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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs.
Revision 1.90 by root, Thu Nov 30 18:21:14 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.52;	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 (@_) {
…		…
75	};	83	};
76	}	84	}
77		85
78	}	86	}
79		87
		88	=over 4
		89
80	=item $main	90	=item $main
81		91
82	This coroutine represents the main program.	92	This coroutine represents the main program.
83		93
84	=cut	94	=cut
85		95
86	our $main = new Coro;	96	$main = new Coro;
87		97
88	=item $current (or as function: current)	98	=item $current (or as function: current)
89		99
90	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.
91		106
92	=cut	107	=cut
93		108
94	# maybe some other module used Coro::Specific before...	109	# maybe some other module used Coro::Specific before...
95	if ($current) {	110	if ($current) {
96	$main->{specific} = $current->{specific};	111	$main->{specific} = $current->{specific};
97	}	112	}
98		113
99	our $current = $main;	114	$current = $main;
100		115
101	sub current() { $current }	116	sub current() { $current }
102		117
103	=item $idle	118	=item $idle
104		119
105	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
106	implementation prints "FATAL: deadlock detected" and exits.	121	to run. The default implementation prints "FATAL: deadlock detected" and
		122	exits.
107		123
108	=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.
109		127
110	# should be done using priorities :(	128	=cut
111	our $idle = new Coro sub {	129
		130	$idle = sub {
112	print STDERR "FATAL: deadlock detected\n";	131	print STDERR "FATAL: deadlock detected\n";
113	exit(51);	132	exit (51);
114	};	133	};
115		134
116	# this coroutine is necessary because a coroutine	135	# this coroutine is necessary because a coroutine
117	# cannot destroy itself.	136	# cannot destroy itself.
118	my @destroy;	137	my @destroy;
119	my $manager;
120	$manager = new Coro sub {	138	my $manager; $manager = new Coro sub {
121	while() {	139	while () {
122	# by overwriting the state object with the manager we destroy it	140	# by overwriting the state object with the manager we destroy it
123	# 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
124	# been readied multiple times. this is harmless since the manager	142	# been readied multiple times. this is harmless since the manager
125	# can be called as many times as neccessary and will always	143	# can be called as many times as neccessary and will always
126	# remove itself from the runqueue	144	# remove itself from the runqueue
127	while (@destroy) {	145	while (@destroy) {
128	my $coro = pop @destroy;	146	my $coro = pop @destroy;
129	$coro->{status} \|\|= [];	147	$coro->{status} \|\|= [];
130	$_->ready for @{delete $coro->{join} \|\| []};	148	$_->ready for @{delete $coro->{join} \|\| []};
131	$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);
132	}	155	}
133	&schedule;	156	&schedule;
134	}	157	}
135	};	158	};
136		159
137	# static methods. not really.	160	# static methods. not really.
138		161
		162	=back
		163
139	=head2 STATIC METHODS	164	=head2 STATIC METHODS
140		165
141	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.
142		167
143	=over 4	168	=over 4
…		…
145	=item async { ... } [@args...]	170	=item async { ... } [@args...]
146		171
147	Create a new asynchronous process and return it's process object	172	Create a new asynchronous process and return it's process object
148	(usually unused). When the sub returns the new process is automatically	173	(usually unused). When the sub returns the new process is automatically
149	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.
150		180
151	# create a new coroutine that just prints its arguments	181	# create a new coroutine that just prints its arguments
152	async {	182	async {
153	print "@_\n";	183	print "@_\n";
154	} 1,2,3,4;	184	} 1,2,3,4;
155		185
156	The coderef you submit MUST NOT be a closure that refers to variables
157	in an outer scope. This does NOT work. Pass arguments into it instead.
158
159	=cut	186	=cut
160		187
161	sub async(&@) {	188	sub async(&@) {
162	my $pid = new Coro @_;	189	my $pid = new Coro @_;
163	$manager->ready; # this ensures that the stack is cloned from the manager
164	$pid->ready;	190	$pid->ready;
165	$pid;	191	$pid
166	}	192	}
167		193
168	=item schedule	194	=item schedule
169		195
170	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
…		…
181		207
182	=cut	208	=cut
183		209
184	=item terminate [arg...]	210	=item terminate [arg...]
185		211
186	Terminates the current process.	212	Terminates the current process with the given status values (see L<cancel>).
187
188	Future versions of this function will allow result arguments.
189		213
190	=cut	214	=cut
191		215
192	sub terminate {	216	sub terminate {
193	$current->{status} = [@_];
194	$current->cancel;	217	$current->cancel (@_);
195	&schedule;
196	die; # NORETURN
197	}	218	}
198		219
199	=back	220	=back
200		221
201	# dynamic methods	222	# dynamic methods
…		…
211	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
212	automatically terminates as if C<terminate> with the returned values were	233	automatically terminates as if C<terminate> with the returned values were
213	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
214	by calling the ready method.	235	by calling the ready method.
215		236
216	=cut	237	Calling C<exit> in a coroutine will not work correctly, so do not do that.
217		238
		239	=cut
		240
