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.1 by root, Thu Jul 30 08:38:50 2009 UTC vs.
Revision 1.33 by root, Wed Aug 5 22:40:51 2009 UTC

4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use AnyEvent::MP; 7 use AnyEvent::MP;
8 8
9 $NODE # contains this node's noderef
10 NODE # returns this node's noderef
11 NODE $port # returns the noderef of the port
12
13 snd $port, type => data...;
14
15 $SELF # receiving/own port id in rcv callbacks
16
17 rcv $port, smartmatch => $cb->($port, @msg);
18
19 # examples:
20 rcv $port2, ping => sub { snd $_[0], "pong"; 0 };
21 rcv $port1, pong => sub { warn "pong received\n" };
22 snd $port2, ping => $port1;
23
24 # more, smarter, matches (_any_ is exported by this module)
25 rcv $port, [child_died => $pid] => sub { ...
26 rcv $port, [_any_, _any_, 3] => sub { .. $_[2] is 3
27
9=head1 DESCRIPTION 28=head1 DESCRIPTION
10 29
30This module (-family) implements a simple message passing framework.
31
32Despite its simplicity, you can securely message other processes running
33on the same or other hosts.
34
35For an introduction to this module family, see the L<AnyEvent::MP::Intro>
36manual page.
37
38At the moment, this module family is severly broken and underdocumented,
39so do not use. This was uploaded mainly to reserve the CPAN namespace -
40stay tuned! The basic API should be finished, however.
41
42=head1 CONCEPTS
43
44=over 4
45
46=item port
47
48A port is something you can send messages to (with the C<snd> function).
49
50Some ports allow you to register C<rcv> handlers that can match specific
51messages. All C<rcv> handlers will receive messages they match, messages
52will not be queued.
53
54=item port id - C<noderef#portname>
55
56A port id is normaly the concatenation of a noderef, a hash-mark (C<#>) as
57separator, and a port name (a printable string of unspecified format). An
58exception is the the node port, whose ID is identical to its node
59reference.
60
61=item node
62
63A node is a single process containing at least one port - the node
64port. You can send messages to node ports to find existing ports or to
65create new ports, among other things.
66
67Nodes are either private (single-process only), slaves (connected to a
68master node only) or public nodes (connectable from unrelated nodes).
69
70=item noderef - C<host:port,host:port...>, C<id@noderef>, C<id>
71
72A node reference is a string that either simply identifies the node (for
73private and slave nodes), or contains a recipe on how to reach a given
74node (for public nodes).
75
76This recipe is simply a comma-separated list of C<address:port> pairs (for
77TCP/IP, other protocols might look different).
78
79Node references come in two flavours: resolved (containing only numerical
80addresses) or unresolved (where hostnames are used instead of addresses).
81
82Before using an unresolved node reference in a message you first have to
83resolve it.
84
85=back
86
87=head1 VARIABLES/FUNCTIONS
88
89=over 4
90
11=cut 91=cut
12 92
13package AnyEvent::MP; 93package AnyEvent::MP;
14 94
95use AnyEvent::MP::Base;
96
15use common::sense; 97use common::sense;
16 98
99use Carp ();
100
17use AE (); 101use AE ();
18 102
103use base "Exporter";
104
19our $VERSION = '0.0'; 105our $VERSION = '0.1';
106our @EXPORT = qw(
107 NODE $NODE *SELF node_of _any_
108 resolve_node initialise_node
109 snd rcv mon kil reg psub
110 port
111);
20 112
21sub nonce($) { 113our $SELF;
22 my $nonce;
23 114
24 if (open my $fh, "</dev/urandom") { 115sub _self_die() {
25 sysread $fh, $nonce, $_[0]; 116 my $msg = $@;
117 $msg =~ s/\n+$// unless ref $msg;
118 kil $SELF, die => $msg;
119}
120
121=item $thisnode = NODE / $NODE
122
123The C<NODE> function returns, and the C<$NODE> variable contains
124the noderef of the local node. The value is initialised by a call
125to C<become_public> or C<become_slave>, after which all local port
126identifiers become invalid.
127
128=item $noderef = node_of $port
129
130Extracts and returns the noderef from a portid or a noderef.
131
132=item $cv = resolve_node $noderef
133
134Takes an unresolved node reference that may contain hostnames and
135abbreviated IDs, resolves all of them and returns a resolved node
136reference.
137
138In addition to C<address:port> pairs allowed in resolved noderefs, the
139following forms are supported:
140
141=over 4
142
143=item the empty string
144
145An empty-string component gets resolved as if the default port (4040) was
146specified.
147
148=item naked port numbers (e.g. C<1234>)
149
150These are resolved by prepending the local nodename and a colon, to be
151further resolved.
152
153=item hostnames (e.g. C<localhost:1234>, C<localhost>)
154
155These are resolved by using AnyEvent::DNS to resolve them, optionally
156looking up SRV records for the C<aemp=4040> port, if no port was
157specified.
158
159=back
160
161=item $SELF
162
163Contains the current port id while executing C<rcv> callbacks or C<psub>
164blocks.
165
166=item SELF, %SELF, @SELF...
167
168Due to some quirks in how perl exports variables, it is impossible to
169just export C<$SELF>, all the symbols called C<SELF> are exported by this
170module, but only C<$SELF> is currently used.
171
172=item snd $port, type => @data
173
174=item snd $port, @msg
175
176Send the given message to the given port ID, which can identify either
177a local or a remote port, and can be either a string or soemthignt hat
178stringifies a sa port ID (such as a port object :).
179
180While the message can be about anything, it is highly recommended to use a
181string as first element (a portid, or some word that indicates a request
182type etc.).
183
184The message data effectively becomes read-only after a call to this
185function: modifying any argument is not allowed and can cause many
186problems.
187
188The type of data you can transfer depends on the transport protocol: when
189JSON is used, then only strings, numbers and arrays and hashes consisting
190of those are allowed (no objects). When Storable is used, then anything
191that Storable can serialise and deserialise is allowed, and for the local
192node, anything can be passed.
193
194=item $local_port = port
195
196Create a new local port object that can be used either as a pattern
197matching port ("full port") or a single-callback port ("miniport"),
198depending on how C<rcv> callbacks are bound to the object.
199
200=item $port = port { my @msg = @_; $finished }
201
202Creates a "miniport", that is, a very lightweight port without any pattern
203matching behind it, and returns its ID. Semantically the same as creating
204a port and calling C<rcv $port, $callback> on it.
205
206The block will be called for every message received on the port. When the
207callback returns a true value its job is considered "done" and the port
208will be destroyed. Otherwise it will stay alive.
209
210The message will be passed as-is, no extra argument (i.e. no port id) will
211be passed to the callback.
212
213If you need the local port id in the callback, this works nicely:
214
215 my $port; $port = port {
216 snd $otherport, reply => $port;
217 };
218
219=cut
220
221sub rcv($@);
222
223sub port(;&) {
224 my $id = "$UNIQ." . $ID++;
225 my $port = "$NODE#$id";
226
227 if (@_) {
228 rcv $port, shift;
26 } else { 229 } else {
27 # shit... 230 $PORT{$id} = sub { }; # nop
28 our $nonce_init;
29 unless ($nonce_init++) {
30 srand time ^ $$ ^ unpack "%L*", qx"ps -edalf" . qx"ipconfig /all";
31 }
32
33 $nonce = join "", map +(chr rand 256), 1 .. $_[0]
34 } 231 }
35 232
36 $nonce 233 $port
37} 234}
38 235
39our $DEFAULT_SECRET; 236=item reg $port, $name
40 237
41sub default_secret { 238Registers the given port under the name C<$name>. If the name already
42 unless (defined $DEFAULT_SECRET) { 239exists it is replaced.
43 if (open my $fh, "<$ENV{HOME}/.aemp-secret") { 240
44 sysread $fh, $DEFAULT_SECRET, -s $fh; 241A port can only be registered under one well known name.
242
243A port automatically becomes unregistered when it is killed.
244
245=cut
246
247sub reg(@) {
248 my ($port, $name) = @_;
249
250 $REG{$name} = $port;
251}
252
253=item rcv $port, $callback->(@msg)
254
255Replaces the callback on the specified miniport (after converting it to
256one if required).
257
258=item rcv $port, tagstring => $callback->(@msg), ...
259
260=item rcv $port, $smartmatch => $callback->(@msg), ...
261
262=item rcv $port, [$smartmatch...] => $callback->(@msg), ...
263
264Register callbacks to be called on matching messages on the given full
265port (after converting it to one if required).
266
267The callback has to return a true value when its work is done, after
268which is will be removed, or a false value in which case it will stay
269registered.
270
271The global C<$SELF> (exported by this module) contains C<$port> while
272executing the callback.
273
274Runtime errors wdurign callback execution will result in the port being
275C<kil>ed.
276
277If the match is an array reference, then it will be matched against the
278first elements of the message, otherwise only the first element is being
279matched.
280
281Any element in the match that is specified as C<_any_> (a function
282exported by this module) matches any single element of the message.
283
284While not required, it is highly recommended that the first matching
285element is a string identifying the message. The one-string-only match is
286also the most efficient match (by far).
287
288=cut
289
290sub rcv($@) {
291 my $port = shift;
292 my ($noderef, $portid) = split /#/, $port, 2;
293
294 ($NODE{$noderef} || add_node $noderef) == $NODE{""}
295 or Carp::croak "$port: rcv can only be called on local ports, caught";
296
297 if (@_ == 1) {
298 my $cb = shift;
299 delete $PORT_DATA{$portid};
300 $PORT{$portid} = sub {
301 local $SELF = $port;
302 eval {
303 &$cb
304 and kil $port;
305 };
306 _self_die if $@;
307 };
308 } else {
309 my $self = $PORT_DATA{$portid} ||= do {
310 my $self = bless {
311 id => $port,
312 }, "AnyEvent::MP::Port";
313
314 $PORT{$portid} = sub {
315 local $SELF = $port;
316
317 eval {
318 for (@{ $self->{rc0}{$_[0]} }) {
319 $_ && &{$_->[0]}
320 && undef $_;
321 }
322
323 for (@{ $self->{rcv}{$_[0]} }) {
324 $_ && [@_[1 .. @{$_->[1]}]] ~~ $_->[1]
325 && &{$_->[0]}
326 && undef $_;
327 }
328
329 for (@{ $self->{any} }) {
330 $_ && [@_[0 .. $#{$_->[1]}]] ~~ $_->[1]
331 && &{$_->[0]}
332 && undef $_;
333 }
334 };
335 _self_die if $@;
336 };
337
338 $self
339 };
340
341 "AnyEvent::MP::Port" eq ref $self
342 or Carp::croak "$port: rcv can only be called on message matching ports, caught";
343
344 while (@_) {
345 my ($match, $cb) = splice @_, 0, 2;
346
347 if (!ref $match) {
348 push @{ $self->{rc0}{$match} }, [$cb];
349 } elsif (("ARRAY" eq ref $match && !ref $match->[0])) {
350 my ($type, @match) = @$match;
351 @match
352 ? push @{ $self->{rcv}{$match->[0]} }, [$cb, \@match]
353 : push @{ $self->{rc0}{$match->[0]} }, [$cb];
45 } else { 354 } else {
46 $DEFAULT_SECRET = nonce 32; 355 push @{ $self->{any} }, [$cb, $match];
356 }
47 } 357 }
48 } 358 }
49 359
50 $DEFAULT_SECRET 360 $port
51} 361}
362
363=item $closure = psub { BLOCK }
364
365Remembers C<$SELF> and creates a closure out of the BLOCK. When the
366closure is executed, sets up the environment in the same way as in C<rcv>
367callbacks, i.e. runtime errors will cause the port to get C<kil>ed.
368
369This is useful when you register callbacks from C<rcv> callbacks:
370
371 rcv delayed_reply => sub {
372 my ($delay, @reply) = @_;
373 my $timer = AE::timer $delay, 0, psub {
374 snd @reply, $SELF;
375 };
376 };
377
378=cut
379
380sub psub(&) {
381 my $cb = shift;
382
383 my $port = $SELF
384 or Carp::croak "psub can only be called from within rcv or psub callbacks, not";
385
386 sub {
387 local $SELF = $port;
388
389 if (wantarray) {
390 my @res = eval { &$cb };
391 _self_die if $@;
392 @res
393 } else {
394 my $res = eval { &$cb };
395 _self_die if $@;
396 $res
397 }
398 }
399}
400
401=item $guard = mon $port, $cb->(@reason)
402
403=item $guard = mon $port, $otherport
404
405=item $guard = mon $port, $otherport, @msg
406
407Monitor the given port and do something when the port is killed.
408
409In the first form, the callback is simply called with any number
410of C<@reason> elements (no @reason means that the port was deleted
411"normally"). Note also that I<< the callback B<must> never die >>, so use
412C<eval> if unsure.
413
414In the second form, the other port will be C<kil>'ed with C<@reason>, iff
415a @reason was specified, i.e. on "normal" kils nothing happens, while
416under all other conditions, the other port is killed with the same reason.
417
418In the last form, a message of the form C<@msg, @reason> will be C<snd>.
419
420Example: call a given callback when C<$port> is killed.
421
422 mon $port, sub { warn "port died because of <@_>\n" };
423
424Example: kill ourselves when C<$port> is killed abnormally.
425
426 mon $port, $self;
427
428Example: send us a restart message another C<$port> is killed.
429
430 mon $port, $self => "restart";
431
432=cut
433
434sub mon {
435 my ($noderef, $port) = split /#/, shift, 2;
436
437 my $node = $NODE{$noderef} || add_node $noderef;
438
439 my $cb = shift;
440
441 unless (ref $cb) {
442 if (@_) {
443 # send a kill info message
444 my (@msg) = ($cb, @_);
445 $cb = sub { snd @msg, @_ };
446 } else {
447 # simply kill other port
448 my $port = $cb;
449 $cb = sub { kil $port, @_ if @_ };
450 }
451 }
452
453 $node->monitor ($port, $cb);
454
455 defined wantarray
456 and AnyEvent::Util::guard { $node->unmonitor ($port, $cb) }
457}
458
459=item $guard = mon_guard $port, $ref, $ref...
460
461Monitors the given C<$port> and keeps the passed references. When the port
462is killed, the references will be freed.
463
464Optionally returns a guard that will stop the monitoring.
465
466This function is useful when you create e.g. timers or other watchers and
467want to free them when the port gets killed:
468
469 $port->rcv (start => sub {
470 my $timer; $timer = mon_guard $port, AE::timer 1, 1, sub {
471 undef $timer if 0.9 < rand;
472 });
473 });
474
475=cut
476
477sub mon_guard {
478 my ($port, @refs) = @_;
479
480 mon $port, sub { 0 && @refs }
481}
482
483=item lnk $port1, $port2
484
485Link two ports. This is simply a shorthand for:
486
487 mon $port1, $port2;
488 mon $port2, $port1;
489
490It means that if either one is killed abnormally, the other one gets
491killed as well.
492
493=item kil $port[, @reason]
494
495Kill the specified port with the given C<@reason>.
496
497If no C<@reason> is specified, then the port is killed "normally" (linked
498ports will not be kileld, or even notified).
499
500Otherwise, linked ports get killed with the same reason (second form of
501C<mon>, see below).
502
503Runtime errors while evaluating C<rcv> callbacks or inside C<psub> blocks
504will be reported as reason C<< die => $@ >>.
505
506Transport/communication errors are reported as C<< transport_error =>
507$message >>.
508
509=back
510
511=head1 FUNCTIONS FOR NODES
512
513=over 4
514
515=item initialise_node $noderef, $seednode, $seednode...
516
517=item initialise_node "slave/", $master, $master...
518
519Initialises a node - must be called exactly once before calling other
520AnyEvent::MP functions when talking to other nodes is required.
521
522All arguments are noderefs, which can be either resolved or unresolved.
523
524There are two types of networked nodes, public nodes and slave nodes:
525
526=over 4
527
528=item public nodes
529
530For public nodes, C<$noderef> must either be a (possibly unresolved)
531noderef, in which case it will be resolved, or C<undef> (or missing), in
532which case the noderef will be guessed.
533
534Afterwards, the node will bind itself on all endpoints and try to connect
535to all additional C<$seednodes> that are specified. Seednodes are optional
536and can be used to quickly bootstrap the node into an existing network.
537
538=item slave nodes
539
540When the C<$noderef> is the special string C<slave/>, then the node will
541become a slave node. Slave nodes cannot be contacted from outside and will
542route most of their traffic to the master node that they attach to.
543
544At least one additional noderef is required: The node will try to connect
545to all of them and will become a slave attached to the first node it can
546successfully connect to.
547
548=back
549
550This function will block until all nodes have been resolved and, for slave
551nodes, until it has successfully established a connection to a master
552server.
553
554Example: become a public node listening on the default node.
555
556 initialise_node;
557
558Example: become a public node, and try to contact some well-known master
559servers to become part of the network.
560
561 initialise_node undef, "master1", "master2";
562
563Example: become a public node listening on port C<4041>.
564
565 initialise_node 4041;
566
567Example: become a public node, only visible on localhost port 4044.
568
569 initialise_node "locahost:4044";
570
571Example: become a slave node to any of the specified master servers.
572
573 initialise_node "slave/", "master1", "192.168.13.17", "mp.example.net";
574
575=cut
576
577=back
578
579=head1 NODE MESSAGES
580
581Nodes understand the following messages sent to them. Many of them take
582arguments called C<@reply>, which will simply be used to compose a reply
583message - C<$reply[0]> is the port to reply to, C<$reply[1]> the type and
584the remaining arguments are simply the message data.
585
586While other messages exist, they are not public and subject to change.
587
588=over 4
589
590=cut
591
592=item lookup => $name, @reply
593
594Replies with the port ID of the specified well-known port, or C<undef>.
595
596=item devnull => ...
597
598Generic data sink/CPU heat conversion.
599
600=item relay => $port, @msg
601
602Simply forwards the message to the given port.
603
604=item eval => $string[ @reply]
605
606Evaluates the given string. If C<@reply> is given, then a message of the
607form C<@reply, $@, @evalres> is sent.
608
609Example: crash another node.
610
611 snd $othernode, eval => "exit";
612
613=item time => @reply
614
615Replies the the current node time to C<@reply>.
616
617Example: tell the current node to send the current time to C<$myport> in a
618C<timereply> message.
619
620 snd $NODE, time => $myport, timereply => 1, 2;
621 # => snd $myport, timereply => 1, 2, <time>
622
623=back
624
625=head1 AnyEvent::MP vs. Distributed Erlang
626
627AnyEvent::MP got lots of its ideas from distributed erlang (erlang node
628== aemp node, erlang process == aemp port), so many of the documents and
629programming techniques employed by erlang apply to AnyEvent::MP. Here is a
630sample:
631
632 http://www.erlang.se/doc/programming_rules.shtml
633 http://erlang.org/doc/getting_started/part_frame.html # chapters 3 and 4
634 http://erlang.org/download/erlang-book-part1.pdf # chapters 5 and 6
635 http://erlang.org/download/armstrong_thesis_2003.pdf # chapters 4 and 5
636
637Despite the similarities, there are also some important differences:
638
639=over 4
640
641=item * Node references contain the recipe on how to contact them.
642
643Erlang relies on special naming and DNS to work everywhere in the
644same way. AEMP relies on each node knowing it's own address(es), with
645convenience functionality.
646
647This means that AEMP requires a less tightly controlled environment at the
648cost of longer node references and a slightly higher management overhead.
649
650=item * Erlang uses processes and a mailbox, AEMP does not queue.
651
652Erlang uses processes that selctively receive messages, and therefore
653needs a queue. AEMP is event based, queuing messages would serve no useful
654purpose.
655
656(But see L<Coro::MP> for a more erlang-like process model on top of AEMP).
657
658=item * Erlang sends are synchronous, AEMP sends are asynchronous.
659
660Sending messages in erlang is synchronous and blocks the process. AEMP
661sends are immediate, connection establishment is handled in the
662background.
663
664=item * Erlang can silently lose messages, AEMP cannot.
665
666Erlang makes few guarantees on messages delivery - messages can get lost
667without any of the processes realising it (i.e. you send messages a, b,
668and c, and the other side only receives messages a and c).
669
670AEMP guarantees correct ordering, and the guarantee that there are no
671holes in the message sequence.
672
673=item * In erlang, processes can be declared dead and later be found to be
674alive.
675
676In erlang it can happen that a monitored process is declared dead and
677linked processes get killed, but later it turns out that the process is
678still alive - and can receive messages.
679
680In AEMP, when port monitoring detects a port as dead, then that port will
681eventually be killed - it cannot happen that a node detects a port as dead
682and then later sends messages to it, finding it is still alive.
683
684=item * Erlang can send messages to the wrong port, AEMP does not.
685
686In erlang it is quite possible that a node that restarts reuses a process
687ID known to other nodes for a completely different process, causing
688messages destined for that process to end up in an unrelated process.
689
690AEMP never reuses port IDs, so old messages or old port IDs floating
691around in the network will not be sent to an unrelated port.
692
693=item * Erlang uses unprotected connections, AEMP uses secure
694authentication and can use TLS.
695
696AEMP can use a proven protocol - SSL/TLS - to protect connections and
697securely authenticate nodes.
698
699=item * The AEMP protocol is optimised for both text-based and binary
700communications.
701
702The AEMP protocol, unlike the erlang protocol, supports both
703language-independent text-only protocols (good for debugging) and binary,
704language-specific serialisers (e.g. Storable).
705
706It has also been carefully designed to be implementable in other languages
707with a minimum of work while gracefully degrading fucntionality to make the
708protocol simple.
709
710=back
52 711
53=head1 SEE ALSO 712=head1 SEE ALSO
54 713
55L<AnyEvent>. 714L<AnyEvent>.
56 715

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines