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