2 This file is part of GNUnet.
3 (C) 2006, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
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.
27 * @author Christian Grothoff
30 #ifndef GNUNET_COMMON_H
31 #define GNUNET_COMMON_H
34 #include <sys/socket.h>
37 #include <netinet/in.h>
50 * Version of the API (for entire gnunetutil.so library).
52 #define GNUNET_UTIL_VERSION 0x00090100
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".
61 #define GNUNET_SYSERR -1
65 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
67 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
73 # if __BYTE_ORDER == __LITTLE_ENDIAN
74 # define GNUNET_htobe16(x) __bswap_16 (x)
75 # define GNUNET_htole16(x) (x)
76 # define GNUNET_be16toh(x) __bswap_16 (x)
77 # define GNUNET_le16toh(x) (x)
79 # define GNUNET_htobe32(x) __bswap_32 (x)
80 # define GNUNET_htole32(x) (x)
81 # define GNUNET_be32toh(x) __bswap_32 (x)
82 # define GNUNET_le32toh(x) (x)
84 # define GNUNET_htobe64(x) __bswap_64 (x)
85 # define GNUNET_htole64(x) (x)
86 # define GNUNET_be64toh(x) __bswap_64 (x)
87 # define GNUNET_le64toh(x) (x)
89 # if __BYTE_ORDER == __BIG_ENDIAN
90 # define GNUNET_htobe16(x) (x)
91 # define GNUNET_htole16(x) __bswap_16 (x)
92 # define GNUNET_be16toh(x) (x)
93 # define GNUNET_le16toh(x) __bswap_16 (x)
95 # define GNUNET_htobe32(x) (x)
96 # define GNUNET_htole32(x) __bswap_32 (x)
97 # define GNUNET_be32toh(x) (x)
98 # define GNUNET_le32toh(x) __bswap_32 (x)
100 # define GNUNET_htobe64(x) (x)
101 # define GNUNET_htole64(x) __bswap_64 (x)
102 # define GNUNET_be64toh(x) (x)
103 # define GNUNET_le64toh(x) __bswap_64 (x)
110 * gcc-ism to get packed structs.
112 #define GNUNET_PACKED __attribute__((packed))
115 * gcc-ism to document unused arguments
117 #define GNUNET_UNUSED __attribute__((unused))
120 * gcc-ism to document functions that don't return
122 #define GNUNET_NORETURN __attribute__((noreturn))
126 * gcc 4.x-ism to pack structures even on W32 (to be used before structs)
128 #define GNUNET_NETWORK_STRUCT_BEGIN \
129 _Pragma("pack(push)") \
133 * gcc 4.x-ism to pack structures even on W32 (to be used after structs)
135 #define GNUNET_NETWORK_STRUCT_END _Pragma("pack(pop)")
138 #error gcc 4.x or higher required on W32 systems
141 * Good luck, GNUNET_PACKED should suffice, but this won't work on W32
143 #define GNUNET_NETWORK_STRUCT_BEGIN
146 * Good luck, GNUNET_PACKED should suffice, but this won't work on W32
148 #define GNUNET_NETWORK_STRUCT_END
151 /* ************************ super-general types *********************** */
153 GNUNET_NETWORK_STRUCT_BEGIN
156 * Header for all communications.
158 struct GNUNET_MessageHeader
162 * The length of the struct (in bytes, including the length field itself),
163 * in big-endian format.
165 uint16_t size GNUNET_PACKED;
168 * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
170 uint16_t type GNUNET_PACKED;
173 GNUNET_NETWORK_STRUCT_END
176 * @brief 512-bit hashcode
180 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
185 GNUNET_NETWORK_STRUCT_BEGIN
188 * The identity of the host (basically the SHA-512 hashcode of
191 struct GNUNET_PeerIdentity
193 GNUNET_HashCode hashPubKey GNUNET_PACKED;
195 GNUNET_NETWORK_STRUCT_END
198 * Function called with a filename.
201 * @param filename complete filename (absolute path)
202 * @return GNUNET_OK to continue to iterate,
203 * GNUNET_SYSERR to abort iteration with error!
205 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
208 /* ****************************** logging ***************************** */
213 enum GNUNET_ErrorType
215 GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
216 GNUNET_ERROR_TYPE_NONE = 0,
217 GNUNET_ERROR_TYPE_ERROR = 1,
218 GNUNET_ERROR_TYPE_WARNING = 2,
219 GNUNET_ERROR_TYPE_INFO = 4,
220 GNUNET_ERROR_TYPE_DEBUG = 8,
221 GNUNET_ERROR_TYPE_INVALID = 16,
222 GNUNET_ERROR_TYPE_BULK = 32
227 * User-defined handler for log messages.
230 * @param kind severeity
231 * @param component what component is issuing the message?
232 * @param date when was the message logged?
233 * @param message what is the message
235 typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind,
236 const char *component, const char *date,
237 const char *message);
241 * Number of log calls to ignore.
243 extern unsigned int skip_log;
245 #if !defined(GNUNET_CULL_LOGGING)
247 GNUNET_get_log_call_status (int caller_level, const char *comp,
248 const char *file, const char *function, int line);
253 * @param kind how serious is the error?
254 * @param message what is the message (format string)
255 * @param ... arguments for format string
258 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
261 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
262 #define _GNUNET_BOOLEAN_EXPR(expr) \
264 int _gnunet_boolean_var_; \
266 _gnunet_boolean_var_ = 1; \
268 _gnunet_boolean_var_ = 0; \
269 _gnunet_boolean_var_; \
271 #define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1))
272 #define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0))
274 #define GN_LIKELY(expr) (expr)
275 #define GN_UNLIKELY(expr) (expr)
278 #if !defined(GNUNET_LOG_CALL_STATUS)
279 #define GNUNET_LOG_CALL_STATUS -1
283 * Log function that specifies an alternative component.
284 * This function should be used by plugins.
286 * @param kind how serious is the error?
287 * @param comp component responsible for generating the message
288 * @param message what is the message (format string)
289 * @param ... arguments for format string
292 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
293 const char *message, ...);
295 #if !defined(GNUNET_CULL_LOGGING)
296 #define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\
297 static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
298 if (GN_UNLIKELY(log_call_enabled == -1))\
299 log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), comp, __FILE__, __FUNCTION__, log_line);\
300 if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\
302 if (GN_UNLIKELY(log_call_enabled))\
303 GNUNET_log_from_nocheck (kind, comp, __VA_ARGS__);\
307 #define GNUNET_log(kind,...) do { int log_line = __LINE__;\
308 static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
309 if (GN_UNLIKELY(log_call_enabled == -1))\
310 log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\
311 if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\
313 if (GN_UNLIKELY(log_call_enabled))\
314 GNUNET_log_nocheck (kind, __VA_ARGS__);\
318 #define GNUNET_log(...)
319 #define GNUNET_log_from(...)
324 * Abort the process, generate a core dump if possible.
327 GNUNET_abort (void) GNUNET_NORETURN;
330 * Ignore the next n calls to the log function.
332 * @param n number of log calls to ignore
333 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
336 GNUNET_log_skip (unsigned int n, int check_reset);
342 * @param comp default component to use
343 * @param loglevel what types of messages should be logged
344 * @param logfile change logging to logfile (use NULL to keep stderr)
345 * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
348 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
352 * Add a custom logger.
354 * @param logger log function
355 * @param logger_cls closure for logger
358 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
362 * Remove a custom logger.
364 * @param logger log function
365 * @param logger_cls closure for logger
368 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
372 * Convert a hash value to a string (for printing debug messages).
373 * This is one of the very few calls in the entire API that is
376 * @param hc the hash code
380 GNUNET_h2s (const GNUNET_HashCode * hc);
384 * Convert a hash value to a string (for printing debug messages).
385 * This prints all 104 characters of a hashcode!
386 * This is one of the very few calls in the entire API that is
389 * @param hc the hash code
393 GNUNET_h2s_full (const GNUNET_HashCode * hc);
397 * Convert a peer identity to a string (for printing debug messages).
398 * This is one of the very few calls in the entire API that is
401 * @param pid the peer identity
402 * @return string form of the pid; will be overwritten by next
403 * call to GNUNET_i2s.
406 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
410 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
411 * (for printing debug messages). This is one of the very few calls
412 * in the entire API that is NOT reentrant!
414 * @param addr the address
415 * @param addrlen the length of the address
416 * @return nicely formatted string for the address
417 * will be overwritten by next call to GNUNET_a2s.
420 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
423 * Convert error type to string.
425 * @param kind type to convert
426 * @return string corresponding to the type
429 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
433 * Use this for fatal errors that cannot be handled
435 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); GNUNET_abort(); } } while(0)
438 * Use this for fatal errors that cannot be handled
440 #define GNUNET_assert_at(cond, f, l) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), f, l); GNUNET_abort(); } } while(0)
443 * Use this for internal assertion violations that are
444 * not fatal (can be handled) but should not occur.
446 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
449 * Use this for assertion violations caused by other
450 * peers (i.e. protocol violations). We do not want to
451 * confuse end-users (say, some other peer runs an
452 * older, broken or incompatible GNUnet version), but
453 * we still want to see these problems during
454 * development and testing. "OP == other peer".
456 #define GNUNET_break_op(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK, _("External protocol violation detected at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
459 * Log an error message at log-level 'level' that indicates
460 * a failure of the command 'cmd' with the message given
461 * by strerror(errno).
463 #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)
466 * Log an error message at log-level 'level' that indicates
467 * a failure of the command 'cmd' with the message given
468 * by strerror(errno).
470 #define GNUNET_log_from_strerror(level, component, cmd) do { GNUNET_log_from (level, component, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
473 * Log an error message at log-level 'level' that indicates
474 * a failure of the command 'cmd' with the message given
475 * by strerror(errno).
477 #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)
480 * Log an error message at log-level 'level' that indicates
481 * a failure of the command 'cmd' with the message given
482 * by strerror(errno).
484 #define GNUNET_log_from_strerror_file(level, component, cmd, filename) do { GNUNET_log_from (level, component, _("`%s' failed on file `%s' at %s:%d with error: %s\n"), cmd, filename,__FILE__, __LINE__, STRERROR(errno)); } while(0)
486 /* ************************* endianess conversion ****************** */
489 * Convert unsigned 64-bit integer to host-byte-order.
490 * @param n the value in network byte order
491 * @return the same value in host byte order
494 GNUNET_ntohll (uint64_t n);
497 * Convert unsigned 64-bit integer to network-byte-order.
498 * @param n the value in host byte order
499 * @return the same value in network byte order
502 GNUNET_htonll (uint64_t n);
505 * Convert double to network-byte-order.
506 * @param d the value in network byte order
507 * @return the same value in host byte order
510 GNUNET_hton_double (double d);
513 * Convert double to host-byte-order
514 * @param d the value in network byte order
515 * @return the same value in host byte order
518 GNUNET_ntoh_double (double d);
520 /* ************************* allocation functions ****************** */
523 * Maximum allocation with GNUNET_malloc macro.
525 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
528 * Wrapper around malloc. Allocates size bytes of memory.
529 * The memory will be zero'ed out.
531 * @param size the number of bytes to allocate, must be
532 * smaller than 40 MB.
533 * @return pointer to size bytes of memory, never NULL (!)
535 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
538 * Allocate and initialize a block of memory.
540 * @param buf data to initalize the block with
541 * @param size the number of bytes in buf (and size of the allocation)
542 * @return pointer to size bytes of memory, never NULL (!)
544 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
547 * Wrapper around malloc. Allocates size bytes of memory.
548 * The memory will be zero'ed out.
550 * @param size the number of bytes to allocate
551 * @return pointer to size bytes of memory, NULL if we do not have enough memory
553 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
556 * Wrapper around realloc. Rellocates size bytes of memory.
558 * @param ptr the pointer to reallocate
559 * @param size the number of bytes to reallocate
560 * @return pointer to size bytes of memory
562 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
565 * Wrapper around free. Frees the memory referred to by ptr.
566 * Note that is is generally better to free memory that was
567 * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
569 * @param ptr location where to free the memory. ptr must have
570 * been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
572 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
575 * Free the memory pointed to by ptr if ptr is not NULL.
576 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
578 * @param ptr the location in memory to free
580 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
583 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
586 * @param a pointer to a zero-terminated string
587 * @return a copy of the string including zero-termination
589 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
592 * Wrapper around GNUNET_strndup. Makes a partial copy of the string
595 * @param a pointer to a string
596 * @param length of the string to duplicate
597 * @return a partial copy of the string including zero-termination
599 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
602 * Grow a well-typed (!) array. This is a convenience
603 * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
604 * to the new (target) size <tt>tsize</tt>.
607 * Example (simple, well-typed stack):
610 * static struct foo * myVector = NULL;
611 * static int myVecLen = 0;
613 * static void push(struct foo * elem) {
614 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
615 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
618 * static void pop(struct foo * elem) {
619 * if (myVecLen == 0) die();
620 * memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
621 * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
625 * @param arr base-pointer of the vector, may be NULL if size is 0;
626 * will be updated to reflect the new address. The TYPE of
627 * arr is important since size is the number of elements and
628 * not the size in bytes
629 * @param size the number of elements in the existing vector (number
630 * of elements to copy over)
631 * @param tsize the target size for the resulting vector, use 0 to
632 * free the vector (then, arr will be NULL afterwards).
634 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
637 * Append an element to a list (growing the
640 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
643 * Like snprintf, just aborts if the buffer is of insufficient size.
645 * @param buf pointer to buffer that is written to
646 * @param size number of bytes in buf
647 * @param format format strings
648 * @param ... data for format string
649 * @return number of bytes written to buf or negative value on error
652 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
656 * Like asprintf, just portable.
658 * @param buf set to a buffer of sufficient size (allocated, caller must free)
659 * @param format format string (see printf, fprintf, etc.)
660 * @param ... data for format string
661 * @return number of bytes in "*buf" excluding 0-termination
664 GNUNET_asprintf (char **buf, const char *format, ...);
667 /* ************** internal implementations, use macros above! ************** */
670 * Allocate memory. Checks the return value, aborts if no more
671 * memory is available. Don't use GNUNET_xmalloc_ directly. Use the
672 * GNUNET_malloc macro.
673 * The memory will be zero'ed out.
675 * @param size number of bytes to allocate
676 * @param filename where is this call being made (for debugging)
677 * @param linenumber line where this call is being made (for debugging)
678 * @return allocated memory, never NULL
681 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
685 * Allocate and initialize memory. Checks the return value, aborts if no more
686 * memory is available. Don't use GNUNET_xmemdup_ directly. Use the
687 * GNUNET_memdup macro.
689 * @param buf buffer to initialize from (must contain size bytes)
690 * @param size number of bytes to allocate
691 * @param filename where is this call being made (for debugging)
692 * @param linenumber line where this call is being made (for debugging)
693 * @return allocated memory, never NULL
696 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
701 * Allocate memory. This function does not check if the allocation
702 * request is within reasonable bounds, allowing allocations larger
703 * than 40 MB. If you don't expect the possibility of very large
704 * allocations, use GNUNET_malloc instead. The memory will be zero'ed
707 * @param size number of bytes to allocate
708 * @param filename where is this call being made (for debugging)
709 * @param linenumber line where this call is being made (for debugging)
710 * @return pointer to size bytes of memory, NULL if we do not have enough memory
713 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
716 * Reallocate memory. Checks the return value, aborts if no more
717 * memory is available.
720 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
723 * Free memory. Merely a wrapper for the case that we
724 * want to keep track of allocations. Don't use GNUNET_xfree_
725 * directly. Use the GNUNET_free macro.
727 * @param ptr pointer to memory to free
728 * @param filename where is this call being made (for debugging)
729 * @param linenumber line where this call is being made (for debugging)
732 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
736 * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
737 * @param str string to duplicate
738 * @param filename where is this call being made (for debugging)
739 * @param linenumber line where this call is being made (for debugging)
740 * @return the duplicated string
743 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
746 * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
748 * @param str string to duplicate
749 * @param len length of the string to duplicate
750 * @param filename where is this call being made (for debugging)
751 * @param linenumber line where this call is being made (for debugging)
752 * @return the duplicated string
755 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
759 * Grow an array, the new elements are zeroed out.
760 * Grows old by (*oldCount-newCount)*elementSize
761 * bytes and sets *oldCount to newCount.
763 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
765 * @param old address of the pointer to the array
767 * @param elementSize the size of the elements of the array
768 * @param oldCount address of the number of elements in the *old array
769 * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
770 * @param filename where is this call being made (for debugging)
771 * @param linenumber line where this call is being made (for debugging)
774 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
775 unsigned int newCount, const char *filename, int linenumber);
779 * Create a copy of the given message.
781 * @param msg message to copy
782 * @return duplicate of the message
784 struct GNUNET_MessageHeader *
785 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
788 #if __STDC_VERSION__ < 199901L
790 #define __func__ __FUNCTION__
792 #define __func__ "<unknown>"
796 #endif /*GNUNET_COMMON_H_ */