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.97 by root, Mon Dec 4 13:47:56 2006 UTC vs.
Revision 1.180 by root, Fri Apr 25 04:28:50 2008 UTC

2 2
3Coro - coroutine process abstraction 3Coro - coroutine process abstraction
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use Coro; 7 use Coro;
8 8
9 async { 9 async {
10 # some asynchronous thread of execution 10 # some asynchronous thread of execution
11 print "2\n";
12 cede; # yield back to main
13 print "4\n";
11 }; 14 };
12 15 print "1\n";
13 # alternatively create an async coroutine like this: 16 cede; # yield to coroutine
14 17 print "3\n";
15 sub some_func : Coro { 18 cede; # and again
16 # some more async code 19
17 } 20 # use locking
18 21 my $lock = new Coro::Semaphore;
19 cede; 22 my $locked;
23
24 $lock->down;
25 $locked = 1;
26 $lock->up;
20 27
21=head1 DESCRIPTION 28=head1 DESCRIPTION
22 29
23This module collection manages coroutines. Coroutines are similar to 30This module collection manages coroutines. Coroutines are similar
24threads but don't run in parallel. 31to threads but don't run in parallel at the same time even on SMP
32machines. The specific flavor of coroutine used in this module also
33guarantees you that it will not switch between coroutines unless
34necessary, at easily-identified points in your program, so locking and
35parallel access are rarely an issue, making coroutine programming much
36safer than threads programming.
25 37
38(Perl, however, does not natively support real threads but instead does a
39very slow and memory-intensive emulation of processes using threads. This
40is a performance win on Windows machines, and a loss everywhere else).
41
26In this module, coroutines are defined as "callchain + lexical variables 42In this module, coroutines are defined as "callchain + lexical variables +
27+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own 43@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
28callchain, it's own set of lexicals and it's own set of perl's most 44its own set of lexicals and its own set of perls most important global
29important global variables. 45variables (see L<Coro::State> for more configuration).
30 46
31=cut 47=cut
32 48
33package Coro; 49package Coro;
34 50
41 57
42our $idle; # idle handler 58our $idle; # idle handler
43our $main; # main coroutine 59our $main; # main coroutine
44our $current; # current coroutine 60our $current; # current coroutine
45 61
46our $VERSION = '3.01'; 62our $VERSION = 4.6;
47 63
48our @EXPORT = qw(async cede schedule terminate current unblock_sub); 64our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
49our %EXPORT_TAGS = ( 65our %EXPORT_TAGS = (
50 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 66 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
51); 67);
52our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); 68our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
53 69
54{
55 my @async;
56 my $init;
57
58 # this way of handling attributes simply is NOT scalable ;()
59 sub import {
60 no strict 'refs';
61
62 Coro->export_to_level (1, @_);
63
64 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
65 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
66 my ($package, $ref) = (shift, shift);
67 my @attrs;
68 for (@_) {
69 if ($_ eq "Coro") {
70 push @async, $ref;
71 unless ($init++) {
72 eval q{
73 sub INIT {
74 &async(pop @async) while @async;
75 }
76 };
77 }
78 } else {
79 push @attrs, $_;
80 }
81 }
82 return $old ? $old->($package, $ref, @attrs) : @attrs;
83 };
84 }
85
86}
87
88=over 4 70=over 4
89 71
90=item $main 72=item $main
91 73
92This coroutine represents the main program. 74This coroutine represents the main program.
99 81
100The current coroutine (the last coroutine switched to). The initial value 82The current coroutine (the last coroutine switched to). The initial value
101is C<$main> (of course). 83is C<$main> (of course).
102 84
103This variable is B<strictly> I<read-only>. It is provided for performance 85This variable is B<strictly> I<read-only>. It is provided for performance
104reasons. If performance is not essentiel you are encouraged to use the 86reasons. If performance is not essential you are encouraged to use the
105C<Coro::current> function instead. 87C<Coro::current> function instead.
106 88
107=cut 89=cut
108 90
91$main->{desc} = "[main::]";
92
109# maybe some other module used Coro::Specific before... 93# maybe some other module used Coro::Specific before...
110$main->{specific} = $current->{specific} 94$main->{_specific} = $current->{_specific}
111 if $current; 95 if $current;
112 96
113_set_current $main; 97_set_current $main;
114 98
115sub current() { $current } 99sub current() { $current }
123This hook is overwritten by modules such as C<Coro::Timer> and 107This hook is overwritten by modules such as C<Coro::Timer> and
124C<Coro::Event> to wait on an external event that hopefully wake up a 108C<Coro::Event> to wait on an external event that hopefully wake up a
125coroutine so the scheduler can run it. 109coroutine so the scheduler can run it.
126 110
127Please note that if your callback recursively invokes perl (e.g. for event 111Please note that if your callback recursively invokes perl (e.g. for event
128handlers), then it must be prepared to be called recursively. 112handlers), then it must be prepared to be called recursively itself.
129 113
130=cut 114=cut
131 115
132$idle = sub { 116$idle = sub {
133 require Carp; 117 require Carp;
134 Carp::croak ("FATAL: deadlock detected"); 118 Carp::croak ("FATAL: deadlock detected");
135}; 119};
136 120
121sub _cancel {
122 my ($self) = @_;
123
124 # free coroutine data and mark as destructed
125 $self->_destroy
126 or return;
127
128 # call all destruction callbacks
129 $_->(@{$self->{_status}})
130 for @{(delete $self->{_on_destroy}) || []};
131}
132
137# this coroutine is necessary because a coroutine 133# this coroutine is necessary because a coroutine
138# cannot destroy itself. 134# cannot destroy itself.
139my @destroy; 135my @destroy;
136my $manager;
137
140my $manager; $manager = new Coro sub { 138$manager = new Coro sub {
141 while () { 139 while () {
142 # by overwriting the state object with the manager we destroy it 140 (shift @destroy)->_cancel
143 # while still being able to schedule this coroutine (in case it has
144 # been readied multiple times. this is harmless since the manager
145 # can be called as many times as neccessary and will always
146 # remove itself from the runqueue
147 while (@destroy) { 141 while @destroy;
148 my $coro = pop @destroy;
149 $coro->{status} ||= [];
150 $_->ready for @{delete $coro->{join} || []};
151 142
152 # the next line destroys the coro state, but keeps the
153 # coroutine itself intact (we basically make it a zombie
154 # coroutine that always runs the manager thread, so it's possible
155 # to transfer() to this coroutine).
156 $coro->_clone_state_from ($manager);
157 }
158 &schedule; 143 &schedule;
159 } 144 }
160}; 145};
161 146$manager->desc ("[coro manager]");
162# static methods. not really. 147$manager->prio (PRIO_MAX);
163 148
164=back 149=back
165 150
166=head2 STATIC METHODS 151=head2 STATIC METHODS
167 152
173 158
174Create a new asynchronous coroutine and return it's coroutine object 159Create a new asynchronous coroutine and return it's coroutine object
175(usually unused). When the sub returns the new coroutine is automatically 160(usually unused). When the sub returns the new coroutine is automatically
176terminated. 161terminated.
177 162
178Calling C<exit> in a coroutine will not work correctly, so do not do that. 163See the C<Coro::State::new> constructor for info about the coroutine
164environment in which coroutines run.
179 165
180When the coroutine dies, the program will exit, just as in the main 166Calling C<exit> in a coroutine will do the same as calling exit outside
181program. 167the coroutine. Likewise, when the coroutine dies, the program will exit,
168just as it would in the main program.
182 169
183 # create a new coroutine that just prints its arguments 170 # create a new coroutine that just prints its arguments
184 async { 171 async {
185 print "@_\n"; 172 print "@_\n";
186 } 1,2,3,4; 173 } 1,2,3,4;
187 174
188=cut 175=cut
189 176
190sub async(&@) { 177sub async(&@) {
191 my $pid = new Coro @_; 178 my $coro = new Coro @_;
192 $pid->ready; 179 $coro->ready;
193 $pid 180 $coro
181}
182
183=item async_pool { ... } [@args...]
184
185Similar to C<async>, but uses a coroutine pool, so you should not call
186terminate or join (although you are allowed to), and you get a coroutine
187that might have executed other code already (which can be good or bad :).
188
189Also, the block is executed in an C<eval> context and a warning will be
190issued in case of an exception instead of terminating the program, as
191C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
192will not work in the expected way, unless you call terminate or cancel,
193which somehow defeats the purpose of pooling.
194
195The priority will be reset to C<0> after each job, tracing will be
196disabled, the description will be reset and the default output filehandle
197gets restored, so you can change alkl these. Otherwise the coroutine will
198be re-used "as-is": most notably if you change other per-coroutine global
199stuff such as C<$/> you need to revert that change, which is most simply
200done by using local as in C< local $/ >.
201
202The pool size is limited to 8 idle coroutines (this can be adjusted by
203changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
204required.
205
206If you are concerned about pooled coroutines growing a lot because a
207single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
208{ terminate }> once per second or so to slowly replenish the pool. In
209addition to that, when the stacks used by a handler grows larger than 16kb
210(adjustable with $Coro::POOL_RSS) it will also exit.
211
212=cut
213
214our $POOL_SIZE = 8;
215our $POOL_RSS = 16 * 1024;
216our @async_pool;
217
218sub pool_handler {
219 my $cb;
220
221 while () {
222 eval {
223 while () {
224 _pool_1 $cb;
225 &$cb;
226 _pool_2 $cb;
227 &schedule;
228 }
229 };
230
231 last if $@ eq "\3async_pool terminate\2\n";
232 warn $@ if $@;
233 }
234}
235
236sub async_pool(&@) {
237 # this is also inlined into the unlock_scheduler
238 my $coro = (pop @async_pool) || new Coro \&pool_handler;
239
240 $coro->{_invoke} = [@_];
241 $coro->ready;
242
243 $coro
194} 244}
195 245
196=item schedule 246=item schedule
197 247
198Calls the scheduler. Please note that the current coroutine will not be put 248Calls the scheduler. Please note that the current coroutine will not be put
211 # wake up sleeping coroutine 261 # wake up sleeping coroutine
212 $current->ready; 262 $current->ready;
213 undef $current; 263 undef $current;
214 }; 264 };
215 265
216 # call schedule until event occured. 266 # call schedule until event occurred.
217 # in case we are woken up for other reasons 267 # in case we are woken up for other reasons
218 # (current still defined), loop. 268 # (current still defined), loop.
219 Coro::schedule while $current; 269 Coro::schedule while $current;
220 } 270 }
221 271
223 273
224"Cede" to other coroutines. This function puts the current coroutine into the 274"Cede" to other coroutines. This function puts the current coroutine into the
225ready queue and calls C<schedule>, which has the effect of giving up the 275ready queue and calls C<schedule>, which has the effect of giving up the
226current "timeslice" to other coroutines of the same or higher priority. 276current "timeslice" to other coroutines of the same or higher priority.
227 277
278=item Coro::cede_notself
279
280Works like cede, but is not exported by default and will cede to any
281coroutine, regardless of priority, once.
282
228=item terminate [arg...] 283=item terminate [arg...]
229 284
230Terminates the current coroutine with the given status values (see L<cancel>). 285Terminates the current coroutine with the given status values (see L<cancel>).
286
287=item killall
288
289Kills/terminates/cancels all coroutines except the currently running
290one. This is useful after a fork, either in the child or the parent, as
291usually only one of them should inherit the running coroutines.
231 292
232=cut 293=cut
233 294
234sub terminate { 295sub terminate {
235 $current->cancel (@_); 296 $current->cancel (@_);
236} 297}
237 298
299sub killall {
300 for (Coro::State::list) {
301 $_->cancel
302 if $_ != $current && UNIVERSAL::isa $_, "Coro";
303 }
304}
305
238=back 306=back
239
240# dynamic methods
241 307
242=head2 COROUTINE METHODS 308=head2 COROUTINE METHODS
243 309
244These are the methods you can call on coroutine objects. 310These are the methods you can call on coroutine objects.
245 311
250Create a new coroutine and return it. When the sub returns the coroutine 316Create a new coroutine and return it. When the sub returns the coroutine
251automatically terminates as if C<terminate> with the returned values were 317automatically terminates as if C<terminate> with the returned values were
252called. To make the coroutine run you must first put it into the ready queue 318called. To make the coroutine run you must first put it into the ready queue
253by calling the ready method. 319by calling the ready method.
254 320
255Calling C<exit> in a coroutine will not work correctly, so do not do that. 321See C<async> and C<Coro::State::new> for additional info about the
322coroutine environment.
256 323
257=cut 324=cut
258 325
259sub _run_coro { 326sub _run_coro {
260 terminate &{+shift}; 327 terminate &{+shift};
277Return wether the coroutine is currently the ready queue or not, 344Return wether the coroutine is currently the ready queue or not,
278 345
279=item $coroutine->cancel (arg...) 346=item $coroutine->cancel (arg...)
280 347
281Terminates the given coroutine and makes it return the given arguments as 348Terminates the given coroutine and makes it return the given arguments as
282status (default: the empty list). 349status (default: the empty list). Never returns if the coroutine is the
350current coroutine.
283 351
284=cut 352=cut
285 353
286sub cancel { 354sub cancel {
287 my $self = shift; 355 my $self = shift;
288 $self->{status} = [@_]; 356 $self->{_status} = [@_];
357
358 if ($current == $self) {
289 push @destroy, $self; 359 push @destroy, $self;
290 $manager->ready; 360 $manager->ready;
291 &schedule if $current == $self; 361 &schedule while 1;
362 } else {
363 $self->_cancel;
364 }
292} 365}
293 366
294=item $coroutine->join 367=item $coroutine->join
295 368
296Wait until the coroutine terminates and return any values given to the 369Wait until the coroutine terminates and return any values given to the
297C<terminate> or C<cancel> functions. C<join> can be called multiple times 370C<terminate> or C<cancel> functions. C<join> can be called concurrently
298from multiple coroutine. 371from multiple coroutines.
299 372
300=cut 373=cut
301 374
302sub join { 375sub join {
303 my $self = shift; 376 my $self = shift;
377
304 unless ($self->{status}) { 378 unless ($self->{_status}) {
305 push @{$self->{join}}, $current; 379 my $current = $current;
306 &schedule; 380
381 push @{$self->{_on_destroy}}, sub {
382 $current->ready;
383 undef $current;
384 };
385
386 &schedule while $current;
307 } 387 }
388
308 wantarray ? @{$self->{status}} : $self->{status}[0]; 389 wantarray ? @{$self->{_status}} : $self->{_status}[0];
390}
391
392=item $coroutine->on_destroy (\&cb)
393
394Registers a callback that is called when this coroutine gets destroyed,
395but before it is joined. The callback gets passed the terminate arguments,
396if any.
397
398=cut
399
400sub on_destroy {
401 my ($self, $cb) = @_;
402
403 push @{ $self->{_on_destroy} }, $cb;
309} 404}
310 405
311=item $oldprio = $coroutine->prio ($newprio) 406=item $oldprio = $coroutine->prio ($newprio)
312 407
313Sets (or gets, if the argument is missing) the priority of the 408Sets (or gets, if the argument is missing) the priority of the
338=item $olddesc = $coroutine->desc ($newdesc) 433=item $olddesc = $coroutine->desc ($newdesc)
339 434
340Sets (or gets in case the argument is missing) the description for this 435Sets (or gets in case the argument is missing) the description for this
341coroutine. This is just a free-form string you can associate with a coroutine. 436coroutine. This is just a free-form string you can associate with a coroutine.
342 437
438This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
439can modify this member directly if you wish.
440
441=item $coroutine->throw ([$scalar])
442
443If C<$throw> is specified and defined, it will be thrown as an exception
444inside the coroutine at the next convinient point in time (usually after
445it gains control at the next schedule/transfer/cede). Otherwise clears the
446exception object.
447
448The exception object will be thrown "as is" with the specified scalar in
449C<$@>, i.e. if it is a string, no line number or newline will be appended
450(unlike with C<die>).
451
452This can be used as a softer means than C<cancel> to ask a coroutine to
453end itself, although there is no guarentee that the exception will lead to
454termination, and if the exception isn't caught it might well end the whole
455program.
456
343=cut 457=cut
344 458
345sub desc { 459sub desc {
346 my $old = $_[0]{desc}; 460 my $old = $_[0]{desc};
347 $_[0]{desc} = $_[1] if @_ > 1; 461 $_[0]{desc} = $_[1] if @_ > 1;
355=over 4 469=over 4
356 470
357=item Coro::nready 471=item Coro::nready
358 472
359Returns the number of coroutines that are currently in the ready state, 473Returns the number of coroutines that are currently in the ready state,
360i.e. that can be swicthed to. The value C<0> means that the only runnable 474i.e. that can be switched to. The value C<0> means that the only runnable
361coroutine is the currently running one, so C<cede> would have no effect, 475coroutine is the currently running one, so C<cede> would have no effect,
362and C<schedule> would cause a deadlock unless there is an idle handler 476and C<schedule> would cause a deadlock unless there is an idle handler
363that wakes up some coroutines. 477that wakes up some coroutines.
478
479=item my $guard = Coro::guard { ... }
480
481This creates and returns a guard object. Nothing happens until the object
482gets destroyed, in which case the codeblock given as argument will be
483executed. This is useful to free locks or other resources in case of a
484runtime error or when the coroutine gets canceled, as in both cases the
485guard block will be executed. The guard object supports only one method,
486C<< ->cancel >>, which will keep the codeblock from being executed.
487
488Example: set some flag and clear it again when the coroutine gets canceled
489or the function returns:
490
491 sub do_something {
492 my $guard = Coro::guard { $busy = 0 };
493 $busy = 1;
494
495 # do something that requires $busy to be true
496 }
497
498=cut
499
500sub guard(&) {
501 bless \(my $cb = $_[0]), "Coro::guard"
502}
503
504sub Coro::guard::cancel {
505 ${$_[0]} = sub { };
506}
507
508sub Coro::guard::DESTROY {
509 ${$_[0]}->();
510}
511
364 512
365=item unblock_sub { ... } 513=item unblock_sub { ... }
366 514
367This utility function takes a BLOCK or code reference and "unblocks" it, 515This utility function takes a BLOCK or code reference and "unblocks" it,
368returning the new coderef. This means that the new coderef will return 516returning the new coderef. This means that the new coderef will return
369immediately without blocking, returning nothing, while the original code 517immediately without blocking, returning nothing, while the original code
370ref will be called (with parameters) from within its own coroutine. 518ref will be called (with parameters) from within its own coroutine.
371 519
372The reason this fucntion exists is that many event libraries (such as the 520The reason this function exists is that many event libraries (such as the
373venerable L<Event|Event> module) are not coroutine-safe (a weaker form 521venerable L<Event|Event> module) are not coroutine-safe (a weaker form
374of thread-safety). This means you must not block within event callbacks, 522of thread-safety). This means you must not block within event callbacks,
375otherwise you might suffer from crashes or worse. 523otherwise you might suffer from crashes or worse.
376 524
377This function allows your callbacks to block by executing them in another 525This function allows your callbacks to block by executing them in another
382In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when 530In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
383creating event callbacks that want to block. 531creating event callbacks that want to block.
384 532
385=cut 533=cut
386 534
387our @unblock_pool;
388our @unblock_queue; 535our @unblock_queue;
389our $UNBLOCK_POOL_SIZE = 2;
390 536
391sub unblock_handler_ { 537# we create a special coro because we want to cede,
392 while () { 538# to reduce pressure on the coro pool (because most callbacks
393 my ($cb, @arg) = @{ delete $Coro::current->{arg} }; 539# return immediately and can be reused) and because we cannot cede
394 $cb->(@arg); 540# inside an event callback.
395
396 last if @unblock_pool >= $UNBLOCK_POOL_SIZE;
397 push @unblock_pool, $Coro::current;
398 schedule;
399 }
400}
401
402our $unblock_scheduler = async { 541our $unblock_scheduler = new Coro sub {
403 while () { 542 while () {
404 while (my $cb = pop @unblock_queue) { 543 while (my $cb = pop @unblock_queue) {
405 my $handler = (pop @unblock_pool or new Coro \&unblock_handler_); 544 # this is an inlined copy of async_pool
406 $handler->{arg} = $cb; 545 my $coro = (pop @async_pool) || new Coro \&pool_handler;
546
547 $coro->{_invoke} = $cb;
407 $handler->ready; 548 $coro->ready;
408 cede; 549 cede; # for short-lived callbacks, this reduces pressure on the coro pool
409 } 550 }
410 551 schedule; # sleep well
411 schedule;
412 } 552 }
413}; 553};
554$unblock_scheduler->desc ("[unblock_sub scheduler]");
414 555
415sub unblock_sub(&) { 556sub unblock_sub(&) {
416 my $cb = shift; 557 my $cb = shift;
417 558
418 sub { 559 sub {
419 push @unblock_queue, [$cb, @_]; 560 unshift @unblock_queue, [$cb, @_];
420 $unblock_scheduler->ready; 561 $unblock_scheduler->ready;
421 } 562 }
422} 563}
423 564
424=back 565=back
431 572
432 - you must make very sure that no coro is still active on global 573 - you must make very sure that no coro is still active on global
433 destruction. very bad things might happen otherwise (usually segfaults). 574 destruction. very bad things might happen otherwise (usually segfaults).
434 575
435 - this module is not thread-safe. You should only ever use this module 576 - this module is not thread-safe. You should only ever use this module
436 from the same thread (this requirement might be losened in the future 577 from the same thread (this requirement might be loosened in the future
437 to allow per-thread schedulers, but Coro::State does not yet allow 578 to allow per-thread schedulers, but Coro::State does not yet allow
438 this). 579 this).
439 580
440=head1 SEE ALSO 581=head1 SEE ALSO
441 582
583Lower level Configuration, Coroutine Environment: L<Coro::State>.
584
585Debugging: L<Coro::Debug>.
586
442Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. 587Support/Utility: L<Coro::Specific>, L<Coro::Util>.
443 588
444Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. 589Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
445 590
446Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. 591Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>.
447 592
593Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>.
594
448Embedding: L<Coro:MakeMaker> 595Embedding: L<Coro::MakeMaker>.
449 596
450=head1 AUTHOR 597=head1 AUTHOR
451 598
452 Marc Lehmann <schmorp@schmorp.de> 599 Marc Lehmann <schmorp@schmorp.de>
453 http://home.schmorp.de/ 600 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines