source3/lib/util_malloc.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Jeremy Allison 2001-2007
   6    Copyright (C) Simo Sorce 2001
   7    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
   8    Copyright (C) James Peach 2006
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #include "includes.h"
  25
  26 /* Max allowable allococation - 256mb - 0x10000000 */
  27 #define MAX_ALLOC_SIZE (1024*1024*256)
  28
  29 #if defined(PARANOID_MALLOC_CHECKER)
  30
  31 /****************************************************************************
  32  Internal malloc wrapper. Externally visible.
  33 ****************************************************************************/
  34
  35 void *malloc_(size_t size)
  36 {
  37         if (size == 0) {
  38                 return NULL;
  39         }
  40 #undef malloc
  41         return malloc(size);
  42 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
  43 }
  44
  45 /****************************************************************************
  46  Internal calloc wrapper. Not externally visible.
  47 ****************************************************************************/
  48
  49 static void *calloc_(size_t count, size_t size)
  50 {
  51         if (size == 0 || count == 0) {
  52                 return NULL;
  53         }
  54 #undef calloc
  55         return calloc(count, size);
  56 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
  57 }
  58
  59 /****************************************************************************
  60  Internal realloc wrapper. Not externally visible.
  61 ****************************************************************************/
  62
  63 static void *realloc_(void *ptr, size_t size)
  64 {
  65 #undef realloc
  66         return realloc(ptr, size);
  67 #define realloc(p,s) __ERROR_DONT_USE_RELLOC_DIRECTLY
  68 }
  69
  70 #endif /* PARANOID_MALLOC_CHECKER */
  71
  72 /****************************************************************************
  73  Expand a pointer to be a particular size.
  74  Note that this version of Realloc has an extra parameter that decides
  75  whether to free the passed in storage on allocation failure or if the
  76  new size is zero.
  77
  78  This is designed for use in the typical idiom of :
  79
  80  p = SMB_REALLOC(p, size)
  81  if (!p) {
  82     return error;
  83  }
  84
  85  and not to have to keep track of the old 'p' contents to free later, nor
  86  to worry if the size parameter was zero. In the case where NULL is returned
  87  we guarentee that p has been freed.
  88
  89  If free later semantics are desired, then pass 'free_old_on_error' as False which
  90  guarentees that the old contents are not freed on error, even if size == 0. To use
  91  this idiom use :
  92
  93  tmp = SMB_REALLOC_KEEP_OLD_ON_ERROR(p, size);
  94  if (!tmp) {
  95     SAFE_FREE(p);
  96     return error;
  97  } else {
  98     p = tmp;
  99  }
 100
 101  Changes were instigated by Coverity error checking. JRA.
 102 ****************************************************************************/
 103
 104 void *Realloc(void *p, size_t size, bool free_old_on_error)
 105 {
 106         void *ret=NULL;
 107
 108         if (size == 0) {
 109                 if (free_old_on_error) {
 110                         SAFE_FREE(p);
 111                 }
 112                 DEBUG(2,("Realloc asked for 0 bytes\n"));
 113                 return NULL;
 114         }
 115
 116 #if defined(PARANOID_MALLOC_CHECKER)
 117         if (!p) {
 118                 ret = (void *)malloc_(size);
 119         } else {
 120                 ret = (void *)realloc_(p,size);
 121         }
 122 #else
 123         if (!p) {
 124                 ret = (void *)malloc(size);
 125         } else {
 126                 ret = (void *)realloc(p,size);
 127         }
 128 #endif
 129
 130         if (!ret) {
 131                 if (free_old_on_error && p) {
 132                         SAFE_FREE(p);
 133                 }
 134                 DEBUG(0,("Memory allocation error: failed to expand to %d bytes\n",(int)size));
 135         }
 136
 137         return(ret);
 138 }
 139