ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro.pm
(Generate patch)

Comparing Coro/Coro.pm (file contents):
Revision 1.20 by root, Sat Jul 21 18:21:45 2001 UTC vs.
Revision 1.56 by pcg, Sat Nov 15 03:53:10 2003 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
23This module collection manages coroutines. Coroutines are similar to 23This module collection manages coroutines. Coroutines are similar to
24Threads but don't run in parallel. 24threads but don't run in parallel.
25
26This module is still experimental, see the BUGS section below.
27 25
28In this module, coroutines are defined as "callchain + lexical variables 26In this module, coroutines are defined as "callchain + lexical variables
29+ @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's 27+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30own set of lexicals and it's own set of perl's most important global 28callchain, it's own set of lexicals and it's own set of perl's most
31variables. 29important global variables.
32 30
33=cut 31=cut
34 32
35package Coro; 33package Coro;
36 34
35BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }
36
37use Coro::State; 37use Coro::State;
38 38
39use vars qw($idle $main $current);
40
39use base Exporter; 41use base Exporter;
40 42
41$VERSION = 0.10; 43$VERSION = "0.9";
42 44
43@EXPORT = qw(async yield schedule terminate current); 45@EXPORT = qw(async cede schedule terminate current);
44@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}};
45 50
46{ 51{
47 my @async; 52 my @async;
53 my $init;
48 54
49 # this way of handling attributes simply is NOT scalable ;() 55 # this way of handling attributes simply is NOT scalable ;()
50 sub import { 56 sub import {
51 Coro->export_to_level(1, @_); 57 Coro->export_to_level(1, @_);
52 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 58 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
… …
54 my ($package, $ref) = (shift, shift); 60 my ($package, $ref) = (shift, shift);
55 my @attrs; 61 my @attrs;
56 for (@_) { 62 for (@_) {
57 if ($_ eq "Coro") { 63 if ($_ eq "Coro") {
58 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 }
59 } else { 72 } else {
60 push @attrs, $_; 73 push @attrs, $_;
61 } 74 }
62 } 75 }
63 return $old ? $old->($package, $ref, @attrs) : @attrs; 76 return $old ? $old->($package, $ref, @attrs) : @attrs;
64 }; 77 };
65 } 78 }
66 79
67 sub INIT {
68 &async(pop @async) while @async;
69 }
70} 80}
81
82=over 4
71 83
72=item $main 84=item $main
73 85
74This coroutine represents the main program. 86This coroutine represents the main program.
75 87
76=cut 88=cut
77 89
78our $main = new Coro; 90$main = new Coro;
79 91
80=item $current (or as function: current) 92=item $current (or as function: current)
81 93
82The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 94The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
83 95
… …
86# maybe some other module used Coro::Specific before... 98# maybe some other module used Coro::Specific before...
87if ($current) { 99if ($current) {
88 $main->{specific} = $current->{specific}; 100 $main->{specific} = $current->{specific};
89} 101}
90 102
91our $current = $main; 103$current = $main;
92 104
93sub current() { $current } 105sub current() { $current }
94 106
95=item $idle 107=item $idle
96 108
… …
98implementation prints "FATAL: deadlock detected" and exits. 110implementation prints "FATAL: deadlock detected" and exits.
99 111
100=cut 112=cut
101 113
102# should be done using priorities :( 114# should be done using priorities :(
103our $idle = new Coro sub { 115$idle = new Coro sub {
104 print STDERR "FATAL: deadlock detected\n"; 116 print STDERR "FATAL: deadlock detected\n";
105 exit(51); 117 exit(51);
106}; 118};
107 119
108# we really need priorities... 120# this coroutine is necessary because a coroutine
109my @ready; # the ready queue. hehe, rather broken ;) 121# cannot destroy itself.
122my @destroy;
123my $manager;
124$manager = new Coro sub {
125 while() {
126 # by overwriting the state object with the manager we destroy it
127 # while still being able to schedule this coroutine (in case it has
128 # been readied multiple times. this is harmless since the manager
129 # can be called as many times as neccessary and will always
130 # remove itself from the runqueue
131 while (@destroy) {
132 my $coro = pop @destroy;
133 $coro->{status} ||= [];
134 $_->ready for @{delete $coro->{join} || []};
135 $coro->{_coro_state} = $manager->{_coro_state};
136 }
137 &schedule;
138 }
139};
110 140
111# static methods. not really. 141# static methods. not really.
142
143=back
112 144
113=head2 STATIC METHODS 145=head2 STATIC METHODS
114 146
115Static methods are actually functions that operate on the current process only. 147Static methods are actually functions that operate on the current process only.
116 148
… …
132 164
133=cut 165=cut
134 166
135sub async(&@) { 167sub async(&@) {
136 my $pid = new Coro @_; 168 my $pid = new Coro @_;
169 $manager->ready; # this ensures that the stack is cloned from the manager
137 $pid->ready; 170 $pid->ready;
138 $pid; 171 $pid;
139} 172}
140 173
141=item schedule 174=item schedule
… …
144into the ready queue, so calling this function usually means you will 177into the ready queue, so calling this function usually means you will
145never be called again. 178never be called again.
146 179
147=cut 180=cut
148 181
149my $prev;
150
151sub schedule {
152 # should be done using priorities :(
153 ($prev, $current) = ($current, shift @ready || $idle);
154 Coro::State::transfer($prev, $current);
155}
156
157=item yield 182=item cede
158 183
159Yield to other processes. This function puts the current process into the 184"Cede" to other processes. This function puts the current process into the
160ready queue and calls C<schedule>. 185ready queue and calls C<schedule>, which has the effect of giving up the
186current "timeslice" to other coroutines of the same or higher priority.
161 187
162=cut 188=cut
163 189
164sub yield { 190=item terminate [arg...]
191
192Terminates the current process.
193
194Future versions of this function will allow result arguments.
195
196=cut
197
198sub terminate {
199 $current->{status} = [@_];
165 $current->ready; 200 $current->cancel;
166 &schedule; 201 &schedule;
167} 202 die; # NORETURN
168
169=item terminate
170
171Terminates the current process.
172
173Future versions of this function will allow result arguments.
174
175=cut
176
177sub terminate {
178 $current->{_results} = [@_];
179 &schedule;
180} 203}
181 204
182=back 205=back
183 206
184# dynamic methods 207# dynamic methods
… …
190=over 4 213=over 4
191 214
192=item new Coro \&sub [, @args...] 215=item new Coro \&sub [, @args...]
193 216
194Create a new process and return it. When the sub returns the process 217Create a new process and return it. When the sub returns the process
195automatically terminates. To start the process you must first put it into 218automatically terminates as if C<terminate> with the returned values were
219called. To make the process run you must first put it into the ready queue
196the ready queue by calling the ready method. 220by calling the ready method.
197
198The coderef you submit MUST NOT be a closure that refers to variables
199in an outer scope. This does NOT work. Pass arguments into it instead.
200 221
201=cut 222=cut
202 223
203sub _newcoro { 224sub _newcoro {
204 terminate &{+shift}; 225 terminate &{+shift};
… …
211 }, $class; 232 }, $class;
212} 233}
213 234
214=item $process->ready 235=item $process->ready
215 236
216Put the current process into the ready queue. 237Put the given process into the ready queue.
217 238
218=cut 239=cut
219 240
220sub ready { 241=item $process->cancel
242
243Like C<terminate>, but terminates the specified process instead.
244
245=cut
246
247sub cancel {
221 push @ready, $_[0]; 248 push @destroy, $_[0];
249 $manager->ready;
250 &schedule if $current == $_[0];
251}
252
253=item $process->join
254
255Wait until the coroutine terminates and return any values given to the
256C<terminate> function. C<join> can be called multiple times from multiple
257processes.
258
259=cut
260
261sub join {
262 my $self = shift;
263 unless ($self->{status}) {
264 push @{$self->{join}}, $current;
265 &schedule;
266 }
267 wantarray ? @{$self->{status}} : $self->{status}[0];
268}
269
270=item $oldprio = $process->prio($newprio)
271
272Sets (or gets, if the argument is missing) the priority of the
273process. Higher priority processes get run before lower priority
274processes. Priorities are small signed integers (currently -4 .. +3),
275that you can refer to using PRIO_xxx constants (use the import tag :prio
276to get then):
277
278 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
279 3 > 1 > 0 > -1 > -3 > -4
280
281 # set priority to HIGH
282 current->prio(PRIO_HIGH);
283
284The idle coroutine ($Coro::idle) always has a lower priority than any
285existing coroutine.
286
287Changing the priority of the current process will take effect immediately,
288but changing the priority of processes in the ready queue (but not
289running) will only take effect after the next schedule (of that
290process). This is a bug that will be fixed in some future version.
291
292=cut
293
294sub prio {
295 my $old = $_[0]{prio};
296 $_[0]{prio} = $_[1] if @_ > 1;
297 $old;
298}
299
300=item $newprio = $process->nice($change)
301
302Similar to C<prio>, but subtract the given value from the priority (i.e.
303higher values mean lower priority, just as in unix).
304
305=cut
306
307sub nice {
308 $_[0]{prio} -= $_[1];
309}
310
311=item $olddesc = $process->desc($newdesc)
312
313Sets (or gets in case the argument is missing) the description for this
314process. This is just a free-form string you can associate with a process.
315
316=cut
317
318sub desc {
319 my $old = $_[0]{desc};
320 $_[0]{desc} = $_[1] if @_ > 1;
321 $old;
222} 322}
223 323
224=back 324=back
225 325
226=cut 326=cut
227 327
2281; 3281;
229 329
230=head1 BUGS/LIMITATIONS 330=head1 BUGS/LIMITATIONS
231 331
232 - could be faster, especially when the core would introduce special 332 - you must make very sure that no coro is still active on global
233 support for coroutines (like it does for threads). 333 destruction. very bad things might happen otherwise (usually segfaults).
234 - there is still a memleak on coroutine termination that I could not 334
235 identify. Could be as small as a single SV.
236 - this module is not well-tested.
237 - if variables or arguments "disappear" (become undef) or become
238 corrupted please contact the author so he cen iron out the
239 remaining bugs.
240 - this module is not thread-safe. You must only ever use this module from 335 - this module is not thread-safe. You should only ever use this module
241 the same thread (this requirement might be loosened in the future to 336 from the same thread (this requirement might be losened in the future
242 allow per-thread schedulers, but Coro::State does not yet allow this). 337 to allow per-thread schedulers, but Coro::State does not yet allow
338 this).
243 339
244=head1 SEE ALSO 340=head1 SEE ALSO
245 341
246L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 342L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
247L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 343L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
344L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
248 345
249=head1 AUTHOR 346=head1 AUTHOR
250 347
251 Marc Lehmann <pcg@goof.com> 348 Marc Lehmann <pcg@goof.com>
252 http://www.goof.com/pcg/marc/ 349 http://www.goof.com/pcg/marc/

Diff Legend

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