Commit | Line | Data |
9e72f0cf |
1 | package Object::Remote::Connection; |
2 | |
c3d5ef8a |
3 | use Object::Remote::Logging qw (:log :dlog router); |
dc28afe8 |
4 | use Object::Remote::Future; |
9d804009 |
5 | use Object::Remote::Null; |
676438a1 |
6 | use Object::Remote::Handle; |
fe6c9a7f |
7 | use Object::Remote::CodeContainer; |
ed5a8a8e |
8 | use Object::Remote::GlobProxy; |
9 | use Object::Remote::GlobContainer; |
b51a8453 |
10 | use Object::Remote::Tied; |
9e72f0cf |
11 | use Object::Remote; |
ed5a8a8e |
12 | use Symbol; |
9e72f0cf |
13 | use IO::Handle; |
69aaad21 |
14 | use POSIX ":sys_wait_h"; |
9e72f0cf |
15 | use Module::Runtime qw(use_module); |
8ed52376 |
16 | use Scalar::Util qw(weaken blessed refaddr openhandle); |
9e72f0cf |
17 | use JSON::PP qw(encode_json); |
18 | use Moo; |
19 | |
69aaad21 |
20 | BEGIN { |
c3d5ef8a |
21 | router()->exclude_forwarding; |
0b51243d |
22 | $SIG{PIPE} = sub { log_debug { "Got a PIPE signal" } }; |
69aaad21 |
23 | } |
24 | |
25 | END { |
26 | log_debug { "Killing all child processes in the process group" }; |
27 | |
28 | #send SIGINT to the process group for our children |
29 | kill(1, -2); |
30 | } |
31 | |
07105aca |
32 | has _id => ( is => 'ro', required => 1, default => sub { our $NEXT_CONNECTION_ID++ } ); |
ad4f54b2 |
33 | |
9e72f0cf |
34 | has send_to_fh => ( |
35 | is => 'ro', required => 1, |
90a3a7f2 |
36 | trigger => sub { |
37 | my $self = $_[0]; |
38 | $_[1]->autoflush(1); |
39 | Dlog_trace { my $id = $self->_id; "connection had send_to_fh set to $_" } $_[1]; |
40 | }, |
9e72f0cf |
41 | ); |
42 | |
12fb4a80 |
43 | has read_channel => ( |
9e72f0cf |
44 | is => 'ro', required => 1, |
45 | trigger => sub { |
12fb4a80 |
46 | my ($self, $ch) = @_; |
8ed52376 |
47 | my $id = $self->_id; |
0b51243d |
48 | Dlog_trace { "trigger for read_channel has been invoked for connection $id; file handle is $_" } $ch->fh; |
9e72f0cf |
49 | weaken($self); |
12fb4a80 |
50 | $ch->on_line_call(sub { $self->_receive(@_) }); |
8ed52376 |
51 | $ch->on_close_call(sub { |
0b51243d |
52 | log_trace { "invoking 'done' on on_close handler for connection id '$id'" }; |
1a7f821f |
53 | $self->on_close->done(@_); |
8ed52376 |
54 | }); |
9e72f0cf |
55 | }, |
56 | ); |
57 | |
12fb4a80 |
58 | has on_close => ( |
b1f39f94 |
59 | is => 'rw', default => sub { $_[0]->_install_future_handlers(CPS::Future->new) }, |
0b51243d |
60 | trigger => sub { |
61 | log_trace { "Installing handlers into future via trigger" }; |
62 | $_[0]->_install_future_handlers($_[1]) |
63 | }, |
12fb4a80 |
64 | ); |
ad4f54b2 |
65 | |
47c83a13 |
66 | has child_pid => (is => 'ro'); |
67 | |
11dbd4a0 |
68 | has local_objects_by_id => ( |
69 | is => 'ro', default => sub { {} }, |
70 | coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in |
71 | ); |
9e72f0cf |
72 | |
11dbd4a0 |
73 | has remote_objects_by_id => ( |
74 | is => 'ro', default => sub { {} }, |
75 | coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in |
76 | ); |
9e72f0cf |
77 | |
a980b0b8 |
78 | has outstanding_futures => (is => 'ro', default => sub { {} }); |
79 | |
b1f39f94 |
80 | has _json => ( |
81 | is => 'lazy', |
82 | handles => { |
83 | _deserialize => 'decode', |
84 | _encode => 'encode', |
85 | }, |
86 | ); |
87 | |
88 | after BUILD => sub { |
0b51243d |
89 | my ($self) = @_; |
90 | my $pid = $self->child_pid; |
b1f39f94 |
91 | |
0b51243d |
92 | unless (defined $pid) { |
93 | log_trace { "After BUILD invoked for connection but there was no pid" }; |
94 | return; |
95 | } |
96 | |
97 | log_trace { "Setting process group of child process '$pid'" }; |
b1f39f94 |
98 | |
99 | setpgrp($self->child_pid, 1); |
100 | }; |
101 | |
102 | sub BUILD { } |
103 | |
12fb4a80 |
104 | sub _fail_outstanding { |
105 | my ($self, $error) = @_; |
0b51243d |
106 | Dlog_debug { "$$ Failing outstanding futures with '$error' for connection $_" } $self->_id; |
12fb4a80 |
107 | my $outstanding = $self->outstanding_futures; |
bd20b1bf |
108 | $_->fail("$error\n") for values %$outstanding; |
12fb4a80 |
109 | %$outstanding = (); |
110 | return; |
111 | } |
112 | |
b1f39f94 |
113 | sub _install_future_handlers { |
114 | my ($self, $f) = @_; |
0b51243d |
115 | Dlog_trace { "Installing handlers into future for connection $_" } $self->_id; |
b1f39f94 |
116 | weaken($self); |
117 | $f->on_done(sub { |
0b51243d |
118 | my $pid = $self->child_pid; |
119 | Dlog_trace { "Executing on_done handler in future for connection $_" } $self->_id; |
b1f39f94 |
120 | $self->_fail_outstanding("Object::Remote connection lost: " . ($f->get)[0]); |
0b51243d |
121 | return unless defined $pid; |
122 | log_debug { "Waiting for child '$pid' to exit" }; |
123 | my $ret = waitpid($pid, 0); |
124 | if ($ret != $pid) { |
125 | log_debug { "Waited for pid $pid but waitpid() returned $ret" }; |
126 | return; |
127 | } elsif ($? & 127) { |
128 | log_warn { "Remote interpreter did not exit cleanly" }; |
129 | } else { |
130 | log_verbose { |
131 | my $exit_value = $? >> 8; |
132 | "Remote Perl interpreter exited with value '$exit_value'" |
133 | }; |
134 | } |
b1f39f94 |
135 | }); |
136 | return $f; |
137 | }; |
9e72f0cf |
138 | |
fe6c9a7f |
139 | sub _id_to_remote_object { |
140 | my ($self, $id) = @_; |
07105aca |
141 | Dlog_trace { "fetching proxy for remote object with id '$id' for connection $_" } $self->_id; |
fe6c9a7f |
142 | return bless({}, 'Object::Remote::Null') if $id eq 'NULL'; |
143 | ( |
144 | $self->remote_objects_by_id->{$id} |
145 | or Object::Remote::Handle->new(connection => $self, id => $id) |
146 | )->proxy; |
147 | } |
148 | |
9e72f0cf |
149 | sub _build__json { |
150 | weaken(my $self = shift); |
9e72f0cf |
151 | JSON::PP->new->filter_json_single_key_object( |
152 | __remote_object__ => sub { |
fe6c9a7f |
153 | $self->_id_to_remote_object(@_); |
154 | } |
155 | )->filter_json_single_key_object( |
156 | __remote_code__ => sub { |
157 | my $code_container = $self->_id_to_remote_object(@_); |
158 | sub { $code_container->call(@_) }; |
9e72f0cf |
159 | } |
6ed5d580 |
160 | )->filter_json_single_key_object( |
161 | __scalar_ref__ => sub { |
162 | my $value = shift; |
163 | return \$value; |
164 | } |
ed5a8a8e |
165 | )->filter_json_single_key_object( |
166 | __glob_ref__ => sub { |
167 | my $glob_container = $self->_id_to_remote_object(@_); |
168 | my $handle = Symbol::gensym; |
169 | tie *$handle, 'Object::Remote::GlobProxy', $glob_container; |
170 | return $handle; |
171 | } |
b51a8453 |
172 | )->filter_json_single_key_object( |
173 | __remote_tied_hash__ => sub { |
1a7f821f |
174 | my %tied_hash; |
175 | tie %tied_hash, 'Object::Remote::Tied', $self->_id_to_remote_object(@_); |
176 | return \%tied_hash; |
b51a8453 |
177 | } |
178 | )->filter_json_single_key_object( |
179 | __remote_tied_array__ => sub { |
1a7f821f |
180 | my @tied_array; |
181 | tie @tied_array, 'Object::Remote::Tied', $self->_id_to_remote_object(@_); |
182 | return \@tied_array; |
b51a8453 |
183 | } |
184 | ); |
9e72f0cf |
185 | } |
186 | |
69aaad21 |
187 | sub _load_if_possible { |
188 | my ($class) = @_; |
189 | |
62796659 |
190 | use_module($class); |
69aaad21 |
191 | |
192 | if ($@) { |
193 | log_debug { "Attempt at loading '$class' failed with '$@'" }; |
194 | } |
195 | |
196 | } |
197 | |
84b04178 |
198 | BEGIN { |
199 | unshift our @Guess, sub { blessed($_[0]) ? $_[0] : undef }; |
69aaad21 |
200 | map _load_if_possible($_), qw( |
201 | Object::Remote::Connector::Local |
202 | Object::Remote::Connector::LocalSudo |
203 | Object::Remote::Connector::SSH |
204 | Object::Remote::Connector::UNIX |
205 | ); |
84b04178 |
206 | } |
207 | |
69aaad21 |
208 | sub conn_from_spec { |
209 | my ($class, $spec, @args) = @_; |
84b04178 |
210 | foreach my $poss (do { our @Guess }) { |
69aaad21 |
211 | if (my $conn = $poss->($spec, @args)) { |
212 | return $conn; |
fbd3b8ec |
213 | } |
84b04178 |
214 | } |
69aaad21 |
215 | |
216 | return undef; |
217 | } |
218 | |
219 | sub new_from_spec { |
220 | my ($class, $spec) = @_; |
221 | return $spec if blessed $spec; |
222 | my $conn = $class->conn_from_spec($spec); |
223 | |
224 | die "Couldn't figure out what to do with ${spec}" |
225 | unless defined $conn; |
226 | |
227 | return $conn->maybe::start::connect; |
84b04178 |
228 | } |
229 | |
11dbd4a0 |
230 | sub remote_object { |
e144d525 |
231 | my ($self, @args) = @_; |
232 | Object::Remote::Handle->new( |
233 | connection => $self, @args |
234 | )->proxy; |
235 | } |
236 | |
4c17fea5 |
237 | sub connect { |
238 | my ($self, $to) = @_; |
07105aca |
239 | Dlog_debug { "Creating connection to remote node '$to' for connection $_" } $self->_id; |
deb77aaf |
240 | return await_future( |
241 | $self->send_class_call(0, 'Object::Remote', connect => $to) |
242 | ); |
4c17fea5 |
243 | } |
244 | |
11dbd4a0 |
245 | sub remote_sub { |
c6fe6fbd |
246 | my ($self, $sub) = @_; |
247 | my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/; |
07105aca |
248 | Dlog_debug { "Invoking remote sub '$sub' for connection $_" } $self->_id; |
deb77aaf |
249 | return await_future($self->send_class_call(0, $pkg, can => $name)); |
250 | } |
251 | |
252 | sub send_class_call { |
253 | my ($self, $ctx, @call) = @_; |
07105aca |
254 | Dlog_trace { "Sending a class call for connection $_" } $self->_id; |
deb77aaf |
255 | $self->send(call => class_call_handler => $ctx => call => @call); |
256 | } |
257 | |
258 | sub register_class_call_handler { |
259 | my ($self) = @_; |
3687a42d |
260 | $self->local_objects_by_id->{'class_call_handler'} ||= do { |
c5736e1c |
261 | my $o = $self->new_class_call_handler; |
3687a42d |
262 | $self->_local_object_to_id($o); |
263 | $o; |
264 | }; |
c6fe6fbd |
265 | } |
266 | |
c5736e1c |
267 | sub new_class_call_handler { |
268 | Object::Remote::CodeContainer->new( |
269 | code => sub { |
270 | my ($class, $method) = (shift, shift); |
271 | use_module($class)->$method(@_); |
272 | } |
273 | ); |
274 | } |
275 | |
9e72f0cf |
276 | sub register_remote { |
277 | my ($self, $remote) = @_; |
07105aca |
278 | Dlog_trace { my $i = $remote->id; "Registered a remote object with id of '$i' for connection $_" } $self->_id; |
9e72f0cf |
279 | weaken($self->remote_objects_by_id->{$remote->id} = $remote); |
280 | return $remote; |
281 | } |
282 | |
283 | sub send_free { |
284 | my ($self, $id) = @_; |
b51a8453 |
285 | Dlog_trace { "sending request to free object '$id' for connection $_" } $self->_id; |
52a81cde |
286 | #TODO this shows up some times when a remote side dies in the middle of a remote |
287 | #method invocation - possibly only when the object is being constructed? |
288 | #(in cleanup) Use of uninitialized value $id in delete at ../Object-Remote/lib/Object/Remote/Connection. |
9e72f0cf |
289 | delete $self->remote_objects_by_id->{$id}; |
290 | $self->_send([ free => $id ]); |
291 | } |
292 | |
293 | sub send { |
294 | my ($self, $type, @call) = @_; |
295 | |
deb77aaf |
296 | my $future = CPS::Future->new; |
a2d43709 |
297 | my $remote = $self->remote_objects_by_id->{$call[0]}; |
deb77aaf |
298 | |
299 | unshift @call, $type => $self->_local_object_to_id($future); |
9e72f0cf |
300 | |
a980b0b8 |
301 | my $outstanding = $self->outstanding_futures; |
302 | $outstanding->{$future} = $future; |
a2d43709 |
303 | $future->on_ready(sub { |
304 | undef($remote); |
305 | delete $outstanding->{$future} |
306 | }); |
a980b0b8 |
307 | |
9e72f0cf |
308 | $self->_send(\@call); |
309 | |
310 | return $future; |
311 | } |
312 | |
9d804009 |
313 | sub send_discard { |
314 | my ($self, $type, @call) = @_; |
315 | |
deb77aaf |
316 | unshift @call, $type => 'NULL'; |
9d804009 |
317 | |
318 | $self->_send(\@call); |
319 | } |
320 | |
9e72f0cf |
321 | sub _send { |
322 | my ($self, $to_send) = @_; |
2d81cf18 |
323 | my $fh = $self->send_to_fh; |
07105aca |
324 | Dlog_trace { "Starting to serialize data in argument to _send for connection $_" } $self->_id; |
2d81cf18 |
325 | my $serialized = $self->_serialize($to_send)."\n"; |
5953edf6 |
326 | Dlog_trace { my $l = length($serialized); "serialization is completed; sending '$l' characters of serialized data to $_" } $fh; |
8ed52376 |
327 | my $ret; |
328 | eval { |
b1f39f94 |
329 | #TODO this should be converted over to a non-blocking ::WriteChannel class |
330 | die "filehandle is not open" unless openhandle($fh); |
331 | log_trace { "file handle has passed openhandle() test; printing to it" }; |
332 | $ret = print $fh $serialized; |
333 | die "print was not successful: $!" unless defined $ret |
8ed52376 |
334 | }; |
69aaad21 |
335 | |
8ed52376 |
336 | if ($@) { |
b1f39f94 |
337 | Dlog_debug { "exception encountered when trying to write to file handle $_: $@" } $fh; |
0b51243d |
338 | my $error = $@; |
339 | chomp($error); |
b1f39f94 |
340 | $self->on_close->done("could not write to file handle: $error") unless $self->on_close->is_ready; |
341 | return; |
8ed52376 |
342 | } |
343 | |
2d81cf18 |
344 | return $ret; |
9e72f0cf |
345 | } |
346 | |
347 | sub _serialize { |
348 | my ($self, $data) = @_; |
3687a42d |
349 | local our @New_Ids = (-1); |
9d804009 |
350 | return eval { |
ad4f54b2 |
351 | my $flat = $self->_encode($self->_deobjectify($data)); |
ad4f54b2 |
352 | $flat; |
70a578ac |
353 | } || do { |
9d804009 |
354 | my $err = $@; # won't get here if the eval doesn't die |
355 | # don't keep refs to new things |
356 | delete @{$self->local_objects_by_id}{@New_Ids}; |
357 | die "Error serializing: $err"; |
358 | }; |
9e72f0cf |
359 | } |
360 | |
a76f2f60 |
361 | sub _local_object_to_id { |
362 | my ($self, $object) = @_; |
363 | my $id = refaddr($object); |
364 | $self->local_objects_by_id->{$id} ||= do { |
3687a42d |
365 | push our(@New_Ids), $id if @New_Ids; |
a76f2f60 |
366 | $object; |
367 | }; |
368 | return $id; |
369 | } |
370 | |
9e72f0cf |
371 | sub _deobjectify { |
372 | my ($self, $data) = @_; |
373 | if (blessed($data)) { |
a76f2f60 |
374 | return +{ __remote_object__ => $self->_local_object_to_id($data) }; |
9e72f0cf |
375 | } elsif (my $ref = ref($data)) { |
376 | if ($ref eq 'HASH') { |
b51a8453 |
377 | my $tied_to = tied(%$data); |
378 | if(defined($tied_to)) { |
379 | return +{__remote_tied_hash__ => $self->_local_object_to_id($tied_to)}; |
380 | } else { |
381 | return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data }; |
382 | } |
9e72f0cf |
383 | } elsif ($ref eq 'ARRAY') { |
b51a8453 |
384 | my $tied_to = tied(@$data); |
385 | if (defined($tied_to)) { |
386 | return +{__remote_tied_array__ => $self->_local_object_to_id($tied_to)}; |
387 | } else { |
388 | return [ map $self->_deobjectify($_), @$data ]; |
389 | } |
fe6c9a7f |
390 | } elsif ($ref eq 'CODE') { |
391 | my $id = $self->_local_object_to_id( |
392 | Object::Remote::CodeContainer->new(code => $data) |
393 | ); |
394 | return +{ __remote_code__ => $id }; |
6ed5d580 |
395 | } elsif ($ref eq 'SCALAR') { |
396 | return +{ __scalar_ref__ => $$data }; |
ed5a8a8e |
397 | } elsif ($ref eq 'GLOB') { |
398 | return +{ __glob_ref__ => $self->_local_object_to_id( |
399 | Object::Remote::GlobContainer->new(handle => $data) |
400 | ) }; |
9e72f0cf |
401 | } else { |
402 | die "Can't collapse reftype $ref"; |
403 | } |
404 | } |
405 | return $data; # plain scalar |
406 | } |
407 | |
9e72f0cf |
408 | sub _receive { |
ad4f54b2 |
409 | my ($self, $flat) = @_; |
07105aca |
410 | Dlog_trace { my $l = length($flat); "Starting to deserialize $l characters of data for connection $_" } $self->_id; |
ad4f54b2 |
411 | my ($type, @rest) = eval { @{$self->_deserialize($flat)} } |
412 | or do { warn "Deserialize failed for ${flat}: $@"; return }; |
07105aca |
413 | Dlog_trace { "deserialization complete for connection $_" } $self->_id; |
9e72f0cf |
414 | eval { $self->${\"receive_${type}"}(@rest); 1 } |
ad4f54b2 |
415 | or do { warn "Receive failed for ${flat}: $@"; return }; |
9e72f0cf |
416 | return; |
417 | } |
418 | |
419 | sub receive_free { |
420 | my ($self, $id) = @_; |
07105aca |
421 | Dlog_trace { "got a receive_free for object '$id' for connection $_" } $self->_id; |
9d804009 |
422 | delete $self->local_objects_by_id->{$id} |
423 | or warn "Free: no such object $id"; |
9e72f0cf |
424 | return; |
425 | } |
426 | |
427 | sub receive_call { |
deb77aaf |
428 | my ($self, $future_id, $id, @rest) = @_; |
07105aca |
429 | Dlog_trace { "got a receive_call for object '$id' for connection $_" } $self->_id; |
deb77aaf |
430 | my $future = $self->_id_to_remote_object($future_id); |
8131a88a |
431 | $future->{method} = 'call_discard_free'; |
9e72f0cf |
432 | my $local = $self->local_objects_by_id->{$id} |
433 | or do { $future->fail("No such object $id"); return }; |
434 | $self->_invoke($future, $local, @rest); |
435 | } |
436 | |
8131a88a |
437 | sub receive_call_free { |
438 | my ($self, $future, $id, @rest) = @_; |
07105aca |
439 | Dlog_trace { "got a receive_call_free for object '$id' for connection $_" } $self->_id; |
84b04178 |
440 | $self->receive_call($future, $id, undef, @rest); |
8131a88a |
441 | $self->receive_free($id); |
442 | } |
443 | |
9e72f0cf |
444 | sub _invoke { |
84b04178 |
445 | my ($self, $future, $local, $ctx, $method, @args) = @_; |
07105aca |
446 | Dlog_trace { "got _invoke for a method named '$method' for connection $_" } $self->_id; |
dc28afe8 |
447 | if ($method =~ /^start::/) { |
448 | my $f = $local->$method(@args); |
449 | $f->on_done(sub { undef($f); $future->done(@_) }); |
3f1f1e66 |
450 | return unless $f; |
dc28afe8 |
451 | $f->on_fail(sub { undef($f); $future->fail(@_) }); |
452 | return; |
453 | } |
84b04178 |
454 | my $do = sub { $local->$method(@args) }; |
455 | eval { |
456 | $future->done( |
457 | defined($ctx) |
458 | ? ($ctx ? $do->() : scalar($do->())) |
459 | : do { $do->(); () } |
460 | ); |
461 | 1; |
462 | } or do { $future->fail($@); return; }; |
9e72f0cf |
463 | return; |
464 | } |
465 | |
9e72f0cf |
466 | 1; |
b9a9982d |
467 | |
468 | =head1 NAME |
469 | |
470 | Object::Remote::Connection - An underlying connection for L<Object::Remote> |
471 | |
472 | =head1 LAME |
473 | |
474 | Shipping prioritised over writing this part up. Blame mst. |
475 | |
476 | =cut |