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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines