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 | |
Elliott Hughes | ed39800 | 2017-06-21 14:41:24 -0700 | [diff] [blame^] | 11 | Copyright (C) 2000-2017 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 | |
florian | 535fb1b | 2013-09-15 13:54:34 +0000 | [diff] [blame] | 35 | #include "pub_tool_basics.h" // SizeT |
| 36 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 37 | // These can be for allocating memory used by tools. |
njn | 1b4e123 | 2007-03-27 07:41:33 +0000 | [diff] [blame] | 38 | // Nb: the allocators *always succeed* -- they never return NULL (Valgrind |
| 39 | // will abort if they can't allocate the memory). |
njn | 608bfe7 | 2009-08-05 22:51:17 +0000 | [diff] [blame] | 40 | // The 'cc' is a string that identifies the allocation point. It's used when |
| 41 | // --profile-heap=yes is specified. |
florian | 54fe202 | 2012-10-27 23:07:42 +0000 | [diff] [blame] | 42 | extern void* VG_(malloc) ( const HChar* cc, SizeT nbytes ); |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 43 | extern void VG_(free) ( void* p ); |
florian | 54fe202 | 2012-10-27 23:07:42 +0000 | [diff] [blame] | 44 | extern void* VG_(calloc) ( const HChar* cc, SizeT n, SizeT bytes_per_elem ); |
florian | 19f91bb | 2012-11-10 22:29:54 +0000 | [diff] [blame] | 45 | extern void* VG_(realloc) ( const HChar* cc, void* p, SizeT size ); |
florian | 77eb20b | 2014-09-11 21:19:17 +0000 | [diff] [blame] | 46 | extern void VG_(realloc_shrink)( void* ptr, SizeT size ); |
florian | 19f91bb | 2012-11-10 22:29:54 +0000 | [diff] [blame] | 47 | extern HChar* VG_(strdup) ( const HChar* cc, const HChar* s ); |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 48 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 49 | // TODO: move somewhere else |
| 50 | // Call here to bomb the system when out of memory (mmap anon fails) |
njn | 4c245e5 | 2009-03-15 23:25:38 +0000 | [diff] [blame] | 51 | __attribute__((noreturn)) |
florian | 54fe202 | 2012-10-27 23:07:42 +0000 | [diff] [blame] | 52 | extern void VG_(out_of_memory_NORETURN) ( const HChar* who, SizeT szB ); |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 53 | |
philippe | 6e4b713 | 2013-01-18 06:19:49 +0000 | [diff] [blame] | 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. |
florian | e464e80 | 2014-09-11 20:15:23 +0000 | [diff] [blame] | 60 | // In particular, do *not* call VG_(free) or VG_(realloc). |
philippe | 6e4b713 | 2013-01-18 06:19:49 +0000 | [diff] [blame] | 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. |
| 65 | extern void* VG_(perm_malloc) ( SizeT nbytes, Int align ); |
| 66 | |
njn | 717cde5 | 2005-05-10 02:47:21 +0000 | [diff] [blame] | 67 | #endif // __PUB_TOOL_MALLOCFREE_H |
| 68 | |
| 69 | /*--------------------------------------------------------------------*/ |
| 70 | /*--- end ---*/ |
| 71 | /*--------------------------------------------------------------------*/ |
| 72 | |