… | |
… | |
16 | cede; # yield to coro |
16 | cede; # yield to coro |
17 | print "3\n"; |
17 | print "3\n"; |
18 | cede; # and again |
18 | cede; # and again |
19 | |
19 | |
20 | # use locking |
20 | # use locking |
21 | use Coro::Semaphore; |
|
|
22 | my $lock = new Coro::Semaphore; |
21 | my $lock = new Coro::Semaphore; |
23 | my $locked; |
22 | my $locked; |
24 | |
23 | |
25 | $lock->down; |
24 | $lock->down; |
26 | $locked = 1; |
25 | $locked = 1; |
… | |
… | |
40 | points in your program, so locking and parallel access are rarely an |
39 | points in your program, so locking and parallel access are rarely an |
41 | issue, making thread programming much safer and easier than using other |
40 | issue, making thread programming much safer and easier than using other |
42 | thread models. |
41 | thread models. |
43 | |
42 | |
44 | Unlike the so-called "Perl threads" (which are not actually real threads |
43 | Unlike the so-called "Perl threads" (which are not actually real threads |
45 | but only the windows process emulation (see section of same name for more |
44 | but only the windows process emulation (see section of same name for |
46 | details) ported to unix, and as such act as processes), Coro provides |
45 | more details) ported to UNIX, and as such act as processes), Coro |
47 | a full shared address space, which makes communication between threads |
46 | provides a full shared address space, which makes communication between |
48 | very easy. And Coro's threads are fast, too: disabling the Windows |
47 | threads very easy. And coro threads are fast, too: disabling the Windows |
49 | process emulation code in your perl and using Coro can easily result in |
48 | process emulation code in your perl and using Coro can easily result in |
50 | a two to four times speed increase for your programs. A parallel matrix |
49 | a two to four times speed increase for your programs. A parallel matrix |
51 | multiplication benchmark runs over 300 times faster on a single core than |
50 | multiplication benchmark (very communication-intensive) runs over 300 |
52 | perl's pseudo-threads on a quad core using all four cores. |
51 | times faster on a single core than perls pseudo-threads on a quad core |
|
|
52 | using all four cores. |
53 | |
53 | |
54 | Coro achieves that by supporting multiple running interpreters that share |
54 | Coro achieves that by supporting multiple running interpreters that share |
55 | data, which is especially useful to code pseudo-parallel processes and |
55 | data, which is especially useful to code pseudo-parallel processes and |
56 | for event-based programming, such as multiple HTTP-GET requests running |
56 | for event-based programming, such as multiple HTTP-GET requests running |
57 | concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro |
57 | concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro |
… | |
… | |
63 | variables (see L<Coro::State> for more configuration and background info). |
63 | variables (see L<Coro::State> for more configuration and background info). |
64 | |
64 | |
65 | See also the C<SEE ALSO> section at the end of this document - the Coro |
65 | See also the C<SEE ALSO> section at the end of this document - the Coro |
66 | module family is quite large. |
66 | module family is quite large. |
67 | |
67 | |
|
|
68 | =head1 CORO THREAD LIFE CYCLE |
|
|
69 | |
|
|
70 | During the long and exciting (or not) life of a coro thread, it goes |
|
|
71 | through a number of states: |
|
|
72 | |
|
|
73 | =over 4 |
|
|
74 | |
|
|
75 | =item 1. Creation |
|
|
76 | |
|
|
77 | The first thing in the life of a coro thread is it's creation - |
|
|
78 | obviously. The typical way to create a thread is to call the C<async |
|
|
79 | BLOCK> function: |
|
|
80 | |
|
|
81 | async { |
|
|
82 | # thread code goes here |
|
|
83 | }; |
|
|
84 | |
|
|
85 | You can also pass arguments, which are put in C<@_>: |
|
|
86 | |
|
|
87 | async { |
|
|
88 | print $_[1]; # prints 2 |
|
|
89 | } 1, 2, 3; |
|
|
90 | |
|
|
91 | This creates a new coro thread and puts it into the ready queue, meaning |
|
|
92 | it will run as soon as the CPU is free for it. |
|
|
93 | |
|
|
94 | C<async> will return a Coro object - you can store this for future |
|
|
95 | reference or ignore it - a thread that is running, ready to run or waiting |
|
|
96 | for some event is alive on it's own. |
|
|
97 | |
|
|
98 | Another way to create a thread is to call the C<new> constructor with a |
|
|
99 | code-reference: |
|
|
100 | |
|
|
101 | new Coro sub { |
|
|
102 | # thread code goes here |
|
|
103 | }, @optional_arguments; |
|
|
104 | |
|
|
105 | This is quite similar to calling C<async>, but the important difference is |
|
|
106 | that the new thread is not put into the ready queue, so the thread will |
|
|
107 | not run until somebody puts it there. C<async> is, therefore, identical to |
|
|
108 | this sequence: |
|
|
109 | |
|
|
110 | my $coro = new Coro sub { |
|
|
111 | # thread code goes here |
|
|
112 | }; |
|
|
113 | $coro->ready; |
|
|
114 | return $coro; |
|
|
115 | |
|
|
116 | =item 2. Startup |
|
|
117 | |
|
|
118 | When a new coro thread is created, only a copy of the code reference |
|
|
119 | and the arguments are stored, no extra memory for stacks and so on is |
|
|
120 | allocated, keeping the coro thread in a low-memory state. |
|
|
121 | |
|
|
122 | Only when it actually starts executing will all the resources be finally |
|
|
123 | allocated. |
|
|
124 | |
|
|
125 | The optional arguments specified at coro creation are available in C<@_>, |
|
|
126 | similar to function calls. |
|
|
127 | |
|
|
128 | =item 3. Running / Blocking |
|
|
129 | |
|
|
130 | A lot can happen after the coro thread has started running. Quite usually, |
|
|
131 | it will not run to the end in one go (because you could use a function |
|
|
132 | instead), but it will give up the CPU regularly because it waits for |
|
|
133 | external events. |
|
|
134 | |
|
|
135 | As long as a coro thread runs, its Coro object is available in the global |
|
|
136 | variable C<$Coro::current>. |
|
|
137 | |
|
|
138 | The low-level way to give up the CPU is to call the scheduler, which |
|
|
139 | selects a new coro thread to run: |
|
|
140 | |
|
|
141 | Coro::schedule; |
|
|
142 | |
|
|
143 | Since running threads are not in the ready queue, calling the scheduler |
|
|
144 | without doing anything else will block the coro thread forever - you need |
|
|
145 | to arrange either for the coro to put woken up (readied) by some other |
|
|
146 | event or some other thread, or you can put it into the ready queue before |
|
|
147 | scheduling: |
|
|
148 | |
|
|
149 | # this is exactly what Coro::cede does |
|
|
150 | $Coro::current->ready; |
|
|
151 | Coro::schedule; |
|
|
152 | |
|
|
153 | All the higher-level synchronisation methods (Coro::Semaphore, |
|
|
154 | Coro::rouse_*...) are actually implemented via C<< ->ready >> and C<< |
|
|
155 | Coro::schedule >>. |
|
|
156 | |
|
|
157 | While the coro thread is running it also might get assigned a C-level |
|
|
158 | thread, or the C-level thread might be unassigned from it, as the Coro |
|
|
159 | runtime wishes. A C-level thread needs to be assigned when your perl |
|
|
160 | thread calls into some C-level function and that function in turn calls |
|
|
161 | perl and perl then wants to switch coroutines. This happens most often |
|
|
162 | when you run an event loop and block in the callback, or when perl |
|
|
163 | itself calls some function such as C<AUTOLOAD> or methods via the C<tie> |
|
|
164 | mechanism. |
|
|
165 | |
|
|
166 | =item 4. Termination |
|
|
167 | |
|
|
168 | Many threads actually terminate after some time. There are a number of |
|
|
169 | ways to terminate a coro thread, the simplest is returning from the |
|
|
170 | top-level code reference: |
|
|
171 | |
|
|
172 | async { |
|
|
173 | # after returning from here, the coro thread is terminated |
|
|
174 | }; |
|
|
175 | |
|
|
176 | async { |
|
|
177 | return if 0.5 < rand; # terminate a little earlier, maybe |
|
|
178 | print "got a chance to print this\n"; |
|
|
179 | # or here |
|
|
180 | }; |
|
|
181 | |
|
|
182 | Any values returned from the coroutine can be recovered using C<< ->join |
|
|
183 | >>: |
|
|
184 | |
|
|
185 | my $coro = async { |
|
|
186 | "hello, world\n" # return a string |
|
|
187 | }; |
|
|
188 | |
|
|
189 | my $hello_world = $coro->join; |
|
|
190 | |
|
|
191 | print $hello_world; |
|
|
192 | |
|
|
193 | Another way to terminate is to call C<< Coro::terminate >>, which at any |
|
|
194 | subroutine call nesting level: |
|
|
195 | |
|
|
196 | async { |
|
|
197 | Coro::terminate "return value 1", "return value 2"; |
|
|
198 | }; |
|
|
199 | |
|
|
200 | Yet another way is to C<< ->cancel >> (or C<< ->safe_cancel >>) the coro |
|
|
201 | thread from another thread: |
|
|
202 | |
|
|
203 | my $coro = async { |
|
|
204 | exit 1; |
|
|
205 | }; |
|
|
206 | |
|
|
207 | $coro->cancel; # also accepts values for ->join to retrieve |
|
|
208 | |
|
|
209 | Cancellation I<can> be dangerous - it's a bit like calling C<exit> without |
|
|
210 | actually exiting, and might leave C libraries and XS modules in a weird |
|
|
211 | state. Unlike other thread implementations, however, Coro is exceptionally |
|
|
212 | safe with regards to cancellation, as perl will always be in a consistent |
|
|
213 | state, and for those cases where you want to do truly marvellous things |
|
|
214 | with your coro while it is being cancelled - that is, make sure all |
|
|
215 | cleanup code is executed from the thread being cancelled - there is even a |
|
|
216 | C<< ->safe_cancel >> method. |
|
|
217 | |
|
|
218 | So, cancelling a thread that runs in an XS event loop might not be the |
|
|
219 | best idea, but any other combination that deals with perl only (cancelling |
|
|
220 | when a thread is in a C<tie> method or an C<AUTOLOAD> for example) is |
|
|
221 | safe. |
|
|
222 | |
|
|
223 | Last not least, a coro thread object that isn't referenced is C<< |
|
|
224 | ->cancel >>'ed automatically - just like other objects in Perl. This |
|
|
225 | is not such a common case, however - a running thread is referencedy by |
|
|
226 | C<$Coro::current>, a thread ready to run is referenced by the ready queue, |
|
|
227 | a thread waiting on a lock or semaphore is referenced by being in some |
|
|
228 | wait list and so on. But a thread that isn't in any of those queues gets |
|
|
229 | cancelled: |
|
|
230 | |
|
|
231 | async { |
|
|
232 | schedule; # cede to other coros, don't go into the ready queue |
|
|
233 | }; |
|
|
234 | |
|
|
235 | cede; |
|
|
236 | # now the async above is destroyed, as it is not referenced by anything. |
|
|
237 | |
|
|
238 | A slightly embellished example might make it clearer: |
|
|
239 | |
|
|
240 | async { |
|
|
241 | my $guard = Guard::guard { print "destroyed\n" }; |
|
|
242 | schedule while 1; |
|
|
243 | }; |
|
|
244 | |
|
|
245 | cede; |
|
|
246 | |
|
|
247 | Superficially one might not expect any output - since the C<async> |
|
|
248 | implements an endless loop, the C<$guard> will not be cleaned up. However, |
|
|
249 | since the thread object returned by C<async> is not stored anywhere, the |
|
|
250 | thread is initially referenced because it is in the ready queue, when it |
|
|
251 | runs it is referenced by C<$Coro::current>, but when it calls C<schedule>, |
|
|
252 | it gets C<cancel>ed causing the guard object to be destroyed (see the next |
|
|
253 | section), and printing it's message. |
|
|
254 | |
|
|
255 | If this seems a bit drastic, remember that this only happens when nothing |
|
|
256 | references the thread anymore, which means there is no way to further |
|
|
257 | execute it, ever. The only options at this point are leaking the thread, |
|
|
258 | or cleaning it up, which brings us to... |
|
|
259 | |
|
|
260 | =item 5. Cleanup |
|
|
261 | |
|
|
262 | Threads will allocate various resources. Most but not all will be returned |
|
|
263 | when a thread terminates, during clean-up. |
|
|
264 | |
|
|
265 | Cleanup is quite similar to throwing an uncaught exception: perl will |
|
|
266 | work it's way up through all subroutine calls and blocks. On it's way, it |
|
|
267 | will release all C<my> variables, undo all C<local>'s and free any other |
|
|
268 | resources truly local to the thread. |
|
|
269 | |
|
|
270 | So, a common way to free resources is to keep them referenced only by my |
|
|
271 | variables: |
|
|
272 | |
|
|
273 | async { |
|
|
274 | my $big_cache = new Cache ...; |
|
|
275 | }; |
|
|
276 | |
|
|
277 | If there are no other references, then the C<$big_cache> object will be |
|
|
278 | freed when the thread terminates, regardless of how it does so. |
|
|
279 | |
|
|
280 | What it does C<NOT> do is unlock any Coro::Semaphores or similar |
|
|
281 | resources, but that's where the C<guard> methods come in handy: |
|
|
282 | |
|
|
283 | my $sem = new Coro::Semaphore; |
|
|
284 | |
|
|
285 | async { |
|
|
286 | my $lock_guard = $sem->guard; |
|
|
287 | # if we return, or die or get cancelled, here, |
|
|
288 | # then the semaphore will be "up"ed. |
|
|
289 | }; |
|
|
290 | |
|
|
291 | The C<Guard::guard> function comes in handy for any custom cleanup you |
|
|
292 | might want to do (but you cannot switch to other coroutines from those |
|
|
293 | code blocks): |
|
|
294 | |
|
|
295 | async { |
|
|
296 | my $window = new Gtk2::Window "toplevel"; |
|
|
297 | # The window will not be cleaned up automatically, even when $window |
|
|
298 | # gets freed, so use a guard to ensure it's destruction |
|
|
299 | # in case of an error: |
|
|
300 | my $window_guard = Guard::guard { $window->destroy }; |
|
|
301 | |
|
|
302 | # we are safe here |
|
|
303 | }; |
|
|
304 | |
|
|
305 | Last not least, C<local> can often be handy, too, e.g. when temporarily |
|
|
306 | replacing the coro thread description: |
|
|
307 | |
|
|
308 | sub myfunction { |
|
|
309 | local $Coro::current->{desc} = "inside myfunction(@_)"; |
|
|
310 | |
|
|
311 | # if we return or die here, the description will be restored |
|
|
312 | } |
|
|
313 | |
|
|
314 | =item 6. Viva La Zombie Muerte |
|
|
315 | |
|
|
316 | Even after a thread has terminated and cleaned up its resources, the Coro |
|
|
317 | object still is there and stores the return values of the thread. |
|
|
318 | |
|
|
319 | When there are no other references, it will simply be cleaned up and |
|
|
320 | freed. |
|
|
321 | |
|
|
322 | If there areany references, the Coro object will stay around, and you |
|
|
323 | can call C<< ->join >> as many times as you wish to retrieve the result |
|
|
324 | values: |
|
|
325 | |
|
|
326 | async { |
|
|
327 | print "hi\n"; |
|
|
328 | 1 |
|
|
329 | }; |
|
|
330 | |
|
|
331 | # run the async above, and free everything before returning |
|
|
332 | # from Coro::cede: |
|
|
333 | Coro::cede; |
|
|
334 | |
|
|
335 | { |
|
|
336 | my $coro = async { |
|
|
337 | print "hi\n"; |
|
|
338 | 1 |
|
|
339 | }; |
|
|
340 | |
|
|
341 | # run the async above, and clean up, but do not free the coro |
|
|
342 | # object: |
|
|
343 | Coro::cede; |
|
|
344 | |
|
|
345 | # optionally retrieve the result values |
|
|
346 | my @results = $coro->join; |
|
|
347 | |
|
|
348 | # now $coro goes out of scope, and presumably gets freed |
|
|
349 | }; |
|
|
350 | |
|
|
351 | =back |
|
|
352 | |
68 | =cut |
353 | =cut |
69 | |
354 | |
70 | package Coro; |
355 | package Coro; |
71 | |
356 | |
72 | use common::sense; |
357 | use common::sense; |
… | |
… | |
81 | |
366 | |
82 | our $idle; # idle handler |
367 | our $idle; # idle handler |
83 | our $main; # main coro |
368 | our $main; # main coro |
84 | our $current; # current coro |
369 | our $current; # current coro |
85 | |
370 | |
86 | our $VERSION = 5.22; |
371 | our $VERSION = 6.51; |
87 | |
372 | |
88 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
373 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
89 | our %EXPORT_TAGS = ( |
374 | our %EXPORT_TAGS = ( |
90 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
375 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
91 | ); |
376 | ); |
… | |
… | |
96 | =over 4 |
381 | =over 4 |
97 | |
382 | |
98 | =item $Coro::main |
383 | =item $Coro::main |
99 | |
384 | |
100 | This variable stores the Coro object that represents the main |
385 | This variable stores the Coro object that represents the main |
101 | program. While you cna C<ready> it and do most other things you can do to |
386 | program. While you can C<ready> it and do most other things you can do to |
102 | coro, it is mainly useful to compare again C<$Coro::current>, to see |
387 | coro, it is mainly useful to compare again C<$Coro::current>, to see |
103 | whether you are running in the main program or not. |
388 | whether you are running in the main program or not. |
104 | |
389 | |
105 | =cut |
390 | =cut |
106 | |
391 | |
… | |
… | |
131 | |
416 | |
132 | The default implementation dies with "FATAL: deadlock detected.", followed |
417 | The default implementation dies with "FATAL: deadlock detected.", followed |
133 | by a thread listing, because the program has no other way to continue. |
418 | by a thread listing, because the program has no other way to continue. |
134 | |
419 | |
135 | This hook is overwritten by modules such as C<Coro::EV> and |
420 | This hook is overwritten by modules such as C<Coro::EV> and |
136 | C<Coro::AnyEvent> to wait on an external event that hopefully wake up a |
421 | C<Coro::AnyEvent> to wait on an external event that hopefully wakes up a |
137 | coro so the scheduler can run it. |
422 | coro so the scheduler can run it. |
138 | |
423 | |
139 | See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. |
424 | See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. |
140 | |
425 | |
141 | =cut |
426 | =cut |
… | |
… | |
152 | our @destroy; |
437 | our @destroy; |
153 | our $manager; |
438 | our $manager; |
154 | |
439 | |
155 | $manager = new Coro sub { |
440 | $manager = new Coro sub { |
156 | while () { |
441 | while () { |
157 | Coro::State::cancel shift @destroy |
442 | _destroy shift @destroy |
158 | while @destroy; |
443 | while @destroy; |
159 | |
444 | |
160 | &schedule; |
445 | &schedule; |
161 | } |
446 | } |
162 | }; |
447 | }; |
… | |
… | |
213 | C<async> does. As the coro is being reused, stuff like C<on_destroy> |
498 | C<async> does. As the coro is being reused, stuff like C<on_destroy> |
214 | will not work in the expected way, unless you call terminate or cancel, |
499 | will not work in the expected way, unless you call terminate or cancel, |
215 | which somehow defeats the purpose of pooling (but is fine in the |
500 | which somehow defeats the purpose of pooling (but is fine in the |
216 | exceptional case). |
501 | exceptional case). |
217 | |
502 | |
218 | The priority will be reset to C<0> after each run, tracing will be |
503 | The priority will be reset to C<0> after each run, all C<swap_sv> calls |
219 | disabled, the description will be reset and the default output filehandle |
504 | will be undone, tracing will be disabled, the description will be reset |
220 | gets restored, so you can change all these. Otherwise the coro will |
505 | and the default output filehandle gets restored, so you can change all |
221 | be re-used "as-is": most notably if you change other per-coro global |
506 | these. Otherwise the coro will be re-used "as-is": most notably if you |
222 | stuff such as C<$/> you I<must needs> revert that change, which is most |
507 | change other per-coro global stuff such as C<$/> you I<must needs> revert |
223 | simply done by using local as in: C<< local $/ >>. |
508 | that change, which is most simply done by using local as in: C<< local $/ |
|
|
509 | >>. |
224 | |
510 | |
225 | The idle pool size is limited to C<8> idle coros (this can be |
511 | The idle pool size is limited to C<8> idle coros (this can be |
226 | adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle |
512 | adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle |
227 | coros as required. |
513 | coros as required. |
228 | |
514 | |
… | |
… | |
296 | coro, regardless of priority. This is useful sometimes to ensure |
582 | coro, regardless of priority. This is useful sometimes to ensure |
297 | progress is made. |
583 | progress is made. |
298 | |
584 | |
299 | =item terminate [arg...] |
585 | =item terminate [arg...] |
300 | |
586 | |
301 | Terminates the current coro with the given status values (see L<cancel>). |
587 | Terminates the current coro with the given status values (see |
|
|
588 | L<cancel>). The values will not be copied, but referenced directly. |
302 | |
589 | |
303 | =item Coro::on_enter BLOCK, Coro::on_leave BLOCK |
590 | =item Coro::on_enter BLOCK, Coro::on_leave BLOCK |
304 | |
591 | |
305 | These function install enter and leave winders in the current scope. The |
592 | These function install enter and leave winders in the current scope. The |
306 | enter block will be executed when on_enter is called and whenever the |
593 | enter block will be executed when on_enter is called and whenever the |
… | |
… | |
366 | Coro::on_enter { |
653 | Coro::on_enter { |
367 | # on entering the thread, we set an VTALRM handler to cede |
654 | # on entering the thread, we set an VTALRM handler to cede |
368 | $SIG{VTALRM} = sub { cede }; |
655 | $SIG{VTALRM} = sub { cede }; |
369 | # and then start the interval timer |
656 | # and then start the interval timer |
370 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01; |
657 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01; |
371 | }; |
658 | }; |
372 | Coro::on_leave { |
659 | Coro::on_leave { |
373 | # on leaving the thread, we stop the interval timer again |
660 | # on leaving the thread, we stop the interval timer again |
374 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0; |
661 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0; |
375 | }; |
662 | }; |
376 | |
663 | |
377 | &{+shift}; |
664 | &{+shift}; |
378 | } |
665 | } |
379 | |
666 | |
380 | # use like this: |
667 | # use like this: |
381 | timeslice { |
668 | timeslice { |
382 | # The following is an endless loop that would normally |
669 | # The following is an endless loop that would normally |
383 | # monopolise the process. Since it runs in a timesliced |
670 | # monopolise the process. Since it runs in a timesliced |
384 | # environment, it will regularly cede to other threads. |
671 | # environment, it will regularly cede to other threads. |
385 | while () { } |
672 | while () { } |
386 | }; |
673 | }; |
387 | |
674 | |
388 | |
675 | |
389 | =item killall |
676 | =item killall |
390 | |
677 | |
391 | Kills/terminates/cancels all coros except the currently running one. |
678 | Kills/terminates/cancels all coros except the currently running one. |
… | |
… | |
462 | To avoid this, it is best to put a suspended coro into the ready queue |
749 | To avoid this, it is best to put a suspended coro into the ready queue |
463 | unconditionally, as every synchronisation mechanism must protect itself |
750 | unconditionally, as every synchronisation mechanism must protect itself |
464 | against spurious wakeups, and the one in the Coro family certainly do |
751 | against spurious wakeups, and the one in the Coro family certainly do |
465 | that. |
752 | that. |
466 | |
753 | |
|
|
754 | =item $state->is_new |
|
|
755 | |
|
|
756 | Returns true iff this Coro object is "new", i.e. has never been run |
|
|
757 | yet. Those states basically consist of only the code reference to call and |
|
|
758 | the arguments, but consumes very little other resources. New states will |
|
|
759 | automatically get assigned a perl interpreter when they are transfered to. |
|
|
760 | |
|
|
761 | =item $state->is_zombie |
|
|
762 | |
|
|
763 | Returns true iff the Coro object has been cancelled, i.e. |
|
|
764 | it's resources freed because they were C<cancel>'ed, C<terminate>'d, |
|
|
765 | C<safe_cancel>'ed or simply went out of scope. |
|
|
766 | |
|
|
767 | The name "zombie" stems from UNIX culture, where a process that has |
|
|
768 | exited and only stores and exit status and no other resources is called a |
|
|
769 | "zombie". |
|
|
770 | |
467 | =item $is_ready = $coro->is_ready |
771 | =item $is_ready = $coro->is_ready |
468 | |
772 | |
469 | Returns true iff the Coro object is in the ready queue. Unless the Coro |
773 | Returns true iff the Coro object is in the ready queue. Unless the Coro |
470 | object gets destroyed, it will eventually be scheduled by the scheduler. |
774 | object gets destroyed, it will eventually be scheduled by the scheduler. |
471 | |
775 | |
… | |
… | |
480 | Returns true iff this Coro object has been suspended. Suspended Coros will |
784 | Returns true iff this Coro object has been suspended. Suspended Coros will |
481 | not ever be scheduled. |
785 | not ever be scheduled. |
482 | |
786 | |
483 | =item $coro->cancel (arg...) |
787 | =item $coro->cancel (arg...) |
484 | |
788 | |
485 | Terminates the given Coro and makes it return the given arguments as |
789 | Terminates the given Coro thread and makes it return the given arguments as |
486 | status (default: the empty list). Never returns if the Coro is the |
790 | status (default: an empty list). Never returns if the Coro is the |
487 | current Coro. |
791 | current Coro. |
488 | |
792 | |
489 | =cut |
793 | This is a rather brutal way to free a coro, with some limitations - if |
|
|
794 | the thread is inside a C callback that doesn't expect to be canceled, |
|
|
795 | bad things can happen, or if the cancelled thread insists on running |
|
|
796 | complicated cleanup handlers that rely on its thread context, things will |
|
|
797 | not work. |
490 | |
798 | |
491 | sub cancel { |
799 | Any cleanup code being run (e.g. from C<guard> blocks, destructors and so |
492 | my $self = shift; |
800 | on) will be run without a thread context, and is not allowed to switch |
|
|
801 | to other threads. A common mistake is to call C<< ->cancel >> from a |
|
|
802 | destructor called by die'ing inside the thread to be cancelled for |
|
|
803 | example. |
493 | |
804 | |
494 | if ($current == $self) { |
805 | On the plus side, C<< ->cancel >> will always clean up the thread, no |
495 | terminate @_; |
806 | matter what. If your cleanup code is complex or you want to avoid |
496 | } else { |
807 | cancelling a C-thread that doesn't know how to clean up itself, it can be |
497 | $self->{_status} = [@_]; |
808 | better to C<< ->throw >> an exception, or use C<< ->safe_cancel >>. |
498 | Coro::State::cancel $self; |
809 | |
|
|
810 | The arguments to C<< ->cancel >> are not copied, but instead will |
|
|
811 | be referenced directly (e.g. if you pass C<$var> and after the call |
|
|
812 | change that variable, then you might change the return values passed to |
|
|
813 | e.g. C<join>, so don't do that). |
|
|
814 | |
|
|
815 | The resources of the Coro are usually freed (or destructed) before this |
|
|
816 | call returns, but this can be delayed for an indefinite amount of time, as |
|
|
817 | in some cases the manager thread has to run first to actually destruct the |
|
|
818 | Coro object. |
|
|
819 | |
|
|
820 | =item $coro->safe_cancel ($arg...) |
|
|
821 | |
|
|
822 | Works mostly like C<< ->cancel >>, but is inherently "safer", and |
|
|
823 | consequently, can fail with an exception in cases the thread is not in a |
|
|
824 | cancellable state. Essentially, C<< ->safe_cancel >> is a C<< ->cancel >> |
|
|
825 | with extra checks before canceling. |
|
|
826 | |
|
|
827 | It works a bit like throwing an exception that cannot be caught - |
|
|
828 | specifically, it will clean up the thread from within itself, so all |
|
|
829 | cleanup handlers (e.g. C<guard> blocks) are run with full thread |
|
|
830 | context and can block if they wish. The downside is that there is no |
|
|
831 | guarantee that the thread can be cancelled when you call this method, and |
|
|
832 | therefore, it might fail. It is also considerably slower than C<cancel> or |
|
|
833 | C<terminate>. |
|
|
834 | |
|
|
835 | A thread is in a safe-cancellable state if it either hasn't been run yet, |
|
|
836 | or it has no C context attached and is inside an SLF function. |
|
|
837 | |
|
|
838 | The latter two basically mean that the thread isn't currently inside a |
|
|
839 | perl callback called from some C function (usually via some XS modules) |
|
|
840 | and isn't currently executing inside some C function itself (via Coro's XS |
|
|
841 | API). |
|
|
842 | |
|
|
843 | This call returns true when it could cancel the thread, or croaks with an |
|
|
844 | error otherwise (i.e. it either returns true or doesn't return at all). |
|
|
845 | |
|
|
846 | Why the weird interface? Well, there are two common models on how and |
|
|
847 | when to cancel things. In the first, you have the expectation that your |
|
|
848 | coro thread can be cancelled when you want to cancel it - if the thread |
|
|
849 | isn't cancellable, this would be a bug somewhere, so C<< ->safe_cancel >> |
|
|
850 | croaks to notify of the bug. |
|
|
851 | |
|
|
852 | In the second model you sometimes want to ask nicely to cancel a thread, |
|
|
853 | but if it's not a good time, well, then don't cancel. This can be done |
|
|
854 | relatively easy like this: |
|
|
855 | |
|
|
856 | if (! eval { $coro->safe_cancel }) { |
|
|
857 | warn "unable to cancel thread: $@"; |
499 | } |
858 | } |
500 | } |
859 | |
|
|
860 | However, what you never should do is first try to cancel "safely" and |
|
|
861 | if that fails, cancel the "hard" way with C<< ->cancel >>. That makes |
|
|
862 | no sense: either you rely on being able to execute cleanup code in your |
|
|
863 | thread context, or you don't. If you do, then C<< ->safe_cancel >> is the |
|
|
864 | only way, and if you don't, then C<< ->cancel >> is always faster and more |
|
|
865 | direct. |
501 | |
866 | |
502 | =item $coro->schedule_to |
867 | =item $coro->schedule_to |
503 | |
868 | |
504 | Puts the current coro to sleep (like C<Coro::schedule>), but instead |
869 | Puts the current coro to sleep (like C<Coro::schedule>), but instead |
505 | of continuing with the next coro from the ready queue, always switch to |
870 | of continuing with the next coro from the ready queue, always switch to |
… | |
… | |
524 | inside the coro at the next convenient point in time. Otherwise |
889 | inside the coro at the next convenient point in time. Otherwise |
525 | clears the exception object. |
890 | clears the exception object. |
526 | |
891 | |
527 | Coro will check for the exception each time a schedule-like-function |
892 | Coro will check for the exception each time a schedule-like-function |
528 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
893 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
529 | >>, C<< Coro::Handle->readable >> and so on. Most of these functions |
894 | >>, C<< Coro::Handle->readable >> and so on. Most of those functions (all |
530 | detect this case and return early in case an exception is pending. |
895 | that are part of Coro itself) detect this case and return early in case an |
|
|
896 | exception is pending. |
531 | |
897 | |
532 | The exception object will be thrown "as is" with the specified scalar in |
898 | The exception object will be thrown "as is" with the specified scalar in |
533 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
899 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
534 | (unlike with C<die>). |
900 | (unlike with C<die>). |
535 | |
901 | |
536 | This can be used as a softer means than C<cancel> to ask a coro to |
902 | This can be used as a softer means than either C<cancel> or C<safe_cancel |
537 | end itself, although there is no guarantee that the exception will lead to |
903 | >to ask a coro to end itself, although there is no guarantee that the |
538 | termination, and if the exception isn't caught it might well end the whole |
904 | exception will lead to termination, and if the exception isn't caught it |
539 | program. |
905 | might well end the whole program. |
540 | |
906 | |
541 | You might also think of C<throw> as being the moral equivalent of |
907 | You might also think of C<throw> as being the moral equivalent of |
542 | C<kill>ing a coro with a signal (in this case, a scalar). |
908 | C<kill>ing a coro with a signal (in this case, a scalar). |
543 | |
909 | |
544 | =item $coro->join |
910 | =item $coro->join |
545 | |
911 | |
546 | Wait until the coro terminates and return any values given to the |
912 | Wait until the coro terminates and return any values given to the |
547 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
913 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
548 | from multiple coro, and all will be resumed and given the status |
914 | from multiple threads, and all will be resumed and given the status |
549 | return once the C<$coro> terminates. |
915 | return once the C<$coro> terminates. |
550 | |
916 | |
551 | =cut |
|
|
552 | |
|
|
553 | sub join { |
|
|
554 | my $self = shift; |
|
|
555 | |
|
|
556 | unless ($self->{_status}) { |
|
|
557 | my $current = $current; |
|
|
558 | |
|
|
559 | push @{$self->{_on_destroy}}, sub { |
|
|
560 | $current->ready; |
|
|
561 | undef $current; |
|
|
562 | }; |
|
|
563 | |
|
|
564 | &schedule while $current; |
|
|
565 | } |
|
|
566 | |
|
|
567 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
|
|
568 | } |
|
|
569 | |
|
|
570 | =item $coro->on_destroy (\&cb) |
917 | =item $coro->on_destroy (\&cb) |
571 | |
918 | |
572 | Registers a callback that is called when this coro gets destroyed, |
919 | Registers a callback that is called when this coro thread gets destroyed, |
573 | but before it is joined. The callback gets passed the terminate arguments, |
920 | that is, after it's resources have been freed but before it is joined. The |
|
|
921 | callback gets passed the terminate/cancel arguments, if any, and I<must |
574 | if any, and I<must not> die, under any circumstances. |
922 | not> die, under any circumstances. |
575 | |
923 | |
576 | =cut |
924 | There can be any number of C<on_destroy> callbacks per coro, and there is |
577 | |
925 | currently no way to remove a callback once added. |
578 | sub on_destroy { |
|
|
579 | my ($self, $cb) = @_; |
|
|
580 | |
|
|
581 | push @{ $self->{_on_destroy} }, $cb; |
|
|
582 | } |
|
|
583 | |
926 | |
584 | =item $oldprio = $coro->prio ($newprio) |
927 | =item $oldprio = $coro->prio ($newprio) |
585 | |
928 | |
586 | Sets (or gets, if the argument is missing) the priority of the |
929 | Sets (or gets, if the argument is missing) the priority of the |
587 | coro. Higher priority coro get run before lower priority |
930 | coro thread. Higher priority coro get run before lower priority |
588 | coro. Priorities are small signed integers (currently -4 .. +3), |
931 | coros. Priorities are small signed integers (currently -4 .. +3), |
589 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
932 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
590 | to get then): |
933 | to get then): |
591 | |
934 | |
592 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
935 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
593 | 3 > 1 > 0 > -1 > -3 > -4 |
936 | 3 > 1 > 0 > -1 > -3 > -4 |
594 | |
937 | |
595 | # set priority to HIGH |
938 | # set priority to HIGH |
596 | current->prio (PRIO_HIGH); |
939 | current->prio (PRIO_HIGH); |
597 | |
940 | |
598 | The idle coro ($Coro::idle) always has a lower priority than any |
941 | The idle coro thread ($Coro::idle) always has a lower priority than any |
599 | existing coro. |
942 | existing coro. |
600 | |
943 | |
601 | Changing the priority of the current coro will take effect immediately, |
944 | Changing the priority of the current coro will take effect immediately, |
602 | but changing the priority of coro in the ready queue (but not |
945 | but changing the priority of a coro in the ready queue (but not running) |
603 | running) will only take effect after the next schedule (of that |
946 | will only take effect after the next schedule (of that coro). This is a |
604 | coro). This is a bug that will be fixed in some future version. |
947 | bug that will be fixed in some future version. |
605 | |
948 | |
606 | =item $newprio = $coro->nice ($change) |
949 | =item $newprio = $coro->nice ($change) |
607 | |
950 | |
608 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
951 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
609 | higher values mean lower priority, just as in unix). |
952 | higher values mean lower priority, just as in UNIX's nice command). |
610 | |
953 | |
611 | =item $olddesc = $coro->desc ($newdesc) |
954 | =item $olddesc = $coro->desc ($newdesc) |
612 | |
955 | |
613 | Sets (or gets in case the argument is missing) the description for this |
956 | Sets (or gets in case the argument is missing) the description for this |
614 | coro. This is just a free-form string you can associate with a |
957 | coro thread. This is just a free-form string you can associate with a |
615 | coro. |
958 | coro. |
616 | |
959 | |
617 | This method simply sets the C<< $coro->{desc} >> member to the given |
960 | This method simply sets the C<< $coro->{desc} >> member to the given |
618 | string. You can modify this member directly if you wish. |
961 | string. You can modify this member directly if you wish, and in fact, this |
|
|
962 | is often preferred to indicate major processing states that can then be |
|
|
963 | seen for example in a L<Coro::Debug> session: |
|
|
964 | |
|
|
965 | sub my_long_function { |
|
|
966 | local $Coro::current->{desc} = "now in my_long_function"; |
|
|
967 | ... |
|
|
968 | $Coro::current->{desc} = "my_long_function: phase 1"; |
|
|
969 | ... |
|
|
970 | $Coro::current->{desc} = "my_long_function: phase 2"; |
|
|
971 | ... |
|
|
972 | } |
619 | |
973 | |
620 | =cut |
974 | =cut |
621 | |
975 | |
622 | sub desc { |
976 | sub desc { |
623 | my $old = $_[0]{desc}; |
977 | my $old = $_[0]{desc}; |
… | |
… | |
660 | returning a new coderef. Unblocking means that calling the new coderef |
1014 | returning a new coderef. Unblocking means that calling the new coderef |
661 | will return immediately without blocking, returning nothing, while the |
1015 | will return immediately without blocking, returning nothing, while the |
662 | original code ref will be called (with parameters) from within another |
1016 | original code ref will be called (with parameters) from within another |
663 | coro. |
1017 | coro. |
664 | |
1018 | |
665 | The reason this function exists is that many event libraries (such as the |
1019 | The reason this function exists is that many event libraries (such as |
666 | venerable L<Event|Event> module) are not thread-safe (a weaker form |
1020 | the venerable L<Event|Event> module) are not thread-safe (a weaker form |
667 | of reentrancy). This means you must not block within event callbacks, |
1021 | of reentrancy). This means you must not block within event callbacks, |
668 | otherwise you might suffer from crashes or worse. The only event library |
1022 | otherwise you might suffer from crashes or worse. The only event library |
669 | currently known that is safe to use without C<unblock_sub> is L<EV>. |
1023 | currently known that is safe to use without C<unblock_sub> is L<EV> (but |
|
|
1024 | you might still run into deadlocks if all event loops are blocked). |
670 | |
1025 | |
671 | Coro will try to catch you when you block in the event loop |
1026 | Coro will try to catch you when you block in the event loop |
672 | ("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and |
1027 | ("FATAL: $Coro::idle blocked itself"), but this is just best effort and |
673 | only works when you do not run your own event loop. |
1028 | only works when you do not run your own event loop. |
674 | |
1029 | |
675 | This function allows your callbacks to block by executing them in another |
1030 | This function allows your callbacks to block by executing them in another |
676 | coro where it is safe to block. One example where blocking is handy |
1031 | coro where it is safe to block. One example where blocking is handy |
677 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
1032 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
… | |
… | |
745 | |
1100 | |
746 | =back |
1101 | =back |
747 | |
1102 | |
748 | =cut |
1103 | =cut |
749 | |
1104 | |
|
|
1105 | for my $module (qw(Channel RWLock Semaphore SemaphoreSet Signal Specific)) { |
|
|
1106 | my $old = defined &{"Coro::$module\::new"} && \&{"Coro::$module\::new"}; |
|
|
1107 | |
|
|
1108 | *{"Coro::$module\::new"} = sub { |
|
|
1109 | require "Coro/$module.pm"; |
|
|
1110 | |
|
|
1111 | # some modules have their new predefined in State.xs, some don't |
|
|
1112 | *{"Coro::$module\::new"} = $old |
|
|
1113 | if $old; |
|
|
1114 | |
|
|
1115 | goto &{"Coro::$module\::new"}; |
|
|
1116 | }; |
|
|
1117 | } |
|
|
1118 | |
750 | 1; |
1119 | 1; |
751 | |
1120 | |
752 | =head1 HOW TO WAIT FOR A CALLBACK |
1121 | =head1 HOW TO WAIT FOR A CALLBACK |
753 | |
1122 | |
754 | It is very common for a coro to wait for some callback to be |
1123 | It is very common for a coro to wait for some callback to be |
… | |
… | |
767 | But from within a coro, you often just want to write this: |
1136 | But from within a coro, you often just want to write this: |
768 | |
1137 | |
769 | my $status = wait_for_child $pid; |
1138 | my $status = wait_for_child $pid; |
770 | |
1139 | |
771 | Coro offers two functions specifically designed to make this easy, |
1140 | Coro offers two functions specifically designed to make this easy, |
772 | C<Coro::rouse_cb> and C<Coro::rouse_wait>. |
1141 | C<rouse_cb> and C<rouse_wait>. |
773 | |
1142 | |
774 | The first function, C<rouse_cb>, generates and returns a callback that, |
1143 | The first function, C<rouse_cb>, generates and returns a callback that, |
775 | when invoked, will save its arguments and notify the coro that |
1144 | when invoked, will save its arguments and notify the coro that |
776 | created the callback. |
1145 | created the callback. |
777 | |
1146 | |
… | |
… | |
783 | function mentioned above: |
1152 | function mentioned above: |
784 | |
1153 | |
785 | sub wait_for_child($) { |
1154 | sub wait_for_child($) { |
786 | my ($pid) = @_; |
1155 | my ($pid) = @_; |
787 | |
1156 | |
788 | my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb); |
1157 | my $watcher = AnyEvent->child (pid => $pid, cb => rouse_cb); |
789 | |
1158 | |
790 | my ($rpid, $rstatus) = Coro::rouse_wait; |
1159 | my ($rpid, $rstatus) = rouse_wait; |
791 | $rstatus |
1160 | $rstatus |
792 | } |
1161 | } |
793 | |
1162 | |
794 | In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough, |
1163 | In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough, |
795 | you can roll your own, using C<schedule>: |
1164 | you can roll your own, using C<schedule> and C<ready>: |
796 | |
1165 | |
797 | sub wait_for_child($) { |
1166 | sub wait_for_child($) { |
798 | my ($pid) = @_; |
1167 | my ($pid) = @_; |
799 | |
1168 | |
800 | # store the current coro in $current, |
1169 | # store the current coro in $current, |
… | |
… | |
803 | my ($done, $rstatus); |
1172 | my ($done, $rstatus); |
804 | |
1173 | |
805 | # pass a closure to ->child |
1174 | # pass a closure to ->child |
806 | my $watcher = AnyEvent->child (pid => $pid, cb => sub { |
1175 | my $watcher = AnyEvent->child (pid => $pid, cb => sub { |
807 | $rstatus = $_[1]; # remember rstatus |
1176 | $rstatus = $_[1]; # remember rstatus |
808 | $done = 1; # mark $rstatus as valud |
1177 | $done = 1; # mark $rstatus as valid |
|
|
1178 | $current->ready; # wake up the waiting thread |
809 | }); |
1179 | }); |
810 | |
1180 | |
811 | # wait until the closure has been called |
1181 | # wait until the closure has been called |
812 | schedule while !$done; |
1182 | schedule while !$done; |
813 | |
1183 | |
… | |
… | |
833 | future to allow per-thread schedulers, but Coro::State does not yet allow |
1203 | future to allow per-thread schedulers, but Coro::State does not yet allow |
834 | this). I recommend disabling thread support and using processes, as having |
1204 | this). I recommend disabling thread support and using processes, as having |
835 | the windows process emulation enabled under unix roughly halves perl |
1205 | the windows process emulation enabled under unix roughly halves perl |
836 | performance, even when not used. |
1206 | performance, even when not used. |
837 | |
1207 | |
|
|
1208 | Attempts to use threads created in another emulated process will crash |
|
|
1209 | ("cleanly", with a null pointer exception). |
|
|
1210 | |
838 | =item coro switching is not signal safe |
1211 | =item coro switching is not signal safe |
839 | |
1212 | |
840 | You must not switch to another coro from within a signal handler (only |
1213 | You must not switch to another coro from within a signal handler (only |
841 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
1214 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
842 | you are sure you are not interrupting a Coro function. |
1215 | you are sure you are not interrupting a Coro function. |
… | |
… | |
857 | ithreads (for example, that memory or files would be shared), showing his |
1230 | ithreads (for example, that memory or files would be shared), showing his |
858 | lack of understanding of this area - if it is hard to understand for Chip, |
1231 | lack of understanding of this area - if it is hard to understand for Chip, |
859 | it is probably not obvious to everybody). |
1232 | it is probably not obvious to everybody). |
860 | |
1233 | |
861 | What follows is an ultra-condensed version of my talk about threads in |
1234 | What follows is an ultra-condensed version of my talk about threads in |
862 | scripting languages given onthe perl workshop 2009: |
1235 | scripting languages given on the perl workshop 2009: |
863 | |
1236 | |
864 | The so-called "ithreads" were originally implemented for two reasons: |
1237 | The so-called "ithreads" were originally implemented for two reasons: |
865 | first, to (badly) emulate unix processes on native win32 perls, and |
1238 | first, to (badly) emulate unix processes on native win32 perls, and |
866 | secondly, to replace the older, real thread model ("5.005-threads"). |
1239 | secondly, to replace the older, real thread model ("5.005-threads"). |
867 | |
1240 | |
… | |
… | |
929 | |
1302 | |
930 | XS API: L<Coro::MakeMaker>. |
1303 | XS API: L<Coro::MakeMaker>. |
931 | |
1304 | |
932 | Low level Configuration, Thread Environment, Continuations: L<Coro::State>. |
1305 | Low level Configuration, Thread Environment, Continuations: L<Coro::State>. |
933 | |
1306 | |
934 | =head1 AUTHOR |
1307 | =head1 AUTHOR/SUPPORT/CONTACT |
935 | |
1308 | |
936 | Marc Lehmann <schmorp@schmorp.de> |
1309 | Marc A. Lehmann <schmorp@schmorp.de> |
937 | http://home.schmorp.de/ |
1310 | http://software.schmorp.de/pkg/Coro.html |
938 | |
1311 | |
939 | =cut |
1312 | =cut |
940 | |
1313 | |