auto-provide OS_IPK paths in [paths] of config
[oweals/gnunet.git] / src / util / common_allocation.c
index 89be027e706b5caa9ae22810d543a52666d8214b..35c557000bf89c193dbdcf907cf87a69ad9fb701 100644 (file)
@@ -1,22 +1,22 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2005, 2006 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001, 2002, 2003, 2005, 2006 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
-*/
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
+ */
 
 /**
  * @file util/common_allocation.c
@@ -24,7 +24,7 @@
  * @author Christian Grothoff
  */
 #include "platform.h"
-#include "gnunet_common.h"
+#include "gnunet_crypto_lib.h"
 #if HAVE_MALLOC_H
 #include <malloc.h>
 #endif
 #include <malloc/malloc.h>
 #endif
 
-#define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
+#define LOG(kind, ...) \
+  GNUNET_log_from (kind, "util-common-allocation", __VA_ARGS__)
 
-#define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
+#define LOG_STRERROR(kind, syscall) \
+  GNUNET_log_from_strerror (kind, "util-common-allocation", syscall)
 
 #ifndef INT_MAX
 #define INT_MAX 0x7FFFFFFF
@@ -53,11 +55,11 @@ static LONG mem_used = 0;
  * memory is available.
  *
  * @param size how many bytes of memory to allocate, do NOT use
- *  this function (or GNUNET_malloc) to allocate more than several MB
+ *  this function (or GNUNET_malloc()) to allocate more than several MB
  *  of memory, if you are possibly needing a very large chunk use
- *  GNUNET_xmalloc_unchecked_ instead.
- * @param filename where in the code was the call to GNUNET_malloc
- * @param linenumber where in the code was the call to GNUNET_malloc
+ *  #GNUNET_xmalloc_unchecked_() instead.
+ * @param filename where in the code was the call to GNUNET_malloc()
+ * @param linenumber where in the code was the call to GNUNET_malloc()
  * @return pointer to size bytes of memory
  */
 void *
@@ -66,22 +68,104 @@ GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber)
   void *ret;
 
   /* As a security precaution, we generally do not allow very large
-   * allocations using the default 'GNUNET_malloc' macro */
+   * allocations using the default 'GNUNET_malloc()' macro */
   GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
   ret = GNUNET_xmalloc_unchecked_ (size, filename, linenumber);
-  if (ret == NULL)
+  if (NULL == ret)
   {
     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "malloc");
-    GNUNET_abort ();
+    GNUNET_assert (0);
   }
   return ret;
 }
 
 
+/**
+ * Allocate memory for a two dimensional array in one block
+ * and set up pointers. Aborts if no more memory is available.
+ * Don't use GNUNET_xnew_array_2d_ directly. Use the
+ * #GNUNET_new_array_2d macro.
+ * The memory of the elements will be zero'ed out.
+ *
+ * @param n size of the first dimension
+ * @param m size of the second dimension
+ * @param elementSize size of a single element in bytes
+ * @param filename where is this call being made (for debugging)
+ * @param linenumber line where this call is being made (for debugging)
+ * @return allocated memory, never NULL
+ */
+void **
+GNUNET_xnew_array_2d_ (size_t n,
+                       size_t m,
+                       size_t elementSize,
+                       const char *filename,
+                       int linenumber)
+{
+  /* use char pointer internally to avoid void pointer arithmetic warnings */
+  char **ret = GNUNET_xmalloc_ (n * sizeof(void *)     /* 1. dim header */
+                                + n * m * elementSize, /* element data */
+                                filename,
+                                linenumber);
+
+  for (size_t i = 0; i < n; i++)
+    ret[i] = (char *) ret    /* base address */
+             + n * sizeof(void *)  /* skip 1. dim header */
+             + i * m * elementSize; /* skip to 2. dim row header */
+  return (void **) ret;
+}
+
+
+/**
+ * Allocate memory for a three dimensional array in one block
+ * and set up pointers. Aborts if no more memory is available.
+ * Don't use GNUNET_xnew_array_3d_ directly. Use the
+ * #GNUNET_new_array_3d macro.
+ * The memory of the elements will be zero'ed out.
+ *
+ * @param n size of the first dimension
+ * @param m size of the second dimension
+ * @param o size of the third dimension
+ * @param elementSize size of a single element in bytes
+ * @param filename where is this call being made (for debugging)
+ * @param linenumber line where this call is being made (for debugging)
+ * @return allocated memory, never NULL
+ */
+void ***
+GNUNET_xnew_array_3d_ (size_t n,
+                       size_t m,
+                       size_t o,
+                       size_t elementSize,
+                       const char *filename,
+                       int linenumber)
+{
+  /* use char pointer internally to avoid void pointer arithmetic warnings */
+  char ***ret = GNUNET_xmalloc_ (n * sizeof(void **)     /* 1. dim header */
+                                 + n * m * sizeof(void *)    /* 2. dim header */
+                                 + n * m * o * elementSize, /* element data */
+                                 filename,
+                                 linenumber);
+
+  for (size_t i = 0; i < n; i++)
+  {
+    /* need to cast to (char *) temporarily for byte level acuracy */
+    ret[i] = (char **) ((char *) ret   /* base address */
+                        + n * sizeof(void **)  /* skip 1. dim header */
+                        + i * m * sizeof(void *)); /* skip to 2. dim header */
+    for (size_t j = 0; j < m; j++)
+      ret[i][j] = (char *) ret    /* base address */
+                  + n * sizeof(void **)   /* skip 1. dim header */
+                  + n * m * sizeof(void *)   /* skip 2. dim header */
+                  + i * m * o * elementSize   /* skip to 2. dim part */
+                  + j * o * elementSize; /* skip to 3. dim row data */
+  }
+  return (void ***) ret;
+}
+
+
 /**
  * Allocate and initialize memory. Checks the return value, aborts if no more
- * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
- * GNUNET_memdup macro.
+ * memory is available.  Don't use #GNUNET_xmemdup_() directly. Use the
+ * GNUNET_memdup() macro.
  *
  * @param buf buffer to initialize from (must contain size bytes)
  * @param size number of bytes to allocate
@@ -90,7 +174,9 @@ GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber)
  * @return allocated memory, never NULL
  */
 void *
-GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
+GNUNET_xmemdup_ (const void *buf,
+                 size_t size,
+                 const char *filename,
                  int linenumber)
 {
   void *ret;
@@ -99,7 +185,7 @@ GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
    * allocations here */
   GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
 #ifdef W32_MEM_LIMIT
-  size += sizeof (size_t);
+  size += sizeof(size_t);
   if (mem_used + size > W32_MEM_LIMIT)
     return NULL;
 #endif
@@ -108,26 +194,25 @@ GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
   if (ret == NULL)
   {
     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "malloc");
-    GNUNET_abort ();
+    GNUNET_assert (0);
   }
 #ifdef W32_MEM_LIMIT
   *((size_t *) ret) = size;
   ret = &((size_t *) ret)[1];
   mem_used += size;
 #endif
-  memcpy (ret, buf, size);
+  GNUNET_memcpy (ret, buf, size);
   return ret;
 }
 
 
-
 /**
- * Wrapper around malloc. Allocates size bytes of memory.
+ * Wrapper around malloc(). Allocates size bytes of memory.
  * The memory will be zero'ed out.
  *
  * @param size the number of bytes to allocate
- * @param filename where in the code was the call to GNUNET_malloc_large
- * @param linenumber where in the code was the call to GNUNET_malloc_large
+ * @param filename where in the code was the call to GNUNET_malloc_unchecked()
+ * @param linenumber where in the code was the call to GNUNET_malloc_unchecked()
  * @return pointer to size bytes of memory, NULL if we do not have enough memory
  */
 void *
@@ -135,14 +220,16 @@ GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
 {
   void *result;
 
+  (void) filename;
+  (void) linenumber;
 #ifdef W32_MEM_LIMIT
-  size += sizeof (size_t);
+  size += sizeof(size_t);
   if (mem_used + size > W32_MEM_LIMIT)
     return NULL;
 #endif
 
   result = malloc (size);
-  if (result == NULL)
+  if (NULL == result)
     return NULL;
   memset (result, 0, size);
 
@@ -159,26 +246,54 @@ GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
 /**
  * Reallocate memory. Checks the return value, aborts if no more
  * memory is available.
+ * The content of the intersection of the new and old size will be unchanged.
  *
  * @param ptr the pointer to reallocate
  * @param n how many bytes of memory to allocate
- * @param filename where in the code was the call to GNUNET_realloc
- * @param linenumber where in the code was the call to GNUNET_realloc
+ * @param filename where in the code was the call to GNUNET_realloc()
+ * @param linenumber where in the code was the call to GNUNET_realloc()
  * @return pointer to size bytes of memory
  */
 void *
 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber)
 {
+  (void) filename;
+  (void) linenumber;
+
 #ifdef W32_MEM_LIMIT
-  n += sizeof (size_t);
+  n += sizeof(size_t);
   ptr = &((size_t *) ptr)[-1];
   mem_used = mem_used - *((size_t *) ptr) + n;
+#endif
+#if defined(M_SIZE)
+#if ENABLE_POISONING
+  {
+    uint64_t *base = ptr;
+    size_t s = M_SIZE (ptr);
+
+    if (s > n)
+    {
+      const uint64_t baadfood = GNUNET_ntohll (0xBAADF00DBAADF00DLL);
+      char *cbase = ptr;
+
+      GNUNET_memcpy (&cbase[n],
+                     &baadfood,
+                     GNUNET_MIN (8 - (n % 8),
+                                 s - n));
+      for (size_t i = 1 + (n + 7) / 8; i < s / 8; i++)
+        base[i] = baadfood;
+      GNUNET_memcpy (&base[s / 8],
+                     &baadfood,
+                     s % 8);
+    }
+  }
+#endif
 #endif
   ptr = realloc (ptr, n);
   if ((NULL == ptr) && (n > 0))
   {
     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "realloc");
-    GNUNET_abort ();
+    GNUNET_assert (0);
   }
 #ifdef W32_MEM_LIMIT
   ptr = &((size_t *) ptr)[1];
@@ -187,15 +302,15 @@ GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber)
 }
 
 
-# if __BYTE_ORDER == __LITTLE_ENDIAN
+#if __BYTE_ORDER == __LITTLE_ENDIAN
 #define BAADFOOD_STR "\x0D\xF0\xAD\xBA"
 #endif
-# if __BYTE_ORDER == __BIG_ENDIAN
+#if __BYTE_ORDER == __BIG_ENDIAN
 #define BAADFOOD_STR "\xBA\xAD\xF0\x0D"
 #endif
 
-#if WINDOWS
-#define M_SIZE(p) _msize (p)
+#if HAVE_MALLOC_NP_H
+#include <malloc_np.h>
 #endif
 #if HAVE_MALLOC_USABLE_SIZE
 #define M_SIZE(p) malloc_usable_size (p)
@@ -208,13 +323,13 @@ GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber)
  * want to keep track of allocations.
  *
  * @param ptr the pointer to free
- * @param filename where in the code was the call to GNUNET_array_grow
- * @param linenumber where in the code was the call to GNUNET_array_grow
+ * @param filename where in the code was the call to GNUNET_free
+ * @param linenumber where in the code was the call to GNUNET_free
  */
 void
 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
 {
-  GNUNET_assert_at (ptr != NULL, filename, linenumber);
+  GNUNET_assert_at (NULL != ptr, filename, linenumber);
 #ifdef W32_MEM_LIMIT
   ptr = &((size_t *) ptr)[-1];
   mem_used -= *((size_t *) ptr);
@@ -224,42 +339,43 @@ GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
   {
     const uint64_t baadfood = GNUNET_ntohll (0xBAADF00DBAADF00DLL);
     uint64_t *base = ptr;
-    size_t s = M_SIZE (ptr);  
-    size_t i;
-    
-    for (i=0;i<s/8;i++)
+    size_t s = M_SIZE (ptr);
+
+    for (size_t i = 0; i < s / 8; i++)
       base[i] = baadfood;
-    memcpy (&base[s/8], &baadfood, s % 8);
+    GNUNET_memcpy (&base[s / 8], &baadfood, s % 8);
   }
 #endif
 #endif
   free (ptr);
 }
 
+
 /**
  * Dup a string (same semantics as strdup).
  *
  * @param str the string to dup
- * @param filename where in the code was the call to GNUNET_strdup
- * @param linenumber where in the code was the call to GNUNET_strdup
- * @return strdup(str)
+ * @param filename where in the code was the call to GNUNET_strdup()
+ * @param linenumber where in the code was the call to GNUNET_strdup()
+ * @return `strdup(@a str)`
  */
 char *
 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber)
 {
   char *res;
+  size_t slen;
 
   GNUNET_assert_at (str != NULL, filename, linenumber);
-  res = GNUNET_xmalloc_ (strlen (str) + 1, filename, linenumber);
-  memcpy (res, str, strlen (str) + 1);
+  slen = strlen (str) + 1;
+  res = GNUNET_xmalloc_ (slen, filename, linenumber);
+  GNUNET_memcpy (res, str, slen);
   return res;
 }
 
 
 #if ! HAVE_STRNLEN
 static size_t
-strnlen (const char *s, 
-        size_t n)
+strnlen (const char *s, size_t n)
 {
   const char *e;
 
@@ -268,6 +384,8 @@ strnlen (const char *s,
     return n;
   return e - s;
 }
+
+
 #endif
 
 
@@ -276,20 +394,24 @@ strnlen (const char *s,
  *
  * @param str the string to dup
  * @param len the length of the string to dup
- * @param filename where in the code was the call to GNUNET_strndup
- * @param linenumber where in the code was the call to GNUNET_strndup
- * @return strndup(str,len)
+ * @param filename where in the code was the call to GNUNET_strndup()
+ * @param linenumber where in the code was the call to GNUNET_strndup()
+ * @return `strndup(@a str,@a len)`
  */
 char *
-GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
+GNUNET_xstrndup_ (const char *str,
+                  size_t len,
+                  const char *filename,
                   int linenumber)
 {
   char *res;
 
-  GNUNET_assert_at (str != NULL, filename, linenumber);
+  if (0 == len)
+    return GNUNET_strdup ("");
+  GNUNET_assert_at (NULL != str, filename, linenumber);
   len = strnlen (str, len);
   res = GNUNET_xmalloc_ (len + 1, filename, linenumber);
-  memcpy (res, str, len);
+  GNUNET_memcpy (res, str, len);
   /* res[len] = '\0'; 'malloc' zeros out anyway */
   return res;
 }
@@ -304,32 +426,36 @@ GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
  * @param elementSize the size of the elements of the array
  * @param oldCount address of the number of elements in the *old array
  * @param newCount number of elements in the new array, may be 0
- * @param filename where in the code was the call to GNUNET_array_grow
- * @param linenumber where in the code was the call to GNUNET_array_grow
+ * @param filename where in the code was the call to GNUNET_array_grow()
+ * @param linenumber where in the code was the call to GNUNET_array_grow()
  */
 void
-GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
-               unsigned int newCount, const char *filename, int linenumber)
+GNUNET_xgrow_ (void **old,
+               size_t elementSize,
+               unsigned int *oldCount,
+               unsigned int newCount,
+               const char *filename,
+               int linenumber)
 {
   void *tmp;
   size_t size;
 
   GNUNET_assert_at (INT_MAX / elementSize > newCount, filename, linenumber);
   size = newCount * elementSize;
-  if (size == 0)
+  if (0 == size)
   {
     tmp = NULL;
   }
   else
   {
     tmp = GNUNET_xmalloc_ (size, filename, linenumber);
-    memset (tmp, 0, size);      /* client code should not rely on this, though... */
-    if (*oldCount > newCount)
-      *oldCount = newCount;     /* shrink is also allowed! */
-    memcpy (tmp, *old, elementSize * (*oldCount));
+    if (NULL != *old)
+    {
+      GNUNET_memcpy (tmp, *old, elementSize * GNUNET_MIN (*oldCount, newCount));
+    }
   }
 
-  if (*old != NULL)
+  if (NULL != *old)
   {
     GNUNET_xfree_ (*old, filename, linenumber);
   }
@@ -339,12 +465,12 @@ GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
 
 
 /**
- * Like asprintf, just portable.
+ * Like asprintf(), just portable.
  *
  * @param buf set to a buffer of sufficient size (allocated, caller must free)
- * @param format format string (see printf, fprintf, etc.)
+ * @param format format string (see printf(), fprintf(), etc.)
  * @param ... data for format string
- * @return number of bytes in "*buf" excluding 0-termination
+ * @return number of bytes in `*@a buf`, excluding 0-termination
  */
 int
 GNUNET_asprintf (char **buf, const char *format, ...)
@@ -353,18 +479,19 @@ GNUNET_asprintf (char **buf, const char *format, ...)
   va_list args;
 
   va_start (args, format);
-  ret = VSNPRINTF (NULL, 0, format, args);
+  ret = vsnprintf (NULL, 0, format, args);
   va_end (args);
+  GNUNET_assert (ret >= 0);
   *buf = GNUNET_malloc (ret + 1);
   va_start (args, format);
-  ret = VSPRINTF (*buf, format, args);
+  ret = vsprintf (*buf, format, args);
   va_end (args);
   return ret;
 }
 
 
 /**
- * Like snprintf, just aborts if the buffer is of insufficient size.
+ * Like snprintf(), just aborts if the buffer is of insufficient size.
  *
  * @param buf pointer to buffer that is written to
  * @param size number of bytes in buf
@@ -379,9 +506,9 @@ GNUNET_snprintf (char *buf, size_t size, const char *format, ...)
   va_list args;
 
   va_start (args, format);
-  ret = VSNPRINTF (buf, size, format, args);
+  ret = vsnprintf (buf, size, format, args);
   va_end (args);
-  GNUNET_assert (ret <= size);
+  GNUNET_assert ((ret >= 0) && (((size_t) ret) < size));
   return ret;
 }
 
@@ -399,9 +526,9 @@ GNUNET_copy_message (const struct GNUNET_MessageHeader *msg)
   uint16_t msize;
 
   msize = ntohs (msg->size);
-  GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
+  GNUNET_assert (msize >= sizeof(struct GNUNET_MessageHeader));
   ret = GNUNET_malloc (msize);
-  memcpy (ret, msg, msize);
+  GNUNET_memcpy (ret, msg, msize);
   return ret;
 }