| … | |
… | |
| 298 | If you don't know what event loop to use, use the one returned from this |
298 | If you don't know what event loop to use, use the one returned from this |
| 299 | function. |
299 | function. |
| 300 | |
300 | |
| 301 | Note that this function is I<not> thread-safe, so if you want to use it |
301 | Note that this function is I<not> thread-safe, so if you want to use it |
| 302 | from multiple threads, you have to lock (note also that this is unlikely, |
302 | from multiple threads, you have to lock (note also that this is unlikely, |
| 303 | as loops cannot bes hared easily between threads anyway). |
303 | as loops cannot be shared easily between threads anyway). |
| 304 | |
304 | |
| 305 | The default loop is the only loop that can handle C<ev_signal> and |
305 | The default loop is the only loop that can handle C<ev_signal> and |
| 306 | C<ev_child> watchers, and to do this, it always registers a handler |
306 | C<ev_child> watchers, and to do this, it always registers a handler |
| 307 | for C<SIGCHLD>. If this is a problem for your application you can either |
307 | for C<SIGCHLD>. If this is a problem for your application you can either |
| 308 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
308 | create 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 | |
| 386 | For few fds, this backend is a bit little slower than poll and select, |
386 | For few fds, this backend is a bit little slower than poll and select, |
| 387 | but it scales phenomenally better. While poll and select usually scale |
387 | but it scales phenomenally better. While poll and select usually scale |
| 388 | like O(total_fds) where n is the total number of fds (or the highest fd), |
388 | like O(total_fds) where n is the total number of fds (or the highest fd), |
| 389 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
389 | epoll scales either O(1) or O(active_fds). |
| 390 | of shortcomings, such as silently dropping events in some hard-to-detect |
390 | |
| 391 | cases and requiring a system call per fd change, no fork support and bad |
391 | The epoll syscalls are the most misdesigned of the more advanced event |
| 392 | support for dup. |
392 | mechanisms: problems include silently dropping fds, requiring a system |
|
|
393 | call per change per fd (and unnecessary guessing of parameters), problems |
|
|
394 | with dup and so on. The biggest issue is fork races, however - if a |
|
|
395 | program forks then I<both> parent and child process have to recreate the |
|
|
396 | epoll set, which can take considerable time (one syscall per fd) and is of |
|
|
397 | course hard to detect. |
| 393 | |
398 | |
| 394 | Epoll is also notoriously buggy - embedding epoll fds should work, but |
399 | Epoll is also notoriously buggy - embedding epoll fds should work, but |
| 395 | of course doesn't, and epoll just loves to report events for totally |
400 | of course doesn't, and epoll just loves to report events for totally |
| 396 | I<different> file descriptors (even already closed ones) than registered |
401 | I<different> file descriptors (even already closed ones, so one cannot |
| 397 | in the set (especially on SMP systems). Libev tries to counter these |
402 | even remove them from the set) than registered in the set (especially |
| 398 | spurious notifications by employing an additional generation counter and |
403 | on SMP systems). Libev tries to counter these spurious notifications by |
| 399 | comparing that against the events to filter out spurious ones. |
404 | employing an additional generation counter and comparing that against the |
|
|
405 | events to filter out spurious ones. |
| 400 | |
406 | |
| 401 | While stopping, setting and starting an I/O watcher in the same iteration |
407 | While stopping, setting and starting an I/O watcher in the same iteration |
| 402 | will result in some caching, there is still a system call per such incident |
408 | will result in some caching, there is still a system call per such incident |
| 403 | (because the fd could point to a different file description now), so its |
409 | (because the fd could point to a different file description now), so its |
| 404 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
410 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
| … | |
… | |
| 406 | |
412 | |
| 407 | Best performance from this backend is achieved by not unregistering all |
413 | Best performance from this backend is achieved by not unregistering all |
| 408 | watchers for a file descriptor until it has been closed, if possible, |
414 | watchers for a file descriptor until it has been closed, if possible, |
| 409 | i.e. keep at least one watcher active per fd at all times. Stopping and |
415 | i.e. keep at least one watcher active per fd at all times. Stopping and |
| 410 | starting a watcher (without re-setting it) also usually doesn't cause |
416 | starting a watcher (without re-setting it) also usually doesn't cause |
| 411 | extra overhead. |
417 | extra overhead. A fork can both result in spurious notifications as well |
|
|
418 | as in libev having to destroy and recreate the epoll object, which can |
|
|
419 | take considerable time and thus should be avoided. |
| 412 | |
420 | |
| 413 | While nominally embeddable in other event loops, this feature is broken in |
421 | While nominally embeddable in other event loops, this feature is broken in |
| 414 | all kernel versions tested so far. |
422 | all kernel versions tested so far. |
| 415 | |
423 | |
| 416 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
424 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
| … | |
… | |
| 431 | |
439 | |
| 432 | It scales in the same way as the epoll backend, but the interface to the |
440 | It scales in the same way as the epoll backend, but the interface to the |
| 433 | kernel is more efficient (which says nothing about its actual speed, of |
441 | kernel is more efficient (which says nothing about its actual speed, of |
| 434 | course). While stopping, setting and starting an I/O watcher does never |
442 | course). While stopping, setting and starting an I/O watcher does never |
| 435 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
443 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
| 436 | two event changes per incident. Support for C<fork ()> is very bad and it |
444 | two event changes per incident. Support for C<fork ()> is very bad (but |
| 437 | drops fds silently in similarly hard-to-detect cases. |
445 | sane, unlike epoll) and it drops fds silently in similarly hard-to-detect |
|
|
446 | cases |
| 438 | |
447 | |
| 439 | This backend usually performs well under most conditions. |
448 | This backend usually performs well under most conditions. |
| 440 | |
449 | |
| 441 | While nominally embeddable in other event loops, this doesn't work |
450 | While nominally embeddable in other event loops, this doesn't work |
| 442 | everywhere, so you might need to test for this. And since it is broken |
451 | everywhere, so you might need to test for this. And since it is broken |
| … | |
… | |
| 471 | might perform better. |
480 | might perform better. |
| 472 | |
481 | |
| 473 | On the positive side, with the exception of the spurious readiness |
482 | On the positive side, with the exception of the spurious readiness |
| 474 | notifications, this backend actually performed fully to specification |
483 | notifications, this backend actually performed fully to specification |
| 475 | in all tests and is fully embeddable, which is a rare feat among the |
484 | in all tests and is fully embeddable, which is a rare feat among the |
| 476 | OS-specific backends. |
485 | OS-specific backends (I vastly prefer correctness over speed hacks). |
| 477 | |
486 | |
| 478 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
487 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
| 479 | C<EVBACKEND_POLL>. |
488 | C<EVBACKEND_POLL>. |
| 480 | |
489 | |
| 481 | =item C<EVBACKEND_ALL> |
490 | =item C<EVBACKEND_ALL> |
| … | |
… | |
| 638 | the loop. |
647 | the loop. |
| 639 | |
648 | |
| 640 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
649 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
| 641 | necessary) and will handle those and any already outstanding ones. It |
650 | necessary) and will handle those and any already outstanding ones. It |
| 642 | will block your process until at least one new event arrives (which could |
651 | will block your process until at least one new event arrives (which could |
| 643 | be an event internal to libev itself, so there is no guarentee that a |
652 | be an event internal to libev itself, so there is no guarantee that a |
| 644 | user-registered callback will be called), and will return after one |
653 | user-registered callback will be called), and will return after one |
| 645 | iteration of the loop. |
654 | iteration of the loop. |
| 646 | |
655 | |
| 647 | This is useful if you are waiting for some external event in conjunction |
656 | This is useful if you are waiting for some external event in conjunction |
| 648 | with something not expressible using other libev watchers (i.e. "roll your |
657 | with something not expressible using other libev watchers (i.e. "roll your |
| … | |
… | |
| 1913 | |
1922 | |
| 1914 | |
1923 | |
| 1915 | =head2 C<ev_stat> - did the file attributes just change? |
1924 | =head2 C<ev_stat> - did the file attributes just change? |
| 1916 | |
1925 | |
| 1917 | This watches a file system path for attribute changes. That is, it calls |
1926 | This watches a file system path for attribute changes. That is, it calls |
| 1918 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
1927 | C<stat> on that path in regular intervals (or when the OS says it changed) |
| 1919 | compared to the last time, invoking the callback if it did. |
1928 | and sees if it changed compared to the last time, invoking the callback if |
|
|
1929 | it did. |
| 1920 | |
1930 | |
| 1921 | The path does not need to exist: changing from "path exists" to "path does |
1931 | The path does not need to exist: changing from "path exists" to "path does |
| 1922 | not exist" is a status change like any other. The condition "path does |
1932 | not exist" is a status change like any other. The condition "path does |
| 1923 | not exist" is signified by the C<st_nlink> field being zero (which is |
1933 | not exist" is signified by the C<st_nlink> field being zero (which is |
| 1924 | otherwise always forced to be at least one) and all the other fields of |
1934 | otherwise always forced to be at least one) and all the other fields of |
| 1925 | the stat buffer having unspecified contents. |
1935 | the stat buffer having unspecified contents. |
| 1926 | |
1936 | |
| 1927 | The path I<should> be absolute and I<must not> end in a slash. If it is |
1937 | The path I<must not> end in a slash or contain special components such as |
|
|
1938 | C<.> or C<..>. The path I<should> be absolute: If it is relative and |
| 1928 | relative and your working directory changes, the behaviour is undefined. |
1939 | your working directory changes, then the behaviour is undefined. |
| 1929 | |
1940 | |
| 1930 | Since there is no standard kernel interface to do this, the portable |
1941 | Since there is no portable change notification interface available, the |
| 1931 | implementation simply calls C<stat (2)> regularly on the path to see if |
1942 | portable implementation simply calls C<stat(2)> regularly on the path |
| 1932 | it changed somehow. You can specify a recommended polling interval for |
1943 | to see if it changed somehow. You can specify a recommended polling |
| 1933 | this case. If you specify a polling interval of C<0> (highly recommended!) |
1944 | interval for this case. If you specify a polling interval of C<0> (highly |
| 1934 | then a I<suitable, unspecified default> value will be used (which |
1945 | recommended!) then a I<suitable, unspecified default> value will be used |
| 1935 | you can expect to be around five seconds, although this might change |
1946 | (which you can expect to be around five seconds, although this might |
| 1936 | dynamically). Libev will also impose a minimum interval which is currently |
1947 | change dynamically). Libev will also impose a minimum interval which is |
| 1937 | around C<0.1>, but thats usually overkill. |
1948 | currently around C<0.1>, but that's usually overkill. |
| 1938 | |
1949 | |
| 1939 | This watcher type is not meant for massive numbers of stat watchers, |
1950 | This watcher type is not meant for massive numbers of stat watchers, |
| 1940 | as even with OS-supported change notifications, this can be |
1951 | as even with OS-supported change notifications, this can be |
| 1941 | resource-intensive. |
1952 | resource-intensive. |
| 1942 | |
1953 | |
| … | |
… | |
| 1952 | support disabled by default, you get the 32 bit version of the stat |
1963 | support disabled by default, you get the 32 bit version of the stat |
| 1953 | structure. When using the library from programs that change the ABI to |
1964 | structure. When using the library from programs that change the ABI to |
| 1954 | use 64 bit file offsets the programs will fail. In that case you have to |
1965 | use 64 bit file offsets the programs will fail. In that case you have to |
| 1955 | compile libev with the same flags to get binary compatibility. This is |
1966 | compile libev with the same flags to get binary compatibility. This is |
| 1956 | obviously the case with any flags that change the ABI, but the problem is |
1967 | obviously the case with any flags that change the ABI, but the problem is |
| 1957 | most noticeably disabled with ev_stat and large file support. |
1968 | most noticeably displayed with ev_stat and large file support. |
| 1958 | |
1969 | |
| 1959 | The solution for this is to lobby your distribution maker to make large |
1970 | The solution for this is to lobby your distribution maker to make large |
| 1960 | file interfaces available by default (as e.g. FreeBSD does) and not |
1971 | file interfaces available by default (as e.g. FreeBSD does) and not |
| 1961 | optional. Libev cannot simply switch on large file support because it has |
1972 | optional. Libev cannot simply switch on large file support because it has |
| 1962 | to exchange stat structures with application programs compiled using the |
1973 | to exchange stat structures with application programs compiled using the |
| … | |
… | |
| 1981 | descriptor open on the object at all times, and detecting renames, unlinks |
1992 | descriptor open on the object at all times, and detecting renames, unlinks |
| 1982 | etc. is difficult. |
1993 | etc. is difficult. |
| 1983 | |
1994 | |
| 1984 | =head3 The special problem of stat time resolution |
1995 | =head3 The special problem of stat time resolution |
| 1985 | |
1996 | |
| 1986 | The C<stat ()> system call only supports full-second resolution portably, and |
1997 | The C<stat ()> system call only supports full-second resolution portably, |
| 1987 | even on systems where the resolution is higher, most file systems still |
1998 | and even on systems where the resolution is higher, most file systems |
| 1988 | only support whole seconds. |
1999 | still only support whole seconds. |
| 1989 | |
2000 | |
| 1990 | That means that, if the time is the only thing that changes, you can |
2001 | That means that, if the time is the only thing that changes, you can |
| 1991 | easily miss updates: on the first update, C<ev_stat> detects a change and |
2002 | easily miss updates: on the first update, C<ev_stat> detects a change and |
| 1992 | calls your callback, which does something. When there is another update |
2003 | calls your callback, which does something. When there is another update |
| 1993 | within the same second, C<ev_stat> will be unable to detect unless the |
2004 | within the same second, C<ev_stat> will be unable to detect unless the |
| … | |
… | |
| 2632 | =over 4 |
2643 | =over 4 |
| 2633 | |
2644 | |
| 2634 | =item ev_async_init (ev_async *, callback) |
2645 | =item ev_async_init (ev_async *, callback) |
| 2635 | |
2646 | |
| 2636 | Initialises and configures the async watcher - it has no parameters of any |
2647 | Initialises and configures the async watcher - it has no parameters of any |
| 2637 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
2648 | kind. There is a C<ev_async_set> macro, but using it is utterly pointless, |
| 2638 | trust me. |
2649 | trust me. |
| 2639 | |
2650 | |
| 2640 | =item ev_async_send (loop, ev_async *) |
2651 | =item ev_async_send (loop, ev_async *) |
| 2641 | |
2652 | |
| 2642 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2653 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
| … | |
… | |
| 3075 | |
3086 | |
| 3076 | #define EV_STANDALONE 1 |
3087 | #define EV_STANDALONE 1 |
| 3077 | #include "ev.h" |
3088 | #include "ev.h" |
| 3078 | |
3089 | |
| 3079 | Both header files and implementation files can be compiled with a C++ |
3090 | Both header files and implementation files can be compiled with a C++ |
| 3080 | compiler (at least, thats a stated goal, and breakage will be treated |
3091 | compiler (at least, that's a stated goal, and breakage will be treated |
| 3081 | as a bug). |
3092 | as a bug). |
| 3082 | |
3093 | |
| 3083 | You need the following files in your source tree, or in a directory |
3094 | You need the following files in your source tree, or in a directory |
| 3084 | in your include path (e.g. in libev/ when using -Ilibev): |
3095 | in your include path (e.g. in libev/ when using -Ilibev): |
| 3085 | |
3096 | |
| … | |
… | |
| 3557 | loop, as long as you don't confuse yourself). The only exception is that |
3568 | loop, as long as you don't confuse yourself). The only exception is that |
| 3558 | you must not do this from C<ev_periodic> reschedule callbacks. |
3569 | you must not do this from C<ev_periodic> reschedule callbacks. |
| 3559 | |
3570 | |
| 3560 | Care has been taken to ensure that libev does not keep local state inside |
3571 | Care has been taken to ensure that libev does not keep local state inside |
| 3561 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3572 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
| 3562 | they do not clal any callbacks. |
3573 | they do not call any callbacks. |
| 3563 | |
3574 | |
| 3564 | =head2 COMPILER WARNINGS |
3575 | =head2 COMPILER WARNINGS |
| 3565 | |
3576 | |
| 3566 | Depending on your compiler and compiler settings, you might get no or a |
3577 | Depending on your compiler and compiler settings, you might get no or a |
| 3567 | lot of warnings when compiling libev code. Some people are apparently |
3578 | lot of warnings when compiling libev code. Some people are apparently |
| … | |
… | |
| 3601 | ==2274== definitely lost: 0 bytes in 0 blocks. |
3612 | ==2274== definitely lost: 0 bytes in 0 blocks. |
| 3602 | ==2274== possibly lost: 0 bytes in 0 blocks. |
3613 | ==2274== possibly lost: 0 bytes in 0 blocks. |
| 3603 | ==2274== still reachable: 256 bytes in 1 blocks. |
3614 | ==2274== still reachable: 256 bytes in 1 blocks. |
| 3604 | |
3615 | |
| 3605 | Then there is no memory leak, just as memory accounted to global variables |
3616 | Then there is no memory leak, just as memory accounted to global variables |
| 3606 | is not a memleak - the memory is still being refernced, and didn't leak. |
3617 | is not a memleak - the memory is still being referenced, and didn't leak. |
| 3607 | |
3618 | |
| 3608 | Similarly, under some circumstances, valgrind might report kernel bugs |
3619 | Similarly, under some circumstances, valgrind might report kernel bugs |
| 3609 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
3620 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
| 3610 | although an acceptable workaround has been found here), or it might be |
3621 | although an acceptable workaround has been found here), or it might be |
| 3611 | confused. |
3622 | confused. |
