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

Comparing Coro/Coro.pm (file contents):
Revision 1.31 by root, Sat Aug 11 23:10:56 2001 UTC vs.
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 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	BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }
		36
37	use Coro::State;	37	use Coro::State;
38		38
		39	use vars qw($idle $main $current);
		40
39	use base Exporter;	41	use base Exporter;
40		42
41	$VERSION = 0.45;	43	$VERSION = 0.95;
42		44
43	@EXPORT = qw(async cede schedule terminate current);	45	@EXPORT = qw(async cede schedule terminate current);
44	%EXPORT_TAGS = (	46	%EXPORT_TAGS = (
45	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	47	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
46	);	48	);
…		…
75	};	77	};
76	}	78	}
77		79
78	}	80	}
79		81
		82	=over 4
		83
80	=item $main	84	=item $main
81		85
82	This coroutine represents the main program.	86	This coroutine represents the main program.
83		87
84	=cut	88	=cut
85		89
86	our $main = new Coro;	90	$main = new Coro;
87		91
88	=item $current (or as function: current)	92	=item $current (or as function: current)
89		93
90	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	94	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
91		95
…		…
94	# maybe some other module used Coro::Specific before...	98	# maybe some other module used Coro::Specific before...
95	if ($current) {	99	if ($current) {
96	$main->{specific} = $current->{specific};	100	$main->{specific} = $current->{specific};
97	}	101	}
98		102
99	our $current = $main;	103	$current = $main;
100		104
101	sub current() { $current }	105	sub current() { $current }
102		106
103	=item $idle	107	=item $idle
104		108
…		…
106	implementation prints "FATAL: deadlock detected" and exits.	110	implementation prints "FATAL: deadlock detected" and exits.
107		111
108	=cut	112	=cut
109		113
110	# should be done using priorities :(	114	# should be done using priorities :(
111	our $idle = new Coro sub {	115	$idle = new Coro sub {
112	print STDERR "FATAL: deadlock detected\n";	116	print STDERR "FATAL: deadlock detected\n";
113	exit(51);	117	exit(51);
114	};	118	};
115		119
116	# this coroutine is necessary because a coroutine	120	# this coroutine is necessary because a coroutine
117	# cannot destroy itself.	121	# cannot destroy itself.
118	my @destroy;	122	my @destroy;
		123	my $manager;
119	my $manager = new Coro sub {	124	$manager = new Coro sub {
120	while() {	125	while () {
121	delete ((pop @destroy)->{_coro_state}) while @destroy;	126	# by overwriting the state object with the manager we destroy it
		127	# while still being able to schedule this coroutine (in case it has
		128	# been readied multiple times. this is harmless since the manager
		129	# can be called as many times as neccessary and will always
		130	# remove itself from the runqueue
		131	while (@destroy) {
		132	my $coro = pop @destroy;
		133	$coro->{status} \|\|= [];
		134	$_->ready for @{delete $coro->{join} \|\| []};
		135	$coro->{_coro_state} = $manager->{_coro_state};
		136	}
122	&schedule;	137	&schedule;
123	}	138	}
124	};	139	};
125		140
126	# static methods. not really.	141	# static methods. not really.
		142
		143	=back
127		144
128	=head2 STATIC METHODS	145	=head2 STATIC METHODS
129		146
130	Static methods are actually functions that operate on the current process only.	147	Static methods are actually functions that operate on the current process only.
131		148
…		…
139		156
140	# create a new coroutine that just prints its arguments	157	# create a new coroutine that just prints its arguments
141	async {	158	async {
142	print "@_\n";	159	print "@_\n";
143	} 1,2,3,4;	160	} 1,2,3,4;
144
145	The coderef you submit MUST NOT be a closure that refers to variables
146	in an outer scope. This does NOT work. Pass arguments into it instead.
147		161
148	=cut	162	=cut
149		163
150	sub async(&@) {	164	sub async(&@) {
151	my $pid = new Coro @_;	165	my $pid = new Coro @_;
…		…
168	ready queue and calls C<schedule>, which has the effect of giving up the	182	ready queue and calls C<schedule>, which has the effect of giving up the
169	current "timeslice" to other coroutines of the same or higher priority.	183	current "timeslice" to other coroutines of the same or higher priority.
170		184
171	=cut	185	=cut
172		186
173	=item terminate	187	=item terminate [arg...]
174		188
175	Terminates the current process.	189	Terminates the current process.
176		190
177	Future versions of this function will allow result arguments.	191	Future versions of this function will allow result arguments.
178		192
179	=cut	193	=cut
180		194
181	sub terminate {	195	sub terminate {
		196	$current->{status} = [@_];
182	$current->cancel;	197	$current->cancel;
183	&schedule;	198	&schedule;
184	die; # NORETURN	199	die; # NORETURN
185	}	200	}
186		201
…		…
195	=over 4	210	=over 4
196		211
197	=item new Coro \&sub [, @args...]	212	=item new Coro \&sub [, @args...]
198		213
199	Create a new process and return it. When the sub returns the process	214	Create a new process and return it. When the sub returns the process
200	automatically terminates. To start the process you must first put it into	215	automatically terminates as if C<terminate> with the returned values were
		216	called. To make the process run you must first put it into the ready queue
201	the ready queue by calling the ready method.	217	by calling the ready method.
202
203	The coderef you submit MUST NOT be a closure that refers to variables
204	in an outer scope. This does NOT work. Pass arguments into it instead.
205		218
206	=cut	219	=cut
207		220
208	sub _newcoro {	221	sub _newcoro {
209	terminate &{+shift};	222	terminate &{+shift};
…		…
216	}, $class;	229	}, $class;
217	}	230	}
218		231
219	=item $process->ready	232	=item $process->ready
220		233
221	Put the current process into the ready queue.	234	Put the given process into the ready queue.
222		235
223	=cut	236	=cut
224		237
225	=item $process->cancel	238	=item $process->cancel
226		239
…		…
229	=cut	242	=cut
230		243
231	sub cancel {	244	sub cancel {
232	push @destroy, $_[0];	245	push @destroy, $_[0];
233	$manager->ready;	246	$manager->ready;
		247	&schedule if $current == $_[0];
		248	}
		249
		250	=item $process->join
		251
		252	Wait until the coroutine terminates and return any values given to the
		253	C<terminate> function. C<join> can be called multiple times from multiple
		254	processes.
		255
		256	=cut
		257
		258	sub join {
		259	my $self = shift;
		260	unless ($self->{status}) {
		261	push @{$self->{join}}, $current;
		262	&schedule;
		263	}
		264	wantarray ? @{$self->{status}} : $self->{status}[0];
234	}	265	}
235		266
236	=item $oldprio = $process->prio($newprio)	267	=item $oldprio = $process->prio($newprio)
237		268
238	Sets the priority of the process. Higher priority processes get run before	269	Sets (or gets, if the argument is missing) the priority of the
		270	process. Higher priority processes get run before lower priority
239	lower priority processes. Priorities are smalled signed integer (currently	271	processes. Priorities are small signed integers (currently -4 .. +3),
240	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import	272	that you can refer to using PRIO_xxx constants (use the import tag :prio
241	tag :prio to get then):	273	to get then):
242		274
243	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	275	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
244	3 > 1 > 0 > -1 > -3 > -4	276	3 > 1 > 0 > -1 > -3 > -4
245		277
246	# set priority to HIGH	278	# set priority to HIGH
…		…
271		303
272	sub nice {	304	sub nice {
273	$_[0]{prio} -= $_[1];	305	$_[0]{prio} -= $_[1];
274	}	306	}
275		307
		308	=item $olddesc = $process->desc($newdesc)
		309
		310	Sets (or gets in case the argument is missing) the description for this
		311	process. This is just a free-form string you can associate with a process.
		312
		313	=cut
		314
		315	sub desc {
		316	my $old = $_[0]{desc};
		317	$_[0]{desc} = $_[1] if @_ > 1;
		318	$old;
		319	}
		320
276	=back	321	=back
277		322
278	=cut	323	=cut
279		324
280	1;	325	1;
281		326
282	=head1 BUGS/LIMITATIONS	327	=head1 BUGS/LIMITATIONS
283		328
284	- could be faster, especially when the core would introduce special	329	- you must make very sure that no coro is still active on global
285	support for coroutines (like it does for threads).	330	destruction. very bad things might happen otherwise (usually segfaults).
286	- there is still a memleak on coroutine termination that I could not	331
287	identify. Could be as small as a single SV.
288	- this module is not well-tested.
289	- if variables or arguments "disappear" (become undef) or become
290	corrupted please contact the author so he cen iron out the
291	remaining bugs.
292	- this module is not thread-safe. You must only ever use this module from	332	- this module is not thread-safe. You should only ever use this module
293	the same thread (this requirement might be loosened in the future to	333	from the same thread (this requirement might be losened in the future
294	allow per-thread schedulers, but Coro::State does not yet allow this).	334	to allow per-thread schedulers, but Coro::State does not yet allow
		335	this).
295		336
296	=head1 SEE ALSO	337	=head1 SEE ALSO
297		338
298	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	339	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
299	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	340	L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
300	L<Coro::Handle>, L<Coro::Socket>.	341	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
301		342
302	=head1 AUTHOR	343	=head1 AUTHOR
303		344
304	Marc Lehmann <pcg@goof.com>	345	Marc Lehmann <pcg@goof.com>
305	http://www.goof.com/pcg/marc/	346	http://www.goof.com/pcg/marc/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.31 by root, Sat Aug 11 23:10:56 2001 UTC vs. Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.31 by root, Sat Aug 11 23:10:56 2001 UTC vs.
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC