src/include/gnunet_common.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2006, 2009 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 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.
  26  *
  27  * @author Christian Grothoff
  28  * @author Nils Durner
  29  */
  30 #ifndef GNUNET_COMMON_H
  31 #define GNUNET_COMMON_H
  32
  33 #if HAVE_SYS_SOCKET_H
  34 #include <sys/socket.h>
  35 #endif
  36 #if HAVE_NETINET_IN_H
  37 #include <netinet/in.h>
  38 #endif
  39 #ifdef MINGW
  40 #include "winproc.h"
  41 #endif
  42 #ifdef HAVE_STDINT_H
  43 #include <stdint.h>
  44 #endif
  45 #ifdef HAVE_STDARG_H
  46 #include <stdarg.h>
  47 #endif
  48
  49 /**
  50  * Version of the API (for entire gnunetutil.so library).
  51  */
  52 #define GNUNET_UTIL_VERSION 0x00090000
  53
  54 /**
  55  * Named constants for return values.  The following
  56  * invariants hold: "GNUNET_NO == 0" (to allow "if (GNUNET_NO)")
  57  * "GNUNET_OK != GNUNET_SYSERR", "GNUNET_OK != GNUNET_NO", "GNUNET_NO != GNUNET_SYSERR"
  58  * and finally "GNUNET_YES != GNUNET_NO".
  59  */
  60 #define GNUNET_OK      1
  61 #define GNUNET_SYSERR -1
  62 #define GNUNET_YES     1
  63 #define GNUNET_NO      0
  64
  65 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
  66
  67 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
  68
  69 /**
  70  * Endian operations
  71  */
  72
  73 # if __BYTE_ORDER == __LITTLE_ENDIAN
  74 #  define GNUNET_htobe16(x) __bswap_16 (x)
  75 #  define GNUNET_htole16(x) (x)
  76 #  define GNUNET_be16toh(x) __bswap_16 (x)
  77 #  define GNUNET_le16toh(x) (x)
  78
  79 #  define GNUNET_htobe32(x) __bswap_32 (x)
  80 #  define GNUNET_htole32(x) (x)
  81 #  define GNUNET_be32toh(x) __bswap_32 (x)
  82 #  define GNUNET_le32toh(x) (x)
  83
  84 #  define GNUNET_htobe64(x) __bswap_64 (x)
  85 #  define GNUNET_htole64(x) (x)
  86 #  define GNUNET_be64toh(x) __bswap_64 (x)
  87 #  define GNUNET_le64toh(x) (x)
  88 # if __BYTE_ORDER == __BIG_ENDIAN
  89 #  define GNUNET_htobe16(x) (x)
  90 #  define GNUNET_htole16(x) __bswap_16 (x)
  91 #  define GNUNET_be16toh(x) (x)
  92 #  define GNUNET_le16toh(x) __bswap_16 (x)
  93
  94 #  define GNUNET_htobe32(x) (x)
  95 #  define GNUNET_htole32(x) __bswap_32 (x)
  96 #  define GNUNET_be32toh(x) (x)
  97 #  define GNUNET_le32toh(x) __bswap_32 (x)
  98
  99 #  define GNUNET_htobe64(x) (x)
 100 #  define GNUNET_htole64(x) __bswap_64 (x)
 101 #  define GNUNET_be64toh(x) (x)
 102 #  define GNUNET_le64toh(x) __bswap_64 (x)
 103 # endif
 104 #endif
 105
 106
 107
 108 /**
 109  * gcc-ism to get packed structs.
 110  */
 111 #define GNUNET_PACKED __attribute__((packed))
 112
 113 /**
 114  * gcc-ism to document unused arguments
 115  */
 116 #define GNUNET_UNUSED __attribute__((unused))
 117
 118
 119 /* ************************ super-general types *********************** */
 120
 121 /**
 122  * Header for all communications.
 123  */
 124 struct GNUNET_MessageHeader
 125 {
 126
 127   /**
 128    * The length of the struct (in bytes, including the length field itself),
 129    * in big-endian format.
 130    */
 131   uint16_t size GNUNET_PACKED;
 132
 133   /**
 134    * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
 135    */
 136   uint16_t type GNUNET_PACKED;
 137
 138 };
 139
 140
 141 /**
 142  * @brief 512-bit hashcode
 143  */
 144 typedef struct
 145 {
 146   uint32_t bits[512 / 8 / sizeof (uint32_t)];   /* = 16 */
 147 }
 148 GNUNET_HashCode;
 149
 150
 151 /**
 152  * The identity of the host (basically the SHA-512 hashcode of
 153  * it's public key).
 154  */
 155 struct GNUNET_PeerIdentity
 156 {
 157   GNUNET_HashCode hashPubKey GNUNET_PACKED;
 158 };
 159
 160
 161 /**
 162  * Function called with a filename.
 163  *
 164  * @param cls closure
 165  * @param filename complete filename (absolute path)
 166  * @return GNUNET_OK to continue to iterate,
 167  *  GNUNET_SYSERR to abort iteration with error!
 168  */
 169 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
 170
 171
 172 /* ****************************** logging ***************************** */
 173
 174 /**
 175  * Types of errors.
 176  */
 177 enum GNUNET_ErrorType
 178 {
 179   GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
 180   GNUNET_ERROR_TYPE_NONE = 0,
 181   GNUNET_ERROR_TYPE_ERROR = 1,
 182   GNUNET_ERROR_TYPE_WARNING = 2,
 183   GNUNET_ERROR_TYPE_INFO = 4,
 184   GNUNET_ERROR_TYPE_DEBUG = 8,
 185   GNUNET_ERROR_TYPE_INVALID = 16,
 186   GNUNET_ERROR_TYPE_BULK = 32
 187 };
 188
 189
 190 /**
 191  * User-defined handler for log messages.
 192  *
 193  * @param cls closure
 194  * @param kind severeity
 195  * @param component what component is issuing the message?
 196  * @param date when was the message logged?
 197  * @param message what is the message
 198  */
 199 typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind,
 200                                const char *component, const char *date,
 201                                const char *message);
 202
 203
 204 /**
 205  * Number of log calls to ignore.
 206  */
 207 extern unsigned int skip_log;
 208
 209 #if !defined(GNUNET_CULL_LOGGING)
 210 int
 211 GNUNET_get_log_call_status (int caller_level, const char *comp,
 212                             const char *file, const char *function, int line);
 213 #endif
 214 /**
 215  * Main log function.
 216  *
 217  * @param kind how serious is the error?
 218  * @param message what is the message (format string)
 219  * @param ... arguments for format string
 220  */
 221 void
 222 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
 223
 224 /* from glib */
 225 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 226 #define _GNUNET_BOOLEAN_EXPR(expr)              \
 227  __extension__ ({                               \
 228    int _gnunet_boolean_var_;                    \
 229    if (expr)                                    \
 230       _gnunet_boolean_var_ = 1;                 \
 231    else                                         \
 232       _gnunet_boolean_var_ = 0;                 \
 233    _gnunet_boolean_var_;                        \
 234 })
 235 #define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1))
 236 #define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0))
 237 #else
 238 #define GN_LIKELY(expr) (expr)
 239 #define GN_UNLIKELY(expr) (expr)
 240 #endif
 241
 242 #if !defined(GNUNET_LOG_CALL_STATUS)
 243 #define GNUNET_LOG_CALL_STATUS -1
 244 #endif
 245
 246 /**
 247  * Log function that specifies an alternative component.
 248  * This function should be used by plugins.
 249  *
 250  * @param kind how serious is the error?
 251  * @param comp component responsible for generating the message
 252  * @param message what is the message (format string)
 253  * @param ... arguments for format string
 254  */
 255 void
 256 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
 257                          const char *message, ...);
 258
 259 #if !defined(GNUNET_CULL_LOGGING)
 260 #define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\
 261   static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
 262   if (GN_UNLIKELY(log_call_enabled == -1))\
 263     log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), comp, __FILE__, __FUNCTION__, log_line);\
 264   if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\
 265   else {\
 266     if (GN_UNLIKELY(log_call_enabled))\
 267       GNUNET_log_from_nocheck (kind, comp, __VA_ARGS__);\
 268   }\
 269 } while (0)
 270
 271 #define GNUNET_log(kind,...) do { int log_line = __LINE__;\
 272   static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
 273   if (GN_UNLIKELY(log_call_enabled == -1))\
 274     log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\
 275   if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\
 276   else {\
 277     if (GN_UNLIKELY(log_call_enabled))\
 278       GNUNET_log_nocheck (kind, __VA_ARGS__);\
 279   }\
 280 } while (0)
 281 #else
 282 #define GNUNET_log(...)
 283 #define GNUNET_log_from(...)
 284 #endif
 285
 286
 287 /**
 288  * Abort the process, generate a core dump if possible.
 289  */
 290 void
 291 GNUNET_abort (void);
 292
 293 /**
 294  * Ignore the next n calls to the log function.
 295  *
 296  * @param n number of log calls to ignore
 297  * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
 298  */
 299 void
 300 GNUNET_log_skip (unsigned int n, int check_reset);
 301
 302
 303 /**
 304  * Setup logging.
 305  *
 306  * @param comp default component to use
 307  * @param loglevel what types of messages should be logged
 308  * @param logfile change logging to logfile (use NULL to keep stderr)
 309  * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
 310  */
 311 int
 312 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
 313
 314
 315 /**
 316  * Add a custom logger.
 317  *
 318  * @param logger log function
 319  * @param logger_cls closure for logger
 320  */
 321 void
 322 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
 323
 324
 325 /**
 326  * Remove a custom logger.
 327  *
 328  * @param logger log function
 329  * @param logger_cls closure for logger
 330  */
 331 void
 332 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
 333
 334
 335 /**
 336  * Convert a hash value to a string (for printing debug messages).
 337  * This is one of the very few calls in the entire API that is
 338  * NOT reentrant!
 339  *
 340  * @param hc the hash code
 341  * @return string
 342  */
 343 const char *
 344 GNUNET_h2s (const GNUNET_HashCode * hc);
 345
 346
 347 /**
 348  * Convert a hash value to a string (for printing debug messages).
 349  * This prints all 104 characters of a hashcode!
 350  * This is one of the very few calls in the entire API that is
 351  * NOT reentrant!
 352  *
 353  * @param hc the hash code
 354  * @return string
 355  */
 356 const char *
 357 GNUNET_h2s_full (const GNUNET_HashCode * hc);
 358
 359
 360 /**
 361  * Convert a peer identity to a string (for printing debug messages).
 362  * This is one of the very few calls in the entire API that is
 363  * NOT reentrant!
 364  *
 365  * @param pid the peer identity
 366  * @return string form of the pid; will be overwritten by next
 367  *         call to GNUNET_i2s.
 368  */
 369 const char *
 370 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 371
 372
 373 /**
 374  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 375  * (for printing debug messages).  This is one of the very few calls
 376  * in the entire API that is NOT reentrant!
 377  *
 378  * @param addr the address
 379  * @param addrlen the length of the address
 380  * @return nicely formatted string for the address
 381  *  will be overwritten by next call to GNUNET_a2s.
 382  */
 383 const char *
 384 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
 385
 386 /**
 387  * Convert error type to string.
 388  *
 389  * @param kind type to convert
 390  * @return string corresponding to the type
 391  */
 392 const char *
 393 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 394
 395
 396 /**
 397  * Use this for fatal errors that cannot be handled
 398  */
 399 #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)
 400
 401 /**
 402  * Use this for fatal errors that cannot be handled
 403  */
 404 #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)
 405
 406 /**
 407  * Use this for internal assertion violations that are
 408  * not fatal (can be handled) but should not occur.
 409  */
 410 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 411
 412 /**
 413  * Use this for assertion violations caused by other
 414  * peers (i.e. protocol violations).  We do not want to
 415  * confuse end-users (say, some other peer runs an
 416  * older, broken or incompatible GNUnet version), but
 417  * we still want to see these problems during
 418  * development and testing.  "OP == other peer".
 419  */
 420 #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)
 421
 422 /**
 423  * Log an error message at log-level 'level' that indicates
 424  * a failure of the command 'cmd' with the message given
 425  * by strerror(errno).
 426  */
 427 #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)
 428
 429 /**
 430  * Log an error message at log-level 'level' that indicates
 431  * a failure of the command 'cmd' with the message given
 432  * by strerror(errno).
 433  */
 434 #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)
 435
 436 /**
 437  * Log an error message at log-level 'level' that indicates
 438  * a failure of the command 'cmd' with the message given
 439  * by strerror(errno).
 440  */
 441 #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)
 442
 443 /**
 444  * Log an error message at log-level 'level' that indicates
 445  * a failure of the command 'cmd' with the message given
 446  * by strerror(errno).
 447  */
 448 #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)
 449
 450 /* ************************* endianess conversion ****************** */
 451
 452 /**
 453  * Convert unsigned 64-bit integer to host-byte-order.
 454  * @param n the value in network byte order
 455  * @return the same value in host byte order
 456  */
 457 uint64_t
 458 GNUNET_ntohll (uint64_t n);
 459
 460 /**
 461  * Convert unsigned 64-bit integer to network-byte-order.
 462  * @param n the value in host byte order
 463  * @return the same value in network byte order
 464  */
 465 uint64_t
 466 GNUNET_htonll (uint64_t n);
 467
 468
 469 /* ************************* allocation functions ****************** */
 470
 471 /**
 472  * Maximum allocation with GNUNET_malloc macro.
 473  */
 474 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 475
 476 /**
 477  * Wrapper around malloc. Allocates size bytes of memory.
 478  * The memory will be zero'ed out.
 479  *
 480  * @param size the number of bytes to allocate, must be
 481  *        smaller than 40 MB.
 482  * @return pointer to size bytes of memory, never NULL (!)
 483  */
 484 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 485
 486 /**
 487  * Allocate and initialize a block of memory.
 488  *
 489  * @param buf data to initalize the block with
 490  * @param size the number of bytes in buf (and size of the allocation)
 491  * @return pointer to size bytes of memory, never NULL (!)
 492  */
 493 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
 494
 495 /**
 496  * Wrapper around malloc. Allocates size bytes of memory.
 497  * The memory will be zero'ed out.
 498  *
 499  * @param size the number of bytes to allocate
 500  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 501  */
 502 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 503
 504 /**
 505  * Wrapper around realloc. Rellocates size bytes of memory.
 506  *
 507  * @param ptr the pointer to reallocate
 508  * @param size the number of bytes to reallocate
 509  * @return pointer to size bytes of memory
 510  */
 511 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 512
 513 /**
 514  * Wrapper around free. Frees the memory referred to by ptr.
 515  * Note that is is generally better to free memory that was
 516  * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
 517  *
 518  * @param ptr location where to free the memory. ptr must have
 519  *     been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
 520  */
 521 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 522
 523 /**
 524  * Free the memory pointed to by ptr if ptr is not NULL.
 525  * Equivalent to if (ptr!=null)GNUNET_free(ptr).
 526  *
 527  * @param ptr the location in memory to free
 528  */
 529 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 530
 531 /**
 532  * Wrapper around GNUNET_strdup.  Makes a copy of the zero-terminated string
 533  * pointed to by a.
 534  *
 535  * @param a pointer to a zero-terminated string
 536  * @return a copy of the string including zero-termination
 537  */
 538 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 539
 540 /**
 541  * Wrapper around GNUNET_strndup.  Makes a partial copy of the string
 542  * pointed to by a.
 543  *
 544  * @param a pointer to a string
 545  * @param length of the string to duplicate
 546  * @return a partial copy of the string including zero-termination
 547  */
 548 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
 549
 550 /**
 551  * Grow a well-typed (!) array.  This is a convenience
 552  * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
 553  * to the new (target) size <tt>tsize</tt>.
 554  * <p>
 555  *
 556  * Example (simple, well-typed stack):
 557  *
 558  * <pre>
 559  * static struct foo * myVector = NULL;
 560  * static int myVecLen = 0;
 561  *
 562  * static void push(struct foo * elem) {
 563  *   GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
 564  *   memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
 565  * }
 566  *
 567  * static void pop(struct foo * elem) {
 568  *   if (myVecLen == 0) die();
 569  *   memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
 570  *   GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
 571  * }
 572  * </pre>
 573  *
 574  * @param arr base-pointer of the vector, may be NULL if size is 0;
 575  *        will be updated to reflect the new address. The TYPE of
 576  *        arr is important since size is the number of elements and
 577  *        not the size in bytes
 578  * @param size the number of elements in the existing vector (number
 579  *        of elements to copy over)
 580  * @param tsize the target size for the resulting vector, use 0 to
 581  *        free the vector (then, arr will be NULL afterwards).
 582  */
 583 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 584
 585 /**
 586  * Append an element to a list (growing the
 587  * list by one).
 588  */
 589 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 590
 591 /**
 592  * Like snprintf, just aborts if the buffer is of insufficient size.
 593  *
 594  * @param buf pointer to buffer that is written to
 595  * @param size number of bytes in buf
 596  * @param format format strings
 597  * @param ... data for format string
 598  * @return number of bytes written to buf or negative value on error
 599  */
 600 int
 601 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 602
 603
 604 /**
 605  * Like asprintf, just portable.
 606  *
 607  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 608  * @param format format string (see printf, fprintf, etc.)
 609  * @param ... data for format string
 610  * @return number of bytes in "*buf" excluding 0-termination
 611  */
 612 int
 613 GNUNET_asprintf (char **buf, const char *format, ...);
 614
 615
 616 /* ************** internal implementations, use macros above! ************** */
 617
 618 /**
 619  * Allocate memory. Checks the return value, aborts if no more
 620  * memory is available.  Don't use GNUNET_xmalloc_ directly. Use the
 621  * GNUNET_malloc macro.
 622  * The memory will be zero'ed out.
 623  *
 624  * @param size number of bytes to allocate
 625  * @param filename where is this call being made (for debugging)
 626  * @param linenumber line where this call is being made (for debugging)
 627  * @return allocated memory, never NULL
 628  */
 629 void *
 630 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
 631
 632
 633 /**
 634  * Allocate and initialize memory. Checks the return value, aborts if no more
 635  * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
 636  * GNUNET_memdup macro.
 637  *
 638  * @param buf buffer to initialize from (must contain size bytes)
 639  * @param size number of bytes to allocate
 640  * @param filename where is this call being made (for debugging)
 641  * @param linenumber line where this call is being made (for debugging)
 642  * @return allocated memory, never NULL
 643  */
 644 void *
 645 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
 646                  int linenumber);
 647
 648
 649 /**
 650  * Allocate memory.  This function does not check if the allocation
 651  * request is within reasonable bounds, allowing allocations larger
 652  * than 40 MB.  If you don't expect the possibility of very large
 653  * allocations, use GNUNET_malloc instead.  The memory will be zero'ed
 654  * out.
 655  *
 656  * @param size number of bytes to allocate
 657  * @param filename where is this call being made (for debugging)
 658  * @param linenumber line where this call is being made (for debugging)
 659  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 660  */
 661 void *
 662 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
 663
 664 /**
 665  * Reallocate memory. Checks the return value, aborts if no more
 666  * memory is available.
 667  */
 668 void *
 669 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
 670
 671 /**
 672  * Free memory. Merely a wrapper for the case that we
 673  * want to keep track of allocations.  Don't use GNUNET_xfree_
 674  * directly. Use the GNUNET_free macro.
 675  *
 676  * @param ptr pointer to memory to free
 677  * @param filename where is this call being made (for debugging)
 678  * @param linenumber line where this call is being made (for debugging)
 679  */
 680 void
 681 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
 682
 683
 684 /**
 685  * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
 686  * @param str string to duplicate
 687  * @param filename where is this call being made (for debugging)
 688  * @param linenumber line where this call is being made (for debugging)
 689  * @return the duplicated string
 690  */
 691 char *
 692 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
 693
 694 /**
 695  * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
 696  *
 697  * @param str string to duplicate
 698  * @param len length of the string to duplicate
 699  * @param filename where is this call being made (for debugging)
 700  * @param linenumber line where this call is being made (for debugging)
 701  * @return the duplicated string
 702  */
 703 char *
 704 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
 705                   int linenumber);
 706
 707 /**
 708  * Grow an array, the new elements are zeroed out.
 709  * Grows old by (*oldCount-newCount)*elementSize
 710  * bytes and sets *oldCount to newCount.
 711  *
 712  * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
 713  *
 714  * @param old address of the pointer to the array
 715  *        *old may be NULL
 716  * @param elementSize the size of the elements of the array
 717  * @param oldCount address of the number of elements in the *old array
 718  * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
 719  * @param filename where is this call being made (for debugging)
 720  * @param linenumber line where this call is being made (for debugging)
 721  */
 722 void
 723 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
 724                unsigned int newCount, const char *filename, int linenumber);
 725
 726
 727 /**
 728  * Create a copy of the given message.
 729  *
 730  * @param msg message to copy
 731  * @return duplicate of the message
 732  */
 733 struct GNUNET_MessageHeader *
 734 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
 735
 736
 737 #if __STDC_VERSION__ < 199901L
 738 #if __GNUC__ >= 2
 739 #define __func__ __FUNCTION__
 740 #else
 741 #define __func__ "<unknown>"
 742 #endif
 743 #endif
 744
 745 #endif /*GNUNET_COMMON_H_ */