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

Comparing libev/ev.pod (file contents):
Revision 1.237 by root, Thu Apr 16 07:58:03 2009 UTC vs.
Revision 1.307 by root, Thu Oct 21 02:33:08 2010 UTC

75While this document tries to be as complete as possible in documenting 75While this document tries to be as complete as possible in documenting
76libev, its usage and the rationale behind its design, it is not a tutorial 76libev, its usage and the rationale behind its design, it is not a tutorial
77on event-based programming, nor will it introduce event-based programming 77on event-based programming, nor will it introduce event-based programming
78with libev. 78with libev.
79 79
80Familarity with event based programming techniques in general is assumed 80Familiarity with event based programming techniques in general is assumed
81throughout this document. 81throughout this document.
82 82
83=head1 ABOUT LIBEV 83=head1 ABOUT LIBEV
84 84
85Libev is an event loop: you register interest in certain events (such as a 85Libev is an event loop: you register interest in certain events (such as a
98=head2 FEATURES 98=head2 FEATURES
99 99
100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102for file descriptor events (C<ev_io>), the Linux C<inotify> interface 102for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 103(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104with customised rescheduling (C<ev_periodic>), synchronous signals 104inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105(C<ev_signal>), process status change events (C<ev_child>), and event 105timers (C<ev_timer>), absolute timers with customised rescheduling
106watchers dealing with the event loop mechanism itself (C<ev_idle>, 106(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 107change events (C<ev_child>), and event watchers dealing with the event
108file watchers (C<ev_stat>) and even limited support for fork events 108loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109(C<ev_fork>). 109C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
110limited support for fork events (C<ev_fork>).
110 111
111It also is quite fast (see this 112It also is quite fast (see this
112L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 113L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113for example). 114for example).
114 115
117Libev is very configurable. In this manual the default (and most common) 118Libev is very configurable. In this manual the default (and most common)
118configuration will be described, which supports multiple event loops. For 119configuration will be described, which supports multiple event loops. For
119more info about various configuration options please have a look at 120more info about various configuration options please have a look at
120B<EMBED> section in this manual. If libev was configured without support 121B<EMBED> section in this manual. If libev was configured without support
121for multiple event loops, then all functions taking an initial argument of 122for multiple event loops, then all functions taking an initial argument of
122name C<loop> (which is always of type C<ev_loop *>) will not have 123name C<loop> (which is always of type C<struct ev_loop *>) will not have
123this argument. 124this argument.
124 125
125=head2 TIME REPRESENTATION 126=head2 TIME REPRESENTATION
126 127
127Libev represents time as a single floating point number, representing 128Libev represents time as a single floating point number, representing
128the (fractional) number of seconds since the (POSIX) epoch (somewhere 129the (fractional) number of seconds since the (POSIX) epoch (in practise
129near the beginning of 1970, details are complicated, don't ask). This 130somewhere near the beginning of 1970, details are complicated, don't
130type is called C<ev_tstamp>, which is what you should use too. It usually 131ask). This type is called C<ev_tstamp>, which is what you should use
131aliases to the C<double> type in C. When you need to do any calculations 132too. It usually aliases to the C<double> type in C. When you need to do
132on it, you should treat it as some floating point value. Unlike the name 133any calculations on it, you should treat it as some floating point value.
134
133component C<stamp> might indicate, it is also used for time differences 135Unlike the name component C<stamp> might indicate, it is also used for
134throughout libev. 136time differences (e.g. delays) throughout libev.
135 137
136=head1 ERROR HANDLING 138=head1 ERROR HANDLING
137 139
138Libev knows three classes of errors: operating system errors, usage errors 140Libev knows three classes of errors: operating system errors, usage errors
139and internal errors (bugs). 141and internal errors (bugs).
190as this indicates an incompatible change. Minor versions are usually 192as this indicates an incompatible change. Minor versions are usually
191compatible to older versions, so a larger minor version alone is usually 193compatible to older versions, so a larger minor version alone is usually
192not a problem. 194not a problem.
193 195
194Example: Make sure we haven't accidentally been linked against the wrong 196Example: Make sure we haven't accidentally been linked against the wrong
195version. 197version (note, however, that this will not detect ABI mismatches :).
196 198
197 assert (("libev version mismatch", 199 assert (("libev version mismatch",
198 ev_version_major () == EV_VERSION_MAJOR 200 ev_version_major () == EV_VERSION_MAJOR
199 && ev_version_minor () >= EV_VERSION_MINOR)); 201 && ev_version_minor () >= EV_VERSION_MINOR));
200 202
344useful to try out specific backends to test their performance, or to work 346useful to try out specific backends to test their performance, or to work
345around bugs. 347around bugs.
346 348
347=item C<EVFLAG_FORKCHECK> 349=item C<EVFLAG_FORKCHECK>
348 350
349Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after 351Instead of calling C<ev_loop_fork> manually after a fork, you can also
350a fork, you can also make libev check for a fork in each iteration by 352make libev check for a fork in each iteration by enabling this flag.
351enabling this flag.
352 353
353This works by calling C<getpid ()> on every iteration of the loop, 354This works by calling C<getpid ()> on every iteration of the loop,
354and thus this might slow down your event loop if you do a lot of loop 355and thus this might slow down your event loop if you do a lot of loop
355iterations and little real work, but is usually not noticeable (on my 356iterations and little real work, but is usually not noticeable (on my
356GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 357GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
362flag. 363flag.
363 364
364This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 365This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365environment variable. 366environment variable.
366 367
368=item C<EVFLAG_NOINOTIFY>
369
370When this flag is specified, then libev will not attempt to use the
371I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
372testing, this flag can be useful to conserve inotify file descriptors, as
373otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374
375=item C<EVFLAG_SIGNALFD>
376
377When this flag is specified, then libev will attempt to use the
378I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API
379delivers signals synchronously, which makes it both faster and might make
380it possible to get the queued signal data. It can also simplify signal
381handling with threads, as long as you properly block signals in your
382threads that are not interested in handling them.
383
384Signalfd will not be used by default as this changes your signal mask, and
385there are a lot of shoddy libraries and programs (glib's threadpool for
386example) that can't properly initialise their signal masks.
387
367=item C<EVBACKEND_SELECT> (value 1, portable select backend) 388=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368 389
369This is your standard select(2) backend. Not I<completely> standard, as 390This is your standard select(2) backend. Not I<completely> standard, as
370libev tries to roll its own fd_set with no limits on the number of fds, 391libev tries to roll its own fd_set with no limits on the number of fds,
371but if that fails, expect a fairly low limit on the number of fds when 392but if that fails, expect a fairly low limit on the number of fds when
394 415
395This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 416This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
396C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 417C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
397 418
398=item C<EVBACKEND_EPOLL> (value 4, Linux) 419=item C<EVBACKEND_EPOLL> (value 4, Linux)
420
421Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
422kernels).
399 423
400For few fds, this backend is a bit little slower than poll and select, 424For few fds, this backend is a bit little slower than poll and select,
401but it scales phenomenally better. While poll and select usually scale 425but it scales phenomenally better. While poll and select usually scale
402like O(total_fds) where n is the total number of fds (or the highest fd), 426like O(total_fds) where n is the total number of fds (or the highest fd),
403epoll scales either O(1) or O(active_fds). 427epoll scales either O(1) or O(active_fds).
415of course I<doesn't>, and epoll just loves to report events for totally 439of course I<doesn't>, and epoll just loves to report events for totally
416I<different> file descriptors (even already closed ones, so one cannot 440I<different> file descriptors (even already closed ones, so one cannot
417even remove them from the set) than registered in the set (especially 441even remove them from the set) than registered in the set (especially
418on SMP systems). Libev tries to counter these spurious notifications by 442on SMP systems). Libev tries to counter these spurious notifications by
419employing an additional generation counter and comparing that against the 443employing an additional generation counter and comparing that against the
420events to filter out spurious ones, recreating the set when required. 444events to filter out spurious ones, recreating the set when required. Last
445not least, it also refuses to work with some file descriptors which work
446perfectly fine with C<select> (files, many character devices...).
421 447
422While stopping, setting and starting an I/O watcher in the same iteration 448While stopping, setting and starting an I/O watcher in the same iteration
423will result in some caching, there is still a system call per such 449will result in some caching, there is still a system call per such
424incident (because the same I<file descriptor> could point to a different 450incident (because the same I<file descriptor> could point to a different
425I<file description> now), so its best to avoid that. Also, C<dup ()>'ed 451I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
518 544
519It is definitely not recommended to use this flag. 545It is definitely not recommended to use this flag.
520 546
521=back 547=back
522 548
523If one or more of these are or'ed into the flags value, then only these 549If one or more of the backend flags are or'ed into the flags value,
524backends will be tried (in the reverse order as listed here). If none are 550then only these backends will be tried (in the reverse order as listed
525specified, all backends in C<ev_recommended_backends ()> will be tried. 551here). If none are specified, all backends in C<ev_recommended_backends
552()> will be tried.
526 553
527Example: This is the most typical usage. 554Example: This is the most typical usage.
528 555
529 if (!ev_default_loop (0)) 556 if (!ev_default_loop (0))
530 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 557 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
542 ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 569 ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
543 570
544=item struct ev_loop *ev_loop_new (unsigned int flags) 571=item struct ev_loop *ev_loop_new (unsigned int flags)
545 572
546Similar to C<ev_default_loop>, but always creates a new event loop that is 573Similar to C<ev_default_loop>, but always creates a new event loop that is
547always distinct from the default loop. Unlike the default loop, it cannot 574always distinct from the default loop.
548handle signal and child watchers, and attempts to do so will be greeted by
549undefined behaviour (or a failed assertion if assertions are enabled).
550 575
551Note that this function I<is> thread-safe, and the recommended way to use 576Note that this function I<is> thread-safe, and one common way to use
552libev with threads is indeed to create one loop per thread, and using the 577libev with threads is indeed to create one loop per thread, and using the
553default loop in the "main" or "initial" thread. 578default loop in the "main" or "initial" thread.
554 579
555Example: Try to create a event loop that uses epoll and nothing else. 580Example: Try to create a event loop that uses epoll and nothing else.
556 581
558 if (!epoller) 583 if (!epoller)
559 fatal ("no epoll found here, maybe it hides under your chair"); 584 fatal ("no epoll found here, maybe it hides under your chair");
560 585
561=item ev_default_destroy () 586=item ev_default_destroy ()
562 587
563Destroys the default loop again (frees all memory and kernel state 588Destroys the default loop (frees all memory and kernel state etc.). None
564etc.). None of the active event watchers will be stopped in the normal 589of the active event watchers will be stopped in the normal sense, so
565sense, so e.g. C<ev_is_active> might still return true. It is your 590e.g. C<ev_is_active> might still return true. It is your responsibility to
566responsibility to either stop all watchers cleanly yourself I<before> 591either stop all watchers cleanly yourself I<before> calling this function,
567calling this function, or cope with the fact afterwards (which is usually 592or cope with the fact afterwards (which is usually the easiest thing, you
568the easiest thing, you can just ignore the watchers and/or C<free ()> them 593can just ignore the watchers and/or C<free ()> them for example).
569for example).
570 594
571Note that certain global state, such as signal state (and installed signal 595Note that certain global state, such as signal state (and installed signal
572handlers), will not be freed by this function, and related watchers (such 596handlers), will not be freed by this function, and related watchers (such
573as signal and child watchers) would need to be stopped manually. 597as signal and child watchers) would need to be stopped manually.
574 598
575In general it is not advisable to call this function except in the 599In general it is not advisable to call this function except in the
576rare occasion where you really need to free e.g. the signal handling 600rare occasion where you really need to free e.g. the signal handling
577pipe fds. If you need dynamically allocated loops it is better to use 601pipe fds. If you need dynamically allocated loops it is better to use
578C<ev_loop_new> and C<ev_loop_destroy>). 602C<ev_loop_new> and C<ev_loop_destroy>.
579 603
580=item ev_loop_destroy (loop) 604=item ev_loop_destroy (loop)
581 605
582Like C<ev_default_destroy>, but destroys an event loop created by an 606Like C<ev_default_destroy>, but destroys an event loop created by an
583earlier call to C<ev_loop_new>. 607earlier call to C<ev_loop_new>.
589name, you can call it anytime, but it makes most sense after forking, in 613name, you can call it anytime, but it makes most sense after forking, in
590the child process (or both child and parent, but that again makes little 614the child process (or both child and parent, but that again makes little
591sense). You I<must> call it in the child before using any of the libev 615sense). You I<must> call it in the child before using any of the libev
592functions, and it will only take effect at the next C<ev_loop> iteration. 616functions, and it will only take effect at the next C<ev_loop> iteration.
593 617
618Again, you I<have> to call it on I<any> loop that you want to re-use after
619a fork, I<even if you do not plan to use the loop in the parent>. This is
620because some kernel interfaces *cough* I<kqueue> *cough* do funny things
621during fork.
622
594On the other hand, you only need to call this function in the child 623On the other hand, you only need to call this function in the child
595process if and only if you want to use the event library in the child. If 624process if and only if you want to use the event loop in the child. If you
596you just fork+exec, you don't have to call it at all. 625just fork+exec or create a new loop in the child, you don't have to call
626it at all.
597 627
598The function itself is quite fast and it's usually not a problem to call 628The function itself is quite fast and it's usually not a problem to call
599it just in case after a fork. To make this easy, the function will fit in 629it just in case after a fork. To make this easy, the function will fit in
600quite nicely into a call to C<pthread_atfork>: 630quite nicely into a call to C<pthread_atfork>:
601 631
603 633
604=item ev_loop_fork (loop) 634=item ev_loop_fork (loop)
605 635
606Like C<ev_default_fork>, but acts on an event loop created by 636Like C<ev_default_fork>, but acts on an event loop created by
607C<ev_loop_new>. Yes, you have to call this on every allocated event loop 637C<ev_loop_new>. Yes, you have to call this on every allocated event loop
608after fork that you want to re-use in the child, and how you do this is 638after fork that you want to re-use in the child, and how you keep track of
609entirely your own problem. 639them is entirely your own problem.
610 640
611=item int ev_is_default_loop (loop) 641=item int ev_is_default_loop (loop)
612 642
613Returns true when the given loop is, in fact, the default loop, and false 643Returns true when the given loop is, in fact, the default loop, and false
614otherwise. 644otherwise.
615 645
616=item unsigned int ev_loop_count (loop) 646=item unsigned int ev_iteration (loop)
617 647
618Returns the count of loop iterations for the loop, which is identical to 648Returns the current iteration count for the loop, which is identical to
619the number of times libev did poll for new events. It starts at C<0> and 649the number of times libev did poll for new events. It starts at C<0> and
620happily wraps around with enough iterations. 650happily wraps around with enough iterations.
621 651
622This value can sometimes be useful as a generation counter of sorts (it 652This value can sometimes be useful as a generation counter of sorts (it
623"ticks" the number of loop iterations), as it roughly corresponds with 653"ticks" the number of loop iterations), as it roughly corresponds with
624C<ev_prepare> and C<ev_check> calls. 654C<ev_prepare> and C<ev_check> calls - and is incremented between the
655prepare and check phases.
656
657=item unsigned int ev_depth (loop)
658
659Returns the number of times C<ev_loop> was entered minus the number of
660times C<ev_loop> was exited, in other words, the recursion depth.
661
662Outside C<ev_loop>, this number is zero. In a callback, this number is
663C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
664in which case it is higher.
665
666Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
667etc.), doesn't count as "exit" - consider this as a hint to avoid such
668ungentleman behaviour unless it's really convenient.
625 669
626=item unsigned int ev_backend (loop) 670=item unsigned int ev_backend (loop)
627 671
628Returns one of the C<EVBACKEND_*> flags indicating the event backend in 672Returns one of the C<EVBACKEND_*> flags indicating the event backend in
629use. 673use.
644 688
645This function is rarely useful, but when some event callback runs for a 689This function is rarely useful, but when some event callback runs for a
646very long time without entering the event loop, updating libev's idea of 690very long time without entering the event loop, updating libev's idea of
647the current time is a good idea. 691the current time is a good idea.
648 692
649See also "The special problem of time updates" in the C<ev_timer> section. 693See also L<The special problem of time updates> in the C<ev_timer> section.
650 694
651=item ev_suspend (loop) 695=item ev_suspend (loop)
652 696
653=item ev_resume (loop) 697=item ev_resume (loop)
654 698
663C<ev_resume> directly afterwards to resume timer processing. 707C<ev_resume> directly afterwards to resume timer processing.
664 708
665Effectively, all C<ev_timer> watchers will be delayed by the time spend 709Effectively, all C<ev_timer> watchers will be delayed by the time spend
666between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers 710between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
667will be rescheduled (that is, they will lose any events that would have 711will be rescheduled (that is, they will lose any events that would have
668occured while suspended). 712occurred while suspended).
669 713
670After calling C<ev_suspend> you B<must not> call I<any> function on the 714After calling C<ev_suspend> you B<must not> call I<any> function on the
671given loop other than C<ev_resume>, and you B<must not> call C<ev_resume> 715given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
672without a previous call to C<ev_suspend>. 716without a previous call to C<ev_suspend>.
673 717
675event loop time (see C<ev_now_update>). 719event loop time (see C<ev_now_update>).
676 720
677=item ev_loop (loop, int flags) 721=item ev_loop (loop, int flags)
678 722
679Finally, this is it, the event handler. This function usually is called 723Finally, this is it, the event handler. This function usually is called
680after you initialised all your watchers and you want to start handling 724after you have initialised all your watchers and you want to start
681events. 725handling events.
682 726
683If the flags argument is specified as C<0>, it will not return until 727If the flags argument is specified as C<0>, it will not return until
684either no event watchers are active anymore or C<ev_unloop> was called. 728either no event watchers are active anymore or C<ev_unloop> was called.
685 729
686Please note that an explicit C<ev_unloop> is usually better than 730Please note that an explicit C<ev_unloop> is usually better than
750C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or 794C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
751C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. 795C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
752 796
753This "unloop state" will be cleared when entering C<ev_loop> again. 797This "unloop state" will be cleared when entering C<ev_loop> again.
754 798
755It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls. 799It is safe to call C<ev_unloop> from outside any C<ev_loop> calls.
756 800
757=item ev_ref (loop) 801=item ev_ref (loop)
758 802
759=item ev_unref (loop) 803=item ev_unref (loop)
760 804
761Ref/unref can be used to add or remove a reference count on the event 805Ref/unref can be used to add or remove a reference count on the event
762loop: Every watcher keeps one reference, and as long as the reference 806loop: Every watcher keeps one reference, and as long as the reference
763count is nonzero, C<ev_loop> will not return on its own. 807count is nonzero, C<ev_loop> will not return on its own.
764 808
765If you have a watcher you never unregister that should not keep C<ev_loop> 809This is useful when you have a watcher that you never intend to
766from returning, call ev_unref() after starting, and ev_ref() before 810unregister, but that nevertheless should not keep C<ev_loop> from
811returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
767stopping it. 812before stopping it.
768 813
769As an example, libev itself uses this for its internal signal pipe: It 814As an example, libev itself uses this for its internal signal pipe: It
770is not visible to the libev user and should not keep C<ev_loop> from 815is not visible to the libev user and should not keep C<ev_loop> from
771exiting if no event watchers registered by it are active. It is also an 816exiting if no event watchers registered by it are active. It is also an
772excellent way to do this for generic recurring timers or from within 817excellent way to do this for generic recurring timers or from within
811 856
812By setting a higher I<io collect interval> you allow libev to spend more 857By setting a higher I<io collect interval> you allow libev to spend more
813time collecting I/O events, so you can handle more events per iteration, 858time collecting I/O events, so you can handle more events per iteration,
814at the cost of increasing latency. Timeouts (both C<ev_periodic> and 859at the cost of increasing latency. Timeouts (both C<ev_periodic> and
815C<ev_timer>) will be not affected. Setting this to a non-null value will 860C<ev_timer>) will be not affected. Setting this to a non-null value will
816introduce an additional C<ev_sleep ()> call into most loop iterations. 861introduce an additional C<ev_sleep ()> call into most loop iterations. The
862sleep time ensures that libev will not poll for I/O events more often then
863once per this interval, on average.
817 864
818Likewise, by setting a higher I<timeout collect interval> you allow libev 865Likewise, by setting a higher I<timeout collect interval> you allow libev
819to spend more time collecting timeouts, at the expense of increased 866to spend more time collecting timeouts, at the expense of increased
820latency/jitter/inexactness (the watcher callback will be called 867latency/jitter/inexactness (the watcher callback will be called
821later). C<ev_io> watchers will not be affected. Setting this to a non-null 868later). C<ev_io> watchers will not be affected. Setting this to a non-null
823 870
824Many (busy) programs can usually benefit by setting the I/O collect 871Many (busy) programs can usually benefit by setting the I/O collect
825interval to a value near C<0.1> or so, which is often enough for 872interval to a value near C<0.1> or so, which is often enough for
826interactive servers (of course not for games), likewise for timeouts. It 873interactive servers (of course not for games), likewise for timeouts. It
827usually doesn't make much sense to set it to a lower value than C<0.01>, 874usually doesn't make much sense to set it to a lower value than C<0.01>,
828as this approaches the timing granularity of most systems. 875as this approaches the timing granularity of most systems. Note that if
876you do transactions with the outside world and you can't increase the
877parallelity, then this setting will limit your transaction rate (if you
878need to poll once per transaction and the I/O collect interval is 0.01,
879then you can't do more than 100 transactions per second).
829 880
830Setting the I<timeout collect interval> can improve the opportunity for 881Setting the I<timeout collect interval> can improve the opportunity for
831saving power, as the program will "bundle" timer callback invocations that 882saving power, as the program will "bundle" timer callback invocations that
832are "near" in time together, by delaying some, thus reducing the number of 883are "near" in time together, by delaying some, thus reducing the number of
833times the process sleeps and wakes up again. Another useful technique to 884times the process sleeps and wakes up again. Another useful technique to
834reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure 885reduce iterations/wake-ups is to use C<ev_periodic> watchers and make sure
835they fire on, say, one-second boundaries only. 886they fire on, say, one-second boundaries only.
836 887
888Example: we only need 0.1s timeout granularity, and we wish not to poll
889more often than 100 times per second:
890
891 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
892 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
893
894=item ev_invoke_pending (loop)
895
896This call will simply invoke all pending watchers while resetting their
897pending state. Normally, C<ev_loop> does this automatically when required,
898but when overriding the invoke callback this call comes handy.
899
900=item int ev_pending_count (loop)
901
902Returns the number of pending watchers - zero indicates that no watchers
903are pending.
904
905=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
906
907This overrides the invoke pending functionality of the loop: Instead of
908invoking all pending watchers when there are any, C<ev_loop> will call
909this callback instead. This is useful, for example, when you want to
910invoke the actual watchers inside another context (another thread etc.).
911
912If you want to reset the callback, use C<ev_invoke_pending> as new
913callback.
914
915=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
916
917Sometimes you want to share the same loop between multiple threads. This
918can be done relatively simply by putting mutex_lock/unlock calls around
919each call to a libev function.
920
921However, C<ev_loop> can run an indefinite time, so it is not feasible to
922wait for it to return. One way around this is to wake up the loop via
923C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
924and I<acquire> callbacks on the loop.
925
926When set, then C<release> will be called just before the thread is
927suspended waiting for new events, and C<acquire> is called just
928afterwards.
929
930Ideally, C<release> will just call your mutex_unlock function, and
931C<acquire> will just call the mutex_lock function again.
932
933While event loop modifications are allowed between invocations of
934C<release> and C<acquire> (that's their only purpose after all), no
935modifications done will affect the event loop, i.e. adding watchers will
936have no effect on the set of file descriptors being watched, or the time
937waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it
938to take note of any changes you made.
939
940In theory, threads executing C<ev_loop> will be async-cancel safe between
941invocations of C<release> and C<acquire>.
942
943See also the locking example in the C<THREADS> section later in this
944document.
945
946=item ev_set_userdata (loop, void *data)
947
948=item ev_userdata (loop)
949
950Set and retrieve a single C<void *> associated with a loop. When
951C<ev_set_userdata> has never been called, then C<ev_userdata> returns
952C<0.>
953
954These two functions can be used to associate arbitrary data with a loop,
955and are intended solely for the C<invoke_pending_cb>, C<release> and
956C<acquire> callbacks described above, but of course can be (ab-)used for
957any other purpose as well.
958
837=item ev_loop_verify (loop) 959=item ev_loop_verify (loop)
838 960
839This function only does something when C<EV_VERIFY> support has been 961This function only does something when C<EV_VERIFY> support has been
840compiled in, which is the default for non-minimal builds. It tries to go 962compiled in, which is the default for non-minimal builds. It tries to go
841through all internal structures and checks them for validity. If anything 963through all internal structures and checks them for validity. If anything
917=item C<EV_WRITE> 1039=item C<EV_WRITE>
918 1040
919The file descriptor in the C<ev_io> watcher has become readable and/or 1041The file descriptor in the C<ev_io> watcher has become readable and/or
920writable. 1042writable.
921 1043
922=item C<EV_TIMEOUT> 1044=item C<EV_TIMER>
923 1045
924The C<ev_timer> watcher has timed out. 1046The C<ev_timer> watcher has timed out.
925 1047
926=item C<EV_PERIODIC> 1048=item C<EV_PERIODIC>
927 1049
1017 1139
1018 ev_io w; 1140 ev_io w;
1019 ev_init (&w, my_cb); 1141 ev_init (&w, my_cb);
1020 ev_io_set (&w, STDIN_FILENO, EV_READ); 1142 ev_io_set (&w, STDIN_FILENO, EV_READ);
1021 1143
1022=item C<ev_TYPE_set> (ev_TYPE *, [args]) 1144=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1023 1145
1024This macro initialises the type-specific parts of a watcher. You need to 1146This macro initialises the type-specific parts of a watcher. You need to
1025call C<ev_init> at least once before you call this macro, but you can 1147call C<ev_init> at least once before you call this macro, but you can
1026call C<ev_TYPE_set> any number of times. You must not, however, call this 1148call C<ev_TYPE_set> any number of times. You must not, however, call this
1027macro on a watcher that is active (it can be pending, however, which is a 1149macro on a watcher that is active (it can be pending, however, which is a
1040 1162
1041Example: Initialise and set an C<ev_io> watcher in one step. 1163Example: Initialise and set an C<ev_io> watcher in one step.
1042 1164
1043 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); 1165 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1044 1166
1045=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) 1167=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1046 1168
1047Starts (activates) the given watcher. Only active watchers will receive 1169Starts (activates) the given watcher. Only active watchers will receive
1048events. If the watcher is already active nothing will happen. 1170events. If the watcher is already active nothing will happen.
1049 1171
1050Example: Start the C<ev_io> watcher that is being abused as example in this 1172Example: Start the C<ev_io> watcher that is being abused as example in this
1051whole section. 1173whole section.
1052 1174
1053 ev_io_start (EV_DEFAULT_UC, &w); 1175 ev_io_start (EV_DEFAULT_UC, &w);
1054 1176
1055=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) 1177=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1056 1178
1057Stops the given watcher if active, and clears the pending status (whether 1179Stops the given watcher if active, and clears the pending status (whether
1058the watcher was active or not). 1180the watcher was active or not).
1059 1181
1060It is possible that stopped watchers are pending - for example, 1182It is possible that stopped watchers are pending - for example,
1085=item ev_cb_set (ev_TYPE *watcher, callback) 1207=item ev_cb_set (ev_TYPE *watcher, callback)
1086 1208
1087Change the callback. You can change the callback at virtually any time 1209Change the callback. You can change the callback at virtually any time
1088(modulo threads). 1210(modulo threads).
1089 1211
1090=item ev_set_priority (ev_TYPE *watcher, priority) 1212=item ev_set_priority (ev_TYPE *watcher, int priority)
1091 1213
1092=item int ev_priority (ev_TYPE *watcher) 1214=item int ev_priority (ev_TYPE *watcher)
1093 1215
1094Set and query the priority of the watcher. The priority is a small 1216Set and query the priority of the watcher. The priority is a small
1095integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1217integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1126returns its C<revents> bitset (as if its callback was invoked). If the 1248returns its C<revents> bitset (as if its callback was invoked). If the
1127watcher isn't pending it does nothing and returns C<0>. 1249watcher isn't pending it does nothing and returns C<0>.
1128 1250
1129Sometimes it can be useful to "poll" a watcher instead of waiting for its 1251Sometimes it can be useful to "poll" a watcher instead of waiting for its
1130callback to be invoked, which can be accomplished with this function. 1252callback to be invoked, which can be accomplished with this function.
1253
1254=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1255
1256Feeds the given event set into the event loop, as if the specified event
1257had happened for the specified watcher (which must be a pointer to an
1258initialised but not necessarily started event watcher). Obviously you must
1259not free the watcher as long as it has pending events.
1260
1261Stopping the watcher, letting libev invoke it, or calling
1262C<ev_clear_pending> will clear the pending event, even if the watcher was
1263not started in the first place.
1264
1265See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1266functions that do not need a watcher.
1131 1267
1132=back 1268=back
1133 1269
1134 1270
1135=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 1271=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1184 #include <stddef.h> 1320 #include <stddef.h>
1185 1321
1186 static void 1322 static void
1187 t1_cb (EV_P_ ev_timer *w, int revents) 1323 t1_cb (EV_P_ ev_timer *w, int revents)
1188 { 1324 {
1189 struct my_biggy big = (struct my_biggy * 1325 struct my_biggy big = (struct my_biggy *)
1190 (((char *)w) - offsetof (struct my_biggy, t1)); 1326 (((char *)w) - offsetof (struct my_biggy, t1));
1191 } 1327 }
1192 1328
1193 static void 1329 static void
1194 t2_cb (EV_P_ ev_timer *w, int revents) 1330 t2_cb (EV_P_ ev_timer *w, int revents)
1195 { 1331 {
1196 struct my_biggy big = (struct my_biggy * 1332 struct my_biggy big = (struct my_biggy *)
1197 (((char *)w) - offsetof (struct my_biggy, t2)); 1333 (((char *)w) - offsetof (struct my_biggy, t2));
1198 } 1334 }
1199 1335
1200=head2 WATCHER PRIORITY MODELS 1336=head2 WATCHER PRIORITY MODELS
1201 1337
1246 1382
1247For example, to emulate how many other event libraries handle priorities, 1383For example, to emulate how many other event libraries handle priorities,
1248you can associate an C<ev_idle> watcher to each such watcher, and in 1384you can associate an C<ev_idle> watcher to each such watcher, and in
1249the normal watcher callback, you just start the idle watcher. The real 1385the normal watcher callback, you just start the idle watcher. The real
1250processing is done in the idle watcher callback. This causes libev to 1386processing is done in the idle watcher callback. This causes libev to
1251continously poll and process kernel event data for the watcher, but when 1387continuously poll and process kernel event data for the watcher, but when
1252the lock-out case is known to be rare (which in turn is rare :), this is 1388the lock-out case is known to be rare (which in turn is rare :), this is
1253workable. 1389workable.
1254 1390
1255Usually, however, the lock-out model implemented that way will perform 1391Usually, however, the lock-out model implemented that way will perform
1256miserably under the type of load it was designed to handle. In that case, 1392miserably under the type of load it was designed to handle. In that case,
1270 { 1406 {
1271 // stop the I/O watcher, we received the event, but 1407 // stop the I/O watcher, we received the event, but
1272 // are not yet ready to handle it. 1408 // are not yet ready to handle it.
1273 ev_io_stop (EV_A_ w); 1409 ev_io_stop (EV_A_ w);
1274 1410
1275 // start the idle watcher to ahndle the actual event. 1411 // start the idle watcher to handle the actual event.
1276 // it will not be executed as long as other watchers 1412 // it will not be executed as long as other watchers
1277 // with the default priority are receiving events. 1413 // with the default priority are receiving events.
1278 ev_idle_start (EV_A_ &idle); 1414 ev_idle_start (EV_A_ &idle);
1279 } 1415 }
1280 1416
1281 static void 1417 static void
1282 idle-cb (EV_P_ ev_idle *w, int revents) 1418 idle_cb (EV_P_ ev_idle *w, int revents)
1283 { 1419 {
1284 // actual processing 1420 // actual processing
1285 read (STDIN_FILENO, ...); 1421 read (STDIN_FILENO, ...);
1286 1422
1287 // have to start the I/O watcher again, as 1423 // have to start the I/O watcher again, as
1332descriptors to non-blocking mode is also usually a good idea (but not 1468descriptors to non-blocking mode is also usually a good idea (but not
1333required if you know what you are doing). 1469required if you know what you are doing).
1334 1470
1335If you cannot use non-blocking mode, then force the use of a 1471If you cannot use non-blocking mode, then force the use of a
1336known-to-be-good backend (at the time of this writing, this includes only 1472known-to-be-good backend (at the time of this writing, this includes only
1337C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). 1473C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1474descriptors for which non-blocking operation makes no sense (such as
1475files) - libev doesn't guarantee any specific behaviour in that case.
1338 1476
1339Another thing you have to watch out for is that it is quite easy to 1477Another thing you have to watch out for is that it is quite easy to
1340receive "spurious" readiness notifications, that is your callback might 1478receive "spurious" readiness notifications, that is your callback might
1341be called with C<EV_READ> but a subsequent C<read>(2) will actually block 1479be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1342because there is no data. Not only are some backends known to create a 1480because there is no data. Not only are some backends known to create a
1407 1545
1408So when you encounter spurious, unexplained daemon exits, make sure you 1546So when you encounter spurious, unexplained daemon exits, make sure you
1409ignore SIGPIPE (and maybe make sure you log the exit status of your daemon 1547ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1410somewhere, as that would have given you a big clue). 1548somewhere, as that would have given you a big clue).
1411 1549
1550=head3 The special problem of accept()ing when you can't
1551
1552Many implementations of the POSIX C<accept> function (for example,
1553found in post-2004 Linux) have the peculiar behaviour of not removing a
1554connection from the pending queue in all error cases.
1555
1556For example, larger servers often run out of file descriptors (because
1557of resource limits), causing C<accept> to fail with C<ENFILE> but not
1558rejecting the connection, leading to libev signalling readiness on
1559the next iteration again (the connection still exists after all), and
1560typically causing the program to loop at 100% CPU usage.
1561
1562Unfortunately, the set of errors that cause this issue differs between
1563operating systems, there is usually little the app can do to remedy the
1564situation, and no known thread-safe method of removing the connection to
1565cope with overload is known (to me).
1566
1567One of the easiest ways to handle this situation is to just ignore it
1568- when the program encounters an overload, it will just loop until the
1569situation is over. While this is a form of busy waiting, no OS offers an
1570event-based way to handle this situation, so it's the best one can do.
1571
1572A better way to handle the situation is to log any errors other than
1573C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
1574messages, and continue as usual, which at least gives the user an idea of
1575what could be wrong ("raise the ulimit!"). For extra points one could stop
1576the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
1577usage.
1578
1579If your program is single-threaded, then you could also keep a dummy file
1580descriptor for overload situations (e.g. by opening F</dev/null>), and
1581when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
1582close that fd, and create a new dummy fd. This will gracefully refuse
1583clients under typical overload conditions.
1584
1585The last way to handle it is to simply log the error and C<exit>, as
1586is often done with C<malloc> failures, but this results in an easy
1587opportunity for a DoS attack.
1412 1588
1413=head3 Watcher-Specific Functions 1589=head3 Watcher-Specific Functions
1414 1590
1415=over 4 1591=over 4
1416 1592
1463year, it will still time out after (roughly) one hour. "Roughly" because 1639year, it will still time out after (roughly) one hour. "Roughly" because
1464detecting time jumps is hard, and some inaccuracies are unavoidable (the 1640detecting time jumps is hard, and some inaccuracies are unavoidable (the
1465monotonic clock option helps a lot here). 1641monotonic clock option helps a lot here).
1466 1642
1467The callback is guaranteed to be invoked only I<after> its timeout has 1643The callback is guaranteed to be invoked only I<after> its timeout has
1468passed. If multiple timers become ready during the same loop iteration 1644passed (not I<at>, so on systems with very low-resolution clocks this
1469then the ones with earlier time-out values are invoked before ones with 1645might introduce a small delay). If multiple timers become ready during the
1470later time-out values (but this is no longer true when a callback calls 1646same loop iteration then the ones with earlier time-out values are invoked
1471C<ev_loop> recursively). 1647before ones of the same priority with later time-out values (but this is
1648no longer true when a callback calls C<ev_loop> recursively).
1472 1649
1473=head3 Be smart about timeouts 1650=head3 Be smart about timeouts
1474 1651
1475Many real-world problems involve some kind of timeout, usually for error 1652Many real-world problems involve some kind of timeout, usually for error
1476recovery. A typical example is an HTTP request - if the other side hangs, 1653recovery. A typical example is an HTTP request - if the other side hangs,
1520C<after> argument to C<ev_timer_set>, and only ever use the C<repeat> 1697C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1521member and C<ev_timer_again>. 1698member and C<ev_timer_again>.
1522 1699
1523At start: 1700At start:
1524 1701
1525 ev_timer_init (timer, callback); 1702 ev_init (timer, callback);
1526 timer->repeat = 60.; 1703 timer->repeat = 60.;
1527 ev_timer_again (loop, timer); 1704 ev_timer_again (loop, timer);
1528 1705
1529Each time there is some activity: 1706Each time there is some activity:
1530 1707
1562 ev_tstamp timeout = last_activity + 60.; 1739 ev_tstamp timeout = last_activity + 60.;
1563 1740
1564 // if last_activity + 60. is older than now, we did time out 1741 // if last_activity + 60. is older than now, we did time out
1565 if (timeout < now) 1742 if (timeout < now)
1566 { 1743 {
1567 // timeout occured, take action 1744 // timeout occurred, take action
1568 } 1745 }
1569 else 1746 else
1570 { 1747 {
1571 // callback was invoked, but there was some activity, re-arm 1748 // callback was invoked, but there was some activity, re-arm
1572 // the watcher to fire in last_activity + 60, which is 1749 // the watcher to fire in last_activity + 60, which is
1592 1769
1593To start the timer, simply initialise the watcher and set C<last_activity> 1770To start the timer, simply initialise the watcher and set C<last_activity>
1594to the current time (meaning we just have some activity :), then call the 1771to the current time (meaning we just have some activity :), then call the
1595callback, which will "do the right thing" and start the timer: 1772callback, which will "do the right thing" and start the timer:
1596 1773
1597 ev_timer_init (timer, callback); 1774 ev_init (timer, callback);
1598 last_activity = ev_now (loop); 1775 last_activity = ev_now (loop);
1599 callback (loop, timer, EV_TIMEOUT); 1776 callback (loop, timer, EV_TIMER);
1600 1777
1601And when there is some activity, simply store the current time in 1778And when there is some activity, simply store the current time in
1602C<last_activity>, no libev calls at all: 1779C<last_activity>, no libev calls at all:
1603 1780
1604 last_actiivty = ev_now (loop); 1781 last_activity = ev_now (loop);
1605 1782
1606This technique is slightly more complex, but in most cases where the 1783This technique is slightly more complex, but in most cases where the
1607time-out is unlikely to be triggered, much more efficient. 1784time-out is unlikely to be triggered, much more efficient.
1608 1785
1609Changing the timeout is trivial as well (if it isn't hard-coded in the 1786Changing the timeout is trivial as well (if it isn't hard-coded in the
1663 1840
1664If the event loop is suspended for a long time, you can also force an 1841If the event loop is suspended for a long time, you can also force an
1665update of the time returned by C<ev_now ()> by calling C<ev_now_update 1842update of the time returned by C<ev_now ()> by calling C<ev_now_update
1666()>. 1843()>.
1667 1844
1845=head3 The special problems of suspended animation
1846
1847When you leave the server world it is quite customary to hit machines that
1848can suspend/hibernate - what happens to the clocks during such a suspend?
1849
1850Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1851all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1852to run until the system is suspended, but they will not advance while the
1853system is suspended. That means, on resume, it will be as if the program
1854was frozen for a few seconds, but the suspend time will not be counted
1855towards C<ev_timer> when a monotonic clock source is used. The real time
1856clock advanced as expected, but if it is used as sole clocksource, then a
1857long suspend would be detected as a time jump by libev, and timers would
1858be adjusted accordingly.
1859
1860I would not be surprised to see different behaviour in different between
1861operating systems, OS versions or even different hardware.
1862
1863The other form of suspend (job control, or sending a SIGSTOP) will see a
1864time jump in the monotonic clocks and the realtime clock. If the program
1865is suspended for a very long time, and monotonic clock sources are in use,
1866then you can expect C<ev_timer>s to expire as the full suspension time
1867will be counted towards the timers. When no monotonic clock source is in
1868use, then libev will again assume a timejump and adjust accordingly.
1869
1870It might be beneficial for this latter case to call C<ev_suspend>
1871and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1872deterministic behaviour in this case (you can do nothing against
1873C<SIGSTOP>).
1874
1668=head3 Watcher-Specific Functions and Data Members 1875=head3 Watcher-Specific Functions and Data Members
1669 1876
1670=over 4 1877=over 4
1671 1878
1672=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1879=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1697If the timer is repeating, either start it if necessary (with the 1904If the timer is repeating, either start it if necessary (with the
1698C<repeat> value), or reset the running timer to the C<repeat> value. 1905C<repeat> value), or reset the running timer to the C<repeat> value.
1699 1906
1700This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 1907This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1701usage example. 1908usage example.
1909
1910=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1911
1912Returns the remaining time until a timer fires. If the timer is active,
1913then this time is relative to the current event loop time, otherwise it's
1914the timeout value currently configured.
1915
1916That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1917C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1918will return C<4>. When the timer expires and is restarted, it will return
1919roughly C<7> (likely slightly less as callback invocation takes some time,
1920too), and so on.
1702 1921
1703=item ev_tstamp repeat [read-write] 1922=item ev_tstamp repeat [read-write]
1704 1923
1705The current C<repeat> value. Will be used each time the watcher times out 1924The current C<repeat> value. Will be used each time the watcher times out
1706or C<ev_timer_again> is called, and determines the next timeout (if any), 1925or C<ev_timer_again> is called, and determines the next timeout (if any),
1906Example: Call a callback every hour, or, more precisely, whenever the 2125Example: Call a callback every hour, or, more precisely, whenever the
1907system time is divisible by 3600. The callback invocation times have 2126system time is divisible by 3600. The callback invocation times have
1908potentially a lot of jitter, but good long-term stability. 2127potentially a lot of jitter, but good long-term stability.
1909 2128
1910 static void 2129 static void
1911 clock_cb (struct ev_loop *loop, ev_io *w, int revents) 2130 clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
1912 { 2131 {
1913 ... its now a full hour (UTC, or TAI or whatever your clock follows) 2132 ... its now a full hour (UTC, or TAI or whatever your clock follows)
1914 } 2133 }
1915 2134
1916 ev_periodic hourly_tick; 2135 ev_periodic hourly_tick;
1942Signal watchers will trigger an event when the process receives a specific 2161Signal watchers will trigger an event when the process receives a specific
1943signal one or more times. Even though signals are very asynchronous, libev 2162signal one or more times. Even though signals are very asynchronous, libev
1944will try it's best to deliver signals synchronously, i.e. as part of the 2163will try it's best to deliver signals synchronously, i.e. as part of the
1945normal event processing, like any other event. 2164normal event processing, like any other event.
1946 2165
1947If you want signals asynchronously, just use C<sigaction> as you would 2166If you want signals to be delivered truly asynchronously, just use
1948do without libev and forget about sharing the signal. You can even use 2167C<sigaction> as you would do without libev and forget about sharing
1949C<ev_async> from a signal handler to synchronously wake up an event loop. 2168the signal. You can even use C<ev_async> from a signal handler to
2169synchronously wake up an event loop.
1950 2170
1951You can configure as many watchers as you like per signal. Only when the 2171You can configure as many watchers as you like for the same signal, but
2172only within the same loop, i.e. you can watch for C<SIGINT> in your
2173default loop and for C<SIGIO> in another loop, but you cannot watch for
2174C<SIGINT> in both the default loop and another loop at the same time. At
2175the moment, C<SIGCHLD> is permanently tied to the default loop.
2176
1952first watcher gets started will libev actually register a signal handler 2177When the first watcher gets started will libev actually register something
1953with the kernel (thus it coexists with your own signal handlers as long as 2178with the kernel (thus it coexists with your own signal handlers as long as
1954you don't register any with libev for the same signal). Similarly, when 2179you don't register any with libev for the same signal).
1955the last signal watcher for a signal is stopped, libev will reset the
1956signal handler to SIG_DFL (regardless of what it was set to before).
1957 2180
1958If possible and supported, libev will install its handlers with 2181If possible and supported, libev will install its handlers with
1959C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2182C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1960interrupted. If you have a problem with system calls getting interrupted by 2183not be unduly interrupted. If you have a problem with system calls getting
1961signals you can block all signals in an C<ev_check> watcher and unblock 2184interrupted by signals you can block all signals in an C<ev_check> watcher
1962them in an C<ev_prepare> watcher. 2185and unblock them in an C<ev_prepare> watcher.
2186
2187=head3 The special problem of inheritance over fork/execve/pthread_create
2188
2189Both the signal mask (C<sigprocmask>) and the signal disposition
2190(C<sigaction>) are unspecified after starting a signal watcher (and after
2191stopping it again), that is, libev might or might not block the signal,
2192and might or might not set or restore the installed signal handler.
2193
2194While this does not matter for the signal disposition (libev never
2195sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2196C<execve>), this matters for the signal mask: many programs do not expect
2197certain signals to be blocked.
2198
2199This means that before calling C<exec> (from the child) you should reset
2200the signal mask to whatever "default" you expect (all clear is a good
2201choice usually).
2202
2203The simplest way to ensure that the signal mask is reset in the child is
2204to install a fork handler with C<pthread_atfork> that resets it. That will
2205catch fork calls done by libraries (such as the libc) as well.
2206
2207In current versions of libev, the signal will not be blocked indefinitely
2208unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
2209the window of opportunity for problems, it will not go away, as libev
2210I<has> to modify the signal mask, at least temporarily.
2211
2212So I can't stress this enough: I<If you do not reset your signal mask when
2213you expect it to be empty, you have a race condition in your code>. This
2214is not a libev-specific thing, this is true for most event libraries.
1963 2215
1964=head3 Watcher-Specific Functions and Data Members 2216=head3 Watcher-Specific Functions and Data Members
1965 2217
1966=over 4 2218=over 4
1967 2219
1999some child status changes (most typically when a child of yours dies or 2251some child status changes (most typically when a child of yours dies or
2000exits). It is permissible to install a child watcher I<after> the child 2252exits). It is permissible to install a child watcher I<after> the child
2001has been forked (which implies it might have already exited), as long 2253has been forked (which implies it might have already exited), as long
2002as the event loop isn't entered (or is continued from a watcher), i.e., 2254as the event loop isn't entered (or is continued from a watcher), i.e.,
2003forking and then immediately registering a watcher for the child is fine, 2255forking and then immediately registering a watcher for the child is fine,
2004but forking and registering a watcher a few event loop iterations later is 2256but forking and registering a watcher a few event loop iterations later or
2005not. 2257in the next callback invocation is not.
2006 2258
2007Only the default event loop is capable of handling signals, and therefore 2259Only the default event loop is capable of handling signals, and therefore
2008you can only register child watchers in the default event loop. 2260you can only register child watchers in the default event loop.
2009 2261
2262Due to some design glitches inside libev, child watchers will always be
2263handled at maximum priority (their priority is set to C<EV_MAXPRI> by
2264libev)
2265
2010=head3 Process Interaction 2266=head3 Process Interaction
2011 2267
2012Libev grabs C<SIGCHLD> as soon as the default event loop is 2268Libev grabs C<SIGCHLD> as soon as the default event loop is
2013initialised. This is necessary to guarantee proper behaviour even if 2269initialised. This is necessary to guarantee proper behaviour even if the
2014the first child watcher is started after the child exits. The occurrence 2270first child watcher is started after the child exits. The occurrence
2015of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2271of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2016synchronously as part of the event loop processing. Libev always reaps all 2272synchronously as part of the event loop processing. Libev always reaps all
2017children, even ones not watched. 2273children, even ones not watched.
2018 2274
2019=head3 Overriding the Built-In Processing 2275=head3 Overriding the Built-In Processing
2029=head3 Stopping the Child Watcher 2285=head3 Stopping the Child Watcher
2030 2286
2031Currently, the child watcher never gets stopped, even when the 2287Currently, the child watcher never gets stopped, even when the
2032child terminates, so normally one needs to stop the watcher in the 2288child terminates, so normally one needs to stop the watcher in the
2033callback. Future versions of libev might stop the watcher automatically 2289callback. Future versions of libev might stop the watcher automatically
2034when a child exit is detected. 2290when a child exit is detected (calling C<ev_child_stop> twice is not a
2291problem).
2035 2292
2036=head3 Watcher-Specific Functions and Data Members 2293=head3 Watcher-Specific Functions and Data Members
2037 2294
2038=over 4 2295=over 4
2039 2296
2365 // no longer anything immediate to do. 2622 // no longer anything immediate to do.
2366 } 2623 }
2367 2624
2368 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2625 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2369 ev_idle_init (idle_watcher, idle_cb); 2626 ev_idle_init (idle_watcher, idle_cb);
2370 ev_idle_start (loop, idle_cb); 2627 ev_idle_start (loop, idle_watcher);
2371 2628
2372 2629
2373=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2630=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2374 2631
2375Prepare and check watchers are usually (but not always) used in pairs: 2632Prepare and check watchers are usually (but not always) used in pairs:
2468 struct pollfd fds [nfd]; 2725 struct pollfd fds [nfd];
2469 // actual code will need to loop here and realloc etc. 2726 // actual code will need to loop here and realloc etc.
2470 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ())); 2727 adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
2471 2728
2472 /* the callback is illegal, but won't be called as we stop during check */ 2729 /* the callback is illegal, but won't be called as we stop during check */
2473 ev_timer_init (&tw, 0, timeout * 1e-3); 2730 ev_timer_init (&tw, 0, timeout * 1e-3, 0.);
2474 ev_timer_start (loop, &tw); 2731 ev_timer_start (loop, &tw);
2475 2732
2476 // create one ev_io per pollfd 2733 // create one ev_io per pollfd
2477 for (int i = 0; i < nfd; ++i) 2734 for (int i = 0; i < nfd; ++i)
2478 { 2735 {
2708event loop blocks next and before C<ev_check> watchers are being called, 2965event loop blocks next and before C<ev_check> watchers are being called,
2709and only in the child after the fork. If whoever good citizen calling 2966and only in the child after the fork. If whoever good citizen calling
2710C<ev_default_fork> cheats and calls it in the wrong process, the fork 2967C<ev_default_fork> cheats and calls it in the wrong process, the fork
2711handlers will be invoked, too, of course. 2968handlers will be invoked, too, of course.
2712 2969
2970=head3 The special problem of life after fork - how is it possible?
2971
2972Most uses of C<fork()> consist of forking, then some simple calls to set
2973up/change the process environment, followed by a call to C<exec()>. This
2974sequence should be handled by libev without any problems.
2975
2976This changes when the application actually wants to do event handling
2977in the child, or both parent in child, in effect "continuing" after the
2978fork.
2979
2980The default mode of operation (for libev, with application help to detect
2981forks) is to duplicate all the state in the child, as would be expected
2982when I<either> the parent I<or> the child process continues.
2983
2984When both processes want to continue using libev, then this is usually the
2985wrong result. In that case, usually one process (typically the parent) is
2986supposed to continue with all watchers in place as before, while the other
2987process typically wants to start fresh, i.e. without any active watchers.
2988
2989The cleanest and most efficient way to achieve that with libev is to
2990simply create a new event loop, which of course will be "empty", and
2991use that for new watchers. This has the advantage of not touching more
2992memory than necessary, and thus avoiding the copy-on-write, and the
2993disadvantage of having to use multiple event loops (which do not support
2994signal watchers).
2995
2996When this is not possible, or you want to use the default loop for
2997other reasons, then in the process that wants to start "fresh", call
2998C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying
2999the default loop will "orphan" (not stop) all registered watchers, so you
3000have to be careful not to execute code that modifies those watchers. Note
3001also that in that case, you have to re-register any signal watchers.
3002
2713=head3 Watcher-Specific Functions and Data Members 3003=head3 Watcher-Specific Functions and Data Members
2714 3004
2715=over 4 3005=over 4
2716 3006
2717=item ev_fork_init (ev_signal *, callback) 3007=item ev_fork_init (ev_signal *, callback)
2721believe me. 3011believe me.
2722 3012
2723=back 3013=back
2724 3014
2725 3015
2726=head2 C<ev_async> - how to wake up another event loop 3016=head2 C<ev_async> - how to wake up an event loop
2727 3017
2728In general, you cannot use an C<ev_loop> from multiple threads or other 3018In general, you cannot use an C<ev_loop> from multiple threads or other
2729asynchronous sources such as signal handlers (as opposed to multiple event 3019asynchronous sources such as signal handlers (as opposed to multiple event
2730loops - those are of course safe to use in different threads). 3020loops - those are of course safe to use in different threads).
2731 3021
2732Sometimes, however, you need to wake up another event loop you do not 3022Sometimes, however, you need to wake up an event loop you do not control,
2733control, for example because it belongs to another thread. This is what 3023for example because it belongs to another thread. This is what C<ev_async>
2734C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you 3024watchers do: as long as the C<ev_async> watcher is active, you can signal
2735can signal it by calling C<ev_async_send>, which is thread- and signal 3025it by calling C<ev_async_send>, which is thread- and signal safe.
2736safe.
2737 3026
2738This functionality is very similar to C<ev_signal> watchers, as signals, 3027This functionality is very similar to C<ev_signal> watchers, as signals,
2739too, are asynchronous in nature, and signals, too, will be compressed 3028too, are asynchronous in nature, and signals, too, will be compressed
2740(i.e. the number of callback invocations may be less than the number of 3029(i.e. the number of callback invocations may be less than the number of
2741C<ev_async_sent> calls). 3030C<ev_async_sent> calls).
2746=head3 Queueing 3035=head3 Queueing
2747 3036
2748C<ev_async> does not support queueing of data in any way. The reason 3037C<ev_async> does not support queueing of data in any way. The reason
2749is that the author does not know of a simple (or any) algorithm for a 3038is that the author does not know of a simple (or any) algorithm for a
2750multiple-writer-single-reader queue that works in all cases and doesn't 3039multiple-writer-single-reader queue that works in all cases and doesn't
2751need elaborate support such as pthreads. 3040need elaborate support such as pthreads or unportable memory access
3041semantics.
2752 3042
2753That means that if you want to queue data, you have to provide your own 3043That means that if you want to queue data, you have to provide your own
2754queue. But at least I can tell you how to implement locking around your 3044queue. But at least I can tell you how to implement locking around your
2755queue: 3045queue:
2756 3046
2895 3185
2896If C<timeout> is less than 0, then no timeout watcher will be 3186If C<timeout> is less than 0, then no timeout watcher will be
2897started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and 3187started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2898repeat = 0) will be started. C<0> is a valid timeout. 3188repeat = 0) will be started. C<0> is a valid timeout.
2899 3189
2900The callback has the type C<void (*cb)(int revents, void *arg)> and gets 3190The callback has the type C<void (*cb)(int revents, void *arg)> and is
2901passed an C<revents> set like normal event callbacks (a combination of 3191passed an C<revents> set like normal event callbacks (a combination of
2902C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> 3192C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
2903value passed to C<ev_once>. Note that it is possible to receive I<both> 3193value passed to C<ev_once>. Note that it is possible to receive I<both>
2904a timeout and an io event at the same time - you probably should give io 3194a timeout and an io event at the same time - you probably should give io
2905events precedence. 3195events precedence.
2906 3196
2907Example: wait up to ten seconds for data to appear on STDIN_FILENO. 3197Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2908 3198
2909 static void stdin_ready (int revents, void *arg) 3199 static void stdin_ready (int revents, void *arg)
2910 { 3200 {
2911 if (revents & EV_READ) 3201 if (revents & EV_READ)
2912 /* stdin might have data for us, joy! */; 3202 /* stdin might have data for us, joy! */;
2913 else if (revents & EV_TIMEOUT) 3203 else if (revents & EV_TIMER)
2914 /* doh, nothing entered */; 3204 /* doh, nothing entered */;
2915 } 3205 }
2916 3206
2917 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3207 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2918 3208
2919=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2920
2921Feeds the given event set into the event loop, as if the specified event
2922had happened for the specified watcher (which must be a pointer to an
2923initialised but not necessarily started event watcher).
2924
2925=item ev_feed_fd_event (struct ev_loop *, int fd, int revents) 3209=item ev_feed_fd_event (loop, int fd, int revents)
2926 3210
2927Feed an event on the given fd, as if a file descriptor backend detected 3211Feed an event on the given fd, as if a file descriptor backend detected
2928the given events it. 3212the given events it.
2929 3213
2930=item ev_feed_signal_event (struct ev_loop *loop, int signum) 3214=item ev_feed_signal_event (loop, int signum)
2931 3215
2932Feed an event as if the given signal occurred (C<loop> must be the default 3216Feed an event as if the given signal occurred (C<loop> must be the default
2933loop!). 3217loop!).
2934 3218
2935=back 3219=back
3015 3299
3016=over 4 3300=over 4
3017 3301
3018=item ev::TYPE::TYPE () 3302=item ev::TYPE::TYPE ()
3019 3303
3020=item ev::TYPE::TYPE (struct ev_loop *) 3304=item ev::TYPE::TYPE (loop)
3021 3305
3022=item ev::TYPE::~TYPE 3306=item ev::TYPE::~TYPE
3023 3307
3024The constructor (optionally) takes an event loop to associate the watcher 3308The constructor (optionally) takes an event loop to associate the watcher
3025with. If it is omitted, it will use C<EV_DEFAULT>. 3309with. If it is omitted, it will use C<EV_DEFAULT>.
3058 myclass obj; 3342 myclass obj;
3059 ev::io iow; 3343 ev::io iow;
3060 iow.set <myclass, &myclass::io_cb> (&obj); 3344 iow.set <myclass, &myclass::io_cb> (&obj);
3061 3345
3062=item w->set (object *) 3346=item w->set (object *)
3063
3064This is an B<experimental> feature that might go away in a future version.
3065 3347
3066This is a variation of a method callback - leaving out the method to call 3348This is a variation of a method callback - leaving out the method to call
3067will default the method to C<operator ()>, which makes it possible to use 3349will default the method to C<operator ()>, which makes it possible to use
3068functor objects without having to manually specify the C<operator ()> all 3350functor objects without having to manually specify the C<operator ()> all
3069the time. Incidentally, you can then also leave out the template argument 3351the time. Incidentally, you can then also leave out the template argument
3102Example: Use a plain function as callback. 3384Example: Use a plain function as callback.
3103 3385
3104 static void io_cb (ev::io &w, int revents) { } 3386 static void io_cb (ev::io &w, int revents) { }
3105 iow.set <io_cb> (); 3387 iow.set <io_cb> ();
3106 3388
3107=item w->set (struct ev_loop *) 3389=item w->set (loop)
3108 3390
3109Associates a different C<struct ev_loop> with this watcher. You can only 3391Associates a different C<struct ev_loop> with this watcher. You can only
3110do this when the watcher is inactive (and not pending either). 3392do this when the watcher is inactive (and not pending either).
3111 3393
3112=item w->set ([arguments]) 3394=item w->set ([arguments])
3113 3395
3114Basically the same as C<ev_TYPE_set>, with the same arguments. Must be 3396Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3115called at least once. Unlike the C counterpart, an active watcher gets 3397method or a suitable start method must be called at least once. Unlike the
3116automatically stopped and restarted when reconfiguring it with this 3398C counterpart, an active watcher gets automatically stopped and restarted
3117method. 3399when reconfiguring it with this method.
3118 3400
3119=item w->start () 3401=item w->start ()
3120 3402
3121Starts the watcher. Note that there is no C<loop> argument, as the 3403Starts the watcher. Note that there is no C<loop> argument, as the
3122constructor already stores the event loop. 3404constructor already stores the event loop.
3123 3405
3406=item w->start ([arguments])
3407
3408Instead of calling C<set> and C<start> methods separately, it is often
3409convenient to wrap them in one call. Uses the same type of arguments as
3410the configure C<set> method of the watcher.
3411
3124=item w->stop () 3412=item w->stop ()
3125 3413
3126Stops the watcher if it is active. Again, no C<loop> argument. 3414Stops the watcher if it is active. Again, no C<loop> argument.
3127 3415
3128=item w->again () (C<ev::timer>, C<ev::periodic> only) 3416=item w->again () (C<ev::timer>, C<ev::periodic> only)
3140 3428
3141=back 3429=back
3142 3430
3143=back 3431=back
3144 3432
3145Example: Define a class with an IO and idle watcher, start one of them in 3433Example: Define a class with two I/O and idle watchers, start the I/O
3146the constructor. 3434watchers in the constructor.
3147 3435
3148 class myclass 3436 class myclass
3149 { 3437 {
3150 ev::io io ; void io_cb (ev::io &w, int revents); 3438 ev::io io ; void io_cb (ev::io &w, int revents);
3439 ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3151 ev::idle idle; void idle_cb (ev::idle &w, int revents); 3440 ev::idle idle; void idle_cb (ev::idle &w, int revents);
3152 3441
3153 myclass (int fd) 3442 myclass (int fd)
3154 { 3443 {
3155 io .set <myclass, &myclass::io_cb > (this); 3444 io .set <myclass, &myclass::io_cb > (this);
3445 io2 .set <myclass, &myclass::io2_cb > (this);
3156 idle.set <myclass, &myclass::idle_cb> (this); 3446 idle.set <myclass, &myclass::idle_cb> (this);
3157 3447
3158 io.start (fd, ev::READ); 3448 io.set (fd, ev::WRITE); // configure the watcher
3449 io.start (); // start it whenever convenient
3450
3451 io2.start (fd, ev::READ); // set + start in one call
3159 } 3452 }
3160 }; 3453 };
3161 3454
3162 3455
3163=head1 OTHER LANGUAGE BINDINGS 3456=head1 OTHER LANGUAGE BINDINGS
3209=item Ocaml 3502=item Ocaml
3210 3503
3211Erkki Seppala has written Ocaml bindings for libev, to be found at 3504Erkki Seppala has written Ocaml bindings for libev, to be found at
3212L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3505L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3213 3506
3507=item Lua
3508
3509Brian Maher has written a partial interface to libev for lua (at the
3510time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3511L<http://github.com/brimworks/lua-ev>.
3512
3214=back 3513=back
3215 3514
3216 3515
3217=head1 MACRO MAGIC 3516=head1 MACRO MAGIC
3218 3517
3371 libev.m4 3670 libev.m4
3372 3671
3373=head2 PREPROCESSOR SYMBOLS/MACROS 3672=head2 PREPROCESSOR SYMBOLS/MACROS
3374 3673
3375Libev can be configured via a variety of preprocessor symbols you have to 3674Libev can be configured via a variety of preprocessor symbols you have to
3376define before including any of its files. The default in the absence of 3675define before including (or compiling) any of its files. The default in
3377autoconf is documented for every option. 3676the absence of autoconf is documented for every option.
3677
3678Symbols marked with "(h)" do not change the ABI, and can have different
3679values when compiling libev vs. including F<ev.h>, so it is permissible
3680to redefine them before including F<ev.h> without breaking compatibility
3681to a compiled library. All other symbols change the ABI, which means all
3682users of libev and the libev code itself must be compiled with compatible
3683settings.
3378 3684
3379=over 4 3685=over 4
3380 3686
3381=item EV_STANDALONE 3687=item EV_STANDALONE (h)
3382 3688
3383Must always be C<1> if you do not use autoconf configuration, which 3689Must always be C<1> if you do not use autoconf configuration, which
3384keeps libev from including F<config.h>, and it also defines dummy 3690keeps libev from including F<config.h>, and it also defines dummy
3385implementations for some libevent functions (such as logging, which is not 3691implementations for some libevent functions (such as logging, which is not
3386supported). It will also not define any of the structs usually found in 3692supported). It will also not define any of the structs usually found in
3387F<event.h> that are not directly supported by the libev core alone. 3693F<event.h> that are not directly supported by the libev core alone.
3388 3694
3389In stanbdalone mode, libev will still try to automatically deduce the 3695In standalone mode, libev will still try to automatically deduce the
3390configuration, but has to be more conservative. 3696configuration, but has to be more conservative.
3391 3697
3392=item EV_USE_MONOTONIC 3698=item EV_USE_MONOTONIC
3393 3699
3394If defined to be C<1>, libev will try to detect the availability of the 3700If defined to be C<1>, libev will try to detect the availability of the
3459be used is the winsock select). This means that it will call 3765be used is the winsock select). This means that it will call
3460C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3766C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3461it is assumed that all these functions actually work on fds, even 3767it is assumed that all these functions actually work on fds, even
3462on win32. Should not be defined on non-win32 platforms. 3768on win32. Should not be defined on non-win32 platforms.
3463 3769
3464=item EV_FD_TO_WIN32_HANDLE 3770=item EV_FD_TO_WIN32_HANDLE(fd)
3465 3771
3466If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3772If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3467file descriptors to socket handles. When not defining this symbol (the 3773file descriptors to socket handles. When not defining this symbol (the
3468default), then libev will call C<_get_osfhandle>, which is usually 3774default), then libev will call C<_get_osfhandle>, which is usually
3469correct. In some cases, programs use their own file descriptor management, 3775correct. In some cases, programs use their own file descriptor management,
3470in which case they can provide this function to map fds to socket handles. 3776in which case they can provide this function to map fds to socket handles.
3777
3778=item EV_WIN32_HANDLE_TO_FD(handle)
3779
3780If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3781using the standard C<_open_osfhandle> function. For programs implementing
3782their own fd to handle mapping, overwriting this function makes it easier
3783to do so. This can be done by defining this macro to an appropriate value.
3784
3785=item EV_WIN32_CLOSE_FD(fd)
3786
3787If programs implement their own fd to handle mapping on win32, then this
3788macro can be used to override the C<close> function, useful to unregister
3789file descriptors again. Note that the replacement function has to close
3790the underlying OS handle.
3471 3791
3472=item EV_USE_POLL 3792=item EV_USE_POLL
3473 3793
3474If defined to be C<1>, libev will compile in support for the C<poll>(2) 3794If defined to be C<1>, libev will compile in support for the C<poll>(2)
3475backend. Otherwise it will be enabled on non-win32 platforms. It 3795backend. Otherwise it will be enabled on non-win32 platforms. It
3522as well as for signal and thread safety in C<ev_async> watchers. 3842as well as for signal and thread safety in C<ev_async> watchers.
3523 3843
3524In the absence of this define, libev will use C<sig_atomic_t volatile> 3844In the absence of this define, libev will use C<sig_atomic_t volatile>
3525(from F<signal.h>), which is usually good enough on most platforms. 3845(from F<signal.h>), which is usually good enough on most platforms.
3526 3846
3527=item EV_H 3847=item EV_H (h)
3528 3848
3529The name of the F<ev.h> header file used to include it. The default if 3849The name of the F<ev.h> header file used to include it. The default if
3530undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 3850undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3531used to virtually rename the F<ev.h> header file in case of conflicts. 3851used to virtually rename the F<ev.h> header file in case of conflicts.
3532 3852
3533=item EV_CONFIG_H 3853=item EV_CONFIG_H (h)
3534 3854
3535If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 3855If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3536F<ev.c>'s idea of where to find the F<config.h> file, similarly to 3856F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3537C<EV_H>, above. 3857C<EV_H>, above.
3538 3858
3539=item EV_EVENT_H 3859=item EV_EVENT_H (h)
3540 3860
3541Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 3861Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3542of how the F<event.h> header can be found, the default is C<"event.h">. 3862of how the F<event.h> header can be found, the default is C<"event.h">.
3543 3863
3544=item EV_PROTOTYPES 3864=item EV_PROTOTYPES (h)
3545 3865
3546If defined to be C<0>, then F<ev.h> will not define any function 3866If defined to be C<0>, then F<ev.h> will not define any function
3547prototypes, but still define all the structs and other symbols. This is 3867prototypes, but still define all the structs and other symbols. This is
3548occasionally useful if you want to provide your own wrapper functions 3868occasionally useful if you want to provide your own wrapper functions
3549around libev functions. 3869around libev functions.
3571fine. 3891fine.
3572 3892
3573If your embedding application does not need any priorities, defining these 3893If your embedding application does not need any priorities, defining these
3574both to C<0> will save some memory and CPU. 3894both to C<0> will save some memory and CPU.
3575 3895
3576=item EV_PERIODIC_ENABLE 3896=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
3897EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3898EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3577 3899
3578If undefined or defined to be C<1>, then periodic timers are supported. If 3900If undefined or defined to be C<1> (and the platform supports it), then
3579defined to be C<0>, then they are not. Disabling them saves a few kB of 3901the respective watcher type is supported. If defined to be C<0>, then it
3580code. 3902is not. Disabling watcher types mainly saves code size.
3581 3903
3582=item EV_IDLE_ENABLE 3904=item EV_FEATURES
3583
3584If undefined or defined to be C<1>, then idle watchers are supported. If
3585defined to be C<0>, then they are not. Disabling them saves a few kB of
3586code.
3587
3588=item EV_EMBED_ENABLE
3589
3590If undefined or defined to be C<1>, then embed watchers are supported. If
3591defined to be C<0>, then they are not. Embed watchers rely on most other
3592watcher types, which therefore must not be disabled.
3593
3594=item EV_STAT_ENABLE
3595
3596If undefined or defined to be C<1>, then stat watchers are supported. If
3597defined to be C<0>, then they are not.
3598
3599=item EV_FORK_ENABLE
3600
3601If undefined or defined to be C<1>, then fork watchers are supported. If
3602defined to be C<0>, then they are not.
3603
3604=item EV_ASYNC_ENABLE
3605
3606If undefined or defined to be C<1>, then async watchers are supported. If
3607defined to be C<0>, then they are not.
3608
3609=item EV_MINIMAL
3610 3905
3611If you need to shave off some kilobytes of code at the expense of some 3906If you need to shave off some kilobytes of code at the expense of some
3612speed, define this symbol to C<1>. Currently this is used to override some 3907speed (but with the full API), you can define this symbol to request
3613inlining decisions, saves roughly 30% code size on amd64. It also selects a 3908certain subsets of functionality. The default is to enable all features
3614much smaller 2-heap for timer management over the default 4-heap. 3909that can be enabled on the platform.
3910
3911A typical way to use this symbol is to define it to C<0> (or to a bitset
3912with some broad features you want) and then selectively re-enable
3913additional parts you want, for example if you want everything minimal,
3914but multiple event loop support, async and child watchers and the poll
3915backend, use this:
3916
3917 #define EV_FEATURES 0
3918 #define EV_MULTIPLICITY 1
3919 #define EV_USE_POLL 1
3920 #define EV_CHILD_ENABLE 1
3921 #define EV_ASYNC_ENABLE 1
3922
3923The actual value is a bitset, it can be a combination of the following
3924values:
3925
3926=over 4
3927
3928=item C<1> - faster/larger code
3929
3930Use larger code to speed up some operations.
3931
3932Currently this is used to override some inlining decisions (enlarging the
3933code size by roughly 30% on amd64).
3934
3935When optimising for size, use of compiler flags such as C<-Os> with
3936gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
3937assertions.
3938
3939=item C<2> - faster/larger data structures
3940
3941Replaces the small 2-heap for timer management by a faster 4-heap, larger
3942hash table sizes and so on. This will usually further increase code size
3943and can additionally have an effect on the size of data structures at
3944runtime.
3945
3946=item C<4> - full API configuration
3947
3948This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3949enables multiplicity (C<EV_MULTIPLICITY>=1).
3950
3951=item C<8> - full API
3952
3953This enables a lot of the "lesser used" API functions. See C<ev.h> for
3954details on which parts of the API are still available without this
3955feature, and do not complain if this subset changes over time.
3956
3957=item C<16> - enable all optional watcher types
3958
3959Enables all optional watcher types. If you want to selectively enable
3960only some watcher types other than I/O and timers (e.g. prepare,
3961embed, async, child...) you can enable them manually by defining
3962C<EV_watchertype_ENABLE> to C<1> instead.
3963
3964=item C<32> - enable all backends
3965
3966This enables all backends - without this feature, you need to enable at
3967least one backend manually (C<EV_USE_SELECT> is a good choice).
3968
3969=item C<64> - enable OS-specific "helper" APIs
3970
3971Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
3972default.
3973
3974=back
3975
3976Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
3977reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
3978code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
3979watchers, timers and monotonic clock support.
3980
3981With an intelligent-enough linker (gcc+binutils are intelligent enough
3982when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3983your program might be left out as well - a binary starting a timer and an
3984I/O watcher then might come out at only 5Kb.
3985
3986=item EV_AVOID_STDIO
3987
3988If this is set to C<1> at compiletime, then libev will avoid using stdio
3989functions (printf, scanf, perror etc.). This will increase the code size
3990somewhat, but if your program doesn't otherwise depend on stdio and your
3991libc allows it, this avoids linking in the stdio library which is quite
3992big.
3993
3994Note that error messages might become less precise when this option is
3995enabled.
3996
3997=item EV_NSIG
3998
3999The highest supported signal number, +1 (or, the number of
4000signals): Normally, libev tries to deduce the maximum number of signals
4001automatically, but sometimes this fails, in which case it can be
4002specified. Also, using a lower number than detected (C<32> should be
4003good for about any system in existence) can save some memory, as libev
4004statically allocates some 12-24 bytes per signal number.
3615 4005
3616=item EV_PID_HASHSIZE 4006=item EV_PID_HASHSIZE
3617 4007
3618C<ev_child> watchers use a small hash table to distribute workload by 4008C<ev_child> watchers use a small hash table to distribute workload by
3619pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 4009pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3620than enough. If you need to manage thousands of children you might want to 4010usually more than enough. If you need to manage thousands of children you
3621increase this value (I<must> be a power of two). 4011might want to increase this value (I<must> be a power of two).
3622 4012
3623=item EV_INOTIFY_HASHSIZE 4013=item EV_INOTIFY_HASHSIZE
3624 4014
3625C<ev_stat> watchers use a small hash table to distribute workload by 4015C<ev_stat> watchers use a small hash table to distribute workload by
3626inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 4016inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3627usually more than enough. If you need to manage thousands of C<ev_stat> 4017disabled), usually more than enough. If you need to manage thousands of
3628watchers you might want to increase this value (I<must> be a power of 4018C<ev_stat> watchers you might want to increase this value (I<must> be a
3629two). 4019power of two).
3630 4020
3631=item EV_USE_4HEAP 4021=item EV_USE_4HEAP
3632 4022
3633Heaps are not very cache-efficient. To improve the cache-efficiency of the 4023Heaps are not very cache-efficient. To improve the cache-efficiency of the
3634timer and periodics heaps, libev uses a 4-heap when this symbol is defined 4024timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3635to C<1>. The 4-heap uses more complicated (longer) code but has noticeably 4025to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3636faster performance with many (thousands) of watchers. 4026faster performance with many (thousands) of watchers.
3637 4027
3638The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4028The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3639(disabled). 4029will be C<0>.
3640 4030
3641=item EV_HEAP_CACHE_AT 4031=item EV_HEAP_CACHE_AT
3642 4032
3643Heaps are not very cache-efficient. To improve the cache-efficiency of the 4033Heaps are not very cache-efficient. To improve the cache-efficiency of the
3644timer and periodics heaps, libev can cache the timestamp (I<at>) within 4034timer and periodics heaps, libev can cache the timestamp (I<at>) within
3645the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), 4035the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3646which uses 8-12 bytes more per watcher and a few hundred bytes more code, 4036which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3647but avoids random read accesses on heap changes. This improves performance 4037but avoids random read accesses on heap changes. This improves performance
3648noticeably with many (hundreds) of watchers. 4038noticeably with many (hundreds) of watchers.
3649 4039
3650The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4040The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3651(disabled). 4041will be C<0>.
3652 4042
3653=item EV_VERIFY 4043=item EV_VERIFY
3654 4044
3655Controls how much internal verification (see C<ev_loop_verify ()>) will 4045Controls how much internal verification (see C<ev_loop_verify ()>) will
3656be done: If set to C<0>, no internal verification code will be compiled 4046be done: If set to C<0>, no internal verification code will be compiled
3658called. If set to C<2>, then the internal verification code will be 4048called. If set to C<2>, then the internal verification code will be
3659called once per loop, which can slow down libev. If set to C<3>, then the 4049called once per loop, which can slow down libev. If set to C<3>, then the
3660verification code will be called very frequently, which will slow down 4050verification code will be called very frequently, which will slow down
3661libev considerably. 4051libev considerably.
3662 4052
3663The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be 4053The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3664C<0>. 4054will be C<0>.
3665 4055
3666=item EV_COMMON 4056=item EV_COMMON
3667 4057
3668By default, all watchers have a C<void *data> member. By redefining 4058By default, all watchers have a C<void *data> member. By redefining
3669this macro to a something else you can include more and other types of 4059this macro to something else you can include more and other types of
3670members. You have to define it each time you include one of the files, 4060members. You have to define it each time you include one of the files,
3671though, and it must be identical each time. 4061though, and it must be identical each time.
3672 4062
3673For example, the perl EV module uses something like this: 4063For example, the perl EV module uses something like this:
3674 4064
3727file. 4117file.
3728 4118
3729The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 4119The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3730that everybody includes and which overrides some configure choices: 4120that everybody includes and which overrides some configure choices:
3731 4121
3732 #define EV_MINIMAL 1 4122 #define EV_FEATURES 8
3733 #define EV_USE_POLL 0 4123 #define EV_USE_SELECT 1
3734 #define EV_MULTIPLICITY 0
3735 #define EV_PERIODIC_ENABLE 0 4124 #define EV_PREPARE_ENABLE 1
4125 #define EV_IDLE_ENABLE 1
3736 #define EV_STAT_ENABLE 0 4126 #define EV_SIGNAL_ENABLE 1
3737 #define EV_FORK_ENABLE 0 4127 #define EV_CHILD_ENABLE 1
4128 #define EV_USE_STDEXCEPT 0
3738 #define EV_CONFIG_H <config.h> 4129 #define EV_CONFIG_H <config.h>
3739 #define EV_MINPRI 0
3740 #define EV_MAXPRI 0
3741 4130
3742 #include "ev++.h" 4131 #include "ev++.h"
3743 4132
3744And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 4133And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3745 4134
3805default loop and triggering an C<ev_async> watcher from the default loop 4194default loop and triggering an C<ev_async> watcher from the default loop
3806watcher callback into the event loop interested in the signal. 4195watcher callback into the event loop interested in the signal.
3807 4196
3808=back 4197=back
3809 4198
4199=head4 THREAD LOCKING EXAMPLE
4200
4201Here is a fictitious example of how to run an event loop in a different
4202thread than where callbacks are being invoked and watchers are
4203created/added/removed.
4204
4205For a real-world example, see the C<EV::Loop::Async> perl module,
4206which uses exactly this technique (which is suited for many high-level
4207languages).
4208
4209The example uses a pthread mutex to protect the loop data, a condition
4210variable to wait for callback invocations, an async watcher to notify the
4211event loop thread and an unspecified mechanism to wake up the main thread.
4212
4213First, you need to associate some data with the event loop:
4214
4215 typedef struct {
4216 mutex_t lock; /* global loop lock */
4217 ev_async async_w;
4218 thread_t tid;
4219 cond_t invoke_cv;
4220 } userdata;
4221
4222 void prepare_loop (EV_P)
4223 {
4224 // for simplicity, we use a static userdata struct.
4225 static userdata u;
4226
4227 ev_async_init (&u->async_w, async_cb);
4228 ev_async_start (EV_A_ &u->async_w);
4229
4230 pthread_mutex_init (&u->lock, 0);
4231 pthread_cond_init (&u->invoke_cv, 0);
4232
4233 // now associate this with the loop
4234 ev_set_userdata (EV_A_ u);
4235 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4236 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4237
4238 // then create the thread running ev_loop
4239 pthread_create (&u->tid, 0, l_run, EV_A);
4240 }
4241
4242The callback for the C<ev_async> watcher does nothing: the watcher is used
4243solely to wake up the event loop so it takes notice of any new watchers
4244that might have been added:
4245
4246 static void
4247 async_cb (EV_P_ ev_async *w, int revents)
4248 {
4249 // just used for the side effects
4250 }
4251
4252The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4253protecting the loop data, respectively.
4254
4255 static void
4256 l_release (EV_P)
4257 {
4258 userdata *u = ev_userdata (EV_A);
4259 pthread_mutex_unlock (&u->lock);
4260 }
4261
4262 static void
4263 l_acquire (EV_P)
4264 {
4265 userdata *u = ev_userdata (EV_A);
4266 pthread_mutex_lock (&u->lock);
4267 }
4268
4269The event loop thread first acquires the mutex, and then jumps straight
4270into C<ev_loop>:
4271
4272 void *
4273 l_run (void *thr_arg)
4274 {
4275 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4276
4277 l_acquire (EV_A);
4278 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4279 ev_loop (EV_A_ 0);
4280 l_release (EV_A);
4281
4282 return 0;
4283 }
4284
4285Instead of invoking all pending watchers, the C<l_invoke> callback will
4286signal the main thread via some unspecified mechanism (signals? pipe
4287writes? C<Async::Interrupt>?) and then waits until all pending watchers
4288have been called (in a while loop because a) spurious wakeups are possible
4289and b) skipping inter-thread-communication when there are no pending
4290watchers is very beneficial):
4291
4292 static void
4293 l_invoke (EV_P)
4294 {
4295 userdata *u = ev_userdata (EV_A);
4296
4297 while (ev_pending_count (EV_A))
4298 {
4299 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4300 pthread_cond_wait (&u->invoke_cv, &u->lock);
4301 }
4302 }
4303
4304Now, whenever the main thread gets told to invoke pending watchers, it
4305will grab the lock, call C<ev_invoke_pending> and then signal the loop
4306thread to continue:
4307
4308 static void
4309 real_invoke_pending (EV_P)
4310 {
4311 userdata *u = ev_userdata (EV_A);
4312
4313 pthread_mutex_lock (&u->lock);
4314 ev_invoke_pending (EV_A);
4315 pthread_cond_signal (&u->invoke_cv);
4316 pthread_mutex_unlock (&u->lock);
4317 }
4318
4319Whenever you want to start/stop a watcher or do other modifications to an
4320event loop, you will now have to lock:
4321
4322 ev_timer timeout_watcher;
4323 userdata *u = ev_userdata (EV_A);
4324
4325 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4326
4327 pthread_mutex_lock (&u->lock);
4328 ev_timer_start (EV_A_ &timeout_watcher);
4329 ev_async_send (EV_A_ &u->async_w);
4330 pthread_mutex_unlock (&u->lock);
4331
4332Note that sending the C<ev_async> watcher is required because otherwise
4333an event loop currently blocking in the kernel will have no knowledge
4334about the newly added timer. By waking up the loop it will pick up any new
4335watchers in the next event loop iteration.
4336
3810=head3 COROUTINES 4337=head3 COROUTINES
3811 4338
3812Libev is very accommodating to coroutines ("cooperative threads"): 4339Libev is very accommodating to coroutines ("cooperative threads"):
3813libev fully supports nesting calls to its functions from different 4340libev fully supports nesting calls to its functions from different
3814coroutines (e.g. you can call C<ev_loop> on the same loop from two 4341coroutines (e.g. you can call C<ev_loop> on the same loop from two
3815different coroutines, and switch freely between both coroutines running the 4342different coroutines, and switch freely between both coroutines running
3816loop, as long as you don't confuse yourself). The only exception is that 4343the loop, as long as you don't confuse yourself). The only exception is
3817you must not do this from C<ev_periodic> reschedule callbacks. 4344that you must not do this from C<ev_periodic> reschedule callbacks.
3818 4345
3819Care has been taken to ensure that libev does not keep local state inside 4346Care has been taken to ensure that libev does not keep local state inside
3820C<ev_loop>, and other calls do not usually allow for coroutine switches as 4347C<ev_loop>, and other calls do not usually allow for coroutine switches as
3821they do not call any callbacks. 4348they do not call any callbacks.
3822 4349
3836maintainable. 4363maintainable.
3837 4364
3838And of course, some compiler warnings are just plain stupid, or simply 4365And of course, some compiler warnings are just plain stupid, or simply
3839wrong (because they don't actually warn about the condition their message 4366wrong (because they don't actually warn about the condition their message
3840seems to warn about). For example, certain older gcc versions had some 4367seems to warn about). For example, certain older gcc versions had some
3841warnings that resulted an extreme number of false positives. These have 4368warnings that resulted in an extreme number of false positives. These have
3842been fixed, but some people still insist on making code warn-free with 4369been fixed, but some people still insist on making code warn-free with
3843such buggy versions. 4370such buggy versions.
3844 4371
3845While libev is written to generate as few warnings as possible, 4372While libev is written to generate as few warnings as possible,
3846"warn-free" code is not a goal, and it is recommended not to build libev 4373"warn-free" code is not a goal, and it is recommended not to build libev
3882I suggest using suppression lists. 4409I suggest using suppression lists.
3883 4410
3884 4411
3885=head1 PORTABILITY NOTES 4412=head1 PORTABILITY NOTES
3886 4413
4414=head2 GNU/LINUX 32 BIT LIMITATIONS
4415
4416GNU/Linux is the only common platform that supports 64 bit file/large file
4417interfaces but I<disables> them by default.
4418
4419That means that libev compiled in the default environment doesn't support
4420files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
4421
4422Unfortunately, many programs try to work around this GNU/Linux issue
4423by enabling the large file API, which makes them incompatible with the
4424standard libev compiled for their system.
4425
4426Likewise, libev cannot enable the large file API itself as this would
4427suddenly make it incompatible to the default compile time environment,
4428i.e. all programs not using special compile switches.
4429
4430=head2 OS/X AND DARWIN BUGS
4431
4432The whole thing is a bug if you ask me - basically any system interface
4433you touch is broken, whether it is locales, poll, kqueue or even the
4434OpenGL drivers.
4435
4436=head3 C<kqueue> is buggy
4437
4438The kqueue syscall is broken in all known versions - most versions support
4439only sockets, many support pipes.
4440
4441Libev tries to work around this by not using C<kqueue> by default on
4442this rotten platform, but of course you can still ask for it when creating
4443a loop.
4444
4445=head3 C<poll> is buggy
4446
4447Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4448implementation by something calling C<kqueue> internally around the 10.5.6
4449release, so now C<kqueue> I<and> C<poll> are broken.
4450
4451Libev tries to work around this by not using C<poll> by default on
4452this rotten platform, but of course you can still ask for it when creating
4453a loop.
4454
4455=head3 C<select> is buggy
4456
4457All that's left is C<select>, and of course Apple found a way to fuck this
4458one up as well: On OS/X, C<select> actively limits the number of file
4459descriptors you can pass in to 1024 - your program suddenly crashes when
4460you use more.
4461
4462There is an undocumented "workaround" for this - defining
4463C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
4464work on OS/X.
4465
4466=head2 SOLARIS PROBLEMS AND WORKAROUNDS
4467
4468=head3 C<errno> reentrancy
4469
4470The default compile environment on Solaris is unfortunately so
4471thread-unsafe that you can't even use components/libraries compiled
4472without C<-D_REENTRANT> (as long as they use C<errno>), which, of course,
4473isn't defined by default.
4474
4475If you want to use libev in threaded environments you have to make sure
4476it's compiled with C<_REENTRANT> defined.
4477
4478=head3 Event port backend
4479
4480The scalable event interface for Solaris is called "event ports". Unfortunately,
4481this mechanism is very buggy. If you run into high CPU usage, your program
4482freezes or you get a large number of spurious wakeups, make sure you have
4483all the relevant and latest kernel patches applied. No, I don't know which
4484ones, but there are multiple ones.
4485
4486If you can't get it to work, you can try running the program by setting
4487the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4488C<select> backends.
4489
4490=head2 AIX POLL BUG
4491
4492AIX unfortunately has a broken C<poll.h> header. Libev works around
4493this by trying to avoid the poll backend altogether (i.e. it's not even
4494compiled in), which normally isn't a big problem as C<select> works fine
4495with large bitsets, and AIX is dead anyway.
4496
3887=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS 4497=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4498
4499=head3 General issues
3888 4500
3889Win32 doesn't support any of the standards (e.g. POSIX) that libev 4501Win32 doesn't support any of the standards (e.g. POSIX) that libev
3890requires, and its I/O model is fundamentally incompatible with the POSIX 4502requires, and its I/O model is fundamentally incompatible with the POSIX
3891model. Libev still offers limited functionality on this platform in 4503model. Libev still offers limited functionality on this platform in
3892the form of the C<EVBACKEND_SELECT> backend, and only supports socket 4504the form of the C<EVBACKEND_SELECT> backend, and only supports socket
3893descriptors. This only applies when using Win32 natively, not when using 4505descriptors. This only applies when using Win32 natively, not when using
3894e.g. cygwin. 4506e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4507as every compielr comes with a slightly differently broken/incompatible
4508environment.
3895 4509
3896Lifting these limitations would basically require the full 4510Lifting these limitations would basically require the full
3897re-implementation of the I/O system. If you are into these kinds of 4511re-implementation of the I/O system. If you are into this kind of thing,
3898things, then note that glib does exactly that for you in a very portable 4512then note that glib does exactly that for you in a very portable way (note
3899way (note also that glib is the slowest event library known to man). 4513also that glib is the slowest event library known to man).
3900 4514
3901There is no supported compilation method available on windows except 4515There is no supported compilation method available on windows except
3902embedding it into other applications. 4516embedding it into other applications.
4517
4518Sensible signal handling is officially unsupported by Microsoft - libev
4519tries its best, but under most conditions, signals will simply not work.
3903 4520
3904Not a libev limitation but worth mentioning: windows apparently doesn't 4521Not a libev limitation but worth mentioning: windows apparently doesn't
3905accept large writes: instead of resulting in a partial write, windows will 4522accept large writes: instead of resulting in a partial write, windows will
3906either accept everything or return C<ENOBUFS> if the buffer is too large, 4523either accept everything or return C<ENOBUFS> if the buffer is too large,
3907so make sure you only write small amounts into your sockets (less than a 4524so make sure you only write small amounts into your sockets (less than a
3912the abysmal performance of winsockets, using a large number of sockets 4529the abysmal performance of winsockets, using a large number of sockets
3913is not recommended (and not reasonable). If your program needs to use 4530is not recommended (and not reasonable). If your program needs to use
3914more than a hundred or so sockets, then likely it needs to use a totally 4531more than a hundred or so sockets, then likely it needs to use a totally
3915different implementation for windows, as libev offers the POSIX readiness 4532different implementation for windows, as libev offers the POSIX readiness
3916notification model, which cannot be implemented efficiently on windows 4533notification model, which cannot be implemented efficiently on windows
3917(Microsoft monopoly games). 4534(due to Microsoft monopoly games).
3918 4535
3919A typical way to use libev under windows is to embed it (see the embedding 4536A typical way to use libev under windows is to embed it (see the embedding
3920section for details) and use the following F<evwrap.h> header file instead 4537section for details) and use the following F<evwrap.h> header file instead
3921of F<ev.h>: 4538of F<ev.h>:
3922 4539
3929you do I<not> compile the F<ev.c> or any other embedded source files!): 4546you do I<not> compile the F<ev.c> or any other embedded source files!):
3930 4547
3931 #include "evwrap.h" 4548 #include "evwrap.h"
3932 #include "ev.c" 4549 #include "ev.c"
3933 4550
3934=over 4
3935
3936=item The winsocket select function 4551=head3 The winsocket C<select> function
3937 4552
3938The winsocket C<select> function doesn't follow POSIX in that it 4553The winsocket C<select> function doesn't follow POSIX in that it
3939requires socket I<handles> and not socket I<file descriptors> (it is 4554requires socket I<handles> and not socket I<file descriptors> (it is
3940also extremely buggy). This makes select very inefficient, and also 4555also extremely buggy). This makes select very inefficient, and also
3941requires a mapping from file descriptors to socket handles (the Microsoft 4556requires a mapping from file descriptors to socket handles (the Microsoft
3950 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ 4565 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3951 4566
3952Note that winsockets handling of fd sets is O(n), so you can easily get a 4567Note that winsockets handling of fd sets is O(n), so you can easily get a
3953complexity in the O(n²) range when using win32. 4568complexity in the O(n²) range when using win32.
3954 4569
3955=item Limited number of file descriptors 4570=head3 Limited number of file descriptors
3956 4571
3957Windows has numerous arbitrary (and low) limits on things. 4572Windows has numerous arbitrary (and low) limits on things.
3958 4573
3959Early versions of winsocket's select only supported waiting for a maximum 4574Early versions of winsocket's select only supported waiting for a maximum
3960of C<64> handles (probably owning to the fact that all windows kernels 4575of C<64> handles (probably owning to the fact that all windows kernels
3961can only wait for C<64> things at the same time internally; Microsoft 4576can only wait for C<64> things at the same time internally; Microsoft
3962recommends spawning a chain of threads and wait for 63 handles and the 4577recommends spawning a chain of threads and wait for 63 handles and the
3963previous thread in each. Great). 4578previous thread in each. Sounds great!).
3964 4579
3965Newer versions support more handles, but you need to define C<FD_SETSIZE> 4580Newer versions support more handles, but you need to define C<FD_SETSIZE>
3966to some high number (e.g. C<2048>) before compiling the winsocket select 4581to some high number (e.g. C<2048>) before compiling the winsocket select
3967call (which might be in libev or elsewhere, for example, perl does its own 4582call (which might be in libev or elsewhere, for example, perl and many
3968select emulation on windows). 4583other interpreters do their own select emulation on windows).
3969 4584
3970Another limit is the number of file descriptors in the Microsoft runtime 4585Another limit is the number of file descriptors in the Microsoft runtime
3971libraries, which by default is C<64> (there must be a hidden I<64> fetish 4586libraries, which by default is C<64> (there must be a hidden I<64>
3972or something like this inside Microsoft). You can increase this by calling 4587fetish or something like this inside Microsoft). You can increase this
3973C<_setmaxstdio>, which can increase this limit to C<2048> (another 4588by calling C<_setmaxstdio>, which can increase this limit to C<2048>
3974arbitrary limit), but is broken in many versions of the Microsoft runtime 4589(another arbitrary limit), but is broken in many versions of the Microsoft
3975libraries.
3976
3977This might get you to about C<512> or C<2048> sockets (depending on 4590runtime libraries. This might get you to about C<512> or C<2048> sockets
3978windows version and/or the phase of the moon). To get more, you need to 4591(depending on windows version and/or the phase of the moon). To get more,
3979wrap all I/O functions and provide your own fd management, but the cost of 4592you need to wrap all I/O functions and provide your own fd management, but
3980calling select (O(n²)) will likely make this unworkable. 4593the cost of calling select (O(n²)) will likely make this unworkable.
3981
3982=back
3983 4594
3984=head2 PORTABILITY REQUIREMENTS 4595=head2 PORTABILITY REQUIREMENTS
3985 4596
3986In addition to a working ISO-C implementation and of course the 4597In addition to a working ISO-C implementation and of course the
3987backend-specific APIs, libev relies on a few additional extensions: 4598backend-specific APIs, libev relies on a few additional extensions:
4028=item C<double> must hold a time value in seconds with enough accuracy 4639=item C<double> must hold a time value in seconds with enough accuracy
4029 4640
4030The type C<double> is used to represent timestamps. It is required to 4641The type C<double> is used to represent timestamps. It is required to
4031have at least 51 bits of mantissa (and 9 bits of exponent), which is good 4642have at least 51 bits of mantissa (and 9 bits of exponent), which is good
4032enough for at least into the year 4000. This requirement is fulfilled by 4643enough for at least into the year 4000. This requirement is fulfilled by
4033implementations implementing IEEE 754 (basically all existing ones). 4644implementations implementing IEEE 754, which is basically all existing
4645ones. With IEEE 754 doubles, you get microsecond accuracy until at least
46462200.
4034 4647
4035=back 4648=back
4036 4649
4037If you know of other additional requirements drop me a note. 4650If you know of other additional requirements drop me a note.
4038 4651
4106involves iterating over all running async watchers or all signal numbers. 4719involves iterating over all running async watchers or all signal numbers.
4107 4720
4108=back 4721=back
4109 4722
4110 4723
4724=head1 PORTING FROM LIBEV 3.X TO 4.X
4725
4726The major version 4 introduced some minor incompatible changes to the API.
4727
4728At the moment, the C<ev.h> header file tries to implement superficial
4729compatibility, so most programs should still compile. Those might be
4730removed in later versions of libev, so better update early than late.
4731
4732=over 4
4733
4734=item C<ev_loop_count> renamed to C<ev_iteration>
4735
4736=item C<ev_loop_depth> renamed to C<ev_depth>
4737
4738=item C<ev_loop_verify> renamed to C<ev_verify>
4739
4740Most functions working on C<struct ev_loop> objects don't have an
4741C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is
4742still called C<ev_loop_fork> because it would otherwise clash with the
4743C<ev_fork> typedef.
4744
4745=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>
4746
4747This is a simple rename - all other watcher types use their name
4748as revents flag, and now C<ev_timer> does, too.
4749
4750Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions
4751and continue to be present for the foreseeable future, so this is mostly a
4752documentation change.
4753
4754=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4755
4756The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4757mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4758and work, but the library code will of course be larger.
4759
4760=back
4761
4762
4111=head1 GLOSSARY 4763=head1 GLOSSARY
4112 4764
4113=over 4 4765=over 4
4114 4766
4115=item active 4767=item active
4136A change of state of some external event, such as data now being available 4788A change of state of some external event, such as data now being available
4137for reading on a file descriptor, time having passed or simply not having 4789for reading on a file descriptor, time having passed or simply not having
4138any other events happening anymore. 4790any other events happening anymore.
4139 4791
4140In libev, events are represented as single bits (such as C<EV_READ> or 4792In libev, events are represented as single bits (such as C<EV_READ> or
4141C<EV_TIMEOUT>). 4793C<EV_TIMER>).
4142 4794
4143=item event library 4795=item event library
4144 4796
4145A software package implementing an event model and loop. 4797A software package implementing an event model and loop.
4146 4798

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines