[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.83 by root, Fri Nov 24 15:34:33 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	# static methods. not really.	161	# static methods. not really.
124		162
		163	=back
		164
125	=head2 STATIC METHODS	165	=head2 STATIC METHODS
126		166
127	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.
128		168
129	=over 4	169	=over 4
…		…
131	=item async { ... } [@args...]	171	=item async { ... } [@args...]
132		172
133	Create a new asynchronous process and return it's process object	173	Create a new asynchronous process and return it's process object
134	(usually unused). When the sub returns the new process is automatically	174	(usually unused). When the sub returns the new process is automatically
135	terminated.	175	terminated.
		176
		177	When the coroutine dies, the program will exit, just as in the main
		178	program.
136		179
137	# create a new coroutine that just prints its arguments	180	# create a new coroutine that just prints its arguments
138	async {	181	async {
139	print "@_\n";	182	print "@_\n";
140	} 1,2,3,4;	183	} 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		184
145	=cut	185	=cut
146		186
147	sub async(&@) {	187	sub async(&@) {
148	my $pid = new Coro @_;	188	my $pid = new Coro @_;
…		…
165	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
166	current "timeslice" to other coroutines of the same or higher priority.	206	current "timeslice" to other coroutines of the same or higher priority.
167		207
168	=cut	208	=cut
169		209
170	=item terminate	210	=item terminate [arg...]
171		211
172	Terminates the current process.	212	Terminates the current process with the given status values (see L<cancel>).
173
174	Future versions of this function will allow result arguments.
175		213
176	=cut	214	=cut
177		215
178	sub terminate {	216	sub terminate {
179	$current->cancel;	217	$current->cancel (@_);
180	&schedule;
181	die; # NORETURN
182	}	218	}
183		219
184	=back	220	=back
185		221
186	# dynamic methods	222	# dynamic methods
…		…
192	=over 4	228	=over 4
193		229
194	=item new Coro \&sub [, @args...]	230	=item new Coro \&sub [, @args...]
195		231
196	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
197	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
198	the ready queue by calling the ready method.	235	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		236
203	=cut	237	=cut
204		238
205	sub _newcoro {	239	sub _newcoro {
206	terminate &{+shift};	240	terminate &{+shift};
207	}	241	}
208		242
209	sub new {	243	sub new {
210	my $class = shift;	244	my $class = shift;
211	bless {	245
212	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	246	$class->SUPER::new (\&_newcoro, @_)
213	}, $class;
214	}	247	}
215		248
216	=item $process->ready	249	=item $process->ready
217		250
218	Put the current process into the ready queue.	251	Put the given process into the ready queue.
219		252
220	=cut	253	=cut
221		254
222	=item $process->cancel	255	=item $process->cancel (arg...)
223		256
224	Like C<terminate>, but terminates the specified process instead.	257	Terminates the given process and makes it return the given arguments as
		258	status (default: the empty list).
225		259
226	=cut	260	=cut
227		261
228	sub cancel {	262	sub cancel {
		263	my $self = shift;
		264	$self->{status} = [@_];
229	push @destroy, $_[0];	265	push @destroy, $self;
230	$manager->ready;	266	$manager->ready;
		267	&schedule if $current == $self;
		268	}
		269
		270	=item $process->join
		271
		272	Wait until the coroutine terminates and return any values given to the
		273	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		274	from multiple processes.
		275
		276	=cut
		277
		278	sub join {
		279	my $self = shift;
		280	unless ($self->{status}) {
		281	push @{$self->{join}}, $current;
		282	&schedule;
		283	}
		284	wantarray ? @{$self->{status}} : $self->{status}[0];
		285	}
		286
		287	=item $oldprio = $process->prio ($newprio)
		288
		289	Sets (or gets, if the argument is missing) the priority of the
		290	process. Higher priority processes get run before lower priority
		291	processes. Priorities are small signed integers (currently -4 .. +3),
		292	that you can refer to using PRIO_xxx constants (use the import tag :prio
		293	to get then):
		294
		295	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		296	3 > 1 > 0 > -1 > -3 > -4
		297
		298	# set priority to HIGH
		299	current->prio(PRIO_HIGH);
		300
		301	The idle coroutine ($Coro::idle) always has a lower priority than any
		302	existing coroutine.
		303
		304	Changing the priority of the current process will take effect immediately,
		305	but changing the priority of processes in the ready queue (but not
		306	running) will only take effect after the next schedule (of that
		307	process). This is a bug that will be fixed in some future version.
		308
		309	=item $newprio = $process->nice ($change)
		310
		311	Similar to C<prio>, but subtract the given value from the priority (i.e.
		312	higher values mean lower priority, just as in unix).
		313
		314	=item $olddesc = $process->desc ($newdesc)
		315
		316	Sets (or gets in case the argument is missing) the description for this
		317	process. This is just a free-form string you can associate with a process.
		318
		319	=cut
		320
		321	sub desc {
		322	my $old = $_[0]{desc};
		323	$_[0]{desc} = $_[1] if @_ > 1;
		324	$old;
231	}	325	}
232		326
233	=back	327	=back
234		328
235	=cut	329	=cut
236		330
237	1;	331	1;
238		332
239	=head1 BUGS/LIMITATIONS	333	=head1 BUGS/LIMITATIONS
240		334
241	- could be faster, especially when the core would introduce special	335	- you must make very sure that no coro is still active on global
242	support for coroutines (like it does for threads).	336	destruction. very bad things might happen otherwise (usually segfaults).
243	- there is still a memleak on coroutine termination that I could not	337
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	338	- 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	339	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).	340	to allow per-thread schedulers, but Coro::State does not yet allow
		341	this).
252		342
253	=head1 SEE ALSO	343	=head1 SEE ALSO
254		344
255	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	345	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
256	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	346
257	L<Coro::Handle>, L<Coro::Socket>.	347	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		348
		349	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		350
		351	Embedding: L<Coro:MakeMaker>
258		352
259	=head1 AUTHOR	353	=head1 AUTHOR
260		354
261	Marc Lehmann <pcg@goof.com>	355	Marc Lehmann <schmorp@schmorp.de>
262	http://www.goof.com/pcg/marc/	356	http://home.schmorp.de/
263		357
264	=cut	358	=cut
265		359

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.83 by root, Fri Nov 24 15:34:33 2006 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.83 by root, Fri Nov 24 15:34:33 2006 UTC