2 This file is part of GNUnet.
3 (C) 2006 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, use 0 to
175 * assert that the log skip counter is currently zero.
177 void GNUNET_log_skip (unsigned int n);
183 * @param component default component to use
184 * @param loglevel what types of messages should be logged
185 * @param logfile change logging to logfile (use NULL to keep stderr)
186 * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened
189 GNUNET_log_setup (const char *component,
190 const char *loglevel, const char *logfile);
193 * Add a custom logger.
195 * @param logger log function
196 * @param logger_cls closure for logger
198 void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
201 * Remove a custom logger.
203 * @param logger log function
204 * @param logger_cls closure for logger
206 void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
210 * Convert a hash value to a string (for printing debug messages).
211 * This is one of the very few calls in the entire API that is
214 * @param hc the hash code
217 const char *GNUNET_h2s (const GNUNET_HashCode *hc);
221 * Convert a peer identity to a string (for printing debug messages).
222 * This is one of the very few calls in the entire API that is
225 * @param pid the peer identity
226 * @return string form of the pid; will be overwritten by next
227 * call to GNUNET_i2s.
229 const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
233 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
234 * (for printing debug messages). This is one of the very few calls
235 * in the entire API that is NOT reentrant!
237 * @param addr the address
238 * @param addrlen the length of the address
239 * @return nicely formatted string for the address
240 * will be overwritten by next call to GNUNET_a2s.
242 const char *GNUNET_a2s (const struct sockaddr *addr,
246 * Convert error type to string.
248 * @param kind type to convert
249 * @return string corresponding to the type
251 const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
254 * Use this for fatal errors that cannot be handled
256 #define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); abort(); } } while(0)
259 * Use this for fatal errors that cannot be handled
261 #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)
264 * Use this for internal assertion violations that are
265 * not fatal (can be handled) but should not occur.
267 #define GNUNET_break(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); } } while(0)
270 * Use this for assertion violations caused by other
271 * peers (i.e. protocol violations). We do not want to
272 * confuse end-users (say, some other peer runs an
273 * older, broken or incompatible GNUnet version), but
274 * we still want to see these problems during
275 * development and testing. "OP == other peer".
277 #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)
280 * Log an error message at log-level 'level' that indicates
281 * a failure of the command 'cmd' with the message given
282 * by strerror(errno).
284 #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)
287 * Log an error message at log-level 'level' that indicates
288 * a failure of the command 'cmd' with the message given
289 * by strerror(errno).
291 #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)
293 /* ************************* endianess conversion ****************** */
296 * Convert a long-long to host-byte-order.
297 * @param n the value in network byte order
298 * @return the same value in host byte order
300 unsigned long long GNUNET_ntohll (unsigned long long n);
303 * Convert a long long to network-byte-order.
304 * @param n the value in host byte order
305 * @return the same value in network byte order
307 unsigned long long GNUNET_htonll (unsigned long long n);
310 /* ************************* allocation functions ****************** */
313 * Maximum allocation with GNUNET_malloc macro.
315 #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
318 * Wrapper around malloc. Allocates size bytes of memory.
319 * The memory will be zero'ed out.
321 * @param size the number of bytes to allocate, must be
322 * smaller than 40 MB.
323 * @return pointer to size bytes of memory
325 #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__)
328 * Wrapper around malloc. Allocates size bytes of memory.
329 * The memory will be zero'ed out.
331 * @param size the number of bytes to allocate
332 * @return pointer to size bytes of memory
334 #define GNUNET_malloc_large(size) GNUNET_xmalloc_unchecked_(size, __FILE__, __LINE__)
337 * Wrapper around realloc. Rellocates size bytes of memory.
339 * @param ptr the pointer to reallocate
340 * @param size the number of bytes to reallocate
341 * @return pointer to size bytes of memory
343 #define GNUNET_realloc(ptr, size) GNUNET_xrealloc_(ptr, size, __FILE__, __LINE__)
346 * Wrapper around free. Frees the memory referred to by ptr.
347 * Note that is is generally better to free memory that was
348 * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free.
350 * @param ptr location where to free the memory. ptr must have
351 * been returned by GNUNET_strdup, GNUNET_malloc or GNUNET_array_grow earlier.
353 #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__)
356 * Free the memory pointed to by ptr if ptr is not NULL.
357 * Equivalent to if (ptr!=null)GNUNET_free(ptr).
359 * @param ptr the location in memory to free
361 #define GNUNET_free_non_null(ptr) do { void * __x__ = ptr; if (__x__ != NULL) { GNUNET_free(__x__); } } while(0)
364 * Wrapper around GNUNET_strdup. Makes a copy of the zero-terminated string
367 * @param a pointer to a zero-terminated string
368 * @return a copy of the string including zero-termination
370 #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__)
373 * Grow a well-typed (!) array. This is a convenience
374 * method to grow a vector <tt>arr</tt> of size <tt>size</tt>
375 * to the new (target) size <tt>tsize</tt>.
378 * Example (simple, well-typed stack):
381 * static struct foo * myVector = NULL;
382 * static int myVecLen = 0;
384 * static void push(struct foo * elem) {
385 * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
386 * memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
389 * static void pop(struct foo * elem) {
390 * if (myVecLen == 0) die();
391 * memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
392 * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
396 * @param arr base-pointer of the vector, may be NULL if size is 0;
397 * will be updated to reflect the new address. The TYPE of
398 * arr is important since size is the number of elements and
399 * not the size in bytes
400 * @param size the number of elements in the existing vector (number
401 * of elements to copy over)
402 * @param tsize the target size for the resulting vector, use 0 to
403 * free the vector (then, arr will be NULL afterwards).
405 #define GNUNET_array_grow(arr,size,tsize) GNUNET_xgrow_((void**)&arr, sizeof(arr[0]), &size, tsize, __FILE__, __LINE__)
408 * Append an element to a list (growing the
411 #define GNUNET_array_append(arr,size,element) do { GNUNET_array_grow(arr,size,size+1); arr[size-1] = element; } while(0)
414 * Like snprintf, just aborts if the buffer is of insufficient size.
416 int GNUNET_snprintf (char *buf, size_t size, const char *format, ...);
419 * Like asprintf, just portable.
421 int GNUNET_asprintf (char **buf, const char *format, ...);
424 /* ************** internal implementations, use macros above! ************** */
427 * Allocate memory. Checks the return value, aborts if no more
428 * memory is available. Don't use GNUNET_xmalloc_ directly. Use the
429 * GNUNET_malloc macro.
430 * The memory will be zero'ed out.
432 void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber);
435 * Allocate memory. This function does not check if the
436 * allocation request is within reasonable bounds, allowing
437 * allocations larger than 40 MB. If you don't expect the
438 * possibility of very large allocations, use GNUNET_malloc instead.
439 * The memory will be zero'ed out.
441 void *GNUNET_xmalloc_unchecked_ (size_t size,
442 const char *filename, int linenumber);
445 * Reallocate memory. Checks the return value, aborts if no more
446 * memory is available.
448 void *GNUNET_xrealloc_ (void *ptr,
449 const size_t n, const char *filename, int linenumber);
452 * Free memory. Merely a wrapper for the case that we
453 * want to keep track of allocations. Don't use GNUNET_xfree_
454 * directly. Use the GNUNET_free macro.
456 void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber);
460 * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.
462 char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber);
465 * Grow an array, the new elements are zeroed out.
466 * Grows old by (*oldCount-newCount)*elementSize
467 * bytes and sets *oldCount to newCount.
469 * Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.
471 * @param old address of the pointer to the array
473 * @param elementSize the size of the elements of the array
474 * @param oldCount address of the number of elements in the *old array
475 * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
477 void GNUNET_xgrow_ (void **old,
479 unsigned int *oldCount,
480 unsigned int newCount,
481 const char *filename, int linenumber);
486 #if __STDC_VERSION__ < 199901L
488 # define __func__ __FUNCTION__
490 # define __func__ "<unknown>"
494 #endif /*GNUNET_COMMON_H_ */