mirror of
https://github.com/MariaDB/server.git
synced 2025-02-02 20:11:42 +01:00
61bddcc89b
(Ran doxygenify.pl conversion locally, then merged and checked consistency.)
------------------------------------------------------------------------
r5091 | marko | 2009-05-25 09:30:14 +0300 (Mon, 25 May 2009) | 33 lines
branches/zip: Convert the function comments to Doxygen format.
This patch was created by running the following commands:
for i in */*[ch]; do doxygenify.pl $i; done
perl -i -pe 's#\*{3} \*/$#****/#' */*[ch]
where doxygenify.pl is
https://svn.innodb.com/svn/misc/trunk/tools/doxygenify.pl r510
Verified the consistency as follows:
(0) not too many /* in: */ or /* out: */ comments left in the code:
grep -l '/\*\s*\(in\|out\)[,:/]' */*[ch]
(1) no difference when ignoring blank lines, after stripping all
C90-style /* comments */, including multi-line ones, before and after
applying this patch:
perl -i -e 'undef $/;while(<ARGV>){s#/\*(.*?)\*/##gs;print}' */*[ch]
diff -I'^\s*$' --exclude .svn -ru TREE1 TREE2
(2) after stripping @return comments and !<, generated a diff and omitted
the hunks where /* out: */ function return comments were removed:
perl -i -e'undef $/;while(<ARGV>){s#!<##g;s#\n\@return\t.*?\*/# \*/#gs;print}'\
*/*[ch]
svn diff|
perl -e 'undef $/;$_=<>;s#\n-\s*/\* out[:,]([^\n]*?)(\n-[^\n]*?)*\*/##gs;print'
Some unintended changes were left. These will be removed in a
subsequent patch.
------------------------------------------------------------------------
166 lines
5.2 KiB
Text
166 lines
5.2 KiB
Text
/*****************************************************************************
|
|
|
|
Copyright (c) 1995, 2009, Innobase Oy. All Rights Reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
|
|
Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/**********************************************************************
|
|
File-based list utilities
|
|
|
|
Created 11/28/1995 Heikki Tuuri
|
|
***********************************************************************/
|
|
|
|
#include "fut0fut.h"
|
|
#include "mtr0log.h"
|
|
#include "buf0buf.h"
|
|
|
|
/* We define the field offsets of a node for the list */
|
|
#define FLST_PREV 0 /* 6-byte address of the previous list element;
|
|
the page part of address is FIL_NULL, if no
|
|
previous element */
|
|
#define FLST_NEXT FIL_ADDR_SIZE /* 6-byte address of the next
|
|
list element; the page part of address
|
|
is FIL_NULL, if no next element */
|
|
|
|
/* We define the field offsets of a base node for the list */
|
|
#define FLST_LEN 0 /* 32-bit list length field */
|
|
#define FLST_FIRST 4 /* 6-byte address of the first element
|
|
of the list; undefined if empty list */
|
|
#define FLST_LAST (4 + FIL_ADDR_SIZE) /* 6-byte address of the
|
|
last element of the list; undefined
|
|
if empty list */
|
|
|
|
/************************************************************************
|
|
Writes a file address. */
|
|
UNIV_INLINE
|
|
void
|
|
flst_write_addr(
|
|
/*============*/
|
|
fil_faddr_t* faddr, /*!< in: pointer to file faddress */
|
|
fil_addr_t addr, /*!< in: file address */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
ut_ad(faddr && mtr);
|
|
ut_ad(mtr_memo_contains_page(mtr, faddr, MTR_MEMO_PAGE_X_FIX));
|
|
ut_a(addr.page == FIL_NULL || addr.boffset >= FIL_PAGE_DATA);
|
|
ut_a(ut_align_offset(faddr, UNIV_PAGE_SIZE) >= FIL_PAGE_DATA);
|
|
|
|
mlog_write_ulint(faddr + FIL_ADDR_PAGE, addr.page, MLOG_4BYTES, mtr);
|
|
mlog_write_ulint(faddr + FIL_ADDR_BYTE, addr.boffset,
|
|
MLOG_2BYTES, mtr);
|
|
}
|
|
|
|
/************************************************************************
|
|
Reads a file address.
|
|
@return file address */
|
|
UNIV_INLINE
|
|
fil_addr_t
|
|
flst_read_addr(
|
|
/*===========*/
|
|
const fil_faddr_t* faddr, /*!< in: pointer to file faddress */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
fil_addr_t addr;
|
|
|
|
ut_ad(faddr && mtr);
|
|
|
|
addr.page = mtr_read_ulint(faddr + FIL_ADDR_PAGE, MLOG_4BYTES, mtr);
|
|
addr.boffset = mtr_read_ulint(faddr + FIL_ADDR_BYTE, MLOG_2BYTES,
|
|
mtr);
|
|
ut_a(addr.page == FIL_NULL || addr.boffset >= FIL_PAGE_DATA);
|
|
ut_a(ut_align_offset(faddr, UNIV_PAGE_SIZE) >= FIL_PAGE_DATA);
|
|
return(addr);
|
|
}
|
|
|
|
/************************************************************************
|
|
Initializes a list base node. */
|
|
UNIV_INLINE
|
|
void
|
|
flst_init(
|
|
/*======*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
ut_ad(mtr_memo_contains_page(mtr, base, MTR_MEMO_PAGE_X_FIX));
|
|
|
|
mlog_write_ulint(base + FLST_LEN, 0, MLOG_4BYTES, mtr);
|
|
flst_write_addr(base + FLST_FIRST, fil_addr_null, mtr);
|
|
flst_write_addr(base + FLST_LAST, fil_addr_null, mtr);
|
|
}
|
|
|
|
/************************************************************************
|
|
Gets list length.
|
|
@return length */
|
|
UNIV_INLINE
|
|
ulint
|
|
flst_get_len(
|
|
/*=========*/
|
|
const flst_base_node_t* base, /*!< in: pointer to base node */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
return(mtr_read_ulint(base + FLST_LEN, MLOG_4BYTES, mtr));
|
|
}
|
|
|
|
/************************************************************************
|
|
Gets list first node address.
|
|
@return file address */
|
|
UNIV_INLINE
|
|
fil_addr_t
|
|
flst_get_first(
|
|
/*===========*/
|
|
const flst_base_node_t* base, /*!< in: pointer to base node */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
return(flst_read_addr(base + FLST_FIRST, mtr));
|
|
}
|
|
|
|
/************************************************************************
|
|
Gets list last node address.
|
|
@return file address */
|
|
UNIV_INLINE
|
|
fil_addr_t
|
|
flst_get_last(
|
|
/*==========*/
|
|
const flst_base_node_t* base, /*!< in: pointer to base node */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
return(flst_read_addr(base + FLST_LAST, mtr));
|
|
}
|
|
|
|
/************************************************************************
|
|
Gets list next node address.
|
|
@return file address */
|
|
UNIV_INLINE
|
|
fil_addr_t
|
|
flst_get_next_addr(
|
|
/*===============*/
|
|
const flst_node_t* node, /*!< in: pointer to node */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
return(flst_read_addr(node + FLST_NEXT, mtr));
|
|
}
|
|
|
|
/************************************************************************
|
|
Gets list prev node address.
|
|
@return file address */
|
|
UNIV_INLINE
|
|
fil_addr_t
|
|
flst_get_prev_addr(
|
|
/*===============*/
|
|
const flst_node_t* node, /*!< in: pointer to node */
|
|
mtr_t* mtr) /*!< in: mini-transaction handle */
|
|
{
|
|
return(flst_read_addr(node + FLST_PREV, mtr));
|
|
}
|