| njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame^] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- High-level memory management. pub_core_mallocfree.h ---*/ |
| 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
| 6 | /* |
| 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
| 9 | |
| 10 | Copyright (C) 2000-2005 Julian Seward |
| 11 | jseward@acm.org |
| 12 | |
| 13 | This program is free software; you can redistribute it and/or |
| 14 | modify it under the terms of the GNU General Public License as |
| 15 | published by the Free Software Foundation; either version 2 of the |
| 16 | License, or (at your option) any later version. |
| 17 | |
| 18 | This program is distributed in the hope that it will be useful, but |
| 19 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 21 | General Public License for more details. |
| 22 | |
| 23 | You should have received a copy of the GNU General Public License |
| 24 | along with this program; if not, write to the Free Software |
| 25 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 26 | 02111-1307, USA. |
| 27 | |
| 28 | The GNU General Public License is contained in the file COPYING. |
| 29 | */ |
| 30 | |
| 31 | #ifndef __PUB_CORE_MALLOCFREE_H |
| 32 | #define __PUB_CORE_MALLOCFREE_H |
| 33 | |
| 34 | #include "pub_tool_mallocfree.h" |
| 35 | |
| 36 | //-------------------------------------------------------------------- |
| 37 | // PURPOSE: high-level memory allocation (malloc/free), for the core and |
| 38 | // tools. |
| 39 | //-------------------------------------------------------------------- |
| 40 | |
| 41 | /* Allocation arenas. |
| 42 | |
| 43 | CORE for the core's general use. |
| 44 | TOOL for the tool to use (and the only one it uses). |
| 45 | SYMTAB for Valgrind's symbol table storage. |
| 46 | CLIENT for the client's mallocs/frees, if the tool replaces glibc's |
| 47 | malloc() et al -- redzone size is chosen by the tool. |
| 48 | DEMANGLE for the C++ demangler. |
| 49 | EXECTXT for storing ExeContexts. |
| 50 | ERRORS for storing CoreErrors. |
| 51 | |
| 52 | When adding a new arena, remember also to add it to ensure_mm_init(). |
| 53 | */ |
| 54 | typedef Int ArenaId; |
| 55 | |
| 56 | #define VG_N_ARENAS 7 |
| 57 | |
| 58 | #define VG_AR_CORE 0 |
| 59 | #define VG_AR_TOOL 1 |
| 60 | #define VG_AR_SYMTAB 2 |
| 61 | #define VG_AR_CLIENT 3 |
| 62 | #define VG_AR_DEMANGLE 4 |
| 63 | #define VG_AR_EXECTXT 5 |
| 64 | #define VG_AR_ERRORS 6 |
| 65 | |
| 66 | // This is both the minimum payload size of a malloc'd block, and its |
| 67 | // minimum alignment. Must be a power of 2 greater than 4, and should be |
| 68 | // greater than 8. |
| 69 | #define VG_MIN_MALLOC_SZB 8 |
| 70 | |
| 71 | extern void* VG_(arena_malloc) ( ArenaId arena, SizeT nbytes ); |
| 72 | extern void VG_(arena_free) ( ArenaId arena, void* ptr ); |
| 73 | extern void* VG_(arena_calloc) ( ArenaId arena, |
| 74 | SizeT nmemb, SizeT bytes_per_memb ); |
| 75 | extern void* VG_(arena_realloc) ( ArenaId arena, void* ptr, SizeT size ); |
| 76 | extern void* VG_(arena_memalign)( ArenaId aid, SizeT req_alignB, |
| 77 | SizeT req_pszB ); |
| 78 | |
| 79 | /* Sets the size of the redzones at the start and end of heap blocks. This |
| 80 | must be called before any of VG_(malloc) and friends are called. */ |
| 81 | extern void VG_(set_client_malloc_redzone_szB) ( SizeT rz_szB ); |
| 82 | |
| 83 | extern SizeT VG_(arena_payload_szB) ( ArenaId aid, void* payload ); |
| 84 | |
| 85 | extern void VG_(sanity_check_malloc_all) ( void ); |
| 86 | |
| 87 | extern void VG_(print_all_arena_stats) ( void ); |
| 88 | |
| 89 | #endif // __PUB_CORE_MALLOCFREE_H |
| 90 | |
| 91 | /*--------------------------------------------------------------------*/ |
| 92 | /*--- end ---*/ |
| 93 | /*--------------------------------------------------------------------*/ |