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

Comparing Coro/Coro.pm (file contents):
Revision 1.129 by root, Wed Sep 19 22:33:08 2007 UTC vs.
Revision 1.152 by root, Sun Oct 7 13:53:37 2007 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.1';
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;
161	my $manager;	170	my $manager;
162		171
163	$manager = new Coro sub {	172	$manager = new Coro sub {
164	$current->desc ("[coro manager]");
165
166	while () {	173	while () {
167	(shift @destroy)->_cancel	174	(shift @destroy)->_cancel
168	while @destroy;	175	while @destroy;
169		176
170	&schedule;	177	&schedule;
171	}	178	}
172	};	179	};
173		180	$manager->desc ("[coro manager]");
174	$manager->prio (PRIO_MAX);	181	$manager->prio (PRIO_MAX);
175		182
176	# static methods. not really.	183	# static methods. not really.
177		184
178	=back	185	=back
…		…
186	=item async { ... } [@args...]	193	=item async { ... } [@args...]
187		194
188	Create a new asynchronous coroutine and return it's coroutine object	195	Create a new asynchronous coroutine and return it's coroutine object
189	(usually unused). When the sub returns the new coroutine is automatically	196	(usually unused). When the sub returns the new coroutine is automatically
190	terminated.	197	terminated.
		198
		199	See the C<Coro::State::new> constructor for info about the coroutine
		200	environment in which coroutines run.
191		201
192	Calling C<exit> in a coroutine will do the same as calling exit outside	202	Calling C<exit> in a coroutine will do the same as calling exit outside
193	the coroutine. Likewise, when the coroutine dies, the program will exit,	203	the coroutine. Likewise, when the coroutine dies, the program will exit,
194	just as it would in the main program.	204	just as it would in the main program.
195		205
…		…
216	issued in case of an exception instead of terminating the program, as	226	issued in case of an exception instead of terminating the program, as
217	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>	227	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
218	will not work in the expected way, unless you call terminate or cancel,	228	will not work in the expected way, unless you call terminate or cancel,
219	which somehow defeats the purpose of pooling.	229	which somehow defeats the purpose of pooling.
220		230
221	The priority will be reset to C<0> after each job, otherwise the coroutine	231	The priority will be reset to C<0> after each job, tracing will be
222	will be re-used "as-is".	232	disabled, the description will be reset and the default output filehandle
		233	gets restored, so you can change alkl these. Otherwise the coroutine will
		234	be re-used "as-is": most notably if you change other per-coroutine global
		235	stuff such as C<$/> you need to revert that change, which is most simply
		236	done by using local as in C< local $/ >.
223		237
224	The pool size is limited to 8 idle coroutines (this can be adjusted by	238	The pool size is limited to 8 idle coroutines (this can be adjusted by
225	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as	239	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
226	required.	240	required.
227		241
228	If you are concerned about pooled coroutines growing a lot because a	242	If you are concerned about pooled coroutines growing a lot because a
229	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {	243	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
230	terminate }> once per second or so to slowly replenish the pool.	244	{ terminate }> once per second or so to slowly replenish the pool. In
		245	addition to that, when the stacks used by a handler grows larger than 16kb
		246	(adjustable with $Coro::POOL_RSS) it will also exit.
231		247
232	=cut	248	=cut
233		249
234	our $POOL_SIZE = 8;	250	our $POOL_SIZE = 8;
		251	our $POOL_RSS = 16 * 1024;
235	our @pool;	252	our @async_pool;
236		253
237	sub pool_handler {	254	sub pool_handler {
		255	my $cb;
		256
238	while () {	257	while () {
239	$current->{desc} = "[async_pool]";
240
241	eval {	258	eval {
242	my ($cb, @arg) = @{ delete $current->{_invoke} or return };	259	while () {
243	$cb->(@arg);	260	_pool_1 $cb;
		261	&$cb;
		262	_pool_2 $cb;
		263	&schedule;
		264	}
244	};	265	};
		266
		267	last if $@ eq "\3async_pool terminate\2\n";
245	warn $@ if $@;	268	warn $@ if $@;
246
247	last if @pool >= $POOL_SIZE;
248
249	push @pool, $current;
250	$current->{desc} = "[async_pool idle]";
251	$current->save (Coro::State::SAVE_DEF);
252	$current->prio (0);
253	schedule;
254	}	269	}
255	}	270	}
256		271
257	sub async_pool(&@) {	272	sub async_pool(&@) {
258	# this is also inlined into the unlock_scheduler	273	# this is also inlined into the unlock_scheduler
259	my $coro = (pop @pool) \|\| new Coro \&pool_handler;;	274	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
260		275
261	$coro->{_invoke} = [@_];	276	$coro->{_invoke} = [@_];
262	$coro->ready;	277	$coro->ready;
263		278
264	$coro	279	$coro
…		…
307		322
308	=item terminate [arg...]	323	=item terminate [arg...]
309		324
310	Terminates the current coroutine with the given status values (see L<cancel>).	325	Terminates the current coroutine with the given status values (see L<cancel>).
311		326
		327	=item killall
		328
		329	Kills/terminates/cancels all coroutines except the currently running
		330	one. This is useful after a fork, either in the child or the parent, as
		331	usually only one of them should inherit the running coroutines.
		332
312	=cut	333	=cut
313		334
314	sub terminate {	335	sub terminate {
315	$current->cancel (@_);	336	$current->cancel (@_);
		337	}
		338
		339	sub killall {
		340	for (Coro::State::list) {
		341	$_->cancel
		342	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		343	}
316	}	344	}
317		345
318	=back	346	=back
319		347
320	# dynamic methods	348	# dynamic methods
…		…
330	Create a new coroutine and return it. When the sub returns the coroutine	358	Create a new coroutine and return it. When the sub returns the coroutine
331	automatically terminates as if C<terminate> with the returned values were	359	automatically terminates as if C<terminate> with the returned values were
332	called. To make the coroutine run you must first put it into the ready queue	360	called. To make the coroutine run you must first put it into the ready queue
333	by calling the ready method.	361	by calling the ready method.
334		362
335	See C<async> for additional discussion.	363	See C<async> and C<Coro::State::new> for additional info about the
		364	coroutine environment.
336		365
337	=cut	366	=cut
338		367
339	sub _run_coro {	368	sub _run_coro {
340	terminate &{+shift};	369	terminate &{+shift};
…		…
364		393
365	=cut	394	=cut
366		395
367	sub cancel {	396	sub cancel {
368	my $self = shift;	397	my $self = shift;
369	$self->{status} = [@_];	398	$self->{_status} = [@_];
370		399
371	if ($current == $self) {	400	if ($current == $self) {
372	push @destroy, $self;	401	push @destroy, $self;
373	$manager->ready;	402	$manager->ready;
374	&schedule while 1;	403	&schedule while 1;
…		…
378	}	407	}
379		408
380	=item $coroutine->join	409	=item $coroutine->join
381		410
382	Wait until the coroutine terminates and return any values given to the	411	Wait until the coroutine terminates and return any values given to the
383	C<terminate> or C<cancel> functions. C<join> can be called multiple times	412	C<terminate> or C<cancel> functions. C<join> can be called concurrently
384	from multiple coroutine.	413	from multiple coroutines.
385		414
386	=cut	415	=cut
387		416
388	sub join {	417	sub join {
389	my $self = shift;	418	my $self = shift;
390		419
391	unless ($self->{status}) {	420	unless ($self->{_status}) {
392	my $current = $current;	421	my $current = $current;
393		422
394	push @{$self->{destroy_cb}}, sub {	423	push @{$self->{_on_destroy}}, sub {
395	$current->ready;	424	$current->ready;
396	undef $current;	425	undef $current;
397	};	426	};
398		427
399	&schedule while $current;	428	&schedule while $current;
400	}	429	}
401		430
402	wantarray ? @{$self->{status}} : $self->{status}[0];	431	wantarray ? @{$self->{_status}} : $self->{_status}[0];
403	}	432	}
404		433
405	=item $coroutine->on_destroy (\&cb)	434	=item $coroutine->on_destroy (\&cb)
406		435
407	Registers a callback that is called when this coroutine gets destroyed,	436	Registers a callback that is called when this coroutine gets destroyed,
…		…
411	=cut	440	=cut
412		441
413	sub on_destroy {	442	sub on_destroy {
414	my ($self, $cb) = @_;	443	my ($self, $cb) = @_;
415		444
416	push @{ $self->{destroy_cb} }, $cb;	445	push @{ $self->{_on_destroy} }, $cb;
417	}	446	}
418		447
419	=item $oldprio = $coroutine->prio ($newprio)	448	=item $oldprio = $coroutine->prio ($newprio)
420		449
421	Sets (or gets, if the argument is missing) the priority of the	450	Sets (or gets, if the argument is missing) the priority of the
…		…
445		474
446	=item $olddesc = $coroutine->desc ($newdesc)	475	=item $olddesc = $coroutine->desc ($newdesc)
447		476
448	Sets (or gets in case the argument is missing) the description for this	477	Sets (or gets in case the argument is missing) the description for this
449	coroutine. This is just a free-form string you can associate with a coroutine.	478	coroutine. This is just a free-form string you can associate with a coroutine.
		479
		480	This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
		481	can modify this member directly if you wish.
		482
		483	=item $coroutine->throw ([$scalar])
		484
		485	If C<$throw> is specified and defined, it will be thrown as an exception
		486	inside the coroutine at the next convinient point in time (usually after
		487	it gains control at the next schedule/transfer/cede). Otherwise clears the
		488	exception object.
		489
		490	The exception object will be thrown "as is" with the specified scalar in
		491	C<$@>, i.e. if it is a string, no line number or newline will be appended
		492	(unlike with C<die>).
		493
		494	This can be used as a softer means than C<cancel> to ask a coroutine to
		495	end itself, although there is no guarentee that the exception will lead to
		496	termination, and if the exception isn't caught it might well end the whole
		497	program.
450		498
451	=cut	499	=cut
452		500
453	sub desc {	501	sub desc {
454	my $old = $_[0]{desc};	502	my $old = $_[0]{desc};
…		…
530		578
531	# we create a special coro because we want to cede,	579	# we create a special coro because we want to cede,
532	# to reduce pressure on the coro pool (because most callbacks	580	# to reduce pressure on the coro pool (because most callbacks
533	# return immediately and can be reused) and because we cannot cede	581	# return immediately and can be reused) and because we cannot cede
534	# inside an event callback.	582	# inside an event callback.
535	our $unblock_scheduler = async {	583	our $unblock_scheduler = new Coro sub {
536	$current->desc ("[unblock_sub scheduler]");
537	while () {	584	while () {
538	while (my $cb = pop @unblock_queue) {	585	while (my $cb = pop @unblock_queue) {
539	# this is an inlined copy of async_pool	586	# this is an inlined copy of async_pool
540	my $coro = (pop @pool or new Coro \&pool_handler);	587	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
541		588
542	$coro->{_invoke} = $cb;	589	$coro->{_invoke} = $cb;
543	$coro->ready;	590	$coro->ready;
544	cede; # for short-lived callbacks, this reduces pressure on the coro pool	591	cede; # for short-lived callbacks, this reduces pressure on the coro pool
545	}	592	}
546	schedule; # sleep well	593	schedule; # sleep well
547	}	594	}
548	};	595	};
		596	$unblock_scheduler->desc ("[unblock_sub scheduler]");
549		597
550	sub unblock_sub(&) {	598	sub unblock_sub(&) {
551	my $cb = shift;	599	my $cb = shift;
552		600
553	sub {	601	sub {
…		…
572	to allow per-thread schedulers, but Coro::State does not yet allow	620	to allow per-thread schedulers, but Coro::State does not yet allow
573	this).	621	this).
574		622
575	=head1 SEE ALSO	623	=head1 SEE ALSO
576		624
		625	Lower level Configuration, Coroutine Environment: L<Coro::State>.
		626
		627	Debugging: L<Coro::Debug>.
		628
577	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	629	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
578		630
579	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.	631	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
580		632
581	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.	633	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>.
582		634
		635	Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
		636
583	Embedding: L<Coro:MakeMaker>	637	Embedding: L<Coro:MakeMaker>.
584		638
585	=head1 AUTHOR	639	=head1 AUTHOR
586		640
587	Marc Lehmann <schmorp@schmorp.de>	641	Marc Lehmann <schmorp@schmorp.de>
588	http://home.schmorp.de/	642	http://home.schmorp.de/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.129 by root, Wed Sep 19 22:33:08 2007 UTC vs. Revision 1.152 by root, Sun Oct 7 13:53:37 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.129 by root, Wed Sep 19 22:33:08 2007 UTC vs.
Revision 1.152 by root, Sun Oct 7 13:53:37 2007 UTC