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 * Version of the API (for entire gnunetutil.so library).
36 #define GNUNET_UTIL_VERSION 0x00000000
39 * Name used for "services" that are actually command-line
40 * programs invoked by the end user.
42 #define GNUNET_CLIENT_SERVICE_NAME "client"
45 * Named constants for return values. The following
46 * invariants hold: "GNUNET_NO == 0" (to allow "if (GNUNET_NO)")
47 * "GNUNET_OK != GNUNET_SYSERR", "GNUNET_OK != GNUNET_NO", "GNUNET_NO != GNUNET_SYSERR"
48 * and finally "GNUNET_YES != GNUNET_NO".
51 #define GNUNET_SYSERR -1
55 #define GNUNET_MIN(a,b) (((a) < (b)) ? (a) : (b))
57 #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b))
60 * gcc-ism to get packed structs.
62 #define GNUNET_PACKED __attribute__((packed))
65 /* ************************ super-general types *********************** */
68 * Header for all communications.
70 struct GNUNET_MessageHeader
74 * The length of the struct (in bytes, including the length field itself)
76 uint16_t size GNUNET_PACKED;
79 * The type of the message (XX_CS_PROTO_XXXX)
81 uint16_t type GNUNET_PACKED;
87 * @brief 512-bit hashcode
91 uint32_t bits[512 / 8 / sizeof (uint32_t)]; /* = 16 */
97 * The identity of the host (basically the SHA-512 hashcode of
100 struct GNUNET_PeerIdentity
102 GNUNET_HashCode hashPubKey GNUNET_PACKED;
107 * Function called with a filename.
109 * @param filename complete filename (absolute path)
111 * @return GNUNET_OK to continue to iterate,
112 * GNUNET_SYSERR to abort iteration with error!
114 typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename);
117 /* ****************************** logging ***************************** */
122 enum GNUNET_ErrorType
124 GNUNET_ERROR_TYPE_ERROR = 1,
125 GNUNET_ERROR_TYPE_WARNING = 2,
126 GNUNET_ERROR_TYPE_INFO = 4,
127 GNUNET_ERROR_TYPE_DEBUG = 8,
128 GNUNET_ERROR_TYPE_INVALID = 16,
129 GNUNET_ERROR_TYPE_BULK = 32
133 * User-defined handler for log messages.
136 * @param kind severeity
137 * @param component what component is issuing the message?
138 * @param date when was the message logged?
139 * @param message what is the message
141 typedef void (*GNUNET_Logger) (void *cls,
142 enum GNUNET_ErrorType kind,
143 const char *component,
144 const char *date, const char *message);
149 * @param kind how serious is the error?
150 * @param message what is the message (format string)
151 * @param ... arguments for format string
153 void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...);
158 * Log function that specifies an alternative component.
159 * This function should be used by plugins.
161 * @param kind how serious is the error?
162 * @param comp component responsible for generating the message
163 * @param message what is the message (format string)
164 * @param ... arguments for format string
167 GNUNET_log_from (enum GNUNET_ErrorType kind,
168 const char *comp, const char *message, ...);
172 * Ignore the next n calls to the log function.
174 * @param n number of log calls to ignore
175 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
178 GNUNET_log_skip (unsigned int n, int check_reset);
184 * @param comp default component to use
185 * @param loglevel what types of messages should be logged
186 * @param logfile change logging to logfile (use NULL to keep stderr)
187 * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
190 GNUNET_log_setup (const char *comp,
191 const char *loglevel, const char *logfile);
194 * Add a custom logger.
196 * @param logger log function
197 * @param logger_cls closure for logger
199 void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
202 * Remove a custom logger.
204 * @param logger log function
205 * @param logger_cls closure for logger
207 void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
211 * Convert a hash value to a string (for printing debug messages).
212 * This is one of the very few calls in the entire API that is
215 * @param hc the hash code
218 const char *GNUNET_h2s (const GNUNET_HashCode *hc);
222 * Convert a peer identity to a string (for printing debug messages).
223 * This is one of the very few calls in the entire API that is
226 * @param pid the peer identity
227 * @return string form of the pid; will be overwritten by next
228 * call to GNUNET_i2s.
230 const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
234 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
235 * (for printing debug messages). This is one of the very few calls
236 * in the entire API that is NOT reentrant!
238 * @param addr the address
239 * @param addrlen the length of the address
240 * @return nicely formatted string for the address
241 * will be overwritten by next call to GNUNET_a2s.
243 const char *GNUNET_a2s (const struct sockaddr *addr,
247 * Convert error type to string.
249 * @param kind type to convert
250 * @return string corresponding to the type
252 const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
255 * Use this for fatal errors that cannot be handled
257 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); abort(); } } while(0)
260 * Use this for fatal errors that cannot be handled
262 #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)
265 * Use this for internal assertion violations that are
266 * not fatal (can be handled) but should not occur.
268 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
271 * Use this for assertion violations caused by other
272 * peers (i.e. protocol violations). We do not want to
273 * confuse end-users (say, some other peer runs an
274 * older, broken or incompatible GNUnet version), but
275 * we still want to see these problems during
276 * development and testing. "OP == other peer".
278 #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)
281 * Log an error message at log-level 'level' that indicates
282 * a failure of the command 'cmd' with the message given
283 * by strerror(errno).
285 #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)
288 * Log an error message at log-level 'level' that indicates
289 * a failure of the command 'cmd' with the message given
290 * by strerror(errno).
292 #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)
294 /* ************************* endianess conversion ****************** */
297 * Convert a long-long to host-byte-order.
298 * @param n the value in network byte order
299 * @return the same value in host byte order
301 unsigned long long GNUNET_ntohll (unsigned long long n);
304 * Convert a long long to network-byte-order.
305 * @param n the value in host byte order
306 * @return the same value in network byte order
308 unsigned long long GNUNET_htonll (unsigned long long n);
311 /* ************************* allocation functions ****************** */
314 * Maximum allocation with GNUNET_malloc macro.
316 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
319 * Wrapper around malloc. Allocates size bytes of memory.
320 * The memory will be zero'ed out.
322 * @param size the number of bytes to allocate, must be
323 * smaller than 40 MB.
324 * @return pointer to size bytes of memory
326 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
329 * Wrapper around malloc. Allocates size bytes of memory.
330 * The memory will be zero'ed out.
332 * @param size the number of bytes to allocate
333 * @return pointer to size bytes of memory
335 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
338 * Wrapper around realloc. Rellocates size bytes of memory.
340 * @param ptr the pointer to reallocate
341 * @param size the number of bytes to reallocate
342 * @return pointer to size bytes of memory
344 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
347 * Wrapper around free. Frees the memory referred to by ptr.
348 * Note that is is generally better to free memory that was
349 * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
351 * @param ptr location where to free the memory. ptr must have
352 * been returned by GNUNET_strdup, GNUNET_malloc or GNUNET_array_grow earlier.
354 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
357 * Free the memory pointed to by ptr if ptr is not NULL.
358 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
360 * @param ptr the location in memory to free
362 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
365 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
368 * @param a pointer to a zero-terminated string
369 * @return a copy of the string including zero-termination
371 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
374 * Grow a well-typed (!) array. This is a convenience
375 * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
376 * to the new (target) size <tt>tsize</tt>.
379 * Example (simple, well-typed stack):
382 * static struct foo * myVector = NULL;
383 * static int myVecLen = 0;
385 * static void push(struct foo * elem) {
386 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
387 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
390 * static void pop(struct foo * elem) {
391 * if (myVecLen == 0) die();
392 * memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
393 * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
397 * @param arr base-pointer of the vector, may be NULL if size is 0;
398 * will be updated to reflect the new address. The TYPE of
399 * arr is important since size is the number of elements and
400 * not the size in bytes
401 * @param size the number of elements in the existing vector (number
402 * of elements to copy over)
403 * @param tsize the target size for the resulting vector, use 0 to
404 * free the vector (then, arr will be NULL afterwards).
406 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
409 * Append an element to a list (growing the
412 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
415 * Like snprintf, just aborts if the buffer is of insufficient size.
417 * @param buf pointer to buffer that is written to
418 * @param size number of bytes in buf
419 * @param format format strings
420 * @param ... data for format string
421 * @return number of bytes written to buf or negative value on error
423 int GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
427 * Like asprintf, just portable.
429 * @param buf set to a buffer of sufficient size (allocated, caller must free)
430 * @param format format string (see printf, fprintf, etc.)
431 * @param ... data for format string
432 * @return number of bytes in "*buf" excluding 0-termination
434 int GNUNET_asprintf (char **buf, const char *format, ...);
437 /* ************** internal implementations, use macros above! ************** */
440 * Allocate memory. Checks the return value, aborts if no more
441 * memory is available. Don't use GNUNET_xmalloc_ directly. Use the
442 * GNUNET_malloc macro.
443 * The memory will be zero'ed out.
445 * @param size number of bytes to allocate
446 * @param filename where is this call being made (for debugging)
447 * @param linenumber line where this call is being made (for debugging)
448 * @return allocated memory, never NULL
450 void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
454 * Allocate memory. This function does not check if the
455 * allocation request is within reasonable bounds, allowing
456 * allocations larger than 40 MB. If you don't expect the
457 * possibility of very large allocations, use GNUNET_malloc instead.
458 * The memory will be zero'ed out.
460 * @param size number of bytes to allocate
461 * @param filename where is this call being made (for debugging)
462 * @param linenumber line where this call is being made (for debugging)
463 * @return allocated memory, never NULL
465 void *GNUNET_xmalloc_unchecked_ (size_t size,
466 const char *filename, int linenumber);
469 * Reallocate memory. Checks the return value, aborts if no more
470 * memory is available.
472 void *GNUNET_xrealloc_ (void *ptr,
473 const size_t n, const char *filename, int linenumber);
476 * Free memory. Merely a wrapper for the case that we
477 * want to keep track of allocations. Don't use GNUNET_xfree_
478 * directly. Use the GNUNET_free macro.
480 * @param ptr pointer to memory to free
481 * @param filename where is this call being made (for debugging)
482 * @param linenumber line where this call is being made (for debugging)
484 void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
488 * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
489 * @param str string to duplicate
490 * @param filename where is this call being made (for debugging)
491 * @param linenumber line where this call is being made (for debugging)
492 * @return the duplicated string
494 char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
497 * Grow an array, the new elements are zeroed out.
498 * Grows old by (*oldCount-newCount)*elementSize
499 * bytes and sets *oldCount to newCount.
501 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
503 * @param old address of the pointer to the array
505 * @param elementSize the size of the elements of the array
506 * @param oldCount address of the number of elements in the *old array
507 * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
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_xgrow_ (void **old,
513 unsigned int *oldCount,
514 unsigned int newCount,
515 const char *filename, int linenumber);
520 #if __STDC_VERSION__ < 199901L
522 # define __func__ __FUNCTION__
524 # define __func__ "<unknown>"
528 #endif /*GNUNET_COMMON_H_ */