| … | |
… | |
| 30 | |
30 | |
| 31 | =cut |
31 | =cut |
| 32 | |
32 | |
| 33 | package Coro; |
33 | package Coro; |
| 34 | |
34 | |
| 35 | BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") } |
35 | use strict; |
|
|
36 | no warnings "uninitialized"; |
| 36 | |
37 | |
| 37 | use Coro::State; |
38 | use Coro::State; |
| 38 | |
39 | |
| 39 | use vars qw($idle $main $current); |
40 | use base qw(Coro::State Exporter); |
| 40 | |
41 | |
| 41 | use base Exporter; |
42 | our $idle; # idle handler |
|
|
43 | our $main; # main coroutine |
|
|
44 | our $current; # current coroutine |
| 42 | |
45 | |
| 43 | $VERSION = 0.95; |
46 | our $VERSION = '3.0'; |
| 44 | |
47 | |
| 45 | @EXPORT = qw(async cede schedule terminate current); |
48 | our @EXPORT = qw(async cede schedule terminate current); |
| 46 | %EXPORT_TAGS = ( |
49 | our %EXPORT_TAGS = ( |
| 47 | 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)], |
| 48 | ); |
51 | ); |
| 49 | @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
52 | our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
| 50 | |
53 | |
| 51 | { |
54 | { |
| 52 | my @async; |
55 | my @async; |
| 53 | my $init; |
56 | my $init; |
| 54 | |
57 | |
| 55 | # this way of handling attributes simply is NOT scalable ;() |
58 | # this way of handling attributes simply is NOT scalable ;() |
| 56 | sub import { |
59 | sub import { |
|
|
60 | no strict 'refs'; |
|
|
61 | |
| 57 | Coro->export_to_level(1, @_); |
62 | Coro->export_to_level(1, @_); |
|
|
63 | |
| 58 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
64 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
| 59 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
65 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
| 60 | my ($package, $ref) = (shift, shift); |
66 | my ($package, $ref) = (shift, shift); |
| 61 | my @attrs; |
67 | my @attrs; |
| 62 | for (@_) { |
68 | for (@_) { |
| … | |
… | |
| 89 | |
95 | |
| 90 | $main = new Coro; |
96 | $main = new Coro; |
| 91 | |
97 | |
| 92 | =item $current (or as function: current) |
98 | =item $current (or as function: current) |
| 93 | |
99 | |
| 94 | 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 |
|
|
101 | is C<$main> (of course). |
|
|
102 | |
|
|
103 | This variable is B<strictly> I<read-only>. It is provided for performance |
|
|
104 | reasons. If performance is not essentiel you are encouraged to use the |
|
|
105 | C<Coro::current> function instead. |
| 95 | |
106 | |
| 96 | =cut |
107 | =cut |
| 97 | |
108 | |
| 98 | # maybe some other module used Coro::Specific before... |
109 | # maybe some other module used Coro::Specific before... |
| 99 | if ($current) { |
110 | if ($current) { |
| … | |
… | |
| 104 | |
115 | |
| 105 | sub current() { $current } |
116 | sub current() { $current } |
| 106 | |
117 | |
| 107 | =item $idle |
118 | =item $idle |
| 108 | |
119 | |
| 109 | The coroutine to switch to when no other coroutine is running. The default |
120 | A callback that is called whenever the scheduler finds no ready coroutines |
| 110 | implementation prints "FATAL: deadlock detected" and exits. |
121 | to run. The default implementation prints "FATAL: deadlock detected" and |
|
|
122 | exits. |
| 111 | |
123 | |
| 112 | =cut |
124 | This hook is overwritten by modules such as C<Coro::Timer> and |
|
|
125 | C<Coro::Event> to wait on an external event that hopefully wakes up some |
|
|
126 | coroutine. |
| 113 | |
127 | |
| 114 | # should be done using priorities :( |
128 | =cut |
| 115 | $idle = new Coro sub { |
129 | |
|
|
130 | $idle = sub { |
| 116 | print STDERR "FATAL: deadlock detected\n"; |
131 | print STDERR "FATAL: deadlock detected\n"; |
| 117 | exit(51); |
132 | exit (51); |
| 118 | }; |
133 | }; |
| 119 | |
134 | |
| 120 | # this coroutine is necessary because a coroutine |
135 | # this coroutine is necessary because a coroutine |
| 121 | # cannot destroy itself. |
136 | # cannot destroy itself. |
| 122 | my @destroy; |
137 | my @destroy; |
| 123 | my $manager; |
|
|
| 124 | $manager = new Coro sub { |
138 | my $manager; $manager = new Coro sub { |
| 125 | while () { |
139 | while () { |
| 126 | # by overwriting the state object with the manager we destroy it |
140 | # by overwriting the state object with the manager we destroy it |
| 127 | # while still being able to schedule this coroutine (in case it has |
141 | # while still being able to schedule this coroutine (in case it has |
| 128 | # been readied multiple times. this is harmless since the manager |
142 | # been readied multiple times. this is harmless since the manager |
| 129 | # can be called as many times as neccessary and will always |
143 | # can be called as many times as neccessary and will always |
| 130 | # remove itself from the runqueue |
144 | # remove itself from the runqueue |
| 131 | while (@destroy) { |
145 | while (@destroy) { |
| 132 | my $coro = pop @destroy; |
146 | my $coro = pop @destroy; |
| 133 | $coro->{status} ||= []; |
147 | $coro->{status} ||= []; |
| 134 | $_->ready for @{delete $coro->{join} || []}; |
148 | $_->ready for @{delete $coro->{join} || []}; |
| 135 | $coro->{_coro_state} = $manager->{_coro_state}; |
149 | |
|
|
150 | # the next line destroys the coro state, but keeps the |
|
|
151 | # process itself intact (we basically make it a zombie |
|
|
152 | # process that always runs the manager thread, so it's possible |
|
|
153 | # to transfer() to this process). |
|
|
154 | $coro->_clone_state_from ($manager); |
| 136 | } |
155 | } |
| 137 | &schedule; |
156 | &schedule; |
| 138 | } |
157 | } |
| 139 | }; |
158 | }; |
| 140 | |
159 | |
| … | |
… | |
| 152 | |
171 | |
| 153 | Create a new asynchronous process and return it's process object |
172 | Create a new asynchronous process and return it's process object |
| 154 | (usually unused). When the sub returns the new process is automatically |
173 | (usually unused). When the sub returns the new process is automatically |
| 155 | terminated. |
174 | terminated. |
| 156 | |
175 | |
|
|
176 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
|
|
177 | |
|
|
178 | When the coroutine dies, the program will exit, just as in the main |
|
|
179 | program. |
|
|
180 | |
| 157 | # create a new coroutine that just prints its arguments |
181 | # create a new coroutine that just prints its arguments |
| 158 | async { |
182 | async { |
| 159 | print "@_\n"; |
183 | print "@_\n"; |
| 160 | } 1,2,3,4; |
184 | } 1,2,3,4; |
| 161 | |
185 | |
| 162 | =cut |
186 | =cut |
| 163 | |
187 | |
| 164 | sub async(&@) { |
188 | sub async(&@) { |
| 165 | my $pid = new Coro @_; |
189 | my $pid = new Coro @_; |
| 166 | $manager->ready; # this ensures that the stack is cloned from the manager |
|
|
| 167 | $pid->ready; |
190 | $pid->ready; |
| 168 | $pid; |
191 | $pid |
| 169 | } |
192 | } |
| 170 | |
193 | |
| 171 | =item schedule |
194 | =item schedule |
| 172 | |
195 | |
| 173 | Calls the scheduler. Please note that the current process will not be put |
196 | Calls the scheduler. Please note that the current process will not be put |
| … | |
… | |
| 184 | |
207 | |
| 185 | =cut |
208 | =cut |
| 186 | |
209 | |
| 187 | =item terminate [arg...] |
210 | =item terminate [arg...] |
| 188 | |
211 | |
| 189 | Terminates the current process. |
212 | Terminates the current process with the given status values (see L<cancel>). |
| 190 | |
|
|
| 191 | Future versions of this function will allow result arguments. |
|
|
| 192 | |
213 | |
| 193 | =cut |
214 | =cut |
| 194 | |
215 | |
| 195 | sub terminate { |
216 | sub terminate { |
| 196 | $current->{status} = [@_]; |
|
|
| 197 | $current->cancel; |
217 | $current->cancel (@_); |
| 198 | &schedule; |
|
|
| 199 | die; # NORETURN |
|
|
| 200 | } |
218 | } |
| 201 | |
219 | |
| 202 | =back |
220 | =back |
| 203 | |
221 | |
| 204 | # dynamic methods |
222 | # dynamic methods |
| … | |
… | |
| 214 | Create a new process and return it. When the sub returns the process |
232 | Create a new process and return it. When the sub returns the process |
| 215 | automatically terminates as if C<terminate> with the returned values were |
233 | 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 |
234 | called. To make the process run you must first put it into the ready queue |
| 217 | by calling the ready method. |
235 | by calling the ready method. |
| 218 | |
236 | |
| 219 | =cut |
237 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
| 220 | |
238 | |
|
|
239 | =cut |
|
|
240 | |
| 221 | sub _newcoro { |
241 | sub _new_coro { |
| 222 | terminate &{+shift}; |
242 | terminate &{+shift}; |
| 223 | } |
243 | } |
| 224 | |
244 | |
| 225 | sub new { |
245 | sub new { |
| 226 | my $class = shift; |
246 | my $class = shift; |
| 227 | bless { |
|
|
| 228 | _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
|
|
| 229 | }, $class; |
|
|
| 230 | } |
|
|
| 231 | |
247 | |
|
|
248 | $class->SUPER::new (\&_new_coro, @_) |
|
|
249 | } |
|
|
250 | |
| 232 | =item $process->ready |
251 | =item $success = $process->ready |
| 233 | |
252 | |
| 234 | Put the given process into the ready queue. |
253 | Put the given process into the ready queue (according to it's priority) |
|
|
254 | and return true. If the process is already in the ready queue, do nothing |
|
|
255 | and return false. |
| 235 | |
256 | |
| 236 | =cut |
257 | =item $is_ready = $process->is_ready |
| 237 | |
258 | |
|
|
259 | Return wether the process is currently the ready queue or not, |
|
|
260 | |
| 238 | =item $process->cancel |
261 | =item $process->cancel (arg...) |
| 239 | |
262 | |
| 240 | Like C<terminate>, but terminates the specified process instead. |
263 | Terminates the given process and makes it return the given arguments as |
|
|
264 | status (default: the empty list). |
| 241 | |
265 | |
| 242 | =cut |
266 | =cut |
| 243 | |
267 | |
| 244 | sub cancel { |
268 | sub cancel { |
|
|
269 | my $self = shift; |
|
|
270 | $self->{status} = [@_]; |
| 245 | push @destroy, $_[0]; |
271 | push @destroy, $self; |
| 246 | $manager->ready; |
272 | $manager->ready; |
| 247 | &schedule if $current == $_[0]; |
273 | &schedule if $current == $self; |
| 248 | } |
274 | } |
| 249 | |
275 | |
| 250 | =item $process->join |
276 | =item $process->join |
| 251 | |
277 | |
| 252 | Wait until the coroutine terminates and return any values given to the |
278 | Wait until the coroutine terminates and return any values given to the |
| 253 | C<terminate> function. C<join> can be called multiple times from multiple |
279 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
| 254 | processes. |
280 | from multiple processes. |
| 255 | |
281 | |
| 256 | =cut |
282 | =cut |
| 257 | |
283 | |
| 258 | sub join { |
284 | sub join { |
| 259 | my $self = shift; |
285 | my $self = shift; |
| … | |
… | |
| 262 | &schedule; |
288 | &schedule; |
| 263 | } |
289 | } |
| 264 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
290 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
| 265 | } |
291 | } |
| 266 | |
292 | |
| 267 | =item $oldprio = $process->prio($newprio) |
293 | =item $oldprio = $process->prio ($newprio) |
| 268 | |
294 | |
| 269 | Sets (or gets, if the argument is missing) the priority of the |
295 | Sets (or gets, if the argument is missing) the priority of the |
| 270 | process. Higher priority processes get run before lower priority |
296 | process. Higher priority processes get run before lower priority |
| 271 | processes. Priorities are small signed integers (currently -4 .. +3), |
297 | processes. Priorities are small signed integers (currently -4 .. +3), |
| 272 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
298 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
| … | |
… | |
| 284 | Changing the priority of the current process will take effect immediately, |
310 | Changing the priority of the current process will take effect immediately, |
| 285 | but changing the priority of processes in the ready queue (but not |
311 | but changing the priority of processes in the ready queue (but not |
| 286 | running) will only take effect after the next schedule (of that |
312 | running) will only take effect after the next schedule (of that |
| 287 | process). This is a bug that will be fixed in some future version. |
313 | process). This is a bug that will be fixed in some future version. |
| 288 | |
314 | |
| 289 | =cut |
|
|
| 290 | |
|
|
| 291 | sub prio { |
|
|
| 292 | my $old = $_[0]{prio}; |
|
|
| 293 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
| 294 | $old; |
|
|
| 295 | } |
|
|
| 296 | |
|
|
| 297 | =item $newprio = $process->nice($change) |
315 | =item $newprio = $process->nice ($change) |
| 298 | |
316 | |
| 299 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
317 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
| 300 | higher values mean lower priority, just as in unix). |
318 | higher values mean lower priority, just as in unix). |
| 301 | |
319 | |
| 302 | =cut |
|
|
| 303 | |
|
|
| 304 | sub nice { |
|
|
| 305 | $_[0]{prio} -= $_[1]; |
|
|
| 306 | } |
|
|
| 307 | |
|
|
| 308 | =item $olddesc = $process->desc($newdesc) |
320 | =item $olddesc = $process->desc ($newdesc) |
| 309 | |
321 | |
| 310 | Sets (or gets in case the argument is missing) the description for this |
322 | Sets (or gets in case the argument is missing) the description for this |
| 311 | process. This is just a free-form string you can associate with a process. |
323 | process. This is just a free-form string you can associate with a process. |
| 312 | |
324 | |
| 313 | =cut |
325 | =cut |
| … | |
… | |
| 334 | to allow per-thread schedulers, but Coro::State does not yet allow |
346 | to allow per-thread schedulers, but Coro::State does not yet allow |
| 335 | this). |
347 | this). |
| 336 | |
348 | |
| 337 | =head1 SEE ALSO |
349 | =head1 SEE ALSO |
| 338 | |
350 | |
| 339 | 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>. |
| 340 | L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>, |
352 | |
| 341 | L<Coro::L<Coro::RWLock>, 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> |
| 342 | |
358 | |
| 343 | =head1 AUTHOR |
359 | =head1 AUTHOR |
| 344 | |
360 | |
| 345 | Marc Lehmann <pcg@goof.com> |
361 | Marc Lehmann <schmorp@schmorp.de> |
| 346 | http://www.goof.com/pcg/marc/ |
362 | http://home.schmorp.de/ |
| 347 | |
363 | |
| 348 | =cut |
364 | =cut |
| 349 | |
365 | |
