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

Comparing libev/ev.pod (file contents):
Revision 1.200 by root, Thu Oct 23 07:33:45 2008 UTC vs.
Revision 1.212 by root, Mon Nov 3 15:13:53 2008 UTC

298If you don't know what event loop to use, use the one returned from this 298If you don't know what event loop to use, use the one returned from this
299function. 299function.
300 300
301Note that this function is I<not> thread-safe, so if you want to use it 301Note that this function is I<not> thread-safe, so if you want to use it
302from multiple threads, you have to lock (note also that this is unlikely, 302from multiple threads, you have to lock (note also that this is unlikely,
303as loops cannot bes hared easily between threads anyway). 303as loops cannot be shared easily between threads anyway).
304 304
305The default loop is the only loop that can handle C<ev_signal> and 305The default loop is the only loop that can handle C<ev_signal> and
306C<ev_child> watchers, and to do this, it always registers a handler 306C<ev_child> watchers, and to do this, it always registers a handler
307for C<SIGCHLD>. If this is a problem for your application you can either 307for C<SIGCHLD>. If this is a problem for your application you can either
308create a dynamic loop with C<ev_loop_new> that doesn't do that, or you 308create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
384=item C<EVBACKEND_EPOLL> (value 4, Linux) 384=item C<EVBACKEND_EPOLL> (value 4, Linux)
385 385
386For few fds, this backend is a bit little slower than poll and select, 386For few fds, this backend is a bit little slower than poll and select,
387but it scales phenomenally better. While poll and select usually scale 387but it scales phenomenally better. While poll and select usually scale
388like O(total_fds) where n is the total number of fds (or the highest fd), 388like O(total_fds) where n is the total number of fds (or the highest fd),
389epoll scales either O(1) or O(active_fds). The epoll design has a number 389epoll scales either O(1) or O(active_fds).
390of shortcomings, such as silently dropping events in some hard-to-detect 390
391cases and requiring a system call per fd change, no fork support and bad 391The epoll mechanism deserves honorable mention as the most misdesigned
392support for dup. 392of the more advanced event mechanisms: mere annoyances include silently
393dropping file descriptors, requiring a system call per change per file
394descriptor (and unnecessary guessing of parameters), problems with dup and
395so on. The biggest issue is fork races, however - if a program forks then
396I<both> parent and child process have to recreate the epoll set, which can
397take considerable time (one syscall per file descriptor) and is of course
398hard to detect.
399
400Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
401of course I<doesn't>, and epoll just loves to report events for totally
402I<different> file descriptors (even already closed ones, so one cannot
403even remove them from the set) than registered in the set (especially
404on SMP systems). Libev tries to counter these spurious notifications by
405employing an additional generation counter and comparing that against the
406events to filter out spurious ones, recreating the set when required.
393 407
394While stopping, setting and starting an I/O watcher in the same iteration 408While stopping, setting and starting an I/O watcher in the same iteration
395will result in some caching, there is still a system call per such incident 409will result in some caching, there is still a system call per such
396(because the fd could point to a different file description now), so its 410incident (because the same I<file descriptor> could point to a different
397best to avoid that. Also, C<dup ()>'ed file descriptors might not work 411I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
398very well if you register events for both fds. 412file descriptors might not work very well if you register events for both
399 413file descriptors.
400Please note that epoll sometimes generates spurious notifications, so you
401need to use non-blocking I/O or other means to avoid blocking when no data
402(or space) is available.
403 414
404Best performance from this backend is achieved by not unregistering all 415Best performance from this backend is achieved by not unregistering all
405watchers for a file descriptor until it has been closed, if possible, 416watchers for a file descriptor until it has been closed, if possible,
406i.e. keep at least one watcher active per fd at all times. Stopping and 417i.e. keep at least one watcher active per fd at all times. Stopping and
407starting a watcher (without re-setting it) also usually doesn't cause 418starting a watcher (without re-setting it) also usually doesn't cause
408extra overhead. 419extra overhead. A fork can both result in spurious notifications as well
420as in libev having to destroy and recreate the epoll object, which can
421take considerable time and thus should be avoided.
409 422
410While nominally embeddable in other event loops, this feature is broken in 423While nominally embeddable in other event loops, this feature is broken in
411all kernel versions tested so far. 424all kernel versions tested so far.
412 425
413This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 426This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
414C<EVBACKEND_POLL>. 427C<EVBACKEND_POLL>.
415 428
416=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 429=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
417 430
418Kqueue deserves special mention, as at the time of this writing, it was 431Kqueue deserves special mention, as at the time of this writing, it
419broken on all BSDs except NetBSD (usually it doesn't work reliably with 432was broken on all BSDs except NetBSD (usually it doesn't work reliably
420anything but sockets and pipes, except on Darwin, where of course it's 433with anything but sockets and pipes, except on Darwin, where of course
421completely useless). For this reason it's not being "auto-detected" unless 434it's completely useless). Unlike epoll, however, whose brokenness
422you explicitly specify it in the flags (i.e. using C<EVBACKEND_KQUEUE>) or 435is by design, these kqueue bugs can (and eventually will) be fixed
423libev was compiled on a known-to-be-good (-enough) system like NetBSD. 436without API changes to existing programs. For this reason it's not being
437"auto-detected" unless you explicitly specify it in the flags (i.e. using
438C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
439system like NetBSD.
424 440
425You still can embed kqueue into a normal poll or select backend and use it 441You still can embed kqueue into a normal poll or select backend and use it
426only for sockets (after having made sure that sockets work with kqueue on 442only for sockets (after having made sure that sockets work with kqueue on
427the target platform). See C<ev_embed> watchers for more info. 443the target platform). See C<ev_embed> watchers for more info.
428 444
429It scales in the same way as the epoll backend, but the interface to the 445It scales in the same way as the epoll backend, but the interface to the
430kernel is more efficient (which says nothing about its actual speed, of 446kernel is more efficient (which says nothing about its actual speed, of
431course). While stopping, setting and starting an I/O watcher does never 447course). While stopping, setting and starting an I/O watcher does never
432cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 448cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
433two event changes per incident. Support for C<fork ()> is very bad and it 449two event changes per incident. Support for C<fork ()> is very bad (but
434drops fds silently in similarly hard-to-detect cases. 450sane, unlike epoll) and it drops fds silently in similarly hard-to-detect
451cases
435 452
436This backend usually performs well under most conditions. 453This backend usually performs well under most conditions.
437 454
438While nominally embeddable in other event loops, this doesn't work 455While nominally embeddable in other event loops, this doesn't work
439everywhere, so you might need to test for this. And since it is broken 456everywhere, so you might need to test for this. And since it is broken
468might perform better. 485might perform better.
469 486
470On the positive side, with the exception of the spurious readiness 487On the positive side, with the exception of the spurious readiness
471notifications, this backend actually performed fully to specification 488notifications, this backend actually performed fully to specification
472in all tests and is fully embeddable, which is a rare feat among the 489in all tests and is fully embeddable, which is a rare feat among the
473OS-specific backends. 490OS-specific backends (I vastly prefer correctness over speed hacks).
474 491
475This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 492This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
476C<EVBACKEND_POLL>. 493C<EVBACKEND_POLL>.
477 494
478=item C<EVBACKEND_ALL> 495=item C<EVBACKEND_ALL>
531responsibility to either stop all watchers cleanly yourself I<before> 548responsibility to either stop all watchers cleanly yourself I<before>
532calling this function, or cope with the fact afterwards (which is usually 549calling this function, or cope with the fact afterwards (which is usually
533the easiest thing, you can just ignore the watchers and/or C<free ()> them 550the easiest thing, you can just ignore the watchers and/or C<free ()> them
534for example). 551for example).
535 552
536Note that certain global state, such as signal state, will not be freed by 553Note that certain global state, such as signal state (and installed signal
537this function, and related watchers (such as signal and child watchers) 554handlers), will not be freed by this function, and related watchers (such
538would need to be stopped manually. 555as signal and child watchers) would need to be stopped manually.
539 556
540In general it is not advisable to call this function except in the 557In general it is not advisable to call this function except in the
541rare occasion where you really need to free e.g. the signal handling 558rare occasion where you really need to free e.g. the signal handling
542pipe fds. If you need dynamically allocated loops it is better to use 559pipe fds. If you need dynamically allocated loops it is better to use
543C<ev_loop_new> and C<ev_loop_destroy>). 560C<ev_loop_new> and C<ev_loop_destroy>).
635the loop. 652the loop.
636 653
637A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if 654A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
638necessary) and will handle those and any already outstanding ones. It 655necessary) and will handle those and any already outstanding ones. It
639will block your process until at least one new event arrives (which could 656will block your process until at least one new event arrives (which could
640be an event internal to libev itself, so there is no guarentee that a 657be an event internal to libev itself, so there is no guarantee that a
641user-registered callback will be called), and will return after one 658user-registered callback will be called), and will return after one
642iteration of the loop. 659iteration of the loop.
643 660
644This is useful if you are waiting for some external event in conjunction 661This is useful if you are waiting for some external event in conjunction
645with something not expressible using other libev watchers (i.e. "roll your 662with something not expressible using other libev watchers (i.e. "roll your
1043The default priority used by watchers when no priority has been set is 1060The default priority used by watchers when no priority has been set is
1044always C<0>, which is supposed to not be too high and not be too low :). 1061always C<0>, which is supposed to not be too high and not be too low :).
1045 1062
1046Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1063Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1047fine, as long as you do not mind that the priority value you query might 1064fine, as long as you do not mind that the priority value you query might
1048or might not have been adjusted to be within valid range. 1065or might not have been clamped to the valid range.
1049 1066
1050=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1067=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1051 1068
1052Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1069Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1053C<loop> nor C<revents> need to be valid as long as the watcher callback 1070C<loop> nor C<revents> need to be valid as long as the watcher callback
1910 1927
1911 1928
1912=head2 C<ev_stat> - did the file attributes just change? 1929=head2 C<ev_stat> - did the file attributes just change?
1913 1930
1914This watches a file system path for attribute changes. That is, it calls 1931This watches a file system path for attribute changes. That is, it calls
1915C<stat> regularly (or when the OS says it changed) and sees if it changed 1932C<stat> on that path in regular intervals (or when the OS says it changed)
1916compared to the last time, invoking the callback if it did. 1933and sees if it changed compared to the last time, invoking the callback if
1934it did.
1917 1935
1918The path does not need to exist: changing from "path exists" to "path does 1936The path does not need to exist: changing from "path exists" to "path does
1919not exist" is a status change like any other. The condition "path does 1937not exist" is a status change like any other. The condition "path does not
1920not exist" is signified by the C<st_nlink> field being zero (which is 1938exist" (or more correctly "path cannot be stat'ed") is signified by the
1921otherwise always forced to be at least one) and all the other fields of 1939C<st_nlink> field being zero (which is otherwise always forced to be at
1922the stat buffer having unspecified contents. 1940least one) and all the other fields of the stat buffer having unspecified
1941contents.
1923 1942
1924The path I<should> be absolute and I<must not> end in a slash. If it is 1943The path I<must not> end in a slash or contain special components such as
1944C<.> or C<..>. The path I<should> be absolute: If it is relative and
1925relative and your working directory changes, the behaviour is undefined. 1945your working directory changes, then the behaviour is undefined.
1926 1946
1927Since there is no standard kernel interface to do this, the portable 1947Since there is no portable change notification interface available, the
1928implementation simply calls C<stat (2)> regularly on the path to see if 1948portable implementation simply calls C<stat(2)> regularly on the path
1929it changed somehow. You can specify a recommended polling interval for 1949to see if it changed somehow. You can specify a recommended polling
1930this case. If you specify a polling interval of C<0> (highly recommended!) 1950interval for this case. If you specify a polling interval of C<0> (highly
1931then a I<suitable, unspecified default> value will be used (which 1951recommended!) then a I<suitable, unspecified default> value will be used
1932you can expect to be around five seconds, although this might change 1952(which you can expect to be around five seconds, although this might
1933dynamically). Libev will also impose a minimum interval which is currently 1953change dynamically). Libev will also impose a minimum interval which is
1934around C<0.1>, but thats usually overkill. 1954currently around C<0.1>, but that's usually overkill.
1935 1955
1936This watcher type is not meant for massive numbers of stat watchers, 1956This watcher type is not meant for massive numbers of stat watchers,
1937as even with OS-supported change notifications, this can be 1957as even with OS-supported change notifications, this can be
1938resource-intensive. 1958resource-intensive.
1939 1959
1940At the time of this writing, the only OS-specific interface implemented 1960At the time of this writing, the only OS-specific interface implemented
1941is the Linux inotify interface (implementing kqueue support is left as 1961is the Linux inotify interface (implementing kqueue support is left as an
1942an exercise for the reader. Note, however, that the author sees no way 1962exercise for the reader. Note, however, that the author sees no way of
1943of implementing C<ev_stat> semantics with kqueue). 1963implementing C<ev_stat> semantics with kqueue, except as a hint).
1944 1964
1945=head3 ABI Issues (Largefile Support) 1965=head3 ABI Issues (Largefile Support)
1946 1966
1947Libev by default (unless the user overrides this) uses the default 1967Libev by default (unless the user overrides this) uses the default
1948compilation environment, which means that on systems with large file 1968compilation environment, which means that on systems with large file
1949support disabled by default, you get the 32 bit version of the stat 1969support disabled by default, you get the 32 bit version of the stat
1950structure. When using the library from programs that change the ABI to 1970structure. When using the library from programs that change the ABI to
1951use 64 bit file offsets the programs will fail. In that case you have to 1971use 64 bit file offsets the programs will fail. In that case you have to
1952compile libev with the same flags to get binary compatibility. This is 1972compile libev with the same flags to get binary compatibility. This is
1953obviously the case with any flags that change the ABI, but the problem is 1973obviously the case with any flags that change the ABI, but the problem is
1954most noticeably disabled with ev_stat and large file support. 1974most noticeably displayed with ev_stat and large file support.
1955 1975
1956The solution for this is to lobby your distribution maker to make large 1976The solution for this is to lobby your distribution maker to make large
1957file interfaces available by default (as e.g. FreeBSD does) and not 1977file interfaces available by default (as e.g. FreeBSD does) and not
1958optional. Libev cannot simply switch on large file support because it has 1978optional. Libev cannot simply switch on large file support because it has
1959to exchange stat structures with application programs compiled using the 1979to exchange stat structures with application programs compiled using the
1960default compilation environment. 1980default compilation environment.
1961 1981
1962=head3 Inotify and Kqueue 1982=head3 Inotify and Kqueue
1963 1983
1964When C<inotify (7)> support has been compiled into libev (generally 1984When C<inotify (7)> support has been compiled into libev and present at
1965only available with Linux 2.6.25 or above due to bugs in earlier 1985runtime, it will be used to speed up change detection where possible. The
1966implementations) and present at runtime, it will be used to speed up 1986inotify descriptor will be created lazily when the first C<ev_stat>
1967change detection where possible. The inotify descriptor will be created 1987watcher is being started.
1968lazily when the first C<ev_stat> watcher is being started.
1969 1988
1970Inotify presence does not change the semantics of C<ev_stat> watchers 1989Inotify presence does not change the semantics of C<ev_stat> watchers
1971except that changes might be detected earlier, and in some cases, to avoid 1990except that changes might be detected earlier, and in some cases, to avoid
1972making regular C<stat> calls. Even in the presence of inotify support 1991making regular C<stat> calls. Even in the presence of inotify support
1973there are many cases where libev has to resort to regular C<stat> polling, 1992there are many cases where libev has to resort to regular C<stat> polling,
1974but as long as the path exists, libev usually gets away without polling. 1993but as long as kernel 2.6.25 or newer is used (2.6.24 and older have too
1994many bugs), the path exists (i.e. stat succeeds), and the path resides on
1995a local filesystem (libev currently assumes only ext2/3, jfs, reiserfs and
1996xfs are fully working) libev usually gets away without polling.
1975 1997
1976There is no support for kqueue, as apparently it cannot be used to 1998There is no support for kqueue, as apparently it cannot be used to
1977implement this functionality, due to the requirement of having a file 1999implement this functionality, due to the requirement of having a file
1978descriptor open on the object at all times, and detecting renames, unlinks 2000descriptor open on the object at all times, and detecting renames, unlinks
1979etc. is difficult. 2001etc. is difficult.
1980 2002
2003=head3 C<stat ()> is a synchronous operation
2004
2005Libev doesn't normally do any kind of I/O itself, and so is not blocking
2006the process. The exception are C<ev_stat> watchers - those call C<stat
2007()>, which is a synchronous operation.
2008
2009For local paths, this usually doesn't matter: unless the system is very
2010busy or the intervals between stat's are large, a stat call will be fast,
2011as the path data is suually in memory already (except when starting the
2012watcher).
2013
2014For networked file systems, calling C<stat ()> can block an indefinite
2015time due to network issues, and even under good conditions, a stat call
2016often takes multiple milliseconds.
2017
2018Therefore, it is best to avoid using C<ev_stat> watchers on networked
2019paths, although this is fully supported by libev.
2020
1981=head3 The special problem of stat time resolution 2021=head3 The special problem of stat time resolution
1982 2022
1983The C<stat ()> system call only supports full-second resolution portably, and 2023The C<stat ()> system call only supports full-second resolution portably,
1984even on systems where the resolution is higher, most file systems still 2024and even on systems where the resolution is higher, most file systems
1985only support whole seconds. 2025still only support whole seconds.
1986 2026
1987That means that, if the time is the only thing that changes, you can 2027That means that, if the time is the only thing that changes, you can
1988easily miss updates: on the first update, C<ev_stat> detects a change and 2028easily miss updates: on the first update, C<ev_stat> detects a change and
1989calls your callback, which does something. When there is another update 2029calls your callback, which does something. When there is another update
1990within the same second, C<ev_stat> will be unable to detect unless the 2030within the same second, C<ev_stat> will be unable to detect unless the
2629=over 4 2669=over 4
2630 2670
2631=item ev_async_init (ev_async *, callback) 2671=item ev_async_init (ev_async *, callback)
2632 2672
2633Initialises and configures the async watcher - it has no parameters of any 2673Initialises and configures the async watcher - it has no parameters of any
2634kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, 2674kind. There is a C<ev_async_set> macro, but using it is utterly pointless,
2635trust me. 2675trust me.
2636 2676
2637=item ev_async_send (loop, ev_async *) 2677=item ev_async_send (loop, ev_async *)
2638 2678
2639Sends/signals/activates the given C<ev_async> watcher, that is, feeds 2679Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2958=item D 2998=item D
2959 2999
2960Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 3000Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2961be found at L<http://proj.llucax.com.ar/wiki/evd>. 3001be found at L<http://proj.llucax.com.ar/wiki/evd>.
2962 3002
3003=item Ocaml
3004
3005Erkki Seppala has written Ocaml bindings for libev, to be found at
3006L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3007
2963=back 3008=back
2964 3009
2965 3010
2966=head1 MACRO MAGIC 3011=head1 MACRO MAGIC
2967 3012
3067 3112
3068 #define EV_STANDALONE 1 3113 #define EV_STANDALONE 1
3069 #include "ev.h" 3114 #include "ev.h"
3070 3115
3071Both header files and implementation files can be compiled with a C++ 3116Both header files and implementation files can be compiled with a C++
3072compiler (at least, thats a stated goal, and breakage will be treated 3117compiler (at least, that's a stated goal, and breakage will be treated
3073as a bug). 3118as a bug).
3074 3119
3075You need the following files in your source tree, or in a directory 3120You need the following files in your source tree, or in a directory
3076in your include path (e.g. in libev/ when using -Ilibev): 3121in your include path (e.g. in libev/ when using -Ilibev):
3077 3122
3549loop, as long as you don't confuse yourself). The only exception is that 3594loop, as long as you don't confuse yourself). The only exception is that
3550you must not do this from C<ev_periodic> reschedule callbacks. 3595you must not do this from C<ev_periodic> reschedule callbacks.
3551 3596
3552Care has been taken to ensure that libev does not keep local state inside 3597Care has been taken to ensure that libev does not keep local state inside
3553C<ev_loop>, and other calls do not usually allow for coroutine switches as 3598C<ev_loop>, and other calls do not usually allow for coroutine switches as
3554they do not clal any callbacks. 3599they do not call any callbacks.
3555 3600
3556=head2 COMPILER WARNINGS 3601=head2 COMPILER WARNINGS
3557 3602
3558Depending on your compiler and compiler settings, you might get no or a 3603Depending on your compiler and compiler settings, you might get no or a
3559lot of warnings when compiling libev code. Some people are apparently 3604lot of warnings when compiling libev code. Some people are apparently
3593 ==2274== definitely lost: 0 bytes in 0 blocks. 3638 ==2274== definitely lost: 0 bytes in 0 blocks.
3594 ==2274== possibly lost: 0 bytes in 0 blocks. 3639 ==2274== possibly lost: 0 bytes in 0 blocks.
3595 ==2274== still reachable: 256 bytes in 1 blocks. 3640 ==2274== still reachable: 256 bytes in 1 blocks.
3596 3641
3597Then there is no memory leak, just as memory accounted to global variables 3642Then there is no memory leak, just as memory accounted to global variables
3598is not a memleak - the memory is still being refernced, and didn't leak. 3643is not a memleak - the memory is still being referenced, and didn't leak.
3599 3644
3600Similarly, under some circumstances, valgrind might report kernel bugs 3645Similarly, under some circumstances, valgrind might report kernel bugs
3601as if it were a bug in libev (e.g. in realloc or in the poll backend, 3646as if it were a bug in libev (e.g. in realloc or in the poll backend,
3602although an acceptable workaround has been found here), or it might be 3647although an acceptable workaround has been found here), or it might be
3603confused. 3648confused.
3841=back 3886=back
3842 3887
3843 3888
3844=head1 AUTHOR 3889=head1 AUTHOR
3845 3890
3846Marc Lehmann <libev@schmorp.de>. 3891Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.
3847 3892

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines