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.270 by root, Fri Jul 31 20:16:34 2009 UTC vs.
Revision 1.279 by root, Sun Aug 9 16:05:11 2009 UTC

806=over 4 806=over 4
807 807
808=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.
809 809
810EV 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
811use. 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
812that, will fall back to its own pure-perl implementation, which is 812pure-perl implementation, which is available everywhere as it comes with
813available everywhere as it comes with AnyEvent itself. 813AnyEvent itself.
814 814
815 AnyEvent::Impl::EV based on EV (interface to libev, best choice). 815 AnyEvent::Impl::EV based on EV (interface to libev, best choice).
816 AnyEvent::Impl::Event based on Event, very stable, few glitches.
817 AnyEvent::Impl::Perl pure-perl implementation, fast and portable. 816 AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
818 817
819=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.
820 819
821These 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
822is 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
823them. This means that AnyEvent will automatically pick the right backend 822them. This means that AnyEvent will automatically pick the right backend
824when the main program loads an event module before anything starts to 823when the main program loads an event module before anything starts to
825create watchers. Nothing special needs to be done by the main program. 824create watchers. Nothing special needs to be done by the main program.
826 825
826 AnyEvent::Impl::Event based on Event, very stable, few glitches.
827 AnyEvent::Impl::Glib based on Glib, slow but very stable. 827 AnyEvent::Impl::Glib based on Glib, slow but very stable.
828 AnyEvent::Impl::Tk based on Tk, very broken. 828 AnyEvent::Impl::Tk based on Tk, very broken.
829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse. 829 AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
830 AnyEvent::Impl::POE based on POE, very slow, some limitations. 830 AnyEvent::Impl::POE based on POE, very slow, some limitations.
831 AnyEvent::Impl::Irssi used when running within irssi. 831 AnyEvent::Impl::Irssi used when running within irssi.
1115 1115
1116BEGIN { AnyEvent::common_sense } 1116BEGIN { AnyEvent::common_sense }
1117 1117
1118use Carp (); 1118use Carp ();
1119 1119
1120our $VERSION = 4.9; 1120our $VERSION = '5.0';
1121our $MODEL; 1121our $MODEL;
1122 1122
1123our $AUTOLOAD; 1123our $AUTOLOAD;
1124our @ISA; 1124our @ISA;
1125 1125
1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6"; 1151 $ENV{PERL_ANYEVENT_PROTOCOLS} || "ipv4,ipv6";
1152} 1152}
1153 1153
1154my @models = ( 1154my @models = (
1155 [EV:: => AnyEvent::Impl::EV:: , 1], 1155 [EV:: => AnyEvent::Impl::EV:: , 1],
1156 [Event:: => AnyEvent::Impl::Event::, 1],
1157 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1], 1156 [AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl:: , 1],
1158 # everything below here will not (normally) be autoprobed 1157 # everything below here will not (normally) be autoprobed
1159 # as the pureperl backend should work everywhere 1158 # as the pureperl backend should work everywhere
1160 # and is usually faster 1159 # and is usually faster
1160 [Event:: => AnyEvent::Impl::Event::, 1],
1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers 1161 [Glib:: => AnyEvent::Impl::Glib:: , 1], # becomes extremely slow with many watchers
1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy 1162 [Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package 1163 [Irssi:: => AnyEvent::Impl::Irssi::], # Irssi has a bogus "Event" package
1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles 1164 [Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program 1165 [Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1168 [Prima:: => AnyEvent::Impl::POE::], 1168 [Prima:: => AnyEvent::Impl::POE::],
1169 # 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
1170 # byzantine signal and broken child handling, among others. 1170 # byzantine signal and broken child handling, among others.
1171 # 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
1172 # obvious default class. 1172 # obvious default class.
1173# [0, IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program 1173 [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1174# [0, IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program 1174 [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
1175# [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
1176); 1177);
1177 1178
1178our %method = map +($_ => 1), 1179our %method = map +($_ => 1),
1179 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);
1180 1181
1287 # 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
1288 1289
1289 ($fh2, $rw) 1290 ($fh2, $rw)
1290} 1291}
1291 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
1292package AnyEvent::Base; 1343package AnyEvent::Base;
1293 1344
1294# default implementations for many methods 1345# default implementations for many methods
1295 1346
1296sub _time { 1347sub _time {
1348 1399
1349# install a dummy wakeup watcher to reduce signal catching latency 1400# install a dummy wakeup watcher to reduce signal catching latency
1350sub _sig_add() { 1401sub _sig_add() {
1351 unless ($SIG_COUNT++) { 1402 unless ($SIG_COUNT++) {
1352 # try to align timer on a full-second boundary, if possible 1403 # try to align timer on a full-second boundary, if possible
1353 my $NOW = AnyEvent->now; 1404 my $NOW = AE::now;
1354 1405
1355 $SIG_TW = AnyEvent->timer ( 1406 $SIG_TW = AE::timer
1356 after => $MAX_SIGNAL_LATENCY - ($NOW - int $NOW), 1407 $MAX_SIGNAL_LATENCY - ($NOW - int $NOW),
1357 interval => $MAX_SIGNAL_LATENCY, 1408 $MAX_SIGNAL_LATENCY,
1358 cb => sub { }, # just for the PERL_ASYNC_CHECK 1409 sub { } # just for the PERL_ASYNC_CHECK
1359 ); 1410 ;
1360 } 1411 }
1361} 1412}
1362 1413
1363sub _sig_del { 1414sub _sig_del {
1364 undef $SIG_TW 1415 undef $SIG_TW
1401 # probe for availability of Async::Interrupt 1452 # probe for availability of Async::Interrupt
1402 if (_have_async_interrupt) { 1453 if (_have_async_interrupt) {
1403 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8; 1454 warn "AnyEvent: using Async::Interrupt for race-free signal handling.\n" if $VERBOSE >= 8;
1404 1455
1405 $SIGPIPE_R = new Async::Interrupt::EventPipe; 1456 $SIGPIPE_R = new Async::Interrupt::EventPipe;
1406 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R->fileno, poll => "r", cb => \&_signal_exec); 1457 $SIG_IO = AE::io $SIGPIPE_R->fileno, 0, \&_signal_exec;
1407 1458
1408 } else { 1459 } else {
1409 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8; 1460 warn "AnyEvent: using emulated perl signal handling with latency timer.\n" if $VERBOSE >= 8;
1410 1461
1411 require Fcntl; 1462 require Fcntl;
1427 } 1478 }
1428 1479
1429 $SIGPIPE_R 1480 $SIGPIPE_R
1430 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n"; 1481 or Carp::croak "AnyEvent: unable to create a signal reporting pipe: $!\n";
1431 1482
1432 $SIG_IO = AnyEvent->io (fh => $SIGPIPE_R, poll => "r", cb => \&_signal_exec); 1483 $SIG_IO = AE::io $SIGPIPE_R, 0, \&_signal_exec;
1433 } 1484 }
1434 1485
1435 *signal = sub { 1486 *signal = sub {
1436 my (undef, %arg) = @_; 1487 my (undef, %arg) = @_;
1437 1488
1526 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/ 1577 $WNOHANG ||= $^O =~ /^(?:openbsd|netbsd|linux|freebsd|cygwin|MSWin32)$/
1527 ? 1 1578 ? 1
1528 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1; 1579 : eval { local $SIG{__DIE__}; require POSIX; &POSIX::WNOHANG } || 1;
1529 1580
1530 unless ($CHLD_W) { 1581 unless ($CHLD_W) {
1531 $CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld); 1582 $CHLD_W = AE::signal CHLD => \&_sigchld;
1532 # 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
1533 &_sigchld; 1584 &_sigchld;
1534 } 1585 }
1535 1586
1536 bless [$pid, $arg{cb}], "AnyEvent::Base::child" 1587 bless [$pid, $arg{cb}], "AnyEvent::Base::child"
1562 # 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,
1563 # within some limits 1614 # within some limits
1564 $w = 0.0001 if $w < 0.0001; 1615 $w = 0.0001 if $w < 0.0001;
1565 $w = 5 if $w > 5; 1616 $w = 5 if $w > 5;
1566 1617
1567 $w = AnyEvent->timer (after => $w, cb => $rcb); 1618 $w = AE::timer $w, 0, $rcb;
1568 } else { 1619 } else {
1569 # clean up... 1620 # clean up...
1570 undef $w; 1621 undef $w;
1571 undef $rcb; 1622 undef $rcb;
1572 } 1623 }
1573 }; 1624 };
1574 1625
1575 $w = AnyEvent->timer (after => 0.05, cb => $rcb); 1626 $w = AE::timer 0.05, 0, $rcb;
1576 1627
1577 bless \\$cb, "AnyEvent::Base::idle" 1628 bless \\$cb, "AnyEvent::Base::idle"
1578} 1629}
1579 1630
1580sub AnyEvent::Base::idle::DESTROY { 1631sub AnyEvent::Base::idle::DESTROY {
1657} 1708}
1658 1709
1659# undocumented/compatibility with pre-3.4 1710# undocumented/compatibility with pre-3.4
1660*broadcast = \&send; 1711*broadcast = \&send;
1661*wait = \&_wait; 1712*wait = \&_wait;
1662
1663#############################################################################
1664# "new" API, currently only emulation of it
1665#############################################################################
1666
1667package AE;
1668
1669sub io($$$) {
1670 AnyEvent->io (fh => $_[0], poll => $_[1] ? "w" : "r", cb => $_[2])
1671}
1672
1673sub timer($$$) {
1674 AnyEvent->timer (after => $_[0], interval => $_[1], cb => $_[2]);
1675}
1676
1677sub signal($$) {
1678 AnyEvent->signal (signal => $_[0], cb => $_[1]);
1679}
1680
1681sub child($$) {
1682 AnyEvent->child (pid => $_[0], cb => $_[1]);
1683}
1684
1685sub idle($) {
1686 AnyEvent->idle (cb => $_[0]);
1687}
1688
1689sub cv() {
1690 AnyEvent->condvar
1691}
1692
1693sub now() {
1694 AnyEvent->now
1695}
1696
1697sub now_update() {
1698 AnyEvent->now_update
1699}
1700
1701sub time() {
1702 AnyEvent->time
1703}
1704 1713
1705=head1 ERROR AND EXCEPTION HANDLING 1714=head1 ERROR AND EXCEPTION HANDLING
1706 1715
1707In general, AnyEvent does not do any error handling - it relies on the 1716In general, AnyEvent does not do any error handling - it relies on the
1708caller to do that if required. The L<AnyEvent::Strict> module (see also 1717caller to do that if required. The L<AnyEvent::Strict> module (see also
2052through AnyEvent. The benchmark creates a lot of timers (with a zero 2061through AnyEvent. The benchmark creates a lot of timers (with a zero
2053timeout) and I/O watchers (watching STDOUT, a pty, to become writable, 2062timeout) and I/O watchers (watching STDOUT, a pty, to become writable,
2054which it is), lets them fire exactly once and destroys them again. 2063which it is), lets them fire exactly once and destroys them again.
2055 2064
2056Source 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
2057distribution. 2066distribution. It uses the L<AE> interface, which makes a real difference
2067for the EV and Perl backends only.
2058 2068
2059=head3 Explanation of the columns 2069=head3 Explanation of the columns
2060 2070
2061I<watcher> is the number of event watchers created/destroyed. Since 2071I<watcher> is the number of event watchers created/destroyed. Since
2062different event models feature vastly different performances, each event 2072different event models feature vastly different performances, each event
2083watcher. 2093watcher.
2084 2094
2085=head3 Results 2095=head3 Results
2086 2096
2087 name watchers bytes create invoke destroy comment 2097 name watchers bytes create invoke destroy comment
2088 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
2089 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
2090 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
2091 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
2092 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
2093 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
2094 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
2095 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
2096 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
2097 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
2098 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
2099 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
2100 2110
2101=head3 Discussion 2111=head3 Discussion
2102 2112
2103The benchmark does I<not> measure scalability of the event loop very 2113The benchmark does I<not> measure scalability of the event loop very
2104well. 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)
2116benchmark machine, handling an event takes roughly 1600 CPU cycles with 2126benchmark machine, handling an event takes roughly 1600 CPU cycles with
2117EV, 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
2118cycles with POE. 2128cycles with POE.
2119 2129
2120C<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
2121maximal/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
2122far less memory than any other event loop and is still faster than Event 2134any other event loop and is still faster than Event natively).
2123natively.
2124 2135
2125The 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
2126constant 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
2127interpreter and the backend itself). Nevertheless this shows that it 2138interpreter and the backend itself). Nevertheless this shows that it
2128adds very little overhead in itself. Like any select-based backend its 2139adds very little overhead in itself. Like any select-based backend its
2202In 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
2203(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
2204connections, most of which are idle at any one point in time. 2215connections, most of which are idle at any one point in time.
2205 2216
2206Source 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
2207distribution. 2218distribution. It uses the L<AE> interface, which makes a real difference
2219for the EV and Perl backends only.
2208 2220
2209=head3 Explanation of the columns 2221=head3 Explanation of the columns
2210 2222
2211I<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
2212each server has a read and write socket end). 2224each server has a read and write socket end).
2220a new one that moves the timeout into the future. 2232a new one that moves the timeout into the future.
2221 2233
2222=head3 Results 2234=head3 Results
2223 2235
2224 name sockets create request 2236 name sockets create request
2225 EV 20000 69.01 11.16 2237 EV 20000 62.66 7.99
2226 Perl 20000 73.32 35.87 2238 Perl 20000 68.32 32.64
2227 IOAsync 20000 157.00 98.14 epoll 2239 IOAsync 20000 174.06 101.15 epoll
2228 IOAsync 20000 159.31 616.06 poll 2240 IOAsync 20000 174.67 610.84 poll
2229 Event 20000 212.62 257.32 2241 Event 20000 202.69 242.91
2230 Glib 20000 651.16 1896.30 2242 Glib 20000 557.01 1689.52
2231 POE 20000 349.67 12317.24 uses POE::Loop::Event 2243 POE 20000 341.54 12086.32 uses POE::Loop::Event
2232 2244
2233=head3 Discussion 2245=head3 Discussion
2234 2246
2235This benchmark I<does> measure scalability and overall performance of the 2247This benchmark I<does> measure scalability and overall performance of the
2236particular event loop. 2248particular event loop.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines