… | |
… | |
20 | |
20 | |
21 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
22 | |
22 | |
23 | This module collection manages coroutines. Coroutines are similar |
23 | This module collection manages coroutines. Coroutines are similar |
24 | to threads but don't run in parallel at the same time even on SMP |
24 | to threads but don't run in parallel at the same time even on SMP |
25 | machines. The specific flavor of coroutine use din this module also |
25 | machines. The specific flavor of coroutine used in this module also |
26 | guarentees you that it will not switch between coroutines unless |
26 | guarantees you that it will not switch between coroutines unless |
27 | necessary, at easily-identified points in your program, so locking and |
27 | necessary, at easily-identified points in your program, so locking and |
28 | parallel access are rarely an issue, making coroutine programming much |
28 | parallel access are rarely an issue, making coroutine programming much |
29 | safer than threads programming. |
29 | safer than threads programming. |
30 | |
30 | |
31 | (Perl, however, does not natively support real threads but instead does a |
31 | (Perl, however, does not natively support real threads but instead does a |
… | |
… | |
50 | |
50 | |
51 | our $idle; # idle handler |
51 | our $idle; # idle handler |
52 | our $main; # main coroutine |
52 | our $main; # main coroutine |
53 | our $current; # current coroutine |
53 | our $current; # current coroutine |
54 | |
54 | |
55 | our $VERSION = '3.3'; |
55 | our $VERSION = '3.7'; |
56 | |
56 | |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
58 | our %EXPORT_TAGS = ( |
58 | our %EXPORT_TAGS = ( |
59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
60 | ); |
60 | ); |
… | |
… | |
108 | |
108 | |
109 | The current coroutine (the last coroutine switched to). The initial value |
109 | The current coroutine (the last coroutine switched to). The initial value |
110 | is C<$main> (of course). |
110 | is C<$main> (of course). |
111 | |
111 | |
112 | This variable is B<strictly> I<read-only>. It is provided for performance |
112 | This variable is B<strictly> I<read-only>. It is provided for performance |
113 | reasons. If performance is not essentiel you are encouraged to use the |
113 | reasons. If performance is not essential you are encouraged to use the |
114 | C<Coro::current> function instead. |
114 | C<Coro::current> function instead. |
115 | |
115 | |
116 | =cut |
116 | =cut |
117 | |
117 | |
118 | # maybe some other module used Coro::Specific before... |
118 | # maybe some other module used Coro::Specific before... |
… | |
… | |
159 | # cannot destroy itself. |
159 | # cannot destroy itself. |
160 | my @destroy; |
160 | my @destroy; |
161 | my $manager; |
161 | my $manager; |
162 | |
162 | |
163 | $manager = new Coro sub { |
163 | $manager = new Coro sub { |
|
|
164 | $current->desc ("[coro manager]"); |
|
|
165 | |
164 | while () { |
166 | while () { |
165 | (shift @destroy)->_cancel |
167 | (shift @destroy)->_cancel |
166 | while @destroy; |
168 | while @destroy; |
167 | |
169 | |
168 | &schedule; |
170 | &schedule; |
… | |
… | |
185 | |
187 | |
186 | Create a new asynchronous coroutine and return it's coroutine object |
188 | Create a new asynchronous coroutine and return it's coroutine object |
187 | (usually unused). When the sub returns the new coroutine is automatically |
189 | (usually unused). When the sub returns the new coroutine is automatically |
188 | terminated. |
190 | terminated. |
189 | |
191 | |
190 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
192 | Calling C<exit> in a coroutine will do the same as calling exit outside |
191 | |
193 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
192 | When the coroutine dies, the program will exit, just as in the main |
194 | just as it would in the main program. |
193 | program. |
|
|
194 | |
195 | |
195 | # create a new coroutine that just prints its arguments |
196 | # create a new coroutine that just prints its arguments |
196 | async { |
197 | async { |
197 | print "@_\n"; |
198 | print "@_\n"; |
198 | } 1,2,3,4; |
199 | } 1,2,3,4; |
… | |
… | |
210 | Similar to C<async>, but uses a coroutine pool, so you should not call |
211 | Similar to C<async>, but uses a coroutine pool, so you should not call |
211 | terminate or join (although you are allowed to), and you get a coroutine |
212 | terminate or join (although you are allowed to), and you get a coroutine |
212 | that might have executed other code already (which can be good or bad :). |
213 | that might have executed other code already (which can be good or bad :). |
213 | |
214 | |
214 | Also, the block is executed in an C<eval> context and a warning will be |
215 | Also, the block is executed in an C<eval> context and a warning will be |
215 | issued in case of an exception instead of terminating the program, as C<async> does. |
216 | issued in case of an exception instead of terminating the program, as |
|
|
217 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
|
|
218 | will not work in the expected way, unless you call terminate or cancel, |
|
|
219 | which somehow defeats the purpose of pooling. |
216 | |
220 | |
217 | The priority will be reset to C<0> after each job, otherwise the coroutine |
221 | The priority will be reset to C<0> after each job, otherwise the coroutine |
218 | will be re-used "as-is". |
222 | will be re-used "as-is". |
219 | |
223 | |
220 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
224 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
… | |
… | |
230 | our $POOL_SIZE = 8; |
234 | our $POOL_SIZE = 8; |
231 | our @pool; |
235 | our @pool; |
232 | |
236 | |
233 | sub pool_handler { |
237 | sub pool_handler { |
234 | while () { |
238 | while () { |
235 | my ($cb, @arg) = @{ delete $current->{_invoke} }; |
239 | $current->{desc} = "[async_pool]"; |
236 | |
240 | |
237 | eval { |
241 | eval { |
|
|
242 | my ($cb, @arg) = @{ delete $current->{_invoke} or return }; |
238 | $cb->(@arg); |
243 | $cb->(@arg); |
239 | }; |
244 | }; |
240 | warn $@ if $@; |
245 | warn $@ if $@; |
241 | |
246 | |
242 | last if @pool >= $POOL_SIZE; |
247 | last if @pool >= $POOL_SIZE; |
|
|
248 | |
243 | push @pool, $current; |
249 | push @pool, $current; |
244 | |
250 | $current->{desc} = "[async_pool idle]"; |
|
|
251 | $current->save (Coro::State::SAVE_DEF); |
245 | $current->prio (0); |
252 | $current->prio (0); |
246 | schedule; |
253 | schedule; |
247 | } |
254 | } |
248 | } |
255 | } |
249 | |
256 | |
250 | sub async_pool(&@) { |
257 | sub async_pool(&@) { |
251 | # this is also inlined into the unlock_scheduler |
258 | # this is also inlined into the unlock_scheduler |
252 | my $coro = (pop @pool or new Coro \&pool_handler); |
259 | my $coro = (pop @pool) || new Coro \&pool_handler;; |
253 | |
260 | |
254 | $coro->{_invoke} = [@_]; |
261 | $coro->{_invoke} = [@_]; |
255 | $coro->ready; |
262 | $coro->ready; |
256 | |
263 | |
257 | $coro |
264 | $coro |
… | |
… | |
275 | # wake up sleeping coroutine |
282 | # wake up sleeping coroutine |
276 | $current->ready; |
283 | $current->ready; |
277 | undef $current; |
284 | undef $current; |
278 | }; |
285 | }; |
279 | |
286 | |
280 | # call schedule until event occured. |
287 | # call schedule until event occurred. |
281 | # in case we are woken up for other reasons |
288 | # in case we are woken up for other reasons |
282 | # (current still defined), loop. |
289 | # (current still defined), loop. |
283 | Coro::schedule while $current; |
290 | Coro::schedule while $current; |
284 | } |
291 | } |
285 | |
292 | |
… | |
… | |
287 | |
294 | |
288 | "Cede" to other coroutines. This function puts the current coroutine into the |
295 | "Cede" to other coroutines. This function puts the current coroutine into the |
289 | ready queue and calls C<schedule>, which has the effect of giving up the |
296 | ready queue and calls C<schedule>, which has the effect of giving up the |
290 | current "timeslice" to other coroutines of the same or higher priority. |
297 | current "timeslice" to other coroutines of the same or higher priority. |
291 | |
298 | |
|
|
299 | Returns true if at least one coroutine switch has happened. |
|
|
300 | |
292 | =item Coro::cede_notself |
301 | =item Coro::cede_notself |
293 | |
302 | |
294 | Works like cede, but is not exported by default and will cede to any |
303 | Works like cede, but is not exported by default and will cede to any |
295 | coroutine, regardless of priority, once. |
304 | coroutine, regardless of priority, once. |
|
|
305 | |
|
|
306 | Returns true if at least one coroutine switch has happened. |
296 | |
307 | |
297 | =item terminate [arg...] |
308 | =item terminate [arg...] |
298 | |
309 | |
299 | Terminates the current coroutine with the given status values (see L<cancel>). |
310 | Terminates the current coroutine with the given status values (see L<cancel>). |
300 | |
311 | |
… | |
… | |
319 | Create a new coroutine and return it. When the sub returns the coroutine |
330 | Create a new coroutine and return it. When the sub returns the coroutine |
320 | automatically terminates as if C<terminate> with the returned values were |
331 | automatically terminates as if C<terminate> with the returned values were |
321 | called. To make the coroutine run you must first put it into the ready queue |
332 | called. To make the coroutine run you must first put it into the ready queue |
322 | by calling the ready method. |
333 | by calling the ready method. |
323 | |
334 | |
324 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
335 | See C<async> for additional discussion. |
325 | |
336 | |
326 | =cut |
337 | =cut |
327 | |
338 | |
328 | sub _run_coro { |
339 | sub _run_coro { |
329 | terminate &{+shift}; |
340 | terminate &{+shift}; |
… | |
… | |
452 | =over 4 |
463 | =over 4 |
453 | |
464 | |
454 | =item Coro::nready |
465 | =item Coro::nready |
455 | |
466 | |
456 | Returns the number of coroutines that are currently in the ready state, |
467 | Returns the number of coroutines that are currently in the ready state, |
457 | i.e. that can be swicthed to. The value C<0> means that the only runnable |
468 | i.e. that can be switched to. The value C<0> means that the only runnable |
458 | coroutine is the currently running one, so C<cede> would have no effect, |
469 | coroutine is the currently running one, so C<cede> would have no effect, |
459 | and C<schedule> would cause a deadlock unless there is an idle handler |
470 | and C<schedule> would cause a deadlock unless there is an idle handler |
460 | that wakes up some coroutines. |
471 | that wakes up some coroutines. |
461 | |
472 | |
462 | =item my $guard = Coro::guard { ... } |
473 | =item my $guard = Coro::guard { ... } |
463 | |
474 | |
464 | This creates and returns a guard object. Nothing happens until the objetc |
475 | This creates and returns a guard object. Nothing happens until the object |
465 | gets destroyed, in which case the codeblock given as argument will be |
476 | gets destroyed, in which case the codeblock given as argument will be |
466 | executed. This is useful to free locks or other resources in case of a |
477 | executed. This is useful to free locks or other resources in case of a |
467 | runtime error or when the coroutine gets canceled, as in both cases the |
478 | runtime error or when the coroutine gets canceled, as in both cases the |
468 | guard block will be executed. The guard object supports only one method, |
479 | guard block will be executed. The guard object supports only one method, |
469 | C<< ->cancel >>, which will keep the codeblock from being executed. |
480 | C<< ->cancel >>, which will keep the codeblock from being executed. |
… | |
… | |
498 | This utility function takes a BLOCK or code reference and "unblocks" it, |
509 | This utility function takes a BLOCK or code reference and "unblocks" it, |
499 | returning the new coderef. This means that the new coderef will return |
510 | returning the new coderef. This means that the new coderef will return |
500 | immediately without blocking, returning nothing, while the original code |
511 | immediately without blocking, returning nothing, while the original code |
501 | ref will be called (with parameters) from within its own coroutine. |
512 | ref will be called (with parameters) from within its own coroutine. |
502 | |
513 | |
503 | The reason this fucntion exists is that many event libraries (such as the |
514 | The reason this function exists is that many event libraries (such as the |
504 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
515 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
505 | of thread-safety). This means you must not block within event callbacks, |
516 | of thread-safety). This means you must not block within event callbacks, |
506 | otherwise you might suffer from crashes or worse. |
517 | otherwise you might suffer from crashes or worse. |
507 | |
518 | |
508 | This function allows your callbacks to block by executing them in another |
519 | This function allows your callbacks to block by executing them in another |
… | |
… | |
520 | # we create a special coro because we want to cede, |
531 | # we create a special coro because we want to cede, |
521 | # to reduce pressure on the coro pool (because most callbacks |
532 | # to reduce pressure on the coro pool (because most callbacks |
522 | # return immediately and can be reused) and because we cannot cede |
533 | # return immediately and can be reused) and because we cannot cede |
523 | # inside an event callback. |
534 | # inside an event callback. |
524 | our $unblock_scheduler = async { |
535 | our $unblock_scheduler = async { |
|
|
536 | $current->desc ("[unblock_sub scheduler]"); |
525 | while () { |
537 | while () { |
526 | while (my $cb = pop @unblock_queue) { |
538 | while (my $cb = pop @unblock_queue) { |
527 | # this is an inlined copy of async_pool |
539 | # this is an inlined copy of async_pool |
528 | my $coro = (pop @pool or new Coro \&pool_handler); |
540 | my $coro = (pop @pool or new Coro \&pool_handler); |
529 | |
541 | |
… | |
… | |
554 | |
566 | |
555 | - you must make very sure that no coro is still active on global |
567 | - you must make very sure that no coro is still active on global |
556 | destruction. very bad things might happen otherwise (usually segfaults). |
568 | destruction. very bad things might happen otherwise (usually segfaults). |
557 | |
569 | |
558 | - this module is not thread-safe. You should only ever use this module |
570 | - this module is not thread-safe. You should only ever use this module |
559 | from the same thread (this requirement might be losened in the future |
571 | from the same thread (this requirement might be loosened in the future |
560 | to allow per-thread schedulers, but Coro::State does not yet allow |
572 | to allow per-thread schedulers, but Coro::State does not yet allow |
561 | this). |
573 | this). |
562 | |
574 | |
563 | =head1 SEE ALSO |
575 | =head1 SEE ALSO |
564 | |
576 | |