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