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.36 by root, Mon Sep 24 01:36:20 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.5;
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...
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 118# this coroutine is necessary because a coroutine
179# cannot destroy itself. 119# cannot destroy itself.
180my @destroy; 120my @destroy;
181my $terminate = new Coro sub { 121my $manager = new Coro sub {
182 while() { 122 while() {
183 delete ((pop @destroy)->{_coro_state}) while @destroy; 123 delete ((pop @destroy)->{_coro_state}) while @destroy;
184 &schedule; 124 &schedule;
185 } 125 }
186}; 126};
187 127
128# static methods. not really.
129
130=head2 STATIC METHODS
131
132Static methods are actually functions that operate on the current process only.
133
134=over 4
135
136=item async { ... } [@args...]
137
138Create a new asynchronous process and return it's process object
139(usually unused). When the sub returns the new process is automatically
140terminated.
141
142 # create a new coroutine that just prints its arguments
143 async {
144 print "@_\n";
145 } 1,2,3,4;
146
147The coderef you submit MUST NOT be a closure that refers to variables
148in an outer scope. This does NOT work. Pass arguments into it instead.
149
150=cut
151
152sub async(&@) {
153 my $pid = new Coro @_;
154 $manager->ready; # this ensures that the stack is cloned from the manager
155 $pid->ready;
156 $pid;
157}
158
159=item schedule
160
161Calls the scheduler. Please note that the current process will not be put
162into the ready queue, so calling this function usually means you will
163never be called again.
164
165=cut
166
167=item cede
168
169"Cede" to other processes. This function puts the current process into the
170ready queue and calls C<schedule>, which has the effect of giving up the
171current "timeslice" to other coroutines of the same or higher priority.
172
173=cut
174
175=item terminate
176
177Terminates the current process.
178
179Future versions of this function will allow result arguments.
180
181=cut
182
188sub terminate { 183sub terminate {
189 push @destroy, $current; 184 $current->cancel;
190 $terminate->ready;
191 &schedule; 185 &schedule;
192 # NORETURN 186 die; # NORETURN
193} 187}
194 188
195=back 189=back
196 190
197# dynamic methods 191# dynamic methods
… …
228 222
229Put the current process into the ready queue. 223Put the current process into the ready queue.
230 224
231=cut 225=cut
232 226
233sub ready { 227=item $process->cancel
228
229Like C<terminate>, but terminates the specified process instead.
230
231=cut
232
233sub cancel {
234 push @ready, $_[0]; 234 push @destroy, $_[0];
235 $manager->ready;
236 &schedule if $current == $_[0];
237}
238
239=item $oldprio = $process->prio($newprio)
240
241Sets the priority of the process. Higher priority processes get run before
242lower priority processes. Priorities are smalled signed integer (currently
243-4 .. +3), that you can refer to using PRIO_xxx constants (use the import
244tag :prio to get then):
245
246 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
247 3 > 1 > 0 > -1 > -3 > -4
248
249 # set priority to HIGH
250 current->prio(PRIO_HIGH);
251
252The idle coroutine ($Coro::idle) always has a lower priority than any
253existing coroutine.
254
255Changing the priority of the current process will take effect immediately,
256but changing the priority of processes in the ready queue (but not
257running) will only take effect after the next schedule (of that
258process). This is a bug that will be fixed in some future version.
259
260=cut
261
262sub prio {
263 my $old = $_[0]{prio};
264 $_[0]{prio} = $_[1] if @_ > 1;
265 $old;
266}
267
268=item $newprio = $process->nice($change)
269
270Similar to C<prio>, but subtract the given value from the priority (i.e.
271higher values mean lower priority, just as in unix).
272
273=cut
274
275sub nice {
276 $_[0]{prio} -= $_[1];
235} 277}
236 278
237=back 279=back
238 280
239=cut 281=cut
240 282
2411; 2831;
242 284
243=head1 BUGS/LIMITATIONS 285=head1 BUGS/LIMITATIONS
244 286
245 - could be faster, especially when the core would introduce special 287 - you must make very sure that no coro is still active on global destruction.
246 support for coroutines (like it does for threads). 288 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 289 - 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 290 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). 291 allow per-thread schedulers, but Coro::State does not yet allow this).
256 292
257=head1 SEE ALSO 293=head1 SEE ALSO
258 294
259L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 295L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
260L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 296L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
297L<Coro::Handle>, L<Coro::Socket>.
261 298
262=head1 AUTHOR 299=head1 AUTHOR
263 300
264 Marc Lehmann <pcg@goof.com> 301 Marc Lehmann <pcg@goof.com>
265 http://www.goof.com/pcg/marc/ 302 http://www.goof.com/pcg/marc/

Diff Legend

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