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