--- Coro/Coro.pm 2008/09/29 12:40:50 1.201 +++ Coro/Coro.pm 2008/12/13 22:08:13 1.244 @@ -1,6 +1,6 @@ =head1 NAME -Coro - coroutine process abstraction +Coro - the only real threads in perl =head1 SYNOPSIS @@ -28,37 +28,44 @@ =head1 DESCRIPTION -This module collection manages coroutines. Coroutines are similar to -threads but don't (in general) run in parallel at the same time even -on SMP machines. The specific flavor of coroutine used in this module -also guarantees you that it will not switch between coroutines unless -necessary, at easily-identified points in your program, so locking and -parallel access are rarely an issue, making coroutine programming much -safer and easier than threads programming. - -Unlike a normal perl program, however, coroutines allow you to have -multiple running interpreters that share data, which is especially useful -to code pseudo-parallel processes and for event-based programming, such as -multiple HTTP-GET requests running concurrently. See L to -learn more. - -Coroutines are also useful because Perl has no support for threads (the so -called "threads" that perl offers are nothing more than the (bad) process -emulation coming from the Windows platform: On standard operating systems -they serve no purpose whatsoever, except by making your programs slow and -making them use a lot of memory. Best disable them when building perl, or -aks your software vendor/distributor to do it for you). +For a tutorial-style introduction, please read the L +manpage. This manpage mainly contains reference information. -In this module, coroutines are defined as "callchain + lexical variables + -@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, +This module collection manages continuations in general, most often +in the form of cooperative threads (also called coroutines in the +documentation). They are similar to kernel threads but don't (in general) +run in parallel at the same time even on SMP machines. The specific flavor +of thread offered by this module also guarantees you that it will not +switch between threads unless necessary, at easily-identified points in +your program, so locking and parallel access are rarely an issue, making +thread programming much safer and easier than using other thread models. + +Unlike the so-called "Perl threads" (which are not actually real threads +but only the windows process emulation ported to unix), Coro provides a +full shared address space, which makes communication between threads +very easy. And threads are fast, too: disabling the Windows process +emulation code in your perl and using Coro can easily result in a two to +four times speed increase for your programs. + +Coro achieves that by supporting multiple running interpreters that share +data, which is especially useful to code pseudo-parallel processes and +for event-based programming, such as multiple HTTP-GET requests running +concurrently. See L to learn more on how to integrate Coro +into an event-based environment. + +In this module, a thread is defined as "callchain + lexical variables + +@_ + $_ + $@ + $/ + C stack), that is, a thread has its own callchain, its own set of lexicals and its own set of perls most important global -variables (see L for more configuration). +variables (see L for more configuration and background info). + +See also the C section at the end of this document - the Coro +module family is quite large. =cut package Coro; -use strict; +use strict qw(vars subs); no warnings "uninitialized"; use Coro::State; @@ -69,7 +76,7 @@ our $main; # main coroutine our $current; # current coroutine -our $VERSION = 4.749; +our $VERSION = 5.13; our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); our %EXPORT_TAGS = ( @@ -77,6 +84,8 @@ ); our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); +=head1 GLOBAL VARIABLES + =over 4 =item $Coro::main @@ -88,13 +97,13 @@ =cut -$main = new Coro; +# $main is now being initialised by Coro::State =item $Coro::current The coroutine object representing the current coroutine (the last coroutine that the Coro scheduler switched to). The initial value is -C<$main> (of course). +C<$Coro::main> (of course). This variable is B I. You can take copies of the value stored in it and use it as any other coroutine object, but you must @@ -102,35 +111,34 @@ =cut -$main->{desc} = "[main::]"; - -# maybe some other module used Coro::Specific before... -$main->{_specific} = $current->{_specific} - if $current; - -_set_current $main; - sub current() { $current } # [DEPRECATED] =item $Coro::idle This variable is mainly useful to integrate Coro into event loops. It is -usually better to rely on L or LC, as this is +usually better to rely on L or L, as this is pretty low-level functionality. -This variable stores a callback that is called whenever the scheduler -finds no ready coroutines to run. The default implementation prints -"FATAL: deadlock detected" and exits, because the program has no other way -to continue. +This variable stores either a coroutine or a callback. -This hook is overwritten by modules such as C and +If it is a callback, the it is called whenever the scheduler finds no +ready coroutines to run. The default implementation prints "FATAL: +deadlock detected" and exits, because the program has no other way to +continue. + +If it is a coroutine object, then this object will be readied (without +invoking any ready hooks, however) when the scheduler finds no other ready +coroutines to run. + +This hook is overwritten by modules such as C and C to wait on an external event that hopefully wake up a coroutine so the scheduler can run it. Note that the callback I, under any circumstances, block the current coroutine. Normally, this is achieved by having an "idle coroutine" that calls the event loop and then blocks again, and then -readying that coroutine in the idle handler. +readying that coroutine in the idle handler, or by simply placing the idle +coroutine in this variable. See L or L for examples of using this technique. @@ -145,43 +153,31 @@ Carp::croak ("FATAL: deadlock detected"); }; -sub _cancel { - my ($self) = @_; - - # free coroutine data and mark as destructed - $self->_destroy - or return; - - # call all destruction callbacks - $_->(@{$self->{_status}}) - for @{(delete $self->{_on_destroy}) || []}; -} - # this coroutine is necessary because a coroutine # cannot destroy itself. -my @destroy; -my $manager; +our @destroy; +our $manager; $manager = new Coro sub { while () { - (shift @destroy)->_cancel + Coro::_cancel shift @destroy while @destroy; &schedule; } }; -$manager->desc ("[coro manager]"); +$manager->{desc} = "[coro manager]"; $manager->prio (PRIO_MAX); =back -=head2 SIMPLE COROUTINE CREATION +=head1 SIMPLE COROUTINE CREATION =over 4 =item async { ... } [@args...] -Create a new coroutine and return it's coroutine object (usually +Create a new coroutine and return its coroutine object (usually unused). The coroutine will be put into the ready queue, so it will start running automatically on the next scheduler run. @@ -222,9 +218,9 @@ coroutine that might have executed other code already (which can be good or bad :). -On the plus side, this function is faster than creating (and destroying) -a completely new coroutine, so if you need a lot of generic coroutines in -quick successsion, use C, not C. +On the plus side, this function is about twice as fast as creating (and +destroying) a completely new coroutine, so if you need a lot of generic +coroutines in quick successsion, use C, not C. The code block is executed in an C context and a warning will be issued in case of an exception instead of terminating the program, as @@ -237,60 +233,41 @@ disabled, the description will be reset and the default output filehandle gets restored, so you can change all these. Otherwise the coroutine will be re-used "as-is": most notably if you change other per-coroutine global -stuff such as C<$/> you I to revert that change, which is most -simply done by using local as in: C< local $/ >. +stuff such as C<$/> you I revert that change, which is most +simply done by using local as in: C<< local $/ >>. -The pool size is limited to C<8> idle coroutines (this can be adjusted by -changing $Coro::POOL_SIZE), and there can be as many non-idle coros as -required. +The idle pool size is limited to C<8> idle coroutines (this can be +adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle +coros as required. If you are concerned about pooled coroutines growing a lot because a single C used a lot of stackspace you can e.g. C once per second or so to slowly replenish the pool. In -addition to that, when the stacks used by a handler grows larger than 16kb +addition to that, when the stacks used by a handler grows larger than 32kb (adjustable via $Coro::POOL_RSS) it will also be destroyed. =cut our $POOL_SIZE = 8; -our $POOL_RSS = 16 * 1024; +our $POOL_RSS = 32 * 1024; our @async_pool; sub pool_handler { - my $cb; - while () { eval { - while () { - _pool_1 $cb; - &$cb; - _pool_2 $cb; - &schedule; - } + &{&_pool_handler} while 1; }; - if ($@) { - last if $@ eq "\3async_pool terminate\2\n"; - warn $@; - } + warn $@ if $@; } } -sub async_pool(&@) { - # this is also inlined into the unlock_scheduler - my $coro = (pop @async_pool) || new Coro \&pool_handler; - - $coro->{_invoke} = [@_]; - $coro->ready; - - $coro -} - =back -=head2 STATIC METHODS +=head1 STATIC METHODS -Static methods are actually functions that operate on the current coroutine. +Static methods are actually functions that implicitly operate on the +current coroutine. =over 4 @@ -315,24 +292,7 @@ so you need to check whether the event indeed happened, e.g. by storing the status in a variable. -The canonical way to wait on external events is this: - - { - # remember current coroutine - my $current = $Coro::current; - - # register a hypothetical event handler - on_event_invoke sub { - # wake up sleeping coroutine - $current->ready; - undef $current; - }; - - # call schedule until event occurred. - # in case we are woken up for other reasons - # (current still defined), loop. - Coro::schedule while $current; - } +See B, below, for some ways to wait for callbacks. =item cede @@ -366,10 +326,6 @@ =cut -sub terminate { - $current->cancel (@_); -} - sub killall { for (Coro::State::list) { $_->cancel @@ -379,7 +335,7 @@ =back -=head2 COROUTINE METHODS +=head1 COROUTINE OBJECT METHODS These are the methods you can call on coroutine objects (or to create them). @@ -398,16 +354,10 @@ =cut -sub _run_coro { +sub _coro_run { terminate &{+shift}; } -sub new { - my $class = shift; - - $class->SUPER::new (\&_run_coro, @_) -} - =item $success = $coroutine->ready Put the given coroutine into the end of its ready queue (there is one @@ -432,17 +382,57 @@ sub cancel { my $self = shift; - $self->{_status} = [@_]; if ($current == $self) { - push @destroy, $self; - $manager->ready; - &schedule while 1; + terminate @_; } else { + $self->{_status} = [@_]; $self->_cancel; } } +=item $coroutine->schedule_to + +Puts the current coroutine to sleep (like C), but instead +of continuing with the next coro from the ready queue, always switch to +the given coroutine object (regardless of priority etc.). The readyness +state of that coroutine isn't changed. + +This is an advanced method for special cases - I'd love to hear about any +uses for this one. + +=item $coroutine->cede_to + +Like C, but puts the current coroutine into the ready +queue. This has the effect of temporarily switching to the given +coroutine, and continuing some time later. + +This is an advanced method for special cases - I'd love to hear about any +uses for this one. + +=item $coroutine->throw ([$scalar]) + +If C<$throw> is specified and defined, it will be thrown as an exception +inside the coroutine at the next convenient point in time. Otherwise +clears the exception object. + +Coro will check for the exception each time a schedule-like-function +returns, i.e. after each C, C, C<< Coro::Semaphore->down +>>, C<< Coro::Handle->readable >> and so on. Most of these functions +detect this case and return early in case an exception is pending. + +The exception object will be thrown "as is" with the specified scalar in +C<$@>, i.e. if it is a string, no line number or newline will be appended +(unlike with C). + +This can be used as a softer means than C to ask a coroutine to +end itself, although there is no guarantee that the exception will lead to +termination, and if the exception isn't caught it might well end the whole +program. + +You might also think of C as being the moral equivalent of +Cing a coroutine with a signal (in this case, a scalar). + =item $coroutine->join Wait until the coroutine terminates and return any values given to the @@ -513,26 +503,11 @@ =item $olddesc = $coroutine->desc ($newdesc) Sets (or gets in case the argument is missing) the description for this -coroutine. This is just a free-form string you can associate with a coroutine. - -This method simply sets the C<< $coroutine->{desc} >> member to the given string. You -can modify this member directly if you wish. - -=item $coroutine->throw ([$scalar]) - -If C<$throw> is specified and defined, it will be thrown as an exception -inside the coroutine at the next convinient point in time (usually after -it gains control at the next schedule/transfer/cede). Otherwise clears the -exception object. - -The exception object will be thrown "as is" with the specified scalar in -C<$@>, i.e. if it is a string, no line number or newline will be appended -(unlike with C). +coroutine. This is just a free-form string you can associate with a +coroutine. -This can be used as a softer means than C to ask a coroutine to -end itself, although there is no guarentee that the exception will lead to -termination, and if the exception isn't caught it might well end the whole -program. +This method simply sets the C<< $coroutine->{desc} >> member to the given +string. You can modify this member directly if you wish. =cut @@ -542,9 +517,14 @@ $old; } +sub transfer { + require Carp; + Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught"); +} + =back -=head2 GLOBAL FUNCTIONS +=head1 GLOBAL FUNCTIONS =over 4 @@ -559,37 +539,12 @@ =item my $guard = Coro::guard { ... } -This creates and returns a guard object. Nothing happens until the object -gets destroyed, in which case the codeblock given as argument will be -executed. This is useful to free locks or other resources in case of a -runtime error or when the coroutine gets canceled, as in both cases the -guard block will be executed. The guard object supports only one method, -C<< ->cancel >>, which will keep the codeblock from being executed. - -Example: set some flag and clear it again when the coroutine gets canceled -or the function returns: - - sub do_something { - my $guard = Coro::guard { $busy = 0 }; - $busy = 1; - - # do something that requires $busy to be true - } +This function still exists, but is deprecated. Please use the +C function instead. =cut -sub guard(&) { - bless \(my $cb = $_[0]), "Coro::guard" -} - -sub Coro::guard::cancel { - ${$_[0]} = sub { }; -} - -sub Coro::guard::DESTROY { - ${$_[0]}->(); -} - +BEGIN { *guard = \&Guard::guard } =item unblock_sub { ... } @@ -601,7 +556,7 @@ The reason this function exists is that many event libraries (such as the venerable L module) are not coroutine-safe (a weaker form -of thread-safety). This means you must not block within event callbacks, +of reentrancy). This means you must not block within event callbacks, otherwise you might suffer from crashes or worse. The only event library currently known that is safe to use without C is L. @@ -634,17 +589,17 @@ our $unblock_scheduler = new Coro sub { while () { while (my $cb = pop @unblock_queue) { - # this is an inlined copy of async_pool - my $coro = (pop @async_pool) || new Coro \&pool_handler; + &async_pool (@$cb); - $coro->{_invoke} = $cb; - $coro->ready; - cede; # for short-lived callbacks, this reduces pressure on the coro pool + # for short-lived callbacks, this reduces pressure on the coro pool + # as the chance is very high that the async_poll coro will be back + # in the idle state when cede returns + cede; } schedule; # sleep well } }; -$unblock_scheduler->desc ("[unblock_sub scheduler]"); +$unblock_scheduler->{desc} = "[unblock_sub scheduler]"; sub unblock_sub(&) { my $cb = shift; @@ -655,19 +610,129 @@ } } +=item $cb = Coro::rouse_cb + +Create and return a "rouse callback". That's a code reference that, +when called, will remember a copy of its arguments and notify the owner +coroutine of the callback. + +See the next function. + +=item @args = Coro::rouse_wait [$cb] + +Wait for the specified rouse callback (or the last one that was created in +this coroutine). + +As soon as the callback is invoked (or when the callback was invoked +before C), it will return the arguments originally passed to +the rouse callback. + +See the section B for an actual usage example. + =back =cut 1; +=head1 HOW TO WAIT FOR A CALLBACK + +It is very common for a coroutine to wait for some callback to be +called. This occurs naturally when you use coroutines in an otherwise +event-based program, or when you use event-based libraries. + +These typically register a callback for some event, and call that callback +when the event occured. In a coroutine, however, you typically want to +just wait for the event, simplyifying things. + +For example C<< AnyEvent->child >> registers a callback to be called when +a specific child has exited: + + my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... }); + +But from withina coroutine, you often just want to write this: + + my $status = wait_for_child $pid; + +Coro offers two functions specifically designed to make this easy, +C and C. + +The first function, C, generates and returns a callback that, +when invoked, will save its arguments and notify the coroutine that +created the callback. + +The second function, C, waits for the callback to be called +(by calling C to go to sleep) and returns the arguments +originally passed to the callback. + +Using these functions, it becomes easy to write the C +function mentioned above: + + sub wait_for_child($) { + my ($pid) = @_; + + my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb); + + my ($rpid, $rstatus) = Coro::rouse_wait; + $rstatus + } + +In the case where C and C are not flexible enough, +you can roll your own, using C: + + sub wait_for_child($) { + my ($pid) = @_; + + # store the current coroutine in $current, + # and provide result variables for the closure passed to ->child + my $current = $Coro::current; + my ($done, $rstatus); + + # pass a closure to ->child + my $watcher = AnyEvent->child (pid => $pid, cb => sub { + $rstatus = $_[1]; # remember rstatus + $done = 1; # mark $rstatus as valud + }); + + # wait until the closure has been called + schedule while !$done; + + $rstatus + } + + =head1 BUGS/LIMITATIONS +=over 4 + +=item fork with pthread backend + +When Coro is compiled using the pthread backend (which isn't recommended +but required on many BSDs as their libcs are completely broken), then +coroutines will not survive a fork. There is no known workaround except to +fix your libc and use a saner backend. + +=item perl process emulation ("threads") + This module is not perl-pseudo-thread-safe. You should only ever use this -module from the same thread (this requirement might be removed in the +module from the first thread (this requirement might be removed in the future to allow per-thread schedulers, but Coro::State does not yet allow -this). I recommend disabling thread support and using processes, as this -is much faster and uses less memory. +this). I recommend disabling thread support and using processes, as having +the windows process emulation enabled under unix roughly halves perl +performance, even when not used. + +=item coroutine switching not signal safe + +You must not switch to another coroutine from within a signal handler +(only relevant with %SIG - most event libraries provide safe signals). + +That means you I call any function that might "block" the +current coroutine - C, C C<< Coro::Semaphore->down >> or +anything that calls those. Everything else, including calling C, +works. + +=back + =head1 SEE ALSO @@ -677,15 +742,18 @@ Support/Utility: L, L. -Locking/IPC: L, L, L, L, L. +Locking and IPC: L, L, L, +L, L. -IO/Timers: L, L, L, L. +I/O and Timers: L, L, L, L. -Compatibility: L, L, L, L. +Compatibility with other modules: L (but see also L for +a better-working alternative), L, L, +L. XS API: L. -Low level Configuration, Coroutine Environment: L. +Low level Configuration, Thread Environment, Continuations: L. =head1 AUTHOR