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_NONE = 0,
142 GNUNET_ERROR_TYPE_ERROR = 1,
143 GNUNET_ERROR_TYPE_WARNING = 2,
144 GNUNET_ERROR_TYPE_INFO = 4,
145 GNUNET_ERROR_TYPE_DEBUG = 8,
146 GNUNET_ERROR_TYPE_INVALID = 16,
147 GNUNET_ERROR_TYPE_BULK = 32
152 * User-defined handler for log messages.
155 * @param kind severeity
156 * @param component what component is issuing the message?
157 * @param date when was the message logged?
158 * @param message what is the message
160 typedef void (*GNUNET_Logger) (void *cls,
161 enum GNUNET_ErrorType kind,
162 const char *component,
163 const char *date, const char *message);
168 * @param kind how serious is the error?
169 * @param message what is the message (format string)
170 * @param ... arguments for format string
172 void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...);
177 * Log function that specifies an alternative component.
178 * This function should be used by plugins.
180 * @param kind how serious is the error?
181 * @param comp component responsible for generating the message
182 * @param message what is the message (format string)
183 * @param ... arguments for format string
186 GNUNET_log_from (enum GNUNET_ErrorType kind,
187 const char *comp, const char *message, ...);
191 * Ignore the next n calls to the log function.
193 * @param n number of log calls to ignore
194 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
197 GNUNET_log_skip (unsigned int n, int check_reset);
203 * @param comp default component to use
204 * @param loglevel what types of messages should be logged
205 * @param logfile change logging to logfile (use NULL to keep stderr)
206 * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
209 GNUNET_log_setup (const char *comp,
210 const char *loglevel, const char *logfile);
214 * Add a custom logger.
216 * @param logger log function
217 * @param logger_cls closure for logger
219 void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
223 * Remove a custom logger.
225 * @param logger log function
226 * @param logger_cls closure for logger
228 void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
232 * Convert a hash value to a string (for printing debug messages).
233 * This is one of the very few calls in the entire API that is
236 * @param hc the hash code
239 const char *GNUNET_h2s (const GNUNET_HashCode *hc);
243 * Convert a hash value to a string (for printing debug messages).
244 * This prints all 104 characters of a hashcode!
245 * This is one of the very few calls in the entire API that is
248 * @param hc the hash code
251 const char *GNUNET_h2s_full (const GNUNET_HashCode *hc);
255 * Convert a peer identity to a string (for printing debug messages).
256 * This is one of the very few calls in the entire API that is
259 * @param pid the peer identity
260 * @return string form of the pid; will be overwritten by next
261 * call to GNUNET_i2s.
263 const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
267 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
268 * (for printing debug messages). This is one of the very few calls
269 * in the entire API that is NOT reentrant!
271 * @param addr the address
272 * @param addrlen the length of the address
273 * @return nicely formatted string for the address
274 * will be overwritten by next call to GNUNET_a2s.
276 const char *GNUNET_a2s (const struct sockaddr *addr,
280 * Convert error type to string.
282 * @param kind type to convert
283 * @return string corresponding to the type
285 const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
289 * Use this for fatal errors that cannot be handled
291 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); abort(); } } while(0)
294 * Use this for fatal errors that cannot be handled
296 #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)
299 * Use this for internal assertion violations that are
300 * not fatal (can be handled) but should not occur.
302 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
305 * Use this for assertion violations caused by other
306 * peers (i.e. protocol violations). We do not want to
307 * confuse end-users (say, some other peer runs an
308 * older, broken or incompatible GNUnet version), but
309 * we still want to see these problems during
310 * development and testing. "OP == other peer".
312 #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)
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(level, cmd) do { GNUNET_log(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, STRERROR(errno)); } while(0)
322 * Log an error message at log-level 'level' that indicates
323 * a failure of the command 'cmd' with the message given
324 * by strerror(errno).
326 #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)
328 /* ************************* endianess conversion ****************** */
331 * Convert a long-long to host-byte-order.
332 * @param n the value in network byte order
333 * @return the same value in host byte order
335 unsigned long long GNUNET_ntohll (unsigned long long n);
338 * Convert a long long to network-byte-order.
339 * @param n the value in host byte order
340 * @return the same value in network byte order
342 unsigned long long GNUNET_htonll (unsigned long long n);
345 /* ************************* allocation functions ****************** */
348 * Maximum allocation with GNUNET_malloc macro.
350 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
353 * Wrapper around malloc. Allocates size bytes of memory.
354 * The memory will be zero'ed out.
356 * @param size the number of bytes to allocate, must be
357 * smaller than 40 MB.
358 * @return pointer to size bytes of memory, never NULL (!)
360 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
363 * Allocate and initialize a block of memory.
365 * @param buf data to initalize the block with
366 * @param size the number of bytes in buf (and size of the allocation)
367 * @return pointer to size bytes of memory, never NULL (!)
369 #define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__)
372 * Wrapper around malloc. Allocates size bytes of memory.
373 * The memory will be zero'ed out.
375 * @param size the number of bytes to allocate
376 * @return pointer to size bytes of memory, NULL if we do not have enough memory
378 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
381 * Wrapper around realloc. Rellocates size bytes of memory.
383 * @param ptr the pointer to reallocate
384 * @param size the number of bytes to reallocate
385 * @return pointer to size bytes of memory
387 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
390 * Wrapper around free. Frees the memory referred to by ptr.
391 * Note that is is generally better to free memory that was
392 * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
394 * @param ptr location where to free the memory. ptr must have
395 * been returned by GNUNET_strdup, GNUNET_malloc or GNUNET_array_grow earlier.
397 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
400 * Free the memory pointed to by ptr if ptr is not NULL.
401 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
403 * @param ptr the location in memory to free
405 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
408 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
411 * @param a pointer to a zero-terminated string
412 * @return a copy of the string including zero-termination
414 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
417 * Grow a well-typed (!) array. This is a convenience
418 * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
419 * to the new (target) size <tt>tsize</tt>.
422 * Example (simple, well-typed stack):
425 * static struct foo * myVector = NULL;
426 * static int myVecLen = 0;
428 * static void push(struct foo * elem) {
429 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
430 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
433 * static void pop(struct foo * elem) {
434 * if (myVecLen == 0) die();
435 * memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
436 * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
440 * @param arr base-pointer of the vector, may be NULL if size is 0;
441 * will be updated to reflect the new address. The TYPE of
442 * arr is important since size is the number of elements and
443 * not the size in bytes
444 * @param size the number of elements in the existing vector (number
445 * of elements to copy over)
446 * @param tsize the target size for the resulting vector, use 0 to
447 * free the vector (then, arr will be NULL afterwards).
449 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
452 * Append an element to a list (growing the
455 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
458 * Like snprintf, just aborts if the buffer is of insufficient size.
460 * @param buf pointer to buffer that is written to
461 * @param size number of bytes in buf
462 * @param format format strings
463 * @param ... data for format string
464 * @return number of bytes written to buf or negative value on error
466 int GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
470 * Like asprintf, just portable.
472 * @param buf set to a buffer of sufficient size (allocated, caller must free)
473 * @param format format string (see printf, fprintf, etc.)
474 * @param ... data for format string
475 * @return number of bytes in "*buf" excluding 0-termination
477 int GNUNET_asprintf (char **buf, const char *format, ...);
480 /* ************** internal implementations, use macros above! ************** */
483 * Allocate memory. Checks the return value, aborts if no more
484 * memory is available. Don't use GNUNET_xmalloc_ directly. Use the
485 * GNUNET_malloc macro.
486 * The memory will be zero'ed out.
488 * @param size number of bytes to allocate
489 * @param filename where is this call being made (for debugging)
490 * @param linenumber line where this call is being made (for debugging)
491 * @return allocated memory, never NULL
493 void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
498 * Allocate and initialize memory. Checks the return value, aborts if no more
499 * memory is available. Don't use GNUNET_xmemdup_ directly. Use the
500 * GNUNET_memdup macro.
502 * @param buf buffer to initialize from (must contain size bytes)
503 * @param size number of bytes to allocate
504 * @param filename where is this call being made (for debugging)
505 * @param linenumber line where this call is being made (for debugging)
506 * @return allocated memory, never NULL
508 void *GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename, int linenumber);
512 * Allocate memory. This function does not check if the allocation
513 * request is within reasonable bounds, allowing allocations larger
514 * than 40 MB. If you don't expect the possibility of very large
515 * allocations, use GNUNET_malloc instead. The memory will be zero'ed
518 * @param size number of bytes to allocate
519 * @param filename where is this call being made (for debugging)
520 * @param linenumber line where this call is being made (for debugging)
521 * @return pointer to size bytes of memory, NULL if we do not have enough memory
523 void *GNUNET_xmalloc_unchecked_ (size_t size,
524 const char *filename, int linenumber);
527 * Reallocate memory. Checks the return value, aborts if no more
528 * memory is available.
530 void *GNUNET_xrealloc_ (void *ptr,
531 size_t n, const char *filename, int linenumber);
534 * Free memory. Merely a wrapper for the case that we
535 * want to keep track of allocations. Don't use GNUNET_xfree_
536 * directly. Use the GNUNET_free macro.
538 * @param ptr pointer to memory to free
539 * @param filename where is this call being made (for debugging)
540 * @param linenumber line where this call is being made (for debugging)
542 void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
546 * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
547 * @param str string to duplicate
548 * @param filename where is this call being made (for debugging)
549 * @param linenumber line where this call is being made (for debugging)
550 * @return the duplicated string
552 char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
555 * Grow an array, the new elements are zeroed out.
556 * Grows old by (*oldCount-newCount)*elementSize
557 * bytes and sets *oldCount to newCount.
559 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
561 * @param old address of the pointer to the array
563 * @param elementSize the size of the elements of the array
564 * @param oldCount address of the number of elements in the *old array
565 * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
566 * @param filename where is this call being made (for debugging)
567 * @param linenumber line where this call is being made (for debugging)
569 void GNUNET_xgrow_ (void **old,
571 unsigned int *oldCount,
572 unsigned int newCount,
573 const char *filename, int linenumber);
578 #if __STDC_VERSION__ < 199901L
580 # define __func__ __FUNCTION__
582 # define __func__ "<unknown>"
586 #endif /*GNUNET_COMMON_H_ */