ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.180 by root, Sat Sep 6 07:00:45 2008 UTC vs.
Revision 1.226 by root, Mon Jul 6 23:32:49 2009 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent - provide framework for multiple event loops 3AnyEvent - provide framework for multiple event loops
4 4
5EV, Event, Glib, Tk, Perl, Event::Lib, Qt, POE - various supported event loops 5EV, Event, Glib, Tk, Perl, Event::Lib, Qt and POE are various supported
6event 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:
137These watchers are normal Perl objects with normal Perl lifetime. After 145These watchers are normal Perl objects with normal Perl lifetime. After
138creating a watcher it will immediately "watch" for events and invoke the 146creating a watcher it will immediately "watch" for events and invoke the
139callback when the event occurs (of course, only when the event model 147callback when the event occurs (of course, only when the event model
140is in control). 148is in control).
141 149
150Note that B<callbacks must not permanently change global variables>
151potentially in use by the event loop (such as C<$_> or C<$[>) and that B<<
152callbacks must not C<die> >>. The former is good programming practise in
153Perl and the latter stems from the fact that exception handling differs
154widely between event loops.
155
142To disable the watcher you have to destroy it (e.g. by setting the 156To disable the watcher you have to destroy it (e.g. by setting the
143variable you store it in to C<undef> or otherwise deleting all references 157variable you store it in to C<undef> or otherwise deleting all references
144to it). 158to it).
145 159
146All watchers are created by calling a method on the C<AnyEvent> class. 160All watchers are created by calling a method on the C<AnyEvent> class.
162=head2 I/O WATCHERS 176=head2 I/O WATCHERS
163 177
164You can create an I/O watcher by calling the C<< AnyEvent->io >> method 178You can create an I/O watcher by calling the C<< AnyEvent->io >> method
165with the following mandatory key-value pairs as arguments: 179with the following mandatory key-value pairs as arguments:
166 180
167C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for events 181C<fh> is the Perl I<file handle> (I<not> file descriptor) to watch
168(AnyEvent might or might not keep a reference to this file handle). C<poll> 182for events (AnyEvent might or might not keep a reference to this file
183handle). Note that only file handles pointing to things for which
184non-blocking operation makes sense are allowed. This includes sockets,
185most character devices, pipes, fifos and so on, but not for example files
186or block devices.
187
169must be a string that is either C<r> or C<w>, which creates a watcher 188C<poll> must be a string that is either C<r> or C<w>, which creates a
170waiting for "r"eadable or "w"ritable events, respectively. C<cb> is the 189watcher waiting for "r"eadable or "w"ritable events, respectively.
190
171callback to invoke each time the file handle becomes ready. 191C<cb> is the callback to invoke each time the file handle becomes ready.
172 192
173Although the callback might get passed parameters, their value and 193Although the callback might get passed parameters, their value and
174presence is undefined and you cannot rely on them. Portable AnyEvent 194presence is undefined and you cannot rely on them. Portable AnyEvent
175callbacks cannot use arguments passed to I/O watcher callbacks. 195callbacks cannot use arguments passed to I/O watcher callbacks.
176 196
308In either case, if you care (and in most cases, you don't), then you 328In either case, if you care (and in most cases, you don't), then you
309can get whatever behaviour you want with any event loop, by taking the 329can get whatever behaviour you want with any event loop, by taking the
310difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into 330difference between C<< AnyEvent->time >> and C<< AnyEvent->now >> into
311account. 331account.
312 332
333=item AnyEvent->now_update
334
335Some event loops (such as L<EV> or L<AnyEvent::Impl::Perl>) cache
336the current time for each loop iteration (see the discussion of L<<
337AnyEvent->now >>, above).
338
339When a callback runs for a long time (or when the process sleeps), then
340this "current" time will differ substantially from the real time, which
341might affect timers and time-outs.
342
343When this is the case, you can call this method, which will update the
344event loop's idea of "current time".
345
346Note that updating the time I<might> cause some events to be handled.
347
313=back 348=back
314 349
315=head2 SIGNAL WATCHERS 350=head2 SIGNAL WATCHERS
316 351
317You can watch for signals using a signal watcher, C<signal> is the signal 352You can watch for signals using a signal watcher, C<signal> is the signal
340=head2 CHILD PROCESS WATCHERS 375=head2 CHILD PROCESS WATCHERS
341 376
342You can also watch on a child process exit and catch its exit status. 377You can also watch on a child process exit and catch its exit status.
343 378
344The child process is specified by the C<pid> argument (if set to C<0>, it 379The child process is specified by the C<pid> argument (if set to C<0>, it
345watches for any child process exit). The watcher will trigger as often 380watches for any child process exit). The watcher will triggered only when
346as status change for the child are received. This works by installing a 381the child process has finished and an exit status is available, not on
347signal handler for C<SIGCHLD>. The callback will be called with the pid 382any trace events (stopped/continued).
348and exit status (as returned by waitpid), so unlike other watcher types, 383
349you I<can> rely on child watcher callback arguments. 384The callback will be called with the pid and exit status (as returned by
385waitpid), so unlike other watcher types, you I<can> rely on child watcher
386callback arguments.
387
388This watcher type works by installing a signal handler for C<SIGCHLD>,
389and since it cannot be shared, nothing else should use SIGCHLD or reap
390random child processes (waiting for specific child processes, e.g. inside
391C<system>, is just fine).
350 392
351There is a slight catch to child watchers, however: you usually start them 393There is a slight catch to child watchers, however: you usually start them
352I<after> the child process was created, and this means the process could 394I<after> the child process was created, and this means the process could
353have exited already (and no SIGCHLD will be sent anymore). 395have exited already (and no SIGCHLD will be sent anymore).
354 396
355Not all event models handle this correctly (POE doesn't), but even for 397Not all event models handle this correctly (neither POE nor IO::Async do,
398see their AnyEvent::Impl manpages for details), but even for event models
356event models that I<do> handle this correctly, they usually need to be 399that I<do> handle this correctly, they usually need to be loaded before
357loaded before the process exits (i.e. before you fork in the first place). 400the process exits (i.e. before you fork in the first place). AnyEvent's
401pure perl event loop handles all cases correctly regardless of when you
402start the watcher.
358 403
359This means you cannot create a child watcher as the very first thing in an 404This means you cannot create a child watcher as the very first
360AnyEvent program, you I<have> to create at least one watcher before you 405thing in an AnyEvent program, you I<have> to create at least one
361C<fork> the child (alternatively, you can call C<AnyEvent::detect>). 406watcher before you C<fork> the child (alternatively, you can call
407C<AnyEvent::detect>).
362 408
363Example: fork a process and wait for it 409Example: fork a process and wait for it
364 410
365 my $done = AnyEvent->condvar; 411 my $done = AnyEvent->condvar;
366 412
376 ); 422 );
377 423
378 # do something else, then wait for process exit 424 # do something else, then wait for process exit
379 $done->recv; 425 $done->recv;
380 426
427=head2 IDLE WATCHERS
428
429Sometimes there is a need to do something, but it is not so important
430to do it instantly, but only when there is nothing better to do. This
431"nothing better to do" is usually defined to be "no other events need
432attention by the event loop".
433
434Idle watchers ideally get invoked when the event loop has nothing
435better to do, just before it would block the process to wait for new
436events. Instead of blocking, the idle watcher is invoked.
437
438Most event loops unfortunately do not really support idle watchers (only
439EV, Event and Glib do it in a usable fashion) - for the rest, AnyEvent
440will simply call the callback "from time to time".
441
442Example: read lines from STDIN, but only process them when the
443program is otherwise idle:
444
445 my @lines; # read data
446 my $idle_w;
447 my $io_w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
448 push @lines, scalar <STDIN>;
449
450 # start an idle watcher, if not already done
451 $idle_w ||= AnyEvent->idle (cb => sub {
452 # handle only one line, when there are lines left
453 if (my $line = shift @lines) {
454 print "handled when idle: $line";
455 } else {
456 # otherwise disable the idle watcher again
457 undef $idle_w;
458 }
459 });
460 });
461
381=head2 CONDITION VARIABLES 462=head2 CONDITION VARIABLES
382 463
383If you are familiar with some event loops you will know that all of them 464If you are familiar with some event loops you will know that all of them
384require you to run some blocking "loop", "run" or similar function that 465require you to run some blocking "loop", "run" or similar function that
385will actively watch for new events and call your callbacks. 466will actively watch for new events and call your callbacks.
518 599
519=item $cv->begin ([group callback]) 600=item $cv->begin ([group callback])
520 601
521=item $cv->end 602=item $cv->end
522 603
523These two methods are EXPERIMENTAL and MIGHT CHANGE.
524
525These two methods can be used to combine many transactions/events into 604These two methods can be used to combine many transactions/events into
526one. For example, a function that pings many hosts in parallel might want 605one. For example, a function that pings many hosts in parallel might want
527to use a condition variable for the whole process. 606to use a condition variable for the whole process.
528 607
529Every call to C<< ->begin >> will increment a counter, and every call to 608Every call to C<< ->begin >> will increment a counter, and every call to
530C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end 609C<< ->end >> will decrement it. If the counter reaches C<0> in C<< ->end
531>>, the (last) callback passed to C<begin> will be executed. That callback 610>>, the (last) callback passed to C<begin> will be executed. That callback
532is I<supposed> to call C<< ->send >>, but that is not required. If no 611is I<supposed> to call C<< ->send >>, but that is not required. If no
533callback was set, C<send> will be called without any arguments. 612callback was set, C<send> will be called without any arguments.
534 613
535Let's clarify this with the ping example: 614You can think of C<< $cv->send >> giving you an OR condition (one call
615sends), while C<< $cv->begin >> and C<< $cv->end >> giving you an AND
616condition (all C<begin> calls must be C<end>'ed before the condvar sends).
617
618Let's start with a simple example: you have two I/O watchers (for example,
619STDOUT and STDERR for a program), and you want to wait for both streams to
620close before activating a condvar:
621
622 my $cv = AnyEvent->condvar;
623
624 $cv->begin; # first watcher
625 my $w1 = AnyEvent->io (fh => $fh1, cb => sub {
626 defined sysread $fh1, my $buf, 4096
627 or $cv->end;
628 });
629
630 $cv->begin; # second watcher
631 my $w2 = AnyEvent->io (fh => $fh2, cb => sub {
632 defined sysread $fh2, my $buf, 4096
633 or $cv->end;
634 });
635
636 $cv->recv;
637
638This works because for every event source (EOF on file handle), there is
639one call to C<begin>, so the condvar waits for all calls to C<end> before
640sending.
641
642The ping example mentioned above is slightly more complicated, as the
643there are results to be passwd back, and the number of tasks that are
644begung can potentially be zero:
536 645
537 my $cv = AnyEvent->condvar; 646 my $cv = AnyEvent->condvar;
538 647
539 my %result; 648 my %result;
540 $cv->begin (sub { $cv->send (\%result) }); 649 $cv->begin (sub { $cv->send (\%result) });
560loop, which serves two important purposes: first, it sets the callback 669loop, which serves two important purposes: first, it sets the callback
561to be called once the counter reaches C<0>, and second, it ensures that 670to be called once the counter reaches C<0>, and second, it ensures that
562C<send> is called even when C<no> hosts are being pinged (the loop 671C<send> is called even when C<no> hosts are being pinged (the loop
563doesn't execute once). 672doesn't execute once).
564 673
565This is the general pattern when you "fan out" into multiple subrequests: 674This is the general pattern when you "fan out" into multiple (but
566use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 675potentially none) subrequests: use an outer C<begin>/C<end> pair to set
567is called at least once, and then, for each subrequest you start, call 676the callback and ensure C<end> is called at least once, and then, for each
568C<begin> and for each subrequest you finish, call C<end>. 677subrequest you start, call C<begin> and for each subrequest you finish,
678call C<end>.
569 679
570=back 680=back
571 681
572=head3 METHODS FOR CONSUMERS 682=head3 METHODS FOR CONSUMERS
573 683
653 AnyEvent::Impl::Tk based on Tk, very bad choice. 763 AnyEvent::Impl::Tk based on Tk, very bad choice.
654 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs). 764 AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
655 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 765 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
656 AnyEvent::Impl::POE based on POE, not generic enough for full support. 766 AnyEvent::Impl::POE based on POE, not generic enough for full support.
657 767
768 # warning, support for IO::Async is only partial, as it is too broken
769 # and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
770 AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
771
658There is no support for WxWidgets, as WxWidgets has no support for 772There is no support for WxWidgets, as WxWidgets has no support for
659watching file handles. However, you can use WxWidgets through the 773watching file handles. However, you can use WxWidgets through the
660POE Adaptor, as POE has a Wx backend that simply polls 20 times per 774POE Adaptor, as POE has a Wx backend that simply polls 20 times per
661second, which was considered to be too horrible to even consider for 775second, which was considered to be too horrible to even consider for
662AnyEvent. Likewise, other POE backends can be used by AnyEvent by using 776AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
818=item L<AnyEvent::IGS> 932=item L<AnyEvent::IGS>
819 933
820A non-blocking interface to the Internet Go Server protocol (used by 934A non-blocking interface to the Internet Go Server protocol (used by
821L<App::IGS>). 935L<App::IGS>).
822 936
823=item L<Net::IRC3> 937=item L<AnyEvent::IRC>
824 938
825AnyEvent based IRC client module family. 939AnyEvent based IRC client module family (replacing the older Net::IRC3).
826 940
827=item L<Net::XMPP2> 941=item L<Net::XMPP2>
828 942
829AnyEvent based XMPP (Jabber protocol) module family. 943AnyEvent based XMPP (Jabber protocol) module family.
830 944
854no warnings; 968no warnings;
855use strict qw(vars subs); 969use strict qw(vars subs);
856 970
857use Carp; 971use Carp;
858 972
859our $VERSION = 4.233; 973our $VERSION = 4.8;
860our $MODEL; 974our $MODEL;
861 975
862our $AUTOLOAD; 976our $AUTOLOAD;
863our @ISA; 977our @ISA;
864 978
865our @REGISTRY; 979our @REGISTRY;
866 980
867our $WIN32; 981our $WIN32;
868 982
869BEGIN { 983BEGIN {
870 my $win32 = ! ! ($^O =~ /mswin32/i); 984 eval "sub WIN32(){ " . (($^O =~ /mswin32/i)*1) ." }";
871 eval "sub WIN32(){ $win32 }"; 985 eval "sub TAINT(){ " . (${^TAINT}*1) . " }";
986
987 delete @ENV{grep /^PERL_ANYEVENT_/, keys %ENV}
988 if ${^TAINT};
872} 989}
873 990
874our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1; 991our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
875 992
876our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 993our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
894 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1011 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
895 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1012 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
896 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza 1013 [POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
897 [Wx:: => AnyEvent::Impl::POE::], 1014 [Wx:: => AnyEvent::Impl::POE::],
898 [Prima:: => AnyEvent::Impl::POE::], 1015 [Prima:: => AnyEvent::Impl::POE::],
1016 # IO::Async is just too broken - we would need workaorunds for its
1017 # byzantine signal and broken child handling, among others.
1018 # IO::Async is rather hard to detect, as it doesn't have any
1019 # obvious default class.
1020# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1021# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1022# [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
899); 1023);
900 1024
901our %method = map +($_ => 1), qw(io timer time now signal child condvar one_event DESTROY); 1025our %method = map +($_ => 1),
1026 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
902 1027
903our @post_detect; 1028our @post_detect;
904 1029
905sub post_detect(&) { 1030sub post_detect(&) {
906 my ($cb) = @_; 1031 my ($cb) = @_;
911 1 1036 1
912 } else { 1037 } else {
913 push @post_detect, $cb; 1038 push @post_detect, $cb;
914 1039
915 defined wantarray 1040 defined wantarray
916 ? bless \$cb, "AnyEvent::Util::PostDetect" 1041 ? bless \$cb, "AnyEvent::Util::postdetect"
917 : () 1042 : ()
918 } 1043 }
919} 1044}
920 1045
921sub AnyEvent::Util::PostDetect::DESTROY { 1046sub AnyEvent::Util::postdetect::DESTROY {
922 @post_detect = grep $_ != ${$_[0]}, @post_detect; 1047 @post_detect = grep $_ != ${$_[0]}, @post_detect;
923} 1048}
924 1049
925sub detect() { 1050sub detect() {
926 unless ($MODEL) { 1051 unless ($MODEL) {
963 last; 1088 last;
964 } 1089 }
965 } 1090 }
966 1091
967 $MODEL 1092 $MODEL
968 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib."; 1093 or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV, Event or Glib.\n";
969 } 1094 }
970 } 1095 }
971 1096
972 push @{"$MODEL\::ISA"}, "AnyEvent::Base"; 1097 push @{"$MODEL\::ISA"}, "AnyEvent::Base";
973 1098
994} 1119}
995 1120
996# utility function to dup a filehandle. this is used by many backends 1121# utility function to dup a filehandle. this is used by many backends
997# to support binding more than one watcher per filehandle (they usually 1122# to support binding more than one watcher per filehandle (they usually
998# allow only one watcher per fd, so we dup it to get a different one). 1123# allow only one watcher per fd, so we dup it to get a different one).
999sub _dupfh($$$$) { 1124sub _dupfh($$;$$) {
1000 my ($poll, $fh, $r, $w) = @_; 1125 my ($poll, $fh, $r, $w) = @_;
1001
1002 require Fcntl;
1003 1126
1004 # cygwin requires the fh mode to be matching, unix doesn't 1127 # cygwin requires the fh mode to be matching, unix doesn't
1005 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1128 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1006 : $poll eq "w" ? ($w, ">") 1129 : $poll eq "w" ? ($w, ">")
1007 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; 1130 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1008 1131
1009 open my $fh2, "$mode&" . fileno $fh 1132 open my $fh2, "$mode&" . fileno $fh
1010 or die "cannot dup() filehandle: $!"; 1133 or die "cannot dup() filehandle: $!,";
1011 1134
1012 # we assume CLOEXEC is already set by perl in all important cases 1135 # we assume CLOEXEC is already set by perl in all important cases
1013 1136
1014 ($fh2, $rw) 1137 ($fh2, $rw)
1015} 1138}
1016 1139
1017package AnyEvent::Base; 1140package AnyEvent::Base;
1018 1141
1019# default implementation for now and time 1142# default implementations for many methods
1020 1143
1021BEGIN { 1144BEGIN {
1022 if (eval "use Time::HiRes (); time (); 1") { 1145 if (eval "use Time::HiRes (); Time::HiRes::time (); 1") {
1023 *_time = \&Time::HiRes::time; 1146 *_time = \&Time::HiRes::time;
1024 # if (eval "use POSIX (); (POSIX::times())... 1147 # if (eval "use POSIX (); (POSIX::times())...
1025 } else { 1148 } else {
1026 *_time = \&CORE::time; # epic fail 1149 *_time = sub { time }; # epic fail
1027 } 1150 }
1028} 1151}
1029 1152
1030sub time { _time } 1153sub time { _time }
1031sub now { _time } 1154sub now { _time }
1155sub now_update { }
1032 1156
1033# default implementation for ->condvar 1157# default implementation for ->condvar
1034 1158
1035sub condvar { 1159sub condvar {
1036 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1160 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, "AnyEvent::CondVar"
1037} 1161}
1038 1162
1039# default implementation for ->signal 1163# default implementation for ->signal
1040 1164
1041our %SIG_CB; 1165our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1166
1167sub _signal_exec {
1168 sysread $SIGPIPE_R, my $dummy, 4;
1169
1170 while (%SIG_EV) {
1171 for (keys %SIG_EV) {
1172 delete $SIG_EV{$_};
1173 $_->() for values %{ $SIG_CB{$_} || {} };
1174 }
1175 }
1176}
1042 1177
1043sub signal { 1178sub signal {
1044 my (undef, %arg) = @_; 1179 my (undef, %arg) = @_;
1045 1180
1181 unless ($SIGPIPE_R) {
1182 require Fcntl;
1183
1184 if (AnyEvent::WIN32) {
1185 require AnyEvent::Util;
1186
1187 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1188 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1189 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1190 } else {
1191 pipe $SIGPIPE_R, $SIGPIPE_W;
1192 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1193 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1194
1195 # not strictly required, as $^F is normally 2, but let's make sure...
1196 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1197 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1198 }
1199
1200 $SIGPIPE_R
1201 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1202
1203 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1204 }
1205
1046 my $signal = uc $arg{signal} 1206 my $signal = uc $arg{signal}
1047 or Carp::croak "required option 'signal' is missing"; 1207 or Carp::croak "required option 'signal' is missing";
1048 1208
1049 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1209 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1050 $SIG{$signal} ||= sub { 1210 $SIG{$signal} ||= sub {
1051 $_->() for values %{ $SIG_CB{$signal} || {} }; 1211 local $!;
1212 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1213 undef $SIG_EV{$signal};
1052 }; 1214 };
1053 1215
1054 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1216 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1055} 1217}
1056 1218
1057sub AnyEvent::Base::Signal::DESTROY { 1219sub AnyEvent::Base::signal::DESTROY {
1058 my ($signal, $cb) = @{$_[0]}; 1220 my ($signal, $cb) = @{$_[0]};
1059 1221
1060 delete $SIG_CB{$signal}{$cb}; 1222 delete $SIG_CB{$signal}{$cb};
1061 1223
1224 # delete doesn't work with older perls - they then
1225 # print weird messages, or just unconditionally exit
1226 # instead of getting the default action.
1062 delete $SIG{$signal} unless keys %{ $SIG_CB{$signal} }; 1227 undef $SIG{$signal} unless keys %{ $SIG_CB{$signal} };
1063} 1228}
1064 1229
1065# default implementation for ->child 1230# default implementation for ->child
1066 1231
1067our %PID_CB; 1232our %PID_CB;
1068our $CHLD_W; 1233our $CHLD_W;
1069our $CHLD_DELAY_W; 1234our $CHLD_DELAY_W;
1070our $PID_IDLE;
1071our $WNOHANG; 1235our $WNOHANG;
1072 1236
1073sub _child_wait { 1237sub _sigchld {
1074 while (0 < (my $pid = waitpid -1, $WNOHANG)) { 1238 while (0 < (my $pid = waitpid -1, $WNOHANG)) {
1075 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }), 1239 $_->($pid, $?) for (values %{ $PID_CB{$pid} || {} }),
1076 (values %{ $PID_CB{0} || {} }); 1240 (values %{ $PID_CB{0} || {} });
1077 } 1241 }
1078
1079 undef $PID_IDLE;
1080}
1081
1082sub _sigchld {
1083 # make sure we deliver these changes "synchronous" with the event loop.
1084 $CHLD_DELAY_W ||= AnyEvent->timer (after => 0, cb => sub {
1085 undef $CHLD_DELAY_W;
1086 &_child_wait;
1087 });
1088} 1242}
1089 1243
1090sub child { 1244sub child {
1091 my (undef, %arg) = @_; 1245 my (undef, %arg) = @_;
1092 1246
1093 defined (my $pid = $arg{pid} + 0) 1247 defined (my $pid = $arg{pid} + 0)
1094 or Carp::croak "required option 'pid' is missing"; 1248 or Carp::croak "required option 'pid' is missing";
1095 1249
1096 $PID_CB{$pid}{$arg{cb}} = $arg{cb}; 1250 $PID_CB{$pid}{$arg{cb}} = $arg{cb};
1097 1251
1098 unless ($WNOHANG) {
1099 $WNOHANG = eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1252 $WNOHANG ||= eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1100 }
1101 1253
1102 unless ($CHLD_W) { 1254 unless ($CHLD_W) {
1103 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1255 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
1104 # child could be a zombie already, so make at least one round 1256 # child could be a zombie already, so make at least one round
1105 &_sigchld; 1257 &_sigchld;
1106 } 1258 }
1107 1259
1108 bless [$pid, $arg{cb}], "AnyEvent::Base::Child" 1260 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1109} 1261}
1110 1262
1111sub AnyEvent::Base::Child::DESTROY { 1263sub AnyEvent::Base::child::DESTROY {
1112 my ($pid, $cb) = @{$_[0]}; 1264 my ($pid, $cb) = @{$_[0]};
1113 1265
1114 delete $PID_CB{$pid}{$cb}; 1266 delete $PID_CB{$pid}{$cb};
1115 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} }; 1267 delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
1116 1268
1117 undef $CHLD_W unless keys %PID_CB; 1269 undef $CHLD_W unless keys %PID_CB;
1270}
1271
1272# idle emulation is done by simply using a timer, regardless
1273# of whether the process is idle or not, and not letting
1274# the callback use more than 50% of the time.
1275sub idle {
1276 my (undef, %arg) = @_;
1277
1278 my ($cb, $w, $rcb) = $arg{cb};
1279
1280 $rcb = sub {
1281 if ($cb) {
1282 $w = _time;
1283 &$cb;
1284 $w = _time - $w;
1285
1286 # never use more then 50% of the time for the idle watcher,
1287 # within some limits
1288 $w = 0.0001 if $w < 0.0001;
1289 $w = 5 if $w > 5;
1290
1291 $w = AnyEvent->timer (after => $w, cb => $rcb);
1292 } else {
1293 # clean up...
1294 undef $w;
1295 undef $rcb;
1296 }
1297 };
1298
1299 $w = AnyEvent->timer (after => 0.05, cb => $rcb);
1300
1301 bless \\$cb, "AnyEvent::Base::idle"
1302}
1303
1304sub AnyEvent::Base::idle::DESTROY {
1305 undef $${$_[0]};
1118} 1306}
1119 1307
1120package AnyEvent::CondVar; 1308package AnyEvent::CondVar;
1121 1309
1122our @ISA = AnyEvent::CondVar::Base::; 1310our @ISA = AnyEvent::CondVar::Base::;
1196so on. 1384so on.
1197 1385
1198=head1 ENVIRONMENT VARIABLES 1386=head1 ENVIRONMENT VARIABLES
1199 1387
1200The following environment variables are used by this module or its 1388The following environment variables are used by this module or its
1201submodules: 1389submodules.
1390
1391Note that AnyEvent will remove I<all> environment variables starting with
1392C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
1393enabled.
1202 1394
1203=over 4 1395=over 4
1204 1396
1205=item C<PERL_ANYEVENT_VERBOSE> 1397=item C<PERL_ANYEVENT_VERBOSE>
1206 1398
1218=item C<PERL_ANYEVENT_STRICT> 1410=item C<PERL_ANYEVENT_STRICT>
1219 1411
1220AnyEvent does not do much argument checking by default, as thorough 1412AnyEvent does not do much argument checking by default, as thorough
1221argument checking is very costly. Setting this variable to a true value 1413argument checking is very costly. Setting this variable to a true value
1222will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly 1414will cause AnyEvent to load C<AnyEvent::Strict> and then to thoroughly
1223check the arguments passed to most method calls. If it finds any problems 1415check the arguments passed to most method calls. If it finds any problems,
1224it will croak. 1416it will croak.
1225 1417
1226In other words, enables "strict" mode. 1418In other words, enables "strict" mode.
1227 1419
1228Unlike C<use strict>, it is definitely recommended ot keep it off in 1420Unlike C<use strict>, it is definitely recommended to keep it off in
1229production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while 1421production. Keeping C<PERL_ANYEVENT_STRICT=1> in your environment while
1230developing programs can be very useful, however. 1422developing programs can be very useful, however.
1231 1423
1232=item C<PERL_ANYEVENT_MODEL> 1424=item C<PERL_ANYEVENT_MODEL>
1233 1425
1256used, and preference will be given to protocols mentioned earlier in the 1448used, and preference will be given to protocols mentioned earlier in the
1257list. 1449list.
1258 1450
1259This variable can effectively be used for denial-of-service attacks 1451This variable can effectively be used for denial-of-service attacks
1260against local programs (e.g. when setuid), although the impact is likely 1452against local programs (e.g. when setuid), although the impact is likely
1261small, as the program has to handle connection errors already- 1453small, as the program has to handle conenction and other failures anyways.
1262 1454
1263Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, 1455Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1264but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 1456but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1265- only support IPv4, never try to resolve or contact IPv6 1457- only support IPv4, never try to resolve or contact IPv6
1266addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 1458addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1278 1470
1279=item C<PERL_ANYEVENT_MAX_FORKS> 1471=item C<PERL_ANYEVENT_MAX_FORKS>
1280 1472
1281The maximum number of child processes that C<AnyEvent::Util::fork_call> 1473The maximum number of child processes that C<AnyEvent::Util::fork_call>
1282will create in parallel. 1474will create in parallel.
1475
1476=item C<PERL_ANYEVENT_MAX_OUTSTANDING_DNS>
1477
1478The default value for the C<max_outstanding> parameter for the default DNS
1479resolver - this is the maximum number of parallel DNS requests that are
1480sent to the DNS server.
1481
1482=item C<PERL_ANYEVENT_RESOLV_CONF>
1483
1484The file to use instead of F</etc/resolv.conf> (or OS-specific
1485configuration) in the default resolver. When set to the empty string, no
1486default config will be used.
1283 1487
1284=back 1488=back
1285 1489
1286=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE 1490=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
1287 1491
1526watcher. 1730watcher.
1527 1731
1528=head3 Results 1732=head3 Results
1529 1733
1530 name watchers bytes create invoke destroy comment 1734 name watchers bytes create invoke destroy comment
1531 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1735 EV/EV 400000 224 0.47 0.35 0.27 EV native interface
1532 EV/Any 100000 244 2.50 0.46 0.29 EV + AnyEvent watchers 1736 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers
1533 CoroEV/Any 100000 244 2.49 0.44 0.29 coroutines + Coro::Signal 1737 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal
1534 Perl/Any 100000 513 4.92 0.87 1.12 pure perl implementation 1738 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation
1535 Event/Event 16000 516 31.88 31.30 0.85 Event native interface 1739 Event/Event 16000 517 32.20 31.80 0.81 Event native interface
1536 Event/Any 16000 590 35.75 31.42 1.08 Event + AnyEvent watchers 1740 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1741 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll
1742 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll
1537 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1743 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour
1538 Tk/Any 2000 1860 26.97 67.98 14.00 SEGV with >> 2000 watchers 1744 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers
1539 POE/Event 2000 6644 108.64 736.02 14.73 via POE::Loop::Event 1745 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event
1540 POE/Select 2000 6343 94.13 809.12 565.96 via POE::Loop::Select 1746 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1541 1747
1542=head3 Discussion 1748=head3 Discussion
1543 1749
1544The benchmark does I<not> measure scalability of the event loop very 1750The benchmark does I<not> measure scalability of the event loop very
1545well. For example, a select-based event loop (such as the pure perl one) 1751well. For example, a select-based event loop (such as the pure perl one)
1570performance becomes really bad with lots of file descriptors (and few of 1776performance becomes really bad with lots of file descriptors (and few of
1571them active), of course, but this was not subject of this benchmark. 1777them active), of course, but this was not subject of this benchmark.
1572 1778
1573The C<Event> module has a relatively high setup and callback invocation 1779The C<Event> module has a relatively high setup and callback invocation
1574cost, but overall scores in on the third place. 1780cost, but overall scores in on the third place.
1781
1782C<IO::Async> performs admirably well, about on par with C<Event>, even
1783when using its pure perl backend.
1575 1784
1576C<Glib>'s memory usage is quite a bit higher, but it features a 1785C<Glib>'s memory usage is quite a bit higher, but it features a
1577faster callback invocation and overall ends up in the same class as 1786faster callback invocation and overall ends up in the same class as
1578C<Event>. However, Glib scales extremely badly, doubling the number of 1787C<Event>. However, Glib scales extremely badly, doubling the number of
1579watchers increases the processing time by more than a factor of four, 1788watchers increases the processing time by more than a factor of four,
1657it to another server. This includes deleting the old timeout and creating 1866it to another server. This includes deleting the old timeout and creating
1658a new one that moves the timeout into the future. 1867a new one that moves the timeout into the future.
1659 1868
1660=head3 Results 1869=head3 Results
1661 1870
1662 name sockets create request 1871 name sockets create request
1663 EV 20000 69.01 11.16 1872 EV 20000 69.01 11.16
1664 Perl 20000 73.32 35.87 1873 Perl 20000 73.32 35.87
1874 IOAsync 20000 157.00 98.14 epoll
1875 IOAsync 20000 159.31 616.06 poll
1665 Event 20000 212.62 257.32 1876 Event 20000 212.62 257.32
1666 Glib 20000 651.16 1896.30 1877 Glib 20000 651.16 1896.30
1667 POE 20000 349.67 12317.24 uses POE::Loop::Event 1878 POE 20000 349.67 12317.24 uses POE::Loop::Event
1668 1879
1669=head3 Discussion 1880=head3 Discussion
1670 1881
1671This benchmark I<does> measure scalability and overall performance of the 1882This benchmark I<does> measure scalability and overall performance of the
1672particular event loop. 1883particular event loop.
1674EV is again fastest. Since it is using epoll on my system, the setup time 1885EV is again fastest. Since it is using epoll on my system, the setup time
1675is relatively high, though. 1886is relatively high, though.
1676 1887
1677Perl surprisingly comes second. It is much faster than the C-based event 1888Perl surprisingly comes second. It is much faster than the C-based event
1678loops Event and Glib. 1889loops Event and Glib.
1890
1891IO::Async performs very well when using its epoll backend, and still quite
1892good compared to Glib when using its pure perl backend.
1679 1893
1680Event suffers from high setup time as well (look at its code and you will 1894Event suffers from high setup time as well (look at its code and you will
1681understand why). Callback invocation also has a high overhead compared to 1895understand why). Callback invocation also has a high overhead compared to
1682the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event 1896the C<< $_->() for .. >>-style loop that the Perl event loop uses. Event
1683uses select or poll in basically all documented configurations. 1897uses select or poll in basically all documented configurations.
1746=item * C-based event loops perform very well with small number of 1960=item * C-based event loops perform very well with small number of
1747watchers, as the management overhead dominates. 1961watchers, as the management overhead dominates.
1748 1962
1749=back 1963=back
1750 1964
1965=head2 THE IO::Lambda BENCHMARK
1966
1967Recently I was told about the benchmark in the IO::Lambda manpage, which
1968could be misinterpreted to make AnyEvent look bad. In fact, the benchmark
1969simply compares IO::Lambda with POE, and IO::Lambda looks better (which
1970shouldn't come as a surprise to anybody). As such, the benchmark is
1971fine, and mostly shows that the AnyEvent backend from IO::Lambda isn't
1972very optimal. But how would AnyEvent compare when used without the extra
1973baggage? To explore this, I wrote the equivalent benchmark for AnyEvent.
1974
1975The benchmark itself creates an echo-server, and then, for 500 times,
1976connects to the echo server, sends a line, waits for the reply, and then
1977creates the next connection. This is a rather bad benchmark, as it doesn't
1978test the efficiency of the framework or much non-blocking I/O, but it is a
1979benchmark nevertheless.
1980
1981 name runtime
1982 Lambda/select 0.330 sec
1983 + optimized 0.122 sec
1984 Lambda/AnyEvent 0.327 sec
1985 + optimized 0.138 sec
1986 Raw sockets/select 0.077 sec
1987 POE/select, components 0.662 sec
1988 POE/select, raw sockets 0.226 sec
1989 POE/select, optimized 0.404 sec
1990
1991 AnyEvent/select/nb 0.085 sec
1992 AnyEvent/EV/nb 0.068 sec
1993 +state machine 0.134 sec
1994
1995The benchmark is also a bit unfair (my fault): the IO::Lambda/POE
1996benchmarks actually make blocking connects and use 100% blocking I/O,
1997defeating the purpose of an event-based solution. All of the newly
1998written AnyEvent benchmarks use 100% non-blocking connects (using
1999AnyEvent::Socket::tcp_connect and the asynchronous pure perl DNS
2000resolver), so AnyEvent is at a disadvantage here, as non-blocking connects
2001generally require a lot more bookkeeping and event handling than blocking
2002connects (which involve a single syscall only).
2003
2004The last AnyEvent benchmark additionally uses L<AnyEvent::Handle>, which
2005offers similar expressive power as POE and IO::Lambda, using conventional
2006Perl syntax. This means that both the echo server and the client are 100%
2007non-blocking, further placing it at a disadvantage.
2008
2009As you can see, the AnyEvent + EV combination even beats the
2010hand-optimised "raw sockets benchmark", while AnyEvent + its pure perl
2011backend easily beats IO::Lambda and POE.
2012
2013And even the 100% non-blocking version written using the high-level (and
2014slow :) L<AnyEvent::Handle> abstraction beats both POE and IO::Lambda by a
2015large margin, even though it does all of DNS, tcp-connect and socket I/O
2016in a non-blocking way.
2017
2018The two AnyEvent benchmarks programs can be found as F<eg/ae0.pl> and
2019F<eg/ae2.pl> in the AnyEvent distribution, the remaining benchmarks are
2020part of the IO::lambda distribution and were used without any changes.
2021
2022
2023=head1 SIGNALS
2024
2025AnyEvent currently installs handlers for these signals:
2026
2027=over 4
2028
2029=item SIGCHLD
2030
2031A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2032emulation for event loops that do not support them natively. Also, some
2033event loops install a similar handler.
2034
2035If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will
2036reset it to default, to avoid losing child exit statuses.
2037
2038=item SIGPIPE
2039
2040A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2041when AnyEvent gets loaded.
2042
2043The rationale for this is that AnyEvent users usually do not really depend
2044on SIGPIPE delivery (which is purely an optimisation for shell use, or
2045badly-written programs), but C<SIGPIPE> can cause spurious and rare
2046program exits as a lot of people do not expect C<SIGPIPE> when writing to
2047some random socket.
2048
2049The rationale for installing a no-op handler as opposed to ignoring it is
2050that this way, the handler will be restored to defaults on exec.
2051
2052Feel free to install your own handler, or reset it to defaults.
2053
2054=back
2055
2056=cut
2057
2058undef $SIG{CHLD}
2059 if $SIG{CHLD} eq 'IGNORE';
2060
2061$SIG{PIPE} = sub { }
2062 unless defined $SIG{PIPE};
1751 2063
1752=head1 FORK 2064=head1 FORK
1753 2065
1754Most event libraries are not fork-safe. The ones who are usually are 2066Most event libraries are not fork-safe. The ones who are usually are
1755because they rely on inefficient but fork-safe C<select> or C<poll> 2067because they rely on inefficient but fork-safe C<select> or C<poll>
1776 use AnyEvent; 2088 use AnyEvent;
1777 2089
1778Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can 2090Similar considerations apply to $ENV{PERL_ANYEVENT_VERBOSE}, as that can
1779be used to probe what backend is used and gain other information (which is 2091be used to probe what backend is used and gain other information (which is
1780probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and 2092probably even less useful to an attacker than PERL_ANYEVENT_MODEL), and
1781$ENV{PERL_ANYEGENT_STRICT}. 2093$ENV{PERL_ANYEVENT_STRICT}.
2094
2095Note that AnyEvent will remove I<all> environment variables starting with
2096C<PERL_ANYEVENT_> from C<%ENV> when it is loaded while taint mode is
2097enabled.
1782 2098
1783 2099
1784=head1 BUGS 2100=head1 BUGS
1785 2101
1786Perl 5.8 has numerous memleaks that sometimes hit this module and are hard 2102Perl 5.8 has numerous memleaks that sometimes hit this module and are hard
1787to work around. If you suffer from memleaks, first upgrade to Perl 5.10 2103to work around. If you suffer from memleaks, first upgrade to Perl 5.10
1788and check wether the leaks still show up. (Perl 5.10.0 has other annoying 2104and check wether the leaks still show up. (Perl 5.10.0 has other annoying
1789mamleaks, such as leaking on C<map> and C<grep> but it is usually not as 2105memleaks, such as leaking on C<map> and C<grep> but it is usually not as
1790pronounced). 2106pronounced).
1791 2107
1792 2108
1793=head1 SEE ALSO 2109=head1 SEE ALSO
1794 2110

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines