| 1 |
=head1 NAME |
| 2 |
|
| 3 |
Coro - coroutine process abstraction |
| 4 |
|
| 5 |
=head1 SYNOPSIS |
| 6 |
|
| 7 |
use Coro; |
| 8 |
|
| 9 |
async { |
| 10 |
# some asynchronous thread of execution |
| 11 |
}; |
| 12 |
|
| 13 |
# alternatively create an async process like this: |
| 14 |
|
| 15 |
sub some_func : Coro { |
| 16 |
# some more async code |
| 17 |
} |
| 18 |
|
| 19 |
cede; |
| 20 |
|
| 21 |
=head1 DESCRIPTION |
| 22 |
|
| 23 |
This module collection manages coroutines. Coroutines are similar to |
| 24 |
Threads but don't run in parallel. |
| 25 |
|
| 26 |
This module is still experimental, see the BUGS section below. |
| 27 |
|
| 28 |
In this module, coroutines are defined as "callchain + lexical variables |
| 29 |
+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own |
| 30 |
callchain, it's own set of lexicals and it's own set of perl's most |
| 31 |
important global variables. |
| 32 |
|
| 33 |
=cut |
| 34 |
|
| 35 |
package Coro; |
| 36 |
|
| 37 |
no warnings qw(uninitialized); |
| 38 |
|
| 39 |
use Coro::State; |
| 40 |
|
| 41 |
use base Exporter; |
| 42 |
|
| 43 |
$VERSION = 0.51; |
| 44 |
|
| 45 |
@EXPORT = qw(async cede schedule terminate current); |
| 46 |
%EXPORT_TAGS = ( |
| 47 |
prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)], |
| 48 |
); |
| 49 |
@EXPORT_OK = @{$EXPORT_TAGS{prio}}; |
| 50 |
|
| 51 |
{ |
| 52 |
my @async; |
| 53 |
my $init; |
| 54 |
|
| 55 |
# this way of handling attributes simply is NOT scalable ;() |
| 56 |
sub import { |
| 57 |
Coro->export_to_level(1, @_); |
| 58 |
my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE}; |
| 59 |
*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub { |
| 60 |
my ($package, $ref) = (shift, shift); |
| 61 |
my @attrs; |
| 62 |
for (@_) { |
| 63 |
if ($_ eq "Coro") { |
| 64 |
push @async, $ref; |
| 65 |
unless ($init++) { |
| 66 |
eval q{ |
| 67 |
sub INIT { |
| 68 |
&async(pop @async) while @async; |
| 69 |
} |
| 70 |
}; |
| 71 |
} |
| 72 |
} else { |
| 73 |
push @attrs, $_; |
| 74 |
} |
| 75 |
} |
| 76 |
return $old ? $old->($package, $ref, @attrs) : @attrs; |
| 77 |
}; |
| 78 |
} |
| 79 |
|
| 80 |
} |
| 81 |
|
| 82 |
=item $main |
| 83 |
|
| 84 |
This coroutine represents the main program. |
| 85 |
|
| 86 |
=cut |
| 87 |
|
| 88 |
our $main = new Coro; |
| 89 |
|
| 90 |
=item $current (or as function: current) |
| 91 |
|
| 92 |
The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course). |
| 93 |
|
| 94 |
=cut |
| 95 |
|
| 96 |
# maybe some other module used Coro::Specific before... |
| 97 |
if ($current) { |
| 98 |
$main->{specific} = $current->{specific}; |
| 99 |
} |
| 100 |
|
| 101 |
our $current = $main; |
| 102 |
|
| 103 |
sub current() { $current } |
| 104 |
|
| 105 |
=item $idle |
| 106 |
|
| 107 |
The coroutine to switch to when no other coroutine is running. The default |
| 108 |
implementation prints "FATAL: deadlock detected" and exits. |
| 109 |
|
| 110 |
=cut |
| 111 |
|
| 112 |
# should be done using priorities :( |
| 113 |
our $idle = new Coro sub { |
| 114 |
print STDERR "FATAL: deadlock detected\n"; |
| 115 |
exit(51); |
| 116 |
}; |
| 117 |
|
| 118 |
# this coroutine is necessary because a coroutine |
| 119 |
# cannot destroy itself. |
| 120 |
my @destroy; |
| 121 |
my $manager; |
| 122 |
$manager = new Coro sub { |
| 123 |
while() { |
| 124 |
# by overwriting the state object with the manager we destroy it |
| 125 |
# while still being able to schedule this coroutine (in case it has |
| 126 |
# been readied multiple times. this is harmless since the manager |
| 127 |
# can be called as many times as neccessary and will always |
| 128 |
# remove itself from the runqueue |
| 129 |
(pop @destroy)->{_coro_state} = $manager->{_coro_state} while @destroy; |
| 130 |
&schedule; |
| 131 |
} |
| 132 |
}; |
| 133 |
|
| 134 |
# static methods. not really. |
| 135 |
|
| 136 |
=head2 STATIC METHODS |
| 137 |
|
| 138 |
Static methods are actually functions that operate on the current process only. |
| 139 |
|
| 140 |
=over 4 |
| 141 |
|
| 142 |
=item async { ... } [@args...] |
| 143 |
|
| 144 |
Create a new asynchronous process and return it's process object |
| 145 |
(usually unused). When the sub returns the new process is automatically |
| 146 |
terminated. |
| 147 |
|
| 148 |
# create a new coroutine that just prints its arguments |
| 149 |
async { |
| 150 |
print "@_\n"; |
| 151 |
} 1,2,3,4; |
| 152 |
|
| 153 |
The coderef you submit MUST NOT be a closure that refers to variables |
| 154 |
in an outer scope. This does NOT work. Pass arguments into it instead. |
| 155 |
|
| 156 |
=cut |
| 157 |
|
| 158 |
sub async(&@) { |
| 159 |
my $pid = new Coro @_; |
| 160 |
$manager->ready; # this ensures that the stack is cloned from the manager |
| 161 |
$pid->ready; |
| 162 |
$pid; |
| 163 |
} |
| 164 |
|
| 165 |
=item schedule |
| 166 |
|
| 167 |
Calls the scheduler. Please note that the current process will not be put |
| 168 |
into the ready queue, so calling this function usually means you will |
| 169 |
never be called again. |
| 170 |
|
| 171 |
=cut |
| 172 |
|
| 173 |
=item cede |
| 174 |
|
| 175 |
"Cede" to other processes. This function puts the current process into the |
| 176 |
ready queue and calls C<schedule>, which has the effect of giving up the |
| 177 |
current "timeslice" to other coroutines of the same or higher priority. |
| 178 |
|
| 179 |
=cut |
| 180 |
|
| 181 |
=item terminate |
| 182 |
|
| 183 |
Terminates the current process. |
| 184 |
|
| 185 |
Future versions of this function will allow result arguments. |
| 186 |
|
| 187 |
=cut |
| 188 |
|
| 189 |
sub terminate { |
| 190 |
$current->cancel; |
| 191 |
&schedule; |
| 192 |
die; # NORETURN |
| 193 |
} |
| 194 |
|
| 195 |
=back |
| 196 |
|
| 197 |
# dynamic methods |
| 198 |
|
| 199 |
=head2 PROCESS METHODS |
| 200 |
|
| 201 |
These are the methods you can call on process objects. |
| 202 |
|
| 203 |
=over 4 |
| 204 |
|
| 205 |
=item new Coro \&sub [, @args...] |
| 206 |
|
| 207 |
Create a new process and return it. When the sub returns the process |
| 208 |
automatically terminates. To start the process you must first put it into |
| 209 |
the ready queue by calling the ready method. |
| 210 |
|
| 211 |
The coderef you submit MUST NOT be a closure that refers to variables |
| 212 |
in an outer scope. This does NOT work. Pass arguments into it instead. |
| 213 |
|
| 214 |
=cut |
| 215 |
|
| 216 |
sub _newcoro { |
| 217 |
terminate &{+shift}; |
| 218 |
} |
| 219 |
|
| 220 |
sub new { |
| 221 |
my $class = shift; |
| 222 |
bless { |
| 223 |
_coro_state => (new Coro::State $_[0] && \&_newcoro, @_), |
| 224 |
}, $class; |
| 225 |
} |
| 226 |
|
| 227 |
=item $process->ready |
| 228 |
|
| 229 |
Put the given process into the ready queue. |
| 230 |
|
| 231 |
=cut |
| 232 |
|
| 233 |
=item $process->cancel |
| 234 |
|
| 235 |
Like C<terminate>, but terminates the specified process instead. |
| 236 |
|
| 237 |
=cut |
| 238 |
|
| 239 |
sub cancel { |
| 240 |
push @destroy, $_[0]; |
| 241 |
$manager->ready; |
| 242 |
&schedule if $current == $_[0]; |
| 243 |
} |
| 244 |
|
| 245 |
=item $oldprio = $process->prio($newprio) |
| 246 |
|
| 247 |
Sets the priority of the process. Higher priority processes get run before |
| 248 |
lower priority processes. Priorities are smalled signed integer (currently |
| 249 |
-4 .. +3), that you can refer to using PRIO_xxx constants (use the import |
| 250 |
tag :prio to get then): |
| 251 |
|
| 252 |
PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN |
| 253 |
3 > 1 > 0 > -1 > -3 > -4 |
| 254 |
|
| 255 |
# set priority to HIGH |
| 256 |
current->prio(PRIO_HIGH); |
| 257 |
|
| 258 |
The idle coroutine ($Coro::idle) always has a lower priority than any |
| 259 |
existing coroutine. |
| 260 |
|
| 261 |
Changing the priority of the current process will take effect immediately, |
| 262 |
but changing the priority of processes in the ready queue (but not |
| 263 |
running) will only take effect after the next schedule (of that |
| 264 |
process). This is a bug that will be fixed in some future version. |
| 265 |
|
| 266 |
=cut |
| 267 |
|
| 268 |
sub prio { |
| 269 |
my $old = $_[0]{prio}; |
| 270 |
$_[0]{prio} = $_[1] if @_ > 1; |
| 271 |
$old; |
| 272 |
} |
| 273 |
|
| 274 |
=item $newprio = $process->nice($change) |
| 275 |
|
| 276 |
Similar to C<prio>, but subtract the given value from the priority (i.e. |
| 277 |
higher values mean lower priority, just as in unix). |
| 278 |
|
| 279 |
=cut |
| 280 |
|
| 281 |
sub nice { |
| 282 |
$_[0]{prio} -= $_[1]; |
| 283 |
} |
| 284 |
|
| 285 |
=back |
| 286 |
|
| 287 |
=cut |
| 288 |
|
| 289 |
1; |
| 290 |
|
| 291 |
=head1 BUGS/LIMITATIONS |
| 292 |
|
| 293 |
- you must make very sure that no coro is still active on global destruction. |
| 294 |
very bad things might happen otherwise (usually segfaults). |
| 295 |
- this module is not thread-safe. You must only ever use this module from |
| 296 |
the same thread (this requirement might be loosened in the future to |
| 297 |
allow per-thread schedulers, but Coro::State does not yet allow this). |
| 298 |
|
| 299 |
=head1 SEE ALSO |
| 300 |
|
| 301 |
L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>, |
| 302 |
L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>, |
| 303 |
L<Coro::Handle>, L<Coro::Socket>. |
| 304 |
|
| 305 |
=head1 AUTHOR |
| 306 |
|
| 307 |
Marc Lehmann <pcg@goof.com> |
| 308 |
http://www.goof.com/pcg/marc/ |
| 309 |
|
| 310 |
=cut |
| 311 |
|
