… | |
… | |
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.56'; |
56 | |
56 | |
57 | our @EXPORT = qw(async 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 | ); |
61 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
61 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
62 | |
62 | |
… | |
… | |
185 | |
185 | |
186 | Create a new asynchronous coroutine and return it's coroutine object |
186 | Create a new asynchronous coroutine and return it's coroutine object |
187 | (usually unused). When the sub returns the new coroutine is automatically |
187 | (usually unused). When the sub returns the new coroutine is automatically |
188 | terminated. |
188 | terminated. |
189 | |
189 | |
190 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
190 | Calling C<exit> in a coroutine will try to do the same as calling exit |
|
|
191 | outside the coroutine, but this is experimental. It is best not to rely on |
|
|
192 | exit doing any cleanups or even not crashing. |
191 | |
193 | |
192 | When the coroutine dies, the program will exit, just as in the main |
194 | When the coroutine dies, the program will exit, just as in the main |
193 | program. |
195 | program. |
194 | |
196 | |
195 | # create a new coroutine that just prints its arguments |
197 | # create a new coroutine that just prints its arguments |
… | |
… | |
198 | } 1,2,3,4; |
200 | } 1,2,3,4; |
199 | |
201 | |
200 | =cut |
202 | =cut |
201 | |
203 | |
202 | sub async(&@) { |
204 | sub async(&@) { |
203 | my $pid = new Coro @_; |
205 | my $coro = new Coro @_; |
204 | $pid->ready; |
206 | $coro->ready; |
205 | $pid |
207 | $coro |
|
|
208 | } |
|
|
209 | |
|
|
210 | =item async_pool { ... } [@args...] |
|
|
211 | |
|
|
212 | Similar to C<async>, but uses a coroutine pool, so you should not call |
|
|
213 | terminate or join (although you are allowed to), and you get a coroutine |
|
|
214 | that might have executed other code already (which can be good or bad :). |
|
|
215 | |
|
|
216 | Also, the block is executed in an C<eval> context and a warning will be |
|
|
217 | issued in case of an exception instead of terminating the program, as |
|
|
218 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
|
|
219 | will not work in the expected way, unless you call terminate or cancel, |
|
|
220 | which somehow defeats the purpose of pooling. |
|
|
221 | |
|
|
222 | The priority will be reset to C<0> after each job, otherwise the coroutine |
|
|
223 | will be re-used "as-is". |
|
|
224 | |
|
|
225 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
|
|
226 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
|
|
227 | required. |
|
|
228 | |
|
|
229 | If you are concerned about pooled coroutines growing a lot because a |
|
|
230 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool { |
|
|
231 | terminate }> once per second or so to slowly replenish the pool. |
|
|
232 | |
|
|
233 | =cut |
|
|
234 | |
|
|
235 | our $POOL_SIZE = 8; |
|
|
236 | our @pool; |
|
|
237 | |
|
|
238 | sub pool_handler { |
|
|
239 | while () { |
|
|
240 | eval { |
|
|
241 | my ($cb, @arg) = @{ delete $current->{_invoke} or return }; |
|
|
242 | $cb->(@arg); |
|
|
243 | }; |
|
|
244 | warn $@ if $@; |
|
|
245 | |
|
|
246 | last if @pool >= $POOL_SIZE; |
|
|
247 | push @pool, $current; |
|
|
248 | |
|
|
249 | $current->save (Coro::State::SAVE_DEF); |
|
|
250 | $current->prio (0); |
|
|
251 | schedule; |
|
|
252 | } |
|
|
253 | } |
|
|
254 | |
|
|
255 | sub async_pool(&@) { |
|
|
256 | # this is also inlined into the unlock_scheduler |
|
|
257 | my $coro = (pop @pool or new Coro \&pool_handler); |
|
|
258 | |
|
|
259 | $coro->{_invoke} = [@_]; |
|
|
260 | $coro->ready; |
|
|
261 | |
|
|
262 | $coro |
206 | } |
263 | } |
207 | |
264 | |
208 | =item schedule |
265 | =item schedule |
209 | |
266 | |
210 | Calls the scheduler. Please note that the current coroutine will not be put |
267 | Calls the scheduler. Please note that the current coroutine will not be put |
… | |
… | |
235 | |
292 | |
236 | "Cede" to other coroutines. This function puts the current coroutine into the |
293 | "Cede" to other coroutines. This function puts the current coroutine into the |
237 | ready queue and calls C<schedule>, which has the effect of giving up the |
294 | ready queue and calls C<schedule>, which has the effect of giving up the |
238 | current "timeslice" to other coroutines of the same or higher priority. |
295 | current "timeslice" to other coroutines of the same or higher priority. |
239 | |
296 | |
|
|
297 | Returns true if at least one coroutine switch has happened. |
|
|
298 | |
240 | =item Coro::cede_notself |
299 | =item Coro::cede_notself |
241 | |
300 | |
242 | Works like cede, but is not exported by default and will cede to any |
301 | Works like cede, but is not exported by default and will cede to any |
243 | coroutine, regardless of priority, once. |
302 | coroutine, regardless of priority, once. |
|
|
303 | |
|
|
304 | Returns true if at least one coroutine switch has happened. |
244 | |
305 | |
245 | =item terminate [arg...] |
306 | =item terminate [arg...] |
246 | |
307 | |
247 | Terminates the current coroutine with the given status values (see L<cancel>). |
308 | Terminates the current coroutine with the given status values (see L<cancel>). |
248 | |
309 | |
… | |
… | |
267 | Create a new coroutine and return it. When the sub returns the coroutine |
328 | Create a new coroutine and return it. When the sub returns the coroutine |
268 | automatically terminates as if C<terminate> with the returned values were |
329 | automatically terminates as if C<terminate> with the returned values were |
269 | called. To make the coroutine run you must first put it into the ready queue |
330 | called. To make the coroutine run you must first put it into the ready queue |
270 | by calling the ready method. |
331 | by calling the ready method. |
271 | |
332 | |
272 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
333 | See C<async> for additional discussion. |
273 | |
334 | |
274 | =cut |
335 | =cut |
275 | |
336 | |
276 | sub _run_coro { |
337 | sub _run_coro { |
277 | terminate &{+shift}; |
338 | terminate &{+shift}; |
… | |
… | |
407 | and C<schedule> would cause a deadlock unless there is an idle handler |
468 | and C<schedule> would cause a deadlock unless there is an idle handler |
408 | that wakes up some coroutines. |
469 | that wakes up some coroutines. |
409 | |
470 | |
410 | =item my $guard = Coro::guard { ... } |
471 | =item my $guard = Coro::guard { ... } |
411 | |
472 | |
412 | This creates and returns a guard object. Nothing happens until the objetc |
473 | This creates and returns a guard object. Nothing happens until the object |
413 | gets destroyed, in which case the codeblock given as argument will be |
474 | gets destroyed, in which case the codeblock given as argument will be |
414 | executed. This is useful to free locks or other resources in case of a |
475 | executed. This is useful to free locks or other resources in case of a |
415 | runtime error or when the coroutine gets canceled, as in both cases the |
476 | runtime error or when the coroutine gets canceled, as in both cases the |
416 | guard block will be executed. The guard object supports only one method, |
477 | guard block will be executed. The guard object supports only one method, |
417 | C<< ->cancel >>, which will keep the codeblock from being executed. |
478 | C<< ->cancel >>, which will keep the codeblock from being executed. |
… | |
… | |
461 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
522 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
462 | creating event callbacks that want to block. |
523 | creating event callbacks that want to block. |
463 | |
524 | |
464 | =cut |
525 | =cut |
465 | |
526 | |
466 | our @unblock_pool; |
|
|
467 | our @unblock_queue; |
527 | our @unblock_queue; |
468 | our $UNBLOCK_POOL_SIZE = 2; |
|
|
469 | |
528 | |
470 | sub unblock_handler_ { |
529 | # we create a special coro because we want to cede, |
471 | while () { |
530 | # to reduce pressure on the coro pool (because most callbacks |
472 | my ($cb, @arg) = @{ delete $Coro::current->{arg} }; |
531 | # return immediately and can be reused) and because we cannot cede |
473 | $cb->(@arg); |
532 | # inside an event callback. |
474 | |
|
|
475 | last if @unblock_pool >= $UNBLOCK_POOL_SIZE; |
|
|
476 | push @unblock_pool, $Coro::current; |
|
|
477 | schedule; |
|
|
478 | } |
|
|
479 | } |
|
|
480 | |
|
|
481 | our $unblock_scheduler = async { |
533 | our $unblock_scheduler = async { |
482 | while () { |
534 | while () { |
483 | while (my $cb = pop @unblock_queue) { |
535 | while (my $cb = pop @unblock_queue) { |
|
|
536 | # this is an inlined copy of async_pool |
484 | my $handler = (pop @unblock_pool or new Coro \&unblock_handler_); |
537 | my $coro = (pop @pool or new Coro \&pool_handler); |
485 | $handler->{arg} = $cb; |
538 | |
|
|
539 | $coro->{_invoke} = $cb; |
486 | $handler->ready; |
540 | $coro->ready; |
487 | cede; |
541 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
488 | } |
542 | } |
489 | |
543 | schedule; # sleep well |
490 | schedule; |
|
|
491 | } |
544 | } |
492 | }; |
545 | }; |
493 | |
546 | |
494 | sub unblock_sub(&) { |
547 | sub unblock_sub(&) { |
495 | my $cb = shift; |
548 | my $cb = shift; |
496 | |
549 | |
497 | sub { |
550 | sub { |
498 | push @unblock_queue, [$cb, @_]; |
551 | unshift @unblock_queue, [$cb, @_]; |
499 | $unblock_scheduler->ready; |
552 | $unblock_scheduler->ready; |
500 | } |
553 | } |
501 | } |
554 | } |
502 | |
555 | |
503 | =back |
556 | =back |