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

Comparing Coro/Coro.pm (file contents):
Revision 1.143 by root, Tue Oct 2 23:27:52 2007 UTC vs.
Revision 1.282 by root, Sun Dec 26 16:23:51 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 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.
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.8'; 86our $VERSION = 5.25;
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 essential 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$main->{desc} = "[main::]";
119
120# maybe some other module used Coro::Specific before...
121$main->{_specific} = $current->{_specific}
122 if $current;
123
124_set_current $main;
125
126sub current() { $current } 121sub current() { $current } # [DEPRECATED]
127 122
128=item $idle 123=item $Coro::idle
129 124
130A 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
131to run. The default implementation prints "FATAL: deadlock detected" and 132The default implementation dies with "FATAL: deadlock detected.", followed
132exits, because the program has no other way to continue. 133by a thread listing, because the program has no other way to continue.
133 134
134This hook is overwritten by modules such as C<Coro::Timer> and 135This hook is overwritten by modules such as C<Coro::EV> and
135C<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
136coroutine so the scheduler can run it. 137coro so the scheduler can run it.
137 138
138Please 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.
139handlers), then it must be prepared to be called recursively.
140 140
141=cut 141=cut
142 142
143$idle = sub { 143# ||= because other modules could have provided their own by now
144 require Carp; 144$idle ||= new Coro sub {
145 Carp::croak ("FATAL: deadlock detected"); 145 require Coro::Debug;
146 die "FATAL: deadlock detected.\n"
147 . Coro::Debug::ps_listing ();
146}; 148};
147 149
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}
159
160# this coroutine is necessary because a coroutine 150# this coro is necessary because a coro
161# cannot destroy itself. 151# cannot destroy itself.
162my @destroy; 152our @destroy;
163my $manager; 153our $manager;
164 154
165$manager = new Coro sub { 155$manager = new Coro sub {
166 while () { 156 while () {
167 (shift @destroy)->_cancel 157 Coro::State::cancel shift @destroy
168 while @destroy; 158 while @destroy;
169 159
170 &schedule; 160 &schedule;
171 } 161 }
172}; 162};
173$manager->desc ("[coro manager]"); 163$manager->{desc} = "[coro manager]";
174$manager->prio (PRIO_MAX); 164$manager->prio (PRIO_MAX);
175 165
176# static methods. not really.
177
178=back 166=back
179 167
180=head2 STATIC METHODS 168=head1 SIMPLE CORO CREATION
181
182Static methods are actually functions that operate on the current coroutine only.
183 169
184=over 4 170=over 4
185 171
186=item async { ... } [@args...] 172=item async { ... } [@args...]
187 173
188Create a new asynchronous coroutine and return it's coroutine object 174Create a new coro and return its Coro object (usually
189(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
190terminated. 180terminated.
191 181
182The remaining arguments are passed as arguments to the closure.
183
184See the C<Coro::State::new> constructor for info about the coro
185environment in which coro are executed.
186
192Calling C<exit> in a coroutine will do the same as calling exit outside 187Calling C<exit> in a coro will do the same as calling exit outside
193the coroutine. Likewise, when the coroutine dies, the program will exit, 188the coro. Likewise, when the coro dies, the program will exit,
194just as it would in the main program. 189just as it would in the main program.
195 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
196 # create a new coroutine that just prints its arguments 194Example: Create a new coro that just prints its arguments.
195
197 async { 196 async {
198 print "@_\n"; 197 print "@_\n";
199 } 1,2,3,4; 198 } 1,2,3,4;
200 199
201=cut
202
203sub async(&@) {
204 my $coro = new Coro @_;
205 $coro->ready;
206 $coro
207}
208
209=item async_pool { ... } [@args...] 200=item async_pool { ... } [@args...]
210 201
211Similar 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
212terminate 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
213that 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 :).
214 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
215Also, 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
216issued in case of an exception instead of terminating the program, as 212issued in case of an exception instead of terminating the program, as
217C<async> does. As the coroutine is being reused, stuff like C<on_destroy> 213C<async> does. As the coro is being reused, stuff like C<on_destroy>
218will 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,
219which somehow defeats the purpose of pooling. 215which somehow defeats the purpose of pooling (but is fine in the
216exceptional case).
220 217
221The 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
222will 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 $/ >>.
223 224
224The 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
225changing $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
226required. 227coros as required.
227 228
228If you are concerned about pooled coroutines growing a lot because a 229If you are concerned about pooled coros growing a lot because a
229single 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
230{ terminate }> once per second or so to slowly replenish the pool. In 231{ terminate }> once per second or so to slowly replenish the pool. In
231addition to that, when the stacks used by a handler grows larger than 16kb 232addition to that, when the stacks used by a handler grows larger than 32kb
232(adjustable with $Coro::POOL_RSS) it will also exit. 233(adjustable via $Coro::POOL_RSS) it will also be destroyed.
233 234
234=cut 235=cut
235 236
236our $POOL_SIZE = 8; 237our $POOL_SIZE = 8;
237our $POOL_RSS = 16 * 1024; 238our $POOL_RSS = 32 * 1024;
238our @async_pool; 239our @async_pool;
239 240
240sub pool_handler { 241sub pool_handler {
241 my $cb;
242
243 while () { 242 while () {
244 eval { 243 eval {
245 while () { 244 &{&_pool_handler} while 1;
246 _pool_1 $cb;
247 &$cb;
248 _pool_2 $cb;
249 &schedule;
250 }
251 }; 245 };
252 246
253 last if $@ eq "\3terminate\2\n";
254 warn $@ if $@; 247 warn $@ if $@;
255 } 248 }
256} 249}
257 250
258sub async_pool(&@) { 251=back
259 # this is also inlined into the unlock_scheduler
260 my $coro = (pop @async_pool) || new Coro \&pool_handler;
261 252
262 $coro->{_invoke} = [@_]; 253=head1 STATIC METHODS
263 $coro->ready;
264 254
265 $coro 255Static methods are actually functions that implicitly operate on the
266} 256current coro.
257
258=over 4
267 259
268=item schedule 260=item schedule
269 261
270Calls the scheduler. Please note that the current coroutine will not be put 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
271into the ready queue, so calling this function usually means you will 269queue, so calling this function usually means you will never be called
272never be called again unless something else (e.g. an event handler) calls 270again unless something else (e.g. an event handler) calls C<< ->ready >>,
273ready. 271thus waking you up.
274 272
275The canonical way to wait on external events is this: 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.
276 280
277 { 281See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks.
278 # remember current coroutine
279 my $current = $Coro::current;
280 282
281 # register a hypothetical event handler 283=item cede
282 on_event_invoke sub { 284
283 # wake up sleeping coroutine 285"Cede" to other coros. This function puts the current coro into
284 $current->ready; 286the ready queue and calls C<schedule>, which has the effect of giving
285 undef $current; 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
286 }; 344 };
287 345
288 # call schedule until event occurred. 346 Coro::on_leave {
289 # in case we are woken up for other reasons 347 $ENV{TZ} = $old_tz;
290 # (current still defined), loop. 348 tzset; # restore old value
291 Coro::schedule while $current; 349 };
350
351 # at this place, the timezone is Antarctica/South_Pole,
352 # without disturbing the TZ of any other coro.
292 } 353 };
293 354
294=item cede 355This can be used to localise about any resource (locale, uid, current
356working directory etc.) to a block, despite the existance of other
357coros.
295 358
296"Cede" to other coroutines. This function puts the current coroutine into the 359Another interesting example implements time-sliced multitasking using
297ready queue and calls C<schedule>, which has the effect of giving up the 360interval timers (this could obviously be optimised, but does the job):
298current "timeslice" to other coroutines of the same or higher priority.
299 361
300Returns true if at least one coroutine switch has happened. 362 # "timeslice" the given block
363 sub timeslice(&) {
364 use Time::HiRes ();
301 365
302=item Coro::cede_notself 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 };
303 376
304Works like cede, but is not exported by default and will cede to any 377 &{+shift};
305coroutine, regardless of priority, once. 378 }
306 379
307Returns true if at least one coroutine switch has happened. 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 };
308 387
309=item terminate [arg...]
310
311Terminates the current coroutine with the given status values (see L<cancel>).
312 388
313=item killall 389=item killall
314 390
315Kills/terminates/cancels all coroutines except the currently running 391Kills/terminates/cancels all coros except the currently running one.
316one. This is useful after a fork, either in the child or the parent, as
317usually only one of them should inherit the running coroutines.
318 392
319=cut 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.
320 397
321sub terminate { 398=cut
322 $current->cancel (@_);
323}
324 399
325sub killall { 400sub killall {
326 for (Coro::State::list) { 401 for (Coro::State::list) {
327 $_->cancel 402 $_->cancel
328 if $_ != $current && UNIVERSAL::isa $_, "Coro"; 403 if $_ != $current && UNIVERSAL::isa $_, "Coro";
329 } 404 }
330} 405}
331 406
332=back 407=back
333 408
334# dynamic methods
335
336=head2 COROUTINE METHODS 409=head1 CORO OBJECT METHODS
337 410
338These are the methods you can call on coroutine objects. 411These are the methods you can call on coro objects (or to create
412them).
339 413
340=over 4 414=over 4
341 415
342=item new Coro \&sub [, @args...] 416=item new Coro \&sub [, @args...]
343 417
344Create a new coroutine and return it. When the sub returns the coroutine 418Create a new coro and return it. When the sub returns, the coro
345automatically terminates as if C<terminate> with the returned values were 419automatically terminates as if C<terminate> with the returned values were
346called. To make the coroutine run you must first put it into the ready queue 420called. To make the coro run you must first put it into the ready
347by calling the ready method. 421queue by calling the ready method.
348 422
349See C<async> for additional discussion. 423See C<async> and C<Coro::State::new> for additional info about the
424coro environment.
350 425
351=cut 426=cut
352 427
353sub _run_coro { 428sub _coro_run {
354 terminate &{+shift}; 429 terminate &{+shift};
355} 430}
356 431
357sub new {
358 my $class = shift;
359
360 $class->SUPER::new (\&_run_coro, @_)
361}
362
363=item $success = $coroutine->ready 432=item $success = $coro->ready
364 433
365Put the given coroutine into the ready queue (according to it's priority) 434Put the given coro into the end of its ready queue (there is one
366and return true. If the coroutine is already in the ready queue, do nothing 435queue for each priority) and return true. If the coro is already in
367and return false. 436the ready queue, do nothing and return false.
368 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
369=item $is_ready = $coroutine->is_ready 467=item $is_ready = $coro->is_ready
370 468
371Return wether the coroutine is currently the ready queue or not, 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.
372 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
373=item $coroutine->cancel (arg...) 483=item $coro->cancel (arg...)
374 484
375Terminates the given coroutine and makes it return the given arguments as 485Terminates the given Coro and makes it return the given arguments as
376status (default: the empty list). Never returns if the coroutine is the 486status (default: the empty list). Never returns if the Coro is the
377current coroutine. 487current Coro.
378 488
379=cut 489=cut
380 490
381sub cancel { 491sub cancel {
382 my $self = shift; 492 my $self = shift;
383 $self->{_status} = [@_];
384 493
385 if ($current == $self) { 494 if ($current == $self) {
386 push @destroy, $self; 495 terminate @_;
387 $manager->ready;
388 &schedule while 1;
389 } else { 496 } else {
390 $self->_cancel; 497 $self->{_status} = [@_];
498 Coro::State::cancel $self;
391 } 499 }
392} 500}
393 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
394=item $coroutine->join 544=item $coro->join
395 545
396Wait until the coroutine terminates and return any values given to the 546Wait until the coro terminates and return any values given to the
397C<terminate> or C<cancel> functions. C<join> can be called concurrently 547C<terminate> or C<cancel> functions. C<join> can be called concurrently
398from multiple coroutines. 548from multiple coro, and all will be resumed and given the status
549return once the C<$coro> terminates.
399 550
400=cut 551=cut
401 552
402sub join { 553sub join {
403 my $self = shift; 554 my $self = shift;
414 } 565 }
415 566
416 wantarray ? @{$self->{_status}} : $self->{_status}[0]; 567 wantarray ? @{$self->{_status}} : $self->{_status}[0];
417} 568}
418 569
419=item $coroutine->on_destroy (\&cb) 570=item $coro->on_destroy (\&cb)
420 571
421Registers a callback that is called when this coroutine gets destroyed, 572Registers a callback that is called when this coro gets destroyed,
422but before it is joined. The callback gets passed the terminate arguments, 573but before it is joined. The callback gets passed the terminate arguments,
423if any. 574if any, and I<must not> die, under any circumstances.
424 575
425=cut 576=cut
426 577
427sub on_destroy { 578sub on_destroy {
428 my ($self, $cb) = @_; 579 my ($self, $cb) = @_;
429 580
430 push @{ $self->{_on_destroy} }, $cb; 581 push @{ $self->{_on_destroy} }, $cb;
431} 582}
432 583
433=item $oldprio = $coroutine->prio ($newprio) 584=item $oldprio = $coro->prio ($newprio)
434 585
435Sets (or gets, if the argument is missing) the priority of the 586Sets (or gets, if the argument is missing) the priority of the
436coroutine. Higher priority coroutines get run before lower priority 587coro. Higher priority coro get run before lower priority
437coroutines. Priorities are small signed integers (currently -4 .. +3), 588coro. Priorities are small signed integers (currently -4 .. +3),
438that 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
439to get then): 590to get then):
440 591
441 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
442 3 > 1 > 0 > -1 > -3 > -4 593 3 > 1 > 0 > -1 > -3 > -4
443 594
444 # set priority to HIGH 595 # set priority to HIGH
445 current->prio(PRIO_HIGH); 596 current->prio (PRIO_HIGH);
446 597
447The idle coroutine ($Coro::idle) always has a lower priority than any 598The idle coro ($Coro::idle) always has a lower priority than any
448existing coroutine. 599existing coro.
449 600
450Changing the priority of the current coroutine will take effect immediately, 601Changing the priority of the current coro will take effect immediately,
451but changing the priority of coroutines in the ready queue (but not 602but changing the priority of coro in the ready queue (but not
452running) will only take effect after the next schedule (of that 603running) will only take effect after the next schedule (of that
453coroutine). 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.
454 605
455=item $newprio = $coroutine->nice ($change) 606=item $newprio = $coro->nice ($change)
456 607
457Similar 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.
458higher values mean lower priority, just as in unix). 609higher values mean lower priority, just as in unix).
459 610
460=item $olddesc = $coroutine->desc ($newdesc) 611=item $olddesc = $coro->desc ($newdesc)
461 612
462Sets (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
463coroutine. 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.
464 616
465This method simply sets the C<< $coroutine->{desc} >> member to the given string. You 617This method simply sets the C<< $coro->{desc} >> member to the given
466can modify this member directly if you wish. 618string. You can modify this member directly if you wish, and in fact, this
619is often preferred to indicate major processing states that cna then be
620seen for example in a L<Coro::Debug> session:
621
622 sub my_long_function {
623 local $Coro::current->{desc} = "now in my_long_function";
624 ...
625 $Coro::current->{desc} = "my_long_function: phase 1";
626 ...
627 $Coro::current->{desc} = "my_long_function: phase 2";
628 ...
629 }
467 630
468=cut 631=cut
469 632
470sub desc { 633sub desc {
471 my $old = $_[0]{desc}; 634 my $old = $_[0]{desc};
472 $_[0]{desc} = $_[1] if @_ > 1; 635 $_[0]{desc} = $_[1] if @_ > 1;
473 $old; 636 $old;
474} 637}
475 638
639sub transfer {
640 require Carp;
641 Carp::croak ("You must not call ->transfer on Coro objects. Use Coro::State objects or the ->schedule_to method. Caught");
642}
643
476=back 644=back
477 645
478=head2 GLOBAL FUNCTIONS 646=head1 GLOBAL FUNCTIONS
479 647
480=over 4 648=over 4
481 649
482=item Coro::nready 650=item Coro::nready
483 651
484Returns the number of coroutines that are currently in the ready state, 652Returns the number of coro that are currently in the ready state,
485i.e. that can be switched to. The value C<0> means that the only runnable 653i.e. that can be switched to by calling C<schedule> directory or
654indirectly. The value C<0> means that the only runnable coro is the
486coroutine is the currently running one, so C<cede> would have no effect, 655currently running one, so C<cede> would have no effect, and C<schedule>
487and C<schedule> would cause a deadlock unless there is an idle handler 656would cause a deadlock unless there is an idle handler that wakes up some
488that wakes up some coroutines. 657coro.
489 658
490=item my $guard = Coro::guard { ... } 659=item my $guard = Coro::guard { ... }
491 660
492This creates and returns a guard object. Nothing happens until the object 661This function still exists, but is deprecated. Please use the
493gets destroyed, in which case the codeblock given as argument will be 662C<Guard::guard> function instead.
494executed. This is useful to free locks or other resources in case of a
495runtime error or when the coroutine gets canceled, as in both cases the
496guard block will be executed. The guard object supports only one method,
497C<< ->cancel >>, which will keep the codeblock from being executed.
498 663
499Example: set some flag and clear it again when the coroutine gets canceled
500or the function returns:
501
502 sub do_something {
503 my $guard = Coro::guard { $busy = 0 };
504 $busy = 1;
505
506 # do something that requires $busy to be true
507 }
508
509=cut 664=cut
510 665
511sub guard(&) { 666BEGIN { *guard = \&Guard::guard }
512 bless \(my $cb = $_[0]), "Coro::guard"
513}
514
515sub Coro::guard::cancel {
516 ${$_[0]} = sub { };
517}
518
519sub Coro::guard::DESTROY {
520 ${$_[0]}->();
521}
522
523 667
524=item unblock_sub { ... } 668=item unblock_sub { ... }
525 669
526This utility function takes a BLOCK or code reference and "unblocks" it, 670This utility function takes a BLOCK or code reference and "unblocks" it,
527returning the new coderef. This means that the new coderef will return 671returning a new coderef. Unblocking means that calling the new coderef
528immediately without blocking, returning nothing, while the original code 672will return immediately without blocking, returning nothing, while the
529ref will be called (with parameters) from within its own coroutine. 673original code ref will be called (with parameters) from within another
674coro.
530 675
531The reason this function exists is that many event libraries (such as the 676The reason this function exists is that many event libraries (such as
532venerable L<Event|Event> module) are not coroutine-safe (a weaker form 677the venerable L<Event|Event> module) are not thread-safe (a weaker form
533of thread-safety). This means you must not block within event callbacks, 678of reentrancy). This means you must not block within event callbacks,
534otherwise you might suffer from crashes or worse. 679otherwise you might suffer from crashes or worse. The only event library
680currently known that is safe to use without C<unblock_sub> is L<EV> (but
681you might still run into deadlocks if all event loops are blocked).
682
683Coro will try to catch you when you block in the event loop
684("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and
685only works when you do not run your own event loop.
535 686
536This function allows your callbacks to block by executing them in another 687This function allows your callbacks to block by executing them in another
537coroutine where it is safe to block. One example where blocking is handy 688coro where it is safe to block. One example where blocking is handy
538is when you use the L<Coro::AIO|Coro::AIO> functions to save results to 689is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
539disk. 690disk, for example.
540 691
541In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when 692In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
542creating event callbacks that want to block. 693creating event callbacks that want to block.
694
695If your handler does not plan to block (e.g. simply sends a message to
696another coro, or puts some other coro into the ready queue), there is
697no reason to use C<unblock_sub>.
698
699Note that you also need to use C<unblock_sub> for any other callbacks that
700are indirectly executed by any C-based event loop. For example, when you
701use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
702provides callbacks that are the result of some event callback, then you
703must not block either, or use C<unblock_sub>.
543 704
544=cut 705=cut
545 706
546our @unblock_queue; 707our @unblock_queue;
547 708
550# return immediately and can be reused) and because we cannot cede 711# return immediately and can be reused) and because we cannot cede
551# inside an event callback. 712# inside an event callback.
552our $unblock_scheduler = new Coro sub { 713our $unblock_scheduler = new Coro sub {
553 while () { 714 while () {
554 while (my $cb = pop @unblock_queue) { 715 while (my $cb = pop @unblock_queue) {
555 # this is an inlined copy of async_pool 716 &async_pool (@$cb);
556 my $coro = (pop @async_pool) || new Coro \&pool_handler;
557 717
558 $coro->{_invoke} = $cb;
559 $coro->ready;
560 cede; # for short-lived callbacks, this reduces pressure on the coro pool 718 # for short-lived callbacks, this reduces pressure on the coro pool
719 # as the chance is very high that the async_poll coro will be back
720 # in the idle state when cede returns
721 cede;
561 } 722 }
562 schedule; # sleep well 723 schedule; # sleep well
563 } 724 }
564}; 725};
565$unblock_scheduler->desc ("[unblock_sub scheduler]"); 726$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
566 727
567sub unblock_sub(&) { 728sub unblock_sub(&) {
568 my $cb = shift; 729 my $cb = shift;
569 730
570 sub { 731 sub {
571 unshift @unblock_queue, [$cb, @_]; 732 unshift @unblock_queue, [$cb, @_];
572 $unblock_scheduler->ready; 733 $unblock_scheduler->ready;
573 } 734 }
574} 735}
575 736
737=item $cb = rouse_cb
738
739Create and return a "rouse callback". That's a code reference that,
740when called, will remember a copy of its arguments and notify the owner
741coro of the callback.
742
743See the next function.
744
745=item @args = rouse_wait [$cb]
746
747Wait for the specified rouse callback (or the last one that was created in
748this coro).
749
750As soon as the callback is invoked (or when the callback was invoked
751before C<rouse_wait>), it will return the arguments originally passed to
752the rouse callback. In scalar context, that means you get the I<last>
753argument, just as if C<rouse_wait> had a C<return ($a1, $a2, $a3...)>
754statement at the end.
755
756See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.
757
576=back 758=back
577 759
578=cut 760=cut
579 761
5801; 7621;
581 763
764=head1 HOW TO WAIT FOR A CALLBACK
765
766It is very common for a coro to wait for some callback to be
767called. This occurs naturally when you use coro in an otherwise
768event-based program, or when you use event-based libraries.
769
770These typically register a callback for some event, and call that callback
771when the event occured. In a coro, however, you typically want to
772just wait for the event, simplyifying things.
773
774For example C<< AnyEvent->child >> registers a callback to be called when
775a specific child has exited:
776
777 my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });
778
779But from within a coro, you often just want to write this:
780
781 my $status = wait_for_child $pid;
782
783Coro offers two functions specifically designed to make this easy,
784C<Coro::rouse_cb> and C<Coro::rouse_wait>.
785
786The first function, C<rouse_cb>, generates and returns a callback that,
787when invoked, will save its arguments and notify the coro that
788created the callback.
789
790The second function, C<rouse_wait>, waits for the callback to be called
791(by calling C<schedule> to go to sleep) and returns the arguments
792originally passed to the callback.
793
794Using these functions, it becomes easy to write the C<wait_for_child>
795function mentioned above:
796
797 sub wait_for_child($) {
798 my ($pid) = @_;
799
800 my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb);
801
802 my ($rpid, $rstatus) = Coro::rouse_wait;
803 $rstatus
804 }
805
806In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough,
807you can roll your own, using C<schedule>:
808
809 sub wait_for_child($) {
810 my ($pid) = @_;
811
812 # store the current coro in $current,
813 # and provide result variables for the closure passed to ->child
814 my $current = $Coro::current;
815 my ($done, $rstatus);
816
817 # pass a closure to ->child
818 my $watcher = AnyEvent->child (pid => $pid, cb => sub {
819 $rstatus = $_[1]; # remember rstatus
820 $done = 1; # mark $rstatus as valud
821 });
822
823 # wait until the closure has been called
824 schedule while !$done;
825
826 $rstatus
827 }
828
829
582=head1 BUGS/LIMITATIONS 830=head1 BUGS/LIMITATIONS
583 831
584 - you must make very sure that no coro is still active on global 832=over 4
585 destruction. very bad things might happen otherwise (usually segfaults).
586 833
834=item fork with pthread backend
835
836When Coro is compiled using the pthread backend (which isn't recommended
837but required on many BSDs as their libcs are completely broken), then
838coro will not survive a fork. There is no known workaround except to
839fix your libc and use a saner backend.
840
841=item perl process emulation ("threads")
842
587 - this module is not thread-safe. You should only ever use this module 843This module is not perl-pseudo-thread-safe. You should only ever use this
588 from the same thread (this requirement might be loosened in the future 844module from the first thread (this requirement might be removed in the
589 to allow per-thread schedulers, but Coro::State does not yet allow 845future to allow per-thread schedulers, but Coro::State does not yet allow
590 this). 846this). I recommend disabling thread support and using processes, as having
847the windows process emulation enabled under unix roughly halves perl
848performance, even when not used.
849
850=item coro switching is not signal safe
851
852You must not switch to another coro from within a signal handler (only
853relevant with %SIG - most event libraries provide safe signals), I<unless>
854you are sure you are not interrupting a Coro function.
855
856That means you I<MUST NOT> call any function that might "block" the
857current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
858anything that calls those. Everything else, including calling C<ready>,
859works.
860
861=back
862
863
864=head1 WINDOWS PROCESS EMULATION
865
866A great many people seem to be confused about ithreads (for example, Chip
867Salzenberg called me unintelligent, incapable, stupid and gullible,
868while in the same mail making rather confused statements about perl
869ithreads (for example, that memory or files would be shared), showing his
870lack of understanding of this area - if it is hard to understand for Chip,
871it is probably not obvious to everybody).
872
873What follows is an ultra-condensed version of my talk about threads in
874scripting languages given on the perl workshop 2009:
875
876The so-called "ithreads" were originally implemented for two reasons:
877first, to (badly) emulate unix processes on native win32 perls, and
878secondly, to replace the older, real thread model ("5.005-threads").
879
880It does that by using threads instead of OS processes. The difference
881between processes and threads is that threads share memory (and other
882state, such as files) between threads within a single process, while
883processes do not share anything (at least not semantically). That
884means that modifications done by one thread are seen by others, while
885modifications by one process are not seen by other processes.
886
887The "ithreads" work exactly like that: when creating a new ithreads
888process, all state is copied (memory is copied physically, files and code
889is copied logically). Afterwards, it isolates all modifications. On UNIX,
890the same behaviour can be achieved by using operating system processes,
891except that UNIX typically uses hardware built into the system to do this
892efficiently, while the windows process emulation emulates this hardware in
893software (rather efficiently, but of course it is still much slower than
894dedicated hardware).
895
896As mentioned before, loading code, modifying code, modifying data
897structures and so on is only visible in the ithreads process doing the
898modification, not in other ithread processes within the same OS process.
899
900This is why "ithreads" do not implement threads for perl at all, only
901processes. What makes it so bad is that on non-windows platforms, you can
902actually take advantage of custom hardware for this purpose (as evidenced
903by the forks module, which gives you the (i-) threads API, just much
904faster).
905
906Sharing data is in the i-threads model is done by transfering data
907structures between threads using copying semantics, which is very slow -
908shared data simply does not exist. Benchmarks using i-threads which are
909communication-intensive show extremely bad behaviour with i-threads (in
910fact, so bad that Coro, which cannot take direct advantage of multiple
911CPUs, is often orders of magnitude faster because it shares data using
912real threads, refer to my talk for details).
913
914As summary, i-threads *use* threads to implement processes, while
915the compatible forks module *uses* processes to emulate, uhm,
916processes. I-threads slow down every perl program when enabled, and
917outside of windows, serve no (or little) practical purpose, but
918disadvantages every single-threaded Perl program.
919
920This is the reason that I try to avoid the name "ithreads", as it is
921misleading as it implies that it implements some kind of thread model for
922perl, and prefer the name "windows process emulation", which describes the
923actual use and behaviour of it much better.
591 924
592=head1 SEE ALSO 925=head1 SEE ALSO
593 926
927Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
928
929Debugging: L<Coro::Debug>.
930
594Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. 931Support/Utility: L<Coro::Specific>, L<Coro::Util>.
595 932
596Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. 933Locking and IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>,
934L<Coro::SemaphoreSet>, L<Coro::RWLock>.
597 935
598Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. 936I/O and Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
599 937
600Embedding: L<Coro:MakeMaker> 938Compatibility with other modules: L<Coro::LWP> (but see also L<AnyEvent::HTTP> for
939a better-working alternative), L<Coro::BDB>, L<Coro::Storable>,
940L<Coro::Select>.
941
942XS API: L<Coro::MakeMaker>.
943
944Low level Configuration, Thread Environment, Continuations: L<Coro::State>.
601 945
602=head1 AUTHOR 946=head1 AUTHOR
603 947
604 Marc Lehmann <schmorp@schmorp.de> 948 Marc Lehmann <schmorp@schmorp.de>
605 http://home.schmorp.de/ 949 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines