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

Comparing Coro/Coro.pm (file contents):
Revision 1.24 by root, Wed Jul 25 04:14:37 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.12;	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;
		51	my $init;
48		52
49	# this way of handling attributes simply is NOT scalable ;()	53	# this way of handling attributes simply is NOT scalable ;()
50	sub import {	54	sub import {
51	Coro->export_to_level(1, @_);	55	Coro->export_to_level(1, @_);
52	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	56	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
…		…
54	my ($package, $ref) = (shift, shift);	58	my ($package, $ref) = (shift, shift);
55	my @attrs;	59	my @attrs;
56	for (@_) {	60	for (@_) {
57	if ($_ eq "Coro") {	61	if ($_ eq "Coro") {
58	push @async, $ref;	62	push @async, $ref;
		63	unless ($init++) {
		64	eval q{
		65	sub INIT {
		66	&async(pop @async) while @async;
		67	}
		68	};
		69	}
59	} else {	70	} else {
60	push @attrs, $_;	71	push @attrs, $_;
61	}	72	}
62	}	73	}
63	return $old ? $old->($package, $ref, @attrs) : @attrs;	74	return $old ? $old->($package, $ref, @attrs) : @attrs;
64	};	75	};
65	}	76	}
66		77
67	sub INIT {
68	&async(pop @async) while @async;
69	}
70	}	78	}
		79
		80	=over 4
71		81
72	=item $main	82	=item $main
73		83
74	This coroutine represents the main program.	84	This coroutine represents the main program.
75		85
…		…
106	};	116	};
107		117
108	# this coroutine is necessary because a coroutine	118	# this coroutine is necessary because a coroutine
109	# cannot destroy itself.	119	# cannot destroy itself.
110	my @destroy;	120	my @destroy;
		121	my $manager;
111	my $manager = new Coro sub {	122	$manager = new Coro sub {
112	while() {	123	while() {
113	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	}
114	&schedule;	135	&schedule;
115	}	136	}
116	};	137	};
117		138
118	# we really need priorities...
119	my @ready; # the ready queue. hehe, rather broken ;)
120
121	# static methods. not really.	139	# static methods. not really.
		140
		141	=back
122		142
123	=head2 STATIC METHODS	143	=head2 STATIC METHODS
124		144
125	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.
126		146
…		…
155	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
156	never be called again.	176	never be called again.
157		177
158	=cut	178	=cut
159		179
160	my $prev;
161
162	sub schedule {
163	# should be done using priorities :(
164	($prev, $current) = ($current, shift @ready \|\| $idle);
165	Coro::State::transfer($prev, $current);
166	}
167
168	=item cede	180	=item cede
169		181
170	"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
171	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
172	current "timeslice" to other coroutines of the same or higher priority.	184	current "timeslice" to other coroutines of the same or higher priority.
173		185
174	=cut	186	=cut
175		187
176	sub cede {	188	=item terminate [arg...]
		189
		190	Terminates the current process.
		191
		192	Future versions of this function will allow result arguments.
		193
		194	=cut
		195
		196	sub terminate {
		197	$current->{status} = [@_];
177	$current->ready;	198	$current->cancel;
178	&schedule;	199	&schedule;
179	}
180
181	=item terminate
182
183	Terminates the current process.
184
185	Future versions of this function will allow result arguments.
186
187	=cut
188
189	sub terminate {
190	push @destroy, $current;
191	$manager->ready;
192	&schedule;
193	# NORETURN	200	die; # NORETURN
194	}	201	}
195		202
196	=back	203	=back
197		204
198	# dynamic methods	205	# dynamic methods
…		…
204	=over 4	211	=over 4
205		212
206	=item new Coro \&sub [, @args...]	213	=item new Coro \&sub [, @args...]
207		214
208	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
209	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
210	the ready queue by calling the ready method.	218	by calling the ready method.
211
212	The coderef you submit MUST NOT be a closure that refers to variables
213	in an outer scope. This does NOT work. Pass arguments into it instead.
214		219
215	=cut	220	=cut
216		221
217	sub _newcoro {	222	sub _newcoro {
218	terminate &{+shift};	223	terminate &{+shift};
…		…
225	}, $class;	230	}, $class;
226	}	231	}
227		232
228	=item $process->ready	233	=item $process->ready
229		234
230	Put the current process into the ready queue.	235	Put the given process into the ready queue.
231		236
232	=cut	237	=cut
233		238
234	sub ready {	239	=item $process->cancel
		240
		241	Like C<terminate>, but terminates the specified process instead.
		242
		243	=cut
		244
		245	sub cancel {
235	push @ready, $_[0];	246	push @destroy, $_[0];
		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;
236	}	320	}
237		321
238	=back	322	=back
239		323
240	=cut	324	=cut
241		325
242	1;	326	1;
243		327
244	=head1 BUGS/LIMITATIONS	328	=head1 BUGS/LIMITATIONS
245		329
246	- could be faster, especially when the core would introduce special	330	- you must make very sure that no coro is still active on global
247	support for coroutines (like it does for threads).	331	destruction. very bad things might happen otherwise (usually segfaults).
248	- there is still a memleak on coroutine termination that I could not	332
249	identify. Could be as small as a single SV.
250	- this module is not well-tested.
251	- if variables or arguments "disappear" (become undef) or become
252	corrupted please contact the author so he cen iron out the
253	remaining bugs.
254	- 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
255	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
256	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).
257		337
258	=head1 SEE ALSO	338	=head1 SEE ALSO
259		339
260	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>,
261	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.	341	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
		342	L<Coro::Handle>, L<Coro::Socket>.
262		343
263	=head1 AUTHOR	344	=head1 AUTHOR
264		345
265	Marc Lehmann <pcg@goof.com>	346	Marc Lehmann <pcg@goof.com>
266	http://www.goof.com/pcg/marc/	347	http://www.goof.com/pcg/marc/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.24 by root, Wed Jul 25 04:14:37 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.24 by root, Wed Jul 25 04:14:37 2001 UTC vs.
Revision 1.53 by root, Tue May 27 01:15:26 2003 UTC