ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/AnyEvent-MP/MP.pm
(Generate patch)

Comparing cvsroot/AnyEvent-MP/MP.pm (file contents):
Revision 1.5 by root, Sat Aug 1 07:44:02 2009 UTC vs.
Revision 1.121 by root, Tue Feb 28 18:37:24 2012 UTC

1=head1 NAME 1=head1 NAME
2 2
3AnyEvent::MP - multi-processing/message-passing framework 3AnyEvent::MP - erlang-style multi-processing/message-passing framework
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::MP; 7 use AnyEvent::MP;
8 8
9 NODE # returns this node identifier
10 $NODE # contains this node identifier 9 $NODE # contains this node's node ID
10 NODE # returns this node's node ID
11 11
12 $SELF # receiving/own port id in rcv callbacks
13
14 # initialise the node so it can send/receive messages
15 configure;
16
17 # ports are message destinations
18
19 # sending messages
12 snd $port, type => data...; 20 snd $port, type => data...;
21 snd $port, @msg;
22 snd @msg_with_first_element_being_a_port;
13 23
14 rcv $port, smartmatch => $cb->($port, @msg); 24 # creating/using ports, the simple way
25 my $simple_port = port { my @msg = @_ };
15 26
16 # examples: 27 # creating/using ports, tagged message matching
28 my $port = port;
17 rcv $port2, ping => sub { snd $_[0], "pong"; 0 }; 29 rcv $port, ping => sub { snd $_[0], "pong" };
18 rcv $port1, pong => sub { warn "pong received\n" }; 30 rcv $port, pong => sub { warn "pong received\n" };
19 snd $port2, ping => $port1;
20 31
21 # more, smarter, matches (_any_ is exported by this module) 32 # create a port on another node
22 rcv $port, [child_died => $pid] => sub { ... 33 my $port = spawn $node, $initfunc, @initdata;
23 rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3 34
35 # destroy a port again
36 kil $port; # "normal" kill
37 kil $port, my_error => "everything is broken"; # error kill
38
39 # monitoring
40 mon $localport, $cb->(@msg) # callback is invoked on death
41 mon $localport, $otherport # kill otherport on abnormal death
42 mon $localport, $otherport, @msg # send message on death
43
44 # temporarily execute code in port context
45 peval $port, sub { die "kill the port!" };
46
47 # execute callbacks in $SELF port context
48 my $timer = AE::timer 1, 0, psub {
49 die "kill the port, delayed";
50 };
51
52=head1 CURRENT STATUS
53
54 bin/aemp - stable.
55 AnyEvent::MP - stable API, should work.
56 AnyEvent::MP::Intro - explains most concepts.
57 AnyEvent::MP::Kernel - mostly stable API.
58 AnyEvent::MP::Global - stable API.
24 59
25=head1 DESCRIPTION 60=head1 DESCRIPTION
26 61
27This module (-family) implements a simple message passing framework. 62This module (-family) implements a simple message passing framework.
28 63
29Despite its simplicity, you can securely message other processes running 64Despite its simplicity, you can securely message other processes running
30on the same or other hosts. 65on the same or other hosts, and you can supervise entities remotely.
66
67For an introduction to this module family, see the L<AnyEvent::MP::Intro>
68manual page and the examples under F<eg/>.
31 69
32=head1 CONCEPTS 70=head1 CONCEPTS
33 71
34=over 4 72=over 4
35 73
36=item port 74=item port
37 75
38A port is something you can send messages to with the C<snd> function, and 76Not to be confused with a TCP port, a "port" is something you can send
39you can register C<rcv> handlers with. All C<rcv> handlers will receive 77messages to (with the C<snd> function).
40messages they match, messages will not be queued.
41 78
79Ports allow you to register C<rcv> handlers that can match all or just
80some messages. Messages send to ports will not be queued, regardless of
81anything was listening for them or not.
82
83Ports are represented by (printable) strings called "port IDs".
84
42=item port id - C<noderef#portname> 85=item port ID - C<nodeid#portname>
43 86
44A port id is always the noderef, a hash-mark (C<#>) as separator, followed 87A port ID is the concatenation of a node ID, a hash-mark (C<#>) as
45by a port name (a printable string of unspecified format). 88separator, and a port name (a printable string of unspecified format).
46 89
47=item node 90=item node
48 91
49A node is a single process containing at least one port - the node 92A node is a single process containing at least one port - the node port,
50port. You can send messages to node ports to let them create new ports, 93which enables nodes to manage each other remotely, and to create new
51among other things. 94ports.
52 95
53Initially, nodes are either private (single-process only) or hidden 96Nodes are either public (have one or more listening ports) or private
54(connected to a master node only). Only when they epxlicitly "become 97(no listening ports). Private nodes cannot talk to other private nodes
55public" can you send them messages from unrelated other nodes. 98currently, but all nodes can talk to public nodes.
56 99
57=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id> 100Nodes is represented by (printable) strings called "node IDs".
58 101
102=item node ID - C<[A-Za-z0-9_\-.:]*>
103
59A noderef is a string that either uniquely identifies a given node (for 104A node ID is a string that uniquely identifies the node within a
60private and hidden nodes), or contains a recipe on how to reach a given 105network. Depending on the configuration used, node IDs can look like a
61node (for public nodes). 106hostname, a hostname and a port, or a random string. AnyEvent::MP itself
107doesn't interpret node IDs in any way except to uniquely identify a node.
108
109=item binds - C<ip:port>
110
111Nodes can only talk to each other by creating some kind of connection to
112each other. To do this, nodes should listen on one or more local transport
113endpoints - binds.
114
115Currently, only standard C<ip:port> specifications can be used, which
116specify TCP ports to listen on. So a bind is basically just a tcp socket
117in listening mode thta accepts conenctions form other nodes.
118
119=item seed nodes
120
121When a node starts, it knows nothing about the network it is in - it
122needs to connect to at least one other node that is already in the
123network. These other nodes are called "seed nodes".
124
125Seed nodes themselves are not special - they are seed nodes only because
126some other node I<uses> them as such, but any node can be used as seed
127node for other nodes, and eahc node cna use a different set of seed nodes.
128
129In addition to discovering the network, seed nodes are also used to
130maintain the network - all nodes using the same seed node form are part of
131the same network. If a network is split into multiple subnets because e.g.
132the network link between the parts goes down, then using the same seed
133nodes for all nodes ensures that eventually the subnets get merged again.
134
135Seed nodes are expected to be long-running, and at least one seed node
136should always be available. They should also be relatively responsive - a
137seed node that blocks for long periods will slow down everybody else.
138
139For small networks, it's best if every node uses the same set of seed
140nodes. For large networks, it can be useful to specify "regional" seed
141nodes for most nodes in an area, and use all seed nodes as seed nodes for
142each other. What's important is that all seed nodes connections form a
143complete graph, so that the network cannot split into separate subnets
144forever.
145
146Seed nodes are represented by seed IDs.
147
148=item seed IDs - C<host:port>
149
150Seed IDs are transport endpoint(s) (usually a hostname/IP address and a
151TCP port) of nodes that should be used as seed nodes.
152
153=item global nodes
154
155An AEMP network needs a discovery service - nodes need to know how to
156connect to other nodes they only know by name. In addition, AEMP offers a
157distributed "group database", which maps group names to a list of strings
158- for example, to register worker ports.
159
160A network needs at least one global node to work, and allows every node to
161be a global node.
162
163Any node that loads the L<AnyEvent::MP::Global> module becomes a global
164node and tries to keep connections to all other nodes. So while it can
165make sense to make every node "global" in small networks, it usually makes
166sense to only make seed nodes into global nodes in large networks (nodes
167keep connections to seed nodes and global nodes, so makign them the same
168reduces overhead).
62 169
63=back 170=back
64 171
65=head1 VARIABLES/FUNCTIONS 172=head1 VARIABLES/FUNCTIONS
66 173
68 175
69=cut 176=cut
70 177
71package AnyEvent::MP; 178package AnyEvent::MP;
72 179
73use AnyEvent::MP::Util (); 180use AnyEvent::MP::Config ();
74use AnyEvent::MP::Node; 181use AnyEvent::MP::Kernel;
75use AnyEvent::MP::Transport; 182use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID);
76 183
77use utf8;
78use common::sense; 184use common::sense;
79 185
80use Carp (); 186use Carp ();
81 187
82use AE (); 188use AE ();
83 189
84use base "Exporter"; 190use base "Exporter";
85 191
86our $VERSION = '0.0'; 192our $VERSION = $AnyEvent::MP::Config::VERSION;
87our @EXPORT = qw(NODE $NODE $PORT snd rcv _any_);
88 193
89our $DEFAULT_SECRET; 194our @EXPORT = qw(
90our $DEFAULT_PORT = "4040"; 195 NODE $NODE *SELF node_of after
196 configure
197 snd rcv mon mon_guard kil psub peval spawn cal
198 port
199);
91 200
92our $CONNECT_INTERVAL = 5; # new connect every 5s, at least 201our $SELF;
93our $CONNECT_TIMEOUT = 30; # includes handshake
94 202
95sub default_secret { 203sub _self_die() {
96 unless (defined $DEFAULT_SECRET) { 204 my $msg = $@;
97 if (open my $fh, "<$ENV{HOME}/.aemp-secret") { 205 $msg =~ s/\n+$// unless ref $msg;
98 sysread $fh, $DEFAULT_SECRET, -s $fh; 206 kil $SELF, die => $msg;
99 } else {
100 $DEFAULT_SECRET = AnyEvent::MP::Util::nonce 32;
101 }
102 }
103
104 $DEFAULT_SECRET
105} 207}
106 208
107=item NODE / $NODE 209=item $thisnode = NODE / $NODE
108 210
109The C<NODE ()> function and the C<$NODE> variable contain the noderef of 211The C<NODE> function returns, and the C<$NODE> variable contains, the node
110the local node. The value is initialised by a call to C<become_public> or 212ID of the node running in the current process. This value is initialised by
111C<become_slave>, after which all local port identifiers become invalid. 213a call to C<configure>.
112 214
113=cut 215=item $nodeid = node_of $port
114 216
115our $UNIQ = sprintf "%x.%x", $$, time; # per-process/node unique cookie 217Extracts and returns the node ID from a port ID or a node ID.
116our $PUBLIC = 0;
117our $NODE;
118our $PORT;
119 218
120our %NODE; # node id to transport mapping, or "undef", for local node 219=item configure $profile, key => value...
121our %PORT; # local ports
122our %LISTENER; # local transports
123 220
124sub NODE() { $NODE } 221=item configure key => value...
125 222
126{ 223Before a node can talk to other nodes on the network (i.e. enter
127 use POSIX (); 224"distributed mode") it has to configure itself - the minimum a node needs
128 my $nodename = (POSIX::uname)[1]; 225to know is its own name, and optionally it should know the addresses of
129 $NODE = "$$\@$nodename"; 226some other nodes in the network to discover other nodes.
130}
131 227
132sub _ANY_() { 1 } 228This function configures a node - it must be called exactly once (or
133sub _any_() { \&_ANY_ } 229never) before calling other AnyEvent::MP functions.
134 230
135sub add_node { 231The key/value pairs are basically the same ones as documented for the
136 my ($noderef) = @_; 232F<aemp> command line utility (sans the set/del prefix), with two additions:
137 233
138 return $NODE{$noderef} 234=over 4
139 if exists $NODE{$noderef};
140 235
141 for (split /,/, $noderef) { 236=item norc => $boolean (default false)
142 return $NODE{$noderef} = $NODE{$_}
143 if exists $NODE{$_};
144 }
145 237
146 # for indirect sends, use a different class 238If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I<not>
147 my $node = new AnyEvent::MP::Node::Direct $noderef; 239be consulted - all configuraiton options must be specified in the
240C<configure> call.
148 241
149 $NODE{$_} = $node 242=item force => $boolean (default false)
150 for $noderef, split /,/, $noderef;
151 243
152 $node 244IF true, then the values specified in the C<configure> will take
153} 245precedence over any values configured via the rc file. The default is for
246the rc file to override any options specified in the program.
154 247
248=back
249
250=over 4
251
252=item step 1, gathering configuration from profiles
253
254The function first looks up a profile in the aemp configuration (see the
255L<aemp> commandline utility). The profile name can be specified via the
256named C<profile> parameter or can simply be the first parameter). If it is
257missing, then the nodename (F<uname -n>) will be used as profile name.
258
259The profile data is then gathered as follows:
260
261First, all remaining key => value pairs (all of which are conveniently
262undocumented at the moment) will be interpreted as configuration
263data. Then they will be overwritten by any values specified in the global
264default configuration (see the F<aemp> utility), then the chain of
265profiles chosen by the profile name (and any C<parent> attributes).
266
267That means that the values specified in the profile have highest priority
268and the values specified directly via C<configure> have lowest priority,
269and can only be used to specify defaults.
270
271If the profile specifies a node ID, then this will become the node ID of
272this process. If not, then the profile name will be used as node ID. The
273special node ID of C<anon/> will be replaced by a random node ID.
274
275=item step 2, bind listener sockets
276
277The next step is to look up the binds in the profile, followed by binding
278aemp protocol listeners on all binds specified (it is possible and valid
279to have no binds, meaning that the node cannot be contacted form the
280outside. This means the node cannot talk to other nodes that also have no
281binds, but it can still talk to all "normal" nodes).
282
283If the profile does not specify a binds list, then a default of C<*> is
284used, meaning the node will bind on a dynamically-assigned port on every
285local IP address it finds.
286
287=item step 3, connect to seed nodes
288
289As the last step, the seed ID list from the profile is passed to the
290L<AnyEvent::MP::Global> module, which will then use it to keep
291connectivity with at least one node at any point in time.
292
293=back
294
295Example: become a distributed node using the local node name as profile.
296This should be the most common form of invocation for "daemon"-type nodes.
297
298 configure
299
300Example: become an anonymous node. This form is often used for commandline
301clients.
302
303 configure nodeid => "anon/";
304
305Example: configure a node using a profile called seed, which is suitable
306for a seed node as it binds on all local addresses on a fixed port (4040,
307customary for aemp).
308
309 # use the aemp commandline utility
310 # aemp profile seed nodeid anon/ binds '*:4040'
311
312 # then use it
313 configure profile => "seed";
314
315 # or simply use aemp from the shell again:
316 # aemp run profile seed
317
318 # or provide a nicer-to-remember nodeid
319 # aemp run profile seed nodeid "$(hostname)"
320
321=item $SELF
322
323Contains the current port id while executing C<rcv> callbacks or C<psub>
324blocks.
325
326=item *SELF, SELF, %SELF, @SELF...
327
328Due to some quirks in how perl exports variables, it is impossible to
329just export C<$SELF>, all the symbols named C<SELF> are exported by this
330module, but only C<$SELF> is currently used.
331
155=item snd $portid, type => @data 332=item snd $port, type => @data
156 333
157=item snd $portid, @msg 334=item snd $port, @msg
158 335
159Send the given message to the given port ID, which can identify either a 336Send the given message to the given port, which can identify either a
160local or a remote port. 337local or a remote port, and must be a port ID.
161 338
162While the message can be about anything, it is highly recommended to use 339While the message can be almost anything, it is highly recommended to
163a constant string as first element. 340use a string as first element (a port ID, or some word that indicates a
341request type etc.) and to consist if only simple perl values (scalars,
342arrays, hashes) - if you think you need to pass an object, think again.
164 343
165The message data effectively becomes read-only after a call to this 344The message data logically becomes read-only after a call to this
166function: modifying any argument is not allowed and can cause many 345function: modifying any argument (or values referenced by them) is
167problems. 346forbidden, as there can be considerable time between the call to C<snd>
347and the time the message is actually being serialised - in fact, it might
348never be copied as within the same process it is simply handed to the
349receiving port.
168 350
169The type of data you can transfer depends on the transport protocol: when 351The type of data you can transfer depends on the transport protocol: when
170JSON is used, then only strings, numbers and arrays and hashes consisting 352JSON is used, then only strings, numbers and arrays and hashes consisting
171of those are allowed (no objects). When Storable is used, then anything 353of those are allowed (no objects). When Storable is used, then anything
172that Storable can serialise and deserialise is allowed, and for the local 354that Storable can serialise and deserialise is allowed, and for the local
173node, anything can be passed. 355node, anything can be passed. Best rely only on the common denominator of
356these.
174 357
175=cut 358=item $local_port = port
176 359
177sub snd(@) { 360Create a new local port object and returns its port ID. Initially it has
178 my ($noderef, $port) = split /#/, shift, 2; 361no callbacks set and will throw an error when it receives messages.
179 362
180 add_node $noderef 363=item $local_port = port { my @msg = @_ }
181 unless exists $NODE{$noderef};
182 364
183 $NODE{$noderef}->send (["$port", [@_]]); 365Creates a new local port, and returns its ID. Semantically the same as
184} 366creating a port and calling C<rcv $port, $callback> on it.
185 367
368The block will be called for every message received on the port, with the
369global variable C<$SELF> set to the port ID. Runtime errors will cause the
370port to be C<kil>ed. The message will be passed as-is, no extra argument
371(i.e. no port ID) will be passed to the callback.
372
373If you want to stop/destroy the port, simply C<kil> it:
374
375 my $port = port {
376 my @msg = @_;
377 ...
378 kil $SELF;
379 };
380
381=cut
382
383sub rcv($@);
384
385sub _kilme {
386 die "received message on port without callback";
387}
388
389sub port(;&) {
390 my $id = "$UNIQ." . ++$ID;
391 my $port = "$NODE#$id";
392
393 rcv $port, shift || \&_kilme;
394
395 $port
396}
397
186=item rcv $portid, type => $callback->(@msg) 398=item rcv $local_port, $callback->(@msg)
187 399
188=item rcv $portid, $smartmatch => $callback->(@msg) 400Replaces the default callback on the specified port. There is no way to
401remove the default callback: use C<sub { }> to disable it, or better
402C<kil> the port when it is no longer needed.
189 403
190=item rcv $portid, [$smartmatch...] => $callback->(@msg) 404The global C<$SELF> (exported by this module) contains C<$port> while
405executing the callback. Runtime errors during callback execution will
406result in the port being C<kil>ed.
191 407
192Register a callback on the port identified by C<$portid>, which I<must> be 408The default callback received all messages not matched by a more specific
193a local port. 409C<tag> match.
194 410
195The callback has to return a true value when its work is done, after 411=item rcv $local_port, tag => $callback->(@msg_without_tag), ...
196which is will be removed, or a false value in which case it will stay
197registered.
198 412
199If the match is an array reference, then it will be matched against the 413Register (or replace) callbacks to be called on messages starting with the
200first elements of the message, otherwise only the first element is being 414given tag on the given port (and return the port), or unregister it (when
201matched. 415C<$callback> is C<$undef> or missing). There can only be one callback
416registered for each tag.
202 417
203Any element in the match that is specified as C<_any_> (a function 418The original message will be passed to the callback, after the first
204exported by this module) matches any single element of the message. 419element (the tag) has been removed. The callback will use the same
420environment as the default callback (see above).
205 421
206While not required, it is highly recommended that the first matching 422Example: create a port and bind receivers on it in one go.
207element is a string identifying the message. The one-string-only match is 423
208also the most efficient match (by far). 424 my $port = rcv port,
425 msg1 => sub { ... },
426 msg2 => sub { ... },
427 ;
428
429Example: create a port, bind receivers and send it in a message elsewhere
430in one go:
431
432 snd $otherport, reply =>
433 rcv port,
434 msg1 => sub { ... },
435 ...
436 ;
437
438Example: temporarily register a rcv callback for a tag matching some port
439(e.g. for an rpc reply) and unregister it after a message was received.
440
441 rcv $port, $otherport => sub {
442 my @reply = @_;
443
444 rcv $SELF, $otherport;
445 };
209 446
210=cut 447=cut
211 448
212sub rcv($@) { 449sub rcv($@) {
213 my ($port, $match, $cb) = @_; 450 my $port = shift;
214
215 my $port = $PORT{$port}
216 or do {
217 my ($noderef, $lport) = split /#/, $port; 451 my ($nodeid, $portid) = split /#/, $port, 2;
218 "AnyEvent::MP::Node::Self" eq ref $NODE{$noderef} 452
453 $NODE{$nodeid} == $NODE{""}
219 or Carp::croak "$port: can only rcv on local ports"; 454 or Carp::croak "$port: rcv can only be called on local ports, caught";
220 455
221 $PORT{$lport} 456 while (@_) {
222 or Carp::croak "$port: port does not exist"; 457 if (ref $_[0]) {
223 458 if (my $self = $PORT_DATA{$portid}) {
224 $PORT{$port} = $PORT{$lport} # also return 459 "AnyEvent::MP::Port" eq ref $self
225 }; 460 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
226 461
227 if (!ref $match) { 462 $self->[0] = shift;
228 push @{ $port->{rc0}{$match} }, [$cb];
229 } elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
230 my ($type, @match) = @$match;
231 @match
232 ? push @{ $port->{rcv}{$match->[0]} }, [$cb, \@match]
233 : push @{ $port->{rc0}{$match->[0]} }, [$cb];
234 } else { 463 } else {
235 push @{ $port->{any} }, [$cb, $match]; 464 my $cb = shift;
236 } 465 $PORT{$portid} = sub {
237} 466 local $SELF = $port;
238 467 eval { &$cb }; _self_die if $@;
239sub _inject {
240 my ($port, $msg) = @{+shift};
241
242 $port = $PORT{$port}
243 or return;
244
245 @_ = @$msg;
246
247 for (@{ $port->{rc0}{$msg->[0]} }) {
248 $_ && &{$_->[0]}
249 && undef $_;
250 }
251
252 for (@{ $port->{rcv}{$msg->[0]} }) {
253 $_ && [@_[1..$#{$_->[1]}]] ~~ $_->[1]
254 && &{$_->[0]}
255 && undef $_;
256 }
257
258 for (@{ $port->{any} }) {
259 $_ && [@_[0..$#{$_->[1]}]] ~~ $_->[1]
260 && &{$_->[0]}
261 && undef $_;
262 }
263}
264
265sub normalise_noderef($) {
266 my ($noderef) = @_;
267
268 my $cv = AE::cv;
269 my @res;
270
271 $cv->begin (sub {
272 my %seen;
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 } 468 };
299 $cv->end; 469 }
470 } elsif (defined $_[0]) {
471 my $self = $PORT_DATA{$portid} ||= do {
472 my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port";
473
474 $PORT{$portid} = sub {
475 local $SELF = $port;
476
477 if (my $cb = $self->[1]{$_[0]}) {
478 shift;
479 eval { &$cb }; _self_die if $@;
480 } else {
481 &{ $self->[0] };
482 }
483 };
484
485 $self
300 }; 486 };
301 487
302# my (undef, undef, undef, undef, @ipv4) = gethostbyname $nodename; 488 "AnyEvent::MP::Port" eq ref $self
303# 489 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
304# for (@ipv4) { 490
305# push @res, [ 491 my ($tag, $cb) = splice @_, 0, 2;
306# $pri, 492
307# AnyEvent::Socket::format_hostport AnyEvent::Socket::format_address $_, $t || $DEFAULT_PORT, 493 if (defined $cb) {
308# ]; 494 $self->[1]{$tag} = $cb;
309# }
310 } else { 495 } else {
311 my ($host, $port) = AnyEvent::Socket::parse_hostport $t, "aemp=$DEFAULT_PORT" 496 delete $self->[1]{$tag};
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 } 497 }
325 } 498 }
326 } 499 }
327 500
328 $cv->end; 501 $port
329
330 $cv
331} 502}
332 503
333sub become_public { 504=item peval $port, $coderef[, @args]
334 return if $PUBLIC;
335 505
336 my $noderef = join ",", ref $_[0] ? @{+shift} : shift; 506Evaluates the given C<$codref> within the contetx of C<$port>, that is,
337 my @args = @_; 507when the code throews an exception the C<$port> will be killed.
338 508
339 $NODE = (normalise_noderef $noderef)->recv; 509Any remaining args will be passed to the callback. Any return values will
510be returned to the caller.
340 511
341 for my $t (split /,/, $NODE) { 512This is useful when you temporarily want to execute code in the context of
342 $NODE{$t} = $NODE{""}; 513a port.
343 514
344 my ($host, $port) = AnyEvent::Socket::parse_hostport $t; 515Example: create a port and run some initialisation code in it's context.
345 516
346 $LISTENER{$t} = AnyEvent::MP::Transport::mp_server $host, $port, 517 my $port = port { ... };
347 @args,
348 on_error => sub {
349 die "on_error<@_>\n";#d#
350 },
351 on_connect => sub {
352 my ($tp) = @_;
353 518
354 $NODE{$tp->{remote_id}} = $_[0]; 519 peval $port, sub {
355 }, 520 init
356 sub { 521 or die "unable to init";
357 my ($tp) = @_; 522 };
358 523
359 $NODE{"$tp->{peerhost}:$tp->{peerport}"} = $tp; 524=cut
360 }, 525
361 ; 526sub peval($$) {
527 local $SELF = shift;
528 my $cb = shift;
529
530 if (wantarray) {
531 my @res = eval { &$cb };
532 _self_die if $@;
533 @res
534 } else {
535 my $res = eval { &$cb };
536 _self_die if $@;
537 $res
362 } 538 }
539}
363 540
364 $PUBLIC = 1; 541=item $closure = psub { BLOCK }
542
543Remembers C<$SELF> and creates a closure out of the BLOCK. When the
544closure is executed, sets up the environment in the same way as in C<rcv>
545callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
546
547The effect is basically as if it returned C<< sub { peval $SELF, sub {
548BLOCK }, @_ } >>.
549
550This is useful when you register callbacks from C<rcv> callbacks:
551
552 rcv delayed_reply => sub {
553 my ($delay, @reply) = @_;
554 my $timer = AE::timer $delay, 0, psub {
555 snd @reply, $SELF;
556 };
557 };
558
559=cut
560
561sub psub(&) {
562 my $cb = shift;
563
564 my $port = $SELF
565 or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
566
567 sub {
568 local $SELF = $port;
569
570 if (wantarray) {
571 my @res = eval { &$cb };
572 _self_die if $@;
573 @res
574 } else {
575 my $res = eval { &$cb };
576 _self_die if $@;
577 $res
578 }
579 }
580}
581
582=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies
583
584=item $guard = mon $port, $rcvport # kill $rcvport when $port dies
585
586=item $guard = mon $port # kill $SELF when $port dies
587
588=item $guard = mon $port, $rcvport, @msg # send a message when $port dies
589
590Monitor the given port and do something when the port is killed or
591messages to it were lost, and optionally return a guard that can be used
592to stop monitoring again.
593
594In the first form (callback), the callback is simply called with any
595number of C<@reason> elements (no @reason means that the port was deleted
596"normally"). Note also that I<< the callback B<must> never die >>, so use
597C<eval> if unsure.
598
599In the second form (another port given), the other port (C<$rcvport>)
600will be C<kil>'ed with C<@reason>, if a @reason was specified, i.e. on
601"normal" kils nothing happens, while under all other conditions, the other
602port is killed with the same reason.
603
604The third form (kill self) is the same as the second form, except that
605C<$rvport> defaults to C<$SELF>.
606
607In the last form (message), a message of the form C<@msg, @reason> will be
608C<snd>.
609
610Monitoring-actions are one-shot: once messages are lost (and a monitoring
611alert was raised), they are removed and will not trigger again.
612
613As a rule of thumb, monitoring requests should always monitor a port from
614a local port (or callback). The reason is that kill messages might get
615lost, just like any other message. Another less obvious reason is that
616even monitoring requests can get lost (for example, when the connection
617to the other node goes down permanently). When monitoring a port locally
618these problems do not exist.
619
620C<mon> effectively guarantees that, in the absence of hardware failures,
621after starting the monitor, either all messages sent to the port will
622arrive, or the monitoring action will be invoked after possible message
623loss has been detected. No messages will be lost "in between" (after
624the first lost message no further messages will be received by the
625port). After the monitoring action was invoked, further messages might get
626delivered again.
627
628Inter-host-connection timeouts and monitoring depend on the transport
629used. The only transport currently implemented is TCP, and AnyEvent::MP
630relies on TCP to detect node-downs (this can take 10-15 minutes on a
631non-idle connection, and usually around two hours for idle connections).
632
633This means that monitoring is good for program errors and cleaning up
634stuff eventually, but they are no replacement for a timeout when you need
635to ensure some maximum latency.
636
637Example: call a given callback when C<$port> is killed.
638
639 mon $port, sub { warn "port died because of <@_>\n" };
640
641Example: kill ourselves when C<$port> is killed abnormally.
642
643 mon $port;
644
645Example: send us a restart message when another C<$port> is killed.
646
647 mon $port, $self => "restart";
648
649=cut
650
651sub mon {
652 my ($nodeid, $port) = split /#/, shift, 2;
653
654 my $node = $NODE{$nodeid} || add_node $nodeid;
655
656 my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,';
657
658 unless (ref $cb) {
659 if (@_) {
660 # send a kill info message
661 my (@msg) = ($cb, @_);
662 $cb = sub { snd @msg, @_ };
663 } else {
664 # simply kill other port
665 my $port = $cb;
666 $cb = sub { kil $port, @_ if @_ };
667 }
668 }
669
670 $node->monitor ($port, $cb);
671
672 defined wantarray
673 and ($cb += 0, AnyEvent::Util::guard { $node->unmonitor ($port, $cb) })
674}
675
676=item $guard = mon_guard $port, $ref, $ref...
677
678Monitors the given C<$port> and keeps the passed references. When the port
679is killed, the references will be freed.
680
681Optionally returns a guard that will stop the monitoring.
682
683This function is useful when you create e.g. timers or other watchers and
684want to free them when the port gets killed (note the use of C<psub>):
685
686 $port->rcv (start => sub {
687 my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub {
688 undef $timer if 0.9 < rand;
689 });
690 });
691
692=cut
693
694sub mon_guard {
695 my ($port, @refs) = @_;
696
697 #TODO: mon-less form?
698
699 mon $port, sub { 0 && @refs }
700}
701
702=item kil $port[, @reason]
703
704Kill the specified port with the given C<@reason>.
705
706If no C<@reason> is specified, then the port is killed "normally" -
707monitor callback will be invoked, but the kil will not cause linked ports
708(C<mon $mport, $lport> form) to get killed.
709
710If a C<@reason> is specified, then linked ports (C<mon $mport, $lport>
711form) get killed with the same reason.
712
713Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
714will be reported as reason C<< die => $@ >>.
715
716Transport/communication errors are reported as C<< transport_error =>
717$message >>.
718
719=cut
720
721=item $port = spawn $node, $initfunc[, @initdata]
722
723Creates a port on the node C<$node> (which can also be a port ID, in which
724case it's the node where that port resides).
725
726The port ID of the newly created port is returned immediately, and it is
727possible to immediately start sending messages or to monitor the port.
728
729After the port has been created, the init function is called on the remote
730node, in the same context as a C<rcv> callback. This function must be a
731fully-qualified function name (e.g. C<MyApp::Chat::Server::init>). To
732specify a function in the main program, use C<::name>.
733
734If the function doesn't exist, then the node tries to C<require>
735the package, then the package above the package and so on (e.g.
736C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function
737exists or it runs out of package names.
738
739The init function is then called with the newly-created port as context
740object (C<$SELF>) and the C<@initdata> values as arguments. It I<must>
741call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise
742the port might not get created.
743
744A common idiom is to pass a local port, immediately monitor the spawned
745port, and in the remote init function, immediately monitor the passed
746local port. This two-way monitoring ensures that both ports get cleaned up
747when there is a problem.
748
749C<spawn> guarantees that the C<$initfunc> has no visible effects on the
750caller before C<spawn> returns (by delaying invocation when spawn is
751called for the local node).
752
753Example: spawn a chat server port on C<$othernode>.
754
755 # this node, executed from within a port context:
756 my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF;
757 mon $server;
758
759 # init function on C<$othernode>
760 sub connect {
761 my ($srcport) = @_;
762
763 mon $srcport;
764
765 rcv $SELF, sub {
766 ...
767 };
768 }
769
770=cut
771
772sub _spawn {
773 my $port = shift;
774 my $init = shift;
775
776 # rcv will create the actual port
777 local $SELF = "$NODE#$port";
778 eval {
779 &{ load_func $init }
780 };
781 _self_die if $@;
782}
783
784sub spawn(@) {
785 my ($nodeid, undef) = split /#/, shift, 2;
786
787 my $id = "$RUNIQ." . ++$ID;
788
789 $_[0] =~ /::/
790 or Carp::croak "spawn init function must be a fully-qualified name, caught";
791
792 snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_;
793
794 "$nodeid#$id"
795}
796
797
798=item after $timeout, @msg
799
800=item after $timeout, $callback
801
802Either sends the given message, or call the given callback, after the
803specified number of seconds.
804
805This is simply a utility function that comes in handy at times - the
806AnyEvent::MP author is not convinced of the wisdom of having it, though,
807so it may go away in the future.
808
809=cut
810
811sub after($@) {
812 my ($timeout, @action) = @_;
813
814 my $t; $t = AE::timer $timeout, 0, sub {
815 undef $t;
816 ref $action[0]
817 ? $action[0]()
818 : snd @action;
819 };
820}
821
822=item cal $port, @msg, $callback[, $timeout]
823
824A simple form of RPC - sends a message to the given C<$port> with the
825given contents (C<@msg>), but adds a reply port to the message.
826
827The reply port is created temporarily just for the purpose of receiving
828the reply, and will be C<kil>ed when no longer needed.
829
830A reply message sent to the port is passed to the C<$callback> as-is.
831
832If an optional time-out (in seconds) is given and it is not C<undef>,
833then the callback will be called without any arguments after the time-out
834elapsed and the port is C<kil>ed.
835
836If no time-out is given (or it is C<undef>), then the local port will
837monitor the remote port instead, so it eventually gets cleaned-up.
838
839Currently this function returns the temporary port, but this "feature"
840might go in future versions unless you can make a convincing case that
841this is indeed useful for something.
842
843=cut
844
845sub cal(@) {
846 my $timeout = ref $_[-1] ? undef : pop;
847 my $cb = pop;
848
849 my $port = port {
850 undef $timeout;
851 kil $SELF;
852 &$cb;
853 };
854
855 if (defined $timeout) {
856 $timeout = AE::timer $timeout, 0, sub {
857 undef $timeout;
858 kil $port;
859 $cb->();
860 };
861 } else {
862 mon $_[0], sub {
863 kil $port;
864 $cb->();
865 };
866 }
867
868 push @_, $port;
869 &snd;
870
871 $port
365} 872}
366 873
367=back 874=back
368 875
369=head1 NODE MESSAGES 876=head1 AnyEvent::MP vs. Distributed Erlang
370 877
371Nodes understand the following messages sent to them. Many of them take 878AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node
372arguments called C<@reply>, which will simply be used to compose a reply 879== aemp node, Erlang process == aemp port), so many of the documents and
373message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and 880programming techniques employed by Erlang apply to AnyEvent::MP. Here is a
374the remaining arguments are simply the message data. 881sample:
882
883 http://www.erlang.se/doc/programming_rules.shtml
884 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
885 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
886 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
887
888Despite the similarities, there are also some important differences:
375 889
376=over 4 890=over 4
377 891
378=cut 892=item * Node IDs are arbitrary strings in AEMP.
379 893
380############################################################################# 894Erlang relies on special naming and DNS to work everywhere in the same
381# self node code 895way. AEMP relies on each node somehow knowing its own address(es) (e.g. by
896configuration or DNS), and possibly the addresses of some seed nodes, but
897will otherwise discover other nodes (and their IDs) itself.
382 898
383sub _new_port($) { 899=item * Erlang has a "remote ports are like local ports" philosophy, AEMP
384 my ($name) = @_; 900uses "local ports are like remote ports".
385 901
386 my ($noderef, $portname) = split /#/, $name; 902The failure modes for local ports are quite different (runtime errors
903only) then for remote ports - when a local port dies, you I<know> it dies,
904when a connection to another node dies, you know nothing about the other
905port.
387 906
388 $PORT{$name} = 907Erlang pretends remote ports are as reliable as local ports, even when
389 $PORT{$portname} = { 908they are not.
390 names => [$name, $portname],
391 };
392}
393 909
394$NODE{""} = new AnyEvent::MP::Node::Self noderef => $NODE; 910AEMP encourages a "treat remote ports differently" philosophy, with local
395_new_port ""; 911ports being the special case/exception, where transport errors cannot
912occur.
396 913
397=item relay => $port, @msg 914=item * Erlang uses processes and a mailbox, AEMP does not queue.
398 915
399Simply forwards the message to the given port. 916Erlang uses processes that selectively receive messages out of order, and
917therefore needs a queue. AEMP is event based, queuing messages would serve
918no useful purpose. For the same reason the pattern-matching abilities
919of AnyEvent::MP are more limited, as there is little need to be able to
920filter messages without dequeuing them.
400 921
401=cut 922This is not a philosophical difference, but simply stems from AnyEvent::MP
923being event-based, while Erlang is process-based.
402 924
403rcv "", relay => \&snd; 925You cna have a look at L<Coro::MP> for a more Erlang-like process model on
926top of AEMP and Coro threads.
404 927
405=item eval => $string[ @reply] 928=item * Erlang sends are synchronous, AEMP sends are asynchronous.
406 929
407Evaluates the given string. If C<@reply> is given, then a message of the 930Sending messages in Erlang is synchronous and blocks the process until
408form C<@reply, $@, @evalres> is sent. 931a conenction has been established and the message sent (and so does not
932need a queue that can overflow). AEMP sends return immediately, connection
933establishment is handled in the background.
409 934
410Example: crash another node. 935=item * Erlang suffers from silent message loss, AEMP does not.
411 936
412 snd $othernode, eval => "exit"; 937Erlang implements few guarantees on messages delivery - messages can get
938lost without any of the processes realising it (i.e. you send messages a,
939b, and c, and the other side only receives messages a and c).
413 940
414=cut 941AEMP guarantees (modulo hardware errors) correct ordering, and the
942guarantee that after one message is lost, all following ones sent to the
943same port are lost as well, until monitoring raises an error, so there are
944no silent "holes" in the message sequence.
415 945
416rcv "", eval => sub { 946If you want your software to be very reliable, you have to cope with
417 my (undef, $string, @reply) = @_; 947corrupted and even out-of-order messages in both Erlang and AEMP. AEMP
418 my @res = eval $string; 948simply tries to work better in common error cases, such as when a network
419 snd @reply, "$@", @res if @reply; 949link goes down.
420};
421 950
422=item time => @reply 951=item * Erlang can send messages to the wrong port, AEMP does not.
423 952
424Replies the the current node time to C<@reply>. 953In Erlang it is quite likely that a node that restarts reuses an Erlang
954process ID known to other nodes for a completely different process,
955causing messages destined for that process to end up in an unrelated
956process.
425 957
426Example: tell the current node to send the current time to C<$myport> in a 958AEMP does not reuse port IDs, so old messages or old port IDs floating
427C<timereply> message. 959around in the network will not be sent to an unrelated port.
428 960
429 snd $NODE, time => $myport, timereply => 1, 2; 961=item * Erlang uses unprotected connections, AEMP uses secure
430 # => snd $myport, timereply => 1, 2, <time> 962authentication and can use TLS.
431 963
432=cut 964AEMP can use a proven protocol - TLS - to protect connections and
965securely authenticate nodes.
433 966
434rcv "", time => sub { shift; snd @_, AE::time }; 967=item * The AEMP protocol is optimised for both text-based and binary
968communications.
969
970The AEMP protocol, unlike the Erlang protocol, supports both programming
971language independent text-only protocols (good for debugging), and binary,
972language-specific serialisers (e.g. Storable). By default, unless TLS is
973used, the protocol is actually completely text-based.
974
975It has also been carefully designed to be implementable in other languages
976with a minimum of work while gracefully degrading functionality to make the
977protocol simple.
978
979=item * AEMP has more flexible monitoring options than Erlang.
980
981In Erlang, you can chose to receive I<all> exit signals as messages or
982I<none>, there is no in-between, so monitoring single Erlang processes is
983difficult to implement.
984
985Monitoring in AEMP is more flexible than in Erlang, as one can choose
986between automatic kill, exit message or callback on a per-port basis.
987
988=item * Erlang tries to hide remote/local connections, AEMP does not.
989
990Monitoring in Erlang is not an indicator of process death/crashes, in the
991same way as linking is (except linking is unreliable in Erlang).
992
993In AEMP, you don't "look up" registered port names or send to named ports
994that might or might not be persistent. Instead, you normally spawn a port
995on the remote node. The init function monitors you, and you monitor the
996remote port. Since both monitors are local to the node, they are much more
997reliable (no need for C<spawn_link>).
998
999This also saves round-trips and avoids sending messages to the wrong port
1000(hard to do in Erlang).
435 1001
436=back 1002=back
437 1003
1004=head1 RATIONALE
1005
1006=over 4
1007
1008=item Why strings for port and node IDs, why not objects?
1009
1010We considered "objects", but found that the actual number of methods
1011that can be called are quite low. Since port and node IDs travel over
1012the network frequently, the serialising/deserialising would add lots of
1013overhead, as well as having to keep a proxy object everywhere.
1014
1015Strings can easily be printed, easily serialised etc. and need no special
1016procedures to be "valid".
1017
1018And as a result, a port with just a default receiver consists of a single
1019code reference stored in a global hash - it can't become much cheaper.
1020
1021=item Why favour JSON, why not a real serialising format such as Storable?
1022
1023In fact, any AnyEvent::MP node will happily accept Storable as framing
1024format, but currently there is no way to make a node use Storable by
1025default (although all nodes will accept it).
1026
1027The default framing protocol is JSON because a) JSON::XS is many times
1028faster for small messages and b) most importantly, after years of
1029experience we found that object serialisation is causing more problems
1030than it solves: Just like function calls, objects simply do not travel
1031easily over the network, mostly because they will always be a copy, so you
1032always have to re-think your design.
1033
1034Keeping your messages simple, concentrating on data structures rather than
1035objects, will keep your messages clean, tidy and efficient.
1036
1037=back
1038
438=head1 SEE ALSO 1039=head1 SEE ALSO
1040
1041L<AnyEvent::MP::Intro> - a gentle introduction.
1042
1043L<AnyEvent::MP::Kernel> - more, lower-level, stuff.
1044
1045L<AnyEvent::MP::Global> - network maintenance and port groups, to find
1046your applications.
1047
1048L<AnyEvent::MP::DataConn> - establish data connections between nodes.
1049
1050L<AnyEvent::MP::LogCatcher> - simple service to display log messages from
1051all nodes.
439 1052
440L<AnyEvent>. 1053L<AnyEvent>.
441 1054
442=head1 AUTHOR 1055=head1 AUTHOR
443 1056

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines