mem0mem.h 14.1 KB
Newer Older
vasil's avatar
vasil committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*****************************************************************************

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

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

19 20
/**************************************************//**
@file include/mem0mem.h
osku's avatar
osku committed
21 22 23 24 25 26 27 28 29 30 31 32
The memory management

Created 6/9/1994 Heikki Tuuri
*******************************************************/

#ifndef mem0mem_h
#define mem0mem_h

#include "univ.i"
#include "ut0mem.h"
#include "ut0byte.h"
#include "ut0rnd.h"
33 34 35
#ifndef UNIV_HOTBACKUP
# include "sync0sync.h"
#endif /* UNIV_HOTBACKUP */
osku's avatar
osku committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
#include "ut0lst.h"
#include "mach0data.h"

/* -------------------- MEMORY HEAPS ----------------------------- */

/* The info structure stored at the beginning of a heap block */
typedef struct mem_block_info_struct mem_block_info_t;

/* A block of a memory heap consists of the info structure
followed by an area of memory */
typedef mem_block_info_t	mem_block_t;

/* A memory heap is a nonempty linear list of memory blocks */
typedef mem_block_t	mem_heap_t;

/* Types of allocation for memory heaps: DYNAMIC means allocation from the
52 53
dynamic memory pool of the C compiler, BUFFER means allocation from the
buffer pool; the latter method is used for very big heaps */
osku's avatar
osku committed
54 55 56

#define MEM_HEAP_DYNAMIC	0	/* the most common type */
#define MEM_HEAP_BUFFER		1
57 58 59 60 61 62 63
#define MEM_HEAP_BTR_SEARCH	2	/* this flag can optionally be
					ORed to MEM_HEAP_BUFFER, in which
					case heap->free_block is used in
					some cases for memory allocations,
					and if it's NULL, the memory
					allocation functions can return
					NULL. */
osku's avatar
osku committed
64 65 66 67 68 69

/* The following start size is used for the first block in the memory heap if
the size is not specified, i.e., 0 is given as the parameter in the call of
create. The standard size is the maximum (payload) size of the blocks used for
allocations of small buffers. */

70
#define MEM_BLOCK_START_SIZE		64
71 72
#define MEM_BLOCK_STANDARD_SIZE		\
	(UNIV_PAGE_SIZE >= 16384 ? 8000 : MEM_MAX_ALLOC_IN_BUF)
osku's avatar
osku committed
73 74 75 76 77

/* If a memory heap is allowed to grow into the buffer pool, the following
is the maximum size for a single allocated buffer: */
#define MEM_MAX_ALLOC_IN_BUF		(UNIV_PAGE_SIZE - 200)

78
/******************************************************************//**
osku's avatar
osku committed
79
Initializes the memory system. */
80
UNIV_INTERN
osku's avatar
osku committed
81 82 83
void
mem_init(
/*=====*/
84
	ulint	size);	/*!< in: common pool size in bytes */
85
/**************************************************************//**
osku's avatar
osku committed
86 87 88
Use this macro instead of the corresponding function! Macro for memory
heap creation. */

89
#define mem_heap_create(N)	mem_heap_create_func(\
90
		(N), MEM_HEAP_DYNAMIC, __FILE__, __LINE__)
91
/**************************************************************//**
osku's avatar
osku committed
92 93 94 95
Use this macro instead of the corresponding function! Macro for memory
heap creation. */

#define mem_heap_create_in_buffer(N)	mem_heap_create_func(\
96
		(N), MEM_HEAP_BUFFER, __FILE__, __LINE__)
97
/**************************************************************//**
osku's avatar
osku committed
98 99 100
Use this macro instead of the corresponding function! Macro for memory
heap creation. */

101
#define mem_heap_create_in_btr_search(N)	mem_heap_create_func(\
102
		(N), MEM_HEAP_BTR_SEARCH | MEM_HEAP_BUFFER,\
103
		__FILE__, __LINE__)
osku's avatar
osku committed
104

105
/**************************************************************//**
osku's avatar
osku committed
106 107 108 109 110
Use this macro instead of the corresponding function! Macro for memory
heap freeing. */

#define mem_heap_free(heap) mem_heap_free_func(\
					  (heap), __FILE__, __LINE__)
111
/*****************************************************************//**
osku's avatar
osku committed
112
NOTE: Use the corresponding macros instead of this function. Creates a
113
memory heap. For debugging purposes, takes also the file name and line as
114
arguments.
115 116
@return own: memory heap, NULL if did not succeed (only possible for
MEM_HEAP_BTR_SEARCH type heaps) */
osku's avatar
osku committed
117 118 119 120
UNIV_INLINE
mem_heap_t*
mem_heap_create_func(
/*=================*/
121
	ulint		n,		/*!< in: desired start block size,
osku's avatar
osku committed
122
					this means that a single user buffer
123
					of size n will fit in the block,
124
					0 creates a default size block */
125 126 127
	ulint		type,		/*!< in: heap type */
	const char*	file_name,	/*!< in: file name where created */
	ulint		line);		/*!< in: line where created */
128
/*****************************************************************//**
osku's avatar
osku committed
129 130 131 132 133 134 135
NOTE: Use the corresponding macro instead of this function. Frees the space
occupied by a memory heap. In the debug version erases the heap memory
blocks. */
UNIV_INLINE
void
mem_heap_free_func(
/*===============*/
136 137 138
	mem_heap_t*	heap,		/*!< in, own: heap to be freed */
	const char*	file_name,	/*!< in: file name where freed */
	ulint		line);		/*!< in: line where freed */
139
/***************************************************************//**
140 141
Allocates and zero-fills n bytes of memory from a memory heap.
@return	allocated, zero-filled storage */
142 143
UNIV_INLINE
void*
144
mem_heap_zalloc(
145
/*============*/
146 147
	mem_heap_t*	heap,	/*!< in: memory heap */
	ulint		n);	/*!< in: number of bytes; if the heap is allowed
148 149
				to grow into the buffer pool, this must be
				<= MEM_MAX_ALLOC_IN_BUF */
150
/***************************************************************//**
151
Allocates n bytes of memory from a memory heap.
152 153
@return allocated storage, NULL if did not succeed (only possible for
MEM_HEAP_BTR_SEARCH type heaps) */
osku's avatar
osku committed
154 155 156 157
UNIV_INLINE
void*
mem_heap_alloc(
/*===========*/
158 159
	mem_heap_t*	heap,	/*!< in: memory heap */
	ulint		n);	/*!< in: number of bytes; if the heap is allowed
osku's avatar
osku committed
160 161
				to grow into the buffer pool, this must be
				<= MEM_MAX_ALLOC_IN_BUF */
162
/*****************************************************************//**
163 164
Returns a pointer to the heap top.
@return	pointer to the heap top */
osku's avatar
osku committed
165 166 167
UNIV_INLINE
byte*
mem_heap_get_heap_top(
168
/*==================*/
169
	mem_heap_t*	heap);	/*!< in: memory heap */
170
/*****************************************************************//**
osku's avatar
osku committed
171 172 173 174 175 176 177
Frees the space in a memory heap exceeding the pointer given. The
pointer must have been acquired from mem_heap_get_heap_top. The first
memory block of the heap is not freed. */
UNIV_INLINE
void
mem_heap_free_heap_top(
/*===================*/
178 179
	mem_heap_t*	heap,	/*!< in: heap from which to free */
	byte*		old_top);/*!< in: pointer to old top of heap */
180
/*****************************************************************//**
osku's avatar
osku committed
181 182 183 184 185
Empties a memory heap. The first memory block of the heap is not freed. */
UNIV_INLINE
void
mem_heap_empty(
/*===========*/
186
	mem_heap_t*	heap);	/*!< in: heap to empty */
187
/*****************************************************************//**
osku's avatar
osku committed
188
Returns a pointer to the topmost element in a memory heap.
189 190
The size of the element must be given.
@return	pointer to the topmost element */
osku's avatar
osku committed
191 192 193
UNIV_INLINE
void*
mem_heap_get_top(
194
/*=============*/
195 196
	mem_heap_t*	heap,	/*!< in: memory heap */
	ulint		n);	/*!< in: size of the topmost element */
197
/*****************************************************************//**
osku's avatar
osku committed
198 199 200 201 202
Frees the topmost element in a memory heap.
The size of the element must be given. */
UNIV_INLINE
void
mem_heap_free_top(
203
/*==============*/
204 205
	mem_heap_t*	heap,	/*!< in: memory heap */
	ulint		n);	/*!< in: size of the topmost element */
206
/*****************************************************************//**
osku's avatar
osku committed
207 208 209 210 211
Returns the space in bytes occupied by a memory heap. */
UNIV_INLINE
ulint
mem_heap_get_size(
/*==============*/
212
	mem_heap_t*	heap);		/*!< in: heap */
213
/**************************************************************//**
osku's avatar
osku committed
214 215 216
Use this macro instead of the corresponding function!
Macro for memory buffer allocation */

217
#define mem_zalloc(N)	memset(mem_alloc(N), 0, (N));
218

219 220
#define mem_alloc(N)	mem_alloc_func((N), NULL, __FILE__, __LINE__)
#define mem_alloc2(N,S)	mem_alloc_func((N), (S), __FILE__, __LINE__)
221
/***************************************************************//**
osku's avatar
osku committed
222 223
NOTE: Use the corresponding macro instead of this function.
Allocates a single buffer of memory from the dynamic memory of
224
the C compiler. Is like malloc of C. The buffer must be freed
225 226
with mem_free.
@return	own: free storage */
osku's avatar
osku committed
227 228 229 230
UNIV_INLINE
void*
mem_alloc_func(
/*===========*/
231 232
	ulint		n,		/*!< in: requested size in bytes */
	ulint*		size,		/*!< out: allocated size in bytes,
233
					or NULL */
234 235
	const char*	file_name,	/*!< in: file name where created */
	ulint		line);		/*!< in: line where created */
236

237
/**************************************************************//**
osku's avatar
osku committed
238 239 240
Use this macro instead of the corresponding function!
Macro for memory buffer freeing */

241
#define mem_free(PTR)	mem_free_func((PTR), __FILE__, __LINE__)
242
/***************************************************************//**
osku's avatar
osku committed
243 244 245 246 247 248 249
NOTE: Use the corresponding macro instead of this function.
Frees a single buffer of storage from
the dynamic memory of C compiler. Similar to free of C. */
UNIV_INLINE
void
mem_free_func(
/*==========*/
250 251 252
	void*		ptr,		/*!< in, own: buffer to be freed */
	const char*	file_name,	/*!< in: file name where created */
	ulint		line);		/*!< in: line where created */
osku's avatar
osku committed
253

254
/**********************************************************************//**
255 256
Duplicates a NUL-terminated string.
@return	own: a copy of the string, must be deallocated with mem_free */
osku's avatar
osku committed
257 258 259 260
UNIV_INLINE
char*
mem_strdup(
/*=======*/
261
	const char*	str);	/*!< in: string to be copied */
262
/**********************************************************************//**
263 264
Makes a NUL-terminated copy of a nonterminated string.
@return	own: a copy of the string, must be deallocated with mem_free */
osku's avatar
osku committed
265 266 267 268
UNIV_INLINE
char*
mem_strdupl(
/*========*/
269 270
	const char*	str,	/*!< in: string to be copied */
	ulint		len);	/*!< in: length of str, in bytes */
osku's avatar
osku committed
271

272
/**********************************************************************//**
273 274
Duplicates a NUL-terminated string, allocated from a memory heap.
@return	own: a copy of the string */
275
UNIV_INTERN
osku's avatar
osku committed
276 277 278
char*
mem_heap_strdup(
/*============*/
279 280
	mem_heap_t*	heap,	/*!< in: memory heap where string is allocated */
	const char*	str);	/*!< in: string to be copied */
281
/**********************************************************************//**
osku's avatar
osku committed
282
Makes a NUL-terminated copy of a nonterminated string,
283 284
allocated from a memory heap.
@return	own: a copy of the string */
osku's avatar
osku committed
285 286 287 288
UNIV_INLINE
char*
mem_heap_strdupl(
/*=============*/
289 290 291
	mem_heap_t*	heap,	/*!< in: memory heap where string is allocated */
	const char*	str,	/*!< in: string to be copied */
	ulint		len);	/*!< in: length of str, in bytes */
osku's avatar
osku committed
292

293
/**********************************************************************//**
294 295
Concatenate two strings and return the result, using a memory heap.
@return	own: the result */
296
UNIV_INTERN
297 298 299
char*
mem_heap_strcat(
/*============*/
300 301 302
	mem_heap_t*	heap,	/*!< in: memory heap where string is allocated */
	const char*	s1,	/*!< in: string 1 */
	const char*	s2);	/*!< in: string 2 */
303

304
/**********************************************************************//**
305 306
Duplicate a block of data, allocated from a memory heap.
@return	own: a copy of the data */
307
UNIV_INTERN
308 309 310
void*
mem_heap_dup(
/*=========*/
311 312 313
	mem_heap_t*	heap,	/*!< in: memory heap where copy is allocated */
	const void*	data,	/*!< in: data to be copied */
	ulint		len);	/*!< in: length of data, in bytes */
314

315
/****************************************************************//**
316 317 318
A simple (s)printf replacement that dynamically allocates the space for the
formatted string from the given heap. This supports a very limited set of
the printf syntax: types 's' and 'u' and length modifier 'l' (which is
319 320
required for the 'u' type).
@return	heap-allocated formatted string */
321
UNIV_INTERN
322 323 324
char*
mem_heap_printf(
/*============*/
325 326
	mem_heap_t*	heap,	/*!< in: memory heap */
	const char*	format,	/*!< in: format string */
327 328
	...) __attribute__ ((format (printf, 2, 3)));

osku's avatar
osku committed
329
#ifdef MEM_PERIODIC_CHECK
330
/******************************************************************//**
osku's avatar
osku committed
331 332
Goes through the list of all allocated mem blocks, checks their magic
numbers, and reports possible corruption. */
333
UNIV_INTERN
osku's avatar
osku committed
334 335 336 337 338 339
void
mem_validate_all_blocks(void);
/*=========================*/
#endif

/*#######################################################################*/
340

osku's avatar
osku committed
341 342 343
/* The info header of a block in a memory heap */

struct mem_block_info_struct {
344
	ulint	magic_n;/* magic number for debugging */
osku's avatar
osku committed
345
	char	file_name[8];/* file name where the mem heap was created */
346
	ulint	line;	/*!< line number where the mem heap was created */
osku's avatar
osku committed
347 348 349 350 351 352 353
	UT_LIST_BASE_NODE_T(mem_block_t) base; /* In the first block in the
			the list this is the base node of the list of blocks;
			in subsequent blocks this is undefined */
	UT_LIST_NODE_T(mem_block_t) list; /* This contains pointers to next
			and prev in the list. The first block allocated
			to the heap is also the first block in this list,
			though it also contains the base node of the list. */
354 355
	ulint	len;	/*!< physical length of this block in bytes */
	ulint	type;	/*!< type of heap: MEM_HEAP_DYNAMIC, or
osku's avatar
osku committed
356
			MEM_HEAP_BUF possibly ORed to MEM_HEAP_BTR_SEARCH */
357
	ulint	free;	/*!< offset in bytes of the first free position for
osku's avatar
osku committed
358
			user data in the block */
359
	ulint	start;	/*!< the value of the struct field 'free' at the
osku's avatar
osku committed
360
			creation of the block */
361
#ifndef UNIV_HOTBACKUP
362
	void*	free_block;
osku's avatar
osku committed
363 364 365 366 367
			/* if the MEM_HEAP_BTR_SEARCH bit is set in type,
			and this is the heap root, this can contain an
			allocated buffer frame, which can be appended as a
			free block to the heap, if we need more space;
			otherwise, this is NULL */
368 369 370 371
	void*	buf_block;
			/* if this block has been allocated from the buffer
			pool, this contains the buf_block_t handle;
			otherwise, this is NULL */
372
#endif /* !UNIV_HOTBACKUP */
373
#ifdef MEM_PERIODIC_CHECK
osku's avatar
osku committed
374 375 376 377 378 379 380 381 382 383
	UT_LIST_NODE_T(mem_block_t) mem_block_list;
			/* List of all mem blocks allocated; protected
			by the mem_comm_pool mutex */
#endif
};

#define MEM_BLOCK_MAGIC_N	764741555
#define MEM_FREED_BLOCK_MAGIC_N	547711122

/* Header size for a memory heap block */
384
#define MEM_BLOCK_HEADER_SIZE	ut_calc_align(sizeof(mem_block_info_t),\
osku's avatar
osku committed
385 386 387 388 389 390 391
							UNIV_MEM_ALIGNMENT)
#include "mem0dbg.h"

#ifndef UNIV_NONINL
#include "mem0mem.ic"
#endif

392
#endif