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