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