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

Comparing Coro/Coro.pm (file contents):
Revision 1.114 by root, Wed Jan 24 16:22:08 2007 UTC vs.
Revision 1.133 by root, Fri Sep 21 01:23:58 2007 UTC

… …
20 20
21=head1 DESCRIPTION 21=head1 DESCRIPTION
22 22
23This module collection manages coroutines. Coroutines are similar 23This module collection manages coroutines. Coroutines are similar
24to threads but don't run in parallel at the same time even on SMP 24to threads but don't run in parallel at the same time even on SMP
25machines. The specific flavor of coroutine use din this module also 25machines. The specific flavor of coroutine used in this module also
26guarentees you that it will not switch between coroutines unless 26guarantees you that it will not switch between coroutines unless
27necessary, at easily-identified points in your program, so locking and 27necessary, at easily-identified points in your program, so locking and
28parallel access are rarely an issue, making coroutine programming much 28parallel access are rarely an issue, making coroutine programming much
29safer than threads programming. 29safer 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
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.5'; 55our $VERSION = '3.7';
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);
… …
108 108
109The current coroutine (the last coroutine switched to). The initial value 109The current coroutine (the last coroutine switched to). The initial value
110is C<$main> (of course). 110is C<$main> (of course).
111 111
112This variable is B<strictly> I<read-only>. It is provided for performance 112This variable is B<strictly> I<read-only>. It is provided for performance
113reasons. If performance is not essentiel 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
118$main->{desc} = "[main::]";
117 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
… …
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
… …
185 187
186Create a new asynchronous coroutine and return it's coroutine object 188Create 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
188terminated. 190terminated.
189 191
190Calling C<exit> in a coroutine will not work correctly, so do not do that. 192Calling C<exit> in a coroutine will do the same as calling exit outside
191 193the coroutine. Likewise, when the coroutine dies, the program will exit,
192When the coroutine dies, the program will exit, just as in the main 194just as it would in the main program.
193program.
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;
… …
223The 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
224changing $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
225required. 226required.
226 227
227If you are concerned about pooled coroutines growing a lot because a 228If you are concerned about pooled coroutines growing a lot because a
228single 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
229terminate }> 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::MAX_POOL_RSS) it will also exit.
230 233
231=cut 234=cut
232 235
233our $POOL_SIZE = 8; 236our $POOL_SIZE = 8;
237our $MAX_POOL_RSS = 16 * 1024;
234our @pool; 238our @pool;
235 239
236sub pool_handler { 240sub pool_handler {
237 while () { 241 while () {
242 $current->{desc} = "[async_pool]";
243
238 eval { 244 eval {
239 my ($cb, @arg) = @{ delete $current->{_invoke} or return }; 245 my ($cb, @arg) = @{ delete $current->{_invoke} or return };
240 $cb->(@arg); 246 $cb->(@arg);
241 }; 247 };
242 warn $@ if $@; 248 warn $@ if $@;
243 249
244 last if @pool >= $POOL_SIZE; 250 last if @pool >= $POOL_SIZE || $current->rss >= $MAX_POOL_RSS;
251
245 push @pool, $current; 252 push @pool, $current;
246 253 $current->{desc} = "[async_pool idle]";
254 $current->save (Coro::State::SAVE_DEF);
247 $current->prio (0); 255 $current->prio (0);
248 schedule; 256 schedule;
249 } 257 }
250} 258}
251 259
252sub async_pool(&@) { 260sub async_pool(&@) {
253 # this is also inlined into the unlock_scheduler 261 # this is also inlined into the unlock_scheduler
254 my $coro = (pop @pool or new Coro \&pool_handler); 262 my $coro = (pop @pool) || new Coro \&pool_handler;;
255 263
256 $coro->{_invoke} = [@_]; 264 $coro->{_invoke} = [@_];
257 $coro->ready; 265 $coro->ready;
258 266
259 $coro 267 $coro
… …
277 # wake up sleeping coroutine 285 # wake up sleeping coroutine
278 $current->ready; 286 $current->ready;
279 undef $current; 287 undef $current;
280 }; 288 };
281 289
282 # call schedule until event occured. 290 # call schedule until event occurred.
283 # in case we are woken up for other reasons 291 # in case we are woken up for other reasons
284 # (current still defined), loop. 292 # (current still defined), loop.
285 Coro::schedule while $current; 293 Coro::schedule while $current;
286 } 294 }
287 295
… …
325Create a new coroutine and return it. When the sub returns the coroutine 333Create a new coroutine and return it. When the sub returns the coroutine
326automatically terminates as if C<terminate> with the returned values were 334automatically terminates as if C<terminate> with the returned values were
327called. To make the coroutine run you must first put it into the ready queue 335called. To make the coroutine run you must first put it into the ready queue
328by calling the ready method. 336by calling the ready method.
329 337
330Calling C<exit> in a coroutine will not work correctly, so do not do that. 338See C<async> for additional discussion.
331 339
332=cut 340=cut
333 341
334sub _run_coro { 342sub _run_coro {
335 terminate &{+shift}; 343 terminate &{+shift};
… …
458=over 4 466=over 4
459 467
460=item Coro::nready 468=item Coro::nready
461 469
462Returns the number of coroutines that are currently in the ready state, 470Returns the number of coroutines that are currently in the ready state,
463i.e. that can be swicthed to. The value C<0> means that the only runnable 471i.e. that can be switched to. The value C<0> means that the only runnable
464coroutine is the currently running one, so C<cede> would have no effect, 472coroutine is the currently running one, so C<cede> would have no effect,
465and C<schedule> would cause a deadlock unless there is an idle handler 473and C<schedule> would cause a deadlock unless there is an idle handler
466that wakes up some coroutines. 474that wakes up some coroutines.
467 475
468=item my $guard = Coro::guard { ... } 476=item my $guard = Coro::guard { ... }
469 477
470This creates and returns a guard object. Nothing happens until the objetc 478This creates and returns a guard object. Nothing happens until the object
471gets destroyed, in which case the codeblock given as argument will be 479gets destroyed, in which case the codeblock given as argument will be
472executed. This is useful to free locks or other resources in case of a 480executed. This is useful to free locks or other resources in case of a
473runtime error or when the coroutine gets canceled, as in both cases the 481runtime error or when the coroutine gets canceled, as in both cases the
474guard block will be executed. The guard object supports only one method, 482guard block will be executed. The guard object supports only one method,
475C<< ->cancel >>, which will keep the codeblock from being executed. 483C<< ->cancel >>, which will keep the codeblock from being executed.
… …
504This utility function takes a BLOCK or code reference and "unblocks" it, 512This utility function takes a BLOCK or code reference and "unblocks" it,
505returning the new coderef. This means that the new coderef will return 513returning the new coderef. This means that the new coderef will return
506immediately without blocking, returning nothing, while the original code 514immediately without blocking, returning nothing, while the original code
507ref will be called (with parameters) from within its own coroutine. 515ref will be called (with parameters) from within its own coroutine.
508 516
509The reason this fucntion exists is that many event libraries (such as the 517The reason this function exists is that many event libraries (such as the
510venerable L<Event|Event> module) are not coroutine-safe (a weaker form 518venerable L<Event|Event> module) are not coroutine-safe (a weaker form
511of thread-safety). This means you must not block within event callbacks, 519of thread-safety). This means you must not block within event callbacks,
512otherwise you might suffer from crashes or worse. 520otherwise you might suffer from crashes or worse.
513 521
514This function allows your callbacks to block by executing them in another 522This function allows your callbacks to block by executing them in another
… …
525 533
526# we create a special coro because we want to cede, 534# we create a special coro because we want to cede,
527# to reduce pressure on the coro pool (because most callbacks 535# to reduce pressure on the coro pool (because most callbacks
528# return immediately and can be reused) and because we cannot cede 536# return immediately and can be reused) and because we cannot cede
529# inside an event callback. 537# inside an event callback.
530our $unblock_scheduler = async { 538our $unblock_scheduler = new Coro sub {
531 while () { 539 while () {
532 while (my $cb = pop @unblock_queue) { 540 while (my $cb = pop @unblock_queue) {
533 # this is an inlined copy of async_pool 541 # this is an inlined copy of async_pool
534 my $coro = (pop @pool or new Coro \&pool_handler); 542 my $coro = (pop @pool or new Coro \&pool_handler);
535 543
… …
538 cede; # for short-lived callbacks, this reduces pressure on the coro pool 546 cede; # for short-lived callbacks, this reduces pressure on the coro pool
539 } 547 }
540 schedule; # sleep well 548 schedule; # sleep well
541 } 549 }
542}; 550};
551$unblock_scheduler->desc ("[unblock_sub scheduler]");
543 552
544sub unblock_sub(&) { 553sub unblock_sub(&) {
545 my $cb = shift; 554 my $cb = shift;
546 555
547 sub { 556 sub {
… …
560 569
561 - you must make very sure that no coro is still active on global 570 - you must make very sure that no coro is still active on global
562 destruction. very bad things might happen otherwise (usually segfaults). 571 destruction. very bad things might happen otherwise (usually segfaults).
563 572
564 - this module is not thread-safe. You should only ever use this module 573 - this module is not thread-safe. You should only ever use this module
565 from the same thread (this requirement might be losened in the future 574 from the same thread (this requirement might be loosened in the future
566 to allow per-thread schedulers, but Coro::State does not yet allow 575 to allow per-thread schedulers, but Coro::State does not yet allow
567 this). 576 this).
568 577
569=head1 SEE ALSO 578=head1 SEE ALSO
570 579

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines