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

Comparing Coro/Coro.pm (file contents):
Revision 1.28 by root, Fri Aug 10 21:03:40 2001 UTC vs.
Revision 1.53 by root, Tue May 27 01:15:26 2003 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	no warnings qw(uninitialized);
		36
37	use Coro::State;	37	use Coro::State;
38		38
39	use base Exporter;	39	use base Exporter;
40		40
41	$VERSION = 0.13;	41	$VERSION = 0.7;
42		42
43	@EXPORT = qw(async cede schedule terminate current);	43	@EXPORT = qw(async cede schedule terminate current);
44	@EXPORT_OK = qw($current);	44	%EXPORT_TAGS = (
		45	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
		46	);
		47	@EXPORT_OK = @{$EXPORT_TAGS{prio}};
45		48
46	{	49	{
47	my @async;	50	my @async;
48	my $init;	51	my $init;
49		52
…		…
72	};	75	};
73	}	76	}
74		77
75	}	78	}
76		79
		80	=over 4
		81
77	=item $main	82	=item $main
78		83
79	This coroutine represents the main program.	84	This coroutine represents the main program.
80		85
81	=cut	86	=cut
…		…
111	};	116	};
112		117
113	# this coroutine is necessary because a coroutine	118	# this coroutine is necessary because a coroutine
114	# cannot destroy itself.	119	# cannot destroy itself.
115	my @destroy;	120	my @destroy;
		121	my $manager;
116	my $manager = new Coro sub {	122	$manager = new Coro sub {
117	while() {	123	while() {
118	delete ((pop @destroy)->{_coro_state}) while @destroy;	124	# by overwriting the state object with the manager we destroy it
		125	# while still being able to schedule this coroutine (in case it has
		126	# been readied multiple times. this is harmless since the manager
		127	# can be called as many times as neccessary and will always
		128	# remove itself from the runqueue
		129	while (@destroy) {
		130	my $coro = pop @destroy;
		131	$coro->{status} \|\|= [];
		132	$_->ready for @{delete $coro->{join} \|\| []};
		133	$coro->{_coro_state} = $manager->{_coro_state};
		134	}
119	&schedule;	135	&schedule;
120	}	136	}
121	};	137	};
122		138
123	# we really need priorities...
124	my @ready; # the ready queue. hehe, rather broken ;)
125
126	# static methods. not really.	139	# static methods. not really.
		140
		141	=back
127		142
128	=head2 STATIC METHODS	143	=head2 STATIC METHODS
129		144
130	Static methods are actually functions that operate on the current process only.	145	Static methods are actually functions that operate on the current process only.
131		146
…		…
160	into the ready queue, so calling this function usually means you will	175	into the ready queue, so calling this function usually means you will
161	never be called again.	176	never be called again.
162		177
163	=cut	178	=cut
164		179
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	180	=item cede
174		181
175	"Cede" to other processes. This function puts the current process into the	182	"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	183	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.	184	current "timeslice" to other coroutines of the same or higher priority.
178		185
179	=cut	186	=cut
180		187
181	sub cede {
182	$current->ready;
183	&schedule;
184	}
185
186	=item terminate	188	=item terminate [arg...]
187		189
188	Terminates the current process.	190	Terminates the current process.
189		191
190	Future versions of this function will allow result arguments.	192	Future versions of this function will allow result arguments.
191		193
192	=cut	194	=cut
193		195
194	sub terminate {	196	sub terminate {
		197	$current->{status} = [@_];
195	$current->cancel;	198	$current->cancel;
196	&schedule;	199	&schedule;
197	die; # NORETURN	200	die; # NORETURN
198	}	201	}
199		202
…		…
208	=over 4	211	=over 4
209		212
210	=item new Coro \&sub [, @args...]	213	=item new Coro \&sub [, @args...]
211		214
212	Create a new process and return it. When the sub returns the process	215	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	216	automatically terminates as if C<terminate> with the returned values were
		217	called. To make the process run you must first put it into the ready queue
214	the ready queue by calling the ready method.	218	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		219
219	=cut	220	=cut
220		221
221	sub _newcoro {	222	sub _newcoro {
222	terminate &{+shift};	223	terminate &{+shift};
…		…
229	}, $class;	230	}, $class;
230	}	231	}
231		232
232	=item $process->ready	233	=item $process->ready
233		234
234	Put the current process into the ready queue.	235	Put the given process into the ready queue.
235		236
236	=cut	237	=cut
237
238	sub ready {
239	push @ready, $_[0];
240	}
241		238
242	=item $process->cancel	239	=item $process->cancel
243		240
244	Like C<terminate>, but terminates the specified process instead.	241	Like C<terminate>, but terminates the specified process instead.
245		242
246	=cut	243	=cut
247		244
248	sub cancel {	245	sub cancel {
249	push @destroy, $_[0];	246	push @destroy, $_[0];
250	$manager->ready;	247	$manager->ready;
		248	&schedule if $current == $_[0];
		249	}
		250
		251	=item $process->join
		252
		253	Wait until the coroutine terminates and return any values given to the
		254	C<terminate> function. C<join> can be called multiple times from multiple
		255	processes.
		256
		257	=cut
		258
		259	sub join {
		260	my $self = shift;
		261	unless ($self->{status}) {
		262	push @{$self->{join}}, $current;
		263	&schedule;
		264	}
		265	wantarray ? @{$self->{status}} : $self->{status}[0];
		266	}
		267
		268	=item $oldprio = $process->prio($newprio)
		269
		270	Sets (or gets, if the argument is missing) the priority of the
		271	process. Higher priority processes get run before lower priority
		272	processes. Priorities are small signed integers (currently -4 .. +3),
		273	that you can refer to using PRIO_xxx constants (use the import tag :prio
		274	to get then):
		275
		276	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		277	3 > 1 > 0 > -1 > -3 > -4
		278
		279	# set priority to HIGH
		280	current->prio(PRIO_HIGH);
		281
		282	The idle coroutine ($Coro::idle) always has a lower priority than any
		283	existing coroutine.
		284
		285	Changing the priority of the current process will take effect immediately,
		286	but changing the priority of processes in the ready queue (but not
		287	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.
		289
		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)
		299
		300	Similar to C<prio>, but subtract the given value from the priority (i.e.
		301	higher values mean lower priority, just as in unix).
		302
		303	=cut
		304
		305	sub nice {
		306	$_[0]{prio} -= $_[1];
		307	}
		308
		309	=item $olddesc = $process->desc($newdesc)
		310
		311	Sets (or gets in case the argument is missing) the description for this
		312	process. This is just a free-form string you can associate with a process.
		313
		314	=cut
		315
		316	sub desc {
		317	my $old = $_[0]{desc};
		318	$_[0]{desc} = $_[1] if @_ > 1;
		319	$old;
251	}	320	}
252		321
253	=back	322	=back
254		323
255	=cut	324	=cut
256		325
257	1;	326	1;
258		327
259	=head1 BUGS/LIMITATIONS	328	=head1 BUGS/LIMITATIONS
260		329
261	- could be faster, especially when the core would introduce special	330	- you must make very sure that no coro is still active on global
262	support for coroutines (like it does for threads).	331	destruction. very bad things might happen otherwise (usually segfaults).
263	- there is still a memleak on coroutine termination that I could not	332
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	333	- 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	334	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).	335	to allow per-thread schedulers, but Coro::State does not yet allow
		336	this).
272		337
273	=head1 SEE ALSO	338	=head1 SEE ALSO
274		339
275	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	340	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>,	341	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.28 by root, Fri Aug 10 21:03:40 2001 UTC vs. Revision 1.53 by root, Tue May 27 01:15:26 2003 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.28 by root, Fri Aug 10 21:03:40 2001 UTC vs.
Revision 1.53 by root, Tue May 27 01:15:26 2003 UTC