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

Comparing Coro/Coro.pm (file contents):
Revision 1.18 by root, Sat Jul 21 02:49:09 2001 UTC vs.
Revision 1.88 by root, Sun Nov 26 02:54:55 2006 UTC

… …
14 14
15 sub some_func : Coro { 15 sub some_func : Coro {
16 # some more async code 16 # some more async code
17 } 17 }
18 18
19 yield; 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 25
26This module is still experimental, see the BUGS section below. 26In this module, coroutines are defined as "callchain + lexical variables
27+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
28callchain, it's own set of lexicals and it's own set of perl's most
29important global variables.
27 30
28=cut 31=cut
29 32
30package Coro; 33package Coro;
31 34
35use strict;
36no warnings "uninitialized";
37
32use Coro::State; 38use Coro::State;
33 39
34use base Exporter; 40use base qw(Coro::State Exporter);
35 41
42our $idle; # idle handler
43our $main; # main coroutine
44our $current; # current coroutine
45
36$VERSION = 0.09; 46our $VERSION = '3.0';
37 47
38@EXPORT = qw(async yield schedule terminate); 48our @EXPORT = qw(async cede schedule terminate current);
39@EXPORT_OK = qw($current); 49our %EXPORT_TAGS = (
50 prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
51);
52our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
40 53
41{ 54{
42 use subs 'async';
43
44 my @async; 55 my @async;
56 my $init;
45 57
46 # this way of handling attributes simply is NOT scalable ;() 58 # this way of handling attributes simply is NOT scalable ;()
47 sub import { 59 sub import {
60 no strict 'refs';
61
48 Coro->export_to_level(1, @_); 62 Coro->export_to_level(1, @_);
63
49 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; 64 my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
50 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { 65 *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
51 my ($package, $ref) = (shift, shift); 66 my ($package, $ref) = (shift, shift);
52 my @attrs; 67 my @attrs;
53 for (@_) { 68 for (@_) {
54 if ($_ eq "Coro") { 69 if ($_ eq "Coro") {
55 push @async, $ref; 70 push @async, $ref;
71 unless ($init++) {
72 eval q{
73 sub INIT {
74 &async(pop @async) while @async;
75 }
76 };
77 }
56 } else { 78 } else {
57 push @attrs, $_; 79 push @attrs, $_;
58 } 80 }
59 } 81 }
60 return $old ? $old->($package, $ref, @attrs) : @attrs; 82 return $old ? $old->($package, $ref, @attrs) : @attrs;
61 }; 83 };
62 } 84 }
63 85
64 sub INIT {
65 async pop @async while @async;
66 }
67} 86}
87
88=over 4
68 89
69=item $main 90=item $main
70 91
71This coroutine represents the main program. 92This coroutine represents the main program.
72 93
73=cut 94=cut
74 95
75our $main = new Coro; 96$main = new Coro;
76 97
77=item $current 98=item $current (or as function: current)
78 99
79The 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.
80 106
81=cut 107=cut
82 108
83# maybe some other module used Coro::Specific before... 109# maybe some other module used Coro::Specific before...
84if ($current) { 110if ($current) {
85 $main->{specific} = $current->{specific}; 111 $main->{specific} = $current->{specific};
86} 112}
87 113
88our $current = $main; 114$current = $main;
115
116sub current() { $current }
89 117
90=item $idle 118=item $idle
91 119
92The coroutine to switch to when no other coroutine is running. The default 120A callback that is called whenever the scheduler finds no ready coroutines
93implementation prints "FATAL: deadlock detected" and exits. 121to run. The default implementation prints "FATAL: deadlock detected" and
122exits.
94 123
95=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.
96 127
97# should be done using priorities :( 128=cut
98our $idle = new Coro sub { 129
130$idle = sub {
99 print STDERR "FATAL: deadlock detected\n"; 131 print STDERR "FATAL: deadlock detected\n";
100 exit(51); 132 exit (51);
101}; 133};
102 134
103# we really need priorities... 135# this coroutine is necessary because a coroutine
104my @ready; # the ready queue. hehe, rather broken ;) 136# cannot destroy itself.
137my @destroy;
138my $manager; $manager = new Coro sub {
139 while () {
140 # by overwriting the state object with the manager we destroy it
141 # while still being able to schedule this coroutine (in case it has
142 # been readied multiple times. this is harmless since the manager
143 # can be called as many times as neccessary and will always
144 # remove itself from the runqueue
145 while (@destroy) {
146 my $coro = pop @destroy;
147 $coro->{status} ||= [];
148 $_->ready for @{delete $coro->{join} || []};
149
150 # the next line destroys the coro state, but keeps the
151 # process itself intact (we basically make it a zombie
152 # process that always runs the manager thread, so it's possible
153 # to transfer() to this process).
154 $coro->_clone_state_from ($manager);
155 }
156 &schedule;
157 }
158};
105 159
106# static methods. not really. 160# static methods. not really.
161
162=back
107 163
108=head2 STATIC METHODS 164=head2 STATIC METHODS
109 165
110Static methods are actually functions that operate on the current process only. 166Static methods are actually functions that operate on the current process only.
111 167
… …
114=item async { ... } [@args...] 170=item async { ... } [@args...]
115 171
116Create a new asynchronous process and return it's process object 172Create a new asynchronous process and return it's process object
117(usually unused). When the sub returns the new process is automatically 173(usually unused). When the sub returns the new process is automatically
118terminated. 174terminated.
175
176When the coroutine dies, the program will exit, just as in the main
177program.
119 178
120 # create a new coroutine that just prints its arguments 179 # create a new coroutine that just prints its arguments
121 async { 180 async {
122 print "@_\n"; 181 print "@_\n";
123 } 1,2,3,4; 182 } 1,2,3,4;
124 183
125The coderef you submit MUST NOT be a closure that refers to variables
126in an outer scope. This does NOT work. Pass arguments into it instead.
127
128=cut 184=cut
129 185
130sub async(&@) { 186sub async(&@) {
131 my $pid = new Coro @_; 187 my $pid = new Coro @_;
132 $pid->ready; 188 $pid->ready;
133 $pid; 189 $pid
134} 190}
135 191
136=item schedule 192=item schedule
137 193
138Calls the scheduler. Please note that the current process will not be put 194Calls the scheduler. Please note that the current process will not be put
139into the ready queue, so calling this function usually means you will 195into the ready queue, so calling this function usually means you will
140never be called again. 196never be called again.
141 197
142=cut 198=cut
143 199
144my $prev;
145
146sub schedule {
147 # should be done using priorities :(
148 ($prev, $current) = ($current, shift @ready || $idle);
149 Coro::State::transfer($prev, $current);
150}
151
152=item yield 200=item cede
153 201
154Yield to other processes. This function puts the current process into the 202"Cede" to other processes. This function puts the current process into the
155ready queue and calls C<schedule>. 203ready queue and calls C<schedule>, which has the effect of giving up the
204current "timeslice" to other coroutines of the same or higher priority.
156 205
157=cut 206=cut
158 207
159sub yield {
160 $current->ready;
161 &schedule;
162}
163
164=item terminate 208=item terminate [arg...]
165 209
166Terminates the current process. 210Terminates the current process with the given status values (see L<cancel>).
167
168Future versions of this function will allow result arguments.
169 211
170=cut 212=cut
171 213
172sub terminate { 214sub terminate {
173 $current->{_results} = [@_]; 215 $current->cancel (@_);
174 &schedule;
175} 216}
176 217
177=back 218=back
178 219
179# dynamic methods 220# dynamic methods
… …
185=over 4 226=over 4
186 227
187=item new Coro \&sub [, @args...] 228=item new Coro \&sub [, @args...]
188 229
189Create a new process and return it. When the sub returns the process 230Create a new process and return it. When the sub returns the process
190automatically terminates. To start the process you must first put it into 231automatically terminates as if C<terminate> with the returned values were
232called. To make the process run you must first put it into the ready queue
191the ready queue by calling the ready method. 233by calling the ready method.
192 234
193The coderef you submit MUST NOT be a closure that refers to variables
194in an outer scope. This does NOT work. Pass arguments into it instead.
195
196=cut 235=cut
197 236
198sub _newcoro { 237sub _new_coro {
199 terminate &{+shift}; 238 terminate &{+shift};
200} 239}
201 240
202sub new { 241sub new {
203 my $class = shift; 242 my $class = shift;
204 bless { 243
205 _coro_state => (new Coro::State $_[0] && \&_newcoro, @_), 244 $class->SUPER::new (\&_new_coro, @_)
206 }, $class;
207} 245}
208 246
209=item $process->ready 247=item $process->ready
210 248
211Put the current process into the ready queue. 249Put the given process into the ready queue.
212 250
213=cut 251=cut
214 252
215sub ready { 253=item $process->cancel (arg...)
216 push @ready, $_[0]; 254
255Terminates the given process and makes it return the given arguments as
256status (default: the empty list).
257
258=cut
259
260sub cancel {
261 my $self = shift;
262 $self->{status} = [@_];
263 push @destroy, $self;
264 $manager->ready;
265 &schedule if $current == $self;
266}
267
268=item $process->join
269
270Wait until the coroutine terminates and return any values given to the
271C<terminate> or C<cancel> functions. C<join> can be called multiple times
272from multiple processes.
273
274=cut
275
276sub join {
277 my $self = shift;
278 unless ($self->{status}) {
279 push @{$self->{join}}, $current;
280 &schedule;
281 }
282 wantarray ? @{$self->{status}} : $self->{status}[0];
283}
284
285=item $oldprio = $process->prio ($newprio)
286
287Sets (or gets, if the argument is missing) the priority of the
288process. Higher priority processes get run before lower priority
289processes. Priorities are small signed integers (currently -4 .. +3),
290that you can refer to using PRIO_xxx constants (use the import tag :prio
291to get then):
292
293 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
294 3 > 1 > 0 > -1 > -3 > -4
295
296 # set priority to HIGH
297 current->prio(PRIO_HIGH);
298
299The idle coroutine ($Coro::idle) always has a lower priority than any
300existing coroutine.
301
302Changing the priority of the current process will take effect immediately,
303but changing the priority of processes in the ready queue (but not
304running) will only take effect after the next schedule (of that
305process). This is a bug that will be fixed in some future version.
306
307=item $newprio = $process->nice ($change)
308
309Similar to C<prio>, but subtract the given value from the priority (i.e.
310higher values mean lower priority, just as in unix).
311
312=item $olddesc = $process->desc ($newdesc)
313
314Sets (or gets in case the argument is missing) the description for this
315process. This is just a free-form string you can associate with a process.
316
317=cut
318
319sub desc {
320 my $old = $_[0]{desc};
321 $_[0]{desc} = $_[1] if @_ > 1;
322 $old;
217} 323}
218 324
219=back 325=back
220 326
221=cut 327=cut
222 328
2231; 3291;
224 330
225=head1 BUGS/LIMITATIONS 331=head1 BUGS/LIMITATIONS
226 332
227 - could be faster, especially when the core would introduce special 333 - you must make very sure that no coro is still active on global
228 support for coroutines (like it does for threads). 334 destruction. very bad things might happen otherwise (usually segfaults).
229 - there is still a memleak on coroutine termination that I could not 335
230 identify. Could be as small as a single SV.
231 - this module is not well-tested.
232 - if variables or arguments "disappear" (become undef) or become
233 corrupted please contact the author so he cen iron out the
234 remaining bugs.
235 - this module is not thread-safe. You must only ever use this module from 336 - this module is not thread-safe. You should only ever use this module
236 the same thread (this requirement might be loosened in the future to 337 from the same thread (this requirement might be losened in the future
237 allow per-thread schedulers, but Coro::Satte does not yet allow this). 338 to allow per-thread schedulers, but Coro::State does not yet allow
339 this).
238 340
239=head1 SEE ALSO 341=head1 SEE ALSO
240 342
241L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 343Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
242L<Coro::Signal>, L<Coro::State>, L<Coro::Event>. 344
345Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
346
347Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
348
349Embedding: L<Coro:MakeMaker>
243 350
244=head1 AUTHOR 351=head1 AUTHOR
245 352
246 Marc Lehmann <pcg@goof.com> 353 Marc Lehmann <schmorp@schmorp.de>
247 http://www.goof.com/pcg/marc/ 354 http://home.schmorp.de/
248 355
249=cut 356=cut
250 357

Diff Legend

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