2 * Object oriented C module to send ICMP and ICMPv6 `echo's.
3 * Copyright (C) 2006 Florian octo Forster <octo at verplant.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
31 # error "You don't have the standard C99 header files installed"
32 #endif /* STDC_HEADERS */
42 # include <sys/types.h>
45 # include <sys/stat.h>
48 #if TIME_WITH_SYS_TIME
49 # include <sys/time.h>
53 # include <sys/time.h>
60 # include <sys/socket.h>
66 #if HAVE_NETINET_IN_SYSTM_H
67 # include <netinet/in_systm.h>
70 # include <netinet/in.h>
73 # include <netinet/ip.h>
75 #if HAVE_NETINET_IP_ICMP_H
76 # include <netinet/ip_icmp.h>
78 #ifdef HAVE_NETINET_IP_VAR_H
79 # include <netinet/ip_var.h>
81 #if HAVE_NETINET_IP6_H
82 # include <netinet/ip6.h>
84 #if HAVE_NETINET_ICMP6_H
85 # include <netinet/icmp6.h>
91 # define dprintf(...) printf ("%s[%4i]: %-20s: ", __FILE__, __LINE__, __FUNCTION__); printf (__VA_ARGS__)
93 # define dprintf(...) /**/
96 #define PING_ERRMSG_LEN 256
101 struct sockaddr_storage *addr;
107 struct timeval *timer;
112 struct pinghost *next;
122 char errmsg[PING_ERRMSG_LEN];
128 * private (static) functions
130 static void ping_set_error (pingobj_t *obj, const char *function,
133 snprintf (obj->errmsg, PING_ERRMSG_LEN, "%s: %s", function, message);
134 obj->errmsg[PING_ERRMSG_LEN - 1] = '\0';
137 static int ping_timeval_add (struct timeval *tv1, struct timeval *tv2,
140 res->tv_sec = tv1->tv_sec + tv2->tv_sec;
141 res->tv_usec = tv1->tv_usec + tv2->tv_usec;
143 while (res->tv_usec > 1000000)
145 res->tv_usec -= 1000000;
152 static int ping_timeval_sub (struct timeval *tv1, struct timeval *tv2,
156 if ((tv1->tv_sec < tv2->tv_sec)
157 || ((tv1->tv_sec == tv2->tv_sec)
158 && (tv1->tv_usec < tv2->tv_usec)))
161 res->tv_sec = tv1->tv_sec - tv2->tv_sec;
162 res->tv_usec = tv1->tv_usec - tv2->tv_usec;
164 assert ((res->tv_sec > 0) || ((res->tv_sec == 0) && (res->tv_usec > 0)));
166 while (res->tv_usec < 0)
168 res->tv_usec += 1000000;
175 static uint16_t ping_icmp4_checksum (char *buf, size_t len)
182 for (ptr = (uint16_t *) buf; len > 1; ptr++, len -= 2)
187 *(char *) &ret = *(char *) ptr;
191 /* Do this twice to get all possible carries.. */
192 sum = (sum >> 16) + (sum & 0xFFFF);
193 sum = (sum >> 16) + (sum & 0xFFFF);
200 static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffer_len)
203 struct icmp *icmp_hdr;
207 uint16_t recv_checksum;
208 uint16_t calc_checksum;
215 if (buffer_len < sizeof (struct ip))
218 ip_hdr = (struct ip *) buffer;
219 ip_hdr_len = ip_hdr->ip_hl << 2;
221 if (buffer_len < ip_hdr_len)
224 buffer += ip_hdr_len;
225 buffer_len -= ip_hdr_len;
227 if (buffer_len < sizeof (struct icmp))
230 icmp_hdr = (struct icmp *) buffer;
231 buffer += sizeof (struct icmp);
232 buffer_len -= sizeof (struct icmp);
234 if (icmp_hdr->icmp_type != ICMP_ECHOREPLY)
236 dprintf ("Unexpected ICMP type: %i\n", icmp_hdr->icmp_type);
240 recv_checksum = icmp_hdr->icmp_cksum;
241 icmp_hdr->icmp_cksum = 0;
242 calc_checksum = ping_icmp4_checksum ((char *) icmp_hdr,
243 sizeof (struct icmp) + buffer_len);
245 if (recv_checksum != calc_checksum)
247 dprintf ("Checksum missmatch: Got 0x%04x, calculated 0x%04x\n",
248 recv_checksum, calc_checksum);
252 ident = ntohs (icmp_hdr->icmp_id);
253 seq = ntohs (icmp_hdr->icmp_seq);
255 for (ptr = ph; ptr != NULL; ptr = ptr->next)
257 dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
258 ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
260 if (ptr->addrfamily != AF_INET)
263 if (!timerisset (ptr->timer))
266 if (ptr->ident != ident)
269 if (((ptr->sequence - 1) & 0xFFFF) != seq)
272 dprintf ("Match found: hostname = %s, ident = 0x%04x, seq = %i\n",
273 ptr->hostname, ident, seq);
280 dprintf ("No match found for ident = 0x%04x, seq = %i\n",
287 static pinghost_t *ping_receive_ipv6 (pinghost_t *ph, char *buffer, size_t buffer_len)
289 struct icmp6_hdr *icmp_hdr;
296 if (buffer_len < sizeof (struct icmp6_hdr))
299 icmp_hdr = (struct icmp6_hdr *) buffer;
300 buffer += sizeof (struct icmp);
301 buffer_len -= sizeof (struct icmp);
303 if (icmp_hdr->icmp6_type != ICMP6_ECHO_REPLY)
305 dprintf ("Unexpected ICMP type: %02x\n", icmp_hdr->icmp6_type);
309 if (icmp_hdr->icmp6_code != 0)
311 dprintf ("Unexpected ICMP code: %02x\n", icmp_hdr->icmp6_code);
315 ident = ntohs (icmp_hdr->icmp6_id);
316 seq = ntohs (icmp_hdr->icmp6_seq);
318 for (ptr = ph; ptr != NULL; ptr = ptr->next)
320 dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
321 ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
323 if (ptr->addrfamily != AF_INET6)
326 if (!timerisset (ptr->timer))
329 if (ptr->ident != ident)
332 if (((ptr->sequence - 1) & 0xFFFF) != seq)
335 dprintf ("Match found: hostname = %s, ident = 0x%04x, seq = %i\n",
336 ptr->hostname, ident, seq);
343 dprintf ("No match found for ident = 0x%04x, seq = %i\n",
350 static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
357 pinghost_t *host = NULL;
359 struct sockaddr_storage sa;
362 sa_len = sizeof (sa);
364 buffer_len = recvfrom (fd, buffer, sizeof (buffer), 0,
365 (struct sockaddr *) &sa, &sa_len);
366 if (buffer_len == -1)
368 dprintf ("recvfrom: %s\n", strerror (errno));
372 dprintf ("Read %i bytes from fd = %i\n", buffer_len, fd);
374 if (sa.ss_family == AF_INET)
376 if ((host = ping_receive_ipv4 (ph, buffer, buffer_len)) == NULL)
379 else if (sa.ss_family == AF_INET6)
381 if ((host = ping_receive_ipv6 (ph, buffer, buffer_len)) == NULL)
385 dprintf ("rcvd: %12i.%06i\n",
388 dprintf ("sent: %12i.%06i\n",
389 (int) host->timer->tv_sec,
390 (int) host->timer->tv_usec);
392 if (ping_timeval_sub (now, host->timer, &diff) < 0)
394 timerclear (host->timer);
398 dprintf ("diff: %12i.%06i\n",
402 host->latency = ((double) diff.tv_usec) / 1000.0;
403 host->latency += ((double) diff.tv_sec) * 1000.0;
405 timerclear (host->timer);
410 static int ping_receive_all (pingobj_t *obj)
419 struct timeval endtime;
420 struct timeval nowtime;
421 struct timeval timeout;
429 for (ptr = ph; ptr != NULL; ptr = ptr->next)
432 if (gettimeofday (&nowtime, NULL) == -1)
434 ping_set_error (obj, "gettimeofday", strerror (errno));
439 timeout.tv_sec = (time_t) obj->timeout;
440 timeout.tv_usec = (suseconds_t) (1000000 * (obj->timeout - ((double) timeout.tv_sec)));
442 dprintf ("Set timeout to %i.%06i seconds\n",
443 (int) timeout.tv_sec,
444 (int) timeout.tv_usec);
446 ping_timeval_add (&nowtime, &timeout, &endtime);
454 for (ptr = ph; ptr != NULL; ptr = ptr->next)
456 if (!timerisset (ptr->timer))
459 FD_SET (ptr->fd, &readfds);
462 if (max_readfds < ptr->fd)
463 max_readfds = ptr->fd;
466 if (num_readfds == 0)
469 if (gettimeofday (&nowtime, NULL) == -1)
471 ping_set_error (obj, "gettimeofday", strerror (errno));
475 if (ping_timeval_sub (&endtime, &nowtime, &timeout) == -1)
478 dprintf ("Waiting on %i sockets for %i.%06i seconds\n", num_readfds,
479 (int) timeout.tv_sec,
480 (int) timeout.tv_usec);
482 status = select (max_readfds + 1, &readfds, NULL, NULL, &timeout);
484 if (gettimeofday (&nowtime, NULL) == -1)
486 ping_set_error (obj, "gettimeofday", strerror (errno));
490 if ((status == -1) && (errno == EINTR))
492 dprintf ("select was interrupted by signal..\n");
497 dprintf ("select: %s\n", strerror (errno));
500 else if (status == 0)
502 dprintf ("select timed out\n");
506 for (ptr = ph; ptr != NULL; ptr = ptr->next)
508 if (FD_ISSET (ptr->fd, &readfds))
509 if (ping_receive_one (ptr->fd, ph, &nowtime) == 0)
517 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
518 * Sending functions: *
521 * +-> ping_send_one_ipv4 *
522 * `-> ping_send_one_ipv6 *
523 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
524 static ssize_t ping_sendto (pingobj_t *obj, pinghost_t *ph,
525 const void *buf, size_t buflen)
529 if (gettimeofday (ph->timer, NULL) == -1)
531 timerclear (ph->timer);
535 ret = sendto (ph->fd, buf, buflen, 0,
536 (struct sockaddr *) ph->addr, ph->addrlen);
539 ping_set_error (obj, "sendto", strerror (errno));
544 static int ping_send_one_ipv4 (pingobj_t *obj, pinghost_t *ph)
555 dprintf ("ph->hostname = %s\n", ph->hostname);
557 memset (buf, '\0', sizeof (buf));
558 icmp4 = (struct icmp *) buf;
559 data = (char *) (icmp4 + 1);
561 icmp4->icmp_type = ICMP_ECHO;
562 icmp4->icmp_code = 0;
563 icmp4->icmp_cksum = 0;
564 icmp4->icmp_id = htons (ph->ident);
565 icmp4->icmp_seq = htons (ph->sequence);
567 buflen = 4096 - sizeof (struct icmp);
568 if (obj->data != NULL)
569 strncpy (data, obj->data, buflen);
571 strncpy (data, PING_DEF_DATA, buflen);
572 datalen = strlen (data);
574 buflen = datalen + sizeof (struct icmp);
576 icmp4->icmp_cksum = ping_icmp4_checksum (buf, buflen);
578 dprintf ("Sending ICMPv4 package with ID 0x%04x\n", ph->ident);
580 status = ping_sendto (obj, ph, buf, buflen);
583 perror ("ping_sendto");
587 dprintf ("sendto: status = %i\n", status);
592 static int ping_send_one_ipv6 (pingobj_t *obj, pinghost_t *ph)
594 struct icmp6_hdr *icmp6;
603 dprintf ("ph->hostname = %s\n", ph->hostname);
605 memset (buf, '\0', sizeof (buf));
606 icmp6 = (struct icmp6_hdr *) buf;
607 data = (char *) (icmp6 + 1);
609 icmp6->icmp6_type = ICMP6_ECHO_REQUEST;
610 icmp6->icmp6_code = 0;
611 /* The checksum will be calculated by the TCP/IP stack. */
612 icmp6->icmp6_cksum = 0;
613 icmp6->icmp6_id = htons (ph->ident);
614 icmp6->icmp6_seq = htons (ph->sequence);
616 buflen = 4096 - sizeof (struct icmp6_hdr);
617 if (obj->data != NULL)
618 strncpy (data, obj->data, buflen);
620 strncpy (data, PING_DEF_DATA, buflen);
621 datalen = strlen (data);
623 buflen = datalen + sizeof (struct icmp6_hdr);
625 dprintf ("Sending ICMPv6 package with ID 0x%04x\n", ph->ident);
627 status = ping_sendto (obj, ph, buf, buflen);
630 perror ("ping_sendto");
634 dprintf ("sendto: status = %i\n", status);
639 static int ping_send_all (pingobj_t *obj)
649 for (ptr = ph; ptr != NULL; ptr = ptr->next)
651 /* start timer.. The GNU `ping6' starts the timer before
652 * sending the packet, so I will do that too */
653 if (gettimeofday (ptr->timer, NULL) == -1)
655 dprintf ("gettimeofday: %s\n", strerror (errno));
656 timerclear (ptr->timer);
662 dprintf ("timer set for hostname = %s\n", ptr->hostname);
665 if (ptr->addrfamily == AF_INET6)
667 dprintf ("Sending ICMPv6 echo request to `%s'\n", ptr->hostname);
668 if (ping_send_one_ipv6 (obj, ptr) != 0)
670 timerclear (ptr->timer);
675 else if (ptr->addrfamily == AF_INET)
677 dprintf ("Sending ICMPv4 echo request to `%s'\n", ptr->hostname);
678 if (ping_send_one_ipv4 (obj, ptr) != 0)
680 timerclear (ptr->timer);
685 else /* this should not happen */
687 dprintf ("Unknown address family: %i\n", ptr->addrfamily);
688 timerclear (ptr->timer);
700 * Set the TTL of a socket protocol independently.
702 static int ping_set_ttl (pinghost_t *ph, int ttl)
706 if (ph->addrfamily == AF_INET)
708 ret = setsockopt (ph->fd, IPPROTO_IP, IP_TTL, &ttl, sizeof (ttl));
710 else if (ph->addrfamily == AF_INET6)
712 ret = setsockopt (ph->fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &ttl, sizeof (ttl));
718 static int ping_get_ident (void)
721 static int did_seed = 0;
727 if ((fd = open ("/dev/urandom", O_RDONLY)) != -1)
731 if (read (fd, &seed, sizeof (seed)) != -1)
734 dprintf ("Random seed: %i\n", seed);
742 dprintf ("open (/dev/urandom): %s\n", strerror (errno));
746 retval = (int) random ();
748 dprintf ("Random number: %i\n", retval);
753 static pinghost_t *ping_alloc (void)
758 ph_size = sizeof (pinghost_t)
759 + sizeof (struct sockaddr_storage)
760 + sizeof (struct timeval);
762 ph = (pinghost_t *) malloc (ph_size);
766 memset (ph, '\0', ph_size);
768 ph->timer = (struct timeval *) (ph + 1);
769 ph->addr = (struct sockaddr_storage *) (ph->timer + 1);
771 ph->addrlen = sizeof (struct sockaddr_storage);
773 ph->ident = ping_get_ident () & 0xFFFF;
778 static void ping_free (pinghost_t *ph)
780 if (ph->hostname != NULL)
789 const char *ping_get_error (pingobj_t *obj)
791 return (obj->errmsg);
794 pingobj_t *ping_construct (void)
798 if ((obj = (pingobj_t *) malloc (sizeof (pingobj_t))) == NULL)
800 memset (obj, '\0', sizeof (pingobj_t));
802 obj->timeout = PING_DEF_TIMEOUT;
803 obj->ttl = PING_DEF_TTL;
804 obj->addrfamily = PING_DEF_AF;
809 void ping_destroy (pingobj_t *obj)
817 while (current != NULL)
819 next = current->next;
829 int ping_setopt (pingobj_t *obj, int option, void *value)
835 case PING_OPT_TIMEOUT:
836 obj->timeout = *((double *) value);
837 if (obj->timeout < 0.0)
839 obj->timeout = PING_DEF_TIMEOUT;
845 obj->ttl = *((int *) value);
846 if ((obj->ttl < 1) || (obj->ttl > 255))
848 obj->ttl = PING_DEF_TTL;
854 obj->addrfamily = *((int *) value);
855 if ((obj->addrfamily != AF_UNSPEC)
856 && (obj->addrfamily != AF_INET)
857 && (obj->addrfamily != AF_INET6))
859 obj->addrfamily = PING_DEF_AF;
865 if (obj->data != NULL)
870 obj->data = strdup ((const char *) value);
875 } /* switch (option) */
878 } /* int ping_setopt */
881 int ping_send (pingobj_t *obj)
885 if (ping_send_all (obj) < 0)
888 if ((ret = ping_receive_all (obj)) < 0)
894 static pinghost_t *ping_host_search (pinghost_t *ph, const char *host)
898 if (strcasecmp (ph->hostname, host) == 0)
907 int ping_host_add (pingobj_t *obj, const char *host)
911 struct sockaddr_storage sockaddr;
912 socklen_t sockaddr_len;
914 struct addrinfo ai_hints;
915 struct addrinfo *ai_list, *ai_ptr;
918 dprintf ("host = %s\n", host);
920 if (ping_host_search (obj->head, host) != NULL)
923 memset (&ai_hints, '\0', sizeof (ai_hints));
924 ai_hints.ai_flags = 0;
926 ai_hints.ai_flags |= AI_ADDRCONFIG;
928 ai_hints.ai_family = obj->addrfamily;
929 ai_hints.ai_socktype = SOCK_RAW;
931 if ((ph = ping_alloc ()) == NULL)
933 dprintf ("Out of memory!\n");
937 if ((ph->hostname = strdup (host)) == NULL)
939 dprintf ("Out of memory!\n");
940 ping_set_error (obj, "strdup", strerror (errno));
945 if ((ai_return = getaddrinfo (host, NULL, &ai_hints, &ai_list)) != 0)
947 dprintf ("getaddrinfo failed\n");
948 ping_set_error (obj, "getaddrinfo",
949 (ai_return == EAI_SYSTEM)
951 : gai_strerror (ai_return));
957 ping_set_error (obj, "getaddrinfo", "No hosts returned");
959 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
963 sockaddr_len = sizeof (sockaddr);
964 memset (&sockaddr, '\0', sockaddr_len);
966 if (ai_ptr->ai_family == AF_INET)
968 struct sockaddr_in *si;
970 si = (struct sockaddr_in *) &sockaddr;
971 si->sin_family = AF_INET;
972 si->sin_port = htons (ph->ident);
973 si->sin_addr.s_addr = htonl (INADDR_ANY);
975 ai_ptr->ai_socktype = SOCK_RAW;
976 ai_ptr->ai_protocol = IPPROTO_ICMP;
978 else if (ai_ptr->ai_family == AF_INET6)
980 struct sockaddr_in6 *si;
982 si = (struct sockaddr_in6 *) &sockaddr;
983 si->sin6_family = AF_INET6;
984 si->sin6_port = htons (ph->ident);
985 si->sin6_addr = in6addr_any;
987 ai_ptr->ai_socktype = SOCK_RAW;
988 ai_ptr->ai_protocol = IPPROTO_ICMPV6;
992 char errmsg[PING_ERRMSG_LEN];
994 snprintf (errmsg, PING_ERRMSG_LEN, "Unknown `ai_family': %i", ai_ptr->ai_family);
995 errmsg[PING_ERRMSG_LEN - 1] = '\0';
998 ping_set_error (obj, "getaddrinfo", errmsg);
1002 /* TODO: Move this to a static function `ping_open_socket' and
1003 * call it whenever the socket dies. */
1004 ph->fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
1007 dprintf ("socket: %s\n", strerror (errno));
1008 ping_set_error (obj, "socket", strerror (errno));
1012 if (bind (ph->fd, (struct sockaddr *) &sockaddr, sockaddr_len) == -1)
1014 dprintf ("bind: %s\n", strerror (errno));
1015 ping_set_error (obj, "bind", strerror (errno));
1021 assert (sizeof (struct sockaddr_storage) >= ai_ptr->ai_addrlen);
1022 memset (ph->addr, '\0', sizeof (struct sockaddr_storage));
1023 memcpy (ph->addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
1024 ph->addrlen = ai_ptr->ai_addrlen;
1025 ph->addrfamily = ai_ptr->ai_family;
1030 freeaddrinfo (ai_list);
1034 free (ph->hostname);
1039 ph->next = obj->head;
1042 ping_set_ttl (ph, obj->ttl);
1047 int ping_host_remove (pingobj_t *obj, const char *host)
1049 pinghost_t *pre, *cur;
1056 if (strcasecmp (host, cur->hostname))
1065 ping_set_error (obj, "ping_host_remove", "Host not found");
1070 obj->head = cur->next;
1072 pre->next = cur->next;
1082 pingobj_iter_t *ping_iterator_get (pingobj_t *obj)
1084 return ((pingobj_iter_t *) obj->head);
1087 pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter)
1089 return ((pingobj_iter_t *) iter->next);
1092 int ping_iterator_get_info (pingobj_iter_t *iter, int info,
1093 void *buffer, size_t *buffer_len)
1097 size_t orig_buffer_len = *buffer_len;
1101 case PING_INFO_HOSTNAME:
1103 *buffer_len = strlen (iter->hostname);
1104 if (orig_buffer_len <= *buffer_len)
1106 /* Since (orig_buffer_len > *buffer_len) `strncpy'
1107 * will copy `*buffer_len' and pad the rest of
1108 * `buffer' with null-bytes */
1109 strncpy (buffer, iter->hostname, orig_buffer_len);
1113 case PING_INFO_ADDRESS:
1114 ret = getnameinfo ((struct sockaddr *) iter->addr,
1122 if ((ret == EAI_MEMORY)
1124 || (ret == EAI_OVERFLOW)
1128 else if (ret == EAI_SYSTEM)
1129 /* XXX: Not thread-safe! */
1136 case PING_INFO_FAMILY:
1138 *buffer_len = sizeof (int);
1139 if (orig_buffer_len < sizeof (int))
1141 *((int *) buffer) = iter->addrfamily;
1145 case PING_INFO_LATENCY:
1147 *buffer_len = sizeof (double);
1148 if (orig_buffer_len < sizeof (double))
1150 *((double *) buffer) = iter->latency;
1154 /* FIXME Return the sequence as an unsigned int */
1155 case PING_INFO_SEQUENCE:
1157 *buffer_len = sizeof (unsigned int);
1158 if (orig_buffer_len < sizeof (unsigned int))
1160 *((unsigned int *) buffer) = (unsigned int) iter->sequence;
1164 case PING_INFO_IDENT:
1166 *buffer_len = sizeof (uint16_t);
1167 if (orig_buffer_len < sizeof (uint16_t))
1169 *((uint16_t *) buffer) = (uint16_t) iter->ident;
1177 void *ping_iterator_get_context (pingobj_iter_t *iter)
1179 return (iter->context);
1182 void ping_iterator_set_context (pingobj_iter_t *iter, void *context)
1184 iter->context = context;