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