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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines