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

Comparing Coro/Coro.pm (file contents):
Revision 1.28 by root, Fri Aug 10 21:03:40 2001 UTC vs.
Revision 1.41 by root, Tue Nov 6 20:34:09 2001 UTC

… …
32 32
33=cut 33=cut
34 34
35package Coro; 35package Coro;
36 36
37no warnings qw(uninitialized);
38
37use Coro::State; 39use Coro::State;
38 40
39use base Exporter; 41use base Exporter;
40 42
41$VERSION = 0.13; 43$VERSION = 0.52;
42 44
43@EXPORT = qw(async cede 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;
48 my $init; 53 my $init;
49 54
… …
111}; 116};
112 117
113# this coroutine is necessary because a coroutine 118# this coroutine is necessary because a coroutine
114# cannot destroy itself. 119# cannot destroy itself.
115my @destroy; 120my @destroy;
121my $manager;
116my $manager = new Coro sub { 122$manager = new Coro sub {
117 while() { 123 while() {
118 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 }
119 &schedule; 135 &schedule;
120 } 136 }
121}; 137};
122
123# we really need priorities...
124my @ready; # the ready queue. hehe, rather broken ;)
125 138
126# static methods. not really. 139# static methods. not really.
127 140
128=head2 STATIC METHODS 141=head2 STATIC METHODS
129 142
… …
160into the ready queue, so calling this function usually means you will 173into the ready queue, so calling this function usually means you will
161never be called again. 174never be called again.
162 175
163=cut 176=cut
164 177
165my $prev;
166
167sub schedule {
168 # should be done using priorities :(
169 ($prev, $current) = ($current, shift @ready || $idle);
170 Coro::State::transfer($prev, $current);
171}
172
173=item cede 178=item cede
174 179
175"Cede" to other processes. This function puts the current process into the 180"Cede" to other processes. This function puts the current process into the
176ready queue and calls C<schedule>, which has the effect of giving up the 181ready queue and calls C<schedule>, which has the effect of giving up the
177current "timeslice" to other coroutines of the same or higher priority. 182current "timeslice" to other coroutines of the same or higher priority.
178 183
179=cut 184=cut
180 185
181sub cede {
182 $current->ready;
183 &schedule;
184}
185
186=item terminate 186=item terminate [arg...]
187 187
188Terminates the current process. 188Terminates the current process.
189 189
190Future versions of this function will allow result arguments. 190Future versions of this function will allow result arguments.
191 191
192=cut 192=cut
193 193
194sub terminate { 194sub terminate {
195 $current->{status} = [@_];
195 $current->cancel; 196 $current->cancel;
196 &schedule; 197 &schedule;
197 die; # NORETURN 198 die; # NORETURN
198} 199}
199 200
… …
208=over 4 209=over 4
209 210
210=item new Coro \&sub [, @args...] 211=item new Coro \&sub [, @args...]
211 212
212Create a new process and return it. When the sub returns the process 213Create a new process and return it. When the sub returns the process
213automatically terminates. To start the process you must first put it into 214automatically terminates as if C<terminate> with the returned values were
215called. To make the process run you must first put it into the ready queue
214the ready queue by calling the ready method. 216by calling the ready method.
215
216The coderef you submit MUST NOT be a closure that refers to variables
217in an outer scope. This does NOT work. Pass arguments into it instead.
218 217
219=cut 218=cut
220 219
221sub _newcoro { 220sub _newcoro {
222 terminate &{+shift}; 221 terminate &{+shift};
… …
229 }, $class; 228 }, $class;
230} 229}
231 230
232=item $process->ready 231=item $process->ready
233 232
234Put the current process into the ready queue. 233Put the given process into the ready queue.
235 234
236=cut 235=cut
237
238sub ready {
239 push @ready, $_[0];
240}
241 236
242=item $process->cancel 237=item $process->cancel
243 238
244Like C<terminate>, but terminates the specified process instead. 239Like C<terminate>, but terminates the specified process instead.
245 240
246=cut 241=cut
247 242
248sub cancel { 243sub cancel {
249 push @destroy, $_[0]; 244 push @destroy, $_[0];
250 $manager->ready; 245 $manager->ready;
246 &schedule if $current == $_[0];
247}
248
249=item $process->join
250
251Wait until the coroutine terminates and return any values given to the
252C<terminate> function. C<join> can be called multiple times from multiple
253processes.
254
255=cut
256
257sub join {
258 my $self = shift;
259 unless ($self->{status}) {
260 push @{$self->{join}}, $current;
261 &schedule;
262 }
263 wantarray ? @{$self->{status}} : $self->{status}[0];
264}
265
266=item $oldprio = $process->prio($newprio)
267
268Sets (or gets, if the argument is missing) the priority of the
269process. Higher priority processes get run before lower priority
270processes. Priorities are smalled signed integer (currently -4 .. +3),
271that you can refer to using PRIO_xxx constants (use the import tag :prio
272to get then):
273
274 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
275 3 > 1 > 0 > -1 > -3 > -4
276
277 # set priority to HIGH
278 current->prio(PRIO_HIGH);
279
280The idle coroutine ($Coro::idle) always has a lower priority than any
281existing coroutine.
282
283Changing the priority of the current process will take effect immediately,
284but changing the priority of processes in the ready queue (but not
285running) will only take effect after the next schedule (of that
286process). This is a bug that will be fixed in some future version.
287
288=cut
289
290sub prio {
291 my $old = $_[0]{prio};
292 $_[0]{prio} = $_[1] if @_ > 1;
293 $old;
294}
295
296=item $newprio = $process->nice($change)
297
298Similar to C<prio>, but subtract the given value from the priority (i.e.
299higher values mean lower priority, just as in unix).
300
301=cut
302
303sub nice {
304 $_[0]{prio} -= $_[1];
305}
306
307=item $olddesc = $process->desc($newdesc)
308
309Sets (or gets in case the argument is missing) the description for this
310process. This is just a free-form string you can associate with a process.
311
312=cut
313
314sub desc {
315 my $old = $_[0]{desc};
316 $_[0]{desc} = $_[1] if @_ > 1;
317 $old;
251} 318}
252 319
253=back 320=back
254 321
255=cut 322=cut
256 323
2571; 3241;
258 325
259=head1 BUGS/LIMITATIONS 326=head1 BUGS/LIMITATIONS
260 327
261 - could be faster, especially when the core would introduce special 328 - you must make very sure that no coro is still active on global destruction.
262 support for coroutines (like it does for threads). 329 very bad things might happen otherwise (usually segfaults).
263 - there is still a memleak on coroutine termination that I could not
264 identify. Could be as small as a single SV.
265 - this module is not well-tested.
266 - if variables or arguments "disappear" (become undef) or become
267 corrupted please contact the author so he cen iron out the
268 remaining bugs.
269 - this module is not thread-safe. You must only ever use this module from 330 - this module is not thread-safe. You must only ever use this module from
270 the same thread (this requirement might be loosened in the future to 331 the same thread (this requirement might be loosened in the future to
271 allow per-thread schedulers, but Coro::State does not yet allow this). 332 allow per-thread schedulers, but Coro::State does not yet allow this).
272 333
273=head1 SEE ALSO 334=head1 SEE ALSO

Diff Legend

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