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

Comparing Coro/Coro.pm (file contents):
Revision 1.128 by root, Wed Sep 19 21:39:15 2007 UTC vs.
Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC

…		…
6		6
7	use Coro;	7	use Coro;
8		8
9	async {	9	async {
10	# some asynchronous thread of execution	10	# some asynchronous thread of execution
		11	print "2\n";
		12	cede; # yield back to main
		13	print "4\n";
11	};	14	};
		15	print "1\n";
		16	cede; # yield to coroutine
		17	print "3\n";
		18	cede; # and again
12		19
13	# alternatively create an async coroutine like this:	20	# use locking
		21	my $lock = new Coro::Semaphore;
		22	my $locked;
14		23
15	sub some_func : Coro {	24	$lock->down;
16	# some more async code	25	$locked = 1;
17	}	26	$lock->up;
18
19	cede;
20		27
21	=head1 DESCRIPTION	28	=head1 DESCRIPTION
22		29
23	This module collection manages coroutines. Coroutines are similar	30	This module collection manages coroutines. Coroutines are similar
24	to threads but don't run in parallel at the same time even on SMP	31	to threads but don't run in parallel at the same time even on SMP
…		…
33	is a performance win on Windows machines, and a loss everywhere else).	40	is a performance win on Windows machines, and a loss everywhere else).
34		41
35	In this module, coroutines are defined as "callchain + lexical variables +	42	In this module, coroutines are defined as "callchain + lexical variables +
36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,	43	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
37	its own set of lexicals and its own set of perls most important global	44	its own set of lexicals and its own set of perls most important global
38	variables.	45	variables (see L<Coro::State> for more configuration).
39		46
40	=cut	47	=cut
41		48
42	package Coro;	49	package Coro;
43		50
…		…
50		57
51	our $idle; # idle handler	58	our $idle; # idle handler
52	our $main; # main coroutine	59	our $main; # main coroutine
53	our $current; # current coroutine	60	our $current; # current coroutine
54		61
55	our $VERSION = '3.7';	62	our $VERSION = '4.51';
56		63
57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);	64	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
58	our %EXPORT_TAGS = (	65	our %EXPORT_TAGS = (
59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	66	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60	);	67	);
…		…
113	reasons. If performance is not essential you are encouraged to use the	120	reasons. If performance is not essential you are encouraged to use the
114	C<Coro::current> function instead.	121	C<Coro::current> function instead.
115		122
116	=cut	123	=cut
117		124
		125	$main->{desc} = "[main::]";
		126
118	# maybe some other module used Coro::Specific before...	127	# maybe some other module used Coro::Specific before...
119	$main->{specific} = $current->{specific}	128	$main->{_specific} = $current->{_specific}
120	if $current;	129	if $current;
121		130
122	_set_current $main;	131	_set_current $main;
123		132
124	sub current() { $current }	133	sub current() { $current }
…		…
132	This hook is overwritten by modules such as C<Coro::Timer> and	141	This hook is overwritten by modules such as C<Coro::Timer> and
133	C<Coro::Event> to wait on an external event that hopefully wake up a	142	C<Coro::Event> to wait on an external event that hopefully wake up a
134	coroutine so the scheduler can run it.	143	coroutine so the scheduler can run it.
135		144
136	Please note that if your callback recursively invokes perl (e.g. for event	145	Please note that if your callback recursively invokes perl (e.g. for event
137	handlers), then it must be prepared to be called recursively.	146	handlers), then it must be prepared to be called recursively itself.
138		147
139	=cut	148	=cut
140		149
141	$idle = sub {	150	$idle = sub {
142	require Carp;	151	require Carp;
…		…
149	# free coroutine data and mark as destructed	158	# free coroutine data and mark as destructed
150	$self->_destroy	159	$self->_destroy
151	or return;	160	or return;
152		161
153	# call all destruction callbacks	162	# call all destruction callbacks
154	$_->(@{$self->{status}})	163	$_->(@{$self->{_status}})
155	for @{(delete $self->{destroy_cb}) \|\| []};	164	for @{(delete $self->{_on_destroy}) \|\| []};
156	}	165	}
157		166
158	# this coroutine is necessary because a coroutine	167	# this coroutine is necessary because a coroutine
159	# cannot destroy itself.	168	# cannot destroy itself.
160	my @destroy;	169	my @destroy;
…		…
166	while @destroy;	175	while @destroy;
167		176
168	&schedule;	177	&schedule;
169	}	178	}
170	};	179	};
171		180	$manager->desc ("[coro manager]");
172	$manager->prio (PRIO_MAX);	181	$manager->prio (PRIO_MAX);
173
174	# static methods. not really.
175		182
176	=back	183	=back
177		184
178	=head2 STATIC METHODS	185	=head2 STATIC METHODS
179		186
…		…
184	=item async { ... } [@args...]	191	=item async { ... } [@args...]
185		192
186	Create a new asynchronous coroutine and return it's coroutine object	193	Create a new asynchronous coroutine and return it's coroutine object
187	(usually unused). When the sub returns the new coroutine is automatically	194	(usually unused). When the sub returns the new coroutine is automatically
188	terminated.	195	terminated.
		196
		197	See the C<Coro::State::new> constructor for info about the coroutine
		198	environment in which coroutines run.
189		199
190	Calling C<exit> in a coroutine will do the same as calling exit outside	200	Calling C<exit> in a coroutine will do the same as calling exit outside
191	the coroutine. Likewise, when the coroutine dies, the program will exit,	201	the coroutine. Likewise, when the coroutine dies, the program will exit,
192	just as it would in the main program.	202	just as it would in the main program.
193		203
…		…
214	issued in case of an exception instead of terminating the program, as	224	issued in case of an exception instead of terminating the program, as
215	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>	225	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
216	will not work in the expected way, unless you call terminate or cancel,	226	will not work in the expected way, unless you call terminate or cancel,
217	which somehow defeats the purpose of pooling.	227	which somehow defeats the purpose of pooling.
218		228
219	The priority will be reset to C<0> after each job, otherwise the coroutine	229	The priority will be reset to C<0> after each job, tracing will be
220	will be re-used "as-is".	230	disabled, the description will be reset and the default output filehandle
		231	gets restored, so you can change alkl these. Otherwise the coroutine will
		232	be re-used "as-is": most notably if you change other per-coroutine global
		233	stuff such as C<$/> you need to revert that change, which is most simply
		234	done by using local as in C< local $/ >.
221		235
222	The pool size is limited to 8 idle coroutines (this can be adjusted by	236	The pool size is limited to 8 idle coroutines (this can be adjusted by
223	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as	237	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
224	required.	238	required.
225		239
226	If you are concerned about pooled coroutines growing a lot because a	240	If you are concerned about pooled coroutines growing a lot because a
227	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {	241	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
228	terminate }> once per second or so to slowly replenish the pool.	242	{ terminate }> once per second or so to slowly replenish the pool. In
		243	addition to that, when the stacks used by a handler grows larger than 16kb
		244	(adjustable with $Coro::POOL_RSS) it will also exit.
229		245
230	=cut	246	=cut
231		247
232	our $POOL_SIZE = 8;	248	our $POOL_SIZE = 8;
		249	our $POOL_RSS = 16 * 1024;
233	our @pool;	250	our @async_pool;
234		251
235	sub pool_handler {	252	sub pool_handler {
		253	my $cb;
		254
236	while () {	255	while () {
237	eval {	256	eval {
238	my ($cb, @arg) = @{ delete $current->{_invoke} or return };	257	while () {
239	$cb->(@arg);	258	_pool_1 $cb;
		259	&$cb;
		260	_pool_2 $cb;
		261	&schedule;
		262	}
240	};	263	};
		264
		265	last if $@ eq "\3async_pool terminate\2\n";
241	warn $@ if $@;	266	warn $@ if $@;
242
243	last if @pool >= $POOL_SIZE;
244	push @pool, $current;
245
246	$current->save (Coro::State::SAVE_DEF);
247	$current->prio (0);
248	schedule;
249	}	267	}
250	}	268	}
251		269
252	sub async_pool(&@) {	270	sub async_pool(&@) {
253	# this is also inlined into the unlock_scheduler	271	# this is also inlined into the unlock_scheduler
254	my $coro = (pop @pool) \|\| do {
255	my $coro = new Coro \&pool_handler;	272	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
256	$coro->{desc} = "async_pool";
257	$coro
258	};
259		273
260	$coro->{_invoke} = [@_];	274	$coro->{_invoke} = [@_];
261	$coro->ready;	275	$coro->ready;
262		276
263	$coro	277	$coro
…		…
293		307
294	"Cede" to other coroutines. This function puts the current coroutine into the	308	"Cede" to other coroutines. This function puts the current coroutine into the
295	ready queue and calls C<schedule>, which has the effect of giving up the	309	ready queue and calls C<schedule>, which has the effect of giving up the
296	current "timeslice" to other coroutines of the same or higher priority.	310	current "timeslice" to other coroutines of the same or higher priority.
297		311
298	Returns true if at least one coroutine switch has happened.
299
300	=item Coro::cede_notself	312	=item Coro::cede_notself
301		313
302	Works like cede, but is not exported by default and will cede to any	314	Works like cede, but is not exported by default and will cede to any
303	coroutine, regardless of priority, once.	315	coroutine, regardless of priority, once.
304		316
305	Returns true if at least one coroutine switch has happened.
306
307	=item terminate [arg...]	317	=item terminate [arg...]
308		318
309	Terminates the current coroutine with the given status values (see L<cancel>).	319	Terminates the current coroutine with the given status values (see L<cancel>).
		320
		321	=item killall
		322
		323	Kills/terminates/cancels all coroutines except the currently running
		324	one. This is useful after a fork, either in the child or the parent, as
		325	usually only one of them should inherit the running coroutines.
310		326
311	=cut	327	=cut
312		328
313	sub terminate {	329	sub terminate {
314	$current->cancel (@_);	330	$current->cancel (@_);
315	}	331	}
316		332
		333	sub killall {
		334	for (Coro::State::list) {
		335	$_->cancel
		336	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		337	}
		338	}
		339
317	=back	340	=back
318
319	# dynamic methods
320		341
321	=head2 COROUTINE METHODS	342	=head2 COROUTINE METHODS
322		343
323	These are the methods you can call on coroutine objects.	344	These are the methods you can call on coroutine objects.
324		345
…		…
329	Create a new coroutine and return it. When the sub returns the coroutine	350	Create a new coroutine and return it. When the sub returns the coroutine
330	automatically terminates as if C<terminate> with the returned values were	351	automatically terminates as if C<terminate> with the returned values were
331	called. To make the coroutine run you must first put it into the ready queue	352	called. To make the coroutine run you must first put it into the ready queue
332	by calling the ready method.	353	by calling the ready method.
333		354
334	See C<async> for additional discussion.	355	See C<async> and C<Coro::State::new> for additional info about the
		356	coroutine environment.
335		357
336	=cut	358	=cut
337		359
338	sub _run_coro {	360	sub _run_coro {
339	terminate &{+shift};	361	terminate &{+shift};
…		…
363		385
364	=cut	386	=cut
365		387
366	sub cancel {	388	sub cancel {
367	my $self = shift;	389	my $self = shift;
368	$self->{status} = [@_];	390	$self->{_status} = [@_];
369		391
370	if ($current == $self) {	392	if ($current == $self) {
371	push @destroy, $self;	393	push @destroy, $self;
372	$manager->ready;	394	$manager->ready;
373	&schedule while 1;	395	&schedule while 1;
…		…
377	}	399	}
378		400
379	=item $coroutine->join	401	=item $coroutine->join
380		402
381	Wait until the coroutine terminates and return any values given to the	403	Wait until the coroutine terminates and return any values given to the
382	C<terminate> or C<cancel> functions. C<join> can be called multiple times	404	C<terminate> or C<cancel> functions. C<join> can be called concurrently
383	from multiple coroutine.	405	from multiple coroutines.
384		406
385	=cut	407	=cut
386		408
387	sub join {	409	sub join {
388	my $self = shift;	410	my $self = shift;
389		411
390	unless ($self->{status}) {	412	unless ($self->{_status}) {
391	my $current = $current;	413	my $current = $current;
392		414
393	push @{$self->{destroy_cb}}, sub {	415	push @{$self->{_on_destroy}}, sub {
394	$current->ready;	416	$current->ready;
395	undef $current;	417	undef $current;
396	};	418	};
397		419
398	&schedule while $current;	420	&schedule while $current;
399	}	421	}
400		422
401	wantarray ? @{$self->{status}} : $self->{status}[0];	423	wantarray ? @{$self->{_status}} : $self->{_status}[0];
402	}	424	}
403		425
404	=item $coroutine->on_destroy (\&cb)	426	=item $coroutine->on_destroy (\&cb)
405		427
406	Registers a callback that is called when this coroutine gets destroyed,	428	Registers a callback that is called when this coroutine gets destroyed,
…		…
410	=cut	432	=cut
411		433
412	sub on_destroy {	434	sub on_destroy {
413	my ($self, $cb) = @_;	435	my ($self, $cb) = @_;
414		436
415	push @{ $self->{destroy_cb} }, $cb;	437	push @{ $self->{_on_destroy} }, $cb;
416	}	438	}
417		439
418	=item $oldprio = $coroutine->prio ($newprio)	440	=item $oldprio = $coroutine->prio ($newprio)
419		441
420	Sets (or gets, if the argument is missing) the priority of the	442	Sets (or gets, if the argument is missing) the priority of the
…		…
444		466
445	=item $olddesc = $coroutine->desc ($newdesc)	467	=item $olddesc = $coroutine->desc ($newdesc)
446		468
447	Sets (or gets in case the argument is missing) the description for this	469	Sets (or gets in case the argument is missing) the description for this
448	coroutine. This is just a free-form string you can associate with a coroutine.	470	coroutine. This is just a free-form string you can associate with a coroutine.
		471
		472	This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
		473	can modify this member directly if you wish.
		474
		475	=item $coroutine->throw ([$scalar])
		476
		477	If C<$throw> is specified and defined, it will be thrown as an exception
		478	inside the coroutine at the next convinient point in time (usually after
		479	it gains control at the next schedule/transfer/cede). Otherwise clears the
		480	exception object.
		481
		482	The exception object will be thrown "as is" with the specified scalar in
		483	C<$@>, i.e. if it is a string, no line number or newline will be appended
		484	(unlike with C<die>).
		485
		486	This can be used as a softer means than C<cancel> to ask a coroutine to
		487	end itself, although there is no guarentee that the exception will lead to
		488	termination, and if the exception isn't caught it might well end the whole
		489	program.
449		490
450	=cut	491	=cut
451		492
452	sub desc {	493	sub desc {
453	my $old = $_[0]{desc};	494	my $old = $_[0]{desc};
…		…
529		570
530	# we create a special coro because we want to cede,	571	# we create a special coro because we want to cede,
531	# to reduce pressure on the coro pool (because most callbacks	572	# to reduce pressure on the coro pool (because most callbacks
532	# return immediately and can be reused) and because we cannot cede	573	# return immediately and can be reused) and because we cannot cede
533	# inside an event callback.	574	# inside an event callback.
534	our $unblock_scheduler = async {	575	our $unblock_scheduler = new Coro sub {
535	while () {	576	while () {
536	while (my $cb = pop @unblock_queue) {	577	while (my $cb = pop @unblock_queue) {
537	# this is an inlined copy of async_pool	578	# this is an inlined copy of async_pool
538	my $coro = (pop @pool or new Coro \&pool_handler);	579	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
539		580
540	$coro->{_invoke} = $cb;	581	$coro->{_invoke} = $cb;
541	$coro->ready;	582	$coro->ready;
542	cede; # for short-lived callbacks, this reduces pressure on the coro pool	583	cede; # for short-lived callbacks, this reduces pressure on the coro pool
543	}	584	}
544	schedule; # sleep well	585	schedule; # sleep well
545	}	586	}
546	};	587	};
		588	$unblock_scheduler->desc ("[unblock_sub scheduler]");
547		589
548	sub unblock_sub(&) {	590	sub unblock_sub(&) {
549	my $cb = shift;	591	my $cb = shift;
550		592
551	sub {	593	sub {
…		…
570	to allow per-thread schedulers, but Coro::State does not yet allow	612	to allow per-thread schedulers, but Coro::State does not yet allow
571	this).	613	this).
572		614
573	=head1 SEE ALSO	615	=head1 SEE ALSO
574		616
		617	Lower level Configuration, Coroutine Environment: L<Coro::State>.
		618
		619	Debugging: L<Coro::Debug>.
		620
575	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	621	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
576		622
577	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.	623	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
578		624
579	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.	625	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>.
580		626
		627	Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
		628
581	Embedding: L<Coro:MakeMaker>	629	Embedding: L<Coro::MakeMaker>.
582		630
583	=head1 AUTHOR	631	=head1 AUTHOR
584		632
585	Marc Lehmann <schmorp@schmorp.de>	633	Marc Lehmann <schmorp@schmorp.de>
586	http://home.schmorp.de/	634	http://home.schmorp.de/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.128 by root, Wed Sep 19 21:39:15 2007 UTC vs. Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.128 by root, Wed Sep 19 21:39:15 2007 UTC vs.
Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC