1 package Object::Remote::Connection;
3 use Object::Remote::Logging qw (:log :dlog router);
4 use Object::Remote::Future;
5 use Object::Remote::Null;
6 use Object::Remote::Handle;
7 use Object::Remote::CodeContainer;
8 use Object::Remote::GlobProxy;
9 use Object::Remote::GlobContainer;
10 use Object::Remote::Tied;
14 use POSIX ":sys_wait_h";
15 use Module::Runtime qw(use_module);
16 use Scalar::Util qw(weaken blessed refaddr openhandle);
17 use JSON::PP qw(encode_json);
21 router()->exclude_forwarding;
22 $SIG{PIPE} = sub { log_debug { "Got a PIPE signal" } };
26 log_debug { "Killing all child processes in the process group" };
28 #send SIGINT to the process group for our children
32 has _id => ( is => 'ro', required => 1, default => sub { our $NEXT_CONNECTION_ID++ } );
35 is => 'ro', required => 1,
39 Dlog_trace { my $id = $self->_id; "connection had send_to_fh set to $_" } $_[1];
44 is => 'ro', required => 1,
48 Dlog_trace { "trigger for read_channel has been invoked for connection $id; file handle is $_" } $ch->fh;
50 $ch->on_line_call(sub { $self->_receive(@_) });
51 $ch->on_close_call(sub {
52 log_trace { "invoking 'done' on on_close handler for connection id '$id'" };
53 $self->on_close->done(@_);
59 is => 'rw', default => sub { $_[0]->_install_future_handlers(CPS::Future->new) },
61 log_trace { "Installing handlers into future via trigger" };
62 $_[0]->_install_future_handlers($_[1])
66 has child_pid => (is => 'ro');
68 has local_objects_by_id => (
69 is => 'ro', default => sub { {} },
70 coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
73 has remote_objects_by_id => (
74 is => 'ro', default => sub { {} },
75 coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
78 has outstanding_futures => (is => 'ro', default => sub { {} });
83 _deserialize => 'decode',
90 my $pid = $self->child_pid;
92 unless (defined $pid) {
93 log_trace { "After BUILD invoked for connection but there was no pid" };
97 log_trace { "Setting process group of child process '$pid'" };
99 setpgrp($self->child_pid, 1);
104 sub _fail_outstanding {
105 my ($self, $error) = @_;
106 Dlog_debug { "$$ Failing outstanding futures with '$error' for connection $_" } $self->_id;
107 my $outstanding = $self->outstanding_futures;
108 $_->fail("$error\n") for values %$outstanding;
113 sub _install_future_handlers {
115 Dlog_trace { "Installing handlers into future for connection $_" } $self->_id;
118 my $pid = $self->child_pid;
119 Dlog_trace { "Executing on_done handler in future for connection $_" } $self->_id;
120 $self->_fail_outstanding("Object::Remote connection lost: " . ($f->get)[0]);
121 return unless defined $pid;
122 log_debug { "Waiting for child '$pid' to exit" };
123 my $ret = waitpid($pid, 0);
125 log_debug { "Waited for pid $pid but waitpid() returned $ret" };
128 log_warn { "Remote interpreter did not exit cleanly" };
131 my $exit_value = $? >> 8;
132 "Remote Perl interpreter exited with value '$exit_value'"
139 sub _id_to_remote_object {
140 my ($self, $id) = @_;
141 Dlog_trace { "fetching proxy for remote object with id '$id' for connection $_" } $self->_id;
142 return bless({}, 'Object::Remote::Null') if $id eq 'NULL';
144 $self->remote_objects_by_id->{$id}
145 or Object::Remote::Handle->new(connection => $self, id => $id)
150 weaken(my $self = shift);
151 JSON::PP->new->filter_json_single_key_object(
152 __remote_object__ => sub {
153 $self->_id_to_remote_object(@_);
155 )->filter_json_single_key_object(
156 __remote_code__ => sub {
157 my $code_container = $self->_id_to_remote_object(@_);
158 sub { $code_container->call(@_) };
160 )->filter_json_single_key_object(
161 __scalar_ref__ => sub {
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;
172 )->filter_json_single_key_object(
173 __local_object__ => sub {
174 $self->local_objects_by_id->{$_[0]}
176 )->filter_json_single_key_object(
177 __remote_tied_hash__ => sub {
179 tie %tied_hash, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
182 )->filter_json_single_key_object(
183 __remote_tied_array__ => sub {
185 tie @tied_array, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
191 sub _load_if_possible {
197 log_debug { "Attempt at loading '$class' failed with '$@'" };
203 unshift our @Guess, sub { blessed($_[0]) ? $_[0] : undef };
204 map _load_if_possible($_), qw(
205 Object::Remote::Connector::Local
206 Object::Remote::Connector::LocalSudo
207 Object::Remote::Connector::SSH
208 Object::Remote::Connector::UNIX
213 my ($class, $spec, @args) = @_;
214 foreach my $poss (do { our @Guess }) {
215 if (my $conn = $poss->($spec, @args)) {
224 my ($class, $spec) = @_;
225 return $spec if blessed $spec;
226 my $conn = $class->conn_from_spec($spec);
228 die "Couldn't figure out what to do with ${spec}"
229 unless defined $conn;
231 return $conn->maybe::start::connect;
235 my ($self, @args) = @_;
236 Object::Remote::Handle->new(
237 connection => $self, @args
242 my ($self, $to) = @_;
243 Dlog_debug { "Creating connection to remote node '$to' for connection $_" } $self->_id;
245 $self->send_class_call(0, 'Object::Remote', connect => $to)
250 my ($self, $sub) = @_;
251 my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/;
252 Dlog_debug { "Invoking remote sub '$sub' for connection $_" } $self->_id;
253 return await_future($self->send_class_call(0, $pkg, can => $name));
256 sub send_class_call {
257 my ($self, $ctx, @call) = @_;
258 Dlog_trace { "Sending a class call for connection $_" } $self->_id;
259 $self->send(call => class_call_handler => $ctx => call => @call);
262 sub register_class_call_handler {
264 $self->local_objects_by_id->{'class_call_handler'} ||= do {
265 my $o = $self->new_class_call_handler;
266 $self->_local_object_to_id($o);
271 sub new_class_call_handler {
272 Object::Remote::CodeContainer->new(
274 my ($class, $method) = (shift, shift);
275 use_module($class)->$method(@_);
280 sub register_remote {
281 my ($self, $remote) = @_;
282 Dlog_trace { my $i = $remote->id; "Registered a remote object with id of '$i' for connection $_" } $self->_id;
283 weaken($self->remote_objects_by_id->{$remote->id} = $remote);
288 my ($self, $id) = @_;
289 Dlog_trace { "sending request to free object '$id' for connection $_" } $self->_id;
290 delete $self->remote_objects_by_id->{$id};
291 $self->_send([ free => $id ]);
295 my ($self, $type, @call) = @_;
297 my $future = CPS::Future->new;
298 my $remote = $self->remote_objects_by_id->{$call[0]};
300 unshift @call, $type => $self->_local_object_to_id($future);
302 my $outstanding = $self->outstanding_futures;
303 $outstanding->{$future} = $future;
304 $future->on_ready(sub {
306 delete $outstanding->{$future}
309 $self->_send(\@call);
315 my ($self, $type, @call) = @_;
317 unshift @call, $type => 'NULL';
319 $self->_send(\@call);
323 my ($self, $to_send) = @_;
324 my $fh = $self->send_to_fh;
325 Dlog_trace { "Starting to serialize data in argument to _send for connection $_" } $self->_id;
326 my $serialized = $self->_serialize($to_send)."\n";
327 Dlog_trace { my $l = length($serialized); "serialization is completed; sending '$l' characters of serialized data to $_" } $fh;
330 #TODO this should be converted over to a non-blocking ::WriteChannel class
331 die "filehandle is not open" unless openhandle($fh);
332 log_trace { "file handle has passed openhandle() test; printing to it" };
333 $ret = print $fh $serialized;
334 die "print was not successful: $!" unless defined $ret
338 Dlog_debug { "exception encountered when trying to write to file handle $_: $@" } $fh;
341 $self->on_close->done("could not write to file handle: $error") unless $self->on_close->is_ready;
349 my ($self, $data) = @_;
350 local our @New_Ids = (-1);
352 my $flat = $self->_encode($self->_deobjectify($data));
355 my $err = $@; # won't get here if the eval doesn't die
356 # don't keep refs to new things
357 delete @{$self->local_objects_by_id}{@New_Ids};
358 die "Error serializing: $err";
362 sub _local_object_to_id {
363 my ($self, $object) = @_;
364 my $id = refaddr($object);
365 $self->local_objects_by_id->{$id} ||= do {
366 push our(@New_Ids), $id if @New_Ids;
373 my ($self, $data) = @_;
374 if (blessed($data)) {
376 $data->isa('Object::Remote::Proxy')
377 and $data->{remote}->connection == $self
379 return +{ __local_object__ => $data->{remote}->id };
381 return +{ __remote_object__ => $self->_local_object_to_id($data) };
383 } elsif (my $ref = ref($data)) {
384 if ($ref eq 'HASH') {
385 my $tied_to = tied(%$data);
386 if(defined($tied_to)) {
387 return +{__remote_tied_hash__ => $self->_local_object_to_id($tied_to)};
389 return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data };
391 } elsif ($ref eq 'ARRAY') {
392 my $tied_to = tied(@$data);
393 if (defined($tied_to)) {
394 return +{__remote_tied_array__ => $self->_local_object_to_id($tied_to)};
396 return [ map $self->_deobjectify($_), @$data ];
398 } elsif ($ref eq 'CODE') {
399 my $id = $self->_local_object_to_id(
400 Object::Remote::CodeContainer->new(code => $data)
402 return +{ __remote_code__ => $id };
403 } elsif ($ref eq 'SCALAR') {
404 return +{ __scalar_ref__ => $$data };
405 } elsif ($ref eq 'GLOB') {
406 return +{ __glob_ref__ => $self->_local_object_to_id(
407 Object::Remote::GlobContainer->new(handle => $data)
410 die "Can't collapse reftype $ref";
413 return $data; # plain scalar
417 my ($self, $flat) = @_;
418 Dlog_trace { my $l = length($flat); "Starting to deserialize $l characters of data for connection $_" } $self->_id;
419 my ($type, @rest) = eval { @{$self->_deserialize($flat)} }
420 or do { warn "Deserialize failed for ${flat}: $@"; return };
421 Dlog_trace { "deserialization complete for connection $_" } $self->_id;
422 eval { $self->${\"receive_${type}"}(@rest); 1 }
423 or do { warn "Receive failed for ${flat}: $@"; return };
428 my ($self, $id) = @_;
429 Dlog_trace { "got a receive_free for object '$id' for connection $_" } $self->_id;
430 delete $self->local_objects_by_id->{$id}
431 or warn "Free: no such object $id";
436 my ($self, $future_id, $id, @rest) = @_;
437 Dlog_trace { "got a receive_call for object '$id' for connection $_" } $self->_id;
438 my $future = $self->_id_to_remote_object($future_id);
439 $future->{method} = 'call_discard_free';
440 my $local = $self->local_objects_by_id->{$id}
441 or do { $future->fail("No such object $id"); return };
442 $self->_invoke($future, $local, @rest);
445 sub receive_call_free {
446 my ($self, $future, $id, @rest) = @_;
447 Dlog_trace { "got a receive_call_free for object '$id' for connection $_" } $self->_id;
448 $self->receive_call($future, $id, undef, @rest);
449 $self->receive_free($id);
453 my ($self, $future, $local, $ctx, $method, @args) = @_;
454 Dlog_trace { "got _invoke for a method named '$method' for connection $_" } $self->_id;
455 if ($method =~ /^start::/) {
456 my $f = $local->$method(@args);
457 $f->on_done(sub { undef($f); $future->done(@_) });
459 $f->on_fail(sub { undef($f); $future->fail(@_) });
462 my $do = sub { $local->$method(@args) };
466 ? ($ctx ? $do->() : scalar($do->()))
470 } or do { $future->fail($@); return; };
478 Object::Remote::Connection - An underlying connection for L<Object::Remote>
482 Shipping prioritised over writing this part up. Blame mst.