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

Comparing Coro/Coro.pm (file contents):
Revision 1.114 by root, Wed Jan 24 16:22:08 2007 UTC vs.
Revision 1.142 by root, Tue Oct 2 23:16:24 2007 UTC

…		…
20		20
21	=head1 DESCRIPTION	21	=head1 DESCRIPTION
22		22
23	This module collection manages coroutines. Coroutines are similar	23	This module collection manages coroutines. Coroutines are similar
24	to threads but don't run in parallel at the same time even on SMP	24	to threads but don't run in parallel at the same time even on SMP
25	machines. The specific flavor of coroutine use din this module also	25	machines. The specific flavor of coroutine used in this module also
26	guarentees you that it will not switch between coroutines unless	26	guarantees you that it will not switch between coroutines unless
27	necessary, at easily-identified points in your program, so locking and	27	necessary, at easily-identified points in your program, so locking and
28	parallel access are rarely an issue, making coroutine programming much	28	parallel access are rarely an issue, making coroutine programming much
29	safer than threads programming.	29	safer than threads programming.
30		30
31	(Perl, however, does not natively support real threads but instead does a	31	(Perl, however, does not natively support real threads but instead does a
…		…
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.5';	55	our $VERSION = '3.8';
56		56
57	our @EXPORT = qw(async async_pool 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	);
…		…
108		108
109	The current coroutine (the last coroutine switched to). The initial value	109	The current coroutine (the last coroutine switched to). The initial value
110	is C<$main> (of course).	110	is C<$main> (of course).
111		111
112	This variable is B<strictly> I<read-only>. It is provided for performance	112	This variable is B<strictly> I<read-only>. It is provided for performance
113	reasons. If performance is not essentiel you are encouraged to use the	113	reasons. If performance is not essential you are encouraged to use the
114	C<Coro::current> function instead.	114	C<Coro::current> function instead.
115		115
116	=cut	116	=cut
117		117
		118	$main->{desc} = "[main::]";
		119
118	# maybe some other module used Coro::Specific before...	120	# maybe some other module used Coro::Specific before...
119	$main->{specific} = $current->{specific}	121	$main->{_specific} = $current->{_specific}
120	if $current;	122	if $current;
121		123
122	_set_current $main;	124	_set_current $main;
123		125
124	sub current() { $current }	126	sub current() { $current }
…		…
149	# free coroutine data and mark as destructed	151	# free coroutine data and mark as destructed
150	$self->_destroy	152	$self->_destroy
151	or return;	153	or return;
152		154
153	# call all destruction callbacks	155	# call all destruction callbacks
154	$_->(@{$self->{status}})	156	$_->(@{$self->{_status}})
155	for @{(delete $self->{destroy_cb}) \|\| []};	157	for @{(delete $self->{_on_destroy}) \|\| []};
156	}	158	}
157		159
158	# this coroutine is necessary because a coroutine	160	# this coroutine is necessary because a coroutine
159	# cannot destroy itself.	161	# cannot destroy itself.
160	my @destroy;	162	my @destroy;
…		…
166	while @destroy;	168	while @destroy;
167		169
168	&schedule;	170	&schedule;
169	}	171	}
170	};	172	};
171		173	$manager->desc ("[coro manager]");
172	$manager->prio (PRIO_MAX);	174	$manager->prio (PRIO_MAX);
173		175
174	# static methods. not really.	176	# static methods. not really.
175		177
176	=back	178	=back
…		…
185		187
186	Create a new asynchronous coroutine and return it's coroutine object	188	Create a new asynchronous coroutine and return it's coroutine object
187	(usually unused). When the sub returns the new coroutine is automatically	189	(usually unused). When the sub returns the new coroutine is automatically
188	terminated.	190	terminated.
189		191
190	Calling C<exit> in a coroutine will not work correctly, so do not do that.	192	Calling C<exit> in a coroutine will do the same as calling exit outside
191		193	the coroutine. Likewise, when the coroutine dies, the program will exit,
192	When the coroutine dies, the program will exit, just as in the main	194	just as it would in the main program.
193	program.
194		195
195	# create a new coroutine that just prints its arguments	196	# create a new coroutine that just prints its arguments
196	async {	197	async {
197	print "@_\n";	198	print "@_\n";
198	} 1,2,3,4;	199	} 1,2,3,4;
…		…
223	The pool size is limited to 8 idle coroutines (this can be adjusted by	224	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	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
225	required.	226	required.
226		227
227	If you are concerned about pooled coroutines growing a lot because a	228	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	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	{ terminate }> once per second or so to slowly replenish the pool. In
		231	addition to that, when the stacks used by a handler grows larger than 16kb
		232	(adjustable with $Coro::POOL_RSS) it will also exit.
230		233
231	=cut	234	=cut
232		235
233	our $POOL_SIZE = 8;	236	our $POOL_SIZE = 8;
		237	our $POOL_RSS = 16 * 1024;
234	our @pool;	238	our @async_pool;
235		239
236	sub pool_handler {	240	sub pool_handler {
		241	my $cb;
		242
237	while () {	243	while () {
238	eval {	244	eval {
239	my ($cb, @arg) = @{ delete $current->{_invoke} or return };	245	while () {
240	$cb->(@arg);	246	_pool_1 $cb;
		247	&$cb;
		248	_pool_2 $cb;
		249	&schedule;
		250	}
241	};	251	};
		252
		253	last if $@ eq "\3terminate\2\n";
242	warn $@ if $@;	254	warn $@ if $@;
243
244	last if @pool >= $POOL_SIZE;
245	push @pool, $current;
246
247	$current->prio (0);
248	schedule;
249	}	255	}
250	}	256	}
251		257
252	sub async_pool(&@) {	258	sub async_pool(&@) {
253	# this is also inlined into the unlock_scheduler	259	# this is also inlined into the unlock_scheduler
254	my $coro = (pop @pool or new Coro \&pool_handler);	260	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
255		261
256	$coro->{_invoke} = [@_];	262	$coro->{_invoke} = [@_];
257	$coro->ready;	263	$coro->ready;
258		264
259	$coro	265	$coro
…		…
277	# wake up sleeping coroutine	283	# wake up sleeping coroutine
278	$current->ready;	284	$current->ready;
279	undef $current;	285	undef $current;
280	};	286	};
281		287
282	# call schedule until event occured.	288	# call schedule until event occurred.
283	# in case we are woken up for other reasons	289	# in case we are woken up for other reasons
284	# (current still defined), loop.	290	# (current still defined), loop.
285	Coro::schedule while $current;	291	Coro::schedule while $current;
286	}	292	}
287		293
…		…
302		308
303	=item terminate [arg...]	309	=item terminate [arg...]
304		310
305	Terminates the current coroutine with the given status values (see L<cancel>).	311	Terminates the current coroutine with the given status values (see L<cancel>).
306		312
		313	=item killall
		314
		315	Kills/terminates/cancels all coroutines except the currently running
		316	one. This is useful after a fork, either in the child or the parent, as
		317	usually only one of them should inherit the running coroutines.
		318
307	=cut	319	=cut
308		320
309	sub terminate {	321	sub terminate {
310	$current->cancel (@_);	322	$current->cancel (@_);
		323	}
		324
		325	sub killall {
		326	for (Coro::State::list) {
		327	$_->cancel
		328	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		329	}
311	}	330	}
312		331
313	=back	332	=back
314		333
315	# dynamic methods	334	# dynamic methods
…		…
325	Create a new coroutine and return it. When the sub returns the coroutine	344	Create a new coroutine and return it. When the sub returns the coroutine
326	automatically terminates as if C<terminate> with the returned values were	345	automatically terminates as if C<terminate> with the returned values were
327	called. To make the coroutine run you must first put it into the ready queue	346	called. To make the coroutine run you must first put it into the ready queue
328	by calling the ready method.	347	by calling the ready method.
329		348
330	Calling C<exit> in a coroutine will not work correctly, so do not do that.	349	See C<async> for additional discussion.
331		350
332	=cut	351	=cut
333		352
334	sub _run_coro {	353	sub _run_coro {
335	terminate &{+shift};	354	terminate &{+shift};
…		…
359		378
360	=cut	379	=cut
361		380
362	sub cancel {	381	sub cancel {
363	my $self = shift;	382	my $self = shift;
364	$self->{status} = [@_];	383	$self->{_status} = [@_];
365		384
366	if ($current == $self) {	385	if ($current == $self) {
367	push @destroy, $self;	386	push @destroy, $self;
368	$manager->ready;	387	$manager->ready;
369	&schedule while 1;	388	&schedule while 1;
…		…
381	=cut	400	=cut
382		401
383	sub join {	402	sub join {
384	my $self = shift;	403	my $self = shift;
385		404
386	unless ($self->{status}) {	405	unless ($self->{_status}) {
387	my $current = $current;	406	my $current = $current;
388		407
389	push @{$self->{destroy_cb}}, sub {	408	push @{$self->{_on_destroy}}, sub {
390	$current->ready;	409	$current->ready;
391	undef $current;	410	undef $current;
392	};	411	};
393		412
394	&schedule while $current;	413	&schedule while $current;
395	}	414	}
396		415
397	wantarray ? @{$self->{status}} : $self->{status}[0];	416	wantarray ? @{$self->{_status}} : $self->{_status}[0];
398	}	417	}
399		418
400	=item $coroutine->on_destroy (\&cb)	419	=item $coroutine->on_destroy (\&cb)
401		420
402	Registers a callback that is called when this coroutine gets destroyed,	421	Registers a callback that is called when this coroutine gets destroyed,
…		…
406	=cut	425	=cut
407		426
408	sub on_destroy {	427	sub on_destroy {
409	my ($self, $cb) = @_;	428	my ($self, $cb) = @_;
410		429
411	push @{ $self->{destroy_cb} }, $cb;	430	push @{ $self->{_on_destroy} }, $cb;
412	}	431	}
413		432
414	=item $oldprio = $coroutine->prio ($newprio)	433	=item $oldprio = $coroutine->prio ($newprio)
415		434
416	Sets (or gets, if the argument is missing) the priority of the	435	Sets (or gets, if the argument is missing) the priority of the
…		…
441	=item $olddesc = $coroutine->desc ($newdesc)	460	=item $olddesc = $coroutine->desc ($newdesc)
442		461
443	Sets (or gets in case the argument is missing) the description for this	462	Sets (or gets in case the argument is missing) the description for this
444	coroutine. This is just a free-form string you can associate with a coroutine.	463	coroutine. This is just a free-form string you can associate with a coroutine.
445		464
		465	This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
		466	can modify this member directly if you wish.
		467
446	=cut	468	=cut
447		469
448	sub desc {	470	sub desc {
449	my $old = $_[0]{desc};	471	my $old = $_[0]{desc};
450	$_[0]{desc} = $_[1] if @_ > 1;	472	$_[0]{desc} = $_[1] if @_ > 1;
…		…
458	=over 4	480	=over 4
459		481
460	=item Coro::nready	482	=item Coro::nready
461		483
462	Returns the number of coroutines that are currently in the ready state,	484	Returns the number of coroutines that are currently in the ready state,
463	i.e. that can be swicthed to. The value C<0> means that the only runnable	485	i.e. that can be switched to. The value C<0> means that the only runnable
464	coroutine is the currently running one, so C<cede> would have no effect,	486	coroutine is the currently running one, so C<cede> would have no effect,
465	and C<schedule> would cause a deadlock unless there is an idle handler	487	and C<schedule> would cause a deadlock unless there is an idle handler
466	that wakes up some coroutines.	488	that wakes up some coroutines.
467		489
468	=item my $guard = Coro::guard { ... }	490	=item my $guard = Coro::guard { ... }
469		491
470	This creates and returns a guard object. Nothing happens until the objetc	492	This creates and returns a guard object. Nothing happens until the object
471	gets destroyed, in which case the codeblock given as argument will be	493	gets destroyed, in which case the codeblock given as argument will be
472	executed. This is useful to free locks or other resources in case of a	494	executed. This is useful to free locks or other resources in case of a
473	runtime error or when the coroutine gets canceled, as in both cases the	495	runtime error or when the coroutine gets canceled, as in both cases the
474	guard block will be executed. The guard object supports only one method,	496	guard block will be executed. The guard object supports only one method,
475	C<< ->cancel >>, which will keep the codeblock from being executed.	497	C<< ->cancel >>, which will keep the codeblock from being executed.
…		…
504	This utility function takes a BLOCK or code reference and "unblocks" it,	526	This utility function takes a BLOCK or code reference and "unblocks" it,
505	returning the new coderef. This means that the new coderef will return	527	returning the new coderef. This means that the new coderef will return
506	immediately without blocking, returning nothing, while the original code	528	immediately without blocking, returning nothing, while the original code
507	ref will be called (with parameters) from within its own coroutine.	529	ref will be called (with parameters) from within its own coroutine.
508		530
509	The reason this fucntion exists is that many event libraries (such as the	531	The reason this function exists is that many event libraries (such as the
510	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form	532	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
511	of thread-safety). This means you must not block within event callbacks,	533	of thread-safety). This means you must not block within event callbacks,
512	otherwise you might suffer from crashes or worse.	534	otherwise you might suffer from crashes or worse.
513		535
514	This function allows your callbacks to block by executing them in another	536	This function allows your callbacks to block by executing them in another
…		…
525		547
526	# we create a special coro because we want to cede,	548	# we create a special coro because we want to cede,
527	# to reduce pressure on the coro pool (because most callbacks	549	# to reduce pressure on the coro pool (because most callbacks
528	# return immediately and can be reused) and because we cannot cede	550	# return immediately and can be reused) and because we cannot cede
529	# inside an event callback.	551	# inside an event callback.
530	our $unblock_scheduler = async {	552	our $unblock_scheduler = new Coro sub {
531	while () {	553	while () {
532	while (my $cb = pop @unblock_queue) {	554	while (my $cb = pop @unblock_queue) {
533	# this is an inlined copy of async_pool	555	# this is an inlined copy of async_pool
534	my $coro = (pop @pool or new Coro \&pool_handler);	556	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
535		557
536	$coro->{_invoke} = $cb;	558	$coro->{_invoke} = $cb;
537	$coro->ready;	559	$coro->ready;
538	cede; # for short-lived callbacks, this reduces pressure on the coro pool	560	cede; # for short-lived callbacks, this reduces pressure on the coro pool
539	}	561	}
540	schedule; # sleep well	562	schedule; # sleep well
541	}	563	}
542	};	564	};
		565	$unblock_scheduler->desc ("[unblock_sub scheduler]");
543		566
544	sub unblock_sub(&) {	567	sub unblock_sub(&) {
545	my $cb = shift;	568	my $cb = shift;
546		569
547	sub {	570	sub {
…		…
560		583
561	- you must make very sure that no coro is still active on global	584	- you must make very sure that no coro is still active on global
562	destruction. very bad things might happen otherwise (usually segfaults).	585	destruction. very bad things might happen otherwise (usually segfaults).
563		586
564	- this module is not thread-safe. You should only ever use this module	587	- this module is not thread-safe. You should only ever use this module
565	from the same thread (this requirement might be losened in the future	588	from the same thread (this requirement might be loosened in the future
566	to allow per-thread schedulers, but Coro::State does not yet allow	589	to allow per-thread schedulers, but Coro::State does not yet allow
567	this).	590	this).
568		591
569	=head1 SEE ALSO	592	=head1 SEE ALSO
570		593

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.114 by root, Wed Jan 24 16:22:08 2007 UTC vs. Revision 1.142 by root, Tue Oct 2 23:16:24 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.114 by root, Wed Jan 24 16:22:08 2007 UTC vs.
Revision 1.142 by root, Tue Oct 2 23:16:24 2007 UTC