1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | Coro - coroutine process abstraction |
3 | Coro - the real perl threads |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use Coro; |
7 | use Coro; |
8 | |
8 | |
… | |
… | |
16 | cede; # yield to coroutine |
16 | cede; # yield to coroutine |
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 | my $lock = new Coro::Semaphore; |
22 | my $lock = new Coro::Semaphore; |
22 | my $locked; |
23 | my $locked; |
23 | |
24 | |
24 | $lock->down; |
25 | $lock->down; |
25 | $locked = 1; |
26 | $locked = 1; |
26 | $lock->up; |
27 | $lock->up; |
27 | |
28 | |
28 | =head1 DESCRIPTION |
29 | =head1 DESCRIPTION |
29 | |
30 | |
30 | This module collection manages coroutines. Coroutines are similar to |
31 | This module collection manages coroutines, that is, cooperative |
31 | threads but don't (in general) run in parallel at the same time even |
32 | threads. Coroutines are similar to kernel threads but don't (in general) |
32 | on SMP machines. The specific flavor of coroutine used in this module |
33 | run in parallel at the same time even on SMP machines. The specific flavor |
33 | also guarantees you that it will not switch between coroutines unless |
34 | of coroutine used in this module also guarantees you that it will not |
34 | necessary, at easily-identified points in your program, so locking and |
35 | switch between coroutines unless necessary, at easily-identified points |
35 | parallel access are rarely an issue, making coroutine programming much |
36 | in your program, so locking and parallel access are rarely an issue, |
36 | safer and easier than threads programming. |
37 | making coroutine programming much safer and easier than using other thread |
|
|
38 | models. |
37 | |
39 | |
38 | Unlike a normal perl program, however, coroutines allow you to have |
40 | Unlike the so-called "Perl threads" (which are not actually real threads |
39 | multiple running interpreters that share data, which is especially useful |
41 | but only the windows process emulation ported to unix), Coro provides a |
40 | to code pseudo-parallel processes and for event-based programming, such as |
42 | full shared address space, which makes communication between coroutines |
41 | multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> to |
43 | very easy. And coroutines are fast, too: disabling the Windows process |
42 | learn more. |
44 | emulation code in your perl and using Coro can easily result in a two to |
|
|
45 | four times speed increase for your programs. |
43 | |
46 | |
44 | Coroutines are also useful because Perl has no support for threads (the so |
47 | Coro achieves that by supporting multiple running interpreters that share |
45 | called "threads" that perl offers are nothing more than the (bad) process |
48 | data, which is especially useful to code pseudo-parallel processes and |
46 | emulation coming from the Windows platform: On standard operating systems |
49 | for event-based programming, such as multiple HTTP-GET requests running |
47 | they serve no purpose whatsoever, except by making your programs slow and |
50 | concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro |
48 | making them use a lot of memory. Best disable them when building perl, or |
51 | into an event-based environment. |
49 | aks your software vendor/distributor to do it for you). |
|
|
50 | |
52 | |
51 | In this module, coroutines are defined as "callchain + lexical variables + |
53 | In this module, a coroutines is defined as "callchain + lexical variables |
52 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
54 | + @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own |
53 | its own set of lexicals and its own set of perls most important global |
55 | callchain, its own set of lexicals and its own set of perls most important |
54 | variables (see L<Coro::State> for more configuration). |
56 | global variables (see L<Coro::State> for more configuration and background |
|
|
57 | info). |
|
|
58 | |
|
|
59 | See also the C<SEE ALSO> section at the end of this document - the Coro |
|
|
60 | module family is quite large. |
55 | |
61 | |
56 | =cut |
62 | =cut |
57 | |
63 | |
58 | package Coro; |
64 | package Coro; |
59 | |
65 | |
60 | use strict; |
66 | use strict qw(vars subs); |
61 | no warnings "uninitialized"; |
67 | no warnings "uninitialized"; |
62 | |
68 | |
63 | use Coro::State; |
69 | use Coro::State; |
64 | |
70 | |
65 | use base qw(Coro::State Exporter); |
71 | use base qw(Coro::State Exporter); |
66 | |
72 | |
67 | our $idle; # idle handler |
73 | our $idle; # idle handler |
68 | our $main; # main coroutine |
74 | our $main; # main coroutine |
69 | our $current; # current coroutine |
75 | our $current; # current coroutine |
70 | |
76 | |
71 | our $VERSION = 4.743; |
77 | our $VERSION = "5.0"; |
72 | |
78 | |
73 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
79 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
74 | our %EXPORT_TAGS = ( |
80 | our %EXPORT_TAGS = ( |
75 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
81 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
76 | ); |
82 | ); |
77 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
83 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
78 | |
84 | |
|
|
85 | =head1 GLOBAL VARIABLES |
|
|
86 | |
79 | =over 4 |
87 | =over 4 |
80 | |
88 | |
81 | =item $Coro::main |
89 | =item $Coro::main |
82 | |
90 | |
83 | This variable stores the coroutine object that represents the main |
91 | This variable stores the coroutine object that represents the main |
84 | program. While you cna C<ready> it and do most other things you can do to |
92 | program. While you cna C<ready> it and do most other things you can do to |
85 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
93 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
86 | wether you are running in the main program or not. |
94 | whether you are running in the main program or not. |
87 | |
95 | |
88 | =cut |
96 | =cut |
89 | |
97 | |
90 | $main = new Coro; |
98 | # $main is now being initialised by Coro::State |
91 | |
99 | |
92 | =item $Coro::current |
100 | =item $Coro::current |
93 | |
101 | |
94 | The coroutine object representing the current coroutine (the last |
102 | The coroutine object representing the current coroutine (the last |
95 | coroutine that the Coro scheduler switched to). The initial value is |
103 | coroutine that the Coro scheduler switched to). The initial value is |
96 | C<$main> (of course). |
104 | C<$Coro::main> (of course). |
97 | |
105 | |
98 | This variable is B<strictly> I<read-only>. You can take copies of the |
106 | This variable is B<strictly> I<read-only>. You can take copies of the |
99 | value stored in it and use it as any other coroutine object, but you must |
107 | value stored in it and use it as any other coroutine object, but you must |
100 | not otherwise modify the variable itself. |
108 | not otherwise modify the variable itself. |
101 | |
109 | |
102 | =cut |
110 | =cut |
103 | |
|
|
104 | $main->{desc} = "[main::]"; |
|
|
105 | |
|
|
106 | # maybe some other module used Coro::Specific before... |
|
|
107 | $main->{_specific} = $current->{_specific} |
|
|
108 | if $current; |
|
|
109 | |
|
|
110 | _set_current $main; |
|
|
111 | |
111 | |
112 | sub current() { $current } # [DEPRECATED] |
112 | sub current() { $current } # [DEPRECATED] |
113 | |
113 | |
114 | =item $Coro::idle |
114 | =item $Coro::idle |
115 | |
115 | |
… | |
… | |
142 | $idle = sub { |
142 | $idle = sub { |
143 | require Carp; |
143 | require Carp; |
144 | Carp::croak ("FATAL: deadlock detected"); |
144 | Carp::croak ("FATAL: deadlock detected"); |
145 | }; |
145 | }; |
146 | |
146 | |
147 | sub _cancel { |
|
|
148 | my ($self) = @_; |
|
|
149 | |
|
|
150 | # free coroutine data and mark as destructed |
|
|
151 | $self->_destroy |
|
|
152 | or return; |
|
|
153 | |
|
|
154 | # call all destruction callbacks |
|
|
155 | $_->(@{$self->{_status}}) |
|
|
156 | for @{(delete $self->{_on_destroy}) || []}; |
|
|
157 | } |
|
|
158 | |
|
|
159 | # this coroutine is necessary because a coroutine |
147 | # this coroutine is necessary because a coroutine |
160 | # cannot destroy itself. |
148 | # cannot destroy itself. |
161 | my @destroy; |
149 | our @destroy; |
162 | my $manager; |
150 | our $manager; |
163 | |
151 | |
164 | $manager = new Coro sub { |
152 | $manager = new Coro sub { |
165 | while () { |
153 | while () { |
166 | (shift @destroy)->_cancel |
154 | Coro::_cancel shift @destroy |
167 | while @destroy; |
155 | while @destroy; |
168 | |
156 | |
169 | &schedule; |
157 | &schedule; |
170 | } |
158 | } |
171 | }; |
159 | }; |
172 | $manager->desc ("[coro manager]"); |
160 | $manager->{desc} = "[coro manager]"; |
173 | $manager->prio (PRIO_MAX); |
161 | $manager->prio (PRIO_MAX); |
174 | |
162 | |
175 | =back |
163 | =back |
176 | |
164 | |
177 | =head2 SIMPLE COROUTINE CREATION |
165 | =head1 SIMPLE COROUTINE CREATION |
178 | |
166 | |
179 | =over 4 |
167 | =over 4 |
180 | |
168 | |
181 | =item async { ... } [@args...] |
169 | =item async { ... } [@args...] |
182 | |
170 | |
… | |
… | |
219 | Similar to C<async>, but uses a coroutine pool, so you should not call |
207 | Similar to C<async>, but uses a coroutine pool, so you should not call |
220 | terminate or join on it (although you are allowed to), and you get a |
208 | terminate or join on it (although you are allowed to), and you get a |
221 | coroutine that might have executed other code already (which can be good |
209 | coroutine that might have executed other code already (which can be good |
222 | or bad :). |
210 | or bad :). |
223 | |
211 | |
224 | On the plus side, this function is faster than creating (and destroying) |
212 | On the plus side, this function is about twice as fast as creating (and |
225 | a completely new coroutine, so if you need a lot of generic coroutines in |
213 | destroying) a completely new coroutine, so if you need a lot of generic |
226 | quick successsion, use C<async_pool>, not C<async>. |
214 | coroutines in quick successsion, use C<async_pool>, not C<async>. |
227 | |
215 | |
228 | The code block is executed in an C<eval> context and a warning will be |
216 | The code block is executed in an C<eval> context and a warning will be |
229 | issued in case of an exception instead of terminating the program, as |
217 | issued in case of an exception instead of terminating the program, as |
230 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
218 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
231 | will not work in the expected way, unless you call terminate or cancel, |
219 | will not work in the expected way, unless you call terminate or cancel, |
… | |
… | |
234 | |
222 | |
235 | The priority will be reset to C<0> after each run, tracing will be |
223 | The priority will be reset to C<0> after each run, tracing will be |
236 | disabled, the description will be reset and the default output filehandle |
224 | disabled, the description will be reset and the default output filehandle |
237 | gets restored, so you can change all these. Otherwise the coroutine will |
225 | gets restored, so you can change all these. Otherwise the coroutine will |
238 | be re-used "as-is": most notably if you change other per-coroutine global |
226 | be re-used "as-is": most notably if you change other per-coroutine global |
239 | stuff such as C<$/> you I<must needs> to revert that change, which is most |
227 | stuff such as C<$/> you I<must needs> revert that change, which is most |
240 | simply done by using local as in: C< local $/ >. |
228 | simply done by using local as in: C<< local $/ >>. |
241 | |
229 | |
242 | The pool size is limited to C<8> idle coroutines (this can be adjusted by |
230 | The idle pool size is limited to C<8> idle coroutines (this can be |
243 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
231 | adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle |
244 | required. |
232 | coros as required. |
245 | |
233 | |
246 | If you are concerned about pooled coroutines growing a lot because a |
234 | If you are concerned about pooled coroutines growing a lot because a |
247 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
235 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
248 | { terminate }> once per second or so to slowly replenish the pool. In |
236 | { terminate }> once per second or so to slowly replenish the pool. In |
249 | addition to that, when the stacks used by a handler grows larger than 16kb |
237 | addition to that, when the stacks used by a handler grows larger than 32kb |
250 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
238 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
251 | |
239 | |
252 | =cut |
240 | =cut |
253 | |
241 | |
254 | our $POOL_SIZE = 8; |
242 | our $POOL_SIZE = 8; |
255 | our $POOL_RSS = 16 * 1024; |
243 | our $POOL_RSS = 32 * 1024; |
256 | our @async_pool; |
244 | our @async_pool; |
257 | |
245 | |
258 | sub pool_handler { |
246 | sub pool_handler { |
259 | my $cb; |
|
|
260 | |
|
|
261 | while () { |
247 | while () { |
262 | eval { |
248 | eval { |
263 | while () { |
249 | &{&_pool_handler} while 1; |
264 | _pool_1 $cb; |
|
|
265 | &$cb; |
|
|
266 | _pool_2 $cb; |
|
|
267 | &schedule; |
|
|
268 | } |
|
|
269 | }; |
250 | }; |
270 | |
251 | |
271 | last if $@ eq "\3async_pool terminate\2\n"; |
|
|
272 | warn $@ if $@; |
252 | warn $@ if $@; |
273 | } |
253 | } |
274 | } |
254 | } |
275 | |
255 | |
276 | sub async_pool(&@) { |
|
|
277 | # this is also inlined into the unlock_scheduler |
|
|
278 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
279 | |
|
|
280 | $coro->{_invoke} = [@_]; |
|
|
281 | $coro->ready; |
|
|
282 | |
|
|
283 | $coro |
|
|
284 | } |
|
|
285 | |
|
|
286 | =back |
256 | =back |
287 | |
257 | |
288 | =head2 STATIC METHODS |
258 | =head1 STATIC METHODS |
289 | |
259 | |
290 | Static methods are actually functions that operate on the current coroutine. |
260 | Static methods are actually functions that implicitly operate on the |
|
|
261 | current coroutine. |
291 | |
262 | |
292 | =over 4 |
263 | =over 4 |
293 | |
264 | |
294 | =item schedule |
265 | =item schedule |
295 | |
266 | |
… | |
… | |
307 | This makes C<schedule> I<the> generic method to use to block the current |
278 | This makes C<schedule> I<the> generic method to use to block the current |
308 | coroutine and wait for events: first you remember the current coroutine in |
279 | coroutine and wait for events: first you remember the current coroutine in |
309 | a variable, then arrange for some callback of yours to call C<< ->ready |
280 | a variable, then arrange for some callback of yours to call C<< ->ready |
310 | >> on that once some event happens, and last you call C<schedule> to put |
281 | >> on that once some event happens, and last you call C<schedule> to put |
311 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
282 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
312 | so you need to check wether the event indeed happened, e.g. by storing the |
283 | so you need to check whether the event indeed happened, e.g. by storing the |
313 | status in a variable. |
284 | status in a variable. |
314 | |
285 | |
315 | The canonical way to wait on external events is this: |
286 | See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks. |
316 | |
|
|
317 | { |
|
|
318 | # remember current coroutine |
|
|
319 | my $current = $Coro::current; |
|
|
320 | |
|
|
321 | # register a hypothetical event handler |
|
|
322 | on_event_invoke sub { |
|
|
323 | # wake up sleeping coroutine |
|
|
324 | $current->ready; |
|
|
325 | undef $current; |
|
|
326 | }; |
|
|
327 | |
|
|
328 | # call schedule until event occurred. |
|
|
329 | # in case we are woken up for other reasons |
|
|
330 | # (current still defined), loop. |
|
|
331 | Coro::schedule while $current; |
|
|
332 | } |
|
|
333 | |
287 | |
334 | =item cede |
288 | =item cede |
335 | |
289 | |
336 | "Cede" to other coroutines. This function puts the current coroutine into |
290 | "Cede" to other coroutines. This function puts the current coroutine into |
337 | the ready queue and calls C<schedule>, which has the effect of giving |
291 | the ready queue and calls C<schedule>, which has the effect of giving |
… | |
… | |
356 | Kills/terminates/cancels all coroutines except the currently running |
310 | Kills/terminates/cancels all coroutines except the currently running |
357 | one. This is useful after a fork, either in the child or the parent, as |
311 | one. This is useful after a fork, either in the child or the parent, as |
358 | usually only one of them should inherit the running coroutines. |
312 | usually only one of them should inherit the running coroutines. |
359 | |
313 | |
360 | Note that while this will try to free some of the main programs resources, |
314 | Note that while this will try to free some of the main programs resources, |
361 | you cnanot free all of them, so if a coroutine that is not the main |
315 | you cannot free all of them, so if a coroutine that is not the main |
362 | program calls this function, there will be some one-time resource leak. |
316 | program calls this function, there will be some one-time resource leak. |
363 | |
317 | |
364 | =cut |
318 | =cut |
365 | |
|
|
366 | sub terminate { |
|
|
367 | $current->cancel (@_); |
|
|
368 | } |
|
|
369 | |
319 | |
370 | sub killall { |
320 | sub killall { |
371 | for (Coro::State::list) { |
321 | for (Coro::State::list) { |
372 | $_->cancel |
322 | $_->cancel |
373 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
323 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
374 | } |
324 | } |
375 | } |
325 | } |
376 | |
326 | |
377 | =back |
327 | =back |
378 | |
328 | |
379 | =head2 COROUTINE METHODS |
329 | =head1 COROUTINE OBJECT METHODS |
380 | |
330 | |
381 | These are the methods you can call on coroutine objects (or to create |
331 | These are the methods you can call on coroutine objects (or to create |
382 | them). |
332 | them). |
383 | |
333 | |
384 | =over 4 |
334 | =over 4 |
… | |
… | |
393 | See C<async> and C<Coro::State::new> for additional info about the |
343 | See C<async> and C<Coro::State::new> for additional info about the |
394 | coroutine environment. |
344 | coroutine environment. |
395 | |
345 | |
396 | =cut |
346 | =cut |
397 | |
347 | |
398 | sub _run_coro { |
348 | sub _terminate { |
399 | terminate &{+shift}; |
349 | terminate &{+shift}; |
400 | } |
|
|
401 | |
|
|
402 | sub new { |
|
|
403 | my $class = shift; |
|
|
404 | |
|
|
405 | $class->SUPER::new (\&_run_coro, @_) |
|
|
406 | } |
350 | } |
407 | |
351 | |
408 | =item $success = $coroutine->ready |
352 | =item $success = $coroutine->ready |
409 | |
353 | |
410 | Put the given coroutine into the end of its ready queue (there is one |
354 | Put the given coroutine into the end of its ready queue (there is one |
… | |
… | |
415 | once all the coroutines of higher priority and all coroutines of the same |
359 | once all the coroutines of higher priority and all coroutines of the same |
416 | priority that were put into the ready queue earlier have been resumed. |
360 | priority that were put into the ready queue earlier have been resumed. |
417 | |
361 | |
418 | =item $is_ready = $coroutine->is_ready |
362 | =item $is_ready = $coroutine->is_ready |
419 | |
363 | |
420 | Return wether the coroutine is currently the ready queue or not, |
364 | Return whether the coroutine is currently the ready queue or not, |
421 | |
365 | |
422 | =item $coroutine->cancel (arg...) |
366 | =item $coroutine->cancel (arg...) |
423 | |
367 | |
424 | Terminates the given coroutine and makes it return the given arguments as |
368 | Terminates the given coroutine and makes it return the given arguments as |
425 | status (default: the empty list). Never returns if the coroutine is the |
369 | status (default: the empty list). Never returns if the coroutine is the |
… | |
… | |
427 | |
371 | |
428 | =cut |
372 | =cut |
429 | |
373 | |
430 | sub cancel { |
374 | sub cancel { |
431 | my $self = shift; |
375 | my $self = shift; |
432 | $self->{_status} = [@_]; |
|
|
433 | |
376 | |
434 | if ($current == $self) { |
377 | if ($current == $self) { |
435 | push @destroy, $self; |
378 | terminate @_; |
436 | $manager->ready; |
|
|
437 | &schedule while 1; |
|
|
438 | } else { |
379 | } else { |
|
|
380 | $self->{_status} = [@_]; |
439 | $self->_cancel; |
381 | $self->_cancel; |
440 | } |
382 | } |
441 | } |
383 | } |
|
|
384 | |
|
|
385 | =item $coroutine->schedule_to |
|
|
386 | |
|
|
387 | Puts the current coroutine to sleep (like C<Coro::schedule>), but instead |
|
|
388 | of continuing with the next coro from the ready queue, always switch to |
|
|
389 | the given coroutine object (regardless of priority etc.). The readyness |
|
|
390 | state of that coroutine isn't changed. |
|
|
391 | |
|
|
392 | This is an advanced method for special cases - I'd love to hear about any |
|
|
393 | uses for this one. |
|
|
394 | |
|
|
395 | =item $coroutine->cede_to |
|
|
396 | |
|
|
397 | Like C<schedule_to>, but puts the current coroutine into the ready |
|
|
398 | queue. This has the effect of temporarily switching to the given |
|
|
399 | coroutine, and continuing some time later. |
|
|
400 | |
|
|
401 | This is an advanced method for special cases - I'd love to hear about any |
|
|
402 | uses for this one. |
|
|
403 | |
|
|
404 | =item $coroutine->throw ([$scalar]) |
|
|
405 | |
|
|
406 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
407 | inside the coroutine at the next convenient point in time. Otherwise |
|
|
408 | clears the exception object. |
|
|
409 | |
|
|
410 | Coro will check for the exception each time a schedule-like-function |
|
|
411 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
|
|
412 | >>, C<< Coro::Handle->readable >> and so on. Most of these functions |
|
|
413 | detect this case and return early in case an exception is pending. |
|
|
414 | |
|
|
415 | The exception object will be thrown "as is" with the specified scalar in |
|
|
416 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
417 | (unlike with C<die>). |
|
|
418 | |
|
|
419 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
420 | end itself, although there is no guarantee that the exception will lead to |
|
|
421 | termination, and if the exception isn't caught it might well end the whole |
|
|
422 | program. |
|
|
423 | |
|
|
424 | You might also think of C<throw> as being the moral equivalent of |
|
|
425 | C<kill>ing a coroutine with a signal (in this case, a scalar). |
442 | |
426 | |
443 | =item $coroutine->join |
427 | =item $coroutine->join |
444 | |
428 | |
445 | Wait until the coroutine terminates and return any values given to the |
429 | Wait until the coroutine terminates and return any values given to the |
446 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
430 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
… | |
… | |
508 | higher values mean lower priority, just as in unix). |
492 | higher values mean lower priority, just as in unix). |
509 | |
493 | |
510 | =item $olddesc = $coroutine->desc ($newdesc) |
494 | =item $olddesc = $coroutine->desc ($newdesc) |
511 | |
495 | |
512 | Sets (or gets in case the argument is missing) the description for this |
496 | Sets (or gets in case the argument is missing) the description for this |
513 | coroutine. This is just a free-form string you can associate with a coroutine. |
497 | coroutine. This is just a free-form string you can associate with a |
|
|
498 | coroutine. |
514 | |
499 | |
515 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
500 | This method simply sets the C<< $coroutine->{desc} >> member to the given |
516 | can modify this member directly if you wish. |
501 | string. You can modify this member directly if you wish. |
517 | |
|
|
518 | =item $coroutine->throw ([$scalar]) |
|
|
519 | |
|
|
520 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
521 | inside the coroutine at the next convinient point in time (usually after |
|
|
522 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
523 | exception object. |
|
|
524 | |
|
|
525 | The exception object will be thrown "as is" with the specified scalar in |
|
|
526 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
527 | (unlike with C<die>). |
|
|
528 | |
|
|
529 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
530 | end itself, although there is no guarentee that the exception will lead to |
|
|
531 | termination, and if the exception isn't caught it might well end the whole |
|
|
532 | program. |
|
|
533 | |
502 | |
534 | =cut |
503 | =cut |
535 | |
504 | |
536 | sub desc { |
505 | sub desc { |
537 | my $old = $_[0]{desc}; |
506 | my $old = $_[0]{desc}; |
538 | $_[0]{desc} = $_[1] if @_ > 1; |
507 | $_[0]{desc} = $_[1] if @_ > 1; |
539 | $old; |
508 | $old; |
540 | } |
509 | } |
541 | |
510 | |
|
|
511 | sub transfer { |
|
|
512 | require Carp; |
|
|
513 | Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught"); |
|
|
514 | } |
|
|
515 | |
542 | =back |
516 | =back |
543 | |
517 | |
544 | =head2 GLOBAL FUNCTIONS |
518 | =head1 GLOBAL FUNCTIONS |
545 | |
519 | |
546 | =over 4 |
520 | =over 4 |
547 | |
521 | |
548 | =item Coro::nready |
522 | =item Coro::nready |
549 | |
523 | |
… | |
… | |
629 | # return immediately and can be reused) and because we cannot cede |
603 | # return immediately and can be reused) and because we cannot cede |
630 | # inside an event callback. |
604 | # inside an event callback. |
631 | our $unblock_scheduler = new Coro sub { |
605 | our $unblock_scheduler = new Coro sub { |
632 | while () { |
606 | while () { |
633 | while (my $cb = pop @unblock_queue) { |
607 | while (my $cb = pop @unblock_queue) { |
634 | # this is an inlined copy of async_pool |
608 | &async_pool (@$cb); |
635 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
636 | |
609 | |
637 | $coro->{_invoke} = $cb; |
|
|
638 | $coro->ready; |
|
|
639 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
610 | # for short-lived callbacks, this reduces pressure on the coro pool |
|
|
611 | # as the chance is very high that the async_poll coro will be back |
|
|
612 | # in the idle state when cede returns |
|
|
613 | cede; |
640 | } |
614 | } |
641 | schedule; # sleep well |
615 | schedule; # sleep well |
642 | } |
616 | } |
643 | }; |
617 | }; |
644 | $unblock_scheduler->desc ("[unblock_sub scheduler]"); |
618 | $unblock_scheduler->{desc} = "[unblock_sub scheduler]"; |
645 | |
619 | |
646 | sub unblock_sub(&) { |
620 | sub unblock_sub(&) { |
647 | my $cb = shift; |
621 | my $cb = shift; |
648 | |
622 | |
649 | sub { |
623 | sub { |
650 | unshift @unblock_queue, [$cb, @_]; |
624 | unshift @unblock_queue, [$cb, @_]; |
651 | $unblock_scheduler->ready; |
625 | $unblock_scheduler->ready; |
652 | } |
626 | } |
653 | } |
627 | } |
654 | |
628 | |
|
|
629 | =item $cb = Coro::rouse_cb |
|
|
630 | |
|
|
631 | Create and return a "rouse callback". That's a code reference that, when |
|
|
632 | called, will save its arguments and notify the owner coroutine of the |
|
|
633 | callback. |
|
|
634 | |
|
|
635 | See the next function. |
|
|
636 | |
|
|
637 | =item @args = Coro::rouse_wait [$cb] |
|
|
638 | |
|
|
639 | Wait for the specified rouse callback (or the last one tht was created in |
|
|
640 | this coroutine). |
|
|
641 | |
|
|
642 | As soon as the callback is invoked (or when the calback was invoked before |
|
|
643 | C<rouse_wait>), it will return a copy of the arguments originally passed |
|
|
644 | to the rouse callback. |
|
|
645 | |
|
|
646 | See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. |
|
|
647 | |
655 | =back |
648 | =back |
656 | |
649 | |
657 | =cut |
650 | =cut |
658 | |
651 | |
659 | 1; |
652 | 1; |
660 | |
653 | |
|
|
654 | =head1 HOW TO WAIT FOR A CALLBACK |
|
|
655 | |
|
|
656 | It is very common for a coroutine to wait for some callback to be |
|
|
657 | called. This occurs naturally when you use coroutines in an otherwise |
|
|
658 | event-based program, or when you use event-based libraries. |
|
|
659 | |
|
|
660 | These typically register a callback for some event, and call that callback |
|
|
661 | when the event occured. In a coroutine, however, you typically want to |
|
|
662 | just wait for the event, simplyifying things. |
|
|
663 | |
|
|
664 | For example C<< AnyEvent->child >> registers a callback to be called when |
|
|
665 | a specific child has exited: |
|
|
666 | |
|
|
667 | my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... }); |
|
|
668 | |
|
|
669 | But from withina coroutine, you often just want to write this: |
|
|
670 | |
|
|
671 | my $status = wait_for_child $pid; |
|
|
672 | |
|
|
673 | Coro offers two functions specifically designed to make this easy, |
|
|
674 | C<Coro::rouse_cb> and C<Coro::rouse_wait>. |
|
|
675 | |
|
|
676 | The first function, C<rouse_cb>, generates and returns a callback that, |
|
|
677 | when invoked, will save it's arguments and notify the coroutine that |
|
|
678 | created the callback. |
|
|
679 | |
|
|
680 | The second function, C<rouse_wait>, waits for the callback to be called |
|
|
681 | (by calling C<schedule> to go to sleep) and returns the arguments |
|
|
682 | originally passed to the callback. |
|
|
683 | |
|
|
684 | Using these functions, it becomes easy to write the C<wait_for_child> |
|
|
685 | function mentioned above: |
|
|
686 | |
|
|
687 | sub wait_for_child($) { |
|
|
688 | my ($pid) = @_; |
|
|
689 | |
|
|
690 | my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb); |
|
|
691 | |
|
|
692 | my ($rpid, $rstatus) = Coro::rouse_wait; |
|
|
693 | $rstatus |
|
|
694 | } |
|
|
695 | |
|
|
696 | In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough, |
|
|
697 | you can roll your own, using C<schedule>: |
|
|
698 | |
|
|
699 | sub wait_for_child($) { |
|
|
700 | my ($pid) = @_; |
|
|
701 | |
|
|
702 | # store the current coroutine in $current, |
|
|
703 | # and provide result variables for the closure passed to ->child |
|
|
704 | my $current = $Coro::current; |
|
|
705 | my ($done, $rstatus); |
|
|
706 | |
|
|
707 | # pass a closure to ->child |
|
|
708 | my $watcher = AnyEvent->child (pid => $pid, cb => sub { |
|
|
709 | $rstatus = $_[1]; # remember rstatus |
|
|
710 | $done = 1; # mark $rstatus as valud |
|
|
711 | }); |
|
|
712 | |
|
|
713 | # wait until the closure has been called |
|
|
714 | schedule while !$done; |
|
|
715 | |
|
|
716 | $rstatus |
|
|
717 | } |
|
|
718 | |
|
|
719 | |
661 | =head1 BUGS/LIMITATIONS |
720 | =head1 BUGS/LIMITATIONS |
|
|
721 | |
|
|
722 | =over 4 |
|
|
723 | |
|
|
724 | =item fork with pthread backend |
|
|
725 | |
|
|
726 | When Coro is compiled using the pthread backend (which isn't recommended |
|
|
727 | but required on many BSDs as their libcs are completely broken), then |
|
|
728 | coroutines will not survive a fork. There is no known workaround except to |
|
|
729 | fix your libc and use a saner backend. |
|
|
730 | |
|
|
731 | =item perl process emulation ("threads") |
662 | |
732 | |
663 | This module is not perl-pseudo-thread-safe. You should only ever use this |
733 | This module is not perl-pseudo-thread-safe. You should only ever use this |
664 | module from the same thread (this requirement might be removed in the |
734 | module from the same thread (this requirement might be removed in the |
665 | future to allow per-thread schedulers, but Coro::State does not yet allow |
735 | future to allow per-thread schedulers, but Coro::State does not yet allow |
666 | this). I recommend disabling thread support and using processes, as this |
736 | this). I recommend disabling thread support and using processes, as having |
667 | is much faster and uses less memory. |
737 | the windows process emulation enabled under unix roughly halves perl |
|
|
738 | performance, even when not used. |
|
|
739 | |
|
|
740 | =item coroutine switching not signal safe |
|
|
741 | |
|
|
742 | You must not switch to another coroutine from within a signal handler |
|
|
743 | (only relevant with %SIG - most event libraries provide safe signals). |
|
|
744 | |
|
|
745 | That means you I<MUST NOT> call any function that might "block" the |
|
|
746 | current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
|
|
747 | anything that calls those. Everything else, including calling C<ready>, |
|
|
748 | works. |
|
|
749 | |
|
|
750 | =back |
|
|
751 | |
668 | |
752 | |
669 | =head1 SEE ALSO |
753 | =head1 SEE ALSO |
670 | |
754 | |
671 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
755 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
672 | |
756 | |