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

Comparing Coro/Coro.pm (file contents):
Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC vs.
Revision 1.79 by root, Fri Nov 3 00:56:02 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 Exporter::;
40		41
41	$VERSION = 0.45;	42	our $idle; # idle coroutine
		43	our $main; # main coroutine
		44	our $current; # current coroutine
42		45
		46	our $VERSION = '2.1';
		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 is C<$main> (of course).
88		101
…		…
91	# maybe some other module used Coro::Specific before...	104	# maybe some other module used Coro::Specific before...
92	if ($current) {	105	if ($current) {
93	$main->{specific} = $current->{specific};	106	$main->{specific} = $current->{specific};
94	}	107	}
95		108
96	our $current = $main;	109	$current = $main;
97		110
98	sub current() { $current }	111	sub current() { $current }
99		112
100	=item $idle	113	=item $idle
101		114
…		…
103	implementation prints "FATAL: deadlock detected" and exits.	116	implementation prints "FATAL: deadlock detected" and exits.
104		117
105	=cut	118	=cut
106		119
107	# should be done using priorities :(	120	# should be done using priorities :(
108	our $idle = new Coro sub {	121	$idle = new Coro sub {
109	print STDERR "FATAL: deadlock detected\n";	122	print STDERR "FATAL: deadlock detected\n";
110	exit(51);	123	exit(51);
111	};	124	};
112		125
113	# this coroutine is necessary because a coroutine	126	# this coroutine is necessary because a coroutine
114	# cannot destroy itself.	127	# cannot destroy itself.
115	my @destroy;	128	my @destroy;
		129	my $manager;
116	my $manager = new Coro sub {	130	$manager = new Coro sub {
117	while() {	131	while () {
118	delete ((pop @destroy)->{_coro_state}) while @destroy;	132	# by overwriting the state object with the manager we destroy it
		133	# while still being able to schedule this coroutine (in case it has
		134	# been readied multiple times. this is harmless since the manager
		135	# can be called as many times as neccessary and will always
		136	# remove itself from the runqueue
		137	while (@destroy) {
		138	my $coro = pop @destroy;
		139	$coro->{status} \|\|= [];
		140	$_->ready for @{delete $coro->{join} \|\| []};
		141
		142	# the next line destroys the _coro_state, but keeps the
		143	# process itself intact (we basically make it a zombie
		144	# process that always runs the manager thread, so it's possible
		145	# to transfer() to this process).
		146	$coro->{_coro_state} = $manager->{_coro_state};
		147	}
119	&schedule;	148	&schedule;
120	}	149	}
121	};	150	};
122		151
123	# static methods. not really.	152	# static methods. not really.
124		153
		154	=back
		155
125	=head2 STATIC METHODS	156	=head2 STATIC METHODS
126		157
127	Static methods are actually functions that operate on the current process only.	158	Static methods are actually functions that operate on the current process only.
128		159
129	=over 4	160	=over 4
…		…
131	=item async { ... } [@args...]	162	=item async { ... } [@args...]
132		163
133	Create a new asynchronous process and return it's process object	164	Create a new asynchronous process and return it's process object
134	(usually unused). When the sub returns the new process is automatically	165	(usually unused). When the sub returns the new process is automatically
135	terminated.	166	terminated.
		167
		168	When the coroutine dies, the program will exit, just as in the main
		169	program.
136		170
137	# create a new coroutine that just prints its arguments	171	# create a new coroutine that just prints its arguments
138	async {	172	async {
139	print "@_\n";	173	print "@_\n";
140	} 1,2,3,4;	174	} 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		175
145	=cut	176	=cut
146		177
147	sub async(&@) {	178	sub async(&@) {
148	my $pid = new Coro @_;	179	my $pid = new Coro @_;
…		…
165	ready queue and calls C<schedule>, which has the effect of giving up the	196	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.	197	current "timeslice" to other coroutines of the same or higher priority.
167		198
168	=cut	199	=cut
169		200
170	=item terminate	201	=item terminate [arg...]
171		202
172	Terminates the current process.	203	Terminates the current process with the given status values (see L<cancel>).
173
174	Future versions of this function will allow result arguments.
175		204
176	=cut	205	=cut
177		206
178	sub terminate {	207	sub terminate {
179	$current->cancel;	208	$current->cancel (@_);
180	&schedule;
181	die; # NORETURN
182	}	209	}
183		210
184	=back	211	=back
185		212
186	# dynamic methods	213	# dynamic methods
…		…
192	=over 4	219	=over 4
193		220
194	=item new Coro \&sub [, @args...]	221	=item new Coro \&sub [, @args...]
195		222
196	Create a new process and return it. When the sub returns the process	223	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	224	automatically terminates as if C<terminate> with the returned values were
		225	called. To make the process run you must first put it into the ready queue
198	the ready queue by calling the ready method.	226	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		227
203	=cut	228	=cut
204		229
205	sub _newcoro {	230	sub _newcoro {
206	terminate &{+shift};	231	terminate &{+shift};
…		…
213	}, $class;	238	}, $class;
214	}	239	}
215		240
216	=item $process->ready	241	=item $process->ready
217		242
218	Put the current process into the ready queue.	243	Put the given process into the ready queue.
219		244
220	=cut	245	=cut
221		246
222	=item $process->cancel	247	=item $process->cancel (arg...)
223		248
224	Like C<terminate>, but terminates the specified process instead.	249	Terminates the given process and makes it return the given arguments as
		250	status (default: the empty list).
225		251
226	=cut	252	=cut
227		253
228	sub cancel {	254	sub cancel {
		255	my $self = shift;
		256	$self->{status} = [@_];
229	push @destroy, $_[0];	257	push @destroy, $self;
230	$manager->ready;	258	$manager->ready;
		259	&schedule if $current == $self;
		260	}
		261
		262	=item $process->join
		263
		264	Wait until the coroutine terminates and return any values given to the
		265	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		266	from multiple processes.
		267
		268	=cut
		269
		270	sub join {
		271	my $self = shift;
		272	unless ($self->{status}) {
		273	push @{$self->{join}}, $current;
		274	&schedule;
		275	}
		276	wantarray ? @{$self->{status}} : $self->{status}[0];
		277	}
		278
		279	=item $oldprio = $process->prio($newprio)
		280
		281	Sets (or gets, if the argument is missing) the priority of the
		282	process. Higher priority processes get run before lower priority
		283	processes. Priorities are small signed integers (currently -4 .. +3),
		284	that you can refer to using PRIO_xxx constants (use the import tag :prio
		285	to get then):
		286
		287	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		288	3 > 1 > 0 > -1 > -3 > -4
		289
		290	# set priority to HIGH
		291	current->prio(PRIO_HIGH);
		292
		293	The idle coroutine ($Coro::idle) always has a lower priority than any
		294	existing coroutine.
		295
		296	Changing the priority of the current process will take effect immediately,
		297	but changing the priority of processes in the ready queue (but not
		298	running) will only take effect after the next schedule (of that
		299	process). This is a bug that will be fixed in some future version.
		300
		301	=cut
		302
		303	sub prio {
		304	my $old = $_[0]{prio};
		305	$_[0]{prio} = $_[1] if @_ > 1;
		306	$old;
		307	}
		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	=cut
		315
		316	sub nice {
		317	$_[0]{prio} -= $_[1];
		318	}
		319
		320	=item $olddesc = $process->desc($newdesc)
		321
		322	Sets (or gets in case the argument is missing) the description for this
		323	process. This is just a free-form string you can associate with a process.
		324
		325	=cut
		326
		327	sub desc {
		328	my $old = $_[0]{desc};
		329	$_[0]{desc} = $_[1] if @_ > 1;
		330	$old;
231	}	331	}
232		332
233	=back	333	=back
234		334
235	=cut	335	=cut
236		336
237	1;	337	1;
238		338
239	=head1 BUGS/LIMITATIONS	339	=head1 BUGS/LIMITATIONS
240		340
241	- could be faster, especially when the core would introduce special	341	- you must make very sure that no coro is still active on global
242	support for coroutines (like it does for threads).	342	destruction. very bad things might happen otherwise (usually segfaults).
243	- there is still a memleak on coroutine termination that I could not	343
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	344	- 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	345	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).	346	to allow per-thread schedulers, but Coro::State does not yet allow
		347	this).
252		348
253	=head1 SEE ALSO	349	=head1 SEE ALSO
254		350
255	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	351	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>,	352
257	L<Coro::Handle>, L<Coro::Socket>.	353	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		354
		355	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		356
		357	Embedding: L<Coro:MakeMaker>
258		358
259	=head1 AUTHOR	359	=head1 AUTHOR
260		360
261	Marc Lehmann <pcg@goof.com>	361	Marc Lehmann <schmorp@schmorp.de>
262	http://www.goof.com/pcg/marc/	362	http://home.schmorp.de/
263		363
264	=cut	364	=cut
265		365

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC vs. Revision 1.79 by root, Fri Nov 3 00:56:02 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC vs.
Revision 1.79 by root, Fri Nov 3 00:56:02 2006 UTC