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.25 by root, Wed Jul 25 21:12:57 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.12;
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;
54 48
109our $idle = new Coro sub { 103our $idle = new Coro sub {
110 print STDERR "FATAL: deadlock detected\n"; 104 print STDERR "FATAL: deadlock detected\n";
111 exit(51); 105 exit(51);
112}; 106};
113 107
108# this coroutine is necessary because a coroutine
109# cannot destroy itself.
110my @destroy;
111my $manager = new Coro sub {
112 while() {
113 delete ((pop @destroy)->{_coro_state}) while @destroy;
114 &schedule;
115 }
116};
117
114# we really need priorities... 118# we really need priorities...
115my @ready; # the ready queue. hehe, rather broken ;) 119my @ready; # the ready queue. hehe, rather broken ;)
116 120
117# static methods. not really. 121# static methods. not really.
118 122
138 142
139=cut 143=cut
140 144
141sub async(&@) { 145sub async(&@) {
142 my $pid = new Coro @_; 146 my $pid = new Coro @_;
147 $manager->ready; # this ensures that the stack is cloned from the manager
143 $pid->ready; 148 $pid->ready;
144 $pid; 149 $pid;
145} 150}
146 151
147=item schedule 152=item schedule
158 # should be done using priorities :( 163 # should be done using priorities :(
159 ($prev, $current) = ($current, shift @ready || $idle); 164 ($prev, $current) = ($current, shift @ready || $idle);
160 Coro::State::transfer($prev, $current); 165 Coro::State::transfer($prev, $current);
161} 166}
162 167
163=item yield 168=item cede
164 169
165Yield to other processes. This function puts the current process into the 170"Cede" to other processes. This function puts the current process into the
166ready queue and calls C<schedule>. 171ready queue and calls C<schedule>, which has the effect of giving up the
172current "timeslice" to other coroutines of the same or higher priority.
167 173
168=cut 174=cut
169 175
170sub yield { 176sub cede {
171 $current->ready; 177 $current->ready;
172 &schedule; 178 &schedule;
173} 179}
174 180
175=item terminate 181=item terminate
179Future versions of this function will allow result arguments. 185Future versions of this function will allow result arguments.
180 186
181=cut 187=cut
182 188
183sub terminate { 189sub terminate {
184 $current->{_results} = [@_]; 190 push @destroy, $current;
185 delete $current->{_coro_state}; 191 $manager->ready;
186 &schedule; 192 &schedule;
193 # NORETURN
187} 194}
188 195
189=back 196=back
190 197
191# dynamic methods 198# dynamic methods
249 allow per-thread schedulers, but Coro::State does not yet allow this). 256 allow per-thread schedulers, but Coro::State does not yet allow this).
250 257
251=head1 SEE ALSO 258=head1 SEE ALSO
252 259
253L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 260L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
254L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 261L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
262L<Coro::L<Coro::Handle>, L<Coro::Socket>.
255 263
256=head1 AUTHOR 264=head1 AUTHOR
257 265
258 Marc Lehmann <pcg@goof.com> 266 Marc Lehmann <pcg@goof.com>
259 http://www.goof.com/pcg/marc/ 267 http://www.goof.com/pcg/marc/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines