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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.16 by root, Tue Jul 17 15:42:28 2001 UTC vs.
Revision 1.30 by root, Sat Aug 11 19:59:19 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.07; 41$VERSION = 0.45;
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
71This coroutine represents the main program. 79This coroutine represents the main program.
72 80
73=cut 81=cut
74 82
75our $main = new Coro; 83our $main = new Coro;
76 84
77=item $current 85=item $current (or as function: current)
78 86
79The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 87The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
80 88
81=cut 89=cut
82 90
… …
84if ($current) { 92if ($current) {
85 $main->{specific} = $current->{specific}; 93 $main->{specific} = $current->{specific};
86} 94}
87 95
88our $current = $main; 96our $current = $main;
97
98sub current() { $current }
89 99
90=item $idle 100=item $idle
91 101
92The coroutine to switch to when no other coroutine is running. The default 102The coroutine to switch to when no other coroutine is running. The default
93implementation prints "FATAL: deadlock detected" and exits. 103implementation prints "FATAL: deadlock detected" and exits.
… …
98our $idle = new Coro sub { 108our $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
103# we really need priorities... 113# this coroutine is necessary because a coroutine
104my @ready; # the ready queue. hehe, rather broken ;) 114# cannot destroy itself.
115my @destroy;
116my $manager = new Coro sub {
117 while() {
118 delete ((pop @destroy)->{_coro_state}) while @destroy;
119 &schedule;
120 }
121};
105 122
106# static methods. not really. 123# static methods. not really.
107 124
108=head2 STATIC METHODS 125=head2 STATIC METHODS
109 126
… …
127 144
128=cut 145=cut
129 146
130sub async(&@) { 147sub async(&@) {
131 my $pid = new Coro @_; 148 my $pid = new Coro @_;
149 $manager->ready; # this ensures that the stack is cloned from the manager
132 $pid->ready; 150 $pid->ready;
133 $pid; 151 $pid;
134} 152}
135 153
136=item schedule 154=item schedule
… …
139into the ready queue, so calling this function usually means you will 157into the ready queue, so calling this function usually means you will
140never be called again. 158never be called again.
141 159
142=cut 160=cut
143 161
144my $prev;
145
146sub schedule {
147 # should be done using priorities :(
148 ($prev, $current) = ($current, shift @ready || $idle);
149 Coro::State::transfer($prev, $current);
150}
151
152=item yield 162=item cede
153 163
154Yield to other processes. This function puts the current process into the 164"Cede" to other processes. This function puts the current process into the
155ready queue and calls C<schedule>. 165ready queue and calls C<schedule>, which has the effect of giving up the
166current "timeslice" to other coroutines of the same or higher priority.
156 167
157=cut 168=cut
158 169
159sub yield { 170=item terminate
171
172Terminates the current process.
173
174Future versions of this function will allow result arguments.
175
176=cut
177
178sub terminate {
160 $current->ready; 179 $current->cancel;
161 &schedule; 180 &schedule;
162} 181 die; # NORETURN
163
164=item terminate
165
166Terminates the current process.
167
168Future versions of this function will allow result arguments.
169
170=cut
171
172sub terminate {
173 $current->{_results} = [@_];
174 &schedule;
175} 182}
176 183
177=back 184=back
178 185
179# dynamic methods 186# dynamic methods
… …
210 217
211Put the current process into the ready queue. 218Put the current process into the ready queue.
212 219
213=cut 220=cut
214 221
215sub ready { 222=item $process->cancel
223
224Like C<terminate>, but terminates the specified process instead.
225
226=cut
227
228sub cancel {
216 push @ready, $_[0]; 229 push @destroy, $_[0];
230 $manager->ready;
217} 231}
218 232
219=back 233=back
220 234
221=cut 235=cut
222 236
2231; 2371;
224 238
225=head1 BUGS 239=head1 BUGS/LIMITATIONS
226 240
227 - could be faster, especially when the core would introduce special 241 - could be faster, especially when the core would introduce special
228 support for coroutines (like it does for threads). 242 support for coroutines (like it does for threads).
229 - there is still a memleak on coroutine termination that I could not 243 - there is still a memleak on coroutine termination that I could not
230 identify. Could be as small as a single SV. 244 identify. Could be as small as a single SV.
231 - this module is not well-tested. 245 - this module is not well-tested.
246 - if variables or arguments "disappear" (become undef) or become
247 corrupted please contact the author so he cen iron out the
248 remaining bugs.
249 - this module is not thread-safe. You must only ever use this module from
250 the same thread (this requirement might be loosened in the future to
251 allow per-thread schedulers, but Coro::State does not yet allow this).
232 252
233=head1 SEE ALSO 253=head1 SEE ALSO
234 254
235L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 255L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
236L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 256L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
257L<Coro::Handle>, L<Coro::Socket>.
237 258
238=head1 AUTHOR 259=head1 AUTHOR
239 260
240 Marc Lehmann <pcg@goof.com> 261 Marc Lehmann <pcg@goof.com>
241 http://www.goof.com/pcg/marc/ 262 http://www.goof.com/pcg/marc/

Diff Legend

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