… | |
… | |
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.05; |
41 | $VERSION = 0.12; |
37 | |
42 | |
38 | @EXPORT = qw(async yield schedule terminate); |
43 | @EXPORT = qw(async cede schedule terminate current); |
39 | @EXPORT_OK = qw($current); |
44 | @EXPORT_OK = qw($current); |
40 | |
45 | |
41 | { |
46 | { |
42 | use subs 'async'; |
|
|
43 | |
|
|
44 | my @async; |
47 | my @async; |
|
|
48 | my $init; |
45 | |
49 | |
46 | # this way of handling attributes simply is NOT scalable ;() |
50 | # this way of handling attributes simply is NOT scalable ;() |
47 | sub import { |
51 | sub import { |
48 | Coro->export_to_level(1, @_); |
52 | Coro->export_to_level(1, @_); |
49 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
53 | my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
… | |
… | |
51 | my ($package, $ref) = (shift, shift); |
55 | my ($package, $ref) = (shift, shift); |
52 | my @attrs; |
56 | my @attrs; |
53 | for (@_) { |
57 | for (@_) { |
54 | if ($_ eq "Coro") { |
58 | if ($_ eq "Coro") { |
55 | push @async, $ref; |
59 | push @async, $ref; |
|
|
60 | unless ($init++) { |
|
|
61 | eval q{ |
|
|
62 | sub INIT { |
|
|
63 | &async(pop @async) while @async; |
|
|
64 | } |
|
|
65 | }; |
|
|
66 | } |
56 | } else { |
67 | } else { |
57 | push @attrs, @_; |
68 | push @attrs, $_; |
58 | } |
69 | } |
59 | } |
70 | } |
60 | return $old ? $old->($package, $name, @attrs) : @attrs; |
71 | return $old ? $old->($package, $ref, @attrs) : @attrs; |
61 | }; |
72 | }; |
62 | } |
73 | } |
63 | |
74 | |
64 | sub INIT { |
|
|
65 | async pop @async while @async; |
|
|
66 | } |
|
|
67 | } |
75 | } |
68 | |
76 | |
69 | =item $main |
77 | =item $main |
70 | |
78 | |
71 | This coroutine represents the main program. |
79 | This coroutine represents the main program. |
72 | |
80 | |
73 | =cut |
81 | =cut |
74 | |
82 | |
75 | our $main = new Coro; |
83 | our $main = new Coro; |
76 | |
84 | |
77 | =item $current |
85 | =item $current (or as function: current) |
78 | |
86 | |
79 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
87 | The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
80 | |
88 | |
81 | =cut |
89 | =cut |
82 | |
90 | |
… | |
… | |
84 | if ($current) { |
92 | if ($current) { |
85 | $main->{specific} = $current->{specific}; |
93 | $main->{specific} = $current->{specific}; |
86 | } |
94 | } |
87 | |
95 | |
88 | our $current = $main; |
96 | our $current = $main; |
|
|
97 | |
|
|
98 | sub current() { $current } |
89 | |
99 | |
90 | =item $idle |
100 | =item $idle |
91 | |
101 | |
92 | The coroutine to switch to when no other coroutine is running. The default |
102 | The coroutine to switch to when no other coroutine is running. The default |
93 | implementation prints "FATAL: deadlock detected" and exits. |
103 | implementation prints "FATAL: deadlock detected" and exits. |
… | |
… | |
98 | our $idle = new Coro sub { |
108 | our $idle = new Coro sub { |
99 | print STDERR "FATAL: deadlock detected\n"; |
109 | print STDERR "FATAL: deadlock detected\n"; |
100 | exit(51); |
110 | exit(51); |
101 | }; |
111 | }; |
102 | |
112 | |
|
|
113 | # this coroutine is necessary because a coroutine |
|
|
114 | # cannot destroy itself. |
|
|
115 | my @destroy; |
|
|
116 | my $manager = new Coro sub { |
|
|
117 | while() { |
|
|
118 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
|
|
119 | &schedule; |
|
|
120 | } |
|
|
121 | }; |
|
|
122 | |
103 | # we really need priorities... |
123 | # we really need priorities... |
104 | ## my @ready; #d# |
|
|
105 | our @ready = (); # the ready queue. hehe, rather broken ;) |
124 | my @ready; # the ready queue. hehe, rather broken ;) |
106 | |
125 | |
107 | # static methods. not really. |
126 | # static methods. not really. |
108 | |
127 | |
109 | =head2 STATIC METHODS |
128 | =head2 STATIC METHODS |
110 | |
129 | |
… | |
… | |
128 | |
147 | |
129 | =cut |
148 | =cut |
130 | |
149 | |
131 | sub async(&@) { |
150 | sub async(&@) { |
132 | my $pid = new Coro @_; |
151 | my $pid = new Coro @_; |
|
|
152 | $manager->ready; # this ensures that the stack is cloned from the manager |
133 | $pid->ready; |
153 | $pid->ready; |
134 | $pid; |
154 | $pid; |
135 | } |
155 | } |
136 | |
156 | |
137 | =item schedule |
157 | =item schedule |
… | |
… | |
148 | # should be done using priorities :( |
168 | # should be done using priorities :( |
149 | ($prev, $current) = ($current, shift @ready || $idle); |
169 | ($prev, $current) = ($current, shift @ready || $idle); |
150 | Coro::State::transfer($prev, $current); |
170 | Coro::State::transfer($prev, $current); |
151 | } |
171 | } |
152 | |
172 | |
153 | =item yield |
173 | =item cede |
154 | |
174 | |
155 | Yield to other processes. This function puts the current process into the |
175 | "Cede" to other processes. This function puts the current process into the |
156 | ready queue and calls C<schedule>. |
176 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
177 | current "timeslice" to other coroutines of the same or higher priority. |
157 | |
178 | |
158 | =cut |
179 | =cut |
159 | |
180 | |
160 | sub yield { |
181 | sub cede { |
161 | $current->ready; |
182 | $current->ready; |
162 | &schedule; |
183 | &schedule; |
163 | } |
184 | } |
164 | |
185 | |
165 | =item terminate |
186 | =item terminate |
… | |
… | |
169 | Future versions of this function will allow result arguments. |
190 | Future versions of this function will allow result arguments. |
170 | |
191 | |
171 | =cut |
192 | =cut |
172 | |
193 | |
173 | sub terminate { |
194 | sub terminate { |
174 | $current->{_results} = [@_]; |
195 | push @destroy, $current; |
|
|
196 | $manager->ready; |
175 | &schedule; |
197 | &schedule; |
|
|
198 | # NORETURN |
176 | } |
199 | } |
177 | |
200 | |
178 | =back |
201 | =back |
179 | |
202 | |
180 | # dynamic methods |
203 | # dynamic methods |
… | |
… | |
221 | |
244 | |
222 | =cut |
245 | =cut |
223 | |
246 | |
224 | 1; |
247 | 1; |
225 | |
248 | |
226 | =head1 BUGS |
249 | =head1 BUGS/LIMITATIONS |
227 | |
250 | |
228 | - could be faster, especially when the core would introduce special |
251 | - could be faster, especially when the core would introduce special |
229 | support for coroutines (like it does for threads). |
252 | support for coroutines (like it does for threads). |
230 | - there is still a memleak on coroutine termination that I could not |
253 | - there is still a memleak on coroutine termination that I could not |
231 | identify. Could be as small as a single SV. |
254 | identify. Could be as small as a single SV. |
232 | - this module is not well-tested. |
255 | - this module is not well-tested. |
|
|
256 | - if variables or arguments "disappear" (become undef) or become |
|
|
257 | corrupted please contact the author so he cen iron out the |
|
|
258 | remaining bugs. |
|
|
259 | - this module is not thread-safe. You must only ever use this module from |
|
|
260 | the same thread (this requirement might be loosened in the future to |
|
|
261 | allow per-thread schedulers, but Coro::State does not yet allow this). |
233 | |
262 | |
234 | =head1 SEE ALSO |
263 | =head1 SEE ALSO |
235 | |
264 | |
236 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
265 | L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
237 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. |
266 | L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
|
|
267 | L<Coro::Handle>, L<Coro::Socket>. |
238 | |
268 | |
239 | =head1 AUTHOR |
269 | =head1 AUTHOR |
240 | |
270 | |
241 | Marc Lehmann <pcg@goof.com> |
271 | Marc Lehmann <pcg@goof.com> |
242 | http://www.goof.com/pcg/marc/ |
272 | http://www.goof.com/pcg/marc/ |