… | |
… | |
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 Exporter::; |
40 | |
41 | |
41 | $VERSION = 0.52; |
42 | our $idle; # idle coroutine |
|
|
43 | our $main; # main coroutine |
|
|
44 | our $current; # current coroutine |
42 | |
45 | |
|
|
46 | our $VERSION = '2.1'; |
|
|
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 (@_) { |
… | |
… | |
75 | }; |
83 | }; |
76 | } |
84 | } |
77 | |
85 | |
78 | } |
86 | } |
79 | |
87 | |
|
|
88 | =over 4 |
|
|
89 | |
80 | =item $main |
90 | =item $main |
81 | |
91 | |
82 | This coroutine represents the main program. |
92 | This coroutine represents the main program. |
83 | |
93 | |
84 | =cut |
94 | =cut |
85 | |
95 | |
86 | our $main = new Coro; |
96 | $main = new Coro; |
87 | |
97 | |
88 | =item $current (or as function: current) |
98 | =item $current (or as function: current) |
89 | |
99 | |
90 | 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 is C<$main> (of course). |
91 | |
101 | |
… | |
… | |
94 | # maybe some other module used Coro::Specific before... |
104 | # maybe some other module used Coro::Specific before... |
95 | if ($current) { |
105 | if ($current) { |
96 | $main->{specific} = $current->{specific}; |
106 | $main->{specific} = $current->{specific}; |
97 | } |
107 | } |
98 | |
108 | |
99 | our $current = $main; |
109 | $current = $main; |
100 | |
110 | |
101 | sub current() { $current } |
111 | sub current() { $current } |
102 | |
112 | |
103 | =item $idle |
113 | =item $idle |
104 | |
114 | |
… | |
… | |
106 | implementation prints "FATAL: deadlock detected" and exits. |
116 | implementation prints "FATAL: deadlock detected" and exits. |
107 | |
117 | |
108 | =cut |
118 | =cut |
109 | |
119 | |
110 | # should be done using priorities :( |
120 | # should be done using priorities :( |
111 | our $idle = new Coro sub { |
121 | $idle = new Coro sub { |
112 | print STDERR "FATAL: deadlock detected\n"; |
122 | print STDERR "FATAL: deadlock detected\n"; |
113 | exit(51); |
123 | exit(51); |
114 | }; |
124 | }; |
115 | |
125 | |
116 | # this coroutine is necessary because a coroutine |
126 | # this coroutine is necessary because a coroutine |
117 | # cannot destroy itself. |
127 | # cannot destroy itself. |
118 | my @destroy; |
128 | my @destroy; |
119 | my $manager; |
129 | my $manager; |
120 | $manager = new Coro sub { |
130 | $manager = new Coro sub { |
121 | while() { |
131 | while () { |
122 | # by overwriting the state object with the manager we destroy it |
132 | # by overwriting the state object with the manager we destroy it |
123 | # while still being able to schedule this coroutine (in case it has |
133 | # while still being able to schedule this coroutine (in case it has |
124 | # been readied multiple times. this is harmless since the manager |
134 | # been readied multiple times. this is harmless since the manager |
125 | # can be called as many times as neccessary and will always |
135 | # can be called as many times as neccessary and will always |
126 | # remove itself from the runqueue |
136 | # remove itself from the runqueue |
127 | while (@destroy) { |
137 | while (@destroy) { |
128 | my $coro = pop @destroy; |
138 | my $coro = pop @destroy; |
129 | $coro->{status} ||= []; |
139 | $coro->{status} ||= []; |
130 | $_->ready for @{delete $coro->{join} || []}; |
140 | $_->ready for @{delete $coro->{join} || []}; |
|
|
141 | |
|
|
142 | # the next line destroys the _coro_state, but keeps the |
|
|
143 | # process itself intact (we basically make it a zombie |
|
|
144 | # process that always runs the manager thread, so it's possible |
|
|
145 | # to transfer() to this process). |
131 | $coro->{_coro_state} = $manager->{_coro_state}; |
146 | $coro->{_coro_state} = $manager->{_coro_state}; |
132 | } |
147 | } |
133 | &schedule; |
148 | &schedule; |
134 | } |
149 | } |
135 | }; |
150 | }; |
136 | |
151 | |
137 | # static methods. not really. |
152 | # static methods. not really. |
138 | |
153 | |
|
|
154 | =back |
|
|
155 | |
139 | =head2 STATIC METHODS |
156 | =head2 STATIC METHODS |
140 | |
157 | |
141 | Static methods are actually functions that operate on the current process only. |
158 | Static methods are actually functions that operate on the current process only. |
142 | |
159 | |
143 | =over 4 |
160 | =over 4 |
… | |
… | |
145 | =item async { ... } [@args...] |
162 | =item async { ... } [@args...] |
146 | |
163 | |
147 | Create a new asynchronous process and return it's process object |
164 | Create a new asynchronous process and return it's process object |
148 | (usually unused). When the sub returns the new process is automatically |
165 | (usually unused). When the sub returns the new process is automatically |
149 | terminated. |
166 | terminated. |
|
|
167 | |
|
|
168 | When the coroutine dies, the program will exit, just as in the main |
|
|
169 | program. |
150 | |
170 | |
151 | # create a new coroutine that just prints its arguments |
171 | # create a new coroutine that just prints its arguments |
152 | async { |
172 | async { |
153 | print "@_\n"; |
173 | print "@_\n"; |
154 | } 1,2,3,4; |
174 | } 1,2,3,4; |
155 | |
|
|
156 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
157 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
158 | |
175 | |
159 | =cut |
176 | =cut |
160 | |
177 | |
161 | sub async(&@) { |
178 | sub async(&@) { |
162 | my $pid = new Coro @_; |
179 | my $pid = new Coro @_; |
… | |
… | |
181 | |
198 | |
182 | =cut |
199 | =cut |
183 | |
200 | |
184 | =item terminate [arg...] |
201 | =item terminate [arg...] |
185 | |
202 | |
186 | Terminates the current process. |
203 | Terminates the current process with the given status values (see L<cancel>). |
187 | |
|
|
188 | Future versions of this function will allow result arguments. |
|
|
189 | |
204 | |
190 | =cut |
205 | =cut |
191 | |
206 | |
192 | sub terminate { |
207 | sub terminate { |
193 | $current->{status} = [@_]; |
|
|
194 | $current->cancel; |
208 | $current->cancel (@_); |
195 | &schedule; |
|
|
196 | die; # NORETURN |
|
|
197 | } |
209 | } |
198 | |
210 | |
199 | =back |
211 | =back |
200 | |
212 | |
201 | # dynamic methods |
213 | # dynamic methods |
… | |
… | |
230 | |
242 | |
231 | Put the given process into the ready queue. |
243 | Put the given process into the ready queue. |
232 | |
244 | |
233 | =cut |
245 | =cut |
234 | |
246 | |
235 | =item $process->cancel |
247 | =item $process->cancel (arg...) |
236 | |
248 | |
237 | Like C<terminate>, but terminates the specified process instead. |
249 | Terminates the given process and makes it return the given arguments as |
|
|
250 | status (default: the empty list). |
238 | |
251 | |
239 | =cut |
252 | =cut |
240 | |
253 | |
241 | sub cancel { |
254 | sub cancel { |
|
|
255 | my $self = shift; |
|
|
256 | $self->{status} = [@_]; |
242 | push @destroy, $_[0]; |
257 | push @destroy, $self; |
243 | $manager->ready; |
258 | $manager->ready; |
244 | &schedule if $current == $_[0]; |
259 | &schedule if $current == $self; |
245 | } |
260 | } |
246 | |
261 | |
247 | =item $process->join |
262 | =item $process->join |
248 | |
263 | |
249 | Wait until the coroutine terminates and return any values given to the |
264 | Wait until the coroutine terminates and return any values given to the |
250 | C<terminate> function. C<join> can be called multiple times from multiple |
265 | C<terminate> or C<cancel> functions. C<join> can be called multiple times |
251 | processes. |
266 | from multiple processes. |
252 | |
267 | |
253 | =cut |
268 | =cut |
254 | |
269 | |
255 | sub join { |
270 | sub join { |
256 | my $self = shift; |
271 | my $self = shift; |
… | |
… | |
263 | |
278 | |
264 | =item $oldprio = $process->prio($newprio) |
279 | =item $oldprio = $process->prio($newprio) |
265 | |
280 | |
266 | Sets (or gets, if the argument is missing) the priority of the |
281 | Sets (or gets, if the argument is missing) the priority of the |
267 | process. Higher priority processes get run before lower priority |
282 | process. Higher priority processes get run before lower priority |
268 | processes. Priorities are smalled signed integer (currently -4 .. +3), |
283 | processes. Priorities are small signed integers (currently -4 .. +3), |
269 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
284 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
270 | to get then): |
285 | to get then): |
271 | |
286 | |
272 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
287 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
273 | 3 > 1 > 0 > -1 > -3 > -4 |
288 | 3 > 1 > 0 > -1 > -3 > -4 |
… | |
… | |
321 | |
336 | |
322 | 1; |
337 | 1; |
323 | |
338 | |
324 | =head1 BUGS/LIMITATIONS |
339 | =head1 BUGS/LIMITATIONS |
325 | |
340 | |
326 | - 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 |
327 | very bad things might happen otherwise (usually segfaults). |
342 | destruction. very bad things might happen otherwise (usually segfaults). |
|
|
343 | |
328 | - 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 |
329 | 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 |
330 | 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). |
331 | |
348 | |
332 | =head1 SEE ALSO |
349 | =head1 SEE ALSO |
333 | |
350 | |
334 | 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>. |
335 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
352 | |
336 | 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> |
337 | |
358 | |
338 | =head1 AUTHOR |
359 | =head1 AUTHOR |
339 | |
360 | |
340 | Marc Lehmann <pcg@goof.com> |
361 | Marc Lehmann <schmorp@schmorp.de> |
341 | http://www.goof.com/pcg/marc/ |
362 | http://home.schmorp.de/ |
342 | |
363 | |
343 | =cut |
364 | =cut |
344 | |
365 | |