… | |
… | |
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.63'; |
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 | |
… | |
… | |
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... |
… | |
… | |
141 | $idle = sub { |
141 | $idle = sub { |
142 | require Carp; |
142 | require Carp; |
143 | Carp::croak ("FATAL: deadlock detected"); |
143 | Carp::croak ("FATAL: deadlock detected"); |
144 | }; |
144 | }; |
145 | |
145 | |
|
|
146 | sub _cancel { |
|
|
147 | my ($self) = @_; |
|
|
148 | |
|
|
149 | # free coroutine data and mark as destructed |
|
|
150 | $self->_destroy |
|
|
151 | or return; |
|
|
152 | |
|
|
153 | # call all destruction callbacks |
|
|
154 | $_->(@{$self->{status}}) |
|
|
155 | for @{(delete $self->{destroy_cb}) || []}; |
|
|
156 | } |
|
|
157 | |
146 | # this coroutine is necessary because a coroutine |
158 | # this coroutine is necessary because a coroutine |
147 | # cannot destroy itself. |
159 | # cannot destroy itself. |
148 | my @destroy; |
160 | my @destroy; |
|
|
161 | my $manager; |
|
|
162 | |
149 | my $manager; $manager = new Coro sub { |
163 | $manager = new Coro sub { |
150 | while () { |
164 | while () { |
151 | # by overwriting the state object with the manager we destroy it |
165 | (shift @destroy)->_cancel |
152 | # while still being able to schedule this coroutine (in case it has |
|
|
153 | # been readied multiple times. this is harmless since the manager |
|
|
154 | # can be called as many times as neccessary and will always |
|
|
155 | # remove itself from the runqueue |
|
|
156 | while (@destroy) { |
166 | while @destroy; |
157 | my $coro = pop @destroy; |
|
|
158 | |
167 | |
159 | $coro->{status} ||= []; |
|
|
160 | |
|
|
161 | $_->ready for @{(delete $coro->{join} ) || []}; |
|
|
162 | $_->(@{$coro->{status}}) for @{(delete $coro->{destroy_cb}) || []}; |
|
|
163 | |
|
|
164 | # the next line destroys the coro state, but keeps the |
|
|
165 | # coroutine itself intact (we basically make it a zombie |
|
|
166 | # coroutine that always runs the manager thread, so it's possible |
|
|
167 | # to transfer() to this coroutine). |
|
|
168 | $coro->_clone_state_from ($manager); |
|
|
169 | } |
|
|
170 | &schedule; |
168 | &schedule; |
171 | } |
169 | } |
172 | }; |
170 | }; |
|
|
171 | |
|
|
172 | $manager->prio (PRIO_MAX); |
173 | |
173 | |
174 | # static methods. not really. |
174 | # static methods. not really. |
175 | |
175 | |
176 | =back |
176 | =back |
177 | |
177 | |
… | |
… | |
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 do the same as calling exit outside |
191 | |
191 | 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 |
192 | just as it would in the main program. |
193 | program. |
|
|
194 | |
193 | |
195 | # create a new coroutine that just prints its arguments |
194 | # create a new coroutine that just prints its arguments |
196 | async { |
195 | async { |
197 | print "@_\n"; |
196 | print "@_\n"; |
198 | } 1,2,3,4; |
197 | } 1,2,3,4; |
199 | |
198 | |
200 | =cut |
199 | =cut |
201 | |
200 | |
202 | sub async(&@) { |
201 | sub async(&@) { |
203 | my $pid = new Coro @_; |
202 | my $coro = new Coro @_; |
204 | $pid->ready; |
203 | $coro->ready; |
205 | $pid |
204 | $coro |
|
|
205 | } |
|
|
206 | |
|
|
207 | =item async_pool { ... } [@args...] |
|
|
208 | |
|
|
209 | Similar to C<async>, but uses a coroutine pool, so you should not call |
|
|
210 | terminate or join (although you are allowed to), and you get a coroutine |
|
|
211 | that might have executed other code already (which can be good or bad :). |
|
|
212 | |
|
|
213 | Also, the block is executed in an C<eval> context and a warning will be |
|
|
214 | issued in case of an exception instead of terminating the program, as |
|
|
215 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
|
|
216 | will not work in the expected way, unless you call terminate or cancel, |
|
|
217 | which somehow defeats the purpose of pooling. |
|
|
218 | |
|
|
219 | The priority will be reset to C<0> after each job, otherwise the coroutine |
|
|
220 | will be re-used "as-is". |
|
|
221 | |
|
|
222 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
|
|
223 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
|
|
224 | required. |
|
|
225 | |
|
|
226 | If you are concerned about pooled coroutines growing a lot because a |
|
|
227 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool { |
|
|
228 | terminate }> once per second or so to slowly replenish the pool. |
|
|
229 | |
|
|
230 | =cut |
|
|
231 | |
|
|
232 | our $POOL_SIZE = 8; |
|
|
233 | our @pool; |
|
|
234 | |
|
|
235 | sub pool_handler { |
|
|
236 | while () { |
|
|
237 | eval { |
|
|
238 | my ($cb, @arg) = @{ delete $current->{_invoke} or return }; |
|
|
239 | $cb->(@arg); |
|
|
240 | }; |
|
|
241 | warn $@ if $@; |
|
|
242 | |
|
|
243 | last if @pool >= $POOL_SIZE; |
|
|
244 | push @pool, $current; |
|
|
245 | |
|
|
246 | $current->save (Coro::State::SAVE_DEF); |
|
|
247 | $current->prio (0); |
|
|
248 | schedule; |
|
|
249 | } |
|
|
250 | } |
|
|
251 | |
|
|
252 | sub async_pool(&@) { |
|
|
253 | # this is also inlined into the unlock_scheduler |
|
|
254 | my $coro = (pop @pool or new Coro \&pool_handler); |
|
|
255 | |
|
|
256 | $coro->{_invoke} = [@_]; |
|
|
257 | $coro->ready; |
|
|
258 | |
|
|
259 | $coro |
206 | } |
260 | } |
207 | |
261 | |
208 | =item schedule |
262 | =item schedule |
209 | |
263 | |
210 | Calls the scheduler. Please note that the current coroutine will not be put |
264 | Calls the scheduler. Please note that the current coroutine will not be put |
… | |
… | |
223 | # wake up sleeping coroutine |
277 | # wake up sleeping coroutine |
224 | $current->ready; |
278 | $current->ready; |
225 | undef $current; |
279 | undef $current; |
226 | }; |
280 | }; |
227 | |
281 | |
228 | # call schedule until event occured. |
282 | # call schedule until event occurred. |
229 | # in case we are woken up for other reasons |
283 | # in case we are woken up for other reasons |
230 | # (current still defined), loop. |
284 | # (current still defined), loop. |
231 | Coro::schedule while $current; |
285 | Coro::schedule while $current; |
232 | } |
286 | } |
233 | |
287 | |
234 | =item cede |
288 | =item cede |
235 | |
289 | |
236 | "Cede" to other coroutines. This function puts the current coroutine into the |
290 | "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 |
291 | 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. |
292 | current "timeslice" to other coroutines of the same or higher priority. |
|
|
293 | |
|
|
294 | Returns true if at least one coroutine switch has happened. |
|
|
295 | |
|
|
296 | =item Coro::cede_notself |
|
|
297 | |
|
|
298 | Works like cede, but is not exported by default and will cede to any |
|
|
299 | coroutine, regardless of priority, once. |
|
|
300 | |
|
|
301 | Returns true if at least one coroutine switch has happened. |
239 | |
302 | |
240 | =item terminate [arg...] |
303 | =item terminate [arg...] |
241 | |
304 | |
242 | Terminates the current coroutine with the given status values (see L<cancel>). |
305 | Terminates the current coroutine with the given status values (see L<cancel>). |
243 | |
306 | |
… | |
… | |
262 | Create a new coroutine and return it. When the sub returns the coroutine |
325 | Create a new coroutine and return it. When the sub returns the coroutine |
263 | automatically terminates as if C<terminate> with the returned values were |
326 | automatically terminates as if C<terminate> with the returned values were |
264 | called. To make the coroutine run you must first put it into the ready queue |
327 | called. To make the coroutine run you must first put it into the ready queue |
265 | by calling the ready method. |
328 | by calling the ready method. |
266 | |
329 | |
267 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
330 | See C<async> for additional discussion. |
268 | |
331 | |
269 | =cut |
332 | =cut |
270 | |
333 | |
271 | sub _run_coro { |
334 | sub _run_coro { |
272 | terminate &{+shift}; |
335 | terminate &{+shift}; |
… | |
… | |
289 | Return wether the coroutine is currently the ready queue or not, |
352 | Return wether the coroutine is currently the ready queue or not, |
290 | |
353 | |
291 | =item $coroutine->cancel (arg...) |
354 | =item $coroutine->cancel (arg...) |
292 | |
355 | |
293 | Terminates the given coroutine and makes it return the given arguments as |
356 | Terminates the given coroutine and makes it return the given arguments as |
294 | status (default: the empty list). |
357 | status (default: the empty list). Never returns if the coroutine is the |
|
|
358 | current coroutine. |
295 | |
359 | |
296 | =cut |
360 | =cut |
297 | |
361 | |
298 | sub cancel { |
362 | sub cancel { |
299 | my $self = shift; |
363 | my $self = shift; |
300 | $self->{status} = [@_]; |
364 | $self->{status} = [@_]; |
|
|
365 | |
|
|
366 | if ($current == $self) { |
301 | push @destroy, $self; |
367 | push @destroy, $self; |
302 | $manager->ready; |
368 | $manager->ready; |
303 | &schedule if $current == $self; |
369 | &schedule while 1; |
|
|
370 | } else { |
|
|
371 | $self->_cancel; |
|
|
372 | } |
304 | } |
373 | } |
305 | |
374 | |
306 | =item $coroutine->join |
375 | =item $coroutine->join |
307 | |
376 | |
308 | Wait until the coroutine terminates and return any values given to the |
377 | Wait until the coroutine terminates and return any values given to the |
… | |
… | |
311 | |
380 | |
312 | =cut |
381 | =cut |
313 | |
382 | |
314 | sub join { |
383 | sub join { |
315 | my $self = shift; |
384 | my $self = shift; |
|
|
385 | |
316 | unless ($self->{status}) { |
386 | unless ($self->{status}) { |
317 | push @{$self->{join}}, $current; |
387 | my $current = $current; |
318 | &schedule; |
388 | |
|
|
389 | push @{$self->{destroy_cb}}, sub { |
|
|
390 | $current->ready; |
|
|
391 | undef $current; |
|
|
392 | }; |
|
|
393 | |
|
|
394 | &schedule while $current; |
319 | } |
395 | } |
|
|
396 | |
320 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
397 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
321 | } |
398 | } |
322 | |
399 | |
323 | =item $coroutine->on_destroy (\&cb) |
400 | =item $coroutine->on_destroy (\&cb) |
324 | |
401 | |
… | |
… | |
381 | =over 4 |
458 | =over 4 |
382 | |
459 | |
383 | =item Coro::nready |
460 | =item Coro::nready |
384 | |
461 | |
385 | Returns the number of coroutines that are currently in the ready state, |
462 | Returns the number of coroutines that are currently in the ready state, |
386 | i.e. that can be swicthed to. The value C<0> means that the only runnable |
463 | i.e. that can be switched to. The value C<0> means that the only runnable |
387 | coroutine is the currently running one, so C<cede> would have no effect, |
464 | coroutine is the currently running one, so C<cede> would have no effect, |
388 | and C<schedule> would cause a deadlock unless there is an idle handler |
465 | and C<schedule> would cause a deadlock unless there is an idle handler |
389 | that wakes up some coroutines. |
466 | that wakes up some coroutines. |
|
|
467 | |
|
|
468 | =item my $guard = Coro::guard { ... } |
|
|
469 | |
|
|
470 | This creates and returns a guard object. Nothing happens until the object |
|
|
471 | gets destroyed, in which case the codeblock given as argument will be |
|
|
472 | executed. This is useful to free locks or other resources in case of a |
|
|
473 | runtime error or when the coroutine gets canceled, as in both cases the |
|
|
474 | guard block will be executed. The guard object supports only one method, |
|
|
475 | C<< ->cancel >>, which will keep the codeblock from being executed. |
|
|
476 | |
|
|
477 | Example: set some flag and clear it again when the coroutine gets canceled |
|
|
478 | or the function returns: |
|
|
479 | |
|
|
480 | sub do_something { |
|
|
481 | my $guard = Coro::guard { $busy = 0 }; |
|
|
482 | $busy = 1; |
|
|
483 | |
|
|
484 | # do something that requires $busy to be true |
|
|
485 | } |
|
|
486 | |
|
|
487 | =cut |
|
|
488 | |
|
|
489 | sub guard(&) { |
|
|
490 | bless \(my $cb = $_[0]), "Coro::guard" |
|
|
491 | } |
|
|
492 | |
|
|
493 | sub Coro::guard::cancel { |
|
|
494 | ${$_[0]} = sub { }; |
|
|
495 | } |
|
|
496 | |
|
|
497 | sub Coro::guard::DESTROY { |
|
|
498 | ${$_[0]}->(); |
|
|
499 | } |
|
|
500 | |
390 | |
501 | |
391 | =item unblock_sub { ... } |
502 | =item unblock_sub { ... } |
392 | |
503 | |
393 | This utility function takes a BLOCK or code reference and "unblocks" it, |
504 | This utility function takes a BLOCK or code reference and "unblocks" it, |
394 | returning the new coderef. This means that the new coderef will return |
505 | returning the new coderef. This means that the new coderef will return |
395 | immediately without blocking, returning nothing, while the original code |
506 | immediately without blocking, returning nothing, while the original code |
396 | ref will be called (with parameters) from within its own coroutine. |
507 | ref will be called (with parameters) from within its own coroutine. |
397 | |
508 | |
398 | The reason this fucntion exists is that many event libraries (such as the |
509 | The reason this function exists is that many event libraries (such as the |
399 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
510 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
400 | of thread-safety). This means you must not block within event callbacks, |
511 | of thread-safety). This means you must not block within event callbacks, |
401 | otherwise you might suffer from crashes or worse. |
512 | otherwise you might suffer from crashes or worse. |
402 | |
513 | |
403 | This function allows your callbacks to block by executing them in another |
514 | This function allows your callbacks to block by executing them in another |
… | |
… | |
408 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
519 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
409 | creating event callbacks that want to block. |
520 | creating event callbacks that want to block. |
410 | |
521 | |
411 | =cut |
522 | =cut |
412 | |
523 | |
413 | our @unblock_pool; |
|
|
414 | our @unblock_queue; |
524 | our @unblock_queue; |
415 | our $UNBLOCK_POOL_SIZE = 2; |
|
|
416 | |
525 | |
417 | sub unblock_handler_ { |
526 | # we create a special coro because we want to cede, |
418 | while () { |
527 | # to reduce pressure on the coro pool (because most callbacks |
419 | my ($cb, @arg) = @{ delete $Coro::current->{arg} }; |
528 | # return immediately and can be reused) and because we cannot cede |
420 | $cb->(@arg); |
529 | # inside an event callback. |
421 | |
|
|
422 | last if @unblock_pool >= $UNBLOCK_POOL_SIZE; |
|
|
423 | push @unblock_pool, $Coro::current; |
|
|
424 | schedule; |
|
|
425 | } |
|
|
426 | } |
|
|
427 | |
|
|
428 | our $unblock_scheduler = async { |
530 | our $unblock_scheduler = async { |
429 | while () { |
531 | while () { |
430 | while (my $cb = pop @unblock_queue) { |
532 | while (my $cb = pop @unblock_queue) { |
|
|
533 | # this is an inlined copy of async_pool |
431 | my $handler = (pop @unblock_pool or new Coro \&unblock_handler_); |
534 | my $coro = (pop @pool or new Coro \&pool_handler); |
432 | $handler->{arg} = $cb; |
535 | |
|
|
536 | $coro->{_invoke} = $cb; |
433 | $handler->ready; |
537 | $coro->ready; |
434 | cede; |
538 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
435 | } |
539 | } |
436 | |
540 | schedule; # sleep well |
437 | schedule; |
|
|
438 | } |
541 | } |
439 | }; |
542 | }; |
440 | |
543 | |
441 | sub unblock_sub(&) { |
544 | sub unblock_sub(&) { |
442 | my $cb = shift; |
545 | my $cb = shift; |
443 | |
546 | |
444 | sub { |
547 | sub { |
445 | push @unblock_queue, [$cb, @_]; |
548 | unshift @unblock_queue, [$cb, @_]; |
446 | $unblock_scheduler->ready; |
549 | $unblock_scheduler->ready; |
447 | } |
550 | } |
448 | } |
551 | } |
449 | |
552 | |
450 | =back |
553 | =back |
… | |
… | |
457 | |
560 | |
458 | - you must make very sure that no coro is still active on global |
561 | - you must make very sure that no coro is still active on global |
459 | destruction. very bad things might happen otherwise (usually segfaults). |
562 | destruction. very bad things might happen otherwise (usually segfaults). |
460 | |
563 | |
461 | - this module is not thread-safe. You should only ever use this module |
564 | - this module is not thread-safe. You should only ever use this module |
462 | from the same thread (this requirement might be losened in the future |
565 | from the same thread (this requirement might be loosened in the future |
463 | to allow per-thread schedulers, but Coro::State does not yet allow |
566 | to allow per-thread schedulers, but Coro::State does not yet allow |
464 | this). |
567 | this). |
465 | |
568 | |
466 | =head1 SEE ALSO |
569 | =head1 SEE ALSO |
467 | |
570 | |