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

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

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.162 by root, Wed Dec 12 19:09:33 2007 UTC vs. Revision 1.227 by root, Thu Nov 20 03:10:30 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.162 by root, Wed Dec 12 19:09:33 2007 UTC vs.
Revision 1.227 by root, Thu Nov 20 03:10:30 2008 UTC