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 0x00090000
55 * Name used for "services" that are actually command-line
56 * programs invoked by the end user.
58 #define GNUNET_CLIENT_SERVICE_NAME "client"
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".
67 #define GNUNET_SYSERR -1
71 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
73 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
76 * gcc-ism to get packed structs.
78 #define GNUNET_PACKED __attribute__((packed))
81 * gcc-ism to document unused arguments
83 #define GNUNET_UNUSED __attribute__((unused))
86 /* ************************ super-general types *********************** */
89 * Header for all communications.
91 struct GNUNET_MessageHeader
95 * The length of the struct (in bytes, including the length field itself),
96 * in big-endian format.
98 uint16_t size GNUNET_PACKED;
101 * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
103 uint16_t type GNUNET_PACKED;
109 * @brief 512-bit hashcode
113 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
119 * The identity of the host (basically the SHA-512 hashcode of
122 struct GNUNET_PeerIdentity
124 GNUNET_HashCode hashPubKey GNUNET_PACKED;
129 * Function called with a filename.
132 * @param filename complete filename (absolute path)
133 * @return GNUNET_OK to continue to iterate,
134 * GNUNET_SYSERR to abort iteration with error!
136 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
139 /* ****************************** logging ***************************** */
144 enum GNUNET_ErrorType
146 GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
147 GNUNET_ERROR_TYPE_NONE = 0,
148 GNUNET_ERROR_TYPE_ERROR = 1,
149 GNUNET_ERROR_TYPE_WARNING = 2,
150 GNUNET_ERROR_TYPE_INFO = 4,
151 GNUNET_ERROR_TYPE_DEBUG = 8,
152 GNUNET_ERROR_TYPE_INVALID = 16,
153 GNUNET_ERROR_TYPE_BULK = 32
158 * User-defined handler for log messages.
161 * @param kind severeity
162 * @param component what component is issuing the message?
163 * @param date when was the message logged?
164 * @param message what is the message
166 typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind,
167 const char *component, const char *date,
168 const char *message);
172 * Number of log calls to ignore.
174 extern unsigned int skip_log;
176 #if !defined(GNUNET_CULL_LOGGING)
178 GNUNET_get_log_call_status (int caller_level, const char *comp,
179 const char *file, const char *function, int line);
184 * @param kind how serious is the error?
185 * @param message what is the message (format string)
186 * @param ... arguments for format string
189 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...);
192 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
193 #define _GNUNET_BOOLEAN_EXPR(expr) \
195 int _gnunet_boolean_var_; \
197 _gnunet_boolean_var_ = 1; \
199 _gnunet_boolean_var_ = 0; \
200 _gnunet_boolean_var_; \
202 #define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1))
203 #define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0))
205 #define GN_LIKELY(expr) (expr)
206 #define GN_UNLIKELY(expr) (expr)
209 #if !defined(GNUNET_LOG_CALL_STATUS)
210 #define GNUNET_LOG_CALL_STATUS -1
214 * Log function that specifies an alternative component.
215 * This function should be used by plugins.
217 * @param kind how serious is the error?
218 * @param comp component responsible for generating the message
219 * @param message what is the message (format string)
220 * @param ... arguments for format string
223 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
224 const char *message, ...);
226 #if !defined(GNUNET_CULL_LOGGING)
227 #define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\
228 static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
229 if (GN_UNLIKELY(log_call_enabled == -1))\
230 log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), comp, __FILE__, __FUNCTION__, log_line);\
231 if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\
233 if (GN_UNLIKELY(log_call_enabled))\
234 GNUNET_log_from_nocheck (kind, comp, __VA_ARGS__);\
238 #define GNUNET_log(kind,...) do { int log_line = __LINE__;\
239 static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\
240 if (GN_UNLIKELY(log_call_enabled == -1))\
241 log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\
242 if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\
244 if (GN_UNLIKELY(log_call_enabled))\
245 GNUNET_log_nocheck (kind, __VA_ARGS__);\
249 #define GNUNET_log(...)
250 #define GNUNET_log_from(...)
255 * Abort the process, generate a core dump if possible.
261 * Ignore the next n calls to the log function.
263 * @param n number of log calls to ignore
264 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
267 GNUNET_log_skip (unsigned int n, int check_reset);
273 * @param comp default component to use
274 * @param loglevel what types of messages should be logged
275 * @param logfile change logging to logfile (use NULL to keep stderr)
276 * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
279 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile);
283 * Add a custom logger.
285 * @param logger log function
286 * @param logger_cls closure for logger
289 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
293 * Remove a custom logger.
295 * @param logger log function
296 * @param logger_cls closure for logger
299 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
303 * Convert a hash value to a string (for printing debug messages).
304 * This is one of the very few calls in the entire API that is
307 * @param hc the hash code
311 GNUNET_h2s (const GNUNET_HashCode * hc);
315 * Convert a hash value to a string (for printing debug messages).
316 * This prints all 104 characters of a hashcode!
317 * This is one of the very few calls in the entire API that is
320 * @param hc the hash code
324 GNUNET_h2s_full (const GNUNET_HashCode * hc);
328 * Convert a peer identity to a string (for printing debug messages).
329 * This is one of the very few calls in the entire API that is
332 * @param pid the peer identity
333 * @return string form of the pid; will be overwritten by next
334 * call to GNUNET_i2s.
337 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
341 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
342 * (for printing debug messages). This is one of the very few calls
343 * in the entire API that is NOT reentrant!
345 * @param addr the address
346 * @param addrlen the length of the address
347 * @return nicely formatted string for the address
348 * will be overwritten by next call to GNUNET_a2s.
351 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen);
354 * Convert error type to string.
356 * @param kind type to convert
357 * @return string corresponding to the type
360 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
364 * Use this for fatal errors that cannot be handled
366 #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)
369 * Use this for fatal errors that cannot be handled
371 #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)
374 * Use this for internal assertion violations that are
375 * not fatal (can be handled) but should not occur.
377 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
380 * Use this for assertion violations caused by other
381 * peers (i.e. protocol violations). We do not want to
382 * confuse end-users (say, some other peer runs an
383 * older, broken or incompatible GNUnet version), but
384 * we still want to see these problems during
385 * development and testing. "OP == other peer".
387 #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)
390 * Log an error message at log-level 'level' that indicates
391 * a failure of the command 'cmd' with the message given
392 * by strerror(errno).
394 #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)
397 * Log an error message at log-level 'level' that indicates
398 * a failure of the command 'cmd' with the message given
399 * by strerror(errno).
401 #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)
404 * Log an error message at log-level 'level' that indicates
405 * a failure of the command 'cmd' with the message given
406 * by strerror(errno).
408 #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)
411 * Log an error message at log-level 'level' that indicates
412 * a failure of the command 'cmd' with the message given
413 * by strerror(errno).
415 #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)
417 /* ************************* endianess conversion ****************** */
420 * Convert unsigned 64-bit integer to host-byte-order.
421 * @param n the value in network byte order
422 * @return the same value in host byte order
425 GNUNET_ntohll (uint64_t n);
428 * Convert unsigned 64-bit integer to network-byte-order.
429 * @param n the value in host byte order
430 * @return the same value in network byte order
433 GNUNET_htonll (uint64_t n);
436 /* ************************* allocation functions ****************** */
439 * Maximum allocation with GNUNET_malloc macro.
441 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
444 * Wrapper around malloc. Allocates size bytes of memory.
445 * The memory will be zero'ed out.
447 * @param size the number of bytes to allocate, must be
448 * smaller than 40 MB.
449 * @return pointer to size bytes of memory, never NULL (!)
451 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
454 * Allocate and initialize a block of memory.
456 * @param buf data to initalize the block with
457 * @param size the number of bytes in buf (and size of the allocation)
458 * @return pointer to size bytes of memory, never NULL (!)
460 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
463 * Wrapper around malloc. Allocates size bytes of memory.
464 * The memory will be zero'ed out.
466 * @param size the number of bytes to allocate
467 * @return pointer to size bytes of memory, NULL if we do not have enough memory
469 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
472 * Wrapper around realloc. Rellocates size bytes of memory.
474 * @param ptr the pointer to reallocate
475 * @param size the number of bytes to reallocate
476 * @return pointer to size bytes of memory
478 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
481 * Wrapper around free. Frees the memory referred to by ptr.
482 * Note that is is generally better to free memory that was
483 * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
485 * @param ptr location where to free the memory. ptr must have
486 * been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier.
488 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
491 * Free the memory pointed to by ptr if ptr is not NULL.
492 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
494 * @param ptr the location in memory to free
496 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
499 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
502 * @param a pointer to a zero-terminated string
503 * @return a copy of the string including zero-termination
505 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
508 * Wrapper around GNUNET_strndup. Makes a partial copy of the string
511 * @param a pointer to a string
512 * @param length of the string to duplicate
513 * @return a partial copy of the string including zero-termination
515 #define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__)
518 * Grow a well-typed (!) array. This is a convenience
519 * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
520 * to the new (target) size <tt>tsize</tt>.
523 * Example (simple, well-typed stack):
526 * static struct foo * myVector = NULL;
527 * static int myVecLen = 0;
529 * static void push(struct foo * elem) {
530 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
531 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
534 * static void pop(struct foo * elem) {
535 * if (myVecLen == 0) die();
536 * memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
537 * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
541 * @param arr base-pointer of the vector, may be NULL if size is 0;
542 * will be updated to reflect the new address. The TYPE of
543 * arr is important since size is the number of elements and
544 * not the size in bytes
545 * @param size the number of elements in the existing vector (number
546 * of elements to copy over)
547 * @param tsize the target size for the resulting vector, use 0 to
548 * free the vector (then, arr will be NULL afterwards).
550 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
553 * Append an element to a list (growing the
556 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
559 * Like snprintf, just aborts if the buffer is of insufficient size.
561 * @param buf pointer to buffer that is written to
562 * @param size number of bytes in buf
563 * @param format format strings
564 * @param ... data for format string
565 * @return number of bytes written to buf or negative value on error
568 GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
572 * Like asprintf, just portable.
574 * @param buf set to a buffer of sufficient size (allocated, caller must free)
575 * @param format format string (see printf, fprintf, etc.)
576 * @param ... data for format string
577 * @return number of bytes in "*buf" excluding 0-termination
580 GNUNET_asprintf (char **buf, const char *format, ...);
583 /* ************** internal implementations, use macros above! ************** */
586 * Allocate memory. Checks the return value, aborts if no more
587 * memory is available. Don't use GNUNET_xmalloc_ directly. Use the
588 * GNUNET_malloc macro.
589 * The memory will be zero'ed out.
591 * @param size number of bytes to allocate
592 * @param filename where is this call being made (for debugging)
593 * @param linenumber line where this call is being made (for debugging)
594 * @return allocated memory, never NULL
597 GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
601 * Allocate and initialize memory. Checks the return value, aborts if no more
602 * memory is available. Don't use GNUNET_xmemdup_ directly. Use the
603 * GNUNET_memdup macro.
605 * @param buf buffer to initialize from (must contain size bytes)
606 * @param size number of bytes to allocate
607 * @param filename where is this call being made (for debugging)
608 * @param linenumber line where this call is being made (for debugging)
609 * @return allocated memory, never NULL
612 GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename,
617 * Allocate memory. This function does not check if the allocation
618 * request is within reasonable bounds, allowing allocations larger
619 * than 40 MB. If you don't expect the possibility of very large
620 * allocations, use GNUNET_malloc instead. The memory will be zero'ed
623 * @param size number of bytes to allocate
624 * @param filename where is this call being made (for debugging)
625 * @param linenumber line where this call is being made (for debugging)
626 * @return pointer to size bytes of memory, NULL if we do not have enough memory
629 GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber);
632 * Reallocate memory. Checks the return value, aborts if no more
633 * memory is available.
636 GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber);
639 * Free memory. Merely a wrapper for the case that we
640 * want to keep track of allocations. Don't use GNUNET_xfree_
641 * directly. Use the GNUNET_free macro.
643 * @param ptr pointer to memory to free
644 * @param filename where is this call being made (for debugging)
645 * @param linenumber line where this call is being made (for debugging)
648 GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
652 * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
653 * @param str string to duplicate
654 * @param filename where is this call being made (for debugging)
655 * @param linenumber line where this call is being made (for debugging)
656 * @return the duplicated string
659 GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
662 * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.
664 * @param str string to duplicate
665 * @param len length of the string to duplicate
666 * @param filename where is this call being made (for debugging)
667 * @param linenumber line where this call is being made (for debugging)
668 * @return the duplicated string
671 GNUNET_xstrndup_ (const char *str, size_t len, const char *filename,
675 * Grow an array, the new elements are zeroed out.
676 * Grows old by (*oldCount-newCount)*elementSize
677 * bytes and sets *oldCount to newCount.
679 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
681 * @param old address of the pointer to the array
683 * @param elementSize the size of the elements of the array
684 * @param oldCount address of the number of elements in the *old array
685 * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
686 * @param filename where is this call being made (for debugging)
687 * @param linenumber line where this call is being made (for debugging)
690 GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount,
691 unsigned int newCount, const char *filename, int linenumber);
695 * Create a copy of the given message.
697 * @param msg message to copy
698 * @return duplicate of the message
700 struct GNUNET_MessageHeader *
701 GNUNET_copy_message (const struct GNUNET_MessageHeader *msg);
704 #if __STDC_VERSION__ < 199901L
706 #define __func__ __FUNCTION__
708 #define __func__ "<unknown>"
712 #endif /*GNUNET_COMMON_H_ */