sdcc/support/util/newalloc.h

   1 /*-------------------------------------------------------------------------
   2    newalloc.h - SDCC Memory allocation functions
   3
   4    These functions are wrappers for the standard malloc, realloc and free
   5    functions.
   6
   7    This program is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by the
   9    Free Software Foundation; either version 2, or (at your option) any
  10    later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20 -------------------------------------------------------------------------*/
  21
  22 #if !defined(_NewAlloc_H)
  23
  24 #define _NewAlloc_H
  25
  26 #include <memory.h>
  27
  28 typedef struct _allocTrace
  29 {
  30   int num;
  31   int max;
  32   void **palloced;
  33 } allocTrace;
  34
  35 /*
  36 -------------------------------------------------------------------------------
  37 Clear_realloc - Reallocate a memory block and clear any memory added with
  38 out of memory error detection
  39
  40 -------------------------------------------------------------------------------
  41 */
  42
  43 void *Clear_realloc (void *OldPtr, size_t OldSize, size_t NewSize);
  44
  45 /*
  46 -------------------------------------------------------------------------------
  47 Safe_realloc - Reallocate a memory block with out of memory error detection
  48
  49 -------------------------------------------------------------------------------
  50 */
  51
  52 void *Safe_realloc (void *OldPtr, size_t NewSize);
  53
  54 /*
  55 -------------------------------------------------------------------------------
  56 Safe_calloc - Allocate a block of memory from the application heap, clearing
  57 all data to zero and checking for out or memory errors.
  58
  59 -------------------------------------------------------------------------------
  60 */
  61
  62 void *Safe_calloc (size_t Elements, size_t Size);
  63
  64 /*
  65 -------------------------------------------------------------------------------
  66 Safe_malloc - Allocate a block of memory from the application heap
  67 and checking for out or memory errors.
  68
  69 -------------------------------------------------------------------------------
  70 */
  71
  72 void *Safe_malloc (size_t Size);
  73
  74 /** Replacement for Safe_malloc that also zeros memory.  To make it interchangable.
  75  */
  76 void *Safe_alloc (size_t Size);
  77
  78 /** Function to make the replacements complete.
  79  */
  80 void Safe_free (void *p);
  81
  82 /** Creates a copy of a string with specified length in a safe way.
  83  */
  84 char *Safe_strndup (const char *sz, size_t len);
  85
  86 /** Creates a copy of a string in a safe way.
  87  */
  88 char *Safe_strdup (const char *sz);
  89
  90 /** Logs the allocated memory 'p' in the given trace for batch freeing
  91     later using freeTrace.
  92 */
  93 void *traceAlloc (allocTrace * ptrace, void *p);
  94
  95 /** Frees all the memory logged in the trace and resets the trace.
  96  */
  97 void freeTrace (allocTrace * ptrace);
  98
  99 #endif