[ViewVC] Diff of: cvs/Coro/Coro.pm

Comparing Coro/Coro.pm (file contents):
Revision 1.156 by root, Fri Nov 9 19:50:15 2007 UTC vs.
Revision 1.208 by root, Tue Nov 4 12:08:44 2008 UTC

 Coro - coroutine process abstraction
 =head1 SYNOPSIS
- use Coro;
+  use Coro;
- async {
+  async {
-    # some asynchronous thread of execution
+     # some asynchronous thread of execution
-    print "2\n";
+     print "2\n";
-    cede; # yield back to main
+     cede; # yield back to main
-    print "4\n";
+     print "4\n";
- };
+  };
- print "1\n";
+  print "1\n";
- cede; # yield to coroutine
+  cede; # yield to coroutine
- print "3\n";
+  print "3\n";
- cede; # and again
+  cede; # and again
- # use locking
+  # use locking
+  use Coro::Semaphore;
- my $lock = new Coro::Semaphore;
+  my $lock = new Coro::Semaphore;
- my $locked;
+  my $locked;
- $lock->down;
+  $lock->down;
- $locked = 1;
+  $locked = 1;
- $lock->up;
+  $lock->up;
 =head1 DESCRIPTION
-This module collection manages coroutines. Coroutines are similar
+This module collection manages coroutines. Coroutines are similar to
-to threads but don't run in parallel at the same time even on SMP
+threads but don't (in general) run in parallel at the same time even
-machines. The specific flavor of coroutine used in this module also
+on SMP machines. The specific flavor of coroutine used in this module
-guarantees you that it will not switch between coroutines unless
+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 than threads programming.
+safer and easier than threads programming.
-(Perl, however, does not natively support real threads but instead does a
+Unlike a normal perl program, however, coroutines allow you to have
-very slow and memory-intensive emulation of processes using threads. This
+multiple running interpreters that share data, which is especially useful
-is a performance win on Windows machines, and a loss everywhere else).
+to code pseudo-parallel processes and for event-based programming, such as
+multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> 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).
 In this module, coroutines are defined as "callchain + lexical variables +
 @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
 its own set of lexicals and its own set of perls most important global
 variables (see L<Coro::State> for more configuration).
 our $idle;    # idle handler
 our $main;    # main coroutine
 our $current; # current coroutine
-our $VERSION = '4.2';
+our $VERSION = 4.803;
 our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
 our %EXPORT_TAGS = (
       prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
 );
 our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
-{
-   my @async;
-   my $init;
-   # this way of handling attributes simply is NOT scalable ;()
-   sub import {
-      no strict 'refs';
-      Coro->export_to_level (1, @_);
-      my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
-      *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
-         my ($package, $ref) = (shift, shift);
-         my @attrs;
-         for (@_) {
-            if ($_ eq "Coro") {
-               push @async, $ref;
-               unless ($init++) {
-                  eval q{
-                     sub INIT {
-                        &async(pop @async) while @async;
-                     }
-                  };
-               }
-            } else {
-               push @attrs, $_;
-            }
-         }
-         return $old ? $old->($package, $ref, @attrs) : @attrs;
-      };
-   }
-}
 =over 4
-=item $main
+=item $Coro::main
-This coroutine represents the main program.
+This variable stores the coroutine object that represents the main
+program. While you cna C<ready> it and do most other things you can do to
+coroutines, it is mainly useful to compare again C<$Coro::current>, to see
+whether you are running in the main program or not.
 =cut
 $main = new Coro;
-=item $current (or as function: current)
+=item $Coro::current
-The current coroutine (the last coroutine switched to). The initial value
+The coroutine object representing the current coroutine (the last
+coroutine that the Coro scheduler switched to). The initial value is
-is C<$main> (of course).
+C<$main> (of course).
-This variable is B<strictly> I<read-only>. It is provided for performance
+This variable is B<strictly> I<read-only>. You can take copies of the
-reasons. If performance is not essential you are encouraged to use the
+value stored in it and use it as any other coroutine object, but you must
-C<Coro::current> function instead.
+not otherwise modify the variable itself.
 =cut
 $main->{desc} = "[main::]";
 $main->{_specific} = $current->{_specific}
    if $current;
 _set_current $main;
-sub current() { $current }
+sub current() { $current } # [DEPRECATED]
-=item $idle
+=item $Coro::idle
-A callback that is called whenever the scheduler finds no ready coroutines
+This variable is mainly useful to integrate Coro into event loops. It is
-to run. The default implementation prints "FATAL: deadlock detected" and
+usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is
-exits, because the program has no other way to continue.
+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 hook is overwritten by modules such as C<Coro::Timer> and
-C<Coro::Event> to wait on an external event that hopefully wake up a
+C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
 coroutine so the scheduler can run it.
+Note that the callback I<must not>, 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.
+See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this
+technique.
 Please note that if your callback recursively invokes perl (e.g. for event
 handlers), then it must be prepared to be called recursively itself.
 =cut
          while @destroy;
       &schedule;
    }
 };
-$manager->desc ("[coro manager]");
+$manager->{desc} = "[coro manager]";
 $manager->prio (PRIO_MAX);
-# static methods. not really.
 =back
-=head2 STATIC METHODS
+=head2 SIMPLE COROUTINE CREATION
-Static methods are actually functions that operate on the current coroutine only.
 =over 4
 =item async { ... } [@args...]
-Create a new asynchronous coroutine and return it's coroutine object
+Create a new coroutine and return it's coroutine object (usually
-(usually unused). When the sub returns the new coroutine is automatically
+unused). The coroutine will be put into the ready queue, so
+it will start running automatically on the next scheduler run.
+The first argument is a codeblock/closure that should be executed in the
+coroutine. When it returns argument returns the coroutine is automatically
 terminated.
+The remaining arguments are passed as arguments to the closure.
 See the C<Coro::State::new> constructor for info about the coroutine
-environment in which coroutines run.
+environment in which coroutines are executed.
 Calling C<exit> in a coroutine will do the same as calling exit outside
 the coroutine. Likewise, when the coroutine dies, the program will exit,
 just as it would in the main program.
+If you do not want that, you can provide a default C<die> handler, or
+simply avoid dieing (by use of C<eval>).
-   # create a new coroutine that just prints its arguments
+Example: Create a new coroutine that just prints its arguments.
    async {
       print "@_\n";
    } 1,2,3,4;
 =cut
 }
 =item async_pool { ... } [@args...]
 Similar to C<async>, but uses a coroutine pool, so you should not call
-terminate or join (although you are allowed to), and you get a coroutine
+terminate or join on it (although you are allowed to), and you get a
-that might have executed other code already (which can be good or bad :).
+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 completly new coroutine, so if you need a lot of generic coroutines in
+quick successsion, use C<async_pool>, not C<async>.
-Also, the block is executed in an C<eval> context and a warning will be
+The code block is executed in an C<eval> context and a warning will be
 issued in case of an exception instead of terminating the program, as
 C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
 will not work in the expected way, unless you call terminate or cancel,
-which somehow defeats the purpose of pooling.
+which somehow defeats the purpose of pooling (but is fine in the
+exceptional case).
-The priority will be reset to C<0> after each job, tracing will be
+The priority will be reset to C<0> after each run, tracing will be
 disabled, the description will be reset and the default output filehandle
-gets restored, so you can change alkl these. Otherwise the coroutine will
+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 need to revert that change, which is most simply
+stuff such as C<$/> you I<must needs> revert that change, which is most
-done by using local as in C< local $/ >.
+simply done by using local as in: C<< local $/ >>.
-The pool size is limited to 8 idle coroutines (this can be adjusted by
+The idle pool size is limited to C<8> idle coroutines (this can be
-changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
+adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
-required.
+coros as required.
 If you are concerned about pooled coroutines growing a lot because a
 single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
 { terminate }> 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
-(adjustable with $Coro::POOL_RSS) it will also exit.
+(adjustable via $Coro::POOL_RSS) it will also be destroyed.
 =cut
 our $POOL_SIZE = 8;
 our $POOL_RSS  = 16 * 1024;
             _pool_2 $cb;
             &schedule;
          }
       };
+      if ($@) {
-      last if $@ eq "\3async_pool terminate\2\n";
+         last if $@ eq "\3async_pool terminate\2\n";
-      warn $@ if $@;
+         warn $@;
+      }
    }
 }
 sub async_pool(&@) {
    # this is also inlined into the unlock_scheduler
    $coro->ready;
    $coro
 }
+=back
+=head2 STATIC METHODS
+Static methods are actually functions that operate on the current coroutine.
+=over 4
 =item schedule
-Calls the scheduler. Please note that the current coroutine will not be put
+Calls the scheduler. The scheduler will find the next coroutine that is
+to be run from the ready queue and switches to it. The next coroutine
+to be run is simply the one with the highest priority that is longest
+in its ready queue. If there is no coroutine ready, it will clal the
+C<$Coro::idle> hook.
+Please note that the current coroutine will I<not> be put into the ready
-into the ready queue, so calling this function usually means you will
+queue, so calling this function usually means you will never be called
-never be called again unless something else (e.g. an event handler) calls
+again unless something else (e.g. an event handler) calls C<< ->ready >>,
-ready.
+thus waking you up.
+This makes C<schedule> I<the> generic method to use to block the current
+coroutine and wait for events: first you remember the current coroutine in
+a variable, then arrange for some callback of yours to call C<< ->ready
+>> on that once some event happens, and last you call C<schedule> to put
+yourself to sleep. Note that a lot of things can wake your coroutine up,
+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
       Coro::schedule while $current;
    }
 =item cede
-"Cede" to other coroutines. This function puts the current coroutine into the
+"Cede" to other coroutines. This function puts the current coroutine into
-ready queue and calls C<schedule>, which has the effect of giving up the
+the ready queue and calls C<schedule>, which has the effect of giving
-current "timeslice" to other coroutines of the same or higher priority.
+up the current "timeslice" to other coroutines of the same or higher
+priority. Once your coroutine gets its turn again it will automatically be
+resumed.
+This function is often called C<yield> in other languages.
 =item Coro::cede_notself
-Works like cede, but is not exported by default and will cede to any
+Works like cede, but is not exported by default and will cede to I<any>
-coroutine, regardless of priority, once.
+coroutine, regardless of priority. This is useful sometimes to ensure
+progress is made.
 =item terminate [arg...]
 Terminates the current coroutine with the given status values (see L<cancel>).
 =item killall
 Kills/terminates/cancels all coroutines except the currently running
 one. This is useful after a fork, either in the child or the parent, as
 usually only one of them should inherit the running coroutines.
+Note that while this will try to free some of the main programs resources,
+you cannot free all of them, so if a coroutine that is not the main
+program calls this function, there will be some one-time resource leak.
 =cut
 sub terminate {
    $current->cancel (@_);
    }
 }
 =back
-# dynamic methods
 =head2 COROUTINE METHODS
-These are the methods you can call on coroutine objects.
+These are the methods you can call on coroutine objects (or to create
+them).
 =over 4
 =item new Coro \&sub [, @args...]
-Create a new coroutine and return it. When the sub returns the coroutine
+Create a new coroutine and return it. When the sub returns, the coroutine
 automatically terminates as if C<terminate> with the returned values were
-called. To make the coroutine run you must first put it into the ready queue
+called. To make the coroutine run you must first put it into the ready
-by calling the ready method.
+queue by calling the ready method.
 See C<async> and C<Coro::State::new> for additional info about the
 coroutine environment.
 =cut
    $class->SUPER::new (\&_run_coro, @_)
 }
 =item $success = $coroutine->ready
-Put the given coroutine into the ready queue (according to it's priority)
+Put the given coroutine into the end of its ready queue (there is one
-and return true. If the coroutine is already in the ready queue, do nothing
+queue for each priority) and return true. If the coroutine is already in
-and return false.
+the ready queue, do nothing and return false.
+This ensures that the scheduler will resume this coroutine automatically
+once all the coroutines of higher priority and all coroutines of the same
+priority that were put into the ready queue earlier have been resumed.
 =item $is_ready = $coroutine->is_ready
-Return wether the coroutine is currently the ready queue or not,
+Return whether the coroutine is currently the ready queue or not,
 =item $coroutine->cancel (arg...)
 Terminates the given coroutine and makes it return the given arguments as
 status (default: the empty list). Never returns if the coroutine is the
    } else {
       $self->_cancel;
    }
 }
+=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 (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<die>).
+This can be used as a softer means than C<cancel> 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<throw> as being the moral equivalent of
+C<kill>ing 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
 C<terminate> or C<cancel> functions. C<join> can be called concurrently
-from multiple coroutines.
+from multiple coroutines, and all will be resumed and given the status
+return once the C<$coroutine> terminates.
 =cut
 sub join {
    my $self = shift;
 =item $coroutine->on_destroy (\&cb)
 Registers a callback that is called when this coroutine gets destroyed,
 but before it is joined. The callback gets passed the terminate arguments,
-if any.
+if any, and I<must not> die, under any circumstances.
 =cut
 sub on_destroy {
    my ($self, $cb) = @_;
 higher values mean lower priority, just as in unix).
 =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.
+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
+This method simply sets the C<< $coroutine->{desc} >> member to the given
-can modify this member directly if you wish.
+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<die>).
-This can be used as a softer means than C<cancel> 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.
 =cut
 sub desc {
    my $old = $_[0]{desc};
 =over 4
 =item Coro::nready
 Returns the number of coroutines that are currently in the ready state,
-i.e. that can be switched to. The value C<0> means that the only runnable
+i.e. that can be switched to by calling C<schedule> directory or
+indirectly. The value C<0> means that the only runnable coroutine is the
-coroutine is the currently running one, so C<cede> would have no effect,
+currently running one, so C<cede> would have no effect, and C<schedule>
-and C<schedule> would cause a deadlock unless there is an idle handler
+would cause a deadlock unless there is an idle handler that wakes up some
-that wakes up some coroutines.
+coroutines.
 =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
 =item unblock_sub { ... }
 This utility function takes a BLOCK or code reference and "unblocks" it,
-returning the new coderef. This means that the new coderef will return
+returning a new coderef. Unblocking means that calling the new coderef
-immediately without blocking, returning nothing, while the original code
+will return immediately without blocking, returning nothing, while the
-ref will be called (with parameters) from within its own coroutine.
+original code ref will be called (with parameters) from within another
+coroutine.
 The reason this function exists is that many event libraries (such as the
 venerable L<Event|Event> module) are not coroutine-safe (a weaker form
 of thread-safety). This means you must not block within event callbacks,
-otherwise you might suffer from crashes or worse.
+otherwise you might suffer from crashes or worse. The only event library
+currently known that is safe to use without C<unblock_sub> is L<EV>.
 This function allows your callbacks to block by executing them in another
 coroutine where it is safe to block. One example where blocking is handy
 is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
-disk.
+disk, for example.
 In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
 creating event callbacks that want to block.
+If your handler does not plan to block (e.g. simply sends a message to
+another coroutine, or puts some other coroutine into the ready queue),
+there is no reason to use C<unblock_sub>.
+Note that you also need to use C<unblock_sub> for any other callbacks that
+are indirectly executed by any C-based event loop. For example, when you
+use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
+provides callbacks that are the result of some event callback, then you
+must not block either, or use C<unblock_sub>.
 =cut
 our @unblock_queue;
          cede; # for short-lived callbacks, this reduces pressure on the coro pool
       }
       schedule; # sleep well
    }
 };
-$unblock_scheduler->desc ("[unblock_sub scheduler]");
+$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
 sub unblock_sub(&) {
    my $cb = shift;
    sub {
 1;
 =head1 BUGS/LIMITATIONS
- - you must make very sure that no coro is still active on global
-   destruction. very bad things might happen otherwise (usually segfaults).
- - this module is not thread-safe. You should only ever use this module
+This module is not perl-pseudo-thread-safe. You should only ever use this
-   from the same thread (this requirement might be loosened in the future
+module from the same thread (this requirement might be removed in the
-   to allow per-thread schedulers, but Coro::State does not yet allow
+future to allow per-thread schedulers, but Coro::State does not yet allow
-   this).
+this). I recommend disabling thread support and using processes, as this
+is much faster and uses less memory.
 =head1 SEE ALSO
-Lower level Configuration, Coroutine Environment: L<Coro::State>.
+Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
 Debugging: L<Coro::Debug>.
 Support/Utility: L<Coro::Specific>, L<Coro::Util>.
 Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
-Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>.
+IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
-Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
+Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>.
-Embedding: L<Coro:MakeMaker>.
+XS API: L<Coro::MakeMaker>.
+Low level Configuration, Coroutine Environment: L<Coro::State>.
 =head1 AUTHOR
  Marc Lehmann <schmorp@schmorp.de>
  http://home.schmorp.de/

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing Coro/Coro.pm (file contents): Revision 1.156 by root, Fri Nov 9 19:50:15 2007 UTC vs. Revision 1.208 by root, Tue Nov 4 12:08:44 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.156 by root, Fri Nov 9 19:50:15 2007 UTC vs.
Revision 1.208 by root, Tue Nov 4 12:08:44 2008 UTC