--- AnyEvent-MP/MP.pm 2009/08/04 14:10:51 1.21 +++ AnyEvent-MP/MP.pm 2012/03/08 21:37:51 1.129 @@ -1,37 +1,71 @@ =head1 NAME -AnyEvent::MP - multi-processing/message-passing framework +AnyEvent::MP - erlang-style multi-processing/message-passing framework =head1 SYNOPSIS use AnyEvent::MP; - NODE # returns this node identifier - $NODE # contains this node identifier + $NODE # contains this node's node ID + NODE # returns this node's node ID + $SELF # receiving/own port id in rcv callbacks + + # initialise the node so it can send/receive messages + configure; + + # ports are message destinations + + # sending messages snd $port, type => data...; + snd $port, @msg; + snd @msg_with_first_element_being_a_port; + + # creating/using ports, the simple way + my $simple_port = port { my @msg = @_ }; - rcv $port, smartmatch => $cb->($port, @msg); + # creating/using ports, tagged message matching + my $port = port; + rcv $port, ping => sub { snd $_[0], "pong" }; + rcv $port, pong => sub { warn "pong received\n" }; + + # create a port on another node + my $port = spawn $node, $initfunc, @initdata; + + # destroy a port again + kil $port; # "normal" kill + kil $port, my_error => "everything is broken"; # error kill + + # monitoring + mon $port, $cb->(@msg) # callback is invoked on death + mon $port, $localport # kill localport on abnormal death + mon $port, $localport, @msg # send message on death + + # temporarily execute code in port context + peval $port, sub { die "kill the port!" }; + + # execute callbacks in $SELF port context + my $timer = AE::timer 1, 0, psub { + die "kill the port, delayed"; + }; + +=head1 CURRENT STATUS - # examples: - rcv $port2, ping => sub { snd $_[0], "pong"; 0 }; - rcv $port1, pong => sub { warn "pong received\n" }; - snd $port2, ping => $port1; - - # more, smarter, matches (_any_ is exported by this module) - rcv $port, [child_died => $pid] => sub { ... - rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3 + bin/aemp - stable. + AnyEvent::MP - stable API, should work. + AnyEvent::MP::Intro - explains most concepts. + AnyEvent::MP::Kernel - mostly stable API. + AnyEvent::MP::Global - stable API. =head1 DESCRIPTION This module (-family) implements a simple message passing framework. Despite its simplicity, you can securely message other processes running -on the same or other hosts. +on the same or other hosts, and you can supervise entities remotely. -At the moment, this module family is severly brokena nd underdocumented, -so do not use. This was uploaded mainly to reserve the CPAN namespace - -stay tuned! +For an introduction to this module family, see the L +manual page and the examples under F. =head1 CONCEPTS @@ -39,30 +73,100 @@ =item port -A port is something you can send messages to with the C function, and -you can register C handlers with. All C handlers will receive -messages they match, messages will not be queued. +Not to be confused with a TCP port, a "port" is something you can send +messages to (with the C function). + +Ports allow you to register C handlers that can match all or just +some messages. Messages send to ports will not be queued, regardless of +anything was listening for them or not. + +Ports are represented by (printable) strings called "port IDs". -=item port id - C +=item port ID - C -A port id is always the noderef, a hash-mark (C<#>) as separator, followed -by a port name (a printable string of unspecified format). +A port ID is the concatenation of a node ID, a hash-mark (C<#>) +as separator, and a port name (a printable string of unspecified +format created by AnyEvent::MP). =item node -A node is a single process containing at least one port - the node -port. You can send messages to node ports to let them create new ports, -among other things. - -Initially, nodes are either private (single-process only) or hidden -(connected to a master node only). Only when they epxlicitly "become -public" can you send them messages from unrelated other nodes. - -=item noderef - C, C, C - -A noderef is a string that either uniquely identifies a given node (for -private and hidden nodes), or contains a recipe on how to reach a given -node (for public nodes). +A node is a single process containing at least one port - the node port, +which enables nodes to manage each other remotely, and to create new +ports. + +Nodes are either public (have one or more listening ports) or private +(no listening ports). Private nodes cannot talk to other private nodes +currently, but all nodes can talk to public nodes. + +Nodes is represented by (printable) strings called "node IDs". + +=item node ID - C<[A-Za-z0-9_\-.:]*> + +A node ID is a string that uniquely identifies the node within a +network. Depending on the configuration used, node IDs can look like a +hostname, a hostname and a port, or a random string. AnyEvent::MP itself +doesn't interpret node IDs in any way except to uniquely identify a node. + +=item binds - C + +Nodes can only talk to each other by creating some kind of connection to +each other. To do this, nodes should listen on one or more local transport +endpoints - binds. + +Currently, only standard C specifications can be used, which +specify TCP ports to listen on. So a bind is basically just a tcp socket +in listening mode thta accepts conenctions form other nodes. + +=item seed nodes + +When a node starts, it knows nothing about the network it is in - it +needs to connect to at least one other node that is already in the +network. These other nodes are called "seed nodes". + +Seed nodes themselves are not special - they are seed nodes only because +some other node I them as such, but any node can be used as seed +node for other nodes, and eahc node cna use a different set of seed nodes. + +In addition to discovering the network, seed nodes are also used to +maintain the network - all nodes using the same seed node form are part of +the same network. If a network is split into multiple subnets because e.g. +the network link between the parts goes down, then using the same seed +nodes for all nodes ensures that eventually the subnets get merged again. + +Seed nodes are expected to be long-running, and at least one seed node +should always be available. They should also be relatively responsive - a +seed node that blocks for long periods will slow down everybody else. + +For small networks, it's best if every node uses the same set of seed +nodes. For large networks, it can be useful to specify "regional" seed +nodes for most nodes in an area, and use all seed nodes as seed nodes for +each other. What's important is that all seed nodes connections form a +complete graph, so that the network cannot split into separate subnets +forever. + +Seed nodes are represented by seed IDs. + +=item seed IDs - C + +Seed IDs are transport endpoint(s) (usually a hostname/IP address and a +TCP port) of nodes that should be used as seed nodes. + +=item global nodes + +An AEMP network needs a discovery service - nodes need to know how to +connect to other nodes they only know by name. In addition, AEMP offers a +distributed "group database", which maps group names to a list of strings +- for example, to register worker ports. + +A network needs at least one global node to work, and allows every node to +be a global node. + +Any node that loads the L module becomes a global +node and tries to keep connections to all other nodes. So while it can +make sense to make every node "global" in small networks, it usually makes +sense to only make seed nodes into global nodes in large networks (nodes +keep connections to seed nodes and global nodes, so makign them the same +reduces overhead). =back @@ -74,72 +178,502 @@ package AnyEvent::MP; -use AnyEvent::MP::Base; +use AnyEvent::MP::Config (); +use AnyEvent::MP::Kernel; +use AnyEvent::MP::Kernel qw(%NODE %PORT %PORT_DATA $UNIQ $RUNIQ $ID); use common::sense; use Carp (); use AE (); +use Guard (); use base "Exporter"; -our $VERSION = '0.02'; +our $VERSION = $AnyEvent::MP::Config::VERSION; + our @EXPORT = qw( - NODE $NODE $PORT snd rcv mon kil _any_ - create_port create_port_on - miniport - become_slave become_public + NODE $NODE *SELF node_of after + configure + snd rcv mon mon_guard kil psub peval spawn cal + port + db_set db_del db_reg + db_mon db_family db_keys db_values ); -=item NODE / $NODE +our $SELF; + +sub _self_die() { + my $msg = $@; + $msg =~ s/\n+$// unless ref $msg; + kil $SELF, die => $msg; +} + +=item $thisnode = NODE / $NODE + +The C function returns, and the C<$NODE> variable contains, the node +ID of the node running in the current process. This value is initialised by +a call to C. + +=item $nodeid = node_of $port + +Extracts and returns the node ID from a port ID or a node ID. + +=item configure $profile, key => value... + +=item configure key => value... + +Before a node can talk to other nodes on the network (i.e. enter +"distributed mode") it has to configure itself - the minimum a node needs +to know is its own name, and optionally it should know the addresses of +some other nodes in the network to discover other nodes. + +This function configures a node - it must be called exactly once (or +never) before calling other AnyEvent::MP functions. + +The key/value pairs are basically the same ones as documented for the +F command line utility (sans the set/del prefix), with these additions: + +=over 4 + +=item norc => $boolean (default false) + +If true, then the rc file (e.g. F<~/.perl-anyevent-mp>) will I +be consulted - all configuraiton options must be specified in the +C call. + +=item force => $boolean (default false) + +IF true, then the values specified in the C will take +precedence over any values configured via the rc file. The default is for +the rc file to override any options specified in the program. + +=item secure => $pass->($nodeid) + +In addition to specifying a boolean, you can specify a code reference that +is called for every remote execution attempt - the execution request is +granted iff the callback returns a true value. + +See F for more info. + +=back + +=over 4 + +=item step 1, gathering configuration from profiles + +The function first looks up a profile in the aemp configuration (see the +L commandline utility). The profile name can be specified via the +named C parameter or can simply be the first parameter). If it is +missing, then the nodename (F) will be used as profile name. + +The profile data is then gathered as follows: + +First, all remaining key => value pairs (all of which are conveniently +undocumented at the moment) will be interpreted as configuration +data. Then they will be overwritten by any values specified in the global +default configuration (see the F utility), then the chain of +profiles chosen by the profile name (and any C attributes). + +That means that the values specified in the profile have highest priority +and the values specified directly via C have lowest priority, +and can only be used to specify defaults. + +If the profile specifies a node ID, then this will become the node ID of +this process. If not, then the profile name will be used as node ID, with +a unique randoms tring (C) appended. + +The node ID can contain some C<%> sequences that are expanded: C<%n> +is expanded to the local nodename, C<%u> is replaced by a random +strign to make the node unique. For example, the F commandline +utility uses C as nodename, which might expand to +C. + +=item step 2, bind listener sockets + +The next step is to look up the binds in the profile, followed by binding +aemp protocol listeners on all binds specified (it is possible and valid +to have no binds, meaning that the node cannot be contacted form the +outside. This means the node cannot talk to other nodes that also have no +binds, but it can still talk to all "normal" nodes). + +If the profile does not specify a binds list, then a default of C<*> is +used, meaning the node will bind on a dynamically-assigned port on every +local IP address it finds. + +=item step 3, connect to seed nodes + +As the last step, the seed ID list from the profile is passed to the +L module, which will then use it to keep +connectivity with at least one node at any point in time. + +=back + +Example: become a distributed node using the local node name as profile. +This should be the most common form of invocation for "daemon"-type nodes. + + configure + +Example: become a semi-anonymous node. This form is often used for +commandline clients. + + configure nodeid => "myscript/%n/%u"; + +Example: configure a node using a profile called seed, which is suitable +for a seed node as it binds on all local addresses on a fixed port (4040, +customary for aemp). + + # use the aemp commandline utility + # aemp profile seed binds '*:4040' -The C function and the C<$NODE> variable contain the noderef of -the local node. The value is initialised by a call to C or -C, after which all local port identifiers become invalid. + # then use it + configure profile => "seed"; -=item snd $portid, type => @data + # or simply use aemp from the shell again: + # aemp run profile seed -=item snd $portid, @msg + # or provide a nicer-to-remember nodeid + # aemp run profile seed nodeid "$(hostname)" -Send the given message to the given port ID, which can identify either -a local or a remote port, and can be either a string or soemthignt hat -stringifies a sa port ID (such as a port object :). +=item $SELF -While the message can be about anything, it is highly recommended to use a -string as first element (a portid, or some word that indicates a request -type etc.). +Contains the current port id while executing C callbacks or C +blocks. -The message data effectively becomes read-only after a call to this -function: modifying any argument is not allowed and can cause many -problems. +=item *SELF, SELF, %SELF, @SELF... + +Due to some quirks in how perl exports variables, it is impossible to +just export C<$SELF>, all the symbols named C are exported by this +module, but only C<$SELF> is currently used. + +=item snd $port, type => @data + +=item snd $port, @msg + +Send the given message to the given port, which can identify either a +local or a remote port, and must be a port ID. + +While the message can be almost anything, it is highly recommended to +use a string as first element (a port ID, or some word that indicates a +request type etc.) and to consist if only simple perl values (scalars, +arrays, hashes) - if you think you need to pass an object, think again. + +The message data logically becomes read-only after a call to this +function: modifying any argument (or values referenced by them) is +forbidden, as there can be considerable time between the call to C +and the time the message is actually being serialised - in fact, it might +never be copied as within the same process it is simply handed to the +receiving port. The type of data you can transfer depends on the transport protocol: when JSON is used, then only strings, numbers and arrays and hashes consisting of those are allowed (no objects). When Storable is used, then anything that Storable can serialise and deserialise is allowed, and for the local -node, anything can be passed. +node, anything can be passed. Best rely only on the common denominator of +these. + +=item $local_port = port + +Create a new local port object and returns its port ID. Initially it has +no callbacks set and will throw an error when it receives messages. + +=item $local_port = port { my @msg = @_ } + +Creates a new local port, and returns its ID. Semantically the same as +creating a port and calling C on it. + +The block will be called for every message received on the port, with the +global variable C<$SELF> set to the port ID. Runtime errors will cause the +port to be Ced. The message will be passed as-is, no extra argument +(i.e. no port ID) will be passed to the callback. + +If you want to stop/destroy the port, simply C it: + + my $port = port { + my @msg = @_; + ... + kil $SELF; + }; + +=cut + +sub rcv($@); + +sub _kilme { + die "received message on port without callback"; +} + +sub port(;&) { + my $id = $UNIQ . ++$ID; + my $port = "$NODE#$id"; + + rcv $port, shift || \&_kilme; + + $port +} + +=item rcv $local_port, $callback->(@msg) + +Replaces the default callback on the specified port. There is no way to +remove the default callback: use C to disable it, or better +C the port when it is no longer needed. + +The global C<$SELF> (exported by this module) contains C<$port> while +executing the callback. Runtime errors during callback execution will +result in the port being Ced. + +The default callback received all messages not matched by a more specific +C match. + +=item rcv $local_port, tag => $callback->(@msg_without_tag), ... + +Register (or replace) callbacks to be called on messages starting with the +given tag on the given port (and return the port), or unregister it (when +C<$callback> is C<$undef> or missing). There can only be one callback +registered for each tag. + +The original message will be passed to the callback, after the first +element (the tag) has been removed. The callback will use the same +environment as the default callback (see above). + +Example: create a port and bind receivers on it in one go. + + my $port = rcv port, + msg1 => sub { ... }, + msg2 => sub { ... }, + ; + +Example: create a port, bind receivers and send it in a message elsewhere +in one go: + + snd $otherport, reply => + rcv port, + msg1 => sub { ... }, + ... + ; + +Example: temporarily register a rcv callback for a tag matching some port +(e.g. for an rpc reply) and unregister it after a message was received. + + rcv $port, $otherport => sub { + my @reply = @_; + + rcv $SELF, $otherport; + }; + +=cut + +sub rcv($@) { + my $port = shift; + my ($nodeid, $portid) = split /#/, $port, 2; + + $NODE{$nodeid} == $NODE{""} + or Carp::croak "$port: rcv can only be called on local ports, caught"; + + while (@_) { + if (ref $_[0]) { + if (my $self = $PORT_DATA{$portid}) { + "AnyEvent::MP::Port" eq ref $self + or Carp::croak "$port: rcv can only be called on message matching ports, caught"; + + $self->[0] = shift; + } else { + my $cb = shift; + $PORT{$portid} = sub { + local $SELF = $port; + eval { &$cb }; _self_die if $@; + }; + } + } elsif (defined $_[0]) { + my $self = $PORT_DATA{$portid} ||= do { + my $self = bless [$PORT{$portid} || sub { }, { }, $port], "AnyEvent::MP::Port"; + + $PORT{$portid} = sub { + local $SELF = $port; + + if (my $cb = $self->[1]{$_[0]}) { + shift; + eval { &$cb }; _self_die if $@; + } else { + &{ $self->[0] }; + } + }; + + $self + }; + + "AnyEvent::MP::Port" eq ref $self + or Carp::croak "$port: rcv can only be called on message matching ports, caught"; + + my ($tag, $cb) = splice @_, 0, 2; + + if (defined $cb) { + $self->[1]{$tag} = $cb; + } else { + delete $self->[1]{$tag}; + } + } + } + + $port +} + +=item peval $port, $coderef[, @args] + +Evaluates the given C<$codref> within the contetx of C<$port>, that is, +when the code throews an exception the C<$port> will be killed. + +Any remaining args will be passed to the callback. Any return values will +be returned to the caller. + +This is useful when you temporarily want to execute code in the context of +a port. + +Example: create a port and run some initialisation code in it's context. + + my $port = port { ... }; + + peval $port, sub { + init + or die "unable to init"; + }; + +=cut + +sub peval($$) { + local $SELF = shift; + my $cb = shift; + + if (wantarray) { + my @res = eval { &$cb }; + _self_die if $@; + @res + } else { + my $res = eval { &$cb }; + _self_die if $@; + $res + } +} + +=item $closure = psub { BLOCK } + +Remembers C<$SELF> and creates a closure out of the BLOCK. When the +closure is executed, sets up the environment in the same way as in C +callbacks, i.e. runtime errors will cause the port to get Ced. + +The effect is basically as if it returned C<< sub { peval $SELF, sub { +BLOCK }, @_ } >>. + +This is useful when you register callbacks from C callbacks: + + rcv delayed_reply => sub { + my ($delay, @reply) = @_; + my $timer = AE::timer $delay, 0, psub { + snd @reply, $SELF; + }; + }; + +=cut + +sub psub(&) { + my $cb = shift; + + my $port = $SELF + or Carp::croak "psub can only be called from within rcv or psub callbacks, not"; + + sub { + local $SELF = $port; + + if (wantarray) { + my @res = eval { &$cb }; + _self_die if $@; + @res + } else { + my $res = eval { &$cb }; + _self_die if $@; + $res + } + } +} + +=item $guard = mon $port, $cb->(@reason) # call $cb when $port dies -=item $guard = mon $portid, $cb->() +=item $guard = mon $port, $rcvport # kill $rcvport when $port dies -=item $guard = mon $portid, $otherport +=item $guard = mon $port # kill $SELF when $port dies -=item $guard = mon $portid, $otherport, @msg +=item $guard = mon $port, $rcvport, @msg # send a message when $port dies -Monitor the given port and call the given callback when the port is -destroyed or connection to it's node is lost. +Monitor the given port and do something when the port is killed or +messages to it were lost, and optionally return a guard that can be used +to stop monitoring again. -#TODO +In the first form (callback), the callback is simply called with any +number of C<@reason> elements (no @reason means that the port was deleted +"normally"). Note also that I<< the callback B never die >>, so use +C if unsure. + +In the second form (another port given), the other port (C<$rcvport>) +will be C'ed with C<@reason>, if a @reason was specified, i.e. on +"normal" kils nothing happens, while under all other conditions, the other +port is killed with the same reason. + +The third form (kill self) is the same as the second form, except that +C<$rvport> defaults to C<$SELF>. + +In the last form (message), a message of the form C<@msg, @reason> will be +C. + +Monitoring-actions are one-shot: once messages are lost (and a monitoring +alert was raised), they are removed and will not trigger again. + +As a rule of thumb, monitoring requests should always monitor a port from +a local port (or callback). The reason is that kill messages might get +lost, just like any other message. Another less obvious reason is that +even monitoring requests can get lost (for example, when the connection +to the other node goes down permanently). When monitoring a port locally +these problems do not exist. + +C effectively guarantees that, in the absence of hardware failures, +after starting the monitor, either all messages sent to the port will +arrive, or the monitoring action will be invoked after possible message +loss has been detected. No messages will be lost "in between" (after +the first lost message no further messages will be received by the +port). After the monitoring action was invoked, further messages might get +delivered again. + +Inter-host-connection timeouts and monitoring depend on the transport +used. The only transport currently implemented is TCP, and AnyEvent::MP +relies on TCP to detect node-downs (this can take 10-15 minutes on a +non-idle connection, and usually around two hours for idle connections). + +This means that monitoring is good for program errors and cleaning up +stuff eventually, but they are no replacement for a timeout when you need +to ensure some maximum latency. + +Example: call a given callback when C<$port> is killed. + + mon $port, sub { warn "port died because of <@_>\n" }; + +Example: kill ourselves when C<$port> is killed abnormally. + + mon $port; + +Example: send us a restart message when another C<$port> is killed. + + mon $port, $self => "restart"; =cut sub mon { - my ($noderef, $port, $cb) = ((split /#/, shift, 2), shift); + my ($nodeid, $port) = split /#/, shift, 2; - my $node = AnyEvent::MP::Base::add_node $noderef; + my $node = $NODE{$nodeid} || add_node $nodeid; - #TODO: ports must not be references - if (!ref $cb or "AnyEvent::MP::Port" eq ref $cb) { + my $cb = @_ ? shift : $SELF || Carp::croak 'mon: called with one argument only, but $SELF not set,'; + + unless (ref $cb) { if (@_) { # send a kill info message my (@msg) = ($cb, @_); @@ -147,14 +681,14 @@ } else { # simply kill other port my $port = $cb; - $cb = sub { kil $port, @_ }; + $cb = sub { kil $port, @_ if @_ }; } } $node->monitor ($port, $cb); defined wantarray - and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) } + and ($cb += 0, Guard::guard { $node->unmonitor ($port, $cb) }) } =item $guard = mon_guard $port, $ref, $ref... @@ -165,10 +699,10 @@ Optionally returns a guard that will stop the monitoring. This function is useful when you create e.g. timers or other watchers and -want to free them when the port gets killed: +want to free them when the port gets killed (note the use of C): $port->rcv (start => sub { - my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub { + my $timer; $timer = mon_guard $port, AE::timer 1, 1, psub { undef $timer if 0.9 < rand; }); }); @@ -178,245 +712,506 @@ sub mon_guard { my ($port, @refs) = @_; + #TODO: mon-less form? + mon $port, sub { 0 && @refs } } -=item $local_port = create_port +=item kil $port[, @reason] -Create a new local port object. See the next section for allowed methods. +Kill the specified port with the given C<@reason>. + +If no C<@reason> is specified, then the port is killed "normally" - +monitor callback will be invoked, but the kil will not cause linked ports +(C form) to get killed. + +If a C<@reason> is specified, then linked ports (C +form) get killed with the same reason. + +Runtime errors while evaluating C callbacks or inside C blocks +will be reported as reason C<< die => $@ >>. + +Transport/communication errors are reported as C<< transport_error => +$message >>. =cut -sub create_port { - my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++; +=item $port = spawn $node, $initfunc[, @initdata] - my $self = bless { - id => "$NODE#$id", - }, "AnyEvent::MP::Port"; +Creates a port on the node C<$node> (which can also be a port ID, in which +case it's the node where that port resides). - $AnyEvent::MP::Base::PORT{$id} = sub { - unshift @_, $self; +The port ID of the newly created port is returned immediately, and it is +possible to immediately start sending messages or to monitor the port. - for (@{ $self->{rc0}{$_[1]} }) { - $_ && &{$_->[0]} - && undef $_; - } +After the port has been created, the init function is called on the remote +node, in the same context as a C callback. This function must be a +fully-qualified function name (e.g. C). To +specify a function in the main program, use C<::name>. - for (@{ $self->{rcv}{$_[1]} }) { - $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1] - && &{$_->[0]} - && undef $_; - } +If the function doesn't exist, then the node tries to C +the package, then the package above the package and so on (e.g. +C, C, C) until the function +exists or it runs out of package names. - for (@{ $self->{any} }) { - $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1] - && &{$_->[0]} - && undef $_; - } - }; +The init function is then called with the newly-created port as context +object (C<$SELF>) and the C<@initdata> values as arguments. It I +call one of the C functions to set callbacks on C<$SELF>, otherwise +the port might not get created. - $self -} +A common idiom is to pass a local port, immediately monitor the spawned +port, and in the remote init function, immediately monitor the passed +local port. This two-way monitoring ensures that both ports get cleaned up +when there is a problem. -=item $portid = miniport { my @msg = @_; $finished } +C guarantees that the C<$initfunc> has no visible effects on the +caller before C returns (by delaying invocation when spawn is +called for the local node). -Creates a "mini port", that is, a very lightweight port without any -pattern matching behind it, and returns its ID. +Example: spawn a chat server port on C<$othernode>. -The block will be called for every message received on the port. When the -callback returns a true value its job is considered "done" and the port -will be destroyed. Otherwise it will stay alive. + # this node, executed from within a port context: + my $server = spawn $othernode, "MyApp::Chat::Server::connect", $SELF; + mon $server; -The message will be passed as-is, no extra argument (i.e. no port id) will -be passed to the callback. + # init function on C<$othernode> + sub connect { + my ($srcport) = @_; -If you need the local port id in the callback, this works nicely: + mon $srcport; - my $port; $port = miniport { - snd $otherport, reply => $port; - }; + rcv $SELF, sub { + ... + }; + } =cut -sub miniport(&) { - my $cb = shift; - my $id = "$AnyEvent::MP::Base::UNIQ." . $AnyEvent::MP::Base::ID++; - - $AnyEvent::MP::Base::PORT{$id} = sub { - &$cb - and kil $id; +sub _spawn { + my $port = shift; + my $init = shift; + + # rcv will create the actual port + local $SELF = "$NODE#$port"; + eval { + &{ load_func $init } }; - - "$NODE#$id" + _self_die if $@; } -package AnyEvent::MP::Port; +sub spawn(@) { + my ($nodeid, undef) = split /#/, shift, 2; -=back + my $id = $RUNIQ . ++$ID; -=head1 METHODS FOR PORT OBJECTS + $_[0] =~ /::/ + or Carp::croak "spawn init function must be a fully-qualified name, caught"; -=over 4 + snd_to_func $nodeid, "AnyEvent::MP::_spawn" => $id, @_; -=item "$port" + "$nodeid#$id" +} + + +=item after $timeout, @msg + +=item after $timeout, $callback -A port object stringifies to its port ID, so can be used directly for -C operations. +Either sends the given message, or call the given callback, after the +specified number of seconds. + +This is simply a utility function that comes in handy at times - the +AnyEvent::MP author is not convinced of the wisdom of having it, though, +so it may go away in the future. =cut -use overload - '""' => sub { $_[0]{id} }, - fallback => 1; +sub after($@) { + my ($timeout, @action) = @_; -sub TO_JSON { $_[0]{id} } + my $t; $t = AE::timer $timeout, 0, sub { + undef $t; + ref $action[0] + ? $action[0]() + : snd @action; + }; +} -=item $port->rcv (type => $callback->($port, @msg)) +#=item $cb2 = timeout $seconds, $cb[, @args] -=item $port->rcv ($smartmatch => $callback->($port, @msg)) +=item cal $port, @msg, $callback[, $timeout] -=item $port->rcv ([$smartmatch...] => $callback->($port, @msg)) +A simple form of RPC - sends a message to the given C<$port> with the +given contents (C<@msg>), but adds a reply port to the message. -Register a callback on the given port. +The reply port is created temporarily just for the purpose of receiving +the reply, and will be Ced when no longer needed. -The callback has to return a true value when its work is done, after -which is will be removed, or a false value in which case it will stay -registered. +A reply message sent to the port is passed to the C<$callback> as-is. -If the match is an array reference, then it will be matched against the -first elements of the message, otherwise only the first element is being -matched. +If an optional time-out (in seconds) is given and it is not C, +then the callback will be called without any arguments after the time-out +elapsed and the port is Ced. -Any element in the match that is specified as C<_any_> (a function -exported by this module) matches any single element of the message. +If no time-out is given (or it is C), then the local port will +monitor the remote port instead, so it eventually gets cleaned-up. -While not required, it is highly recommended that the first matching -element is a string identifying the message. The one-string-only match is -also the most efficient match (by far). +Currently this function returns the temporary port, but this "feature" +might go in future versions unless you can make a convincing case that +this is indeed useful for something. =cut -sub rcv($@) { - my ($self, $match, $cb) = @_; +sub cal(@) { + my $timeout = ref $_[-1] ? undef : pop; + my $cb = pop; + + my $port = port { + undef $timeout; + kil $SELF; + &$cb; + }; - if (!ref $match) { - push @{ $self->{rc0}{$match} }, [$cb]; - } elsif (("ARRAY" eq ref $match && !ref $match->[0])) { - my ($type, @match) = @$match; - @match - ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match] - : push @{ $self->{rc0}{$match->[0]} }, [$cb]; + if (defined $timeout) { + $timeout = AE::timer $timeout, 0, sub { + undef $timeout; + kil $port; + $cb->(); + }; } else { - push @{ $self->{any} }, [$cb, $match]; + mon $_[0], sub { + kil $port; + $cb->(); + }; } + + push @_, $port; + &snd; + + $port } -=item $port->register ($name) +=back -Registers the given port under the well known name C<$name>. If the name -already exists it is replaced. +=head1 DISTRIBUTED DATABASE -A port can only be registered under one well known name. +AnyEvent::MP comes with a simple distributed database. The database will +be mirrored asynchronously at all global nodes. Other nodes bind to one of +the global nodes for their needs. -=cut +The database consists of a two-level hash - a hash contains a hash which +contains values. -sub register { - my ($self, $name) = @_; +The top level hash key is called "family", and the second-level hash key +is called "subkey" or simply "key". - $self->{wkname} = $name; - $AnyEvent::MP::Base::WKP{$name} = "$self"; -} +The family must be alphanumeric, i.e. start with a letter and consist +of letters, digits, underscores and colons (C<[A-Za-z][A-Za-z0-9_:]*>, +pretty much like Perl module names. -=item $port->destroy +As the family namespace is global, it is recommended to prefix family names +with the name of the application or module using it. -Explicitly destroy/remove/nuke/vaporise the port. +The subkeys must be non-empty strings, with no further restrictions. -Ports are normally kept alive by their mere existance alone, and need to -be destroyed explicitly. +The values should preferably be strings, but other perl scalars should +work as well (such as undef, arrays and hashes). -=cut +Every database entry is owned by one node - adding the same family/subkey +combination on multiple nodes will not cause discomfort for AnyEvent::MP, +but the result might be nondeterministic, i.e. the key might have +different values on different nodes. -sub destroy { - my ($self) = @_; +Different subkeys in the same family can be owned by different nodes +without problems, and in fact, this is the common method to create worker +pools. For example, a worker port for image scaling might do this: - delete $AnyEvent::MP::Base::WKP{ $self->{wkname} }; + db_set my_image_scalers => $port; - AnyEvent::MP::Base::kil $self->{id}; -} +And clients looking for an image scaler will want to get the +C keys from time to time: -=back + db_keys my_image_scalers => sub { + @ports = @{ $_[0] }; + }; -=head1 FUNCTIONS FOR NODES +Or better yet, they want to monitor the database family, so they always +have a reasonable up-to-date copy: -=over 4 + db_mon my_image_scalers => sub { + @ports = keys %{ $_[0] }; + }; + +In general, you can set or delete single subkeys, but query and monitor +whole families only. + +If you feel the need to monitor or query a single subkey, try giving it +it's own family. + +=over + +=item db_set $family => $subkey [=> $value] + +Sets (or replaces) a key to the database - if C<$value> is omitted, +C is used instead. + +=item db_del $family => $subkey + +Deletes a key from the database. + +=item $guard = db_reg $family => $subkey [=> $value] + +Sets the key on the database and returns a guard. When the guard is +destroyed, the key is deleted from the database. If C<$value> is missing, +then C is used. + +=item db_family $family => $cb->(\%familyhash) + +Queries the named database C<$family> and call the callback with the +family represented as a hash. You can keep and freely modify the hash. -=item mon $noderef, $callback->($noderef, $status, $) +=item db_keys $family => $cb->(\@keys) -Monitors the given noderef. +Same as C, except it only queries the family I and passes +them as array reference to the callback. -=item become_public endpoint... +=item db_values $family => $cb->(\@values) -Tells the node to become a public node, i.e. reachable from other nodes. +Same as C, except it only queries the family I and passes them +as array reference to the callback. -If no arguments are given, or the first argument is C, then -AnyEvent::MP tries to bind on port C<4040> on all IP addresses that the -local nodename resolves to. +=item $guard = db_mon $family => $cb->($familyhash, \@subkeys...) -Otherwise the first argument must be an array-reference with transport -endpoints ("ip:port", "hostname:port") or port numbers (in which case the -local nodename is used as hostname). The endpoints are all resolved and -will become the node reference. +Creates a monitor on the given database family. Each time a key is set or +or is deleted the callback is called with a hash containing the database +family and an arrayref with subkeys that have changed. + +Specifically, if one of the passed subkeys exists in the $familyhash, then +it is currently set to the value in the $familyhash. Otherwise, it has +been deleted. + +The family hash reference belongs to AnyEvent::MP and B by the callback. When in doubt, make a copy. + +The first call will be with the current contents of the family and all +keys, as if they were just added. + +It is possible that the callback is called with a change event even though +the subkey is already present and the value has not changed. + +The monitoring stops when the guard object is destroyed. + +Example: on every change to the family "mygroup", print out all keys. + + my $guard = db_mon mygroup => sub { + my ($family, $keys) = @_; + print "mygroup members: ", (join " ", keys %$family), "\n"; + }; + +Exmaple: wait until the family "My::Module::workers" is non-empty. + + my $guard; $guard = db_mon My::Module::workers => sub { + my ($family, $keys) = @_; + return unless %$family; + undef $guard; + print "My::Module::workers now nonempty\n"; + }; + +Example: print all changes to the family "AnyRvent::Fantasy::Module". + + my $guard = db_mon AnyRvent::Fantasy::Module => sub { + my ($family, $keys) = @_; + + for (@$keys) { + print "$_: ", + (exists $family->{$_} + ? $family->{$_} + : "(deleted)"), + "\n"; + } + }; =cut =back -=head1 NODE MESSAGES +=head1 AnyEvent::MP vs. Distributed Erlang -Nodes understand the following messages sent to them. Many of them take -arguments called C<@reply>, which will simply be used to compose a reply -message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and -the remaining arguments are simply the message data. +AnyEvent::MP got lots of its ideas from distributed Erlang (Erlang node +== aemp node, Erlang process == aemp port), so many of the documents and +programming techniques employed by Erlang apply to AnyEvent::MP. Here is a +sample: + + http://www.erlang.se/doc/programming_rules.shtml + http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4 + http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6 + http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5 + +Despite the similarities, there are also some important differences: =over 4 -=cut +=item * Node IDs are arbitrary strings in AEMP. + +Erlang relies on special naming and DNS to work everywhere in the same +way. AEMP relies on each node somehow knowing its own address(es) (e.g. by +configuration or DNS), and possibly the addresses of some seed nodes, but +will otherwise discover other nodes (and their IDs) itself. + +=item * Erlang has a "remote ports are like local ports" philosophy, AEMP +uses "local ports are like remote ports". + +The failure modes for local ports are quite different (runtime errors +only) then for remote ports - when a local port dies, you I it dies, +when a connection to another node dies, you know nothing about the other +port. + +Erlang pretends remote ports are as reliable as local ports, even when +they are not. + +AEMP encourages a "treat remote ports differently" philosophy, with local +ports being the special case/exception, where transport errors cannot +occur. + +=item * Erlang uses processes and a mailbox, AEMP does not queue. + +Erlang uses processes that selectively receive messages out of order, and +therefore needs a queue. AEMP is event based, queuing messages would serve +no useful purpose. For the same reason the pattern-matching abilities +of AnyEvent::MP are more limited, as there is little need to be able to +filter messages without dequeuing them. + +This is not a philosophical difference, but simply stems from AnyEvent::MP +being event-based, while Erlang is process-based. + +You cna have a look at L for a more Erlang-like process model on +top of AEMP and Coro threads. + +=item * Erlang sends are synchronous, AEMP sends are asynchronous. + +Sending messages in Erlang is synchronous and blocks the process until +a conenction has been established and the message sent (and so does not +need a queue that can overflow). AEMP sends return immediately, connection +establishment is handled in the background. + +=item * Erlang suffers from silent message loss, AEMP does not. + +Erlang implements few guarantees on messages delivery - messages can get +lost without any of the processes realising it (i.e. you send messages a, +b, and c, and the other side only receives messages a and c). + +AEMP guarantees (modulo hardware errors) correct ordering, and the +guarantee that after one message is lost, all following ones sent to the +same port are lost as well, until monitoring raises an error, so there are +no silent "holes" in the message sequence. -=item wkp => $name, @reply +If you want your software to be very reliable, you have to cope with +corrupted and even out-of-order messages in both Erlang and AEMP. AEMP +simply tries to work better in common error cases, such as when a network +link goes down. -Replies with the port ID of the specified well-known port, or C. +=item * Erlang can send messages to the wrong port, AEMP does not. -=item devnull => ... +In Erlang it is quite likely that a node that restarts reuses an Erlang +process ID known to other nodes for a completely different process, +causing messages destined for that process to end up in an unrelated +process. -Generic data sink/CPU heat conversion. +AEMP does not reuse port IDs, so old messages or old port IDs floating +around in the network will not be sent to an unrelated port. -=item relay => $port, @msg +=item * Erlang uses unprotected connections, AEMP uses secure +authentication and can use TLS. -Simply forwards the message to the given port. +AEMP can use a proven protocol - TLS - to protect connections and +securely authenticate nodes. -=item eval => $string[ @reply] +=item * The AEMP protocol is optimised for both text-based and binary +communications. -Evaluates the given string. If C<@reply> is given, then a message of the -form C<@reply, $@, @evalres> is sent. +The AEMP protocol, unlike the Erlang protocol, supports both programming +language independent text-only protocols (good for debugging), and binary, +language-specific serialisers (e.g. Storable). By default, unless TLS is +used, the protocol is actually completely text-based. -Example: crash another node. +It has also been carefully designed to be implementable in other languages +with a minimum of work while gracefully degrading functionality to make the +protocol simple. - snd $othernode, eval => "exit"; +=item * AEMP has more flexible monitoring options than Erlang. -=item time => @reply +In Erlang, you can chose to receive I exit signals as messages or +I, there is no in-between, so monitoring single Erlang processes is +difficult to implement. -Replies the the current node time to C<@reply>. +Monitoring in AEMP is more flexible than in Erlang, as one can choose +between automatic kill, exit message or callback on a per-port basis. -Example: tell the current node to send the current time to C<$myport> in a -C message. +=item * Erlang tries to hide remote/local connections, AEMP does not. - snd $NODE, time => $myport, timereply => 1, 2; - # => snd $myport, timereply => 1, 2,