better way to reap child process pids
[scpubgit/Object-Remote.git] / lib / Object / Remote / Connection.pm
index 8e132a6..488794c 100644 (file)
@@ -1,6 +1,6 @@
 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;
@@ -18,34 +18,8 @@ use JSON::PP qw(encode_json);
 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" } };      
+  router()->exclude_forwarding;
+  $SIG{PIPE} = sub { log_debug { "Got a PIPE signal" } };
 }
 
 END {
@@ -55,8 +29,6 @@ END {
   kill(1, -2);
 }
 
-our $DEBUG = !!$ENV{OBJECT_REMOTE_DEBUG};
-
 has _id => ( is => 'ro', required => 1, default => sub { our $NEXT_CONNECTION_ID++ } );
 
 has send_to_fh => (
@@ -73,19 +45,22 @@ has read_channel => (
   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; 
+    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'" }; 
-        $self->on_close->done(@_);
+      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,
+  trigger => sub {
+      log_trace { "Installing handlers into future via trigger" };
+      $_[0]->_install_future_handlers($_[1])
+  },
 );
 
 has child_pid => (is => 'ro');
@@ -111,11 +86,15 @@ has _json => (
 );
 
 after BUILD => sub {
-  my ($self) = @_; 
-  
-  return unless defined $self->child_pid; 
+  my ($self) = @_;
+  my $pid = $self->child_pid;
   
-  log_debug { "Setting process group of child process" };
+  unless (defined $pid) {
+      log_trace { "After BUILD invoked for connection but there was no pid" };
+      return;
+  }
+    
+  log_trace { "Setting process group of child process '$pid'" };
   
   setpgrp($self->child_pid, 1);
 };
@@ -124,7 +103,7 @@ sub BUILD { }
 
 sub _fail_outstanding {
   my ($self, $error) = @_;
-  Dlog_debug { "Failing outstanding futures with '$error' for connection $_" } $self->_id;
+  Dlog_debug { "$$ Failing outstanding futures with '$error' for connection $_" } $self->_id;
   my $outstanding = $self->outstanding_futures;
   $_->fail("$error\n") for values %$outstanding;
   %$outstanding = ();
@@ -133,11 +112,26 @@ sub _fail_outstanding {
 
 sub _install_future_handlers {
     my ($self, $f) = @_;
-    Dlog_trace { "trigger for on_close has been invoked for connection $_" } $self->_id;
+    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'"
+        };
+      }
     });
     return $f; 
 };
@@ -181,15 +175,15 @@ sub _build__json {
     }
   )->filter_json_single_key_object(
     __remote_tied_hash__ => sub {
-        my %tied_hash;
-        tie %tied_hash, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
-        return \%tied_hash;
+      my %tied_hash;
+      tie %tied_hash, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
+      return \%tied_hash;
     }
   )->filter_json_single_key_object(
     __remote_tied_array__ => sub {
-        my @tied_array;
-        tie @tied_array, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
-        return \@tied_array;
+      my @tied_array;
+      tie @tied_array, 'Object::Remote::Tied', $self->_id_to_remote_object(@_);
+      return \@tied_array;
     }
   ); 
 }
@@ -197,7 +191,7 @@ sub _build__json {
 sub _load_if_possible {
   my ($class) = @_; 
 
-  eval "require $class"; 
+  use_module($class); 
 
   if ($@) {
     log_debug { "Attempt at loading '$class' failed with '$@'" };
@@ -342,7 +336,8 @@ sub _send {
     
   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; 
   }
@@ -355,7 +350,6 @@ sub _serialize {
   local our @New_Ids = (-1);
   return eval {
     my $flat = $self->_encode($self->_deobjectify($data));
-    warn "$$ >>> ${flat}\n" if $DEBUG;
     $flat;
   } || do {
     my $err = $@; # won't get here if the eval doesn't die
@@ -421,7 +415,6 @@ sub _deobjectify {
 
 sub _receive {
   my ($self, $flat) = @_;
-  warn "$$ <<< $flat\n" if $DEBUG;
   Dlog_trace { my $l = length($flat); "Starting to deserialize $l characters of data for connection $_" } $self->_id;
   my ($type, @rest) = eval { @{$self->_deserialize($flat)} }
     or do { warn "Deserialize failed for ${flat}: $@"; return };