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.13 by root, Tue Jul 17 00:24:14 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
24Threads but don't run in parallel.
25
26This module is still experimental, see the BUGS section below.
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
23=cut 33=cut
24 34
25package Coro; 35package Coro;
26 36
27use Coro::State; 37use Coro::State;
28 38
29use base Exporter; 39use base Exporter;
30 40
31$VERSION = 0.05; 41$VERSION = 0.45;
32 42
33@EXPORT = qw(async yield schedule terminate); 43@EXPORT = qw(async cede schedule terminate current);
34@EXPORT_OK = qw($current); 44@EXPORT_OK = qw($current);
35 45
36{ 46{
37 use subs 'async';
38
39 my @async; 47 my @async;
48 my $init;
40 49
41 # this way of handling attributes simply is NOT scalable ;() 50 # this way of handling attributes simply is NOT scalable ;()
42 sub import { 51 sub import {
43 Coro->export_to_level(1, @_); 52 Coro->export_to_level(1, @_);
44 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 53 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
… …
46 my ($package, $ref) = (shift, shift); 55 my ($package, $ref) = (shift, shift);
47 my @attrs; 56 my @attrs;
48 for (@_) { 57 for (@_) {
49 if ($_ eq "Coro") { 58 if ($_ eq "Coro") {
50 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 }
51 } else { 67 } else {
52 push @attrs, @_; 68 push @attrs, $_;
53 } 69 }
54 } 70 }
55 return $old ? $old->($package, $name, @attrs) : @attrs; 71 return $old ? $old->($package, $ref, @attrs) : @attrs;
56 }; 72 };
57 } 73 }
58 74
59 sub INIT {
60 async pop @async while @async;
61 }
62} 75}
63 76
64=item $main 77=item $main
65 78
66This coroutine represents the main program. 79This coroutine represents the main program.
67 80
68=cut 81=cut
69 82
70our $main = new Coro; 83our $main = new Coro;
71 84
72=item $current 85=item $current (or as function: current)
73 86
74The 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).
75 88
76=cut 89=cut
77 90
… …
79if ($current) { 92if ($current) {
80 $main->{specific} = $current->{specific}; 93 $main->{specific} = $current->{specific};
81} 94}
82 95
83our $current = $main; 96our $current = $main;
97
98sub current() { $current }
84 99
85=item $idle 100=item $idle
86 101
87The 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
88implementation prints "FATAL: deadlock detected" and exits. 103implementation prints "FATAL: deadlock detected" and exits.
… …
93our $idle = new Coro sub { 108our $idle = new Coro sub {
94 print STDERR "FATAL: deadlock detected\n"; 109 print STDERR "FATAL: deadlock detected\n";
95 exit(51); 110 exit(51);
96}; 111};
97 112
98# we really need priorities... 113# this coroutine is necessary because a coroutine
99## my @ready; #d# 114# cannot destroy itself.
100our @ready = (); # the ready queue. hehe, rather broken ;) 115my @destroy;
116my $manager = new Coro sub {
117 while() {
118 delete ((pop @destroy)->{_coro_state}) while @destroy;
119 &schedule;
120 }
121};
101 122
102# static methods. not really. 123# static methods. not really.
103 124
104=head2 STATIC METHODS 125=head2 STATIC METHODS
105 126
… …
123 144
124=cut 145=cut
125 146
126sub async(&@) { 147sub async(&@) {
127 my $pid = new Coro @_; 148 my $pid = new Coro @_;
149 $manager->ready; # this ensures that the stack is cloned from the manager
128 $pid->ready; 150 $pid->ready;
129 $pid; 151 $pid;
130} 152}
131 153
132=item schedule 154=item schedule
… …
135into the ready queue, so calling this function usually means you will 157into the ready queue, so calling this function usually means you will
136never be called again. 158never be called again.
137 159
138=cut 160=cut
139 161
140my $prev;
141
142sub schedule {
143 # should be done using priorities :(
144 ($prev, $current) = ($current, shift @ready || $idle);
145 Coro::State::transfer($prev, $current);
146}
147
148=item yield 162=item cede
149 163
150Yield to other processes. This function puts the current process into the 164"Cede" to other processes. This function puts the current process into the
151ready 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.
152 167
153=cut 168=cut
154 169
155sub 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 {
156 $current->ready; 179 $current->cancel;
157 &schedule; 180 &schedule;
158} 181 die; # NORETURN
159
160=item terminate
161
162Terminates the current process.
163
164Future versions of this function will allow result arguments.
165
166=cut
167
168sub terminate {
169 $current->{_results} = [@_];
170 &schedule;
171} 182}
172 183
173=back 184=back
174 185
175# dynamic methods 186# dynamic methods
… …
206 217
207Put the current process into the ready queue. 218Put the current process into the ready queue.
208 219
209=cut 220=cut
210 221
211sub ready { 222=item $process->cancel
223
224Like C<terminate>, but terminates the specified process instead.
225
226=cut
227
228sub cancel {
212 push @ready, $_[0]; 229 push @destroy, $_[0];
230 $manager->ready;
213} 231}
214 232
215=back 233=back
216 234
217=cut 235=cut
218 236
2191; 2371;
220 238
239=head1 BUGS/LIMITATIONS
240
241 - could be faster, especially when the core would introduce special
242 support for coroutines (like it does for threads).
243 - there is still a memleak on coroutine termination that I could not
244 identify. Could be as small as a single SV.
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).
252
221=head1 SEE ALSO 253=head1 SEE ALSO
222 254
223L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 255L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
224L<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>.
225 258
226=head1 AUTHOR 259=head1 AUTHOR
227 260
228 Marc Lehmann <pcg@goof.com> 261 Marc Lehmann <pcg@goof.com>
229 http://www.goof.com/pcg/marc/ 262 http://www.goof.com/pcg/marc/

Diff Legend

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