| … | |
… | |
| 14 | |
14 | |
| 15 | sub some_func : Coro { |
15 | sub some_func : Coro { |
| 16 | # some more async code |
16 | # some more async code |
| 17 | } |
17 | } |
| 18 | |
18 | |
| 19 | yield; |
19 | cede; |
| 20 | |
20 | |
| 21 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
| 22 | |
22 | |
| 23 | This module collection manages coroutines. Coroutines are similar to |
23 | This module collection manages coroutines. Coroutines are similar to |
| 24 | Threads but don't run in parallel. |
24 | threads but don't run in parallel. |
| 25 | |
|
|
| 26 | This module is still experimental, see the BUGS section below. |
|
|
| 27 | |
25 | |
| 28 | In this module, coroutines are defined as "callchain + lexical variables |
26 | In this module, coroutines are defined as "callchain + lexical variables |
| 29 | + @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's |
27 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
| 30 | own set of lexicals and it's own set of perl's most important global |
28 | callchain, it's own set of lexicals and it's own set of perl's most |
| 31 | variables. |
29 | important global variables. |
| 32 | |
30 | |
| 33 | =cut |
31 | =cut |
| 34 | |
32 | |
| 35 | package Coro; |
33 | package Coro; |
| 36 | |
34 | |
|
|
35 | BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") } |
|
|
36 | |
| 37 | use Coro::State; |
37 | use Coro::State; |
| 38 | |
38 | |
|
|
39 | use vars qw($idle $main $current); |
|
|
40 | |
| 39 | use base Exporter; |
41 | use base Exporter; |
| 40 | |
42 | |
| 41 | $VERSION = 0.10; |
43 | $VERSION = '1.0'; |
| 42 | |
44 | |
| 43 | @EXPORT = qw(async yield 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 | } |
|
|
81 | |
|
|
82 | =over 4 |
| 71 | |
83 | |
| 72 | =item $main |
84 | =item $main |
| 73 | |
85 | |
| 74 | This coroutine represents the main program. |
86 | This coroutine represents the main program. |
| 75 | |
87 | |
| 76 | =cut |
88 | =cut |
| 77 | |
89 | |
| 78 | our $main = new Coro; |
90 | $main = new Coro; |
| 79 | |
91 | |
| 80 | =item $current (or as function: current) |
92 | =item $current (or as function: current) |
| 81 | |
93 | |
| 82 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
94 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
| 83 | |
95 | |
| … | |
… | |
| 86 | # maybe some other module used Coro::Specific before... |
98 | # maybe some other module used Coro::Specific before... |
| 87 | if ($current) { |
99 | if ($current) { |
| 88 | $main->{specific} = $current->{specific}; |
100 | $main->{specific} = $current->{specific}; |
| 89 | } |
101 | } |
| 90 | |
102 | |
| 91 | our $current = $main; |
103 | $current = $main; |
| 92 | |
104 | |
| 93 | sub current() { $current } |
105 | sub current() { $current } |
| 94 | |
106 | |
| 95 | =item $idle |
107 | =item $idle |
| 96 | |
108 | |
| … | |
… | |
| 98 | implementation prints "FATAL: deadlock detected" and exits. |
110 | implementation prints "FATAL: deadlock detected" and exits. |
| 99 | |
111 | |
| 100 | =cut |
112 | =cut |
| 101 | |
113 | |
| 102 | # should be done using priorities :( |
114 | # should be done using priorities :( |
| 103 | our $idle = new Coro sub { |
115 | $idle = new Coro sub { |
| 104 | print STDERR "FATAL: deadlock detected\n"; |
116 | print STDERR "FATAL: deadlock detected\n"; |
| 105 | exit(51); |
117 | exit(51); |
| 106 | }; |
118 | }; |
| 107 | |
119 | |
| 108 | # we really need priorities... |
120 | # this coroutine is necessary because a coroutine |
| 109 | my @ready; # the ready queue. hehe, rather broken ;) |
121 | # cannot destroy itself. |
|
|
122 | my @destroy; |
|
|
123 | my $manager; |
|
|
124 | $manager = new Coro sub { |
|
|
125 | while () { |
|
|
126 | # by overwriting the state object with the manager we destroy it |
|
|
127 | # while still being able to schedule this coroutine (in case it has |
|
|
128 | # been readied multiple times. this is harmless since the manager |
|
|
129 | # can be called as many times as neccessary and will always |
|
|
130 | # remove itself from the runqueue |
|
|
131 | while (@destroy) { |
|
|
132 | my $coro = pop @destroy; |
|
|
133 | $coro->{status} ||= []; |
|
|
134 | $_->ready for @{delete $coro->{join} || []}; |
|
|
135 | |
|
|
136 | # the next line destroys the _coro_state, but keeps the |
|
|
137 | # process itself intact (we basically make it a zombie |
|
|
138 | # process that always runs the manager thread, so it's possible |
|
|
139 | # to transfer() to this process). |
|
|
140 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
141 | } |
|
|
142 | &schedule; |
|
|
143 | } |
|
|
144 | }; |
| 110 | |
145 | |
| 111 | # static methods. not really. |
146 | # static methods. not really. |
|
|
147 | |
|
|
148 | =back |
| 112 | |
149 | |
| 113 | =head2 STATIC METHODS |
150 | =head2 STATIC METHODS |
| 114 | |
151 | |
| 115 | Static methods are actually functions that operate on the current process only. |
152 | Static methods are actually functions that operate on the current process only. |
| 116 | |
153 | |
| … | |
… | |
| 125 | # create a new coroutine that just prints its arguments |
162 | # create a new coroutine that just prints its arguments |
| 126 | async { |
163 | async { |
| 127 | print "@_\n"; |
164 | print "@_\n"; |
| 128 | } 1,2,3,4; |
165 | } 1,2,3,4; |
| 129 | |
166 | |
| 130 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
| 131 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
| 132 | |
|
|
| 133 | =cut |
167 | =cut |
| 134 | |
168 | |
| 135 | sub async(&@) { |
169 | sub async(&@) { |
| 136 | my $pid = new Coro @_; |
170 | my $pid = new Coro @_; |
|
|
171 | $manager->ready; # this ensures that the stack is cloned from the manager |
| 137 | $pid->ready; |
172 | $pid->ready; |
| 138 | $pid; |
173 | $pid; |
| 139 | } |
174 | } |
| 140 | |
175 | |
| 141 | =item schedule |
176 | =item schedule |
| … | |
… | |
| 144 | into the ready queue, so calling this function usually means you will |
179 | into the ready queue, so calling this function usually means you will |
| 145 | never be called again. |
180 | never be called again. |
| 146 | |
181 | |
| 147 | =cut |
182 | =cut |
| 148 | |
183 | |
| 149 | my $prev; |
|
|
| 150 | |
|
|
| 151 | sub schedule { |
|
|
| 152 | # should be done using priorities :( |
|
|
| 153 | ($prev, $current) = ($current, shift @ready || $idle); |
|
|
| 154 | Coro::State::transfer($prev, $current); |
|
|
| 155 | } |
|
|
| 156 | |
|
|
| 157 | =item yield |
184 | =item cede |
| 158 | |
185 | |
| 159 | Yield to other processes. This function puts the current process into the |
186 | "Cede" to other processes. This function puts the current process into the |
| 160 | ready queue and calls C<schedule>. |
187 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
188 | current "timeslice" to other coroutines of the same or higher priority. |
| 161 | |
189 | |
| 162 | =cut |
190 | =cut |
| 163 | |
191 | |
| 164 | sub yield { |
|
|
| 165 | $current->ready; |
|
|
| 166 | &schedule; |
|
|
| 167 | } |
|
|
| 168 | |
|
|
| 169 | =item terminate |
192 | =item terminate [arg...] |
| 170 | |
193 | |
| 171 | Terminates the current process. |
194 | Terminates the current process with the given status values (see L<cancel>). |
| 172 | |
|
|
| 173 | Future versions of this function will allow result arguments. |
|
|
| 174 | |
195 | |
| 175 | =cut |
196 | =cut |
| 176 | |
197 | |
| 177 | sub terminate { |
198 | sub terminate { |
| 178 | $current->{_results} = [@_]; |
199 | $current->cancel (@_); |
| 179 | &schedule; |
|
|
| 180 | } |
200 | } |
| 181 | |
201 | |
| 182 | =back |
202 | =back |
| 183 | |
203 | |
| 184 | # dynamic methods |
204 | # dynamic methods |
| … | |
… | |
| 190 | =over 4 |
210 | =over 4 |
| 191 | |
211 | |
| 192 | =item new Coro \&sub [, @args...] |
212 | =item new Coro \&sub [, @args...] |
| 193 | |
213 | |
| 194 | Create a new process and return it. When the sub returns the process |
214 | Create a new process and return it. When the sub returns the process |
| 195 | automatically terminates. To start the process you must first put it into |
215 | automatically terminates as if C<terminate> with the returned values were |
|
|
216 | called. To make the process run you must first put it into the ready queue |
| 196 | the ready queue by calling the ready method. |
217 | by calling the ready method. |
| 197 | |
|
|
| 198 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
| 199 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
| 200 | |
218 | |
| 201 | =cut |
219 | =cut |
| 202 | |
220 | |
| 203 | sub _newcoro { |
221 | sub _newcoro { |
| 204 | terminate &{+shift}; |
222 | terminate &{+shift}; |
| … | |
… | |
| 211 | }, $class; |
229 | }, $class; |
| 212 | } |
230 | } |
| 213 | |
231 | |
| 214 | =item $process->ready |
232 | =item $process->ready |
| 215 | |
233 | |
| 216 | Put the current process into the ready queue. |
234 | Put the given process into the ready queue. |
| 217 | |
235 | |
| 218 | =cut |
236 | =cut |
| 219 | |
237 | |
| 220 | sub ready { |
238 | =item $process->cancel (arg...) |
| 221 | push @ready, $_[0]; |
239 | |
|
|
240 | Temrinates the given process and makes it return the given arguments as |
|
|
241 | status (default: the empty list). |
|
|
242 | |
|
|
243 | =cut |
|
|
244 | |
|
|
245 | sub cancel { |
|
|
246 | my $self = shift; |
|
|
247 | $self->{status} = [@_]; |
|
|
248 | push @destroy, $self; |
|
|
249 | $manager->ready; |
|
|
250 | &schedule if $current == $self; |
|
|
251 | } |
|
|
252 | |
|
|
253 | =item $process->join |
|
|
254 | |
|
|
255 | Wait until the coroutine terminates and return any values given to the |
|
|
256 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
|
|
257 | from multiple processes. |
|
|
258 | |
|
|
259 | =cut |
|
|
260 | |
|
|
261 | sub join { |
|
|
262 | my $self = shift; |
|
|
263 | unless ($self->{status}) { |
|
|
264 | push @{$self->{join}}, $current; |
|
|
265 | &schedule; |
|
|
266 | } |
|
|
267 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
|
|
268 | } |
|
|
269 | |
|
|
270 | =item $oldprio = $process->prio($newprio) |
|
|
271 | |
|
|
272 | Sets (or gets, if the argument is missing) the priority of the |
|
|
273 | process. Higher priority processes get run before lower priority |
|
|
274 | processes. Priorities are small signed integers (currently -4 .. +3), |
|
|
275 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
|
|
276 | to get then): |
|
|
277 | |
|
|
278 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
|
|
279 | 3 > 1 > 0 > -1 > -3 > -4 |
|
|
280 | |
|
|
281 | # set priority to HIGH |
|
|
282 | current->prio(PRIO_HIGH); |
|
|
283 | |
|
|
284 | The idle coroutine ($Coro::idle) always has a lower priority than any |
|
|
285 | existing coroutine. |
|
|
286 | |
|
|
287 | Changing the priority of the current process will take effect immediately, |
|
|
288 | but changing the priority of processes in the ready queue (but not |
|
|
289 | running) will only take effect after the next schedule (of that |
|
|
290 | process). This is a bug that will be fixed in some future version. |
|
|
291 | |
|
|
292 | =cut |
|
|
293 | |
|
|
294 | sub prio { |
|
|
295 | my $old = $_[0]{prio}; |
|
|
296 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
297 | $old; |
|
|
298 | } |
|
|
299 | |
|
|
300 | =item $newprio = $process->nice($change) |
|
|
301 | |
|
|
302 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
|
|
303 | higher values mean lower priority, just as in unix). |
|
|
304 | |
|
|
305 | =cut |
|
|
306 | |
|
|
307 | sub nice { |
|
|
308 | $_[0]{prio} -= $_[1]; |
|
|
309 | } |
|
|
310 | |
|
|
311 | =item $olddesc = $process->desc($newdesc) |
|
|
312 | |
|
|
313 | Sets (or gets in case the argument is missing) the description for this |
|
|
314 | process. This is just a free-form string you can associate with a process. |
|
|
315 | |
|
|
316 | =cut |
|
|
317 | |
|
|
318 | sub desc { |
|
|
319 | my $old = $_[0]{desc}; |
|
|
320 | $_[0]{desc} = $_[1] if @_ > 1; |
|
|
321 | $old; |
| 222 | } |
322 | } |
| 223 | |
323 | |
| 224 | =back |
324 | =back |
| 225 | |
325 | |
| 226 | =cut |
326 | =cut |
| 227 | |
327 | |
| 228 | 1; |
328 | 1; |
| 229 | |
329 | |
| 230 | =head1 BUGS/LIMITATIONS |
330 | =head1 BUGS/LIMITATIONS |
| 231 | |
331 | |
| 232 | - could be faster, especially when the core would introduce special |
332 | - you must make very sure that no coro is still active on global |
| 233 | support for coroutines (like it does for threads). |
333 | destruction. very bad things might happen otherwise (usually segfaults). |
| 234 | - there is still a memleak on coroutine termination that I could not |
334 | |
| 235 | identify. Could be as small as a single SV. |
|
|
| 236 | - this module is not well-tested. |
|
|
| 237 | - if variables or arguments "disappear" (become undef) or become |
|
|
| 238 | corrupted please contact the author so he cen iron out the |
|
|
| 239 | remaining bugs. |
|
|
| 240 | - this module is not thread-safe. You must only ever use this module from |
335 | - this module is not thread-safe. You should only ever use this module |
| 241 | the same thread (this requirement might be loosened in the future to |
336 | from the same thread (this requirement might be losened in the future |
| 242 | allow per-thread schedulers, but Coro::State does not yet allow this). |
337 | to allow per-thread schedulers, but Coro::State does not yet allow |
|
|
338 | this). |
| 243 | |
339 | |
| 244 | =head1 SEE ALSO |
340 | =head1 SEE ALSO |
| 245 | |
341 | |
| 246 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
342 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
| 247 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. |
343 | L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>, |
|
|
344 | L<Coro::Handle>, L<Coro::RWLock>, L<Coro::Socket>. |
| 248 | |
345 | |
| 249 | =head1 AUTHOR |
346 | =head1 AUTHOR |
| 250 | |
347 | |
| 251 | Marc Lehmann <pcg@goof.com> |
348 | Marc Lehmann <pcg@goof.com> |
| 252 | http://www.goof.com/pcg/marc/ |
349 | http://www.goof.com/pcg/marc/ |
