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

Comparing Coro/Coro.pm (file contents):
Revision 1.80 by root, Mon Nov 6 19:56:26 2006 UTC vs.
Revision 1.131 by root, Thu Sep 20 12:24:42 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
35use strict; 44use strict;
36no warnings "uninitialized"; 45no warnings "uninitialized";
37 46
38use Coro::State; 47use Coro::State;
39 48
40use base Exporter::; 49use base qw(Coro::State Exporter);
41 50
42our $idle; # idle coroutine 51our $idle; # idle handler
43our $main; # main coroutine 52our $main; # main coroutine
44our $current; # current coroutine 53our $current; # current coroutine
45 54
46our $VERSION = '2.5'; 55our $VERSION = '3.7';
47 56
48our @EXPORT = qw(async cede schedule terminate current); 57our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
49our %EXPORT_TAGS = ( 58our %EXPORT_TAGS = (
50 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)],
51); 60);
52our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; 61our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
53 62
54{ 63{
55 my @async; 64 my @async;
56 my $init; 65 my $init;
57 66
58 # this way of handling attributes simply is NOT scalable ;() 67 # this way of handling attributes simply is NOT scalable ;()
59 sub import { 68 sub import {
60 no strict 'refs'; 69 no strict 'refs';
61 70
62 Coro->export_to_level(1, @_); 71 Coro->export_to_level (1, @_);
63 72
64 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 73 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
65 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { 74 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
66 my ($package, $ref) = (shift, shift); 75 my ($package, $ref) = (shift, shift);
67 my @attrs; 76 my @attrs;
95 104
96$main = new Coro; 105$main = new Coro;
97 106
98=item $current (or as function: current) 107=item $current (or as function: current)
99 108
100The 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).
101 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
102=cut 116=cut
117
118$main->{desc} = "[main::]";
103 119
104# maybe some other module used Coro::Specific before... 120# maybe some other module used Coro::Specific before...
105if ($current) {
106 $main->{specific} = $current->{specific}; 121$main->{specific} = $current->{specific}
107} 122 if $current;
108 123
109$current = $main; 124_set_current $main;
110 125
111sub current() { $current } 126sub current() { $current }
112 127
113=item $idle 128=item $idle
114 129
115The coroutine to switch to when no other coroutine is running. The default 130A callback that is called whenever the scheduler finds no ready coroutines
116implementation 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.
117 133
118=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.
119 137
120# should be done using priorities :( 138Please note that if your callback recursively invokes perl (e.g. for event
121$idle = new Coro sub { 139handlers), then it must be prepared to be called recursively.
122 print STDERR "FATAL: deadlock detected\n"; 140
123 exit(51); 141=cut
142
143$idle = sub {
144 require Carp;
145 Carp::croak ("FATAL: deadlock detected");
124}; 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}
125 159
126# this coroutine is necessary because a coroutine 160# this coroutine is necessary because a coroutine
127# cannot destroy itself. 161# cannot destroy itself.
128my @destroy; 162my @destroy;
129my $manager; 163my $manager;
164
130$manager = new Coro sub { 165$manager = new Coro sub {
166 $current->desc ("[coro manager]");
167
131 while () { 168 while () {
132 # by overwriting the state object with the manager we destroy it 169 (shift @destroy)->_cancel
133 # while still being able to schedule this coroutine (in case it has
134 # been readied multiple times. this is harmless since the manager
135 # can be called as many times as neccessary and will always
136 # remove itself from the runqueue
137 while (@destroy) { 170 while @destroy;
138 my $coro = pop @destroy;
139 $coro->{status} ||= [];
140 $_->ready for @{delete $coro->{join} || []};
141 171
142 # the next line destroys the _coro_state, but keeps the
143 # process itself intact (we basically make it a zombie
144 # process that always runs the manager thread, so it's possible
145 # to transfer() to this process).
146 $coro->{_coro_state} = $manager->{_coro_state};
147 }
148 &schedule; 172 &schedule;
149 } 173 }
150}; 174};
151 175
176$manager->prio (PRIO_MAX);
177
152# static methods. not really. 178# static methods. not really.
153 179
154=back 180=back
155 181
156=head2 STATIC METHODS 182=head2 STATIC METHODS
157 183
158Static methods are actually functions that operate on the current process only. 184Static methods are actually functions that operate on the current coroutine only.
159 185
160=over 4 186=over 4
161 187
162=item async { ... } [@args...] 188=item async { ... } [@args...]
163 189
164Create a new asynchronous process and return it's process object 190Create a new asynchronous coroutine and return it's coroutine object
165(usually unused). When the sub returns the new process is automatically 191(usually unused). When the sub returns the new coroutine is automatically
166terminated. 192terminated.
167 193
168When the coroutine dies, the program will exit, just as in the main 194Calling C<exit> in a coroutine will do the same as calling exit outside
169program. 195the coroutine. Likewise, when the coroutine dies, the program will exit,
196just as it would in the main program.
170 197
171 # create a new coroutine that just prints its arguments 198 # create a new coroutine that just prints its arguments
172 async { 199 async {
173 print "@_\n"; 200 print "@_\n";
174 } 1,2,3,4; 201 } 1,2,3,4;
175 202
176=cut 203=cut
177 204
178sub async(&@) { 205sub async(&@) {
179 my $pid = new Coro @_; 206 my $coro = new Coro @_;
180 $manager->ready; # this ensures that the stack is cloned from the manager
181 $pid->ready; 207 $coro->ready;
182 $pid; 208 $coro
209}
210
211=item async_pool { ... } [@args...]
212
213Similar to C<async>, but uses a coroutine pool, so you should not call
214terminate or join (although you are allowed to), and you get a coroutine
215that might have executed other code already (which can be good or bad :).
216
217Also, the block is executed in an C<eval> context and a warning will be
218issued in case of an exception instead of terminating the program, as
219C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
220will not work in the expected way, unless you call terminate or cancel,
221which somehow defeats the purpose of pooling.
222
223The priority will be reset to C<0> after each job, otherwise the coroutine
224will be re-used "as-is".
225
226The pool size is limited to 8 idle coroutines (this can be adjusted by
227changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
228required.
229
230If you are concerned about pooled coroutines growing a lot because a
231single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {
232terminate }> once per second or so to slowly replenish the pool.
233
234=cut
235
236our $POOL_SIZE = 8;
237our $MAX_POOL_RSS = 64 * 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
183} 268}
184 269
185=item schedule 270=item schedule
186 271
187Calls 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
188into the ready queue, so calling this function usually means you will 273into the ready queue, so calling this function usually means you will
189never be called again. 274never be called again unless something else (e.g. an event handler) calls
275ready.
190 276
191=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 }
192 295
193=item cede 296=item cede
194 297
195"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
196ready 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
197current "timeslice" to other coroutines of the same or higher priority. 300current "timeslice" to other coroutines of the same or higher priority.
198 301
199=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.
200 310
201=item terminate [arg...] 311=item terminate [arg...]
202 312
203Terminates the current process with the given status values (see L<cancel>). 313Terminates the current coroutine with the given status values (see L<cancel>).
204 314
205=cut 315=cut
206 316
207sub terminate { 317sub terminate {
208 $current->cancel (@_); 318 $current->cancel (@_);
210 320
211=back 321=back
212 322
213# dynamic methods 323# dynamic methods
214 324
215=head2 PROCESS METHODS 325=head2 COROUTINE METHODS
216 326
217These are the methods you can call on process objects. 327These are the methods you can call on coroutine objects.
218 328
219=over 4 329=over 4
220 330
221=item new Coro \&sub [, @args...] 331=item new Coro \&sub [, @args...]
222 332
223Create 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
224automatically terminates as if C<terminate> with the returned values were 334automatically terminates as if C<terminate> with the returned values were
225called. 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
226by calling the ready method. 336by calling the ready method.
227 337
228=cut 338See C<async> for additional discussion.
229 339
340=cut
341
230sub _newcoro { 342sub _run_coro {
231 terminate &{+shift}; 343 terminate &{+shift};
232} 344}
233 345
234sub new { 346sub new {
235 my $class = shift; 347 my $class = shift;
236 bless {
237 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
238 }, $class;
239}
240 348
241=item $process->ready 349 $class->SUPER::new (\&_run_coro, @_)
350}
242 351
243Put the given process into the ready queue. 352=item $success = $coroutine->ready
244 353
245=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.
246 357
358=item $is_ready = $coroutine->is_ready
359
360Return wether the coroutine is currently the ready queue or not,
361
247=item $process->cancel (arg...) 362=item $coroutine->cancel (arg...)
248 363
249Terminates the given process and makes it return the given arguments as 364Terminates the given coroutine and makes it return the given arguments as
250status (default: the empty list). 365status (default: the empty list). Never returns if the coroutine is the
366current coroutine.
251 367
252=cut 368=cut
253 369
254sub cancel { 370sub cancel {
255 my $self = shift; 371 my $self = shift;
256 $self->{status} = [@_]; 372 $self->{status} = [@_];
373
374 if ($current == $self) {
257 push @destroy, $self; 375 push @destroy, $self;
258 $manager->ready; 376 $manager->ready;
259 &schedule if $current == $self; 377 &schedule while 1;
378 } else {
379 $self->_cancel;
380 }
260} 381}
261 382
262=item $process->join 383=item $coroutine->join
263 384
264Wait until the coroutine terminates and return any values given to the 385Wait until the coroutine terminates and return any values given to the
265C<terminate> or C<cancel> functions. C<join> can be called multiple times 386C<terminate> or C<cancel> functions. C<join> can be called multiple times
266from multiple processes. 387from multiple coroutine.
267 388
268=cut 389=cut
269 390
270sub join { 391sub join {
271 my $self = shift; 392 my $self = shift;
393
272 unless ($self->{status}) { 394 unless ($self->{status}) {
273 push @{$self->{join}}, $current; 395 my $current = $current;
274 &schedule; 396
397 push @{$self->{destroy_cb}}, sub {
398 $current->ready;
399 undef $current;
400 };
401
402 &schedule while $current;
275 } 403 }
404
276 wantarray ? @{$self->{status}} : $self->{status}[0]; 405 wantarray ? @{$self->{status}} : $self->{status}[0];
277} 406}
278 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
279=item $oldprio = $process->prio($newprio) 422=item $oldprio = $coroutine->prio ($newprio)
280 423
281Sets (or gets, if the argument is missing) the priority of the 424Sets (or gets, if the argument is missing) the priority of the
282process. Higher priority processes get run before lower priority 425coroutine. Higher priority coroutines get run before lower priority
283processes. Priorities are small signed integers (currently -4 .. +3), 426coroutines. Priorities are small signed integers (currently -4 .. +3),
284that 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
285to get then): 428to get then):
286 429
287 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
288 3 > 1 > 0 > -1 > -3 > -4 431 3 > 1 > 0 > -1 > -3 > -4
291 current->prio(PRIO_HIGH); 434 current->prio(PRIO_HIGH);
292 435
293The idle coroutine ($Coro::idle) always has a lower priority than any 436The idle coroutine ($Coro::idle) always has a lower priority than any
294existing coroutine. 437existing coroutine.
295 438
296Changing the priority of the current process will take effect immediately, 439Changing the priority of the current coroutine will take effect immediately,
297but changing the priority of processes in the ready queue (but not 440but changing the priority of coroutines in the ready queue (but not
298running) will only take effect after the next schedule (of that 441running) will only take effect after the next schedule (of that
299process). 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.
300 443
301=cut
302
303sub prio {
304 my $old = $_[0]{prio};
305 $_[0]{prio} = $_[1] if @_ > 1;
306 $old;
307}
308
309=item $newprio = $process->nice($change) 444=item $newprio = $coroutine->nice ($change)
310 445
311Similar 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.
312higher values mean lower priority, just as in unix). 447higher values mean lower priority, just as in unix).
313 448
314=cut
315
316sub nice {
317 $_[0]{prio} -= $_[1];
318}
319
320=item $olddesc = $process->desc($newdesc) 449=item $olddesc = $coroutine->desc ($newdesc)
321 450
322Sets (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
323process. 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.
324 453
325=cut 454=cut
326 455
327sub desc { 456sub desc {
328 my $old = $_[0]{desc}; 457 my $old = $_[0]{desc};
330 $old; 459 $old;
331} 460}
332 461
333=back 462=back
334 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 = async {
539 $current->desc ("[unblock_sub scheduler]");
540 while () {
541 while (my $cb = pop @unblock_queue) {
542 # this is an inlined copy of async_pool
543 my $coro = (pop @pool or new Coro \&pool_handler);
544
545 $coro->{_invoke} = $cb;
546 $coro->ready;
547 cede; # for short-lived callbacks, this reduces pressure on the coro pool
548 }
549 schedule; # sleep well
550 }
551};
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
335=cut 564=cut
336 565
3371; 5661;
338 567
339=head1 BUGS/LIMITATIONS 568=head1 BUGS/LIMITATIONS
340 569
341 - you must make very sure that no coro is still active on global 570 - you must make very sure that no coro is still active on global
342 destruction. very bad things might happen otherwise (usually segfaults). 571 destruction. very bad things might happen otherwise (usually segfaults).
343 572
344 - this module is not thread-safe. You should only ever use this module 573 - this module is not thread-safe. You should only ever use this module
345 from the same thread (this requirement might be losened in the future 574 from the same thread (this requirement might be loosened in the future
346 to allow per-thread schedulers, but Coro::State does not yet allow 575 to allow per-thread schedulers, but Coro::State does not yet allow
347 this). 576 this).
348 577
349=head1 SEE ALSO 578=head1 SEE ALSO
350 579

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines