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 0x00000000
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 /* ************************ super-general types *********************** */
84 * Header for all communications.
86 struct GNUNET_MessageHeader
90 * The length of the struct (in bytes, including the length field itself),
91 * in big-endian format.
93 uint16_t size GNUNET_PACKED;
96 * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
98 uint16_t type GNUNET_PACKED;
104 * @brief 512-bit hashcode
108 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
114 * The identity of the host (basically the SHA-512 hashcode of
117 struct GNUNET_PeerIdentity
119 GNUNET_HashCode hashPubKey GNUNET_PACKED;
124 * Function called with a filename.
127 * @param filename complete filename (absolute path)
128 * @return GNUNET_OK to continue to iterate,
129 * GNUNET_SYSERR to abort iteration with error!
131 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
134 /* ****************************** logging ***************************** */
139 enum GNUNET_ErrorType
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
150 * User-defined handler for log messages.
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
158 typedef void (*GNUNET_Logger) (void *cls,
159 enum GNUNET_ErrorType kind,
160 const char *component,
161 const char *date, const char *message);
166 * @param kind how serious is the error?
167 * @param message what is the message (format string)
168 * @param ... arguments for format string
170 void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...);
175 * Log function that specifies an alternative component.
176 * This function should be used by plugins.
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
184 GNUNET_log_from (enum GNUNET_ErrorType kind,
185 const char *comp, const char *message, ...);
189 * Ignore the next n calls to the log function.
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
195 GNUNET_log_skip (unsigned int n, int check_reset);
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
207 GNUNET_log_setup (const char *comp,
208 const char *loglevel, const char *logfile);
211 * Add a custom logger.
213 * @param logger log function
214 * @param logger_cls closure for logger
216 void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
219 * Remove a custom logger.
221 * @param logger log function
222 * @param logger_cls closure for logger
224 void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
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
232 * @param hc the hash code
235 const char *GNUNET_h2s (const GNUNET_HashCode *hc);
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
243 * @param hc the hash code
246 const char *GNUNET_h2s_full (const GNUNET_HashCode *hc);
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
253 * @param pid the peer identity
254 * @return string form of the pid; will be overwritten by next
255 * call to GNUNET_i2s.
257 const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
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!
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.
270 const char *GNUNET_a2s (const struct sockaddr *addr,
274 * Convert error type to string.
276 * @param kind type to convert
277 * @return string corresponding to the type
279 const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
282 * Use this for fatal errors that cannot be handled
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)
287 * Use this for fatal errors that cannot be handled
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)
292 * Use this for internal assertion violations that are
293 * not fatal (can be handled) but should not occur.
295 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
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".
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)
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).
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)
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).
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)
321 /* ************************* endianess conversion ****************** */
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
328 unsigned long long GNUNET_ntohll (unsigned long long n);
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
335 unsigned long long GNUNET_htonll (unsigned long long n);
338 /* ************************* allocation functions ****************** */
341 * Maximum allocation with GNUNET_malloc macro.
343 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
346 * Wrapper around malloc. Allocates size bytes of memory.
347 * The memory will be zero'ed out.
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 (!)
353 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
356 * Wrapper around malloc. Allocates size bytes of memory.
357 * The memory will be zero'ed out.
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
362 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
365 * Wrapper around realloc. Rellocates size bytes of memory.
367 * @param ptr the pointer to reallocate
368 * @param size the number of bytes to reallocate
369 * @return pointer to size bytes of memory
371 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
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.
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.
381 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
384 * Free the memory pointed to by ptr if ptr is not NULL.
385 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
387 * @param ptr the location in memory to free
389 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
392 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
395 * @param a pointer to a zero-terminated string
396 * @return a copy of the string including zero-termination
398 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
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>.
406 * Example (simple, well-typed stack):
409 * static struct foo * myVector = NULL;
410 * static int myVecLen = 0;
412 * static void push(struct foo * elem) {
413 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
414 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
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);
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).
433 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
436 * Append an element to a list (growing the
439 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
442 * Like snprintf, just aborts if the buffer is of insufficient size.
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
450 int GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
454 * Like asprintf, just portable.
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
461 int GNUNET_asprintf (char **buf, const char *format, ...);
464 /* ************** internal implementations, use macros above! ************** */
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.
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
477 void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
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
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
492 void *GNUNET_xmalloc_unchecked_ (size_t size,
493 const char *filename, int linenumber);
496 * Reallocate memory. Checks the return value, aborts if no more
497 * memory is available.
499 void *GNUNET_xrealloc_ (void *ptr,
500 size_t n, const char *filename, int linenumber);
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.
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)
511 void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
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
521 char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
524 * Grow an array, the new elements are zeroed out.
525 * Grows old by (*oldCount-newCount)*elementSize
526 * bytes and sets *oldCount to newCount.
528 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
530 * @param old address of the pointer to the array
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)
538 void GNUNET_xgrow_ (void **old,
540 unsigned int *oldCount,
541 unsigned int newCount,
542 const char *filename, int linenumber);
547 #if __STDC_VERSION__ < 199901L
549 # define __func__ __FUNCTION__
551 # define __func__ "<unknown>"
555 #endif /*GNUNET_COMMON_H_ */