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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.237 by root, Sat Nov 22 16:37:11 2008 UTC vs.
Revision 1.264 by root, Thu Aug 13 02:35:41 2009 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines