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 | |
… | |
… | |
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 |
40 | multiple running interpreters that share data, which is especially useful |
35 | in the form of cooperative threads (also called coroutines in the |
41 | to code pseudo-parallel processes and for event-based programming, such as |
36 | documentation). They are similar to kernel threads but don't (in general) |
42 | multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> to |
37 | run in parallel at the same time even on SMP machines. The specific flavor |
43 | learn more. |
38 | of thread offered by this module also guarantees you that it will not |
|
|
39 | switch between threads unless necessary, at easily-identified points in |
|
|
40 | your program, so locking and parallel access are rarely an issue, making |
|
|
41 | thread programming much safer and easier than using other thread models. |
44 | |
42 | |
45 | Coroutines are also useful because Perl has no support for threads (the so |
43 | 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 |
44 | but only the windows process emulation ported to unix), Coro provides a |
47 | emulation coming from the Windows platform: On standard operating systems |
45 | full shared address space, which makes communication between threads |
48 | they serve no purpose whatsoever, except by making your programs slow and |
46 | very easy. And threads are fast, too: disabling the Windows process |
49 | making them use a lot of memory. Best disable them when building perl, or |
47 | emulation code in your perl and using Coro can easily result in a two to |
50 | aks your software vendor/distributor to do it for you). |
48 | four times speed increase for your programs. |
51 | |
49 | |
|
|
50 | Coro achieves that by supporting multiple running interpreters that share |
|
|
51 | data, which is especially useful to code pseudo-parallel processes and |
|
|
52 | for event-based programming, such as multiple HTTP-GET requests running |
|
|
53 | concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro |
|
|
54 | into an event-based environment. |
|
|
55 | |
52 | In this module, coroutines are defined as "callchain + lexical variables + |
56 | In this module, a thread is defined as "callchain + lexical variables + |
53 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
57 | @_ + $_ + $@ + $/ + 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 |
58 | its own set of lexicals and its own set of perls most important global |
55 | variables (see L<Coro::State> for more configuration). |
59 | variables (see L<Coro::State> for more configuration and background info). |
|
|
60 | |
|
|
61 | See also the C<SEE ALSO> section at the end of this document - the Coro |
|
|
62 | module family is quite large. |
56 | |
63 | |
57 | =cut |
64 | =cut |
58 | |
65 | |
59 | package Coro; |
66 | package Coro; |
60 | |
67 | |
61 | use strict; |
68 | use strict qw(vars subs); |
62 | no warnings "uninitialized"; |
69 | no warnings "uninitialized"; |
63 | |
70 | |
64 | use Coro::State; |
71 | use Coro::State; |
65 | |
72 | |
66 | use base qw(Coro::State Exporter); |
73 | use base qw(Coro::State Exporter); |
67 | |
74 | |
68 | our $idle; # idle handler |
75 | our $idle; # idle handler |
69 | our $main; # main coroutine |
76 | our $main; # main coroutine |
70 | our $current; # current coroutine |
77 | our $current; # current coroutine |
71 | |
78 | |
72 | our $VERSION = 4.746; |
79 | our $VERSION = 5.13; |
73 | |
80 | |
74 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
81 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
75 | our %EXPORT_TAGS = ( |
82 | our %EXPORT_TAGS = ( |
76 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
83 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
77 | ); |
84 | ); |
78 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
85 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
79 | |
86 | |
|
|
87 | =head1 GLOBAL VARIABLES |
|
|
88 | |
80 | =over 4 |
89 | =over 4 |
81 | |
90 | |
82 | =item $Coro::main |
91 | =item $Coro::main |
83 | |
92 | |
84 | This variable stores the coroutine object that represents the main |
93 | This variable stores the coroutine object that represents the main |
… | |
… | |
86 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
95 | coroutines, it is mainly useful to compare again C<$Coro::current>, to see |
87 | whether you are running in the main program or not. |
96 | whether you are running in the main program or not. |
88 | |
97 | |
89 | =cut |
98 | =cut |
90 | |
99 | |
91 | $main = new Coro; |
100 | # $main is now being initialised by Coro::State |
92 | |
101 | |
93 | =item $Coro::current |
102 | =item $Coro::current |
94 | |
103 | |
95 | The coroutine object representing the current coroutine (the last |
104 | The coroutine object representing the current coroutine (the last |
96 | coroutine that the Coro scheduler switched to). The initial value is |
105 | coroutine that the Coro scheduler switched to). The initial value is |
97 | C<$main> (of course). |
106 | C<$Coro::main> (of course). |
98 | |
107 | |
99 | This variable is B<strictly> I<read-only>. You can take copies of the |
108 | 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 |
109 | value stored in it and use it as any other coroutine object, but you must |
101 | not otherwise modify the variable itself. |
110 | not otherwise modify the variable itself. |
102 | |
111 | |
103 | =cut |
112 | =cut |
104 | |
113 | |
105 | $main->{desc} = "[main::]"; |
|
|
106 | |
|
|
107 | # maybe some other module used Coro::Specific before... |
|
|
108 | $main->{_specific} = $current->{_specific} |
|
|
109 | if $current; |
|
|
110 | |
|
|
111 | _set_current $main; |
|
|
112 | |
|
|
113 | sub current() { $current } # [DEPRECATED] |
114 | sub current() { $current } # [DEPRECATED] |
114 | |
115 | |
115 | =item $Coro::idle |
116 | =item $Coro::idle |
116 | |
117 | |
117 | This variable is mainly useful to integrate Coro into event loops. It is |
118 | This variable is mainly useful to integrate Coro into event loops. It is |
118 | usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is |
119 | usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is |
119 | pretty low-level functionality. |
120 | pretty low-level functionality. |
120 | |
121 | |
121 | This variable stores a callback that is called whenever the scheduler |
122 | This variable stores either a coroutine or a callback. |
|
|
123 | |
|
|
124 | If it is a callback, the it is called whenever the scheduler finds no |
122 | finds no ready coroutines to run. The default implementation prints |
125 | ready coroutines to run. The default implementation prints "FATAL: |
123 | "FATAL: deadlock detected" and exits, because the program has no other way |
126 | deadlock detected" and exits, because the program has no other way to |
124 | to continue. |
127 | continue. |
125 | |
128 | |
|
|
129 | If it is a coroutine object, then this object will be readied (without |
|
|
130 | invoking any ready hooks, however) when the scheduler finds no other ready |
|
|
131 | coroutines to run. |
|
|
132 | |
126 | This hook is overwritten by modules such as C<Coro::Timer> and |
133 | This hook is overwritten by modules such as C<Coro::EV> and |
127 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
134 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
128 | coroutine so the scheduler can run it. |
135 | coroutine so the scheduler can run it. |
129 | |
136 | |
130 | Note that the callback I<must not>, under any circumstances, block |
137 | Note that the callback I<must not>, under any circumstances, block |
131 | the current coroutine. Normally, this is achieved by having an "idle |
138 | the current coroutine. Normally, this is achieved by having an "idle |
132 | coroutine" that calls the event loop and then blocks again, and then |
139 | coroutine" that calls the event loop and then blocks again, and then |
133 | readying that coroutine in the idle handler. |
140 | readying that coroutine in the idle handler, or by simply placing the idle |
|
|
141 | coroutine in this variable. |
134 | |
142 | |
135 | See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this |
143 | See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this |
136 | technique. |
144 | technique. |
137 | |
145 | |
138 | Please note that if your callback recursively invokes perl (e.g. for event |
146 | Please note that if your callback recursively invokes perl (e.g. for event |
… | |
… | |
143 | $idle = sub { |
151 | $idle = sub { |
144 | require Carp; |
152 | require Carp; |
145 | Carp::croak ("FATAL: deadlock detected"); |
153 | Carp::croak ("FATAL: deadlock detected"); |
146 | }; |
154 | }; |
147 | |
155 | |
148 | sub _cancel { |
|
|
149 | my ($self) = @_; |
|
|
150 | |
|
|
151 | # free coroutine data and mark as destructed |
|
|
152 | $self->_destroy |
|
|
153 | or return; |
|
|
154 | |
|
|
155 | # call all destruction callbacks |
|
|
156 | $_->(@{$self->{_status}}) |
|
|
157 | for @{(delete $self->{_on_destroy}) || []}; |
|
|
158 | } |
|
|
159 | |
|
|
160 | # this coroutine is necessary because a coroutine |
156 | # this coroutine is necessary because a coroutine |
161 | # cannot destroy itself. |
157 | # cannot destroy itself. |
162 | my @destroy; |
158 | our @destroy; |
163 | my $manager; |
159 | our $manager; |
164 | |
160 | |
165 | $manager = new Coro sub { |
161 | $manager = new Coro sub { |
166 | while () { |
162 | while () { |
167 | (shift @destroy)->_cancel |
163 | Coro::_cancel shift @destroy |
168 | while @destroy; |
164 | while @destroy; |
169 | |
165 | |
170 | &schedule; |
166 | &schedule; |
171 | } |
167 | } |
172 | }; |
168 | }; |
173 | $manager->desc ("[coro manager]"); |
169 | $manager->{desc} = "[coro manager]"; |
174 | $manager->prio (PRIO_MAX); |
170 | $manager->prio (PRIO_MAX); |
175 | |
171 | |
176 | =back |
172 | =back |
177 | |
173 | |
178 | =head2 SIMPLE COROUTINE CREATION |
174 | =head1 SIMPLE COROUTINE CREATION |
179 | |
175 | |
180 | =over 4 |
176 | =over 4 |
181 | |
177 | |
182 | =item async { ... } [@args...] |
178 | =item async { ... } [@args...] |
183 | |
179 | |
184 | Create a new coroutine and return it's coroutine object (usually |
180 | Create a new coroutine and return its coroutine object (usually |
185 | unused). The coroutine will be put into the ready queue, so |
181 | unused). The coroutine will be put into the ready queue, so |
186 | it will start running automatically on the next scheduler run. |
182 | it will start running automatically on the next scheduler run. |
187 | |
183 | |
188 | The first argument is a codeblock/closure that should be executed in the |
184 | The first argument is a codeblock/closure that should be executed in the |
189 | coroutine. When it returns argument returns the coroutine is automatically |
185 | coroutine. When it returns argument returns the coroutine is automatically |
… | |
… | |
220 | Similar to C<async>, but uses a coroutine pool, so you should not call |
216 | Similar to C<async>, but uses a coroutine pool, so you should not call |
221 | terminate or join on it (although you are allowed to), and you get a |
217 | terminate or join on it (although you are allowed to), and you get a |
222 | coroutine that might have executed other code already (which can be good |
218 | coroutine that might have executed other code already (which can be good |
223 | or bad :). |
219 | or bad :). |
224 | |
220 | |
225 | On the plus side, this function is faster than creating (and destroying) |
221 | On the plus side, this function is about twice as fast as creating (and |
226 | a completely new coroutine, so if you need a lot of generic coroutines in |
222 | destroying) a completely new coroutine, so if you need a lot of generic |
227 | quick successsion, use C<async_pool>, not C<async>. |
223 | coroutines in quick successsion, use C<async_pool>, not C<async>. |
228 | |
224 | |
229 | The code block is executed in an C<eval> context and a warning will be |
225 | The code block is executed in an C<eval> context and a warning will be |
230 | issued in case of an exception instead of terminating the program, as |
226 | issued in case of an exception instead of terminating the program, as |
231 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
227 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
232 | will not work in the expected way, unless you call terminate or cancel, |
228 | will not work in the expected way, unless you call terminate or cancel, |
… | |
… | |
235 | |
231 | |
236 | The priority will be reset to C<0> after each run, tracing will be |
232 | The priority will be reset to C<0> after each run, tracing will be |
237 | disabled, the description will be reset and the default output filehandle |
233 | disabled, the description will be reset and the default output filehandle |
238 | gets restored, so you can change all these. Otherwise the coroutine will |
234 | gets restored, so you can change all these. Otherwise the coroutine will |
239 | be re-used "as-is": most notably if you change other per-coroutine global |
235 | be re-used "as-is": most notably if you change other per-coroutine global |
240 | stuff such as C<$/> you I<must needs> to revert that change, which is most |
236 | stuff such as C<$/> you I<must needs> revert that change, which is most |
241 | simply done by using local as in: C< local $/ >. |
237 | simply done by using local as in: C<< local $/ >>. |
242 | |
238 | |
243 | The pool size is limited to C<8> idle coroutines (this can be adjusted by |
239 | The idle pool size is limited to C<8> idle coroutines (this can be |
244 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
240 | adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle |
245 | required. |
241 | coros as required. |
246 | |
242 | |
247 | If you are concerned about pooled coroutines growing a lot because a |
243 | If you are concerned about pooled coroutines growing a lot because a |
248 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
244 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
249 | { terminate }> once per second or so to slowly replenish the pool. In |
245 | { terminate }> once per second or so to slowly replenish the pool. In |
250 | addition to that, when the stacks used by a handler grows larger than 16kb |
246 | addition to that, when the stacks used by a handler grows larger than 32kb |
251 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
247 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
252 | |
248 | |
253 | =cut |
249 | =cut |
254 | |
250 | |
255 | our $POOL_SIZE = 8; |
251 | our $POOL_SIZE = 8; |
256 | our $POOL_RSS = 16 * 1024; |
252 | our $POOL_RSS = 32 * 1024; |
257 | our @async_pool; |
253 | our @async_pool; |
258 | |
254 | |
259 | sub pool_handler { |
255 | sub pool_handler { |
260 | my $cb; |
|
|
261 | |
|
|
262 | while () { |
256 | while () { |
263 | eval { |
257 | eval { |
264 | while () { |
258 | &{&_pool_handler} while 1; |
265 | _pool_1 $cb; |
|
|
266 | &$cb; |
|
|
267 | _pool_2 $cb; |
|
|
268 | &schedule; |
|
|
269 | } |
|
|
270 | }; |
259 | }; |
271 | |
260 | |
272 | if ($@) { |
|
|
273 | last if $@ eq "\3async_pool terminate\2\n"; |
|
|
274 | warn $@; |
261 | warn $@ if $@; |
275 | } |
|
|
276 | } |
262 | } |
277 | } |
|
|
278 | |
|
|
279 | sub async_pool(&@) { |
|
|
280 | # this is also inlined into the unlock_scheduler |
|
|
281 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
282 | |
|
|
283 | $coro->{_invoke} = [@_]; |
|
|
284 | $coro->ready; |
|
|
285 | |
|
|
286 | $coro |
|
|
287 | } |
263 | } |
288 | |
264 | |
289 | =back |
265 | =back |
290 | |
266 | |
291 | =head2 STATIC METHODS |
267 | =head1 STATIC METHODS |
292 | |
268 | |
293 | Static methods are actually functions that operate on the current coroutine. |
269 | Static methods are actually functions that implicitly operate on the |
|
|
270 | current coroutine. |
294 | |
271 | |
295 | =over 4 |
272 | =over 4 |
296 | |
273 | |
297 | =item schedule |
274 | =item schedule |
298 | |
275 | |
… | |
… | |
313 | >> on that once some event happens, and last you call C<schedule> to put |
290 | >> on that once some event happens, and last you call C<schedule> to put |
314 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
291 | yourself to sleep. Note that a lot of things can wake your coroutine up, |
315 | so you need to check whether the event indeed happened, e.g. by storing the |
292 | so you need to check whether the event indeed happened, e.g. by storing the |
316 | status in a variable. |
293 | status in a variable. |
317 | |
294 | |
318 | The canonical way to wait on external events is this: |
295 | See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks. |
319 | |
|
|
320 | { |
|
|
321 | # remember current coroutine |
|
|
322 | my $current = $Coro::current; |
|
|
323 | |
|
|
324 | # register a hypothetical event handler |
|
|
325 | on_event_invoke sub { |
|
|
326 | # wake up sleeping coroutine |
|
|
327 | $current->ready; |
|
|
328 | undef $current; |
|
|
329 | }; |
|
|
330 | |
|
|
331 | # call schedule until event occurred. |
|
|
332 | # in case we are woken up for other reasons |
|
|
333 | # (current still defined), loop. |
|
|
334 | Coro::schedule while $current; |
|
|
335 | } |
|
|
336 | |
296 | |
337 | =item cede |
297 | =item cede |
338 | |
298 | |
339 | "Cede" to other coroutines. This function puts the current coroutine into |
299 | "Cede" to other coroutines. This function puts the current coroutine into |
340 | the ready queue and calls C<schedule>, which has the effect of giving |
300 | the ready queue and calls C<schedule>, which has the effect of giving |
… | |
… | |
364 | you cannot free all of them, so if a coroutine that is not the main |
324 | you cannot free all of them, so if a coroutine that is not the main |
365 | program calls this function, there will be some one-time resource leak. |
325 | program calls this function, there will be some one-time resource leak. |
366 | |
326 | |
367 | =cut |
327 | =cut |
368 | |
328 | |
369 | sub terminate { |
|
|
370 | $current->cancel (@_); |
|
|
371 | } |
|
|
372 | |
|
|
373 | sub killall { |
329 | sub killall { |
374 | for (Coro::State::list) { |
330 | for (Coro::State::list) { |
375 | $_->cancel |
331 | $_->cancel |
376 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
332 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
377 | } |
333 | } |
378 | } |
334 | } |
379 | |
335 | |
380 | =back |
336 | =back |
381 | |
337 | |
382 | =head2 COROUTINE METHODS |
338 | =head1 COROUTINE OBJECT METHODS |
383 | |
339 | |
384 | These are the methods you can call on coroutine objects (or to create |
340 | These are the methods you can call on coroutine objects (or to create |
385 | them). |
341 | them). |
386 | |
342 | |
387 | =over 4 |
343 | =over 4 |
… | |
… | |
396 | See C<async> and C<Coro::State::new> for additional info about the |
352 | See C<async> and C<Coro::State::new> for additional info about the |
397 | coroutine environment. |
353 | coroutine environment. |
398 | |
354 | |
399 | =cut |
355 | =cut |
400 | |
356 | |
401 | sub _run_coro { |
357 | sub _coro_run { |
402 | terminate &{+shift}; |
358 | terminate &{+shift}; |
403 | } |
|
|
404 | |
|
|
405 | sub new { |
|
|
406 | my $class = shift; |
|
|
407 | |
|
|
408 | $class->SUPER::new (\&_run_coro, @_) |
|
|
409 | } |
359 | } |
410 | |
360 | |
411 | =item $success = $coroutine->ready |
361 | =item $success = $coroutine->ready |
412 | |
362 | |
413 | Put the given coroutine into the end of its ready queue (there is one |
363 | Put the given coroutine into the end of its ready queue (there is one |
… | |
… | |
430 | |
380 | |
431 | =cut |
381 | =cut |
432 | |
382 | |
433 | sub cancel { |
383 | sub cancel { |
434 | my $self = shift; |
384 | my $self = shift; |
435 | $self->{_status} = [@_]; |
|
|
436 | |
385 | |
437 | if ($current == $self) { |
386 | if ($current == $self) { |
438 | push @destroy, $self; |
387 | terminate @_; |
439 | $manager->ready; |
|
|
440 | &schedule while 1; |
|
|
441 | } else { |
388 | } else { |
|
|
389 | $self->{_status} = [@_]; |
442 | $self->_cancel; |
390 | $self->_cancel; |
443 | } |
391 | } |
444 | } |
392 | } |
|
|
393 | |
|
|
394 | =item $coroutine->schedule_to |
|
|
395 | |
|
|
396 | Puts the current coroutine to sleep (like C<Coro::schedule>), but instead |
|
|
397 | of continuing with the next coro from the ready queue, always switch to |
|
|
398 | the given coroutine object (regardless of priority etc.). The readyness |
|
|
399 | state of that coroutine isn't changed. |
|
|
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->cede_to |
|
|
405 | |
|
|
406 | Like C<schedule_to>, but puts the current coroutine into the ready |
|
|
407 | queue. This has the effect of temporarily switching to the given |
|
|
408 | coroutine, and continuing some time later. |
|
|
409 | |
|
|
410 | This is an advanced method for special cases - I'd love to hear about any |
|
|
411 | uses for this one. |
|
|
412 | |
|
|
413 | =item $coroutine->throw ([$scalar]) |
|
|
414 | |
|
|
415 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
416 | inside the coroutine at the next convenient point in time. Otherwise |
|
|
417 | clears the exception object. |
|
|
418 | |
|
|
419 | Coro will check for the exception each time a schedule-like-function |
|
|
420 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
|
|
421 | >>, C<< Coro::Handle->readable >> and so on. Most of these functions |
|
|
422 | detect this case and return early in case an exception is pending. |
|
|
423 | |
|
|
424 | The exception object will be thrown "as is" with the specified scalar in |
|
|
425 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
426 | (unlike with C<die>). |
|
|
427 | |
|
|
428 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
429 | end itself, although there is no guarantee that the exception will lead to |
|
|
430 | termination, and if the exception isn't caught it might well end the whole |
|
|
431 | program. |
|
|
432 | |
|
|
433 | You might also think of C<throw> as being the moral equivalent of |
|
|
434 | C<kill>ing a coroutine with a signal (in this case, a scalar). |
445 | |
435 | |
446 | =item $coroutine->join |
436 | =item $coroutine->join |
447 | |
437 | |
448 | Wait until the coroutine terminates and return any values given to the |
438 | Wait until the coroutine terminates and return any values given to the |
449 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
439 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
… | |
… | |
511 | higher values mean lower priority, just as in unix). |
501 | higher values mean lower priority, just as in unix). |
512 | |
502 | |
513 | =item $olddesc = $coroutine->desc ($newdesc) |
503 | =item $olddesc = $coroutine->desc ($newdesc) |
514 | |
504 | |
515 | Sets (or gets in case the argument is missing) the description for this |
505 | Sets (or gets in case the argument is missing) the description for this |
516 | coroutine. This is just a free-form string you can associate with a coroutine. |
506 | coroutine. This is just a free-form string you can associate with a |
|
|
507 | coroutine. |
517 | |
508 | |
518 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
509 | This method simply sets the C<< $coroutine->{desc} >> member to the given |
519 | can modify this member directly if you wish. |
510 | string. You can modify this member directly if you wish. |
520 | |
|
|
521 | =item $coroutine->throw ([$scalar]) |
|
|
522 | |
|
|
523 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
524 | inside the coroutine at the next convinient point in time (usually after |
|
|
525 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
526 | exception object. |
|
|
527 | |
|
|
528 | The exception object will be thrown "as is" with the specified scalar in |
|
|
529 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
530 | (unlike with C<die>). |
|
|
531 | |
|
|
532 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
533 | end itself, although there is no guarentee that the exception will lead to |
|
|
534 | termination, and if the exception isn't caught it might well end the whole |
|
|
535 | program. |
|
|
536 | |
511 | |
537 | =cut |
512 | =cut |
538 | |
513 | |
539 | sub desc { |
514 | sub desc { |
540 | my $old = $_[0]{desc}; |
515 | my $old = $_[0]{desc}; |
541 | $_[0]{desc} = $_[1] if @_ > 1; |
516 | $_[0]{desc} = $_[1] if @_ > 1; |
542 | $old; |
517 | $old; |
543 | } |
518 | } |
544 | |
519 | |
|
|
520 | sub transfer { |
|
|
521 | require Carp; |
|
|
522 | Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught"); |
|
|
523 | } |
|
|
524 | |
545 | =back |
525 | =back |
546 | |
526 | |
547 | =head2 GLOBAL FUNCTIONS |
527 | =head1 GLOBAL FUNCTIONS |
548 | |
528 | |
549 | =over 4 |
529 | =over 4 |
550 | |
530 | |
551 | =item Coro::nready |
531 | =item Coro::nready |
552 | |
532 | |
… | |
… | |
557 | would cause a deadlock unless there is an idle handler that wakes up some |
537 | would cause a deadlock unless there is an idle handler that wakes up some |
558 | coroutines. |
538 | coroutines. |
559 | |
539 | |
560 | =item my $guard = Coro::guard { ... } |
540 | =item my $guard = Coro::guard { ... } |
561 | |
541 | |
562 | This creates and returns a guard object. Nothing happens until the object |
542 | This function still exists, but is deprecated. Please use the |
563 | gets destroyed, in which case the codeblock given as argument will be |
543 | C<Guard::guard> function instead. |
564 | executed. This is useful to free locks or other resources in case of a |
|
|
565 | runtime error or when the coroutine gets canceled, as in both cases the |
|
|
566 | guard block will be executed. The guard object supports only one method, |
|
|
567 | C<< ->cancel >>, which will keep the codeblock from being executed. |
|
|
568 | |
544 | |
569 | Example: set some flag and clear it again when the coroutine gets canceled |
|
|
570 | or the function returns: |
|
|
571 | |
|
|
572 | sub do_something { |
|
|
573 | my $guard = Coro::guard { $busy = 0 }; |
|
|
574 | $busy = 1; |
|
|
575 | |
|
|
576 | # do something that requires $busy to be true |
|
|
577 | } |
|
|
578 | |
|
|
579 | =cut |
545 | =cut |
580 | |
546 | |
581 | sub guard(&) { |
547 | BEGIN { *guard = \&Guard::guard } |
582 | bless \(my $cb = $_[0]), "Coro::guard" |
|
|
583 | } |
|
|
584 | |
|
|
585 | sub Coro::guard::cancel { |
|
|
586 | ${$_[0]} = sub { }; |
|
|
587 | } |
|
|
588 | |
|
|
589 | sub Coro::guard::DESTROY { |
|
|
590 | ${$_[0]}->(); |
|
|
591 | } |
|
|
592 | |
|
|
593 | |
548 | |
594 | =item unblock_sub { ... } |
549 | =item unblock_sub { ... } |
595 | |
550 | |
596 | This utility function takes a BLOCK or code reference and "unblocks" it, |
551 | This utility function takes a BLOCK or code reference and "unblocks" it, |
597 | returning a new coderef. Unblocking means that calling the new coderef |
552 | returning a new coderef. Unblocking means that calling the new coderef |
… | |
… | |
599 | original code ref will be called (with parameters) from within another |
554 | original code ref will be called (with parameters) from within another |
600 | coroutine. |
555 | coroutine. |
601 | |
556 | |
602 | The reason this function exists is that many event libraries (such as the |
557 | The reason this function exists is that many event libraries (such as the |
603 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
558 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
604 | of thread-safety). This means you must not block within event callbacks, |
559 | of reentrancy). This means you must not block within event callbacks, |
605 | otherwise you might suffer from crashes or worse. The only event library |
560 | otherwise you might suffer from crashes or worse. The only event library |
606 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
561 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
607 | |
562 | |
608 | This function allows your callbacks to block by executing them in another |
563 | This function allows your callbacks to block by executing them in another |
609 | coroutine where it is safe to block. One example where blocking is handy |
564 | coroutine where it is safe to block. One example where blocking is handy |
… | |
… | |
632 | # return immediately and can be reused) and because we cannot cede |
587 | # return immediately and can be reused) and because we cannot cede |
633 | # inside an event callback. |
588 | # inside an event callback. |
634 | our $unblock_scheduler = new Coro sub { |
589 | our $unblock_scheduler = new Coro sub { |
635 | while () { |
590 | while () { |
636 | while (my $cb = pop @unblock_queue) { |
591 | while (my $cb = pop @unblock_queue) { |
637 | # this is an inlined copy of async_pool |
592 | &async_pool (@$cb); |
638 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
639 | |
593 | |
640 | $coro->{_invoke} = $cb; |
|
|
641 | $coro->ready; |
|
|
642 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
594 | # for short-lived callbacks, this reduces pressure on the coro pool |
|
|
595 | # as the chance is very high that the async_poll coro will be back |
|
|
596 | # in the idle state when cede returns |
|
|
597 | cede; |
643 | } |
598 | } |
644 | schedule; # sleep well |
599 | schedule; # sleep well |
645 | } |
600 | } |
646 | }; |
601 | }; |
647 | $unblock_scheduler->desc ("[unblock_sub scheduler]"); |
602 | $unblock_scheduler->{desc} = "[unblock_sub scheduler]"; |
648 | |
603 | |
649 | sub unblock_sub(&) { |
604 | sub unblock_sub(&) { |
650 | my $cb = shift; |
605 | my $cb = shift; |
651 | |
606 | |
652 | sub { |
607 | sub { |
653 | unshift @unblock_queue, [$cb, @_]; |
608 | unshift @unblock_queue, [$cb, @_]; |
654 | $unblock_scheduler->ready; |
609 | $unblock_scheduler->ready; |
655 | } |
610 | } |
656 | } |
611 | } |
657 | |
612 | |
|
|
613 | =item $cb = Coro::rouse_cb |
|
|
614 | |
|
|
615 | Create and return a "rouse callback". That's a code reference that, |
|
|
616 | when called, will remember a copy of its arguments and notify the owner |
|
|
617 | coroutine of the callback. |
|
|
618 | |
|
|
619 | See the next function. |
|
|
620 | |
|
|
621 | =item @args = Coro::rouse_wait [$cb] |
|
|
622 | |
|
|
623 | Wait for the specified rouse callback (or the last one that was created in |
|
|
624 | this coroutine). |
|
|
625 | |
|
|
626 | As soon as the callback is invoked (or when the callback was invoked |
|
|
627 | before C<rouse_wait>), it will return the arguments originally passed to |
|
|
628 | the rouse callback. |
|
|
629 | |
|
|
630 | See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. |
|
|
631 | |
658 | =back |
632 | =back |
659 | |
633 | |
660 | =cut |
634 | =cut |
661 | |
635 | |
662 | 1; |
636 | 1; |
663 | |
637 | |
|
|
638 | =head1 HOW TO WAIT FOR A CALLBACK |
|
|
639 | |
|
|
640 | It is very common for a coroutine to wait for some callback to be |
|
|
641 | called. This occurs naturally when you use coroutines in an otherwise |
|
|
642 | event-based program, or when you use event-based libraries. |
|
|
643 | |
|
|
644 | These typically register a callback for some event, and call that callback |
|
|
645 | when the event occured. In a coroutine, however, you typically want to |
|
|
646 | just wait for the event, simplyifying things. |
|
|
647 | |
|
|
648 | For example C<< AnyEvent->child >> registers a callback to be called when |
|
|
649 | a specific child has exited: |
|
|
650 | |
|
|
651 | my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... }); |
|
|
652 | |
|
|
653 | But from withina coroutine, you often just want to write this: |
|
|
654 | |
|
|
655 | my $status = wait_for_child $pid; |
|
|
656 | |
|
|
657 | Coro offers two functions specifically designed to make this easy, |
|
|
658 | C<Coro::rouse_cb> and C<Coro::rouse_wait>. |
|
|
659 | |
|
|
660 | The first function, C<rouse_cb>, generates and returns a callback that, |
|
|
661 | when invoked, will save its arguments and notify the coroutine that |
|
|
662 | created the callback. |
|
|
663 | |
|
|
664 | The second function, C<rouse_wait>, waits for the callback to be called |
|
|
665 | (by calling C<schedule> to go to sleep) and returns the arguments |
|
|
666 | originally passed to the callback. |
|
|
667 | |
|
|
668 | Using these functions, it becomes easy to write the C<wait_for_child> |
|
|
669 | function mentioned above: |
|
|
670 | |
|
|
671 | sub wait_for_child($) { |
|
|
672 | my ($pid) = @_; |
|
|
673 | |
|
|
674 | my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb); |
|
|
675 | |
|
|
676 | my ($rpid, $rstatus) = Coro::rouse_wait; |
|
|
677 | $rstatus |
|
|
678 | } |
|
|
679 | |
|
|
680 | In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough, |
|
|
681 | you can roll your own, using C<schedule>: |
|
|
682 | |
|
|
683 | sub wait_for_child($) { |
|
|
684 | my ($pid) = @_; |
|
|
685 | |
|
|
686 | # store the current coroutine in $current, |
|
|
687 | # and provide result variables for the closure passed to ->child |
|
|
688 | my $current = $Coro::current; |
|
|
689 | my ($done, $rstatus); |
|
|
690 | |
|
|
691 | # pass a closure to ->child |
|
|
692 | my $watcher = AnyEvent->child (pid => $pid, cb => sub { |
|
|
693 | $rstatus = $_[1]; # remember rstatus |
|
|
694 | $done = 1; # mark $rstatus as valud |
|
|
695 | }); |
|
|
696 | |
|
|
697 | # wait until the closure has been called |
|
|
698 | schedule while !$done; |
|
|
699 | |
|
|
700 | $rstatus |
|
|
701 | } |
|
|
702 | |
|
|
703 | |
664 | =head1 BUGS/LIMITATIONS |
704 | =head1 BUGS/LIMITATIONS |
665 | |
705 | |
|
|
706 | =over 4 |
|
|
707 | |
|
|
708 | =item fork with pthread backend |
|
|
709 | |
|
|
710 | When Coro is compiled using the pthread backend (which isn't recommended |
|
|
711 | but required on many BSDs as their libcs are completely broken), then |
|
|
712 | coroutines will not survive a fork. There is no known workaround except to |
|
|
713 | fix your libc and use a saner backend. |
|
|
714 | |
|
|
715 | =item perl process emulation ("threads") |
|
|
716 | |
666 | This module is not perl-pseudo-thread-safe. You should only ever use this |
717 | This module is not perl-pseudo-thread-safe. You should only ever use this |
667 | module from the same thread (this requirement might be removed in the |
718 | module from the first thread (this requirement might be removed in the |
668 | future to allow per-thread schedulers, but Coro::State does not yet allow |
719 | future to allow per-thread schedulers, but Coro::State does not yet allow |
669 | this). I recommend disabling thread support and using processes, as this |
720 | this). I recommend disabling thread support and using processes, as having |
670 | is much faster and uses less memory. |
721 | the windows process emulation enabled under unix roughly halves perl |
|
|
722 | performance, even when not used. |
|
|
723 | |
|
|
724 | =item coroutine switching not signal safe |
|
|
725 | |
|
|
726 | You must not switch to another coroutine from within a signal handler |
|
|
727 | (only relevant with %SIG - most event libraries provide safe signals). |
|
|
728 | |
|
|
729 | That means you I<MUST NOT> call any function that might "block" the |
|
|
730 | current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
|
|
731 | anything that calls those. Everything else, including calling C<ready>, |
|
|
732 | works. |
|
|
733 | |
|
|
734 | =back |
|
|
735 | |
671 | |
736 | |
672 | =head1 SEE ALSO |
737 | =head1 SEE ALSO |
673 | |
738 | |
674 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
739 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
675 | |
740 | |
676 | Debugging: L<Coro::Debug>. |
741 | Debugging: L<Coro::Debug>. |
677 | |
742 | |
678 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
743 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
679 | |
744 | |
680 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
745 | Locking and IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, |
|
|
746 | L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
681 | |
747 | |
682 | IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>. |
748 | I/O and Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>. |
683 | |
749 | |
684 | Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>. |
750 | Compatibility with other modules: L<Coro::LWP> (but see also L<AnyEvent::HTTP> for |
|
|
751 | a better-working alternative), L<Coro::BDB>, L<Coro::Storable>, |
|
|
752 | L<Coro::Select>. |
685 | |
753 | |
686 | XS API: L<Coro::MakeMaker>. |
754 | XS API: L<Coro::MakeMaker>. |
687 | |
755 | |
688 | Low level Configuration, Coroutine Environment: L<Coro::State>. |
756 | Low level Configuration, Thread Environment, Continuations: L<Coro::State>. |
689 | |
757 | |
690 | =head1 AUTHOR |
758 | =head1 AUTHOR |
691 | |
759 | |
692 | Marc Lehmann <schmorp@schmorp.de> |
760 | Marc Lehmann <schmorp@schmorp.de> |
693 | http://home.schmorp.de/ |
761 | http://home.schmorp.de/ |