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

Comparing AnyEvent-FastPing/FastPing.pm (file contents):
Revision 1.11 by root, Mon Jan 31 05:35:48 2011 UTC vs.
Revision 1.19 by root, Sat Nov 12 01:20:46 2016 UTC

… …
10 10
11This module was written for a single purpose only: sending ICMP ECHO 11This module was written for a single purpose only: sending ICMP ECHO
12REQUEST packets as quickly as possible to a large number of hosts 12REQUEST packets as quickly as possible to a large number of hosts
13(thousands to millions). 13(thousands to millions).
14 14
15It employs a sending thread and is fully event-driven (using AnyEvent), so 15It employs a separate thread and is fully event-driven (using AnyEvent),
16you have to run an event model supported by AnyEvent to use this module. 16so you have to run an event model supported by AnyEvent to use this
17module.
17 18
18=head1 FUNCTIONS 19=head1 FUNCTIONS
19 20
20=over 4 21=over 4
21 22
… …
26use common::sense; 27use common::sense;
27 28
28use AnyEvent; 29use AnyEvent;
29 30
30BEGIN { 31BEGIN {
31 our $VERSION = '2.0'; 32 our $VERSION = 2.1;
32 our @ISA = qw(Exporter); 33 our @ISA = qw(Exporter);
33 34
34 require Exporter; 35 require Exporter;
35 #Exporter::export_ok_tags (keys %EXPORT_TAGS); 36 #Exporter::export_ok_tags (keys %EXPORT_TAGS);
36 37
… …
38 XSLoader::load (__PACKAGE__, $VERSION); 39 XSLoader::load (__PACKAGE__, $VERSION);
39} 40}
40 41
41our ($THR_RES_FD, $ICMP4_FD, $ICMP6_FD); 42our ($THR_RES_FD, $ICMP4_FD, $ICMP6_FD);
42 43
43our $THR_RES_FH; open $THR_RES_FH, "<&=$THR_RES_FD" or die "FATAL: cannot fdopen"; 44our $THR_RES_FH;
44 45
45our $ICMP4_FH; our $ICMP4_W = $ICMP4_FD >= 0 && (open $ICMP4_FH, "<&=$ICMP4_FD") && AE::io $ICMP4_FH, 0, \&_recv_icmp4; 46our $ICMP4_FH;
46our $ICMP6_FH; our $ICMP6_W = $ICMP6_FD >= 0 && (open $ICMP6_FH, "<&=$ICMP6_FD") && AE::io $ICMP6_FH, 0, \&_recv_icmp6; 47our $ICMP6_FH;
48
49our @IDLE_CB;
47 50
48=item AnyEvent::FastPing::ipv4_supported 51=item AnyEvent::FastPing::ipv4_supported
49 52
50Returns true if IPv4 is supported in this module and on this system. 53Returns true iff IPv4 is supported in this module and on this system.
51 54
52=item AnyEvent::FastPing::ipv6_supported 55=item AnyEvent::FastPing::ipv6_supported
53 56
54Returns true if IPv6 is supported in this module and on this system. 57Returns true iff IPv6 is supported in this module and on this system.
55 58
56=item AnyEvent::FastPing::icmp4_pktsize 59=item AnyEvent::FastPing::icmp4_pktsize
57 60
58Returns the number of bytes each IPv4 ping packet has. 61Returns the number of octets per IPv4 ping packet (the whole IP packet
62including headers, excluding lower-level headers or trailers such as
63Ethernet).
64
65Can be used to calculate e.g. octets/s from rate ...
66
67 my $octets_per_second = $packets_per_second * AnyEvent::FastPing::icmp4_pktsize;
68
69... or convert kilobit/second to packet rate ...
70
71 my $packets_per_second = $kilobit_per_second
72 * (1000 / 8 / AnyEvent::FastPing::icmp4_pktsize);
73
74etc.
59 75
60=item AnyEvent::FastPing::icmp6_pktsize 76=item AnyEvent::FastPing::icmp6_pktsize
61 77
62Returns the number of bytes each IPv4 ping packet has. 78Like AnyEvent::FastPing::icmp4_pktsize, but for IPv6.
79
80=back
81
82=head1 THE AnyEvent::FastPing CLASS
83
84The AnyEvent::FastPing class represents a single "pinger". A "pinger"
85comes with its own thread to send packets in the background, a rate-limit
86machinery and separate idle/receive callbacks.
87
88The recommended workflow (there are others) is this: 1. create a new
89AnyEvent::FastPing object 2. configure the address lists and ranges to
90ping, also configure an idle callback and optionally a receive callback
913. C<start> the pinger.
92
93When the pinger has finished pinging all the configured addresses it will
94call the idle callback.
95
96The pinging process works like this: every range has a minimum interval
97between sends, which is used to limit the rate at which hosts in that
98range are being pinged. Distinct ranges are independent of each other,
99which is why there is a per-pinger "global" minimum interval as well.
100
101The pinger sends pings as fats as possible, while both obeying the pinger
102rate limit as well as range limits.
103
104When a range is exhausted, it is removed. When all ranges are exhausted,
105the pinger waits another C<max_rtt> seconds and then exits, causing the
106idle callback to trigger.
107
108Performance: On my 2 GHz Opteron system with a pretty average nvidia
109gigabit network card I can ping around 60k to 200k addresses per second,
110depending on routing decisions.
111
112Example: ping 10.0.0.1-10.0.0.15 with at most 100 packets/s, and
11311.0.0.1-11.0.255.255 with at most 1000 packets/s. Also ping the IPv6
114loopback address 5 times as fast as possible. Do not, however, exceed 1000
115packets/s overall. Also dump each received reply.
116
117 use AnyEvent::Socket;
118 use AnyEvent::FastPing;
119
120 my $done = AnyEvent->condvar;
121
122 my $pinger = new AnyEvent::FastPing;
123
124 $pinger->interval (1/1000);
125 $pinger->max_rtt (0.1); # reasonably fast/reliable network
126
127 $pinger->add_range (v10.0.0.1, v10.0.0.15, 1/100);
128 $pinger->add_range (v11.0.0.1, v11.0.255.255, 1/1000);
129 $pinger->add_hosts ([ (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1) x 5 ]);
130
131 $pinger->on_recv (sub {
132 for (@{ $_[0] }) {
133 printf "%s %g\n", (AnyEvent::Socket::format_address $_->[0]), $_->[1];
134 }
135 });
136
137 $pinger->on_idle (sub {
138 print "done\n";
139 undef $pinger;
140 });
141
142 $pinger->start;
143 $done->wait;
144
145=head2 METHODS
146
147=over 4
148
149=item $pinger = new AnyEvent::FastPing
150
151Creates a new pinger - right now there can be at most C<65536> pingers in
152a process, although that limit might change to something drastically lower
153- you should be stingy with your pinger objects.
63 154
64=cut 155=cut
65 156
66sub new { 157sub new {
67 my ($klass) = @_; 158 _boot;
68 159
160 our $ICMP4_W = $ICMP4_FD >= 0 && (open $ICMP4_FH, "<&=$ICMP4_FD") && AE::io $ICMP4_FH, 0, \&_recv_icmp4;
161 our $ICMP6_W = $ICMP6_FD >= 0 && (open $ICMP6_FH, "<&=$ICMP6_FD") && AE::io $ICMP6_FH, 0, \&_recv_icmp6;
162
163 open $THR_RES_FH, "<&=$THR_RES_FD" or die "AnyEvent::FastPing: FATAL: cannot fdopen thread result fd";
164
165 our $THR_RES_W = AE::io $THR_RES_FH, 0, sub {
166 sysread $THR_RES_FH, my $buf, 8;
167
168 for my $id (unpack "S*", $buf) {
169 _stop_id $id;
170 ($IDLE_CB[$id] || sub { })->();
171 }
172 };
173
174 *new = sub {
69 _new $klass, (rand 65536), (rand 65536), (rand 65536) 175 _new shift, (rand 65536), (rand 65536), (rand 65536)
176 };
177
178 goto &new;
70} 179}
71
72our @IDLE_CB;
73 180
74sub DESTROY { 181sub DESTROY {
75 undef $IDLE_CB[ &id ]; 182 undef $IDLE_CB[ &id ];
76 &_free; 183 &_free;
77} 184}
78 185
186=item $pinger->on_recv ($callback->([[$host, $rtt], ...]))
187
188Registers a callback to be called for ping replies. If no callback has
189been registered than ping replies will be ignored, otherwise this module
190calculates the round trip time, in seconds, for each reply and calls this
191callback.
192
193The callback receives a single argument, which is an array reference
194with an entry for each reply packet (the replies will be batched for
195efficiency). Each member in the array reference is again an array
196reference with exactly two members: the binary host address (4 octets for
197IPv4, 16 for IPv6) and the approximate round trip time, in seconds.
198
199The replies will be passed to the callback as soon as they arrive, and
200this callback can be called many times with batches of replies.
201
202The receive callback will be called whenever a suitable reply arrives,
203whether generated by this pinger or not, whether this pinger is started
204or not. The packets will have a unique 64 bit ID to distinguish them from
205other pinger objects and other generators, but this doesn't help against
206malicious replies.
207
208Note that very high packet rates can overwhelm your process, causing
209replies to be dropped (configure your kernel with long receive queues for
210raw sockets if this is a problem).
211
212Example: register a callback which simply dumps the received data.
213
214 use AnyEvent::Socket;
215
216 $pinger->on_recv (sub {
217 for (@{ $_[0] }) {
218 printf "%s %g\n", (AnyEvent::Socket::format_address $_->[0]), $_->[1];
219 }
220 });
221
222Example: a single ping reply with payload of 1 from C<::1> gets passed
223like this:
224
225 [
226 [ "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\1", 0.000280141830444336 ]
227 ]
228
229Example: ping replies for C<127.0.0.1> and C<127.0.0.2>:
230
231 [
232 [ "\177\0\0\1", 0.00015711784362793 ],
233 [ "\177\0\0\2", 0.00090184211731 ]
234 ]
235
236=item $pinger->on_idle ($callback->())
237
238Registers a callback to be called when the pinger becomes I<idle>, that
239is, it has been started, has exhausted all ping ranges and waited for
240the C<max_rtt> time. An idle pinger is also stopped, so the callback can
241instantly add new ranges, if it so desires.
242
243=cut
244
79sub on_idle { 245sub on_idle {
80 $IDLE_CB[ &id ] = $_[1]; 246 $IDLE_CB[ &id ] = $_[1];
81} 247}
82 248
83our $THR_RES_W = AE::io $THR_RES_FH, 0, sub { 249=item $pinger->interval ($seconds)
84 sysread $THR_RES_FH, my $buf, 8;
85 250
86 for my $id (unpack "S*", $buf) { 251Configures the minimum interval between packet sends for this pinger - the
87 _stop_id $id; 252pinger will not send packets faster than this rate (or actually 1 / rate),
88 ($IDLE_CB[$id] || sub { })->(); 253even if individual ranges have a lower interval.
89 }
90};
91 254
92for(1..10) { 255A value of C<0> selects the fastest possible speed (currently no faster
93my $p = new AnyEvent::FastPing;#d# 256than 1_000_000 packets/s).
94$p->interval (0);
95$p->max_rtt (0.5);
96#$p->add_range (v127.0.0.1, v127.255.255.254, 0);
97$p->add_range (v1.0.0.1, v1.255.255.254, 0);
98$p->on_idle (my $cv = AE::cv);
99my $cnt;
100$p->on_recv (sub {
101 $cnt++;
102});
103$p->start;
104$cv->recv;
105warn $cnt;
106}
107 257
108=item AnyEvent::FastPing::icmp_ping [ranges...], $send_interval, $payload, \&callback 258=item $pinger->max_rtt ($seconds)
109 259
110Ping the given IPv4 address ranges. Each range is an arrayref of the 260If your idle callback were called instantly after all ranges were
111form C<[lo, hi, interval]>, where C<lo> and C<hi> are octet strings with 261exhausted and you destroyed the object inside (which is common), then
112either 4 octets (for IPv4 addresses) or 16 octets (for IPV6 addresses), 262there would be no chance to receive some replies, as there would be no
113representing the lowest and highest address to ping (you can convert a 263time of the packet to travel over the network.
114dotted-quad IPv4 address to this format by using C<inet_aton $address>. The
115range C<interval> is the minimum time in seconds between pings to the
116given range. If omitted, defaults to C<$send_interval>.
117 264
118The C<$send_interval> is the minimum interval between sending any two 265This can be fixed by starting a timer in the idle callback, or more simply
119packets and is a way to make an overall rate limit. If omitted, pings will 266by selecting a suitable C<max_rtt> value, which should be the maximum time
120be sent as fast as possible. 267you allow a ping packet to travel to its destination and back.
121 268
122The C<$payload> is a 32 bit unsigned integer given as the ICMP ECHO 269The pinger thread automatically waits for this amount of time before becoming idle.
123REQUEST ident and sequence numbers (in unspecified order :).
124 270
125The request will be queued and all requests will be served by a background 271The default is currently C<0.5> seconds, which is usually plenty.
126thread in order. When all ranges have been pinged, the C<callback> will be
127called.
128 272
129Algorithm: Each range has an associated "next time to send packet" 273=item $pinger->add_range ($lo, $hi[, $interval])
130time. The algorithm loops as long as there are ranges with hosts to be
131pinged and always serves the range with the most urgent packet send
132time. It will at most send one packet every C<$send_interval> seconds.
133 274
134This will ensure that pings to the same range are nicely interleaved with 275Ping the IPv4 (or IPv6, but see below) address range, starting at binary
135other ranges - this can help reduce per-subnet bandwidth while maintaining 276address C<$lo> and ending at C<$hi> (both C<$lo> and C<$hi> will be
136an overall high packet rate. 277pinged), generating no more than one ping per C<$interval> seconds (or as
278fast as possible if omitted).
137 279
138The algorithm to send each packet is O(log n) on the number of ranges, so 280You can convert IP addresses from text to binary form by
281using C<AnyEvent::Util::parse_address>, C<Socket::inet_aton>,
282C<Socket6::inet_pton> or any other method that you like :)
283
284The algorithm to select the next address is O(log n) on the number of
139even a large number of ranges (many thousands) is managable. 285ranges, so even a large number of ranges (many thousands) is manageable.
140 286
141No storage is allocated per address. 287No storage is allocated per address.
142 288
143Performance: On my 2 GHz Opteron system with a pretty average nvidia 289Note that, while IPv6 addresses are currently supported, the usefulness of
144gigabit network card I can ping around 60k to 200k adresses per second, 290this option is extremely limited and might be gone in future versions - if
145depending on routing decisions. 291you want to ping a number of IPv6 hosts, better specify them individually
292using the C<add_hosts> method.
146 293
147Example: ping 10.0.0.1-10.0.0.15 with at most 100 packets/s, and 294=item $pinger->add_hosts ([$host...], $interval, $interleave)
14811.0.0.1-11.0.255.255 with at most 1000 packets/s. Do not, however, exceed
1491000 packets/s overall:
150 295
151 my $done = AnyEvent->condvar; 296Similar to C<add_range>, but uses a list of single addresses instead. The
297list is specified as an array reference as first argument. Each entry in
298the array should be a binary host address, either IPv4 or IPv6. If all
299addresses are IPv4 addresses, then a compact IPv4-only format will be used
300to store the list internally.
152 301
153 AnyEvent::FastPing::icmp_ping 302Minimum C<$interval> is the same as for C<add_range> and can be left out.
154 [
155 [v10.0.0.1, v10.0.0.15, .01],
156 [v11.0.0.1, v11.0.255.255, .001],
157 ],
158 .001, 0x12345678,
159 sub {
160 warn "all ranges pinged\n";
161 $done->broadcast;
162 }
163 ;
164 303
165 $done->wait; 304C<$interlave> specifies an increment between addresses: often address
305lists are generated in a way that results in clustering - first all
306addresses from one subnet, then from the next, and so on. To avoid this,
307you can specify an interleave factor. If it is C<1> (the default), then
308every address is pinged in the order specified. If it is C<2>, then only
309every second address will be pinged in the first round, followed by a
310second round with the others. Higher factors will create C<$interleave>
311runs of addresses spaced C<$interleave> indices in the list.
166 312
167=cut 313The special value C<0> selects a (hopefully) suitable interleave factor
314automatically - currently C<256> for lists with less than 65536 addresses,
315and the square root of the list length otherwise.
168 316
169sub icmp_ping($$$&) { 317=item $pinger->start
170# _send_req _req_icmp_ping @_;
171}
172 318
173=item AnyEvent::FastPing::register_cb \&cb 319Start the pinger, unless it is running already. While a pinger is running
320you must not modify the pinger. If you want to change a parameter, you
321have to C<stop> the pinger first.
174 322
175Register a callback that is called for every received ping reply 323The pinger will automatically stop when destroyed.
176(regardless of whether a ping is still in process or not and regardless of
177whether the reply is actually a reply to a ping sent earlier).
178 324
179The code reference gets a single parameter - an arrayref with an 325=item $pinger->stop
180entry for each received packet (replies are being batched for greater
181efficiency). Each packet is represented by an arrayref with three members:
182the source address (an octet string of either 4 (IPv4) or 16 (IPv6) octets
183length), the payload as passed to C<icmp_ping> and the round trip time in
184seconds.
185 326
186Example: register a callback which simply dumps the received data. Since 327Stop the pinger, if it is running. A pinger can be stopped at any time,
187the coderef is created on the fly via sub, it would be hard to unregister 328after which it's current state is preserved - starting it again will
188this callback again :) 329continue where it left off.
189 330
190 AnyEvent::FastPing::register_cb sub {
191 for (@{$_[0]}) {
192 printf "%s %d %g\n",
193 (4 == length $_->[0] ? inet_ntoa $_->[0] : Socket6::inet_ntop (&AF_INET6, $_->[0])),
194 $_->[2],
195 $_->[1];
196 }
197 };
198
199Example: a single ping reply with payload of 1 from C<::1> gets passed
200like this:
201
202 [ [
203 "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\1",
204 "0.000280141830444336",
205 1
206 ] ]
207
208Example: ping replies for C<127.0.0.1> and C<127.0.0.2>, with a payload of
209C<0x12345678>:
210
211 [
212 [
213 "\177\0\0\1",
214 "0.00015711784362793",
215 305419896
216 ],
217 [
218 "\177\0\0\2",
219 "0.00090184211731",
220 305419896
221 ]
222 ]
223
224=item AnyEvent::FastPing::unregister_cb \&cb
225
226Unregister the callback again (make sure you pass the same codereference
227as to C<register_cb>).
228
229=cut 331=cut
230
231our @CB;
232
233sub register_cb($) {
234 push @CB, $_[0];
235}
236
237sub unregister_cb($) {
238 @CB = grep $_ != $_[0], @CB;
239}
240 332
2411; 3331;
242 334
243=back 335=back
244 336

Diff Legend

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