218	sub _newcoro {	241	sub _new_coro {
219	terminate &{+shift};	242	terminate &{+shift};
220	}	243	}
221		244
222	sub new {	245	sub new {
223	my $class = shift;	246	my $class = shift;
224	bless {
225	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
226	}, $class;
227	}
228		247
		248	$class->SUPER::new (\&_new_coro, @_)
		249	}
		250
229	=item $process->ready	251	=item $success = $process->ready
230		252
231	Put the given 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.
232		256
233	=cut	257	=item $is_ready = $process->is_ready
234		258
		259	Return wether the process is currently the ready queue or not,
		260
235	=item $process->cancel	261	=item $process->cancel (arg...)
236		262
237	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).
238		265
239	=cut	266	=cut
240		267
241	sub cancel {	268	sub cancel {
		269	my $self = shift;
		270	$self->{status} = [@_];
242	push @destroy, $_[0];	271	push @destroy, $self;
243	$manager->ready;	272	$manager->ready;
244	&schedule if $current == $_[0];	273	&schedule if $current == $self;
245	}	274	}
246		275
247	=item $process->join	276	=item $process->join
248		277
249	Wait until the coroutine terminates and return any values given to the	278	Wait until the coroutine terminates and return any values given to the
250	C<terminate> function. C<join> can be called multiple times from multiple	279	C<terminate> or C<cancel> functions. C<join> can be called multiple times
251	processes.	280	from multiple processes.
252		281
253	=cut	282	=cut
254		283
255	sub join {	284	sub join {
256	my $self = shift;	285	my $self = shift;
…		…
259	&schedule;	288	&schedule;
260	}	289	}
261	wantarray ? @{$self->{status}} : $self->{status}[0];	290	wantarray ? @{$self->{status}} : $self->{status}[0];
262	}	291	}
263		292
264	=item $oldprio = $process->prio($newprio)	293	=item $oldprio = $process->prio ($newprio)
265		294
266	Sets (or gets, if the argument is missing) the priority of the	295	Sets (or gets, if the argument is missing) the priority of the
267	process. Higher priority processes get run before lower priority	296	process. Higher priority processes get run before lower priority
268	processes. Priorities are smalled signed integer (currently -4 .. +3),	297	processes. Priorities are small signed integers (currently -4 .. +3),
269	that you can refer to using PRIO_xxx constants (use the import tag :prio	298	that you can refer to using PRIO_xxx constants (use the import tag :prio
270	to get then):	299	to get then):
271		300
272	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
273	3 > 1 > 0 > -1 > -3 > -4	302	3 > 1 > 0 > -1 > -3 > -4
…		…
281	Changing the priority of the current process will take effect immediately,	310	Changing the priority of the current process will take effect immediately,
282	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
283	running) will only take effect after the next schedule (of that	312	running) will only take effect after the next schedule (of that
284	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.
285		314
286	=cut
287
288	sub prio {
289	my $old = $_[0]{prio};
290	$_[0]{prio} = $_[1] if @_ > 1;
291	$old;
292	}
293
294	=item $newprio = $process->nice($change)	315	=item $newprio = $process->nice ($change)
295		316
296	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.
297	higher values mean lower priority, just as in unix).	318	higher values mean lower priority, just as in unix).
298		319
299	=cut
300
301	sub nice {
302	$_[0]{prio} -= $_[1];
303	}
304
305	=item $olddesc = $process->desc($newdesc)	320	=item $olddesc = $process->desc ($newdesc)
306		321
307	Sets (or gets in case the argument is missing) the description for this	322	Sets (or gets in case the argument is missing) the description for this
308	process. This is just a free-form string you can associate with a process.	323	process. This is just a free-form string you can associate with a process.
309		324
310	=cut	325	=cut
…		…
321		336
322	1;	337	1;
323		338
324	=head1 BUGS/LIMITATIONS	339	=head1 BUGS/LIMITATIONS
325		340
326	- 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
327	very bad things might happen otherwise (usually segfaults).	342	destruction. very bad things might happen otherwise (usually segfaults).
		343
328	- this module is not thread-safe. You should only ever use this module from	344	- this module is not thread-safe. You should only ever use this module
329	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
330	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).
331		348
332	=head1 SEE ALSO	349	=head1 SEE ALSO
333		350
334	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>.
335	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	352
336	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>
337		358
338	=head1 AUTHOR	359	=head1 AUTHOR
339		360
340	Marc Lehmann <pcg@goof.com>	361	Marc Lehmann <schmorp@schmorp.de>
341	http://www.goof.com/pcg/marc/	362	http://home.schmorp.de/
342		363
343	=cut	364	=cut
344		365

Diff Legend

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

Comparing cvsroot/Coro/Coro.pm (file contents): Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs. Revision 1.90 by root, Thu Nov 30 18:21:14 2006 UTC

Diff Legend

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs.
Revision 1.90 by root, Thu Nov 30 18:21:14 2006 UTC