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

Comparing Coro/Coro.pm (file contents):
Revision 1.40 by root, Sun Oct 28 17:00:05 2001 UTC vs.
Revision 1.83 by root, Fri Nov 24 15:34:33 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	while (@destroy) {	146	while (@destroy) {
130	my $coro = pop @destroy;	147	my $coro = pop @destroy;
131	$coro->{status} \|\|= [];	148	$coro->{status} \|\|= [];
132	$_->ready for @{delete $coro->{join} \|\| []};	149	$_->ready for @{delete $coro->{join} \|\| []};
133	$coro->{_coro_state} = $manager->{_coro_state};	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);
134	}	156	}
135	&schedule;	157	&schedule;
136	}	158	}
137	};	159	};
138		160
139	# static methods. not really.	161	# static methods. not really.
140		162
		163	=back
		164
141	=head2 STATIC METHODS	165	=head2 STATIC METHODS
142		166
143	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.
144		168
145	=over 4	169	=over 4
…		…
147	=item async { ... } [@args...]	171	=item async { ... } [@args...]
148		172
149	Create a new asynchronous process and return it's process object	173	Create a new asynchronous process and return it's process object
150	(usually unused). When the sub returns the new process is automatically	174	(usually unused). When the sub returns the new process is automatically
151	terminated.	175	terminated.
		176
		177	When the coroutine dies, the program will exit, just as in the main
		178	program.
152		179
153	# create a new coroutine that just prints its arguments	180	# create a new coroutine that just prints its arguments
154	async {	181	async {
155	print "@_\n";	182	print "@_\n";
156	} 1,2,3,4;	183	} 1,2,3,4;
157
158	The coderef you submit MUST NOT be a closure that refers to variables
159	in an outer scope. This does NOT work. Pass arguments into it instead.
160		184
161	=cut	185	=cut
162		186
163	sub async(&@) {	187	sub async(&@) {
164	my $pid = new Coro @_;	188	my $pid = new Coro @_;
…		…
183		207
184	=cut	208	=cut
185		209
186	=item terminate [arg...]	210	=item terminate [arg...]
187		211
188	Terminates the current process.	212	Terminates the current process with the given status values (see L<cancel>).
189
190	Future versions of this function will allow result arguments.
191		213
192	=cut	214	=cut
193		215
194	sub terminate {	216	sub terminate {
195	$current->{status} = [@_];
196	$current->cancel;	217	$current->cancel (@_);
197	&schedule;
198	die; # NORETURN
199	}	218	}
200		219
201	=back	220	=back
202		221
203	# dynamic methods	222	# dynamic methods
…		…
210		229
211	=item new Coro \&sub [, @args...]	230	=item new Coro \&sub [, @args...]
212		231
213	Create a new process and return it. When the sub returns the process	232	Create a new process and return it. When the sub returns the process
214	automatically terminates as if C<terminate> with the returned values were	233	automatically terminates as if C<terminate> with the returned values were
215	called. To start the process you must first put it into the ready queue by	234	called. To make the process run you must first put it into the ready queue
216	calling the ready method.	235	by calling the ready method.
217
218	The coderef you submit MUST NOT be a closure that refers to variables
219	in an outer scope. This does NOT work. Pass arguments into it instead.
220		236
221	=cut	237	=cut
222		238
223	sub _newcoro {	239	sub _newcoro {
224	terminate &{+shift};	240	terminate &{+shift};
225	}	241	}
226		242
227	sub new {	243	sub new {
228	my $class = shift;	244	my $class = shift;
229	bless {	245
230	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	246	$class->SUPER::new (\&_newcoro, @_)
231	}, $class;
232	}	247	}
233		248
234	=item $process->ready	249	=item $process->ready
235		250
236	Put the given process into the ready queue.	251	Put the given process into the ready queue.
237		252
238	=cut	253	=cut
239		254
240	=item $process->cancel	255	=item $process->cancel (arg...)
241		256
242	Like C<terminate>, but terminates the specified process instead.	257	Terminates the given process and makes it return the given arguments as
		258	status (default: the empty list).
243		259
244	=cut	260	=cut
245		261
246	sub cancel {	262	sub cancel {
		263	my $self = shift;
		264	$self->{status} = [@_];
247	push @destroy, $_[0];	265	push @destroy, $self;
248	$manager->ready;	266	$manager->ready;
249	&schedule if $current == $_[0];	267	&schedule if $current == $self;
250	}	268	}
251		269
252	=item $process->join	270	=item $process->join
253		271
254	Wait until the coroutine terminates and return any values given to the	272	Wait until the coroutine terminates and return any values given to the
255	C<terminate> function. C<join> can be called multiple times from multiple	273	C<terminate> or C<cancel> functions. C<join> can be called multiple times
256	processes.	274	from multiple processes.
257		275
258	=cut	276	=cut
259		277
260	sub join {	278	sub join {
261	my $self = shift;	279	my $self = shift;
…		…
264	&schedule;	282	&schedule;
265	}	283	}
266	wantarray ? @{$self->{status}} : $self->{status}[0];	284	wantarray ? @{$self->{status}} : $self->{status}[0];
267	}	285	}
268		286
269	=item $oldprio = $process->prio($newprio)	287	=item $oldprio = $process->prio ($newprio)
270		288
271	Sets the priority of the process. Higher priority processes get run before	289	Sets (or gets, if the argument is missing) the priority of the
		290	process. Higher priority processes get run before lower priority
272	lower priority processes. Priorities are smalled signed integer (currently	291	processes. Priorities are small signed integers (currently -4 .. +3),
273	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import	292	that you can refer to using PRIO_xxx constants (use the import tag :prio
274	tag :prio to get then):	293	to get then):
275		294
276	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	295	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277	3 > 1 > 0 > -1 > -3 > -4	296	3 > 1 > 0 > -1 > -3 > -4
278		297
279	# set priority to HIGH	298	# set priority to HIGH
…		…
285	Changing the priority of the current process will take effect immediately,	304	Changing the priority of the current process will take effect immediately,
286	but changing the priority of processes in the ready queue (but not	305	but changing the priority of processes in the ready queue (but not
287	running) will only take effect after the next schedule (of that	306	running) will only take effect after the next schedule (of that
288	process). This is a bug that will be fixed in some future version.	307	process). This is a bug that will be fixed in some future version.
289		308
290	=cut
291
292	sub prio {
293	my $old = $_[0]{prio};
294	$_[0]{prio} = $_[1] if @_ > 1;
295	$old;
296	}
297
298	=item $newprio = $process->nice($change)	309	=item $newprio = $process->nice ($change)
299		310
300	Similar to C<prio>, but subtract the given value from the priority (i.e.	311	Similar to C<prio>, but subtract the given value from the priority (i.e.
301	higher values mean lower priority, just as in unix).	312	higher values mean lower priority, just as in unix).
302		313
303	=cut	314	=item $olddesc = $process->desc ($newdesc)
304		315
305	sub nice {	316	Sets (or gets in case the argument is missing) the description for this
306	$_[0]{prio} -= $_[1];	317	process. This is just a free-form string you can associate with a process.
		318
		319	=cut
		320
		321	sub desc {
		322	my $old = $_[0]{desc};
		323	$_[0]{desc} = $_[1] if @_ > 1;
		324	$old;
307	}	325	}
308		326
309	=back	327	=back
310		328
311	=cut	329	=cut
312		330
313	1;	331	1;
314		332
315	=head1 BUGS/LIMITATIONS	333	=head1 BUGS/LIMITATIONS
316		334
317	- you must make very sure that no coro is still active on global destruction.	335	- you must make very sure that no coro is still active on global
318	very bad things might happen otherwise (usually segfaults).	336	destruction. very bad things might happen otherwise (usually segfaults).
		337
319	- this module is not thread-safe. You must only ever use this module from	338	- this module is not thread-safe. You should only ever use this module
320	the same thread (this requirement might be loosened in the future to	339	from the same thread (this requirement might be losened in the future
321	allow per-thread schedulers, but Coro::State does not yet allow this).	340	to allow per-thread schedulers, but Coro::State does not yet allow
		341	this).
322		342
323	=head1 SEE ALSO	343	=head1 SEE ALSO
324		344
325	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	345	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
326	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	346
327	L<Coro::Handle>, L<Coro::Socket>.	347	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		348
		349	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		350
		351	Embedding: L<Coro:MakeMaker>
328		352
329	=head1 AUTHOR	353	=head1 AUTHOR
330		354
331	Marc Lehmann <pcg@goof.com>	355	Marc Lehmann <schmorp@schmorp.de>
332	http://www.goof.com/pcg/marc/	356	http://home.schmorp.de/
333		357
334	=cut	358	=cut
335		359

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.40 by root, Sun Oct 28 17:00:05 2001 UTC vs. Revision 1.83 by root, Fri Nov 24 15:34:33 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.40 by root, Sun Oct 28 17:00:05 2001 UTC vs.
Revision 1.83 by root, Fri Nov 24 15:34:33 2006 UTC