--- libev/ev.h 2007/11/29 17:28:13 1.76 +++ libev/ev.h 2008/09/29 03:31:14 1.106 @@ -1,30 +1,40 @@ /* - * Copyright (c) 2007 Marc Alexander Lehmann - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are - * met: + * libev native API header * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. + * Copyright (c) 2007,2008 Marc Alexander Lehmann + * All rights reserved. * - * * Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following - * disclaimer in the documentation and/or other materials provided - * with the distribution. + * Redistribution and use in source and binary forms, with or without modifica- + * tion, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER- + * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO + * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE- + * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; + * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH- + * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * Alternatively, the contents of this file may be used under the terms of + * the GNU General Public License ("GPL") version 2 or any later version, + * in which case the provisions of the GPL are applicable instead of + * the above. If you wish to allow the use of your version of this file + * only under the terms of the GPL and not to allow others to use your + * version of this file under the BSD license, indicate your decision + * by deleting the provisions above and replace them with the notice + * and other provisions required by the GPL. If you do not delete the + * provisions above, a recipient may use your version of this file under + * either the BSD or the GPL. */ #ifndef EV_H__ @@ -56,6 +66,10 @@ # define EV_STAT_ENABLE 1 #endif +#ifndef EV_IDLE_ENABLE +# define EV_IDLE_ENABLE 1 +#endif + #ifndef EV_FORK_ENABLE # define EV_FORK_ENABLE 1 #endif @@ -64,9 +78,22 @@ # define EV_EMBED_ENABLE 1 #endif +#ifndef EV_ASYNC_ENABLE +# define EV_ASYNC_ENABLE 1 +#endif + +#ifndef EV_ATOMIC_T +# include +# define EV_ATOMIC_T sig_atomic_t volatile +#endif + /*****************************************************************************/ #if EV_STAT_ENABLE +# ifdef _WIN32 +# include +# include +# endif # include #endif @@ -77,6 +104,8 @@ # define EV_P_ EV_P, # define EV_A loop # define EV_A_ EV_A, +# define EV_DEFAULT_UC ev_default_loop_uc () +# define EV_DEFAULT_UC_ EV_DEFAULT_UC, # define EV_DEFAULT ev_default_loop (0) # define EV_DEFAULT_ EV_DEFAULT, #else @@ -86,26 +115,37 @@ # define EV_A_ # define EV_DEFAULT # define EV_DEFAULT_ - +# define EV_DEFAULT_UC +# define EV_DEFAULT_UC_ # undef EV_EMBED_ENABLE #endif +#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 +# define EV_INLINE static inline +#else +# define EV_INLINE static +#endif + +/*****************************************************************************/ + /* eventmask, revents, events... */ -#define EV_UNDEF -1L /* guaranteed to be invalid */ -#define EV_NONE 0x00L /* no events */ -#define EV_READ 0x01L /* ev_io detected read will not block */ -#define EV_WRITE 0x02L /* ev_io detected write will not block */ -#define EV_TIMEOUT 0x00000100L /* timer timed out */ -#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ -#define EV_SIGNAL 0x00000400L /* signal was received */ -#define EV_CHILD 0x00000800L /* child/pid had status change */ -#define EV_STAT 0x00001000L /* stat data changed */ -#define EV_IDLE 0x00002000L /* event loop is idling */ -#define EV_PREPARE 0x00004000L /* event loop about to poll */ -#define EV_CHECK 0x00008000L /* event loop finished poll */ -#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ -#define EV_FORK 0x00020000L /* event loop resumed in child */ -#define EV_ERROR 0x80000000L /* sent when an error occurs */ +#define EV_UNDEF -1 /* guaranteed to be invalid */ +#define EV_NONE 0x00 /* no events */ +#define EV_READ 0x01 /* ev_io detected read will not block */ +#define EV_WRITE 0x02 /* ev_io detected write will not block */ +#define EV_IOFDSET 0x80 /* internal use only */ +#define EV_TIMEOUT 0x00000100 /* timer timed out */ +#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ +#define EV_SIGNAL 0x00000400 /* signal was received */ +#define EV_CHILD 0x00000800 /* child/pid had status change */ +#define EV_STAT 0x00001000 /* stat data changed */ +#define EV_IDLE 0x00002000 /* event loop is idling */ +#define EV_PREPARE 0x00004000 /* event loop about to poll */ +#define EV_CHECK 0x00008000 /* event loop finished poll */ +#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ +#define EV_FORK 0x00020000 /* event loop resumed in child */ +#define EV_ASYNC 0x00040000 /* async intra-loop signal */ +#define EV_ERROR 0x80000000 /* sent when an error occurs */ /* can be used to add custom fields to all watchers, while losing binary compatibility */ #ifndef EV_COMMON @@ -115,8 +155,8 @@ # define EV_PROTOTYPES 1 #endif -#define EV_VERSION_MAJOR 1 -#define EV_VERSION_MINOR 1 +#define EV_VERSION_MAJOR 3 +#define EV_VERSION_MINOR 0 #ifndef EV_CB_DECLARE # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); @@ -130,6 +170,15 @@ * private: you can look at them, but not change them, and they might not mean anything to you. * ro: can be read anytime, but only changed when the watcher isn't active * rw: can be read and modified anytime, even when the watcher is active + * + * some internal details that might be helpful for debugging: + * + * active is either 0, which means the watcher is not active, + * or the array index of the watcher (periodics, timers) + * or the array index + 1 (most other watchers) + * or simply 1 for watchers that aren't in some array. + * pending is either 0, in which case the watcher isn't, + * or the array index + 1 in the pendings array. */ /* shared by all watchers */ @@ -191,6 +240,7 @@ { EV_WATCHER_TIME (ev_periodic) + ev_tstamp offset; /* rw */ ev_tstamp interval; /* rw */ ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ } ev_periodic; @@ -211,6 +261,7 @@ { EV_WATCHER_LIST (ev_child) + int flags; /* private */ int pid; /* ro */ int rpid; /* rw, holds the received pid */ int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ @@ -240,12 +291,14 @@ } ev_stat; #endif +#if EV_IDLE_ENABLE /* invoked when the nothing else needs to be done, keeps the process from blocking */ /* revent EV_IDLE */ typedef struct ev_idle { EV_WATCHER (ev_idle) } ev_idle; +#endif /* invoked for each run of the mainloop, just before the blocking call */ /* you can still change events in any way you like */ @@ -277,11 +330,30 @@ { EV_WATCHER (ev_embed) - ev_io io; /* private */ - struct ev_loop *loop; /* ro */ + struct ev_loop *other; /* ro */ + ev_io io; /* private */ + ev_prepare prepare; /* private */ + ev_check check; /* unused */ + ev_timer timer; /* unused */ + ev_periodic periodic; /* unused */ + ev_idle idle; /* unused */ + ev_fork fork; /* private */ } ev_embed; #endif +#if EV_ASYNC_ENABLE +/* invoked when somebody calls ev_async_send on the watcher */ +/* revent EV_ASYNC */ +typedef struct ev_async +{ + EV_WATCHER (ev_async) + + EV_ATOMIC_T sent; /* private */ +} ev_async; + +# define ev_async_pending(w) ((w)->sent + 0) +#endif + /* the presence of this union forces similar struct layout */ union ev_any_watcher { @@ -296,7 +368,9 @@ #if EV_STAT_ENABLE struct ev_stat stat; #endif +#if EV_IDLE_ENABLE struct ev_idle idle; +#endif struct ev_prepare prepare; struct ev_check check; #if EV_FORK_ENABLE @@ -305,21 +379,24 @@ #if EV_EMBED_ENABLE struct ev_embed embed; #endif +#if EV_ASYNC_ENABLE + struct ev_async async; +#endif }; /* bits for ev_default_loop and ev_loop_new */ /* the default */ -#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ +#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ /* flag bits */ -#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ -#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */ +#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ +#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ /* method bits to be ored together */ -#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ -#define EVBACKEND_POLL 0x00000002UL /* !win */ -#define EVBACKEND_EPOLL 0x00000004UL /* linux */ -#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ -#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ -#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ +#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ +#define EVBACKEND_POLL 0x00000002U /* !win */ +#define EVBACKEND_EPOLL 0x00000004U /* linux */ +#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ +#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ +#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ #if EV_PROTOTYPES int ev_version_major (void); @@ -330,6 +407,7 @@ unsigned int ev_embeddable_backends (void); ev_tstamp ev_time (void); +void ev_sleep (ev_tstamp delay); /* sleep for a while */ /* Sets the allocation function to use, works like realloc. * It is used to allocate and free memory. @@ -345,40 +423,65 @@ */ void ev_set_syserr_cb (void (*cb)(const char *msg)); -# if EV_MULTIPLICITY +#if EV_MULTIPLICITY +EV_INLINE struct ev_loop * +ev_default_loop_uc (void) +{ + extern struct ev_loop *ev_default_loop_ptr; + + return ev_default_loop_ptr; +} + /* the default loop is the only one that handles signals and child watchers */ /* you can call this as often as you like */ -static struct ev_loop * +EV_INLINE struct ev_loop * ev_default_loop (unsigned int flags) { - extern struct ev_loop *ev_default_loop_ptr; - extern struct ev_loop *ev_default_loop_init (unsigned int flags); + struct ev_loop *loop = ev_default_loop_uc (); - if (!ev_default_loop_ptr) - ev_default_loop_init (flags); + if (!loop) + { + extern struct ev_loop *ev_default_loop_init (unsigned int flags); - return ev_default_loop_ptr; + loop = ev_default_loop_init (flags); + } + + return loop; } /* create and destroy alternative loops that don't handle signals */ struct ev_loop *ev_loop_new (unsigned int flags); void ev_loop_destroy (EV_P); void ev_loop_fork (EV_P); +void ev_loop_verify (EV_P); ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ +void ev_now_update (EV_P); -# else +#else int ev_default_loop (unsigned int flags); /* returns true when successful */ -static ev_tstamp +EV_INLINE ev_tstamp ev_now (void) { extern ev_tstamp ev_rt_now; return ev_rt_now; } -# endif +#endif /* multiplicity */ + +EV_INLINE int +ev_is_default_loop (EV_P) +{ +#if EV_MULTIPLICITY + extern struct ev_loop *ev_default_loop_ptr; + + return !!(EV_A == ev_default_loop_ptr); +#else + return 1; +#endif +} void ev_default_destroy (void); /* destroy the default loop */ /* this needs to be called after fork, to duplicate the default loop */ @@ -387,8 +490,9 @@ /* you can actually call it at any time, anywhere :) */ void ev_default_fork (void); -unsigned int ev_backend (EV_P); -#endif +unsigned int ev_backend (EV_P); /* backend in use by loop */ +unsigned int ev_loop_count (EV_P); /* number of loop iterations */ +#endif /* prototypes */ #define EVLOOP_NONBLOCK 1 /* do not block/wait */ #define EVLOOP_ONESHOT 2 /* block *once* only */ @@ -400,6 +504,9 @@ void ev_loop (EV_P_ int flags); 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 */ +void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ +void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ + /* * ref/unref can be used to add or remove a refcount on the mainloop. every watcher * keeps one reference. if you have a long-runing watcher you never unregister that @@ -415,43 +522,47 @@ /* these may evaluate ev multiple times, and the other arguments at most once */ /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ -#define ev_init(ev,cb_) do { \ +#define ev_init(ev,cb_) do { \ ((ev_watcher *)(void *)(ev))->active = \ ((ev_watcher *)(void *)(ev))->pending = \ ((ev_watcher *)(void *)(ev))->priority = 0; \ - ev_set_cb ((ev), cb_); \ + ev_set_cb ((ev), cb_); \ } while (0) -#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) -#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) -#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) +#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) +#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) +#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) -#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) +#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ -#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) +#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ +#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) -#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) -#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) +#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) +#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) -#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) +#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) +#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ -#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ +#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) #define ev_cb(ev) (ev)->cb /* rw */ -#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) +#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) + +#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) #ifndef ev_set_cb # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) @@ -466,6 +577,8 @@ void ev_feed_event (EV_P_ void *w, int revents); void ev_feed_fd_event (EV_P_ int fd, int revents); void ev_feed_signal_event (EV_P_ int signum); +void ev_invoke (EV_P_ void *w, int revents); +int ev_clear_pending (EV_P_ void *w); void ev_io_start (EV_P_ ev_io *w); void ev_io_stop (EV_P_ ev_io *w); @@ -495,8 +608,10 @@ void ev_stat_stat (EV_P_ ev_stat *w); # endif +# if EV_IDLE_ENABLE void ev_idle_start (EV_P_ ev_idle *w); void ev_idle_stop (EV_P_ ev_idle *w); +# endif void ev_prepare_start (EV_P_ ev_prepare *w); void ev_prepare_stop (EV_P_ ev_prepare *w); @@ -516,6 +631,12 @@ void ev_embed_sweep (EV_P_ ev_embed *w); # endif +# if EV_ASYNC_ENABLE +void ev_async_start (EV_P_ ev_async *w); +void ev_async_stop (EV_P_ ev_async *w); +void ev_async_send (EV_P_ ev_async *w); +# endif + #endif #ifdef __cplusplus