1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | AnyEvent - provide framework for multiple event loops |
3 | AnyEvent - provide framework for multiple event loops |
4 | |
4 | |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops |
5 | EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported |
|
|
6 | event loops. |
6 | |
7 | |
7 | =head1 SYNOPSIS |
8 | =head1 SYNOPSIS |
8 | |
9 | |
9 | use AnyEvent; |
10 | use AnyEvent; |
10 | |
11 | |
|
|
12 | # file descriptor readable |
11 | my $w = AnyEvent->io (fh => $fh, poll => "r|w", cb => sub { ... }); |
13 | my $w = AnyEvent->io (fh => $fh, poll => "r", cb => sub { ... }); |
12 | |
14 | |
|
|
15 | # one-shot or repeating timers |
13 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
16 | my $w = AnyEvent->timer (after => $seconds, cb => sub { ... }); |
14 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
17 | my $w = AnyEvent->timer (after => $seconds, interval => $seconds, cb => ... |
15 | |
18 | |
16 | print AnyEvent->now; # prints current event loop time |
19 | print AnyEvent->now; # prints current event loop time |
17 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
20 | print AnyEvent->time; # think Time::HiRes::time or simply CORE::time. |
18 | |
21 | |
|
|
22 | # POSIX signal |
19 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
23 | my $w = AnyEvent->signal (signal => "TERM", cb => sub { ... }); |
20 | |
24 | |
|
|
25 | # child process exit |
21 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
26 | my $w = AnyEvent->child (pid => $pid, cb => sub { |
22 | my ($pid, $status) = @_; |
27 | my ($pid, $status) = @_; |
23 | ... |
28 | ... |
24 | }); |
29 | }); |
|
|
30 | |
|
|
31 | # called when event loop idle (if applicable) |
|
|
32 | my $w = AnyEvent->idle (cb => sub { ... }); |
25 | |
33 | |
26 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
34 | my $w = AnyEvent->condvar; # stores whether a condition was flagged |
27 | $w->send; # wake up current and all future recv's |
35 | $w->send; # wake up current and all future recv's |
28 | $w->recv; # enters "main loop" till $condvar gets ->send |
36 | $w->recv; # enters "main loop" till $condvar gets ->send |
29 | # use a condvar in callback mode: |
37 | # use a condvar in callback mode: |
… | |
… | |
168 | =head2 I/O WATCHERS |
176 | =head2 I/O WATCHERS |
169 | |
177 | |
170 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
178 | You can create an I/O watcher by calling the C<< AnyEvent->io >> method |
171 | with the following mandatory key-value pairs as arguments: |
179 | with the following mandatory key-value pairs as arguments: |
172 | |
180 | |
173 | C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events |
181 | C<fh> is the Perl I<file handle> (I<not> file descriptor, see below) to |
174 | (AnyEvent might or might not keep a reference to this file handle). C<poll> |
182 | watch for events (AnyEvent might or might not keep a reference to this |
|
|
183 | file handle). Note that only file handles pointing to things for which |
|
|
184 | non-blocking operation makes sense are allowed. This includes sockets, |
|
|
185 | most character devices, pipes, fifos and so on, but not for example files |
|
|
186 | or block devices. |
|
|
187 | |
175 | must be a string that is either C<r> or C<w>, which creates a watcher |
188 | C<poll> must be a string that is either C<r> or C<w>, which creates a |
176 | waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the |
189 | watcher waiting for "r"eadable or "w"ritable events, respectively. |
|
|
190 | |
177 | callback to invoke each time the file handle becomes ready. |
191 | C<cb> is the callback to invoke each time the file handle becomes ready. |
178 | |
192 | |
179 | Although the callback might get passed parameters, their value and |
193 | Although the callback might get passed parameters, their value and |
180 | presence is undefined and you cannot rely on them. Portable AnyEvent |
194 | presence is undefined and you cannot rely on them. Portable AnyEvent |
181 | callbacks cannot use arguments passed to I/O watcher callbacks. |
195 | callbacks cannot use arguments passed to I/O watcher callbacks. |
182 | |
196 | |
… | |
… | |
195 | chomp (my $input = <STDIN>); |
209 | chomp (my $input = <STDIN>); |
196 | warn "read: $input\n"; |
210 | warn "read: $input\n"; |
197 | undef $w; |
211 | undef $w; |
198 | }); |
212 | }); |
199 | |
213 | |
|
|
214 | =head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR |
|
|
215 | |
|
|
216 | It is not uncommon to only have a file descriptor, while AnyEvent requires |
|
|
217 | a Perl file handle. |
|
|
218 | |
|
|
219 | There are basically two methods to convert a file descriptor into a file handle. If you own |
|
|
220 | the file descriptor, you can open it with C<&=>, as in: |
|
|
221 | |
|
|
222 | open my $fh, "<&=$fileno" or die "xxx: ยง!"; |
|
|
223 | |
|
|
224 | This will "own" the file descriptor, meaning that when C<$fh> is |
|
|
225 | destroyed, it will automatically close the C<$fileno>. Also, note that |
|
|
226 | the open mode (read, write, read/write) must correspond with how the |
|
|
227 | underlying file descriptor was opened. |
|
|
228 | |
|
|
229 | In many cases, taking over the file descriptor is now what you want, in |
|
|
230 | which case the only alternative is to dup the file descriptor: |
|
|
231 | |
|
|
232 | open my $fh, "<&$fileno" or die "xxx: $!"; |
|
|
233 | |
|
|
234 | This has the advantage of not closing the file descriptor and the |
|
|
235 | disadvantage of making a slow copy. |
|
|
236 | |
200 | =head2 TIME WATCHERS |
237 | =head2 TIME WATCHERS |
201 | |
238 | |
202 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
239 | You can create a time watcher by calling the C<< AnyEvent->timer >> |
203 | method with the following mandatory arguments: |
240 | method with the following mandatory arguments: |
204 | |
241 | |
… | |
… | |
314 | In either case, if you care (and in most cases, you don't), then you |
351 | In either case, if you care (and in most cases, you don't), then you |
315 | can get whatever behaviour you want with any event loop, by taking the |
352 | can get whatever behaviour you want with any event loop, by taking the |
316 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
353 | difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into |
317 | account. |
354 | account. |
318 | |
355 | |
|
|
356 | =item AnyEvent->now_update |
|
|
357 | |
|
|
358 | Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache |
|
|
359 | the current time for each loop iteration (see the discussion of L<< |
|
|
360 | AnyEvent->now >>, above). |
|
|
361 | |
|
|
362 | When a callback runs for a long time (or when the process sleeps), then |
|
|
363 | this "current" time will differ substantially from the real time, which |
|
|
364 | might affect timers and time-outs. |
|
|
365 | |
|
|
366 | When this is the case, you can call this method, which will update the |
|
|
367 | event loop's idea of "current time". |
|
|
368 | |
|
|
369 | Note that updating the time I<might> cause some events to be handled. |
|
|
370 | |
319 | =back |
371 | =back |
320 | |
372 | |
321 | =head2 SIGNAL WATCHERS |
373 | =head2 SIGNAL WATCHERS |
322 | |
374 | |
323 | You can watch for signals using a signal watcher, C<signal> is the signal |
375 | You can watch for signals using a signal watcher, C<signal> is the signal |
… | |
… | |
363 | |
415 | |
364 | There is a slight catch to child watchers, however: you usually start them |
416 | There is a slight catch to child watchers, however: you usually start them |
365 | I<after> the child process was created, and this means the process could |
417 | I<after> the child process was created, and this means the process could |
366 | have exited already (and no SIGCHLD will be sent anymore). |
418 | have exited already (and no SIGCHLD will be sent anymore). |
367 | |
419 | |
368 | Not all event models handle this correctly (POE doesn't), but even for |
420 | Not all event models handle this correctly (neither POE nor IO::Async do, |
|
|
421 | see their AnyEvent::Impl manpages for details), but even for event models |
369 | event models that I<do> handle this correctly, they usually need to be |
422 | that I<do> handle this correctly, they usually need to be loaded before |
370 | loaded before the process exits (i.e. before you fork in the first place). |
423 | the process exits (i.e. before you fork in the first place). AnyEvent's |
|
|
424 | pure perl event loop handles all cases correctly regardless of when you |
|
|
425 | start the watcher. |
371 | |
426 | |
372 | This means you cannot create a child watcher as the very first thing in an |
427 | This means you cannot create a child watcher as the very first |
373 | AnyEvent program, you I<have> to create at least one watcher before you |
428 | thing in an AnyEvent program, you I<have> to create at least one |
374 | C<fork> the child (alternatively, you can call C<AnyEvent::detect>). |
429 | watcher before you C<fork> the child (alternatively, you can call |
|
|
430 | C<AnyEvent::detect>). |
375 | |
431 | |
376 | Example: fork a process and wait for it |
432 | Example: fork a process and wait for it |
377 | |
433 | |
378 | my $done = AnyEvent->condvar; |
434 | my $done = AnyEvent->condvar; |
379 | |
435 | |
… | |
… | |
389 | ); |
445 | ); |
390 | |
446 | |
391 | # do something else, then wait for process exit |
447 | # do something else, then wait for process exit |
392 | $done->recv; |
448 | $done->recv; |
393 | |
449 | |
|
|
450 | =head2 IDLE WATCHERS |
|
|
451 | |
|
|
452 | Sometimes there is a need to do something, but it is not so important |
|
|
453 | to do it instantly, but only when there is nothing better to do. This |
|
|
454 | "nothing better to do" is usually defined to be "no other events need |
|
|
455 | attention by the event loop". |
|
|
456 | |
|
|
457 | Idle watchers ideally get invoked when the event loop has nothing |
|
|
458 | better to do, just before it would block the process to wait for new |
|
|
459 | events. Instead of blocking, the idle watcher is invoked. |
|
|
460 | |
|
|
461 | Most event loops unfortunately do not really support idle watchers (only |
|
|
462 | EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent |
|
|
463 | will simply call the callback "from time to time". |
|
|
464 | |
|
|
465 | Example: read lines from STDIN, but only process them when the |
|
|
466 | program is otherwise idle: |
|
|
467 | |
|
|
468 | my @lines; # read data |
|
|
469 | my $idle_w; |
|
|
470 | my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub { |
|
|
471 | push @lines, scalar <STDIN>; |
|
|
472 | |
|
|
473 | # start an idle watcher, if not already done |
|
|
474 | $idle_w ||= AnyEvent->idle (cb => sub { |
|
|
475 | # handle only one line, when there are lines left |
|
|
476 | if (my $line = shift @lines) { |
|
|
477 | print "handled when idle: $line"; |
|
|
478 | } else { |
|
|
479 | # otherwise disable the idle watcher again |
|
|
480 | undef $idle_w; |
|
|
481 | } |
|
|
482 | }); |
|
|
483 | }); |
|
|
484 | |
394 | =head2 CONDITION VARIABLES |
485 | =head2 CONDITION VARIABLES |
395 | |
486 | |
396 | If you are familiar with some event loops you will know that all of them |
487 | If you are familiar with some event loops you will know that all of them |
397 | require you to run some blocking "loop", "run" or similar function that |
488 | require you to run some blocking "loop", "run" or similar function that |
398 | will actively watch for new events and call your callbacks. |
489 | will actively watch for new events and call your callbacks. |
… | |
… | |
531 | |
622 | |
532 | =item $cv->begin ([group callback]) |
623 | =item $cv->begin ([group callback]) |
533 | |
624 | |
534 | =item $cv->end |
625 | =item $cv->end |
535 | |
626 | |
536 | These two methods are EXPERIMENTAL and MIGHT CHANGE. |
|
|
537 | |
|
|
538 | These two methods can be used to combine many transactions/events into |
627 | These two methods can be used to combine many transactions/events into |
539 | one. For example, a function that pings many hosts in parallel might want |
628 | one. For example, a function that pings many hosts in parallel might want |
540 | to use a condition variable for the whole process. |
629 | to use a condition variable for the whole process. |
541 | |
630 | |
542 | Every call to C<< ->begin >> will increment a counter, and every call to |
631 | Every call to C<< ->begin >> will increment a counter, and every call to |
543 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
632 | C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end |
544 | >>, the (last) callback passed to C<begin> will be executed. That callback |
633 | >>, the (last) callback passed to C<begin> will be executed. That callback |
545 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
634 | is I<supposed> to call C<< ->send >>, but that is not required. If no |
546 | callback was set, C<send> will be called without any arguments. |
635 | callback was set, C<send> will be called without any arguments. |
547 | |
636 | |
548 | Let's clarify this with the ping example: |
637 | You can think of C<< $cv->send >> giving you an OR condition (one call |
|
|
638 | sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND |
|
|
639 | condition (all C<begin> calls must be C<end>'ed before the condvar sends). |
|
|
640 | |
|
|
641 | Let's start with a simple example: you have two I/O watchers (for example, |
|
|
642 | STDOUT and STDERR for a program), and you want to wait for both streams to |
|
|
643 | close before activating a condvar: |
|
|
644 | |
|
|
645 | my $cv = AnyEvent->condvar; |
|
|
646 | |
|
|
647 | $cv->begin; # first watcher |
|
|
648 | my $w1 = AnyEvent->io (fh => $fh1, cb => sub { |
|
|
649 | defined sysread $fh1, my $buf, 4096 |
|
|
650 | or $cv->end; |
|
|
651 | }); |
|
|
652 | |
|
|
653 | $cv->begin; # second watcher |
|
|
654 | my $w2 = AnyEvent->io (fh => $fh2, cb => sub { |
|
|
655 | defined sysread $fh2, my $buf, 4096 |
|
|
656 | or $cv->end; |
|
|
657 | }); |
|
|
658 | |
|
|
659 | $cv->recv; |
|
|
660 | |
|
|
661 | This works because for every event source (EOF on file handle), there is |
|
|
662 | one call to C<begin>, so the condvar waits for all calls to C<end> before |
|
|
663 | sending. |
|
|
664 | |
|
|
665 | The ping example mentioned above is slightly more complicated, as the |
|
|
666 | there are results to be passwd back, and the number of tasks that are |
|
|
667 | begung can potentially be zero: |
549 | |
668 | |
550 | my $cv = AnyEvent->condvar; |
669 | my $cv = AnyEvent->condvar; |
551 | |
670 | |
552 | my %result; |
671 | my %result; |
553 | $cv->begin (sub { $cv->send (\%result) }); |
672 | $cv->begin (sub { $cv->send (\%result) }); |
… | |
… | |
573 | loop, which serves two important purposes: first, it sets the callback |
692 | loop, which serves two important purposes: first, it sets the callback |
574 | to be called once the counter reaches C<0>, and second, it ensures that |
693 | to be called once the counter reaches C<0>, and second, it ensures that |
575 | C<send> is called even when C<no> hosts are being pinged (the loop |
694 | C<send> is called even when C<no> hosts are being pinged (the loop |
576 | doesn't execute once). |
695 | doesn't execute once). |
577 | |
696 | |
578 | This is the general pattern when you "fan out" into multiple subrequests: |
697 | This is the general pattern when you "fan out" into multiple (but |
579 | use an outer C<begin>/C<end> pair to set the callback and ensure C<end> |
698 | potentially none) subrequests: use an outer C<begin>/C<end> pair to set |
580 | is called at least once, and then, for each subrequest you start, call |
699 | the callback and ensure C<end> is called at least once, and then, for each |
581 | C<begin> and for each subrequest you finish, call C<end>. |
700 | subrequest you start, call C<begin> and for each subrequest you finish, |
|
|
701 | call C<end>. |
582 | |
702 | |
583 | =back |
703 | =back |
584 | |
704 | |
585 | =head3 METHODS FOR CONSUMERS |
705 | =head3 METHODS FOR CONSUMERS |
586 | |
706 | |
… | |
… | |
666 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
786 | AnyEvent::Impl::Tk based on Tk, very bad choice. |
667 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
787 | AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). |
668 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
788 | AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. |
669 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
789 | AnyEvent::Impl::POE based on POE, not generic enough for full support. |
670 | |
790 | |
|
|
791 | # warning, support for IO::Async is only partial, as it is too broken |
|
|
792 | # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async. |
|
|
793 | AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs). |
|
|
794 | |
671 | There is no support for WxWidgets, as WxWidgets has no support for |
795 | There is no support for WxWidgets, as WxWidgets has no support for |
672 | watching file handles. However, you can use WxWidgets through the |
796 | watching file handles. However, you can use WxWidgets through the |
673 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
797 | POE Adaptor, as POE has a Wx backend that simply polls 20 times per |
674 | second, which was considered to be too horrible to even consider for |
798 | second, which was considered to be too horrible to even consider for |
675 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
799 | AnyEvent. Likewise, other POE backends can be used by AnyEvent by using |
… | |
… | |
867 | no warnings; |
991 | no warnings; |
868 | use strict qw(vars subs); |
992 | use strict qw(vars subs); |
869 | |
993 | |
870 | use Carp; |
994 | use Carp; |
871 | |
995 | |
872 | our $VERSION = 4.341; |
996 | our $VERSION = 4.8; |
873 | our $MODEL; |
997 | our $MODEL; |
874 | |
998 | |
875 | our $AUTOLOAD; |
999 | our $AUTOLOAD; |
876 | our @ISA; |
1000 | our @ISA; |
877 | |
1001 | |
878 | our @REGISTRY; |
1002 | our @REGISTRY; |
879 | |
1003 | |
880 | our $WIN32; |
1004 | our $WIN32; |
881 | |
1005 | |
882 | BEGIN { |
1006 | BEGIN { |
883 | my $win32 = ! ! ($^O =~ /mswin32/i); |
1007 | eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }"; |
884 | eval "sub WIN32(){ $win32 }"; |
1008 | eval "sub TAINT(){ " . (${^TAINT}*1) . " }"; |
|
|
1009 | |
|
|
1010 | delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV} |
|
|
1011 | if ${^TAINT}; |
885 | } |
1012 | } |
886 | |
1013 | |
887 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
1014 | our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; |
888 | |
1015 | |
889 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
1016 | our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred |
… | |
… | |
907 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
1034 | [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy |
908 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
1035 | [Qt:: => AnyEvent::Impl::Qt::], # requires special main program |
909 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
1036 | [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza |
910 | [Wx:: => AnyEvent::Impl::POE::], |
1037 | [Wx:: => AnyEvent::Impl::POE::], |
911 | [Prima:: => AnyEvent::Impl::POE::], |
1038 | [Prima:: => AnyEvent::Impl::POE::], |
|
|
1039 | # IO::Async is just too broken - we would need workaorunds for its |
|
|
1040 | # byzantine signal and broken child handling, among others. |
|
|
1041 | # IO::Async is rather hard to detect, as it doesn't have any |
|
|
1042 | # obvious default class. |
|
|
1043 | # [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1044 | # [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program |
|
|
1045 | # [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program |
912 | ); |
1046 | ); |
913 | |
1047 | |
914 | our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); |
1048 | our %method = map +($_ => 1), |
|
|
1049 | qw(io timer time now now_update signal child idle condvar one_event DESTROY); |
915 | |
1050 | |
916 | our @post_detect; |
1051 | our @post_detect; |
917 | |
1052 | |
918 | sub post_detect(&) { |
1053 | sub post_detect(&) { |
919 | my ($cb) = @_; |
1054 | my ($cb) = @_; |
… | |
… | |
924 | 1 |
1059 | 1 |
925 | } else { |
1060 | } else { |
926 | push @post_detect, $cb; |
1061 | push @post_detect, $cb; |
927 | |
1062 | |
928 | defined wantarray |
1063 | defined wantarray |
929 | ? bless \$cb, "AnyEvent::Util::PostDetect" |
1064 | ? bless \$cb, "AnyEvent::Util::postdetect" |
930 | : () |
1065 | : () |
931 | } |
1066 | } |
932 | } |
1067 | } |
933 | |
1068 | |
934 | sub AnyEvent::Util::PostDetect::DESTROY { |
1069 | sub AnyEvent::Util::postdetect::DESTROY { |
935 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
1070 | @post_detect = grep $_ != ${$_[0]}, @post_detect; |
936 | } |
1071 | } |
937 | |
1072 | |
938 | sub detect() { |
1073 | sub detect() { |
939 | unless ($MODEL) { |
1074 | unless ($MODEL) { |
… | |
… | |
976 | last; |
1111 | last; |
977 | } |
1112 | } |
978 | } |
1113 | } |
979 | |
1114 | |
980 | $MODEL |
1115 | $MODEL |
981 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; |
1116 | or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n"; |
982 | } |
1117 | } |
983 | } |
1118 | } |
984 | |
1119 | |
985 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
1120 | push @{"$MODEL\::ISA"}, "AnyEvent::Base"; |
986 | |
1121 | |
… | |
… | |
1007 | } |
1142 | } |
1008 | |
1143 | |
1009 | # utility function to dup a filehandle. this is used by many backends |
1144 | # utility function to dup a filehandle. this is used by many backends |
1010 | # to support binding more than one watcher per filehandle (they usually |
1145 | # to support binding more than one watcher per filehandle (they usually |
1011 | # allow only one watcher per fd, so we dup it to get a different one). |
1146 | # allow only one watcher per fd, so we dup it to get a different one). |
1012 | sub _dupfh($$$$) { |
1147 | sub _dupfh($$;$$) { |
1013 | my ($poll, $fh, $r, $w) = @_; |
1148 | my ($poll, $fh, $r, $w) = @_; |
1014 | |
1149 | |
1015 | # cygwin requires the fh mode to be matching, unix doesn't |
1150 | # cygwin requires the fh mode to be matching, unix doesn't |
1016 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1151 | my ($rw, $mode) = $poll eq "r" ? ($r, "<") |
1017 | : $poll eq "w" ? ($w, ">") |
1152 | : $poll eq "w" ? ($w, ">") |
1018 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1153 | : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; |
1019 | |
1154 | |
1020 | open my $fh2, "$mode&" . fileno $fh |
1155 | open my $fh2, "$mode&" . fileno $fh |
1021 | or die "cannot dup() filehandle: $!"; |
1156 | or die "cannot dup() filehandle: $!,"; |
1022 | |
1157 | |
1023 | # we assume CLOEXEC is already set by perl in all important cases |
1158 | # we assume CLOEXEC is already set by perl in all important cases |
1024 | |
1159 | |
1025 | ($fh2, $rw) |
1160 | ($fh2, $rw) |
1026 | } |
1161 | } |
1027 | |
1162 | |
1028 | package AnyEvent::Base; |
1163 | package AnyEvent::Base; |
1029 | |
1164 | |
1030 | # default implementation for now and time |
1165 | # default implementations for many methods |
1031 | |
1166 | |
1032 | BEGIN { |
1167 | BEGIN { |
1033 | if (eval "use Time::HiRes (); time (); 1") { |
1168 | if (eval "use Time::HiRes (); Time::HiRes::time (); 1") { |
1034 | *_time = \&Time::HiRes::time; |
1169 | *_time = \&Time::HiRes::time; |
1035 | # if (eval "use POSIX (); (POSIX::times())... |
1170 | # if (eval "use POSIX (); (POSIX::times())... |
1036 | } else { |
1171 | } else { |
1037 | *_time = sub { time }; # epic fail |
1172 | *_time = sub { time }; # epic fail |
1038 | } |
1173 | } |
1039 | } |
1174 | } |
1040 | |
1175 | |
1041 | sub time { _time } |
1176 | sub time { _time } |
1042 | sub now { _time } |
1177 | sub now { _time } |
|
|
1178 | sub now_update { } |
1043 | |
1179 | |
1044 | # default implementation for ->condvar |
1180 | # default implementation for ->condvar |
1045 | |
1181 | |
1046 | sub condvar { |
1182 | sub condvar { |
1047 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: |
1183 | bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar" |
1048 | } |
1184 | } |
1049 | |
1185 | |
1050 | # default implementation for ->signal |
1186 | # default implementation for ->signal |
1051 | |
1187 | |
1052 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1188 | our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO); |
1053 | |
1189 | |
1054 | sub _signal_exec { |
1190 | sub _signal_exec { |
|
|
1191 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1192 | |
1055 | while (%SIG_EV) { |
1193 | while (%SIG_EV) { |
1056 | sysread $SIGPIPE_R, my $dummy, 4; |
|
|
1057 | for (keys %SIG_EV) { |
1194 | for (keys %SIG_EV) { |
1058 | delete $SIG_EV{$_}; |
1195 | delete $SIG_EV{$_}; |
1059 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1196 | $_->() for values %{ $SIG_CB{$_} || {} }; |
1060 | } |
1197 | } |
1061 | } |
1198 | } |
… | |
… | |
1063 | |
1200 | |
1064 | sub signal { |
1201 | sub signal { |
1065 | my (undef, %arg) = @_; |
1202 | my (undef, %arg) = @_; |
1066 | |
1203 | |
1067 | unless ($SIGPIPE_R) { |
1204 | unless ($SIGPIPE_R) { |
|
|
1205 | require Fcntl; |
|
|
1206 | |
1068 | if (AnyEvent::WIN32) { |
1207 | if (AnyEvent::WIN32) { |
|
|
1208 | require AnyEvent::Util; |
|
|
1209 | |
1069 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1210 | ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe (); |
1070 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
1211 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R; |
1071 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
1212 | AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case |
1072 | } else { |
1213 | } else { |
1073 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1214 | pipe $SIGPIPE_R, $SIGPIPE_W; |
1074 | require Fcntl; |
|
|
1075 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1215 | fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R; |
1076 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
1216 | fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case |
|
|
1217 | |
|
|
1218 | # not strictly required, as $^F is normally 2, but let's make sure... |
|
|
1219 | fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
|
|
1220 | fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC; |
1077 | } |
1221 | } |
1078 | |
1222 | |
1079 | $SIGPIPE_R |
1223 | $SIGPIPE_R |
1080 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1224 | or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; |
1081 | |
1225 | |
… | |
… | |
1085 | my $signal = uc $arg{signal} |
1229 | my $signal = uc $arg{signal} |
1086 | or Carp::croak "required option 'signal' is missing"; |
1230 | or Carp::croak "required option 'signal' is missing"; |
1087 | |
1231 | |
1088 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1232 | $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; |
1089 | $SIG{$signal} ||= sub { |
1233 | $SIG{$signal} ||= sub { |
|
|
1234 | local $!; |
1090 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1235 | syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; |
1091 | undef $SIG_EV{$signal}; |
1236 | undef $SIG_EV{$signal}; |
1092 | }; |
1237 | }; |
1093 | |
1238 | |
1094 | bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" |
1239 | bless [$signal, $arg{cb}], "AnyEvent::Base::signal" |
1095 | } |
1240 | } |
1096 | |
1241 | |
1097 | sub AnyEvent::Base::Signal::DESTROY { |
1242 | sub AnyEvent::Base::signal::DESTROY { |
1098 | my ($signal, $cb) = @{$_[0]}; |
1243 | my ($signal, $cb) = @{$_[0]}; |
1099 | |
1244 | |
1100 | delete $SIG_CB{$signal}{$cb}; |
1245 | delete $SIG_CB{$signal}{$cb}; |
1101 | |
1246 | |
|
|
1247 | # delete doesn't work with older perls - they then |
|
|
1248 | # print weird messages, or just unconditionally exit |
|
|
1249 | # instead of getting the default action. |
1102 | delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1250 | undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; |
1103 | } |
1251 | } |
1104 | |
1252 | |
1105 | # default implementation for ->child |
1253 | # default implementation for ->child |
1106 | |
1254 | |
1107 | our %PID_CB; |
1255 | our %PID_CB; |
1108 | our $CHLD_W; |
1256 | our $CHLD_W; |
1109 | our $CHLD_DELAY_W; |
1257 | our $CHLD_DELAY_W; |
1110 | our $PID_IDLE; |
|
|
1111 | our $WNOHANG; |
1258 | our $WNOHANG; |
1112 | |
1259 | |
1113 | sub _child_wait { |
1260 | sub _sigchld { |
1114 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1261 | while (0 < (my $pid = waitpid -1, $WNOHANG)) { |
1115 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1262 | $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), |
1116 | (values %{ $PID_CB{0} || {} }); |
1263 | (values %{ $PID_CB{0} || {} }); |
1117 | } |
1264 | } |
1118 | |
|
|
1119 | undef $PID_IDLE; |
|
|
1120 | } |
|
|
1121 | |
|
|
1122 | sub _sigchld { |
|
|
1123 | # make sure we deliver these changes "synchronous" with the event loop. |
|
|
1124 | $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub { |
|
|
1125 | undef $CHLD_DELAY_W; |
|
|
1126 | &_child_wait; |
|
|
1127 | }); |
|
|
1128 | } |
1265 | } |
1129 | |
1266 | |
1130 | sub child { |
1267 | sub child { |
1131 | my (undef, %arg) = @_; |
1268 | my (undef, %arg) = @_; |
1132 | |
1269 | |
1133 | defined (my $pid = $arg{pid} + 0) |
1270 | defined (my $pid = $arg{pid} + 0) |
1134 | or Carp::croak "required option 'pid' is missing"; |
1271 | or Carp::croak "required option 'pid' is missing"; |
1135 | |
1272 | |
1136 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1273 | $PID_CB{$pid}{$arg{cb}} = $arg{cb}; |
1137 | |
1274 | |
1138 | unless ($WNOHANG) { |
|
|
1139 | $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1275 | $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; |
1140 | } |
|
|
1141 | |
1276 | |
1142 | unless ($CHLD_W) { |
1277 | unless ($CHLD_W) { |
1143 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1278 | $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); |
1144 | # child could be a zombie already, so make at least one round |
1279 | # child could be a zombie already, so make at least one round |
1145 | &_sigchld; |
1280 | &_sigchld; |
1146 | } |
1281 | } |
1147 | |
1282 | |
1148 | bless [$pid, $arg{cb}], "AnyEvent::Base::Child" |
1283 | bless [$pid, $arg{cb}], "AnyEvent::Base::child" |
1149 | } |
1284 | } |
1150 | |
1285 | |
1151 | sub AnyEvent::Base::Child::DESTROY { |
1286 | sub AnyEvent::Base::child::DESTROY { |
1152 | my ($pid, $cb) = @{$_[0]}; |
1287 | my ($pid, $cb) = @{$_[0]}; |
1153 | |
1288 | |
1154 | delete $PID_CB{$pid}{$cb}; |
1289 | delete $PID_CB{$pid}{$cb}; |
1155 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1290 | delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; |
1156 | |
1291 | |
1157 | undef $CHLD_W unless keys %PID_CB; |
1292 | undef $CHLD_W unless keys %PID_CB; |
|
|
1293 | } |
|
|
1294 | |
|
|
1295 | # idle emulation is done by simply using a timer, regardless |
|
|
1296 | # of whether the process is idle or not, and not letting |
|
|
1297 | # the callback use more than 50% of the time. |
|
|
1298 | sub idle { |
|
|
1299 | my (undef, %arg) = @_; |
|
|
1300 | |
|
|
1301 | my ($cb, $w, $rcb) = $arg{cb}; |
|
|
1302 | |
|
|
1303 | $rcb = sub { |
|
|
1304 | if ($cb) { |
|
|
1305 | $w = _time; |
|
|
1306 | &$cb; |
|
|
1307 | $w = _time - $w; |
|
|
1308 | |
|
|
1309 | # never use more then 50% of the time for the idle watcher, |
|
|
1310 | # within some limits |
|
|
1311 | $w = 0.0001 if $w < 0.0001; |
|
|
1312 | $w = 5 if $w > 5; |
|
|
1313 | |
|
|
1314 | $w = AnyEvent->timer (after => $w, cb => $rcb); |
|
|
1315 | } else { |
|
|
1316 | # clean up... |
|
|
1317 | undef $w; |
|
|
1318 | undef $rcb; |
|
|
1319 | } |
|
|
1320 | }; |
|
|
1321 | |
|
|
1322 | $w = AnyEvent->timer (after => 0.05, cb => $rcb); |
|
|
1323 | |
|
|
1324 | bless \\$cb, "AnyEvent::Base::idle" |
|
|
1325 | } |
|
|
1326 | |
|
|
1327 | sub AnyEvent::Base::idle::DESTROY { |
|
|
1328 | undef $${$_[0]}; |
1158 | } |
1329 | } |
1159 | |
1330 | |
1160 | package AnyEvent::CondVar; |
1331 | package AnyEvent::CondVar; |
1161 | |
1332 | |
1162 | our @ISA = AnyEvent::CondVar::Base::; |
1333 | our @ISA = AnyEvent::CondVar::Base::; |
… | |
… | |
1236 | so on. |
1407 | so on. |
1237 | |
1408 | |
1238 | =head1 ENVIRONMENT VARIABLES |
1409 | =head1 ENVIRONMENT VARIABLES |
1239 | |
1410 | |
1240 | The following environment variables are used by this module or its |
1411 | The following environment variables are used by this module or its |
1241 | submodules: |
1412 | submodules. |
|
|
1413 | |
|
|
1414 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
1415 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
1416 | enabled. |
1242 | |
1417 | |
1243 | =over 4 |
1418 | =over 4 |
1244 | |
1419 | |
1245 | =item C<PERL_ANYEVENT_VERBOSE> |
1420 | =item C<PERL_ANYEVENT_VERBOSE> |
1246 | |
1421 | |
… | |
… | |
1258 | =item C<PERL_ANYEVENT_STRICT> |
1433 | =item C<PERL_ANYEVENT_STRICT> |
1259 | |
1434 | |
1260 | AnyEvent does not do much argument checking by default, as thorough |
1435 | AnyEvent does not do much argument checking by default, as thorough |
1261 | argument checking is very costly. Setting this variable to a true value |
1436 | argument checking is very costly. Setting this variable to a true value |
1262 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1437 | will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly |
1263 | check the arguments passed to most method calls. If it finds any problems |
1438 | check the arguments passed to most method calls. If it finds any problems, |
1264 | it will croak. |
1439 | it will croak. |
1265 | |
1440 | |
1266 | In other words, enables "strict" mode. |
1441 | In other words, enables "strict" mode. |
1267 | |
1442 | |
1268 | Unlike C<use strict>, it is definitely recommended ot keep it off in |
1443 | Unlike C<use strict>, it is definitely recommended to keep it off in |
1269 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1444 | production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while |
1270 | developing programs can be very useful, however. |
1445 | developing programs can be very useful, however. |
1271 | |
1446 | |
1272 | =item C<PERL_ANYEVENT_MODEL> |
1447 | =item C<PERL_ANYEVENT_MODEL> |
1273 | |
1448 | |
… | |
… | |
1318 | |
1493 | |
1319 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1494 | =item C<PERL_ANYEVENT_MAX_FORKS> |
1320 | |
1495 | |
1321 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1496 | The maximum number of child processes that C<AnyEvent::Util::fork_call> |
1322 | will create in parallel. |
1497 | will create in parallel. |
|
|
1498 | |
|
|
1499 | =item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS> |
|
|
1500 | |
|
|
1501 | The default value for the C<max_outstanding> parameter for the default DNS |
|
|
1502 | resolver - this is the maximum number of parallel DNS requests that are |
|
|
1503 | sent to the DNS server. |
|
|
1504 | |
|
|
1505 | =item C<PERL_ANYEVENT_RESOLV_CONF> |
|
|
1506 | |
|
|
1507 | The file to use instead of F</etc/resolv.conf> (or OS-specific |
|
|
1508 | configuration) in the default resolver. When set to the empty string, no |
|
|
1509 | default config will be used. |
|
|
1510 | |
|
|
1511 | =item C<PERL_ANYEVENT_CA_FILE>, C<PERL_ANYEVENT_CA_PATH>. |
|
|
1512 | |
|
|
1513 | When neither C<ca_file> nor C<ca_path> was specified during |
|
|
1514 | L<AnyEvent::TLS> context creation, and either of these environment |
|
|
1515 | variables exist, they will be used to specify CA certificate locations |
|
|
1516 | instead of a system-dependent default. |
1323 | |
1517 | |
1324 | =back |
1518 | =back |
1325 | |
1519 | |
1326 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1520 | =head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE |
1327 | |
1521 | |
… | |
… | |
1572 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1766 | EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers |
1573 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1767 | CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal |
1574 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1768 | Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation |
1575 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1769 | Event/Event 16000 517 32.20 31.80 0.81 Event native interface |
1576 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
1770 | Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers |
|
|
1771 | IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll |
|
|
1772 | IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll |
1577 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1773 | Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour |
1578 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1774 | Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers |
1579 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1775 | POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event |
1580 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1776 | POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select |
1581 | |
1777 | |
… | |
… | |
1610 | performance becomes really bad with lots of file descriptors (and few of |
1806 | performance becomes really bad with lots of file descriptors (and few of |
1611 | them active), of course, but this was not subject of this benchmark. |
1807 | them active), of course, but this was not subject of this benchmark. |
1612 | |
1808 | |
1613 | The C<Event> module has a relatively high setup and callback invocation |
1809 | The C<Event> module has a relatively high setup and callback invocation |
1614 | cost, but overall scores in on the third place. |
1810 | cost, but overall scores in on the third place. |
|
|
1811 | |
|
|
1812 | C<IO::Async> performs admirably well, about on par with C<Event>, even |
|
|
1813 | when using its pure perl backend. |
1615 | |
1814 | |
1616 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1815 | C<Glib>'s memory usage is quite a bit higher, but it features a |
1617 | faster callback invocation and overall ends up in the same class as |
1816 | faster callback invocation and overall ends up in the same class as |
1618 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1817 | C<Event>. However, Glib scales extremely badly, doubling the number of |
1619 | watchers increases the processing time by more than a factor of four, |
1818 | watchers increases the processing time by more than a factor of four, |
… | |
… | |
1697 | it to another server. This includes deleting the old timeout and creating |
1896 | it to another server. This includes deleting the old timeout and creating |
1698 | a new one that moves the timeout into the future. |
1897 | a new one that moves the timeout into the future. |
1699 | |
1898 | |
1700 | =head3 Results |
1899 | =head3 Results |
1701 | |
1900 | |
1702 | name sockets create request |
1901 | name sockets create request |
1703 | EV 20000 69.01 11.16 |
1902 | EV 20000 69.01 11.16 |
1704 | Perl 20000 73.32 35.87 |
1903 | Perl 20000 73.32 35.87 |
|
|
1904 | IOAsync 20000 157.00 98.14 epoll |
|
|
1905 | IOAsync 20000 159.31 616.06 poll |
1705 | Event 20000 212.62 257.32 |
1906 | Event 20000 212.62 257.32 |
1706 | Glib 20000 651.16 1896.30 |
1907 | Glib 20000 651.16 1896.30 |
1707 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1908 | POE 20000 349.67 12317.24 uses POE::Loop::Event |
1708 | |
1909 | |
1709 | =head3 Discussion |
1910 | =head3 Discussion |
1710 | |
1911 | |
1711 | This benchmark I<does> measure scalability and overall performance of the |
1912 | This benchmark I<does> measure scalability and overall performance of the |
1712 | particular event loop. |
1913 | particular event loop. |
… | |
… | |
1714 | EV is again fastest. Since it is using epoll on my system, the setup time |
1915 | EV is again fastest. Since it is using epoll on my system, the setup time |
1715 | is relatively high, though. |
1916 | is relatively high, though. |
1716 | |
1917 | |
1717 | Perl surprisingly comes second. It is much faster than the C-based event |
1918 | Perl surprisingly comes second. It is much faster than the C-based event |
1718 | loops Event and Glib. |
1919 | loops Event and Glib. |
|
|
1920 | |
|
|
1921 | IO::Async performs very well when using its epoll backend, and still quite |
|
|
1922 | good compared to Glib when using its pure perl backend. |
1719 | |
1923 | |
1720 | Event suffers from high setup time as well (look at its code and you will |
1924 | Event suffers from high setup time as well (look at its code and you will |
1721 | understand why). Callback invocation also has a high overhead compared to |
1925 | understand why). Callback invocation also has a high overhead compared to |
1722 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1926 | the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event |
1723 | uses select or poll in basically all documented configurations. |
1927 | uses select or poll in basically all documented configurations. |
… | |
… | |
1786 | =item * C-based event loops perform very well with small number of |
1990 | =item * C-based event loops perform very well with small number of |
1787 | watchers, as the management overhead dominates. |
1991 | watchers, as the management overhead dominates. |
1788 | |
1992 | |
1789 | =back |
1993 | =back |
1790 | |
1994 | |
|
|
1995 | =head2 THE IO::Lambda BENCHMARK |
|
|
1996 | |
|
|
1997 | Recently I was told about the benchmark in the IO::Lambda manpage, which |
|
|
1998 | could be misinterpreted to make AnyEvent look bad. In fact, the benchmark |
|
|
1999 | simply compares IO::Lambda with POE, and IO::Lambda looks better (which |
|
|
2000 | shouldn't come as a surprise to anybody). As such, the benchmark is |
|
|
2001 | fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't |
|
|
2002 | very optimal. But how would AnyEvent compare when used without the extra |
|
|
2003 | baggage? To explore this, I wrote the equivalent benchmark for AnyEvent. |
|
|
2004 | |
|
|
2005 | The benchmark itself creates an echo-server, and then, for 500 times, |
|
|
2006 | connects to the echo server, sends a line, waits for the reply, and then |
|
|
2007 | creates the next connection. This is a rather bad benchmark, as it doesn't |
|
|
2008 | test the efficiency of the framework or much non-blocking I/O, but it is a |
|
|
2009 | benchmark nevertheless. |
|
|
2010 | |
|
|
2011 | name runtime |
|
|
2012 | Lambda/select 0.330 sec |
|
|
2013 | + optimized 0.122 sec |
|
|
2014 | Lambda/AnyEvent 0.327 sec |
|
|
2015 | + optimized 0.138 sec |
|
|
2016 | Raw sockets/select 0.077 sec |
|
|
2017 | POE/select, components 0.662 sec |
|
|
2018 | POE/select, raw sockets 0.226 sec |
|
|
2019 | POE/select, optimized 0.404 sec |
|
|
2020 | |
|
|
2021 | AnyEvent/select/nb 0.085 sec |
|
|
2022 | AnyEvent/EV/nb 0.068 sec |
|
|
2023 | +state machine 0.134 sec |
|
|
2024 | |
|
|
2025 | The benchmark is also a bit unfair (my fault): the IO::Lambda/POE |
|
|
2026 | benchmarks actually make blocking connects and use 100% blocking I/O, |
|
|
2027 | defeating the purpose of an event-based solution. All of the newly |
|
|
2028 | written AnyEvent benchmarks use 100% non-blocking connects (using |
|
|
2029 | AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS |
|
|
2030 | resolver), so AnyEvent is at a disadvantage here, as non-blocking connects |
|
|
2031 | generally require a lot more bookkeeping and event handling than blocking |
|
|
2032 | connects (which involve a single syscall only). |
|
|
2033 | |
|
|
2034 | The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which |
|
|
2035 | offers similar expressive power as POE and IO::Lambda, using conventional |
|
|
2036 | Perl syntax. This means that both the echo server and the client are 100% |
|
|
2037 | non-blocking, further placing it at a disadvantage. |
|
|
2038 | |
|
|
2039 | As you can see, the AnyEvent + EV combination even beats the |
|
|
2040 | hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl |
|
|
2041 | backend easily beats IO::Lambda and POE. |
|
|
2042 | |
|
|
2043 | And even the 100% non-blocking version written using the high-level (and |
|
|
2044 | slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a |
|
|
2045 | large margin, even though it does all of DNS, tcp-connect and socket I/O |
|
|
2046 | in a non-blocking way. |
|
|
2047 | |
|
|
2048 | The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and |
|
|
2049 | F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are |
|
|
2050 | part of the IO::lambda distribution and were used without any changes. |
|
|
2051 | |
1791 | |
2052 | |
1792 | =head1 SIGNALS |
2053 | =head1 SIGNALS |
1793 | |
2054 | |
1794 | AnyEvent currently installs handlers for these signals: |
2055 | AnyEvent currently installs handlers for these signals: |
1795 | |
2056 | |
… | |
… | |
1798 | =item SIGCHLD |
2059 | =item SIGCHLD |
1799 | |
2060 | |
1800 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
2061 | A handler for C<SIGCHLD> is installed by AnyEvent's child watcher |
1801 | emulation for event loops that do not support them natively. Also, some |
2062 | emulation for event loops that do not support them natively. Also, some |
1802 | event loops install a similar handler. |
2063 | event loops install a similar handler. |
|
|
2064 | |
|
|
2065 | If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will |
|
|
2066 | reset it to default, to avoid losing child exit statuses. |
1803 | |
2067 | |
1804 | =item SIGPIPE |
2068 | =item SIGPIPE |
1805 | |
2069 | |
1806 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
2070 | A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef> |
1807 | when AnyEvent gets loaded. |
2071 | when AnyEvent gets loaded. |
… | |
… | |
1819 | |
2083 | |
1820 | =back |
2084 | =back |
1821 | |
2085 | |
1822 | =cut |
2086 | =cut |
1823 | |
2087 | |
|
|
2088 | undef $SIG{CHLD} |
|
|
2089 | if $SIG{CHLD} eq 'IGNORE'; |
|
|
2090 | |
1824 | $SIG{PIPE} = sub { } |
2091 | $SIG{PIPE} = sub { } |
1825 | unless defined $SIG{PIPE}; |
2092 | unless defined $SIG{PIPE}; |
1826 | |
|
|
1827 | |
2093 | |
1828 | =head1 FORK |
2094 | =head1 FORK |
1829 | |
2095 | |
1830 | Most event libraries are not fork-safe. The ones who are usually are |
2096 | Most event libraries are not fork-safe. The ones who are usually are |
1831 | because they rely on inefficient but fork-safe C<select> or C<poll> |
2097 | because they rely on inefficient but fork-safe C<select> or C<poll> |
… | |
… | |
1852 | use AnyEvent; |
2118 | use AnyEvent; |
1853 | |
2119 | |
1854 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
2120 | Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can |
1855 | be used to probe what backend is used and gain other information (which is |
2121 | be used to probe what backend is used and gain other information (which is |
1856 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
2122 | probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and |
1857 | $ENV{PERL_ANYEGENT_STRICT}. |
2123 | $ENV{PERL_ANYEVENT_STRICT}. |
|
|
2124 | |
|
|
2125 | Note that AnyEvent will remove I<all> environment variables starting with |
|
|
2126 | C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is |
|
|
2127 | enabled. |
1858 | |
2128 | |
1859 | |
2129 | |
1860 | =head1 BUGS |
2130 | =head1 BUGS |
1861 | |
2131 | |
1862 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
2132 | Perl 5.8 has numerous memleaks that sometimes hit this module and are hard |
1863 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
2133 | to work around. If you suffer from memleaks, first upgrade to Perl 5.10 |
1864 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
2134 | and check wether the leaks still show up. (Perl 5.10.0 has other annoying |
1865 | mamleaks, such as leaking on C<map> and C<grep> but it is usually not as |
2135 | memleaks, such as leaking on C<map> and C<grep> but it is usually not as |
1866 | pronounced). |
2136 | pronounced). |
1867 | |
2137 | |
1868 | |
2138 | |
1869 | =head1 SEE ALSO |
2139 | =head1 SEE ALSO |
1870 | |
2140 | |