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

Comparing Coro/Coro.pm (file contents):
Revision 1.18 by root, Sat Jul 21 02:49:09 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
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.09; 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, $ref, @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
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
103# we really need priorities... 123# we really need priorities...
104my @ready; # the ready queue. hehe, rather broken ;) 124my @ready; # the ready queue. hehe, rather broken ;)
105 125
106# static methods. not really. 126# static methods. not really.
107 127
… …
127 147
128=cut 148=cut
129 149
130sub async(&@) { 150sub async(&@) {
131 my $pid = new Coro @_; 151 my $pid = new Coro @_;
152 $manager->ready; # this ensures that the stack is cloned from the manager
132 $pid->ready; 153 $pid->ready;
133 $pid; 154 $pid;
134} 155}
135 156
136=item schedule 157=item schedule
… …
147 # should be done using priorities :( 168 # should be done using priorities :(
148 ($prev, $current) = ($current, shift @ready || $idle); 169 ($prev, $current) = ($current, shift @ready || $idle);
149 Coro::State::transfer($prev, $current); 170 Coro::State::transfer($prev, $current);
150} 171}
151 172
152=item yield 173=item cede
153 174
154Yield to other processes. This function puts the current process into the 175"Cede" to other processes. This function puts the current process into the
155ready 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.
156 178
157=cut 179=cut
158 180
159sub yield { 181sub cede {
160 $current->ready; 182 $current->ready;
161 &schedule; 183 &schedule;
162} 184}
163 185
164=item terminate 186=item terminate
… …
168Future versions of this function will allow result arguments. 190Future versions of this function will allow result arguments.
169 191
170=cut 192=cut
171 193
172sub terminate { 194sub terminate {
173 $current->{_results} = [@_]; 195 $current->cancel;
174 &schedule; 196 &schedule;
197 die; # NORETURN
175} 198}
176 199
177=back 200=back
178 201
179# dynamic methods 202# dynamic methods
… …
212 235
213=cut 236=cut
214 237
215sub ready { 238sub ready {
216 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;
217} 251}
218 252
219=back 253=back
220 254
221=cut 255=cut
… …
232 - if variables or arguments "disappear" (become undef) or become 266 - if variables or arguments "disappear" (become undef) or become
233 corrupted please contact the author so he cen iron out the 267 corrupted please contact the author so he cen iron out the
234 remaining bugs. 268 remaining bugs.
235 - this module is not thread-safe. You must only ever use this module from 269 - this module is not thread-safe. You must only ever use this module from
236 the same thread (this requirement might be loosened in the future to 270 the same thread (this requirement might be loosened in the future to
237 allow per-thread schedulers, but Coro::Satte does not yet allow this). 271 allow per-thread schedulers, but Coro::State does not yet allow this).
238 272
239=head1 SEE ALSO 273=head1 SEE ALSO
240 274
241L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 275L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
242L<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>.
243 278
244=head1 AUTHOR 279=head1 AUTHOR
245 280
246 Marc Lehmann <pcg@goof.com> 281 Marc Lehmann <pcg@goof.com>
247 http://www.goof.com/pcg/marc/ 282 http://www.goof.com/pcg/marc/

Diff Legend

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