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

Comparing Coro/Coro.pm (file contents):
Revision 1.36 by root, Mon Sep 24 01:36:20 2001 UTC vs.
Revision 1.80 by root, Mon Nov 6 19:56: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;
37	no warnings qw(uninitialized);	36	no warnings "uninitialized";
38		37
39	use Coro::State;	38	use Coro::State;
40		39
41	use base Exporter;	40	use base Exporter::;
42		41
		42	our $idle; # idle coroutine
		43	our $main; # main coroutine
		44	our $current; # current coroutine
		45
43	$VERSION = 0.5;	46	our $VERSION = '2.5';
44		47
45	@EXPORT = qw(async cede schedule terminate current);	48	our @EXPORT = qw(async cede schedule terminate current);
46	%EXPORT_TAGS = (	49	our %EXPORT_TAGS = (
47	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	50	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48	);	51	);
49	@EXPORT_OK = @{$EXPORT_TAGS{prio}};	52	our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
50		53
51	{	54	{
52	my @async;	55	my @async;
53	my $init;	56	my $init;
54		57
55	# this way of handling attributes simply is NOT scalable ;()	58	# this way of handling attributes simply is NOT scalable ;()
56	sub import {	59	sub import {
		60	no strict 'refs';
		61
57	Coro->export_to_level(1, @_);	62	Coro->export_to_level(1, @_);
		63
58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	64	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
59	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	65	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
60	my ($package, $ref) = (shift, shift);	66	my ($package, $ref) = (shift, shift);
61	my @attrs;	67	my @attrs;
62	for (@_) {	68	for (@_) {
…		…
77	};	83	};
78	}	84	}
79		85
80	}	86	}
81		87
		88	=over 4
		89
82	=item $main	90	=item $main
83		91
84	This coroutine represents the main program.	92	This coroutine represents the main program.
85		93
86	=cut	94	=cut
87		95
88	our $main = new Coro;	96	$main = new Coro;
89		97
90	=item $current (or as function: current)	98	=item $current (or as function: current)
91		99
92	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).
93		101
…		…
96	# maybe some other module used Coro::Specific before...	104	# maybe some other module used Coro::Specific before...
97	if ($current) {	105	if ($current) {
98	$main->{specific} = $current->{specific};	106	$main->{specific} = $current->{specific};
99	}	107	}
100		108
101	our $current = $main;	109	$current = $main;
102		110
103	sub current() { $current }	111	sub current() { $current }
104		112
105	=item $idle	113	=item $idle
106		114
…		…
108	implementation prints "FATAL: deadlock detected" and exits.	116	implementation prints "FATAL: deadlock detected" and exits.
109		117
110	=cut	118	=cut
111		119
112	# should be done using priorities :(	120	# should be done using priorities :(
113	our $idle = new Coro sub {	121	$idle = new Coro sub {
114	print STDERR "FATAL: deadlock detected\n";	122	print STDERR "FATAL: deadlock detected\n";
115	exit(51);	123	exit(51);
116	};	124	};
117		125
118	# this coroutine is necessary because a coroutine	126	# this coroutine is necessary because a coroutine
119	# cannot destroy itself.	127	# cannot destroy itself.
120	my @destroy;	128	my @destroy;
		129	my $manager;
121	my $manager = new Coro sub {	130	$manager = new Coro sub {
122	while() {	131	while () {
123	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	}
124	&schedule;	148	&schedule;
125	}	149	}
126	};	150	};
127		151
128	# static methods. not really.	152	# static methods. not really.
129		153
		154	=back
		155
130	=head2 STATIC METHODS	156	=head2 STATIC METHODS
131		157
132	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.
133		159
134	=over 4	160	=over 4
…		…
136	=item async { ... } [@args...]	162	=item async { ... } [@args...]
137		163
138	Create a new asynchronous process and return it's process object	164	Create a new asynchronous process and return it's process object
139	(usually unused). When the sub returns the new process is automatically	165	(usually unused). When the sub returns the new process is automatically
140	terminated.	166	terminated.
		167
		168	When the coroutine dies, the program will exit, just as in the main
		169	program.
141		170
142	# create a new coroutine that just prints its arguments	171	# create a new coroutine that just prints its arguments
143	async {	172	async {
144	print "@_\n";	173	print "@_\n";
145	} 1,2,3,4;	174	} 1,2,3,4;
146
147	The coderef you submit MUST NOT be a closure that refers to variables
148	in an outer scope. This does NOT work. Pass arguments into it instead.
149		175
150	=cut	176	=cut
151		177
152	sub async(&@) {	178	sub async(&@) {
153	my $pid = new Coro @_;	179	my $pid = new Coro @_;
…		…
170	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
171	current "timeslice" to other coroutines of the same or higher priority.	197	current "timeslice" to other coroutines of the same or higher priority.
172		198
173	=cut	199	=cut
174		200
175	=item terminate	201	=item terminate [arg...]
176		202
177	Terminates the current process.	203	Terminates the current process with the given status values (see L<cancel>).
178
179	Future versions of this function will allow result arguments.
180		204
181	=cut	205	=cut
182		206
183	sub terminate {	207	sub terminate {
184	$current->cancel;	208	$current->cancel (@_);
185	&schedule;
186	die; # NORETURN
187	}	209	}
188		210
189	=back	211	=back
190		212
191	# dynamic methods	213	# dynamic methods
…		…
197	=over 4	219	=over 4
198		220
199	=item new Coro \&sub [, @args...]	221	=item new Coro \&sub [, @args...]
200		222
201	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
202	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
203	the ready queue by calling the ready method.	226	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		227
208	=cut	228	=cut
209		229
210	sub _newcoro {	230	sub _newcoro {
211	terminate &{+shift};	231	terminate &{+shift};
…		…
218	}, $class;	238	}, $class;
219	}	239	}
220		240
221	=item $process->ready	241	=item $process->ready
222		242
223	Put the current process into the ready queue.	243	Put the given process into the ready queue.
224		244
225	=cut	245	=cut
226		246
227	=item $process->cancel	247	=item $process->cancel (arg...)
228		248
229	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).
230		251
231	=cut	252	=cut
232		253
233	sub cancel {	254	sub cancel {
		255	my $self = shift;
		256	$self->{status} = [@_];
234	push @destroy, $_[0];	257	push @destroy, $self;
235	$manager->ready;	258	$manager->ready;
236	&schedule if $current == $_[0];	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];
237	}	277	}
238		278
239	=item $oldprio = $process->prio($newprio)	279	=item $oldprio = $process->prio($newprio)
240		280
241	Sets the priority of the process. Higher priority processes get run before	281	Sets (or gets, if the argument is missing) the priority of the
		282	process. Higher priority processes get run before lower priority
242	lower priority processes. Priorities are smalled signed integer (currently	283	processes. Priorities are small signed integers (currently -4 .. +3),
243	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import	284	that you can refer to using PRIO_xxx constants (use the import tag :prio
244	tag :prio to get then):	285	to get then):
245		286
246	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	287	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
247	3 > 1 > 0 > -1 > -3 > -4	288	3 > 1 > 0 > -1 > -3 > -4
248		289
249	# set priority to HIGH	290	# set priority to HIGH
…		…
274		315
275	sub nice {	316	sub nice {
276	$_[0]{prio} -= $_[1];	317	$_[0]{prio} -= $_[1];
277	}	318	}
278		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;
		331	}
		332
279	=back	333	=back
280		334
281	=cut	335	=cut
282		336
283	1;	337	1;
284		338
285	=head1 BUGS/LIMITATIONS	339	=head1 BUGS/LIMITATIONS
286		340
287	- you must make very sure that no coro is still active on global destruction.	341	- you must make very sure that no coro is still active on global
288	very bad things might happen otherwise (usually segfaults).	342	destruction. very bad things might happen otherwise (usually segfaults).
		343
289	- 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
290	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
291	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).
292		348
293	=head1 SEE ALSO	349	=head1 SEE ALSO
294		350
295	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>.
296	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	352
297	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>
298		358
299	=head1 AUTHOR	359	=head1 AUTHOR
300		360
301	Marc Lehmann <pcg@goof.com>	361	Marc Lehmann <schmorp@schmorp.de>
302	http://www.goof.com/pcg/marc/	362	http://home.schmorp.de/
303		363
304	=cut	364	=cut
305		365

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.36 by root, Mon Sep 24 01:36:20 2001 UTC vs. Revision 1.80 by root, Mon Nov 6 19:56:26 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.36 by root, Mon Sep 24 01:36:20 2001 UTC vs.
Revision 1.80 by root, Mon Nov 6 19:56:26 2006 UTC