[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.180 by root, Fri Apr 25 04:28:50 2008 UTC

…		…
2		2
3	Coro - coroutine process abstraction	3	Coro - coroutine process abstraction
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
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	};
12		15	print "1\n";
13	# alternatively create an async coroutine like this:	16	cede; # yield to coroutine
14		17	print "3\n";
15	sub some_func : Coro {	18	cede; # and again
16	# some more async code	19
17	}	20	# use locking
18		21	my $lock = new Coro::Semaphore;
19	cede;	22	my $locked;
		23
		24	$lock->down;
		25	$locked = 1;
		26	$lock->up;
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.6;
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	);
61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));	68	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
62		69
63	{
64	my @async;
65	my $init;
66
67	# this way of handling attributes simply is NOT scalable ;()
68	sub import {
69	no strict 'refs';
70
71	Coro->export_to_level (1, @_);
72
73	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
74	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
75	my ($package, $ref) = (shift, shift);
76	my @attrs;
77	for (@_) {
78	if ($_ eq "Coro") {
79	push @async, $ref;
80	unless ($init++) {
81	eval q{
82	sub INIT {
83	&async(pop @async) while @async;
84	}
85	};
86	}
87	} else {
88	push @attrs, $_;
89	}
90	}
91	return $old ? $old->($package, $ref, @attrs) : @attrs;
92	};
93	}
94
95	}
96
97	=over 4	70	=over 4
98		71
99	=item $main	72	=item $main
100		73
101	This coroutine represents the main program.	74	This coroutine represents the main program.
…		…
113	reasons. If performance is not essential you are encouraged to use the	86	reasons. If performance is not essential you are encouraged to use the
114	C<Coro::current> function instead.	87	C<Coro::current> function instead.
115		88
116	=cut	89	=cut
117		90
		91	$main->{desc} = "[main::]";
		92
118	# maybe some other module used Coro::Specific before...	93	# maybe some other module used Coro::Specific before...
119	$main->{specific} = $current->{specific}	94	$main->{_specific} = $current->{_specific}
120	if $current;	95	if $current;
121		96
122	_set_current $main;	97	_set_current $main;
123		98
124	sub current() { $current }	99	sub current() { $current }
…		…
132	This hook is overwritten by modules such as C<Coro::Timer> and	107	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	108	C<Coro::Event> to wait on an external event that hopefully wake up a
134	coroutine so the scheduler can run it.	109	coroutine so the scheduler can run it.
135		110
136	Please note that if your callback recursively invokes perl (e.g. for event	111	Please note that if your callback recursively invokes perl (e.g. for event
137	handlers), then it must be prepared to be called recursively.	112	handlers), then it must be prepared to be called recursively itself.
138		113
139	=cut	114	=cut
140		115
141	$idle = sub {	116	$idle = sub {
142	require Carp;	117	require Carp;
…		…
149	# free coroutine data and mark as destructed	124	# free coroutine data and mark as destructed
150	$self->_destroy	125	$self->_destroy
151	or return;	126	or return;
152		127
153	# call all destruction callbacks	128	# call all destruction callbacks
154	$_->(@{$self->{status}})	129	$_->(@{$self->{_status}})
155	for @{(delete $self->{destroy_cb}) \|\| []};	130	for @{(delete $self->{_on_destroy}) \|\| []};
156	}	131	}
157		132
158	# this coroutine is necessary because a coroutine	133	# this coroutine is necessary because a coroutine
159	# cannot destroy itself.	134	# cannot destroy itself.
160	my @destroy;	135	my @destroy;
161	my $manager;	136	my $manager;
162		137
163	$manager = new Coro sub {	138	$manager = new Coro sub {
164	$current->desc ("[coro manager]");
165
166	while () {	139	while () {
167	(shift @destroy)->_cancel	140	(shift @destroy)->_cancel
168	while @destroy;	141	while @destroy;
169		142
170	&schedule;	143	&schedule;
171	}	144	}
172	};	145	};
173		146	$manager->desc ("[coro manager]");
174	$manager->prio (PRIO_MAX);	147	$manager->prio (PRIO_MAX);
175
176	# static methods. not really.
177		148
178	=back	149	=back
179		150
180	=head2 STATIC METHODS	151	=head2 STATIC METHODS
181		152
…		…
186	=item async { ... } [@args...]	157	=item async { ... } [@args...]
187		158
188	Create a new asynchronous coroutine and return it's coroutine object	159	Create a new asynchronous coroutine and return it's coroutine object
189	(usually unused). When the sub returns the new coroutine is automatically	160	(usually unused). When the sub returns the new coroutine is automatically
190	terminated.	161	terminated.
		162
		163	See the C<Coro::State::new> constructor for info about the coroutine
		164	environment in which coroutines run.
191		165
192	Calling C<exit> in a coroutine will do the same as calling exit outside	166	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,	167	the coroutine. Likewise, when the coroutine dies, the program will exit,
194	just as it would in the main program.	168	just as it would in the main program.
195		169
…		…
216	issued in case of an exception instead of terminating the program, as	190	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>	191	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,	192	will not work in the expected way, unless you call terminate or cancel,
219	which somehow defeats the purpose of pooling.	193	which somehow defeats the purpose of pooling.
220		194
221	The priority will be reset to C<0> after each job, otherwise the coroutine	195	The priority will be reset to C<0> after each job, tracing will be
222	will be re-used "as-is".	196	disabled, the description will be reset and the default output filehandle
		197	gets restored, so you can change alkl these. Otherwise the coroutine will
		198	be re-used "as-is": most notably if you change other per-coroutine global
		199	stuff such as C<$/> you need to revert that change, which is most simply
		200	done by using local as in C< local $/ >.
223		201
224	The pool size is limited to 8 idle coroutines (this can be adjusted by	202	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	203	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
226	required.	204	required.
227		205
228	If you are concerned about pooled coroutines growing a lot because a	206	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 {	207	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.	208	{ terminate }> once per second or so to slowly replenish the pool. In
		209	addition to that, when the stacks used by a handler grows larger than 16kb
		210	(adjustable with $Coro::POOL_RSS) it will also exit.
231		211
232	=cut	212	=cut
233		213
234	our $POOL_SIZE = 8;	214	our $POOL_SIZE = 8;
		215	our $POOL_RSS = 16 * 1024;
235	our @pool;	216	our @async_pool;
236		217
237	sub pool_handler {	218	sub pool_handler {
		219	my $cb;
		220
238	while () {	221	while () {
239	$current->{desc} = "[async_pool]";
240
241	eval {	222	eval {
242	my ($cb, @arg) = @{ delete $current->{_invoke} or return };	223	while () {
243	$cb->(@arg);	224	_pool_1 $cb;
		225	&$cb;
		226	_pool_2 $cb;
		227	&schedule;
		228	}
244	};	229	};
		230
		231	last if $@ eq "\3async_pool terminate\2\n";
245	warn $@ if $@;	232	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	}	233	}
255	}	234	}
256		235
257	sub async_pool(&@) {	236	sub async_pool(&@) {
258	# this is also inlined into the unlock_scheduler	237	# this is also inlined into the unlock_scheduler
259	my $coro = (pop @pool) \|\| new Coro \&pool_handler;;	238	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
260		239
261	$coro->{_invoke} = [@_];	240	$coro->{_invoke} = [@_];
262	$coro->ready;	241	$coro->ready;
263		242
264	$coro	243	$coro
…		…
294		273
295	"Cede" to other coroutines. This function puts the current coroutine into the	274	"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	275	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.	276	current "timeslice" to other coroutines of the same or higher priority.
298		277
299	Returns true if at least one coroutine switch has happened.
300
301	=item Coro::cede_notself	278	=item Coro::cede_notself
302		279
303	Works like cede, but is not exported by default and will cede to any	280	Works like cede, but is not exported by default and will cede to any
304	coroutine, regardless of priority, once.	281	coroutine, regardless of priority, once.
305		282
306	Returns true if at least one coroutine switch has happened.
307
308	=item terminate [arg...]	283	=item terminate [arg...]
309		284
310	Terminates the current coroutine with the given status values (see L<cancel>).	285	Terminates the current coroutine with the given status values (see L<cancel>).
		286
		287	=item killall
		288
		289	Kills/terminates/cancels all coroutines except the currently running
		290	one. This is useful after a fork, either in the child or the parent, as
		291	usually only one of them should inherit the running coroutines.
311		292
312	=cut	293	=cut
313		294
314	sub terminate {	295	sub terminate {
315	$current->cancel (@_);	296	$current->cancel (@_);
316	}	297	}
317		298
		299	sub killall {
		300	for (Coro::State::list) {
		301	$_->cancel
		302	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		303	}
		304	}
		305
318	=back	306	=back
319
320	# dynamic methods
321		307
322	=head2 COROUTINE METHODS	308	=head2 COROUTINE METHODS
323		309
324	These are the methods you can call on coroutine objects.	310	These are the methods you can call on coroutine objects.
325		311
…		…
330	Create a new coroutine and return it. When the sub returns the coroutine	316	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	317	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	318	called. To make the coroutine run you must first put it into the ready queue
333	by calling the ready method.	319	by calling the ready method.
334		320
335	See C<async> for additional discussion.	321	See C<async> and C<Coro::State::new> for additional info about the
		322	coroutine environment.
336		323
337	=cut	324	=cut
338		325
339	sub _run_coro {	326	sub _run_coro {
340	terminate &{+shift};	327	terminate &{+shift};
…		…
364		351
365	=cut	352	=cut
366		353
367	sub cancel {	354	sub cancel {
368	my $self = shift;	355	my $self = shift;
369	$self->{status} = [@_];	356	$self->{_status} = [@_];
370		357
371	if ($current == $self) {	358	if ($current == $self) {
372	push @destroy, $self;	359	push @destroy, $self;
373	$manager->ready;	360	$manager->ready;
374	&schedule while 1;	361	&schedule while 1;
…		…
378	}	365	}
379		366
380	=item $coroutine->join	367	=item $coroutine->join
381		368
382	Wait until the coroutine terminates and return any values given to the	369	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	370	C<terminate> or C<cancel> functions. C<join> can be called concurrently
384	from multiple coroutine.	371	from multiple coroutines.
385		372
386	=cut	373	=cut
387		374
388	sub join {	375	sub join {
389	my $self = shift;	376	my $self = shift;
390		377
391	unless ($self->{status}) {	378	unless ($self->{_status}) {
392	my $current = $current;	379	my $current = $current;
393		380
394	push @{$self->{destroy_cb}}, sub {	381	push @{$self->{_on_destroy}}, sub {
395	$current->ready;	382	$current->ready;
396	undef $current;	383	undef $current;
397	};	384	};
398		385
399	&schedule while $current;	386	&schedule while $current;
400	}	387	}
401		388
402	wantarray ? @{$self->{status}} : $self->{status}[0];	389	wantarray ? @{$self->{_status}} : $self->{_status}[0];
403	}	390	}
404		391
405	=item $coroutine->on_destroy (\&cb)	392	=item $coroutine->on_destroy (\&cb)
406		393
407	Registers a callback that is called when this coroutine gets destroyed,	394	Registers a callback that is called when this coroutine gets destroyed,
…		…
411	=cut	398	=cut
412		399
413	sub on_destroy {	400	sub on_destroy {
414	my ($self, $cb) = @_;	401	my ($self, $cb) = @_;
415		402
416	push @{ $self->{destroy_cb} }, $cb;	403	push @{ $self->{_on_destroy} }, $cb;
417	}	404	}
418		405
419	=item $oldprio = $coroutine->prio ($newprio)	406	=item $oldprio = $coroutine->prio ($newprio)
420		407
421	Sets (or gets, if the argument is missing) the priority of the	408	Sets (or gets, if the argument is missing) the priority of the
…		…
445		432
446	=item $olddesc = $coroutine->desc ($newdesc)	433	=item $olddesc = $coroutine->desc ($newdesc)
447		434
448	Sets (or gets in case the argument is missing) the description for this	435	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.	436	coroutine. This is just a free-form string you can associate with a coroutine.
		437
		438	This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
		439	can modify this member directly if you wish.
		440
		441	=item $coroutine->throw ([$scalar])
		442
		443	If C<$throw> is specified and defined, it will be thrown as an exception
		444	inside the coroutine at the next convinient point in time (usually after
		445	it gains control at the next schedule/transfer/cede). Otherwise clears the
		446	exception object.
		447
		448	The exception object will be thrown "as is" with the specified scalar in
		449	C<$@>, i.e. if it is a string, no line number or newline will be appended
		450	(unlike with C<die>).
		451
		452	This can be used as a softer means than C<cancel> to ask a coroutine to
		453	end itself, although there is no guarentee that the exception will lead to
		454	termination, and if the exception isn't caught it might well end the whole
		455	program.
450		456
451	=cut	457	=cut
452		458
453	sub desc {	459	sub desc {
454	my $old = $_[0]{desc};	460	my $old = $_[0]{desc};
…		…
530		536
531	# we create a special coro because we want to cede,	537	# we create a special coro because we want to cede,
532	# to reduce pressure on the coro pool (because most callbacks	538	# to reduce pressure on the coro pool (because most callbacks
533	# return immediately and can be reused) and because we cannot cede	539	# return immediately and can be reused) and because we cannot cede
534	# inside an event callback.	540	# inside an event callback.
535	our $unblock_scheduler = async {	541	our $unblock_scheduler = new Coro sub {
536	$current->desc ("[unblock_sub scheduler]");
537	while () {	542	while () {
538	while (my $cb = pop @unblock_queue) {	543	while (my $cb = pop @unblock_queue) {
539	# this is an inlined copy of async_pool	544	# this is an inlined copy of async_pool
540	my $coro = (pop @pool or new Coro \&pool_handler);	545	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
541		546
542	$coro->{_invoke} = $cb;	547	$coro->{_invoke} = $cb;
543	$coro->ready;	548	$coro->ready;
544	cede; # for short-lived callbacks, this reduces pressure on the coro pool	549	cede; # for short-lived callbacks, this reduces pressure on the coro pool
545	}	550	}
546	schedule; # sleep well	551	schedule; # sleep well
547	}	552	}
548	};	553	};
		554	$unblock_scheduler->desc ("[unblock_sub scheduler]");
549		555
550	sub unblock_sub(&) {	556	sub unblock_sub(&) {
551	my $cb = shift;	557	my $cb = shift;
552		558
553	sub {	559	sub {
…		…
572	to allow per-thread schedulers, but Coro::State does not yet allow	578	to allow per-thread schedulers, but Coro::State does not yet allow
573	this).	579	this).
574		580
575	=head1 SEE ALSO	581	=head1 SEE ALSO
576		582
		583	Lower level Configuration, Coroutine Environment: L<Coro::State>.
		584
		585	Debugging: L<Coro::Debug>.
		586
577	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	587	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
578		588
579	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.	589	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
580		590
581	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.	591	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>.
582		592
		593	Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
		594
583	Embedding: L<Coro:MakeMaker>	595	Embedding: L<Coro::MakeMaker>.
584		596
585	=head1 AUTHOR	597	=head1 AUTHOR
586		598
587	Marc Lehmann <schmorp@schmorp.de>	599	Marc Lehmann <schmorp@schmorp.de>
588	http://home.schmorp.de/	600	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.180 by root, Fri Apr 25 04:28:50 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.180 by root, Fri Apr 25 04:28:50 2008 UTC