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

Comparing Coro/Coro.pm (file contents):
Revision 1.47 by root, Mon Feb 25 03:21:08 2002 UTC vs.
Revision 1.80 by root, Mon Nov 6 19:56:26 2006 UTC

… …
30 30
31=cut 31=cut
32 32
33package Coro; 33package Coro;
34 34
35use strict;
35no warnings qw(uninitialized); 36no warnings "uninitialized";
36 37
37use Coro::State; 38use Coro::State;
38 39
39use base Exporter; 40use base Exporter::;
40 41
41$VERSION = 0.533; 42our $idle; # idle coroutine
43our $main; # main coroutine
44our $current; # current coroutine
42 45
46our $VERSION = '2.5';
47
43@EXPORT = qw(async cede schedule terminate current); 48our @EXPORT = qw(async cede schedule terminate current);
44%EXPORT_TAGS = ( 49our %EXPORT_TAGS = (
45 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)],
46); 51);
47@EXPORT_OK = @{$EXPORT_TAGS{prio}}; 52our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
48 53
49{ 54{
50 my @async; 55 my @async;
51 my $init; 56 my $init;
52 57
53 # this way of handling attributes simply is NOT scalable ;() 58 # this way of handling attributes simply is NOT scalable ;()
54 sub import { 59 sub import {
60 no strict 'refs';
61
55 Coro->export_to_level(1, @_); 62 Coro->export_to_level(1, @_);
63
56 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 64 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
57 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { 65 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
58 my ($package, $ref) = (shift, shift); 66 my ($package, $ref) = (shift, shift);
59 my @attrs; 67 my @attrs;
60 for (@_) { 68 for (@_) {
… …
83 91
84This coroutine represents the main program. 92This coroutine represents the main program.
85 93
86=cut 94=cut
87 95
88our $main = new Coro; 96$main = new Coro;
89 97
90=item $current (or as function: current) 98=item $current (or as function: current)
91 99
92The 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 is C<$main> (of course).
93 101
… …
96# maybe some other module used Coro::Specific before... 104# maybe some other module used Coro::Specific before...
97if ($current) { 105if ($current) {
98 $main->{specific} = $current->{specific}; 106 $main->{specific} = $current->{specific};
99} 107}
100 108
101our $current = $main; 109$current = $main;
102 110
103sub current() { $current } 111sub current() { $current }
104 112
105=item $idle 113=item $idle
106 114
… …
108implementation prints "FATAL: deadlock detected" and exits. 116implementation prints "FATAL: deadlock detected" and exits.
109 117
110=cut 118=cut
111 119
112# should be done using priorities :( 120# should be done using priorities :(
113our $idle = new Coro sub { 121$idle = new Coro sub {
114 print STDERR "FATAL: deadlock detected\n"; 122 print STDERR "FATAL: deadlock detected\n";
115 exit(51); 123 exit(51);
116}; 124};
117 125
118# this coroutine is necessary because a coroutine 126# this coroutine is necessary because a coroutine
119# cannot destroy itself. 127# cannot destroy itself.
120my @destroy; 128my @destroy;
121my $manager; 129my $manager;
122$manager = new Coro sub { 130$manager = new Coro sub {
123 while() { 131 while () {
124 # by overwriting the state object with the manager we destroy it 132 # by overwriting the state object with the manager we destroy it
125 # 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
126 # been readied multiple times. this is harmless since the manager 134 # been readied multiple times. this is harmless since the manager
127 # can be called as many times as neccessary and will always 135 # can be called as many times as neccessary and will always
128 # remove itself from the runqueue 136 # remove itself from the runqueue
129 while (@destroy) { 137 while (@destroy) {
130 my $coro = pop @destroy; 138 my $coro = pop @destroy;
131 $coro->{status} ||= []; 139 $coro->{status} ||= [];
132 $_->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).
133 $coro->{_coro_state} = $manager->{_coro_state}; 146 $coro->{_coro_state} = $manager->{_coro_state};
134 } 147 }
135 &schedule; 148 &schedule;
136 } 149 }
137}; 150};
… …
150 163
151Create a new asynchronous process and return it's process object 164Create a new asynchronous process and return it's process object
152(usually unused). When the sub returns the new process is automatically 165(usually unused). When the sub returns the new process is automatically
153terminated. 166terminated.
154 167
168When the coroutine dies, the program will exit, just as in the main
169program.
170
155 # create a new coroutine that just prints its arguments 171 # create a new coroutine that just prints its arguments
156 async { 172 async {
157 print "@_\n"; 173 print "@_\n";
158 } 1,2,3,4; 174 } 1,2,3,4;
159
160The coderef you submit MUST NOT be a closure that refers to variables
161in an outer scope. This does NOT work. Pass arguments into it instead.
162 175
163=cut 176=cut
164 177
165sub async(&@) { 178sub async(&@) {
166 my $pid = new Coro @_; 179 my $pid = new Coro @_;
… …
185 198
186=cut 199=cut
187 200
188=item terminate [arg...] 201=item terminate [arg...]
189 202
190Terminates the current process. 203Terminates the current process with the given status values (see L<cancel>).
191
192Future versions of this function will allow result arguments.
193 204
194=cut 205=cut
195 206
196sub terminate { 207sub terminate {
197 $current->{status} = [@_];
198 $current->cancel; 208 $current->cancel (@_);
199 &schedule;
200 die; # NORETURN
201} 209}
202 210
203=back 211=back
204 212
205# dynamic methods 213# dynamic methods
… …
234 242
235Put the given process into the ready queue. 243Put the given process into the ready queue.
236 244
237=cut 245=cut
238 246
239=item $process->cancel 247=item $process->cancel (arg...)
240 248
241Like 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).
242 251
243=cut 252=cut
244 253
245sub cancel { 254sub cancel {
255 my $self = shift;
256 $self->{status} = [@_];
246 push @destroy, $_[0]; 257 push @destroy, $self;
247 $manager->ready; 258 $manager->ready;
248 &schedule if $current == $_[0]; 259 &schedule if $current == $self;
249} 260}
250 261
251=item $process->join 262=item $process->join
252 263
253Wait until the coroutine terminates and return any values given to the 264Wait until the coroutine terminates and return any values given to the
254C<terminate> function. C<join> can be called multiple times from multiple 265C<terminate> or C<cancel> functions. C<join> can be called multiple times
255processes. 266from multiple processes.
256 267
257=cut 268=cut
258 269
259sub join { 270sub join {
260 my $self = shift; 271 my $self = shift;
… …
267 278
268=item $oldprio = $process->prio($newprio) 279=item $oldprio = $process->prio($newprio)
269 280
270Sets (or gets, if the argument is missing) the priority of the 281Sets (or gets, if the argument is missing) the priority of the
271process. Higher priority processes get run before lower priority 282process. Higher priority processes get run before lower priority
272processes. Priorities are smalled signed integer (currently -4 .. +3), 283processes. Priorities are small signed integers (currently -4 .. +3),
273that 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
274to get then): 285to get then):
275 286
276 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 287 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
277 3 > 1 > 0 > -1 > -3 > -4 288 3 > 1 > 0 > -1 > -3 > -4
… …
325 336
3261; 3371;
327 338
328=head1 BUGS/LIMITATIONS 339=head1 BUGS/LIMITATIONS
329 340
330 - you must make very sure that no coro is still active on global destruction. 341 - you must make very sure that no coro is still active on global
331 very bad things might happen otherwise (usually segfaults). 342 destruction. very bad things might happen otherwise (usually segfaults).
343
332 - this module is not thread-safe. You should only ever use this module from 344 - this module is not thread-safe. You should only ever use this module
333 the same thread (this requirement might be loosened in the future to 345 from the same thread (this requirement might be losened in the future
334 allow per-thread schedulers, but Coro::State does not yet allow this). 346 to allow per-thread schedulers, but Coro::State does not yet allow
347 this).
335 348
336=head1 SEE ALSO 349=head1 SEE ALSO
337 350
338L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 351Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
339L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 352
340L<Coro::Handle>, L<Coro::Socket>. 353Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
354
355Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
356
357Embedding: L<Coro:MakeMaker>
341 358
342=head1 AUTHOR 359=head1 AUTHOR
343 360
344 Marc Lehmann <pcg@goof.com> 361 Marc Lehmann <schmorp@schmorp.de>
345 http://www.goof.com/pcg/marc/ 362 http://home.schmorp.de/
346 363
347=cut 364=cut
348 365

Diff Legend

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