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