2 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #ifndef UTIL_INTERNAL_H_INCLUDED_
27 #define UTIL_INTERNAL_H_INCLUDED_
29 #include "event2/event-config.h"
30 #include "evconfig-private.h"
34 /* For EVUTIL_ASSERT */
35 #include "log-internal.h"
38 #ifdef EVENT__HAVE_SYS_SOCKET_H
39 #include <sys/socket.h>
41 #ifdef EVENT__HAVE_SYS_EVENTFD_H
42 #include <sys/eventfd.h>
44 #include "event2/util.h"
46 #include "time-internal.h"
47 #include "ipv6-internal.h"
53 /* __has_attribute() wrapper */
54 #ifdef __has_attribute
55 # define EVUTIL_HAS_ATTRIBUTE __has_attribute
57 /** clang 3 __has_attribute misbehaves in some versions */
58 #if defined(__clang__) && __clang__ == 1
59 # if defined(__apple_build_version__)
60 # if __clang_major__ <= 6
61 # undef EVUTIL_HAS_ATTRIBUTE
63 # else /* !__apple_build_version__ */
64 # if __clang_major__ == 3 && __clang_minor__ >= 2 && __clang_minor__ <= 5
65 # undef EVUTIL_HAS_ATTRIBUTE
67 # endif /* __apple_build_version__ */
68 #endif /*\ defined(__clang__) && __clang__ == 1 */
69 #ifndef EVUTIL_HAS_ATTRIBUTE
70 # define EVUTIL_HAS_ATTRIBUTE(x) 0
73 /* If we need magic to say "inline", get it for free internally. */
75 #define inline EVENT__inline
78 /* Define to appropriate substitute if compiler doesnt have __func__ */
79 #if defined(EVENT__HAVE___func__)
81 # define __func__ __func__
83 #elif defined(EVENT__HAVE___FUNCTION__)
84 # define __func__ __FUNCTION__
86 # define __func__ __FILE__
89 /* A good no-op to use in macro definitions. */
90 #define EVUTIL_NIL_STMT_ ((void)0)
91 /* A no-op that tricks the compiler into thinking a condition is used while
92 * definitely not making any code for it. Used to compile out asserts while
93 * avoiding "unused variable" warnings. The "!" forces the compiler to
94 * do the sizeof() on an int, in case "condition" is a bitfield value.
96 #define EVUTIL_NIL_CONDITION_(condition) do { \
97 (void)sizeof(!(condition)); \
100 /* Internal use only: macros to match patterns of error codes in a
101 cross-platform way. We need these macros because of two historical
102 reasons: first, nonblocking IO functions are generally written to give an
103 error on the "blocked now, try later" case, so sometimes an error from a
104 read, write, connect, or accept means "no error; just wait for more
105 data," and we need to look at the error code. Second, Windows defines
106 a different set of error codes for sockets. */
110 #if EAGAIN == EWOULDBLOCK
111 #define EVUTIL_ERR_IS_EAGAIN(e) \
114 #define EVUTIL_ERR_IS_EAGAIN(e) \
115 ((e) == EAGAIN || (e) == EWOULDBLOCK)
118 /* True iff e is an error that means a read/write operation can be retried. */
119 #define EVUTIL_ERR_RW_RETRIABLE(e) \
120 ((e) == EINTR || EVUTIL_ERR_IS_EAGAIN(e))
121 /* True iff e is an error that means an connect can be retried. */
122 #define EVUTIL_ERR_CONNECT_RETRIABLE(e) \
123 ((e) == EINTR || (e) == EINPROGRESS)
124 /* True iff e is an error that means a accept can be retried. */
125 #define EVUTIL_ERR_ACCEPT_RETRIABLE(e) \
126 ((e) == EINTR || EVUTIL_ERR_IS_EAGAIN(e) || (e) == ECONNABORTED)
128 /* True iff e is an error that means the connection was refused */
129 #define EVUTIL_ERR_CONNECT_REFUSED(e) \
130 ((e) == ECONNREFUSED)
135 #define EVUTIL_ERR_IS_EAGAIN(e) \
136 ((e) == WSAEWOULDBLOCK || (e) == EAGAIN)
138 #define EVUTIL_ERR_RW_RETRIABLE(e) \
139 ((e) == WSAEWOULDBLOCK || \
142 #define EVUTIL_ERR_CONNECT_RETRIABLE(e) \
143 ((e) == WSAEWOULDBLOCK || \
145 (e) == WSAEINPROGRESS || \
148 #define EVUTIL_ERR_ACCEPT_RETRIABLE(e) \
149 EVUTIL_ERR_RW_RETRIABLE(e)
151 #define EVUTIL_ERR_CONNECT_REFUSED(e) \
152 ((e) == WSAECONNREFUSED)
156 /* Arguments for shutdown() */
158 #define EVUTIL_SHUT_RD SHUT_RD
160 #define EVUTIL_SHUT_RD 0
163 #define EVUTIL_SHUT_WR SHUT_WR
165 #define EVUTIL_SHUT_WR 1 /* SD_SEND */
168 #define EVUTIL_SHUT_BOTH SHUT_BOTH
170 #define EVUTIL_SHUT_BOTH 2
173 /* Helper: Verify that all the elements in 'dlist' are internally consistent.
174 * Checks for circular lists and bad prev/next pointers.
177 * EVUTIL_ASSERT_LIST_OK(eventlist, event, ev_next);
179 #define EVUTIL_ASSERT_LIST_OK(dlist, type, field) do { \
180 struct type *elm1, *elm2, **nextp; \
181 if (LIST_EMPTY((dlist))) \
184 /* Check list for circularity using Floyd's */ \
185 /* 'Tortoise and Hare' algorithm */ \
186 elm1 = LIST_FIRST((dlist)); \
187 elm2 = LIST_NEXT(elm1, field); \
188 while (elm1 && elm2) { \
189 EVUTIL_ASSERT(elm1 != elm2); \
190 elm1 = LIST_NEXT(elm1, field); \
191 elm2 = LIST_NEXT(elm2, field); \
194 EVUTIL_ASSERT(elm1 != elm2); \
195 elm2 = LIST_NEXT(elm2, field); \
198 /* Now check next and prev pointers for consistency. */ \
199 nextp = &LIST_FIRST((dlist)); \
200 elm1 = LIST_FIRST((dlist)); \
202 EVUTIL_ASSERT(*nextp == elm1); \
203 EVUTIL_ASSERT(nextp == elm1->field.le_prev); \
204 nextp = &LIST_NEXT(elm1, field); \
209 /* Helper: Verify that all the elements in a TAILQ are internally consistent.
210 * Checks for circular lists and bad prev/next pointers.
213 * EVUTIL_ASSERT_TAILQ_OK(activelist, event, ev_active_next);
215 #define EVUTIL_ASSERT_TAILQ_OK(tailq, type, field) do { \
216 struct type *elm1, *elm2, **nextp; \
217 if (TAILQ_EMPTY((tailq))) \
220 /* Check list for circularity using Floyd's */ \
221 /* 'Tortoise and Hare' algorithm */ \
222 elm1 = TAILQ_FIRST((tailq)); \
223 elm2 = TAILQ_NEXT(elm1, field); \
224 while (elm1 && elm2) { \
225 EVUTIL_ASSERT(elm1 != elm2); \
226 elm1 = TAILQ_NEXT(elm1, field); \
227 elm2 = TAILQ_NEXT(elm2, field); \
230 EVUTIL_ASSERT(elm1 != elm2); \
231 elm2 = TAILQ_NEXT(elm2, field); \
234 /* Now check next and prev pointers for consistency. */ \
235 nextp = &TAILQ_FIRST((tailq)); \
236 elm1 = TAILQ_FIRST((tailq)); \
238 EVUTIL_ASSERT(*nextp == elm1); \
239 EVUTIL_ASSERT(nextp == elm1->field.tqe_prev); \
240 nextp = &TAILQ_NEXT(elm1, field); \
243 EVUTIL_ASSERT(nextp == (tailq)->tqh_last); \
246 /* Locale-independent replacements for some ctypes functions. Use these
247 * when you care about ASCII's notion of character types, because you are about
248 * to send those types onto the wire.
251 int EVUTIL_ISALPHA_(char c);
253 int EVUTIL_ISALNUM_(char c);
254 int EVUTIL_ISSPACE_(char c);
256 int EVUTIL_ISDIGIT_(char c);
258 int EVUTIL_ISXDIGIT_(char c);
259 int EVUTIL_ISPRINT_(char c);
260 int EVUTIL_ISLOWER_(char c);
261 int EVUTIL_ISUPPER_(char c);
263 char EVUTIL_TOUPPER_(char c);
265 char EVUTIL_TOLOWER_(char c);
267 /** Remove all trailing horizontal whitespace (space or tab) from the end of a
270 void evutil_rtrim_lws_(char *);
273 /** Helper macro. If we know that a given pointer points to a field in a
274 structure, return a pointer to the structure itself. Used to implement
275 our half-baked C OO. Example:
279 struct supertype common;
283 void fn(struct supertype *super) {
284 struct subtype *sub = EVUTIL_UPCAST(super, struct subtype, common);
288 #define EVUTIL_UPCAST(ptr, type, field) \
289 ((type *)(((char*)(ptr)) - evutil_offsetof(type, field)))
291 /* As open(pathname, flags, mode), except that the file is always opened with
292 * the close-on-exec flag set. (And the mode argument is mandatory.)
294 int evutil_open_closeonexec_(const char *pathname, int flags, unsigned mode);
297 int evutil_read_file_(const char *filename, char **content_out, size_t *len_out,
301 int evutil_socket_connect_(evutil_socket_t *fd_ptr, const struct sockaddr *sa, int socklen);
304 int evutil_socket_finished_connecting_(evutil_socket_t fd);
306 #ifdef EVENT__HAVE_AFUNIX_H
308 int evutil_check_working_afunix_();
312 int evutil_ersatz_socketpair_(int, int , int, evutil_socket_t[2]);
314 int evutil_resolve_(int family, const char *hostname, struct sockaddr *sa,
315 ev_socklen_t *socklen, int port);
317 const char *evutil_getenv_(const char *name);
319 /* Structure to hold the state of our weak random number generator.
321 struct evutil_weakrand_state {
325 #define EVUTIL_WEAKRAND_MAX EV_INT32_MAX
327 /* Initialize the state of a week random number generator based on 'seed'. If
328 * the seed is 0, construct a new seed based on not-very-strong platform
329 * entropy, like the PID and the time of day.
331 * This function, and the other evutil_weakrand* functions, are meant for
332 * speed, not security or statistical strength. If you need a RNG which an
333 * attacker can't predict, or which passes strong statistical tests, use the
334 * evutil_secure_rng* functions instead.
337 ev_uint32_t evutil_weakrand_seed_(struct evutil_weakrand_state *state, ev_uint32_t seed);
338 /* Return a pseudorandom value between 0 and EVUTIL_WEAKRAND_MAX inclusive.
339 * Updates the state in 'seed' as needed -- this value must be protected by a
343 ev_int32_t evutil_weakrand_(struct evutil_weakrand_state *seed);
344 /* Return a pseudorandom value x such that 0 <= x < top. top must be no more
345 * than EVUTIL_WEAKRAND_MAX. Updates the state in 'seed' as needed -- this
346 * value must be proteced by a lock */
348 ev_int32_t evutil_weakrand_range_(struct evutil_weakrand_state *seed, ev_int32_t top);
350 /* Evaluates to the same boolean value as 'p', and hints to the compiler that
351 * we expect this value to be false. */
352 #if defined(__GNUC__) && __GNUC__ >= 3 /* gcc 3.0 or later */
353 #define EVUTIL_UNLIKELY(p) __builtin_expect(!!(p),0)
355 #define EVUTIL_UNLIKELY(p) (p)
358 #if EVUTIL_HAS_ATTRIBUTE(fallthrough)
359 #define EVUTIL_FALLTHROUGH __attribute__((fallthrough))
361 #define EVUTIL_FALLTHROUGH /* fallthrough */
364 /* Replacement for assert() that calls event_errx on failure. */
366 #define EVUTIL_ASSERT(cond) EVUTIL_NIL_CONDITION_(cond)
367 #define EVUTIL_FAILURE_CHECK(cond) 0
369 #define EVUTIL_ASSERT(cond) \
371 if (EVUTIL_UNLIKELY(!(cond))) { \
372 event_errx(EVENT_ERR_ABORT_, \
373 "%s:%d: Assertion %s failed in %s", \
374 __FILE__,__LINE__,#cond,__func__); \
375 /* In case a user-supplied handler tries to */ \
376 /* return control to us, log and abort here. */ \
377 (void)fprintf(stderr, \
378 "%s:%d: Assertion %s failed in %s", \
379 __FILE__,__LINE__,#cond,__func__); \
383 #define EVUTIL_FAILURE_CHECK(cond) EVUTIL_UNLIKELY(cond)
386 #ifndef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE
387 /* Replacement for sockaddr storage that we can use internally on platforms
388 * that lack it. It is not space-efficient, but neither is sockaddr_storage.
390 struct sockaddr_storage {
392 struct sockaddr ss_sa;
393 struct sockaddr_in ss_sin;
394 struct sockaddr_in6 ss_sin6;
395 char ss_padding[128];
398 #define ss_family ss_union.ss_sa.sa_family
401 /* Internal addrinfo error code. This one is returned from only from
402 * evutil_getaddrinfo_common_, when we are sure that we'll have to hit a DNS
404 #define EVUTIL_EAI_NEED_RESOLVE -90002
407 struct evdns_getaddrinfo_request;
408 typedef struct evdns_getaddrinfo_request* (*evdns_getaddrinfo_fn)(
409 struct evdns_base *base,
410 const char *nodename, const char *servname,
411 const struct evutil_addrinfo *hints_in,
412 void (*cb)(int, struct evutil_addrinfo *, void *), void *arg);
414 void evutil_set_evdns_getaddrinfo_fn_(evdns_getaddrinfo_fn fn);
415 typedef void (*evdns_getaddrinfo_cancel_fn)(
416 struct evdns_getaddrinfo_request *req);
418 void evutil_set_evdns_getaddrinfo_cancel_fn_(evdns_getaddrinfo_cancel_fn fn);
421 struct evutil_addrinfo *evutil_new_addrinfo_(struct sockaddr *sa,
422 ev_socklen_t socklen, const struct evutil_addrinfo *hints);
424 struct evutil_addrinfo *evutil_addrinfo_append_(struct evutil_addrinfo *first,
425 struct evutil_addrinfo *append);
427 void evutil_adjust_hints_for_addrconfig_(struct evutil_addrinfo *hints);
429 int evutil_getaddrinfo_common_(const char *nodename, const char *servname,
430 struct evutil_addrinfo *hints, struct evutil_addrinfo **res, int *portnum);
432 struct evdns_getaddrinfo_request *evutil_getaddrinfo_async_(
433 struct evdns_base *dns_base,
434 const char *nodename, const char *servname,
435 const struct evutil_addrinfo *hints_in,
436 void (*cb)(int, struct evutil_addrinfo *, void *), void *arg);
437 void evutil_getaddrinfo_cancel_async_(struct evdns_getaddrinfo_request *data);
439 /** Return true iff sa is a looback address. (That is, it is 127.0.0.1/8, or
442 int evutil_sockaddr_is_loopback_(const struct sockaddr *sa);
446 Formats a sockaddr sa into a string buffer of size outlen stored in out.
447 Returns a pointer to out. Always writes something into out, so it's safe
448 to use the output of this function without checking it for NULL.
451 const char *evutil_format_sockaddr_port_(const struct sockaddr *sa, char *out, size_t outlen);
453 int evutil_hex_char_to_int_(char c);
456 void evutil_free_secure_rng_globals_(void);
457 void evutil_free_globals_(void);
461 HMODULE evutil_load_windows_system_library_(const TCHAR *library_name);
464 #if defined(_MSC_VER) || defined(__MINGW32__) || defined(__MINGW64__)
472 #define EV_U64_FMT "%I64u"
473 #define EV_I64_FMT "%I64d"
474 #define EV_I64_ARG(x) ((__int64)(x))
475 #define EV_U64_ARG(x) ((unsigned __int64)(x))
477 #define EV_U64_FMT "%llu"
478 #define EV_I64_FMT "%lld"
479 #define EV_I64_ARG(x) ((long long)(x))
480 #define EV_U64_ARG(x) ((unsigned long long)(x))
485 #define EV_SOCK_FMT EV_I64_FMT
486 #define EV_SOCK_ARG(x) EV_I64_ARG((x))
488 #define EV_SOCK_FMT "%d"
489 #define EV_SOCK_ARG(x) (x)
492 #if defined(__STDC__) && defined(__STDC_VERSION__) && !defined(__MINGW64_VERSION_MAJOR)
493 #if (__STDC_VERSION__ >= 199901L)
494 #define EV_SIZE_FMT "%zu"
495 #define EV_SSIZE_FMT "%zd"
496 #define EV_SIZE_ARG(x) (x)
497 #define EV_SSIZE_ARG(x) (x)
502 #if (EVENT__SIZEOF_SIZE_T <= EVENT__SIZEOF_LONG)
503 #define EV_SIZE_FMT "%lu"
504 #define EV_SSIZE_FMT "%ld"
505 #define EV_SIZE_ARG(x) ((unsigned long)(x))
506 #define EV_SSIZE_ARG(x) ((long)(x))
508 #define EV_SIZE_FMT EV_U64_FMT
509 #define EV_SSIZE_FMT EV_I64_FMT
510 #define EV_SIZE_ARG(x) EV_U64_ARG(x)
511 #define EV_SSIZE_ARG(x) EV_I64_ARG(x)
516 evutil_socket_t evutil_socket_(int domain, int type, int protocol);
517 evutil_socket_t evutil_accept4_(evutil_socket_t sockfd, struct sockaddr *addr,
518 ev_socklen_t *addrlen, int flags);
520 /* used by one of the test programs.. */
522 int evutil_make_internal_pipe_(evutil_socket_t fd[2]);
523 evutil_socket_t evutil_eventfd_(unsigned initval, int flags);
526 #define EVUTIL_SOCK_NONBLOCK SOCK_NONBLOCK
528 #define EVUTIL_SOCK_NONBLOCK 0x4000000
531 #define EVUTIL_SOCK_CLOEXEC SOCK_CLOEXEC
533 #define EVUTIL_SOCK_CLOEXEC 0x80000000
536 #define EVUTIL_EFD_NONBLOCK EFD_NONBLOCK
538 #define EVUTIL_EFD_NONBLOCK 0x4000
541 #define EVUTIL_EFD_CLOEXEC EFD_CLOEXEC
543 #define EVUTIL_EFD_CLOEXEC 0x8000
546 void evutil_memclear_(void *mem, size_t len);
551 /* This is a any, loopback, link-local, multicast */
553 int evutil_v4addr_is_local_(const struct in_addr *in);
554 /* This is a reserved, ipv4compat, ipv4map, loopback,
555 * link-local, multicast, or unspecified address. */
557 int evutil_v6addr_is_local_(const struct in6_addr *in);