… | |
… | |
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 | |
32 | use Coro::State; |
37 | use Coro::State; |
33 | |
38 | |
34 | use base Exporter; |
39 | use base Exporter; |
35 | |
40 | |
36 | $VERSION = 0.09; |
41 | $VERSION = 0.5; |
37 | |
42 | |
38 | @EXPORT = qw(async yield schedule terminate current); |
43 | @EXPORT = qw(async cede schedule terminate current); |
39 | @EXPORT_OK = qw($current); |
44 | %EXPORT_TAGS = ( |
|
|
45 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
|
|
46 | ); |
|
|
47 | @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
40 | |
48 | |
41 | { |
49 | { |
42 | use subs 'async'; |
|
|
43 | |
|
|
44 | my @async; |
50 | my @async; |
|
|
51 | my $init; |
45 | |
52 | |
46 | # this way of handling attributes simply is NOT scalable ;() |
53 | # this way of handling attributes simply is NOT scalable ;() |
47 | sub import { |
54 | sub import { |
48 | Coro->export_to_level(1, @_); |
55 | Coro->export_to_level(1, @_); |
49 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
56 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
… | |
… | |
51 | my ($package, $ref) = (shift, shift); |
58 | my ($package, $ref) = (shift, shift); |
52 | my @attrs; |
59 | my @attrs; |
53 | for (@_) { |
60 | for (@_) { |
54 | if ($_ eq "Coro") { |
61 | if ($_ eq "Coro") { |
55 | push @async, $ref; |
62 | push @async, $ref; |
|
|
63 | unless ($init++) { |
|
|
64 | eval q{ |
|
|
65 | sub INIT { |
|
|
66 | &async(pop @async) while @async; |
|
|
67 | } |
|
|
68 | }; |
|
|
69 | } |
56 | } else { |
70 | } else { |
57 | push @attrs, $_; |
71 | push @attrs, $_; |
58 | } |
72 | } |
59 | } |
73 | } |
60 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
74 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
61 | }; |
75 | }; |
62 | } |
76 | } |
63 | |
77 | |
64 | sub INIT { |
|
|
65 | async pop @async while @async; |
|
|
66 | } |
|
|
67 | } |
78 | } |
68 | |
79 | |
69 | =item $main |
80 | =item $main |
70 | |
81 | |
71 | This coroutine represents the main program. |
82 | This coroutine represents the main program. |
… | |
… | |
100 | our $idle = new Coro sub { |
111 | our $idle = new Coro sub { |
101 | print STDERR "FATAL: deadlock detected\n"; |
112 | print STDERR "FATAL: deadlock detected\n"; |
102 | exit(51); |
113 | exit(51); |
103 | }; |
114 | }; |
104 | |
115 | |
105 | # we really need priorities... |
116 | # this coroutine is necessary because a coroutine |
106 | my @ready; # the ready queue. hehe, rather broken ;) |
117 | # cannot destroy itself. |
|
|
118 | my @destroy; |
|
|
119 | my $manager = new Coro sub { |
|
|
120 | while() { |
|
|
121 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
|
|
122 | &schedule; |
|
|
123 | } |
|
|
124 | }; |
107 | |
125 | |
108 | # static methods. not really. |
126 | # static methods. not really. |
109 | |
127 | |
110 | =head2 STATIC METHODS |
128 | =head2 STATIC METHODS |
111 | |
129 | |
… | |
… | |
129 | |
147 | |
130 | =cut |
148 | =cut |
131 | |
149 | |
132 | sub async(&@) { |
150 | sub async(&@) { |
133 | my $pid = new Coro @_; |
151 | my $pid = new Coro @_; |
|
|
152 | $manager->ready; # this ensures that the stack is cloned from the manager |
134 | $pid->ready; |
153 | $pid->ready; |
135 | $pid; |
154 | $pid; |
136 | } |
155 | } |
137 | |
156 | |
138 | =item schedule |
157 | =item schedule |
… | |
… | |
141 | into the ready queue, so calling this function usually means you will |
160 | into the ready queue, so calling this function usually means you will |
142 | never be called again. |
161 | never be called again. |
143 | |
162 | |
144 | =cut |
163 | =cut |
145 | |
164 | |
146 | my $prev; |
|
|
147 | |
|
|
148 | sub schedule { |
|
|
149 | # should be done using priorities :( |
|
|
150 | ($prev, $current) = ($current, shift @ready || $idle); |
|
|
151 | Coro::State::transfer($prev, $current); |
|
|
152 | } |
|
|
153 | |
|
|
154 | =item yield |
165 | =item cede |
155 | |
166 | |
156 | Yield to other processes. This function puts the current process into the |
167 | "Cede" to other processes. This function puts the current process into the |
157 | ready queue and calls C<schedule>. |
168 | 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. |
158 | |
170 | |
159 | =cut |
171 | =cut |
160 | |
172 | |
161 | sub yield { |
173 | =item terminate |
|
|
174 | |
|
|
175 | Terminates the current process. |
|
|
176 | |
|
|
177 | Future versions of this function will allow result arguments. |
|
|
178 | |
|
|
179 | =cut |
|
|
180 | |
|
|
181 | sub terminate { |
162 | $current->ready; |
182 | $current->cancel; |
163 | &schedule; |
183 | &schedule; |
164 | } |
184 | die; # NORETURN |
165 | |
|
|
166 | =item terminate |
|
|
167 | |
|
|
168 | Terminates the current process. |
|
|
169 | |
|
|
170 | Future versions of this function will allow result arguments. |
|
|
171 | |
|
|
172 | =cut |
|
|
173 | |
|
|
174 | sub terminate { |
|
|
175 | $current->{_results} = [@_]; |
|
|
176 | &schedule; |
|
|
177 | } |
185 | } |
178 | |
186 | |
179 | =back |
187 | =back |
180 | |
188 | |
181 | # dynamic methods |
189 | # dynamic methods |
… | |
… | |
212 | |
220 | |
213 | Put the current process into the ready queue. |
221 | Put the current process into the ready queue. |
214 | |
222 | |
215 | =cut |
223 | =cut |
216 | |
224 | |
217 | sub ready { |
225 | =item $process->cancel |
|
|
226 | |
|
|
227 | Like C<terminate>, but terminates the specified process instead. |
|
|
228 | |
|
|
229 | =cut |
|
|
230 | |
|
|
231 | sub cancel { |
218 | push @ready, $_[0]; |
232 | push @destroy, $_[0]; |
|
|
233 | $manager->ready; |
|
|
234 | &schedule if $current == $_[0]; |
|
|
235 | } |
|
|
236 | |
|
|
237 | =item $oldprio = $process->prio($newprio) |
|
|
238 | |
|
|
239 | Sets the priority of the process. Higher priority processes get run before |
|
|
240 | lower priority processes. Priorities are smalled signed integer (currently |
|
|
241 | -4 .. +3), that you can refer to using PRIO_xxx constants (use the import |
|
|
242 | tag :prio to get then): |
|
|
243 | |
|
|
244 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
|
|
245 | 3 > 1 > 0 > -1 > -3 > -4 |
|
|
246 | |
|
|
247 | # set priority to HIGH |
|
|
248 | current->prio(PRIO_HIGH); |
|
|
249 | |
|
|
250 | The idle coroutine ($Coro::idle) always has a lower priority than any |
|
|
251 | existing coroutine. |
|
|
252 | |
|
|
253 | Changing the priority of the current process will take effect immediately, |
|
|
254 | but changing the priority of processes in the ready queue (but not |
|
|
255 | running) will only take effect after the next schedule (of that |
|
|
256 | process). This is a bug that will be fixed in some future version. |
|
|
257 | |
|
|
258 | =cut |
|
|
259 | |
|
|
260 | sub prio { |
|
|
261 | my $old = $_[0]{prio}; |
|
|
262 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
263 | $old; |
|
|
264 | } |
|
|
265 | |
|
|
266 | =item $newprio = $process->nice($change) |
|
|
267 | |
|
|
268 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
|
|
269 | higher values mean lower priority, just as in unix). |
|
|
270 | |
|
|
271 | =cut |
|
|
272 | |
|
|
273 | sub nice { |
|
|
274 | $_[0]{prio} -= $_[1]; |
219 | } |
275 | } |
220 | |
276 | |
221 | =back |
277 | =back |
222 | |
278 | |
223 | =cut |
279 | =cut |
224 | |
280 | |
225 | 1; |
281 | 1; |
226 | |
282 | |
227 | =head1 BUGS/LIMITATIONS |
283 | =head1 BUGS/LIMITATIONS |
228 | |
284 | |
229 | - could be faster, especially when the core would introduce special |
285 | - you must make very sure that no coro is still active on global destruction. |
230 | support for coroutines (like it does for threads). |
286 | very bad things might happen otherwise (usually segfaults). |
231 | - there is still a memleak on coroutine termination that I could not |
|
|
232 | identify. Could be as small as a single SV. |
|
|
233 | - this module is not well-tested. |
|
|
234 | - if variables or arguments "disappear" (become undef) or become |
|
|
235 | corrupted please contact the author so he cen iron out the |
|
|
236 | remaining bugs. |
|
|
237 | - this module is not thread-safe. You must only ever use this module from |
287 | - this module is not thread-safe. You must only ever use this module from |
238 | the same thread (this requirement might be loosened in the future to |
288 | the same thread (this requirement might be loosened in the future to |
239 | allow per-thread schedulers, but Coro::Satte does not yet allow this). |
289 | allow per-thread schedulers, but Coro::State does not yet allow this). |
240 | |
290 | |
241 | =head1 SEE ALSO |
291 | =head1 SEE ALSO |
242 | |
292 | |
243 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
293 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
244 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. |
294 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
|
|
295 | L<Coro::Handle>, L<Coro::Socket>. |
245 | |
296 | |
246 | =head1 AUTHOR |
297 | =head1 AUTHOR |
247 | |
298 | |
248 | Marc Lehmann <pcg@goof.com> |
299 | Marc Lehmann <pcg@goof.com> |
249 | http://www.goof.com/pcg/marc/ |
300 | http://www.goof.com/pcg/marc/ |