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

Comparing Coro/Coro.pm (file contents):
Revision 1.23 by root, Mon Jul 23 04:23:32 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.10; 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.
… …
103our $idle = new Coro sub { 113our $idle = new Coro sub {
104 print STDERR "FATAL: deadlock detected\n"; 114 print STDERR "FATAL: deadlock detected\n";
105 exit(51); 115 exit(51);
106}; 116};
107 117
108# we really need priorities... 118# this coroutine is necessary because a coroutine
109my @ready; # the ready queue. hehe, rather broken ;) 119# cannot destroy itself.
120my @destroy;
121my $manager;
122$manager = new Coro sub {
123 while() {
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 }
135 &schedule;
136 }
137};
110 138
111# static methods. not really. 139# static methods. not really.
112 140
113=head2 STATIC METHODS 141=head2 STATIC METHODS
114 142
… …
132 160
133=cut 161=cut
134 162
135sub async(&@) { 163sub async(&@) {
136 my $pid = new Coro @_; 164 my $pid = new Coro @_;
165 $manager->ready; # this ensures that the stack is cloned from the manager
137 $pid->ready; 166 $pid->ready;
138 $pid; 167 $pid;
139} 168}
140 169
141=item schedule 170=item schedule
… …
144into the ready queue, so calling this function usually means you will 173into the ready queue, so calling this function usually means you will
145never be called again. 174never be called again.
146 175
147=cut 176=cut
148 177
149my $prev;
150
151sub schedule {
152 # should be done using priorities :(
153 ($prev, $current) = ($current, shift @ready || $idle);
154 Coro::State::transfer($prev, $current);
155}
156
157=item cede 178=item cede
158 179
159"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
160ready 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
161current "timeslice" to other coroutines of the same or higher priority. 182current "timeslice" to other coroutines of the same or higher priority.
162 183
163=cut 184=cut
164 185
165sub 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} = [@_];
166 $current->ready; 196 $current->cancel;
167 &schedule; 197 &schedule;
168}
169
170=item terminate
171
172Terminates the current process.
173
174Future versions of this function will allow result arguments.
175
176=cut
177
178# this coroutine is necessary because a coroutine
179# cannot destroy itself.
180my @destroy;
181my $terminate = new Coro sub {
182 while() {
183 delete ((pop @destroy)->{_coro_state}) while @destroy;
184 &schedule;
185 }
186};
187
188sub terminate {
189 push @destroy, $current;
190 $terminate->ready;
191 &schedule;
192 # NORETURN 198 die; # NORETURN
193} 199}
194 200
195=back 201=back
196 202
197# dynamic methods 203# dynamic methods
… …
203=over 4 209=over 4
204 210
205=item new Coro \&sub [, @args...] 211=item new Coro \&sub [, @args...]
206 212
207Create 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
208automatically terminates. To start the process you must first put it into 214automatically terminates as if C<terminate> with the returned values were
209the 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.
210 217
211The 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
212in 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.
213 220
214=cut 221=cut
… …
224 }, $class; 231 }, $class;
225} 232}
226 233
227=item $process->ready 234=item $process->ready
228 235
229Put the current process into the ready queue. 236Put the given process into the ready queue.
230 237
231=cut 238=cut
232 239
233sub ready { 240=item $process->cancel
241
242Like C<terminate>, but terminates the specified process instead.
243
244=cut
245
246sub cancel {
234 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];
235} 307}
236 308
237=back 309=back
238 310
239=cut 311=cut
240 312
2411; 3131;
242 314
243=head1 BUGS/LIMITATIONS 315=head1 BUGS/LIMITATIONS
244 316
245 - 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.
246 support for coroutines (like it does for threads). 318 very bad things might happen otherwise (usually segfaults).
247 - there is still a memleak on coroutine termination that I could not
248 identify. Could be as small as a single SV.
249 - this module is not well-tested.
250 - if variables or arguments "disappear" (become undef) or become
251 corrupted please contact the author so he cen iron out the
252 remaining bugs.
253 - 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
254 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
255 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).
256 322
257=head1 SEE ALSO 323=head1 SEE ALSO
258 324
259L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 325L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
260L<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>.
261 328
262=head1 AUTHOR 329=head1 AUTHOR
263 330
264 Marc Lehmann <pcg@goof.com> 331 Marc Lehmann <pcg@goof.com>
265 http://www.goof.com/pcg/marc/ 332 http://www.goof.com/pcg/marc/

Diff Legend

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