libbb: nonblock_safe_read->nonblock_immune_read, remove unused param of xmalloc_reads
[oweals/busybox.git] / networking / ping.c
index 467b7f6940fb3c97f68880953ce749f81b4f28d8..7a9c2d1f03ffbacb8a70a6175316771807323885 100644 (file)
@@ -11,7 +11,7 @@
  * This code is derived from software contributed to Berkeley by
  * Mike Muuss.
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 /* from ping6.c:
  * Copyright (C) 1999 by Randolph Chung <tausq@debian.org>
 #include <netinet/ip_icmp.h>
 #include "libbb.h"
 
+//config:config PING
+//config:      bool "ping"
+//config:      default y
+//config:      select PLATFORM_LINUX
+//config:      help
+//config:        ping uses the ICMP protocol's mandatory ECHO_REQUEST datagram to
+//config:        elicit an ICMP ECHO_RESPONSE from a host or gateway.
+//config:
+//config:config PING6
+//config:      bool "ping6"
+//config:      default y
+//config:      depends on FEATURE_IPV6 && PING
+//config:      help
+//config:        This will give you a ping that can talk IPv6.
+//config:
+//config:config FEATURE_FANCY_PING
+//config:      bool "Enable fancy ping output"
+//config:      default y
+//config:      depends on PING
+//config:      help
+//config:        Make the output from the ping applet include statistics, and at the
+//config:        same time provide full support for ICMP packets.
+
+/* Needs socket(AF_INET, SOCK_RAW, IPPROTO_ICMP), therefore BB_SUID_MAYBE: */
+//applet:IF_PING(APPLET(ping, BB_DIR_BIN, BB_SUID_MAYBE))
+//applet:IF_PING6(APPLET(ping6, BB_DIR_BIN, BB_SUID_MAYBE))
+
+//kbuild:lib-$(CONFIG_PING)  += ping.o
+//kbuild:lib-$(CONFIG_PING6) += ping.o
+
+//usage:#if !ENABLE_FEATURE_FANCY_PING
+//usage:# define ping_trivial_usage
+//usage:       "HOST"
+//usage:# define ping_full_usage "\n\n"
+//usage:       "Send ICMP ECHO_REQUEST packets to network hosts"
+//usage:# define ping6_trivial_usage
+//usage:       "HOST"
+//usage:# define ping6_full_usage "\n\n"
+//usage:       "Send ICMP ECHO_REQUEST packets to network hosts"
+//usage:#else
+//usage:# define ping_trivial_usage
+//usage:       "[OPTIONS] HOST"
+//usage:# define ping_full_usage "\n\n"
+//usage:       "Send ICMP ECHO_REQUEST packets to network hosts\n"
+//usage:     "\nOptions:"
+//usage:     "\n       -4,-6           Force IP or IPv6 name resolution"
+//usage:     "\n       -c CNT          Send only CNT pings"
+//usage:     "\n       -s SIZE         Send SIZE data bytes in packets (default:56)"
+//usage:     "\n       -t TTL          Set TTL"
+//usage:     "\n       -I IFACE/IP     Use interface or IP address as source"
+//usage:     "\n       -W SEC          Seconds to wait for the first response (default:10)"
+//usage:     "\n                       (after all -c CNT packets are sent)"
+//usage:     "\n       -w SEC          Seconds until ping exits (default:infinite)"
+//usage:     "\n                       (can exit earlier with -c CNT)"
+//usage:     "\n       -q              Quiet, only displays output at start"
+//usage:     "\n                       and when finished"
+//usage:
+//usage:# define ping6_trivial_usage
+//usage:       "[OPTIONS] HOST"
+//usage:# define ping6_full_usage "\n\n"
+//usage:       "Send ICMP ECHO_REQUEST packets to network hosts\n"
+//usage:     "\nOptions:"
+//usage:     "\n       -c CNT          Send only CNT pings"
+//usage:     "\n       -s SIZE         Send SIZE data bytes in packets (default:56)"
+//usage:     "\n       -I IFACE/IP     Use interface or IP address as source"
+//usage:     "\n       -q              Quiet, only displays output at start"
+//usage:     "\n                       and when finished"
+//usage:
+//usage:#endif
+//usage:
+//usage:#define ping_example_usage
+//usage:       "$ ping localhost\n"
+//usage:       "PING slag (127.0.0.1): 56 data bytes\n"
+//usage:       "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n"
+//usage:       "\n"
+//usage:       "--- debian ping statistics ---\n"
+//usage:       "1 packets transmitted, 1 packets received, 0% packet loss\n"
+//usage:       "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
+//usage:#define ping6_example_usage
+//usage:       "$ ping6 ip6-localhost\n"
+//usage:       "PING ip6-localhost (::1): 56 data bytes\n"
+//usage:       "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n"
+//usage:       "\n"
+//usage:       "--- ip6-localhost ping statistics ---\n"
+//usage:       "1 packets transmitted, 1 packets received, 0% packet loss\n"
+//usage:       "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
+
 #if ENABLE_PING6
 # include <netinet/icmp6.h>
 /* I see RENUMBERED constants in bits/in.h - !!?
@@ -43,13 +130,12 @@ enum {
        DEFDATALEN = 56,
        MAXIPLEN = 60,
        MAXICMPLEN = 76,
-       MAXPACKET = 65468,
        MAX_DUP_CHK = (8 * 128),
        MAXWAIT = 10,
        PINGINTERVAL = 1, /* 1 second */
 };
 
