… | |
… | |
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 |
28 | In this module, coroutines are defined as "callchain + lexical variables |
29 | + @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's |
29 | + @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
30 | own set of lexicals and it's own set of perl's most important global |
30 | callchain, it's own set of lexicals and it's own set of perl's most |
31 | variables. |
31 | important global variables. |
32 | |
|
|
33 | WARNING: When using this module, make sure that, at program end, no |
|
|
34 | coroutines are still running OR just call exit before falling off the |
|
|
35 | end. The reason for this is that some coroutine of yours might have called |
|
|
36 | into a C function, and falling off the end of main:: results in returning |
|
|
37 | to that C function instead if to the main C interpreter. |
|
|
38 | |
32 | |
39 | =cut |
33 | =cut |
40 | |
34 | |
41 | package Coro; |
35 | package Coro; |
42 | |
36 | |
43 | use Coro::State; |
37 | use Coro::State; |
44 | |
38 | |
45 | use base Exporter; |
39 | use base Exporter; |
46 | |
40 | |
47 | $VERSION = 0.10; |
41 | $VERSION = 0.12; |
48 | |
42 | |
49 | @EXPORT = qw(async yield schedule terminate current); |
43 | @EXPORT = qw(async cede schedule terminate current); |
50 | @EXPORT_OK = qw($current); |
44 | @EXPORT_OK = qw($current); |
51 | |
45 | |
52 | { |
46 | { |
53 | my @async; |
47 | my @async; |
54 | |
48 | |
… | |
… | |
109 | our $idle = new Coro sub { |
103 | our $idle = new Coro sub { |
110 | print STDERR "FATAL: deadlock detected\n"; |
104 | print STDERR "FATAL: deadlock detected\n"; |
111 | exit(51); |
105 | exit(51); |
112 | }; |
106 | }; |
113 | |
107 | |
|
|
108 | # this coroutine is necessary because a coroutine |
|
|
109 | # cannot destroy itself. |
|
|
110 | my @destroy; |
|
|
111 | my $manager = new Coro sub { |
|
|
112 | while() { |
|
|
113 | delete ((pop @destroy)->{_coro_state}) while @destroy; |
|
|
114 | &schedule; |
|
|
115 | } |
|
|
116 | }; |
|
|
117 | |
114 | # we really need priorities... |
118 | # we really need priorities... |
115 | my @ready; # the ready queue. hehe, rather broken ;) |
119 | my @ready; # the ready queue. hehe, rather broken ;) |
116 | |
120 | |
117 | # static methods. not really. |
121 | # static methods. not really. |
118 | |
122 | |
… | |
… | |
138 | |
142 | |
139 | =cut |
143 | =cut |
140 | |
144 | |
141 | sub async(&@) { |
145 | sub async(&@) { |
142 | my $pid = new Coro @_; |
146 | my $pid = new Coro @_; |
|
|
147 | $manager->ready; # this ensures that the stack is cloned from the manager |
143 | $pid->ready; |
148 | $pid->ready; |
144 | $pid; |
149 | $pid; |
145 | } |
150 | } |
146 | |
151 | |
147 | =item schedule |
152 | =item schedule |
… | |
… | |
158 | # should be done using priorities :( |
163 | # should be done using priorities :( |
159 | ($prev, $current) = ($current, shift @ready || $idle); |
164 | ($prev, $current) = ($current, shift @ready || $idle); |
160 | Coro::State::transfer($prev, $current); |
165 | Coro::State::transfer($prev, $current); |
161 | } |
166 | } |
162 | |
167 | |
163 | =item yield |
168 | =item cede |
164 | |
169 | |
165 | Yield to other processes. This function puts the current process into the |
170 | "Cede" to other processes. This function puts the current process into the |
166 | ready queue and calls C<schedule>. |
171 | ready queue and calls C<schedule>, which has the effect of giving up the |
|
|
172 | current "timeslice" to other coroutines of the same or higher priority. |
167 | |
173 | |
168 | =cut |
174 | =cut |
169 | |
175 | |
170 | sub yield { |
176 | sub cede { |
171 | $current->ready; |
177 | $current->ready; |
172 | &schedule; |
178 | &schedule; |
173 | } |
179 | } |
174 | |
180 | |
175 | =item terminate |
181 | =item terminate |
… | |
… | |
179 | Future versions of this function will allow result arguments. |
185 | Future versions of this function will allow result arguments. |
180 | |
186 | |
181 | =cut |
187 | =cut |
182 | |
188 | |
183 | sub terminate { |
189 | sub terminate { |
184 | $current->{_results} = [@_]; |
190 | push @destroy, $current; |
185 | delete $current->{_coro_state}; |
191 | $manager->ready; |
186 | &schedule; |
192 | &schedule; |
|
|
193 | # NORETURN |
187 | } |
194 | } |
188 | |
195 | |
189 | =back |
196 | =back |
190 | |
197 | |
191 | # dynamic methods |
198 | # dynamic methods |