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

Comparing Coro/Coro.pm (file contents):
Revision 1.99 by root, Tue Dec 5 12:50:04 2006 UTC vs.
Revision 1.107 by root, Fri Jan 5 18:25:51 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.11';	55	our $VERSION = '3.3';
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	$coro->{status} \|\|= [];
159	$_->ready for @{delete $coro->{join} \|\| []};
160		167
161	# the next line destroys the coro state, but keeps the
162	# coroutine itself intact (we basically make it a zombie
163	# coroutine that always runs the manager thread, so it's possible
164	# to transfer() to this coroutine).
165	$coro->_clone_state_from ($manager);
166	}
167	&schedule;	168	&schedule;
168	}	169	}
169	};	170	};
		171
		172	$manager->prio (PRIO_MAX);
170		173
171	# static methods. not really.	174	# static methods. not really.
172		175
173	=back	176	=back
174		177
…		…
195	} 1,2,3,4;	198	} 1,2,3,4;
196		199
197	=cut	200	=cut
198		201
199	sub async(&@) {	202	sub async(&@) {
200	my $pid = new Coro @_;	203	my $coro = new Coro @_;
201	$pid->ready;	204	$coro->ready;
202	$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 C<async> does.
		216
		217	The priority will be reset to C<0> after each job, otherwise the coroutine
		218	will be re-used "as-is".
		219
		220	The pool size is limited to 8 idle coroutines (this can be adjusted by
		221	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
		222	required.
		223
		224	If you are concerned about pooled coroutines growing a lot because a
		225	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {
		226	terminate }> once per second or so to slowly replenish the pool.
		227
		228	=cut
		229
		230	our $POOL_SIZE = 8;
		231	our @pool;
		232
		233	sub pool_handler {
		234	while () {
		235	my ($cb, @arg) = @{ delete $current->{_invoke} };
		236
		237	eval {
		238	$cb->(@arg);
		239	};
		240	warn $@ if $@;
		241
		242	last if @pool >= $POOL_SIZE;
		243	push @pool, $current;
		244
		245	$current->prio (0);
		246	schedule;
		247	}
		248	}
		249
		250	sub async_pool(&@) {
		251	# this is also inlined into the unlock_scheduler
		252	my $coro = (pop @pool or new Coro \&pool_handler);
		253
		254	$coro->{_invoke} = [@_];
		255	$coro->ready;
		256
		257	$coro
203	}	258	}
204		259
205	=item schedule	260	=item schedule
206		261
207	Calls the scheduler. Please note that the current coroutine will not be put	262	Calls the scheduler. Please note that the current coroutine will not be put
…		…
232		287
233	"Cede" to other coroutines. This function puts the current coroutine into the	288	"Cede" to other coroutines. This function puts the current coroutine into the
234	ready queue and calls C<schedule>, which has the effect of giving up the	289	ready queue and calls C<schedule>, which has the effect of giving up the
235	current "timeslice" to other coroutines of the same or higher priority.	290	current "timeslice" to other coroutines of the same or higher priority.
236		291
		292	Returns true if at least one coroutine switch has happened.
		293
		294	=item Coro::cede_notself
		295
		296	Works like cede, but is not exported by default and will cede to any
		297	coroutine, regardless of priority, once.
		298
		299	Returns true if at least one coroutine switch has happened.
		300
237	=item terminate [arg...]	301	=item terminate [arg...]
238		302
239	Terminates the current coroutine with the given status values (see L<cancel>).	303	Terminates the current coroutine with the given status values (see L<cancel>).
240		304
241	=cut	305	=cut
…		…
286	Return wether the coroutine is currently the ready queue or not,	350	Return wether the coroutine is currently the ready queue or not,
287		351
288	=item $coroutine->cancel (arg...)	352	=item $coroutine->cancel (arg...)
289		353
290	Terminates the given coroutine and makes it return the given arguments as	354	Terminates the given coroutine and makes it return the given arguments as
291	status (default: the empty list).	355	status (default: the empty list). Never returns if the coroutine is the
		356	current coroutine.
292		357
293	=cut	358	=cut
294		359
295	sub cancel {	360	sub cancel {
296	my $self = shift;	361	my $self = shift;
297	$self->{status} = [@_];	362	$self->{status} = [@_];
		363
		364	if ($current == $self) {
298	push @destroy, $self;	365	push @destroy, $self;
299	$manager->ready;	366	$manager->ready;
300	&schedule if $current == $self;	367	&schedule while 1;
		368	} else {
		369	$self->_cancel;
		370	}
301	}	371	}
302		372
303	=item $coroutine->join	373	=item $coroutine->join
304		374
305	Wait until the coroutine terminates and return any values given to the	375	Wait until the coroutine terminates and return any values given to the
…		…
308		378
309	=cut	379	=cut
310		380
311	sub join {	381	sub join {
312	my $self = shift;	382	my $self = shift;
		383
313	unless ($self->{status}) {	384	unless ($self->{status}) {
314	push @{$self->{join}}, $current;	385	my $current = $current;
315	&schedule;	386
		387	push @{$self->{destroy_cb}}, sub {
		388	$current->ready;
		389	undef $current;
		390	};
		391
		392	&schedule while $current;
316	}	393	}
		394
317	wantarray ? @{$self->{status}} : $self->{status}[0];	395	wantarray ? @{$self->{status}} : $self->{status}[0];
		396	}
		397
		398	=item $coroutine->on_destroy (\&cb)
		399
		400	Registers a callback that is called when this coroutine gets destroyed,
		401	but before it is joined. The callback gets passed the terminate arguments,
		402	if any.
		403
		404	=cut
		405
		406	sub on_destroy {
		407	my ($self, $cb) = @_;
		408
		409	push @{ $self->{destroy_cb} }, $cb;
318	}	410	}
319		411
320	=item $oldprio = $coroutine->prio ($newprio)	412	=item $oldprio = $coroutine->prio ($newprio)
321		413
322	Sets (or gets, if the argument is missing) the priority of the	414	Sets (or gets, if the argument is missing) the priority of the
…		…
369	i.e. that can be swicthed to. The value C<0> means that the only runnable	461	i.e. that can be swicthed to. The value C<0> means that the only runnable
370	coroutine is the currently running one, so C<cede> would have no effect,	462	coroutine is the currently running one, so C<cede> would have no effect,
371	and C<schedule> would cause a deadlock unless there is an idle handler	463	and C<schedule> would cause a deadlock unless there is an idle handler
372	that wakes up some coroutines.	464	that wakes up some coroutines.
373		465
		466	=item my $guard = Coro::guard { ... }
		467
		468	This creates and returns a guard object. Nothing happens until the objetc
		469	gets destroyed, in which case the codeblock given as argument will be
		470	executed. This is useful to free locks or other resources in case of a
		471	runtime error or when the coroutine gets canceled, as in both cases the
		472	guard block will be executed. The guard object supports only one method,
		473	C<< ->cancel >>, which will keep the codeblock from being executed.
		474
		475	Example: set some flag and clear it again when the coroutine gets canceled
		476	or the function returns:
		477
		478	sub do_something {
		479	my $guard = Coro::guard { $busy = 0 };
		480	$busy = 1;
		481
		482	# do something that requires $busy to be true
		483	}
		484
		485	=cut
		486
		487	sub guard(&) {
		488	bless \(my $cb = $_[0]), "Coro::guard"
		489	}
		490
		491	sub Coro::guard::cancel {
		492	${$_[0]} = sub { };
		493	}
		494
		495	sub Coro::guard::DESTROY {
		496	${$_[0]}->();
		497	}
		498
		499
374	=item unblock_sub { ... }	500	=item unblock_sub { ... }
375		501
376	This utility function takes a BLOCK or code reference and "unblocks" it,	502	This utility function takes a BLOCK or code reference and "unblocks" it,
377	returning the new coderef. This means that the new coderef will return	503	returning the new coderef. This means that the new coderef will return
378	immediately without blocking, returning nothing, while the original code	504	immediately without blocking, returning nothing, while the original code
…		…
391	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when	517	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
392	creating event callbacks that want to block.	518	creating event callbacks that want to block.
393		519
394	=cut	520	=cut
395		521
396	our @unblock_pool;
397	our @unblock_queue;	522	our @unblock_queue;
398	our $UNBLOCK_POOL_SIZE = 2;
399		523
400	sub unblock_handler_ {	524	# we create a special coro because we want to cede,
401	while () {	525	# to reduce pressure on the coro pool (because most callbacks
402	my ($cb, @arg) = @{ delete $Coro::current->{arg} };	526	# return immediately and can be reused) and because we cannot cede
403	$cb->(@arg);	527	# inside an event callback.
404
405	last if @unblock_pool >= $UNBLOCK_POOL_SIZE;
406	push @unblock_pool, $Coro::current;
407	schedule;
408	}
409	}
410
411	our $unblock_scheduler = async {	528	our $unblock_scheduler = async {
412	while () {	529	while () {
413	while (my $cb = pop @unblock_queue) {	530	while (my $cb = pop @unblock_queue) {
		531	# this is an inlined copy of async_pool
414	my $handler = (pop @unblock_pool or new Coro \&unblock_handler_);	532	my $coro = (pop @pool or new Coro \&pool_handler);
415	$handler->{arg} = $cb;	533
		534	$coro->{_invoke} = $cb;
416	$handler->ready;	535	$coro->ready;
417	cede;	536	cede; # for short-lived callbacks, this reduces pressure on the coro pool
418	}	537	}
419		538	schedule; # sleep well
420	schedule;
421	}	539	}
422	};	540	};
423		541
424	sub unblock_sub(&) {	542	sub unblock_sub(&) {
425	my $cb = shift;	543	my $cb = shift;
426		544
427	sub {	545	sub {
428	push @unblock_queue, [$cb, @_];	546	unshift @unblock_queue, [$cb, @_];
429	$unblock_scheduler->ready;	547	$unblock_scheduler->ready;
430	}	548	}
431	}	549	}
432		550
433	=back	551	=back

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.99 by root, Tue Dec 5 12:50:04 2006 UTC vs. Revision 1.107 by root, Fri Jan 5 18:25:51 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.99 by root, Tue Dec 5 12:50:04 2006 UTC vs.
Revision 1.107 by root, Fri Jan 5 18:25:51 2007 UTC