src/include/gnunet_common.h

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