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

Comparing Coro/Coro.pm (file contents):
Revision 1.49 by root, Sat Mar 22 23:08:36 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	use strict;
35	no warnings qw(uninitialized);	36	no warnings "uninitialized";
36		37
37	use Coro::State;	38	use Coro::State;
38		39
39	use base Exporter;	40	use base qw(Coro::State Exporter);
40		41
41	$VERSION = 0.65;	42	our $idle; # idle handler
		43	our $main; # main coroutine
		44	our $current; # current coroutine
42		45
		46	our $VERSION = '3.0';
		47
43	@EXPORT = qw(async cede schedule terminate current);	48	our @EXPORT = qw(async cede schedule terminate current);
44	%EXPORT_TAGS = (	49	our %EXPORT_TAGS = (
45	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)],
46	);	51	);
47	@EXPORT_OK = @{$EXPORT_TAGS{prio}};	52	our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
48		53
49	{	54	{
50	my @async;	55	my @async;
51	my $init;	56	my $init;
52		57
53	# this way of handling attributes simply is NOT scalable ;()	58	# this way of handling attributes simply is NOT scalable ;()
54	sub import {	59	sub import {
		60	no strict 'refs';
		61
55	Coro->export_to_level(1, @_);	62	Coro->export_to_level(1, @_);
		63
56	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	64	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
57	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	65	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
58	my ($package, $ref) = (shift, shift);	66	my ($package, $ref) = (shift, shift);
59	my @attrs;	67	my @attrs;
60	for (@_) {	68	for (@_) {
…		…
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, because the program has no other way to continue.
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 wake up a
		126	coroutine so the scheduler can run it.
111		127
112	# should be done using priorities :(	128	Please note that if your callback recursively invokes perl (e.g. for event
113	our $idle = new Coro sub {	129	handlers), then it must be prepared to be called recursively.
		130
		131	=cut
		132
		133	$idle = sub {
114	print STDERR "FATAL: deadlock detected\n";	134	print STDERR "FATAL: deadlock detected\n";
115	exit(51);	135	exit (51);
116	};	136	};
117		137
118	# this coroutine is necessary because a coroutine	138	# this coroutine is necessary because a coroutine
119	# cannot destroy itself.	139	# cannot destroy itself.
120	my @destroy;	140	my @destroy;
121	my $manager;
122	$manager = new Coro sub {	141	my $manager; $manager = new Coro sub {
123	while() {	142	while () {
124	# by overwriting the state object with the manager we destroy it	143	# by overwriting the state object with the manager we destroy it
125	# 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
126	# been readied multiple times. this is harmless since the manager	145	# been readied multiple times. this is harmless since the manager
127	# can be called as many times as neccessary and will always	146	# can be called as many times as neccessary and will always
128	# remove itself from the runqueue	147	# remove itself from the runqueue
129	while (@destroy) {	148	while (@destroy) {
130	my $coro = pop @destroy;	149	my $coro = pop @destroy;
131	$coro->{status} \|\|= [];	150	$coro->{status} \|\|= [];
132	$_->ready for @{delete $coro->{join} \|\| []};	151	$_->ready for @{delete $coro->{join} \|\| []};
133	$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);
134	}	158	}
135	&schedule;	159	&schedule;
136	}	160	}
137	};	161	};
138		162
…		…
150		174
151	Create a new asynchronous process and return it's process object	175	Create a new asynchronous process and return it's process object
152	(usually unused). When the sub returns the new process is automatically	176	(usually unused). When the sub returns the new process is automatically
153	terminated.	177	terminated.
154		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
155	# create a new coroutine that just prints its arguments	184	# create a new coroutine that just prints its arguments
156	async {	185	async {
157	print "@_\n";	186	print "@_\n";
158	} 1,2,3,4;	187	} 1,2,3,4;
159		188
160	The coderef you submit MUST NOT be a closure that refers to variables
161	in an outer scope. This does NOT work. Pass arguments into it instead.
162
163	=cut	189	=cut
164		190
165	sub async(&@) {	191	sub async(&@) {
166	my $pid = new Coro @_;	192	my $pid = new Coro @_;
167	$manager->ready; # this ensures that the stack is cloned from the manager
168	$pid->ready;	193	$pid->ready;
169	$pid;	194	$pid
170	}	195	}
171		196
172	=item schedule	197	=item schedule
173		198
174	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
175	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
176	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	}
177		222
178	=cut	223	=cut
179		224
180	=item cede	225	=item cede
181		226
…		…
185		230
186	=cut	231	=cut
187		232
188	=item terminate [arg...]	233	=item terminate [arg...]
189		234
190	Terminates the current process.	235	Terminates the current process with the given status values (see L<cancel>).
191
192	Future versions of this function will allow result arguments.
193		236
194	=cut	237	=cut
195		238
196	sub terminate {	239	sub terminate {
197	$current->{status} = [@_];
198	$current->cancel;	240	$current->cancel (@_);
199	&schedule;
200	die; # NORETURN
201	}	241	}
202		242
203	=back	243	=back
204		244
205	# dynamic methods	245	# dynamic methods
…		…
215	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
216	automatically terminates as if C<terminate> with the returned values were	256	automatically terminates as if C<terminate> with the returned values were
217	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
218	by calling the ready method.	258	by calling the ready method.
219		259
220	=cut	260	Calling C<exit> in a coroutine will not work correctly, so do not do that.
221		261
		262	=cut
		263
222	sub _newcoro {	264	sub _new_coro {
223	terminate &{+shift};	265	terminate &{+shift};
224	}	266	}
225		267
226	sub new {	268	sub new {
227	my $class = shift;	269	my $class = shift;
228	bless {
229	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
230	}, $class;
231	}
232		270
		271	$class->SUPER::new (\&_new_coro, @_)
		272	}
		273
233	=item $process->ready	274	=item $success = $process->ready
234		275
235	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.
236		279
237	=cut	280	=item $is_ready = $process->is_ready
238		281
		282	Return wether the process is currently the ready queue or not,
		283
239	=item $process->cancel	284	=item $process->cancel (arg...)
240		285
241	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).
242		288
243	=cut	289	=cut
244		290
245	sub cancel {	291	sub cancel {
		292	my $self = shift;
		293	$self->{status} = [@_];
246	push @destroy, $_[0];	294	push @destroy, $self;
247	$manager->ready;	295	$manager->ready;
248	&schedule if $current == $_[0];	296	&schedule if $current == $self;
249	}	297	}
250		298
251	=item $process->join	299	=item $process->join
252		300
253	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
254	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
255	processes.	303	from multiple processes.
256		304
257	=cut	305	=cut
258		306
259	sub join {	307	sub join {
260	my $self = shift;	308	my $self = shift;
…		…
263	&schedule;	311	&schedule;
264	}	312	}
265	wantarray ? @{$self->{status}} : $self->{status}[0];	313	wantarray ? @{$self->{status}} : $self->{status}[0];
266	}	314	}
267		315
268	=item $oldprio = $process->prio($newprio)	316	=item $oldprio = $process->prio ($newprio)
269		317
270	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
271	process. Higher priority processes get run before lower priority	319	process. Higher priority processes get run before lower priority
272	processes. Priorities are smalled signed integer (currently -4 .. +3),	320	processes. Priorities are small signed integers (currently -4 .. +3),
273	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
274	to get then):	322	to get then):
275		323
276	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	324	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277	3 > 1 > 0 > -1 > -3 > -4	325	3 > 1 > 0 > -1 > -3 > -4
…		…
285	Changing the priority of the current process will take effect immediately,	333	Changing the priority of the current process will take effect immediately,
286	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
287	running) will only take effect after the next schedule (of that	335	running) will only take effect after the next schedule (of that
288	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.
289		337
290	=cut
291
292	sub prio {
293	my $old = $_[0]{prio};
294	$_[0]{prio} = $_[1] if @_ > 1;
295	$old;
296	}
297
298	=item $newprio = $process->nice($change)	338	=item $newprio = $process->nice ($change)
299		339
300	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.
301	higher values mean lower priority, just as in unix).	341	higher values mean lower priority, just as in unix).
302		342
303	=cut
304
305	sub nice {
306	$_[0]{prio} -= $_[1];
307	}
308
309	=item $olddesc = $process->desc($newdesc)	343	=item $olddesc = $process->desc ($newdesc)
310		344
311	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
312	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.
313		347
314	=cut	348	=cut
…		…
325		359
326	1;	360	1;
327		361
328	=head1 BUGS/LIMITATIONS	362	=head1 BUGS/LIMITATIONS
329		363
330	- you must make very sure that no coro is still active on global destruction.	364	- you must make very sure that no coro is still active on global
331	very bad things might happen otherwise (usually segfaults).	365	destruction. very bad things might happen otherwise (usually segfaults).
		366
332	- this module is not thread-safe. You should only ever use this module from	367	- this module is not thread-safe. You should only ever use this module
333	the same thread (this requirement might be loosened in the future to	368	from the same thread (this requirement might be losened in the future
334	allow per-thread schedulers, but Coro::State does not yet allow this).	369	to allow per-thread schedulers, but Coro::State does not yet allow
		370	this).
335		371
336	=head1 SEE ALSO	372	=head1 SEE ALSO
337		373
338	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>.
339	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	375
340	L<Coro::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>
341		381
342	=head1 AUTHOR	382	=head1 AUTHOR
343		383
344	Marc Lehmann <pcg@goof.com>	384	Marc Lehmann <schmorp@schmorp.de>
345	http://www.goof.com/pcg/marc/	385	http://home.schmorp.de/
346		386
347	=cut	387	=cut
348		388

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.49 by root, Sat Mar 22 23:08:36 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.49 by root, Sat Mar 22 23:08:36 2003 UTC vs.
Revision 1.91 by root, Fri Dec 1 02:17:37 2006 UTC