mem0dbg.h

Go to the documentation of this file.

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

Copyright (c) 1994, 2010, 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

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

/**************************************************/
/* In the debug version each allocated field is surrounded with
check fields whose sizes are given below */

#ifdef UNIV_MEM_DEBUG
# ifndef UNIV_HOTBACKUP
/* The mutex which protects in the debug version the hash table
containing the list of live memory heaps, and also the global
variables in mem0dbg.cc. */
extern ib_mutex_t       mem_hash_mutex;
# endif /* !UNIV_HOTBACKUP */

#define MEM_FIELD_HEADER_SIZE   ut_calc_align(2 * sizeof(ulint),\
                                                UNIV_MEM_ALIGNMENT)
#define MEM_FIELD_TRAILER_SIZE  sizeof(ulint)
#else
#define MEM_FIELD_HEADER_SIZE   0
#endif


/* Space needed when allocating for a user a field of
length N. The space is allocated only in multiples of
UNIV_MEM_ALIGNMENT. In the debug version there are also
check fields at the both ends of the field. */
#ifdef UNIV_MEM_DEBUG
#define MEM_SPACE_NEEDED(N) ut_calc_align((N) + MEM_FIELD_HEADER_SIZE\
                 + MEM_FIELD_TRAILER_SIZE, UNIV_MEM_ALIGNMENT)
#else
#define MEM_SPACE_NEEDED(N) ut_calc_align((N), UNIV_MEM_ALIGNMENT)
#endif

#if defined UNIV_MEM_DEBUG || defined UNIV_DEBUG
/***************************************************************/
UNIV_INTERN
void
mem_heap_validate_or_print(
/*=======================*/
        mem_heap_t*     heap,   
        byte*           top,    
        ibool            print,  
        ibool*           error,  
        ulint*          us_size,
        ulint*          ph_size,
        ulint*          n_blocks); 
/**************************************************************/
UNIV_INTERN
ibool
mem_heap_validate(
/*==============*/
        mem_heap_t*   heap);    
#endif /* UNIV_MEM_DEBUG || UNIV_DEBUG */
#ifdef UNIV_DEBUG
/**************************************************************/
UNIV_INTERN
ibool
mem_heap_check(
/*===========*/
        mem_heap_t*   heap);    
#endif /* UNIV_DEBUG */
#ifdef UNIV_MEM_DEBUG
/*****************************************************************/
UNIV_INTERN
ibool
mem_all_freed(void);
/*===============*/
/*****************************************************************/
UNIV_INTERN
ibool
mem_validate_no_assert(void);
/*=========================*/
/************************************************************/
UNIV_INTERN
ibool
mem_validate(void);
/*===============*/
#endif /* UNIV_MEM_DEBUG */
/************************************************************/
UNIV_INTERN
void
mem_analyze_corruption(
/*===================*/
        void*   ptr);   
/*****************************************************************/
UNIV_INTERN
void
mem_print_info(void);
/*================*/
/*****************************************************************/
UNIV_INTERN
void
mem_print_new_info(void);
/*====================*/