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