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

Comparing Coro/Coro.pm (file contents):
Revision 1.80 by root, Mon Nov 6 19:56:26 2006 UTC vs.
Revision 1.129 by root, Wed Sep 19 22:33:08 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
35use strict; 44use strict;
36no warnings "uninitialized"; 45no warnings "uninitialized";
37 46
38use Coro::State; 47use Coro::State;
39 48
40use base Exporter::; 49use base qw(Coro::State Exporter);
41 50
42our $idle; # idle coroutine 51our $idle; # idle handler
43our $main; # main coroutine 52our $main; # main coroutine
44our $current; # current coroutine 53our $current; # current coroutine
45 54
46our $VERSION = '2.5'; 55our $VERSION = '3.7';
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;
95 104
96$main = new Coro; 105$main = new Coro;
97 106
98=item $current (or as function: current) 107=item $current (or as function: current)
99 108
100The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 109The current coroutine (the last coroutine switched to). The initial value
110is C<$main> (of course).
111
112This variable is B<strictly> I<read-only>. It is provided for performance
113reasons. If performance is not essential you are encouraged to use the
114C<Coro::current> function instead.
101 115
102=cut 116=cut
103 117
104# maybe some other module used Coro::Specific before... 118# maybe some other module used Coro::Specific before...
105if ($current) {
106 $main->{specific} = $current->{specific}; 119$main->{specific} = $current->{specific}
107} 120 if $current;
108 121
109$current = $main; 122_set_current $main;
110 123
111sub current() { $current } 124sub current() { $current }
112 125
113=item $idle 126=item $idle
114 127
115The coroutine to switch to when no other coroutine is running. The default 128A callback that is called whenever the scheduler finds no ready coroutines
116implementation prints "FATAL: deadlock detected" and exits. 129to run. The default implementation prints "FATAL: deadlock detected" and
130exits, because the program has no other way to continue.
117 131
118=cut 132This hook is overwritten by modules such as C<Coro::Timer> and
133C<Coro::Event> to wait on an external event that hopefully wake up a
134coroutine so the scheduler can run it.
119 135
120# should be done using priorities :( 136Please note that if your callback recursively invokes perl (e.g. for event
121$idle = new Coro sub { 137handlers), then it must be prepared to be called recursively.
122 print STDERR "FATAL: deadlock detected\n"; 138
123 exit(51); 139=cut
140
141$idle = sub {
142 require Carp;
143 Carp::croak ("FATAL: deadlock detected");
124}; 144};
145
146sub _cancel {
147 my ($self) = @_;
148
149 # free coroutine data and mark as destructed
150 $self->_destroy
151 or return;
152
153 # call all destruction callbacks
154 $_->(@{$self->{status}})
155 for @{(delete $self->{destroy_cb}) || []};
156}
125 157
126# this coroutine is necessary because a coroutine 158# this coroutine is necessary because a coroutine
127# cannot destroy itself. 159# cannot destroy itself.
128my @destroy; 160my @destroy;
129my $manager; 161my $manager;
162
130$manager = new Coro sub { 163$manager = new Coro sub {
164 $current->desc ("[coro manager]");
165
131 while () { 166 while () {
132 # by overwriting the state object with the manager we destroy it 167 (shift @destroy)->_cancel
133 # while still being able to schedule this coroutine (in case it has
134 # been readied multiple times. this is harmless since the manager
135 # can be called as many times as neccessary and will always
136 # remove itself from the runqueue
137 while (@destroy) { 168 while @destroy;
138 my $coro = pop @destroy;
139 $coro->{status} ||= [];
140 $_->ready for @{delete $coro->{join} || []};
141 169
142 # the next line destroys the _coro_state, but keeps the
143 # process itself intact (we basically make it a zombie
144 # process that always runs the manager thread, so it's possible
145 # to transfer() to this process).
146 $coro->{_coro_state} = $manager->{_coro_state};
147 }
148 &schedule; 170 &schedule;
149 } 171 }
150}; 172};
151 173
174$manager->prio (PRIO_MAX);
175
152# static methods. not really. 176# static methods. not really.
153 177
154=back 178=back
155 179
156=head2 STATIC METHODS 180=head2 STATIC METHODS
157 181
158Static methods are actually functions that operate on the current process only. 182Static methods are actually functions that operate on the current coroutine only.
159 183
160=over 4 184=over 4
161 185
162=item async { ... } [@args...] 186=item async { ... } [@args...]
163 187
164Create a new asynchronous process and return it's process object 188Create a new asynchronous coroutine and return it's coroutine object
165(usually unused). When the sub returns the new process is automatically 189(usually unused). When the sub returns the new coroutine is automatically
166terminated. 190terminated.
167 191
168When the coroutine dies, the program will exit, just as in the main 192Calling C<exit> in a coroutine will do the same as calling exit outside
169program. 193the coroutine. Likewise, when the coroutine dies, the program will exit,
194just as it would in the main program.
170 195
171 # create a new coroutine that just prints its arguments 196 # create a new coroutine that just prints its arguments
172 async { 197 async {
173 print "@_\n"; 198 print "@_\n";
174 } 1,2,3,4; 199 } 1,2,3,4;
175 200
176=cut 201=cut
177 202
178sub async(&@) { 203sub async(&@) {
179 my $pid = new Coro @_; 204 my $coro = new Coro @_;
180 $manager->ready; # this ensures that the stack is cloned from the manager
181 $pid->ready; 205 $coro->ready;
182 $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 {
230terminate }> once per second or so to slowly replenish the pool.
231
232=cut
233
234our $POOL_SIZE = 8;
235our @pool;
236
237sub pool_handler {
238 while () {
239 $current->{desc} = "[async_pool]";
240
241 eval {
242 my ($cb, @arg) = @{ delete $current->{_invoke} or return };
243 $cb->(@arg);
244 };
245 warn $@ if $@;
246
247 last if @pool >= $POOL_SIZE;
248
249 push @pool, $current;
250 $current->{desc} = "[async_pool idle]";
251 $current->save (Coro::State::SAVE_DEF);
252 $current->prio (0);
253 schedule;
254 }
255}
256
257sub async_pool(&@) {
258 # this is also inlined into the unlock_scheduler
259 my $coro = (pop @pool) || new Coro \&pool_handler;;
260
261 $coro->{_invoke} = [@_];
262 $coro->ready;
263
264 $coro
183} 265}
184 266
185=item schedule 267=item schedule
186 268
187Calls the scheduler. Please note that the current process will not be put 269Calls the scheduler. Please note that the current coroutine will not be put
188into the ready queue, so calling this function usually means you will 270into the ready queue, so calling this function usually means you will
189never be called again. 271never be called again unless something else (e.g. an event handler) calls
272ready.
190 273
191=cut 274The canonical way to wait on external events is this:
275
276 {
277 # remember current coroutine
278 my $current = $Coro::current;
279
280 # register a hypothetical event handler
281 on_event_invoke sub {
282 # wake up sleeping coroutine
283 $current->ready;
284 undef $current;
285 };
286
287 # call schedule until event occurred.
288 # in case we are woken up for other reasons
289 # (current still defined), loop.
290 Coro::schedule while $current;
291 }
192 292
193=item cede 293=item cede
194 294
195"Cede" to other processes. This function puts the current process into the 295"Cede" to other coroutines. This function puts the current coroutine into the
196ready queue and calls C<schedule>, which has the effect of giving up the 296ready queue and calls C<schedule>, which has the effect of giving up the
197current "timeslice" to other coroutines of the same or higher priority. 297current "timeslice" to other coroutines of the same or higher priority.
198 298
199=cut 299Returns true if at least one coroutine switch has happened.
300
301=item Coro::cede_notself
302
303Works like cede, but is not exported by default and will cede to any
304coroutine, regardless of priority, once.
305
306Returns true if at least one coroutine switch has happened.
200 307
201=item terminate [arg...] 308=item terminate [arg...]
202 309
203Terminates the current process with the given status values (see L<cancel>). 310Terminates the current coroutine with the given status values (see L<cancel>).
204 311
205=cut 312=cut
206 313
207sub terminate { 314sub terminate {
208 $current->cancel (@_); 315 $current->cancel (@_);
210 317
211=back 318=back
212 319
213# dynamic methods 320# dynamic methods
214 321
215=head2 PROCESS METHODS 322=head2 COROUTINE METHODS
216 323
217These are the methods you can call on process objects. 324These are the methods you can call on coroutine objects.
218 325
219=over 4 326=over 4
220 327
221=item new Coro \&sub [, @args...] 328=item new Coro \&sub [, @args...]
222 329
223Create a new process and return it. When the sub returns the process 330Create a new coroutine and return it. When the sub returns the coroutine
224automatically terminates as if C<terminate> with the returned values were 331automatically terminates as if C<terminate> with the returned values were
225called. To make the process 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
226by calling the ready method. 333by calling the ready method.
227 334
228=cut 335See C<async> for additional discussion.
229 336
337=cut
338
230sub _newcoro { 339sub _run_coro {
231 terminate &{+shift}; 340 terminate &{+shift};
232} 341}
233 342
234sub new { 343sub new {
235 my $class = shift; 344 my $class = shift;
236 bless {
237 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
238 }, $class;
239}
240 345
241=item $process->ready 346 $class->SUPER::new (\&_run_coro, @_)
347}
242 348
243Put the given process into the ready queue. 349=item $success = $coroutine->ready
244 350
245=cut 351Put the given coroutine into the ready queue (according to it's priority)
352and return true. If the coroutine is already in the ready queue, do nothing
353and return false.
246 354
355=item $is_ready = $coroutine->is_ready
356
357Return wether the coroutine is currently the ready queue or not,
358
247=item $process->cancel (arg...) 359=item $coroutine->cancel (arg...)
248 360
249Terminates the given process and makes it return the given arguments as 361Terminates the given coroutine and makes it return the given arguments as
250status (default: the empty list). 362status (default: the empty list). Never returns if the coroutine is the
363current coroutine.
251 364
252=cut 365=cut
253 366
254sub cancel { 367sub cancel {
255 my $self = shift; 368 my $self = shift;
256 $self->{status} = [@_]; 369 $self->{status} = [@_];
370
371 if ($current == $self) {
257 push @destroy, $self; 372 push @destroy, $self;
258 $manager->ready; 373 $manager->ready;
259 &schedule if $current == $self; 374 &schedule while 1;
375 } else {
376 $self->_cancel;
377 }
260} 378}
261 379
262=item $process->join 380=item $coroutine->join
263 381
264Wait until the coroutine terminates and return any values given to the 382Wait until the coroutine terminates and return any values given to the
265C<terminate> or C<cancel> functions. C<join> can be called multiple times 383C<terminate> or C<cancel> functions. C<join> can be called multiple times
266from multiple processes. 384from multiple coroutine.
267 385
268=cut 386=cut
269 387
270sub join { 388sub join {
271 my $self = shift; 389 my $self = shift;
390
272 unless ($self->{status}) { 391 unless ($self->{status}) {
273 push @{$self->{join}}, $current; 392 my $current = $current;
274 &schedule; 393
394 push @{$self->{destroy_cb}}, sub {
395 $current->ready;
396 undef $current;
397 };
398
399 &schedule while $current;
275 } 400 }
401
276 wantarray ? @{$self->{status}} : $self->{status}[0]; 402 wantarray ? @{$self->{status}} : $self->{status}[0];
277} 403}
278 404
405=item $coroutine->on_destroy (\&cb)
406
407Registers a callback that is called when this coroutine gets destroyed,
408but before it is joined. The callback gets passed the terminate arguments,
409if any.
410
411=cut
412
413sub on_destroy {
414 my ($self, $cb) = @_;
415
416 push @{ $self->{destroy_cb} }, $cb;
417}
418
279=item $oldprio = $process->prio($newprio) 419=item $oldprio = $coroutine->prio ($newprio)
280 420
281Sets (or gets, if the argument is missing) the priority of the 421Sets (or gets, if the argument is missing) the priority of the
282process. Higher priority processes get run before lower priority 422coroutine. Higher priority coroutines get run before lower priority
283processes. Priorities are small signed integers (currently -4 .. +3), 423coroutines. Priorities are small signed integers (currently -4 .. +3),
284that you can refer to using PRIO_xxx constants (use the import tag :prio 424that you can refer to using PRIO_xxx constants (use the import tag :prio
285to get then): 425to get then):
286 426
287 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 427 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
288 3 > 1 > 0 > -1 > -3 > -4 428 3 > 1 > 0 > -1 > -3 > -4
291 current->prio(PRIO_HIGH); 431 current->prio(PRIO_HIGH);
292 432
293The idle coroutine ($Coro::idle) always has a lower priority than any 433The idle coroutine ($Coro::idle) always has a lower priority than any
294existing coroutine. 434existing coroutine.
295 435
296Changing the priority of the current process will take effect immediately, 436Changing the priority of the current coroutine will take effect immediately,
297but changing the priority of processes in the ready queue (but not 437but changing the priority of coroutines in the ready queue (but not
298running) will only take effect after the next schedule (of that 438running) will only take effect after the next schedule (of that
299process). This is a bug that will be fixed in some future version. 439coroutine). This is a bug that will be fixed in some future version.
300 440
301=cut
302
303sub prio {
304 my $old = $_[0]{prio};
305 $_[0]{prio} = $_[1] if @_ > 1;
306 $old;
307}
308
309=item $newprio = $process->nice($change) 441=item $newprio = $coroutine->nice ($change)
310 442
311Similar to C<prio>, but subtract the given value from the priority (i.e. 443Similar to C<prio>, but subtract the given value from the priority (i.e.
312higher values mean lower priority, just as in unix). 444higher values mean lower priority, just as in unix).
313 445
314=cut
315
316sub nice {
317 $_[0]{prio} -= $_[1];
318}
319
320=item $olddesc = $process->desc($newdesc) 446=item $olddesc = $coroutine->desc ($newdesc)
321 447
322Sets (or gets in case the argument is missing) the description for this 448Sets (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. 449coroutine. This is just a free-form string you can associate with a coroutine.
324 450
325=cut 451=cut
326 452
327sub desc { 453sub desc {
328 my $old = $_[0]{desc}; 454 my $old = $_[0]{desc};
330 $old; 456 $old;
331} 457}
332 458
333=back 459=back
334 460
461=head2 GLOBAL FUNCTIONS
462
463=over 4
464
465=item Coro::nready
466
467Returns the number of coroutines that are currently in the ready state,
468i.e. that can be switched to. The value C<0> means that the only runnable
469coroutine is the currently running one, so C<cede> would have no effect,
470and C<schedule> would cause a deadlock unless there is an idle handler
471that wakes up some coroutines.
472
473=item my $guard = Coro::guard { ... }
474
475This creates and returns a guard object. Nothing happens until the object
476gets destroyed, in which case the codeblock given as argument will be
477executed. This is useful to free locks or other resources in case of a
478runtime error or when the coroutine gets canceled, as in both cases the
479guard block will be executed. The guard object supports only one method,
480C<< ->cancel >>, which will keep the codeblock from being executed.
481
482Example: set some flag and clear it again when the coroutine gets canceled
483or the function returns:
484
485 sub do_something {
486 my $guard = Coro::guard { $busy = 0 };
487 $busy = 1;
488
489 # do something that requires $busy to be true
490 }
491
492=cut
493
494sub guard(&) {
495 bless \(my $cb = $_[0]), "Coro::guard"
496}
497
498sub Coro::guard::cancel {
499 ${$_[0]} = sub { };
500}
501
502sub Coro::guard::DESTROY {
503 ${$_[0]}->();
504}
505
506
507=item unblock_sub { ... }
508
509This utility function takes a BLOCK or code reference and "unblocks" it,
510returning the new coderef. This means that the new coderef will return
511immediately without blocking, returning nothing, while the original code
512ref will be called (with parameters) from within its own coroutine.
513
514The reason this function exists is that many event libraries (such as the
515venerable L<Event|Event> module) are not coroutine-safe (a weaker form
516of thread-safety). This means you must not block within event callbacks,
517otherwise you might suffer from crashes or worse.
518
519This function allows your callbacks to block by executing them in another
520coroutine where it is safe to block. One example where blocking is handy
521is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
522disk.
523
524In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
525creating event callbacks that want to block.
526
527=cut
528
529our @unblock_queue;
530
531# we create a special coro because we want to cede,
532# to reduce pressure on the coro pool (because most callbacks
533# return immediately and can be reused) and because we cannot cede
534# inside an event callback.
535our $unblock_scheduler = async {
536 $current->desc ("[unblock_sub scheduler]");
537 while () {
538 while (my $cb = pop @unblock_queue) {
539 # this is an inlined copy of async_pool
540 my $coro = (pop @pool or new Coro \&pool_handler);
541
542 $coro->{_invoke} = $cb;
543 $coro->ready;
544 cede; # for short-lived callbacks, this reduces pressure on the coro pool
545 }
546 schedule; # sleep well
547 }
548};
549
550sub unblock_sub(&) {
551 my $cb = shift;
552
553 sub {
554 unshift @unblock_queue, [$cb, @_];
555 $unblock_scheduler->ready;
556 }
557}
558
559=back
560
335=cut 561=cut
336 562
3371; 5631;
338 564
339=head1 BUGS/LIMITATIONS 565=head1 BUGS/LIMITATIONS
340 566
341 - 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
342 destruction. very bad things might happen otherwise (usually segfaults). 568 destruction. very bad things might happen otherwise (usually segfaults).
343 569
344 - 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
345 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
346 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
347 this). 573 this).
348 574
349=head1 SEE ALSO 575=head1 SEE ALSO
350 576

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines