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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines