mirror of
https://github.com/MariaDB/server.git
synced 2025-01-23 15:24:16 +01:00
1601bdc38a
------------------------------------------------------------------------
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.
------------------------------------------------------------------------
112 lines
3.8 KiB
Text
112 lines
3.8 KiB
Text
/*****************************************************************************
|
|
|
|
Copyright (c) 1994, 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/mem0dbg.ic
|
|
The memory management: the debug code. This is not an independent
|
|
compilation module but is included in mem0mem.*.
|
|
|
|
Created 6/8/1994 Heikki Tuuri
|
|
*************************************************************************/
|
|
|
|
#ifdef UNIV_MEM_DEBUG
|
|
# ifndef UNIV_HOTBACKUP
|
|
extern mutex_t mem_hash_mutex;
|
|
# endif /* !UNIV_HOTBACKUP */
|
|
extern ulint mem_current_allocated_memory;
|
|
|
|
/******************************************************************//**
|
|
Initializes an allocated memory field in the debug version. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_field_init(
|
|
/*===========*/
|
|
byte* buf, /*!< in: memory field */
|
|
ulint n); /*!< in: how many bytes the user requested */
|
|
/******************************************************************//**
|
|
Erases an allocated memory field in the debug version. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_field_erase(
|
|
/*============*/
|
|
byte* buf, /*!< in: memory field */
|
|
ulint n); /*!< in: how many bytes the user requested */
|
|
/***************************************************************//**
|
|
Initializes a buffer to a random combination of hex BA and BE.
|
|
Used to initialize allocated memory. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_init_buf(
|
|
/*=========*/
|
|
byte* buf, /*!< in: pointer to buffer */
|
|
ulint n); /*!< in: length of buffer */
|
|
/***************************************************************//**
|
|
Initializes a buffer to a random combination of hex DE and AD.
|
|
Used to erase freed memory. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_erase_buf(
|
|
/*==========*/
|
|
byte* buf, /*!< in: pointer to buffer */
|
|
ulint n); /*!< in: length of buffer */
|
|
/***************************************************************//**
|
|
Inserts a created memory heap to the hash table of
|
|
current allocated memory heaps.
|
|
Initializes the hash table when first called. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_hash_insert(
|
|
/*============*/
|
|
mem_heap_t* heap, /*!< in: the created heap */
|
|
const char* file_name, /*!< in: file name of creation */
|
|
ulint line); /*!< in: line where created */
|
|
/***************************************************************//**
|
|
Removes a memory heap (which is going to be freed by the caller)
|
|
from the list of live memory heaps. Returns the size of the heap
|
|
in terms of how much memory in bytes was allocated for the user of
|
|
the heap (not the total space occupied by the heap).
|
|
Also validates the heap.
|
|
NOTE: This function does not free the storage occupied by the
|
|
heap itself, only the node in the list of heaps. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_hash_remove(
|
|
/*============*/
|
|
mem_heap_t* heap, /*!< in: the heap to be freed */
|
|
const char* file_name, /*!< in: file name of freeing */
|
|
ulint line); /*!< in: line where freed */
|
|
|
|
|
|
void
|
|
mem_field_header_set_len(byte* field, ulint len);
|
|
|
|
ulint
|
|
mem_field_header_get_len(byte* field);
|
|
|
|
void
|
|
mem_field_header_set_check(byte* field, ulint check);
|
|
|
|
ulint
|
|
mem_field_header_get_check(byte* field);
|
|
|
|
void
|
|
mem_field_trailer_set_check(byte* field, ulint check);
|
|
|
|
ulint
|
|
mem_field_trailer_get_check(byte* field);
|
|
#endif /* UNIV_MEM_DEBUG */
|