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

Comparing Coro/Coro.pm (file contents):
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC vs.
Revision 1.86 by root, Sat Nov 25 01:14:11 2006 UTC

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

Diff Legend

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