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