… | |
… | |
32 | |
32 | |
33 | =cut |
33 | =cut |
34 | |
34 | |
35 | package Coro; |
35 | package Coro; |
36 | |
36 | |
|
|
37 | no warnings qw(uninitialized); |
|
|
38 | |
37 | use Coro::State; |
39 | use Coro::State; |
38 | |
40 | |
39 | use base Exporter; |
41 | use base Exporter; |
40 | |
42 | |
41 | $VERSION = 0.5; |
43 | $VERSION = 0.52; |
42 | |
44 | |
43 | @EXPORT = qw(async cede schedule terminate current); |
45 | @EXPORT = qw(async cede schedule terminate current); |
44 | %EXPORT_TAGS = ( |
46 | %EXPORT_TAGS = ( |
45 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
47 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
46 | ); |
48 | ); |
… | |
… | |
114 | }; |
116 | }; |
115 | |
117 | |
116 | # this coroutine is necessary because a coroutine |
118 | # this coroutine is necessary because a coroutine |
117 | # cannot destroy itself. |
119 | # cannot destroy itself. |
118 | my @destroy; |
120 | my @destroy; |
|
|
121 | my $manager; |
119 | my $manager = new Coro sub { |
122 | $manager = new Coro sub { |
120 | while() { |
123 | while() { |
121 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
124 | # by overwriting the state object with the manager we destroy it |
|
|
125 | # while still being able to schedule this coroutine (in case it has |
|
|
126 | # been readied multiple times. this is harmless since the manager |
|
|
127 | # can be called as many times as neccessary and will always |
|
|
128 | # remove itself from the runqueue |
|
|
129 | while (@destroy) { |
|
|
130 | my $coro = pop @destroy; |
|
|
131 | $coro->{status} ||= []; |
|
|
132 | $_->ready for @{delete $coro->{join} || []}; |
|
|
133 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
134 | } |
122 | &schedule; |
135 | &schedule; |
123 | } |
136 | } |
124 | }; |
137 | }; |
125 | |
138 | |
126 | # static methods. not really. |
139 | # static methods. not really. |
… | |
… | |
168 | ready queue and calls C<schedule>, which has the effect of giving up the |
181 | ready queue and calls C<schedule>, which has the effect of giving up the |
169 | current "timeslice" to other coroutines of the same or higher priority. |
182 | current "timeslice" to other coroutines of the same or higher priority. |
170 | |
183 | |
171 | =cut |
184 | =cut |
172 | |
185 | |
173 | =item terminate |
186 | =item terminate [arg...] |
174 | |
187 | |
175 | Terminates the current process. |
188 | Terminates the current process. |
176 | |
189 | |
177 | Future versions of this function will allow result arguments. |
190 | Future versions of this function will allow result arguments. |
178 | |
191 | |
179 | =cut |
192 | =cut |
180 | |
193 | |
181 | sub terminate { |
194 | sub terminate { |
|
|
195 | $current->{status} = [@_]; |
182 | $current->cancel; |
196 | $current->cancel; |
183 | &schedule; |
197 | &schedule; |
184 | die; # NORETURN |
198 | die; # NORETURN |
185 | } |
199 | } |
186 | |
200 | |
… | |
… | |
195 | =over 4 |
209 | =over 4 |
196 | |
210 | |
197 | =item new Coro \&sub [, @args...] |
211 | =item new Coro \&sub [, @args...] |
198 | |
212 | |
199 | Create a new process and return it. When the sub returns the process |
213 | Create a new process and return it. When the sub returns the process |
200 | automatically terminates. To start the process you must first put it into |
214 | automatically terminates as if C<terminate> with the returned values were |
|
|
215 | called. To make the process run you must first put it into the ready queue |
201 | the ready queue by calling the ready method. |
216 | by calling the ready method. |
202 | |
|
|
203 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
204 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
205 | |
217 | |
206 | =cut |
218 | =cut |
207 | |
219 | |
208 | sub _newcoro { |
220 | sub _newcoro { |
209 | terminate &{+shift}; |
221 | terminate &{+shift}; |
… | |
… | |
216 | }, $class; |
228 | }, $class; |
217 | } |
229 | } |
218 | |
230 | |
219 | =item $process->ready |
231 | =item $process->ready |
220 | |
232 | |
221 | Put the current process into the ready queue. |
233 | Put the given process into the ready queue. |
222 | |
234 | |
223 | =cut |
235 | =cut |
224 | |
236 | |
225 | =item $process->cancel |
237 | =item $process->cancel |
226 | |
238 | |
… | |
… | |
229 | =cut |
241 | =cut |
230 | |
242 | |
231 | sub cancel { |
243 | sub cancel { |
232 | push @destroy, $_[0]; |
244 | push @destroy, $_[0]; |
233 | $manager->ready; |
245 | $manager->ready; |
|
|
246 | &schedule if $current == $_[0]; |
|
|
247 | } |
|
|
248 | |
|
|
249 | =item $process->join |
|
|
250 | |
|
|
251 | Wait until the coroutine terminates and return any values given to the |
|
|
252 | C<terminate> function. C<join> can be called multiple times from multiple |
|
|
253 | processes. |
|
|
254 | |
|
|
255 | =cut |
|
|
256 | |
|
|
257 | sub join { |
|
|
258 | my $self = shift; |
|
|
259 | unless ($self->{status}) { |
|
|
260 | push @{$self->{join}}, $current; |
|
|
261 | &schedule; |
|
|
262 | } |
|
|
263 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
234 | } |
264 | } |
235 | |
265 | |
236 | =item $oldprio = $process->prio($newprio) |
266 | =item $oldprio = $process->prio($newprio) |
237 | |
267 | |
238 | Sets the priority of the process. Higher priority processes get run before |
268 | Sets (or gets, if the argument is missing) the priority of the |
|
|
269 | process. Higher priority processes get run before lower priority |
239 | lower priority processes. Priorities are smalled signed integer (currently |
270 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
240 | -4 .. +3), that you can refer to using PRIO_xxx constants (use the import |
271 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
241 | tag :prio to get then): |
272 | to get then): |
242 | |
273 | |
243 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
274 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
244 | 3 > 1 > 0 > -1 > -3 > -4 |
275 | 3 > 1 > 0 > -1 > -3 > -4 |
245 | |
276 | |
246 | # set priority to HIGH |
277 | # set priority to HIGH |
… | |
… | |
269 | |
300 | |
270 | =cut |
301 | =cut |
271 | |
302 | |
272 | sub nice { |
303 | sub nice { |
273 | $_[0]{prio} -= $_[1]; |
304 | $_[0]{prio} -= $_[1]; |
|
|
305 | } |
|
|
306 | |
|
|
307 | =item $olddesc = $process->desc($newdesc) |
|
|
308 | |
|
|
309 | Sets (or gets in case the argument is missing) the description for this |
|
|
310 | process. This is just a free-form string you can associate with a process. |
|
|
311 | |
|
|
312 | =cut |
|
|
313 | |
|
|
314 | sub desc { |
|
|
315 | my $old = $_[0]{desc}; |
|
|
316 | $_[0]{desc} = $_[1] if @_ > 1; |
|
|
317 | $old; |
274 | } |
318 | } |
275 | |
319 | |
276 | =back |
320 | =back |
277 | |
321 | |
278 | =cut |
322 | =cut |