… | |
… | |
81 | |
81 | |
82 | our $idle; # idle handler |
82 | our $idle; # idle handler |
83 | our $main; # main coro |
83 | our $main; # main coro |
84 | our $current; # current coro |
84 | our $current; # current coro |
85 | |
85 | |
86 | our $VERSION = 5.25; |
86 | our $VERSION = 5.26; |
87 | |
87 | |
88 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
88 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
89 | our %EXPORT_TAGS = ( |
89 | our %EXPORT_TAGS = ( |
90 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
90 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
91 | ); |
91 | ); |
… | |
… | |
131 | |
131 | |
132 | The default implementation dies with "FATAL: deadlock detected.", followed |
132 | The default implementation dies with "FATAL: deadlock detected.", followed |
133 | by a thread listing, because the program has no other way to continue. |
133 | by a thread listing, because the program has no other way to continue. |
134 | |
134 | |
135 | This hook is overwritten by modules such as C<Coro::EV> and |
135 | This hook is overwritten by modules such as C<Coro::EV> and |
136 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
136 | C<Coro::AnyEvent> to wait on an external event that hopefully wakes up a |
137 | coro so the scheduler can run it. |
137 | coro so the scheduler can run it. |
138 | |
138 | |
139 | See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. |
139 | See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. |
140 | |
140 | |
141 | =cut |
141 | =cut |
… | |
… | |
567 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
567 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
568 | } |
568 | } |
569 | |
569 | |
570 | =item $coro->on_destroy (\&cb) |
570 | =item $coro->on_destroy (\&cb) |
571 | |
571 | |
572 | Registers a callback that is called when this coro gets destroyed, |
572 | Registers a callback that is called when this coro thread gets destroyed, |
573 | but before it is joined. The callback gets passed the terminate arguments, |
573 | but before it is joined. The callback gets passed the terminate arguments, |
574 | if any, and I<must not> die, under any circumstances. |
574 | if any, and I<must not> die, under any circumstances. |
575 | |
575 | |
|
|
576 | There can be any number of C<on_destroy> callbacks per coro. |
|
|
577 | |
576 | =cut |
578 | =cut |
577 | |
579 | |
578 | sub on_destroy { |
580 | sub on_destroy { |
579 | my ($self, $cb) = @_; |
581 | my ($self, $cb) = @_; |
580 | |
582 | |
… | |
… | |
582 | } |
584 | } |
583 | |
585 | |
584 | =item $oldprio = $coro->prio ($newprio) |
586 | =item $oldprio = $coro->prio ($newprio) |
585 | |
587 | |
586 | Sets (or gets, if the argument is missing) the priority of the |
588 | Sets (or gets, if the argument is missing) the priority of the |
587 | coro. Higher priority coro get run before lower priority |
589 | coro thread. Higher priority coro get run before lower priority |
588 | coro. Priorities are small signed integers (currently -4 .. +3), |
590 | coros. Priorities are small signed integers (currently -4 .. +3), |
589 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
591 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
590 | to get then): |
592 | to get then): |
591 | |
593 | |
592 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
594 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
593 | 3 > 1 > 0 > -1 > -3 > -4 |
595 | 3 > 1 > 0 > -1 > -3 > -4 |
594 | |
596 | |
595 | # set priority to HIGH |
597 | # set priority to HIGH |
596 | current->prio (PRIO_HIGH); |
598 | current->prio (PRIO_HIGH); |
597 | |
599 | |
598 | The idle coro ($Coro::idle) always has a lower priority than any |
600 | The idle coro thread ($Coro::idle) always has a lower priority than any |
599 | existing coro. |
601 | existing coro. |
600 | |
602 | |
601 | Changing the priority of the current coro will take effect immediately, |
603 | Changing the priority of the current coro will take effect immediately, |
602 | but changing the priority of coro in the ready queue (but not |
604 | but changing the priority of a coro in the ready queue (but not running) |
603 | running) will only take effect after the next schedule (of that |
605 | will only take effect after the next schedule (of that coro). This is a |
604 | coro). This is a bug that will be fixed in some future version. |
606 | bug that will be fixed in some future version. |
605 | |
607 | |
606 | =item $newprio = $coro->nice ($change) |
608 | =item $newprio = $coro->nice ($change) |
607 | |
609 | |
608 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
610 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
609 | higher values mean lower priority, just as in unix). |
611 | higher values mean lower priority, just as in UNIX's nice command). |
610 | |
612 | |
611 | =item $olddesc = $coro->desc ($newdesc) |
613 | =item $olddesc = $coro->desc ($newdesc) |
612 | |
614 | |
613 | Sets (or gets in case the argument is missing) the description for this |
615 | Sets (or gets in case the argument is missing) the description for this |
614 | coro. This is just a free-form string you can associate with a |
616 | coro thread. This is just a free-form string you can associate with a |
615 | coro. |
617 | coro. |
616 | |
618 | |
617 | This method simply sets the C<< $coro->{desc} >> member to the given |
619 | This method simply sets the C<< $coro->{desc} >> member to the given |
618 | string. You can modify this member directly if you wish, and in fact, this |
620 | string. You can modify this member directly if you wish, and in fact, this |
619 | is often preferred to indicate major processing states that cna then be |
621 | is often preferred to indicate major processing states that cna then be |
… | |
… | |
671 | returning a new coderef. Unblocking means that calling the new coderef |
673 | returning a new coderef. Unblocking means that calling the new coderef |
672 | will return immediately without blocking, returning nothing, while the |
674 | will return immediately without blocking, returning nothing, while the |
673 | original code ref will be called (with parameters) from within another |
675 | original code ref will be called (with parameters) from within another |
674 | coro. |
676 | coro. |
675 | |
677 | |
676 | The reason this function exists is that many event libraries (such as the |
678 | The reason this function exists is that many event libraries (such as |
677 | venerable L<Event|Event> module) are not thread-safe (a weaker form |
679 | the venerable L<Event|Event> module) are not thread-safe (a weaker form |
678 | of reentrancy). This means you must not block within event callbacks, |
680 | of reentrancy). This means you must not block within event callbacks, |
679 | otherwise you might suffer from crashes or worse. The only event library |
681 | otherwise you might suffer from crashes or worse. The only event library |
680 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
682 | currently known that is safe to use without C<unblock_sub> is L<EV> (but |
|
|
683 | you might still run into deadlocks if all event loops are blocked). |
681 | |
684 | |
682 | Coro will try to catch you when you block in the event loop |
685 | Coro will try to catch you when you block in the event loop |
683 | ("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and |
686 | ("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and |
684 | only works when you do not run your own event loop. |
687 | only works when you do not run your own event loop. |
685 | |
688 | |
… | |
… | |
756 | |
759 | |
757 | =back |
760 | =back |
758 | |
761 | |
759 | =cut |
762 | =cut |
760 | |
763 | |
|
|
764 | for my $module (qw(Channel RWLock Semaphore SemaphoreSet Signal Specific)) { |
|
|
765 | my $old = defined &{"Coro::$module\::new"} && \&{"Coro::$module\::new"}; |
|
|
766 | |
|
|
767 | *{"Coro::$module\::new"} = sub { |
|
|
768 | require "Coro/$module.pm"; |
|
|
769 | |
|
|
770 | # some modules have their new predefined in State.xs, some don't |
|
|
771 | *{"Coro::$module\::new"} = $old |
|
|
772 | if $old; |
|
|
773 | |
|
|
774 | goto &{"Coro::$module\::new"}; |
|
|
775 | }; |
|
|
776 | } |
|
|
777 | |
761 | 1; |
778 | 1; |
762 | |
779 | |
763 | =head1 HOW TO WAIT FOR A CALLBACK |
780 | =head1 HOW TO WAIT FOR A CALLBACK |
764 | |
781 | |
765 | It is very common for a coro to wait for some callback to be |
782 | It is very common for a coro to wait for some callback to be |
… | |
… | |
868 | ithreads (for example, that memory or files would be shared), showing his |
885 | ithreads (for example, that memory or files would be shared), showing his |
869 | lack of understanding of this area - if it is hard to understand for Chip, |
886 | lack of understanding of this area - if it is hard to understand for Chip, |
870 | it is probably not obvious to everybody). |
887 | it is probably not obvious to everybody). |
871 | |
888 | |
872 | What follows is an ultra-condensed version of my talk about threads in |
889 | What follows is an ultra-condensed version of my talk about threads in |
873 | scripting languages given onthe perl workshop 2009: |
890 | scripting languages given on the perl workshop 2009: |
874 | |
891 | |
875 | The so-called "ithreads" were originally implemented for two reasons: |
892 | The so-called "ithreads" were originally implemented for two reasons: |
876 | first, to (badly) emulate unix processes on native win32 perls, and |
893 | first, to (badly) emulate unix processes on native win32 perls, and |
877 | secondly, to replace the older, real thread model ("5.005-threads"). |
894 | secondly, to replace the older, real thread model ("5.005-threads"). |
878 | |
895 | |