gnunet_common.h File Reference

commonly used definitions; globals in this file are exempt from the rule that the module name ("common") must be part of the symbol name. More...

#include <stdlib.h>
#include "gettext.h"

Include dependency graph for gnunet_common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_HashCode
	A 512-bit hashcode. More...
struct	GNUNET_ShortHashCode
	A 256-bit hashcode. More...
struct	GNUNET_Uuid
	A UUID, a 128 bit "random" value. More...
struct	GNUNET_MessageHeader
	Header for all communications. More...
struct	GNUNET_OperationResultMessage
	Answer from service to client about last operation. More...
struct	GNUNET_AsyncScopeId
	Identifier for an asynchronous execution context. More...
struct	GNUNET_AsyncScopeSave
	Saved async scope identifier or root scope. More...

Macros
#define	GNUNET_UTIL_VERSION   0x000A0104
	Version of the API (for entire gnunetutil.so library). More...
#define	GNUNET_MIN(a, b)   (((a) < (b)) ? (a) : (b))
#define	GNUNET_MAX(a, b)   (((a) > (b)) ? (a) : (b))
#define	GNUNET_VA_ARG_ENUM(va, X)   ((enum X) va_arg (va, int))
	wrap va_arg for enums More...
#define	GNUNET_EXTRA_LOGGING   1
	define GNUNET_EXTRA_LOGGING if using this header outside the GNUnet source tree where gnunet_config.h is unavailable More...
#define	BYTE_SWAP_16(x)   ((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))
	Endian operations. More...
#define	BYTE_SWAP_32(x)
#define	BYTE_SWAP_64(x)
#define	GNUNET_htobe16(x)   BYTE_SWAP_16 (x)
#define	GNUNET_htole16(x)   (x)
#define	GNUNET_be16toh(x)   BYTE_SWAP_16 (x)
#define	GNUNET_le16toh(x)   (x)
#define	GNUNET_htobe32(x)   BYTE_SWAP_32 (x)
#define	GNUNET_htole32(x)   (x)
#define	GNUNET_be32toh(x)   BYTE_SWAP_32 (x)
#define	GNUNET_le32toh(x)   (x)
#define	GNUNET_htobe64(x)   BYTE_SWAP_64 (x)
#define	GNUNET_htole64(x)   (x)
#define	GNUNET_be64toh(x)   BYTE_SWAP_64 (x)
#define	GNUNET_le64toh(x)   (x)
#define	GNUNET_htobe16(x)   (x)
#define	GNUNET_htole16(x)   BYTE_SWAP_16 (x)
#define	GNUNET_be16toh(x)   (x)
#define	GNUNET_le16toh(x)   BYTE_SWAP_16 (x)
#define	GNUNET_htobe32(x)   (x)
#define	GNUNET_htole32(x)   BYTE_SWAP_32 (x)
#define	GNUNET_be32toh(x)   (x)
#define	GNUNET_le32toh(x)   BYTE_SWAP_32 (x)
#define	GNUNET_htobe64(x)   (x)
#define	GNUNET_htole64(x)   BYTE_SWAP_64 (x)
#define	GNUNET_be64toh(x)   (x)
#define	GNUNET_le64toh(x)   BYTE_SWAP_64 (x)
#define	GNUNET_NZL(l)   GNUNET_MAX (1, l)
	Macro used to avoid using 0 for the length of a variable-size array (Non-Zero-Length). More...
#define	GNUNET_PACKED   __attribute__ ((packed))
	gcc-ism to get packed structs. More...
#define	GNUNET_GCC_STRUCT_LAYOUT
	gcc-ism to get gcc bitfield layout when compiling with -mms-bitfields More...
#define	GNUNET_ALIGN   __attribute__ ((aligned (8)))
	gcc-ism to force alignment; we use this to align char-arrays that may then be cast to 'struct's. More...
#define	GNUNET_UNUSED   __attribute__ ((unused))
	gcc-ism to document unused arguments More...
#define	GNUNET_NORETURN   __attribute__ ((noreturn))
	gcc-ism to document functions that don't return More...
#define	GNUNET_NETWORK_STRUCT_BEGIN
	Define as empty, GNUNET_PACKED should suffice, but this won't work on W32. More...
#define	GNUNET_NETWORK_STRUCT_END
	Define as empty, GNUNET_PACKED should suffice, but this won't work on W32;. More...
#define	GN_LIKELY(expr)   (expr)
#define	GN_UNLIKELY(expr)   (expr)
#define	GNUNET_LOG_CALL_STATUS   -1
#define	GNUNET_log_from(kind, comp, ...)
#define	GNUNET_log(kind, ...)
#define	GNUNET_assert(cond)
	Use this for fatal errors that cannot be handled. More...
#define	GNUNET_assert_at(cond, f, l)
	Use this for fatal errors that cannot be handled. More...
#define	GNUNET_assert_from(cond, comp)
	Use this for fatal errors that cannot be handled. More...
#define	GNUNET_static_assert(cond)   GNUNET_assert (cond)
	Assertion to be checked (if supported by C compiler) at compile time, otherwise checked at runtime and resulting in an abort() on failure. More...
#define	GNUNET_break(cond)
	Use this for internal assertion violations that are not fatal (can be handled) but should not occur. More...
#define	GNUNET_break_op(cond)
	Use this for assertion violations caused by other peers (i.e. More...
#define	GNUNET_log_strerror(level, cmd)
	Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the message given by strerror(errno). More...
#define	GNUNET_log_from_strerror(level, component, cmd)
	Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the message given by strerror(errno). More...
#define	GNUNET_log_strerror_file(level, cmd, filename)
	Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the message given by strerror(errno). More...
#define	GNUNET_log_from_strerror_file(level, component, cmd, filename)
	Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the message given by strerror(errno). More...
#define	GNUNET_MAX_MALLOC_CHECKED   (1024 * 1024 * 40)
	Maximum allocation with GNUNET_malloc macro. More...
#define	GNUNET_new(type)   (type *) GNUNET_malloc (sizeof(type))
	Allocate a struct or union of the given type. More...
#define	GNUNET_memcmp(a, b)
	Compare memory in a and b, where both must be of the same pointer type. More...
#define	GNUNET_memcmp_priv(a, b)
	Compare memory in a and b in constant time, suitable for private data. More...
#define	GNUNET_is_zero(a)    GNUNET_is_zero_ (a, sizeof (*a))
	Check that memory in a is all zeros. More...
#define	GNUNET_memcpy(dst, src, n)
	Call memcpy() but check for n being 0 first. More...
#define	GNUNET_new_array(n, type)
	Allocate a size n array with structs or unions of the given type. More...
#define	GNUNET_new_array_2d(n, m, type)    (type **) GNUNET_xnew_array_2d_ (n, m, sizeof(type), __FILE__, __LINE__)
	Allocate a size n times m array with structs or unions of the given type. More...
#define	GNUNET_new_array_3d(n, m, o, type)    (type ***) GNUNET_xnew_array_3d_ (n, m, o, sizeof(type), __FILE__, __LINE__)
	Allocate a size n times m times o array with structs or unions of the given type. More...
#define	GNUNET_malloc(size)   GNUNET_xmalloc_ (size, __FILE__, __LINE__)
	Wrapper around malloc. More...
#define	GNUNET_memdup(buf, size)   GNUNET_xmemdup_ (buf, size, __FILE__, __LINE__)
	Allocate and initialize a block of memory. More...
#define	GNUNET_malloc_large(size)    GNUNET_xmalloc_unchecked_ (size, __FILE__, __LINE__)
	Wrapper around malloc. More...
#define	GNUNET_realloc(ptr, size)    GNUNET_xrealloc_ (ptr, size, __FILE__, __LINE__)
	Wrapper around realloc. More...
#define	GNUNET_free_nz(ptr)   GNUNET_xfree_ (ptr, __FILE__, __LINE__)
	Wrapper around free. More...
#define	GNUNET_free(ptr)
	Wrapper around free. More...
#define	GNUNET_strdup(a)   GNUNET_xstrdup_ (a, __FILE__, __LINE__)
	Wrapper around GNUNET_xstrdup_. More...
#define	GNUNET_strndup(a, length)    GNUNET_xstrndup_ (a, length, __FILE__, __LINE__)
	Wrapper around GNUNET_xstrndup_. More...
#define	GNUNET_array_grow(arr, size, tsize)
	Grow a well-typed (!) array. More...
#define	GNUNET_array_append(arr, len, element)
	Append an element to an array (growing the array by one). More...
#define	GNUNET_array_concatenate(arr1, len1, arr2, len2)
	Append arr2 to arr1 (growing arr1 as needed). More...
#define	__func__   "<unknown>"

Typedefs
typedef enum GNUNET_GenericReturnValue(*	GNUNET_FileNameCallback) (void *cls, const char *filename)
	Function called with a filename. More...
typedef void(*	GNUNET_ContinuationCallback) (void *cls)
	Generic continuation callback. More...
typedef void(*	GNUNET_ResultCallback) (void *cls, int64_t result_code, const void *data, uint16_t data_size)
	Function called with the result of an asynchronous operation. More...
typedef void(*	GNUNET_Logger) (void *cls, enum GNUNET_ErrorType kind, const char *component, const char *date, const char *message)
	User-defined handler for log messages. More...

Enumerations
enum	GNUNET_GenericReturnValue { GNUNET_SYSERR = -1 , GNUNET_NO = 0 , GNUNET_OK = 1 , GNUNET_YES = 1 }
	Named constants for return values. More...
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_MESSAGE = 4 , GNUNET_ERROR_TYPE_INFO = 8 , GNUNET_ERROR_TYPE_DEBUG = 16 , GNUNET_ERROR_TYPE_INVALID = 32 ,   GNUNET_ERROR_TYPE_BULK = 64 }
	Types of errors. More...
enum	GNUNET_SCHEDULER_Priority {   GNUNET_SCHEDULER_PRIORITY_KEEP = 0 , GNUNET_SCHEDULER_PRIORITY_IDLE = 1 , GNUNET_SCHEDULER_PRIORITY_BACKGROUND = 2 , GNUNET_SCHEDULER_PRIORITY_DEFAULT = 3 ,   GNUNET_SCHEDULER_PRIORITY_HIGH = 4 , GNUNET_SCHEDULER_PRIORITY_UI = 5 , GNUNET_SCHEDULER_PRIORITY_URGENT = 6 , GNUNET_SCHEDULER_PRIORITY_SHUTDOWN = 7 ,   GNUNET_SCHEDULER_PRIORITY_COUNT = 8 }
	Valid task priorities. More...

Functions
int	GNUNET_get_log_skip (void)
	Get the number of log calls that are going to be skipped. More...
int	GNUNET_get_log_call_status (int caller_level, const char *comp, const char *file, const char *function, int line)
	Decides whether a particular logging call should or should not be allowed to be made. More...
void	GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message,...) __attribute__((format(printf
	Main log function. More...
void	GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp, const char *message,...) __attribute__((format(printf
	Log function that specifies an alternative component. More...
void	GNUNET_log_config_missing (enum GNUNET_ErrorType kind, const char *section, const char *option)
	Log error message about missing configuration option. More...
void	GNUNET_log_config_invalid (enum GNUNET_ErrorType kind, const char *section, const char *option, const char *required)
	Log error message about invalid configuration option value. More...
void	GNUNET_abort_ (void) __attribute__((noreturn))
	Abort the process, generate a core dump if possible. More...
void	GNUNET_log_skip (int n, int check_reset)
	Ignore the next n calls to the log function. More...
int	GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
	Setup logging. More...
void	GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
	Add a custom logger. More...
void	GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
	Remove a custom logger. More...
const char *	GNUNET_sh2s (const struct GNUNET_ShortHashCode *shc)
	Convert a short hash value to a string (for printing debug messages). More...
const char *	GNUNET_uuid2s (const struct GNUNET_Uuid *uuid)
	Convert a UUID to a string (for printing debug messages). More...
const char *	GNUNET_h2s (const struct GNUNET_HashCode *hc)
	Convert a hash value to a string (for printing debug messages). More...
const char *	GNUNET_h2s2 (const struct GNUNET_HashCode *hc)
	Convert a hash value to a string (for printing debug messages). More...
const char *	GNUNET_h2s_full (const struct GNUNET_HashCode *hc)
	Convert a hash value to a string (for printing debug messages). More...
const char *	GNUNET_p2s (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
	Convert a public key value to a string (for printing debug messages). More...
const char *	GNUNET_p2s2 (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
	Convert a public key value to a string (for printing debug messages). More...
const char *	GNUNET_e2s (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
	Convert a public key value to a string (for printing debug messages). More...
const char *	GNUNET_e2s2 (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
	Convert a public key value to a string (for printing debug messages). More...
const char *	GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
	Convert a peer identity to a string (for printing debug messages). More...
const char *	GNUNET_i2s2 (const struct GNUNET_PeerIdentity *pid)
	Convert a peer identity to a string (for printing debug messages). More...
const char *	GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid)
	Convert a peer identity to a string (for printing debug messages). More...
const char *	GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
	Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string (for printing debug messages). More...
const char *	GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
	Convert error type to string. More...
uint64_t	GNUNET_htonll (uint64_t n)
	Convert unsigned 64-bit integer to network byte order. More...
uint64_t	GNUNET_ntohll (uint64_t n)
	Convert unsigned 64-bit integer to host byte order. More...
double	GNUNET_hton_double (double d)
	Convert double to network byte order. More...
double	GNUNET_ntoh_double (double d)
	Convert double to host byte order. More...
int	GNUNET_memcmp_ct_ (const void *b1, const void *b2, size_t len)
	Compare memory in b1 and b2 in constant time, suitable for private data. More...
enum GNUNET_GenericReturnValue	GNUNET_is_zero_ (const void *a, size_t n)
	Check that memory in a is all zeros. More...
int	GNUNET_snprintf (char *buf, size_t size, const char *format,...) __attribute__((format(printf
	Like snprintf, just aborts if the buffer is of insufficient size. More...
int int	GNUNET_asprintf (char **buf, const char *format,...) __attribute__((format(printf
	Like asprintf, just portable. More...
int int void *	GNUNET_xmalloc_ (size_t size, const char *filename, int linenumber)
	Allocate memory. More...
void **	GNUNET_xnew_array_2d_ (size_t n, size_t m, size_t elementSize, const char *filename, int linenumber)
	Allocate memory for a two dimensional array in one block and set up pointers. More...
void ***	GNUNET_xnew_array_3d_ (size_t n, size_t m, size_t o, size_t elementSize, const char *filename, int linenumber)
	Allocate memory for a three dimensional array in one block and set up pointers. More...
void *	GNUNET_xmemdup_ (const void *buf, size_t size, const char *filename, int linenumber)
	Allocate and initialize memory. More...
void *	GNUNET_xmalloc_unchecked_ (size_t size, const char *filename, int linenumber)
	Allocate memory. More...
void *	GNUNET_xrealloc_ (void *ptr, size_t n, const char *filename, int linenumber)
	Reallocate memory. More...
void	GNUNET_xfree_ (void *ptr, const char *filename, int linenumber)
	Free memory. More...
char *	GNUNET_xstrdup_ (const char *str, const char *filename, int linenumber)
	Dup a string. More...
char *	GNUNET_xstrndup_ (const char *str, size_t len, const char *filename, int linenumber)
	Dup partially a string. More...
void	GNUNET_xgrow_ (void **old, size_t elementSize, unsigned int *oldCount, unsigned int newCount, const char *filename, int linenumber)
	Grow an array, the new elements are zeroed out. More...
struct GNUNET_MessageHeader *	GNUNET_copy_message (const struct GNUNET_MessageHeader *msg)
	Create a copy of the given message. More...
void	GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid, struct GNUNET_AsyncScopeSave *old_scope)
	Set the async scope for the current thread. More...
void	GNUNET_async_scope_restore (struct GNUNET_AsyncScopeSave *old_scope)
	Clear the current thread's async scope. More...
void	GNUNET_async_scope_get (struct GNUNET_AsyncScopeSave *scope_ret)
	Get the current async scope. More...
void	GNUNET_async_scope_fresh (struct GNUNET_AsyncScopeId *aid_ret)
	Generate a fresh async scope identifier. More...

Detailed Description

commonly used definitions; globals in this file are exempt from the rule that the module name ("common") must be part of the symbol name.

Author

Christian Grothoff

Nils Durner

Martin Schanzenbach

Definition in file gnunet_common.h.

Macro Definition Documentation

GNUNET_UTIL_VERSION

#define GNUNET_UTIL_VERSION   0x000A0104

Version of the API (for entire gnunetutil.so library).

Definition at line 82 of file gnunet_common.h.

GNUNET_MIN

#define GNUNET_MIN	(		a,
			b
	)		(((a) < (b)) ? (a) : (b))

Definition at line 101 of file gnunet_common.h.

GNUNET_MAX

#define GNUNET_MAX	(		a,
			b
	)		(((a) > (b)) ? (a) : (b))

Definition at line 103 of file gnunet_common.h.

GNUNET_VA_ARG_ENUM

#define GNUNET_VA_ARG_ENUM	(		va,
			X
	)		((enum X) va_arg (va, int))

wrap va_arg for enums

Definition at line 137 of file gnunet_common.h.

BYTE_SWAP_16

#define BYTE_SWAP_16

(

x

)

((((x) & 0x00ff) << 8) | (((x) & 0xff00) >> 8))

Endian operations.

Definition at line 159 of file gnunet_common.h.

BYTE_SWAP_32

#define BYTE_SWAP_32

(

x

)

Value:

  ((((x) & 0x000000ffU) << 24) | (((x) & 0x0000ff00U) << 8)   \
   | (((x) & 0x00ff0000U) >> 8) | (((x) & 0xff000000U) >> 24))

Definition at line 161 of file gnunet_common.h.

BYTE_SWAP_64

#define BYTE_SWAP_64

(

x

)

Value:

  ((((x) & 0x00000000000000ffUL) << 56) | (((x) & 0x000000000000ff00UL) << 40)   \
   | (((x) & 0x0000000000ff0000UL) << 24) | (((x) & 0x00000000ff000000UL) << 8)    \
   | (((x) & 0x000000ff00000000UL) >> 8) | (((x) & 0x0000ff0000000000UL) >> 24)    \
   | (((x) & 0x00ff000000000000UL) >> 40) | (((x) & 0xff00000000000000UL) >> \
                                             56))

Definition at line 165 of file gnunet_common.h.

GNUNET_htobe16 [1/2]

#define GNUNET_htobe16

(

x

)

BYTE_SWAP_16 (x)

Definition at line 189 of file gnunet_common.h.

GNUNET_htole16 [1/2]

#define GNUNET_htole16

(

x

)

(x)

Definition at line 190 of file gnunet_common.h.

GNUNET_be16toh [1/2]

#define GNUNET_be16toh

(

x

)

BYTE_SWAP_16 (x)

Definition at line 191 of file gnunet_common.h.

GNUNET_le16toh [1/2]

#define GNUNET_le16toh

(

x

)

(x)

Definition at line 192 of file gnunet_common.h.

GNUNET_htobe32 [1/2]

#define GNUNET_htobe32

(

x

)

BYTE_SWAP_32 (x)

Definition at line 194 of file gnunet_common.h.

GNUNET_htole32 [1/2]

#define GNUNET_htole32

(

x

)

(x)

Definition at line 195 of file gnunet_common.h.

GNUNET_be32toh [1/2]

#define GNUNET_be32toh

(

x

)

BYTE_SWAP_32 (x)

Definition at line 196 of file gnunet_common.h.

GNUNET_le32toh [1/2]

#define GNUNET_le32toh

(

x

)

(x)

Definition at line 197 of file gnunet_common.h.

GNUNET_htobe64 [1/2]

#define GNUNET_htobe64

(

x

)

BYTE_SWAP_64 (x)

Definition at line 199 of file gnunet_common.h.

GNUNET_htole64 [1/2]

#define GNUNET_htole64

(

x

)

(x)

Definition at line 200 of file gnunet_common.h.

GNUNET_be64toh [1/2]

#define GNUNET_be64toh

(

x

)

BYTE_SWAP_64 (x)

Definition at line 201 of file gnunet_common.h.

GNUNET_le64toh [1/2]

#define GNUNET_le64toh

(

x

)

(x)

Definition at line 202 of file gnunet_common.h.

GNUNET_htobe16 [2/2]

#define GNUNET_htobe16

(

x

)

(x)

Definition at line 189 of file gnunet_common.h.

GNUNET_htole16 [2/2]

#define GNUNET_htole16

(

x

)

BYTE_SWAP_16 (x)

Definition at line 190 of file gnunet_common.h.

GNUNET_be16toh [2/2]

#define GNUNET_be16toh

(

x

)

(x)

Definition at line 191 of file gnunet_common.h.

GNUNET_le16toh [2/2]

#define GNUNET_le16toh

(

x

)

BYTE_SWAP_16 (x)

Definition at line 192 of file gnunet_common.h.

GNUNET_htobe32 [2/2]

#define GNUNET_htobe32

(

x

)

(x)

Definition at line 194 of file gnunet_common.h.

GNUNET_htole32 [2/2]

#define GNUNET_htole32

(

x

)

BYTE_SWAP_32 (x)

Definition at line 195 of file gnunet_common.h.

GNUNET_be32toh [2/2]

#define GNUNET_be32toh

(

x

)

(x)

Definition at line 196 of file gnunet_common.h.

GNUNET_le32toh [2/2]

#define GNUNET_le32toh

(

x

)

BYTE_SWAP_32 (x)

Definition at line 197 of file gnunet_common.h.

GNUNET_htobe64 [2/2]

#define GNUNET_htobe64

(

x

)

(x)

Definition at line 199 of file gnunet_common.h.

GNUNET_htole64 [2/2]

#define GNUNET_htole64

(

x

)

BYTE_SWAP_64 (x)

Definition at line 200 of file gnunet_common.h.

GNUNET_be64toh [2/2]

#define GNUNET_be64toh

(

x

)

(x)

Definition at line 201 of file gnunet_common.h.

GNUNET_le64toh [2/2]

#define GNUNET_le64toh

(

x

)

BYTE_SWAP_64 (x)

Definition at line 202 of file gnunet_common.h.

GNUNET_NZL

#define GNUNET_NZL

(

l

)

GNUNET_MAX (1, l)

Macro used to avoid using 0 for the length of a variable-size array (Non-Zero-Length).

Basically, C standard says that "int[n] x;" is undefined if n=0. This was supposed to prevent issues with pointer aliasing. However, C compilers may conclude that n!=0 as n=0 would be undefined, and then optimize under the assumption n!=0, which could cause actual issues. Hence, when initializing an array on the stack with a variable-length that might be zero, write "int[GNUNET_NZL(n)] x;" instead of "int[n] x".

Definition at line 218 of file gnunet_common.h.

GNUNET_PACKED

#define GNUNET_PACKED   __attribute__ ((packed))

gcc-ism to get packed structs.

Definition at line 224 of file gnunet_common.h.

GNUNET_GCC_STRUCT_LAYOUT

#define GNUNET_GCC_STRUCT_LAYOUT

gcc-ism to get gcc bitfield layout when compiling with -mms-bitfields

Definition at line 229 of file gnunet_common.h.

GNUNET_ALIGN

#define GNUNET_ALIGN   __attribute__ ((aligned (8)))

gcc-ism to force alignment; we use this to align char-arrays that may then be cast to 'struct's.

See also gcc bug #33594.

Definition at line 239 of file gnunet_common.h.

GNUNET_UNUSED

#define GNUNET_UNUSED   __attribute__ ((unused))

gcc-ism to document unused arguments

Definition at line 245 of file gnunet_common.h.

GNUNET_NORETURN

#define GNUNET_NORETURN   __attribute__ ((noreturn))

gcc-ism to document functions that don't return

Definition at line 250 of file gnunet_common.h.

GNUNET_NETWORK_STRUCT_BEGIN

#define GNUNET_NETWORK_STRUCT_BEGIN

Define as empty, GNUNET_PACKED should suffice, but this won't work on W32.

Definition at line 255 of file gnunet_common.h.

GNUNET_NETWORK_STRUCT_END

#define GNUNET_NETWORK_STRUCT_END

Define as empty, GNUNET_PACKED should suffice, but this won't work on W32;.

Definition at line 260 of file gnunet_common.h.

GN_LIKELY

#define GN_LIKELY

(

expr

)

(expr)

Definition at line 501 of file gnunet_common.h.

GN_UNLIKELY

#define GN_UNLIKELY

(

expr

)

(expr)

Definition at line 502 of file gnunet_common.h.

GNUNET_LOG_CALL_STATUS

#define GNUNET_LOG_CALL_STATUS   -1

Definition at line 506 of file gnunet_common.h.

GNUNET_log_from

#define GNUNET_log_from	(		kind,
			comp,
			...
	)

Value:

  do                                                                      \
  {                                                                       \
    static int log_call_enabled = GNUNET_LOG_CALL_STATUS;                 \
    if ((GNUNET_EXTRA_LOGGING > 0) ||                                     \
        ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0))                        \
    {                                                                     \
      if (GN_UNLIKELY (log_call_enabled == -1))                           \
        log_call_enabled =                                                \
          GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), \
                                      (comp),                             \
                                      __FILE__,                           \
                                      __FUNCTION__,                       \
                                      __LINE__);                          \
      if (GN_UNLIKELY (GNUNET_get_log_skip () > 0))                       \
      {                                                                   \
        GNUNET_log_skip (-1, GNUNET_NO);                                  \
      }                                                                   \
      else                                                                \
      {                                                                   \
        if (GN_UNLIKELY (log_call_enabled))                               \
          GNUNET_log_from_nocheck ((kind), comp, __VA_ARGS__);            \
      }                                                                   \
    }                                                                     \
  } while (0)

Definition at line 528 of file gnunet_common.h.

GNUNET_log

#define GNUNET_log	(		kind,
			...
	)

Value:

  do                                                                      \
  {                                                                       \
    static int log_call_enabled = GNUNET_LOG_CALL_STATUS;                 \
    if ((GNUNET_EXTRA_LOGGING > 0) ||                                     \
        ((GNUNET_ERROR_TYPE_DEBUG & (kind)) == 0))                        \
    {                                                                     \
      if (GN_UNLIKELY (log_call_enabled == -1))                           \
        log_call_enabled =                                                \
          GNUNET_get_log_call_status ((kind) & (~GNUNET_ERROR_TYPE_BULK), \
                                      NULL,                               \
                                      __FILE__,                           \
                                      __FUNCTION__,                       \
                                      __LINE__);                          \
      if (GN_UNLIKELY (GNUNET_get_log_skip () > 0))                       \
      {                                                                   \
        GNUNET_log_skip (-1, GNUNET_NO);                                  \
      }                                                                   \
      else                                                                \
      {                                                                   \
        if (GN_UNLIKELY (log_call_enabled))                               \
          GNUNET_log_nocheck ((kind), __VA_ARGS__);                       \
      }                                                                   \
    }                                                                     \
  } while (0)

Definition at line 554 of file gnunet_common.h.

GNUNET_static_assert

#define GNUNET_static_assert

(

cond

)

GNUNET_assert (cond)

Assertion to be checked (if supported by C compiler) at compile time, otherwise checked at runtime and resulting in an abort() on failure.

This is the case where the compiler does not support static assertions.

Parameters

cond	condition to test, 0 implies failure

Definition at line 976 of file gnunet_common.h.

GNUNET_memcmp

#define GNUNET_memcmp	(		a,
			b
	)

Value:

  ({                              \
    const typeof (*b) * _a = (a);  \
    const typeof (*a) * _b = (b);  \
    memcmp (_a, _b, sizeof(*a)); \
  })

Compare memory in a and b, where both must be of the same pointer type.

Do NOT use this function on arrays, it would only compare the first element!

Definition at line 1185 of file gnunet_common.h.

GNUNET_memcmp_priv

#define GNUNET_memcmp_priv	(		a,
			b
	)

Value:

  ({                              \
    const typeof (*b) * _a = (a);  \
    const typeof (*a) * _b = (b);  \
    GNUNET_memcmp_ct_ (_a, _b, sizeof(*a)); \
  })

Compare memory in a and b in constant time, suitable for private data.

Both a and b must be of the same pointer type.

Do NOT use this function on arrays, it would only compare the first element!

Definition at line 1214 of file gnunet_common.h.

GNUNET_is_zero

#define GNUNET_is_zero

(

a

)

GNUNET_is_zero_ (a, sizeof (*a))

Check that memory in a is all zeros.

a must be a pointer.

Parameters

a	pointer to a struct which should be tested for the entire memory being zero'ed out.

Returns

GNUNET_YES if a is zero, GNUNET_NO otherwise

Definition at line 1242 of file gnunet_common.h.

GNUNET_memcpy

#define GNUNET_memcpy	(		dst,
			src,
			n
	)

Value:

  do                               \
  {                                \
    if (0 != n)                    \
    {                              \
      (void) memcpy (dst, src, n); \
    }                              \
  } while (0)

Call memcpy() but check for n being 0 first.

In the latter case, it is now safe to pass NULL for src or dst. Unlike traditional memcpy(), returns nothing.

Parameters

dst	destination of the copy, may be NULL if n is zero
src	source of the copy, may be NULL if n is zero
n	number of bytes to copy

Definition at line 1255 of file gnunet_common.h.

__func__

#define __func__   "<unknown>"

Definition at line 1755 of file gnunet_common.h.

Typedef Documentation

GNUNET_FileNameCallback

typedef enum GNUNET_GenericReturnValue(* GNUNET_FileNameCallback) (void *cls, const char *filename)

Function called with a filename.

Parameters

cls	closure
filename	complete filename (absolute path)

Returns

GNUNET_OK to continue to iterate, GNUNET_NO to stop iteration with no error, GNUNET_SYSERR to abort iteration with error!

Definition at line 1 of file gnunet_common.h.

GNUNET_ContinuationCallback

typedef void(* GNUNET_ContinuationCallback) (void *cls)

Generic continuation callback.

Parameters

cls

Closure.

Definition at line 390 of file gnunet_common.h.

GNUNET_ResultCallback

typedef void(* GNUNET_ResultCallback) (void *cls, int64_t result_code, const void *data, uint16_t data_size)

Function called with the result of an asynchronous operation.

Parameters

cls	Closure.
result_code	Result code for the operation.
data	Data result for the operation.
data_size	Size of data.

Definition at line 406 of file gnunet_common.h.

Enumeration Type Documentation

GNUNET_GenericReturnValue

enum GNUNET_GenericReturnValue

Named constants for return values.

The following invariants hold: GNUNET_NO == 0 (to allow if (GNUNET_NO)) GNUNET_OK != GNUNET_SYSERR, GNUNET_OK != GNUNET_NO, GNUNET_NO != GNUNET_SYSERR and finally GNUNET_YES != GNUNET_NO.

Enumerator
GNUNET_SYSERR
GNUNET_NO
GNUNET_OK
GNUNET_YES

Definition at line 91 of file gnunet_common.h.

{
  GNUNET_SYSERR = -1,
  GNUNET_NO = 0,
  GNUNET_OK = 1,
  /* intentionally identical to #GNUNET_OK! */
  GNUNET_YES = 1,
};

GNUNET_SCHEDULER_Priority

enum GNUNET_SCHEDULER_Priority

Valid task priorities.

Use these, do not pass random integers! For various reasons (#3862 – building with QT Creator, and our restricted cross-compilation with emscripten) this cannot be in gnunet_scheduler_lib.h, but it works if we declare it here. Naturally, logically this is part of the scheduler.

Enumerator
GNUNET_SCHEDULER_PRIORITY_KEEP	Run with the same priority as the current job.
GNUNET_SCHEDULER_PRIORITY_IDLE	Run when otherwise idle.
GNUNET_SCHEDULER_PRIORITY_BACKGROUND	Run as background job (higher than idle, lower than default).
GNUNET_SCHEDULER_PRIORITY_DEFAULT	Run with the default priority (normal P2P operations). Any task that is scheduled without an explicit priority being specified will run with this priority.
GNUNET_SCHEDULER_PRIORITY_HIGH	Run with high priority (important requests). Higher than DEFAULT.
GNUNET_SCHEDULER_PRIORITY_UI	Run with priority for interactive tasks. Higher than "HIGH".
GNUNET_SCHEDULER_PRIORITY_URGENT	Run with priority for urgent tasks. Use for things like aborts and shutdowns that need to preempt "UI"-level tasks. Higher than "UI".
GNUNET_SCHEDULER_PRIORITY_SHUTDOWN	This is an internal priority level that is only used for tasks that are being triggered due to shutdown (they have automatically highest priority). User code must not use this priority level directly. Tasks run with this priority level that internally schedule other tasks will see their original priority level be inherited (unless otherwise specified).
GNUNET_SCHEDULER_PRIORITY_COUNT	Number of priorities (must be the last priority). This priority must not be used by clients.

Definition at line 1767 of file gnunet_common.h.

{
  GNUNET_SCHEDULER_PRIORITY_KEEP = 0,
 
  GNUNET_SCHEDULER_PRIORITY_IDLE = 1,
 
  GNUNET_SCHEDULER_PRIORITY_BACKGROUND = 2,
 
  GNUNET_SCHEDULER_PRIORITY_DEFAULT = 3,
 
  GNUNET_SCHEDULER_PRIORITY_HIGH = 4,
 
  GNUNET_SCHEDULER_PRIORITY_UI = 5,
 
  GNUNET_SCHEDULER_PRIORITY_URGENT = 6,
 
  GNUNET_SCHEDULER_PRIORITY_SHUTDOWN = 7,
 
  GNUNET_SCHEDULER_PRIORITY_COUNT = 8
};

Function Documentation

GNUNET_get_log_call_status()

int GNUNET_get_log_call_status	(	int	caller_level,
		const char *	comp,
		const char *	file,
		const char *	function,
		int	line
	)

Decides whether a particular logging call should or should not be allowed to be made.

Used internally by GNUNET_log*()

Parameters

caller_level	loglevel the caller wants to use
comp	component name the caller uses (NULL means that global component name is used)
file	file name containing the logging call, usually FILE
function	function which tries to make a logging call, usually FUNCTION
line	line at which the call is made, usually LINE

Returns

0 to disallow the call, 1 to allow it

Definition at line 479 of file common_logging.c.

{
  struct LogDef *ld;
  int i;
  int force_only;
 
  if (NULL == comp)
    /* Use default component */
    comp = component_nopid;
 
  /* We have no definitions to override globally configured log level,
   * so just use it right away.
   */
  if ((min_level >= 0) && (GNUNET_NO == gnunet_force_log_present))
    return caller_level <= min_level;
 
  /* Only look for forced definitions? */
  force_only = min_level >= 0;
  for (i = 0; i < logdefs_len; i++)
  {
    ld = &logdefs[i];
    if (((! force_only) || ld->force) &&
        ((line >= ld->from_line) && (line <= ld->to_line) ) &&
        (0 == regexec (&ld->component_regex, comp, 0, NULL, 0)) &&
        (0 == regexec (&ld->file_regex, file, 0, NULL, 0)) &&
        (0 == regexec (&ld->function_regex, function, 0, NULL, 0)))
    {
      /* We're finished */
      return caller_level <= ld->level;
    }
  }
  /* No matches - use global level, if defined */
  if (min_level >= 0)
    return caller_level <= min_level;
  /* All programs/services previously defaulted to WARNING.
   * Now *we* default to WARNING, and THEY default to NULL.
   * Or rather we default to MESSAGE, since things aren't always bad.
   */
  return caller_level <= GNUNET_ERROR_TYPE_MESSAGE;
}

References component_nopid, LogDef::component_regex, LogDef::file_regex, LogDef::force, LogDef::from_line, LogDef::function_regex, GNUNET_ERROR_TYPE_MESSAGE, gnunet_force_log_present, GNUNET_NO, LogDef::level, line, logdefs, logdefs_len, min_level, and LogDef::to_line.

Referenced by GCCH_debug(), GCT_debug(), and get_nick_record().

Here is the caller graph for this function:

GNUNET_htonll()

uint64_t GNUNET_htonll

(

uint64_t

n

)

Convert unsigned 64-bit integer to network byte order.

Parameters

n	The value in host byte order.

Returns

The same value in network byte order.

Definition at line 36 of file common_endian.c.

{
#if __BYTE_ORDER == __BIG_ENDIAN
  return n;
#elif __BYTE_ORDER == __LITTLE_ENDIAN
  return (((uint64_t) htonl (n)) << 32) + htonl (n >> 32);
#else
  #error byteorder undefined
#endif
}

Referenced by abd_string_to_value(), block_proc(), change_service(), commit_set(), consider_sending_fc(), create_loc_uri(), determine_id(), GCCH_handle_channel_plaintext_data_ack(), GNUNET_ABD_delegate_issue(), GNUNET_ABD_delegate_serialize(), GNUNET_ABD_delegates_serialize(), GNUNET_ARM_request_service_list(), GNUNET_BIO_write_int64(), GNUNET_CRYPTO_ecc_scalar_from_int(), GNUNET_CRYPTO_random_timeflake(), GNUNET_DATASTORE_get_key(), GNUNET_DATASTORE_get_zero_anonymity(), GNUNET_DATASTORE_reserve(), GNUNET_FS_tree_encoder_next(), GNUNET_GNSRECORD_records_serialize(), GNUNET_hton_double(), GNUNET_NAMESTORE_zone_iterator_next(), GNUNET_NAMESTORE_zone_monitor_next(), GNUNET_PQ_query_param_absolute_time(), GNUNET_PQ_query_param_relative_time(), GNUNET_PQ_query_param_uint64(), GNUNET_RECLAIM_attribute_store(), GNUNET_RECLAIM_credential_store(), GNUNET_TESTBED_controller_connect(), GNUNET_TESTBED_controller_link(), GNUNET_TESTBED_generate_peergetconfig_msg_(), GNUNET_TESTBED_generate_slavegetconfig_msg_(), GST_send_operation_fail_msg(), GST_send_operation_success_msg(), handle_client_accept(), hash_for_index_cb(), notify_change(), opstart_manage_service(), opstart_overlay_connect(), opstart_peer_create(), opstart_peer_destroy(), opstart_peer_reconfigure(), opstart_peer_start(), opstart_peer_stop(), opstart_shutdown_peers(), p2_controller_connect_cb(), run(), save(), send_ack(), send_add_queue(), send_channel_data_ack(), send_client_done(), send_client_element(), send_controller_link_response(), send_hello_thru_rocc(), send_overlay_connect_success_msg(), send_update_queue(), signal_result(), transmit(), transmit_item(), transmit_set(), unindex_process(), union_accept(), uri_chk_parse(), and uri_loc_parse().

GNUNET_ntohll()

uint64_t GNUNET_ntohll

(

uint64_t

n

)

Convert unsigned 64-bit integer to host byte order.

Parameters

n	The value in network byte order.

Returns

The same value in host byte order.

Definition at line 53 of file common_endian.c.

{
#if __BYTE_ORDER == __BIG_ENDIAN
  return n;
#elif __BYTE_ORDER == __LITTLE_ENDIAN
  return (((uint64_t) ntohl (n)) << 32) + ntohl (n >> 32);
#else
  #error byteorder undefined
#endif
}

Referenced by abd_value_to_string(), backward_resolution(), cb_intersection_element_removed(), cmp_pow_value(), copy_element_cb(), find_proof(), forward_overlay_connect(), GNUNET_ABD_delegate_deserialize(), GNUNET_ABD_delegates_deserialize(), GNUNET_BIO_read_int64(), GNUNET_FRAGMENT_print_ack(), GNUNET_FRAGMENT_process_ack(), GNUNET_FS_handle_on_demand_block(), GNUNET_FS_publish_stop(), GNUNET_FS_uri_chk_get_file_size(), GNUNET_GNSRECORD_records_deserialize(), GNUNET_ntoh_double(), GNUNET_xfree_(), GNUNET_xrealloc_(), handle_add_queue_message(), handle_alice_client_message(), handle_arm_list_result(), handle_arm_result(), handle_attribute_store_message(), handle_bob_client_message(), handle_client_index_start(), handle_client_loc_sign(), handle_credential_store_message(), handle_data(), handle_flow_control(), handle_get(), handle_get_key(), handle_get_zero_anonymity(), handle_iteration_next(), handle_link_controllers(), handle_link_controllers_result(), handle_manage_peer_service(), handle_monitor_next(), handle_op_fail_event(), handle_opsuccess(), handle_overlay_connect(), handle_peer_conevent(), handle_peer_config(), handle_peer_create(), handle_peer_create_success(), handle_peer_destroy(), handle_peer_event(), handle_peer_get_config(), handle_peer_reconfigure(), handle_peer_start(), handle_peer_stop(), handle_remote_overlay_connect(), handle_reserve(), handle_result(), handle_set(), handle_shutdown_peers(), handle_slave_config(), handle_slave_get_config(), handle_start(), handle_statistics_value(), handle_statistics_watch_value(), handle_stop(), handle_union_p2p_strata_estimator(), handle_update_queue_message(), process_result_with_request(), reconstruct_cb(), set_result_cb(), try_match_block(), uri_chk_to_string(), uri_loc_to_string(), and verify_message_crypto().

GNUNET_hton_double()

double GNUNET_hton_double

(

double

d

)

Convert double to network byte order.

Parameters

d	The value in host byte order.

Returns

The same value in network byte order.

Convert double to network byte order.

Parameters

d	the value in network byte order

Returns

the same value in host byte order

Definition at line 74 of file common_endian.c.

{
  double res;
  uint64_t *in = (uint64_t *) &d;
  uint64_t *out = (uint64_t *) &res;
 
  out[0] = GNUNET_htonll (in[0]);
 
  return res;
}

References GNUNET_htonll(), and res.

Referenced by setup_estimate_message().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_ntoh_double()

double GNUNET_ntoh_double

(

double

d

)

Convert double to host byte order.

Parameters

d	The value in network byte order.

Returns

The same value in host byte order.

Convert double to host byte order.

Parameters

d	the value in network byte order

Returns

the same value in host byte order

Definition at line 92 of file common_endian.c.

{
  double res;
  uint64_t *in = (uint64_t *) &d;
  uint64_t *out = (uint64_t *) &res;
 
  out[0] = GNUNET_ntohll (in[0]);
 
  return res;
}

References GNUNET_ntohll(), and res.

Referenced by handle_estimate().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_memcmp_ct_()

int GNUNET_memcmp_ct_	(	const void *	b1,
		const void *	b2,
		size_t	len
	)

Compare memory in b1 and b2 in constant time, suitable for private data.

Parameters

b1	some buffer of size len
b2	another buffer of size len
len	number of bytes in b1 and b2

Returns

0 if buffers are equal,

Definition at line 130 of file consttime_memcmp.c.

{
  const uint8_t *c1, *c2;
  uint16_t d, r, m;
 
#if USE_VOLATILE_TEMPORARY
  volatile uint16_t v;
#else
  uint16_t v;
#endif
 
  c1 = b1;
  c2 = b2;
 
  r = 0;
  while (len)
  {
    /*
     * Take the low 8 bits of r (in the range 0x00 to 0xff,
     * or 0 to 255);
     * As explained elsewhere, the low 8 bits of r will be zero
     * if and only if all bytes compared so far were identical;
     * Zero-extend to a 16-bit type (in the range 0x0000 to
     * 0x00ff);
     * Add 255, yielding a result in the range 255 to 510;
     * Save that in a volatile variable to prevent
     * the compiler from trying any shortcuts (the
     * use of a volatile variable depends on "#ifdef
     * USE_VOLATILE_TEMPORARY", and most compilers won't
     * need it);
     * Divide by 256 yielding a result of 1 if the original
     * value of r was non-zero, or 0 if r was zero;
     * Subtract 1, yielding 0 if r was non-zero, or -1 if r
     * was zero;
     * Convert to uint16_t, yielding 0x0000 if r was
     * non-zero, or 0xffff if r was zero;
     * Save in m.
     */v = ((uint16_t) (uint8_t) r) + 255;
    m = v / 256 - 1;
 
    /*
     * Get the values from *c1 and *c2 as uint8_t (each will
     * be in the range 0 to 255, or 0x00 to 0xff);
     * Convert them to signed int values (still in the
     * range 0 to 255);
     * Subtract them using signed arithmetic, yielding a
     * result in the range -255 to +255;
     * Convert to uint16_t, yielding a result in the range
     * 0xff01 to 0xffff (for what was previously -255 to
     * -1), or 0, or in the range 0x0001 to 0x00ff (for what
     * was previously +1 to +255).
     */d = (uint16_t) ((int) *c1 - (int) *c2);
 
    /*
     * If the low 8 bits of r were previously 0, then m
     * is now 0xffff, so (d & m) is the same as d, so we
     * effectively copy d to r;
     * Otherwise, if r was previously non-zero, then m is
     * now 0, so (d & m) is zero, so leave r unchanged.
     * Note that the low 8 bits of d will be zero if and
     * only if d == 0, which happens when *c1 == *c2.
     * The low 8 bits of r are thus zero if and only if the
     * entirety of r is zero, which happens if and only if
     * all bytes compared so far were equal.  As soon as a
     * non-zero value is stored in r, it remains unchanged
     * for the remainder of the loop.
     */r |= (d & m);
 
    /*
     * Increment pointers, decrement length, and loop.
     */
    ++c1;
    ++c2;
    --len;
  }
 
  /*
   * At this point, r is an unsigned value, which will be 0 if the
   * final result should be zero, or in the range 0x0001 to 0x00ff
   * (1 to 255) if the final result should be positive, or in the
   * range 0xff01 to 0xffff (65281 to 65535) if the final result
   * should be negative.
   *
   * We want to convert the unsigned values in the range 0xff01
   * to 0xffff to signed values in the range -255 to -1, while
   * converting the other unsigned values to equivalent signed
   * values (0, or +1 to +255).
   *
   * On a machine with two's complement arithmetic, simply copying
   * the underlying bits (with sign extension if int is wider than
   * 16 bits) would do the job, so something like this might work:
   *
   *     return (int16_t)r;
   *
   * However, that invokes implementation-defined behaviour,
   * because values larger than 32767 can't fit in a signed 16-bit
   * integer without overflow.
   *
   * To avoid any implementation-defined behaviour, we go through
   * these contortions:
   *
   * a. Calculate ((uint32_t)r + 0x8000).  The cast to uint32_t
   *    it to prevent problems on platforms where int is narrower
   *    than 32 bits.  If int is a larger than 32-bits, then the
   *    usual arithmetic conversions cause this addition to be
   *    done in unsigned int arithmetic.  If int is 32 bits
   *    or narrower, then this addition is done in uint32_t
   *    arithmetic.  In either case, no overflow or wraparound
   *    occurs, and the result from this step has a value that
   *    will be one of 0x00008000 (32768), or in the range
   *    0x00008001 to 0x000080ff (32769 to 33023), or in the range
   *    0x00017f01 to 0x00017fff (98049 to 98303).
   *
   * b. Cast the result from (a) to uint16_t.  This effectively
   *    discards the high bits of the result, in a way that is
   *    well defined by the C language.  The result from this step
   *    will be of type uint16_t, and its value will be one of
   *    0x8000 (32768), or in the range 0x8001 to 0x80ff (32769 to
   *    33023), or in the range 0x7f01 to 0x7fff (32513 to
   *    32767).
   *
   * c. Cast the result from (b) to int32_t.  We use int32_t
   *    instead of int because we need a type that's strictly
   *    larger than 16 bits, and the C standard allows
   *    implementations where int is only 16 bits.  The result
   *    from this step will be of type int32_t, and its value will
   *    be one of 0x00008000 (32768), or in the range 0x00008001
   *    to 0x000080ff (32769 to 33023), or in the range 0x00007f01
   *    to 0x00007fff (32513 to 32767).
   *
   * d. Take the result from (c) and subtract 0x8000 (32768) using
   *    signed int32_t arithmetic.  The result from this step will
   *    be of type int32_t and the value will be one of
   *    0x00000000 (0), or in the range 0x00000001 to 0x000000ff
   *    (+1 to +255), or in the range 0xffffff01 to 0xffffffff
   *    (-255 to -1).
   *
   * e. Cast the result from (d) to int.  This does nothing
   *    interesting, except to make explicit what would have been
   *    implicit in the return statement.  The final result is an
   *    int in the range -255 to +255.
   *
   * Unfortunately, compilers don't seem to be good at figuring
   * out that most of this can be optimised away by careful choice
   * of register width and sign extension.
   *
   */return (/*e*/ int) (/*d*/
    (/*c*/ int32_t) (/*b*/ uint16_t) (/*a*/ (uint32_t) r + 0x8000)
    - 0x8000);
}

References consensus-simulation::int, len, and m.

GNUNET_is_zero_()

enum GNUNET_GenericReturnValue GNUNET_is_zero_	(	const void *	a,
		size_t	n
	)

Check that memory in a is all zeros.

a must be a pointer.

Parameters

a	pointer to n bytes which should be tested for the entire memory being zero'ed out.
n	number of bytes in to be tested

Returns

GNUNET_YES if a is zero, GNUNET_NO otherwise

Definition at line 486 of file common_allocation.c.

{
  const char *b = a;
 
  for (size_t i = 0; i < n; i++)
    if (b[i])
      return GNUNET_NO;
  return GNUNET_YES;
}

GNUNET_xmalloc_()

int int void* GNUNET_xmalloc_	(	size_t	size,
		const char *	filename,
		int	linenumber
	)

Allocate memory.

Checks the return value, aborts if no more memory is available. Don't use GNUNET_xmalloc_ directly. Use the GNUNET_malloc macro. The memory will be zero'ed out.

Parameters

size	number of bytes to allocate
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

allocated memory, never NULL

Checks the return value, aborts if no more memory is available.

Parameters

size	how many bytes of memory to allocate, do NOT use this function (or GNUNET_malloc()) to allocate more than several MB of memory, if you are possibly needing a very large chunk use GNUNET_xmalloc_unchecked_() instead.
filename	where in the code was the call to GNUNET_malloc()
linenumber	where in the code was the call to GNUNET_malloc()

Returns

pointer to size bytes of memory

Definition at line 59 of file common_allocation.c.

{
  void *ret;
 
  /* As a security precaution, we generally do not allow very large
   * allocations using the default 'GNUNET_malloc()' macro */
  GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
  ret = GNUNET_xmalloc_unchecked_ (size, filename, linenumber);
  if (NULL == ret)
  {
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "malloc");
    GNUNET_assert (0);
  }
  return ret;
}

References filename, GNUNET_assert, GNUNET_assert_at, GNUNET_ERROR_TYPE_ERROR, GNUNET_MAX_MALLOC_CHECKED, GNUNET_xmalloc_unchecked_(), LOG_STRERROR, ret, and size.

Referenced by GNUNET_xgrow_(), GNUNET_xnew_array_2d_(), GNUNET_xnew_array_3d_(), GNUNET_xstrdup_(), and GNUNET_xstrndup_().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_xnew_array_2d_()

void** GNUNET_xnew_array_2d_	(	size_t	n,
		size_t	m,
		size_t	elementSize,
		const char *	filename,
		int	linenumber
	)

Allocate memory for a two dimensional array in one block and set up pointers.

Aborts if no more memory is available. Don't use GNUNET_xnew_array_2d_ directly. Use the GNUNET_new_array_2d macro. The memory of the elements will be zero'ed out.

Parameters

n	size of the first dimension
m	size of the second dimension
elementSize	size of a single element in bytes
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

allocated memory, never NULL

Definition at line 91 of file common_allocation.c.

{
  /* use char pointer internally to avoid void pointer arithmetic warnings */
  char **ret = GNUNET_xmalloc_ (n * sizeof(void *)     /* 1. dim header */
                                + n * m * elementSize, /* element data */
                                filename,
                                linenumber);
 
  for (size_t i = 0; i < n; i++)
    ret[i] = (char *) ret    /* base address */
             + n * sizeof(void *)  /* skip 1. dim header */
             + i * m * elementSize; /* skip to 2. dim row header */
  return (void **) ret;
}

References filename, GNUNET_xmalloc_(), m, and ret.

Here is the call graph for this function:

GNUNET_xnew_array_3d_()

void*** GNUNET_xnew_array_3d_	(	size_t	n,
		size_t	m,
		size_t	o,
		size_t	elementSize,
		const char *	filename,
		int	linenumber
	)

Allocate memory for a three dimensional array in one block and set up pointers.

Aborts if no more memory is available. Don't use GNUNET_xnew_array_3d_ directly. Use the GNUNET_new_array_3d macro. The memory of the elements will be zero'ed out.

Parameters

n	size of the first dimension
m	size of the second dimension
o	size of the third dimension
elementSize	size of a single element in bytes
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

allocated memory, never NULL

Definition at line 127 of file common_allocation.c.

{
  /* use char pointer internally to avoid void pointer arithmetic warnings */
  char ***ret = GNUNET_xmalloc_ (n * sizeof(void **)     /* 1. dim header */
                                 + n * m * sizeof(void *)    /* 2. dim header */
                                 + n * m * o * elementSize, /* element data */
                                 filename,
                                 linenumber);
 
  for (size_t i = 0; i < n; i++)
  {
    /* need to cast to (char *) temporarily for byte level accuracy */
    ret[i] = (char **) ((char *) ret   /* base address */
                        + n * sizeof(void **)  /* skip 1. dim header */
                        + i * m * sizeof(void *)); /* skip to 2. dim header */
    for (size_t j = 0; j < m; j++)
      ret[i][j] = (char *) ret    /* base address */
                  + n * sizeof(void **)   /* skip 1. dim header */
                  + n * m * sizeof(void *)   /* skip 2. dim header */
                  + i * m * o * elementSize   /* skip to 2. dim part */
                  + j * o * elementSize; /* skip to 3. dim row data */
  }
  return (void ***) ret;
}

References filename, GNUNET_xmalloc_(), m, and ret.

Here is the call graph for this function:

GNUNET_xmemdup_()

void* GNUNET_xmemdup_	(	const void *	buf,
		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.

Parameters

buf	buffer to initialize from (must contain size bytes)
size	number of bytes to allocate
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

allocated memory, never NULL

Checks the return value, aborts if no more memory is available. Don't use GNUNET_xmemdup_() directly. Use the GNUNET_memdup() macro.

Parameters

buf	buffer to initialize from (must contain size bytes)
size	number of bytes to allocate
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

allocated memory, never NULL

Definition at line 170 of file common_allocation.c.

{
  void *ret;
 
  /* As a security precaution, we generally do not allow very large
   * allocations here */
  GNUNET_assert_at (size <= GNUNET_MAX_MALLOC_CHECKED, filename, linenumber);
  GNUNET_assert_at (size < INT_MAX, filename, linenumber);
  ret = malloc (size);
  if (ret == NULL)
  {
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "malloc");
    GNUNET_assert (0);
  }
  GNUNET_memcpy (ret, buf, size);
  return ret;
}

References buf, filename, GNUNET_assert, GNUNET_assert_at, GNUNET_ERROR_TYPE_ERROR, GNUNET_MAX_MALLOC_CHECKED, GNUNET_memcpy, INT_MAX, LOG_STRERROR, ret, and size.

GNUNET_xmalloc_unchecked_()

void* GNUNET_xmalloc_unchecked_	(	size_t	size,
		const char *	filename,
		int	linenumber
	)

Allocate memory.

This function does not check if the allocation request is within reasonable bounds, allowing allocations larger than 40 MB. If you don't expect the possibility of very large allocations, use GNUNET_malloc instead. The memory will be zero'ed out.

Parameters

size	number of bytes to allocate
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

pointer to size bytes of memory, NULL if we do not have enough memory

Allocate memory.

Allocates size bytes of memory. The memory will be zero'ed out.

Parameters

size	the number of bytes to allocate
filename	where in the code was the call to GNUNET_malloc_unchecked()
linenumber	where in the code was the call to GNUNET_malloc_unchecked()

Returns

pointer to size bytes of memory, NULL if we do not have enough memory

Definition at line 202 of file common_allocation.c.

{
  void *result;
 
  (void) filename;
  (void) linenumber;
 
  result = malloc (size);
  if (NULL == result)
    return NULL;
  memset (result, 0, size);
 
  return result;
}

References filename, result, and size.

Referenced by GNUNET_xmalloc_().

Here is the caller graph for this function:

GNUNET_xrealloc_()

void* GNUNET_xrealloc_	(	void *	ptr,
		size_t	n,
		const char *	filename,
		int	linenumber
	)

Reallocate memory.

Checks the return value, aborts if no more memory is available.

Checks the return value, aborts if no more memory is available. The content of the intersection of the new and old size will be unchanged.

Parameters

ptr	the pointer to reallocate
n	how many bytes of memory to allocate
filename	where in the code was the call to GNUNET_realloc()
linenumber	where in the code was the call to GNUNET_realloc()

Returns

pointer to size bytes of memory

Definition at line 230 of file common_allocation.c.

{
  (void) filename;
  (void) linenumber;
 
#if defined(M_SIZE)
#if ENABLE_POISONING
  {
    uint64_t *base = ptr;
    size_t s = M_SIZE (ptr);
 
    if (s > n)
    {
      const uint64_t baadfood = GNUNET_ntohll (0xBAADF00DBAADF00DLL);
      char *cbase = ptr;
 
      GNUNET_memcpy (&cbase[n],
                     &baadfood,
                     GNUNET_MIN (8 - (n % 8),
                                 s - n));
      for (size_t i = 1 + (n + 7) / 8; i < s / 8; i++)
        base[i] = baadfood;
      GNUNET_memcpy (&base[s / 8],
                     &baadfood,
                     s % 8);
    }
  }
#endif
#endif
  ptr = realloc (ptr, n);
  if ((NULL == ptr) && (n > 0))
  {
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "realloc");
    GNUNET_assert (0);
  }
  return ptr;
}

References filename, GNUNET_assert, GNUNET_ERROR_TYPE_ERROR, GNUNET_memcpy, GNUNET_MIN, GNUNET_ntohll(), and LOG_STRERROR.

Here is the call graph for this function:

GNUNET_xfree_()

void GNUNET_xfree_	(	void *	ptr,
		const char *	filename,
		int	linenumber
	)

Free memory.

Merely a wrapper for the case that we want to keep track of allocations. Don't use GNUNET_xfree_ directly. Use the GNUNET_free macro.

Parameters

ptr	pointer to memory to free
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Merely a wrapper for the case that we want to keep track of allocations.

Parameters

ptr	the pointer to free
filename	where in the code was the call to GNUNET_free()
linenumber	where in the code was the call to GNUNET_free()

Definition at line 294 of file common_allocation.c.

{
  if (NULL == ptr)
    return;
#if defined(M_SIZE)
#if ENABLE_POISONING
  {
    const uint64_t baadfood = GNUNET_ntohll (0xBAADF00DBAADF00DLL);
    uint64_t *base = ptr;
    size_t s = M_SIZE (ptr);
 
    for (size_t i = 0; i < s / 8; i++)
      base[i] = baadfood;
    GNUNET_memcpy (&base[s / 8], &baadfood, s % 8);
  }
#endif
#endif
  free (ptr);
}

References GNUNET_memcpy, and GNUNET_ntohll().

Referenced by GNUNET_xgrow_().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_xstrdup_()

char* GNUNET_xstrdup_	(	const char *	str,
		const char *	filename,
		int	linenumber
	)

Dup a string.

Don't call GNUNET_xstrdup_ directly. Use the GNUNET_strdup macro.

Parameters

str	string to duplicate
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

the duplicated string

Dup a string.

Parameters

str	the string to dup
filename	where in the code was the call to GNUNET_strdup()
linenumber	where in the code was the call to GNUNET_strdup()

Returns

strdup(@a str)

Definition at line 326 of file common_allocation.c.

{
  char *res;
  size_t slen;
 
  GNUNET_assert_at (str != NULL, filename, linenumber);
  slen = strlen (str) + 1;
  res = GNUNET_xmalloc_ (slen, filename, linenumber);
  GNUNET_memcpy (res, str, slen);
  return res;
}

References filename, GNUNET_assert_at, GNUNET_memcpy, GNUNET_xmalloc_(), and res.

Here is the call graph for this function:

GNUNET_xstrndup_()

char* GNUNET_xstrndup_	(	const char *	str,
		size_t	len,
		const char *	filename,
		int	linenumber
	)

Dup partially a string.

Don't call GNUNET_xstrndup_ directly. Use the GNUNET_strndup macro.

Parameters

str	string to duplicate
len	length of the string to duplicate
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Returns

the duplicated string

Dup partially a string.

Parameters

str	the string to dup
len	the length of the string to dup
filename	where in the code was the call to GNUNET_strndup()
linenumber	where in the code was the call to GNUNET_strndup()

Returns

strndup(@a str,@a len)

Definition at line 365 of file common_allocation.c.

{
  char *res;
 
  if (0 == len)
    return GNUNET_strdup ("");
  GNUNET_assert_at (NULL != str, filename, linenumber);
  len = strnlen (str, len);
  res = GNUNET_xmalloc_ (len + 1, filename, linenumber);
  GNUNET_memcpy (res, str, len);
  /* res[len] = '\0'; 'malloc' zeros out anyway */
  return res;
}

References filename, GNUNET_assert_at, GNUNET_memcpy, GNUNET_strdup, GNUNET_xmalloc_(), len, res, and strnlen().

Here is the call graph for this function:

GNUNET_xgrow_()

void GNUNET_xgrow_	(	void **	old,
		size_t	elementSize,
		unsigned int *	oldCount,
		unsigned int	newCount,
		const char *	filename,
		int	linenumber
	)

Grow an array, the new elements are zeroed out.

Grows old by (*oldCount-newCount)*elementSize bytes and sets *oldCount to newCount.

Don't call GNUNET_xgrow_ directly. Use the GNUNET_array_grow macro.

Parameters

old	address of the pointer to the array *old may be NULL
elementSize	the size of the elements of the array
oldCount	address of the number of elements in the *old array
newCount	number of elements in the new array, may be 0 (then *old will be NULL afterwards)
filename	where is this call being made (for debugging)
linenumber	line where this call is being made (for debugging)

Grow an array, the new elements are zeroed out.

Grows old by (*oldCount-newCount)*elementSize bytes and sets *oldCount to newCount.

Parameters

old	address of the pointer to the array *old may be NULL
elementSize	the size of the elements of the array
oldCount	address of the number of elements in the *old array
newCount	number of elements in the new array, may be 0
filename	where in the code was the call to GNUNET_array_grow()
linenumber	where in the code was the call to GNUNET_array_grow()

Definition at line 396 of file common_allocation.c.

{
  void *tmp;
  size_t size;
 
  GNUNET_assert_at (INT_MAX / elementSize > newCount, filename, linenumber);
  size = newCount * elementSize;
  if (0 == size)
  {
    tmp = NULL;
  }
  else
  {
    tmp = GNUNET_xmalloc_ (size, filename, linenumber);
    if (NULL != *old)
    {
      GNUNET_memcpy (tmp, *old, elementSize * GNUNET_MIN (*oldCount, newCount));
    }
  }
 
  if (NULL != *old)
  {
    GNUNET_xfree_ (*old, filename, linenumber);
  }
  *old = tmp;
  *oldCount = newCount;
}

References filename, GNUNET_assert_at, GNUNET_memcpy, GNUNET_MIN, GNUNET_xfree_(), GNUNET_xmalloc_(), INT_MAX, and size.

Here is the call graph for this function:

GNUNET_async_scope_enter()

void GNUNET_async_scope_enter	(	const struct GNUNET_AsyncScopeId *	aid,
		struct GNUNET_AsyncScopeSave *	old_scope
	)

Set the async scope for the current thread.

Parameters

aid	the async scope identifier
old_scope[out]	location to save the old scope

Definition at line 1501 of file common_logging.c.

{
  *old_scope = current_async_scope;
  current_async_scope.have_scope = GNUNET_YES;
  current_async_scope.scope_id = *aid;
}

References current_async_scope, GNUNET_YES, GNUNET_AsyncScopeSave::have_scope, and GNUNET_AsyncScopeSave::scope_id.

Referenced by GNUNET_SCHEDULER_begin_async_scope(), and GNUNET_SCHEDULER_do_work().

Here is the caller graph for this function:

GNUNET_async_scope_restore()

void GNUNET_async_scope_restore

(

struct GNUNET_AsyncScopeSave *

old_scope

)

Clear the current thread's async scope.

Parameters

old_scope

scope to restore

Definition at line 1516 of file common_logging.c.

{
  current_async_scope = *old_scope;
}

References current_async_scope.

Referenced by GNUNET_SCHEDULER_do_work().

Here is the caller graph for this function:

GNUNET_async_scope_get()

void GNUNET_async_scope_get

(

struct GNUNET_AsyncScopeSave *

scope_ret

)

Get the current async scope.

Parameters

[out]

scope_ret

pointer to where the result is stored

Definition at line 1542 of file common_logging.c.

{
  *scope_ret = current_async_scope;
}

References current_async_scope.

Referenced by add_without_sets(), GNUNET_SCHEDULER_add_at_with_priority(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_add_select(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_do_work(), and setup_job_headers().

Here is the caller graph for this function:

GNUNET_async_scope_fresh()

void GNUNET_async_scope_fresh

(

struct GNUNET_AsyncScopeId *

aid_ret

)

Generate a fresh async scope identifier.

Parameters

[out]

aid_ret

pointer to where the result is stored

Definition at line 1528 of file common_logging.c.

{
  GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
                              aid_ret,
                              sizeof(struct GNUNET_AsyncScopeId));
}

References GNUNET_CRYPTO_QUALITY_WEAK, and GNUNET_CRYPTO_random_block().

Here is the call graph for this function: