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

Comparing Coro/Coro.pm (file contents):
Revision 1.43 by root, Sun Nov 25 20:04:04 2001 UTC vs.
Revision 1.83 by root, Fri Nov 24 15:34:33 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
42our $idle; # idle handler
43our $main; # main coroutine
44our $current; # current coroutine
45
41$VERSION = 0.52; 46our $VERSION = '2.5';
42 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; 138my $manager;
122$manager = new Coro sub { 139$manager = new Coro sub {
123 while() { 140 while () {
124 # by overwriting the state object with the manager we destroy it 141 # by overwriting the state object with the manager we destroy it
125 # 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
126 # been readied multiple times. this is harmless since the manager 143 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always 144 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue 145 # remove itself from the runqueue
129 while (@destroy) { 146 while (@destroy) {
130 my $coro = pop @destroy; 147 my $coro = pop @destroy;
131 $coro->{status} ||= []; 148 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []}; 149 $_->ready for @{delete $coro->{join} || []};
133 $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);
134 } 156 }
135 &schedule; 157 &schedule;
136 } 158 }
137}; 159};
138 160
… …
150 172
151Create a new asynchronous process and return it's process object 173Create a new asynchronous process and return it's process object
152(usually unused). When the sub returns the new process is automatically 174(usually unused). When the sub returns the new process is automatically
153terminated. 175terminated.
154 176
177When the coroutine dies, the program will exit, just as in the main
178program.
179
155 # create a new coroutine that just prints its arguments 180 # create a new coroutine that just prints its arguments
156 async { 181 async {
157 print "@_\n"; 182 print "@_\n";
158 } 1,2,3,4; 183 } 1,2,3,4;
159
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 184
163=cut 185=cut
164 186
165sub async(&@) { 187sub async(&@) {
166 my $pid = new Coro @_; 188 my $pid = new Coro @_;
… …
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
… …
223 terminate &{+shift}; 240 terminate &{+shift};
224} 241}
225 242
226sub new { 243sub new {
227 my $class = shift; 244 my $class = shift;
228 bless { 245
229 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 246 $class->SUPER::new (\&_newcoro, @_)
230 }, $class;
231} 247}
232 248
233=item $process->ready 249=item $process->ready
234 250
235Put the given process into the ready queue. 251Put the given process into the ready queue.
236 252
237=cut 253=cut
238 254
239=item $process->cancel 255=item $process->cancel (arg...)
240 256
241Like C<terminate>, but terminates the specified process instead. 257Terminates the given process and makes it return the given arguments as
258status (default: the empty list).
242 259
243=cut 260=cut
244 261
245sub cancel { 262sub cancel {
263 my $self = shift;
264 $self->{status} = [@_];
246 push @destroy, $_[0]; 265 push @destroy, $self;
247 $manager->ready; 266 $manager->ready;
248 &schedule if $current == $_[0]; 267 &schedule if $current == $self;
249} 268}
250 269
251=item $process->join 270=item $process->join
252 271
253Wait until the coroutine terminates and return any values given to the 272Wait until the coroutine terminates and return any values given to the
254C<terminate> function. C<join> can be called multiple times from multiple 273C<terminate> or C<cancel> functions. C<join> can be called multiple times
255processes. 274from multiple processes.
256 275
257=cut 276=cut
258 277
259sub join { 278sub join {
260 my $self = shift; 279 my $self = shift;
… …
263 &schedule; 282 &schedule;
264 } 283 }
265 wantarray ? @{$self->{status}} : $self->{status}[0]; 284 wantarray ? @{$self->{status}} : $self->{status}[0];
266} 285}
267 286
268=item $oldprio = $process->prio($newprio) 287=item $oldprio = $process->prio ($newprio)
269 288
270Sets (or gets, if the argument is missing) the priority of the 289Sets (or gets, if the argument is missing) the priority of the
271process. Higher priority processes get run before lower priority 290process. Higher priority processes get run before lower priority
272processes. Priorities are smalled signed integer (currently -4 .. +3), 291processes. Priorities are small signed integers (currently -4 .. +3),
273that you can refer to using PRIO_xxx constants (use the import tag :prio 292that you can refer to using PRIO_xxx constants (use the import tag :prio
274to get then): 293to get then):
275 294
276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 295 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277 3 > 1 > 0 > -1 > -3 > -4 296 3 > 1 > 0 > -1 > -3 > -4
… …
285Changing the priority of the current process will take effect immediately, 304Changing the priority of the current process will take effect immediately,
286but changing the priority of processes in the ready queue (but not 305but changing the priority of processes in the ready queue (but not
287running) will only take effect after the next schedule (of that 306running) will only take effect after the next schedule (of that
288process). This is a bug that will be fixed in some future version. 307process). This is a bug that will be fixed in some future version.
289 308
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) 309=item $newprio = $process->nice ($change)
299 310
300Similar to C<prio>, but subtract the given value from the priority (i.e. 311Similar to C<prio>, but subtract the given value from the priority (i.e.
301higher values mean lower priority, just as in unix). 312higher values mean lower priority, just as in unix).
302 313
303=cut
304
305sub nice {
306 $_[0]{prio} -= $_[1];
307}
308
309=item $olddesc = $process->desc($newdesc) 314=item $olddesc = $process->desc ($newdesc)
310 315
311Sets (or gets in case the argument is missing) the description for this 316Sets (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. 317process. This is just a free-form string you can associate with a process.
313 318
314=cut 319=cut
… …
325 330
3261; 3311;
327 332
328=head1 BUGS/LIMITATIONS 333=head1 BUGS/LIMITATIONS
329 334
330 - you must make very sure that no coro is still active on global destruction. 335 - you must make very sure that no coro is still active on global
331 very bad things might happen otherwise (usually segfaults). 336 destruction. very bad things might happen otherwise (usually segfaults).
337
332 - this module is not thread-safe. You should only ever use this module from 338 - this module is not thread-safe. You should only ever use this module
333 the same thread (this requirement might be loosened in the future to 339 from the same thread (this requirement might be losened in the future
334 allow per-thread schedulers, but Coro::State does not yet allow this). 340 to allow per-thread schedulers, but Coro::State does not yet allow
341 this).
335 342
336=head1 SEE ALSO 343=head1 SEE ALSO
337 344
338L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 345Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
339L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 346
340L<Coro::Handle>, L<Coro::Socket>. 347Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
348
349Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
350
351Embedding: L<Coro:MakeMaker>
341 352
342=head1 AUTHOR 353=head1 AUTHOR
343 354
344 Marc Lehmann <pcg@goof.com> 355 Marc Lehmann <schmorp@schmorp.de>
345 http://www.goof.com/pcg/marc/ 356 http://home.schmorp.de/
346 357
347=cut 358=cut
348 359

Diff Legend

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