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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.129 by root, Wed Sep 19 22:33:08 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;
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
176	# static methods. not really.
177		182
178	=back	183	=back
179		184
180	=head2 STATIC METHODS	185	=head2 STATIC METHODS
181		186
…		…
186	=item async { ... } [@args...]	191	=item async { ... } [@args...]
187		192
188	Create a new asynchronous coroutine and return it's coroutine object	193	Create a new asynchronous coroutine and return it's coroutine object
189	(usually unused). When the sub returns the new coroutine is automatically	194	(usually unused). When the sub returns the new coroutine is automatically
190	terminated.	195	terminated.
		196
		197	See the C<Coro::State::new> constructor for info about the coroutine
		198	environment in which coroutines run.
191		199
192	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
193	the coroutine. Likewise, when the coroutine dies, the program will exit,	201	the coroutine. Likewise, when the coroutine dies, the program will exit,
194	just as it would in the main program.	202	just as it would in the main program.
195		203
…		…
216	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
217	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>
218	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,
219	which somehow defeats the purpose of pooling.	227	which somehow defeats the purpose of pooling.
220		228
221	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
222	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 $/ >.
223		235
224	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
225	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
226	required.	238	required.
227		239
228	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
229	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
230	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.
231		245
232	=cut	246	=cut
233		247
234	our $POOL_SIZE = 8;	248	our $POOL_SIZE = 8;
		249	our $POOL_RSS = 16 * 1024;
235	our @pool;	250	our @async_pool;
236		251
237	sub pool_handler {	252	sub pool_handler {
		253	my $cb;
		254
238	while () {	255	while () {
239	$current->{desc} = "[async_pool]";
240
241	eval {	256	eval {
242	my ($cb, @arg) = @{ delete $current->{_invoke} or return };	257	while () {
243	$cb->(@arg);	258	_pool_1 $cb;
		259	&$cb;
		260	_pool_2 $cb;
		261	&schedule;
		262	}
244	};	263	};
		264
		265	last if $@ eq "\3async_pool terminate\2\n";
245	warn $@ if $@;	266	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	}	267	}
255	}	268	}
256		269
257	sub async_pool(&@) {	270	sub async_pool(&@) {
258	# this is also inlined into the unlock_scheduler	271	# this is also inlined into the unlock_scheduler
259	my $coro = (pop @pool) \|\| new Coro \&pool_handler;;	272	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
260		273
261	$coro->{_invoke} = [@_];	274	$coro->{_invoke} = [@_];
262	$coro->ready;	275	$coro->ready;
263		276
264	$coro	277	$coro
…		…
294		307
295	"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
296	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
297	current "timeslice" to other coroutines of the same or higher priority.	310	current "timeslice" to other coroutines of the same or higher priority.
298		311
299	Returns true if at least one coroutine switch has happened.
300
301	=item Coro::cede_notself	312	=item Coro::cede_notself
302		313
303	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
304	coroutine, regardless of priority, once.	315	coroutine, regardless of priority, once.
305		316
306	Returns true if at least one coroutine switch has happened.
307
308	=item terminate [arg...]	317	=item terminate [arg...]
309		318
310	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.
311		326
312	=cut	327	=cut
313		328
314	sub terminate {	329	sub terminate {
315	$current->cancel (@_);	330	$current->cancel (@_);
316	}	331	}
317		332
		333	sub killall {
		334	for (Coro::State::list) {
		335	$_->cancel
		336	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		337	}
		338	}
		339
318	=back	340	=back
319
320	# dynamic methods
321		341
322	=head2 COROUTINE METHODS	342	=head2 COROUTINE METHODS
323		343
324	These are the methods you can call on coroutine objects.	344	These are the methods you can call on coroutine objects.
325		345
…		…
330	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
331	automatically terminates as if C<terminate> with the returned values were	351	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	352	called. To make the coroutine run you must first put it into the ready queue
333	by calling the ready method.	353	by calling the ready method.
334		354
335	See C<async> for additional discussion.	355	See C<async> and C<Coro::State::new> for additional info about the
		356	coroutine environment.
336		357
337	=cut	358	=cut
338		359
339	sub _run_coro {	360	sub _run_coro {
340	terminate &{+shift};	361	terminate &{+shift};
…		…
364		385
365	=cut	386	=cut
366		387
367	sub cancel {	388	sub cancel {
368	my $self = shift;	389	my $self = shift;
369	$self->{status} = [@_];	390	$self->{_status} = [@_];
370		391
371	if ($current == $self) {	392	if ($current == $self) {
372	push @destroy, $self;	393	push @destroy, $self;
373	$manager->ready;	394	$manager->ready;
374	&schedule while 1;	395	&schedule while 1;
…		…
378	}	399	}
379		400
380	=item $coroutine->join	401	=item $coroutine->join
381		402
382	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
383	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
384	from multiple coroutine.	405	from multiple coroutines.
385		406
386	=cut	407	=cut
387		408
388	sub join {	409	sub join {
389	my $self = shift;	410	my $self = shift;
390		411
391	unless ($self->{status}) {	412	unless ($self->{_status}) {
392	my $current = $current;	413	my $current = $current;
393		414
394	push @{$self->{destroy_cb}}, sub {	415	push @{$self->{_on_destroy}}, sub {
395	$current->ready;	416	$current->ready;
396	undef $current;	417	undef $current;
397	};	418	};
398		419
399	&schedule while $current;	420	&schedule while $current;
400	}	421	}
401		422
402	wantarray ? @{$self->{status}} : $self->{status}[0];	423	wantarray ? @{$self->{_status}} : $self->{_status}[0];
403	}	424	}
404		425
405	=item $coroutine->on_destroy (\&cb)	426	=item $coroutine->on_destroy (\&cb)
406		427
407	Registers a callback that is called when this coroutine gets destroyed,	428	Registers a callback that is called when this coroutine gets destroyed,
…		…
411	=cut	432	=cut
412		433
413	sub on_destroy {	434	sub on_destroy {
414	my ($self, $cb) = @_;	435	my ($self, $cb) = @_;
415		436
416	push @{ $self->{destroy_cb} }, $cb;	437	push @{ $self->{_on_destroy} }, $cb;
417	}	438	}
418		439
419	=item $oldprio = $coroutine->prio ($newprio)	440	=item $oldprio = $coroutine->prio ($newprio)
420		441
421	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
…		…
445		466
446	=item $olddesc = $coroutine->desc ($newdesc)	467	=item $olddesc = $coroutine->desc ($newdesc)
447		468
448	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
449	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.
450		490
451	=cut	491	=cut
452		492
453	sub desc {	493	sub desc {
454	my $old = $_[0]{desc};	494	my $old = $_[0]{desc};
…		…
530		570
531	# we create a special coro because we want to cede,	571	# we create a special coro because we want to cede,
532	# to reduce pressure on the coro pool (because most callbacks	572	# to reduce pressure on the coro pool (because most callbacks
533	# return immediately and can be reused) and because we cannot cede	573	# return immediately and can be reused) and because we cannot cede
534	# inside an event callback.	574	# inside an event callback.
535	our $unblock_scheduler = async {	575	our $unblock_scheduler = new Coro sub {
536	$current->desc ("[unblock_sub scheduler]");
537	while () {	576	while () {
538	while (my $cb = pop @unblock_queue) {	577	while (my $cb = pop @unblock_queue) {
539	# this is an inlined copy of async_pool	578	# this is an inlined copy of async_pool
540	my $coro = (pop @pool or new Coro \&pool_handler);	579	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
541		580
542	$coro->{_invoke} = $cb;	581	$coro->{_invoke} = $cb;
543	$coro->ready;	582	$coro->ready;
544	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
545	}	584	}
546	schedule; # sleep well	585	schedule; # sleep well
547	}	586	}
548	};	587	};
		588	$unblock_scheduler->desc ("[unblock_sub scheduler]");
549		589
550	sub unblock_sub(&) {	590	sub unblock_sub(&) {
551	my $cb = shift;	591	my $cb = shift;
552		592
553	sub {	593	sub {
…		…
572	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
573	this).	613	this).
574		614
575	=head1 SEE ALSO	615	=head1 SEE ALSO
576		616
		617	Lower level Configuration, Coroutine Environment: L<Coro::State>.
		618
		619	Debugging: L<Coro::Debug>.
		620
577	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	621	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
578		622
579	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>.
580		624
581	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>.
582		626
		627	Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
		628
583	Embedding: L<Coro:MakeMaker>	629	Embedding: L<Coro::MakeMaker>.
584		630
585	=head1 AUTHOR	631	=head1 AUTHOR
586		632
587	Marc Lehmann <schmorp@schmorp.de>	633	Marc Lehmann <schmorp@schmorp.de>
588	http://home.schmorp.de/	634	http://home.schmorp.de/

Diff Legend

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

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

Diff Legend

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