2 * Object oriented C module to send ICMP and ICMPv6 `echo's.
3 * Copyright (C) 2006-2016 Florian octo Forster <ff at octo.it>
5 * This library is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License as published by the
7 * Free Software Foundation; either version 2.1 of the License, or (at your
8 * option) any later version.
10 * This library is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this library; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #define __APPLE_USE_RFC_3542
32 # include <inttypes.h>
36 # error "You don't have the standard C99 header files installed"
37 #endif /* STDC_HEADERS */
51 # include <sys/types.h>
54 # include <sys/stat.h>
57 #if TIME_WITH_SYS_TIME
58 # include <sys/time.h>
62 # include <sys/time.h>
69 # include <sys/socket.h>
76 #if HAVE_NETINET_IN_SYSTM_H
77 # include <netinet/in_systm.h>
80 # include <netinet/in.h>
83 # include <netinet/ip.h>
85 #if HAVE_NETINET_IP_ICMP_H
86 # include <netinet/ip_icmp.h>
88 #ifdef HAVE_NETINET_IP_VAR_H
89 # include <netinet/ip_var.h>
91 #if HAVE_NETINET_IP6_H
92 # include <netinet/ip6.h>
94 #if HAVE_NETINET_ICMP6_H
95 # include <netinet/icmp6.h>
101 # define dprintf(...) printf ("%s[%4i]: %-20s: ", __FILE__, __LINE__, __FUNCTION__); printf (__VA_ARGS__)
103 # define dprintf(...) /**/
106 #define PING_ERRMSG_LEN 256
107 #define PING_TABLE_LEN 5381
111 /* username: name passed in by the user */
113 /* hostname: name returned by the reverse lookup */
115 struct sockaddr_storage *addr;
120 struct timeval *timer;
129 struct pinghost *next;
130 struct pinghost *table_next;
144 struct sockaddr *srcaddr;
145 socklen_t srcaddrlen;
152 char errmsg[PING_ERRMSG_LEN];
155 pinghost_t *table[PING_TABLE_LEN];
159 * private (static) functions
161 /* Even though Posix requires "strerror_r" to return an "int",
162 * some systems (e.g. the GNU libc) return a "char *" _and_
163 * ignore the second argument ... -tokkee */
164 static char *sstrerror (int errnum, char *buf, size_t buflen)
170 snprintf (buf, buflen, "Error %i (%#x)", errnum, errnum);
172 /* #endif !HAVE_STRERROR_R */
174 #elif STRERROR_R_CHAR_P
177 temp = strerror_r (errnum, buf, buflen);
180 if ((temp != NULL) && (temp != buf) && (temp[0] != 0))
181 strncpy (buf, temp, buflen);
183 strncpy (buf, "strerror_r did not return "
184 "an error message", buflen);
187 /* #endif STRERROR_R_CHAR_P */
190 if (strerror_r (errnum, buf, buflen) != 0)
192 snprintf (buf, buflen, "Error %i (%#x); "
193 "Additionally, strerror_r failed.",
196 #endif /* STRERROR_R_CHAR_P */
201 } /* char *sstrerror */
203 static void ping_set_error (pingobj_t *obj, const char *function,
206 snprintf (obj->errmsg, sizeof (obj->errmsg),
207 "%s: %s", function, message);
208 obj->errmsg[sizeof (obj->errmsg) - 1] = 0;
211 static void ping_set_errno (pingobj_t *obj, int error_number)
213 sstrerror (error_number, obj->errmsg, sizeof (obj->errmsg));
216 static int ping_timeval_add (struct timeval *tv1, struct timeval *tv2,
219 res->tv_sec = tv1->tv_sec + tv2->tv_sec;
220 res->tv_usec = tv1->tv_usec + tv2->tv_usec;
222 while (res->tv_usec > 1000000)
224 res->tv_usec -= 1000000;
231 static int ping_timeval_sub (struct timeval *tv1, struct timeval *tv2,
234 if ((tv1->tv_sec < tv2->tv_sec)
235 || ((tv1->tv_sec == tv2->tv_sec)
236 && (tv1->tv_usec < tv2->tv_usec)))
239 res->tv_sec = tv1->tv_sec - tv2->tv_sec;
240 res->tv_usec = tv1->tv_usec - tv2->tv_usec;
242 assert ((res->tv_sec > 0) || ((res->tv_sec == 0) && (res->tv_usec >= 0)));
244 while (res->tv_usec < 0)
246 res->tv_usec += 1000000;
253 static uint16_t ping_icmp4_checksum (char *buf, size_t len)
260 for (ptr = (uint16_t *) buf; len > 1; ptr++, len -= 2)
265 *(char *) &ret = *(char *) ptr;
269 /* Do this twice to get all possible carries.. */
270 sum = (sum >> 16) + (sum & 0xFFFF);
271 sum = (sum >> 16) + (sum & 0xFFFF);
278 static pinghost_t *ping_receive_ipv4 (pingobj_t *obj, char *buffer,
282 struct icmp *icmp_hdr;
286 uint16_t recv_checksum;
287 uint16_t calc_checksum;
294 if (buffer_len < sizeof (struct ip))
297 ip_hdr = (struct ip *) buffer;
298 ip_hdr_len = ip_hdr->ip_hl << 2;
300 if (buffer_len < ip_hdr_len)
303 buffer += ip_hdr_len;
304 buffer_len -= ip_hdr_len;
306 if (buffer_len < ICMP_MINLEN)
309 icmp_hdr = (struct icmp *) buffer;
310 if (icmp_hdr->icmp_type != ICMP_ECHOREPLY)
312 dprintf ("Unexpected ICMP type: %"PRIu8"\n", icmp_hdr->icmp_type);
316 recv_checksum = icmp_hdr->icmp_cksum;
317 /* This writes to buffer. */
318 icmp_hdr->icmp_cksum = 0;
319 calc_checksum = ping_icmp4_checksum (buffer, buffer_len);
321 if (recv_checksum != calc_checksum)
323 dprintf ("Checksum missmatch: Got 0x%04"PRIx16", "
324 "calculated 0x%04"PRIx16"\n",
325 recv_checksum, calc_checksum);
329 ident = ntohs (icmp_hdr->icmp_id);
330 seq = ntohs (icmp_hdr->icmp_seq);
332 for (ptr = obj->table[ident % PING_TABLE_LEN];
333 ptr != NULL; ptr = ptr->table_next)
335 dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
336 ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
338 if (ptr->addrfamily != AF_INET)
341 if (!timerisset (ptr->timer))
344 if (ptr->ident != ident)
347 if (((ptr->sequence - 1) & 0xFFFF) != seq)
350 dprintf ("Match found: hostname = %s, ident = 0x%04"PRIx16", "
352 ptr->hostname, ident, seq);
359 dprintf ("No match found for ident = 0x%04"PRIx16", seq = %"PRIu16"\n",
364 ptr->recv_ttl = (int) ip_hdr->ip_ttl;
365 ptr->recv_qos = (uint8_t) ip_hdr->ip_tos;
370 #ifndef ICMP6_ECHO_REQUEST
371 # ifdef ICMP6_ECHO /* AIX netinet/ip6_icmp.h */
372 # define ICMP6_ECHO_REQUEST ICMP6_ECHO
374 # define ICMP6_ECHO_REQUEST 128
378 #ifndef ICMP6_ECHO_REPLY
379 # ifdef ICMP6_ECHOREPLY /* AIX netinet/ip6_icmp.h */
380 # define ICMP6_ECHO_REPLY ICMP6_ECHOREPLY
382 # define ICMP6_ECHO_REPLY 129
386 static pinghost_t *ping_receive_ipv6 (pingobj_t *obj, char *buffer,
389 struct icmp6_hdr *icmp_hdr;
396 if (buffer_len < ICMP_MINLEN)
399 icmp_hdr = (struct icmp6_hdr *) buffer;
400 buffer += ICMP_MINLEN;
401 buffer_len -= ICMP_MINLEN;
403 if (icmp_hdr->icmp6_type != ICMP6_ECHO_REPLY)
405 dprintf ("Unexpected ICMP type: %02x\n", icmp_hdr->icmp6_type);
409 if (icmp_hdr->icmp6_code != 0)
411 dprintf ("Unexpected ICMP code: %02x\n", icmp_hdr->icmp6_code);
415 ident = ntohs (icmp_hdr->icmp6_id);
416 seq = ntohs (icmp_hdr->icmp6_seq);
418 /* We have to iterate over all hosts, since ICMPv6 packets may
419 * be received on any raw v6 socket. */
420 for (ptr = obj->head; ptr != NULL; ptr = ptr->next)
422 dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
423 ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
425 if (ptr->addrfamily != AF_INET6)
428 if (!timerisset (ptr->timer))
431 if (ptr->ident != ident)
434 if (((ptr->sequence - 1) & 0xFFFF) != seq)
437 dprintf ("Match found: hostname = %s, ident = 0x%04"PRIx16", "
439 ptr->hostname, ident, seq);
446 dprintf ("No match found for ident = 0x%04"PRIx16", "
454 static int ping_receive_one (pingobj_t *obj, struct timeval *now, int addrfam)
456 int fd = addrfam == AF_INET6 ? obj->fd6 : obj->fd4;
457 struct timeval diff, pkt_now = *now;
458 pinghost_t *host = NULL;
463 * Set up the receive buffer..
465 struct msghdr msghdr;
466 struct cmsghdr *cmsg;
467 char payload_buffer[4096];
468 ssize_t payload_buffer_len;
469 char control_buffer[4096];
470 struct iovec payload_iovec;
472 memset (&payload_iovec, 0, sizeof (payload_iovec));
473 payload_iovec.iov_base = payload_buffer;
474 payload_iovec.iov_len = sizeof (payload_buffer);
476 memset (&msghdr, 0, sizeof (msghdr));
477 /* unspecified source address */
478 msghdr.msg_name = NULL;
479 msghdr.msg_namelen = 0;
480 /* output buffer vector, see readv(2) */
481 msghdr.msg_iov = &payload_iovec;
482 msghdr.msg_iovlen = 1;
483 /* output buffer for control messages */
484 msghdr.msg_control = control_buffer;
485 msghdr.msg_controllen = sizeof (control_buffer);
486 /* flags; this is an output only field.. */
487 msghdr.msg_flags = 0;
489 msghdr.msg_flags |= MSG_XPG4_2;
492 payload_buffer_len = recvmsg (fd, &msghdr, /* flags = */ 0);
493 if (payload_buffer_len < 0)
496 char errbuf[PING_ERRMSG_LEN];
497 dprintf ("recvfrom: %s\n",
498 sstrerror (errno, errbuf, sizeof (errbuf)));
502 dprintf ("Read %zi bytes from fd = %i\n", payload_buffer_len, fd);
504 /* Iterate over all auxiliary data in msghdr */
507 for (cmsg = CMSG_FIRSTHDR (&msghdr); /* {{{ */
509 cmsg = CMSG_NXTHDR (&msghdr, cmsg))
511 if (cmsg->cmsg_level == SOL_SOCKET)
514 if (cmsg->cmsg_type == SO_TIMESTAMP)
515 memcpy (&pkt_now, CMSG_DATA (cmsg), sizeof (pkt_now));
516 #endif /* SO_TIMESTAMP */
518 else if (addrfam == AF_INET) /* {{{ */
520 if (cmsg->cmsg_level != IPPROTO_IP)
523 if (cmsg->cmsg_type == IP_TOS)
525 memcpy (&recv_qos, CMSG_DATA (cmsg),
527 dprintf ("TOSv4 = 0x%02"PRIx8";\n", recv_qos);
529 if (cmsg->cmsg_type == IP_TTL)
531 memcpy (&recv_ttl, CMSG_DATA (cmsg),
533 dprintf ("TTLv4 = %i;\n", recv_ttl);
537 dprintf ("Not handling option %i.\n",
541 else if (addrfam == AF_INET6) /* {{{ */
543 if (cmsg->cmsg_level != IPPROTO_IPV6)
546 if (cmsg->cmsg_type == IPV6_TCLASS)
548 memcpy (&recv_qos, CMSG_DATA (cmsg),
550 dprintf ("TOSv6 = 0x%02"PRIx8";\n", recv_qos);
553 if (cmsg->cmsg_type == IPV6_HOPLIMIT)
555 memcpy (&recv_ttl, CMSG_DATA (cmsg),
557 dprintf ("TTLv6 = %i;\n", recv_ttl);
561 #ifdef IPV6_UNICAST_HOPS
562 if (cmsg->cmsg_type == IPV6_UNICAST_HOPS)
564 memcpy (&recv_ttl, CMSG_DATA (cmsg),
566 dprintf ("TTLv6 = %i;\n", recv_ttl);
570 #ifdef IPV6_MULTICAST_HOPS
571 if (cmsg->cmsg_type == IPV6_MULTICAST_HOPS)
573 memcpy (&recv_ttl, CMSG_DATA (cmsg),
575 dprintf ("TTLv6 = %i;\n", recv_ttl);
580 dprintf ("Not handling option %i.\n",
586 dprintf ("Don't know how to handle "
587 "unknown protocol %i.\n",
590 } /* }}} for (cmsg) */
592 if (addrfam == AF_INET)
594 host = ping_receive_ipv4 (obj, payload_buffer, payload_buffer_len);
598 else if (addrfam == AF_INET6)
600 host = ping_receive_ipv6 (obj, payload_buffer, payload_buffer_len);
606 dprintf ("ping_receive_one: Unknown address family %i.\n",
611 dprintf ("rcvd: %12i.%06i\n",
612 (int) pkt_now.tv_sec,
613 (int) pkt_now.tv_usec);
614 dprintf ("sent: %12i.%06i\n",
615 (int) host->timer->tv_sec,
616 (int) host->timer->tv_usec);
618 if (ping_timeval_sub (&pkt_now, host->timer, &diff) < 0)
620 timerclear (host->timer);
624 dprintf ("diff: %12i.%06i\n",
629 host->recv_ttl = recv_ttl;
630 host->recv_qos = recv_qos;
632 host->latency = ((double) diff.tv_usec) / 1000.0;
633 host->latency += ((double) diff.tv_sec) * 1000.0;
635 timerclear (host->timer);
640 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
641 * Sending functions: *
644 * +-> ping_send_one_ipv4 *
645 * `-> ping_send_one_ipv6 *
646 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
647 static ssize_t ping_sendto (pingobj_t *obj, pinghost_t *ph,
648 const void *buf, size_t buflen, int fd)
652 if (gettimeofday (ph->timer, NULL) == -1)
654 timerclear (ph->timer);
658 ret = sendto (fd, buf, buflen, 0,
659 (struct sockaddr *) ph->addr, ph->addrlen);
663 #if defined(EHOSTUNREACH)
664 if (errno == EHOSTUNREACH)
667 #if defined(ENETUNREACH)
668 if (errno == ENETUNREACH)
671 ping_set_errno (obj, errno);
677 static int ping_send_one_ipv4 (pingobj_t *obj, pinghost_t *ph, int fd)
682 char buf[4096] = {0};
688 dprintf ("ph->hostname = %s\n", ph->hostname);
690 icmp4 = (struct icmp *) buf;
691 *icmp4 = (struct icmp) {
692 .icmp_type = ICMP_ECHO,
693 .icmp_id = htons (ph->ident),
694 .icmp_seq = htons (ph->sequence),
697 datalen = strlen (ph->data);
698 buflen = ICMP_MINLEN + datalen;
699 if (sizeof (buf) < buflen)
702 data = buf + ICMP_MINLEN;
703 memcpy (data, ph->data, datalen);
705 icmp4->icmp_cksum = ping_icmp4_checksum (buf, buflen);
707 dprintf ("Sending ICMPv4 package with ID 0x%04x\n", ph->ident);
709 status = ping_sendto (obj, ph, buf, buflen, fd);
712 perror ("ping_sendto");
716 dprintf ("sendto: status = %i\n", status);
721 static int ping_send_one_ipv6 (pingobj_t *obj, pinghost_t *ph, int fd)
723 struct icmp6_hdr *icmp6;
726 char buf[4096] = {0};
732 dprintf ("ph->hostname = %s\n", ph->hostname);
734 icmp6 = (struct icmp6_hdr *) buf;
735 *icmp6 = (struct icmp6_hdr) {
736 .icmp6_type = ICMP6_ECHO_REQUEST,
737 .icmp6_id = htons (ph->ident),
738 .icmp6_seq = htons (ph->sequence),
741 datalen = strlen (ph->data);
742 buflen = sizeof (*icmp6) + datalen;
743 if (sizeof (buf) < buflen)
746 data = buf + ICMP_MINLEN;
747 memcpy (data, ph->data, datalen);
749 /* The checksum will be calculated by the TCP/IP stack. */
751 dprintf ("Sending ICMPv6 package with ID 0x%04x\n", ph->ident);
753 status = ping_sendto (obj, ph, buf, buflen, fd);
756 perror ("ping_sendto");
760 dprintf ("sendto: status = %i\n", status);
765 static int ping_send_one (pingobj_t *obj, pinghost_t *ptr, int fd)
767 if (gettimeofday (ptr->timer, NULL) == -1)
769 /* start timer.. The GNU `ping6' starts the timer before
770 * sending the packet, so I will do that too */
772 char errbuf[PING_ERRMSG_LEN];
773 dprintf ("gettimeofday: %s\n",
774 sstrerror (errno, errbuf, sizeof (errbuf)));
776 timerclear (ptr->timer);
781 dprintf ("timer set for hostname = %s\n", ptr->hostname);
784 if (ptr->addrfamily == AF_INET6)
786 dprintf ("Sending ICMPv6 echo request to `%s'\n", ptr->hostname);
787 if (ping_send_one_ipv6 (obj, ptr, fd) != 0)
789 timerclear (ptr->timer);
793 else if (ptr->addrfamily == AF_INET)
795 dprintf ("Sending ICMPv4 echo request to `%s'\n", ptr->hostname);
796 if (ping_send_one_ipv4 (obj, ptr, fd) != 0)
798 timerclear (ptr->timer);
802 else /* this should not happen */
804 dprintf ("Unknown address family: %i\n", ptr->addrfamily);
805 timerclear (ptr->timer);
815 * Set the TTL of a socket protocol independently.
817 static int ping_set_ttl (pingobj_t *obj, int ttl)
820 char errbuf[PING_ERRMSG_LEN];
824 if (setsockopt (obj->fd4, IPPROTO_IP, IP_TTL,
828 ping_set_error (obj, "ping_set_ttl",
829 sstrerror (ret, errbuf, sizeof (errbuf)));
830 dprintf ("Setting TTLv4 failed: %s\n", errbuf);
836 dprintf ("Setting TTLv6 to %i\n", ttl);
837 if (setsockopt (obj->fd6, IPPROTO_IPV6, IPV6_UNICAST_HOPS,
841 ping_set_error (obj, "ping_set_ttl",
842 sstrerror (ret, errbuf, sizeof (errbuf)));
843 dprintf ("Setting TTLv6 failed: %s\n", errbuf);
851 * Set the TOS of a socket protocol independently.
853 * Using SOL_SOCKET / SO_PRIORITY might be a protocol independent way to
854 * set this. See socket(7) for details.
856 static int ping_set_qos (pingobj_t *obj, uint8_t qos)
859 char errbuf[PING_ERRMSG_LEN];
863 dprintf ("Setting TP_TOS to %#04"PRIx8"\n", qos);
864 if (setsockopt (obj->fd4, IPPROTO_IP, IP_TOS,
868 ping_set_error (obj, "ping_set_qos",
869 sstrerror (ret, errbuf, sizeof (errbuf)));
870 dprintf ("Setting TP_TOS failed: %s\n", errbuf);
876 /* IPV6_TCLASS requires an "int". */
879 dprintf ("Setting IPV6_TCLASS to %#04"PRIx8" (%i)\n", qos, tmp);
880 if (setsockopt (obj->fd6, IPPROTO_IPV6, IPV6_TCLASS,
884 ping_set_error (obj, "ping_set_qos",
885 sstrerror (ret, errbuf, sizeof (errbuf)));
886 dprintf ("Setting IPV6_TCLASS failed: %s\n", errbuf);
893 static int ping_get_ident (void)
896 static int did_seed = 0;
902 if ((fd = open ("/dev/urandom", O_RDONLY)) != -1)
906 if (read (fd, &seed, sizeof (seed)) != -1)
909 dprintf ("Random seed: %#x\n", seed);
918 char errbuf[PING_ERRMSG_LEN];
919 dprintf ("open (/dev/urandom): %s\n",
920 sstrerror (errno, errbuf, sizeof (errbuf)));
925 retval = (int) random ();
927 dprintf ("Random number: %#x\n", retval);
932 static pinghost_t *ping_alloc (void)
937 ph_size = sizeof (pinghost_t)
938 + sizeof (struct sockaddr_storage)
939 + sizeof (struct timeval);
941 ph = (pinghost_t *) malloc (ph_size);
945 memset (ph, '\0', ph_size);
947 ph->timer = (struct timeval *) (ph + 1);
948 ph->addr = (struct sockaddr_storage *) (ph->timer + 1);
950 ph->addrlen = sizeof (struct sockaddr_storage);
953 ph->ident = ping_get_ident () & 0xFFFF;
958 static void ping_free (pinghost_t *ph)
970 /* ping_open_socket opens, initializes and returns a new raw socket to use for
971 * ICMPv4 or ICMPv6 packets. addrfam must be either AF_INET or AF_INET6. On
972 * error, -1 is returned and obj->errmsg is set appropriately. */
973 static int ping_open_socket(pingobj_t *obj, int addrfam)
976 if (addrfam == AF_INET6)
978 fd = socket(addrfam, SOCK_RAW, IPPROTO_ICMPV6);
980 else if (addrfam == AF_INET)
982 fd = socket(addrfam, SOCK_RAW, IPPROTO_ICMP);
984 else /* this should not happen */
986 ping_set_error (obj, "ping_open_socket", "Unknown address family");
987 dprintf ("Unknown address family: %i\n", addrfam);
993 ping_set_errno (obj, errno);
995 char errbuf[PING_ERRMSG_LEN];
996 dprintf ("socket: %s\n",
997 sstrerror (errno, errbuf, sizeof (errbuf)));
1001 else if (fd >= FD_SETSIZE)
1003 ping_set_errno (obj, EMFILE);
1004 dprintf ("socket(2) returned file descriptor %d, which is above the file "
1005 "descriptor limit for select(2) (FD_SETSIZE = %d)\n",
1011 if (obj->srcaddr != NULL)
1013 assert (obj->srcaddrlen > 0);
1014 assert (obj->srcaddrlen <= sizeof (struct sockaddr_storage));
1016 if (bind (fd, obj->srcaddr, obj->srcaddrlen) == -1)
1018 ping_set_errno (obj, errno);
1020 char errbuf[PING_ERRMSG_LEN];
1021 dprintf ("bind: %s\n",
1022 sstrerror (errno, errbuf, sizeof (errbuf)));
1029 #ifdef SO_BINDTODEVICE
1030 if (obj->device != NULL)
1032 if (setsockopt (fd, SOL_SOCKET, SO_BINDTODEVICE,
1033 obj->device, strlen (obj->device) + 1) != 0)
1035 ping_set_errno (obj, errno);
1037 char errbuf[PING_ERRMSG_LEN];
1038 dprintf ("setsockopt (SO_BINDTODEVICE): %s\n",
1039 sstrerror (errno, errbuf, sizeof (errbuf)));
1045 #endif /* SO_BINDTODEVICE */
1049 if (setsockopt(fd, SOL_SOCKET, SO_MARK,
1050 &obj->mark, sizeof(obj->mark)) != 0)
1052 ping_set_errno (obj, errno);
1054 char errbuf[PING_ERRMSG_LEN];
1055 dprintf ("setsockopt (SO_MARK): %s\n",
1056 sstrerror (errno, errbuf, sizeof (errbuf)));
1066 int status = setsockopt (fd, SOL_SOCKET, SO_TIMESTAMP,
1067 &(int){1}, sizeof(int));
1070 ping_set_errno (obj, errno);
1072 char errbuf[PING_ERRMSG_LEN];
1073 dprintf ("setsockopt (SO_TIMESTAMP): %s\n",
1074 sstrerror (errno, errbuf, sizeof (errbuf)));
1080 #endif /* SO_TIMESTAMP */
1082 if (addrfam == AF_INET)
1085 /* Enable receiving the TOS field */
1086 setsockopt (fd, IPPROTO_IP, IP_RECVTOS, &(int){1}, sizeof(int));
1087 #endif /* IP_RECVTOS */
1089 /* Enable receiving the TTL field */
1090 setsockopt (fd, IPPROTO_IP, IP_RECVTTL, &(int){1}, sizeof(int));
1092 #if defined(IPV6_RECVHOPLIMIT) || defined(IPV6_RECVTCLASS)
1093 else if (addrfam == AF_INET6)
1095 # if defined(IPV6_RECVHOPLIMIT)
1096 /* For details see RFC 3542, section 6.3. */
1097 setsockopt (fd, IPPROTO_IPV6, IPV6_RECVHOPLIMIT,
1098 &(int){1}, sizeof(int));
1099 # endif /* IPV6_RECVHOPLIMIT */
1101 # if defined(IPV6_RECVTCLASS)
1102 /* For details see RFC 3542, section 6.5. */
1103 setsockopt (fd, IPPROTO_IPV6, IPV6_RECVTCLASS,
1104 &(int){1}, sizeof(int));
1105 # endif /* IPV6_RECVTCLASS */
1107 #endif /* IPV6_RECVHOPLIMIT || IPV6_RECVTCLASS */
1115 const char *ping_get_error (pingobj_t *obj)
1119 return (obj->errmsg);
1122 pingobj_t *ping_construct (void)
1126 if ((obj = malloc (sizeof (*obj))) == NULL)
1128 memset (obj, 0, sizeof (*obj));
1130 obj->timeout = PING_DEF_TIMEOUT;
1131 obj->ttl = PING_DEF_TTL;
1132 obj->addrfamily = PING_DEF_AF;
1133 obj->data = strdup (PING_DEF_DATA);
1141 void ping_destroy (pingobj_t *obj)
1143 pinghost_t *current;
1149 current = obj->head;
1152 while (current != NULL)
1154 next = current->next;
1155 ping_free (current);
1160 free (obj->srcaddr);
1174 int ping_setopt (pingobj_t *obj, int option, void *value)
1178 if ((obj == NULL) || (value == NULL))
1185 obj->qos = *((uint8_t *) value);
1186 ret = ping_set_qos (obj, obj->qos);
1190 case PING_OPT_TIMEOUT:
1191 obj->timeout = *((double *) value);
1192 if (obj->timeout < 0.0)
1194 obj->timeout = PING_DEF_TIMEOUT;
1200 ret = *((int *) value);
1201 if ((ret < 1) || (ret > 255))
1203 obj->ttl = PING_DEF_TTL;
1209 ret = ping_set_ttl (obj, obj->ttl);
1214 obj->addrfamily = *((int *) value);
1215 if ((obj->addrfamily != AF_UNSPEC)
1216 && (obj->addrfamily != AF_INET)
1217 && (obj->addrfamily != AF_INET6))
1219 obj->addrfamily = PING_DEF_AF;
1222 if (obj->srcaddr != NULL)
1224 free (obj->srcaddr);
1225 obj->srcaddr = NULL;
1230 if (obj->data != NULL)
1235 obj->data = strdup ((const char *) value);
1238 case PING_OPT_SOURCE:
1240 char *hostname = (char *) value;
1241 struct addrinfo ai_hints;
1242 struct addrinfo *ai_list;
1245 if (obj->addrfamily != AF_UNSPEC)
1247 dprintf ("Resetting obj->addrfamily to AF_UNSPEC.\n");
1250 memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
1251 ai_hints.ai_family = obj->addrfamily = AF_UNSPEC;
1252 #if defined(AI_ADDRCONFIG)
1253 ai_hints.ai_flags = AI_ADDRCONFIG;
1255 status = getaddrinfo (hostname, NULL, &ai_hints, &ai_list);
1258 #if defined(EAI_SYSTEM)
1259 char errbuf[PING_ERRMSG_LEN];
1261 ping_set_error (obj, "getaddrinfo",
1262 #if defined(EAI_SYSTEM)
1263 (status == EAI_SYSTEM)
1264 ? sstrerror (errno, errbuf, sizeof (errbuf)) :
1266 gai_strerror (status));
1271 if (ai_list->ai_next != NULL)
1273 dprintf ("hostname = `%s' is ambiguous.\n", hostname);
1276 if (obj->srcaddr == NULL)
1278 obj->srcaddrlen = 0;
1279 obj->srcaddr = malloc (sizeof (struct sockaddr_storage));
1280 if (obj->srcaddr == NULL)
1282 ping_set_errno (obj, errno);
1284 freeaddrinfo (ai_list);
1288 memset ((void *) obj->srcaddr, 0, sizeof (struct sockaddr_storage));
1289 assert (ai_list->ai_addrlen <= sizeof (struct sockaddr_storage));
1290 memcpy ((void *) obj->srcaddr, (const void *) ai_list->ai_addr,
1291 ai_list->ai_addrlen);
1292 obj->srcaddrlen = ai_list->ai_addrlen;
1293 obj->addrfamily = ai_list->ai_family;
1295 freeaddrinfo (ai_list);
1296 } /* case PING_OPT_SOURCE */
1299 case PING_OPT_DEVICE:
1301 #ifdef SO_BINDTODEVICE
1302 char *device = strdup ((char *) value);
1306 ping_set_errno (obj, errno);
1311 if (obj->device != NULL)
1313 obj->device = device;
1314 #else /* ! SO_BINDTODEVICE */
1315 ping_set_errno (obj, ENOTSUP);
1317 #endif /* ! SO_BINDTODEVICE */
1318 } /* case PING_OPT_DEVICE */
1324 obj->mark = *(int*)(value);
1327 ping_set_errno (obj, ENOTSUP);
1329 #endif /* !SO_MARK */
1331 } /* case PING_OPT_MARK */
1336 } /* switch (option) */
1339 } /* int ping_setopt */
1341 int ping_send (pingobj_t *obj)
1345 struct timeval endtime;
1346 struct timeval nowtime;
1347 struct timeval timeout;
1349 _Bool need_ipv4_socket = 0;
1350 _Bool need_ipv6_socket = 0;
1352 for (ptr = obj->head; ptr != NULL; ptr = ptr->next)
1354 ptr->latency = -1.0;
1357 if (ptr->addrfamily == AF_INET)
1358 need_ipv4_socket = 1;
1359 else if (ptr->addrfamily == AF_INET6)
1360 need_ipv6_socket = 1;
1363 if (!need_ipv4_socket && !need_ipv6_socket)
1365 ping_set_error (obj, "ping_send", "No hosts to ping");
1369 if (need_ipv4_socket && obj->fd4 == -1)
1371 obj->fd4 = ping_open_socket(obj, AF_INET);
1374 ping_set_ttl (obj, obj->ttl);
1375 ping_set_qos (obj, obj->qos);
1377 if (need_ipv6_socket && obj->fd6 == -1)
1379 obj->fd6 = ping_open_socket(obj, AF_INET6);
1382 ping_set_ttl (obj, obj->ttl);
1383 ping_set_qos (obj, obj->qos);
1386 if (gettimeofday (&nowtime, NULL) == -1)
1388 ping_set_errno (obj, errno);
1392 /* Set up timeout */
1393 timeout.tv_sec = (time_t) obj->timeout;
1394 timeout.tv_usec = (suseconds_t) (1000000 * (obj->timeout - ((double) timeout.tv_sec)));
1396 dprintf ("Set timeout to %i.%06i seconds\n",
1397 (int) timeout.tv_sec,
1398 (int) timeout.tv_usec);
1400 ping_timeval_add (&nowtime, &timeout, &endtime);
1402 /* host_to_ping points to the host to which to send the next ping. The
1403 * pointer is advanced to the next host in the linked list after the
1404 * ping has been sent. If host_to_ping is NULL, no more pings need to be
1406 pinghost_t *host_to_ping = obj->head;
1408 /* pings_in_flight is the number of hosts we sent a "ping" to but didn't
1409 * receive a "pong" yet. */
1410 int pings_in_flight = 0;
1412 /* pongs_received is the number of echo replies received. Unless there
1413 * is an error, this is used as the return value of ping_send(). */
1414 int pongs_received = 0;
1416 int error_count = 0;
1418 while (pings_in_flight > 0 || host_to_ping != NULL)
1426 FD_ZERO (&read_fds);
1427 FD_ZERO (&write_fds);
1431 FD_SET(obj->fd4, &read_fds);
1432 if (host_to_ping != NULL && host_to_ping->addrfamily == AF_INET)
1433 write_fd = obj->fd4;
1435 if (max_fd < obj->fd4)
1441 FD_SET(obj->fd6, &read_fds);
1442 if (host_to_ping != NULL && host_to_ping->addrfamily == AF_INET6)
1443 write_fd = obj->fd6;
1445 if (max_fd < obj->fd6)
1450 FD_SET(write_fd, &write_fds);
1452 assert (max_fd != -1);
1453 assert (max_fd < FD_SETSIZE);
1455 if (gettimeofday (&nowtime, NULL) == -1)
1457 ping_set_errno (obj, errno);
1461 if (ping_timeval_sub (&endtime, &nowtime, &timeout) == -1)
1464 dprintf ("Waiting on %i sockets for %u.%06u seconds\n",
1465 ((obj->fd4 != -1) ? 1 : 0) + ((obj->fd6 != -1) ? 1 : 0),
1466 (unsigned) timeout.tv_sec,
1467 (unsigned) timeout.tv_usec);
1469 int status = select (max_fd + 1, &read_fds, &write_fds, NULL, &timeout);
1471 if (gettimeofday (&nowtime, NULL) == -1)
1473 ping_set_errno (obj, errno);
1479 ping_set_errno (obj, errno);
1480 dprintf ("select: %s\n", obj->errmsg);
1483 else if (status == 0)
1485 dprintf ("select timed out\n");
1488 for (ph = obj->head; ph != NULL; ph = ph->next)
1489 if (ph->latency < 0.0)
1494 /* first, check if we can receive a reply ... */
1495 if (obj->fd6 != -1 && FD_ISSET (obj->fd6, &read_fds))
1497 if (ping_receive_one (obj, &nowtime, AF_INET6) == 0)
1504 if (obj->fd4 != -1 && FD_ISSET (obj->fd4, &read_fds))
1506 if (ping_receive_one (obj, &nowtime, AF_INET) == 0)
1514 /* ... and if no reply is available to read, continue sending
1517 /* this condition should always be true. We keep it for
1518 * consistency with the read blocks above and just to be on the
1520 if (write_fd != -1 && FD_ISSET (write_fd, &write_fds))
1522 if (ping_send_one (obj, host_to_ping, write_fd) == 0)
1526 host_to_ping = host_to_ping->next;
1532 return (-1 * error_count);
1533 return (pongs_received);
1534 } /* int ping_send */
1536 static pinghost_t *ping_host_search (pinghost_t *ph, const char *host)
1540 if (strcasecmp (ph->username, host) == 0)
1549 int ping_host_add (pingobj_t *obj, const char *host)
1553 struct addrinfo ai_hints;
1554 struct addrinfo *ai_list, *ai_ptr;
1557 if ((obj == NULL) || (host == NULL))
1560 dprintf ("host = %s\n", host);
1562 if (ping_host_search (obj->head, host) != NULL)
1565 memset (&ai_hints, '\0', sizeof (ai_hints));
1566 ai_hints.ai_flags = 0;
1567 #ifdef AI_ADDRCONFIG
1568 ai_hints.ai_flags |= AI_ADDRCONFIG;
1571 ai_hints.ai_flags |= AI_CANONNAME;
1573 ai_hints.ai_family = obj->addrfamily;
1574 ai_hints.ai_socktype = SOCK_RAW;
1576 if ((ph = ping_alloc ()) == NULL)
1578 dprintf ("Out of memory!\n");
1582 if ((ph->username = strdup (host)) == NULL)
1584 dprintf ("Out of memory!\n");
1585 ping_set_errno (obj, errno);
1590 if ((ph->hostname = strdup (host)) == NULL)
1592 dprintf ("Out of memory!\n");
1593 ping_set_errno (obj, errno);
1598 /* obj->data is not garuanteed to be != NULL */
1599 if ((ph->data = strdup (obj->data == NULL ? PING_DEF_DATA : obj->data)) == NULL)
1601 dprintf ("Out of memory!\n");
1602 ping_set_errno (obj, errno);
1607 if ((ai_return = getaddrinfo (host, NULL, &ai_hints, &ai_list)) != 0)
1609 #if defined(EAI_SYSTEM)
1610 char errbuf[PING_ERRMSG_LEN];
1612 dprintf ("getaddrinfo failed\n");
1613 ping_set_error (obj, "getaddrinfo",
1614 #if defined(EAI_SYSTEM)
1615 (ai_return == EAI_SYSTEM)
1616 ? sstrerror (errno, errbuf, sizeof (errbuf)) :
1618 gai_strerror (ai_return));
1623 if (ai_list == NULL)
1624 ping_set_error (obj, "getaddrinfo", "No hosts returned");
1626 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1628 if (ai_ptr->ai_family == AF_INET)
1630 ai_ptr->ai_socktype = SOCK_RAW;
1631 ai_ptr->ai_protocol = IPPROTO_ICMP;
1633 else if (ai_ptr->ai_family == AF_INET6)
1635 ai_ptr->ai_socktype = SOCK_RAW;
1636 ai_ptr->ai_protocol = IPPROTO_ICMPV6;
1640 char errmsg[PING_ERRMSG_LEN];
1642 snprintf (errmsg, PING_ERRMSG_LEN, "Unknown `ai_family': %i", ai_ptr->ai_family);
1643 errmsg[PING_ERRMSG_LEN - 1] = '\0';
1645 dprintf ("%s", errmsg);
1646 ping_set_error (obj, "getaddrinfo", errmsg);
1650 assert (sizeof (struct sockaddr_storage) >= ai_ptr->ai_addrlen);
1651 memset (ph->addr, '\0', sizeof (struct sockaddr_storage));
1652 memcpy (ph->addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
1653 ph->addrlen = ai_ptr->ai_addrlen;
1654 ph->addrfamily = ai_ptr->ai_family;
1657 if ((ai_ptr->ai_canonname != NULL)
1658 && (strcmp (ph->hostname, ai_ptr->ai_canonname) != 0))
1662 dprintf ("ph->hostname = %s; ai_ptr->ai_canonname = %s;\n",
1663 ph->hostname, ai_ptr->ai_canonname);
1665 old_hostname = ph->hostname;
1666 if ((ph->hostname = strdup (ai_ptr->ai_canonname)) == NULL)
1668 /* strdup failed, falling back to old hostname */
1669 ph->hostname = old_hostname;
1671 else if (old_hostname != NULL)
1673 free (old_hostname);
1676 #endif /* AI_CANONNAME */
1677 } /* for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) */
1679 freeaddrinfo (ai_list);
1682 * Adding in the front is much easier, but then the iterator will
1683 * return the host that was added last as first host. That's just not
1686 if (obj->head == NULL)
1695 while (hptr->next != NULL)
1698 assert ((hptr != NULL) && (hptr->next == NULL));
1702 ph->table_next = obj->table[ph->ident % PING_TABLE_LEN];
1703 obj->table[ph->ident % PING_TABLE_LEN] = ph;
1706 } /* int ping_host_add */
1708 int ping_host_remove (pingobj_t *obj, const char *host)
1710 pinghost_t *pre, *cur, *target;
1712 if ((obj == NULL) || (host == NULL))
1720 if (strcasecmp (host, cur->username) == 0)
1729 ping_set_error (obj, "ping_host_remove", "Host not found");
1734 obj->head = cur->next;
1736 pre->next = cur->next;
1741 cur = obj->table[target->ident % PING_TABLE_LEN];
1749 cur = cur->table_next;
1754 ping_set_error(obj, "ping_host_remove", "Host not found (T)");
1760 obj->table[target->ident % PING_TABLE_LEN] = cur->table_next;
1762 pre->table_next = cur->table_next;
1769 pingobj_iter_t *ping_iterator_get (pingobj_t *obj)
1773 return ((pingobj_iter_t *) obj->head);
1776 pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter)
1780 return ((pingobj_iter_t *) iter->next);
1783 int ping_iterator_count (pingobj_t *obj)
1789 pingobj_iter_t *iter = obj->head;
1797 int ping_iterator_get_info (pingobj_iter_t *iter, int info,
1798 void *buffer, size_t *buffer_len)
1802 size_t orig_buffer_len = *buffer_len;
1804 if ((iter == NULL) || (buffer_len == NULL))
1807 if ((buffer == NULL) && (*buffer_len != 0 ))
1812 case PING_INFO_USERNAME:
1814 *buffer_len = strlen (iter->username) + 1;
1815 if (orig_buffer_len <= *buffer_len)
1817 /* Since (orig_buffer_len > *buffer_len) `strncpy'
1818 * will copy `*buffer_len' and pad the rest of
1819 * `buffer' with null-bytes */
1820 strncpy (buffer, iter->username, orig_buffer_len);
1824 case PING_INFO_HOSTNAME:
1826 *buffer_len = strlen (iter->hostname) + 1;
1827 if (orig_buffer_len < *buffer_len)
1829 /* Since (orig_buffer_len > *buffer_len) `strncpy'
1830 * will copy `*buffer_len' and pad the rest of
1831 * `buffer' with null-bytes */
1832 strncpy (buffer, iter->hostname, orig_buffer_len);
1836 case PING_INFO_ADDRESS:
1837 ret = getnameinfo ((struct sockaddr *) iter->addr,
1845 if ((ret == EAI_MEMORY)
1847 || (ret == EAI_OVERFLOW)
1851 #if defined(EAI_SYSTEM)
1852 else if (ret == EAI_SYSTEM)
1860 case PING_INFO_FAMILY:
1862 *buffer_len = sizeof (int);
1863 if (orig_buffer_len < sizeof (int))
1865 *((int *) buffer) = iter->addrfamily;
1869 case PING_INFO_LATENCY:
1871 *buffer_len = sizeof (double);
1872 if (orig_buffer_len < sizeof (double))
1874 *((double *) buffer) = iter->latency;
1878 case PING_INFO_DROPPED:
1880 *buffer_len = sizeof (uint32_t);
1881 if (orig_buffer_len < sizeof (uint32_t))
1883 *((uint32_t *) buffer) = iter->dropped;
1887 case PING_INFO_SEQUENCE:
1889 *buffer_len = sizeof (unsigned int);
1890 if (orig_buffer_len < sizeof (unsigned int))
1892 *((unsigned int *) buffer) = (unsigned int) iter->sequence;
1896 case PING_INFO_IDENT:
1898 *buffer_len = sizeof (uint16_t);
1899 if (orig_buffer_len < sizeof (uint16_t))
1901 *((uint16_t *) buffer) = (uint16_t) iter->ident;
1905 case PING_INFO_DATA:
1907 *buffer_len = strlen (iter->data);
1908 if (orig_buffer_len < *buffer_len)
1910 strncpy ((char *) buffer, iter->data, orig_buffer_len);
1914 case PING_INFO_RECV_TTL:
1916 *buffer_len = sizeof (int);
1917 if (orig_buffer_len < sizeof (int))
1919 *((int *) buffer) = iter->recv_ttl;
1923 case PING_INFO_RECV_QOS:
1925 if (*buffer_len>sizeof(unsigned)) *buffer_len=sizeof(unsigned);
1926 if (!*buffer_len) *buffer_len=1;
1927 if (orig_buffer_len < *buffer_len)
1929 memcpy(buffer,&iter->recv_qos,*buffer_len);
1935 } /* ping_iterator_get_info */
1937 void *ping_iterator_get_context (pingobj_iter_t *iter)
1941 return (iter->context);
1944 void ping_iterator_set_context (pingobj_iter_t *iter, void *context)
1948 iter->context = context;