Use BB_FEATURE_CLEAN_UP where appropriate
[oweals/busybox.git] / ping.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * $Id: ping.c,v 1.23 2000/07/16 20:57:15 kraai Exp $
4  * Mini ping implementation for busybox
5  *
6  * Copyright (C) 1999 by Randolph Chung <tausq@debian.org>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21  *
22  * This version of ping is adapted from the ping in netkit-base 0.10,
23  * which is:
24  *
25  * Copyright (c) 1989 The Regents of the University of California.
26  * All rights reserved.
27  *
28  * This code is derived from software contributed to Berkeley by
29  * Mike Muuss.
30  * 
31  * Original copyright notice is retained at the end of this file.
32  */
33
34 #include "internal.h"
35 #include <sys/param.h>
36 #include <sys/socket.h>
37 #include <sys/file.h>
38 #include <sys/time.h>
39 #include <sys/times.h>
40 #include <sys/signal.h>
41
42 #include <netinet/in.h>
43 #include <netinet/ip.h>
44 #include <netinet/ip_icmp.h>
45 #include <arpa/inet.h>
46 #include <netdb.h>
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <errno.h>
50
51
52 /* It turns out that libc5 doesn't have proper icmp support
53  * built into it header files, so we have to supplement it */
54 #if ! defined __GLIBC__ && ! defined __UCLIBC__
55 typedef unsigned int socklen_t;
56
57 #define ICMP_MINLEN     8                               /* abs minimum */
58
59 struct icmp_ra_addr
60 {
61   u_int32_t ira_addr;
62   u_int32_t ira_preference;
63 };
64
65
66 struct icmp
67 {
68   u_int8_t  icmp_type;  /* type of message, see below */
69   u_int8_t  icmp_code;  /* type sub code */
70   u_int16_t icmp_cksum; /* ones complement checksum of struct */
71   union
72   {
73     u_char ih_pptr;             /* ICMP_PARAMPROB */
74     struct in_addr ih_gwaddr;   /* gateway address */
75     struct ih_idseq             /* echo datagram */
76     {
77       u_int16_t icd_id;
78       u_int16_t icd_seq;
79     } ih_idseq;
80     u_int32_t ih_void;
81
82     /* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
83     struct ih_pmtu
84     {
85       u_int16_t ipm_void;
86       u_int16_t ipm_nextmtu;
87     } ih_pmtu;
88
89     struct ih_rtradv
90     {
91       u_int8_t irt_num_addrs;
92       u_int8_t irt_wpa;
93       u_int16_t irt_lifetime;
94     } ih_rtradv;
95   } icmp_hun;
96 #define icmp_pptr       icmp_hun.ih_pptr
97 #define icmp_gwaddr     icmp_hun.ih_gwaddr
98 #define icmp_id         icmp_hun.ih_idseq.icd_id
99 #define icmp_seq        icmp_hun.ih_idseq.icd_seq
100 #define icmp_void       icmp_hun.ih_void
101 #define icmp_pmvoid     icmp_hun.ih_pmtu.ipm_void
102 #define icmp_nextmtu    icmp_hun.ih_pmtu.ipm_nextmtu
103 #define icmp_num_addrs  icmp_hun.ih_rtradv.irt_num_addrs
104 #define icmp_wpa        icmp_hun.ih_rtradv.irt_wpa
105 #define icmp_lifetime   icmp_hun.ih_rtradv.irt_lifetime
106   union
107   {
108     struct
109     {
110       u_int32_t its_otime;
111       u_int32_t its_rtime;
112       u_int32_t its_ttime;
113     } id_ts;
114     struct
115     {
116       struct ip idi_ip;
117       /* options and then 64 bits of data */
118     } id_ip;
119     struct icmp_ra_addr id_radv;
120     u_int32_t   id_mask;
121     u_int8_t    id_data[1];
122   } icmp_dun;
123 #define icmp_otime      icmp_dun.id_ts.its_otime
124 #define icmp_rtime      icmp_dun.id_ts.its_rtime
125 #define icmp_ttime      icmp_dun.id_ts.its_ttime
126 #define icmp_ip         icmp_dun.id_ip.idi_ip
127 #define icmp_radv       icmp_dun.id_radv
128 #define icmp_mask       icmp_dun.id_mask
129 #define icmp_data       icmp_dun.id_data
130 };
131 #endif
132
133 #define DEFDATALEN      56
134 #define MAXIPLEN        60
135 #define MAXICMPLEN      76
136 #define MAXPACKET       65468
137 #define MAX_DUP_CHK     (8 * 128)
138 #define MAXWAIT         10
139 #define PINGINTERVAL    1               /* second */
140
141 #define O_QUIET         (1 << 0)
142
143 #define A(bit)          rcvd_tbl[(bit)>>3]      /* identify byte in array */
144 #define B(bit)          (1 << ((bit) & 0x07))   /* identify bit in byte */
145 #define SET(bit)        (A(bit) |= B(bit))
146 #define CLR(bit)        (A(bit) &= (~B(bit)))
147 #define TST(bit)        (A(bit) & B(bit))
148
149 static void ping(const char *host);
150
151 /* common routines */
152 static int in_cksum(unsigned short *buf, int sz)
153 {
154         int nleft = sz;
155         int sum = 0;
156         unsigned short *w = buf;
157         unsigned short ans = 0;
158
159         while (nleft > 1) {
160                 sum += *w++;
161                 nleft -= 2;
162         }
163
164         if (nleft == 1) {
165                 *(unsigned char *) (&ans) = *(unsigned char *) w;
166                 sum += ans;
167         }
168
169         sum = (sum >> 16) + (sum & 0xFFFF);
170         sum += (sum >> 16);
171         ans = ~sum;
172         return (ans);
173 }
174
175 /* simple version */
176 #ifdef BB_FEATURE_SIMPLE_PING
177 static char *hostname = NULL;
178
179 static void noresp(int ign)
180 {
181         printf("No response from %s\n", hostname);
182         exit(0);
183 }
184
185 static void ping(const char *host)
186 {
187         struct hostent *h;
188         struct sockaddr_in pingaddr;
189         struct icmp *pkt;
190         int pingsock, c;
191         char packet[DEFDATALEN + MAXIPLEN + MAXICMPLEN];
192
193         if ((pingsock = socket(AF_INET, SOCK_RAW, 1)) < 0) {    /* 1 == ICMP */
194                 perror("ping: creating a raw socket");
195                 exit(1);
196         }
197
198         /* drop root privs if running setuid */
199         setuid(getuid());
200
201         memset(&pingaddr, 0, sizeof(struct sockaddr_in));
202
203         pingaddr.sin_family = AF_INET;
204         if (!(h = gethostbyname(host))) {
205                 errorMsg("unknown host %s\n", host);
206                 exit(1);
207         }
208         memcpy(&pingaddr.sin_addr, h->h_addr, sizeof(pingaddr.sin_addr));
209         hostname = h->h_name;
210
211         pkt = (struct icmp *) packet;
212         memset(pkt, 0, sizeof(packet));
213         pkt->icmp_type = ICMP_ECHO;
214         pkt->icmp_cksum = in_cksum((unsigned short *) pkt, sizeof(packet));
215
216         c = sendto(pingsock, packet, sizeof(packet), 0,
217                            (struct sockaddr *) &pingaddr, sizeof(struct sockaddr_in));
218
219         if (c < 0 || c != sizeof(packet)) {
220                 if (c < 0)
221                         perror("ping: sendto");
222                 errorMsg("write incomplete\n");
223                 exit(1);
224         }
225
226         signal(SIGALRM, noresp);
227         alarm(5);                                       /* give the host 5000ms to respond */
228         /* listen for replies */
229         while (1) {
230                 struct sockaddr_in from;
231                 size_t fromlen = sizeof(from);
232
233                 if ((c = recvfrom(pingsock, packet, sizeof(packet), 0,
234                                                   (struct sockaddr *) &from, &fromlen)) < 0) {
235                         if (errno == EINTR)
236                                 continue;
237                         perror("ping: recvfrom");
238                         continue;
239                 }
240                 if (c >= 76) {                  /* ip + icmp */
241                         struct iphdr *iphdr = (struct iphdr *) packet;
242
243                         pkt = (struct icmp *) (packet + (iphdr->ihl << 2));     /* skip ip hdr */
244                         if (pkt->icmp_type == ICMP_ECHOREPLY)
245                                 break;
246                 }
247         }
248         printf("%s is alive!\n", hostname);
249         return;
250 }
251
252 extern int ping_main(int argc, char **argv)
253 {
254         argc--;
255         argv++;
256         if (argc < 1)
257                 usage(ping_usage);
258         ping(*argv);
259         exit(TRUE);
260 }
261
262 #else /* ! BB_FEATURE_SIMPLE_PING */
263 /* full(er) version */
264 static char *hostname = NULL;
265 static struct sockaddr_in pingaddr;
266 static int pingsock = -1;
267 static int datalen = DEFDATALEN;
268
269 static long ntransmitted = 0, nreceived = 0, nrepeats = 0, pingcount = 0;
270 static int myid = 0, options = 0;
271 static unsigned long tmin = ULONG_MAX, tmax = 0, tsum = 0;
272 static char rcvd_tbl[MAX_DUP_CHK / 8];
273
274 static void sendping(int);
275 static void pingstats(int);
276 static void unpack(char *, int, struct sockaddr_in *);
277
278 /**************************************************************************/
279
280 static void pingstats(int junk)
281 {
282         signal(SIGINT, SIG_IGN);
283
284         printf("\n--- %s ping statistics ---\n", hostname);
285         printf("%ld packets transmitted, ", ntransmitted);
286         printf("%ld packets received, ", nreceived);
287         if (nrepeats)
288                 printf("%ld duplicates, ", nrepeats);
289         if (ntransmitted)
290                 printf("%ld%% packet loss\n",
291                            (ntransmitted - nreceived) * 100 / ntransmitted);
292         if (nreceived)
293                 printf("round-trip min/avg/max = %lu.%lu/%lu.%lu/%lu.%lu ms\n",
294                            tmin / 10, tmin % 10,
295                            (tsum / (nreceived + nrepeats)) / 10,
296                            (tsum / (nreceived + nrepeats)) % 10, tmax / 10, tmax % 10);
297         exit(0);
298 }
299
300 static void sendping(int junk)
301 {
302         struct icmp *pkt;
303         int i;
304         char packet[datalen + 8];
305
306         pkt = (struct icmp *) packet;
307
308         pkt->icmp_type = ICMP_ECHO;
309         pkt->icmp_code = 0;
310         pkt->icmp_cksum = 0;
311         pkt->icmp_seq = ntransmitted++;
312         pkt->icmp_id = myid;
313         CLR(pkt->icmp_seq % MAX_DUP_CHK);
314
315         gettimeofday((struct timeval *) &packet[8], NULL);
316         pkt->icmp_cksum = in_cksum((unsigned short *) pkt, sizeof(packet));
317
318         i = sendto(pingsock, packet, sizeof(packet), 0,
319                            (struct sockaddr *) &pingaddr, sizeof(struct sockaddr_in));
320
321         if (i < 0)
322                 fatalError("sendto: %s\n", strerror(errno));
323         else if ((size_t)i != sizeof(packet))
324                 fatalError("ping wrote %d chars; %d expected\n", i,
325                            (int)sizeof(packet));
326
327         signal(SIGALRM, sendping);
328         if (pingcount == 0 || ntransmitted < pingcount) {       /* schedule next in 1s */
329                 alarm(PINGINTERVAL);
330         } else {                                        /* done, wait for the last ping to come back */
331                 /* todo, don't necessarily need to wait so long... */
332                 signal(SIGALRM, pingstats);
333                 alarm(MAXWAIT);
334         }
335 }
336
337 static char *icmp_type_name (int id)
338 {
339         switch (id) {
340         case ICMP_ECHOREPLY:            return "Echo Reply";
341         case ICMP_DEST_UNREACH:         return "Destination Unreachable";
342         case ICMP_SOURCE_QUENCH:        return "Source Quench";
343         case ICMP_REDIRECT:             return "Redirect (change route)";
344         case ICMP_ECHO:                         return "Echo Request";
345         case ICMP_TIME_EXCEEDED:        return "Time Exceeded";
346         case ICMP_PARAMETERPROB:        return "Parameter Problem";
347         case ICMP_TIMESTAMP:            return "Timestamp Request";
348         case ICMP_TIMESTAMPREPLY:       return "Timestamp Reply";
349         case ICMP_INFO_REQUEST:         return "Information Request";
350         case ICMP_INFO_REPLY:           return "Information Reply";
351         case ICMP_ADDRESS:                      return "Address Mask Request";
352         case ICMP_ADDRESSREPLY:         return "Address Mask Reply";
353         default:                                        return "unknown ICMP type";
354         }
355 }
356
357 static void unpack(char *buf, int sz, struct sockaddr_in *from)
358 {
359         struct icmp *icmppkt;
360         struct iphdr *iphdr;
361         struct timeval tv, *tp;
362         int hlen, dupflag;
363         unsigned long triptime;
364
365         gettimeofday(&tv, NULL);
366
367         /* check IP header */
368         iphdr = (struct iphdr *) buf;
369         hlen = iphdr->ihl << 2;
370         /* discard if too short */
371         if (sz < (datalen + ICMP_MINLEN))
372                 return;
373
374         sz -= hlen;
375         icmppkt = (struct icmp *) (buf + hlen);
376
377         if (icmppkt->icmp_id != myid)
378             return;                             /* not our ping */
379
380         if (icmppkt->icmp_type == ICMP_ECHOREPLY) {
381             ++nreceived;
382                 tp = (struct timeval *) icmppkt->icmp_data;
383
384                 if ((tv.tv_usec -= tp->tv_usec) < 0) {
385                         --tv.tv_sec;
386                         tv.tv_usec += 1000000;
387                 }
388                 tv.tv_sec -= tp->tv_sec;
389
390                 triptime = tv.tv_sec * 10000 + (tv.tv_usec / 100);
391                 tsum += triptime;
392                 if (triptime < tmin)
393                         tmin = triptime;
394                 if (triptime > tmax)
395                         tmax = triptime;
396
397                 if (TST(icmppkt->icmp_seq % MAX_DUP_CHK)) {
398                         ++nrepeats;
399                         --nreceived;
400                         dupflag = 1;
401                 } else {
402                         SET(icmppkt->icmp_seq % MAX_DUP_CHK);
403                         dupflag = 0;
404                 }
405
406                 if (options & O_QUIET)
407                         return;
408
409                 printf("%d bytes from %s: icmp_seq=%u", sz,
410                            inet_ntoa(*(struct in_addr *) &from->sin_addr.s_addr),
411                            icmppkt->icmp_seq);
412                 printf(" ttl=%d", iphdr->ttl);
413                 printf(" time=%lu.%lu ms", triptime / 10, triptime % 10);
414                 if (dupflag)
415                         printf(" (DUP!)");
416                 printf("\n");
417         } else 
418                 if (icmppkt->icmp_type != ICMP_ECHO)
419                         errorMsg("Warning: Got ICMP %d (%s)\n",
420                                         icmppkt->icmp_type, icmp_type_name (icmppkt->icmp_type));
421 }
422
423 static void ping(const char *host)
424 {
425         struct protoent *proto;
426         struct hostent *h;
427         char buf[MAXHOSTNAMELEN];
428         char packet[datalen + MAXIPLEN + MAXICMPLEN];
429         int sockopt;
430
431         proto = getprotobyname("icmp");
432         /* if getprotobyname failed, just silently force 
433          * proto->p_proto to have the correct value for "icmp" */
434         if ((pingsock = socket(AF_INET, SOCK_RAW,
435                                                    (proto ? proto->p_proto : 1))) < 0) {        /* 1 == ICMP */
436                 if (errno == EPERM) {
437                         errorMsg("permission denied. (are you root?)\n");
438                 } else {
439                         perror("ping: creating a raw socket");
440                 }
441                 exit(1);
442         }
443
444         /* drop root privs if running setuid */
445         setuid(getuid());
446
447         memset(&pingaddr, 0, sizeof(struct sockaddr_in));
448
449         pingaddr.sin_family = AF_INET;
450         if (!(h = gethostbyname(host))) {
451                 errorMsg("unknown host %s\n", host);
452                 exit(1);
453         }
454
455         if (h->h_addrtype != AF_INET) {
456                 errorMsg("unknown address type; only AF_INET is currently supported.\n");
457                 exit(1);
458         }
459
460         pingaddr.sin_family = AF_INET;  /* h->h_addrtype */
461         memcpy(&pingaddr.sin_addr, h->h_addr, sizeof(pingaddr.sin_addr));
462         strncpy(buf, h->h_name, sizeof(buf) - 1);
463         hostname = buf;
464
465         /* enable broadcast pings */
466         sockopt = 1;
467         setsockopt(pingsock, SOL_SOCKET, SO_BROADCAST, (char *) &sockopt,
468                            sizeof(sockopt));
469
470         /* set recv buf for broadcast pings */
471         sockopt = 48 * 1024;
472         setsockopt(pingsock, SOL_SOCKET, SO_RCVBUF, (char *) &sockopt,
473                            sizeof(sockopt));
474
475         printf("PING %s (%s): %d data bytes\n",
476                    hostname,
477                    inet_ntoa(*(struct in_addr *) &pingaddr.sin_addr.s_addr),
478                    datalen);
479
480         signal(SIGINT, pingstats);
481
482         /* start the ping's going ... */
483         sendping(0);
484
485         /* listen for replies */
486         while (1) {
487                 struct sockaddr_in from;
488                 socklen_t fromlen = (socklen_t) sizeof(from);
489                 int c;
490
491                 if ((c = recvfrom(pingsock, packet, sizeof(packet), 0,
492                                                   (struct sockaddr *) &from, &fromlen)) < 0) {
493                         if (errno == EINTR)
494                                 continue;
495                         perror("ping: recvfrom");
496                         continue;
497                 }
498                 unpack(packet, c, &from);
499                 if (pingcount > 0 && nreceived >= pingcount)
500                         break;
501         }
502         pingstats(0);
503 }
504
505 extern int ping_main(int argc, char **argv)
506 {
507         char *thisarg;
508
509         argc--;
510         argv++;
511         options = 0;
512         /* Parse any options */
513         while (argc >= 1 && **argv == '-') {
514                 thisarg = *argv;
515                 thisarg++;
516                 switch (*thisarg) {
517                 case 'q':
518                         options |= O_QUIET;
519                         break;
520                 case 'c':
521                         if (--argc <= 0)
522                                 usage(ping_usage);
523                         argv++;
524                         pingcount = atoi(*argv);
525                         break;
526                 case 's':
527                         if (--argc <= 0)
528                                 usage(ping_usage);
529                         argv++;
530                         datalen = atoi(*argv);
531                         break;
532                 default:
533                         usage(ping_usage);
534                 }
535                 argc--;
536                 argv++;
537         }
538         if (argc < 1)
539                 usage(ping_usage);
540
541         myid = getpid() & 0xFFFF;
542         ping(*argv);
543         return(TRUE);
544 }
545 #endif /* ! BB_FEATURE_SIMPLE_PING */
546
547 /*
548  * Copyright (c) 1989 The Regents of the University of California.
549  * All rights reserved.
550  *
551  * This code is derived from software contributed to Berkeley by
552  * Mike Muuss.
553  *
554  * Redistribution and use in source and binary forms, with or without
555  * modification, are permitted provided that the following conditions
556  * are met:
557  * 1. Redistributions of source code must retain the above copyright
558  *    notice, this list of conditions and the following disclaimer.
559  * 2. Redistributions in binary form must reproduce the above copyright
560  *    notice, this list of conditions and the following disclaimer in the
561  *    documentation and/or other materials provided with the distribution.
562  * 3. All advertising materials mentioning features or use of this software
563  *    must display the following acknowledgement:
564  *      This product includes software developed by the University of
565  *      California, Berkeley and its contributors.
566  * 4. Neither the name of the University nor the names of its contributors
567  *    may be used to endorse or promote products derived from this software
568  *    without specific prior written permission.
569  *
570  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
571  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
572  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
573  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
574  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
575  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
576  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
577  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
578  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
579  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
580  * SUCH DAMAGE.
581  */