[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.84 by root, Sat Nov 25 00:40:26 2006 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	use strict;
		36	no warnings "uninitialized";
		37
37	use Coro::State;	38	use Coro::State;
38		39
39	use base Exporter;	40	use base qw(Coro::State Exporter);
40		41
		42	our $idle; # idle handler
		43	our $main; # main coroutine
		44	our $current; # current coroutine
		45
41	$VERSION = 0.45;	46	our $VERSION = '2.5';
42		47
43	@EXPORT = qw(async cede schedule terminate current);	48	our @EXPORT = qw(async cede schedule terminate current);
44	@EXPORT_OK = qw($current);	49	our %EXPORT_TAGS = (
		50	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
		51	);
		52	our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
45		53
46	{	54	{
47	my @async;	55	my @async;
48	my $init;	56	my $init;
49		57
50	# this way of handling attributes simply is NOT scalable ;()	58	# this way of handling attributes simply is NOT scalable ;()
51	sub import {	59	sub import {
		60	no strict 'refs';
		61
52	Coro->export_to_level(1, @_);	62	Coro->export_to_level(1, @_);
		63
53	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	64	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
54	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	65	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
55	my ($package, $ref) = (shift, shift);	66	my ($package, $ref) = (shift, shift);
56	my @attrs;	67	my @attrs;
57	for (@_) {	68	for (@_) {
…		…
72	};	83	};
73	}	84	}
74		85
75	}	86	}
76		87
		88	=over 4
		89
77	=item $main	90	=item $main
78		91
79	This coroutine represents the main program.	92	This coroutine represents the main program.
80		93
81	=cut	94	=cut
82		95
83	our $main = new Coro;	96	$main = new Coro;
84		97
85	=item $current (or as function: current)	98	=item $current (or as function: current)
86		99
87	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	100	The current coroutine (the last coroutine switched to). The initial value
		101	is C<$main> (of course).
		102
		103	This variable is B<strictly> I<read-only>. It is provided for performance
		104	reasons. If performance is not essentiel you are encouraged to use the
		105	C<Coro::current> function instead.
88		106
89	=cut	107	=cut
90		108
91	# maybe some other module used Coro::Specific before...	109	# maybe some other module used Coro::Specific before...
92	if ($current) {	110	if ($current) {
93	$main->{specific} = $current->{specific};	111	$main->{specific} = $current->{specific};
94	}	112	}
95		113
96	our $current = $main;	114	$current = $main;
97		115
98	sub current() { $current }	116	sub current() { $current }
99		117
100	=item $idle	118	=item $idle
101		119
102	The coroutine to switch to when no other coroutine is running. The default	120	A callback that is called whenever the scheduler finds no ready coroutines
103	implementation prints "FATAL: deadlock detected" and exits.	121	to run. The default implementation prints "FATAL: deadlock detected" and
		122	exits.
104		123
105	=cut	124	This hook is overwritten by modules such as C<Coro::Timer> and
		125	C<Coro::Event> to wait on an external event that hopefully wakes up some
		126	coroutine.
106		127
107	# should be done using priorities :(	128	=cut
108	our $idle = new Coro sub {	129
		130	$idle = sub {
109	print STDERR "FATAL: deadlock detected\n";	131	print STDERR "FATAL: deadlock detected\n";
110	exit(51);	132	exit (51);
111	};	133	};
112		134
113	# this coroutine is necessary because a coroutine	135	# this coroutine is necessary because a coroutine
114	# cannot destroy itself.	136	# cannot destroy itself.
115	my @destroy;	137	my @destroy;
		138	my $manager;
116	my $manager = new Coro sub {	139	$manager = new Coro sub {
117	while() {	140	while () {
118	delete ((pop @destroy)->{_coro_state}) while @destroy;	141	# by overwriting the state object with the manager we destroy it
		142	# while still being able to schedule this coroutine (in case it has
		143	# been readied multiple times. this is harmless since the manager
		144	# can be called as many times as neccessary and will always
		145	# remove itself from the runqueue
		146	while (@destroy) {
		147	my $coro = pop @destroy;
		148	$coro->{status} \|\|= [];
		149	$_->ready for @{delete $coro->{join} \|\| []};
		150
		151	# the next line destroys the coro state, but keeps the
		152	# process itself intact (we basically make it a zombie
		153	# process that always runs the manager thread, so it's possible
		154	# to transfer() to this process).
		155	$coro->_clone_state_from ($manager);
		156	}
119	&schedule;	157	&schedule;
120	}	158	}
121	};	159	};
122		160
123	# we really need priorities...
124	my @ready; # the ready queue. hehe, rather broken ;)
125
126	# static methods. not really.	161	# static methods. not really.
		162
		163	=back
127		164
128	=head2 STATIC METHODS	165	=head2 STATIC METHODS
129		166
130	Static methods are actually functions that operate on the current process only.	167	Static methods are actually functions that operate on the current process only.
131		168
…		…
134	=item async { ... } [@args...]	171	=item async { ... } [@args...]
135		172
136	Create a new asynchronous process and return it's process object	173	Create a new asynchronous process and return it's process object
137	(usually unused). When the sub returns the new process is automatically	174	(usually unused). When the sub returns the new process is automatically
138	terminated.	175	terminated.
		176
		177	When the coroutine dies, the program will exit, just as in the main
		178	program.
139		179
140	# create a new coroutine that just prints its arguments	180	# create a new coroutine that just prints its arguments
141	async {	181	async {
142	print "@_\n";	182	print "@_\n";
143	} 1,2,3,4;	183	} 1,2,3,4;
144
145	The coderef you submit MUST NOT be a closure that refers to variables
146	in an outer scope. This does NOT work. Pass arguments into it instead.
147		184
148	=cut	185	=cut
149		186
150	sub async(&@) {	187	sub async(&@) {
151	my $pid = new Coro @_;	188	my $pid = new Coro @_;
…		…
160	into the ready queue, so calling this function usually means you will	197	into the ready queue, so calling this function usually means you will
161	never be called again.	198	never be called again.
162		199
163	=cut	200	=cut
164		201
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	202	=item cede
174		203
175	"Cede" to other processes. This function puts the current process into the	204	"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	205	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.	206	current "timeslice" to other coroutines of the same or higher priority.
178		207
179	=cut	208	=cut
180		209
181	sub cede {
182	$current->ready;
183	&schedule;
184	}
185
186	=item terminate	210	=item terminate [arg...]
187		211
188	Terminates the current process.	212	Terminates the current process with the given status values (see L<cancel>).
189
190	Future versions of this function will allow result arguments.
191		213
192	=cut	214	=cut
193		215
194	sub terminate {	216	sub terminate {
195	$current->cancel;	217	$current->cancel (@_);
196	&schedule;
197	die; # NORETURN
198	}	218	}
199		219
200	=back	220	=back
201		221
202	# dynamic methods	222	# dynamic methods
…		…
208	=over 4	228	=over 4
209		229
210	=item new Coro \&sub [, @args...]	230	=item new Coro \&sub [, @args...]
211		231
212	Create a new process and return it. When the sub returns the process	232	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	233	automatically terminates as if C<terminate> with the returned values were
		234	called. To make the process run you must first put it into the ready queue
214	the ready queue by calling the ready method.	235	by calling the ready method.
215		236
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
219	=cut	237	=cut
220		238
221	sub _newcoro {	239	sub _new_coro {
		240	# $current->_clear_idle_sp; # set the idle sp on the following cede
		241	_set_cede_self; # ensures that cede cede's us first
		242	cede;
222	terminate &{+shift};	243	terminate &{+shift};
223	}	244	}
224		245
225	sub new {	246	sub new {
226	my $class = shift;	247	my $class = shift;
227	bless {	248
228	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	249	$class->SUPER::new (\&_new_coro, @_)
229	}, $class;
230	}	250	}
231		251
232	=item $process->ready	252	=item $process->ready
233		253
234	Put the current process into the ready queue.	254	Put the given process into the ready queue.
235		255
236	=cut	256	=cut
237		257
238	sub ready {
239	push @ready, $_[0];
240	}
241
242	=item $process->cancel	258	=item $process->cancel (arg...)
243		259
244	Like C<terminate>, but terminates the specified process instead.	260	Terminates the given process and makes it return the given arguments as
		261	status (default: the empty list).
245		262
246	=cut	263	=cut
247		264
248	sub cancel {	265	sub cancel {
		266	my $self = shift;
		267	$self->{status} = [@_];
249	push @destroy, $_[0];	268	push @destroy, $self;
250	$manager->ready;	269	$manager->ready;
		270	&schedule if $current == $self;
		271	}
		272
		273	=item $process->join
		274
		275	Wait until the coroutine terminates and return any values given to the
		276	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		277	from multiple processes.
		278
		279	=cut
		280
		281	sub join {
		282	my $self = shift;
		283	unless ($self->{status}) {
		284	push @{$self->{join}}, $current;
		285	&schedule;
		286	}
		287	wantarray ? @{$self->{status}} : $self->{status}[0];
		288	}
		289
		290	=item $oldprio = $process->prio ($newprio)
		291
		292	Sets (or gets, if the argument is missing) the priority of the
		293	process. Higher priority processes get run before lower priority
		294	processes. Priorities are small signed integers (currently -4 .. +3),
		295	that you can refer to using PRIO_xxx constants (use the import tag :prio
		296	to get then):
		297
		298	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		299	3 > 1 > 0 > -1 > -3 > -4
		300
		301	# set priority to HIGH
		302	current->prio(PRIO_HIGH);
		303
		304	The idle coroutine ($Coro::idle) always has a lower priority than any
		305	existing coroutine.
		306
		307	Changing the priority of the current process will take effect immediately,
		308	but changing the priority of processes in the ready queue (but not
		309	running) will only take effect after the next schedule (of that
		310	process). This is a bug that will be fixed in some future version.
		311
		312	=item $newprio = $process->nice ($change)
		313
		314	Similar to C<prio>, but subtract the given value from the priority (i.e.
		315	higher values mean lower priority, just as in unix).
		316
		317	=item $olddesc = $process->desc ($newdesc)
		318
		319	Sets (or gets in case the argument is missing) the description for this
		320	process. This is just a free-form string you can associate with a process.
		321
		322	=cut
		323
		324	sub desc {
		325	my $old = $_[0]{desc};
		326	$_[0]{desc} = $_[1] if @_ > 1;
		327	$old;
251	}	328	}
252		329
253	=back	330	=back
254		331
255	=cut	332	=cut
256		333
257	1;	334	1;
258		335
259	=head1 BUGS/LIMITATIONS	336	=head1 BUGS/LIMITATIONS
260		337
261	- could be faster, especially when the core would introduce special	338	- you must make very sure that no coro is still active on global
262	support for coroutines (like it does for threads).	339	destruction. very bad things might happen otherwise (usually segfaults).
263	- there is still a memleak on coroutine termination that I could not	340
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	341	- 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	342	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).	343	to allow per-thread schedulers, but Coro::State does not yet allow
		344	this).
272		345
273	=head1 SEE ALSO	346	=head1 SEE ALSO
274		347
275	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	348	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
276	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	349
277	L<Coro::Handle>, L<Coro::Socket>.	350	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		351
		352	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		353
		354	Embedding: L<Coro:MakeMaker>
278		355
279	=head1 AUTHOR	356	=head1 AUTHOR
280		357
281	Marc Lehmann <pcg@goof.com>	358	Marc Lehmann <schmorp@schmorp.de>
282	http://www.goof.com/pcg/marc/	359	http://home.schmorp.de/
283		360
284	=cut	361	=cut
285		362

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.84 by root, Sat Nov 25 00:40:26 2006 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.84 by root, Sat Nov 25 00:40:26 2006 UTC