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.91 by root, Fri Dec 1 02:17:37 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 = '3.0';
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, because the program has no other way to continue.
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 wake up a
126coroutine so the scheduler can run it.
113 127
114# should be done using priorities :( 128Please note that if your callback recursively invokes perl (e.g. for event
115$idle = new Coro sub { 129handlers), then it must be prepared to be called recursively.
130
131=cut
132
133$idle = sub {
116 print STDERR "FATAL: deadlock detected\n"; 134 print STDERR "FATAL: deadlock detected\n";
117 exit(51); 135 exit (51);
118}; 136};
119 137
120# this coroutine is necessary because a coroutine 138# this coroutine is necessary because a coroutine
121# cannot destroy itself. 139# cannot destroy itself.
122my @destroy; 140my @destroy;
123my $manager;
124$manager = new Coro sub { 141my $manager; $manager = new Coro sub {
125 while() { 142 while () {
126 # by overwriting the state object with the manager we destroy it 143 # by overwriting the state object with the manager we destroy it
127 # while still being able to schedule this coroutine (in case it has 144 # while still being able to schedule this coroutine (in case it has
128 # been readied multiple times. this is harmless since the manager 145 # been readied multiple times. this is harmless since the manager
129 # can be called as many times as neccessary and will always 146 # can be called as many times as neccessary and will always
130 # remove itself from the runqueue 147 # remove itself from the runqueue
131 while (@destroy) { 148 while (@destroy) {
132 my $coro = pop @destroy; 149 my $coro = pop @destroy;
133 $coro->{status} ||= []; 150 $coro->{status} ||= [];
134 $_->ready for @{delete $coro->{join} || []}; 151 $_->ready for @{delete $coro->{join} || []};
135 $coro->{_coro_state} = $manager->{_coro_state}; 152
153 # the next line destroys the coro state, but keeps the
154 # process itself intact (we basically make it a zombie
155 # process that always runs the manager thread, so it's possible
156 # to transfer() to this process).
157 $coro->_clone_state_from ($manager);
136 } 158 }
137 &schedule; 159 &schedule;
138 } 160 }
139}; 161};
140 162
… …
152 174
153Create a new asynchronous process and return it's process object 175Create a new asynchronous process and return it's process object
154(usually unused). When the sub returns the new process is automatically 176(usually unused). When the sub returns the new process is automatically
155terminated. 177terminated.
156 178
179Calling C<exit> in a coroutine will not work correctly, so do not do that.
180
181When the coroutine dies, the program will exit, just as in the main
182program.
183
157 # create a new coroutine that just prints its arguments 184 # create a new coroutine that just prints its arguments
158 async { 185 async {
159 print "@_\n"; 186 print "@_\n";
160 } 1,2,3,4; 187 } 1,2,3,4;
161 188
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 189=cut
166 190
167sub async(&@) { 191sub async(&@) {
168 my $pid = new Coro @_; 192 my $pid = new Coro @_;
169 $manager->ready; # this ensures that the stack is cloned from the manager
170 $pid->ready; 193 $pid->ready;
171 $pid; 194 $pid
172} 195}
173 196
174=item schedule 197=item schedule
175 198
176Calls the scheduler. Please note that the current process will not be put 199Calls the scheduler. Please note that the current process will not be put
177into the ready queue, so calling this function usually means you will 200into the ready queue, so calling this function usually means you will
178never be called again. 201never be called again unless something else (e.g. an event handler) calls
202ready.
203
204The canonical way to wait on external events is this:
205
206 {
207 # remember current process
208 my $current = $Coro::current;
209
210 # register a hypothetical event handler
211 on_event_invoke sub {
212 # wake up sleeping coroutine
213 $current->ready;
214 undef $current;
215 };
216
217 # call schedule until event occured.
218 # in case we are woken up for other reasons
219 # (current still defined), loop.
220 Coro::schedule while $current;
221 }
179 222
180=cut 223=cut
181 224
182=item cede 225=item cede
183 226
… …
187 230
188=cut 231=cut
189 232
190=item terminate [arg...] 233=item terminate [arg...]
191 234
192Terminates the current process. 235Terminates the current process with the given status values (see L<cancel>).
193
194Future versions of this function will allow result arguments.
195 236
196=cut 237=cut
197 238
198sub terminate { 239sub terminate {
199 $current->{status} = [@_];
200 $current->cancel; 240 $current->cancel (@_);
201 &schedule;
202 die; # NORETURN
203} 241}
204 242
205=back 243=back
206 244
207# dynamic methods 245# dynamic methods
… …
217Create a new process and return it. When the sub returns the process 255Create a new process and return it. When the sub returns the process
218automatically terminates as if C<terminate> with the returned values were 256automatically terminates as if C<terminate> with the returned values were
219called. To make the process run you must first put it into the ready queue 257called. To make the process run you must first put it into the ready queue
220by calling the ready method. 258by calling the ready method.
221 259
222=cut 260Calling C<exit> in a coroutine will not work correctly, so do not do that.
223 261
262=cut
263
224sub _newcoro { 264sub _new_coro {
225 terminate &{+shift}; 265 terminate &{+shift};
226} 266}
227 267
228sub new { 268sub new {
229 my $class = shift; 269 my $class = shift;
230 bless {
231 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
232 }, $class;
233}
234 270
271 $class->SUPER::new (\&_new_coro, @_)
272}
273
235=item $process->ready 274=item $success = $process->ready
236 275
237Put the given process into the ready queue. 276Put the given process into the ready queue (according to it's priority)
277and return true. If the process is already in the ready queue, do nothing
278and return false.
238 279
239=cut 280=item $is_ready = $process->is_ready
240 281
282Return wether the process is currently the ready queue or not,
283
241=item $process->cancel 284=item $process->cancel (arg...)
242 285
243Like C<terminate>, but terminates the specified process instead. 286Terminates the given process and makes it return the given arguments as
287status (default: the empty list).
244 288
245=cut 289=cut
246 290
247sub cancel { 291sub cancel {
292 my $self = shift;
293 $self->{status} = [@_];
248 push @destroy, $_[0]; 294 push @destroy, $self;
249 $manager->ready; 295 $manager->ready;
250 &schedule if $current == $_[0]; 296 &schedule if $current == $self;
251} 297}
252 298
253=item $process->join 299=item $process->join
254 300
255Wait until the coroutine terminates and return any values given to the 301Wait until the coroutine terminates and return any values given to the
256C<terminate> function. C<join> can be called multiple times from multiple 302C<terminate> or C<cancel> functions. C<join> can be called multiple times
257processes. 303from multiple processes.
258 304
259=cut 305=cut
260 306
261sub join { 307sub join {
262 my $self = shift; 308 my $self = shift;
… …
265 &schedule; 311 &schedule;
266 } 312 }
267 wantarray ? @{$self->{status}} : $self->{status}[0]; 313 wantarray ? @{$self->{status}} : $self->{status}[0];
268} 314}
269 315
270=item $oldprio = $process->prio($newprio) 316=item $oldprio = $process->prio ($newprio)
271 317
272Sets (or gets, if the argument is missing) the priority of the 318Sets (or gets, if the argument is missing) the priority of the
273process. Higher priority processes get run before lower priority 319process. Higher priority processes get run before lower priority
274processes. Priorities are small signed integers (currently -4 .. +3), 320processes. Priorities are small signed integers (currently -4 .. +3),
275that you can refer to using PRIO_xxx constants (use the import tag :prio 321that you can refer to using PRIO_xxx constants (use the import tag :prio
… …
287Changing the priority of the current process will take effect immediately, 333Changing the priority of the current process will take effect immediately,
288but changing the priority of processes in the ready queue (but not 334but changing the priority of processes in the ready queue (but not
289running) will only take effect after the next schedule (of that 335running) will only take effect after the next schedule (of that
290process). This is a bug that will be fixed in some future version. 336process). This is a bug that will be fixed in some future version.
291 337
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) 338=item $newprio = $process->nice ($change)
301 339
302Similar to C<prio>, but subtract the given value from the priority (i.e. 340Similar to C<prio>, but subtract the given value from the priority (i.e.
303higher values mean lower priority, just as in unix). 341higher values mean lower priority, just as in unix).
304 342
305=cut
306
307sub nice {
308 $_[0]{prio} -= $_[1];
309}
310
311=item $olddesc = $process->desc($newdesc) 343=item $olddesc = $process->desc ($newdesc)
312 344
313Sets (or gets in case the argument is missing) the description for this 345Sets (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. 346process. This is just a free-form string you can associate with a process.
315 347
316=cut 348=cut
… …
337 to allow per-thread schedulers, but Coro::State does not yet allow 369 to allow per-thread schedulers, but Coro::State does not yet allow
338 this). 370 this).
339 371
340=head1 SEE ALSO 372=head1 SEE ALSO
341 373
342L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 374Support/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>, 375
344L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>. 376Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
377
378Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
379
380Embedding: L<Coro:MakeMaker>
345 381
346=head1 AUTHOR 382=head1 AUTHOR
347 383
348 Marc Lehmann <pcg@goof.com> 384 Marc Lehmann <schmorp@schmorp.de>
349 http://www.goof.com/pcg/marc/ 385 http://home.schmorp.de/
350 386
351=cut 387=cut
352 388

Diff Legend

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