src/include/gnunet_common.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2006-2013 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 3, 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  * @defgroup logging Logging
  31  * @defgroup memory Memory management
  32  */
  33 #ifndef GNUNET_COMMON_H
  34 #define GNUNET_COMMON_H
  35
  36 #if HAVE_SYS_SOCKET_H
  37 #include <sys/socket.h>
  38 #endif
  39 #if HAVE_NETINET_IN_H
  40 #include <netinet/in.h>
  41 #endif
  42 #ifdef MINGW
  43 #include "winproc.h"
  44 #endif
  45 #ifdef HAVE_STDINT_H
  46 #include <stdint.h>
  47 #endif
  48 #ifdef HAVE_STDARG_H
  49 #include <stdarg.h>
  50 #endif
  51
  52 #ifdef __cplusplus
  53 extern "C"
  54 {
  55 #if 0                           /* keep Emacsens' auto-indent happy */
  56 }
  57 #endif
  58 #endif
  59
  60 /**
  61  * Version of the API (for entire gnunetutil.so library).
  62  */
  63 #define GNUNET_UTIL_VERSION 0x000A0100
  64
  65 /**
  66  * Named constants for return values.  The following invariants hold:
  67  * `GNUNET_NO == 0` (to allow `if (GNUNET_NO)`) `GNUNET_OK !=
  68  * GNUNET_SYSERR`, `GNUNET_OK != GNUNET_NO`, `GNUNET_NO !=
  69  * GNUNET_SYSERR` and finally `GNUNET_YES != GNUNET_NO`.
  70  */
  71 #define GNUNET_OK      1
  72 #define GNUNET_SYSERR -1
  73 #define GNUNET_YES     1
  74 #define GNUNET_NO      0
  75
  76 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
  77
  78 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
  79
  80 /* some systems use one underscore only, and mingw uses no underscore... */
  81 #ifndef __BYTE_ORDER
  82 #ifdef _BYTE_ORDER
  83 #define __BYTE_ORDER _BYTE_ORDER
  84 #else
  85 #ifdef BYTE_ORDER
  86 #define __BYTE_ORDER BYTE_ORDER
  87 #endif
  88 #endif
  89 #endif
  90 #ifndef __BIG_ENDIAN
  91 #ifdef _BIG_ENDIAN
  92 #define __BIG_ENDIAN _BIG_ENDIAN
  93 #else
  94 #ifdef BIG_ENDIAN
  95 #define __BIG_ENDIAN BIG_ENDIAN
  96 #endif
  97 #endif
  98 #endif
  99 #ifndef __LITTLE_ENDIAN
 100 #ifdef _LITTLE_ENDIAN
 101 #define __LITTLE_ENDIAN _LITTLE_ENDIAN
 102 #else
 103 #ifdef LITTLE_ENDIAN
 104 #define __LITTLE_ENDIAN LITTLE_ENDIAN
 105 #endif
 106 #endif
 107 #endif
 108
 109 /**
 110  * @ingroup logging
 111  * define #GNUNET_EXTRA_LOGGING if using this header outside the GNUnet source
 112  * tree where gnunet_config.h is unavailable
 113  */
 114 #ifndef GNUNET_EXTRA_LOGGING
 115 #define GNUNET_EXTRA_LOGGING 0
 116 #endif
 117
 118 /**
 119  * Endian operations
 120  */
 121
 122 # if __BYTE_ORDER == __LITTLE_ENDIAN
 123 #  define GNUNET_htobe16(x) __bswap_16 (x)
 124 #  define GNUNET_htole16(x) (x)
 125 #  define GNUNET_be16toh(x) __bswap_16 (x)
 126 #  define GNUNET_le16toh(x) (x)
 127
 128 #  define GNUNET_htobe32(x) __bswap_32 (x)
 129 #  define GNUNET_htole32(x) (x)
 130 #  define GNUNET_be32toh(x) __bswap_32 (x)
 131 #  define GNUNET_le32toh(x) (x)
 132
 133 #  define GNUNET_htobe64(x) __bswap_64 (x)
 134 #  define GNUNET_htole64(x) (x)
 135 #  define GNUNET_be64toh(x) __bswap_64 (x)
 136 #  define GNUNET_le64toh(x) (x)
 137 #endif
 138 # if __BYTE_ORDER == __BIG_ENDIAN
 139 #  define GNUNET_htobe16(x) (x)
 140 #  define GNUNET_htole16(x) __bswap_16 (x)
 141 #  define GNUNET_be16toh(x) (x)
 142 #  define GNUNET_le16toh(x) __bswap_16 (x)
 143
 144 #  define GNUNET_htobe32(x) (x)
 145 #  define GNUNET_htole32(x) __bswap_32 (x)
 146 #  define GNUNET_be32toh(x) (x)
 147 #  define GNUNET_le32toh(x) __bswap_32 (x)
 148
 149 #  define GNUNET_htobe64(x) (x)
 150 #  define GNUNET_htole64(x) __bswap_64 (x)
 151 #  define GNUNET_be64toh(x) (x)
 152 #  define GNUNET_le64toh(x) __bswap_64 (x)
 153 #endif
 154
 155
 156
 157
 158 /**
 159  * gcc-ism to get packed structs.
 160  */
 161 #define GNUNET_PACKED __attribute__((packed))
 162
 163 /**
 164  * gcc-ism to get gcc bitfield layout when compiling with -mms-bitfields
 165  */
 166 #if MINGW
 167 #define GNUNET_GCC_STRUCT_LAYOUT __attribute__((gcc_struct))
 168 #else
 169 #define GNUNET_GCC_STRUCT_LAYOUT
 170 #endif
 171
 172 /**
 173  * gcc-ism to force alignment; we use this to align char-arrays
 174  * that may then be cast to 'struct's.  See also gcc
 175  * bug #33594.
 176  */
 177 #ifdef __BIGGEST_ALIGNMENT__
 178 #define GNUNET_ALIGN __attribute__((aligned (__BIGGEST_ALIGNMENT__)))
 179 #else
 180 #define GNUNET_ALIGN __attribute__((aligned (8)))
 181 #endif
 182
 183 /**
 184  * gcc-ism to document unused arguments
 185  */
 186 #define GNUNET_UNUSED __attribute__((unused))
 187
 188 /**
 189  * gcc-ism to document functions that don't return
 190  */
 191 #define GNUNET_NORETURN __attribute__((noreturn))
 192
 193 #if MINGW
 194 #if __GNUC__ > 3
 195 /**
 196  * gcc 4.x-ism to pack structures even on W32 (to be used before structs);
 197  * Using this would cause structs to be unaligned on the stack on Sparc,
 198  * so we *only* use this on W32 (see #670578 from Debian); fortunately,
 199  * W32 doesn't run on sparc anyway.
 200  */
 201 #define GNUNET_NETWORK_STRUCT_BEGIN \
 202   _Pragma("pack(push)") \
 203   _Pragma("pack(1)")
 204
 205 /**
 206  * gcc 4.x-ism to pack structures even on W32 (to be used after structs)
 207  * Using this would cause structs to be unaligned on the stack on Sparc,
 208  * so we *only* use this on W32 (see #670578 from Debian); fortunately,
 209  * W32 doesn't run on sparc anyway.
 210  */
 211 #define GNUNET_NETWORK_STRUCT_END _Pragma("pack(pop)")
 212
 213 #else
 214 #error gcc 4.x or higher required on W32 systems
 215 #endif
 216 #else
 217 /**
 218  * Define as empty, GNUNET_PACKED should suffice, but this won't work on W32
 219  */
 220 #define GNUNET_NETWORK_STRUCT_BEGIN
 221
 222 /**
 223  * Define as empty, GNUNET_PACKED should suffice, but this won't work on W32;
 224  */
 225 #define GNUNET_NETWORK_STRUCT_END
 226 #endif
 227
 228 /* ************************ super-general types *********************** */
 229
 230 GNUNET_NETWORK_STRUCT_BEGIN
 231
 232 /**
 233  * Header for all communications.
 234  */
 235 struct GNUNET_MessageHeader
 236 {
 237
 238   /**
 239    * The length of the struct (in bytes, including the length field itself),
 240    * in big-endian format.
 241    */
 242   uint16_t size GNUNET_PACKED;
 243
 244   /**
 245    * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
 246    */
 247   uint16_t type GNUNET_PACKED;
 248
 249 };
 250
 251 GNUNET_NETWORK_STRUCT_END
 252
 253 /**
 254  * Function called with a filename.
 255  *
 256  * @param cls closure
 257  * @param filename complete filename (absolute path)
 258  * @return #GNUNET_OK to continue to iterate,
 259  *  #GNUNET_NO to stop iteration with no error,
 260  *  #GNUNET_SYSERR to abort iteration with error!
 261  */
 262 typedef int
 263 (*GNUNET_FileNameCallback) (void *cls,
 264                             const char *filename);
 265
 266
 267 /**
 268  * Generic continuation callback.
 269  *
 270  * @param cls  Closure.
 271  */
 272 typedef void
 273 (*GNUNET_ContinuationCallback) (void *cls);
 274
 275
 276 /* ****************************** logging ***************************** */
 277
 278 /**
 279  * @ingroup logging
 280  * Types of errors.
 281  */
 282 enum GNUNET_ErrorType
 283 {
 284   GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
 285   GNUNET_ERROR_TYPE_NONE = 0,
 286   GNUNET_ERROR_TYPE_ERROR = 1,
 287   GNUNET_ERROR_TYPE_WARNING = 2,
 288   GNUNET_ERROR_TYPE_INFO = 4,
 289   GNUNET_ERROR_TYPE_DEBUG = 8,
 290   GNUNET_ERROR_TYPE_INVALID = 16,
 291   GNUNET_ERROR_TYPE_BULK = 32
 292 };
 293
 294
 295 /**
 296  * @ingroup logging
 297  * User-defined handler for log messages.
 298  *
 299  * @param cls closure
 300  * @param kind severeity
 301  * @param component what component is issuing the message?
 302  * @param date when was the message logged?
 303  * @param message what is the message
 304  */
 305 typedef void
 306 (*GNUNET_Logger) (void *cls,
 307                   enum GNUNET_ErrorType kind,
 308                   const char *component,
 309                   const char *date,
 310                   const char *message);
 311
 312
 313 /**
 314  * @ingroup logging
 315  * Get the number of log calls that are going to be skipped
 316  *
 317  * @return number of log calls to be ignored
 318  */
 319 int
 320 GNUNET_get_log_skip (void);
 321
 322
 323 #if !defined(GNUNET_CULL_LOGGING)
 324 int
 325 GNUNET_get_log_call_status (int caller_level,
 326                             const char *comp,
 327                             const char *file,
 328                             const char *function,
 329                             int line);
 330 #endif
 331
 332
 333 /**
 334  * @ingroup logging
 335  * Main log function.
 336  *
 337  * @param kind how serious is the error?
 338  * @param message what is the message (format string)
 339  * @param ... arguments for format string
 340  */
 341 void
 342 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
 343
 344 /* from glib */
 345 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 346 #define _GNUNET_BOOLEAN_EXPR(expr)              \
 347  __extension__ ({                               \
 348    int _gnunet_boolean_var_;                    \
 349    if (expr)                                    \
 350       _gnunet_boolean_var_ = 1;                 \
 351    else                                         \
 352       _gnunet_boolean_var_ = 0;                 \
 353    _gnunet_boolean_var_;                        \
 354 })
 355 #define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1))
 356 #define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0))
 357 #else
 358 #define GN_LIKELY(expr) (expr)
 359 #define GN_UNLIKELY(expr) (expr)
 360 #endif
 361
 362 #if !defined(GNUNET_LOG_CALL_STATUS)
 363 #define GNUNET_LOG_CALL_STATUS -1
 364 #endif
 365
 366
 367 /**
 368  * @ingroup logging
 369  * Log function that specifies an alternative component.
 370  * This function should be used by plugins.
 371  *
 372  * @param kind how serious is the error?
 373  * @param comp component responsible for generating the message
 374  * @param message what is the message (format string)
 375  * @param ... arguments for format string
 376  */
 377 void
 378 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
 379                          const char *message, ...);
 380
 381 #if !defined(GNUNET_CULL_LOGGING)
 382 #define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\
 383   static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
 384   if ((GNUNET_EXTRA_LOGGING > 0) || ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0)) { \
 385     if (GN_UNLIKELY(log_call_enabled == -1))\
 386       log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), (comp), __FILE__, __FUNCTION__, log_line); \
 387     if (GN_UNLIKELY(GNUNET_get_log_skip () > 0)) { GNUNET_log_skip (-1, GNUNET_NO); }\
 388     else {\
 389       if (GN_UNLIKELY(log_call_enabled))\
 390         GNUNET_log_from_nocheck ((kind), comp, __VA_ARGS__);    \
 391     }\
 392   }\
 393 } while (0)
 394
 395  #define GNUNET_log(kind,...) do { int log_line = __LINE__;\
 396   static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
 397   if ((GNUNET_EXTRA_LOGGING > 0) || ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0)) { \
 398     if (GN_UNLIKELY(log_call_enabled == -1))\
 399       log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\
 400     if (GN_UNLIKELY(GNUNET_get_log_skip () > 0)) { GNUNET_log_skip (-1, GNUNET_NO); }\
 401     else {\
 402       if (GN_UNLIKELY(log_call_enabled))\
 403         GNUNET_log_nocheck ((kind), __VA_ARGS__);       \
 404     }\
 405   }\
 406 } while (0)
 407 #else
 408 #define GNUNET_log(...)
 409 #define GNUNET_log_from(...)
 410 #endif
 411
 412
 413 /**
 414  * @ingroup logging
 415  * Log error message about missing configuration option.
 416  *
 417  * @param kind log level
 418  * @param section section with missing option
 419  * @param option name of missing option
 420  */
 421 void
 422 GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
 423                            const char *section,
 424                            const char *option);
 425
 426
 427 /**
 428  * @ingroup logging
 429  * Log error message about invalid configuration option value.
 430  *
 431  * @param kind log level
 432  * @param section section with invalid option
 433  * @param option name of invalid option
 434  * @param required what is required that is invalid about the option
 435  */
 436 void
 437 GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
 438                            const char *section,
 439                            const char *option,
 440                            const char *required);
 441
 442
 443 /**
 444  * @ingroup logging
 445  * Abort the process, generate a core dump if possible.
 446  * Most code should use `GNUNET_assert (0)` instead to
 447  * first log the location of the failure.
 448  */
 449 void
 450 GNUNET_abort_ (void) GNUNET_NORETURN;
 451
 452
 453 /**
 454  * @ingroup logging
 455  * Ignore the next @a n calls to the log function.
 456  *
 457  * @param n number of log calls to ignore (could be negative)
 458  * @param check_reset #GNUNET_YES to assert that the log skip counter is currently zero
 459  */
 460 void
 461 GNUNET_log_skip (int n,
 462                  int check_reset);
 463
 464
 465 /**
 466  * @ingroup logging
 467  * Setup logging.
 468  *
 469  * @param comp default component to use
 470  * @param loglevel what types of messages should be logged
 471  * @param logfile change logging to logfile (use NULL to keep stderr)
 472  * @return #GNUNET_OK on success, #GNUNET_SYSERR if logfile could not be opened
 473  */
 474 int
 475 GNUNET_log_setup (const char *comp,
 476                   const char *loglevel,
 477                   const char *logfile);
 478
 479
 480 /**
 481  * @ingroup logging
 482  * Add a custom logger.
 483  *
 484  * @param logger log function
 485  * @param logger_cls closure for @a logger
 486  */
 487 void
 488 GNUNET_logger_add (GNUNET_Logger logger,
 489                    void *logger_cls);
 490
 491
 492 /**
 493  * @ingroup logging
 494  * Remove a custom logger.
 495  *
 496  * @param logger log function
 497  * @param logger_cls closure for @a logger
 498  */
 499 void
 500 GNUNET_logger_remove (GNUNET_Logger logger,
 501                       void *logger_cls);
 502
 503
 504 /**
 505  * @ingroup logging
 506  * Convert a hash value to a string (for printing debug messages).
 507  * This is one of the very few calls in the entire API that is
 508  * NOT reentrant!
 509  *
 510  * @param hc the hash code
 511  * @return string
 512  */
 513 const char *
 514 GNUNET_h2s (const struct GNUNET_HashCode * hc);
 515
 516
 517 /**
 518  * @ingroup logging
 519  * Convert a hash value to a string (for printing debug messages).
 520  * This prints all 104 characters of a hashcode!
 521  * This is one of the very few calls in the entire API that is
 522  * NOT reentrant!
 523  *
 524  * @param hc the hash code
 525  * @return string
 526  */
 527 const char *
 528 GNUNET_h2s_full (const struct GNUNET_HashCode * hc);
 529
 530
 531 /**
 532  * @ingroup logging
 533  * Convert a peer identity to a string (for printing debug messages).
 534  * This is one of the very few calls in the entire API that is
 535  * NOT reentrant!
 536  *
 537  * @param pid the peer identity
 538  * @return string form of the pid; will be overwritten by next
 539  *         call to #GNUNET_i2s().
 540  */
 541 const char *
 542 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 543
 544
 545 /**
 546  * @ingroup logging
 547  * Convert a peer identity to a string (for printing debug messages).
 548  * This is one of the very few calls in the entire API that is
 549  * NOT reentrant!
 550  *
 551  * @param pid the peer identity
 552  * @return string form of the pid; will be overwritten by next
 553  *         call to #GNUNET_i2s_full().
 554  */
 555 const char *
 556 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
 557
 558
 559 /**
 560  * @ingroup logging
 561  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 562  * (for printing debug messages).  This is one of the very few calls
 563  * in the entire API that is NOT reentrant!
 564  *
 565  * @param addr the address
 566  * @param addrlen the length of the @a addr
 567  * @return nicely formatted string for the address
 568  *  will be overwritten by next call to #GNUNET_a2s().
 569  */
 570 const char *
 571 GNUNET_a2s (const struct sockaddr *addr,
 572             socklen_t addrlen);
 573
 574
 575 /**
 576  * @ingroup logging
 577  * Convert error type to string.
 578  *
 579  * @param kind type to convert
 580  * @return string corresponding to the type
 581  */
 582 const char *
 583 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 584
 585
 586 /**
 587  * @ingroup logging
 588  * Use this for fatal errors that cannot be handled
 589  */
 590 #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)
 591
 592
 593 /**
 594  * @ingroup logging
 595  * Use this for fatal errors that cannot be handled
 596  */
 597 #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)
 598
 599
 600 /**
 601  * @ingroup logging
 602  * Use this for internal assertion violations that are
 603  * not fatal (can be handled) but should not occur.
 604  */
 605 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 606
 607
 608 /**
 609  * @ingroup logging
 610  * Use this for assertion violations caused by other
 611  * peers (i.e. protocol violations).  We do not want to
 612  * confuse end-users (say, some other peer runs an
 613  * older, broken or incompatible GNUnet version), but
 614  * we still want to see these problems during
 615  * development and testing.  "OP == other peer".
 616  */
 617 #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)
 618
 619
 620 /**
 621  * @ingroup logging
 622  * Log an error message at log-level 'level' that indicates
 623  * a failure of the command 'cmd' with the message given
 624  * by strerror(errno).
 625  */
 626 #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)
 627
 628
 629 /**
 630  * @ingroup logging
 631  * Log an error message at log-level 'level' that indicates
 632  * a failure of the command 'cmd' with the message given
 633  * by strerror(errno).
 634  */
 635 #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)
 636
 637
 638 /**
 639  * @ingroup logging
 640  * Log an error message at log-level 'level' that indicates
 641  * a failure of the command 'cmd' with the message given
 642  * by strerror(errno).
 643  */
 644 #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)
 645
 646
 647 /**
 648  * @ingroup logging
 649  * Log an error message at log-level 'level' that indicates
 650  * a failure of the command 'cmd' with the message given
 651  * by strerror(errno).
 652  */
 653 #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)
 654
 655 /* ************************* endianess conversion ****************** */
 656
 657 /**
 658  * Convert unsigned 64-bit integer to network byte order.
 659  *
 660  * @param n
 661  *        The value in host byte order.
 662  *
 663  * @return The same value in network byte order.
 664  */
 665 uint64_t
 666 GNUNET_htonll (uint64_t n);
 667
 668
 669 /**
 670  * Convert unsigned 64-bit integer to host byte order.
 671  *
 672  * @param n
 673  *        The value in network byte order.
 674  *
 675  * @return The same value in host byte order.
 676  */
 677 uint64_t
 678 GNUNET_ntohll (uint64_t n);
 679
 680
 681 /**
 682  * Convert double to network byte order.
 683  *
 684  * @param d
 685  *        The value in network byte order.
 686  *
 687  * @return The same value in host byte order.
 688  */
 689 double
 690 GNUNET_hton_double (double d);
 691
 692
 693 /**
 694  * Convert double to host byte order
 695  *
 696  * @param d
 697  *        The value in network byte order.
 698  *
 699  * @return The same value in host byte order.
 700  */
 701 double
 702 GNUNET_ntoh_double (double d);
 703
 704
 705 /**
 706  * Convert signed 64-bit integer to network byte order.
 707  *
 708  * @param n
 709  *        The value in host byte order.
 710  *
 711  * @return The same value in network byte order.
 712  */
 713 uint64_t
 714 GNUNET_htonll_signed (int64_t n);
 715
 716
 717 /**
 718  * Convert signed 64-bit integer to host byte order.
 719  *
 720  * @param n
 721  *        The value in network byte order.
 722  *
 723  * @return The same value in host byte order.
 724  */
 725 int64_t
 726 GNUNET_ntohll_signed (uint64_t n);
 727
 728
 729 /**
 730  * Convert signed 32-bit integer to network byte order.
 731  *
 732  * @param n
 733  *        The value in host byte order.
 734  *
 735  * @return The same value in network byte order.
 736  */
 737 uint32_t
 738 GNUNET_htonl_signed (int32_t n);
 739
 740
 741 /**
 742  * Convert signed 32-bit integer to host byte order.
 743  *
 744  * @param n
 745  *        The value in network byte order.
 746  *
 747  * @return The same value in host byte order.
 748  */
 749 int32_t
 750 GNUNET_ntohl_signed (uint32_t n);
 751
 752
 753 /**
 754  * Convert signed 16-bit integer to network byte order.
 755  *
 756  * @param n
 757  *        The value in host byte order.
 758  *
 759  * @return The same value in network byte order.
 760  */
 761 uint16_t
 762 GNUNET_htons_signed (int16_t n);
 763
 764
 765 /**
 766  * Convert signed 16-bit integer to host byte order.
 767  *
 768  * @param n
 769  *        The value in network byte order.
 770  *
 771  * @return The same value in host byte order.
 772  */
 773 int16_t
 774 GNUNET_ntohs_signed (uint16_t n);
 775
 776
 777 /* ************************* allocation functions ****************** */
 778
 779 /**
 780  * @ingroup memory
 781  * Maximum allocation with GNUNET_malloc macro.
 782  */
 783 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 784
 785 /**
 786  * @ingroup memory
 787  * Allocate a struct or union of the given @a type.
 788  * Wrapper around #GNUNET_malloc that returns a pointer
 789  * to the newly created object of the correct type.
 790  *
 791  * @param type name of the struct or union, i.e. pass 'struct Foo'.
 792  */
 793 #define GNUNET_new(type) (type *) GNUNET_malloc (sizeof (type))
 794
 795 /**
 796  * @ingroup memory
 797  * Allocate a size @a n array with structs or unions of the given @a type.
 798  * Wrapper around #GNUNET_malloc that returns a pointer
 799  * to the newly created objects of the correct type.
 800  *
 801  * @param n number of elements in the array
 802  * @param type name of the struct or union, i.e. pass 'struct Foo'.
 803  */
 804 #define GNUNET_new_array(n, type) (type *) GNUNET_malloc ((n) * sizeof (type))
 805
 806 /**
 807  * @ingroup memory
 808  * Wrapper around malloc. Allocates size bytes of memory.
 809  * The memory will be zero'ed out.
 810  *
 811  * @param size the number of bytes to allocate, must be
 812  *        smaller than 40 MB.
 813  * @return pointer to size bytes of memory, never NULL (!)
 814  */
 815 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 816
 817 /**
 818  * @ingroup memory
 819  * Allocate and initialize a block of memory.
 820  *
 821  * @param buf data to initalize the block with
 822  * @param size the number of bytes in buf (and size of the allocation)
 823  * @return pointer to size bytes of memory, never NULL (!)
 824  */
 825 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
 826
 827 /**
 828  * @ingroup memory
 829  * Wrapper around malloc. Allocates size bytes of memory.
 830  * The memory will be zero'ed out.
 831  *
 832  * @param size the number of bytes to allocate
 833  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 834  */
 835 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 836
 837 /**
 838  * @ingroup memory
 839  * Wrapper around realloc. Rellocates size bytes of memory.
 840  *
 841  * @param ptr the pointer to reallocate
 842  * @param size the number of bytes to reallocate
 843  * @return pointer to size bytes of memory
 844  */
 845 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 846
 847 /**
 848  * @ingroup memory
 849  * Wrapper around free. Frees the memory referred to by ptr.
 850  * Note that is is generally better to free memory that was
 851  * allocated with #GNUNET_array_grow using #GNUNET_array_grow(mem, size, 0) instead of #GNUNET_free.
 852  *
 853  * @param ptr location where to free the memory. ptr must have
 854  *     been returned by #GNUNET_strdup, #GNUNET_strndup, #GNUNET_malloc or #GNUNET_array_grow earlier.
 855  */
 856 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 857
 858 /**
 859  * @ingroup memory
 860  * Free the memory pointed to by ptr if ptr is not NULL.
 861  * Equivalent to `if (NULL != ptr) GNUNET_free(ptr)`.
 862  *
 863  * @param ptr the location in memory to free
 864  */
 865 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 866
 867 /**
 868  * @ingroup memory
 869  * Wrapper around #GNUNET_xstrdup_.  Makes a copy of the zero-terminated string
 870  * pointed to by a.
 871  *
 872  * @param a pointer to a zero-terminated string
 873  * @return a copy of the string including zero-termination
 874  */
 875 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 876
 877 /**
 878  * @ingroup memory
 879  * Wrapper around #GNUNET_xstrndup_.  Makes a partial copy of the string
 880  * pointed to by a.
 881  *
 882  * @param a pointer to a string
 883  * @param length of the string to duplicate
 884  * @return a partial copy of the string including zero-termination
 885  */
 886 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
 887
 888 /**
 889  * @ingroup memory
 890  * Grow a well-typed (!) array.  This is a convenience
 891  * method to grow a vector @a arr of size @a size
 892  * to the new (target) size @a tsize.
 893  * <p>
 894  *
 895  * Example (simple, well-typed stack):
 896  *
 897  * <pre>
 898  * static struct foo * myVector = NULL;
 899  * static int myVecLen = 0;
 900  *
 901  * static void push(struct foo * elem) {
 902  *   GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
 903  *   memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
 904  * }
 905  *
 906  * static void pop(struct foo * elem) {
 907  *   if (myVecLen == 0) die();
 908  *   memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
 909  *   GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
 910  * }
 911  * </pre>
 912  *
 913  * @param arr base-pointer of the vector, may be NULL if size is 0;
 914  *        will be updated to reflect the new address. The TYPE of
 915  *        arr is important since size is the number of elements and
 916  *        not the size in bytes
 917  * @param size the number of elements in the existing vector (number
 918  *        of elements to copy over)
 919  * @param tsize the target size for the resulting vector, use 0 to
 920  *        free the vector (then, arr will be NULL afterwards).
 921  */
 922 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 923
 924 /**
 925  * @ingroup memory
 926  * Append an element to a list (growing the
 927  * list by one).
 928  */
 929 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 930
 931 /**
 932  * @ingroup memory
 933  * Like snprintf, just aborts if the buffer is of insufficient size.
 934  *
 935  * @param buf pointer to buffer that is written to
 936  * @param size number of bytes in @a buf
 937  * @param format format strings
 938  * @param ... data for format string
 939  * @return number of bytes written to buf or negative value on error
 940  */
 941 int
 942 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 943
 944
 945 /**
 946  * @ingroup memory
 947  * Like asprintf, just portable.
 948  *
 949  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 950  * @param format format string (see printf, fprintf, etc.)
 951  * @param ... data for format string
 952  * @return number of bytes in "*buf" excluding 0-termination
 953  */
 954 int
 955 GNUNET_asprintf (char **buf, const char *format, ...);
 956
 957
 958 /* ************** internal implementations, use macros above! ************** */
 959
 960 /**
 961  * Allocate memory. Checks the return value, aborts if no more
 962  * memory is available.  Don't use GNUNET_xmalloc_ directly. Use the
 963  * #GNUNET_malloc macro.
 964  * The memory will be zero'ed out.
 965  *
 966  * @param size number of bytes to allocate
 967  * @param filename where is this call being made (for debugging)
 968  * @param linenumber line where this call is being made (for debugging)
 969  * @return allocated memory, never NULL
 970  */
 971 void *
 972 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
 973
 974
 975 /**
 976  * Allocate and initialize memory. Checks the return value, aborts if no more
 977  * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
 978  * #GNUNET_memdup macro.
 979  *
 980  * @param buf buffer to initialize from (must contain size bytes)
 981  * @param size number of bytes to allocate
 982  * @param filename where is this call being made (for debugging)
 983  * @param linenumber line where this call is being made (for debugging)
 984  * @return allocated memory, never NULL
 985  */
 986 void *
 987 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
 988                  int linenumber);
 989
 990
 991 /**
 992  * Allocate memory.  This function does not check if the allocation
 993  * request is within reasonable bounds, allowing allocations larger
 994  * than 40 MB.  If you don't expect the possibility of very large
 995  * allocations, use #GNUNET_malloc instead.  The memory will be zero'ed
 996  * out.
 997  *
 998  * @param size number of bytes to allocate
 999  * @param filename where is this call being made (for debugging)
1000  * @param linenumber line where this call is being made (for debugging)
1001  * @return pointer to size bytes of memory, NULL if we do not have enough memory
1002  */
1003 void *
1004 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
1005
1006
1007 /**
1008  * Reallocate memory. Checks the return value, aborts if no more
1009  * memory is available.
1010  */
1011 void *
1012 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
1013
1014
1015 /**
1016  * Free memory. Merely a wrapper for the case that we
1017  * want to keep track of allocations.  Don't use GNUNET_xfree_
1018  * directly. Use the #GNUNET_free macro.
1019  *
1020  * @param ptr pointer to memory to free
1021  * @param filename where is this call being made (for debugging)
1022  * @param linenumber line where this call is being made (for debugging)
1023  */
1024 void
1025 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
1026
1027
1028 /**
1029  * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the #GNUNET_strdup macro.
1030  * @param str string to duplicate
1031  * @param filename where is this call being made (for debugging)
1032  * @param linenumber line where this call is being made (for debugging)
1033  * @return the duplicated string
1034  */
1035 char *
1036 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
1037
1038 /**
1039  * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the #GNUNET_strndup macro.
1040  *
1041  * @param str string to duplicate
1042  * @param len length of the string to duplicate
1043  * @param filename where is this call being made (for debugging)
1044  * @param linenumber line where this call is being made (for debugging)
1045  * @return the duplicated string
1046  */
1047 char *
1048 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
1049                   int linenumber);
1050
1051 /**
1052  * Grow an array, the new elements are zeroed out.
1053  * Grows old by (*oldCount-newCount)*elementSize
1054  * bytes and sets *oldCount to newCount.
1055  *
1056  * Don't call GNUNET_xgrow_ directly. Use the #GNUNET_array_grow macro.
1057  *
1058  * @param old address of the pointer to the array
1059  *        *old may be NULL
1060  * @param elementSize the size of the elements of the array
1061  * @param oldCount address of the number of elements in the *old array
1062  * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
1063  * @param filename where is this call being made (for debugging)
1064  * @param linenumber line where this call is being made (for debugging)
1065  */
1066 void
1067 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
1068                unsigned int newCount, const char *filename, int linenumber);
1069
1070
1071 /**
1072  * @ingroup memory
1073  * Create a copy of the given message.
1074  *
1075  * @param msg message to copy
1076  * @return duplicate of the message
1077  */
1078 struct GNUNET_MessageHeader *
1079 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
1080
1081
1082 #if __STDC_VERSION__ < 199901L
1083 #if __GNUC__ >= 2
1084 #define __func__ __FUNCTION__
1085 #else
1086 #define __func__ "<unknown>"
1087 #endif
1088 #endif
1089
1090
1091 #if 0                           /* keep Emacsens' auto-indent happy */
1092 {
1093 #endif
1094 #ifdef __cplusplus
1095 }
1096 #endif
1097
1098
1099
1100
1101 #endif /*GNUNET_COMMON_H_ */