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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines