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

Comparing Coro/Coro.pm (file contents):
Revision 1.29 by root, Sat Aug 11 00:37:31 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_OK = qw($current);	46	%EXPORT_TAGS = (
		47	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
		48	);
		49	@EXPORT_OK = @{$EXPORT_TAGS{prio}};
45		50
46	{	51	{
47	my @async;	52	my @async;
48	my $init;	53	my $init;
49		54
…		…
72	};	77	};
73	}	78	}
74		79
75	}	80	}
76		81
		82	=over 4
		83
77	=item $main	84	=item $main
78		85
79	This coroutine represents the main program.	86	This coroutine represents the main program.
80		87
81	=cut	88	=cut
82		89
83	our $main = new Coro;	90	$main = new Coro;
84		91
85	=item $current (or as function: current)	92	=item $current (or as function: current)
86		93
87	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).
88		95
…		…
91	# maybe some other module used Coro::Specific before...	98	# maybe some other module used Coro::Specific before...
92	if ($current) {	99	if ($current) {
93	$main->{specific} = $current->{specific};	100	$main->{specific} = $current->{specific};
94	}	101	}
95		102
96	our $current = $main;	103	$current = $main;
97		104
98	sub current() { $current }	105	sub current() { $current }
99		106
100	=item $idle	107	=item $idle
101		108
…		…
103	implementation prints "FATAL: deadlock detected" and exits.	110	implementation prints "FATAL: deadlock detected" and exits.
104		111
105	=cut	112	=cut
106		113
107	# should be done using priorities :(	114	# should be done using priorities :(
108	our $idle = new Coro sub {	115	$idle = new Coro sub {
109	print STDERR "FATAL: deadlock detected\n";	116	print STDERR "FATAL: deadlock detected\n";
110	exit(51);	117	exit(51);
111	};	118	};
112		119
113	# this coroutine is necessary because a coroutine	120	# this coroutine is necessary because a coroutine
114	# cannot destroy itself.	121	# cannot destroy itself.
115	my @destroy;	122	my @destroy;
		123	my $manager;
116	my $manager = new Coro sub {	124	$manager = new Coro sub {
117	while() {	125	while () {
118	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	}
119	&schedule;	137	&schedule;
120	}	138	}
121	};	139	};
122		140
123	# we really need priorities...
124	my @ready; # the ready queue. hehe, rather broken ;)
125
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 @_;
…		…
160	into the ready queue, so calling this function usually means you will	174	into the ready queue, so calling this function usually means you will
161	never be called again.	175	never be called again.
162		176
163	=cut	177	=cut
164		178
165	my $prev;
166
167	sub schedule {
168	# should be done using priorities :(
169	($prev, $current) = ($current, shift @ready \|\| $idle);
170	Coro::State::transfer($prev, $current);
171	}
172
173	=item cede	179	=item cede
174		180
175	"Cede" to other processes. This function puts the current process into the	181	"Cede" to other processes. This function puts the current process into the
176	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
177	current "timeslice" to other coroutines of the same or higher priority.	183	current "timeslice" to other coroutines of the same or higher priority.
178		184
179	=cut	185	=cut
180		186
181	sub cede {
182	$current->ready;
183	&schedule;
184	}
185
186	=item terminate	187	=item terminate [arg...]
187		188
188	Terminates the current process.	189	Terminates the current process.
189		190
190	Future versions of this function will allow result arguments.	191	Future versions of this function will allow result arguments.
191		192
192	=cut	193	=cut
193		194
194	sub terminate {	195	sub terminate {
		196	$current->{status} = [@_];
195	$current->cancel;	197	$current->cancel;
196	&schedule;	198	&schedule;
197	die; # NORETURN	199	die; # NORETURN
198	}	200	}
199		201
…		…
208	=over 4	210	=over 4
209		211
210	=item new Coro \&sub [, @args...]	212	=item new Coro \&sub [, @args...]
211		213
212	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
213	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
214	the ready queue by calling the ready method.	217	by calling the ready method.
215
216	The coderef you submit MUST NOT be a closure that refers to variables
217	in an outer scope. This does NOT work. Pass arguments into it instead.
218		218
219	=cut	219	=cut
220		220
221	sub _newcoro {	221	sub _newcoro {
222	terminate &{+shift};	222	terminate &{+shift};
…		…
229	}, $class;	229	}, $class;
230	}	230	}
231		231
232	=item $process->ready	232	=item $process->ready
233		233
234	Put the current process into the ready queue.	234	Put the given process into the ready queue.
235		235
236	=cut	236	=cut
237
238	sub ready {
239	push @ready, $_[0];
240	}
241		237
242	=item $process->cancel	238	=item $process->cancel
243		239
244	Like C<terminate>, but terminates the specified process instead.	240	Like C<terminate>, but terminates the specified process instead.
245		241
246	=cut	242	=cut
247		243
248	sub cancel {	244	sub cancel {
249	push @destroy, $_[0];	245	push @destroy, $_[0];
250	$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];
		265	}
		266
		267	=item $oldprio = $process->prio($newprio)
		268
		269	Sets (or gets, if the argument is missing) the priority of the
		270	process. Higher priority processes get run before lower priority
		271	processes. Priorities are small signed integers (currently -4 .. +3),
		272	that you can refer to using PRIO_xxx constants (use the import tag :prio
		273	to get then):
		274
		275	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		276	3 > 1 > 0 > -1 > -3 > -4
		277
		278	# set priority to HIGH
		279	current->prio(PRIO_HIGH);
		280
		281	The idle coroutine ($Coro::idle) always has a lower priority than any
		282	existing coroutine.
		283
		284	Changing the priority of the current process will take effect immediately,
		285	but changing the priority of processes in the ready queue (but not
		286	running) will only take effect after the next schedule (of that
		287	process). This is a bug that will be fixed in some future version.
		288
		289	=cut
		290
		291	sub prio {
		292	my $old = $_[0]{prio};
		293	$_[0]{prio} = $_[1] if @_ > 1;
		294	$old;
		295	}
		296
		297	=item $newprio = $process->nice($change)
		298
		299	Similar to C<prio>, but subtract the given value from the priority (i.e.
		300	higher values mean lower priority, just as in unix).
		301
		302	=cut
		303
		304	sub nice {
		305	$_[0]{prio} -= $_[1];
		306	}
		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;
251	}	319	}
252		320
253	=back	321	=back
254		322
255	=cut	323	=cut
256		324
257	1;	325	1;
258		326
259	=head1 BUGS/LIMITATIONS	327	=head1 BUGS/LIMITATIONS
260		328
261	- could be faster, especially when the core would introduce special	329	- you must make very sure that no coro is still active on global
262	support for coroutines (like it does for threads).	330	destruction. very bad things might happen otherwise (usually segfaults).
263	- there is still a memleak on coroutine termination that I could not	331
264	identify. Could be as small as a single SV.
265	- this module is not well-tested.
266	- if variables or arguments "disappear" (become undef) or become
267	corrupted please contact the author so he cen iron out the
268	remaining bugs.
269	- 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
270	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
271	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).
272		336
273	=head1 SEE ALSO	337	=head1 SEE ALSO
274		338
275	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>,
276	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>,
277	L<Coro::Handle>, L<Coro::Socket>.	341	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
278		342
279	=head1 AUTHOR	343	=head1 AUTHOR
280		344
281	Marc Lehmann <pcg@goof.com>	345	Marc Lehmann <pcg@goof.com>
282	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.29 by root, Sat Aug 11 00:37:31 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.29 by root, Sat Aug 11 00:37:31 2001 UTC vs.
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC