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