… | |
… | |
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 | |
… | |
… | |
43 | our $main; # main coroutine |
43 | our $main; # main coroutine |
44 | our $current; # current coroutine |
44 | our $current; # current coroutine |
45 | |
45 | |
46 | our $VERSION = '3.0'; |
46 | our $VERSION = '3.0'; |
47 | |
47 | |
48 | our @EXPORT = qw(async cede schedule terminate current); |
48 | our @EXPORT = qw(async cede schedule terminate current unblock_sub); |
49 | our %EXPORT_TAGS = ( |
49 | our %EXPORT_TAGS = ( |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
51 | ); |
51 | ); |
52 | our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
52 | our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
53 | |
53 | |
… | |
… | |
57 | |
57 | |
58 | # this way of handling attributes simply is NOT scalable ;() |
58 | # this way of handling attributes simply is NOT scalable ;() |
59 | sub import { |
59 | sub import { |
60 | no strict 'refs'; |
60 | no strict 'refs'; |
61 | |
61 | |
62 | Coro->export_to_level(1, @_); |
62 | Coro->export_to_level (1, @_); |
63 | |
63 | |
64 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
64 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
65 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
65 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
66 | my ($package, $ref) = (shift, shift); |
66 | my ($package, $ref) = (shift, shift); |
67 | my @attrs; |
67 | my @attrs; |
… | |
… | |
105 | C<Coro::current> function instead. |
105 | C<Coro::current> function instead. |
106 | |
106 | |
107 | =cut |
107 | =cut |
108 | |
108 | |
109 | # maybe some other module used Coro::Specific before... |
109 | # maybe some other module used Coro::Specific before... |
110 | if ($current) { |
|
|
111 | $main->{specific} = $current->{specific}; |
110 | $main->{specific} = $current->{specific} |
112 | } |
111 | if $current; |
113 | |
112 | |
114 | $current = $main; |
113 | _set_current $main; |
115 | |
114 | |
116 | sub current() { $current } |
115 | sub current() { $current } |
117 | |
116 | |
118 | =item $idle |
117 | =item $idle |
119 | |
118 | |
… | |
… | |
149 | my $coro = pop @destroy; |
148 | my $coro = pop @destroy; |
150 | $coro->{status} ||= []; |
149 | $coro->{status} ||= []; |
151 | $_->ready for @{delete $coro->{join} || []}; |
150 | $_->ready for @{delete $coro->{join} || []}; |
152 | |
151 | |
153 | # the next line destroys the coro state, but keeps the |
152 | # the next line destroys the coro state, but keeps the |
154 | # process itself intact (we basically make it a zombie |
153 | # coroutine itself intact (we basically make it a zombie |
155 | # process that always runs the manager thread, so it's possible |
154 | # coroutine that always runs the manager thread, so it's possible |
156 | # to transfer() to this process). |
155 | # to transfer() to this coroutine). |
157 | $coro->_clone_state_from ($manager); |
156 | $coro->_clone_state_from ($manager); |
158 | } |
157 | } |
159 | &schedule; |
158 | &schedule; |
160 | } |
159 | } |
161 | }; |
160 | }; |
… | |
… | |
164 | |
163 | |
165 | =back |
164 | =back |
166 | |
165 | |
167 | =head2 STATIC METHODS |
166 | =head2 STATIC METHODS |
168 | |
167 | |
169 | Static methods are actually functions that operate on the current process only. |
168 | Static methods are actually functions that operate on the current coroutine only. |
170 | |
169 | |
171 | =over 4 |
170 | =over 4 |
172 | |
171 | |
173 | =item async { ... } [@args...] |
172 | =item async { ... } [@args...] |
174 | |
173 | |
175 | Create a new asynchronous process and return it's process object |
174 | Create a new asynchronous coroutine and return it's coroutine object |
176 | (usually unused). When the sub returns the new process is automatically |
175 | (usually unused). When the sub returns the new coroutine is automatically |
177 | terminated. |
176 | terminated. |
178 | |
177 | |
179 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
178 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
180 | |
179 | |
181 | When the coroutine dies, the program will exit, just as in the main |
180 | When the coroutine dies, the program will exit, just as in the main |
… | |
… | |
194 | $pid |
193 | $pid |
195 | } |
194 | } |
196 | |
195 | |
197 | =item schedule |
196 | =item schedule |
198 | |
197 | |
199 | Calls the scheduler. Please note that the current process will not be put |
198 | Calls the scheduler. Please note that the current coroutine will not be put |
200 | into the ready queue, so calling this function usually means you will |
199 | into the ready queue, so calling this function usually means you will |
201 | never be called again unless something else (e.g. an event handler) calls |
200 | never be called again unless something else (e.g. an event handler) calls |
202 | ready. |
201 | ready. |
203 | |
202 | |
204 | The canonical way to wait on external events is this: |
203 | The canonical way to wait on external events is this: |
205 | |
204 | |
206 | { |
205 | { |
207 | # remember current process |
206 | # remember current coroutine |
208 | my $current = $Coro::current; |
207 | my $current = $Coro::current; |
209 | |
208 | |
210 | # register a hypothetical event handler |
209 | # register a hypothetical event handler |
211 | on_event_invoke sub { |
210 | on_event_invoke sub { |
212 | # wake up sleeping coroutine |
211 | # wake up sleeping coroutine |
… | |
… | |
218 | # in case we are woken up for other reasons |
217 | # in case we are woken up for other reasons |
219 | # (current still defined), loop. |
218 | # (current still defined), loop. |
220 | Coro::schedule while $current; |
219 | Coro::schedule while $current; |
221 | } |
220 | } |
222 | |
221 | |
223 | =cut |
|
|
224 | |
|
|
225 | =item cede |
222 | =item cede |
226 | |
223 | |
227 | "Cede" to other processes. This function puts the current process into the |
224 | "Cede" to other coroutines. This function puts the current coroutine into the |
228 | ready queue and calls C<schedule>, which has the effect of giving up the |
225 | ready queue and calls C<schedule>, which has the effect of giving up the |
229 | current "timeslice" to other coroutines of the same or higher priority. |
226 | current "timeslice" to other coroutines of the same or higher priority. |
230 | |
227 | |
231 | =cut |
|
|
232 | |
|
|
233 | =item terminate [arg...] |
228 | =item terminate [arg...] |
234 | |
229 | |
235 | Terminates the current process with the given status values (see L<cancel>). |
230 | Terminates the current coroutine with the given status values (see L<cancel>). |
236 | |
231 | |
237 | =cut |
232 | =cut |
238 | |
233 | |
239 | sub terminate { |
234 | sub terminate { |
240 | $current->cancel (@_); |
235 | $current->cancel (@_); |
… | |
… | |
242 | |
237 | |
243 | =back |
238 | =back |
244 | |
239 | |
245 | # dynamic methods |
240 | # dynamic methods |
246 | |
241 | |
247 | =head2 PROCESS METHODS |
242 | =head2 COROUTINE METHODS |
248 | |
243 | |
249 | These are the methods you can call on process objects. |
244 | These are the methods you can call on coroutine objects. |
250 | |
245 | |
251 | =over 4 |
246 | =over 4 |
252 | |
247 | |
253 | =item new Coro \&sub [, @args...] |
248 | =item new Coro \&sub [, @args...] |
254 | |
249 | |
255 | Create a new process and return it. When the sub returns the process |
250 | Create a new coroutine and return it. When the sub returns the coroutine |
256 | automatically terminates as if C<terminate> with the returned values were |
251 | automatically terminates as if C<terminate> with the returned values were |
257 | called. To make the process run you must first put it into the ready queue |
252 | called. To make the coroutine run you must first put it into the ready queue |
258 | by calling the ready method. |
253 | by calling the ready method. |
259 | |
254 | |
260 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
255 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
261 | |
256 | |
262 | =cut |
257 | =cut |
263 | |
258 | |
264 | sub _new_coro { |
259 | sub _run_coro { |
265 | terminate &{+shift}; |
260 | terminate &{+shift}; |
266 | } |
261 | } |
267 | |
262 | |
268 | sub new { |
263 | sub new { |
269 | my $class = shift; |
264 | my $class = shift; |
270 | |
265 | |
271 | $class->SUPER::new (\&_new_coro, @_) |
266 | $class->SUPER::new (\&_run_coro, @_) |
272 | } |
267 | } |
273 | |
268 | |
274 | =item $success = $process->ready |
269 | =item $success = $coroutine->ready |
275 | |
270 | |
276 | Put the given process into the ready queue (according to it's priority) |
271 | Put the given coroutine into the ready queue (according to it's priority) |
277 | and return true. If the process is already in the ready queue, do nothing |
272 | and return true. If the coroutine is already in the ready queue, do nothing |
278 | and return false. |
273 | and return false. |
279 | |
274 | |
280 | =item $is_ready = $process->is_ready |
275 | =item $is_ready = $coroutine->is_ready |
281 | |
276 | |
282 | Return wether the process is currently the ready queue or not, |
277 | Return wether the coroutine is currently the ready queue or not, |
283 | |
278 | |
284 | =item $process->cancel (arg...) |
279 | =item $coroutine->cancel (arg...) |
285 | |
280 | |
286 | Terminates the given process and makes it return the given arguments as |
281 | Terminates the given coroutine and makes it return the given arguments as |
287 | status (default: the empty list). |
282 | status (default: the empty list). |
288 | |
283 | |
289 | =cut |
284 | =cut |
290 | |
285 | |
291 | sub cancel { |
286 | sub cancel { |
… | |
… | |
294 | push @destroy, $self; |
289 | push @destroy, $self; |
295 | $manager->ready; |
290 | $manager->ready; |
296 | &schedule if $current == $self; |
291 | &schedule if $current == $self; |
297 | } |
292 | } |
298 | |
293 | |
299 | =item $process->join |
294 | =item $coroutine->join |
300 | |
295 | |
301 | Wait until the coroutine terminates and return any values given to the |
296 | Wait until the coroutine terminates and return any values given to the |
302 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
297 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
303 | from multiple processes. |
298 | from multiple coroutine. |
304 | |
299 | |
305 | =cut |
300 | =cut |
306 | |
301 | |
307 | sub join { |
302 | sub join { |
308 | my $self = shift; |
303 | my $self = shift; |
… | |
… | |
311 | &schedule; |
306 | &schedule; |
312 | } |
307 | } |
313 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
308 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
314 | } |
309 | } |
315 | |
310 | |
316 | =item $oldprio = $process->prio ($newprio) |
311 | =item $oldprio = $coroutine->prio ($newprio) |
317 | |
312 | |
318 | Sets (or gets, if the argument is missing) the priority of the |
313 | Sets (or gets, if the argument is missing) the priority of the |
319 | process. Higher priority processes get run before lower priority |
314 | coroutine. Higher priority coroutines get run before lower priority |
320 | processes. Priorities are small signed integers (currently -4 .. +3), |
315 | coroutines. Priorities are small signed integers (currently -4 .. +3), |
321 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
316 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
322 | to get then): |
317 | to get then): |
323 | |
318 | |
324 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
319 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
325 | 3 > 1 > 0 > -1 > -3 > -4 |
320 | 3 > 1 > 0 > -1 > -3 > -4 |
… | |
… | |
328 | current->prio(PRIO_HIGH); |
323 | current->prio(PRIO_HIGH); |
329 | |
324 | |
330 | The idle coroutine ($Coro::idle) always has a lower priority than any |
325 | The idle coroutine ($Coro::idle) always has a lower priority than any |
331 | existing coroutine. |
326 | existing coroutine. |
332 | |
327 | |
333 | Changing the priority of the current process will take effect immediately, |
328 | Changing the priority of the current coroutine will take effect immediately, |
334 | but changing the priority of processes in the ready queue (but not |
329 | but changing the priority of coroutines in the ready queue (but not |
335 | running) will only take effect after the next schedule (of that |
330 | running) will only take effect after the next schedule (of that |
336 | process). This is a bug that will be fixed in some future version. |
331 | coroutine). This is a bug that will be fixed in some future version. |
337 | |
332 | |
338 | =item $newprio = $process->nice ($change) |
333 | =item $newprio = $coroutine->nice ($change) |
339 | |
334 | |
340 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
335 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
341 | higher values mean lower priority, just as in unix). |
336 | higher values mean lower priority, just as in unix). |
342 | |
337 | |
343 | =item $olddesc = $process->desc ($newdesc) |
338 | =item $olddesc = $coroutine->desc ($newdesc) |
344 | |
339 | |
345 | Sets (or gets in case the argument is missing) the description for this |
340 | Sets (or gets in case the argument is missing) the description for this |
346 | process. This is just a free-form string you can associate with a process. |
341 | coroutine. This is just a free-form string you can associate with a coroutine. |
347 | |
342 | |
348 | =cut |
343 | =cut |
349 | |
344 | |
350 | sub desc { |
345 | sub desc { |
351 | my $old = $_[0]{desc}; |
346 | my $old = $_[0]{desc}; |
… | |
… | |
353 | $old; |
348 | $old; |
354 | } |
349 | } |
355 | |
350 | |
356 | =back |
351 | =back |
357 | |
352 | |
|
|
353 | =head2 UTILITY FUNCTIONS |
|
|
354 | |
|
|
355 | =over 4 |
|
|
356 | |
|
|
357 | =item unblock_sub { ... } |
|
|
358 | |
|
|
359 | This utility function takes a BLOCK or code reference and "unblocks" it, |
|
|
360 | returning the new coderef. This means that the new coderef will return |
|
|
361 | immediately without blocking, returning nothing, while the original code |
|
|
362 | ref will be called (with parameters) from within its own coroutine. |
|
|
363 | |
|
|
364 | The reason this fucntion exists is that many event libraries (such as the |
|
|
365 | venerable L<Event|Event> module) are not coroutine-safe (a weaker form |
|
|
366 | of thread-safety). This means you must not block within event callbacks, |
|
|
367 | otherwise you might suffer from crashes or worse. |
|
|
368 | |
|
|
369 | This function allows your callbacks to block by executing them in another |
|
|
370 | coroutine where it is safe to block. One example where blocking is handy |
|
|
371 | is when you use the L<Coro::AIO|Coro::AIO> functions to save results to |
|
|
372 | disk. |
|
|
373 | |
|
|
374 | In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when |
|
|
375 | creating event callbacks that want to block. |
|
|
376 | |
|
|
377 | =cut |
|
|
378 | |
|
|
379 | our @unblock_pool; |
|
|
380 | our @unblock_queue; |
|
|
381 | our $UNBLOCK_POOL_SIZE = 2; |
|
|
382 | |
|
|
383 | sub unblock_handler_ { |
|
|
384 | while () { |
|
|
385 | my ($cb, @arg) = @{ delete $Coro::current->{arg} }; |
|
|
386 | $cb->(@arg); |
|
|
387 | |
|
|
388 | last if @unblock_pool >= $UNBLOCK_POOL_SIZE; |
|
|
389 | push @unblock_pool, $Coro::current; |
|
|
390 | schedule; |
|
|
391 | } |
|
|
392 | } |
|
|
393 | |
|
|
394 | our $unblock_scheduler = async { |
|
|
395 | while () { |
|
|
396 | while (my $cb = pop @unblock_queue) { |
|
|
397 | my $handler = (pop @unblock_pool or new Coro \&unblock_handler_); |
|
|
398 | $handler->{arg} = $cb; |
|
|
399 | $handler->ready; |
|
|
400 | cede; |
|
|
401 | } |
|
|
402 | |
|
|
403 | schedule; |
|
|
404 | } |
|
|
405 | }; |
|
|
406 | |
|
|
407 | sub unblock_sub(&) { |
|
|
408 | my $cb = shift; |
|
|
409 | |
|
|
410 | sub { |
|
|
411 | push @unblock_queue, [$cb, @_]; |
|
|
412 | $unblock_scheduler->ready; |
|
|
413 | } |
|
|
414 | } |
|
|
415 | |
|
|
416 | =back |
|
|
417 | |
358 | =cut |
418 | =cut |
359 | |
419 | |
360 | 1; |
420 | 1; |
361 | |
421 | |
362 | =head1 BUGS/LIMITATIONS |
422 | =head1 BUGS/LIMITATIONS |