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

Comparing Coro/Coro.pm (file contents):
Revision 1.66 by root, Thu Mar 3 17:20:31 2005 UTC vs.
Revision 1.83 by root, Fri Nov 24 15:34:33 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 = 1.11; 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;
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 150
136 # the next line destroys the _coro_state, but keeps the 151 # the next line destroys the coro state, but keeps the
137 # process itself intact (we basically make it a zombie 152 # process itself intact (we basically make it a zombie
138 # process that always runs the manager thread, so it's possible 153 # process that always runs the manager thread, so it's possible
139 # to transfer() to this process). 154 # to transfer() to this process).
140 $coro->{_coro_state} = $manager->{_coro_state}; 155 $coro->_clone_state_from ($manager);
141 } 156 }
142 &schedule; 157 &schedule;
143 } 158 }
144}; 159};
145 160
156=item async { ... } [@args...] 171=item async { ... } [@args...]
157 172
158Create a new asynchronous process and return it's process object 173Create a new asynchronous process and return it's process object
159(usually unused). When the sub returns the new process is automatically 174(usually unused). When the sub returns the new process is automatically
160terminated. 175terminated.
176
177When the coroutine dies, the program will exit, just as in the main
178program.
161 179
162 # create a new coroutine that just prints its arguments 180 # create a new coroutine that just prints its arguments
163 async { 181 async {
164 print "@_\n"; 182 print "@_\n";
165 } 1,2,3,4; 183 } 1,2,3,4;
222 terminate &{+shift}; 240 terminate &{+shift};
223} 241}
224 242
225sub new { 243sub new {
226 my $class = shift; 244 my $class = shift;
227 bless { 245
228 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 246 $class->SUPER::new (\&_newcoro, @_)
229 }, $class;
230} 247}
231 248
232=item $process->ready 249=item $process->ready
233 250
234Put the given process into the ready queue. 251Put the given process into the ready queue.
235 252
236=cut 253=cut
237 254
238=item $process->cancel (arg...) 255=item $process->cancel (arg...)
239 256
240Temrinates the given process and makes it return the given arguments as 257Terminates the given process and makes it return the given arguments as
241status (default: the empty list). 258status (default: the empty list).
242 259
243=cut 260=cut
244 261
245sub cancel { 262sub cancel {
265 &schedule; 282 &schedule;
266 } 283 }
267 wantarray ? @{$self->{status}} : $self->{status}[0]; 284 wantarray ? @{$self->{status}} : $self->{status}[0];
268} 285}
269 286
270=item $oldprio = $process->prio($newprio) 287=item $oldprio = $process->prio ($newprio)
271 288
272Sets (or gets, if the argument is missing) the priority of the 289Sets (or gets, if the argument is missing) the priority of the
273process. Higher priority processes get run before lower priority 290process. Higher priority processes get run before lower priority
274processes. Priorities are small signed integers (currently -4 .. +3), 291processes. Priorities are small signed integers (currently -4 .. +3),
275that you can refer to using PRIO_xxx constants (use the import tag :prio 292that you can refer to using PRIO_xxx constants (use the import tag :prio
287Changing the priority of the current process will take effect immediately, 304Changing the priority of the current process will take effect immediately,
288but changing the priority of processes in the ready queue (but not 305but changing the priority of processes in the ready queue (but not
289running) will only take effect after the next schedule (of that 306running) will only take effect after the next schedule (of that
290process). This is a bug that will be fixed in some future version. 307process). This is a bug that will be fixed in some future version.
291 308
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) 309=item $newprio = $process->nice ($change)
301 310
302Similar to C<prio>, but subtract the given value from the priority (i.e. 311Similar to C<prio>, but subtract the given value from the priority (i.e.
303higher values mean lower priority, just as in unix). 312higher values mean lower priority, just as in unix).
304 313
305=cut
306
307sub nice {
308 $_[0]{prio} -= $_[1];
309}
310
311=item $olddesc = $process->desc($newdesc) 314=item $olddesc = $process->desc ($newdesc)
312 315
313Sets (or gets in case the argument is missing) the description for this 316Sets (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. 317process. This is just a free-form string you can associate with a process.
315 318
316=cut 319=cut
337 to allow per-thread schedulers, but Coro::State does not yet allow 340 to allow per-thread schedulers, but Coro::State does not yet allow
338 this). 341 this).
339 342
340=head1 SEE ALSO 343=head1 SEE ALSO
341 344
342L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 345Support/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>, 346
344L<Coro::Handle>, L<Coro::RWLock>, L<Coro::Socket>. 347Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
348
349Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
350
351Embedding: L<Coro:MakeMaker>
345 352
346=head1 AUTHOR 353=head1 AUTHOR
347 354
348 Marc Lehmann <schmorp@schmorp.de> 355 Marc Lehmann <schmorp@schmorp.de>
349 http://home.schmorp.de/ 356 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines