… | |
… | |
16 | cede; # yield to coro |
16 | cede; # yield to coro |
17 | print "3\n"; |
17 | print "3\n"; |
18 | cede; # and again |
18 | cede; # and again |
19 | |
19 | |
20 | # use locking |
20 | # use locking |
21 | use Coro::Semaphore; |
|
|
22 | my $lock = new Coro::Semaphore; |
21 | my $lock = new Coro::Semaphore; |
23 | my $locked; |
22 | my $locked; |
24 | |
23 | |
25 | $lock->down; |
24 | $lock->down; |
26 | $locked = 1; |
25 | $locked = 1; |
… | |
… | |
90 | } 1, 2, 3; |
89 | } 1, 2, 3; |
91 | |
90 | |
92 | This creates a new coro thread and puts it into the ready queue, meaning |
91 | This creates a new coro thread and puts it into the ready queue, meaning |
93 | it will run as soon as the CPU is free for it. |
92 | it will run as soon as the CPU is free for it. |
94 | |
93 | |
95 | C<async> will return a coro object - you can store this for future |
94 | C<async> will return a Coro object - you can store this for future |
96 | reference or ignore it, the thread itself will keep a reference to it's |
95 | reference or ignore it - a thread that is running, ready to run or waiting |
97 | thread object - threads are alive on their own. |
96 | for some event is alive on it's own. |
98 | |
97 | |
99 | Another way to create a thread is to call the C<new> constructor with a |
98 | Another way to create a thread is to call the C<new> constructor with a |
100 | code-reference: |
99 | code-reference: |
101 | |
100 | |
102 | new Coro sub { |
101 | new Coro sub { |
… | |
… | |
131 | A lot can happen after the coro thread has started running. Quite usually, |
130 | A lot can happen after the coro thread has started running. Quite usually, |
132 | it will not run to the end in one go (because you could use a function |
131 | it will not run to the end in one go (because you could use a function |
133 | instead), but it will give up the CPU regularly because it waits for |
132 | instead), but it will give up the CPU regularly because it waits for |
134 | external events. |
133 | external events. |
135 | |
134 | |
136 | As long as a coro thread runs, it's coro object is available in the global |
135 | As long as a coro thread runs, its Coro object is available in the global |
137 | variable C<$Coro::current>. |
136 | variable C<$Coro::current>. |
138 | |
137 | |
139 | The low-level way to give up the CPU is to call the scheduler, which |
138 | The low-level way to give up the CPU is to call the scheduler, which |
140 | selects a new coro thread to run: |
139 | selects a new coro thread to run: |
141 | |
140 | |
… | |
… | |
196 | |
195 | |
197 | async { |
196 | async { |
198 | Coro::terminate "return value 1", "return value 2"; |
197 | Coro::terminate "return value 1", "return value 2"; |
199 | }; |
198 | }; |
200 | |
199 | |
201 | And yet another way is to C<< ->cancel >> the coro thread from another |
200 | And yet another way is to C<< ->cancel >> (or C<< ->safe_cancel >>) the |
202 | thread: |
201 | coro thread from another thread: |
203 | |
202 | |
204 | my $coro = async { |
203 | my $coro = async { |
205 | exit 1; |
204 | exit 1; |
206 | }; |
205 | }; |
207 | |
206 | |
208 | $coro->cancel; # an also accept values for ->join to retrieve |
207 | $coro->cancel; # also accepts values for ->join to retrieve |
209 | |
208 | |
210 | Cancellation I<can> be dangerous - it's a bit like calling C<exit> without |
209 | Cancellation I<can> be dangerous - it's a bit like calling C<exit> without |
211 | actually exiting, and might leave C libraries and XS modules in a weird |
210 | actually exiting, and might leave C libraries and XS modules in a weird |
212 | state. Unlike other thread implementations, however, Coro is exceptionally |
211 | state. Unlike other thread implementations, however, Coro is exceptionally |
213 | safe with regards to cancellation, as perl will always be in a consistent |
212 | safe with regards to cancellation, as perl will always be in a consistent |
214 | state. |
213 | state, and for those cases where you want to do truly marvellous things |
|
|
214 | with your coro while it is being cancelled - that is, make sure all |
|
|
215 | cleanup code is executed from the thread being cancelled - there is even a |
|
|
216 | C<< ->safe_cancel >> method. |
215 | |
217 | |
216 | So, cancelling a thread that runs in an XS event loop might not be the |
218 | So, cancelling a thread that runs in an XS event loop might not be the |
217 | best idea, but any other combination that deals with perl only (cancelling |
219 | best idea, but any other combination that deals with perl only (cancelling |
218 | when a thread is in a C<tie> method or an C<AUTOLOAD> for example) is |
220 | when a thread is in a C<tie> method or an C<AUTOLOAD> for example) is |
219 | safe. |
221 | safe. |
220 | |
222 | |
|
|
223 | Lastly, a coro thread object that isn't referenced is C<< ->cancel >>'ed |
|
|
224 | automatically - just like other objects in Perl. This is not such a common |
|
|
225 | case, however - a running thread is referencedy b C<$Coro::current>, a |
|
|
226 | thread ready to run is referenced by the ready queue, a thread waiting |
|
|
227 | on a lock or semaphore is referenced by being in some wait list and so |
|
|
228 | on. But a thread that isn't in any of those queues gets cancelled: |
|
|
229 | |
|
|
230 | async { |
|
|
231 | schedule; # cede to other coros, don't go into the ready queue |
|
|
232 | }; |
|
|
233 | |
|
|
234 | cede; |
|
|
235 | # now the async above is destroyed, as it is not referenced by anything. |
|
|
236 | |
221 | =item 5. Cleanup |
237 | =item 5. Cleanup |
222 | |
238 | |
223 | Threads will allocate various resources. Most but not all will be returned |
239 | Threads will allocate various resources. Most but not all will be returned |
224 | when a thread terminates, during clean-up. |
240 | when a thread terminates, during clean-up. |
225 | |
241 | |
… | |
… | |
248 | # if we reutrn, or die or get cancelled, here, |
264 | # if we reutrn, or die or get cancelled, here, |
249 | # then the semaphore will be "up"ed. |
265 | # then the semaphore will be "up"ed. |
250 | }; |
266 | }; |
251 | |
267 | |
252 | The C<Guard::guard> function comes in handy for any custom cleanup you |
268 | The C<Guard::guard> function comes in handy for any custom cleanup you |
253 | might want to do: |
269 | might want to do (but you cannot switch to other coroutines form those |
|
|
270 | code blocks): |
254 | |
271 | |
255 | async { |
272 | async { |
256 | my $window = new Gtk2::Window "toplevel"; |
273 | my $window = new Gtk2::Window "toplevel"; |
257 | # The window will not be cleaned up automatically, even when $window |
274 | # The window will not be cleaned up automatically, even when $window |
258 | # gets freed, so use a guard to ensure it's destruction |
275 | # gets freed, so use a guard to ensure it's destruction |
… | |
… | |
271 | # if we return or die here, the description will be restored |
288 | # if we return or die here, the description will be restored |
272 | } |
289 | } |
273 | |
290 | |
274 | =item 6. Viva La Zombie Muerte |
291 | =item 6. Viva La Zombie Muerte |
275 | |
292 | |
276 | Even after a thread has terminated and cleaned up it's resources, the coro |
293 | Even after a thread has terminated and cleaned up its resources, the Coro |
277 | object still is there and stores the return values of the thread. Only in |
294 | object still is there and stores the return values of the thread. |
278 | this state will the coro object be "reference counted" in the normal perl |
|
|
279 | sense: the thread code keeps a reference to it when it is active, but not |
|
|
280 | after it has terminated. |
|
|
281 | |
295 | |
282 | The means the coro object gets freed automatically when the thread has |
296 | The means the Coro object gets freed automatically when the thread has |
283 | terminated and cleaned up and there arenot other references. |
297 | terminated and cleaned up and there arenot other references. |
284 | |
298 | |
285 | If there are, the coro object will stay around, and you can call C<< |
299 | If there are, the Coro object will stay around, and you can call C<< |
286 | ->join >> as many times as you wish to retrieve the result values: |
300 | ->join >> as many times as you wish to retrieve the result values: |
287 | |
301 | |
288 | async { |
302 | async { |
289 | print "hi\n"; |
303 | print "hi\n"; |
290 | 1 |
304 | 1 |
… | |
… | |
328 | |
342 | |
329 | our $idle; # idle handler |
343 | our $idle; # idle handler |
330 | our $main; # main coro |
344 | our $main; # main coro |
331 | our $current; # current coro |
345 | our $current; # current coro |
332 | |
346 | |
333 | our $VERSION = 5.372; |
347 | our $VERSION = "6.10"; |
334 | |
348 | |
335 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
349 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
336 | our %EXPORT_TAGS = ( |
350 | our %EXPORT_TAGS = ( |
337 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
351 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
338 | ); |
352 | ); |
… | |
… | |
710 | To avoid this, it is best to put a suspended coro into the ready queue |
724 | To avoid this, it is best to put a suspended coro into the ready queue |
711 | unconditionally, as every synchronisation mechanism must protect itself |
725 | unconditionally, as every synchronisation mechanism must protect itself |
712 | against spurious wakeups, and the one in the Coro family certainly do |
726 | against spurious wakeups, and the one in the Coro family certainly do |
713 | that. |
727 | that. |
714 | |
728 | |
|
|
729 | =item $state->is_new |
|
|
730 | |
|
|
731 | Returns true iff this Coro object is "new", i.e. has never been run |
|
|
732 | yet. Those states basically consist of only the code reference to call and |
|
|
733 | the arguments, but consumes very little other resources. New states will |
|
|
734 | automatically get assigned a perl interpreter when they are transfered to. |
|
|
735 | |
|
|
736 | =item $state->is_zombie |
|
|
737 | |
|
|
738 | Returns true iff the Coro object has been cancelled, i.e. |
|
|
739 | it's resources freed because they were C<cancel>'ed, C<terminate>'d, |
|
|
740 | C<safe_cancel>'ed or simply went out of scope. |
|
|
741 | |
|
|
742 | The name "zombie" stems from UNIX culture, where a process that has |
|
|
743 | exited and only stores and exit status and no other resources is called a |
|
|
744 | "zombie". |
|
|
745 | |
715 | =item $is_ready = $coro->is_ready |
746 | =item $is_ready = $coro->is_ready |
716 | |
747 | |
717 | Returns true iff the Coro object is in the ready queue. Unless the Coro |
748 | Returns true iff the Coro object is in the ready queue. Unless the Coro |
718 | object gets destroyed, it will eventually be scheduled by the scheduler. |
749 | object gets destroyed, it will eventually be scheduled by the scheduler. |
719 | |
750 | |
… | |
… | |
728 | Returns true iff this Coro object has been suspended. Suspended Coros will |
759 | Returns true iff this Coro object has been suspended. Suspended Coros will |
729 | not ever be scheduled. |
760 | not ever be scheduled. |
730 | |
761 | |
731 | =item $coro->cancel (arg...) |
762 | =item $coro->cancel (arg...) |
732 | |
763 | |
733 | Terminates the given Coro object and makes it return the given arguments as |
764 | Terminates the given Coro thread and makes it return the given arguments as |
734 | status (default: an empty list). Never returns if the Coro is the |
765 | status (default: an empty list). Never returns if the Coro is the |
735 | current Coro. |
766 | current Coro. |
736 | |
767 | |
737 | The arguments are not copied, but instead will be referenced directly |
768 | This is a rather brutal way to free a coro, with some limitations - if |
738 | (e.g. if you pass C<$var> and after the call change that variable, then |
769 | the thread is inside a C callback that doesn't expect to be canceled, |
739 | you might change the return values passed to e.g. C<join>, so don't do |
770 | bad things can happen, or if the cancelled thread insists on running |
740 | that). |
771 | complicated cleanup handlers that rely on its thread context, things will |
|
|
772 | not work. |
|
|
773 | |
|
|
774 | Any cleanup code being run (e.g. from C<guard> blocks) will be run without |
|
|
775 | a thread context, and is not allowed to switch to other threads. On the |
|
|
776 | plus side, C<< ->cancel >> will always clean up the thread, no matter |
|
|
777 | what. If your cleanup code is complex or you want to avoid cancelling a |
|
|
778 | C-thread that doesn't know how to clean up itself, it can be better to C<< |
|
|
779 | ->throw >> an exception, or use C<< ->safe_cancel >>. |
|
|
780 | |
|
|
781 | The arguments to C<< ->cancel >> are not copied, but instead will |
|
|
782 | be referenced directly (e.g. if you pass C<$var> and after the call |
|
|
783 | change that variable, then you might change the return values passed to |
|
|
784 | e.g. C<join>, so don't do that). |
741 | |
785 | |
742 | The resources of the Coro are usually freed (or destructed) before this |
786 | The resources of the Coro are usually freed (or destructed) before this |
743 | call returns, but this can be delayed for an indefinite amount of time, as |
787 | call returns, but this can be delayed for an indefinite amount of time, as |
744 | in some cases the manager thread has to run first to actually destruct the |
788 | in some cases the manager thread has to run first to actually destruct the |
745 | Coro object. |
789 | Coro object. |
746 | |
790 | |
|
|
791 | =item $coro->safe_cancel ($arg...) |
|
|
792 | |
|
|
793 | Works mostly like C<< ->cancel >>, but is inherently "safer", and |
|
|
794 | consequently, can fail with an exception in cases the thread is not in a |
|
|
795 | cancellable state. |
|
|
796 | |
|
|
797 | This method works a bit like throwing an exception that cannot be caught |
|
|
798 | - specifically, it will clean up the thread from within itself, so |
|
|
799 | all cleanup handlers (e.g. C<guard> blocks) are run with full thread |
|
|
800 | context and can block if they wish. The downside is that there is no |
|
|
801 | guarantee that the thread can be cancelled when you call this method, and |
|
|
802 | therefore, it might fail. It is also considerably slower than C<cancel> or |
|
|
803 | C<terminate>. |
|
|
804 | |
|
|
805 | A thread is in a safe-cancellable state if it either hasn't been run yet, |
|
|
806 | or it has no C context attached and is inside an SLF function. |
|
|
807 | |
|
|
808 | The latter two basically mean that the thread isn't currently inside a |
|
|
809 | perl callback called from some C function (usually via some XS modules) |
|
|
810 | and isn't currently executing inside some C function itself (via Coro's XS |
|
|
811 | API). |
|
|
812 | |
|
|
813 | This call returns true when it could cancel the thread, or croaks with an |
|
|
814 | error otherwise (i.e. it either returns true or doesn't return at all). |
|
|
815 | |
|
|
816 | Why the weird interface? Well, there are two common models on how and |
|
|
817 | when to cancel things. In the first, you have the expectation that your |
|
|
818 | coro thread can be cancelled when you want to cancel it - if the thread |
|
|
819 | isn't cancellable, this would be a bug somewhere, so C<< ->safe_cancel >> |
|
|
820 | croaks to notify of the bug. |
|
|
821 | |
|
|
822 | In the second model you sometimes want to ask nicely to cancel a thread, |
|
|
823 | but if it's not a good time, well, then don't cancel. This can be done |
|
|
824 | relatively easy like this: |
|
|
825 | |
|
|
826 | if (! eval { $coro->safe_cancel }) { |
|
|
827 | warn "unable to cancel thread: $@"; |
|
|
828 | } |
|
|
829 | |
|
|
830 | However, what you never should do is first try to cancel "safely" and |
|
|
831 | if that fails, cancel the "hard" way with C<< ->cancel >>. That makes |
|
|
832 | no sense: either you rely on being able to execute cleanup code in your |
|
|
833 | thread context, or you don't. If you do, then C<< ->safe_cancel >> is the |
|
|
834 | only way, and if you don't, then C<< ->cancel >> is always faster and more |
|
|
835 | direct. |
|
|
836 | |
747 | =item $coro->schedule_to |
837 | =item $coro->schedule_to |
748 | |
838 | |
749 | Puts the current coro to sleep (like C<Coro::schedule>), but instead |
839 | Puts the current coro to sleep (like C<Coro::schedule>), but instead |
750 | of continuing with the next coro from the ready queue, always switch to |
840 | of continuing with the next coro from the ready queue, always switch to |
751 | the given coro object (regardless of priority etc.). The readyness |
841 | the given coro object (regardless of priority etc.). The readyness |
… | |
… | |
769 | inside the coro at the next convenient point in time. Otherwise |
859 | inside the coro at the next convenient point in time. Otherwise |
770 | clears the exception object. |
860 | clears the exception object. |
771 | |
861 | |
772 | Coro will check for the exception each time a schedule-like-function |
862 | Coro will check for the exception each time a schedule-like-function |
773 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
863 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
774 | >>, C<< Coro::Handle->readable >> and so on. Most of these functions |
864 | >>, C<< Coro::Handle->readable >> and so on. Most of those functions (all |
775 | detect this case and return early in case an exception is pending. |
865 | that are part of Coro itself) detect this case and return early in case an |
|
|
866 | exception is pending. |
776 | |
867 | |
777 | The exception object will be thrown "as is" with the specified scalar in |
868 | The exception object will be thrown "as is" with the specified scalar in |
778 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
869 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
779 | (unlike with C<die>). |
870 | (unlike with C<die>). |
780 | |
871 | |
781 | This can be used as a softer means than C<cancel> to ask a coro to |
872 | This can be used as a softer means than either C<cancel> or C<safe_cancel |
782 | end itself, although there is no guarantee that the exception will lead to |
873 | >to ask a coro to end itself, although there is no guarantee that the |
783 | termination, and if the exception isn't caught it might well end the whole |
874 | exception will lead to termination, and if the exception isn't caught it |
784 | program. |
875 | might well end the whole program. |
785 | |
876 | |
786 | You might also think of C<throw> as being the moral equivalent of |
877 | You might also think of C<throw> as being the moral equivalent of |
787 | C<kill>ing a coro with a signal (in this case, a scalar). |
878 | C<kill>ing a coro with a signal (in this case, a scalar). |
788 | |
879 | |
789 | =item $coro->join |
880 | =item $coro->join |
… | |
… | |
791 | Wait until the coro terminates and return any values given to the |
882 | Wait until the coro terminates and return any values given to the |
792 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
883 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
793 | from multiple threads, and all will be resumed and given the status |
884 | from multiple threads, and all will be resumed and given the status |
794 | return once the C<$coro> terminates. |
885 | return once the C<$coro> terminates. |
795 | |
886 | |
796 | =cut |
|
|
797 | |
|
|
798 | sub join { |
|
|
799 | my $self = shift; |
|
|
800 | |
|
|
801 | unless ($self->{_status}) { |
|
|
802 | my $current = $current; |
|
|
803 | |
|
|
804 | push @{$self->{_on_destroy}}, sub { |
|
|
805 | $current->ready; |
|
|
806 | undef $current; |
|
|
807 | }; |
|
|
808 | |
|
|
809 | &schedule while $current; |
|
|
810 | } |
|
|
811 | |
|
|
812 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
|
|
813 | } |
|
|
814 | |
|
|
815 | =item $coro->on_destroy (\&cb) |
887 | =item $coro->on_destroy (\&cb) |
816 | |
888 | |
817 | Registers a callback that is called when this coro thread gets destroyed, |
889 | Registers a callback that is called when this coro thread gets destroyed, |
818 | but before it is joined. The callback gets passed the terminate arguments, |
890 | that is, after it's resources have been freed but before it is joined. The |
|
|
891 | callback gets passed the terminate/cancel arguments, if any, and I<must |
819 | if any, and I<must not> die, under any circumstances. |
892 | not> die, under any circumstances. |
820 | |
893 | |
821 | There can be any number of C<on_destroy> callbacks per coro. |
894 | There can be any number of C<on_destroy> callbacks per coro, and there is |
822 | |
895 | no way currently to remove a callback once added. |
823 | =cut |
|
|
824 | |
|
|
825 | sub on_destroy { |
|
|
826 | my ($self, $cb) = @_; |
|
|
827 | |
|
|
828 | push @{ $self->{_on_destroy} }, $cb; |
|
|
829 | } |
|
|
830 | |
896 | |
831 | =item $oldprio = $coro->prio ($newprio) |
897 | =item $oldprio = $coro->prio ($newprio) |
832 | |
898 | |
833 | Sets (or gets, if the argument is missing) the priority of the |
899 | Sets (or gets, if the argument is missing) the priority of the |
834 | coro thread. Higher priority coro get run before lower priority |
900 | coro thread. Higher priority coro get run before lower priority |
… | |
… | |
1106 | future to allow per-thread schedulers, but Coro::State does not yet allow |
1172 | future to allow per-thread schedulers, but Coro::State does not yet allow |
1107 | this). I recommend disabling thread support and using processes, as having |
1173 | this). I recommend disabling thread support and using processes, as having |
1108 | the windows process emulation enabled under unix roughly halves perl |
1174 | the windows process emulation enabled under unix roughly halves perl |
1109 | performance, even when not used. |
1175 | performance, even when not used. |
1110 | |
1176 | |
|
|
1177 | Attempts to use threads created in another emulated process will crash |
|
|
1178 | ("cleanly", with a null pointer exception). |
|
|
1179 | |
1111 | =item coro switching is not signal safe |
1180 | =item coro switching is not signal safe |
1112 | |
1181 | |
1113 | You must not switch to another coro from within a signal handler (only |
1182 | You must not switch to another coro from within a signal handler (only |
1114 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
1183 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
1115 | you are sure you are not interrupting a Coro function. |
1184 | you are sure you are not interrupting a Coro function. |