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