… | |
… | |
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 |
|
|
29 | + @_ + $_ + $@ + $^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 |
|
|
31 | important global variables. |
|
|
32 | |
28 | =cut |
33 | =cut |
29 | |
34 | |
30 | package Coro; |
35 | package Coro; |
31 | |
36 | |
|
|
37 | no warnings qw(uninitialized); |
|
|
38 | |
32 | use Coro::State; |
39 | use Coro::State; |
33 | |
40 | |
34 | use base Exporter; |
41 | use base Exporter; |
35 | |
42 | |
36 | $VERSION = 0.08; |
43 | $VERSION = 0.52; |
37 | |
44 | |
38 | @EXPORT = qw(async yield schedule terminate); |
45 | @EXPORT = qw(async cede schedule terminate current); |
39 | @EXPORT_OK = qw($current); |
46 | %EXPORT_TAGS = ( |
|
|
47 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
|
|
48 | ); |
|
|
49 | @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
40 | |
50 | |
41 | { |
51 | { |
42 | use subs 'async'; |
|
|
43 | |
|
|
44 | my @async; |
52 | my @async; |
|
|
53 | my $init; |
45 | |
54 | |
46 | # this way of handling attributes simply is NOT scalable ;() |
55 | # this way of handling attributes simply is NOT scalable ;() |
47 | sub import { |
56 | sub import { |
48 | Coro->export_to_level(1, @_); |
57 | Coro->export_to_level(1, @_); |
49 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
58 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
… | |
… | |
51 | my ($package, $ref) = (shift, shift); |
60 | my ($package, $ref) = (shift, shift); |
52 | my @attrs; |
61 | my @attrs; |
53 | for (@_) { |
62 | for (@_) { |
54 | if ($_ eq "Coro") { |
63 | if ($_ eq "Coro") { |
55 | push @async, $ref; |
64 | push @async, $ref; |
|
|
65 | unless ($init++) { |
|
|
66 | eval q{ |
|
|
67 | sub INIT { |
|
|
68 | &async(pop @async) while @async; |
|
|
69 | } |
|
|
70 | }; |
|
|
71 | } |
56 | } else { |
72 | } else { |
57 | push @attrs, $_; |
73 | push @attrs, $_; |
58 | } |
74 | } |
59 | } |
75 | } |
60 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
76 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
61 | }; |
77 | }; |
62 | } |
78 | } |
63 | |
79 | |
64 | sub INIT { |
|
|
65 | async pop @async while @async; |
|
|
66 | } |
|
|
67 | } |
80 | } |
68 | |
81 | |
69 | =item $main |
82 | =item $main |
70 | |
83 | |
71 | This coroutine represents the main program. |
84 | This coroutine represents the main program. |
72 | |
85 | |
73 | =cut |
86 | =cut |
74 | |
87 | |
75 | our $main = new Coro; |
88 | our $main = new Coro; |
76 | |
89 | |
77 | =item $current |
90 | =item $current (or as function: current) |
78 | |
91 | |
79 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
92 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
80 | |
93 | |
81 | =cut |
94 | =cut |
82 | |
95 | |
… | |
… | |
84 | if ($current) { |
97 | if ($current) { |
85 | $main->{specific} = $current->{specific}; |
98 | $main->{specific} = $current->{specific}; |
86 | } |
99 | } |
87 | |
100 | |
88 | our $current = $main; |
101 | our $current = $main; |
|
|
102 | |
|
|
103 | sub current() { $current } |
89 | |
104 | |
90 | =item $idle |
105 | =item $idle |
91 | |
106 | |
92 | The coroutine to switch to when no other coroutine is running. The default |
107 | The coroutine to switch to when no other coroutine is running. The default |
93 | implementation prints "FATAL: deadlock detected" and exits. |
108 | implementation prints "FATAL: deadlock detected" and exits. |
… | |
… | |
98 | our $idle = new Coro sub { |
113 | our $idle = new Coro sub { |
99 | print STDERR "FATAL: deadlock detected\n"; |
114 | print STDERR "FATAL: deadlock detected\n"; |
100 | exit(51); |
115 | exit(51); |
101 | }; |
116 | }; |
102 | |
117 | |
103 | # we really need priorities... |
118 | # this coroutine is necessary because a coroutine |
104 | my @ready; # the ready queue. hehe, rather broken ;) |
119 | # cannot destroy itself. |
|
|
120 | my @destroy; |
|
|
121 | my $manager; |
|
|
122 | $manager = new Coro sub { |
|
|
123 | while() { |
|
|
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 | } |
|
|
135 | &schedule; |
|
|
136 | } |
|
|
137 | }; |
105 | |
138 | |
106 | # static methods. not really. |
139 | # static methods. not really. |
107 | |
140 | |
108 | =head2 STATIC METHODS |
141 | =head2 STATIC METHODS |
109 | |
142 | |
… | |
… | |
127 | |
160 | |
128 | =cut |
161 | =cut |
129 | |
162 | |
130 | sub async(&@) { |
163 | sub async(&@) { |
131 | my $pid = new Coro @_; |
164 | my $pid = new Coro @_; |
|
|
165 | $manager->ready; # this ensures that the stack is cloned from the manager |
132 | $pid->ready; |
166 | $pid->ready; |
133 | $pid; |
167 | $pid; |
134 | } |
168 | } |
135 | |
169 | |
136 | =item schedule |
170 | =item schedule |
… | |
… | |
139 | into the ready queue, so calling this function usually means you will |
173 | into the ready queue, so calling this function usually means you will |
140 | never be called again. |
174 | never be called again. |
141 | |
175 | |
142 | =cut |
176 | =cut |
143 | |
177 | |
144 | my $prev; |
|
|
145 | |
|
|
146 | sub schedule { |
|
|
147 | # should be done using priorities :( |
|
|
148 | ($prev, $current) = ($current, shift @ready || $idle); |
|
|
149 | Coro::State::transfer($prev, $current); |
|
|
150 | } |
|
|
151 | |
|
|
152 | =item yield |
178 | =item cede |
153 | |
179 | |
154 | Yield to other processes. This function puts the current process into the |
180 | "Cede" to other processes. This function puts the current process into the |
155 | ready queue and calls C<schedule>. |
181 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
182 | current "timeslice" to other coroutines of the same or higher priority. |
156 | |
183 | |
157 | =cut |
184 | =cut |
158 | |
185 | |
159 | sub yield { |
186 | =item terminate [arg...] |
|
|
187 | |
|
|
188 | Terminates the current process. |
|
|
189 | |
|
|
190 | Future versions of this function will allow result arguments. |
|
|
191 | |
|
|
192 | =cut |
|
|
193 | |
|
|
194 | sub terminate { |
|
|
195 | $current->{status} = [@_]; |
160 | $current->ready; |
196 | $current->cancel; |
161 | &schedule; |
197 | &schedule; |
162 | } |
198 | die; # NORETURN |
163 | |
|
|
164 | =item terminate |
|
|
165 | |
|
|
166 | Terminates the current process. |
|
|
167 | |
|
|
168 | Future versions of this function will allow result arguments. |
|
|
169 | |
|
|
170 | =cut |
|
|
171 | |
|
|
172 | sub terminate { |
|
|
173 | $current->{_results} = [@_]; |
|
|
174 | &schedule; |
|
|
175 | } |
199 | } |
176 | |
200 | |
177 | =back |
201 | =back |
178 | |
202 | |
179 | # dynamic methods |
203 | # dynamic methods |
… | |
… | |
185 | =over 4 |
209 | =over 4 |
186 | |
210 | |
187 | =item new Coro \&sub [, @args...] |
211 | =item new Coro \&sub [, @args...] |
188 | |
212 | |
189 | 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 |
190 | 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 |
191 | the ready queue by calling the ready method. |
216 | by calling the ready method. |
192 | |
|
|
193 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
194 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
195 | |
217 | |
196 | =cut |
218 | =cut |
197 | |
219 | |
198 | sub _newcoro { |
220 | sub _newcoro { |
199 | terminate &{+shift}; |
221 | terminate &{+shift}; |
… | |
… | |
206 | }, $class; |
228 | }, $class; |
207 | } |
229 | } |
208 | |
230 | |
209 | =item $process->ready |
231 | =item $process->ready |
210 | |
232 | |
211 | Put the current process into the ready queue. |
233 | Put the given process into the ready queue. |
212 | |
234 | |
213 | =cut |
235 | =cut |
214 | |
236 | |
215 | sub ready { |
237 | =item $process->cancel |
|
|
238 | |
|
|
239 | Like C<terminate>, but terminates the specified process instead. |
|
|
240 | |
|
|
241 | =cut |
|
|
242 | |
|
|
243 | sub cancel { |
216 | push @ready, $_[0]; |
244 | push @destroy, $_[0]; |
|
|
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]; |
|
|
264 | } |
|
|
265 | |
|
|
266 | =item $oldprio = $process->prio($newprio) |
|
|
267 | |
|
|
268 | Sets (or gets, if the argument is missing) the priority of the |
|
|
269 | process. Higher priority processes get run before lower priority |
|
|
270 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
|
|
271 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
|
|
272 | to get then): |
|
|
273 | |
|
|
274 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
|
|
275 | 3 > 1 > 0 > -1 > -3 > -4 |
|
|
276 | |
|
|
277 | # set priority to HIGH |
|
|
278 | current->prio(PRIO_HIGH); |
|
|
279 | |
|
|
280 | The idle coroutine ($Coro::idle) always has a lower priority than any |
|
|
281 | existing coroutine. |
|
|
282 | |
|
|
283 | Changing the priority of the current process will take effect immediately, |
|
|
284 | but changing the priority of processes in the ready queue (but not |
|
|
285 | running) will only take effect after the next schedule (of that |
|
|
286 | process). This is a bug that will be fixed in some future version. |
|
|
287 | |
|
|
288 | =cut |
|
|
289 | |
|
|
290 | sub prio { |
|
|
291 | my $old = $_[0]{prio}; |
|
|
292 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
293 | $old; |
|
|
294 | } |
|
|
295 | |
|
|
296 | =item $newprio = $process->nice($change) |
|
|
297 | |
|
|
298 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
|
|
299 | higher values mean lower priority, just as in unix). |
|
|
300 | |
|
|
301 | =cut |
|
|
302 | |
|
|
303 | sub nice { |
|
|
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; |
217 | } |
318 | } |
218 | |
319 | |
219 | =back |
320 | =back |
220 | |
321 | |
221 | =cut |
322 | =cut |
222 | |
323 | |
223 | 1; |
324 | 1; |
224 | |
325 | |
225 | =head1 BUGS/LIMITATIONS |
326 | =head1 BUGS/LIMITATIONS |
226 | |
327 | |
227 | - could be faster, especially when the core would introduce special |
328 | - you must make very sure that no coro is still active on global destruction. |
228 | support for coroutines (like it does for threads). |
329 | very bad things might happen otherwise (usually segfaults). |
229 | - there is still a memleak on coroutine termination that I could not |
|
|
230 | identify. Could be as small as a single SV. |
|
|
231 | - this module is not well-tested. |
|
|
232 | - if variables or arguments "disappear" (become undef) or become |
|
|
233 | corrupted please contact the author so he cen iron out the |
|
|
234 | remaining bugs. |
|
|
235 | - this module is not thread-safe. You must only ever use this module from |
330 | - this module is not thread-safe. You must only ever use this module from |
236 | the same thread (this requirement might be loosened in the future to |
331 | the same thread (this requirement might be loosened in the future to |
237 | allow per-thread schedulers, but Coro::Satte does not yet allow this). |
332 | allow per-thread schedulers, but Coro::State does not yet allow this). |
238 | |
333 | |
239 | =head1 SEE ALSO |
334 | =head1 SEE ALSO |
240 | |
335 | |
241 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
336 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
242 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. |
337 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
|
|
338 | L<Coro::Handle>, L<Coro::Socket>. |
243 | |
339 | |
244 | =head1 AUTHOR |
340 | =head1 AUTHOR |
245 | |
341 | |
246 | Marc Lehmann <pcg@goof.com> |
342 | Marc Lehmann <pcg@goof.com> |
247 | http://www.goof.com/pcg/marc/ |
343 | http://www.goof.com/pcg/marc/ |