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.61 by pcg, Fri May 14 13:25:08 2004 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
37no warnings qw(uninitialized); 35BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }
38 36
39use Coro::State; 37use Coro::State;
40 38
39use vars qw($idle $main $current);
40
41use base Exporter; 41use base Exporter;
42 42
43$VERSION = 0.52; 43$VERSION = 0.97;
44 44
45@EXPORT = qw(async cede schedule terminate current); 45@EXPORT = qw(async cede schedule terminate current);
46%EXPORT_TAGS = ( 46%EXPORT_TAGS = (
47 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], 47 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48); 48);
… …
77 }; 77 };
78 } 78 }
79 79
80} 80}
81 81
82=over 4
83
82=item $main 84=item $main
83 85
84This coroutine represents the main program. 86This coroutine represents the main program.
85 87
86=cut 88=cut
87 89
88our $main = new Coro; 90$main = new Coro;
89 91
90=item $current (or as function: current) 92=item $current (or as function: current)
91 93
92The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). 94The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
93 95
… …
96# maybe some other module used Coro::Specific before... 98# maybe some other module used Coro::Specific before...
97if ($current) { 99if ($current) {
98 $main->{specific} = $current->{specific}; 100 $main->{specific} = $current->{specific};
99} 101}
100 102
101our $current = $main; 103$current = $main;
102 104
103sub current() { $current } 105sub current() { $current }
104 106
105=item $idle 107=item $idle
106 108
… …
108implementation prints "FATAL: deadlock detected" and exits. 110implementation prints "FATAL: deadlock detected" and exits.
109 111
110=cut 112=cut
111 113
112# should be done using priorities :( 114# should be done using priorities :(
113our $idle = new Coro sub { 115$idle = new Coro sub {
114 print STDERR "FATAL: deadlock detected\n"; 116 print STDERR "FATAL: deadlock detected\n";
115 exit(51); 117 exit(51);
116}; 118};
117 119
118# this coroutine is necessary because a coroutine 120# this coroutine is necessary because a coroutine
119# cannot destroy itself. 121# cannot destroy itself.
120my @destroy; 122my @destroy;
121my $manager; 123my $manager;
122$manager = new Coro sub { 124$manager = new Coro sub {
123 while() { 125 while () {
124 # by overwriting the state object with the manager we destroy it 126 # by overwriting the state object with the manager we destroy it
125 # while still being able to schedule this coroutine (in case it has 127 # while still being able to schedule this coroutine (in case it has
126 # been readied multiple times. this is harmless since the manager 128 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always 129 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue 130 # remove itself from the runqueue
129 while (@destroy) { 131 while (@destroy) {
130 my $coro = pop @destroy; 132 my $coro = pop @destroy;
131 $coro->{status} ||= []; 133 $coro->{status} ||= [];
132 $_->ready for @{delete $coro->{join} || []}; 134 $_->ready for @{delete $coro->{join} || []};
135
136 # the next line destroys the _coro_state, but keeps the
137 # process itself intact (we basically make it a zombie
138 # process that always runs the manager thread, so it's possible
139 # to transfer() to this process).
133 $coro->{_coro_state} = $manager->{_coro_state}; 140 $coro->{_coro_state} = $manager->{_coro_state};
134 } 141 }
135 &schedule; 142 &schedule;
136 } 143 }
137}; 144};
138 145
139# static methods. not really. 146# static methods. not really.
140 147
148=back
149
141=head2 STATIC METHODS 150=head2 STATIC METHODS
142 151
143Static methods are actually functions that operate on the current process only. 152Static methods are actually functions that operate on the current process only.
144 153
145=over 4 154=over 4
… …
152 161
153 # create a new coroutine that just prints its arguments 162 # create a new coroutine that just prints its arguments
154 async { 163 async {
155 print "@_\n"; 164 print "@_\n";
156 } 1,2,3,4; 165 } 1,2,3,4;
157
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 166
161=cut 167=cut
162 168
163sub async(&@) { 169sub async(&@) {
164 my $pid = new Coro @_; 170 my $pid = new Coro @_;
… …
183 189
184=cut 190=cut
185 191
186=item terminate [arg...] 192=item terminate [arg...]
187 193
188Terminates the current process. 194Terminates the current process with the given status values (see L<cancel>).
189
190Future versions of this function will allow result arguments.
191 195
192=cut 196=cut
193 197
194sub terminate { 198sub terminate {
195 $current->{status} = [@_];
196 $current->cancel; 199 $current->cancel (@_);
197 &schedule;
198 die; # NORETURN
199} 200}
200 201
201=back 202=back
202 203
203# dynamic methods 204# dynamic methods
… …
232 233
233Put the given process into the ready queue. 234Put the given process into the ready queue.
234 235
235=cut 236=cut
236 237
237=item $process->cancel 238=item $process->cancel (arg...)
238 239
239Like C<terminate>, but terminates the specified process instead. 240Temrinates the given process and makes it return the given arguments as
241status (default: the empty list).
240 242
241=cut 243=cut
242 244
243sub cancel { 245sub cancel {
246 my $self = shift;
247 $self->{status} = [@_];
244 push @destroy, $_[0]; 248 push @destroy, $self;
245 $manager->ready; 249 $manager->ready;
246 &schedule if $current == $_[0]; 250 &schedule if $current == $self;
247} 251}
248 252
249=item $process->join 253=item $process->join
250 254
251Wait until the coroutine terminates and return any values given to the 255Wait until the coroutine terminates and return any values given to the
252C<terminate> function. C<join> can be called multiple times from multiple 256C<terminate> or C<cancel> functions. C<join> can be called multiple times
253processes. 257from multiple processes.
254 258
255=cut 259=cut
256 260
257sub join { 261sub join {
258 my $self = shift; 262 my $self = shift;
… …
265 269
266=item $oldprio = $process->prio($newprio) 270=item $oldprio = $process->prio($newprio)
267 271
268Sets (or gets, if the argument is missing) the priority of the 272Sets (or gets, if the argument is missing) the priority of the
269process. Higher priority processes get run before lower priority 273process. Higher priority processes get run before lower priority
270processes. Priorities are smalled signed integer (currently -4 .. +3), 274processes. Priorities are small signed integers (currently -4 .. +3),
271that you can refer to using PRIO_xxx constants (use the import tag :prio 275that you can refer to using PRIO_xxx constants (use the import tag :prio
272to get then): 276to get then):
273 277
274 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 278 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
275 3 > 1 > 0 > -1 > -3 > -4 279 3 > 1 > 0 > -1 > -3 > -4
… …
323 327
3241; 3281;
325 329
326=head1 BUGS/LIMITATIONS 330=head1 BUGS/LIMITATIONS
327 331
328 - you must make very sure that no coro is still active on global destruction. 332 - you must make very sure that no coro is still active on global
329 very bad things might happen otherwise (usually segfaults). 333 destruction. very bad things might happen otherwise (usually segfaults).
334
330 - this module is not thread-safe. You must only ever use this module from 335 - 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 336 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). 337 to allow per-thread schedulers, but Coro::State does not yet allow
338 this).
333 339
334=head1 SEE ALSO 340=head1 SEE ALSO
335 341
336L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 342L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
337L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 343L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,
338L<Coro::Handle>, L<Coro::Socket>. 344L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.
339 345
340=head1 AUTHOR 346=head1 AUTHOR
341 347
342 Marc Lehmann <pcg@goof.com> 348 Marc Lehmann <pcg@goof.com>
343 http://www.goof.com/pcg/marc/ 349 http://www.goof.com/pcg/marc/

Diff Legend

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