-/* common routines */
+/* Common routines */
 
 static int in_cksum(unsigned short *buf, int sz)
 {
@@ -76,40 +162,41 @@ static int in_cksum(unsigned short *buf, int sz)
 
 #if !ENABLE_FEATURE_FANCY_PING
 
-/* simple version */
+/* Simple version */
 
-static char *hostname;
+struct globals {
+       char *hostname;
+       char packet[DEFDATALEN + MAXIPLEN + MAXICMPLEN];
+} FIX_ALIASING;
+#define G (*(struct globals*)&bb_common_bufsiz1)
+#define INIT_G() do { } while (0)
 
 static void noresp(int ign UNUSED_PARAM)
 {
-       printf("No response from %s\n", hostname);
+       printf("No response from %s\n", G.hostname);
        exit(EXIT_FAILURE);
 }
 
 static void ping4(len_and_sockaddr *lsa)
 {
-       struct sockaddr_in pingaddr;
        struct icmp *pkt;
        int pingsock, c;
-       char packet[DEFDATALEN + MAXIPLEN + MAXICMPLEN];
 
        pingsock = create_icmp_socket();
-       pingaddr = lsa->u.sin;
 
-       pkt = (struct icmp *) packet;
-       memset(pkt, 0, sizeof(packet));
+       pkt = (struct icmp *) G.packet;
+       memset(pkt, 0, sizeof(G.packet));
        pkt->icmp_type = ICMP_ECHO;
-       pkt->icmp_cksum = in_cksum((unsigned short *) pkt, sizeof(packet));
+       pkt->icmp_cksum = in_cksum((unsigned short *) pkt, sizeof(G.packet));
 
-       c = xsendto(pingsock, packet, DEFDATALEN + ICMP_MINLEN,
-                          (struct sockaddr *) &pingaddr, sizeof(pingaddr));
+       xsendto(pingsock, G.packet, DEFDATALEN + ICMP_MINLEN, &lsa->u.sa, lsa->len);
 
        /* listen for replies */
        while (1) {
                struct sockaddr_in from;
                socklen_t fromlen = sizeof(from);
 
-               c = recvfrom(pingsock, packet, sizeof(packet), 0,
+               c = recvfrom(pingsock, G.packet, sizeof(G.packet), 0,
                                (struct sockaddr *) &from, &fromlen);
                if (c < 0) {
                        if (errno != EINTR)
@@ -117,9 +204,9 @@ static void ping4(len_and_sockaddr *lsa)
                        continue;
                }
                if (c >= 76) {                  /* ip + icmp */
-                       struct iphdr *iphdr = (struct iphdr *) packet;
+                       struct iphdr *iphdr = (struct iphdr *) G.packet;
 
-                       pkt = (struct icmp *) (packet + (iphdr->ihl << 2));     /* skip ip hdr */
+                       pkt = (struct icmp *) (G.packet + (iphdr->ihl << 2));   /* skip ip hdr */
                        if (pkt->icmp_type == ICMP_ECHOREPLY)
                                break;
                }
@@ -131,31 +218,27 @@ static void ping4(len_and_sockaddr *lsa)
 #if ENABLE_PING6
 static void ping6(len_and_sockaddr *lsa)
 {
-       struct sockaddr_in6 pingaddr;
        struct icmp6_hdr *pkt;
        int pingsock, c;
        int sockopt;
-       char packet[DEFDATALEN + MAXIPLEN + MAXICMPLEN];
 
        pingsock = create_icmp6_socket();
-       pingaddr = lsa->u.sin6;
 
-       pkt = (struct icmp6_hdr *) packet;
-       memset(pkt, 0, sizeof(packet));
+       pkt = (struct icmp6_hdr *) G.packet;
+       memset(pkt, 0, sizeof(G.packet));
        pkt->icmp6_type = ICMP6_ECHO_REQUEST;
 
        sockopt = offsetof(struct icmp6_hdr, icmp6_cksum);
        setsockopt(pingsock, SOL_RAW, IPV6_CHECKSUM, &sockopt, sizeof(sockopt));
 
-       c = xsendto(pingsock, packet, DEFDATALEN + sizeof (struct icmp6_hdr),
-                          (struct sockaddr *) &pingaddr, sizeof(pingaddr));
+       xsendto(pingsock, G.packet, DEFDATALEN + sizeof(struct icmp6_hdr), &lsa->u.sa, lsa->len);
 
        /* listen for replies */
        while (1) {
                struct sockaddr_in6 from;
                socklen_t fromlen = sizeof(from);
 
-               c = recvfrom(pingsock, packet, sizeof(packet), 0,
+               c = recvfrom(pingsock, G.packet, sizeof(G.packet), 0,
                                (struct sockaddr *) &from, &fromlen);
                if (c < 0) {
                        if (errno != EINTR)
@@ -163,7 +246,7 @@ static void ping6(len_and_sockaddr *lsa)
                        continue;
                }
                if (c >= ICMP_MINLEN) {                 /* icmp6_hdr */
-                       pkt = (struct icmp6_hdr *) packet;
+                       pkt = (struct icmp6_hdr *) G.packet;
                        if (pkt->icmp6_type == ICMP6_ECHO_REPLY)
                                break;
                }
@@ -180,6 +263,8 @@ static int common_ping_main(sa_family_t af, char **argv)
 {
        len_and_sockaddr *lsa;
 
+       INIT_G();
+
 #if ENABLE_PING6
        while ((++argv)[0] && argv[0][0] == '-') {
                if (argv[0][1] == '4') {
@@ -196,14 +281,14 @@ static int common_ping_main(sa_family_t af, char **argv)
        argv++;
 #endif
 
-       hostname = *argv;
-       if (!hostname)
+       G.hostname = *argv;
+       if (!G.hostname)
                bb_show_usage();
 
 #if ENABLE_PING6
-       lsa = xhost_and_af2sockaddr(hostname, 0, af);
+       lsa = xhost_and_af2sockaddr(G.hostname, 0, af);
 #else
-       lsa = xhost_and_af2sockaddr(hostname, 0, AF_INET);
+       lsa = xhost_and_af2sockaddr(G.hostname, 0, AF_INET);
 #endif
        /* Set timer _after_ DNS resolution */
        signal(SIGALRM, noresp);
@@ -215,7 +300,7 @@ static int common_ping_main(sa_family_t af, char **argv)
        else
 #endif
                ping4(lsa);
-       printf("%s is alive!\n", hostname);
+       printf("%s is alive!\n", G.hostname);
        return EXIT_SUCCESS;
 }
 
@@ -223,19 +308,20 @@ static int common_ping_main(sa_family_t af, char **argv)
 #else /* FEATURE_FANCY_PING */
 
 
-/* full(er) version */
+/* Full(er) version */
 
-#define OPT_STRING ("qvc:s:w:W:I:4" IF_PING6("6"))
+#define OPT_STRING ("qvc:s:t:w:W:I:4" IF_PING6("6"))
 enum {
        OPT_QUIET = 1 << 0,
        OPT_VERBOSE = 1 << 1,
        OPT_c = 1 << 2,
        OPT_s = 1 << 3,
-       OPT_w = 1 << 4,
-       OPT_W = 1 << 5,
-       OPT_I = 1 << 6,
-       OPT_IPV4 = 1 << 7,
-       OPT_IPV6 = (1 << 8) * ENABLE_PING6,
+       OPT_t = 1 << 4,
+       OPT_w = 1 << 5,
+       OPT_W = 1 << 6,
+       OPT_I = 1 << 7,
+       OPT_IPV4 = 1 << 8,
+       OPT_IPV6 = (1 << 9) * ENABLE_PING6,
 };
 
 
@@ -246,6 +332,7 @@ struct globals {
        len_and_sockaddr *source_lsa;
        unsigned datalen;
        unsigned pingcount; /* must be int-sized */
+       unsigned opt_ttl;
        unsigned long ntransmitted, nreceived, nrepeats;
        uint16_t myid;
        unsigned tmin, tmax; /* in us */
@@ -253,6 +340,9 @@ struct globals {
        unsigned deadline;
        unsigned timeout;
        unsigned total_secs;
+       unsigned sizeof_rcv_packet;
+       char *rcv_packet; /* [datalen + MAXIPLEN + MAXICMPLEN] */
+       void *snd_packet; /* [datalen + ipv4/ipv6_const] */
        const char *hostname;
        const char *dotted;
        union {
@@ -274,6 +364,7 @@ struct globals {
 #define nreceived    (G.nreceived   )
 #define nrepeats     (G.nrepeats    )
 #define pingcount    (G.pingcount   )
+#define opt_ttl      (G.opt_ttl     )
 #define myid         (G.myid        )
 #define tmin         (G.tmin        )
 #define tmax         (G.tmax        )
@@ -296,11 +387,11 @@ void BUG_ping_globals_too_big(void);
 } while (0)
 
 
-#define        A(bit)          rcvd_tbl[(bit)>>3]      /* identify byte in array */
-#define        B(bit)          (1 << ((bit) & 0x07))   /* identify bit in byte */
-#define        SET(bit)        (A(bit) |= B(bit))
-#define        CLR(bit)        (A(bit) &= (~B(bit)))
-#define        TST(bit)        (A(bit) & B(bit))
+#define A(bit)         rcvd_tbl[(bit)>>3]      /* identify byte in array */
+#define B(bit)         (1 << ((bit) & 0x07))   /* identify bit in byte */
+#define SET(bit)       (A(bit) |= B(bit))
+#define CLR(bit)       (A(bit) &= (~B(bit)))
+#define TST(bit)       (A(bit) & B(bit))
 
 /**************************************************************************/
 
@@ -328,16 +419,18 @@ static void print_stats_and_exit(int junk UNUSED_PARAM)
        exit(nreceived == 0 || (deadline && nreceived < pingcount));
 }
 
-static void sendping_tail(void (*sp)(int), const void *pkt, int size_pkt)
+static void sendping_tail(void (*sp)(int), int size_pkt)
 {
        int sz;
 
        CLR((uint16_t)ntransmitted % MAX_DUP_CHK);
        ntransmitted++;
 
+       size_pkt += datalen;
+
        /* sizeof(pingaddr) can be larger than real sa size, but I think
         * it doesn't matter */
-       sz = xsendto(pingsock, pkt, size_pkt, &pingaddr.sa, sizeof(pingaddr));
+       sz = xsendto(pingsock, G.snd_packet, size_pkt, &pingaddr.sa, sizeof(pingaddr));
        if (sz != size_pkt)
                bb_error_msg_and_die(bb_msg_write_error);
 
@@ -370,31 +463,32 @@ static void sendping_tail(void (*sp)(int), const void *pkt, int size_pkt)
 
 static void sendping4(int junk UNUSED_PARAM)
 {
-       /* +4 reserves a place for timestamp, which may end up sitting
-        * *after* packet. Saves one if() */
-       struct icmp *pkt = alloca(datalen + ICMP_MINLEN + 4);
+       struct icmp *pkt = G.snd_packet;
 
-       memset(pkt, 0, datalen + ICMP_MINLEN + 4);
+       //memset(pkt, 0, datalen + ICMP_MINLEN + 4); - G.snd_packet was xzalloced
        pkt->icmp_type = ICMP_ECHO;
        /*pkt->icmp_code = 0;*/
-       /*pkt->icmp_cksum = 0;*/
+       pkt->icmp_cksum = 0; /* cksum is calculated with this field set to 0 */
        pkt->icmp_seq = htons(ntransmitted); /* don't ++ here, it can be a macro */
        pkt->icmp_id = myid;
 
-       /* We don't do hton, because we will read it back on the same machine */
+       /* If datalen < 4, we store timestamp _past_ the packet,
+        * but it's ok - we allocated 4 extra bytes in xzalloc() just in case.
+        */
        /*if (datalen >= 4)*/
+               /* No hton: we'll read it back on the same machine */
                *(uint32_t*)&pkt->icmp_dun = monotonic_us();
 
        pkt->icmp_cksum = in_cksum((unsigned short *) pkt, datalen + ICMP_MINLEN);
 
-       sendping_tail(sendping4, pkt, datalen + ICMP_MINLEN);
+       sendping_tail(sendping4, ICMP_MINLEN);
 }
 #if ENABLE_PING6
 static void sendping6(int junk UNUSED_PARAM)
 {
-       struct icmp6_hdr *pkt = alloca(datalen + sizeof(struct icmp6_hdr) + 4);
+       struct icmp6_hdr *pkt = G.snd_packet;
 
-       memset(pkt, 0, datalen + sizeof(struct icmp6_hdr) + 4);
+       //memset(pkt, 0, datalen + sizeof(struct icmp6_hdr) + 4);
        pkt->icmp6_type = ICMP6_ECHO_REQUEST;
        /*pkt->icmp6_code = 0;*/
        /*pkt->icmp6_cksum = 0;*/
@@ -404,7 +498,9 @@ static void sendping6(int junk UNUSED_PARAM)
        /*if (datalen >= 4)*/
                *(uint32_t*)(&pkt->icmp6_data8[4]) = monotonic_us();
 
-       sendping_tail(sendping6, pkt, datalen + sizeof(struct icmp6_hdr));
+       //TODO? pkt->icmp_cksum = in_cksum(...);
+
+       sendping_tail(sendping6, sizeof(struct icmp6_hdr));
 }
 #endif
 
@@ -561,7 +657,6 @@ static void unpack6(char *packet, int sz, /*struct sockaddr_in6 *from,*/ int hop
 
 static void ping4(len_and_sockaddr *lsa)
 {
-       char packet[datalen + MAXIPLEN + MAXICMPLEN];
        int sockopt;
 
        pingsock = create_icmp_socket();
@@ -583,6 +678,12 @@ static void ping4(len_and_sockaddr *lsa)
        sockopt = (datalen * 2) + 7 * 1024; /* giving it a bit of extra room */
        setsockopt(pingsock, SOL_SOCKET, SO_RCVBUF, &sockopt, sizeof(sockopt));
 
+       if (opt_ttl != 0) {
+               setsockopt(pingsock, IPPROTO_IP, IP_TTL, &opt_ttl, sizeof(opt_ttl));
+               /* above doesnt affect packets sent to bcast IP, so... */
+               setsockopt(pingsock, IPPROTO_IP, IP_MULTICAST_TTL, &opt_ttl, sizeof(opt_ttl));
+       }
+
        signal(SIGINT, print_stats_and_exit);
 
        /* start the ping's going ... */
@@ -594,14 +695,14 @@ static void ping4(len_and_sockaddr *lsa)
                socklen_t fromlen = (socklen_t) sizeof(from);
                int c;
 
-               c = recvfrom(pingsock, packet, sizeof(packet), 0,
+               c = recvfrom(pingsock, G.rcv_packet, G.sizeof_rcv_packet, 0,
                                (struct sockaddr *) &from, &fromlen);
                if (c < 0) {
                        if (errno != EINTR)
                                bb_perror_msg("recvfrom");
                        continue;
                }
-               unpack4(packet, c, &from);
+               unpack4(G.rcv_packet, c, &from);
                if (pingcount && nreceived >= pingcount)
                        break;
        }
@@ -610,7 +711,6 @@ static void ping4(len_and_sockaddr *lsa)
 extern int BUG_bad_offsetof_icmp6_cksum(void);
 static void ping6(len_and_sockaddr *lsa)
 {
-       char packet[datalen + MAXIPLEN + MAXICMPLEN];
        int sockopt;
        struct msghdr msg;
        struct sockaddr_in6 from;
@@ -670,8 +770,8 @@ static void ping6(len_and_sockaddr *lsa)
        msg.msg_iov = &iov;
        msg.msg_iovlen = 1;
        msg.msg_control = control_buf;
-       iov.iov_base = packet;
-       iov.iov_len = sizeof(packet);
+       iov.iov_base = G.rcv_packet;
+       iov.iov_len = G.sizeof_rcv_packet;
        while (1) {
                int c;
                struct cmsghdr *mp;
@@ -694,7 +794,7 @@ static void ping6(len_and_sockaddr *lsa)
                                move_from_unaligned_int(hoplimit, CMSG_DATA(mp));
                        }
                }
-               unpack6(packet, c, /*&from,*/ hoplimit);
+               unpack6(G.rcv_packet, c, /*&from,*/ hoplimit);
                if (pingcount && nreceived >= pingcount)
                        break;
        }
@@ -710,12 +810,20 @@ static void ping(len_and_sockaddr *lsa)
        }
        printf(": %d data bytes\n", datalen);
 
+       G.sizeof_rcv_packet = datalen + MAXIPLEN + MAXICMPLEN;
+       G.rcv_packet = xzalloc(G.sizeof_rcv_packet);
 #if ENABLE_PING6
-       if (lsa->u.sa.sa_family == AF_INET6)
+       if (lsa->u.sa.sa_family == AF_INET6) {
+               /* +4 reserves a place for timestamp, which may end up sitting
+                * _after_ packet. Saves one if() - see sendping4/6() */
+               G.snd_packet = xzalloc(datalen + sizeof(struct icmp6_hdr) + 4);
                ping6(lsa);
-       else
+       else
 #endif
+       {
+               G.snd_packet = xzalloc(datalen + ICMP_MINLEN + 4);
                ping4(lsa);
+       }
 }
 
 static int common_ping_main(int opt, char **argv)
@@ -725,9 +833,9 @@ static int common_ping_main(int opt, char **argv)
 
        INIT_G();
 
-       /* exactly one argument needed; -v and -q don't mix; -c NUM, -w NUM, -W NUM */
-       opt_complementary = "=1:q--v:v--q:c+:w+:W+";
-       opt |= getopt32(argv, OPT_STRING, &pingcount, &str_s, &deadline, &timeout, &str_I);
+       /* exactly one argument needed; -v and -q don't mix; -c NUM, -t NUM, -w NUM, -W NUM */
+       opt_complementary = "=1:q--v:v--q:c+:t+:w+:W+";
+       opt |= getopt32(argv, OPT_STRING, &pingcount, &str_s, &opt_ttl, &deadline, &timeout, &str_I);
        if (opt & OPT_s)
                datalen = xatou16(str_s); // -s
        if (opt & OPT_I) { // -I