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

Comparing Coro/Coro.pm (file contents):
Revision 1.8 by root, Sat Jul 14 22:14:21 2001 UTC vs.
Revision 1.37 by root, Mon Sep 24 02:25:44 2001 UTC

…		…
14		14
15	sub some_func : Coro {	15	sub some_func : Coro {
16	# some more async code	16	# some more async code
17	}	17	}
18		18
19	yield;	19	cede;
20		20
21	=head1 DESCRIPTION	21	=head1 DESCRIPTION
22		22
		23	This module collection manages coroutines. Coroutines are similar to
		24	Threads but don't run in parallel.
		25
		26	This module is still experimental, see the BUGS section below.
		27
		28	In this module, coroutines are defined as "callchain + lexical variables
		29	+ @_ + $_ + $@ + $^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
		31	important global variables.
		32
23	=cut	33	=cut
24		34
25	package Coro;	35	package Coro;
26		36
		37	no warnings qw(uninitialized);
		38
27	use Coro::State;	39	use Coro::State;
28		40
29	use base Exporter;	41	use base Exporter;
30		42
31	$VERSION = 0.03;	43	$VERSION = 0.5;
32		44
33	@EXPORT = qw(async yield schedule);	45	@EXPORT = qw(async cede schedule terminate current);
34	@EXPORT_OK = qw($current);	46	%EXPORT_TAGS = (
		47	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
		48	);
		49	@EXPORT_OK = @{$EXPORT_TAGS{prio}};
35		50
36	{	51	{
37	use subs 'async';
38
39	my @async;	52	my @async;
		53	my $init;
40		54
41	# this way of handling attributes simply is NOT scalable ;()	55	# this way of handling attributes simply is NOT scalable ;()
42	sub import {	56	sub import {
43	Coro->export_to_level(1, @_);	57	Coro->export_to_level(1, @_);
44	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
…		…
46	my ($package, $ref) = (shift, shift);	60	my ($package, $ref) = (shift, shift);
47	my @attrs;	61	my @attrs;
48	for (@_) {	62	for (@_) {
49	if ($_ eq "Coro") {	63	if ($_ eq "Coro") {
50	push @async, $ref;	64	push @async, $ref;
		65	unless ($init++) {
		66	eval q{
		67	sub INIT {
		68	&async(pop @async) while @async;
		69	}
		70	};
		71	}
51	} else {	72	} else {
52	push @attrs, @_;	73	push @attrs, $_;
53	}	74	}
54	}	75	}
55	return $old ? $old->($package, $name, @attrs) : @attrs;	76	return $old ? $old->($package, $ref, @attrs) : @attrs;
56	};	77	};
57	}	78	}
58		79
59	sub INIT {
60	async pop @async while @async;
61	}
62	}	80	}
63
64	my $idle = new Coro sub {
65	&yield while 1;
66	};
67		81
68	=item $main	82	=item $main
69		83
70	This coroutine represents the main program.	84	This coroutine represents the main program.
71		85
72	=cut	86	=cut
73		87
74	$main = new Coro;	88	our $main = new Coro;
75		89
76	=item $current	90	=item $current (or as function: current)
77		91
78	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	92	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
79		93
80	=cut	94	=cut
81		95
82	# maybe some other module used Coro::Specific before...	96	# maybe some other module used Coro::Specific before...
83	if ($current) {	97	if ($current) {
84	$main->{specific} = $current->{specific};	98	$main->{specific} = $current->{specific};
85	}	99	}
86		100
87	$current = $main;	101	our $current = $main;
88		102
89	# we really need priorities...	103	sub current() { $current }
90	my @ready = (); # the ready queue. hehe, rather broken ;)	104
		105	=item $idle
		106
		107	The coroutine to switch to when no other coroutine is running. The default
		108	implementation prints "FATAL: deadlock detected" and exits.
		109
		110	=cut
		111
		112	# should be done using priorities :(
		113	our $idle = new Coro sub {
		114	print STDERR "FATAL: deadlock detected\n";
		115	exit(51);
		116	};
		117
		118	# this coroutine is necessary because a coroutine
		119	# cannot destroy itself.
		120	my @destroy;
		121	my $manager = new Coro sub {
		122	while() {
		123	# by overwriting the state object with the manager we destroy it
		124	# while still being able to schedule this coroutine (in case it has
		125	# been readied multiple times. this is harmless since the manager
		126	# can be called as many times as neccessary and will always
		127	# remove itself from the runqueue
		128	(pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy;
		129	&schedule;
		130	}
		131	};
91		132
92	# static methods. not really.	133	# static methods. not really.
93		134
94	=head2 STATIC METHODS	135	=head2 STATIC METHODS
95		136
96	Static methods are actually functions that operate on the current process only.	137	Static methods are actually functions that operate on the current process only.
97		138
98	=over 4	139	=over 4
99		140
100	=item async { ... };	141	=item async { ... } [@args...]
101		142
102	Create a new asynchronous process and return it's process object	143	Create a new asynchronous process and return it's process object
103	(usually unused). When the sub returns the new process is automatically	144	(usually unused). When the sub returns the new process is automatically
104	terminated.	145	terminated.
105		146
106	=cut	147	# create a new coroutine that just prints its arguments
		148	async {
		149	print "@_\n";
		150	} 1,2,3,4;
107		151
		152	The coderef you submit MUST NOT be a closure that refers to variables
		153	in an outer scope. This does NOT work. Pass arguments into it instead.
		154
		155	=cut
		156
108	sub async(&) {	157	sub async(&@) {
109	(new Coro $_[0])->ready;	158	my $pid = new Coro @_;
		159	$manager->ready; # this ensures that the stack is cloned from the manager
		160	$pid->ready;
		161	$pid;
110	}	162	}
111		163
112	=item schedule	164	=item schedule
113		165
114	Calls the scheduler. Please note that the current process will not be put	166	Calls the scheduler. Please note that the current process will not be put
115	into the ready queue, so calling this function usually means you will	167	into the ready queue, so calling this function usually means you will
116	never be called again.	168	never be called again.
117		169
118	=cut	170	=cut
119		171
120	my $prev;
121
122	sub schedule {
123	($prev, $current) = ($current, shift @ready);
124	Coro::State::transfer($prev, $current);
125	}
126
127	=item yield	172	=item cede
128		173
129	Yield to other processes. This function puts the current process into the	174	"Cede" to other processes. This function puts the current process into the
130	ready queue and calls C<schedule>.	175	ready queue and calls C<schedule>, which has the effect of giving up the
		176	current "timeslice" to other coroutines of the same or higher priority.
131		177
132	=cut	178	=cut
133		179
134	sub yield {	180	=item terminate
		181
		182	Terminates the current process.
		183
		184	Future versions of this function will allow result arguments.
		185
		186	=cut
		187
		188	sub terminate {
135	$current->ready;	189	$current->cancel;
136	&schedule;	190	&schedule;
137	}	191	die; # NORETURN
138
139	=item terminate
140
141	Terminates the current process.
142
143	=cut
144
145	sub terminate {
146	&schedule;
147	}	192	}
148		193
149	=back	194	=back
150		195
151	# dynamic methods	196	# dynamic methods
…		…
154		199
155	These are the methods you can call on process objects.	200	These are the methods you can call on process objects.
156		201
157	=over 4	202	=over 4
158		203
159	=item new Coro \⊂	204	=item new Coro \&sub [, @args...]
160		205
161	Create a new process and return it. When the sub returns the process	206	Create a new process and return it. When the sub returns the process
162	automatically terminates. To start the process you must first put it into	207	automatically terminates. To start the process you must first put it into
163	the ready queue by calling the ready method.	208	the ready queue by calling the ready method.
164		209
		210	The coderef you submit MUST NOT be a closure that refers to variables
		211	in an outer scope. This does NOT work. Pass arguments into it instead.
		212
165	=cut	213	=cut
		214
		215	sub _newcoro {
		216	terminate &{+shift};
		217	}
166		218
167	sub new {	219	sub new {
168	my $class = shift;	220	my $class = shift;
169	my $proc = $_[0];
170	bless {	221	bless {
171	_coro_state => new Coro::State ($proc ? sub { &$proc; &terminate } : $proc),	222	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
172	}, $class;	223	}, $class;
173	}	224	}
174		225
175	=item $process->ready	226	=item $process->ready
176		227
177	Put the current process into the ready queue.	228	Put the current process into the ready queue.
178		229
179	=cut	230	=cut
180		231
181	sub ready {	232	=item $process->cancel
		233
		234	Like C<terminate>, but terminates the specified process instead.
		235
		236	=cut
		237
		238	sub cancel {
182	push @ready, $_[0];	239	push @destroy, $_[0];
		240	$manager->ready;
		241	&schedule if $current == $_[0];
		242	}
		243
		244	=item $oldprio = $process->prio($newprio)
		245
		246	Sets the priority of the process. Higher priority processes get run before
		247	lower priority processes. Priorities are smalled signed integer (currently
		248	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import
		249	tag :prio to get then):
		250
		251	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		252	3 > 1 > 0 > -1 > -3 > -4
		253
		254	# set priority to HIGH
		255	current->prio(PRIO_HIGH);
		256
		257	The idle coroutine ($Coro::idle) always has a lower priority than any
		258	existing coroutine.
		259
		260	Changing the priority of the current process will take effect immediately,
		261	but changing the priority of processes in the ready queue (but not
		262	running) will only take effect after the next schedule (of that
		263	process). This is a bug that will be fixed in some future version.
		264
		265	=cut
		266
		267	sub prio {
		268	my $old = $_[0]{prio};
		269	$_[0]{prio} = $_[1] if @_ > 1;
		270	$old;
		271	}
		272
		273	=item $newprio = $process->nice($change)
		274
		275	Similar to C<prio>, but subtract the given value from the priority (i.e.
		276	higher values mean lower priority, just as in unix).
		277
		278	=cut
		279
		280	sub nice {
		281	$_[0]{prio} -= $_[1];
183	}	282	}
184		283
185	=back	284	=back
186		285
187	=cut	286	=cut
188		287
189	1;	288	1;
		289
		290	=head1 BUGS/LIMITATIONS
		291
		292	- you must make very sure that no coro is still active on global destruction.
		293	very bad things might happen otherwise (usually segfaults).
		294	- this module is not thread-safe. You must only ever use this module from
		295	the same thread (this requirement might be loosened in the future to
		296	allow per-thread schedulers, but Coro::State does not yet allow this).
		297
		298	=head1 SEE ALSO
		299
		300	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
		301	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
		302	L<Coro::Handle>, L<Coro::Socket>.
190		303
191	=head1 AUTHOR	304	=head1 AUTHOR
192		305
193	Marc Lehmann <pcg@goof.com>	306	Marc Lehmann <pcg@goof.com>
194	http://www.goof.com/pcg/marc/	307	http://www.goof.com/pcg/marc/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.8 by root, Sat Jul 14 22:14:21 2001 UTC vs. Revision 1.37 by root, Mon Sep 24 02:25:44 2001 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.8 by root, Sat Jul 14 22:14:21 2001 UTC vs.
Revision 1.37 by root, Mon Sep 24 02:25:44 2001 UTC