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.264 by root, Wed Jul 29 12:42:09 2009 UTC vs.
Revision 1.278 by root, Sun Aug 9 15:09:28 2009 UTC

181my variables are only visible after the statement in which they are 181my variables are only visible after the statement in which they are
182declared. 182declared.
183 183
184=head2 I/O WATCHERS 184=head2 I/O WATCHERS
185 185
186 $w = AnyEvent->io (
187 fh => <filehandle_or_fileno>,
188 poll => <"r" or "w">,
189 cb => <callback>,
190 );
191
186You can create an I/O watcher by calling the C<< AnyEvent->io >> method 192You can create an I/O watcher by calling the C<< AnyEvent->io >> method
187with the following mandatory key-value pairs as arguments: 193with the following mandatory key-value pairs as arguments:
188 194
189C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch 195C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
190for events (AnyEvent might or might not keep a reference to this file 196for events (AnyEvent might or might not keep a reference to this file
219 undef $w; 225 undef $w;
220 }); 226 });
221 227
222=head2 TIME WATCHERS 228=head2 TIME WATCHERS
223 229
230 $w = AnyEvent->timer (after => <seconds>, cb => <callback>);
231
232 $w = AnyEvent->timer (
233 after => <fractional_seconds>,
234 interval => <fractional_seconds>,
235 cb => <callback>,
236 );
237
224You can create a time watcher by calling the C<< AnyEvent->timer >> 238You can create a time watcher by calling the C<< AnyEvent->timer >>
225method with the following mandatory arguments: 239method with the following mandatory arguments:
226 240
227C<after> specifies after how many seconds (fractional values are 241C<after> specifies after how many seconds (fractional values are
228supported) the callback should be invoked. C<cb> is the callback to invoke 242supported) the callback should be invoked. C<cb> is the callback to invoke
355 369
356=back 370=back
357 371
358=head2 SIGNAL WATCHERS 372=head2 SIGNAL WATCHERS
359 373
374 $w = AnyEvent->signal (signal => <uppercase_signal_name>, cb => <callback>);
375
360You can watch for signals using a signal watcher, C<signal> is the signal 376You can watch for signals using a signal watcher, C<signal> is the signal
361I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl 377I<name> in uppercase and without any C<SIG> prefix, C<cb> is the Perl
362callback to be invoked whenever a signal occurs. 378callback to be invoked whenever a signal occurs.
363 379
364Although the callback might get passed parameters, their value and 380Although the callback might get passed parameters, their value and
383 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 }); 399 my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
384 400
385=head3 Signal Races, Delays and Workarounds 401=head3 Signal Races, Delays and Workarounds
386 402
387Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 403Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
388callbacks to signals in a generic way, which is a pity, as you cannot do 404callbacks to signals in a generic way, which is a pity, as you cannot
389race-free signal handling in perl. AnyEvent will try to do it's best, but 405do race-free signal handling in perl, requiring C libraries for
406this. AnyEvent will try to do it's best, which means in some cases,
390in some cases, signals will be delayed. The maximum time a signal might 407signals will be delayed. The maximum time a signal might be delayed is
391be delayed is specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 408specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This
392seconds). This variable can be changed only before the first signal 409variable can be changed only before the first signal watcher is created,
393watcher is created, and should be left alone otherwise. Higher values 410and should be left alone otherwise. This variable determines how often
411AnyEvent polls for signals (in case a wake-up was missed). Higher values
394will cause fewer spurious wake-ups, which is better for power and CPU 412will cause fewer spurious wake-ups, which is better for power and CPU
413saving.
414
395saving. All these problems can be avoided by installing the optional 415All these problems can be avoided by installing the optional
396L<Async::Interrupt> module. This will not work with inherently broken 416L<Async::Interrupt> module, which works with most event loops. It will not
397event loops such as L<Event> or L<Event::Lib> (and not with L<POE> 417work with inherently broken event loops such as L<Event> or L<Event::Lib>
398currently, as POE does it's own workaround with one-second latency). With 418(and not with L<POE> currently, as POE does it's own workaround with
399those, you just have to suffer the delays. 419one-second latency). For those, you just have to suffer the delays.
400 420
401=head2 CHILD PROCESS WATCHERS 421=head2 CHILD PROCESS WATCHERS
422
423 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
402 424
403You can also watch on a child process exit and catch its exit status. 425You can also watch on a child process exit and catch its exit status.
404 426
405The child process is specified by the C<pid> argument (one some backends, 427The child process is specified by the C<pid> argument (one some backends,
406using C<0> watches for any child process exit, on others this will 428using C<0> watches for any child process exit, on others this will
455 # do something else, then wait for process exit 477 # do something else, then wait for process exit
456 $done->recv; 478 $done->recv;
457 479
458=head2 IDLE WATCHERS 480=head2 IDLE WATCHERS
459 481
482 $w = AnyEvent->idle (cb => <callback>);
483
460Sometimes there is a need to do something, but it is not so important 484Sometimes there is a need to do something, but it is not so important
461to do it instantly, but only when there is nothing better to do. This 485to do it instantly, but only when there is nothing better to do. This
462"nothing better to do" is usually defined to be "no other events need 486"nothing better to do" is usually defined to be "no other events need
463attention by the event loop". 487attention by the event loop".
464 488
490 }); 514 });
491 }); 515 });
492 516
493=head2 CONDITION VARIABLES 517=head2 CONDITION VARIABLES
494 518
519 $cv = AnyEvent->condvar;
520
521 $cv->send (<list>);
522 my @res = $cv->recv;
523
495If you are familiar with some event loops you will know that all of them 524If you are familiar with some event loops you will know that all of them
496require you to run some blocking "loop", "run" or similar function that 525require you to run some blocking "loop", "run" or similar function that
497will actively watch for new events and call your callbacks. 526will actively watch for new events and call your callbacks.
498 527
499AnyEvent is slightly different: it expects somebody else to run the event 528AnyEvent is slightly different: it expects somebody else to run the event
761=item $cb = $cv->cb ($cb->($cv)) 790=item $cb = $cv->cb ($cb->($cv))
762 791
763This is a mutator function that returns the callback set and optionally 792This is a mutator function that returns the callback set and optionally
764replaces it before doing so. 793replaces it before doing so.
765 794
766The callback will be called when the condition becomes "true", i.e. when 795The callback will be called when the condition becomes (or already was)
767C<send> or C<croak> are called, with the only argument being the condition 796"true", i.e. when C<send> or C<croak> are called (or were called), with
768variable itself. Calling C<recv> inside the callback or at any later time 797the only argument being the condition variable itself. Calling C<recv>
769is guaranteed not to block. 798inside the callback or at any later time is guaranteed not to block.
770 799
771=back 800=back
772 801
773=head1 SUPPORTED EVENT LOOPS/BACKENDS 802=head1 SUPPORTED EVENT LOOPS/BACKENDS
774 803
777=over 4 806=over 4
778 807
779=item Backends that are autoprobed when no other event loop can be found. 808=item Backends that are autoprobed when no other event loop can be found.
780 809
781EV is the preferred backend when no other event loop seems to be in 810EV is the preferred backend when no other event loop seems to be in
782use. If EV is not installed, then AnyEvent will try Event, and, failing 811use. If EV is not installed, then AnyEvent will fall back to its own
783that, will fall back to its own pure-perl implementation, which is 812pure-perl implementation, which is available everywhere as it comes with
784available everywhere as it comes with AnyEvent itself. 813AnyEvent itself.
785 814
786 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 815 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
787 AnyEvent::Impl::Event based on Event, very stable, few glitches.
788 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 816 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
789 817
790=item Backends that are transparently being picked up when they are used. 818=item Backends that are transparently being picked up when they are used.
791 819
792These will be used when they are currently loaded when the first watcher 820These will be used when they are currently loaded when the first watcher
793is created, in which case it is assumed that the application is using 821is created, in which case it is assumed that the application is using
794them. This means that AnyEvent will automatically pick the right backend 822them. This means that AnyEvent will automatically pick the right backend
795when the main program loads an event module before anything starts to 823when the main program loads an event module before anything starts to
796create watchers. Nothing special needs to be done by the main program. 824create watchers. Nothing special needs to be done by the main program.
797 825
826 AnyEvent::Impl::Event based on Event, very stable, few glitches.
798 AnyEvent::Impl::Glib based on Glib, slow but very stable. 827 AnyEvent::Impl::Glib based on Glib, slow but very stable.
799 AnyEvent::Impl::Tk based on Tk, very broken. 828 AnyEvent::Impl::Tk based on Tk, very broken.
800 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
801 AnyEvent::Impl::POE based on POE, very slow, some limitations. 830 AnyEvent::Impl::POE based on POE, very slow, some limitations.
802 AnyEvent::Impl::Irssi used when running within irssi. 831 AnyEvent::Impl::Irssi used when running within irssi.
1086 1115
1087BEGIN { AnyEvent::common_sense } 1116BEGIN { AnyEvent::common_sense }
1088 1117
1089use Carp (); 1118use Carp ();
1090 1119
1091our $VERSION = 4.881; 1120our $VERSION = 4.92;
1092our $MODEL; 1121our $MODEL;
1093 1122
1094our $AUTOLOAD; 1123our $AUTOLOAD;
1095our @ISA; 1124our @ISA;
1096 1125
1122 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1123} 1152}
1124 1153
1125my @models = ( 1154my @models = (
1126 [EV:: => AnyEvent::Impl::EV:: , 1], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
1127 [Event:: => AnyEvent::Impl::Event::, 1],
1128 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1156 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1129 # everything below here will not (normally) be autoprobed 1157 # everything below here will not (normally) be autoprobed
1130 # as the pureperl backend should work everywhere 1158 # as the pureperl backend should work everywhere
1131 # and is usually faster 1159 # and is usually faster
1160 [Event:: => AnyEvent::Impl::Event::, 1],
1132 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1133 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1134 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1135 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1136 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1139 [Prima:: => AnyEvent::Impl::POE::], 1168 [Prima:: => AnyEvent::Impl::POE::],
1140 # IO::Async is just too broken - we would need workarounds for its 1169 # IO::Async is just too broken - we would need workarounds for its
1141 # byzantine signal and broken child handling, among others. 1170 # byzantine signal and broken child handling, among others.
1142 # IO::Async is rather hard to detect, as it doesn't have any 1171 # IO::Async is rather hard to detect, as it doesn't have any
1143 # obvious default class. 1172 # obvious default class.
1144# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1173 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1145# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1146# [0, IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program 1175 [IO::Async::Notifier:: => AnyEvent::Impl::IOAsync::], # requires special main program
1176 [AnyEvent::Impl::IOAsync:: => AnyEvent::Impl::IOAsync::], # requires special main program
1147); 1177);
1148 1178
1149our %method = map +($_ => 1), 1179our %method = map +($_ => 1),
1150 qw(io timer time now now_update signal child idle condvar one_event DESTROY); 1180 qw(io timer time now now_update signal child idle condvar one_event DESTROY);
1151 1181
1258 # we assume CLOEXEC is already set by perl in all important cases 1288 # we assume CLOEXEC is already set by perl in all important cases
1259 1289
1260 ($fh2, $rw) 1290 ($fh2, $rw)
1261} 1291}
1262 1292
1293=head1 SIMPLIFIED AE API
1294
1295Starting with version 5.0, AnyEvent officially supports a second, much
1296simpler, API that is designed to reduce the calling, typing and memory
1297overhead.
1298
1299See the L<AE> manpage for details.
1300
1301=cut
1302
1303package AE;
1304
1305our $VERSION = $AnyEvent::VERSION;
1306
1307sub io($$$) {
1308 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1309}
1310
1311sub timer($$$) {
1312 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2])
1313}
1314
1315sub signal($$) {
1316 AnyEvent->signal (signal => $_[0], cb => $_[1])
1317}
1318
1319sub child($$) {
1320 AnyEvent->child (pid => $_[0], cb => $_[1])
1321}
1322
1323sub idle($) {
1324 AnyEvent->idle (cb => $_[0])
1325}
1326
1327sub cv(;&) {
1328 AnyEvent->condvar (@_ ? (cb => $_[0]) : ())
1329}
1330
1331sub now() {
1332 AnyEvent->now
1333}
1334
1335sub now_update() {
1336 AnyEvent->now_update
1337}
1338
1339sub time() {
1340 AnyEvent->time
1341}
1342
1263package AnyEvent::Base; 1343package AnyEvent::Base;
1264 1344
1265# default implementations for many methods 1345# default implementations for many methods
1266 1346
1267sub _time { 1347sub _time {
1319 1399
1320# install a dummy wakeup watcher to reduce signal catching latency 1400# install a dummy wakeup watcher to reduce signal catching latency
1321sub _sig_add() { 1401sub _sig_add() {
1322 unless ($SIG_COUNT++) { 1402 unless ($SIG_COUNT++) {
1323 # try to align timer on a full-second boundary, if possible 1403 # try to align timer on a full-second boundary, if possible
1324 my $NOW = AnyEvent->now; 1404 my $NOW = AE::now;
1325 1405
1326 $SIG_TW = AnyEvent->timer ( 1406 $SIG_TW = AE::timer
1327 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1407 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1328 interval => $MAX_SIGNAL_LATENCY, 1408 $MAX_SIGNAL_LATENCY,
1329 cb => sub { }, # just for the PERL_ASYNC_CHECK 1409 sub { } # just for the PERL_ASYNC_CHECK
1330 ); 1410 ;
1331 } 1411 }
1332} 1412}
1333 1413
1334sub _sig_del { 1414sub _sig_del {
1335 undef $SIG_TW 1415 undef $SIG_TW
1336 unless --$SIG_COUNT; 1416 unless --$SIG_COUNT;
1337} 1417}
1338 1418
1339our $_sig_name_init; $_sig_name_init = sub { 1419our $_sig_name_init; $_sig_name_init = sub {
1420 eval q{ # poor man's autoloading
1340 undef $_sig_name_init; 1421 undef $_sig_name_init;
1341 1422
1342 if (_have_async_interrupt) { 1423 if (_have_async_interrupt) {
1343 *sig2num = \&Async::Interrupt::sig2num; 1424 *sig2num = \&Async::Interrupt::sig2num;
1344 *sig2name = \&Async::Interrupt::sig2name; 1425 *sig2name = \&Async::Interrupt::sig2name;
1345 } else { 1426 } else {
1346 require Config; 1427 require Config;
1347 1428
1348 my %signame2num; 1429 my %signame2num;
1349 @signame2num{ split ' ', $Config::Config{sig_name} } 1430 @signame2num{ split ' ', $Config::Config{sig_name} }
1350 = split ' ', $Config::Config{sig_num}; 1431 = split ' ', $Config::Config{sig_num};
1351 1432
1352 my @signum2name; 1433 my @signum2name;
1353 @signum2name[values %signame2num] = keys %signame2num; 1434 @signum2name[values %signame2num] = keys %signame2num;
1354 1435
1355 *sig2num = sub($) { 1436 *sig2num = sub($) {
1356 $_[0] > 0 ? shift : $signame2num{+shift} 1437 $_[0] > 0 ? shift : $signame2num{+shift}
1357 }; 1438 };
1358 *sig2name = sub ($) { 1439 *sig2name = sub ($) {
1359 $_[0] > 0 ? $signum2name[+shift] : shift 1440 $_[0] > 0 ? $signum2name[+shift] : shift
1441 };
1360 }; 1442 }
1361 } 1443 };
1444 die if $@;
1362}; 1445};
1363 1446
1364sub sig2num ($) { &$_sig_name_init; &sig2num } 1447sub sig2num ($) { &$_sig_name_init; &sig2num }
1365sub sig2name($) { &$_sig_name_init; &sig2name } 1448sub sig2name($) { &$_sig_name_init; &sig2name }
1366 1449
1367sub _signal { 1450sub signal {
1451 eval q{ # poor man's autoloading {}
1452 # probe for availability of Async::Interrupt
1453 if (_have_async_interrupt) {
1454 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1455
1456 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1457 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1458
1459 } else {
1460 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1461
1462 require Fcntl;
1463
1464 if (AnyEvent::WIN32) {
1465 require AnyEvent::Util;
1466
1467 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1468 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R, 1) if $SIGPIPE_R;
1469 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W, 1) if $SIGPIPE_W; # just in case
1470 } else {
1471 pipe $SIGPIPE_R, $SIGPIPE_W;
1472 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1473 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1474
1475 # not strictly required, as $^F is normally 2, but let's make sure...
1476 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1477 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1478 }
1479
1480 $SIGPIPE_R
1481 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1482
1483 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1484 }
1485
1486 *signal = sub {
1368 my (undef, %arg) = @_; 1487 my (undef, %arg) = @_;
1369 1488
1370 my $signal = uc $arg{signal} 1489 my $signal = uc $arg{signal}
1371 or Carp::croak "required option 'signal' is missing"; 1490 or Carp::croak "required option 'signal' is missing";
1372 1491
1373 if ($HAVE_ASYNC_INTERRUPT) { 1492 if ($HAVE_ASYNC_INTERRUPT) {
1374 # async::interrupt 1493 # async::interrupt
1375 1494
1376 $signal = sig2num $signal; 1495 $signal = sig2num $signal;
1377 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1496 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1378 1497
1379 $SIG_ASY{$signal} ||= new Async::Interrupt 1498 $SIG_ASY{$signal} ||= new Async::Interrupt
1380 cb => sub { undef $SIG_EV{$signal} }, 1499 cb => sub { undef $SIG_EV{$signal} },
1381 signal => $signal, 1500 signal => $signal,
1382 pipe => [$SIGPIPE_R->filenos], 1501 pipe => [$SIGPIPE_R->filenos],
1383 pipe_autodrain => 0, 1502 pipe_autodrain => 0,
1384 ; 1503 ;
1385 1504
1386 } else { 1505 } else {
1387 # pure perl 1506 # pure perl
1388 1507
1389 # AE::Util has been loaded in signal 1508 # AE::Util has been loaded in signal
1390 $signal = sig2name $signal; 1509 $signal = sig2name $signal;
1391 $SIG_CB{$signal}{$arg{cb}} = $arg{cb}; 1510 $SIG_CB{$signal}{$arg{cb}} = $arg{cb};
1392 1511
1393 $SIG{$signal} ||= sub { 1512 $SIG{$signal} ||= sub {
1394 local $!; 1513 local $!;
1395 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV; 1514 syswrite $SIGPIPE_W, "\x00", 1 unless %SIG_EV;
1396 undef $SIG_EV{$signal}; 1515 undef $SIG_EV{$signal};
1516 };
1517
1518 # can't do signal processing without introducing races in pure perl,
1519 # so limit the signal latency.
1520 _sig_add;
1521 }
1522
1523 bless [$signal, $arg{cb}], "AnyEvent::Base::signal"
1397 }; 1524 };
1398 1525
1399 # can't do signal processing without introducing races in pure perl, 1526 *AnyEvent::Base::signal::DESTROY = sub {
1400 # so limit the signal latency. 1527 my ($signal, $cb) = @{$_[0]};
1528
1401 _sig_add; 1529 _sig_del;
1402 }
1403 1530
1404 bless [$signal, $arg{cb}], "AnyEvent::Base::signal" 1531 delete $SIG_CB{$signal}{$cb};
1405}
1406 1532
1407sub signal { 1533 $HAVE_ASYNC_INTERRUPT
1408 # probe for availability of Async::Interrupt 1534 ? delete $SIG_ASY{$signal}
1409 if (_have_async_interrupt) { 1535 : # delete doesn't work with older perls - they then
1410 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1536 # print weird messages, or just unconditionally exit
1411 1537 # instead of getting the default action.
1412 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1538 undef $SIG{$signal}
1413 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1539 unless keys %{ $SIG_CB{$signal} };
1414
1415 } else {
1416 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1417
1418 require Fcntl;
1419
1420 if (AnyEvent::WIN32) {
1421 require AnyEvent::Util;
1422
1423 ($SIGPIPE_R, $SIGPIPE_W) = AnyEvent::Util::portable_pipe ();
1424 AnyEvent::Util::fh_nonblocking ($SIGPIPE_R) if $SIGPIPE_R;
1425 AnyEvent::Util::fh_nonblocking ($SIGPIPE_W) if $SIGPIPE_W; # just in case
1426 } else {
1427 pipe $SIGPIPE_R, $SIGPIPE_W;
1428 fcntl $SIGPIPE_R, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_R;
1429 fcntl $SIGPIPE_W, &Fcntl::F_SETFL, &Fcntl::O_NONBLOCK if $SIGPIPE_W; # just in case
1430
1431 # not strictly required, as $^F is normally 2, but let's make sure...
1432 fcntl $SIGPIPE_R, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1433 fcntl $SIGPIPE_W, &Fcntl::F_SETFD, &Fcntl::FD_CLOEXEC;
1434 } 1540 };
1435
1436 $SIGPIPE_R
1437 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1438
1439 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec);
1440 } 1541 };
1441 1542 die if $@;
1442 *signal = \&_signal;
1443 &signal 1543 &signal
1444}
1445
1446sub AnyEvent::Base::signal::DESTROY {
1447 my ($signal, $cb) = @{$_[0]};
1448
1449 _sig_del;
1450
1451 delete $SIG_CB{$signal}{$cb};
1452
1453 $HAVE_ASYNC_INTERRUPT
1454 ? delete $SIG_ASY{$signal}
1455 : # delete doesn't work with older perls - they then
1456 # print weird messages, or just unconditionally exit
1457 # instead of getting the default action.
1458 undef $SIG{$signal}
1459 unless keys %{ $SIG_CB{$signal} };
1460} 1544}
1461 1545
1462# default implementation for ->child 1546# default implementation for ->child
1463 1547
1464our %PID_CB; 1548our %PID_CB;
1493 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1577 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1494 ? 1 1578 ? 1
1495 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1579 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1496 1580
1497 unless ($CHLD_W) { 1581 unless ($CHLD_W) {
1498 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1582 $CHLD_W = AE::signal CHLD => \&_sigchld;
1499 # child could be a zombie already, so make at least one round 1583 # child could be a zombie already, so make at least one round
1500 &_sigchld; 1584 &_sigchld;
1501 } 1585 }
1502 1586
1503 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1587 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1529 # never use more then 50% of the time for the idle watcher, 1613 # never use more then 50% of the time for the idle watcher,
1530 # within some limits 1614 # within some limits
1531 $w = 0.0001 if $w < 0.0001; 1615 $w = 0.0001 if $w < 0.0001;
1532 $w = 5 if $w > 5; 1616 $w = 5 if $w > 5;
1533 1617
1534 $w = AnyEvent->timer (after => $w, cb => $rcb); 1618 $w = AE::timer $w, 0, $rcb;
1535 } else { 1619 } else {
1536 # clean up... 1620 # clean up...
1537 undef $w; 1621 undef $w;
1538 undef $rcb; 1622 undef $rcb;
1539 } 1623 }
1540 }; 1624 };
1541 1625
1542 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1626 $w = AE::timer 0.05, 0, $rcb;
1543 1627
1544 bless \\$cb, "AnyEvent::Base::idle" 1628 bless \\$cb, "AnyEvent::Base::idle"
1545} 1629}
1546 1630
1547sub AnyEvent::Base::idle::DESTROY { 1631sub AnyEvent::Base::idle::DESTROY {
1601 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak}; 1685 Carp::croak $_[0]{_ae_croak} if $_[0]{_ae_croak};
1602 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0] 1686 wantarray ? @{ $_[0]{_ae_sent} } : $_[0]{_ae_sent}[0]
1603} 1687}
1604 1688
1605sub cb { 1689sub cb {
1606 $_[0]{_ae_cb} = $_[1] if @_ > 1; 1690 my $cv = shift;
1691
1692 @_
1693 and $cv->{_ae_cb} = shift
1694 and $cv->{_ae_sent}
1695 and (delete $cv->{_ae_cb})->($cv);
1696
1607 $_[0]{_ae_cb} 1697 $cv->{_ae_cb}
1608} 1698}
1609 1699
1610sub begin { 1700sub begin {
1611 ++$_[0]{_ae_counter}; 1701 ++$_[0]{_ae_counter};
1612 $_[0]{_ae_end_cb} = $_[1] if @_ > 1; 1702 $_[0]{_ae_end_cb} = $_[1] if @_ > 1;
1971through AnyEvent. The benchmark creates a lot of timers (with a zero 2061through AnyEvent. The benchmark creates a lot of timers (with a zero
1972timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2062timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
1973which it is), lets them fire exactly once and destroys them again. 2063which it is), lets them fire exactly once and destroys them again.
1974 2064
1975Source code for this benchmark is found as F<eg/bench> in the AnyEvent 2065Source code for this benchmark is found as F<eg/bench> in the AnyEvent
1976distribution. 2066distribution. It uses the L<AE> interface, which makes a real difference
2067for the EV and Perl backends only.
1977 2068
1978=head3 Explanation of the columns 2069=head3 Explanation of the columns
1979 2070
1980I<watcher> is the number of event watchers created/destroyed. Since 2071I<watcher> is the number of event watchers created/destroyed. Since
1981different event models feature vastly different performances, each event 2072different event models feature vastly different performances, each event
2002watcher. 2093watcher.
2003 2094
2004=head3 Results 2095=head3 Results
2005 2096
2006 name watchers bytes create invoke destroy comment 2097 name watchers bytes create invoke destroy comment
2007 EV/EV 400000 224 0.47 0.35 0.27 EV native interface 2098 EV/EV 100000 223 0.47 0.43 0.27 EV native interface
2008 EV/Any 100000 224 2.88 0.34 0.27 EV + AnyEvent watchers 2099 EV/Any 100000 223 0.48 0.42 0.26 EV + AnyEvent watchers
2009 CoroEV/Any 100000 224 2.85 0.35 0.28 coroutines + Coro::Signal 2100 Coro::EV/Any 100000 223 0.47 0.42 0.26 coroutines + Coro::Signal
2010 Perl/Any 100000 452 4.13 0.73 0.95 pure perl implementation 2101 Perl/Any 100000 431 2.70 0.74 0.92 pure perl implementation
2011 Event/Event 16000 517 32.20 31.80 0.81 Event native interface 2102 Event/Event 16000 516 31.16 31.84 0.82 Event native interface
2012 Event/Any 16000 590 35.85 31.55 1.06 Event + AnyEvent watchers 2103 Event/Any 16000 1203 42.61 34.79 1.80 Event + AnyEvent watchers
2013 IOAsync/Any 16000 989 38.10 32.77 11.13 via IO::Async::Loop::IO_Poll 2104 IOAsync/Any 16000 1911 41.92 27.45 16.81 via IO::Async::Loop::IO_Poll
2014 IOAsync/Any 16000 990 37.59 29.50 10.61 via IO::Async::Loop::Epoll 2105 IOAsync/Any 16000 1726 40.69 26.37 15.25 via IO::Async::Loop::Epoll
2015 Glib/Any 16000 1357 102.33 12.31 51.00 quadratic behaviour 2106 Glib/Any 16000 1118 89.00 12.57 51.17 quadratic behaviour
2016 Tk/Any 2000 1860 27.20 66.31 14.00 SEGV with >> 2000 watchers 2107 Tk/Any 2000 1346 20.96 10.75 8.00 SEGV with >> 2000 watchers
2017 POE/Event 2000 6328 109.99 751.67 14.02 via POE::Loop::Event 2108 POE/Any 2000 6951 108.97 795.32 14.24 via POE::Loop::Event
2018 POE/Select 2000 6027 94.54 809.13 579.80 via POE::Loop::Select 2109 POE/Any 2000 6648 94.79 774.40 575.51 via POE::Loop::Select
2019 2110
2020=head3 Discussion 2111=head3 Discussion
2021 2112
2022The benchmark does I<not> measure scalability of the event loop very 2113The benchmark does I<not> measure scalability of the event loop very
2023well. For example, a select-based event loop (such as the pure perl one) 2114well. For example, a select-based event loop (such as the pure perl one)
2035benchmark machine, handling an event takes roughly 1600 CPU cycles with 2126benchmark machine, handling an event takes roughly 1600 CPU cycles with
2036EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU 2127EV, 3100 CPU cycles with AnyEvent's pure perl loop and almost 3000000 CPU
2037cycles with POE. 2128cycles with POE.
2038 2129
2039C<EV> is the sole leader regarding speed and memory use, which are both 2130C<EV> is the sole leader regarding speed and memory use, which are both
2040maximal/minimal, respectively. Even when going through AnyEvent, it uses 2131maximal/minimal, respectively. When using the L<AE> API there is zero
2132overhead (when going through the AnyEvent API create is about 5-6 times
2133slower, with other times being equal, so still uses far less memory than
2041far less memory than any other event loop and is still faster than Event 2134any other event loop and is still faster than Event natively).
2042natively.
2043 2135
2044The pure perl implementation is hit in a few sweet spots (both the 2136The pure perl implementation is hit in a few sweet spots (both the
2045constant timeout and the use of a single fd hit optimisations in the perl 2137constant timeout and the use of a single fd hit optimisations in the perl
2046interpreter and the backend itself). Nevertheless this shows that it 2138interpreter and the backend itself). Nevertheless this shows that it
2047adds very little overhead in itself. Like any select-based backend its 2139adds very little overhead in itself. Like any select-based backend its
2121In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100 2213In this benchmark, we use 10000 socket pairs (20000 sockets), of which 100
2122(1%) are active. This mirrors the activity of large servers with many 2214(1%) are active. This mirrors the activity of large servers with many
2123connections, most of which are idle at any one point in time. 2215connections, most of which are idle at any one point in time.
2124 2216
2125Source code for this benchmark is found as F<eg/bench2> in the AnyEvent 2217Source code for this benchmark is found as F<eg/bench2> in the AnyEvent
2126distribution. 2218distribution. It uses the L<AE> interface, which makes a real difference
2219for the EV and Perl backends only.
2127 2220
2128=head3 Explanation of the columns 2221=head3 Explanation of the columns
2129 2222
2130I<sockets> is the number of sockets, and twice the number of "servers" (as 2223I<sockets> is the number of sockets, and twice the number of "servers" (as
2131each server has a read and write socket end). 2224each server has a read and write socket end).
2139a new one that moves the timeout into the future. 2232a new one that moves the timeout into the future.
2140 2233
2141=head3 Results 2234=head3 Results
2142 2235
2143 name sockets create request 2236 name sockets create request
2144 EV 20000 69.01 11.16 2237 EV 20000 62.66 7.99
2145 Perl 20000 73.32 35.87 2238 Perl 20000 68.32 32.64
2146 IOAsync 20000 157.00 98.14 epoll 2239 IOAsync 20000 174.06 101.15 epoll
2147 IOAsync 20000 159.31 616.06 poll 2240 IOAsync 20000 174.67 610.84 poll
2148 Event 20000 212.62 257.32 2241 Event 20000 202.69 242.91
2149 Glib 20000 651.16 1896.30 2242 Glib 20000 557.01 1689.52
2150 POE 20000 349.67 12317.24 uses POE::Loop::Event 2243 POE 20000 341.54 12086.32 uses POE::Loop::Event
2151 2244
2152=head3 Discussion 2245=head3 Discussion
2153 2246
2154This benchmark I<does> measure scalability and overall performance of the 2247This benchmark I<does> measure scalability and overall performance of the
2155particular event loop. 2248particular event loop.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines