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

Comparing Coro/Coro.pm (file contents):
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs.
Revision 1.78 by root, Wed Nov 1 01:21:21 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.52; 42our $idle; # idle coroutine
43our $main; # main coroutine
44our $current; # current coroutine
42 45
46our $VERSION = '2.1';
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 (@_) {
… …
75 }; 83 };
76 } 84 }
77 85
78} 86}
79 87
88=over 4
89
80=item $main 90=item $main
81 91
82This coroutine represents the main program. 92This coroutine represents the main program.
83 93
84=cut 94=cut
85 95
86our $main = new Coro; 96$main = new Coro;
87 97
88=item $current (or as function: current) 98=item $current (or as function: current)
89 99
90The 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).
91 101
… …
94# maybe some other module used Coro::Specific before... 104# maybe some other module used Coro::Specific before...
95if ($current) { 105if ($current) {
96 $main->{specific} = $current->{specific}; 106 $main->{specific} = $current->{specific};
97} 107}
98 108
99our $current = $main; 109$current = $main;
100 110
101sub current() { $current } 111sub current() { $current }
102 112
103=item $idle 113=item $idle
104 114
… …
106implementation prints "FATAL: deadlock detected" and exits. 116implementation prints "FATAL: deadlock detected" and exits.
107 117
108=cut 118=cut
109 119
110# should be done using priorities :( 120# should be done using priorities :(
111our $idle = new Coro sub { 121$idle = new Coro sub {
112 print STDERR "FATAL: deadlock detected\n"; 122 print STDERR "FATAL: deadlock detected\n";
113 exit(51); 123 exit(51);
114}; 124};
115 125
116# this coroutine is necessary because a coroutine 126# this coroutine is necessary because a coroutine
117# cannot destroy itself. 127# cannot destroy itself.
118my @destroy; 128my @destroy;
119my $manager; 129my $manager;
120$manager = new Coro sub { 130$manager = new Coro sub {
121 while() { 131 while () {
122 # by overwriting the state object with the manager we destroy it 132 # by overwriting the state object with the manager we destroy it
123 # 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
124 # been readied multiple times. this is harmless since the manager 134 # been readied multiple times. this is harmless since the manager
125 # can be called as many times as neccessary and will always 135 # can be called as many times as neccessary and will always
126 # remove itself from the runqueue 136 # remove itself from the runqueue
127 while (@destroy) { 137 while (@destroy) {
128 my $coro = pop @destroy; 138 my $coro = pop @destroy;
129 $coro->{status} ||= []; 139 $coro->{status} ||= [];
130 $_->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).
131 $coro->{_coro_state} = $manager->{_coro_state}; 146 $coro->{_coro_state} = $manager->{_coro_state};
132 } 147 }
133 &schedule; 148 &schedule;
134 } 149 }
135}; 150};
136 151
137# static methods. not really. 152# static methods. not really.
138 153
154=back
155
139=head2 STATIC METHODS 156=head2 STATIC METHODS
140 157
141Static methods are actually functions that operate on the current process only. 158Static methods are actually functions that operate on the current process only.
142 159
143=over 4 160=over 4
… …
150 167
151 # create a new coroutine that just prints its arguments 168 # create a new coroutine that just prints its arguments
152 async { 169 async {
153 print "@_\n"; 170 print "@_\n";
154 } 1,2,3,4; 171 } 1,2,3,4;
155
156The coderef you submit MUST NOT be a closure that refers to variables
157in an outer scope. This does NOT work. Pass arguments into it instead.
158 172
159=cut 173=cut
160 174
161sub async(&@) { 175sub async(&@) {
162 my $pid = new Coro @_; 176 my $pid = new Coro @_;
… …
181 195
182=cut 196=cut
183 197
184=item terminate [arg...] 198=item terminate [arg...]
185 199
186Terminates the current process. 200Terminates the current process with the given status values (see L<cancel>).
187
188Future versions of this function will allow result arguments.
189 201
190=cut 202=cut
191 203
192sub terminate { 204sub terminate {
193 $current->{status} = [@_];
194 $current->cancel; 205 $current->cancel (@_);
195 &schedule;
196 die; # NORETURN
197} 206}
198 207
199=back 208=back
200 209
201# dynamic methods 210# dynamic methods
… …
230 239
231Put the given process into the ready queue. 240Put the given process into the ready queue.
232 241
233=cut 242=cut
234 243
235=item $process->cancel 244=item $process->cancel (arg...)
236 245
237Like C<terminate>, but terminates the specified process instead. 246Temrinates the given process and makes it return the given arguments as
247status (default: the empty list).
238 248
239=cut 249=cut
240 250
241sub cancel { 251sub cancel {
252 my $self = shift;
253 $self->{status} = [@_];
242 push @destroy, $_[0]; 254 push @destroy, $self;
243 $manager->ready; 255 $manager->ready;
244 &schedule if $current == $_[0]; 256 &schedule if $current == $self;
245} 257}
246 258
247=item $process->join 259=item $process->join
248 260
249Wait until the coroutine terminates and return any values given to the 261Wait until the coroutine terminates and return any values given to the
250C<terminate> function. C<join> can be called multiple times from multiple 262C<terminate> or C<cancel> functions. C<join> can be called multiple times
251processes. 263from multiple processes.
252 264
253=cut 265=cut
254 266
255sub join { 267sub join {
256 my $self = shift; 268 my $self = shift;
… …
263 275
264=item $oldprio = $process->prio($newprio) 276=item $oldprio = $process->prio($newprio)
265 277
266Sets (or gets, if the argument is missing) the priority of the 278Sets (or gets, if the argument is missing) the priority of the
267process. Higher priority processes get run before lower priority 279process. Higher priority processes get run before lower priority
268processes. Priorities are smalled signed integer (currently -4 .. +3), 280processes. Priorities are small signed integers (currently -4 .. +3),
269that you can refer to using PRIO_xxx constants (use the import tag :prio 281that you can refer to using PRIO_xxx constants (use the import tag :prio
270to get then): 282to get then):
271 283
272 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN 284 PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
273 3 > 1 > 0 > -1 > -3 > -4 285 3 > 1 > 0 > -1 > -3 > -4
… …
321 333
3221; 3341;
323 335
324=head1 BUGS/LIMITATIONS 336=head1 BUGS/LIMITATIONS
325 337
326 - you must make very sure that no coro is still active on global destruction. 338 - you must make very sure that no coro is still active on global
327 very bad things might happen otherwise (usually segfaults). 339 destruction. very bad things might happen otherwise (usually segfaults).
340
328 - this module is not thread-safe. You should only ever use this module from 341 - this module is not thread-safe. You should only ever use this module
329 the same thread (this requirement might be loosened in the future to 342 from the same thread (this requirement might be losened in the future
330 allow per-thread schedulers, but Coro::State does not yet allow this). 343 to allow per-thread schedulers, but Coro::State does not yet allow
344 this).
331 345
332=head1 SEE ALSO 346=head1 SEE ALSO
333 347
334L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, 348Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
335L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, 349
336L<Coro::Handle>, L<Coro::Socket>. 350Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
351
352Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
353
354Embedding: L<Coro:MakeMaker>
337 355
338=head1 AUTHOR 356=head1 AUTHOR
339 357
340 Marc Lehmann <pcg@goof.com> 358 Marc Lehmann <schmorp@schmorp.de>
341 http://www.goof.com/pcg/marc/ 359 http://home.schmorp.de/
342 360
343=cut 361=cut
344 362

Diff Legend

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