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

Comparing Coro/Coro.pm (file contents):
Revision 1.121 by root, Fri Apr 13 12:56:55 2007 UTC vs.
Revision 1.145 by root, Wed Oct 3 16:03:17 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.56';	55	our $VERSION = '4.0';
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
		192	See the C<Coro::State::new> constructor for info about the coroutine
		193	environment.
		194
190	Calling C<exit> in a coroutine will try to do the same as calling exit	195	Calling C<exit> in a coroutine will do the same as calling exit outside
191	outside the coroutine, but this is experimental. It is best not to rely on	196	the coroutine. Likewise, when the coroutine dies, the program will exit,
192	exit doing any cleanups or even not crashing.	197	just as it would in the main program.
193
194	When the coroutine dies, the program will exit, just as in the main
195	program.
196		198
197	# create a new coroutine that just prints its arguments	199	# create a new coroutine that just prints its arguments
198	async {	200	async {
199	print "@_\n";	201	print "@_\n";
200	} 1,2,3,4;	202	} 1,2,3,4;
…		…
225	The pool size is limited to 8 idle coroutines (this can be adjusted by	227	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	228	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
227	required.	229	required.
228		230
229	If you are concerned about pooled coroutines growing a lot because a	231	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 {	232	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.	233	{ terminate }> once per second or so to slowly replenish the pool. In
		234	addition to that, when the stacks used by a handler grows larger than 16kb
		235	(adjustable with $Coro::POOL_RSS) it will also exit.
232		236
233	=cut	237	=cut
234		238
235	our $POOL_SIZE = 8;	239	our $POOL_SIZE = 8;
		240	our $POOL_RSS = 16 * 1024;
236	our @pool;	241	our @async_pool;
237		242
238	sub pool_handler {	243	sub pool_handler {
		244	my $cb;
		245
239	while () {	246	while () {
240	eval {	247	eval {
241	my ($cb, @arg) = @{ delete $current->{_invoke} or return };	248	while () {
242	$cb->(@arg);	249	_pool_1 $cb;
		250	&$cb;
		251	_pool_2 $cb;
		252	&schedule;
		253	}
243	};	254	};
		255
		256	last if $@ eq "\3terminate\2\n";
244	warn $@ if $@;	257	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	}	258	}
253	}	259	}
254		260
255	sub async_pool(&@) {	261	sub async_pool(&@) {
256	# this is also inlined into the unlock_scheduler	262	# this is also inlined into the unlock_scheduler
257	my $coro = (pop @pool or new Coro \&pool_handler);	263	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
258		264
259	$coro->{_invoke} = [@_];	265	$coro->{_invoke} = [@_];
260	$coro->ready;	266	$coro->ready;
261		267
262	$coro	268	$coro
…		…
280	# wake up sleeping coroutine	286	# wake up sleeping coroutine
281	$current->ready;	287	$current->ready;
282	undef $current;	288	undef $current;
283	};	289	};
284		290
285	# call schedule until event occured.	291	# call schedule until event occurred.
286	# in case we are woken up for other reasons	292	# in case we are woken up for other reasons
287	# (current still defined), loop.	293	# (current still defined), loop.
288	Coro::schedule while $current;	294	Coro::schedule while $current;
289	}	295	}
290		296
…		…
305		311
306	=item terminate [arg...]	312	=item terminate [arg...]
307		313
308	Terminates the current coroutine with the given status values (see L<cancel>).	314	Terminates the current coroutine with the given status values (see L<cancel>).
309		315
		316	=item killall
		317
		318	Kills/terminates/cancels all coroutines except the currently running
		319	one. This is useful after a fork, either in the child or the parent, as
		320	usually only one of them should inherit the running coroutines.
		321
310	=cut	322	=cut
311		323
312	sub terminate {	324	sub terminate {
313	$current->cancel (@_);	325	$current->cancel (@_);
		326	}
		327
		328	sub killall {
		329	for (Coro::State::list) {
		330	$_->cancel
		331	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		332	}
314	}	333	}
315		334
316	=back	335	=back
317		336
318	# dynamic methods	337	# dynamic methods
…		…
328	Create a new coroutine and return it. When the sub returns the coroutine	347	Create a new coroutine and return it. When the sub returns the coroutine
329	automatically terminates as if C<terminate> with the returned values were	348	automatically terminates as if C<terminate> with the returned values were
330	called. To make the coroutine run you must first put it into the ready queue	349	called. To make the coroutine run you must first put it into the ready queue
331	by calling the ready method.	350	by calling the ready method.
332		351
333	See C<async> for additional discussion.	352	See C<async> and C<Coro::State::new> for additional info about the
		353	coroutine environment.
334		354
335	=cut	355	=cut
336		356
337	sub _run_coro {	357	sub _run_coro {
338	terminate &{+shift};	358	terminate &{+shift};
…		…
362		382
363	=cut	383	=cut
364		384
365	sub cancel {	385	sub cancel {
366	my $self = shift;	386	my $self = shift;
367	$self->{status} = [@_];	387	$self->{_status} = [@_];
368		388
369	if ($current == $self) {	389	if ($current == $self) {
370	push @destroy, $self;	390	push @destroy, $self;
371	$manager->ready;	391	$manager->ready;
372	&schedule while 1;	392	&schedule while 1;
…		…
376	}	396	}
377		397
378	=item $coroutine->join	398	=item $coroutine->join
379		399
380	Wait until the coroutine terminates and return any values given to the	400	Wait until the coroutine terminates and return any values given to the
381	C<terminate> or C<cancel> functions. C<join> can be called multiple times	401	C<terminate> or C<cancel> functions. C<join> can be called concurrently
382	from multiple coroutine.	402	from multiple coroutines.
383		403
384	=cut	404	=cut
385		405
386	sub join {	406	sub join {
387	my $self = shift;	407	my $self = shift;
388		408
389	unless ($self->{status}) {	409	unless ($self->{_status}) {
390	my $current = $current;	410	my $current = $current;
391		411
392	push @{$self->{destroy_cb}}, sub {	412	push @{$self->{_on_destroy}}, sub {
393	$current->ready;	413	$current->ready;
394	undef $current;	414	undef $current;
395	};	415	};
396		416
397	&schedule while $current;	417	&schedule while $current;
398	}	418	}
399		419
400	wantarray ? @{$self->{status}} : $self->{status}[0];	420	wantarray ? @{$self->{_status}} : $self->{_status}[0];
401	}	421	}
402		422
403	=item $coroutine->on_destroy (\&cb)	423	=item $coroutine->on_destroy (\&cb)
404		424
405	Registers a callback that is called when this coroutine gets destroyed,	425	Registers a callback that is called when this coroutine gets destroyed,
…		…
409	=cut	429	=cut
410		430
411	sub on_destroy {	431	sub on_destroy {
412	my ($self, $cb) = @_;	432	my ($self, $cb) = @_;
413		433
414	push @{ $self->{destroy_cb} }, $cb;	434	push @{ $self->{_on_destroy} }, $cb;
415	}	435	}
416		436
417	=item $oldprio = $coroutine->prio ($newprio)	437	=item $oldprio = $coroutine->prio ($newprio)
418		438
419	Sets (or gets, if the argument is missing) the priority of the	439	Sets (or gets, if the argument is missing) the priority of the
…		…
444	=item $olddesc = $coroutine->desc ($newdesc)	464	=item $olddesc = $coroutine->desc ($newdesc)
445		465
446	Sets (or gets in case the argument is missing) the description for this	466	Sets (or gets in case the argument is missing) the description for this
447	coroutine. This is just a free-form string you can associate with a coroutine.	467	coroutine. This is just a free-form string you can associate with a coroutine.
448		468
		469	This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
		470	can modify this member directly if you wish.
		471
449	=cut	472	=cut
450		473
451	sub desc {	474	sub desc {
452	my $old = $_[0]{desc};	475	my $old = $_[0]{desc};
453	$_[0]{desc} = $_[1] if @_ > 1;	476	$_[0]{desc} = $_[1] if @_ > 1;
…		…
461	=over 4	484	=over 4
462		485
463	=item Coro::nready	486	=item Coro::nready
464		487
465	Returns the number of coroutines that are currently in the ready state,	488	Returns the number of coroutines that are currently in the ready state,
466	i.e. that can be swicthed to. The value C<0> means that the only runnable	489	i.e. that can be switched to. The value C<0> means that the only runnable
467	coroutine is the currently running one, so C<cede> would have no effect,	490	coroutine is the currently running one, so C<cede> would have no effect,
468	and C<schedule> would cause a deadlock unless there is an idle handler	491	and C<schedule> would cause a deadlock unless there is an idle handler
469	that wakes up some coroutines.	492	that wakes up some coroutines.
470		493
471	=item my $guard = Coro::guard { ... }	494	=item my $guard = Coro::guard { ... }
…		…
507	This utility function takes a BLOCK or code reference and "unblocks" it,	530	This utility function takes a BLOCK or code reference and "unblocks" it,
508	returning the new coderef. This means that the new coderef will return	531	returning the new coderef. This means that the new coderef will return
509	immediately without blocking, returning nothing, while the original code	532	immediately without blocking, returning nothing, while the original code
510	ref will be called (with parameters) from within its own coroutine.	533	ref will be called (with parameters) from within its own coroutine.
511		534
512	The reason this fucntion exists is that many event libraries (such as the	535	The reason this function exists is that many event libraries (such as the
513	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form	536	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
514	of thread-safety). This means you must not block within event callbacks,	537	of thread-safety). This means you must not block within event callbacks,
515	otherwise you might suffer from crashes or worse.	538	otherwise you might suffer from crashes or worse.
516		539
517	This function allows your callbacks to block by executing them in another	540	This function allows your callbacks to block by executing them in another
…		…
528		551
529	# we create a special coro because we want to cede,	552	# we create a special coro because we want to cede,
530	# to reduce pressure on the coro pool (because most callbacks	553	# to reduce pressure on the coro pool (because most callbacks
531	# return immediately and can be reused) and because we cannot cede	554	# return immediately and can be reused) and because we cannot cede
532	# inside an event callback.	555	# inside an event callback.
533	our $unblock_scheduler = async {	556	our $unblock_scheduler = new Coro sub {
534	while () {	557	while () {
535	while (my $cb = pop @unblock_queue) {	558	while (my $cb = pop @unblock_queue) {
536	# this is an inlined copy of async_pool	559	# this is an inlined copy of async_pool
537	my $coro = (pop @pool or new Coro \&pool_handler);	560	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
538		561
539	$coro->{_invoke} = $cb;	562	$coro->{_invoke} = $cb;
540	$coro->ready;	563	$coro->ready;
541	cede; # for short-lived callbacks, this reduces pressure on the coro pool	564	cede; # for short-lived callbacks, this reduces pressure on the coro pool
542	}	565	}
543	schedule; # sleep well	566	schedule; # sleep well
544	}	567	}
545	};	568	};
		569	$unblock_scheduler->desc ("[unblock_sub scheduler]");
546		570
547	sub unblock_sub(&) {	571	sub unblock_sub(&) {
548	my $cb = shift;	572	my $cb = shift;
549		573
550	sub {	574	sub {
…		…
563		587
564	- you must make very sure that no coro is still active on global	588	- you must make very sure that no coro is still active on global
565	destruction. very bad things might happen otherwise (usually segfaults).	589	destruction. very bad things might happen otherwise (usually segfaults).
566		590
567	- this module is not thread-safe. You should only ever use this module	591	- this module is not thread-safe. You should only ever use this module
568	from the same thread (this requirement might be losened in the future	592	from the same thread (this requirement might be loosened in the future
569	to allow per-thread schedulers, but Coro::State does not yet allow	593	to allow per-thread schedulers, but Coro::State does not yet allow
570	this).	594	this).
571		595
572	=head1 SEE ALSO	596	=head1 SEE ALSO
573		597

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.121 by root, Fri Apr 13 12:56:55 2007 UTC vs. Revision 1.145 by root, Wed Oct 3 16:03:17 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.121 by root, Fri Apr 13 12:56:55 2007 UTC vs.
Revision 1.145 by root, Wed Oct 3 16:03:17 2007 UTC