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

Comparing Coro/Coro.pm (file contents):
Revision 1.19 by root, Sat Jul 21 03:44:06 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.09; 41$VERSION = 0.45;
37 42
38@EXPORT = qw(async yield schedule terminate current); 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.
… …
100our $idle = new Coro sub { 108our $idle = new Coro sub {
101 print STDERR "FATAL: deadlock detected\n"; 109 print STDERR "FATAL: deadlock detected\n";
102 exit(51); 110 exit(51);
103}; 111};
104 112
105# we really need priorities... 113# this coroutine is necessary because a coroutine
106my @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};
107 122
108# static methods. not really. 123# static methods. not really.
109 124
110=head2 STATIC METHODS 125=head2 STATIC METHODS
111 126
… …
129 144
130=cut 145=cut
131 146
132sub async(&@) { 147sub async(&@) {
133 my $pid = new Coro @_; 148 my $pid = new Coro @_;
149 $manager->ready; # this ensures that the stack is cloned from the manager
134 $pid->ready; 150 $pid->ready;
135 $pid; 151 $pid;
136} 152}
137 153
138=item schedule 154=item schedule
… …
141into the ready queue, so calling this function usually means you will 157into the ready queue, so calling this function usually means you will
142never be called again. 158never be called again.
143 159
144=cut 160=cut
145 161
146my $prev;
147
148sub schedule {
149 # should be done using priorities :(
150 ($prev, $current) = ($current, shift @ready || $idle);
151 Coro::State::transfer($prev, $current);
152}
153
154=item yield 162=item cede
155 163
156Yield to other processes. This function puts the current process into the 164"Cede" to other processes. This function puts the current process into the
157ready 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.
158 167
159=cut 168=cut
160 169
161sub 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 {
162 $current->ready; 179 $current->cancel;
163 &schedule; 180 &schedule;
164} 181 die; # NORETURN
165
166=item terminate
167
168Terminates the current process.
169
170Future versions of this function will allow result arguments.
171
172=cut
173
174sub terminate {
175 $current->{_results} = [@_];
176 &schedule;
177} 182}
178 183
179=back 184=back
180 185
181# dynamic methods 186# dynamic methods
… …
212 217
213Put the current process into the ready queue. 218Put the current process into the ready queue.
214 219
215=cut 220=cut
216 221
217sub ready { 222=item $process->cancel
223
224Like C<terminate>, but terminates the specified process instead.
225
226=cut
227
228sub cancel {
218 push @ready, $_[0]; 229 push @destroy, $_[0];
230 $manager->ready;
219} 231}
220 232
221=back 233=back
222 234
223=cut 235=cut
… …
234 - if variables or arguments "disappear" (become undef) or become 246 - if variables or arguments "disappear" (become undef) or become
235 corrupted please contact the author so he cen iron out the 247 corrupted please contact the author so he cen iron out the
236 remaining bugs. 248 remaining bugs.
237 - this module is not thread-safe. You must only ever use this module from 249 - this module is not thread-safe. You must only ever use this module from
238 the same thread (this requirement might be loosened in the future to 250 the same thread (this requirement might be loosened in the future to
239 allow per-thread schedulers, but Coro::Satte does not yet allow this). 251 allow per-thread schedulers, but Coro::State does not yet allow this).
240 252
241=head1 SEE ALSO 253=head1 SEE ALSO
242 254
243L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 255L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
244L<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>.
245 258
246=head1 AUTHOR 259=head1 AUTHOR
247 260
248 Marc Lehmann <pcg@goof.com> 261 Marc Lehmann <pcg@goof.com>
249 http://www.goof.com/pcg/marc/ 262 http://www.goof.com/pcg/marc/

Diff Legend

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