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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines