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.195 by root, Wed Mar 25 17:33:11 2009 UTC

340=head2 CHILD PROCESS WATCHERS 340=head2 CHILD PROCESS WATCHERS
341 341
342You can also watch on a child process exit and catch its exit status. 342You can also watch on a child process exit and catch its exit status.
343 343
344The child process is specified by the C<pid> argument (if set to C<0>, it 344The 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 345watches for any child process exit). The watcher will triggered only when
346as status change for the child are received. This works by installing a 346the 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 347any trace events (stopped/continued).
348and exit status (as returned by waitpid), so unlike other watcher types, 348
349you I<can> rely on child watcher callback arguments. 349The callback will be called with the pid and exit status (as returned by
350waitpid), so unlike other watcher types, you I<can> rely on child watcher
351callback arguments.
352
353This watcher type works by installing a signal handler for C<SIGCHLD>,
354and since it cannot be shared, nothing else should use SIGCHLD or reap
355random child processes (waiting for specific child processes, e.g. inside
356C<system>, is just fine).
350 357
351There is a slight catch to child watchers, however: you usually start them 358There 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 359I<after> the child process was created, and this means the process could
353have exited already (and no SIGCHLD will be sent anymore). 360have exited already (and no SIGCHLD will be sent anymore).
354 361
818=item L<AnyEvent::IGS> 825=item L<AnyEvent::IGS>
819 826
820A non-blocking interface to the Internet Go Server protocol (used by 827A non-blocking interface to the Internet Go Server protocol (used by
821L<App::IGS>). 828L<App::IGS>).
822 829
823=item L<Net::IRC3> 830=item L<AnyEvent::IRC>
824 831
825AnyEvent based IRC client module family. 832AnyEvent based IRC client module family (replacing the older Net::IRC3).
826 833
827=item L<Net::XMPP2> 834=item L<Net::XMPP2>
828 835
829AnyEvent based XMPP (Jabber protocol) module family. 836AnyEvent based XMPP (Jabber protocol) module family.
830 837
854no warnings; 861no warnings;
855use strict qw(vars subs); 862use strict qw(vars subs);
856 863
857use Carp; 864use Carp;
858 865
859our $VERSION = 4.233; 866our $VERSION = 4.341;
860our $MODEL; 867our $MODEL;
861 868
862our $AUTOLOAD; 869our $AUTOLOAD;
863our @ISA; 870our @ISA;
864 871
997# to support binding more than one watcher per filehandle (they usually 1004# 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). 1005# allow only one watcher per fd, so we dup it to get a different one).
999sub _dupfh($$$$) { 1006sub _dupfh($$$$) {
1000 my ($poll, $fh, $r, $w) = @_; 1007 my ($poll, $fh, $r, $w) = @_;
1001 1008
1002 require Fcntl;
1003
1004 # cygwin requires the fh mode to be matching, unix doesn't 1009 # cygwin requires the fh mode to be matching, unix doesn't
1005 my ($rw, $mode) = $poll eq "r" ? ($r, "<") 1010 my ($rw, $mode) = $poll eq "r" ? ($r, "<")
1006 : $poll eq "w" ? ($w, ">") 1011 : $poll eq "w" ? ($w, ">")
1007 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'"; 1012 : Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1008 1013
1021BEGIN { 1026BEGIN {
1022 if (eval "use Time::HiRes (); time (); 1") { 1027 if (eval "use Time::HiRes (); time (); 1") {
1023 *_time = \&Time::HiRes::time; 1028 *_time = \&Time::HiRes::time;
1024 # if (eval "use POSIX (); (POSIX::times())... 1029 # if (eval "use POSIX (); (POSIX::times())...
1025 } else { 1030 } else {
1026 *_time = \&CORE::time; # epic fail 1031 *_time = sub { time }; # epic fail
1027 } 1032 }
1028} 1033}
1029 1034
1030sub time { _time } 1035sub time { _time }
1031sub now { _time } 1036sub now { _time }
1036 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar:: 1041 bless { @_ == 3 ? (_ae_cb => $_[2]) : () }, AnyEvent::CondVar::
1037} 1042}
1038 1043
1039# default implementation for ->signal 1044# default implementation for ->signal
1040 1045
1041our %SIG_CB; 1046our ($SIGPIPE_R, $SIGPIPE_W, %SIG_CB, %SIG_EV, $SIG_IO);
1047
1048sub _signal_exec {
1049 while (%SIG_EV) {
1050 sysread $SIGPIPE_R, my $dummy, 4;
1051 for (keys %SIG_EV) {
1052 delete $SIG_EV{$_};
1053 $_->() for values %{ $SIG_CB{$_} || {} };
1054 }
1055 }
1056}
1042 1057
1043sub signal { 1058sub signal {
1044 my (undef, %arg) = @_; 1059 my (undef, %arg) = @_;
1045 1060
1061 unless ($SIGPIPE_R) {
1062 if (AnyEvent::WIN32) {
1063 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1064 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1065 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1066 } else {
1067 pipe $SIGPIPE_R, $SIGPIPE_W;
1068 require Fcntl;
1069 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1070 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1071 }
1072
1073 $SIGPIPE_R
1074 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1075
1076 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1077 }
1078
1046 my $signal = uc $arg{signal} 1079 my $signal = uc $arg{signal}
1047 or Carp::croak "required option 'signal' is missing"; 1080 or Carp::croak "required option 'signal' is missing";
1048 1081
1049 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1082 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1050 $SIG{$signal} ||= sub { 1083 $SIG{$signal} ||= sub {
1051 $_->() for values %{ $SIG_CB{$signal} || {} }; 1084 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1085 undef $SIG_EV{$signal};
1052 }; 1086 };
1053 1087
1054 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal" 1088 bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
1055} 1089}
1056 1090
1256used, and preference will be given to protocols mentioned earlier in the 1290used, and preference will be given to protocols mentioned earlier in the
1257list. 1291list.
1258 1292
1259This variable can effectively be used for denial-of-service attacks 1293This variable can effectively be used for denial-of-service attacks
1260against local programs (e.g. when setuid), although the impact is likely 1294against local programs (e.g. when setuid), although the impact is likely
1261small, as the program has to handle connection errors already- 1295small, as the program has to handle conenction and other failures anyways.
1262 1296
1263Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6, 1297Examples: C<PERL_ANYEVENT_PROTOCOLS=ipv4,ipv6> - prefer IPv4 over IPv6,
1264but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4> 1298but support both and try to use both. C<PERL_ANYEVENT_PROTOCOLS=ipv4>
1265- only support IPv4, never try to resolve or contact IPv6 1299- only support IPv4, never try to resolve or contact IPv6
1266addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or 1300addresses. C<PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4> support either IPv4 or
1526watcher. 1560watcher.
1527 1561
1528=head3 Results 1562=head3 Results
1529 1563
1530 name watchers bytes create invoke destroy comment 1564 name watchers bytes create invoke destroy comment
1531 EV/EV 400000 244 0.56 0.46 0.31 EV native interface 1565 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 1566 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 1567 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 1568 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 1569 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 1570 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers
1537 Glib/Any 16000 1357 98.22 12.41 54.00 quadratic behaviour 1571 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 1572 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 1573 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 1574 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select
1541 1575
1542=head3 Discussion 1576=head3 Discussion
1543 1577
1544The benchmark does I<not> measure scalability of the event loop very 1578The 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) 1579well. For example, a select-based event loop (such as the pure perl one)
1747watchers, as the management overhead dominates. 1781watchers, as the management overhead dominates.
1748 1782
1749=back 1783=back
1750 1784
1751 1785
1786=head1 SIGNALS
1787
1788AnyEvent currently installs handlers for these signals:
1789
1790=over 4
1791
1792=item SIGCHLD
1793
1794A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
1795emulation for event loops that do not support them natively. Also, some
1796event loops install a similar handler.
1797
1798=item SIGPIPE
1799
1800A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
1801when AnyEvent gets loaded.
1802
1803The rationale for this is that AnyEvent users usually do not really depend
1804on SIGPIPE delivery (which is purely an optimisation for shell use, or
1805badly-written programs), but C<SIGPIPE> can cause spurious and rare
1806program exits as a lot of people do not expect C<SIGPIPE> when writing to
1807some random socket.
1808
1809The rationale for installing a no-op handler as opposed to ignoring it is
1810that this way, the handler will be restored to defaults on exec.
1811
1812Feel free to install your own handler, or reset it to defaults.
1813
1814=back
1815
1816=cut
1817
1818$SIG{PIPE} = sub { }
1819 unless defined $SIG{PIPE};
1820
1821
1752=head1 FORK 1822=head1 FORK
1753 1823
1754Most event libraries are not fork-safe. The ones who are usually are 1824Most 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> 1825because they rely on inefficient but fork-safe C<select> or C<poll>
1756calls. Only L<EV> is fully fork-aware. 1826calls. Only L<EV> is fully fork-aware.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines