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

Comparing Coro/Coro.pm (file contents):
Revision 1.82 by root, Fri Nov 24 13:40:36 2006 UTC vs.
Revision 1.89 by root, Mon Nov 27 02:01:33 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.5'; 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}->_clone_state_from ($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
176Calling C<exit> in a coroutine will not work correctly, so do not do that.
177
168When the coroutine dies, the program will exit, just as in the main 178When the coroutine dies, the program will exit, just as in the main
169program. 179program.
170 180
171 # create a new coroutine that just prints its arguments 181 # create a new coroutine that just prints its arguments
172 async { 182 async {
… …
175 185
176=cut 186=cut
177 187
178sub async(&@) { 188sub async(&@) {
179 my $pid = new Coro @_; 189 my $pid = new Coro @_;
180 $manager->ready; # this ensures that the stack is cloned from the manager
181 $pid->ready; 190 $pid->ready;
182 $pid; 191 $pid
183} 192}
184 193
185=item schedule 194=item schedule
186 195
187Calls the scheduler. Please note that the current process will not be put 196Calls the scheduler. Please note that the current process will not be put
… …
223Create a new process and return it. When the sub returns the process 232Create a new process and return it. When the sub returns the process
224automatically terminates as if C<terminate> with the returned values were 233automatically terminates as if C<terminate> with the returned values were
225called. To make the process run you must first put it into the ready queue 234called. To make the process run you must first put it into the ready queue
226by calling the ready method. 235by calling the ready method.
227 236
228=cut 237Calling C<exit> in a coroutine will not work correctly, so do not do that.
229 238
239=cut
240
230sub _newcoro { 241sub _new_coro {
231 terminate &{+shift}; 242 terminate &{+shift};
232} 243}
233 244
234sub new { 245sub new {
235 my $class = shift; 246 my $class = shift;
236 bless { 247
237 _coro_state => (new Coro::State \&_newcoro, @_), 248 $class->SUPER::new (\&_new_coro, @_)
238 }, $class;
239} 249}
240 250
241=item $process->ready 251=item $process->ready
242 252
243Put the given process into the ready queue. 253Put the given process into the ready queue.
… …
296Changing the priority of the current process will take effect immediately, 306Changing the priority of the current process will take effect immediately,
297but changing the priority of processes in the ready queue (but not 307but changing the priority of processes in the ready queue (but not
298running) will only take effect after the next schedule (of that 308running) will only take effect after the next schedule (of that
299process). This is a bug that will be fixed in some future version. 309process). This is a bug that will be fixed in some future version.
300 310
301=cut
302
303sub prio {
304 shift->{_coro_state}->prio (@_)
305}
306
307=item $newprio = $process->nice ($change) 311=item $newprio = $process->nice ($change)
308 312
309Similar to C<prio>, but subtract the given value from the priority (i.e. 313Similar to C<prio>, but subtract the given value from the priority (i.e.
310higher values mean lower priority, just as in unix). 314higher values mean lower priority, just as in unix).
311
312=cut
313
314sub nice {
315 shift->{_coro_state}->nice (@_)
316}
317 315
318=item $olddesc = $process->desc ($newdesc) 316=item $olddesc = $process->desc ($newdesc)
319 317
320Sets (or gets in case the argument is missing) the description for this 318Sets (or gets in case the argument is missing) the description for this
321process. This is just a free-form string you can associate with a process. 319process. This is just a free-form string you can associate with a process.

Diff Legend

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