--- libev/ev.h 2010/10/24 17:58:41 1.149 +++ libev/ev.h 2012/04/02 23:46:11 1.166 @@ -1,19 +1,19 @@ /* * libev native API header * - * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann + * Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann * All rights reserved. * * 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 @@ -56,7 +56,11 @@ #endif #ifndef EV_FEATURES -# define EV_FEATURES 0x7f +# if defined __OPTIMIZE_SIZE__ +# define EV_FEATURES 0x7c +# else +# define EV_FEATURES 0x7f +# endif #endif #define EV_FEATURE_CODE ((EV_FEATURES) & 1) @@ -103,6 +107,10 @@ # define EV_FORK_ENABLE EV_FEATURE_WATCHERS #endif +#ifndef EV_CLEANUP_ENABLE +# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS +#endif + #ifndef EV_SIGNAL_ENABLE # define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS #endif @@ -181,7 +189,13 @@ # define EV_INLINE static #endif -/* EV_PROTOTYPES can be sued to switch of prototype declarations */ +#ifdef EV_API_STATIC +# define EV_API_DECL static +#else +# define EV_API_DECL extern +#endif + +/* EV_PROTOTYPES can be used to switch of prototype declarations */ #ifndef EV_PROTOTYPES # define EV_PROTOTYPES 1 #endif @@ -189,11 +203,11 @@ /*****************************************************************************/ #define EV_VERSION_MAJOR 4 -#define EV_VERSION_MINOR 0 +#define EV_VERSION_MINOR 11 /* eventmask, revents, events... */ enum { - EV_UNDEF = -1, /* guaranteed to be invalid */ + EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */ EV_NONE = 0x00, /* no events */ EV_READ = 0x01, /* ev_io detected read will not block */ EV_WRITE = 0x02, /* ev_io detected write will not block */ @@ -212,7 +226,8 @@ EV_CHECK = 0x00008000, /* event loop finished poll */ EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ EV_FORK = 0x00020000, /* event loop resumed in child */ - EV_ASYNC = 0x00040000, /* async intra-loop signal */ + EV_CLEANUP = 0x00040000, /* event loop resumed in child */ + EV_ASYNC = 0x00080000, /* async intra-loop signal */ EV_CUSTOM = 0x01000000, /* for use by user code */ EV_ERROR = 0x80000000 /* sent when an error occurs */ }; @@ -391,12 +406,22 @@ #if EV_FORK_ENABLE /* the callback gets invoked before check in the child process when a fork was detected */ +/* revent EV_FORK */ typedef struct ev_fork { EV_WATCHER (ev_fork) } ev_fork; #endif +#if EV_CLEANUP_ENABLE +/* is invoked just before the loop gets destroyed */ +/* revent EV_CLEANUP */ +typedef struct ev_cleanup +{ + EV_WATCHER (ev_cleanup) +} ev_cleanup; +#endif + #if EV_EMBED_ENABLE /* used to embed an event loop inside another */ /* the callback gets invoked when the event loop has handled events, and can be 0 */ @@ -412,6 +437,9 @@ ev_periodic periodic; /* unused */ ev_idle idle; /* unused */ ev_fork fork; /* private */ +#if EV_CLEANUP_ENABLE + ev_cleanup cleanup; /* unused */ +#endif } ev_embed; #endif @@ -450,6 +478,9 @@ #if EV_FORK_ENABLE struct ev_fork fork; #endif +#if EV_CLEANUP_ENABLE + struct ev_cleanup cleanup; +#endif #if EV_EMBED_ENABLE struct ev_embed embed; #endif @@ -470,7 +501,8 @@ #if EV_COMPAT3 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ #endif - EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ + EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */ + EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */ }; /* method bits to be ored together */ @@ -481,19 +513,20 @@ EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ - EVBACKEND_ALL = 0x0000003FU + EVBACKEND_ALL = 0x0000003FU, /* all known backends */ + EVBACKEND_MASK = 0x0000FFFFU /* all future backends */ }; #if EV_PROTOTYPES -int ev_version_major (void); -int ev_version_minor (void); +EV_API_DECL int ev_version_major (void); +EV_API_DECL int ev_version_minor (void); -unsigned int ev_supported_backends (void); -unsigned int ev_recommended_backends (void); -unsigned int ev_embeddable_backends (void); +EV_API_DECL unsigned int ev_supported_backends (void); +EV_API_DECL unsigned int ev_recommended_backends (void); +EV_API_DECL unsigned int ev_embeddable_backends (void); -ev_tstamp ev_time (void); -void ev_sleep (ev_tstamp delay); /* sleep for a while */ +EV_API_DECL ev_tstamp ev_time (void); +EV_API_DECL 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. @@ -501,19 +534,23 @@ * or take some potentially destructive action. * The default is your system realloc function. */ -void ev_set_allocator (void *(*cb)(void *ptr, long size)); +EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size)); /* set the callback function to call on a * retryable syscall error * (such as failed select, poll, epoll_wait) */ -void ev_set_syserr_cb (void (*cb)(const char *msg)); +EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg)); #if EV_MULTIPLICITY /* the default loop is the only one that handles signals and child watchers */ /* you can call this as often as you like */ -struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)); +EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)); + +#ifdef EV_API_STATIC +EV_API_DECL struct ev_loop *ev_default_loop_ptr; +#endif EV_INLINE struct ev_loop * ev_default_loop_uc_ (void) @@ -530,21 +567,19 @@ } /* create and destroy alternative loops that don't handle signals */ -struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); -/* destroy event loops, also works for the default loop */ -void ev_loop_destroy (EV_P); +EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); -ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ +EV_API_DECL ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ #else -int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */ +EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */ + +EV_API_DECL ev_tstamp ev_rt_now; EV_INLINE ev_tstamp ev_now (void) { - extern ev_tstamp ev_rt_now; - return ev_rt_now; } @@ -557,21 +592,24 @@ #endif /* multiplicity */ +/* destroy event loops, also works for the default loop */ +EV_API_DECL void ev_loop_destroy (EV_P); + /* this needs to be called after fork, to duplicate the loop */ /* when you want to re-use it in the child */ /* you can call it in either the parent or the child */ /* you can actually call it at any time, anywhere :) */ -void ev_loop_fork (EV_P); +EV_API_DECL void ev_loop_fork (EV_P); -unsigned int ev_backend (EV_P); /* backend in use by loop */ +EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */ -void ev_now_update (EV_P); /* update event loop time */ +EV_API_DECL void ev_now_update (EV_P); /* update event loop time */ #if EV_WALK_ENABLE /* walk (almost) all watchers in the loop of a given type, invoking the */ /* callback on every such watcher. The callback might stop the watcher, */ /* but do nothing else with the loop */ -void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); +EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); #endif #endif /* prototypes */ @@ -590,45 +628,45 @@ }; #if EV_PROTOTYPES -void ev_run (EV_P_ int flags EV_CPP (= 0)); -void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */ +EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0)); +EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */ /* * ref/unref can be used to add or remove a refcount on the mainloop. every watcher * keeps one reference. if you have a long-running watcher you never unregister that * should not keep ev_loop from running, unref() after starting, and ref() before stopping. */ -void ev_ref (EV_P); -void ev_unref (EV_P); +EV_API_DECL void ev_ref (EV_P); +EV_API_DECL void ev_unref (EV_P); /* * convenience function, wait for a single event, without registering an event watcher * if timeout is < 0, do wait indefinitely */ -void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); +EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); # if EV_FEATURE_API -unsigned int ev_iteration (EV_P); /* number of loop iterations */ -unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ -void ev_verify (EV_P); /* abort if loop data corrupted */ +EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */ +EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ +EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */ -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 */ +EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ +EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ /* advanced stuff for threading etc. support, see docs */ -void ev_set_userdata (EV_P_ void *data); -void *ev_userdata (EV_P); -void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); -void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); +EV_API_DECL void ev_set_userdata (EV_P_ void *data); +EV_API_DECL void *ev_userdata (EV_P); +EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); +EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); -unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ -void ev_invoke_pending (EV_P); /* invoke all pending watchers */ +EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ +EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */ /* * stop/start the timer handling. */ -void ev_suspend (EV_P); -void ev_resume (EV_P); +EV_API_DECL void ev_suspend (EV_P); +EV_API_DECL void ev_resume (EV_P); #endif #endif @@ -653,6 +691,7 @@ #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ #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_cleanup_set(ev) /* nop, yes, this is a serious in-joke */ #define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) @@ -666,6 +705,7 @@ #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } 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_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_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 */ @@ -691,81 +731,87 @@ /* stopping (disabling, deleting) a watcher does nothing unless its already running */ #if EV_PROTOTYPES -/* feeds an event into a watcher as if the event actually occured */ +/* feeds an event into a watcher as if the event actually occurred */ /* accepts any ev_watcher type */ -void ev_feed_event (EV_P_ void *w, int revents); -void ev_feed_fd_event (EV_P_ int fd, int revents); +EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents); +EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents); #if EV_SIGNAL_ENABLE -void ev_feed_signal_event (EV_P_ int signum); +EV_API_DECL void ev_feed_signal (int signum); +EV_API_DECL void ev_feed_signal_event (EV_P_ int signum); #endif -void ev_invoke (EV_P_ void *w, int revents); -int ev_clear_pending (EV_P_ void *w); +EV_API_DECL void ev_invoke (EV_P_ void *w, int revents); +EV_API_DECL 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); +EV_API_DECL void ev_io_start (EV_P_ ev_io *w); +EV_API_DECL void ev_io_stop (EV_P_ ev_io *w); -void ev_timer_start (EV_P_ ev_timer *w); -void ev_timer_stop (EV_P_ ev_timer *w); +EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w); +EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w); /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ -void ev_timer_again (EV_P_ ev_timer *w); +EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w); /* return remaining time */ -ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); +EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); #if EV_PERIODIC_ENABLE -void ev_periodic_start (EV_P_ ev_periodic *w); -void ev_periodic_stop (EV_P_ ev_periodic *w); -void ev_periodic_again (EV_P_ ev_periodic *w); +EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w); +EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w); +EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w); #endif /* only supported in the default loop */ #if EV_SIGNAL_ENABLE -void ev_signal_start (EV_P_ ev_signal *w); -void ev_signal_stop (EV_P_ ev_signal *w); +EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w); +EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w); #endif /* only supported in the default loop */ # if EV_CHILD_ENABLE -void ev_child_start (EV_P_ ev_child *w); -void ev_child_stop (EV_P_ ev_child *w); +EV_API_DECL void ev_child_start (EV_P_ ev_child *w); +EV_API_DECL void ev_child_stop (EV_P_ ev_child *w); # endif # if EV_STAT_ENABLE -void ev_stat_start (EV_P_ ev_stat *w); -void ev_stat_stop (EV_P_ ev_stat *w); -void ev_stat_stat (EV_P_ ev_stat *w); +EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w); +EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w); +EV_API_DECL 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); +EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w); +EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w); # endif #if EV_PREPARE_ENABLE -void ev_prepare_start (EV_P_ ev_prepare *w); -void ev_prepare_stop (EV_P_ ev_prepare *w); +EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w); +EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w); #endif #if EV_CHECK_ENABLE -void ev_check_start (EV_P_ ev_check *w); -void ev_check_stop (EV_P_ ev_check *w); +EV_API_DECL void ev_check_start (EV_P_ ev_check *w); +EV_API_DECL void ev_check_stop (EV_P_ ev_check *w); #endif # if EV_FORK_ENABLE -void ev_fork_start (EV_P_ ev_fork *w); -void ev_fork_stop (EV_P_ ev_fork *w); +EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w); +EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w); +# endif + +# if EV_CLEANUP_ENABLE +EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w); +EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w); # endif # if EV_EMBED_ENABLE /* only supported when loop to be embedded is in fact embeddable */ -void ev_embed_start (EV_P_ ev_embed *w); -void ev_embed_stop (EV_P_ ev_embed *w); -void ev_embed_sweep (EV_P_ ev_embed *w); +EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w); +EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w); +EV_API_DECL 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); +EV_API_DECL void ev_async_start (EV_P_ ev_async *w); +EV_API_DECL void ev_async_stop (EV_P_ ev_async *w); +EV_API_DECL void ev_async_send (EV_P_ ev_async *w); # endif #if EV_COMPAT3 @@ -780,9 +826,9 @@ EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); } EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); } #if EV_FEATURE_API - EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } - EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } - EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } + EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); } + EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); } + EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } #endif #endif #else