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