… | |
… | |
2 | |
2 | |
3 | Coro - coroutine process abstraction |
3 | Coro - coroutine process abstraction |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
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 | }; |
12 | |
15 | print "1\n"; |
13 | # alternatively create an async coroutine like this: |
16 | cede; # yield to coroutine |
14 | |
17 | print "3\n"; |
15 | sub some_func : Coro { |
18 | cede; # and again |
16 | # some more async code |
19 | |
17 | } |
20 | # use locking |
18 | |
21 | my $lock = new Coro::Semaphore; |
19 | cede; |
22 | my $locked; |
|
|
23 | |
|
|
24 | $lock->down; |
|
|
25 | $locked = 1; |
|
|
26 | $lock->up; |
20 | |
27 | |
21 | =head1 DESCRIPTION |
28 | =head1 DESCRIPTION |
22 | |
29 | |
23 | This module collection manages coroutines. Coroutines are similar |
30 | This module collection manages coroutines. Coroutines are similar |
24 | to threads but don't run in parallel at the same time even on SMP |
31 | to threads but don't run in parallel at the same time even on SMP |
… | |
… | |
33 | is a performance win on Windows machines, and a loss everywhere else). |
40 | is a performance win on Windows machines, and a loss everywhere else). |
34 | |
41 | |
35 | In this module, coroutines are defined as "callchain + lexical variables + |
42 | In this module, coroutines are defined as "callchain + lexical variables + |
36 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
43 | @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain, |
37 | its own set of lexicals and its own set of perls most important global |
44 | its own set of lexicals and its own set of perls most important global |
38 | variables. |
45 | variables (see L<Coro::State> for more configuration). |
39 | |
46 | |
40 | =cut |
47 | =cut |
41 | |
48 | |
42 | package Coro; |
49 | package Coro; |
43 | |
50 | |
… | |
… | |
50 | |
57 | |
51 | our $idle; # idle handler |
58 | our $idle; # idle handler |
52 | our $main; # main coroutine |
59 | our $main; # main coroutine |
53 | our $current; # current coroutine |
60 | our $current; # current coroutine |
54 | |
61 | |
55 | our $VERSION = '4.01'; |
62 | our $VERSION = '4.51'; |
56 | |
63 | |
57 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
64 | our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub); |
58 | our %EXPORT_TAGS = ( |
65 | our %EXPORT_TAGS = ( |
59 | 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)], |
60 | ); |
67 | ); |
61 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
68 | our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready)); |
62 | |
69 | |
63 | { |
|
|
64 | my @async; |
|
|
65 | my $init; |
|
|
66 | |
|
|
67 | # this way of handling attributes simply is NOT scalable ;() |
|
|
68 | sub import { |
|
|
69 | no strict 'refs'; |
|
|
70 | |
|
|
71 | Coro->export_to_level (1, @_); |
|
|
72 | |
|
|
73 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
|
|
74 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
|
|
75 | my ($package, $ref) = (shift, shift); |
|
|
76 | my @attrs; |
|
|
77 | for (@_) { |
|
|
78 | if ($_ eq "Coro") { |
|
|
79 | push @async, $ref; |
|
|
80 | unless ($init++) { |
|
|
81 | eval q{ |
|
|
82 | sub INIT { |
|
|
83 | &async(pop @async) while @async; |
|
|
84 | } |
|
|
85 | }; |
|
|
86 | } |
|
|
87 | } else { |
|
|
88 | push @attrs, $_; |
|
|
89 | } |
|
|
90 | } |
|
|
91 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
|
|
92 | }; |
|
|
93 | } |
|
|
94 | |
|
|
95 | } |
|
|
96 | |
|
|
97 | =over 4 |
70 | =over 4 |
98 | |
71 | |
99 | =item $main |
72 | =item $main |
100 | |
73 | |
101 | This coroutine represents the main program. |
74 | This coroutine represents the main program. |
… | |
… | |
134 | This hook is overwritten by modules such as C<Coro::Timer> and |
107 | 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 |
108 | C<Coro::Event> to wait on an external event that hopefully wake up a |
136 | coroutine so the scheduler can run it. |
109 | coroutine so the scheduler can run it. |
137 | |
110 | |
138 | Please note that if your callback recursively invokes perl (e.g. for event |
111 | Please note that if your callback recursively invokes perl (e.g. for event |
139 | handlers), then it must be prepared to be called recursively. |
112 | handlers), then it must be prepared to be called recursively itself. |
140 | |
113 | |
141 | =cut |
114 | =cut |
142 | |
115 | |
143 | $idle = sub { |
116 | $idle = sub { |
144 | require Carp; |
117 | require Carp; |
… | |
… | |
171 | } |
144 | } |
172 | }; |
145 | }; |
173 | $manager->desc ("[coro manager]"); |
146 | $manager->desc ("[coro manager]"); |
174 | $manager->prio (PRIO_MAX); |
147 | $manager->prio (PRIO_MAX); |
175 | |
148 | |
176 | # static methods. not really. |
|
|
177 | |
|
|
178 | =back |
149 | =back |
179 | |
150 | |
180 | =head2 STATIC METHODS |
151 | =head2 STATIC METHODS |
181 | |
152 | |
182 | Static methods are actually functions that operate on the current coroutine only. |
153 | Static methods are actually functions that operate on the current coroutine only. |
… | |
… | |
188 | Create a new asynchronous coroutine and return it's coroutine object |
159 | Create a new asynchronous coroutine and return it's coroutine object |
189 | (usually unused). When the sub returns the new coroutine is automatically |
160 | (usually unused). When the sub returns the new coroutine is automatically |
190 | terminated. |
161 | terminated. |
191 | |
162 | |
192 | See the C<Coro::State::new> constructor for info about the coroutine |
163 | See the C<Coro::State::new> constructor for info about the coroutine |
193 | environment. |
164 | environment in which coroutines run. |
194 | |
165 | |
195 | Calling C<exit> in a coroutine will do the same as calling exit outside |
166 | Calling C<exit> in a coroutine will do the same as calling exit outside |
196 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
167 | the coroutine. Likewise, when the coroutine dies, the program will exit, |
197 | just as it would in the main program. |
168 | just as it would in the main program. |
198 | |
169 | |
… | |
… | |
255 | _pool_2 $cb; |
226 | _pool_2 $cb; |
256 | &schedule; |
227 | &schedule; |
257 | } |
228 | } |
258 | }; |
229 | }; |
259 | |
230 | |
260 | last if $@ eq "\3terminate\2\n"; |
231 | last if $@ eq "\3async_pool terminate\2\n"; |
261 | warn $@ if $@; |
232 | warn $@ if $@; |
262 | } |
233 | } |
263 | } |
234 | } |
264 | |
235 | |
265 | sub async_pool(&@) { |
236 | sub async_pool(&@) { |
… | |
… | |
302 | |
273 | |
303 | "Cede" to other coroutines. This function puts the current coroutine into the |
274 | "Cede" to other coroutines. This function puts the current coroutine into the |
304 | ready queue and calls C<schedule>, which has the effect of giving up the |
275 | ready queue and calls C<schedule>, which has the effect of giving up the |
305 | current "timeslice" to other coroutines of the same or higher priority. |
276 | current "timeslice" to other coroutines of the same or higher priority. |
306 | |
277 | |
307 | Returns true if at least one coroutine switch has happened. |
|
|
308 | |
|
|
309 | =item Coro::cede_notself |
278 | =item Coro::cede_notself |
310 | |
279 | |
311 | Works like cede, but is not exported by default and will cede to any |
280 | Works like cede, but is not exported by default and will cede to any |
312 | coroutine, regardless of priority, once. |
281 | coroutine, regardless of priority, once. |
313 | |
|
|
314 | Returns true if at least one coroutine switch has happened. |
|
|
315 | |
282 | |
316 | =item terminate [arg...] |
283 | =item terminate [arg...] |
317 | |
284 | |
318 | Terminates the current coroutine with the given status values (see L<cancel>). |
285 | Terminates the current coroutine with the given status values (see L<cancel>). |
319 | |
286 | |
… | |
… | |
335 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
302 | if $_ != $current && UNIVERSAL::isa $_, "Coro"; |
336 | } |
303 | } |
337 | } |
304 | } |
338 | |
305 | |
339 | =back |
306 | =back |
340 | |
|
|
341 | # dynamic methods |
|
|
342 | |
307 | |
343 | =head2 COROUTINE METHODS |
308 | =head2 COROUTINE METHODS |
344 | |
309 | |
345 | These are the methods you can call on coroutine objects. |
310 | These are the methods you can call on coroutine objects. |
346 | |
311 | |
… | |
… | |
470 | Sets (or gets in case the argument is missing) the description for this |
435 | Sets (or gets in case the argument is missing) the description for this |
471 | coroutine. This is just a free-form string you can associate with a coroutine. |
436 | coroutine. This is just a free-form string you can associate with a coroutine. |
472 | |
437 | |
473 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
438 | This method simply sets the C<< $coroutine->{desc} >> member to the given string. You |
474 | can modify this member directly if you wish. |
439 | can modify this member directly if you wish. |
|
|
440 | |
|
|
441 | =item $coroutine->throw ([$scalar]) |
|
|
442 | |
|
|
443 | If C<$throw> is specified and defined, it will be thrown as an exception |
|
|
444 | inside the coroutine at the next convinient point in time (usually after |
|
|
445 | it gains control at the next schedule/transfer/cede). Otherwise clears the |
|
|
446 | exception object. |
|
|
447 | |
|
|
448 | The exception object will be thrown "as is" with the specified scalar in |
|
|
449 | C<$@>, i.e. if it is a string, no line number or newline will be appended |
|
|
450 | (unlike with C<die>). |
|
|
451 | |
|
|
452 | This can be used as a softer means than C<cancel> to ask a coroutine to |
|
|
453 | end itself, although there is no guarentee that the exception will lead to |
|
|
454 | termination, and if the exception isn't caught it might well end the whole |
|
|
455 | program. |
475 | |
456 | |
476 | =cut |
457 | =cut |
477 | |
458 | |
478 | sub desc { |
459 | sub desc { |
479 | my $old = $_[0]{desc}; |
460 | my $old = $_[0]{desc}; |
… | |
… | |
597 | to allow per-thread schedulers, but Coro::State does not yet allow |
578 | to allow per-thread schedulers, but Coro::State does not yet allow |
598 | this). |
579 | this). |
599 | |
580 | |
600 | =head1 SEE ALSO |
581 | =head1 SEE ALSO |
601 | |
582 | |
|
|
583 | Lower level Configuration, Coroutine Environment: L<Coro::State>. |
|
|
584 | |
|
|
585 | Debugging: L<Coro::Debug>. |
|
|
586 | |
602 | Support/Utility: L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
587 | Support/Utility: L<Coro::Specific>, L<Coro::Util>. |
603 | |
588 | |
604 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
589 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
605 | |
590 | |
606 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
591 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>. |
607 | |
592 | |
|
|
593 | Compatibility: L<Coro::LWP>, L<Coro::Storable>, L<Coro::Select>. |
|
|
594 | |
608 | Embedding: L<Coro:MakeMaker> |
595 | Embedding: L<Coro::MakeMaker>. |
609 | |
596 | |
610 | =head1 AUTHOR |
597 | =head1 AUTHOR |
611 | |
598 | |
612 | Marc Lehmann <schmorp@schmorp.de> |
599 | Marc Lehmann <schmorp@schmorp.de> |
613 | http://home.schmorp.de/ |
600 | http://home.schmorp.de/ |