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

Comparing Coro/Coro.pm (file contents):
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 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
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 (@_) {
… …
75 }; 83 };
76 } 84 }
77 85
78} 86}
79 87
88=over 4
89
80=item $main 90=item $main
81 91
82This coroutine represents the main program. 92This coroutine represents the main program.
83 93
84=cut 94=cut
85 95
86our $main = new Coro; 96$main = new Coro;
87 97
88=item $current (or as function: current) 98=item $current (or as function: current)
89 99
90The 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.
91 106
92=cut 107=cut
93 108
94# maybe some other module used Coro::Specific before... 109# maybe some other module used Coro::Specific before...
95if ($current) { 110if ($current) {
96 $main->{specific} = $current->{specific}; 111 $main->{specific} = $current->{specific};
97} 112}
98 113
99our $current = $main; 114$current = $main;
100 115
101sub current() { $current } 116sub current() { $current }
102 117
103=item $idle 118=item $idle
104 119
105The coroutine to switch to when no other coroutine is running. The default 120A callback that is called whenever the scheduler finds no ready coroutines
106implementation prints "FATAL: deadlock detected" and exits. 121to run. The default implementation prints "FATAL: deadlock detected" and
122exits.
107 123
108=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.
109 127
110# should be done using priorities :( 128=cut
111our $idle = new Coro sub { 129
130$idle = sub {
112 print STDERR "FATAL: deadlock detected\n"; 131 print STDERR "FATAL: deadlock detected\n";
113 exit(51); 132 exit (51);
114}; 133};
115 134
116# this coroutine is necessary because a coroutine 135# this coroutine is necessary because a coroutine
117# cannot destroy itself. 136# cannot destroy itself.
118my @destroy; 137my @destroy;
119my $manager; 138my $manager;
120$manager = new Coro sub { 139$manager = new Coro sub {
121 while() { 140 while () {
122 # by overwriting the state object with the manager we destroy it 141 # by overwriting the state object with the manager we destroy it
123 # 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
124 # been readied multiple times. this is harmless since the manager 143 # been readied multiple times. this is harmless since the manager
125 # can be called as many times as neccessary and will always 144 # can be called as many times as neccessary and will always
126 # remove itself from the runqueue 145 # remove itself from the runqueue
127 while (@destroy) { 146 while (@destroy) {
128 my $coro = pop @destroy; 147 my $coro = pop @destroy;
129 $coro->{status} ||= []; 148 $coro->{status} ||= [];
130 $_->ready for @{delete $coro->{join} || []}; 149 $_->ready for @{delete $coro->{join} || []};
131 $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);
132 } 156 }
133 &schedule; 157 &schedule;
134 } 158 }
135}; 159};
136 160
137# static methods. not really. 161# static methods. not really.
138 162
163=back
164
139=head2 STATIC METHODS 165=head2 STATIC METHODS
140 166
141Static methods are actually functions that operate on the current process only. 167Static methods are actually functions that operate on the current process only.
142 168
143=over 4 169=over 4
… …
145=item async { ... } [@args...] 171=item async { ... } [@args...]
146 172
147Create a new asynchronous process and return it's process object 173Create a new asynchronous process and return it's process object
148(usually unused). When the sub returns the new process is automatically 174(usually unused). When the sub returns the new process is automatically
149terminated. 175terminated.
176
177When the coroutine dies, the program will exit, just as in the main
178program.
150 179
151 # create a new coroutine that just prints its arguments 180 # create a new coroutine that just prints its arguments
152 async { 181 async {
153 print "@_\n"; 182 print "@_\n";
154 } 1,2,3,4; 183 } 1,2,3,4;
155 184
156The coderef you submit MUST NOT be a closure that refers to variables
157in an outer scope. This does NOT work. Pass arguments into it instead.
158
159=cut 185=cut
160 186
161sub async(&@) { 187sub async(&@) {
162 my $pid = new Coro @_; 188 my $pid = new Coro @_;
163 $manager->ready; # this ensures that the stack is cloned from the manager
164 $pid->ready; 189 $pid->ready;
165 $pid; 190 $pid
166} 191}
167 192
168=item schedule 193=item schedule
169 194
170Calls 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
… …
181 206
182=cut 207=cut
183 208
184=item terminate [arg...] 209=item terminate [arg...]
185 210
186Terminates the current process. 211Terminates the current process with the given status values (see L<cancel>).
187
188Future versions of this function will allow result arguments.
189 212
190=cut 213=cut
191 214
192sub terminate { 215sub terminate {
193 $current->{status} = [@_];
194 $current->cancel; 216 $current->cancel (@_);
195 &schedule;
196 die; # NORETURN
197} 217}
198 218
199=back 219=back
200 220
201# dynamic methods 221# dynamic methods
… …
213called. 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
214by calling the ready method. 234by calling the ready method.
215 235
216=cut 236=cut
217 237
218sub _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;
219 terminate &{+shift}; 242 terminate &{+shift};
220} 243}
221 244
222sub new { 245sub new {
223 my $class = shift; 246 my $class = shift;
224 bless { 247
225 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 248 $class->SUPER::new (\&_new_coro, @_)
226 }, $class;
227} 249}
228 250
229=item $process->ready 251=item $process->ready
230 252
231Put the given process into the ready queue. 253Put the given process into the ready queue.
232 254
233=cut 255=cut
234 256
235=item $process->cancel 257=item $process->cancel (arg...)
236 258
237Like 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).
238 261
239=cut 262=cut
240 263
241sub cancel { 264sub cancel {
265 my $self = shift;
266 $self->{status} = [@_];
242 push @destroy, $_[0]; 267 push @destroy, $self;
243 $manager->ready; 268 $manager->ready;
244 &schedule if $current == $_[0]; 269 &schedule if $current == $self;
245} 270}
246 271
247=item $process->join 272=item $process->join
248 273
249Wait until the coroutine terminates and return any values given to the 274Wait until the coroutine terminates and return any values given to the
250C<terminate> function. C<join> can be called multiple times from multiple 275C<terminate> or C<cancel> functions. C<join> can be called multiple times
251processes. 276from multiple processes.
252 277
253=cut 278=cut
254 279
255sub join { 280sub join {
256 my $self = shift; 281 my $self = shift;
… …
259 &schedule; 284 &schedule;
260 } 285 }
261 wantarray ? @{$self->{status}} : $self->{status}[0]; 286 wantarray ? @{$self->{status}} : $self->{status}[0];
262} 287}
263 288
264=item $oldprio = $process->prio($newprio) 289=item $oldprio = $process->prio ($newprio)
265 290
266Sets (or gets, if the argument is missing) the priority of the 291Sets (or gets, if the argument is missing) the priority of the
267process. Higher priority processes get run before lower priority 292process. Higher priority processes get run before lower priority
268processes. Priorities are smalled signed integer (currently -4 .. +3), 293processes. Priorities are small signed integers (currently -4 .. +3),
269that 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
270to get then): 295to get then):
271 296
272 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 297 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
273 3 > 1 > 0 > -1 > -3 > -4 298 3 > 1 > 0 > -1 > -3 > -4
… …
281Changing the priority of the current process will take effect immediately, 306Changing the priority of the current process will take effect immediately,
282but changing the priority of processes in the ready queue (but not 307but changing the priority of processes in the ready queue (but not
283running) will only take effect after the next schedule (of that 308running) will only take effect after the next schedule (of that
284process). 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.
285 310
286=cut
287
288sub prio {
289 my $old = $_[0]{prio};
290 $_[0]{prio} = $_[1] if @_ > 1;
291 $old;
292}
293
294=item $newprio = $process->nice($change) 311=item $newprio = $process->nice ($change)
295 312
296Similar 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.
297higher values mean lower priority, just as in unix). 314higher values mean lower priority, just as in unix).
298 315
299=cut
300
301sub nice {
302 $_[0]{prio} -= $_[1];
303}
304
305=item $olddesc = $process->desc($newdesc) 316=item $olddesc = $process->desc ($newdesc)
306 317
307Sets (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
308process. 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.
309 320
310=cut 321=cut
… …
321 332
3221; 3331;
323 334
324=head1 BUGS/LIMITATIONS 335=head1 BUGS/LIMITATIONS
325 336
326 - you must make very sure that no coro is still active on global destruction. 337 - you must make very sure that no coro is still active on global
327 very bad things might happen otherwise (usually segfaults). 338 destruction. very bad things might happen otherwise (usually segfaults).
339
328 - this module is not thread-safe. You should only ever use this module from 340 - this module is not thread-safe. You should only ever use this module
329 the same thread (this requirement might be loosened in the future to 341 from the same thread (this requirement might be losened in the future
330 allow per-thread schedulers, but Coro::State does not yet allow this). 342 to allow per-thread schedulers, but Coro::State does not yet allow
343 this).
331 344
332=head1 SEE ALSO 345=head1 SEE ALSO
333 346
334L<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>.
335L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 348
336L<Coro::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>
337 354
338=head1 AUTHOR 355=head1 AUTHOR
339 356
340 Marc Lehmann <pcg@goof.com> 357 Marc Lehmann <schmorp@schmorp.de>
341 http://www.goof.com/pcg/marc/ 358 http://home.schmorp.de/
342 359
343=cut 360=cut
344 361

Diff Legend

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