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 | |
9 | async { |
9 | async { |
10 | # some asynchronous thread of execution |
10 | # some asynchronous thread of execution |
|
|
11 | print "2\n"; |
|
|
12 | cede; # yield back to main |
|
|
13 | print "4\n"; |
11 | }; |
14 | }; |
12 | |
15 | print "1\n"; |
13 | # alternatively create an async process like this: |
16 | cede; # yield to coro |
14 | |
17 | print "3\n"; |
15 | sub some_func : Coro { |
18 | cede; # and again |
16 | # some more async code |
19 | |
17 | } |
20 | # use locking |
18 | |
21 | use Coro::Semaphore; |
19 | cede; |
22 | my $lock = new Coro::Semaphore; |
|
|
23 | my $locked; |
|
|
24 | |
|
|
25 | $lock->down; |
|
|
26 | $locked = 1; |
|
|
27 | $lock->up; |
20 | |
28 | |
21 | =head1 DESCRIPTION |
29 | =head1 DESCRIPTION |
22 | |
30 | |
23 | This module collection manages coroutines. Coroutines are similar to |
31 | For a tutorial-style introduction, please read the L<Coro::Intro> |
24 | threads but don't run in parallel. |
32 | manpage. This manpage mainly contains reference information. |
25 | |
33 | |
|
|
34 | This module collection manages continuations in general, most often in |
|
|
35 | the form of cooperative threads (also called coros, or simply "coro" |
|
|
36 | in the documentation). They are similar to kernel threads but don't (in |
|
|
37 | general) run in parallel at the same time even on SMP machines. The |
|
|
38 | specific flavor of thread offered by this module also guarantees you that |
|
|
39 | it will not switch between threads unless necessary, at easily-identified |
|
|
40 | points in your program, so locking and parallel access are rarely an |
|
|
41 | issue, making thread programming much safer and easier than using other |
|
|
42 | thread models. |
|
|
43 | |
|
|
44 | 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 |
|
|
46 | more details) ported to UNIX, and as such act as processes), Coro |
|
|
47 | provides a full shared address space, which makes communication between |
|
|
48 | 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 |
|
|
50 | a two to four times speed increase for your programs. A parallel matrix |
|
|
51 | multiplication benchmark (very communication-intensive) runs over 300 |
|
|
52 | times faster on a single core than perls pseudo-threads on a quad core |
|
|
53 | using all four cores. |
|
|
54 | |
|
|
55 | Coro achieves that by supporting multiple running interpreters that share |
|
|
56 | data, which is especially useful to code pseudo-parallel processes and |
|
|
57 | for event-based programming, such as multiple HTTP-GET requests running |
|
|
58 | concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro |
|
|
59 | into an event-based environment. |
|
|
60 | |
26 | In this module, coroutines are defined as "callchain + lexical variables |
61 | In this module, a thread is defined as "callchain + lexical variables + |
27 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
62 | some package variables + C stack), that is, a thread has its own callchain, |
28 | callchain, it's own set of lexicals and it's own set of perl's most |
63 | its own set of lexicals and its own set of perls most important global |
29 | important global variables. |
64 | variables (see L<Coro::State> for more configuration and background info). |
|
|
65 | |
|
|
66 | See also the C<SEE ALSO> section at the end of this document - the Coro |
|
|
67 | module family is quite large. |
|
|
68 | |
|
|
69 | =head1 CORO THREAD LIFE CYCLE |
|
|
70 | |
|
|
71 | During the long and exciting (or not) life of a coro thread, it goes |
|
|
72 | through a number of states: |
|
|
73 | |
|
|
74 | =over 4 |
|
|
75 | |
|
|
76 | =item 1. Creation |
|
|
77 | |
|
|
78 | The first thing in the life of a coro thread is it's creation - |
|
|
79 | obviously. The typical way to create a thread is to call the C<async |
|
|
80 | BLOCK> function: |
|
|
81 | |
|
|
82 | async { |
|
|
83 | # thread code goes here |
|
|
84 | }; |
|
|
85 | |
|
|
86 | You can also pass arguments, which are put in C<@_>: |
|
|
87 | |
|
|
88 | async { |
|
|
89 | print $_[1]; # prints 2 |
|
|
90 | } 1, 2, 3; |
|
|
91 | |
|
|
92 | This creates a new coro thread and puts it into the ready queue, meaning |
|
|
93 | it will run as soon as the CPU is free for it. |
|
|
94 | |
|
|
95 | C<async> will return a coro object - you can store this for future |
|
|
96 | reference or ignore it, the thread itself will keep a reference to it's |
|
|
97 | thread object - threads are alive on their own. |
|
|
98 | |
|
|
99 | Another way to create a thread is to call the C<new> constructor with a |
|
|
100 | code-reference: |
|
|
101 | |
|
|
102 | new Coro sub { |
|
|
103 | # thread code goes here |
|
|
104 | }, @optional_arguments; |
|
|
105 | |
|
|
106 | This is quite similar to calling C<async>, but the important difference is |
|
|
107 | that the new thread is not put into the ready queue, so the thread will |
|
|
108 | not run until somebody puts it there. C<async> is, therefore, identical to |
|
|
109 | this sequence: |
|
|
110 | |
|
|
111 | my $coro = new Coro sub { |
|
|
112 | # thread code goes here |
|
|
113 | }; |
|
|
114 | $coro->ready; |
|
|
115 | return $coro; |
|
|
116 | |
|
|
117 | =item 2. Startup |
|
|
118 | |
|
|
119 | When a new coro thread is created, only a copy of the code reference |
|
|
120 | and the arguments are stored, no extra memory for stacks and so on is |
|
|
121 | allocated, keeping the coro thread in a low-memory state. |
|
|
122 | |
|
|
123 | Only when it actually starts executing will all the resources be finally |
|
|
124 | allocated. |
|
|
125 | |
|
|
126 | The optional arguments specified at coro creation are available in C<@_>, |
|
|
127 | similar to function calls. |
|
|
128 | |
|
|
129 | =item 3. Running / Blocking |
|
|
130 | |
|
|
131 | A lot can happen after the coro thread has started running. Quite usually, |
|
|
132 | it will not run to the end in one go (because you could use a function |
|
|
133 | instead), but it will give up the CPU regularly because it waits for |
|
|
134 | external events. |
|
|
135 | |
|
|
136 | As long as a coro thread runs, it's coro object is available in the global |
|
|
137 | variable C<$Coro::current>. |
|
|
138 | |
|
|
139 | The low-level way to give up the CPU is to call the scheduler, which |
|
|
140 | selects a new coro thread to run: |
|
|
141 | |
|
|
142 | Coro::schedule; |
|
|
143 | |
|
|
144 | Since running threads are not in the ready queue, calling the scheduler |
|
|
145 | without doing anything else will block the coro thread forever - you need |
|
|
146 | to arrange either for the coro to put woken up (readied) by some other |
|
|
147 | event or some other thread, or you can put it into the ready queue before |
|
|
148 | scheduling: |
|
|
149 | |
|
|
150 | # this is exactly what Coro::cede does |
|
|
151 | $Coro::current->ready; |
|
|
152 | Coro::schedule; |
|
|
153 | |
|
|
154 | All the higher-level synchronisation methods (Coro::Semaphore, |
|
|
155 | Coro::rouse_*...) are actually implemented via C<< ->ready >> and C<< |
|
|
156 | Coro::schedule >>. |
|
|
157 | |
|
|
158 | While the coro thread is running it also might get assigned a C-level |
|
|
159 | thread, or the C-level thread might be unassigned from it, as the Coro |
|
|
160 | runtime wishes. A C-level thread needs to be assigned when your perl |
|
|
161 | thread calls into some C-level function and that function in turn calls |
|
|
162 | perl and perl then wants to switch coroutines. This happens most often |
|
|
163 | when you run an event loop and block in the callback, or when perl |
|
|
164 | itself calls some function such as C<AUTOLOAD> or methods via the C<tie> |
|
|
165 | mechanism. |
|
|
166 | |
|
|
167 | =item 4. Termination |
|
|
168 | |
|
|
169 | Many threads actually terminate after some time. There are a number of |
|
|
170 | ways to terminate a coro thread, the simplest is returning from the |
|
|
171 | top-level code reference: |
|
|
172 | |
|
|
173 | async { |
|
|
174 | # after returning from here, the coro thread is terminated |
|
|
175 | }; |
|
|
176 | |
|
|
177 | async { |
|
|
178 | return if 0.5 < rand; # terminate a little earlier, maybe |
|
|
179 | print "got a chance to print this\n"; |
|
|
180 | # or here |
|
|
181 | }; |
|
|
182 | |
|
|
183 | Any values returned from the coroutine can be recovered using C<< ->join |
|
|
184 | >>: |
|
|
185 | |
|
|
186 | my $coro = async { |
|
|
187 | "hello, world\n" # return a string |
|
|
188 | }; |
|
|
189 | |
|
|
190 | my $hello_world = $coro->join; |
|
|
191 | |
|
|
192 | print $hello_world; |
|
|
193 | |
|
|
194 | Another way to terminate is to call C<< Coro::terminate >>, which at any |
|
|
195 | subroutine call nesting level: |
|
|
196 | |
|
|
197 | async { |
|
|
198 | Coro::terminate "return value 1", "return value 2"; |
|
|
199 | }; |
|
|
200 | |
|
|
201 | And yet another way is to C<< ->cancel >> (or C<< ->safe_cancel >>) the |
|
|
202 | coro thread from another thread: |
|
|
203 | |
|
|
204 | my $coro = async { |
|
|
205 | exit 1; |
|
|
206 | }; |
|
|
207 | |
|
|
208 | $coro->cancel; # also accepts values for ->join to retrieve |
|
|
209 | |
|
|
210 | Cancellation I<can> be dangerous - it's a bit like calling C<exit> without |
|
|
211 | actually exiting, and might leave C libraries and XS modules in a weird |
|
|
212 | state. Unlike other thread implementations, however, Coro is exceptionally |
|
|
213 | safe with regards to cancellation, as perl will always be in a consistent |
|
|
214 | state, and for those cases where you want to do truly marvellous things |
|
|
215 | with your coro while it is being cancelled - that is, make sure all |
|
|
216 | cleanup code is executed from the thread being cancelled - there is even a |
|
|
217 | C<< ->safe_cancel >> method. |
|
|
218 | |
|
|
219 | So, cancelling a thread that runs in an XS event loop might not be the |
|
|
220 | best idea, but any other combination that deals with perl only (cancelling |
|
|
221 | when a thread is in a C<tie> method or an C<AUTOLOAD> for example) is |
|
|
222 | safe. |
|
|
223 | |
|
|
224 | =item 5. Cleanup |
|
|
225 | |
|
|
226 | Threads will allocate various resources. Most but not all will be returned |
|
|
227 | when a thread terminates, during clean-up. |
|
|
228 | |
|
|
229 | Cleanup is quite similar to throwing an uncaught exception: perl will |
|
|
230 | work it's way up through all subroutine calls and blocks. On it's way, it |
|
|
231 | will release all C<my> variables, undo all C<local>'s and free any other |
|
|
232 | resources truly local to the thread. |
|
|
233 | |
|
|
234 | So, a common way to free resources is to keep them referenced only by my |
|
|
235 | variables: |
|
|
236 | |
|
|
237 | async { |
|
|
238 | my $big_cache = new Cache ...; |
|
|
239 | }; |
|
|
240 | |
|
|
241 | If there are no other references, then the C<$big_cache> object will be |
|
|
242 | freed when the thread terminates, regardless of how it does so. |
|
|
243 | |
|
|
244 | What it does C<NOT> do is unlock any Coro::Semaphores or similar |
|
|
245 | resources, but that's where the C<guard> methods come in handy: |
|
|
246 | |
|
|
247 | my $sem = new Coro::Semaphore; |
|
|
248 | |
|
|
249 | async { |
|
|
250 | my $lock_guard = $sem->guard; |
|
|
251 | # if we reutrn, or die or get cancelled, here, |
|
|
252 | # then the semaphore will be "up"ed. |
|
|
253 | }; |
|
|
254 | |
|
|
255 | The C<Guard::guard> function comes in handy for any custom cleanup you |
|
|
256 | might want to do: |
|
|
257 | |
|
|
258 | async { |
|
|
259 | my $window = new Gtk2::Window "toplevel"; |
|
|
260 | # The window will not be cleaned up automatically, even when $window |
|
|
261 | # gets freed, so use a guard to ensure it's destruction |
|
|
262 | # in case of an error: |
|
|
263 | my $window_guard = Guard::guard { $window->destroy }; |
|
|
264 | |
|
|
265 | # we are safe here |
|
|
266 | }; |
|
|
267 | |
|
|
268 | Last not least, C<local> can often be handy, too, e.g. when temporarily |
|
|
269 | replacing the coro thread description: |
|
|
270 | |
|
|
271 | sub myfunction { |
|
|
272 | local $Coro::current->{desc} = "inside myfunction(@_)"; |
|
|
273 | |
|
|
274 | # if we return or die here, the description will be restored |
|
|
275 | } |
|
|
276 | |
|
|
277 | =item 6. Viva La Zombie Muerte |
|
|
278 | |
|
|
279 | Even after a thread has terminated and cleaned up it's resources, the coro |
|
|
280 | object still is there and stores the return values of the thread. Only in |
|
|
281 | this state will the coro object be "reference counted" in the normal perl |
|
|
282 | sense: the thread code keeps a reference to it when it is active, but not |
|
|
283 | after it has terminated. |
|
|
284 | |
|
|
285 | The means the coro object gets freed automatically when the thread has |
|
|
286 | terminated and cleaned up and there arenot other references. |
|
|
287 | |
|
|
288 | If there are, the coro object will stay around, and you can call C<< |
|
|
289 | ->join >> as many times as you wish to retrieve the result values: |
|
|
290 | |
|
|
291 | async { |
|
|
292 | print "hi\n"; |
|
|
293 | 1 |
|
|
294 | }; |
|
|
295 | |
|
|
296 | # run the async above, and free everything before returning |
|
|
297 | # from Coro::cede: |
|
|
298 | Coro::cede; |
|
|
299 | |
|
|
300 | { |
|
|
301 | my $coro = async { |
|
|
302 | print "hi\n"; |
|
|
303 | 1 |
|
|
304 | }; |
|
|
305 | |
|
|
306 | # run the async above, and clean up, but do not free the coro |
|
|
307 | # object: |
|
|
308 | Coro::cede; |
|
|
309 | |
|
|
310 | # optionally retrieve the result values |
|
|
311 | my @results = $coro->join; |
|
|
312 | |
|
|
313 | # now $coro goes out of scope, and presumably gets freed |
|
|
314 | }; |
|
|
315 | |
|
|
316 | =back |
30 | |
317 | |
31 | =cut |
318 | =cut |
32 | |
319 | |
33 | package Coro; |
320 | package Coro; |
34 | |
321 | |
35 | no warnings qw(uninitialized); |
322 | use common::sense; |
|
|
323 | |
|
|
324 | use Carp (); |
|
|
325 | |
|
|
326 | use Guard (); |
36 | |
327 | |
37 | use Coro::State; |
328 | use Coro::State; |
38 | |
329 | |
39 | use base Exporter; |
330 | use base qw(Coro::State Exporter); |
40 | |
331 | |
41 | $VERSION = 0.652; |
332 | our $idle; # idle handler |
|
|
333 | our $main; # main coro |
|
|
334 | our $current; # current coro |
42 | |
335 | |
43 | @EXPORT = qw(async cede schedule terminate current); |
336 | our $VERSION = 5.372; |
|
|
337 | |
|
|
338 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait); |
44 | %EXPORT_TAGS = ( |
339 | our %EXPORT_TAGS = ( |
45 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
340 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
46 | ); |
341 | ); |
47 | @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
342 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
48 | |
343 | |
49 | { |
344 | =head1 GLOBAL VARIABLES |
50 | my @async; |
|
|
51 | my $init; |
|
|
52 | |
|
|
53 | # this way of handling attributes simply is NOT scalable ;() |
|
|
54 | sub import { |
|
|
55 | Coro->export_to_level(1, @_); |
|
|
56 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
|
|
57 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
|
|
58 | my ($package, $ref) = (shift, shift); |
|
|
59 | my @attrs; |
|
|
60 | for (@_) { |
|
|
61 | if ($_ eq "Coro") { |
|
|
62 | push @async, $ref; |
|
|
63 | unless ($init++) { |
|
|
64 | eval q{ |
|
|
65 | sub INIT { |
|
|
66 | &async(pop @async) while @async; |
|
|
67 | } |
|
|
68 | }; |
|
|
69 | } |
|
|
70 | } else { |
|
|
71 | push @attrs, $_; |
|
|
72 | } |
|
|
73 | } |
|
|
74 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
|
|
75 | }; |
|
|
76 | } |
|
|
77 | |
|
|
78 | } |
|
|
79 | |
345 | |
80 | =over 4 |
346 | =over 4 |
81 | |
347 | |
82 | =item $main |
348 | =item $Coro::main |
83 | |
349 | |
84 | This coroutine represents the main program. |
350 | This variable stores the Coro object that represents the main |
|
|
351 | program. While you cna C<ready> it and do most other things you can do to |
|
|
352 | coro, it is mainly useful to compare again C<$Coro::current>, to see |
|
|
353 | whether you are running in the main program or not. |
85 | |
354 | |
86 | =cut |
355 | =cut |
87 | |
356 | |
88 | our $main = new Coro; |
357 | # $main is now being initialised by Coro::State |
89 | |
358 | |
90 | =item $current (or as function: current) |
359 | =item $Coro::current |
91 | |
360 | |
92 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
361 | The Coro object representing the current coro (the last |
|
|
362 | coro that the Coro scheduler switched to). The initial value is |
|
|
363 | C<$Coro::main> (of course). |
93 | |
364 | |
94 | =cut |
365 | This variable is B<strictly> I<read-only>. You can take copies of the |
|
|
366 | value stored in it and use it as any other Coro object, but you must |
|
|
367 | not otherwise modify the variable itself. |
95 | |
368 | |
96 | # maybe some other module used Coro::Specific before... |
369 | =cut |
97 | if ($current) { |
|
|
98 | $main->{specific} = $current->{specific}; |
|
|
99 | } |
|
|
100 | |
370 | |
101 | our $current = $main; |
|
|
102 | |
|
|
103 | sub current() { $current } |
371 | sub current() { $current } # [DEPRECATED] |
104 | |
372 | |
105 | =item $idle |
373 | =item $Coro::idle |
106 | |
374 | |
107 | The coroutine to switch to when no other coroutine is running. The default |
375 | This variable is mainly useful to integrate Coro into event loops. It is |
108 | implementation prints "FATAL: deadlock detected" and exits. |
376 | usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is |
|
|
377 | pretty low-level functionality. |
109 | |
378 | |
110 | =cut |
379 | This variable stores a Coro object that is put into the ready queue when |
|
|
380 | there are no other ready threads (without invoking any ready hooks). |
111 | |
381 | |
112 | # should be done using priorities :( |
382 | The default implementation dies with "FATAL: deadlock detected.", followed |
|
|
383 | by a thread listing, because the program has no other way to continue. |
|
|
384 | |
|
|
385 | This hook is overwritten by modules such as C<Coro::EV> and |
|
|
386 | C<Coro::AnyEvent> to wait on an external event that hopefully wakes up a |
|
|
387 | coro so the scheduler can run it. |
|
|
388 | |
|
|
389 | See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique. |
|
|
390 | |
|
|
391 | =cut |
|
|
392 | |
|
|
393 | # ||= because other modules could have provided their own by now |
113 | our $idle = new Coro sub { |
394 | $idle ||= new Coro sub { |
|
|
395 | require Coro::Debug; |
114 | print STDERR "FATAL: deadlock detected\n"; |
396 | die "FATAL: deadlock detected.\n" |
115 | exit(51); |
397 | . Coro::Debug::ps_listing (); |
116 | }; |
398 | }; |
117 | |
399 | |
118 | # this coroutine is necessary because a coroutine |
400 | # this coro is necessary because a coro |
119 | # cannot destroy itself. |
401 | # cannot destroy itself. |
120 | my @destroy; |
402 | our @destroy; |
121 | my $manager; |
403 | our $manager; |
|
|
404 | |
122 | $manager = new Coro sub { |
405 | $manager = new Coro sub { |
123 | while() { |
406 | while () { |
124 | # by overwriting the state object with the manager we destroy it |
407 | _destroy shift @destroy |
125 | # while still being able to schedule this coroutine (in case it has |
|
|
126 | # been readied multiple times. this is harmless since the manager |
|
|
127 | # can be called as many times as neccessary and will always |
|
|
128 | # remove itself from the runqueue |
|
|
129 | while (@destroy) { |
408 | while @destroy; |
130 | my $coro = pop @destroy; |
409 | |
131 | $coro->{status} ||= []; |
|
|
132 | $_->ready for @{delete $coro->{join} || []}; |
|
|
133 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
134 | } |
|
|
135 | &schedule; |
410 | &schedule; |
136 | } |
411 | } |
137 | }; |
412 | }; |
138 | |
413 | $manager->{desc} = "[coro manager]"; |
139 | # static methods. not really. |
414 | $manager->prio (PRIO_MAX); |
140 | |
415 | |
141 | =back |
416 | =back |
142 | |
417 | |
143 | =head2 STATIC METHODS |
418 | =head1 SIMPLE CORO CREATION |
144 | |
|
|
145 | Static methods are actually functions that operate on the current process only. |
|
|
146 | |
419 | |
147 | =over 4 |
420 | =over 4 |
148 | |
421 | |
149 | =item async { ... } [@args...] |
422 | =item async { ... } [@args...] |
150 | |
423 | |
151 | Create a new asynchronous process and return it's process object |
424 | Create a new coro and return its Coro object (usually |
152 | (usually unused). When the sub returns the new process is automatically |
425 | unused). The coro will be put into the ready queue, so |
|
|
426 | it will start running automatically on the next scheduler run. |
|
|
427 | |
|
|
428 | The first argument is a codeblock/closure that should be executed in the |
|
|
429 | coro. When it returns argument returns the coro is automatically |
153 | terminated. |
430 | terminated. |
154 | |
431 | |
|
|
432 | The remaining arguments are passed as arguments to the closure. |
|
|
433 | |
|
|
434 | See the C<Coro::State::new> constructor for info about the coro |
|
|
435 | environment in which coro are executed. |
|
|
436 | |
|
|
437 | Calling C<exit> in a coro will do the same as calling exit outside |
|
|
438 | the coro. Likewise, when the coro dies, the program will exit, |
|
|
439 | just as it would in the main program. |
|
|
440 | |
|
|
441 | If you do not want that, you can provide a default C<die> handler, or |
|
|
442 | simply avoid dieing (by use of C<eval>). |
|
|
443 | |
155 | # create a new coroutine that just prints its arguments |
444 | Example: Create a new coro that just prints its arguments. |
|
|
445 | |
156 | async { |
446 | async { |
157 | print "@_\n"; |
447 | print "@_\n"; |
158 | } 1,2,3,4; |
448 | } 1,2,3,4; |
159 | |
449 | |
160 | The coderef you submit MUST NOT be a closure that refers to variables |
450 | =item async_pool { ... } [@args...] |
161 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
162 | |
451 | |
163 | =cut |
452 | Similar to C<async>, but uses a coro pool, so you should not call |
|
|
453 | terminate or join on it (although you are allowed to), and you get a |
|
|
454 | coro that might have executed other code already (which can be good |
|
|
455 | or bad :). |
164 | |
456 | |
165 | sub async(&@) { |
457 | On the plus side, this function is about twice as fast as creating (and |
166 | my $pid = new Coro @_; |
458 | destroying) a completely new coro, so if you need a lot of generic |
167 | $manager->ready; # this ensures that the stack is cloned from the manager |
459 | coros in quick successsion, use C<async_pool>, not C<async>. |
168 | $pid->ready; |
460 | |
169 | $pid; |
461 | The code block is executed in an C<eval> context and a warning will be |
|
|
462 | issued in case of an exception instead of terminating the program, as |
|
|
463 | C<async> does. As the coro is being reused, stuff like C<on_destroy> |
|
|
464 | will not work in the expected way, unless you call terminate or cancel, |
|
|
465 | which somehow defeats the purpose of pooling (but is fine in the |
|
|
466 | exceptional case). |
|
|
467 | |
|
|
468 | The priority will be reset to C<0> after each run, tracing will be |
|
|
469 | disabled, the description will be reset and the default output filehandle |
|
|
470 | gets restored, so you can change all these. Otherwise the coro will |
|
|
471 | be re-used "as-is": most notably if you change other per-coro global |
|
|
472 | stuff such as C<$/> you I<must needs> revert that change, which is most |
|
|
473 | simply done by using local as in: C<< local $/ >>. |
|
|
474 | |
|
|
475 | The idle pool size is limited to C<8> idle coros (this can be |
|
|
476 | adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle |
|
|
477 | coros as required. |
|
|
478 | |
|
|
479 | If you are concerned about pooled coros growing a lot because a |
|
|
480 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
|
|
481 | { terminate }> once per second or so to slowly replenish the pool. In |
|
|
482 | addition to that, when the stacks used by a handler grows larger than 32kb |
|
|
483 | (adjustable via $Coro::POOL_RSS) it will also be destroyed. |
|
|
484 | |
|
|
485 | =cut |
|
|
486 | |
|
|
487 | our $POOL_SIZE = 8; |
|
|
488 | our $POOL_RSS = 32 * 1024; |
|
|
489 | our @async_pool; |
|
|
490 | |
|
|
491 | sub pool_handler { |
|
|
492 | while () { |
|
|
493 | eval { |
|
|
494 | &{&_pool_handler} while 1; |
|
|
495 | }; |
|
|
496 | |
|
|
497 | warn $@ if $@; |
|
|
498 | } |
170 | } |
499 | } |
171 | |
500 | |
|
|
501 | =back |
|
|
502 | |
|
|
503 | =head1 STATIC METHODS |
|
|
504 | |
|
|
505 | Static methods are actually functions that implicitly operate on the |
|
|
506 | current coro. |
|
|
507 | |
|
|
508 | =over 4 |
|
|
509 | |
172 | =item schedule |
510 | =item schedule |
173 | |
511 | |
174 | Calls the scheduler. Please note that the current process will not be put |
512 | Calls the scheduler. The scheduler will find the next coro that is |
|
|
513 | to be run from the ready queue and switches to it. The next coro |
|
|
514 | to be run is simply the one with the highest priority that is longest |
|
|
515 | in its ready queue. If there is no coro ready, it will call the |
|
|
516 | C<$Coro::idle> hook. |
|
|
517 | |
|
|
518 | Please note that the current coro will I<not> be put into the ready |
175 | into the ready queue, so calling this function usually means you will |
519 | queue, so calling this function usually means you will never be called |
176 | never be called again. |
520 | again unless something else (e.g. an event handler) calls C<< ->ready >>, |
|
|
521 | thus waking you up. |
177 | |
522 | |
178 | =cut |
523 | This makes C<schedule> I<the> generic method to use to block the current |
|
|
524 | coro and wait for events: first you remember the current coro in |
|
|
525 | a variable, then arrange for some callback of yours to call C<< ->ready |
|
|
526 | >> on that once some event happens, and last you call C<schedule> to put |
|
|
527 | yourself to sleep. Note that a lot of things can wake your coro up, |
|
|
528 | so you need to check whether the event indeed happened, e.g. by storing the |
|
|
529 | status in a variable. |
|
|
530 | |
|
|
531 | See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks. |
179 | |
532 | |
180 | =item cede |
533 | =item cede |
181 | |
534 | |
182 | "Cede" to other processes. This function puts the current process into the |
535 | "Cede" to other coros. This function puts the current coro into |
183 | ready queue and calls C<schedule>, which has the effect of giving up the |
536 | the ready queue and calls C<schedule>, which has the effect of giving |
184 | current "timeslice" to other coroutines of the same or higher priority. |
537 | up the current "timeslice" to other coros of the same or higher |
|
|
538 | priority. Once your coro gets its turn again it will automatically be |
|
|
539 | resumed. |
185 | |
540 | |
186 | =cut |
541 | This function is often called C<yield> in other languages. |
|
|
542 | |
|
|
543 | =item Coro::cede_notself |
|
|
544 | |
|
|
545 | Works like cede, but is not exported by default and will cede to I<any> |
|
|
546 | coro, regardless of priority. This is useful sometimes to ensure |
|
|
547 | progress is made. |
187 | |
548 | |
188 | =item terminate [arg...] |
549 | =item terminate [arg...] |
189 | |
550 | |
190 | Terminates the current process. |
551 | Terminates the current coro with the given status values (see |
|
|
552 | L<cancel>). The values will not be copied, but referenced directly. |
191 | |
553 | |
192 | Future versions of this function will allow result arguments. |
554 | =item Coro::on_enter BLOCK, Coro::on_leave BLOCK |
193 | |
555 | |
194 | =cut |
556 | These function install enter and leave winders in the current scope. The |
|
|
557 | enter block will be executed when on_enter is called and whenever the |
|
|
558 | current coro is re-entered by the scheduler, while the leave block is |
|
|
559 | executed whenever the current coro is blocked by the scheduler, and |
|
|
560 | also when the containing scope is exited (by whatever means, be it exit, |
|
|
561 | die, last etc.). |
195 | |
562 | |
196 | sub terminate { |
563 | I<Neither invoking the scheduler, nor exceptions, are allowed within those |
197 | $current->{status} = [@_]; |
564 | BLOCKs>. That means: do not even think about calling C<die> without an |
198 | $current->cancel; |
565 | eval, and do not even think of entering the scheduler in any way. |
199 | &schedule; |
566 | |
200 | die; # NORETURN |
567 | Since both BLOCKs are tied to the current scope, they will automatically |
|
|
568 | be removed when the current scope exits. |
|
|
569 | |
|
|
570 | These functions implement the same concept as C<dynamic-wind> in scheme |
|
|
571 | does, and are useful when you want to localise some resource to a specific |
|
|
572 | coro. |
|
|
573 | |
|
|
574 | They slow down thread switching considerably for coros that use them |
|
|
575 | (about 40% for a BLOCK with a single assignment, so thread switching is |
|
|
576 | still reasonably fast if the handlers are fast). |
|
|
577 | |
|
|
578 | These functions are best understood by an example: The following function |
|
|
579 | will change the current timezone to "Antarctica/South_Pole", which |
|
|
580 | requires a call to C<tzset>, but by using C<on_enter> and C<on_leave>, |
|
|
581 | which remember/change the current timezone and restore the previous |
|
|
582 | value, respectively, the timezone is only changed for the coro that |
|
|
583 | installed those handlers. |
|
|
584 | |
|
|
585 | use POSIX qw(tzset); |
|
|
586 | |
|
|
587 | async { |
|
|
588 | my $old_tz; # store outside TZ value here |
|
|
589 | |
|
|
590 | Coro::on_enter { |
|
|
591 | $old_tz = $ENV{TZ}; # remember the old value |
|
|
592 | |
|
|
593 | $ENV{TZ} = "Antarctica/South_Pole"; |
|
|
594 | tzset; # enable new value |
|
|
595 | }; |
|
|
596 | |
|
|
597 | Coro::on_leave { |
|
|
598 | $ENV{TZ} = $old_tz; |
|
|
599 | tzset; # restore old value |
|
|
600 | }; |
|
|
601 | |
|
|
602 | # at this place, the timezone is Antarctica/South_Pole, |
|
|
603 | # without disturbing the TZ of any other coro. |
|
|
604 | }; |
|
|
605 | |
|
|
606 | This can be used to localise about any resource (locale, uid, current |
|
|
607 | working directory etc.) to a block, despite the existance of other |
|
|
608 | coros. |
|
|
609 | |
|
|
610 | Another interesting example implements time-sliced multitasking using |
|
|
611 | interval timers (this could obviously be optimised, but does the job): |
|
|
612 | |
|
|
613 | # "timeslice" the given block |
|
|
614 | sub timeslice(&) { |
|
|
615 | use Time::HiRes (); |
|
|
616 | |
|
|
617 | Coro::on_enter { |
|
|
618 | # on entering the thread, we set an VTALRM handler to cede |
|
|
619 | $SIG{VTALRM} = sub { cede }; |
|
|
620 | # and then start the interval timer |
|
|
621 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01; |
|
|
622 | }; |
|
|
623 | Coro::on_leave { |
|
|
624 | # on leaving the thread, we stop the interval timer again |
|
|
625 | Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0; |
|
|
626 | }; |
|
|
627 | |
|
|
628 | &{+shift}; |
|
|
629 | } |
|
|
630 | |
|
|
631 | # use like this: |
|
|
632 | timeslice { |
|
|
633 | # The following is an endless loop that would normally |
|
|
634 | # monopolise the process. Since it runs in a timesliced |
|
|
635 | # environment, it will regularly cede to other threads. |
|
|
636 | while () { } |
|
|
637 | }; |
|
|
638 | |
|
|
639 | |
|
|
640 | =item killall |
|
|
641 | |
|
|
642 | Kills/terminates/cancels all coros except the currently running one. |
|
|
643 | |
|
|
644 | Note that while this will try to free some of the main interpreter |
|
|
645 | resources if the calling coro isn't the main coro, but one |
|
|
646 | cannot free all of them, so if a coro that is not the main coro |
|
|
647 | calls this function, there will be some one-time resource leak. |
|
|
648 | |
|
|
649 | =cut |
|
|
650 | |
|
|
651 | sub killall { |
|
|
652 | for (Coro::State::list) { |
|
|
653 | $_->cancel |
|
|
654 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
655 | } |
201 | } |
656 | } |
202 | |
657 | |
203 | =back |
658 | =back |
204 | |
659 | |
205 | # dynamic methods |
660 | =head1 CORO OBJECT METHODS |
206 | |
661 | |
207 | =head2 PROCESS METHODS |
|
|
208 | |
|
|
209 | These are the methods you can call on process objects. |
662 | These are the methods you can call on coro objects (or to create |
|
|
663 | them). |
210 | |
664 | |
211 | =over 4 |
665 | =over 4 |
212 | |
666 | |
213 | =item new Coro \&sub [, @args...] |
667 | =item new Coro \&sub [, @args...] |
214 | |
668 | |
215 | Create a new process and return it. When the sub returns the process |
669 | Create a new coro and return it. When the sub returns, the coro |
216 | automatically terminates as if C<terminate> with the returned values were |
670 | automatically terminates as if C<terminate> with the returned values were |
217 | called. To make the process run you must first put it into the ready queue |
671 | called. To make the coro run you must first put it into the ready |
218 | by calling the ready method. |
672 | queue by calling the ready method. |
219 | |
673 | |
220 | =cut |
674 | See C<async> and C<Coro::State::new> for additional info about the |
|
|
675 | coro environment. |
221 | |
676 | |
|
|
677 | =cut |
|
|
678 | |
222 | sub _newcoro { |
679 | sub _coro_run { |
223 | terminate &{+shift}; |
680 | terminate &{+shift}; |
224 | } |
681 | } |
225 | |
682 | |
226 | sub new { |
683 | =item $success = $coro->ready |
227 | my $class = shift; |
|
|
228 | bless { |
|
|
229 | _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
|
|
230 | }, $class; |
|
|
231 | } |
|
|
232 | |
684 | |
233 | =item $process->ready |
685 | Put the given coro into the end of its ready queue (there is one |
|
|
686 | queue for each priority) and return true. If the coro is already in |
|
|
687 | the ready queue, do nothing and return false. |
234 | |
688 | |
235 | Put the given process into the ready queue. |
689 | This ensures that the scheduler will resume this coro automatically |
|
|
690 | once all the coro of higher priority and all coro of the same |
|
|
691 | priority that were put into the ready queue earlier have been resumed. |
236 | |
692 | |
237 | =cut |
693 | =item $coro->suspend |
238 | |
694 | |
239 | =item $process->cancel |
695 | Suspends the specified coro. A suspended coro works just like any other |
|
|
696 | coro, except that the scheduler will not select a suspended coro for |
|
|
697 | execution. |
240 | |
698 | |
241 | Like C<terminate>, but terminates the specified process instead. |
699 | Suspending a coro can be useful when you want to keep the coro from |
|
|
700 | running, but you don't want to destroy it, or when you want to temporarily |
|
|
701 | freeze a coro (e.g. for debugging) to resume it later. |
242 | |
702 | |
243 | =cut |
703 | A scenario for the former would be to suspend all (other) coros after a |
|
|
704 | fork and keep them alive, so their destructors aren't called, but new |
|
|
705 | coros can be created. |
244 | |
706 | |
245 | sub cancel { |
707 | =item $coro->resume |
246 | push @destroy, $_[0]; |
|
|
247 | $manager->ready; |
|
|
248 | &schedule if $current == $_[0]; |
|
|
249 | } |
|
|
250 | |
708 | |
|
|
709 | If the specified coro was suspended, it will be resumed. Note that when |
|
|
710 | the coro was in the ready queue when it was suspended, it might have been |
|
|
711 | unreadied by the scheduler, so an activation might have been lost. |
|
|
712 | |
|
|
713 | To avoid this, it is best to put a suspended coro into the ready queue |
|
|
714 | unconditionally, as every synchronisation mechanism must protect itself |
|
|
715 | against spurious wakeups, and the one in the Coro family certainly do |
|
|
716 | that. |
|
|
717 | |
|
|
718 | =item $is_ready = $coro->is_ready |
|
|
719 | |
|
|
720 | Returns true iff the Coro object is in the ready queue. Unless the Coro |
|
|
721 | object gets destroyed, it will eventually be scheduled by the scheduler. |
|
|
722 | |
|
|
723 | =item $is_running = $coro->is_running |
|
|
724 | |
|
|
725 | Returns true iff the Coro object is currently running. Only one Coro object |
|
|
726 | can ever be in the running state (but it currently is possible to have |
|
|
727 | multiple running Coro::States). |
|
|
728 | |
|
|
729 | =item $is_suspended = $coro->is_suspended |
|
|
730 | |
|
|
731 | Returns true iff this Coro object has been suspended. Suspended Coros will |
|
|
732 | not ever be scheduled. |
|
|
733 | |
|
|
734 | =item $coro->cancel (arg...) |
|
|
735 | |
|
|
736 | Terminates the given Coro thread and makes it return the given arguments as |
|
|
737 | status (default: an empty list). Never returns if the Coro is the |
|
|
738 | current Coro. |
|
|
739 | |
|
|
740 | This is a rather brutal way to free a coro, with some limitations - if |
|
|
741 | the thread is inside a C callback that doesn't expect to be canceled, |
|
|
742 | bad things can happen, or if the cancelled thread insists on running |
|
|
743 | complicated cleanup handlers that rely on it'S thread context, things will |
|
|
744 | not work. |
|
|
745 | |
|
|
746 | Any cleanup code being run (e.g. from C<guard> blocks) will be run without |
|
|
747 | a thread context, and is not allowed to switch to other threads. On the |
|
|
748 | plus side, C<< ->cancel >> will always clean up the thread, no matter |
|
|
749 | what. If your cleanup code is complex or you want to avoid cancelling a |
|
|
750 | C-thread that doesn't know how to clean up itself, it can be better to C<< |
|
|
751 | ->throw >> an exception, or use C<< ->safe_cancel >>. |
|
|
752 | |
|
|
753 | The arguments to C<< ->cancel >> are not copied, but instead will |
|
|
754 | be referenced directly (e.g. if you pass C<$var> and after the call |
|
|
755 | change that variable, then you might change the return values passed to |
|
|
756 | e.g. C<join>, so don't do that). |
|
|
757 | |
|
|
758 | The resources of the Coro are usually freed (or destructed) before this |
|
|
759 | call returns, but this can be delayed for an indefinite amount of time, as |
|
|
760 | in some cases the manager thread has to run first to actually destruct the |
|
|
761 | Coro object. |
|
|
762 | |
|
|
763 | =item $coro->safe_cancel ($arg...) |
|
|
764 | |
|
|
765 | Works mostly like C<< ->cancel >>, but is inherently "safer", and |
|
|
766 | consequently, can fail with an exception in cases the thread is not in a |
|
|
767 | cancellable state. |
|
|
768 | |
|
|
769 | This method works a bit like throwing an exception that cannot be caught |
|
|
770 | - specifically, it will clean up the thread from within itself, so |
|
|
771 | all cleanup handlers (e.g. C<guard> blocks) are run with full thread |
|
|
772 | context and can block if they wish. The downside is that there is no |
|
|
773 | guarantee that the thread can be cancelled when you call this method, and |
|
|
774 | therefore, it might fail. It is also considerably slower than C<cancel> or |
|
|
775 | C<terminate>. |
|
|
776 | |
|
|
777 | A thread is in a safe-cancellable state if it either hasn't been run yet, |
|
|
778 | or it has no C context attached and is inside an SLF function. |
|
|
779 | |
|
|
780 | The latter two basically mean that the thread isn't currently inside a |
|
|
781 | perl callback called from some C function (usually via some XS modules) |
|
|
782 | and isn't currently executing inside some C function itself (via Coro's XS |
|
|
783 | API). |
|
|
784 | |
|
|
785 | This call returns true when it could cancel the thread, or croaks with an |
|
|
786 | error otherwise (i.e. it either returns true or doesn't return at all). |
|
|
787 | |
|
|
788 | Why the weird interface? Well, there are two common models on how and |
|
|
789 | when to cancel things. In the first, you have the expectation that your |
|
|
790 | coro thread can be cancelled when you want to cancel it - if the thread |
|
|
791 | isn't cancellable, this would be a bug somewhere, so C<< ->safe_cancel >> |
|
|
792 | croaks to notify of the bug. |
|
|
793 | |
|
|
794 | In the second model you sometimes want to ask nicely to cancel a thread, |
|
|
795 | but if it's not a good time, well, then don't cancel. This can be done |
|
|
796 | relatively easy like this: |
|
|
797 | |
|
|
798 | if (! eval { $coro->safe_cancel }) { |
|
|
799 | warn "unable to cancel thread: $@"; |
|
|
800 | } |
|
|
801 | |
|
|
802 | However, what you never should do is first try to cancel "safely" and |
|
|
803 | if that fails, cancel the "hard" way with C<< ->cancel >>. That makes |
|
|
804 | no sense: either you rely on being able to execute cleanup code in your |
|
|
805 | thread context, or you don't. If you do, then C<< ->safe_cancel >> is the |
|
|
806 | only way, and if you don't, then C<< ->cancel >> is always faster and more |
|
|
807 | direct. |
|
|
808 | |
|
|
809 | =item $coro->schedule_to |
|
|
810 | |
|
|
811 | Puts the current coro to sleep (like C<Coro::schedule>), but instead |
|
|
812 | of continuing with the next coro from the ready queue, always switch to |
|
|
813 | the given coro object (regardless of priority etc.). The readyness |
|
|
814 | state of that coro isn't changed. |
|
|
815 | |
|
|
816 | This is an advanced method for special cases - I'd love to hear about any |
|
|
817 | uses for this one. |
|
|
818 | |
|
|
819 | =item $coro->cede_to |
|
|
820 | |
|
|
821 | Like C<schedule_to>, but puts the current coro into the ready |
|
|
822 | queue. This has the effect of temporarily switching to the given |
|
|
823 | coro, and continuing some time later. |
|
|
824 | |
|
|
825 | This is an advanced method for special cases - I'd love to hear about any |
|
|
826 | uses for this one. |
|
|
827 | |
|
|
828 | =item $coro->throw ([$scalar]) |
|
|
829 | |
|
|
830 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
831 | inside the coro at the next convenient point in time. Otherwise |
|
|
832 | clears the exception object. |
|
|
833 | |
|
|
834 | Coro will check for the exception each time a schedule-like-function |
|
|
835 | returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down |
|
|
836 | >>, C<< Coro::Handle->readable >> and so on. Most of those functions (all |
|
|
837 | that are part of Coro itself) detect this case and return early in case an |
|
|
838 | exception is pending. |
|
|
839 | |
|
|
840 | The exception object will be thrown "as is" with the specified scalar in |
|
|
841 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
842 | (unlike with C<die>). |
|
|
843 | |
|
|
844 | This can be used as a softer means than either C<cancel> or C<safe_cancel |
|
|
845 | >to ask a coro to end itself, although there is no guarantee that the |
|
|
846 | exception will lead to termination, and if the exception isn't caught it |
|
|
847 | might well end the whole program. |
|
|
848 | |
|
|
849 | You might also think of C<throw> as being the moral equivalent of |
|
|
850 | C<kill>ing a coro with a signal (in this case, a scalar). |
|
|
851 | |
251 | =item $process->join |
852 | =item $coro->join |
252 | |
853 | |
253 | Wait until the coroutine terminates and return any values given to the |
854 | Wait until the coro terminates and return any values given to the |
254 | C<terminate> function. C<join> can be called multiple times from multiple |
855 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
255 | processes. |
856 | from multiple threads, and all will be resumed and given the status |
|
|
857 | return once the C<$coro> terminates. |
256 | |
858 | |
257 | =cut |
859 | =cut |
258 | |
860 | |
259 | sub join { |
861 | sub join { |
260 | my $self = shift; |
862 | my $self = shift; |
|
|
863 | |
261 | unless ($self->{status}) { |
864 | unless ($self->{_status}) { |
262 | push @{$self->{join}}, $current; |
865 | my $current = $current; |
263 | &schedule; |
866 | |
|
|
867 | push @{$self->{_on_destroy}}, sub { |
|
|
868 | $current->ready; |
|
|
869 | undef $current; |
|
|
870 | }; |
|
|
871 | |
|
|
872 | &schedule while $current; |
264 | } |
873 | } |
|
|
874 | |
265 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
875 | wantarray ? @{$self->{_status}} : $self->{_status}[0] |
266 | } |
876 | } |
267 | |
877 | |
|
|
878 | =item $coro->on_destroy (\&cb) |
|
|
879 | |
|
|
880 | Registers a callback that is called when this coro thread gets destroyed, |
|
|
881 | that is, after it's resources have been freed but before it is joined. The |
|
|
882 | callback gets passed the terminate/cancel arguments, if any, and I<must |
|
|
883 | not> die, under any circumstances. |
|
|
884 | |
|
|
885 | There can be any number of C<on_destroy> callbacks per coro, and there is |
|
|
886 | no way currently to remove a callback once added. |
|
|
887 | |
|
|
888 | =cut |
|
|
889 | |
|
|
890 | sub on_destroy { |
|
|
891 | my ($self, $cb) = @_; |
|
|
892 | |
|
|
893 | push @{ $self->{_on_destroy} }, $cb; |
|
|
894 | } |
|
|
895 | |
268 | =item $oldprio = $process->prio($newprio) |
896 | =item $oldprio = $coro->prio ($newprio) |
269 | |
897 | |
270 | Sets (or gets, if the argument is missing) the priority of the |
898 | Sets (or gets, if the argument is missing) the priority of the |
271 | process. Higher priority processes get run before lower priority |
899 | coro thread. Higher priority coro get run before lower priority |
272 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
900 | coros. Priorities are small signed integers (currently -4 .. +3), |
273 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
901 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
274 | to get then): |
902 | to get then): |
275 | |
903 | |
276 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
904 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
277 | 3 > 1 > 0 > -1 > -3 > -4 |
905 | 3 > 1 > 0 > -1 > -3 > -4 |
278 | |
906 | |
279 | # set priority to HIGH |
907 | # set priority to HIGH |
280 | current->prio(PRIO_HIGH); |
908 | current->prio (PRIO_HIGH); |
281 | |
909 | |
282 | The idle coroutine ($Coro::idle) always has a lower priority than any |
910 | The idle coro thread ($Coro::idle) always has a lower priority than any |
283 | existing coroutine. |
911 | existing coro. |
284 | |
912 | |
285 | Changing the priority of the current process will take effect immediately, |
913 | Changing the priority of the current coro will take effect immediately, |
286 | but changing the priority of processes in the ready queue (but not |
914 | but changing the priority of a coro in the ready queue (but not running) |
287 | running) will only take effect after the next schedule (of that |
915 | will only take effect after the next schedule (of that coro). This is a |
288 | process). This is a bug that will be fixed in some future version. |
916 | bug that will be fixed in some future version. |
289 | |
917 | |
290 | =cut |
|
|
291 | |
|
|
292 | sub prio { |
|
|
293 | my $old = $_[0]{prio}; |
|
|
294 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
295 | $old; |
|
|
296 | } |
|
|
297 | |
|
|
298 | =item $newprio = $process->nice($change) |
918 | =item $newprio = $coro->nice ($change) |
299 | |
919 | |
300 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
920 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
301 | higher values mean lower priority, just as in unix). |
921 | higher values mean lower priority, just as in UNIX's nice command). |
302 | |
922 | |
303 | =cut |
|
|
304 | |
|
|
305 | sub nice { |
|
|
306 | $_[0]{prio} -= $_[1]; |
|
|
307 | } |
|
|
308 | |
|
|
309 | =item $olddesc = $process->desc($newdesc) |
923 | =item $olddesc = $coro->desc ($newdesc) |
310 | |
924 | |
311 | Sets (or gets in case the argument is missing) the description for this |
925 | Sets (or gets in case the argument is missing) the description for this |
312 | process. This is just a free-form string you can associate with a process. |
926 | coro thread. This is just a free-form string you can associate with a |
|
|
927 | coro. |
|
|
928 | |
|
|
929 | This method simply sets the C<< $coro->{desc} >> member to the given |
|
|
930 | string. You can modify this member directly if you wish, and in fact, this |
|
|
931 | is often preferred to indicate major processing states that cna then be |
|
|
932 | seen for example in a L<Coro::Debug> session: |
|
|
933 | |
|
|
934 | sub my_long_function { |
|
|
935 | local $Coro::current->{desc} = "now in my_long_function"; |
|
|
936 | ... |
|
|
937 | $Coro::current->{desc} = "my_long_function: phase 1"; |
|
|
938 | ... |
|
|
939 | $Coro::current->{desc} = "my_long_function: phase 2"; |
|
|
940 | ... |
|
|
941 | } |
313 | |
942 | |
314 | =cut |
943 | =cut |
315 | |
944 | |
316 | sub desc { |
945 | sub desc { |
317 | my $old = $_[0]{desc}; |
946 | my $old = $_[0]{desc}; |
318 | $_[0]{desc} = $_[1] if @_ > 1; |
947 | $_[0]{desc} = $_[1] if @_ > 1; |
319 | $old; |
948 | $old; |
320 | } |
949 | } |
321 | |
950 | |
|
|
951 | sub transfer { |
|
|
952 | require Carp; |
|
|
953 | Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught"); |
|
|
954 | } |
|
|
955 | |
322 | =back |
956 | =back |
323 | |
957 | |
|
|
958 | =head1 GLOBAL FUNCTIONS |
|
|
959 | |
|
|
960 | =over 4 |
|
|
961 | |
|
|
962 | =item Coro::nready |
|
|
963 | |
|
|
964 | Returns the number of coro that are currently in the ready state, |
|
|
965 | i.e. that can be switched to by calling C<schedule> directory or |
|
|
966 | indirectly. The value C<0> means that the only runnable coro is the |
|
|
967 | currently running one, so C<cede> would have no effect, and C<schedule> |
|
|
968 | would cause a deadlock unless there is an idle handler that wakes up some |
|
|
969 | coro. |
|
|
970 | |
|
|
971 | =item my $guard = Coro::guard { ... } |
|
|
972 | |
|
|
973 | This function still exists, but is deprecated. Please use the |
|
|
974 | C<Guard::guard> function instead. |
|
|
975 | |
324 | =cut |
976 | =cut |
|
|
977 | |
|
|
978 | BEGIN { *guard = \&Guard::guard } |
|
|
979 | |
|
|
980 | =item unblock_sub { ... } |
|
|
981 | |
|
|
982 | This utility function takes a BLOCK or code reference and "unblocks" it, |
|
|
983 | returning a new coderef. Unblocking means that calling the new coderef |
|
|
984 | will return immediately without blocking, returning nothing, while the |
|
|
985 | original code ref will be called (with parameters) from within another |
|
|
986 | coro. |
|
|
987 | |
|
|
988 | The reason this function exists is that many event libraries (such as |
|
|
989 | the venerable L<Event|Event> module) are not thread-safe (a weaker form |
|
|
990 | of reentrancy). This means you must not block within event callbacks, |
|
|
991 | otherwise you might suffer from crashes or worse. The only event library |
|
|
992 | currently known that is safe to use without C<unblock_sub> is L<EV> (but |
|
|
993 | you might still run into deadlocks if all event loops are blocked). |
|
|
994 | |
|
|
995 | Coro will try to catch you when you block in the event loop |
|
|
996 | ("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and |
|
|
997 | only works when you do not run your own event loop. |
|
|
998 | |
|
|
999 | This function allows your callbacks to block by executing them in another |
|
|
1000 | coro where it is safe to block. One example where blocking is handy |
|
|
1001 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
|
|
1002 | disk, for example. |
|
|
1003 | |
|
|
1004 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
|
|
1005 | creating event callbacks that want to block. |
|
|
1006 | |
|
|
1007 | If your handler does not plan to block (e.g. simply sends a message to |
|
|
1008 | another coro, or puts some other coro into the ready queue), there is |
|
|
1009 | no reason to use C<unblock_sub>. |
|
|
1010 | |
|
|
1011 | Note that you also need to use C<unblock_sub> for any other callbacks that |
|
|
1012 | are indirectly executed by any C-based event loop. For example, when you |
|
|
1013 | use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it |
|
|
1014 | provides callbacks that are the result of some event callback, then you |
|
|
1015 | must not block either, or use C<unblock_sub>. |
|
|
1016 | |
|
|
1017 | =cut |
|
|
1018 | |
|
|
1019 | our @unblock_queue; |
|
|
1020 | |
|
|
1021 | # we create a special coro because we want to cede, |
|
|
1022 | # to reduce pressure on the coro pool (because most callbacks |
|
|
1023 | # return immediately and can be reused) and because we cannot cede |
|
|
1024 | # inside an event callback. |
|
|
1025 | our $unblock_scheduler = new Coro sub { |
|
|
1026 | while () { |
|
|
1027 | while (my $cb = pop @unblock_queue) { |
|
|
1028 | &async_pool (@$cb); |
|
|
1029 | |
|
|
1030 | # for short-lived callbacks, this reduces pressure on the coro pool |
|
|
1031 | # as the chance is very high that the async_poll coro will be back |
|
|
1032 | # in the idle state when cede returns |
|
|
1033 | cede; |
|
|
1034 | } |
|
|
1035 | schedule; # sleep well |
|
|
1036 | } |
|
|
1037 | }; |
|
|
1038 | $unblock_scheduler->{desc} = "[unblock_sub scheduler]"; |
|
|
1039 | |
|
|
1040 | sub unblock_sub(&) { |
|
|
1041 | my $cb = shift; |
|
|
1042 | |
|
|
1043 | sub { |
|
|
1044 | unshift @unblock_queue, [$cb, @_]; |
|
|
1045 | $unblock_scheduler->ready; |
|
|
1046 | } |
|
|
1047 | } |
|
|
1048 | |
|
|
1049 | =item $cb = rouse_cb |
|
|
1050 | |
|
|
1051 | Create and return a "rouse callback". That's a code reference that, |
|
|
1052 | when called, will remember a copy of its arguments and notify the owner |
|
|
1053 | coro of the callback. |
|
|
1054 | |
|
|
1055 | See the next function. |
|
|
1056 | |
|
|
1057 | =item @args = rouse_wait [$cb] |
|
|
1058 | |
|
|
1059 | Wait for the specified rouse callback (or the last one that was created in |
|
|
1060 | this coro). |
|
|
1061 | |
|
|
1062 | As soon as the callback is invoked (or when the callback was invoked |
|
|
1063 | before C<rouse_wait>), it will return the arguments originally passed to |
|
|
1064 | the rouse callback. In scalar context, that means you get the I<last> |
|
|
1065 | argument, just as if C<rouse_wait> had a C<return ($a1, $a2, $a3...)> |
|
|
1066 | statement at the end. |
|
|
1067 | |
|
|
1068 | See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. |
|
|
1069 | |
|
|
1070 | =back |
|
|
1071 | |
|
|
1072 | =cut |
|
|
1073 | |
|
|
1074 | for my $module (qw(Channel RWLock Semaphore SemaphoreSet Signal Specific)) { |
|
|
1075 | my $old = defined &{"Coro::$module\::new"} && \&{"Coro::$module\::new"}; |
|
|
1076 | |
|
|
1077 | *{"Coro::$module\::new"} = sub { |
|
|
1078 | require "Coro/$module.pm"; |
|
|
1079 | |
|
|
1080 | # some modules have their new predefined in State.xs, some don't |
|
|
1081 | *{"Coro::$module\::new"} = $old |
|
|
1082 | if $old; |
|
|
1083 | |
|
|
1084 | goto &{"Coro::$module\::new"}; |
|
|
1085 | }; |
|
|
1086 | } |
325 | |
1087 | |
326 | 1; |
1088 | 1; |
327 | |
1089 | |
|
|
1090 | =head1 HOW TO WAIT FOR A CALLBACK |
|
|
1091 | |
|
|
1092 | It is very common for a coro to wait for some callback to be |
|
|
1093 | called. This occurs naturally when you use coro in an otherwise |
|
|
1094 | event-based program, or when you use event-based libraries. |
|
|
1095 | |
|
|
1096 | These typically register a callback for some event, and call that callback |
|
|
1097 | when the event occured. In a coro, however, you typically want to |
|
|
1098 | just wait for the event, simplyifying things. |
|
|
1099 | |
|
|
1100 | For example C<< AnyEvent->child >> registers a callback to be called when |
|
|
1101 | a specific child has exited: |
|
|
1102 | |
|
|
1103 | my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... }); |
|
|
1104 | |
|
|
1105 | But from within a coro, you often just want to write this: |
|
|
1106 | |
|
|
1107 | my $status = wait_for_child $pid; |
|
|
1108 | |
|
|
1109 | Coro offers two functions specifically designed to make this easy, |
|
|
1110 | C<Coro::rouse_cb> and C<Coro::rouse_wait>. |
|
|
1111 | |
|
|
1112 | The first function, C<rouse_cb>, generates and returns a callback that, |
|
|
1113 | when invoked, will save its arguments and notify the coro that |
|
|
1114 | created the callback. |
|
|
1115 | |
|
|
1116 | The second function, C<rouse_wait>, waits for the callback to be called |
|
|
1117 | (by calling C<schedule> to go to sleep) and returns the arguments |
|
|
1118 | originally passed to the callback. |
|
|
1119 | |
|
|
1120 | Using these functions, it becomes easy to write the C<wait_for_child> |
|
|
1121 | function mentioned above: |
|
|
1122 | |
|
|
1123 | sub wait_for_child($) { |
|
|
1124 | my ($pid) = @_; |
|
|
1125 | |
|
|
1126 | my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb); |
|
|
1127 | |
|
|
1128 | my ($rpid, $rstatus) = Coro::rouse_wait; |
|
|
1129 | $rstatus |
|
|
1130 | } |
|
|
1131 | |
|
|
1132 | In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough, |
|
|
1133 | you can roll your own, using C<schedule>: |
|
|
1134 | |
|
|
1135 | sub wait_for_child($) { |
|
|
1136 | my ($pid) = @_; |
|
|
1137 | |
|
|
1138 | # store the current coro in $current, |
|
|
1139 | # and provide result variables for the closure passed to ->child |
|
|
1140 | my $current = $Coro::current; |
|
|
1141 | my ($done, $rstatus); |
|
|
1142 | |
|
|
1143 | # pass a closure to ->child |
|
|
1144 | my $watcher = AnyEvent->child (pid => $pid, cb => sub { |
|
|
1145 | $rstatus = $_[1]; # remember rstatus |
|
|
1146 | $done = 1; # mark $rstatus as valud |
|
|
1147 | }); |
|
|
1148 | |
|
|
1149 | # wait until the closure has been called |
|
|
1150 | schedule while !$done; |
|
|
1151 | |
|
|
1152 | $rstatus |
|
|
1153 | } |
|
|
1154 | |
|
|
1155 | |
328 | =head1 BUGS/LIMITATIONS |
1156 | =head1 BUGS/LIMITATIONS |
329 | |
1157 | |
330 | - you must make very sure that no coro is still active on global destruction. |
1158 | =over 4 |
331 | very bad things might happen otherwise (usually segfaults). |
1159 | |
|
|
1160 | =item fork with pthread backend |
|
|
1161 | |
|
|
1162 | When Coro is compiled using the pthread backend (which isn't recommended |
|
|
1163 | but required on many BSDs as their libcs are completely broken), then |
|
|
1164 | coro will not survive a fork. There is no known workaround except to |
|
|
1165 | fix your libc and use a saner backend. |
|
|
1166 | |
|
|
1167 | =item perl process emulation ("threads") |
|
|
1168 | |
332 | - this module is not thread-safe. You should only ever use this module from |
1169 | This module is not perl-pseudo-thread-safe. You should only ever use this |
333 | the same thread (this requirement might be loosened in the future to |
1170 | module from the first thread (this requirement might be removed in the |
334 | allow per-thread schedulers, but Coro::State does not yet allow this). |
1171 | future to allow per-thread schedulers, but Coro::State does not yet allow |
|
|
1172 | this). I recommend disabling thread support and using processes, as having |
|
|
1173 | the windows process emulation enabled under unix roughly halves perl |
|
|
1174 | performance, even when not used. |
|
|
1175 | |
|
|
1176 | =item coro switching is not signal safe |
|
|
1177 | |
|
|
1178 | You must not switch to another coro from within a signal handler (only |
|
|
1179 | relevant with %SIG - most event libraries provide safe signals), I<unless> |
|
|
1180 | you are sure you are not interrupting a Coro function. |
|
|
1181 | |
|
|
1182 | That means you I<MUST NOT> call any function that might "block" the |
|
|
1183 | current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or |
|
|
1184 | anything that calls those. Everything else, including calling C<ready>, |
|
|
1185 | works. |
|
|
1186 | |
|
|
1187 | =back |
|
|
1188 | |
|
|
1189 | |
|
|
1190 | =head1 WINDOWS PROCESS EMULATION |
|
|
1191 | |
|
|
1192 | A great many people seem to be confused about ithreads (for example, Chip |
|
|
1193 | Salzenberg called me unintelligent, incapable, stupid and gullible, |
|
|
1194 | while in the same mail making rather confused statements about perl |
|
|
1195 | ithreads (for example, that memory or files would be shared), showing his |
|
|
1196 | lack of understanding of this area - if it is hard to understand for Chip, |
|
|
1197 | it is probably not obvious to everybody). |
|
|
1198 | |
|
|
1199 | What follows is an ultra-condensed version of my talk about threads in |
|
|
1200 | scripting languages given on the perl workshop 2009: |
|
|
1201 | |
|
|
1202 | The so-called "ithreads" were originally implemented for two reasons: |
|
|
1203 | first, to (badly) emulate unix processes on native win32 perls, and |
|
|
1204 | secondly, to replace the older, real thread model ("5.005-threads"). |
|
|
1205 | |
|
|
1206 | It does that by using threads instead of OS processes. The difference |
|
|
1207 | between processes and threads is that threads share memory (and other |
|
|
1208 | state, such as files) between threads within a single process, while |
|
|
1209 | processes do not share anything (at least not semantically). That |
|
|
1210 | means that modifications done by one thread are seen by others, while |
|
|
1211 | modifications by one process are not seen by other processes. |
|
|
1212 | |
|
|
1213 | The "ithreads" work exactly like that: when creating a new ithreads |
|
|
1214 | process, all state is copied (memory is copied physically, files and code |
|
|
1215 | is copied logically). Afterwards, it isolates all modifications. On UNIX, |
|
|
1216 | the same behaviour can be achieved by using operating system processes, |
|
|
1217 | except that UNIX typically uses hardware built into the system to do this |
|
|
1218 | efficiently, while the windows process emulation emulates this hardware in |
|
|
1219 | software (rather efficiently, but of course it is still much slower than |
|
|
1220 | dedicated hardware). |
|
|
1221 | |
|
|
1222 | As mentioned before, loading code, modifying code, modifying data |
|
|
1223 | structures and so on is only visible in the ithreads process doing the |
|
|
1224 | modification, not in other ithread processes within the same OS process. |
|
|
1225 | |
|
|
1226 | This is why "ithreads" do not implement threads for perl at all, only |
|
|
1227 | processes. What makes it so bad is that on non-windows platforms, you can |
|
|
1228 | actually take advantage of custom hardware for this purpose (as evidenced |
|
|
1229 | by the forks module, which gives you the (i-) threads API, just much |
|
|
1230 | faster). |
|
|
1231 | |
|
|
1232 | Sharing data is in the i-threads model is done by transfering data |
|
|
1233 | structures between threads using copying semantics, which is very slow - |
|
|
1234 | shared data simply does not exist. Benchmarks using i-threads which are |
|
|
1235 | communication-intensive show extremely bad behaviour with i-threads (in |
|
|
1236 | fact, so bad that Coro, which cannot take direct advantage of multiple |
|
|
1237 | CPUs, is often orders of magnitude faster because it shares data using |
|
|
1238 | real threads, refer to my talk for details). |
|
|
1239 | |
|
|
1240 | As summary, i-threads *use* threads to implement processes, while |
|
|
1241 | the compatible forks module *uses* processes to emulate, uhm, |
|
|
1242 | processes. I-threads slow down every perl program when enabled, and |
|
|
1243 | outside of windows, serve no (or little) practical purpose, but |
|
|
1244 | disadvantages every single-threaded Perl program. |
|
|
1245 | |
|
|
1246 | This is the reason that I try to avoid the name "ithreads", as it is |
|
|
1247 | misleading as it implies that it implements some kind of thread model for |
|
|
1248 | perl, and prefer the name "windows process emulation", which describes the |
|
|
1249 | actual use and behaviour of it much better. |
335 | |
1250 | |
336 | =head1 SEE ALSO |
1251 | =head1 SEE ALSO |
337 | |
1252 | |
338 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
1253 | Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. |
339 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
1254 | |
340 | L<Coro::Handle>, L<Coro::Socket>. |
1255 | Debugging: L<Coro::Debug>. |
|
|
1256 | |
|
|
1257 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
|
|
1258 | |
|
|
1259 | Locking and IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, |
|
|
1260 | L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
|
|
1261 | |
|
|
1262 | I/O and Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>. |
|
|
1263 | |
|
|
1264 | Compatibility with other modules: L<Coro::LWP> (but see also L<AnyEvent::HTTP> for |
|
|
1265 | a better-working alternative), L<Coro::BDB>, L<Coro::Storable>, |
|
|
1266 | L<Coro::Select>. |
|
|
1267 | |
|
|
1268 | XS API: L<Coro::MakeMaker>. |
|
|
1269 | |
|
|
1270 | Low level Configuration, Thread Environment, Continuations: L<Coro::State>. |
341 | |
1271 | |
342 | =head1 AUTHOR |
1272 | =head1 AUTHOR |
343 | |
1273 | |
344 | Marc Lehmann <pcg@goof.com> |
1274 | Marc Lehmann <schmorp@schmorp.de> |
345 | http://www.goof.com/pcg/marc/ |
1275 | http://home.schmorp.de/ |
346 | |
1276 | |
347 | =cut |
1277 | =cut |
348 | |
1278 | |