Coro/Coro.pm

=head1 NAME

Coro - coroutine process abstraction

=head1 SYNOPSIS

 use Coro;

 async {
    # some asynchronous thread of execution
 };

 # alternatively create an async coroutine like this:

 sub some_func : Coro {
    # some more async code
 }

 cede;

=head1 DESCRIPTION

This module collection manages coroutines. Coroutines are similar
to threads but don't 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 than threads programming.

(Perl, however, does not natively support real threads but instead does a
very slow and memory-intensive emulation of processes using threads. This
is a performance win on Windows machines, and a loss everywhere else).

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.

=cut

package Coro;

use strict;
no warnings "uninitialized";

use Coro::State;

use base qw(Coro::State Exporter);

our $idle;    # idle handler
our $main;    # main coroutine
our $current; # current coroutine

our $VERSION = '4.02';

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

This coroutine represents the main program.

=cut

$main = new Coro;

=item $current (or as function: current)

The current coroutine (the last coroutine switched to). The initial value
is C<$main> (of course).

This variable is B<strictly> I<read-only>. It is provided for performance
reasons. If performance is not essential you are encouraged to use the
C<Coro::current> function instead.

=cut

$main->{desc} = "[main::]";

# maybe some other module used Coro::Specific before...
$main->{_specific} = $current->{_specific}
   if $current;

_set_current $main;

sub current() { $current }

=item $idle

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
coroutine so the scheduler can run it.

Please note that if your callback recursively invokes perl (e.g. for event
handlers), then it must be prepared to be called recursively.

=cut

$idle = sub {
   require Carp;
   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;

$manager = new Coro sub {
   while () {
      (shift @destroy)->_cancel
         while @destroy;

      &schedule;
   }
};
$manager->desc ("[coro manager]");
$manager->prio (PRIO_MAX);

# static methods. not really.

=back

=head2 STATIC METHODS

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
(usually unused). When the sub returns the new coroutine is automatically
terminated.

See the C<Coro::State::new> constructor for info about the coroutine
environment.

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.

   # create a new coroutine that just prints its arguments
   async {
      print "@_\n";
   } 1,2,3,4;

=cut

sub async(&@) {
   my $coro = new Coro @_;
   $coro->ready;
   $coro
}

=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
that might have executed other code already (which can be good or bad :).

Also, the 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.

The priority will be reset to C<0> after each job, 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
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
done by using local as in C< local $/ >.

The pool size is limited to 8 idle coroutines (this can be adjusted by
changing $Coro::POOL_SIZE), and there can be as many non-idle 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.

=cut

our $POOL_SIZE = 8;
our $POOL_RSS  = 16 * 1024;
our @async_pool;

sub pool_handler {
   my $cb;

   while () {
      eval {
         while () {
            _pool_1 $cb;
            &$cb;
            _pool_2 $cb;
            &schedule;
         }
      };

      last if $@ eq "\3terminate\2\n";
      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
}

=item schedule

Calls the scheduler. Please note that the current coroutine will not be put
into the ready queue, so calling this function usually means you will
never be called again unless something else (e.g. an event handler) calls
ready.

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;
   }

=item cede

"Cede" to other coroutines. This function puts the current coroutine into the
ready queue and calls C<schedule>, which has the effect of giving up the
current "timeslice" to other coroutines of the same or higher priority.

Returns true if at least one coroutine switch has happened.

=item Coro::cede_notself

Works like cede, but is not exported by default and will cede to any
coroutine, regardless of priority, once.

Returns true if at least one coroutine switch has happened.

=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.

=cut

sub terminate {
   $current->cancel (@_);
}

sub killall {
   for (Coro::State::list) {
      $_->cancel
         if $_ != $current && UNIVERSAL::isa $_, "Coro";
   }
}

=back

# dynamic methods

=head2 COROUTINE METHODS

These are the methods you can call on coroutine objects.

=over 4

=item new Coro \&sub [, @args...]

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
by calling the ready method.

See C<async> and C<Coro::State::new> for additional info about the
coroutine environment.

=cut

sub _run_coro {
   terminate &{+shift};
}

sub new {
   my $class = shift;

   $class->SUPER::new (\&_run_coro, @_)
}

=item $success = $coroutine->ready

Put the given coroutine into the ready queue (according to it's priority)
and return true. If the coroutine is already in the ready queue, do nothing
and return false.

=item $is_ready = $coroutine->is_ready

Return wether 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
current coroutine.

=cut

sub cancel {
   my $self = shift;
   $self->{_status} = [@_];

   if ($current == $self) {
      push @destroy, $self;
      $manager->ready;
      &schedule while 1;
   } else {
      $self->_cancel;
   }
}

=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.

=cut

sub join {
   my $self = shift;

   unless ($self->{_status}) {
      my $current = $current;

      push @{$self->{_on_destroy}}, sub {
         $current->ready;
         undef $current;
      };

      &schedule while $current;
   }

   wantarray ? @{$self->{_status}} : $self->{_status}[0];
}

=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.

=cut

sub on_destroy {
   my ($self, $cb) = @_;

   push @{ $self->{_on_destroy} }, $cb;
}

=item $oldprio = $coroutine->prio ($newprio)

Sets (or gets, if the argument is missing) the priority of the
coroutine. Higher priority coroutines get run before lower priority
coroutines. Priorities are small signed integers (currently -4 .. +3),
that you can refer to using PRIO_xxx constants (use the import tag :prio
to get then):

   PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
       3    >     1     >      0      >    -1    >    -3     >    -4

   # set priority to HIGH
   current->prio(PRIO_HIGH);

The idle coroutine ($Coro::idle) always has a lower priority than any
existing coroutine.

Changing the priority of the current coroutine will take effect immediately,
but changing the priority of coroutines in the ready queue (but not
running) will only take effect after the next schedule (of that
coroutine). This is a bug that will be fixed in some future version.

=item $newprio = $coroutine->nice ($change)

Similar to C<prio>, but subtract the given value from the priority (i.e.
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.

This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
can modify this member directly if you wish.

=cut

sub desc {
   my $old = $_[0]{desc};
   $_[0]{desc} = $_[1] if @_ > 1;
   $old;
}

=back

=head2 GLOBAL FUNCTIONS

=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
coroutine is the currently running one, so C<cede> would have no effect,
and C<schedule> would cause a deadlock unless there is an idle handler
that wakes up some 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
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
   }

=cut

sub guard(&) {
   bless \(my $cb = $_[0]), "Coro::guard"
}

sub Coro::guard::cancel {
   ${$_[0]} = sub { };
}

sub Coro::guard::DESTROY {
   ${$_[0]}->();
}


=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
immediately without blocking, returning nothing, while the original code
ref will be called (with parameters) from within its own 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.

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.

In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
creating event callbacks that want to block.

=cut

our @unblock_queue;

# we create a special coro because we want to cede,
# to reduce pressure on the coro pool (because most callbacks
# return immediately and can be reused) and because we cannot cede
# inside an event callback.
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;

         $coro->{_invoke} = $cb;
         $coro->ready;
         cede; # for short-lived callbacks, this reduces pressure on the coro pool
      }
      schedule; # sleep well
   }
};
$unblock_scheduler->desc ("[unblock_sub scheduler]");

sub unblock_sub(&) {
   my $cb = shift;

   sub {
      unshift @unblock_queue, [$cb, @_];
      $unblock_scheduler->ready;
   }
}

=back

=cut

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
   from the same thread (this requirement might be loosened in the future
   to allow per-thread schedulers, but Coro::State does not yet allow
   this).

=head1 SEE ALSO

Support/Utility: L<Coro::Specific>, L<Coro::State>, 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>, L<Coro::Select>.

Embedding: L<Coro:MakeMaker>

=head1 AUTHOR

 Marc Lehmann <schmorp@schmorp.de>
 http://home.schmorp.de/

=cut

Revision:	1.149
Committed:	Sat Oct 6 00:39:07 2007 UTC (16 years, 8 months ago) by root
Branch:	MAIN
CVS Tags:	rel-4_02
Changes since 1.148:	+1 -1 lines
Log Message:	* empty log message *
#	Content
1	=head1 NAME
2
3	Coro - coroutine process abstraction
4
5	=head1 SYNOPSIS
6
7	use Coro;
8
9	async {
10	# some asynchronous thread of execution
11	};
12
13	# alternatively create an async coroutine like this:
14
15	sub some_func : Coro {
16	# some more async code
17	}
18
19	cede;
20
21	=head1 DESCRIPTION
22
23	This module collection manages coroutines. Coroutines are similar
24	to threads but don't run in parallel at the same time even on SMP
25	machines. The specific flavor of coroutine used in this module also
26	guarantees you that it will not switch between coroutines unless
27	necessary, at easily-identified points in your program, so locking and
28	parallel access are rarely an issue, making coroutine programming much
29	safer than threads programming.
30
31	(Perl, however, does not natively support real threads but instead does a
32	very slow and memory-intensive emulation of processes using threads. This
33	is a performance win on Windows machines, and a loss everywhere else).
34
35	In this module, coroutines are defined as "callchain + lexical variables +
36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
37	its own set of lexicals and its own set of perls most important global
38	variables.
39
40	=cut
41
42	package Coro;
43
44	use strict;
45	no warnings "uninitialized";
46
47	use Coro::State;
48
49	use base qw(Coro::State Exporter);
50
51	our $idle; # idle handler
52	our $main; # main coroutine
53	our $current; # current coroutine
54
55	our $VERSION = '4.02';
56
57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58	our %EXPORT_TAGS = (
59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60	);
61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
62
63	{
64	my @async;
65	my $init;
66
67	# this way of handling attributes simply is NOT scalable ;()
68	sub import {
69	no strict 'refs';
70
71	Coro->export_to_level (1, @_);
72
73	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
74	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
75	my ($package, $ref) = (shift, shift);
76	my @attrs;
77	for (@_) {
78	if ($_ eq "Coro") {
79	push @async, $ref;
80	unless ($init++) {
81	eval q{
82	sub INIT {
83	&async(pop @async) while @async;
84	}
85	};
86	}
87	} else {
88	push @attrs, $_;
89	}
90	}
91	return $old ? $old->($package, $ref, @attrs) : @attrs;
92	};
93	}
94
95	}
96
97	=over 4
98
99	=item $main
100
101	This coroutine represents the main program.
102
103	=cut
104
105	$main = new Coro;
106
107	=item $current (or as function: current)
108
109	The current coroutine (the last coroutine switched to). The initial value
110	is C<$main> (of course).
111
112	This variable is B<strictly> I<read-only>. It is provided for performance
113	reasons. If performance is not essential you are encouraged to use the
114	C<Coro::current> function instead.
115
116	=cut
117
118	$main->{desc} = "[main::]";
119
120	# maybe some other module used Coro::Specific before...
121	$main->{_specific} = $current->{_specific}
122	if $current;
123
124	_set_current $main;
125
126	sub current() { $current }
127
128	=item $idle
129
130	A callback that is called whenever the scheduler finds no ready coroutines
131	to run. The default implementation prints "FATAL: deadlock detected" and
132	exits, because the program has no other way to continue.
133
134	This hook is overwritten by modules such as C<Coro::Timer> and
135	C<Coro::Event> to wait on an external event that hopefully wake up a
136	coroutine so the scheduler can run it.
137
138	Please note that if your callback recursively invokes perl (e.g. for event
139	handlers), then it must be prepared to be called recursively.
140
141	=cut
142
143	$idle = sub {
144	require Carp;
145	Carp::croak ("FATAL: deadlock detected");
146	};
147
148	sub _cancel {
149	my ($self) = @_;
150
151	# free coroutine data and mark as destructed
152	$self->_destroy
153	or return;
154
155	# call all destruction callbacks
156	$_->(@{$self->{_status}})
157	for @{(delete $self->{_on_destroy}) \|\| []};
158	}
159
160	# this coroutine is necessary because a coroutine
161	# cannot destroy itself.
162	my @destroy;
163	my $manager;
164
165	$manager = new Coro sub {
166	while () {
167	(shift @destroy)->_cancel
168	while @destroy;
169
170	&schedule;
171	}
172	};
173	$manager->desc ("[coro manager]");
174	$manager->prio (PRIO_MAX);
175
176	# static methods. not really.
177
178	=back
179
180	=head2 STATIC METHODS
181
182	Static methods are actually functions that operate on the current coroutine only.
183
184	=over 4
185
186	=item async { ... } [@args...]
187
188	Create a new asynchronous coroutine and return it's coroutine object
189	(usually unused). When the sub returns the new coroutine is automatically
190	terminated.
191
192	See the C<Coro::State::new> constructor for info about the coroutine
193	environment.
194
195	Calling C<exit> in a coroutine will do the same as calling exit outside
196	the coroutine. Likewise, when the coroutine dies, the program will exit,
197	just as it would in the main program.
198
199	# create a new coroutine that just prints its arguments
200	async {
201	print "@_\n";
202	} 1,2,3,4;
203
204	=cut
205
206	sub async(&@) {
207	my $coro = new Coro @_;
208	$coro->ready;
209	$coro
210	}
211
212	=item async_pool { ... } [@args...]
213
214	Similar to C<async>, but uses a coroutine pool, so you should not call
215	terminate or join (although you are allowed to), and you get a coroutine
216	that might have executed other code already (which can be good or bad :).
217
218	Also, the block is executed in an C<eval> context and a warning will be
219	issued in case of an exception instead of terminating the program, as
220	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
221	will not work in the expected way, unless you call terminate or cancel,
222	which somehow defeats the purpose of pooling.
223
224	The priority will be reset to C<0> after each job, tracing will be
225	disabled, the description will be reset and the default output filehandle
226	gets restored, so you can change alkl these. Otherwise the coroutine will
227	be re-used "as-is": most notably if you change other per-coroutine global
228	stuff such as C<$/> you need to revert that change, which is most simply
229	done by using local as in C< local $/ >.
230
231	The pool size is limited to 8 idle coroutines (this can be adjusted by
232	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
233	required.
234
235	If you are concerned about pooled coroutines growing a lot because a
236	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
237	{ terminate }> once per second or so to slowly replenish the pool. In
238	addition to that, when the stacks used by a handler grows larger than 16kb
239	(adjustable with $Coro::POOL_RSS) it will also exit.
240
241	=cut
242
243	our $POOL_SIZE = 8;
244	our $POOL_RSS = 16 * 1024;
245	our @async_pool;
246
247	sub pool_handler {
248	my $cb;
249
250	while () {
251	eval {
252	while () {
253	_pool_1 $cb;
254	&$cb;
255	_pool_2 $cb;
256	&schedule;
257	}
258	};
259
260	last if $@ eq "\3terminate\2\n";
261	warn $@ if $@;
262	}
263	}
264
265	sub async_pool(&@) {
266	# this is also inlined into the unlock_scheduler
267	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
268
269	$coro->{_invoke} = [@_];
270	$coro->ready;
271
272	$coro
273	}
274
275	=item schedule
276
277	Calls the scheduler. Please note that the current coroutine will not be put
278	into the ready queue, so calling this function usually means you will
279	never be called again unless something else (e.g. an event handler) calls
280	ready.
281
282	The canonical way to wait on external events is this:
283
284	{
285	# remember current coroutine
286	my $current = $Coro::current;
287
288	# register a hypothetical event handler
289	on_event_invoke sub {
290	# wake up sleeping coroutine
291	$current->ready;
292	undef $current;
293	};
294
295	# call schedule until event occurred.
296	# in case we are woken up for other reasons
297	# (current still defined), loop.
298	Coro::schedule while $current;
299	}
300
301	=item cede
302
303	"Cede" to other coroutines. This function puts the current coroutine into the
304	ready queue and calls C<schedule>, which has the effect of giving up the
305	current "timeslice" to other coroutines of the same or higher priority.
306
307	Returns true if at least one coroutine switch has happened.
308
309	=item Coro::cede_notself
310
311	Works like cede, but is not exported by default and will cede to any
312	coroutine, regardless of priority, once.
313
314	Returns true if at least one coroutine switch has happened.
315
316	=item terminate [arg...]
317
318	Terminates the current coroutine with the given status values (see L<cancel>).
319
320	=item killall
321
322	Kills/terminates/cancels all coroutines except the currently running
323	one. This is useful after a fork, either in the child or the parent, as
324	usually only one of them should inherit the running coroutines.
325
326	=cut
327
328	sub terminate {
329	$current->cancel (@_);
330	}
331
332	sub killall {
333	for (Coro::State::list) {
334	$_->cancel
335	if $_ != $current && UNIVERSAL::isa $_, "Coro";
336	}
337	}
338
339	=back
340
341	# dynamic methods
342
343	=head2 COROUTINE METHODS
344
345	These are the methods you can call on coroutine objects.
346
347	=over 4
348
349	=item new Coro \&sub [, @args...]
350
351	Create a new coroutine and return it. When the sub returns the coroutine
352	automatically terminates as if C<terminate> with the returned values were
353	called. To make the coroutine run you must first put it into the ready queue
354	by calling the ready method.
355
356	See C<async> and C<Coro::State::new> for additional info about the
357	coroutine environment.
358
359	=cut
360
361	sub _run_coro {
362	terminate &{+shift};
363	}
364
365	sub new {
366	my $class = shift;
367
368	$class->SUPER::new (\&_run_coro, @_)
369	}
370
371	=item $success = $coroutine->ready
372
373	Put the given coroutine into the ready queue (according to it's priority)
374	and return true. If the coroutine is already in the ready queue, do nothing
375	and return false.
376
377	=item $is_ready = $coroutine->is_ready
378
379	Return wether the coroutine is currently the ready queue or not,
380
381	=item $coroutine->cancel (arg...)
382
383	Terminates the given coroutine and makes it return the given arguments as
384	status (default: the empty list). Never returns if the coroutine is the
385	current coroutine.
386
387	=cut
388
389	sub cancel {
390	my $self = shift;
391	$self->{_status} = [@_];
392
393	if ($current == $self) {
394	push @destroy, $self;
395	$manager->ready;
396	&schedule while 1;
397	} else {
398	$self->_cancel;
399	}
400	}
401
402	=item $coroutine->join
403
404	Wait until the coroutine terminates and return any values given to the
405	C<terminate> or C<cancel> functions. C<join> can be called concurrently
406	from multiple coroutines.
407
408	=cut
409
410	sub join {
411	my $self = shift;
412
413	unless ($self->{_status}) {
414	my $current = $current;
415
416	push @{$self->{_on_destroy}}, sub {
417	$current->ready;
418	undef $current;
419	};
420
421	&schedule while $current;
422	}
423
424	wantarray ? @{$self->{_status}} : $self->{_status}[0];
425	}
426
427	=item $coroutine->on_destroy (\&cb)
428
429	Registers a callback that is called when this coroutine gets destroyed,
430	but before it is joined. The callback gets passed the terminate arguments,
431	if any.
432
433	=cut
434
435	sub on_destroy {
436	my ($self, $cb) = @_;
437
438	push @{ $self->{_on_destroy} }, $cb;
439	}
440
441	=item $oldprio = $coroutine->prio ($newprio)
442
443	Sets (or gets, if the argument is missing) the priority of the
444	coroutine. Higher priority coroutines get run before lower priority
445	coroutines. Priorities are small signed integers (currently -4 .. +3),
446	that you can refer to using PRIO_xxx constants (use the import tag :prio
447	to get then):
448
449	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
450	3 > 1 > 0 > -1 > -3 > -4
451
452	# set priority to HIGH
453	current->prio(PRIO_HIGH);
454
455	The idle coroutine ($Coro::idle) always has a lower priority than any
456	existing coroutine.
457
458	Changing the priority of the current coroutine will take effect immediately,
459	but changing the priority of coroutines in the ready queue (but not
460	running) will only take effect after the next schedule (of that
461	coroutine). This is a bug that will be fixed in some future version.
462
463	=item $newprio = $coroutine->nice ($change)
464
465	Similar to C<prio>, but subtract the given value from the priority (i.e.
466	higher values mean lower priority, just as in unix).
467
468	=item $olddesc = $coroutine->desc ($newdesc)
469
470	Sets (or gets in case the argument is missing) the description for this
471	coroutine. This is just a free-form string you can associate with a coroutine.
472
473	This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
474	can modify this member directly if you wish.
475
476	=cut
477
478	sub desc {
479	my $old = $_[0]{desc};
480	$_[0]{desc} = $_[1] if @_ > 1;
481	$old;
482	}
483
484	=back
485
486	=head2 GLOBAL FUNCTIONS
487
488	=over 4
489
490	=item Coro::nready
491
492	Returns the number of coroutines that are currently in the ready state,
493	i.e. that can be switched to. The value C<0> means that the only runnable
494	coroutine is the currently running one, so C<cede> would have no effect,
495	and C<schedule> would cause a deadlock unless there is an idle handler
496	that wakes up some coroutines.
497
498	=item my $guard = Coro::guard { ... }
499
500	This creates and returns a guard object. Nothing happens until the object
501	gets destroyed, in which case the codeblock given as argument will be
502	executed. This is useful to free locks or other resources in case of a
503	runtime error or when the coroutine gets canceled, as in both cases the
504	guard block will be executed. The guard object supports only one method,
505	C<< ->cancel >>, which will keep the codeblock from being executed.
506
507	Example: set some flag and clear it again when the coroutine gets canceled
508	or the function returns:
509
510	sub do_something {
511	my $guard = Coro::guard { $busy = 0 };
512	$busy = 1;
513
514	# do something that requires $busy to be true
515	}
516
517	=cut
518
519	sub guard(&) {
520	bless \(my $cb = $_[0]), "Coro::guard"
521	}
522
523	sub Coro::guard::cancel {
524	${$_[0]} = sub { };
525	}
526
527	sub Coro::guard::DESTROY {
528	${$_[0]}->();
529	}
530
531
532	=item unblock_sub { ... }
533
534	This utility function takes a BLOCK or code reference and "unblocks" it,
535	returning the new coderef. This means that the new coderef will return
536	immediately without blocking, returning nothing, while the original code
537	ref will be called (with parameters) from within its own coroutine.
538
539	The reason this function exists is that many event libraries (such as the
540	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
541	of thread-safety). This means you must not block within event callbacks,
542	otherwise you might suffer from crashes or worse.
543
544	This function allows your callbacks to block by executing them in another
545	coroutine where it is safe to block. One example where blocking is handy
546	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
547	disk.
548
549	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
550	creating event callbacks that want to block.
551
552	=cut
553
554	our @unblock_queue;
555
556	# we create a special coro because we want to cede,
557	# to reduce pressure on the coro pool (because most callbacks
558	# return immediately and can be reused) and because we cannot cede
559	# inside an event callback.
560	our $unblock_scheduler = new Coro sub {
561	while () {
562	while (my $cb = pop @unblock_queue) {
563	# this is an inlined copy of async_pool
564	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
565
566	$coro->{_invoke} = $cb;
567	$coro->ready;
568	cede; # for short-lived callbacks, this reduces pressure on the coro pool
569	}
570	schedule; # sleep well
571	}
572	};
573	$unblock_scheduler->desc ("[unblock_sub scheduler]");
574
575	sub unblock_sub(&) {
576	my $cb = shift;
577
578	sub {
579	unshift @unblock_queue, [$cb, @_];
580	$unblock_scheduler->ready;
581	}
582	}
583
584	=back
585
586	=cut
587
588	1;
589
590	=head1 BUGS/LIMITATIONS
591
592	- you must make very sure that no coro is still active on global
593	destruction. very bad things might happen otherwise (usually segfaults).
594
595	- this module is not thread-safe. You should only ever use this module
596	from the same thread (this requirement might be loosened in the future
597	to allow per-thread schedulers, but Coro::State does not yet allow
598	this).
599
600	=head1 SEE ALSO
601
602	Support/Utility: L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
603
604	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
605
606	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
607
608	Embedding: L<Coro:MakeMaker>
609
610	=head1 AUTHOR
611
612	Marc Lehmann <schmorp@schmorp.de>
613	http://home.schmorp.de/
614
615	=cut
616