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