src/util/common_allocation.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2005, 2006 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/common_allocation.c
  23  * @brief wrapper around malloc/free
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29
  30 #ifndef INT_MAX
  31 #define INT_MAX 0x7FFFFFFF
  32 #endif
  33
  34 #if 0
  35 #define W32_MEM_LIMIT 200000000
  36 #endif
  37
  38 #ifdef W32_MEM_LIMIT
  39 static LONG mem_used = 0;
  40 #endif
  41
  42 /**
  43  * Allocate memory. Checks the return value, aborts if no more
  44  * memory is available.
  45  *
  46  * @param size how many bytes of memory to allocate, do NOT use
  47  *  this function (or GNUNET_malloc) to allocate more than several MB
  48  *  of memory, if you are possibly needing a very large chunk use
  49  *  GNUNET_xmalloc_unchecked_ instead.
  50  * @param filename where in the code was the call to GNUNET_malloc
  51  * @param linenumber where in the code was the call to GNUNET_malloc
  52  * @return pointer to size bytes of memory
  53  */
  54 void *
  55 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber)
  56 {
  57   void *ret;
  58   /* As a security precaution, we generally do not allow very large
  59      allocations using the default 'GNUNET_malloc' macro */
  60   GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
  61   ret = GNUNET_xmalloc_unchecked_ (size, filename, linenumber);
  62   if (ret == NULL)
  63     {
  64       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
  65       abort ();
  66     }
  67   return ret;
  68 }
  69
  70
  71 /**
  72  * Wrapper around malloc. Allocates size bytes of memory.
  73  * The memory will be zero'ed out.
  74  *
  75  * @param size the number of bytes to allocate
  76  * @param filename where in the code was the call to GNUNET_malloc_large
  77  * @param linenumber where in the code was the call to GNUNET_malloc_large
  78  * @return pointer to size bytes of memory, NULL if we do not have enough memory
  79  */
  80 void *
  81 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
  82 {
  83   void *result;
  84
  85 #ifdef W32_MEM_LIMIT
  86   size += sizeof (size_t);
  87   if (mem_used + size > W32_MEM_LIMIT)
  88     return NULL;
  89 #endif
  90
  91   GNUNET_assert_at (size < INT_MAX, filename, linenumber);
  92   result = malloc (size);
  93   if (result == NULL)
  94     return NULL;
  95   memset (result, 0, size);
  96
  97 #ifdef W32_MEM_LIMIT
  98   *((size_t *) result) = size;
  99   result = &((size_t *) result)[1];
 100   mem_used += size;
 101 #endif
 102
 103   return result;
 104 }
 105
 106
 107 /**
 108  * Reallocate memory. Checks the return value, aborts if no more
 109  * memory is available.
 110  *
 111  * @param ptr the pointer to reallocate
 112  * @param n how many bytes of memory to allocate
 113  * @param filename where in the code was the call to GNUNET_realloc
 114  * @param linenumber where in the code was the call to GNUNET_realloc
 115  * @return pointer to size bytes of memory
 116  */
 117 void *
 118 GNUNET_xrealloc_ (void *ptr,
 119 #ifndef W32_MEM_LIMIT
 120                   const size_t n,
 121 #else
 122                   size_t n,
 123 #endif
 124                   const char *filename, int linenumber)
 125 {
 126 #ifdef W32_MEM_LIMIT
 127   n += sizeof (size_t);
 128   ptr = &((size_t *) ptr)[-1];
 129   mem_used = mem_used - *((size_t *) ptr) + n;
 130 #endif
 131   ptr = realloc (ptr, n);
 132   if (!ptr)
 133     {
 134       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "realloc");
 135       abort ();
 136     }
 137 #ifdef W32_MEM_LIMIT
 138   ptr = &((size_t *) ptr)[1];
 139 #endif
 140   return ptr;
 141 }
 142
 143
 144 /**
 145  * Free memory. Merely a wrapper for the case that we
 146  * want to keep track of allocations.
 147  *
 148  * @param ptr the pointer to free
 149  * @param filename where in the code was the call to GNUNET_array_grow
 150  * @param linenumber where in the code was the call to GNUNET_array_grow
 151  */
 152 void
 153 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
 154 {
 155   GNUNET_assert_at (ptr != NULL, filename, linenumber);
 156 #ifdef W32_MEM_LIMIT
 157   ptr = &((size_t *) ptr)[-1];
 158   mem_used -= *((size_t *) ptr);
 159 #endif
 160   free (ptr);
 161 }
 162
 163 /**
 164  * Dup a string (same semantics as strdup).
 165  *
 166  * @param str the string to dup
 167  * @param filename where in the code was the call to GNUNET_strdup
 168  * @param linenumber where in the code was the call to GNUNET_strdup
 169  * @return strdup(str)
 170  */
 171 char *
 172 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber)
 173 {
 174   char *res;
 175
 176   GNUNET_assert_at (str != NULL, filename, linenumber);
 177   res = GNUNET_xmalloc_ (strlen (str) + 1, filename, linenumber);
 178   memcpy (res, str, strlen (str) + 1);
 179   return res;
 180 }
 181
 182 /**
 183  * Grow an array.  Grows old by (*oldCount-newCount)*elementSize bytes
 184  * and sets *oldCount to newCount.
 185  *
 186  * @param old address of the pointer to the array
 187  *        *old may be NULL
 188  * @param elementSize the size of the elements of the array
 189  * @param oldCount address of the number of elements in the *old array
 190  * @param newCount number of elements in the new array, may be 0
 191  * @param filename where in the code was the call to GNUNET_array_grow
 192  * @param linenumber where in the code was the call to GNUNET_array_grow
 193  */
 194 void
 195 GNUNET_xgrow_ (void **old,
 196                size_t elementSize,
 197                unsigned int *oldCount,
 198                unsigned int newCount, const char *filename, int linenumber)
 199 {
 200   void *tmp;
 201   size_t size;
 202
 203   GNUNET_assert_at (INT_MAX / elementSize > newCount, filename, linenumber);
 204   size = newCount * elementSize;
 205   if (size == 0)
 206     {
 207       tmp = NULL;
 208     }
 209   else
 210     {
 211       tmp = GNUNET_xmalloc_ (size, filename, linenumber);
 212       memset (tmp, 0, size);    /* client code should not rely on this, though... */
 213       if (*oldCount > newCount)
 214         *oldCount = newCount;   /* shrink is also allowed! */
 215       memcpy (tmp, *old, elementSize * (*oldCount));
 216     }
 217
 218   if (*old != NULL)
 219     {
 220       GNUNET_xfree_ (*old, filename, linenumber);
 221     }
 222   *old = tmp;
 223   *oldCount = newCount;
 224 }
 225
 226
 227 /**
 228  * Like asprintf, just portable.
 229  *
 230  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 231  * @param format format string (see printf, fprintf, etc.)
 232  * @param ... data for format string
 233  * @return number of bytes in "*buf" excluding 0-termination
 234  */
 235 int
 236 GNUNET_asprintf (char **buf, const char *format, ...)
 237 {
 238   int ret;
 239   va_list args;
 240
 241   va_start (args, format);
 242   ret = VSNPRINTF (NULL, 0, format, args);
 243   va_end (args);
 244   *buf = GNUNET_malloc (ret + 1);
 245   va_start (args, format);
 246   ret = VSPRINTF (*buf, format, args);
 247   va_end (args);
 248   return ret;
 249 }
 250
 251
 252 /**
 253  * Like snprintf, just aborts if the buffer is of insufficient size.
 254  *
 255  * @param buf pointer to buffer that is written to
 256  * @param size number of bytes in buf
 257  * @param format format strings
 258  * @param ... data for format string
 259  * @return number of bytes written to buf or negative value on error
 260  */
 261 int
 262 GNUNET_snprintf (char *buf, size_t size, const char *format, ...)
 263 {
 264   int ret;
 265   va_list args;
 266
 267   va_start (args, format);
 268   ret = VSNPRINTF (buf, size, format, args);
 269   va_end (args);
 270   GNUNET_assert (ret <= size);
 271   return ret;
 272 }
 273
 274 /* end of common_allocation.c */