2 This file is part of GNUnet.
3 (C) 2006-2013 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 3, 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 include/gnunet_common.h
23 * @brief commonly used definitions; globals in this file
24 * are exempt from the rule that the module name ("common")
25 * must be part of the symbol name.
27 * @author Christian Grothoff
30 * @defgroup logging Logging
31 * @defgroup memory Memory management
33 #ifndef GNUNET_COMMON_H
34 #define GNUNET_COMMON_H
37 #include <sys/socket.h>
40 #include <netinet/in.h>
55 #if 0 /* keep Emacsens' auto-indent happy */
61 * Version of the API (for entire gnunetutil.so library).
63 #define GNUNET_UTIL_VERSION 0x00090501
66 * Named constants for return values. The following
67 * invariants hold: "GNUNET_NO == 0" (to allow "if (GNUNET_NO)")
68 * "GNUNET_OK != GNUNET_SYSERR", "GNUNET_OK != GNUNET_NO", "GNUNET_NO != GNUNET_SYSERR"
69 * and finally "GNUNET_YES != GNUNET_NO".
72 #define GNUNET_SYSERR -1
76 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
78 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
80 /* some systems use one underscore only, and mingw uses no underscore... */
83 #define __BYTE_ORDER _BYTE_ORDER
86 #define __BYTE_ORDER BYTE_ORDER
92 #define __BIG_ENDIAN _BIG_ENDIAN
95 #define __BIG_ENDIAN BIG_ENDIAN
99 #ifndef __LITTLE_ENDIAN
100 #ifdef _LITTLE_ENDIAN
101 #define __LITTLE_ENDIAN _LITTLE_ENDIAN
104 #define __LITTLE_ENDIAN LITTLE_ENDIAN
111 * define GNUNET_EXTRA_LOGGING if using this header outside the GNUnet source
112 * tree where gnunet_config.h is unavailable
114 #ifndef GNUNET_EXTRA_LOGGING
115 #define GNUNET_EXTRA_LOGGING 0
122 # if __BYTE_ORDER == __LITTLE_ENDIAN
123 # define GNUNET_htobe16(x) __bswap_16 (x)
124 # define GNUNET_htole16(x) (x)
125 # define GNUNET_be16toh(x) __bswap_16 (x)
126 # define GNUNET_le16toh(x) (x)
128 # define GNUNET_htobe32(x) __bswap_32 (x)
129 # define GNUNET_htole32(x) (x)
130 # define GNUNET_be32toh(x) __bswap_32 (x)
131 # define GNUNET_le32toh(x) (x)
133 # define GNUNET_htobe64(x) __bswap_64 (x)
134 # define GNUNET_htole64(x) (x)
135 # define GNUNET_be64toh(x) __bswap_64 (x)
136 # define GNUNET_le64toh(x) (x)
138 # if __BYTE_ORDER == __BIG_ENDIAN
139 # define GNUNET_htobe16(x) (x)
140 # define GNUNET_htole16(x) __bswap_16 (x)
141 # define GNUNET_be16toh(x) (x)
142 # define GNUNET_le16toh(x) __bswap_16 (x)
144 # define GNUNET_htobe32(x) (x)
145 # define GNUNET_htole32(x) __bswap_32 (x)
146 # define GNUNET_be32toh(x) (x)
147 # define GNUNET_le32toh(x) __bswap_32 (x)
149 # define GNUNET_htobe64(x) (x)
150 # define GNUNET_htole64(x) __bswap_64 (x)
151 # define GNUNET_be64toh(x) (x)
152 # define GNUNET_le64toh(x) __bswap_64 (x)
159 * gcc-ism to get packed structs.
161 #define GNUNET_PACKED __attribute__((packed))
164 * gcc-ism to get gcc bitfield layout when compiling with -mms-bitfields
167 #define GNUNET_GCC_STRUCT_LAYOUT __attribute__((gcc_struct))
169 #define GNUNET_GCC_STRUCT_LAYOUT
173 * gcc-ism to force alignment; we use this to align char-arrays
174 * that may then be cast to 'struct's. See also gcc
177 #ifdef __BIGGEST_ALIGNMENT__
178 #define GNUNET_ALIGN __attribute__((aligned (__BIGGEST_ALIGNMENT__)))
180 #define GNUNET_ALIGN __attribute__((aligned (8)))
184 * gcc-ism to document unused arguments
186 #define GNUNET_UNUSED __attribute__((unused))
189 * gcc-ism to document functions that don't return
191 #define GNUNET_NORETURN __attribute__((noreturn))
196 * gcc 4.x-ism to pack structures even on W32 (to be used before structs);
197 * Using this would cause structs to be unaligned on the stack on Sparc,
198 * so we *only* use this on W32 (see #670578 from Debian); fortunately,
199 * W32 doesn't run on sparc anyway.
201 #define GNUNET_NETWORK_STRUCT_BEGIN \
202 _Pragma("pack(push)") \
206 * gcc 4.x-ism to pack structures even on W32 (to be used after structs)
207 * Using this would cause structs to be unaligned on the stack on Sparc,
208 * so we *only* use this on W32 (see #670578 from Debian); fortunately,
209 * W32 doesn't run on sparc anyway.
211 #define GNUNET_NETWORK_STRUCT_END _Pragma("pack(pop)")
214 #error gcc 4.x or higher required on W32 systems
218 * Define as empty, GNUNET_PACKED should suffice, but this won't work on W32
220 #define GNUNET_NETWORK_STRUCT_BEGIN
223 * Define as empty, GNUNET_PACKED should suffice, but this won't work on W32;
225 #define GNUNET_NETWORK_STRUCT_END
228 /* ************************ super-general types *********************** */
230 GNUNET_NETWORK_STRUCT_BEGIN
233 * Header for all communications.
235 struct GNUNET_MessageHeader
239 * The length of the struct (in bytes, including the length field itself),
240 * in big-endian format.
242 uint16_t size GNUNET_PACKED;
245 * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
247 uint16_t type GNUNET_PACKED;
253 * @brief A SHA-512 hashcode
255 struct GNUNET_HashCode
257 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
262 * The identity of the host (basically the SHA-512 hashcode of
265 struct GNUNET_PeerIdentity
267 struct GNUNET_HashCode hashPubKey;
269 GNUNET_NETWORK_STRUCT_END
272 * Function called with a filename.
275 * @param filename complete filename (absolute path)
276 * @return GNUNET_OK to continue to iterate,
277 * GNUNET_NO to stop iteration with no error,
278 * GNUNET_SYSERR to abort iteration with error!
280 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
283 /* ****************************** logging ***************************** */
289 enum GNUNET_ErrorType
291 GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
292 GNUNET_ERROR_TYPE_NONE = 0,
293 GNUNET_ERROR_TYPE_ERROR = 1,
294 GNUNET_ERROR_TYPE_WARNING = 2,
295 GNUNET_ERROR_TYPE_INFO = 4,
296 GNUNET_ERROR_TYPE_DEBUG = 8,
297 GNUNET_ERROR_TYPE_INVALID = 16,
298 GNUNET_ERROR_TYPE_BULK = 32
304 * User-defined handler for log messages.
307 * @param kind severeity
308 * @param component what component is issuing the message?
309 * @param date when was the message logged?
310 * @param message what is the message
312 typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind,
313 const char *component, const char *date,
314 const char *message);
319 * Get the number of log calls that are going to be skipped
321 * @return number of log calls to be ignored
324 GNUNET_get_log_skip ();
326 #if !defined(GNUNET_CULL_LOGGING)
328 GNUNET_get_log_call_status (int caller_level, const char *comp,
329 const char *file, const char *function, int line);
337 * @param kind how serious is the error?
338 * @param message what is the message (format string)
339 * @param ... arguments for format string
342 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
345 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
346 #define _GNUNET_BOOLEAN_EXPR(expr) \
348 int _gnunet_boolean_var_; \
350 _gnunet_boolean_var_ = 1; \
352 _gnunet_boolean_var_ = 0; \
353 _gnunet_boolean_var_; \
355 #define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1))
356 #define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0))
358 #define GN_LIKELY(expr) (expr)
359 #define GN_UNLIKELY(expr) (expr)
362 #if !defined(GNUNET_LOG_CALL_STATUS)
363 #define GNUNET_LOG_CALL_STATUS -1
369 * Log function that specifies an alternative component.
370 * This function should be used by plugins.
372 * @param kind how serious is the error?
373 * @param comp component responsible for generating the message
374 * @param message what is the message (format string)
375 * @param ... arguments for format string
378 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
379 const char *message, ...);
381 #if !defined(GNUNET_CULL_LOGGING)
382 #define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\
383 static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
384 if ((GNUNET_EXTRA_LOGGING > 0) || ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0)) { \
385 if (GN_UNLIKELY(log_call_enabled == -1))\
386 log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), (comp), __FILE__, __FUNCTION__, log_line); \
387 if (GN_UNLIKELY(GNUNET_get_log_skip () > 0)) { GNUNET_log_skip (-1, GNUNET_NO); }\
389 if (GN_UNLIKELY(log_call_enabled))\
390 GNUNET_log_from_nocheck ((kind), comp, __VA_ARGS__); \
395 #define GNUNET_log(kind,...) do { int log_line = __LINE__;\
396 static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
397 if ((GNUNET_EXTRA_LOGGING > 0) || ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0)) { \
398 if (GN_UNLIKELY(log_call_enabled == -1))\
399 log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\
400 if (GN_UNLIKELY(GNUNET_get_log_skip () > 0)) { GNUNET_log_skip (-1, GNUNET_NO); }\
402 if (GN_UNLIKELY(log_call_enabled))\
403 GNUNET_log_nocheck ((kind), __VA_ARGS__); \
408 #define GNUNET_log(...)
409 #define GNUNET_log_from(...)
415 * Log error message about missing configuration option.
417 * @param kind log level
418 * @param section section with missing option
419 * @param option name of missing option
422 GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
429 * Log error message about invalid configuration option value.
431 * @param kind log level
432 * @param section section with invalid option
433 * @param option name of invalid option
434 * @param required what is required that is invalid about the option
437 GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
440 const char *required);
445 * Abort the process, generate a core dump if possible.
448 GNUNET_abort (void) GNUNET_NORETURN;
453 * Ignore the next @a n calls to the log function.
455 * @param n number of log calls to ignore (could be negative)
456 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
459 GNUNET_log_skip (int n, int check_reset);
466 * @param comp default component to use
467 * @param loglevel what types of messages should be logged
468 * @param logfile change logging to logfile (use NULL to keep stderr)
469 * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
472 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
477 * Add a custom logger.
479 * @param logger log function
480 * @param logger_cls closure for logger
483 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
488 * Remove a custom logger.
490 * @param logger log function
491 * @param logger_cls closure for logger
494 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
499 * Convert a hash value to a string (for printing debug messages).
500 * This is one of the very few calls in the entire API that is
503 * @param hc the hash code
507 GNUNET_h2s (const struct GNUNET_HashCode * hc);
512 * Convert a hash value to a string (for printing debug messages).
513 * This prints all 104 characters of a hashcode!
514 * This is one of the very few calls in the entire API that is
517 * @param hc the hash code
521 GNUNET_h2s_full (const struct GNUNET_HashCode * hc);
526 * Convert a peer identity to a string (for printing debug messages).
527 * This is one of the very few calls in the entire API that is
530 * @param pid the peer identity
531 * @return string form of the pid; will be overwritten by next
532 * call to GNUNET_i2s.
535 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
540 * Convert a peer identity to a string (for printing debug messages).
541 * This is one of the very few calls in the entire API that is
544 * @param pid the peer identity
545 * @return string form of the pid; will be overwritten by next
546 * call to GNUNET_i2s.
549 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
554 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
555 * (for printing debug messages). This is one of the very few calls
556 * in the entire API that is NOT reentrant!
558 * @param addr the address
559 * @param addrlen the length of the address
560 * @return nicely formatted string for the address
561 * will be overwritten by next call to GNUNET_a2s.
564 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
569 * Convert error type to string.
571 * @param kind type to convert
572 * @return string corresponding to the type
575 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
580 * Use this for fatal errors that cannot be handled
582 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); GNUNET_abort(); } } while(0)
587 * Use this for fatal errors that cannot be handled
589 #define GNUNET_assert_at(cond, f, l) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), f, l); GNUNET_abort(); } } while(0)
594 * Use this for internal assertion violations that are
595 * not fatal (can be handled) but should not occur.
597 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
602 * Use this for assertion violations caused by other
603 * peers (i.e. protocol violations). We do not want to
604 * confuse end-users (say, some other peer runs an
605 * older, broken or incompatible GNUnet version), but
606 * we still want to see these problems during
607 * development and testing. "OP == other peer".
609 #define GNUNET_break_op(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK, _("External protocol violation detected at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
614 * Log an error message at log-level 'level' that indicates
615 * a failure of the command 'cmd' with the message given
616 * by strerror(errno).
618 #define GNUNET_log_strerror(level, cmd) do { GNUNET_log(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
623 * Log an error message at log-level 'level' that indicates
624 * a failure of the command 'cmd' with the message given
625 * by strerror(errno).
627 #define GNUNET_log_from_strerror(level, component, cmd) do { GNUNET_log_from (level, component, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
632 * Log an error message at log-level 'level' that indicates
633 * a failure of the command 'cmd' with the message given
634 * by strerror(errno).
636 #define GNUNET_log_strerror_file(level, cmd, filename) do { GNUNET_log(level, _("`%s' failed on file `%s' at %s:%d with error: %s\n"), cmd, filename,__FILE__, __LINE__, STRERROR(errno)); } while(0)
641 * Log an error message at log-level 'level' that indicates
642 * a failure of the command 'cmd' with the message given
643 * by strerror(errno).
645 #define GNUNET_log_from_strerror_file(level, component, cmd, filename) do { GNUNET_log_from (level, component, _("`%s' failed on file `%s' at %s:%d with error: %s\n"), cmd, filename,__FILE__, __LINE__, STRERROR(errno)); } while(0)
647 /* ************************* endianess conversion ****************** */
650 * Convert unsigned 64-bit integer to host-byte-order.
651 * @param n the value in network byte order
652 * @return the same value in host byte order
655 GNUNET_ntohll (uint64_t n);
658 * Convert unsigned 64-bit integer to network-byte-order.
659 * @param n the value in host byte order
660 * @return the same value in network byte order
663 GNUNET_htonll (uint64_t n);
666 * Convert double to network-byte-order.
667 * @param d the value in network byte order
668 * @return the same value in host byte order
671 GNUNET_hton_double (double d);
674 * Convert double to host-byte-order
675 * @param d the value in network byte order
676 * @return the same value in host byte order
679 GNUNET_ntoh_double (double d);
681 /* ************************* allocation functions ****************** */
685 * Maximum allocation with GNUNET_malloc macro.
687 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
691 * Allocate a struct or union of the given 'type'.
692 * Wrapper around GNUNET_malloc that returns a pointer
693 * to the newly created object of the correct type.
695 * @param type name of the struct or union, i.e. pass 'struct Foo'.
697 #define GNUNET_new(type) (type *) GNUNET_malloc (sizeof (type))
701 * Wrapper around malloc. Allocates size bytes of memory.
702 * The memory will be zero'ed out.
704 * @param size the number of bytes to allocate, must be
705 * smaller than 40 MB.
706 * @return pointer to size bytes of memory, never NULL (!)
708 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
712 * Allocate and initialize a block of memory.
714 * @param buf data to initalize the block with
715 * @param size the number of bytes in buf (and size of the allocation)
716 * @return pointer to size bytes of memory, never NULL (!)
718 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
722 * Wrapper around malloc. Allocates size bytes of memory.
723 * The memory will be zero'ed out.
725 * @param size the number of bytes to allocate
726 * @return pointer to size bytes of memory, NULL if we do not have enough memory
728 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
732 * Wrapper around realloc. Rellocates size bytes of memory.
734 * @param ptr the pointer to reallocate
735 * @param size the number of bytes to reallocate
736 * @return pointer to size bytes of memory
738 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
742 * Wrapper around free. Frees the memory referred to by ptr.
743 * Note that is is generally better to free memory that was
744 * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
746 * @param ptr location where to free the memory. ptr must have
747 * been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
749 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
753 * Free the memory pointed to by ptr if ptr is not NULL.
754 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
756 * @param ptr the location in memory to free
758 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
762 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
765 * @param a pointer to a zero-terminated string
766 * @return a copy of the string including zero-termination
768 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
772 * Wrapper around GNUNET_strndup. Makes a partial copy of the string
775 * @param a pointer to a string
776 * @param length of the string to duplicate
777 * @return a partial copy of the string including zero-termination
779 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
783 * Grow a well-typed (!) array. This is a convenience
784 * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
785 * to the new (target) size <tt>tsize</tt>.
788 * Example (simple, well-typed stack):
791 * static struct foo * myVector = NULL;
792 * static int myVecLen = 0;
794 * static void push(struct foo * elem) {
795 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
796 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
799 * static void pop(struct foo * elem) {
800 * if (myVecLen == 0) die();
801 * memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
802 * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
806 * @param arr base-pointer of the vector, may be NULL if size is 0;
807 * will be updated to reflect the new address. The TYPE of
808 * arr is important since size is the number of elements and
809 * not the size in bytes
810 * @param size the number of elements in the existing vector (number
811 * of elements to copy over)
812 * @param tsize the target size for the resulting vector, use 0 to
813 * free the vector (then, arr will be NULL afterwards).
815 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
819 * Append an element to a list (growing the
822 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
826 * Like snprintf, just aborts if the buffer is of insufficient size.
828 * @param buf pointer to buffer that is written to
829 * @param size number of bytes in buf
830 * @param format format strings
831 * @param ... data for format string
832 * @return number of bytes written to buf or negative value on error
835 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
840 * Like asprintf, just portable.
842 * @param buf set to a buffer of sufficient size (allocated, caller must free)
843 * @param format format string (see printf, fprintf, etc.)
844 * @param ... data for format string
845 * @return number of bytes in "*buf" excluding 0-termination
848 GNUNET_asprintf (char **buf, const char *format, ...);
851 /* ************** internal implementations, use macros above! ************** */
854 * Allocate memory. Checks the return value, aborts if no more
855 * memory is available. Don't use GNUNET_xmalloc_ directly. Use the
856 * GNUNET_malloc macro.
857 * The memory will be zero'ed out.
859 * @param size number of bytes to allocate
860 * @param filename where is this call being made (for debugging)
861 * @param linenumber line where this call is being made (for debugging)
862 * @return allocated memory, never NULL
865 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
869 * Allocate and initialize memory. Checks the return value, aborts if no more
870 * memory is available. Don't use GNUNET_xmemdup_ directly. Use the
871 * GNUNET_memdup macro.
873 * @param buf buffer to initialize from (must contain size bytes)
874 * @param size number of bytes to allocate
875 * @param filename where is this call being made (for debugging)
876 * @param linenumber line where this call is being made (for debugging)
877 * @return allocated memory, never NULL
880 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
885 * Allocate memory. This function does not check if the allocation
886 * request is within reasonable bounds, allowing allocations larger
887 * than 40 MB. If you don't expect the possibility of very large
888 * allocations, use GNUNET_malloc instead. The memory will be zero'ed
891 * @param size number of bytes to allocate
892 * @param filename where is this call being made (for debugging)
893 * @param linenumber line where this call is being made (for debugging)
894 * @return pointer to size bytes of memory, NULL if we do not have enough memory
897 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
900 * Reallocate memory. Checks the return value, aborts if no more
901 * memory is available.
904 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
907 * Free memory. Merely a wrapper for the case that we
908 * want to keep track of allocations. Don't use GNUNET_xfree_
909 * directly. Use the GNUNET_free macro.
911 * @param ptr pointer to memory to free
912 * @param filename where is this call being made (for debugging)
913 * @param linenumber line where this call is being made (for debugging)
916 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
920 * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
921 * @param str string to duplicate
922 * @param filename where is this call being made (for debugging)
923 * @param linenumber line where this call is being made (for debugging)
924 * @return the duplicated string
927 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
930 * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
932 * @param str string to duplicate
933 * @param len length of the string to duplicate
934 * @param filename where is this call being made (for debugging)
935 * @param linenumber line where this call is being made (for debugging)
936 * @return the duplicated string
939 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
943 * Grow an array, the new elements are zeroed out.
944 * Grows old by (*oldCount-newCount)*elementSize
945 * bytes and sets *oldCount to newCount.
947 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
949 * @param old address of the pointer to the array
951 * @param elementSize the size of the elements of the array
952 * @param oldCount address of the number of elements in the *old array
953 * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
954 * @param filename where is this call being made (for debugging)
955 * @param linenumber line where this call is being made (for debugging)
958 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
959 unsigned int newCount, const char *filename, int linenumber);
964 * Create a copy of the given message.
966 * @param msg message to copy
967 * @return duplicate of the message
969 struct GNUNET_MessageHeader *
970 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
973 #if __STDC_VERSION__ < 199901L
975 #define __func__ __FUNCTION__
977 #define __func__ "<unknown>"
984 #if 0 /* keep Emacsens' auto-indent happy */
994 #endif /*GNUNET_COMMON_H_ */