… | |
… | |
30 | |
30 | |
31 | =cut |
31 | =cut |
32 | |
32 | |
33 | package Coro; |
33 | package Coro; |
34 | |
34 | |
|
|
35 | use strict; |
35 | no warnings qw(uninitialized); |
36 | no warnings "uninitialized"; |
36 | |
37 | |
37 | use Coro::State; |
38 | use Coro::State; |
38 | |
39 | |
39 | use base Exporter; |
40 | use base qw(Coro::State Exporter); |
40 | |
41 | |
41 | $VERSION = 0.651; |
42 | our $idle; # idle handler |
|
|
43 | our $main; # main coroutine |
|
|
44 | our $current; # current coroutine |
42 | |
45 | |
|
|
46 | our $VERSION = '3.0'; |
|
|
47 | |
43 | @EXPORT = qw(async cede schedule terminate current); |
48 | our @EXPORT = qw(async cede schedule terminate current); |
44 | %EXPORT_TAGS = ( |
49 | our %EXPORT_TAGS = ( |
45 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
50 | prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
46 | ); |
51 | ); |
47 | @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
52 | our @EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
48 | |
53 | |
49 | { |
54 | { |
50 | my @async; |
55 | my @async; |
51 | my $init; |
56 | my $init; |
52 | |
57 | |
53 | # this way of handling attributes simply is NOT scalable ;() |
58 | # this way of handling attributes simply is NOT scalable ;() |
54 | sub import { |
59 | sub import { |
|
|
60 | no strict 'refs'; |
|
|
61 | |
55 | Coro->export_to_level(1, @_); |
62 | Coro->export_to_level(1, @_); |
|
|
63 | |
56 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
64 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
57 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
65 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
58 | my ($package, $ref) = (shift, shift); |
66 | my ($package, $ref) = (shift, shift); |
59 | my @attrs; |
67 | my @attrs; |
60 | for (@_) { |
68 | for (@_) { |
… | |
… | |
83 | |
91 | |
84 | This coroutine represents the main program. |
92 | This coroutine represents the main program. |
85 | |
93 | |
86 | =cut |
94 | =cut |
87 | |
95 | |
88 | our $main = new Coro; |
96 | $main = new Coro; |
89 | |
97 | |
90 | =item $current (or as function: current) |
98 | =item $current (or as function: current) |
91 | |
99 | |
92 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
100 | The current coroutine (the last coroutine switched to). The initial value |
|
|
101 | is C<$main> (of course). |
|
|
102 | |
|
|
103 | This variable is B<strictly> I<read-only>. It is provided for performance |
|
|
104 | reasons. If performance is not essentiel you are encouraged to use the |
|
|
105 | C<Coro::current> function instead. |
93 | |
106 | |
94 | =cut |
107 | =cut |
95 | |
108 | |
96 | # maybe some other module used Coro::Specific before... |
109 | # maybe some other module used Coro::Specific before... |
97 | if ($current) { |
110 | if ($current) { |
98 | $main->{specific} = $current->{specific}; |
111 | $main->{specific} = $current->{specific}; |
99 | } |
112 | } |
100 | |
113 | |
101 | our $current = $main; |
114 | $current = $main; |
102 | |
115 | |
103 | sub current() { $current } |
116 | sub current() { $current } |
104 | |
117 | |
105 | =item $idle |
118 | =item $idle |
106 | |
119 | |
107 | The coroutine to switch to when no other coroutine is running. The default |
120 | A callback that is called whenever the scheduler finds no ready coroutines |
108 | implementation prints "FATAL: deadlock detected" and exits. |
121 | to run. The default implementation prints "FATAL: deadlock detected" and |
|
|
122 | exits. |
109 | |
123 | |
110 | =cut |
124 | This hook is overwritten by modules such as C<Coro::Timer> and |
|
|
125 | C<Coro::Event> to wait on an external event that hopefully wakes up some |
|
|
126 | coroutine. |
111 | |
127 | |
112 | # should be done using priorities :( |
128 | =cut |
113 | our $idle = new Coro sub { |
129 | |
|
|
130 | $idle = sub { |
114 | print STDERR "FATAL: deadlock detected\n"; |
131 | print STDERR "FATAL: deadlock detected\n"; |
115 | exit(51); |
132 | exit (51); |
116 | }; |
133 | }; |
117 | |
134 | |
118 | # this coroutine is necessary because a coroutine |
135 | # this coroutine is necessary because a coroutine |
119 | # cannot destroy itself. |
136 | # cannot destroy itself. |
120 | my @destroy; |
137 | my @destroy; |
121 | my $manager; |
|
|
122 | $manager = new Coro sub { |
138 | my $manager; $manager = new Coro sub { |
123 | while() { |
139 | while () { |
124 | # by overwriting the state object with the manager we destroy it |
140 | # by overwriting the state object with the manager we destroy it |
125 | # while still being able to schedule this coroutine (in case it has |
141 | # while still being able to schedule this coroutine (in case it has |
126 | # been readied multiple times. this is harmless since the manager |
142 | # been readied multiple times. this is harmless since the manager |
127 | # can be called as many times as neccessary and will always |
143 | # can be called as many times as neccessary and will always |
128 | # remove itself from the runqueue |
144 | # remove itself from the runqueue |
129 | while (@destroy) { |
145 | while (@destroy) { |
130 | my $coro = pop @destroy; |
146 | my $coro = pop @destroy; |
131 | $coro->{status} ||= []; |
147 | $coro->{status} ||= []; |
132 | $_->ready for @{delete $coro->{join} || []}; |
148 | $_->ready for @{delete $coro->{join} || []}; |
133 | $coro->{_coro_state} = $manager->{_coro_state}; |
149 | |
|
|
150 | # the next line destroys the coro state, but keeps the |
|
|
151 | # process itself intact (we basically make it a zombie |
|
|
152 | # process that always runs the manager thread, so it's possible |
|
|
153 | # to transfer() to this process). |
|
|
154 | $coro->_clone_state_from ($manager); |
134 | } |
155 | } |
135 | &schedule; |
156 | &schedule; |
136 | } |
157 | } |
137 | }; |
158 | }; |
138 | |
159 | |
… | |
… | |
150 | |
171 | |
151 | Create a new asynchronous process and return it's process object |
172 | Create a new asynchronous process and return it's process object |
152 | (usually unused). When the sub returns the new process is automatically |
173 | (usually unused). When the sub returns the new process is automatically |
153 | terminated. |
174 | terminated. |
154 | |
175 | |
|
|
176 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
|
|
177 | |
|
|
178 | When the coroutine dies, the program will exit, just as in the main |
|
|
179 | program. |
|
|
180 | |
155 | # create a new coroutine that just prints its arguments |
181 | # create a new coroutine that just prints its arguments |
156 | async { |
182 | async { |
157 | print "@_\n"; |
183 | print "@_\n"; |
158 | } 1,2,3,4; |
184 | } 1,2,3,4; |
159 | |
185 | |
160 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
161 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
162 | |
|
|
163 | =cut |
186 | =cut |
164 | |
187 | |
165 | sub async(&@) { |
188 | sub async(&@) { |
166 | my $pid = new Coro @_; |
189 | my $pid = new Coro @_; |
167 | $manager->ready; # this ensures that the stack is cloned from the manager |
|
|
168 | $pid->ready; |
190 | $pid->ready; |
169 | $pid; |
191 | $pid |
170 | } |
192 | } |
171 | |
193 | |
172 | =item schedule |
194 | =item schedule |
173 | |
195 | |
174 | Calls the scheduler. Please note that the current process will not be put |
196 | Calls the scheduler. Please note that the current process will not be put |
… | |
… | |
185 | |
207 | |
186 | =cut |
208 | =cut |
187 | |
209 | |
188 | =item terminate [arg...] |
210 | =item terminate [arg...] |
189 | |
211 | |
190 | Terminates the current process. |
212 | Terminates the current process with the given status values (see L<cancel>). |
191 | |
|
|
192 | Future versions of this function will allow result arguments. |
|
|
193 | |
213 | |
194 | =cut |
214 | =cut |
195 | |
215 | |
196 | sub terminate { |
216 | sub terminate { |
197 | $current->{status} = [@_]; |
|
|
198 | $current->cancel; |
217 | $current->cancel (@_); |
199 | &schedule; |
|
|
200 | die; # NORETURN |
|
|
201 | } |
218 | } |
202 | |
219 | |
203 | =back |
220 | =back |
204 | |
221 | |
205 | # dynamic methods |
222 | # dynamic methods |
… | |
… | |
215 | Create a new process and return it. When the sub returns the process |
232 | Create a new process and return it. When the sub returns the process |
216 | automatically terminates as if C<terminate> with the returned values were |
233 | 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 |
234 | called. To make the process run you must first put it into the ready queue |
218 | by calling the ready method. |
235 | by calling the ready method. |
219 | |
236 | |
220 | =cut |
237 | Calling C<exit> in a coroutine will not work correctly, so do not do that. |
221 | |
238 | |
|
|
239 | =cut |
|
|
240 | |
222 | sub _newcoro { |
241 | sub _new_coro { |
223 | terminate &{+shift}; |
242 | terminate &{+shift}; |
224 | } |
243 | } |
225 | |
244 | |
226 | sub new { |
245 | sub new { |
227 | my $class = shift; |
246 | my $class = shift; |
228 | bless { |
|
|
229 | _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
|
|
230 | }, $class; |
|
|
231 | } |
|
|
232 | |
247 | |
|
|
248 | $class->SUPER::new (\&_new_coro, @_) |
|
|
249 | } |
|
|
250 | |
233 | =item $process->ready |
251 | =item $success = $process->ready |
234 | |
252 | |
235 | Put the given process into the ready queue. |
253 | Put the given process into the ready queue (according to it's priority) |
|
|
254 | and return true. If the process is already in the ready queue, do nothing |
|
|
255 | and return false. |
236 | |
256 | |
237 | =cut |
257 | =item $is_ready = $process->is_ready |
238 | |
258 | |
|
|
259 | Return wether the process is currently the ready queue or not, |
|
|
260 | |
239 | =item $process->cancel |
261 | =item $process->cancel (arg...) |
240 | |
262 | |
241 | Like C<terminate>, but terminates the specified process instead. |
263 | Terminates the given process and makes it return the given arguments as |
|
|
264 | status (default: the empty list). |
242 | |
265 | |
243 | =cut |
266 | =cut |
244 | |
267 | |
245 | sub cancel { |
268 | sub cancel { |
|
|
269 | my $self = shift; |
|
|
270 | $self->{status} = [@_]; |
246 | push @destroy, $_[0]; |
271 | push @destroy, $self; |
247 | $manager->ready; |
272 | $manager->ready; |
248 | &schedule if $current == $_[0]; |
273 | &schedule if $current == $self; |
249 | } |
274 | } |
250 | |
275 | |
251 | =item $process->join |
276 | =item $process->join |
252 | |
277 | |
253 | Wait until the coroutine terminates and return any values given to the |
278 | 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 |
279 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
255 | processes. |
280 | from multiple processes. |
256 | |
281 | |
257 | =cut |
282 | =cut |
258 | |
283 | |
259 | sub join { |
284 | sub join { |
260 | my $self = shift; |
285 | my $self = shift; |
… | |
… | |
263 | &schedule; |
288 | &schedule; |
264 | } |
289 | } |
265 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
290 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
266 | } |
291 | } |
267 | |
292 | |
268 | =item $oldprio = $process->prio($newprio) |
293 | =item $oldprio = $process->prio ($newprio) |
269 | |
294 | |
270 | Sets (or gets, if the argument is missing) the priority of the |
295 | Sets (or gets, if the argument is missing) the priority of the |
271 | process. Higher priority processes get run before lower priority |
296 | process. Higher priority processes get run before lower priority |
272 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
297 | processes. Priorities are small signed integers (currently -4 .. +3), |
273 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
298 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
274 | to get then): |
299 | to get then): |
275 | |
300 | |
276 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
301 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
277 | 3 > 1 > 0 > -1 > -3 > -4 |
302 | 3 > 1 > 0 > -1 > -3 > -4 |
… | |
… | |
285 | Changing the priority of the current process will take effect immediately, |
310 | Changing the priority of the current process will take effect immediately, |
286 | but changing the priority of processes in the ready queue (but not |
311 | but changing the priority of processes in the ready queue (but not |
287 | running) will only take effect after the next schedule (of that |
312 | running) will only take effect after the next schedule (of that |
288 | process). This is a bug that will be fixed in some future version. |
313 | process). This is a bug that will be fixed in some future version. |
289 | |
314 | |
290 | =cut |
|
|
291 | |
|
|
292 | sub prio { |
|
|
293 | my $old = $_[0]{prio}; |
|
|
294 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
295 | $old; |
|
|
296 | } |
|
|
297 | |
|
|
298 | =item $newprio = $process->nice($change) |
315 | =item $newprio = $process->nice ($change) |
299 | |
316 | |
300 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
317 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
301 | higher values mean lower priority, just as in unix). |
318 | higher values mean lower priority, just as in unix). |
302 | |
319 | |
303 | =cut |
|
|
304 | |
|
|
305 | sub nice { |
|
|
306 | $_[0]{prio} -= $_[1]; |
|
|
307 | } |
|
|
308 | |
|
|
309 | =item $olddesc = $process->desc($newdesc) |
320 | =item $olddesc = $process->desc ($newdesc) |
310 | |
321 | |
311 | Sets (or gets in case the argument is missing) the description for this |
322 | 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. |
323 | process. This is just a free-form string you can associate with a process. |
313 | |
324 | |
314 | =cut |
325 | =cut |
… | |
… | |
325 | |
336 | |
326 | 1; |
337 | 1; |
327 | |
338 | |
328 | =head1 BUGS/LIMITATIONS |
339 | =head1 BUGS/LIMITATIONS |
329 | |
340 | |
330 | - you must make very sure that no coro is still active on global destruction. |
341 | - you must make very sure that no coro is still active on global |
331 | very bad things might happen otherwise (usually segfaults). |
342 | destruction. very bad things might happen otherwise (usually segfaults). |
|
|
343 | |
332 | - this module is not thread-safe. You should only ever use this module from |
344 | - this module is not thread-safe. You should only ever use this module |
333 | the same thread (this requirement might be loosened in the future to |
345 | from the same thread (this requirement might be losened in the future |
334 | allow per-thread schedulers, but Coro::State does not yet allow this). |
346 | to allow per-thread schedulers, but Coro::State does not yet allow |
|
|
347 | this). |
335 | |
348 | |
336 | =head1 SEE ALSO |
349 | =head1 SEE ALSO |
337 | |
350 | |
338 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
351 | Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>. |
339 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
352 | |
340 | L<Coro::Handle>, L<Coro::Socket>. |
353 | Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>. |
|
|
354 | |
|
|
355 | Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>. |
|
|
356 | |
|
|
357 | Embedding: L<Coro:MakeMaker> |
341 | |
358 | |
342 | =head1 AUTHOR |
359 | =head1 AUTHOR |
343 | |
360 | |
344 | Marc Lehmann <pcg@goof.com> |
361 | Marc Lehmann <schmorp@schmorp.de> |
345 | http://www.goof.com/pcg/marc/ |
362 | http://home.schmorp.de/ |
346 | |
363 | |
347 | =cut |
364 | =cut |
348 | |
365 | |