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

Comparing Coro/Coro.pm (file contents):
Revision 1.78 by root, Wed Nov 1 01:21:21 2006 UTC vs.
Revision 1.88 by root, Sun Nov 26 02:54:55 2006 UTC

… …
35use strict; 35use strict;
36no warnings "uninitialized"; 36no warnings "uninitialized";
37 37
38use Coro::State; 38use Coro::State;
39 39
40use base Exporter::; 40use base qw(Coro::State Exporter);
41 41
42our $idle; # idle coroutine 42our $idle; # idle handler
43our $main; # main coroutine 43our $main; # main coroutine
44our $current; # current coroutine 44our $current; # current coroutine
45 45
46our $VERSION = '2.1'; 46our $VERSION = '3.0';
47 47
48our @EXPORT = qw(async cede schedule terminate current); 48our @EXPORT = qw(async cede schedule terminate current);
49our %EXPORT_TAGS = ( 49our %EXPORT_TAGS = (
50 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 50 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
51); 51);
… …
95 95
96$main = new Coro; 96$main = new Coro;
97 97
98=item $current (or as function: current) 98=item $current (or as function: current)
99 99
100The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 100The current coroutine (the last coroutine switched to). The initial value
101is C<$main> (of course).
102
103This variable is B<strictly> I<read-only>. It is provided for performance
104reasons. If performance is not essentiel you are encouraged to use the
105C<Coro::current> function instead.
101 106
102=cut 107=cut
103 108
104# maybe some other module used Coro::Specific before... 109# maybe some other module used Coro::Specific before...
105if ($current) { 110if ($current) {
… …
110 115
111sub current() { $current } 116sub current() { $current }
112 117
113=item $idle 118=item $idle
114 119
115The coroutine to switch to when no other coroutine is running. The default 120A callback that is called whenever the scheduler finds no ready coroutines
116implementation prints "FATAL: deadlock detected" and exits. 121to run. The default implementation prints "FATAL: deadlock detected" and
122exits.
117 123
118=cut 124This hook is overwritten by modules such as C<Coro::Timer> and
125C<Coro::Event> to wait on an external event that hopefully wakes up some
126coroutine.
119 127
120# should be done using priorities :( 128=cut
121$idle = new Coro sub { 129
130$idle = sub {
122 print STDERR "FATAL: deadlock detected\n"; 131 print STDERR "FATAL: deadlock detected\n";
123 exit(51); 132 exit (51);
124}; 133};
125 134
126# this coroutine is necessary because a coroutine 135# this coroutine is necessary because a coroutine
127# cannot destroy itself. 136# cannot destroy itself.
128my @destroy; 137my @destroy;
129my $manager;
130$manager = new Coro sub { 138my $manager; $manager = new Coro sub {
131 while () { 139 while () {
132 # by overwriting the state object with the manager we destroy it 140 # by overwriting the state object with the manager we destroy it
133 # while still being able to schedule this coroutine (in case it has 141 # while still being able to schedule this coroutine (in case it has
134 # been readied multiple times. this is harmless since the manager 142 # been readied multiple times. this is harmless since the manager
135 # can be called as many times as neccessary and will always 143 # can be called as many times as neccessary and will always
… …
137 while (@destroy) { 145 while (@destroy) {
138 my $coro = pop @destroy; 146 my $coro = pop @destroy;
139 $coro->{status} ||= []; 147 $coro->{status} ||= [];
140 $_->ready for @{delete $coro->{join} || []}; 148 $_->ready for @{delete $coro->{join} || []};
141 149
142 # the next line destroys the _coro_state, but keeps the 150 # the next line destroys the coro state, but keeps the
143 # process itself intact (we basically make it a zombie 151 # process itself intact (we basically make it a zombie
144 # process that always runs the manager thread, so it's possible 152 # process that always runs the manager thread, so it's possible
145 # to transfer() to this process). 153 # to transfer() to this process).
146 $coro->{_coro_state} = $manager->{_coro_state}; 154 $coro->_clone_state_from ($manager);
147 } 155 }
148 &schedule; 156 &schedule;
149 } 157 }
150}; 158};
151 159
… …
163 171
164Create a new asynchronous process and return it's process object 172Create a new asynchronous process and return it's process object
165(usually unused). When the sub returns the new process is automatically 173(usually unused). When the sub returns the new process is automatically
166terminated. 174terminated.
167 175
176When the coroutine dies, the program will exit, just as in the main
177program.
178
168 # create a new coroutine that just prints its arguments 179 # create a new coroutine that just prints its arguments
169 async { 180 async {
170 print "@_\n"; 181 print "@_\n";
171 } 1,2,3,4; 182 } 1,2,3,4;
172 183
173=cut 184=cut
174 185
175sub async(&@) { 186sub async(&@) {
176 my $pid = new Coro @_; 187 my $pid = new Coro @_;
177 $manager->ready; # this ensures that the stack is cloned from the manager
178 $pid->ready; 188 $pid->ready;
179 $pid; 189 $pid
180} 190}
181 191
182=item schedule 192=item schedule
183 193
184Calls the scheduler. Please note that the current process will not be put 194Calls the scheduler. Please note that the current process will not be put
… …
222called. To make the process run you must first put it into the ready queue 232called. To make the process run you must first put it into the ready queue
223by calling the ready method. 233by calling the ready method.
224 234
225=cut 235=cut
226 236
227sub _newcoro { 237sub _new_coro {
228 terminate &{+shift}; 238 terminate &{+shift};
229} 239}
230 240
231sub new { 241sub new {
232 my $class = shift; 242 my $class = shift;
233 bless { 243
234 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 244 $class->SUPER::new (\&_new_coro, @_)
235 }, $class;
236} 245}
237 246
238=item $process->ready 247=item $process->ready
239 248
240Put the given process into the ready queue. 249Put the given process into the ready queue.
241 250
242=cut 251=cut
243 252
244=item $process->cancel (arg...) 253=item $process->cancel (arg...)
245 254
246Temrinates the given process and makes it return the given arguments as 255Terminates the given process and makes it return the given arguments as
247status (default: the empty list). 256status (default: the empty list).
248 257
249=cut 258=cut
250 259
251sub cancel { 260sub cancel {
… …
271 &schedule; 280 &schedule;
272 } 281 }
273 wantarray ? @{$self->{status}} : $self->{status}[0]; 282 wantarray ? @{$self->{status}} : $self->{status}[0];
274} 283}
275 284
276=item $oldprio = $process->prio($newprio) 285=item $oldprio = $process->prio ($newprio)
277 286
278Sets (or gets, if the argument is missing) the priority of the 287Sets (or gets, if the argument is missing) the priority of the
279process. Higher priority processes get run before lower priority 288process. Higher priority processes get run before lower priority
280processes. Priorities are small signed integers (currently -4 .. +3), 289processes. Priorities are small signed integers (currently -4 .. +3),
281that you can refer to using PRIO_xxx constants (use the import tag :prio 290that you can refer to using PRIO_xxx constants (use the import tag :prio
… …
293Changing the priority of the current process will take effect immediately, 302Changing the priority of the current process will take effect immediately,
294but changing the priority of processes in the ready queue (but not 303but changing the priority of processes in the ready queue (but not
295running) will only take effect after the next schedule (of that 304running) will only take effect after the next schedule (of that
296process). This is a bug that will be fixed in some future version. 305process). This is a bug that will be fixed in some future version.
297 306
298=cut
299
300sub prio {
301 my $old = $_[0]{prio};
302 $_[0]{prio} = $_[1] if @_ > 1;
303 $old;
304}
305
306=item $newprio = $process->nice($change) 307=item $newprio = $process->nice ($change)
307 308
308Similar to C<prio>, but subtract the given value from the priority (i.e. 309Similar to C<prio>, but subtract the given value from the priority (i.e.
309higher values mean lower priority, just as in unix). 310higher values mean lower priority, just as in unix).
310 311
311=cut
312
313sub nice {
314 $_[0]{prio} -= $_[1];
315}
316
317=item $olddesc = $process->desc($newdesc) 312=item $olddesc = $process->desc ($newdesc)
318 313
319Sets (or gets in case the argument is missing) the description for this 314Sets (or gets in case the argument is missing) the description for this
320process. This is just a free-form string you can associate with a process. 315process. This is just a free-form string you can associate with a process.
321 316
322=cut 317=cut

Diff Legend

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