ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.253 by root, Tue Jul 14 18:33:48 2009 UTC vs.
Revision 1.262 by root, Sat Jul 25 10:14:34 2009 UTC

98=head2 FEATURES 98=head2 FEATURES
99 99
100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102for file descriptor events (C<ev_io>), the Linux C<inotify> interface 102for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 103(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104with customised rescheduling (C<ev_periodic>), synchronous signals 104inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105(C<ev_signal>), process status change events (C<ev_child>), and event 105timers (C<ev_timer>), absolute timers with customised rescheduling
106watchers dealing with the event loop mechanism itself (C<ev_idle>, 106(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 107change events (C<ev_child>), and event watchers dealing with the event
108file watchers (C<ev_stat>) and even limited support for fork events 108loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109(C<ev_fork>). 109C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
110limited support for fork events (C<ev_fork>).
110 111
111It also is quite fast (see this 112It also is quite fast (see this
112L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 113L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113for example). 114for example).
114 115
361forget about forgetting to tell libev about forking) when you use this 362forget about forgetting to tell libev about forking) when you use this
362flag. 363flag.
363 364
364This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 365This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365environment variable. 366environment variable.
367
368=item C<EVFLAG_NOINOTIFY>
369
370When this flag is specified, then libev will not attempt to use the
371I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
372testing, this flag can be useful to conserve inotify file descriptors, as
373otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374
375=item C<EVFLAG_NOSIGNALFD>
376
377When this flag is specified, then libev will not attempt to use the
378I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is
379probably only useful to work around any bugs in libev. Consequently, this
380flag might go away once the signalfd functionality is considered stable,
381so it's useful mostly in environment variables and not in program code.
366 382
367=item C<EVBACKEND_SELECT> (value 1, portable select backend) 383=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368 384
369This is your standard select(2) backend. Not I<completely> standard, as 385This is your standard select(2) backend. Not I<completely> standard, as
370libev tries to roll its own fd_set with no limits on the number of fds, 386libev tries to roll its own fd_set with no limits on the number of fds,
518 534
519It is definitely not recommended to use this flag. 535It is definitely not recommended to use this flag.
520 536
521=back 537=back
522 538
523If one or more of these are or'ed into the flags value, then only these 539If one or more of the backend flags are or'ed into the flags value,
524backends will be tried (in the reverse order as listed here). If none are 540then only these backends will be tried (in the reverse order as listed
525specified, all backends in C<ev_recommended_backends ()> will be tried. 541here). If none are specified, all backends in C<ev_recommended_backends
542()> will be tried.
526 543
527Example: This is the most typical usage. 544Example: This is the most typical usage.
528 545
529 if (!ev_default_loop (0)) 546 if (!ev_default_loop (0))
530 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 547 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
862 879
863This call will simply invoke all pending watchers while resetting their 880This call will simply invoke all pending watchers while resetting their
864pending state. Normally, C<ev_loop> does this automatically when required, 881pending state. Normally, C<ev_loop> does this automatically when required,
865but when overriding the invoke callback this call comes handy. 882but when overriding the invoke callback this call comes handy.
866 883
884=item int ev_pending_count (loop)
885
886Returns the number of pending watchers - zero indicates that no watchers
887are pending.
888
867=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) 889=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
868 890
869This overrides the invoke pending functionality of the loop: Instead of 891This overrides the invoke pending functionality of the loop: Instead of
870invoking all pending watchers when there are any, C<ev_loop> will call 892invoking all pending watchers when there are any, C<ev_loop> will call
871this callback instead. This is useful, for example, when you want to 893this callback instead. This is useful, for example, when you want to
889suspended waiting for new events, and C<acquire> is called just 911suspended waiting for new events, and C<acquire> is called just
890afterwards. 912afterwards.
891 913
892Ideally, C<release> will just call your mutex_unlock function, and 914Ideally, C<release> will just call your mutex_unlock function, and
893C<acquire> will just call the mutex_lock function again. 915C<acquire> will just call the mutex_lock function again.
916
917While event loop modifications are allowed between invocations of
918C<release> and C<acquire> (that's their only purpose after all), no
919modifications done will affect the event loop, i.e. adding watchers will
920have no effect on the set of file descriptors being watched, or the time
921waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it
922to take note of any changes you made.
923
924In theory, threads executing C<ev_loop> will be async-cancel safe between
925invocations of C<release> and C<acquire>.
926
927See also the locking example in the C<THREADS> section later in this
928document.
894 929
895=item ev_set_userdata (loop, void *data) 930=item ev_set_userdata (loop, void *data)
896 931
897=item ev_userdata (loop) 932=item ev_userdata (loop)
898 933
1737 1772
1738If the event loop is suspended for a long time, you can also force an 1773If the event loop is suspended for a long time, you can also force an
1739update of the time returned by C<ev_now ()> by calling C<ev_now_update 1774update of the time returned by C<ev_now ()> by calling C<ev_now_update
1740()>. 1775()>.
1741 1776
1777=head3 The special problems of suspended animation
1778
1779When you leave the server world it is quite customary to hit machines that
1780can suspend/hibernate - what happens to the clocks during such a suspend?
1781
1782Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1783all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1784to run until the system is suspended, but they will not advance while the
1785system is suspended. That means, on resume, it will be as if the program
1786was frozen for a few seconds, but the suspend time will not be counted
1787towards C<ev_timer> when a monotonic clock source is used. The real time
1788clock advanced as expected, but if it is used as sole clocksource, then a
1789long suspend would be detected as a time jump by libev, and timers would
1790be adjusted accordingly.
1791
1792I would not be surprised to see different behaviour in different between
1793operating systems, OS versions or even different hardware.
1794
1795The other form of suspend (job control, or sending a SIGSTOP) will see a
1796time jump in the monotonic clocks and the realtime clock. If the program
1797is suspended for a very long time, and monotonic clock sources are in use,
1798then you can expect C<ev_timer>s to expire as the full suspension time
1799will be counted towards the timers. When no monotonic clock source is in
1800use, then libev will again assume a timejump and adjust accordingly.
1801
1802It might be beneficial for this latter case to call C<ev_suspend>
1803and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1804deterministic behaviour in this case (you can do nothing against
1805C<SIGSTOP>).
1806
1742=head3 Watcher-Specific Functions and Data Members 1807=head3 Watcher-Specific Functions and Data Members
1743 1808
1744=over 4 1809=over 4
1745 1810
1746=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1811=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1771If the timer is repeating, either start it if necessary (with the 1836If the timer is repeating, either start it if necessary (with the
1772C<repeat> value), or reset the running timer to the C<repeat> value. 1837C<repeat> value), or reset the running timer to the C<repeat> value.
1773 1838
1774This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 1839This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1775usage example. 1840usage example.
1841
1842=item ev_timer_remaining (loop, ev_timer *)
1843
1844Returns the remaining time until a timer fires. If the timer is active,
1845then this time is relative to the current event loop time, otherwise it's
1846the timeout value currently configured.
1847
1848That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1849C<5>. When the timer is started and one second passes, C<ev_timer_remain>
1850will return C<4>. When the timer expires and is restarted, it will return
1851roughly C<7> (likely slightly less as callback invocation takes some time,
1852too), and so on.
1776 1853
1777=item ev_tstamp repeat [read-write] 1854=item ev_tstamp repeat [read-write]
1778 1855
1779The current C<repeat> value. Will be used each time the watcher times out 1856The current C<repeat> value. Will be used each time the watcher times out
1780or C<ev_timer_again> is called, and determines the next timeout (if any), 1857or C<ev_timer_again> is called, and determines the next timeout (if any),
2016Signal watchers will trigger an event when the process receives a specific 2093Signal watchers will trigger an event when the process receives a specific
2017signal one or more times. Even though signals are very asynchronous, libev 2094signal one or more times. Even though signals are very asynchronous, libev
2018will try it's best to deliver signals synchronously, i.e. as part of the 2095will try it's best to deliver signals synchronously, i.e. as part of the
2019normal event processing, like any other event. 2096normal event processing, like any other event.
2020 2097
2021If you want signals asynchronously, just use C<sigaction> as you would 2098If you want signals to be delivered truly asynchronously, just use
2022do without libev and forget about sharing the signal. You can even use 2099C<sigaction> as you would do without libev and forget about sharing
2023C<ev_async> from a signal handler to synchronously wake up an event loop. 2100the signal. You can even use C<ev_async> from a signal handler to
2101synchronously wake up an event loop.
2024 2102
2025You can configure as many watchers as you like per signal. Only when the 2103You can configure as many watchers as you like for the same signal, but
2104only within the same loop, i.e. you can watch for C<SIGINT> in your
2105default loop and for C<SIGIO> in another loop, but you cannot watch for
2106C<SIGINT> in both the default loop and another loop at the same time. At
2107the moment, C<SIGCHLD> is permanently tied to the default loop.
2108
2026first watcher gets started will libev actually register a signal handler 2109When the first watcher gets started will libev actually register something
2027with the kernel (thus it coexists with your own signal handlers as long as 2110with the kernel (thus it coexists with your own signal handlers as long as
2028you don't register any with libev for the same signal). Similarly, when 2111you don't register any with libev for the same signal).
2029the last signal watcher for a signal is stopped, libev will reset the 2112
2030signal handler to SIG_DFL (regardless of what it was set to before). 2113Both the signal mask state (C<sigprocmask>) and the signal handler state
2114(C<sigaction>) are unspecified after starting a signal watcher (and after
2115sotpping it again), that is, libev might or might not block the signal,
2116and might or might not set or restore the installed signal handler.
2031 2117
2032If possible and supported, libev will install its handlers with 2118If possible and supported, libev will install its handlers with
2033C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2119C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2034interrupted. If you have a problem with system calls getting interrupted by 2120not be unduly interrupted. If you have a problem with system calls getting
2035signals you can block all signals in an C<ev_check> watcher and unblock 2121interrupted by signals you can block all signals in an C<ev_check> watcher
2036them in an C<ev_prepare> watcher. 2122and unblock them in an C<ev_prepare> watcher.
2037 2123
2038=head3 Watcher-Specific Functions and Data Members 2124=head3 Watcher-Specific Functions and Data Members
2039 2125
2040=over 4 2126=over 4
2041 2127
2086libev) 2172libev)
2087 2173
2088=head3 Process Interaction 2174=head3 Process Interaction
2089 2175
2090Libev grabs C<SIGCHLD> as soon as the default event loop is 2176Libev grabs C<SIGCHLD> as soon as the default event loop is
2091initialised. This is necessary to guarantee proper behaviour even if 2177initialised. This is necessary to guarantee proper behaviour even if the
2092the first child watcher is started after the child exits. The occurrence 2178first child watcher is started after the child exits. The occurrence
2093of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2179of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2094synchronously as part of the event loop processing. Libev always reaps all 2180synchronously as part of the event loop processing. Libev always reaps all
2095children, even ones not watched. 2181children, even ones not watched.
2096 2182
2097=head3 Overriding the Built-In Processing 2183=head3 Overriding the Built-In Processing
2107=head3 Stopping the Child Watcher 2193=head3 Stopping the Child Watcher
2108 2194
2109Currently, the child watcher never gets stopped, even when the 2195Currently, the child watcher never gets stopped, even when the
2110child terminates, so normally one needs to stop the watcher in the 2196child terminates, so normally one needs to stop the watcher in the
2111callback. Future versions of libev might stop the watcher automatically 2197callback. Future versions of libev might stop the watcher automatically
2112when a child exit is detected. 2198when a child exit is detected (calling C<ev_child_stop> twice is not a
2199problem).
2113 2200
2114=head3 Watcher-Specific Functions and Data Members 2201=head3 Watcher-Specific Functions and Data Members
2115 2202
2116=over 4 2203=over 4
2117 2204
3495keeps libev from including F<config.h>, and it also defines dummy 3582keeps libev from including F<config.h>, and it also defines dummy
3496implementations for some libevent functions (such as logging, which is not 3583implementations for some libevent functions (such as logging, which is not
3497supported). It will also not define any of the structs usually found in 3584supported). It will also not define any of the structs usually found in
3498F<event.h> that are not directly supported by the libev core alone. 3585F<event.h> that are not directly supported by the libev core alone.
3499 3586
3500In stanbdalone mode, libev will still try to automatically deduce the 3587In standalone mode, libev will still try to automatically deduce the
3501configuration, but has to be more conservative. 3588configuration, but has to be more conservative.
3502 3589
3503=item EV_USE_MONOTONIC 3590=item EV_USE_MONOTONIC
3504 3591
3505If defined to be C<1>, libev will try to detect the availability of the 3592If defined to be C<1>, libev will try to detect the availability of the
3732Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to 3819Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3733provide a bare-bones event library. See C<ev.h> for details on what parts 3820provide a bare-bones event library. See C<ev.h> for details on what parts
3734of the API are still available, and do not complain if this subset changes 3821of the API are still available, and do not complain if this subset changes
3735over time. 3822over time.
3736 3823
3824=item EV_NSIG
3825
3826The highest supported signal number, +1 (or, the number of
3827signals): Normally, libev tries to deduce the maximum number of signals
3828automatically, but sometimes this fails, in which case it can be
3829specified. Also, using a lower number than detected (C<32> should be
3830good for about any system in existance) can save some memory, as libev
3831statically allocates some 12-24 bytes per signal number.
3832
3737=item EV_PID_HASHSIZE 3833=item EV_PID_HASHSIZE
3738 3834
3739C<ev_child> watchers use a small hash table to distribute workload by 3835C<ev_child> watchers use a small hash table to distribute workload by
3740pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3836pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
3741than enough. If you need to manage thousands of children you might want to 3837than enough. If you need to manage thousands of children you might want to
3928 4024
3929=back 4025=back
3930 4026
3931=head4 THREAD LOCKING EXAMPLE 4027=head4 THREAD LOCKING EXAMPLE
3932 4028
4029Here is a fictitious example of how to run an event loop in a different
4030thread than where callbacks are being invoked and watchers are
4031created/added/removed.
4032
4033For a real-world example, see the C<EV::Loop::Async> perl module,
4034which uses exactly this technique (which is suited for many high-level
4035languages).
4036
4037The example uses a pthread mutex to protect the loop data, a condition
4038variable to wait for callback invocations, an async watcher to notify the
4039event loop thread and an unspecified mechanism to wake up the main thread.
4040
4041First, you need to associate some data with the event loop:
4042
4043 typedef struct {
4044 mutex_t lock; /* global loop lock */
4045 ev_async async_w;
4046 thread_t tid;
4047 cond_t invoke_cv;
4048 } userdata;
4049
4050 void prepare_loop (EV_P)
4051 {
4052 // for simplicity, we use a static userdata struct.
4053 static userdata u;
4054
4055 ev_async_init (&u->async_w, async_cb);
4056 ev_async_start (EV_A_ &u->async_w);
4057
4058 pthread_mutex_init (&u->lock, 0);
4059 pthread_cond_init (&u->invoke_cv, 0);
4060
4061 // now associate this with the loop
4062 ev_set_userdata (EV_A_ u);
4063 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4064 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4065
4066 // then create the thread running ev_loop
4067 pthread_create (&u->tid, 0, l_run, EV_A);
4068 }
4069
4070The callback for the C<ev_async> watcher does nothing: the watcher is used
4071solely to wake up the event loop so it takes notice of any new watchers
4072that might have been added:
4073
4074 static void
4075 async_cb (EV_P_ ev_async *w, int revents)
4076 {
4077 // just used for the side effects
4078 }
4079
4080The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4081protecting the loop data, respectively.
4082
4083 static void
4084 l_release (EV_P)
4085 {
4086 userdata *u = ev_userdata (EV_A);
4087 pthread_mutex_unlock (&u->lock);
4088 }
4089
4090 static void
4091 l_acquire (EV_P)
4092 {
4093 userdata *u = ev_userdata (EV_A);
4094 pthread_mutex_lock (&u->lock);
4095 }
4096
4097The event loop thread first acquires the mutex, and then jumps straight
4098into C<ev_loop>:
4099
4100 void *
4101 l_run (void *thr_arg)
4102 {
4103 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4104
4105 l_acquire (EV_A);
4106 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4107 ev_loop (EV_A_ 0);
4108 l_release (EV_A);
4109
4110 return 0;
4111 }
4112
4113Instead of invoking all pending watchers, the C<l_invoke> callback will
4114signal the main thread via some unspecified mechanism (signals? pipe
4115writes? C<Async::Interrupt>?) and then waits until all pending watchers
4116have been called (in a while loop because a) spurious wakeups are possible
4117and b) skipping inter-thread-communication when there are no pending
4118watchers is very beneficial):
4119
4120 static void
4121 l_invoke (EV_P)
4122 {
4123 userdata *u = ev_userdata (EV_A);
4124
4125 while (ev_pending_count (EV_A))
4126 {
4127 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4128 pthread_cond_wait (&u->invoke_cv, &u->lock);
4129 }
4130 }
4131
4132Now, whenever the main thread gets told to invoke pending watchers, it
4133will grab the lock, call C<ev_invoke_pending> and then signal the loop
4134thread to continue:
4135
4136 static void
4137 real_invoke_pending (EV_P)
4138 {
4139 userdata *u = ev_userdata (EV_A);
4140
4141 pthread_mutex_lock (&u->lock);
4142 ev_invoke_pending (EV_A);
4143 pthread_cond_signal (&u->invoke_cv);
4144 pthread_mutex_unlock (&u->lock);
4145 }
4146
4147Whenever you want to start/stop a watcher or do other modifications to an
4148event loop, you will now have to lock:
4149
4150 ev_timer timeout_watcher;
4151 userdata *u = ev_userdata (EV_A);
4152
4153 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4154
4155 pthread_mutex_lock (&u->lock);
4156 ev_timer_start (EV_A_ &timeout_watcher);
4157 ev_async_send (EV_A_ &u->async_w);
4158 pthread_mutex_unlock (&u->lock);
4159
4160Note that sending the C<ev_async> watcher is required because otherwise
4161an event loop currently blocking in the kernel will have no knowledge
4162about the newly added timer. By waking up the loop it will pick up any new
4163watchers in the next event loop iteration.
4164
3933=head3 COROUTINES 4165=head3 COROUTINES
3934 4166
3935Libev is very accommodating to coroutines ("cooperative threads"): 4167Libev is very accommodating to coroutines ("cooperative threads"):
3936libev fully supports nesting calls to its functions from different 4168libev fully supports nesting calls to its functions from different
3937coroutines (e.g. you can call C<ev_loop> on the same loop from two 4169coroutines (e.g. you can call C<ev_loop> on the same loop from two
3938different coroutines, and switch freely between both coroutines running the 4170different coroutines, and switch freely between both coroutines running
3939loop, as long as you don't confuse yourself). The only exception is that 4171the loop, as long as you don't confuse yourself). The only exception is
3940you must not do this from C<ev_periodic> reschedule callbacks. 4172that you must not do this from C<ev_periodic> reschedule callbacks.
3941 4173
3942Care has been taken to ensure that libev does not keep local state inside 4174Care has been taken to ensure that libev does not keep local state inside
3943C<ev_loop>, and other calls do not usually allow for coroutine switches as 4175C<ev_loop>, and other calls do not usually allow for coroutine switches as
3944they do not call any callbacks. 4176they do not call any callbacks.
3945 4177

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines