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

Comparing Coro/Coro.pm (file contents):
Revision 1.108 by root, Fri Jan 5 20:00:49 2007 UTC vs.
Revision 1.276 by root, Wed Apr 14 01:56:02 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3Coro - coroutine process abstraction 3Coro - the only real threads in perl
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use Coro; 7 use Coro;
8 8
9 async { 9 async {
10 # some asynchronous thread of execution 10 # some asynchronous thread of execution
11 print "2\n";
12 cede; # yield back to main
13 print "4\n";
11 }; 14 };
12 15 print "1\n";
13 # alternatively create an async coroutine like this: 16 cede; # yield to coro
14 17 print "3\n";
15 sub some_func : Coro { 18 cede; # and again
16 # some more async code 19
17 } 20 # use locking
18 21 use Coro::Semaphore;
19 cede; 22 my $lock = new Coro::Semaphore;
23 my $locked;
24
25 $lock->down;
26 $locked = 1;
27 $lock->up;
20 28
21=head1 DESCRIPTION 29=head1 DESCRIPTION
22 30
23This module collection manages coroutines. Coroutines are similar 31For a tutorial-style introduction, please read the L<Coro::Intro>
24to threads but don't run in parallel at the same time even on SMP 32manpage. This manpage mainly contains reference information.
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.
30 33
31(Perl, however, does not natively support real threads but instead does a 34This module collection manages continuations in general, most often in
32very slow and memory-intensive emulation of processes using threads. This 35the form of cooperative threads (also called coros, or simply "coro"
33is a performance win on Windows machines, and a loss everywhere else). 36in the documentation). They are similar to kernel threads but don't (in
37general) run in parallel at the same time even on SMP machines. The
38specific flavor of thread offered by this module also guarantees you that
39it will not switch between threads unless necessary, at easily-identified
40points in your program, so locking and parallel access are rarely an
41issue, making thread programming much safer and easier than using other
42thread models.
34 43
44Unlike the so-called "Perl threads" (which are not actually real threads
45but only the windows process emulation (see section of same name for more
46details) ported to unix, and as such act as processes), Coro provides
47a full shared address space, which makes communication between threads
48very easy. And Coro's threads are fast, too: disabling the Windows
49process emulation code in your perl and using Coro can easily result in
50a two to four times speed increase for your programs. A parallel matrix
51multiplication benchmark runs over 300 times faster on a single core than
52perl's pseudo-threads on a quad core using all four cores.
53
54Coro achieves that by supporting multiple running interpreters that share
55data, which is especially useful to code pseudo-parallel processes and
56for event-based programming, such as multiple HTTP-GET requests running
57concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro
58into an event-based environment.
59
35In this module, coroutines are defined as "callchain + lexical variables + 60In this module, a thread is defined as "callchain + lexical variables +
36@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, 61some package variables + C stack), that is, a thread has its own callchain,
37its own set of lexicals and its own set of perls most important global 62its own set of lexicals and its own set of perls most important global
38variables. 63variables (see L<Coro::State> for more configuration and background info).
64
65See also the C<SEE ALSO> section at the end of this document - the Coro
66module family is quite large.
39 67
40=cut 68=cut
41 69
42package Coro; 70package Coro;
43 71
44use strict; 72use common::sense;
45no warnings "uninitialized"; 73
74use Carp ();
75
76use Guard ();
46 77
47use Coro::State; 78use Coro::State;
48 79
49use base qw(Coro::State Exporter); 80use base qw(Coro::State Exporter);
50 81
51our $idle; # idle handler 82our $idle; # idle handler
52our $main; # main coroutine 83our $main; # main coro
53our $current; # current coroutine 84our $current; # current coro
54 85
55our $VERSION = '3.3'; 86our $VERSION = 5.22;
56 87
57our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 88our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait);
58our %EXPORT_TAGS = ( 89our %EXPORT_TAGS = (
59 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 90 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
60); 91);
61our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); 92our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
62 93
63{ 94=head1 GLOBAL VARIABLES
64 my @async;
65 my $init;
66
67 # this way of handling attributes simply is NOT scalable ;()
68 sub import {
69 no strict 'refs';
70
71 Coro->export_to_level (1, @_);
72
73 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
74 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
75 my ($package, $ref) = (shift, shift);
76 my @attrs;
77 for (@_) {
78 if ($_ eq "Coro") {
79 push @async, $ref;
80 unless ($init++) {
81 eval q{
82 sub INIT {
83 &async(pop @async) while @async;
84 }
85 };
86 }
87 } else {
88 push @attrs, $_;
89 }
90 }
91 return $old ? $old->($package, $ref, @attrs) : @attrs;
92 };
93 }
94
95}
96 95
97=over 4 96=over 4
98 97
99=item $main 98=item $Coro::main
100 99
101This coroutine represents the main program. 100This variable stores the Coro object that represents the main
101program. While you cna C<ready> it and do most other things you can do to
102coro, it is mainly useful to compare again C<$Coro::current>, to see
103whether you are running in the main program or not.
102 104
103=cut 105=cut
104 106
105$main = new Coro; 107# $main is now being initialised by Coro::State
106 108
107=item $current (or as function: current) 109=item $Coro::current
108 110
109The current coroutine (the last coroutine switched to). The initial value 111The Coro object representing the current coro (the last
112coro that the Coro scheduler switched to). The initial value is
110is C<$main> (of course). 113C<$Coro::main> (of course).
111 114
112This variable is B<strictly> I<read-only>. It is provided for performance 115This variable is B<strictly> I<read-only>. You can take copies of the
113reasons. If performance is not essentiel you are encouraged to use the 116value stored in it and use it as any other Coro object, but you must
114C<Coro::current> function instead. 117not otherwise modify the variable itself.
115 118
116=cut 119=cut
117 120
118# maybe some other module used Coro::Specific before...
119$main->{specific} = $current->{specific}
120 if $current;
121
122_set_current $main;
123
124sub current() { $current } 121sub current() { $current } # [DEPRECATED]
125 122
126=item $idle 123=item $Coro::idle
127 124
128A callback that is called whenever the scheduler finds no ready coroutines 125This variable is mainly useful to integrate Coro into event loops. It is
126usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is
127pretty low-level functionality.
128
129This variable stores a Coro object that is put into the ready queue when
130there are no other ready threads (without invoking any ready hooks).
131
129to run. The default implementation prints "FATAL: deadlock detected" and 132The default implementation dies with "FATAL: deadlock detected.", followed
130exits, because the program has no other way to continue. 133by a thread listing, because the program has no other way to continue.
131 134
132This hook is overwritten by modules such as C<Coro::Timer> and 135This hook is overwritten by modules such as C<Coro::EV> and
133C<Coro::Event> to wait on an external event that hopefully wake up a 136C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
134coroutine so the scheduler can run it. 137coro so the scheduler can run it.
135 138
136Please note that if your callback recursively invokes perl (e.g. for event 139See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique.
137handlers), then it must be prepared to be called recursively.
138 140
139=cut 141=cut
140 142
141$idle = sub { 143# ||= because other modules could have provided their own by now
142 require Carp; 144$idle ||= new Coro sub {
143 Carp::croak ("FATAL: deadlock detected"); 145 require Coro::Debug;
146 die "FATAL: deadlock detected.\n"
147 . Coro::Debug::ps_listing ();
144}; 148};
145 149
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}
157
158# this coroutine is necessary because a coroutine 150# this coro is necessary because a coro
159# cannot destroy itself. 151# cannot destroy itself.
160my @destroy; 152our @destroy;
161my $manager; 153our $manager;
162 154
163$manager = new Coro sub { 155$manager = new Coro sub {
164 while () { 156 while () {
165 (shift @destroy)->_cancel 157 Coro::State::cancel shift @destroy
166 while @destroy; 158 while @destroy;
167 159
168 &schedule; 160 &schedule;
169 } 161 }
170}; 162};
171 163$manager->{desc} = "[coro manager]";
172$manager->prio (PRIO_MAX); 164$manager->prio (PRIO_MAX);
173 165
174# static methods. not really.
175
176=back 166=back
177 167
178=head2 STATIC METHODS 168=head1 SIMPLE CORO CREATION
179
180Static methods are actually functions that operate on the current coroutine only.
181 169
182=over 4 170=over 4
183 171
184=item async { ... } [@args...] 172=item async { ... } [@args...]
185 173
186Create a new asynchronous coroutine and return it's coroutine object 174Create a new coro and return its Coro object (usually
187(usually unused). When the sub returns the new coroutine is automatically 175unused). The coro will be put into the ready queue, so
176it will start running automatically on the next scheduler run.
177
178The first argument is a codeblock/closure that should be executed in the
179coro. When it returns argument returns the coro is automatically
188terminated. 180terminated.
189 181
190Calling C<exit> in a coroutine will not work correctly, so do not do that. 182The remaining arguments are passed as arguments to the closure.
191 183
192When the coroutine dies, the program will exit, just as in the main 184See the C<Coro::State::new> constructor for info about the coro
193program. 185environment in which coro are executed.
194 186
187Calling C<exit> in a coro will do the same as calling exit outside
188the coro. Likewise, when the coro dies, the program will exit,
189just as it would in the main program.
190
191If you do not want that, you can provide a default C<die> handler, or
192simply avoid dieing (by use of C<eval>).
193
195 # create a new coroutine that just prints its arguments 194Example: Create a new coro that just prints its arguments.
195
196 async { 196 async {
197 print "@_\n"; 197 print "@_\n";
198 } 1,2,3,4; 198 } 1,2,3,4;
199 199
200=cut
201
202sub async(&@) {
203 my $coro = new Coro @_;
204 $coro->ready;
205 $coro
206}
207
208=item async_pool { ... } [@args...] 200=item async_pool { ... } [@args...]
209 201
210Similar to C<async>, but uses a coroutine pool, so you should not call 202Similar to C<async>, but uses a coro pool, so you should not call
211terminate or join (although you are allowed to), and you get a coroutine 203terminate or join on it (although you are allowed to), and you get a
212that might have executed other code already (which can be good or bad :). 204coro that might have executed other code already (which can be good
205or bad :).
213 206
207On the plus side, this function is about twice as fast as creating (and
208destroying) a completely new coro, so if you need a lot of generic
209coros in quick successsion, use C<async_pool>, not C<async>.
210
214Also, the block is executed in an C<eval> context and a warning will be 211The code 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 212issued in case of an exception instead of terminating the program, as
216C<async> does. As the coroutine is being reused, stuff like C<on_destroy> 213C<async> does. As the coro is being reused, stuff like C<on_destroy>
217will not work in the expected way, unless you call terminate or cancel, 214will not work in the expected way, unless you call terminate or cancel,
218which somehow defeats the purpose of pooling. 215which somehow defeats the purpose of pooling (but is fine in the
216exceptional case).
219 217
220The priority will be reset to C<0> after each job, otherwise the coroutine 218The priority will be reset to C<0> after each run, tracing will be
221will be re-used "as-is". 219disabled, the description will be reset and the default output filehandle
220gets restored, so you can change all these. Otherwise the coro will
221be re-used "as-is": most notably if you change other per-coro global
222stuff such as C<$/> you I<must needs> revert that change, which is most
223simply done by using local as in: C<< local $/ >>.
222 224
223The pool size is limited to 8 idle coroutines (this can be adjusted by 225The idle pool size is limited to C<8> idle coros (this can be
224changing $Coro::POOL_SIZE), and there can be as many non-idle coros as 226adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
225required. 227coros as required.
226 228
227If you are concerned about pooled coroutines growing a lot because a 229If you are concerned about pooled coros growing a lot because a
228single C<async_pool> used a lot of stackspace you can e.g. C<async_pool { 230single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
229terminate }> once per second or so to slowly replenish the pool. 231{ terminate }> once per second or so to slowly replenish the pool. In
232addition to that, when the stacks used by a handler grows larger than 32kb
233(adjustable via $Coro::POOL_RSS) it will also be destroyed.
230 234
231=cut 235=cut
232 236
233our $POOL_SIZE = 8; 237our $POOL_SIZE = 8;
238our $POOL_RSS = 32 * 1024;
234our @pool; 239our @async_pool;
235 240
236sub pool_handler { 241sub pool_handler {
237 while () { 242 while () {
238 my ($cb, @arg) = @{ delete $current->{_invoke} };
239
240 eval { 243 eval {
241 $cb->(@arg); 244 &{&_pool_handler} while 1;
242 }; 245 };
246
243 warn $@ if $@; 247 warn $@ if $@;
244
245 last if @pool >= $POOL_SIZE;
246 push @pool, $current;
247
248 $current->prio (0);
249 schedule;
250 } 248 }
251} 249}
252 250
253sub async_pool(&@) { 251=back
254 # this is also inlined into the unlock_scheduler
255 my $coro = (pop @pool or new Coro \&pool_handler);
256 252
257 $coro->{_invoke} = [@_]; 253=head1 STATIC METHODS
258 $coro->ready;
259 254
260 $coro 255Static methods are actually functions that implicitly operate on the
256current coro.
257
258=over 4
259
260=item schedule
261
262Calls the scheduler. The scheduler will find the next coro that is
263to be run from the ready queue and switches to it. The next coro
264to be run is simply the one with the highest priority that is longest
265in its ready queue. If there is no coro ready, it will call the
266C<$Coro::idle> hook.
267
268Please note that the current coro will I<not> be put into the ready
269queue, so calling this function usually means you will never be called
270again unless something else (e.g. an event handler) calls C<< ->ready >>,
271thus waking you up.
272
273This makes C<schedule> I<the> generic method to use to block the current
274coro and wait for events: first you remember the current coro in
275a variable, then arrange for some callback of yours to call C<< ->ready
276>> on that once some event happens, and last you call C<schedule> to put
277yourself to sleep. Note that a lot of things can wake your coro up,
278so you need to check whether the event indeed happened, e.g. by storing the
279status in a variable.
280
281See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks.
282
283=item cede
284
285"Cede" to other coros. This function puts the current coro into
286the ready queue and calls C<schedule>, which has the effect of giving
287up the current "timeslice" to other coros of the same or higher
288priority. Once your coro gets its turn again it will automatically be
289resumed.
290
291This function is often called C<yield> in other languages.
292
293=item Coro::cede_notself
294
295Works like cede, but is not exported by default and will cede to I<any>
296coro, regardless of priority. This is useful sometimes to ensure
297progress is made.
298
299=item terminate [arg...]
300
301Terminates the current coro with the given status values (see L<cancel>).
302
303=item Coro::on_enter BLOCK, Coro::on_leave BLOCK
304
305These function install enter and leave winders in the current scope. The
306enter block will be executed when on_enter is called and whenever the
307current coro is re-entered by the scheduler, while the leave block is
308executed whenever the current coro is blocked by the scheduler, and
309also when the containing scope is exited (by whatever means, be it exit,
310die, last etc.).
311
312I<Neither invoking the scheduler, nor exceptions, are allowed within those
313BLOCKs>. That means: do not even think about calling C<die> without an
314eval, and do not even think of entering the scheduler in any way.
315
316Since both BLOCKs are tied to the current scope, they will automatically
317be removed when the current scope exits.
318
319These functions implement the same concept as C<dynamic-wind> in scheme
320does, and are useful when you want to localise some resource to a specific
321coro.
322
323They slow down thread switching considerably for coros that use them
324(about 40% for a BLOCK with a single assignment, so thread switching is
325still reasonably fast if the handlers are fast).
326
327These functions are best understood by an example: The following function
328will change the current timezone to "Antarctica/South_Pole", which
329requires a call to C<tzset>, but by using C<on_enter> and C<on_leave>,
330which remember/change the current timezone and restore the previous
331value, respectively, the timezone is only changed for the coro that
332installed those handlers.
333
334 use POSIX qw(tzset);
335
336 async {
337 my $old_tz; # store outside TZ value here
338
339 Coro::on_enter {
340 $old_tz = $ENV{TZ}; # remember the old value
341
342 $ENV{TZ} = "Antarctica/South_Pole";
343 tzset; # enable new value
344 };
345
346 Coro::on_leave {
347 $ENV{TZ} = $old_tz;
348 tzset; # restore old value
349 };
350
351 # at this place, the timezone is Antarctica/South_Pole,
352 # without disturbing the TZ of any other coro.
353 };
354
355This can be used to localise about any resource (locale, uid, current
356working directory etc.) to a block, despite the existance of other
357coros.
358
359Another interesting example implements time-sliced multitasking using
360interval timers (this could obviously be optimised, but does the job):
361
362 # "timeslice" the given block
363 sub timeslice(&) {
364 use Time::HiRes ();
365
366 Coro::on_enter {
367 # on entering the thread, we set an VTALRM handler to cede
368 $SIG{VTALRM} = sub { cede };
369 # and then start the interval timer
370 Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01;
371 };
372 Coro::on_leave {
373 # on leaving the thread, we stop the interval timer again
374 Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0;
375 };
376
377 &{+shift};
378 }
379
380 # use like this:
381 timeslice {
382 # The following is an endless loop that would normally
383 # monopolise the process. Since it runs in a timesliced
384 # environment, it will regularly cede to other threads.
385 while () { }
386 };
387
388
389=item killall
390
391Kills/terminates/cancels all coros except the currently running one.
392
393Note that while this will try to free some of the main interpreter
394resources if the calling coro isn't the main coro, but one
395cannot free all of them, so if a coro that is not the main coro
396calls this function, there will be some one-time resource leak.
397
398=cut
399
400sub killall {
401 for (Coro::State::list) {
402 $_->cancel
403 if $_ != $current && UNIVERSAL::isa $_, "Coro";
404 }
261} 405}
262 406
263=item schedule 407=back
264 408
265Calls the scheduler. Please note that the current coroutine will not be put 409=head1 CORO OBJECT METHODS
266into the ready queue, so calling this function usually means you will
267never be called again unless something else (e.g. an event handler) calls
268ready.
269 410
270The canonical way to wait on external events is this: 411These are the methods you can call on coro objects (or to create
412them).
271 413
414=over 4
415
416=item new Coro \&sub [, @args...]
417
418Create a new coro and return it. When the sub returns, the coro
419automatically terminates as if C<terminate> with the returned values were
420called. To make the coro run you must first put it into the ready
421queue by calling the ready method.
422
423See C<async> and C<Coro::State::new> for additional info about the
424coro environment.
425
426=cut
427
428sub _coro_run {
429 terminate &{+shift};
430}
431
432=item $success = $coro->ready
433
434Put the given coro into the end of its ready queue (there is one
435queue for each priority) and return true. If the coro is already in
436the ready queue, do nothing and return false.
437
438This ensures that the scheduler will resume this coro automatically
439once all the coro of higher priority and all coro of the same
440priority that were put into the ready queue earlier have been resumed.
441
442=item $coro->suspend
443
444Suspends the specified coro. A suspended coro works just like any other
445coro, except that the scheduler will not select a suspended coro for
446execution.
447
448Suspending a coro can be useful when you want to keep the coro from
449running, but you don't want to destroy it, or when you want to temporarily
450freeze a coro (e.g. for debugging) to resume it later.
451
452A scenario for the former would be to suspend all (other) coros after a
453fork and keep them alive, so their destructors aren't called, but new
454coros can be created.
455
456=item $coro->resume
457
458If the specified coro was suspended, it will be resumed. Note that when
459the coro was in the ready queue when it was suspended, it might have been
460unreadied by the scheduler, so an activation might have been lost.
461
462To avoid this, it is best to put a suspended coro into the ready queue
463unconditionally, as every synchronisation mechanism must protect itself
464against spurious wakeups, and the one in the Coro family certainly do
465that.
466
467=item $is_ready = $coro->is_ready
468
469Returns true iff the Coro object is in the ready queue. Unless the Coro
470object gets destroyed, it will eventually be scheduled by the scheduler.
471
472=item $is_running = $coro->is_running
473
474Returns true iff the Coro object is currently running. Only one Coro object
475can ever be in the running state (but it currently is possible to have
476multiple running Coro::States).
477
478=item $is_suspended = $coro->is_suspended
479
480Returns true iff this Coro object has been suspended. Suspended Coros will
481not ever be scheduled.
482
483=item $coro->cancel (arg...)
484
485Terminates the given Coro and makes it return the given arguments as
486status (default: the empty list). Never returns if the Coro is the
487current Coro.
488
489=cut
490
491sub cancel {
492 my $self = shift;
493
494 if ($current == $self) {
495 terminate @_;
496 } else {
497 $self->{_status} = [@_];
498 Coro::State::cancel $self;
272 { 499 }
273 # remember current coroutine 500}
501
502=item $coro->schedule_to
503
504Puts the current coro to sleep (like C<Coro::schedule>), but instead
505of continuing with the next coro from the ready queue, always switch to
506the given coro object (regardless of priority etc.). The readyness
507state of that coro isn't changed.
508
509This is an advanced method for special cases - I'd love to hear about any
510uses for this one.
511
512=item $coro->cede_to
513
514Like C<schedule_to>, but puts the current coro into the ready
515queue. This has the effect of temporarily switching to the given
516coro, and continuing some time later.
517
518This is an advanced method for special cases - I'd love to hear about any
519uses for this one.
520
521=item $coro->throw ([$scalar])
522
523If C<$throw> is specified and defined, it will be thrown as an exception
524inside the coro at the next convenient point in time. Otherwise
525clears the exception object.
526
527Coro will check for the exception each time a schedule-like-function
528returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down
529>>, C<< Coro::Handle->readable >> and so on. Most of these functions
530detect this case and return early in case an exception is pending.
531
532The exception object will be thrown "as is" with the specified scalar in
533C<$@>, i.e. if it is a string, no line number or newline will be appended
534(unlike with C<die>).
535
536This can be used as a softer means than C<cancel> to ask a coro to
537end itself, although there is no guarantee that the exception will lead to
538termination, and if the exception isn't caught it might well end the whole
539program.
540
541You might also think of C<throw> as being the moral equivalent of
542C<kill>ing a coro with a signal (in this case, a scalar).
543
544=item $coro->join
545
546Wait until the coro terminates and return any values given to the
547C<terminate> or C<cancel> functions. C<join> can be called concurrently
548from multiple coro, and all will be resumed and given the status
549return once the C<$coro> terminates.
550
551=cut
552
553sub join {
554 my $self = shift;
555
556 unless ($self->{_status}) {
274 my $current = $Coro::current; 557 my $current = $current;
275 558
276 # register a hypothetical event handler 559 push @{$self->{_on_destroy}}, sub {
277 on_event_invoke sub {
278 # wake up sleeping coroutine
279 $current->ready; 560 $current->ready;
280 undef $current; 561 undef $current;
281 }; 562 };
282 563
283 # call schedule until event occured.
284 # in case we are woken up for other reasons
285 # (current still defined), loop.
286 Coro::schedule while $current;
287 }
288
289=item cede
290
291"Cede" to other coroutines. This function puts the current coroutine into the
292ready queue and calls C<schedule>, which has the effect of giving up the
293current "timeslice" to other coroutines of the same or higher priority.
294
295Returns true if at least one coroutine switch has happened.
296
297=item Coro::cede_notself
298
299Works like cede, but is not exported by default and will cede to any
300coroutine, regardless of priority, once.
301
302Returns true if at least one coroutine switch has happened.
303
304=item terminate [arg...]
305
306Terminates the current coroutine with the given status values (see L<cancel>).
307
308=cut
309
310sub terminate {
311 $current->cancel (@_);
312}
313
314=back
315
316# dynamic methods
317
318=head2 COROUTINE METHODS
319
320These are the methods you can call on coroutine objects.
321
322=over 4
323
324=item new Coro \&sub [, @args...]
325
326Create a new coroutine and return it. When the sub returns the coroutine
327automatically terminates as if C<terminate> with the returned values were
328called. To make the coroutine run you must first put it into the ready queue
329by calling the ready method.
330
331Calling C<exit> in a coroutine will not work correctly, so do not do that.
332
333=cut
334
335sub _run_coro {
336 terminate &{+shift};
337}
338
339sub new {
340 my $class = shift;
341
342 $class->SUPER::new (\&_run_coro, @_)
343}
344
345=item $success = $coroutine->ready
346
347Put the given coroutine into the ready queue (according to it's priority)
348and return true. If the coroutine is already in the ready queue, do nothing
349and return false.
350
351=item $is_ready = $coroutine->is_ready
352
353Return wether the coroutine is currently the ready queue or not,
354
355=item $coroutine->cancel (arg...)
356
357Terminates the given coroutine and makes it return the given arguments as
358status (default: the empty list). Never returns if the coroutine is the
359current coroutine.
360
361=cut
362
363sub cancel {
364 my $self = shift;
365 $self->{status} = [@_];
366
367 if ($current == $self) {
368 push @destroy, $self;
369 $manager->ready;
370 &schedule while 1;
371 } else {
372 $self->_cancel;
373 }
374}
375
376=item $coroutine->join
377
378Wait until the coroutine terminates and return any values given to the
379C<terminate> or C<cancel> functions. C<join> can be called multiple times
380from multiple coroutine.
381
382=cut
383
384sub join {
385 my $self = shift;
386
387 unless ($self->{status}) {
388 my $current = $current;
389
390 push @{$self->{destroy_cb}}, sub {
391 $current->ready;
392 undef $current;
393 };
394
395 &schedule while $current; 564 &schedule while $current;
396 } 565 }
397 566
398 wantarray ? @{$self->{status}} : $self->{status}[0]; 567 wantarray ? @{$self->{_status}} : $self->{_status}[0];
399} 568}
400 569
401=item $coroutine->on_destroy (\&cb) 570=item $coro->on_destroy (\&cb)
402 571
403Registers a callback that is called when this coroutine gets destroyed, 572Registers a callback that is called when this coro gets destroyed,
404but before it is joined. The callback gets passed the terminate arguments, 573but before it is joined. The callback gets passed the terminate arguments,
405if any. 574if any, and I<must not> die, under any circumstances.
406 575
407=cut 576=cut
408 577
409sub on_destroy { 578sub on_destroy {
410 my ($self, $cb) = @_; 579 my ($self, $cb) = @_;
411 580
412 push @{ $self->{destroy_cb} }, $cb; 581 push @{ $self->{_on_destroy} }, $cb;
413} 582}
414 583
415=item $oldprio = $coroutine->prio ($newprio) 584=item $oldprio = $coro->prio ($newprio)
416 585
417Sets (or gets, if the argument is missing) the priority of the 586Sets (or gets, if the argument is missing) the priority of the
418coroutine. Higher priority coroutines get run before lower priority 587coro. Higher priority coro get run before lower priority
419coroutines. Priorities are small signed integers (currently -4 .. +3), 588coro. Priorities are small signed integers (currently -4 .. +3),
420that you can refer to using PRIO_xxx constants (use the import tag :prio 589that you can refer to using PRIO_xxx constants (use the import tag :prio
421to get then): 590to get then):
422 591
423 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 592 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
424 3 > 1 > 0 > -1 > -3 > -4 593 3 > 1 > 0 > -1 > -3 > -4
425 594
426 # set priority to HIGH 595 # set priority to HIGH
427 current->prio(PRIO_HIGH); 596 current->prio (PRIO_HIGH);
428 597
429The idle coroutine ($Coro::idle) always has a lower priority than any 598The idle coro ($Coro::idle) always has a lower priority than any
430existing coroutine. 599existing coro.
431 600
432Changing the priority of the current coroutine will take effect immediately, 601Changing the priority of the current coro will take effect immediately,
433but changing the priority of coroutines in the ready queue (but not 602but changing the priority of coro in the ready queue (but not
434running) will only take effect after the next schedule (of that 603running) will only take effect after the next schedule (of that
435coroutine). This is a bug that will be fixed in some future version. 604coro). This is a bug that will be fixed in some future version.
436 605
437=item $newprio = $coroutine->nice ($change) 606=item $newprio = $coro->nice ($change)
438 607
439Similar to C<prio>, but subtract the given value from the priority (i.e. 608Similar to C<prio>, but subtract the given value from the priority (i.e.
440higher values mean lower priority, just as in unix). 609higher values mean lower priority, just as in unix).
441 610
442=item $olddesc = $coroutine->desc ($newdesc) 611=item $olddesc = $coro->desc ($newdesc)
443 612
444Sets (or gets in case the argument is missing) the description for this 613Sets (or gets in case the argument is missing) the description for this
445coroutine. This is just a free-form string you can associate with a coroutine. 614coro. This is just a free-form string you can associate with a
615coro.
616
617This method simply sets the C<< $coro->{desc} >> member to the given
618string. You can modify this member directly if you wish.
446 619
447=cut 620=cut
448 621
449sub desc { 622sub desc {
450 my $old = $_[0]{desc}; 623 my $old = $_[0]{desc};
451 $_[0]{desc} = $_[1] if @_ > 1; 624 $_[0]{desc} = $_[1] if @_ > 1;
452 $old; 625 $old;
453} 626}
454 627
628sub transfer {
629 require Carp;
630 Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught");
631}
632
455=back 633=back
456 634
457=head2 GLOBAL FUNCTIONS 635=head1 GLOBAL FUNCTIONS
458 636
459=over 4 637=over 4
460 638
461=item Coro::nready 639=item Coro::nready
462 640
463Returns the number of coroutines that are currently in the ready state, 641Returns the number of coro that are currently in the ready state,
464i.e. that can be swicthed to. The value C<0> means that the only runnable 642i.e. that can be switched to by calling C<schedule> directory or
643indirectly. The value C<0> means that the only runnable coro is the
465coroutine is the currently running one, so C<cede> would have no effect, 644currently running one, so C<cede> would have no effect, and C<schedule>
466and C<schedule> would cause a deadlock unless there is an idle handler 645would cause a deadlock unless there is an idle handler that wakes up some
467that wakes up some coroutines. 646coro.
468 647
469=item my $guard = Coro::guard { ... } 648=item my $guard = Coro::guard { ... }
470 649
471This creates and returns a guard object. Nothing happens until the objetc 650This function still exists, but is deprecated. Please use the
472gets destroyed, in which case the codeblock given as argument will be 651C<Guard::guard> function instead.
473executed. This is useful to free locks or other resources in case of a
474runtime error or when the coroutine gets canceled, as in both cases the
475guard block will be executed. The guard object supports only one method,
476C<< ->cancel >>, which will keep the codeblock from being executed.
477 652
478Example: set some flag and clear it again when the coroutine gets canceled
479or the function returns:
480
481 sub do_something {
482 my $guard = Coro::guard { $busy = 0 };
483 $busy = 1;
484
485 # do something that requires $busy to be true
486 }
487
488=cut 653=cut
489 654
490sub guard(&) { 655BEGIN { *guard = \&Guard::guard }
491 bless \(my $cb = $_[0]), "Coro::guard"
492}
493
494sub Coro::guard::cancel {
495 ${$_[0]} = sub { };
496}
497
498sub Coro::guard::DESTROY {
499 ${$_[0]}->();
500}
501
502 656
503=item unblock_sub { ... } 657=item unblock_sub { ... }
504 658
505This utility function takes a BLOCK or code reference and "unblocks" it, 659This utility function takes a BLOCK or code reference and "unblocks" it,
506returning the new coderef. This means that the new coderef will return 660returning a new coderef. Unblocking means that calling the new coderef
507immediately without blocking, returning nothing, while the original code 661will return immediately without blocking, returning nothing, while the
508ref will be called (with parameters) from within its own coroutine. 662original code ref will be called (with parameters) from within another
663coro.
509 664
510The reason this fucntion exists is that many event libraries (such as the 665The reason this function exists is that many event libraries (such as the
511venerable L<Event|Event> module) are not coroutine-safe (a weaker form 666venerable L<Event|Event> module) are not thread-safe (a weaker form
512of thread-safety). This means you must not block within event callbacks, 667of reentrancy). This means you must not block within event callbacks,
513otherwise you might suffer from crashes or worse. 668otherwise you might suffer from crashes or worse. The only event library
669currently known that is safe to use without C<unblock_sub> is L<EV>.
670
671Coro will try to catch you when you block in the event loop
672("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and
673only works when you do not run your own event loop.
514 674
515This function allows your callbacks to block by executing them in another 675This function allows your callbacks to block by executing them in another
516coroutine where it is safe to block. One example where blocking is handy 676coro where it is safe to block. One example where blocking is handy
517is when you use the L<Coro::AIO|Coro::AIO> functions to save results to 677is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
518disk. 678disk, for example.
519 679
520In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when 680In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
521creating event callbacks that want to block. 681creating event callbacks that want to block.
682
683If your handler does not plan to block (e.g. simply sends a message to
684another coro, or puts some other coro into the ready queue), there is
685no reason to use C<unblock_sub>.
686
687Note that you also need to use C<unblock_sub> for any other callbacks that
688are indirectly executed by any C-based event loop. For example, when you
689use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
690provides callbacks that are the result of some event callback, then you
691must not block either, or use C<unblock_sub>.
522 692
523=cut 693=cut
524 694
525our @unblock_queue; 695our @unblock_queue;
526 696
527# we create a special coro because we want to cede, 697# we create a special coro because we want to cede,
528# to reduce pressure on the coro pool (because most callbacks 698# to reduce pressure on the coro pool (because most callbacks
529# return immediately and can be reused) and because we cannot cede 699# return immediately and can be reused) and because we cannot cede
530# inside an event callback. 700# inside an event callback.
531our $unblock_scheduler = async { 701our $unblock_scheduler = new Coro sub {
532 while () { 702 while () {
533 while (my $cb = pop @unblock_queue) { 703 while (my $cb = pop @unblock_queue) {
534 # this is an inlined copy of async_pool 704 &async_pool (@$cb);
535 my $coro = (pop @pool or new Coro \&pool_handler);
536 705
537 $coro->{_invoke} = $cb;
538 $coro->ready;
539 cede; # for short-lived callbacks, this reduces pressure on the coro pool 706 # for short-lived callbacks, this reduces pressure on the coro pool
707 # as the chance is very high that the async_poll coro will be back
708 # in the idle state when cede returns
709 cede;
540 } 710 }
541 schedule; # sleep well 711 schedule; # sleep well
542 } 712 }
543}; 713};
714$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
544 715
545sub unblock_sub(&) { 716sub unblock_sub(&) {
546 my $cb = shift; 717 my $cb = shift;
547 718
548 sub { 719 sub {
549 unshift @unblock_queue, [$cb, @_]; 720 unshift @unblock_queue, [$cb, @_];
550 $unblock_scheduler->ready; 721 $unblock_scheduler->ready;
551 } 722 }
552} 723}
553 724
725=item $cb = rouse_cb
726
727Create and return a "rouse callback". That's a code reference that,
728when called, will remember a copy of its arguments and notify the owner
729coro of the callback.
730
731See the next function.
732
733=item @args = rouse_wait [$cb]
734
735Wait for the specified rouse callback (or the last one that was created in
736this coro).
737
738As soon as the callback is invoked (or when the callback was invoked
739before C<rouse_wait>), it will return the arguments originally passed to
740the rouse callback. In scalar context, that means you get the I<last>
741argument, just as if C<rouse_wait> had a C<return ($a1, $a2, $a3...)>
742statement at the end.
743
744See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.
745
554=back 746=back
555 747
556=cut 748=cut
557 749
5581; 7501;
559 751
752=head1 HOW TO WAIT FOR A CALLBACK
753
754It is very common for a coro to wait for some callback to be
755called. This occurs naturally when you use coro in an otherwise
756event-based program, or when you use event-based libraries.
757
758These typically register a callback for some event, and call that callback
759when the event occured. In a coro, however, you typically want to
760just wait for the event, simplyifying things.
761
762For example C<< AnyEvent->child >> registers a callback to be called when
763a specific child has exited:
764
765 my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });
766
767But from within a coro, you often just want to write this:
768
769 my $status = wait_for_child $pid;
770
771Coro offers two functions specifically designed to make this easy,
772C<Coro::rouse_cb> and C<Coro::rouse_wait>.
773
774The first function, C<rouse_cb>, generates and returns a callback that,
775when invoked, will save its arguments and notify the coro that
776created the callback.
777
778The second function, C<rouse_wait>, waits for the callback to be called
779(by calling C<schedule> to go to sleep) and returns the arguments
780originally passed to the callback.
781
782Using these functions, it becomes easy to write the C<wait_for_child>
783function mentioned above:
784
785 sub wait_for_child($) {
786 my ($pid) = @_;
787
788 my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb);
789
790 my ($rpid, $rstatus) = Coro::rouse_wait;
791 $rstatus
792 }
793
794In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough,
795you can roll your own, using C<schedule>:
796
797 sub wait_for_child($) {
798 my ($pid) = @_;
799
800 # store the current coro in $current,
801 # and provide result variables for the closure passed to ->child
802 my $current = $Coro::current;
803 my ($done, $rstatus);
804
805 # pass a closure to ->child
806 my $watcher = AnyEvent->child (pid => $pid, cb => sub {
807 $rstatus = $_[1]; # remember rstatus
808 $done = 1; # mark $rstatus as valud
809 });
810
811 # wait until the closure has been called
812 schedule while !$done;
813
814 $rstatus
815 }
816
817
560=head1 BUGS/LIMITATIONS 818=head1 BUGS/LIMITATIONS
561 819
562 - you must make very sure that no coro is still active on global 820=over 4
563 destruction. very bad things might happen otherwise (usually segfaults).
564 821
822=item fork with pthread backend
823
824When Coro is compiled using the pthread backend (which isn't recommended
825but required on many BSDs as their libcs are completely broken), then
826coro will not survive a fork. There is no known workaround except to
827fix your libc and use a saner backend.
828
829=item perl process emulation ("threads")
830
565 - this module is not thread-safe. You should only ever use this module 831This module is not perl-pseudo-thread-safe. You should only ever use this
566 from the same thread (this requirement might be losened in the future 832module from the first thread (this requirement might be removed in the
567 to allow per-thread schedulers, but Coro::State does not yet allow 833future to allow per-thread schedulers, but Coro::State does not yet allow
568 this). 834this). I recommend disabling thread support and using processes, as having
835the windows process emulation enabled under unix roughly halves perl
836performance, even when not used.
837
838=item coro switching is not signal safe
839
840You must not switch to another coro from within a signal handler (only
841relevant with %SIG - most event libraries provide safe signals), I<unless>
842you are sure you are not interrupting a Coro function.
843
844That means you I<MUST NOT> call any function that might "block" the
845current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
846anything that calls those. Everything else, including calling C<ready>,
847works.
848
849=back
850
851
852=head1 WINDOWS PROCESS EMULATION
853
854A great many people seem to be confused about ithreads (for example, Chip
855Salzenberg called me unintelligent, incapable, stupid and gullible,
856while in the same mail making rather confused statements about perl
857ithreads (for example, that memory or files would be shared), showing his
858lack of understanding of this area - if it is hard to understand for Chip,
859it is probably not obvious to everybody).
860
861What follows is an ultra-condensed version of my talk about threads in
862scripting languages given onthe perl workshop 2009:
863
864The so-called "ithreads" were originally implemented for two reasons:
865first, to (badly) emulate unix processes on native win32 perls, and
866secondly, to replace the older, real thread model ("5.005-threads").
867
868It does that by using threads instead of OS processes. The difference
869between processes and threads is that threads share memory (and other
870state, such as files) between threads within a single process, while
871processes do not share anything (at least not semantically). That
872means that modifications done by one thread are seen by others, while
873modifications by one process are not seen by other processes.
874
875The "ithreads" work exactly like that: when creating a new ithreads
876process, all state is copied (memory is copied physically, files and code
877is copied logically). Afterwards, it isolates all modifications. On UNIX,
878the same behaviour can be achieved by using operating system processes,
879except that UNIX typically uses hardware built into the system to do this
880efficiently, while the windows process emulation emulates this hardware in
881software (rather efficiently, but of course it is still much slower than
882dedicated hardware).
883
884As mentioned before, loading code, modifying code, modifying data
885structures and so on is only visible in the ithreads process doing the
886modification, not in other ithread processes within the same OS process.
887
888This is why "ithreads" do not implement threads for perl at all, only
889processes. What makes it so bad is that on non-windows platforms, you can
890actually take advantage of custom hardware for this purpose (as evidenced
891by the forks module, which gives you the (i-) threads API, just much
892faster).
893
894Sharing data is in the i-threads model is done by transfering data
895structures between threads using copying semantics, which is very slow -
896shared data simply does not exist. Benchmarks using i-threads which are
897communication-intensive show extremely bad behaviour with i-threads (in
898fact, so bad that Coro, which cannot take direct advantage of multiple
899CPUs, is often orders of magnitude faster because it shares data using
900real threads, refer to my talk for details).
901
902As summary, i-threads *use* threads to implement processes, while
903the compatible forks module *uses* processes to emulate, uhm,
904processes. I-threads slow down every perl program when enabled, and
905outside of windows, serve no (or little) practical purpose, but
906disadvantages every single-threaded Perl program.
907
908This is the reason that I try to avoid the name "ithreads", as it is
909misleading as it implies that it implements some kind of thread model for
910perl, and prefer the name "windows process emulation", which describes the
911actual use and behaviour of it much better.
569 912
570=head1 SEE ALSO 913=head1 SEE ALSO
571 914
915Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
916
917Debugging: L<Coro::Debug>.
918
572Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. 919Support/Utility: L<Coro::Specific>, L<Coro::Util>.
573 920
574Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. 921Locking and IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>,
922L<Coro::SemaphoreSet>, L<Coro::RWLock>.
575 923
576Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. 924I/O and Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
577 925
578Embedding: L<Coro:MakeMaker> 926Compatibility with other modules: L<Coro::LWP> (but see also L<AnyEvent::HTTP> for
927a better-working alternative), L<Coro::BDB>, L<Coro::Storable>,
928L<Coro::Select>.
929
930XS API: L<Coro::MakeMaker>.
931
932Low level Configuration, Thread Environment, Continuations: L<Coro::State>.
579 933
580=head1 AUTHOR 934=head1 AUTHOR
581 935
582 Marc Lehmann <schmorp@schmorp.de> 936 Marc Lehmann <schmorp@schmorp.de>
583 http://home.schmorp.de/ 937 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines