1 package Object::Remote::Connection;
3 use Object::Remote::Future;
4 use Object::Remote::Null;
5 use Object::Remote::Handle;
6 use Object::Remote::CodeContainer;
7 use Object::Remote::GlobProxy;
8 use Object::Remote::GlobContainer;
9 use Object::Remote::Logging qw (:log :dlog);
13 use Module::Runtime qw(use_module);
14 use Scalar::Util qw(weaken blessed refaddr);
15 use JSON::PP qw(encode_json);
18 our $DEBUG = !!$ENV{OBJECT_REMOTE_DEBUG};
19 #numbering each connection allows it to be
20 #tracked along with file handles in
22 BEGIN { our $NEXT_CONNECTION_ID = 0 }
23 has _id => ( is => 'ro', required => 1, default => sub { our $NEXT_CONNECTION_ID++ } );
26 is => 'ro', required => 1,
30 Dlog_trace { my $id = $self->_id; "connection had send_to_fh set to $_" } $_[1];
35 is => 'ro', required => 1,
38 Dlog_trace { my $id = $self->_id; "trigger for read_channel has been invoked for connection $id; file handle is " } $ch->fh;
40 $ch->on_line_call(sub { $self->_receive(@_) });
41 $ch->on_close_call(sub { $self->on_close->done(@_) });
46 is => 'ro', default => sub { CPS::Future->new },
49 Dlog_trace { "trigger for on_close has been invoked for connection $_" } $self->_id;
52 $self->_fail_outstanding("Connection lost: ".($f->get)[0]);
57 has child_pid => (is => 'ro');
59 has local_objects_by_id => (
60 is => 'ro', default => sub { {} },
61 coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
64 has remote_objects_by_id => (
65 is => 'ro', default => sub { {} },
66 coerce => sub { +{ %{$_[0]} } }, # shallow clone on the way in
69 has outstanding_futures => (is => 'ro', default => sub { {} });
71 sub _fail_outstanding {
72 my ($self, $error) = @_;
73 Dlog_debug { "Failing outstanding futures with '$error' for connection $_" } $self->_id;
74 my $outstanding = $self->outstanding_futures;
75 $_->fail($error) for values %$outstanding;
83 _deserialize => 'decode',
88 sub _id_to_remote_object {
90 Dlog_trace { "fetching proxy for remote object with id '$id' for connection $_" } $self->_id;
91 return bless({}, 'Object::Remote::Null') if $id eq 'NULL';
93 $self->remote_objects_by_id->{$id}
94 or Object::Remote::Handle->new(connection => $self, id => $id)
99 weaken(my $self = shift);
100 JSON::PP->new->filter_json_single_key_object(
101 __remote_object__ => sub {
102 $self->_id_to_remote_object(@_);
104 )->filter_json_single_key_object(
105 __remote_code__ => sub {
106 my $code_container = $self->_id_to_remote_object(@_);
107 sub { $code_container->call(@_) };
109 )->filter_json_single_key_object(
110 __scalar_ref__ => sub {
114 )->filter_json_single_key_object(
115 __glob_ref__ => sub {
116 my $glob_container = $self->_id_to_remote_object(@_);
117 my $handle = Symbol::gensym;
118 tie *$handle, 'Object::Remote::GlobProxy', $glob_container;
125 unshift our @Guess, sub { blessed($_[0]) ? $_[0] : undef };
126 eval { require Object::Remote::Connector::Local };
127 eval { require Object::Remote::Connector::LocalSudo };
128 eval { require Object::Remote::Connector::SSH };
129 eval { require Object::Remote::Connector::UNIX };
133 my ($class, $spec) = @_;
134 return $spec if blessed $spec;
135 Dlog_debug { "creating a new connection from spec" };
136 foreach my $poss (do { our @Guess }) {
137 if (my $conn = $poss->($spec)) {
138 #Dlog_debug { my $id = $conn->_id; "created connection $id for spec $_" } $spec;
139 return $conn->maybe::start::connect;
142 die "Couldn't figure out what to do with ${spec}";
146 my ($self, @args) = @_;
147 Object::Remote::Handle->new(
148 connection => $self, @args
153 my ($self, $to) = @_;
154 Dlog_debug { "Creating connection to remote node '$to' for connection $_" } $self->_id;
156 $self->send_class_call(0, 'Object::Remote', connect => $to)
161 my ($self, $sub) = @_;
162 my ($pkg, $name) = $sub =~ m/^(.*)::([^:]+)$/;
163 Dlog_debug { "Invoking remote sub '$sub' for connection $_" } $self->_id;
164 return await_future($self->send_class_call(0, $pkg, can => $name));
167 sub send_class_call {
168 my ($self, $ctx, @call) = @_;
169 Dlog_trace { "Sending a class call for connection $_" } $self->_id;
170 $self->send(call => class_call_handler => $ctx => call => @call);
173 sub register_class_call_handler {
175 $self->local_objects_by_id->{'class_call_handler'} ||= do {
176 my $o = $self->new_class_call_handler;
177 $self->_local_object_to_id($o);
182 sub new_class_call_handler {
183 Object::Remote::CodeContainer->new(
185 my ($class, $method) = (shift, shift);
186 use_module($class)->$method(@_);
191 sub register_remote {
192 my ($self, $remote) = @_;
193 Dlog_trace { my $i = $remote->id; "Registered a remote object with id of '$i' for connection $_" } $self->_id;
194 weaken($self->remote_objects_by_id->{$remote->id} = $remote);
199 my ($self, $id) = @_;
200 Dlog_debug { "sending request to free object '$id' for connection $_" } $self->_id;
201 delete $self->remote_objects_by_id->{$id};
202 $self->_send([ free => $id ]);
206 my ($self, $type, @call) = @_;
208 my $future = CPS::Future->new;
209 my $remote = $self->remote_objects_by_id->{$call[0]};
211 unshift @call, $type => $self->_local_object_to_id($future);
213 my $outstanding = $self->outstanding_futures;
214 $outstanding->{$future} = $future;
215 $future->on_ready(sub {
217 delete $outstanding->{$future}
220 $self->_send(\@call);
226 my ($self, $type, @call) = @_;
228 unshift @call, $type => 'NULL';
230 $self->_send(\@call);
234 my ($self, $to_send) = @_;
235 my $fh = $self->send_to_fh;
236 Dlog_trace { "Starting to serialize data in argument to _send for connection $_" } $self->_id;
237 my $serialized = $self->_serialize($to_send)."\n";
238 Dlog_trace { my $l = length($serialized); "serialization is completed; sending '$l' characters of serialized data to $_" } $fh;
239 #TODO this is very risky for deadlocks unless it's set to non-blocking and then with out extra
240 #logic it could easily do short-writes to the remote side
241 my $ret = print $fh $serialized;
242 Dlog_trace { my $r = defined $ret ? $ret : 'undef'; "print() returned $r with $_" } $fh;
243 #TODO hrm reason print's return value was ignored?
244 die "could not write to filehandle: $!" unless $ret;
249 my ($self, $data) = @_;
250 local our @New_Ids = (-1);
252 my $flat = $self->_encode($self->_deobjectify($data));
253 warn "$$ >>> ${flat}\n" if $DEBUG;
256 my $err = $@; # won't get here if the eval doesn't die
257 # don't keep refs to new things
258 delete @{$self->local_objects_by_id}{@New_Ids};
259 die "Error serializing: $err";
263 sub _local_object_to_id {
264 my ($self, $object) = @_;
265 my $id = refaddr($object);
266 $self->local_objects_by_id->{$id} ||= do {
267 push our(@New_Ids), $id if @New_Ids;
274 my ($self, $data) = @_;
275 if (blessed($data)) {
276 return +{ __remote_object__ => $self->_local_object_to_id($data) };
277 } elsif (my $ref = ref($data)) {
278 if ($ref eq 'HASH') {
279 return +{ map +($_ => $self->_deobjectify($data->{$_})), keys %$data };
280 } elsif ($ref eq 'ARRAY') {
281 return [ map $self->_deobjectify($_), @$data ];
282 } elsif ($ref eq 'CODE') {
283 my $id = $self->_local_object_to_id(
284 Object::Remote::CodeContainer->new(code => $data)
286 return +{ __remote_code__ => $id };
287 } elsif ($ref eq 'SCALAR') {
288 return +{ __scalar_ref__ => $$data };
289 } elsif ($ref eq 'GLOB') {
290 return +{ __glob_ref__ => $self->_local_object_to_id(
291 Object::Remote::GlobContainer->new(handle => $data)
294 die "Can't collapse reftype $ref";
297 return $data; # plain scalar
301 my ($self, $flat) = @_;
302 warn "$$ <<< $flat\n" if $DEBUG;
303 Dlog_trace { my $l = length($flat); "Starting to deserialize $l characters of data for connection $_" } $self->_id;
304 my ($type, @rest) = eval { @{$self->_deserialize($flat)} }
305 or do { warn "Deserialize failed for ${flat}: $@"; return };
306 Dlog_trace { "deserialization complete for connection $_" } $self->_id;
307 eval { $self->${\"receive_${type}"}(@rest); 1 }
308 or do { warn "Receive failed for ${flat}: $@"; return };
313 my ($self, $id) = @_;
314 Dlog_trace { "got a receive_free for object '$id' for connection $_" } $self->_id;
315 delete $self->local_objects_by_id->{$id}
316 or warn "Free: no such object $id";
321 my ($self, $future_id, $id, @rest) = @_;
322 Dlog_trace { "got a receive_call for object '$id' for connection $_" } $self->_id;
323 my $future = $self->_id_to_remote_object($future_id);
324 $future->{method} = 'call_discard_free';
325 my $local = $self->local_objects_by_id->{$id}
326 or do { $future->fail("No such object $id"); return };
327 $self->_invoke($future, $local, @rest);
330 sub receive_call_free {
331 my ($self, $future, $id, @rest) = @_;
332 Dlog_trace { "got a receive_call_free for object '$id' for connection $_" } $self->_id;
333 $self->receive_call($future, $id, undef, @rest);
334 $self->receive_free($id);
338 my ($self, $future, $local, $ctx, $method, @args) = @_;
339 Dlog_trace { "got _invoke for a method named '$method' for connection $_" } $self->_id;
340 if ($method =~ /^start::/) {
341 my $f = $local->$method(@args);
342 $f->on_done(sub { undef($f); $future->done(@_) });
344 $f->on_fail(sub { undef($f); $future->fail(@_) });
347 my $do = sub { $local->$method(@args) };
351 ? ($ctx ? $do->() : scalar($do->()))
355 } or do { $future->fail($@); return; };
363 Object::Remote::Connection - An underlying connection for L<Object::Remote>
367 Shipping prioritised over writing this part up. Blame mst.