… | |
… | |
67 | |
67 | |
68 | =cut |
68 | =cut |
69 | |
69 | |
70 | package Coro; |
70 | package Coro; |
71 | |
71 | |
72 | use strict qw(vars subs); |
72 | use common::sense; |
73 | no warnings "uninitialized"; |
73 | |
|
|
74 | use Carp (); |
74 | |
75 | |
75 | use Guard (); |
76 | use Guard (); |
76 | |
77 | |
77 | use Coro::State; |
78 | use Coro::State; |
78 | |
79 | |
… | |
… | |
80 | |
81 | |
81 | our $idle; # idle handler |
82 | our $idle; # idle handler |
82 | our $main; # main coro |
83 | our $main; # main coro |
83 | our $current; # current coro |
84 | our $current; # current coro |
84 | |
85 | |
85 | our $VERSION = 5.17; |
86 | our $VERSION = 5.21; |
86 | |
87 | |
87 | 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); |
88 | our %EXPORT_TAGS = ( |
89 | our %EXPORT_TAGS = ( |
89 | 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)], |
90 | ); |
91 | ); |
91 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
92 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
92 | |
93 | |
… | |
… | |
123 | |
124 | |
124 | This variable is mainly useful to integrate Coro into event loops. It is |
125 | This variable is mainly useful to integrate Coro into event loops. It is |
125 | usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is |
126 | usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is |
126 | pretty low-level functionality. |
127 | pretty low-level functionality. |
127 | |
128 | |
128 | This variable stores either a Coro object or a callback. |
129 | This variable stores a Coro object that is put into the ready queue when |
|
|
130 | there are no other ready threads (without invoking any ready hooks). |
129 | |
131 | |
130 | If it is a callback, the it is called whenever the scheduler finds no |
132 | The default implementation dies with "FATAL: deadlock detected.", followed |
131 | ready coros to run. The default implementation prints "FATAL: |
133 | by a thread listing, because the program has no other way to continue. |
132 | deadlock detected" and exits, because the program has no other way to |
|
|
133 | continue. |
|
|
134 | |
|
|
135 | If it is a coro object, then this object will be readied (without |
|
|
136 | invoking any ready hooks, however) when the scheduler finds no other ready |
|
|
137 | coros to run. |
|
|
138 | |
134 | |
139 | 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 |
140 | 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 wake up a |
141 | coro so the scheduler can run it. |
137 | coro so the scheduler can run it. |
142 | |
138 | |
143 | Note that the callback I<must not>, under any circumstances, block |
|
|
144 | the current coro. Normally, this is achieved by having an "idle |
|
|
145 | coro" that calls the event loop and then blocks again, and then |
|
|
146 | readying that coro in the idle handler, or by simply placing the idle |
|
|
147 | coro in this variable. |
|
|
148 | |
|
|
149 | See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this |
139 | See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. |
150 | technique. |
|
|
151 | |
140 | |
152 | Please note that if your callback recursively invokes perl (e.g. for event |
|
|
153 | handlers), then it must be prepared to be called recursively itself. |
|
|
154 | |
|
|
155 | =cut |
141 | =cut |
156 | |
142 | |
157 | $idle = sub { |
143 | # ||= because other modules could have provided their own by now |
158 | require Carp; |
144 | $idle ||= new Coro sub { |
159 | Carp::croak ("FATAL: deadlock detected"); |
145 | require Coro::Debug; |
|
|
146 | die "FATAL: deadlock detected.\n" |
|
|
147 | . Coro::Debug::ps_listing (); |
160 | }; |
148 | }; |
161 | |
149 | |
162 | # this coro is necessary because a coro |
150 | # this coro is necessary because a coro |
163 | # cannot destroy itself. |
151 | # cannot destroy itself. |
164 | our @destroy; |
152 | our @destroy; |
… | |
… | |
272 | =item schedule |
260 | =item schedule |
273 | |
261 | |
274 | Calls the scheduler. The scheduler will find the next coro that is |
262 | Calls the scheduler. The scheduler will find the next coro that is |
275 | to be run from the ready queue and switches to it. The next coro |
263 | to be run from the ready queue and switches to it. The next coro |
276 | to be run is simply the one with the highest priority that is longest |
264 | to be run is simply the one with the highest priority that is longest |
277 | in its ready queue. If there is no coro ready, it will clal the |
265 | in its ready queue. If there is no coro ready, it will call the |
278 | C<$Coro::idle> hook. |
266 | C<$Coro::idle> hook. |
279 | |
267 | |
280 | Please note that the current coro will I<not> be put into the ready |
268 | Please note that the current coro will I<not> be put into the ready |
281 | queue, so calling this function usually means you will never be called |
269 | queue, so calling this function usually means you will never be called |
282 | again unless something else (e.g. an event handler) calls C<< ->ready >>, |
270 | again unless something else (e.g. an event handler) calls C<< ->ready >>, |
… | |
… | |
678 | venerable L<Event|Event> module) are not thread-safe (a weaker form |
666 | venerable L<Event|Event> module) are not thread-safe (a weaker form |
679 | of reentrancy). This means you must not block within event callbacks, |
667 | of reentrancy). This means you must not block within event callbacks, |
680 | otherwise you might suffer from crashes or worse. The only event library |
668 | otherwise you might suffer from crashes or worse. The only event library |
681 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
669 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
682 | |
670 | |
|
|
671 | Coro will try to catch you when you block in the event loop |
|
|
672 | ("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and |
|
|
673 | only works when you do not run your own event loop. |
|
|
674 | |
683 | This function allows your callbacks to block by executing them in another |
675 | This function allows your callbacks to block by executing them in another |
684 | coro where it is safe to block. One example where blocking is handy |
676 | coro where it is safe to block. One example where blocking is handy |
685 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
677 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
686 | disk, for example. |
678 | disk, for example. |
687 | |
679 | |
… | |
… | |
728 | unshift @unblock_queue, [$cb, @_]; |
720 | unshift @unblock_queue, [$cb, @_]; |
729 | $unblock_scheduler->ready; |
721 | $unblock_scheduler->ready; |
730 | } |
722 | } |
731 | } |
723 | } |
732 | |
724 | |
733 | =item $cb = Coro::rouse_cb |
725 | =item $cb = rouse_cb |
734 | |
726 | |
735 | Create and return a "rouse callback". That's a code reference that, |
727 | Create and return a "rouse callback". That's a code reference that, |
736 | when called, will remember a copy of its arguments and notify the owner |
728 | when called, will remember a copy of its arguments and notify the owner |
737 | coro of the callback. |
729 | coro of the callback. |
738 | |
730 | |
739 | See the next function. |
731 | See the next function. |
740 | |
732 | |
741 | =item @args = Coro::rouse_wait [$cb] |
733 | =item @args = rouse_wait [$cb] |
742 | |
734 | |
743 | Wait for the specified rouse callback (or the last one that was created in |
735 | Wait for the specified rouse callback (or the last one that was created in |
744 | this coro). |
736 | this coro). |
745 | |
737 | |
746 | As soon as the callback is invoked (or when the callback was invoked |
738 | As soon as the callback is invoked (or when the callback was invoked |
… | |
… | |
843 | the windows process emulation enabled under unix roughly halves perl |
835 | the windows process emulation enabled under unix roughly halves perl |
844 | performance, even when not used. |
836 | performance, even when not used. |
845 | |
837 | |
846 | =item coro switching is not signal safe |
838 | =item coro switching is not signal safe |
847 | |
839 | |
848 | You must not switch to another coro from within a signal handler |
840 | You must not switch to another coro from within a signal handler (only |
849 | (only relevant with %SIG - most event libraries provide safe signals). |
841 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
|
|
842 | you are sure you are not interrupting a Coro function. |
850 | |
843 | |
851 | That means you I<MUST NOT> call any function that might "block" the |
844 | That means you I<MUST NOT> call any function that might "block" the |
852 | current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
845 | current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
853 | anything that calls those. Everything else, including calling C<ready>, |
846 | anything that calls those. Everything else, including calling C<ready>, |
854 | works. |
847 | works. |