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