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

Comparing Coro/Coro.pm (file contents):
Revision 1.24 by root, Wed Jul 25 04:14:37 2001 UTC vs.
Revision 1.40 by root, Sun Oct 28 17:00:05 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.12; 43$VERSION = 0.51;
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;
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}
71 81
72=item $main 82=item $main
73 83
74This coroutine represents the main program. 84This coroutine represents the main program.
… …
106}; 116};
107 117
108# this coroutine is necessary because a coroutine 118# this coroutine is necessary because a coroutine
109# cannot destroy itself. 119# cannot destroy itself.
110my @destroy; 120my @destroy;
121my $manager;
111my $manager = new Coro sub { 122$manager = new Coro sub {
112 while() { 123 while() {
113 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 }
114 &schedule; 135 &schedule;
115 } 136 }
116}; 137};
117
118# we really need priorities...
119my @ready; # the ready queue. hehe, rather broken ;)
120 138
121# static methods. not really. 139# static methods. not really.
122 140
123=head2 STATIC METHODS 141=head2 STATIC METHODS
124 142
… …
155into the ready queue, so calling this function usually means you will 173into the ready queue, so calling this function usually means you will
156never be called again. 174never be called again.
157 175
158=cut 176=cut
159 177
160my $prev;
161
162sub schedule {
163 # should be done using priorities :(
164 ($prev, $current) = ($current, shift @ready || $idle);
165 Coro::State::transfer($prev, $current);
166}
167
168=item cede 178=item cede
169 179
170"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
171ready 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
172current "timeslice" to other coroutines of the same or higher priority. 182current "timeslice" to other coroutines of the same or higher priority.
173 183
174=cut 184=cut
175 185
176sub cede { 186=item terminate [arg...]
187
188Terminates the current process.
189
190Future versions of this function will allow result arguments.
191
192=cut
193
194sub terminate {
195 $current->{status} = [@_];
177 $current->ready; 196 $current->cancel;
178 &schedule; 197 &schedule;
179}
180
181=item terminate
182
183Terminates the current process.
184
185Future versions of this function will allow result arguments.
186
187=cut
188
189sub terminate {
190 push @destroy, $current;
191 $manager->ready;
192 &schedule;
193 # NORETURN 198 die; # NORETURN
194} 199}
195 200
196=back 201=back
197 202
198# dynamic methods 203# dynamic methods
… …
204=over 4 209=over 4
205 210
206=item new Coro \&sub [, @args...] 211=item new Coro \&sub [, @args...]
207 212
208Create 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
209automatically terminates. To start the process you must first put it into 214automatically terminates as if C<terminate> with the returned values were
210the ready queue by calling the ready method. 215called. To start the process you must first put it into the ready queue by
216calling the ready method.
211 217
212The coderef you submit MUST NOT be a closure that refers to variables 218The coderef you submit MUST NOT be a closure that refers to variables
213in an outer scope. This does NOT work. Pass arguments into it instead. 219in an outer scope. This does NOT work. Pass arguments into it instead.
214 220
215=cut 221=cut
… …
225 }, $class; 231 }, $class;
226} 232}
227 233
228=item $process->ready 234=item $process->ready
229 235
230Put the current process into the ready queue. 236Put the given process into the ready queue.
231 237
232=cut 238=cut
233 239
234sub ready { 240=item $process->cancel
241
242Like C<terminate>, but terminates the specified process instead.
243
244=cut
245
246sub cancel {
235 push @ready, $_[0]; 247 push @destroy, $_[0];
248 $manager->ready;
249 &schedule if $current == $_[0];
250}
251
252=item $process->join
253
254Wait until the coroutine terminates and return any values given to the
255C<terminate> function. C<join> can be called multiple times from multiple
256processes.
257
258=cut
259
260sub join {
261 my $self = shift;
262 unless ($self->{status}) {
263 push @{$self->{join}}, $current;
264 &schedule;
265 }
266 wantarray ? @{$self->{status}} : $self->{status}[0];
267}
268
269=item $oldprio = $process->prio($newprio)
270
271Sets the priority of the process. Higher priority processes get run before
272lower priority processes. Priorities are smalled signed integer (currently
273-4 .. +3), that you can refer to using PRIO_xxx constants (use the import
274tag :prio to get then):
275
276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277 3 > 1 > 0 > -1 > -3 > -4
278
279 # set priority to HIGH
280 current->prio(PRIO_HIGH);
281
282The idle coroutine ($Coro::idle) always has a lower priority than any
283existing coroutine.
284
285Changing the priority of the current process will take effect immediately,
286but changing the priority of processes in the ready queue (but not
287running) will only take effect after the next schedule (of that
288process). This is a bug that will be fixed in some future version.
289
290=cut
291
292sub prio {
293 my $old = $_[0]{prio};
294 $_[0]{prio} = $_[1] if @_ > 1;
295 $old;
296}
297
298=item $newprio = $process->nice($change)
299
300Similar to C<prio>, but subtract the given value from the priority (i.e.
301higher values mean lower priority, just as in unix).
302
303=cut
304
305sub nice {
306 $_[0]{prio} -= $_[1];
236} 307}
237 308
238=back 309=back
239 310
240=cut 311=cut
241 312
2421; 3131;
243 314
244=head1 BUGS/LIMITATIONS 315=head1 BUGS/LIMITATIONS
245 316
246 - could be faster, especially when the core would introduce special 317 - you must make very sure that no coro is still active on global destruction.
247 support for coroutines (like it does for threads). 318 very bad things might happen otherwise (usually segfaults).
248 - there is still a memleak on coroutine termination that I could not
249 identify. Could be as small as a single SV.
250 - this module is not well-tested.
251 - if variables or arguments "disappear" (become undef) or become
252 corrupted please contact the author so he cen iron out the
253 remaining bugs.
254 - this module is not thread-safe. You must only ever use this module from 319 - this module is not thread-safe. You must only ever use this module from
255 the same thread (this requirement might be loosened in the future to 320 the same thread (this requirement might be loosened in the future to
256 allow per-thread schedulers, but Coro::State does not yet allow this). 321 allow per-thread schedulers, but Coro::State does not yet allow this).
257 322
258=head1 SEE ALSO 323=head1 SEE ALSO
259 324
260L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 325L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
261L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 326L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
327L<Coro::Handle>, L<Coro::Socket>.
262 328
263=head1 AUTHOR 329=head1 AUTHOR
264 330
265 Marc Lehmann <pcg@goof.com> 331 Marc Lehmann <pcg@goof.com>
266 http://www.goof.com/pcg/marc/ 332 http://www.goof.com/pcg/marc/

Diff Legend

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