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

Comparing Coro/Coro.pm (file contents):
Revision 1.180 by root, Fri Apr 25 04:28:50 2008 UTC vs.
Revision 1.226 by root, Wed Nov 19 16:01:32 2008 UTC

16 cede; # yield to coroutine 16 cede; # yield to coroutine
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 my $lock = new Coro::Semaphore; 22 my $lock = new Coro::Semaphore;
22 my $locked; 23 my $locked;
23 24
24 $lock->down; 25 $lock->down;
25 $locked = 1; 26 $locked = 1;
26 $lock->up; 27 $lock->up;
27 28
28=head1 DESCRIPTION 29=head1 DESCRIPTION
29 30
30This module collection manages coroutines. Coroutines are similar 31This module collection manages coroutines. Coroutines are similar to
31to threads but don't run in parallel at the same time even on SMP 32threads but don't (in general) run in parallel at the same time even
32machines. The specific flavor of coroutine used in this module also 33on SMP machines. The specific flavor of coroutine used in this module
33guarantees you that it will not switch between coroutines unless 34also guarantees you that it will not switch between coroutines unless
34necessary, at easily-identified points in your program, so locking and 35necessary, at easily-identified points in your program, so locking and
35parallel access are rarely an issue, making coroutine programming much 36parallel access are rarely an issue, making coroutine programming much
36safer than threads programming. 37safer and easier than threads programming.
37 38
38(Perl, however, does not natively support real threads but instead does a 39Unlike a normal perl program, however, coroutines allow you to have
39very slow and memory-intensive emulation of processes using threads. This 40multiple running interpreters that share data, which is especially useful
40is a performance win on Windows machines, and a loss everywhere else). 41to code pseudo-parallel processes and for event-based programming, such as
42multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> to
43learn more.
44
45Coroutines are also useful because Perl has no support for threads (the so
46called "threads" that perl offers are nothing more than the (bad) process
47emulation coming from the Windows platform: On standard operating systems
48they serve no purpose whatsoever, except by making your programs slow and
49making them use a lot of memory. Best disable them when building perl, or
50aks your software vendor/distributor to do it for you).
41 51
42In this module, coroutines are defined as "callchain + lexical variables + 52In this module, coroutines are defined as "callchain + lexical variables +
43@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, 53@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
44its own set of lexicals and its own set of perls most important global 54its own set of lexicals and its own set of perls most important global
45variables (see L<Coro::State> for more configuration). 55variables (see L<Coro::State> for more configuration).
46 56
47=cut 57=cut
48 58
49package Coro; 59package Coro;
50 60
51use strict; 61use strict qw(vars subs);
52no warnings "uninitialized"; 62no warnings "uninitialized";
53 63
54use Coro::State; 64use Coro::State;
55 65
56use base qw(Coro::State Exporter); 66use base qw(Coro::State Exporter);
57 67
58our $idle; # idle handler 68our $idle; # idle handler
59our $main; # main coroutine 69our $main; # main coroutine
60our $current; # current coroutine 70our $current; # current coroutine
61 71
62our $VERSION = 4.6; 72our $VERSION = 5.0;
63 73
64our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); 74our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
65our %EXPORT_TAGS = ( 75our %EXPORT_TAGS = (
66 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 76 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
67); 77);
68our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); 78our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
69 79
70=over 4 80=over 4
71 81
72=item $main 82=item $Coro::main
73 83
74This coroutine represents the main program. 84This variable stores the coroutine object that represents the main
85program. While you cna C<ready> it and do most other things you can do to
86coroutines, it is mainly useful to compare again C<$Coro::current>, to see
87whether you are running in the main program or not.
75 88
76=cut 89=cut
77 90
78$main = new Coro; 91# $main is now being initialised by Coro::State
79 92
80=item $current (or as function: current) 93=item $Coro::current
81 94
82The current coroutine (the last coroutine switched to). The initial value 95The coroutine object representing the current coroutine (the last
96coroutine that the Coro scheduler switched to). The initial value is
83is C<$main> (of course). 97C<$Coro::main> (of course).
84 98
85This variable is B<strictly> I<read-only>. It is provided for performance 99This variable is B<strictly> I<read-only>. You can take copies of the
86reasons. If performance is not essential you are encouraged to use the 100value stored in it and use it as any other coroutine object, but you must
87C<Coro::current> function instead. 101not otherwise modify the variable itself.
88 102
89=cut 103=cut
90 104
91$main->{desc} = "[main::]";
92
93# maybe some other module used Coro::Specific before...
94$main->{_specific} = $current->{_specific}
95 if $current;
96
97_set_current $main;
98
99sub current() { $current } 105sub current() { $current } # [DEPRECATED]
100 106
101=item $idle 107=item $Coro::idle
102 108
103A callback that is called whenever the scheduler finds no ready coroutines 109This variable is mainly useful to integrate Coro into event loops. It is
104to run. The default implementation prints "FATAL: deadlock detected" and 110usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is
105exits, because the program has no other way to continue. 111pretty low-level functionality.
112
113This variable stores a callback that is called whenever the scheduler
114finds no ready coroutines to run. The default implementation prints
115"FATAL: deadlock detected" and exits, because the program has no other way
116to continue.
106 117
107This hook is overwritten by modules such as C<Coro::Timer> and 118This hook is overwritten by modules such as C<Coro::Timer> and
108C<Coro::Event> to wait on an external event that hopefully wake up a 119C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
109coroutine so the scheduler can run it. 120coroutine so the scheduler can run it.
121
122Note that the callback I<must not>, under any circumstances, block
123the current coroutine. Normally, this is achieved by having an "idle
124coroutine" that calls the event loop and then blocks again, and then
125readying that coroutine in the idle handler.
126
127See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this
128technique.
110 129
111Please note that if your callback recursively invokes perl (e.g. for event 130Please note that if your callback recursively invokes perl (e.g. for event
112handlers), then it must be prepared to be called recursively itself. 131handlers), then it must be prepared to be called recursively itself.
113 132
114=cut 133=cut
125 $self->_destroy 144 $self->_destroy
126 or return; 145 or return;
127 146
128 # call all destruction callbacks 147 # call all destruction callbacks
129 $_->(@{$self->{_status}}) 148 $_->(@{$self->{_status}})
130 for @{(delete $self->{_on_destroy}) || []}; 149 for @{ delete $self->{_on_destroy} || [] };
131} 150}
132 151
133# this coroutine is necessary because a coroutine 152# this coroutine is necessary because a coroutine
134# cannot destroy itself. 153# cannot destroy itself.
135my @destroy; 154our @destroy;
136my $manager; 155our $manager;
137 156
138$manager = new Coro sub { 157$manager = new Coro sub {
139 while () { 158 while () {
140 (shift @destroy)->_cancel 159 (shift @destroy)->_cancel
141 while @destroy; 160 while @destroy;
142 161
143 &schedule; 162 &schedule;
144 } 163 }
145}; 164};
146$manager->desc ("[coro manager]"); 165$manager->{desc} = "[coro manager]";
147$manager->prio (PRIO_MAX); 166$manager->prio (PRIO_MAX);
148 167
149=back 168=back
150 169
151=head2 STATIC METHODS 170=head2 SIMPLE COROUTINE CREATION
152
153Static methods are actually functions that operate on the current coroutine only.
154 171
155=over 4 172=over 4
156 173
157=item async { ... } [@args...] 174=item async { ... } [@args...]
158 175
159Create a new asynchronous coroutine and return it's coroutine object 176Create a new coroutine and return it's coroutine object (usually
160(usually unused). When the sub returns the new coroutine is automatically 177unused). The coroutine will be put into the ready queue, so
178it will start running automatically on the next scheduler run.
179
180The first argument is a codeblock/closure that should be executed in the
181coroutine. When it returns argument returns the coroutine is automatically
161terminated. 182terminated.
162 183
184The remaining arguments are passed as arguments to the closure.
185
163See the C<Coro::State::new> constructor for info about the coroutine 186See the C<Coro::State::new> constructor for info about the coroutine
164environment in which coroutines run. 187environment in which coroutines are executed.
165 188
166Calling C<exit> in a coroutine will do the same as calling exit outside 189Calling C<exit> in a coroutine will do the same as calling exit outside
167the coroutine. Likewise, when the coroutine dies, the program will exit, 190the coroutine. Likewise, when the coroutine dies, the program will exit,
168just as it would in the main program. 191just as it would in the main program.
169 192
193If you do not want that, you can provide a default C<die> handler, or
194simply avoid dieing (by use of C<eval>).
195
170 # create a new coroutine that just prints its arguments 196Example: Create a new coroutine that just prints its arguments.
197
171 async { 198 async {
172 print "@_\n"; 199 print "@_\n";
173 } 1,2,3,4; 200 } 1,2,3,4;
174 201
175=cut 202=cut
181} 208}
182 209
183=item async_pool { ... } [@args...] 210=item async_pool { ... } [@args...]
184 211
185Similar to C<async>, but uses a coroutine pool, so you should not call 212Similar to C<async>, but uses a coroutine pool, so you should not call
186terminate or join (although you are allowed to), and you get a coroutine 213terminate or join on it (although you are allowed to), and you get a
187that might have executed other code already (which can be good or bad :). 214coroutine that might have executed other code already (which can be good
215or bad :).
188 216
217On the plus side, this function is faster than creating (and destroying)
218a completly new coroutine, so if you need a lot of generic coroutines in
219quick successsion, use C<async_pool>, not C<async>.
220
189Also, the block is executed in an C<eval> context and a warning will be 221The code block is executed in an C<eval> context and a warning will be
190issued in case of an exception instead of terminating the program, as 222issued in case of an exception instead of terminating the program, as
191C<async> does. As the coroutine is being reused, stuff like C<on_destroy> 223C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
192will not work in the expected way, unless you call terminate or cancel, 224will not work in the expected way, unless you call terminate or cancel,
193which somehow defeats the purpose of pooling. 225which somehow defeats the purpose of pooling (but is fine in the
226exceptional case).
194 227
195The priority will be reset to C<0> after each job, tracing will be 228The priority will be reset to C<0> after each run, tracing will be
196disabled, the description will be reset and the default output filehandle 229disabled, the description will be reset and the default output filehandle
197gets restored, so you can change alkl these. Otherwise the coroutine will 230gets restored, so you can change all these. Otherwise the coroutine will
198be re-used "as-is": most notably if you change other per-coroutine global 231be re-used "as-is": most notably if you change other per-coroutine global
199stuff such as C<$/> you need to revert that change, which is most simply 232stuff such as C<$/> you I<must needs> revert that change, which is most
200done by using local as in C< local $/ >. 233simply done by using local as in: C<< local $/ >>.
201 234
202The pool size is limited to 8 idle coroutines (this can be adjusted by 235The idle pool size is limited to C<8> idle coroutines (this can be
203changing $Coro::POOL_SIZE), and there can be as many non-idle coros as 236adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
204required. 237coros as required.
205 238
206If you are concerned about pooled coroutines growing a lot because a 239If you are concerned about pooled coroutines growing a lot because a
207single C<async_pool> used a lot of stackspace you can e.g. C<async_pool 240single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
208{ terminate }> once per second or so to slowly replenish the pool. In 241{ terminate }> once per second or so to slowly replenish the pool. In
209addition to that, when the stacks used by a handler grows larger than 16kb 242addition to that, when the stacks used by a handler grows larger than 16kb
210(adjustable with $Coro::POOL_RSS) it will also exit. 243(adjustable via $Coro::POOL_RSS) it will also be destroyed.
211 244
212=cut 245=cut
213 246
214our $POOL_SIZE = 8; 247our $POOL_SIZE = 8;
215our $POOL_RSS = 16 * 1024; 248our $POOL_RSS = 16 * 1024;
226 _pool_2 $cb; 259 _pool_2 $cb;
227 &schedule; 260 &schedule;
228 } 261 }
229 }; 262 };
230 263
264 if ($@) {
231 last if $@ eq "\3async_pool terminate\2\n"; 265 last if $@ eq "\3async_pool terminate\2\n";
232 warn $@ if $@; 266 warn $@;
267 }
233 } 268 }
234} 269}
235 270
236sub async_pool(&@) { 271sub async_pool(&@) {
237 # this is also inlined into the unlock_scheduler 272 # this is also inlined into the unblock_scheduler
238 my $coro = (pop @async_pool) || new Coro \&pool_handler; 273 my $coro = (pop @async_pool) || new Coro \&pool_handler;
239 274
240 $coro->{_invoke} = [@_]; 275 $coro->{_invoke} = [@_];
241 $coro->ready; 276 $coro->ready;
242 277
243 $coro 278 $coro
244} 279}
245 280
281=back
282
283=head2 STATIC METHODS
284
285Static methods are actually functions that operate on the current coroutine.
286
287=over 4
288
246=item schedule 289=item schedule
247 290
248Calls the scheduler. Please note that the current coroutine will not be put 291Calls the scheduler. The scheduler will find the next coroutine that is
292to be run from the ready queue and switches to it. The next coroutine
293to be run is simply the one with the highest priority that is longest
294in its ready queue. If there is no coroutine ready, it will clal the
295C<$Coro::idle> hook.
296
297Please note that the current coroutine will I<not> be put into the ready
249into the ready queue, so calling this function usually means you will 298queue, so calling this function usually means you will never be called
250never be called again unless something else (e.g. an event handler) calls 299again unless something else (e.g. an event handler) calls C<< ->ready >>,
251ready. 300thus waking you up.
252 301
253The canonical way to wait on external events is this: 302This makes C<schedule> I<the> generic method to use to block the current
303coroutine and wait for events: first you remember the current coroutine in
304a variable, then arrange for some callback of yours to call C<< ->ready
305>> on that once some event happens, and last you call C<schedule> to put
306yourself to sleep. Note that a lot of things can wake your coroutine up,
307so you need to check whether the event indeed happened, e.g. by storing the
308status in a variable.
254 309
255 { 310See B<HOW TO WAIT FOR A CALLBACK>, below, for some ways to wait for callbacks.
256 # remember current coroutine
257 my $current = $Coro::current;
258
259 # register a hypothetical event handler
260 on_event_invoke sub {
261 # wake up sleeping coroutine
262 $current->ready;
263 undef $current;
264 };
265
266 # call schedule until event occurred.
267 # in case we are woken up for other reasons
268 # (current still defined), loop.
269 Coro::schedule while $current;
270 }
271 311
272=item cede 312=item cede
273 313
274"Cede" to other coroutines. This function puts the current coroutine into the 314"Cede" to other coroutines. This function puts the current coroutine into
275ready queue and calls C<schedule>, which has the effect of giving up the 315the ready queue and calls C<schedule>, which has the effect of giving
276current "timeslice" to other coroutines of the same or higher priority. 316up the current "timeslice" to other coroutines of the same or higher
317priority. Once your coroutine gets its turn again it will automatically be
318resumed.
319
320This function is often called C<yield> in other languages.
277 321
278=item Coro::cede_notself 322=item Coro::cede_notself
279 323
280Works like cede, but is not exported by default and will cede to any 324Works like cede, but is not exported by default and will cede to I<any>
281coroutine, regardless of priority, once. 325coroutine, regardless of priority. This is useful sometimes to ensure
326progress is made.
282 327
283=item terminate [arg...] 328=item terminate [arg...]
284 329
285Terminates the current coroutine with the given status values (see L<cancel>). 330Terminates the current coroutine with the given status values (see L<cancel>).
286 331
288 333
289Kills/terminates/cancels all coroutines except the currently running 334Kills/terminates/cancels all coroutines except the currently running
290one. This is useful after a fork, either in the child or the parent, as 335one. This is useful after a fork, either in the child or the parent, as
291usually only one of them should inherit the running coroutines. 336usually only one of them should inherit the running coroutines.
292 337
338Note that while this will try to free some of the main programs resources,
339you cannot free all of them, so if a coroutine that is not the main
340program calls this function, there will be some one-time resource leak.
341
293=cut 342=cut
294 343
295sub terminate { 344sub terminate {
296 $current->cancel (@_); 345 $current->{_status} = [@_];
346 push @destroy, $current;
347 $manager->ready;
348 do { &schedule } while 1;
297} 349}
298 350
299sub killall { 351sub killall {
300 for (Coro::State::list) { 352 for (Coro::State::list) {
301 $_->cancel 353 $_->cancel
305 357
306=back 358=back
307 359
308=head2 COROUTINE METHODS 360=head2 COROUTINE METHODS
309 361
310These are the methods you can call on coroutine objects. 362These are the methods you can call on coroutine objects (or to create
363them).
311 364
312=over 4 365=over 4
313 366
314=item new Coro \&sub [, @args...] 367=item new Coro \&sub [, @args...]
315 368
316Create a new coroutine and return it. When the sub returns the coroutine 369Create a new coroutine and return it. When the sub returns, the coroutine
317automatically terminates as if C<terminate> with the returned values were 370automatically terminates as if C<terminate> with the returned values were
318called. To make the coroutine run you must first put it into the ready queue 371called. To make the coroutine run you must first put it into the ready
319by calling the ready method. 372queue by calling the ready method.
320 373
321See C<async> and C<Coro::State::new> for additional info about the 374See C<async> and C<Coro::State::new> for additional info about the
322coroutine environment. 375coroutine environment.
323 376
324=cut 377=cut
325 378
326sub _run_coro { 379sub _terminate {
327 terminate &{+shift}; 380 terminate &{+shift};
328} 381}
329 382
330sub new {
331 my $class = shift;
332
333 $class->SUPER::new (\&_run_coro, @_)
334}
335
336=item $success = $coroutine->ready 383=item $success = $coroutine->ready
337 384
338Put the given coroutine into the ready queue (according to it's priority) 385Put the given coroutine into the end of its ready queue (there is one
339and return true. If the coroutine is already in the ready queue, do nothing 386queue for each priority) and return true. If the coroutine is already in
340and return false. 387the ready queue, do nothing and return false.
388
389This ensures that the scheduler will resume this coroutine automatically
390once all the coroutines of higher priority and all coroutines of the same
391priority that were put into the ready queue earlier have been resumed.
341 392
342=item $is_ready = $coroutine->is_ready 393=item $is_ready = $coroutine->is_ready
343 394
344Return wether the coroutine is currently the ready queue or not, 395Return whether the coroutine is currently the ready queue or not,
345 396
346=item $coroutine->cancel (arg...) 397=item $coroutine->cancel (arg...)
347 398
348Terminates the given coroutine and makes it return the given arguments as 399Terminates the given coroutine and makes it return the given arguments as
349status (default: the empty list). Never returns if the coroutine is the 400status (default: the empty list). Never returns if the coroutine is the
351 402
352=cut 403=cut
353 404
354sub cancel { 405sub cancel {
355 my $self = shift; 406 my $self = shift;
356 $self->{_status} = [@_];
357 407
358 if ($current == $self) { 408 if ($current == $self) {
359 push @destroy, $self; 409 terminate @_;
360 $manager->ready;
361 &schedule while 1;
362 } else { 410 } else {
411 $self->{_status} = [@_];
363 $self->_cancel; 412 $self->_cancel;
364 } 413 }
365} 414}
415
416=item $coroutine->throw ([$scalar])
417
418If C<$throw> is specified and defined, it will be thrown as an exception
419inside the coroutine at the next convenient point in time. Otherwise
420clears the exception object.
421
422Coro will check for the exception each time a schedule-like-function
423returns, i.e. after each C<schedule>, C<cede>, C<< Coro::Semaphore->down
424>>, C<< Coro::Handle->readable >> and so on. Most of these functions
425detect this case and return early in case an exception is pending.
426
427The exception object will be thrown "as is" with the specified scalar in
428C<$@>, i.e. if it is a string, no line number or newline will be appended
429(unlike with C<die>).
430
431This can be used as a softer means than C<cancel> to ask a coroutine to
432end itself, although there is no guarantee that the exception will lead to
433termination, and if the exception isn't caught it might well end the whole
434program.
435
436You might also think of C<throw> as being the moral equivalent of
437C<kill>ing a coroutine with a signal (in this case, a scalar).
366 438
367=item $coroutine->join 439=item $coroutine->join
368 440
369Wait until the coroutine terminates and return any values given to the 441Wait until the coroutine terminates and return any values given to the
370C<terminate> or C<cancel> functions. C<join> can be called concurrently 442C<terminate> or C<cancel> functions. C<join> can be called concurrently
371from multiple coroutines. 443from multiple coroutines, and all will be resumed and given the status
444return once the C<$coroutine> terminates.
372 445
373=cut 446=cut
374 447
375sub join { 448sub join {
376 my $self = shift; 449 my $self = shift;
391 464
392=item $coroutine->on_destroy (\&cb) 465=item $coroutine->on_destroy (\&cb)
393 466
394Registers a callback that is called when this coroutine gets destroyed, 467Registers a callback that is called when this coroutine gets destroyed,
395but before it is joined. The callback gets passed the terminate arguments, 468but before it is joined. The callback gets passed the terminate arguments,
396if any. 469if any, and I<must not> die, under any circumstances.
397 470
398=cut 471=cut
399 472
400sub on_destroy { 473sub on_destroy {
401 my ($self, $cb) = @_; 474 my ($self, $cb) = @_;
431higher values mean lower priority, just as in unix). 504higher values mean lower priority, just as in unix).
432 505
433=item $olddesc = $coroutine->desc ($newdesc) 506=item $olddesc = $coroutine->desc ($newdesc)
434 507
435Sets (or gets in case the argument is missing) the description for this 508Sets (or gets in case the argument is missing) the description for this
436coroutine. This is just a free-form string you can associate with a coroutine. 509coroutine. This is just a free-form string you can associate with a
510coroutine.
437 511
438This method simply sets the C<< $coroutine->{desc} >> member to the given string. You 512This method simply sets the C<< $coroutine->{desc} >> member to the given
439can modify this member directly if you wish. 513string. You can modify this member directly if you wish.
440
441=item $coroutine->throw ([$scalar])
442
443If C<$throw> is specified and defined, it will be thrown as an exception
444inside the coroutine at the next convinient point in time (usually after
445it gains control at the next schedule/transfer/cede). Otherwise clears the
446exception object.
447
448The exception object will be thrown "as is" with the specified scalar in
449C<$@>, i.e. if it is a string, no line number or newline will be appended
450(unlike with C<die>).
451
452This can be used as a softer means than C<cancel> to ask a coroutine to
453end itself, although there is no guarentee that the exception will lead to
454termination, and if the exception isn't caught it might well end the whole
455program.
456 514
457=cut 515=cut
458 516
459sub desc { 517sub desc {
460 my $old = $_[0]{desc}; 518 my $old = $_[0]{desc};
469=over 4 527=over 4
470 528
471=item Coro::nready 529=item Coro::nready
472 530
473Returns the number of coroutines that are currently in the ready state, 531Returns the number of coroutines that are currently in the ready state,
474i.e. that can be switched to. The value C<0> means that the only runnable 532i.e. that can be switched to by calling C<schedule> directory or
533indirectly. The value C<0> means that the only runnable coroutine is the
475coroutine is the currently running one, so C<cede> would have no effect, 534currently running one, so C<cede> would have no effect, and C<schedule>
476and C<schedule> would cause a deadlock unless there is an idle handler 535would cause a deadlock unless there is an idle handler that wakes up some
477that wakes up some coroutines. 536coroutines.
478 537
479=item my $guard = Coro::guard { ... } 538=item my $guard = Coro::guard { ... }
480 539
481This creates and returns a guard object. Nothing happens until the object 540This creates and returns a guard object. Nothing happens until the object
482gets destroyed, in which case the codeblock given as argument will be 541gets destroyed, in which case the codeblock given as argument will be
511 570
512 571
513=item unblock_sub { ... } 572=item unblock_sub { ... }
514 573
515This utility function takes a BLOCK or code reference and "unblocks" it, 574This utility function takes a BLOCK or code reference and "unblocks" it,
516returning the new coderef. This means that the new coderef will return 575returning a new coderef. Unblocking means that calling the new coderef
517immediately without blocking, returning nothing, while the original code 576will return immediately without blocking, returning nothing, while the
518ref will be called (with parameters) from within its own coroutine. 577original code ref will be called (with parameters) from within another
578coroutine.
519 579
520The reason this function exists is that many event libraries (such as the 580The reason this function exists is that many event libraries (such as the
521venerable L<Event|Event> module) are not coroutine-safe (a weaker form 581venerable L<Event|Event> module) are not coroutine-safe (a weaker form
522of thread-safety). This means you must not block within event callbacks, 582of thread-safety). This means you must not block within event callbacks,
523otherwise you might suffer from crashes or worse. 583otherwise you might suffer from crashes or worse. The only event library
584currently known that is safe to use without C<unblock_sub> is L<EV>.
524 585
525This function allows your callbacks to block by executing them in another 586This function allows your callbacks to block by executing them in another
526coroutine where it is safe to block. One example where blocking is handy 587coroutine where it is safe to block. One example where blocking is handy
527is when you use the L<Coro::AIO|Coro::AIO> functions to save results to 588is when you use the L<Coro::AIO|Coro::AIO> functions to save results to
528disk. 589disk, for example.
529 590
530In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when 591In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
531creating event callbacks that want to block. 592creating event callbacks that want to block.
593
594If your handler does not plan to block (e.g. simply sends a message to
595another coroutine, or puts some other coroutine into the ready queue),
596there is no reason to use C<unblock_sub>.
597
598Note that you also need to use C<unblock_sub> for any other callbacks that
599are indirectly executed by any C-based event loop. For example, when you
600use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
601provides callbacks that are the result of some event callback, then you
602must not block either, or use C<unblock_sub>.
532 603
533=cut 604=cut
534 605
535our @unblock_queue; 606our @unblock_queue;
536 607
549 cede; # for short-lived callbacks, this reduces pressure on the coro pool 620 cede; # for short-lived callbacks, this reduces pressure on the coro pool
550 } 621 }
551 schedule; # sleep well 622 schedule; # sleep well
552 } 623 }
553}; 624};
554$unblock_scheduler->desc ("[unblock_sub scheduler]"); 625$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
555 626
556sub unblock_sub(&) { 627sub unblock_sub(&) {
557 my $cb = shift; 628 my $cb = shift;
558 629
559 sub { 630 sub {
560 unshift @unblock_queue, [$cb, @_]; 631 unshift @unblock_queue, [$cb, @_];
561 $unblock_scheduler->ready; 632 $unblock_scheduler->ready;
562 } 633 }
563} 634}
564 635
636=item $cb = Coro::rouse_cb
637
638Create and return a "rouse callback". That's a code reference that, when
639called, will save its arguments and notify the owner coroutine of the
640callback.
641
642See the next function.
643
644=item @args = Coro::rouse_wait [$cb]
645
646Wait for the specified rouse callback (or the last one tht was created in
647this coroutine).
648
649As soon as the callback is invoked (or when the calback was invoked before
650C<rouse_wait>), it will return a copy of the arguments originally passed
651to the rouse callback.
652
653See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.
654
565=back 655=back
566 656
567=cut 657=cut
568 658
5691; 6591;
570 660
661=head1 HOW TO WAIT FOR A CALLBACK
662
663It is very common for a coroutine to wait for some callback to be
664called. This occurs naturally when you use coroutines in an otherwise
665event-based program, or when you use event-based libraries.
666
667These typically register a callback for some event, and call that callback
668when the event occured. In a coroutine, however, you typically want to
669just wait for the event, simplyifying things.
670
671For example C<< AnyEvent->child >> registers a callback to be called when
672a specific child has exited:
673
674 my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });
675
676But from withina coroutine, you often just want to write this:
677
678 my $status = wait_for_child $pid;
679
680Coro offers two functions specifically designed to make this easy,
681C<Coro::rouse_cb> and C<Coro::rouse_wait>.
682
683The first function, C<rouse_cb>, generates and returns a callback that,
684when invoked, will save it's arguments and notify the coroutine that
685created the callback.
686
687The second function, C<rouse_wait>, waits for the callback to be called
688(by calling C<schedule> to go to sleep) and returns the arguments
689originally passed to the callback.
690
691Using these functions, it becomes easy to write the C<wait_for_child>
692function mentioned above:
693
694 sub wait_for_child($) {
695 my ($pid) = @_;
696
697 my $watcher = AnyEvent->child (pid => $pid, cb => Coro::rouse_cb);
698
699 my ($rpid, $rstatus) = Coro::rouse_wait;
700 $rstatus
701 }
702
703In the case where C<rouse_cb> and C<rouse_wait> are not flexible enough,
704you can roll your own, using C<schedule>:
705
706 sub wait_for_child($) {
707 my ($pid) = @_;
708
709 # store the current coroutine in $current,
710 # and provide result variables for the closure passed to ->child
711 my $current = $Coro::current;
712 my ($done, $rstatus);
713
714 # pass a closure to ->child
715 my $watcher = AnyEvent->child (pid => $pid, cb => sub {
716 $rstatus = $_[1]; # remember rstatus
717 $done = 1; # mark $rstatus as valud
718 });
719
720 # wait until the closure has been called
721 schedule while !$done;
722
723 $rstatus
724 }
725
726
571=head1 BUGS/LIMITATIONS 727=head1 BUGS/LIMITATIONS
572 728
573 - you must make very sure that no coro is still active on global 729=over 4
574 destruction. very bad things might happen otherwise (usually segfaults).
575 730
731=item fork with pthread backend
732
733When Coro is compiled using the pthread backend (which isn't recommended
734but required on many BSDs as their libcs are completely broken), then
735coroutines will not survive a fork. There is no known workaround except to
736fix your libc and use a saner backend.
737
738=item perl process emulation ("threads")
739
576 - this module is not thread-safe. You should only ever use this module 740This module is not perl-pseudo-thread-safe. You should only ever use this
577 from the same thread (this requirement might be loosened in the future 741module from the same thread (this requirement might be removed in the
578 to allow per-thread schedulers, but Coro::State does not yet allow 742future to allow per-thread schedulers, but Coro::State does not yet allow
579 this). 743this). I recommend disabling thread support and using processes, as having
744the windows process emulation enabled under unix roughly halves perl
745performance, even when not used.
746
747=item coroutine switching not signal safe
748
749You must not switch to another coroutine from within a signal handler
750(only relevant with %SIG - most event libraries provide safe signals).
751
752That means you I<MUST NOT> call any function that might "block" the
753current coroutine - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
754anything that calls those. Everything else, including calling C<ready>,
755works.
756
757=back
758
580 759
581=head1 SEE ALSO 760=head1 SEE ALSO
582 761
583Lower level Configuration, Coroutine Environment: L<Coro::State>. 762Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
584 763
585Debugging: L<Coro::Debug>. 764Debugging: L<Coro::Debug>.
586 765
587Support/Utility: L<Coro::Specific>, L<Coro::Util>. 766Support/Utility: L<Coro::Specific>, L<Coro::Util>.
588 767
589Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. 768Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
590 769
591Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>. 770IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
592 771
593Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>. 772Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>.
594 773
595Embedding: L<Coro::MakeMaker>. 774XS API: L<Coro::MakeMaker>.
775
776Low level Configuration, Coroutine Environment: L<Coro::State>.
596 777
597=head1 AUTHOR 778=head1 AUTHOR
598 779
599 Marc Lehmann <schmorp@schmorp.de> 780 Marc Lehmann <schmorp@schmorp.de>
600 http://home.schmorp.de/ 781 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines