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

Comparing Coro/Coro.pm (file contents):
Revision 1.53 by root, Tue May 27 01:15:26 2003 UTC vs.
Revision 1.90 by root, Thu Nov 30 18:21:14 2006 UTC

… …
30 30
31=cut 31=cut
32 32
33package Coro; 33package Coro;
34 34
35use strict;
35no warnings qw(uninitialized); 36no warnings "uninitialized";
36 37
37use Coro::State; 38use Coro::State;
38 39
39use base Exporter; 40use base qw(Coro::State Exporter);
40 41
41$VERSION = 0.7; 42our $idle; # idle handler
43our $main; # main coroutine
44our $current; # current coroutine
42 45
46our $VERSION = '3.0';
47
43@EXPORT = qw(async cede schedule terminate current); 48our @EXPORT = qw(async cede schedule terminate current);
44%EXPORT_TAGS = ( 49our %EXPORT_TAGS = (
45 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)],
46); 51);
47@EXPORT_OK = @{$EXPORT_TAGS{prio}}; 52our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
48 53
49{ 54{
50 my @async; 55 my @async;
51 my $init; 56 my $init;
52 57
53 # this way of handling attributes simply is NOT scalable ;() 58 # this way of handling attributes simply is NOT scalable ;()
54 sub import { 59 sub import {
60 no strict 'refs';
61
55 Coro->export_to_level(1, @_); 62 Coro->export_to_level(1, @_);
63
56 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 64 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
57 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { 65 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
58 my ($package, $ref) = (shift, shift); 66 my ($package, $ref) = (shift, shift);
59 my @attrs; 67 my @attrs;
60 for (@_) { 68 for (@_) {
… …
83 91
84This coroutine represents the main program. 92This coroutine represents the main program.
85 93
86=cut 94=cut
87 95
88our $main = new Coro; 96$main = new Coro;
89 97
90=item $current (or as function: current) 98=item $current (or as function: current)
91 99
92The 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.
93 106
94=cut 107=cut
95 108
96# maybe some other module used Coro::Specific before... 109# maybe some other module used Coro::Specific before...
97if ($current) { 110if ($current) {
98 $main->{specific} = $current->{specific}; 111 $main->{specific} = $current->{specific};
99} 112}
100 113
101our $current = $main; 114$current = $main;
102 115
103sub current() { $current } 116sub current() { $current }
104 117
105=item $idle 118=item $idle
106 119
107The coroutine to switch to when no other coroutine is running. The default 120A callback that is called whenever the scheduler finds no ready coroutines
108implementation prints "FATAL: deadlock detected" and exits. 121to run. The default implementation prints "FATAL: deadlock detected" and
122exits.
109 123
110=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.
111 127
112# should be done using priorities :( 128=cut
113our $idle = new Coro sub { 129
130$idle = sub {
114 print STDERR "FATAL: deadlock detected\n"; 131 print STDERR "FATAL: deadlock detected\n";
115 exit(51); 132 exit (51);
116}; 133};
117 134
118# this coroutine is necessary because a coroutine 135# this coroutine is necessary because a coroutine
119# cannot destroy itself. 136# cannot destroy itself.
120my @destroy; 137my @destroy;
121my $manager;
122$manager = new Coro sub { 138my $manager; $manager = new Coro sub {
123 while() { 139 while () {
124 # by overwriting the state object with the manager we destroy it 140 # by overwriting the state object with the manager we destroy it
125 # 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
126 # been readied multiple times. this is harmless since the manager 142 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always 143 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue 144 # remove itself from the runqueue
129 while (@destroy) { 145 while (@destroy) {
130 my $coro = pop @destroy; 146 my $coro = pop @destroy;
131 $coro->{status} ||= []; 147 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []}; 148 $_->ready for @{delete $coro->{join} || []};
133 $coro->{_coro_state} = $manager->{_coro_state}; 149
150 # the next line destroys the coro state, but keeps the
151 # process itself intact (we basically make it a zombie
152 # process that always runs the manager thread, so it's possible
153 # to transfer() to this process).
154 $coro->_clone_state_from ($manager);
134 } 155 }
135 &schedule; 156 &schedule;
136 } 157 }
137}; 158};
138 159
… …
150 171
151Create a new asynchronous process and return it's process object 172Create a new asynchronous process and return it's process object
152(usually unused). When the sub returns the new process is automatically 173(usually unused). When the sub returns the new process is automatically
153terminated. 174terminated.
154 175
176Calling C<exit> in a coroutine will not work correctly, so do not do that.
177
178When the coroutine dies, the program will exit, just as in the main
179program.
180
155 # create a new coroutine that just prints its arguments 181 # create a new coroutine that just prints its arguments
156 async { 182 async {
157 print "@_\n"; 183 print "@_\n";
158 } 1,2,3,4; 184 } 1,2,3,4;
159 185
160The coderef you submit MUST NOT be a closure that refers to variables
161in an outer scope. This does NOT work. Pass arguments into it instead.
162
163=cut 186=cut
164 187
165sub async(&@) { 188sub async(&@) {
166 my $pid = new Coro @_; 189 my $pid = new Coro @_;
167 $manager->ready; # this ensures that the stack is cloned from the manager
168 $pid->ready; 190 $pid->ready;
169 $pid; 191 $pid
170} 192}
171 193
172=item schedule 194=item schedule
173 195
174Calls 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
… …
185 207
186=cut 208=cut
187 209
188=item terminate [arg...] 210=item terminate [arg...]
189 211
190Terminates the current process. 212Terminates the current process with the given status values (see L<cancel>).
191
192Future versions of this function will allow result arguments.
193 213
194=cut 214=cut
195 215
196sub terminate { 216sub terminate {
197 $current->{status} = [@_];
198 $current->cancel; 217 $current->cancel (@_);
199 &schedule;
200 die; # NORETURN
201} 218}
202 219
203=back 220=back
204 221
205# dynamic methods 222# dynamic methods
… …
215Create 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
216automatically terminates as if C<terminate> with the returned values were 233automatically terminates as if C<terminate> with the returned values were
217called. 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
218by calling the ready method. 235by calling the ready method.
219 236
220=cut 237Calling C<exit> in a coroutine will not work correctly, so do not do that.
221 238
239=cut
240
222sub _newcoro { 241sub _new_coro {
223 terminate &{+shift}; 242 terminate &{+shift};
224} 243}
225 244
226sub new { 245sub new {
227 my $class = shift; 246 my $class = shift;
228 bless {
229 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
230 }, $class;
231}
232 247
248 $class->SUPER::new (\&_new_coro, @_)
249}
250
233=item $process->ready 251=item $success = $process->ready
234 252
235Put the given process into the ready queue. 253Put the given process into the ready queue (according to it's priority)
254and return true. If the process is already in the ready queue, do nothing
255and return false.
236 256
237=cut 257=item $is_ready = $process->is_ready
238 258
259Return wether the process is currently the ready queue or not,
260
239=item $process->cancel 261=item $process->cancel (arg...)
240 262
241Like C<terminate>, but terminates the specified process instead. 263Terminates the given process and makes it return the given arguments as
264status (default: the empty list).
242 265
243=cut 266=cut
244 267
245sub cancel { 268sub cancel {
269 my $self = shift;
270 $self->{status} = [@_];
246 push @destroy, $_[0]; 271 push @destroy, $self;
247 $manager->ready; 272 $manager->ready;
248 &schedule if $current == $_[0]; 273 &schedule if $current == $self;
249} 274}
250 275
251=item $process->join 276=item $process->join
252 277
253Wait until the coroutine terminates and return any values given to the 278Wait until the coroutine terminates and return any values given to the
254C<terminate> function. C<join> can be called multiple times from multiple 279C<terminate> or C<cancel> functions. C<join> can be called multiple times
255processes. 280from multiple processes.
256 281
257=cut 282=cut
258 283
259sub join { 284sub join {
260 my $self = shift; 285 my $self = shift;
… …
263 &schedule; 288 &schedule;
264 } 289 }
265 wantarray ? @{$self->{status}} : $self->{status}[0]; 290 wantarray ? @{$self->{status}} : $self->{status}[0];
266} 291}
267 292
268=item $oldprio = $process->prio($newprio) 293=item $oldprio = $process->prio ($newprio)
269 294
270Sets (or gets, if the argument is missing) the priority of the 295Sets (or gets, if the argument is missing) the priority of the
271process. Higher priority processes get run before lower priority 296process. Higher priority processes get run before lower priority
272processes. Priorities are small signed integers (currently -4 .. +3), 297processes. Priorities are small signed integers (currently -4 .. +3),
273that you can refer to using PRIO_xxx constants (use the import tag :prio 298that you can refer to using PRIO_xxx constants (use the import tag :prio
… …
285Changing the priority of the current process will take effect immediately, 310Changing the priority of the current process will take effect immediately,
286but changing the priority of processes in the ready queue (but not 311but changing the priority of processes in the ready queue (but not
287running) will only take effect after the next schedule (of that 312running) will only take effect after the next schedule (of that
288process). This is a bug that will be fixed in some future version. 313process). This is a bug that will be fixed in some future version.
289 314
290=cut
291
292sub prio {
293 my $old = $_[0]{prio};
294 $_[0]{prio} = $_[1] if @_ > 1;
295 $old;
296}
297
298=item $newprio = $process->nice($change) 315=item $newprio = $process->nice ($change)
299 316
300Similar to C<prio>, but subtract the given value from the priority (i.e. 317Similar to C<prio>, but subtract the given value from the priority (i.e.
301higher values mean lower priority, just as in unix). 318higher values mean lower priority, just as in unix).
302 319
303=cut
304
305sub nice {
306 $_[0]{prio} -= $_[1];
307}
308
309=item $olddesc = $process->desc($newdesc) 320=item $olddesc = $process->desc ($newdesc)
310 321
311Sets (or gets in case the argument is missing) the description for this 322Sets (or gets in case the argument is missing) the description for this
312process. This is just a free-form string you can associate with a process. 323process. This is just a free-form string you can associate with a process.
313 324
314=cut 325=cut
… …
335 to allow per-thread schedulers, but Coro::State does not yet allow 346 to allow per-thread schedulers, but Coro::State does not yet allow
336 this). 347 this).
337 348
338=head1 SEE ALSO 349=head1 SEE ALSO
339 350
340L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 351Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
341L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 352
342L<Coro::Handle>, L<Coro::Socket>. 353Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
354
355Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
356
357Embedding: L<Coro:MakeMaker>
343 358
344=head1 AUTHOR 359=head1 AUTHOR
345 360
346 Marc Lehmann <pcg@goof.com> 361 Marc Lehmann <schmorp@schmorp.de>
347 http://www.goof.com/pcg/marc/ 362 http://home.schmorp.de/
348 363
349=cut 364=cut
350 365

Diff Legend

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