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