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