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

Comparing Coro/Coro.pm (file contents):
Revision 1.22 by root, Mon Jul 23 02:14:19 2001 UTC vs.
Revision 1.57 by pcg, Sun Nov 30 22:49:25 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), 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
39	WARNING: Unless you really know what you are doing, do NOT do context
40	switches inside callbacks from the XS level. The reason for this is
41	similar to the reason above: A callback calls a perl function, this
42	perl function does a context switch, some other callback is called, the
43	original function returns from it - to what? To the wrong XS function,
44	with totally different return values. Unfortunately, this includes
45	callbacks done by perl itself (tie'd variables!).
46
47	The only workaround for this is to do coroutines on C level.
48		30
49	=cut	31	=cut
50		32
51	package Coro;	33	package Coro;
52		34
		35	BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }
		36
53	use Coro::State;	37	use Coro::State;
54		38
		39	use vars qw($idle $main $current);
		40
55	use base Exporter;	41	use base Exporter;
56		42
57	$VERSION = 0.10;	43	$VERSION = "0.9";
58		44
59	@EXPORT = qw(async cede schedule terminate current);	45	@EXPORT = qw(async cede schedule terminate current);
60	@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}};
61		50
62	{	51	{
63	my @async;	52	my @async;
		53	my $init;
64		54
65	# this way of handling attributes simply is NOT scalable ;()	55	# this way of handling attributes simply is NOT scalable ;()
66	sub import {	56	sub import {
67	Coro->export_to_level(1, @_);	57	Coro->export_to_level(1, @_);
68	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
…		…
70	my ($package, $ref) = (shift, shift);	60	my ($package, $ref) = (shift, shift);
71	my @attrs;	61	my @attrs;
72	for (@_) {	62	for (@_) {
73	if ($_ eq "Coro") {	63	if ($_ eq "Coro") {
74	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	}
75	} else {	72	} else {
76	push @attrs, $_;	73	push @attrs, $_;
77	}	74	}
78	}	75	}
79	return $old ? $old->($package, $ref, @attrs) : @attrs;	76	return $old ? $old->($package, $ref, @attrs) : @attrs;
80	};	77	};
81	}	78	}
82		79
83	sub INIT {
84	&async(pop @async) while @async;
85	}
86	}	80	}
		81
		82	=over 4
87		83
88	=item $main	84	=item $main
89		85
90	This coroutine represents the main program.	86	This coroutine represents the main program.
91		87
92	=cut	88	=cut
93		89
94	our $main = new Coro;	90	$main = new Coro;
95		91
96	=item $current (or as function: current)	92	=item $current (or as function: current)
97		93
98	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).
99		95
…		…
102	# maybe some other module used Coro::Specific before...	98	# maybe some other module used Coro::Specific before...
103	if ($current) {	99	if ($current) {
104	$main->{specific} = $current->{specific};	100	$main->{specific} = $current->{specific};
105	}	101	}
106		102
107	our $current = $main;	103	$current = $main;
108		104
109	sub current() { $current }	105	sub current() { $current }
110		106
111	=item $idle	107	=item $idle
112		108
…		…
114	implementation prints "FATAL: deadlock detected" and exits.	110	implementation prints "FATAL: deadlock detected" and exits.
115		111
116	=cut	112	=cut
117		113
118	# should be done using priorities :(	114	# should be done using priorities :(
119	our $idle = new Coro sub {	115	$idle = new Coro sub {
120	print STDERR "FATAL: deadlock detected\n";	116	print STDERR "FATAL: deadlock detected\n";
121	exit(51);	117	exit(51);
122	};	118	};
123		119
124	# we really need priorities...	120	# this coroutine is necessary because a coroutine
125	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	};
126		140
127	# static methods. not really.	141	# static methods. not really.
		142
		143	=back
