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

Comparing Coro/Coro.pm (file contents):
Revision 1.33 by root, Sun Sep 16 00:44:05 2001 UTC vs.
Revision 1.53 by root, Tue May 27 01:15:26 2003 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.
32 30
33=cut 31=cut
34 32
35package Coro; 33package Coro;
36 34
35no warnings qw(uninitialized);
36
37use Coro::State; 37use Coro::State;
38 38
39use base Exporter; 39use base Exporter;
40 40
41$VERSION = 0.49; 41$VERSION = 0.7;
42 42
43@EXPORT = qw(async cede schedule terminate current); 43@EXPORT = qw(async cede schedule terminate current);
44%EXPORT_TAGS = ( 44%EXPORT_TAGS = (
45 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)],
46); 46);
… …
75 }; 75 };
76 } 76 }
77 77
78} 78}
79 79
80=over 4
81
80=item $main 82=item $main
81 83
82This coroutine represents the main program. 84This coroutine represents the main program.
83 85
84=cut 86=cut
… …
114}; 116};
115 117
116# this coroutine is necessary because a coroutine 118# this coroutine is necessary because a coroutine
117# cannot destroy itself. 119# cannot destroy itself.
118my @destroy; 120my @destroy;
121my $manager;
119my $manager = new Coro sub { 122$manager = new Coro sub {
120 while() { 123 while() {
121 delete ((pop @destroy)->{_coro_state}) while @destroy; 124 # by overwriting the state object with the manager we destroy it
125 # while still being able to schedule this coroutine (in case it has
126 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue
129 while (@destroy) {
130 my $coro = pop @destroy;
131 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []};
133 $coro->{_coro_state} = $manager->{_coro_state};
134 }
122 &schedule; 135 &schedule;
123 } 136 }
124}; 137};
125 138
126# static methods. not really. 139# static methods. not really.
140
141=back
127 142
128=head2 STATIC METHODS 143=head2 STATIC METHODS
129 144
130Static methods are actually functions that operate on the current process only. 145Static methods are actually functions that operate on the current process only.
131 146
… …
168ready queue and calls C<schedule>, which has the effect of giving up the 183ready queue and calls C<schedule>, which has the effect of giving up the
169current "timeslice" to other coroutines of the same or higher priority. 184current "timeslice" to other coroutines of the same or higher priority.
170 185
171=cut 186=cut
172 187
173=item terminate 188=item terminate [arg...]
174 189
175Terminates the current process. 190Terminates the current process.
176 191
177Future versions of this function will allow result arguments. 192Future versions of this function will allow result arguments.
178 193
179=cut 194=cut
180 195
181sub terminate { 196sub terminate {
197 $current->{status} = [@_];
182 $current->cancel; 198 $current->cancel;
183 &schedule; 199 &schedule;
184 die; # NORETURN 200 die; # NORETURN
185} 201}
186 202
… …
195=over 4 211=over 4
196 212
197=item new Coro \&sub [, @args...] 213=item new Coro \&sub [, @args...]
198 214
199Create a new process and return it. When the sub returns the process 215Create a new process and return it. When the sub returns the process
200automatically terminates. To start the process you must first put it into 216automatically terminates as if C<terminate> with the returned values were
217called. To make the process run you must first put it into the ready queue
201the ready queue by calling the ready method. 218by calling the ready method.
202
203The coderef you submit MUST NOT be a closure that refers to variables
204in an outer scope. This does NOT work. Pass arguments into it instead.
205 219
206=cut 220=cut
207 221
208sub _newcoro { 222sub _newcoro {
209 terminate &{+shift}; 223 terminate &{+shift};
… …
216 }, $class; 230 }, $class;
217} 231}
218 232
219=item $process->ready 233=item $process->ready
220 234
221Put the current process into the ready queue. 235Put the given process into the ready queue.
222 236
223=cut 237=cut
224 238
225=item $process->cancel 239=item $process->cancel
226 240
… …
229=cut 243=cut
230 244
231sub cancel { 245sub cancel {
232 push @destroy, $_[0]; 246 push @destroy, $_[0];
233 $manager->ready; 247 $manager->ready;
248 &schedule if $current == $_[0];
249}
250
251=item $process->join
252
253Wait until the coroutine terminates and return any values given to the
254C<terminate> function. C<join> can be called multiple times from multiple
255processes.
256
257=cut
258
259sub join {
260 my $self = shift;
261 unless ($self->{status}) {
262 push @{$self->{join}}, $current;
263 &schedule;
264 }
265 wantarray ? @{$self->{status}} : $self->{status}[0];
234} 266}
235 267
236=item $oldprio = $process->prio($newprio) 268=item $oldprio = $process->prio($newprio)
237 269
238Sets the priority of the process. Higher priority processes get run before 270Sets (or gets, if the argument is missing) the priority of the
271process. Higher priority processes get run before lower priority
239lower priority processes. Priorities are smalled signed integer (currently 272processes. Priorities are small signed integers (currently -4 .. +3),
240-4 .. +3), that you can refer to using PRIO_xxx constants (use the import 273that you can refer to using PRIO_xxx constants (use the import tag :prio
241tag :prio to get then): 274to get then):
242 275
243 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
244 3 > 1 > 0 > -1 > -3 > -4 277 3 > 1 > 0 > -1 > -3 > -4
245 278
246 # set priority to HIGH 279 # set priority to HIGH
… …
271 304
272sub nice { 305sub nice {
273 $_[0]{prio} -= $_[1]; 306 $_[0]{prio} -= $_[1];
274} 307}
275 308
309=item $olddesc = $process->desc($newdesc)
310
311Sets (or gets in case the argument is missing) the description for this
312process. This is just a free-form string you can associate with a process.
313
314=cut
315
316sub desc {
317 my $old = $_[0]{desc};
318 $_[0]{desc} = $_[1] if @_ > 1;
319 $old;
320}
321
276=back 322=back
277 323
278=cut 324=cut
279 325
2801; 3261;
281 327
282=head1 BUGS/LIMITATIONS 328=head1 BUGS/LIMITATIONS
283 329
284 - you must make very sure that no coro is still active on global destruction. 330 - you must make very sure that no coro is still active on global
285 very bad things might happen otherwise (usually segfaults). 331 destruction. very bad things might happen otherwise (usually segfaults).
332
286 - this module is not thread-safe. You must only ever use this module from 333 - this module is not thread-safe. You should only ever use this module
287 the same thread (this requirement might be loosened in the future to 334 from the same thread (this requirement might be losened in the future
288 allow per-thread schedulers, but Coro::State does not yet allow this). 335 to allow per-thread schedulers, but Coro::State does not yet allow
336 this).
289 337
290=head1 SEE ALSO 338=head1 SEE ALSO
291 339
292L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 340L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
293L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 341L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,

Diff Legend

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