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