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

Comparing Coro/Coro.pm (file contents):
Revision 1.25 by root, Wed Jul 25 21:12:57 2001 UTC vs.
Revision 1.38 by root, Wed Oct 3 01:09:56 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 (pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy;
114 &schedule; 130 &schedule;
115 } 131 }
116}; 132};
117
118# we really need priorities...
119my @ready; # the ready queue. hehe, rather broken ;)
120 133
121# static methods. not really. 134# static methods. not really.
122 135
123=head2 STATIC METHODS 136=head2 STATIC METHODS
124 137
155into the ready queue, so calling this function usually means you will 168into the ready queue, so calling this function usually means you will
156never be called again. 169never be called again.
157 170
158=cut 171=cut
159 172
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 173=item cede
169 174
170"Cede" to other processes. This function puts the current process into the 175"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 176ready queue and calls C<schedule>, which has the effect of giving up the
172current "timeslice" to other coroutines of the same or higher priority. 177current "timeslice" to other coroutines of the same or higher priority.
173 178
174=cut 179=cut
175 180
176sub cede { 181=item terminate
182
183Terminates the current process.
184
185Future versions of this function will allow result arguments.
186
187=cut
188
189sub terminate {
177 $current->ready; 190 $current->cancel;
178 &schedule; 191 &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 192 die; # NORETURN
194} 193}
195 194
196=back 195=back
197 196
198# dynamic methods 197# dynamic methods
229 228
230Put the current process into the ready queue. 229Put the current process into the ready queue.
231 230
232=cut 231=cut
233 232
234sub ready { 233=item $process->cancel
234
235Like C<terminate>, but terminates the specified process instead.
236
237=cut
238
239sub cancel {
235 push @ready, $_[0]; 240 push @destroy, $_[0];
241 $manager->ready;
242 &schedule if $current == $_[0];
243}
244
245=item $oldprio = $process->prio($newprio)
246
247Sets the priority of the process. Higher priority processes get run before
248lower priority processes. Priorities are smalled signed integer (currently
249-4 .. +3), that you can refer to using PRIO_xxx constants (use the import
250tag :prio to get then):
251
252 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
253 3 > 1 > 0 > -1 > -3 > -4
254
255 # set priority to HIGH
256 current->prio(PRIO_HIGH);
257
258The idle coroutine ($Coro::idle) always has a lower priority than any
259existing coroutine.
260
261Changing the priority of the current process will take effect immediately,
262but changing the priority of processes in the ready queue (but not
263running) will only take effect after the next schedule (of that
264process). This is a bug that will be fixed in some future version.
265
266=cut
267
268sub prio {
269 my $old = $_[0]{prio};
270 $_[0]{prio} = $_[1] if @_ > 1;
271 $old;
272}
273
274=item $newprio = $process->nice($change)
275
276Similar to C<prio>, but subtract the given value from the priority (i.e.
277higher values mean lower priority, just as in unix).
278
279=cut
280
281sub nice {
282 $_[0]{prio} -= $_[1];
236} 283}
237 284
238=back 285=back
239 286
240=cut 287=cut
241 288
2421; 2891;
243 290
244=head1 BUGS/LIMITATIONS 291=head1 BUGS/LIMITATIONS
245 292
246 - could be faster, especially when the core would introduce special 293 - you must make very sure that no coro is still active on global destruction.
247 support for coroutines (like it does for threads). 294 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 295 - 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 296 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). 297 allow per-thread schedulers, but Coro::State does not yet allow this).
257 298
258=head1 SEE ALSO 299=head1 SEE ALSO
259 300
260L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 301L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
261L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 302L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
262L<Coro::L<Coro::Handle>, L<Coro::Socket>. 303L<Coro::Handle>, L<Coro::Socket>.
263 304
264=head1 AUTHOR 305=head1 AUTHOR
265 306
266 Marc Lehmann <pcg@goof.com> 307 Marc Lehmann <pcg@goof.com>
267 http://www.goof.com/pcg/marc/ 308 http://www.goof.com/pcg/marc/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines