1 |
=head1 NAME |
2 |
|
3 |
Coro - coroutine process abstraction |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use Coro; |
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 |
yield; |
20 |
|
21 |
=head1 DESCRIPTION |
22 |
|
23 |
This module collection manages coroutines. Coroutines are similar to |
24 |
Threads but don't run in parallel. |
25 |
|
26 |
This module is still experimental, see the BUGS section below. |
27 |
|
28 |
In this module, coroutines are defined as "callchain + lexical variables |
29 |
+ @_ + $_ + $@ + $^W), that is, a coroutine has it's own callchain, it's |
30 |
own set of lexicals and it's own set of perl's most important global |
31 |
variables. |
32 |
|
33 |
=cut |
34 |
|
35 |
package Coro; |
36 |
|
37 |
use Coro::State; |
38 |
|
39 |
use base Exporter; |
40 |
|
41 |
$VERSION = 0.10; |
42 |
|
43 |
@EXPORT = qw(async yield schedule terminate current); |
44 |
@EXPORT_OK = qw($current); |
45 |
|
46 |
{ |
47 |
my @async; |
48 |
|
49 |
# this way of handling attributes simply is NOT scalable ;() |
50 |
sub import { |
51 |
Coro->export_to_level(1, @_); |
52 |
my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
53 |
*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
54 |
my ($package, $ref) = (shift, shift); |
55 |
my @attrs; |
56 |
for (@_) { |
57 |
if ($_ eq "Coro") { |
58 |
push @async, $ref; |
59 |
} else { |
60 |
push @attrs, $_; |
61 |
} |
62 |
} |
63 |
return $old ? $old->($package, $ref, @attrs) : @attrs; |
64 |
}; |
65 |
} |
66 |
|
67 |
sub INIT { |
68 |
&async(pop @async) while @async; |
69 |
} |
70 |
} |
71 |
|
72 |
=item $main |
73 |
|
74 |
This coroutine represents the main program. |
75 |
|
76 |
=cut |
77 |
|
78 |
our $main = new Coro; |
79 |
|
80 |
=item $current (or as function: current) |
81 |
|
82 |
The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
83 |
|
84 |
=cut |
85 |
|
86 |
# maybe some other module used Coro::Specific before... |
87 |
if ($current) { |
88 |
$main->{specific} = $current->{specific}; |
89 |
} |
90 |
|
91 |
our $current = $main; |
92 |
|
93 |
sub current() { $current } |
94 |
|
95 |
=item $idle |
96 |
|
97 |
The coroutine to switch to when no other coroutine is running. The default |
98 |
implementation prints "FATAL: deadlock detected" and exits. |
99 |
|
100 |
=cut |
101 |
|
102 |
# should be done using priorities :( |
103 |
our $idle = new Coro sub { |
104 |
print STDERR "FATAL: deadlock detected\n"; |
105 |
exit(51); |
106 |
}; |
107 |
|
108 |
# we really need priorities... |
109 |
my @ready; # the ready queue. hehe, rather broken ;) |
110 |
|
111 |
# static methods. not really. |
112 |
|
113 |
=head2 STATIC METHODS |
114 |
|
115 |
Static methods are actually functions that operate on the current process only. |
116 |
|
117 |
=over 4 |
118 |
|
119 |
=item async { ... } [@args...] |
120 |
|
121 |
Create a new asynchronous process and return it's process object |
122 |
(usually unused). When the sub returns the new process is automatically |
123 |
terminated. |
124 |
|
125 |
# create a new coroutine that just prints its arguments |
126 |
async { |
127 |
print "@_\n"; |
128 |
} 1,2,3,4; |
129 |
|
130 |
The coderef you submit MUST NOT be a closure that refers to variables |
131 |
in an outer scope. This does NOT work. Pass arguments into it instead. |
132 |
|
133 |
=cut |
134 |
|
135 |
sub async(&@) { |
136 |
my $pid = new Coro @_; |
137 |
$pid->ready; |
138 |
$pid; |
139 |
} |
140 |
|
141 |
=item schedule |
142 |
|
143 |
Calls the scheduler. Please note that the current process will not be put |
144 |
into the ready queue, so calling this function usually means you will |
145 |
never be called again. |
146 |
|
147 |
=cut |
148 |
|
149 |
my $prev; |
150 |
|
151 |
sub schedule { |
152 |
# should be done using priorities :( |
153 |
($prev, $current) = ($current, shift @ready || $idle); |
154 |
Coro::State::transfer($prev, $current); |
155 |
} |
156 |
|
157 |
=item yield |
158 |
|
159 |
Yield to other processes. This function puts the current process into the |
160 |
ready queue and calls C<schedule>. |
161 |
|
162 |
=cut |
163 |
|
164 |
sub yield { |
165 |
$current->ready; |
166 |
&schedule; |
167 |
} |
168 |
|
169 |
=item terminate |
170 |
|
171 |
Terminates the current process. |
172 |
|
173 |
Future versions of this function will allow result arguments. |
174 |
|
175 |
=cut |
176 |
|
177 |
sub terminate { |
178 |
$current->{_results} = [@_]; |
179 |
&schedule; |
180 |
} |
181 |
|
182 |
=back |
183 |
|
184 |
# dynamic methods |
185 |
|
186 |
=head2 PROCESS METHODS |
187 |
|
188 |
These are the methods you can call on process objects. |
189 |
|
190 |
=over 4 |
191 |
|
192 |
=item new Coro \&sub [, @args...] |
193 |
|
194 |
Create a new process and return it. When the sub returns the process |
195 |
automatically terminates. To start the process you must first put it into |
196 |
the ready queue by calling the ready method. |
197 |
|
198 |
The coderef you submit MUST NOT be a closure that refers to variables |
199 |
in an outer scope. This does NOT work. Pass arguments into it instead. |
200 |
|
201 |
=cut |
202 |
|
203 |
sub _newcoro { |
204 |
terminate &{+shift}; |
205 |
} |
206 |
|
207 |
sub new { |
208 |
my $class = shift; |
209 |
bless { |
210 |
_coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
211 |
}, $class; |
212 |
} |
213 |
|
214 |
=item $process->ready |
215 |
|
216 |
Put the current process into the ready queue. |
217 |
|
218 |
=cut |
219 |
|
220 |
sub ready { |
221 |
push @ready, $_[0]; |
222 |
} |
223 |
|
224 |
=back |
225 |
|
226 |
=cut |
227 |
|
228 |
1; |
229 |
|
230 |
=head1 BUGS/LIMITATIONS |
231 |
|
232 |
- could be faster, especially when the core would introduce special |
233 |
support for coroutines (like it does for threads). |
234 |
- there is still a memleak on coroutine termination that I could not |
235 |
identify. Could be as small as a single SV. |
236 |
- this module is not well-tested. |
237 |
- if variables or arguments "disappear" (become undef) or become |
238 |
corrupted please contact the author so he cen iron out the |
239 |
remaining bugs. |
240 |
- this module is not thread-safe. You must only ever use this module from |
241 |
the same thread (this requirement might be loosened in the future to |
242 |
allow per-thread schedulers, but Coro::State does not yet allow this). |
243 |
|
244 |
=head1 SEE ALSO |
245 |
|
246 |
L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
247 |
L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. |
248 |
|
249 |
=head1 AUTHOR |
250 |
|
251 |
Marc Lehmann <pcg@goof.com> |
252 |
http://www.goof.com/pcg/marc/ |
253 |
|
254 |
=cut |
255 |
|