include/pub_tool_mallocfree.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- MallocFree: high-level memory management.                    ---*/
   4 /*---                                        pub_tool_mallocfree.h ---*/
   5 /*--------------------------------------------------------------------*/
   6
   7 /*
   8    This file is part of Valgrind, a dynamic binary instrumentation
   9    framework.
  10
  11    Copyright (C) 2000-2017 Julian Seward
  12       jseward@acm.org
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of the
  17    License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful, but
  20    WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public License
  25    along with this program; if not, see <http://www.gnu.org/licenses/>.
  26
  27    The GNU General Public License is contained in the file COPYING.
  28 */
  29
  30 #ifndef __PUB_TOOL_MALLOCFREE_H
  31 #define __PUB_TOOL_MALLOCFREE_H
  32
  33 #include "pub_tool_basics.h"   // SizeT
  34
  35 // These can be for allocating memory used by tools.
  36 // Nb: the allocators *always succeed* -- they never return NULL (Valgrind
  37 // will abort if they can't allocate the memory).
  38 // The 'cc' is a string that identifies the allocation point.  It's used when
  39 // --profile-heap=yes is specified.
  40 extern void* VG_(malloc)         ( const HChar* cc, SizeT nbytes );
  41 extern void  VG_(free)           ( void* p );
  42 extern void* VG_(calloc)         ( const HChar* cc, SizeT n, SizeT bytes_per_elem );
  43 extern void*  VG_(realloc)       ( const HChar* cc, void* p, SizeT size );
  44 extern void   VG_(realloc_shrink)( void* ptr, SizeT size );
  45 extern HChar* VG_(strdup)        ( const HChar* cc, const HChar* s );
  46
  47 // TODO: move somewhere else
  48 // Call here to bomb the system when out of memory (mmap anon fails)
  49 // Provide the VKI errno if possible (normally the result of sr_Err),
  50 // may be zero if unknown.
  51 __attribute__((noreturn))
  52 extern void VG_(out_of_memory_NORETURN) ( const HChar* who, SizeT szB,
  53                                           UWord err );
  54
  55 // VG_(perm_malloc) is for allocating small blocks which are
  56 // never released. The overhead for such blocks is minimal.
  57 // VG_(perm_malloc) returns memory which is (at least) aligned
  58 // on a multiple of align.
  59 // Use the macro vg_alignof (type) to get a safe alignment for a type.
  60 // No other function can be used on these permanently allocated blocks.
  61 // In particular, do *not* call VG_(free) or VG_(realloc).
  62 // Technically, these blocks will be returned from big superblocks
  63 // only containing such permanently allocated blocks.
  64 // Note that there is no cc cost centre : all such blocks will be
  65 // regrouped under the "perm_alloc" cost centre.
  66 extern void* VG_(perm_malloc)    ( SizeT nbytes, Int align );
  67
  68 #endif   // __PUB_TOOL_MALLOCFREE_H
  69
  70 /*--------------------------------------------------------------------*/
  71 /*--- end                                                          ---*/
  72 /*--------------------------------------------------------------------*/
  73