ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro.pm
(Generate patch)

Comparing Coro/Coro.pm (file contents):
Revision 1.126 by root, Sat May 26 15:33:25 2007 UTC vs.
Revision 1.142 by root, Tue Oct 2 23:16:24 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines