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.80 by root, Mon Nov 6 19:56:26 2006 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
35use strict;
37no warnings qw(uninitialized); 36no warnings "uninitialized";
38 37
39use Coro::State; 38use Coro::State;
40 39
41use base Exporter; 40use base Exporter::;
42 41
42our $idle; # idle coroutine
43our $main; # main coroutine
44our $current; # current coroutine
45
43$VERSION = 0.52; 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 (@_) {
… …
77 }; 83 };
78 } 84 }
79 85
80} 86}
81 87
88=over 4
89
82=item $main 90=item $main
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};
138 151
139# static methods. not really. 152# static methods. not really.
140 153
154=back
155
141=head2 STATIC METHODS 156=head2 STATIC METHODS
142 157
143Static methods are actually functions that operate on the current process only. 158Static methods are actually functions that operate on the current process only.
144 159
145=over 4 160=over 4
… …
147=item async { ... } [@args...] 162=item async { ... } [@args...]
148 163
149Create a new asynchronous process and return it's process object 164Create a new asynchronous process and return it's process object
150(usually unused). When the sub returns the new process is automatically 165(usually unused). When the sub returns the new process is automatically
151terminated. 166terminated.
167
168When the coroutine dies, the program will exit, just as in the main
169program.
152 170
153 # create a new coroutine that just prints its arguments 171 # create a new coroutine that just prints its arguments
154 async { 172 async {
155 print "@_\n"; 173 print "@_\n";
156 } 1,2,3,4; 174 } 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 175
161=cut 176=cut
162 177
163sub async(&@) { 178sub async(&@) {
164 my $pid = new Coro @_; 179 my $pid = new Coro @_;
… …
183 198
184=cut 199=cut
185 200
186=item terminate [arg...] 201=item terminate [arg...]
187 202
188Terminates the current process. 203Terminates the current process with the given status values (see L<cancel>).
189
190Future versions of this function will allow result arguments.
191 204
192=cut 205=cut
193 206
194sub terminate { 207sub terminate {
195 $current->{status} = [@_];
196 $current->cancel; 208 $current->cancel (@_);
197 &schedule;
198 die; # NORETURN
199} 209}
200 210
201=back 211=back
202 212
203# dynamic methods 213# dynamic methods
… …
232 242
233Put the given process into the ready queue. 243Put the given process into the ready queue.
234 244
235=cut 245=cut
236 246
237=item $process->cancel 247=item $process->cancel (arg...)
238 248
239Like 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).
240 251
241=cut 252=cut
242 253
243sub cancel { 254sub cancel {
255 my $self = shift;
256 $self->{status} = [@_];
244 push @destroy, $_[0]; 257 push @destroy, $self;
245 $manager->ready; 258 $manager->ready;
246 &schedule if $current == $_[0]; 259 &schedule if $current == $self;
247} 260}
248 261
249=item $process->join 262=item $process->join
250 263
251Wait until the coroutine terminates and return any values given to the 264Wait until the coroutine terminates and return any values given to the
252C<terminate> function. C<join> can be called multiple times from multiple 265C<terminate> or C<cancel> functions. C<join> can be called multiple times
253processes. 266from multiple processes.
254 267
255=cut 268=cut
256 269
257sub join { 270sub join {
258 my $self = shift; 271 my $self = shift;
… …
265 278
266=item $oldprio = $process->prio($newprio) 279=item $oldprio = $process->prio($newprio)
267 280
268Sets (or gets, if the argument is missing) the priority of the 281Sets (or gets, if the argument is missing) the priority of the
269process. Higher priority processes get run before lower priority 282process. Higher priority processes get run before lower priority
270processes. Priorities are smalled signed integer (currently -4 .. +3), 283processes. Priorities are small signed integers (currently -4 .. +3),
271that 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
272to get then): 285to get then):
273 286
274 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
275 3 > 1 > 0 > -1 > -3 > -4 288 3 > 1 > 0 > -1 > -3 > -4
… …
323 336
3241; 3371;
325 338
326=head1 BUGS/LIMITATIONS 339=head1 BUGS/LIMITATIONS
327 340
328 - 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
329 very bad things might happen otherwise (usually segfaults). 342 destruction. very bad things might happen otherwise (usually segfaults).
343
330 - this module is not thread-safe. You must only ever use this module from 344 - 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 345 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). 346 to allow per-thread schedulers, but Coro::State does not yet allow
347 this).
333 348
334=head1 SEE ALSO 349=head1 SEE ALSO
335 350
336L<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>.
337L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 352
338L<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>
339 358
340=head1 AUTHOR 359=head1 AUTHOR
341 360
342 Marc Lehmann <pcg@goof.com> 361 Marc Lehmann <schmorp@schmorp.de>
343 http://www.goof.com/pcg/marc/ 362 http://home.schmorp.de/
344 363
345=cut 364=cut
346 365

Diff Legend

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