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

Comparing Coro/Coro.pm (file contents):
Revision 1.134 by root, Sat Sep 22 14:42:56 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	);
…		…
116	=cut	123	=cut
117		124
118	$main->{desc} = "[main::]";	125	$main->{desc} = "[main::]";
119		126
120	# maybe some other module used Coro::Specific before...	127	# maybe some other module used Coro::Specific before...
121	$main->{specific} = $current->{specific}	128	$main->{_specific} = $current->{_specific}
122	if $current;	129	if $current;
123		130
124	_set_current $main;	131	_set_current $main;
125		132
126	sub current() { $current }	133	sub current() { $current }
…		…
134	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
135	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
136	coroutine so the scheduler can run it.	143	coroutine so the scheduler can run it.
137		144
138	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
139	handlers), then it must be prepared to be called recursively.	146	handlers), then it must be prepared to be called recursively itself.
140		147
141	=cut	148	=cut
142		149
143	$idle = sub {	150	$idle = sub {
144	require Carp;	151	require Carp;
…		…
151	# free coroutine data and mark as destructed	158	# free coroutine data and mark as destructed
152	$self->_destroy	159	$self->_destroy
153	or return;	160	or return;
154		161
155	# call all destruction callbacks	162	# call all destruction callbacks
156	$_->(@{$self->{status}})	163	$_->(@{$self->{_status}})
157	for @{(delete $self->{destroy_cb}) \|\| []};	164	for @{(delete $self->{_on_destroy}) \|\| []};
158	}	165	}
159		166
160	# this coroutine is necessary because a coroutine	167	# this coroutine is necessary because a coroutine
161	# cannot destroy itself.	168	# cannot destroy itself.
162	my @destroy;	169	my @destroy;
…		…
171	}	178	}
172	};	179	};
173	$manager->desc ("[coro manager]");	180	$manager->desc ("[coro manager]");
174	$manager->prio (PRIO_MAX);	181	$manager->prio (PRIO_MAX);
175		182
176	# static methods. not really.
177
178	=back	183	=back
179		184
180	=head2 STATIC METHODS	185	=head2 STATIC METHODS
181		186
182	Static methods are actually functions that operate on the current coroutine only.	187	Static methods are actually functions that operate on the current coroutine only.
…		…
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
…		…
241	my $cb;	253	my $cb;
242		254
243	while () {	255	while () {
244	eval {	256	eval {
245	while () {	257	while () {
246	$cb = &_pool_1	258	_pool_1 $cb;
247	or return;
248
249	&$cb;	259	&$cb;
250		260	_pool_2 $cb;
251	return if &_pool_2;
252
253	undef $cb;
254	schedule;	261	&schedule;
255	}	262	}
256	};	263	};
257		264
		265	last if $@ eq "\3async_pool terminate\2\n";
258	warn $@ if $@;	266	warn $@ if $@;
259	}	267	}
260	}	268	}
261		269
262	sub async_pool(&@) {	270	sub async_pool(&@) {
263	# this is also inlined into the unlock_scheduler	271	# this is also inlined into the unlock_scheduler
264	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;;	272	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
265		273
266	$coro->{_invoke} = [@_];	274	$coro->{_invoke} = [@_];
267	$coro->ready;	275	$coro->ready;
268		276
269	$coro	277	$coro
…		…
299		307
300	"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
301	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
302	current "timeslice" to other coroutines of the same or higher priority.	310	current "timeslice" to other coroutines of the same or higher priority.
303		311
304	Returns true if at least one coroutine switch has happened.
305
306	=item Coro::cede_notself	312	=item Coro::cede_notself
307		313
308	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
309	coroutine, regardless of priority, once.	315	coroutine, regardless of priority, once.
310		316
311	Returns true if at least one coroutine switch has happened.
312
313	=item terminate [arg...]	317	=item terminate [arg...]
314		318
315	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.
316		326
317	=cut	327	=cut
318		328
319	sub terminate {	329	sub terminate {
320	$current->cancel (@_);	330	$current->cancel (@_);
321	}	331	}
322		332
		333	sub killall {
		334	for (Coro::State::list) {
		335	$_->cancel
		336	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		337	}
		338	}
		339
323	=back	340	=back
324
325	# dynamic methods
326		341
327	=head2 COROUTINE METHODS	342	=head2 COROUTINE METHODS
328		343
329	These are the methods you can call on coroutine objects.	344	These are the methods you can call on coroutine objects.
330		345
…		…
335	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
336	automatically terminates as if C<terminate> with the returned values were	351	automatically terminates as if C<terminate> with the returned values were
337	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
338	by calling the ready method.	353	by calling the ready method.
339		354
340	See C<async> for additional discussion.	355	See C<async> and C<Coro::State::new> for additional info about the
		356	coroutine environment.
341		357
342	=cut	358	=cut
343		359
344	sub _run_coro {	360	sub _run_coro {
345	terminate &{+shift};	361	terminate &{+shift};
…		…
369		385
370	=cut	386	=cut
371		387
372	sub cancel {	388	sub cancel {
373	my $self = shift;	389	my $self = shift;
374	$self->{status} = [@_];	390	$self->{_status} = [@_];
375		391
376	if ($current == $self) {	392	if ($current == $self) {
377	push @destroy, $self;	393	push @destroy, $self;
378	$manager->ready;	394	$manager->ready;
379	&schedule while 1;	395	&schedule while 1;
…		…
383	}	399	}
384		400
385	=item $coroutine->join	401	=item $coroutine->join
386		402
387	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
388	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
389	from multiple coroutine.	405	from multiple coroutines.
390		406
391	=cut	407	=cut
392		408
393	sub join {	409	sub join {
394	my $self = shift;	410	my $self = shift;
395		411
396	unless ($self->{status}) {	412	unless ($self->{_status}) {
397	my $current = $current;	413	my $current = $current;
398		414
399	push @{$self->{destroy_cb}}, sub {	415	push @{$self->{_on_destroy}}, sub {
400	$current->ready;	416	$current->ready;
401	undef $current;	417	undef $current;
402	};	418	};
403		419
404	&schedule while $current;	420	&schedule while $current;
405	}	421	}
406		422
407	wantarray ? @{$self->{status}} : $self->{status}[0];	423	wantarray ? @{$self->{_status}} : $self->{_status}[0];
408	}	424	}
409		425
410	=item $coroutine->on_destroy (\&cb)	426	=item $coroutine->on_destroy (\&cb)
411		427
412	Registers a callback that is called when this coroutine gets destroyed,	428	Registers a callback that is called when this coroutine gets destroyed,
…		…
416	=cut	432	=cut
417		433
418	sub on_destroy {	434	sub on_destroy {
419	my ($self, $cb) = @_;	435	my ($self, $cb) = @_;
420		436
421	push @{ $self->{destroy_cb} }, $cb;	437	push @{ $self->{_on_destroy} }, $cb;
422	}	438	}
423		439
424	=item $oldprio = $coroutine->prio ($newprio)	440	=item $oldprio = $coroutine->prio ($newprio)
425		441
426	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
…		…
450		466
451	=item $olddesc = $coroutine->desc ($newdesc)	467	=item $olddesc = $coroutine->desc ($newdesc)
452		468
453	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
454	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.
455		490
456	=cut	491	=cut
457		492
458	sub desc {	493	sub desc {
459	my $old = $_[0]{desc};	494	my $old = $_[0]{desc};
…		…
577	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
578	this).	613	this).
579		614
580	=head1 SEE ALSO	615	=head1 SEE ALSO
581		616
		617	Lower level Configuration, Coroutine Environment: L<Coro::State>.
		618
		619	Debugging: L<Coro::Debug>.
		620
582	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	621	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
583		622
584	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>.
585		624
586	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>.
587		626
		627	Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
		628
588	Embedding: L<Coro:MakeMaker>	629	Embedding: L<Coro::MakeMaker>.
589		630
590	=head1 AUTHOR	631	=head1 AUTHOR
591		632
592	Marc Lehmann <schmorp@schmorp.de>	633	Marc Lehmann <schmorp@schmorp.de>
593	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.134 by root, Sat Sep 22 14:42:56 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.134 by root, Sat Sep 22 14:42:56 2007 UTC vs.
Revision 1.178 by root, Thu Apr 17 22:33:10 2008 UTC