| … | |
… | |
| 19 | cede; |
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 + C stack), that is, a coroutine has it's own |
27 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
| 30 | callchain, it's own set of lexicals and it's own set of perl's most |
28 | callchain, it's own set of lexicals and it's own set of perl's most |
| 31 | important global variables. |
29 | important global variables. |
| 32 | |
30 | |
| 33 | =cut |
31 | =cut |
| 34 | |
32 | |
| 35 | package Coro; |
33 | package Coro; |
| 36 | |
34 | |
|
|
35 | use strict; |
|
|
36 | no warnings "uninitialized"; |
|
|
37 | |
| 37 | use Coro::State; |
38 | use Coro::State; |
| 38 | |
39 | |
| 39 | use base Exporter; |
40 | use base Exporter::; |
| 40 | |
41 | |
| 41 | $VERSION = 0.49; |
42 | our $idle; # idle coroutine |
|
|
43 | our $main; # main coroutine |
|
|
44 | our $current; # current coroutine |
| 42 | |
45 | |
|
|
46 | our $VERSION = '2.5'; |
|
|
47 | |
| 43 | @EXPORT = qw(async cede schedule terminate current); |
48 | our @EXPORT = qw(async cede schedule terminate current); |
| 44 | %EXPORT_TAGS = ( |
49 | our %EXPORT_TAGS = ( |
| 45 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
| 46 | ); |
51 | ); |
| 47 | @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
52 | our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
| 48 | |
53 | |
| 49 | { |
54 | { |
| 50 | my @async; |
55 | my @async; |
| 51 | my $init; |
56 | my $init; |
| 52 | |
57 | |
| 53 | # this way of handling attributes simply is NOT scalable ;() |
58 | # this way of handling attributes simply is NOT scalable ;() |
| 54 | sub import { |
59 | sub import { |
|
|
60 | no strict 'refs'; |
|
|
61 | |
| 55 | Coro->export_to_level(1, @_); |
62 | Coro->export_to_level(1, @_); |
|
|
63 | |
| 56 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
64 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
| 57 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
65 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
| 58 | my ($package, $ref) = (shift, shift); |
66 | my ($package, $ref) = (shift, shift); |
| 59 | my @attrs; |
67 | my @attrs; |
| 60 | for (@_) { |
68 | for (@_) { |
| … | |
… | |
| 75 | }; |
83 | }; |
| 76 | } |
84 | } |
| 77 | |
85 | |
| 78 | } |
86 | } |
| 79 | |
87 | |
|
|
88 | =over 4 |
|
|
89 | |
| 80 | =item $main |
90 | =item $main |
| 81 | |
91 | |
| 82 | This coroutine represents the main program. |
92 | This coroutine represents the main program. |
| 83 | |
93 | |
| 84 | =cut |
94 | =cut |
| 85 | |
95 | |
| 86 | our $main = new Coro; |
96 | $main = new Coro; |
| 87 | |
97 | |
| 88 | =item $current (or as function: current) |
98 | =item $current (or as function: current) |
| 89 | |
99 | |
| 90 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
100 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
| 91 | |
101 | |
| … | |
… | |
| 94 | # maybe some other module used Coro::Specific before... |
104 | # maybe some other module used Coro::Specific before... |
| 95 | if ($current) { |
105 | if ($current) { |
| 96 | $main->{specific} = $current->{specific}; |
106 | $main->{specific} = $current->{specific}; |
| 97 | } |
107 | } |
| 98 | |
108 | |
| 99 | our $current = $main; |
109 | $current = $main; |
| 100 | |
110 | |
| 101 | sub current() { $current } |
111 | sub current() { $current } |
| 102 | |
112 | |
| 103 | =item $idle |
113 | =item $idle |
| 104 | |
114 | |
| … | |
… | |
| 106 | implementation prints "FATAL: deadlock detected" and exits. |
116 | implementation prints "FATAL: deadlock detected" and exits. |
| 107 | |
117 | |
| 108 | =cut |
118 | =cut |
| 109 | |
119 | |
| 110 | # should be done using priorities :( |
120 | # should be done using priorities :( |
| 111 | our $idle = new Coro sub { |
121 | $idle = new Coro sub { |
| 112 | print STDERR "FATAL: deadlock detected\n"; |
122 | print STDERR "FATAL: deadlock detected\n"; |
| 113 | exit(51); |
123 | exit(51); |
| 114 | }; |
124 | }; |
| 115 | |
125 | |
| 116 | # this coroutine is necessary because a coroutine |
126 | # this coroutine is necessary because a coroutine |
| 117 | # cannot destroy itself. |
127 | # cannot destroy itself. |
| 118 | my @destroy; |
128 | my @destroy; |
|
|
129 | my $manager; |
| 119 | my $manager = new Coro sub { |
130 | $manager = new Coro sub { |
| 120 | while() { |
131 | while () { |
| 121 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
132 | # by overwriting the state object with the manager we destroy it |
|
|
133 | # while still being able to schedule this coroutine (in case it has |
|
|
134 | # been readied multiple times. this is harmless since the manager |
|
|
135 | # can be called as many times as neccessary and will always |
|
|
136 | # remove itself from the runqueue |
|
|
137 | while (@destroy) { |
|
|
138 | my $coro = pop @destroy; |
|
|
139 | $coro->{status} ||= []; |
|
|
140 | $_->ready for @{delete $coro->{join} || []}; |
|
|
141 | |
|
|
142 | # the next line destroys the _coro_state, but keeps the |
|
|
143 | # process itself intact (we basically make it a zombie |
|
|
144 | # process that always runs the manager thread, so it's possible |
|
|
145 | # to transfer() to this process). |
|
|
146 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
147 | } |
| 122 | &schedule; |
148 | &schedule; |
| 123 | } |
149 | } |
| 124 | }; |
150 | }; |
| 125 | |
151 | |
| 126 | # static methods. not really. |
152 | # static methods. not really. |
| 127 | |
153 | |
|
|
154 | =back |
|
|
155 | |
| 128 | =head2 STATIC METHODS |
156 | =head2 STATIC METHODS |
| 129 | |
157 | |
| 130 | Static methods are actually functions that operate on the current process only. |
158 | Static methods are actually functions that operate on the current process only. |
| 131 | |
159 | |
| 132 | =over 4 |
160 | =over 4 |
| … | |
… | |
| 134 | =item async { ... } [@args...] |
162 | =item async { ... } [@args...] |
| 135 | |
163 | |
| 136 | Create a new asynchronous process and return it's process object |
164 | Create a new asynchronous process and return it's process object |
| 137 | (usually unused). When the sub returns the new process is automatically |
165 | (usually unused). When the sub returns the new process is automatically |
| 138 | terminated. |
166 | terminated. |
|
|
167 | |
|
|
168 | When the coroutine dies, the program will exit, just as in the main |
|
|
169 | program. |
| 139 | |
170 | |
| 140 | # create a new coroutine that just prints its arguments |
171 | # create a new coroutine that just prints its arguments |
| 141 | async { |
172 | async { |
| 142 | print "@_\n"; |
173 | print "@_\n"; |
| 143 | } 1,2,3,4; |
174 | } 1,2,3,4; |
| 144 | |
|
|
| 145 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
| 146 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
| 147 | |
175 | |
| 148 | =cut |
176 | =cut |
| 149 | |
177 | |
| 150 | sub async(&@) { |
178 | sub async(&@) { |
| 151 | my $pid = new Coro @_; |
179 | my $pid = new Coro @_; |
| … | |
… | |
| 168 | ready queue and calls C<schedule>, which has the effect of giving up the |
196 | ready queue and calls C<schedule>, which has the effect of giving up the |
| 169 | current "timeslice" to other coroutines of the same or higher priority. |
197 | current "timeslice" to other coroutines of the same or higher priority. |
| 170 | |
198 | |
| 171 | =cut |
199 | =cut |
| 172 | |
200 | |
| 173 | =item terminate |
201 | =item terminate [arg...] |
| 174 | |
202 | |
| 175 | Terminates the current process. |
203 | Terminates the current process with the given status values (see L<cancel>). |
| 176 | |
|
|
| 177 | Future versions of this function will allow result arguments. |
|
|
| 178 | |
204 | |
| 179 | =cut |
205 | =cut |
| 180 | |
206 | |
| 181 | sub terminate { |
207 | sub terminate { |
| 182 | $current->cancel; |
208 | $current->cancel (@_); |
| 183 | &schedule; |
|
|
| 184 | die; # NORETURN |
|
|
| 185 | } |
209 | } |
| 186 | |
210 | |
| 187 | =back |
211 | =back |
| 188 | |
212 | |
| 189 | # dynamic methods |
213 | # dynamic methods |
| … | |
… | |
| 195 | =over 4 |
219 | =over 4 |
| 196 | |
220 | |
| 197 | =item new Coro \&sub [, @args...] |
221 | =item new Coro \&sub [, @args...] |
| 198 | |
222 | |
| 199 | Create a new process and return it. When the sub returns the process |
223 | Create a new process and return it. When the sub returns the process |
| 200 | automatically terminates. To start the process you must first put it into |
224 | automatically terminates as if C<terminate> with the returned values were |
|
|
225 | called. To make the process run you must first put it into the ready queue |
| 201 | the ready queue by calling the ready method. |
226 | by calling the ready method. |
| 202 | |
|
|
| 203 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
| 204 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
| 205 | |
227 | |
| 206 | =cut |
228 | =cut |
| 207 | |
229 | |
| 208 | sub _newcoro { |
230 | sub _newcoro { |
| 209 | terminate &{+shift}; |
231 | terminate &{+shift}; |
| … | |
… | |
| 216 | }, $class; |
238 | }, $class; |
| 217 | } |
239 | } |
| 218 | |
240 | |
| 219 | =item $process->ready |
241 | =item $process->ready |
| 220 | |
242 | |
| 221 | Put the current process into the ready queue. |
243 | Put the given process into the ready queue. |
| 222 | |
244 | |
| 223 | =cut |
245 | =cut |
| 224 | |
246 | |
| 225 | =item $process->cancel |
247 | =item $process->cancel (arg...) |
| 226 | |
248 | |
| 227 | Like C<terminate>, but terminates the specified process instead. |
249 | Terminates the given process and makes it return the given arguments as |
|
|
250 | status (default: the empty list). |
| 228 | |
251 | |
| 229 | =cut |
252 | =cut |
| 230 | |
253 | |
| 231 | sub cancel { |
254 | sub cancel { |
|
|
255 | my $self = shift; |
|
|
256 | $self->{status} = [@_]; |
| 232 | push @destroy, $_[0]; |
257 | push @destroy, $self; |
| 233 | $manager->ready; |
258 | $manager->ready; |
|
|
259 | &schedule if $current == $self; |
|
|
260 | } |
|
|
261 | |
|
|
262 | =item $process->join |
|
|
263 | |
|
|
264 | Wait until the coroutine terminates and return any values given to the |
|
|
265 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
|
|
266 | from multiple processes. |
|
|
267 | |
|
|
268 | =cut |
|
|
269 | |
|
|
270 | sub join { |
|
|
271 | my $self = shift; |
|
|
272 | unless ($self->{status}) { |
|
|
273 | push @{$self->{join}}, $current; |
|
|
274 | &schedule; |
|
|
275 | } |
|
|
276 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
| 234 | } |
277 | } |
| 235 | |
278 | |
| 236 | =item $oldprio = $process->prio($newprio) |
279 | =item $oldprio = $process->prio($newprio) |
| 237 | |
280 | |
| 238 | Sets the priority of the process. Higher priority processes get run before |
281 | Sets (or gets, if the argument is missing) the priority of the |
|
|
282 | process. Higher priority processes get run before lower priority |
| 239 | lower priority processes. Priorities are smalled signed integer (currently |
283 | processes. Priorities are small signed integers (currently -4 .. +3), |
| 240 | -4 .. +3), that you can refer to using PRIO_xxx constants (use the import |
284 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
| 241 | tag :prio to get then): |
285 | to get then): |
| 242 | |
286 | |
| 243 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
287 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
| 244 | 3 > 1 > 0 > -1 > -3 > -4 |
288 | 3 > 1 > 0 > -1 > -3 > -4 |
| 245 | |
289 | |
| 246 | # set priority to HIGH |
290 | # set priority to HIGH |
| … | |
… | |
| 271 | |
315 | |
| 272 | sub nice { |
316 | sub nice { |
| 273 | $_[0]{prio} -= $_[1]; |
317 | $_[0]{prio} -= $_[1]; |
| 274 | } |
318 | } |
| 275 | |
319 | |
|
|
320 | =item $olddesc = $process->desc($newdesc) |
|
|
321 | |
|
|
322 | Sets (or gets in case the argument is missing) the description for this |
|
|
323 | process. This is just a free-form string you can associate with a process. |
|
|
324 | |
|
|
325 | =cut |
|
|
326 | |
|
|
327 | sub desc { |
|
|
328 | my $old = $_[0]{desc}; |
|
|
329 | $_[0]{desc} = $_[1] if @_ > 1; |
|
|
330 | $old; |
|
|
331 | } |
|
|
332 | |
| 276 | =back |
333 | =back |
| 277 | |
334 | |
| 278 | =cut |
335 | =cut |
| 279 | |
336 | |
| 280 | 1; |
337 | 1; |
| 281 | |
338 | |
| 282 | =head1 BUGS/LIMITATIONS |
339 | =head1 BUGS/LIMITATIONS |
| 283 | |
340 | |
| 284 | - could be faster, especially when the core would introduce special |
341 | - you must make very sure that no coro is still active on global |
| 285 | support for coroutines (like it does for threads). |
342 | destruction. very bad things might happen otherwise (usually segfaults). |
| 286 | - there is still a memleak on coroutine termination that I could not |
343 | |
| 287 | identify. Could be as small as a single SV. |
|
|
| 288 | - this module is not well-tested. |
|
|
| 289 | - if variables or arguments "disappear" (become undef) or become |
|
|
| 290 | corrupted please contact the author so he cen iron out the |
|
|
| 291 | remaining bugs. |
|
|
| 292 | - this module is not thread-safe. You must only ever use this module from |
344 | - this module is not thread-safe. You should only ever use this module |
| 293 | the same thread (this requirement might be loosened in the future to |
345 | from the same thread (this requirement might be losened in the future |
| 294 | allow per-thread schedulers, but Coro::State does not yet allow this). |
346 | to allow per-thread schedulers, but Coro::State does not yet allow |
|
|
347 | this). |
| 295 | |
348 | |
| 296 | =head1 SEE ALSO |
349 | =head1 SEE ALSO |
| 297 | |
350 | |
| 298 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
351 | Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
| 299 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
352 | |
| 300 | L<Coro::Handle>, L<Coro::Socket>. |
353 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
|
|
354 | |
|
|
355 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
|
|
356 | |
|
|
357 | Embedding: L<Coro:MakeMaker> |
| 301 | |
358 | |
| 302 | =head1 AUTHOR |
359 | =head1 AUTHOR |
| 303 | |
360 | |
| 304 | Marc Lehmann <pcg@goof.com> |
361 | Marc Lehmann <schmorp@schmorp.de> |
| 305 | http://www.goof.com/pcg/marc/ |
362 | http://home.schmorp.de/ |
| 306 | |
363 | |
| 307 | =cut |
364 | =cut |
| 308 | |
365 | |
