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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines