… | |
… | |
2 | |
2 | |
3 | Coro - coroutine process abstraction |
3 | Coro - coroutine process abstraction |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use Coro; |
7 | use Coro; |
8 | |
8 | |
9 | async { |
9 | async { |
10 | # some asynchronous thread of execution |
10 | # some asynchronous thread of execution |
|
|
11 | print "2\n"; |
|
|
12 | cede; # yield back to main |
|
|
13 | print "4\n"; |
11 | }; |
14 | }; |
12 | |
15 | print "1\n"; |
13 | # alternatively create an async coroutine like this: |
16 | cede; # yield to coroutine |
14 | |
17 | print "3\n"; |
15 | sub some_func : Coro { |
18 | cede; # and again |
16 | # some more async code |
19 | |
17 | } |
20 | # use locking |
18 | |
21 | my $lock = new Coro::Semaphore; |
19 | cede; |
22 | my $locked; |
|
|
23 | |
|
|
24 | $lock->down; |
|
|
25 | $locked = 1; |
|
|
26 | $lock->up; |
20 | |
27 | |
21 | =head1 DESCRIPTION |
28 | =head1 DESCRIPTION |
22 | |
29 | |
23 | This module collection manages coroutines. Coroutines are similar |
30 | This module collection manages coroutines. Coroutines are similar to |
24 | to threads but don't run in parallel at the same time even on SMP |
31 | threads but don't (in general) run in parallel at the same time even |
25 | machines. The specific flavor of coroutine used in this module also |
32 | on SMP machines. The specific flavor of coroutine used in this module |
26 | guarantees you that it will not switch between coroutines unless |
33 | also guarantees you that it will not switch between coroutines unless |
27 | necessary, at easily-identified points in your program, so locking and |
34 | necessary, at easily-identified points in your program, so locking and |
28 | parallel access are rarely an issue, making coroutine programming much |
35 | parallel access are rarely an issue, making coroutine programming much |
29 | safer than threads programming. |
36 | safer and easier than threads programming. |
30 | |
37 | |
31 | (Perl, however, does not natively support real threads but instead does a |
38 | Unlike a normal perl program, however, coroutines allow you to have |
32 | very slow and memory-intensive emulation of processes using threads. This |
39 | multiple running interpreters that share data, which is especially useful |
33 | is a performance win on Windows machines, and a loss everywhere else). |
40 | to code pseudo-parallel processes, such as multiple HTTP-GET requests |
|
|
41 | running concurrently. |
|
|
42 | |
|
|
43 | Coroutines are also useful because Perl has no support for threads (the so |
|
|
44 | called "threads" that perl offers are nothing more than the (bad) process |
|
|
45 | emulation coming from the Windows platform: On standard operating systems |
|
|
46 | they serve no purpose whatsoever, except by making your programs slow and |
|
|
47 | making them use a lot of memory. Best disable them when building perl, or |
|
|
48 | aks your software vendor/distributor to do it for you). |
34 | |
49 | |
35 | In this module, coroutines are defined as "callchain + lexical variables + |
50 | In this module, coroutines are defined as "callchain + lexical variables + |
36 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
51 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
37 | its own set of lexicals and its own set of perls most important global |
52 | its own set of lexicals and its own set of perls most important global |
38 | variables. |
53 | variables (see L<Coro::State> for more configuration). |
39 | |
54 | |
40 | =cut |
55 | =cut |
41 | |
56 | |
42 | package Coro; |
57 | package Coro; |
43 | |
58 | |
… | |
… | |
50 | |
65 | |
51 | our $idle; # idle handler |
66 | our $idle; # idle handler |
52 | our $main; # main coroutine |
67 | our $main; # main coroutine |
53 | our $current; # current coroutine |
68 | our $current; # current coroutine |
54 | |
69 | |
55 | our $VERSION = '3.7'; |
70 | our $VERSION = 4.6; |
56 | |
71 | |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
72 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
58 | our %EXPORT_TAGS = ( |
73 | our %EXPORT_TAGS = ( |
59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
74 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
60 | ); |
75 | ); |
61 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
76 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
62 | |
77 | |
63 | { |
|
|
64 | my @async; |
|
|
65 | my $init; |
|
|
66 | |
|
|
67 | # this way of handling attributes simply is NOT scalable ;() |
|
|
68 | sub import { |
|
|
69 | no strict 'refs'; |
|
|
70 | |
|
|
71 | Coro->export_to_level (1, @_); |
|
|
72 | |
|
|
73 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
|
|
74 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
|
|
75 | my ($package, $ref) = (shift, shift); |
|
|
76 | my @attrs; |
|
|
77 | for (@_) { |
|
|
78 | if ($_ eq "Coro") { |
|
|
79 | push @async, $ref; |
|
|
80 | unless ($init++) { |
|
|
81 | eval q{ |
|
|
82 | sub INIT { |
|
|
83 | &async(pop @async) while @async; |
|
|
84 | } |
|
|
85 | }; |
|
|
86 | } |
|
|
87 | } else { |
|
|
88 | push @attrs, $_; |
|
|
89 | } |
|
|
90 | } |
|
|
91 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
|
|
92 | }; |
|
|
93 | } |
|
|
94 | |
|
|
95 | } |
|
|
96 | |
|
|
97 | =over 4 |
78 | =over 4 |
98 | |
79 | |
99 | =item $main |
80 | =item $Coro::main |
100 | |
81 | |
101 | This coroutine represents the main program. |
82 | This variable stores the coroutine object that represents the main |
|
|
83 | program. While you cna C<ready> it and do most other things you can do to |
|
|
84 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
|
|
85 | wether you are running in the main program or not. |
102 | |
86 | |
103 | =cut |
87 | =cut |
104 | |
88 | |
105 | $main = new Coro; |
89 | $main = new Coro; |
106 | |
90 | |
107 | =item $current (or as function: current) |
91 | =item $Coro::current |
108 | |
92 | |
109 | The current coroutine (the last coroutine switched to). The initial value |
93 | The coroutine object representing the current coroutine (the last |
|
|
94 | coroutine that the Coro scheduler switched to). The initial value is |
110 | is C<$main> (of course). |
95 | C<$main> (of course). |
111 | |
96 | |
112 | This variable is B<strictly> I<read-only>. It is provided for performance |
97 | This variable is B<strictly> I<read-only>. You can take copies of the |
113 | reasons. If performance is not essential you are encouraged to use the |
98 | value stored in it and use it as any other coroutine object, but you must |
114 | C<Coro::current> function instead. |
99 | not otherwise modify the variable itself. |
115 | |
100 | |
116 | =cut |
101 | =cut |
117 | |
102 | |
118 | $main->{desc} = "[main::]"; |
103 | $main->{desc} = "[main::]"; |
119 | |
104 | |
120 | # maybe some other module used Coro::Specific before... |
105 | # maybe some other module used Coro::Specific before... |
121 | $main->{specific} = $current->{specific} |
106 | $main->{_specific} = $current->{_specific} |
122 | if $current; |
107 | if $current; |
123 | |
108 | |
124 | _set_current $main; |
109 | _set_current $main; |
125 | |
110 | |
126 | sub current() { $current } |
111 | sub current() { $current } # [DEPRECATED] |
127 | |
112 | |
128 | =item $idle |
113 | =item $Coro::idle |
129 | |
114 | |
130 | A callback that is called whenever the scheduler finds no ready coroutines |
115 | This variable is mainly useful to integrate Coro into event loops. It is |
131 | to run. The default implementation prints "FATAL: deadlock detected" and |
116 | usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is |
132 | exits, because the program has no other way to continue. |
117 | pretty low-level functionality. |
|
|
118 | |
|
|
119 | This variable stores a callback that is called whenever the scheduler |
|
|
120 | finds no ready coroutines to run. The default implementation prints |
|
|
121 | "FATAL: deadlock detected" and exits, because the program has no other way |
|
|
122 | to continue. |
133 | |
123 | |
134 | This hook is overwritten by modules such as C<Coro::Timer> and |
124 | This hook is overwritten by modules such as C<Coro::Timer> and |
135 | C<Coro::Event> to wait on an external event that hopefully wake up a |
125 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
136 | coroutine so the scheduler can run it. |
126 | coroutine so the scheduler can run it. |
137 | |
127 | |
|
|
128 | Note that the callback I<must not>, under any circumstances, block |
|
|
129 | the current coroutine. Normally, this is achieved by having an "idle |
|
|
130 | coroutine" that calls the event loop and then blocks again, and then |
|
|
131 | readying that coroutine in the idle handler. |
|
|
132 | |
|
|
133 | See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this |
|
|
134 | technique. |
|
|
135 | |
138 | Please note that if your callback recursively invokes perl (e.g. for event |
136 | Please note that if your callback recursively invokes perl (e.g. for event |
139 | handlers), then it must be prepared to be called recursively. |
137 | handlers), then it must be prepared to be called recursively itself. |
140 | |
138 | |
141 | =cut |
139 | =cut |
142 | |
140 | |
143 | $idle = sub { |
141 | $idle = sub { |
144 | require Carp; |
142 | require Carp; |
… | |
… | |
151 | # free coroutine data and mark as destructed |
149 | # free coroutine data and mark as destructed |
152 | $self->_destroy |
150 | $self->_destroy |
153 | or return; |
151 | or return; |
154 | |
152 | |
155 | # call all destruction callbacks |
153 | # call all destruction callbacks |
156 | $_->(@{$self->{status}}) |
154 | $_->(@{$self->{_status}}) |
157 | for @{(delete $self->{destroy_cb}) || []}; |
155 | for @{(delete $self->{_on_destroy}) || []}; |
158 | } |
156 | } |
159 | |
157 | |
160 | # this coroutine is necessary because a coroutine |
158 | # this coroutine is necessary because a coroutine |
161 | # cannot destroy itself. |
159 | # cannot destroy itself. |
162 | my @destroy; |
160 | my @destroy; |
… | |
… | |
171 | } |
169 | } |
172 | }; |
170 | }; |
173 | $manager->desc ("[coro manager]"); |
171 | $manager->desc ("[coro manager]"); |
174 | $manager->prio (PRIO_MAX); |
172 | $manager->prio (PRIO_MAX); |
175 | |
173 | |
176 | # static methods. not really. |
|
|
177 | |
|
|
178 | =back |
174 | =back |
179 | |
175 | |
180 | =head2 STATIC METHODS |
176 | =head2 SIMPLE COROUTINE CREATION |
181 | |
|
|
182 | Static methods are actually functions that operate on the current coroutine only. |
|
|
183 | |
177 | |
184 | =over 4 |
178 | =over 4 |
185 | |
179 | |
186 | =item async { ... } [@args...] |
180 | =item async { ... } [@args...] |
187 | |
181 | |
188 | Create a new asynchronous coroutine and return it's coroutine object |
182 | Create a new coroutine and return it's coroutine object (usually |
189 | (usually unused). When the sub returns the new coroutine is automatically |
183 | unused). The coroutine will be put into the ready queue, so |
|
|
184 | it will start running automatically on the next scheduler run. |
|
|
185 | |
|
|
186 | The first argument is a codeblock/closure that should be executed in the |
|
|
187 | coroutine. When it returns argument returns the coroutine is automatically |
190 | terminated. |
188 | terminated. |
|
|
189 | |
|
|
190 | The remaining arguments are passed as arguments to the closure. |
|
|
191 | |
|
|
192 | See the C<Coro::State::new> constructor for info about the coroutine |
|
|
193 | environment in which coroutines are executed. |
191 | |
194 | |
192 | Calling C<exit> in a coroutine will do the same as calling exit outside |
195 | Calling C<exit> in a coroutine will do the same as calling exit outside |
193 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
196 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
194 | just as it would in the main program. |
197 | just as it would in the main program. |
195 | |
198 | |
|
|
199 | If you do not want that, you can provide a default C<die> handler, or |
|
|
200 | simply avoid dieing (by use of C<eval>). |
|
|
201 | |
196 | # create a new coroutine that just prints its arguments |
202 | Example: Create a new coroutine that just prints its arguments. |
|
|
203 | |
197 | async { |
204 | async { |
198 | print "@_\n"; |
205 | print "@_\n"; |
199 | } 1,2,3,4; |
206 | } 1,2,3,4; |
200 | |
207 | |
201 | =cut |
208 | =cut |
… | |
… | |
207 | } |
214 | } |
208 | |
215 | |
209 | =item async_pool { ... } [@args...] |
216 | =item async_pool { ... } [@args...] |
210 | |
217 | |
211 | Similar to C<async>, but uses a coroutine pool, so you should not call |
218 | Similar to C<async>, but uses a coroutine pool, so you should not call |
212 | terminate or join (although you are allowed to), and you get a coroutine |
219 | terminate or join on it (although you are allowed to), and you get a |
213 | that might have executed other code already (which can be good or bad :). |
220 | coroutine that might have executed other code already (which can be good |
|
|
221 | or bad :). |
214 | |
222 | |
|
|
223 | On the plus side, this function is faster than creating (and destroying) |
|
|
224 | a completely new coroutine, so if you need a lot of generic coroutines in |
|
|
225 | quick successsion, use C<async_pool>, not C<async>. |
|
|
226 | |
215 | Also, the block is executed in an C<eval> context and a warning will be |
227 | The code block is executed in an C<eval> context and a warning will be |
216 | issued in case of an exception instead of terminating the program, as |
228 | issued in case of an exception instead of terminating the program, as |
217 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
229 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
218 | will not work in the expected way, unless you call terminate or cancel, |
230 | will not work in the expected way, unless you call terminate or cancel, |
219 | which somehow defeats the purpose of pooling. |
231 | which somehow defeats the purpose of pooling (but is fine in the |
|
|
232 | exceptional case). |
220 | |
233 | |
221 | The priority will be reset to C<0> after each job, otherwise the coroutine |
234 | The priority will be reset to C<0> after each run, tracing will be |
222 | will be re-used "as-is". |
235 | disabled, the description will be reset and the default output filehandle |
|
|
236 | gets restored, so you can change all these. Otherwise the coroutine will |
|
|
237 | be re-used "as-is": most notably if you change other per-coroutine global |
|
|
238 | stuff such as C<$/> you I<must needs> to revert that change, which is most |
|
|
239 | simply done by using local as in: C< local $/ >. |
223 | |
240 | |
224 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
241 | The pool size is limited to C<8> idle coroutines (this can be adjusted by |
225 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
242 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
226 | required. |
243 | required. |
227 | |
244 | |
228 | If you are concerned about pooled coroutines growing a lot because a |
245 | If you are concerned about pooled coroutines growing a lot because a |
229 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
246 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
230 | { terminate }> once per second or so to slowly replenish the pool. In |
247 | { terminate }> once per second or so to slowly replenish the pool. In |
231 | addition to that, when the stacks used by a handler grows larger than 16kb |
248 | addition to that, when the stacks used by a handler grows larger than 16kb |
232 | (adjustable with $Coro::POOL_RSS) it will also exit. |
249 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
233 | |
250 | |
234 | =cut |
251 | =cut |
235 | |
252 | |
236 | our $POOL_SIZE = 8; |
253 | our $POOL_SIZE = 8; |
237 | our $POOL_RSS = 16 * 1024; |
254 | our $POOL_RSS = 16 * 1024; |
… | |
… | |
248 | _pool_2 $cb; |
265 | _pool_2 $cb; |
249 | &schedule; |
266 | &schedule; |
250 | } |
267 | } |
251 | }; |
268 | }; |
252 | |
269 | |
253 | last if $@ eq "\3terminate\2\n"; |
270 | last if $@ eq "\3async_pool terminate\2\n"; |
254 | warn $@ if $@; |
271 | warn $@ if $@; |
255 | } |
272 | } |
256 | } |
273 | } |
257 | |
274 | |
258 | sub async_pool(&@) { |
275 | sub async_pool(&@) { |
… | |
… | |
263 | $coro->ready; |
280 | $coro->ready; |
264 | |
281 | |
265 | $coro |
282 | $coro |
266 | } |
283 | } |
267 | |
284 | |
|
|
285 | =back |
|
|
286 | |
|
|
287 | =head2 STATIC METHODS |
|
|
288 | |
|
|
289 | Static methods are actually functions that operate on the current coroutine. |
|
|
290 | |
|
|
291 | =over 4 |
|
|
292 | |
268 | =item schedule |
293 | =item schedule |
269 | |
294 | |
270 | Calls the scheduler. Please note that the current coroutine will not be put |
295 | Calls the scheduler. The scheduler will find the next coroutine that is |
|
|
296 | to be run from the ready queue and switches to it. The next coroutine |
|
|
297 | to be run is simply the one with the highest priority that is longest |
|
|
298 | in its ready queue. If there is no coroutine ready, it will clal the |
|
|
299 | C<$Coro::idle> hook. |
|
|
300 | |
|
|
301 | Please note that the current coroutine will I<not> be put into the ready |
271 | into the ready queue, so calling this function usually means you will |
302 | queue, so calling this function usually means you will never be called |
272 | never be called again unless something else (e.g. an event handler) calls |
303 | again unless something else (e.g. an event handler) calls C<< ->ready >>, |
273 | ready. |
304 | thus waking you up. |
|
|
305 | |
|
|
306 | This makes C<schedule> I<the> generic method to use to block the current |
|
|
307 | coroutine and wait for events: first you remember the current coroutine in |
|
|
308 | a variable, then arrange for some callback of yours to call C<< ->ready |
|
|
309 | >> on that once some event happens, and last you call C<schedule> to put |
|
|
310 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
|
|
311 | so you need to check wether the event indeed happened, e.g. by storing the |
|
|
312 | status in a variable. |
274 | |
313 | |
275 | The canonical way to wait on external events is this: |
314 | The canonical way to wait on external events is this: |
276 | |
315 | |
277 | { |
316 | { |
278 | # remember current coroutine |
317 | # remember current coroutine |
… | |
… | |
291 | Coro::schedule while $current; |
330 | Coro::schedule while $current; |
292 | } |
331 | } |
293 | |
332 | |
294 | =item cede |
333 | =item cede |
295 | |
334 | |
296 | "Cede" to other coroutines. This function puts the current coroutine into the |
335 | "Cede" to other coroutines. This function puts the current coroutine into |
297 | ready queue and calls C<schedule>, which has the effect of giving up the |
336 | the ready queue and calls C<schedule>, which has the effect of giving |
298 | current "timeslice" to other coroutines of the same or higher priority. |
337 | up the current "timeslice" to other coroutines of the same or higher |
|
|
338 | priority. Once your coroutine gets its turn again it will automatically be |
|
|
339 | resumed. |
299 | |
340 | |
300 | Returns true if at least one coroutine switch has happened. |
341 | This function is often called C<yield> in other languages. |
301 | |
342 | |
302 | =item Coro::cede_notself |
343 | =item Coro::cede_notself |
303 | |
344 | |
304 | Works like cede, but is not exported by default and will cede to any |
345 | Works like cede, but is not exported by default and will cede to I<any> |
305 | coroutine, regardless of priority, once. |
346 | coroutine, regardless of priority. This is useful sometimes to ensure |
306 | |
347 | progress is made. |
307 | Returns true if at least one coroutine switch has happened. |
|
|
308 | |
348 | |
309 | =item terminate [arg...] |
349 | =item terminate [arg...] |
310 | |
350 | |
311 | Terminates the current coroutine with the given status values (see L<cancel>). |
351 | Terminates the current coroutine with the given status values (see L<cancel>). |
|
|
352 | |
|
|
353 | =item killall |
|
|
354 | |
|
|
355 | Kills/terminates/cancels all coroutines except the currently running |
|
|
356 | one. This is useful after a fork, either in the child or the parent, as |
|
|
357 | usually only one of them should inherit the running coroutines. |
|
|
358 | |
|
|
359 | Note that while this will try to free some of the main programs resources, |
|
|
360 | you cnanot free all of them, so if a coroutine that is not the main |
|
|
361 | program calls this function, there will be some one-time resource leak. |
312 | |
362 | |
313 | =cut |
363 | =cut |
314 | |
364 | |
315 | sub terminate { |
365 | sub terminate { |
316 | $current->cancel (@_); |
366 | $current->cancel (@_); |
317 | } |
367 | } |
318 | |
368 | |
|
|
369 | sub killall { |
|
|
370 | for (Coro::State::list) { |
|
|
371 | $_->cancel |
|
|
372 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
373 | } |
|
|
374 | } |
|
|
375 | |
319 | =back |
376 | =back |
320 | |
377 | |
321 | # dynamic methods |
|
|
322 | |
|
|
323 | =head2 COROUTINE METHODS |
378 | =head2 COROUTINE METHODS |
324 | |
379 | |
325 | These are the methods you can call on coroutine objects. |
380 | These are the methods you can call on coroutine objects (or to create |
|
|
381 | them). |
326 | |
382 | |
327 | =over 4 |
383 | =over 4 |
328 | |
384 | |
329 | =item new Coro \&sub [, @args...] |
385 | =item new Coro \&sub [, @args...] |
330 | |
386 | |
331 | Create a new coroutine and return it. When the sub returns the coroutine |
387 | Create a new coroutine and return it. When the sub returns, the coroutine |
332 | automatically terminates as if C<terminate> with the returned values were |
388 | automatically terminates as if C<terminate> with the returned values were |
333 | called. To make the coroutine run you must first put it into the ready queue |
389 | called. To make the coroutine run you must first put it into the ready |
334 | by calling the ready method. |
390 | queue by calling the ready method. |
335 | |
391 | |
336 | See C<async> for additional discussion. |
392 | See C<async> and C<Coro::State::new> for additional info about the |
|
|
393 | coroutine environment. |
337 | |
394 | |
338 | =cut |
395 | =cut |
339 | |
396 | |
340 | sub _run_coro { |
397 | sub _run_coro { |
341 | terminate &{+shift}; |
398 | terminate &{+shift}; |
… | |
… | |
347 | $class->SUPER::new (\&_run_coro, @_) |
404 | $class->SUPER::new (\&_run_coro, @_) |
348 | } |
405 | } |
349 | |
406 | |
350 | =item $success = $coroutine->ready |
407 | =item $success = $coroutine->ready |
351 | |
408 | |
352 | Put the given coroutine into the ready queue (according to it's priority) |
409 | Put the given coroutine into the end of its ready queue (there is one |
353 | and return true. If the coroutine is already in the ready queue, do nothing |
410 | queue for each priority) and return true. If the coroutine is already in |
354 | and return false. |
411 | the ready queue, do nothing and return false. |
|
|
412 | |
|
|
413 | This ensures that the scheduler will resume this coroutine automatically |
|
|
414 | once all the coroutines of higher priority and all coroutines of the same |
|
|
415 | priority that were put into the ready queue earlier have been resumed. |
355 | |
416 | |
356 | =item $is_ready = $coroutine->is_ready |
417 | =item $is_ready = $coroutine->is_ready |
357 | |
418 | |
358 | Return wether the coroutine is currently the ready queue or not, |
419 | Return wether the coroutine is currently the ready queue or not, |
359 | |
420 | |
… | |
… | |
365 | |
426 | |
366 | =cut |
427 | =cut |
367 | |
428 | |
368 | sub cancel { |
429 | sub cancel { |
369 | my $self = shift; |
430 | my $self = shift; |
370 | $self->{status} = [@_]; |
431 | $self->{_status} = [@_]; |
371 | |
432 | |
372 | if ($current == $self) { |
433 | if ($current == $self) { |
373 | push @destroy, $self; |
434 | push @destroy, $self; |
374 | $manager->ready; |
435 | $manager->ready; |
375 | &schedule while 1; |
436 | &schedule while 1; |
… | |
… | |
379 | } |
440 | } |
380 | |
441 | |
381 | =item $coroutine->join |
442 | =item $coroutine->join |
382 | |
443 | |
383 | Wait until the coroutine terminates and return any values given to the |
444 | Wait until the coroutine terminates and return any values given to the |
384 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
445 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
385 | from multiple coroutine. |
446 | from multiple coroutines, and all will be resumed and given the status |
|
|
447 | return once the C<$coroutine> terminates. |
386 | |
448 | |
387 | =cut |
449 | =cut |
388 | |
450 | |
389 | sub join { |
451 | sub join { |
390 | my $self = shift; |
452 | my $self = shift; |
391 | |
453 | |
392 | unless ($self->{status}) { |
454 | unless ($self->{_status}) { |
393 | my $current = $current; |
455 | my $current = $current; |
394 | |
456 | |
395 | push @{$self->{destroy_cb}}, sub { |
457 | push @{$self->{_on_destroy}}, sub { |
396 | $current->ready; |
458 | $current->ready; |
397 | undef $current; |
459 | undef $current; |
398 | }; |
460 | }; |
399 | |
461 | |
400 | &schedule while $current; |
462 | &schedule while $current; |
401 | } |
463 | } |
402 | |
464 | |
403 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
465 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
404 | } |
466 | } |
405 | |
467 | |
406 | =item $coroutine->on_destroy (\&cb) |
468 | =item $coroutine->on_destroy (\&cb) |
407 | |
469 | |
408 | Registers a callback that is called when this coroutine gets destroyed, |
470 | Registers a callback that is called when this coroutine gets destroyed, |
409 | but before it is joined. The callback gets passed the terminate arguments, |
471 | but before it is joined. The callback gets passed the terminate arguments, |
410 | if any. |
472 | if any, and I<must not> die, under any circumstances. |
411 | |
473 | |
412 | =cut |
474 | =cut |
413 | |
475 | |
414 | sub on_destroy { |
476 | sub on_destroy { |
415 | my ($self, $cb) = @_; |
477 | my ($self, $cb) = @_; |
416 | |
478 | |
417 | push @{ $self->{destroy_cb} }, $cb; |
479 | push @{ $self->{_on_destroy} }, $cb; |
418 | } |
480 | } |
419 | |
481 | |
420 | =item $oldprio = $coroutine->prio ($newprio) |
482 | =item $oldprio = $coroutine->prio ($newprio) |
421 | |
483 | |
422 | Sets (or gets, if the argument is missing) the priority of the |
484 | Sets (or gets, if the argument is missing) the priority of the |
… | |
… | |
447 | =item $olddesc = $coroutine->desc ($newdesc) |
509 | =item $olddesc = $coroutine->desc ($newdesc) |
448 | |
510 | |
449 | Sets (or gets in case the argument is missing) the description for this |
511 | Sets (or gets in case the argument is missing) the description for this |
450 | coroutine. This is just a free-form string you can associate with a coroutine. |
512 | coroutine. This is just a free-form string you can associate with a coroutine. |
451 | |
513 | |
|
|
514 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
|
|
515 | can modify this member directly if you wish. |
|
|
516 | |
|
|
517 | =item $coroutine->throw ([$scalar]) |
|
|
518 | |
|
|
519 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
520 | inside the coroutine at the next convinient point in time (usually after |
|
|
521 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
522 | exception object. |
|
|
523 | |
|
|
524 | The exception object will be thrown "as is" with the specified scalar in |
|
|
525 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
526 | (unlike with C<die>). |
|
|
527 | |
|
|
528 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
529 | end itself, although there is no guarentee that the exception will lead to |
|
|
530 | termination, and if the exception isn't caught it might well end the whole |
|
|
531 | program. |
|
|
532 | |
452 | =cut |
533 | =cut |
453 | |
534 | |
454 | sub desc { |
535 | sub desc { |
455 | my $old = $_[0]{desc}; |
536 | my $old = $_[0]{desc}; |
456 | $_[0]{desc} = $_[1] if @_ > 1; |
537 | $_[0]{desc} = $_[1] if @_ > 1; |
… | |
… | |
464 | =over 4 |
545 | =over 4 |
465 | |
546 | |
466 | =item Coro::nready |
547 | =item Coro::nready |
467 | |
548 | |
468 | Returns the number of coroutines that are currently in the ready state, |
549 | Returns the number of coroutines that are currently in the ready state, |
469 | i.e. that can be switched to. The value C<0> means that the only runnable |
550 | i.e. that can be switched to by calling C<schedule> directory or |
|
|
551 | indirectly. The value C<0> means that the only runnable coroutine is the |
470 | coroutine is the currently running one, so C<cede> would have no effect, |
552 | currently running one, so C<cede> would have no effect, and C<schedule> |
471 | and C<schedule> would cause a deadlock unless there is an idle handler |
553 | would cause a deadlock unless there is an idle handler that wakes up some |
472 | that wakes up some coroutines. |
554 | coroutines. |
473 | |
555 | |
474 | =item my $guard = Coro::guard { ... } |
556 | =item my $guard = Coro::guard { ... } |
475 | |
557 | |
476 | This creates and returns a guard object. Nothing happens until the object |
558 | This creates and returns a guard object. Nothing happens until the object |
477 | gets destroyed, in which case the codeblock given as argument will be |
559 | gets destroyed, in which case the codeblock given as argument will be |
… | |
… | |
506 | |
588 | |
507 | |
589 | |
508 | =item unblock_sub { ... } |
590 | =item unblock_sub { ... } |
509 | |
591 | |
510 | This utility function takes a BLOCK or code reference and "unblocks" it, |
592 | This utility function takes a BLOCK or code reference and "unblocks" it, |
511 | returning the new coderef. This means that the new coderef will return |
593 | returning a new coderef. Unblocking means that calling the new coderef |
512 | immediately without blocking, returning nothing, while the original code |
594 | will return immediately without blocking, returning nothing, while the |
513 | ref will be called (with parameters) from within its own coroutine. |
595 | original code ref will be called (with parameters) from within another |
|
|
596 | coroutine. |
514 | |
597 | |
515 | The reason this function exists is that many event libraries (such as the |
598 | The reason this function exists is that many event libraries (such as the |
516 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
599 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
517 | of thread-safety). This means you must not block within event callbacks, |
600 | of thread-safety). This means you must not block within event callbacks, |
518 | otherwise you might suffer from crashes or worse. |
601 | otherwise you might suffer from crashes or worse. The only event library |
|
|
602 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
519 | |
603 | |
520 | This function allows your callbacks to block by executing them in another |
604 | This function allows your callbacks to block by executing them in another |
521 | coroutine where it is safe to block. One example where blocking is handy |
605 | coroutine where it is safe to block. One example where blocking is handy |
522 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
606 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
523 | disk. |
607 | disk, for example. |
524 | |
608 | |
525 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
609 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
526 | creating event callbacks that want to block. |
610 | creating event callbacks that want to block. |
|
|
611 | |
|
|
612 | If your handler does not plan to block (e.g. simply sends a message to |
|
|
613 | another coroutine, or puts some other coroutine into the ready queue), |
|
|
614 | there is no reason to use C<unblock_sub>. |
527 | |
615 | |
528 | =cut |
616 | =cut |
529 | |
617 | |
530 | our @unblock_queue; |
618 | our @unblock_queue; |
531 | |
619 | |
… | |
… | |
563 | |
651 | |
564 | 1; |
652 | 1; |
565 | |
653 | |
566 | =head1 BUGS/LIMITATIONS |
654 | =head1 BUGS/LIMITATIONS |
567 | |
655 | |
568 | - you must make very sure that no coro is still active on global |
|
|
569 | destruction. very bad things might happen otherwise (usually segfaults). |
|
|
570 | |
|
|
571 | - this module is not thread-safe. You should only ever use this module |
656 | This module is not perl-pseudo-thread-safe. You should only ever use this |
572 | from the same thread (this requirement might be loosened in the future |
657 | module from the same thread (this requirement might be removed in the |
573 | to allow per-thread schedulers, but Coro::State does not yet allow |
658 | future to allow per-thread schedulers, but Coro::State does not yet allow |
574 | this). |
659 | this). I recommend disabling thread support and using processes, as this |
|
|
660 | is much faster and uses less memory. |
575 | |
661 | |
576 | =head1 SEE ALSO |
662 | =head1 SEE ALSO |
577 | |
663 | |
|
|
664 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
|
|
665 | |
|
|
666 | Debugging: L<Coro::Debug>. |
|
|
667 | |
578 | Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
668 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
579 | |
669 | |
580 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
670 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
581 | |
671 | |
582 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
672 | IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>. |
583 | |
673 | |
584 | Embedding: L<Coro:MakeMaker> |
674 | Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>. |
|
|
675 | |
|
|
676 | XS API: L<Coro::MakeMaker>. |
|
|
677 | |
|
|
678 | Low level Configuration, Coroutine Environment: L<Coro::State>. |
585 | |
679 | |
586 | =head1 AUTHOR |
680 | =head1 AUTHOR |
587 | |
681 | |
588 | Marc Lehmann <schmorp@schmorp.de> |
682 | Marc Lehmann <schmorp@schmorp.de> |
589 | http://home.schmorp.de/ |
683 | http://home.schmorp.de/ |