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

Comparing Coro/Coro.pm (file contents):
Revision 1.41 by root, Tue Nov 6 20:34:09 2001 UTC vs.
Revision 1.86 by root, Sat Nov 25 01:14:11 2006 UTC

… …
19 cede; 19 cede;
20 20
21=head1 DESCRIPTION 21=head1 DESCRIPTION
22 22
23This module collection manages coroutines. Coroutines are similar to 23This module collection manages coroutines. Coroutines are similar to
24Threads but don't run in parallel. 24threads but don't run in parallel.
25
26This module is still experimental, see the BUGS section below.
27 25
28In this module, coroutines are defined as "callchain + lexical variables 26In this module, coroutines are defined as "callchain + lexical variables
29+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own 27+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
30callchain, it's own set of lexicals and it's own set of perl's most 28callchain, it's own set of lexicals and it's own set of perl's most
31important global variables. 29important global variables.
32 30
33=cut 31=cut
34 32
35package Coro; 33package Coro;
36 34
35use strict;
37no warnings qw(uninitialized); 36no warnings "uninitialized";
38 37
39use Coro::State; 38use Coro::State;
40 39
41use base Exporter; 40use base qw(Coro::State Exporter);
42 41
42our $idle; # idle handler
43our $main; # main coroutine
44our $current; # current coroutine
45
43$VERSION = 0.52; 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 (@_) {
… …
77 }; 83 };
78 } 84 }
79 85
80} 86}
81 87
88=over 4
89
82=item $main 90=item $main
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;
122$manager = new Coro sub { 138my $manager; $manager = new Coro sub {
123 while() { 139 while () {
124 # by overwriting the state object with the manager we destroy it 140 # by overwriting the state object with the manager we destroy it
125 # 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
126 # been readied multiple times. this is harmless since the manager 142 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always 143 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue 144 # remove itself from the runqueue
129 while (@destroy) { 145 while (@destroy) {
130 my $coro = pop @destroy; 146 my $coro = pop @destroy;
131 $coro->{status} ||= []; 147 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []}; 148 $_->ready for @{delete $coro->{join} || []};
133 $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);
134 } 155 }
135 &schedule; 156 &schedule;
136 } 157 }
137}; 158};
138 159
139# static methods. not really. 160# static methods. not really.
140 161
162=back
163
141=head2 STATIC METHODS 164=head2 STATIC METHODS
142 165
143Static methods are actually functions that operate on the current process only. 166Static methods are actually functions that operate on the current process only.
144 167
145=over 4 168=over 4
… …
147=item async { ... } [@args...] 170=item async { ... } [@args...]
148 171
149Create a new asynchronous process and return it's process object 172Create a new asynchronous process and return it's process object
150(usually unused). When the sub returns the new process is automatically 173(usually unused). When the sub returns the new process is automatically
151terminated. 174terminated.
175
176When the coroutine dies, the program will exit, just as in the main
177program.
152 178
153 # create a new coroutine that just prints its arguments 179 # create a new coroutine that just prints its arguments
154 async { 180 async {
155 print "@_\n"; 181 print "@_\n";
156 } 1,2,3,4; 182 } 1,2,3,4;
157 183
158The coderef you submit MUST NOT be a closure that refers to variables
159in an outer scope. This does NOT work. Pass arguments into it instead.
160
161=cut 184=cut
162 185
163sub async(&@) { 186sub async(&@) {
164 my $pid = new Coro @_; 187 my $pid = new Coro @_;
165 $manager->ready; # this ensures that the stack is cloned from the manager
166 $pid->ready; 188 $pid->ready;
167 $pid; 189 $pid
168} 190}
169 191
170=item schedule 192=item schedule
171 193
172Calls 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
… …
183 205
184=cut 206=cut
185 207
186=item terminate [arg...] 208=item terminate [arg...]
187 209
188Terminates the current process. 210Terminates the current process with the given status values (see L<cancel>).
189
190Future versions of this function will allow result arguments.
191 211
192=cut 212=cut
193 213
194sub terminate { 214sub terminate {
195 $current->{status} = [@_];
196 $current->cancel; 215 $current->cancel (@_);
197 &schedule;
198 die; # NORETURN
199} 216}
200 217
201=back 218=back
202 219
203# dynamic methods 220# dynamic methods
… …
215called. 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
216by calling the ready method. 233by calling the ready method.
217 234
218=cut 235=cut
219 236
220sub _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;
221 terminate &{+shift}; 241 terminate &{+shift};
222} 242}
223 243
224sub new { 244sub new {
225 my $class = shift; 245 my $class = shift;
226 bless { 246
227 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 247 $class->SUPER::new (\&_new_coro, @_)
228 }, $class;
229} 248}
230 249
231=item $process->ready 250=item $process->ready
232 251
233Put the given process into the ready queue. 252Put the given process into the ready queue.
234 253
235=cut 254=cut
236 255
237=item $process->cancel 256=item $process->cancel (arg...)
238 257
239Like 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).
240 260
241=cut 261=cut
242 262
243sub cancel { 263sub cancel {
264 my $self = shift;
265 $self->{status} = [@_];
244 push @destroy, $_[0]; 266 push @destroy, $self;
245 $manager->ready; 267 $manager->ready;
246 &schedule if $current == $_[0]; 268 &schedule if $current == $self;
247} 269}
248 270
249=item $process->join 271=item $process->join
250 272
251Wait until the coroutine terminates and return any values given to the 273Wait until the coroutine terminates and return any values given to the
252C<terminate> function. C<join> can be called multiple times from multiple 274C<terminate> or C<cancel> functions. C<join> can be called multiple times
253processes. 275from multiple processes.
254 276
255=cut 277=cut
256 278
257sub join { 279sub join {
258 my $self = shift; 280 my $self = shift;
… …
261 &schedule; 283 &schedule;
262 } 284 }
263 wantarray ? @{$self->{status}} : $self->{status}[0]; 285 wantarray ? @{$self->{status}} : $self->{status}[0];
264} 286}
265 287
266=item $oldprio = $process->prio($newprio) 288=item $oldprio = $process->prio ($newprio)
267 289
268Sets (or gets, if the argument is missing) the priority of the 290Sets (or gets, if the argument is missing) the priority of the
269process. Higher priority processes get run before lower priority 291process. Higher priority processes get run before lower priority
270processes. Priorities are smalled signed integer (currently -4 .. +3), 292processes. Priorities are small signed integers (currently -4 .. +3),
271that 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
272to get then): 294to get then):
273 295
274 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
275 3 > 1 > 0 > -1 > -3 > -4 297 3 > 1 > 0 > -1 > -3 > -4
… …
283Changing the priority of the current process will take effect immediately, 305Changing the priority of the current process will take effect immediately,
284but changing the priority of processes in the ready queue (but not 306but changing the priority of processes in the ready queue (but not
285running) will only take effect after the next schedule (of that 307running) will only take effect after the next schedule (of that
286process). 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.
287 309
288=cut
289
290sub prio {
291 my $old = $_[0]{prio};
292 $_[0]{prio} = $_[1] if @_ > 1;
293 $old;
294}
295
296=item $newprio = $process->nice($change) 310=item $newprio = $process->nice ($change)
297 311
298Similar 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.
299higher values mean lower priority, just as in unix). 313higher values mean lower priority, just as in unix).
300 314
301=cut
302
303sub nice {
304 $_[0]{prio} -= $_[1];
305}
306
307=item $olddesc = $process->desc($newdesc) 315=item $olddesc = $process->desc ($newdesc)
308 316
309Sets (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
310process. 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.
311 319
312=cut 320=cut
… …
323 331
3241; 3321;
325 333
326=head1 BUGS/LIMITATIONS 334=head1 BUGS/LIMITATIONS
327 335
328 - 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
329 very bad things might happen otherwise (usually segfaults). 337 destruction. very bad things might happen otherwise (usually segfaults).
338
330 - this module is not thread-safe. You must only ever use this module from 339 - this module is not thread-safe. You should only ever use this module
331 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
332 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).
333 343
334=head1 SEE ALSO 344=head1 SEE ALSO
335 345
336L<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>.
337L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 347
338L<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>
339 353
340=head1 AUTHOR 354=head1 AUTHOR
341 355
342 Marc Lehmann <pcg@goof.com> 356 Marc Lehmann <schmorp@schmorp.de>
343 http://www.goof.com/pcg/marc/ 357 http://home.schmorp.de/
344 358
345=cut 359=cut
346 360

Diff Legend

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