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

Comparing Coro/Coro.pm (file contents):
Revision 1.56 by pcg, Sat Nov 15 03:53:10 2003 UTC vs.
Revision 1.85 by root, Sat Nov 25 00:56:35 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.9"; 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; 138my $manager;
124$manager = new Coro sub { 139$manager = new Coro sub {
125 while() { 140 while () {
126 # by overwriting the state object with the manager we destroy it 141 # by overwriting the state object with the manager we destroy it
127 # while still being able to schedule this coroutine (in case it has 142 # while still being able to schedule this coroutine (in case it has
128 # been readied multiple times. this is harmless since the manager 143 # been readied multiple times. this is harmless since the manager
129 # can be called as many times as neccessary and will always 144 # can be called as many times as neccessary and will always
130 # remove itself from the runqueue 145 # remove itself from the runqueue
131 while (@destroy) { 146 while (@destroy) {
132 my $coro = pop @destroy; 147 my $coro = pop @destroy;
133 $coro->{status} ||= []; 148 $coro->{status} ||= [];
134 $_->ready for @{delete $coro->{join} || []}; 149 $_->ready for @{delete $coro->{join} || []};
135 $coro->{_coro_state} = $manager->{_coro_state}; 150
151 # the next line destroys the coro state, but keeps the
152 # process itself intact (we basically make it a zombie
153 # process that always runs the manager thread, so it's possible
154 # to transfer() to this process).
155 $coro->_clone_state_from ($manager);
136 } 156 }
137 &schedule; 157 &schedule;
138 } 158 }
139}; 159};
140 160
… …
152 172
153Create a new asynchronous process and return it's process object 173Create a new asynchronous process and return it's process object
154(usually unused). When the sub returns the new process is automatically 174(usually unused). When the sub returns the new process is automatically
155terminated. 175terminated.
156 176
177When the coroutine dies, the program will exit, just as in the main
178program.
179
157 # create a new coroutine that just prints its arguments 180 # create a new coroutine that just prints its arguments
158 async { 181 async {
159 print "@_\n"; 182 print "@_\n";
160 } 1,2,3,4; 183 } 1,2,3,4;
161 184
162The coderef you submit MUST NOT be a closure that refers to variables
163in an outer scope. This does NOT work. Pass arguments into it instead.
164
165=cut 185=cut
166 186
167sub async(&@) { 187sub async(&@) {
168 my $pid = new Coro @_; 188 my $pid = new Coro @_;
169 $manager->ready; # this ensures that the stack is cloned from the manager
170 $pid->ready; 189 $pid->ready;
171 $pid; 190 $pid
172} 191}
173 192
174=item schedule 193=item schedule
175 194
176Calls the scheduler. Please note that the current process will not be put 195Calls the scheduler. Please note that the current process will not be put
… …
187 206
188=cut 207=cut
189 208
190=item terminate [arg...] 209=item terminate [arg...]
191 210
192Terminates the current process. 211Terminates the current process with the given status values (see L<cancel>).
193
194Future versions of this function will allow result arguments.
195 212
196=cut 213=cut
197 214
198sub terminate { 215sub terminate {
199 $current->{status} = [@_];
200 $current->cancel; 216 $current->cancel (@_);
201 &schedule;
202 die; # NORETURN
203} 217}
204 218
205=back 219=back
206 220
207# dynamic methods 221# dynamic methods
… …
219called. To make the process run you must first put it into the ready queue 233called. To make the process run you must first put it into the ready queue
220by calling the ready method. 234by calling the ready method.
221 235
222=cut 236=cut
223 237
224sub _newcoro { 238sub _new_coro {
239 $current->_clear_idle_sp; # set the idle sp on the following cede
240 _set_cede_self; # ensures that cede cede's us first
241 cede;
225 terminate &{+shift}; 242 terminate &{+shift};
226} 243}
227 244
228sub new { 245sub new {
229 my $class = shift; 246 my $class = shift;
230 bless { 247
231 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 248 $class->SUPER::new (\&_new_coro, @_)
232 }, $class;
233} 249}
234 250
235=item $process->ready 251=item $process->ready
236 252
237Put the given process into the ready queue. 253Put the given process into the ready queue.
238 254
239=cut 255=cut
240 256
241=item $process->cancel 257=item $process->cancel (arg...)
242 258
243Like C<terminate>, but terminates the specified process instead. 259Terminates the given process and makes it return the given arguments as
260status (default: the empty list).
244 261
245=cut 262=cut
246 263
247sub cancel { 264sub cancel {
265 my $self = shift;
266 $self->{status} = [@_];
248 push @destroy, $_[0]; 267 push @destroy, $self;
249 $manager->ready; 268 $manager->ready;
250 &schedule if $current == $_[0]; 269 &schedule if $current == $self;
251} 270}
252 271
253=item $process->join 272=item $process->join
254 273
255Wait until the coroutine terminates and return any values given to the 274Wait until the coroutine terminates and return any values given to the
256C<terminate> function. C<join> can be called multiple times from multiple 275C<terminate> or C<cancel> functions. C<join> can be called multiple times
257processes. 276from multiple processes.
258 277
259=cut 278=cut
260 279
261sub join { 280sub join {
262 my $self = shift; 281 my $self = shift;
… …
265 &schedule; 284 &schedule;
266 } 285 }
267 wantarray ? @{$self->{status}} : $self->{status}[0]; 286 wantarray ? @{$self->{status}} : $self->{status}[0];
268} 287}
269 288
270=item $oldprio = $process->prio($newprio) 289=item $oldprio = $process->prio ($newprio)
271 290
272Sets (or gets, if the argument is missing) the priority of the 291Sets (or gets, if the argument is missing) the priority of the
273process. Higher priority processes get run before lower priority 292process. Higher priority processes get run before lower priority
274processes. Priorities are small signed integers (currently -4 .. +3), 293processes. Priorities are small signed integers (currently -4 .. +3),
275that you can refer to using PRIO_xxx constants (use the import tag :prio 294that you can refer to using PRIO_xxx constants (use the import tag :prio
… …
287Changing the priority of the current process will take effect immediately, 306Changing the priority of the current process will take effect immediately,
288but changing the priority of processes in the ready queue (but not 307but changing the priority of processes in the ready queue (but not
289running) will only take effect after the next schedule (of that 308running) will only take effect after the next schedule (of that
290process). 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.
291 310
292=cut
293
294sub prio {
295 my $old = $_[0]{prio};
296 $_[0]{prio} = $_[1] if @_ > 1;
297 $old;
298}
299
300=item $newprio = $process->nice($change) 311=item $newprio = $process->nice ($change)
301 312
302Similar 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.
303higher values mean lower priority, just as in unix). 314higher values mean lower priority, just as in unix).
304 315
305=cut
306
307sub nice {
308 $_[0]{prio} -= $_[1];
309}
310
311=item $olddesc = $process->desc($newdesc) 316=item $olddesc = $process->desc ($newdesc)
312 317
313Sets (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
314process. 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.
315 320
316=cut 321=cut
… …
337 to allow per-thread schedulers, but Coro::State does not yet allow 342 to allow per-thread schedulers, but Coro::State does not yet allow
338 this). 343 this).
339 344
340=head1 SEE ALSO 345=head1 SEE ALSO
341 346
342L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 347Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
343L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>, 348
344L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>. 349Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
350
351Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
352
353Embedding: L<Coro:MakeMaker>
345 354
346=head1 AUTHOR 355=head1 AUTHOR
347 356
348 Marc Lehmann <pcg@goof.com> 357 Marc Lehmann <schmorp@schmorp.de>
349 http://www.goof.com/pcg/marc/ 358 http://home.schmorp.de/
350 359
351=cut 360=cut
352 361

Diff Legend

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