128		144
129	=head2 STATIC METHODS	145	=head2 STATIC METHODS
130		146
131	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.
132		148
…		…
141	# create a new coroutine that just prints its arguments	157	# create a new coroutine that just prints its arguments
142	async {	158	async {
143	print "@_\n";	159	print "@_\n";
144	} 1,2,3,4;	160	} 1,2,3,4;
145		161
146	The coderef you submit MUST NOT be a closure that refers to variables
147	in an outer scope. This does NOT work. Pass arguments into it instead.
148
149	=cut	162	=cut
150		163
151	sub async(&@) {	164	sub async(&@) {
152	my $pid = new Coro @_;	165	my $pid = new Coro @_;
		166	$manager->ready; # this ensures that the stack is cloned from the manager
153	$pid->ready;	167	$pid->ready;
154	$pid;	168	$pid;
155	}	169	}
156		170
157	=item schedule	171	=item schedule
…		…
160	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
161	never be called again.	175	never be called again.
162		176
163	=cut	177	=cut
164		178
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	179	=item cede
174		180
175	"Cede" to other processes. This function puts the current process into the	181	"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	182	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.	183	current "timeslice" to other coroutines of the same or higher priority.
178		184
179	=cut	185	=cut
180		186
181	sub cede {	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} = [@_];
182	$current->ready;	197	$current->cancel;
183	&schedule;	198	&schedule;
184	}	199	die; # NORETURN
185
186	=item terminate
187
188	Terminates the current process.
189
190	Future versions of this function will allow result arguments.
191
192	=cut
193
194	sub terminate {
195	my $self = $current;
196	$self->{_results} = [@_];
197	$current = shift @ready \|\| $idle;
198	Coro::State::transfer(delete $self->{_coro_state}, $current);
199	# cannot return
200	die;
201	}	200	}
202		201
203	=back	202	=back
204		203
205	# dynamic methods	204	# dynamic methods
…		…
211	=over 4	210	=over 4
212		211
213	=item new Coro \&sub [, @args...]	212	=item new Coro \&sub [, @args...]
214		213
215	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
216	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
217	the ready queue by calling the ready method.	217	by calling the ready method.
218
219	The coderef you submit MUST NOT be a closure that refers to variables
220	in an outer scope. This does NOT work. Pass arguments into it instead.
221		218
222	=cut	219	=cut
223		220
224	sub _newcoro {	221	sub _newcoro {
225	terminate &{+shift};	222	terminate &{+shift};
…		…
232	}, $class;	229	}, $class;
233	}	230	}
234		231
235	=item $process->ready	232	=item $process->ready
236		233
237	Put the current process into the ready queue.	234	Put the given process into the ready queue.
238		235
239	=cut	236	=cut
240		237
241	sub ready {	238	=item $process->cancel
		239
		240	Like C<terminate>, but terminates the specified process instead.
		241
		242	=cut
		243
		244	sub cancel {
242	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;
243	}	319	}
244		320
245	=back	321	=back
246		322
247	=cut	323	=cut
248		324
249	1;	325	1;
250		326
251	=head1 BUGS/LIMITATIONS	327	=head1 BUGS/LIMITATIONS
252		328
253	- could be faster, especially when the core would introduce special	329	- you must make very sure that no coro is still active on global
254	support for coroutines (like it does for threads).	330	destruction. very bad things might happen otherwise (usually segfaults).
255	- there is still a memleak on coroutine termination that I could not	331
256	identify. Could be as small as a single SV.
257	- this module is not well-tested.
258	- if variables or arguments "disappear" (become undef) or become
259	corrupted please contact the author so he cen iron out the
260	remaining bugs.
261	- 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
262	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
263	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).
264		336
265	=head1 SEE ALSO	337	=head1 SEE ALSO
266		338
267	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>,
268	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>.
269		342
270	=head1 AUTHOR	343	=head1 AUTHOR
271		344
272	Marc Lehmann <pcg@goof.com>	345	Marc Lehmann <pcg@goof.com>
273	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.22 by root, Mon Jul 23 02:14:19 2001 UTC vs. Revision 1.57 by pcg, Sun Nov 30 22:49:25 2003 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.22 by root, Mon Jul 23 02:14:19 2001 UTC vs.
Revision 1.57 by pcg, Sun Nov 30 22:49:25 2003 UTC