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

Comparing Coro/Coro.pm (file contents):
Revision 1.233 by root, Fri Nov 21 06:02:07 2008 UTC vs.
Revision 1.273 by root, Fri Dec 11 18:32:23 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines