12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2006-2020 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Affero General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file include/gnunet_common.h
- * @brief 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
- * @author Nils Durner
- * @author Martin Schanzenbach
- *
- * @defgroup logging Logging
- * @see [Documentation](https://gnunet.org/logging)
- *
- * @defgroup memory Memory management
- */
- #ifndef GNUNET_COMMON_H
- #define GNUNET_COMMON_H
- #include <stdlib.h>
- #if HAVE_SYS_SOCKET_H
- #include <sys/socket.h>
- #endif
- #if HAVE_NETINET_IN_H
- #include <netinet/in.h>
- #endif
- #ifdef HAVE_STDINT_H
- #include <stdint.h>
- #endif
- #ifdef HAVE_STDARG_H
- #include <stdarg.h>
- #endif
- #ifdef HAVE_SYS_TYPES_H
- #include <sys/types.h>
- #endif
- #ifdef HAVE_SYS_SOCKET_H
- #include <sys/socket.h>
- #endif
- #ifdef HAVE_BYTESWAP_H
- #include <byteswap.h>
- #endif
- #ifdef __cplusplus
- extern "C" {
- #if 0 /* keep Emacsens' auto-indent happy */
- }
- #endif
- #endif
- /**
- * Version of the API (for entire gnunetutil.so library).
- */
- #define GNUNET_UTIL_VERSION 0x000A0104
- /**
- * 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`.
- */
- enum GNUNET_GenericReturnValue
- {
- GNUNET_SYSERR = -1,
- GNUNET_NO = 0,
- GNUNET_OK = 1,
- /* intentionally identical to #GNUNET_OK! */
- GNUNET_YES = 1,
- };
- #define GNUNET_MIN(a, b) (((a) < (b)) ? (a) : (b))
- #define GNUNET_MAX(a, b) (((a) > (b)) ? (a) : (b))
- /* some systems use one underscore only, and mingw uses no underscore... */
- #ifndef __BYTE_ORDER
- #ifdef _BYTE_ORDER
- #define __BYTE_ORDER _BYTE_ORDER
- #else
- #ifdef BYTE_ORDER
- #define __BYTE_ORDER BYTE_ORDER
- #endif
- #endif
- #endif
- #ifndef __BIG_ENDIAN
- #ifdef _BIG_ENDIAN
- #define __BIG_ENDIAN _BIG_ENDIAN
- #else
- #ifdef BIG_ENDIAN
- #define __BIG_ENDIAN BIG_ENDIAN
- #endif
- #endif
- #endif
- #ifndef __LITTLE_ENDIAN
- #ifdef _LITTLE_ENDIAN
- #define __LITTLE_ENDIAN _LITTLE_ENDIAN
- #else
- #ifdef LITTLE_ENDIAN
- #define __LITTLE_ENDIAN LITTLE_ENDIAN
- #endif
- #endif
- #endif
- /**
- * wrap va_arg for enums
- */
- #define GNUNET_VA_ARG_ENUM(va, X) ((enum X) va_arg (va, int))
- /**
- * @ingroup logging
- * define #GNUNET_EXTRA_LOGGING if using this header outside the GNUnet source
- * tree where gnunet_config.h is unavailable
- */
- #ifndef GNUNET_EXTRA_LOGGING
- #define GNUNET_EXTRA_LOGGING 0
- #endif
- /**
- * 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
- /**
- * 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".
- */
- #define GNUNET_NZL(l) GNUNET_MAX (1, l)
- /**
- * gcc-ism to get packed structs.
- */
- #define GNUNET_PACKED __attribute__ ((packed))
- /**
- * gcc-ism to get gcc bitfield layout when compiling with -mms-bitfields
- */
- #define GNUNET_GCC_STRUCT_LAYOUT
- /**
- * 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.
- */
- #ifdef __BIGGEST_ALIGNMENT__
- #define GNUNET_ALIGN __attribute__ ((aligned (__BIGGEST_ALIGNMENT__)))
- #else
- #define GNUNET_ALIGN __attribute__ ((aligned (8)))
- #endif
- /**
- * gcc-ism to document unused arguments
- */
- #define GNUNET_UNUSED __attribute__ ((unused))
- /**
- * gcc-ism to document functions that don't return
- */
- #define GNUNET_NORETURN __attribute__ ((noreturn))
- /**
- * Define as empty, GNUNET_PACKED should suffice, but this won't work on W32
- */
- #define GNUNET_NETWORK_STRUCT_BEGIN
- /**
- * Define as empty, GNUNET_PACKED should suffice, but this won't work on W32;
- */
- #define GNUNET_NETWORK_STRUCT_END
- /* ************************ super-general types *********************** */
- GNUNET_NETWORK_STRUCT_BEGIN
- /**
- * @brief A 512-bit hashcode. These are the default length for GNUnet, using SHA-512.
- */
- struct GNUNET_HashCode
- {
- uint32_t bits[512 / 8 / sizeof(uint32_t)]; /* = 16 */
- };
- /**
- * @brief A 256-bit hashcode. Used under special conditions, like when space
- * is critical and security is not impacted by it.
- */
- struct GNUNET_ShortHashCode
- {
- uint32_t bits[256 / 8 / sizeof(uint32_t)]; /* = 8 */
- };
- /**
- * A UUID, a 128 bit random value.
- */
- struct GNUNET_Uuid
- {
- /**
- * 128 random bits.
- */
- uint32_t value[4];
- };
- /**
- * Header for all communications.
- */
- struct GNUNET_MessageHeader
- {
- /**
- * The length of the struct (in bytes, including the length field itself),
- * in big-endian format.
- */
- uint16_t size GNUNET_PACKED;
- /**
- * The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
- */
- uint16_t type GNUNET_PACKED;
- };
- /**
- * Answer from service to client about last operation.
- */
- struct GNUNET_OperationResultMessage
- {
- struct GNUNET_MessageHeader header;
- uint32_t reserved GNUNET_PACKED;
- /**
- * Operation ID.
- */
- uint64_t op_id GNUNET_PACKED;
- /**
- * Status code for the operation.
- */
- uint64_t result_code GNUNET_PACKED;
- /* Followed by data. */
- };
- /**
- * Identifier for an asynchronous execution context.
- */
- struct GNUNET_AsyncScopeId
- {
- uint32_t bits[16 / sizeof(uint32_t)]; /* = 16 bytes */
- };
- GNUNET_NETWORK_STRUCT_END
- /**
- * Saved async scope identifier or root scope.
- */
- struct GNUNET_AsyncScopeSave
- {
- /**
- * Saved scope. Unused if 'have_scope==GNUNET_NO'.
- */
- struct GNUNET_AsyncScopeId scope_id;
- /**
- * GNUNET_YES unless this saved scope is the unnamed root scope.
- */
- int have_scope;
- };
- /**
- * Function called with a filename.
- *
- * @param cls closure
- * @param filename complete filename (absolute path)
- * @return #GNUNET_OK to continue to iterate,
- * #GNUNET_NO to stop iteration with no error,
- * #GNUNET_SYSERR to abort iteration with error!
- */
- typedef enum GNUNET_GenericReturnValue
- (*GNUNET_FileNameCallback) (void *cls,
- const char *filename);
- /**
- * Generic continuation callback.
- *
- * @param cls Closure.
- */
- typedef void
- (*GNUNET_ContinuationCallback) (void *cls);
- /**
- * Function called with the result of an asynchronous operation.
- *
- * @param cls
- * Closure.
- * @param result_code
- * Result code for the operation.
- * @param data
- * Data result for the operation.
- * @param data_size
- * Size of @a data.
- */
- typedef void
- (*GNUNET_ResultCallback) (void *cls,
- int64_t result_code,
- const void *data,
- uint16_t data_size);
- /* ****************************** logging ***************************** */
- /**
- * @ingroup logging
- * Types of errors.
- */
- enum GNUNET_ErrorType
- {
- GNUNET_ERROR_TYPE_UNSPECIFIED = -1,
- GNUNET_ERROR_TYPE_NONE = 0,
- GNUNET_ERROR_TYPE_ERROR = 1,
- GNUNET_ERROR_TYPE_WARNING = 2,
- /* UX: We need a message type that is output by
- * default without looking like there is a problem.
- */
- 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
- };
- /**
- * @ingroup logging
- * User-defined handler for log messages.
- *
- * @param cls closure
- * @param kind severeity
- * @param component what component is issuing the message?
- * @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);
- /**
- * @ingroup logging
- * Get the number of log calls that are going to be skipped
- *
- * @return number of log calls to be ignored
- */
- int
- GNUNET_get_log_skip (void);
- #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
- /**
- * @ingroup logging
- * Main log function.
- *
- * @param kind how serious is the error?
- * @param message what is the message (format string)
- * @param ... arguments for format string
- */
- void
- GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
- __attribute__ ((format (printf, 2, 3)));
- /* 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
- /**
- * @ingroup logging
- * Log function that specifies an alternative component.
- * This function should be used by plugins.
- *
- * @param kind how serious is the error?
- * @param comp component responsible for generating the message
- * @param message what is the message (format string)
- * @param ... arguments for format string
- */
- void
- GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind,
- const char *comp,
- const char *message,
- ...)
- __attribute__ ((format (printf, 3, 4)));
- #if ! defined(GNUNET_CULL_LOGGING)
- #define GNUNET_log_from(kind, comp, ...) \
- 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)
- #define GNUNET_log(kind, ...) \
- 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)
- #else
- #define GNUNET_log(...)
- #define GNUNET_log_from(...)
- #endif
- /**
- * @ingroup logging
- * Log error message about missing configuration option.
- *
- * @param kind log level
- * @param section section with missing option
- * @param option name of missing option
- */
- void
- GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
- const char *section,
- const char *option);
- /**
- * @ingroup logging
- * Log error message about invalid configuration option value.
- *
- * @param kind log level
- * @param section section with invalid option
- * @param option name of invalid option
- * @param required what is required that is invalid about the option
- */
- void
- GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
- const char *section,
- const char *option,
- const char *required);
- /**
- * @ingroup logging
- * Abort the process, generate a core dump if possible.
- * Most code should use `GNUNET_assert (0)` instead to
- * first log the location of the failure.
- */
- void
- GNUNET_abort_ (void) GNUNET_NORETURN;
- /**
- * @ingroup logging
- * Ignore the next @a n calls to the log function.
- *
- * @param n number of log calls to ignore (could be negative)
- * @param check_reset #GNUNET_YES to assert that the log skip counter is currently zero
- */
- void
- GNUNET_log_skip (int n, int check_reset);
- /**
- * @ingroup logging
- * Setup logging.
- *
- * @param comp default component to use
- * @param loglevel what types of messages should be logged
- * @param logfile change logging to logfile (use NULL to keep stderr)
- * @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);
- /**
- * @ingroup logging
- * Add a custom logger. Note that installing any custom logger
- * will disable the standard logger. When multiple custom loggers
- * are installed, all will be called. The standard logger will
- * only be used if no custom loggers are present.
- *
- * @param logger log function
- * @param logger_cls closure for @a logger
- */
- void
- GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls);
- /**
- * @ingroup logging
- * Remove a custom logger.
- *
- * @param logger log function
- * @param logger_cls closure for @a logger
- */
- void
- GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls);
- /**
- * @ingroup logging
- * Convert a short hash value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param shc the hash code
- * @return string
- */
- const char *
- GNUNET_sh2s (const struct GNUNET_ShortHashCode *shc);
- /**
- * @ingroup logging
- * Convert a UUID to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param uuid the UUID
- * @return string
- */
- const char *
- GNUNET_uuid2s (const struct GNUNET_Uuid *uuid);
- /**
- * @ingroup logging
- * Convert a hash value to a string (for printing debug messages).
- * 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 (const struct GNUNET_HashCode *hc);
- /**
- * @ingroup logging
- * Convert a hash value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant! Identical to #GNUNET_h2s(), except that another
- * buffer is used so both #GNUNET_h2s() and #GNUNET_h2s2() can be
- * used within the same log statement.
- *
- * @param hc the hash code
- * @return string
- */
- const char *
- GNUNET_h2s2 (const struct GNUNET_HashCode *hc);
- /**
- * @ingroup logging
- * 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 struct GNUNET_HashCode *hc);
- /**
- * Public key. Details in gnunet_util_crypto.h.
- */
- struct GNUNET_CRYPTO_EddsaPublicKey;
- /**
- * Public key. Details in gnunet_util_crypto.h.
- */
- struct GNUNET_CRYPTO_EcdhePublicKey;
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * 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_p2s (const struct GNUNET_CRYPTO_EddsaPublicKey *p);
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * 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_p2s2 (const struct GNUNET_CRYPTO_EddsaPublicKey *p);
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * 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_e2s (const struct GNUNET_CRYPTO_EcdhePublicKey *p);
- /**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * 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_e2s2 (const struct GNUNET_CRYPTO_EcdhePublicKey *p);
- /**
- * Forward declaration to make compiler happy depending on include order.
- */
- struct GNUNET_PeerIdentity;
- /**
- * @ingroup logging
- * Convert a peer identity to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param pid the peer identity
- * @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s().
- */
- const char *
- GNUNET_i2s (const struct GNUNET_PeerIdentity *pid);
- /**
- * @ingroup logging
- * Convert a peer identity to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant! Identical to #GNUNET_i2s(), except that another
- * buffer is used so both #GNUNET_i2s() and #GNUNET_i2s2() can be
- * used within the same log statement.
- *
- * @param pid the peer identity
- * @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s().
- */
- const char *
- GNUNET_i2s2 (const struct GNUNET_PeerIdentity *pid);
- /**
- * @ingroup logging
- * Convert a peer identity to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param pid the peer identity
- * @return string form of the pid; will be overwritten by next
- * call to #GNUNET_i2s_full().
- */
- const char *
- GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid);
- /**
- * @ingroup logging
- * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
- * (for printing debug messages). This is one of the very few calls
- * in the entire API that is NOT reentrant!
- *
- * @param addr the address
- * @param addrlen the length of the @a addr
- * @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);
- /**
- * @ingroup logging
- * Convert error type to string.
- *
- * @param kind type to convert
- * @return string corresponding to the type
- */
- const char *
- GNUNET_error_type_to_string (enum GNUNET_ErrorType kind);
- /**
- * @ingroup logging
- * 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. Aborting.\n"), \
- __FILE__, \
- __LINE__); \
- GNUNET_abort_ (); \
- } \
- } while (0)
- /**
- * @ingroup logging
- * 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. Aborting.\n"), \
- f, \
- l); \
- GNUNET_abort_ (); \
- } \
- } while (0)
- /**
- * @ingroup logging
- * Use this for fatal errors that cannot be handled
- *
- * @param cond Condition to evaluate
- * @param comp Component string to use for logging
- */
- #define GNUNET_assert_from(cond, comp) \
- do \
- { \
- if (! (cond)) \
- { \
- GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, \
- comp, \
- _ ("Assertion failed at %s:%d. Aborting.\n"), \
- __FILE__, \
- __LINE__); \
- GNUNET_abort_ (); \
- } \
- } while (0)
- #if HAVE_STATIC_ASSERT
- /**
- * Assertion to be checked (if supported by C compiler) at
- * compile time, otherwise checked at runtime and resulting
- * in an abort() on failure.
- *
- * @param cond condition to test, 0 implies failure
- */
- #define GNUNET_static_assert(cond) _Static_assert (cond, "")
- #else
- /**
- * 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.
- *
- * @param cond condition to test, 0 implies failure
- */
- #define GNUNET_static_assert(cond) GNUNET_assert (cond)
- #endif
- /**
- * @ingroup logging
- * Use this for internal assertion violations that are
- * not fatal (can be handled) but should not occur.
- */
- #define GNUNET_break(cond) \
- do \
- { \
- if (! (cond)) \
- { \
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR, \
- _ ("Assertion failed at %s:%d.\n"), \
- __FILE__, \
- __LINE__); \
- } \
- } while (0)
- /**
- * @ingroup logging
- * Use this for assertion violations caused by other
- * peers (i.e. protocol violations). We do not want to
- * confuse end-users (say, some other peer runs an
- * older, broken or incompatible GNUnet version), but
- * 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 | GNUNET_ERROR_TYPE_BULK, \
- _ ("External protocol violation detected at %s:%d.\n"), \
- __FILE__, \
- __LINE__); \
- } \
- } while (0)
- /**
- * @ingroup logging
- * 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_strerror(level, cmd) \
- do \
- { \
- GNUNET_log (level, \
- _ ("`%s' failed at %s:%d with error: %s\n"), \
- cmd, \
- __FILE__, \
- __LINE__, \
- strerror (errno)); \
- } while (0)
- /**
- * @ingroup logging
- * 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)
- /**
- * @ingroup logging
- * 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_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)
- /**
- * @ingroup logging
- * 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)
- /* ************************* endianness conversion ****************** */
- #ifdef htonbe64
- #define GNUNET_htonll(n) htobe64 (n)
- #else
- /**
- * 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.
- */
- uint64_t
- GNUNET_htonll (uint64_t n);
- #endif
- #ifdef be64toh
- #define GNUNET_ntohll(n) be64toh (n)
- #else
- /**
- * 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.
- */
- uint64_t
- GNUNET_ntohll (uint64_t n);
- #endif
- /**
- * Convert double to network byte order.
- *
- * @param d
- * The value in host byte order.
- *
- * @return The same value in network byte order.
- */
- double
- GNUNET_hton_double (double d);
- /**
- * Convert double to host byte order
- *
- * @param d
- * The value in network byte order.
- *
- * @return The same value in host byte order.
- */
- double
- GNUNET_ntoh_double (double d);
- /* ************************* allocation functions ****************** */
- /**
- * @ingroup memory
- * Maximum allocation with GNUNET_malloc macro.
- */
- #define GNUNET_MAX_MALLOC_CHECKED (1024 * 1024 * 40)
- /**
- * @ingroup memory
- * Allocate a struct or union of the given @a type.
- * Wrapper around #GNUNET_malloc that returns a pointer
- * to the newly created object of the correct type.
- *
- * @param type name of the struct or union, i.e. pass 'struct Foo'.
- */
- #define GNUNET_new(type) (type *) GNUNET_malloc (sizeof(type))
- /**
- * Compare memory in @a a and @a b, where both must be of
- * the same pointer type.
- *
- * Do NOT use this function on arrays, it would only compare
- * the first element!
- */
- #define GNUNET_memcmp(a, b) \
- ({ \
- const typeof (*b) * _a = (a); \
- const typeof (*a) * _b = (b); \
- memcmp (_a, _b, sizeof(*a)); \
- })
- /**
- * Compare memory in @a b1 and @a b2 in constant time, suitable for private
- * data.
- *
- * @param b1 some buffer of size @a len
- * @param b2 another buffer of size @a len
- * @param len number of bytes in @a b1 and @a b2
- * @return 0 if buffers are equal,
- */
- int
- GNUNET_memcmp_ct_ (const void *b1,
- const void *b2,
- size_t len);
- /**
- * Compare memory in @a a and @a b in constant time, suitable for private
- * data. Both @a a and @a b must be of the same pointer type.
- *
- * Do NOT use this function on arrays, it would only compare
- * the first element!
- */
- #define GNUNET_memcmp_priv(a, b) \
- ({ \
- const typeof (*b) * _a = (a); \
- const typeof (*a) * _b = (b); \
- GNUNET_memcmp_ct_ (_a, _b, sizeof(*a)); \
- })
- /**
- * Check that memory in @a a is all zeros. @a a must be a pointer.
- *
- * @param a pointer to @a n bytes which should be tested for the
- * entire memory being zero'ed out.
- * @param n number of bytes in @a to be tested
- * @return GNUNET_YES if a is zero, GNUNET_NO otherwise
- */
- enum GNUNET_GenericReturnValue
- GNUNET_is_zero_ (const void *a,
- size_t n);
- /**
- * Check that memory in @a a is all zeros. @a a must be a pointer.
- *
- * @param a pointer to a struct which should be tested for the
- * entire memory being zero'ed out.
- * @return GNUNET_YES if a is zero, GNUNET_NO otherwise
- */
- #define GNUNET_is_zero(a) \
- GNUNET_is_zero_ (a, sizeof (*a))
- /**
- * Call memcpy() but check for @a n being 0 first. In the latter
- * case, it is now safe to pass NULL for @a src or @a dst.
- * Unlike traditional memcpy(), returns nothing.
- *
- * @param dst destination of the copy, may be NULL if @a n is zero
- * @param src source of the copy, may be NULL if @a n is zero
- * @param n number of bytes to copy
- */
- #define GNUNET_memcpy(dst, src, n) \
- do \
- { \
- if (0 != n) \
- { \
- (void) memcpy (dst, src, n); \
- } \
- } while (0)
- /**
- * @ingroup memory
- * Allocate a size @a n array with structs or unions of the given @a type.
- * Wrapper around #GNUNET_malloc that returns a pointer
- * to the newly created objects of the correct type.
- *
- * @param n number of elements in the array
- * @param type name of the struct or union, i.e. pass 'struct Foo'.
- */
- #define GNUNET_new_array(n, type) ({ \
- GNUNET_assert (SIZE_MAX / sizeof (type) >= n); \
- (type *) GNUNET_malloc ((n) * sizeof(type)); \
- })
- /**
- * @ingroup memory
- * Allocate a size @a n times @a m array
- * with structs or unions of the given @a type.
- *
- * @param n size of the first dimension
- * @param m size of the second dimension
- * @param type name of the struct or union, i.e. pass 'struct Foo'.
- */
- #define GNUNET_new_array_2d(n, m, type) \
- (type **) GNUNET_xnew_array_2d_ (n, m, sizeof(type), __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Allocate a size @a n times @a m times @a o array
- * with structs or unions of the given @a type.
- *
- * @param n size of the first dimension
- * @param m size of the second dimension
- * @param o size of the third dimension
- * @param type name of the struct or union, i.e. pass 'struct Foo'.
- */
- #define GNUNET_new_array_3d(n, m, o, type) \
- (type ***) GNUNET_xnew_array_3d_ (n, m, o, sizeof(type), __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Wrapper around malloc. Allocates size bytes of memory.
- * The memory will be zero'ed out.
- *
- * @param size the number of bytes to allocate, must be
- * smaller than 40 MB.
- * @return pointer to size bytes of memory, never NULL (!)
- */
- #define GNUNET_malloc(size) GNUNET_xmalloc_ (size, __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Allocate and initialize a block of memory.
- *
- * @param buf data to initialize 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__)
- /**
- * @ingroup memory
- * Wrapper around malloc. Allocates size bytes of memory.
- * The memory will be zero'ed out.
- *
- * @param size the number of bytes to allocate
- * @return pointer to size bytes of memory, NULL if we do not have enough memory
- */
- #define GNUNET_malloc_large(size) \
- GNUNET_xmalloc_unchecked_ (size, __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Wrapper around realloc. Reallocates size bytes of memory.
- * The content of the intersection of the new and old size will be unchanged.
- *
- * @param ptr the pointer to reallocate
- * @param size the number of bytes to reallocate
- * @return pointer to size bytes of memory
- */
- #define GNUNET_realloc(ptr, size) \
- GNUNET_xrealloc_ (ptr, size, __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Wrapper around free. Frees the memory referred to by ptr.
- * Note that it is generally better to free memory that was
- * allocated with #GNUNET_array_grow using #GNUNET_array_grow(mem, size, 0) instead of #GNUNET_free_nz.
- *
- * @param ptr location where to free the memory. ptr must have
- * been returned by #GNUNET_strdup, #GNUNET_strndup, #GNUNET_malloc or #GNUNET_array_grow earlier. NULL is allowed.
- */
- #define GNUNET_free_nz(ptr) GNUNET_xfree_ (ptr, __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Wrapper around free. Frees the memory referred to by ptr and sets ptr to NULL.
- * Note that it is generally better to free memory that was
- * allocated with #GNUNET_array_grow using #GNUNET_array_grow(mem, size, 0) instead of #GNUNET_free.
- *
- * @a ptr will be set to NULL. Use #GNUNET_free_nz() if @a ptr is not an L-value.
- *
- * @param ptr location where to free the memory. ptr must have
- * been returned by #GNUNET_strdup, #GNUNET_strndup, #GNUNET_malloc or #GNUNET_array_grow earlier. NULL is allowed.
- */
- #define GNUNET_free(ptr) do { \
- GNUNET_xfree_ (ptr, __FILE__, __LINE__); \
- ptr = NULL; \
- } while (0)
- /**
- * @ingroup memory
- * Wrapper around #GNUNET_xstrdup_. Makes a copy of the zero-terminated string
- * pointed to by a.
- *
- * @param a pointer to a zero-terminated string
- * @return a copy of the string including zero-termination
- */
- #define GNUNET_strdup(a) GNUNET_xstrdup_ (a, __FILE__, __LINE__)
- /**
- * @ingroup memory
- * Wrapper around #GNUNET_xstrndup_. 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__)
- /**
- * @ingroup memory
- * Grow a well-typed (!) array. This is a convenience
- * method to grow a vector @a arr of size @a size
- * to the new (target) size @a tsize.
- * <p>
- *
- * Example (simple, well-typed stack):
- *
- * <pre>
- * static struct foo * myVector = NULL;
- * static int myVecLen = 0;
- *
- * static void push(struct foo * elem) {
- * GNUNET_array_grow(myVector, myVecLen, myVecLen+1);
- * GNUNET_memcpy(&myVector[myVecLen-1], elem, sizeof(struct foo));
- * }
- *
- * static void pop(struct foo * elem) {
- * if (myVecLen == 0) die();
- * GNUNET_memcpy(elem, myVector[myVecLen-1], sizeof(struct foo));
- * GNUNET_array_grow(myVector, myVecLen, myVecLen-1);
- * }
- * </pre>
- *
- * @param arr base-pointer of the vector, may be NULL if size is 0;
- * will be updated to reflect the new address. The TYPE of
- * arr is important since size is the number of elements and
- * not the size in bytes
- * @param size the number of elements in the existing vector (number
- * of elements to copy over), will be updated with the new
- * array size
- * @param tsize the target size for the resulting vector, use 0 to
- * free the vector (then, arr will be NULL afterwards).
- */
- #define GNUNET_array_grow(arr, size, tsize) \
- GNUNET_xgrow_ ((void **) &(arr), \
- sizeof((arr)[0]), \
- &size, \
- tsize, \
- __FILE__, \
- __LINE__)
- /**
- * @ingroup memory
- * Append an element to an array (growing the array by one).
- *
- * @param arr base-pointer of the vector, may be NULL if @a len is 0;
- * will be updated to reflect the new address. The TYPE of
- * arr is important since size is the number of elements and
- * not the size in bytes
- * @param len the number of elements in the existing vector (number
- * of elements to copy over), will be updated with the new
- * array length
- * @param element the element that will be appended to the array
- */
- #define GNUNET_array_append(arr, len, element) \
- do \
- { \
- GNUNET_assert ((len) + 1 > (len)); \
- GNUNET_array_grow (arr, len, len + 1); \
- (arr) [len - 1] = element; \
- } while (0)
- /**
- * @ingroup memory
- * Append @a arr2 to @a arr1 (growing @a arr1
- * as needed). The @a arr2 array is left unchanged. Naturally
- * this function performs a shallow copy. Both arrays must have
- * the same type for their elements.
- *
- * @param arr1 base-pointer of the vector, may be NULL if @a len is 0;
- * will be updated to reflect the new address. The TYPE of
- * arr is important since size is the number of elements and
- * not the size in bytes
- * @param len1 the number of elements in the existing vector (number
- * of elements to copy over), will be updated with the new
- * array size
- * @param arr2 base-pointer a second array to concatenate, may be NULL if @a len2 is 0;
- * will be updated to reflect the new address. The TYPE of
- * arr is important since size is the number of elements and
- * not the size in bytes
- * @param len the number of elements in the existing vector (number
- * of elements to copy over), will be updated with the new
- * array size
- */
- #define GNUNET_array_concatenate(arr1, len1, arr2, len2) \
- do \
- { \
- const typeof (*arr2) * _a1 = (arr1); \
- const typeof (*arr1) * _a2 = (arr2); \
- GNUNET_assert ((len1) + (len2) >= (len1)); \
- GNUNET_assert (SIZE_MAX / sizeof (*_a1) >= ((len1) + (len2))); \
- GNUNET_array_grow (arr1, len1, (len1) + (len2)); \
- memcpy (&(arr1) [(len1) - (len2)], _a2, (len2) * sizeof (*arr1)); \
- } while (0)
- /**
- * @ingroup memory
- * Like snprintf, just aborts if the buffer is of insufficient size.
- *
- * @param buf pointer to buffer that is written to
- * @param size number of bytes in @a buf
- * @param format format strings
- * @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,
- ...)
- __attribute__ ((format (printf, 3, 4)));
- /**
- * @ingroup memory
- * Like asprintf, just portable.
- *
- * @param buf set to a buffer of sufficient size (allocated, caller must free)
- * @param format format string (see printf, fprintf, etc.)
- * @param ... data for format string
- * @return number of bytes in "*buf" excluding 0-termination
- */
- int
- GNUNET_asprintf (char **buf,
- const char *format,
- ...)
- __attribute__ ((format (printf, 2, 3)));
- /* ************** internal implementations, use macros above! ************** */
- /**
- * 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.
- *
- * @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_xmalloc_ (size_t size, 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.
- *
- * @param n size of the first dimension
- * @param m size of the second dimension
- * @param elementSize size of a single element in bytes
- * @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_xnew_array_2d_ (size_t n,
- size_t m,
- 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.
- *
- * @param n size of the first dimension
- * @param m size of the second dimension
- * @param o size of the third dimension
- * @param elementSize size of a single element in bytes
- * @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_xnew_array_3d_ (size_t n,
- size_t m,
- size_t o,
- size_t elementSize,
- 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);
- /**
- * 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.
- *
- * @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 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);
- /**
- * Reallocate memory. Checks the return value, aborts if no more
- * memory is available.
- */
- void *
- GNUNET_xrealloc_ (void *ptr, size_t n, 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.
- *
- * @param ptr pointer to memory to free
- * @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);
- /**
- * Dup a string. Don't call GNUNET_xstrdup_ directly. Use the #GNUNET_strdup macro.
- * @param str 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_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.
- * Grows old by (*oldCount-newCount)*elementSize
- * bytes and sets *oldCount to newCount.
- *
- * Don't call GNUNET_xgrow_ directly. Use the #GNUNET_array_grow macro.
- *
- * @param old address of the pointer to the array
- * *old may be NULL
- * @param elementSize the size of the elements of the array
- * @param oldCount address of the number of elements in the *old array
- * @param newCount number of elements in the new array, may be 0 (then *old will be NULL afterwards)
- * @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);
- /**
- * @ingroup memory
- * 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);
- /**
- * Set the async scope for the current thread.
- *
- * @param aid the async scope identifier
- * @param old_scope[out] location to save the old scope
- */
- void
- GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid,
- struct GNUNET_AsyncScopeSave *old_scope);
- /**
- * Clear the current thread's async scope.
- *
- * @param old_scope scope to restore
- */
- void
- GNUNET_async_scope_restore (struct GNUNET_AsyncScopeSave *old_scope);
- /**
- * Get the current async scope.
- *
- * @param[out] scope_ret pointer to where the result is stored
- */
- void
- GNUNET_async_scope_get (struct GNUNET_AsyncScopeSave *scope_ret);
- /**
- * Generate a fresh async scope identifier.
- *
- * @param[out] aid_ret pointer to where the result is stored
- */
- void
- GNUNET_async_scope_fresh (struct GNUNET_AsyncScopeId *aid_ret);
- #if __STDC_VERSION__ < 199901L
- #if __GNUC__ >= 2
- #define __func__ __FUNCTION__
- #else
- #define __func__ "<unknown>"
- #endif
- #endif
- /**
- * 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.
- */
- enum GNUNET_SCHEDULER_Priority
- {
- /**
- * Run with the same priority as the current job.
- */
- GNUNET_SCHEDULER_PRIORITY_KEEP = 0,
- /**
- * Run when otherwise idle.
- */
- GNUNET_SCHEDULER_PRIORITY_IDLE = 1,
- /**
- * Run as background job (higher than idle,
- * lower than default).
- */
- GNUNET_SCHEDULER_PRIORITY_BACKGROUND = 2,
- /**
- * 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_DEFAULT = 3,
- /**
- * Run with high priority (important requests).
- * Higher than DEFAULT.
- */
- GNUNET_SCHEDULER_PRIORITY_HIGH = 4,
- /**
- * Run with priority for interactive tasks.
- * Higher than "HIGH".
- */
- GNUNET_SCHEDULER_PRIORITY_UI = 5,
- /**
- * 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_URGENT = 6,
- /**
- * 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_SHUTDOWN = 7,
- /**
- * Number of priorities (must be the last priority).
- * This priority must not be used by clients.
- */
- GNUNET_SCHEDULER_PRIORITY_COUNT = 8
- };
- #if 0 /* keep Emacsens' auto-indent happy */
- {
- #endif
- #ifdef __cplusplus
- }
- #endif
- #endif /* GNUNET_COMMON_H */
|