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 #define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
  31
  32 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
  33
  34 #ifndef INT_MAX
  35 #define INT_MAX 0x7FFFFFFF
  36 #endif
  37
  38 #if 0
  39 #define W32_MEM_LIMIT 200000000
  40 #endif
  41
  42 #ifdef W32_MEM_LIMIT
  43 static LONG mem_used = 0;
  44 #endif
  45
  46 /**
  47  * Allocate memory. Checks the return value, aborts if no more
  48  * memory is available.
  49  *
  50  * @param size how many bytes of memory to allocate, do NOT use
  51  *  this function (or GNUNET_malloc) to allocate more than several MB
  52  *  of memory, if you are possibly needing a very large chunk use
  53  *  GNUNET_xmalloc_unchecked_ instead.
  54  * @param filename where in the code was the call to GNUNET_malloc
  55  * @param linenumber where in the code was the call to GNUNET_malloc
  56  * @return pointer to size bytes of memory
  57  */
  58 void *
  59 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber)
  60 {
  61   void *ret;
  62
  63   /* As a security precaution, we generally do not allow very large
  64    * allocations using the default 'GNUNET_malloc' macro */
  65   GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
  66   ret = GNUNET_xmalloc_unchecked_ (size, filename, linenumber);
  67   if (ret == NULL)
  68   {
  69     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "malloc");
  70     GNUNET_abort ();
  71   }
  72   return ret;
  73 }
  74
  75
  76 /**
  77  * Allocate and initialize memory. Checks the return value, aborts if no more
  78  * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
  79  * GNUNET_memdup macro.
  80  *
  81  * @param buf buffer to initialize from (must contain size bytes)
  82  * @param size number of bytes to allocate
  83  * @param filename where is this call being made (for debugging)
  84  * @param linenumber line where this call is being made (for debugging)
  85  * @return allocated memory, never NULL
  86  */
  87 void *
  88 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
  89                  int linenumber)
  90 {
  91   void *ret;
  92
  93   /* As a security precaution, we generally do not allow very large
  94    * allocations here */
  95   GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
  96 #ifdef W32_MEM_LIMIT
  97   size += sizeof (size_t);
  98   if (mem_used + size > W32_MEM_LIMIT)
  99     return NULL;
 100 #endif
 101   GNUNET_assert_at (size < INT_MAX, filename, linenumber);
 102   ret = malloc (size);
 103   if (ret == NULL)
 104   {
 105     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "malloc");
 106     GNUNET_abort ();
 107   }
 108 #ifdef W32_MEM_LIMIT
 109   *((size_t *) ret) = size;
 110   ret = &((size_t *) ret)[1];
 111   mem_used += size;
 112 #endif
 113   memcpy (ret, buf, size);
 114   return ret;
 115 }
 116
 117
 118
 119 /**
 120  * Wrapper around malloc. Allocates size bytes of memory.
 121  * The memory will be zero'ed out.
 122  *
 123  * @param size the number of bytes to allocate
 124  * @param filename where in the code was the call to GNUNET_malloc_large
 125  * @param linenumber where in the code was the call to GNUNET_malloc_large
 126  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 127  */
 128 void *
 129 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
 130 {
 131   void *result;
 132
 133 #ifdef W32_MEM_LIMIT
 134   size += sizeof (size_t);
 135   if (mem_used + size > W32_MEM_LIMIT)
 136     return NULL;
 137 #endif
 138
 139   result = malloc (size);
 140   if (result == NULL)
 141     return NULL;
 142   memset (result, 0, size);
 143
 144 #ifdef W32_MEM_LIMIT
 145   *((size_t *) result) = size;
 146   result = &((size_t *) result)[1];
 147   mem_used += size;
 148 #endif
 149
 150   return result;
 151 }
 152
 153
 154 /**
 155  * Reallocate memory. Checks the return value, aborts if no more
 156  * memory is available.
 157  *
 158  * @param ptr the pointer to reallocate
 159  * @param n how many bytes of memory to allocate
 160  * @param filename where in the code was the call to GNUNET_realloc
 161  * @param linenumber where in the code was the call to GNUNET_realloc
 162  * @return pointer to size bytes of memory
 163  */
 164 void *
 165 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber)
 166 {
 167 #ifdef W32_MEM_LIMIT
 168   n += sizeof (size_t);
 169   ptr = &((size_t *) ptr)[-1];
 170   mem_used = mem_used - *((size_t *) ptr) + n;
 171 #endif
 172   ptr = realloc (ptr, n);
 173   if ((NULL == ptr) && (n > 0))
 174   {
 175     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "realloc");
 176     GNUNET_abort ();
 177   }
 178 #ifdef W32_MEM_LIMIT
 179   ptr = &((size_t *) ptr)[1];
 180 #endif
 181   return ptr;
 182 }
 183
 184
 185 /**
 186  * Free memory. Merely a wrapper for the case that we
 187  * want to keep track of allocations.
 188  *
 189  * @param ptr the pointer to free
 190  * @param filename where in the code was the call to GNUNET_array_grow
 191  * @param linenumber where in the code was the call to GNUNET_array_grow
 192  */
 193 void
 194 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
 195 {
 196   GNUNET_assert_at (ptr != NULL, filename, linenumber);
 197 #ifdef W32_MEM_LIMIT
 198   ptr = &((size_t *) ptr)[-1];
 199   mem_used -= *((size_t *) ptr);
 200 #endif
 201   free (ptr);
 202 }
 203
 204 /**
 205  * Dup a string (same semantics as strdup).
 206  *
 207  * @param str the string to dup
 208  * @param filename where in the code was the call to GNUNET_strdup
 209  * @param linenumber where in the code was the call to GNUNET_strdup
 210  * @return strdup(str)
 211  */
 212 char *
 213 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber)
 214 {
 215   char *res;
 216
 217   GNUNET_assert_at (str != NULL, filename, linenumber);
 218   res = GNUNET_xmalloc_ (strlen (str) + 1, filename, linenumber);
 219   memcpy (res, str, strlen (str) + 1);
 220   return res;
 221 }
 222
 223
 224 /**
 225  * Dup partially a string (same semantics as strndup).
 226  *
 227  * @param str the string to dup
 228  * @param len the length of the string to dup
 229  * @param filename where in the code was the call to GNUNET_strndup
 230  * @param linenumber where in the code was the call to GNUNET_strndup
 231  * @return strndup(str,len)
 232  */
 233 char *
 234 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
 235                   int linenumber)
 236 {
 237   char *res;
 238
 239   GNUNET_assert_at (str != NULL, filename, linenumber);
 240   len = GNUNET_MIN (len, strlen (str));
 241   res = GNUNET_xmalloc_ (len + 1, filename, linenumber);
 242   memcpy (res, str, len);
 243   res[len] = '\0';
 244   return res;
 245 }
 246
 247
 248 /**
 249  * Grow an array.  Grows old by (*oldCount-newCount)*elementSize bytes
 250  * and sets *oldCount to newCount.
 251  *
 252  * @param old address of the pointer to the array
 253  *        *old may be NULL
 254  * @param elementSize the size of the elements of the array
 255  * @param oldCount address of the number of elements in the *old array
 256  * @param newCount number of elements in the new array, may be 0
 257  * @param filename where in the code was the call to GNUNET_array_grow
 258  * @param linenumber where in the code was the call to GNUNET_array_grow
 259  */
 260 void
 261 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
 262                unsigned int newCount, const char *filename, int linenumber)
 263 {
 264   void *tmp;
 265   size_t size;
 266
 267   GNUNET_assert_at (INT_MAX / elementSize > newCount, filename, linenumber);
 268   size = newCount * elementSize;
 269   if (size == 0)
 270   {
 271     tmp = NULL;
 272   }
 273   else
 274   {
 275     tmp = GNUNET_xmalloc_ (size, filename, linenumber);
 276     memset (tmp, 0, size);      /* client code should not rely on this, though... */
 277     if (*oldCount > newCount)
 278       *oldCount = newCount;     /* shrink is also allowed! */
 279     memcpy (tmp, *old, elementSize * (*oldCount));
 280   }
 281
 282   if (*old != NULL)
 283   {
 284     GNUNET_xfree_ (*old, filename, linenumber);
 285   }
 286   *old = tmp;
 287   *oldCount = newCount;
 288 }
 289
 290
 291 /**
 292  * Like asprintf, just portable.
 293  *
 294  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 295  * @param format format string (see printf, fprintf, etc.)
 296  * @param ... data for format string
 297  * @return number of bytes in "*buf" excluding 0-termination
 298  */
 299 int
 300 GNUNET_asprintf (char **buf, const char *format, ...)
 301 {
 302   int ret;
 303   va_list args;
 304
 305   va_start (args, format);
 306   ret = VSNPRINTF (NULL, 0, format, args);
 307   va_end (args);
 308   *buf = GNUNET_malloc (ret + 1);
 309   va_start (args, format);
 310   ret = VSPRINTF (*buf, format, args);
 311   va_end (args);
 312   return ret;
 313 }
 314
 315
 316 /**
 317  * Like snprintf, just aborts if the buffer is of insufficient size.
 318  *
 319  * @param buf pointer to buffer that is written to
 320  * @param size number of bytes in buf
 321  * @param format format strings
 322  * @param ... data for format string
 323  * @return number of bytes written to buf or negative value on error
 324  */
 325 int
 326 GNUNET_snprintf (char *buf, size_t size, const char *format, ...)
 327 {
 328   int ret;
 329   va_list args;
 330
 331   va_start (args, format);
 332   ret = VSNPRINTF (buf, size, format, args);
 333   va_end (args);
 334   GNUNET_assert (ret <= size);
 335   return ret;
 336 }
 337
 338
 339 /**
 340  * Create a copy of the given message.
 341  *
 342  * @param msg message to copy
 343  * @return duplicate of the message
 344  */
 345 struct GNUNET_MessageHeader *
 346 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg)
 347 {
 348   struct GNUNET_MessageHeader *ret;
 349   uint16_t msize;
 350
 351   msize = ntohs (msg->size);
 352   GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
 353   ret = GNUNET_malloc (msize);
 354   memcpy (ret, msg, msize);
 355   return ret;
 356 }
 357
 358
 359 /* end of common_allocation.c */