Commit | Line | Data |
a9fdb55e |
1 | package Object::Remote::Role::Connector::PerlInterpreter; |
2 | |
90115979 |
3 | use IPC::Open3; |
4c8c83d7 |
4 | use IO::Handle; |
353556c4 |
5 | use Symbol; |
5add5e29 |
6 | use Object::Remote::Logging qw(:log :dlog router); |
a9fdb55e |
7 | use Object::Remote::ModuleSender; |
8 | use Object::Remote::Handle; |
fbd3b8ec |
9 | use Object::Remote::Future; |
c824fdf3 |
10 | use Scalar::Util qw(blessed weaken); |
a9fdb55e |
11 | use Moo::Role; |
12 | |
13 | with 'Object::Remote::Role::Connector'; |
14 | |
03f41c0e |
15 | has module_sender => (is => 'lazy'); |
f1d70835 |
16 | has ulimit => ( is => 'ro'); |
17 | has nice => ( is => 'ro'); |
18 | has watchdog_timeout => ( is => 'ro', required => 1, default => sub { undef }); |
90f5193d |
19 | has forward_env => (is => 'ro', required => 1, builder => 1); |
f129bfaf |
20 | has perl_command => (is => 'lazy'); |
f1d70835 |
21 | has pid => (is => 'rwp'); |
22 | has connection_id => (is => 'rwp'); |
c824fdf3 |
23 | |
6b7b2732 |
24 | #if no child_stderr file handle is specified then stderr |
25 | #of the child will be connected to stderr of the parent |
c824fdf3 |
26 | has stderr => ( is => 'rw', default => sub { undef } ); |
03f41c0e |
27 | |
5add5e29 |
28 | BEGIN { router()->exclude_forwarding; } |
29 | |
03f41c0e |
30 | sub _build_module_sender { |
18e789ab |
31 | my ($hook) = |
32 | grep {blessed($_) && $_->isa('Object::Remote::ModuleLoader::Hook') } |
33 | @INC; |
03f41c0e |
34 | return $hook ? $hook->sender : Object::Remote::ModuleSender->new; |
35 | } |
36 | |
eb351344 |
37 | #FIXME by policy object-remote does not invoke a shell |
37efeb68 |
38 | sub _build_perl_command { |
8f43bcd9 |
39 | my ($self) = @_; |
40 | my $nice = $self->nice; |
41 | my $ulimit = $self->ulimit; |
42 | my $perl_path = 'perl'; |
43 | my $shell_code = ''; |
0fe333eb |
44 | |
8f43bcd9 |
45 | if (defined($ulimit)) { |
46 | $shell_code .= "ulimit $ulimit || exit 1; "; |
47 | } |
0fe333eb |
48 | |
8f43bcd9 |
49 | if (defined($nice)) { |
50 | $shell_code .= "nice -n $nice "; |
51 | } |
0fe333eb |
52 | |
8f43bcd9 |
53 | if (defined($ENV{OBJECT_REMOTE_PERL_BIN})) { |
54 | log_debug { "Using OBJECT_REMOTE_PERL_BIN environment variable as perl path" }; |
55 | $perl_path = $ENV{OBJECT_REMOTE_PERL_BIN}; |
56 | } |
0fe333eb |
57 | |
8f43bcd9 |
58 | $shell_code .= $perl_path . ' -'; |
0fe333eb |
59 | |
8f43bcd9 |
60 | return [ 'bash', '-c', $shell_code ]; |
37efeb68 |
61 | } |
498c4ad5 |
62 | |
90f5193d |
63 | sub _build_forward_env { |
64 | return [qw( |
65 | OBJECT_REMOTE_PERL_BIN |
66 | OBJECT_REMOTE_LOG_LEVEL OBJECT_REMOTE_LOG_FORMAT OBJECT_REMOTE_LOG_SELECTIONS |
67 | OBJECT_REMOTE_LOG_FORWARDING |
68 | )]; |
69 | } |
70 | |
03f41c0e |
71 | around connect => sub { |
72 | my ($orig, $self) = (shift, shift); |
fbd3b8ec |
73 | my $f = $self->$start::start($orig => @_); |
74 | return future { |
75 | $f->on_done(sub { |
76 | my ($conn) = $f->get; |
f1d70835 |
77 | $self->_setup_watchdog_reset($conn); |
78 | my $sub = $conn->remote_sub('Object::Remote::Logging::init_remote_logging'); |
f4a85080 |
79 | $sub->('Object::Remote::Logging', router => router(), connection_id => $conn->_id); |
fbd3b8ec |
80 | Object::Remote::Handle->new( |
81 | connection => $conn, |
82 | class => 'Object::Remote::ModuleLoader', |
83 | args => { module_sender => $self->module_sender } |
84 | )->disarm_free; |
85 | require Object::Remote::Prompt; |
86 | Object::Remote::Prompt::maybe_set_prompt_command_on($conn); |
87 | }); |
88 | $f; |
89 | } 2; |
a9fdb55e |
90 | }; |
91 | |
498c4ad5 |
92 | sub final_perl_command { shift->perl_command } |
a9fdb55e |
93 | |
7efea51f |
94 | sub _start_perl { |
a9fdb55e |
95 | my $self = shift; |
6b7b2732 |
96 | my $given_stderr = $self->stderr; |
97 | my $foreign_stderr; |
98 | |
088218cf |
99 | Dlog_verbose { |
100 | s/\n/ /g; "invoking connection to perl interpreter using command line: $_" |
101 | } @{$self->final_perl_command}; |
f8080c1c |
102 | |
6b7b2732 |
103 | if (defined($given_stderr)) { |
09130cd0 |
104 | #if the stderr data goes to an existing file handle |
105 | #an anonymous file handle is required |
106 | #as the other half of a pipe style file handle pair |
107 | #so the file handles can go into the run loop |
108 | $foreign_stderr = gensym(); |
6b7b2732 |
109 | } else { |
09130cd0 |
110 | #if no file handle has been specified |
111 | #for the child's stderr then connect |
112 | #the child stderr to the parent stderr |
113 | $foreign_stderr = ">&STDERR"; |
6b7b2732 |
114 | } |
115 | |
116 | my $pid = open3( |
117 | my $foreign_stdin, |
118 | my $foreign_stdout, |
119 | $foreign_stderr, |
120 | @{$self->final_perl_command}, |
121 | ) or die "Failed to run perl at '$_[0]': $!"; |
122 | |
f1d70835 |
123 | $self->_set_pid($pid); |
124 | |
6b7b2732 |
125 | if (defined($given_stderr)) { |
09130cd0 |
126 | Dlog_debug { "Child process STDERR is being handled via run loop" }; |
6b7b2732 |
127 | |
09130cd0 |
128 | Object::Remote->current_loop |
129 | ->watch_io( |
130 | handle => $foreign_stderr, |
131 | on_read_ready => sub { |
132 | my $buf = ''; |
133 | my $len = sysread($foreign_stderr, $buf, 32768); |
134 | if (!defined($len) or $len == 0) { |
135 | log_trace { "Got EOF or error on child stderr, removing from watcher" }; |
136 | $self->stderr(undef); |
137 | Object::Remote->current_loop->unwatch_io( |
138 | handle => $foreign_stderr, |
139 | on_read_ready => 1 |
140 | ); |
6b7b2732 |
141 | } else { |
09130cd0 |
142 | Dlog_trace { "got $len characters of stderr data for connection" }; |
143 | print $given_stderr $buf or die "could not send stderr data: $!"; |
6b7b2732 |
144 | } |
7790ca36 |
145 | } |
6b7b2732 |
146 | ); |
147 | } |
148 | |
c824fdf3 |
149 | return ($foreign_stdin, $foreign_stdout, $pid); |
7efea51f |
150 | } |
151 | |
152 | sub _open2_for { |
153 | my $self = shift; |
154 | my ($foreign_stdin, $foreign_stdout, $pid) = $self->_start_perl(@_); |
fbd3b8ec |
155 | my $to_send = $self->fatnode_text; |
f1d70835 |
156 | log_debug { my $len = length($to_send); "Sending contents of fat node to remote node; size is '$len' characters" }; |
fbd3b8ec |
157 | Object::Remote->current_loop |
158 | ->watch_io( |
159 | handle => $foreign_stdin, |
160 | on_write_ready => sub { |
9031635d |
161 | my $len = syswrite($foreign_stdin, $to_send, 32768); |
fbd3b8ec |
162 | if (defined $len) { |
163 | substr($to_send, 0, $len) = ''; |
164 | } |
165 | # if the stdin went away, we'll never get Shere |
166 | # so it's not a big deal to simply give up on !defined |
353556c4 |
167 | if (!defined($len) or 0 == length($to_send)) { |
5d59cb98 |
168 | log_trace { "Got EOF or error when writing fatnode data to filehandle, unwatching it" }; |
fbd3b8ec |
169 | Object::Remote->current_loop |
170 | ->unwatch_io( |
171 | handle => $foreign_stdin, |
172 | on_write_ready => 1 |
09130cd0 |
173 | ); |
5d59cb98 |
174 | } else { |
175 | log_trace { "Sent $len bytes of fatnode data to remote side" }; |
fbd3b8ec |
176 | } |
177 | } |
178 | ); |
a9fdb55e |
179 | return ($foreign_stdin, $foreign_stdout, $pid); |
180 | } |
181 | |
c824fdf3 |
182 | sub _setup_watchdog_reset { |
09130cd0 |
183 | my ($self, $conn) = @_; |
184 | my $timer_id; |
c824fdf3 |
185 | |
867e4de5 |
186 | return unless $self->watchdog_timeout; |
c824fdf3 |
187 | |
09130cd0 |
188 | Dlog_trace { "Creating Watchdog management timer for connection id $_" } $conn->_id; |
b7a853b3 |
189 | |
09130cd0 |
190 | weaken($conn); |
b7a853b3 |
191 | |
09130cd0 |
192 | $timer_id = Object::Remote->current_loop->watch_time( |
193 | every => $self->watchdog_timeout / 3, |
194 | code => sub { |
195 | unless(defined($conn)) { |
867e4de5 |
196 | log_warn { "Weak reference to connection in Watchdog was lost, terminating update timer $timer_id" }; |
09130cd0 |
197 | Object::Remote->current_loop->unwatch_time($timer_id); |
867e4de5 |
198 | return; |
09130cd0 |
199 | } |
867e4de5 |
200 | |
201 | unless($conn->is_valid) { |
202 | log_warn { "Watchdog timer found an invalid connection, removing the timer" }; |
203 | Object::Remote->current_loop->unwatch_time($timer_id); |
204 | return; |
205 | } |
206 | |
09130cd0 |
207 | Dlog_trace { "Reseting Watchdog for connection id $_" } $conn->_id; |
208 | #we do not want to block in the run loop so send the |
209 | #update off and ignore any result, we don't need it |
210 | #anyway |
211 | $conn->send_class_call(0, 'Object::Remote::WatchDog', 'reset'); |
212 | } |
867e4de5 |
213 | ); |
214 | |
215 | $conn->on_close->on_ready(sub { |
216 | log_debug { "Removing watchdog for connection that is now closed" }; |
217 | Object::Remote->current_loop->unwatch_time($timer_id); |
218 | }); |
c824fdf3 |
219 | } |
220 | |
b1cbd5be |
221 | sub fatnode_text { |
222 | my ($self) = @_; |
8faf2a28 |
223 | my $connection_timeout = $self->timeout; |
224 | my $watchdog_timeout = $self->watchdog_timeout; |
b1cbd5be |
225 | my $text = ''; |
c824fdf3 |
226 | |
227 | require Object::Remote::FatNode; |
228 | |
8faf2a28 |
229 | if (defined($connection_timeout)) { |
230 | $text .= "alarm($connection_timeout);\n"; |
231 | } |
232 | |
233 | if (defined($watchdog_timeout)) { |
f1d70835 |
234 | $text .= "my \$WATCHDOG_TIMEOUT = $watchdog_timeout;\n"; |
b7a853b3 |
235 | } else { |
8faf2a28 |
236 | $text .= "my \$WATCHDOG_TIMEOUT = undef;\n"; |
c824fdf3 |
237 | } |
b7a853b3 |
238 | |
90f5193d |
239 | $text .= $self->_create_env_forward(@{$self->forward_env}); |
ffc9934e |
240 | |
241 | #Action at a distance but at least it's not spooky - the logging |
242 | #system needs to know if a node is remote but there is a period |
243 | #during init where the remote connection information has not been |
244 | #setup on the remote side yet so this flag allows a graceful |
245 | #degredation to happen |
f1d70835 |
246 | $text .= '$Object::Remote::FatNode::REMOTE_NODE = "1";' . "\n"; |
247 | |
b1cbd5be |
248 | $text .= <<'END'; |
249 | $INC{'Object/Remote/FatNode.pm'} = __FILE__; |
250 | $Object::Remote::FatNode::DATA = <<'ENDFAT'; |
251 | END |
fbd3b8ec |
252 | $text .= do { no warnings 'once'; $Object::Remote::FatNode::DATA }; |
b1cbd5be |
253 | $text .= "ENDFAT\n"; |
254 | $text .= <<'END'; |
255 | eval $Object::Remote::FatNode::DATA; |
1a2d795f |
256 | die $@ if $@; |
b1cbd5be |
257 | END |
c824fdf3 |
258 | |
b1cbd5be |
259 | $text .= "__END__\n"; |
260 | return $text; |
261 | } |
262 | |
90f5193d |
263 | sub _create_env_forward { |
264 | my ($self, @env_names) = @_; |
265 | my $code = ''; |
266 | |
267 | foreach my $name (@env_names) { |
268 | next unless exists $ENV{$name}; |
269 | my $value = $ENV{$name}; |
270 | $name =~ s/'/\\'/g; |
271 | if(defined($value)) { |
272 | $value =~ s/'/\\'/g; |
273 | $value = "'$value'"; |
274 | } else { |
275 | $value = 'undef'; |
276 | } |
277 | $code .= "\$ENV{'$name'} = $value;\n"; |
278 | } |
279 | |
280 | return $code; |
281 | } |
282 | |
a9fdb55e |
283 | 1; |