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  * Convert a peer identity to a string (for printing debug messages).
 443  * This is one of the very few calls in the entire API that is
 444  * NOT reentrant!
 445  *
 446  * @param pid the peer identity
 447  * @return string form of the pid; will be overwritten by next
 448  *         call to GNUNET_i2s.
 449  */
 450 const char *
 451 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
 452
 453 /**
 454  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 455  * (for printing debug messages).  This is one of the very few calls
 456  * in the entire API that is NOT reentrant!
 457  *
 458  * @param addr the address
 459  * @param addrlen the length of the address
 460  * @return nicely formatted string for the address
 461  *  will be overwritten by next call to GNUNET_a2s.
 462  */
 463 const char *
 464 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
 465
 466 /**
 467  * Convert error type to string.
 468  *
 469  * @param kind type to convert
 470  * @return string corresponding to the type
 471  */
 472 const char *
 473 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 474
 475
 476 /**
 477  * Use this for fatal errors that cannot be handled
 478  */
 479 #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)
 480
 481 /**
 482  * Use this for fatal errors that cannot be handled
 483  */
 484 #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)
 485
 486 /**
 487  * Use this for internal assertion violations that are
 488  * not fatal (can be handled) but should not occur.
 489  */
 490 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 491
 492 /**
 493  * Use this for assertion violations caused by other
 494  * peers (i.e. protocol violations).  We do not want to
 495  * confuse end-users (say, some other peer runs an
 496  * older, broken or incompatible GNUnet version), but
 497  * we still want to see these problems during
 498  * development and testing.  "OP == other peer".
 499  */
 500 #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)
 501
 502 /**
 503  * Log an error message at log-level 'level' that indicates
 504  * a failure of the command 'cmd' with the message given
 505  * by strerror(errno).
 506  */
 507 #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)
 508
 509 /**
 510  * Log an error message at log-level 'level' that indicates
 511  * a failure of the command 'cmd' with the message given
 512  * by strerror(errno).
 513  */
 514 #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)
 515
 516 /**
 517  * Log an error message at log-level 'level' that indicates
 518  * a failure of the command 'cmd' with the message given
 519  * by strerror(errno).
 520  */
 521 #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)
 522
 523 /**
 524  * Log an error message at log-level 'level' that indicates
 525  * a failure of the command 'cmd' with the message given
 526  * by strerror(errno).
 527  */
 528 #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)
 529
 530 /* ************************* endianess conversion ****************** */
 531
 532 /**
 533  * Convert unsigned 64-bit integer to host-byte-order.
 534  * @param n the value in network byte order
 535  * @return the same value in host byte order
 536  */
 537 uint64_t
 538 GNUNET_ntohll (uint64_t n);
 539
 540 /**
 541  * Convert unsigned 64-bit integer to network-byte-order.
 542  * @param n the value in host byte order
 543  * @return the same value in network byte order
 544  */
 545 uint64_t
 546 GNUNET_htonll (uint64_t n);
 547
 548 /**
 549  * Convert double to network-byte-order.
 550  * @param d the value in network byte order
 551  * @return the same value in host byte order
 552  */
 553 double
 554 GNUNET_hton_double (double d);
 555
 556 /**
 557  * Convert double to host-byte-order
 558  * @param d the value in network byte order
 559  * @return the same value in host byte order
 560  */
 561 double
 562 GNUNET_ntoh_double (double d);
 563
 564 /* ************************* allocation functions ****************** */
 565
 566 /**
 567  * Maximum allocation with GNUNET_malloc macro.
 568  */
 569 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 570
 571 /**
 572  * Wrapper around malloc. Allocates size bytes of memory.
 573  * The memory will be zero'ed out.
 574  *
 575  * @param size the number of bytes to allocate, must be
 576  *        smaller than 40 MB.
 577  * @return pointer to size bytes of memory, never NULL (!)
 578  */
 579 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 580
 581 /**
 582  * Allocate and initialize a block of memory.
 583  *
 584  * @param buf data to initalize the block with
 585  * @param size the number of bytes in buf (and size of the allocation)
 586  * @return pointer to size bytes of memory, never NULL (!)
 587  */
 588 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
 589
 590 /**
 591  * Wrapper around malloc. Allocates size bytes of memory.
 592  * The memory will be zero'ed out.
 593  *
 594  * @param size the number of bytes to allocate
 595  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 596  */
 597 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 598
 599 /**
 600  * Wrapper around realloc. Rellocates size bytes of memory.
 601  *
 602  * @param ptr the pointer to reallocate
 603  * @param size the number of bytes to reallocate
 604  * @return pointer to size bytes of memory
 605  */
 606 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 607
 608 /**
 609  * Wrapper around free. Frees the memory referred to by ptr.
 610  * Note that is is generally better to free memory that was
 611  * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
 612  *
 613  * @param ptr location where to free the memory. ptr must have
 614  *     been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
 615  */
 616 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 617
 618 /**
 619  * Free the memory pointed to by ptr if ptr is not NULL.
 620  * Equivalent to if (ptr!=null)GNUNET_free(ptr).
 621  *
 622  * @param ptr the location in memory to free
 623  */
 624 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 625
 626 /**
 627  * Wrapper around GNUNET_strdup.  Makes a copy of the zero-terminated string
 628  * pointed to by a.
 629  *
 630  * @param a pointer to a zero-terminated string
 631  * @return a copy of the string including zero-termination
 632  */
 633 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 634
 635 /**
 636  * Wrapper around GNUNET_strndup.  Makes a partial copy of the string
 637  * pointed to by a.
 638  *
 639  * @param a pointer to a string
 640  * @param length of the string to duplicate
 641  * @return a partial copy of the string including zero-termination
 642  */
 643 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
 644
 645 /**
 646  * Grow a well-typed (!) array.  This is a convenience
 647  * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
 648  * to the new (target) size <tt>tsize</tt>.
 649  * <p>
 650  *
 651  * Example (simple, well-typed stack):
 652  *
 653  * <pre>
 654  * static struct foo * myVector = NULL;
 655  * static int myVecLen = 0;
 656  *
 657  * static void push(struct foo * elem) {
 658  *   GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
 659  *   memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
 660  * }
 661  *
 662  * static void pop(struct foo * elem) {
 663  *   if (myVecLen == 0) die();
 664  *   memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
 665  *   GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
 666  * }
 667  * </pre>
 668  *
 669  * @param arr base-pointer of the vector, may be NULL if size is 0;
 670  *        will be updated to reflect the new address. The TYPE of
 671  *        arr is important since size is the number of elements and
 672  *        not the size in bytes
 673  * @param size the number of elements in the existing vector (number
 674  *        of elements to copy over)
 675  * @param tsize the target size for the resulting vector, use 0 to
 676  *        free the vector (then, arr will be NULL afterwards).
 677  */
 678 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 679
 680 /**
 681  * Append an element to a list (growing the
 682  * list by one).
 683  */
 684 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 685
 686 /**
 687  * Like snprintf, just aborts if the buffer is of insufficient size.
 688  *
 689  * @param buf pointer to buffer that is written to
 690  * @param size number of bytes in buf
 691  * @param format format strings
 692  * @param ... data for format string
 693  * @return number of bytes written to buf or negative value on error
 694  */
 695 int
 696 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 697
 698
 699 /**
 700  * Like asprintf, just portable.
 701  *
 702  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 703  * @param format format string (see printf, fprintf, etc.)
 704  * @param ... data for format string
 705  * @return number of bytes in "*buf" excluding 0-termination
 706  */
 707 int
 708 GNUNET_asprintf (char **buf, const char *format, ...);
 709
 710
 711 /* ************** internal implementations, use macros above! ************** */
 712
 713 /**
 714  * Allocate memory. Checks the return value, aborts if no more
 715  * memory is available.  Don't use GNUNET_xmalloc_ directly. Use the
 716  * GNUNET_malloc macro.
 717  * The memory will be zero'ed out.
 718  *
 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_xmalloc_ (size_t size, const char *filename, int linenumber);
 726
 727
 728 /**
 729  * Allocate and initialize memory. Checks the return value, aborts if no more
 730  * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
 731  * GNUNET_memdup macro.
 732  *
 733  * @param buf buffer to initialize from (must contain size bytes)
 734  * @param size number of bytes to allocate
 735  * @param filename where is this call being made (for debugging)
 736  * @param linenumber line where this call is being made (for debugging)
 737  * @return allocated memory, never NULL
 738  */
 739 void *
 740 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
 741                  int linenumber);
 742
 743
 744 /**
 745  * Allocate memory.  This function does not check if the allocation
 746  * request is within reasonable bounds, allowing allocations larger
 747  * than 40 MB.  If you don't expect the possibility of very large
 748  * allocations, use GNUNET_malloc instead.  The memory will be zero'ed
 749  * out.
 750  *
 751  * @param size number of bytes to allocate
 752  * @param filename where is this call being made (for debugging)
 753  * @param linenumber line where this call is being made (for debugging)
 754  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 755  */
 756 void *
 757 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
 758
 759 /**
 760  * Reallocate memory. Checks the return value, aborts if no more
 761  * memory is available.
 762  */
 763 void *
 764 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
 765
 766 /**
 767  * Free memory. Merely a wrapper for the case that we
 768  * want to keep track of allocations.  Don't use GNUNET_xfree_
 769  * directly. Use the GNUNET_free macro.
 770  *
 771  * @param ptr pointer to memory to free
 772  * @param filename where is this call being made (for debugging)
 773  * @param linenumber line where this call is being made (for debugging)
 774  */
 775 void
 776 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
 777
 778
 779 /**
 780  * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
 781  * @param str string to duplicate
 782  * @param filename where is this call being made (for debugging)
 783  * @param linenumber line where this call is being made (for debugging)
 784  * @return the duplicated string
 785  */
 786 char *
 787 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
 788
 789 /**
 790  * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
 791  *
 792  * @param str string to duplicate
 793  * @param len length of the string to duplicate
 794  * @param filename where is this call being made (for debugging)
 795  * @param linenumber line where this call is being made (for debugging)
 796  * @return the duplicated string
 797  */
 798 char *
 799 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
 800                   int linenumber);
 801
 802 /**
 803  * Grow an array, the new elements are zeroed out.
 804  * Grows old by (*oldCount-newCount)*elementSize
 805  * bytes and sets *oldCount to newCount.
 806  *
 807  * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
 808  *
 809  * @param old address of the pointer to the array
 810  *        *old may be NULL
 811  * @param elementSize the size of the elements of the array
 812  * @param oldCount address of the number of elements in the *old array
 813  * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
 814  * @param filename where is this call being made (for debugging)
 815  * @param linenumber line where this call is being made (for debugging)
 816  */
 817 void
 818 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
 819                unsigned int newCount, const char *filename, int linenumber);
 820
 821
 822 /**
 823  * Create a copy of the given message.
 824  *
 825  * @param msg message to copy
 826  * @return duplicate of the message
 827  */
 828 struct GNUNET_MessageHeader *
 829 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
 830
 831
 832 #if __STDC_VERSION__ < 199901L
 833 #if __GNUC__ >= 2
 834 #define __func__ __FUNCTION__
 835 #else
 836 #define __func__ "<unknown>"
 837 #endif
 838 #endif
 839
 840 #endif /*GNUNET_COMMON_H_ */