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

Comparing Coro/Coro.pm (file contents):
Revision 1.247 by root, Mon Dec 15 02:07:11 2008 UTC vs.
Revision 1.268 by root, Thu Oct 1 23:16:27 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines