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

Comparing Coro/Coro.pm (file contents):
Revision 1.30 by root, Sat Aug 11 19:59:19 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.45; 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 138
123# static methods. not really. 139# static methods. not really.
… …
165ready 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
166current "timeslice" to other coroutines of the same or higher priority. 182current "timeslice" to other coroutines of the same or higher priority.
167 183
168=cut 184=cut
169 185
170=item terminate 186=item terminate [arg...]
171 187
172Terminates the current process. 188Terminates the current process.
173 189
174Future versions of this function will allow result arguments. 190Future versions of this function will allow result arguments.
175 191
176=cut 192=cut
177 193
178sub terminate { 194sub terminate {
195 $current->{status} = [@_];
179 $current->cancel; 196 $current->cancel;
180 &schedule; 197 &schedule;
181 die; # NORETURN 198 die; # NORETURN
182} 199}
183 200
… …
192=over 4 209=over 4
193 210
194=item new Coro \&sub [, @args...] 211=item new Coro \&sub [, @args...]
195 212
196Create 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
197automatically 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
198the ready queue by calling the ready method. 216by calling the ready method.
199
200The coderef you submit MUST NOT be a closure that refers to variables
201in an outer scope. This does NOT work. Pass arguments into it instead.
202 217
203=cut 218=cut
204 219
205sub _newcoro { 220sub _newcoro {
206 terminate &{+shift}; 221 terminate &{+shift};
… …
213 }, $class; 228 }, $class;
214} 229}
215 230
216=item $process->ready 231=item $process->ready
217 232
218Put the current process into the ready queue. 233Put the given process into the ready queue.
219 234
220=cut 235=cut
221 236
222=item $process->cancel 237=item $process->cancel
223 238
… …
226=cut 241=cut
227 242
228sub cancel { 243sub cancel {
229 push @destroy, $_[0]; 244 push @destroy, $_[0];
230 $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;
231} 318}
232 319
233=back 320=back
234 321
235=cut 322=cut
236 323
2371; 3241;
238 325
239=head1 BUGS/LIMITATIONS 326=head1 BUGS/LIMITATIONS
240 327
241 - 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.
242 support for coroutines (like it does for threads). 329 very bad things might happen otherwise (usually segfaults).
243 - there is still a memleak on coroutine termination that I could not
244 identify. Could be as small as a single SV.
245 - this module is not well-tested.
246 - if variables or arguments "disappear" (become undef) or become
247 corrupted please contact the author so he cen iron out the
248 remaining bugs.
249 - 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
250 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
251 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).
252 333
253=head1 SEE ALSO 334=head1 SEE ALSO

Diff Legend

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