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