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

Comparing Coro/Coro.pm (file contents):
Revision 1.13 by root, Tue Jul 17 00:24:14 2001 UTC vs.
Revision 1.24 by root, Wed Jul 25 04:14:37 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.12;
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;
40 48
41 # this way of handling attributes simply is NOT scalable ;() 49 # this way of handling attributes simply is NOT scalable ;()
42 sub import { 50 sub import {
43 Coro->export_to_level(1, @_); 51 Coro->export_to_level(1, @_);
… …
47 my @attrs; 55 my @attrs;
48 for (@_) { 56 for (@_) {
49 if ($_ eq "Coro") { 57 if ($_ eq "Coro") {
50 push @async, $ref; 58 push @async, $ref;
51 } else { 59 } else {
52 push @attrs, @_; 60 push @attrs, $_;
53 } 61 }
54 } 62 }
55 return $old ? $old->($package, $name, @attrs) : @attrs; 63 return $old ? $old->($package, $ref, @attrs) : @attrs;
56 }; 64 };
57 } 65 }
58 66
59 sub INIT { 67 sub INIT {
60 async pop @async while @async; 68 &async(pop @async) while @async;
61 } 69 }
62} 70}
63 71
64=item $main 72=item $main
65 73
… …
67 75
68=cut 76=cut
69 77
70our $main = new Coro; 78our $main = new Coro;
71 79
72=item $current 80=item $current (or as function: current)
73 81
74The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 82The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
75 83
76=cut 84=cut
77 85
… …
79if ($current) { 87if ($current) {
80 $main->{specific} = $current->{specific}; 88 $main->{specific} = $current->{specific};
81} 89}
82 90
83our $current = $main; 91our $current = $main;
92
93sub current() { $current }
84 94
85=item $idle 95=item $idle
86 96
87The coroutine to switch to when no other coroutine is running. The default 97The coroutine to switch to when no other coroutine is running. The default
88implementation prints "FATAL: deadlock detected" and exits. 98implementation prints "FATAL: deadlock detected" and exits.
… …
93our $idle = new Coro sub { 103our $idle = new Coro sub {
94 print STDERR "FATAL: deadlock detected\n"; 104 print STDERR "FATAL: deadlock detected\n";
95 exit(51); 105 exit(51);
96}; 106};
97 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
98# we really need priorities... 118# we really need priorities...
99## my @ready; #d#
100our @ready = (); # the ready queue. hehe, rather broken ;) 119my @ready; # the ready queue. hehe, rather broken ;)
101 120
102# static methods. not really. 121# static methods. not really.
103 122
104=head2 STATIC METHODS 123=head2 STATIC METHODS
105 124
… …
123 142
124=cut 143=cut
125 144
126sub async(&@) { 145sub async(&@) {
127 my $pid = new Coro @_; 146 my $pid = new Coro @_;
147 $manager->ready; # this ensures that the stack is cloned from the manager
128 $pid->ready; 148 $pid->ready;
129 $pid; 149 $pid;
130} 150}
131 151
132=item schedule 152=item schedule
… …
143 # should be done using priorities :( 163 # should be done using priorities :(
144 ($prev, $current) = ($current, shift @ready || $idle); 164 ($prev, $current) = ($current, shift @ready || $idle);
145 Coro::State::transfer($prev, $current); 165 Coro::State::transfer($prev, $current);
146} 166}
147 167
148=item yield 168=item cede
149 169
150Yield to other processes. This function puts the current process into the 170"Cede" to other processes. This function puts the current process into the
151ready 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.
152 173
153=cut 174=cut
154 175
155sub yield { 176sub cede {
156 $current->ready; 177 $current->ready;
157 &schedule; 178 &schedule;
158} 179}
159 180
160=item terminate 181=item terminate
… …
164Future versions of this function will allow result arguments. 185Future versions of this function will allow result arguments.
165 186
166=cut 187=cut
167 188
168sub terminate { 189sub terminate {
169 $current->{_results} = [@_]; 190 push @destroy, $current;
191 $manager->ready;
170 &schedule; 192 &schedule;
193 # NORETURN
171} 194}
172 195
173=back 196=back
174 197
175# dynamic methods 198# dynamic methods
… …
216 239
217=cut 240=cut
218 241
2191; 2421;
220 243
244=head1 BUGS/LIMITATIONS
245
246 - could be faster, especially when the core would introduce special
247 support for coroutines (like it does for threads).
248 - there is still a memleak on coroutine termination that I could not
249 identify. Could be as small as a single SV.
250 - this module is not well-tested.
251 - if variables or arguments "disappear" (become undef) or become
252 corrupted please contact the author so he cen iron out the
253 remaining bugs.
254 - this module is not thread-safe. You must only ever use this module from
255 the same thread (this requirement might be loosened in the future to
256 allow per-thread schedulers, but Coro::State does not yet allow this).
257
221=head1 SEE ALSO 258=head1 SEE ALSO
222 259
223L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 260L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
224L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 261L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.
225 262

Diff Legend

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