… | |
… | |
105 | details of the event, and then hand it over to libev by I<starting> the |
105 | details of the event, and then hand it over to libev by I<starting> the |
106 | watcher. |
106 | watcher. |
107 | |
107 | |
108 | =head2 FEATURES |
108 | =head2 FEATURES |
109 | |
109 | |
110 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
110 | Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll> |
111 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
111 | interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port |
112 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
112 | mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify> |
113 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
113 | interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
114 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
114 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
115 | timers (C<ev_timer>), absolute timers with customised rescheduling |
115 | timers (C<ev_timer>), absolute timers with customised rescheduling |
116 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
116 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
117 | change events (C<ev_child>), and event watchers dealing with the event |
117 | change events (C<ev_child>), and event watchers dealing with the event |
118 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
118 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
… | |
… | |
265 | |
265 | |
266 | You could override this function in high-availability programs to, say, |
266 | You could override this function in high-availability programs to, say, |
267 | free some memory if it cannot allocate memory, to use a special allocator, |
267 | free some memory if it cannot allocate memory, to use a special allocator, |
268 | or even to sleep a while and retry until some memory is available. |
268 | or even to sleep a while and retry until some memory is available. |
269 | |
269 | |
|
|
270 | Example: The following is the C<realloc> function that libev itself uses |
|
|
271 | which should work with C<realloc> and C<free> functions of all kinds and |
|
|
272 | is probably a good basis for your own implementation. |
|
|
273 | |
|
|
274 | static void * |
|
|
275 | ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT |
|
|
276 | { |
|
|
277 | if (size) |
|
|
278 | return realloc (ptr, size); |
|
|
279 | |
|
|
280 | free (ptr); |
|
|
281 | return 0; |
|
|
282 | } |
|
|
283 | |
270 | Example: Replace the libev allocator with one that waits a bit and then |
284 | Example: Replace the libev allocator with one that waits a bit and then |
271 | retries (example requires a standards-compliant C<realloc>). |
285 | retries. |
272 | |
286 | |
273 | static void * |
287 | static void * |
274 | persistent_realloc (void *ptr, size_t size) |
288 | persistent_realloc (void *ptr, size_t size) |
275 | { |
289 | { |
|
|
290 | if (!size) |
|
|
291 | { |
|
|
292 | free (ptr); |
|
|
293 | return 0; |
|
|
294 | } |
|
|
295 | |
276 | for (;;) |
296 | for (;;) |
277 | { |
297 | { |
278 | void *newptr = realloc (ptr, size); |
298 | void *newptr = realloc (ptr, size); |
279 | |
299 | |
280 | if (newptr) |
300 | if (newptr) |
… | |
… | |
547 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
567 | All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or |
548 | faster than epoll for maybe up to a hundred file descriptors, depending on |
568 | faster than epoll for maybe up to a hundred file descriptors, depending on |
549 | the usage. So sad. |
569 | the usage. So sad. |
550 | |
570 | |
551 | While nominally embeddable in other event loops, this feature is broken in |
571 | While nominally embeddable in other event loops, this feature is broken in |
552 | all kernel versions tested so far. |
572 | a lot of kernel revisions, but probably(!) works in current versions. |
553 | |
573 | |
554 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
574 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
555 | C<EVBACKEND_POLL>. |
575 | C<EVBACKEND_POLL>. |
556 | |
576 | |
|
|
577 | =item C<EVBACKEND_LINUXAIO> (value 64, Linux) |
|
|
578 | |
|
|
579 | Use the linux-specific linux aio (I<not> C<< aio(7) >> but C<< |
|
|
580 | io_submit(2) >>) event interface available in post-4.18 kernels (but libev |
|
|
581 | only tries to use it in 4.19+). |
|
|
582 | |
|
|
583 | This is another linux trainwreck of an event interface. |
|
|
584 | |
|
|
585 | If this backend works for you (as of this writing, it was very |
|
|
586 | experimental), it is the best event interface available on linux and might |
|
|
587 | be well worth enabling it - if it isn't available in your kernel this will |
|
|
588 | be detected and this backend will be skipped. |
|
|
589 | |
|
|
590 | This backend can batch oneshot requests and supports a user-space ring |
|
|
591 | buffer to receive events. It also doesn't suffer from most of the design |
|
|
592 | problems of epoll (such as not being able to remove event sources from |
|
|
593 | the epoll set), and generally sounds too good to be true. Because, this |
|
|
594 | being the linux kernel, of course it suffers from a whole new set of |
|
|
595 | limitations, forcing you to fall back to epoll, inheriting all its design |
|
|
596 | issues. |
|
|
597 | |
|
|
598 | For one, it is not easily embeddable (but probably could be done using |
|
|
599 | an event fd at some extra overhead). It also is subject to a system wide |
|
|
600 | limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no aio |
|
|
601 | requests are left, this backend will be skipped during initialisation, and |
|
|
602 | will switch to epoll when the loop is active. |
|
|
603 | |
|
|
604 | Most problematic in practice, however, is that not all file descriptors |
|
|
605 | work with it. For example, in linux 5.1, tcp sockets, pipes, event fds, |
|
|
606 | files, F</dev/null> and a few others are supported, but ttys do not work |
|
|
607 | properly (a known bug that the kernel developers don't care about, see |
|
|
608 | L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not |
|
|
609 | (yet?) a generic event polling interface. |
|
|
610 | |
|
|
611 | Overall, it seems the linux developers just don't want it to have a |
|
|
612 | generic event handling mechanism other than C<select> or C<poll>. |
|
|
613 | |
|
|
614 | To work around all these problem, the current version of libev uses its |
|
|
615 | epoll backend as a fallback for file descriptor types that do not work. Or |
|
|
616 | falls back completely to epoll if the kernel acts up. |
|
|
617 | |
|
|
618 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
|
|
619 | C<EVBACKEND_POLL>. |
|
|
620 | |
557 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
621 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
558 | |
622 | |
559 | Kqueue deserves special mention, as at the time of this writing, it |
623 | Kqueue deserves special mention, as at the time this backend was |
560 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
624 | implemented, it was broken on all BSDs except NetBSD (usually it doesn't |
561 | with anything but sockets and pipes, except on Darwin, where of course |
625 | work reliably with anything but sockets and pipes, except on Darwin, |
562 | it's completely useless). Unlike epoll, however, whose brokenness |
626 | where of course it's completely useless). Unlike epoll, however, whose |
563 | is by design, these kqueue bugs can (and eventually will) be fixed |
627 | brokenness is by design, these kqueue bugs can be (and mostly have been) |
564 | without API changes to existing programs. For this reason it's not being |
628 | fixed without API changes to existing programs. For this reason it's not |
565 | "auto-detected" unless you explicitly specify it in the flags (i.e. using |
629 | being "auto-detected" on all platforms unless you explicitly specify it |
566 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
630 | in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a |
567 | system like NetBSD. |
631 | known-to-be-good (-enough) system like NetBSD. |
568 | |
632 | |
569 | You still can embed kqueue into a normal poll or select backend and use it |
633 | You still can embed kqueue into a normal poll or select backend and use it |
570 | only for sockets (after having made sure that sockets work with kqueue on |
634 | only for sockets (after having made sure that sockets work with kqueue on |
571 | the target platform). See C<ev_embed> watchers for more info. |
635 | the target platform). See C<ev_embed> watchers for more info. |
572 | |
636 | |
… | |
… | |
657 | |
721 | |
658 | Example: Use whatever libev has to offer, but make sure that kqueue is |
722 | Example: Use whatever libev has to offer, but make sure that kqueue is |
659 | used if available. |
723 | used if available. |
660 | |
724 | |
661 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
725 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); |
|
|
726 | |
|
|
727 | Example: Similarly, on linux, you mgiht want to take advantage of the |
|
|
728 | linux aio backend if possible, but fall back to something else if that |
|
|
729 | isn't available. |
|
|
730 | |
|
|
731 | struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO); |
662 | |
732 | |
663 | =item ev_loop_destroy (loop) |
733 | =item ev_loop_destroy (loop) |
664 | |
734 | |
665 | Destroys an event loop object (frees all memory and kernel state |
735 | Destroys an event loop object (frees all memory and kernel state |
666 | etc.). None of the active event watchers will be stopped in the normal |
736 | etc.). None of the active event watchers will be stopped in the normal |
… | |
… | |
1610 | |
1680 | |
1611 | But really, best use non-blocking mode. |
1681 | But really, best use non-blocking mode. |
1612 | |
1682 | |
1613 | =head3 The special problem of disappearing file descriptors |
1683 | =head3 The special problem of disappearing file descriptors |
1614 | |
1684 | |
1615 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1685 | Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing |
1616 | descriptor (either due to calling C<close> explicitly or any other means, |
1686 | a file descriptor (either due to calling C<close> explicitly or any other |
1617 | such as C<dup2>). The reason is that you register interest in some file |
1687 | means, such as C<dup2>). The reason is that you register interest in some |
1618 | descriptor, but when it goes away, the operating system will silently drop |
1688 | file descriptor, but when it goes away, the operating system will silently |
1619 | this interest. If another file descriptor with the same number then is |
1689 | drop this interest. If another file descriptor with the same number then |
1620 | registered with libev, there is no efficient way to see that this is, in |
1690 | is registered with libev, there is no efficient way to see that this is, |
1621 | fact, a different file descriptor. |
1691 | in fact, a different file descriptor. |
1622 | |
1692 | |
1623 | To avoid having to explicitly tell libev about such cases, libev follows |
1693 | To avoid having to explicitly tell libev about such cases, libev follows |
1624 | the following policy: Each time C<ev_io_set> is being called, libev |
1694 | the following policy: Each time C<ev_io_set> is being called, libev |
1625 | will assume that this is potentially a new file descriptor, otherwise |
1695 | will assume that this is potentially a new file descriptor, otherwise |
1626 | it is assumed that the file descriptor stays the same. That means that |
1696 | it is assumed that the file descriptor stays the same. That means that |
… | |
… | |
1675 | when you rarely read from a file instead of from a socket, and want to |
1745 | when you rarely read from a file instead of from a socket, and want to |
1676 | reuse the same code path. |
1746 | reuse the same code path. |
1677 | |
1747 | |
1678 | =head3 The special problem of fork |
1748 | =head3 The special problem of fork |
1679 | |
1749 | |
1680 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
1750 | Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()> |
1681 | useless behaviour. Libev fully supports fork, but needs to be told about |
1751 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1682 | it in the child if you want to continue to use it in the child. |
1752 | to be told about it in the child if you want to continue to use it in the |
|
|
1753 | child. |
1683 | |
1754 | |
1684 | To support fork in your child processes, you have to call C<ev_loop_fork |
1755 | To support fork in your child processes, you have to call C<ev_loop_fork |
1685 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1756 | ()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to |
1686 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1757 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
1687 | |
1758 | |
… | |
… | |
2225 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2296 | C<ev_timer>, which would still trigger roughly 10 seconds after starting |
2226 | it, as it uses a relative timeout). |
2297 | it, as it uses a relative timeout). |
2227 | |
2298 | |
2228 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2299 | C<ev_periodic> watchers can also be used to implement vastly more complex |
2229 | timers, such as triggering an event on each "midnight, local time", or |
2300 | timers, such as triggering an event on each "midnight, local time", or |
2230 | other complicated rules. This cannot be done with C<ev_timer> watchers, as |
2301 | other complicated rules. This cannot easily be done with C<ev_timer> |
2231 | those cannot react to time jumps. |
2302 | watchers, as those cannot react to time jumps. |
2232 | |
2303 | |
2233 | As with timers, the callback is guaranteed to be invoked only when the |
2304 | As with timers, the callback is guaranteed to be invoked only when the |
2234 | point in time where it is supposed to trigger has passed. If multiple |
2305 | point in time where it is supposed to trigger has passed. If multiple |
2235 | timers become ready during the same loop iteration then the ones with |
2306 | timers become ready during the same loop iteration then the ones with |
2236 | earlier time-out values are invoked before ones with later time-out values |
2307 | earlier time-out values are invoked before ones with later time-out values |
… | |
… | |
2322 | |
2393 | |
2323 | NOTE: I<< This callback must always return a time that is higher than or |
2394 | NOTE: I<< This callback must always return a time that is higher than or |
2324 | equal to the passed C<now> value >>. |
2395 | equal to the passed C<now> value >>. |
2325 | |
2396 | |
2326 | This can be used to create very complex timers, such as a timer that |
2397 | This can be used to create very complex timers, such as a timer that |
2327 | triggers on "next midnight, local time". To do this, you would calculate the |
2398 | triggers on "next midnight, local time". To do this, you would calculate |
2328 | next midnight after C<now> and return the timestamp value for this. How |
2399 | the next midnight after C<now> and return the timestamp value for |
2329 | you do this is, again, up to you (but it is not trivial, which is the main |
2400 | this. Here is a (completely untested, no error checking) example on how to |
2330 | reason I omitted it as an example). |
2401 | do this: |
|
|
2402 | |
|
|
2403 | #include <time.h> |
|
|
2404 | |
|
|
2405 | static ev_tstamp |
|
|
2406 | my_rescheduler (ev_periodic *w, ev_tstamp now) |
|
|
2407 | { |
|
|
2408 | time_t tnow = (time_t)now; |
|
|
2409 | struct tm tm; |
|
|
2410 | localtime_r (&tnow, &tm); |
|
|
2411 | |
|
|
2412 | tm.tm_sec = tm.tm_min = tm.tm_hour = 0; // midnight current day |
|
|
2413 | ++tm.tm_mday; // midnight next day |
|
|
2414 | |
|
|
2415 | return mktime (&tm); |
|
|
2416 | } |
|
|
2417 | |
|
|
2418 | Note: this code might run into trouble on days that have more then two |
|
|
2419 | midnights (beginning and end). |
2331 | |
2420 | |
2332 | =back |
2421 | =back |
2333 | |
2422 | |
2334 | =item ev_periodic_again (loop, ev_periodic *) |
2423 | =item ev_periodic_again (loop, ev_periodic *) |
2335 | |
2424 | |
… | |
… | |
3960 | The normal C API should work fine when used from C++: both ev.h and the |
4049 | The normal C API should work fine when used from C++: both ev.h and the |
3961 | libev sources can be compiled as C++. Therefore, code that uses the C API |
4050 | libev sources can be compiled as C++. Therefore, code that uses the C API |
3962 | will work fine. |
4051 | will work fine. |
3963 | |
4052 | |
3964 | Proper exception specifications might have to be added to callbacks passed |
4053 | Proper exception specifications might have to be added to callbacks passed |
3965 | to libev: exceptions may be thrown only from watcher callbacks, all |
4054 | to libev: exceptions may be thrown only from watcher callbacks, all other |
3966 | other callbacks (allocator, syserr, loop acquire/release and periodic |
4055 | callbacks (allocator, syserr, loop acquire/release and periodic reschedule |
3967 | reschedule callbacks) must not throw exceptions, and might need a C<throw |
4056 | callbacks) must not throw exceptions, and might need a C<noexcept> |
3968 | ()> specification. If you have code that needs to be compiled as both C |
4057 | specification. If you have code that needs to be compiled as both C and |
3969 | and C++ you can use the C<EV_THROW> macro for this: |
4058 | C++ you can use the C<EV_NOEXCEPT> macro for this: |
3970 | |
4059 | |
3971 | static void |
4060 | static void |
3972 | fatal_error (const char *msg) EV_THROW |
4061 | fatal_error (const char *msg) EV_NOEXCEPT |
3973 | { |
4062 | { |
3974 | perror (msg); |
4063 | perror (msg); |
3975 | abort (); |
4064 | abort (); |
3976 | } |
4065 | } |
3977 | |
4066 | |
… | |
… | |
4390 | ev_win32.c required on win32 platforms only |
4479 | ev_win32.c required on win32 platforms only |
4391 | |
4480 | |
4392 | ev_select.c only when select backend is enabled |
4481 | ev_select.c only when select backend is enabled |
4393 | ev_poll.c only when poll backend is enabled |
4482 | ev_poll.c only when poll backend is enabled |
4394 | ev_epoll.c only when the epoll backend is enabled |
4483 | ev_epoll.c only when the epoll backend is enabled |
|
|
4484 | ev_linuxaio.c only when the linux aio backend is enabled |
4395 | ev_kqueue.c only when the kqueue backend is enabled |
4485 | ev_kqueue.c only when the kqueue backend is enabled |
4396 | ev_port.c only when the solaris port backend is enabled |
4486 | ev_port.c only when the solaris port backend is enabled |
4397 | |
4487 | |
4398 | F<ev.c> includes the backend files directly when enabled, so you only need |
4488 | F<ev.c> includes the backend files directly when enabled, so you only need |
4399 | to compile this single file. |
4489 | to compile this single file. |
… | |
… | |
4589 | If defined to be C<1>, libev will compile in support for the Linux |
4679 | If defined to be C<1>, libev will compile in support for the Linux |
4590 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4680 | C<epoll>(7) backend. Its availability will be detected at runtime, |
4591 | otherwise another method will be used as fallback. This is the preferred |
4681 | otherwise another method will be used as fallback. This is the preferred |
4592 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4682 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4593 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4683 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
|
|
4684 | |
|
|
4685 | =item EV_USE_LINUXAIO |
|
|
4686 | |
|
|
4687 | If defined to be C<1>, libev will compile in support for the Linux |
|
|
4688 | aio backend. Due to it's currenbt limitations it has to be requested |
|
|
4689 | explicitly. If undefined, it will be enabled on linux, otherwise |
|
|
4690 | disabled. |
4594 | |
4691 | |
4595 | =item EV_USE_KQUEUE |
4692 | =item EV_USE_KQUEUE |
4596 | |
4693 | |
4597 | If defined to be C<1>, libev will compile in support for the BSD style |
4694 | If defined to be C<1>, libev will compile in support for the BSD style |
4598 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
4695 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |