… | |
… | |
8 | |
8 | |
9 | async { |
9 | async { |
10 | # some asynchronous thread of execution |
10 | # some asynchronous thread of execution |
11 | }; |
11 | }; |
12 | |
12 | |
13 | # alternatively create an async process like this: |
13 | # alternatively create an async coroutine like this: |
14 | |
14 | |
15 | sub some_func : Coro { |
15 | sub some_func : Coro { |
16 | # some more async code |
16 | # some more async code |
17 | } |
17 | } |
18 | |
18 | |
19 | cede; |
19 | cede; |
20 | |
20 | |
21 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
22 | |
22 | |
23 | This module collection manages coroutines. Coroutines are similar to |
23 | This module collection manages coroutines. Coroutines are similar |
24 | threads but don't run in parallel. |
24 | to threads but don't run in parallel at the same time even on SMP |
|
|
25 | machines. The specific flavor of coroutine used in this module also |
|
|
26 | guarantees you that it will not switch between coroutines unless |
|
|
27 | necessary, at easily-identified points in your program, so locking and |
|
|
28 | parallel access are rarely an issue, making coroutine programming much |
|
|
29 | safer than threads programming. |
25 | |
30 | |
|
|
31 | (Perl, however, does not natively support real threads but instead does a |
|
|
32 | very slow and memory-intensive emulation of processes using threads. This |
|
|
33 | is a performance win on Windows machines, and a loss everywhere else). |
|
|
34 | |
26 | In this module, coroutines are defined as "callchain + lexical variables |
35 | In this module, coroutines are defined as "callchain + lexical variables + |
27 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
36 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
28 | callchain, it's own set of lexicals and it's own set of perl's most |
37 | its own set of lexicals and its own set of perls most important global |
29 | important global variables. |
38 | variables. |
30 | |
39 | |
31 | =cut |
40 | =cut |
32 | |
41 | |
33 | package Coro; |
42 | package Coro; |
34 | |
43 | |
35 | use strict; |
44 | use strict; |
36 | no warnings "uninitialized"; |
45 | no warnings "uninitialized"; |
37 | |
46 | |
38 | use Coro::State; |
47 | use Coro::State; |
39 | |
48 | |
40 | use base Exporter::; |
49 | use base qw(Coro::State Exporter); |
41 | |
50 | |
42 | our $idle; # idle coroutine |
51 | our $idle; # idle handler |
43 | our $main; # main coroutine |
52 | our $main; # main coroutine |
44 | our $current; # current coroutine |
53 | our $current; # current coroutine |
45 | |
54 | |
46 | our $VERSION = '2.1'; |
55 | our $VERSION = '4.0'; |
47 | |
56 | |
48 | our @EXPORT = qw(async cede schedule terminate current); |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
49 | our %EXPORT_TAGS = ( |
58 | our %EXPORT_TAGS = ( |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
59 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
51 | ); |
60 | ); |
52 | our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
61 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
53 | |
62 | |
54 | { |
63 | { |
55 | my @async; |
64 | my @async; |
56 | my $init; |
65 | my $init; |
57 | |
66 | |
58 | # this way of handling attributes simply is NOT scalable ;() |
67 | # this way of handling attributes simply is NOT scalable ;() |
59 | sub import { |
68 | sub import { |
60 | no strict 'refs'; |
69 | no strict 'refs'; |
61 | |
70 | |
62 | Coro->export_to_level(1, @_); |
71 | Coro->export_to_level (1, @_); |
63 | |
72 | |
64 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
73 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
65 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
74 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
66 | my ($package, $ref) = (shift, shift); |
75 | my ($package, $ref) = (shift, shift); |
67 | my @attrs; |
76 | my @attrs; |
… | |
… | |
95 | |
104 | |
96 | $main = new Coro; |
105 | $main = new Coro; |
97 | |
106 | |
98 | =item $current (or as function: current) |
107 | =item $current (or as function: current) |
99 | |
108 | |
100 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
109 | The current coroutine (the last coroutine switched to). The initial value |
|
|
110 | is C<$main> (of course). |
101 | |
111 | |
|
|
112 | This variable is B<strictly> I<read-only>. It is provided for performance |
|
|
113 | reasons. If performance is not essential you are encouraged to use the |
|
|
114 | C<Coro::current> function instead. |
|
|
115 | |
102 | =cut |
116 | =cut |
|
|
117 | |
|
|
118 | $main->{desc} = "[main::]"; |
103 | |
119 | |
104 | # maybe some other module used Coro::Specific before... |
120 | # maybe some other module used Coro::Specific before... |
105 | if ($current) { |
|
|
106 | $main->{specific} = $current->{specific}; |
121 | $main->{_specific} = $current->{_specific} |
107 | } |
122 | if $current; |
108 | |
123 | |
109 | $current = $main; |
124 | _set_current $main; |
110 | |
125 | |
111 | sub current() { $current } |
126 | sub current() { $current } |
112 | |
127 | |
113 | =item $idle |
128 | =item $idle |
114 | |
129 | |
115 | The coroutine to switch to when no other coroutine is running. The default |
130 | A callback that is called whenever the scheduler finds no ready coroutines |
116 | implementation prints "FATAL: deadlock detected" and exits. |
131 | to run. The default implementation prints "FATAL: deadlock detected" and |
|
|
132 | exits, because the program has no other way to continue. |
117 | |
133 | |
118 | =cut |
134 | This hook is overwritten by modules such as C<Coro::Timer> and |
|
|
135 | C<Coro::Event> to wait on an external event that hopefully wake up a |
|
|
136 | coroutine so the scheduler can run it. |
119 | |
137 | |
120 | # should be done using priorities :( |
138 | Please note that if your callback recursively invokes perl (e.g. for event |
121 | $idle = new Coro sub { |
139 | handlers), then it must be prepared to be called recursively. |
122 | print STDERR "FATAL: deadlock detected\n"; |
140 | |
123 | exit(51); |
141 | =cut |
|
|
142 | |
|
|
143 | $idle = sub { |
|
|
144 | require Carp; |
|
|
145 | Carp::croak ("FATAL: deadlock detected"); |
124 | }; |
146 | }; |
|
|
147 | |
|
|
148 | sub _cancel { |
|
|
149 | my ($self) = @_; |
|
|
150 | |
|
|
151 | # free coroutine data and mark as destructed |
|
|
152 | $self->_destroy |
|
|
153 | or return; |
|
|
154 | |
|
|
155 | # call all destruction callbacks |
|
|
156 | $_->(@{$self->{_status}}) |
|
|
157 | for @{(delete $self->{_on_destroy}) || []}; |
|
|
158 | } |
125 | |
159 | |
126 | # this coroutine is necessary because a coroutine |
160 | # this coroutine is necessary because a coroutine |
127 | # cannot destroy itself. |
161 | # cannot destroy itself. |
128 | my @destroy; |
162 | my @destroy; |
129 | my $manager; |
163 | my $manager; |
|
|
164 | |
130 | $manager = new Coro sub { |
165 | $manager = new Coro sub { |
131 | while () { |
166 | while () { |
132 | # by overwriting the state object with the manager we destroy it |
167 | (shift @destroy)->_cancel |
133 | # while still being able to schedule this coroutine (in case it has |
|
|
134 | # been readied multiple times. this is harmless since the manager |
|
|
135 | # can be called as many times as neccessary and will always |
|
|
136 | # remove itself from the runqueue |
|
|
137 | while (@destroy) { |
168 | while @destroy; |
138 | my $coro = pop @destroy; |
|
|
139 | $coro->{status} ||= []; |
|
|
140 | $_->ready for @{delete $coro->{join} || []}; |
|
|
141 | |
169 | |
142 | # the next line destroys the _coro_state, but keeps the |
|
|
143 | # process itself intact (we basically make it a zombie |
|
|
144 | # process that always runs the manager thread, so it's possible |
|
|
145 | # to transfer() to this process). |
|
|
146 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
147 | } |
|
|
148 | &schedule; |
170 | &schedule; |
149 | } |
171 | } |
150 | }; |
172 | }; |
|
|
173 | $manager->desc ("[coro manager]"); |
|
|
174 | $manager->prio (PRIO_MAX); |
151 | |
175 | |
152 | # static methods. not really. |
176 | # static methods. not really. |
153 | |
177 | |
154 | =back |
178 | =back |
155 | |
179 | |
156 | =head2 STATIC METHODS |
180 | =head2 STATIC METHODS |
157 | |
181 | |
158 | Static methods are actually functions that operate on the current process only. |
182 | Static methods are actually functions that operate on the current coroutine only. |
159 | |
183 | |
160 | =over 4 |
184 | =over 4 |
161 | |
185 | |
162 | =item async { ... } [@args...] |
186 | =item async { ... } [@args...] |
163 | |
187 | |
164 | Create a new asynchronous process and return it's process object |
188 | Create a new asynchronous coroutine and return it's coroutine object |
165 | (usually unused). When the sub returns the new process is automatically |
189 | (usually unused). When the sub returns the new coroutine is automatically |
166 | terminated. |
190 | terminated. |
|
|
191 | |
|
|
192 | Calling C<exit> in a coroutine will do the same as calling exit outside |
|
|
193 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
|
|
194 | just as it would in the main program. |
167 | |
195 | |
168 | # create a new coroutine that just prints its arguments |
196 | # create a new coroutine that just prints its arguments |
169 | async { |
197 | async { |
170 | print "@_\n"; |
198 | print "@_\n"; |
171 | } 1,2,3,4; |
199 | } 1,2,3,4; |
172 | |
200 | |
173 | =cut |
201 | =cut |
174 | |
202 | |
175 | sub async(&@) { |
203 | sub async(&@) { |
176 | my $pid = new Coro @_; |
204 | my $coro = new Coro @_; |
177 | $manager->ready; # this ensures that the stack is cloned from the manager |
|
|
178 | $pid->ready; |
205 | $coro->ready; |
179 | $pid; |
206 | $coro |
|
|
207 | } |
|
|
208 | |
|
|
209 | =item async_pool { ... } [@args...] |
|
|
210 | |
|
|
211 | Similar to C<async>, but uses a coroutine pool, so you should not call |
|
|
212 | terminate or join (although you are allowed to), and you get a coroutine |
|
|
213 | that might have executed other code already (which can be good or bad :). |
|
|
214 | |
|
|
215 | Also, the block is executed in an C<eval> context and a warning will be |
|
|
216 | issued in case of an exception instead of terminating the program, as |
|
|
217 | C<async> does. As the coroutine is being reused, stuff like C<on_destroy> |
|
|
218 | will not work in the expected way, unless you call terminate or cancel, |
|
|
219 | which somehow defeats the purpose of pooling. |
|
|
220 | |
|
|
221 | The priority will be reset to C<0> after each job, otherwise the coroutine |
|
|
222 | will be re-used "as-is". |
|
|
223 | |
|
|
224 | The pool size is limited to 8 idle coroutines (this can be adjusted by |
|
|
225 | changing $Coro::POOL_SIZE), and there can be as many non-idle coros as |
|
|
226 | required. |
|
|
227 | |
|
|
228 | If you are concerned about pooled coroutines growing a lot because a |
|
|
229 | single C<async_pool> used a lot of stackspace you can e.g. C<async_pool |
|
|
230 | { terminate }> once per second or so to slowly replenish the pool. In |
|
|
231 | addition to that, when the stacks used by a handler grows larger than 16kb |
|
|
232 | (adjustable with $Coro::POOL_RSS) it will also exit. |
|
|
233 | |
|
|
234 | =cut |
|
|
235 | |
|
|
236 | our $POOL_SIZE = 8; |
|
|
237 | our $POOL_RSS = 16 * 1024; |
|
|
238 | our @async_pool; |
|
|
239 | |
|
|
240 | sub pool_handler { |
|
|
241 | my $cb; |
|
|
242 | |
|
|
243 | while () { |
|
|
244 | eval { |
|
|
245 | while () { |
|
|
246 | _pool_1 $cb; |
|
|
247 | &$cb; |
|
|
248 | _pool_2 $cb; |
|
|
249 | &schedule; |
|
|
250 | } |
|
|
251 | }; |
|
|
252 | |
|
|
253 | last if $@ eq "\3terminate\2\n"; |
|
|
254 | warn $@ if $@; |
|
|
255 | } |
|
|
256 | } |
|
|
257 | |
|
|
258 | sub async_pool(&@) { |
|
|
259 | # this is also inlined into the unlock_scheduler |
|
|
260 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
261 | |
|
|
262 | $coro->{_invoke} = [@_]; |
|
|
263 | $coro->ready; |
|
|
264 | |
|
|
265 | $coro |
180 | } |
266 | } |
181 | |
267 | |
182 | =item schedule |
268 | =item schedule |
183 | |
269 | |
184 | Calls the scheduler. Please note that the current process will not be put |
270 | Calls the scheduler. Please note that the current coroutine will not be put |
185 | into the ready queue, so calling this function usually means you will |
271 | into the ready queue, so calling this function usually means you will |
186 | never be called again. |
272 | never be called again unless something else (e.g. an event handler) calls |
|
|
273 | ready. |
187 | |
274 | |
188 | =cut |
275 | The canonical way to wait on external events is this: |
|
|
276 | |
|
|
277 | { |
|
|
278 | # remember current coroutine |
|
|
279 | my $current = $Coro::current; |
|
|
280 | |
|
|
281 | # register a hypothetical event handler |
|
|
282 | on_event_invoke sub { |
|
|
283 | # wake up sleeping coroutine |
|
|
284 | $current->ready; |
|
|
285 | undef $current; |
|
|
286 | }; |
|
|
287 | |
|
|
288 | # call schedule until event occurred. |
|
|
289 | # in case we are woken up for other reasons |
|
|
290 | # (current still defined), loop. |
|
|
291 | Coro::schedule while $current; |
|
|
292 | } |
189 | |
293 | |
190 | =item cede |
294 | =item cede |
191 | |
295 | |
192 | "Cede" to other processes. This function puts the current process into the |
296 | "Cede" to other coroutines. This function puts the current coroutine into the |
193 | ready queue and calls C<schedule>, which has the effect of giving up the |
297 | ready queue and calls C<schedule>, which has the effect of giving up the |
194 | current "timeslice" to other coroutines of the same or higher priority. |
298 | current "timeslice" to other coroutines of the same or higher priority. |
195 | |
299 | |
196 | =cut |
300 | Returns true if at least one coroutine switch has happened. |
|
|
301 | |
|
|
302 | =item Coro::cede_notself |
|
|
303 | |
|
|
304 | Works like cede, but is not exported by default and will cede to any |
|
|
305 | coroutine, regardless of priority, once. |
|
|
306 | |
|
|
307 | Returns true if at least one coroutine switch has happened. |
197 | |
308 | |
198 | =item terminate [arg...] |
309 | =item terminate [arg...] |
199 | |
310 | |
200 | Terminates the current process with the given status values (see L<cancel>). |
311 | Terminates the current coroutine with the given status values (see L<cancel>). |
|
|
312 | |
|
|
313 | =item killall |
|
|
314 | |
|
|
315 | Kills/terminates/cancels all coroutines except the currently running |
|
|
316 | one. This is useful after a fork, either in the child or the parent, as |
|
|
317 | usually only one of them should inherit the running coroutines. |
201 | |
318 | |
202 | =cut |
319 | =cut |
203 | |
320 | |
204 | sub terminate { |
321 | sub terminate { |
205 | $current->cancel (@_); |
322 | $current->cancel (@_); |
206 | } |
323 | } |
207 | |
324 | |
|
|
325 | sub killall { |
|
|
326 | for (Coro::State::list) { |
|
|
327 | $_->cancel |
|
|
328 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
|
|
329 | } |
|
|
330 | } |
|
|
331 | |
208 | =back |
332 | =back |
209 | |
333 | |
210 | # dynamic methods |
334 | # dynamic methods |
211 | |
335 | |
212 | =head2 PROCESS METHODS |
336 | =head2 COROUTINE METHODS |
213 | |
337 | |
214 | These are the methods you can call on process objects. |
338 | These are the methods you can call on coroutine objects. |
215 | |
339 | |
216 | =over 4 |
340 | =over 4 |
217 | |
341 | |
218 | =item new Coro \&sub [, @args...] |
342 | =item new Coro \&sub [, @args...] |
219 | |
343 | |
220 | Create a new process and return it. When the sub returns the process |
344 | Create a new coroutine and return it. When the sub returns the coroutine |
221 | automatically terminates as if C<terminate> with the returned values were |
345 | automatically terminates as if C<terminate> with the returned values were |
222 | called. To make the process run you must first put it into the ready queue |
346 | called. To make the coroutine run you must first put it into the ready queue |
223 | by calling the ready method. |
347 | by calling the ready method. |
224 | |
348 | |
225 | =cut |
349 | See C<async> for additional discussion. |
226 | |
350 | |
|
|
351 | =cut |
|
|
352 | |
227 | sub _newcoro { |
353 | sub _run_coro { |
228 | terminate &{+shift}; |
354 | terminate &{+shift}; |
229 | } |
355 | } |
230 | |
356 | |
231 | sub new { |
357 | sub new { |
232 | my $class = shift; |
358 | my $class = shift; |
233 | bless { |
|
|
234 | _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
|
|
235 | }, $class; |
|
|
236 | } |
|
|
237 | |
359 | |
238 | =item $process->ready |
360 | $class->SUPER::new (\&_run_coro, @_) |
|
|
361 | } |
239 | |
362 | |
240 | Put the given process into the ready queue. |
363 | =item $success = $coroutine->ready |
241 | |
364 | |
242 | =cut |
365 | Put the given coroutine into the ready queue (according to it's priority) |
|
|
366 | and return true. If the coroutine is already in the ready queue, do nothing |
|
|
367 | and return false. |
243 | |
368 | |
|
|
369 | =item $is_ready = $coroutine->is_ready |
|
|
370 | |
|
|
371 | Return wether the coroutine is currently the ready queue or not, |
|
|
372 | |
244 | =item $process->cancel (arg...) |
373 | =item $coroutine->cancel (arg...) |
245 | |
374 | |
246 | Temrinates the given process and makes it return the given arguments as |
375 | Terminates the given coroutine and makes it return the given arguments as |
247 | status (default: the empty list). |
376 | status (default: the empty list). Never returns if the coroutine is the |
|
|
377 | current coroutine. |
248 | |
378 | |
249 | =cut |
379 | =cut |
250 | |
380 | |
251 | sub cancel { |
381 | sub cancel { |
252 | my $self = shift; |
382 | my $self = shift; |
253 | $self->{status} = [@_]; |
383 | $self->{_status} = [@_]; |
|
|
384 | |
|
|
385 | if ($current == $self) { |
254 | push @destroy, $self; |
386 | push @destroy, $self; |
255 | $manager->ready; |
387 | $manager->ready; |
256 | &schedule if $current == $self; |
388 | &schedule while 1; |
|
|
389 | } else { |
|
|
390 | $self->_cancel; |
|
|
391 | } |
257 | } |
392 | } |
258 | |
393 | |
259 | =item $process->join |
394 | =item $coroutine->join |
260 | |
395 | |
261 | Wait until the coroutine terminates and return any values given to the |
396 | Wait until the coroutine terminates and return any values given to the |
262 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
397 | C<terminate> or C<cancel> functions. C<join> can be called concurrently |
263 | from multiple processes. |
398 | from multiple coroutines. |
264 | |
399 | |
265 | =cut |
400 | =cut |
266 | |
401 | |
267 | sub join { |
402 | sub join { |
268 | my $self = shift; |
403 | my $self = shift; |
|
|
404 | |
269 | unless ($self->{status}) { |
405 | unless ($self->{_status}) { |
270 | push @{$self->{join}}, $current; |
406 | my $current = $current; |
271 | &schedule; |
407 | |
|
|
408 | push @{$self->{_on_destroy}}, sub { |
|
|
409 | $current->ready; |
|
|
410 | undef $current; |
|
|
411 | }; |
|
|
412 | |
|
|
413 | &schedule while $current; |
272 | } |
414 | } |
|
|
415 | |
273 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
416 | wantarray ? @{$self->{_status}} : $self->{_status}[0]; |
274 | } |
417 | } |
275 | |
418 | |
|
|
419 | =item $coroutine->on_destroy (\&cb) |
|
|
420 | |
|
|
421 | Registers a callback that is called when this coroutine gets destroyed, |
|
|
422 | but before it is joined. The callback gets passed the terminate arguments, |
|
|
423 | if any. |
|
|
424 | |
|
|
425 | =cut |
|
|
426 | |
|
|
427 | sub on_destroy { |
|
|
428 | my ($self, $cb) = @_; |
|
|
429 | |
|
|
430 | push @{ $self->{_on_destroy} }, $cb; |
|
|
431 | } |
|
|
432 | |
276 | =item $oldprio = $process->prio($newprio) |
433 | =item $oldprio = $coroutine->prio ($newprio) |
277 | |
434 | |
278 | Sets (or gets, if the argument is missing) the priority of the |
435 | Sets (or gets, if the argument is missing) the priority of the |
279 | process. Higher priority processes get run before lower priority |
436 | coroutine. Higher priority coroutines get run before lower priority |
280 | processes. Priorities are small signed integers (currently -4 .. +3), |
437 | coroutines. Priorities are small signed integers (currently -4 .. +3), |
281 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
438 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
282 | to get then): |
439 | to get then): |
283 | |
440 | |
284 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
441 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
285 | 3 > 1 > 0 > -1 > -3 > -4 |
442 | 3 > 1 > 0 > -1 > -3 > -4 |
… | |
… | |
288 | current->prio(PRIO_HIGH); |
445 | current->prio(PRIO_HIGH); |
289 | |
446 | |
290 | The idle coroutine ($Coro::idle) always has a lower priority than any |
447 | The idle coroutine ($Coro::idle) always has a lower priority than any |
291 | existing coroutine. |
448 | existing coroutine. |
292 | |
449 | |
293 | Changing the priority of the current process will take effect immediately, |
450 | Changing the priority of the current coroutine will take effect immediately, |
294 | but changing the priority of processes in the ready queue (but not |
451 | but changing the priority of coroutines in the ready queue (but not |
295 | running) will only take effect after the next schedule (of that |
452 | running) will only take effect after the next schedule (of that |
296 | process). This is a bug that will be fixed in some future version. |
453 | coroutine). This is a bug that will be fixed in some future version. |
297 | |
454 | |
298 | =cut |
|
|
299 | |
|
|
300 | sub prio { |
|
|
301 | my $old = $_[0]{prio}; |
|
|
302 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
303 | $old; |
|
|
304 | } |
|
|
305 | |
|
|
306 | =item $newprio = $process->nice($change) |
455 | =item $newprio = $coroutine->nice ($change) |
307 | |
456 | |
308 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
457 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
309 | higher values mean lower priority, just as in unix). |
458 | higher values mean lower priority, just as in unix). |
310 | |
459 | |
311 | =cut |
|
|
312 | |
|
|
313 | sub nice { |
|
|
314 | $_[0]{prio} -= $_[1]; |
|
|
315 | } |
|
|
316 | |
|
|
317 | =item $olddesc = $process->desc($newdesc) |
460 | =item $olddesc = $coroutine->desc ($newdesc) |
318 | |
461 | |
319 | Sets (or gets in case the argument is missing) the description for this |
462 | Sets (or gets in case the argument is missing) the description for this |
320 | process. This is just a free-form string you can associate with a process. |
463 | coroutine. This is just a free-form string you can associate with a coroutine. |
|
|
464 | |
|
|
465 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
|
|
466 | can modify this member directly if you wish. |
321 | |
467 | |
322 | =cut |
468 | =cut |
323 | |
469 | |
324 | sub desc { |
470 | sub desc { |
325 | my $old = $_[0]{desc}; |
471 | my $old = $_[0]{desc}; |
… | |
… | |
327 | $old; |
473 | $old; |
328 | } |
474 | } |
329 | |
475 | |
330 | =back |
476 | =back |
331 | |
477 | |
|
|
478 | =head2 GLOBAL FUNCTIONS |
|
|
479 | |
|
|
480 | =over 4 |
|
|
481 | |
|
|
482 | =item Coro::nready |
|
|
483 | |
|
|
484 | Returns the number of coroutines that are currently in the ready state, |
|
|
485 | i.e. that can be switched to. The value C<0> means that the only runnable |
|
|
486 | coroutine is the currently running one, so C<cede> would have no effect, |
|
|
487 | and C<schedule> would cause a deadlock unless there is an idle handler |
|
|
488 | that wakes up some coroutines. |
|
|
489 | |
|
|
490 | =item my $guard = Coro::guard { ... } |
|
|
491 | |
|
|
492 | This creates and returns a guard object. Nothing happens until the object |
|
|
493 | gets destroyed, in which case the codeblock given as argument will be |
|
|
494 | executed. This is useful to free locks or other resources in case of a |
|
|
495 | runtime error or when the coroutine gets canceled, as in both cases the |
|
|
496 | guard block will be executed. The guard object supports only one method, |
|
|
497 | C<< ->cancel >>, which will keep the codeblock from being executed. |
|
|
498 | |
|
|
499 | Example: set some flag and clear it again when the coroutine gets canceled |
|
|
500 | or the function returns: |
|
|
501 | |
|
|
502 | sub do_something { |
|
|
503 | my $guard = Coro::guard { $busy = 0 }; |
|
|
504 | $busy = 1; |
|
|
505 | |
|
|
506 | # do something that requires $busy to be true |
|
|
507 | } |
|
|
508 | |
|
|
509 | =cut |
|
|
510 | |
|
|
511 | sub guard(&) { |
|
|
512 | bless \(my $cb = $_[0]), "Coro::guard" |
|
|
513 | } |
|
|
514 | |
|
|
515 | sub Coro::guard::cancel { |
|
|
516 | ${$_[0]} = sub { }; |
|
|
517 | } |
|
|
518 | |
|
|
519 | sub Coro::guard::DESTROY { |
|
|
520 | ${$_[0]}->(); |
|
|
521 | } |
|
|
522 | |
|
|
523 | |
|
|
524 | =item unblock_sub { ... } |
|
|
525 | |
|
|
526 | This utility function takes a BLOCK or code reference and "unblocks" it, |
|
|
527 | returning the new coderef. This means that the new coderef will return |
|
|
528 | immediately without blocking, returning nothing, while the original code |
|
|
529 | ref will be called (with parameters) from within its own coroutine. |
|
|
530 | |
|
|
531 | The reason this function exists is that many event libraries (such as the |
|
|
532 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
|
|
533 | of thread-safety). This means you must not block within event callbacks, |
|
|
534 | otherwise you might suffer from crashes or worse. |
|
|
535 | |
|
|
536 | This function allows your callbacks to block by executing them in another |
|
|
537 | coroutine where it is safe to block. One example where blocking is handy |
|
|
538 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
|
|
539 | disk. |
|
|
540 | |
|
|
541 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
|
|
542 | creating event callbacks that want to block. |
|
|
543 | |
|
|
544 | =cut |
|
|
545 | |
|
|
546 | our @unblock_queue; |
|
|
547 | |
|
|
548 | # we create a special coro because we want to cede, |
|
|
549 | # to reduce pressure on the coro pool (because most callbacks |
|
|
550 | # return immediately and can be reused) and because we cannot cede |
|
|
551 | # inside an event callback. |
|
|
552 | our $unblock_scheduler = new Coro sub { |
|
|
553 | while () { |
|
|
554 | while (my $cb = pop @unblock_queue) { |
|
|
555 | # this is an inlined copy of async_pool |
|
|
556 | my $coro = (pop @async_pool) || new Coro \&pool_handler; |
|
|
557 | |
|
|
558 | $coro->{_invoke} = $cb; |
|
|
559 | $coro->ready; |
|
|
560 | cede; # for short-lived callbacks, this reduces pressure on the coro pool |
|
|
561 | } |
|
|
562 | schedule; # sleep well |
|
|
563 | } |
|
|
564 | }; |
|
|
565 | $unblock_scheduler->desc ("[unblock_sub scheduler]"); |
|
|
566 | |
|
|
567 | sub unblock_sub(&) { |
|
|
568 | my $cb = shift; |
|
|
569 | |
|
|
570 | sub { |
|
|
571 | unshift @unblock_queue, [$cb, @_]; |
|
|
572 | $unblock_scheduler->ready; |
|
|
573 | } |
|
|
574 | } |
|
|
575 | |
|
|
576 | =back |
|
|
577 | |
332 | =cut |
578 | =cut |
333 | |
579 | |
334 | 1; |
580 | 1; |
335 | |
581 | |
336 | =head1 BUGS/LIMITATIONS |
582 | =head1 BUGS/LIMITATIONS |
337 | |
583 | |
338 | - you must make very sure that no coro is still active on global |
584 | - you must make very sure that no coro is still active on global |
339 | destruction. very bad things might happen otherwise (usually segfaults). |
585 | destruction. very bad things might happen otherwise (usually segfaults). |
340 | |
586 | |
341 | - this module is not thread-safe. You should only ever use this module |
587 | - this module is not thread-safe. You should only ever use this module |
342 | from the same thread (this requirement might be losened in the future |
588 | from the same thread (this requirement might be loosened in the future |
343 | to allow per-thread schedulers, but Coro::State does not yet allow |
589 | to allow per-thread schedulers, but Coro::State does not yet allow |
344 | this). |
590 | this). |
345 | |
591 | |
346 | =head1 SEE ALSO |
592 | =head1 SEE ALSO |
347 | |
593 | |