src/include/gnunet_common.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2006, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_common.h
  23  * @brief commonly used definitions; globals in this file
  24  *        are exempt from the rule that the module name ("common")
  25  *        must be part of the symbol name.
  26  *
  27  * @author Christian Grothoff
  28  * @author Nils Durner
  29  */
  30 #ifndef GNUNET_COMMON_H
  31 #define GNUNET_COMMON_H
  32
  33 #if HAVE_SYS_SOCKET_H
  34 #include <sys/socket.h>
  35 #endif
  36 #if HAVE_NETINET_IN_H
  37 #include <netinet/in.h>
  38 #endif
  39 #ifdef MINGW
  40 #include "winproc.h"
  41 #endif
  42 #ifdef HAVE_STDINT_H
  43 #include <stdint.h>
  44 #endif
  45 #ifdef HAVE_STDARG_H
  46 #include <stdarg.h>
  47 #endif
  48
  49 /**
  50  * Version of the API (for entire gnunetutil.so library).
  51  */
  52 #define GNUNET_UTIL_VERSION 0x00089900
  53
  54 /**
  55  * Name used for "services" that are actually command-line
  56  * programs invoked by the end user.
  57  */
  58 #define GNUNET_CLIENT_SERVICE_NAME "client"
  59
  60 /**
  61  * Named constants for return values.  The following
  62  * invariants hold: "GNUNET_NO == 0" (to allow "if (GNUNET_NO)")
  63  * "GNUNET_OK != GNUNET_SYSERR", "GNUNET_OK != GNUNET_NO", "GNUNET_NO != GNUNET_SYSERR"
  64  * and finally "GNUNET_YES != GNUNET_NO".
  65  */
  66 #define GNUNET_OK      1
  67 #define GNUNET_SYSERR -1
  68 #define GNUNET_YES     1
  69 #define GNUNET_NO      0
  70
  71 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
  72
  73 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
  74
  75 /**
  76  * gcc-ism to get packed structs.
  77  */
  78 #define GNUNET_PACKED __attribute__((packed))
  79
  80
  81 /* ************************ super-general types *********************** */
  82
  83 /**
  84  * Header for all communications.
  85  */
  86 struct GNUNET_MessageHeader
  87 {
  88
  89   /**
  90    * The length of the struct (in bytes, including the length field itself),
  91    * in big-endian format.
  92    */
  93   uint16_t size GNUNET_PACKED;
  94
  95   /**
  96    * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
  97    */
  98   uint16_t type GNUNET_PACKED;
  99
 100 };
 101
 102
 103 /**
 104  * @brief 512-bit hashcode
 105  */
 106 typedef struct
 107 {
 108   uint32_t bits[512 / 8 / sizeof (uint32_t)];   /* = 16 */
 109 }
 110 GNUNET_HashCode;
 111
 112
 113 /**
 114  * The identity of the host (basically the SHA-512 hashcode of
 115  * it's public key).
 116  */
 117 struct GNUNET_PeerIdentity
 118 {
 119   GNUNET_HashCode hashPubKey GNUNET_PACKED;
 120 };
 121
 122
 123 /**
 124  * Function called with a filename.
 125  *
 126  * @param cls closure
 127  * @param filename complete filename (absolute path)
 128  * @return GNUNET_OK to continue to iterate,
 129  *  GNUNET_SYSERR to abort iteration with error!
 130  */
 131 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
 132
 133
 134 /* ****************************** logging ***************************** */
 135
 136 /**
 137  * Types of errors.
 138  */
 139 enum GNUNET_ErrorType
 140 {
 141   GNUNET_ERROR_TYPE_NONE = 0,
 142   GNUNET_ERROR_TYPE_ERROR = 1,
 143   GNUNET_ERROR_TYPE_WARNING = 2,
 144   GNUNET_ERROR_TYPE_INFO = 4,
 145   GNUNET_ERROR_TYPE_DEBUG = 8,
 146   GNUNET_ERROR_TYPE_INVALID = 16,
 147   GNUNET_ERROR_TYPE_BULK = 32
 148 };
 149
 150
 151 /**
 152  * User-defined handler for log messages.
 153  *
 154  * @param cls closure
 155  * @param kind severeity
 156  * @param component what component is issuing the message?
 157  * @param date when was the message logged?
 158  * @param message what is the message
 159  */
 160 typedef void (*GNUNET_Logger) (void *cls,
 161                                enum GNUNET_ErrorType kind,
 162                                const char *component,
 163                                const char *date, const char *message);
 164
 165 /**
 166  * Main log function.
 167  *
 168  * @param kind how serious is the error?
 169  * @param message what is the message (format string)
 170  * @param ... arguments for format string
 171  */
 172 void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...);
 173
 174
 175
 176 /**
 177  * Log function that specifies an alternative component.
 178  * This function should be used by plugins.
 179  *
 180  * @param kind how serious is the error?
 181  * @param comp component responsible for generating the message
 182  * @param message what is the message (format string)
 183  * @param ... arguments for format string
 184  */
 185 void
 186 GNUNET_log_from (enum GNUNET_ErrorType kind,
 187                  const char *comp, const char *message, ...);
 188
 189
 190 /**
 191  * Ignore the next n calls to the log function.
 192  *
 193  * @param n number of log calls to ignore
 194  * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
 195  */
 196 void GNUNET_log_skip (unsigned int n, int check_reset);
 197
 198
 199 /**
 200  * Setup logging.
 201  *
 202  * @param comp default component to use
 203  * @param loglevel what types of messages should be logged
 204  * @param logfile change logging to logfile (use NULL to keep stderr)
 205  * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
 206  */
 207 int
 208 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
 209
 210
 211 /**
 212  * Add a custom logger.
 213  *
 214  * @param logger log function
 215  * @param logger_cls closure for logger
 216  */
 217 void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
 218
 219
 220 /**
 221  * Remove a custom logger.
 222  *
 223  * @param logger log function
 224  * @param logger_cls closure for logger
 225  */
 226 void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
 227
 228
 229 /**
 230  * Convert a hash value to a string (for printing debug messages).
 231  * This is one of the very few calls in the entire API that is
 232  * NOT reentrant!
 233  *
 234  * @param hc the hash code
 235  * @return string
 236  */
 237 const char *GNUNET_h2s (const GNUNET_HashCode * hc);
 238
 239
 240 /**
 241  * Convert a hash value to a string (for printing debug messages).
 242  * This prints all 104 characters of a hashcode!
 243  * This is one of the very few calls in the entire API that is
 244  * NOT reentrant!
 245  *
 246  * @param hc the hash code
 247  * @return string
 248  */
 249 const char *GNUNET_h2s_full (const GNUNET_HashCode * hc);
 250
 251
 252 /**
 253  * Convert a peer identity to a string (for printing debug messages).
 254  * This is one of the very few calls in the entire API that is
 255  * NOT reentrant!
 256  *
 257  * @param pid the peer identity
 258  * @return string form of the pid; will be overwritten by next
 259  *         call to GNUNET_i2s.
 260  */
 261 const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 262
 263
 264 /**
 265  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 266  * (for printing debug messages).  This is one of the very few calls
 267  * in the entire API that is NOT reentrant!
 268  *
 269  * @param addr the address
 270  * @param addrlen the length of the address
 271  * @return nicely formatted string for the address
 272  *  will be overwritten by next call to GNUNET_a2s.
 273  */
 274 const char *GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
 275
 276 /**
 277  * Convert error type to string.
 278  *
 279  * @param kind type to convert
 280  * @return string corresponding to the type
 281  */
 282 const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 283
 284
 285 /**
 286  * Use this for fatal errors that cannot be handled
 287  */
 288 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); abort(); } } while(0)
 289
 290 /**
 291  * Use this for fatal errors that cannot be handled
 292  */
 293 #define GNUNET_assert_at(cond, f, l) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), f, l); abort(); } } while(0)
 294
 295 /**
 296  * Use this for internal assertion violations that are
 297  * not fatal (can be handled) but should not occur.
 298  */
 299 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 300
 301 /**
 302  * Use this for assertion violations caused by other
 303  * peers (i.e. protocol violations).  We do not want to
 304  * confuse end-users (say, some other peer runs an
 305  * older, broken or incompatible GNUnet version), but
 306  * we still want to see these problems during
 307  * development and testing.  "OP == other peer".
 308  */
 309 #define GNUNET_break_op(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_WARNING, _("External protocol violation detected at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 310
 311 /**
 312  * Log an error message at log-level 'level' that indicates
 313  * a failure of the command 'cmd' with the message given
 314  * by strerror(errno).
 315  */
 316 #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)
 317
 318 /**
 319  * Log an error message at log-level 'level' that indicates
 320  * a failure of the command 'cmd' with the message given
 321  * by strerror(errno).
 322  */
 323 #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)
 324
 325 /* ************************* endianess conversion ****************** */
 326
 327 /**
 328  * Convert a long-long to host-byte-order.
 329  * @param n the value in network byte order
 330  * @return the same value in host byte order
 331  */
 332 unsigned long long GNUNET_ntohll (unsigned long long n);
 333
 334 /**
 335  * Convert a long long to network-byte-order.
 336  * @param n the value in host byte order
 337  * @return the same value in network byte order
 338  */
 339 unsigned long long GNUNET_htonll (unsigned long long n);
 340
 341
 342 /* ************************* allocation functions ****************** */
 343
 344 /**
 345  * Maximum allocation with GNUNET_malloc macro.
 346  */
 347 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 348
 349 /**
 350  * Wrapper around malloc. Allocates size bytes of memory.
 351  * The memory will be zero'ed out.
 352  *
 353  * @param size the number of bytes to allocate, must be
 354  *        smaller than 40 MB.
 355  * @return pointer to size bytes of memory, never NULL (!)
 356  */
 357 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 358
 359 /**
 360  * Allocate and initialize a block of memory.
 361  *
 362  * @param buf data to initalize the block with
 363  * @param size the number of bytes in buf (and size of the allocation)
 364  * @return pointer to size bytes of memory, never NULL (!)
 365  */
 366 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
 367
 368 /**
 369  * Wrapper around malloc. Allocates size bytes of memory.
 370  * The memory will be zero'ed out.
 371  *
 372  * @param size the number of bytes to allocate
 373  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 374  */
 375 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 376
 377 /**
 378  * Wrapper around realloc. Rellocates size bytes of memory.
 379  *
 380  * @param ptr the pointer to reallocate
 381  * @param size the number of bytes to reallocate
 382  * @return pointer to size bytes of memory
 383  */
 384 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 385
 386 /**
 387  * Wrapper around free. Frees the memory referred to by ptr.
 388  * Note that is is generally better to free memory that was
 389  * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
 390  *
 391  * @param ptr location where to free the memory. ptr must have
 392  *     been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
 393  */
 394 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 395
 396 /**
 397  * Free the memory pointed to by ptr if ptr is not NULL.
 398  * Equivalent to if (ptr!=null)GNUNET_free(ptr).
 399  *
 400  * @param ptr the location in memory to free
 401  */
 402 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 403
 404 /**
 405  * Wrapper around GNUNET_strdup.  Makes a copy of the zero-terminated string
 406  * pointed to by a.
 407  *
 408  * @param a pointer to a zero-terminated string
 409  * @return a copy of the string including zero-termination
 410  */
 411 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 412
 413 /**
 414  * Wrapper around GNUNET_strndup.  Makes a partial copy of the string
 415  * pointed to by a.
 416  *
 417  * @param a pointer to a string
 418  * @param length of the string to duplicate
 419  * @return a partial copy of the string including zero-termination
 420  */
 421 #define GNUNET_strndup(a,b) GNUNET_xstrndup_(a,b,__FILE__,__LINE__)
 422
 423 /**
 424  * Grow a well-typed (!) array.  This is a convenience
 425  * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
 426  * to the new (target) size <tt>tsize</tt>.
 427  * <p>
 428  *
 429  * Example (simple, well-typed stack):
 430  *
 431  * <pre>
 432  * static struct foo * myVector = NULL;
 433  * static int myVecLen = 0;
 434  *
 435  * static void push(struct foo * elem) {
 436  *   GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
 437  *   memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
 438  * }
 439  *
 440  * static void pop(struct foo * elem) {
 441  *   if (myVecLen == 0) die();
 442  *   memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
 443  *   GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
 444  * }
 445  * </pre>
 446  *
 447  * @param arr base-pointer of the vector, may be NULL if size is 0;
 448  *        will be updated to reflect the new address. The TYPE of
 449  *        arr is important since size is the number of elements and
 450  *        not the size in bytes
 451  * @param size the number of elements in the existing vector (number
 452  *        of elements to copy over)
 453  * @param tsize the target size for the resulting vector, use 0 to
 454  *        free the vector (then, arr will be NULL afterwards).
 455  */
 456 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 457
 458 /**
 459  * Append an element to a list (growing the
 460  * list by one).
 461  */
 462 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 463
 464 /**
 465  * Like snprintf, just aborts if the buffer is of insufficient size.
 466  *
 467  * @param buf pointer to buffer that is written to
 468  * @param size number of bytes in buf
 469  * @param format format strings
 470  * @param ... data for format string
 471  * @return number of bytes written to buf or negative value on error
 472  */
 473 int GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 474
 475
 476 /**
 477  * Like asprintf, just portable.
 478  *
 479  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 480  * @param format format string (see printf, fprintf, etc.)
 481  * @param ... data for format string
 482  * @return number of bytes in "*buf" excluding 0-termination
 483  */
 484 int GNUNET_asprintf (char **buf, const char *format, ...);
 485
 486
 487 /* ************** internal implementations, use macros above! ************** */
 488
 489 /**
 490  * Allocate memory. Checks the return value, aborts if no more
 491  * memory is available.  Don't use GNUNET_xmalloc_ directly. Use the
 492  * GNUNET_malloc macro.
 493  * The memory will be zero'ed out.
 494  *
 495  * @param size number of bytes to allocate
 496  * @param filename where is this call being made (for debugging)
 497  * @param linenumber line where this call is being made (for debugging)
 498  * @return allocated memory, never NULL
 499  */
 500 void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
 501
 502
 503
 504 /**
 505  * Allocate and initialize memory. Checks the return value, aborts if no more
 506  * memory is available.  Don't use GNUNET_xmemdup_ directly. Use the
 507  * GNUNET_memdup macro.
 508  *
 509  * @param buf buffer to initialize from (must contain size bytes)
 510  * @param size number of bytes to allocate
 511  * @param filename where is this call being made (for debugging)
 512  * @param linenumber line where this call is being made (for debugging)
 513  * @return allocated memory, never NULL
 514  */
 515 void *GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
 516                        int linenumber);
 517
 518
 519 /**
 520  * Allocate memory.  This function does not check if the allocation
 521  * request is within reasonable bounds, allowing allocations larger
 522  * than 40 MB.  If you don't expect the possibility of very large
 523  * allocations, use GNUNET_malloc instead.  The memory will be zero'ed
 524  * out.
 525  *
 526  * @param size number of bytes to allocate
 527  * @param filename where is this call being made (for debugging)
 528  * @param linenumber line where this call is being made (for debugging)
 529  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 530  */
 531 void *GNUNET_xmalloc_unchecked_ (size_t size,
 532                                  const char *filename, int linenumber);
 533
 534 /**
 535  * Reallocate memory. Checks the return value, aborts if no more
 536  * memory is available.
 537  */
 538 void *GNUNET_xrealloc_ (void *ptr,
 539                         size_t n, const char *filename, int linenumber);
 540
 541 /**
 542  * Free memory. Merely a wrapper for the case that we
 543  * want to keep track of allocations.  Don't use GNUNET_xfree_
 544  * directly. Use the GNUNET_free macro.
 545  *
 546  * @param ptr pointer to memory to free
 547  * @param filename where is this call being made (for debugging)
 548  * @param linenumber line where this call is being made (for debugging)
 549  */
 550 void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
 551
 552
 553 /**
 554  * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
 555  * @param str string to duplicate
 556  * @param filename where is this call being made (for debugging)
 557  * @param linenumber line where this call is being made (for debugging)
 558  * @return the duplicated string
 559  */
 560 char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
 561
 562 /**
 563  * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
 564  * @param str string to duplicate
 565  * @param len lenght of the string to duplicate
 566  * @param filename where is this call being made (for debugging)
 567  * @param linenumber line where this call is being made (for debugging)
 568  * @return the duplicated string
 569  */
 570 char *GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
 571                         int linenumber);
 572
 573 /**
 574  * Grow an array, the new elements are zeroed out.
 575  * Grows old by (*oldCount-newCount)*elementSize
 576  * bytes and sets *oldCount to newCount.
 577  *
 578  * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
 579  *
 580  * @param old address of the pointer to the array
 581  *        *old may be NULL
 582  * @param elementSize the size of the elements of the array
 583  * @param oldCount address of the number of elements in the *old array
 584  * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
 585  * @param filename where is this call being made (for debugging)
 586  * @param linenumber line where this call is being made (for debugging)
 587  */
 588 void GNUNET_xgrow_ (void **old,
 589                     size_t elementSize,
 590                     unsigned int *oldCount,
 591                     unsigned int newCount,
 592                     const char *filename, int linenumber);
 593
 594
 595
 596
 597 #if __STDC_VERSION__ < 199901L
 598 #if __GNUC__ >= 2
 599 #define __func__ __FUNCTION__
 600 #else
 601 #define __func__ "<unknown>"
 602 #endif
 603 #endif
 604
 605 #endif /*GNUNET_COMMON_H_ */