• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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-2010 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       DINFO     for debug info (symbols, line #s, CFI, etc) 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       TTAUX     for storing TT/TC auxiliary structures (address range
52                 equivalence classes).
53 
54    When adding a new arena, remember also to add it to ensure_mm_init().
55 */
56 typedef Int ArenaId;
57 
58 #define VG_N_ARENAS        8
59 
60 #define VG_AR_CORE         0
61 #define VG_AR_TOOL         1
62 #define VG_AR_DINFO        2
63 #define VG_AR_CLIENT       3
64 #define VG_AR_DEMANGLE     4
65 #define VG_AR_EXECTXT      5
66 #define VG_AR_ERRORS       6
67 #define VG_AR_TTAUX        7
68 
69 // This is both the minimum payload size of a malloc'd block, and its
70 // minimum alignment.  Must be a power of 2 greater than 4, and should be
71 // greater than 8.
72 #if   defined(VGP_x86_linux)   || \
73       defined(VGP_ppc32_linux) || \
74       defined(VGP_arm_linux)
75 #  define VG_MIN_MALLOC_SZB        8
76 // Nb: We always use 16 bytes for Darwin, even on 32-bits, so it can be used
77 // for any AltiVec- or SSE-related type.  This matches the Darwin libc.
78 #elif defined(VGP_amd64_linux) || \
79       defined(VGP_ppc64_linux) || \
80       defined(VGP_ppc64_aix5)  || \
81       defined(VGP_ppc32_aix5)  || \
82       defined(VGP_x86_darwin)  || \
83       defined(VGP_amd64_darwin)
84 #  define VG_MIN_MALLOC_SZB       16
85 #else
86 #  error Unknown platform
87 #endif
88 
89 /* This struct definition MUST match the system one. */
90 /* SVID2/XPG mallinfo structure */
91 struct vg_mallinfo {
92    int arena;    /* total space allocated from system */
93    int ordblks;  /* number of non-inuse chunks */
94    int smblks;   /* unused -- always zero */
95    int hblks;    /* number of mmapped regions */
96    int hblkhd;   /* total space in mmapped regions */
97    int usmblks;  /* unused -- always zero */
98    int fsmblks;  /* unused -- always zero */
99    int uordblks; /* total allocated space */
100    int fordblks; /* total non-inuse space */
101    int keepcost; /* top-most, releasable (via malloc_trim) space */
102 };
103 
104 extern void* VG_(arena_malloc)  ( ArenaId arena, HChar* cc, SizeT nbytes );
105 extern void  VG_(arena_free)    ( ArenaId arena, void* ptr );
106 extern void* VG_(arena_calloc)  ( ArenaId arena, HChar* cc,
107                                   SizeT nmemb, SizeT bytes_per_memb );
108 extern void* VG_(arena_realloc) ( ArenaId arena, HChar* cc,
109                                   void* ptr, SizeT size );
110 extern void* VG_(arena_memalign)( ArenaId aid, HChar* cc,
111                                   SizeT req_alignB, SizeT req_pszB );
112 extern Char* VG_(arena_strdup)  ( ArenaId aid, HChar* cc,
113                                   const Char* s);
114 
115 extern SizeT VG_(arena_malloc_usable_size) ( ArenaId aid, void* payload );
116 
117 extern void  VG_(mallinfo) ( ThreadId tid, struct vg_mallinfo* mi );
118 
119 extern void  VG_(sanity_check_malloc_all) ( void );
120 
121 extern void  VG_(print_all_arena_stats) ( void );
122 
123 extern void  VG_(print_arena_cc_analysis) ( void );
124 
125 #endif   // __PUB_CORE_MALLOCFREE_H
126 
127 /*--------------------------------------------------------------------*/
128 /*--- end                                                          ---*/
129 /*--------------------------------------------------------------------*/
130