Code

Relicense: Use the LGPL v2.1 (or later) for liboping.
[liboping.git] / src / liboping.c
index 0cff9f43a6422c0d563f59abf0eed2416928a3a5..3c1c92a4a5a1ab7a86dac708f18eb83a2fe36267 100644 (file)
@@ -1,20 +1,20 @@
 /**
  * Object oriented C module to send ICMP and ICMPv6 `echo's.
- * Copyright (C) 2006-2009  Florian octo Forster <octo at verplant.org>
+ * Copyright (C) 2006-2010  Florian octo Forster <octo at verplant.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; only version 2 of the License is
- * applicable.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by the
+ * Free Software Foundation; either version 2.1 of the License, or (at your
+ * option) any later version.
+ * 
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+ * for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #if HAVE_CONFIG_H
@@ -134,6 +134,8 @@ struct pingobj
        struct sockaddr         *srcaddr;
        socklen_t                srcaddrlen;
 
+       char                    *device;
+
        char                     errmsg[PING_ERRMSG_LEN];
 
        pinghost_t              *head;
@@ -145,7 +147,7 @@ struct pingobj
 /* Even though Posix requires "strerror_r" to return an "int",
  * some systems (e.g. the GNU libc) return a "char *" _and_
  * ignore the second argument ... -tokkee */
-char *sstrerror (int errnum, char *buf, size_t buflen)
+static char *sstrerror (int errnum, char *buf, size_t buflen)
 {
        buf[0] = 0;
 
@@ -259,7 +261,8 @@ static uint16_t ping_icmp4_checksum (char *buf, size_t len)
        return (ret);
 }
 
-static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffer_len)
+static pinghost_t *ping_receive_ipv4 (pingobj_t *obj, char *buffer,
+               size_t buffer_len)
 {
        struct ip *ip_hdr;
        struct icmp *icmp_hdr;
@@ -306,7 +309,8 @@ static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffe
 
        if (recv_checksum != calc_checksum)
        {
-               dprintf ("Checksum missmatch: Got 0x%04x, calculated 0x%04x\n",
+               dprintf ("Checksum missmatch: Got 0x%04"PRIx16", "
+                               "calculated 0x%04"PRIx16"\n",
                                recv_checksum, calc_checksum);
                return (NULL);
        }
@@ -314,7 +318,9 @@ static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffe
        ident = ntohs (icmp_hdr->icmp_id);
        seq   = ntohs (icmp_hdr->icmp_seq);
 
-       for (ptr = ph; ptr != NULL; ptr = ptr->next)
+       /* We have to iterate over all hosts, since ICMPv4 packets may
+        * be received on any raw v4 socket. */
+       for (ptr = obj->head; ptr != NULL; ptr = ptr->next)
        {
                dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
                                ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
@@ -331,7 +337,8 @@ static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffe
                if (((ptr->sequence - 1) & 0xFFFF) != seq)
                        continue;
 
-               dprintf ("Match found: hostname = %s, ident = 0x%04x, seq = %i\n",
+               dprintf ("Match found: hostname = %s, ident = 0x%04"PRIx16", "
+                               "seq = %"PRIu16"\n",
                                ptr->hostname, ident, seq);
 
                break;
@@ -339,7 +346,7 @@ static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffe
 
        if (ptr == NULL)
        {
-               dprintf ("No match found for ident = 0x%04x, seq = %i\n",
+               dprintf ("No match found for ident = 0x%04"PRIx16", seq = %"PRIu16"\n",
                                ident, seq);
        }
 
@@ -365,7 +372,8 @@ static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffe
 # endif
 #endif
 
-static pinghost_t *ping_receive_ipv6 (pinghost_t *ph, char *buffer, size_t buffer_len)
+static pinghost_t *ping_receive_ipv6 (pingobj_t *obj, char *buffer,
+               size_t buffer_len)
 {
        struct icmp6_hdr *icmp_hdr;
 
@@ -396,7 +404,9 @@ static pinghost_t *ping_receive_ipv6 (pinghost_t *ph, char *buffer, size_t buffe
        ident = ntohs (icmp_hdr->icmp6_id);
        seq   = ntohs (icmp_hdr->icmp6_seq);
 
-       for (ptr = ph; ptr != NULL; ptr = ptr->next)
+       /* We have to iterate over all hosts, since ICMPv6 packets may
+        * be received on any raw v6 socket. */
+       for (ptr = obj->head; ptr != NULL; ptr = ptr->next)
        {
                dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
                                ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
@@ -413,7 +423,8 @@ static pinghost_t *ping_receive_ipv6 (pinghost_t *ph, char *buffer, size_t buffe
                if (((ptr->sequence - 1) & 0xFFFF) != seq)
                        continue;
 
-               dprintf ("Match found: hostname = %s, ident = 0x%04x, seq = %i\n",
+               dprintf ("Match found: hostname = %s, ident = 0x%04"PRIx16", "
+                               "seq = %"PRIu16"\n",
                                ptr->hostname, ident, seq);
 
                break;
@@ -421,15 +432,21 @@ static pinghost_t *ping_receive_ipv6 (pinghost_t *ph, char *buffer, size_t buffe
 
        if (ptr == NULL)
        {
-               dprintf ("No match found for ident = 0x%04x, seq = %i\n",
+               dprintf ("No match found for ident = 0x%04"PRIx16", "
+                               "seq = %"PRIu16"\n",
                                ident, seq);
        }
 
        return (ptr);
 }
 
-static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
+static int ping_receive_one (pingobj_t *obj, const pinghost_t *ph,
+               struct timeval *now)
 {
+       /* Note: 'ph' is not necessarily the host object for which we receive a
+        * reply. The right object will be returned by ping_receive_ipv*(). For
+        * now, we can only rely on ph->fd and ph->addrfamily. */
+
        struct timeval diff;
        pinghost_t *host = NULL;
        int recv_ttl;
@@ -464,7 +481,7 @@ static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
        msghdr.msg_flags |= MSG_XPG4_2;
 #endif
 
-       payload_buffer_len = recvmsg (fd, &msghdr, /* flags = */ 0);
+       payload_buffer_len = recvmsg (ph->fd, &msghdr, /* flags = */ 0);
        if (payload_buffer_len < 0)
        {
 #if WITH_DEBUG
@@ -474,11 +491,10 @@ static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
 #endif
                return (-1);
        }
-       dprintf ("Read %zi bytes from fd = %i\n", payload_buffer_len, fd);
+       dprintf ("Read %zi bytes from fd = %i\n", payload_buffer_len, ph->fd);
 
        /* Iterate over all auxiliary data in msghdr */
        recv_ttl = -1;
-       ph->recv_ttl = -1;
        for (cmsg = CMSG_FIRSTHDR (&msghdr); /* {{{ */
                        cmsg != NULL;
                        cmsg = CMSG_NXTHDR (&msghdr, cmsg))
@@ -527,13 +543,13 @@ static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
 
        if (ph->addrfamily == AF_INET)
        {
-               host = ping_receive_ipv4 (ph, payload_buffer, payload_buffer_len);
+               host = ping_receive_ipv4 (obj, payload_buffer, payload_buffer_len);
                if (host == NULL)
                        return (-1);
        }
        else if (ph->addrfamily == AF_INET6)
        {
-               host = ping_receive_ipv6 (ph, payload_buffer, payload_buffer_len);
+               host = ping_receive_ipv6 (obj, payload_buffer, payload_buffer_len);
                if (host == NULL)
                        return (-1);
        }
@@ -574,9 +590,10 @@ static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
 
 static int ping_receive_all (pingobj_t *obj)
 {
-       fd_set readfds;
-       int num_readfds;
-       int max_readfds;
+       fd_set read_fds;
+       fd_set err_fds;
+       int num_fds;
+       int max_fd;
 
        pinghost_t *ph;
        pinghost_t *ptr;
@@ -592,7 +609,10 @@ static int ping_receive_all (pingobj_t *obj)
        ret = 0;
 
        for (ptr = ph; ptr != NULL; ptr = ptr->next)
-               ptr->latency = -1.0;
+       {
+               ptr->latency  = -1.0;
+               ptr->recv_ttl = -1;
+       }
 
        if (gettimeofday (&nowtime, NULL) == -1)
        {
@@ -612,23 +632,25 @@ static int ping_receive_all (pingobj_t *obj)
 
        while (1)
        {
-               FD_ZERO (&readfds);
-               num_readfds =  0;
-               max_readfds = -1;
+               FD_ZERO (&read_fds);
+               FD_ZERO (&err_fds);
+               num_fds =  0;
+               max_fd = -1;
 
                for (ptr = ph; ptr != NULL; ptr = ptr->next)
                {
                        if (!timerisset (ptr->timer))
                                continue;
 
-                       FD_SET (ptr->fd, &readfds);
-                       num_readfds++;
+                       FD_SET (ptr->fd, &read_fds);
+                       FD_SET (ptr->fd, &err_fds);
+                       num_fds++;
 
-                       if (max_readfds < ptr->fd)
-                               max_readfds = ptr->fd;
+                       if (max_fd < ptr->fd)
+                               max_fd = ptr->fd;
                }
 
-               if (num_readfds == 0)
+               if (num_fds == 0)
                        break;
 
                if (gettimeofday (&nowtime, NULL) == -1)
@@ -640,11 +662,11 @@ static int ping_receive_all (pingobj_t *obj)
                if (ping_timeval_sub (&endtime, &nowtime, &timeout) == -1)
                        break;
 
-               dprintf ("Waiting on %i sockets for %i.%06i seconds\n", num_readfds,
+               dprintf ("Waiting on %i sockets for %i.%06i seconds\n", num_fds,
                                (int) timeout.tv_sec,
                                (int) timeout.tv_usec);
 
-               status = select (max_readfds + 1, &readfds, NULL, NULL, &timeout);
+               status = select (max_fd + 1, &read_fds, NULL, &err_fds, &timeout);
 
                if (gettimeofday (&nowtime, NULL) == -1)
                {
@@ -677,9 +699,18 @@ static int ping_receive_all (pingobj_t *obj)
 
                for (ptr = ph; ptr != NULL; ptr = ptr->next)
                {
-                       if (FD_ISSET (ptr->fd, &readfds))
-                               if (ping_receive_one (ptr->fd, ph, &nowtime) == 0)
+                       if (FD_ISSET (ptr->fd, &read_fds))
+                       {
+                               if (ping_receive_one (obj, ptr, &nowtime) == 0)
                                        ret++;
+                       }
+                       else if (FD_ISSET (ptr->fd, &err_fds))
+                       {
+                               /* clear the timer in this case so that we
+                                * don't run into an endless loop. */
+                               /* TODO: Set an error flag in this case. */
+                               timerclear (ptr->timer);
+                       }
                }
        } /* while (1) */
        
@@ -988,6 +1019,8 @@ static void ping_free (pinghost_t *ph)
  */
 const char *ping_get_error (pingobj_t *obj)
 {
+       if (obj == NULL)
+               return (NULL);
        return (obj->errmsg);
 }
 
@@ -1012,6 +1045,9 @@ void ping_destroy (pingobj_t *obj)
        pinghost_t *current;
        pinghost_t *next;
 
+       if (obj == NULL)
+               return;
+
        current = obj->head;
        next = NULL;
 
@@ -1028,6 +1064,9 @@ void ping_destroy (pingobj_t *obj)
        if (obj->srcaddr != NULL)
                free (obj->srcaddr);
 
+       if (obj->device != NULL)
+               free (obj->device);
+
        free (obj);
 
        return;
@@ -1037,6 +1076,9 @@ int ping_setopt (pingobj_t *obj, int option, void *value)
 {
        int ret = 0;
 
+       if ((obj == NULL) || (value == NULL))
+               return (-1);
+
        switch (option)
        {
                case PING_OPT_TIMEOUT:
@@ -1150,6 +1192,28 @@ int ping_setopt (pingobj_t *obj, int option, void *value)
                } /* case PING_OPT_SOURCE */
                break;
 
+               case PING_OPT_DEVICE:
+               {
+#ifdef SO_BINDTODEVICE
+                       char *device = strdup ((char *) value);
+
+                       if (device == NULL)
+                       {
+                               ping_set_errno (obj, errno);
+                               ret = -1;
+                               break;
+                       }
+
+                       if (obj->device != NULL)
+                               free (obj->device);
+                       obj->device = device;
+#else /* ! SO_BINDTODEVICE */
+                       ping_set_errno (obj, ENOTSUP);
+                       ret = -1;
+#endif /* ! SO_BINDTODEVICE */
+               } /* case PING_OPT_DEVICE */
+               break;
+
                default:
                        ret = -2;
        } /* switch (option) */
@@ -1162,6 +1226,9 @@ int ping_send (pingobj_t *obj)
 {
        int ret;
 
+       if (obj == NULL)
+               return (-1);
+
        if (ping_send_all (obj) < 0)
                return (-1);
 
@@ -1192,6 +1259,9 @@ int ping_host_add (pingobj_t *obj, const char *host)
        struct addrinfo *ai_list, *ai_ptr;
        int              ai_return;
 
+       if ((obj == NULL) || (host == NULL))
+               return (-1);
+
        dprintf ("host = %s\n", host);
 
        if (ping_host_search (obj->head, host) != NULL)
@@ -1317,6 +1387,25 @@ int ping_host_add (pingobj_t *obj, const char *host)
                        }
                }
 
+#ifdef SO_BINDTODEVICE
+               if (obj->device != NULL)
+               {
+                       if (setsockopt (ph->fd, SOL_SOCKET, SO_BINDTODEVICE,
+                                       obj->device, strlen (obj->device) + 1) != 0)
+                       {
+#if WITH_DEBUG
+                               char errbuf[PING_ERRMSG_LEN];
+                               dprintf ("setsockopt: %s\n",
+                                               sstrerror (errno, errbuf, sizeof (errbuf)));
+#endif
+                               ping_set_errno (obj, errno);
+                               close (ph->fd);
+                               ph->fd = -1;
+                               continue;
+                       }
+               }
+#endif /* SO_BINDTODEVICE */
+
                assert (sizeof (struct sockaddr_storage) >= ai_ptr->ai_addrlen);
                memset (ph->addr, '\0', sizeof (struct sockaddr_storage));
                memcpy (ph->addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
@@ -1352,6 +1441,7 @@ int ping_host_add (pingobj_t *obj, const char *host)
                        setsockopt (ph->fd, IPPROTO_IP, IP_RECVTTL,
                                        &opt, sizeof (opt));
                }
+#if defined(IPPROTO_IPV6) && defined(IPV6_RECVHOPLIMIT)
                else if (ph->addrfamily == AF_INET6)
                {
                        int opt = 1;
@@ -1359,6 +1449,7 @@ int ping_host_add (pingobj_t *obj, const char *host)
                        setsockopt (ph->fd, IPPROTO_IPV6, IPV6_RECVHOPLIMIT,
                                        &opt, sizeof (opt));
                }
+#endif
 
                break;
        }
@@ -1401,6 +1492,9 @@ int ping_host_remove (pingobj_t *obj, const char *host)
 {
        pinghost_t *pre, *cur;
 
+       if ((obj == NULL) || (host == NULL))
+               return (-1);
+
        pre = NULL;
        cur = obj->head;
 
@@ -1431,11 +1525,15 @@ int ping_host_remove (pingobj_t *obj, const char *host)
 
 pingobj_iter_t *ping_iterator_get (pingobj_t *obj)
 {
+       if (obj == NULL)
+               return (NULL);
        return ((pingobj_iter_t *) obj->head);
 }
 
 pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter)
 {
+       if (iter == NULL)
+               return (NULL);
        return ((pingobj_iter_t *) iter->next);
 }
 
@@ -1446,6 +1544,12 @@ int ping_iterator_get_info (pingobj_iter_t *iter, int info,
 
        size_t orig_buffer_len = *buffer_len;
 
+       if ((iter == NULL) || (buffer_len == NULL))
+               return (-1);
+
+       if ((buffer == NULL) && (*buffer_len != 0 ))
+               return (-1);
+
        switch (info)
        {
                case PING_INFO_USERNAME:
@@ -1565,10 +1669,14 @@ int ping_iterator_get_info (pingobj_iter_t *iter, int info,
 
 void *ping_iterator_get_context (pingobj_iter_t *iter)
 {
+       if (iter == NULL)
+               return (NULL);
        return (iter->context);
 }
 
 void ping_iterator_set_context (pingobj_iter_t *iter, void *context)
 {
+       if (iter == NULL)
+               return;
        iter->context = context;
 }