2 * libev native API header
4 * Copyright (c) 2007,2008 Marc Alexander Lehmann <libev@schmorp.de>
7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met:
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU General Public License ("GPL") version 2 or any later version,
30 * in which case the provisions of the GPL are applicable instead of
31 * the above. If you wish to allow the use of your version of this file
32 * only under the terms of the GPL and not to allow others to use your
33 * version of this file under the BSD license, indicate your decision
34 * by deleting the provisions above and replace them with the notice
35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL.
47 typedef double ev_tstamp;
49 /* these priorities are inclusive, higher priorities will be called earlier */
57 #ifndef EV_MULTIPLICITY
58 # define EV_MULTIPLICITY 1
61 #ifndef EV_PERIODIC_ENABLE
62 # define EV_PERIODIC_ENABLE 1
65 #ifndef EV_STAT_ENABLE
66 # define EV_STAT_ENABLE 1
69 #ifndef EV_IDLE_ENABLE
70 # define EV_IDLE_ENABLE 1
73 #ifndef EV_FORK_ENABLE
74 # define EV_FORK_ENABLE 1
77 #ifndef EV_EMBED_ENABLE
78 # define EV_EMBED_ENABLE 1
81 #ifndef EV_ASYNC_ENABLE
82 # define EV_ASYNC_ENABLE 1
87 # define EV_ATOMIC_T sig_atomic_t volatile
90 /*****************************************************************************/
93 # include <sys/stat.h>
96 /* support multiple event loops? */
99 # define EV_P struct ev_loop *loop
103 # define EV_DEFAULT_UC ev_default_loop_uc ()
104 # define EV_DEFAULT_UC_ EV_DEFAULT_UC,
105 # define EV_DEFAULT ev_default_loop (0)
106 # define EV_DEFAULT_ EV_DEFAULT,
114 # define EV_DEFAULT_UC
115 # define EV_DEFAULT_UC_
116 # undef EV_EMBED_ENABLE
119 #if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
120 # define EV_INLINE static inline
122 # define EV_INLINE static
125 /*****************************************************************************/
127 /* eventmask, revents, events... */
128 #define EV_UNDEF -1 /* guaranteed to be invalid */
129 #define EV_NONE 0x00 /* no events */
130 #define EV_READ 0x01 /* ev_io detected read will not block */
131 #define EV_WRITE 0x02 /* ev_io detected write will not block */
132 #define EV_IOFDSET 0x80 /* internal use only */
133 #define EV_TIMEOUT 0x00000100 /* timer timed out */
134 #define EV_PERIODIC 0x00000200 /* periodic timer timed out */
135 #define EV_SIGNAL 0x00000400 /* signal was received */
136 #define EV_CHILD 0x00000800 /* child/pid had status change */
137 #define EV_STAT 0x00001000 /* stat data changed */
138 #define EV_IDLE 0x00002000 /* event loop is idling */
139 #define EV_PREPARE 0x00004000 /* event loop about to poll */
140 #define EV_CHECK 0x00008000 /* event loop finished poll */
141 #define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
142 #define EV_FORK 0x00020000 /* event loop resumed in child */
143 #define EV_ASYNC 0x00040000 /* async intra-loop signal */
144 #define EV_ERROR 0x80000000 /* sent when an error occurs */
146 /* can be used to add custom fields to all watchers, while losing binary compatibility */
148 # define EV_COMMON void *data;
150 #ifndef EV_PROTOTYPES
151 # define EV_PROTOTYPES 1
154 #define EV_VERSION_MAJOR 3
155 #define EV_VERSION_MINOR 0
157 #ifndef EV_CB_DECLARE
158 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
161 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
165 * struct member types:
166 * private: you can look at them, but not change them, and they might not mean anything to you.
167 * ro: can be read anytime, but only changed when the watcher isn't active
168 * rw: can be read and modified anytime, even when the watcher is active
170 * some internal details that might be helpful for debugging:
172 * active is either 0, which means the watcher is not active,
173 * or the array index of the watcher (periodics, timers)
174 * or the array index + 1 (most other watchers)
175 * or simply 1 for watchers that aren't in some array.
176 * pending is either 0, in which case the watcher isn't,
177 * or the array index + 1 in the pendings array.
180 /* shared by all watchers */
181 #define EV_WATCHER(type) \
182 int active; /* private */ \
183 int pending; /* private */ \
184 int priority; /* private */ \
186 EV_CB_DECLARE (type) /* private */
188 #define EV_WATCHER_LIST(type) \
190 struct ev_watcher_list *next; /* private */
192 #define EV_WATCHER_TIME(type) \
194 ev_tstamp at; /* private */
196 /* base class, nothing to see here unless you subclass */
197 typedef struct ev_watcher
199 EV_WATCHER (ev_watcher)
202 /* base class, nothing to see here unless you subclass */
203 typedef struct ev_watcher_list
205 EV_WATCHER_LIST (ev_watcher_list)
208 /* base class, nothing to see here unless you subclass */
209 typedef struct ev_watcher_time
211 EV_WATCHER_TIME (ev_watcher_time)
214 /* invoked when fd is either EV_READable or EV_WRITEable */
215 /* revent EV_READ, EV_WRITE */
218 EV_WATCHER_LIST (ev_io)
224 /* invoked after a specific time, repeatable (based on monotonic clock) */
225 /* revent EV_TIMEOUT */
226 typedef struct ev_timer
228 EV_WATCHER_TIME (ev_timer)
230 ev_tstamp repeat; /* rw */
233 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
234 /* revent EV_PERIODIC */
235 typedef struct ev_periodic
237 EV_WATCHER_TIME (ev_periodic)
239 ev_tstamp offset; /* rw */
240 ev_tstamp interval; /* rw */
241 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
244 /* invoked when the given signal has been received */
245 /* revent EV_SIGNAL */
246 typedef struct ev_signal
248 EV_WATCHER_LIST (ev_signal)
253 /* invoked when sigchld is received and waitpid indicates the given pid */
254 /* revent EV_CHILD */
255 /* does not support priorities */
256 typedef struct ev_child
258 EV_WATCHER_LIST (ev_child)
260 int flags; /* private */
262 int rpid; /* rw, holds the received pid */
263 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
267 /* st_nlink = 0 means missing file or other error */
269 typedef struct _stati64 ev_statdata;
271 typedef struct stat ev_statdata;
274 /* invoked each time the stat data changes for a given path */
276 typedef struct ev_stat
278 EV_WATCHER_LIST (ev_stat)
280 ev_timer timer; /* private */
281 ev_tstamp interval; /* ro */
282 const char *path; /* ro */
283 ev_statdata prev; /* ro */
284 ev_statdata attr; /* ro */
286 int wd; /* wd for inotify, fd for kqueue */
291 /* invoked when the nothing else needs to be done, keeps the process from blocking */
293 typedef struct ev_idle
299 /* invoked for each run of the mainloop, just before the blocking call */
300 /* you can still change events in any way you like */
301 /* revent EV_PREPARE */
302 typedef struct ev_prepare
304 EV_WATCHER (ev_prepare)
307 /* invoked for each run of the mainloop, just after the blocking call */
308 /* revent EV_CHECK */
309 typedef struct ev_check
311 EV_WATCHER (ev_check)
315 /* the callback gets invoked before check in the child process when a fork was detected */
316 typedef struct ev_fork
323 /* used to embed an event loop inside another */
324 /* the callback gets invoked when the event loop has handled events, and can be 0 */
325 typedef struct ev_embed
327 EV_WATCHER (ev_embed)
329 struct ev_loop *other; /* ro */
330 ev_io io; /* private */
331 ev_prepare prepare; /* private */
332 ev_check check; /* unused */
333 ev_timer timer; /* unused */
334 ev_periodic periodic; /* unused */
335 ev_idle idle; /* unused */
336 ev_fork fork; /* unused */
341 /* invoked when somebody calls ev_async_send on the watcher */
342 /* revent EV_ASYNC */
343 typedef struct ev_async
345 EV_WATCHER (ev_async)
347 EV_ATOMIC_T sent; /* private */
350 # define ev_async_pending(w) ((w)->sent + 0)
353 /* the presence of this union forces similar struct layout */
357 struct ev_watcher_list wl;
360 struct ev_timer timer;
361 struct ev_periodic periodic;
362 struct ev_signal signal;
363 struct ev_child child;
370 struct ev_prepare prepare;
371 struct ev_check check;
376 struct ev_embed embed;
379 struct ev_async async;
383 /* bits for ev_default_loop and ev_loop_new */
385 #define EVFLAG_AUTO 0x00000000U /* not quite a mask */
387 #define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
388 #define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
389 /* method bits to be ored together */
390 #define EVBACKEND_SELECT 0x00000001U /* about anywhere */
391 #define EVBACKEND_POLL 0x00000002U /* !win */
392 #define EVBACKEND_EPOLL 0x00000004U /* linux */
393 #define EVBACKEND_KQUEUE 0x00000008U /* bsd */
394 #define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
395 #define EVBACKEND_PORT 0x00000020U /* solaris 10 */
398 int ev_version_major (void);
399 int ev_version_minor (void);
401 unsigned int ev_supported_backends (void);
402 unsigned int ev_recommended_backends (void);
403 unsigned int ev_embeddable_backends (void);
405 ev_tstamp ev_time (void);
406 void ev_sleep (ev_tstamp delay); /* sleep for a while */
408 /* Sets the allocation function to use, works like realloc.
409 * It is used to allocate and free memory.
410 * If it returns zero when memory needs to be allocated, the library might abort
411 * or take some potentially destructive action.
412 * The default is your system realloc function.
414 void ev_set_allocator (void *(*cb)(void *ptr, long size));
416 /* set the callback function to call on a
417 * retryable syscall error
418 * (such as failed select, poll, epoll_wait)
420 void ev_set_syserr_cb (void (*cb)(const char *msg));
423 EV_INLINE struct ev_loop *
424 ev_default_loop_uc (void)
426 extern struct ev_loop *ev_default_loop_ptr;
428 return ev_default_loop_ptr;
431 /* the default loop is the only one that handles signals and child watchers */
432 /* you can call this as often as you like */
433 EV_INLINE struct ev_loop *
434 ev_default_loop (unsigned int flags)
436 struct ev_loop *loop = ev_default_loop_uc ();
440 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
442 loop = ev_default_loop_init (flags);
448 /* create and destroy alternative loops that don't handle signals */
449 struct ev_loop *ev_loop_new (unsigned int flags);
450 void ev_loop_destroy (EV_P);
451 void ev_loop_fork (EV_P);
452 void ev_loop_verify (EV_P);
454 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
458 int ev_default_loop (unsigned int flags); /* returns true when successful */
463 extern ev_tstamp ev_rt_now;
467 #endif /* multiplicity */
470 ev_is_default_loop (EV_P)
473 extern struct ev_loop *ev_default_loop_ptr;
475 return !!(EV_A == ev_default_loop_ptr);
481 void ev_default_destroy (void); /* destroy the default loop */
482 /* this needs to be called after fork, to duplicate the default loop */
483 /* if you create alternative loops you have to call ev_loop_fork on them */
484 /* you can call it in either the parent or the child */
485 /* you can actually call it at any time, anywhere :) */
486 void ev_default_fork (void);
488 unsigned int ev_backend (EV_P); /* backend in use by loop */
489 unsigned int ev_loop_count (EV_P); /* number of loop iterations */
490 #endif /* prototypes */
492 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
493 #define EVLOOP_ONESHOT 2 /* block *once* only */
494 #define EVUNLOOP_CANCEL 0 /* undo unloop */
495 #define EVUNLOOP_ONE 1 /* unloop once */
496 #define EVUNLOOP_ALL 2 /* unloop all loops */
499 void ev_loop (EV_P_ int flags);
500 void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
502 void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
503 void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
506 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
507 * keeps one reference. if you have a long-runing watcher you never unregister that
508 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
511 void ev_unref (EV_P);
513 /* convinience function, wait for a single event, without registering an event watcher */
514 /* if timeout is < 0, do wait indefinitely */
515 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
518 /* these may evaluate ev multiple times, and the other arguments at most once */
519 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
520 #define ev_init(ev,cb_) do { \
521 ((ev_watcher *)(void *)(ev))->active = \
522 ((ev_watcher *)(void *)(ev))->pending = \
523 ((ev_watcher *)(void *)(ev))->priority = 0; \
524 ev_set_cb ((ev), cb_); \
527 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
528 #define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
529 #define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
530 #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
531 #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
532 #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
533 #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
534 #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
535 #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
536 #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
537 #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
538 #define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
540 #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
541 #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
542 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
543 #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
544 #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
545 #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
546 #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
547 #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
548 #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
549 #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
550 #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
551 #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
553 #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
554 #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
556 #define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
557 #define ev_cb(ev) (ev)->cb /* rw */
558 #define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
560 #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
563 # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
566 /* stopping (enabling, adding) a watcher does nothing if it is already running */
567 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
570 /* feeds an event into a watcher as if the event actually occured */
571 /* accepts any ev_watcher type */
572 void ev_feed_event (EV_P_ void *w, int revents);
573 void ev_feed_fd_event (EV_P_ int fd, int revents);
574 void ev_feed_signal_event (EV_P_ int signum);
575 void ev_invoke (EV_P_ void *w, int revents);
576 int ev_clear_pending (EV_P_ void *w);
578 void ev_io_start (EV_P_ ev_io *w);
579 void ev_io_stop (EV_P_ ev_io *w);
581 void ev_timer_start (EV_P_ ev_timer *w);
582 void ev_timer_stop (EV_P_ ev_timer *w);
583 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
584 void ev_timer_again (EV_P_ ev_timer *w);
586 #if EV_PERIODIC_ENABLE
587 void ev_periodic_start (EV_P_ ev_periodic *w);
588 void ev_periodic_stop (EV_P_ ev_periodic *w);
589 void ev_periodic_again (EV_P_ ev_periodic *w);
592 /* only supported in the default loop */
593 void ev_signal_start (EV_P_ ev_signal *w);
594 void ev_signal_stop (EV_P_ ev_signal *w);
596 /* only supported in the default loop */
597 void ev_child_start (EV_P_ ev_child *w);
598 void ev_child_stop (EV_P_ ev_child *w);
601 void ev_stat_start (EV_P_ ev_stat *w);
602 void ev_stat_stop (EV_P_ ev_stat *w);
603 void ev_stat_stat (EV_P_ ev_stat *w);
607 void ev_idle_start (EV_P_ ev_idle *w);
608 void ev_idle_stop (EV_P_ ev_idle *w);
611 void ev_prepare_start (EV_P_ ev_prepare *w);
612 void ev_prepare_stop (EV_P_ ev_prepare *w);
614 void ev_check_start (EV_P_ ev_check *w);
615 void ev_check_stop (EV_P_ ev_check *w);
618 void ev_fork_start (EV_P_ ev_fork *w);
619 void ev_fork_stop (EV_P_ ev_fork *w);
623 /* only supported when loop to be embedded is in fact embeddable */
624 void ev_embed_start (EV_P_ ev_embed *w);
625 void ev_embed_stop (EV_P_ ev_embed *w);
626 void ev_embed_sweep (EV_P_ ev_embed *w);
630 void ev_async_start (EV_P_ ev_async *w);
631 void ev_async_stop (EV_P_ ev_async *w);
632 void ev_async_send (EV_P_ ev_async *w);