ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro.pm
(Generate patch)

Comparing Coro/Coro.pm (file contents):
Revision 1.14 by root, Tue Jul 17 02:21:56 2001 UTC vs.
Revision 1.23 by root, Mon Jul 23 04:23:32 2001 UTC

… …
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
23This module collection manages coroutines. Coroutines are similar to 23This module collection manages coroutines. Coroutines are similar to
24Threads but don't run in parallel. 24Threads but don't run in parallel.
25 25
26This module is still experimental, see the BUGS section below. 26This module is still experimental, see the BUGS section below.
27 27
28In this module, coroutines are defined as "callchain + lexical variables
29+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30callchain, it's own set of lexicals and it's own set of perl's most
31important global variables.
32
28=cut 33=cut
29 34
30package Coro; 35package Coro;
31 36
32use Coro::State; 37use Coro::State;
33 38
34use base Exporter; 39use base Exporter;
35 40
36$VERSION = 0.05; 41$VERSION = 0.10;
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;
45 48
46 # this way of handling attributes simply is NOT scalable ;() 49 # this way of handling attributes simply is NOT scalable ;()
47 sub import { 50 sub import {
48 Coro->export_to_level(1, @_); 51 Coro->export_to_level(1, @_);
… …
52 my @attrs; 55 my @attrs;
53 for (@_) { 56 for (@_) {
54 if ($_ eq "Coro") { 57 if ($_ eq "Coro") {
55 push @async, $ref; 58 push @async, $ref;
56 } else { 59 } else {
57 push @attrs, @_; 60 push @attrs, $_;
58 } 61 }
59 } 62 }
60 return $old ? $old->($package, $name, @attrs) : @attrs; 63 return $old ? $old->($package, $ref, @attrs) : @attrs;
61 }; 64 };
62 } 65 }
63 66
64 sub INIT { 67 sub INIT {
65 async pop @async while @async; 68 &async(pop @async) while @async;
66 } 69 }
67} 70}
68 71
69=item $main 72=item $main
70 73
… …
72 75
73=cut 76=cut
74 77
75our $main = new Coro; 78our $main = new Coro;
76 79
77=item $current 80=item $current (or as function: current)
78 81
79The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 82The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
80 83
81=cut 84=cut
82 85
… …
84if ($current) { 87if ($current) {
85 $main->{specific} = $current->{specific}; 88 $main->{specific} = $current->{specific};
86} 89}
87 90
88our $current = $main; 91our $current = $main;
92
93sub current() { $current }
89 94
90=item $idle 95=item $idle
91 96
92The coroutine to switch to when no other coroutine is running. The default 97The coroutine to switch to when no other coroutine is running. The default
93implementation prints "FATAL: deadlock detected" and exits. 98implementation prints "FATAL: deadlock detected" and exits.
… …
99 print STDERR "FATAL: deadlock detected\n"; 104 print STDERR "FATAL: deadlock detected\n";
100 exit(51); 105 exit(51);
101}; 106};
102 107
103# we really need priorities... 108# we really need priorities...
104## my @ready; #d#
105our @ready = (); # the ready queue. hehe, rather broken ;) 109my @ready; # the ready queue. hehe, rather broken ;)
106 110
107# static methods. not really. 111# static methods. not really.
108 112
109=head2 STATIC METHODS 113=head2 STATIC METHODS
110 114
… …
148 # should be done using priorities :( 152 # should be done using priorities :(
149 ($prev, $current) = ($current, shift @ready || $idle); 153 ($prev, $current) = ($current, shift @ready || $idle);
150 Coro::State::transfer($prev, $current); 154 Coro::State::transfer($prev, $current);
151} 155}
152 156
153=item yield 157=item cede
154 158
155Yield to other processes. This function puts the current process into the 159"Cede" to other processes. This function puts the current process into the
156ready queue and calls C<schedule>. 160ready queue and calls C<schedule>, which has the effect of giving up the
161current "timeslice" to other coroutines of the same or higher priority.
157 162
158=cut 163=cut
159 164
160sub yield { 165sub cede {
161 $current->ready; 166 $current->ready;
162 &schedule; 167 &schedule;
163} 168}
164 169
165=item terminate 170=item terminate
… …
168 173
169Future versions of this function will allow result arguments. 174Future versions of this function will allow result arguments.
170 175
171=cut 176=cut
172 177
178# this coroutine is necessary because a coroutine
179# cannot destroy itself.
180my @destroy;
181my $terminate = new Coro sub {
182 while() {
183 delete ((pop @destroy)->{_coro_state}) while @destroy;
184 &schedule;
185 }
186};
187
173sub terminate { 188sub terminate {
174 $current->{_results} = [@_]; 189 push @destroy, $current;
190 $terminate->ready;
175 &schedule; 191 &schedule;
192 # NORETURN
176} 193}
177 194
178=back 195=back
179 196
180# dynamic methods 197# dynamic methods
… …
221 238
222=cut 239=cut
223 240
2241; 2411;
225 242
226=head1 BUGS 243=head1 BUGS/LIMITATIONS
227 244
228 - could be faster, especially when the core would introduce special 245 - could be faster, especially when the core would introduce special
229 support for coroutines (like it does for threads). 246 support for coroutines (like it does for threads).
230 - there is still a memleak on coroutine termination that I could not 247 - there is still a memleak on coroutine termination that I could not
231 identify. Could be as small as a single SV. 248 identify. Could be as small as a single SV.
232 - this module is not well-tested. 249 - this module is not well-tested.
250 - if variables or arguments "disappear" (become undef) or become
251 corrupted please contact the author so he cen iron out the
252 remaining bugs.
253 - this module is not thread-safe. You must only ever use this module from
254 the same thread (this requirement might be loosened in the future to
255 allow per-thread schedulers, but Coro::State does not yet allow this).
233 256
234=head1 SEE ALSO 257=head1 SEE ALSO
235 258
236L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 259L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
237L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 260L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines