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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.101 by root, Fri Dec 29 08:36:34 2006 UTC vs.
Revision 1.119 by root, Wed Mar 28 14:24:17 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.55';
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
…		…
198	} 1,2,3,4;	198	} 1,2,3,4;
199		199
200	=cut	200	=cut
201		201
202	sub async(&@) {	202	sub async(&@) {
203	my $pid = new Coro @_;	203	my $coro = new Coro @_;
204	$pid->ready;	204	$coro->ready;
205	$pid	205	$coro
		206	}
		207
		208	=item async_pool { ... } [@args...]
		209
		210	Similar to C<async>, but uses a coroutine pool, so you should not call
		211	terminate or join (although you are allowed to), and you get a coroutine
		212	that might have executed other code already (which can be good or bad :).
		213
		214	Also, the block is executed in an C<eval> context and a warning will be
		215	issued in case of an exception instead of terminating the program, as
		216	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
		217	will not work in the expected way, unless you call terminate or cancel,
		218	which somehow defeats the purpose of pooling.
		219
		220	The priority will be reset to C<0> after each job, otherwise the coroutine
		221	will be re-used "as-is".
		222
		223	The pool size is limited to 8 idle coroutines (this can be adjusted by
		224	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
		225	required.
		226
		227	If you are concerned about pooled coroutines growing a lot because a
		228	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {
		229	terminate }> once per second or so to slowly replenish the pool.
		230
		231	=cut
		232
		233	our $POOL_SIZE = 8;
		234	our @pool;
		235
		236	sub pool_handler {
		237	while () {
		238	eval {
		239	my ($cb, @arg) = @{ delete $current->{_invoke} or return };
		240	$cb->(@arg);
		241	};
		242	warn $@ if $@;
		243
		244	last if @pool >= $POOL_SIZE;
		245	push @pool, $current;
		246
		247	$current->save (Coro::State::SAVE_DEF);
		248	$current->prio (0);
		249	schedule;
		250	}
		251	}
		252
		253	sub async_pool(&@) {
		254	# this is also inlined into the unlock_scheduler
		255	my $coro = (pop @pool or new Coro \&pool_handler);
		256
		257	$coro->{_invoke} = [@_];
		258	$coro->ready;
		259
		260	$coro
206	}	261	}
207		262
208	=item schedule	263	=item schedule
209		264
210	Calls the scheduler. Please note that the current coroutine will not be put	265	Calls the scheduler. Please note that the current coroutine will not be put
…		…
235		290
236	"Cede" to other coroutines. This function puts the current coroutine into the	291	"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	292	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.	293	current "timeslice" to other coroutines of the same or higher priority.
239		294
		295	Returns true if at least one coroutine switch has happened.
		296
		297	=item Coro::cede_notself
		298
		299	Works like cede, but is not exported by default and will cede to any
		300	coroutine, regardless of priority, once.
		301
		302	Returns true if at least one coroutine switch has happened.
		303
240	=item terminate [arg...]	304	=item terminate [arg...]
241		305
242	Terminates the current coroutine with the given status values (see L<cancel>).	306	Terminates the current coroutine with the given status values (see L<cancel>).
243		307
244	=cut	308	=cut
…		…
289	Return wether the coroutine is currently the ready queue or not,	353	Return wether the coroutine is currently the ready queue or not,
290		354
291	=item $coroutine->cancel (arg...)	355	=item $coroutine->cancel (arg...)
292		356
293	Terminates the given coroutine and makes it return the given arguments as	357	Terminates the given coroutine and makes it return the given arguments as
294	status (default: the empty list).	358	status (default: the empty list). Never returns if the coroutine is the
		359	current coroutine.
295		360
296	=cut	361	=cut
297		362
298	sub cancel {	363	sub cancel {
299	my $self = shift;	364	my $self = shift;
300	$self->{status} = [@_];	365	$self->{status} = [@_];
		366
		367	if ($current == $self) {
301	push @destroy, $self;	368	push @destroy, $self;
302	$manager->ready;	369	$manager->ready;
303	&schedule if $current == $self;	370	&schedule while 1;
		371	} else {
		372	$self->_cancel;
		373	}
304	}	374	}
305		375
306	=item $coroutine->join	376	=item $coroutine->join
307		377
308	Wait until the coroutine terminates and return any values given to the	378	Wait until the coroutine terminates and return any values given to the
…		…
311		381
312	=cut	382	=cut
313		383
314	sub join {	384	sub join {
315	my $self = shift;	385	my $self = shift;
		386
316	unless ($self->{status}) {	387	unless ($self->{status}) {
317	push @{$self->{join}}, $current;	388	my $current = $current;
318	&schedule;	389
		390	push @{$self->{destroy_cb}}, sub {
		391	$current->ready;
		392	undef $current;
		393	};
		394
		395	&schedule while $current;
319	}	396	}
		397
320	wantarray ? @{$self->{status}} : $self->{status}[0];	398	wantarray ? @{$self->{status}} : $self->{status}[0];
321	}	399	}
322		400
323	=item $coroutine->on_destroy (\&cb)	401	=item $coroutine->on_destroy (\&cb)
324		402
…		…
386	i.e. that can be swicthed to. The value C<0> means that the only runnable	464	i.e. that can be swicthed to. The value C<0> means that the only runnable
387	coroutine is the currently running one, so C<cede> would have no effect,	465	coroutine is the currently running one, so C<cede> would have no effect,
388	and C<schedule> would cause a deadlock unless there is an idle handler	466	and C<schedule> would cause a deadlock unless there is an idle handler
389	that wakes up some coroutines.	467	that wakes up some coroutines.
390		468
		469	=item my $guard = Coro::guard { ... }
		470
		471	This creates and returns a guard object. Nothing happens until the object
		472	gets destroyed, in which case the codeblock given as argument will be
		473	executed. This is useful to free locks or other resources in case of a
		474	runtime error or when the coroutine gets canceled, as in both cases the
		475	guard block will be executed. The guard object supports only one method,
		476	C<< ->cancel >>, which will keep the codeblock from being executed.
		477
		478	Example: set some flag and clear it again when the coroutine gets canceled
		479	or the function returns:
		480
		481	sub do_something {
		482	my $guard = Coro::guard { $busy = 0 };
		483	$busy = 1;
		484
		485	# do something that requires $busy to be true
		486	}
		487
		488	=cut
		489
		490	sub guard(&) {
		491	bless \(my $cb = $_[0]), "Coro::guard"
		492	}
		493
		494	sub Coro::guard::cancel {
		495	${$_[0]} = sub { };
		496	}
		497
		498	sub Coro::guard::DESTROY {
		499	${$_[0]}->();
		500	}
		501
		502
391	=item unblock_sub { ... }	503	=item unblock_sub { ... }
392		504
393	This utility function takes a BLOCK or code reference and "unblocks" it,	505	This utility function takes a BLOCK or code reference and "unblocks" it,
394	returning the new coderef. This means that the new coderef will return	506	returning the new coderef. This means that the new coderef will return
395	immediately without blocking, returning nothing, while the original code	507	immediately without blocking, returning nothing, while the original code
…		…
408	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when	520	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
409	creating event callbacks that want to block.	521	creating event callbacks that want to block.
410		522
411	=cut	523	=cut
412		524
413	our @unblock_pool;
414	our @unblock_queue;	525	our @unblock_queue;
415	our $UNBLOCK_POOL_SIZE = 2;
416		526
417	sub unblock_handler_ {	527	# we create a special coro because we want to cede,
418	while () {	528	# to reduce pressure on the coro pool (because most callbacks
419	my ($cb, @arg) = @{ delete $Coro::current->{arg} };	529	# return immediately and can be reused) and because we cannot cede
420	$cb->(@arg);	530	# inside an event callback.
421
422	last if @unblock_pool >= $UNBLOCK_POOL_SIZE;
423	push @unblock_pool, $Coro::current;
424	schedule;
425	}
426	}
427
428	our $unblock_scheduler = async {	531	our $unblock_scheduler = async {
429	while () {	532	while () {
430	while (my $cb = pop @unblock_queue) {	533	while (my $cb = pop @unblock_queue) {
		534	# this is an inlined copy of async_pool
431	my $handler = (pop @unblock_pool or new Coro \&unblock_handler_);	535	my $coro = (pop @pool or new Coro \&pool_handler);
432	$handler->{arg} = $cb;	536
		537	$coro->{_invoke} = $cb;
433	$handler->ready;	538	$coro->ready;
434	cede;	539	cede; # for short-lived callbacks, this reduces pressure on the coro pool
435	}	540	}
436		541	schedule; # sleep well
437	schedule;
438	}	542	}
439	};	543	};
440		544
441	sub unblock_sub(&) {	545	sub unblock_sub(&) {
442	my $cb = shift;	546	my $cb = shift;
443		547
444	sub {	548	sub {
445	push @unblock_queue, [$cb, @_];	549	unshift @unblock_queue, [$cb, @_];
446	$unblock_scheduler->ready;	550	$unblock_scheduler->ready;
447	}	551	}
448	}	552	}
449		553
450	=back	554	=back

Diff Legend

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

Comparing cvsroot/Coro/Coro.pm (file contents): Revision 1.101 by root, Fri Dec 29 08:36:34 2006 UTC vs. Revision 1.119 by root, Wed Mar 28 14:24:17 2007 UTC

Diff Legend

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.101 by root, Fri Dec 29 08:36:34 2006 UTC vs.
Revision 1.119 by root, Wed Mar 28 14:24:17 2007 UTC