[ViewVC] Diff of: cvs/AnyEvent-MP/MP.pm

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.3 by root, Sat Aug 1 07:11:45 2009 UTC vs.
Revision 1.20 by root, Mon Aug 3 22:05:55 2009 UTC

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

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-MP/MP.pm (file contents): Revision 1.3 by root, Sat Aug 1 07:11:45 2009 UTC vs. Revision 1.20 by root, Mon Aug 3 22:05:55 2009 UTC

Diff Legend

Comparing AnyEvent-MP/MP.pm (file contents):
Revision 1.3 by root, Sat Aug 1 07:11:45 2009 UTC vs.
Revision 1.20 by root, Mon Aug 3 22:05:55 2009 UTC