… | |
… | |
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. |
32 | |
30 | |
33 | =cut |
31 | =cut |
34 | |
32 | |
35 | package Coro; |
33 | package Coro; |
36 | |
34 | |
|
|
35 | no warnings qw(uninitialized); |
|
|
36 | |
37 | use Coro::State; |
37 | use Coro::State; |
38 | |
38 | |
39 | use base Exporter; |
39 | use base Exporter; |
40 | |
40 | |
41 | $VERSION = 0.5; |
41 | $VERSION = 0.533; |
42 | |
42 | |
43 | @EXPORT = qw(async cede schedule terminate current); |
43 | @EXPORT = qw(async cede schedule terminate current); |
44 | %EXPORT_TAGS = ( |
44 | %EXPORT_TAGS = ( |
45 | 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)], |
46 | ); |
46 | ); |
… | |
… | |
75 | }; |
75 | }; |
76 | } |
76 | } |
77 | |
77 | |
78 | } |
78 | } |
79 | |
79 | |
|
|
80 | =over 4 |
|
|
81 | |
80 | =item $main |
82 | =item $main |
81 | |
83 | |
82 | This coroutine represents the main program. |
84 | This coroutine represents the main program. |
83 | |
85 | |
84 | =cut |
86 | =cut |
… | |
… | |
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. |
|
|
140 | |
|
|
141 | =back |
127 | |
142 | |
128 | =head2 STATIC METHODS |
143 | =head2 STATIC METHODS |
129 | |
144 | |
130 | 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. |
131 | |
146 | |
… | |
… | |
168 | 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 |
169 | current "timeslice" to other coroutines of the same or higher priority. |
184 | current "timeslice" to other coroutines of the same or higher priority. |
170 | |
185 | |
171 | =cut |
186 | =cut |
172 | |
187 | |
173 | =item terminate |
188 | =item terminate [arg...] |
174 | |
189 | |
175 | Terminates the current process. |
190 | Terminates the current process. |
176 | |
191 | |
177 | Future versions of this function will allow result arguments. |
192 | Future versions of this function will allow result arguments. |
178 | |
193 | |
179 | =cut |
194 | =cut |
180 | |
195 | |
181 | sub terminate { |
196 | sub terminate { |
|
|
197 | $current->{status} = [@_]; |
182 | $current->cancel; |
198 | $current->cancel; |
183 | &schedule; |
199 | &schedule; |
184 | die; # NORETURN |
200 | die; # NORETURN |
185 | } |
201 | } |
186 | |
202 | |
… | |
… | |
195 | =over 4 |
211 | =over 4 |
196 | |
212 | |
197 | =item new Coro \&sub [, @args...] |
213 | =item new Coro \&sub [, @args...] |
198 | |
214 | |
199 | 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 |
200 | 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 |
201 | the ready queue by calling the ready method. |
218 | 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 | |
219 | |
206 | =cut |
220 | =cut |
207 | |
221 | |
208 | sub _newcoro { |
222 | sub _newcoro { |
209 | terminate &{+shift}; |
223 | terminate &{+shift}; |
… | |
… | |
216 | }, $class; |
230 | }, $class; |
217 | } |
231 | } |
218 | |
232 | |
219 | =item $process->ready |
233 | =item $process->ready |
220 | |
234 | |
221 | Put the current process into the ready queue. |
235 | Put the given process into the ready queue. |
222 | |
236 | |
223 | =cut |
237 | =cut |
224 | |
238 | |
225 | =item $process->cancel |
239 | =item $process->cancel |
226 | |
240 | |
… | |
… | |
232 | push @destroy, $_[0]; |
246 | push @destroy, $_[0]; |
233 | $manager->ready; |
247 | $manager->ready; |
234 | &schedule if $current == $_[0]; |
248 | &schedule if $current == $_[0]; |
235 | } |
249 | } |
236 | |
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 | |
237 | =item $oldprio = $process->prio($newprio) |
268 | =item $oldprio = $process->prio($newprio) |
238 | |
269 | |
239 | 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 |
240 | lower priority processes. Priorities are smalled signed integer (currently |
272 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
241 | -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 |
242 | tag :prio to get then): |
274 | to get then): |
243 | |
275 | |
244 | 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 |
245 | 3 > 1 > 0 > -1 > -3 > -4 |
277 | 3 > 1 > 0 > -1 > -3 > -4 |
246 | |
278 | |
247 | # set priority to HIGH |
279 | # set priority to HIGH |
… | |
… | |
272 | |
304 | |
273 | sub nice { |
305 | sub nice { |
274 | $_[0]{prio} -= $_[1]; |
306 | $_[0]{prio} -= $_[1]; |
275 | } |
307 | } |
276 | |
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 | |
277 | =back |
322 | =back |
278 | |
323 | |
279 | =cut |
324 | =cut |
280 | |
325 | |
281 | 1; |
326 | 1; |
282 | |
327 | |
283 | =head1 BUGS/LIMITATIONS |
328 | =head1 BUGS/LIMITATIONS |
284 | |
329 | |
285 | - 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. |
286 | very bad things might happen otherwise (usually segfaults). |
331 | very bad things might happen otherwise (usually segfaults). |
287 | - 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 |
288 | 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 |
289 | 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). |
290 | |
335 | |
291 | =head1 SEE ALSO |
336 | =head1 SEE ALSO |
292 | |
337 | |