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.35 by root, Mon Sep 24 00:16:30 2001 UTC

… …
36 36
37use Coro::State; 37use Coro::State;
38 38
39use base Exporter; 39use base Exporter;
40 40
41$VERSION = 0.10; 41$VERSION = 0.5;
42 42
43@EXPORT = qw(async cede schedule terminate current); 43@EXPORT = qw(async cede schedule terminate current);
44@EXPORT_OK = qw($current); 44%EXPORT_TAGS = (
45 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
46);
47@EXPORT_OK = @{$EXPORT_TAGS{prio}};
45 48
46{ 49{
47 my @async; 50 my @async;
51 my $init;
48 52
49 # this way of handling attributes simply is NOT scalable ;() 53 # this way of handling attributes simply is NOT scalable ;()
50 sub import { 54 sub import {
51 Coro->export_to_level(1, @_); 55 Coro->export_to_level(1, @_);
52 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 56 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
… …
54 my ($package, $ref) = (shift, shift); 58 my ($package, $ref) = (shift, shift);
55 my @attrs; 59 my @attrs;
56 for (@_) { 60 for (@_) {
57 if ($_ eq "Coro") { 61 if ($_ eq "Coro") {
58 push @async, $ref; 62 push @async, $ref;
63 unless ($init++) {
64 eval q{
65 sub INIT {
66 &async(pop @async) while @async;
67 }
68 };
69 }
59 } else { 70 } else {
60 push @attrs, $_; 71 push @attrs, $_;
61 } 72 }
62 } 73 }
63 return $old ? $old->($package, $ref, @attrs) : @attrs; 74 return $old ? $old->($package, $ref, @attrs) : @attrs;
64 }; 75 };
65 } 76 }
66 77
67 sub INIT {
68 &async(pop @async) while @async;
69 }
70} 78}
71 79
72=item $main 80=item $main
73 81
74This coroutine represents the main program. 82This coroutine represents the main program.
… …
103our $idle = new Coro sub { 111our $idle = new Coro sub {
104 print STDERR "FATAL: deadlock detected\n"; 112 print STDERR "FATAL: deadlock detected\n";
105 exit(51); 113 exit(51);
106}; 114};
107 115
108# we really need priorities...
109my @ready; # the ready queue. hehe, rather broken ;)
110
111# static methods. not really.
112
113=head2 STATIC METHODS
114
115Static methods are actually functions that operate on the current process only.
116
117=over 4
118
119=item async { ... } [@args...]
120
121Create a new asynchronous process and return it's process object
122(usually unused). When the sub returns the new process is automatically
123terminated.
124
125 # create a new coroutine that just prints its arguments
126 async {
127 print "@_\n";
128 } 1,2,3,4;
129
130The coderef you submit MUST NOT be a closure that refers to variables
131in an outer scope. This does NOT work. Pass arguments into it instead.
132
133=cut
134
135sub async(&@) {
136 my $pid = new Coro @_;
137 $pid->ready;
138 $pid;
139}
140
141=item schedule
142
143Calls the scheduler. Please note that the current process will not be put
144into the ready queue, so calling this function usually means you will
145never be called again.
146
147=cut
148
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
158
159"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
161current "timeslice" to other coroutines of the same or higher priority.
162
163=cut
164
165sub cede {
166 $current->ready;
167 &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 116# this coroutine is necessary because a coroutine
179# cannot destroy itself. 117# cannot destroy itself.
180my @destroy; 118my @destroy;
181my $terminate = new Coro sub { 119my $manager = new Coro sub {
182 while() { 120 while() {
183 delete ((pop @destroy)->{_coro_state}) while @destroy; 121 delete ((pop @destroy)->{_coro_state}) while @destroy;
184 &schedule; 122 &schedule;
185 } 123 }
186}; 124};
187 125
126# static methods. not really.
127
128=head2 STATIC METHODS
129
130Static methods are actually functions that operate on the current process only.
131
132=over 4
133
134=item async { ... } [@args...]
135
136Create a new asynchronous process and return it's process object
137(usually unused). When the sub returns the new process is automatically
138terminated.
139
140 # create a new coroutine that just prints its arguments
141 async {
142 print "@_\n";
143 } 1,2,3,4;
144
145The coderef you submit MUST NOT be a closure that refers to variables
146in an outer scope. This does NOT work. Pass arguments into it instead.
147
148=cut
149
150sub async(&@) {
151 my $pid = new Coro @_;
152 $manager->ready; # this ensures that the stack is cloned from the manager
153 $pid->ready;
154 $pid;
155}
156
157=item schedule
158
159Calls the scheduler. Please note that the current process will not be put
160into the ready queue, so calling this function usually means you will
161never be called again.
162
163=cut
164
165=item cede
166
167"Cede" to other processes. This function puts the current process into the
168ready queue and calls C<schedule>, which has the effect of giving up the
169current "timeslice" to other coroutines of the same or higher priority.
170
171=cut
172
173=item terminate
174
175Terminates the current process.
176
177Future versions of this function will allow result arguments.
178
179=cut
180
188sub terminate { 181sub terminate {
189 push @destroy, $current; 182 $current->cancel;
190 $terminate->ready;
191 &schedule; 183 &schedule;
192 # NORETURN 184 die; # NORETURN
193} 185}
194 186
195=back 187=back
196 188
197# dynamic methods 189# dynamic methods
… …
228 220
229Put the current process into the ready queue. 221Put the current process into the ready queue.
230 222
231=cut 223=cut
232 224
233sub ready { 225=item $process->cancel
226
227Like C<terminate>, but terminates the specified process instead.
228
229=cut
230
231sub cancel {
234 push @ready, $_[0]; 232 push @destroy, $_[0];
233 $manager->ready;
234 &schedule if $current == $_[0];
235}
236
237=item $oldprio = $process->prio($newprio)
238
239Sets the priority of the process. Higher priority processes get run before
240lower priority processes. Priorities are smalled signed integer (currently
241-4 .. +3), that you can refer to using PRIO_xxx constants (use the import
242tag :prio to get then):
243
244 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
245 3 > 1 > 0 > -1 > -3 > -4
246
247 # set priority to HIGH
248 current->prio(PRIO_HIGH);
249
250The idle coroutine ($Coro::idle) always has a lower priority than any
251existing coroutine.
252
253Changing the priority of the current process will take effect immediately,
254but changing the priority of processes in the ready queue (but not
255running) will only take effect after the next schedule (of that
256process). This is a bug that will be fixed in some future version.
257
258=cut
259
260sub prio {
261 my $old = $_[0]{prio};
262 $_[0]{prio} = $_[1] if @_ > 1;
263 $old;
264}
265
266=item $newprio = $process->nice($change)
267
268Similar to C<prio>, but subtract the given value from the priority (i.e.
269higher values mean lower priority, just as in unix).
270
271=cut
272
273sub nice {
274 $_[0]{prio} -= $_[1];
235} 275}
236 276
237=back 277=back
238 278
239=cut 279=cut
240 280
2411; 2811;
242 282
243=head1 BUGS/LIMITATIONS 283=head1 BUGS/LIMITATIONS
244 284
245 - could be faster, especially when the core would introduce special 285 - you must make very sure that no coro is still active on global destruction.
246 support for coroutines (like it does for threads). 286 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 287 - 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 288 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). 289 allow per-thread schedulers, but Coro::State does not yet allow this).
256 290
257=head1 SEE ALSO 291=head1 SEE ALSO
258 292
259L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 293L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
260L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 294L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
295L<Coro::Handle>, L<Coro::Socket>.
261 296
262=head1 AUTHOR 297=head1 AUTHOR
263 298
264 Marc Lehmann <pcg@goof.com> 299 Marc Lehmann <pcg@goof.com>
265 http://www.goof.com/pcg/marc/ 300 http://www.goof.com/pcg/marc/

Diff Legend

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