src/include/gnunet_common.h

   1 /*
   2      This file is part of GNUnet.
   3      (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 /* ****************************** logging ***************************** */
 268
 269 /**
 270  * @ingroup logging
 271  * Types of errors.
 272  */
 273 enum GNUNET_ErrorType
 274 {
 275   GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
 276   GNUNET_ERROR_TYPE_NONE = 0,
 277   GNUNET_ERROR_TYPE_ERROR = 1,
 278   GNUNET_ERROR_TYPE_WARNING = 2,
 279   GNUNET_ERROR_TYPE_INFO = 4,
 280   GNUNET_ERROR_TYPE_DEBUG = 8,
 281   GNUNET_ERROR_TYPE_INVALID = 16,
 282   GNUNET_ERROR_TYPE_BULK = 32
 283 };
 284
 285
 286 /**
 287  * @ingroup logging
 288  * User-defined handler for log messages.
 289  *
 290  * @param cls closure
 291  * @param kind severeity
 292  * @param component what component is issuing the message?
 293  * @param date when was the message logged?
 294  * @param message what is the message
 295  */
 296 typedef void (*GNUNET_Logger) (void *cls,
 297                                enum GNUNET_ErrorType kind,
 298                                const char *component,
 299                                const char *date,
 300                                const char *message);
 301
 302
 303 /**
 304  * @ingroup logging
 305  * Get the number of log calls that are going to be skipped
 306  *
 307  * @return number of log calls to be ignored
 308  */
 309 int
 310 GNUNET_get_log_skip ();
 311
 312 #if !defined(GNUNET_CULL_LOGGING)
 313 int
 314 GNUNET_get_log_call_status (int caller_level,
 315                             const char *comp,
 316                             const char *file,
 317                             const char *function,
 318                             int line);
 319 #endif
 320
 321
 322 /**
 323  * @ingroup logging
 324  * Main log function.
 325  *
 326  * @param kind how serious is the error?
 327  * @param message what is the message (format string)
 328  * @param ... arguments for format string
 329  */
 330 void
 331 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
 332
 333 /* from glib */
 334 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 335 #define _GNUNET_BOOLEAN_EXPR(expr)              \
 336  __extension__ ({                               \
 337    int _gnunet_boolean_var_;                    \
 338    if (expr)                                    \
 339       _gnunet_boolean_var_ = 1;                 \
 340    else                                         \
 341       _gnunet_boolean_var_ = 0;                 \
 342    _gnunet_boolean_var_;                        \
 343 })
 344 #define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1))
 345 #define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0))
 346 #else
 347 #define GN_LIKELY(expr) (expr)
 348 #define GN_UNLIKELY(expr) (expr)
 349 #endif
 350
 351 #if !defined(GNUNET_LOG_CALL_STATUS)
 352 #define GNUNET_LOG_CALL_STATUS -1
 353 #endif
 354
 355
 356 /**
 357  * @ingroup logging
 358  * Log function that specifies an alternative component.
 359  * This function should be used by plugins.
 360  *
 361  * @param kind how serious is the error?
 362  * @param comp component responsible for generating the message
 363  * @param message what is the message (format string)
 364  * @param ... arguments for format string
 365  */
 366 void
 367 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
 368                          const char *message, ...);
 369
 370 #if !defined(GNUNET_CULL_LOGGING)
 371 #define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\
 372   static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
 373   if ((GNUNET_EXTRA_LOGGING > 0) || ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0)) { \
 374     if (GN_UNLIKELY(log_call_enabled == -1))\
 375       log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), (comp), __FILE__, __FUNCTION__, log_line); \
 376     if (GN_UNLIKELY(GNUNET_get_log_skip () > 0)) { GNUNET_log_skip (-1, GNUNET_NO); }\
 377     else {\
 378       if (GN_UNLIKELY(log_call_enabled))\
 379         GNUNET_log_from_nocheck ((kind), comp, __VA_ARGS__);    \
 380     }\
 381   }\
 382 } while (0)
 383
 384  #define GNUNET_log(kind,...) do { int log_line = __LINE__;\
 385   static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
 386   if ((GNUNET_EXTRA_LOGGING > 0) || ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0)) { \
 387     if (GN_UNLIKELY(log_call_enabled == -1))\
 388       log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\
 389     if (GN_UNLIKELY(GNUNET_get_log_skip () > 0)) { GNUNET_log_skip (-1, GNUNET_NO); }\
 390     else {\
 391       if (GN_UNLIKELY(log_call_enabled))\
 392         GNUNET_log_nocheck ((kind), __VA_ARGS__);       \
 393     }\
 394   }\
 395 } while (0)
 396 #else
 397 #define GNUNET_log(...)
 398 #define GNUNET_log_from(...)
 399 #endif
 400
 401
 402 /**
 403  * @ingroup logging
 404  * Log error message about missing configuration option.
 405  *
 406  * @param kind log level
 407  * @param section section with missing option
 408  * @param option name of missing option
 409  */
 410 void
 411 GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
 412                            const char *section,
 413                            const char *option);
 414
 415
 416 /**
 417  * @ingroup logging
 418  * Log error message about invalid configuration option value.
 419  *
 420  * @param kind log level
 421  * @param section section with invalid option
 422  * @param option name of invalid option
 423  * @param required what is required that is invalid about the option
 424  */
 425 void
 426 GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
 427                            const char *section,
 428                            const char *option,
 429                            const char *required);
 430
 431
 432 /**
 433  * @ingroup logging
 434  * Abort the process, generate a core dump if possible.
 435  */
 436 void
 437 GNUNET_abort (void) GNUNET_NORETURN;
 438
 439
 440 /**
 441  * @ingroup logging
 442  * Ignore the next @a n calls to the log function.
 443  *
 444  * @param n number of log calls to ignore (could be negative)
 445  * @param check_reset #GNUNET_YES to assert that the log skip counter is currently zero
 446  */
 447 void
 448 GNUNET_log_skip (int n,
 449                  int check_reset);
 450
 451
 452 /**
 453  * @ingroup logging
 454  * Setup logging.
 455  *
 456  * @param comp default component to use
 457  * @param loglevel what types of messages should be logged
 458  * @param logfile change logging to logfile (use NULL to keep stderr)
 459  * @return #GNUNET_OK on success, #GNUNET_SYSERR if logfile could not be opened
 460  */
 461 int
 462 GNUNET_log_setup (const char *comp,
 463                   const char *loglevel,
 464                   const char *logfile);
 465
 466
 467 /**
 468  * @ingroup logging
 469  * Add a custom logger.
 470  *
 471  * @param logger log function
 472  * @param logger_cls closure for @a logger
 473  */
 474 void
 475 GNUNET_logger_add (GNUNET_Logger logger,
 476                    void *logger_cls);
 477
 478
 479 /**
 480  * @ingroup logging
 481  * Remove a custom logger.
 482  *
 483  * @param logger log function
 484  * @param logger_cls closure for @a logger
 485  */
 486 void
 487 GNUNET_logger_remove (GNUNET_Logger logger,
 488                       void *logger_cls);
 489
 490
 491 /**
 492  * @ingroup logging
 493  * Convert a hash value to a string (for printing debug messages).
 494  * This is one of the very few calls in the entire API that is
 495  * NOT reentrant!
 496  *
 497  * @param hc the hash code
 498  * @return string
 499  */
 500 const char *
 501 GNUNET_h2s (const struct GNUNET_HashCode * hc);
 502
 503
 504 /**
 505  * @ingroup logging
 506  * Convert a hash value to a string (for printing debug messages).
 507  * This prints all 104 characters of a hashcode!
 508  * This is one of the very few calls in the entire API that is
 509  * NOT reentrant!
 510  *
 511  * @param hc the hash code
 512  * @return string
 513  */
 514 const char *
 515 GNUNET_h2s_full (const struct GNUNET_HashCode * hc);
 516
 517
 518 /**
 519  * @ingroup logging
 520  * Convert a peer identity to a string (for printing debug messages).
 521  * This is one of the very few calls in the entire API that is
 522  * NOT reentrant!
 523  *
 524  * @param pid the peer identity
 525  * @return string form of the pid; will be overwritten by next
 526  *         call to #GNUNET_i2s().
 527  */
 528 const char *
 529 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 530
 531
 532 /**
 533  * @ingroup logging
 534  * Convert a peer identity to a string (for printing debug messages).
 535  * This is one of the very few calls in the entire API that is
 536  * NOT reentrant!
 537  *
 538  * @param pid the peer identity
 539  * @return string form of the pid; will be overwritten by next
 540  *         call to #GNUNET_i2s_full().
 541  */
 542 const char *
 543 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
 544
 545
 546 /**
 547  * @ingroup logging
 548  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 549  * (for printing debug messages).  This is one of the very few calls
 550  * in the entire API that is NOT reentrant!
 551  *
 552  * @param addr the address
 553  * @param addrlen the length of the @a addr
 554  * @return nicely formatted string for the address
 555  *  will be overwritten by next call to #GNUNET_a2s().
 556  */
 557 const char *
 558 GNUNET_a2s (const struct sockaddr *addr,
 559             socklen_t addrlen);
 560
 561
 562 /**
 563  * @ingroup logging
 564  * Convert error type to string.
 565  *
 566  * @param kind type to convert
 567  * @return string corresponding to the type
 568  */
 569 const char *
 570 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 571
 572
 573 /**
 574  * @ingroup logging
 575  * Use this for fatal errors that cannot be handled
 576  */
 577 #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)
 578
 579
 580 /**
 581  * @ingroup logging
 582  * Use this for fatal errors that cannot be handled
 583  */
 584 #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)
 585
 586
 587 /**
 588  * @ingroup logging
 589  * Use this for internal assertion violations that are
 590  * not fatal (can be handled) but should not occur.
 591  */
 592 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 593
 594
 595 /**
 596  * @ingroup logging
 597  * Use this for assertion violations caused by other
 598  * peers (i.e. protocol violations).  We do not want to
 599  * confuse end-users (say, some other peer runs an
 600  * older, broken or incompatible GNUnet version), but
 601  * we still want to see these problems during
 602  * development and testing.  "OP == other peer".
 603  */
 604 #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)
 605
 606
 607 /**
 608  * @ingroup logging
 609  * Log an error message at log-level 'level' that indicates
 610  * a failure of the command 'cmd' with the message given
 611  * by strerror(errno).
 612  */
 613 #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)
 614
 615
 616 /**
 617  * @ingroup logging
 618  * Log an error message at log-level 'level' that indicates
 619  * a failure of the command 'cmd' with the message given
 620  * by strerror(errno).
 621  */
 622 #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)
 623
 624
 625 /**
 626  * @ingroup logging
 627  * Log an error message at log-level 'level' that indicates
 628  * a failure of the command 'cmd' with the message given
 629  * by strerror(errno).
 630  */
 631 #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)
 632
 633
 634 /**
 635  * @ingroup logging
 636  * Log an error message at log-level 'level' that indicates
 637  * a failure of the command 'cmd' with the message given
 638  * by strerror(errno).
 639  */
 640 #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)
 641
 642 /* ************************* endianess conversion ****************** */
 643
 644 /**
 645  * Convert unsigned 64-bit integer to host-byte-order.
 646  * @param n the value in network byte order
 647  * @return the same value in host byte order
 648  */
 649 uint64_t
 650 GNUNET_ntohll (uint64_t n);
 651
 652 /**
 653  * Convert unsigned 64-bit integer to network-byte-order.
 654  * @param n the value in host byte order
 655  * @return the same value in network byte order
 656  */
 657 uint64_t
 658 GNUNET_htonll (uint64_t n);
 659
 660 /**
 661  * Convert double to network-byte-order.
 662  * @param d the value in network byte order
 663  * @return the same value in host byte order
 664  */
 665 double
 666 GNUNET_hton_double (double d);
 667
 668 /**
 669  * Convert double to host-byte-order
 670  * @param d the value in network byte order
 671  * @return the same value in host byte order
 672  */
 673 double
 674 GNUNET_ntoh_double (double d);
 675
 676 /* ************************* allocation functions ****************** */
 677
 678 /**
 679  * @ingroup memory
 680  * Maximum allocation with GNUNET_malloc macro.
 681  */
 682 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 683
 684 /**
 685  * @ingroup memory
 686  * Allocate a struct or union of the given @a type.
 687  * Wrapper around #GNUNET_malloc that returns a pointer
 688  * to the newly created object of the correct type.
 689  *
 690  * @param type name of the struct or union, i.e. pass 'struct Foo'.
 691  */
 692 #define GNUNET_new(type) (type *) GNUNET_malloc (sizeof (type))
 693
 694 /**
 695  * @ingroup memory
 696  * Allocate a size @a n array with structs or unions of the given @a type.
 697  * Wrapper around #GNUNET_malloc that returns a pointer
 698  * to the newly created objects of the correct type.
 699  *
 700  * @param n number of elements in the array
 701  * @param type name of the struct or union, i.e. pass 'struct Foo'.
 702  */
 703 #define GNUNET_new_array(n, type) (type *) GNUNET_malloc ((n) * sizeof (type))
 704
 705 /**
 706  * @ingroup memory
 707  * Wrapper around malloc. Allocates size bytes of memory.
 708  * The memory will be zero'ed out.
 709  *
 710  * @param size the number of bytes to allocate, must be
 711  *        smaller than 40 MB.
 712  * @return pointer to size bytes of memory, never NULL (!)
 713  */
 714 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 715
 716 /**
 717  * @ingroup memory
 718  * Allocate and initialize a block of memory.
 719  *
 720  * @param buf data to initalize the block with
 721  * @param size the number of bytes in buf (and size of the allocation)
 722  * @return pointer to size bytes of memory, never NULL (!)
 723  */
 724 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
 725
 726 /**
 727  * @ingroup memory
 728  * Wrapper around malloc. Allocates size bytes of memory.
 729  * The memory will be zero'ed out.
 730  *
 731  * @param size the number of bytes to allocate
 732  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 733  */
 734 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 735
 736 /**
 737  * @ingroup memory
 738  * Wrapper around realloc. Rellocates size bytes of memory.
 739  *
 740  * @param ptr the pointer to reallocate
 741  * @param size the number of bytes to reallocate
 742  * @return pointer to size bytes of memory
 743  */
 744 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 745
 746 /**
 747  * @ingroup memory
 748  * Wrapper around free. Frees the memory referred to by ptr.
 749  * Note that is is generally better to free memory that was
 750  * allocated with #GNUNET_array_grow using #GNUNET_array_grow(mem, size, 0) instead of #GNUNET_free.
 751  *
 752  * @param ptr location where to free the memory. ptr must have
 753  *     been returned by #GNUNET_strdup, #GNUNET_strndup, #GNUNET_malloc or #GNUNET_array_grow earlier.
 754  */
 755 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 756
 757 /**
 758  * @ingroup memory
 759  * Free the memory pointed to by ptr if ptr is not NULL.
 760  * Equivalent to `if (NULL != ptr) GNUNET_free(ptr)`.
 761  *
 762  * @param ptr the location in memory to free
 763  */
 764 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 765
 766 /**
 767  * @ingroup memory
 768  * Wrapper around #GNUNET_xstrdup_.  Makes a copy of the zero-terminated string
 769  * pointed to by a.
 770  *
 771  * @param a pointer to a zero-terminated string
 772  * @return a copy of the string including zero-termination
 773  */
 774 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 775
 776 /**
 777  * @ingroup memory
 778  * Wrapper around #GNUNET_xstrndup_.  Makes a partial copy of the string
 779  * pointed to by a.
 780  *
 781  * @param a pointer to a string
 782  * @param length of the string to duplicate
 783  * @return a partial copy of the string including zero-termination
 784  */
 785 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
 786
 787 /**
 788  * @ingroup memory
 789  * Grow a well-typed (!) array.  This is a convenience
 790  * method to grow a vector @a arr of size @a size
 791  * to the new (target) size @a tsize.
 792  * <p>
 793  *
 794  * Example (simple, well-typed stack):
 795  *
 796  * <pre>
 797  * static struct foo * myVector = NULL;
 798  * static int myVecLen = 0;
 799  *
 800  * static void push(struct foo * elem) {
 801  *   GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
 802  *   memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
 803  * }
 804  *
 805  * static void pop(struct foo * elem) {
 806  *   if (myVecLen == 0) die();
 807  *   memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
 808  *   GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
 809  * }
 810  * </pre>
 811  *
 812  * @param arr base-pointer of the vector, may be NULL if size is 0;
 813  *        will be updated to reflect the new address. The TYPE of
 814  *        arr is important since size is the number of elements and
 815  *        not the size in bytes
 816  * @param size the number of elements in the existing vector (number
 817  *        of elements to copy over)
 818  * @param tsize the target size for the resulting vector, use 0 to
 819  *        free the vector (then, arr will be NULL afterwards).
 820  */
 821 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 822
 823 /**
 824  * @ingroup memory
 825  * Append an element to a list (growing the
 826  * list by one).
 827  */
 828 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 829
 830 /**
 831  * @ingroup memory
 832  * Like snprintf, just aborts if the buffer is of insufficient size.
 833  *
 834  * @param buf pointer to buffer that is written to
 835  * @param size number of bytes in @a buf
 836  * @param format format strings
 837  * @param ... data for format string
 838  * @return number of bytes written to buf or negative value on error
 839  */
 840 int
 841 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 842
 843
 844 /**
 845  * @ingroup memory
 846  * Like asprintf, just portable.
 847  *
 848  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 849  * @param format format string (see printf, fprintf, etc.)
 850  * @param ... data for format string
 851  * @return number of bytes in "*buf" excluding 0-termination
 852  */
 853 int
 854 GNUNET_asprintf (char **buf, const char *format, ...);
 855
 856
 857 /* ************** internal implementations, use macros above! ************** */
 858
 859 /**
 860  * Allocate memory. Checks the return value, aborts if no more
 861  * memory is available.  Don't use GNUNET_xmalloc_ directly. Use the
 862  * #GNUNET_malloc macro.
 863  * The memory will be zero'ed out.
 864  *
 865  * @param size number of bytes to allocate
 866  * @param filename where is this call being made (for debugging)
 867  * @param linenumber line where this call is being made (for debugging)
 868  * @return allocated memory, never NULL
 869  */
 870 void *
 871 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
 872
 873
 874 /**
 875  * Allocate and initialize memory. Checks the return value, aborts if no more
 876  * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
 877  * #GNUNET_memdup macro.
 878  *
 879  * @param buf buffer to initialize from (must contain size bytes)
 880  * @param size number of bytes to allocate
 881  * @param filename where is this call being made (for debugging)
 882  * @param linenumber line where this call is being made (for debugging)
 883  * @return allocated memory, never NULL
 884  */
 885 void *
 886 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
 887                  int linenumber);
 888
 889
 890 /**
 891  * Allocate memory.  This function does not check if the allocation
 892  * request is within reasonable bounds, allowing allocations larger
 893  * than 40 MB.  If you don't expect the possibility of very large
 894  * allocations, use #GNUNET_malloc instead.  The memory will be zero'ed
 895  * out.
 896  *
 897  * @param size number of bytes to allocate
 898  * @param filename where is this call being made (for debugging)
 899  * @param linenumber line where this call is being made (for debugging)
 900  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 901  */
 902 void *
 903 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
 904
 905
 906 /**
 907  * Reallocate memory. Checks the return value, aborts if no more
 908  * memory is available.
 909  */
 910 void *
 911 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
 912
 913
 914 /**
 915  * Free memory. Merely a wrapper for the case that we
 916  * want to keep track of allocations.  Don't use GNUNET_xfree_
 917  * directly. Use the #GNUNET_free macro.
 918  *
 919  * @param ptr pointer to memory to free
 920  * @param filename where is this call being made (for debugging)
 921  * @param linenumber line where this call is being made (for debugging)
 922  */
 923 void
 924 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
 925
 926
 927 /**
 928  * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the #GNUNET_strdup macro.
 929  * @param str string to duplicate
 930  * @param filename where is this call being made (for debugging)
 931  * @param linenumber line where this call is being made (for debugging)
 932  * @return the duplicated string
 933  */
 934 char *
 935 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
 936
 937 /**
 938  * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the #GNUNET_strndup macro.
 939  *
 940  * @param str string to duplicate
 941  * @param len length of the string to duplicate
 942  * @param filename where is this call being made (for debugging)
 943  * @param linenumber line where this call is being made (for debugging)
 944  * @return the duplicated string
 945  */
 946 char *
 947 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
 948                   int linenumber);
 949
 950 /**
 951  * Grow an array, the new elements are zeroed out.
 952  * Grows old by (*oldCount-newCount)*elementSize
 953  * bytes and sets *oldCount to newCount.
 954  *
 955  * Don't call GNUNET_xgrow_ directly. Use the #GNUNET_array_grow macro.
 956  *
 957  * @param old address of the pointer to the array
 958  *        *old may be NULL
 959  * @param elementSize the size of the elements of the array
 960  * @param oldCount address of the number of elements in the *old array
 961  * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
 962  * @param filename where is this call being made (for debugging)
 963  * @param linenumber line where this call is being made (for debugging)
 964  */
 965 void
 966 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
 967                unsigned int newCount, const char *filename, int linenumber);
 968
 969
 970 /**
 971  * @ingroup memory
 972  * Create a copy of the given message.
 973  *
 974  * @param msg message to copy
 975  * @return duplicate of the message
 976  */
 977 struct GNUNET_MessageHeader *
 978 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
 979
 980
 981 #if __STDC_VERSION__ < 199901L
 982 #if __GNUC__ >= 2
 983 #define __func__ __FUNCTION__
 984 #else
 985 #define __func__ "<unknown>"
 986 #endif
 987 #endif
 988
 989
 990 #if 0                           /* keep Emacsens' auto-indent happy */
 991 {
 992 #endif
 993 #ifdef __cplusplus
 994 }
 995 #endif
 996
 997
 998
 999
1000 #endif /*GNUNET_COMMON_H_ */