1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- MallocFree: high-level memory management. ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- pub_tool_mallocfree.h ---*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 10ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 11436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2000-2013 Julian Seward 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_TOOL_MALLOCFREE_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_MALLOCFREE_H 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 35436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov#include "pub_tool_basics.h" // SizeT 36436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// These can be for allocating memory used by tools. 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Nb: the allocators *always succeed* -- they never return NULL (Valgrind 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// will abort if they can't allocate the memory). 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// The 'cc' is a string that identifies the allocation point. It's used when 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// --profile-heap=yes is specified. 42436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void* VG_(malloc) ( const HChar* cc, SizeT nbytes ); 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(free) ( void* p ); 44436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void* VG_(calloc) ( const HChar* cc, SizeT n, SizeT bytes_per_elem ); 45436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void* VG_(realloc) ( const HChar* cc, void* p, SizeT size ); 46436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern HChar* VG_(strdup) ( const HChar* cc, const HChar* s ); 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Returns the usable size of a heap-block. It's the asked-for size plus 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// possibly some more due to rounding up. 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SizeT VG_(malloc_usable_size)( void* p ); 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// TODO: move somewhere else 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Call here to bomb the system when out of memory (mmap anon fails) 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__((noreturn)) 55436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void VG_(out_of_memory_NORETURN) ( const HChar* who, SizeT szB ); 56436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov 57436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// VG_(perm_malloc) is for allocating small blocks which are 58436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// never released. The overhead for such blocks is minimal. 59436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// VG_(perm_malloc) returns memory which is (at least) aligned 60436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// on a multiple of align. 61436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// Use the macro vg_alignof (type) to get a safe alignment for a type. 62436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// No other function can be used on these permanently allocated blocks. 63436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// In particular, do *not* call VG_(free) or VG_(malloc_usable_size) 64436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// or VG_(realloc). 65436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// Technically, these blocks will be returned from big superblocks 66436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// only containing such permanently allocated blocks. 67436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// Note that there is no cc cost centre : all such blocks will be 68436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov// regrouped under the "perm_alloc" cost centre. 69436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void* VG_(perm_malloc) ( SizeT nbytes, Int align ); 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_TOOL_MALLOCFREE_H 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 77