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 0x00000000
  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  * User-defined handler for log messages.
 152  *
 153  * @param cls closure
 154  * @param kind severeity
 155  * @param component what component is issuing the message?
 156  * @param date when was the message logged?
 157  * @param message what is the message
 158  */
 159 typedef void (*GNUNET_Logger) (void *cls,
 160                                enum GNUNET_ErrorType kind,
 161                                const char *component,
 162                                const char *date, const char *message);
 163
 164 /**
 165  * Main log function.
 166  *
 167  * @param kind how serious is the error?
 168  * @param message what is the message (format string)
 169  * @param ... arguments for format string
 170  */
 171 void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...);
 172
 173
 174
 175 /**
 176  * Log function that specifies an alternative component.
 177  * This function should be used by plugins.
 178  *
 179  * @param kind how serious is the error?
 180  * @param comp component responsible for generating the message
 181  * @param message what is the message (format string)
 182  * @param ... arguments for format string
 183  */
 184 void
 185 GNUNET_log_from (enum GNUNET_ErrorType kind,
 186                  const char *comp, const char *message, ...);
 187
 188
 189 /**
 190  * Ignore the next n calls to the log function.
 191  *
 192  * @param n number of log calls to ignore
 193  * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
 194  */
 195 void
 196 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,
 209                   const char *loglevel, const char *logfile);
 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  * Remove a custom logger.
 221  *
 222  * @param logger log function
 223  * @param logger_cls closure for logger
 224  */
 225 void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
 226
 227
 228 /**
 229  * Convert a hash value to a string (for printing debug messages).
 230  * This is one of the very few calls in the entire API that is
 231  * NOT reentrant!
 232  *
 233  * @param hc the hash code
 234  * @return string
 235  */
 236 const char *GNUNET_h2s (const GNUNET_HashCode *hc);
 237
 238 /**
 239  * Convert a hash value to a string (for printing debug messages).
 240  * This prints all 104 characters of a hashcode!
 241  * This is one of the very few calls in the entire API that is
 242  * NOT reentrant!
 243  *
 244  * @param hc the hash code
 245  * @return string
 246  */
 247 const char *GNUNET_h2s_full (const GNUNET_HashCode *hc);
 248
 249 /**
 250  * Convert a peer identity to a string (for printing debug messages).
 251  * This is one of the very few calls in the entire API that is
 252  * NOT reentrant!
 253  *
 254  * @param pid the peer identity
 255  * @return string form of the pid; will be overwritten by next
 256  *         call to GNUNET_i2s.
 257  */
 258 const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
 259
 260
 261 /**
 262  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 263  * (for printing debug messages).  This is one of the very few calls
 264  * in the entire API that is NOT reentrant!
 265  *
 266  * @param addr the address
 267  * @param addrlen the length of the address
 268  * @return nicely formatted string for the address
 269  *  will be overwritten by next call to GNUNET_a2s.
 270  */
 271 const char *GNUNET_a2s (const struct sockaddr *addr,
 272                         socklen_t addrlen);
 273
 274 /**
 275  * Convert error type to string.
 276  *
 277  * @param kind type to convert
 278  * @return string corresponding to the type
 279  */
 280 const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
 281
 282 /**
 283  * Use this for fatal errors that cannot be handled
 284  */
 285 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); abort(); } } while(0)
 286
 287 /**
 288  * Use this for fatal errors that cannot be handled
 289  */
 290 #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)
 291
 292 /**
 293  * Use this for internal assertion violations that are
 294  * not fatal (can be handled) but should not occur.
 295  */
 296 #define GNUNET_break(cond)  do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
 297
 298 /**
 299  * Use this for assertion violations caused by other
 300  * peers (i.e. protocol violations).  We do not want to
 301  * confuse end-users (say, some other peer runs an
 302  * older, broken or incompatible GNUnet version), but
 303  * we still want to see these problems during
 304  * development and testing.  "OP == other peer".
 305  */
 306 #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)
 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(level, cmd) do { GNUNET_log(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
 314
 315 /**
 316  * Log an error message at log-level 'level' that indicates
 317  * a failure of the command 'cmd' with the message given
 318  * by strerror(errno).
 319  */
 320 #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)
 321
 322 /* ************************* endianess conversion ****************** */
 323
 324 /**
 325  * Convert a long-long to host-byte-order.
 326  * @param n the value in network byte order
 327  * @return the same value in host byte order
 328  */
 329 unsigned long long GNUNET_ntohll (unsigned long long n);
 330
 331 /**
 332  * Convert a long long to network-byte-order.
 333  * @param n the value in host byte order
 334  * @return the same value in network byte order
 335  */
 336 unsigned long long GNUNET_htonll (unsigned long long n);
 337
 338
 339 /* ************************* allocation functions ****************** */
 340
 341 /**
 342  * Maximum allocation with GNUNET_malloc macro.
 343  */
 344 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
 345
 346 /**
 347  * Wrapper around malloc. Allocates size bytes of memory.
 348  * The memory will be zero'ed out.
 349  *
 350  * @param size the number of bytes to allocate, must be
 351  *        smaller than 40 MB.
 352  * @return pointer to size bytes of memory, never NULL (!)
 353  */
 354 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
 355
 356 /**
 357  * Wrapper around malloc. Allocates size bytes of memory.
 358  * The memory will be zero'ed out.
 359  *
 360  * @param size the number of bytes to allocate
 361  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 362  */
 363 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
 364
 365 /**
 366  * Wrapper around realloc. Rellocates size bytes of memory.
 367  *
 368  * @param ptr the pointer to reallocate
 369  * @param size the number of bytes to reallocate
 370  * @return pointer to size bytes of memory
 371  */
 372 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
 373
 374 /**
 375  * Wrapper around free. Frees the memory referred to by ptr.
 376  * Note that is is generally better to free memory that was
 377  * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
 378  *
 379  * @param ptr location where to free the memory. ptr must have
 380  *     been returned by GNUNET_strdup, GNUNET_malloc or GNUNET_array_grow earlier.
 381  */
 382 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
 383
 384 /**
 385  * Free the memory pointed to by ptr if ptr is not NULL.
 386  * Equivalent to if (ptr!=null)GNUNET_free(ptr).
 387  *
 388  * @param ptr the location in memory to free
 389  */
 390 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
 391
 392 /**
 393  * Wrapper around GNUNET_strdup.  Makes a copy of the zero-terminated string
 394  * pointed to by a.
 395  *
 396  * @param a pointer to a zero-terminated string
 397  * @return a copy of the string including zero-termination
 398  */
 399 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
 400
 401 /**
 402  * Grow a well-typed (!) array.  This is a convenience
 403  * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
 404  * to the new (target) size <tt>tsize</tt>.
 405  * <p>
 406  *
 407  * Example (simple, well-typed stack):
 408  *
 409  * <pre>
 410  * static struct foo * myVector = NULL;
 411  * static int myVecLen = 0;
 412  *
 413  * static void push(struct foo * elem) {
 414  *   GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
 415  *   memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
 416  * }
 417  *
 418  * static void pop(struct foo * elem) {
 419  *   if (myVecLen == 0) die();
 420  *   memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
 421  *   GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
 422  * }
 423  * </pre>
 424  *
 425  * @param arr base-pointer of the vector, may be NULL if size is 0;
 426  *        will be updated to reflect the new address. The TYPE of
 427  *        arr is important since size is the number of elements and
 428  *        not the size in bytes
 429  * @param size the number of elements in the existing vector (number
 430  *        of elements to copy over)
 431  * @param tsize the target size for the resulting vector, use 0 to
 432  *        free the vector (then, arr will be NULL afterwards).
 433  */
 434 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
 435
 436 /**
 437  * Append an element to a list (growing the
 438  * list by one).
 439  */
 440 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
 441
 442 /**
 443  * Like snprintf, just aborts if the buffer is of insufficient size.
 444  *
 445  * @param buf pointer to buffer that is written to
 446  * @param size number of bytes in buf
 447  * @param format format strings
 448  * @param ... data for format string
 449  * @return number of bytes written to buf or negative value on error
 450  */
 451 int GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
 452
 453
 454 /**
 455  * Like asprintf, just portable.
 456  *
 457  * @param buf set to a buffer of sufficient size (allocated, caller must free)
 458  * @param format format string (see printf, fprintf, etc.)
 459  * @param ... data for format string
 460  * @return number of bytes in "*buf" excluding 0-termination
 461  */
 462 int GNUNET_asprintf (char **buf, const char *format, ...);
 463
 464
 465 /* ************** internal implementations, use macros above! ************** */
 466
 467 /**
 468  * Allocate memory. Checks the return value, aborts if no more
 469  * memory is available.  Don't use GNUNET_xmalloc_ directly. Use the
 470  * GNUNET_malloc macro.
 471  * The memory will be zero'ed out.
 472  *
 473  * @param size number of bytes to allocate
 474  * @param filename where is this call being made (for debugging)
 475  * @param linenumber line where this call is being made (for debugging)
 476  * @return allocated memory, never NULL
 477  */
 478 void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
 479
 480
 481 /**
 482  * Allocate memory.  This function does not check if the allocation
 483  * request is within reasonable bounds, allowing allocations larger
 484  * than 40 MB.  If you don't expect the possibility of very large
 485  * allocations, use GNUNET_malloc instead.  The memory will be zero'ed
 486  * out.
 487  *
 488  * @param size number of bytes to allocate
 489  * @param filename where is this call being made (for debugging)
 490  * @param linenumber line where this call is being made (for debugging)
 491  * @return pointer to size bytes of memory, NULL if we do not have enough memory
 492  */
 493 void *GNUNET_xmalloc_unchecked_ (size_t size,
 494                                  const char *filename, int linenumber);
 495
 496 /**
 497  * Reallocate memory. Checks the return value, aborts if no more
 498  * memory is available.
 499  */
 500 void *GNUNET_xrealloc_ (void *ptr,
 501                         size_t n, const char *filename, int linenumber);
 502
 503 /**
 504  * Free memory. Merely a wrapper for the case that we
 505  * want to keep track of allocations.  Don't use GNUNET_xfree_
 506  * directly. Use the GNUNET_free macro.
 507  *
 508  * @param ptr pointer to memory to free
 509  * @param filename where is this call being made (for debugging)
 510  * @param linenumber line where this call is being made (for debugging)
 511  */
 512 void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
 513
 514
 515 /**
 516  * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
 517  * @param str string to duplicate
 518  * @param filename where is this call being made (for debugging)
 519  * @param linenumber line where this call is being made (for debugging)
 520  * @return the duplicated string
 521  */
 522 char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
 523
 524 /**
 525  * Grow an array, the new elements are zeroed out.
 526  * Grows old by (*oldCount-newCount)*elementSize
 527  * bytes and sets *oldCount to newCount.
 528  *
 529  * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
 530  *
 531  * @param old address of the pointer to the array
 532  *        *old may be NULL
 533  * @param elementSize the size of the elements of the array
 534  * @param oldCount address of the number of elements in the *old array
 535  * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
 536  * @param filename where is this call being made (for debugging)
 537  * @param linenumber line where this call is being made (for debugging)
 538  */
 539 void GNUNET_xgrow_ (void **old,
 540                     size_t elementSize,
 541                     unsigned int *oldCount,
 542                     unsigned int newCount,
 543                     const char *filename, int linenumber);
 544
 545
 546
 547
 548 #if __STDC_VERSION__ < 199901L
 549 # if __GNUC__ >= 2
 550 #  define __func__ __FUNCTION__
 551 # else
 552 #  define __func__ "<unknown>"
 553 # endif
 554 #endif
 555
 556 #endif /*GNUNET_COMMON_H_ */