… | |
… | |
62 | |
62 | |
63 | // unloop was called, so exit |
63 | // unloop was called, so exit |
64 | return 0; |
64 | return 0; |
65 | } |
65 | } |
66 | |
66 | |
67 | =head1 DESCRIPTION |
67 | =head1 ABOUT THIS DOCUMENT |
|
|
68 | |
|
|
69 | This document documents the libev software package. |
68 | |
70 | |
69 | The newest version of this document is also available as an html-formatted |
71 | The newest version of this document is also available as an html-formatted |
70 | web page you might find easier to navigate when reading it for the first |
72 | web page you might find easier to navigate when reading it for the first |
71 | time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
73 | time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>. |
|
|
74 | |
|
|
75 | While this document tries to be as complete as possible in documenting |
|
|
76 | libev, its usage and the rationale behind its design, it is not a tutorial |
|
|
77 | on event-based programming, nor will it introduce event-based programming |
|
|
78 | with libev. |
|
|
79 | |
|
|
80 | Familarity with event based programming techniques in general is assumed |
|
|
81 | throughout this document. |
|
|
82 | |
|
|
83 | =head1 ABOUT LIBEV |
72 | |
84 | |
73 | Libev is an event loop: you register interest in certain events (such as a |
85 | Libev is an event loop: you register interest in certain events (such as a |
74 | file descriptor being readable or a timeout occurring), and it will manage |
86 | file descriptor being readable or a timeout occurring), and it will manage |
75 | these event sources and provide your program with events. |
87 | these event sources and provide your program with events. |
76 | |
88 | |
… | |
… | |
86 | =head2 FEATURES |
98 | =head2 FEATURES |
87 | |
99 | |
88 | 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 |
89 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
90 | 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 |
91 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
103 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
92 | with customised rescheduling (C<ev_periodic>), synchronous signals |
104 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
93 | (C<ev_signal>), process status change events (C<ev_child>), and event |
105 | timers (C<ev_timer>), absolute timers with customised rescheduling |
94 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
106 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
95 | 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 |
96 | 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 |
97 | (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>). |
98 | |
111 | |
99 | It also is quite fast (see this |
112 | It also is quite fast (see this |
100 | 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 |
101 | for example). |
114 | for example). |
102 | |
115 | |
… | |
… | |
105 | 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) |
106 | configuration will be described, which supports multiple event loops. For |
119 | configuration will be described, which supports multiple event loops. For |
107 | more info about various configuration options please have a look at |
120 | more info about various configuration options please have a look at |
108 | 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 |
109 | 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 |
110 | 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 |
111 | this argument. |
124 | this argument. |
112 | |
125 | |
113 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
114 | |
127 | |
115 | Libev represents time as a single floating point number, representing the |
128 | Libev represents time as a single floating point number, representing |
116 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
129 | the (fractional) number of seconds since the (POSIX) epoch (somewhere |
117 | the beginning of 1970, details are complicated, don't ask). This type is |
130 | near the beginning of 1970, details are complicated, don't ask). This |
118 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
131 | type is called C<ev_tstamp>, which is what you should use too. It usually |
119 | to the C<double> type in C, and when you need to do any calculations on |
132 | aliases to the C<double> type in C. When you need to do any calculations |
120 | it, you should treat it as some floating point value. Unlike the name |
133 | on it, you should treat it as some floating point value. Unlike the name |
121 | component C<stamp> might indicate, it is also used for time differences |
134 | component C<stamp> might indicate, it is also used for time differences |
122 | throughout libev. |
135 | throughout libev. |
123 | |
136 | |
124 | =head1 ERROR HANDLING |
137 | =head1 ERROR HANDLING |
125 | |
138 | |
… | |
… | |
350 | flag. |
363 | flag. |
351 | |
364 | |
352 | 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> |
353 | environment variable. |
366 | environment variable. |
354 | |
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 | |
355 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
388 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
356 | |
389 | |
357 | 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 |
358 | 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, |
359 | 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 |
… | |
… | |
382 | |
415 | |
383 | 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 |
384 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
417 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
385 | |
418 | |
386 | =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). |
387 | |
423 | |
388 | 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, |
389 | but it scales phenomenally better. While poll and select usually scale |
425 | but it scales phenomenally better. While poll and select usually scale |
390 | 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), |
391 | epoll scales either O(1) or O(active_fds). |
427 | epoll scales either O(1) or O(active_fds). |
… | |
… | |
506 | |
542 | |
507 | It is definitely not recommended to use this flag. |
543 | It is definitely not recommended to use this flag. |
508 | |
544 | |
509 | =back |
545 | =back |
510 | |
546 | |
511 | 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, |
512 | 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 |
513 | 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. |
514 | |
551 | |
515 | Example: This is the most typical usage. |
552 | Example: This is the most typical usage. |
516 | |
553 | |
517 | if (!ev_default_loop (0)) |
554 | if (!ev_default_loop (0)) |
518 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
555 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
530 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
567 | ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); |
531 | |
568 | |
532 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
569 | =item struct ev_loop *ev_loop_new (unsigned int flags) |
533 | |
570 | |
534 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
571 | Similar to C<ev_default_loop>, but always creates a new event loop that is |
535 | always distinct from the default loop. Unlike the default loop, it cannot |
572 | always distinct from the default loop. |
536 | handle signal and child watchers, and attempts to do so will be greeted by |
|
|
537 | undefined behaviour (or a failed assertion if assertions are enabled). |
|
|
538 | |
573 | |
539 | Note that this function I<is> thread-safe, and the recommended way to use |
574 | Note that this function I<is> thread-safe, and one common way to use |
540 | libev with threads is indeed to create one loop per thread, and using the |
575 | libev with threads is indeed to create one loop per thread, and using the |
541 | default loop in the "main" or "initial" thread. |
576 | default loop in the "main" or "initial" thread. |
542 | |
577 | |
543 | Example: Try to create a event loop that uses epoll and nothing else. |
578 | Example: Try to create a event loop that uses epoll and nothing else. |
544 | |
579 | |
… | |
… | |
546 | if (!epoller) |
581 | if (!epoller) |
547 | fatal ("no epoll found here, maybe it hides under your chair"); |
582 | fatal ("no epoll found here, maybe it hides under your chair"); |
548 | |
583 | |
549 | =item ev_default_destroy () |
584 | =item ev_default_destroy () |
550 | |
585 | |
551 | Destroys the default loop again (frees all memory and kernel state |
586 | Destroys the default loop (frees all memory and kernel state etc.). None |
552 | etc.). None of the active event watchers will be stopped in the normal |
587 | of the active event watchers will be stopped in the normal sense, so |
553 | sense, so e.g. C<ev_is_active> might still return true. It is your |
588 | e.g. C<ev_is_active> might still return true. It is your responsibility to |
554 | responsibility to either stop all watchers cleanly yourself I<before> |
589 | either stop all watchers cleanly yourself I<before> calling this function, |
555 | calling this function, or cope with the fact afterwards (which is usually |
590 | or cope with the fact afterwards (which is usually the easiest thing, you |
556 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
591 | can just ignore the watchers and/or C<free ()> them for example). |
557 | for example). |
|
|
558 | |
592 | |
559 | Note that certain global state, such as signal state (and installed signal |
593 | Note that certain global state, such as signal state (and installed signal |
560 | handlers), will not be freed by this function, and related watchers (such |
594 | handlers), will not be freed by this function, and related watchers (such |
561 | as signal and child watchers) would need to be stopped manually. |
595 | as signal and child watchers) would need to be stopped manually. |
562 | |
596 | |
563 | In general it is not advisable to call this function except in the |
597 | In general it is not advisable to call this function except in the |
564 | rare occasion where you really need to free e.g. the signal handling |
598 | rare occasion where you really need to free e.g. the signal handling |
565 | pipe fds. If you need dynamically allocated loops it is better to use |
599 | pipe fds. If you need dynamically allocated loops it is better to use |
566 | C<ev_loop_new> and C<ev_loop_destroy>). |
600 | C<ev_loop_new> and C<ev_loop_destroy>. |
567 | |
601 | |
568 | =item ev_loop_destroy (loop) |
602 | =item ev_loop_destroy (loop) |
569 | |
603 | |
570 | Like C<ev_default_destroy>, but destroys an event loop created by an |
604 | Like C<ev_default_destroy>, but destroys an event loop created by an |
571 | earlier call to C<ev_loop_new>. |
605 | earlier call to C<ev_loop_new>. |
… | |
… | |
609 | |
643 | |
610 | This value can sometimes be useful as a generation counter of sorts (it |
644 | This value can sometimes be useful as a generation counter of sorts (it |
611 | "ticks" the number of loop iterations), as it roughly corresponds with |
645 | "ticks" the number of loop iterations), as it roughly corresponds with |
612 | C<ev_prepare> and C<ev_check> calls. |
646 | C<ev_prepare> and C<ev_check> calls. |
613 | |
647 | |
|
|
648 | =item unsigned int ev_loop_depth (loop) |
|
|
649 | |
|
|
650 | Returns the number of times C<ev_loop> was entered minus the number of |
|
|
651 | times C<ev_loop> was exited, in other words, the recursion depth. |
|
|
652 | |
|
|
653 | Outside C<ev_loop>, this number is zero. In a callback, this number is |
|
|
654 | C<1>, unless C<ev_loop> was invoked recursively (or from another thread), |
|
|
655 | in which case it is higher. |
|
|
656 | |
|
|
657 | Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread |
|
|
658 | etc.), doesn't count as exit. |
|
|
659 | |
614 | =item unsigned int ev_backend (loop) |
660 | =item unsigned int ev_backend (loop) |
615 | |
661 | |
616 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
662 | Returns one of the C<EVBACKEND_*> flags indicating the event backend in |
617 | use. |
663 | use. |
618 | |
664 | |
… | |
… | |
632 | |
678 | |
633 | This function is rarely useful, but when some event callback runs for a |
679 | This function is rarely useful, but when some event callback runs for a |
634 | very long time without entering the event loop, updating libev's idea of |
680 | very long time without entering the event loop, updating libev's idea of |
635 | the current time is a good idea. |
681 | the current time is a good idea. |
636 | |
682 | |
637 | See also "The special problem of time updates" in the C<ev_timer> section. |
683 | See also L<The special problem of time updates> in the C<ev_timer> section. |
638 | |
684 | |
639 | =item ev_suspend (loop) |
685 | =item ev_suspend (loop) |
640 | |
686 | |
641 | =item ev_resume (loop) |
687 | =item ev_resume (loop) |
642 | |
688 | |
… | |
… | |
663 | event loop time (see C<ev_now_update>). |
709 | event loop time (see C<ev_now_update>). |
664 | |
710 | |
665 | =item ev_loop (loop, int flags) |
711 | =item ev_loop (loop, int flags) |
666 | |
712 | |
667 | Finally, this is it, the event handler. This function usually is called |
713 | Finally, this is it, the event handler. This function usually is called |
668 | after you initialised all your watchers and you want to start handling |
714 | after you have initialised all your watchers and you want to start |
669 | events. |
715 | handling events. |
670 | |
716 | |
671 | If the flags argument is specified as C<0>, it will not return until |
717 | If the flags argument is specified as C<0>, it will not return until |
672 | either no event watchers are active anymore or C<ev_unloop> was called. |
718 | either no event watchers are active anymore or C<ev_unloop> was called. |
673 | |
719 | |
674 | Please note that an explicit C<ev_unloop> is usually better than |
720 | Please note that an explicit C<ev_unloop> is usually better than |
… | |
… | |
748 | |
794 | |
749 | Ref/unref can be used to add or remove a reference count on the event |
795 | Ref/unref can be used to add or remove a reference count on the event |
750 | loop: Every watcher keeps one reference, and as long as the reference |
796 | loop: Every watcher keeps one reference, and as long as the reference |
751 | count is nonzero, C<ev_loop> will not return on its own. |
797 | count is nonzero, C<ev_loop> will not return on its own. |
752 | |
798 | |
753 | If you have a watcher you never unregister that should not keep C<ev_loop> |
799 | This is useful when you have a watcher that you never intend to |
754 | from returning, call ev_unref() after starting, and ev_ref() before |
800 | unregister, but that nevertheless should not keep C<ev_loop> from |
|
|
801 | returning. In such a case, call C<ev_unref> after starting, and C<ev_ref> |
755 | stopping it. |
802 | before stopping it. |
756 | |
803 | |
757 | As an example, libev itself uses this for its internal signal pipe: It |
804 | As an example, libev itself uses this for its internal signal pipe: It |
758 | is not visible to the libev user and should not keep C<ev_loop> from |
805 | is not visible to the libev user and should not keep C<ev_loop> from |
759 | exiting if no event watchers registered by it are active. It is also an |
806 | exiting if no event watchers registered by it are active. It is also an |
760 | excellent way to do this for generic recurring timers or from within |
807 | excellent way to do this for generic recurring timers or from within |
… | |
… | |
799 | |
846 | |
800 | By setting a higher I<io collect interval> you allow libev to spend more |
847 | By setting a higher I<io collect interval> you allow libev to spend more |
801 | time collecting I/O events, so you can handle more events per iteration, |
848 | time collecting I/O events, so you can handle more events per iteration, |
802 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
849 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
803 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
850 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
804 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
851 | introduce an additional C<ev_sleep ()> call into most loop iterations. The |
|
|
852 | sleep time ensures that libev will not poll for I/O events more often then |
|
|
853 | once per this interval, on average. |
805 | |
854 | |
806 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
855 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
807 | to spend more time collecting timeouts, at the expense of increased |
856 | to spend more time collecting timeouts, at the expense of increased |
808 | latency/jitter/inexactness (the watcher callback will be called |
857 | latency/jitter/inexactness (the watcher callback will be called |
809 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
858 | later). C<ev_io> watchers will not be affected. Setting this to a non-null |
… | |
… | |
811 | |
860 | |
812 | Many (busy) programs can usually benefit by setting the I/O collect |
861 | Many (busy) programs can usually benefit by setting the I/O collect |
813 | interval to a value near C<0.1> or so, which is often enough for |
862 | interval to a value near C<0.1> or so, which is often enough for |
814 | interactive servers (of course not for games), likewise for timeouts. It |
863 | interactive servers (of course not for games), likewise for timeouts. It |
815 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
864 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
816 | as this approaches the timing granularity of most systems. |
865 | as this approaches the timing granularity of most systems. Note that if |
|
|
866 | you do transactions with the outside world and you can't increase the |
|
|
867 | parallelity, then this setting will limit your transaction rate (if you |
|
|
868 | need to poll once per transaction and the I/O collect interval is 0.01, |
|
|
869 | then you can't do more than 100 transations per second). |
817 | |
870 | |
818 | Setting the I<timeout collect interval> can improve the opportunity for |
871 | Setting the I<timeout collect interval> can improve the opportunity for |
819 | saving power, as the program will "bundle" timer callback invocations that |
872 | saving power, as the program will "bundle" timer callback invocations that |
820 | are "near" in time together, by delaying some, thus reducing the number of |
873 | are "near" in time together, by delaying some, thus reducing the number of |
821 | times the process sleeps and wakes up again. Another useful technique to |
874 | times the process sleeps and wakes up again. Another useful technique to |
822 | reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure |
875 | reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure |
823 | they fire on, say, one-second boundaries only. |
876 | they fire on, say, one-second boundaries only. |
824 | |
877 | |
|
|
878 | Example: we only need 0.1s timeout granularity, and we wish not to poll |
|
|
879 | more often than 100 times per second: |
|
|
880 | |
|
|
881 | ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); |
|
|
882 | ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); |
|
|
883 | |
|
|
884 | =item ev_invoke_pending (loop) |
|
|
885 | |
|
|
886 | This call will simply invoke all pending watchers while resetting their |
|
|
887 | pending state. Normally, C<ev_loop> does this automatically when required, |
|
|
888 | but when overriding the invoke callback this call comes handy. |
|
|
889 | |
|
|
890 | =item int ev_pending_count (loop) |
|
|
891 | |
|
|
892 | Returns the number of pending watchers - zero indicates that no watchers |
|
|
893 | are pending. |
|
|
894 | |
|
|
895 | =item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P)) |
|
|
896 | |
|
|
897 | This overrides the invoke pending functionality of the loop: Instead of |
|
|
898 | invoking all pending watchers when there are any, C<ev_loop> will call |
|
|
899 | this callback instead. This is useful, for example, when you want to |
|
|
900 | invoke the actual watchers inside another context (another thread etc.). |
|
|
901 | |
|
|
902 | If you want to reset the callback, use C<ev_invoke_pending> as new |
|
|
903 | callback. |
|
|
904 | |
|
|
905 | =item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) |
|
|
906 | |
|
|
907 | Sometimes you want to share the same loop between multiple threads. This |
|
|
908 | can be done relatively simply by putting mutex_lock/unlock calls around |
|
|
909 | each call to a libev function. |
|
|
910 | |
|
|
911 | However, C<ev_loop> can run an indefinite time, so it is not feasible to |
|
|
912 | wait for it to return. One way around this is to wake up the loop via |
|
|
913 | C<ev_unloop> and C<av_async_send>, another way is to set these I<release> |
|
|
914 | and I<acquire> callbacks on the loop. |
|
|
915 | |
|
|
916 | When set, then C<release> will be called just before the thread is |
|
|
917 | suspended waiting for new events, and C<acquire> is called just |
|
|
918 | afterwards. |
|
|
919 | |
|
|
920 | Ideally, C<release> will just call your mutex_unlock function, and |
|
|
921 | C<acquire> will just call the mutex_lock function again. |
|
|
922 | |
|
|
923 | While event loop modifications are allowed between invocations of |
|
|
924 | C<release> and C<acquire> (that's their only purpose after all), no |
|
|
925 | modifications done will affect the event loop, i.e. adding watchers will |
|
|
926 | have no effect on the set of file descriptors being watched, or the time |
|
|
927 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
|
|
928 | to take note of any changes you made. |
|
|
929 | |
|
|
930 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
|
|
931 | invocations of C<release> and C<acquire>. |
|
|
932 | |
|
|
933 | See also the locking example in the C<THREADS> section later in this |
|
|
934 | document. |
|
|
935 | |
|
|
936 | =item ev_set_userdata (loop, void *data) |
|
|
937 | |
|
|
938 | =item ev_userdata (loop) |
|
|
939 | |
|
|
940 | Set and retrieve a single C<void *> associated with a loop. When |
|
|
941 | C<ev_set_userdata> has never been called, then C<ev_userdata> returns |
|
|
942 | C<0.> |
|
|
943 | |
|
|
944 | These two functions can be used to associate arbitrary data with a loop, |
|
|
945 | and are intended solely for the C<invoke_pending_cb>, C<release> and |
|
|
946 | C<acquire> callbacks described above, but of course can be (ab-)used for |
|
|
947 | any other purpose as well. |
|
|
948 | |
825 | =item ev_loop_verify (loop) |
949 | =item ev_loop_verify (loop) |
826 | |
950 | |
827 | This function only does something when C<EV_VERIFY> support has been |
951 | This function only does something when C<EV_VERIFY> support has been |
828 | compiled in, which is the default for non-minimal builds. It tries to go |
952 | compiled in, which is the default for non-minimal builds. It tries to go |
829 | through all internal structures and checks them for validity. If anything |
953 | through all internal structures and checks them for validity. If anything |
… | |
… | |
905 | =item C<EV_WRITE> |
1029 | =item C<EV_WRITE> |
906 | |
1030 | |
907 | The file descriptor in the C<ev_io> watcher has become readable and/or |
1031 | The file descriptor in the C<ev_io> watcher has become readable and/or |
908 | writable. |
1032 | writable. |
909 | |
1033 | |
910 | =item C<EV_TIMEOUT> |
1034 | =item C<EV_TIMER> |
911 | |
1035 | |
912 | The C<ev_timer> watcher has timed out. |
1036 | The C<ev_timer> watcher has timed out. |
913 | |
1037 | |
914 | =item C<EV_PERIODIC> |
1038 | =item C<EV_PERIODIC> |
915 | |
1039 | |
… | |
… | |
1005 | |
1129 | |
1006 | ev_io w; |
1130 | ev_io w; |
1007 | ev_init (&w, my_cb); |
1131 | ev_init (&w, my_cb); |
1008 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1132 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1009 | |
1133 | |
1010 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
1134 | =item C<ev_TYPE_set> (ev_TYPE *watcher, [args]) |
1011 | |
1135 | |
1012 | This macro initialises the type-specific parts of a watcher. You need to |
1136 | This macro initialises the type-specific parts of a watcher. You need to |
1013 | call C<ev_init> at least once before you call this macro, but you can |
1137 | call C<ev_init> at least once before you call this macro, but you can |
1014 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1138 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1015 | macro on a watcher that is active (it can be pending, however, which is a |
1139 | macro on a watcher that is active (it can be pending, however, which is a |
… | |
… | |
1028 | |
1152 | |
1029 | Example: Initialise and set an C<ev_io> watcher in one step. |
1153 | Example: Initialise and set an C<ev_io> watcher in one step. |
1030 | |
1154 | |
1031 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1155 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1032 | |
1156 | |
1033 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
1157 | =item C<ev_TYPE_start> (loop, ev_TYPE *watcher) |
1034 | |
1158 | |
1035 | Starts (activates) the given watcher. Only active watchers will receive |
1159 | Starts (activates) the given watcher. Only active watchers will receive |
1036 | events. If the watcher is already active nothing will happen. |
1160 | events. If the watcher is already active nothing will happen. |
1037 | |
1161 | |
1038 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1162 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1039 | whole section. |
1163 | whole section. |
1040 | |
1164 | |
1041 | ev_io_start (EV_DEFAULT_UC, &w); |
1165 | ev_io_start (EV_DEFAULT_UC, &w); |
1042 | |
1166 | |
1043 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
1167 | =item C<ev_TYPE_stop> (loop, ev_TYPE *watcher) |
1044 | |
1168 | |
1045 | Stops the given watcher if active, and clears the pending status (whether |
1169 | Stops the given watcher if active, and clears the pending status (whether |
1046 | the watcher was active or not). |
1170 | the watcher was active or not). |
1047 | |
1171 | |
1048 | It is possible that stopped watchers are pending - for example, |
1172 | It is possible that stopped watchers are pending - for example, |
… | |
… | |
1073 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1197 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1074 | |
1198 | |
1075 | Change the callback. You can change the callback at virtually any time |
1199 | Change the callback. You can change the callback at virtually any time |
1076 | (modulo threads). |
1200 | (modulo threads). |
1077 | |
1201 | |
1078 | =item ev_set_priority (ev_TYPE *watcher, priority) |
1202 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1079 | |
1203 | |
1080 | =item int ev_priority (ev_TYPE *watcher) |
1204 | =item int ev_priority (ev_TYPE *watcher) |
1081 | |
1205 | |
1082 | Set and query the priority of the watcher. The priority is a small |
1206 | Set and query the priority of the watcher. The priority is a small |
1083 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1207 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
… | |
… | |
1096 | or might not have been clamped to the valid range. |
1220 | or might not have been clamped to the valid range. |
1097 | |
1221 | |
1098 | The default priority used by watchers when no priority has been set is |
1222 | The default priority used by watchers when no priority has been set is |
1099 | always C<0>, which is supposed to not be too high and not be too low :). |
1223 | always C<0>, which is supposed to not be too high and not be too low :). |
1100 | |
1224 | |
1101 | See L<WATCHER PRIORITIES>, below, for a more thorough treatment of |
1225 | See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of |
1102 | priorities. |
1226 | priorities. |
1103 | |
1227 | |
1104 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1228 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
1105 | |
1229 | |
1106 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
1230 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
… | |
… | |
1114 | returns its C<revents> bitset (as if its callback was invoked). If the |
1238 | returns its C<revents> bitset (as if its callback was invoked). If the |
1115 | watcher isn't pending it does nothing and returns C<0>. |
1239 | watcher isn't pending it does nothing and returns C<0>. |
1116 | |
1240 | |
1117 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1241 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1118 | callback to be invoked, which can be accomplished with this function. |
1242 | callback to be invoked, which can be accomplished with this function. |
|
|
1243 | |
|
|
1244 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
|
|
1245 | |
|
|
1246 | Feeds the given event set into the event loop, as if the specified event |
|
|
1247 | had happened for the specified watcher (which must be a pointer to an |
|
|
1248 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1249 | not free the watcher as long as it has pending events. |
|
|
1250 | |
|
|
1251 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1252 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
|
|
1253 | not started in the first place. |
|
|
1254 | |
|
|
1255 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
|
|
1256 | functions that do not need a watcher. |
1119 | |
1257 | |
1120 | =back |
1258 | =back |
1121 | |
1259 | |
1122 | |
1260 | |
1123 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1261 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
1172 | #include <stddef.h> |
1310 | #include <stddef.h> |
1173 | |
1311 | |
1174 | static void |
1312 | static void |
1175 | t1_cb (EV_P_ ev_timer *w, int revents) |
1313 | t1_cb (EV_P_ ev_timer *w, int revents) |
1176 | { |
1314 | { |
1177 | struct my_biggy big = (struct my_biggy * |
1315 | struct my_biggy big = (struct my_biggy *) |
1178 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1316 | (((char *)w) - offsetof (struct my_biggy, t1)); |
1179 | } |
1317 | } |
1180 | |
1318 | |
1181 | static void |
1319 | static void |
1182 | t2_cb (EV_P_ ev_timer *w, int revents) |
1320 | t2_cb (EV_P_ ev_timer *w, int revents) |
1183 | { |
1321 | { |
1184 | struct my_biggy big = (struct my_biggy * |
1322 | struct my_biggy big = (struct my_biggy *) |
1185 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1323 | (((char *)w) - offsetof (struct my_biggy, t2)); |
1186 | } |
1324 | } |
1187 | |
1325 | |
1188 | =head2 WATCHER PRIORITY MODELS |
1326 | =head2 WATCHER PRIORITY MODELS |
1189 | |
1327 | |
… | |
… | |
1265 | // with the default priority are receiving events. |
1403 | // with the default priority are receiving events. |
1266 | ev_idle_start (EV_A_ &idle); |
1404 | ev_idle_start (EV_A_ &idle); |
1267 | } |
1405 | } |
1268 | |
1406 | |
1269 | static void |
1407 | static void |
1270 | idle-cb (EV_P_ ev_idle *w, int revents) |
1408 | idle_cb (EV_P_ ev_idle *w, int revents) |
1271 | { |
1409 | { |
1272 | // actual processing |
1410 | // actual processing |
1273 | read (STDIN_FILENO, ...); |
1411 | read (STDIN_FILENO, ...); |
1274 | |
1412 | |
1275 | // have to start the I/O watcher again, as |
1413 | // have to start the I/O watcher again, as |
… | |
… | |
1320 | descriptors to non-blocking mode is also usually a good idea (but not |
1458 | descriptors to non-blocking mode is also usually a good idea (but not |
1321 | required if you know what you are doing). |
1459 | required if you know what you are doing). |
1322 | |
1460 | |
1323 | If you cannot use non-blocking mode, then force the use of a |
1461 | If you cannot use non-blocking mode, then force the use of a |
1324 | known-to-be-good backend (at the time of this writing, this includes only |
1462 | known-to-be-good backend (at the time of this writing, this includes only |
1325 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). |
1463 | C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file |
|
|
1464 | descriptors for which non-blocking operation makes no sense (such as |
|
|
1465 | files) - libev doesn't guarentee any specific behaviour in that case. |
1326 | |
1466 | |
1327 | Another thing you have to watch out for is that it is quite easy to |
1467 | Another thing you have to watch out for is that it is quite easy to |
1328 | receive "spurious" readiness notifications, that is your callback might |
1468 | receive "spurious" readiness notifications, that is your callback might |
1329 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1469 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
1330 | because there is no data. Not only are some backends known to create a |
1470 | because there is no data. Not only are some backends known to create a |
… | |
… | |
1395 | |
1535 | |
1396 | So when you encounter spurious, unexplained daemon exits, make sure you |
1536 | So when you encounter spurious, unexplained daemon exits, make sure you |
1397 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1537 | ignore SIGPIPE (and maybe make sure you log the exit status of your daemon |
1398 | somewhere, as that would have given you a big clue). |
1538 | somewhere, as that would have given you a big clue). |
1399 | |
1539 | |
|
|
1540 | =head3 The special problem of accept()ing when you can't |
|
|
1541 | |
|
|
1542 | Many implementations of the POSIX C<accept> function (for example, |
|
|
1543 | found in port-2004 Linux) have the peculiar behaviour of not removing a |
|
|
1544 | connection from the pending queue in all error cases. |
|
|
1545 | |
|
|
1546 | For example, larger servers often run out of file descriptors (because |
|
|
1547 | of resource limits), causing C<accept> to fail with C<ENFILE> but not |
|
|
1548 | rejecting the connection, leading to libev signalling readiness on |
|
|
1549 | the next iteration again (the connection still exists after all), and |
|
|
1550 | typically causing the program to loop at 100% CPU usage. |
|
|
1551 | |
|
|
1552 | Unfortunately, the set of errors that cause this issue differs between |
|
|
1553 | operating systems, there is usually little the app can do to remedy the |
|
|
1554 | situation, and no known thread-safe method of removing the connection to |
|
|
1555 | cope with overload is known (to me). |
|
|
1556 | |
|
|
1557 | One of the easiest ways to handle this situation is to just ignore it |
|
|
1558 | - when the program encounters an overload, it will just loop until the |
|
|
1559 | situation is over. While this is a form of busy waiting, no OS offers an |
|
|
1560 | event-based way to handle this situation, so it's the best one can do. |
|
|
1561 | |
|
|
1562 | A better way to handle the situation is to log any errors other than |
|
|
1563 | C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such |
|
|
1564 | messages, and continue as usual, which at least gives the user an idea of |
|
|
1565 | what could be wrong ("raise the ulimit!"). For extra points one could stop |
|
|
1566 | the C<ev_io> watcher on the listening fd "for a while", which reduces CPU |
|
|
1567 | usage. |
|
|
1568 | |
|
|
1569 | If your program is single-threaded, then you could also keep a dummy file |
|
|
1570 | descriptor for overload situations (e.g. by opening F</dev/null>), and |
|
|
1571 | when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>, |
|
|
1572 | close that fd, and create a new dummy fd. This will gracefully refuse |
|
|
1573 | clients under typical overload conditions. |
|
|
1574 | |
|
|
1575 | The last way to handle it is to simply log the error and C<exit>, as |
|
|
1576 | is often done with C<malloc> failures, but this results in an easy |
|
|
1577 | opportunity for a DoS attack. |
1400 | |
1578 | |
1401 | =head3 Watcher-Specific Functions |
1579 | =head3 Watcher-Specific Functions |
1402 | |
1580 | |
1403 | =over 4 |
1581 | =over 4 |
1404 | |
1582 | |
… | |
… | |
1451 | year, it will still time out after (roughly) one hour. "Roughly" because |
1629 | year, it will still time out after (roughly) one hour. "Roughly" because |
1452 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1630 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
1453 | monotonic clock option helps a lot here). |
1631 | monotonic clock option helps a lot here). |
1454 | |
1632 | |
1455 | The callback is guaranteed to be invoked only I<after> its timeout has |
1633 | The callback is guaranteed to be invoked only I<after> its timeout has |
1456 | passed. If multiple timers become ready during the same loop iteration |
1634 | passed (not I<at>, so on systems with very low-resolution clocks this |
1457 | then the ones with earlier time-out values are invoked before ones with |
1635 | might introduce a small delay). If multiple timers become ready during the |
1458 | later time-out values (but this is no longer true when a callback calls |
1636 | same loop iteration then the ones with earlier time-out values are invoked |
1459 | C<ev_loop> recursively). |
1637 | before ones of the same priority with later time-out values (but this is |
|
|
1638 | no longer true when a callback calls C<ev_loop> recursively). |
1460 | |
1639 | |
1461 | =head3 Be smart about timeouts |
1640 | =head3 Be smart about timeouts |
1462 | |
1641 | |
1463 | Many real-world problems involve some kind of timeout, usually for error |
1642 | Many real-world problems involve some kind of timeout, usually for error |
1464 | recovery. A typical example is an HTTP request - if the other side hangs, |
1643 | recovery. A typical example is an HTTP request - if the other side hangs, |
… | |
… | |
1508 | C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> |
1687 | C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> |
1509 | member and C<ev_timer_again>. |
1688 | member and C<ev_timer_again>. |
1510 | |
1689 | |
1511 | At start: |
1690 | At start: |
1512 | |
1691 | |
1513 | ev_timer_init (timer, callback); |
1692 | ev_init (timer, callback); |
1514 | timer->repeat = 60.; |
1693 | timer->repeat = 60.; |
1515 | ev_timer_again (loop, timer); |
1694 | ev_timer_again (loop, timer); |
1516 | |
1695 | |
1517 | Each time there is some activity: |
1696 | Each time there is some activity: |
1518 | |
1697 | |
… | |
… | |
1580 | |
1759 | |
1581 | To start the timer, simply initialise the watcher and set C<last_activity> |
1760 | To start the timer, simply initialise the watcher and set C<last_activity> |
1582 | to the current time (meaning we just have some activity :), then call the |
1761 | to the current time (meaning we just have some activity :), then call the |
1583 | callback, which will "do the right thing" and start the timer: |
1762 | callback, which will "do the right thing" and start the timer: |
1584 | |
1763 | |
1585 | ev_timer_init (timer, callback); |
1764 | ev_init (timer, callback); |
1586 | last_activity = ev_now (loop); |
1765 | last_activity = ev_now (loop); |
1587 | callback (loop, timer, EV_TIMEOUT); |
1766 | callback (loop, timer, EV_TIMER); |
1588 | |
1767 | |
1589 | And when there is some activity, simply store the current time in |
1768 | And when there is some activity, simply store the current time in |
1590 | C<last_activity>, no libev calls at all: |
1769 | C<last_activity>, no libev calls at all: |
1591 | |
1770 | |
1592 | last_actiivty = ev_now (loop); |
1771 | last_actiivty = ev_now (loop); |
… | |
… | |
1651 | |
1830 | |
1652 | If the event loop is suspended for a long time, you can also force an |
1831 | If the event loop is suspended for a long time, you can also force an |
1653 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1832 | update of the time returned by C<ev_now ()> by calling C<ev_now_update |
1654 | ()>. |
1833 | ()>. |
1655 | |
1834 | |
|
|
1835 | =head3 The special problems of suspended animation |
|
|
1836 | |
|
|
1837 | When you leave the server world it is quite customary to hit machines that |
|
|
1838 | can suspend/hibernate - what happens to the clocks during such a suspend? |
|
|
1839 | |
|
|
1840 | Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes |
|
|
1841 | all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue |
|
|
1842 | to run until the system is suspended, but they will not advance while the |
|
|
1843 | system is suspended. That means, on resume, it will be as if the program |
|
|
1844 | was frozen for a few seconds, but the suspend time will not be counted |
|
|
1845 | towards C<ev_timer> when a monotonic clock source is used. The real time |
|
|
1846 | clock advanced as expected, but if it is used as sole clocksource, then a |
|
|
1847 | long suspend would be detected as a time jump by libev, and timers would |
|
|
1848 | be adjusted accordingly. |
|
|
1849 | |
|
|
1850 | I would not be surprised to see different behaviour in different between |
|
|
1851 | operating systems, OS versions or even different hardware. |
|
|
1852 | |
|
|
1853 | The other form of suspend (job control, or sending a SIGSTOP) will see a |
|
|
1854 | time jump in the monotonic clocks and the realtime clock. If the program |
|
|
1855 | is suspended for a very long time, and monotonic clock sources are in use, |
|
|
1856 | then you can expect C<ev_timer>s to expire as the full suspension time |
|
|
1857 | will be counted towards the timers. When no monotonic clock source is in |
|
|
1858 | use, then libev will again assume a timejump and adjust accordingly. |
|
|
1859 | |
|
|
1860 | It might be beneficial for this latter case to call C<ev_suspend> |
|
|
1861 | and C<ev_resume> in code that handles C<SIGTSTP>, to at least get |
|
|
1862 | deterministic behaviour in this case (you can do nothing against |
|
|
1863 | C<SIGSTOP>). |
|
|
1864 | |
1656 | =head3 Watcher-Specific Functions and Data Members |
1865 | =head3 Watcher-Specific Functions and Data Members |
1657 | |
1866 | |
1658 | =over 4 |
1867 | =over 4 |
1659 | |
1868 | |
1660 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
1869 | =item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) |
… | |
… | |
1685 | If the timer is repeating, either start it if necessary (with the |
1894 | If the timer is repeating, either start it if necessary (with the |
1686 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1895 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1687 | |
1896 | |
1688 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1897 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1689 | usage example. |
1898 | usage example. |
|
|
1899 | |
|
|
1900 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
|
|
1901 | |
|
|
1902 | Returns the remaining time until a timer fires. If the timer is active, |
|
|
1903 | then this time is relative to the current event loop time, otherwise it's |
|
|
1904 | the timeout value currently configured. |
|
|
1905 | |
|
|
1906 | That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns |
|
|
1907 | C<5>. When the timer is started and one second passes, C<ev_timer_remaining> |
|
|
1908 | will return C<4>. When the timer expires and is restarted, it will return |
|
|
1909 | roughly C<7> (likely slightly less as callback invocation takes some time, |
|
|
1910 | too), and so on. |
1690 | |
1911 | |
1691 | =item ev_tstamp repeat [read-write] |
1912 | =item ev_tstamp repeat [read-write] |
1692 | |
1913 | |
1693 | The current C<repeat> value. Will be used each time the watcher times out |
1914 | The current C<repeat> value. Will be used each time the watcher times out |
1694 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
1915 | or C<ev_timer_again> is called, and determines the next timeout (if any), |
… | |
… | |
1930 | Signal watchers will trigger an event when the process receives a specific |
2151 | Signal watchers will trigger an event when the process receives a specific |
1931 | signal one or more times. Even though signals are very asynchronous, libev |
2152 | signal one or more times. Even though signals are very asynchronous, libev |
1932 | will try it's best to deliver signals synchronously, i.e. as part of the |
2153 | will try it's best to deliver signals synchronously, i.e. as part of the |
1933 | normal event processing, like any other event. |
2154 | normal event processing, like any other event. |
1934 | |
2155 | |
1935 | If you want signals asynchronously, just use C<sigaction> as you would |
2156 | If you want signals to be delivered truly asynchronously, just use |
1936 | do without libev and forget about sharing the signal. You can even use |
2157 | C<sigaction> as you would do without libev and forget about sharing |
1937 | C<ev_async> from a signal handler to synchronously wake up an event loop. |
2158 | the signal. You can even use C<ev_async> from a signal handler to |
|
|
2159 | synchronously wake up an event loop. |
1938 | |
2160 | |
1939 | You can configure as many watchers as you like per signal. Only when the |
2161 | You can configure as many watchers as you like for the same signal, but |
|
|
2162 | only within the same loop, i.e. you can watch for C<SIGINT> in your |
|
|
2163 | default loop and for C<SIGIO> in another loop, but you cannot watch for |
|
|
2164 | C<SIGINT> in both the default loop and another loop at the same time. At |
|
|
2165 | the moment, C<SIGCHLD> is permanently tied to the default loop. |
|
|
2166 | |
1940 | first watcher gets started will libev actually register a signal handler |
2167 | When the first watcher gets started will libev actually register something |
1941 | with the kernel (thus it coexists with your own signal handlers as long as |
2168 | with the kernel (thus it coexists with your own signal handlers as long as |
1942 | you don't register any with libev for the same signal). Similarly, when |
2169 | you don't register any with libev for the same signal). |
1943 | the last signal watcher for a signal is stopped, libev will reset the |
|
|
1944 | signal handler to SIG_DFL (regardless of what it was set to before). |
|
|
1945 | |
2170 | |
1946 | If possible and supported, libev will install its handlers with |
2171 | If possible and supported, libev will install its handlers with |
1947 | C<SA_RESTART> behaviour enabled, so system calls should not be unduly |
2172 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
1948 | interrupted. If you have a problem with system calls getting interrupted by |
2173 | not be unduly interrupted. If you have a problem with system calls getting |
1949 | signals you can block all signals in an C<ev_check> watcher and unblock |
2174 | interrupted by signals you can block all signals in an C<ev_check> watcher |
1950 | them in an C<ev_prepare> watcher. |
2175 | and unblock them in an C<ev_prepare> watcher. |
|
|
2176 | |
|
|
2177 | =head3 The special problem of inheritance over fork/execve/pthread_create |
|
|
2178 | |
|
|
2179 | Both the signal mask (C<sigprocmask>) and the signal disposition |
|
|
2180 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2181 | stopping it again), that is, libev might or might not block the signal, |
|
|
2182 | and might or might not set or restore the installed signal handler. |
|
|
2183 | |
|
|
2184 | While this does not matter for the signal disposition (libev never |
|
|
2185 | sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on |
|
|
2186 | C<execve>), this matters for the signal mask: many programs do not expect |
|
|
2187 | certain signals to be blocked. |
|
|
2188 | |
|
|
2189 | This means that before calling C<exec> (from the child) you should reset |
|
|
2190 | the signal mask to whatever "default" you expect (all clear is a good |
|
|
2191 | choice usually). |
|
|
2192 | |
|
|
2193 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2194 | to install a fork handler with C<pthread_atfork> that resets it. That will |
|
|
2195 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2196 | |
|
|
2197 | In current versions of libev, the signal will not be blocked indefinitely |
|
|
2198 | unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces |
|
|
2199 | the window of opportunity for problems, it will not go away, as libev |
|
|
2200 | I<has> to modify the signal mask, at least temporarily. |
|
|
2201 | |
|
|
2202 | So I can't stress this enough: I<If you do not reset your signal mask when |
|
|
2203 | you expect it to be empty, you have a race condition in your code>. This |
|
|
2204 | is not a libev-specific thing, this is true for most event libraries. |
1951 | |
2205 | |
1952 | =head3 Watcher-Specific Functions and Data Members |
2206 | =head3 Watcher-Specific Functions and Data Members |
1953 | |
2207 | |
1954 | =over 4 |
2208 | =over 4 |
1955 | |
2209 | |
… | |
… | |
1987 | some child status changes (most typically when a child of yours dies or |
2241 | some child status changes (most typically when a child of yours dies or |
1988 | exits). It is permissible to install a child watcher I<after> the child |
2242 | exits). It is permissible to install a child watcher I<after> the child |
1989 | has been forked (which implies it might have already exited), as long |
2243 | has been forked (which implies it might have already exited), as long |
1990 | as the event loop isn't entered (or is continued from a watcher), i.e., |
2244 | as the event loop isn't entered (or is continued from a watcher), i.e., |
1991 | forking and then immediately registering a watcher for the child is fine, |
2245 | forking and then immediately registering a watcher for the child is fine, |
1992 | but forking and registering a watcher a few event loop iterations later is |
2246 | but forking and registering a watcher a few event loop iterations later or |
1993 | not. |
2247 | in the next callback invocation is not. |
1994 | |
2248 | |
1995 | Only the default event loop is capable of handling signals, and therefore |
2249 | Only the default event loop is capable of handling signals, and therefore |
1996 | you can only register child watchers in the default event loop. |
2250 | you can only register child watchers in the default event loop. |
1997 | |
2251 | |
|
|
2252 | Due to some design glitches inside libev, child watchers will always be |
|
|
2253 | handled at maximum priority (their priority is set to C<EV_MAXPRI> by |
|
|
2254 | libev) |
|
|
2255 | |
1998 | =head3 Process Interaction |
2256 | =head3 Process Interaction |
1999 | |
2257 | |
2000 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2258 | Libev grabs C<SIGCHLD> as soon as the default event loop is |
2001 | initialised. This is necessary to guarantee proper behaviour even if |
2259 | initialised. This is necessary to guarantee proper behaviour even if the |
2002 | the first child watcher is started after the child exits. The occurrence |
2260 | first child watcher is started after the child exits. The occurrence |
2003 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2261 | of C<SIGCHLD> is recorded asynchronously, but child reaping is done |
2004 | synchronously as part of the event loop processing. Libev always reaps all |
2262 | synchronously as part of the event loop processing. Libev always reaps all |
2005 | children, even ones not watched. |
2263 | children, even ones not watched. |
2006 | |
2264 | |
2007 | =head3 Overriding the Built-In Processing |
2265 | =head3 Overriding the Built-In Processing |
… | |
… | |
2017 | =head3 Stopping the Child Watcher |
2275 | =head3 Stopping the Child Watcher |
2018 | |
2276 | |
2019 | Currently, the child watcher never gets stopped, even when the |
2277 | Currently, the child watcher never gets stopped, even when the |
2020 | child terminates, so normally one needs to stop the watcher in the |
2278 | child terminates, so normally one needs to stop the watcher in the |
2021 | callback. Future versions of libev might stop the watcher automatically |
2279 | callback. Future versions of libev might stop the watcher automatically |
2022 | when a child exit is detected. |
2280 | when a child exit is detected (calling C<ev_child_stop> twice is not a |
|
|
2281 | problem). |
2023 | |
2282 | |
2024 | =head3 Watcher-Specific Functions and Data Members |
2283 | =head3 Watcher-Specific Functions and Data Members |
2025 | |
2284 | |
2026 | =over 4 |
2285 | =over 4 |
2027 | |
2286 | |
… | |
… | |
2353 | // no longer anything immediate to do. |
2612 | // no longer anything immediate to do. |
2354 | } |
2613 | } |
2355 | |
2614 | |
2356 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2615 | ev_idle *idle_watcher = malloc (sizeof (ev_idle)); |
2357 | ev_idle_init (idle_watcher, idle_cb); |
2616 | ev_idle_init (idle_watcher, idle_cb); |
2358 | ev_idle_start (loop, idle_cb); |
2617 | ev_idle_start (loop, idle_watcher); |
2359 | |
2618 | |
2360 | |
2619 | |
2361 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2620 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
2362 | |
2621 | |
2363 | Prepare and check watchers are usually (but not always) used in pairs: |
2622 | Prepare and check watchers are usually (but not always) used in pairs: |
… | |
… | |
2456 | struct pollfd fds [nfd]; |
2715 | struct pollfd fds [nfd]; |
2457 | // actual code will need to loop here and realloc etc. |
2716 | // actual code will need to loop here and realloc etc. |
2458 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2717 | adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); |
2459 | |
2718 | |
2460 | /* the callback is illegal, but won't be called as we stop during check */ |
2719 | /* the callback is illegal, but won't be called as we stop during check */ |
2461 | ev_timer_init (&tw, 0, timeout * 1e-3); |
2720 | ev_timer_init (&tw, 0, timeout * 1e-3, 0.); |
2462 | ev_timer_start (loop, &tw); |
2721 | ev_timer_start (loop, &tw); |
2463 | |
2722 | |
2464 | // create one ev_io per pollfd |
2723 | // create one ev_io per pollfd |
2465 | for (int i = 0; i < nfd; ++i) |
2724 | for (int i = 0; i < nfd; ++i) |
2466 | { |
2725 | { |
… | |
… | |
2696 | event loop blocks next and before C<ev_check> watchers are being called, |
2955 | event loop blocks next and before C<ev_check> watchers are being called, |
2697 | and only in the child after the fork. If whoever good citizen calling |
2956 | and only in the child after the fork. If whoever good citizen calling |
2698 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
2957 | C<ev_default_fork> cheats and calls it in the wrong process, the fork |
2699 | handlers will be invoked, too, of course. |
2958 | handlers will be invoked, too, of course. |
2700 | |
2959 | |
|
|
2960 | =head3 The special problem of life after fork - how is it possible? |
|
|
2961 | |
|
|
2962 | Most uses of C<fork()> consist of forking, then some simple calls to ste |
|
|
2963 | up/change the process environment, followed by a call to C<exec()>. This |
|
|
2964 | sequence should be handled by libev without any problems. |
|
|
2965 | |
|
|
2966 | This changes when the application actually wants to do event handling |
|
|
2967 | in the child, or both parent in child, in effect "continuing" after the |
|
|
2968 | fork. |
|
|
2969 | |
|
|
2970 | The default mode of operation (for libev, with application help to detect |
|
|
2971 | forks) is to duplicate all the state in the child, as would be expected |
|
|
2972 | when I<either> the parent I<or> the child process continues. |
|
|
2973 | |
|
|
2974 | When both processes want to continue using libev, then this is usually the |
|
|
2975 | wrong result. In that case, usually one process (typically the parent) is |
|
|
2976 | supposed to continue with all watchers in place as before, while the other |
|
|
2977 | process typically wants to start fresh, i.e. without any active watchers. |
|
|
2978 | |
|
|
2979 | The cleanest and most efficient way to achieve that with libev is to |
|
|
2980 | simply create a new event loop, which of course will be "empty", and |
|
|
2981 | use that for new watchers. This has the advantage of not touching more |
|
|
2982 | memory than necessary, and thus avoiding the copy-on-write, and the |
|
|
2983 | disadvantage of having to use multiple event loops (which do not support |
|
|
2984 | signal watchers). |
|
|
2985 | |
|
|
2986 | When this is not possible, or you want to use the default loop for |
|
|
2987 | other reasons, then in the process that wants to start "fresh", call |
|
|
2988 | C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying |
|
|
2989 | the default loop will "orphan" (not stop) all registered watchers, so you |
|
|
2990 | have to be careful not to execute code that modifies those watchers. Note |
|
|
2991 | also that in that case, you have to re-register any signal watchers. |
|
|
2992 | |
2701 | =head3 Watcher-Specific Functions and Data Members |
2993 | =head3 Watcher-Specific Functions and Data Members |
2702 | |
2994 | |
2703 | =over 4 |
2995 | =over 4 |
2704 | |
2996 | |
2705 | =item ev_fork_init (ev_signal *, callback) |
2997 | =item ev_fork_init (ev_signal *, callback) |
… | |
… | |
2734 | =head3 Queueing |
3026 | =head3 Queueing |
2735 | |
3027 | |
2736 | C<ev_async> does not support queueing of data in any way. The reason |
3028 | C<ev_async> does not support queueing of data in any way. The reason |
2737 | is that the author does not know of a simple (or any) algorithm for a |
3029 | is that the author does not know of a simple (or any) algorithm for a |
2738 | multiple-writer-single-reader queue that works in all cases and doesn't |
3030 | multiple-writer-single-reader queue that works in all cases and doesn't |
2739 | need elaborate support such as pthreads. |
3031 | need elaborate support such as pthreads or unportable memory access |
|
|
3032 | semantics. |
2740 | |
3033 | |
2741 | That means that if you want to queue data, you have to provide your own |
3034 | That means that if you want to queue data, you have to provide your own |
2742 | queue. But at least I can tell you how to implement locking around your |
3035 | queue. But at least I can tell you how to implement locking around your |
2743 | queue: |
3036 | queue: |
2744 | |
3037 | |
… | |
… | |
2883 | |
3176 | |
2884 | If C<timeout> is less than 0, then no timeout watcher will be |
3177 | If C<timeout> is less than 0, then no timeout watcher will be |
2885 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
3178 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
2886 | repeat = 0) will be started. C<0> is a valid timeout. |
3179 | repeat = 0) will be started. C<0> is a valid timeout. |
2887 | |
3180 | |
2888 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
3181 | The callback has the type C<void (*cb)(int revents, void *arg)> and is |
2889 | passed an C<revents> set like normal event callbacks (a combination of |
3182 | passed an C<revents> set like normal event callbacks (a combination of |
2890 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
3183 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg> |
2891 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
3184 | value passed to C<ev_once>. Note that it is possible to receive I<both> |
2892 | a timeout and an io event at the same time - you probably should give io |
3185 | a timeout and an io event at the same time - you probably should give io |
2893 | events precedence. |
3186 | events precedence. |
2894 | |
3187 | |
2895 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
3188 | Example: wait up to ten seconds for data to appear on STDIN_FILENO. |
2896 | |
3189 | |
2897 | static void stdin_ready (int revents, void *arg) |
3190 | static void stdin_ready (int revents, void *arg) |
2898 | { |
3191 | { |
2899 | if (revents & EV_READ) |
3192 | if (revents & EV_READ) |
2900 | /* stdin might have data for us, joy! */; |
3193 | /* stdin might have data for us, joy! */; |
2901 | else if (revents & EV_TIMEOUT) |
3194 | else if (revents & EV_TIMER) |
2902 | /* doh, nothing entered */; |
3195 | /* doh, nothing entered */; |
2903 | } |
3196 | } |
2904 | |
3197 | |
2905 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3198 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
2906 | |
3199 | |
2907 | =item ev_feed_event (struct ev_loop *, watcher *, int revents) |
|
|
2908 | |
|
|
2909 | Feeds the given event set into the event loop, as if the specified event |
|
|
2910 | had happened for the specified watcher (which must be a pointer to an |
|
|
2911 | initialised but not necessarily started event watcher). |
|
|
2912 | |
|
|
2913 | =item ev_feed_fd_event (struct ev_loop *, int fd, int revents) |
3200 | =item ev_feed_fd_event (loop, int fd, int revents) |
2914 | |
3201 | |
2915 | Feed an event on the given fd, as if a file descriptor backend detected |
3202 | Feed an event on the given fd, as if a file descriptor backend detected |
2916 | the given events it. |
3203 | the given events it. |
2917 | |
3204 | |
2918 | =item ev_feed_signal_event (struct ev_loop *loop, int signum) |
3205 | =item ev_feed_signal_event (loop, int signum) |
2919 | |
3206 | |
2920 | Feed an event as if the given signal occurred (C<loop> must be the default |
3207 | Feed an event as if the given signal occurred (C<loop> must be the default |
2921 | loop!). |
3208 | loop!). |
2922 | |
3209 | |
2923 | =back |
3210 | =back |
… | |
… | |
3003 | |
3290 | |
3004 | =over 4 |
3291 | =over 4 |
3005 | |
3292 | |
3006 | =item ev::TYPE::TYPE () |
3293 | =item ev::TYPE::TYPE () |
3007 | |
3294 | |
3008 | =item ev::TYPE::TYPE (struct ev_loop *) |
3295 | =item ev::TYPE::TYPE (loop) |
3009 | |
3296 | |
3010 | =item ev::TYPE::~TYPE |
3297 | =item ev::TYPE::~TYPE |
3011 | |
3298 | |
3012 | The constructor (optionally) takes an event loop to associate the watcher |
3299 | The constructor (optionally) takes an event loop to associate the watcher |
3013 | with. If it is omitted, it will use C<EV_DEFAULT>. |
3300 | with. If it is omitted, it will use C<EV_DEFAULT>. |
… | |
… | |
3090 | Example: Use a plain function as callback. |
3377 | Example: Use a plain function as callback. |
3091 | |
3378 | |
3092 | static void io_cb (ev::io &w, int revents) { } |
3379 | static void io_cb (ev::io &w, int revents) { } |
3093 | iow.set <io_cb> (); |
3380 | iow.set <io_cb> (); |
3094 | |
3381 | |
3095 | =item w->set (struct ev_loop *) |
3382 | =item w->set (loop) |
3096 | |
3383 | |
3097 | Associates a different C<struct ev_loop> with this watcher. You can only |
3384 | Associates a different C<struct ev_loop> with this watcher. You can only |
3098 | do this when the watcher is inactive (and not pending either). |
3385 | do this when the watcher is inactive (and not pending either). |
3099 | |
3386 | |
3100 | =item w->set ([arguments]) |
3387 | =item w->set ([arguments]) |
… | |
… | |
3197 | =item Ocaml |
3484 | =item Ocaml |
3198 | |
3485 | |
3199 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3486 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3200 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3487 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3201 | |
3488 | |
|
|
3489 | =item Lua |
|
|
3490 | |
|
|
3491 | Brian Maher has written a partial interface to libev for lua (at the |
|
|
3492 | time of this writing, only C<ev_io> and C<ev_timer>), to be found at |
|
|
3493 | L<http://github.com/brimworks/lua-ev>. |
|
|
3494 | |
3202 | =back |
3495 | =back |
3203 | |
3496 | |
3204 | |
3497 | |
3205 | =head1 MACRO MAGIC |
3498 | =head1 MACRO MAGIC |
3206 | |
3499 | |
… | |
… | |
3359 | libev.m4 |
3652 | libev.m4 |
3360 | |
3653 | |
3361 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3654 | =head2 PREPROCESSOR SYMBOLS/MACROS |
3362 | |
3655 | |
3363 | Libev can be configured via a variety of preprocessor symbols you have to |
3656 | Libev can be configured via a variety of preprocessor symbols you have to |
3364 | define before including any of its files. The default in the absence of |
3657 | define before including (or compiling) any of its files. The default in |
3365 | autoconf is documented for every option. |
3658 | the absence of autoconf is documented for every option. |
|
|
3659 | |
|
|
3660 | Symbols marked with "(h)" do not change the ABI, and can have different |
|
|
3661 | values when compiling libev vs. including F<ev.h>, so it is permissible |
|
|
3662 | to redefine them before including F<ev.h> without breakign compatibility |
|
|
3663 | to a compiled library. All other symbols change the ABI, which means all |
|
|
3664 | users of libev and the libev code itself must be compiled with compatible |
|
|
3665 | settings. |
3366 | |
3666 | |
3367 | =over 4 |
3667 | =over 4 |
3368 | |
3668 | |
3369 | =item EV_STANDALONE |
3669 | =item EV_STANDALONE (h) |
3370 | |
3670 | |
3371 | Must always be C<1> if you do not use autoconf configuration, which |
3671 | Must always be C<1> if you do not use autoconf configuration, which |
3372 | keeps libev from including F<config.h>, and it also defines dummy |
3672 | keeps libev from including F<config.h>, and it also defines dummy |
3373 | implementations for some libevent functions (such as logging, which is not |
3673 | implementations for some libevent functions (such as logging, which is not |
3374 | supported). It will also not define any of the structs usually found in |
3674 | supported). It will also not define any of the structs usually found in |
3375 | F<event.h> that are not directly supported by the libev core alone. |
3675 | F<event.h> that are not directly supported by the libev core alone. |
3376 | |
3676 | |
3377 | In stanbdalone mode, libev will still try to automatically deduce the |
3677 | In standalone mode, libev will still try to automatically deduce the |
3378 | configuration, but has to be more conservative. |
3678 | configuration, but has to be more conservative. |
3379 | |
3679 | |
3380 | =item EV_USE_MONOTONIC |
3680 | =item EV_USE_MONOTONIC |
3381 | |
3681 | |
3382 | If defined to be C<1>, libev will try to detect the availability of the |
3682 | If defined to be C<1>, libev will try to detect the availability of the |
… | |
… | |
3447 | be used is the winsock select). This means that it will call |
3747 | be used is the winsock select). This means that it will call |
3448 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3748 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3449 | it is assumed that all these functions actually work on fds, even |
3749 | it is assumed that all these functions actually work on fds, even |
3450 | on win32. Should not be defined on non-win32 platforms. |
3750 | on win32. Should not be defined on non-win32 platforms. |
3451 | |
3751 | |
3452 | =item EV_FD_TO_WIN32_HANDLE |
3752 | =item EV_FD_TO_WIN32_HANDLE(fd) |
3453 | |
3753 | |
3454 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3754 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3455 | file descriptors to socket handles. When not defining this symbol (the |
3755 | file descriptors to socket handles. When not defining this symbol (the |
3456 | default), then libev will call C<_get_osfhandle>, which is usually |
3756 | default), then libev will call C<_get_osfhandle>, which is usually |
3457 | correct. In some cases, programs use their own file descriptor management, |
3757 | correct. In some cases, programs use their own file descriptor management, |
3458 | in which case they can provide this function to map fds to socket handles. |
3758 | in which case they can provide this function to map fds to socket handles. |
|
|
3759 | |
|
|
3760 | =item EV_WIN32_HANDLE_TO_FD(handle) |
|
|
3761 | |
|
|
3762 | If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors |
|
|
3763 | using the standard C<_open_osfhandle> function. For programs implementing |
|
|
3764 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
3765 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
3766 | |
|
|
3767 | =item EV_WIN32_CLOSE_FD(fd) |
|
|
3768 | |
|
|
3769 | If programs implement their own fd to handle mapping on win32, then this |
|
|
3770 | macro can be used to override the C<close> function, useful to unregister |
|
|
3771 | file descriptors again. Note that the replacement function has to close |
|
|
3772 | the underlying OS handle. |
3459 | |
3773 | |
3460 | =item EV_USE_POLL |
3774 | =item EV_USE_POLL |
3461 | |
3775 | |
3462 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3776 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3463 | backend. Otherwise it will be enabled on non-win32 platforms. It |
3777 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
3510 | as well as for signal and thread safety in C<ev_async> watchers. |
3824 | as well as for signal and thread safety in C<ev_async> watchers. |
3511 | |
3825 | |
3512 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3826 | In the absence of this define, libev will use C<sig_atomic_t volatile> |
3513 | (from F<signal.h>), which is usually good enough on most platforms. |
3827 | (from F<signal.h>), which is usually good enough on most platforms. |
3514 | |
3828 | |
3515 | =item EV_H |
3829 | =item EV_H (h) |
3516 | |
3830 | |
3517 | The name of the F<ev.h> header file used to include it. The default if |
3831 | The name of the F<ev.h> header file used to include it. The default if |
3518 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3832 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
3519 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3833 | used to virtually rename the F<ev.h> header file in case of conflicts. |
3520 | |
3834 | |
3521 | =item EV_CONFIG_H |
3835 | =item EV_CONFIG_H (h) |
3522 | |
3836 | |
3523 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3837 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
3524 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3838 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
3525 | C<EV_H>, above. |
3839 | C<EV_H>, above. |
3526 | |
3840 | |
3527 | =item EV_EVENT_H |
3841 | =item EV_EVENT_H (h) |
3528 | |
3842 | |
3529 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3843 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
3530 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3844 | of how the F<event.h> header can be found, the default is C<"event.h">. |
3531 | |
3845 | |
3532 | =item EV_PROTOTYPES |
3846 | =item EV_PROTOTYPES (h) |
3533 | |
3847 | |
3534 | If defined to be C<0>, then F<ev.h> will not define any function |
3848 | If defined to be C<0>, then F<ev.h> will not define any function |
3535 | prototypes, but still define all the structs and other symbols. This is |
3849 | prototypes, but still define all the structs and other symbols. This is |
3536 | occasionally useful if you want to provide your own wrapper functions |
3850 | occasionally useful if you want to provide your own wrapper functions |
3537 | around libev functions. |
3851 | around libev functions. |
… | |
… | |
3559 | fine. |
3873 | fine. |
3560 | |
3874 | |
3561 | If your embedding application does not need any priorities, defining these |
3875 | If your embedding application does not need any priorities, defining these |
3562 | both to C<0> will save some memory and CPU. |
3876 | both to C<0> will save some memory and CPU. |
3563 | |
3877 | |
3564 | =item EV_PERIODIC_ENABLE |
3878 | =item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE, |
|
|
3879 | EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE, |
|
|
3880 | EV_ASYNC_ENABLE, EV_CHILD_ENABLE. |
3565 | |
3881 | |
3566 | If undefined or defined to be C<1>, then periodic timers are supported. If |
3882 | If undefined or defined to be C<1> (and the platform supports it), then |
3567 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
3883 | the respective watcher type is supported. If defined to be C<0>, then it |
3568 | code. |
3884 | is not. Disabling watcher types mainly saves codesize. |
3569 | |
3885 | |
3570 | =item EV_IDLE_ENABLE |
3886 | =item EV_FEATURES |
3571 | |
|
|
3572 | If undefined or defined to be C<1>, then idle watchers are supported. If |
|
|
3573 | defined to be C<0>, then they are not. Disabling them saves a few kB of |
|
|
3574 | code. |
|
|
3575 | |
|
|
3576 | =item EV_EMBED_ENABLE |
|
|
3577 | |
|
|
3578 | If undefined or defined to be C<1>, then embed watchers are supported. If |
|
|
3579 | defined to be C<0>, then they are not. Embed watchers rely on most other |
|
|
3580 | watcher types, which therefore must not be disabled. |
|
|
3581 | |
|
|
3582 | =item EV_STAT_ENABLE |
|
|
3583 | |
|
|
3584 | If undefined or defined to be C<1>, then stat watchers are supported. If |
|
|
3585 | defined to be C<0>, then they are not. |
|
|
3586 | |
|
|
3587 | =item EV_FORK_ENABLE |
|
|
3588 | |
|
|
3589 | If undefined or defined to be C<1>, then fork watchers are supported. If |
|
|
3590 | defined to be C<0>, then they are not. |
|
|
3591 | |
|
|
3592 | =item EV_ASYNC_ENABLE |
|
|
3593 | |
|
|
3594 | If undefined or defined to be C<1>, then async watchers are supported. If |
|
|
3595 | defined to be C<0>, then they are not. |
|
|
3596 | |
|
|
3597 | =item EV_MINIMAL |
|
|
3598 | |
3887 | |
3599 | If you need to shave off some kilobytes of code at the expense of some |
3888 | If you need to shave off some kilobytes of code at the expense of some |
3600 | speed, define this symbol to C<1>. Currently this is used to override some |
3889 | speed (but with the full API), you can define this symbol to request |
3601 | inlining decisions, saves roughly 30% code size on amd64. It also selects a |
3890 | certain subsets of functionality. The default is to enable all features |
3602 | much smaller 2-heap for timer management over the default 4-heap. |
3891 | that can be enabled on the platform. |
|
|
3892 | |
|
|
3893 | A typical way to use this symbol is to define it to C<0> (or to a bitset |
|
|
3894 | with some broad features you want) and then selectively re-enable |
|
|
3895 | additional parts you want, for example if you want everything minimal, |
|
|
3896 | but multiple event loop support, async and child watchers and the poll |
|
|
3897 | backend, use this: |
|
|
3898 | |
|
|
3899 | #define EV_FEATURES 0 |
|
|
3900 | #define EV_MULTIPLICITY 1 |
|
|
3901 | #define EV_USE_POLL 1 |
|
|
3902 | #define EV_CHILD_ENABLE 1 |
|
|
3903 | #define EV_ASYNC_ENABLE 1 |
|
|
3904 | |
|
|
3905 | The actual value is a bitset, it can be a combination of the following |
|
|
3906 | values: |
|
|
3907 | |
|
|
3908 | =over 4 |
|
|
3909 | |
|
|
3910 | =item C<1> - faster/larger code |
|
|
3911 | |
|
|
3912 | Use larger code to speed up some operations. |
|
|
3913 | |
|
|
3914 | Currently this is used to override some inlining decisions (enlarging the roughly |
|
|
3915 | 30% code size on amd64. |
|
|
3916 | |
|
|
3917 | When optimising for size, use of compiler flags such as C<-Os> with |
|
|
3918 | gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of |
|
|
3919 | assertions. |
|
|
3920 | |
|
|
3921 | =item C<2> - faster/larger data structures |
|
|
3922 | |
|
|
3923 | Replaces the small 2-heap for timer management by a faster 4-heap, larger |
|
|
3924 | hash table sizes and so on. This will usually further increase codesize |
|
|
3925 | and can additionally have an effect on the size of data structures at |
|
|
3926 | runtime. |
|
|
3927 | |
|
|
3928 | =item C<4> - full API configuration |
|
|
3929 | |
|
|
3930 | This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and |
|
|
3931 | enables multiplicity (C<EV_MULTIPLICITY>=1). |
|
|
3932 | |
|
|
3933 | =item C<8> - full API |
|
|
3934 | |
|
|
3935 | This enables a lot of the "lesser used" API functions. See C<ev.h> for |
|
|
3936 | details on which parts of the API are still available without this |
|
|
3937 | feature, and do not complain if this subset changes over time. |
|
|
3938 | |
|
|
3939 | =item C<16> - enable all optional watcher types |
|
|
3940 | |
|
|
3941 | Enables all optional watcher types. If you want to selectively enable |
|
|
3942 | only some watcher types other than I/O and timers (e.g. prepare, |
|
|
3943 | embed, async, child...) you can enable them manually by defining |
|
|
3944 | C<EV_watchertype_ENABLE> to C<1> instead. |
|
|
3945 | |
|
|
3946 | =item C<32> - enable all backends |
|
|
3947 | |
|
|
3948 | This enables all backends - without this feature, you need to enable at |
|
|
3949 | least one backend manually (C<EV_USE_SELECT> is a good choice). |
|
|
3950 | |
|
|
3951 | =item C<64> - enable OS-specific "helper" APIs |
|
|
3952 | |
|
|
3953 | Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by |
|
|
3954 | default. |
|
|
3955 | |
|
|
3956 | =back |
|
|
3957 | |
|
|
3958 | Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0> |
|
|
3959 | reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb |
|
|
3960 | code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O |
|
|
3961 | watchers, timers and monotonic clock support. |
|
|
3962 | |
|
|
3963 | With an intelligent-enough linker (gcc+binutils are intelligent enough |
|
|
3964 | when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by |
|
|
3965 | your program might be left out as well - a binary starting a timer and an |
|
|
3966 | I/O watcher then might come out at only 5Kb. |
|
|
3967 | |
|
|
3968 | =item EV_AVOID_STDIO |
|
|
3969 | |
|
|
3970 | If this is set to C<1> at compiletime, then libev will avoid using stdio |
|
|
3971 | functions (printf, scanf, perror etc.). This will increase the codesize |
|
|
3972 | somewhat, but if your program doesn't otherwise depend on stdio and your |
|
|
3973 | libc allows it, this avoids linking in the stdio library which is quite |
|
|
3974 | big. |
|
|
3975 | |
|
|
3976 | Note that error messages might become less precise when this option is |
|
|
3977 | enabled. |
|
|
3978 | |
|
|
3979 | =item EV_NSIG |
|
|
3980 | |
|
|
3981 | The highest supported signal number, +1 (or, the number of |
|
|
3982 | signals): Normally, libev tries to deduce the maximum number of signals |
|
|
3983 | automatically, but sometimes this fails, in which case it can be |
|
|
3984 | specified. Also, using a lower number than detected (C<32> should be |
|
|
3985 | good for about any system in existance) can save some memory, as libev |
|
|
3986 | statically allocates some 12-24 bytes per signal number. |
3603 | |
3987 | |
3604 | =item EV_PID_HASHSIZE |
3988 | =item EV_PID_HASHSIZE |
3605 | |
3989 | |
3606 | C<ev_child> watchers use a small hash table to distribute workload by |
3990 | C<ev_child> watchers use a small hash table to distribute workload by |
3607 | pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more |
3991 | pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled), |
3608 | than enough. If you need to manage thousands of children you might want to |
3992 | usually more than enough. If you need to manage thousands of children you |
3609 | increase this value (I<must> be a power of two). |
3993 | might want to increase this value (I<must> be a power of two). |
3610 | |
3994 | |
3611 | =item EV_INOTIFY_HASHSIZE |
3995 | =item EV_INOTIFY_HASHSIZE |
3612 | |
3996 | |
3613 | C<ev_stat> watchers use a small hash table to distribute workload by |
3997 | C<ev_stat> watchers use a small hash table to distribute workload by |
3614 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
3998 | inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES> |
3615 | usually more than enough. If you need to manage thousands of C<ev_stat> |
3999 | disabled), usually more than enough. If you need to manage thousands of |
3616 | watchers you might want to increase this value (I<must> be a power of |
4000 | C<ev_stat> watchers you might want to increase this value (I<must> be a |
3617 | two). |
4001 | power of two). |
3618 | |
4002 | |
3619 | =item EV_USE_4HEAP |
4003 | =item EV_USE_4HEAP |
3620 | |
4004 | |
3621 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4005 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3622 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
4006 | timer and periodics heaps, libev uses a 4-heap when this symbol is defined |
3623 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
4007 | to C<1>. The 4-heap uses more complicated (longer) code but has noticeably |
3624 | faster performance with many (thousands) of watchers. |
4008 | faster performance with many (thousands) of watchers. |
3625 | |
4009 | |
3626 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4010 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3627 | (disabled). |
4011 | will be C<0>. |
3628 | |
4012 | |
3629 | =item EV_HEAP_CACHE_AT |
4013 | =item EV_HEAP_CACHE_AT |
3630 | |
4014 | |
3631 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
4015 | Heaps are not very cache-efficient. To improve the cache-efficiency of the |
3632 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
4016 | timer and periodics heaps, libev can cache the timestamp (I<at>) within |
3633 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
4017 | the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), |
3634 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
4018 | which uses 8-12 bytes more per watcher and a few hundred bytes more code, |
3635 | but avoids random read accesses on heap changes. This improves performance |
4019 | but avoids random read accesses on heap changes. This improves performance |
3636 | noticeably with many (hundreds) of watchers. |
4020 | noticeably with many (hundreds) of watchers. |
3637 | |
4021 | |
3638 | The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> |
4022 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3639 | (disabled). |
4023 | will be C<0>. |
3640 | |
4024 | |
3641 | =item EV_VERIFY |
4025 | =item EV_VERIFY |
3642 | |
4026 | |
3643 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
4027 | Controls how much internal verification (see C<ev_loop_verify ()>) will |
3644 | be done: If set to C<0>, no internal verification code will be compiled |
4028 | be done: If set to C<0>, no internal verification code will be compiled |
… | |
… | |
3646 | called. If set to C<2>, then the internal verification code will be |
4030 | called. If set to C<2>, then the internal verification code will be |
3647 | called once per loop, which can slow down libev. If set to C<3>, then the |
4031 | called once per loop, which can slow down libev. If set to C<3>, then the |
3648 | verification code will be called very frequently, which will slow down |
4032 | verification code will be called very frequently, which will slow down |
3649 | libev considerably. |
4033 | libev considerably. |
3650 | |
4034 | |
3651 | The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be |
4035 | The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it |
3652 | C<0>. |
4036 | will be C<0>. |
3653 | |
4037 | |
3654 | =item EV_COMMON |
4038 | =item EV_COMMON |
3655 | |
4039 | |
3656 | By default, all watchers have a C<void *data> member. By redefining |
4040 | By default, all watchers have a C<void *data> member. By redefining |
3657 | this macro to a something else you can include more and other types of |
4041 | this macro to a something else you can include more and other types of |
… | |
… | |
3715 | file. |
4099 | file. |
3716 | |
4100 | |
3717 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
4101 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
3718 | that everybody includes and which overrides some configure choices: |
4102 | that everybody includes and which overrides some configure choices: |
3719 | |
4103 | |
3720 | #define EV_MINIMAL 1 |
4104 | #define EV_FEATURES 8 |
3721 | #define EV_USE_POLL 0 |
4105 | #define EV_USE_SELECT 1 |
3722 | #define EV_MULTIPLICITY 0 |
|
|
3723 | #define EV_PERIODIC_ENABLE 0 |
4106 | #define EV_PREPARE_ENABLE 1 |
|
|
4107 | #define EV_IDLE_ENABLE 1 |
3724 | #define EV_STAT_ENABLE 0 |
4108 | #define EV_SIGNAL_ENABLE 1 |
3725 | #define EV_FORK_ENABLE 0 |
4109 | #define EV_CHILD_ENABLE 1 |
|
|
4110 | #define EV_USE_STDEXCEPT 0 |
3726 | #define EV_CONFIG_H <config.h> |
4111 | #define EV_CONFIG_H <config.h> |
3727 | #define EV_MINPRI 0 |
|
|
3728 | #define EV_MAXPRI 0 |
|
|
3729 | |
4112 | |
3730 | #include "ev++.h" |
4113 | #include "ev++.h" |
3731 | |
4114 | |
3732 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
4115 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
3733 | |
4116 | |
… | |
… | |
3793 | default loop and triggering an C<ev_async> watcher from the default loop |
4176 | default loop and triggering an C<ev_async> watcher from the default loop |
3794 | watcher callback into the event loop interested in the signal. |
4177 | watcher callback into the event loop interested in the signal. |
3795 | |
4178 | |
3796 | =back |
4179 | =back |
3797 | |
4180 | |
|
|
4181 | =head4 THREAD LOCKING EXAMPLE |
|
|
4182 | |
|
|
4183 | Here is a fictitious example of how to run an event loop in a different |
|
|
4184 | thread than where callbacks are being invoked and watchers are |
|
|
4185 | created/added/removed. |
|
|
4186 | |
|
|
4187 | For a real-world example, see the C<EV::Loop::Async> perl module, |
|
|
4188 | which uses exactly this technique (which is suited for many high-level |
|
|
4189 | languages). |
|
|
4190 | |
|
|
4191 | The example uses a pthread mutex to protect the loop data, a condition |
|
|
4192 | variable to wait for callback invocations, an async watcher to notify the |
|
|
4193 | event loop thread and an unspecified mechanism to wake up the main thread. |
|
|
4194 | |
|
|
4195 | First, you need to associate some data with the event loop: |
|
|
4196 | |
|
|
4197 | typedef struct { |
|
|
4198 | mutex_t lock; /* global loop lock */ |
|
|
4199 | ev_async async_w; |
|
|
4200 | thread_t tid; |
|
|
4201 | cond_t invoke_cv; |
|
|
4202 | } userdata; |
|
|
4203 | |
|
|
4204 | void prepare_loop (EV_P) |
|
|
4205 | { |
|
|
4206 | // for simplicity, we use a static userdata struct. |
|
|
4207 | static userdata u; |
|
|
4208 | |
|
|
4209 | ev_async_init (&u->async_w, async_cb); |
|
|
4210 | ev_async_start (EV_A_ &u->async_w); |
|
|
4211 | |
|
|
4212 | pthread_mutex_init (&u->lock, 0); |
|
|
4213 | pthread_cond_init (&u->invoke_cv, 0); |
|
|
4214 | |
|
|
4215 | // now associate this with the loop |
|
|
4216 | ev_set_userdata (EV_A_ u); |
|
|
4217 | ev_set_invoke_pending_cb (EV_A_ l_invoke); |
|
|
4218 | ev_set_loop_release_cb (EV_A_ l_release, l_acquire); |
|
|
4219 | |
|
|
4220 | // then create the thread running ev_loop |
|
|
4221 | pthread_create (&u->tid, 0, l_run, EV_A); |
|
|
4222 | } |
|
|
4223 | |
|
|
4224 | The callback for the C<ev_async> watcher does nothing: the watcher is used |
|
|
4225 | solely to wake up the event loop so it takes notice of any new watchers |
|
|
4226 | that might have been added: |
|
|
4227 | |
|
|
4228 | static void |
|
|
4229 | async_cb (EV_P_ ev_async *w, int revents) |
|
|
4230 | { |
|
|
4231 | // just used for the side effects |
|
|
4232 | } |
|
|
4233 | |
|
|
4234 | The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex |
|
|
4235 | protecting the loop data, respectively. |
|
|
4236 | |
|
|
4237 | static void |
|
|
4238 | l_release (EV_P) |
|
|
4239 | { |
|
|
4240 | userdata *u = ev_userdata (EV_A); |
|
|
4241 | pthread_mutex_unlock (&u->lock); |
|
|
4242 | } |
|
|
4243 | |
|
|
4244 | static void |
|
|
4245 | l_acquire (EV_P) |
|
|
4246 | { |
|
|
4247 | userdata *u = ev_userdata (EV_A); |
|
|
4248 | pthread_mutex_lock (&u->lock); |
|
|
4249 | } |
|
|
4250 | |
|
|
4251 | The event loop thread first acquires the mutex, and then jumps straight |
|
|
4252 | into C<ev_loop>: |
|
|
4253 | |
|
|
4254 | void * |
|
|
4255 | l_run (void *thr_arg) |
|
|
4256 | { |
|
|
4257 | struct ev_loop *loop = (struct ev_loop *)thr_arg; |
|
|
4258 | |
|
|
4259 | l_acquire (EV_A); |
|
|
4260 | pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0); |
|
|
4261 | ev_loop (EV_A_ 0); |
|
|
4262 | l_release (EV_A); |
|
|
4263 | |
|
|
4264 | return 0; |
|
|
4265 | } |
|
|
4266 | |
|
|
4267 | Instead of invoking all pending watchers, the C<l_invoke> callback will |
|
|
4268 | signal the main thread via some unspecified mechanism (signals? pipe |
|
|
4269 | writes? C<Async::Interrupt>?) and then waits until all pending watchers |
|
|
4270 | have been called (in a while loop because a) spurious wakeups are possible |
|
|
4271 | and b) skipping inter-thread-communication when there are no pending |
|
|
4272 | watchers is very beneficial): |
|
|
4273 | |
|
|
4274 | static void |
|
|
4275 | l_invoke (EV_P) |
|
|
4276 | { |
|
|
4277 | userdata *u = ev_userdata (EV_A); |
|
|
4278 | |
|
|
4279 | while (ev_pending_count (EV_A)) |
|
|
4280 | { |
|
|
4281 | wake_up_other_thread_in_some_magic_or_not_so_magic_way (); |
|
|
4282 | pthread_cond_wait (&u->invoke_cv, &u->lock); |
|
|
4283 | } |
|
|
4284 | } |
|
|
4285 | |
|
|
4286 | Now, whenever the main thread gets told to invoke pending watchers, it |
|
|
4287 | will grab the lock, call C<ev_invoke_pending> and then signal the loop |
|
|
4288 | thread to continue: |
|
|
4289 | |
|
|
4290 | static void |
|
|
4291 | real_invoke_pending (EV_P) |
|
|
4292 | { |
|
|
4293 | userdata *u = ev_userdata (EV_A); |
|
|
4294 | |
|
|
4295 | pthread_mutex_lock (&u->lock); |
|
|
4296 | ev_invoke_pending (EV_A); |
|
|
4297 | pthread_cond_signal (&u->invoke_cv); |
|
|
4298 | pthread_mutex_unlock (&u->lock); |
|
|
4299 | } |
|
|
4300 | |
|
|
4301 | Whenever you want to start/stop a watcher or do other modifications to an |
|
|
4302 | event loop, you will now have to lock: |
|
|
4303 | |
|
|
4304 | ev_timer timeout_watcher; |
|
|
4305 | userdata *u = ev_userdata (EV_A); |
|
|
4306 | |
|
|
4307 | ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); |
|
|
4308 | |
|
|
4309 | pthread_mutex_lock (&u->lock); |
|
|
4310 | ev_timer_start (EV_A_ &timeout_watcher); |
|
|
4311 | ev_async_send (EV_A_ &u->async_w); |
|
|
4312 | pthread_mutex_unlock (&u->lock); |
|
|
4313 | |
|
|
4314 | Note that sending the C<ev_async> watcher is required because otherwise |
|
|
4315 | an event loop currently blocking in the kernel will have no knowledge |
|
|
4316 | about the newly added timer. By waking up the loop it will pick up any new |
|
|
4317 | watchers in the next event loop iteration. |
|
|
4318 | |
3798 | =head3 COROUTINES |
4319 | =head3 COROUTINES |
3799 | |
4320 | |
3800 | Libev is very accommodating to coroutines ("cooperative threads"): |
4321 | Libev is very accommodating to coroutines ("cooperative threads"): |
3801 | libev fully supports nesting calls to its functions from different |
4322 | libev fully supports nesting calls to its functions from different |
3802 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
4323 | coroutines (e.g. you can call C<ev_loop> on the same loop from two |
3803 | different coroutines, and switch freely between both coroutines running the |
4324 | different coroutines, and switch freely between both coroutines running |
3804 | loop, as long as you don't confuse yourself). The only exception is that |
4325 | the loop, as long as you don't confuse yourself). The only exception is |
3805 | you must not do this from C<ev_periodic> reschedule callbacks. |
4326 | that you must not do this from C<ev_periodic> reschedule callbacks. |
3806 | |
4327 | |
3807 | Care has been taken to ensure that libev does not keep local state inside |
4328 | Care has been taken to ensure that libev does not keep local state inside |
3808 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
4329 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3809 | they do not call any callbacks. |
4330 | they do not call any callbacks. |
3810 | |
4331 | |
… | |
… | |
3887 | way (note also that glib is the slowest event library known to man). |
4408 | way (note also that glib is the slowest event library known to man). |
3888 | |
4409 | |
3889 | There is no supported compilation method available on windows except |
4410 | There is no supported compilation method available on windows except |
3890 | embedding it into other applications. |
4411 | embedding it into other applications. |
3891 | |
4412 | |
|
|
4413 | Sensible signal handling is officially unsupported by Microsoft - libev |
|
|
4414 | tries its best, but under most conditions, signals will simply not work. |
|
|
4415 | |
3892 | Not a libev limitation but worth mentioning: windows apparently doesn't |
4416 | Not a libev limitation but worth mentioning: windows apparently doesn't |
3893 | accept large writes: instead of resulting in a partial write, windows will |
4417 | accept large writes: instead of resulting in a partial write, windows will |
3894 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
4418 | either accept everything or return C<ENOBUFS> if the buffer is too large, |
3895 | so make sure you only write small amounts into your sockets (less than a |
4419 | so make sure you only write small amounts into your sockets (less than a |
3896 | megabyte seems safe, but this apparently depends on the amount of memory |
4420 | megabyte seems safe, but this apparently depends on the amount of memory |
… | |
… | |
3900 | the abysmal performance of winsockets, using a large number of sockets |
4424 | the abysmal performance of winsockets, using a large number of sockets |
3901 | is not recommended (and not reasonable). If your program needs to use |
4425 | is not recommended (and not reasonable). If your program needs to use |
3902 | more than a hundred or so sockets, then likely it needs to use a totally |
4426 | more than a hundred or so sockets, then likely it needs to use a totally |
3903 | different implementation for windows, as libev offers the POSIX readiness |
4427 | different implementation for windows, as libev offers the POSIX readiness |
3904 | notification model, which cannot be implemented efficiently on windows |
4428 | notification model, which cannot be implemented efficiently on windows |
3905 | (Microsoft monopoly games). |
4429 | (due to Microsoft monopoly games). |
3906 | |
4430 | |
3907 | A typical way to use libev under windows is to embed it (see the embedding |
4431 | A typical way to use libev under windows is to embed it (see the embedding |
3908 | section for details) and use the following F<evwrap.h> header file instead |
4432 | section for details) and use the following F<evwrap.h> header file instead |
3909 | of F<ev.h>: |
4433 | of F<ev.h>: |
3910 | |
4434 | |
… | |
… | |
3946 | |
4470 | |
3947 | Early versions of winsocket's select only supported waiting for a maximum |
4471 | Early versions of winsocket's select only supported waiting for a maximum |
3948 | of C<64> handles (probably owning to the fact that all windows kernels |
4472 | of C<64> handles (probably owning to the fact that all windows kernels |
3949 | can only wait for C<64> things at the same time internally; Microsoft |
4473 | can only wait for C<64> things at the same time internally; Microsoft |
3950 | recommends spawning a chain of threads and wait for 63 handles and the |
4474 | recommends spawning a chain of threads and wait for 63 handles and the |
3951 | previous thread in each. Great). |
4475 | previous thread in each. Sounds great!). |
3952 | |
4476 | |
3953 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
4477 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
3954 | to some high number (e.g. C<2048>) before compiling the winsocket select |
4478 | to some high number (e.g. C<2048>) before compiling the winsocket select |
3955 | call (which might be in libev or elsewhere, for example, perl does its own |
4479 | call (which might be in libev or elsewhere, for example, perl and many |
3956 | select emulation on windows). |
4480 | other interpreters do their own select emulation on windows). |
3957 | |
4481 | |
3958 | Another limit is the number of file descriptors in the Microsoft runtime |
4482 | Another limit is the number of file descriptors in the Microsoft runtime |
3959 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
4483 | libraries, which by default is C<64> (there must be a hidden I<64> |
3960 | or something like this inside Microsoft). You can increase this by calling |
4484 | fetish or something like this inside Microsoft). You can increase this |
3961 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
4485 | by calling C<_setmaxstdio>, which can increase this limit to C<2048> |
3962 | arbitrary limit), but is broken in many versions of the Microsoft runtime |
4486 | (another arbitrary limit), but is broken in many versions of the Microsoft |
3963 | libraries. |
|
|
3964 | |
|
|
3965 | This might get you to about C<512> or C<2048> sockets (depending on |
4487 | runtime libraries. This might get you to about C<512> or C<2048> sockets |
3966 | windows version and/or the phase of the moon). To get more, you need to |
4488 | (depending on windows version and/or the phase of the moon). To get more, |
3967 | wrap all I/O functions and provide your own fd management, but the cost of |
4489 | you need to wrap all I/O functions and provide your own fd management, but |
3968 | calling select (O(n²)) will likely make this unworkable. |
4490 | the cost of calling select (O(n²)) will likely make this unworkable. |
3969 | |
4491 | |
3970 | =back |
4492 | =back |
3971 | |
4493 | |
3972 | =head2 PORTABILITY REQUIREMENTS |
4494 | =head2 PORTABILITY REQUIREMENTS |
3973 | |
4495 | |
… | |
… | |
4016 | =item C<double> must hold a time value in seconds with enough accuracy |
4538 | =item C<double> must hold a time value in seconds with enough accuracy |
4017 | |
4539 | |
4018 | The type C<double> is used to represent timestamps. It is required to |
4540 | The type C<double> is used to represent timestamps. It is required to |
4019 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
4541 | have at least 51 bits of mantissa (and 9 bits of exponent), which is good |
4020 | enough for at least into the year 4000. This requirement is fulfilled by |
4542 | enough for at least into the year 4000. This requirement is fulfilled by |
4021 | implementations implementing IEEE 754 (basically all existing ones). |
4543 | implementations implementing IEEE 754, which is basically all existing |
|
|
4544 | ones. With IEEE 754 doubles, you get microsecond accuracy until at least |
|
|
4545 | 2200. |
4022 | |
4546 | |
4023 | =back |
4547 | =back |
4024 | |
4548 | |
4025 | If you know of other additional requirements drop me a note. |
4549 | If you know of other additional requirements drop me a note. |
4026 | |
4550 | |
… | |
… | |
4094 | involves iterating over all running async watchers or all signal numbers. |
4618 | involves iterating over all running async watchers or all signal numbers. |
4095 | |
4619 | |
4096 | =back |
4620 | =back |
4097 | |
4621 | |
4098 | |
4622 | |
|
|
4623 | =head1 PORTING FROM 3.X TO 4.X |
|
|
4624 | |
|
|
4625 | The major version 4 introduced some minor incompatible changes to the API. |
|
|
4626 | |
|
|
4627 | =over 4 |
|
|
4628 | |
|
|
4629 | =item C<EV_TIMEOUT> replaced by C<EV_TIMER> in C<revents> |
|
|
4630 | |
|
|
4631 | This is a simple rename - all other watcher types use their name |
|
|
4632 | as revents flag, and now C<ev_timer> does, too. |
|
|
4633 | |
|
|
4634 | Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions |
|
|
4635 | and continue to be present for the forseeable future, so this is mostly a |
|
|
4636 | documentation change. |
|
|
4637 | |
|
|
4638 | =item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> |
|
|
4639 | |
|
|
4640 | The preprocessor symbol C<EV_MINIMAL> has been replaced by a different |
|
|
4641 | mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile |
|
|
4642 | and work, but the library code will of course be larger. |
|
|
4643 | |
|
|
4644 | =back |
|
|
4645 | |
|
|
4646 | |
|
|
4647 | =head1 GLOSSARY |
|
|
4648 | |
|
|
4649 | =over 4 |
|
|
4650 | |
|
|
4651 | =item active |
|
|
4652 | |
|
|
4653 | A watcher is active as long as it has been started (has been attached to |
|
|
4654 | an event loop) but not yet stopped (disassociated from the event loop). |
|
|
4655 | |
|
|
4656 | =item application |
|
|
4657 | |
|
|
4658 | In this document, an application is whatever is using libev. |
|
|
4659 | |
|
|
4660 | =item callback |
|
|
4661 | |
|
|
4662 | The address of a function that is called when some event has been |
|
|
4663 | detected. Callbacks are being passed the event loop, the watcher that |
|
|
4664 | received the event, and the actual event bitset. |
|
|
4665 | |
|
|
4666 | =item callback invocation |
|
|
4667 | |
|
|
4668 | The act of calling the callback associated with a watcher. |
|
|
4669 | |
|
|
4670 | =item event |
|
|
4671 | |
|
|
4672 | A change of state of some external event, such as data now being available |
|
|
4673 | for reading on a file descriptor, time having passed or simply not having |
|
|
4674 | any other events happening anymore. |
|
|
4675 | |
|
|
4676 | In libev, events are represented as single bits (such as C<EV_READ> or |
|
|
4677 | C<EV_TIMER>). |
|
|
4678 | |
|
|
4679 | =item event library |
|
|
4680 | |
|
|
4681 | A software package implementing an event model and loop. |
|
|
4682 | |
|
|
4683 | =item event loop |
|
|
4684 | |
|
|
4685 | An entity that handles and processes external events and converts them |
|
|
4686 | into callback invocations. |
|
|
4687 | |
|
|
4688 | =item event model |
|
|
4689 | |
|
|
4690 | The model used to describe how an event loop handles and processes |
|
|
4691 | watchers and events. |
|
|
4692 | |
|
|
4693 | =item pending |
|
|
4694 | |
|
|
4695 | A watcher is pending as soon as the corresponding event has been detected, |
|
|
4696 | and stops being pending as soon as the watcher will be invoked or its |
|
|
4697 | pending status is explicitly cleared by the application. |
|
|
4698 | |
|
|
4699 | A watcher can be pending, but not active. Stopping a watcher also clears |
|
|
4700 | its pending status. |
|
|
4701 | |
|
|
4702 | =item real time |
|
|
4703 | |
|
|
4704 | The physical time that is observed. It is apparently strictly monotonic :) |
|
|
4705 | |
|
|
4706 | =item wall-clock time |
|
|
4707 | |
|
|
4708 | The time and date as shown on clocks. Unlike real time, it can actually |
|
|
4709 | be wrong and jump forwards and backwards, e.g. when the you adjust your |
|
|
4710 | clock. |
|
|
4711 | |
|
|
4712 | =item watcher |
|
|
4713 | |
|
|
4714 | A data structure that describes interest in certain events. Watchers need |
|
|
4715 | to be started (attached to an event loop) before they can receive events. |
|
|
4716 | |
|
|
4717 | =item watcher invocation |
|
|
4718 | |
|
|
4719 | The act of calling the callback associated with a watcher. |
|
|
4720 | |
|
|
4721 | =back |
|
|
4722 | |
4099 | =head1 AUTHOR |
4723 | =head1 AUTHOR |
4100 | |
4724 | |
4101 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |
4725 | Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson. |
4102 | |
4726 | |