… | |
… | |
27 | This module (-family) implements a simple message passing framework. |
27 | This module (-family) implements a simple message passing framework. |
28 | |
28 | |
29 | Despite its simplicity, you can securely message other processes running |
29 | Despite its simplicity, you can securely message other processes running |
30 | on the same or other hosts. |
30 | on the same or other hosts. |
31 | |
31 | |
|
|
32 | At the moment, this module family is severly brokena nd underdocumented, |
|
|
33 | so do not use. This was uploaded mainly to resreve the CPAN namespace - |
|
|
34 | stay tuned! |
|
|
35 | |
32 | =head1 CONCEPTS |
36 | =head1 CONCEPTS |
33 | |
37 | |
34 | =over 4 |
38 | =over 4 |
35 | |
39 | |
36 | =item port |
40 | =item port |
… | |
… | |
52 | |
56 | |
53 | Initially, nodes are either private (single-process only) or hidden |
57 | Initially, nodes are either private (single-process only) or hidden |
54 | (connected to a master node only). Only when they epxlicitly "become |
58 | (connected to a master node only). Only when they epxlicitly "become |
55 | public" can you send them messages from unrelated other nodes. |
59 | public" can you send them messages from unrelated other nodes. |
56 | |
60 | |
57 | =item noderef - C<host:port,host:port...>, C<id@noderef, C<id> |
61 | =item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> |
58 | |
62 | |
59 | A noderef is a string that either uniquely identifies a given node (for |
63 | A noderef is a string that either uniquely identifies a given node (for |
60 | private and hidden nodes), or contains a recipe on how to reach a given |
64 | private and hidden nodes), or contains a recipe on how to reach a given |
61 | node (for public nodes). |
65 | node (for public nodes). |
62 | |
66 | |
… | |
… | |
68 | |
72 | |
69 | =cut |
73 | =cut |
70 | |
74 | |
71 | package AnyEvent::MP; |
75 | package AnyEvent::MP; |
72 | |
76 | |
73 | use AnyEvent::MP::Util (); |
|
|
74 | use AnyEvent::MP::Node; |
77 | use AnyEvent::MP::Base; |
75 | use AnyEvent::MP::Transport; |
|
|
76 | |
78 | |
77 | use utf8; |
|
|
78 | use common::sense; |
79 | use common::sense; |
79 | |
80 | |
80 | use Carp (); |
81 | use Carp (); |
81 | |
82 | |
82 | use AE (); |
83 | use AE (); |
83 | |
84 | |
84 | use base "Exporter"; |
85 | use base "Exporter"; |
85 | |
86 | |
86 | our $VERSION = '0.0'; |
87 | our $VERSION = '0.02'; |
87 | our @EXPORT = qw(NODE $NODE $PORT snd rcv _any_); |
88 | our @EXPORT = qw( |
88 | |
89 | NODE $NODE $PORT snd rcv _any_ |
89 | our $DEFAULT_SECRET; |
90 | create_port create_port_on |
90 | our $DEFAULT_PORT = "4040"; |
91 | become_slave become_public |
91 | |
92 | ); |
92 | our $CONNECT_INTERVAL = 5; # new connect every 5s, at least |
|
|
93 | our $CONNECT_TIMEOUT = 30; # includes handshake |
|
|
94 | |
|
|
95 | sub default_secret { |
|
|
96 | unless (defined $DEFAULT_SECRET) { |
|
|
97 | if (open my $fh, "<$ENV{HOME}/.aemp-secret") { |
|
|
98 | sysread $fh, $DEFAULT_SECRET, -s $fh; |
|
|
99 | } else { |
|
|
100 | $DEFAULT_SECRET = AnyEvent::MP::Util::nonce 32; |
|
|
101 | } |
|
|
102 | } |
|
|
103 | |
|
|
104 | $DEFAULT_SECRET |
|
|
105 | } |
|
|
106 | |
93 | |
107 | =item NODE / $NODE |
94 | =item NODE / $NODE |
108 | |
95 | |
109 | The C<NODE ()> function and the C<$NODE> variable contain the noderef of |
96 | The C<NODE ()> function and the C<$NODE> variable contain the noderef of |
110 | the local node. The value is initialised by a call to C<become_public> or |
97 | the local node. The value is initialised by a call to C<become_public> or |
111 | C<become_slave>, after which all local port identifiers become invalid. |
98 | C<become_slave>, after which all local port identifiers become invalid. |
112 | |
99 | |
113 | =cut |
|
|
114 | |
|
|
115 | our $UNIQ = sprintf "%x.%x", $$, time; # per-process/node unique cookie |
|
|
116 | our $PUBLIC = 0; |
|
|
117 | our $NODE; |
|
|
118 | our $PORT; |
|
|
119 | |
|
|
120 | our %NODE; # node id to transport mapping, or "undef", for local node |
|
|
121 | our %PORT; # local ports |
|
|
122 | our %LISTENER; # local transports |
|
|
123 | |
|
|
124 | sub NODE() { $NODE } |
|
|
125 | |
|
|
126 | { |
|
|
127 | use POSIX (); |
|
|
128 | my $nodename = (POSIX::uname)[1]; |
|
|
129 | $NODE = "$$\@$nodename"; |
|
|
130 | } |
|
|
131 | |
|
|
132 | sub _ANY_() { 1 } |
|
|
133 | sub _any_() { \&_ANY_ } |
|
|
134 | |
|
|
135 | sub add_node { |
|
|
136 | my ($noderef) = @_; |
|
|
137 | |
|
|
138 | return $NODE{$noderef} |
|
|
139 | if exists $NODE{$noderef}; |
|
|
140 | |
|
|
141 | for (split /,/, $noderef) { |
|
|
142 | return $NODE{$noderef} = $NODE{$_} |
|
|
143 | if exists $NODE{$_}; |
|
|
144 | } |
|
|
145 | |
|
|
146 | # for indirect sends, use a different class |
|
|
147 | my $node = new AnyEvent::MP::Node::Direct $noderef; |
|
|
148 | |
|
|
149 | $NODE{$_} = $node |
|
|
150 | for $noderef, split /,/, $noderef; |
|
|
151 | |
|
|
152 | $node |
|
|
153 | } |
|
|
154 | |
|
|
155 | =item snd $portid, type => @data |
100 | =item snd $portid, type => @data |
156 | |
101 | |
157 | =item snd $portid, @msg |
102 | =item snd $portid, @msg |
158 | |
103 | |
159 | Send the given message to the given port ID, which can identify either a |
104 | Send the given message to the given port ID, which can identify either |
160 | local or a remote port. |
105 | a local or a remote port, and can be either a string or soemthignt hat |
|
|
106 | stringifies a sa port ID (such as a port object :). |
161 | |
107 | |
162 | While the message can be about anything, it is highly recommended to use |
108 | While the message can be about anything, it is highly recommended to use a |
163 | a constant string as first element. |
109 | string as first element (a portid, or some word that indicates a request |
|
|
110 | type etc.). |
164 | |
111 | |
165 | The message data effectively becomes read-only after a call to this |
112 | The message data effectively becomes read-only after a call to this |
166 | function: modifying any argument is not allowed and can cause many |
113 | function: modifying any argument is not allowed and can cause many |
167 | problems. |
114 | problems. |
168 | |
115 | |
… | |
… | |
170 | JSON is used, then only strings, numbers and arrays and hashes consisting |
117 | JSON is used, then only strings, numbers and arrays and hashes consisting |
171 | of those are allowed (no objects). When Storable is used, then anything |
118 | of those are allowed (no objects). When Storable is used, then anything |
172 | that Storable can serialise and deserialise is allowed, and for the local |
119 | that Storable can serialise and deserialise is allowed, and for the local |
173 | node, anything can be passed. |
120 | node, anything can be passed. |
174 | |
121 | |
175 | =cut |
122 | =item $local_port = create_port |
176 | |
123 | |
177 | sub snd($@) { |
124 | Create a new local port object. See the next section for allowed methods. |
178 | my ($noderef, $port) = split /#/, shift, 2; |
|
|
179 | |
125 | |
180 | add_node $noderef |
126 | =cut |
181 | unless exists $NODE{$noderef}; |
|
|
182 | |
127 | |
183 | $NODE{$noderef}->send (["$port", [@_]]); |
128 | sub create_port { |
|
|
129 | my $id = "$AnyEvent::MP::Base::UNIQ." . ++$AnyEvent::MP::Base::ID; |
|
|
130 | |
|
|
131 | my $self = bless { |
|
|
132 | id => "$NODE#$id", |
|
|
133 | names => [$id], |
|
|
134 | }, "AnyEvent::MP::Port"; |
|
|
135 | |
|
|
136 | $AnyEvent::MP::Base::PORT{$id} = sub { |
|
|
137 | unshift @_, $self; |
|
|
138 | |
|
|
139 | for (@{ $self->{rc0}{$_[1]} }) { |
|
|
140 | $_ && &{$_->[0]} |
|
|
141 | && undef $_; |
|
|
142 | } |
|
|
143 | |
|
|
144 | for (@{ $self->{rcv}{$_[1]} }) { |
|
|
145 | $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] |
|
|
146 | && &{$_->[0]} |
|
|
147 | && undef $_; |
|
|
148 | } |
|
|
149 | |
|
|
150 | for (@{ $self->{any} }) { |
|
|
151 | $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] |
|
|
152 | && &{$_->[0]} |
|
|
153 | && undef $_; |
|
|
154 | } |
|
|
155 | }; |
|
|
156 | |
|
|
157 | $self |
184 | } |
158 | } |
185 | |
159 | |
|
|
160 | package AnyEvent::MP::Port; |
|
|
161 | |
|
|
162 | =back |
|
|
163 | |
|
|
164 | =head1 METHODS FOR PORT OBJECTS |
|
|
165 | |
|
|
166 | =over 4 |
|
|
167 | |
|
|
168 | =item "$port" |
|
|
169 | |
|
|
170 | A port object stringifies to its port ID, so can be used directly for |
|
|
171 | C<snd> operations. |
|
|
172 | |
|
|
173 | =cut |
|
|
174 | |
|
|
175 | use overload |
|
|
176 | '""' => sub { $_[0]{id} }, |
|
|
177 | fallback => 1; |
|
|
178 | |
186 | =item rcv $portid, type => $callback->(@msg) |
179 | =item $port->rcv (type => $callback->($port, @msg)) |
187 | |
180 | |
188 | =item rcv $portid, $smartmatch => $callback->(@msg) |
181 | =item $port->rcv ($smartmatch => $callback->($port, @msg)) |
189 | |
182 | |
190 | =item rcv $portid, [$smartmatch...] => $callback->(@msg) |
183 | =item $port->rcv ([$smartmatch...] => $callback->($port, @msg)) |
191 | |
184 | |
192 | Register a callback on the port identified by C<$portid>, which I<must> be |
185 | Register a callback on the given port. |
193 | a local port. |
|
|
194 | |
186 | |
195 | The callback has to return a true value when its work is done, after |
187 | The callback has to return a true value when its work is done, after |
196 | which is will be removed, or a false value in which case it will stay |
188 | which is will be removed, or a false value in which case it will stay |
197 | registered. |
189 | registered. |
198 | |
190 | |
… | |
… | |
208 | also the most efficient match (by far). |
200 | also the most efficient match (by far). |
209 | |
201 | |
210 | =cut |
202 | =cut |
211 | |
203 | |
212 | sub rcv($@) { |
204 | sub rcv($@) { |
213 | my ($port, $match, $cb) = @_; |
205 | my ($self, $match, $cb) = @_; |
214 | |
|
|
215 | my $port = $PORT{$port} |
|
|
216 | or do { |
|
|
217 | my ($noderef, $lport) = split /#/, $port; |
|
|
218 | "AnyEvent::MP::Node::Self" eq ref $NODE{$noderef} |
|
|
219 | or Carp::croak "$port: can only rcv on local ports"; |
|
|
220 | |
|
|
221 | $PORT{$lport} |
|
|
222 | or Carp::croak "$port: port does not exist"; |
|
|
223 | |
|
|
224 | $PORT{$port} = $PORT{$lport} # also return |
|
|
225 | }; |
|
|
226 | |
206 | |
227 | if (!ref $match) { |
207 | if (!ref $match) { |
228 | push @{ $port->{rc0}{$match} }, [$cb]; |
208 | push @{ $self->{rc0}{$match} }, [$cb]; |
229 | } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { |
209 | } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { |
230 | my ($type, @match) = @$match; |
210 | my ($type, @match) = @$match; |
231 | @match |
211 | @match |
232 | ? push @{ $port->{rcv}{$match->[0]} }, [$cb, \@match] |
212 | ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match] |
233 | : push @{ $port->{rc0}{$match->[0]} }, [$cb]; |
213 | : push @{ $self->{rc0}{$match->[0]} }, [$cb]; |
234 | } else { |
214 | } else { |
235 | push @{ $port->{any} }, [$cb, $match]; |
215 | push @{ $self->{any} }, [$cb, $match]; |
236 | } |
216 | } |
237 | } |
217 | } |
238 | |
218 | |
239 | sub _inject { |
219 | =item $port->register ($name) |
240 | my ($port, $msg) = @{+shift}; |
|
|
241 | |
220 | |
242 | $port = $PORT{$port} |
221 | Registers the given port under the well known name C<$name>. If the name |
243 | or return; |
222 | already exists it is replaced. |
244 | |
223 | |
245 | @_ = @$msg; |
224 | A port can only be registered under one well known name. |
246 | |
225 | |
247 | for (@{ $port->{rc0}{$msg->[0]} }) { |
226 | =cut |
248 | $_ && &{$_->[0]} |
|
|
249 | && undef $_; |
|
|
250 | } |
|
|
251 | |
227 | |
252 | for (@{ $port->{rcv}{$msg->[0]} }) { |
228 | sub register { |
253 | $_ && [@_[1..$#{$_->[1]}]] ~~ $_->[1] |
229 | my ($self, $name) = @_; |
254 | && &{$_->[0]} |
|
|
255 | && undef $_; |
|
|
256 | } |
|
|
257 | |
230 | |
258 | for (@{ $port->{any} }) { |
231 | $self->{wkname} = $name; |
259 | $_ && [@_[0..$#{$_->[1]}]] ~~ $_->[1] |
232 | $AnyEvent::MP::Base::WKP{$name} = "$self"; |
260 | && &{$_->[0]} |
|
|
261 | && undef $_; |
|
|
262 | } |
|
|
263 | } |
233 | } |
264 | |
234 | |
265 | sub normalise_noderef($) { |
235 | =item $port->destroy |
|
|
236 | |
|
|
237 | Explicitly destroy/remove/nuke/vaporise the port. |
|
|
238 | |
|
|
239 | Ports are normally kept alive by there mere existance alone, and need to |
|
|
240 | be destroyed explicitly. |
|
|
241 | |
|
|
242 | =cut |
|
|
243 | |
|
|
244 | sub destroy { |
266 | my ($noderef) = @_; |
245 | my ($self) = @_; |
267 | |
246 | |
268 | my $cv = AE::cv; |
247 | delete $AnyEvent::MP::Base::WKP{ $self->{wkname} }; |
269 | my @res; |
|
|
270 | |
248 | |
271 | $cv->begin (sub { |
249 | delete $AnyEvent::MP::Base::PORT{$_} |
272 | my %seen; |
250 | for @{ $self->{names} }; |
273 | my @refs; |
|
|
274 | for (sort { $a->[0] <=> $b->[0] } @res) { |
|
|
275 | push @refs, $_->[1] unless $seen{$_->[1]}++ |
|
|
276 | } |
|
|
277 | shift->send (join ",", @refs); |
|
|
278 | }); |
|
|
279 | |
|
|
280 | $noderef = $DEFAULT_PORT unless length $noderef; |
|
|
281 | |
|
|
282 | my $idx; |
|
|
283 | for my $t (split /,/, $noderef) { |
|
|
284 | my $pri = ++$idx; |
|
|
285 | |
|
|
286 | #TODO: this should be outside normalise_noderef and in become_public |
|
|
287 | if ($t =~ /^\d*$/) { |
|
|
288 | my $nodename = (POSIX::uname)[1]; |
|
|
289 | |
|
|
290 | $cv->begin; |
|
|
291 | AnyEvent::Socket::resolve_sockaddr $nodename, $t || "aemp=$DEFAULT_PORT", "tcp", 0, undef, sub { |
|
|
292 | for (@_) { |
|
|
293 | my ($service, $host) = AnyEvent::Socket::unpack_sockaddr $_->[3]; |
|
|
294 | push @res, [ |
|
|
295 | $pri += 1e-5, |
|
|
296 | AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $host, $service |
|
|
297 | ]; |
|
|
298 | } |
|
|
299 | $cv->end; |
|
|
300 | }; |
|
|
301 | |
|
|
302 | # my (undef, undef, undef, undef, @ipv4) = gethostbyname $nodename; |
|
|
303 | # |
|
|
304 | # for (@ipv4) { |
|
|
305 | # push @res, [ |
|
|
306 | # $pri, |
|
|
307 | # AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $_, $t || $DEFAULT_PORT, |
|
|
308 | # ]; |
|
|
309 | # } |
|
|
310 | } else { |
|
|
311 | my ($host, $port) = AnyEvent::Socket::parse_hostport $t, "aemp=$DEFAULT_PORT" |
|
|
312 | or Carp::croak "$t: unparsable transport descriptor"; |
|
|
313 | |
|
|
314 | $cv->begin; |
|
|
315 | AnyEvent::Socket::resolve_sockaddr $host, $port, "tcp", 0, undef, sub { |
|
|
316 | for (@_) { |
|
|
317 | my ($service, $host) = AnyEvent::Socket::unpack_sockaddr $_->[3]; |
|
|
318 | push @res, [ |
|
|
319 | $pri += 1e-5, |
|
|
320 | AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $host, $service |
|
|
321 | ]; |
|
|
322 | } |
|
|
323 | $cv->end; |
|
|
324 | } |
|
|
325 | } |
|
|
326 | } |
|
|
327 | |
|
|
328 | $cv->end; |
|
|
329 | |
|
|
330 | $cv |
|
|
331 | } |
251 | } |
332 | |
252 | |
333 | sub become_public { |
253 | =back |
334 | return if $PUBLIC; |
|
|
335 | |
254 | |
336 | my $noderef = join ",", ref $_[0] ? @{+shift} : shift; |
255 | =head1 FUNCTIONS FOR NODES |
337 | my @args = @_; |
|
|
338 | |
256 | |
339 | $NODE = (normalise_noderef $noderef)->recv; |
257 | =over 4 |
340 | |
258 | |
341 | for my $t (split /,/, $NODE) { |
259 | =item mon $noderef, $callback->($noderef, $status, $) |
342 | $NODE{$t} = $NODE{""}; |
|
|
343 | |
260 | |
344 | my ($host, $port) = AnyEvent::Socket::parse_hostport $t; |
261 | Monitors the given noderef. |
345 | |
262 | |
346 | $LISTENER{$t} = AnyEvent::MP::Transport::mp_server $host, $port, |
263 | =item become_public endpoint... |
347 | @args, |
|
|
348 | on_error => sub { |
|
|
349 | die "on_error<@_>\n";#d# |
|
|
350 | }, |
|
|
351 | on_connect => sub { |
|
|
352 | my ($tp) = @_; |
|
|
353 | |
264 | |
354 | $NODE{$tp->{remote_id}} = $_[0]; |
265 | Tells the node to become a public node, i.e. reachable from other nodes. |
355 | }, |
|
|
356 | sub { |
|
|
357 | my ($tp) = @_; |
|
|
358 | |
266 | |
359 | $NODE{"$tp->{peerhost}:$tp->{peerport}"} = $tp; |
267 | If no arguments are given, or the first argument is C<undef>, then |
360 | }, |
268 | AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the |
361 | ; |
269 | local nodename resolves to. |
362 | } |
|
|
363 | |
270 | |
364 | $PUBLIC = 1; |
271 | Otherwise the first argument must be an array-reference with transport |
365 | } |
272 | endpoints ("ip:port", "hostname:port") or port numbers (in which case the |
|
|
273 | local nodename is used as hostname). The endpoints are all resolved and |
|
|
274 | will become the node reference. |
366 | |
275 | |
367 | ############################################################################# |
276 | =cut |
368 | # self node code |
|
|
369 | |
277 | |
370 | sub _new_port($) { |
278 | =back |
371 | my ($name) = @_; |
|
|
372 | |
279 | |
373 | my ($noderef, $portname) = split /#/, $name; |
280 | =head1 NODE MESSAGES |
374 | |
281 | |
375 | $PORT{$name} = |
282 | Nodes understand the following messages sent to them. Many of them take |
376 | $PORT{$portname} = { |
283 | arguments called C<@reply>, which will simply be used to compose a reply |
377 | names => [$name, $portname], |
284 | message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and |
378 | }; |
285 | the remaining arguments are simply the message data. |
379 | } |
|
|
380 | |
286 | |
381 | $NODE{""} = new AnyEvent::MP::Node::Self noderef => $NODE; |
287 | =over 4 |
382 | _new_port ""; |
|
|
383 | |
288 | |
384 | rcv "", relay => \&snd; |
289 | =cut |
|
|
290 | |
|
|
291 | =item wkp => $name, @reply |
|
|
292 | |
|
|
293 | Replies with the port ID of the specified well-known port, or C<undef>. |
|
|
294 | |
|
|
295 | =item devnull => ... |
|
|
296 | |
|
|
297 | Generic data sink/CPU heat conversion. |
|
|
298 | |
|
|
299 | =item relay => $port, @msg |
|
|
300 | |
|
|
301 | Simply forwards the message to the given port. |
|
|
302 | |
|
|
303 | =item eval => $string[ @reply] |
|
|
304 | |
|
|
305 | Evaluates the given string. If C<@reply> is given, then a message of the |
|
|
306 | form C<@reply, $@, @evalres> is sent. |
|
|
307 | |
|
|
308 | Example: crash another node. |
|
|
309 | |
|
|
310 | snd $othernode, eval => "exit"; |
|
|
311 | |
|
|
312 | =item time => @reply |
|
|
313 | |
|
|
314 | Replies the the current node time to C<@reply>. |
|
|
315 | |
|
|
316 | Example: tell the current node to send the current time to C<$myport> in a |
|
|
317 | C<timereply> message. |
|
|
318 | |
|
|
319 | snd $NODE, time => $myport, timereply => 1, 2; |
|
|
320 | # => snd $myport, timereply => 1, 2, <time> |
385 | |
321 | |
386 | =back |
322 | =back |
387 | |
323 | |
388 | =head1 SEE ALSO |
324 | =head1 SEE ALSO |
389 | |
325 | |