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-2013 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, 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#include "pub_tool_basics.h"   // SizeT
36
37// These can be for allocating memory used by tools.
38// Nb: the allocators *always succeed* -- they never return NULL (Valgrind
39// will abort if they can't allocate the memory).
40// The 'cc' is a string that identifies the allocation point.  It's used when
41// --profile-heap=yes is specified.
42extern void* VG_(malloc)         ( const HChar* cc, SizeT nbytes );
43extern void  VG_(free)           ( void* p );
44extern void* VG_(calloc)         ( const HChar* cc, SizeT n, SizeT bytes_per_elem );
45extern void*  VG_(realloc)       ( const HChar* cc, void* p, SizeT size );
46extern void   VG_(realloc_shrink)( void* ptr, SizeT size );
47extern HChar* VG_(strdup)        ( const HChar* cc, const HChar* s );
48
49// TODO: move somewhere else
50// Call here to bomb the system when out of memory (mmap anon fails)
51__attribute__((noreturn))
52extern void VG_(out_of_memory_NORETURN) ( const HChar* who, SizeT szB );
53
54// VG_(perm_malloc) is for allocating small blocks which are
55// never released. The overhead for such blocks is minimal.
56// VG_(perm_malloc) returns memory which is (at least) aligned
57// on a multiple of align.
58// Use the macro vg_alignof (type) to get a safe alignment for a type.
59// No other function can be used on these permanently allocated blocks.
60// In particular, do *not* call VG_(free) or VG_(realloc).
61// Technically, these blocks will be returned from big superblocks
62// only containing such permanently allocated blocks.
63// Note that there is no cc cost centre : all such blocks will be
64// regrouped under the "perm_alloc" cost centre.
65extern void* VG_(perm_malloc)    ( SizeT nbytes, Int align );
66
67#endif   // __PUB_TOOL_MALLOCFREE_H
68
69/*--------------------------------------------------------------------*/
70/*--- end                                                          ---*/
71/*--------------------------------------------------------------------*/
72
73