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

Comparing Coro/Coro.pm (file contents):
Revision 1.108 by root, Fri Jan 5 20:00:49 2007 UTC vs.
Revision 1.237 by root, Sat Nov 22 16:37:11 2008 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	Coro - coroutine process abstraction	3	Coro - real threads in perl
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use Coro;	7	use Coro;
8		8
9	async {	9	async {
10	# some asynchronous thread of execution	10	# some asynchronous thread of execution
		11	print "2\n";
		12	cede; # yield back to main
		13	print "4\n";
11	};	14	};
12		15	print "1\n";
13	# alternatively create an async coroutine like this:	16	cede; # yield to coroutine
14		17	print "3\n";
15	sub some_func : Coro {	18	cede; # and again
16	# some more async code	19
17	}	20	# use locking
18		21	use Coro::Semaphore;
19	cede;	22	my $lock = new Coro::Semaphore;
		23	my $locked;
		24
		25	$lock->down;
		26	$locked = 1;
		27	$lock->up;
20		28
21	=head1 DESCRIPTION	29	=head1 DESCRIPTION
22		30
23	This module collection manages coroutines. Coroutines are similar	31	For a tutorial-style introduction, please read the L<Coro::Intro>
24	to threads but don't run in parallel at the same time even on SMP	32	manpage. This manpage mainly contains reference information.
25	machines. The specific flavor of coroutine use din this module also
26	guarentees 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		33
31	(Perl, however, does not natively support real threads but instead does a	34	This module collection manages coroutines, that is, cooperative
32	very slow and memory-intensive emulation of processes using threads. This	35	threads. Coroutines are similar to kernel threads but don't (in general)
33	is a performance win on Windows machines, and a loss everywhere else).	36	run in parallel at the same time even on SMP machines. The specific flavor
		37	of coroutine used in this module also guarantees you that it will not
		38	switch between coroutines unless necessary, at easily-identified points
		39	in your program, so locking and parallel access are rarely an issue,
		40	making coroutine programming much safer and easier than using other thread
		41	models.
34		42
		43	Unlike the so-called "Perl threads" (which are not actually real threads
		44	but only the windows process emulation ported to unix), Coro provides a
		45	full shared address space, which makes communication between coroutines
		46	very easy. And coroutines are fast, too: disabling the Windows process
		47	emulation code in your perl and using Coro can easily result in a two to
		48	four times speed increase for your programs.
		49
		50	Coro achieves that by supporting multiple running interpreters that share
		51	data, which is especially useful to code pseudo-parallel processes and
		52	for event-based programming, such as multiple HTTP-GET requests running
		53	concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro
		54	into an event-based environment.
		55
35	In this module, coroutines are defined as "callchain + lexical variables +	56	In this module, a coroutines is defined as "callchain + lexical variables
36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,	57	+ @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own
37	its own set of lexicals and its own set of perls most important global	58	callchain, its own set of lexicals and its own set of perls most important
38	variables.	59	global variables (see L<Coro::State> for more configuration and background
		60	info).
		61
		62	See also the C<SEE ALSO> section at the end of this document - the Coro
		63	module family is quite large.
39		64
40	=cut	65	=cut
41		66
42	package Coro;	67	package Coro;
43		68
44	use strict;	69	use strict qw(vars subs);
45	no warnings "uninitialized";	70	no warnings "uninitialized";
46		71
47	use Coro::State;	72	use Coro::State;
48		73
49	use base qw(Coro::State Exporter);	74	use base qw(Coro::State Exporter);
50		75
51	our $idle; # idle handler	76	our $idle; # idle handler
52	our $main; # main coroutine	77	our $main; # main coroutine
53	our $current; # current coroutine	78	our $current; # current coroutine
54		79
55	our $VERSION = '3.3';	80	our $VERSION = "5.0";
56		81
57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);	82	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58	our %EXPORT_TAGS = (	83	our %EXPORT_TAGS = (
59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	84	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60	);	85	);
61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));	86	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
62		87
63	{	88	=head1 GLOBAL VARIABLES
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		89
97	=over 4	90	=over 4
98		91
99	=item $main	92	=item $Coro::main
100		93
101	This coroutine represents the main program.	94	This variable stores the coroutine object that represents the main
		95	program. While you cna C<ready> it and do most other things you can do to
		96	coroutines, it is mainly useful to compare again C<$Coro::current>, to see
		97	whether you are running in the main program or not.
102		98
103	=cut	99	=cut
104		100
105	$main = new Coro;	101	# $main is now being initialised by Coro::State
106		102
107	=item $current (or as function: current)	103	=item $Coro::current
108		104
109	The current coroutine (the last coroutine switched to). The initial value	105	The coroutine object representing the current coroutine (the last
		106	coroutine that the Coro scheduler switched to). The initial value is
110	is C<$main> (of course).	107	C<$Coro::main> (of course).
111		108
112	This variable is B<strictly> I<read-only>. It is provided for performance	109	This variable is B<strictly> I<read-only>. You can take copies of the
113	reasons. If performance is not essentiel you are encouraged to use the	110	value stored in it and use it as any other coroutine object, but you must
114	C<Coro::current> function instead.	111	not otherwise modify the variable itself.
115		112
116	=cut	113	=cut
117		114
118	# maybe some other module used Coro::Specific before...
119	$main->{specific} = $current->{specific}
120	if $current;
121
122	_set_current $main;
123
124	sub current() { $current }	115	sub current() { $current } # [DEPRECATED]
125		116
126	=item $idle	117	=item $Coro::idle
127		118
128	A callback that is called whenever the scheduler finds no ready coroutines	119	This variable is mainly useful to integrate Coro into event loops. It is
129	to run. The default implementation prints "FATAL: deadlock detected" and	120	usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is
130	exits, because the program has no other way to continue.	121	pretty low-level functionality.
		122
		123	This variable stores a callback that is called whenever the scheduler
		124	finds no ready coroutines to run. The default implementation prints
		125	"FATAL: deadlock detected" and exits, because the program has no other way
		126	to continue.
131		127
132	This hook is overwritten by modules such as C<Coro::Timer> and	128	This hook is overwritten by modules such as C<Coro::Timer> and
133	C<Coro::Event> to wait on an external event that hopefully wake up a	129	C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
134	coroutine so the scheduler can run it.	130	coroutine so the scheduler can run it.
135		131
		132	Note that the callback I<must not>, under any circumstances, block
		133	the current coroutine. Normally, this is achieved by having an "idle
		134	coroutine" that calls the event loop and then blocks again, and then
		135	readying that coroutine in the idle handler.
		136
		137	See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this
		138	technique.
		139
136	Please note that if your callback recursively invokes perl (e.g. for event	140	Please note that if your callback recursively invokes perl (e.g. for event
137	handlers), then it must be prepared to be called recursively.	141	handlers), then it must be prepared to be called recursively itself.
138		142
139	=cut	143	=cut
140		144
141	$idle = sub {	145	$idle = sub {
142	require Carp;	146	require Carp;
143	Carp::croak ("FATAL: deadlock detected");	147	Carp::croak ("FATAL: deadlock detected");
144	};	148	};
145		149
146	sub _cancel {
147	my ($self) = @_;
148
149	# free coroutine data and mark as destructed
150	$self->_destroy
151	or return;
152
153	# call all destruction callbacks
154	$_->(@{$self->{status}})
155	for @{(delete $self->{destroy_cb}) \|\| []};
156	}
157
158	# this coroutine is necessary because a coroutine	150	# this coroutine is necessary because a coroutine
159	# cannot destroy itself.	151	# cannot destroy itself.
160	my @destroy;	152	our @destroy;
161	my $manager;	153	our $manager;
162		154
163	$manager = new Coro sub {	155	$manager = new Coro sub {
164	while () {	156	while () {
165	(shift @destroy)->_cancel	157	Coro::_cancel shift @destroy
166	while @destroy;	158	while @destroy;
167		159
168	&schedule;	160	&schedule;
169	}	161	}
170	};	162	};
171		163	$manager->{desc} = "[coro manager]";
172	$manager->prio (PRIO_MAX);	164	$manager->prio (PRIO_MAX);
173		165
174	# static methods. not really.
175
176	=back	166	=back
177		167
178	=head2 STATIC METHODS	168	=head1 SIMPLE COROUTINE CREATION
179
180	Static methods are actually functions that operate on the current coroutine only.
181		169
182	=over 4	170	=over 4
183		171
184	=item async { ... } [@args...]	172	=item async { ... } [@args...]
185		173
186	Create a new asynchronous coroutine and return it's coroutine object	174	Create a new coroutine and return it's coroutine object (usually
187	(usually unused). When the sub returns the new coroutine is automatically	175	unused). The coroutine will be put into the ready queue, so
		176	it will start running automatically on the next scheduler run.
		177
		178	The first argument is a codeblock/closure that should be executed in the
		179	coroutine. When it returns argument returns the coroutine is automatically
188	terminated.	180	terminated.
189		181
190	Calling C<exit> in a coroutine will not work correctly, so do not do that.	182	The remaining arguments are passed as arguments to the closure.
191		183
192	When the coroutine dies, the program will exit, just as in the main	184	See the C<Coro::State::new> constructor for info about the coroutine
193	program.	185	environment in which coroutines are executed.
194		186
		187	Calling C<exit> in a coroutine will do the same as calling exit outside
		188	the coroutine. Likewise, when the coroutine dies, the program will exit,
		189	just as it would in the main program.
		190
		191	If you do not want that, you can provide a default C<die> handler, or
		192	simply avoid dieing (by use of C<eval>).
		193
195	# create a new coroutine that just prints its arguments	194	Example: Create a new coroutine that just prints its arguments.
		195
196	async {	196	async {
197	print "@_\n";	197	print "@_\n";
198	} 1,2,3,4;	198	} 1,2,3,4;
199		199
200	=cut	200	=cut
206	}	206	}
207		207
208	=item async_pool { ... } [@args...]	208	=item async_pool { ... } [@args...]
209		209
210	Similar to C<async>, but uses a coroutine pool, so you should not call	210	Similar to C<async>, but uses a coroutine pool, so you should not call
211	terminate or join (although you are allowed to), and you get a coroutine	211	terminate or join on it (although you are allowed to), and you get a
212	that might have executed other code already (which can be good or bad :).	212	coroutine that might have executed other code already (which can be good
		213	or bad :).
213		214
		215	On the plus side, this function is about twice as fast as creating (and
		216	destroying) a completely new coroutine, so if you need a lot of generic
		217	coroutines in quick successsion, use C<async_pool>, not C<async>.
		218
214	Also, the block is executed in an C<eval> context and a warning will be	219	The code block is executed in an C<eval> context and a warning will be
215	issued in case of an exception instead of terminating the program, as	220	issued in case of an exception instead of terminating the program, as
216	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>	221	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
217	will not work in the expected way, unless you call terminate or cancel,	222	will not work in the expected way, unless you call terminate or cancel,
218	which somehow defeats the purpose of pooling.	223	which somehow defeats the purpose of pooling (but is fine in the
		224	exceptional case).
219		225
220	The priority will be reset to C<0> after each job, otherwise the coroutine	226	The priority will be reset to C<0> after each run, tracing will be
221	will be re-used "as-is".	227	disabled, the description will be reset and the default output filehandle
		228	gets restored, so you can change all these. Otherwise the coroutine will
		229	be re-used "as-is": most notably if you change other per-coroutine global
		230	stuff such as C<$/> you I<must needs> revert that change, which is most
		231	simply done by using local as in: C<< local $/ >>.
222		232
223	The pool size is limited to 8 idle coroutines (this can be adjusted by	233	The idle pool size is limited to C<8> idle coroutines (this can be
224	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as	234	adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
225	required.	235	coros as required.
226		236
227	If you are concerned about pooled coroutines growing a lot because a	237	If you are concerned about pooled coroutines growing a lot because a
228	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {	238	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
229	terminate }> once per second or so to slowly replenish the pool.	239	{ terminate }> once per second or so to slowly replenish the pool. In
		240	addition to that, when the stacks used by a handler grows larger than 32kb
		241	(adjustable via $Coro::POOL_RSS) it will also be destroyed.
230		242
231	=cut	243	=cut
232		244
233	our $POOL_SIZE = 8;	245	our $POOL_SIZE = 8;
		246	our $POOL_RSS = 32 * 1024;
234	our @pool;	247	our @async_pool;
235		248
236	sub pool_handler {	249	sub pool_handler {
237	while () {	250	while () {
238	my ($cb, @arg) = @{ delete $current->{_invoke} };
239
240	eval {	251	eval {
241	$cb->(@arg);	252	&{&_pool_handler} while 1;
242	};	253	};
		254
243	warn $@ if $@;	255	warn $@ if $@;
244
245	last if @pool >= $POOL_SIZE;
246	push @pool, $current;
247
248	$current->prio (0);
249	schedule;
250	}	256	}
251	}	257	}
252		258
253	sub async_pool(&@) {	259	=back
254	# this is also inlined into the unlock_scheduler
255	my $coro = (pop @pool or new Coro \&pool_handler);
256		260
257	$coro->{_invoke} = [@_];	261	=head1 STATIC METHODS
258	$coro->ready;
259		262
260	$coro	263	Static methods are actually functions that implicitly operate on the
261	}	264	current coroutine.
		265
		266	=over 4
262		267
263	=item schedule	268	=item schedule
264		269
265	Calls the scheduler. Please note that the current coroutine will not be put	270	Calls the scheduler. The scheduler will find the next coroutine that is
		271	to be run from the ready queue and switches to it. The next coroutine
		272	to be run is simply the one with the highest priority that is longest
		273	in its ready queue. If there is no coroutine ready, it will clal the
		274	C<$Coro::idle> hook.
		275
		276	Please note that the current coroutine will I<not> be put into the ready
266	into the ready queue, so calling this function usually means you will	277	queue, so calling this function usually means you will never be called
267	never be called again unless something else (e.g. an event handler) calls	278	again unless something else (e.g. an event handler) calls C<< ->ready >>,
268	ready.	279	thus waking you up.
269		280
270	The canonical way to wait on external events is this:	281	This makes C<schedule> I<the> generic method to use to block the current
		282	coroutine and wait for events: first you remember the current coroutine in
		283	a variable, then arrange for some callback of yours to call C<< ->ready
		284	>> on that once some event happens, and last you call C<schedule> to put
		285	yourself to sleep. Note that a lot of things can wake your coroutine up,
		286	so you need to check whether the event indeed happened, e.g. by storing the
		287	status in a variable.
271		288
		289	See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks.
		290
		291	=item cede
		292
		293	"Cede" to other coroutines. This function puts the current coroutine into
		294	the ready queue and calls C<schedule>, which has the effect of giving
		295	up the current "timeslice" to other coroutines of the same or higher
		296	priority. Once your coroutine gets its turn again it will automatically be
		297	resumed.
		298
		299	This function is often called C<yield> in other languages.
		300
		301	=item Coro::cede_notself
		302
		303	Works like cede, but is not exported by default and will cede to I<any>
		304	coroutine, regardless of priority. This is useful sometimes to ensure
		305	progress is made.
		306
		307	=item terminate [arg...]
		308
		309	Terminates the current coroutine with the given status values (see L<cancel>).
		310
		311	=item killall
		312
		313	Kills/terminates/cancels all coroutines except the currently running
		314	one. This is useful after a fork, either in the child or the parent, as
		315	usually only one of them should inherit the running coroutines.
		316
		317	Note that while this will try to free some of the main programs resources,
		318	you cannot free all of them, so if a coroutine that is not the main
		319	program calls this function, there will be some one-time resource leak.
		320
		321	=cut
		322
		323	sub killall {
		324	for (Coro::State::list) {
		325	$_->cancel
		326	if $_ != $current && UNIVERSAL::isa $_, "Coro";
272	{	327	}
273	# remember current coroutine	328	}
		329
		330	=back
		331
		332	=head1 COROUTINE OBJECT METHODS
		333
		334	These are the methods you can call on coroutine objects (or to create
		335	them).
		336
		337	=over 4
		338
		339	=item new Coro \&sub [, @args...]
		340
		341	Create a new coroutine and return it. When the sub returns, the coroutine
		342	automatically terminates as if C<terminate> with the returned values were
		343	called. To make the coroutine run you must first put it into the ready
		344	queue by calling the ready method.
		345
		346	See C<async> and C<Coro::State::new> for additional info about the
		347	coroutine environment.
		348
		349	=cut
		350
		351	sub _terminate {
		352	terminate &{+shift};
		353	}
		354
		355	=item $success = $coroutine->ready
		356
		357	Put the given coroutine into the end of its ready queue (there is one
		358	queue for each priority) and return true. If the coroutine is already in
		359	the ready queue, do nothing and return false.
		360
		361	This ensures that the scheduler will resume this coroutine automatically
		362	once all the coroutines of higher priority and all coroutines of the same
		363	priority that were put into the ready queue earlier have been resumed.
		364
		365	=item $is_ready = $coroutine->is_ready
		366
		367	Return whether the coroutine is currently the ready queue or not,
		368
		369	=item $coroutine->cancel (arg...)
		370
		371	Terminates the given coroutine and makes it return the given arguments as
		372	status (default: the empty list). Never returns if the coroutine is the
		373	current coroutine.
		374
		375	=cut
		376
		377	sub cancel {
		378	my $self = shift;
		379
		380	if ($current == $self) {
		381	terminate @_;
		382	} else {
		383	$self->{_status} = [@_];
		384	$self->_cancel;
		385	}
		386	}
		387
		388	=item $coroutine->schedule_to
		389
		390	Puts the current coroutine to sleep (like C<Coro::schedule>), but instead
		391	of continuing with the next coro from the ready queue, always switch to
		392	the given coroutine object (regardless of priority etc.). The readyness
		393	state of that coroutine isn't changed.
		394
		395	This is an advanced method for special cases - I'd love to hear about any
		396	uses for this one.
		397
		398	=item $coroutine->cede_to
		399
		400	Like C<schedule_to>, but puts the current coroutine into the ready
		401	queue. This has the effect of temporarily switching to the given
		402	coroutine, and continuing some time later.
		403
		404	This is an advanced method for special cases - I'd love to hear about any
		405	uses for this one.
		406
		407	=item $coroutine->throw ([$scalar])
		408
		409	If C<$throw> is specified and defined, it will be thrown as an exception
		410	inside the coroutine at the next convenient point in time. Otherwise
		411	clears the exception object.
		412
		413	Coro will check for the exception each time a schedule-like-function
		414	returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down
		415	>>, C<< Coro::Handle->readable >> and so on. Most of these functions
		416	detect this case and return early in case an exception is pending.
		417
		418	The exception object will be thrown "as is" with the specified scalar in
		419	C<$@>, i.e. if it is a string, no line number or newline will be appended
		420	(unlike with C<die>).
		421
		422	This can be used as a softer means than C<cancel> to ask a coroutine to
		423	end itself, although there is no guarantee that the exception will lead to
		424	termination, and if the exception isn't caught it might well end the whole
		425	program.
		426
		427	You might also think of C<throw> as being the moral equivalent of
		428	C<kill>ing a coroutine with a signal (in this case, a scalar).
		429
		430	=item $coroutine->join
		431
		432	Wait until the coroutine terminates and return any values given to the
		433	C<terminate> or C<cancel> functions. C<join> can be called concurrently
		434	from multiple coroutines, and all will be resumed and given the status
		435	return once the C<$coroutine> terminates.
		436
		437	=cut
		438
		439	sub join {
		440	my $self = shift;
		441
		442	unless ($self->{_status}) {
274	my $current = $Coro::current;	443	my $current = $current;
275		444
276	# register a hypothetical event handler	445	push @{$self->{_on_destroy}}, sub {
277	on_event_invoke sub {
278	# wake up sleeping coroutine
279	$current->ready;	446	$current->ready;
280	undef $current;	447	undef $current;
281	};	448	};
282		449
283	# call schedule until event occured.
284	# in case we are woken up for other reasons
285	# (current still defined), loop.
286	Coro::schedule while $current;
287	}
288
289	=item cede
290
291	"Cede" to other coroutines. This function puts the current coroutine into the
292	ready queue and calls C<schedule>, which has the effect of giving up the
293	current "timeslice" to other coroutines of the same or higher priority.
294
295	Returns true if at least one coroutine switch has happened.
296
297	=item Coro::cede_notself
298
299	Works like cede, but is not exported by default and will cede to any
300	coroutine, regardless of priority, once.
301
302	Returns true if at least one coroutine switch has happened.
303
304	=item terminate [arg...]
305
306	Terminates the current coroutine with the given status values (see L<cancel>).
307
308	=cut
309
310	sub terminate {
311	$current->cancel (@_);
312	}
313
314	=back
315
316	# dynamic methods
317
318	=head2 COROUTINE METHODS
319
320	These are the methods you can call on coroutine objects.
321
322	=over 4
323
324	=item new Coro \&sub [, @args...]
325
326	Create a new coroutine and return it. When the sub returns the coroutine
327	automatically terminates as if C<terminate> with the returned values were
328	called. To make the coroutine run you must first put it into the ready queue
329	by calling the ready method.
330
331	Calling C<exit> in a coroutine will not work correctly, so do not do that.
332
333	=cut
334
335	sub _run_coro {
336	terminate &{+shift};
337	}
338
339	sub new {
340	my $class = shift;
341
342	$class->SUPER::new (\&_run_coro, @_)
343	}
344
345	=item $success = $coroutine->ready
346
347	Put the given coroutine into the ready queue (according to it's priority)
348	and return true. If the coroutine is already in the ready queue, do nothing
349	and return false.
350
351	=item $is_ready = $coroutine->is_ready
352
353	Return wether the coroutine is currently the ready queue or not,
354
355	=item $coroutine->cancel (arg...)
356
357	Terminates the given coroutine and makes it return the given arguments as
358	status (default: the empty list). Never returns if the coroutine is the
359	current coroutine.
360
361	=cut
362
363	sub cancel {
364	my $self = shift;
365	$self->{status} = [@_];
366
367	if ($current == $self) {
368	push @destroy, $self;
369	$manager->ready;
370	&schedule while 1;
371	} else {
372	$self->_cancel;
373	}
374	}
375
376	=item $coroutine->join
377
378	Wait until the coroutine terminates and return any values given to the
379	C<terminate> or C<cancel> functions. C<join> can be called multiple times
380	from multiple coroutine.
381
382	=cut
383
384	sub join {
385	my $self = shift;
386
387	unless ($self->{status}) {
388	my $current = $current;
389
390	push @{$self->{destroy_cb}}, sub {
391	$current->ready;
392	undef $current;
393	};
394
395	&schedule while $current;	450	&schedule while $current;
396	}	451	}
397		452
398	wantarray ? @{$self->{status}} : $self->{status}[0];	453	wantarray ? @{$self->{_status}} : $self->{_status}[0];
399	}	454	}
400		455
401	=item $coroutine->on_destroy (\&cb)	456	=item $coroutine->on_destroy (\&cb)
402		457
403	Registers a callback that is called when this coroutine gets destroyed,	458	Registers a callback that is called when this coroutine gets destroyed,
404	but before it is joined. The callback gets passed the terminate arguments,	459	but before it is joined. The callback gets passed the terminate arguments,
405	if any.	460	if any, and I<must not> die, under any circumstances.
406		461
407	=cut	462	=cut
408		463
409	sub on_destroy {	464	sub on_destroy {
410	my ($self, $cb) = @_;	465	my ($self, $cb) = @_;
411		466
412	push @{ $self->{destroy_cb} }, $cb;	467	push @{ $self->{_on_destroy} }, $cb;
413	}	468	}
414		469
415	=item $oldprio = $coroutine->prio ($newprio)	470	=item $oldprio = $coroutine->prio ($newprio)
416		471
417	Sets (or gets, if the argument is missing) the priority of the	472	Sets (or gets, if the argument is missing) the priority of the
…		…
440	higher values mean lower priority, just as in unix).	495	higher values mean lower priority, just as in unix).
441		496
442	=item $olddesc = $coroutine->desc ($newdesc)	497	=item $olddesc = $coroutine->desc ($newdesc)
443		498
444	Sets (or gets in case the argument is missing) the description for this	499	Sets (or gets in case the argument is missing) the description for this
445	coroutine. This is just a free-form string you can associate with a coroutine.	500	coroutine. This is just a free-form string you can associate with a
		501	coroutine.
		502
		503	This method simply sets the C<< $coroutine->{desc} >> member to the given
		504	string. You can modify this member directly if you wish.
446		505
447	=cut	506	=cut
448		507
449	sub desc {	508	sub desc {
450	my $old = $_[0]{desc};	509	my $old = $_[0]{desc};
451	$_[0]{desc} = $_[1] if @_ > 1;	510	$_[0]{desc} = $_[1] if @_ > 1;
452	$old;	511	$old;
453	}	512	}
454		513
		514	sub transfer {
		515	require Carp;
		516	Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught");
		517	}
		518
455	=back	519	=back
456		520
457	=head2 GLOBAL FUNCTIONS	521	=head1 GLOBAL FUNCTIONS
458		522
459	=over 4	523	=over 4
460		524
461	=item Coro::nready	525	=item Coro::nready
462		526
463	Returns the number of coroutines that are currently in the ready state,	527	Returns the number of coroutines that are currently in the ready state,
464	i.e. that can be swicthed to. The value C<0> means that the only runnable	528	i.e. that can be switched to by calling C<schedule> directory or
		529	indirectly. The value C<0> means that the only runnable coroutine is the
465	coroutine is the currently running one, so C<cede> would have no effect,	530	currently running one, so C<cede> would have no effect, and C<schedule>
466	and C<schedule> would cause a deadlock unless there is an idle handler	531	would cause a deadlock unless there is an idle handler that wakes up some
467	that wakes up some coroutines.	532	coroutines.
468		533
469	=item my $guard = Coro::guard { ... }	534	=item my $guard = Coro::guard { ... }
470		535
471	This creates and returns a guard object. Nothing happens until the objetc	536	This creates and returns a guard object. Nothing happens until the object
472	gets destroyed, in which case the codeblock given as argument will be	537	gets destroyed, in which case the codeblock given as argument will be
473	executed. This is useful to free locks or other resources in case of a	538	executed. This is useful to free locks or other resources in case of a
474	runtime error or when the coroutine gets canceled, as in both cases the	539	runtime error or when the coroutine gets canceled, as in both cases the
475	guard block will be executed. The guard object supports only one method,	540	guard block will be executed. The guard object supports only one method,
476	C<< ->cancel >>, which will keep the codeblock from being executed.	541	C<< ->cancel >>, which will keep the codeblock from being executed.
…		…
501		566
502		567
503	=item unblock_sub { ... }	568	=item unblock_sub { ... }
504		569
505	This utility function takes a BLOCK or code reference and "unblocks" it,	570	This utility function takes a BLOCK or code reference and "unblocks" it,
506	returning the new coderef. This means that the new coderef will return	571	returning a new coderef. Unblocking means that calling the new coderef
507	immediately without blocking, returning nothing, while the original code	572	will return immediately without blocking, returning nothing, while the
508	ref will be called (with parameters) from within its own coroutine.	573	original code ref will be called (with parameters) from within another
		574	coroutine.
509		575
510	The reason this fucntion exists is that many event libraries (such as the	576	The reason this function exists is that many event libraries (such as the
511	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form	577	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
512	of thread-safety). This means you must not block within event callbacks,	578	of thread-safety). This means you must not block within event callbacks,
513	otherwise you might suffer from crashes or worse.	579	otherwise you might suffer from crashes or worse. The only event library
		580	currently known that is safe to use without C<unblock_sub> is L<EV>.
514		581
515	This function allows your callbacks to block by executing them in another	582	This function allows your callbacks to block by executing them in another
516	coroutine where it is safe to block. One example where blocking is handy	583	coroutine where it is safe to block. One example where blocking is handy
517	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to	584	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
518	disk.	585	disk, for example.
519		586
520	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when	587	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
521	creating event callbacks that want to block.	588	creating event callbacks that want to block.
		589
		590	If your handler does not plan to block (e.g. simply sends a message to
		591	another coroutine, or puts some other coroutine into the ready queue),
		592	there is no reason to use C<unblock_sub>.
		593
		594	Note that you also need to use C<unblock_sub> for any other callbacks that
		595	are indirectly executed by any C-based event loop. For example, when you
		596	use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
		597	provides callbacks that are the result of some event callback, then you
		598	must not block either, or use C<unblock_sub>.
522		599
523	=cut	600	=cut
524		601
525	our @unblock_queue;	602	our @unblock_queue;
526		603
527	# we create a special coro because we want to cede,	604	# we create a special coro because we want to cede,
528	# to reduce pressure on the coro pool (because most callbacks	605	# to reduce pressure on the coro pool (because most callbacks
529	# return immediately and can be reused) and because we cannot cede	606	# return immediately and can be reused) and because we cannot cede
530	# inside an event callback.	607	# inside an event callback.
531	our $unblock_scheduler = async {	608	our $unblock_scheduler = new Coro sub {
532	while () {	609	while () {
533	while (my $cb = pop @unblock_queue) {	610	while (my $cb = pop @unblock_queue) {
534	# this is an inlined copy of async_pool	611	&async_pool (@$cb);
535	my $coro = (pop @pool or new Coro \&pool_handler);
536		612
537	$coro->{_invoke} = $cb;
538	$coro->ready;
539	cede; # for short-lived callbacks, this reduces pressure on the coro pool	613	# for short-lived callbacks, this reduces pressure on the coro pool
		614	# as the chance is very high that the async_poll coro will be back
		615	# in the idle state when cede returns
		616	cede;
540	}	617	}
541	schedule; # sleep well	618	schedule; # sleep well
542	}	619	}
543	};	620	};
		621	$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
544		622
545	sub unblock_sub(&) {	623	sub unblock_sub(&) {
546	my $cb = shift;	624	my $cb = shift;
547		625
548	sub {	626	sub {
549	unshift @unblock_queue, [$cb, @_];	627	unshift @unblock_queue, [$cb, @_];
550	$unblock_scheduler->ready;	628	$unblock_scheduler->ready;
551	}	629	}
552	}	630	}
553		631
		632	=item $cb = Coro::rouse_cb
		633
		634	Create and return a "rouse callback". That's a code reference that, when
		635	called, will save its arguments and notify the owner coroutine of the
		636	callback.
		637
		638	See the next function.
		639
		640	=item @args = Coro::rouse_wait [$cb]
		641
		642	Wait for the specified rouse callback (or the last one tht was created in
		643	this coroutine).
		644
		645	As soon as the callback is invoked (or when the calback was invoked before
		646	C<rouse_wait>), it will return a copy of the arguments originally passed
		647	to the rouse callback.
		648
		649	See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.
		650
554	=back	651	=back
555		652
556	=cut	653	=cut
557		654
558	1;	655	1;
559		656
		657	=head1 HOW TO WAIT FOR A CALLBACK
		658
		659	It is very common for a coroutine to wait for some callback to be
		660	called. This occurs naturally when you use coroutines in an otherwise
		661	event-based program, or when you use event-based libraries.
		662
		663	These typically register a callback for some event, and call that callback
		664	when the event occured. In a coroutine, however, you typically want to
		665	just wait for the event, simplyifying things.
		666
		667	For example C<< AnyEvent->child >> registers a callback to be called when
		668	a specific child has exited:
		669
		670	my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });
		671
		672	But from withina coroutine, you often just want to write this:
		673
		674	my $status = wait_for_child $pid;
		675
		676	Coro offers two functions specifically designed to make this easy,
		677	C<Coro::rouse_cb> and C<Coro::rouse_wait>.
		678
		679	The first function, C<rouse_cb>, generates and returns a callback that,
		680	when invoked, will save it's arguments and notify the coroutine that
		681	created the callback.
		682
		683	The second function, C<rouse_wait>, waits for the callback to be called
		684	(by calling C<schedule> to go to sleep) and returns the arguments
		685	originally passed to the callback.
		686
		687	Using these functions, it becomes easy to write the C<wait_for_child>
		688	function mentioned above:
		689
		690	sub wait_for_child($) {
		691	my ($pid) = @_;
		692
		693	my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb);
		694
		695	my ($rpid, $rstatus) = Coro::rouse_wait;
		696	$rstatus
		697	}
		698
		699	In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough,
		700	you can roll your own, using C<schedule>:
		701
		702	sub wait_for_child($) {
		703	my ($pid) = @_;
		704
		705	# store the current coroutine in $current,
		706	# and provide result variables for the closure passed to ->child
		707	my $current = $Coro::current;
		708	my ($done, $rstatus);
		709
		710	# pass a closure to ->child
		711	my $watcher = AnyEvent->child (pid => $pid, cb => sub {
		712	$rstatus = $_[1]; # remember rstatus
		713	$done = 1; # mark $rstatus as valud
		714	});
		715
		716	# wait until the closure has been called
		717	schedule while !$done;
		718
		719	$rstatus
		720	}
		721
		722
560	=head1 BUGS/LIMITATIONS	723	=head1 BUGS/LIMITATIONS
561		724
562	- you must make very sure that no coro is still active on global	725	=over 4
563	destruction. very bad things might happen otherwise (usually segfaults).
564		726
		727	=item fork with pthread backend
		728
		729	When Coro is compiled using the pthread backend (which isn't recommended
		730	but required on many BSDs as their libcs are completely broken), then
		731	coroutines will not survive a fork. There is no known workaround except to
		732	fix your libc and use a saner backend.
		733
		734	=item perl process emulation ("threads")
		735
565	- this module is not thread-safe. You should only ever use this module	736	This module is not perl-pseudo-thread-safe. You should only ever use this
566	from the same thread (this requirement might be losened in the future	737	module from the same thread (this requirement might be removed in the
567	to allow per-thread schedulers, but Coro::State does not yet allow	738	future to allow per-thread schedulers, but Coro::State does not yet allow
568	this).	739	this). I recommend disabling thread support and using processes, as having
		740	the windows process emulation enabled under unix roughly halves perl
		741	performance, even when not used.
		742
		743	=item coroutine switching not signal safe
		744
		745	You must not switch to another coroutine from within a signal handler
		746	(only relevant with %SIG - most event libraries provide safe signals).
		747
		748	That means you I<MUST NOT> call any function that might "block" the
		749	current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
		750	anything that calls those. Everything else, including calling C<ready>,
		751	works.
		752
		753	=back
		754
569		755
570	=head1 SEE ALSO	756	=head1 SEE ALSO
571		757
		758	Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
		759
		760	Debugging: L<Coro::Debug>.
		761
572	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	762	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
573		763
574	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.	764	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>,
		765	L<Coro::SemaphoreSet>, L<Coro::RWLock>.
575		766
576	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.	767	IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
577		768
578	Embedding: L<Coro:MakeMaker>	769	Compatibility: L<Coro::LWP> (but see also L<AnyEvent::HTTP> for
		770	a better-working alternative), L<Coro::BDB>, L<Coro::Storable>,
		771	L<Coro::Select>.
		772
		773	XS API: L<Coro::MakeMaker>.
		774
		775	Low level Configuration, Coroutine Environment: L<Coro::State>.
579		776
580	=head1 AUTHOR	777	=head1 AUTHOR
581		778
582	Marc Lehmann <schmorp@schmorp.de>	779	Marc Lehmann <schmorp@schmorp.de>
583	http://home.schmorp.de/	780	http://home.schmorp.de/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.108 by root, Fri Jan 5 20:00:49 2007 UTC vs. Revision 1.237 by root, Sat Nov 22 16:37:11 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.108 by root, Fri Jan 5 20:00:49 2007 UTC vs.
Revision 1.237 by root, Sat Nov 22 16:37:11 2008 UTC