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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines