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.120 by root, Fri Apr 13 03:57:15 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
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.56';
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;
119my $manager; 161my $manager;
162
120$manager = new Coro sub { 163$manager = new Coro sub {
121 while() { 164 while () {
122 # by overwriting the state object with the manager we destroy it 165 (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) { 166 while @destroy;
128 my $coro = pop @destroy; 167
129 $coro->{status} ||= [];
130 $_->ready for @{delete $coro->{join} || []};
131 $coro->{_coro_state} = $manager->{_coro_state};
132 }
133 &schedule; 168 &schedule;
134 } 169 }
135}; 170};
136 171
172$manager->prio (PRIO_MAX);
173
137# static methods. not really. 174# static methods. not really.
138 175
176=back
177
139=head2 STATIC METHODS 178=head2 STATIC METHODS
140 179
141Static methods are actually functions that operate on the current process only. 180Static methods are actually functions that operate on the current coroutine only.
142 181
143=over 4 182=over 4
144 183
145=item async { ... } [@args...] 184=item async { ... } [@args...]
146 185
147Create a new asynchronous process and return it's process object 186Create a new asynchronous coroutine and return it's coroutine object
148(usually unused). When the sub returns the new process is automatically 187(usually unused). When the sub returns the new coroutine is automatically
149terminated. 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.
150 194
151 # create a new coroutine that just prints its arguments 195 # create a new coroutine that just prints its arguments
152 async { 196 async {
153 print "@_\n"; 197 print "@_\n";
154 } 1,2,3,4; 198 } 1,2,3,4;
155 199
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 200=cut
160 201
161sub async(&@) { 202sub async(&@) {
162 my $pid = new Coro @_; 203 my $coro = new Coro @_;
163 $manager->ready; # this ensures that the stack is cloned from the manager
164 $pid->ready; 204 $coro->ready;
165 $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
166} 261}
167 262
168=item schedule 263=item schedule
169 264
170Calls 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
171into the ready queue, so calling this function usually means you will 266into the ready queue, so calling this function usually means you will
172never be called again. 267never be called again unless something else (e.g. an event handler) calls
268ready.
173 269
174=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 }
175 288
176=item cede 289=item cede
177 290
178"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
179ready 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
180current "timeslice" to other coroutines of the same or higher priority. 293current "timeslice" to other coroutines of the same or higher priority.
181 294
182=cut 295Returns true if at least one coroutine switch has happened.
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.
183 303
184=item terminate [arg...] 304=item terminate [arg...]
185 305
186Terminates the current process. 306Terminates the current coroutine with the given status values (see L<cancel>).
187
188Future versions of this function will allow result arguments.
189 307
190=cut 308=cut
191 309
192sub terminate { 310sub terminate {
193 $current->{status} = [@_];
194 $current->cancel; 311 $current->cancel (@_);
195 &schedule;
196 die; # NORETURN
197} 312}
198 313
199=back 314=back
200 315
201# dynamic methods 316# dynamic methods
202 317
203=head2 PROCESS METHODS 318=head2 COROUTINE METHODS
204 319
205These are the methods you can call on process objects. 320These are the methods you can call on coroutine objects.
206 321
207=over 4 322=over 4
208 323
209=item new Coro \&sub [, @args...] 324=item new Coro \&sub [, @args...]
210 325
211Create 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
212automatically terminates as if C<terminate> with the returned values were 327automatically 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 328called. To make the coroutine run you must first put it into the ready queue
214by calling the ready method. 329by calling the ready method.
215 330
216=cut 331Calling C<exit> in a coroutine will not work correctly, so do not do that.
217 332
333=cut
334
218sub _newcoro { 335sub _run_coro {
219 terminate &{+shift}; 336 terminate &{+shift};
220} 337}
221 338
222sub new { 339sub new {
223 my $class = shift; 340 my $class = shift;
224 bless {
225 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
226 }, $class;
227}
228 341
229=item $process->ready 342 $class->SUPER::new (\&_run_coro, @_)
343}
230 344
231Put the given process into the ready queue. 345=item $success = $coroutine->ready
232 346
233=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.
234 350
235=item $process->cancel 351=item $is_ready = $coroutine->is_ready
236 352
237Like 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.
238 360
239=cut 361=cut
240 362
241sub cancel { 363sub cancel {
364 my $self = shift;
365 $self->{status} = [@_];
366
367 if ($current == $self) {
242 push @destroy, $_[0]; 368 push @destroy, $self;
243 $manager->ready; 369 $manager->ready;
244 &schedule if $current == $_[0]; 370 &schedule while 1;
371 } else {
372 $self->_cancel;
373 }
245} 374}
246 375
247=item $process->join 376=item $coroutine->join
248 377
249Wait until the coroutine terminates and return any values given to the 378Wait until the coroutine terminates and return any values given to the
250C<terminate> function. C<join> can be called multiple times from multiple 379C<terminate> or C<cancel> functions. C<join> can be called multiple times
251processes. 380from multiple coroutine.
252 381
253=cut 382=cut
254 383
255sub join { 384sub join {
256 my $self = shift; 385 my $self = shift;
386
257 unless ($self->{status}) { 387 unless ($self->{status}) {
258 push @{$self->{join}}, $current; 388 my $current = $current;
259 &schedule; 389
390 push @{$self->{destroy_cb}}, sub {
391 $current->ready;
392 undef $current;
393 };
394
395 &schedule while $current;
260 } 396 }
397
261 wantarray ? @{$self->{status}} : $self->{status}[0]; 398 wantarray ? @{$self->{status}} : $self->{status}[0];
262} 399}
263 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
264=item $oldprio = $process->prio($newprio) 415=item $oldprio = $coroutine->prio ($newprio)
265 416
266Sets (or gets, if the argument is missing) the priority of the 417Sets (or gets, if the argument is missing) the priority of the
267process. Higher priority processes get run before lower priority 418coroutine. Higher priority coroutines get run before lower priority
268processes. Priorities are smalled signed integer (currently -4 .. +3), 419coroutines. Priorities are small signed integers (currently -4 .. +3),
269that you can refer to using PRIO_xxx constants (use the import tag :prio 420that you can refer to using PRIO_xxx constants (use the import tag :prio
270to get then): 421to get then):
271 422
272 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
273 3 > 1 > 0 > -1 > -3 > -4 424 3 > 1 > 0 > -1 > -3 > -4
276 current->prio(PRIO_HIGH); 427 current->prio(PRIO_HIGH);
277 428
278The idle coroutine ($Coro::idle) always has a lower priority than any 429The idle coroutine ($Coro::idle) always has a lower priority than any
279existing coroutine. 430existing coroutine.
280 431
281Changing the priority of the current process will take effect immediately, 432Changing the priority of the current coroutine will take effect immediately,
282but changing the priority of processes in the ready queue (but not 433but changing the priority of coroutines in the ready queue (but not
283running) will only take effect after the next schedule (of that 434running) will only take effect after the next schedule (of that
284process). 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.
285 436
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) 437=item $newprio = $coroutine->nice ($change)
295 438
296Similar 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.
297higher values mean lower priority, just as in unix). 440higher values mean lower priority, just as in unix).
298 441
299=cut
300
301sub nice {
302 $_[0]{prio} -= $_[1];
303}
304
305=item $olddesc = $process->desc($newdesc) 442=item $olddesc = $coroutine->desc ($newdesc)
306 443
307Sets (or gets in case the argument is missing) the description for this 444Sets (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. 445coroutine. This is just a free-form string you can associate with a coroutine.
309 446
310=cut 447=cut
311 448
312sub desc { 449sub desc {
313 my $old = $_[0]{desc}; 450 my $old = $_[0]{desc};
315 $old; 452 $old;
316} 453}
317 454
318=back 455=back
319 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
320=cut 556=cut
321 557
3221; 5581;
323 559
324=head1 BUGS/LIMITATIONS 560=head1 BUGS/LIMITATIONS
325 561
326 - 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
327 very bad things might happen otherwise (usually segfaults). 563 destruction. very bad things might happen otherwise (usually segfaults).
564
328 - this module is not thread-safe. You should only ever use this module from 565 - 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 566 from the same thread (this requirement might be losened in the future
330 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).
331 569
332=head1 SEE ALSO 570=head1 SEE ALSO
333 571
334L<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>.
335L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 573
336L<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>
337 579
338=head1 AUTHOR 580=head1 AUTHOR
339 581
340 Marc Lehmann <pcg@goof.com> 582 Marc Lehmann <schmorp@schmorp.de>
341 http://www.goof.com/pcg/marc/ 583 http://home.schmorp.de/
342 584
343=cut 585=cut
344 586

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines