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

Comparing Coro/Coro.pm (file contents):
Revision 1.235 by root, Fri Nov 21 06:54:51 2008 UTC vs.
Revision 1.268 by root, Thu Oct 1 23:16:27 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines