src/include/gnunet_common.h

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