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

Comparing Coro/Coro.pm (file contents):
Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC vs.
Revision 1.179 by root, Sat Apr 19 19:06:02 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.8';	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	);
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.
…		…
116	=cut	89	=cut
117		90
118	$main->{desc} = "[main::]";	91	$main->{desc} = "[main::]";
119		92
120	# maybe some other module used Coro::Specific before...	93	# maybe some other module used Coro::Specific before...
121	$main->{specific} = $current->{specific}	94	$main->{_specific} = $current->{_specific}
122	if $current;	95	if $current;
123		96
124	_set_current $main;	97	_set_current $main;
125		98
126	sub current() { $current }	99	sub current() { $current }
…		…
134	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
135	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
136	coroutine so the scheduler can run it.	109	coroutine so the scheduler can run it.
137		110
138	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
139	handlers), then it must be prepared to be called recursively.	112	handlers), then it must be prepared to be called recursively itself.
140		113
141	=cut	114	=cut
142		115
143	$idle = sub {	116	$idle = sub {
144	require Carp;	117	require Carp;
…		…
151	# free coroutine data and mark as destructed	124	# free coroutine data and mark as destructed
152	$self->_destroy	125	$self->_destroy
153	or return;	126	or return;
154		127
155	# call all destruction callbacks	128	# call all destruction callbacks
156	$_->(@{$self->{status}})	129	$_->(@{$self->{_status}})
157	for @{(delete $self->{destroy_cb}) \|\| []};	130	for @{(delete $self->{_on_destroy}) \|\| []};
158	}
159
160	sub _do_trace_sub {
161	&{$current->{_trace_sub_cb}}
162	}
163
164	sub _do_trace_line {
165	&{$current->{_trace_line_cb}}
166	}	131	}
167		132
168	# this coroutine is necessary because a coroutine	133	# this coroutine is necessary because a coroutine
169	# cannot destroy itself.	134	# cannot destroy itself.
170	my @destroy;	135	my @destroy;
…		…
179	}	144	}
180	};	145	};
181	$manager->desc ("[coro manager]");	146	$manager->desc ("[coro manager]");
182	$manager->prio (PRIO_MAX);	147	$manager->prio (PRIO_MAX);
183		148
184	# static methods. not really.
185
186	=back	149	=back
187		150
188	=head2 STATIC METHODS	151	=head2 STATIC METHODS
189		152
190	Static methods are actually functions that operate on the current coroutine only.	153	Static methods are actually functions that operate on the current coroutine only.
…		…
194	=item async { ... } [@args...]	157	=item async { ... } [@args...]
195		158
196	Create a new asynchronous coroutine and return it's coroutine object	159	Create a new asynchronous coroutine and return it's coroutine object
197	(usually unused). When the sub returns the new coroutine is automatically	160	(usually unused). When the sub returns the new coroutine is automatically
198	terminated.	161	terminated.
		162
		163	See the C<Coro::State::new> constructor for info about the coroutine
		164	environment in which coroutines run.
199		165
200	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
201	the coroutine. Likewise, when the coroutine dies, the program will exit,	167	the coroutine. Likewise, when the coroutine dies, the program will exit,
202	just as it would in the main program.	168	just as it would in the main program.
203		169
…		…
224	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
225	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>
226	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,
227	which somehow defeats the purpose of pooling.	193	which somehow defeats the purpose of pooling.
228		194
229	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
230	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 $/ >.
231		201
232	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
233	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
234	required.	204	required.
235		205
…		…
256	_pool_2 $cb;	226	_pool_2 $cb;
257	&schedule;	227	&schedule;
258	}	228	}
259	};	229	};
260		230
261	last if $@ eq "\3terminate\2\n";	231	last if $@ eq "\3async_pool terminate\2\n";
262	warn $@ if $@;	232	warn $@ if $@;
263	}	233	}
264	}	234	}
265		235
266	sub async_pool(&@) {	236	sub async_pool(&@) {
…		…
303		273
304	"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
305	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
306	current "timeslice" to other coroutines of the same or higher priority.	276	current "timeslice" to other coroutines of the same or higher priority.
307		277
308	Returns true if at least one coroutine switch has happened.
309
310	=item Coro::cede_notself	278	=item Coro::cede_notself
311		279
312	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
313	coroutine, regardless of priority, once.	281	coroutine, regardless of priority, once.
314		282
315	Returns true if at least one coroutine switch has happened.
316
317	=item terminate [arg...]	283	=item terminate [arg...]
318		284
319	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.
320		292
321	=cut	293	=cut
322		294
323	sub terminate {	295	sub terminate {
324	$current->cancel (@_);	296	$current->cancel (@_);
325	}	297	}
326		298
		299	sub killall {
		300	for (Coro::State::list) {
		301	$_->cancel
		302	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		303	}
		304	}
		305
327	=back	306	=back
328
329	# dynamic methods
330		307
331	=head2 COROUTINE METHODS	308	=head2 COROUTINE METHODS
332		309
333	These are the methods you can call on coroutine objects.	310	These are the methods you can call on coroutine objects.
334		311
…		…
339	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
340	automatically terminates as if C<terminate> with the returned values were	317	automatically terminates as if C<terminate> with the returned values were
341	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
342	by calling the ready method.	319	by calling the ready method.
343		320
344	See C<async> for additional discussion.	321	See C<async> and C<Coro::State::new> for additional info about the
		322	coroutine environment.
345		323
346	=cut	324	=cut
347		325
348	sub _run_coro {	326	sub _run_coro {
349	terminate &{+shift};	327	terminate &{+shift};
…		…
373		351
374	=cut	352	=cut
375		353
376	sub cancel {	354	sub cancel {
377	my $self = shift;	355	my $self = shift;
378	$self->{status} = [@_];	356	$self->{_status} = [@_];
379		357
380	if ($current == $self) {	358	if ($current == $self) {
381	push @destroy, $self;	359	push @destroy, $self;
382	$manager->ready;	360	$manager->ready;
383	&schedule while 1;	361	&schedule while 1;
…		…
387	}	365	}
388		366
389	=item $coroutine->join	367	=item $coroutine->join
390		368
391	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
392	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
393	from multiple coroutine.	371	from multiple coroutines.
394		372
395	=cut	373	=cut
396		374
397	sub join {	375	sub join {
398	my $self = shift;	376	my $self = shift;
399		377
400	unless ($self->{status}) {	378	unless ($self->{_status}) {
401	my $current = $current;	379	my $current = $current;
402		380
403	push @{$self->{destroy_cb}}, sub {	381	push @{$self->{_on_destroy}}, sub {
404	$current->ready;	382	$current->ready;
405	undef $current;	383	undef $current;
406	};	384	};
407		385
408	&schedule while $current;	386	&schedule while $current;
409	}	387	}
410		388
411	wantarray ? @{$self->{status}} : $self->{status}[0];	389	wantarray ? @{$self->{_status}} : $self->{_status}[0];
412	}	390	}
413		391
414	=item $coroutine->on_destroy (\&cb)	392	=item $coroutine->on_destroy (\&cb)
415		393
416	Registers a callback that is called when this coroutine gets destroyed,	394	Registers a callback that is called when this coroutine gets destroyed,
…		…
420	=cut	398	=cut
421		399
422	sub on_destroy {	400	sub on_destroy {
423	my ($self, $cb) = @_;	401	my ($self, $cb) = @_;
424		402
425	push @{ $self->{destroy_cb} }, $cb;	403	push @{ $self->{_on_destroy} }, $cb;
426	}	404	}
427		405
428	=item $oldprio = $coroutine->prio ($newprio)	406	=item $oldprio = $coroutine->prio ($newprio)
429		407
430	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
…		…
454		432
455	=item $olddesc = $coroutine->desc ($newdesc)	433	=item $olddesc = $coroutine->desc ($newdesc)
456		434
457	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
458	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.
459		456
460	=cut	457	=cut
461		458
462	sub desc {	459	sub desc {
463	my $old = $_[0]{desc};	460	my $old = $_[0]{desc};
…		…
581	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
582	this).	579	this).
583		580
584	=head1 SEE ALSO	581	=head1 SEE ALSO
585		582
		583	Lower level Configuration, Coroutine Environment: L<Coro::State>.
		584
		585	Debugging: L<Coro::Debug>.
		586
586	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.	587	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
587		588
588	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>.
589		590
590	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>.
591		592
		593	Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
		594
592	Embedding: L<Coro:MakeMaker>	595	Embedding: L<Coro::MakeMaker>.
593		596
594	=head1 AUTHOR	597	=head1 AUTHOR
595		598
596	Marc Lehmann <schmorp@schmorp.de>	599	Marc Lehmann <schmorp@schmorp.de>
597	http://home.schmorp.de/	600	http://home.schmorp.de/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC vs. Revision 1.179 by root, Sat Apr 19 19:06:02 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC vs.
Revision 1.179 by root, Sat Apr 19 19:06:02 2008 UTC