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