mirror of
https://github.com/MariaDB/server.git
synced 2025-02-01 11:31:51 +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.
------------------------------------------------------------------------
129 lines
3.9 KiB
C
129 lines
3.9 KiB
C
/*****************************************************************************
|
|
|
|
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/mem0pool.h
|
|
The lowest-level memory management
|
|
|
|
Created 6/9/1994 Heikki Tuuri
|
|
*******************************************************/
|
|
|
|
#ifndef mem0pool_h
|
|
#define mem0pool_h
|
|
|
|
#include "univ.i"
|
|
#include "os0file.h"
|
|
#include "ut0lst.h"
|
|
|
|
/** Memory area header */
|
|
typedef struct mem_area_struct mem_area_t;
|
|
/** Memory pool */
|
|
typedef struct mem_pool_struct mem_pool_t;
|
|
|
|
/** The common memory pool */
|
|
extern mem_pool_t* mem_comm_pool;
|
|
|
|
/** Memory area header */
|
|
|
|
struct mem_area_struct{
|
|
ulint size_and_free; /*!< memory area size is obtained by
|
|
anding with ~MEM_AREA_FREE; area in
|
|
a free list if ANDing with
|
|
MEM_AREA_FREE results in nonzero */
|
|
UT_LIST_NODE_T(mem_area_t)
|
|
free_list; /*!< free list node */
|
|
};
|
|
|
|
/** Each memory area takes this many extra bytes for control information */
|
|
#define MEM_AREA_EXTRA_SIZE (ut_calc_align(sizeof(struct mem_area_struct),\
|
|
UNIV_MEM_ALIGNMENT))
|
|
|
|
/********************************************************************//**
|
|
Creates a memory pool.
|
|
@return memory pool */
|
|
UNIV_INTERN
|
|
mem_pool_t*
|
|
mem_pool_create(
|
|
/*============*/
|
|
ulint size); /*!< in: pool size in bytes */
|
|
/********************************************************************//**
|
|
Allocates memory from a pool. NOTE: This low-level function should only be
|
|
used in mem0mem.*!
|
|
@return own: allocated memory buffer */
|
|
UNIV_INTERN
|
|
void*
|
|
mem_area_alloc(
|
|
/*===========*/
|
|
ulint* psize, /*!< in: requested size in bytes; for optimum
|
|
space usage, the size should be a power of 2
|
|
minus MEM_AREA_EXTRA_SIZE;
|
|
out: allocated size in bytes (greater than
|
|
or equal to the requested size) */
|
|
mem_pool_t* pool); /*!< in: memory pool */
|
|
/********************************************************************//**
|
|
Frees memory to a pool. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_area_free(
|
|
/*==========*/
|
|
void* ptr, /*!< in, own: pointer to allocated memory
|
|
buffer */
|
|
mem_pool_t* pool); /*!< in: memory pool */
|
|
/********************************************************************//**
|
|
Returns the amount of reserved memory.
|
|
@return reserved mmeory in bytes */
|
|
UNIV_INTERN
|
|
ulint
|
|
mem_pool_get_reserved(
|
|
/*==================*/
|
|
mem_pool_t* pool); /*!< in: memory pool */
|
|
/********************************************************************//**
|
|
Reserves the mem pool mutex. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_pool_mutex_enter(void);
|
|
/*======================*/
|
|
/********************************************************************//**
|
|
Releases the mem pool mutex. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_pool_mutex_exit(void);
|
|
/*=====================*/
|
|
/********************************************************************//**
|
|
Validates a memory pool.
|
|
@return TRUE if ok */
|
|
UNIV_INTERN
|
|
ibool
|
|
mem_pool_validate(
|
|
/*==============*/
|
|
mem_pool_t* pool); /*!< in: memory pool */
|
|
/********************************************************************//**
|
|
Prints info of a memory pool. */
|
|
UNIV_INTERN
|
|
void
|
|
mem_pool_print_info(
|
|
/*================*/
|
|
FILE* outfile,/*!< in: output file to write to */
|
|
mem_pool_t* pool); /*!< in: memory pool */
|
|
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "mem0pool.ic"
|
|
#endif
|
|
|
|
#endif
|