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

Comparing Coro/Coro.pm (file contents):
Revision 1.89 by root, Mon Nov 27 02:01:33 2006 UTC vs.
Revision 1.145 by root, Wed Oct 3 16:03:17 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 = '4.0';
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. 192See the C<Coro::State::new> constructor for info about the coroutine
193environment.
177 194
178When the coroutine dies, the program will exit, just as in the main 195Calling C<exit> in a coroutine will do the same as calling exit outside
179program. 196the coroutine. Likewise, when the coroutine dies, the program will exit,
197just as it would in the main program.
180 198
181 # create a new coroutine that just prints its arguments 199 # create a new coroutine that just prints its arguments
182 async { 200 async {
183 print "@_\n"; 201 print "@_\n";
184 } 1,2,3,4; 202 } 1,2,3,4;
185 203
186=cut 204=cut
187 205
188sub async(&@) { 206sub async(&@) {
189 my $pid = new Coro @_; 207 my $coro = new Coro @_;
190 $pid->ready; 208 $coro->ready;
191 $pid 209 $coro
210}
211
212=item async_pool { ... } [@args...]
213
214Similar to C<async>, but uses a coroutine pool, so you should not call
215terminate or join (although you are allowed to), and you get a coroutine
216that might have executed other code already (which can be good or bad :).
217
218Also, the block is executed in an C<eval> context and a warning will be
219issued in case of an exception instead of terminating the program, as
220C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
221will not work in the expected way, unless you call terminate or cancel,
222which somehow defeats the purpose of pooling.
223
224The priority will be reset to C<0> after each job, otherwise the coroutine
225will be re-used "as-is".
226
227The pool size is limited to 8 idle coroutines (this can be adjusted by
228changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
229required.
230
231If you are concerned about pooled coroutines growing a lot because a
232single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
233{ terminate }> once per second or so to slowly replenish the pool. In
234addition to that, when the stacks used by a handler grows larger than 16kb
235(adjustable with $Coro::POOL_RSS) it will also exit.
236
237=cut
238
239our $POOL_SIZE = 8;
240our $POOL_RSS = 16 * 1024;
241our @async_pool;
242
243sub pool_handler {
244 my $cb;
245
246 while () {
247 eval {
248 while () {
249 _pool_1 $cb;
250 &$cb;
251 _pool_2 $cb;
252 &schedule;
253 }
254 };
255
256 last if $@ eq "\3terminate\2\n";
257 warn $@ if $@;
258 }
259}
260
261sub async_pool(&@) {
262 # this is also inlined into the unlock_scheduler
263 my $coro = (pop @async_pool) || new Coro \&pool_handler;
264
265 $coro->{_invoke} = [@_];
266 $coro->ready;
267
268 $coro
192} 269}
193 270
194=item schedule 271=item schedule
195 272
196Calls the scheduler. Please note that the current process will not be put 273Calls the scheduler. Please note that the current coroutine will not be put
197into the ready queue, so calling this function usually means you will 274into the ready queue, so calling this function usually means you will
198never be called again. 275never be called again unless something else (e.g. an event handler) calls
276ready.
199 277
200=cut 278The canonical way to wait on external events is this:
279
280 {
281 # remember current coroutine
282 my $current = $Coro::current;
283
284 # register a hypothetical event handler
285 on_event_invoke sub {
286 # wake up sleeping coroutine
287 $current->ready;
288 undef $current;
289 };
290
291 # call schedule until event occurred.
292 # in case we are woken up for other reasons
293 # (current still defined), loop.
294 Coro::schedule while $current;
295 }
201 296
202=item cede 297=item cede
203 298
204"Cede" to other processes. This function puts the current process into the 299"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 300ready queue and calls C<schedule>, which has the effect of giving up the
206current "timeslice" to other coroutines of the same or higher priority. 301current "timeslice" to other coroutines of the same or higher priority.
207 302
208=cut 303Returns true if at least one coroutine switch has happened.
304
305=item Coro::cede_notself
306
307Works like cede, but is not exported by default and will cede to any
308coroutine, regardless of priority, once.
309
310Returns true if at least one coroutine switch has happened.
209 311
210=item terminate [arg...] 312=item terminate [arg...]
211 313
212Terminates the current process with the given status values (see L<cancel>). 314Terminates the current coroutine with the given status values (see L<cancel>).
315
316=item killall
317
318Kills/terminates/cancels all coroutines except the currently running
319one. This is useful after a fork, either in the child or the parent, as
320usually only one of them should inherit the running coroutines.
213 321
214=cut 322=cut
215 323
216sub terminate { 324sub terminate {
217 $current->cancel (@_); 325 $current->cancel (@_);
218} 326}
219 327
328sub killall {
329 for (Coro::State::list) {
330 $_->cancel
331 if $_ != $current && UNIVERSAL::isa $_, "Coro";
332 }
333}
334
220=back 335=back
221 336
222# dynamic methods 337# dynamic methods
223 338
224=head2 PROCESS METHODS 339=head2 COROUTINE METHODS
225 340
226These are the methods you can call on process objects. 341These are the methods you can call on coroutine objects.
227 342
228=over 4 343=over 4
229 344
230=item new Coro \&sub [, @args...] 345=item new Coro \&sub [, @args...]
231 346
232Create a new process and return it. When the sub returns the process 347Create a new coroutine and return it. When the sub returns the coroutine
233automatically terminates as if C<terminate> with the returned values were 348automatically 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 349called. To make the coroutine run you must first put it into the ready queue
235by calling the ready method. 350by calling the ready method.
236 351
237Calling C<exit> in a coroutine will not work correctly, so do not do that. 352See C<async> and C<Coro::State::new> for additional info about the
353coroutine environment.
238 354
239=cut 355=cut
240 356
241sub _new_coro { 357sub _run_coro {
242 terminate &{+shift}; 358 terminate &{+shift};
243} 359}
244 360
245sub new { 361sub new {
246 my $class = shift; 362 my $class = shift;
247 363
248 $class->SUPER::new (\&_new_coro, @_) 364 $class->SUPER::new (\&_run_coro, @_)
249} 365}
250 366
251=item $process->ready 367=item $success = $coroutine->ready
252 368
253Put the given process into the ready queue. 369Put the given coroutine into the ready queue (according to it's priority)
370and return true. If the coroutine is already in the ready queue, do nothing
371and return false.
254 372
255=cut 373=item $is_ready = $coroutine->is_ready
256 374
375Return wether the coroutine is currently the ready queue or not,
376
257=item $process->cancel (arg...) 377=item $coroutine->cancel (arg...)
258 378
259Terminates the given process and makes it return the given arguments as 379Terminates the given coroutine and makes it return the given arguments as
260status (default: the empty list). 380status (default: the empty list). Never returns if the coroutine is the
381current coroutine.
261 382
262=cut 383=cut
263 384
264sub cancel { 385sub cancel {
265 my $self = shift; 386 my $self = shift;
266 $self->{status} = [@_]; 387 $self->{_status} = [@_];
388
389 if ($current == $self) {
267 push @destroy, $self; 390 push @destroy, $self;
268 $manager->ready; 391 $manager->ready;
269 &schedule if $current == $self; 392 &schedule while 1;
393 } else {
394 $self->_cancel;
395 }
270} 396}
271 397
272=item $process->join 398=item $coroutine->join
273 399
274Wait until the coroutine terminates and return any values given to the 400Wait until the coroutine terminates and return any values given to the
275C<terminate> or C<cancel> functions. C<join> can be called multiple times 401C<terminate> or C<cancel> functions. C<join> can be called concurrently
276from multiple processes. 402from multiple coroutines.
277 403
278=cut 404=cut
279 405
280sub join { 406sub join {
281 my $self = shift; 407 my $self = shift;
408
282 unless ($self->{status}) { 409 unless ($self->{_status}) {
283 push @{$self->{join}}, $current; 410 my $current = $current;
284 &schedule; 411
412 push @{$self->{_on_destroy}}, sub {
413 $current->ready;
414 undef $current;
415 };
416
417 &schedule while $current;
285 } 418 }
419
286 wantarray ? @{$self->{status}} : $self->{status}[0]; 420 wantarray ? @{$self->{_status}} : $self->{_status}[0];
287} 421}
288 422
423=item $coroutine->on_destroy (\&cb)
424
425Registers a callback that is called when this coroutine gets destroyed,
426but before it is joined. The callback gets passed the terminate arguments,
427if any.
428
429=cut
430
431sub on_destroy {
432 my ($self, $cb) = @_;
433
434 push @{ $self->{_on_destroy} }, $cb;
435}
436
289=item $oldprio = $process->prio ($newprio) 437=item $oldprio = $coroutine->prio ($newprio)
290 438
291Sets (or gets, if the argument is missing) the priority of the 439Sets (or gets, if the argument is missing) the priority of the
292process. Higher priority processes get run before lower priority 440coroutine. Higher priority coroutines get run before lower priority
293processes. Priorities are small signed integers (currently -4 .. +3), 441coroutines. Priorities are small signed integers (currently -4 .. +3),
294that you can refer to using PRIO_xxx constants (use the import tag :prio 442that you can refer to using PRIO_xxx constants (use the import tag :prio
295to get then): 443to get then):
296 444
297 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 445 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
298 3 > 1 > 0 > -1 > -3 > -4 446 3 > 1 > 0 > -1 > -3 > -4
301 current->prio(PRIO_HIGH); 449 current->prio(PRIO_HIGH);
302 450
303The idle coroutine ($Coro::idle) always has a lower priority than any 451The idle coroutine ($Coro::idle) always has a lower priority than any
304existing coroutine. 452existing coroutine.
305 453
306Changing the priority of the current process will take effect immediately, 454Changing the priority of the current coroutine will take effect immediately,
307but changing the priority of processes in the ready queue (but not 455but changing the priority of coroutines in the ready queue (but not
308running) will only take effect after the next schedule (of that 456running) will only take effect after the next schedule (of that
309process). This is a bug that will be fixed in some future version. 457coroutine). This is a bug that will be fixed in some future version.
310 458
311=item $newprio = $process->nice ($change) 459=item $newprio = $coroutine->nice ($change)
312 460
313Similar to C<prio>, but subtract the given value from the priority (i.e. 461Similar to C<prio>, but subtract the given value from the priority (i.e.
314higher values mean lower priority, just as in unix). 462higher values mean lower priority, just as in unix).
315 463
316=item $olddesc = $process->desc ($newdesc) 464=item $olddesc = $coroutine->desc ($newdesc)
317 465
318Sets (or gets in case the argument is missing) the description for this 466Sets (or gets in case the argument is missing) the description for this
319process. This is just a free-form string you can associate with a process. 467coroutine. This is just a free-form string you can associate with a coroutine.
468
469This method simply sets the C<< $coroutine->{desc} >> member to the given string. You
470can modify this member directly if you wish.
320 471
321=cut 472=cut
322 473
323sub desc { 474sub desc {
324 my $old = $_[0]{desc}; 475 my $old = $_[0]{desc};
326 $old; 477 $old;
327} 478}
328 479
329=back 480=back
330 481
482=head2 GLOBAL FUNCTIONS
483
484=over 4
485
486=item Coro::nready
487
488Returns the number of coroutines that are currently in the ready state,
489i.e. that can be switched to. The value C<0> means that the only runnable
490coroutine is the currently running one, so C<cede> would have no effect,
491and C<schedule> would cause a deadlock unless there is an idle handler
492that wakes up some coroutines.
493
494=item my $guard = Coro::guard { ... }
495
496This creates and returns a guard object. Nothing happens until the object
497gets destroyed, in which case the codeblock given as argument will be
498executed. This is useful to free locks or other resources in case of a
499runtime error or when the coroutine gets canceled, as in both cases the
500guard block will be executed. The guard object supports only one method,
501C<< ->cancel >>, which will keep the codeblock from being executed.
502
503Example: set some flag and clear it again when the coroutine gets canceled
504or the function returns:
505
506 sub do_something {
507 my $guard = Coro::guard { $busy = 0 };
508 $busy = 1;
509
510 # do something that requires $busy to be true
511 }
512
513=cut
514
515sub guard(&) {
516 bless \(my $cb = $_[0]), "Coro::guard"
517}
518
519sub Coro::guard::cancel {
520 ${$_[0]} = sub { };
521}
522
523sub Coro::guard::DESTROY {
524 ${$_[0]}->();
525}
526
527
528=item unblock_sub { ... }
529
530This utility function takes a BLOCK or code reference and "unblocks" it,
531returning the new coderef. This means that the new coderef will return
532immediately without blocking, returning nothing, while the original code
533ref will be called (with parameters) from within its own coroutine.
534
535The reason this function exists is that many event libraries (such as the
536venerable L<Event|Event> module) are not coroutine-safe (a weaker form
537of thread-safety). This means you must not block within event callbacks,
538otherwise you might suffer from crashes or worse.
539
540This function allows your callbacks to block by executing them in another
541coroutine where it is safe to block. One example where blocking is handy
542is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
543disk.
544
545In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
546creating event callbacks that want to block.
547
548=cut
549
550our @unblock_queue;
551
552# we create a special coro because we want to cede,
553# to reduce pressure on the coro pool (because most callbacks
554# return immediately and can be reused) and because we cannot cede
555# inside an event callback.
556our $unblock_scheduler = new Coro sub {
557 while () {
558 while (my $cb = pop @unblock_queue) {
559 # this is an inlined copy of async_pool
560 my $coro = (pop @async_pool) || new Coro \&pool_handler;
561
562 $coro->{_invoke} = $cb;
563 $coro->ready;
564 cede; # for short-lived callbacks, this reduces pressure on the coro pool
565 }
566 schedule; # sleep well
567 }
568};
569$unblock_scheduler->desc ("[unblock_sub scheduler]");
570
571sub unblock_sub(&) {
572 my $cb = shift;
573
574 sub {
575 unshift @unblock_queue, [$cb, @_];
576 $unblock_scheduler->ready;
577 }
578}
579
580=back
581
331=cut 582=cut
332 583
3331; 5841;
334 585
335=head1 BUGS/LIMITATIONS 586=head1 BUGS/LIMITATIONS
336 587
337 - you must make very sure that no coro is still active on global 588 - you must make very sure that no coro is still active on global
338 destruction. very bad things might happen otherwise (usually segfaults). 589 destruction. very bad things might happen otherwise (usually segfaults).
339 590
340 - this module is not thread-safe. You should only ever use this module 591 - this module is not thread-safe. You should only ever use this module
341 from the same thread (this requirement might be losened in the future 592 from the same thread (this requirement might be loosened in the future
342 to allow per-thread schedulers, but Coro::State does not yet allow 593 to allow per-thread schedulers, but Coro::State does not yet allow
343 this). 594 this).
344 595
345=head1 SEE ALSO 596=head1 SEE ALSO
346 597

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines