njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 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 | |
sewardj | 03f8d3f | 2012-08-05 15:46:46 +0000 | [diff] [blame] | 11 | Copyright (C) 2000-2012 Julian Seward |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 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 | // These can be for allocating memory used by tools. |
njn | 1b4e123 | 2007-03-27 07:41:33 +0000 | [diff] [blame] | 36 | // Nb: the allocators *always succeed* -- they never return NULL (Valgrind |
| 37 | // will abort if they can't allocate the memory). |
njn | 608bfe7 | 2009-08-05 22:51:17 +0000 | [diff] [blame] | 38 | // The 'cc' is a string that identifies the allocation point. It's used when |
| 39 | // --profile-heap=yes is specified. |
florian | 54fe202 | 2012-10-27 23:07:42 +0000 | [diff] [blame] | 40 | extern void* VG_(malloc) ( const HChar* cc, SizeT nbytes ); |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 41 | extern void VG_(free) ( void* p ); |
florian | 54fe202 | 2012-10-27 23:07:42 +0000 | [diff] [blame] | 42 | extern void* VG_(calloc) ( const HChar* cc, SizeT n, SizeT bytes_per_elem ); |
florian | 19f91bb | 2012-11-10 22:29:54 +0000 | [diff] [blame] | 43 | extern void* VG_(realloc) ( const HChar* cc, void* p, SizeT size ); |
| 44 | extern HChar* VG_(strdup) ( const HChar* cc, const HChar* s ); |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 45 | |
njn | 32397c0 | 2007-11-10 04:08:08 +0000 | [diff] [blame] | 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 | |
philippe | d99c26a | 2012-07-31 22:17:28 +0000 | [diff] [blame] | 50 | // If tool is replacing malloc for the client, the below returns |
| 51 | // the effective client redzone as derived from the default |
| 52 | // provided by the tool, VG_(clo_redzone_size) and the minimum |
| 53 | // redzone required by m_mallocfree.c. |
| 54 | // It is an error to call this before VG_(needs_malloc_replacement) has |
| 55 | // been called. |
| 56 | extern SizeT VG_(malloc_effective_client_redzone_size)(void); |
| 57 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 58 | // TODO: move somewhere else |
| 59 | // Call here to bomb the system when out of memory (mmap anon fails) |
njn | 4c245e5 | 2009-03-15 23:25:38 +0000 | [diff] [blame] | 60 | __attribute__((noreturn)) |
florian | 54fe202 | 2012-10-27 23:07:42 +0000 | [diff] [blame] | 61 | extern void VG_(out_of_memory_NORETURN) ( const HChar* who, SizeT szB ); |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 62 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 63 | #endif // __PUB_TOOL_MALLOCFREE_H |
| 64 | |
| 65 | /*--------------------------------------------------------------------*/ |
| 66 | /*--- end ---*/ |
| 67 | /*--------------------------------------------------------------------*/ |
| 68 | |