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