… | |
… | |
6 | |
6 | |
7 | use Coro; |
7 | use Coro; |
8 | |
8 | |
9 | async { |
9 | async { |
10 | # some asynchronous thread of execution |
10 | # some asynchronous thread of execution |
|
|
11 | print "2\n"; |
|
|
12 | cede; # yield back to main |
|
|
13 | print "4\n"; |
11 | }; |
14 | }; |
|
|
15 | print "1\n"; |
|
|
16 | cede; # yield to coroutine |
|
|
17 | print "3\n"; |
|
|
18 | cede; # and again |
12 | |
19 | |
13 | # alternatively create an async coroutine like this: |
20 | # use locking |
|
|
21 | my $lock = new Coro::Semaphore; |
|
|
22 | my $locked; |
14 | |
23 | |
15 | sub some_func : Coro { |
24 | $lock->down; |
16 | # some more async code |
25 | $locked = 1; |
17 | } |
26 | $lock->up; |
18 | |
|
|
19 | cede; |
|
|
20 | |
27 | |
21 | =head1 DESCRIPTION |
28 | =head1 DESCRIPTION |
22 | |
29 | |
23 | This module collection manages coroutines. Coroutines are similar |
30 | This module collection manages coroutines. Coroutines are similar |
24 | to threads but don't run in parallel at the same time even on SMP |
31 | to threads but don't run in parallel at the same time even on SMP |
… | |
… | |
33 | is a performance win on Windows machines, and a loss everywhere else). |
40 | is a performance win on Windows machines, and a loss everywhere else). |
34 | |
41 | |
35 | In this module, coroutines are defined as "callchain + lexical variables + |
42 | In this module, coroutines are defined as "callchain + lexical variables + |
36 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
43 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
37 | its own set of lexicals and its own set of perls most important global |
44 | its own set of lexicals and its own set of perls most important global |
38 | variables. |
45 | variables (see L<Coro::State> for more configuration). |
39 | |
46 | |
40 | =cut |
47 | =cut |
41 | |
48 | |
42 | package Coro; |
49 | package Coro; |
43 | |
50 | |
… | |
… | |
50 | |
57 | |
51 | our $idle; # idle handler |
58 | our $idle; # idle handler |
52 | our $main; # main coroutine |
59 | our $main; # main coroutine |
53 | our $current; # current coroutine |
60 | our $current; # current coroutine |
54 | |
61 | |
55 | our $VERSION = '3.7'; |
62 | our $VERSION = '4.2'; |
56 | |
63 | |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
64 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
58 | our %EXPORT_TAGS = ( |
65 | our %EXPORT_TAGS = ( |
59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
66 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
60 | ); |
67 | ); |
… | |
… | |
116 | =cut |
123 | =cut |
117 | |
124 | |
118 | $main->{desc} = "[main::]"; |
125 | $main->{desc} = "[main::]"; |
119 | |
126 | |
120 | # maybe some other module used Coro::Specific before... |
127 | # maybe some other module used Coro::Specific before... |
121 | $main->{specific} = $current->{specific} |
128 | $main->{_specific} = $current->{_specific} |
122 | if $current; |
129 | if $current; |
123 | |
130 | |
124 | _set_current $main; |
131 | _set_current $main; |
125 | |
132 | |
126 | sub current() { $current } |
133 | sub current() { $current } |
… | |
… | |
134 | This hook is overwritten by modules such as C<Coro::Timer> and |
141 | This hook is overwritten by modules such as C<Coro::Timer> and |
135 | C<Coro::Event> to wait on an external event that hopefully wake up a |
142 | C<Coro::Event> to wait on an external event that hopefully wake up a |
136 | coroutine so the scheduler can run it. |
143 | coroutine so the scheduler can run it. |
137 | |
144 | |
138 | Please note that if your callback recursively invokes perl (e.g. for event |
145 | Please note that if your callback recursively invokes perl (e.g. for event |
139 | handlers), then it must be prepared to be called recursively. |
146 | handlers), then it must be prepared to be called recursively itself. |
140 | |
147 | |
141 | =cut |
148 | =cut |
142 | |
149 | |
143 | $idle = sub { |
150 | $idle = sub { |
144 | require Carp; |
151 | require Carp; |
… | |
… | |
151 | # free coroutine data and mark as destructed |
158 | # free coroutine data and mark as destructed |
152 | $self->_destroy |
159 | $self->_destroy |
153 | or return; |
160 | or return; |
154 | |
161 | |
155 | # call all destruction callbacks |
162 | # call all destruction callbacks |
156 | $_->(@{$self->{status}}) |
163 | $_->(@{$self->{_status}}) |
157 | for @{(delete $self->{destroy_cb}) || []}; |
164 | for @{(delete $self->{_on_destroy}) || []}; |
158 | } |
165 | } |
159 | |
166 | |
160 | # this coroutine is necessary because a coroutine |
167 | # this coroutine is necessary because a coroutine |
161 | # cannot destroy itself. |
168 | # cannot destroy itself. |
162 | my @destroy; |
169 | my @destroy; |
… | |
… | |
186 | =item async { ... } [@args...] |
193 | =item async { ... } [@args...] |
187 | |
194 | |
188 | Create a new asynchronous coroutine and return it's coroutine object |
195 | Create a new asynchronous coroutine and return it's coroutine object |
189 | (usually unused). When the sub returns the new coroutine is automatically |
196 | (usually unused). When the sub returns the new coroutine is automatically |
190 | terminated. |
197 | terminated. |
|
|
198 | |
|
|
199 | See the C<Coro::State::new> constructor for info about the coroutine |
|
|
200 | environment in which coroutines run. |
191 | |
201 | |
192 | Calling C<exit> in a coroutine will do the same as calling exit outside |
202 | Calling C<exit> in a coroutine will do the same as calling exit outside |
193 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
203 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
194 | just as it would in the main program. |
204 | just as it would in the main program. |
195 | |
205 | |
… | |
… | |
216 | issued in case of an exception instead of terminating the program, as |
226 | issued in case of an exception instead of terminating the program, as |
217 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
227 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
218 | will not work in the expected way, unless you call terminate or cancel, |
228 | will not work in the expected way, unless you call terminate or cancel, |
219 | which somehow defeats the purpose of pooling. |
229 | which somehow defeats the purpose of pooling. |
220 | |
230 | |
221 | The priority will be reset to C<0> after each job, otherwise the coroutine |
231 | The priority will be reset to C<0> after each job, tracing will be |
222 | will be re-used "as-is". |
232 | disabled, the description will be reset and the default output filehandle |
|
|
233 | gets restored, so you can change alkl these. Otherwise the coroutine will |
|
|
234 | be re-used "as-is": most notably if you change other per-coroutine global |
|
|
235 | stuff such as C<$/> you need to revert that change, which is most simply |
|
|
236 | done by using local as in C< local $/ >. |
223 | |
237 | |
224 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
238 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
225 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
239 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
226 | required. |
240 | required. |
227 | |
241 | |
… | |
… | |
248 | _pool_2 $cb; |
262 | _pool_2 $cb; |
249 | &schedule; |
263 | &schedule; |
250 | } |
264 | } |
251 | }; |
265 | }; |
252 | |
266 | |
253 | last if $@ eq "\3terminate\2\n"; |
267 | last if $@ eq "\3async_pool terminate\2\n"; |
254 | warn $@ if $@; |
268 | warn $@ if $@; |
255 | } |
269 | } |
256 | } |
270 | } |
257 | |
271 | |
258 | sub async_pool(&@) { |
272 | sub async_pool(&@) { |
… | |
… | |
295 | |
309 | |
296 | "Cede" to other coroutines. This function puts the current coroutine into the |
310 | "Cede" to other coroutines. This function puts the current coroutine into the |
297 | ready queue and calls C<schedule>, which has the effect of giving up the |
311 | ready queue and calls C<schedule>, which has the effect of giving up the |
298 | current "timeslice" to other coroutines of the same or higher priority. |
312 | current "timeslice" to other coroutines of the same or higher priority. |
299 | |
313 | |
300 | Returns true if at least one coroutine switch has happened. |
|
|
301 | |
|
|
302 | =item Coro::cede_notself |
314 | =item Coro::cede_notself |
303 | |
315 | |
304 | Works like cede, but is not exported by default and will cede to any |
316 | Works like cede, but is not exported by default and will cede to any |
305 | coroutine, regardless of priority, once. |
317 | coroutine, regardless of priority, once. |
306 | |
318 | |
307 | Returns true if at least one coroutine switch has happened. |
|
|
308 | |
|
|
309 | =item terminate [arg...] |
319 | =item terminate [arg...] |
310 | |
320 | |
311 | Terminates the current coroutine with the given status values (see L<cancel>). |
321 | Terminates the current coroutine with the given status values (see L<cancel>). |
|
|
322 | |
|
|
323 | =item killall |
|
|
324 | |
|
|
325 | Kills/terminates/cancels all coroutines except the currently running |
|
|
326 | one. This is useful after a fork, either in the child or the parent, as |
|
|
327 | usually only one of them should inherit the running coroutines. |
312 | |
328 | |
313 | =cut |
329 | =cut |
314 | |
330 | |
315 | sub terminate { |
331 | sub terminate { |
316 | $current->cancel (@_); |
332 | $current->cancel (@_); |
|
|
333 | } |
|
|
334 | |
|
|
335 | sub killall { |
|
|
336 | for (Coro::State::list) { |
|
|
337 | $_->cancel |
|
|
338 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
339 | } |
317 | } |
340 | } |
318 | |
341 | |
319 | =back |
342 | =back |
320 | |
343 | |
321 | # dynamic methods |
344 | # dynamic methods |
… | |
… | |
331 | Create a new coroutine and return it. When the sub returns the coroutine |
354 | Create a new coroutine and return it. When the sub returns the coroutine |
332 | automatically terminates as if C<terminate> with the returned values were |
355 | automatically terminates as if C<terminate> with the returned values were |
333 | called. To make the coroutine run you must first put it into the ready queue |
356 | called. To make the coroutine run you must first put it into the ready queue |
334 | by calling the ready method. |
357 | by calling the ready method. |
335 | |
358 | |
336 | See C<async> for additional discussion. |
359 | See C<async> and C<Coro::State::new> for additional info about the |
|
|
360 | coroutine environment. |
337 | |
361 | |
338 | =cut |
362 | =cut |
339 | |
363 | |
340 | sub _run_coro { |
364 | sub _run_coro { |
341 | terminate &{+shift}; |
365 | terminate &{+shift}; |
… | |
… | |
365 | |
389 | |
366 | =cut |
390 | =cut |
367 | |
391 | |
368 | sub cancel { |
392 | sub cancel { |
369 | my $self = shift; |
393 | my $self = shift; |
370 | $self->{status} = [@_]; |
394 | $self->{_status} = [@_]; |
371 | |
395 | |
372 | if ($current == $self) { |
396 | if ($current == $self) { |
373 | push @destroy, $self; |
397 | push @destroy, $self; |
374 | $manager->ready; |
398 | $manager->ready; |
375 | &schedule while 1; |
399 | &schedule while 1; |
… | |
… | |
379 | } |
403 | } |
380 | |
404 | |
381 | =item $coroutine->join |
405 | =item $coroutine->join |
382 | |
406 | |
383 | Wait until the coroutine terminates and return any values given to the |
407 | Wait until the coroutine terminates and return any values given to the |
384 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
408 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
385 | from multiple coroutine. |
409 | from multiple coroutines. |
386 | |
410 | |
387 | =cut |
411 | =cut |
388 | |
412 | |
389 | sub join { |
413 | sub join { |
390 | my $self = shift; |
414 | my $self = shift; |
391 | |
415 | |
392 | unless ($self->{status}) { |
416 | unless ($self->{_status}) { |
393 | my $current = $current; |
417 | my $current = $current; |
394 | |
418 | |
395 | push @{$self->{destroy_cb}}, sub { |
419 | push @{$self->{_on_destroy}}, sub { |
396 | $current->ready; |
420 | $current->ready; |
397 | undef $current; |
421 | undef $current; |
398 | }; |
422 | }; |
399 | |
423 | |
400 | &schedule while $current; |
424 | &schedule while $current; |
401 | } |
425 | } |
402 | |
426 | |
403 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
427 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
404 | } |
428 | } |
405 | |
429 | |
406 | =item $coroutine->on_destroy (\&cb) |
430 | =item $coroutine->on_destroy (\&cb) |
407 | |
431 | |
408 | Registers a callback that is called when this coroutine gets destroyed, |
432 | Registers a callback that is called when this coroutine gets destroyed, |
… | |
… | |
412 | =cut |
436 | =cut |
413 | |
437 | |
414 | sub on_destroy { |
438 | sub on_destroy { |
415 | my ($self, $cb) = @_; |
439 | my ($self, $cb) = @_; |
416 | |
440 | |
417 | push @{ $self->{destroy_cb} }, $cb; |
441 | push @{ $self->{_on_destroy} }, $cb; |
418 | } |
442 | } |
419 | |
443 | |
420 | =item $oldprio = $coroutine->prio ($newprio) |
444 | =item $oldprio = $coroutine->prio ($newprio) |
421 | |
445 | |
422 | Sets (or gets, if the argument is missing) the priority of the |
446 | Sets (or gets, if the argument is missing) the priority of the |
… | |
… | |
446 | |
470 | |
447 | =item $olddesc = $coroutine->desc ($newdesc) |
471 | =item $olddesc = $coroutine->desc ($newdesc) |
448 | |
472 | |
449 | Sets (or gets in case the argument is missing) the description for this |
473 | Sets (or gets in case the argument is missing) the description for this |
450 | coroutine. This is just a free-form string you can associate with a coroutine. |
474 | coroutine. This is just a free-form string you can associate with a coroutine. |
|
|
475 | |
|
|
476 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
|
|
477 | can modify this member directly if you wish. |
|
|
478 | |
|
|
479 | =item $coroutine->throw ([$scalar]) |
|
|
480 | |
|
|
481 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
482 | inside the coroutine at the next convinient point in time (usually after |
|
|
483 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
484 | exception object. |
|
|
485 | |
|
|
486 | The exception object will be thrown "as is" with the specified scalar in |
|
|
487 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
488 | (unlike with C<die>). |
|
|
489 | |
|
|
490 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
491 | end itself, although there is no guarentee that the exception will lead to |
|
|
492 | termination, and if the exception isn't caught it might well end the whole |
|
|
493 | program. |
451 | |
494 | |
452 | =cut |
495 | =cut |
453 | |
496 | |
454 | sub desc { |
497 | sub desc { |
455 | my $old = $_[0]{desc}; |
498 | my $old = $_[0]{desc}; |
… | |
… | |
573 | to allow per-thread schedulers, but Coro::State does not yet allow |
616 | to allow per-thread schedulers, but Coro::State does not yet allow |
574 | this). |
617 | this). |
575 | |
618 | |
576 | =head1 SEE ALSO |
619 | =head1 SEE ALSO |
577 | |
620 | |
|
|
621 | Lower level Configuration, Coroutine Environment: L<Coro::State>. |
|
|
622 | |
|
|
623 | Debugging: L<Coro::Debug>. |
|
|
624 | |
578 | Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
625 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
579 | |
626 | |
580 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
627 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
581 | |
628 | |
582 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
629 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>. |
583 | |
630 | |
|
|
631 | Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>. |
|
|
632 | |
584 | Embedding: L<Coro:MakeMaker> |
633 | Embedding: L<Coro:MakeMaker>. |
585 | |
634 | |
586 | =head1 AUTHOR |
635 | =head1 AUTHOR |
587 | |
636 | |
588 | Marc Lehmann <schmorp@schmorp.de> |
637 | Marc Lehmann <schmorp@schmorp.de> |
589 | http://home.schmorp.de/ |
638 | http://home.schmorp.de/ |