2 * libev event processing core, watcher management
4 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46 #include <sys/types.h>
48 # include <sys/wait.h>
55 #ifndef EV_USE_MONOTONIC
56 # define EV_USE_MONOTONIC 1
60 # define EV_USE_SELECT 1
64 # define EV_USE_POLL 0 /* poll is usually slower than select, and not as well tested */
68 # define EV_USE_EPOLL 0
72 # define EV_USE_KQUEUE 0
75 #ifndef EV_USE_REALTIME
76 # define EV_USE_REALTIME 1
81 #ifndef CLOCK_MONOTONIC
82 # undef EV_USE_MONOTONIC
83 # define EV_USE_MONOTONIC 0
86 #ifndef CLOCK_REALTIME
87 # undef EV_USE_REALTIME
88 # define EV_USE_REALTIME 0
93 #define MIN_TIMEJUMP 1. /* minimum timejump that gets detected (if monotonic clock available) */
94 #define MAX_BLOCKTIME 59.731 /* never wait longer than this time (to detect time jumps) */
95 #define PID_HASHSIZE 16 /* size of pid hash table, must be power of two */
96 /*#define CLEANUP_INTERVAL 300. /* how often to try to free memory and re-check fds */
101 # define expect(expr,value) __builtin_expect ((expr),(value))
102 # define inline inline
104 # define expect(expr,value) (expr)
105 # define inline static
108 #define expect_false(expr) expect ((expr) != 0, 0)
109 #define expect_true(expr) expect ((expr) != 0, 1)
111 #define NUMPRI (EV_MAXPRI - EV_MINPRI + 1)
112 #define ABSPRI(w) ((w)->priority - EV_MINPRI)
114 typedef struct ev_watcher *W;
115 typedef struct ev_watcher_list *WL;
116 typedef struct ev_watcher_time *WT;
118 static ev_tstamp now_floor, now, diff; /* monotonic clock */
122 static int have_monotonic; /* runtime */
124 static ev_tstamp method_fudge; /* stupid epoll-returns-early bug */
125 static void (*method_modify)(int fd, int oev, int nev);
126 static void (*method_poll)(ev_tstamp timeout);
128 /*****************************************************************************/
135 clock_gettime (CLOCK_REALTIME, &ts);
136 return ts.tv_sec + ts.tv_nsec * 1e-9;
139 gettimeofday (&tv, 0);
140 return tv.tv_sec + tv.tv_usec * 1e-6;
148 if (expect_true (have_monotonic))
151 clock_gettime (CLOCK_MONOTONIC, &ts);
152 return ts.tv_sec + ts.tv_nsec * 1e-9;
159 #define array_roundsize(base,n) ((n) | 4 & ~3)
161 #define array_needsize(base,cur,cnt,init) \
162 if (expect_false ((cnt) > cur)) \
167 newcnt = array_roundsize (base, newcnt << 1); \
169 while ((cnt) > newcnt); \
171 base = realloc (base, sizeof (*base) * (newcnt)); \
172 init (base + cur, newcnt - cur); \
176 /*****************************************************************************/
181 unsigned char events;
189 anfds_init (ANFD *base, int count)
194 base->events = EV_NONE;
207 static ANPENDING *pendings [NUMPRI];
208 static int pendingmax [NUMPRI], pendingcnt [NUMPRI];
211 event (W w, int events)
215 pendings [ABSPRI (w)][w->pending - 1].events |= events;
219 w->pending = ++pendingcnt [ABSPRI (w)];
220 array_needsize (pendings [ABSPRI (w)], pendingmax [ABSPRI (w)], pendingcnt [ABSPRI (w)], );
221 pendings [ABSPRI (w)][w->pending - 1].w = w;
222 pendings [ABSPRI (w)][w->pending - 1].events = events;
226 queue_events (W *events, int eventcnt, int type)
230 for (i = 0; i < eventcnt; ++i)
231 event (events [i], type);
235 fd_event (int fd, int events)
237 ANFD *anfd = anfds + fd;
240 for (w = anfd->head; w; w = w->next)
242 int ev = w->events & events;
249 /*****************************************************************************/
251 static int *fdchanges;
252 static int fdchangemax, fdchangecnt;
259 for (i = 0; i < fdchangecnt; ++i)
261 int fd = fdchanges [i];
262 ANFD *anfd = anfds + fd;
267 for (w = anfd->head; w; w = w->next)
272 if (anfd->events != events)
274 method_modify (fd, anfd->events, events);
275 anfd->events = events;
285 if (anfds [fd].reify || fdchangecnt < 0)
288 anfds [fd].reify = 1;
291 array_needsize (fdchanges, fdchangemax, fdchangecnt, );
292 fdchanges [fdchangecnt - 1] = fd;
300 printf ("killing fd %d\n", fd);//D
301 while ((w = anfds [fd].head))
304 event ((W)w, EV_ERROR | EV_READ | EV_WRITE);
308 /* called on EBADF to verify fds */
314 for (fd = 0; fd < anfdmax; ++fd)
315 if (anfds [fd].events)
316 if (fcntl (fd, F_GETFD) == -1 && errno == EBADF)
320 /* called on ENOMEM in select/poll to kill some fds and retry */
327 if (anfds [fd].events)
335 /*****************************************************************************/
337 static struct ev_timer **timers;
338 static int timermax, timercnt;
340 static struct ev_periodic **periodics;
341 static int periodicmax, periodiccnt;
344 upheap (WT *timers, int k)
348 while (k && timers [k >> 1]->at > w->at)
350 timers [k] = timers [k >> 1];
351 timers [k]->active = k + 1;
356 timers [k]->active = k + 1;
361 downheap (WT *timers, int N, int k)
369 if (j + 1 < N && timers [j]->at > timers [j + 1]->at)
372 if (w->at <= timers [j]->at)
375 timers [k] = timers [j];
376 timers [k]->active = k + 1;
381 timers [k]->active = k + 1;
384 /*****************************************************************************/
388 struct ev_signal *head;
389 sig_atomic_t volatile gotsig;
392 static ANSIG *signals;
393 static int signalmax;
395 static int sigpipe [2];
396 static sig_atomic_t volatile gotsig;
397 static struct ev_io sigev;
400 signals_init (ANSIG *base, int count)
412 sighandler (int signum)
414 signals [signum - 1].gotsig = 1;
419 write (sigpipe [1], &signum, 1);
424 sigcb (struct ev_io *iow, int revents)
429 read (sigpipe [0], &revents, 1);
432 for (signum = signalmax; signum--; )
433 if (signals [signum].gotsig)
435 signals [signum].gotsig = 0;
437 for (w = signals [signum].head; w; w = w->next)
438 event ((W)w, EV_SIGNAL);
446 fcntl (sigpipe [0], F_SETFD, FD_CLOEXEC);
447 fcntl (sigpipe [1], F_SETFD, FD_CLOEXEC);
449 /* rather than sort out wether we really need nb, set it */
450 fcntl (sigpipe [0], F_SETFL, O_NONBLOCK);
451 fcntl (sigpipe [1], F_SETFL, O_NONBLOCK);
454 ev_io_set (&sigev, sigpipe [0], EV_READ);
455 ev_io_start (&sigev);
458 /*****************************************************************************/
460 static struct ev_idle **idles;
461 static int idlemax, idlecnt;
463 static struct ev_prepare **prepares;
464 static int preparemax, preparecnt;
466 static struct ev_check **checks;
467 static int checkmax, checkcnt;
469 /*****************************************************************************/
471 static struct ev_child *childs [PID_HASHSIZE];
472 static struct ev_signal childev;
477 # define WCONTINUED 0
481 child_reap (struct ev_signal *sw, int chain, int pid, int status)
485 for (w = childs [chain & (PID_HASHSIZE - 1)]; w; w = w->next)
486 if (w->pid == pid || !w->pid)
488 w->priority = sw->priority; /* need to do it *now* */
491 printf ("rpid %p %d %d\n", w, pid, w->pid);//D
492 event ((W)w, EV_CHILD);
497 childcb (struct ev_signal *sw, int revents)
501 printf ("chld %x\n", revents);//D
502 if (0 < (pid = waitpid (-1, &status, WNOHANG | WUNTRACED | WCONTINUED)))
504 /* make sure we are called again until all childs have been reaped */
505 event ((W)sw, EV_SIGNAL);
507 child_reap (sw, pid, pid, status);
508 child_reap (sw, 0, pid, status); /* this might trigger a watcher twice, but event catches that */
514 /*****************************************************************************/
517 # include "ev_kqueue.c"
520 # include "ev_epoll.c"
523 # include "ev_poll.c"
526 # include "ev_select.c"
530 ev_version_major (void)
532 return EV_VERSION_MAJOR;
536 ev_version_minor (void)
538 return EV_VERSION_MINOR;
541 /* return true if we are running with elevated privileges and ignore env variables */
545 return getuid () != geteuid ()
546 || getgid () != getegid ();
549 int ev_init (int methods)
556 if (!clock_gettime (CLOCK_MONOTONIC, &ts))
569 if (methods == EVMETHOD_AUTO)
570 if (!enable_secure () && getenv ("LIBEV_METHODS"))
571 methods = atoi (getenv ("LIBEV_METHODS"));
573 methods = EVMETHOD_ANY;
577 if (!ev_method && (methods & EVMETHOD_KQUEUE)) kqueue_init (methods);
580 if (!ev_method && (methods & EVMETHOD_EPOLL )) epoll_init (methods);
583 if (!ev_method && (methods & EVMETHOD_POLL )) poll_init (methods);
586 if (!ev_method && (methods & EVMETHOD_SELECT)) select_init (methods);
591 ev_watcher_init (&sigev, sigcb);
592 ev_set_priority (&sigev, EV_MAXPRI);
596 ev_signal_init (&childev, childcb, SIGCHLD);
597 ev_set_priority (&childev, EV_MAXPRI);
598 ev_signal_start (&childev);
606 /*****************************************************************************/
609 ev_fork_prepare (void)
615 ev_fork_parent (void)
624 if (ev_method == EVMETHOD_EPOLL)
625 epoll_postfork_child ();
635 /*****************************************************************************/
642 for (pri = NUMPRI; pri--; )
643 while (pendingcnt [pri])
645 ANPENDING *p = pendings [pri] + --pendingcnt [pri];
650 p->w->cb (p->w, p->events);
658 while (timercnt && timers [0]->at <= now)
660 struct ev_timer *w = timers [0];
662 /* first reschedule or stop timer */
665 assert (("negative ev_timer repeat value found while processing timers", w->repeat > 0.));
666 w->at = now + w->repeat;
667 downheap ((WT *)timers, timercnt, 0);
670 ev_timer_stop (w); /* nonrepeating: stop timer */
672 event ((W)w, EV_TIMEOUT);
677 periodics_reify (void)
679 while (periodiccnt && periodics [0]->at <= ev_now)
681 struct ev_periodic *w = periodics [0];
683 /* first reschedule or stop timer */
686 w->at += floor ((ev_now - w->at) / w->interval + 1.) * w->interval;
687 assert (("ev_periodic timeout in the past detected while processing timers, negative interval?", w->at > ev_now));
688 downheap ((WT *)periodics, periodiccnt, 0);
691 ev_periodic_stop (w); /* nonrepeating: stop timer */
693 event ((W)w, EV_PERIODIC);
698 periodics_reschedule (ev_tstamp diff)
702 /* adjust periodics after time jump */
703 for (i = 0; i < periodiccnt; ++i)
705 struct ev_periodic *w = periodics [i];
709 ev_tstamp diff = ceil ((ev_now - w->at) / w->interval) * w->interval;
711 if (fabs (diff) >= 1e-4)
713 ev_periodic_stop (w);
714 ev_periodic_start (w);
716 i = 0; /* restart loop, inefficient, but time jumps should be rare */
723 time_update_monotonic (void)
727 if (expect_true (now - now_floor < MIN_TIMEJUMP * .5))
746 if (expect_true (have_monotonic))
748 if (time_update_monotonic ())
750 ev_tstamp odiff = diff;
752 for (i = 4; --i; ) /* loop a few times, before making important decisions */
756 if (fabs (odiff - diff) < MIN_TIMEJUMP)
757 return; /* all is well */
764 periodics_reschedule (diff - odiff);
765 /* no timer adjustment, as the monotonic clock doesn't jump */
773 if (expect_false (now > ev_now || now < ev_now - MAX_BLOCKTIME - MIN_TIMEJUMP))
775 periodics_reschedule (ev_now - now);
777 /* adjust timers. this is easy, as the offset is the same for all */
778 for (i = 0; i < timercnt; ++i)
779 timers [i]->at += diff;
788 void ev_loop (int flags)
791 ev_loop_done = flags & (EVLOOP_ONESHOT | EVLOOP_NONBLOCK) ? 1 : 0;
795 /* queue check watchers (and execute them) */
796 if (expect_false (preparecnt))
798 queue_events ((W *)prepares, preparecnt, EV_PREPARE);
802 /* update fd-related kernel structures */
805 /* calculate blocking time */
807 /* we only need this for !monotonic clockor timers, but as we basically
808 always have timers, we just calculate it always */
810 if (expect_true (have_monotonic))
811 time_update_monotonic ();
819 if (flags & EVLOOP_NONBLOCK || idlecnt)
823 block = MAX_BLOCKTIME;
827 ev_tstamp to = timers [0]->at - now + method_fudge;
828 if (block > to) block = to;
833 ev_tstamp to = periodics [0]->at - ev_now + method_fudge;
834 if (block > to) block = to;
837 if (block < 0.) block = 0.;
842 /* update ev_now, do magic */
845 /* queue pending timers and reschedule them */
846 timers_reify (); /* relative timers called last */
847 periodics_reify (); /* absolute timers called first */
849 /* queue idle watchers unless io or timers are pending */
851 queue_events ((W *)idles, idlecnt, EV_IDLE);
853 /* queue check watchers, to be executed first */
855 queue_events ((W *)checks, checkcnt, EV_CHECK);
859 while (!ev_loop_done);
861 if (ev_loop_done != 2)
865 /*****************************************************************************/
868 wlist_add (WL *head, WL elem)
875 wlist_del (WL *head, WL elem)
885 head = &(*head)->next;
890 ev_clear_pending (W w)
894 pendings [ABSPRI (w)][w->pending - 1].w = 0;
900 ev_start (W w, int active)
902 if (w->priority < EV_MINPRI) w->priority = EV_MINPRI;
903 if (w->priority > EV_MAXPRI) w->priority = EV_MAXPRI;
914 /*****************************************************************************/
917 ev_io_start (struct ev_io *w)
921 if (ev_is_active (w))
924 assert (("ev_io_start called with negative fd", fd >= 0));
927 array_needsize (anfds, anfdmax, fd + 1, anfds_init);
928 wlist_add ((WL *)&anfds[fd].head, (WL)w);
934 ev_io_stop (struct ev_io *w)
936 ev_clear_pending ((W)w);
937 if (!ev_is_active (w))
940 wlist_del ((WL *)&anfds[w->fd].head, (WL)w);
947 ev_timer_start (struct ev_timer *w)
949 if (ev_is_active (w))
954 assert (("ev_timer_start called with negative timer repeat value", w->repeat >= 0.));
956 ev_start ((W)w, ++timercnt);
957 array_needsize (timers, timermax, timercnt, );
958 timers [timercnt - 1] = w;
959 upheap ((WT *)timers, timercnt - 1);
963 ev_timer_stop (struct ev_timer *w)
965 ev_clear_pending ((W)w);
966 if (!ev_is_active (w))
969 if (w->active < timercnt--)
971 timers [w->active - 1] = timers [timercnt];
972 downheap ((WT *)timers, timercnt, w->active - 1);
981 ev_timer_again (struct ev_timer *w)
983 if (ev_is_active (w))
987 w->at = now + w->repeat;
988 downheap ((WT *)timers, timercnt, w->active - 1);
998 ev_periodic_start (struct ev_periodic *w)
1000 if (ev_is_active (w))
1003 assert (("ev_periodic_start called with negative interval value", w->interval >= 0.));
1005 /* this formula differs from the one in periodic_reify because we do not always round up */
1007 w->at += ceil ((ev_now - w->at) / w->interval) * w->interval;
1009 ev_start ((W)w, ++periodiccnt);
1010 array_needsize (periodics, periodicmax, periodiccnt, );
1011 periodics [periodiccnt - 1] = w;
1012 upheap ((WT *)periodics, periodiccnt - 1);
1016 ev_periodic_stop (struct ev_periodic *w)
1018 ev_clear_pending ((W)w);
1019 if (!ev_is_active (w))
1022 if (w->active < periodiccnt--)
1024 periodics [w->active - 1] = periodics [periodiccnt];
1025 downheap ((WT *)periodics, periodiccnt, w->active - 1);
1032 # define SA_RESTART 0
1036 ev_signal_start (struct ev_signal *w)
1038 if (ev_is_active (w))
1041 assert (("ev_signal_start called with illegal signal number", w->signum > 0));
1044 array_needsize (signals, signalmax, w->signum, signals_init);
1045 wlist_add ((WL *)&signals [w->signum - 1].head, (WL)w);
1049 struct sigaction sa;
1050 sa.sa_handler = sighandler;
1051 sigfillset (&sa.sa_mask);
1052 sa.sa_flags = SA_RESTART; /* if restarting works we save one iteration */
1053 sigaction (w->signum, &sa, 0);
1058 ev_signal_stop (struct ev_signal *w)
1060 ev_clear_pending ((W)w);
1061 if (!ev_is_active (w))
1064 wlist_del ((WL *)&signals [w->signum - 1].head, (WL)w);
1067 if (!signals [w->signum - 1].head)
1068 signal (w->signum, SIG_DFL);
1072 ev_idle_start (struct ev_idle *w)
1074 if (ev_is_active (w))
1077 ev_start ((W)w, ++idlecnt);
1078 array_needsize (idles, idlemax, idlecnt, );
1079 idles [idlecnt - 1] = w;
1083 ev_idle_stop (struct ev_idle *w)
1085 ev_clear_pending ((W)w);
1086 if (ev_is_active (w))
1089 idles [w->active - 1] = idles [--idlecnt];
1094 ev_prepare_start (struct ev_prepare *w)
1096 if (ev_is_active (w))
1099 ev_start ((W)w, ++preparecnt);
1100 array_needsize (prepares, preparemax, preparecnt, );
1101 prepares [preparecnt - 1] = w;
1105 ev_prepare_stop (struct ev_prepare *w)
1107 ev_clear_pending ((W)w);
1108 if (ev_is_active (w))
1111 prepares [w->active - 1] = prepares [--preparecnt];
1116 ev_check_start (struct ev_check *w)
1118 if (ev_is_active (w))
1121 ev_start ((W)w, ++checkcnt);
1122 array_needsize (checks, checkmax, checkcnt, );
1123 checks [checkcnt - 1] = w;
1127 ev_check_stop (struct ev_check *w)
1129 ev_clear_pending ((W)w);
1130 if (ev_is_active (w))
1133 checks [w->active - 1] = checks [--checkcnt];
1138 ev_child_start (struct ev_child *w)
1140 if (ev_is_active (w))
1144 wlist_add ((WL *)&childs [w->pid & (PID_HASHSIZE - 1)], (WL)w);
1148 ev_child_stop (struct ev_child *w)
1150 ev_clear_pending ((W)w);
1151 if (ev_is_active (w))
1154 wlist_del ((WL *)&childs [w->pid & (PID_HASHSIZE - 1)], (WL)w);
1158 /*****************************************************************************/
1164 void (*cb)(int revents, void *arg);
1169 once_cb (struct ev_once *once, int revents)
1171 void (*cb)(int revents, void *arg) = once->cb;
1172 void *arg = once->arg;
1174 ev_io_stop (&once->io);
1175 ev_timer_stop (&once->to);
1182 once_cb_io (struct ev_io *w, int revents)
1184 once_cb ((struct ev_once *)(((char *)w) - offsetof (struct ev_once, io)), revents);
1188 once_cb_to (struct ev_timer *w, int revents)
1190 once_cb ((struct ev_once *)(((char *)w) - offsetof (struct ev_once, to)), revents);
1194 ev_once (int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg)
1196 struct ev_once *once = malloc (sizeof (struct ev_once));
1199 cb (EV_ERROR | EV_READ | EV_WRITE | EV_TIMEOUT, arg);
1205 ev_watcher_init (&once->io, once_cb_io);
1208 ev_io_set (&once->io, fd, events);
1209 ev_io_start (&once->io);
1212 ev_watcher_init (&once->to, once_cb_to);
1215 ev_timer_set (&once->to, timeout, 0.);
1216 ev_timer_start (&once->to);
1221 /*****************************************************************************/
1228 sin_cb (struct ev_io *w, int revents)
1230 fprintf (stderr, "sin %d, revents %d\n", w->fd, revents);
1234 ocb (struct ev_timer *w, int revents)
1236 //fprintf (stderr, "timer %f,%f (%x) (%f) d%p\n", w->at, w->repeat, revents, w->at - ev_time (), w->data);
1242 scb (struct ev_signal *w, int revents)
1244 fprintf (stderr, "signal %x,%d\n", revents, w->signum);
1250 gcb (struct ev_signal *w, int revents)
1252 fprintf (stderr, "generic %x\n", revents);
1260 ev_io_init (&wio, sin_cb, 0, EV_READ);
1263 struct ev_timer t[10000];
1267 for (i = 0; i < 10000; ++i)
1269 struct ev_timer *w = t + i;
1270 ev_watcher_init (w, ocb, i);
1271 ev_timer_init_abs (w, ocb, drand48 (), 0.99775533);
1273 if (drand48 () < 0.5)
1279 ev_timer_init (&t1, ocb, 5, 10);
1280 ev_timer_start (&t1);
1282 struct ev_signal sig;
1283 ev_signal_init (&sig, scb, SIGQUIT);
1284 ev_signal_start (&sig);
1287 ev_check_init (&cw, gcb);
1288 ev_check_start (&cw);
1291 ev_idle_init (&iw, gcb);
1292 ev_idle_start (&iw);