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