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

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

Diff Legend

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

Comparing cvsroot/Coro/Coro.pm (file contents): Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC vs. Revision 1.196 by root, Sat Aug 30 03:07:46 2008 UTC

Diff Legend

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC vs.
Revision 1.196 by root, Sat Aug 30 03:07:46 2008 UTC