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.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
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;
120$manager = new Coro sub { 138my $manager; $manager = new Coro sub {
121 while() { 139 while () {
122 # by overwriting the state object with the manager we destroy it 140 # by overwriting the state object with the manager we destroy it
123 # 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
124 # been readied multiple times. this is harmless since the manager 142 # been readied multiple times. this is harmless since the manager
125 # can be called as many times as neccessary and will always 143 # can be called as many times as neccessary and will always
126 # remove itself from the runqueue 144 # remove itself from the runqueue
127 while (@destroy) { 145 while (@destroy) {
128 my $coro = pop @destroy; 146 my $coro = pop @destroy;
129 $coro->{status} ||= []; 147 $coro->{status} ||= [];
130 $_->ready for @{delete $coro->{join} || []}; 148 $_->ready for @{delete $coro->{join} || []};
131 $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);
132 } 155 }
133 &schedule; 156 &schedule;
134 } 157 }
135}; 158};
136 159
137# static methods. not really. 160# static methods. not really.
138 161
162=back
163
139=head2 STATIC METHODS 164=head2 STATIC METHODS
140 165
141Static methods are actually functions that operate on the current process only. 166Static methods are actually functions that operate on the current process only.
142 167
143=over 4 168=over 4
… …
145=item async { ... } [@args...] 170=item async { ... } [@args...]
146 171
147Create a new asynchronous process and return it's process object 172Create a new asynchronous process and return it's process object
148(usually unused). When the sub returns the new process is automatically 173(usually unused). When the sub returns the new process is automatically
149terminated. 174terminated.
175
176When the coroutine dies, the program will exit, just as in the main
177program.
150 178
151 # create a new coroutine that just prints its arguments 179 # create a new coroutine that just prints its arguments
152 async { 180 async {
153 print "@_\n"; 181 print "@_\n";
154 } 1,2,3,4; 182 } 1,2,3,4;
155 183
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 184=cut
160 185
161sub async(&@) { 186sub async(&@) {
162 my $pid = new Coro @_; 187 my $pid = new Coro @_;
163 $manager->ready; # this ensures that the stack is cloned from the manager
164 $pid->ready; 188 $pid->ready;
165 $pid; 189 $pid
166} 190}
167 191
168=item schedule 192=item schedule
169 193
170Calls 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
… …
181 205
182=cut 206=cut
183 207
184=item terminate [arg...] 208=item terminate [arg...]
185 209
186Terminates the current process. 210Terminates the current process with the given status values (see L<cancel>).
187
188Future versions of this function will allow result arguments.
189 211
190=cut 212=cut
191 213
192sub terminate { 214sub terminate {
193 $current->{status} = [@_];
194 $current->cancel; 215 $current->cancel (@_);
195 &schedule;
196 die; # NORETURN
197} 216}
198 217
199=back 218=back
200 219
201# dynamic methods 220# dynamic methods
… …
213called. 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
214by calling the ready method. 233by calling the ready method.
215 234
216=cut 235=cut
217 236
218sub _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;
219 terminate &{+shift}; 241 terminate &{+shift};
220} 242}
221 243
222sub new { 244sub new {
223 my $class = shift; 245 my $class = shift;
224 bless { 246
225 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 247 $class->SUPER::new (\&_new_coro, @_)
226 }, $class;
227} 248}
228 249
229=item $process->ready 250=item $process->ready
230 251
231Put the given process into the ready queue. 252Put the given process into the ready queue.
232 253
233=cut 254=cut
234 255
235=item $process->cancel 256=item $process->cancel (arg...)
236 257
237Like 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).
238 260
239=cut 261=cut
240 262
241sub cancel { 263sub cancel {
264 my $self = shift;
265 $self->{status} = [@_];
242 push @destroy, $_[0]; 266 push @destroy, $self;
243 $manager->ready; 267 $manager->ready;
244 &schedule if $current == $_[0]; 268 &schedule if $current == $self;
245} 269}
246 270
247=item $process->join 271=item $process->join
248 272
249Wait until the coroutine terminates and return any values given to the 273Wait until the coroutine terminates and return any values given to the
250C<terminate> function. C<join> can be called multiple times from multiple 274C<terminate> or C<cancel> functions. C<join> can be called multiple times
251processes. 275from multiple processes.
252 276
253=cut 277=cut
254 278
255sub join { 279sub join {
256 my $self = shift; 280 my $self = shift;
… …
259 &schedule; 283 &schedule;
260 } 284 }
261 wantarray ? @{$self->{status}} : $self->{status}[0]; 285 wantarray ? @{$self->{status}} : $self->{status}[0];
262} 286}
263 287
264=item $oldprio = $process->prio($newprio) 288=item $oldprio = $process->prio ($newprio)
265 289
266Sets (or gets, if the argument is missing) the priority of the 290Sets (or gets, if the argument is missing) the priority of the
267process. Higher priority processes get run before lower priority 291process. Higher priority processes get run before lower priority
268processes. Priorities are smalled signed integer (currently -4 .. +3), 292processes. Priorities are small signed integers (currently -4 .. +3),
269that 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
270to get then): 294to get then):
271 295
272 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 296 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
273 3 > 1 > 0 > -1 > -3 > -4 297 3 > 1 > 0 > -1 > -3 > -4
… …
281Changing the priority of the current process will take effect immediately, 305Changing the priority of the current process will take effect immediately,
282but changing the priority of processes in the ready queue (but not 306but changing the priority of processes in the ready queue (but not
283running) will only take effect after the next schedule (of that 307running) will only take effect after the next schedule (of that
284process). 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.
285 309
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) 310=item $newprio = $process->nice ($change)
295 311
296Similar 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.
297higher values mean lower priority, just as in unix). 313higher values mean lower priority, just as in unix).
298 314
299=cut
300
301sub nice {
302 $_[0]{prio} -= $_[1];
303}
304
305=item $olddesc = $process->desc($newdesc) 315=item $olddesc = $process->desc ($newdesc)
306 316
307Sets (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
308process. 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.
309 319
310=cut 320=cut
… …
321 331
3221; 3321;
323 333
324=head1 BUGS/LIMITATIONS 334=head1 BUGS/LIMITATIONS
325 335
326 - you must make very sure that no coro is still active on global destruction. 336 - you must make very sure that no coro is still active on global
327 very bad things might happen otherwise (usually segfaults). 337 destruction. very bad things might happen otherwise (usually segfaults).
338
328 - this module is not thread-safe. You should only ever use this module from 339 - 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 340 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). 341 to allow per-thread schedulers, but Coro::State does not yet allow
342 this).
331 343
332=head1 SEE ALSO 344=head1 SEE ALSO
333 345
334L<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>.
335L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 347
336L<Coro::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>
337 353
338=head1 AUTHOR 354=head1 AUTHOR
339 355
340 Marc Lehmann <pcg@goof.com> 356 Marc Lehmann <schmorp@schmorp.de>
341 http://www.goof.com/pcg/marc/ 357 http://home.schmorp.de/
342 358
343=cut 359=cut
344 360

Diff Legend

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