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