[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.55 by pcg, Wed Nov 5 20:02:44 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	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.8;
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
…		…
160	into the ready queue, so calling this function usually means you will	177	into the ready queue, so calling this function usually means you will
161	never be called again.	178	never be called again.
162		179
163	=cut	180	=cut
164		181
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	182	=item cede
174		183
175	"Cede" to other processes. This function puts the current process into the	184	"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	185	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.	186	current "timeslice" to other coroutines of the same or higher priority.
178		187
179	=cut	188	=cut
180		189
181	sub cede {
182	$current->ready;
183	&schedule;
184	}
185
186	=item terminate	190	=item terminate [arg...]
187		191
188	Terminates the current process.	192	Terminates the current process.
189		193
190	Future versions of this function will allow result arguments.	194	Future versions of this function will allow result arguments.
191		195
192	=cut	196	=cut
193		197
194	sub terminate {	198	sub terminate {
		199	$current->{status} = [@_];
195	$current->cancel;	200	$current->cancel;
196	&schedule;	201	&schedule;
197	die; # NORETURN	202	die; # NORETURN
198	}	203	}
199		204
…		…
208	=over 4	213	=over 4
209		214
210	=item new Coro \&sub [, @args...]	215	=item new Coro \&sub [, @args...]
211		216
212	Create a new process and return it. When the sub returns the process	217	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	218	automatically terminates as if C<terminate> with the returned values were
		219	called. To make the process run you must first put it into the ready queue
214	the ready queue by calling the ready method.	220	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		221
219	=cut	222	=cut
220		223
221	sub _newcoro {	224	sub _newcoro {
222	terminate &{+shift};	225	terminate &{+shift};
…		…
229	}, $class;	232	}, $class;
230	}	233	}
231		234
232	=item $process->ready	235	=item $process->ready
233		236
234	Put the current process into the ready queue.	237	Put the given process into the ready queue.
235		238
236	=cut	239	=cut
237
238	sub ready {
239	push @ready, $_[0];
240	}
241		240
242	=item $process->cancel	241	=item $process->cancel
243		242
244	Like C<terminate>, but terminates the specified process instead.	243	Like C<terminate>, but terminates the specified process instead.
245		244
246	=cut	245	=cut
247		246
248	sub cancel {	247	sub cancel {
249	push @destroy, $_[0];	248	push @destroy, $_[0];
250	$manager->ready;	249	$manager->ready;
		250	&schedule if $current == $_[0];
		251	}
		252
		253	=item $process->join
		254
		255	Wait until the coroutine terminates and return any values given to the
		256	C<terminate> function. C<join> can be called multiple times from multiple
		257	processes.
		258
		259	=cut
		260
		261	sub join {
		262	my $self = shift;
		263	unless ($self->{status}) {
		264	push @{$self->{join}}, $current;
		265	&schedule;
		266	}
		267	wantarray ? @{$self->{status}} : $self->{status}[0];
		268	}
		269
		270	=item $oldprio = $process->prio($newprio)
		271
		272	Sets (or gets, if the argument is missing) the priority of the
		273	process. Higher priority processes get run before lower priority
		274	processes. Priorities are small signed integers (currently -4 .. +3),
		275	that you can refer to using PRIO_xxx constants (use the import tag :prio
		276	to get then):
		277
		278	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		279	3 > 1 > 0 > -1 > -3 > -4
		280
		281	# set priority to HIGH
		282	current->prio(PRIO_HIGH);
		283
		284	The idle coroutine ($Coro::idle) always has a lower priority than any
		285	existing coroutine.
		286
		287	Changing the priority of the current process will take effect immediately,
		288	but changing the priority of processes in the ready queue (but not
		289	running) will only take effect after the next schedule (of that
		290	process). This is a bug that will be fixed in some future version.
		291
		292	=cut
		293
		294	sub prio {
		295	my $old = $_[0]{prio};
		296	$_[0]{prio} = $_[1] if @_ > 1;
		297	$old;
		298	}
		299
		300	=item $newprio = $process->nice($change)
		301
		302	Similar to C<prio>, but subtract the given value from the priority (i.e.
		303	higher values mean lower priority, just as in unix).
		304
		305	=cut
		306
		307	sub nice {
		308	$_[0]{prio} -= $_[1];
		309	}
		310
		311	=item $olddesc = $process->desc($newdesc)
		312
		313	Sets (or gets in case the argument is missing) the description for this
		314	process. This is just a free-form string you can associate with a process.
		315
		316	=cut
		317
		318	sub desc {
		319	my $old = $_[0]{desc};
		320	$_[0]{desc} = $_[1] if @_ > 1;
		321	$old;
251	}	322	}
252		323
253	=back	324	=back
254		325
255	=cut	326	=cut
256		327
257	1;	328	1;
258		329
259	=head1 BUGS/LIMITATIONS	330	=head1 BUGS/LIMITATIONS
260		331
261	- could be faster, especially when the core would introduce special	332	- you must make very sure that no coro is still active on global
262	support for coroutines (like it does for threads).	333	destruction. very bad things might happen otherwise (usually segfaults).
263	- there is still a memleak on coroutine termination that I could not	334
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	335	- 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	336	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).	337	to allow per-thread schedulers, but Coro::State does not yet allow
		338	this).
272		339
273	=head1 SEE ALSO	340	=head1 SEE ALSO
274		341
275	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	342	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>,	343	L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
277	L<Coro::Handle>, L<Coro::Socket>.	344	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
278		345
279	=head1 AUTHOR	346	=head1 AUTHOR
280		347
281	Marc Lehmann <pcg@goof.com>	348	Marc Lehmann <pcg@goof.com>
282	http://www.goof.com/pcg/marc/	349	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.55 by pcg, Wed Nov 5 20:02:44 2003 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.55 by pcg, Wed Nov 5 20:02:44 2003 UTC