src/oping.c: Move calculation of average and stddev to separate functions.
[liboping.git] / src / oping.c
index eb97e5d..4946bf7 100644 (file)
@@ -1,11 +1,11 @@
 /**
  * Object oriented C module to send ICMP and ICMPv6 `echo's.
- * Copyright (C) 2006  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; either version 2 of the License, or
- * (at your option) any later version.
+ * 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
 # error "You don't have the standard C99 header files installed"
 #endif /* STDC_HEADERS */
 
+#if HAVE_UNISTD_H
+# include <unistd.h>
+#endif
+
 #if HAVE_MATH_H
 # include <math.h>
 #endif
 # include <signal.h>
 #endif
 
+#if HAVE_SYS_TYPES_H
+#include <sys/types.h>
+#endif
+
+#if USE_NCURSES
+# include <ncurses.h>
+#endif
+
 #include "oping.h"
 
+#ifndef _POSIX_SAVED_IDS
+# define _POSIX_SAVED_IDS 0
+#endif
+
 typedef struct ping_context
 {
        char host[NI_MAXHOST];
@@ -63,24 +79,38 @@ typedef struct ping_context
 
        int req_sent;
        int req_rcvd;
-       
+
        double latency_min;
        double latency_max;
        double latency_total;
        double latency_total_square;
+
+#if USE_NCURSES
+       WINDOW *window;
+#endif
 } ping_context_t;
 
-static double opt_interval   = 1.0;
-static int    opt_addrfamily = PING_DEF_AF;
-static int    opt_count      = -1;
+static double  opt_interval   = 1.0;
+static int     opt_addrfamily = PING_DEF_AF;
+static char   *opt_srcaddr    = NULL;
+static char   *opt_device     = NULL;
+static char   *opt_filename   = NULL;
+static int     opt_count      = -1;
+static int     opt_send_ttl   = 64;
 
-void sigint_handler (int signal)
+#if USE_NCURSES
+static WINDOW *main_win = NULL;
+#endif
+
+static void sigint_handler (int signal)
 {
+       /* Make compiler happy */
+       signal = 0;
        /* Exit the loop */
        opt_count = 0;
 }
 
-ping_context_t *context_create (void)
+static ping_context_t *context_create (void)
 {
        ping_context_t *ret;
 
@@ -94,28 +124,93 @@ ping_context_t *context_create (void)
        ret->latency_total = 0.0;
        ret->latency_total_square = 0.0;
 
+#if USE_NCURSES
+       ret->window = NULL;
+#endif
+
        return (ret);
 }
 
-void context_destroy (ping_context_t *context)
+static void context_destroy (ping_context_t *context)
 {
+       if (context == NULL)
+               return;
+
+#if USE_NCURSES
+       if (context->window != NULL)
+       {
+               delwin (context->window);
+               context->window = NULL;
+       }
+#endif
+
        free (context);
 }
 
