| 1 | =head1 NAME |
1 | =head1 NAME |
| 2 | |
2 | |
| 3 | Coro - create an manage coroutines |
3 | Coro - coroutine process abstraction |
| 4 | |
4 | |
| 5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
| 6 | |
6 | |
| 7 | use Coro; |
7 | use Coro; |
| 8 | |
8 | |
|
|
9 | async { |
|
|
10 | # some asynchronous thread of execution |
|
|
11 | }; |
|
|
12 | |
|
|
13 | # alternatively create an async process like this: |
|
|
14 | |
|
|
15 | sub some_func : Coro { |
|
|
16 | # some more async code |
|
|
17 | } |
|
|
18 | |
|
|
19 | cede; |
|
|
20 | |
| 9 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
| 10 | |
22 | |
|
|
23 | This module collection manages coroutines. Coroutines are similar to |
|
|
24 | threads but don't run in parallel. |
|
|
25 | |
|
|
26 | In this module, coroutines are defined as "callchain + lexical variables |
|
|
27 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
|
|
28 | callchain, it's own set of lexicals and it's own set of perl's most |
|
|
29 | important global variables. |
|
|
30 | |
|
|
31 | =cut |
|
|
32 | |
|
|
33 | package Coro; |
|
|
34 | |
|
|
35 | BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") } |
|
|
36 | |
|
|
37 | use Coro::State; |
|
|
38 | |
|
|
39 | use vars qw($idle $main $current); |
|
|
40 | |
|
|
41 | use base Exporter; |
|
|
42 | |
|
|
43 | $VERSION = 0.8; |
|
|
44 | |
|
|
45 | @EXPORT = qw(async cede schedule terminate 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}}; |
|
|
50 | |
|
|
51 | { |
|
|
52 | my @async; |
|
|
53 | my $init; |
|
|
54 | |
|
|
55 | # this way of handling attributes simply is NOT scalable ;() |
|
|
56 | sub import { |
|
|
57 | Coro->export_to_level(1, @_); |
|
|
58 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
|
|
59 | *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
|
|
60 | my ($package, $ref) = (shift, shift); |
|
|
61 | my @attrs; |
|
|
62 | for (@_) { |
|
|
63 | if ($_ eq "Coro") { |
|
|
64 | push @async, $ref; |
|
|
65 | unless ($init++) { |
|
|
66 | eval q{ |
|
|
67 | sub INIT { |
|
|
68 | &async(pop @async) while @async; |
|
|
69 | } |
|
|
70 | }; |
|
|
71 | } |
|
|
72 | } else { |
|
|
73 | push @attrs, $_; |
|
|
74 | } |
|
|
75 | } |
|
|
76 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
|
|
77 | }; |
|
|
78 | } |
|
|
79 | |
|
|
80 | } |
|
|
81 | |
| 11 | =over 4 |
82 | =over 4 |
| 12 | |
83 | |
| 13 | =cut |
|
|
| 14 | |
|
|
| 15 | package Coro; |
|
|
| 16 | |
|
|
| 17 | BEGIN { |
|
|
| 18 | $VERSION = 0.01; |
|
|
| 19 | |
|
|
| 20 | require XSLoader; |
|
|
| 21 | XSLoader::load Coro, $VERSION; |
|
|
| 22 | } |
|
|
| 23 | |
|
|
| 24 | =item $main |
84 | =item $main |
| 25 | |
85 | |
| 26 | This coroutine represents the main program. |
86 | This coroutine represents the main program. |
| 27 | |
87 | |
| 28 | =item $current |
88 | =cut |
|
|
89 | |
|
|
90 | $main = new Coro; |
|
|
91 | |
|
|
92 | =item $current (or as function: current) |
| 29 | |
93 | |
| 30 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
94 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
| 31 | |
95 | |
| 32 | =cut |
96 | =cut |
| 33 | |
97 | |
| 34 | $main = $current = _newprocess { |
98 | # maybe some other module used Coro::Specific before... |
| 35 | # never being called |
99 | if ($current) { |
|
|
100 | $main->{specific} = $current->{specific}; |
|
|
101 | } |
|
|
102 | |
|
|
103 | $current = $main; |
|
|
104 | |
|
|
105 | sub current() { $current } |
|
|
106 | |
|
|
107 | =item $idle |
|
|
108 | |
|
|
109 | The coroutine to switch to when no other coroutine is running. The default |
|
|
110 | implementation prints "FATAL: deadlock detected" and exits. |
|
|
111 | |
|
|
112 | =cut |
|
|
113 | |
|
|
114 | # should be done using priorities :( |
|
|
115 | $idle = new Coro sub { |
|
|
116 | print STDERR "FATAL: deadlock detected\n"; |
|
|
117 | exit(51); |
| 36 | }; |
118 | }; |
| 37 | |
119 | |
| 38 | =item $error, $error_msg, $error_coro |
120 | # this coroutine is necessary because a coroutine |
| 39 | |
121 | # cannot destroy itself. |
| 40 | This coroutine will be called on fatal errors. C<$error_msg> and |
122 | my @destroy; |
| 41 | C<$error_coro> return the error message and the error-causing coroutine, |
123 | my $manager; |
| 42 | respectively. |
124 | $manager = new Coro sub { |
| 43 | |
125 | while() { |
| 44 | =cut |
126 | # by overwriting the state object with the manager we destroy it |
| 45 | |
127 | # while still being able to schedule this coroutine (in case it has |
| 46 | $error_msg = |
128 | # been readied multiple times. this is harmless since the manager |
| 47 | $error_coro = undef; |
129 | # can be called as many times as neccessary and will always |
| 48 | |
130 | # remove itself from the runqueue |
| 49 | $error = _newprocess { |
131 | while (@destroy) { |
| 50 | print STDERR "FATAL: $error_msg, program aborted\n"; |
132 | my $coro = pop @destroy; |
| 51 | exit 250; |
133 | $coro->{status} ||= []; |
|
|
134 | $_->ready for @{delete $coro->{join} || []}; |
|
|
135 | $coro->{_coro_state} = $manager->{_coro_state}; |
|
|
136 | } |
|
|
137 | &schedule; |
|
|
138 | } |
| 52 | }; |
139 | }; |
| 53 | |
140 | |
| 54 | =item $coro = new $coderef [, @args] |
141 | # static methods. not really. |
| 55 | |
142 | |
| 56 | Create a new coroutine and return it. The first C<resume> call to this |
143 | =back |
| 57 | coroutine will start execution at the given coderef. If it returns it |
|
|
| 58 | should return a coroutine to switch to. If, after returning, the coroutine |
|
|
| 59 | is C<resume>d again it starts execution again at the givne coderef. |
|
|
| 60 | |
144 | |
|
|
145 | =head2 STATIC METHODS |
|
|
146 | |
|
|
147 | Static methods are actually functions that operate on the current process only. |
|
|
148 | |
|
|
149 | =over 4 |
|
|
150 | |
|
|
151 | =item async { ... } [@args...] |
|
|
152 | |
|
|
153 | Create a new asynchronous process and return it's process object |
|
|
154 | (usually unused). When the sub returns the new process is automatically |
|
|
155 | terminated. |
|
|
156 | |
|
|
157 | # create a new coroutine that just prints its arguments |
|
|
158 | async { |
|
|
159 | print "@_\n"; |
|
|
160 | } 1,2,3,4; |
|
|
161 | |
|
|
162 | The coderef you submit MUST NOT be a closure that refers to variables |
|
|
163 | in an outer scope. This does NOT work. Pass arguments into it instead. |
|
|
164 | |
| 61 | =cut |
165 | =cut |
|
|
166 | |
|
|
167 | sub async(&@) { |
|
|
168 | my $pid = new Coro @_; |
|
|
169 | $manager->ready; # this ensures that the stack is cloned from the manager |
|
|
170 | $pid->ready; |
|
|
171 | $pid; |
|
|
172 | } |
|
|
173 | |
|
|
174 | =item schedule |
|
|
175 | |
|
|
176 | Calls the scheduler. Please note that the current process will not be put |
|
|
177 | into the ready queue, so calling this function usually means you will |
|
|
178 | never be called again. |
|
|
179 | |
|
|
180 | =cut |
|
|
181 | |
|
|
182 | =item cede |
|
|
183 | |
|
|
184 | "Cede" to other processes. This function puts the current process into the |
|
|
185 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
186 | current "timeslice" to other coroutines of the same or higher priority. |
|
|
187 | |
|
|
188 | =cut |
|
|
189 | |
|
|
190 | =item terminate [arg...] |
|
|
191 | |
|
|
192 | Terminates the current process. |
|
|
193 | |
|
|
194 | Future versions of this function will allow result arguments. |
|
|
195 | |
|
|
196 | =cut |
|
|
197 | |
|
|
198 | sub terminate { |
|
|
199 | $current->{status} = [@_]; |
|
|
200 | $current->cancel; |
|
|
201 | &schedule; |
|
|
202 | die; # NORETURN |
|
|
203 | } |
|
|
204 | |
|
|
205 | =back |
|
|
206 | |
|
|
207 | # dynamic methods |
|
|
208 | |
|
|
209 | =head2 PROCESS METHODS |
|
|
210 | |
|
|
211 | These are the methods you can call on process objects. |
|
|
212 | |
|
|
213 | =over 4 |
|
|
214 | |
|
|
215 | =item new Coro \&sub [, @args...] |
|
|
216 | |
|
|
217 | Create a new process and return it. When the sub returns the process |
|
|
218 | automatically terminates as if C<terminate> with the returned values were |
|
|
219 | called. To make the process run you must first put it into the ready queue |
|
|
220 | by calling the ready method. |
|
|
221 | |
|
|
222 | =cut |
|
|
223 | |
|
|
224 | sub _newcoro { |
|
|
225 | terminate &{+shift}; |
|
|
226 | } |
| 62 | |
227 | |
| 63 | sub new { |
228 | sub new { |
| 64 | my $class = $_[0]; |
229 | my $class = shift; |
| 65 | my $proc = $_[1]; |
230 | bless { |
| 66 | bless _newprocess { |
231 | _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
| 67 | do { |
|
|
| 68 | eval { &$proc->resume }; |
|
|
| 69 | if ($@) { |
|
|
| 70 | ($error_msg, $error_coro) = ($@, $current); |
|
|
| 71 | $error->resume; |
|
|
| 72 | } |
|
|
| 73 | } while (); |
|
|
| 74 | }, $class; |
232 | }, $class; |
| 75 | } |
233 | } |
| 76 | |
234 | |
| 77 | =item $coro->resume |
235 | =item $process->ready |
| 78 | |
236 | |
| 79 | Resume execution at the given coroutine. |
237 | Put the given process into the ready queue. |
| 80 | |
238 | |
| 81 | =cut |
239 | =cut |
| 82 | |
240 | |
| 83 | my $prev; |
241 | =item $process->cancel |
| 84 | |
242 | |
| 85 | sub resume { |
243 | Like C<terminate>, but terminates the specified process instead. |
| 86 | $prev = $current; $current = $_[0]; |
244 | |
| 87 | _transfer($prev, $current); |
245 | =cut |
|
|
246 | |
|
|
247 | sub cancel { |
|
|
248 | push @destroy, $_[0]; |
|
|
249 | $manager->ready; |
|
|
250 | &schedule if $current == $_[0]; |
| 88 | } |
251 | } |
|
|
252 | |
|
|
253 | =item $process->join |
|
|
254 | |
|
|
255 | Wait until the coroutine terminates and return any values given to the |
|
|
256 | C<terminate> function. C<join> can be called multiple times from multiple |
|
|
257 | processes. |
|
|
258 | |
|
|
259 | =cut |
|
|
260 | |
|
|
261 | sub join { |
|
|
262 | my $self = shift; |
|
|
263 | unless ($self->{status}) { |
|
|
264 | push @{$self->{join}}, $current; |
|
|
265 | &schedule; |
|
|
266 | } |
|
|
267 | wantarray ? @{$self->{status}} : $self->{status}[0]; |
|
|
268 | } |
|
|
269 | |
|
|
270 | =item $oldprio = $process->prio($newprio) |
|
|
271 | |
|
|
272 | Sets (or gets, if the argument is missing) the priority of the |
|
|
273 | process. Higher priority processes get run before lower priority |
|
|
274 | processes. Priorities are small signed integers (currently -4 .. +3), |
|
|
275 | that you can refer to using PRIO_xxx constants (use the import tag :prio |
|
|
276 | to get then): |
|
|
277 | |
|
|
278 | PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
|
|
279 | 3 > 1 > 0 > -1 > -3 > -4 |
|
|
280 | |
|
|
281 | # set priority to HIGH |
|
|
282 | current->prio(PRIO_HIGH); |
|
|
283 | |
|
|
284 | The idle coroutine ($Coro::idle) always has a lower priority than any |
|
|
285 | existing coroutine. |
|
|
286 | |
|
|
287 | Changing the priority of the current process will take effect immediately, |
|
|
288 | but changing the priority of processes in the ready queue (but not |
|
|
289 | running) will only take effect after the next schedule (of that |
|
|
290 | process). This is a bug that will be fixed in some future version. |
|
|
291 | |
|
|
292 | =cut |
|
|
293 | |
|
|
294 | sub prio { |
|
|
295 | my $old = $_[0]{prio}; |
|
|
296 | $_[0]{prio} = $_[1] if @_ > 1; |
|
|
297 | $old; |
|
|
298 | } |
|
|
299 | |
|
|
300 | =item $newprio = $process->nice($change) |
|
|
301 | |
|
|
302 | Similar to C<prio>, but subtract the given value from the priority (i.e. |
|
|
303 | higher values mean lower priority, just as in unix). |
|
|
304 | |
|
|
305 | =cut |
|
|
306 | |
|
|
307 | sub nice { |
|
|
308 | $_[0]{prio} -= $_[1]; |
|
|
309 | } |
|
|
310 | |
|
|
311 | =item $olddesc = $process->desc($newdesc) |
|
|
312 | |
|
|
313 | Sets (or gets in case the argument is missing) the description for this |
|
|
314 | process. This is just a free-form string you can associate with a process. |
|
|
315 | |
|
|
316 | =cut |
|
|
317 | |
|
|
318 | sub desc { |
|
|
319 | my $old = $_[0]{desc}; |
|
|
320 | $_[0]{desc} = $_[1] if @_ > 1; |
|
|
321 | $old; |
|
|
322 | } |
|
|
323 | |
|
|
324 | =back |
|
|
325 | |
|
|
326 | =cut |
| 89 | |
327 | |
| 90 | 1; |
328 | 1; |
| 91 | |
329 | |
| 92 | =back |
330 | =head1 BUGS/LIMITATIONS |
| 93 | |
331 | |
| 94 | =head1 BUGS |
332 | - you must make very sure that no coro is still active on global |
|
|
333 | destruction. very bad things might happen otherwise (usually segfaults). |
| 95 | |
334 | |
| 96 | This module has not yet been extensively tested. |
335 | - this module is not thread-safe. You should only ever use this module |
|
|
336 | from the same thread (this requirement might be losened in the future |
|
|
337 | to allow per-thread schedulers, but Coro::State does not yet allow |
|
|
338 | this). |
|
|
339 | |
|
|
340 | =head1 SEE ALSO |
|
|
341 | |
|
|
342 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
|
|
343 | L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>, |
|
|
344 | L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>. |
| 97 | |
345 | |
| 98 | =head1 AUTHOR |
346 | =head1 AUTHOR |
| 99 | |
347 | |
| 100 | Marc Lehmann <pcg@goof.com> |
348 | Marc Lehmann <pcg@goof.com> |
| 101 | http://www.goof.com/pcg/marc/ |
349 | http://www.goof.com/pcg/marc/ |
