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