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

Comparing Coro/Coro.pm (file contents):
Revision 1.90 by root, Thu Nov 30 18:21:14 2006 UTC vs.
Revision 1.142 by root, Tue Oct 2 23:16:24 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines