1 |
=head1 NAME |
2 |
|
3 |
Coro::State - create and manage simple coroutines |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use Coro::State; |
8 |
|
9 |
$new = new Coro::State sub { |
10 |
print "in coroutine (called with @_), switching back\n"; |
11 |
$new->transfer ($main); |
12 |
print "in coroutine again, switching back\n"; |
13 |
$new->transfer ($main); |
14 |
}, 5; |
15 |
|
16 |
$main = new Coro::State; |
17 |
|
18 |
print "in main, switching to coroutine\n"; |
19 |
$main->transfer ($new); |
20 |
print "back in main, switch to coroutine again\n"; |
21 |
$main->transfer ($new); |
22 |
print "back in main\n"; |
23 |
|
24 |
=head1 DESCRIPTION |
25 |
|
26 |
This module implements coroutines. Coroutines, similar to continuations, |
27 |
allow you to run more than one "thread of execution" in parallel. Unlike |
28 |
threads, there is no parallelism and only voluntary switching is used so |
29 |
locking problems are greatly reduced. |
30 |
|
31 |
This can be used to implement non-local jumps, exception handling, |
32 |
continuations and more. |
33 |
|
34 |
This module provides only low-level functionality. See L<Coro> and related |
35 |
modules for a higher level process abstraction including scheduling. |
36 |
|
37 |
=head2 MEMORY CONSUMPTION |
38 |
|
39 |
A newly created coroutine that has not been used only allocates a |
40 |
relatively small (a few hundred bytes) structure. Only on the first |
41 |
C<transfer> will perl allocate stacks (a few kb) and optionally |
42 |
a C stack/coroutine (cctx) for coroutines that recurse through C |
43 |
functions. All this is very system-dependent. On my x86_64-pc-linux-gnu |
44 |
system this amounts to about 8k per (non-trivial) coroutine. You can view |
45 |
the actual memory consumption using Coro::Debug. |
46 |
|
47 |
=head2 FUNCTIONS |
48 |
|
49 |
=over 4 |
50 |
|
51 |
=cut |
52 |
|
53 |
package Coro::State; |
54 |
|
55 |
use strict; |
56 |
no warnings "uninitialized"; |
57 |
|
58 |
use XSLoader; |
59 |
|
60 |
BEGIN { |
61 |
our $VERSION = '4.0'; |
62 |
|
63 |
# must be done here because the xs part expects it to exist |
64 |
# it might exist already because Coro::Specific created it. |
65 |
$Coro::current ||= { }; |
66 |
|
67 |
XSLoader::load __PACKAGE__, $VERSION; |
68 |
} |
69 |
|
70 |
use Exporter; |
71 |
use base Exporter::; |
72 |
|
73 |
=item $coro = new Coro::State [$coderef[, @args...]] |
74 |
|
75 |
Create a new coroutine and return it. The first C<transfer> call to this |
76 |
coroutine will start execution at the given coderef. If the subroutine |
77 |
returns the program will be terminated as if execution of the main program |
78 |
ended. If it throws an exception the program will terminate. |
79 |
|
80 |
Calling C<exit> in a coroutine does the same as calling it in the main |
81 |
program. |
82 |
|
83 |
If the coderef is omitted this function will create a new "empty" |
84 |
coroutine, i.e. a coroutine that cannot be transfered to but can be used |
85 |
to save the current coroutine in. |
86 |
|
87 |
The returned object is an empty hash which can be used for any purpose |
88 |
whatsoever, for example when subclassing Coro::State. |
89 |
|
90 |
Certain variables are "localised" to each coroutine, that is, certain |
91 |
"global" variables are actually per coroutine. Not everything that would |
92 |
sensibly be localised currently is, and not everything that is localised |
93 |
makes sense for every application, and the future might bring changes. |
94 |
|
95 |
The following global variables can have different values in each |
96 |
coroutine, and have defined initial values: |
97 |
|
98 |
Variable Initial Value |
99 |
@_ whatever arguments were passed to the Coro |
100 |
$_ undef |
101 |
$@ undef |
102 |
$/ "\n" |
103 |
(select) STDOUT |
104 |
|
105 |
If you feel that something important is missing then tell me. Also |
106 |
remember that every function call that might call C<transfer> (such |
107 |
as C<Coro::Channel::put>) might clobber any global and/or special |
108 |
variables. Yes, this is by design ;) You can always create your own |
109 |
process abstraction model that saves these variables. |
110 |
|
111 |
The easiest way to do this is to create your own scheduling primitive like |
112 |
this: |
113 |
|
114 |
sub schedule { |
115 |
local ($;, ...); |
116 |
$old->transfer ($new); |
117 |
} |
118 |
|
119 |
=cut |
120 |
|
121 |
# this is called for each newly created C coroutine, |
122 |
# and is being artificially injected into the opcode flow. |
123 |
# its sole purpose is to call transfer() once so it knows |
124 |
# the stop level stack frame for stack sharing. |
125 |
sub _cctx_init { |
126 |
select STDOUT; |
127 |
_set_stacklevel $_[0]; |
128 |
} |
129 |
|
130 |
=item $state->has_stack |
131 |
|
132 |
Returns wether the state currently uses a cctx/C stack. An active state |
133 |
always has a cctx, as well as the main program. Other states only use a |
134 |
cctx when needed. |
135 |
|
136 |
=item $bytes = $state->rss |
137 |
|
138 |
Returns the memory allocated by the coroutine (which includes |
139 |
static structures, various perl stacks but NOT local variables, |
140 |
arguments or any C stack). |
141 |
|
142 |
=item $state->call ($coderef) |
143 |
|
144 |
Try to call the given $coderef in the context of the given state. This |
145 |
works even when the state is currently within an XS function, and can |
146 |
be very dangerous. You can use it to acquire stack traces etc. (see the |
147 |
Coro::Debug module for more details). The coderef MUST NOT EVER transfer |
148 |
to another state. |
149 |
|
150 |
=item $state->eval ($string) |
151 |
|
152 |
Like C<call>, but eval's the string. Dangerous. Do not |
153 |
use. Untested. Unused. Biohazard. |
154 |
|
155 |
=item $state->trace ($flags) |
156 |
|
157 |
Internal function to control tracing. I just mention this so you can stay |
158 |
from abusing it. |
159 |
|
160 |
=item $prev->transfer ($next) |
161 |
|
162 |
Save the state of the current subroutine in C<$prev> and switch to the |
163 |
coroutine saved in C<$next>. |
164 |
|
165 |
The "state" of a subroutine includes the scope, i.e. lexical variables and |
166 |
the current execution state (subroutine, stack). |
167 |
|
168 |
=item Coro::State::cctx_count |
169 |
|
170 |
Returns the number of C-level coroutines allocated. If this number is |
171 |
very high (more than a dozen) it might help to identify points of C-level |
172 |
recursion in your code and moving this into a separate coroutine. |
173 |
|
174 |
=item Coro::State::cctx_idle |
175 |
|
176 |
Returns the number of allocated but idle (free for reuse) C level |
177 |
coroutines. Currently, Coro will limit the number of idle/unused cctxs to |
178 |
8. |
179 |
|
180 |
=item Coro::State::cctx_stacksize [$new_stacksize] |
181 |
|
182 |
Returns the current C stack size and optionally sets the new I<minimum> |
183 |
stack size to C<$new_stacksize> I<long>s. Existing stacks will not |
184 |
be changed, but Coro will try to replace smaller stacks as soon as |
185 |
possible. Any Coro::State's that starts to use a stack after this call is |
186 |
guarenteed this minimum size. Please note that Coroutines will only need |
187 |
to use a C-level stack if the interpreter recurses or calls a function in |
188 |
a module that calls back into the interpreter. |
189 |
|
190 |
=item @states = Coro::State::list |
191 |
|
192 |
Returns a list of all states currently allocated. |
193 |
|
194 |
=cut |
195 |
|
196 |
sub debug_desc { |
197 |
$_[0]{desc} |
198 |
} |
199 |
|
200 |
1; |
201 |
|
202 |
=back |
203 |
|
204 |
=head1 BUGS |
205 |
|
206 |
This module is not thread-safe. You must only ever use this module from |
207 |
the same thread (this requirement might be loosened in the future). |
208 |
|
209 |
=head1 SEE ALSO |
210 |
|
211 |
L<Coro>. |
212 |
|
213 |
=head1 AUTHOR |
214 |
|
215 |
Marc Lehmann <schmorp@schmorp.de> |
216 |
http://home.schmorp.de/ |
217 |
|
218 |
=cut |
219 |
|