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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.56 by pcg, Sat Nov 15 03:53:10 2003 UTC vs.
Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC

…		…
30		30
31	=cut	31	=cut
32		32
33	package Coro;	33	package Coro;
34		34
35	BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }	35	use strict;
		36	no warnings "uninitialized";
36		37
37	use Coro::State;	38	use Coro::State;
38		39
39	use vars qw($idle $main $current);	40	use base qw(Coro::State Exporter);
40		41
41	use base Exporter;	42	our $idle; # idle handler
		43	our $main; # main coroutine
		44	our $current; # current coroutine
42		45
43	$VERSION = "0.9";	46	our $VERSION = '3.0';
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 (@_) {
…		…
89		95
90	$main = new Coro;	96	$main = new Coro;
91		97
92	=item $current (or as function: current)	98	=item $current (or as function: current)
93		99
94	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.
95		106
96	=cut	107	=cut
97		108
98	# maybe some other module used Coro::Specific before...	109	# maybe some other module used Coro::Specific before...
99	if ($current) {	110	if ($current) {
…		…
104		115
105	sub current() { $current }	116	sub current() { $current }
106		117
107	=item $idle	118	=item $idle
108		119
109	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
110	implementation prints "FATAL: deadlock detected" and exits.	121	to run. The default implementation prints "FATAL: deadlock detected" and
		122	exits.
111		123
112	=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.
113		127
114	# should be done using priorities :(	128	=cut
115	$idle = new Coro sub {	129
		130	$idle = sub {
116	print STDERR "FATAL: deadlock detected\n";	131	print STDERR "FATAL: deadlock detected\n";
117	exit(51);	132	exit (51);
118	};	133	};
119		134
120	# this coroutine is necessary because a coroutine	135	# this coroutine is necessary because a coroutine
121	# cannot destroy itself.	136	# cannot destroy itself.
122	my @destroy;	137	my @destroy;
123	my $manager;
124	$manager = new Coro sub {	138	my $manager; $manager = new Coro sub {
125	while() {	139	while () {
126	# by overwriting the state object with the manager we destroy it	140	# by overwriting the state object with the manager we destroy it
127	# while still being able to schedule this coroutine (in case it has	141	# while still being able to schedule this coroutine (in case it has
128	# been readied multiple times. this is harmless since the manager	142	# been readied multiple times. this is harmless since the manager
129	# can be called as many times as neccessary and will always	143	# can be called as many times as neccessary and will always
130	# remove itself from the runqueue	144	# remove itself from the runqueue
131	while (@destroy) {	145	while (@destroy) {
132	my $coro = pop @destroy;	146	my $coro = pop @destroy;
133	$coro->{status} \|\|= [];	147	$coro->{status} \|\|= [];
134	$_->ready for @{delete $coro->{join} \|\| []};	148	$_->ready for @{delete $coro->{join} \|\| []};
135	$coro->{_coro_state} = $manager->{_coro_state};	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);
136	}	155	}
137	&schedule;	156	&schedule;
138	}	157	}
139	};	158	};
140		159
…		…
152		171
153	Create a new asynchronous process and return it's process object	172	Create a new asynchronous process and return it's process object
154	(usually unused). When the sub returns the new process is automatically	173	(usually unused). When the sub returns the new process is automatically
155	terminated.	174	terminated.
156		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.
		180
157	# create a new coroutine that just prints its arguments	181	# create a new coroutine that just prints its arguments
158	async {	182	async {
159	print "@_\n";	183	print "@_\n";
160	} 1,2,3,4;	184	} 1,2,3,4;
161		185
162	The coderef you submit MUST NOT be a closure that refers to variables
163	in an outer scope. This does NOT work. Pass arguments into it instead.
164
165	=cut	186	=cut
166		187
167	sub async(&@) {	188	sub async(&@) {
168	my $pid = new Coro @_;	189	my $pid = new Coro @_;
169	$manager->ready; # this ensures that the stack is cloned from the manager
170	$pid->ready;	190	$pid->ready;
171	$pid;	191	$pid
172	}	192	}
173		193
174	=item schedule	194	=item schedule
175		195
176	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
…		…
187		207
188	=cut	208	=cut
189		209
190	=item terminate [arg...]	210	=item terminate [arg...]
191		211
192	Terminates the current process.	212	Terminates the current process with the given status values (see L<cancel>).
193
194	Future versions of this function will allow result arguments.
195		213
196	=cut	214	=cut
197		215
198	sub terminate {	216	sub terminate {
199	$current->{status} = [@_];
200	$current->cancel;	217	$current->cancel (@_);
201	&schedule;
202	die; # NORETURN
203	}	218	}
204		219
205	=back	220	=back
206		221
207	# dynamic methods	222	# dynamic methods
…		…
217	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
218	automatically terminates as if C<terminate> with the returned values were	233	automatically terminates as if C<terminate> with the returned values were
219	called. To make the process run you must first put it into the ready queue	234	called. To make the process run you must first put it into the ready queue
220	by calling the ready method.	235	by calling the ready method.
221		236
222	=cut	237	Calling C<exit> in a coroutine will not work correctly, so do not do that.
223		238
		239	=cut
		240
224	sub _newcoro {	241	sub _new_coro {
225	terminate &{+shift};	242	terminate &{+shift};
226	}	243	}
227		244
228	sub new {	245	sub new {
229	my $class = shift;	246	my $class = shift;
230	bless {	247
231	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	248	$class->SUPER::new (\&_new_coro, @_)
232	}, $class;
233	}	249	}
234		250
235	=item $process->ready	251	=item $process->ready
236		252
237	Put the given process into the ready queue.	253	Put the given process into the ready queue.
238		254
239	=cut	255	=cut
240		256
241	=item $process->cancel	257	=item $process->cancel (arg...)
242		258
243	Like C<terminate>, but terminates the specified process instead.	259	Terminates the given process and makes it return the given arguments as
		260	status (default: the empty list).
244		261
245	=cut	262	=cut
246		263
247	sub cancel {	264	sub cancel {
		265	my $self = shift;
		266	$self->{status} = [@_];
248	push @destroy, $_[0];	267	push @destroy, $self;
249	$manager->ready;	268	$manager->ready;
250	&schedule if $current == $_[0];	269	&schedule if $current == $self;
251	}	270	}
252		271
253	=item $process->join	272	=item $process->join
254		273
255	Wait until the coroutine terminates and return any values given to the	274	Wait until the coroutine terminates and return any values given to the
256	C<terminate> function. C<join> can be called multiple times from multiple	275	C<terminate> or C<cancel> functions. C<join> can be called multiple times
257	processes.	276	from multiple processes.
258		277
259	=cut	278	=cut
260		279
261	sub join {	280	sub join {
262	my $self = shift;	281	my $self = shift;
…		…
265	&schedule;	284	&schedule;
266	}	285	}
267	wantarray ? @{$self->{status}} : $self->{status}[0];	286	wantarray ? @{$self->{status}} : $self->{status}[0];
268	}	287	}
269		288
270	=item $oldprio = $process->prio($newprio)	289	=item $oldprio = $process->prio ($newprio)
271		290
272	Sets (or gets, if the argument is missing) the priority of the	291	Sets (or gets, if the argument is missing) the priority of the
273	process. Higher priority processes get run before lower priority	292	process. Higher priority processes get run before lower priority
274	processes. Priorities are small signed integers (currently -4 .. +3),	293	processes. Priorities are small signed integers (currently -4 .. +3),
275	that you can refer to using PRIO_xxx constants (use the import tag :prio	294	that you can refer to using PRIO_xxx constants (use the import tag :prio
…		…
287	Changing the priority of the current process will take effect immediately,	306	Changing the priority of the current process will take effect immediately,
288	but changing the priority of processes in the ready queue (but not	307	but changing the priority of processes in the ready queue (but not
289	running) will only take effect after the next schedule (of that	308	running) will only take effect after the next schedule (of that
290	process). This is a bug that will be fixed in some future version.	309	process). This is a bug that will be fixed in some future version.
291		310
292	=cut
293
294	sub prio {
295	my $old = $_[0]{prio};
296	$_[0]{prio} = $_[1] if @_ > 1;
297	$old;
298	}
299
300	=item $newprio = $process->nice($change)	311	=item $newprio = $process->nice ($change)
301		312
302	Similar to C<prio>, but subtract the given value from the priority (i.e.	313	Similar to C<prio>, but subtract the given value from the priority (i.e.
303	higher values mean lower priority, just as in unix).	314	higher values mean lower priority, just as in unix).
304		315
305	=cut
306
307	sub nice {
308	$_[0]{prio} -= $_[1];
309	}
310
311	=item $olddesc = $process->desc($newdesc)	316	=item $olddesc = $process->desc ($newdesc)
312		317
313	Sets (or gets in case the argument is missing) the description for this	318	Sets (or gets in case the argument is missing) the description for this
314	process. This is just a free-form string you can associate with a process.	319	process. This is just a free-form string you can associate with a process.
315		320
316	=cut	321	=cut
…		…
337	to allow per-thread schedulers, but Coro::State does not yet allow	342	to allow per-thread schedulers, but Coro::State does not yet allow
338	this).	343	this).
339		344
340	=head1 SEE ALSO	345	=head1 SEE ALSO
341		346
342	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	347	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
343	L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,	348
344	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.	349	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		350
		351	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		352
		353	Embedding: L<Coro:MakeMaker>
345		354
346	=head1 AUTHOR	355	=head1 AUTHOR
347		356
348	Marc Lehmann <pcg@goof.com>	357	Marc Lehmann <schmorp@schmorp.de>
349	http://www.goof.com/pcg/marc/	358	http://home.schmorp.de/
350		359
351	=cut	360	=cut
352		361

Diff Legend

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

Comparing cvsroot/Coro/Coro.pm (file contents): Revision 1.56 by pcg, Sat Nov 15 03:53:10 2003 UTC vs. Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC

Diff Legend

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.56 by pcg, Sat Nov 15 03:53:10 2003 UTC vs.
Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC