X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_common.h;h=cecc94c9edc5787b9aee02b2ea2bf5e1d5bd97f1;hb=d583ad46d4babd962f362deac20fa5aa6cdce7c7;hp=0639ba0a275a10c3c2b4a2e38c709d79c62258c6;hpb=1d4f263c97c34dd9c9a556fc4d9e3e1dc015c338;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h index 0639ba0a2..cecc94c9e 100644 --- a/src/include/gnunet_common.h +++ b/src/include/gnunet_common.h @@ -39,17 +39,17 @@ #ifdef MINGW #include "winproc.h" #endif +#ifdef HAVE_STDINT_H +#include +#endif +#ifdef HAVE_STDARG_H +#include +#endif /** * Version of the API (for entire gnunetutil.so library). */ -#define GNUNET_UTIL_VERSION 0x00000000 - -/** - * Name used for "services" that are actually command-line - * programs invoked by the end user. - */ -#define GNUNET_CLIENT_SERVICE_NAME "client" +#define GNUNET_UTIL_VERSION 0x00090100 /** * Named constants for return values. The following @@ -66,14 +66,87 @@ #define GNUNET_MAX(a,b) (((a) > (b)) ? (a) : (b)) +/** + * Endian operations + */ + +# if __BYTE_ORDER == __LITTLE_ENDIAN +# define GNUNET_htobe16(x) __bswap_16 (x) +# define GNUNET_htole16(x) (x) +# define GNUNET_be16toh(x) __bswap_16 (x) +# define GNUNET_le16toh(x) (x) + +# define GNUNET_htobe32(x) __bswap_32 (x) +# define GNUNET_htole32(x) (x) +# define GNUNET_be32toh(x) __bswap_32 (x) +# define GNUNET_le32toh(x) (x) + +# define GNUNET_htobe64(x) __bswap_64 (x) +# define GNUNET_htole64(x) (x) +# define GNUNET_be64toh(x) __bswap_64 (x) +# define GNUNET_le64toh(x) (x) +#endif +# if __BYTE_ORDER == __BIG_ENDIAN +# define GNUNET_htobe16(x) (x) +# define GNUNET_htole16(x) __bswap_16 (x) +# define GNUNET_be16toh(x) (x) +# define GNUNET_le16toh(x) __bswap_16 (x) + +# define GNUNET_htobe32(x) (x) +# define GNUNET_htole32(x) __bswap_32 (x) +# define GNUNET_be32toh(x) (x) +# define GNUNET_le32toh(x) __bswap_32 (x) + +# define GNUNET_htobe64(x) (x) +# define GNUNET_htole64(x) __bswap_64 (x) +# define GNUNET_be64toh(x) (x) +# define GNUNET_le64toh(x) __bswap_64 (x) +#endif + + + + /** * gcc-ism to get packed structs. */ #define GNUNET_PACKED __attribute__((packed)) +/** + * gcc-ism to document unused arguments + */ +#define GNUNET_UNUSED __attribute__((unused)) + +#if __GNUC__ > 3 +/** + * gcc 4.x-ism to pack structures even on W32 (to be used before structs) + */ +#define GNUNET_NETWORK_STRUCT_BEGIN \ + _Pragma("pack(push)") \ + _Pragma("pack(1)") + +/** + * gcc 4.x-ism to pack structures even on W32 (to be used after structs) + */ +#define GNUNET_NETWORK_STRUCT_END _Pragma("pack(pop)") +#else +#ifdef MINGW +#error gcc 4.x or higher required on W32 systems +#endif +/** + * Good luck, GNUNET_PACKED should suffice, but this won't work on W32 + */ +#define GNUNET_NETWORK_STRUCT_BEGIN + +/** + * Good luck, GNUNET_PACKED should suffice, but this won't work on W32 + */ +#define GNUNET_NETWORK_STRUCT_END +#endif /* ************************ super-general types *********************** */ +GNUNET_NETWORK_STRUCT_BEGIN + /** * Header for all communications. */ @@ -92,7 +165,7 @@ struct GNUNET_MessageHeader uint16_t type GNUNET_PACKED; }; - +GNUNET_NETWORK_STRUCT_END /** * @brief 512-bit hashcode @@ -104,6 +177,8 @@ typedef struct GNUNET_HashCode; +GNUNET_NETWORK_STRUCT_BEGIN + /** * The identity of the host (basically the SHA-512 hashcode of * it's public key). @@ -112,7 +187,7 @@ struct GNUNET_PeerIdentity { GNUNET_HashCode hashPubKey GNUNET_PACKED; }; - +GNUNET_NETWORK_STRUCT_END /** * Function called with a filename. @@ -132,6 +207,8 @@ typedef int (*GNUNET_FileNameCallback) (void *cls, const char *filename); */ enum GNUNET_ErrorType { + GNUNET_ERROR_TYPE_UNSPECIFIED = -1, + GNUNET_ERROR_TYPE_NONE = 0, GNUNET_ERROR_TYPE_ERROR = 1, GNUNET_ERROR_TYPE_WARNING = 2, GNUNET_ERROR_TYPE_INFO = 4, @@ -140,6 +217,7 @@ enum GNUNET_ErrorType GNUNET_ERROR_TYPE_BULK = 32 }; + /** * User-defined handler for log messages. * @@ -149,11 +227,21 @@ enum GNUNET_ErrorType * @param date when was the message logged? * @param message what is the message */ -typedef void (*GNUNET_Logger) (void *cls, - enum GNUNET_ErrorType kind, - const char *component, - const char *date, const char *message); +typedef void (*GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind, + const char *component, const char *date, + const char *message); + +/** + * Number of log calls to ignore. + */ +extern unsigned int skip_log; + +#if !defined(GNUNET_CULL_LOGGING) +int +GNUNET_get_log_call_status (int caller_level, const char *comp, + const char *file, const char *function, int line); +#endif /** * Main log function. * @@ -161,9 +249,30 @@ typedef void (*GNUNET_Logger) (void *cls, * @param message what is the message (format string) * @param ... arguments for format string */ -void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...); - +void +GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...); + +/* from glib */ +#if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__) +#define _GNUNET_BOOLEAN_EXPR(expr) \ + __extension__ ({ \ + int _gnunet_boolean_var_; \ + if (expr) \ + _gnunet_boolean_var_ = 1; \ + else \ + _gnunet_boolean_var_ = 0; \ + _gnunet_boolean_var_; \ +}) +#define GN_LIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 1)) +#define GN_UNLIKELY(expr) (__builtin_expect (_GNUNET_BOOLEAN_EXPR(expr), 0)) +#else +#define GN_LIKELY(expr) (expr) +#define GN_UNLIKELY(expr) (expr) +#endif +#if !defined(GNUNET_LOG_CALL_STATUS) +#define GNUNET_LOG_CALL_STATUS -1 +#endif /** * Log function that specifies an alternative component. @@ -175,9 +284,42 @@ void GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...); * @param ... arguments for format string */ void -GNUNET_log_from (enum GNUNET_ErrorType kind, - const char *comp, const char *message, ...); +GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp, + const char *message, ...); + +#if !defined(GNUNET_CULL_LOGGING) +#define GNUNET_log_from(kind,comp,...) do { int log_line = __LINE__;\ + static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\ + if (GN_UNLIKELY(log_call_enabled == -1))\ + log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), comp, __FILE__, __FUNCTION__, log_line);\ + if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\ + else {\ + if (GN_UNLIKELY(log_call_enabled))\ + GNUNET_log_from_nocheck (kind, comp, __VA_ARGS__);\ + }\ +} while (0) + +#define GNUNET_log(kind,...) do { int log_line = __LINE__;\ + static int log_call_enabled = GNUNET_LOG_CALL_STATUS;\ + if (GN_UNLIKELY(log_call_enabled == -1))\ + log_call_enabled = GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), NULL, __FILE__, __FUNCTION__, log_line);\ + if (GN_UNLIKELY(skip_log > 0)) {skip_log--;}\ + else {\ + if (GN_UNLIKELY(log_call_enabled))\ + GNUNET_log_nocheck (kind, __VA_ARGS__);\ + }\ +} while (0) +#else +#define GNUNET_log(...) +#define GNUNET_log_from(...) +#endif + +/** + * Abort the process, generate a core dump if possible. + */ +void +GNUNET_abort (void); /** * Ignore the next n calls to the log function. @@ -198,8 +340,8 @@ GNUNET_log_skip (unsigned int n, int check_reset); * @return GNUNET_OK on success, GNUNET_SYSERR if logfile could not be opened */ int -GNUNET_log_setup (const char *comp, - const char *loglevel, const char *logfile); +GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile); + /** * Add a custom logger. @@ -207,7 +349,9 @@ GNUNET_log_setup (const char *comp, * @param logger log function * @param logger_cls closure for logger */ -void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls); +void +GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls); + /** * Remove a custom logger. @@ -215,7 +359,8 @@ void GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls); * @param logger log function * @param logger_cls closure for logger */ -void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls); +void +GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls); /** @@ -224,9 +369,23 @@ void GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls); * NOT reentrant! * * @param hc the hash code - * @return string + * @return string */ -const char *GNUNET_h2s (const GNUNET_HashCode *hc); +const char * +GNUNET_h2s (const GNUNET_HashCode * hc); + + +/** + * Convert a hash value to a string (for printing debug messages). + * This prints all 104 characters of a hashcode! + * This is one of the very few calls in the entire API that is + * NOT reentrant! + * + * @param hc the hash code + * @return string + */ +const char * +GNUNET_h2s_full (const GNUNET_HashCode * hc); /** @@ -238,7 +397,8 @@ const char *GNUNET_h2s (const GNUNET_HashCode *hc); * @return string form of the pid; will be overwritten by next * call to GNUNET_i2s. */ -const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid); +const char * +GNUNET_i2s (const struct GNUNET_PeerIdentity *pid); /** @@ -251,8 +411,8 @@ const char *GNUNET_i2s (const struct GNUNET_PeerIdentity *pid); * @return nicely formatted string for the address * will be overwritten by next call to GNUNET_a2s. */ -const char *GNUNET_a2s (const struct sockaddr *addr, - socklen_t addrlen); +const char * +GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen); /** * Convert error type to string. @@ -260,17 +420,19 @@ const char *GNUNET_a2s (const struct sockaddr *addr, * @param kind type to convert * @return string corresponding to the type */ -const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind); +const char * +GNUNET_error_type_to_string (enum GNUNET_ErrorType kind); + /** * Use this for fatal errors that cannot be handled */ -#define GNUNET_assert(cond) do { if (! (cond)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, _("Assertion failed at %s:%d.\n"), __FILE__, __LINE__); abort(); } } while(0) +#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) /** * Use this for fatal errors that cannot be handled */ -#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) +#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) /** * Use this for internal assertion violations that are @@ -286,7 +448,7 @@ const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind); * we still want to see these problems during * development and testing. "OP == other peer". */ -#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) +#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) /** * Log an error message at log-level 'level' that indicates @@ -295,6 +457,13 @@ const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind); */ #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) +/** + * Log an error message at log-level 'level' that indicates + * a failure of the command 'cmd' with the message given + * by strerror(errno). + */ +#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) + /** * Log an error message at log-level 'level' that indicates * a failure of the command 'cmd' with the message given @@ -302,21 +471,30 @@ const char *GNUNET_error_type_to_string (enum GNUNET_ErrorType kind); */ #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) +/** + * Log an error message at log-level 'level' that indicates + * a failure of the command 'cmd' with the message given + * by strerror(errno). + */ +#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) + /* ************************* endianess conversion ****************** */ /** - * Convert a long-long to host-byte-order. + * Convert unsigned 64-bit integer to host-byte-order. * @param n the value in network byte order * @return the same value in host byte order */ -unsigned long long GNUNET_ntohll (unsigned long long n); +uint64_t +GNUNET_ntohll (uint64_t n); /** - * Convert a long long to network-byte-order. + * Convert unsigned 64-bit integer to network-byte-order. * @param n the value in host byte order * @return the same value in network byte order */ -unsigned long long GNUNET_htonll (unsigned long long n); +uint64_t +GNUNET_htonll (uint64_t n); /* ************************* allocation functions ****************** */ @@ -336,6 +514,15 @@ unsigned long long GNUNET_htonll (unsigned long long n); */ #define GNUNET_malloc(size) GNUNET_xmalloc_(size, __FILE__, __LINE__) +/** + * Allocate and initialize a block of memory. + * + * @param buf data to initalize the block with + * @param size the number of bytes in buf (and size of the allocation) + * @return pointer to size bytes of memory, never NULL (!) + */ +#define GNUNET_memdup(buf,size) GNUNET_xmemdup_(buf, size, __FILE__, __LINE__) + /** * Wrapper around malloc. Allocates size bytes of memory. * The memory will be zero'ed out. @@ -360,7 +547,7 @@ unsigned long long GNUNET_htonll (unsigned long long n); * allocated with GNUNET_array_grow using GNUNET_array_grow(mem, size, 0) instead of GNUNET_free. * * @param ptr location where to free the memory. ptr must have - * been returned by GNUNET_strdup, GNUNET_malloc or GNUNET_array_grow earlier. + * been returned by GNUNET_strdup, GNUNET_strndup, GNUNET_malloc or GNUNET_array_grow earlier. */ #define GNUNET_free(ptr) GNUNET_xfree_(ptr, __FILE__, __LINE__) @@ -381,6 +568,16 @@ unsigned long long GNUNET_htonll (unsigned long long n); */ #define GNUNET_strdup(a) GNUNET_xstrdup_(a,__FILE__,__LINE__) +/** + * Wrapper around GNUNET_strndup. Makes a partial copy of the string + * pointed to by a. + * + * @param a pointer to a string + * @param length of the string to duplicate + * @return a partial copy of the string including zero-termination + */ +#define GNUNET_strndup(a,length) GNUNET_xstrndup_(a,length,__FILE__,__LINE__) + /** * Grow a well-typed (!) array. This is a convenience * method to grow a vector arr of size size @@ -431,7 +628,8 @@ unsigned long long GNUNET_htonll (unsigned long long n); * @param ... data for format string * @return number of bytes written to buf or negative value on error */ -int GNUNET_snprintf (char *buf, size_t size, const char *format, ...); +int +GNUNET_snprintf (char *buf, size_t size, const char *format, ...); /** @@ -442,7 +640,8 @@ int GNUNET_snprintf (char *buf, size_t size, const char *format, ...); * @param ... data for format string * @return number of bytes in "*buf" excluding 0-termination */ -int GNUNET_asprintf (char **buf, const char *format, ...); +int +GNUNET_asprintf (char **buf, const char *format, ...); /* ************** internal implementations, use macros above! ************** */ @@ -458,7 +657,24 @@ int GNUNET_asprintf (char **buf, const char *format, ...); * @param linenumber line where this call is being made (for debugging) * @return allocated memory, never NULL */ -void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber); +void * +GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber); + + +/** + * Allocate and initialize memory. Checks the return value, aborts if no more + * memory is available. Don't use GNUNET_xmemdup_ directly. Use the + * GNUNET_memdup macro. + * + * @param buf buffer to initialize from (must contain size bytes) + * @param size number of bytes to allocate + * @param filename where is this call being made (for debugging) + * @param linenumber line where this call is being made (for debugging) + * @return allocated memory, never NULL + */ +void * +GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename, + int linenumber); /** @@ -473,15 +689,15 @@ void *GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber); * @param linenumber line where this call is being made (for debugging) * @return pointer to size bytes of memory, NULL if we do not have enough memory */ -void *GNUNET_xmalloc_unchecked_ (size_t size, - const char *filename, int linenumber); +void * +GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber); /** * Reallocate memory. Checks the return value, aborts if no more * memory is available. */ -void *GNUNET_xrealloc_ (void *ptr, - const size_t n, const char *filename, int linenumber); +void * +GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber); /** * Free memory. Merely a wrapper for the case that we @@ -492,7 +708,8 @@ void *GNUNET_xrealloc_ (void *ptr, * @param filename where is this call being made (for debugging) * @param linenumber line where this call is being made (for debugging) */ -void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber); +void +GNUNET_xfree_ (void *ptr, const char *filename, int linenumber); /** @@ -502,7 +719,21 @@ void GNUNET_xfree_ (void *ptr, const char *filename, int linenumber); * @param linenumber line where this call is being made (for debugging) * @return the duplicated string */ -char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber); +char * +GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber); + +/** + * Dup partially a string. Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro. + * + * @param str string to duplicate + * @param len length of the string to duplicate + * @param filename where is this call being made (for debugging) + * @param linenumber line where this call is being made (for debugging) + * @return the duplicated string + */ +char * +GNUNET_xstrndup_ (const char *str, size_t len, const char *filename, + int linenumber); /** * Grow an array, the new elements are zeroed out. @@ -519,21 +750,27 @@ char *GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber); * @param filename where is this call being made (for debugging) * @param linenumber line where this call is being made (for debugging) */ -void GNUNET_xgrow_ (void **old, - size_t elementSize, - unsigned int *oldCount, - unsigned int newCount, - const char *filename, int linenumber); +void +GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount, + unsigned int newCount, const char *filename, int linenumber); +/** + * Create a copy of the given message. + * + * @param msg message to copy + * @return duplicate of the message + */ +struct GNUNET_MessageHeader * +GNUNET_copy_message (const struct GNUNET_MessageHeader *msg); #if __STDC_VERSION__ < 199901L -# if __GNUC__ >= 2 -# define __func__ __FUNCTION__ -# else -# define __func__ "" -# endif +#if __GNUC__ >= 2 +#define __func__ __FUNCTION__ +#else +#define __func__ "" +#endif #endif #endif /*GNUNET_COMMON_H_ */