diff options
Diffstat (limited to 'storage/xtradb/include/btr0cur.ic')
| -rw-r--r-- | storage/xtradb/include/btr0cur.ic | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/storage/xtradb/include/btr0cur.ic b/storage/xtradb/include/btr0cur.ic index 84a3a5cba0b..280583f6ccf 100644 --- a/storage/xtradb/include/btr0cur.ic +++ b/storage/xtradb/include/btr0cur.ic @@ -16,110 +16,110 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/****************************************************** +/**************************************************//** +@file include/btr0cur.ic The index tree cursor Created 10/16/1994 Heikki Tuuri *******************************************************/ +#ifndef UNIV_HOTBACKUP #include "btr0btr.h" #ifdef UNIV_DEBUG -/************************************************************* -Returns the page cursor component of a tree cursor. */ +/*********************************************************//** +Returns the page cursor component of a tree cursor. +@return pointer to page cursor component */ UNIV_INLINE page_cur_t* btr_cur_get_page_cur( /*=================*/ - /* out: pointer to page cursor - component */ - const btr_cur_t* cursor) /* in: tree cursor */ + const btr_cur_t* cursor) /*!< in: tree cursor */ { return(&((btr_cur_t*) cursor)->page_cur); } #endif /* UNIV_DEBUG */ -/************************************************************* -Returns the buffer block on which the tree cursor is positioned. */ +/*********************************************************//** +Returns the buffer block on which the tree cursor is positioned. +@return pointer to buffer block */ UNIV_INLINE buf_block_t* btr_cur_get_block( /*==============*/ - /* out: pointer to buffer block */ - btr_cur_t* cursor) /* in: tree cursor */ + btr_cur_t* cursor) /*!< in: tree cursor */ { return(page_cur_get_block(btr_cur_get_page_cur(cursor))); } -/************************************************************* -Returns the record pointer of a tree cursor. */ +/*********************************************************//** +Returns the record pointer of a tree cursor. +@return pointer to record */ UNIV_INLINE rec_t* btr_cur_get_rec( /*============*/ - /* out: pointer to record */ - btr_cur_t* cursor) /* in: tree cursor */ + btr_cur_t* cursor) /*!< in: tree cursor */ { return(page_cur_get_rec(&(cursor->page_cur))); } -/************************************************************* -Returns the compressed page on which the tree cursor is positioned. */ +/*********************************************************//** +Returns the compressed page on which the tree cursor is positioned. +@return pointer to compressed page, or NULL if the page is not compressed */ UNIV_INLINE page_zip_des_t* btr_cur_get_page_zip( /*=================*/ - /* out: pointer to compressed page, - or NULL if the page is not compressed */ - btr_cur_t* cursor) /* in: tree cursor */ + btr_cur_t* cursor) /*!< in: tree cursor */ { return(buf_block_get_page_zip(btr_cur_get_block(cursor))); } -/************************************************************* +/*********************************************************//** Invalidates a tree cursor by setting record pointer to NULL. */ UNIV_INLINE void btr_cur_invalidate( /*===============*/ - btr_cur_t* cursor) /* in: tree cursor */ + btr_cur_t* cursor) /*!< in: tree cursor */ { page_cur_invalidate(&(cursor->page_cur)); } -/************************************************************* -Returns the page of a tree cursor. */ +/*********************************************************//** +Returns the page of a tree cursor. +@return pointer to page */ UNIV_INLINE page_t* btr_cur_get_page( /*=============*/ - /* out: pointer to page */ - btr_cur_t* cursor) /* in: tree cursor */ + btr_cur_t* cursor) /*!< in: tree cursor */ { return(page_align(page_cur_get_rec(&(cursor->page_cur)))); } -/************************************************************* -Returns the index of a cursor. */ +/*********************************************************//** +Returns the index of a cursor. +@return index */ UNIV_INLINE dict_index_t* btr_cur_get_index( /*==============*/ - /* out: index */ - btr_cur_t* cursor) /* in: B-tree cursor */ + btr_cur_t* cursor) /*!< in: B-tree cursor */ { return(cursor->index); } -/************************************************************* +/*********************************************************//** Positions a tree cursor at a given record. */ UNIV_INLINE void btr_cur_position( /*=============*/ - dict_index_t* index, /* in: index */ - rec_t* rec, /* in: record in tree */ - buf_block_t* block, /* in: buffer block of rec */ - btr_cur_t* cursor) /* out: cursor */ + dict_index_t* index, /*!< in: index */ + rec_t* rec, /*!< in: record in tree */ + buf_block_t* block, /*!< in: buffer block of rec */ + btr_cur_t* cursor) /*!< out: cursor */ { ut_ad(page_align(rec) == block->frame); @@ -128,16 +128,16 @@ btr_cur_position( cursor->index = index; } -/************************************************************************* +/*********************************************************************//** Checks if compressing an index page where a btr cursor is placed makes -sense. */ +sense. +@return TRUE if compression is recommended */ UNIV_INLINE ibool btr_cur_compress_recommendation( /*============================*/ - /* out: TRUE if compression is recommended */ - btr_cur_t* cursor, /* in: btr cursor */ - mtr_t* mtr) /* in: mtr */ + btr_cur_t* cursor, /*!< in: btr cursor */ + mtr_t* mtr) /*!< in: mtr */ { page_t* page; @@ -162,18 +162,17 @@ btr_cur_compress_recommendation( return(FALSE); } -/************************************************************************* +/*********************************************************************//** Checks if the record on which the cursor is placed can be deleted without -making tree compression necessary (or, recommended). */ +making tree compression necessary (or, recommended). +@return TRUE if can be deleted without recommended compression */ UNIV_INLINE ibool btr_cur_can_delete_without_compress( /*================================*/ - /* out: TRUE if can be deleted without - recommended compression */ - btr_cur_t* cursor, /* in: btr cursor */ - ulint rec_size,/* in: rec_get_size(btr_cur_get_rec(cursor))*/ - mtr_t* mtr) /* in: mtr */ + btr_cur_t* cursor, /*!< in: btr cursor */ + ulint rec_size,/*!< in: rec_get_size(btr_cur_get_rec(cursor))*/ + mtr_t* mtr) /*!< in: mtr */ { page_t* page; @@ -198,3 +197,4 @@ btr_cur_can_delete_without_compress( return(TRUE); } +#endif /* !UNIV_HOTBACKUP */ |