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)
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);
64 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
72 * Wrapper around malloc. Allocates size bytes of memory.
73 * The memory will be zero'ed out.
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
81 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
86 size += sizeof (size_t);
87 if (mem_used + size > W32_MEM_LIMIT)
91 GNUNET_assert_at (size < INT_MAX, filename, linenumber);
92 result = malloc (size);
95 memset (result, 0, size);
98 *((size_t *) result) = size;
99 result = &((size_t *) result)[1];
107 * Reallocate memory. Checks the return value, aborts if no more
108 * memory is available.
110 * @param ptr the pointer to reallocate
111 * @param n how many bytes of memory to allocate
112 * @param filename where in the code was the call to GNUNET_realloc
113 * @param linenumber where in the code was the call to GNUNET_realloc
114 * @return pointer to size bytes of memory
117 GNUNET_xrealloc_ (void *ptr,
118 #ifndef W32_MEM_LIMIT
123 const char *filename, int linenumber)
126 n += sizeof (size_t);
127 ptr = &((size_t *) ptr)[-1];
128 mem_used = mem_used - *((size_t *) ptr) + n;
130 ptr = realloc (ptr, n);
133 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "realloc");
137 ptr = &((size_t *) ptr)[1];
143 * Free memory. Merely a wrapper for the case that we
144 * want to keep track of allocations.
146 * @param ptr the pointer to free
147 * @param filename where in the code was the call to GNUNET_array_grow
148 * @param linenumber where in the code was the call to GNUNET_array_grow
151 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
153 GNUNET_assert_at (ptr != NULL, filename, linenumber);
155 ptr = &((size_t *) ptr)[-1];
156 mem_used -= *((size_t *) ptr);
162 * Dup a string (same semantics as strdup).
164 * @param str the string to dup
165 * @param filename where in the code was the call to GNUNET_strdup
166 * @param linenumber where in the code was the call to GNUNET_strdup
167 * @return strdup(str)
170 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber)
174 GNUNET_assert_at (str != NULL, filename, linenumber);
175 res = GNUNET_xmalloc_ (strlen (str) + 1, filename, linenumber);
176 memcpy (res, str, strlen (str) + 1);
181 * Grow an array. Grows old by (*oldCount-newCount)*elementSize bytes
182 * and sets *oldCount to newCount.
184 * @param old address of the pointer to the array
186 * @param elementSize the size of the elements of the array
187 * @param oldCount address of the number of elements in the *old array
188 * @param newCount number of elements in the new array, may be 0
189 * @param filename where in the code was the call to GNUNET_array_grow
190 * @param linenumber where in the code was the call to GNUNET_array_grow
193 GNUNET_xgrow_ (void **old,
195 unsigned int *oldCount,
196 unsigned int newCount, const char *filename, int linenumber)
201 GNUNET_assert_at (INT_MAX / elementSize > newCount, filename, linenumber);
202 size = newCount * elementSize;
209 tmp = GNUNET_xmalloc_ (size, filename, linenumber);
210 memset (tmp, 0, size); /* client code should not rely on this, though... */
211 if (*oldCount > newCount)
212 *oldCount = newCount; /* shrink is also allowed! */
213 memcpy (tmp, *old, elementSize * (*oldCount));
218 GNUNET_xfree_ (*old, filename, linenumber);
221 *oldCount = newCount;
226 * Like asprintf, just portable.
228 * @param buf set to a buffer of sufficient size (allocated, caller must free)
229 * @param format format string (see printf, fprintf, etc.)
230 * @param ... data for format string
231 * @return number of bytes in "*buf" excluding 0-termination
234 GNUNET_asprintf (char **buf, const char *format, ...)
239 va_start (args, format);
240 ret = VSNPRINTF (NULL, 0, format, args);
242 *buf = GNUNET_malloc (ret + 1);
243 va_start (args, format);
244 ret = VSPRINTF (*buf, format, args);
251 * Like snprintf, just aborts if the buffer is of insufficient size.
253 * @param buf pointer to buffer that is written to
254 * @param size number of bytes in buf
255 * @param format format strings
256 * @param ... data for format string
257 * @return number of bytes written to buf or negative value on error
260 GNUNET_snprintf (char *buf, size_t size, const char *format, ...)
265 va_start (args, format);
266 ret = VSNPRINTF (buf, size, format, args);
268 GNUNET_assert (ret <= size);
272 /* end of common_allocation.c */