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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.30 by root, Sat Aug 11 19:59:19 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	# static methods. not really.	141	# static methods. not really.
		142
		143	=back
124		144
125	=head2 STATIC METHODS	145	=head2 STATIC METHODS
126		146
127	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.
128		148
…		…
136		156
137	# create a new coroutine that just prints its arguments	157	# create a new coroutine that just prints its arguments
138	async {	158	async {
139	print "@_\n";	159	print "@_\n";
140	} 1,2,3,4;	160	} 1,2,3,4;
141
142	The coderef you submit MUST NOT be a closure that refers to variables
143	in an outer scope. This does NOT work. Pass arguments into it instead.
144		161
145	=cut	162	=cut
146		163
147	sub async(&@) {	164	sub async(&@) {
148	my $pid = new Coro @_;	165	my $pid = new Coro @_;
…		…
165	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
166	current "timeslice" to other coroutines of the same or higher priority.	183	current "timeslice" to other coroutines of the same or higher priority.
167		184
168	=cut	185	=cut
169		186
170	=item terminate	187	=item terminate [arg...]
171		188
172	Terminates the current process.	189	Terminates the current process.
173		190
174	Future versions of this function will allow result arguments.	191	Future versions of this function will allow result arguments.
175		192
176	=cut	193	=cut
177		194
178	sub terminate {	195	sub terminate {
		196	$current->{status} = [@_];
179	$current->cancel;	197	$current->cancel;
180	&schedule;	198	&schedule;
181	die; # NORETURN	199	die; # NORETURN
182	}	200	}
183		201
…		…
192	=over 4	210	=over 4
193		211
194	=item new Coro \&sub [, @args...]	212	=item new Coro \&sub [, @args...]
195		213
196	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
197	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
198	the ready queue by calling the ready method.	217	by calling the ready method.
199
200	The coderef you submit MUST NOT be a closure that refers to variables
201	in an outer scope. This does NOT work. Pass arguments into it instead.
202		218
203	=cut	219	=cut
204		220
205	sub _newcoro {	221	sub _newcoro {
206	terminate &{+shift};	222	terminate &{+shift};
…		…
213	}, $class;	229	}, $class;
214	}	230	}
215		231
216	=item $process->ready	232	=item $process->ready
217		233
218	Put the current process into the ready queue.	234	Put the given process into the ready queue.
219		235
220	=cut	236	=cut
221		237
222	=item $process->cancel	238	=item $process->cancel
223		239
…		…
226	=cut	242	=cut
227		243
228	sub cancel {	244	sub cancel {
229	push @destroy, $_[0];	245	push @destroy, $_[0];
230	$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;
231	}	319	}
232		320
233	=back	321	=back
234		322
235	=cut	323	=cut
236		324
237	1;	325	1;
238		326
239	=head1 BUGS/LIMITATIONS	327	=head1 BUGS/LIMITATIONS
240		328
241	- could be faster, especially when the core would introduce special	329	- you must make very sure that no coro is still active on global
242	support for coroutines (like it does for threads).	330	destruction. very bad things might happen otherwise (usually segfaults).
243	- there is still a memleak on coroutine termination that I could not	331
244	identify. Could be as small as a single SV.
245	- this module is not well-tested.
246	- if variables or arguments "disappear" (become undef) or become
247	corrupted please contact the author so he cen iron out the
248	remaining bugs.
249	- 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
250	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
251	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).
252		336
253	=head1 SEE ALSO	337	=head1 SEE ALSO
254		338
255	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>,
256	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>,
257	L<Coro::Handle>, L<Coro::Socket>.	341	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
258		342
259	=head1 AUTHOR	343	=head1 AUTHOR
260		344
261	Marc Lehmann <pcg@goof.com>	345	Marc Lehmann <pcg@goof.com>
262	http://www.goof.com/pcg/marc/	346	http://www.goof.com/pcg/marc/

Diff Legend

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

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

Diff Legend

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