… | |
… | |
98 | =head2 FEATURES |
98 | =head2 FEATURES |
99 | |
99 | |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
103 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
103 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
104 | with customised rescheduling (C<ev_periodic>), synchronous signals |
104 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
105 | (C<ev_signal>), process status change events (C<ev_child>), and event |
105 | timers (C<ev_timer>), absolute timers with customised rescheduling |
106 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
106 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
107 | C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as |
107 | change events (C<ev_child>), and event watchers dealing with the event |
108 | file watchers (C<ev_stat>) and even limited support for fork events |
108 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
109 | (C<ev_fork>). |
109 | C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even |
|
|
110 | limited support for fork events (C<ev_fork>). |
110 | |
111 | |
111 | It also is quite fast (see this |
112 | It also is quite fast (see this |
112 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | for example). |
114 | for example). |
114 | |
115 | |
… | |
… | |
117 | Libev is very configurable. In this manual the default (and most common) |
118 | Libev is very configurable. In this manual the default (and most common) |
118 | configuration will be described, which supports multiple event loops. For |
119 | configuration will be described, which supports multiple event loops. For |
119 | more info about various configuration options please have a look at |
120 | more info about various configuration options please have a look at |
120 | B<EMBED> section in this manual. If libev was configured without support |
121 | B<EMBED> section in this manual. If libev was configured without support |
121 | for multiple event loops, then all functions taking an initial argument of |
122 | for multiple event loops, then all functions taking an initial argument of |
122 | name C<loop> (which is always of type C<ev_loop *>) will not have |
123 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
123 | this argument. |
124 | this argument. |
124 | |
125 | |
125 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
126 | |
127 | |
127 | Libev represents time as a single floating point number, representing |
128 | Libev represents time as a single floating point number, representing |
… | |
… | |
362 | flag. |
363 | flag. |
363 | |
364 | |
364 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> |
365 | environment variable. |
366 | environment variable. |
366 | |
367 | |
|
|
368 | =item C<EVFLAG_NOINOTIFY> |
|
|
369 | |
|
|
370 | When this flag is specified, then libev will not attempt to use the |
|
|
371 | I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and |
|
|
372 | testing, this flag can be useful to conserve inotify file descriptors, as |
|
|
373 | otherwise each loop using C<ev_stat> watchers consumes one inotify handle. |
|
|
374 | |
|
|
375 | =item C<EVFLAG_SIGNALFD> |
|
|
376 | |
|
|
377 | When this flag is specified, then libev will attempt to use the |
|
|
378 | I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API |
|
|
379 | delivers signals synchronously, which makes it both faster and might make |
|
|
380 | it possible to get the queued signal data. It can also simplify signal |
|
|
381 | handling with threads, as long as you properly block signals in your |
|
|
382 | threads that are not interested in handling them. |
|
|
383 | |
|
|
384 | Signalfd will not be used by default as this changes your signal mask, and |
|
|
385 | there are a lot of shoddy libraries and programs (glib's threadpool for |
|
|
386 | example) that can't properly initialise their signal masks. |
|
|
387 | |
367 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
388 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
368 | |
389 | |
369 | This is your standard select(2) backend. Not I<completely> standard, as |
390 | This is your standard select(2) backend. Not I<completely> standard, as |
370 | libev tries to roll its own fd_set with no limits on the number of fds, |
391 | libev tries to roll its own fd_set with no limits on the number of fds, |
371 | but if that fails, expect a fairly low limit on the number of fds when |
392 | but if that fails, expect a fairly low limit on the number of fds when |
… | |
… | |
394 | |
415 | |
395 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
416 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
396 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
417 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
397 | |
418 | |
398 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
419 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
|
|
420 | |
|
|
421 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
|
|
422 | kernels). |
399 | |
423 | |
400 | For few fds, this backend is a bit little slower than poll and select, |
424 | For few fds, this backend is a bit little slower than poll and select, |
401 | but it scales phenomenally better. While poll and select usually scale |
425 | but it scales phenomenally better. While poll and select usually scale |
402 | like O(total_fds) where n is the total number of fds (or the highest fd), |
426 | like O(total_fds) where n is the total number of fds (or the highest fd), |
403 | epoll scales either O(1) or O(active_fds). |
427 | epoll scales either O(1) or O(active_fds). |
… | |
… | |
518 | |
542 | |
519 | It is definitely not recommended to use this flag. |
543 | It is definitely not recommended to use this flag. |
520 | |
544 | |
521 | =back |
545 | =back |
522 | |
546 | |
523 | If one or more of these are or'ed into the flags value, then only these |
547 | If one or more of the backend flags are or'ed into the flags value, |
524 | backends will be tried (in the reverse order as listed here). If none are |
548 | then only these backends will be tried (in the reverse order as listed |
525 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
549 | here). If none are specified, all backends in C<ev_recommended_backends |
|
|
550 | ()> will be tried. |
526 | |
551 | |
527 | Example: This is the most typical usage. |
552 | Example: This is the most typical usage. |
528 | |
553 | |
529 | if (!ev_default_loop (0)) |
554 | if (!ev_default_loop (0)) |
530 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
555 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
573 | as signal and child watchers) would need to be stopped manually. |
598 | as signal and child watchers) would need to be stopped manually. |
574 | |
599 | |
575 | In general it is not advisable to call this function except in the |
600 | In general it is not advisable to call this function except in the |
576 | rare occasion where you really need to free e.g. the signal handling |
601 | rare occasion where you really need to free e.g. the signal handling |
577 | pipe fds. If you need dynamically allocated loops it is better to use |
602 | pipe fds. If you need dynamically allocated loops it is better to use |
578 | C<ev_loop_new> and C<ev_loop_destroy>). |
603 | C<ev_loop_new> and C<ev_loop_destroy>. |
579 | |
604 | |
580 | =item ev_loop_destroy (loop) |
605 | =item ev_loop_destroy (loop) |
581 | |
606 | |
582 | Like C<ev_default_destroy>, but destroys an event loop created by an |
607 | Like C<ev_default_destroy>, but destroys an event loop created by an |
583 | earlier call to C<ev_loop_new>. |
608 | earlier call to C<ev_loop_new>. |
… | |
… | |
687 | event loop time (see C<ev_now_update>). |
712 | event loop time (see C<ev_now_update>). |
688 | |
713 | |
689 | =item ev_loop (loop, int flags) |
714 | =item ev_loop (loop, int flags) |
690 | |
715 | |
691 | Finally, this is it, the event handler. This function usually is called |
716 | Finally, this is it, the event handler. This function usually is called |
692 | after you initialised all your watchers and you want to start handling |
717 | after you have initialised all your watchers and you want to start |
693 | events. |
718 | handling events. |
694 | |
719 | |
695 | If the flags argument is specified as C<0>, it will not return until |
720 | If the flags argument is specified as C<0>, it will not return until |
696 | either no event watchers are active anymore or C<ev_unloop> was called. |
721 | either no event watchers are active anymore or C<ev_unloop> was called. |
697 | |
722 | |
698 | Please note that an explicit C<ev_unloop> is usually better than |
723 | Please note that an explicit C<ev_unloop> is usually better than |
… | |
… | |
772 | |
797 | |
773 | Ref/unref can be used to add or remove a reference count on the event |
798 | Ref/unref can be used to add or remove a reference count on the event |
774 | loop: Every watcher keeps one reference, and as long as the reference |
799 | loop: Every watcher keeps one reference, and as long as the reference |
775 | count is nonzero, C<ev_loop> will not return on its own. |
800 | count is nonzero, C<ev_loop> will not return on its own. |
776 | |
801 | |
777 | If you have a watcher you never unregister that should not keep C<ev_loop> |
802 | This is useful when you have a watcher that you never intend to |
778 | from returning, call ev_unref() after starting, and ev_ref() before |
803 | unregister, but that nevertheless should not keep C<ev_loop> from |
|
|
804 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
779 | stopping it. |
805 | before stopping it. |
780 | |
806 | |
781 | As an example, libev itself uses this for its internal signal pipe: It |
807 | As an example, libev itself uses this for its internal signal pipe: It |
782 | is not visible to the libev user and should not keep C<ev_loop> from |
808 | is not visible to the libev user and should not keep C<ev_loop> from |
783 | exiting if no event watchers registered by it are active. It is also an |
809 | exiting if no event watchers registered by it are active. It is also an |
784 | excellent way to do this for generic recurring timers or from within |
810 | excellent way to do this for generic recurring timers or from within |
… | |
… | |
856 | more often than 100 times per second: |
882 | more often than 100 times per second: |
857 | |
883 | |
858 | ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); |
884 | ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); |
859 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
885 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
860 | |
886 | |
|
|
887 | =item ev_invoke_pending (loop) |
|
|
888 | |
|
|
889 | This call will simply invoke all pending watchers while resetting their |
|
|
890 | pending state. Normally, C<ev_loop> does this automatically when required, |
|
|
891 | but when overriding the invoke callback this call comes handy. |
|
|
892 | |
|
|
893 | =item int ev_pending_count (loop) |
|
|
894 | |
|
|
895 | Returns the number of pending watchers - zero indicates that no watchers |
|
|
896 | are pending. |
|
|
897 | |
|
|
898 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
|
|
899 | |
|
|
900 | This overrides the invoke pending functionality of the loop: Instead of |
|
|
901 | invoking all pending watchers when there are any, C<ev_loop> will call |
|
|
902 | this callback instead. This is useful, for example, when you want to |
|
|
903 | invoke the actual watchers inside another context (another thread etc.). |
|
|
904 | |
|
|
905 | If you want to reset the callback, use C<ev_invoke_pending> as new |
|
|
906 | callback. |
|
|
907 | |
|
|
908 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
|
|
909 | |
|
|
910 | Sometimes you want to share the same loop between multiple threads. This |
|
|
911 | can be done relatively simply by putting mutex_lock/unlock calls around |
|
|
912 | each call to a libev function. |
|
|
913 | |
|
|
914 | However, C<ev_loop> can run an indefinite time, so it is not feasible to |
|
|
915 | wait for it to return. One way around this is to wake up the loop via |
|
|
916 | C<ev_unloop> and C<av_async_send>, another way is to set these I<release> |
|
|
917 | and I<acquire> callbacks on the loop. |
|
|
918 | |
|
|
919 | When set, then C<release> will be called just before the thread is |
|
|
920 | suspended waiting for new events, and C<acquire> is called just |
|
|
921 | afterwards. |
|
|
922 | |
|
|
923 | Ideally, C<release> will just call your mutex_unlock function, and |
|
|
924 | C<acquire> will just call the mutex_lock function again. |
|
|
925 | |
|
|
926 | While event loop modifications are allowed between invocations of |
|
|
927 | C<release> and C<acquire> (that's their only purpose after all), no |
|
|
928 | modifications done will affect the event loop, i.e. adding watchers will |
|
|
929 | have no effect on the set of file descriptors being watched, or the time |
|
|
930 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
|
|
931 | to take note of any changes you made. |
|
|
932 | |
|
|
933 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
|
|
934 | invocations of C<release> and C<acquire>. |
|
|
935 | |
|
|
936 | See also the locking example in the C<THREADS> section later in this |
|
|
937 | document. |
|
|
938 | |
|
|
939 | =item ev_set_userdata (loop, void *data) |
|
|
940 | |
|
|
941 | =item ev_userdata (loop) |
|
|
942 | |
|
|
943 | Set and retrieve a single C<void *> associated with a loop. When |
|
|
944 | C<ev_set_userdata> has never been called, then C<ev_userdata> returns |
|
|
945 | C<0.> |
|
|
946 | |
|
|
947 | These two functions can be used to associate arbitrary data with a loop, |
|
|
948 | and are intended solely for the C<invoke_pending_cb>, C<release> and |
|
|
949 | C<acquire> callbacks described above, but of course can be (ab-)used for |
|
|
950 | any other purpose as well. |
|
|
951 | |
861 | =item ev_loop_verify (loop) |
952 | =item ev_loop_verify (loop) |
862 | |
953 | |
863 | This function only does something when C<EV_VERIFY> support has been |
954 | This function only does something when C<EV_VERIFY> support has been |
864 | compiled in, which is the default for non-minimal builds. It tries to go |
955 | compiled in, which is the default for non-minimal builds. It tries to go |
865 | through all internal structures and checks them for validity. If anything |
956 | through all internal structures and checks them for validity. If anything |
… | |
… | |
1041 | |
1132 | |
1042 | ev_io w; |
1133 | ev_io w; |
1043 | ev_init (&w, my_cb); |
1134 | ev_init (&w, my_cb); |
1044 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1135 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1045 | |
1136 | |
1046 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
1137 | =item C<ev_TYPE_set> (ev_TYPE *watcher, [args]) |
1047 | |
1138 | |
1048 | This macro initialises the type-specific parts of a watcher. You need to |
1139 | This macro initialises the type-specific parts of a watcher. You need to |
1049 | call C<ev_init> at least once before you call this macro, but you can |
1140 | call C<ev_init> at least once before you call this macro, but you can |
1050 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1141 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1051 | macro on a watcher that is active (it can be pending, however, which is a |
1142 | macro on a watcher that is active (it can be pending, however, which is a |
… | |
… | |
1064 | |
1155 | |
1065 | Example: Initialise and set an C<ev_io> watcher in one step. |
1156 | Example: Initialise and set an C<ev_io> watcher in one step. |
1066 | |
1157 | |
1067 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1158 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1068 | |
1159 | |
1069 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
1160 | =item C<ev_TYPE_start> (loop, ev_TYPE *watcher) |
1070 | |
1161 | |
1071 | Starts (activates) the given watcher. Only active watchers will receive |
1162 | Starts (activates) the given watcher. Only active watchers will receive |
1072 | events. If the watcher is already active nothing will happen. |
1163 | events. If the watcher is already active nothing will happen. |
1073 | |
1164 | |
1074 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1165 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1075 | whole section. |
1166 | whole section. |
1076 | |
1167 | |
1077 | ev_io_start (EV_DEFAULT_UC, &w); |
1168 | ev_io_start (EV_DEFAULT_UC, &w); |
1078 | |
1169 | |
1079 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
1170 | =item C<ev_TYPE_stop> (loop, ev_TYPE *watcher) |
1080 | |
1171 | |
1081 | Stops the given watcher if active, and clears the pending status (whether |
1172 | Stops the given watcher if active, and clears the pending status (whether |
1082 | the watcher was active or not). |
1173 | the watcher was active or not). |
1083 | |
1174 | |
1084 | It is possible that stopped watchers are pending - for example, |
1175 | It is possible that stopped watchers are pending - for example, |
… | |
… | |
1109 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1200 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1110 | |
1201 | |
1111 | Change the callback. You can change the callback at virtually any time |
1202 | Change the callback. You can change the callback at virtually any time |
1112 | (modulo threads). |
1203 | (modulo threads). |
1113 | |
1204 | |
1114 | =item ev_set_priority (ev_TYPE *watcher, priority) |
1205 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1115 | |
1206 | |
1116 | =item int ev_priority (ev_TYPE *watcher) |
1207 | =item int ev_priority (ev_TYPE *watcher) |
1117 | |
1208 | |
1118 | Set and query the priority of the watcher. The priority is a small |
1209 | Set and query the priority of the watcher. The priority is a small |
1119 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1210 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
… | |
… | |
1150 | returns its C<revents> bitset (as if its callback was invoked). If the |
1241 | returns its C<revents> bitset (as if its callback was invoked). If the |
1151 | watcher isn't pending it does nothing and returns C<0>. |
1242 | watcher isn't pending it does nothing and returns C<0>. |
1152 | |
1243 | |
1153 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1244 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1154 | callback to be invoked, which can be accomplished with this function. |
1245 | callback to be invoked, which can be accomplished with this function. |
|
|
1246 | |
|
|
1247 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
|
|
1248 | |
|
|
1249 | Feeds the given event set into the event loop, as if the specified event |
|
|
1250 | had happened for the specified watcher (which must be a pointer to an |
|
|
1251 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1252 | not free the watcher as long as it has pending events. |
|
|
1253 | |
|
|
1254 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1255 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
|
|
1256 | not started in the first place. |
|
|
1257 | |
|
|
1258 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
|
|
1259 | functions that do not need a watcher. |
1155 | |
1260 | |
1156 | =back |
1261 | =back |
1157 | |
1262 | |
1158 | |
1263 | |
1159 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1264 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
1433 | |
1538 | |
1434 | So when you encounter spurious, unexplained daemon exits, make sure you |
1539 | So when you encounter spurious, unexplained daemon exits, make sure you |
1435 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1540 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1436 | somewhere, as that would have given you a big clue). |
1541 | somewhere, as that would have given you a big clue). |
1437 | |
1542 | |
|
|
1543 | =head3 The special problem of accept()ing when you can't |
|
|
1544 | |
|
|
1545 | Many implementations of the POSIX C<accept> function (for example, |
|
|
1546 | found in port-2004 Linux) have the peculiar behaviour of not removing a |
|
|
1547 | connection from the pending queue in all error cases. |
|
|
1548 | |
|
|
1549 | For example, larger servers often run out of file descriptors (because |
|
|
1550 | of resource limits), causing C<accept> to fail with C<ENFILE> but not |
|
|
1551 | rejecting the connection, leading to libev signalling readiness on |
|
|
1552 | the next iteration again (the connection still exists after all), and |
|
|
1553 | typically causing the program to loop at 100% CPU usage. |
|
|
1554 | |
|
|
1555 | Unfortunately, the set of errors that cause this issue differs between |
|
|
1556 | operating systems, there is usually little the app can do to remedy the |
|
|
1557 | situation, and no known thread-safe method of removing the connection to |
|
|
1558 | cope with overload is known (to me). |
|
|
1559 | |
|
|
1560 | One of the easiest ways to handle this situation is to just ignore it |
|
|
1561 | - when the program encounters an overload, it will just loop until the |
|
|
1562 | situation is over. While this is a form of busy waiting, no OS offers an |
|
|
1563 | event-based way to handle this situation, so it's the best one can do. |
|
|
1564 | |
|
|
1565 | A better way to handle the situation is to log any errors other than |
|
|
1566 | C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such |
|
|
1567 | messages, and continue as usual, which at least gives the user an idea of |
|
|
1568 | what could be wrong ("raise the ulimit!"). For extra points one could stop |
|
|
1569 | the C<ev_io> watcher on the listening fd "for a while", which reduces CPU |
|
|
1570 | usage. |
|
|
1571 | |
|
|
1572 | If your program is single-threaded, then you could also keep a dummy file |
|
|
1573 | descriptor for overload situations (e.g. by opening F</dev/null>), and |
|
|
1574 | when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>, |
|
|
1575 | close that fd, and create a new dummy fd. This will gracefully refuse |
|
|
1576 | clients under typical overload conditions. |
|
|
1577 | |
|
|
1578 | The last way to handle it is to simply log the error and C<exit>, as |
|
|
1579 | is often done with C<malloc> failures, but this results in an easy |
|
|
1580 | opportunity for a DoS attack. |
1438 | |
1581 | |
1439 | =head3 Watcher-Specific Functions |
1582 | =head3 Watcher-Specific Functions |
1440 | |
1583 | |
1441 | =over 4 |
1584 | =over 4 |
1442 | |
1585 | |
… | |
… | |
1690 | |
1833 | |
1691 | If the event loop is suspended for a long time, you can also force an |
1834 | If the event loop is suspended for a long time, you can also force an |
1692 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1835 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1693 | ()>. |
1836 | ()>. |
1694 | |
1837 | |
|
|
1838 | =head3 The special problems of suspended animation |
|
|
1839 | |
|
|
1840 | When you leave the server world it is quite customary to hit machines that |
|
|
1841 | can suspend/hibernate - what happens to the clocks during such a suspend? |
|
|
1842 | |
|
|
1843 | Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes |
|
|
1844 | all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue |
|
|
1845 | to run until the system is suspended, but they will not advance while the |
|
|
1846 | system is suspended. That means, on resume, it will be as if the program |
|
|
1847 | was frozen for a few seconds, but the suspend time will not be counted |
|
|
1848 | towards C<ev_timer> when a monotonic clock source is used. The real time |
|
|
1849 | clock advanced as expected, but if it is used as sole clocksource, then a |
|
|
1850 | long suspend would be detected as a time jump by libev, and timers would |
|
|
1851 | be adjusted accordingly. |
|
|
1852 | |
|
|
1853 | I would not be surprised to see different behaviour in different between |
|
|
1854 | operating systems, OS versions or even different hardware. |
|
|
1855 | |
|
|
1856 | The other form of suspend (job control, or sending a SIGSTOP) will see a |
|
|
1857 | time jump in the monotonic clocks and the realtime clock. If the program |
|
|
1858 | is suspended for a very long time, and monotonic clock sources are in use, |
|
|
1859 | then you can expect C<ev_timer>s to expire as the full suspension time |
|
|
1860 | will be counted towards the timers. When no monotonic clock source is in |
|
|
1861 | use, then libev will again assume a timejump and adjust accordingly. |
|
|
1862 | |
|
|
1863 | It might be beneficial for this latter case to call C<ev_suspend> |
|
|
1864 | and C<ev_resume> in code that handles C<SIGTSTP>, to at least get |
|
|
1865 | deterministic behaviour in this case (you can do nothing against |
|
|
1866 | C<SIGSTOP>). |
|
|
1867 | |
1695 | =head3 Watcher-Specific Functions and Data Members |
1868 | =head3 Watcher-Specific Functions and Data Members |
1696 | |
1869 | |
1697 | =over 4 |
1870 | =over 4 |
1698 | |
1871 | |
1699 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1872 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
… | |
… | |
1724 | If the timer is repeating, either start it if necessary (with the |
1897 | If the timer is repeating, either start it if necessary (with the |
1725 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1898 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1726 | |
1899 | |
1727 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1900 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1728 | usage example. |
1901 | usage example. |
|
|
1902 | |
|
|
1903 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
|
|
1904 | |
|
|
1905 | Returns the remaining time until a timer fires. If the timer is active, |
|
|
1906 | then this time is relative to the current event loop time, otherwise it's |
|
|
1907 | the timeout value currently configured. |
|
|
1908 | |
|
|
1909 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
|
|
1910 | C<5>. When the timer is started and one second passes, C<ev_timer_remaining> |
|
|
1911 | will return C<4>. When the timer expires and is restarted, it will return |
|
|
1912 | roughly C<7> (likely slightly less as callback invocation takes some time, |
|
|
1913 | too), and so on. |
1729 | |
1914 | |
1730 | =item ev_tstamp repeat [read-write] |
1915 | =item ev_tstamp repeat [read-write] |
1731 | |
1916 | |
1732 | The current C<repeat> value. Will be used each time the watcher times out |
1917 | The current C<repeat> value. Will be used each time the watcher times out |
1733 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
1918 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
… | |
… | |
1969 | Signal watchers will trigger an event when the process receives a specific |
2154 | Signal watchers will trigger an event when the process receives a specific |
1970 | signal one or more times. Even though signals are very asynchronous, libev |
2155 | signal one or more times. Even though signals are very asynchronous, libev |
1971 | will try it's best to deliver signals synchronously, i.e. as part of the |
2156 | will try it's best to deliver signals synchronously, i.e. as part of the |
1972 | normal event processing, like any other event. |
2157 | normal event processing, like any other event. |
1973 | |
2158 | |
1974 | If you want signals asynchronously, just use C<sigaction> as you would |
2159 | If you want signals to be delivered truly asynchronously, just use |
1975 | do without libev and forget about sharing the signal. You can even use |
2160 | C<sigaction> as you would do without libev and forget about sharing |
1976 | C<ev_async> from a signal handler to synchronously wake up an event loop. |
2161 | the signal. You can even use C<ev_async> from a signal handler to |
|
|
2162 | synchronously wake up an event loop. |
1977 | |
2163 | |
1978 | You can configure as many watchers as you like per signal. Only when the |
2164 | You can configure as many watchers as you like for the same signal, but |
|
|
2165 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
|
|
2166 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
|
|
2167 | C<SIGINT> in both the default loop and another loop at the same time. At |
|
|
2168 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
|
|
2169 | |
1979 | first watcher gets started will libev actually register a signal handler |
2170 | When the first watcher gets started will libev actually register something |
1980 | with the kernel (thus it coexists with your own signal handlers as long as |
2171 | with the kernel (thus it coexists with your own signal handlers as long as |
1981 | you don't register any with libev for the same signal). Similarly, when |
2172 | you don't register any with libev for the same signal). |
1982 | the last signal watcher for a signal is stopped, libev will reset the |
|
|
1983 | signal handler to SIG_DFL (regardless of what it was set to before). |
|
|
1984 | |
2173 | |
1985 | If possible and supported, libev will install its handlers with |
2174 | If possible and supported, libev will install its handlers with |
1986 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
2175 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
1987 | interrupted. If you have a problem with system calls getting interrupted by |
2176 | not be unduly interrupted. If you have a problem with system calls getting |
1988 | signals you can block all signals in an C<ev_check> watcher and unblock |
2177 | interrupted by signals you can block all signals in an C<ev_check> watcher |
1989 | them in an C<ev_prepare> watcher. |
2178 | and unblock them in an C<ev_prepare> watcher. |
|
|
2179 | |
|
|
2180 | =head3 The special problem of inheritance over fork/execve/pthread_create |
|
|
2181 | |
|
|
2182 | Both the signal mask (C<sigprocmask>) and the signal disposition |
|
|
2183 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2184 | stopping it again), that is, libev might or might not block the signal, |
|
|
2185 | and might or might not set or restore the installed signal handler. |
|
|
2186 | |
|
|
2187 | While this does not matter for the signal disposition (libev never |
|
|
2188 | sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on |
|
|
2189 | C<execve>), this matters for the signal mask: many programs do not expect |
|
|
2190 | certain signals to be blocked. |
|
|
2191 | |
|
|
2192 | This means that before calling C<exec> (from the child) you should reset |
|
|
2193 | the signal mask to whatever "default" you expect (all clear is a good |
|
|
2194 | choice usually). |
|
|
2195 | |
|
|
2196 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2197 | to install a fork handler with C<pthread_atfork> that resets it. That will |
|
|
2198 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2199 | |
|
|
2200 | In current versions of libev, the signal will not be blocked indefinitely |
|
|
2201 | unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces |
|
|
2202 | the window of opportunity for problems, it will not go away, as libev |
|
|
2203 | I<has> to modify the signal mask, at least temporarily. |
|
|
2204 | |
|
|
2205 | So I can't stress this enough: I<If you do not reset your signal mask when |
|
|
2206 | you expect it to be empty, you have a race condition in your code>. This |
|
|
2207 | is not a libev-specific thing, this is true for most event libraries. |
1990 | |
2208 | |
1991 | =head3 Watcher-Specific Functions and Data Members |
2209 | =head3 Watcher-Specific Functions and Data Members |
1992 | |
2210 | |
1993 | =over 4 |
2211 | =over 4 |
1994 | |
2212 | |
… | |
… | |
2039 | libev) |
2257 | libev) |
2040 | |
2258 | |
2041 | =head3 Process Interaction |
2259 | =head3 Process Interaction |
2042 | |
2260 | |
2043 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2261 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2044 | initialised. This is necessary to guarantee proper behaviour even if |
2262 | initialised. This is necessary to guarantee proper behaviour even if the |
2045 | the first child watcher is started after the child exits. The occurrence |
2263 | first child watcher is started after the child exits. The occurrence |
2046 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2264 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2047 | synchronously as part of the event loop processing. Libev always reaps all |
2265 | synchronously as part of the event loop processing. Libev always reaps all |
2048 | children, even ones not watched. |
2266 | children, even ones not watched. |
2049 | |
2267 | |
2050 | =head3 Overriding the Built-In Processing |
2268 | =head3 Overriding the Built-In Processing |
… | |
… | |
2060 | =head3 Stopping the Child Watcher |
2278 | =head3 Stopping the Child Watcher |
2061 | |
2279 | |
2062 | Currently, the child watcher never gets stopped, even when the |
2280 | Currently, the child watcher never gets stopped, even when the |
2063 | child terminates, so normally one needs to stop the watcher in the |
2281 | child terminates, so normally one needs to stop the watcher in the |
2064 | callback. Future versions of libev might stop the watcher automatically |
2282 | callback. Future versions of libev might stop the watcher automatically |
2065 | when a child exit is detected. |
2283 | when a child exit is detected (calling C<ev_child_stop> twice is not a |
|
|
2284 | problem). |
2066 | |
2285 | |
2067 | =head3 Watcher-Specific Functions and Data Members |
2286 | =head3 Watcher-Specific Functions and Data Members |
2068 | |
2287 | |
2069 | =over 4 |
2288 | =over 4 |
2070 | |
2289 | |
… | |
… | |
2810 | =head3 Queueing |
3029 | =head3 Queueing |
2811 | |
3030 | |
2812 | C<ev_async> does not support queueing of data in any way. The reason |
3031 | C<ev_async> does not support queueing of data in any way. The reason |
2813 | is that the author does not know of a simple (or any) algorithm for a |
3032 | is that the author does not know of a simple (or any) algorithm for a |
2814 | multiple-writer-single-reader queue that works in all cases and doesn't |
3033 | multiple-writer-single-reader queue that works in all cases and doesn't |
2815 | need elaborate support such as pthreads. |
3034 | need elaborate support such as pthreads or unportable memory access |
|
|
3035 | semantics. |
2816 | |
3036 | |
2817 | That means that if you want to queue data, you have to provide your own |
3037 | That means that if you want to queue data, you have to provide your own |
2818 | queue. But at least I can tell you how to implement locking around your |
3038 | queue. But at least I can tell you how to implement locking around your |
2819 | queue: |
3039 | queue: |
2820 | |
3040 | |
… | |
… | |
2978 | /* doh, nothing entered */; |
3198 | /* doh, nothing entered */; |
2979 | } |
3199 | } |
2980 | |
3200 | |
2981 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3201 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2982 | |
3202 | |
2983 | =item ev_feed_event (struct ev_loop *, watcher *, int revents) |
|
|
2984 | |
|
|
2985 | Feeds the given event set into the event loop, as if the specified event |
|
|
2986 | had happened for the specified watcher (which must be a pointer to an |
|
|
2987 | initialised but not necessarily started event watcher). |
|
|
2988 | |
|
|
2989 | =item ev_feed_fd_event (struct ev_loop *, int fd, int revents) |
3203 | =item ev_feed_fd_event (loop, int fd, int revents) |
2990 | |
3204 | |
2991 | Feed an event on the given fd, as if a file descriptor backend detected |
3205 | Feed an event on the given fd, as if a file descriptor backend detected |
2992 | the given events it. |
3206 | the given events it. |
2993 | |
3207 | |
2994 | =item ev_feed_signal_event (struct ev_loop *loop, int signum) |
3208 | =item ev_feed_signal_event (loop, int signum) |
2995 | |
3209 | |
2996 | Feed an event as if the given signal occurred (C<loop> must be the default |
3210 | Feed an event as if the given signal occurred (C<loop> must be the default |
2997 | loop!). |
3211 | loop!). |
2998 | |
3212 | |
2999 | =back |
3213 | =back |
… | |
… | |
3079 | |
3293 | |
3080 | =over 4 |
3294 | =over 4 |
3081 | |
3295 | |
3082 | =item ev::TYPE::TYPE () |
3296 | =item ev::TYPE::TYPE () |
3083 | |
3297 | |
3084 | =item ev::TYPE::TYPE (struct ev_loop *) |
3298 | =item ev::TYPE::TYPE (loop) |
3085 | |
3299 | |
3086 | =item ev::TYPE::~TYPE |
3300 | =item ev::TYPE::~TYPE |
3087 | |
3301 | |
3088 | The constructor (optionally) takes an event loop to associate the watcher |
3302 | The constructor (optionally) takes an event loop to associate the watcher |
3089 | with. If it is omitted, it will use C<EV_DEFAULT>. |
3303 | with. If it is omitted, it will use C<EV_DEFAULT>. |
… | |
… | |
3166 | Example: Use a plain function as callback. |
3380 | Example: Use a plain function as callback. |
3167 | |
3381 | |
3168 | static void io_cb (ev::io &w, int revents) { } |
3382 | static void io_cb (ev::io &w, int revents) { } |
3169 | iow.set <io_cb> (); |
3383 | iow.set <io_cb> (); |
3170 | |
3384 | |
3171 | =item w->set (struct ev_loop *) |
3385 | =item w->set (loop) |
3172 | |
3386 | |
3173 | Associates a different C<struct ev_loop> with this watcher. You can only |
3387 | Associates a different C<struct ev_loop> with this watcher. You can only |
3174 | do this when the watcher is inactive (and not pending either). |
3388 | do this when the watcher is inactive (and not pending either). |
3175 | |
3389 | |
3176 | =item w->set ([arguments]) |
3390 | =item w->set ([arguments]) |
… | |
… | |
3273 | =item Ocaml |
3487 | =item Ocaml |
3274 | |
3488 | |
3275 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3489 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3276 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3490 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3277 | |
3491 | |
|
|
3492 | =item Lua |
|
|
3493 | |
|
|
3494 | Brian Maher has written a partial interface to libev for lua (at the |
|
|
3495 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
|
|
3496 | L<http://github.com/brimworks/lua-ev>. |
|
|
3497 | |
3278 | =back |
3498 | =back |
3279 | |
3499 | |
3280 | |
3500 | |
3281 | =head1 MACRO MAGIC |
3501 | =head1 MACRO MAGIC |
3282 | |
3502 | |
… | |
… | |
3435 | libev.m4 |
3655 | libev.m4 |
3436 | |
3656 | |
3437 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3657 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3438 | |
3658 | |
3439 | Libev can be configured via a variety of preprocessor symbols you have to |
3659 | Libev can be configured via a variety of preprocessor symbols you have to |
3440 | define before including any of its files. The default in the absence of |
3660 | define before including (or compiling) any of its files. The default in |
3441 | autoconf is documented for every option. |
3661 | the absence of autoconf is documented for every option. |
|
|
3662 | |
|
|
3663 | Symbols marked with "(h)" do not change the ABI, and can have different |
|
|
3664 | values when compiling libev vs. including F<ev.h>, so it is permissible |
|
|
3665 | to redefine them before including F<ev.h> without breakign compatibility |
|
|
3666 | to a compiled library. All other symbols change the ABI, which means all |
|
|
3667 | users of libev and the libev code itself must be compiled with compatible |
|
|
3668 | settings. |
3442 | |
3669 | |
3443 | =over 4 |
3670 | =over 4 |
3444 | |
3671 | |
3445 | =item EV_STANDALONE |
3672 | =item EV_STANDALONE (h) |
3446 | |
3673 | |
3447 | Must always be C<1> if you do not use autoconf configuration, which |
3674 | Must always be C<1> if you do not use autoconf configuration, which |
3448 | keeps libev from including F<config.h>, and it also defines dummy |
3675 | keeps libev from including F<config.h>, and it also defines dummy |
3449 | implementations for some libevent functions (such as logging, which is not |
3676 | implementations for some libevent functions (such as logging, which is not |
3450 | supported). It will also not define any of the structs usually found in |
3677 | supported). It will also not define any of the structs usually found in |
3451 | F<event.h> that are not directly supported by the libev core alone. |
3678 | F<event.h> that are not directly supported by the libev core alone. |
3452 | |
3679 | |
3453 | In stanbdalone mode, libev will still try to automatically deduce the |
3680 | In standalone mode, libev will still try to automatically deduce the |
3454 | configuration, but has to be more conservative. |
3681 | configuration, but has to be more conservative. |
3455 | |
3682 | |
3456 | =item EV_USE_MONOTONIC |
3683 | =item EV_USE_MONOTONIC |
3457 | |
3684 | |
3458 | If defined to be C<1>, libev will try to detect the availability of the |
3685 | If defined to be C<1>, libev will try to detect the availability of the |
… | |
… | |
3523 | be used is the winsock select). This means that it will call |
3750 | be used is the winsock select). This means that it will call |
3524 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3751 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3525 | it is assumed that all these functions actually work on fds, even |
3752 | it is assumed that all these functions actually work on fds, even |
3526 | on win32. Should not be defined on non-win32 platforms. |
3753 | on win32. Should not be defined on non-win32 platforms. |
3527 | |
3754 | |
3528 | =item EV_FD_TO_WIN32_HANDLE |
3755 | =item EV_FD_TO_WIN32_HANDLE(fd) |
3529 | |
3756 | |
3530 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3757 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3531 | file descriptors to socket handles. When not defining this symbol (the |
3758 | file descriptors to socket handles. When not defining this symbol (the |
3532 | default), then libev will call C<_get_osfhandle>, which is usually |
3759 | default), then libev will call C<_get_osfhandle>, which is usually |
3533 | correct. In some cases, programs use their own file descriptor management, |
3760 | correct. In some cases, programs use their own file descriptor management, |
3534 | in which case they can provide this function to map fds to socket handles. |
3761 | in which case they can provide this function to map fds to socket handles. |
|
|
3762 | |
|
|
3763 | =item EV_WIN32_HANDLE_TO_FD(handle) |
|
|
3764 | |
|
|
3765 | If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors |
|
|
3766 | using the standard C<_open_osfhandle> function. For programs implementing |
|
|
3767 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
3768 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
3769 | |
|
|
3770 | =item EV_WIN32_CLOSE_FD(fd) |
|
|
3771 | |
|
|
3772 | If programs implement their own fd to handle mapping on win32, then this |
|
|
3773 | macro can be used to override the C<close> function, useful to unregister |
|
|
3774 | file descriptors again. Note that the replacement function has to close |
|
|
3775 | the underlying OS handle. |
3535 | |
3776 | |
3536 | =item EV_USE_POLL |
3777 | =item EV_USE_POLL |
3537 | |
3778 | |
3538 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3779 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3539 | backend. Otherwise it will be enabled on non-win32 platforms. It |
3780 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
3586 | as well as for signal and thread safety in C<ev_async> watchers. |
3827 | as well as for signal and thread safety in C<ev_async> watchers. |
3587 | |
3828 | |
3588 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3829 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3589 | (from F<signal.h>), which is usually good enough on most platforms. |
3830 | (from F<signal.h>), which is usually good enough on most platforms. |
3590 | |
3831 | |
3591 | =item EV_H |
3832 | =item EV_H (h) |
3592 | |
3833 | |
3593 | The name of the F<ev.h> header file used to include it. The default if |
3834 | The name of the F<ev.h> header file used to include it. The default if |
3594 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3835 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3595 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3836 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3596 | |
3837 | |
3597 | =item EV_CONFIG_H |
3838 | =item EV_CONFIG_H (h) |
3598 | |
3839 | |
3599 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3840 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3600 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3841 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3601 | C<EV_H>, above. |
3842 | C<EV_H>, above. |
3602 | |
3843 | |
3603 | =item EV_EVENT_H |
3844 | =item EV_EVENT_H (h) |
3604 | |
3845 | |
3605 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3846 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3606 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3847 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3607 | |
3848 | |
3608 | =item EV_PROTOTYPES |
3849 | =item EV_PROTOTYPES (h) |
3609 | |
3850 | |
3610 | If defined to be C<0>, then F<ev.h> will not define any function |
3851 | If defined to be C<0>, then F<ev.h> will not define any function |
3611 | prototypes, but still define all the structs and other symbols. This is |
3852 | prototypes, but still define all the structs and other symbols. This is |
3612 | occasionally useful if you want to provide your own wrapper functions |
3853 | occasionally useful if you want to provide your own wrapper functions |
3613 | around libev functions. |
3854 | around libev functions. |
… | |
… | |
3635 | fine. |
3876 | fine. |
3636 | |
3877 | |
3637 | If your embedding application does not need any priorities, defining these |
3878 | If your embedding application does not need any priorities, defining these |
3638 | both to C<0> will save some memory and CPU. |
3879 | both to C<0> will save some memory and CPU. |
3639 | |
3880 | |
3640 | =item EV_PERIODIC_ENABLE |
3881 | =item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, |
|
|
3882 | EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, |
|
|
3883 | EV_ASYNC_ENABLE, EV_CHILD_ENABLE. |
3641 | |
3884 | |
3642 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3885 | If undefined or defined to be C<1> (and the platform supports it), then |
3643 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
3886 | the respective watcher type is supported. If defined to be C<0>, then it |
3644 | code. |
3887 | is not. Disabling watcher types mainly saves codesize. |
3645 | |
3888 | |
3646 | =item EV_IDLE_ENABLE |
3889 | =item EV_FEATURES |
3647 | |
|
|
3648 | If undefined or defined to be C<1>, then idle watchers are supported. If |
|
|
3649 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
|
|
3650 | code. |
|
|
3651 | |
|
|
3652 | =item EV_EMBED_ENABLE |
|
|
3653 | |
|
|
3654 | If undefined or defined to be C<1>, then embed watchers are supported. If |
|
|
3655 | defined to be C<0>, then they are not. Embed watchers rely on most other |
|
|
3656 | watcher types, which therefore must not be disabled. |
|
|
3657 | |
|
|
3658 | =item EV_STAT_ENABLE |
|
|
3659 | |
|
|
3660 | If undefined or defined to be C<1>, then stat watchers are supported. If |
|
|
3661 | defined to be C<0>, then they are not. |
|
|
3662 | |
|
|
3663 | =item EV_FORK_ENABLE |
|
|
3664 | |
|
|
3665 | If undefined or defined to be C<1>, then fork watchers are supported. If |
|
|
3666 | defined to be C<0>, then they are not. |
|
|
3667 | |
|
|
3668 | =item EV_ASYNC_ENABLE |
|
|
3669 | |
|
|
3670 | If undefined or defined to be C<1>, then async watchers are supported. If |
|
|
3671 | defined to be C<0>, then they are not. |
|
|
3672 | |
|
|
3673 | =item EV_MINIMAL |
|
|
3674 | |
3890 | |
3675 | If you need to shave off some kilobytes of code at the expense of some |
3891 | If you need to shave off some kilobytes of code at the expense of some |
3676 | speed (but with the full API), define this symbol to C<1>. Currently this |
3892 | speed (but with the full API), you can define this symbol to request |
3677 | is used to override some inlining decisions, saves roughly 30% code size |
3893 | certain subsets of functionality. The default is to enable all features |
3678 | on amd64. It also selects a much smaller 2-heap for timer management over |
3894 | that can be enabled on the platform. |
3679 | the default 4-heap. |
|
|
3680 | |
3895 | |
3681 | You can save even more by disabling watcher types you do not need and |
3896 | Note that using autoconf will usually override most of the features, so |
3682 | setting C<EV_MAXPRI> == C<EV_MINPRI>. |
3897 | using this symbol makes sense mostly when embedding libev. |
|
|
3898 | |
|
|
3899 | A typical way to use this symbol is to define it to C<0> (or to a bitset |
|
|
3900 | with some broad features you want) and then selectively re-enable |
|
|
3901 | additional parts you want, for example if you want everything minimal, |
|
|
3902 | but multiple event loop support, async and child watchers and the poll |
|
|
3903 | backend, use this: |
|
|
3904 | |
|
|
3905 | #define EV_FEATURES 0 |
|
|
3906 | #define EV_MULTIPLICITY 1 |
|
|
3907 | #define EV_USE_POLL 1 |
|
|
3908 | #define EV_CHILD_ENABLE 1 |
|
|
3909 | #define EV_ASYNC_ENABLE 1 |
|
|
3910 | |
|
|
3911 | The actual value is a bitset, it can be a combination of the following |
|
|
3912 | values: |
|
|
3913 | |
|
|
3914 | =over 4 |
|
|
3915 | |
|
|
3916 | =item C<1> - faster/larger code |
|
|
3917 | |
|
|
3918 | Use larger code to speed up some operations. |
|
|
3919 | |
|
|
3920 | Currently this is used to override some inlining decisions (enlarging the roughly |
|
|
3921 | 30% code size on amd64. |
|
|
3922 | |
|
|
3923 | Also disables C<assert>'s in the code, unless you define C<NDEBUG> |
|
|
3924 | explicitly to C<0>. |
|
|
3925 | |
|
|
3926 | Use of compiler flags such as C<-Os> with gcc that optimise for size are |
|
|
3927 | recommended when disabling this feature. |
|
|
3928 | |
|
|
3929 | =item C<2> - faster/larger data structures |
|
|
3930 | |
|
|
3931 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
|
|
3932 | hash table sizes and so on. This will usually further increase codesize |
|
|
3933 | and can additionally have an effect on the size of data structures at |
|
|
3934 | runtime. |
|
|
3935 | |
|
|
3936 | =item C<4> - full API configuration |
|
|
3937 | |
|
|
3938 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
|
|
3939 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
|
|
3940 | |
|
|
3941 | It also enables a lot of the "lesser used" core API functions. See C<ev.h> |
|
|
3942 | for details on which parts of the API are still available without this |
|
|
3943 | feature, and do not complain if this subset changes over time. |
|
|
3944 | |
|
|
3945 | =item C<8> - enable all optional watcher types |
|
|
3946 | |
|
|
3947 | Enables all optional watcher types. If you want to selectively enable |
|
|
3948 | only some watcher types other than I/O and timers (e.g. prepare, |
|
|
3949 | embed, async, child...) you can enable them manually by defining |
|
|
3950 | C<EV_watchertype_ENABLE> to C<1> instead. |
|
|
3951 | |
|
|
3952 | =item C<16> - enable all backends |
|
|
3953 | |
|
|
3954 | This enables all backends - without this feature, you need to enable at |
|
|
3955 | least one backend manually (C<EV_USE_SELECT> is a good choice). |
|
|
3956 | |
|
|
3957 | =item C<32> - enable OS-specific "helper" APIs |
|
|
3958 | |
|
|
3959 | Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by |
|
|
3960 | default. |
|
|
3961 | |
|
|
3962 | =back |
|
|
3963 | |
|
|
3964 | Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0> |
|
|
3965 | reduces the compiled size of libev from 24.7Kb to 6.5Kb on my GNU/Linux |
|
|
3966 | amd64 system, while still giving you I/O watchers, timers and monotonic |
|
|
3967 | clock support. |
|
|
3968 | |
|
|
3969 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
|
|
3970 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
|
|
3971 | your program might be left out as well - a binary starting a timer and an |
|
|
3972 | I/O watcher then might come out at only 5Kb. |
|
|
3973 | |
|
|
3974 | =item EV_AVOID_STDIO |
|
|
3975 | |
|
|
3976 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
|
|
3977 | functions (printf, scanf, perror etc.). This will increase the codesize |
|
|
3978 | somewhat, but if your program doesn't otherwise depend on stdio and your |
|
|
3979 | libc allows it, this avoids linking in the stdio library which is quite |
|
|
3980 | big. |
|
|
3981 | |
|
|
3982 | Note that error messages might become less precise when this option is |
|
|
3983 | enabled. |
|
|
3984 | |
|
|
3985 | =item EV_NSIG |
|
|
3986 | |
|
|
3987 | The highest supported signal number, +1 (or, the number of |
|
|
3988 | signals): Normally, libev tries to deduce the maximum number of signals |
|
|
3989 | automatically, but sometimes this fails, in which case it can be |
|
|
3990 | specified. Also, using a lower number than detected (C<32> should be |
|
|
3991 | good for about any system in existance) can save some memory, as libev |
|
|
3992 | statically allocates some 12-24 bytes per signal number. |
3683 | |
3993 | |
3684 | =item EV_PID_HASHSIZE |
3994 | =item EV_PID_HASHSIZE |
3685 | |
3995 | |
3686 | C<ev_child> watchers use a small hash table to distribute workload by |
3996 | C<ev_child> watchers use a small hash table to distribute workload by |
3687 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
3997 | pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled), |
3688 | than enough. If you need to manage thousands of children you might want to |
3998 | usually more than enough. If you need to manage thousands of children you |
3689 | increase this value (I<must> be a power of two). |
3999 | might want to increase this value (I<must> be a power of two). |
3690 | |
4000 | |
3691 | =item EV_INOTIFY_HASHSIZE |
4001 | =item EV_INOTIFY_HASHSIZE |
3692 | |
4002 | |
3693 | C<ev_stat> watchers use a small hash table to distribute workload by |
4003 | C<ev_stat> watchers use a small hash table to distribute workload by |
3694 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
4004 | inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES> |
3695 | usually more than enough. If you need to manage thousands of C<ev_stat> |
4005 | disabled), usually more than enough. If you need to manage thousands of |
3696 | watchers you might want to increase this value (I<must> be a power of |
4006 | C<ev_stat> watchers you might want to increase this value (I<must> be a |
3697 | two). |
4007 | power of two). |
3698 | |
4008 | |
3699 | =item EV_USE_4HEAP |
4009 | =item EV_USE_4HEAP |
3700 | |
4010 | |
3701 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4011 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3702 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
4012 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
3703 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
4013 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
3704 | faster performance with many (thousands) of watchers. |
4014 | faster performance with many (thousands) of watchers. |
3705 | |
4015 | |
3706 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4016 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3707 | (disabled). |
4017 | will be C<0>. |
3708 | |
4018 | |
3709 | =item EV_HEAP_CACHE_AT |
4019 | =item EV_HEAP_CACHE_AT |
3710 | |
4020 | |
3711 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4021 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3712 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
4022 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
3713 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
4023 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3714 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
4024 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3715 | but avoids random read accesses on heap changes. This improves performance |
4025 | but avoids random read accesses on heap changes. This improves performance |
3716 | noticeably with many (hundreds) of watchers. |
4026 | noticeably with many (hundreds) of watchers. |
3717 | |
4027 | |
3718 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4028 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3719 | (disabled). |
4029 | will be C<0>. |
3720 | |
4030 | |
3721 | =item EV_VERIFY |
4031 | =item EV_VERIFY |
3722 | |
4032 | |
3723 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
4033 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
3724 | be done: If set to C<0>, no internal verification code will be compiled |
4034 | be done: If set to C<0>, no internal verification code will be compiled |
… | |
… | |
3726 | called. If set to C<2>, then the internal verification code will be |
4036 | called. If set to C<2>, then the internal verification code will be |
3727 | called once per loop, which can slow down libev. If set to C<3>, then the |
4037 | called once per loop, which can slow down libev. If set to C<3>, then the |
3728 | verification code will be called very frequently, which will slow down |
4038 | verification code will be called very frequently, which will slow down |
3729 | libev considerably. |
4039 | libev considerably. |
3730 | |
4040 | |
3731 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
4041 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3732 | C<0>. |
4042 | will be C<0>. |
3733 | |
4043 | |
3734 | =item EV_COMMON |
4044 | =item EV_COMMON |
3735 | |
4045 | |
3736 | By default, all watchers have a C<void *data> member. By redefining |
4046 | By default, all watchers have a C<void *data> member. By redefining |
3737 | this macro to a something else you can include more and other types of |
4047 | this macro to a something else you can include more and other types of |
… | |
… | |
3795 | file. |
4105 | file. |
3796 | |
4106 | |
3797 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
4107 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
3798 | that everybody includes and which overrides some configure choices: |
4108 | that everybody includes and which overrides some configure choices: |
3799 | |
4109 | |
3800 | #define EV_MINIMAL 1 |
4110 | #define EV_FEATURES 0 |
3801 | #define EV_USE_POLL 0 |
4111 | #define EV_USE_SELECT 1 |
3802 | #define EV_MULTIPLICITY 0 |
|
|
3803 | #define EV_PERIODIC_ENABLE 0 |
|
|
3804 | #define EV_STAT_ENABLE 0 |
|
|
3805 | #define EV_FORK_ENABLE 0 |
|
|
3806 | #define EV_CONFIG_H <config.h> |
4112 | #define EV_CONFIG_H <config.h> |
3807 | #define EV_MINPRI 0 |
|
|
3808 | #define EV_MAXPRI 0 |
|
|
3809 | |
4113 | |
3810 | #include "ev++.h" |
4114 | #include "ev++.h" |
3811 | |
4115 | |
3812 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
4116 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3813 | |
4117 | |
… | |
… | |
3873 | default loop and triggering an C<ev_async> watcher from the default loop |
4177 | default loop and triggering an C<ev_async> watcher from the default loop |
3874 | watcher callback into the event loop interested in the signal. |
4178 | watcher callback into the event loop interested in the signal. |
3875 | |
4179 | |
3876 | =back |
4180 | =back |
3877 | |
4181 | |
|
|
4182 | =head4 THREAD LOCKING EXAMPLE |
|
|
4183 | |
|
|
4184 | Here is a fictitious example of how to run an event loop in a different |
|
|
4185 | thread than where callbacks are being invoked and watchers are |
|
|
4186 | created/added/removed. |
|
|
4187 | |
|
|
4188 | For a real-world example, see the C<EV::Loop::Async> perl module, |
|
|
4189 | which uses exactly this technique (which is suited for many high-level |
|
|
4190 | languages). |
|
|
4191 | |
|
|
4192 | The example uses a pthread mutex to protect the loop data, a condition |
|
|
4193 | variable to wait for callback invocations, an async watcher to notify the |
|
|
4194 | event loop thread and an unspecified mechanism to wake up the main thread. |
|
|
4195 | |
|
|
4196 | First, you need to associate some data with the event loop: |
|
|
4197 | |
|
|
4198 | typedef struct { |
|
|
4199 | mutex_t lock; /* global loop lock */ |
|
|
4200 | ev_async async_w; |
|
|
4201 | thread_t tid; |
|
|
4202 | cond_t invoke_cv; |
|
|
4203 | } userdata; |
|
|
4204 | |
|
|
4205 | void prepare_loop (EV_P) |
|
|
4206 | { |
|
|
4207 | // for simplicity, we use a static userdata struct. |
|
|
4208 | static userdata u; |
|
|
4209 | |
|
|
4210 | ev_async_init (&u->async_w, async_cb); |
|
|
4211 | ev_async_start (EV_A_ &u->async_w); |
|
|
4212 | |
|
|
4213 | pthread_mutex_init (&u->lock, 0); |
|
|
4214 | pthread_cond_init (&u->invoke_cv, 0); |
|
|
4215 | |
|
|
4216 | // now associate this with the loop |
|
|
4217 | ev_set_userdata (EV_A_ u); |
|
|
4218 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
|
|
4219 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
|
|
4220 | |
|
|
4221 | // then create the thread running ev_loop |
|
|
4222 | pthread_create (&u->tid, 0, l_run, EV_A); |
|
|
4223 | } |
|
|
4224 | |
|
|
4225 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
|
|
4226 | solely to wake up the event loop so it takes notice of any new watchers |
|
|
4227 | that might have been added: |
|
|
4228 | |
|
|
4229 | static void |
|
|
4230 | async_cb (EV_P_ ev_async *w, int revents) |
|
|
4231 | { |
|
|
4232 | // just used for the side effects |
|
|
4233 | } |
|
|
4234 | |
|
|
4235 | The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex |
|
|
4236 | protecting the loop data, respectively. |
|
|
4237 | |
|
|
4238 | static void |
|
|
4239 | l_release (EV_P) |
|
|
4240 | { |
|
|
4241 | userdata *u = ev_userdata (EV_A); |
|
|
4242 | pthread_mutex_unlock (&u->lock); |
|
|
4243 | } |
|
|
4244 | |
|
|
4245 | static void |
|
|
4246 | l_acquire (EV_P) |
|
|
4247 | { |
|
|
4248 | userdata *u = ev_userdata (EV_A); |
|
|
4249 | pthread_mutex_lock (&u->lock); |
|
|
4250 | } |
|
|
4251 | |
|
|
4252 | The event loop thread first acquires the mutex, and then jumps straight |
|
|
4253 | into C<ev_loop>: |
|
|
4254 | |
|
|
4255 | void * |
|
|
4256 | l_run (void *thr_arg) |
|
|
4257 | { |
|
|
4258 | struct ev_loop *loop = (struct ev_loop *)thr_arg; |
|
|
4259 | |
|
|
4260 | l_acquire (EV_A); |
|
|
4261 | pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
|
|
4262 | ev_loop (EV_A_ 0); |
|
|
4263 | l_release (EV_A); |
|
|
4264 | |
|
|
4265 | return 0; |
|
|
4266 | } |
|
|
4267 | |
|
|
4268 | Instead of invoking all pending watchers, the C<l_invoke> callback will |
|
|
4269 | signal the main thread via some unspecified mechanism (signals? pipe |
|
|
4270 | writes? C<Async::Interrupt>?) and then waits until all pending watchers |
|
|
4271 | have been called (in a while loop because a) spurious wakeups are possible |
|
|
4272 | and b) skipping inter-thread-communication when there are no pending |
|
|
4273 | watchers is very beneficial): |
|
|
4274 | |
|
|
4275 | static void |
|
|
4276 | l_invoke (EV_P) |
|
|
4277 | { |
|
|
4278 | userdata *u = ev_userdata (EV_A); |
|
|
4279 | |
|
|
4280 | while (ev_pending_count (EV_A)) |
|
|
4281 | { |
|
|
4282 | wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
|
|
4283 | pthread_cond_wait (&u->invoke_cv, &u->lock); |
|
|
4284 | } |
|
|
4285 | } |
|
|
4286 | |
|
|
4287 | Now, whenever the main thread gets told to invoke pending watchers, it |
|
|
4288 | will grab the lock, call C<ev_invoke_pending> and then signal the loop |
|
|
4289 | thread to continue: |
|
|
4290 | |
|
|
4291 | static void |
|
|
4292 | real_invoke_pending (EV_P) |
|
|
4293 | { |
|
|
4294 | userdata *u = ev_userdata (EV_A); |
|
|
4295 | |
|
|
4296 | pthread_mutex_lock (&u->lock); |
|
|
4297 | ev_invoke_pending (EV_A); |
|
|
4298 | pthread_cond_signal (&u->invoke_cv); |
|
|
4299 | pthread_mutex_unlock (&u->lock); |
|
|
4300 | } |
|
|
4301 | |
|
|
4302 | Whenever you want to start/stop a watcher or do other modifications to an |
|
|
4303 | event loop, you will now have to lock: |
|
|
4304 | |
|
|
4305 | ev_timer timeout_watcher; |
|
|
4306 | userdata *u = ev_userdata (EV_A); |
|
|
4307 | |
|
|
4308 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
4309 | |
|
|
4310 | pthread_mutex_lock (&u->lock); |
|
|
4311 | ev_timer_start (EV_A_ &timeout_watcher); |
|
|
4312 | ev_async_send (EV_A_ &u->async_w); |
|
|
4313 | pthread_mutex_unlock (&u->lock); |
|
|
4314 | |
|
|
4315 | Note that sending the C<ev_async> watcher is required because otherwise |
|
|
4316 | an event loop currently blocking in the kernel will have no knowledge |
|
|
4317 | about the newly added timer. By waking up the loop it will pick up any new |
|
|
4318 | watchers in the next event loop iteration. |
|
|
4319 | |
3878 | =head3 COROUTINES |
4320 | =head3 COROUTINES |
3879 | |
4321 | |
3880 | Libev is very accommodating to coroutines ("cooperative threads"): |
4322 | Libev is very accommodating to coroutines ("cooperative threads"): |
3881 | libev fully supports nesting calls to its functions from different |
4323 | libev fully supports nesting calls to its functions from different |
3882 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4324 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3883 | different coroutines, and switch freely between both coroutines running the |
4325 | different coroutines, and switch freely between both coroutines running |
3884 | loop, as long as you don't confuse yourself). The only exception is that |
4326 | the loop, as long as you don't confuse yourself). The only exception is |
3885 | you must not do this from C<ev_periodic> reschedule callbacks. |
4327 | that you must not do this from C<ev_periodic> reschedule callbacks. |
3886 | |
4328 | |
3887 | Care has been taken to ensure that libev does not keep local state inside |
4329 | Care has been taken to ensure that libev does not keep local state inside |
3888 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
4330 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3889 | they do not call any callbacks. |
4331 | they do not call any callbacks. |
3890 | |
4332 | |