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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.118 by root, Mon Mar 19 15:50:48 2007 UTC vs.
Revision 1.129 by root, Wed Sep 19 22:33:08 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.55'; 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 117
118# maybe some other module used Coro::Specific before... 118# maybe some other module used Coro::Specific before...
… …
159# cannot destroy itself. 159# cannot destroy itself.
160my @destroy; 160my @destroy;
161my $manager; 161my $manager;
162 162
163$manager = new Coro sub { 163$manager = new Coro sub {
164 $current->desc ("[coro manager]");
165
164 while () { 166 while () {
165 (shift @destroy)->_cancel 167 (shift @destroy)->_cancel
166 while @destroy; 168 while @destroy;
167 169
168 &schedule; 170 &schedule;
… …
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;
… …
233our $POOL_SIZE = 8; 234our $POOL_SIZE = 8;
234our @pool; 235our @pool;
235 236
236sub pool_handler { 237sub pool_handler {
237 while () { 238 while () {
239 $current->{desc} = "[async_pool]";
240
238 eval { 241 eval {
239 my ($cb, @arg) = @{ delete $current->{_invoke} or return }; 242 my ($cb, @arg) = @{ delete $current->{_invoke} or return };
240 $cb->(@arg); 243 $cb->(@arg);
241 }; 244 };
242 warn $@ if $@; 245 warn $@ if $@;
243 246
244 last if @pool >= $POOL_SIZE; 247 last if @pool >= $POOL_SIZE;
248
245 push @pool, $current; 249 push @pool, $current;
246 250 $current->{desc} = "[async_pool idle]";
247 $current->save (Coro::State::SAVE_DEF); 251 $current->save (Coro::State::SAVE_DEF);
248 $current->prio (0); 252 $current->prio (0);
249 schedule; 253 schedule;
250 } 254 }
251} 255}
252 256
253sub async_pool(&@) { 257sub async_pool(&@) {
254 # this is also inlined into the unlock_scheduler 258 # this is also inlined into the unlock_scheduler
255 my $coro = (pop @pool or new Coro \&pool_handler); 259 my $coro = (pop @pool) || new Coro \&pool_handler;;
256 260
257 $coro->{_invoke} = [@_]; 261 $coro->{_invoke} = [@_];
258 $coro->ready; 262 $coro->ready;
259 263
260 $coro 264 $coro
… …
278 # wake up sleeping coroutine 282 # wake up sleeping coroutine
279 $current->ready; 283 $current->ready;
280 undef $current; 284 undef $current;
281 }; 285 };
282 286
283 # call schedule until event occured. 287 # call schedule until event occurred.
284 # in case we are woken up for other reasons 288 # in case we are woken up for other reasons
285 # (current still defined), loop. 289 # (current still defined), loop.
286 Coro::schedule while $current; 290 Coro::schedule while $current;
287 } 291 }
288 292
… …
326Create a new coroutine and return it. When the sub returns the coroutine 330Create a new coroutine and return it. When the sub returns the coroutine
327automatically terminates as if C<terminate> with the returned values were 331automatically terminates as if C<terminate> with the returned values were
328called. To make the coroutine run you must first put it into the ready queue 332called. To make the coroutine run you must first put it into the ready queue
329by calling the ready method. 333by calling the ready method.
330 334
331Calling C<exit> in a coroutine will not work correctly, so do not do that. 335See C<async> for additional discussion.
332 336
333=cut 337=cut
334 338
335sub _run_coro { 339sub _run_coro {
336 terminate &{+shift}; 340 terminate &{+shift};
… …
459=over 4 463=over 4
460 464
461=item Coro::nready 465=item Coro::nready
462 466
463Returns the number of coroutines that are currently in the ready state, 467Returns the number of coroutines that are currently in the ready state,
464i.e. that can be swicthed to. The value C<0> means that the only runnable 468i.e. that can be switched to. The value C<0> means that the only runnable
465coroutine is the currently running one, so C<cede> would have no effect, 469coroutine is the currently running one, so C<cede> would have no effect,
466and C<schedule> would cause a deadlock unless there is an idle handler 470and C<schedule> would cause a deadlock unless there is an idle handler
467that wakes up some coroutines. 471that wakes up some coroutines.
468 472
469=item my $guard = Coro::guard { ... } 473=item my $guard = Coro::guard { ... }
470 474
471This creates and returns a guard object. Nothing happens until the objetc 475This creates and returns a guard object. Nothing happens until the object
472gets destroyed, in which case the codeblock given as argument will be 476gets destroyed, in which case the codeblock given as argument will be
473executed. This is useful to free locks or other resources in case of a 477executed. This is useful to free locks or other resources in case of a
474runtime error or when the coroutine gets canceled, as in both cases the 478runtime error or when the coroutine gets canceled, as in both cases the
475guard block will be executed. The guard object supports only one method, 479guard block will be executed. The guard object supports only one method,
476C<< ->cancel >>, which will keep the codeblock from being executed. 480C<< ->cancel >>, which will keep the codeblock from being executed.
… …
505This utility function takes a BLOCK or code reference and "unblocks" it, 509This utility function takes a BLOCK or code reference and "unblocks" it,
506returning the new coderef. This means that the new coderef will return 510returning the new coderef. This means that the new coderef will return
507immediately without blocking, returning nothing, while the original code 511immediately without blocking, returning nothing, while the original code
508ref will be called (with parameters) from within its own coroutine. 512ref will be called (with parameters) from within its own coroutine.
509 513
510The reason this fucntion exists is that many event libraries (such as the 514The reason this function exists is that many event libraries (such as the
511venerable L<Event|Event> module) are not coroutine-safe (a weaker form 515venerable L<Event|Event> module) are not coroutine-safe (a weaker form
512of thread-safety). This means you must not block within event callbacks, 516of thread-safety). This means you must not block within event callbacks,
513otherwise you might suffer from crashes or worse. 517otherwise you might suffer from crashes or worse.
514 518
515This function allows your callbacks to block by executing them in another 519This function allows your callbacks to block by executing them in another
… …
527# we create a special coro because we want to cede, 531# we create a special coro because we want to cede,
528# to reduce pressure on the coro pool (because most callbacks 532# to reduce pressure on the coro pool (because most callbacks
529# return immediately and can be reused) and because we cannot cede 533# return immediately and can be reused) and because we cannot cede
530# inside an event callback. 534# inside an event callback.
531our $unblock_scheduler = async { 535our $unblock_scheduler = async {
536 $current->desc ("[unblock_sub scheduler]");
532 while () { 537 while () {
533 while (my $cb = pop @unblock_queue) { 538 while (my $cb = pop @unblock_queue) {
534 # this is an inlined copy of async_pool 539 # this is an inlined copy of async_pool
535 my $coro = (pop @pool or new Coro \&pool_handler); 540 my $coro = (pop @pool or new Coro \&pool_handler);
536 541
… …
561 566
562 - you must make very sure that no coro is still active on global 567 - you must make very sure that no coro is still active on global
563 destruction. very bad things might happen otherwise (usually segfaults). 568 destruction. very bad things might happen otherwise (usually segfaults).
564 569
565 - this module is not thread-safe. You should only ever use this module 570 - this module is not thread-safe. You should only ever use this module
566 from the same thread (this requirement might be losened in the future 571 from the same thread (this requirement might be loosened in the future
567 to allow per-thread schedulers, but Coro::State does not yet allow 572 to allow per-thread schedulers, but Coro::State does not yet allow
568 this). 573 this).
569 574
570=head1 SEE ALSO 575=head1 SEE ALSO
571 576

Diff Legend

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