Go to the documentation of this file.
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
66 #ifdef EVENT__HAVE_GETADDRINFO
71 #ifdef EVENT__HAVE_ERRNO_H
74 #include <sys/socket.h>
78 #include <libcx/net.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_MIN INT16_MIN
263 #define EV_INT16_MAX INT16_MAX
264 #define EV_UINT8_MAX UINT8_MAX
265 #define EV_INT8_MAX INT8_MAX
266 #define EV_INT8_MIN INT8_MIN
276 #if EVENT__SIZEOF_SIZE_T == 8
277 #define EV_SIZE_MAX EV_UINT64_MAX
278 #define EV_SSIZE_MAX EV_INT64_MAX
279 #elif EVENT__SIZEOF_SIZE_T == 4
280 #define EV_SIZE_MAX EV_UINT32_MAX
281 #define EV_SSIZE_MAX EV_INT32_MAX
282 #elif defined(EVENT_IN_DOXYGEN_)
283 #define EV_SIZE_MAX ...
284 #define EV_SSIZE_MAX ...
286 #error "No way to define SIZE_MAX"
289 #define EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1)
293 #define ev_socklen_t int
294 #elif defined(EVENT__socklen_t)
295 #define ev_socklen_t EVENT__socklen_t
297 #define ev_socklen_t socklen_t
300 #ifdef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY
301 #if !defined(EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY) \
302 && !defined(ss_family)
303 #define ss_family __ss_family
311 #define evutil_socket_t intptr_t
313 #define evutil_socket_t int
329 #ifdef EVENT_IN_DOXYGEN_
334 #define EV_MONOT_PRECISE 1
335 #define EV_MONOT_FALLBACK 2
343 EVENT2_EXPORT_SYMBOL
int
459 #define EVUTIL_CLOSESOCKET(s) evutil_closesocket(s)
477 #define EVUTIL_SOCKET_ERROR() WSAGetLastError()
479 #define EVUTIL_SET_SOCKET_ERROR(errcode) \
480 do { WSASetLastError(errcode); } while (0)
487 #define EVUTIL_INVALID_SOCKET INVALID_SOCKET
488 #elif defined(EVENT_IN_DOXYGEN_)
504 #define EVUTIL_SOCKET_ERROR() ...
506 #define EVUTIL_SET_SOCKET_ERROR(errcode) ...
508 #define evutil_socket_geterror(sock) ...
510 #define evutil_socket_error_to_string(errcode) ...
511 #define EVUTIL_INVALID_SOCKET -1
514 #define EVUTIL_SOCKET_ERROR() (errno)
515 #define EVUTIL_SET_SOCKET_ERROR(errcode) \
516 do { errno = (errcode); } while (0)
517 #define evutil_socket_geterror(sock) (errno)
518 #define evutil_socket_error_to_string(errcode) (strerror(errcode))
519 #define EVUTIL_INVALID_SOCKET -1
531 #ifdef EVENT__HAVE_TIMERADD
532 #define evutil_timeradd(tvp, uvp, vvp) timeradd((tvp), (uvp), (vvp))
533 #define evutil_timersub(tvp, uvp, vvp) timersub((tvp), (uvp), (vvp))
535 #define evutil_timeradd(tvp, uvp, vvp) \
537 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
538 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
539 if ((vvp)->tv_usec >= 1000000) { \
541 (vvp)->tv_usec -= 1000000; \
544 #define evutil_timersub(tvp, uvp, vvp) \
546 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
547 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
548 if ((vvp)->tv_usec < 0) { \
550 (vvp)->tv_usec += 1000000; \
555 #ifdef EVENT__HAVE_TIMERCLEAR
556 #define evutil_timerclear(tvp) timerclear(tvp)
558 #define evutil_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
564 #define evutil_timercmp(tvp, uvp, cmp) \
565 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
566 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
567 ((tvp)->tv_sec cmp (uvp)->tv_sec))
569 #ifdef EVENT__HAVE_TIMERISSET
570 #define evutil_timerisset(tvp) timerisset(tvp)
572 #define evutil_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
577 #define evutil_offsetof(type, field) offsetof(type, field)
579 #define evutil_offsetof(type, field) ((off_t)(&((type *)0)->field))
585 ev_int64_t
evutil_strtoll(
const char *s,
char **endptr,
int base);
588 #ifdef EVENT__HAVE_GETTIMEOFDAY
589 #define evutil_gettimeofday(tv, tz) gettimeofday((tv), (tz))
593 int evutil_gettimeofday(
struct timeval *tv,
struct timezone *tz);
602 __attribute__((format(printf, 3, 4)))
609 int evutil_vsnprintf(
char *buf,
size_t buflen,
const char *format, va_list ap)
611 __attribute__((format(printf, 3, 0)))
617 const char *
evutil_inet_ntop(
int af,
const void *src,
char *dst,
size_t len);
668 #ifdef EVENT__HAVE_STRUCT_ADDRINFO
669 #define evutil_addrinfo addrinfo
683 struct sockaddr *ai_addr;
694 #if defined(EAI_ADDRFAMILY) && defined(EVENT__HAVE_GETADDRINFO)
695 #define EVUTIL_EAI_ADDRFAMILY EAI_ADDRFAMILY
697 #define EVUTIL_EAI_ADDRFAMILY -901
699 #if defined(EAI_AGAIN) && defined(EVENT__HAVE_GETADDRINFO)
700 #define EVUTIL_EAI_AGAIN EAI_AGAIN
702 #define EVUTIL_EAI_AGAIN -902
704 #if defined(EAI_BADFLAGS) && defined(EVENT__HAVE_GETADDRINFO)
705 #define EVUTIL_EAI_BADFLAGS EAI_BADFLAGS
707 #define EVUTIL_EAI_BADFLAGS -903
709 #if defined(EAI_FAIL) && defined(EVENT__HAVE_GETADDRINFO)
710 #define EVUTIL_EAI_FAIL EAI_FAIL
712 #define EVUTIL_EAI_FAIL -904
714 #if defined(EAI_FAMILY) && defined(EVENT__HAVE_GETADDRINFO)
715 #define EVUTIL_EAI_FAMILY EAI_FAMILY
717 #define EVUTIL_EAI_FAMILY -905
719 #if defined(EAI_MEMORY) && defined(EVENT__HAVE_GETADDRINFO)
720 #define EVUTIL_EAI_MEMORY EAI_MEMORY
722 #define EVUTIL_EAI_MEMORY -906
727 #if defined(EAI_NODATA) && defined(EVENT__HAVE_GETADDRINFO) && (!defined(EAI_NONAME) || EAI_NODATA != EAI_NONAME)
728 #define EVUTIL_EAI_NODATA EAI_NODATA
730 #define EVUTIL_EAI_NODATA -907
732 #if defined(EAI_NONAME) && defined(EVENT__HAVE_GETADDRINFO)
733 #define EVUTIL_EAI_NONAME EAI_NONAME
735 #define EVUTIL_EAI_NONAME -908
737 #if defined(EAI_SERVICE) && defined(EVENT__HAVE_GETADDRINFO)
738 #define EVUTIL_EAI_SERVICE EAI_SERVICE
740 #define EVUTIL_EAI_SERVICE -909
742 #if defined(EAI_SOCKTYPE) && defined(EVENT__HAVE_GETADDRINFO)
743 #define EVUTIL_EAI_SOCKTYPE EAI_SOCKTYPE
745 #define EVUTIL_EAI_SOCKTYPE -910
747 #if defined(EAI_SYSTEM) && defined(EVENT__HAVE_GETADDRINFO)
748 #define EVUTIL_EAI_SYSTEM EAI_SYSTEM
750 #define EVUTIL_EAI_SYSTEM -911
753 #define EVUTIL_EAI_CANCEL -90001
755 #if defined(AI_PASSIVE) && defined(EVENT__HAVE_GETADDRINFO)
756 #define EVUTIL_AI_PASSIVE AI_PASSIVE
758 #define EVUTIL_AI_PASSIVE 0x1000
760 #if defined(AI_CANONNAME) && defined(EVENT__HAVE_GETADDRINFO)
761 #define EVUTIL_AI_CANONNAME AI_CANONNAME
763 #define EVUTIL_AI_CANONNAME 0x2000
765 #if defined(AI_NUMERICHOST) && defined(EVENT__HAVE_GETADDRINFO)
766 #define EVUTIL_AI_NUMERICHOST AI_NUMERICHOST
768 #define EVUTIL_AI_NUMERICHOST 0x4000
770 #if defined(AI_NUMERICSERV) && defined(EVENT__HAVE_GETADDRINFO)
771 #define EVUTIL_AI_NUMERICSERV AI_NUMERICSERV
773 #define EVUTIL_AI_NUMERICSERV 0x8000
775 #if defined(AI_V4MAPPED) && defined(EVENT__HAVE_GETADDRINFO)
776 #define EVUTIL_AI_V4MAPPED AI_V4MAPPED
778 #define EVUTIL_AI_V4MAPPED 0x10000
780 #if defined(AI_ALL) && defined(EVENT__HAVE_GETADDRINFO)
781 #define EVUTIL_AI_ALL AI_ALL
783 #define EVUTIL_AI_ALL 0x20000
785 #if defined(AI_ADDRCONFIG) && defined(EVENT__HAVE_GETADDRINFO)
786 #define EVUTIL_AI_ADDRCONFIG AI_ADDRCONFIG
788 #define EVUTIL_AI_ADDRCONFIG 0x40000
813 const char *evutil_gai_strerror(
int err);
862 #if !defined(EVENT__HAVE_ARC4RANDOM) || defined(EVENT__HAVE_ARC4RANDOM_ADDRANDOM)
Structure to hold information about a monotonic timer.
Definition: util.h:328
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_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_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 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_listen_socket_ipv6only(evutil_socket_t sock)
Set ipv6 only bind socket option to make listener work only in ipv6 sockets.
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_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 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_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.
#define evutil_socket_error_to_string(errcode)
Convert a socket error to a string.
Definition: util.h:510
const EVENT2_EXPORT_SYMBOL char * evutil_inet_ntop(int af, const void *src, char *dst, size_t len)
Replacement for inet_ntop for platforms which lack it.
#define evutil_socket_geterror(sock)
Return the most recent socket error to occur on sock.
Definition: util.h:508
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...
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...
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_socketpair(int d, int type, int protocol, evutil_socket_t sv[2])
Create two new sockets that are connected to each other.
EVENT2_EXPORT_SYMBOL void evutil_freeaddrinfo(struct evutil_addrinfo *ai)
Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo.
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...
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 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 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_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_closesocket(evutil_socket_t sock)
Do the platform-specific call needed to close a socket returned from socket() or accept().
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().
A definition of struct addrinfo for systems that lack it.
Definition: util.h:676
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.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:313