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

Comparing libev/ev.pod (file contents):
Revision 1.237 by root, Thu Apr 16 07:58:03 2009 UTC vs.
Revision 1.264 by root, Wed Aug 19 23:44:51 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?");
621 638
622This value can sometimes be useful as a generation counter of sorts (it 639This value can sometimes be useful as a generation counter of sorts (it
623"ticks" the number of loop iterations), as it roughly corresponds with 640"ticks" the number of loop iterations), as it roughly corresponds with
624C<ev_prepare> and C<ev_check> calls. 641C<ev_prepare> and C<ev_check> calls.
625 642
643=item unsigned int ev_loop_depth (loop)
644
645Returns the number of times C<ev_loop> was entered minus the number of
646times C<ev_loop> was exited, in other words, the recursion depth.
647
648Outside C<ev_loop>, this number is zero. In a callback, this number is
649C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
650in which case it is higher.
651
652Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
653etc.), doesn't count as exit.
654
626=item unsigned int ev_backend (loop) 655=item unsigned int ev_backend (loop)
627 656
628Returns one of the C<EVBACKEND_*> flags indicating the event backend in 657Returns one of the C<EVBACKEND_*> flags indicating the event backend in
629use. 658use.
630 659
644 673
645This function is rarely useful, but when some event callback runs for a 674This function is rarely useful, but when some event callback runs for a
646very long time without entering the event loop, updating libev's idea of 675very long time without entering the event loop, updating libev's idea of
647the current time is a good idea. 676the current time is a good idea.
648 677
649See also "The special problem of time updates" in the C<ev_timer> section. 678See also L<The special problem of time updates> in the C<ev_timer> section.
650 679
651=item ev_suspend (loop) 680=item ev_suspend (loop)
652 681
653=item ev_resume (loop) 682=item ev_resume (loop)
654 683
811 840
812By setting a higher I<io collect interval> you allow libev to spend more 841By setting a higher I<io collect interval> you allow libev to spend more
813time collecting I/O events, so you can handle more events per iteration, 842time collecting I/O events, so you can handle more events per iteration,
814at the cost of increasing latency. Timeouts (both C<ev_periodic> and 843at the cost of increasing latency. Timeouts (both C<ev_periodic> and
815C<ev_timer>) will be not affected. Setting this to a non-null value will 844C<ev_timer>) will be not affected. Setting this to a non-null value will
816introduce an additional C<ev_sleep ()> call into most loop iterations. 845introduce an additional C<ev_sleep ()> call into most loop iterations. The
846sleep time ensures that libev will not poll for I/O events more often then
847once per this interval, on average.
817 848
818Likewise, by setting a higher I<timeout collect interval> you allow libev 849Likewise, by setting a higher I<timeout collect interval> you allow libev
819to spend more time collecting timeouts, at the expense of increased 850to spend more time collecting timeouts, at the expense of increased
820latency/jitter/inexactness (the watcher callback will be called 851latency/jitter/inexactness (the watcher callback will be called
821later). C<ev_io> watchers will not be affected. Setting this to a non-null 852later). C<ev_io> watchers will not be affected. Setting this to a non-null
823 854
824Many (busy) programs can usually benefit by setting the I/O collect 855Many (busy) programs can usually benefit by setting the I/O collect
825interval to a value near C<0.1> or so, which is often enough for 856interval to a value near C<0.1> or so, which is often enough for
826interactive servers (of course not for games), likewise for timeouts. It 857interactive servers (of course not for games), likewise for timeouts. It
827usually doesn't make much sense to set it to a lower value than C<0.01>, 858usually doesn't make much sense to set it to a lower value than C<0.01>,
828as this approaches the timing granularity of most systems. 859as this approaches the timing granularity of most systems. Note that if
860you do transactions with the outside world and you can't increase the
861parallelity, then this setting will limit your transaction rate (if you
862need to poll once per transaction and the I/O collect interval is 0.01,
863then you can't do more than 100 transations per second).
829 864
830Setting the I<timeout collect interval> can improve the opportunity for 865Setting the I<timeout collect interval> can improve the opportunity for
831saving power, as the program will "bundle" timer callback invocations that 866saving power, as the program will "bundle" timer callback invocations that
832are "near" in time together, by delaying some, thus reducing the number of 867are "near" in time together, by delaying some, thus reducing the number of
833times the process sleeps and wakes up again. Another useful technique to 868times the process sleeps and wakes up again. Another useful technique to
834reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure 869reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
835they fire on, say, one-second boundaries only. 870they fire on, say, one-second boundaries only.
871
872Example: we only need 0.1s timeout granularity, and we wish not to poll
873more often than 100 times per second:
874
875 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
876 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
877
878=item ev_invoke_pending (loop)
879
880This call will simply invoke all pending watchers while resetting their
881pending state. Normally, C<ev_loop> does this automatically when required,
882but when overriding the invoke callback this call comes handy.
883
884=item int ev_pending_count (loop)
885
886Returns the number of pending watchers - zero indicates that no watchers
887are pending.
888
889=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
890
891This overrides the invoke pending functionality of the loop: Instead of
892invoking all pending watchers when there are any, C<ev_loop> will call
893this callback instead. This is useful, for example, when you want to
894invoke the actual watchers inside another context (another thread etc.).
895
896If you want to reset the callback, use C<ev_invoke_pending> as new
897callback.
898
899=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
900
901Sometimes you want to share the same loop between multiple threads. This
902can be done relatively simply by putting mutex_lock/unlock calls around
903each call to a libev function.
904
905However, C<ev_loop> can run an indefinite time, so it is not feasible to
906wait for it to return. One way around this is to wake up the loop via
907C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
908and I<acquire> callbacks on the loop.
909
910When set, then C<release> will be called just before the thread is
911suspended waiting for new events, and C<acquire> is called just
912afterwards.
913
914Ideally, C<release> will just call your mutex_unlock function, and
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.
929
930=item ev_set_userdata (loop, void *data)
931
932=item ev_userdata (loop)
933
934Set and retrieve a single C<void *> associated with a loop. When
935C<ev_set_userdata> has never been called, then C<ev_userdata> returns
936C<0.>
937
938These two functions can be used to associate arbitrary data with a loop,
939and are intended solely for the C<invoke_pending_cb>, C<release> and
940C<acquire> callbacks described above, but of course can be (ab-)used for
941any other purpose as well.
836 942
837=item ev_loop_verify (loop) 943=item ev_loop_verify (loop)
838 944
839This function only does something when C<EV_VERIFY> support has been 945This function only does something when C<EV_VERIFY> support has been
840compiled in, which is the default for non-minimal builds. It tries to go 946compiled in, which is the default for non-minimal builds. It tries to go
1184 #include <stddef.h> 1290 #include <stddef.h>
1185 1291
1186 static void 1292 static void
1187 t1_cb (EV_P_ ev_timer *w, int revents) 1293 t1_cb (EV_P_ ev_timer *w, int revents)
1188 { 1294 {
1189 struct my_biggy big = (struct my_biggy * 1295 struct my_biggy big = (struct my_biggy *)
1190 (((char *)w) - offsetof (struct my_biggy, t1)); 1296 (((char *)w) - offsetof (struct my_biggy, t1));
1191 } 1297 }
1192 1298
1193 static void 1299 static void
1194 t2_cb (EV_P_ ev_timer *w, int revents) 1300 t2_cb (EV_P_ ev_timer *w, int revents)
1195 { 1301 {
1196 struct my_biggy big = (struct my_biggy * 1302 struct my_biggy big = (struct my_biggy *)
1197 (((char *)w) - offsetof (struct my_biggy, t2)); 1303 (((char *)w) - offsetof (struct my_biggy, t2));
1198 } 1304 }
1199 1305
1200=head2 WATCHER PRIORITY MODELS 1306=head2 WATCHER PRIORITY MODELS
1201 1307
1277 // with the default priority are receiving events. 1383 // with the default priority are receiving events.
1278 ev_idle_start (EV_A_ &idle); 1384 ev_idle_start (EV_A_ &idle);
1279 } 1385 }
1280 1386
1281 static void 1387 static void
1282 idle-cb (EV_P_ ev_idle *w, int revents) 1388 idle_cb (EV_P_ ev_idle *w, int revents)
1283 { 1389 {
1284 // actual processing 1390 // actual processing
1285 read (STDIN_FILENO, ...); 1391 read (STDIN_FILENO, ...);
1286 1392
1287 // have to start the I/O watcher again, as 1393 // have to start the I/O watcher again, as
1332descriptors to non-blocking mode is also usually a good idea (but not 1438descriptors to non-blocking mode is also usually a good idea (but not
1333required if you know what you are doing). 1439required if you know what you are doing).
1334 1440
1335If you cannot use non-blocking mode, then force the use of a 1441If you cannot use non-blocking mode, then force the use of a
1336known-to-be-good backend (at the time of this writing, this includes only 1442known-to-be-good backend (at the time of this writing, this includes only
1337C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1443C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1444descriptors for which non-blocking operation makes no sense (such as
1445files) - libev doesn't guarentee any specific behaviour in that case.
1338 1446
1339Another thing you have to watch out for is that it is quite easy to 1447Another thing you have to watch out for is that it is quite easy to
1340receive "spurious" readiness notifications, that is your callback might 1448receive "spurious" readiness notifications, that is your callback might
1341be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1449be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1342because there is no data. Not only are some backends known to create a 1450because there is no data. Not only are some backends known to create a
1463year, it will still time out after (roughly) one hour. "Roughly" because 1571year, it will still time out after (roughly) one hour. "Roughly" because
1464detecting time jumps is hard, and some inaccuracies are unavoidable (the 1572detecting time jumps is hard, and some inaccuracies are unavoidable (the
1465monotonic clock option helps a lot here). 1573monotonic clock option helps a lot here).
1466 1574
1467The callback is guaranteed to be invoked only I<after> its timeout has 1575The callback is guaranteed to be invoked only I<after> its timeout has
1468passed. If multiple timers become ready during the same loop iteration 1576passed (not I<at>, so on systems with very low-resolution clocks this
1469then the ones with earlier time-out values are invoked before ones with 1577might introduce a small delay). If multiple timers become ready during the
1470later time-out values (but this is no longer true when a callback calls 1578same loop iteration then the ones with earlier time-out values are invoked
1471C<ev_loop> recursively). 1579before ones of the same priority with later time-out values (but this is
1580no longer true when a callback calls C<ev_loop> recursively).
1472 1581
1473=head3 Be smart about timeouts 1582=head3 Be smart about timeouts
1474 1583
1475Many real-world problems involve some kind of timeout, usually for error 1584Many real-world problems involve some kind of timeout, usually for error
1476recovery. A typical example is an HTTP request - if the other side hangs, 1585recovery. A typical example is an HTTP request - if the other side hangs,
1520C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> 1629C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1521member and C<ev_timer_again>. 1630member and C<ev_timer_again>.
1522 1631
1523At start: 1632At start:
1524 1633
1525 ev_timer_init (timer, callback); 1634 ev_init (timer, callback);
1526 timer->repeat = 60.; 1635 timer->repeat = 60.;
1527 ev_timer_again (loop, timer); 1636 ev_timer_again (loop, timer);
1528 1637
1529Each time there is some activity: 1638Each time there is some activity:
1530 1639
1592 1701
1593To start the timer, simply initialise the watcher and set C<last_activity> 1702To start the timer, simply initialise the watcher and set C<last_activity>
1594to the current time (meaning we just have some activity :), then call the 1703to the current time (meaning we just have some activity :), then call the
1595callback, which will "do the right thing" and start the timer: 1704callback, which will "do the right thing" and start the timer:
1596 1705
1597 ev_timer_init (timer, callback); 1706 ev_init (timer, callback);
1598 last_activity = ev_now (loop); 1707 last_activity = ev_now (loop);
1599 callback (loop, timer, EV_TIMEOUT); 1708 callback (loop, timer, EV_TIMEOUT);
1600 1709
1601And when there is some activity, simply store the current time in 1710And when there is some activity, simply store the current time in
1602C<last_activity>, no libev calls at all: 1711C<last_activity>, no libev calls at all:
1663 1772
1664If 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
1665update 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
1666()>. 1775()>.
1667 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
1668=head3 Watcher-Specific Functions and Data Members 1807=head3 Watcher-Specific Functions and Data Members
1669 1808
1670=over 4 1809=over 4
1671 1810
1672=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)
1697If the timer is repeating, either start it if necessary (with the 1836If the timer is repeating, either start it if necessary (with the
1698C<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.
1699 1838
1700This 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
1701usage 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.
1702 1853
1703=item ev_tstamp repeat [read-write] 1854=item ev_tstamp repeat [read-write]
1704 1855
1705The 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
1706or 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),
1942Signal watchers will trigger an event when the process receives a specific 2093Signal watchers will trigger an event when the process receives a specific
1943signal one or more times. Even though signals are very asynchronous, libev 2094signal one or more times. Even though signals are very asynchronous, libev
1944will 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
1945normal event processing, like any other event. 2096normal event processing, like any other event.
1946 2097
1947If you want signals asynchronously, just use C<sigaction> as you would 2098If you want signals to be delivered truly asynchronously, just use
1948do without libev and forget about sharing the signal. You can even use 2099C<sigaction> as you would do without libev and forget about sharing
1949C<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.
1950 2102
1951You 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
1952first watcher gets started will libev actually register a signal handler 2109When the first watcher gets started will libev actually register something
1953with 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
1954you don't register any with libev for the same signal). Similarly, when 2111you don't register any with libev for the same signal).
1955the last signal watcher for a signal is stopped, libev will reset the 2112
1956signal 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.
1957 2117
1958If possible and supported, libev will install its handlers with 2118If possible and supported, libev will install its handlers with
1959C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2119C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1960interrupted. If you have a problem with system calls getting interrupted by 2120not be unduly interrupted. If you have a problem with system calls getting
1961signals 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
1962them in an C<ev_prepare> watcher. 2122and unblock them in an C<ev_prepare> watcher.
1963 2123
1964=head3 Watcher-Specific Functions and Data Members 2124=head3 Watcher-Specific Functions and Data Members
1965 2125
1966=over 4 2126=over 4
1967 2127
1999some child status changes (most typically when a child of yours dies or 2159some child status changes (most typically when a child of yours dies or
2000exits). It is permissible to install a child watcher I<after> the child 2160exits). It is permissible to install a child watcher I<after> the child
2001has been forked (which implies it might have already exited), as long 2161has been forked (which implies it might have already exited), as long
2002as the event loop isn't entered (or is continued from a watcher), i.e., 2162as the event loop isn't entered (or is continued from a watcher), i.e.,
2003forking and then immediately registering a watcher for the child is fine, 2163forking and then immediately registering a watcher for the child is fine,
2004but forking and registering a watcher a few event loop iterations later is 2164but forking and registering a watcher a few event loop iterations later or
2005not. 2165in the next callback invocation is not.
2006 2166
2007Only the default event loop is capable of handling signals, and therefore 2167Only the default event loop is capable of handling signals, and therefore
2008you can only register child watchers in the default event loop. 2168you can only register child watchers in the default event loop.
2009 2169
2170Due to some design glitches inside libev, child watchers will always be
2171handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2172libev)
2173
2010=head3 Process Interaction 2174=head3 Process Interaction
2011 2175
2012Libev grabs C<SIGCHLD> as soon as the default event loop is 2176Libev grabs C<SIGCHLD> as soon as the default event loop is
2013initialised. This is necessary to guarantee proper behaviour even if 2177initialised. This is necessary to guarantee proper behaviour even if the
2014the first child watcher is started after the child exits. The occurrence 2178first child watcher is started after the child exits. The occurrence
2015of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2179of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2016synchronously as part of the event loop processing. Libev always reaps all 2180synchronously as part of the event loop processing. Libev always reaps all
2017children, even ones not watched. 2181children, even ones not watched.
2018 2182
2019=head3 Overriding the Built-In Processing 2183=head3 Overriding the Built-In Processing
2029=head3 Stopping the Child Watcher 2193=head3 Stopping the Child Watcher
2030 2194
2031Currently, the child watcher never gets stopped, even when the 2195Currently, the child watcher never gets stopped, even when the
2032child terminates, so normally one needs to stop the watcher in the 2196child terminates, so normally one needs to stop the watcher in the
2033callback. Future versions of libev might stop the watcher automatically 2197callback. Future versions of libev might stop the watcher automatically
2034when a child exit is detected. 2198when a child exit is detected (calling C<ev_child_stop> twice is not a
2199problem).
2035 2200
2036=head3 Watcher-Specific Functions and Data Members 2201=head3 Watcher-Specific Functions and Data Members
2037 2202
2038=over 4 2203=over 4
2039 2204
2365 // no longer anything immediate to do. 2530 // no longer anything immediate to do.
2366 } 2531 }
2367 2532
2368 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2533 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2369 ev_idle_init (idle_watcher, idle_cb); 2534 ev_idle_init (idle_watcher, idle_cb);
2370 ev_idle_start (loop, idle_cb); 2535 ev_idle_start (loop, idle_watcher);
2371 2536
2372 2537
2373=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2538=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2374 2539
2375Prepare and check watchers are usually (but not always) used in pairs: 2540Prepare and check watchers are usually (but not always) used in pairs:
2468 struct pollfd fds [nfd]; 2633 struct pollfd fds [nfd];
2469 // actual code will need to loop here and realloc etc. 2634 // actual code will need to loop here and realloc etc.
2470 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2635 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2471 2636
2472 /* the callback is illegal, but won't be called as we stop during check */ 2637 /* the callback is illegal, but won't be called as we stop during check */
2473 ev_timer_init (&tw, 0, timeout * 1e-3); 2638 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2474 ev_timer_start (loop, &tw); 2639 ev_timer_start (loop, &tw);
2475 2640
2476 // create one ev_io per pollfd 2641 // create one ev_io per pollfd
2477 for (int i = 0; i < nfd; ++i) 2642 for (int i = 0; i < nfd; ++i)
2478 { 2643 {
2708event loop blocks next and before C<ev_check> watchers are being called, 2873event loop blocks next and before C<ev_check> watchers are being called,
2709and only in the child after the fork. If whoever good citizen calling 2874and only in the child after the fork. If whoever good citizen calling
2710C<ev_default_fork> cheats and calls it in the wrong process, the fork 2875C<ev_default_fork> cheats and calls it in the wrong process, the fork
2711handlers will be invoked, too, of course. 2876handlers will be invoked, too, of course.
2712 2877
2878=head3 The special problem of life after fork - how is it possible?
2879
2880Most uses of C<fork()> consist of forking, then some simple calls to ste
2881up/change the process environment, followed by a call to C<exec()>. This
2882sequence should be handled by libev without any problems.
2883
2884This changes when the application actually wants to do event handling
2885in the child, or both parent in child, in effect "continuing" after the
2886fork.
2887
2888The default mode of operation (for libev, with application help to detect
2889forks) is to duplicate all the state in the child, as would be expected
2890when I<either> the parent I<or> the child process continues.
2891
2892When both processes want to continue using libev, then this is usually the
2893wrong result. In that case, usually one process (typically the parent) is
2894supposed to continue with all watchers in place as before, while the other
2895process typically wants to start fresh, i.e. without any active watchers.
2896
2897The cleanest and most efficient way to achieve that with libev is to
2898simply create a new event loop, which of course will be "empty", and
2899use that for new watchers. This has the advantage of not touching more
2900memory than necessary, and thus avoiding the copy-on-write, and the
2901disadvantage of having to use multiple event loops (which do not support
2902signal watchers).
2903
2904When this is not possible, or you want to use the default loop for
2905other reasons, then in the process that wants to start "fresh", call
2906C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2907the default loop will "orphan" (not stop) all registered watchers, so you
2908have to be careful not to execute code that modifies those watchers. Note
2909also that in that case, you have to re-register any signal watchers.
2910
2713=head3 Watcher-Specific Functions and Data Members 2911=head3 Watcher-Specific Functions and Data Members
2714 2912
2715=over 4 2913=over 4
2716 2914
2717=item ev_fork_init (ev_signal *, callback) 2915=item ev_fork_init (ev_signal *, callback)
3209=item Ocaml 3407=item Ocaml
3210 3408
3211Erkki Seppala has written Ocaml bindings for libev, to be found at 3409Erkki Seppala has written Ocaml bindings for libev, to be found at
3212L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3410L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3213 3411
3412=item Lua
3413
3414Brian Maher has written a partial interface to libev
3415for lua (only C<ev_io> and C<ev_timer>), to be found at
3416L<http://github.com/brimworks/lua-ev>.
3417
3214=back 3418=back
3215 3419
3216 3420
3217=head1 MACRO MAGIC 3421=head1 MACRO MAGIC
3218 3422
3384keeps libev from including F<config.h>, and it also defines dummy 3588keeps libev from including F<config.h>, and it also defines dummy
3385implementations for some libevent functions (such as logging, which is not 3589implementations for some libevent functions (such as logging, which is not
3386supported). It will also not define any of the structs usually found in 3590supported). It will also not define any of the structs usually found in
3387F<event.h> that are not directly supported by the libev core alone. 3591F<event.h> that are not directly supported by the libev core alone.
3388 3592
3389In stanbdalone mode, libev will still try to automatically deduce the 3593In standalone mode, libev will still try to automatically deduce the
3390configuration, but has to be more conservative. 3594configuration, but has to be more conservative.
3391 3595
3392=item EV_USE_MONOTONIC 3596=item EV_USE_MONOTONIC
3393 3597
3394If defined to be C<1>, libev will try to detect the availability of the 3598If defined to be C<1>, libev will try to detect the availability of the
3459be used is the winsock select). This means that it will call 3663be used is the winsock select). This means that it will call
3460C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3664C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3461it is assumed that all these functions actually work on fds, even 3665it is assumed that all these functions actually work on fds, even
3462on win32. Should not be defined on non-win32 platforms. 3666on win32. Should not be defined on non-win32 platforms.
3463 3667
3464=item EV_FD_TO_WIN32_HANDLE 3668=item EV_FD_TO_WIN32_HANDLE(fd)
3465 3669
3466If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3670If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3467file descriptors to socket handles. When not defining this symbol (the 3671file descriptors to socket handles. When not defining this symbol (the
3468default), then libev will call C<_get_osfhandle>, which is usually 3672default), then libev will call C<_get_osfhandle>, which is usually
3469correct. In some cases, programs use their own file descriptor management, 3673correct. In some cases, programs use their own file descriptor management,
3470in which case they can provide this function to map fds to socket handles. 3674in which case they can provide this function to map fds to socket handles.
3675
3676=item EV_WIN32_HANDLE_TO_FD(handle)
3677
3678If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3679using the standard C<_open_osfhandle> function. For programs implementing
3680their own fd to handle mapping, overwriting this function makes it easier
3681to do so. This can be done by defining this macro to an appropriate value.
3682
3683=item EV_WIN32_CLOSE_FD(fd)
3684
3685If programs implement their own fd to handle mapping on win32, then this
3686macro can be used to override the C<close> function, useful to unregister
3687file descriptors again. Note that the replacement function has to close
3688the underlying OS handle.
3471 3689
3472=item EV_USE_POLL 3690=item EV_USE_POLL
3473 3691
3474If defined to be C<1>, libev will compile in support for the C<poll>(2) 3692If defined to be C<1>, libev will compile in support for the C<poll>(2)
3475backend. Otherwise it will be enabled on non-win32 platforms. It 3693backend. Otherwise it will be enabled on non-win32 platforms. It
3607defined to be C<0>, then they are not. 3825defined to be C<0>, then they are not.
3608 3826
3609=item EV_MINIMAL 3827=item EV_MINIMAL
3610 3828
3611If you need to shave off some kilobytes of code at the expense of some 3829If you need to shave off some kilobytes of code at the expense of some
3612speed, define this symbol to C<1>. Currently this is used to override some 3830speed (but with the full API), define this symbol to C<1>. Currently this
3613inlining decisions, saves roughly 30% code size on amd64. It also selects a 3831is used to override some inlining decisions, saves roughly 30% code size
3614much smaller 2-heap for timer management over the default 4-heap. 3832on amd64. It also selects a much smaller 2-heap for timer management over
3833the default 4-heap.
3834
3835You can save even more by disabling watcher types you do not need
3836and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>
3837(C<-DNDEBUG>) will usually reduce code size a lot.
3838
3839Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3840provide a bare-bones event library. See C<ev.h> for details on what parts
3841of the API are still available, and do not complain if this subset changes
3842over time.
3843
3844=item EV_NSIG
3845
3846The highest supported signal number, +1 (or, the number of
3847signals): Normally, libev tries to deduce the maximum number of signals
3848automatically, but sometimes this fails, in which case it can be
3849specified. Also, using a lower number than detected (C<32> should be
3850good for about any system in existance) can save some memory, as libev
3851statically allocates some 12-24 bytes per signal number.
3615 3852
3616=item EV_PID_HASHSIZE 3853=item EV_PID_HASHSIZE
3617 3854
3618C<ev_child> watchers use a small hash table to distribute workload by 3855C<ev_child> watchers use a small hash table to distribute workload by
3619pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3856pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
3805default loop and triggering an C<ev_async> watcher from the default loop 4042default loop and triggering an C<ev_async> watcher from the default loop
3806watcher callback into the event loop interested in the signal. 4043watcher callback into the event loop interested in the signal.
3807 4044
3808=back 4045=back
3809 4046
4047=head4 THREAD LOCKING EXAMPLE
4048
4049Here is a fictitious example of how to run an event loop in a different
4050thread than where callbacks are being invoked and watchers are
4051created/added/removed.
4052
4053For a real-world example, see the C<EV::Loop::Async> perl module,
4054which uses exactly this technique (which is suited for many high-level
4055languages).
4056
4057The example uses a pthread mutex to protect the loop data, a condition
4058variable to wait for callback invocations, an async watcher to notify the
4059event loop thread and an unspecified mechanism to wake up the main thread.
4060
4061First, you need to associate some data with the event loop:
4062
4063 typedef struct {
4064 mutex_t lock; /* global loop lock */
4065 ev_async async_w;
4066 thread_t tid;
4067 cond_t invoke_cv;
4068 } userdata;
4069
4070 void prepare_loop (EV_P)
4071 {
4072 // for simplicity, we use a static userdata struct.
4073 static userdata u;
4074
4075 ev_async_init (&u->async_w, async_cb);
4076 ev_async_start (EV_A_ &u->async_w);
4077
4078 pthread_mutex_init (&u->lock, 0);
4079 pthread_cond_init (&u->invoke_cv, 0);
4080
4081 // now associate this with the loop
4082 ev_set_userdata (EV_A_ u);
4083 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4084 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4085
4086 // then create the thread running ev_loop
4087 pthread_create (&u->tid, 0, l_run, EV_A);
4088 }
4089
4090The callback for the C<ev_async> watcher does nothing: the watcher is used
4091solely to wake up the event loop so it takes notice of any new watchers
4092that might have been added:
4093
4094 static void
4095 async_cb (EV_P_ ev_async *w, int revents)
4096 {
4097 // just used for the side effects
4098 }
4099
4100The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4101protecting the loop data, respectively.
4102
4103 static void
4104 l_release (EV_P)
4105 {
4106 userdata *u = ev_userdata (EV_A);
4107 pthread_mutex_unlock (&u->lock);
4108 }
4109
4110 static void
4111 l_acquire (EV_P)
4112 {
4113 userdata *u = ev_userdata (EV_A);
4114 pthread_mutex_lock (&u->lock);
4115 }
4116
4117The event loop thread first acquires the mutex, and then jumps straight
4118into C<ev_loop>:
4119
4120 void *
4121 l_run (void *thr_arg)
4122 {
4123 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4124
4125 l_acquire (EV_A);
4126 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4127 ev_loop (EV_A_ 0);
4128 l_release (EV_A);
4129
4130 return 0;
4131 }
4132
4133Instead of invoking all pending watchers, the C<l_invoke> callback will
4134signal the main thread via some unspecified mechanism (signals? pipe
4135writes? C<Async::Interrupt>?) and then waits until all pending watchers
4136have been called (in a while loop because a) spurious wakeups are possible
4137and b) skipping inter-thread-communication when there are no pending
4138watchers is very beneficial):
4139
4140 static void
4141 l_invoke (EV_P)
4142 {
4143 userdata *u = ev_userdata (EV_A);
4144
4145 while (ev_pending_count (EV_A))
4146 {
4147 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4148 pthread_cond_wait (&u->invoke_cv, &u->lock);
4149 }
4150 }
4151
4152Now, whenever the main thread gets told to invoke pending watchers, it
4153will grab the lock, call C<ev_invoke_pending> and then signal the loop
4154thread to continue:
4155
4156 static void
4157 real_invoke_pending (EV_P)
4158 {
4159 userdata *u = ev_userdata (EV_A);
4160
4161 pthread_mutex_lock (&u->lock);
4162 ev_invoke_pending (EV_A);
4163 pthread_cond_signal (&u->invoke_cv);
4164 pthread_mutex_unlock (&u->lock);
4165 }
4166
4167Whenever you want to start/stop a watcher or do other modifications to an
4168event loop, you will now have to lock:
4169
4170 ev_timer timeout_watcher;
4171 userdata *u = ev_userdata (EV_A);
4172
4173 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4174
4175 pthread_mutex_lock (&u->lock);
4176 ev_timer_start (EV_A_ &timeout_watcher);
4177 ev_async_send (EV_A_ &u->async_w);
4178 pthread_mutex_unlock (&u->lock);
4179
4180Note that sending the C<ev_async> watcher is required because otherwise
4181an event loop currently blocking in the kernel will have no knowledge
4182about the newly added timer. By waking up the loop it will pick up any new
4183watchers in the next event loop iteration.
4184
3810=head3 COROUTINES 4185=head3 COROUTINES
3811 4186
3812Libev is very accommodating to coroutines ("cooperative threads"): 4187Libev is very accommodating to coroutines ("cooperative threads"):
3813libev fully supports nesting calls to its functions from different 4188libev fully supports nesting calls to its functions from different
3814coroutines (e.g. you can call C<ev_loop> on the same loop from two 4189coroutines (e.g. you can call C<ev_loop> on the same loop from two
3815different coroutines, and switch freely between both coroutines running the 4190different coroutines, and switch freely between both coroutines running
3816loop, as long as you don't confuse yourself). The only exception is that 4191the loop, as long as you don't confuse yourself). The only exception is
3817you must not do this from C<ev_periodic> reschedule callbacks. 4192that you must not do this from C<ev_periodic> reschedule callbacks.
3818 4193
3819Care has been taken to ensure that libev does not keep local state inside 4194Care has been taken to ensure that libev does not keep local state inside
3820C<ev_loop>, and other calls do not usually allow for coroutine switches as 4195C<ev_loop>, and other calls do not usually allow for coroutine switches as
3821they do not call any callbacks. 4196they do not call any callbacks.
3822 4197
3899way (note also that glib is the slowest event library known to man). 4274way (note also that glib is the slowest event library known to man).
3900 4275
3901There is no supported compilation method available on windows except 4276There is no supported compilation method available on windows except
3902embedding it into other applications. 4277embedding it into other applications.
3903 4278
4279Sensible signal handling is officially unsupported by Microsoft - libev
4280tries its best, but under most conditions, signals will simply not work.
4281
3904Not a libev limitation but worth mentioning: windows apparently doesn't 4282Not a libev limitation but worth mentioning: windows apparently doesn't
3905accept large writes: instead of resulting in a partial write, windows will 4283accept large writes: instead of resulting in a partial write, windows will
3906either accept everything or return C<ENOBUFS> if the buffer is too large, 4284either accept everything or return C<ENOBUFS> if the buffer is too large,
3907so make sure you only write small amounts into your sockets (less than a 4285so make sure you only write small amounts into your sockets (less than a
3908megabyte seems safe, but this apparently depends on the amount of memory 4286megabyte seems safe, but this apparently depends on the amount of memory
3912the abysmal performance of winsockets, using a large number of sockets 4290the abysmal performance of winsockets, using a large number of sockets
3913is not recommended (and not reasonable). If your program needs to use 4291is not recommended (and not reasonable). If your program needs to use
3914more than a hundred or so sockets, then likely it needs to use a totally 4292more than a hundred or so sockets, then likely it needs to use a totally
3915different implementation for windows, as libev offers the POSIX readiness 4293different implementation for windows, as libev offers the POSIX readiness
3916notification model, which cannot be implemented efficiently on windows 4294notification model, which cannot be implemented efficiently on windows
3917(Microsoft monopoly games). 4295(due to Microsoft monopoly games).
3918 4296
3919A typical way to use libev under windows is to embed it (see the embedding 4297A typical way to use libev under windows is to embed it (see the embedding
3920section for details) and use the following F<evwrap.h> header file instead 4298section for details) and use the following F<evwrap.h> header file instead
3921of F<ev.h>: 4299of F<ev.h>:
3922 4300
3958 4336
3959Early versions of winsocket's select only supported waiting for a maximum 4337Early versions of winsocket's select only supported waiting for a maximum
3960of C<64> handles (probably owning to the fact that all windows kernels 4338of C<64> handles (probably owning to the fact that all windows kernels
3961can only wait for C<64> things at the same time internally; Microsoft 4339can only wait for C<64> things at the same time internally; Microsoft
3962recommends spawning a chain of threads and wait for 63 handles and the 4340recommends spawning a chain of threads and wait for 63 handles and the
3963previous thread in each. Great). 4341previous thread in each. Sounds great!).
3964 4342
3965Newer versions support more handles, but you need to define C<FD_SETSIZE> 4343Newer versions support more handles, but you need to define C<FD_SETSIZE>
3966to some high number (e.g. C<2048>) before compiling the winsocket select 4344to some high number (e.g. C<2048>) before compiling the winsocket select
3967call (which might be in libev or elsewhere, for example, perl does its own 4345call (which might be in libev or elsewhere, for example, perl and many
3968select emulation on windows). 4346other interpreters do their own select emulation on windows).
3969 4347
3970Another limit is the number of file descriptors in the Microsoft runtime 4348Another limit is the number of file descriptors in the Microsoft runtime
3971libraries, which by default is C<64> (there must be a hidden I<64> fetish 4349libraries, which by default is C<64> (there must be a hidden I<64>
3972or something like this inside Microsoft). You can increase this by calling 4350fetish or something like this inside Microsoft). You can increase this
3973C<_setmaxstdio>, which can increase this limit to C<2048> (another 4351by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3974arbitrary limit), but is broken in many versions of the Microsoft runtime 4352(another arbitrary limit), but is broken in many versions of the Microsoft
3975libraries.
3976
3977This might get you to about C<512> or C<2048> sockets (depending on 4353runtime libraries. This might get you to about C<512> or C<2048> sockets
3978windows version and/or the phase of the moon). To get more, you need to 4354(depending on windows version and/or the phase of the moon). To get more,
3979wrap all I/O functions and provide your own fd management, but the cost of 4355you need to wrap all I/O functions and provide your own fd management, but
3980calling select (O(n²)) will likely make this unworkable. 4356the cost of calling select (O(n²)) will likely make this unworkable.
3981 4357
3982=back 4358=back
3983 4359
3984=head2 PORTABILITY REQUIREMENTS 4360=head2 PORTABILITY REQUIREMENTS
3985 4361
4028=item C<double> must hold a time value in seconds with enough accuracy 4404=item C<double> must hold a time value in seconds with enough accuracy
4029 4405
4030The type C<double> is used to represent timestamps. It is required to 4406The type C<double> is used to represent timestamps. It is required to
4031have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4407have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4032enough for at least into the year 4000. This requirement is fulfilled by 4408enough for at least into the year 4000. This requirement is fulfilled by
4033implementations implementing IEEE 754 (basically all existing ones). 4409implementations implementing IEEE 754, which is basically all existing
4410ones. With IEEE 754 doubles, you get microsecond accuracy until at least
44112200.
4034 4412
4035=back 4413=back
4036 4414
4037If you know of other additional requirements drop me a note. 4415If you know of other additional requirements drop me a note.
4038 4416

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines