lib/Object/Remote/Role/Connector/PerlInterpreter.pm

   1 package Object::Remote::Role::Connector::PerlInterpreter;
   2
   3 use IPC::Open2;
   4 use IPC::Open3;
   5 use IO::Handle;
   6 use Object::Remote::ModuleSender;
   7 use Object::Remote::Handle;
   8 use Object::Remote::Future;
   9 use Object::Remote::Logging qw( :log :dlog );
  10 use Scalar::Util qw(blessed);
  11 use POSIX ":sys_wait_h";
  12 use Moo::Role;
  13
  14 with 'Object::Remote::Role::Connector';
  15
  16 BEGIN {
  17   $SIG{CHLD} = sub {
  18     my $kid;
  19     do {
  20       $kid = waitpid(-1, WNOHANG);
  21     } while $kid > 0;
  22   }
  23 }
  24
  25 has module_sender => (is => 'lazy');
  26 #if no child_stderr file handle is specified then stderr
  27 #of the child will be connected to stderr of the parent
  28 has stderr => ( is => 'rw', default => sub { \*STDERR } );
  29
  30 sub _build_module_sender {
  31   my ($hook) =
  32     grep {blessed($_) && $_->isa('Object::Remote::ModuleLoader::Hook') }
  33       @INC;
  34   return $hook ? $hook->sender : Object::Remote::ModuleSender->new;
  35 }
  36
  37 has perl_command => (is => 'lazy');
  38
  39 #TODO convert nice value into optional feature enabled by
  40 #setting value of attribute
  41 #ulimit of ~500 megs of v-ram
  42 #TODO only works with ssh with quotes but only works locally
  43 #with out quotes
  44 #sub _build_perl_command { [ 'sh', '-c', '"ulimit -v 80000; nice -n 15 perl -"' ] }
  45 sub _build_perl_command { [ 'sh', '-c', '"ulimit -v 200000; nice -n 15 perl -"' ] }
  46 #sub _build_perl_command { [ 'perl', '-' ] }
  47
  48 around connect => sub {
  49   my ($orig, $self) = (shift, shift);
  50   my $f = $self->$start::start($orig => @_);
  51   return future {
  52     $f->on_done(sub {
  53       my ($conn) = $f->get;
  54       my $sub = $conn->remote_sub('Object::Remote::Logging::init_logging_forwarding');
  55       $sub->('Object::Remote::Logging', Object::Remote::Logging->arg_router);
  56       Object::Remote::Handle->new(
  57         connection => $conn,
  58         class => 'Object::Remote::ModuleLoader',
  59         args => { module_sender => $self->module_sender }
  60       )->disarm_free;
  61       require Object::Remote::Prompt;
  62       Object::Remote::Prompt::maybe_set_prompt_command_on($conn);
  63     });
  64     $f;
  65   } 2;
  66 };
  67
  68 sub final_perl_command { shift->perl_command }
  69
  70 sub _start_perl {
  71   my $self = shift;
  72   my $given_stderr = $self->stderr;
  73   my $foreign_stderr;
  74
  75   Dlog_debug { "invoking connection to perl interpreter using command line: $_" } @{$self->final_perl_command};
  76
  77   use Symbol;
  78
  79   if (defined($given_stderr)) {
  80       $foreign_stderr = gensym();
  81   } else {
  82       $foreign_stderr = ">&STDERR";
  83   }
  84
  85   my $pid = open3(
  86     my $foreign_stdin,
  87     my $foreign_stdout,
  88     $foreign_stderr,
  89     @{$self->final_perl_command},
  90   ) or die "Failed to run perl at '$_[0]': $!";
  91
  92   if (defined($given_stderr)) {
  93       log_warn { "using experimental cat for child stderr" };
  94
  95       #TODO refactor if this solves the problem
  96       Object::Remote->current_loop
  97                     ->watch_io(
  98                         handle => $foreign_stderr,
  99                         on_read_ready => sub {
 100                           my $buf = '';
 101                           my $len = sysread($foreign_stderr, $buf, 32768);
 102                           if (!defined($len) or $len == 0) {
 103                             log_trace { "Got EOF or error on child stderr, removing from watcher" };
 104                             $self->stderr(undef);
 105                             Object::Remote->current_loop
 106                                           ->unwatch_io(
 107                                               handle => $foreign_stderr,
 108                                               on_read_ready => 1
 109                                             );
 110                           } else {
 111                               Dlog_trace { "got $len characters of stderr data for connection" };
 112                               print $given_stderr $buf or die "could not send stderr data: $!";
 113                           }
 114                          }
 115                       );
 116   }
 117
 118   #TODO open2() dupes the child stderr into the calling
 119   #process stderr which means if this process exits the
 120   #child is still attached to the shell - using open3()
 121   #and having the run loop manage the stderr means this
 122   #won't happen BUT if the run loop just sends the remote
 123   #stderr data to the local stderr the logs will interleave
 124   #for sure - a simple test would be to use open3() and just
 125   #close the remote stderr and see what happens - a longer
 126   #term solution would be for Object::Remote to offer a feature
 127   #where the user of a connection species a destination for output
 128   #either a file name or their own file handle and the node output
 129   #is dumped to it
 130 #  my $pid = open2(
 131 #    my $foreign_stdout,
 132 #    my $foreign_stdin,
 133 #    @{$self->final_perl_command},
 134 #  ) or die "Failed to run perl at '$_[0]': $!";
 135
 136   Dlog_trace { "Connection to remote side successful; remote stdin and stdout: $_" } [ $foreign_stdin, $foreign_stdout ];
 137   return ($foreign_stdin, $foreign_stdout, $pid);
 138 }
 139
 140 #TODO open2() forks off a child and I have not been able to locate
 141 #a mechanism for reaping dead children so they don't become zombies
 142 #CONFIRMED there is no reaping of children being done, find a safe
 143 #way to do it
 144 sub _open2_for {
 145   my $self = shift;
 146   my ($foreign_stdin, $foreign_stdout, $pid) = $self->_start_perl(@_);
 147   my $to_send = $self->fatnode_text;
 148   log_debug { my $len = length($to_send); "Sending contents of fat node to remote node; size is '$len' characters"  };
 149   Object::Remote->current_loop
 150                 ->watch_io(
 151                     handle => $foreign_stdin,
 152                     on_write_ready => sub {
 153                       my $len = syswrite($foreign_stdin, $to_send, 32768);
 154                       if (defined $len) {
 155                         substr($to_send, 0, $len) = '';
 156                       }
 157                       # if the stdin went away, we'll never get Shere
 158                       # so it's not a big deal to simply give up on !defined
 159                       if (!defined($len) or 0 == length($to_send)) {
 160                         log_trace { "Got EOF or error when writing fatnode data to filehandle, unwatching it" };
 161                         Object::Remote->current_loop
 162                                       ->unwatch_io(
 163                                           handle => $foreign_stdin,
 164                                           on_write_ready => 1
 165                                         );
 166                       } else {
 167                           log_trace { "Sent $len bytes of fatnode data to remote side" };
 168                       }
 169                     }
 170                   );
 171   return ($foreign_stdin, $foreign_stdout, $pid);
 172 }
 173
 174 sub fatnode_text {
 175   my ($self) = @_;
 176   require Object::Remote::FatNode;
 177   my $text = '';
 178   $text .= 'BEGIN { $ENV{OBJECT_REMOTE_DEBUG} = 1 }'."\n"
 179     if $ENV{OBJECT_REMOTE_DEBUG};
 180   $text .= <<'END';
 181 $INC{'Object/Remote/FatNode.pm'} = __FILE__;
 182 $Object::Remote::FatNode::DATA = <<'ENDFAT';
 183 END
 184   $text .= do { no warnings 'once'; $Object::Remote::FatNode::DATA };
 185   $text .= "ENDFAT\n";
 186   $text .= <<'END';
 187 eval $Object::Remote::FatNode::DATA;
 188 die $@ if $@;
 189 END
 190   $text .= "__END__\n";
 191   return $text;
 192 }
 193
 194 1;