… | |
… | |
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.8'; |
62 | our $VERSION = '4.1'; |
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 | } |
|
|
159 | |
|
|
160 | sub _do_trace { |
|
|
161 | $current->{_trace_cb}->(); |
|
|
162 | } |
165 | } |
163 | |
166 | |
164 | # this coroutine is necessary because a coroutine |
167 | # this coroutine is necessary because a coroutine |
165 | # cannot destroy itself. |
168 | # cannot destroy itself. |
166 | my @destroy; |
169 | my @destroy; |
… | |
… | |
190 | =item async { ... } [@args...] |
193 | =item async { ... } [@args...] |
191 | |
194 | |
192 | Create a new asynchronous coroutine and return it's coroutine object |
195 | Create a new asynchronous coroutine and return it's coroutine object |
193 | (usually unused). When the sub returns the new coroutine is automatically |
196 | (usually unused). When the sub returns the new coroutine is automatically |
194 | terminated. |
197 | terminated. |
|
|
198 | |
|
|
199 | See the C<Coro::State::new> constructor for info about the coroutine |
|
|
200 | environment in which coroutines run. |
195 | |
201 | |
196 | 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 |
197 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
203 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
198 | just as it would in the main program. |
204 | just as it would in the main program. |
199 | |
205 | |
… | |
… | |
220 | 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 |
221 | 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> |
222 | 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, |
223 | which somehow defeats the purpose of pooling. |
229 | which somehow defeats the purpose of pooling. |
224 | |
230 | |
225 | 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 |
226 | 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 $/ >. |
227 | |
237 | |
228 | 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 |
229 | 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 |
230 | required. |
240 | required. |
231 | |
241 | |
… | |
… | |
252 | _pool_2 $cb; |
262 | _pool_2 $cb; |
253 | &schedule; |
263 | &schedule; |
254 | } |
264 | } |
255 | }; |
265 | }; |
256 | |
266 | |
257 | last if $@ eq "\3terminate\2\n"; |
267 | last if $@ eq "\3async_pool terminate\2\n"; |
258 | warn $@ if $@; |
268 | warn $@ if $@; |
259 | } |
269 | } |
260 | } |
270 | } |
261 | |
271 | |
262 | sub async_pool(&@) { |
272 | sub async_pool(&@) { |
… | |
… | |
312 | |
322 | |
313 | =item terminate [arg...] |
323 | =item terminate [arg...] |
314 | |
324 | |
315 | Terminates the current coroutine with the given status values (see L<cancel>). |
325 | Terminates the current coroutine with the given status values (see L<cancel>). |
316 | |
326 | |
|
|
327 | =item killall |
|
|
328 | |
|
|
329 | Kills/terminates/cancels all coroutines except the currently running |
|
|
330 | one. This is useful after a fork, either in the child or the parent, as |
|
|
331 | usually only one of them should inherit the running coroutines. |
|
|
332 | |
317 | =cut |
333 | =cut |
318 | |
334 | |
319 | sub terminate { |
335 | sub terminate { |
320 | $current->cancel (@_); |
336 | $current->cancel (@_); |
|
|
337 | } |
|
|
338 | |
|
|
339 | sub killall { |
|
|
340 | for (Coro::State::list) { |
|
|
341 | $_->cancel |
|
|
342 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
343 | } |
321 | } |
344 | } |
322 | |
345 | |
323 | =back |
346 | =back |
324 | |
347 | |
325 | # dynamic methods |
348 | # dynamic methods |
… | |
… | |
335 | Create a new coroutine and return it. When the sub returns the coroutine |
358 | Create a new coroutine and return it. When the sub returns the coroutine |
336 | automatically terminates as if C<terminate> with the returned values were |
359 | automatically terminates as if C<terminate> with the returned values were |
337 | called. To make the coroutine run you must first put it into the ready queue |
360 | called. To make the coroutine run you must first put it into the ready queue |
338 | by calling the ready method. |
361 | by calling the ready method. |
339 | |
362 | |
340 | See C<async> for additional discussion. |
363 | See C<async> and C<Coro::State::new> for additional info about the |
|
|
364 | coroutine environment. |
341 | |
365 | |
342 | =cut |
366 | =cut |
343 | |
367 | |
344 | sub _run_coro { |
368 | sub _run_coro { |
345 | terminate &{+shift}; |
369 | terminate &{+shift}; |
… | |
… | |
369 | |
393 | |
370 | =cut |
394 | =cut |
371 | |
395 | |
372 | sub cancel { |
396 | sub cancel { |
373 | my $self = shift; |
397 | my $self = shift; |
374 | $self->{status} = [@_]; |
398 | $self->{_status} = [@_]; |
375 | |
399 | |
376 | if ($current == $self) { |
400 | if ($current == $self) { |
377 | push @destroy, $self; |
401 | push @destroy, $self; |
378 | $manager->ready; |
402 | $manager->ready; |
379 | &schedule while 1; |
403 | &schedule while 1; |
… | |
… | |
383 | } |
407 | } |
384 | |
408 | |
385 | =item $coroutine->join |
409 | =item $coroutine->join |
386 | |
410 | |
387 | Wait until the coroutine terminates and return any values given to the |
411 | Wait until the coroutine terminates and return any values given to the |
388 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
412 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
389 | from multiple coroutine. |
413 | from multiple coroutines. |
390 | |
414 | |
391 | =cut |
415 | =cut |
392 | |
416 | |
393 | sub join { |
417 | sub join { |
394 | my $self = shift; |
418 | my $self = shift; |
395 | |
419 | |
396 | unless ($self->{status}) { |
420 | unless ($self->{_status}) { |
397 | my $current = $current; |
421 | my $current = $current; |
398 | |
422 | |
399 | push @{$self->{destroy_cb}}, sub { |
423 | push @{$self->{_on_destroy}}, sub { |
400 | $current->ready; |
424 | $current->ready; |
401 | undef $current; |
425 | undef $current; |
402 | }; |
426 | }; |
403 | |
427 | |
404 | &schedule while $current; |
428 | &schedule while $current; |
405 | } |
429 | } |
406 | |
430 | |
407 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
431 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
408 | } |
432 | } |
409 | |
433 | |
410 | =item $coroutine->on_destroy (\&cb) |
434 | =item $coroutine->on_destroy (\&cb) |
411 | |
435 | |
412 | Registers a callback that is called when this coroutine gets destroyed, |
436 | Registers a callback that is called when this coroutine gets destroyed, |
… | |
… | |
416 | =cut |
440 | =cut |
417 | |
441 | |
418 | sub on_destroy { |
442 | sub on_destroy { |
419 | my ($self, $cb) = @_; |
443 | my ($self, $cb) = @_; |
420 | |
444 | |
421 | push @{ $self->{destroy_cb} }, $cb; |
445 | push @{ $self->{_on_destroy} }, $cb; |
422 | } |
446 | } |
423 | |
447 | |
424 | =item $oldprio = $coroutine->prio ($newprio) |
448 | =item $oldprio = $coroutine->prio ($newprio) |
425 | |
449 | |
426 | Sets (or gets, if the argument is missing) the priority of the |
450 | Sets (or gets, if the argument is missing) the priority of the |
… | |
… | |
450 | |
474 | |
451 | =item $olddesc = $coroutine->desc ($newdesc) |
475 | =item $olddesc = $coroutine->desc ($newdesc) |
452 | |
476 | |
453 | Sets (or gets in case the argument is missing) the description for this |
477 | Sets (or gets in case the argument is missing) the description for this |
454 | coroutine. This is just a free-form string you can associate with a coroutine. |
478 | coroutine. This is just a free-form string you can associate with a coroutine. |
|
|
479 | |
|
|
480 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
|
|
481 | can modify this member directly if you wish. |
|
|
482 | |
|
|
483 | =item $coroutine->throw ([$scalar]) |
|
|
484 | |
|
|
485 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
486 | inside the coroutine at the next convinient point in time (usually after |
|
|
487 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
488 | exception object. |
|
|
489 | |
|
|
490 | The exception object will be thrown "as is" with the specified scalar in |
|
|
491 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
492 | (unlike with C<die>). |
|
|
493 | |
|
|
494 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
495 | end itself, although there is no guarentee that the exception will lead to |
|
|
496 | termination, and if the exception isn't caught it might well end the whole |
|
|
497 | program. |
455 | |
498 | |
456 | =cut |
499 | =cut |
457 | |
500 | |
458 | sub desc { |
501 | sub desc { |
459 | my $old = $_[0]{desc}; |
502 | my $old = $_[0]{desc}; |
… | |
… | |
577 | to allow per-thread schedulers, but Coro::State does not yet allow |
620 | to allow per-thread schedulers, but Coro::State does not yet allow |
578 | this). |
621 | this). |
579 | |
622 | |
580 | =head1 SEE ALSO |
623 | =head1 SEE ALSO |
581 | |
624 | |
|
|
625 | Lower level Configuration, Coroutine Environment: L<Coro::State>. |
|
|
626 | |
|
|
627 | Debugging: L<Coro::Debug>. |
|
|
628 | |
582 | Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
629 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
583 | |
630 | |
584 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
631 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
585 | |
632 | |
586 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
633 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>. |
587 | |
634 | |
|
|
635 | Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>. |
|
|
636 | |
588 | Embedding: L<Coro:MakeMaker> |
637 | Embedding: L<Coro:MakeMaker>. |
589 | |
638 | |
590 | =head1 AUTHOR |
639 | =head1 AUTHOR |
591 | |
640 | |
592 | Marc Lehmann <schmorp@schmorp.de> |
641 | Marc Lehmann <schmorp@schmorp.de> |
593 | http://home.schmorp.de/ |
642 | http://home.schmorp.de/ |