replaced entire logging subsystem with one that is fully operational with the followi...
[scpubgit/Object-Remote.git] / lib / Object / Remote / Role / Connector / PerlInterpreter.pm
CommitLineData
a9fdb55e 1package Object::Remote::Role::Connector::PerlInterpreter;
2
6b7b2732 3use IPC::Open2;
90115979 4use IPC::Open3;
4c8c83d7 5use IO::Handle;
353556c4 6use Symbol;
4e446335 7use Object::Remote::Logging qw( :log :dlog get_router );
a9fdb55e 8use Object::Remote::ModuleSender;
9use Object::Remote::Handle;
fbd3b8ec 10use Object::Remote::Future;
c824fdf3 11use Scalar::Util qw(blessed weaken);
a9fdb55e 12use Moo::Role;
13
14with 'Object::Remote::Role::Connector';
15
03f41c0e 16has module_sender => (is => 'lazy');
37efeb68 17has ulimit => ( is => 'ro' );
18has nice => ( is => 'ro' );
f129bfaf 19has watchdog_timeout => ( is => 'ro', required => 1, default => sub { undef } );
20has perl_command => (is => 'lazy');
c824fdf3 21
6b7b2732 22#if no child_stderr file handle is specified then stderr
23#of the child will be connected to stderr of the parent
c824fdf3 24has stderr => ( is => 'rw', default => sub { undef } );
03f41c0e 25
26sub _build_module_sender {
18e789ab 27 my ($hook) =
28 grep {blessed($_) && $_->isa('Object::Remote::ModuleLoader::Hook') }
29 @INC;
03f41c0e 30 return $hook ? $hook->sender : Object::Remote::ModuleSender->new;
31}
32
37efeb68 33sub _build_perl_command {
34 my ($self) = @_;
35 my $nice = $self->nice;
8506bc08 36 my $ulimit = $self->ulimit;
37 my $shell_code = '';
37efeb68 38
39 if (defined($ulimit)) {
40 $shell_code .= "ulimit -v $ulimit; ";
41 }
42
43 if (defined($nice)) {
44 $shell_code .= "nice -n $nice ";
45 }
46
8506bc08 47 $shell_code .= 'perl -';
48
49 return [ 'sh', '-c', $shell_code ];
37efeb68 50}
498c4ad5 51
03f41c0e 52around connect => sub {
53 my ($orig, $self) = (shift, shift);
fbd3b8ec 54 my $f = $self->$start::start($orig => @_);
55 return future {
56 $f->on_done(sub {
57 my ($conn) = $f->get;
c824fdf3 58 $self->_setup_watchdog_reset($conn);
4a9fa1a5 59 my $sub = $conn->remote_sub('Object::Remote::Logging::init_logging_forwarding');
4e446335 60 $sub->('Object::Remote::Logging', router => get_router, connection_id => $conn->_id);
fbd3b8ec 61 Object::Remote::Handle->new(
62 connection => $conn,
63 class => 'Object::Remote::ModuleLoader',
64 args => { module_sender => $self->module_sender }
65 )->disarm_free;
66 require Object::Remote::Prompt;
67 Object::Remote::Prompt::maybe_set_prompt_command_on($conn);
68 });
69 $f;
70 } 2;
a9fdb55e 71};
72
498c4ad5 73sub final_perl_command { shift->perl_command }
a9fdb55e 74
7efea51f 75sub _start_perl {
a9fdb55e 76 my $self = shift;
6b7b2732 77 my $given_stderr = $self->stderr;
78 my $foreign_stderr;
79
9031635d 80 Dlog_debug { "invoking connection to perl interpreter using command line: $_" } @{$self->final_perl_command};
f8080c1c 81
6b7b2732 82 if (defined($given_stderr)) {
09130cd0 83 #if the stderr data goes to an existing file handle
84 #an anonymous file handle is required
85 #as the other half of a pipe style file handle pair
86 #so the file handles can go into the run loop
87 $foreign_stderr = gensym();
6b7b2732 88 } else {
09130cd0 89 #if no file handle has been specified
90 #for the child's stderr then connect
91 #the child stderr to the parent stderr
92 $foreign_stderr = ">&STDERR";
6b7b2732 93 }
94
95 my $pid = open3(
96 my $foreign_stdin,
97 my $foreign_stdout,
98 $foreign_stderr,
99 @{$self->final_perl_command},
100 ) or die "Failed to run perl at '$_[0]': $!";
101
102 if (defined($given_stderr)) {
09130cd0 103 Dlog_debug { "Child process STDERR is being handled via run loop" };
6b7b2732 104
09130cd0 105 Object::Remote->current_loop
106 ->watch_io(
107 handle => $foreign_stderr,
108 on_read_ready => sub {
109 my $buf = '';
110 my $len = sysread($foreign_stderr, $buf, 32768);
111 if (!defined($len) or $len == 0) {
112 log_trace { "Got EOF or error on child stderr, removing from watcher" };
113 $self->stderr(undef);
114 Object::Remote->current_loop->unwatch_io(
115 handle => $foreign_stderr,
116 on_read_ready => 1
117 );
6b7b2732 118 } else {
09130cd0 119 Dlog_trace { "got $len characters of stderr data for connection" };
120 print $given_stderr $buf or die "could not send stderr data: $!";
6b7b2732 121 }
7790ca36 122 }
6b7b2732 123 );
124 }
125
c824fdf3 126 return ($foreign_stdin, $foreign_stdout, $pid);
7efea51f 127}
128
129sub _open2_for {
130 my $self = shift;
131 my ($foreign_stdin, $foreign_stdout, $pid) = $self->_start_perl(@_);
fbd3b8ec 132 my $to_send = $self->fatnode_text;
5d59cb98 133 log_debug { my $len = length($to_send); "Sending contents of fat node to remote node; size is '$len' characters" };
fbd3b8ec 134 Object::Remote->current_loop
135 ->watch_io(
136 handle => $foreign_stdin,
137 on_write_ready => sub {
9031635d 138 my $len = syswrite($foreign_stdin, $to_send, 32768);
fbd3b8ec 139 if (defined $len) {
140 substr($to_send, 0, $len) = '';
141 }
142 # if the stdin went away, we'll never get Shere
143 # so it's not a big deal to simply give up on !defined
353556c4 144 if (!defined($len) or 0 == length($to_send)) {
5d59cb98 145 log_trace { "Got EOF or error when writing fatnode data to filehandle, unwatching it" };
fbd3b8ec 146 Object::Remote->current_loop
147 ->unwatch_io(
148 handle => $foreign_stdin,
149 on_write_ready => 1
09130cd0 150 );
5d59cb98 151 } else {
152 log_trace { "Sent $len bytes of fatnode data to remote side" };
fbd3b8ec 153 }
154 }
155 );
a9fdb55e 156 return ($foreign_stdin, $foreign_stdout, $pid);
157}
158
c824fdf3 159sub _setup_watchdog_reset {
09130cd0 160 my ($self, $conn) = @_;
161 my $timer_id;
c824fdf3 162
09130cd0 163 return unless $self->watchdog_timeout;
c824fdf3 164
09130cd0 165 Dlog_trace { "Creating Watchdog management timer for connection id $_" } $conn->_id;
b7a853b3 166
09130cd0 167 weaken($conn);
b7a853b3 168
09130cd0 169 $timer_id = Object::Remote->current_loop->watch_time(
170 every => $self->watchdog_timeout / 3,
171 code => sub {
172 unless(defined($conn)) {
173 log_trace { "Weak reference to connection in Watchdog was lost, terminating update timer $timer_id" };
174 Object::Remote->current_loop->unwatch_time($timer_id);
175 return;
176 }
c824fdf3 177
09130cd0 178 Dlog_trace { "Reseting Watchdog for connection id $_" } $conn->_id;
179 #we do not want to block in the run loop so send the
180 #update off and ignore any result, we don't need it
181 #anyway
182 $conn->send_class_call(0, 'Object::Remote::WatchDog', 'reset');
183 }
184 );
c824fdf3 185}
186
b1cbd5be 187sub fatnode_text {
188 my ($self) = @_;
b1cbd5be 189 my $text = '';
c824fdf3 190
191 require Object::Remote::FatNode;
192
b7a853b3 193 if (defined($self->watchdog_timeout)) {
194 $text = "my \$WATCHDOG_TIMEOUT = '" . $self->watchdog_timeout . "';\n";
c824fdf3 195 $text .= "alarm(\$WATCHDOG_TIMEOUT);\n";
b7a853b3 196 } else {
09130cd0 197 $text = "my \$WATCHDOG_TIMEOUT = undef;\n";
c824fdf3 198 }
b7a853b3 199
b1cbd5be 200 $text .= <<'END';
201$INC{'Object/Remote/FatNode.pm'} = __FILE__;
202$Object::Remote::FatNode::DATA = <<'ENDFAT';
203END
fbd3b8ec 204 $text .= do { no warnings 'once'; $Object::Remote::FatNode::DATA };
b1cbd5be 205 $text .= "ENDFAT\n";
206 $text .= <<'END';
207eval $Object::Remote::FatNode::DATA;
1a2d795f 208die $@ if $@;
b1cbd5be 209END
c824fdf3 210
b1cbd5be 211 $text .= "__END__\n";
212 return $text;
213}
214
a9fdb55e 2151;