package Object::Remote::Connection;
-use Object::Remote::Logging qw (:log :dlog);
+use Object::Remote::Logging qw (:log :dlog router);
use Object::Remote::Future;
use Object::Remote::Null;
use Object::Remote::Handle;
use Module::Runtime qw(use_module);
use Scalar::Util qw(weaken blessed refaddr openhandle);
use JSON::PP qw(encode_json);
+use Future;
+use Carp qw(croak);
use Moo;
-BEGIN {
- #this will reap child processes as soon
- #as they are done executing so the process
- #table cleans up as fast as possible but
- #anything that needs to call waitpid()
- #in the future to get the exit value of
- #a child will get trash results if
- #the signal handler was running.
- #If creating a child and getting the
- #exit value is required then set
- #a localized version of the signal
- #handler for CHLD to be 'IGNORE'
- #in the smallest block possible
- #and outside the block send
- #the process a CHLD signal
- #to reap anything that may
- #have exited while blocked
- #in waitpid()
- $SIG{CHLD} = sub {
- my $kid;
- log_trace { "CHLD signal handler is executing" };
- do {
- $kid = waitpid(-1, WNOHANG);
- log_debug { "waitpid() returned '$kid'" };
- } while $kid > 0;
- log_trace { "CHLD signal handler is done" };
- };
-
- $SIG{PIPE} = sub { log_debug { "Got a PIPE signal" } };
-}
+BEGIN { router()->exclude_forwarding }
END {
- log_debug { "Killing all child processes in the process group" };
-
- #send SIGINT to the process group for our children
- kill(1, -2);
+ our %child_pids;
+
+ log_trace { "END handler is being invoked in " . __PACKAGE__ };
+
+ foreach(keys(%child_pids)) {
+ log_debug { "Killing child process '$_'" };
+ kill('TERM', $_);
+ }
}
has _id => ( is => 'ro', required => 1, default => sub { our $NEXT_CONNECTION_ID++ } );
has send_to_fh => (
is => 'ro', required => 1,
trigger => sub {
- my $self = $_[0];
- $_[1]->autoflush(1);
- Dlog_trace { my $id = $self->_id; "connection had send_to_fh set to $_" } $_[1];
+ my $self = $_[0];
+ $_[1]->autoflush(1);
+ Dlog_trace { my $id = $self->_id; "connection had send_to_fh set to $_" } $_[1];
},
);
is => 'ro', required => 1,
trigger => sub {
my ($self, $ch) = @_;
- my $id = $self->_id;
- Dlog_trace { "trigger for read_channel has been invoked for connection $id; file handle is $_" } $ch->fh;
+ my $id = $self->_id;
+ Dlog_trace { "trigger for read_channel has been invoked for connection $id; file handle is $_" } $ch->fh;
weaken($self);
$ch->on_line_call(sub { $self->_receive(@_) });
- $ch->on_close_call(sub {
- log_trace { "invoking 'done' on on_close handler for connection id '$id'" };
+ $ch->on_close_call(sub {
+ log_trace { "invoking 'done' on on_close handler for connection id '$id'" };
$self->on_close->done(@_);
});
},
);
has on_close => (
- is => 'rw', default => sub { $_[0]->_install_future_handlers(CPS::Future->new) },
- trigger => \&_install_future_handlers,
+ is => 'rw', default => sub { $_[0]->_install_future_handlers(Future->new) },
+ trigger => sub {
+ log_trace { "Installing handlers into future via trigger" };
+ $_[0]->_install_future_handlers($_[1])
+ },
);
has child_pid => (is => 'ro');
);
after BUILD => sub {
- my ($self) = @_;
-
- return unless defined $self->child_pid;
-
- log_debug { "Setting process group of child process" };
-
- setpgrp($self->child_pid, 1);
+ my ($self) = @_;
+ my $pid = $self->child_pid;
+ our %child_pids;
+ return unless defined $pid;
+ $child_pids{$pid} = 1;
+ return;
};
sub BUILD { }
+sub is_valid {
+ my ($self) = @_;
+ my $valid = ! $self->on_close->is_ready;
+
+ log_trace {
+ my $id = $self->_id;
+ my $text;
+ if ($valid) {
+ $text = 'yes';
+ } else {
+ $text = 'no';
+ }
+ "Connection '$id' is valid: '$text'"
+ };
+
+ return $valid;
+}
+
sub _fail_outstanding {
my ($self, $error) = @_;
- Dlog_debug { "Failing outstanding futures with '$error' for connection $_" } $self->_id;
my $outstanding = $self->outstanding_futures;
- $_->fail("$error\n") for values %$outstanding;
+
+ Dlog_debug {
+ sprintf "Failing %i outstanding futures with '$error'", scalar(keys(%$outstanding))
+ };
+
+ foreach(keys(%$outstanding)) {
+ log_trace { "Failing future for $_" };
+ my $future = $outstanding->{$_};
+ $future->fail("$error\n");
+ }
+
%$outstanding = ();
return;
}
sub _install_future_handlers {
my ($self, $f) = @_;
- Dlog_trace { "trigger for on_close has been invoked for connection $_" } $self->_id;
+ our %child_pids;
+ Dlog_trace { "Installing handlers into future for connection $_" } $self->_id;
weaken($self);
$f->on_done(sub {
- Dlog_trace { "failing all of the outstanding futures for connection $_" } $self->_id;
+ my $pid = $self->child_pid;
+ Dlog_trace { "Executing on_done handler in future for connection $_" } $self->_id;
$self->_fail_outstanding("Object::Remote connection lost: " . ($f->get)[0]);
+ return unless defined $pid;
+ log_debug { "Waiting for child '$pid' to exit" };
+ my $ret = waitpid($pid, 0);
+ if ($ret != $pid) {
+ log_debug { "Waited for pid $pid but waitpid() returned $ret" };
+ return;
+ } elsif ($? & 127) {
+ log_warn { "Remote interpreter did not exit cleanly" };
+ } else {
+ log_verbose {
+ my $exit_value = $? >> 8;
+ "Remote Perl interpreter exited with value '$exit_value'"
+ };
+ }
+
+ delete $child_pids{$pid};
});
- return $f;
+ return $f;
};
sub _id_to_remote_object {
tie @tied_array, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
return \@tied_array;
}
- );
+ );
}
sub _load_if_possible {
- my ($class) = @_;
+ my ($class) = @_;
- use_module($class);
+ use_module($class);
if ($@) {
log_debug { "Attempt at loading '$class' failed with '$@'" };
Object::Remote::Connector::LocalSudo
Object::Remote::Connector::SSH
Object::Remote::Connector::UNIX
- );
+ Object::Remote::Connector::INET
+ );
}
sub conn_from_spec {
return $conn;
}
}
-
+
return undef;
}
sub new_from_spec {
- my ($class, $spec) = @_;
+ my ($class, $spec, @args) = @_;
return $spec if blessed $spec;
- my $conn = $class->conn_from_spec($spec);
-
+ my $conn = $class->conn_from_spec($spec, @args);
+
die "Couldn't figure out what to do with ${spec}"
unless defined $conn;
-
- return $conn->maybe::start::connect;
+
+ return $conn->maybe::start::connect;
}
sub remote_object {
sub remote_sub {
my ($self, $sub) = @_;
my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/;
- Dlog_debug { "Invoking remote sub '$sub' for connection $_" } $self->_id;
+ Dlog_debug { "Invoking remote sub '$sub' for connection '$_'" } $self->_id;
return await_future($self->send_class_call(0, $pkg, can => $name));
}
sub send_free {
my ($self, $id) = @_;
Dlog_trace { "sending request to free object '$id' for connection $_" } $self->_id;
+ #TODO this shows up some times when a remote side dies in the middle of a remote
+ #method invocation - possibly only when the object is being constructed?
+ #(in cleanup) Use of uninitialized value $id in delete at ../Object-Remote/lib/Object/Remote/Connection.
delete $self->remote_objects_by_id->{$id};
$self->_send([ free => $id ]);
}
sub send {
my ($self, $type, @call) = @_;
- my $future = CPS::Future->new;
+ my $future = Future->new;
my $remote = $self->remote_objects_by_id->{$call[0]};
unshift @call, $type => $self->_local_object_to_id($future);
sub _send {
my ($self, $to_send) = @_;
my $fh = $self->send_to_fh;
+
+ unless ($self->is_valid) {
+ croak "Attempt to invoke _send on a connection that is not valid";
+ }
+
Dlog_trace { "Starting to serialize data in argument to _send for connection $_" } $self->_id;
my $serialized = $self->_serialize($to_send)."\n";
Dlog_trace { my $l = length($serialized); "serialization is completed; sending '$l' characters of serialized data to $_" } $fh;
- my $ret;
- eval {
+ my $ret;
+ eval {
#TODO this should be converted over to a non-blocking ::WriteChannel class
die "filehandle is not open" unless openhandle($fh);
log_trace { "file handle has passed openhandle() test; printing to it" };
$ret = print $fh $serialized;
die "print was not successful: $!" unless defined $ret
};
-
+
if ($@) {
Dlog_debug { "exception encountered when trying to write to file handle $_: $@" } $fh;
- my $error = $@; chomp($error);
+ my $error = $@;
+ chomp($error);
$self->on_close->done("could not write to file handle: $error") unless $self->on_close->is_ready;
- return;
+ return;
}
-
- return $ret;
+
+ return $ret;
}
sub _serialize {
if ($ref eq 'HASH') {
my $tied_to = tied(%$data);
if(defined($tied_to)) {
- return +{__remote_tied_hash__ => $self->_local_object_to_id($tied_to)};
+ return +{__remote_tied_hash__ => $self->_local_object_to_id($tied_to)};
} else {
return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data };
}
} elsif ($ref eq 'ARRAY') {
my $tied_to = tied(@$data);
if (defined($tied_to)) {
- return +{__remote_tied_array__ => $self->_local_object_to_id($tied_to)};
+ return +{__remote_tied_array__ => $self->_local_object_to_id($tied_to)};
} else {
return [ map $self->_deobjectify($_), @$data ];
}
Object::Remote::Connection - An underlying connection for L<Object::Remote>
-=head1 LAME
+ use Object::Remote;
+
+ my $local = Object::Remote->connect('-');
+ my $remote = Object::Remote->connect('myserver');
+ my $remote_user = Object::Remote->connect('user@myserver');
+ my $local_sudo = Object::Remote->connect('user@');
+
+ #$remote can be any other connection object
+ my $hostname = Sys::Hostname->can::on($remote, 'hostname');
+
+=head1 DESCRIPTION
+
+This is the class that supports connections to remote objects.
+
+=head1 SEE ALSO
+
+=over 4
+
+=item C<Object::Remote::Role::Connector::PerlInterpreter>
+
+=item C<Object::Remote>
-Shipping prioritised over writing this part up. Blame mst.
+=back
=cut
projects / scpubgit/Object-Remote.git / blobdiff