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

Comparing Coro/Coro.pm (file contents):
Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC vs.
Revision 1.121 by root, Fri Apr 13 12:56:55 2007 UTC

…		…
50		50
51	our $idle; # idle handler	51	our $idle; # idle handler
52	our $main; # main coroutine	52	our $main; # main coroutine
53	our $current; # current coroutine	53	our $current; # current coroutine
54		54
55	our $VERSION = '3.3';	55	our $VERSION = '3.56';
56		56
57	our @EXPORT = qw(async cede schedule terminate current unblock_sub);	57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58	our %EXPORT_TAGS = (	58	our %EXPORT_TAGS = (
59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60	);	60	);
61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));	61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
62		62
…		…
141	$idle = sub {	141	$idle = sub {
142	require Carp;	142	require Carp;
143	Carp::croak ("FATAL: deadlock detected");	143	Carp::croak ("FATAL: deadlock detected");
144	};	144	};
145		145
		146	sub _cancel {
		147	my ($self) = @_;
		148
		149	# free coroutine data and mark as destructed
		150	$self->_destroy
		151	or return;
		152
		153	# call all destruction callbacks
		154	$_->(@{$self->{status}})
		155	for @{(delete $self->{destroy_cb}) \|\| []};
		156	}
		157
146	# this coroutine is necessary because a coroutine	158	# this coroutine is necessary because a coroutine
147	# cannot destroy itself.	159	# cannot destroy itself.
148	my @destroy;	160	my @destroy;
		161	my $manager;
		162
149	my $manager; $manager = new Coro sub {	163	$manager = new Coro sub {
150	while () {	164	while () {
151	# by overwriting the state object with the manager we destroy it	165	(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) {	166	while @destroy;
157	my $coro = pop @destroy;
158		167
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;	168	&schedule;
171	}	169	}
172	};	170	};
		171
		172	$manager->prio (PRIO_MAX);
173		173
174	# static methods. not really.	174	# static methods. not really.
175		175
176	=back	176	=back
177		177
…		…
185		185
186	Create a new asynchronous coroutine and return it's coroutine object	186	Create a new asynchronous coroutine and return it's coroutine object
187	(usually unused). When the sub returns the new coroutine is automatically	187	(usually unused). When the sub returns the new coroutine is automatically
188	terminated.	188	terminated.
189		189
190	Calling C<exit> in a coroutine will not work correctly, so do not do that.	190	Calling C<exit> in a coroutine will try to do the same as calling exit
		191	outside the coroutine, but this is experimental. It is best not to rely on
		192	exit doing any cleanups or even not crashing.
191		193
192	When the coroutine dies, the program will exit, just as in the main	194	When the coroutine dies, the program will exit, just as in the main
193	program.	195	program.
194		196
195	# create a new coroutine that just prints its arguments	197	# create a new coroutine that just prints its arguments
…		…
198	} 1,2,3,4;	200	} 1,2,3,4;
199		201
200	=cut	202	=cut
201		203
202	sub async(&@) {	204	sub async(&@) {
203	my $pid = new Coro @_;	205	my $coro = new Coro @_;
204	$pid->ready;	206	$coro->ready;
205	$pid	207	$coro
		208	}
		209
		210	=item async_pool { ... } [@args...]
		211
		212	Similar to C<async>, but uses a coroutine pool, so you should not call
		213	terminate or join (although you are allowed to), and you get a coroutine
		214	that might have executed other code already (which can be good or bad :).
		215
		216	Also, the block is executed in an C<eval> context and a warning will be
		217	issued in case of an exception instead of terminating the program, as
		218	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
		219	will not work in the expected way, unless you call terminate or cancel,
		220	which somehow defeats the purpose of pooling.
		221
		222	The priority will be reset to C<0> after each job, otherwise the coroutine
		223	will be re-used "as-is".
		224
		225	The pool size is limited to 8 idle coroutines (this can be adjusted by
		226	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
		227	required.
		228
		229	If you are concerned about pooled coroutines growing a lot because a
		230	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {
		231	terminate }> once per second or so to slowly replenish the pool.
		232
		233	=cut
		234
		235	our $POOL_SIZE = 8;
		236	our @pool;
		237
		238	sub pool_handler {
		239	while () {
		240	eval {
		241	my ($cb, @arg) = @{ delete $current->{_invoke} or return };
		242	$cb->(@arg);
		243	};
		244	warn $@ if $@;
		245
		246	last if @pool >= $POOL_SIZE;
		247	push @pool, $current;
		248
		249	$current->save (Coro::State::SAVE_DEF);
		250	$current->prio (0);
		251	schedule;
		252	}
		253	}
		254
		255	sub async_pool(&@) {
		256	# this is also inlined into the unlock_scheduler
		257	my $coro = (pop @pool or new Coro \&pool_handler);
		258
		259	$coro->{_invoke} = [@_];
		260	$coro->ready;
		261
		262	$coro
206	}	263	}
207		264
208	=item schedule	265	=item schedule
209		266
210	Calls the scheduler. Please note that the current coroutine will not be put	267	Calls the scheduler. Please note that the current coroutine will not be put
…		…
235		292
236	"Cede" to other coroutines. This function puts the current coroutine into the	293	"Cede" to other coroutines. This function puts the current coroutine into the
237	ready queue and calls C<schedule>, which has the effect of giving up the	294	ready queue and calls C<schedule>, which has the effect of giving up the
238	current "timeslice" to other coroutines of the same or higher priority.	295	current "timeslice" to other coroutines of the same or higher priority.
239		296
		297	Returns true if at least one coroutine switch has happened.
		298
240	=item Coro::cede_notself	299	=item Coro::cede_notself
241		300
242	Works like cede, but is not exported by default and will cede to any	301	Works like cede, but is not exported by default and will cede to any
243	coroutine, regardless of priority, once.	302	coroutine, regardless of priority, once.
		303
		304	Returns true if at least one coroutine switch has happened.
244		305
245	=item terminate [arg...]	306	=item terminate [arg...]
246		307
247	Terminates the current coroutine with the given status values (see L<cancel>).	308	Terminates the current coroutine with the given status values (see L<cancel>).
248		309
…		…
267	Create a new coroutine and return it. When the sub returns the coroutine	328	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	329	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	330	called. To make the coroutine run you must first put it into the ready queue
270	by calling the ready method.	331	by calling the ready method.
271		332
272	Calling C<exit> in a coroutine will not work correctly, so do not do that.	333	See C<async> for additional discussion.
273		334
274	=cut	335	=cut
275		336
276	sub _run_coro {	337	sub _run_coro {
277	terminate &{+shift};	338	terminate &{+shift};
…		…
294	Return wether the coroutine is currently the ready queue or not,	355	Return wether the coroutine is currently the ready queue or not,
295		356
296	=item $coroutine->cancel (arg...)	357	=item $coroutine->cancel (arg...)
297		358
298	Terminates the given coroutine and makes it return the given arguments as	359	Terminates the given coroutine and makes it return the given arguments as
299	status (default: the empty list).	360	status (default: the empty list). Never returns if the coroutine is the
		361	current coroutine.
300		362
301	=cut	363	=cut
302		364
303	sub cancel {	365	sub cancel {
304	my $self = shift;	366	my $self = shift;
305	$self->{status} = [@_];	367	$self->{status} = [@_];
		368
		369	if ($current == $self) {
306	push @destroy, $self;	370	push @destroy, $self;
307	$manager->ready;	371	$manager->ready;
308	&schedule if $current == $self;	372	&schedule while 1;
		373	} else {
		374	$self->_cancel;
		375	}
309	}	376	}
310		377
311	=item $coroutine->join	378	=item $coroutine->join
312		379
313	Wait until the coroutine terminates and return any values given to the	380	Wait until the coroutine terminates and return any values given to the
…		…
316		383
317	=cut	384	=cut
318		385
319	sub join {	386	sub join {
320	my $self = shift;	387	my $self = shift;
		388
321	unless ($self->{status}) {	389	unless ($self->{status}) {
322	push @{$self->{join}}, $current;	390	my $current = $current;
323	&schedule;	391
		392	push @{$self->{destroy_cb}}, sub {
		393	$current->ready;
		394	undef $current;
		395	};
		396
		397	&schedule while $current;
324	}	398	}
		399
325	wantarray ? @{$self->{status}} : $self->{status}[0];	400	wantarray ? @{$self->{status}} : $self->{status}[0];
326	}	401	}
327		402
328	=item $coroutine->on_destroy (\&cb)	403	=item $coroutine->on_destroy (\&cb)
329		404
…		…
391	i.e. that can be swicthed to. The value C<0> means that the only runnable	466	i.e. that can be swicthed to. The value C<0> means that the only runnable
392	coroutine is the currently running one, so C<cede> would have no effect,	467	coroutine is the currently running one, so C<cede> would have no effect,
393	and C<schedule> would cause a deadlock unless there is an idle handler	468	and C<schedule> would cause a deadlock unless there is an idle handler
394	that wakes up some coroutines.	469	that wakes up some coroutines.
395		470
		471	=item my $guard = Coro::guard { ... }
		472
		473	This creates and returns a guard object. Nothing happens until the object
		474	gets destroyed, in which case the codeblock given as argument will be
		475	executed. This is useful to free locks or other resources in case of a
		476	runtime error or when the coroutine gets canceled, as in both cases the
		477	guard block will be executed. The guard object supports only one method,
		478	C<< ->cancel >>, which will keep the codeblock from being executed.
		479
		480	Example: set some flag and clear it again when the coroutine gets canceled
		481	or the function returns:
		482
		483	sub do_something {
		484	my $guard = Coro::guard { $busy = 0 };
		485	$busy = 1;
		486
		487	# do something that requires $busy to be true
		488	}
		489
		490	=cut
		491
		492	sub guard(&) {
		493	bless \(my $cb = $_[0]), "Coro::guard"
		494	}
		495
		496	sub Coro::guard::cancel {
		497	${$_[0]} = sub { };
		498	}
		499
		500	sub Coro::guard::DESTROY {
		501	${$_[0]}->();
		502	}
		503
		504
396	=item unblock_sub { ... }	505	=item unblock_sub { ... }
397		506
398	This utility function takes a BLOCK or code reference and "unblocks" it,	507	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	508	returning the new coderef. This means that the new coderef will return
400	immediately without blocking, returning nothing, while the original code	509	immediately without blocking, returning nothing, while the original code
…		…
413	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when	522	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
414	creating event callbacks that want to block.	523	creating event callbacks that want to block.
415		524
416	=cut	525	=cut
417		526
418	our @unblock_pool;
419	our @unblock_queue;	527	our @unblock_queue;
420	our $UNBLOCK_POOL_SIZE = 2;
421		528
422	sub unblock_handler_ {	529	# we create a special coro because we want to cede,
423	while () {	530	# to reduce pressure on the coro pool (because most callbacks
424	my ($cb, @arg) = @{ delete $Coro::current->{arg} };	531	# return immediately and can be reused) and because we cannot cede
425	$cb->(@arg);	532	# 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 {	533	our $unblock_scheduler = async {
434	while () {	534	while () {
435	while (my $cb = pop @unblock_queue) {	535	while (my $cb = pop @unblock_queue) {
		536	# this is an inlined copy of async_pool
436	my $handler = (pop @unblock_pool or new Coro \&unblock_handler_);	537	my $coro = (pop @pool or new Coro \&pool_handler);
437	$handler->{arg} = $cb;	538
		539	$coro->{_invoke} = $cb;
438	$handler->ready;	540	$coro->ready;
439	cede;	541	cede; # for short-lived callbacks, this reduces pressure on the coro pool
440	}	542	}
441		543	schedule; # sleep well
442	schedule;
443	}	544	}
444	};	545	};
445		546
446	sub unblock_sub(&) {	547	sub unblock_sub(&) {
447	my $cb = shift;	548	my $cb = shift;
448		549
449	sub {	550	sub {
450	push @unblock_queue, [$cb, @_];	551	unshift @unblock_queue, [$cb, @_];
451	$unblock_scheduler->ready;	552	$unblock_scheduler->ready;
452	}	553	}
453	}	554	}
454		555
455	=back	556	=back

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC vs. Revision 1.121 by root, Fri Apr 13 12:56:55 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC vs.
Revision 1.121 by root, Fri Apr 13 12:56:55 2007 UTC