26 #ifndef EVENT2_UTIL_H_INCLUDED_ 27 #define EVENT2_UTIL_H_INCLUDED_ 35 #include <event2/visibility.h> 41 #include <event2/event-config.h> 42 #ifdef EVENT__HAVE_SYS_TIME_H 45 #ifdef EVENT__HAVE_STDINT_H 47 #elif defined(EVENT__HAVE_INTTYPES_H) 50 #ifdef EVENT__HAVE_SYS_TYPES_H 51 #include <sys/types.h> 53 #ifdef EVENT__HAVE_STDDEF_H 60 #ifdef EVENT__HAVE_NETDB_H 61 #if !defined(_GNU_SOURCE) 69 #ifdef EVENT__HAVE_GETADDRINFO 74 #ifdef EVENT__HAVE_ERRNO_H 77 #include <sys/socket.h> 83 #if defined(EVENT__SIZEOF_VOID__) && !defined(EVENT__SIZEOF_VOID_P) 84 #define EVENT__SIZEOF_VOID_P EVENT__SIZEOF_VOID__ 116 #ifdef EVENT__HAVE_UINT64_T 117 #define ev_uint64_t uint64_t 118 #define ev_int64_t int64_t 119 #elif defined(_WIN32) 120 #define ev_uint64_t unsigned __int64 121 #define ev_int64_t signed __int64 122 #elif EVENT__SIZEOF_LONG_LONG == 8 123 #define ev_uint64_t unsigned long long 124 #define ev_int64_t long long 125 #elif EVENT__SIZEOF_LONG == 8 126 #define ev_uint64_t unsigned long 127 #define ev_int64_t long 128 #elif defined(EVENT_IN_DOXYGEN_) 129 #define ev_uint64_t ... 130 #define ev_int64_t ... 132 #error "No way to define ev_uint64_t" 135 #ifdef EVENT__HAVE_UINT32_T 136 #define ev_uint32_t uint32_t 137 #define ev_int32_t int32_t 138 #elif defined(_WIN32) 139 #define ev_uint32_t unsigned int 140 #define ev_int32_t signed int 141 #elif EVENT__SIZEOF_LONG == 4 142 #define ev_uint32_t unsigned long 143 #define ev_int32_t signed long 144 #elif EVENT__SIZEOF_INT == 4 145 #define ev_uint32_t unsigned int 146 #define ev_int32_t signed int 147 #elif defined(EVENT_IN_DOXYGEN_) 148 #define ev_uint32_t ... 149 #define ev_int32_t ... 151 #error "No way to define ev_uint32_t" 154 #ifdef EVENT__HAVE_UINT16_T 155 #define ev_uint16_t uint16_t 156 #define ev_int16_t int16_t 157 #elif defined(_WIN32) 158 #define ev_uint16_t unsigned short 159 #define ev_int16_t signed short 160 #elif EVENT__SIZEOF_INT == 2 161 #define ev_uint16_t unsigned int 162 #define ev_int16_t signed int 163 #elif EVENT__SIZEOF_SHORT == 2 164 #define ev_uint16_t unsigned short 165 #define ev_int16_t signed short 166 #elif defined(EVENT_IN_DOXYGEN_) 167 #define ev_uint16_t ... 168 #define ev_int16_t ... 170 #error "No way to define ev_uint16_t" 173 #ifdef EVENT__HAVE_UINT8_T 174 #define ev_uint8_t uint8_t 175 #define ev_int8_t int8_t 176 #elif defined(EVENT_IN_DOXYGEN_) 177 #define ev_uint8_t ... 178 #define ev_int8_t ... 180 #define ev_uint8_t unsigned char 181 #define ev_int8_t signed char 184 #ifdef EVENT__HAVE_UINTPTR_T 185 #define ev_uintptr_t uintptr_t 186 #define ev_intptr_t intptr_t 187 #elif EVENT__SIZEOF_VOID_P <= 4 188 #define ev_uintptr_t ev_uint32_t 189 #define ev_intptr_t ev_int32_t 190 #elif EVENT__SIZEOF_VOID_P <= 8 191 #define ev_uintptr_t ev_uint64_t 192 #define ev_intptr_t ev_int64_t 193 #elif defined(EVENT_IN_DOXYGEN_) 194 #define ev_uintptr_t ... 195 #define ev_intptr_t ... 197 #error "No way to define ev_uintptr_t" 200 #ifdef EVENT__ssize_t 201 #define ev_ssize_t EVENT__ssize_t 203 #define ev_ssize_t ssize_t 214 #define ev_off_t ev_int64_t 215 #elif EVENT__SIZEOF_OFF_T == 8 216 #define ev_off_t ev_int64_t 217 #elif EVENT__SIZEOF_OFF_T == 4 218 #define ev_off_t ev_int32_t 219 #elif defined(EVENT_IN_DOXYGEN_) 222 #define ev_off_t off_t 241 #ifndef EVENT__HAVE_STDINT_H 242 #define EV_UINT64_MAX ((((ev_uint64_t)0xffffffffUL) << 32) | 0xffffffffUL) 243 #define EV_INT64_MAX ((((ev_int64_t) 0x7fffffffL) << 32) | 0xffffffffL) 244 #define EV_INT64_MIN ((-EV_INT64_MAX) - 1) 245 #define EV_UINT32_MAX ((ev_uint32_t)0xffffffffUL) 246 #define EV_INT32_MAX ((ev_int32_t) 0x7fffffffL) 247 #define EV_INT32_MIN ((-EV_INT32_MAX) - 1) 248 #define EV_UINT16_MAX ((ev_uint16_t)0xffffUL) 249 #define EV_INT16_MAX ((ev_int16_t) 0x7fffL) 250 #define EV_INT16_MIN ((-EV_INT16_MAX) - 1) 251 #define EV_UINT8_MAX 255 252 #define EV_INT8_MAX 127 253 #define EV_INT8_MIN ((-EV_INT8_MAX) - 1) 255 #define EV_UINT64_MAX UINT64_MAX 256 #define EV_INT64_MAX INT64_MAX 257 #define EV_INT64_MIN INT64_MIN 258 #define EV_UINT32_MAX UINT32_MAX 259 #define EV_INT32_MAX INT32_MAX 260 #define EV_INT32_MIN INT32_MIN 261 #define EV_UINT16_MAX UINT16_MAX 262 #define EV_INT16_MAX INT16_MAX 263 #define EV_UINT8_MAX UINT8_MAX 264 #define EV_INT8_MAX INT8_MAX 265 #define EV_INT8_MIN INT8_MIN 275 #if EVENT__SIZEOF_SIZE_T == 8 276 #define EV_SIZE_MAX EV_UINT64_MAX 277 #define EV_SSIZE_MAX EV_INT64_MAX 278 #elif EVENT__SIZEOF_SIZE_T == 4 279 #define EV_SIZE_MAX EV_UINT32_MAX 280 #define EV_SSIZE_MAX EV_INT32_MAX 281 #elif defined(EVENT_IN_DOXYGEN_) 282 #define EV_SIZE_MAX ... 283 #define EV_SSIZE_MAX ... 285 #error "No way to define SIZE_MAX" 288 #define EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1) 292 #define ev_socklen_t int 293 #elif defined(EVENT__socklen_t) 294 #define ev_socklen_t EVENT__socklen_t 296 #define ev_socklen_t socklen_t 299 #ifdef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY 300 #if !defined(EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY) \ 301 && !defined(ss_family) 302 #define ss_family __ss_family 310 #define evutil_socket_t intptr_t 312 #define evutil_socket_t int 328 #ifdef EVENT_IN_DOXYGEN_
333 #define EV_MONOT_PRECISE 1 334 #define EV_MONOT_FALLBACK 2 342 EVENT2_EXPORT_SYMBOL
int 445 #define EVUTIL_CLOSESOCKET(s) evutil_closesocket(s) 463 #define EVUTIL_SOCKET_ERROR() WSAGetLastError() 465 #define EVUTIL_SET_SOCKET_ERROR(errcode) \ 466 do { WSASetLastError(errcode); } while (0) 473 #elif defined(EVENT_IN_DOXYGEN_) 489 #define EVUTIL_SOCKET_ERROR() ... 491 #define EVUTIL_SET_SOCKET_ERROR(errcode) ... 493 #define evutil_socket_geterror(sock) ... 495 #define evutil_socket_error_to_string(errcode) ... 498 #define EVUTIL_SOCKET_ERROR() (errno) 499 #define EVUTIL_SET_SOCKET_ERROR(errcode) \ 500 do { errno = (errcode); } while (0) 501 #define evutil_socket_geterror(sock) (errno) 502 #define evutil_socket_error_to_string(errcode) (strerror(errcode)) 514 #ifdef EVENT__HAVE_TIMERADD 515 #define evutil_timeradd(tvp, uvp, vvp) timeradd((tvp), (uvp), (vvp)) 516 #define evutil_timersub(tvp, uvp, vvp) timersub((tvp), (uvp), (vvp)) 518 #define evutil_timeradd(tvp, uvp, vvp) \ 520 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \ 521 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \ 522 if ((vvp)->tv_usec >= 1000000) { \ 524 (vvp)->tv_usec -= 1000000; \ 527 #define evutil_timersub(tvp, uvp, vvp) \ 529 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \ 530 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \ 531 if ((vvp)->tv_usec < 0) { \ 533 (vvp)->tv_usec += 1000000; \ 538 #ifdef EVENT__HAVE_TIMERCLEAR 539 #define evutil_timerclear(tvp) timerclear(tvp) 541 #define evutil_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0 547 #define evutil_timercmp(tvp, uvp, cmp) \ 548 (((tvp)->tv_sec == (uvp)->tv_sec) ? \ 549 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \ 550 ((tvp)->tv_sec cmp (uvp)->tv_sec)) 552 #ifdef EVENT__HAVE_TIMERISSET 553 #define evutil_timerisset(tvp) timerisset(tvp) 555 #define evutil_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec) 560 #define evutil_offsetof(type, field) offsetof(type, field) 562 #define evutil_offsetof(type, field) ((off_t)(&((type *)0)->field)) 568 ev_int64_t
evutil_strtoll(
const char *s,
char **endptr,
int base);
571 #ifdef EVENT__HAVE_GETTIMEOFDAY 572 #define evutil_gettimeofday(tv, tz) gettimeofday((tv), (tz)) 576 int evutil_gettimeofday(
struct timeval *tv,
struct timezone *tz);
585 __attribute__((format(printf, 3, 4)))
592 int evutil_vsnprintf(
char *buf,
size_t buflen,
const char *format, va_list ap)
594 __attribute__((format(printf, 3, 0)))
600 const char *
evutil_inet_ntop(
int af,
const void *src,
char *dst,
size_t len);
651 #ifdef EVENT__HAVE_STRUCT_ADDRINFO 652 #define evutil_addrinfo addrinfo 666 struct sockaddr *ai_addr;
677 #if defined(EAI_ADDRFAMILY) && defined(EVENT__HAVE_GETADDRINFO) 678 #define EVUTIL_EAI_ADDRFAMILY EAI_ADDRFAMILY 680 #define EVUTIL_EAI_ADDRFAMILY -901 682 #if defined(EAI_AGAIN) && defined(EVENT__HAVE_GETADDRINFO) 683 #define EVUTIL_EAI_AGAIN EAI_AGAIN 685 #define EVUTIL_EAI_AGAIN -902 687 #if defined(EAI_BADFLAGS) && defined(EVENT__HAVE_GETADDRINFO) 688 #define EVUTIL_EAI_BADFLAGS EAI_BADFLAGS 690 #define EVUTIL_EAI_BADFLAGS -903 692 #if defined(EAI_FAIL) && defined(EVENT__HAVE_GETADDRINFO) 693 #define EVUTIL_EAI_FAIL EAI_FAIL 695 #define EVUTIL_EAI_FAIL -904 697 #if defined(EAI_FAMILY) && defined(EVENT__HAVE_GETADDRINFO) 698 #define EVUTIL_EAI_FAMILY EAI_FAMILY 700 #define EVUTIL_EAI_FAMILY -905 702 #if defined(EAI_MEMORY) && defined(EVENT__HAVE_GETADDRINFO) 703 #define EVUTIL_EAI_MEMORY EAI_MEMORY 705 #define EVUTIL_EAI_MEMORY -906 710 #if defined(EAI_NODATA) && defined(EVENT__HAVE_GETADDRINFO) && (!defined(EAI_NONAME) || EAI_NODATA != EAI_NONAME) 711 #define EVUTIL_EAI_NODATA EAI_NODATA 713 #define EVUTIL_EAI_NODATA -907 715 #if defined(EAI_NONAME) && defined(EVENT__HAVE_GETADDRINFO) 716 #define EVUTIL_EAI_NONAME EAI_NONAME 718 #define EVUTIL_EAI_NONAME -908 720 #if defined(EAI_SERVICE) && defined(EVENT__HAVE_GETADDRINFO) 721 #define EVUTIL_EAI_SERVICE EAI_SERVICE 723 #define EVUTIL_EAI_SERVICE -909 725 #if defined(EAI_SOCKTYPE) && defined(EVENT__HAVE_GETADDRINFO) 726 #define EVUTIL_EAI_SOCKTYPE EAI_SOCKTYPE 728 #define EVUTIL_EAI_SOCKTYPE -910 730 #if defined(EAI_SYSTEM) && defined(EVENT__HAVE_GETADDRINFO) 731 #define EVUTIL_EAI_SYSTEM EAI_SYSTEM 733 #define EVUTIL_EAI_SYSTEM -911 736 #define EVUTIL_EAI_CANCEL -90001 738 #if defined(AI_PASSIVE) && defined(EVENT__HAVE_GETADDRINFO) 739 #define EVUTIL_AI_PASSIVE AI_PASSIVE 741 #define EVUTIL_AI_PASSIVE 0x1000 743 #if defined(AI_CANONNAME) && defined(EVENT__HAVE_GETADDRINFO) 744 #define EVUTIL_AI_CANONNAME AI_CANONNAME 746 #define EVUTIL_AI_CANONNAME 0x2000 748 #if defined(AI_NUMERICHOST) && defined(EVENT__HAVE_GETADDRINFO) 749 #define EVUTIL_AI_NUMERICHOST AI_NUMERICHOST 751 #define EVUTIL_AI_NUMERICHOST 0x4000 753 #if defined(AI_NUMERICSERV) && defined(EVENT__HAVE_GETADDRINFO) 754 #define EVUTIL_AI_NUMERICSERV AI_NUMERICSERV 756 #define EVUTIL_AI_NUMERICSERV 0x8000 758 #if defined(AI_V4MAPPED) && defined(EVENT__HAVE_GETADDRINFO) 759 #define EVUTIL_AI_V4MAPPED AI_V4MAPPED 761 #define EVUTIL_AI_V4MAPPED 0x10000 763 #if defined(AI_ALL) && defined(EVENT__HAVE_GETADDRINFO) 764 #define EVUTIL_AI_ALL AI_ALL 766 #define EVUTIL_AI_ALL 0x20000 768 #if defined(AI_ADDRCONFIG) && defined(EVENT__HAVE_GETADDRINFO) 769 #define EVUTIL_AI_ADDRCONFIG AI_ADDRCONFIG 771 #define EVUTIL_AI_ADDRCONFIG 0x40000 796 const char *evutil_gai_strerror(
int err);
EVENT2_EXPORT_SYMBOL int evutil_gettime_monotonic(struct evutil_monotonic_timer *timer, struct timeval *tp)
Query the current monotonic time from a struct evutil_monotonic_timer previously configured with evut...
EVENT2_EXPORT_SYMBOL struct evutil_monotonic_timer * evutil_monotonic_timer_new(void)
Allocate a new struct evutil_monotonic_timer for use with the evutil_configure_monotonic_time() and e...
#define evutil_socket_error_to_string(errcode)
Convert a socket error to a string.
Definition: util.h:495
EVENT2_EXPORT_SYMBOL int evutil_closesocket(evutil_socket_t sock)
Do the platform-specific call needed to close a socket returned from socket() or accept().
EVENT2_EXPORT_SYMBOL ev_int64_t evutil_strtoll(const char *s, char **endptr, int base)
Parse a 64-bit value from a string.
EVENT2_EXPORT_SYMBOL void evutil_monotonic_timer_free(struct evutil_monotonic_timer *timer)
Free a struct evutil_monotonic_timer that was allocated using evutil_monotonic_timer_new().
#define evutil_socket_geterror(sock)
Return the most recent socket error to occur on sock.
Definition: util.h:493
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable_port(evutil_socket_t sock)
Do platform-specific operations to make a listener port reusable.
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable(evutil_socket_t sock)
Do platform-specific operations to make a listener socket reusable.
EVENT2_EXPORT_SYMBOL int evutil_vsnprintf(char *buf, size_t buflen, const char *format, va_list ap)
Replacement for vsnprintf to get consistent behavior on platforms for which the return value of snpri...
EVENT2_EXPORT_SYMBOL void evutil_secure_rng_get_bytes(void *buf, size_t n)
Generate n bytes of secure pseudorandom data, and store them in buf.
EVENT2_EXPORT_SYMBOL int evutil_socketpair(int d, int type, int protocol, evutil_socket_t sv[2])
Create two new sockets that are connected to each other.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:312
EVENT2_EXPORT_SYMBOL int evutil_date_rfc1123(char *date, const size_t datelen, const struct tm *tm)
Format a date string using RFC 1123 format (used in HTTP).
EVENT2_EXPORT_SYMBOL int evutil_sockaddr_cmp(const struct sockaddr *sa1, const struct sockaddr *sa2, int include_port)
Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 preceeds sa2...
EVENT2_EXPORT_SYMBOL int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock)
Do platform-specific operations, if possible, to make a tcp listener socket defer accept()s until the...
EVENT2_EXPORT_SYMBOL int evutil_getaddrinfo(const char *nodename, const char *servname, const struct evutil_addrinfo *hints_in, struct evutil_addrinfo **res)
This function clones getaddrinfo for systems that don't have it.
EVENT2_EXPORT_SYMBOL int evutil_inet_pton(int af, const char *src, void *dst)
Replacement for inet_pton for platforms which lack it.
EVENT2_EXPORT_SYMBOL int evutil_make_socket_nonblocking(evutil_socket_t sock)
Do platform-specific operations as needed to make a socket nonblocking.
EVENT2_EXPORT_SYMBOL int evutil_secure_rng_init(void)
Seed the secure random number generator if needed, and return 0 on success or -1 on failure...
EVENT2_EXPORT_SYMBOL int evutil_ascii_strncasecmp(const char *str1, const char *str2, size_t n)
As strncasecmp, but always compares the characters in locale-independent ASCII.
EVENT2_EXPORT_SYMBOL void evutil_secure_rng_add_bytes(const char *dat, size_t datlen)
Seed the random number generator with extra random bytes.
EVENT2_EXPORT_SYMBOL int evutil_parse_sockaddr_port(const char *str, struct sockaddr *out, int *outlen)
Parse an IPv4 or IPv6 address, with optional port, from a string.
EVENT2_EXPORT_SYMBOL int evutil_secure_rng_set_urandom_device_file(char *fname)
Set a filename to use in place of /dev/urandom for seeding the secure PRNG.
EVENT2_EXPORT_SYMBOL const char * evutil_inet_ntop(int af, const void *src, char *dst, size_t len)
Replacement for inet_ntop for platforms which lack it.
A definition of struct addrinfo for systems that lack it.
Definition: util.h:659
EVENT2_EXPORT_SYMBOL int evutil_configure_monotonic_time(struct evutil_monotonic_timer *timer, int flags)
Set up a struct evutil_monotonic_timer; flags can include EV_MONOT_PRECISE and EV_MONOT_FALLBACK.
EVENT2_EXPORT_SYMBOL int evutil_ascii_strcasecmp(const char *str1, const char *str2)
As strcasecmp, but always compares the characters in locale-independent ASCII.
EVENT2_EXPORT_SYMBOL int evutil_make_socket_closeonexec(evutil_socket_t sock)
Do platform-specific operations as needed to close a socket upon a successful execution of one of the...
Structure to hold information about a monotonic timer.
Definition: util.h:327
EVENT2_EXPORT_SYMBOL void evutil_freeaddrinfo(struct evutil_addrinfo *ai)
Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo.
EVENT2_EXPORT_SYMBOL int evutil_snprintf(char *buf, size_t buflen, const char *format,...)
Replacement for snprintf to get consistent behavior on platforms for which the return value of snprin...