fut0lst.h

Go to the documentation of this file.

/*****************************************************************************

Copyright (c) 1995, 2009, Oracle and/or its affiliates. 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.,
51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA

*****************************************************************************/

/******************************************************************/
#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
/********************************************************************/
UNIV_INLINE
void
flst_init(
/*======*/
        flst_base_node_t*       base,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_add_last(
/*==========*/
        flst_base_node_t*       base,   
        flst_node_t*            node,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_add_first(
/*===========*/
        flst_base_node_t*       base,   
        flst_node_t*            node,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_insert_after(
/*==============*/
        flst_base_node_t*       base,   
        flst_node_t*            node1,  
        flst_node_t*            node2,  
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_insert_before(
/*===============*/
        flst_base_node_t*       base,   
        flst_node_t*            node2,  
        flst_node_t*            node3,  
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_remove(
/*========*/
        flst_base_node_t*       base,   
        flst_node_t*            node2,  
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_cut_end(
/*=========*/
        flst_base_node_t*       base,   
        flst_node_t*            node2,  
        ulint                   n_nodes,
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
void
flst_truncate_end(
/*==============*/
        flst_base_node_t*       base,   
        flst_node_t*            node2,  
        ulint                   n_nodes,
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INLINE
ulint
flst_get_len(
/*=========*/
        const flst_base_node_t* base,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INLINE
fil_addr_t
flst_get_first(
/*===========*/
        const flst_base_node_t* base,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INLINE
fil_addr_t
flst_get_last(
/*==========*/
        const flst_base_node_t* base,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INLINE
fil_addr_t
flst_get_next_addr(
/*===============*/
        const flst_node_t*      node,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INLINE
fil_addr_t
flst_get_prev_addr(
/*===============*/
        const flst_node_t*      node,   
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INLINE
void
flst_write_addr(
/*============*/
        fil_faddr_t*    faddr,  
        fil_addr_t      addr,   
        mtr_t*          mtr);   
/********************************************************************/
UNIV_INLINE
fil_addr_t
flst_read_addr(
/*===========*/
        const fil_faddr_t*      faddr,  
        mtr_t*                  mtr);   
/********************************************************************/
UNIV_INTERN
ibool
flst_validate(
/*==========*/
        const flst_base_node_t* base,   
        mtr_t*                  mtr1);  
/********************************************************************/
UNIV_INTERN
void
flst_print(
/*=======*/
        const flst_base_node_t* base,   
        mtr_t*                  mtr);   
#ifndef UNIV_NONINL
#include "fut0lst.ic"
#endif

#endif /* !UNIV_HOTBACKUP */

#endif