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.385 by root, Mon Sep 5 08:51:14 2011 UTC vs.
Revision 1.396 by root, Sat Mar 10 17:36:24 2012 UTC

415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's 415not restart syscalls (that includes L<Async::Interrupt> and AnyEvent's
416pure perl implementation). 416pure perl implementation).
417 417
418=head3 Safe/Unsafe Signals 418=head3 Safe/Unsafe Signals
419 419
420Perl signals can be either "safe" (synchronous to opcode handling) or 420Perl signals can be either "safe" (synchronous to opcode handling)
421"unsafe" (asynchronous) - the former might get delayed indefinitely, the 421or "unsafe" (asynchronous) - the former might delay signal delivery
422latter might corrupt your memory. 422indefinitely, the latter might corrupt your memory.
423 423
424AnyEvent signal handlers are, in addition, synchronous to the event loop, 424AnyEvent signal handlers are, in addition, synchronous to the event loop,
425i.e. they will not interrupt your running perl program but will only be 425i.e. they will not interrupt your running perl program but will only be
426called as part of the normal event handling (just like timer, I/O etc. 426called as part of the normal event handling (just like timer, I/O etc.
427callbacks, too). 427callbacks, too).
428 428
429=head3 Signal Races, Delays and Workarounds 429=head3 Signal Races, Delays and Workarounds
430 430
431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching 431Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support
432callbacks to signals in a generic way, which is a pity, as you cannot 432attaching callbacks to signals in a generic way, which is a pity,
433do race-free signal handling in perl, requiring C libraries for 433as you cannot do race-free signal handling in perl, requiring
434this. AnyEvent will try to do its best, which means in some cases, 434C libraries for this. AnyEvent will try to do its best, which
435signals will be delayed. The maximum time a signal might be delayed is 435means in some cases, signals will be delayed. The maximum time
436specified in C<$AnyEvent::MAX_SIGNAL_LATENCY> (default: 10 seconds). This 436a signal might be delayed is 10 seconds by default, but can
437variable can be changed only before the first signal watcher is created, 437be overriden via C<$ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY}> or
438and should be left alone otherwise. This variable determines how often 438C<$AnyEvent::MAX_SIGNAL_LATENCY> - see the L<ENVIRONMENT VARIABLES>
439AnyEvent polls for signals (in case a wake-up was missed). Higher values 439section for details.
440will cause fewer spurious wake-ups, which is better for power and CPU
441saving.
442 440
443All these problems can be avoided by installing the optional 441All these problems can be avoided by installing the optional
444L<Async::Interrupt> module, which works with most event loops. It will not 442L<Async::Interrupt> module, which works with most event loops. It will not
445work with inherently broken event loops such as L<Event> or L<Event::Lib> 443work with inherently broken event loops such as L<Event> or L<Event::Lib>
446(and not with L<POE> currently, as POE does its own workaround with 444(and not with L<POE> currently). For those, you just have to suffer the
447one-second latency). For those, you just have to suffer the delays. 445delays.
448 446
449=head2 CHILD PROCESS WATCHERS 447=head2 CHILD PROCESS WATCHERS
450 448
451 $w = AnyEvent->child (pid => <process id>, cb => <callback>); 449 $w = AnyEvent->child (pid => <process id>, cb => <callback>);
452 450
1235 1233
1236BEGIN { AnyEvent::common_sense } 1234BEGIN { AnyEvent::common_sense }
1237 1235
1238use Carp (); 1236use Carp ();
1239 1237
1240our $VERSION = '6.02'; 1238our $VERSION = '6.14';
1241our $MODEL; 1239our $MODEL;
1242our @ISA; 1240our @ISA;
1243our @REGISTRY; 1241our @REGISTRY;
1244our $VERBOSE; 1242our $VERBOSE;
1245our $MAX_SIGNAL_LATENCY = 10;
1246our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred 1243our %PROTOCOL; # (ipv4|ipv6) => (1|2), higher numbers are preferred
1244our $MAX_SIGNAL_LATENCY = $ENV{PERL_ANYEVENT_MAX_SIGNAL_LATENCY} || 10; # executes after the BEGIN block below (tainting!)
1247 1245
1248BEGIN { 1246BEGIN {
1249 require "AnyEvent/constants.pl"; 1247 require "AnyEvent/constants.pl";
1250 1248
1251 eval "sub TAINT (){" . (${^TAINT}*1) . "}"; 1249 eval "sub TAINT (){" . (${^TAINT}*1) . "}";
1304} 1302}
1305 1303
1306sub log($$;@) { 1304sub log($$;@) {
1307 # only load the big bloated module when we actually are about to log something 1305 # only load the big bloated module when we actually are about to log something
1308 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal 1306 if ($_[0] <= ($VERBOSE || 1)) { # also catches non-numeric levels(!) and fatal
1307 local ($!, $@);
1309 require AnyEvent::Log; # among other things, sets $VERBOSE to 9 1308 require AnyEvent::Log; # among other things, sets $VERBOSE to 9
1310 # AnyEvent::Log overwrites this function 1309 # AnyEvent::Log overwrites this function
1311 goto &log; 1310 goto &log;
1312 } 1311 }
1313 1312
1314 0 # not logged 1313 0 # not logged
1315} 1314}
1316 1315
1317sub logger($;$) { 1316sub _logger($;$) {
1318 package AnyEvent::Log;
1319
1320 my ($level, $renabled) = @_; 1317 my ($level, $renabled) = @_;
1321 1318
1322 $$renabled = $level <= $VERBOSE; 1319 $$renabled = $level <= $VERBOSE;
1323 1320
1324 my $pkg = (caller)[0];
1325
1326 my $logger = [$pkg, $level, $renabled]; 1321 my $logger = [(caller)[0], $level, $renabled];
1327 1322
1328 our %LOGGER;
1329 $LOGGER{$logger+0} = $logger; 1323 $AnyEvent::Log::LOGGER{$logger+0} = $logger;
1330 1324
1325# return unless defined wantarray;
1326#
1331 require AnyEvent::Util; 1327# require AnyEvent::Util;
1332 my $guard = AnyEvent::Util::guard (sub { 1328# my $guard = AnyEvent::Util::guard (sub {
1333 # "clean up" 1329# # "clean up"
1334 delete $LOGGER{$logger+0}; 1330# delete $LOGGER{$logger+0};
1335 }); 1331# });
1336 1332#
1337 sub { 1333# sub {
1338 return 0 unless $$renabled; 1334# return 0 unless $$renabled;
1339 1335#
1340 $guard if 0; # keep guard alive, but don't cause runtime overhead 1336# $guard if 0; # keep guard alive, but don't cause runtime overhead
1341 require AnyEvent::Log unless $AnyEvent::Log::VERSION; 1337# require AnyEvent::Log unless $AnyEvent::Log::VERSION;
1342 package AnyEvent::Log; 1338# package AnyEvent::Log;
1343 _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time 1339# _log ($logger->[0], $level, @_) # logger->[0] has been converted at load time
1344 } 1340# }
1345} 1341}
1346 1342
1347if (length $ENV{PERL_ANYEVENT_LOG}) { 1343if (length $ENV{PERL_ANYEVENT_LOG}) {
1348 require AnyEvent::Log; # AnyEvent::Log does the thing for us 1344 require AnyEvent::Log; # AnyEvent::Log does the thing for us
1349} 1345}
1395our @methods = qw(io timer time now now_update signal child idle condvar); 1391our @methods = qw(io timer time now now_update signal child idle condvar);
1396 1392
1397sub detect() { 1393sub detect() {
1398 return $MODEL if $MODEL; # some programs keep references to detect 1394 return $MODEL if $MODEL; # some programs keep references to detect
1399 1395
1396 # IO::Async::Loop::AnyEvent is extremely evil, refuse to work with it
1397 # the author knows about the problems and what it does to AnyEvent as a whole
1398 # (and the ability of others to use AnyEvent), but simply wants to abuse AnyEvent
1399 # anyway.
1400 AnyEvent::log fatal => "AnyEvent: IO::Async::Loop::AnyEvent detected - that module is broken by\n"
1401 . "design, abuses internals and breaks AnyEvent - will not continue."
1402 if exists $INC{"IO/Async/Loop/AnyEvent.pm"};
1403
1400 local $!; # for good measure 1404 local $!; # for good measure
1401 local $SIG{__DIE__}; # we use eval 1405 local $SIG{__DIE__}; # we use eval
1402 1406
1403 # free some memory 1407 # free some memory
1404 *detect = sub () { $MODEL }; 1408 *detect = sub () { $MODEL };
1428 if (${"$package\::VERSION"} > 0) { 1432 if (${"$package\::VERSION"} > 0) {
1429 if (eval "require $model") { 1433 if (eval "require $model") {
1430 AnyEvent::log 7 => "autodetected model '$model', using it."; 1434 AnyEvent::log 7 => "autodetected model '$model', using it.";
1431 $MODEL = $model; 1435 $MODEL = $model;
1432 last; 1436 last;
1437 } else {
1438 AnyEvent::log 8 => "detected event loop $package, but cannot load '$model', skipping: $@";
1433 } 1439 }
1434 } 1440 }
1435 } 1441 }
1436 1442
1437 unless ($MODEL) { 1443 unless ($MODEL) {
2219 2225
2220The default value for the C<max_outstanding> parameter for the default DNS 2226The default value for the C<max_outstanding> parameter for the default DNS
2221resolver - this is the maximum number of parallel DNS requests that are 2227resolver - this is the maximum number of parallel DNS requests that are
2222sent to the DNS server. 2228sent to the DNS server.
2223 2229
2230=item C<PERL_ANYEVENT_MAX_SIGNAL_LATENCY>
2231
2232Perl has inherently racy signal handling (you can basically choose between
2233losing signals and memory corruption) - pure perl event loops (including
2234C<AnyEvent::Loop>, when C<Async::Interrupt> isn't available) therefore
2235have to poll regularly to avoid losing signals.
2236
2237Some event loops are racy, but don't poll regularly, and some event loops
2238are written in C but are still racy. For those event loops, AnyEvent
2239installs a timer that regularly wakes up the event loop.
2240
2241By default, the interval for this timer is C<10> seconds, but you can
2242override this delay with this environment variable (or by setting
2243the C<$AnyEvent::MAX_SIGNAL_LATENCY> variable before creating signal
2244watchers).
2245
2246Lower values increase CPU (and energy) usage, higher values can introduce
2247long delays when reaping children or waiting for signals.
2248
2249The L<AnyEvent::Async> module, if available, will be used to avoid this
2250polling (with most event loops).
2251
2224=item C<PERL_ANYEVENT_RESOLV_CONF> 2252=item C<PERL_ANYEVENT_RESOLV_CONF>
2225 2253
2226The absolute path to a F<resolv.conf>-style file to use instead of 2254The absolute path to a F<resolv.conf>-style file to use instead of
2227F</etc/resolv.conf> (or the OS-specific configuration) in the default 2255F</etc/resolv.conf> (or the OS-specific configuration) in the default
2228resolver, or the empty string to select the default configuration. 2256resolver, or the empty string to select the default configuration.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines