diff options
Diffstat (limited to 'storage/xtradb/include/buf0buddy.ic')
| -rw-r--r-- | storage/xtradb/include/buf0buddy.ic | 46 |
1 files changed, 22 insertions, 24 deletions
diff --git a/storage/xtradb/include/buf0buddy.ic b/storage/xtradb/include/buf0buddy.ic index 668959cdba2..69659fb69d6 100644 --- a/storage/xtradb/include/buf0buddy.ic +++ b/storage/xtradb/include/buf0buddy.ic @@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/****************************************************** +/**************************************************//** +@file include/buf0buddy.ic Binary buddy allocator for compressed pages Created December 2006 by Marko Makela @@ -32,47 +33,45 @@ Created December 2006 by Marko Makela #include "ut0ut.h" #include "sync0sync.h" -/************************************************************************** +/**********************************************************************//** Allocate a block. The thread calling this function must hold buf_pool_mutex and must not hold buf_pool_zip_mutex or any block->mutex. -The buf_pool_mutex may only be released and reacquired if lru != NULL. */ +The buf_pool_mutex may only be released and reacquired if lru != NULL. +@return allocated block, possibly NULL if lru==NULL */ UNIV_INTERN void* buf_buddy_alloc_low( /*================*/ - /* out: allocated block, - possibly NULL if lru==NULL */ - ulint i, /* in: index of buf_pool->zip_free[], + ulint i, /*!< in: index of buf_pool->zip_free[], or BUF_BUDDY_SIZES */ - ibool* lru, /* in: pointer to a variable that will be assigned + ibool* lru, /*!< in: pointer to a variable that will be assigned TRUE if storage was allocated from the LRU list and buf_pool_mutex was temporarily released, or NULL if the LRU list should not be used */ ibool have_page_hash_mutex) __attribute__((malloc)); -/************************************************************************** +/**********************************************************************//** Deallocate a block. */ UNIV_INTERN void buf_buddy_free_low( /*===============*/ - void* buf, /* in: block to be freed, must not be + void* buf, /*!< in: block to be freed, must not be pointed to by the buffer pool */ - ulint i, /* in: index of buf_pool->zip_free[], + ulint i, /*!< in: index of buf_pool->zip_free[], or BUF_BUDDY_SIZES */ ibool have_page_hash_mutex) __attribute__((nonnull)); -/************************************************************************** -Get the index of buf_pool->zip_free[] for a given block size. */ +/**********************************************************************//** +Get the index of buf_pool->zip_free[] for a given block size. +@return index of buf_pool->zip_free[], or BUF_BUDDY_SIZES */ UNIV_INLINE ulint buf_buddy_get_slot( /*===============*/ - /* out: index of buf_pool->zip_free[], - or BUF_BUDDY_SIZES */ - ulint size) /* in: block size */ + ulint size) /*!< in: block size */ { ulint i; ulint s; @@ -84,7 +83,7 @@ buf_buddy_get_slot( return(i); } -/************************************************************************** +/**********************************************************************//** Allocate a block. The thread calling this function must hold buf_pool_mutex and must not hold buf_pool_zip_mutex or any block->mutex. The buf_pool_mutex may only be released and reacquired @@ -92,15 +91,14 @@ if lru != NULL. This function should only be used for allocating compressed page frames or control blocks (buf_page_t). Allocated control blocks must be properly initialized immediately after buf_buddy_alloc() has returned the memory, before releasing -buf_pool_mutex. */ +buf_pool_mutex. +@return allocated block, possibly NULL if lru == NULL */ UNIV_INLINE void* buf_buddy_alloc( /*============*/ - /* out: allocated block, - possibly NULL if lru == NULL */ - ulint size, /* in: block size, up to UNIV_PAGE_SIZE */ - ibool* lru, /* in: pointer to a variable that will be assigned + ulint size, /*!< in: block size, up to UNIV_PAGE_SIZE */ + ibool* lru, /*!< in: pointer to a variable that will be assigned TRUE if storage was allocated from the LRU list and buf_pool_mutex was temporarily released, or NULL if the LRU list should not be used */ @@ -111,15 +109,15 @@ buf_buddy_alloc( return(buf_buddy_alloc_low(buf_buddy_get_slot(size), lru, have_page_hash_mutex)); } -/************************************************************************** +/**********************************************************************//** Deallocate a block. */ UNIV_INLINE void buf_buddy_free( /*===========*/ - void* buf, /* in: block to be freed, must not be + void* buf, /*!< in: block to be freed, must not be pointed to by the buffer pool */ - ulint size, /* in: block size, up to UNIV_PAGE_SIZE */ + ulint size, /*!< in: block size, up to UNIV_PAGE_SIZE */ ibool have_page_hash_mutex) { //ut_ad(buf_pool_mutex_own()); |