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

Comparing Coro/Coro.pm (file contents):
Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC vs.
Revision 1.233 by root, Fri Nov 21 06:02:07 2008 UTC

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

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC vs. Revision 1.233 by root, Fri Nov 21 06:02:07 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC vs.
Revision 1.233 by root, Fri Nov 21 06:02:07 2008 UTC