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

Comparing Coro/Coro.pm (file contents):
Revision 1.57 by pcg, Sun Nov 30 22:49:25 2003 UTC vs.
Revision 1.84 by root, Sat Nov 25 00:40:26 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 = '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 (@_) {
… …
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.
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 wakes up some
126coroutine.
113 127
114# should be done using priorities :( 128=cut
115$idle = new Coro sub { 129
130$idle = sub {
116 print STDERR "FATAL: deadlock detected\n"; 131 print STDERR "FATAL: deadlock detected\n";
117 exit(51); 132 exit (51);
118}; 133};
119 134
120# this coroutine is necessary because a coroutine 135# this coroutine is necessary because a coroutine
121# cannot destroy itself. 136# cannot destroy itself.
122my @destroy; 137my @destroy;
… …
130 # remove itself from the runqueue 145 # remove itself from the runqueue
131 while (@destroy) { 146 while (@destroy) {
132 my $coro = pop @destroy; 147 my $coro = pop @destroy;
133 $coro->{status} ||= []; 148 $coro->{status} ||= [];
134 $_->ready for @{delete $coro->{join} || []}; 149 $_->ready for @{delete $coro->{join} || []};
135 $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);
136 } 156 }
137 &schedule; 157 &schedule;
138 } 158 }
139}; 159};
140 160
… …
151=item async { ... } [@args...] 171=item async { ... } [@args...]
152 172
153Create a new asynchronous process and return it's process object 173Create a new asynchronous process and return it's process object
154(usually unused). When the sub returns the new process is automatically 174(usually unused). When the sub returns the new process is automatically
155terminated. 175terminated.
176
177When the coroutine dies, the program will exit, just as in the main
178program.
156 179
157 # create a new coroutine that just prints its arguments 180 # create a new coroutine that just prints its arguments
158 async { 181 async {
159 print "@_\n"; 182 print "@_\n";
160 } 1,2,3,4; 183 } 1,2,3,4;
… …
184 207
185=cut 208=cut
186 209
187=item terminate [arg...] 210=item terminate [arg...]
188 211
189Terminates the current process. 212Terminates the current process with the given status values (see L<cancel>).
190
191Future versions of this function will allow result arguments.
192 213
193=cut 214=cut
194 215
195sub terminate { 216sub terminate {
196 $current->{status} = [@_];
197 $current->cancel; 217 $current->cancel (@_);
198 &schedule;
199 die; # NORETURN
200} 218}
201 219
202=back 220=back
203 221
204# dynamic methods 222# dynamic methods
… …
216called. To make the process run you must first put it into the ready queue 234called. To make the process run you must first put it into the ready queue
217by calling the ready method. 235by calling the ready method.
218 236
219=cut 237=cut
220 238
221sub _newcoro { 239sub _new_coro {
240# $current->_clear_idle_sp; # set the idle sp on the following cede
241 _set_cede_self; # ensures that cede cede's us first
242 cede;
222 terminate &{+shift}; 243 terminate &{+shift};
223} 244}
224 245
225sub new { 246sub new {
226 my $class = shift; 247 my $class = shift;
227 bless { 248
228 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 249 $class->SUPER::new (\&_new_coro, @_)
229 }, $class;
230} 250}
231 251
232=item $process->ready 252=item $process->ready
233 253
234Put the given process into the ready queue. 254Put the given process into the ready queue.
235 255
236=cut 256=cut
237 257
238=item $process->cancel 258=item $process->cancel (arg...)
239 259
240Like C<terminate>, but terminates the specified process instead. 260Terminates the given process and makes it return the given arguments as
261status (default: the empty list).
241 262
242=cut 263=cut
243 264
244sub cancel { 265sub cancel {
266 my $self = shift;
267 $self->{status} = [@_];
245 push @destroy, $_[0]; 268 push @destroy, $self;
246 $manager->ready; 269 $manager->ready;
247 &schedule if $current == $_[0]; 270 &schedule if $current == $self;
248} 271}
249 272
250=item $process->join 273=item $process->join
251 274
252Wait until the coroutine terminates and return any values given to the 275Wait until the coroutine terminates and return any values given to the
253C<terminate> function. C<join> can be called multiple times from multiple 276C<terminate> or C<cancel> functions. C<join> can be called multiple times
254processes. 277from multiple processes.
255 278
256=cut 279=cut
257 280
258sub join { 281sub join {
259 my $self = shift; 282 my $self = shift;
… …
262 &schedule; 285 &schedule;
263 } 286 }
264 wantarray ? @{$self->{status}} : $self->{status}[0]; 287 wantarray ? @{$self->{status}} : $self->{status}[0];
265} 288}
266 289
267=item $oldprio = $process->prio($newprio) 290=item $oldprio = $process->prio ($newprio)
268 291
269Sets (or gets, if the argument is missing) the priority of the 292Sets (or gets, if the argument is missing) the priority of the
270process. Higher priority processes get run before lower priority 293process. Higher priority processes get run before lower priority
271processes. Priorities are small signed integers (currently -4 .. +3), 294processes. Priorities are small signed integers (currently -4 .. +3),
272that you can refer to using PRIO_xxx constants (use the import tag :prio 295that you can refer to using PRIO_xxx constants (use the import tag :prio
… …
284Changing the priority of the current process will take effect immediately, 307Changing the priority of the current process will take effect immediately,
285but changing the priority of processes in the ready queue (but not 308but changing the priority of processes in the ready queue (but not
286running) will only take effect after the next schedule (of that 309running) will only take effect after the next schedule (of that
287process). This is a bug that will be fixed in some future version. 310process). This is a bug that will be fixed in some future version.
288 311
289=cut
290
291sub prio {
292 my $old = $_[0]{prio};
293 $_[0]{prio} = $_[1] if @_ > 1;
294 $old;
295}
296
297=item $newprio = $process->nice($change) 312=item $newprio = $process->nice ($change)
298 313
299Similar to C<prio>, but subtract the given value from the priority (i.e. 314Similar to C<prio>, but subtract the given value from the priority (i.e.
300higher values mean lower priority, just as in unix). 315higher values mean lower priority, just as in unix).
301 316
302=cut
303
304sub nice {
305 $_[0]{prio} -= $_[1];
306}
307
308=item $olddesc = $process->desc($newdesc) 317=item $olddesc = $process->desc ($newdesc)
309 318
310Sets (or gets in case the argument is missing) the description for this 319Sets (or gets in case the argument is missing) the description for this
311process. This is just a free-form string you can associate with a process. 320process. This is just a free-form string you can associate with a process.
312 321
313=cut 322=cut
… …
334 to allow per-thread schedulers, but Coro::State does not yet allow 343 to allow per-thread schedulers, but Coro::State does not yet allow
335 this). 344 this).
336 345
337=head1 SEE ALSO 346=head1 SEE ALSO
338 347
339L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 348Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
340L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>, 349
341L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>. 350Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
351
352Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
353
354Embedding: L<Coro:MakeMaker>
342 355
343=head1 AUTHOR 356=head1 AUTHOR
344 357
345 Marc Lehmann <pcg@goof.com> 358 Marc Lehmann <schmorp@schmorp.de>
346 http://www.goof.com/pcg/marc/ 359 http://home.schmorp.de/
347 360
348=cut 361=cut
349 362

Diff Legend

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