coregrind/pub_core_mallocfree.h

   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-2017 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, see <http://www.gnu.org/licenses/>.
  25
  26    The GNU General Public License is contained in the file COPYING.
  27 */
  28
  29 #ifndef __PUB_CORE_MALLOCFREE_H
  30 #define __PUB_CORE_MALLOCFREE_H
  31
  32 #include "pub_tool_mallocfree.h"
  33
  34 //--------------------------------------------------------------------
  35 // PURPOSE: high-level memory allocation (malloc/free), for the core and
  36 // tools.
  37 //--------------------------------------------------------------------
  38
  39 /* Allocation arenas.
  40
  41       CORE      for the core's and tools' general use.
  42       DINFO     for debug info (symbols, line #s, CFI, etc) storage.
  43       CLIENT    for the client's mallocs/frees, if the tool replaces glibc's
  44                     malloc() et al -- redzone size is chosen by the tool.
  45       DEMANGLE  for the C++ demangler.
  46       TTAUX     for storing TT/TC auxiliary structures (address range
  47                 equivalence classes).
  48
  49    When adding a new arena, remember also to add it to ensure_mm_init().
  50 */
  51 typedef Int ArenaId;
  52
  53 #define VG_N_ARENAS        5
  54
  55 #define VG_AR_CORE         0
  56 #define VG_AR_DINFO        1
  57 #define VG_AR_CLIENT       2
  58 #define VG_AR_DEMANGLE     3
  59 #define VG_AR_TTAUX        4
  60
  61 // This is both the minimum payload size of a malloc'd block, and its
  62 // minimum alignment.  Must be a power of 2 greater than 4, and should be
  63 // greater than 8.
  64 #if   defined(VGP_x86_linux)    || \
  65       defined(VGP_arm_linux)    || \
  66       defined(VGP_mips32_linux) || \
  67       (defined(VGP_mips64_linux) && defined(VGABI_N32)) || \
  68       defined(VGP_nanomips_linux) || \
  69       defined(VGP_x86_solaris)
  70 #  define VG_MIN_MALLOC_SZB        8
  71 // Nb: We always use 16 bytes for Darwin, even on 32-bits, so it can be used
  72 // for any AltiVec- or SSE-related type.  This matches the Darwin libc.
  73 // Also, use 16 bytes for any PPC variant, since 16 is required to make
  74 // Altiveccery work right.
  75 #elif defined(VGP_amd64_linux)    || \
  76       defined(VGP_ppc32_linux)    || \
  77       defined(VGP_ppc64be_linux)  || \
  78       defined(VGP_ppc64le_linux)  || \
  79       defined(VGP_s390x_linux)    || \
  80       (defined(VGP_mips64_linux) && !defined(VGABI_N32)) || \
  81       defined(VGP_x86_freebsd)    || \
  82       defined(VGP_amd64_freebsd)  || \
  83       defined(VGP_x86_darwin)     || \
  84       defined(VGP_amd64_darwin)   || \
  85       defined(VGP_arm64_linux)    || \
  86       defined(VGP_amd64_solaris)
  87 #  define VG_MIN_MALLOC_SZB       16
  88 #else
  89 #  error Unknown platform
  90 #endif
  91
  92 /* This struct definition MUST match the system one. */
  93 /* SVID2/XPG mallinfo structure */
  94 struct vg_mallinfo {
  95    int arena;    /* total space allocated from system */
  96    int ordblks;  /* number of non-inuse chunks */
  97    int smblks;   /* unused -- always zero */
  98    int hblks;    /* number of mmapped regions */
  99    int hblkhd;   /* total space in mmapped regions */
 100    int usmblks;  /* unused -- always zero */
 101    int fsmblks;  /* unused -- always zero */
 102    int uordblks; /* total allocated space */
 103    int fordblks; /* total non-inuse space */
 104    int keepcost; /* top-most, releasable (via malloc_trim) space */
 105 };
 106
 107 extern void* VG_(arena_malloc)  ( ArenaId arena, const HChar* cc, SizeT nbytes );
 108 extern void  VG_(arena_free)    ( ArenaId arena, void* ptr );
 109 extern void* VG_(arena_calloc)  ( ArenaId arena, const HChar* cc,
 110                                   SizeT nmemb, SizeT bytes_per_memb );
 111 extern void* VG_(arena_realloc) ( ArenaId arena, const HChar* cc,
 112                                   void* ptr, SizeT size );
 113 extern void* VG_(arena_memalign)( ArenaId aid, const HChar* cc,
 114                                   SizeT req_alignB, SizeT req_pszB );
 115 extern HChar* VG_(arena_strdup)  ( ArenaId aid, const HChar* cc,
 116                                    const HChar* s);
 117
 118 /* Specialised version of realloc, that shrinks the size of the block ptr from
 119    its current size to req_pszB.
 120    req_pszB must be <= to the current size of ptr (otherwise it will assert).
 121    Compared to VG_(arena_realloc):
 122      * VG_(arena_realloc_shrink) cannot increase the size of ptr.
 123      * If large enough, the unused memory is made usable for other allocation.
 124      * ptr is shrunk in place, so as to avoid temporary allocation and memcpy. */
 125 extern void VG_(arena_realloc_shrink) ( ArenaId aid,
 126                                         void* ptr, SizeT req_pszB);
 127
 128 extern SizeT VG_(arena_malloc_usable_size) ( ArenaId aid, void* payload );
 129
 130 extern SizeT VG_(arena_redzone_size) ( ArenaId aid );
 131
 132 extern void  VG_(mallinfo) ( ThreadId tid, struct vg_mallinfo* mi );
 133
 134 // VG_(arena_perm_malloc) is for permanent allocation of small blocks.
 135 // See VG_(perm_malloc) in pub_tool_mallocfree.h for more details.
 136 // Do not call any VG_(arena_*) functions with these permanent blocks.
 137 extern void* VG_(arena_perm_malloc) ( ArenaId aid, SizeT nbytes, Int align );
 138
 139 extern void  VG_(sanity_check_malloc_all) ( void );
 140
 141 extern void  VG_(print_all_arena_stats) ( void );
 142
 143 extern void  VG_(print_arena_cc_analysis) ( void );
 144
 145 typedef
 146    struct _AddrArenaInfo
 147    AddrArenaInfo;
 148
 149 struct _AddrArenaInfo {
 150    ArenaId aid;
 151    const HChar* name; // arena name, !NULL if Addr a points in an arena.
 152    SizeT       block_szB;
 153    PtrdiffT    rwoffset;
 154    Bool        free;  // True if this is in the arena free zone.
 155 };
 156 /* If Addr a points in one of the allocation arenas, describes Addr a in *aai
 157    otherwise sets *aai to 0/NULL/...
 158    Note that no information is produced for addresses allocated with
 159    VG_(arena_perm_malloc). */
 160 extern void VG_(describe_arena_addr) ( Addr a, /*OUT*/AddrArenaInfo* aai );
 161
 162 #endif   // __PUB_CORE_MALLOCFREE_H
 163
 164 /*--------------------------------------------------------------------*/
 165 /*--- end                                                          ---*/
 166 /*--------------------------------------------------------------------*/