2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2005, 2006 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file util/common_allocation.c
23 * @brief wrapper around malloc/free
24 * @author Christian Grothoff
28 #include "gnunet_common.h"
31 #define INT_MAX 0x7FFFFFFF
35 #define W32_MEM_LIMIT 200000000
39 static LONG mem_used = 0;
43 * Allocate memory. Checks the return value, aborts if no more
44 * memory is available.
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
55 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber)
59 /* As a security precaution, we generally do not allow very large
60 * allocations using the default 'GNUNET_malloc' macro */
61 GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
62 ret = GNUNET_xmalloc_unchecked_ (size, filename, linenumber);
65 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
73 * Allocate and initialize memory. Checks the return value, aborts if no more
74 * memory is available. Don't use GNUNET_xmemdup_ directly. Use the
75 * GNUNET_memdup macro.
77 * @param buf buffer to initialize from (must contain size bytes)
78 * @param size number of bytes to allocate
79 * @param filename where is this call being made (for debugging)
80 * @param linenumber line where this call is being made (for debugging)
81 * @return allocated memory, never NULL
84 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
89 /* As a security precaution, we generally do not allow very large
91 GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
93 size += sizeof (size_t);
94 if (mem_used + size > W32_MEM_LIMIT)
97 GNUNET_assert_at (size < INT_MAX, filename, linenumber);
101 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
105 *((size_t *) ret) = size;
106 ret = &((size_t *) ret)[1];
109 memcpy (ret, buf, size);
116 * Wrapper around malloc. Allocates size bytes of memory.
117 * The memory will be zero'ed out.
119 * @param size the number of bytes to allocate
120 * @param filename where in the code was the call to GNUNET_malloc_large
121 * @param linenumber where in the code was the call to GNUNET_malloc_large
122 * @return pointer to size bytes of memory, NULL if we do not have enough memory
125 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
130 size += sizeof (size_t);
131 if (mem_used + size > W32_MEM_LIMIT)
135 GNUNET_assert_at (size < INT_MAX, filename, linenumber);
136 result = malloc (size);
139 memset (result, 0, size);
142 *((size_t *) result) = size;
143 result = &((size_t *) result)[1];
152 * Reallocate memory. Checks the return value, aborts if no more
153 * memory is available.
155 * @param ptr the pointer to reallocate
156 * @param n how many bytes of memory to allocate
157 * @param filename where in the code was the call to GNUNET_realloc
158 * @param linenumber where in the code was the call to GNUNET_realloc
159 * @return pointer to size bytes of memory
162 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber)
165 n += sizeof (size_t);
166 ptr = &((size_t *) ptr)[-1];
167 mem_used = mem_used - *((size_t *) ptr) + n;
169 ptr = realloc (ptr, n);
170 if ((NULL == ptr) && (n > 0))
172 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "realloc");
176 ptr = &((size_t *) ptr)[1];
183 * Free memory. Merely a wrapper for the case that we
184 * want to keep track of allocations.
186 * @param ptr the pointer to free
187 * @param filename where in the code was the call to GNUNET_array_grow
188 * @param linenumber where in the code was the call to GNUNET_array_grow
191 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
193 GNUNET_assert_at (ptr != NULL, filename, linenumber);
195 ptr = &((size_t *) ptr)[-1];
196 mem_used -= *((size_t *) ptr);
202 * Dup a string (same semantics as strdup).
204 * @param str the string to dup
205 * @param filename where in the code was the call to GNUNET_strdup
206 * @param linenumber where in the code was the call to GNUNET_strdup
207 * @return strdup(str)
210 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber)
214 GNUNET_assert_at (str != NULL, filename, linenumber);
215 res = GNUNET_xmalloc_ (strlen (str) + 1, filename, linenumber);
216 memcpy (res, str, strlen (str) + 1);
222 * Dup partially a string (same semantics as strndup).
224 * @param str the string to dup
225 * @param len the length of the string to dup
226 * @param filename where in the code was the call to GNUNET_strndup
227 * @param linenumber where in the code was the call to GNUNET_strndup
228 * @return strndup(str,len)
231 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
236 GNUNET_assert_at (str != NULL, filename, linenumber);
237 len = GNUNET_MIN (len, strlen (str));
238 res = GNUNET_xmalloc_ (len + 1, filename, linenumber);
239 memcpy (res, str, len);
246 * Grow an array. Grows old by (*oldCount-newCount)*elementSize bytes
247 * and sets *oldCount to newCount.
249 * @param old address of the pointer to the array
251 * @param elementSize the size of the elements of the array
252 * @param oldCount address of the number of elements in the *old array
253 * @param newCount number of elements in the new array, may be 0
254 * @param filename where in the code was the call to GNUNET_array_grow
255 * @param linenumber where in the code was the call to GNUNET_array_grow
258 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
259 unsigned int newCount, const char *filename, int linenumber)
264 GNUNET_assert_at (INT_MAX / elementSize > newCount, filename, linenumber);
265 size = newCount * elementSize;
272 tmp = GNUNET_xmalloc_ (size, filename, linenumber);
273 memset (tmp, 0, size); /* client code should not rely on this, though... */
274 if (*oldCount > newCount)
275 *oldCount = newCount; /* shrink is also allowed! */
276 memcpy (tmp, *old, elementSize * (*oldCount));
281 GNUNET_xfree_ (*old, filename, linenumber);
284 *oldCount = newCount;
289 * Like asprintf, just portable.
291 * @param buf set to a buffer of sufficient size (allocated, caller must free)
292 * @param format format string (see printf, fprintf, etc.)
293 * @param ... data for format string
294 * @return number of bytes in "*buf" excluding 0-termination
297 GNUNET_asprintf (char **buf, const char *format, ...)
302 va_start (args, format);
303 ret = VSNPRINTF (NULL, 0, format, args);
305 *buf = GNUNET_malloc (ret + 1);
306 va_start (args, format);
307 ret = VSPRINTF (*buf, format, args);
314 * Like snprintf, just aborts if the buffer is of insufficient size.
316 * @param buf pointer to buffer that is written to
317 * @param size number of bytes in buf
318 * @param format format strings
319 * @param ... data for format string
320 * @return number of bytes written to buf or negative value on error
323 GNUNET_snprintf (char *buf, size_t size, const char *format, ...)
328 va_start (args, format);
329 ret = VSNPRINTF (buf, size, format, args);
331 GNUNET_assert (ret <= size);
335 /* end of common_allocation.c */