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

Comparing libev/ev.pod (file contents):
Revision 1.445 by root, Fri Dec 21 06:54:30 2018 UTC vs.
Revision 1.469 by root, Sat Jun 3 08:53:03 2023 UTC

105details of the event, and then hand it over to libev by I<starting> the 105details of the event, and then hand it over to libev by I<starting> the
106watcher. 106watcher.
107 107
108=head2 FEATURES 108=head2 FEATURES
109 109
110Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 110Libev supports C<select>, C<poll>, the Linux-specific aio and C<epoll>
111BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 111interfaces, the BSD-specific C<kqueue> and the Solaris-specific event port
112for file descriptor events (C<ev_io>), the Linux C<inotify> interface 112mechanisms for file descriptor events (C<ev_io>), the Linux C<inotify>
113(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner 113interface (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative 114inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
115timers (C<ev_timer>), absolute timers with customised rescheduling 115timers (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
117change events (C<ev_child>), and event watchers dealing with the event 117change events (C<ev_child>), and event watchers dealing with the event
118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and 118loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
159When libev detects a usage error such as a negative timer interval, then 159When libev detects a usage error such as a negative timer interval, then
160it will print a diagnostic message and abort (via the C<assert> mechanism, 160it will print a diagnostic message and abort (via the C<assert> mechanism,
161so C<NDEBUG> will disable this checking): these are programming errors in 161so C<NDEBUG> will disable this checking): these are programming errors in
162the libev caller and need to be fixed there. 162the libev caller and need to be fixed there.
163 163
164Via the C<EV_FREQUENT> macro you can compile in and/or enable extensive
165consistency checking code inside libev that can be used to check for
166internal inconsistencies, suually caused by application bugs.
167
164Libev also has a few internal error-checking C<assert>ions, and also has 168Libev also has a few internal error-checking C<assert>ions. These do not
165extensive consistency checking code. These do not trigger under normal
166circumstances, as they indicate either a bug in libev or worse. 169trigger under normal circumstances, as they indicate either a bug in libev
170or worse.
167 171
168 172
169=head1 GLOBAL FUNCTIONS 173=head1 GLOBAL FUNCTIONS
170 174
171These functions can be called anytime, even before initialising the 175These functions can be called anytime, even before initialising the
265 269
266You could override this function in high-availability programs to, say, 270You could override this function in high-availability programs to, say,
267free some memory if it cannot allocate memory, to use a special allocator, 271free some memory if it cannot allocate memory, to use a special allocator,
268or even to sleep a while and retry until some memory is available. 272or even to sleep a while and retry until some memory is available.
269 273
274Example: The following is the C<realloc> function that libev itself uses
275which should work with C<realloc> and C<free> functions of all kinds and
276is probably a good basis for your own implementation.
277
278 static void *
279 ev_realloc_emul (void *ptr, long size) EV_NOEXCEPT
280 {
281 if (size)
282 return realloc (ptr, size);
283
284 free (ptr);
285 return 0;
286 }
287
270Example: Replace the libev allocator with one that waits a bit and then 288Example: Replace the libev allocator with one that waits a bit and then
271retries (example requires a standards-compliant C<realloc>). 289retries.
272 290
273 static void * 291 static void *
274 persistent_realloc (void *ptr, size_t size) 292 persistent_realloc (void *ptr, size_t size)
275 { 293 {
294 if (!size)
295 {
296 free (ptr);
297 return 0;
298 }
299
276 for (;;) 300 for (;;)
277 { 301 {
278 void *newptr = realloc (ptr, size); 302 void *newptr = realloc (ptr, size);
279 303
280 if (newptr) 304 if (newptr)
456unblocking the signals. 480unblocking the signals.
457 481
458It's also required by POSIX in a threaded program, as libev calls 482It's also required by POSIX in a threaded program, as libev calls
459C<sigprocmask>, whose behaviour is officially unspecified. 483C<sigprocmask>, whose behaviour is officially unspecified.
460 484
461This flag's behaviour will become the default in future versions of libev. 485=item C<EVFLAG_NOTIMERFD>
486
487When this flag is specified, the libev will avoid using a C<timerfd> to
488detect time jumps. It will still be able to detect time jumps, but takes
489longer and has a lower accuracy in doing so, but saves a file descriptor
490per loop.
491
492The current implementation only tries to use a C<timerfd> when the first
493C<ev_periodic> watcher is started and falls back on other methods if it
494cannot be created, but this behaviour might change in the future.
462 495
463=item C<EVBACKEND_SELECT> (value 1, portable select backend) 496=item C<EVBACKEND_SELECT> (value 1, portable select backend)
464 497
465This is your standard select(2) backend. Not I<completely> standard, as 498This is your standard select(2) backend. Not I<completely> standard, as
466libev tries to roll its own fd_set with no limits on the number of fds, 499libev tries to roll its own fd_set with no limits on the number of fds,
491This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 524This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
492C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 525C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
493 526
494=item C<EVBACKEND_EPOLL> (value 4, Linux) 527=item C<EVBACKEND_EPOLL> (value 4, Linux)
495 528
496Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 529Use the Linux-specific epoll(7) interface (for both pre- and post-2.6.9
497kernels). 530kernels).
498 531
499For few fds, this backend is a bit little slower than poll and select, but 532For few fds, this backend is a bit little slower than poll and select, but
500it scales phenomenally better. While poll and select usually scale like 533it scales phenomenally better. While poll and select usually scale like
501O(total_fds) where total_fds is the total number of fds (or the highest 534O(total_fds) where total_fds is the total number of fds (or the highest
547All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or 580All this means that, in practice, C<EVBACKEND_SELECT> can be as fast or
548faster than epoll for maybe up to a hundred file descriptors, depending on 581faster than epoll for maybe up to a hundred file descriptors, depending on
549the usage. So sad. 582the usage. So sad.
550 583
551While nominally embeddable in other event loops, this feature is broken in 584While nominally embeddable in other event loops, this feature is broken in
552all kernel versions tested so far. 585a lot of kernel revisions, but probably(!) works in current versions.
553 586
554This backend maps C<EV_READ> and C<EV_WRITE> in the same way as 587This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
555C<EVBACKEND_POLL>. 588C<EVBACKEND_POLL>.
556 589
590=item C<EVBACKEND_LINUXAIO> (value 64, Linux)
591
592Use the Linux-specific Linux AIO (I<not> C<< aio(7) >> but C<<
593io_submit(2) >>) event interface available in post-4.18 kernels (but libev
594only tries to use it in 4.19+).
595
596This is another Linux train wreck of an event interface.
597
598If this backend works for you (as of this writing, it was very
599experimental), it is the best event interface available on Linux and might
600be well worth enabling it - if it isn't available in your kernel this will
601be detected and this backend will be skipped.
602
603This backend can batch oneshot requests and supports a user-space ring
604buffer to receive events. It also doesn't suffer from most of the design
605problems of epoll (such as not being able to remove event sources from
606the epoll set), and generally sounds too good to be true. Because, this
607being the Linux kernel, of course it suffers from a whole new set of
608limitations, forcing you to fall back to epoll, inheriting all its design
609issues.
610
611For one, it is not easily embeddable (but probably could be done using
612an event fd at some extra overhead). It also is subject to a system wide
613limit that can be configured in F</proc/sys/fs/aio-max-nr>. If no AIO
614requests are left, this backend will be skipped during initialisation, and
615will switch to epoll when the loop is active.
616
617Most problematic in practice, however, is that not all file descriptors
618work with it. For example, in Linux 5.1, TCP sockets, pipes, event fds,
619files, F</dev/null> and many others are supported, but ttys do not work
620properly (a known bug that the kernel developers don't care about, see
621L<https://lore.kernel.org/patchwork/patch/1047453/>), so this is not
622(yet?) a generic event polling interface.
623
624Overall, it seems the Linux developers just don't want it to have a
625generic event handling mechanism other than C<select> or C<poll>.
626
627To work around all these problem, the current version of libev uses its
628epoll backend as a fallback for file descriptor types that do not work. Or
629falls back completely to epoll if the kernel acts up.
630
631This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
632C<EVBACKEND_POLL>.
633
557=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 634=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
558 635
559Kqueue deserves special mention, as at the time of this writing, it 636Kqueue deserves special mention, as at the time this backend was
560was broken on all BSDs except NetBSD (usually it doesn't work reliably 637implemented, it was broken on all BSDs except NetBSD (usually it doesn't
561with anything but sockets and pipes, except on Darwin, where of course 638work reliably with anything but sockets and pipes, except on Darwin,
562it's completely useless). Unlike epoll, however, whose brokenness 639where of course it's completely useless). Unlike epoll, however, whose
563is by design, these kqueue bugs can (and eventually will) be fixed 640brokenness is by design, these kqueue bugs can be (and mostly have been)
564without API changes to existing programs. For this reason it's not being 641fixed 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 642being "auto-detected" on all platforms unless you explicitly specify it
566C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) 643in the flags (i.e. using C<EVBACKEND_KQUEUE>) or libev was compiled on a
567system like NetBSD. 644known-to-be-good (-enough) system like NetBSD.
568 645
569You still can embed kqueue into a normal poll or select backend and use it 646You still can embed kqueue into a normal poll or select backend and use it
570only for sockets (after having made sure that sockets work with kqueue on 647only for sockets (after having made sure that sockets work with kqueue on
571the target platform). See C<ev_embed> watchers for more info. 648the target platform). See C<ev_embed> watchers for more info.
572 649
573It scales in the same way as the epoll backend, but the interface to the 650It scales in the same way as the epoll backend, but the interface to the
574kernel is more efficient (which says nothing about its actual speed, of 651kernel is more efficient (which says nothing about its actual speed, of
575course). While stopping, setting and starting an I/O watcher does never 652course). While stopping, setting and starting an I/O watcher does never
576cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 653cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
577two event changes per incident. Support for C<fork ()> is very bad (you 654two event changes per incident. Support for C<fork ()> is very bad (you
578might have to leak fd's on fork, but it's more sane than epoll) and it 655might have to leak fds on fork, but it's more sane than epoll) and it
579drops fds silently in similarly hard-to-detect cases. 656drops fds silently in similarly hard-to-detect cases.
580 657
581This backend usually performs well under most conditions. 658This backend usually performs well under most conditions.
582 659
583While nominally embeddable in other event loops, this doesn't work 660While nominally embeddable in other event loops, this doesn't work
598and is not embeddable, which would limit the usefulness of this backend 675and is not embeddable, which would limit the usefulness of this backend
599immensely. 676immensely.
600 677
601=item C<EVBACKEND_PORT> (value 32, Solaris 10) 678=item C<EVBACKEND_PORT> (value 32, Solaris 10)
602 679
603This uses the Solaris 10 event port mechanism. As with everything on Solaris, 680This uses the Solaris 10 event port mechanism. As with everything on
604it's really slow, but it still scales very well (O(active_fds)). 681Solaris, it's really slow, but it still scales very well (O(active_fds)).
605 682
606While this backend scales well, it requires one system call per active 683While this backend scales well, it requires one system call per active
607file descriptor per loop iteration. For small and medium numbers of file 684file descriptor per loop iteration. For small and medium numbers of file
608descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend 685descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
609might perform better. 686might perform better.
657 734
658Example: Use whatever libev has to offer, but make sure that kqueue is 735Example: Use whatever libev has to offer, but make sure that kqueue is
659used if available. 736used if available.
660 737
661 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE); 738 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
739
740Example: Similarly, on linux, you mgiht want to take advantage of the
741linux aio backend if possible, but fall back to something else if that
742isn't available.
743
744 struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_LINUXAIO);
662 745
663=item ev_loop_destroy (loop) 746=item ev_loop_destroy (loop)
664 747
665Destroys an event loop object (frees all memory and kernel state 748Destroys an event loop object (frees all memory and kernel state
666etc.). None of the active event watchers will be stopped in the normal 749etc.). None of the active event watchers will be stopped in the normal
876 - Queue all expired timers. 959 - Queue all expired timers.
877 - Queue all expired periodics. 960 - Queue all expired periodics.
878 - Queue all idle watchers with priority higher than that of pending events. 961 - Queue all idle watchers with priority higher than that of pending events.
879 - Queue all check watchers. 962 - Queue all check watchers.
880 - Call all queued watchers in reverse order (i.e. check watchers first). 963 - Call all queued watchers in reverse order (i.e. check watchers first).
881 Signals and child watchers are implemented as I/O watchers, and will 964 Signals, async and child watchers are implemented as I/O watchers, and
882 be handled here by queueing them when their watcher gets executed. 965 will be handled here by queueing them when their watcher gets executed.
883 - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT 966 - If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
884 were used, or there are no active watchers, goto FINISH, otherwise 967 were used, or there are no active watchers, goto FINISH, otherwise
885 continue with step LOOP. 968 continue with step LOOP.
886 FINISH: 969 FINISH:
887 - Reset the ev_break status iff it was EVBREAK_ONE. 970 - Reset the ev_break status iff it was EVBREAK_ONE.
1135with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher 1218with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
1136*) >>), and you can stop watching for events at any time by calling the 1219*) >>), and you can stop watching for events at any time by calling the
1137corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>. 1220corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
1138 1221
1139As long as your watcher is active (has been started but not stopped) you 1222As long as your watcher is active (has been started but not stopped) you
1140must not touch the values stored in it. Most specifically you must never 1223must not touch the values stored in it except when explicitly documented
1141reinitialise it or call its C<ev_TYPE_set> macro. 1224otherwise. Most specifically you must never reinitialise it or call its
1225C<ev_TYPE_set> macro.
1142 1226
1143Each and every callback receives the event loop pointer as first, the 1227Each and every callback receives the event loop pointer as first, the
1144registered watcher structure as second, and a bitset of received events as 1228registered watcher structure as second, and a bitset of received events as
1145third argument. 1229third argument.
1146 1230
1312 1396
1313=item bool ev_is_active (ev_TYPE *watcher) 1397=item bool ev_is_active (ev_TYPE *watcher)
1314 1398
1315Returns a true value iff the watcher is active (i.e. it has been started 1399Returns a true value iff the watcher is active (i.e. it has been started
1316and not yet been stopped). As long as a watcher is active you must not modify 1400and not yet been stopped). As long as a watcher is active you must not modify
1317it. 1401it unless documented otherwise.
1402
1403Obviously, it is safe to call this on an active watcher, or actually any
1404watcher that is initialised.
1318 1405
1319=item bool ev_is_pending (ev_TYPE *watcher) 1406=item bool ev_is_pending (ev_TYPE *watcher)
1320 1407
1321Returns a true value iff the watcher is pending, (i.e. it has outstanding 1408Returns a true value iff the watcher is pending, (i.e. it has outstanding
1322events but its callback has not yet been invoked). As long as a watcher 1409events but its callback has not yet been invoked). As long as a watcher
1323is pending (but not active) you must not call an init function on it (but 1410is pending (but not active) you must not call an init function on it (but
1324C<ev_TYPE_set> is safe), you must not change its priority, and you must 1411C<ev_TYPE_set> is safe), you must not change its priority, and you must
1325make sure the watcher is available to libev (e.g. you cannot C<free ()> 1412make sure the watcher is available to libev (e.g. you cannot C<free ()>
1326it). 1413it).
1327 1414
1415It is safe to call this on any watcher in any state as long as it is
1416initialised.
1417
1328=item callback ev_cb (ev_TYPE *watcher) 1418=item callback ev_cb (ev_TYPE *watcher)
1329 1419
1330Returns the callback currently set on the watcher. 1420Returns the callback currently set on the watcher.
1331 1421
1332=item ev_set_cb (ev_TYPE *watcher, callback) 1422=item ev_set_cb (ev_TYPE *watcher, callback)
1345from being executed (except for C<ev_idle> watchers). 1435from being executed (except for C<ev_idle> watchers).
1346 1436
1347If you need to suppress invocation when higher priority events are pending 1437If you need to suppress invocation when higher priority events are pending
1348you need to look at C<ev_idle> watchers, which provide this functionality. 1438you need to look at C<ev_idle> watchers, which provide this functionality.
1349 1439
1350You I<must not> change the priority of a watcher as long as it is active or 1440You I<must not> change the priority of a watcher as long as it is active
1351pending. 1441or pending. Reading the priority with C<ev_priority> is fine in any state.
1352 1442
1353Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1443Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1354fine, as long as you do not mind that the priority value you query might 1444fine, as long as you do not mind that the priority value you query might
1355or might not have been clamped to the valid range. 1445or might not have been clamped to the valid range.
1356 1446
1378 1468
1379=item ev_feed_event (loop, ev_TYPE *watcher, int revents) 1469=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1380 1470
1381Feeds the given event set into the event loop, as if the specified event 1471Feeds the given event set into the event loop, as if the specified event
1382had happened for the specified watcher (which must be a pointer to an 1472had happened for the specified watcher (which must be a pointer to an
1383initialised but not necessarily started event watcher). Obviously you must 1473initialised but not necessarily started event watcher, though it can be
1384not free the watcher as long as it has pending events. 1474active). Obviously you must not free the watcher as long as it has pending
1475events.
1385 1476
1386Stopping the watcher, letting libev invoke it, or calling 1477Stopping the watcher, letting libev invoke it, or calling
1387C<ev_clear_pending> will clear the pending event, even if the watcher was 1478C<ev_clear_pending> will clear the pending event, even if the watcher was
1388not started in the first place. 1479not started in the first place.
1389 1480
1417 1508
1418=item started/running/active 1509=item started/running/active
1419 1510
1420Once a watcher has been started with a call to C<ev_TYPE_start> it becomes 1511Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1421property of the event loop, and is actively waiting for events. While in 1512property of the event loop, and is actively waiting for events. While in
1422this state it cannot be accessed (except in a few documented ways), moved, 1513this state it cannot be accessed (except in a few documented ways, such as
1423freed or anything else - the only legal thing is to keep a pointer to it, 1514stoping it), moved, freed or anything else - the only legal thing is to
1424and call libev functions on it that are documented to work on active watchers. 1515keep a pointer to it, and call libev functions on it that are documented
1516to work on active watchers.
1517
1518As a rule of thumb, before accessing a member or calling any function on
1519a watcher, it should be stopped (or freshly initialised). If that is not
1520convenient, you can check the documentation for that function or member to
1521see if it is safe to use on an active watcher.
1425 1522
1426=item pending 1523=item pending
1427 1524
1428If a watcher is active and libev determines that an event it is interested 1525If a watcher is active and libev determines that an event it is interested
1429in has occurred (such as a timer expiring), it will become pending. It will 1526in has occurred (such as a timer expiring), it will become pending. It
1430stay in this pending state until either it is stopped or its callback is 1527will stay in this pending state until either it is explicitly stopped or
1431about to be invoked, so it is not normally pending inside the watcher 1528its callback is about to be invoked, so it is not normally pending inside
1432callback. 1529the watcher callback.
1433 1530
1434The watcher might or might not be active while it is pending (for example, 1531Generally, the watcher might or might not be active while it is pending
1435an expired non-repeating timer can be pending but no longer active). If it 1532(for example, an expired non-repeating timer can be pending but no longer
1436is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>), 1533active). If it is pending but not active, it can be freely accessed (e.g.
1437but it is still property of the event loop at this time, so cannot be 1534by calling C<ev_TYPE_set>), but it is still property of the event loop at
1438moved, freed or reused. And if it is active the rules described in the 1535this time, so cannot be moved, freed or reused. And if it is active the
1439previous item still apply. 1536rules described in the previous item still apply.
1537
1538Explicitly stopping a watcher will also clear the pending state
1539unconditionally, so it is safe to stop a watcher and then free it.
1440 1540
1441It is also possible to feed an event on a watcher that is not active (e.g. 1541It is also possible to feed an event on a watcher that is not active (e.g.
1442via C<ev_feed_event>), in which case it becomes pending without being 1542via C<ev_feed_event>), in which case it becomes pending without being
1443active. 1543active.
1444 1544
1461 1561
1462Many event loops support I<watcher priorities>, which are usually small 1562Many event loops support I<watcher priorities>, which are usually small
1463integers that influence the ordering of event callback invocation 1563integers that influence the ordering of event callback invocation
1464between watchers in some way, all else being equal. 1564between watchers in some way, all else being equal.
1465 1565
1466In libev, Watcher priorities can be set using C<ev_set_priority>. See its 1566In libev, watcher priorities can be set using C<ev_set_priority>. See its
1467description for the more technical details such as the actual priority 1567description for the more technical details such as the actual priority
1468range. 1568range.
1469 1569
1470There are two common ways how these these priorities are being interpreted 1570There are two common ways how these these priorities are being interpreted
1471by event loops: 1571by event loops:
1565 1665
1566This section describes each watcher in detail, but will not repeat 1666This section describes each watcher in detail, but will not repeat
1567information given in the last section. Any initialisation/set macros, 1667information given in the last section. Any initialisation/set macros,
1568functions and members specific to the watcher type are explained. 1668functions and members specific to the watcher type are explained.
1569 1669
1570Members are additionally marked with either I<[read-only]>, meaning that, 1670Most members are additionally marked with either I<[read-only]>, meaning
1571while the watcher is active, you can look at the member and expect some 1671that, while the watcher is active, you can look at the member and expect
1572sensible content, but you must not modify it (you can modify it while the 1672some sensible content, but you must not modify it (you can modify it while
1573watcher is stopped to your hearts content), or I<[read-write]>, which 1673the watcher is stopped to your hearts content), or I<[read-write]>, which
1574means you can expect it to have some sensible content while the watcher 1674means you can expect it to have some sensible content while the watcher is
1575is active, but you can also modify it. Modifying it may not do something 1675active, but you can also modify it (within the same thread as the event
1676loop, i.e. without creating data races). Modifying it may not do something
1576sensible or take immediate effect (or do anything at all), but libev will 1677sensible or take immediate effect (or do anything at all), but libev will
1577not crash or malfunction in any way. 1678not crash or malfunction in any way.
1578 1679
1680In any case, the documentation for each member will explain what the
1681effects are, and if there are any additional access restrictions.
1579 1682
1580=head2 C<ev_io> - is this file descriptor readable or writable? 1683=head2 C<ev_io> - is this file descriptor readable or writable?
1581 1684
1582I/O watchers check whether a file descriptor is readable or writable 1685I/O watchers check whether a file descriptor is readable or writable
1583in each iteration of the event loop, or, more precisely, when reading 1686in each iteration of the event loop, or, more precisely, when reading
1610 1713
1611But really, best use non-blocking mode. 1714But really, best use non-blocking mode.
1612 1715
1613=head3 The special problem of disappearing file descriptors 1716=head3 The special problem of disappearing file descriptors
1614 1717
1615Some backends (e.g. kqueue, epoll) need to be told about closing a file 1718Some backends (e.g. kqueue, epoll, linuxaio) need to be told about closing
1616descriptor (either due to calling C<close> explicitly or any other means, 1719a file descriptor (either due to calling C<close> explicitly or any other
1617such as C<dup2>). The reason is that you register interest in some file 1720means, such as C<dup2>). The reason is that you register interest in some
1618descriptor, but when it goes away, the operating system will silently drop 1721file descriptor, but when it goes away, the operating system will silently
1619this interest. If another file descriptor with the same number then is 1722drop this interest. If another file descriptor with the same number then
1620registered with libev, there is no efficient way to see that this is, in 1723is registered with libev, there is no efficient way to see that this is,
1621fact, a different file descriptor. 1724in fact, a different file descriptor.
1622 1725
1623To avoid having to explicitly tell libev about such cases, libev follows 1726To avoid having to explicitly tell libev about such cases, libev follows
1624the following policy: Each time C<ev_io_set> is being called, libev 1727the following policy: Each time C<ev_io_set> is being called, libev
1625will assume that this is potentially a new file descriptor, otherwise 1728will assume that this is potentially a new file descriptor, otherwise
1626it is assumed that the file descriptor stays the same. That means that 1729it is assumed that the file descriptor stays the same. That means that
1675when you rarely read from a file instead of from a socket, and want to 1778when you rarely read from a file instead of from a socket, and want to
1676reuse the same code path. 1779reuse the same code path.
1677 1780
1678=head3 The special problem of fork 1781=head3 The special problem of fork
1679 1782
1680Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1783Some backends (epoll, kqueue, linuxaio, iouring) do not support C<fork ()>
1681useless behaviour. Libev fully supports fork, but needs to be told about 1784at all or exhibit useless behaviour. Libev fully supports fork, but needs
1682it in the child if you want to continue to use it in the child. 1785to be told about it in the child if you want to continue to use it in the
1786child.
1683 1787
1684To support fork in your child processes, you have to call C<ev_loop_fork 1788To 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 1789()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1686C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1790C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1687 1791
1742=item ev_io_init (ev_io *, callback, int fd, int events) 1846=item ev_io_init (ev_io *, callback, int fd, int events)
1743 1847
1744=item ev_io_set (ev_io *, int fd, int events) 1848=item ev_io_set (ev_io *, int fd, int events)
1745 1849
1746Configures an C<ev_io> watcher. The C<fd> is the file descriptor to 1850Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
1747receive events for and C<events> is either C<EV_READ>, C<EV_WRITE> or 1851receive events for and C<events> is either C<EV_READ>, C<EV_WRITE>, both
1748C<EV_READ | EV_WRITE>, to express the desire to receive the given events. 1852C<EV_READ | EV_WRITE> or C<0>, to express the desire to receive the given
1853events.
1749 1854
1750=item int fd [read-only] 1855Note that setting the C<events> to C<0> and starting the watcher is
1856supported, but not specially optimized - if your program sometimes happens
1857to generate this combination this is fine, but if it is easy to avoid
1858starting an io watcher watching for no events you should do so.
1751 1859
1752The file descriptor being watched. 1860=item ev_io_modify (ev_io *, int events)
1753 1861
1862Similar to C<ev_io_set>, but only changes the requested events. Using this
1863might be faster with some backends, as libev can assume that the C<fd>
1864still refers to the same underlying file description, something it cannot
1865do when using C<ev_io_set>.
1866
1867=item int fd [no-modify]
1868
1869The file descriptor being watched. While it can be read at any time, you
1870must not modify this member even when the watcher is stopped - always use
1871C<ev_io_set> for that.
1872
1754=item int events [read-only] 1873=item int events [no-modify]
1755 1874
1756The events being watched. 1875The set of events the fd is being watched for, among other flags. Remember
1876that this is a bit set - to test for C<EV_READ>, use C<< w->events &
1877EV_READ >>, and similarly for C<EV_WRITE>.
1878
1879As with C<fd>, you must not modify this member even when the watcher is
1880stopped, always use C<ev_io_set> or C<ev_io_modify> for that.
1757 1881
1758=back 1882=back
1759 1883
1760=head3 Examples 1884=head3 Examples
1761 1885
3754event loop thread and an unspecified mechanism to wake up the main thread. 3878event loop thread and an unspecified mechanism to wake up the main thread.
3755 3879
3756First, you need to associate some data with the event loop: 3880First, you need to associate some data with the event loop:
3757 3881
3758 typedef struct { 3882 typedef struct {
3759 mutex_t lock; /* global loop lock */ 3883 pthread_mutex_t lock; /* global loop lock */
3884 pthread_t tid;
3885 pthread_cond_t invoke_cv;
3760 ev_async async_w; 3886 ev_async async_w;
3761 thread_t tid;
3762 cond_t invoke_cv;
3763 } userdata; 3887 } userdata;
3764 3888
3765 void prepare_loop (EV_P) 3889 void prepare_loop (EV_P)
3766 { 3890 {
3767 // for simplicity, we use a static userdata struct. 3891 // for simplicity, we use a static userdata struct.
3768 static userdata u; 3892 static userdata u;
3769 3893
3770 ev_async_init (&u->async_w, async_cb); 3894 ev_async_init (&u.async_w, async_cb);
3771 ev_async_start (EV_A_ &u->async_w); 3895 ev_async_start (EV_A_ &u.async_w);
3772 3896
3773 pthread_mutex_init (&u->lock, 0); 3897 pthread_mutex_init (&u.lock, 0);
3774 pthread_cond_init (&u->invoke_cv, 0); 3898 pthread_cond_init (&u.invoke_cv, 0);
3775 3899
3776 // now associate this with the loop 3900 // now associate this with the loop
3777 ev_set_userdata (EV_A_ u); 3901 ev_set_userdata (EV_A_ &u);
3778 ev_set_invoke_pending_cb (EV_A_ l_invoke); 3902 ev_set_invoke_pending_cb (EV_A_ l_invoke);
3779 ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 3903 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3780 3904
3781 // then create the thread running ev_run 3905 // then create the thread running ev_run
3782 pthread_create (&u->tid, 0, l_run, EV_A); 3906 pthread_create (&u.tid, 0, l_run, EV_A);
3783 } 3907 }
3784 3908
3785The callback for the C<ev_async> watcher does nothing: the watcher is used 3909The callback for the C<ev_async> watcher does nothing: the watcher is used
3786solely to wake up the event loop so it takes notice of any new watchers 3910solely to wake up the event loop so it takes notice of any new watchers
3787that might have been added: 3911that might have been added:
4159method. 4283method.
4160 4284
4161For C<ev::embed> watchers this method is called C<set_embed>, to avoid 4285For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4162clashing with the C<set (loop)> method. 4286clashing with the C<set (loop)> method.
4163 4287
4288For C<ev::io> watchers there is an additional C<set> method that acepts a
4289new event mask only, and internally calls C<ev_io_modify>.
4290
4164=item w->start () 4291=item w->start ()
4165 4292
4166Starts the watcher. Note that there is no C<loop> argument, as the 4293Starts the watcher. Note that there is no C<loop> argument, as the
4167constructor already stores the event loop. 4294constructor already stores the event loop.
4168 4295
4408 ev_win32.c required on win32 platforms only 4535 ev_win32.c required on win32 platforms only
4409 4536
4410 ev_select.c only when select backend is enabled 4537 ev_select.c only when select backend is enabled
4411 ev_poll.c only when poll backend is enabled 4538 ev_poll.c only when poll backend is enabled
4412 ev_epoll.c only when the epoll backend is enabled 4539 ev_epoll.c only when the epoll backend is enabled
4540 ev_linuxaio.c only when the linux aio backend is enabled
4541 ev_iouring.c only when the linux io_uring backend is enabled
4413 ev_kqueue.c only when the kqueue backend is enabled 4542 ev_kqueue.c only when the kqueue backend is enabled
4414 ev_port.c only when the solaris port backend is enabled 4543 ev_port.c only when the solaris port backend is enabled
4415 4544
4416F<ev.c> includes the backend files directly when enabled, so you only need 4545F<ev.c> includes the backend files directly when enabled, so you only need
4417to compile this single file. 4546to compile this single file.
4538available and will probe for kernel support at runtime. This will improve 4667available and will probe for kernel support at runtime. This will improve
4539C<ev_signal> and C<ev_async> performance and reduce resource consumption. 4668C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4540If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc 4669If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
45412.7 or newer, otherwise disabled. 46702.7 or newer, otherwise disabled.
4542 4671
4672=item EV_USE_SIGNALFD
4673
4674If defined to be C<1>, then libev will assume that C<signalfd ()> is
4675available and will probe for kernel support at runtime. This enables
4676the use of EVFLAG_SIGNALFD for faster and simpler signal handling. If
4677undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46782.7 or newer, otherwise disabled.
4679
4680=item EV_USE_TIMERFD
4681
4682If defined to be C<1>, then libev will assume that C<timerfd ()> is
4683available and will probe for kernel support at runtime. This allows
4684libev to detect time jumps accurately. If undefined, it will be enabled
4685if the headers indicate GNU/Linux + Glibc 2.8 or newer and define
4686C<TFD_TIMER_CANCEL_ON_SET>, otherwise disabled.
4687
4688=item EV_USE_EVENTFD
4689
4690If defined to be C<1>, then libev will assume that C<eventfd ()> is
4691available and will probe for kernel support at runtime. This will improve
4692C<ev_signal> and C<ev_async> performance and reduce resource consumption.
4693If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
46942.7 or newer, otherwise disabled.
4695
4543=item EV_USE_SELECT 4696=item EV_USE_SELECT
4544 4697
4545If undefined or defined to be C<1>, libev will compile in support for the 4698If undefined or defined to be C<1>, libev will compile in support for the
4546C<select>(2) backend. No attempt at auto-detection will be done: if no 4699C<select>(2) backend. No attempt at auto-detection will be done: if no
4547other method takes over, select will be it. Otherwise the select backend 4700other method takes over, select will be it. Otherwise the select backend
4607If defined to be C<1>, libev will compile in support for the Linux 4760If defined to be C<1>, libev will compile in support for the Linux
4608C<epoll>(7) backend. Its availability will be detected at runtime, 4761C<epoll>(7) backend. Its availability will be detected at runtime,
4609otherwise another method will be used as fallback. This is the preferred 4762otherwise another method will be used as fallback. This is the preferred
4610backend for GNU/Linux systems. If undefined, it will be enabled if the 4763backend for GNU/Linux systems. If undefined, it will be enabled if the
4611headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled. 4764headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4765
4766=item EV_USE_LINUXAIO
4767
4768If defined to be C<1>, libev will compile in support for the Linux aio
4769backend (C<EV_USE_EPOLL> must also be enabled). If undefined, it will be
4770enabled on linux, otherwise disabled.
4771
4772=item EV_USE_IOURING
4773
4774If defined to be C<1>, libev will compile in support for the Linux
4775io_uring backend (C<EV_USE_EPOLL> must also be enabled). Due to it's
4776current limitations it has to be requested explicitly. If undefined, it
4777will be enabled on linux, otherwise disabled.
4612 4778
4613=item EV_USE_KQUEUE 4779=item EV_USE_KQUEUE
4614 4780
4615If defined to be C<1>, libev will compile in support for the BSD style 4781If defined to be C<1>, libev will compile in support for the BSD style
4616C<kqueue>(2) backend. Its actual availability will be detected at runtime, 4782C<kqueue>(2) backend. Its actual availability will be detected at runtime,
4894called. If set to C<2>, then the internal verification code will be 5060called. If set to C<2>, then the internal verification code will be
4895called once per loop, which can slow down libev. If set to C<3>, then the 5061called once per loop, which can slow down libev. If set to C<3>, then the
4896verification code will be called very frequently, which will slow down 5062verification code will be called very frequently, which will slow down
4897libev considerably. 5063libev considerably.
4898 5064
5065Verification errors are reported via C's C<assert> mechanism, so if you
5066disable that (e.g. by defining C<NDEBUG>) then no errors will be reported.
5067
4899The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it 5068The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4900will be C<0>. 5069will be C<0>.
4901 5070
4902=item EV_COMMON 5071=item EV_COMMON
4903 5072

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines