… | |
… | |
159 | When libev detects a usage error such as a negative timer interval, then |
159 | When libev detects a usage error such as a negative timer interval, then |
160 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
160 | it will print a diagnostic message and abort (via the C<assert> mechanism, |
161 | so C<NDEBUG> will disable this checking): these are programming errors in |
161 | so C<NDEBUG> will disable this checking): these are programming errors in |
162 | the libev caller and need to be fixed there. |
162 | the libev caller and need to be fixed there. |
163 | |
163 | |
|
|
164 | Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive |
|
|
165 | consistency checking code inside libev that can be used to check for |
|
|
166 | internal inconsistencies, suually caused by application bugs. |
|
|
167 | |
164 | Libev also has a few internal error-checking C<assert>ions, and also has |
168 | Libev also has a few internal error-checking C<assert>ions. These do not |
165 | extensive consistency checking code. These do not trigger under normal |
|
|
166 | circumstances, as they indicate either a bug in libev or worse. |
169 | trigger under normal circumstances, as they indicate either a bug in libev |
|
|
170 | or worse. |
167 | |
171 | |
168 | |
172 | |
169 | =head1 GLOBAL FUNCTIONS |
173 | =head1 GLOBAL FUNCTIONS |
170 | |
174 | |
171 | These functions can be called anytime, even before initialising the |
175 | These functions can be called anytime, even before initialising the |
… | |
… | |
511 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
515 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
512 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
516 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
513 | |
517 | |
514 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
518 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
515 | |
519 | |
516 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
520 | Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
517 | kernels). |
521 | kernels). |
518 | |
522 | |
519 | For few fds, this backend is a bit little slower than poll and select, but |
523 | For few fds, this backend is a bit little slower than poll and select, but |
520 | it scales phenomenally better. While poll and select usually scale like |
524 | it scales phenomenally better. While poll and select usually scale like |
521 | O(total_fds) where total_fds is the total number of fds (or the highest |
525 | O(total_fds) where total_fds is the total number of fds (or the highest |
… | |
… | |
574 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
578 | This backend maps C<EV_READ> and C<EV_WRITE> in the same way as |
575 | C<EVBACKEND_POLL>. |
579 | C<EVBACKEND_POLL>. |
576 | |
580 | |
577 | =item C<EVBACKEND_LINUXAIO> (value 64, Linux) |
581 | =item C<EVBACKEND_LINUXAIO> (value 64, Linux) |
578 | |
582 | |
579 | Use the linux-specific linux aio (I<not> C<< aio(7) >> but C<< |
583 | 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 |
584 | io_submit(2) >>) event interface available in post-4.18 kernels (but libev |
581 | only tries to use it in 4.19+). |
585 | only tries to use it in 4.19+). |
582 | |
586 | |
583 | This is another linux trainwreck of an event interface. |
587 | This is another Linux train wreck of an event interface. |
584 | |
588 | |
585 | If this backend works for you (as of this writing, it was very |
589 | 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 |
590 | 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 |
591 | be well worth enabling it - if it isn't available in your kernel this will |
588 | be detected and this backend will be skipped. |
592 | be detected and this backend will be skipped. |
589 | |
593 | |
590 | This backend can batch oneshot requests and supports a user-space ring |
594 | 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 |
595 | 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 |
596 | 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 |
597 | 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 |
598 | 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 |
599 | limitations, forcing you to fall back to epoll, inheriting all its design |
596 | issues. |
600 | issues. |
597 | |
601 | |
598 | For one, it is not easily embeddable (but probably could be done using |
602 | 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 |
603 | 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 |
604 | 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 |
605 | requests are left, this backend will be skipped during initialisation, and |
602 | will switch to epoll when the loop is active. |
606 | will switch to epoll when the loop is active. |
603 | |
607 | |
604 | Most problematic in practice, however, is that not all file descriptors |
608 | 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, |
609 | 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 |
610 | files, F</dev/null> and many others are supported, but ttys do not work |
607 | properly (a known bug that the kernel developers don't care about, see |
611 | 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 |
612 | L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not |
609 | (yet?) a generic event polling interface. |
613 | (yet?) a generic event polling interface. |
610 | |
614 | |
611 | Overall, it seems the linux developers just don't want it to have a |
615 | 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>. |
616 | generic event handling mechanism other than C<select> or C<poll>. |
613 | |
617 | |
614 | To work around all these problem, the current version of libev uses its |
618 | 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 |
619 | 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. |
620 | falls back completely to epoll if the kernel acts up. |
… | |
… | |
637 | It scales in the same way as the epoll backend, but the interface to the |
641 | It scales in the same way as the epoll backend, but the interface to the |
638 | kernel is more efficient (which says nothing about its actual speed, of |
642 | kernel is more efficient (which says nothing about its actual speed, of |
639 | course). While stopping, setting and starting an I/O watcher does never |
643 | course). While stopping, setting and starting an I/O watcher does never |
640 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
644 | cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to |
641 | two event changes per incident. Support for C<fork ()> is very bad (you |
645 | two event changes per incident. Support for C<fork ()> is very bad (you |
642 | might have to leak fd's on fork, but it's more sane than epoll) and it |
646 | might have to leak fds on fork, but it's more sane than epoll) and it |
643 | drops fds silently in similarly hard-to-detect cases. |
647 | drops fds silently in similarly hard-to-detect cases. |
644 | |
648 | |
645 | This backend usually performs well under most conditions. |
649 | This backend usually performs well under most conditions. |
646 | |
650 | |
647 | While nominally embeddable in other event loops, this doesn't work |
651 | While nominally embeddable in other event loops, this doesn't work |
… | |
… | |
1531 | |
1535 | |
1532 | Many event loops support I<watcher priorities>, which are usually small |
1536 | Many event loops support I<watcher priorities>, which are usually small |
1533 | integers that influence the ordering of event callback invocation |
1537 | integers that influence the ordering of event callback invocation |
1534 | between watchers in some way, all else being equal. |
1538 | between watchers in some way, all else being equal. |
1535 | |
1539 | |
1536 | In libev, Watcher priorities can be set using C<ev_set_priority>. See its |
1540 | In libev, watcher priorities can be set using C<ev_set_priority>. See its |
1537 | description for the more technical details such as the actual priority |
1541 | description for the more technical details such as the actual priority |
1538 | range. |
1542 | range. |
1539 | |
1543 | |
1540 | There are two common ways how these these priorities are being interpreted |
1544 | There are two common ways how these these priorities are being interpreted |
1541 | by event loops: |
1545 | by event loops: |
… | |
… | |
1745 | when you rarely read from a file instead of from a socket, and want to |
1749 | when you rarely read from a file instead of from a socket, and want to |
1746 | reuse the same code path. |
1750 | reuse the same code path. |
1747 | |
1751 | |
1748 | =head3 The special problem of fork |
1752 | =head3 The special problem of fork |
1749 | |
1753 | |
1750 | Some backends (epoll, kqueue, probably linuxaio) do not support C<fork ()> |
1754 | Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()> |
1751 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1755 | at all or exhibit useless behaviour. Libev fully supports fork, but needs |
1752 | to be told about it in the child if you want to continue to use it in the |
1756 | to be told about it in the child if you want to continue to use it in the |
1753 | child. |
1757 | child. |
1754 | |
1758 | |
1755 | To support fork in your child processes, you have to call C<ev_loop_fork |
1759 | To support fork in your child processes, you have to call C<ev_loop_fork |
… | |
… | |
4480 | |
4484 | |
4481 | ev_select.c only when select backend is enabled |
4485 | ev_select.c only when select backend is enabled |
4482 | ev_poll.c only when poll backend is enabled |
4486 | ev_poll.c only when poll backend is enabled |
4483 | ev_epoll.c only when the epoll backend is enabled |
4487 | ev_epoll.c only when the epoll backend is enabled |
4484 | ev_linuxaio.c only when the linux aio backend is enabled |
4488 | ev_linuxaio.c only when the linux aio backend is enabled |
|
|
4489 | ev_iouring.c only when the linux io_uring backend is enabled |
4485 | ev_kqueue.c only when the kqueue backend is enabled |
4490 | ev_kqueue.c only when the kqueue backend is enabled |
4486 | ev_port.c only when the solaris port backend is enabled |
4491 | ev_port.c only when the solaris port backend is enabled |
4487 | |
4492 | |
4488 | F<ev.c> includes the backend files directly when enabled, so you only need |
4493 | F<ev.c> includes the backend files directly when enabled, so you only need |
4489 | to compile this single file. |
4494 | to compile this single file. |
… | |
… | |
4682 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4687 | backend for GNU/Linux systems. If undefined, it will be enabled if the |
4683 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4688 | headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. |
4684 | |
4689 | |
4685 | =item EV_USE_LINUXAIO |
4690 | =item EV_USE_LINUXAIO |
4686 | |
4691 | |
|
|
4692 | If defined to be C<1>, libev will compile in support for the Linux aio |
|
|
4693 | backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be |
|
|
4694 | enabled on linux, otherwise disabled. |
|
|
4695 | |
|
|
4696 | =item EV_USE_IOURING |
|
|
4697 | |
4687 | If defined to be C<1>, libev will compile in support for the Linux |
4698 | 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 |
4699 | io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's |
4689 | explicitly. If undefined, it will be enabled on linux, otherwise |
4700 | current limitations it has to be requested explicitly. If undefined, it |
4690 | disabled. |
4701 | will be enabled on linux, otherwise disabled. |
4691 | |
4702 | |
4692 | =item EV_USE_KQUEUE |
4703 | =item EV_USE_KQUEUE |
4693 | |
4704 | |
4694 | If defined to be C<1>, libev will compile in support for the BSD style |
4705 | If defined to be C<1>, libev will compile in support for the BSD style |
4695 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
4706 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
… | |
… | |
4973 | called. If set to C<2>, then the internal verification code will be |
4984 | called. If set to C<2>, then the internal verification code will be |
4974 | called once per loop, which can slow down libev. If set to C<3>, then the |
4985 | called once per loop, which can slow down libev. If set to C<3>, then the |
4975 | verification code will be called very frequently, which will slow down |
4986 | verification code will be called very frequently, which will slow down |
4976 | libev considerably. |
4987 | libev considerably. |
4977 | |
4988 | |
|
|
4989 | Verification errors are reported via C's C<assert> mechanism, so if you |
|
|
4990 | disable that (e.g. by defining C<NDEBUG>) then no errors will be reported. |
|
|
4991 | |
4978 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4992 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
4979 | will be C<0>. |
4993 | will be C<0>. |
4980 | |
4994 | |
4981 | =item EV_COMMON |
4995 | =item EV_COMMON |
4982 | |
4996 | |