… | |
… | |
19 | cede; |
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 | |
|
|
26 | This module is still experimental, see the BUGS section below. |
|
|
27 | |
25 | |
28 | In this module, coroutines are defined as "callchain + lexical variables |
26 | In this module, coroutines are defined as "callchain + lexical variables |
29 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
27 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
30 | callchain, it's own set of lexicals and it's own set of perl's most |
28 | callchain, it's own set of lexicals and it's own set of perl's most |
31 | important global variables. |
29 | important global variables. |
… | |
… | |
38 | |
36 | |
39 | use Coro::State; |
37 | use Coro::State; |
40 | |
38 | |
41 | use base Exporter; |
39 | use base Exporter; |
42 | |
40 | |
43 | $VERSION = 0.51; |
41 | $VERSION = 0.652; |
44 | |
42 | |
45 | @EXPORT = qw(async cede schedule terminate current); |
43 | @EXPORT = qw(async cede schedule terminate current); |
46 | %EXPORT_TAGS = ( |
44 | %EXPORT_TAGS = ( |
47 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
45 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
48 | ); |
46 | ); |
… | |
… | |
77 | }; |
75 | }; |
78 | } |
76 | } |
79 | |
77 | |
80 | } |
78 | } |
81 | |
79 | |
|
|
80 | =over 4 |
|
|
81 | |
82 | =item $main |
82 | =item $main |
83 | |
83 | |
84 | This coroutine represents the main program. |
84 | This coroutine represents the main program. |
85 | |
85 | |
86 | =cut |
86 | =cut |
… | |
… | |
124 | # by overwriting the state object with the manager we destroy it |
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 |
125 | # while still being able to schedule this coroutine (in case it has |
126 | # been readied multiple times. this is harmless since the manager |
126 | # been readied multiple times. this is harmless since the manager |
127 | # can be called as many times as neccessary and will always |
127 | # can be called as many times as neccessary and will always |
128 | # remove itself from the runqueue |
128 | # remove itself from the runqueue |
|
|
129 | while (@destroy) { |
|
|
130 | my $coro = pop @destroy; |
|
|
131 | $coro->{status} ||= []; |
|
|
132 | $_->ready for @{delete $coro->{join} || []}; |
129 | (pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy; |
133 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
134 | } |
130 | &schedule; |
135 | &schedule; |
131 | } |
136 | } |
132 | }; |
137 | }; |
133 | |
138 | |
134 | # static methods. not really. |
139 | # static methods. not really. |
|
|
140 | |
|
|
141 | =back |
135 | |
142 | |
136 | =head2 STATIC METHODS |
143 | =head2 STATIC METHODS |
137 | |
144 | |
138 | Static methods are actually functions that operate on the current process only. |
145 | Static methods are actually functions that operate on the current process only. |
139 | |
146 | |
… | |
… | |
176 | ready queue and calls C<schedule>, which has the effect of giving up the |
183 | ready queue and calls C<schedule>, which has the effect of giving up the |
177 | current "timeslice" to other coroutines of the same or higher priority. |
184 | current "timeslice" to other coroutines of the same or higher priority. |
178 | |
185 | |
179 | =cut |
186 | =cut |
180 | |
187 | |
181 | =item terminate |
188 | =item terminate [arg...] |
182 | |
189 | |
183 | Terminates the current process. |
190 | Terminates the current process. |
184 | |
191 | |
185 | Future versions of this function will allow result arguments. |
192 | Future versions of this function will allow result arguments. |
186 | |
193 | |
187 | =cut |
194 | =cut |
188 | |
195 | |
189 | sub terminate { |
196 | sub terminate { |
|
|
197 | $current->{status} = [@_]; |
190 | $current->cancel; |
198 | $current->cancel; |
191 | &schedule; |
199 | &schedule; |
192 | die; # NORETURN |
200 | die; # NORETURN |
193 | } |
201 | } |
194 | |
202 | |
… | |
… | |
203 | =over 4 |
211 | =over 4 |
204 | |
212 | |
205 | =item new Coro \&sub [, @args...] |
213 | =item new Coro \&sub [, @args...] |
206 | |
214 | |
207 | Create a new process and return it. When the sub returns the process |
215 | Create a new process and return it. When the sub returns the process |
208 | automatically terminates. To start the process you must first put it into |
216 | automatically terminates as if C<terminate> with the returned values were |
|
|
217 | called. To make the process run you must first put it into the ready queue |
209 | the ready queue by calling the ready method. |
218 | by calling the ready method. |
210 | |
|
|
211 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
212 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
213 | |
219 | |
214 | =cut |
220 | =cut |
215 | |
221 | |
216 | sub _newcoro { |
222 | sub _newcoro { |
217 | terminate &{+shift}; |
223 | terminate &{+shift}; |
… | |
… | |
224 | }, $class; |
230 | }, $class; |
225 | } |
231 | } |
226 | |
232 | |
227 | =item $process->ready |
233 | =item $process->ready |
228 | |
234 | |
229 | Put the current process into the ready queue. |
235 | Put the given process into the ready queue. |
230 | |
236 | |
231 | =cut |
237 | =cut |
232 | |
238 | |
233 | =item $process->cancel |
239 | =item $process->cancel |
234 | |
240 | |
… | |
… | |
240 | push @destroy, $_[0]; |
246 | push @destroy, $_[0]; |
241 | $manager->ready; |
247 | $manager->ready; |
242 | &schedule if $current == $_[0]; |
248 | &schedule if $current == $_[0]; |
243 | } |
249 | } |
244 | |
250 | |
|
|
251 | =item $process->join |
|
|
252 | |
|
|
253 | Wait until the coroutine terminates and return any values given to the |
|
|
254 | C<terminate> function. C<join> can be called multiple times from multiple |
|
|
255 | processes. |
|
|
256 | |
|
|
257 | =cut |
|
|
258 | |
|
|
259 | sub join { |
|
|
260 | my $self = shift; |
|
|
261 | unless ($self->{status}) { |
|
|
262 | push @{$self->{join}}, $current; |
|
|
263 | &schedule; |
|
|
264 | } |
|
|
265 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
|
|
266 | } |
|
|
267 | |
245 | =item $oldprio = $process->prio($newprio) |
268 | =item $oldprio = $process->prio($newprio) |
246 | |
269 | |
247 | Sets the priority of the process. Higher priority processes get run before |
270 | Sets (or gets, if the argument is missing) the priority of the |
|
|
271 | process. Higher priority processes get run before lower priority |
248 | lower priority processes. Priorities are smalled signed integer (currently |
272 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
249 | -4 .. +3), that you can refer to using PRIO_xxx constants (use the import |
273 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
250 | tag :prio to get then): |
274 | to get then): |
251 | |
275 | |
252 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
276 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
253 | 3 > 1 > 0 > -1 > -3 > -4 |
277 | 3 > 1 > 0 > -1 > -3 > -4 |
254 | |
278 | |
255 | # set priority to HIGH |
279 | # set priority to HIGH |
… | |
… | |
280 | |
304 | |
281 | sub nice { |
305 | sub nice { |
282 | $_[0]{prio} -= $_[1]; |
306 | $_[0]{prio} -= $_[1]; |
283 | } |
307 | } |
284 | |
308 | |
|
|
309 | =item $olddesc = $process->desc($newdesc) |
|
|
310 | |
|
|
311 | Sets (or gets in case the argument is missing) the description for this |
|
|
312 | process. This is just a free-form string you can associate with a process. |
|
|
313 | |
|
|
314 | =cut |
|
|
315 | |
|
|
316 | sub desc { |
|
|
317 | my $old = $_[0]{desc}; |
|
|
318 | $_[0]{desc} = $_[1] if @_ > 1; |
|
|
319 | $old; |
|
|
320 | } |
|
|
321 | |
285 | =back |
322 | =back |
286 | |
323 | |
287 | =cut |
324 | =cut |
288 | |
325 | |
289 | 1; |
326 | 1; |
290 | |
327 | |
291 | =head1 BUGS/LIMITATIONS |
328 | =head1 BUGS/LIMITATIONS |
292 | |
329 | |
293 | - you must make very sure that no coro is still active on global destruction. |
330 | - you must make very sure that no coro is still active on global destruction. |
294 | very bad things might happen otherwise (usually segfaults). |
331 | very bad things might happen otherwise (usually segfaults). |
295 | - this module is not thread-safe. You must only ever use this module from |
332 | - this module is not thread-safe. You should only ever use this module from |
296 | the same thread (this requirement might be loosened in the future to |
333 | the same thread (this requirement might be loosened in the future to |
297 | allow per-thread schedulers, but Coro::State does not yet allow this). |
334 | allow per-thread schedulers, but Coro::State does not yet allow this). |
298 | |
335 | |
299 | =head1 SEE ALSO |
336 | =head1 SEE ALSO |
300 | |
337 | |