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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.37 by root, Mon Sep 24 02:25:44 2001 UTC vs.
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC

… …
19 cede; 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 + C stack), that is, a coroutine has it's own 27+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30callchain, it's own set of lexicals and it's own set of perl's most 28callchain, it's own set of lexicals and it's own set of perl's most
31important global variables. 29important global variables.
… …
38 36
39use Coro::State; 37use Coro::State;
40 38
41use base Exporter; 39use base Exporter;
42 40
43$VERSION = 0.5; 41$VERSION = 0.52;
44 42
45@EXPORT = qw(async cede schedule terminate current); 43@EXPORT = qw(async cede schedule terminate current);
46%EXPORT_TAGS = ( 44%EXPORT_TAGS = (
47 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 45 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48); 46);
… …
116}; 114};
117 115
118# this coroutine is necessary because a coroutine 116# this coroutine is necessary because a coroutine
119# cannot destroy itself. 117# cannot destroy itself.
120my @destroy; 118my @destroy;
119my $manager;
121my $manager = new Coro sub { 120$manager = new Coro sub {
122 while() { 121 while() {
123 # by overwriting the state object with the manager we destroy it 122 # by overwriting the state object with the manager we destroy it
124 # while still being able to schedule this coroutine (in case it has 123 # while still being able to schedule this coroutine (in case it has
125 # been readied multiple times. this is harmless since the manager 124 # been readied multiple times. this is harmless since the manager
126 # can be called as many times as neccessary and will always 125 # can be called as many times as neccessary and will always
127 # remove itself from the runqueue 126 # remove itself from the runqueue
127 while (@destroy) {
128 my $coro = pop @destroy;
129 $coro->{status} ||= [];
130 $_->ready for @{delete $coro->{join} || []};
128 (pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy; 131 $coro->{_coro_state} = $manager->{_coro_state};
132 }
129 &schedule; 133 &schedule;
130 } 134 }
131}; 135};
132 136
133# static methods. not really. 137# static methods. not really.
… …
175ready queue and calls C<schedule>, which has the effect of giving up the 179ready queue and calls C<schedule>, which has the effect of giving up the
176current "timeslice" to other coroutines of the same or higher priority. 180current "timeslice" to other coroutines of the same or higher priority.
177 181
178=cut 182=cut
179 183
180=item terminate 184=item terminate [arg...]
181 185
182Terminates the current process. 186Terminates the current process.
183 187
184Future versions of this function will allow result arguments. 188Future versions of this function will allow result arguments.
185 189
186=cut 190=cut
187 191
188sub terminate { 192sub terminate {
193 $current->{status} = [@_];
189 $current->cancel; 194 $current->cancel;
190 &schedule; 195 &schedule;
191 die; # NORETURN 196 die; # NORETURN
192} 197}
193 198
… …
202=over 4 207=over 4
203 208
204=item new Coro \&sub [, @args...] 209=item new Coro \&sub [, @args...]
205 210
206Create a new process and return it. When the sub returns the process 211Create a new process and return it. When the sub returns the process
207automatically terminates. To start the process you must first put it into 212automatically terminates as if C<terminate> with the returned values were
213called. To make the process run you must first put it into the ready queue
208the ready queue by calling the ready method. 214by calling the ready method.
209
210The coderef you submit MUST NOT be a closure that refers to variables
211in an outer scope. This does NOT work. Pass arguments into it instead.
212 215
213=cut 216=cut
214 217
215sub _newcoro { 218sub _newcoro {
216 terminate &{+shift}; 219 terminate &{+shift};
… …
223 }, $class; 226 }, $class;
224} 227}
225 228
226=item $process->ready 229=item $process->ready
227 230
228Put the current process into the ready queue. 231Put the given process into the ready queue.
229 232
230=cut 233=cut
231 234
232=item $process->cancel 235=item $process->cancel
233 236
… …
239 push @destroy, $_[0]; 242 push @destroy, $_[0];
240 $manager->ready; 243 $manager->ready;
241 &schedule if $current == $_[0]; 244 &schedule if $current == $_[0];
242} 245}
243 246
247=item $process->join
248
249Wait until the coroutine terminates and return any values given to the
250C<terminate> function. C<join> can be called multiple times from multiple
251processes.
252
253=cut
254
255sub join {
256 my $self = shift;
257 unless ($self->{status}) {
258 push @{$self->{join}}, $current;
259 &schedule;
260 }
261 wantarray ? @{$self->{status}} : $self->{status}[0];
262}
263
244=item $oldprio = $process->prio($newprio) 264=item $oldprio = $process->prio($newprio)
245 265
246Sets the priority of the process. Higher priority processes get run before 266Sets (or gets, if the argument is missing) the priority of the
267process. Higher priority processes get run before lower priority
247lower priority processes. Priorities are smalled signed integer (currently 268processes. Priorities are smalled signed integer (currently -4 .. +3),
248-4 .. +3), that you can refer to using PRIO_xxx constants (use the import 269that you can refer to using PRIO_xxx constants (use the import tag :prio
249tag :prio to get then): 270to get then):
250 271
251 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 272 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
252 3 > 1 > 0 > -1 > -3 > -4 273 3 > 1 > 0 > -1 > -3 > -4
253 274
254 # set priority to HIGH 275 # set priority to HIGH
… …
279 300
280sub nice { 301sub nice {
281 $_[0]{prio} -= $_[1]; 302 $_[0]{prio} -= $_[1];
282} 303}
283 304
305=item $olddesc = $process->desc($newdesc)
306
307Sets (or gets in case the argument is missing) the description for this
308process. This is just a free-form string you can associate with a process.
309
310=cut
311
312sub desc {
313 my $old = $_[0]{desc};
314 $_[0]{desc} = $_[1] if @_ > 1;
315 $old;
316}
317
284=back 318=back
285 319
286=cut 320=cut
287 321
2881; 3221;
289 323
290=head1 BUGS/LIMITATIONS 324=head1 BUGS/LIMITATIONS
291 325
292 - you must make very sure that no coro is still active on global destruction. 326 - you must make very sure that no coro is still active on global destruction.
293 very bad things might happen otherwise (usually segfaults). 327 very bad things might happen otherwise (usually segfaults).
294 - this module is not thread-safe. You must only ever use this module from 328 - this module is not thread-safe. You should only ever use this module from
295 the same thread (this requirement might be loosened in the future to 329 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). 330 allow per-thread schedulers, but Coro::State does not yet allow this).
297 331
298=head1 SEE ALSO 332=head1 SEE ALSO
299 333

Diff Legend

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