mirror of
https://github.com/MariaDB/server.git
synced 2025-01-24 07:44:22 +01:00
41b29de7ac
------------------------------------------------------------------------
r5092 | marko | 2009-05-25 09:54:17 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Adjust some function comments after r5091.
------------------------------------------------------------------------
r5100 | marko | 2009-05-25 12:09:45 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Split some long lines that were introduced in r5091.
------------------------------------------------------------------------
r5101 | marko | 2009-05-25 12:42:47 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Introduce the macro TEMP_INDEX_PREFIX_STR.
This is to avoid triggering an error in Doxygen.
------------------------------------------------------------------------
r5102 | marko | 2009-05-25 13:47:14 +0300 (Mon, 25 May 2009) | 1 line
branches/zip: Add missing file comments.
------------------------------------------------------------------------
r5103 | marko | 2009-05-25 13:52:29 +0300 (Mon, 25 May 2009) | 10 lines
branches/zip: Add @file comments, and convert decorative
/*********************************
comments to Doxygen /** style like this:
/*****************************//**
This conversion was performed by the following command:
perl -i -e 'while(<ARGV>){if (m|^/\*{30}\**$|) {
s|\*{4}$|//**| if ++$com>1; $_ .= "\@file $ARGV\n" if $com==2}
print; if(eof){$.=0;undef $com}}' */*[ch] include/univ.i
------------------------------------------------------------------------
r5104 | marko | 2009-05-25 14:39:07 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Revert ut0auxconf_* to r5102,
that is, make Doxygen ignore these test programs.
------------------------------------------------------------------------
r5105 | marko | 2009-05-25 14:52:20 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Enclose some #error checks inside #ifndef DOXYGEN
to prevent bogus Doxygen errors.
------------------------------------------------------------------------
r5106 | marko | 2009-05-25 16:09:24 +0300 (Mon, 25 May 2009) | 2 lines
branches/zip: Add some Doxygen comments, mainly to structs, typedefs,
macros and global variables. Many more to go.
------------------------------------------------------------------------
r5108 | marko | 2009-05-26 00:32:35 +0300 (Tue, 26 May 2009) | 2 lines
branches/zip: lexyy.c: Remove the inadvertently added @file directive.
There is nothing for Doxygen to see in this file, move along.
------------------------------------------------------------------------
r5125 | marko | 2009-05-26 16:28:49 +0300 (Tue, 26 May 2009) | 3 lines
branches/zip: Add some Doxygen comments for many structs, typedefs,
#defines and global variables. Many are still missing.
------------------------------------------------------------------------
r5134 | marko | 2009-05-27 09:08:43 +0300 (Wed, 27 May 2009) | 1 line
branches/zip: Add some Doxygen @return comments.
------------------------------------------------------------------------
r5139 | marko | 2009-05-27 10:01:40 +0300 (Wed, 27 May 2009) | 1 line
branches/zip: Add Doxyfile.
------------------------------------------------------------------------
r5143 | marko | 2009-05-27 10:57:25 +0300 (Wed, 27 May 2009) | 3 lines
branches/zip: buf0buf.h, Doxyfile: Fix the Doxygen translation.
@defgroup is for source code modules, not for field groups.
Tell Doxygen to expand the UT_LIST declarations.
------------------------------------------------------------------------
217 lines
7.2 KiB
C
217 lines
7.2 KiB
C
/*****************************************************************************
|
|
|
|
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 include/fut0lst.h
|
|
File-based list utilities
|
|
|
|
Created 11/28/1995 Heikki Tuuri
|
|
***********************************************************************/
|
|
|
|
#ifndef fut0lst_h
|
|
#define fut0lst_h
|
|
|
|
#include "univ.i"
|
|
|
|
#include "fil0fil.h"
|
|
#include "mtr0mtr.h"
|
|
|
|
|
|
/* The C 'types' of base node and list node: these should be used to
|
|
write self-documenting code. Of course, the sizeof macro cannot be
|
|
applied to these types! */
|
|
|
|
typedef byte flst_base_node_t;
|
|
typedef byte flst_node_t;
|
|
|
|
/* The physical size of a list base node in bytes */
|
|
#define FLST_BASE_NODE_SIZE (4 + 2 * FIL_ADDR_SIZE)
|
|
|
|
/* The physical size of a list node in bytes */
|
|
#define FLST_NODE_SIZE (2 * FIL_ADDR_SIZE)
|
|
|
|
#ifndef UNIV_HOTBACKUP
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
Adds a node as the last node in a list. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_add_last(
|
|
/*==========*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node, /*!< in: node to add */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
Adds a node as the first node in a list. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_add_first(
|
|
/*===========*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node, /*!< in: node to add */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
Inserts a node after another in a list. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_insert_after(
|
|
/*==============*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node1, /*!< in: node to insert after */
|
|
flst_node_t* node2, /*!< in: node to add */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
Inserts a node before another in a list. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_insert_before(
|
|
/*===============*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node2, /*!< in: node to insert */
|
|
flst_node_t* node3, /*!< in: node to insert before */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
Removes a node. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_remove(
|
|
/*========*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node2, /*!< in: node to remove */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
Cuts off the tail of the list, including the node given. The number of
|
|
nodes which will be removed must be provided by the caller, as this function
|
|
does not measure the length of the tail. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_cut_end(
|
|
/*=========*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node2, /*!< in: first node to remove */
|
|
ulint n_nodes,/*!< in: number of nodes to remove,
|
|
must be >= 1 */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
Cuts off the tail of the list, not including the given node. The number of
|
|
nodes which will be removed must be provided by the caller, as this function
|
|
does not measure the length of the tail. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_truncate_end(
|
|
/*==============*/
|
|
flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
flst_node_t* node2, /*!< in: first node not to remove */
|
|
ulint n_nodes,/*!< in: number of nodes to remove */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
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 */
|
|
/********************************************************************//**
|
|
Validates a file-based list.
|
|
@return TRUE if ok */
|
|
UNIV_INTERN
|
|
ibool
|
|
flst_validate(
|
|
/*==========*/
|
|
const flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
mtr_t* mtr1); /*!< in: mtr */
|
|
/********************************************************************//**
|
|
Prints info of a file-based list. */
|
|
UNIV_INTERN
|
|
void
|
|
flst_print(
|
|
/*=======*/
|
|
const flst_base_node_t* base, /*!< in: pointer to base node of list */
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "fut0lst.ic"
|
|
#endif
|
|
|
|
#endif /* !UNIV_HOTBACKUP */
|
|
|
|
#endif
|