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

Comparing Coro/Coro.pm (file contents):
Revision 1.21 by root, Sun Jul 22 03:24:10 2001 UTC vs.
Revision 1.29 by root, Sat Aug 11 00:37:31 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 28In 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
30own set of lexicals and it's own set of perl's most important global 30callchain, it's own set of lexicals and it's own set of perl's most
31variables. 31important global variables.
32
33WARNING: When using this module, make sure that, at program end, no
34coroutines are still running OR just call exit before falling off the
35end. The reason for this is that some coroutine of yours might have called
36into a C function, and falling off the end of main:: results in returning
37to that C function instead if to the main C interpreter.
38 32
39=cut 33=cut
40 34
41package Coro; 35package Coro;
42 36
43use Coro::State; 37use Coro::State;
44 38
45use base Exporter; 39use base Exporter;
46 40
47$VERSION = 0.10; 41$VERSION = 0.45;
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;
48 my $init;
54 49
55 # this way of handling attributes simply is NOT scalable ;() 50 # this way of handling attributes simply is NOT scalable ;()
56 sub import { 51 sub import {
57 Coro->export_to_level(1, @_); 52 Coro->export_to_level(1, @_);
58 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 53 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
… …
60 my ($package, $ref) = (shift, shift); 55 my ($package, $ref) = (shift, shift);
61 my @attrs; 56 my @attrs;
62 for (@_) { 57 for (@_) {
63 if ($_ eq "Coro") { 58 if ($_ eq "Coro") {
64 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 }
65 } else { 67 } else {
66 push @attrs, $_; 68 push @attrs, $_;
67 } 69 }
68 } 70 }
69 return $old ? $old->($package, $ref, @attrs) : @attrs; 71 return $old ? $old->($package, $ref, @attrs) : @attrs;
70 }; 72 };
71 } 73 }
72 74
73 sub INIT {
74 &async(pop @async) while @async;
75 }
76} 75}
77 76
78=item $main 77=item $main
79 78
80This coroutine represents the main program. 79This coroutine represents the main program.
… …
109our $idle = new Coro sub { 108our $idle = new Coro sub {
110 print STDERR "FATAL: deadlock detected\n"; 109 print STDERR "FATAL: deadlock detected\n";
111 exit(51); 110 exit(51);
112}; 111};
113 112
113# this coroutine is necessary because a coroutine
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};
122
114# we really need priorities... 123# we really need priorities...
115my @ready; # the ready queue. hehe, rather broken ;) 124my @ready; # the ready queue. hehe, rather broken ;)
116 125
117# static methods. not really. 126# static methods. not really.
118 127
… …
138 147
139=cut 148=cut
140 149
141sub async(&@) { 150sub async(&@) {
142 my $pid = new Coro @_; 151 my $pid = new Coro @_;
152 $manager->ready; # this ensures that the stack is cloned from the manager
143 $pid->ready; 153 $pid->ready;
144 $pid; 154 $pid;
145} 155}
146 156
147=item schedule 157=item schedule
… …
158 # should be done using priorities :( 168 # should be done using priorities :(
159 ($prev, $current) = ($current, shift @ready || $idle); 169 ($prev, $current) = ($current, shift @ready || $idle);
160 Coro::State::transfer($prev, $current); 170 Coro::State::transfer($prev, $current);
161} 171}
162 172
163=item yield 173=item cede
164 174
165Yield to other processes. This function puts the current process into the 175"Cede" to other processes. This function puts the current process into the
166ready queue and calls C<schedule>. 176ready queue and calls C<schedule>, which has the effect of giving up the
177current "timeslice" to other coroutines of the same or higher priority.
167 178
168=cut 179=cut
169 180
170sub yield { 181sub cede {
171 $current->ready; 182 $current->ready;
172 &schedule; 183 &schedule;
173} 184}
174 185
175=item terminate 186=item terminate
… …
179Future versions of this function will allow result arguments. 190Future versions of this function will allow result arguments.
180 191
181=cut 192=cut
182 193
183sub terminate { 194sub terminate {
184 $current->{_results} = [@_]; 195 $current->cancel;
185 delete $current->{_coro_state};
186 &schedule; 196 &schedule;
197 die; # NORETURN
187} 198}
188 199
189=back 200=back
190 201
191# dynamic methods 202# dynamic methods
… …
224 235
225=cut 236=cut
226 237
227sub ready { 238sub ready {
228 push @ready, $_[0]; 239 push @ready, $_[0];
240}
241
242=item $process->cancel
243
244Like C<terminate>, but terminates the specified process instead.
245
246=cut
247
248sub cancel {
249 push @destroy, $_[0];
250 $manager->ready;
229} 251}
230 252
231=back 253=back
232 254
233=cut 255=cut
… …
249 allow per-thread schedulers, but Coro::State does not yet allow this). 271 allow per-thread schedulers, but Coro::State does not yet allow this).
250 272
251=head1 SEE ALSO 273=head1 SEE ALSO
252 274
253L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 275L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
254L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 276L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
277L<Coro::Handle>, L<Coro::Socket>.
255 278
256=head1 AUTHOR 279=head1 AUTHOR
257 280
258 Marc Lehmann <pcg@goof.com> 281 Marc Lehmann <pcg@goof.com>
259 http://www.goof.com/pcg/marc/ 282 http://www.goof.com/pcg/marc/

Diff Legend

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