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

Comparing Coro/Coro.pm (file contents):
Revision 1.57 by pcg, Sun Nov 30 22:49:25 2003 UTC vs.
Revision 1.91 by root, Fri Dec 1 02:17:37 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, because the program has no other way to continue.
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 wake up a
		126	coroutine so the scheduler can run it.
113		127
114	# should be done using priorities :(	128	Please note that if your callback recursively invokes perl (e.g. for event
115	$idle = new Coro sub {	129	handlers), then it must be prepared to be called recursively.
		130
		131	=cut
		132
		133	$idle = sub {
116	print STDERR "FATAL: deadlock detected\n";	134	print STDERR "FATAL: deadlock detected\n";
117	exit(51);	135	exit (51);
118	};	136	};
119		137
120	# this coroutine is necessary because a coroutine	138	# this coroutine is necessary because a coroutine
121	# cannot destroy itself.	139	# cannot destroy itself.
122	my @destroy;	140	my @destroy;
123	my $manager;
124	$manager = new Coro sub {	141	my $manager; $manager = new Coro sub {
125	while () {	142	while () {
126	# by overwriting the state object with the manager we destroy it	143	# by overwriting the state object with the manager we destroy it
127	# while still being able to schedule this coroutine (in case it has	144	# while still being able to schedule this coroutine (in case it has
128	# been readied multiple times. this is harmless since the manager	145	# been readied multiple times. this is harmless since the manager
129	# can be called as many times as neccessary and will always	146	# can be called as many times as neccessary and will always
130	# remove itself from the runqueue	147	# remove itself from the runqueue
131	while (@destroy) {	148	while (@destroy) {
132	my $coro = pop @destroy;	149	my $coro = pop @destroy;
133	$coro->{status} \|\|= [];	150	$coro->{status} \|\|= [];
134	$_->ready for @{delete $coro->{join} \|\| []};	151	$_->ready for @{delete $coro->{join} \|\| []};
135	$coro->{_coro_state} = $manager->{_coro_state};	152
		153	# the next line destroys the coro state, but keeps the
		154	# process itself intact (we basically make it a zombie
		155	# process that always runs the manager thread, so it's possible
		156	# to transfer() to this process).
		157	$coro->_clone_state_from ($manager);
136	}	158	}
137	&schedule;	159	&schedule;
138	}	160	}
139	};	161	};
140		162
…		…
152		174
153	Create a new asynchronous process and return it's process object	175	Create a new asynchronous process and return it's process object
154	(usually unused). When the sub returns the new process is automatically	176	(usually unused). When the sub returns the new process is automatically
155	terminated.	177	terminated.
156		178
		179	Calling C<exit> in a coroutine will not work correctly, so do not do that.
		180
		181	When the coroutine dies, the program will exit, just as in the main
		182	program.
		183
157	# create a new coroutine that just prints its arguments	184	# create a new coroutine that just prints its arguments
158	async {	185	async {
159	print "@_\n";	186	print "@_\n";
160	} 1,2,3,4;	187	} 1,2,3,4;
161		188
162	=cut	189	=cut
163		190
164	sub async(&@) {	191	sub async(&@) {
165	my $pid = new Coro @_;	192	my $pid = new Coro @_;
166	$manager->ready; # this ensures that the stack is cloned from the manager
167	$pid->ready;	193	$pid->ready;
168	$pid;	194	$pid
169	}	195	}
170		196
171	=item schedule	197	=item schedule
172		198
173	Calls the scheduler. Please note that the current process will not be put	199	Calls the scheduler. Please note that the current process will not be put
174	into the ready queue, so calling this function usually means you will	200	into the ready queue, so calling this function usually means you will
175	never be called again.	201	never be called again unless something else (e.g. an event handler) calls
		202	ready.
		203
		204	The canonical way to wait on external events is this:
		205
		206	{
		207	# remember current process
		208	my $current = $Coro::current;
		209
		210	# register a hypothetical event handler
		211	on_event_invoke sub {
		212	# wake up sleeping coroutine
		213	$current->ready;
		214	undef $current;
		215	};
		216
		217	# call schedule until event occured.
		218	# in case we are woken up for other reasons
		219	# (current still defined), loop.
		220	Coro::schedule while $current;
		221	}
176		222
177	=cut	223	=cut
178		224
179	=item cede	225	=item cede
180		226
…		…
184		230
185	=cut	231	=cut
186		232
187	=item terminate [arg...]	233	=item terminate [arg...]
188		234
189	Terminates the current process.	235	Terminates the current process with the given status values (see L<cancel>).
190
191	Future versions of this function will allow result arguments.
192		236
193	=cut	237	=cut
194		238
195	sub terminate {	239	sub terminate {
196	$current->{status} = [@_];
197	$current->cancel;	240	$current->cancel (@_);
198	&schedule;
199	die; # NORETURN
200	}	241	}
201		242
202	=back	243	=back
203		244
204	# dynamic methods	245	# dynamic methods
…		…
214	Create a new process and return it. When the sub returns the process	255	Create a new process and return it. When the sub returns the process
215	automatically terminates as if C<terminate> with the returned values were	256	automatically terminates as if C<terminate> with the returned values were
216	called. To make the process run you must first put it into the ready queue	257	called. To make the process run you must first put it into the ready queue
217	by calling the ready method.	258	by calling the ready method.
218		259
219	=cut	260	Calling C<exit> in a coroutine will not work correctly, so do not do that.
220		261
		262	=cut
		263
221	sub _newcoro {	264	sub _new_coro {
222	terminate &{+shift};	265	terminate &{+shift};
223	}	266	}
224		267
225	sub new {	268	sub new {
226	my $class = shift;	269	my $class = shift;
227	bless {
228	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
229	}, $class;
230	}
231		270
		271	$class->SUPER::new (\&_new_coro, @_)
		272	}
		273
232	=item $process->ready	274	=item $success = $process->ready
233		275
234	Put the given process into the ready queue.	276	Put the given process into the ready queue (according to it's priority)
		277	and return true. If the process is already in the ready queue, do nothing
		278	and return false.
235		279
236	=cut	280	=item $is_ready = $process->is_ready
237		281
		282	Return wether the process is currently the ready queue or not,
		283
238	=item $process->cancel	284	=item $process->cancel (arg...)
239		285
240	Like C<terminate>, but terminates the specified process instead.	286	Terminates the given process and makes it return the given arguments as
		287	status (default: the empty list).
241		288
242	=cut	289	=cut
243		290
244	sub cancel {	291	sub cancel {
		292	my $self = shift;
		293	$self->{status} = [@_];
245	push @destroy, $_[0];	294	push @destroy, $self;
246	$manager->ready;	295	$manager->ready;
247	&schedule if $current == $_[0];	296	&schedule if $current == $self;
248	}	297	}
249		298
250	=item $process->join	299	=item $process->join
251		300
252	Wait until the coroutine terminates and return any values given to the	301	Wait until the coroutine terminates and return any values given to the
253	C<terminate> function. C<join> can be called multiple times from multiple	302	C<terminate> or C<cancel> functions. C<join> can be called multiple times
254	processes.	303	from multiple processes.
255		304
256	=cut	305	=cut
257		306
258	sub join {	307	sub join {
259	my $self = shift;	308	my $self = shift;
…		…
262	&schedule;	311	&schedule;
263	}	312	}
264	wantarray ? @{$self->{status}} : $self->{status}[0];	313	wantarray ? @{$self->{status}} : $self->{status}[0];
265	}	314	}
266		315
267	=item $oldprio = $process->prio($newprio)	316	=item $oldprio = $process->prio ($newprio)
268		317
269	Sets (or gets, if the argument is missing) the priority of the	318	Sets (or gets, if the argument is missing) the priority of the
270	process. Higher priority processes get run before lower priority	319	process. Higher priority processes get run before lower priority
271	processes. Priorities are small signed integers (currently -4 .. +3),	320	processes. Priorities are small signed integers (currently -4 .. +3),
272	that you can refer to using PRIO_xxx constants (use the import tag :prio	321	that you can refer to using PRIO_xxx constants (use the import tag :prio
…		…
284	Changing the priority of the current process will take effect immediately,	333	Changing the priority of the current process will take effect immediately,
285	but changing the priority of processes in the ready queue (but not	334	but changing the priority of processes in the ready queue (but not
286	running) will only take effect after the next schedule (of that	335	running) will only take effect after the next schedule (of that
287	process). This is a bug that will be fixed in some future version.	336	process). This is a bug that will be fixed in some future version.
288		337
289	=cut
290
291	sub prio {
292	my $old = $_[0]{prio};
293	$_[0]{prio} = $_[1] if @_ > 1;
294	$old;
295	}
296
297	=item $newprio = $process->nice($change)	338	=item $newprio = $process->nice ($change)
298		339
299	Similar to C<prio>, but subtract the given value from the priority (i.e.	340	Similar to C<prio>, but subtract the given value from the priority (i.e.
300	higher values mean lower priority, just as in unix).	341	higher values mean lower priority, just as in unix).
301		342
302	=cut
303
304	sub nice {
305	$_[0]{prio} -= $_[1];
306	}
307
308	=item $olddesc = $process->desc($newdesc)	343	=item $olddesc = $process->desc ($newdesc)
309		344
310	Sets (or gets in case the argument is missing) the description for this	345	Sets (or gets in case the argument is missing) the description for this
311	process. This is just a free-form string you can associate with a process.	346	process. This is just a free-form string you can associate with a process.
312		347
313	=cut	348	=cut
…		…
334	to allow per-thread schedulers, but Coro::State does not yet allow	369	to allow per-thread schedulers, but Coro::State does not yet allow
335	this).	370	this).
336		371
337	=head1 SEE ALSO	372	=head1 SEE ALSO
338		373
339	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	374	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
340	L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,	375
341	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.	376	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		377
		378	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		379
		380	Embedding: L<Coro:MakeMaker>
342		381
343	=head1 AUTHOR	382	=head1 AUTHOR
344		383
345	Marc Lehmann <pcg@goof.com>	384	Marc Lehmann <schmorp@schmorp.de>
346	http://www.goof.com/pcg/marc/	385	http://home.schmorp.de/
347		386
348	=cut	387	=cut
349		388

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.57 by pcg, Sun Nov 30 22:49:25 2003 UTC vs. Revision 1.91 by root, Fri Dec 1 02:17:37 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.57 by pcg, Sun Nov 30 22:49:25 2003 UTC vs.
Revision 1.91 by root, Fri Dec 1 02:17:37 2006 UTC