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