mem0pool.h File Reference

#include "univ.i"
#include "os0file.h"
#include "ut0lst.h"
#include "mem0pool.ic"

Include dependency graph for mem0pool.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	mem_area_t

Macros
#define	MEM_AREA_EXTRA_SIZE

Functions
UNIV_INTERN mem_pool_t *	mem_pool_create (ulint size)
UNIV_INTERN void	mem_pool_free (mem_pool_t *pool)
UNIV_INTERN void *	mem_area_alloc (ulint *psize, mem_pool_t *pool)
UNIV_INTERN void	mem_area_free (void *ptr, mem_pool_t *pool)
UNIV_INTERN ulint	mem_pool_get_reserved (mem_pool_t *pool)
UNIV_INTERN ibool	mem_pool_validate (mem_pool_t *pool)
UNIV_INTERN void	mem_pool_print_info (FILE *outfile, mem_pool_t *pool)

Variables
mem_pool_t *	mem_comm_pool

Detailed Description

The lowest-level memory management

Created 6/9/1994 Heikki Tuuri

Definition in file mem0pool.h.

Macro Definition Documentation

#define MEM_AREA_EXTRA_SIZE

Value:

(ut_calc_align(sizeof(struct mem_area_t),\
                        UNIV_MEM_ALIGNMENT))

Each memory area takes this many extra bytes for control information

Definition at line 50 of file mem0pool.h.

Function Documentation

UNIV_INTERN void* mem_area_alloc	(	ulint *	psize,
		mem_pool_t *	pool
	)

Allocates memory from a pool. NOTE: This low-level function should only be used in mem0mem.*!

Returns

own: allocated memory buffer in: memory pool

Allocates memory from a pool. NOTE: This low-level function should only be used in mem0mem.*!

Returns

own: allocated memory buffer

Parameters

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)
pool	in: memory pool

Definition at line 364 of file mem0pool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN void mem_area_free	(	void *	ptr,
		mem_pool_t *	pool
	)

Frees memory to a pool. in: memory pool

Frees memory to a pool.

Parameters

ptr	in, own: pointer to allocated memory buffer
pool	in: memory pool

Definition at line 506 of file mem0pool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN mem_pool_t* mem_pool_create

(

ulint

size

)

Creates a memory pool.

Returns

memory pool in: pool size in bytes

Creates a memory pool.

Returns

memory pool

Parameters

size	in: pool size in bytes

Definition at line 220 of file mem0pool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN void mem_pool_free

(

mem_pool_t *

pool

)

Frees a memory pool. in, own: memory pool

Frees a memory pool.

Parameters

pool	in, own: memory pool

Definition at line 279 of file mem0pool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN ulint mem_pool_get_reserved

(

mem_pool_t *

pool

)

Returns the amount of reserved memory.

Returns

reserved mmeory in bytes in: memory pool

Returns the amount of reserved memory.

Returns

reserved memory in bytes

Parameters

pool	in: memory pool

Definition at line 714 of file mem0pool.cc.

Here is the caller graph for this function:

UNIV_INTERN void mem_pool_print_info	(	FILE *	outfile,
		mem_pool_t *	pool
	)

Prints info of a memory pool. in: memory pool

Prints info of a memory pool.

Parameters

outfile	in: output file to write to
pool	in: memory pool

Definition at line 680 of file mem0pool.cc.

Here is the call graph for this function:

UNIV_INTERN ibool mem_pool_validate

(

mem_pool_t *

pool

)

Validates a memory pool.

Returns

TRUE if ok in: memory pool

Validates a memory pool.

Returns

TRUE if ok

Parameters

pool	in: memory pool

Definition at line 636 of file mem0pool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

mem_pool_t* mem_comm_pool

The common memory pool

Definition at line 116 of file mem0pool.cc.