Home | History | Annotate | Download | only in include
      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-2011 Julian Seward
     12       jseward (at) 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, write to the Free Software
     26    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
     27    02111-1307, USA.
     28 
     29    The GNU General Public License is contained in the file COPYING.
     30 */
     31 
     32 #ifndef __PUB_TOOL_MALLOCFREE_H
     33 #define __PUB_TOOL_MALLOCFREE_H
     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)         ( HChar* cc, SizeT nbytes );
     41 extern void  VG_(free)           ( void* p );
     42 extern void* VG_(calloc)         ( HChar* cc, SizeT n, SizeT bytes_per_elem );
     43 extern void* VG_(realloc)        ( HChar* cc, void* p, SizeT size );
     44 extern Char* VG_(strdup)         ( HChar* cc, const Char* s );
     45 
     46 // Returns the usable size of a heap-block.  It's the asked-for size plus
     47 // possibly some more due to rounding up.
     48 extern SizeT VG_(malloc_usable_size)( void* p );
     49 
     50 // TODO: move somewhere else
     51 // Call here to bomb the system when out of memory (mmap anon fails)
     52 __attribute__((noreturn))
     53 extern void VG_(out_of_memory_NORETURN) ( HChar* who, SizeT szB );
     54 
     55 #endif   // __PUB_TOOL_MALLOCFREE_H
     56 
     57 /*--------------------------------------------------------------------*/
     58 /*--- end                                                          ---*/
     59 /*--------------------------------------------------------------------*/
     60 
     61