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

Comparing Coro/Coro.pm (file contents):
Revision 1.38 by root, Wed Oct 3 01:09:56 2001 UTC vs.
Revision 1.85 by root, Sat Nov 25 00:56:35 2006 UTC

…		…
19	cede;	19	cede;
20		20
21	=head1 DESCRIPTION	21	=head1 DESCRIPTION
22		22
23	This module collection manages coroutines. Coroutines are similar to	23	This module collection manages coroutines. Coroutines are similar to
24	Threads but don't run in parallel.	24	threads but don't run in parallel.
25
26	This module is still experimental, see the BUGS section below.
27		25
28	In this module, coroutines are defined as "callchain + lexical variables	26	In this module, coroutines are defined as "callchain + lexical variables
29	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own	27	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30	callchain, it's own set of lexicals and it's own set of perl's most	28	callchain, it's own set of lexicals and it's own set of perl's most
31	important global variables.	29	important global variables.
32		30
33	=cut	31	=cut
34		32
35	package Coro;	33	package Coro;
36		34
		35	use strict;
37	no warnings qw(uninitialized);	36	no warnings "uninitialized";
38		37
39	use Coro::State;	38	use Coro::State;
40		39
41	use base Exporter;	40	use base qw(Coro::State Exporter);
42		41
		42	our $idle; # idle handler
		43	our $main; # main coroutine
		44	our $current; # current coroutine
		45
43	$VERSION = 0.51;	46	our $VERSION = '2.5';
44		47
45	@EXPORT = qw(async cede schedule terminate current);	48	our @EXPORT = qw(async cede schedule terminate current);
46	%EXPORT_TAGS = (	49	our %EXPORT_TAGS = (
47	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	50	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48	);	51	);
49	@EXPORT_OK = @{$EXPORT_TAGS{prio}};	52	our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
50		53
51	{	54	{
52	my @async;	55	my @async;
53	my $init;	56	my $init;
54		57
55	# this way of handling attributes simply is NOT scalable ;()	58	# this way of handling attributes simply is NOT scalable ;()
56	sub import {	59	sub import {
		60	no strict 'refs';
		61
57	Coro->export_to_level(1, @_);	62	Coro->export_to_level(1, @_);
		63
58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	64	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
59	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	65	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
60	my ($package, $ref) = (shift, shift);	66	my ($package, $ref) = (shift, shift);
61	my @attrs;	67	my @attrs;
62	for (@_) {	68	for (@_) {
…		…
77	};	83	};
78	}	84	}
79		85
80	}	86	}
81		87
		88	=over 4
		89
82	=item $main	90	=item $main
83		91
84	This coroutine represents the main program.	92	This coroutine represents the main program.
85		93
86	=cut	94	=cut
87		95
88	our $main = new Coro;	96	$main = new Coro;
89		97
90	=item $current (or as function: current)	98	=item $current (or as function: current)
91		99
92	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	100	The current coroutine (the last coroutine switched to). The initial value
		101	is C<$main> (of course).
		102
		103	This variable is B<strictly> I<read-only>. It is provided for performance
		104	reasons. If performance is not essentiel you are encouraged to use the
		105	C<Coro::current> function instead.
93		106
94	=cut	107	=cut
95		108
96	# maybe some other module used Coro::Specific before...	109	# maybe some other module used Coro::Specific before...
97	if ($current) {	110	if ($current) {
98	$main->{specific} = $current->{specific};	111	$main->{specific} = $current->{specific};
99	}	112	}
100		113
101	our $current = $main;	114	$current = $main;
102		115
103	sub current() { $current }	116	sub current() { $current }
104		117
105	=item $idle	118	=item $idle
106		119
107	The coroutine to switch to when no other coroutine is running. The default	120	A callback that is called whenever the scheduler finds no ready coroutines
108	implementation prints "FATAL: deadlock detected" and exits.	121	to run. The default implementation prints "FATAL: deadlock detected" and
		122	exits.
109		123
110	=cut	124	This hook is overwritten by modules such as C<Coro::Timer> and
		125	C<Coro::Event> to wait on an external event that hopefully wakes up some
		126	coroutine.
111		127
112	# should be done using priorities :(	128	=cut
113	our $idle = new Coro sub {	129
		130	$idle = sub {
114	print STDERR "FATAL: deadlock detected\n";	131	print STDERR "FATAL: deadlock detected\n";
115	exit(51);	132	exit (51);
116	};	133	};
117		134
118	# this coroutine is necessary because a coroutine	135	# this coroutine is necessary because a coroutine
119	# cannot destroy itself.	136	# cannot destroy itself.
120	my @destroy;	137	my @destroy;
121	my $manager;	138	my $manager;
122	$manager = new Coro sub {	139	$manager = new Coro sub {
123	while() {	140	while () {
124	# by overwriting the state object with the manager we destroy it	141	# by overwriting the state object with the manager we destroy it
125	# while still being able to schedule this coroutine (in case it has	142	# while still being able to schedule this coroutine (in case it has
126	# been readied multiple times. this is harmless since the manager	143	# been readied multiple times. this is harmless since the manager
127	# can be called as many times as neccessary and will always	144	# can be called as many times as neccessary and will always
128	# remove itself from the runqueue	145	# remove itself from the runqueue
129	(pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy;	146	while (@destroy) {
		147	my $coro = pop @destroy;
		148	$coro->{status} \|\|= [];
		149	$_->ready for @{delete $coro->{join} \|\| []};
		150
		151	# the next line destroys the coro state, but keeps the
		152	# process itself intact (we basically make it a zombie
		153	# process that always runs the manager thread, so it's possible
		154	# to transfer() to this process).
		155	$coro->_clone_state_from ($manager);
		156	}
130	&schedule;	157	&schedule;
131	}	158	}
132	};	159	};
133		160
134	# static methods. not really.	161	# static methods. not really.
135		162
		163	=back
		164
136	=head2 STATIC METHODS	165	=head2 STATIC METHODS
137		166
138	Static methods are actually functions that operate on the current process only.	167	Static methods are actually functions that operate on the current process only.
139		168
140	=over 4	169	=over 4
…		…
142	=item async { ... } [@args...]	171	=item async { ... } [@args...]
143		172
144	Create a new asynchronous process and return it's process object	173	Create a new asynchronous process and return it's process object
145	(usually unused). When the sub returns the new process is automatically	174	(usually unused). When the sub returns the new process is automatically
146	terminated.	175	terminated.
		176
		177	When the coroutine dies, the program will exit, just as in the main
		178	program.
147		179
148	# create a new coroutine that just prints its arguments	180	# create a new coroutine that just prints its arguments
149	async {	181	async {
150	print "@_\n";	182	print "@_\n";
151	} 1,2,3,4;	183	} 1,2,3,4;
152		184
153	The coderef you submit MUST NOT be a closure that refers to variables
154	in an outer scope. This does NOT work. Pass arguments into it instead.
155
156	=cut	185	=cut
157		186
158	sub async(&@) {	187	sub async(&@) {
159	my $pid = new Coro @_;	188	my $pid = new Coro @_;
160	$manager->ready; # this ensures that the stack is cloned from the manager
161	$pid->ready;	189	$pid->ready;
162	$pid;	190	$pid
163	}	191	}
164		192
165	=item schedule	193	=item schedule
166		194
167	Calls the scheduler. Please note that the current process will not be put	195	Calls the scheduler. Please note that the current process will not be put
…		…
176	ready queue and calls C<schedule>, which has the effect of giving up the	204	ready queue and calls C<schedule>, which has the effect of giving up the
177	current "timeslice" to other coroutines of the same or higher priority.	205	current "timeslice" to other coroutines of the same or higher priority.
178		206
179	=cut	207	=cut
180		208
181	=item terminate	209	=item terminate [arg...]
182		210
183	Terminates the current process.	211	Terminates the current process with the given status values (see L<cancel>).
184
185	Future versions of this function will allow result arguments.
186		212
187	=cut	213	=cut
188		214
189	sub terminate {	215	sub terminate {
190	$current->cancel;	216	$current->cancel (@_);
191	&schedule;
192	die; # NORETURN
193	}	217	}
194		218
195	=back	219	=back
196		220
197	# dynamic methods	221	# dynamic methods
…		…
203	=over 4	227	=over 4
204		228
205	=item new Coro \&sub [, @args...]	229	=item new Coro \&sub [, @args...]
206		230
207	Create a new process and return it. When the sub returns the process	231	Create a new process and return it. When the sub returns the process
208	automatically terminates. To start the process you must first put it into	232	automatically terminates as if C<terminate> with the returned values were
		233	called. To make the process run you must first put it into the ready queue
209	the ready queue by calling the ready method.	234	by calling the ready method.
210		235
211	The coderef you submit MUST NOT be a closure that refers to variables
212	in an outer scope. This does NOT work. Pass arguments into it instead.
213
214	=cut	236	=cut
215		237
216	sub _newcoro {	238	sub _new_coro {
		239	$current->_clear_idle_sp; # set the idle sp on the following cede
		240	_set_cede_self; # ensures that cede cede's us first
		241	cede;
217	terminate &{+shift};	242	terminate &{+shift};
218	}	243	}
219		244
220	sub new {	245	sub new {
221	my $class = shift;	246	my $class = shift;
222	bless {	247
223	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	248	$class->SUPER::new (\&_new_coro, @_)
224	}, $class;
225	}	249	}
226		250
227	=item $process->ready	251	=item $process->ready
228		252
229	Put the current process into the ready queue.	253	Put the given process into the ready queue.
230		254
231	=cut	255	=cut
232		256
233	=item $process->cancel	257	=item $process->cancel (arg...)
234		258
235	Like C<terminate>, but terminates the specified process instead.	259	Terminates the given process and makes it return the given arguments as
		260	status (default: the empty list).
236		261
237	=cut	262	=cut
238		263
239	sub cancel {	264	sub cancel {
		265	my $self = shift;
		266	$self->{status} = [@_];
240	push @destroy, $_[0];	267	push @destroy, $self;
241	$manager->ready;	268	$manager->ready;
242	&schedule if $current == $_[0];	269	&schedule if $current == $self;
243	}	270	}
244		271
		272	=item $process->join
		273
		274	Wait until the coroutine terminates and return any values given to the
		275	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		276	from multiple processes.
		277
		278	=cut
		279
		280	sub join {
		281	my $self = shift;
		282	unless ($self->{status}) {
		283	push @{$self->{join}}, $current;
		284	&schedule;
		285	}
		286	wantarray ? @{$self->{status}} : $self->{status}[0];
		287	}
		288
245	=item $oldprio = $process->prio($newprio)	289	=item $oldprio = $process->prio ($newprio)
246		290
247	Sets the priority of the process. Higher priority processes get run before	291	Sets (or gets, if the argument is missing) the priority of the
		292	process. Higher priority processes get run before lower priority
248	lower priority processes. Priorities are smalled signed integer (currently	293	processes. Priorities are small signed integers (currently -4 .. +3),
249	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import	294	that you can refer to using PRIO_xxx constants (use the import tag :prio
250	tag :prio to get then):	295	to get then):
251		296
252	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	297	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
253	3 > 1 > 0 > -1 > -3 > -4	298	3 > 1 > 0 > -1 > -3 > -4
254		299
255	# set priority to HIGH	300	# set priority to HIGH
…		…
261	Changing the priority of the current process will take effect immediately,	306	Changing the priority of the current process will take effect immediately,
262	but changing the priority of processes in the ready queue (but not	307	but changing the priority of processes in the ready queue (but not
263	running) will only take effect after the next schedule (of that	308	running) will only take effect after the next schedule (of that
264	process). This is a bug that will be fixed in some future version.	309	process). This is a bug that will be fixed in some future version.
265		310
266	=cut
267
268	sub prio {
269	my $old = $_[0]{prio};
270	$_[0]{prio} = $_[1] if @_ > 1;
271	$old;
272	}
273
274	=item $newprio = $process->nice($change)	311	=item $newprio = $process->nice ($change)
275		312
276	Similar to C<prio>, but subtract the given value from the priority (i.e.	313	Similar to C<prio>, but subtract the given value from the priority (i.e.
277	higher values mean lower priority, just as in unix).	314	higher values mean lower priority, just as in unix).
278		315
279	=cut	316	=item $olddesc = $process->desc ($newdesc)
280		317
281	sub nice {	318	Sets (or gets in case the argument is missing) the description for this
282	$_[0]{prio} -= $_[1];	319	process. This is just a free-form string you can associate with a process.
		320
		321	=cut
		322
		323	sub desc {
		324	my $old = $_[0]{desc};
		325	$_[0]{desc} = $_[1] if @_ > 1;
		326	$old;
283	}	327	}
284		328
285	=back	329	=back
286		330
287	=cut	331	=cut
288		332
289	1;	333	1;
290		334
291	=head1 BUGS/LIMITATIONS	335	=head1 BUGS/LIMITATIONS
292		336
293	- you must make very sure that no coro is still active on global destruction.	337	- you must make very sure that no coro is still active on global
294	very bad things might happen otherwise (usually segfaults).	338	destruction. very bad things might happen otherwise (usually segfaults).
		339
295	- this module is not thread-safe. You must only ever use this module from	340	- this module is not thread-safe. You should only ever use this module
296	the same thread (this requirement might be loosened in the future to	341	from the same thread (this requirement might be losened in the future
297	allow per-thread schedulers, but Coro::State does not yet allow this).	342	to allow per-thread schedulers, but Coro::State does not yet allow
		343	this).
298		344
299	=head1 SEE ALSO	345	=head1 SEE ALSO
300		346
301	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	347	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
302	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	348
303	L<Coro::Handle>, L<Coro::Socket>.	349	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		350
		351	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		352
		353	Embedding: L<Coro:MakeMaker>
304		354
305	=head1 AUTHOR	355	=head1 AUTHOR
306		356
307	Marc Lehmann <pcg@goof.com>	357	Marc Lehmann <schmorp@schmorp.de>
308	http://www.goof.com/pcg/marc/	358	http://home.schmorp.de/
309		359
310	=cut	360	=cut
311		361

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.38 by root, Wed Oct 3 01:09:56 2001 UTC vs. Revision 1.85 by root, Sat Nov 25 00:56:35 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.38 by root, Wed Oct 3 01:09:56 2001 UTC vs.
Revision 1.85 by root, Sat Nov 25 00:56:35 2006 UTC