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

Comparing Coro/Coro.pm (file contents):
Revision 1.245 by root, Sun Dec 14 19:52:58 2008 UTC vs.
Revision 1.282 by root, Sun Dec 26 16:23:51 2010 UTC

11 print "2\n"; 11 print "2\n";
12 cede; # yield back to main 12 cede; # yield back to main
13 print "4\n"; 13 print "4\n";
14 }; 14 };
15 print "1\n"; 15 print "1\n";
16 cede; # yield to coroutine 16 cede; # yield to coro
17 print "3\n"; 17 print "3\n";
18 cede; # and again 18 cede; # and again
19 19
20 # use locking 20 # use locking
21 use Coro::Semaphore; 21 use Coro::Semaphore;
29=head1 DESCRIPTION 29=head1 DESCRIPTION
30 30
31For a tutorial-style introduction, please read the L<Coro::Intro> 31For a tutorial-style introduction, please read the L<Coro::Intro>
32manpage. This manpage mainly contains reference information. 32manpage. This manpage mainly contains reference information.
33 33
34This module collection manages continuations in general, most often 34This module collection manages continuations in general, most often in
35in the form of cooperative threads (also called coroutines in the 35the form of cooperative threads (also called coros, or simply "coro"
36documentation). They are similar to kernel threads but don't (in general) 36in the documentation). They are similar to kernel threads but don't (in
37run in parallel at the same time even on SMP machines. The specific flavor 37general) run in parallel at the same time even on SMP machines. The
38of thread offered by this module also guarantees you that it will not 38specific flavor of thread offered by this module also guarantees you that
39switch between threads unless necessary, at easily-identified points in 39it will not switch between threads unless necessary, at easily-identified
40your program, so locking and parallel access are rarely an issue, making 40points in your program, so locking and parallel access are rarely an
41thread programming much safer and easier than using other thread models. 41issue, making thread programming much safer and easier than using other
42thread models.
42 43
43Unlike the so-called "Perl threads" (which are not actually real threads 44Unlike the so-called "Perl threads" (which are not actually real threads
44but only the windows process emulation ported to unix), Coro provides a 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
45full shared address space, which makes communication between threads 47a full shared address space, which makes communication between threads
46very easy. And threads are fast, too: disabling the Windows process 48very easy. And Coro's threads are fast, too: disabling the Windows
47emulation code in your perl and using Coro can easily result in a two to 49process emulation code in your perl and using Coro can easily result in
48four times speed increase for your programs. 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.
49 53
50Coro achieves that by supporting multiple running interpreters that share 54Coro achieves that by supporting multiple running interpreters that share
51data, which is especially useful to code pseudo-parallel processes and 55data, which is especially useful to code pseudo-parallel processes and
52for event-based programming, such as multiple HTTP-GET requests running 56for event-based programming, such as multiple HTTP-GET requests running
53concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro 57concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro
54into an event-based environment. 58into an event-based environment.
55 59
56In this module, a thread is defined as "callchain + lexical variables + 60In this module, a thread is defined as "callchain + lexical variables +
57@_ + $_ + $@ + $/ + C stack), that is, a thread has its own callchain, 61some package variables + C stack), that is, a thread has its own callchain,
58its 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
59variables (see L<Coro::State> for more configuration and background info). 63variables (see L<Coro::State> for more configuration and background info).
60 64
61See also the C<SEE ALSO> section at the end of this document - the Coro 65See also the C<SEE ALSO> section at the end of this document - the Coro
62module family is quite large. 66module family is quite large.
63 67
64=cut 68=cut
65 69
66package Coro; 70package Coro;
67 71
68use strict qw(vars subs); 72use common::sense;
69no warnings "uninitialized"; 73
74use Carp ();
75
76use Guard ();
70 77
71use Coro::State; 78use Coro::State;
72 79
73use base qw(Coro::State Exporter); 80use base qw(Coro::State Exporter);
74 81
75our $idle; # idle handler 82our $idle; # idle handler
76our $main; # main coroutine 83our $main; # main coro
77our $current; # current coroutine 84our $current; # current coro
78 85
79our $VERSION = 5.13; 86our $VERSION = 5.25;
80 87
81our @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);
82our %EXPORT_TAGS = ( 89our %EXPORT_TAGS = (
83 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)],
84); 91);
85our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); 92our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
86 93
88 95
89=over 4 96=over 4
90 97
91=item $Coro::main 98=item $Coro::main
92 99
93This variable stores the coroutine object that represents the main 100This variable stores the Coro object that represents the main
94program. While you cna C<ready> it and do most other things you can do to 101program. While you cna C<ready> it and do most other things you can do to
95coroutines, it is mainly useful to compare again C<$Coro::current>, to see 102coro, it is mainly useful to compare again C<$Coro::current>, to see
96whether you are running in the main program or not. 103whether you are running in the main program or not.
97 104
98=cut 105=cut
99 106
100# $main is now being initialised by Coro::State 107# $main is now being initialised by Coro::State
101 108
102=item $Coro::current 109=item $Coro::current
103 110
104The coroutine object representing the current coroutine (the last 111The Coro object representing the current coro (the last
105coroutine that the Coro scheduler switched to). The initial value is 112coro that the Coro scheduler switched to). The initial value is
106C<$Coro::main> (of course). 113C<$Coro::main> (of course).
107 114
108This variable is B<strictly> I<read-only>. You can take copies of the 115This variable is B<strictly> I<read-only>. You can take copies of the
109value stored in it and use it as any other coroutine object, but you must 116value stored in it and use it as any other Coro object, but you must
110not otherwise modify the variable itself. 117not otherwise modify the variable itself.
111 118
112=cut 119=cut
113 120
114sub current() { $current } # [DEPRECATED] 121sub current() { $current } # [DEPRECATED]
117 124
118This variable is mainly useful to integrate Coro into event loops. It is 125This variable is mainly useful to integrate Coro into event loops. It is
119usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is 126usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is
120pretty low-level functionality. 127pretty low-level functionality.
121 128
122This variable stores either a coroutine or a callback. 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).
123 131
124If it is a callback, the it is called whenever the scheduler finds no 132The default implementation dies with "FATAL: deadlock detected.", followed
125ready coroutines to run. The default implementation prints "FATAL: 133by a thread listing, because the program has no other way to continue.
126deadlock detected" and exits, because the program has no other way to
127continue.
128
129If it is a coroutine object, then this object will be readied (without
130invoking any ready hooks, however) when the scheduler finds no other ready
131coroutines to run.
132 134
133This hook is overwritten by modules such as C<Coro::EV> and 135This hook is overwritten by modules such as C<Coro::EV> and
134C<Coro::AnyEvent> 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
135coroutine so the scheduler can run it. 137coro so the scheduler can run it.
136 138
137Note that the callback I<must not>, under any circumstances, block
138the current coroutine. Normally, this is achieved by having an "idle
139coroutine" that calls the event loop and then blocks again, and then
140readying that coroutine in the idle handler, or by simply placing the idle
141coroutine in this variable.
142
143See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this 139See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique.
144technique.
145 140
146Please note that if your callback recursively invokes perl (e.g. for event
147handlers), then it must be prepared to be called recursively itself.
148
149=cut 141=cut
150 142
151$idle = sub { 143# ||= because other modules could have provided their own by now
152 require Carp; 144$idle ||= new Coro sub {
153 Carp::croak ("FATAL: deadlock detected"); 145 require Coro::Debug;
146 die "FATAL: deadlock detected.\n"
147 . Coro::Debug::ps_listing ();
154}; 148};
155 149
156# this coroutine is necessary because a coroutine 150# this coro is necessary because a coro
157# cannot destroy itself. 151# cannot destroy itself.
158our @destroy; 152our @destroy;
159our $manager; 153our $manager;
160 154
161$manager = new Coro sub { 155$manager = new Coro sub {
162 while () { 156 while () {
163 Coro::_cancel shift @destroy 157 Coro::State::cancel shift @destroy
164 while @destroy; 158 while @destroy;
165 159
166 &schedule; 160 &schedule;
167 } 161 }
168}; 162};
169$manager->{desc} = "[coro manager]"; 163$manager->{desc} = "[coro manager]";
170$manager->prio (PRIO_MAX); 164$manager->prio (PRIO_MAX);
171 165
172=back 166=back
173 167
174=head1 SIMPLE COROUTINE CREATION 168=head1 SIMPLE CORO CREATION
175 169
176=over 4 170=over 4
177 171
178=item async { ... } [@args...] 172=item async { ... } [@args...]
179 173
180Create a new coroutine and return its coroutine object (usually 174Create a new coro and return its Coro object (usually
181unused). The coroutine will be put into the ready queue, so 175unused). The coro will be put into the ready queue, so
182it will start running automatically on the next scheduler run. 176it will start running automatically on the next scheduler run.
183 177
184The first argument is a codeblock/closure that should be executed in the 178The first argument is a codeblock/closure that should be executed in the
185coroutine. When it returns argument returns the coroutine is automatically 179coro. When it returns argument returns the coro is automatically
186terminated. 180terminated.
187 181
188The remaining arguments are passed as arguments to the closure. 182The remaining arguments are passed as arguments to the closure.
189 183
190See the C<Coro::State::new> constructor for info about the coroutine 184See the C<Coro::State::new> constructor for info about the coro
191environment in which coroutines are executed. 185environment in which coro are executed.
192 186
193Calling 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
194the coroutine. Likewise, when the coroutine dies, the program will exit, 188the coro. Likewise, when the coro dies, the program will exit,
195just as it would in the main program. 189just as it would in the main program.
196 190
197If you do not want that, you can provide a default C<die> handler, or 191If you do not want that, you can provide a default C<die> handler, or
198simply avoid dieing (by use of C<eval>). 192simply avoid dieing (by use of C<eval>).
199 193
200Example: Create a new coroutine that just prints its arguments. 194Example: Create a new coro that just prints its arguments.
201 195
202 async { 196 async {
203 print "@_\n"; 197 print "@_\n";
204 } 1,2,3,4; 198 } 1,2,3,4;
205 199
206=cut
207
208sub async(&@) {
209 my $coro = new Coro @_;
210 $coro->ready;
211 $coro
212}
213
214=item async_pool { ... } [@args...] 200=item async_pool { ... } [@args...]
215 201
216Similar 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
217terminate or join on it (although you are allowed to), and you get a 203terminate or join on it (although you are allowed to), and you get a
218coroutine that might have executed other code already (which can be good 204coro that might have executed other code already (which can be good
219or bad :). 205or bad :).
220 206
221On the plus side, this function is about twice as fast as creating (and 207On the plus side, this function is about twice as fast as creating (and
222destroying) a completely new coroutine, so if you need a lot of generic 208destroying) a completely new coro, so if you need a lot of generic
223coroutines in quick successsion, use C<async_pool>, not C<async>. 209coros in quick successsion, use C<async_pool>, not C<async>.
224 210
225The code 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
226issued in case of an exception instead of terminating the program, as 212issued in case of an exception instead of terminating the program, as
227C<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>
228will 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,
229which somehow defeats the purpose of pooling (but is fine in the 215which somehow defeats the purpose of pooling (but is fine in the
230exceptional case). 216exceptional case).
231 217
232The priority will be reset to C<0> after each run, tracing will be 218The priority will be reset to C<0> after each run, tracing will be
233disabled, the description will be reset and the default output filehandle 219disabled, the description will be reset and the default output filehandle
234gets restored, so you can change all these. Otherwise the coroutine will 220gets restored, so you can change all these. Otherwise the coro will
235be re-used "as-is": most notably if you change other per-coroutine global 221be re-used "as-is": most notably if you change other per-coro global
236stuff such as C<$/> you I<must needs> revert that change, which is most 222stuff such as C<$/> you I<must needs> revert that change, which is most
237simply done by using local as in: C<< local $/ >>. 223simply done by using local as in: C<< local $/ >>.
238 224
239The idle pool size is limited to C<8> idle coroutines (this can be 225The idle pool size is limited to C<8> idle coros (this can be
240adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle 226adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
241coros as required. 227coros as required.
242 228
243If you are concerned about pooled coroutines growing a lot because a 229If you are concerned about pooled coros growing a lot because a
244single 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
245{ 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
246addition to that, when the stacks used by a handler grows larger than 32kb 232addition to that, when the stacks used by a handler grows larger than 32kb
247(adjustable via $Coro::POOL_RSS) it will also be destroyed. 233(adjustable via $Coro::POOL_RSS) it will also be destroyed.
248 234
265=back 251=back
266 252
267=head1 STATIC METHODS 253=head1 STATIC METHODS
268 254
269Static methods are actually functions that implicitly operate on the 255Static methods are actually functions that implicitly operate on the
270current coroutine. 256current coro.
271 257
272=over 4 258=over 4
273 259
274=item schedule 260=item schedule
275 261
276Calls the scheduler. The scheduler will find the next coroutine that is 262Calls the scheduler. The scheduler will find the next coro that is
277to be run from the ready queue and switches to it. The next coroutine 263to be run from the ready queue and switches to it. The next coro
278to be run is simply the one with the highest priority that is longest 264to be run is simply the one with the highest priority that is longest
279in its ready queue. If there is no coroutine ready, it will clal the 265in its ready queue. If there is no coro ready, it will call the
280C<$Coro::idle> hook. 266C<$Coro::idle> hook.
281 267
282Please note that the current coroutine will I<not> be put into the ready 268Please note that the current coro will I<not> be put into the ready
283queue, so calling this function usually means you will never be called 269queue, so calling this function usually means you will never be called
284again unless something else (e.g. an event handler) calls C<< ->ready >>, 270again unless something else (e.g. an event handler) calls C<< ->ready >>,
285thus waking you up. 271thus waking you up.
286 272
287This makes C<schedule> I<the> generic method to use to block the current 273This makes C<schedule> I<the> generic method to use to block the current
288coroutine and wait for events: first you remember the current coroutine in 274coro and wait for events: first you remember the current coro in
289a variable, then arrange for some callback of yours to call C<< ->ready 275a variable, then arrange for some callback of yours to call C<< ->ready
290>> on that once some event happens, and last you call C<schedule> to put 276>> on that once some event happens, and last you call C<schedule> to put
291yourself to sleep. Note that a lot of things can wake your coroutine up, 277yourself to sleep. Note that a lot of things can wake your coro up,
292so you need to check whether the event indeed happened, e.g. by storing the 278so you need to check whether the event indeed happened, e.g. by storing the
293status in a variable. 279status in a variable.
294 280
295See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks. 281See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks.
296 282
297=item cede 283=item cede
298 284
299"Cede" to other coroutines. This function puts the current coroutine into 285"Cede" to other coros. This function puts the current coro into
300the ready queue and calls C<schedule>, which has the effect of giving 286the ready queue and calls C<schedule>, which has the effect of giving
301up the current "timeslice" to other coroutines of the same or higher 287up the current "timeslice" to other coros of the same or higher
302priority. Once your coroutine gets its turn again it will automatically be 288priority. Once your coro gets its turn again it will automatically be
303resumed. 289resumed.
304 290
305This function is often called C<yield> in other languages. 291This function is often called C<yield> in other languages.
306 292
307=item Coro::cede_notself 293=item Coro::cede_notself
308 294
309Works like cede, but is not exported by default and will cede to I<any> 295Works like cede, but is not exported by default and will cede to I<any>
310coroutine, regardless of priority. This is useful sometimes to ensure 296coro, regardless of priority. This is useful sometimes to ensure
311progress is made. 297progress is made.
312 298
313=item terminate [arg...] 299=item terminate [arg...]
314 300
315Terminates the current coroutine with the given status values (see L<cancel>). 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
316 388
317=item killall 389=item killall
318 390
319Kills/terminates/cancels all coroutines except the currently running 391Kills/terminates/cancels all coros except the currently running one.
320one. This can be useful after a fork, either in the child or the parent,
321as usually only one of them should inherit the running coroutines.
322 392
323Note that in the implementation, destructors run as normal, making this
324function not so useful after a fork. Future versions of this function
325might try to free resources without running any code.
326
327Note that while this will try to free some of the main programs resources, 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
328you cannot free all of them, so if a coroutine that is not the main 395cannot free all of them, so if a coro that is not the main coro
329program calls this function, there will be some one-time resource leak. 396calls this function, there will be some one-time resource leak.
330 397
331=cut 398=cut
332 399
333sub killall { 400sub killall {
334 for (Coro::State::list) { 401 for (Coro::State::list) {
337 } 404 }
338} 405}
339 406
340=back 407=back
341 408
342=head1 COROUTINE OBJECT METHODS 409=head1 CORO OBJECT METHODS
343 410
344These are the methods you can call on coroutine objects (or to create 411These are the methods you can call on coro objects (or to create
345them). 412them).
346 413
347=over 4 414=over 4
348 415
349=item new Coro \&sub [, @args...] 416=item new Coro \&sub [, @args...]
350 417
351Create 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
352automatically terminates as if C<terminate> with the returned values were 419automatically terminates as if C<terminate> with the returned values were
353called. To make the coroutine run you must first put it into the ready 420called. To make the coro run you must first put it into the ready
354queue by calling the ready method. 421queue by calling the ready method.
355 422
356See C<async> and C<Coro::State::new> for additional info about the 423See C<async> and C<Coro::State::new> for additional info about the
357coroutine environment. 424coro environment.
358 425
359=cut 426=cut
360 427
361sub _coro_run { 428sub _coro_run {
362 terminate &{+shift}; 429 terminate &{+shift};
363} 430}
364 431
365=item $success = $coroutine->ready 432=item $success = $coro->ready
366 433
367Put the given coroutine into the end of its ready queue (there is one 434Put the given coro into the end of its ready queue (there is one
368queue for each priority) and return true. If the coroutine is already in 435queue for each priority) and return true. If the coro is already in
369the ready queue, do nothing and return false. 436the ready queue, do nothing and return false.
370 437
371This ensures that the scheduler will resume this coroutine automatically 438This ensures that the scheduler will resume this coro automatically
372once all the coroutines of higher priority and all coroutines of the same 439once all the coro of higher priority and all coro of the same
373priority that were put into the ready queue earlier have been resumed. 440priority that were put into the ready queue earlier have been resumed.
374 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
375=item $is_ready = $coroutine->is_ready 467=item $is_ready = $coro->is_ready
376 468
377Return whether 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.
378 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
379=item $coroutine->cancel (arg...) 483=item $coro->cancel (arg...)
380 484
381Terminates the given coroutine and makes it return the given arguments as 485Terminates the given Coro and makes it return the given arguments as
382status (default: the empty list). Never returns if the coroutine is the 486status (default: the empty list). Never returns if the Coro is the
383current coroutine. 487current Coro.
384 488
385=cut 489=cut
386 490
387sub cancel { 491sub cancel {
388 my $self = shift; 492 my $self = shift;
389 493
390 if ($current == $self) { 494 if ($current == $self) {
391 terminate @_; 495 terminate @_;
392 } else { 496 } else {
393 $self->{_status} = [@_]; 497 $self->{_status} = [@_];
394 $self->_cancel; 498 Coro::State::cancel $self;
395 } 499 }
396} 500}
397 501
398=item $coroutine->schedule_to 502=item $coro->schedule_to
399 503
400Puts the current coroutine to sleep (like C<Coro::schedule>), but instead 504Puts the current coro to sleep (like C<Coro::schedule>), but instead
401of continuing with the next coro from the ready queue, always switch to 505of continuing with the next coro from the ready queue, always switch to
402the given coroutine object (regardless of priority etc.). The readyness 506the given coro object (regardless of priority etc.). The readyness
403state of that coroutine isn't changed. 507state of that coro isn't changed.
404 508
405This is an advanced method for special cases - I'd love to hear about any 509This is an advanced method for special cases - I'd love to hear about any
406uses for this one. 510uses for this one.
407 511
408=item $coroutine->cede_to 512=item $coro->cede_to
409 513
410Like C<schedule_to>, but puts the current coroutine into the ready 514Like C<schedule_to>, but puts the current coro into the ready
411queue. This has the effect of temporarily switching to the given 515queue. This has the effect of temporarily switching to the given
412coroutine, and continuing some time later. 516coro, and continuing some time later.
413 517
414This is an advanced method for special cases - I'd love to hear about any 518This is an advanced method for special cases - I'd love to hear about any
415uses for this one. 519uses for this one.
416 520
417=item $coroutine->throw ([$scalar]) 521=item $coro->throw ([$scalar])
418 522
419If C<$throw> is specified and defined, it will be thrown as an exception 523If C<$throw> is specified and defined, it will be thrown as an exception
420inside the coroutine at the next convenient point in time. Otherwise 524inside the coro at the next convenient point in time. Otherwise
421clears the exception object. 525clears the exception object.
422 526
423Coro will check for the exception each time a schedule-like-function 527Coro will check for the exception each time a schedule-like-function
424returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down 528returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down
425>>, C<< Coro::Handle->readable >> and so on. Most of these functions 529>>, C<< Coro::Handle->readable >> and so on. Most of these functions
427 531
428The exception object will be thrown "as is" with the specified scalar in 532The exception object will be thrown "as is" with the specified scalar in
429C<$@>, i.e. if it is a string, no line number or newline will be appended 533C<$@>, i.e. if it is a string, no line number or newline will be appended
430(unlike with C<die>). 534(unlike with C<die>).
431 535
432This can be used as a softer means than C<cancel> to ask a coroutine to 536This can be used as a softer means than C<cancel> to ask a coro to
433end itself, although there is no guarantee that the exception will lead to 537end itself, although there is no guarantee that the exception will lead to
434termination, and if the exception isn't caught it might well end the whole 538termination, and if the exception isn't caught it might well end the whole
435program. 539program.
436 540
437You might also think of C<throw> as being the moral equivalent of 541You might also think of C<throw> as being the moral equivalent of
438C<kill>ing a coroutine with a signal (in this case, a scalar). 542C<kill>ing a coro with a signal (in this case, a scalar).
439 543
440=item $coroutine->join 544=item $coro->join
441 545
442Wait until the coroutine terminates and return any values given to the 546Wait until the coro terminates and return any values given to the
443C<terminate> or C<cancel> functions. C<join> can be called concurrently 547C<terminate> or C<cancel> functions. C<join> can be called concurrently
444from multiple coroutines, and all will be resumed and given the status 548from multiple coro, and all will be resumed and given the status
445return once the C<$coroutine> terminates. 549return once the C<$coro> terminates.
446 550
447=cut 551=cut
448 552
449sub join { 553sub join {
450 my $self = shift; 554 my $self = shift;
461 } 565 }
462 566
463 wantarray ? @{$self->{_status}} : $self->{_status}[0]; 567 wantarray ? @{$self->{_status}} : $self->{_status}[0];
464} 568}
465 569
466=item $coroutine->on_destroy (\&cb) 570=item $coro->on_destroy (\&cb)
467 571
468Registers a callback that is called when this coroutine gets destroyed, 572Registers a callback that is called when this coro gets destroyed,
469but before it is joined. The callback gets passed the terminate arguments, 573but before it is joined. The callback gets passed the terminate arguments,
470if any, and I<must not> die, under any circumstances. 574if any, and I<must not> die, under any circumstances.
471 575
472=cut 576=cut
473 577
475 my ($self, $cb) = @_; 579 my ($self, $cb) = @_;
476 580
477 push @{ $self->{_on_destroy} }, $cb; 581 push @{ $self->{_on_destroy} }, $cb;
478} 582}
479 583
480=item $oldprio = $coroutine->prio ($newprio) 584=item $oldprio = $coro->prio ($newprio)
481 585
482Sets (or gets, if the argument is missing) the priority of the 586Sets (or gets, if the argument is missing) the priority of the
483coroutine. Higher priority coroutines get run before lower priority 587coro. Higher priority coro get run before lower priority
484coroutines. Priorities are small signed integers (currently -4 .. +3), 588coro. Priorities are small signed integers (currently -4 .. +3),
485that 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
486to get then): 590to get then):
487 591
488 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
489 3 > 1 > 0 > -1 > -3 > -4 593 3 > 1 > 0 > -1 > -3 > -4
490 594
491 # set priority to HIGH 595 # set priority to HIGH
492 current->prio(PRIO_HIGH); 596 current->prio (PRIO_HIGH);
493 597
494The idle coroutine ($Coro::idle) always has a lower priority than any 598The idle coro ($Coro::idle) always has a lower priority than any
495existing coroutine. 599existing coro.
496 600
497Changing the priority of the current coroutine will take effect immediately, 601Changing the priority of the current coro will take effect immediately,
498but changing the priority of coroutines in the ready queue (but not 602but changing the priority of coro in the ready queue (but not
499running) will only take effect after the next schedule (of that 603running) will only take effect after the next schedule (of that
500coroutine). 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.
501 605
502=item $newprio = $coroutine->nice ($change) 606=item $newprio = $coro->nice ($change)
503 607
504Similar 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.
505higher values mean lower priority, just as in unix). 609higher values mean lower priority, just as in unix).
506 610
507=item $olddesc = $coroutine->desc ($newdesc) 611=item $olddesc = $coro->desc ($newdesc)
508 612
509Sets (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
510coroutine. This is just a free-form string you can associate with a 614coro. This is just a free-form string you can associate with a
511coroutine. 615coro.
512 616
513This method simply sets the C<< $coroutine->{desc} >> member to the given 617This method simply sets the C<< $coro->{desc} >> member to the given
514string. You can 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 }
515 630
516=cut 631=cut
517 632
518sub desc { 633sub desc {
519 my $old = $_[0]{desc}; 634 my $old = $_[0]{desc};
532 647
533=over 4 648=over 4
534 649
535=item Coro::nready 650=item Coro::nready
536 651
537Returns the number of coroutines that are currently in the ready state, 652Returns the number of coro that are currently in the ready state,
538i.e. that can be switched to by calling C<schedule> directory or 653i.e. that can be switched to by calling C<schedule> directory or
539indirectly. The value C<0> means that the only runnable coroutine is the 654indirectly. The value C<0> means that the only runnable coro is the
540currently running one, so C<cede> would have no effect, and C<schedule> 655currently running one, so C<cede> would have no effect, and C<schedule>
541would cause a deadlock unless there is an idle handler that wakes up some 656would cause a deadlock unless there is an idle handler that wakes up some
542coroutines. 657coro.
543 658
544=item my $guard = Coro::guard { ... } 659=item my $guard = Coro::guard { ... }
545 660
546This function still exists, but is deprecated. Please use the 661This function still exists, but is deprecated. Please use the
547C<Guard::guard> function instead. 662C<Guard::guard> function instead.
554 669
555This utility function takes a BLOCK or code reference and "unblocks" it, 670This utility function takes a BLOCK or code reference and "unblocks" it,
556returning a new coderef. Unblocking means that calling the new coderef 671returning a new coderef. Unblocking means that calling the new coderef
557will return immediately without blocking, returning nothing, while the 672will return immediately without blocking, returning nothing, while the
558original code ref will be called (with parameters) from within another 673original code ref will be called (with parameters) from within another
559coroutine. 674coro.
560 675
561The reason this function exists is that many event libraries (such as the 676The reason this function exists is that many event libraries (such as
562venerable L<Event|Event> module) are not coroutine-safe (a weaker form 677the venerable L<Event|Event> module) are not thread-safe (a weaker form
563of reentrancy). This means you must not block within event callbacks, 678of reentrancy). This means you must not block within event callbacks,
564otherwise you might suffer from crashes or worse. The only event library 679otherwise you might suffer from crashes or worse. The only event library
565currently known that is safe to use without C<unblock_sub> is L<EV>. 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.
566 686
567This function allows your callbacks to block by executing them in another 687This function allows your callbacks to block by executing them in another
568coroutine 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
569is 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
570disk, for example. 690disk, for example.
571 691
572In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when 692In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
573creating event callbacks that want to block. 693creating event callbacks that want to block.
574 694
575If your handler does not plan to block (e.g. simply sends a message to 695If your handler does not plan to block (e.g. simply sends a message to
576another coroutine, or puts some other coroutine into the ready queue), 696another coro, or puts some other coro into the ready queue), there is
577there is no reason to use C<unblock_sub>. 697no reason to use C<unblock_sub>.
578 698
579Note that you also need to use C<unblock_sub> for any other callbacks that 699Note that you also need to use C<unblock_sub> for any other callbacks that
580are indirectly executed by any C-based event loop. For example, when you 700are indirectly executed by any C-based event loop. For example, when you
581use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it 701use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
582provides callbacks that are the result of some event callback, then you 702provides callbacks that are the result of some event callback, then you
612 unshift @unblock_queue, [$cb, @_]; 732 unshift @unblock_queue, [$cb, @_];
613 $unblock_scheduler->ready; 733 $unblock_scheduler->ready;
614 } 734 }
615} 735}
616 736
617=item $cb = Coro::rouse_cb 737=item $cb = rouse_cb
618 738
619Create and return a "rouse callback". That's a code reference that, 739Create and return a "rouse callback". That's a code reference that,
620when called, will remember a copy of its arguments and notify the owner 740when called, will remember a copy of its arguments and notify the owner
621coroutine of the callback. 741coro of the callback.
622 742
623See the next function. 743See the next function.
624 744
625=item @args = Coro::rouse_wait [$cb] 745=item @args = rouse_wait [$cb]
626 746
627Wait for the specified rouse callback (or the last one that was created in 747Wait for the specified rouse callback (or the last one that was created in
628this coroutine). 748this coro).
629 749
630As soon as the callback is invoked (or when the callback was invoked 750As soon as the callback is invoked (or when the callback was invoked
631before C<rouse_wait>), it will return the arguments originally passed to 751before C<rouse_wait>), it will return the arguments originally passed to
632the rouse callback. 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.
633 755
634See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example. 756See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.
635 757
636=back 758=back
637 759
639 761
6401; 7621;
641 763
642=head1 HOW TO WAIT FOR A CALLBACK 764=head1 HOW TO WAIT FOR A CALLBACK
643 765
644It is very common for a coroutine to wait for some callback to be 766It is very common for a coro to wait for some callback to be
645called. This occurs naturally when you use coroutines in an otherwise 767called. This occurs naturally when you use coro in an otherwise
646event-based program, or when you use event-based libraries. 768event-based program, or when you use event-based libraries.
647 769
648These typically register a callback for some event, and call that callback 770These typically register a callback for some event, and call that callback
649when the event occured. In a coroutine, however, you typically want to 771when the event occured. In a coro, however, you typically want to
650just wait for the event, simplyifying things. 772just wait for the event, simplyifying things.
651 773
652For example C<< AnyEvent->child >> registers a callback to be called when 774For example C<< AnyEvent->child >> registers a callback to be called when
653a specific child has exited: 775a specific child has exited:
654 776
655 my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... }); 777 my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });
656 778
657But from withina coroutine, you often just want to write this: 779But from within a coro, you often just want to write this:
658 780
659 my $status = wait_for_child $pid; 781 my $status = wait_for_child $pid;
660 782
661Coro offers two functions specifically designed to make this easy, 783Coro offers two functions specifically designed to make this easy,
662C<Coro::rouse_cb> and C<Coro::rouse_wait>. 784C<Coro::rouse_cb> and C<Coro::rouse_wait>.
663 785
664The first function, C<rouse_cb>, generates and returns a callback that, 786The first function, C<rouse_cb>, generates and returns a callback that,
665when invoked, will save its arguments and notify the coroutine that 787when invoked, will save its arguments and notify the coro that
666created the callback. 788created the callback.
667 789
668The second function, C<rouse_wait>, waits for the callback to be called 790The second function, C<rouse_wait>, waits for the callback to be called
669(by calling C<schedule> to go to sleep) and returns the arguments 791(by calling C<schedule> to go to sleep) and returns the arguments
670originally passed to the callback. 792originally passed to the callback.
685you can roll your own, using C<schedule>: 807you can roll your own, using C<schedule>:
686 808
687 sub wait_for_child($) { 809 sub wait_for_child($) {
688 my ($pid) = @_; 810 my ($pid) = @_;
689 811
690 # store the current coroutine in $current, 812 # store the current coro in $current,
691 # and provide result variables for the closure passed to ->child 813 # and provide result variables for the closure passed to ->child
692 my $current = $Coro::current; 814 my $current = $Coro::current;
693 my ($done, $rstatus); 815 my ($done, $rstatus);
694 816
695 # pass a closure to ->child 817 # pass a closure to ->child
711 833
712=item fork with pthread backend 834=item fork with pthread backend
713 835
714When Coro is compiled using the pthread backend (which isn't recommended 836When Coro is compiled using the pthread backend (which isn't recommended
715but required on many BSDs as their libcs are completely broken), then 837but required on many BSDs as their libcs are completely broken), then
716coroutines will not survive a fork. There is no known workaround except to 838coro will not survive a fork. There is no known workaround except to
717fix your libc and use a saner backend. 839fix your libc and use a saner backend.
718 840
719=item perl process emulation ("threads") 841=item perl process emulation ("threads")
720 842
721This module is not perl-pseudo-thread-safe. You should only ever use this 843This module is not perl-pseudo-thread-safe. You should only ever use this
723future 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
724this). I recommend disabling thread support and using processes, as having 846this). I recommend disabling thread support and using processes, as having
725the windows process emulation enabled under unix roughly halves perl 847the windows process emulation enabled under unix roughly halves perl
726performance, even when not used. 848performance, even when not used.
727 849
728=item coroutine switching not signal safe 850=item coro switching is not signal safe
729 851
730You must not switch to another coroutine from within a signal handler 852You must not switch to another coro from within a signal handler (only
731(only relevant with %SIG - most event libraries provide safe signals). 853relevant with %SIG - most event libraries provide safe signals), I<unless>
854you are sure you are not interrupting a Coro function.
732 855
733That means you I<MUST NOT> call any function that might "block" the 856That means you I<MUST NOT> call any function that might "block" the
734current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or 857current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
735anything that calls those. Everything else, including calling C<ready>, 858anything that calls those. Everything else, including calling C<ready>,
736works. 859works.
737 860
738=back 861=back
739 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.
740 924
741=head1 SEE ALSO 925=head1 SEE ALSO
742 926
743Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>. 927Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
744 928

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines