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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines