mem0mem.h 14.5 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

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

osku's avatar
osku committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
/******************************************************
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 "ut0ut.h"
#include "ut0rnd.h"
#include "sync0sync.h"
#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
50 51
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
52 53 54

#define MEM_HEAP_DYNAMIC	0	/* the most common type */
#define MEM_HEAP_BUFFER		1
55 56 57 58 59 60 61
#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
62 63 64 65 66 67

/* 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. */

68
#define MEM_BLOCK_START_SIZE		64
69 70
#define MEM_BLOCK_STANDARD_SIZE		\
	(UNIV_PAGE_SIZE >= 16384 ? 8000 : MEM_MAX_ALLOC_IN_BUF)
osku's avatar
osku committed
71 72 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)

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

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

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

99
#define mem_heap_create_in_btr_search(N)	mem_heap_create_func(\
100
		(N), MEM_HEAP_BTR_SEARCH | MEM_HEAP_BUFFER,\
101
		__FILE__, __LINE__)
osku's avatar
osku committed
102 103 104 105 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__)
/*********************************************************************
NOTE: Use the corresponding macros instead of this function. Creates a
111 112
memory heap. For debugging purposes, takes also the file name and line as
arguments. */
osku's avatar
osku committed
113 114 115 116
UNIV_INLINE
mem_heap_t*
mem_heap_create_func(
/*=================*/
117 118 119
					/* out, own: memory heap, NULL if
					did not succeed (only possible for
					MEM_HEAP_BTR_SEARCH type heaps)*/
osku's avatar
osku committed
120 121
	ulint		n,		/* in: desired start block size,
					this means that a single user buffer
122
					of size n will fit in the block,
123
					0 creates a default size block */
124
	ulint		type,		/* in: heap type */
osku's avatar
osku committed
125
	const char*	file_name,	/* in: file name where created */
126
	ulint		line);		/* in: line where created */
osku's avatar
osku committed
127 128 129 130 131 132 133 134
/*********************************************************************
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(
/*===============*/
135 136 137
	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 */
osku's avatar
osku committed
138
/*******************************************************************
139 140 141
Allocates and zero-fills n bytes of memory from a memory heap. */
UNIV_INLINE
void*
142
mem_heap_zalloc(
143
/*============*/
144
				/* out: allocated, zero-filled storage */
145 146 147 148 149
	mem_heap_t*	heap,	/* in: memory heap */
	ulint		n);	/* in: number of bytes; if the heap is allowed
				to grow into the buffer pool, this must be
				<= MEM_MAX_ALLOC_IN_BUF */
/*******************************************************************
osku's avatar
osku committed
150 151 152 153 154
Allocates n bytes of memory from a memory heap. */
UNIV_INLINE
void*
mem_heap_alloc(
/*===========*/
155 156 157
				/* out: allocated storage, NULL if did not
				succeed (only possible for
				MEM_HEAP_BTR_SEARCH type heaps) */
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 162 163 164 165 166
				to grow into the buffer pool, this must be
				<= MEM_MAX_ALLOC_IN_BUF */
/*********************************************************************
Returns a pointer to the heap top. */
UNIV_INLINE
byte*
mem_heap_get_heap_top(
167
/*==================*/
osku's avatar
osku committed
168
				/* out: pointer to the heap top */
169
	mem_heap_t*	heap);	/* in: memory heap */
osku's avatar
osku committed
170 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
	mem_heap_t*	heap,	/* in: heap from which to free */
osku's avatar
osku committed
179 180 181 182 183 184 185
	byte*		old_top);/* in: pointer to old top of heap */
/*********************************************************************
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 */
osku's avatar
osku committed
187 188 189 190 191 192
/*********************************************************************
Returns a pointer to the topmost element in a memory heap.
The size of the element must be given. */
UNIV_INLINE
void*
mem_heap_get_top(
193
/*=============*/
osku's avatar
osku committed
194
				/* out: pointer to the topmost element */
195 196
	mem_heap_t*	heap,	/* in: memory heap */
	ulint		n);	/* in: size of the topmost element */
osku's avatar
osku committed
197 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 */
osku's avatar
osku committed
206 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 */
osku's avatar
osku committed
213 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__)
osku's avatar
osku committed
221 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
osku's avatar
osku committed
225 226 227 228 229
with mem_free. */
UNIV_INLINE
void*
mem_alloc_func(
/*===========*/
230
					/* out, own: free storage */
231 232 233
	ulint		n,		/* in: requested size in bytes */
	ulint*		size,		/* out: allocated size in bytes,
					or NULL */
osku's avatar
osku committed
234
	const char*	file_name,	/* in: file name where created */
235 236
	ulint		line);		/* in: line where created */

osku's avatar
osku committed
237 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__)
osku's avatar
osku committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
/*******************************************************************
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(
/*==========*/
	void*		ptr,		/* in, own: buffer to be freed */
	const char*	file_name,	/* in: file name where created */
	ulint		line		/* in: line where created */
);

/**************************************************************************
Duplicates a NUL-terminated string. */
UNIV_INLINE
char*
mem_strdup(
/*=======*/
				/* out, own: a copy of the string,
				must be deallocated with mem_free */
	const char*	str);	/* in: string to be copied */
/**************************************************************************
Makes a NUL-terminated copy of a nonterminated string. */
UNIV_INLINE
char*
mem_strdupl(
/*========*/
				/* out, own: a copy of the string,
				must be deallocated with mem_free */
	const char*	str,	/* in: string to be copied */
	ulint		len);	/* in: length of str, in bytes */

/**************************************************************************
Duplicates a NUL-terminated string, allocated from a memory heap. */
277
UNIV_INTERN
osku's avatar
osku committed
278 279 280 281
char*
mem_heap_strdup(
/*============*/
				/* out, own: a copy of the string */
282 283
	mem_heap_t*	heap,	/* in: memory heap where string is allocated */
	const char*	str);	/* in: string to be copied */
osku's avatar
osku committed
284 285 286 287 288 289 290 291 292 293 294 295
/**************************************************************************
Makes a NUL-terminated copy of a nonterminated string,
allocated from a memory heap. */
UNIV_INLINE
char*
mem_heap_strdupl(
/*=============*/
				/* out, own: a copy of the string */
	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 */

296 297
/**************************************************************************
Concatenate two strings and return the result, using a memory heap. */
298
UNIV_INTERN
299 300 301 302 303 304 305 306 307 308
char*
mem_heap_strcat(
/*============*/
				/* out, own: the result */
	mem_heap_t*	heap,	/* in: memory heap where string is allocated */
	const char*	s1,	/* in: string 1 */
	const char*	s2);	/* in: string 2 */

/**************************************************************************
Duplicate a block of data, allocated from a memory heap. */
309
UNIV_INTERN
310 311 312 313 314 315 316 317
void*
mem_heap_dup(
/*=========*/
				/* out, own: a copy of the data */
	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 */

318 319
/**************************************************************************
Concatenate two memory blocks and return the result, using a memory heap. */
320
UNIV_INTERN
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
void*
mem_heap_cat(
/*=========*/
				/* out, own: the result */
	mem_heap_t*	heap,	/* in: memory heap where result is allocated */
	const void*	b1,	/* in: block 1 */
	ulint		len1,	/* in: length of b1, in bytes */
	const void*	b2,	/* in: block 2 */
	ulint		len2);	/* in: length of b2, in bytes */

/********************************************************************
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
required for the 'u' type). */
336
UNIV_INTERN
337 338 339 340 341 342 343 344
char*
mem_heap_printf(
/*============*/
				/* out: heap-allocated formatted string */
	mem_heap_t*	heap,	/* in: memory heap */
	const char*	format,	/* in: format string */
	...) __attribute__ ((format (printf, 2, 3)));

osku's avatar
osku committed
345 346 347 348
#ifdef MEM_PERIODIC_CHECK
/**********************************************************************
Goes through the list of all allocated mem blocks, checks their magic
numbers, and reports possible corruption. */
349
UNIV_INTERN
osku's avatar
osku committed
350 351 352 353 354 355
void
mem_validate_all_blocks(void);
/*=========================*/
#endif

/*#######################################################################*/
356

osku's avatar
osku committed
357 358 359
/* The info header of a block in a memory heap */

struct mem_block_info_struct {
360
	ulint	magic_n;/* magic number for debugging */
osku's avatar
osku committed
361 362 363 364 365 366 367 368 369
	char	file_name[8];/* file name where the mem heap was created */
	ulint	line;	/* line number where the mem heap was created */
	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. */
370 371
	ulint	len;	/* physical length of this block in bytes */
	ulint	type;	/* type of heap: MEM_HEAP_DYNAMIC, or
osku's avatar
osku committed
372
			MEM_HEAP_BUF possibly ORed to MEM_HEAP_BTR_SEARCH */
373
	ulint	free;	/* offset in bytes of the first free position for
osku's avatar
osku committed
374
			user data in the block */
375
	ulint	start;	/* the value of the struct field 'free' at the
osku's avatar
osku committed
376
			creation of the block */
377
	void*	free_block;
osku's avatar
osku committed
378 379 380 381 382
			/* 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 */
383 384 385 386
	void*	buf_block;
			/* if this block has been allocated from the buffer
			pool, this contains the buf_block_t handle;
			otherwise, this is NULL */
387
#ifdef MEM_PERIODIC_CHECK
osku's avatar
osku committed
388 389 390 391 392 393 394 395 396 397
	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 */
398
#define MEM_BLOCK_HEADER_SIZE	ut_calc_align(sizeof(mem_block_info_t),\
osku's avatar
osku committed
399 400 401 402 403 404 405
							UNIV_MEM_ALIGNMENT)
#include "mem0dbg.h"

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

406
#endif