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.82 by root, Fri Nov 24 13:40:36 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);
40
41use base Exporter; 40use base Exporter::;
42 41
43$VERSION = "0.9"; 42our $idle; # idle coroutine
43our $main; # main coroutine
44our $current; # current coroutine
44 45
46our $VERSION = '2.5';
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 (@_) {
120# this coroutine is necessary because a coroutine 126# this coroutine is necessary because a coroutine
121# cannot destroy itself. 127# cannot destroy itself.
122my @destroy; 128my @destroy;
123my $manager; 129my $manager;
124$manager = new Coro sub { 130$manager = new Coro sub {
125 while() { 131 while () {
126 # by overwriting the state object with the manager we destroy it 132 # by overwriting the state object with the manager we destroy it
127 # while still being able to schedule this coroutine (in case it has 133 # while still being able to schedule this coroutine (in case it has
128 # been readied multiple times. this is harmless since the manager 134 # been readied multiple times. this is harmless since the manager
129 # can be called as many times as neccessary and will always 135 # can be called as many times as neccessary and will always
130 # remove itself from the runqueue 136 # remove itself from the runqueue
131 while (@destroy) { 137 while (@destroy) {
132 my $coro = pop @destroy; 138 my $coro = pop @destroy;
133 $coro->{status} ||= []; 139 $coro->{status} ||= [];
134 $_->ready for @{delete $coro->{join} || []}; 140 $_->ready for @{delete $coro->{join} || []};
141
142 # the next line destroys the _coro_state, but keeps the
143 # process itself intact (we basically make it a zombie
144 # process that always runs the manager thread, so it's possible
145 # to transfer() to this process).
135 $coro->{_coro_state} = $manager->{_coro_state}; 146 $coro->{_coro_state}->_clone_state_from ($manager->{_coro_state});
136 } 147 }
137 &schedule; 148 &schedule;
138 } 149 }
139}; 150};
140 151
152 163
153Create a new asynchronous process and return it's process object 164Create a new asynchronous process and return it's process object
154(usually unused). When the sub returns the new process is automatically 165(usually unused). When the sub returns the new process is automatically
155terminated. 166terminated.
156 167
168When the coroutine dies, the program will exit, just as in the main
169program.
170
157 # create a new coroutine that just prints its arguments 171 # create a new coroutine that just prints its arguments
158 async { 172 async {
159 print "@_\n"; 173 print "@_\n";
160 } 1,2,3,4; 174 } 1,2,3,4;
161
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 175
165=cut 176=cut
166 177
167sub async(&@) { 178sub async(&@) {
168 my $pid = new Coro @_; 179 my $pid = new Coro @_;
187 198
188=cut 199=cut
189 200
190=item terminate [arg...] 201=item terminate [arg...]
191 202
192Terminates the current process. 203Terminates the current process with the given status values (see L<cancel>).
193
194Future versions of this function will allow result arguments.
195 204
196=cut 205=cut
197 206
198sub terminate { 207sub terminate {
199 $current->{status} = [@_];
200 $current->cancel; 208 $current->cancel (@_);
201 &schedule;
202 die; # NORETURN
203} 209}
204 210
205=back 211=back
206 212
207# dynamic methods 213# dynamic methods
226} 232}
227 233
228sub new { 234sub new {
229 my $class = shift; 235 my $class = shift;
230 bless { 236 bless {
231 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 237 _coro_state => (new Coro::State \&_newcoro, @_),
232 }, $class; 238 }, $class;
233} 239}
234 240
235=item $process->ready 241=item $process->ready
236 242
237Put the given process into the ready queue. 243Put the given process into the ready queue.
238 244
239=cut 245=cut
240 246
241=item $process->cancel 247=item $process->cancel (arg...)
242 248
243Like C<terminate>, but terminates the specified process instead. 249Terminates the given process and makes it return the given arguments as
250status (default: the empty list).
244 251
245=cut 252=cut
246 253
247sub cancel { 254sub cancel {
255 my $self = shift;
256 $self->{status} = [@_];
248 push @destroy, $_[0]; 257 push @destroy, $self;
249 $manager->ready; 258 $manager->ready;
250 &schedule if $current == $_[0]; 259 &schedule if $current == $self;
251} 260}
252 261
253=item $process->join 262=item $process->join
254 263
255Wait until the coroutine terminates and return any values given to the 264Wait until the coroutine terminates and return any values given to the
256C<terminate> function. C<join> can be called multiple times from multiple 265C<terminate> or C<cancel> functions. C<join> can be called multiple times
257processes. 266from multiple processes.
258 267
259=cut 268=cut
260 269
261sub join { 270sub join {
262 my $self = shift; 271 my $self = shift;
265 &schedule; 274 &schedule;
266 } 275 }
267 wantarray ? @{$self->{status}} : $self->{status}[0]; 276 wantarray ? @{$self->{status}} : $self->{status}[0];
268} 277}
269 278
270=item $oldprio = $process->prio($newprio) 279=item $oldprio = $process->prio ($newprio)
271 280
272Sets (or gets, if the argument is missing) the priority of the 281Sets (or gets, if the argument is missing) the priority of the
273process. Higher priority processes get run before lower priority 282process. Higher priority processes get run before lower priority
274processes. Priorities are small signed integers (currently -4 .. +3), 283processes. Priorities are small signed integers (currently -4 .. +3),
275that you can refer to using PRIO_xxx constants (use the import tag :prio 284that you can refer to using PRIO_xxx constants (use the import tag :prio
290process). This is a bug that will be fixed in some future version. 299process). This is a bug that will be fixed in some future version.
291 300
292=cut 301=cut
293 302
294sub prio { 303sub prio {
295 my $old = $_[0]{prio}; 304 shift->{_coro_state}->prio (@_)
296 $_[0]{prio} = $_[1] if @_ > 1;
297 $old;
298} 305}
299 306
300=item $newprio = $process->nice($change) 307=item $newprio = $process->nice ($change)
301 308
302Similar to C<prio>, but subtract the given value from the priority (i.e. 309Similar to C<prio>, but subtract the given value from the priority (i.e.
303higher values mean lower priority, just as in unix). 310higher values mean lower priority, just as in unix).
304 311
305=cut 312=cut
306 313
307sub nice { 314sub nice {
308 $_[0]{prio} -= $_[1]; 315 shift->{_coro_state}->nice (@_)
309} 316}
310 317
311=item $olddesc = $process->desc($newdesc) 318=item $olddesc = $process->desc ($newdesc)
312 319
313Sets (or gets in case the argument is missing) the description for this 320Sets (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. 321process. This is just a free-form string you can associate with a process.
315 322
316=cut 323=cut
337 to allow per-thread schedulers, but Coro::State does not yet allow 344 to allow per-thread schedulers, but Coro::State does not yet allow
338 this). 345 this).
339 346
340=head1 SEE ALSO 347=head1 SEE ALSO
341 348
342L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 349Support/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>, 350
344L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>. 351Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
352
353Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
354
355Embedding: L<Coro:MakeMaker>
345 356
346=head1 AUTHOR 357=head1 AUTHOR
347 358
348 Marc Lehmann <pcg@goof.com> 359 Marc Lehmann <schmorp@schmorp.de>
349 http://www.goof.com/pcg/marc/ 360 http://home.schmorp.de/
350 361
351=cut 362=cut
352 363

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines