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

Comparing Coro/Coro.pm (file contents):
Revision 1.21 by root, Sun Jul 22 03:24:10 2001 UTC vs.
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC

…		…
14		14
15	sub some_func : Coro {	15	sub some_func : Coro {
16	# some more async code	16	# some more async code
17	}	17	}
18		18
19	yield;	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), that is, a coroutine has it's own callchain, it's	27	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30	own set of lexicals and it's own set of perl's most important global	28	callchain, it's own set of lexicals and it's own set of perl's most
31	variables.	29	important global variables.
32
33	WARNING: When using this module, make sure that, at program end, no
34	coroutines are still running OR just call exit before falling off the
35	end. The reason for this is that some coroutine of yours might have called
36	into a C function, and falling off the end of main:: results in returning
37	to that C function instead if to the main C interpreter.
38		30
39	=cut	31	=cut
40		32
41	package Coro;	33	package Coro;
42		34
		35	BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }
		36
43	use Coro::State;	37	use Coro::State;
44		38
		39	use vars qw($idle $main $current);
		40
45	use base Exporter;	41	use base Exporter;
46		42
47	$VERSION = 0.10;	43	$VERSION = 0.95;
48		44
49	@EXPORT = qw(async yield schedule terminate current);	45	@EXPORT = qw(async cede schedule terminate current);
50	@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}};
51		50
52	{	51	{
53	my @async;	52	my @async;
		53	my $init;
54		54
55	# this way of handling attributes simply is NOT scalable ;()	55	# this way of handling attributes simply is NOT scalable ;()
56	sub import {	56	sub import {
57	Coro->export_to_level(1, @_);	57	Coro->export_to_level(1, @_);
58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
…		…
60	my ($package, $ref) = (shift, shift);	60	my ($package, $ref) = (shift, shift);
61	my @attrs;	61	my @attrs;
62	for (@_) {	62	for (@_) {
63	if ($_ eq "Coro") {	63	if ($_ eq "Coro") {
64	push @async, $ref;	64	push @async, $ref;
		65	unless ($init++) {
		66	eval q{
		67	sub INIT {
		68	&async(pop @async) while @async;
		69	}
		70	};
		71	}
65	} else {	72	} else {
66	push @attrs, $_;	73	push @attrs, $_;
67	}	74	}
68	}	75	}
69	return $old ? $old->($package, $ref, @attrs) : @attrs;	76	return $old ? $old->($package, $ref, @attrs) : @attrs;
70	};	77	};
71	}	78	}
72		79
73	sub INIT {
74	&async(pop @async) while @async;
75	}
76	}	80	}
		81
		82	=over 4
77		83
78	=item $main	84	=item $main
79		85
80	This coroutine represents the main program.	86	This coroutine represents the main program.
81		87
82	=cut	88	=cut
83		89
84	our $main = new Coro;	90	$main = new Coro;
85		91
86	=item $current (or as function: current)	92	=item $current (or as function: current)
87		93
88	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).
89		95
…		…
92	# maybe some other module used Coro::Specific before...	98	# maybe some other module used Coro::Specific before...
93	if ($current) {	99	if ($current) {
94	$main->{specific} = $current->{specific};	100	$main->{specific} = $current->{specific};
95	}	101	}
96		102
97	our $current = $main;	103	$current = $main;
98		104
99	sub current() { $current }	105	sub current() { $current }
100		106
101	=item $idle	107	=item $idle
102		108
…		…
104	implementation prints "FATAL: deadlock detected" and exits.	110	implementation prints "FATAL: deadlock detected" and exits.
105		111
106	=cut	112	=cut
107		113
108	# should be done using priorities :(	114	# should be done using priorities :(
109	our $idle = new Coro sub {	115	$idle = new Coro sub {
110	print STDERR "FATAL: deadlock detected\n";	116	print STDERR "FATAL: deadlock detected\n";
111	exit(51);	117	exit(51);
112	};	118	};
113		119
114	# we really need priorities...	120	# this coroutine is necessary because a coroutine
115	my @ready; # the ready queue. hehe, rather broken ;)	121	# cannot destroy itself.
		122	my @destroy;
		123	my $manager;
		124	$manager = new Coro sub {
		125	while () {
		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	}
		137	&schedule;
		138	}
		139	};
116		140
117	# static methods. not really.	141	# static methods. not really.
		142
		143	=back
118		144
119	=head2 STATIC METHODS	145	=head2 STATIC METHODS
120		146
121	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.
122		148
…		…
131	# create a new coroutine that just prints its arguments	157	# create a new coroutine that just prints its arguments
132	async {	158	async {
133	print "@_\n";	159	print "@_\n";
134	} 1,2,3,4;	160	} 1,2,3,4;
135		161
136	The coderef you submit MUST NOT be a closure that refers to variables
137	in an outer scope. This does NOT work. Pass arguments into it instead.
138
139	=cut	162	=cut
140		163
141	sub async(&@) {	164	sub async(&@) {
142	my $pid = new Coro @_;	165	my $pid = new Coro @_;
		166	$manager->ready; # this ensures that the stack is cloned from the manager
143	$pid->ready;	167	$pid->ready;
144	$pid;	168	$pid;
145	}	169	}
146		170
147	=item schedule	171	=item schedule
…		…
150	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
151	never be called again.	175	never be called again.
152		176
153	=cut	177	=cut
154		178
155	my $prev;
156
157	sub schedule {
158	# should be done using priorities :(
159	($prev, $current) = ($current, shift @ready \|\| $idle);
160	Coro::State::transfer($prev, $current);
161	}
162
163	=item yield	179	=item cede
164		180
165	Yield to other processes. This function puts the current process into the	181	"Cede" to other processes. This function puts the current process into the
166	ready queue and calls C<schedule>.	182	ready queue and calls C<schedule>, which has the effect of giving up the
		183	current "timeslice" to other coroutines of the same or higher priority.
167		184
168	=cut	185	=cut
169		186
170	sub yield {	187	=item terminate [arg...]
		188
		189	Terminates the current process.
		190
		191	Future versions of this function will allow result arguments.
		192
		193	=cut
		194
		195	sub terminate {
		196	$current->{status} = [@_];
171	$current->ready;	197	$current->cancel;
172	&schedule;	198	&schedule;
173	}	199	die; # NORETURN
174
175	=item terminate
176
177	Terminates the current process.
178
179	Future versions of this function will allow result arguments.
180
181	=cut
182
183	sub terminate {
184	$current->{_results} = [@_];
185	delete $current->{_coro_state};
186	&schedule;
187	}	200	}
188		201
189	=back	202	=back
190		203
191	# dynamic methods	204	# dynamic methods
…		…
197	=over 4	210	=over 4
198		211
199	=item new Coro \&sub [, @args...]	212	=item new Coro \&sub [, @args...]
200		213
201	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
202	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
203	the ready queue by calling the ready method.	217	by calling the ready method.
204
205	The coderef you submit MUST NOT be a closure that refers to variables
206	in an outer scope. This does NOT work. Pass arguments into it instead.
207		218
208	=cut	219	=cut
209		220
210	sub _newcoro {	221	sub _newcoro {
211	terminate &{+shift};	222	terminate &{+shift};
…		…
218	}, $class;	229	}, $class;
219	}	230	}
220		231
221	=item $process->ready	232	=item $process->ready
222		233
223	Put the current process into the ready queue.	234	Put the given process into the ready queue.
224		235
225	=cut	236	=cut
226		237
227	sub ready {	238	=item $process->cancel
		239
		240	Like C<terminate>, but terminates the specified process instead.
		241
		242	=cut
		243
		244	sub cancel {
228	push @ready, $_[0];	245	push @destroy, $_[0];
		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;
229	}	319	}
230		320
231	=back	321	=back
232		322
233	=cut	323	=cut
234		324
235	1;	325	1;
236		326
237	=head1 BUGS/LIMITATIONS	327	=head1 BUGS/LIMITATIONS
238		328
239	- could be faster, especially when the core would introduce special	329	- you must make very sure that no coro is still active on global
240	support for coroutines (like it does for threads).	330	destruction. very bad things might happen otherwise (usually segfaults).
241	- there is still a memleak on coroutine termination that I could not	331
242	identify. Could be as small as a single SV.
243	- this module is not well-tested.
244	- if variables or arguments "disappear" (become undef) or become
245	corrupted please contact the author so he cen iron out the
246	remaining bugs.
247	- 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
248	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
249	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).
250		336
251	=head1 SEE ALSO	337	=head1 SEE ALSO
252		338
253	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>,
254	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.	340	L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
		341	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
255		342
256	=head1 AUTHOR	343	=head1 AUTHOR
257		344
258	Marc Lehmann <pcg@goof.com>	345	Marc Lehmann <pcg@goof.com>
259	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.21 by root, Sun Jul 22 03:24:10 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.21 by root, Sun Jul 22 03:24:10 2001 UTC vs.
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC