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