-void usage_exit (const char *name)
+static double context_get_average (ping_context_t *ctx) /* {{{ */
+{
+       double num_total;
+
+       if (ctx == NULL)
+               return (-1.0);
+
+       if (ctx->req_rcvd < 1)
+               return (-0.0);
+
+       num_total = (double) ctx->req_rcvd;
+       return (ctx->latency_total / num_total);
+} /* }}} double context_get_average */
+
+static double context_get_stddev (ping_context_t *ctx) /* {{{ */
 {
-       fprintf (stderr, "Usage: %s [-46] [-c count] [-i interval] host [host [host ...]]\n",
+       double num_total;
+
+       if (ctx == NULL)
+               return (-1.0);
+
+       if (ctx->req_rcvd < 1)
+               return (-0.0);
+       else if (ctx->req_rcvd < 2)
+               return (0.0);
+
+       num_total = (double) ctx->req_rcvd;
+       return (sqrt (((num_total * ctx->latency_total_square)
+                                       - (ctx->latency_total * ctx->latency_total))
+                               / (num_total * (num_total - 1.0))));
+} /* }}} double context_get_stddev */
+
+static void usage_exit (const char *name, int status)
+{
+       int name_length;
+
+       name_length = (int) strlen (name);
+
+       fprintf (stderr, "Usage: %s [OPTIONS] "
+                               "-f filename | host [host [host ...]]\n"
+
+                       "\nAvailable options:\n"
+                       "  -4|-6        force the use of IPv4 or IPv6\n"
+                       "  -c count     number of ICMP packets to send\n"
+                       "  -i interval  interval with which to send ICMP packets\n"
+                       "  -t ttl       time to live for each ICMP packet\n"
+                       "  -I srcaddr   source address\n"
+                       "  -D device    outgoing interface name\n"
+                       "  -f filename  filename to read hosts from\n"
+
+                       "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
+                       "by Florian octo Forster <octo@verplant.org>\n"
+                       "for contributions see `AUTHORS'\n",
                        name);
-       exit (1);
+       exit (status);
 }
 
-int read_options (int argc, char **argv)
+static int read_options (int argc, char **argv)
 {
        int optchar;
 
        while (1)
        {
-               optchar = getopt (argc, argv, "46c:hi:");
+               optchar = getopt (argc, argv, "46c:hi:I:t:f:D:");
 
                if (optchar == -1)
                        break;
@@ -133,6 +228,17 @@ int read_options (int argc, char **argv)
                                        new_count = atoi (optarg);
                                        if (new_count > 0)
                                                opt_count = new_count;
+                                       else
+                                               fprintf(stderr, "Ignoring invalid count: %s\n",
+                                                               optarg);
+                               }
+                               break;
+
+                       case 'f':
+                               {
+                                       if (opt_filename != NULL)
+                                               free (opt_filename);
+                                       opt_filename = strdup (optarg);
                                }
                                break;
 
@@ -140,42 +246,84 @@ int read_options (int argc, char **argv)
                                {
                                        double new_interval;
                                        new_interval = atof (optarg);
-                                       if (new_interval >= 0.2)
+                                       if (new_interval < 0.001)
+                                               fprintf (stderr, "Ignoring invalid interval: %s\n",
+                                                               optarg);
+                                       else
                                                opt_interval = new_interval;
                                }
                                break;
+                       case 'I':
+                               {
+                                       if (opt_srcaddr != NULL)
+                                               free (opt_srcaddr);
+                                       opt_srcaddr = strdup (optarg);
+                               }
+                               break;
+
+                       case 'D':
+                               opt_device = optarg;
+                               break;
+
+                       case 't':
+                       {
+                               int new_send_ttl;
+                               new_send_ttl = atoi (optarg);
+                               if ((new_send_ttl > 0) && (new_send_ttl < 256))
+                                       opt_send_ttl = new_send_ttl;
+                               else
+                                       fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
+                                                       optarg);
+                               break;
+                       }
 
                        case 'h':
+                               usage_exit (argv[0], 0);
+                               break;
                        default:
-                               usage_exit (argv[0]);
+                               usage_exit (argv[0], 1);
                }
        }
 
        return (optind);
 }
 
-void print_host (pingobj_iter_t *iter)
+static void print_host (pingobj_iter_t *iter)
 {
        double          latency;
        unsigned int    sequence;
+       int             recv_ttl;
        size_t          buffer_len;
        size_t          data_len;
        ping_context_t *context;
-       
+
+       latency = -1.0;
        buffer_len = sizeof (latency);
        ping_iterator_get_info (iter, PING_INFO_LATENCY,
                        &latency, &buffer_len);
 
+       sequence = 0;
        buffer_len = sizeof (sequence);
        ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
                        &sequence, &buffer_len);
 
+       recv_ttl = -1;
+       buffer_len = sizeof (recv_ttl);
+       ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
+                       &recv_ttl, &buffer_len);
+
        data_len = 0;
        ping_iterator_get_info (iter, PING_INFO_DATA,
                        NULL, &data_len);
 
        context = (ping_context_t *) ping_iterator_get_context (iter);
 
+#if USE_NCURSES
+# define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
+#else
+# define HOST_PRINTF(...) printf(__VA_ARGS__)
+#endif
+
        context->req_sent++;
        if (latency > 0.0)
        {
@@ -188,20 +336,52 @@ void print_host (pingobj_iter_t *iter)
                if ((context->latency_min < 0.0) || (context->latency_min > latency))
                        context->latency_min = latency;
 
-               printf ("%u bytes from %s (%s): icmp_seq=%u time=%.2f ms\n",
-                               (unsigned int) data_len,
+               HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i "
+                               "time=%.2f ms\n",
+                               data_len,
                                context->host, context->addr,
-                               (unsigned int) sequence, latency);
+                               sequence, recv_ttl, latency);
        }
        else
        {
-               printf ("echo reply from %s (%s): icmp_seq=%u timeout\n",
+               HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
                                context->host, context->addr,
-                               (unsigned int) sequence);
+                               sequence);
+       }
+
+#if USE_NCURSES
+       wrefresh (main_win);
+       werase (context->window);
+       box (context->window, 0, 0);
+       mvwprintw (context->window, /* y = */ 0, /* x = */ 5,
+                       " %s ping statistics ",
+                       context->host);
+       mvwprintw (context->window, /* y = */ 1, /* x = */ 2,
+                       "%i packets transmitted, %i received, %.2f%% packet "
+                       "loss, time %.1fms",
+                       context->req_sent, context->req_rcvd,
+                       100.0 * (context->req_sent - context->req_rcvd) / ((double) context->req_sent),
+                       context->latency_total);
+       if (context->req_rcvd != 0)
+       {
+               double average;
+               double deviation;
+
+               average = context_get_average (context);
+               deviation = context_get_stddev (context);
+                       
+               mvwprintw (context->window, /* y = */ 2, /* x = */ 2,
+                               "rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms",
+                               context->latency_min,
+                               average,
+                               context->latency_max,
+                               deviation);
        }
+       wrefresh (context->window);
+#endif
 }
 
-void time_normalize (struct timespec *ts)
+static void time_normalize (struct timespec *ts)
 {
        while (ts->tv_nsec < 0)
        {
@@ -222,7 +402,7 @@ void time_normalize (struct timespec *ts)
        }
 }
 
-void time_calc (struct timespec *ts_dest,
+static void time_calc (struct timespec *ts_dest, /* {{{ */
                const struct timespec *ts_int,
                const struct timeval  *tv_begin,
                const struct timeval  *tv_end)
@@ -246,9 +426,110 @@ void time_calc (struct timespec *ts_dest,
        ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
        ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
        time_normalize (ts_dest);
-}
+} /* }}} void time_calc */
+
+static int print_header (pingobj_t *ping) /* {{{ */
+{
+       pingobj_iter_t *iter;
+       int i;
+
+#if USE_NCURSES
+       initscr ();
+       cbreak ();
+       noecho ();
+#endif
+
+       i = 0;
+       for (iter = ping_iterator_get (ping);
+                       iter != NULL;
+                       iter = ping_iterator_next (iter))
+       {
+               ping_context_t *context;
+               size_t buffer_size;
+
+               context = context_create ();
+
+               buffer_size = sizeof (context->host);
+               ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
+
+               buffer_size = sizeof (context->addr);
+               ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
+
+               buffer_size = 0;
+               ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
+
+#if USE_NCURSES
+               context->window = newwin (/* height = */ 4, COLS,
+                               /* start y = */ 4*i, /* start x = */ 0);
+               box (context->window, 0, 0);
+               mvwprintw (context->window, /* y = */ 0, /* x = */ 5,
+                               " %s ping statistics ",
+                               context->host);
+               wrefresh (context->window);
+#else /* !USE_NCURSES */
+               printf ("PING %s (%s) %zu bytes of data.\n",
+                               context->host, context->addr, buffer_size);
+#endif
+
+               ping_iterator_set_context (iter, (void *) context);
+
+               i++;
+       }
+
+#if USE_NCURSES
+       delwin (main_win);
+       main_win = newwin (LINES - 4*i, COLS, 4*i, 0);
+       scrollok (main_win, TRUE);
+#endif
+
+       return (0);
+} /* }}} int print_header */
+
+static int print_footer (pingobj_t *ping)
+{
+       pingobj_iter_t *iter;
+
+#if USE_NCURSES
+       endwin ();
+#endif
+
+       for (iter = ping_iterator_get (ping);
+                       iter != NULL;
+                       iter = ping_iterator_next (iter))
+       {
+               ping_context_t *context;
+
+               context = ping_iterator_get_context (iter);
+
+               printf ("\n--- %s ping statistics ---\n"
+                               "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
+                               context->host, context->req_sent, context->req_rcvd,
+                               100.0 * (context->req_sent - context->req_rcvd) / ((double) context->req_sent),
+                               context->latency_total);
+
+               if (context->req_rcvd != 0)
+               {
+                       double average;
+                       double deviation;
+
+                       average = context_get_average (context);
+                       deviation = context_get_stddev (context);
 
-int main (int argc, char **argv)
+                       printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
+                                       context->latency_min,
+                                       average,
+                                       context->latency_max,
+                                       deviation);
+               }
+
+               ping_iterator_set_context (iter, NULL);
+               context_destroy (context);
+       }
+
+       return (0);
+} /* }}} int print_footer */
+
+int main (int argc, char **argv) /* {{{ */
 {
        pingobj_t      *ping;
        pingobj_iter_t *iter;
@@ -262,16 +543,42 @@ int main (int argc, char **argv)
 
        int optind;
        int i;
+       int status;
+#if _POSIX_SAVED_IDS
+       uid_t saved_set_uid;
+
+       /* Save the old effective user id */
+       saved_set_uid = geteuid ();
+       /* Set the effective user ID to the real user ID without changing the
+        * saved set-user ID */
+       status = seteuid (getuid ());
+       if (status != 0)
+       {
+               fprintf (stderr, "Temporarily dropping privileges "
+                               "failed: %s\n", strerror (errno));
+               exit (EXIT_FAILURE);
+       }
+#endif
 
        optind = read_options (argc, argv);
 
-       if (optind >= argc)
-               usage_exit (argv[0]);
-
-       if (geteuid () != 0)
+#if !_POSIX_SAVED_IDS
+       /* Cannot temporarily drop privileges -> reject every file but "-". */
+       if ((opt_filename != NULL)
+                       && (strcmp ("-", opt_filename) != 0)
+                       && (getuid () != geteuid ()))
        {
-               fprintf (stderr, "Need superuser privileges to open a RAW socket. Sorry.\n");
-               return (1);
+               fprintf (stderr, "Your real and effective user IDs don't "
+                               "match. Reading from a file (option '-f')\n"
+                               "is therefore too risky. You can still read "
+                               "from STDIN using '-f -' if you like.\n"
+                               "Sorry.\n");
+               exit (EXIT_FAILURE);
+       }
+#endif
+
+       if ((optind >= argc) && (opt_filename == NULL)) {
+               usage_exit (argv[0], 1);
        }
 
        if ((ping = ping_construct ()) == NULL)
@@ -280,6 +587,12 @@ int main (int argc, char **argv)
                return (1);
        }
 
+       if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
+       {
+               fprintf (stderr, "Setting TTL to %i failed: %s\n",
+                               opt_send_ttl, ping_get_error (ping));
+       }
+
        {
                double temp_sec;
                double temp_nsec;
@@ -294,33 +607,128 @@ int main (int argc, char **argv)
        if (opt_addrfamily != PING_DEF_AF)
                ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
 
-       for (i = optind; i < argc; i++)
+       if (opt_srcaddr != NULL)
        {
-               if (ping_host_add (ping, argv[i]) > 0)
+               if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
                {
-                       fprintf (stderr, "ping_host_add (%s) failed\n", argv[i]);
-                       continue;
+                       fprintf (stderr, "Setting source address failed: %s\n",
+                                       ping_get_error (ping));
                }
        }
 
-       for (iter = ping_iterator_get (ping);
-                       iter != NULL;
-                       iter = ping_iterator_next (iter))
+       if (opt_device != NULL)
        {
-               ping_context_t *context;
-               size_t buffer_size;
+               if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
+               {
+                       fprintf (stderr, "Setting device failed: %s\n",
+                                       ping_get_error (ping));
+               }
+       }
 
-               context = context_create ();
+       if (opt_filename != NULL)
+       {
+               FILE *infile;
+               char line[256];
+               char host[256];
 
-               buffer_size = sizeof (context->host);
-               ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
+               if (strcmp (opt_filename, "-") == 0)
+                       /* Open STDIN */
+                       infile = fdopen(0, "r");
+               else
+                       infile = fopen(opt_filename, "r");
 
-               buffer_size = sizeof (context->addr);
-               ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
+               if (infile == NULL)
+               {
+                       fprintf (stderr, "Opening %s failed: %s\n",
+                                       (strcmp (opt_filename, "-") == 0)
+                                       ? "STDIN" : opt_filename,
+                                       strerror(errno));
+                       return (1);
+               }
 
-               ping_iterator_set_context (iter, (void *) context);
+#if _POSIX_SAVED_IDS
+               /* Regain privileges */
+               status = seteuid (saved_set_uid);
+               if (status != 0)
+               {
+                       fprintf (stderr, "Temporarily re-gaining privileges "
+                                       "failed: %s\n", strerror (errno));
+                       exit (EXIT_FAILURE);
+               }
+#endif
+
+               while (fgets(line, sizeof(line), infile))
+               {
+                       /* Strip whitespace */
+                       if (sscanf(line, "%s", host) != 1)
+                               continue;
+
+                       if ((host[0] == 0) || (host[0] == '#'))
+                               continue;
+
+                       if (ping_host_add(ping, host) < 0)
+                       {
+                               const char *errmsg = ping_get_error (ping);
+
+                               fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
+                               continue;
+                       }
+               }
+
+#if _POSIX_SAVED_IDS
+               /* Drop privileges */
+               status = seteuid (getuid ());
+               if (status != 0)
+               {
+                       fprintf (stderr, "Temporarily dropping privileges "
+                                       "failed: %s\n", strerror (errno));
+                       exit (EXIT_FAILURE);
+               }
+#endif
+
+               fclose(infile);
+       }
+
+#if _POSIX_SAVED_IDS
+       /* Regain privileges */
+       status = seteuid (saved_set_uid);
+       if (status != 0)
+       {
+               fprintf (stderr, "Temporarily re-gaining privileges "
+                               "failed: %s\n", strerror (errno));
+               exit (EXIT_FAILURE);
+       }
+#endif
+
+       for (i = optind; i < argc; i++)
+       {
+               if (ping_host_add (ping, argv[i]) < 0)
+               {
+                       const char *errmsg = ping_get_error (ping);
+
+                       fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
+                       continue;
+               }
        }
 
+       /* Permanently drop root privileges if we're setuid-root. */
+       status = setuid (getuid ());
+       if (status != 0)
+       {
+               fprintf (stderr, "Dropping privileges failed: %s\n",
+                               strerror (errno));
+               exit (EXIT_FAILURE);
+       }
+
+#if _POSIX_SAVED_IDS
+       saved_set_uid = (uid_t) -1;
+#endif
+
+       print_header (ping);
+
+       if (i == 0)
+               return (1);
+
        memset (&sigint_action, '\0', sizeof (sigint_action));
        sigint_action.sa_handler = sigint_handler;
        if (sigaction (SIGINT, &sigint_action, NULL) < 0)
@@ -341,7 +749,8 @@ int main (int argc, char **argv)
 
                if (ping_send (ping) < 0)
                {
-                       fprintf (stderr, "ping_send failed\n");
+                       fprintf (stderr, "ping_send failed: %s\n",
+                                       ping_get_error (ping));
                        return (1);
                }
 
@@ -384,44 +793,11 @@ int main (int argc, char **argv)
                        opt_count--;
        } /* while (opt_count != 0) */
 
-       for (iter = ping_iterator_get (ping);
-                       iter != NULL;
-                       iter = ping_iterator_next (iter))
-       {
-               ping_context_t *context;
-
-               context = ping_iterator_get_context (iter);
-
-               printf ("\n--- %s ping statistics ---\n"
-                               "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
-                               context->host, context->req_sent, context->req_rcvd,
-                               100.0 * (context->req_sent - context->req_rcvd) / ((double) context->req_sent),
-                               context->latency_total);
-
-               if (context->req_rcvd != 0)
-               {
-                       double num_total;
-                       double average;
-                       double deviation;
-
-                       num_total = (double) context->req_rcvd;
-
-                       average = context->latency_total / num_total;
-                       deviation = sqrt (((num_total * context->latency_total_square) - (context->latency_total * context->latency_total))
-                                       / (num_total * (num_total - 1.0)));
-
-                       printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
-                                       context->latency_min,
-                                       average,
-                                       context->latency_max,
-                                       deviation);
-               }
-
-               ping_iterator_set_context (iter, NULL);
-               free (context);
-       }
+       print_footer (ping);
 
        ping_destroy (ping);
 
        return (0);
-}
+} /* }}} int main */
+
+/* vim: set fdm=marker : */