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