2 * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
3 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include "event2/event-config.h"
28 #include "evconfig-private.h"
32 #define WIN32_LEAN_AND_MEAN
34 #undef WIN32_LEAN_AND_MEAN
36 #include <sys/types.h>
37 #if !defined(_WIN32) && defined(EVENT__HAVE_SYS_TIME_H)
40 #include <sys/queue.h>
41 #ifdef EVENT__HAVE_SYS_SOCKET_H
42 #include <sys/socket.h>
46 #ifdef EVENT__HAVE_UNISTD_H
55 #ifdef EVENT__HAVE_FCNTL_H
59 #include "event2/event.h"
60 #include "event2/event_struct.h"
61 #include "event2/event_compat.h"
62 #include "event-internal.h"
63 #include "defer-internal.h"
64 #include "evthread-internal.h"
65 #include "event2/thread.h"
66 #include "event2/util.h"
67 #include "log-internal.h"
68 #include "evmap-internal.h"
69 #include "iocp-internal.h"
70 #include "changelist-internal.h"
71 #define HT_NO_CACHE_HASH_VALUES
72 #include "ht-internal.h"
73 #include "util-internal.h"
76 #ifdef EVENT__HAVE_WORKING_KQUEUE
77 #include "kqueue-internal.h"
80 #ifdef EVENT__HAVE_EVENT_PORTS
81 extern const struct eventop evportops;
83 #ifdef EVENT__HAVE_SELECT
84 extern const struct eventop selectops;
86 #ifdef EVENT__HAVE_POLL
87 extern const struct eventop pollops;
89 #ifdef EVENT__HAVE_EPOLL
90 extern const struct eventop epollops;
92 #ifdef EVENT__HAVE_WORKING_KQUEUE
93 extern const struct eventop kqops;
95 #ifdef EVENT__HAVE_DEVPOLL
96 extern const struct eventop devpollops;
99 extern const struct eventop win32ops;
102 /* Array of backends in order of preference. */
103 static const struct eventop *eventops[] = {
104 #ifdef EVENT__HAVE_EVENT_PORTS
107 #ifdef EVENT__HAVE_WORKING_KQUEUE
110 #ifdef EVENT__HAVE_EPOLL
113 #ifdef EVENT__HAVE_DEVPOLL
116 #ifdef EVENT__HAVE_POLL
119 #ifdef EVENT__HAVE_SELECT
128 /* Global state; deprecated */
130 struct event_base *event_global_current_base_ = NULL;
131 #define current_base event_global_current_base_
135 static void *event_self_cbarg_ptr_ = NULL;
138 static void event_queue_insert_active(struct event_base *, struct event_callback *);
139 static void event_queue_insert_active_later(struct event_base *, struct event_callback *);
140 static void event_queue_insert_timeout(struct event_base *, struct event *);
141 static void event_queue_insert_inserted(struct event_base *, struct event *);
142 static void event_queue_remove_active(struct event_base *, struct event_callback *);
143 static void event_queue_remove_active_later(struct event_base *, struct event_callback *);
144 static void event_queue_remove_timeout(struct event_base *, struct event *);
145 static void event_queue_remove_inserted(struct event_base *, struct event *);
146 static void event_queue_make_later_events_active(struct event_base *base);
148 static int evthread_make_base_notifiable_nolock_(struct event_base *base);
149 static int event_del_(struct event *ev, int blocking);
151 #ifdef USE_REINSERT_TIMEOUT
152 /* This code seems buggy; only turn it on if we find out what the trouble is. */
153 static void event_queue_reinsert_timeout(struct event_base *,struct event *, int was_common, int is_common, int old_timeout_idx);
156 static int event_haveevents(struct event_base *);
158 static int event_process_active(struct event_base *);
160 static int timeout_next(struct event_base *, struct timeval **);
161 static void timeout_process(struct event_base *);
163 static inline void event_signal_closure(struct event_base *, struct event *ev);
164 static inline void event_persist_closure(struct event_base *, struct event *ev);
166 static int evthread_notify_base(struct event_base *base);
168 static void insert_common_timeout_inorder(struct common_timeout_list *ctl,
171 #ifndef EVENT__DISABLE_DEBUG_MODE
172 /* These functions implement a hashtable of which 'struct event *' structures
173 * have been setup or added. We don't want to trust the content of the struct
174 * event itself, since we're trying to work through cases where an event gets
175 * clobbered or freed. Instead, we keep a hashtable indexed by the pointer.
178 struct event_debug_entry {
179 HT_ENTRY(event_debug_entry) node;
180 const struct event *ptr;
184 static inline unsigned
185 hash_debug_entry(const struct event_debug_entry *e)
187 /* We need to do this silliness to convince compilers that we
188 * honestly mean to cast e->ptr to an integer, and discard any
189 * part of it that doesn't fit in an unsigned.
191 unsigned u = (unsigned) ((ev_uintptr_t) e->ptr);
192 /* Our hashtable implementation is pretty sensitive to low bits,
193 * and every struct event is over 64 bytes in size, so we can
199 eq_debug_entry(const struct event_debug_entry *a,
200 const struct event_debug_entry *b)
202 return a->ptr == b->ptr;
205 int event_debug_mode_on_ = 0;
208 #if !defined(EVENT__DISABLE_THREAD_SUPPORT) && !defined(EVENT__DISABLE_DEBUG_MODE)
210 * @brief debug mode variable which is set for any function/structure that needs
211 * to be shared across threads (if thread support is enabled).
213 * When and if evthreads are initialized, this variable will be evaluated,
214 * and if set to something other than zero, this means the evthread setup
215 * functions were called out of order.
217 * See: "Locks and threading" in the documentation.
219 int event_debug_created_threadable_ctx_ = 0;
222 /* Set if it's too late to enable event_debug_mode. */
223 static int event_debug_mode_too_late = 0;
224 #ifndef EVENT__DISABLE_THREAD_SUPPORT
225 static void *event_debug_map_lock_ = NULL;
227 static HT_HEAD(event_debug_map, event_debug_entry) global_debug_map =
230 HT_PROTOTYPE(event_debug_map, event_debug_entry, node, hash_debug_entry,
232 HT_GENERATE(event_debug_map, event_debug_entry, node, hash_debug_entry,
233 eq_debug_entry, 0.5, mm_malloc, mm_realloc, mm_free)
235 /* record that ev is now setup (that is, ready for an add) */
236 static void event_debug_note_setup_(const struct event *ev)
238 struct event_debug_entry *dent, find;
240 if (!event_debug_mode_on_)
244 EVLOCK_LOCK(event_debug_map_lock_, 0);
245 dent = HT_FIND(event_debug_map, &global_debug_map, &find);
249 dent = mm_malloc(sizeof(*dent));
252 "Out of memory in debugging code");
255 HT_INSERT(event_debug_map, &global_debug_map, dent);
257 EVLOCK_UNLOCK(event_debug_map_lock_, 0);
260 event_debug_mode_too_late = 1;
262 /* record that ev is no longer setup */
263 static void event_debug_note_teardown_(const struct event *ev)
265 struct event_debug_entry *dent, find;
267 if (!event_debug_mode_on_)
271 EVLOCK_LOCK(event_debug_map_lock_, 0);
272 dent = HT_REMOVE(event_debug_map, &global_debug_map, &find);
275 EVLOCK_UNLOCK(event_debug_map_lock_, 0);
278 event_debug_mode_too_late = 1;
280 /* Macro: record that ev is now added */
281 static void event_debug_note_add_(const struct event *ev)
283 struct event_debug_entry *dent,find;
285 if (!event_debug_mode_on_)
289 EVLOCK_LOCK(event_debug_map_lock_, 0);
290 dent = HT_FIND(event_debug_map, &global_debug_map, &find);
294 event_errx(EVENT_ERR_ABORT_,
295 "%s: noting an add on a non-setup event %p"
296 " (events: 0x%x, fd: "EV_SOCK_FMT
298 __func__, ev, ev->ev_events,
299 EV_SOCK_ARG(ev->ev_fd), ev->ev_flags);
301 EVLOCK_UNLOCK(event_debug_map_lock_, 0);
304 event_debug_mode_too_late = 1;
306 /* record that ev is no longer added */
307 static void event_debug_note_del_(const struct event *ev)
309 struct event_debug_entry *dent, find;
311 if (!event_debug_mode_on_)
315 EVLOCK_LOCK(event_debug_map_lock_, 0);
316 dent = HT_FIND(event_debug_map, &global_debug_map, &find);
320 event_errx(EVENT_ERR_ABORT_,
321 "%s: noting a del on a non-setup event %p"
322 " (events: 0x%x, fd: "EV_SOCK_FMT
324 __func__, ev, ev->ev_events,
325 EV_SOCK_ARG(ev->ev_fd), ev->ev_flags);
327 EVLOCK_UNLOCK(event_debug_map_lock_, 0);
330 event_debug_mode_too_late = 1;
332 /* assert that ev is setup (i.e., okay to add or inspect) */
333 static void event_debug_assert_is_setup_(const struct event *ev)
335 struct event_debug_entry *dent, find;
337 if (!event_debug_mode_on_)
341 EVLOCK_LOCK(event_debug_map_lock_, 0);
342 dent = HT_FIND(event_debug_map, &global_debug_map, &find);
344 event_errx(EVENT_ERR_ABORT_,
345 "%s called on a non-initialized event %p"
346 " (events: 0x%x, fd: "EV_SOCK_FMT
348 __func__, ev, ev->ev_events,
349 EV_SOCK_ARG(ev->ev_fd), ev->ev_flags);
351 EVLOCK_UNLOCK(event_debug_map_lock_, 0);
353 /* assert that ev is not added (i.e., okay to tear down or set up again) */
354 static void event_debug_assert_not_added_(const struct event *ev)
356 struct event_debug_entry *dent, find;
358 if (!event_debug_mode_on_)
362 EVLOCK_LOCK(event_debug_map_lock_, 0);
363 dent = HT_FIND(event_debug_map, &global_debug_map, &find);
364 if (dent && dent->added) {
365 event_errx(EVENT_ERR_ABORT_,
366 "%s called on an already added event %p"
367 " (events: 0x%x, fd: "EV_SOCK_FMT", "
369 __func__, ev, ev->ev_events,
370 EV_SOCK_ARG(ev->ev_fd), ev->ev_flags);
372 EVLOCK_UNLOCK(event_debug_map_lock_, 0);
374 static void event_debug_assert_socket_nonblocking_(evutil_socket_t fd)
376 if (!event_debug_mode_on_)
384 if ((flags = fcntl(fd, F_GETFL, NULL)) >= 0) {
385 EVUTIL_ASSERT(flags & O_NONBLOCK);
391 static void event_debug_note_setup_(const struct event *ev) { (void)ev; }
392 static void event_debug_note_teardown_(const struct event *ev) { (void)ev; }
393 static void event_debug_note_add_(const struct event *ev) { (void)ev; }
394 static void event_debug_note_del_(const struct event *ev) { (void)ev; }
395 static void event_debug_assert_is_setup_(const struct event *ev) { (void)ev; }
396 static void event_debug_assert_not_added_(const struct event *ev) { (void)ev; }
397 static void event_debug_assert_socket_nonblocking_(evutil_socket_t fd) { (void)fd; }
400 #define EVENT_BASE_ASSERT_LOCKED(base) \
401 EVLOCK_ASSERT_LOCKED((base)->th_base_lock)
403 /* How often (in seconds) do we check for changes in wall clock time relative
404 * to monotonic time? Set this to -1 for 'never.' */
405 #define CLOCK_SYNC_INTERVAL 5
407 /** Set 'tp' to the current time according to 'base'. We must hold the lock
408 * on 'base'. If there is a cached time, return it. Otherwise, use
409 * clock_gettime or gettimeofday as appropriate to find out the right time.
410 * Return 0 on success, -1 on failure.
413 gettime(struct event_base *base, struct timeval *tp)
415 EVENT_BASE_ASSERT_LOCKED(base);
417 if (base->tv_cache.tv_sec) {
418 *tp = base->tv_cache;
422 if (evutil_gettime_monotonic_(&base->monotonic_timer, tp) == -1) {
426 if (base->last_updated_clock_diff + CLOCK_SYNC_INTERVAL
429 evutil_gettimeofday(&tv,NULL);
430 evutil_timersub(&tv, tp, &base->tv_clock_diff);
431 base->last_updated_clock_diff = tp->tv_sec;
438 event_base_gettimeofday_cached(struct event_base *base, struct timeval *tv)
444 return evutil_gettimeofday(tv, NULL);
447 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
448 if (base->tv_cache.tv_sec == 0) {
449 r = evutil_gettimeofday(tv, NULL);
451 evutil_timeradd(&base->tv_cache, &base->tv_clock_diff, tv);
454 EVBASE_RELEASE_LOCK(base, th_base_lock);
458 /** Make 'base' have no current cached time. */
460 clear_time_cache(struct event_base *base)
462 base->tv_cache.tv_sec = 0;
465 /** Replace the cached time in 'base' with the current time. */
467 update_time_cache(struct event_base *base)
469 base->tv_cache.tv_sec = 0;
470 if (!(base->flags & EVENT_BASE_FLAG_NO_CACHE_TIME))
471 gettime(base, &base->tv_cache);
475 event_base_update_cache_time(struct event_base *base)
484 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
485 if (base->running_loop)
486 update_time_cache(base);
487 EVBASE_RELEASE_LOCK(base, th_base_lock);
491 static inline struct event *
492 event_callback_to_event(struct event_callback *evcb)
494 EVUTIL_ASSERT((evcb->evcb_flags & EVLIST_INIT));
495 return EVUTIL_UPCAST(evcb, struct event, ev_evcallback);
498 static inline struct event_callback *
499 event_to_event_callback(struct event *ev)
501 return &ev->ev_evcallback;
507 struct event_base *base = event_base_new_with_config(NULL);
510 event_errx(1, "%s: Unable to construct event_base", __func__);
522 struct event_base *base = NULL;
523 struct event_config *cfg = event_config_new();
525 base = event_base_new_with_config(cfg);
526 event_config_free(cfg);
531 /** Return true iff 'method' is the name of a method that 'cfg' tells us to
534 event_config_is_avoided_method(const struct event_config *cfg,
537 struct event_config_entry *entry;
539 TAILQ_FOREACH(entry, &cfg->entries, next) {
540 if (entry->avoid_method != NULL &&
541 strcmp(entry->avoid_method, method) == 0)
548 /** Return true iff 'method' is disabled according to the environment. */
550 event_is_method_disabled(const char *name)
552 char environment[64];
555 evutil_snprintf(environment, sizeof(environment), "EVENT_NO%s", name);
556 for (i = 8; environment[i] != '\0'; ++i)
557 environment[i] = EVUTIL_TOUPPER_(environment[i]);
558 /* Note that evutil_getenv_() ignores the environment entirely if
560 return (evutil_getenv_(environment) != NULL);
564 event_base_get_features(const struct event_base *base)
566 return base->evsel->features;
570 event_enable_debug_mode(void)
572 #ifndef EVENT__DISABLE_DEBUG_MODE
573 if (event_debug_mode_on_)
574 event_errx(1, "%s was called twice!", __func__);
575 if (event_debug_mode_too_late)
576 event_errx(1, "%s must be called *before* creating any events "
577 "or event_bases",__func__);
579 event_debug_mode_on_ = 1;
581 HT_INIT(event_debug_map, &global_debug_map);
586 event_disable_debug_mode(void)
588 #ifndef EVENT__DISABLE_DEBUG_MODE
589 struct event_debug_entry **ent, *victim;
591 EVLOCK_LOCK(event_debug_map_lock_, 0);
592 for (ent = HT_START(event_debug_map, &global_debug_map); ent; ) {
594 ent = HT_NEXT_RMV(event_debug_map, &global_debug_map, ent);
597 HT_CLEAR(event_debug_map, &global_debug_map);
598 EVLOCK_UNLOCK(event_debug_map_lock_ , 0);
600 event_debug_mode_on_ = 0;
605 event_base_new_with_config(const struct event_config *cfg)
608 struct event_base *base;
609 int should_check_environment;
611 #ifndef EVENT__DISABLE_DEBUG_MODE
612 event_debug_mode_too_late = 1;
615 if ((base = mm_calloc(1, sizeof(struct event_base))) == NULL) {
616 event_warn("%s: calloc", __func__);
621 base->flags = cfg->flags;
623 should_check_environment =
624 !(cfg && (cfg->flags & EVENT_BASE_FLAG_IGNORE_ENV));
629 cfg && (cfg->flags & EVENT_BASE_FLAG_PRECISE_TIMER);
631 if (should_check_environment && !precise_time) {
632 precise_time = evutil_getenv_("EVENT_PRECISE_TIMER") != NULL;
634 base->flags |= EVENT_BASE_FLAG_PRECISE_TIMER;
637 flags = precise_time ? EV_MONOT_PRECISE : 0;
638 evutil_configure_monotonic_time_(&base->monotonic_timer, flags);
643 min_heap_ctor_(&base->timeheap);
645 base->sig.ev_signal_pair[0] = -1;
646 base->sig.ev_signal_pair[1] = -1;
647 base->th_notify_fd[0] = -1;
648 base->th_notify_fd[1] = -1;
650 TAILQ_INIT(&base->active_later_queue);
652 evmap_io_initmap_(&base->io);
653 evmap_signal_initmap_(&base->sigmap);
654 event_changelist_init_(&base->changelist);
659 memcpy(&base->max_dispatch_time,
660 &cfg->max_dispatch_interval, sizeof(struct timeval));
661 base->limit_callbacks_after_prio =
662 cfg->limit_callbacks_after_prio;
664 base->max_dispatch_time.tv_sec = -1;
665 base->limit_callbacks_after_prio = 1;
667 if (cfg && cfg->max_dispatch_callbacks >= 0) {
668 base->max_dispatch_callbacks = cfg->max_dispatch_callbacks;
670 base->max_dispatch_callbacks = INT_MAX;
672 if (base->max_dispatch_callbacks == INT_MAX &&
673 base->max_dispatch_time.tv_sec == -1)
674 base->limit_callbacks_after_prio = INT_MAX;
676 for (i = 0; eventops[i] && !base->evbase; i++) {
678 /* determine if this backend should be avoided */
679 if (event_config_is_avoided_method(cfg,
682 if ((eventops[i]->features & cfg->require_features)
683 != cfg->require_features)
687 /* also obey the environment variables */
688 if (should_check_environment &&
689 event_is_method_disabled(eventops[i]->name))
692 base->evsel = eventops[i];
694 base->evbase = base->evsel->init(base);
697 if (base->evbase == NULL) {
698 event_warnx("%s: no event mechanism available",
701 event_base_free(base);
705 if (evutil_getenv_("EVENT_SHOW_METHOD"))
706 event_msgx("libevent using: %s", base->evsel->name);
708 /* allocate a single active event queue */
709 if (event_base_priority_init(base, 1) < 0) {
710 event_base_free(base);
714 /* prepare for threading */
716 #if !defined(EVENT__DISABLE_THREAD_SUPPORT) && !defined(EVENT__DISABLE_DEBUG_MODE)
717 event_debug_created_threadable_ctx_ = 1;
720 #ifndef EVENT__DISABLE_THREAD_SUPPORT
721 if (EVTHREAD_LOCKING_ENABLED() &&
722 (!cfg || !(cfg->flags & EVENT_BASE_FLAG_NOLOCK))) {
724 EVTHREAD_ALLOC_LOCK(base->th_base_lock, 0);
725 EVTHREAD_ALLOC_COND(base->current_event_cond);
726 r = evthread_make_base_notifiable(base);
728 event_warnx("%s: Unable to make base notifiable.", __func__);
729 event_base_free(base);
736 if (cfg && (cfg->flags & EVENT_BASE_FLAG_STARTUP_IOCP))
737 event_base_start_iocp_(base, cfg->n_cpus_hint);
744 event_base_start_iocp_(struct event_base *base, int n_cpus)
749 base->iocp = event_iocp_port_launch_(n_cpus);
751 event_warnx("%s: Couldn't launch IOCP", __func__);
761 event_base_stop_iocp_(struct event_base *base)
768 rv = event_iocp_shutdown_(base->iocp, -1);
769 EVUTIL_ASSERT(rv >= 0);
775 event_base_cancel_single_callback_(struct event_base *base,
776 struct event_callback *evcb,
781 if (evcb->evcb_flags & EVLIST_INIT) {
782 struct event *ev = event_callback_to_event(evcb);
783 if (!(ev->ev_flags & EVLIST_INTERNAL)) {
784 event_del_(ev, EVENT_DEL_EVEN_IF_FINALIZING);
788 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
789 event_callback_cancel_nolock_(base, evcb, 1);
790 EVBASE_RELEASE_LOCK(base, th_base_lock);
794 if (run_finalizers && (evcb->evcb_flags & EVLIST_FINALIZING)) {
795 switch (evcb->evcb_closure) {
796 case EV_CLOSURE_EVENT_FINALIZE:
797 case EV_CLOSURE_EVENT_FINALIZE_FREE: {
798 struct event *ev = event_callback_to_event(evcb);
799 ev->ev_evcallback.evcb_cb_union.evcb_evfinalize(ev, ev->ev_arg);
800 if (evcb->evcb_closure == EV_CLOSURE_EVENT_FINALIZE_FREE)
804 case EV_CLOSURE_CB_FINALIZE:
805 evcb->evcb_cb_union.evcb_cbfinalize(evcb, evcb->evcb_arg);
814 static int event_base_free_queues_(struct event_base *base, int run_finalizers)
818 for (i = 0; i < base->nactivequeues; ++i) {
819 struct event_callback *evcb, *next;
820 for (evcb = TAILQ_FIRST(&base->activequeues[i]); evcb; ) {
821 next = TAILQ_NEXT(evcb, evcb_active_next);
822 deleted += event_base_cancel_single_callback_(base, evcb, run_finalizers);
828 struct event_callback *evcb;
829 while ((evcb = TAILQ_FIRST(&base->active_later_queue))) {
830 deleted += event_base_cancel_single_callback_(base, evcb, run_finalizers);
838 event_base_free_(struct event_base *base, int run_finalizers)
842 /* XXXX grab the lock? If there is contention when one thread frees
843 * the base, then the contending thread will be very sad soon. */
845 /* event_base_free(NULL) is how to free the current_base if we
846 * made it with event_init and forgot to hold a reference to it. */
847 if (base == NULL && current_base)
849 /* Don't actually free NULL. */
851 event_warnx("%s: no base to free", __func__);
854 /* XXX(niels) - check for internal events first */
857 event_base_stop_iocp_(base);
860 /* threading fds if we have them */
861 if (base->th_notify_fd[0] != -1) {
862 event_del(&base->th_notify);
863 EVUTIL_CLOSESOCKET(base->th_notify_fd[0]);
864 if (base->th_notify_fd[1] != -1)
865 EVUTIL_CLOSESOCKET(base->th_notify_fd[1]);
866 base->th_notify_fd[0] = -1;
867 base->th_notify_fd[1] = -1;
868 event_debug_unassign(&base->th_notify);
871 /* Delete all non-internal events. */
872 evmap_delete_all_(base);
874 while ((ev = min_heap_top_(&base->timeheap)) != NULL) {
878 for (i = 0; i < base->n_common_timeouts; ++i) {
879 struct common_timeout_list *ctl =
880 base->common_timeout_queues[i];
881 event_del(&ctl->timeout_event); /* Internal; doesn't count */
882 event_debug_unassign(&ctl->timeout_event);
883 for (ev = TAILQ_FIRST(&ctl->events); ev; ) {
884 struct event *next = TAILQ_NEXT(ev,
885 ev_timeout_pos.ev_next_with_common_timeout);
886 if (!(ev->ev_flags & EVLIST_INTERNAL)) {
894 if (base->common_timeout_queues)
895 mm_free(base->common_timeout_queues);
898 /* For finalizers we can register yet another finalizer out from
899 * finalizer, and iff finalizer will be in active_later_queue we can
900 * add finalizer to activequeues, and we will have events in
901 * activequeues after this function returns, which is not what we want
902 * (we even have an assertion for this).
904 * A simple case is bufferevent with underlying (i.e. filters).
906 int i = event_base_free_queues_(base, run_finalizers);
907 event_debug(("%s: %d events freed", __func__, i));
915 event_debug(("%s: %d events were still set in base",
916 __func__, n_deleted));
918 while (LIST_FIRST(&base->once_events)) {
919 struct event_once *eonce = LIST_FIRST(&base->once_events);
920 LIST_REMOVE(eonce, next_once);
924 if (base->evsel != NULL && base->evsel->dealloc != NULL)
925 base->evsel->dealloc(base);
927 for (i = 0; i < base->nactivequeues; ++i)
928 EVUTIL_ASSERT(TAILQ_EMPTY(&base->activequeues[i]));
930 EVUTIL_ASSERT(min_heap_empty_(&base->timeheap));
931 min_heap_dtor_(&base->timeheap);
933 mm_free(base->activequeues);
935 evmap_io_clear_(&base->io);
936 evmap_signal_clear_(&base->sigmap);
937 event_changelist_freemem_(&base->changelist);
939 EVTHREAD_FREE_LOCK(base->th_base_lock, 0);
940 EVTHREAD_FREE_COND(base->current_event_cond);
942 /* If we're freeing current_base, there won't be a current_base. */
943 if (base == current_base)
949 event_base_free_nofinalize(struct event_base *base)
951 event_base_free_(base, 0);
955 event_base_free(struct event_base *base)
957 event_base_free_(base, 1);
960 /* Fake eventop; used to disable the backend temporarily inside event_reinit
961 * so that we can call event_del() on an event without telling the backend.
964 nil_backend_del(struct event_base *b, evutil_socket_t fd, short old,
965 short events, void *fdinfo)
969 const struct eventop nil_eventop = {
971 NULL, /* init: unused. */
972 NULL, /* add: unused. */
973 nil_backend_del, /* del: used, so needs to be killed. */
974 NULL, /* dispatch: unused. */
975 NULL, /* dealloc: unused. */
979 /* reinitialize the event base after a fork */
981 event_reinit(struct event_base *base)
983 const struct eventop *evsel;
985 int was_notifiable = 0;
986 int had_signal_added = 0;
988 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
992 /* check if this event mechanism requires reinit on the backend */
993 if (evsel->need_reinit) {
994 /* We're going to call event_del() on our notify events (the
995 * ones that tell about signals and wakeup events). But we
996 * don't actually want to tell the backend to change its
997 * state, since it might still share some resource (a kqueue,
998 * an epoll fd) with the parent process, and we don't want to
999 * delete the fds from _that_ backend, we temporarily stub out
1000 * the evsel with a replacement.
1002 base->evsel = &nil_eventop;
1005 /* We need to re-create a new signal-notification fd and a new
1006 * thread-notification fd. Otherwise, we'll still share those with
1007 * the parent process, which would make any notification sent to them
1008 * get received by one or both of the event loops, more or less at
1011 if (base->sig.ev_signal_added) {
1012 event_del_nolock_(&base->sig.ev_signal, EVENT_DEL_AUTOBLOCK);
1013 event_debug_unassign(&base->sig.ev_signal);
1014 memset(&base->sig.ev_signal, 0, sizeof(base->sig.ev_signal));
1015 had_signal_added = 1;
1016 base->sig.ev_signal_added = 0;
1018 if (base->sig.ev_signal_pair[0] != -1)
1019 EVUTIL_CLOSESOCKET(base->sig.ev_signal_pair[0]);
1020 if (base->sig.ev_signal_pair[1] != -1)
1021 EVUTIL_CLOSESOCKET(base->sig.ev_signal_pair[1]);
1022 if (base->th_notify_fn != NULL) {
1024 base->th_notify_fn = NULL;
1026 if (base->th_notify_fd[0] != -1) {
1027 event_del_nolock_(&base->th_notify, EVENT_DEL_AUTOBLOCK);
1028 EVUTIL_CLOSESOCKET(base->th_notify_fd[0]);
1029 if (base->th_notify_fd[1] != -1)
1030 EVUTIL_CLOSESOCKET(base->th_notify_fd[1]);
1031 base->th_notify_fd[0] = -1;
1032 base->th_notify_fd[1] = -1;
1033 event_debug_unassign(&base->th_notify);
1036 /* Replace the original evsel. */
1037 base->evsel = evsel;
1039 if (evsel->need_reinit) {
1040 /* Reconstruct the backend through brute-force, so that we do
1041 * not share any structures with the parent process. For some
1042 * backends, this is necessary: epoll and kqueue, for
1043 * instance, have events associated with a kernel
1044 * structure. If didn't reinitialize, we'd share that
1045 * structure with the parent process, and any changes made by
1046 * the parent would affect our backend's behavior (and vice
1049 if (base->evsel->dealloc != NULL)
1050 base->evsel->dealloc(base);
1051 base->evbase = evsel->init(base);
1052 if (base->evbase == NULL) {
1054 "%s: could not reinitialize event mechanism",
1060 /* Empty out the changelist (if any): we are starting from a
1062 event_changelist_freemem_(&base->changelist);
1064 /* Tell the event maps to re-inform the backend about all
1065 * pending events. This will make the signal notification
1066 * event get re-created if necessary. */
1067 if (evmap_reinit_(base) < 0)
1070 res = evsig_init_(base);
1071 if (res == 0 && had_signal_added) {
1072 res = event_add_nolock_(&base->sig.ev_signal, NULL, 0);
1074 base->sig.ev_signal_added = 1;
1078 /* If we were notifiable before, and nothing just exploded, become
1079 * notifiable again. */
1080 if (was_notifiable && res == 0)
1081 res = evthread_make_base_notifiable_nolock_(base);
1084 EVBASE_RELEASE_LOCK(base, th_base_lock);
1088 /* Get the monotonic time for this event_base' timer */
1090 event_gettime_monotonic(struct event_base *base, struct timeval *tv)
1095 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1096 rv = evutil_gettime_monotonic_(&(base->monotonic_timer), tv);
1097 EVBASE_RELEASE_LOCK(base, th_base_lock);
1104 event_get_supported_methods(void)
1106 static const char **methods = NULL;
1107 const struct eventop **method;
1111 /* count all methods */
1112 for (method = &eventops[0]; *method != NULL; ++method) {
1116 /* allocate one more than we need for the NULL pointer */
1117 tmp = mm_calloc((i + 1), sizeof(char *));
1121 /* populate the array with the supported methods */
1122 for (k = 0, i = 0; eventops[k] != NULL; ++k) {
1123 tmp[i++] = eventops[k]->name;
1127 if (methods != NULL)
1128 mm_free((char**)methods);
1135 struct event_config *
1136 event_config_new(void)
1138 struct event_config *cfg = mm_calloc(1, sizeof(*cfg));
1143 TAILQ_INIT(&cfg->entries);
1144 cfg->max_dispatch_interval.tv_sec = -1;
1145 cfg->max_dispatch_callbacks = INT_MAX;
1146 cfg->limit_callbacks_after_prio = 1;
1152 event_config_entry_free(struct event_config_entry *entry)
1154 if (entry->avoid_method != NULL)
1155 mm_free((char *)entry->avoid_method);
1160 event_config_free(struct event_config *cfg)
1162 struct event_config_entry *entry;
1164 while ((entry = TAILQ_FIRST(&cfg->entries)) != NULL) {
1165 TAILQ_REMOVE(&cfg->entries, entry, next);
1166 event_config_entry_free(entry);
1172 event_config_set_flag(struct event_config *cfg, int flag)
1181 event_config_avoid_method(struct event_config *cfg, const char *method)
1183 struct event_config_entry *entry = mm_malloc(sizeof(*entry));
1187 if ((entry->avoid_method = mm_strdup(method)) == NULL) {
1192 TAILQ_INSERT_TAIL(&cfg->entries, entry, next);
1198 event_config_require_features(struct event_config *cfg,
1203 cfg->require_features = features;
1208 event_config_set_num_cpus_hint(struct event_config *cfg, int cpus)
1212 cfg->n_cpus_hint = cpus;
1217 event_config_set_max_dispatch_interval(struct event_config *cfg,
1218 const struct timeval *max_interval, int max_callbacks, int min_priority)
1221 memcpy(&cfg->max_dispatch_interval, max_interval,
1222 sizeof(struct timeval));
1224 cfg->max_dispatch_interval.tv_sec = -1;
1225 cfg->max_dispatch_callbacks =
1226 max_callbacks >= 0 ? max_callbacks : INT_MAX;
1227 if (min_priority < 0)
1229 cfg->limit_callbacks_after_prio = min_priority;
1234 event_priority_init(int npriorities)
1236 return event_base_priority_init(current_base, npriorities);
1240 event_base_priority_init(struct event_base *base, int npriorities)
1245 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1247 if (N_ACTIVE_CALLBACKS(base) || npriorities < 1
1248 || npriorities >= EVENT_MAX_PRIORITIES)
1251 if (npriorities == base->nactivequeues)
1254 if (base->nactivequeues) {
1255 mm_free(base->activequeues);
1256 base->nactivequeues = 0;
1259 /* Allocate our priority queues */
1260 base->activequeues = (struct evcallback_list *)
1261 mm_calloc(npriorities, sizeof(struct evcallback_list));
1262 if (base->activequeues == NULL) {
1263 event_warn("%s: calloc", __func__);
1266 base->nactivequeues = npriorities;
1268 for (i = 0; i < base->nactivequeues; ++i) {
1269 TAILQ_INIT(&base->activequeues[i]);
1275 EVBASE_RELEASE_LOCK(base, th_base_lock);
1280 event_base_get_npriorities(struct event_base *base)
1285 base = current_base;
1287 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1288 n = base->nactivequeues;
1289 EVBASE_RELEASE_LOCK(base, th_base_lock);
1294 event_base_get_num_events(struct event_base *base, unsigned int type)
1298 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1300 if (type & EVENT_BASE_COUNT_ACTIVE)
1301 r += base->event_count_active;
1303 if (type & EVENT_BASE_COUNT_VIRTUAL)
1304 r += base->virtual_event_count;
1306 if (type & EVENT_BASE_COUNT_ADDED)
1307 r += base->event_count;
1309 EVBASE_RELEASE_LOCK(base, th_base_lock);
1315 event_base_get_max_events(struct event_base *base, unsigned int type, int clear)
1319 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1321 if (type & EVENT_BASE_COUNT_ACTIVE) {
1322 r += base->event_count_active_max;
1324 base->event_count_active_max = 0;
1327 if (type & EVENT_BASE_COUNT_VIRTUAL) {
1328 r += base->virtual_event_count_max;
1330 base->virtual_event_count_max = 0;
1333 if (type & EVENT_BASE_COUNT_ADDED) {
1334 r += base->event_count_max;
1336 base->event_count_max = 0;
1339 EVBASE_RELEASE_LOCK(base, th_base_lock);
1344 /* Returns true iff we're currently watching any events. */
1346 event_haveevents(struct event_base *base)
1348 /* Caller must hold th_base_lock */
1349 return (base->virtual_event_count > 0 || base->event_count > 0);
1352 /* "closure" function called when processing active signal events */
1354 event_signal_closure(struct event_base *base, struct event *ev)
1359 /* Allows deletes to work */
1360 ncalls = ev->ev_ncalls;
1362 ev->ev_pncalls = &ncalls;
1363 EVBASE_RELEASE_LOCK(base, th_base_lock);
1366 ev->ev_ncalls = ncalls;
1368 ev->ev_pncalls = NULL;
1369 (*ev->ev_callback)(ev->ev_fd, ev->ev_res, ev->ev_arg);
1371 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1372 should_break = base->event_break;
1373 EVBASE_RELEASE_LOCK(base, th_base_lock);
1377 ev->ev_pncalls = NULL;
1383 /* Common timeouts are special timeouts that are handled as queues rather than
1384 * in the minheap. This is more efficient than the minheap if we happen to
1385 * know that we're going to get several thousands of timeout events all with
1386 * the same timeout value.
1388 * Since all our timeout handling code assumes timevals can be copied,
1389 * assigned, etc, we can't use "magic pointer" to encode these common
1390 * timeouts. Searching through a list to see if every timeout is common could
1391 * also get inefficient. Instead, we take advantage of the fact that tv_usec
1392 * is 32 bits long, but only uses 20 of those bits (since it can never be over
1393 * 999999.) We use the top bits to encode 4 bites of magic number, and 8 bits
1394 * of index into the event_base's aray of common timeouts.
1397 #define MICROSECONDS_MASK COMMON_TIMEOUT_MICROSECONDS_MASK
1398 #define COMMON_TIMEOUT_IDX_MASK 0x0ff00000
1399 #define COMMON_TIMEOUT_IDX_SHIFT 20
1400 #define COMMON_TIMEOUT_MASK 0xf0000000
1401 #define COMMON_TIMEOUT_MAGIC 0x50000000
1403 #define COMMON_TIMEOUT_IDX(tv) \
1404 (((tv)->tv_usec & COMMON_TIMEOUT_IDX_MASK)>>COMMON_TIMEOUT_IDX_SHIFT)
1406 /** Return true iff if 'tv' is a common timeout in 'base' */
1408 is_common_timeout(const struct timeval *tv,
1409 const struct event_base *base)
1412 if ((tv->tv_usec & COMMON_TIMEOUT_MASK) != COMMON_TIMEOUT_MAGIC)
1414 idx = COMMON_TIMEOUT_IDX(tv);
1415 return idx < base->n_common_timeouts;
1418 /* True iff tv1 and tv2 have the same common-timeout index, or if neither
1419 * one is a common timeout. */
1421 is_same_common_timeout(const struct timeval *tv1, const struct timeval *tv2)
1423 return (tv1->tv_usec & ~MICROSECONDS_MASK) ==
1424 (tv2->tv_usec & ~MICROSECONDS_MASK);
1427 /** Requires that 'tv' is a common timeout. Return the corresponding
1428 * common_timeout_list. */
1429 static inline struct common_timeout_list *
1430 get_common_timeout_list(struct event_base *base, const struct timeval *tv)
1432 return base->common_timeout_queues[COMMON_TIMEOUT_IDX(tv)];
1437 common_timeout_ok(const struct timeval *tv,
1438 struct event_base *base)
1440 const struct timeval *expect =
1441 &get_common_timeout_list(base, tv)->duration;
1442 return tv->tv_sec == expect->tv_sec &&
1443 tv->tv_usec == expect->tv_usec;
1447 /* Add the timeout for the first event in given common timeout list to the
1448 * event_base's minheap. */
1450 common_timeout_schedule(struct common_timeout_list *ctl,
1451 const struct timeval *now, struct event *head)
1453 struct timeval timeout = head->ev_timeout;
1454 timeout.tv_usec &= MICROSECONDS_MASK;
1455 event_add_nolock_(&ctl->timeout_event, &timeout, 1);
1458 /* Callback: invoked when the timeout for a common timeout queue triggers.
1459 * This means that (at least) the first event in that queue should be run,
1460 * and the timeout should be rescheduled if there are more events. */
1462 common_timeout_callback(evutil_socket_t fd, short what, void *arg)
1465 struct common_timeout_list *ctl = arg;
1466 struct event_base *base = ctl->base;
1467 struct event *ev = NULL;
1468 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1469 gettime(base, &now);
1471 ev = TAILQ_FIRST(&ctl->events);
1472 if (!ev || ev->ev_timeout.tv_sec > now.tv_sec ||
1473 (ev->ev_timeout.tv_sec == now.tv_sec &&
1474 (ev->ev_timeout.tv_usec&MICROSECONDS_MASK) > now.tv_usec))
1476 event_del_nolock_(ev, EVENT_DEL_NOBLOCK);
1477 event_active_nolock_(ev, EV_TIMEOUT, 1);
1480 common_timeout_schedule(ctl, &now, ev);
1481 EVBASE_RELEASE_LOCK(base, th_base_lock);
1484 #define MAX_COMMON_TIMEOUTS 256
1486 const struct timeval *
1487 event_base_init_common_timeout(struct event_base *base,
1488 const struct timeval *duration)
1492 const struct timeval *result=NULL;
1493 struct common_timeout_list *new_ctl;
1495 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1496 if (duration->tv_usec > 1000000) {
1497 memcpy(&tv, duration, sizeof(struct timeval));
1498 if (is_common_timeout(duration, base))
1499 tv.tv_usec &= MICROSECONDS_MASK;
1500 tv.tv_sec += tv.tv_usec / 1000000;
1501 tv.tv_usec %= 1000000;
1504 for (i = 0; i < base->n_common_timeouts; ++i) {
1505 const struct common_timeout_list *ctl =
1506 base->common_timeout_queues[i];
1507 if (duration->tv_sec == ctl->duration.tv_sec &&
1508 duration->tv_usec ==
1509 (ctl->duration.tv_usec & MICROSECONDS_MASK)) {
1510 EVUTIL_ASSERT(is_common_timeout(&ctl->duration, base));
1511 result = &ctl->duration;
1515 if (base->n_common_timeouts == MAX_COMMON_TIMEOUTS) {
1516 event_warnx("%s: Too many common timeouts already in use; "
1517 "we only support %d per event_base", __func__,
1518 MAX_COMMON_TIMEOUTS);
1521 if (base->n_common_timeouts_allocated == base->n_common_timeouts) {
1522 int n = base->n_common_timeouts < 16 ? 16 :
1523 base->n_common_timeouts*2;
1524 struct common_timeout_list **newqueues =
1525 mm_realloc(base->common_timeout_queues,
1526 n*sizeof(struct common_timeout_queue *));
1528 event_warn("%s: realloc",__func__);
1531 base->n_common_timeouts_allocated = n;
1532 base->common_timeout_queues = newqueues;
1534 new_ctl = mm_calloc(1, sizeof(struct common_timeout_list));
1536 event_warn("%s: calloc",__func__);
1539 TAILQ_INIT(&new_ctl->events);
1540 new_ctl->duration.tv_sec = duration->tv_sec;
1541 new_ctl->duration.tv_usec =
1542 duration->tv_usec | COMMON_TIMEOUT_MAGIC |
1543 (base->n_common_timeouts << COMMON_TIMEOUT_IDX_SHIFT);
1544 evtimer_assign(&new_ctl->timeout_event, base,
1545 common_timeout_callback, new_ctl);
1546 new_ctl->timeout_event.ev_flags |= EVLIST_INTERNAL;
1547 event_priority_set(&new_ctl->timeout_event, 0);
1548 new_ctl->base = base;
1549 base->common_timeout_queues[base->n_common_timeouts++] = new_ctl;
1550 result = &new_ctl->duration;
1554 EVUTIL_ASSERT(is_common_timeout(result, base));
1556 EVBASE_RELEASE_LOCK(base, th_base_lock);
1560 /* Closure function invoked when we're activating a persistent event. */
1562 event_persist_closure(struct event_base *base, struct event *ev)
1564 void (*evcb_callback)(evutil_socket_t, short, void *);
1566 // Other fields of *ev that must be stored before executing
1567 evutil_socket_t evcb_fd;
1571 /* reschedule the persistent event if we have a timeout. */
1572 if (ev->ev_io_timeout.tv_sec || ev->ev_io_timeout.tv_usec) {
1573 /* If there was a timeout, we want it to run at an interval of
1574 * ev_io_timeout after the last time it was _scheduled_ for,
1575 * not ev_io_timeout after _now_. If it fired for another
1576 * reason, though, the timeout ought to start ticking _now_. */
1577 struct timeval run_at, relative_to, delay, now;
1578 ev_uint32_t usec_mask = 0;
1579 EVUTIL_ASSERT(is_same_common_timeout(&ev->ev_timeout,
1580 &ev->ev_io_timeout));
1581 gettime(base, &now);
1582 if (is_common_timeout(&ev->ev_timeout, base)) {
1583 delay = ev->ev_io_timeout;
1584 usec_mask = delay.tv_usec & ~MICROSECONDS_MASK;
1585 delay.tv_usec &= MICROSECONDS_MASK;
1586 if (ev->ev_res & EV_TIMEOUT) {
1587 relative_to = ev->ev_timeout;
1588 relative_to.tv_usec &= MICROSECONDS_MASK;
1593 delay = ev->ev_io_timeout;
1594 if (ev->ev_res & EV_TIMEOUT) {
1595 relative_to = ev->ev_timeout;
1600 evutil_timeradd(&relative_to, &delay, &run_at);
1601 if (evutil_timercmp(&run_at, &now, <)) {
1602 /* Looks like we missed at least one invocation due to
1603 * a clock jump, not running the event loop for a
1604 * while, really slow callbacks, or
1605 * something. Reschedule relative to now.
1607 evutil_timeradd(&now, &delay, &run_at);
1609 run_at.tv_usec |= usec_mask;
1610 event_add_nolock_(ev, &run_at, 1);
1613 // Save our callback before we release the lock
1614 evcb_callback = ev->ev_callback;
1615 evcb_fd = ev->ev_fd;
1616 evcb_res = ev->ev_res;
1617 evcb_arg = ev->ev_arg;
1620 EVBASE_RELEASE_LOCK(base, th_base_lock);
1622 // Execute the callback
1623 (evcb_callback)(evcb_fd, evcb_res, evcb_arg);
1627 Helper for event_process_active to process all the events in a single queue,
1628 releasing the lock as we go. This function requires that the lock be held
1629 when it's invoked. Returns -1 if we get a signal or an event_break that
1630 means we should stop processing any active events now. Otherwise returns
1631 the number of non-internal event_callbacks that we processed.
1634 event_process_active_single_queue(struct event_base *base,
1635 struct evcallback_list *activeq,
1636 int max_to_process, const struct timeval *endtime)
1638 struct event_callback *evcb;
1641 EVUTIL_ASSERT(activeq != NULL);
1643 for (evcb = TAILQ_FIRST(activeq); evcb; evcb = TAILQ_FIRST(activeq)) {
1644 struct event *ev=NULL;
1645 if (evcb->evcb_flags & EVLIST_INIT) {
1646 ev = event_callback_to_event(evcb);
1648 if (ev->ev_events & EV_PERSIST || ev->ev_flags & EVLIST_FINALIZING)
1649 event_queue_remove_active(base, evcb);
1651 event_del_nolock_(ev, EVENT_DEL_NOBLOCK);
1653 "event_process_active: event: %p, %s%s%scall %p",
1655 ev->ev_res & EV_READ ? "EV_READ " : " ",
1656 ev->ev_res & EV_WRITE ? "EV_WRITE " : " ",
1657 ev->ev_res & EV_CLOSED ? "EV_CLOSED " : " ",
1660 event_queue_remove_active(base, evcb);
1661 event_debug(("event_process_active: event_callback %p, "
1662 "closure %d, call %p",
1663 evcb, evcb->evcb_closure, evcb->evcb_cb_union.evcb_callback));
1666 if (!(evcb->evcb_flags & EVLIST_INTERNAL))
1670 base->current_event = evcb;
1671 #ifndef EVENT__DISABLE_THREAD_SUPPORT
1672 base->current_event_waiters = 0;
1675 switch (evcb->evcb_closure) {
1676 case EV_CLOSURE_EVENT_SIGNAL:
1677 EVUTIL_ASSERT(ev != NULL);
1678 event_signal_closure(base, ev);
1680 case EV_CLOSURE_EVENT_PERSIST:
1681 EVUTIL_ASSERT(ev != NULL);
1682 event_persist_closure(base, ev);
1684 case EV_CLOSURE_EVENT: {
1685 void (*evcb_callback)(evutil_socket_t, short, void *);
1687 EVUTIL_ASSERT(ev != NULL);
1688 evcb_callback = *ev->ev_callback;
1690 EVBASE_RELEASE_LOCK(base, th_base_lock);
1691 evcb_callback(ev->ev_fd, res, ev->ev_arg);
1694 case EV_CLOSURE_CB_SELF: {
1695 void (*evcb_selfcb)(struct event_callback *, void *) = evcb->evcb_cb_union.evcb_selfcb;
1696 EVBASE_RELEASE_LOCK(base, th_base_lock);
1697 evcb_selfcb(evcb, evcb->evcb_arg);
1700 case EV_CLOSURE_EVENT_FINALIZE:
1701 case EV_CLOSURE_EVENT_FINALIZE_FREE: {
1702 void (*evcb_evfinalize)(struct event *, void *);
1703 int evcb_closure = evcb->evcb_closure;
1704 EVUTIL_ASSERT(ev != NULL);
1705 base->current_event = NULL;
1706 evcb_evfinalize = ev->ev_evcallback.evcb_cb_union.evcb_evfinalize;
1707 EVUTIL_ASSERT((evcb->evcb_flags & EVLIST_FINALIZING));
1708 EVBASE_RELEASE_LOCK(base, th_base_lock);
1709 event_debug_note_teardown_(ev);
1710 evcb_evfinalize(ev, ev->ev_arg);
1711 if (evcb_closure == EV_CLOSURE_EVENT_FINALIZE_FREE)
1715 case EV_CLOSURE_CB_FINALIZE: {
1716 void (*evcb_cbfinalize)(struct event_callback *, void *) = evcb->evcb_cb_union.evcb_cbfinalize;
1717 base->current_event = NULL;
1718 EVUTIL_ASSERT((evcb->evcb_flags & EVLIST_FINALIZING));
1719 EVBASE_RELEASE_LOCK(base, th_base_lock);
1720 evcb_cbfinalize(evcb, evcb->evcb_arg);
1727 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1728 base->current_event = NULL;
1729 #ifndef EVENT__DISABLE_THREAD_SUPPORT
1730 if (base->current_event_waiters) {
1731 base->current_event_waiters = 0;
1732 EVTHREAD_COND_BROADCAST(base->current_event_cond);
1736 if (base->event_break)
1738 if (count >= max_to_process)
1740 if (count && endtime) {
1742 update_time_cache(base);
1743 gettime(base, &now);
1744 if (evutil_timercmp(&now, endtime, >=))
1747 if (base->event_continue)
1754 * Active events are stored in priority queues. Lower priorities are always
1755 * process before higher priorities. Low priority events can starve high
1760 event_process_active(struct event_base *base)
1762 /* Caller must hold th_base_lock */
1763 struct evcallback_list *activeq = NULL;
1765 const struct timeval *endtime;
1767 const int maxcb = base->max_dispatch_callbacks;
1768 const int limit_after_prio = base->limit_callbacks_after_prio;
1769 if (base->max_dispatch_time.tv_sec >= 0) {
1770 update_time_cache(base);
1772 evutil_timeradd(&base->max_dispatch_time, &tv, &tv);
1778 for (i = 0; i < base->nactivequeues; ++i) {
1779 if (TAILQ_FIRST(&base->activequeues[i]) != NULL) {
1780 base->event_running_priority = i;
1781 activeq = &base->activequeues[i];
1782 if (i < limit_after_prio)
1783 c = event_process_active_single_queue(base, activeq,
1786 c = event_process_active_single_queue(base, activeq,
1791 break; /* Processed a real event; do not
1792 * consider lower-priority events */
1793 /* If we get here, all of the events we processed
1794 * were internal. Continue. */
1799 base->event_running_priority = -1;
1805 * Wait continuously for events. We exit only if no events are left.
1809 event_dispatch(void)
1811 return (event_loop(0));
1815 event_base_dispatch(struct event_base *event_base)
1817 return (event_base_loop(event_base, 0));
1821 event_base_get_method(const struct event_base *base)
1823 EVUTIL_ASSERT(base);
1824 return (base->evsel->name);
1827 /** Callback: used to implement event_base_loopexit by telling the event_base
1828 * that it's time to exit its loop. */
1830 event_loopexit_cb(evutil_socket_t fd, short what, void *arg)
1832 struct event_base *base = arg;
1833 base->event_gotterm = 1;
1837 event_loopexit(const struct timeval *tv)
1839 return (event_once(-1, EV_TIMEOUT, event_loopexit_cb,
1844 event_base_loopexit(struct event_base *event_base, const struct timeval *tv)
1846 return (event_base_once(event_base, -1, EV_TIMEOUT, event_loopexit_cb,
1851 event_loopbreak(void)
1853 return (event_base_loopbreak(current_base));
1857 event_base_loopbreak(struct event_base *event_base)
1860 if (event_base == NULL)
1863 EVBASE_ACQUIRE_LOCK(event_base, th_base_lock);
1864 event_base->event_break = 1;
1866 if (EVBASE_NEED_NOTIFY(event_base)) {
1867 r = evthread_notify_base(event_base);
1871 EVBASE_RELEASE_LOCK(event_base, th_base_lock);
1876 event_base_loopcontinue(struct event_base *event_base)
1879 if (event_base == NULL)
1882 EVBASE_ACQUIRE_LOCK(event_base, th_base_lock);
1883 event_base->event_continue = 1;
1885 if (EVBASE_NEED_NOTIFY(event_base)) {
1886 r = evthread_notify_base(event_base);
1890 EVBASE_RELEASE_LOCK(event_base, th_base_lock);
1895 event_base_got_break(struct event_base *event_base)
1898 EVBASE_ACQUIRE_LOCK(event_base, th_base_lock);
1899 res = event_base->event_break;
1900 EVBASE_RELEASE_LOCK(event_base, th_base_lock);
1905 event_base_got_exit(struct event_base *event_base)
1908 EVBASE_ACQUIRE_LOCK(event_base, th_base_lock);
1909 res = event_base->event_gotterm;
1910 EVBASE_RELEASE_LOCK(event_base, th_base_lock);
1914 /* not thread safe */
1917 event_loop(int flags)
1919 return event_base_loop(current_base, flags);
1923 event_base_loop(struct event_base *base, int flags)
1925 const struct eventop *evsel = base->evsel;
1927 struct timeval *tv_p;
1928 int res, done, retval = 0;
1930 /* Grab the lock. We will release it inside evsel.dispatch, and again
1931 * as we invoke user callbacks. */
1932 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
1934 if (base->running_loop) {
1935 event_warnx("%s: reentrant invocation. Only one event_base_loop"
1936 " can run on each event_base at once.", __func__);
1937 EVBASE_RELEASE_LOCK(base, th_base_lock);
1941 base->running_loop = 1;
1943 clear_time_cache(base);
1945 if (base->sig.ev_signal_added && base->sig.ev_n_signals_added)
1946 evsig_set_base_(base);
1950 #ifndef EVENT__DISABLE_THREAD_SUPPORT
1951 base->th_owner_id = EVTHREAD_GET_ID();
1954 base->event_gotterm = base->event_break = 0;
1957 base->event_continue = 0;
1958 base->n_deferreds_queued = 0;
1960 /* Terminate the loop if we have been asked to */
1961 if (base->event_gotterm) {
1965 if (base->event_break) {
1970 if (!N_ACTIVE_CALLBACKS(base) && !(flags & EVLOOP_NONBLOCK)) {
1971 timeout_next(base, &tv_p);
1974 * if we have active events, we just poll new events
1977 evutil_timerclear(&tv);
1980 /* If we have no events, we just exit */
1981 if (0==(flags&EVLOOP_NO_EXIT_ON_EMPTY) &&
1982 !event_haveevents(base) && !N_ACTIVE_CALLBACKS(base)) {
1983 event_debug(("%s: no events registered.", __func__));
1988 event_queue_make_later_events_active(base);
1990 clear_time_cache(base);
1992 res = evsel->dispatch(base, tv_p);
1995 event_debug(("%s: dispatch returned unsuccessfully.",
2001 update_time_cache(base);
2003 timeout_process(base);
2005 if (N_ACTIVE_CALLBACKS(base)) {
2006 int n = event_process_active(base);
2007 if ((flags & EVLOOP_ONCE)
2008 && N_ACTIVE_CALLBACKS(base) == 0
2011 } else if (flags & EVLOOP_NONBLOCK)
2014 event_debug(("%s: asked to terminate loop.", __func__));
2017 clear_time_cache(base);
2018 base->running_loop = 0;
2020 EVBASE_RELEASE_LOCK(base, th_base_lock);
2025 /* One-time callback to implement event_base_once: invokes the user callback,
2026 * then deletes the allocated storage */
2028 event_once_cb(evutil_socket_t fd, short events, void *arg)
2030 struct event_once *eonce = arg;
2032 (*eonce->cb)(fd, events, eonce->arg);
2033 EVBASE_ACQUIRE_LOCK(eonce->ev.ev_base, th_base_lock);
2034 LIST_REMOVE(eonce, next_once);
2035 EVBASE_RELEASE_LOCK(eonce->ev.ev_base, th_base_lock);
2036 event_debug_unassign(&eonce->ev);
2040 /* not threadsafe, event scheduled once. */
2042 event_once(evutil_socket_t fd, short events,
2043 void (*callback)(evutil_socket_t, short, void *),
2044 void *arg, const struct timeval *tv)
2046 return event_base_once(current_base, fd, events, callback, arg, tv);
2049 /* Schedules an event once */
2051 event_base_once(struct event_base *base, evutil_socket_t fd, short events,
2052 void (*callback)(evutil_socket_t, short, void *),
2053 void *arg, const struct timeval *tv)
2055 struct event_once *eonce;
2062 /* We cannot support signals that just fire once, or persistent
2064 if (events & (EV_SIGNAL|EV_PERSIST))
2067 if ((eonce = mm_calloc(1, sizeof(struct event_once))) == NULL)
2070 eonce->cb = callback;
2073 if ((events & (EV_TIMEOUT|EV_SIGNAL|EV_READ|EV_WRITE|EV_CLOSED)) == EV_TIMEOUT) {
2074 evtimer_assign(&eonce->ev, base, event_once_cb, eonce);
2076 if (tv == NULL || ! evutil_timerisset(tv)) {
2077 /* If the event is going to become active immediately,
2078 * don't put it on the timeout queue. This is one
2079 * idiom for scheduling a callback, so let's make
2080 * it fast (and order-preserving). */
2083 } else if (events & (EV_READ|EV_WRITE|EV_CLOSED)) {
2084 events &= EV_READ|EV_WRITE|EV_CLOSED;
2086 event_assign(&eonce->ev, base, fd, events, event_once_cb, eonce);
2088 /* Bad event combination */
2094 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
2096 event_active_nolock_(&eonce->ev, EV_TIMEOUT, 1);
2098 res = event_add_nolock_(&eonce->ev, tv, 0);
2104 LIST_INSERT_HEAD(&base->once_events, eonce, next_once);
2106 EVBASE_RELEASE_LOCK(base, th_base_lock);
2113 event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd, short events, void (*callback)(evutil_socket_t, short, void *), void *arg)
2116 base = current_base;
2117 if (arg == &event_self_cbarg_ptr_)
2120 if (!(events & EV_SIGNAL))
2121 event_debug_assert_socket_nonblocking_(fd);
2122 event_debug_assert_not_added_(ev);
2126 ev->ev_callback = callback;
2129 ev->ev_events = events;
2131 ev->ev_flags = EVLIST_INIT;
2133 ev->ev_pncalls = NULL;
2135 if (events & EV_SIGNAL) {
2136 if ((events & (EV_READ|EV_WRITE|EV_CLOSED)) != 0) {
2137 event_warnx("%s: EV_SIGNAL is not compatible with "
2138 "EV_READ, EV_WRITE or EV_CLOSED", __func__);
2141 ev->ev_closure = EV_CLOSURE_EVENT_SIGNAL;
2143 if (events & EV_PERSIST) {
2144 evutil_timerclear(&ev->ev_io_timeout);
2145 ev->ev_closure = EV_CLOSURE_EVENT_PERSIST;
2147 ev->ev_closure = EV_CLOSURE_EVENT;
2151 min_heap_elem_init_(ev);
2154 /* by default, we put new events into the middle priority */
2155 ev->ev_pri = base->nactivequeues / 2;
2158 event_debug_note_setup_(ev);
2164 event_base_set(struct event_base *base, struct event *ev)
2166 /* Only innocent events may be assigned to a different base */
2167 if (ev->ev_flags != EVLIST_INIT)
2170 event_debug_assert_is_setup_(ev);
2173 ev->ev_pri = base->nactivequeues/2;
2179 event_set(struct event *ev, evutil_socket_t fd, short events,
2180 void (*callback)(evutil_socket_t, short, void *), void *arg)
2183 r = event_assign(ev, current_base, fd, events, callback, arg);
2184 EVUTIL_ASSERT(r == 0);
2188 event_self_cbarg(void)
2190 return &event_self_cbarg_ptr_;
2194 event_base_get_running_event(struct event_base *base)
2196 struct event *ev = NULL;
2197 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
2198 if (EVBASE_IN_THREAD(base)) {
2199 struct event_callback *evcb = base->current_event;
2200 if (evcb->evcb_flags & EVLIST_INIT)
2201 ev = event_callback_to_event(evcb);
2203 EVBASE_RELEASE_LOCK(base, th_base_lock);
2208 event_new(struct event_base *base, evutil_socket_t fd, short events, void (*cb)(evutil_socket_t, short, void *), void *arg)
2211 ev = mm_malloc(sizeof(struct event));
2214 if (event_assign(ev, base, fd, events, cb, arg) < 0) {
2223 event_free(struct event *ev)
2225 /* This is disabled, so that events which have been finalized be a
2226 * valid target for event_free(). That's */
2227 // event_debug_assert_is_setup_(ev);
2229 /* make sure that this event won't be coming back to haunt us. */
2231 event_debug_note_teardown_(ev);
2237 event_debug_unassign(struct event *ev)
2239 event_debug_assert_not_added_(ev);
2240 event_debug_note_teardown_(ev);
2242 ev->ev_flags &= ~EVLIST_INIT;
2245 #define EVENT_FINALIZE_FREE_ 0x10000
2247 event_finalize_nolock_(struct event_base *base, unsigned flags, struct event *ev, event_finalize_callback_fn cb)
2249 ev_uint8_t closure = (flags & EVENT_FINALIZE_FREE_) ?
2250 EV_CLOSURE_EVENT_FINALIZE_FREE : EV_CLOSURE_EVENT_FINALIZE;
2252 event_del_nolock_(ev, EVENT_DEL_NOBLOCK);
2253 ev->ev_closure = closure;
2254 ev->ev_evcallback.evcb_cb_union.evcb_evfinalize = cb;
2255 event_active_nolock_(ev, EV_FINALIZE, 1);
2256 ev->ev_flags |= EVLIST_FINALIZING;
2261 event_finalize_impl_(unsigned flags, struct event *ev, event_finalize_callback_fn cb)
2264 struct event_base *base = ev->ev_base;
2265 if (EVUTIL_FAILURE_CHECK(!base)) {
2266 event_warnx("%s: event has no event_base set.", __func__);
2270 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
2271 r = event_finalize_nolock_(base, flags, ev, cb);
2272 EVBASE_RELEASE_LOCK(base, th_base_lock);
2277 event_finalize(unsigned flags, struct event *ev, event_finalize_callback_fn cb)
2279 return event_finalize_impl_(flags, ev, cb);
2283 event_free_finalize(unsigned flags, struct event *ev, event_finalize_callback_fn cb)
2285 return event_finalize_impl_(flags|EVENT_FINALIZE_FREE_, ev, cb);
2289 event_callback_finalize_nolock_(struct event_base *base, unsigned flags, struct event_callback *evcb, void (*cb)(struct event_callback *, void *))
2291 struct event *ev = NULL;
2292 if (evcb->evcb_flags & EVLIST_INIT) {
2293 ev = event_callback_to_event(evcb);
2294 event_del_nolock_(ev, EVENT_DEL_NOBLOCK);
2296 event_callback_cancel_nolock_(base, evcb, 0); /*XXX can this fail?*/
2299 evcb->evcb_closure = EV_CLOSURE_CB_FINALIZE;
2300 evcb->evcb_cb_union.evcb_cbfinalize = cb;
2301 event_callback_activate_nolock_(base, evcb); /* XXX can this really fail?*/
2302 evcb->evcb_flags |= EVLIST_FINALIZING;
2306 event_callback_finalize_(struct event_base *base, unsigned flags, struct event_callback *evcb, void (*cb)(struct event_callback *, void *))
2308 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
2309 event_callback_finalize_nolock_(base, flags, evcb, cb);
2310 EVBASE_RELEASE_LOCK(base, th_base_lock);
2313 /** Internal: Finalize all of the n_cbs callbacks in evcbs. The provided
2314 * callback will be invoked on *one of them*, after they have *all* been
2317 event_callback_finalize_many_(struct event_base *base, int n_cbs, struct event_callback **evcbs, void (*cb)(struct event_callback *, void *))
2319 int n_pending = 0, i;
2322 base = current_base;
2324 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
2326 event_debug(("%s: %d events finalizing", __func__, n_cbs));
2328 /* At most one can be currently executing; the rest we just
2329 * cancel... But we always make sure that the finalize callback
2331 for (i = 0; i < n_cbs; ++i) {
2332 struct event_callback *evcb = evcbs[i];
2333 if (evcb == base->current_event) {
2334 event_callback_finalize_nolock_(base, 0, evcb, cb);
2337 event_callback_cancel_nolock_(base, evcb, 0);
2341 if (n_pending == 0) {
2342 /* Just do the first one. */
2343 event_callback_finalize_nolock_(base, 0, evcbs[0], cb);
2346 EVBASE_RELEASE_LOCK(base, th_base_lock);
2351 * Set's the priority of an event - if an event is already scheduled
2352 * changing the priority is going to fail.
2356 event_priority_set(struct event *ev, int pri)
2358 event_debug_assert_is_setup_(ev);
2360 if (ev->ev_flags & EVLIST_ACTIVE)
2362 if (pri < 0 || pri >= ev->ev_base->nactivequeues)
2371 * Checks if a specific event is pending or scheduled.
2375 event_pending(const struct event *ev, short event, struct timeval *tv)
2379 if (EVUTIL_FAILURE_CHECK(ev->ev_base == NULL)) {
2380 event_warnx("%s: event has no event_base set.", __func__);
2384 EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);
2385 event_debug_assert_is_setup_(ev);
2387 if (ev->ev_flags & EVLIST_INSERTED)
2388 flags |= (ev->ev_events & (EV_READ|EV_WRITE|EV_CLOSED|EV_SIGNAL));
2389 if (ev->ev_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER))
2390 flags |= ev->ev_res;
2391 if (ev->ev_flags & EVLIST_TIMEOUT)
2392 flags |= EV_TIMEOUT;
2394 event &= (EV_TIMEOUT|EV_READ|EV_WRITE|EV_CLOSED|EV_SIGNAL);
2396 /* See if there is a timeout that we should report */
2397 if (tv != NULL && (flags & event & EV_TIMEOUT)) {
2398 struct timeval tmp = ev->ev_timeout;
2399 tmp.tv_usec &= MICROSECONDS_MASK;
2400 /* correctly remamp to real time */
2401 evutil_timeradd(&ev->ev_base->tv_clock_diff, &tmp, tv);
2404 EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);
2406 return (flags & event);
2410 event_initialized(const struct event *ev)
2412 if (!(ev->ev_flags & EVLIST_INIT))
2419 event_get_assignment(const struct event *event, struct event_base **base_out, evutil_socket_t *fd_out, short *events_out, event_callback_fn *callback_out, void **arg_out)
2421 event_debug_assert_is_setup_(event);
2424 *base_out = event->ev_base;
2426 *fd_out = event->ev_fd;
2428 *events_out = event->ev_events;
2430 *callback_out = event->ev_callback;
2432 *arg_out = event->ev_arg;
2436 event_get_struct_event_size(void)
2438 return sizeof(struct event);
2442 event_get_fd(const struct event *ev)
2444 event_debug_assert_is_setup_(ev);
2449 event_get_base(const struct event *ev)
2451 event_debug_assert_is_setup_(ev);
2456 event_get_events(const struct event *ev)
2458 event_debug_assert_is_setup_(ev);
2459 return ev->ev_events;
2463 event_get_callback(const struct event *ev)
2465 event_debug_assert_is_setup_(ev);
2466 return ev->ev_callback;
2470 event_get_callback_arg(const struct event *ev)
2472 event_debug_assert_is_setup_(ev);
2477 event_get_priority(const struct event *ev)
2479 event_debug_assert_is_setup_(ev);
2484 event_add(struct event *ev, const struct timeval *tv)
2488 if (EVUTIL_FAILURE_CHECK(!ev->ev_base)) {
2489 event_warnx("%s: event has no event_base set.", __func__);
2493 EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);
2495 res = event_add_nolock_(ev, tv, 0);
2497 EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);
2502 /* Helper callback: wake an event_base from another thread. This version
2503 * works by writing a byte to one end of a socketpair, so that the event_base
2504 * listening on the other end will wake up as the corresponding event
2507 evthread_notify_base_default(struct event_base *base)
2513 r = send(base->th_notify_fd[1], buf, 1, 0);
2515 r = write(base->th_notify_fd[1], buf, 1);
2517 return (r < 0 && ! EVUTIL_ERR_IS_EAGAIN(errno)) ? -1 : 0;
2520 #ifdef EVENT__HAVE_EVENTFD
2521 /* Helper callback: wake an event_base from another thread. This version
2522 * assumes that you have a working eventfd() implementation. */
2524 evthread_notify_base_eventfd(struct event_base *base)
2526 ev_uint64_t msg = 1;
2529 r = write(base->th_notify_fd[0], (void*) &msg, sizeof(msg));
2530 } while (r < 0 && errno == EAGAIN);
2532 return (r < 0) ? -1 : 0;
2537 /** Tell the thread currently running the event_loop for base (if any) that it
2538 * needs to stop waiting in its dispatch function (if it is) and process all
2539 * active callbacks. */
2541 evthread_notify_base(struct event_base *base)
2543 EVENT_BASE_ASSERT_LOCKED(base);
2544 if (!base->th_notify_fn)
2546 if (base->is_notify_pending)
2548 base->is_notify_pending = 1;
2549 return base->th_notify_fn(base);
2552 /* Implementation function to remove a timeout on a currently pending event.
2555 event_remove_timer_nolock_(struct event *ev)
2557 struct event_base *base = ev->ev_base;
2559 EVENT_BASE_ASSERT_LOCKED(base);
2560 event_debug_assert_is_setup_(ev);
2562 event_debug(("event_remove_timer_nolock: event: %p", ev));
2564 /* If it's not pending on a timeout, we don't need to do anything. */
2565 if (ev->ev_flags & EVLIST_TIMEOUT) {
2566 event_queue_remove_timeout(base, ev);
2567 evutil_timerclear(&ev->ev_.ev_io.ev_timeout);
2574 event_remove_timer(struct event *ev)
2578 if (EVUTIL_FAILURE_CHECK(!ev->ev_base)) {
2579 event_warnx("%s: event has no event_base set.", __func__);
2583 EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);
2585 res = event_remove_timer_nolock_(ev);
2587 EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);
2592 /* Implementation function to add an event. Works just like event_add,
2593 * except: 1) it requires that we have the lock. 2) if tv_is_absolute is set,
2594 * we treat tv as an absolute time, not as an interval to add to the current
2597 event_add_nolock_(struct event *ev, const struct timeval *tv,
2600 struct event_base *base = ev->ev_base;
2604 EVENT_BASE_ASSERT_LOCKED(base);
2605 event_debug_assert_is_setup_(ev);
2608 "event_add: event: %p (fd "EV_SOCK_FMT"), %s%s%s%scall %p",
2610 EV_SOCK_ARG(ev->ev_fd),
2611 ev->ev_events & EV_READ ? "EV_READ " : " ",
2612 ev->ev_events & EV_WRITE ? "EV_WRITE " : " ",
2613 ev->ev_events & EV_CLOSED ? "EV_CLOSED " : " ",
2614 tv ? "EV_TIMEOUT " : " ",
2617 EVUTIL_ASSERT(!(ev->ev_flags & ~EVLIST_ALL));
2619 if (ev->ev_flags & EVLIST_FINALIZING) {
2625 * prepare for timeout insertion further below, if we get a
2626 * failure on any step, we should not change any state.
2628 if (tv != NULL && !(ev->ev_flags & EVLIST_TIMEOUT)) {
2629 if (min_heap_reserve_(&base->timeheap,
2630 1 + min_heap_size_(&base->timeheap)) == -1)
2631 return (-1); /* ENOMEM == errno */
2634 /* If the main thread is currently executing a signal event's
2635 * callback, and we are not the main thread, then we want to wait
2636 * until the callback is done before we mess with the event, or else
2637 * we can race on ev_ncalls and ev_pncalls below. */
2638 #ifndef EVENT__DISABLE_THREAD_SUPPORT
2639 if (base->current_event == event_to_event_callback(ev) &&
2640 (ev->ev_events & EV_SIGNAL)
2641 && !EVBASE_IN_THREAD(base)) {
2642 ++base->current_event_waiters;
2643 EVTHREAD_COND_WAIT(base->current_event_cond, base->th_base_lock);
2647 if ((ev->ev_events & (EV_READ|EV_WRITE|EV_CLOSED|EV_SIGNAL)) &&
2648 !(ev->ev_flags & (EVLIST_INSERTED|EVLIST_ACTIVE|EVLIST_ACTIVE_LATER))) {
2649 if (ev->ev_events & (EV_READ|EV_WRITE|EV_CLOSED))
2650 res = evmap_io_add_(base, ev->ev_fd, ev);
2651 else if (ev->ev_events & EV_SIGNAL)
2652 res = evmap_signal_add_(base, (int)ev->ev_fd, ev);
2654 event_queue_insert_inserted(base, ev);
2656 /* evmap says we need to notify the main thread. */
2663 * we should change the timeout state only if the previous event
2664 * addition succeeded.
2666 if (res != -1 && tv != NULL) {
2669 #ifdef USE_REINSERT_TIMEOUT
2671 int old_timeout_idx;
2675 * for persistent timeout events, we remember the
2676 * timeout value and re-add the event.
2678 * If tv_is_absolute, this was already set.
2680 if (ev->ev_closure == EV_CLOSURE_EVENT_PERSIST && !tv_is_absolute)
2681 ev->ev_io_timeout = *tv;
2683 #ifndef USE_REINSERT_TIMEOUT
2684 if (ev->ev_flags & EVLIST_TIMEOUT) {
2685 event_queue_remove_timeout(base, ev);
2689 /* Check if it is active due to a timeout. Rescheduling
2690 * this timeout before the callback can be executed
2691 * removes it from the active list. */
2692 if ((ev->ev_flags & EVLIST_ACTIVE) &&
2693 (ev->ev_res & EV_TIMEOUT)) {
2694 if (ev->ev_events & EV_SIGNAL) {
2695 /* See if we are just active executing
2696 * this event in a loop
2698 if (ev->ev_ncalls && ev->ev_pncalls) {
2700 *ev->ev_pncalls = 0;
2704 event_queue_remove_active(base, event_to_event_callback(ev));
2707 gettime(base, &now);
2709 common_timeout = is_common_timeout(tv, base);
2710 #ifdef USE_REINSERT_TIMEOUT
2711 was_common = is_common_timeout(&ev->ev_timeout, base);
2712 old_timeout_idx = COMMON_TIMEOUT_IDX(&ev->ev_timeout);
2715 if (tv_is_absolute) {
2716 ev->ev_timeout = *tv;
2717 } else if (common_timeout) {
2718 struct timeval tmp = *tv;
2719 tmp.tv_usec &= MICROSECONDS_MASK;
2720 evutil_timeradd(&now, &tmp, &ev->ev_timeout);
2721 ev->ev_timeout.tv_usec |=
2722 (tv->tv_usec & ~MICROSECONDS_MASK);
2724 evutil_timeradd(&now, tv, &ev->ev_timeout);
2728 "event_add: event %p, timeout in %d seconds %d useconds, call %p",
2729 ev, (int)tv->tv_sec, (int)tv->tv_usec, ev->ev_callback));
2731 #ifdef USE_REINSERT_TIMEOUT
2732 event_queue_reinsert_timeout(base, ev, was_common, common_timeout, old_timeout_idx);
2734 event_queue_insert_timeout(base, ev);
2737 if (common_timeout) {
2738 struct common_timeout_list *ctl =
2739 get_common_timeout_list(base, &ev->ev_timeout);
2740 if (ev == TAILQ_FIRST(&ctl->events)) {
2741 common_timeout_schedule(ctl, &now, ev);
2744 struct event* top = NULL;
2745 /* See if the earliest timeout is now earlier than it
2746 * was before: if so, we will need to tell the main
2747 * thread to wake up earlier than it would otherwise.
2748 * We double check the timeout of the top element to
2749 * handle time distortions due to system suspension.
2751 if (min_heap_elt_is_top_(ev))
2753 else if ((top = min_heap_top_(&base->timeheap)) != NULL &&
2754 evutil_timercmp(&top->ev_timeout, &now, <))
2759 /* if we are not in the right thread, we need to wake up the loop */
2760 if (res != -1 && notify && EVBASE_NEED_NOTIFY(base))
2761 evthread_notify_base(base);
2763 event_debug_note_add_(ev);
2769 event_del_(struct event *ev, int blocking)
2772 struct event_base *base = ev->ev_base;
2774 if (EVUTIL_FAILURE_CHECK(!base)) {
2775 event_warnx("%s: event has no event_base set.", __func__);
2779 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
2780 res = event_del_nolock_(ev, blocking);
2781 EVBASE_RELEASE_LOCK(base, th_base_lock);
2787 event_del(struct event *ev)
2789 return event_del_(ev, EVENT_DEL_AUTOBLOCK);
2793 event_del_block(struct event *ev)
2795 return event_del_(ev, EVENT_DEL_BLOCK);
2799 event_del_noblock(struct event *ev)
2801 return event_del_(ev, EVENT_DEL_NOBLOCK);
2804 /** Helper for event_del: always called with th_base_lock held.
2806 * "blocking" must be one of the EVENT_DEL_{BLOCK, NOBLOCK, AUTOBLOCK,
2807 * EVEN_IF_FINALIZING} values. See those for more information.
2810 event_del_nolock_(struct event *ev, int blocking)
2812 struct event_base *base;
2813 int res = 0, notify = 0;
2815 event_debug(("event_del: %p (fd "EV_SOCK_FMT"), callback %p",
2816 ev, EV_SOCK_ARG(ev->ev_fd), ev->ev_callback));
2818 /* An event without a base has not been added */
2819 if (ev->ev_base == NULL)
2822 EVENT_BASE_ASSERT_LOCKED(ev->ev_base);
2824 if (blocking != EVENT_DEL_EVEN_IF_FINALIZING) {
2825 if (ev->ev_flags & EVLIST_FINALIZING) {
2833 EVUTIL_ASSERT(!(ev->ev_flags & ~EVLIST_ALL));
2835 /* See if we are just active executing this event in a loop */
2836 if (ev->ev_events & EV_SIGNAL) {
2837 if (ev->ev_ncalls && ev->ev_pncalls) {
2839 *ev->ev_pncalls = 0;
2843 if (ev->ev_flags & EVLIST_TIMEOUT) {
2844 /* NOTE: We never need to notify the main thread because of a
2845 * deleted timeout event: all that could happen if we don't is
2846 * that the dispatch loop might wake up too early. But the
2847 * point of notifying the main thread _is_ to wake up the
2848 * dispatch loop early anyway, so we wouldn't gain anything by
2851 event_queue_remove_timeout(base, ev);
2854 if (ev->ev_flags & EVLIST_ACTIVE)
2855 event_queue_remove_active(base, event_to_event_callback(ev));
2856 else if (ev->ev_flags & EVLIST_ACTIVE_LATER)
2857 event_queue_remove_active_later(base, event_to_event_callback(ev));
2859 if (ev->ev_flags & EVLIST_INSERTED) {
2860 event_queue_remove_inserted(base, ev);
2861 if (ev->ev_events & (EV_READ|EV_WRITE|EV_CLOSED))
2862 res = evmap_io_del_(base, ev->ev_fd, ev);
2864 res = evmap_signal_del_(base, (int)ev->ev_fd, ev);
2866 /* evmap says we need to notify the main thread. */
2870 /* If we do not have events, let's notify event base so it can
2871 * exit without waiting */
2872 if (!event_haveevents(base) && !N_ACTIVE_CALLBACKS(base))
2876 /* if we are not in the right thread, we need to wake up the loop */
2877 if (res != -1 && notify && EVBASE_NEED_NOTIFY(base))
2878 evthread_notify_base(base);
2880 event_debug_note_del_(ev);
2882 /* If the main thread is currently executing this event's callback,
2883 * and we are not the main thread, then we want to wait until the
2884 * callback is done before returning. That way, when this function
2885 * returns, it will be safe to free the user-supplied argument.
2887 #ifndef EVENT__DISABLE_THREAD_SUPPORT
2888 if (blocking != EVENT_DEL_NOBLOCK &&
2889 base->current_event == event_to_event_callback(ev) &&
2890 !EVBASE_IN_THREAD(base) &&
2891 (blocking == EVENT_DEL_BLOCK || !(ev->ev_events & EV_FINALIZE))) {
2892 ++base->current_event_waiters;
2893 EVTHREAD_COND_WAIT(base->current_event_cond, base->th_base_lock);
2901 event_active(struct event *ev, int res, short ncalls)
2903 if (EVUTIL_FAILURE_CHECK(!ev->ev_base)) {
2904 event_warnx("%s: event has no event_base set.", __func__);
2908 EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);
2910 event_debug_assert_is_setup_(ev);
2912 event_active_nolock_(ev, res, ncalls);
2914 EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);
2919 event_active_nolock_(struct event *ev, int res, short ncalls)
2921 struct event_base *base;
2923 event_debug(("event_active: %p (fd "EV_SOCK_FMT"), res %d, callback %p",
2924 ev, EV_SOCK_ARG(ev->ev_fd), (int)res, ev->ev_callback));
2927 EVENT_BASE_ASSERT_LOCKED(base);
2929 if (ev->ev_flags & EVLIST_FINALIZING) {
2934 switch ((ev->ev_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER))) {
2936 case EVLIST_ACTIVE|EVLIST_ACTIVE_LATER:
2940 /* We get different kinds of events, add them together */
2943 case EVLIST_ACTIVE_LATER:
2951 if (ev->ev_pri < base->event_running_priority)
2952 base->event_continue = 1;
2954 if (ev->ev_events & EV_SIGNAL) {
2955 #ifndef EVENT__DISABLE_THREAD_SUPPORT
2956 if (base->current_event == event_to_event_callback(ev) &&
2957 !EVBASE_IN_THREAD(base)) {
2958 ++base->current_event_waiters;
2959 EVTHREAD_COND_WAIT(base->current_event_cond, base->th_base_lock);
2962 ev->ev_ncalls = ncalls;
2963 ev->ev_pncalls = NULL;
2966 event_callback_activate_nolock_(base, event_to_event_callback(ev));
2970 event_active_later_(struct event *ev, int res)
2972 EVBASE_ACQUIRE_LOCK(ev->ev_base, th_base_lock);
2973 event_active_later_nolock_(ev, res);
2974 EVBASE_RELEASE_LOCK(ev->ev_base, th_base_lock);
2978 event_active_later_nolock_(struct event *ev, int res)
2980 struct event_base *base = ev->ev_base;
2981 EVENT_BASE_ASSERT_LOCKED(base);
2983 if (ev->ev_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER)) {
2984 /* We get different kinds of events, add them together */
2991 event_callback_activate_later_nolock_(base, event_to_event_callback(ev));
2995 event_callback_activate_(struct event_base *base,
2996 struct event_callback *evcb)
2999 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3000 r = event_callback_activate_nolock_(base, evcb);
3001 EVBASE_RELEASE_LOCK(base, th_base_lock);
3006 event_callback_activate_nolock_(struct event_base *base,
3007 struct event_callback *evcb)
3011 if (evcb->evcb_flags & EVLIST_FINALIZING)
3014 switch (evcb->evcb_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER)) {
3018 case EVLIST_ACTIVE_LATER:
3019 event_queue_remove_active_later(base, evcb);
3028 event_queue_insert_active(base, evcb);
3030 if (EVBASE_NEED_NOTIFY(base))
3031 evthread_notify_base(base);
3037 event_callback_activate_later_nolock_(struct event_base *base,
3038 struct event_callback *evcb)
3040 if (evcb->evcb_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER))
3043 event_queue_insert_active_later(base, evcb);
3044 if (EVBASE_NEED_NOTIFY(base))
3045 evthread_notify_base(base);
3050 event_callback_init_(struct event_base *base,
3051 struct event_callback *cb)
3053 memset(cb, 0, sizeof(*cb));
3054 cb->evcb_pri = base->nactivequeues - 1;
3058 event_callback_cancel_(struct event_base *base,
3059 struct event_callback *evcb)
3062 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3063 r = event_callback_cancel_nolock_(base, evcb, 0);
3064 EVBASE_RELEASE_LOCK(base, th_base_lock);
3069 event_callback_cancel_nolock_(struct event_base *base,
3070 struct event_callback *evcb, int even_if_finalizing)
3072 if ((evcb->evcb_flags & EVLIST_FINALIZING) && !even_if_finalizing)
3075 if (evcb->evcb_flags & EVLIST_INIT)
3076 return event_del_nolock_(event_callback_to_event(evcb),
3077 even_if_finalizing ? EVENT_DEL_EVEN_IF_FINALIZING : EVENT_DEL_AUTOBLOCK);
3079 switch ((evcb->evcb_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER))) {
3081 case EVLIST_ACTIVE|EVLIST_ACTIVE_LATER:
3085 /* We get different kinds of events, add them together */
3086 event_queue_remove_active(base, evcb);
3088 case EVLIST_ACTIVE_LATER:
3089 event_queue_remove_active_later(base, evcb);
3099 event_deferred_cb_init_(struct event_callback *cb, ev_uint8_t priority, deferred_cb_fn fn, void *arg)
3101 memset(cb, 0, sizeof(*cb));
3102 cb->evcb_cb_union.evcb_selfcb = fn;
3104 cb->evcb_pri = priority;
3105 cb->evcb_closure = EV_CLOSURE_CB_SELF;
3109 event_deferred_cb_set_priority_(struct event_callback *cb, ev_uint8_t priority)
3111 cb->evcb_pri = priority;
3115 event_deferred_cb_cancel_(struct event_base *base, struct event_callback *cb)
3118 base = current_base;
3119 event_callback_cancel_(base, cb);
3122 #define MAX_DEFERREDS_QUEUED 32
3124 event_deferred_cb_schedule_(struct event_base *base, struct event_callback *cb)
3128 base = current_base;
3129 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3130 if (base->n_deferreds_queued > MAX_DEFERREDS_QUEUED) {
3131 r = event_callback_activate_later_nolock_(base, cb);
3133 r = event_callback_activate_nolock_(base, cb);
3135 ++base->n_deferreds_queued;
3138 EVBASE_RELEASE_LOCK(base, th_base_lock);
3143 timeout_next(struct event_base *base, struct timeval **tv_p)
3145 /* Caller must hold th_base_lock */
3148 struct timeval *tv = *tv_p;
3151 ev = min_heap_top_(&base->timeheap);
3154 /* if no time-based events are active wait for I/O */
3159 if (gettime(base, &now) == -1) {
3164 if (evutil_timercmp(&ev->ev_timeout, &now, <=)) {
3165 evutil_timerclear(tv);
3169 evutil_timersub(&ev->ev_timeout, &now, tv);
3171 EVUTIL_ASSERT(tv->tv_sec >= 0);
3172 EVUTIL_ASSERT(tv->tv_usec >= 0);
3173 event_debug(("timeout_next: event: %p, in %d seconds, %d useconds", ev, (int)tv->tv_sec, (int)tv->tv_usec));
3179 /* Activate every event whose timeout has elapsed. */
3181 timeout_process(struct event_base *base)
3183 /* Caller must hold lock. */
3187 if (min_heap_empty_(&base->timeheap)) {
3191 gettime(base, &now);
3193 while ((ev = min_heap_top_(&base->timeheap))) {
3194 if (evutil_timercmp(&ev->ev_timeout, &now, >))
3197 /* delete this event from the I/O queues */
3198 event_del_nolock_(ev, EVENT_DEL_NOBLOCK);
3200 event_debug(("timeout_process: event: %p, call %p",
3201 ev, ev->ev_callback));
3202 event_active_nolock_(ev, EV_TIMEOUT, 1);
3207 #define MAX(a,b) (((a)>(b))?(a):(b))
3210 #define MAX_EVENT_COUNT(var, v) var = MAX(var, v)
3212 /* These are a fancy way to spell
3213 if (~flags & EVLIST_INTERNAL)
3214 base->event_count--/++;
3216 #define DECR_EVENT_COUNT(base,flags) \
3217 ((base)->event_count -= !((flags) & EVLIST_INTERNAL))
3218 #define INCR_EVENT_COUNT(base,flags) do { \
3219 ((base)->event_count += !((flags) & EVLIST_INTERNAL)); \
3220 MAX_EVENT_COUNT((base)->event_count_max, (base)->event_count); \
3224 event_queue_remove_inserted(struct event_base *base, struct event *ev)
3226 EVENT_BASE_ASSERT_LOCKED(base);
3227 if (EVUTIL_FAILURE_CHECK(!(ev->ev_flags & EVLIST_INSERTED))) {
3228 event_errx(1, "%s: %p(fd "EV_SOCK_FMT") not on queue %x", __func__,
3229 ev, EV_SOCK_ARG(ev->ev_fd), EVLIST_INSERTED);
3232 DECR_EVENT_COUNT(base, ev->ev_flags);
3233 ev->ev_flags &= ~EVLIST_INSERTED;
3236 event_queue_remove_active(struct event_base *base, struct event_callback *evcb)
3238 EVENT_BASE_ASSERT_LOCKED(base);
3239 if (EVUTIL_FAILURE_CHECK(!(evcb->evcb_flags & EVLIST_ACTIVE))) {
3240 event_errx(1, "%s: %p not on queue %x", __func__,
3241 evcb, EVLIST_ACTIVE);
3244 DECR_EVENT_COUNT(base, evcb->evcb_flags);
3245 evcb->evcb_flags &= ~EVLIST_ACTIVE;
3246 base->event_count_active--;
3248 TAILQ_REMOVE(&base->activequeues[evcb->evcb_pri],
3249 evcb, evcb_active_next);
3252 event_queue_remove_active_later(struct event_base *base, struct event_callback *evcb)
3254 EVENT_BASE_ASSERT_LOCKED(base);
3255 if (EVUTIL_FAILURE_CHECK(!(evcb->evcb_flags & EVLIST_ACTIVE_LATER))) {
3256 event_errx(1, "%s: %p not on queue %x", __func__,
3257 evcb, EVLIST_ACTIVE_LATER);
3260 DECR_EVENT_COUNT(base, evcb->evcb_flags);
3261 evcb->evcb_flags &= ~EVLIST_ACTIVE_LATER;
3262 base->event_count_active--;
3264 TAILQ_REMOVE(&base->active_later_queue, evcb, evcb_active_next);
3267 event_queue_remove_timeout(struct event_base *base, struct event *ev)
3269 EVENT_BASE_ASSERT_LOCKED(base);
3270 if (EVUTIL_FAILURE_CHECK(!(ev->ev_flags & EVLIST_TIMEOUT))) {
3271 event_errx(1, "%s: %p(fd "EV_SOCK_FMT") not on queue %x", __func__,
3272 ev, EV_SOCK_ARG(ev->ev_fd), EVLIST_TIMEOUT);
3275 DECR_EVENT_COUNT(base, ev->ev_flags);
3276 ev->ev_flags &= ~EVLIST_TIMEOUT;
3278 if (is_common_timeout(&ev->ev_timeout, base)) {
3279 struct common_timeout_list *ctl =
3280 get_common_timeout_list(base, &ev->ev_timeout);
3281 TAILQ_REMOVE(&ctl->events, ev,
3282 ev_timeout_pos.ev_next_with_common_timeout);
3284 min_heap_erase_(&base->timeheap, ev);
3288 #ifdef USE_REINSERT_TIMEOUT
3289 /* Remove and reinsert 'ev' into the timeout queue. */
3291 event_queue_reinsert_timeout(struct event_base *base, struct event *ev,
3292 int was_common, int is_common, int old_timeout_idx)
3294 struct common_timeout_list *ctl;
3295 if (!(ev->ev_flags & EVLIST_TIMEOUT)) {
3296 event_queue_insert_timeout(base, ev);
3300 switch ((was_common<<1) | is_common) {
3301 case 3: /* Changing from one common timeout to another */
3302 ctl = base->common_timeout_queues[old_timeout_idx];
3303 TAILQ_REMOVE(&ctl->events, ev,
3304 ev_timeout_pos.ev_next_with_common_timeout);
3305 ctl = get_common_timeout_list(base, &ev->ev_timeout);
3306 insert_common_timeout_inorder(ctl, ev);
3308 case 2: /* Was common; is no longer common */
3309 ctl = base->common_timeout_queues[old_timeout_idx];
3310 TAILQ_REMOVE(&ctl->events, ev,
3311 ev_timeout_pos.ev_next_with_common_timeout);
3312 min_heap_push_(&base->timeheap, ev);
3314 case 1: /* Wasn't common; has become common. */
3315 min_heap_erase_(&base->timeheap, ev);
3316 ctl = get_common_timeout_list(base, &ev->ev_timeout);
3317 insert_common_timeout_inorder(ctl, ev);
3319 case 0: /* was in heap; is still on heap. */
3320 min_heap_adjust_(&base->timeheap, ev);
3323 EVUTIL_ASSERT(0); /* unreachable */
3329 /* Add 'ev' to the common timeout list in 'ev'. */
3331 insert_common_timeout_inorder(struct common_timeout_list *ctl,
3335 /* By all logic, we should just be able to append 'ev' to the end of
3336 * ctl->events, since the timeout on each 'ev' is set to {the common
3337 * timeout} + {the time when we add the event}, and so the events
3338 * should arrive in order of their timeeouts. But just in case
3339 * there's some wacky threading issue going on, we do a search from
3340 * the end of 'ev' to find the right insertion point.
3342 TAILQ_FOREACH_REVERSE(e, &ctl->events,
3343 event_list, ev_timeout_pos.ev_next_with_common_timeout) {
3344 /* This timercmp is a little sneaky, since both ev and e have
3345 * magic values in tv_usec. Fortunately, they ought to have
3346 * the _same_ magic values in tv_usec. Let's assert for that.
3349 is_same_common_timeout(&e->ev_timeout, &ev->ev_timeout));
3350 if (evutil_timercmp(&ev->ev_timeout, &e->ev_timeout, >=)) {
3351 TAILQ_INSERT_AFTER(&ctl->events, e, ev,
3352 ev_timeout_pos.ev_next_with_common_timeout);
3356 TAILQ_INSERT_HEAD(&ctl->events, ev,
3357 ev_timeout_pos.ev_next_with_common_timeout);
3361 event_queue_insert_inserted(struct event_base *base, struct event *ev)
3363 EVENT_BASE_ASSERT_LOCKED(base);
3365 if (EVUTIL_FAILURE_CHECK(ev->ev_flags & EVLIST_INSERTED)) {
3366 event_errx(1, "%s: %p(fd "EV_SOCK_FMT") already inserted", __func__,
3367 ev, EV_SOCK_ARG(ev->ev_fd));
3371 INCR_EVENT_COUNT(base, ev->ev_flags);
3373 ev->ev_flags |= EVLIST_INSERTED;
3377 event_queue_insert_active(struct event_base *base, struct event_callback *evcb)
3379 EVENT_BASE_ASSERT_LOCKED(base);
3381 if (evcb->evcb_flags & EVLIST_ACTIVE) {
3382 /* Double insertion is possible for active events */
3386 INCR_EVENT_COUNT(base, evcb->evcb_flags);
3388 evcb->evcb_flags |= EVLIST_ACTIVE;
3390 base->event_count_active++;
3391 MAX_EVENT_COUNT(base->event_count_active_max, base->event_count_active);
3392 EVUTIL_ASSERT(evcb->evcb_pri < base->nactivequeues);
3393 TAILQ_INSERT_TAIL(&base->activequeues[evcb->evcb_pri],
3394 evcb, evcb_active_next);
3398 event_queue_insert_active_later(struct event_base *base, struct event_callback *evcb)
3400 EVENT_BASE_ASSERT_LOCKED(base);
3401 if (evcb->evcb_flags & (EVLIST_ACTIVE_LATER|EVLIST_ACTIVE)) {
3402 /* Double insertion is possible */
3406 INCR_EVENT_COUNT(base, evcb->evcb_flags);
3407 evcb->evcb_flags |= EVLIST_ACTIVE_LATER;
3408 base->event_count_active++;
3409 MAX_EVENT_COUNT(base->event_count_active_max, base->event_count_active);
3410 EVUTIL_ASSERT(evcb->evcb_pri < base->nactivequeues);
3411 TAILQ_INSERT_TAIL(&base->active_later_queue, evcb, evcb_active_next);
3415 event_queue_insert_timeout(struct event_base *base, struct event *ev)
3417 EVENT_BASE_ASSERT_LOCKED(base);
3419 if (EVUTIL_FAILURE_CHECK(ev->ev_flags & EVLIST_TIMEOUT)) {
3420 event_errx(1, "%s: %p(fd "EV_SOCK_FMT") already on timeout", __func__,
3421 ev, EV_SOCK_ARG(ev->ev_fd));
3425 INCR_EVENT_COUNT(base, ev->ev_flags);
3427 ev->ev_flags |= EVLIST_TIMEOUT;
3429 if (is_common_timeout(&ev->ev_timeout, base)) {
3430 struct common_timeout_list *ctl =
3431 get_common_timeout_list(base, &ev->ev_timeout);
3432 insert_common_timeout_inorder(ctl, ev);
3434 min_heap_push_(&base->timeheap, ev);
3439 event_queue_make_later_events_active(struct event_base *base)
3441 struct event_callback *evcb;
3442 EVENT_BASE_ASSERT_LOCKED(base);
3444 while ((evcb = TAILQ_FIRST(&base->active_later_queue))) {
3445 TAILQ_REMOVE(&base->active_later_queue, evcb, evcb_active_next);
3446 evcb->evcb_flags = (evcb->evcb_flags & ~EVLIST_ACTIVE_LATER) | EVLIST_ACTIVE;
3447 EVUTIL_ASSERT(evcb->evcb_pri < base->nactivequeues);
3448 TAILQ_INSERT_TAIL(&base->activequeues[evcb->evcb_pri], evcb, evcb_active_next);
3449 base->n_deferreds_queued += (evcb->evcb_closure == EV_CLOSURE_CB_SELF);
3453 /* Functions for debugging */
3456 event_get_version(void)
3458 return (EVENT__VERSION);
3462 event_get_version_number(void)
3464 return (EVENT__NUMERIC_VERSION);
3468 * No thread-safe interface needed - the information should be the same
3473 event_get_method(void)
3475 return (current_base->evsel->name);
3478 #ifndef EVENT__DISABLE_MM_REPLACEMENT
3479 static void *(*mm_malloc_fn_)(size_t sz) = NULL;
3480 static void *(*mm_realloc_fn_)(void *p, size_t sz) = NULL;
3481 static void (*mm_free_fn_)(void *p) = NULL;
3484 event_mm_malloc_(size_t sz)
3490 return mm_malloc_fn_(sz);
3496 event_mm_calloc_(size_t count, size_t size)
3498 if (count == 0 || size == 0)
3501 if (mm_malloc_fn_) {
3502 size_t sz = count * size;
3504 if (count > EV_SIZE_MAX / size)
3506 p = mm_malloc_fn_(sz);
3508 return memset(p, 0, sz);
3510 void *p = calloc(count, size);
3512 /* Windows calloc doesn't reliably set ENOMEM */
3525 event_mm_strdup_(const char *str)
3532 if (mm_malloc_fn_) {
3533 size_t ln = strlen(str);
3535 if (ln == EV_SIZE_MAX)
3537 p = mm_malloc_fn_(ln+1);
3539 return memcpy(p, str, ln+1);
3542 return _strdup(str);
3553 event_mm_realloc_(void *ptr, size_t sz)
3556 return mm_realloc_fn_(ptr, sz);
3558 return realloc(ptr, sz);
3562 event_mm_free_(void *ptr)
3571 event_set_mem_functions(void *(*malloc_fn)(size_t sz),
3572 void *(*realloc_fn)(void *ptr, size_t sz),
3573 void (*free_fn)(void *ptr))
3575 mm_malloc_fn_ = malloc_fn;
3576 mm_realloc_fn_ = realloc_fn;
3577 mm_free_fn_ = free_fn;
3581 #ifdef EVENT__HAVE_EVENTFD
3583 evthread_notify_drain_eventfd(evutil_socket_t fd, short what, void *arg)
3587 struct event_base *base = arg;
3589 r = read(fd, (void*) &msg, sizeof(msg));
3590 if (r<0 && errno != EAGAIN) {
3591 event_sock_warn(fd, "Error reading from eventfd");
3593 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3594 base->is_notify_pending = 0;
3595 EVBASE_RELEASE_LOCK(base, th_base_lock);
3600 evthread_notify_drain_default(evutil_socket_t fd, short what, void *arg)
3602 unsigned char buf[1024];
3603 struct event_base *base = arg;
3605 while (recv(fd, (char*)buf, sizeof(buf), 0) > 0)
3608 while (read(fd, (char*)buf, sizeof(buf)) > 0)
3612 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3613 base->is_notify_pending = 0;
3614 EVBASE_RELEASE_LOCK(base, th_base_lock);
3618 evthread_make_base_notifiable(struct event_base *base)
3624 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3625 r = evthread_make_base_notifiable_nolock_(base);
3626 EVBASE_RELEASE_LOCK(base, th_base_lock);
3631 evthread_make_base_notifiable_nolock_(struct event_base *base)
3633 void (*cb)(evutil_socket_t, short, void *);
3634 int (*notify)(struct event_base *);
3636 if (base->th_notify_fn != NULL) {
3637 /* The base is already notifiable: we're doing fine. */
3641 #if defined(EVENT__HAVE_WORKING_KQUEUE)
3642 if (base->evsel == &kqops && event_kq_add_notify_event_(base) == 0) {
3643 base->th_notify_fn = event_kq_notify_base_;
3644 /* No need to add an event here; the backend can wake
3645 * itself up just fine. */
3650 #ifdef EVENT__HAVE_EVENTFD
3651 base->th_notify_fd[0] = evutil_eventfd_(0,
3652 EVUTIL_EFD_CLOEXEC|EVUTIL_EFD_NONBLOCK);
3653 if (base->th_notify_fd[0] >= 0) {
3654 base->th_notify_fd[1] = -1;
3655 notify = evthread_notify_base_eventfd;
3656 cb = evthread_notify_drain_eventfd;
3659 if (evutil_make_internal_pipe_(base->th_notify_fd) == 0) {
3660 notify = evthread_notify_base_default;
3661 cb = evthread_notify_drain_default;
3666 base->th_notify_fn = notify;
3668 /* prepare an event that we can use for wakeup */
3669 event_assign(&base->th_notify, base, base->th_notify_fd[0],
3670 EV_READ|EV_PERSIST, cb, base);
3672 /* we need to mark this as internal event */
3673 base->th_notify.ev_flags |= EVLIST_INTERNAL;
3674 event_priority_set(&base->th_notify, 0);
3676 return event_add_nolock_(&base->th_notify, NULL, 0);
3680 event_base_foreach_event_nolock_(struct event_base *base,
3681 event_base_foreach_event_cb fn, void *arg)
3687 /* Start out with all the EVLIST_INSERTED events. */
3688 if ((r = evmap_foreach_event_(base, fn, arg)))
3691 /* Okay, now we deal with those events that have timeouts and are in
3693 for (u = 0; u < base->timeheap.n; ++u) {
3694 ev = base->timeheap.p[u];
3695 if (ev->ev_flags & EVLIST_INSERTED) {
3696 /* we already processed this one */
3699 if ((r = fn(base, ev, arg)))
3703 /* Now for the events in one of the timeout queues.
3705 for (i = 0; i < base->n_common_timeouts; ++i) {
3706 struct common_timeout_list *ctl =
3707 base->common_timeout_queues[i];
3708 TAILQ_FOREACH(ev, &ctl->events,
3709 ev_timeout_pos.ev_next_with_common_timeout) {
3710 if (ev->ev_flags & EVLIST_INSERTED) {
3711 /* we already processed this one */
3714 if ((r = fn(base, ev, arg)))
3719 /* Finally, we deal wit all the active events that we haven't touched
3721 for (i = 0; i < base->nactivequeues; ++i) {
3722 struct event_callback *evcb;
3723 TAILQ_FOREACH(evcb, &base->activequeues[i], evcb_active_next) {
3724 if ((evcb->evcb_flags & (EVLIST_INIT|EVLIST_INSERTED|EVLIST_TIMEOUT)) != EVLIST_INIT) {
3725 /* This isn't an event (evlist_init clear), or
3726 * we already processed it. (inserted or
3730 ev = event_callback_to_event(evcb);
3731 if ((r = fn(base, ev, arg)))
3739 /* Helper for event_base_dump_events: called on each event in the event base;
3740 * dumps only the inserted events. */
3742 dump_inserted_event_fn(const struct event_base *base, const struct event *e, void *arg)
3745 const char *gloss = (e->ev_events & EV_SIGNAL) ?
3748 if (! (e->ev_flags & (EVLIST_INSERTED|EVLIST_TIMEOUT)))
3751 fprintf(output, " %p [%s "EV_SOCK_FMT"]%s%s%s%s%s%s%s",
3752 (void*)e, gloss, EV_SOCK_ARG(e->ev_fd),
3753 (e->ev_events&EV_READ)?" Read":"",
3754 (e->ev_events&EV_WRITE)?" Write":"",
3755 (e->ev_events&EV_CLOSED)?" EOF":"",
3756 (e->ev_events&EV_SIGNAL)?" Signal":"",
3757 (e->ev_events&EV_PERSIST)?" Persist":"",
3758 (e->ev_events&EV_ET)?" ET":"",
3759 (e->ev_flags&EVLIST_INTERNAL)?" Internal":"");
3760 if (e->ev_flags & EVLIST_TIMEOUT) {
3762 tv.tv_sec = e->ev_timeout.tv_sec;
3763 tv.tv_usec = e->ev_timeout.tv_usec & MICROSECONDS_MASK;
3764 evutil_timeradd(&tv, &base->tv_clock_diff, &tv);
3765 fprintf(output, " Timeout=%ld.%06d",
3766 (long)tv.tv_sec, (int)(tv.tv_usec & MICROSECONDS_MASK));
3768 fputc('\n', output);
3773 /* Helper for event_base_dump_events: called on each event in the event base;
3774 * dumps only the active events. */
3776 dump_active_event_fn(const struct event_base *base, const struct event *e, void *arg)
3779 const char *gloss = (e->ev_events & EV_SIGNAL) ?
3782 if (! (e->ev_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER)))
3785 fprintf(output, " %p [%s "EV_SOCK_FMT", priority=%d]%s%s%s%s%s active%s%s\n",
3786 (void*)e, gloss, EV_SOCK_ARG(e->ev_fd), e->ev_pri,
3787 (e->ev_res&EV_READ)?" Read":"",
3788 (e->ev_res&EV_WRITE)?" Write":"",
3789 (e->ev_res&EV_CLOSED)?" EOF":"",
3790 (e->ev_res&EV_SIGNAL)?" Signal":"",
3791 (e->ev_res&EV_TIMEOUT)?" Timeout":"",
3792 (e->ev_flags&EVLIST_INTERNAL)?" [Internal]":"",
3793 (e->ev_flags&EVLIST_ACTIVE_LATER)?" [NextTime]":"");
3799 event_base_foreach_event(struct event_base *base,
3800 event_base_foreach_event_cb fn, void *arg)
3803 if ((!fn) || (!base)) {
3806 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3807 r = event_base_foreach_event_nolock_(base, fn, arg);
3808 EVBASE_RELEASE_LOCK(base, th_base_lock);
3814 event_base_dump_events(struct event_base *base, FILE *output)
3816 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3817 fprintf(output, "Inserted events:\n");
3818 event_base_foreach_event_nolock_(base, dump_inserted_event_fn, output);
3820 fprintf(output, "Active events:\n");
3821 event_base_foreach_event_nolock_(base, dump_active_event_fn, output);
3822 EVBASE_RELEASE_LOCK(base, th_base_lock);
3826 event_base_active_by_fd(struct event_base *base, evutil_socket_t fd, short events)
3828 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3830 /* Activate any non timer events */
3831 if (!(events & EV_TIMEOUT)) {
3832 evmap_io_active_(base, fd, events & (EV_READ|EV_WRITE|EV_CLOSED));
3834 /* If we want to activate timer events, loop and activate each event with
3835 * the same fd in both the timeheap and common timeouts list */
3840 for (u = 0; u < base->timeheap.n; ++u) {
3841 ev = base->timeheap.p[u];
3842 if (ev->ev_fd == fd) {
3843 event_active_nolock_(ev, EV_TIMEOUT, 1);
3847 for (i = 0; i < base->n_common_timeouts; ++i) {
3848 struct common_timeout_list *ctl = base->common_timeout_queues[i];
3849 TAILQ_FOREACH(ev, &ctl->events,
3850 ev_timeout_pos.ev_next_with_common_timeout) {
3851 if (ev->ev_fd == fd) {
3852 event_active_nolock_(ev, EV_TIMEOUT, 1);
3858 EVBASE_RELEASE_LOCK(base, th_base_lock);
3862 event_base_active_by_signal(struct event_base *base, int sig)
3864 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3865 evmap_signal_active_(base, sig, 1);
3866 EVBASE_RELEASE_LOCK(base, th_base_lock);
3871 event_base_add_virtual_(struct event_base *base)
3873 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3874 base->virtual_event_count++;
3875 MAX_EVENT_COUNT(base->virtual_event_count_max, base->virtual_event_count);
3876 EVBASE_RELEASE_LOCK(base, th_base_lock);
3880 event_base_del_virtual_(struct event_base *base)
3882 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3883 EVUTIL_ASSERT(base->virtual_event_count > 0);
3884 base->virtual_event_count--;
3885 if (base->virtual_event_count == 0 && EVBASE_NEED_NOTIFY(base))
3886 evthread_notify_base(base);
3887 EVBASE_RELEASE_LOCK(base, th_base_lock);
3891 event_free_debug_globals_locks(void)
3893 #ifndef EVENT__DISABLE_THREAD_SUPPORT
3894 #ifndef EVENT__DISABLE_DEBUG_MODE
3895 if (event_debug_map_lock_ != NULL) {
3896 EVTHREAD_FREE_LOCK(event_debug_map_lock_, 0);
3897 event_debug_map_lock_ = NULL;
3898 evthreadimpl_disable_lock_debugging_();
3900 #endif /* EVENT__DISABLE_DEBUG_MODE */
3901 #endif /* EVENT__DISABLE_THREAD_SUPPORT */
3906 event_free_debug_globals(void)
3908 event_free_debug_globals_locks();
3912 event_free_evsig_globals(void)
3914 evsig_free_globals_();
3918 event_free_evutil_globals(void)
3920 evutil_free_globals_();
3924 event_free_globals(void)
3926 event_free_debug_globals();
3927 event_free_evsig_globals();
3928 event_free_evutil_globals();
3932 libevent_global_shutdown(void)
3934 event_disable_debug_mode();
3935 event_free_globals();
3938 #ifndef EVENT__DISABLE_THREAD_SUPPORT
3940 event_global_setup_locks_(const int enable_locks)
3942 #ifndef EVENT__DISABLE_DEBUG_MODE
3943 EVTHREAD_SETUP_GLOBAL_LOCK(event_debug_map_lock_, 0);
3945 if (evsig_global_setup_locks_(enable_locks) < 0)
3947 if (evutil_global_setup_locks_(enable_locks) < 0)
3949 if (evutil_secure_rng_global_setup_locks_(enable_locks) < 0)
3956 event_base_assert_ok_(struct event_base *base)
3958 EVBASE_ACQUIRE_LOCK(base, th_base_lock);
3959 event_base_assert_ok_nolock_(base);
3960 EVBASE_RELEASE_LOCK(base, th_base_lock);
3964 event_base_assert_ok_nolock_(struct event_base *base)
3969 /* First do checks on the per-fd and per-signal lists */
3970 evmap_check_integrity_(base);
3972 /* Check the heap property */
3973 for (i = 1; i < (int)base->timeheap.n; ++i) {
3974 int parent = (i - 1) / 2;
3975 struct event *ev, *p_ev;
3976 ev = base->timeheap.p[i];
3977 p_ev = base->timeheap.p[parent];
3978 EVUTIL_ASSERT(ev->ev_flags & EVLIST_TIMEOUT);
3979 EVUTIL_ASSERT(evutil_timercmp(&p_ev->ev_timeout, &ev->ev_timeout, <=));
3980 EVUTIL_ASSERT(ev->ev_timeout_pos.min_heap_idx == i);
3983 /* Check that the common timeouts are fine */
3984 for (i = 0; i < base->n_common_timeouts; ++i) {
3985 struct common_timeout_list *ctl = base->common_timeout_queues[i];
3986 struct event *last=NULL, *ev;
3988 EVUTIL_ASSERT_TAILQ_OK(&ctl->events, event, ev_timeout_pos.ev_next_with_common_timeout);
3990 TAILQ_FOREACH(ev, &ctl->events, ev_timeout_pos.ev_next_with_common_timeout) {
3992 EVUTIL_ASSERT(evutil_timercmp(&last->ev_timeout, &ev->ev_timeout, <=));
3993 EVUTIL_ASSERT(ev->ev_flags & EVLIST_TIMEOUT);
3994 EVUTIL_ASSERT(is_common_timeout(&ev->ev_timeout,base));
3995 EVUTIL_ASSERT(COMMON_TIMEOUT_IDX(&ev->ev_timeout) == i);
4000 /* Check the active queues. */
4002 for (i = 0; i < base->nactivequeues; ++i) {
4003 struct event_callback *evcb;
4004 EVUTIL_ASSERT_TAILQ_OK(&base->activequeues[i], event_callback, evcb_active_next);
4005 TAILQ_FOREACH(evcb, &base->activequeues[i], evcb_active_next) {
4006 EVUTIL_ASSERT((evcb->evcb_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER)) == EVLIST_ACTIVE);
4007 EVUTIL_ASSERT(evcb->evcb_pri == i);
4013 struct event_callback *evcb;
4014 TAILQ_FOREACH(evcb, &base->active_later_queue, evcb_active_next) {
4015 EVUTIL_ASSERT((evcb->evcb_flags & (EVLIST_ACTIVE|EVLIST_ACTIVE_LATER)) == EVLIST_ACTIVE_LATER);
4019 EVUTIL_ASSERT(count == base->event_count_active);