| … | |
… | |
| 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.7'; |
55 | our $VERSION = '4.0'; |
| 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 | ); |
| … | |
… | |
| 113 | reasons. If performance is not essential 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 | $main->{desc} = "[main::]"; |
|
|
119 | |
| 118 | # maybe some other module used Coro::Specific before... |
120 | # maybe some other module used Coro::Specific before... |
| 119 | $main->{specific} = $current->{specific} |
121 | $main->{_specific} = $current->{_specific} |
| 120 | if $current; |
122 | if $current; |
| 121 | |
123 | |
| 122 | _set_current $main; |
124 | _set_current $main; |
| 123 | |
125 | |
| 124 | sub current() { $current } |
126 | sub current() { $current } |
| … | |
… | |
| 149 | # free coroutine data and mark as destructed |
151 | # free coroutine data and mark as destructed |
| 150 | $self->_destroy |
152 | $self->_destroy |
| 151 | or return; |
153 | or return; |
| 152 | |
154 | |
| 153 | # call all destruction callbacks |
155 | # call all destruction callbacks |
| 154 | $_->(@{$self->{status}}) |
156 | $_->(@{$self->{_status}}) |
| 155 | for @{(delete $self->{destroy_cb}) || []}; |
157 | for @{(delete $self->{_on_destroy}) || []}; |
| 156 | } |
158 | } |
| 157 | |
159 | |
| 158 | # this coroutine is necessary because a coroutine |
160 | # this coroutine is necessary because a coroutine |
| 159 | # cannot destroy itself. |
161 | # cannot destroy itself. |
| 160 | my @destroy; |
162 | my @destroy; |
| 161 | my $manager; |
163 | my $manager; |
| 162 | |
164 | |
| 163 | $manager = new Coro sub { |
165 | $manager = new Coro sub { |
| 164 | $current->desc ("[coro manager]"); |
|
|
| 165 | |
|
|
| 166 | while () { |
166 | while () { |
| 167 | (shift @destroy)->_cancel |
167 | (shift @destroy)->_cancel |
| 168 | while @destroy; |
168 | while @destroy; |
| 169 | |
169 | |
| 170 | &schedule; |
170 | &schedule; |
| 171 | } |
171 | } |
| 172 | }; |
172 | }; |
| 173 | |
173 | $manager->desc ("[coro manager]"); |
| 174 | $manager->prio (PRIO_MAX); |
174 | $manager->prio (PRIO_MAX); |
| 175 | |
175 | |
| 176 | # static methods. not really. |
176 | # static methods. not really. |
| 177 | |
177 | |
| 178 | =back |
178 | =back |
| … | |
… | |
| 224 | 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 |
| 225 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
225 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
| 226 | required. |
226 | required. |
| 227 | |
227 | |
| 228 | If you are concerned about pooled coroutines growing a lot because a |
228 | If you are concerned about pooled coroutines growing a lot because a |
| 229 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool { |
229 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
| 230 | terminate }> once per second or so to slowly replenish the pool. |
230 | { terminate }> once per second or so to slowly replenish the pool. In |
|
|
231 | addition to that, when the stacks used by a handler grows larger than 16kb |
|
|
232 | (adjustable with $Coro::POOL_RSS) it will also exit. |
| 231 | |
233 | |
| 232 | =cut |
234 | =cut |
| 233 | |
235 | |
| 234 | our $POOL_SIZE = 8; |
236 | our $POOL_SIZE = 8; |
|
|
237 | our $POOL_RSS = 16 * 1024; |
| 235 | our @pool; |
238 | our @async_pool; |
| 236 | |
239 | |
| 237 | sub pool_handler { |
240 | sub pool_handler { |
|
|
241 | my $cb; |
|
|
242 | |
| 238 | while () { |
243 | while () { |
| 239 | $current->{desc} = "[async_pool]"; |
|
|
| 240 | |
|
|
| 241 | eval { |
244 | eval { |
| 242 | my ($cb, @arg) = @{ delete $current->{_invoke} or return }; |
245 | while () { |
| 243 | $cb->(@arg); |
246 | _pool_1 $cb; |
|
|
247 | &$cb; |
|
|
248 | _pool_2 $cb; |
|
|
249 | &schedule; |
|
|
250 | } |
| 244 | }; |
251 | }; |
|
|
252 | |
|
|
253 | last if $@ eq "\3terminate\2\n"; |
| 245 | warn $@ if $@; |
254 | warn $@ if $@; |
| 246 | |
|
|
| 247 | last if @pool >= $POOL_SIZE; |
|
|
| 248 | |
|
|
| 249 | push @pool, $current; |
|
|
| 250 | $current->{desc} = "[async_pool idle]"; |
|
|
| 251 | $current->save (Coro::State::SAVE_DEF); |
|
|
| 252 | $current->prio (0); |
|
|
| 253 | schedule; |
|
|
| 254 | } |
255 | } |
| 255 | } |
256 | } |
| 256 | |
257 | |
| 257 | sub async_pool(&@) { |
258 | sub async_pool(&@) { |
| 258 | # this is also inlined into the unlock_scheduler |
259 | # this is also inlined into the unlock_scheduler |
| 259 | my $coro = (pop @pool) || new Coro \&pool_handler;; |
260 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
| 260 | |
261 | |
| 261 | $coro->{_invoke} = [@_]; |
262 | $coro->{_invoke} = [@_]; |
| 262 | $coro->ready; |
263 | $coro->ready; |
| 263 | |
264 | |
| 264 | $coro |
265 | $coro |
| … | |
… | |
| 307 | |
308 | |
| 308 | =item terminate [arg...] |
309 | =item terminate [arg...] |
| 309 | |
310 | |
| 310 | Terminates the current coroutine with the given status values (see L<cancel>). |
311 | Terminates the current coroutine with the given status values (see L<cancel>). |
| 311 | |
312 | |
|
|
313 | =item killall |
|
|
314 | |
|
|
315 | Kills/terminates/cancels all coroutines except the currently running |
|
|
316 | one. This is useful after a fork, either in the child or the parent, as |
|
|
317 | usually only one of them should inherit the running coroutines. |
|
|
318 | |
| 312 | =cut |
319 | =cut |
| 313 | |
320 | |
| 314 | sub terminate { |
321 | sub terminate { |
| 315 | $current->cancel (@_); |
322 | $current->cancel (@_); |
|
|
323 | } |
|
|
324 | |
|
|
325 | sub killall { |
|
|
326 | for (Coro::State::list) { |
|
|
327 | $_->cancel |
|
|
328 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
329 | } |
| 316 | } |
330 | } |
| 317 | |
331 | |
| 318 | =back |
332 | =back |
| 319 | |
333 | |
| 320 | # dynamic methods |
334 | # dynamic methods |
| … | |
… | |
| 364 | |
378 | |
| 365 | =cut |
379 | =cut |
| 366 | |
380 | |
| 367 | sub cancel { |
381 | sub cancel { |
| 368 | my $self = shift; |
382 | my $self = shift; |
| 369 | $self->{status} = [@_]; |
383 | $self->{_status} = [@_]; |
| 370 | |
384 | |
| 371 | if ($current == $self) { |
385 | if ($current == $self) { |
| 372 | push @destroy, $self; |
386 | push @destroy, $self; |
| 373 | $manager->ready; |
387 | $manager->ready; |
| 374 | &schedule while 1; |
388 | &schedule while 1; |
| … | |
… | |
| 378 | } |
392 | } |
| 379 | |
393 | |
| 380 | =item $coroutine->join |
394 | =item $coroutine->join |
| 381 | |
395 | |
| 382 | Wait until the coroutine terminates and return any values given to the |
396 | Wait until the coroutine terminates and return any values given to the |
| 383 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
397 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
| 384 | from multiple coroutine. |
398 | from multiple coroutines. |
| 385 | |
399 | |
| 386 | =cut |
400 | =cut |
| 387 | |
401 | |
| 388 | sub join { |
402 | sub join { |
| 389 | my $self = shift; |
403 | my $self = shift; |
| 390 | |
404 | |
| 391 | unless ($self->{status}) { |
405 | unless ($self->{_status}) { |
| 392 | my $current = $current; |
406 | my $current = $current; |
| 393 | |
407 | |
| 394 | push @{$self->{destroy_cb}}, sub { |
408 | push @{$self->{_on_destroy}}, sub { |
| 395 | $current->ready; |
409 | $current->ready; |
| 396 | undef $current; |
410 | undef $current; |
| 397 | }; |
411 | }; |
| 398 | |
412 | |
| 399 | &schedule while $current; |
413 | &schedule while $current; |
| 400 | } |
414 | } |
| 401 | |
415 | |
| 402 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
416 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
| 403 | } |
417 | } |
| 404 | |
418 | |
| 405 | =item $coroutine->on_destroy (\&cb) |
419 | =item $coroutine->on_destroy (\&cb) |
| 406 | |
420 | |
| 407 | Registers a callback that is called when this coroutine gets destroyed, |
421 | Registers a callback that is called when this coroutine gets destroyed, |
| … | |
… | |
| 411 | =cut |
425 | =cut |
| 412 | |
426 | |
| 413 | sub on_destroy { |
427 | sub on_destroy { |
| 414 | my ($self, $cb) = @_; |
428 | my ($self, $cb) = @_; |
| 415 | |
429 | |
| 416 | push @{ $self->{destroy_cb} }, $cb; |
430 | push @{ $self->{_on_destroy} }, $cb; |
| 417 | } |
431 | } |
| 418 | |
432 | |
| 419 | =item $oldprio = $coroutine->prio ($newprio) |
433 | =item $oldprio = $coroutine->prio ($newprio) |
| 420 | |
434 | |
| 421 | Sets (or gets, if the argument is missing) the priority of the |
435 | Sets (or gets, if the argument is missing) the priority of the |
| … | |
… | |
| 445 | |
459 | |
| 446 | =item $olddesc = $coroutine->desc ($newdesc) |
460 | =item $olddesc = $coroutine->desc ($newdesc) |
| 447 | |
461 | |
| 448 | Sets (or gets in case the argument is missing) the description for this |
462 | Sets (or gets in case the argument is missing) the description for this |
| 449 | coroutine. This is just a free-form string you can associate with a coroutine. |
463 | coroutine. This is just a free-form string you can associate with a coroutine. |
|
|
464 | |
|
|
465 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
|
|
466 | can modify this member directly if you wish. |
| 450 | |
467 | |
| 451 | =cut |
468 | =cut |
| 452 | |
469 | |
| 453 | sub desc { |
470 | sub desc { |
| 454 | my $old = $_[0]{desc}; |
471 | my $old = $_[0]{desc}; |
| … | |
… | |
| 530 | |
547 | |
| 531 | # we create a special coro because we want to cede, |
548 | # we create a special coro because we want to cede, |
| 532 | # to reduce pressure on the coro pool (because most callbacks |
549 | # to reduce pressure on the coro pool (because most callbacks |
| 533 | # return immediately and can be reused) and because we cannot cede |
550 | # return immediately and can be reused) and because we cannot cede |
| 534 | # inside an event callback. |
551 | # inside an event callback. |
| 535 | our $unblock_scheduler = async { |
552 | our $unblock_scheduler = new Coro sub { |
| 536 | $current->desc ("[unblock_sub scheduler]"); |
|
|
| 537 | while () { |
553 | while () { |
| 538 | while (my $cb = pop @unblock_queue) { |
554 | while (my $cb = pop @unblock_queue) { |
| 539 | # this is an inlined copy of async_pool |
555 | # this is an inlined copy of async_pool |
| 540 | my $coro = (pop @pool or new Coro \&pool_handler); |
556 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
| 541 | |
557 | |
| 542 | $coro->{_invoke} = $cb; |
558 | $coro->{_invoke} = $cb; |
| 543 | $coro->ready; |
559 | $coro->ready; |
| 544 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
560 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
| 545 | } |
561 | } |
| 546 | schedule; # sleep well |
562 | schedule; # sleep well |
| 547 | } |
563 | } |
| 548 | }; |
564 | }; |
|
|
565 | $unblock_scheduler->desc ("[unblock_sub scheduler]"); |
| 549 | |
566 | |
| 550 | sub unblock_sub(&) { |
567 | sub unblock_sub(&) { |
| 551 | my $cb = shift; |
568 | my $cb = shift; |
| 552 | |
569 | |
| 553 | sub { |
570 | sub { |
