… | |
… | |
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 | yield; |
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 to |
24 | Threads but don't run in parallel. |
24 | Threads but don't run in parallel. |
25 | |
25 | |
26 | This module is still experimental, see the BUGS section below. |
26 | This module is still experimental, see the BUGS section below. |
27 | |
27 | |
28 | In this module, coroutines are defined as "callchain + lexical variables |
28 | In this module, coroutines are defined as "callchain + lexical variables |
29 | + @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's |
29 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
30 | own set of lexicals and it's own set of perl's most important global |
30 | callchain, it's own set of lexicals and it's own set of perl's most |
31 | variables. |
31 | important global variables. |
32 | |
|
|
33 | WARNING: When using this module, make sure that, at program end, no |
|
|
34 | coroutines are still running OR just call exit before falling off the |
|
|
35 | end. The reason for this is that some coroutine of yours might have called |
|
|
36 | into a C function, and falling off the end of main:: results in returning |
|
|
37 | to that C function instead if to the main C interpreter. |
|
|
38 | |
32 | |
39 | =cut |
33 | =cut |
40 | |
34 | |
41 | package Coro; |
35 | package Coro; |
42 | |
36 | |
43 | use Coro::State; |
37 | use Coro::State; |
44 | |
38 | |
45 | use base Exporter; |
39 | use base Exporter; |
46 | |
40 | |
47 | $VERSION = 0.10; |
41 | $VERSION = 0.45; |
48 | |
42 | |
49 | @EXPORT = qw(async yield schedule terminate current); |
43 | @EXPORT = qw(async cede schedule terminate current); |
50 | @EXPORT_OK = qw($current); |
44 | @EXPORT_OK = qw($current); |
51 | |
45 | |
52 | { |
46 | { |
53 | my @async; |
47 | my @async; |
|
|
48 | my $init; |
54 | |
49 | |
55 | # this way of handling attributes simply is NOT scalable ;() |
50 | # this way of handling attributes simply is NOT scalable ;() |
56 | sub import { |
51 | sub import { |
57 | Coro->export_to_level(1, @_); |
52 | Coro->export_to_level(1, @_); |
58 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
53 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
… | |
… | |
60 | my ($package, $ref) = (shift, shift); |
55 | my ($package, $ref) = (shift, shift); |
61 | my @attrs; |
56 | my @attrs; |
62 | for (@_) { |
57 | for (@_) { |
63 | if ($_ eq "Coro") { |
58 | if ($_ eq "Coro") { |
64 | push @async, $ref; |
59 | push @async, $ref; |
|
|
60 | unless ($init++) { |
|
|
61 | eval q{ |
|
|
62 | sub INIT { |
|
|
63 | &async(pop @async) while @async; |
|
|
64 | } |
|
|
65 | }; |
|
|
66 | } |
65 | } else { |
67 | } else { |
66 | push @attrs, $_; |
68 | push @attrs, $_; |
67 | } |
69 | } |
68 | } |
70 | } |
69 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
71 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
70 | }; |
72 | }; |
71 | } |
73 | } |
72 | |
74 | |
73 | sub INIT { |
|
|
74 | &async(pop @async) while @async; |
|
|
75 | } |
|
|
76 | } |
75 | } |
77 | |
76 | |
78 | =item $main |
77 | =item $main |
79 | |
78 | |
80 | This coroutine represents the main program. |
79 | This coroutine represents the main program. |
… | |
… | |
109 | our $idle = new Coro sub { |
108 | our $idle = new Coro sub { |
110 | print STDERR "FATAL: deadlock detected\n"; |
109 | print STDERR "FATAL: deadlock detected\n"; |
111 | exit(51); |
110 | exit(51); |
112 | }; |
111 | }; |
113 | |
112 | |
114 | # we really need priorities... |
113 | # this coroutine is necessary because a coroutine |
115 | my @ready; # the ready queue. hehe, rather broken ;) |
114 | # cannot destroy itself. |
|
|
115 | my @destroy; |
|
|
116 | my $manager = new Coro sub { |
|
|
117 | while() { |
|
|
118 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
|
|
119 | &schedule; |
|
|
120 | } |
|
|
121 | }; |
116 | |
122 | |
117 | # static methods. not really. |
123 | # static methods. not really. |
118 | |
124 | |
119 | =head2 STATIC METHODS |
125 | =head2 STATIC METHODS |
120 | |
126 | |
… | |
… | |
138 | |
144 | |
139 | =cut |
145 | =cut |
140 | |
146 | |
141 | sub async(&@) { |
147 | sub async(&@) { |
142 | my $pid = new Coro @_; |
148 | my $pid = new Coro @_; |
|
|
149 | $manager->ready; # this ensures that the stack is cloned from the manager |
143 | $pid->ready; |
150 | $pid->ready; |
144 | $pid; |
151 | $pid; |
145 | } |
152 | } |
146 | |
153 | |
147 | =item schedule |
154 | =item schedule |
… | |
… | |
150 | into the ready queue, so calling this function usually means you will |
157 | into the ready queue, so calling this function usually means you will |
151 | never be called again. |
158 | never be called again. |
152 | |
159 | |
153 | =cut |
160 | =cut |
154 | |
161 | |
155 | my $prev; |
|
|
156 | |
|
|
157 | sub schedule { |
|
|
158 | # should be done using priorities :( |
|
|
159 | ($prev, $current) = ($current, shift @ready || $idle); |
|
|
160 | Coro::State::transfer($prev, $current); |
|
|
161 | } |
|
|
162 | |
|
|
163 | =item yield |
162 | =item cede |
164 | |
163 | |
165 | Yield to other processes. This function puts the current process into the |
164 | "Cede" to other processes. This function puts the current process into the |
166 | ready queue and calls C<schedule>. |
165 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
166 | current "timeslice" to other coroutines of the same or higher priority. |
167 | |
167 | |
168 | =cut |
168 | =cut |
169 | |
169 | |
170 | sub yield { |
170 | =item terminate |
|
|
171 | |
|
|
172 | Terminates the current process. |
|
|
173 | |
|
|
174 | Future versions of this function will allow result arguments. |
|
|
175 | |
|
|
176 | =cut |
|
|
177 | |
|
|
178 | sub terminate { |
171 | $current->ready; |
179 | $current->cancel; |
172 | &schedule; |
180 | &schedule; |
173 | } |
181 | die; # NORETURN |
174 | |
|
|
175 | =item terminate |
|
|
176 | |
|
|
177 | Terminates the current process. |
|
|
178 | |
|
|
179 | Future versions of this function will allow result arguments. |
|
|
180 | |
|
|
181 | =cut |
|
|
182 | |
|
|
183 | sub terminate { |
|
|
184 | $current->{_results} = [@_]; |
|
|
185 | delete $current->{_coro_state}; |
|
|
186 | &schedule; |
|
|
187 | } |
182 | } |
188 | |
183 | |
189 | =back |
184 | =back |
190 | |
185 | |
191 | # dynamic methods |
186 | # dynamic methods |
… | |
… | |
222 | |
217 | |
223 | Put the current process into the ready queue. |
218 | Put the current process into the ready queue. |
224 | |
219 | |
225 | =cut |
220 | =cut |
226 | |
221 | |
227 | sub ready { |
222 | =item $process->cancel |
|
|
223 | |
|
|
224 | Like C<terminate>, but terminates the specified process instead. |
|
|
225 | |
|
|
226 | =cut |
|
|
227 | |
|
|
228 | sub cancel { |
228 | push @ready, $_[0]; |
229 | push @destroy, $_[0]; |
|
|
230 | $manager->ready; |
229 | } |
231 | } |
230 | |
232 | |
231 | =back |
233 | =back |
232 | |
234 | |
233 | =cut |
235 | =cut |
… | |
… | |
249 | allow per-thread schedulers, but Coro::State does not yet allow this). |
251 | allow per-thread schedulers, but Coro::State does not yet allow this). |
250 | |
252 | |
251 | =head1 SEE ALSO |
253 | =head1 SEE ALSO |
252 | |
254 | |
253 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
255 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
254 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. |
256 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
|
|
257 | L<Coro::Handle>, L<Coro::Socket>. |
255 | |
258 | |
256 | =head1 AUTHOR |
259 | =head1 AUTHOR |
257 | |
260 | |
258 | Marc Lehmann <pcg@goof.com> |
261 | Marc Lehmann <pcg@goof.com> |
259 | http://www.goof.com/pcg/marc/ |
262 | http://www.goof.com/pcg/marc/ |