1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | Coro - coroutine process abstraction |
3 | Coro - the only real threads in perl |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use Coro; |
7 | use Coro; |
8 | |
8 | |
… | |
… | |
11 | print "2\n"; |
11 | print "2\n"; |
12 | cede; # yield back to main |
12 | cede; # yield back to main |
13 | print "4\n"; |
13 | print "4\n"; |
14 | }; |
14 | }; |
15 | print "1\n"; |
15 | print "1\n"; |
16 | cede; # yield to coroutine |
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; |
21 | use Coro::Semaphore; |
… | |
… | |
26 | $locked = 1; |
26 | $locked = 1; |
27 | $lock->up; |
27 | $lock->up; |
28 | |
28 | |
29 | =head1 DESCRIPTION |
29 | =head1 DESCRIPTION |
30 | |
30 | |
31 | This module collection manages coroutines. Coroutines are similar to |
31 | For a tutorial-style introduction, please read the L<Coro::Intro> |
32 | threads but don't (in general) run in parallel at the same time even |
32 | manpage. This manpage mainly contains reference information. |
33 | on SMP machines. The specific flavor of coroutine used in this module |
|
|
34 | also guarantees you that it will not switch between coroutines unless |
|
|
35 | necessary, at easily-identified points in your program, so locking and |
|
|
36 | parallel access are rarely an issue, making coroutine programming much |
|
|
37 | safer and easier than threads programming. |
|
|
38 | |
33 | |
39 | Unlike a normal perl program, however, coroutines allow you to have |
34 | This module collection manages continuations in general, most often in |
40 | multiple running interpreters that share data, which is especially useful |
35 | the form of cooperative threads (also called coros, or simply "coro" |
41 | to code pseudo-parallel processes and for event-based programming, such as |
36 | in the documentation). They are similar to kernel threads but don't (in |
42 | multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> to |
37 | general) run in parallel at the same time even on SMP machines. The |
43 | learn more. |
38 | specific flavor of thread offered by this module also guarantees you that |
|
|
39 | it will not switch between threads unless necessary, at easily-identified |
|
|
40 | points in your program, so locking and parallel access are rarely an |
|
|
41 | issue, making thread programming much safer and easier than using other |
|
|
42 | thread models. |
44 | |
43 | |
45 | Coroutines are also useful because Perl has no support for threads (the so |
44 | Unlike the so-called "Perl threads" (which are not actually real threads |
46 | called "threads" that perl offers are nothing more than the (bad) process |
45 | but only the windows process emulation ported to unix, and as such act |
47 | emulation coming from the Windows platform: On standard operating systems |
46 | as processes), Coro provides a full shared address space, which makes |
48 | they serve no purpose whatsoever, except by making your programs slow and |
47 | communication between threads very easy. And Coro's threads are fast, |
49 | making them use a lot of memory. Best disable them when building perl, or |
48 | too: disabling the Windows process emulation code in your perl and using |
50 | aks your software vendor/distributor to do it for you). |
49 | Coro can easily result in a two to four times speed increase for your |
|
|
50 | programs. A parallel matrix multiplication benchmark runs over 300 times |
|
|
51 | faster on a single core than perl's pseudo-threads on a quad core using |
|
|
52 | all four cores. |
51 | |
53 | |
|
|
54 | Coro achieves that by supporting multiple running interpreters that share |
|
|
55 | data, which is especially useful to code pseudo-parallel processes and |
|
|
56 | for event-based programming, such as multiple HTTP-GET requests running |
|
|
57 | concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro |
|
|
58 | into an event-based environment. |
|
|
59 | |
52 | In this module, coroutines are defined as "callchain + lexical variables + |
60 | In this module, a thread is defined as "callchain + lexical variables + |
53 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
61 | some package variables + C stack), that is, a thread has its own callchain, |
54 | its own set of lexicals and its own set of perls most important global |
62 | its own set of lexicals and its own set of perls most important global |
55 | variables (see L<Coro::State> for more configuration). |
63 | variables (see L<Coro::State> for more configuration and background info). |
|
|
64 | |
|
|
65 | See also the C<SEE ALSO> section at the end of this document - the Coro |
|
|
66 | module family is quite large. |
56 | |
67 | |
57 | =cut |
68 | =cut |
58 | |
69 | |
59 | package Coro; |
70 | package Coro; |
60 | |
71 | |
61 | use strict; |
72 | use strict qw(vars subs); |
62 | no warnings "uninitialized"; |
73 | no warnings "uninitialized"; |
63 | |
74 | |
|
|
75 | use Guard (); |
|
|
76 | |
64 | use Coro::State; |
77 | use Coro::State; |
65 | |
78 | |
66 | use base qw(Coro::State Exporter); |
79 | use base qw(Coro::State Exporter); |
67 | |
80 | |
68 | our $idle; # idle handler |
81 | our $idle; # idle handler |
69 | our $main; # main coroutine |
82 | our $main; # main coro |
70 | our $current; # current coroutine |
83 | our $current; # current coro |
71 | |
84 | |
72 | our $VERSION = 4.749; |
85 | our $VERSION = 5.161; |
73 | |
86 | |
74 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
87 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
75 | our %EXPORT_TAGS = ( |
88 | our %EXPORT_TAGS = ( |
76 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
89 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
77 | ); |
90 | ); |
78 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
91 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
79 | |
92 | |
|
|
93 | =head1 GLOBAL VARIABLES |
|
|
94 | |
80 | =over 4 |
95 | =over 4 |
81 | |
96 | |
82 | =item $Coro::main |
97 | =item $Coro::main |
83 | |
98 | |
84 | This variable stores the coroutine object that represents the main |
99 | This variable stores the Coro object that represents the main |
85 | program. While you cna C<ready> it and do most other things you can do to |
100 | program. While you cna C<ready> it and do most other things you can do to |
86 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
101 | coro, it is mainly useful to compare again C<$Coro::current>, to see |
87 | whether you are running in the main program or not. |
102 | whether you are running in the main program or not. |
88 | |
103 | |
89 | =cut |
104 | =cut |
90 | |
105 | |
91 | $main = new Coro; |
106 | # $main is now being initialised by Coro::State |
92 | |
107 | |
93 | =item $Coro::current |
108 | =item $Coro::current |
94 | |
109 | |
95 | The coroutine object representing the current coroutine (the last |
110 | The Coro object representing the current coro (the last |
96 | coroutine that the Coro scheduler switched to). The initial value is |
111 | coro that the Coro scheduler switched to). The initial value is |
97 | C<$main> (of course). |
112 | C<$Coro::main> (of course). |
98 | |
113 | |
99 | This variable is B<strictly> I<read-only>. You can take copies of the |
114 | This variable is B<strictly> I<read-only>. You can take copies of the |
100 | value stored in it and use it as any other coroutine object, but you must |
115 | value stored in it and use it as any other Coro object, but you must |
101 | not otherwise modify the variable itself. |
116 | not otherwise modify the variable itself. |
102 | |
117 | |
103 | =cut |
118 | =cut |
104 | |
119 | |
105 | $main->{desc} = "[main::]"; |
|
|
106 | |
|
|
107 | # maybe some other module used Coro::Specific before... |
|
|
108 | $main->{_specific} = $current->{_specific} |
|
|
109 | if $current; |
|
|
110 | |
|
|
111 | _set_current $main; |
|
|
112 | |
|
|
113 | sub current() { $current } # [DEPRECATED] |
120 | sub current() { $current } # [DEPRECATED] |
114 | |
121 | |
115 | =item $Coro::idle |
122 | =item $Coro::idle |
116 | |
123 | |
117 | This variable is mainly useful to integrate Coro into event loops. It is |
124 | This variable is mainly useful to integrate Coro into event loops. It is |
118 | usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is |
125 | usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is |
119 | pretty low-level functionality. |
126 | pretty low-level functionality. |
120 | |
127 | |
121 | This variable stores a callback that is called whenever the scheduler |
128 | This variable stores either a Coro object or a callback. |
|
|
129 | |
|
|
130 | If it is a callback, the it is called whenever the scheduler finds no |
122 | finds no ready coroutines to run. The default implementation prints |
131 | ready coros to run. The default implementation prints "FATAL: |
123 | "FATAL: deadlock detected" and exits, because the program has no other way |
132 | deadlock detected" and exits, because the program has no other way to |
124 | to continue. |
133 | continue. |
125 | |
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 | |
126 | This hook is overwritten by modules such as C<Coro::Timer> and |
139 | This hook is overwritten by modules such as C<Coro::EV> and |
127 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
140 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
128 | coroutine so the scheduler can run it. |
141 | coro so the scheduler can run it. |
129 | |
142 | |
130 | Note that the callback I<must not>, under any circumstances, block |
143 | Note that the callback I<must not>, under any circumstances, block |
131 | the current coroutine. Normally, this is achieved by having an "idle |
144 | the current coro. Normally, this is achieved by having an "idle |
132 | coroutine" that calls the event loop and then blocks again, and then |
145 | coro" that calls the event loop and then blocks again, and then |
133 | readying that coroutine in the idle handler. |
146 | readying that coro in the idle handler, or by simply placing the idle |
|
|
147 | coro in this variable. |
134 | |
148 | |
135 | See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this |
149 | See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this |
136 | technique. |
150 | technique. |
137 | |
151 | |
138 | Please note that if your callback recursively invokes perl (e.g. for event |
152 | Please note that if your callback recursively invokes perl (e.g. for event |
… | |
… | |
143 | $idle = sub { |
157 | $idle = sub { |
144 | require Carp; |
158 | require Carp; |
145 | Carp::croak ("FATAL: deadlock detected"); |
159 | Carp::croak ("FATAL: deadlock detected"); |
146 | }; |
160 | }; |
147 | |
161 | |
148 | sub _cancel { |
|
|
149 | my ($self) = @_; |
|
|
150 | |
|
|
151 | # free coroutine data and mark as destructed |
|
|
152 | $self->_destroy |
|
|
153 | or return; |
|
|
154 | |
|
|
155 | # call all destruction callbacks |
|
|
156 | $_->(@{$self->{_status}}) |
|
|
157 | for @{(delete $self->{_on_destroy}) || []}; |
|
|
158 | } |
|
|
159 | |
|
|
160 | # this coroutine is necessary because a coroutine |
162 | # this coro is necessary because a coro |
161 | # cannot destroy itself. |
163 | # cannot destroy itself. |
162 | my @destroy; |
164 | our @destroy; |
163 | my $manager; |
165 | our $manager; |
164 | |
166 | |
165 | $manager = new Coro sub { |
167 | $manager = new Coro sub { |
166 | while () { |
168 | while () { |
167 | (shift @destroy)->_cancel |
169 | Coro::State::cancel shift @destroy |
168 | while @destroy; |
170 | while @destroy; |
169 | |
171 | |
170 | &schedule; |
172 | &schedule; |
171 | } |
173 | } |
172 | }; |
174 | }; |
173 | $manager->desc ("[coro manager]"); |
175 | $manager->{desc} = "[coro manager]"; |
174 | $manager->prio (PRIO_MAX); |
176 | $manager->prio (PRIO_MAX); |
175 | |
177 | |
176 | =back |
178 | =back |
177 | |
179 | |
178 | =head2 SIMPLE COROUTINE CREATION |
180 | =head1 SIMPLE CORO CREATION |
179 | |
181 | |
180 | =over 4 |
182 | =over 4 |
181 | |
183 | |
182 | =item async { ... } [@args...] |
184 | =item async { ... } [@args...] |
183 | |
185 | |
184 | Create a new coroutine and return it's coroutine object (usually |
186 | Create a new coro and return its Coro object (usually |
185 | unused). The coroutine will be put into the ready queue, so |
187 | unused). The coro will be put into the ready queue, so |
186 | it will start running automatically on the next scheduler run. |
188 | it will start running automatically on the next scheduler run. |
187 | |
189 | |
188 | The first argument is a codeblock/closure that should be executed in the |
190 | The first argument is a codeblock/closure that should be executed in the |
189 | coroutine. When it returns argument returns the coroutine is automatically |
191 | coro. When it returns argument returns the coro is automatically |
190 | terminated. |
192 | terminated. |
191 | |
193 | |
192 | The remaining arguments are passed as arguments to the closure. |
194 | The remaining arguments are passed as arguments to the closure. |
193 | |
195 | |
194 | See the C<Coro::State::new> constructor for info about the coroutine |
196 | See the C<Coro::State::new> constructor for info about the coro |
195 | environment in which coroutines are executed. |
197 | environment in which coro are executed. |
196 | |
198 | |
197 | Calling C<exit> in a coroutine will do the same as calling exit outside |
199 | Calling C<exit> in a coro will do the same as calling exit outside |
198 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
200 | the coro. Likewise, when the coro dies, the program will exit, |
199 | just as it would in the main program. |
201 | just as it would in the main program. |
200 | |
202 | |
201 | If you do not want that, you can provide a default C<die> handler, or |
203 | If you do not want that, you can provide a default C<die> handler, or |
202 | simply avoid dieing (by use of C<eval>). |
204 | simply avoid dieing (by use of C<eval>). |
203 | |
205 | |
204 | Example: Create a new coroutine that just prints its arguments. |
206 | Example: Create a new coro that just prints its arguments. |
205 | |
207 | |
206 | async { |
208 | async { |
207 | print "@_\n"; |
209 | print "@_\n"; |
208 | } 1,2,3,4; |
210 | } 1,2,3,4; |
209 | |
211 | |
… | |
… | |
215 | $coro |
217 | $coro |
216 | } |
218 | } |
217 | |
219 | |
218 | =item async_pool { ... } [@args...] |
220 | =item async_pool { ... } [@args...] |
219 | |
221 | |
220 | Similar to C<async>, but uses a coroutine pool, so you should not call |
222 | Similar to C<async>, but uses a coro pool, so you should not call |
221 | terminate or join on it (although you are allowed to), and you get a |
223 | terminate or join on it (although you are allowed to), and you get a |
222 | coroutine that might have executed other code already (which can be good |
224 | coro that might have executed other code already (which can be good |
223 | or bad :). |
225 | or bad :). |
224 | |
226 | |
225 | On the plus side, this function is faster than creating (and destroying) |
227 | On the plus side, this function is about twice as fast as creating (and |
226 | a completely new coroutine, so if you need a lot of generic coroutines in |
228 | destroying) a completely new coro, so if you need a lot of generic |
227 | quick successsion, use C<async_pool>, not C<async>. |
229 | coros in quick successsion, use C<async_pool>, not C<async>. |
228 | |
230 | |
229 | The code block is executed in an C<eval> context and a warning will be |
231 | The code block is executed in an C<eval> context and a warning will be |
230 | issued in case of an exception instead of terminating the program, as |
232 | issued in case of an exception instead of terminating the program, as |
231 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
233 | C<async> does. As the coro is being reused, stuff like C<on_destroy> |
232 | will not work in the expected way, unless you call terminate or cancel, |
234 | will not work in the expected way, unless you call terminate or cancel, |
233 | which somehow defeats the purpose of pooling (but is fine in the |
235 | which somehow defeats the purpose of pooling (but is fine in the |
234 | exceptional case). |
236 | exceptional case). |
235 | |
237 | |
236 | The priority will be reset to C<0> after each run, tracing will be |
238 | The priority will be reset to C<0> after each run, tracing will be |
237 | disabled, the description will be reset and the default output filehandle |
239 | disabled, the description will be reset and the default output filehandle |
238 | gets restored, so you can change all these. Otherwise the coroutine will |
240 | gets restored, so you can change all these. Otherwise the coro will |
239 | be re-used "as-is": most notably if you change other per-coroutine global |
241 | be re-used "as-is": most notably if you change other per-coro global |
240 | stuff such as C<$/> you I<must needs> to revert that change, which is most |
242 | stuff such as C<$/> you I<must needs> revert that change, which is most |
241 | simply done by using local as in: C< local $/ >. |
243 | simply done by using local as in: C<< local $/ >>. |
242 | |
244 | |
243 | The pool size is limited to C<8> idle coroutines (this can be adjusted by |
245 | The idle pool size is limited to C<8> idle coros (this can be |
244 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
246 | adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle |
245 | required. |
247 | coros as required. |
246 | |
248 | |
247 | If you are concerned about pooled coroutines growing a lot because a |
249 | If you are concerned about pooled coros growing a lot because a |
248 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
250 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
249 | { terminate }> once per second or so to slowly replenish the pool. In |
251 | { terminate }> once per second or so to slowly replenish the pool. In |
250 | addition to that, when the stacks used by a handler grows larger than 16kb |
252 | addition to that, when the stacks used by a handler grows larger than 32kb |
251 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
253 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
252 | |
254 | |
253 | =cut |
255 | =cut |
254 | |
256 | |
255 | our $POOL_SIZE = 8; |
257 | our $POOL_SIZE = 8; |
256 | our $POOL_RSS = 16 * 1024; |
258 | our $POOL_RSS = 32 * 1024; |
257 | our @async_pool; |
259 | our @async_pool; |
258 | |
260 | |
259 | sub pool_handler { |
261 | sub pool_handler { |
260 | my $cb; |
|
|
261 | |
|
|
262 | while () { |
262 | while () { |
263 | eval { |
263 | eval { |
264 | while () { |
264 | &{&_pool_handler} while 1; |
265 | _pool_1 $cb; |
|
|
266 | &$cb; |
|
|
267 | _pool_2 $cb; |
|
|
268 | &schedule; |
|
|
269 | } |
|
|
270 | }; |
265 | }; |
271 | |
266 | |
272 | if ($@) { |
|
|
273 | last if $@ eq "\3async_pool terminate\2\n"; |
|
|
274 | warn $@; |
267 | warn $@ if $@; |
275 | } |
|
|
276 | } |
268 | } |
277 | } |
269 | } |
278 | |
270 | |
279 | sub async_pool(&@) { |
|
|
280 | # this is also inlined into the unlock_scheduler |
|
|
281 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
282 | |
|
|
283 | $coro->{_invoke} = [@_]; |
|
|
284 | $coro->ready; |
|
|
285 | |
|
|
286 | $coro |
|
|
287 | } |
|
|
288 | |
|
|
289 | =back |
271 | =back |
290 | |
272 | |
291 | =head2 STATIC METHODS |
273 | =head1 STATIC METHODS |
292 | |
274 | |
293 | Static methods are actually functions that operate on the current coroutine. |
275 | Static methods are actually functions that implicitly operate on the |
|
|
276 | current coro. |
294 | |
277 | |
295 | =over 4 |
278 | =over 4 |
296 | |
279 | |
297 | =item schedule |
280 | =item schedule |
298 | |
281 | |
299 | Calls the scheduler. The scheduler will find the next coroutine that is |
282 | Calls the scheduler. The scheduler will find the next coro that is |
300 | to be run from the ready queue and switches to it. The next coroutine |
283 | to be run from the ready queue and switches to it. The next coro |
301 | to be run is simply the one with the highest priority that is longest |
284 | to be run is simply the one with the highest priority that is longest |
302 | in its ready queue. If there is no coroutine ready, it will clal the |
285 | in its ready queue. If there is no coro ready, it will clal the |
303 | C<$Coro::idle> hook. |
286 | C<$Coro::idle> hook. |
304 | |
287 | |
305 | Please note that the current coroutine will I<not> be put into the ready |
288 | Please note that the current coro will I<not> be put into the ready |
306 | queue, so calling this function usually means you will never be called |
289 | queue, so calling this function usually means you will never be called |
307 | again unless something else (e.g. an event handler) calls C<< ->ready >>, |
290 | again unless something else (e.g. an event handler) calls C<< ->ready >>, |
308 | thus waking you up. |
291 | thus waking you up. |
309 | |
292 | |
310 | This makes C<schedule> I<the> generic method to use to block the current |
293 | This makes C<schedule> I<the> generic method to use to block the current |
311 | coroutine and wait for events: first you remember the current coroutine in |
294 | coro and wait for events: first you remember the current coro in |
312 | a variable, then arrange for some callback of yours to call C<< ->ready |
295 | a variable, then arrange for some callback of yours to call C<< ->ready |
313 | >> on that once some event happens, and last you call C<schedule> to put |
296 | >> on that once some event happens, and last you call C<schedule> to put |
314 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
297 | yourself to sleep. Note that a lot of things can wake your coro up, |
315 | so you need to check whether the event indeed happened, e.g. by storing the |
298 | so you need to check whether the event indeed happened, e.g. by storing the |
316 | status in a variable. |
299 | status in a variable. |
317 | |
300 | |
318 | The canonical way to wait on external events is this: |
301 | See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks. |
319 | |
302 | |
320 | { |
303 | =item cede |
321 | # remember current coroutine |
|
|
322 | my $current = $Coro::current; |
|
|
323 | |
304 | |
324 | # register a hypothetical event handler |
305 | "Cede" to other coros. This function puts the current coro into |
325 | on_event_invoke sub { |
306 | the ready queue and calls C<schedule>, which has the effect of giving |
326 | # wake up sleeping coroutine |
307 | up the current "timeslice" to other coros of the same or higher |
327 | $current->ready; |
308 | priority. Once your coro gets its turn again it will automatically be |
328 | undef $current; |
309 | resumed. |
|
|
310 | |
|
|
311 | This function is often called C<yield> in other languages. |
|
|
312 | |
|
|
313 | =item Coro::cede_notself |
|
|
314 | |
|
|
315 | Works like cede, but is not exported by default and will cede to I<any> |
|
|
316 | coro, regardless of priority. This is useful sometimes to ensure |
|
|
317 | progress is made. |
|
|
318 | |
|
|
319 | =item terminate [arg...] |
|
|
320 | |
|
|
321 | Terminates the current coro with the given status values (see L<cancel>). |
|
|
322 | |
|
|
323 | =item Coro::on_enter BLOCK, Coro::on_leave BLOCK |
|
|
324 | |
|
|
325 | These function install enter and leave winders in the current scope. The |
|
|
326 | enter block will be executed when on_enter is called and whenever the |
|
|
327 | current coro is re-entered by the scheduler, while the leave block is |
|
|
328 | executed whenever the current coro is blocked by the scheduler, and |
|
|
329 | also when the containing scope is exited (by whatever means, be it exit, |
|
|
330 | die, last etc.). |
|
|
331 | |
|
|
332 | I<Neither invoking the scheduler, nor exceptions, are allowed within those |
|
|
333 | BLOCKs>. That means: do not even think about calling C<die> without an |
|
|
334 | eval, and do not even think of entering the scheduler in any way. |
|
|
335 | |
|
|
336 | Since both BLOCKs are tied to the current scope, they will automatically |
|
|
337 | be removed when the current scope exits. |
|
|
338 | |
|
|
339 | These functions implement the same concept as C<dynamic-wind> in scheme |
|
|
340 | does, and are useful when you want to localise some resource to a specific |
|
|
341 | coro. |
|
|
342 | |
|
|
343 | They slow down thread switching considerably for coros that use them |
|
|
344 | (about 40% for a BLOCK with a single assignment, so thread switching is |
|
|
345 | still reasonably fast if the handlers are fast). |
|
|
346 | |
|
|
347 | These functions are best understood by an example: The following function |
|
|
348 | will change the current timezone to "Antarctica/South_Pole", which |
|
|
349 | requires a call to C<tzset>, but by using C<on_enter> and C<on_leave>, |
|
|
350 | which remember/change the current timezone and restore the previous |
|
|
351 | value, respectively, the timezone is only changed for the coro that |
|
|
352 | installed those handlers. |
|
|
353 | |
|
|
354 | use POSIX qw(tzset); |
|
|
355 | |
|
|
356 | async { |
|
|
357 | my $old_tz; # store outside TZ value here |
|
|
358 | |
|
|
359 | Coro::on_enter { |
|
|
360 | $old_tz = $ENV{TZ}; # remember the old value |
|
|
361 | |
|
|
362 | $ENV{TZ} = "Antarctica/South_Pole"; |
|
|
363 | tzset; # enable new value |
329 | }; |
364 | }; |
330 | |
365 | |
331 | # call schedule until event occurred. |
366 | Coro::on_leave { |
332 | # in case we are woken up for other reasons |
367 | $ENV{TZ} = $old_tz; |
333 | # (current still defined), loop. |
368 | tzset; # restore old value |
334 | Coro::schedule while $current; |
369 | }; |
|
|
370 | |
|
|
371 | # at this place, the timezone is Antarctica/South_Pole, |
|
|
372 | # without disturbing the TZ of any other coro. |
335 | } |
373 | }; |
336 | |
374 | |
337 | =item cede |
375 | This can be used to localise about any resource (locale, uid, current |
|
|
376 | working directory etc.) to a block, despite the existance of other |
|
|
377 | coros. |
338 | |
378 | |
339 | "Cede" to other coroutines. This function puts the current coroutine into |
379 | Another interesting example implements time-sliced multitasking using |
340 | the ready queue and calls C<schedule>, which has the effect of giving |
380 | interval timers (this could obviously be optimised, but does the job): |
341 | up the current "timeslice" to other coroutines of the same or higher |
|
|
342 | priority. Once your coroutine gets its turn again it will automatically be |
|
|
343 | resumed. |
|
|
344 | |
381 | |
345 | This function is often called C<yield> in other languages. |
382 | # "timeslice" the given block |
|
|
383 | sub timeslice(&) { |
|
|
384 | use Time::HiRes (); |
346 | |
385 | |
347 | =item Coro::cede_notself |
386 | Coro::on_enter { |
|
|
387 | # on entering the thread, we set an VTALRM handler to cede |
|
|
388 | $SIG{VTALRM} = sub { cede }; |
|
|
389 | # and then start the interval timer |
|
|
390 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01; |
|
|
391 | }; |
|
|
392 | Coro::on_leave { |
|
|
393 | # on leaving the thread, we stop the interval timer again |
|
|
394 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0; |
|
|
395 | }; |
348 | |
396 | |
349 | Works like cede, but is not exported by default and will cede to I<any> |
397 | &{+shift}; |
350 | coroutine, regardless of priority. This is useful sometimes to ensure |
398 | } |
351 | progress is made. |
|
|
352 | |
399 | |
353 | =item terminate [arg...] |
400 | # use like this: |
|
|
401 | timeslice { |
|
|
402 | # The following is an endless loop that would normally |
|
|
403 | # monopolise the process. Since it runs in a timesliced |
|
|
404 | # environment, it will regularly cede to other threads. |
|
|
405 | while () { } |
|
|
406 | }; |
354 | |
407 | |
355 | Terminates the current coroutine with the given status values (see L<cancel>). |
|
|
356 | |
408 | |
357 | =item killall |
409 | =item killall |
358 | |
410 | |
359 | Kills/terminates/cancels all coroutines except the currently running |
411 | Kills/terminates/cancels all coros except the currently running one. |
360 | one. This is useful after a fork, either in the child or the parent, as |
|
|
361 | usually only one of them should inherit the running coroutines. |
|
|
362 | |
412 | |
363 | Note that while this will try to free some of the main programs resources, |
413 | Note that while this will try to free some of the main interpreter |
|
|
414 | resources if the calling coro isn't the main coro, but one |
364 | you cannot free all of them, so if a coroutine that is not the main |
415 | cannot free all of them, so if a coro that is not the main coro |
365 | program calls this function, there will be some one-time resource leak. |
416 | calls this function, there will be some one-time resource leak. |
366 | |
417 | |
367 | =cut |
418 | =cut |
368 | |
|
|
369 | sub terminate { |
|
|
370 | $current->cancel (@_); |
|
|
371 | } |
|
|
372 | |
419 | |
373 | sub killall { |
420 | sub killall { |
374 | for (Coro::State::list) { |
421 | for (Coro::State::list) { |
375 | $_->cancel |
422 | $_->cancel |
376 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
423 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
377 | } |
424 | } |
378 | } |
425 | } |
379 | |
426 | |
380 | =back |
427 | =back |
381 | |
428 | |
382 | =head2 COROUTINE METHODS |
429 | =head1 CORO OBJECT METHODS |
383 | |
430 | |
384 | These are the methods you can call on coroutine objects (or to create |
431 | These are the methods you can call on coro objects (or to create |
385 | them). |
432 | them). |
386 | |
433 | |
387 | =over 4 |
434 | =over 4 |
388 | |
435 | |
389 | =item new Coro \&sub [, @args...] |
436 | =item new Coro \&sub [, @args...] |
390 | |
437 | |
391 | Create a new coroutine and return it. When the sub returns, the coroutine |
438 | Create a new coro and return it. When the sub returns, the coro |
392 | automatically terminates as if C<terminate> with the returned values were |
439 | automatically terminates as if C<terminate> with the returned values were |
393 | called. To make the coroutine run you must first put it into the ready |
440 | called. To make the coro run you must first put it into the ready |
394 | queue by calling the ready method. |
441 | queue by calling the ready method. |
395 | |
442 | |
396 | See C<async> and C<Coro::State::new> for additional info about the |
443 | See C<async> and C<Coro::State::new> for additional info about the |
397 | coroutine environment. |
444 | coro environment. |
398 | |
445 | |
399 | =cut |
446 | =cut |
400 | |
447 | |
401 | sub _run_coro { |
448 | sub _coro_run { |
402 | terminate &{+shift}; |
449 | terminate &{+shift}; |
403 | } |
450 | } |
404 | |
451 | |
405 | sub new { |
|
|
406 | my $class = shift; |
|
|
407 | |
|
|
408 | $class->SUPER::new (\&_run_coro, @_) |
|
|
409 | } |
|
|
410 | |
|
|
411 | =item $success = $coroutine->ready |
452 | =item $success = $coro->ready |
412 | |
453 | |
413 | Put the given coroutine into the end of its ready queue (there is one |
454 | Put the given coro into the end of its ready queue (there is one |
414 | queue for each priority) and return true. If the coroutine is already in |
455 | queue for each priority) and return true. If the coro is already in |
415 | the ready queue, do nothing and return false. |
456 | the ready queue, do nothing and return false. |
416 | |
457 | |
417 | This ensures that the scheduler will resume this coroutine automatically |
458 | This ensures that the scheduler will resume this coro automatically |
418 | once all the coroutines of higher priority and all coroutines of the same |
459 | once all the coro of higher priority and all coro of the same |
419 | priority that were put into the ready queue earlier have been resumed. |
460 | priority that were put into the ready queue earlier have been resumed. |
420 | |
461 | |
|
|
462 | =item $coro->suspend |
|
|
463 | |
|
|
464 | Suspends the specified coro. A suspended coro works just like any other |
|
|
465 | coro, except that the scheduler will not select a suspended coro for |
|
|
466 | execution. |
|
|
467 | |
|
|
468 | Suspending a coro can be useful when you want to keep the coro from |
|
|
469 | running, but you don't want to destroy it, or when you want to temporarily |
|
|
470 | freeze a coro (e.g. for debugging) to resume it later. |
|
|
471 | |
|
|
472 | A scenario for the former would be to suspend all (other) coros after a |
|
|
473 | fork and keep them alive, so their destructors aren't called, but new |
|
|
474 | coros can be created. |
|
|
475 | |
|
|
476 | =item $coro->resume |
|
|
477 | |
|
|
478 | If the specified coro was suspended, it will be resumed. Note that when |
|
|
479 | the coro was in the ready queue when it was suspended, it might have been |
|
|
480 | unreadied by the scheduler, so an activation might have been lost. |
|
|
481 | |
|
|
482 | To avoid this, it is best to put a suspended coro into the ready queue |
|
|
483 | unconditionally, as every synchronisation mechanism must protect itself |
|
|
484 | against spurious wakeups, and the one in the Coro family certainly do |
|
|
485 | that. |
|
|
486 | |
421 | =item $is_ready = $coroutine->is_ready |
487 | =item $is_ready = $coro->is_ready |
422 | |
488 | |
423 | Return whether the coroutine is currently the ready queue or not, |
489 | Returns true iff the Coro object is in the ready queue. Unless the Coro |
|
|
490 | object gets destroyed, it will eventually be scheduled by the scheduler. |
424 | |
491 | |
|
|
492 | =item $is_running = $coro->is_running |
|
|
493 | |
|
|
494 | Returns true iff the Coro object is currently running. Only one Coro object |
|
|
495 | can ever be in the running state (but it currently is possible to have |
|
|
496 | multiple running Coro::States). |
|
|
497 | |
|
|
498 | =item $is_suspended = $coro->is_suspended |
|
|
499 | |
|
|
500 | Returns true iff this Coro object has been suspended. Suspended Coros will |
|
|
501 | not ever be scheduled. |
|
|
502 | |
425 | =item $coroutine->cancel (arg...) |
503 | =item $coro->cancel (arg...) |
426 | |
504 | |
427 | Terminates the given coroutine and makes it return the given arguments as |
505 | Terminates the given Coro and makes it return the given arguments as |
428 | status (default: the empty list). Never returns if the coroutine is the |
506 | status (default: the empty list). Never returns if the Coro is the |
429 | current coroutine. |
507 | current Coro. |
430 | |
508 | |
431 | =cut |
509 | =cut |
432 | |
510 | |
433 | sub cancel { |
511 | sub cancel { |
434 | my $self = shift; |
512 | my $self = shift; |
435 | $self->{_status} = [@_]; |
|
|
436 | |
513 | |
437 | if ($current == $self) { |
514 | if ($current == $self) { |
438 | push @destroy, $self; |
515 | terminate @_; |
439 | $manager->ready; |
|
|
440 | &schedule while 1; |
|
|
441 | } else { |
516 | } else { |
442 | $self->_cancel; |
517 | $self->{_status} = [@_]; |
|
|
518 | Coro::State::cancel $self; |
443 | } |
519 | } |
444 | } |
520 | } |
445 | |
521 | |
|
|
522 | =item $coro->schedule_to |
|
|
523 | |
|
|
524 | Puts the current coro to sleep (like C<Coro::schedule>), but instead |
|
|
525 | of continuing with the next coro from the ready queue, always switch to |
|
|
526 | the given coro object (regardless of priority etc.). The readyness |
|
|
527 | state of that coro isn't changed. |
|
|
528 | |
|
|
529 | This is an advanced method for special cases - I'd love to hear about any |
|
|
530 | uses for this one. |
|
|
531 | |
|
|
532 | =item $coro->cede_to |
|
|
533 | |
|
|
534 | Like C<schedule_to>, but puts the current coro into the ready |
|
|
535 | queue. This has the effect of temporarily switching to the given |
|
|
536 | coro, and continuing some time later. |
|
|
537 | |
|
|
538 | This is an advanced method for special cases - I'd love to hear about any |
|
|
539 | uses for this one. |
|
|
540 | |
|
|
541 | =item $coro->throw ([$scalar]) |
|
|
542 | |
|
|
543 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
544 | inside the coro at the next convenient point in time. Otherwise |
|
|
545 | clears the exception object. |
|
|
546 | |
|
|
547 | Coro will check for the exception each time a schedule-like-function |
|
|
548 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
|
|
549 | >>, C<< Coro::Handle->readable >> and so on. Most of these functions |
|
|
550 | detect this case and return early in case an exception is pending. |
|
|
551 | |
|
|
552 | The exception object will be thrown "as is" with the specified scalar in |
|
|
553 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
554 | (unlike with C<die>). |
|
|
555 | |
|
|
556 | This can be used as a softer means than C<cancel> to ask a coro to |
|
|
557 | end itself, although there is no guarantee that the exception will lead to |
|
|
558 | termination, and if the exception isn't caught it might well end the whole |
|
|
559 | program. |
|
|
560 | |
|
|
561 | You might also think of C<throw> as being the moral equivalent of |
|
|
562 | C<kill>ing a coro with a signal (in this case, a scalar). |
|
|
563 | |
446 | =item $coroutine->join |
564 | =item $coro->join |
447 | |
565 | |
448 | Wait until the coroutine terminates and return any values given to the |
566 | Wait until the coro terminates and return any values given to the |
449 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
567 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
450 | from multiple coroutines, and all will be resumed and given the status |
568 | from multiple coro, and all will be resumed and given the status |
451 | return once the C<$coroutine> terminates. |
569 | return once the C<$coro> terminates. |
452 | |
570 | |
453 | =cut |
571 | =cut |
454 | |
572 | |
455 | sub join { |
573 | sub join { |
456 | my $self = shift; |
574 | my $self = shift; |
… | |
… | |
467 | } |
585 | } |
468 | |
586 | |
469 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
587 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
470 | } |
588 | } |
471 | |
589 | |
472 | =item $coroutine->on_destroy (\&cb) |
590 | =item $coro->on_destroy (\&cb) |
473 | |
591 | |
474 | Registers a callback that is called when this coroutine gets destroyed, |
592 | Registers a callback that is called when this coro gets destroyed, |
475 | but before it is joined. The callback gets passed the terminate arguments, |
593 | but before it is joined. The callback gets passed the terminate arguments, |
476 | if any, and I<must not> die, under any circumstances. |
594 | if any, and I<must not> die, under any circumstances. |
477 | |
595 | |
478 | =cut |
596 | =cut |
479 | |
597 | |
… | |
… | |
481 | my ($self, $cb) = @_; |
599 | my ($self, $cb) = @_; |
482 | |
600 | |
483 | push @{ $self->{_on_destroy} }, $cb; |
601 | push @{ $self->{_on_destroy} }, $cb; |
484 | } |
602 | } |
485 | |
603 | |
486 | =item $oldprio = $coroutine->prio ($newprio) |
604 | =item $oldprio = $coro->prio ($newprio) |
487 | |
605 | |
488 | Sets (or gets, if the argument is missing) the priority of the |
606 | Sets (or gets, if the argument is missing) the priority of the |
489 | coroutine. Higher priority coroutines get run before lower priority |
607 | coro. Higher priority coro get run before lower priority |
490 | coroutines. Priorities are small signed integers (currently -4 .. +3), |
608 | coro. Priorities are small signed integers (currently -4 .. +3), |
491 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
609 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
492 | to get then): |
610 | to get then): |
493 | |
611 | |
494 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
612 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
495 | 3 > 1 > 0 > -1 > -3 > -4 |
613 | 3 > 1 > 0 > -1 > -3 > -4 |
496 | |
614 | |
497 | # set priority to HIGH |
615 | # set priority to HIGH |
498 | current->prio(PRIO_HIGH); |
616 | current->prio (PRIO_HIGH); |
499 | |
617 | |
500 | The idle coroutine ($Coro::idle) always has a lower priority than any |
618 | The idle coro ($Coro::idle) always has a lower priority than any |
501 | existing coroutine. |
619 | existing coro. |
502 | |
620 | |
503 | Changing the priority of the current coroutine will take effect immediately, |
621 | Changing the priority of the current coro will take effect immediately, |
504 | but changing the priority of coroutines in the ready queue (but not |
622 | but changing the priority of coro in the ready queue (but not |
505 | running) will only take effect after the next schedule (of that |
623 | running) will only take effect after the next schedule (of that |
506 | coroutine). This is a bug that will be fixed in some future version. |
624 | coro). This is a bug that will be fixed in some future version. |
507 | |
625 | |
508 | =item $newprio = $coroutine->nice ($change) |
626 | =item $newprio = $coro->nice ($change) |
509 | |
627 | |
510 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
628 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
511 | higher values mean lower priority, just as in unix). |
629 | higher values mean lower priority, just as in unix). |
512 | |
630 | |
513 | =item $olddesc = $coroutine->desc ($newdesc) |
631 | =item $olddesc = $coro->desc ($newdesc) |
514 | |
632 | |
515 | Sets (or gets in case the argument is missing) the description for this |
633 | Sets (or gets in case the argument is missing) the description for this |
516 | coroutine. This is just a free-form string you can associate with a coroutine. |
634 | coro. This is just a free-form string you can associate with a |
|
|
635 | coro. |
517 | |
636 | |
518 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
637 | This method simply sets the C<< $coro->{desc} >> member to the given |
519 | can modify this member directly if you wish. |
638 | string. You can modify this member directly if you wish. |
520 | |
|
|
521 | =item $coroutine->throw ([$scalar]) |
|
|
522 | |
|
|
523 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
524 | inside the coroutine at the next convinient point in time (usually after |
|
|
525 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
526 | exception object. |
|
|
527 | |
|
|
528 | The exception object will be thrown "as is" with the specified scalar in |
|
|
529 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
530 | (unlike with C<die>). |
|
|
531 | |
|
|
532 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
533 | end itself, although there is no guarentee that the exception will lead to |
|
|
534 | termination, and if the exception isn't caught it might well end the whole |
|
|
535 | program. |
|
|
536 | |
639 | |
537 | =cut |
640 | =cut |
538 | |
641 | |
539 | sub desc { |
642 | sub desc { |
540 | my $old = $_[0]{desc}; |
643 | my $old = $_[0]{desc}; |
541 | $_[0]{desc} = $_[1] if @_ > 1; |
644 | $_[0]{desc} = $_[1] if @_ > 1; |
542 | $old; |
645 | $old; |
543 | } |
646 | } |
544 | |
647 | |
|
|
648 | sub transfer { |
|
|
649 | require Carp; |
|
|
650 | Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught"); |
|
|
651 | } |
|
|
652 | |
545 | =back |
653 | =back |
546 | |
654 | |
547 | =head2 GLOBAL FUNCTIONS |
655 | =head1 GLOBAL FUNCTIONS |
548 | |
656 | |
549 | =over 4 |
657 | =over 4 |
550 | |
658 | |
551 | =item Coro::nready |
659 | =item Coro::nready |
552 | |
660 | |
553 | Returns the number of coroutines that are currently in the ready state, |
661 | Returns the number of coro that are currently in the ready state, |
554 | i.e. that can be switched to by calling C<schedule> directory or |
662 | i.e. that can be switched to by calling C<schedule> directory or |
555 | indirectly. The value C<0> means that the only runnable coroutine is the |
663 | indirectly. The value C<0> means that the only runnable coro is the |
556 | currently running one, so C<cede> would have no effect, and C<schedule> |
664 | currently running one, so C<cede> would have no effect, and C<schedule> |
557 | would cause a deadlock unless there is an idle handler that wakes up some |
665 | would cause a deadlock unless there is an idle handler that wakes up some |
558 | coroutines. |
666 | coro. |
559 | |
667 | |
560 | =item my $guard = Coro::guard { ... } |
668 | =item my $guard = Coro::guard { ... } |
561 | |
669 | |
562 | This creates and returns a guard object. Nothing happens until the object |
670 | This function still exists, but is deprecated. Please use the |
563 | gets destroyed, in which case the codeblock given as argument will be |
671 | C<Guard::guard> function instead. |
564 | executed. This is useful to free locks or other resources in case of a |
|
|
565 | runtime error or when the coroutine gets canceled, as in both cases the |
|
|
566 | guard block will be executed. The guard object supports only one method, |
|
|
567 | C<< ->cancel >>, which will keep the codeblock from being executed. |
|
|
568 | |
672 | |
569 | Example: set some flag and clear it again when the coroutine gets canceled |
|
|
570 | or the function returns: |
|
|
571 | |
|
|
572 | sub do_something { |
|
|
573 | my $guard = Coro::guard { $busy = 0 }; |
|
|
574 | $busy = 1; |
|
|
575 | |
|
|
576 | # do something that requires $busy to be true |
|
|
577 | } |
|
|
578 | |
|
|
579 | =cut |
673 | =cut |
580 | |
674 | |
581 | sub guard(&) { |
675 | BEGIN { *guard = \&Guard::guard } |
582 | bless \(my $cb = $_[0]), "Coro::guard" |
|
|
583 | } |
|
|
584 | |
|
|
585 | sub Coro::guard::cancel { |
|
|
586 | ${$_[0]} = sub { }; |
|
|
587 | } |
|
|
588 | |
|
|
589 | sub Coro::guard::DESTROY { |
|
|
590 | ${$_[0]}->(); |
|
|
591 | } |
|
|
592 | |
|
|
593 | |
676 | |
594 | =item unblock_sub { ... } |
677 | =item unblock_sub { ... } |
595 | |
678 | |
596 | This utility function takes a BLOCK or code reference and "unblocks" it, |
679 | This utility function takes a BLOCK or code reference and "unblocks" it, |
597 | returning a new coderef. Unblocking means that calling the new coderef |
680 | returning a new coderef. Unblocking means that calling the new coderef |
598 | will return immediately without blocking, returning nothing, while the |
681 | will return immediately without blocking, returning nothing, while the |
599 | original code ref will be called (with parameters) from within another |
682 | original code ref will be called (with parameters) from within another |
600 | coroutine. |
683 | coro. |
601 | |
684 | |
602 | The reason this function exists is that many event libraries (such as the |
685 | The reason this function exists is that many event libraries (such as the |
603 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
686 | venerable L<Event|Event> module) are not thread-safe (a weaker form |
604 | of thread-safety). This means you must not block within event callbacks, |
687 | of reentrancy). This means you must not block within event callbacks, |
605 | otherwise you might suffer from crashes or worse. The only event library |
688 | otherwise you might suffer from crashes or worse. The only event library |
606 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
689 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
607 | |
690 | |
608 | This function allows your callbacks to block by executing them in another |
691 | This function allows your callbacks to block by executing them in another |
609 | coroutine where it is safe to block. One example where blocking is handy |
692 | coro where it is safe to block. One example where blocking is handy |
610 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
693 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
611 | disk, for example. |
694 | disk, for example. |
612 | |
695 | |
613 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
696 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
614 | creating event callbacks that want to block. |
697 | creating event callbacks that want to block. |
615 | |
698 | |
616 | If your handler does not plan to block (e.g. simply sends a message to |
699 | If your handler does not plan to block (e.g. simply sends a message to |
617 | another coroutine, or puts some other coroutine into the ready queue), |
700 | another coro, or puts some other coro into the ready queue), there is |
618 | there is no reason to use C<unblock_sub>. |
701 | no reason to use C<unblock_sub>. |
619 | |
702 | |
620 | Note that you also need to use C<unblock_sub> for any other callbacks that |
703 | Note that you also need to use C<unblock_sub> for any other callbacks that |
621 | are indirectly executed by any C-based event loop. For example, when you |
704 | are indirectly executed by any C-based event loop. For example, when you |
622 | use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it |
705 | use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it |
623 | provides callbacks that are the result of some event callback, then you |
706 | provides callbacks that are the result of some event callback, then you |
… | |
… | |
632 | # return immediately and can be reused) and because we cannot cede |
715 | # return immediately and can be reused) and because we cannot cede |
633 | # inside an event callback. |
716 | # inside an event callback. |
634 | our $unblock_scheduler = new Coro sub { |
717 | our $unblock_scheduler = new Coro sub { |
635 | while () { |
718 | while () { |
636 | while (my $cb = pop @unblock_queue) { |
719 | while (my $cb = pop @unblock_queue) { |
637 | # this is an inlined copy of async_pool |
720 | &async_pool (@$cb); |
638 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
639 | |
721 | |
640 | $coro->{_invoke} = $cb; |
|
|
641 | $coro->ready; |
|
|
642 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
722 | # for short-lived callbacks, this reduces pressure on the coro pool |
|
|
723 | # as the chance is very high that the async_poll coro will be back |
|
|
724 | # in the idle state when cede returns |
|
|
725 | cede; |
643 | } |
726 | } |
644 | schedule; # sleep well |
727 | schedule; # sleep well |
645 | } |
728 | } |
646 | }; |
729 | }; |
647 | $unblock_scheduler->desc ("[unblock_sub scheduler]"); |
730 | $unblock_scheduler->{desc} = "[unblock_sub scheduler]"; |
648 | |
731 | |
649 | sub unblock_sub(&) { |
732 | sub unblock_sub(&) { |
650 | my $cb = shift; |
733 | my $cb = shift; |
651 | |
734 | |
652 | sub { |
735 | sub { |
653 | unshift @unblock_queue, [$cb, @_]; |
736 | unshift @unblock_queue, [$cb, @_]; |
654 | $unblock_scheduler->ready; |
737 | $unblock_scheduler->ready; |
655 | } |
738 | } |
656 | } |
739 | } |
657 | |
740 | |
|
|
741 | =item $cb = Coro::rouse_cb |
|
|
742 | |
|
|
743 | Create and return a "rouse callback". That's a code reference that, |
|
|
744 | when called, will remember a copy of its arguments and notify the owner |
|
|
745 | coro of the callback. |
|
|
746 | |
|
|
747 | See the next function. |
|
|
748 | |
|
|
749 | =item @args = Coro::rouse_wait [$cb] |
|
|
750 | |
|
|
751 | Wait for the specified rouse callback (or the last one that was created in |
|
|
752 | this coro). |
|
|
753 | |
|
|
754 | As soon as the callback is invoked (or when the callback was invoked |
|
|
755 | before C<rouse_wait>), it will return the arguments originally passed to |
|
|
756 | the rouse callback. In scalar context, that means you get the I<last> |
|
|
757 | argument, just as if C<rouse_wait> had a C<return ($a1, $a2, $a3...)> |
|
|
758 | statement at the end. |
|
|
759 | |
|
|
760 | See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. |
|
|
761 | |
658 | =back |
762 | =back |
659 | |
763 | |
660 | =cut |
764 | =cut |
661 | |
765 | |
662 | 1; |
766 | 1; |
663 | |
767 | |
|
|
768 | =head1 HOW TO WAIT FOR A CALLBACK |
|
|
769 | |
|
|
770 | It is very common for a coro to wait for some callback to be |
|
|
771 | called. This occurs naturally when you use coro in an otherwise |
|
|
772 | event-based program, or when you use event-based libraries. |
|
|
773 | |
|
|
774 | These typically register a callback for some event, and call that callback |
|
|
775 | when the event occured. In a coro, however, you typically want to |
|
|
776 | just wait for the event, simplyifying things. |
|
|
777 | |
|
|
778 | For example C<< AnyEvent->child >> registers a callback to be called when |
|
|
779 | a specific child has exited: |
|
|
780 | |
|
|
781 | my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... }); |
|
|
782 | |
|
|
783 | But from within a coro, you often just want to write this: |
|
|
784 | |
|
|
785 | my $status = wait_for_child $pid; |
|
|
786 | |
|
|
787 | Coro offers two functions specifically designed to make this easy, |
|
|
788 | C<Coro::rouse_cb> and C<Coro::rouse_wait>. |
|
|
789 | |
|
|
790 | The first function, C<rouse_cb>, generates and returns a callback that, |
|
|
791 | when invoked, will save its arguments and notify the coro that |
|
|
792 | created the callback. |
|
|
793 | |
|
|
794 | The second function, C<rouse_wait>, waits for the callback to be called |
|
|
795 | (by calling C<schedule> to go to sleep) and returns the arguments |
|
|
796 | originally passed to the callback. |
|
|
797 | |
|
|
798 | Using these functions, it becomes easy to write the C<wait_for_child> |
|
|
799 | function mentioned above: |
|
|
800 | |
|
|
801 | sub wait_for_child($) { |
|
|
802 | my ($pid) = @_; |
|
|
803 | |
|
|
804 | my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb); |
|
|
805 | |
|
|
806 | my ($rpid, $rstatus) = Coro::rouse_wait; |
|
|
807 | $rstatus |
|
|
808 | } |
|
|
809 | |
|
|
810 | In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough, |
|
|
811 | you can roll your own, using C<schedule>: |
|
|
812 | |
|
|
813 | sub wait_for_child($) { |
|
|
814 | my ($pid) = @_; |
|
|
815 | |
|
|
816 | # store the current coro in $current, |
|
|
817 | # and provide result variables for the closure passed to ->child |
|
|
818 | my $current = $Coro::current; |
|
|
819 | my ($done, $rstatus); |
|
|
820 | |
|
|
821 | # pass a closure to ->child |
|
|
822 | my $watcher = AnyEvent->child (pid => $pid, cb => sub { |
|
|
823 | $rstatus = $_[1]; # remember rstatus |
|
|
824 | $done = 1; # mark $rstatus as valud |
|
|
825 | }); |
|
|
826 | |
|
|
827 | # wait until the closure has been called |
|
|
828 | schedule while !$done; |
|
|
829 | |
|
|
830 | $rstatus |
|
|
831 | } |
|
|
832 | |
|
|
833 | |
664 | =head1 BUGS/LIMITATIONS |
834 | =head1 BUGS/LIMITATIONS |
665 | |
835 | |
|
|
836 | =over 4 |
|
|
837 | |
|
|
838 | =item fork with pthread backend |
|
|
839 | |
|
|
840 | When Coro is compiled using the pthread backend (which isn't recommended |
|
|
841 | but required on many BSDs as their libcs are completely broken), then |
|
|
842 | coro will not survive a fork. There is no known workaround except to |
|
|
843 | fix your libc and use a saner backend. |
|
|
844 | |
|
|
845 | =item perl process emulation ("threads") |
|
|
846 | |
666 | This module is not perl-pseudo-thread-safe. You should only ever use this |
847 | This module is not perl-pseudo-thread-safe. You should only ever use this |
667 | module from the same thread (this requirement might be removed in the |
848 | module from the first thread (this requirement might be removed in the |
668 | future to allow per-thread schedulers, but Coro::State does not yet allow |
849 | future to allow per-thread schedulers, but Coro::State does not yet allow |
669 | this). I recommend disabling thread support and using processes, as this |
850 | this). I recommend disabling thread support and using processes, as having |
670 | is much faster and uses less memory. |
851 | the windows process emulation enabled under unix roughly halves perl |
|
|
852 | performance, even when not used. |
|
|
853 | |
|
|
854 | =item coro switching is not signal safe |
|
|
855 | |
|
|
856 | You must not switch to another coro from within a signal handler |
|
|
857 | (only relevant with %SIG - most event libraries provide safe signals). |
|
|
858 | |
|
|
859 | That means you I<MUST NOT> call any function that might "block" the |
|
|
860 | current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
|
|
861 | anything that calls those. Everything else, including calling C<ready>, |
|
|
862 | works. |
|
|
863 | |
|
|
864 | =back |
|
|
865 | |
671 | |
866 | |
672 | =head1 SEE ALSO |
867 | =head1 SEE ALSO |
673 | |
868 | |
674 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
869 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
675 | |
870 | |
676 | Debugging: L<Coro::Debug>. |
871 | Debugging: L<Coro::Debug>. |
677 | |
872 | |
678 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
873 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
679 | |
874 | |
680 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
875 | Locking and IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, |
|
|
876 | L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
681 | |
877 | |
682 | IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>. |
878 | I/O and Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>. |
683 | |
879 | |
684 | Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>. |
880 | Compatibility with other modules: L<Coro::LWP> (but see also L<AnyEvent::HTTP> for |
|
|
881 | a better-working alternative), L<Coro::BDB>, L<Coro::Storable>, |
|
|
882 | L<Coro::Select>. |
685 | |
883 | |
686 | XS API: L<Coro::MakeMaker>. |
884 | XS API: L<Coro::MakeMaker>. |
687 | |
885 | |
688 | Low level Configuration, Coroutine Environment: L<Coro::State>. |
886 | Low level Configuration, Thread Environment, Continuations: L<Coro::State>. |
689 | |
887 | |
690 | =head1 AUTHOR |
888 | =head1 AUTHOR |
691 | |
889 | |
692 | Marc Lehmann <schmorp@schmorp.de> |
890 | Marc Lehmann <schmorp@schmorp.de> |
693 | http://home.schmorp.de/ |
891 | http://home.schmorp.de/ |