… | |
… | |
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.17; |
86 | our $VERSION = 5.25; |
87 | |
87 | |
88 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
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 | ); |
92 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
92 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
93 | |
93 | |
… | |
… | |
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 |
142 | |
142 | |
|
|
143 | # ||= because other modules could have provided their own by now |
143 | $idle = new Coro sub { |
144 | $idle ||= new Coro sub { |
144 | require Coro::Debug; |
145 | require Coro::Debug; |
145 | die "FATAL: deadlock detected.\n" |
146 | die "FATAL: deadlock detected.\n" |
146 | . Coro::Debug::ps_listing (); |
147 | . Coro::Debug::ps_listing (); |
147 | }; |
148 | }; |
148 | |
149 | |
… | |
… | |
612 | Sets (or gets in case the argument is missing) the description for this |
613 | Sets (or gets in case the argument is missing) the description for this |
613 | coro. This is just a free-form string you can associate with a |
614 | coro. This is just a free-form string you can associate with a |
614 | coro. |
615 | coro. |
615 | |
616 | |
616 | This method simply sets the C<< $coro->{desc} >> member to the given |
617 | This method simply sets the C<< $coro->{desc} >> member to the given |
617 | string. You can modify this member directly if you wish. |
618 | 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 |
|
|
620 | seen for example in a L<Coro::Debug> session: |
|
|
621 | |
|
|
622 | sub my_long_function { |
|
|
623 | local $Coro::current->{desc} = "now in my_long_function"; |
|
|
624 | ... |
|
|
625 | $Coro::current->{desc} = "my_long_function: phase 1"; |
|
|
626 | ... |
|
|
627 | $Coro::current->{desc} = "my_long_function: phase 2"; |
|
|
628 | ... |
|
|
629 | } |
618 | |
630 | |
619 | =cut |
631 | =cut |
620 | |
632 | |
621 | sub desc { |
633 | sub desc { |
622 | my $old = $_[0]{desc}; |
634 | my $old = $_[0]{desc}; |
… | |
… | |
659 | returning a new coderef. Unblocking means that calling the new coderef |
671 | returning a new coderef. Unblocking means that calling the new coderef |
660 | will return immediately without blocking, returning nothing, while the |
672 | will return immediately without blocking, returning nothing, while the |
661 | original code ref will be called (with parameters) from within another |
673 | original code ref will be called (with parameters) from within another |
662 | coro. |
674 | coro. |
663 | |
675 | |
664 | The reason this function exists is that many event libraries (such as the |
676 | The reason this function exists is that many event libraries (such as |
665 | venerable L<Event|Event> module) are not thread-safe (a weaker form |
677 | the venerable L<Event|Event> module) are not thread-safe (a weaker form |
666 | of reentrancy). This means you must not block within event callbacks, |
678 | of reentrancy). This means you must not block within event callbacks, |
667 | otherwise you might suffer from crashes or worse. The only event library |
679 | otherwise you might suffer from crashes or worse. The only event library |
668 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
680 | currently known that is safe to use without C<unblock_sub> is L<EV> (but |
|
|
681 | you might still run into deadlocks if all event loops are blocked). |
|
|
682 | |
|
|
683 | Coro will try to catch you when you block in the event loop |
|
|
684 | ("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and |
|
|
685 | only works when you do not run your own event loop. |
669 | |
686 | |
670 | This function allows your callbacks to block by executing them in another |
687 | This function allows your callbacks to block by executing them in another |
671 | coro where it is safe to block. One example where blocking is handy |
688 | coro where it is safe to block. One example where blocking is handy |
672 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
689 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
673 | disk, for example. |
690 | disk, for example. |
… | |
… | |
715 | unshift @unblock_queue, [$cb, @_]; |
732 | unshift @unblock_queue, [$cb, @_]; |
716 | $unblock_scheduler->ready; |
733 | $unblock_scheduler->ready; |
717 | } |
734 | } |
718 | } |
735 | } |
719 | |
736 | |
720 | =item $cb = Coro::rouse_cb |
737 | =item $cb = rouse_cb |
721 | |
738 | |
722 | Create and return a "rouse callback". That's a code reference that, |
739 | Create and return a "rouse callback". That's a code reference that, |
723 | when called, will remember a copy of its arguments and notify the owner |
740 | when called, will remember a copy of its arguments and notify the owner |
724 | coro of the callback. |
741 | coro of the callback. |
725 | |
742 | |
726 | See the next function. |
743 | See the next function. |
727 | |
744 | |
728 | =item @args = Coro::rouse_wait [$cb] |
745 | =item @args = rouse_wait [$cb] |
729 | |
746 | |
730 | Wait for the specified rouse callback (or the last one that was created in |
747 | Wait for the specified rouse callback (or the last one that was created in |
731 | this coro). |
748 | this coro). |
732 | |
749 | |
733 | As soon as the callback is invoked (or when the callback was invoked |
750 | As soon as the callback is invoked (or when the callback was invoked |
… | |
… | |
739 | See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. |
756 | See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. |
740 | |
757 | |
741 | =back |
758 | =back |
742 | |
759 | |
743 | =cut |
760 | =cut |
|
|
761 | |
|
|
762 | for my $module (qw(Channel RWLock Semaphore SemaphoreSet Signal Specific)) { |
|
|
763 | my $old = defined &{"Coro::$module\::new"} && \&{"Coro::$module\::new"}; |
|
|
764 | |
|
|
765 | *{"Coro::$module\::new"} = sub { |
|
|
766 | require "Coro/$module.pm"; |
|
|
767 | |
|
|
768 | # some modules have their new predefined in State.xs, some don't |
|
|
769 | *{"Coro::$module\::new"} = $old |
|
|
770 | if $old; |
|
|
771 | |
|
|
772 | goto &{"Coro::$module\::new"}; |
|
|
773 | }; |
|
|
774 | } |
744 | |
775 | |
745 | 1; |
776 | 1; |
746 | |
777 | |
747 | =head1 HOW TO WAIT FOR A CALLBACK |
778 | =head1 HOW TO WAIT FOR A CALLBACK |
748 | |
779 | |
… | |
… | |
830 | the windows process emulation enabled under unix roughly halves perl |
861 | the windows process emulation enabled under unix roughly halves perl |
831 | performance, even when not used. |
862 | performance, even when not used. |
832 | |
863 | |
833 | =item coro switching is not signal safe |
864 | =item coro switching is not signal safe |
834 | |
865 | |
835 | You must not switch to another coro from within a signal handler |
866 | You must not switch to another coro from within a signal handler (only |
836 | (only relevant with %SIG - most event libraries provide safe signals). |
867 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
|
|
868 | you are sure you are not interrupting a Coro function. |
837 | |
869 | |
838 | That means you I<MUST NOT> call any function that might "block" the |
870 | That means you I<MUST NOT> call any function that might "block" the |
839 | current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
871 | current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
840 | anything that calls those. Everything else, including calling C<ready>, |
872 | anything that calls those. Everything else, including calling C<ready>, |
841 | works. |
873 | works. |
… | |
… | |
851 | ithreads (for example, that memory or files would be shared), showing his |
883 | ithreads (for example, that memory or files would be shared), showing his |
852 | lack of understanding of this area - if it is hard to understand for Chip, |
884 | lack of understanding of this area - if it is hard to understand for Chip, |
853 | it is probably not obvious to everybody). |
885 | it is probably not obvious to everybody). |
854 | |
886 | |
855 | What follows is an ultra-condensed version of my talk about threads in |
887 | What follows is an ultra-condensed version of my talk about threads in |
856 | scripting languages given onthe perl workshop 2009: |
888 | scripting languages given on the perl workshop 2009: |
857 | |
889 | |
858 | The so-called "ithreads" were originally implemented for two reasons: |
890 | The so-called "ithreads" were originally implemented for two reasons: |
859 | first, to (badly) emulate unix processes on native win32 perls, and |
891 | first, to (badly) emulate unix processes on native win32 perls, and |
860 | secondly, to replace the older, real thread model ("5.005-threads"). |
892 | secondly, to replace the older, real thread model ("5.005-threads"). |
861 | |
893 | |