[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.90 by root, Thu Nov 30 18:21:14 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 qw(Coro::State Exporter);
42		41
43	$VERSION = 0.5;	42	our $idle; # idle handler
		43	our $main; # main coroutine
		44	our $current; # current coroutine
44		45
		46	our $VERSION = '3.0';
		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
		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.
93		106
94	=cut	107	=cut
95		108
96	# maybe some other module used Coro::Specific before...	109	# maybe some other module used Coro::Specific before...
97	if ($current) {	110	if ($current) {
98	$main->{specific} = $current->{specific};	111	$main->{specific} = $current->{specific};
99	}	112	}
100		113
101	our $current = $main;	114	$current = $main;
102		115
103	sub current() { $current }	116	sub current() { $current }
104		117
105	=item $idle	118	=item $idle
106		119
107	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
108	implementation prints "FATAL: deadlock detected" and exits.	121	to run. The default implementation prints "FATAL: deadlock detected" and
		122	exits.
109		123
110	=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.
111		127
112	# should be done using priorities :(	128	=cut
113	our $idle = new Coro sub {	129
		130	$idle = sub {
114	print STDERR "FATAL: deadlock detected\n";	131	print STDERR "FATAL: deadlock detected\n";
115	exit(51);	132	exit (51);
116	};	133	};
117		134
118	# this coroutine is necessary because a coroutine	135	# this coroutine is necessary because a coroutine
119	# cannot destroy itself.	136	# cannot destroy itself.
120	my @destroy;	137	my @destroy;
121	my $manager = new Coro sub {	138	my $manager; $manager = new Coro sub {
122	while() {	139	while () {
123	delete ((pop @destroy)->{_coro_state}) while @destroy;	140	# by overwriting the state object with the manager we destroy it
		141	# while still being able to schedule this coroutine (in case it has
		142	# been readied multiple times. this is harmless since the manager
		143	# can be called as many times as neccessary and will always
		144	# remove itself from the runqueue
		145	while (@destroy) {
		146	my $coro = pop @destroy;
		147	$coro->{status} \|\|= [];
		148	$_->ready for @{delete $coro->{join} \|\| []};
		149
		150	# the next line destroys the coro state, but keeps the
		151	# process itself intact (we basically make it a zombie
		152	# process that always runs the manager thread, so it's possible
		153	# to transfer() to this process).
		154	$coro->_clone_state_from ($manager);
		155	}
124	&schedule;	156	&schedule;
125	}	157	}
126	};	158	};
127		159
128	# static methods. not really.	160	# static methods. not really.
129		161
		162	=back
		163
130	=head2 STATIC METHODS	164	=head2 STATIC METHODS
131		165
132	Static methods are actually functions that operate on the current process only.	166	Static methods are actually functions that operate on the current process only.
133		167
134	=over 4	168	=over 4
…		…
136	=item async { ... } [@args...]	170	=item async { ... } [@args...]
137		171
138	Create a new asynchronous process and return it's process object	172	Create a new asynchronous process and return it's process object
139	(usually unused). When the sub returns the new process is automatically	173	(usually unused). When the sub returns the new process is automatically
140	terminated.	174	terminated.
		175
		176	Calling C<exit> in a coroutine will not work correctly, so do not do that.
		177
		178	When the coroutine dies, the program will exit, just as in the main
		179	program.
141		180
142	# create a new coroutine that just prints its arguments	181	# create a new coroutine that just prints its arguments
143	async {	182	async {
144	print "@_\n";	183	print "@_\n";
145	} 1,2,3,4;	184	} 1,2,3,4;
146		185
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
150	=cut	186	=cut
151		187
152	sub async(&@) {	188	sub async(&@) {
153	my $pid = new Coro @_;	189	my $pid = new Coro @_;
154	$manager->ready; # this ensures that the stack is cloned from the manager
155	$pid->ready;	190	$pid->ready;
156	$pid;	191	$pid
157	}	192	}
158		193
159	=item schedule	194	=item schedule
160		195
161	Calls the scheduler. Please note that the current process will not be put	196	Calls the scheduler. Please note that the current process will not be put
…		…
170	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
171	current "timeslice" to other coroutines of the same or higher priority.	206	current "timeslice" to other coroutines of the same or higher priority.
172		207
173	=cut	208	=cut
174		209
175	=item terminate	210	=item terminate [arg...]
176		211
177	Terminates the current process.	212	Terminates the current process with the given status values (see L<cancel>).
178
179	Future versions of this function will allow result arguments.
180		213
181	=cut	214	=cut
182		215
183	sub terminate {	216	sub terminate {
184	$current->cancel;	217	$current->cancel (@_);
185	&schedule;
186	die; # NORETURN
187	}	218	}
188		219
189	=back	220	=back
190		221
191	# dynamic methods	222	# dynamic methods
…		…
197	=over 4	228	=over 4
198		229
199	=item new Coro \&sub [, @args...]	230	=item new Coro \&sub [, @args...]
200		231
201	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
202	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
203	the ready queue by calling the ready method.	235	by calling the ready method.
204		236
205	The coderef you submit MUST NOT be a closure that refers to variables	237	Calling C<exit> in a coroutine will not work correctly, so do not do that.
206	in an outer scope. This does NOT work. Pass arguments into it instead.
207		238
208	=cut	239	=cut
209		240
210	sub _newcoro {	241	sub _new_coro {
211	terminate &{+shift};	242	terminate &{+shift};
212	}	243	}
213		244
214	sub new {	245	sub new {
215	my $class = shift;	246	my $class = shift;
216	bless {
217	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
218	}, $class;
219	}
220		247
		248	$class->SUPER::new (\&_new_coro, @_)
		249	}
		250
221	=item $process->ready	251	=item $success = $process->ready
222		252
223	Put the current process into the ready queue.	253	Put the given process into the ready queue (according to it's priority)
		254	and return true. If the process is already in the ready queue, do nothing
		255	and return false.
224		256
225	=cut	257	=item $is_ready = $process->is_ready
226		258
		259	Return wether the process is currently the ready queue or not,
		260
227	=item $process->cancel	261	=item $process->cancel (arg...)
228		262
229	Like C<terminate>, but terminates the specified process instead.	263	Terminates the given process and makes it return the given arguments as
		264	status (default: the empty list).
230		265
231	=cut	266	=cut
232		267
233	sub cancel {	268	sub cancel {
		269	my $self = shift;
		270	$self->{status} = [@_];
234	push @destroy, $_[0];	271	push @destroy, $self;
235	$manager->ready;	272	$manager->ready;
236	&schedule if $current == $_[0];	273	&schedule if $current == $self;
237	}	274	}
238		275
		276	=item $process->join
		277
		278	Wait until the coroutine terminates and return any values given to the
		279	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		280	from multiple processes.
		281
		282	=cut
		283
		284	sub join {
		285	my $self = shift;
		286	unless ($self->{status}) {
		287	push @{$self->{join}}, $current;
		288	&schedule;
		289	}
		290	wantarray ? @{$self->{status}} : $self->{status}[0];
		291	}
		292
239	=item $oldprio = $process->prio($newprio)	293	=item $oldprio = $process->prio ($newprio)
240		294
241	Sets the priority of the process. Higher priority processes get run before	295	Sets (or gets, if the argument is missing) the priority of the
		296	process. Higher priority processes get run before lower priority
242	lower priority processes. Priorities are smalled signed integer (currently	297	processes. Priorities are small signed integers (currently -4 .. +3),
243	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import	298	that you can refer to using PRIO_xxx constants (use the import tag :prio
244	tag :prio to get then):	299	to get then):
245		300
246	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	301	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
247	3 > 1 > 0 > -1 > -3 > -4	302	3 > 1 > 0 > -1 > -3 > -4
248		303
249	# set priority to HIGH	304	# set priority to HIGH
…		…
255	Changing the priority of the current process will take effect immediately,	310	Changing the priority of the current process will take effect immediately,
256	but changing the priority of processes in the ready queue (but not	311	but changing the priority of processes in the ready queue (but not
257	running) will only take effect after the next schedule (of that	312	running) will only take effect after the next schedule (of that
258	process). This is a bug that will be fixed in some future version.	313	process). This is a bug that will be fixed in some future version.
259		314
260	=cut
261
262	sub prio {
263	my $old = $_[0]{prio};
264	$_[0]{prio} = $_[1] if @_ > 1;
265	$old;
266	}
267
268	=item $newprio = $process->nice($change)	315	=item $newprio = $process->nice ($change)
269		316
270	Similar to C<prio>, but subtract the given value from the priority (i.e.	317	Similar to C<prio>, but subtract the given value from the priority (i.e.
271	higher values mean lower priority, just as in unix).	318	higher values mean lower priority, just as in unix).
272		319
273	=cut	320	=item $olddesc = $process->desc ($newdesc)
274		321
275	sub nice {	322	Sets (or gets in case the argument is missing) the description for this
276	$_[0]{prio} -= $_[1];	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;
277	}	331	}
278		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.90 by root, Thu Nov 30 18:21:14 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.90 by root, Thu Nov 30 18:21:14 2006 UTC