Bump version to 1.7.0; Update ChangeLog.
[liboping.git] / src / oping.c
index 0649d00..d53edd8 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * Object oriented C module to send ICMP and ICMPv6 `echo's.
- * Copyright (C) 2006-2011  Florian octo Forster <ff at octo.it>
+ * Copyright (C) 2006-2014  Florian octo Forster <ff at octo.it>
  *
  * 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
 #endif
 
 #include <locale.h>
+#include <langinfo.h>
 
 #if USE_NCURSES
 # define NCURSES_OPAQUE 1
 /* http://newsgroups.derkeiler.com/Archive/Rec/rec.games.roguelike.development/2010-09/msg00050.html */
 # define _X_OPEN_SOURCE_EXTENDED
-# include <ncursesw/ncurses.h>
+
+# if HAVE_NCURSESW_NCURSES_H
+#  include <ncursesw/ncurses.h>
+# elif HAVE_NCURSES_H
+#  include <ncurses.h>
+# endif
 
 # define OPING_GREEN 1
 # define OPING_YELLOW 2
 # define OPING_GREEN_HIST 4
 # define OPING_YELLOW_HIST 5
 # define OPING_RED_HIST 6
+
+static char const * const hist_symbols_utf8[] = {
+       "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" };
+static size_t const hist_symbols_utf8_num = sizeof (hist_symbols_utf8)
+       / sizeof (hist_symbols_utf8[0]);
+
+/* scancodes for 6 levels of horizontal bars, ncurses-specific */
+/* those are not the usual constants because those are not constant */
+static int const hist_symbols_acs[] = {
+       115, /* ACS_S9 "⎽" */
+       114, /* ACS_S7 "⎼" */
+       113, /* ACS_S5 "─" */
+       112, /* ACS_S3 "⎻" */
+       111  /* ACS_S1 "⎺" */
+};
+static size_t const hist_symbols_acs_num = sizeof (hist_symbols_acs)
+       / sizeof (hist_symbols_acs[0]);
+
+/* use different colors without a background for scancodes */
+static int const hist_colors_utf8[] = {
+       OPING_GREEN_HIST, OPING_YELLOW_HIST, OPING_RED_HIST };
+static int const hist_colors_acs[] = {
+       OPING_GREEN, OPING_YELLOW, OPING_RED };
+/* assuming that both arrays are the same size */
+static size_t const hist_colors_num = sizeof (hist_colors_utf8)
+       / sizeof (hist_colors_utf8[0]);
 #endif
 
 #include "oping.h"
 
-const char *bars[BARS_LEN] = { "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" };
-
 #ifndef _POSIX_SAVED_IDS
 # define _POSIX_SAVED_IDS 0
 #endif
 
+#ifndef IPTOS_MINCOST
+# define IPTOS_MINCOST 0x02
+#endif
+
 /* Remove GNU specific __attribute__ settings when using another compiler */
 #if !__GNUC__
 # define __attribute__(x) /**/
@@ -130,6 +164,10 @@ static char   *opt_filename   = NULL;
 static int     opt_count      = -1;
 static int     opt_send_ttl   = 64;
 static uint8_t opt_send_qos   = 0;
+static double  opt_exit_status_threshold = 1.0;
+#if USE_NCURSES
+static int     opt_utf8       = 0;
+#endif
 
 static int host_num = 0;
 
@@ -274,6 +312,11 @@ static void usage_exit (const char *name, int status) /* {{{ */
                        "  -I srcaddr   source address\n"
                        "  -D device    outgoing interface name\n"
                        "  -f filename  filename to read hosts from\n"
+#if USE_NCURSES
+                       "  -u / -U      force / disable UTF-8 output\n"
+#endif
+                       "  -Z percent   Exit with non-zero exit status if more than this percentage of\n"
+                       "               probes timed out. (default: never)\n"
 
                        "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
                        "by Florian octo Forster <octo@verplant.org>\n"
@@ -476,7 +519,11 @@ static int read_options (int argc, char **argv) /* {{{ */
 
        while (1)
        {
-               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:");
+               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:"
+#if USE_NCURSES
+                               "uU"
+#endif
+                               );
 
                if (optchar == -1)
                        break;
@@ -547,6 +594,33 @@ static int read_options (int argc, char **argv) /* {{{ */
                                set_opt_send_qos (optarg);
                                break;
 
+#if USE_NCURSES
+                       case 'u':
+                               opt_utf8 = 2;
+                               break;
+                       case 'U':
+                               opt_utf8 = 1;
+                               break;
+#endif
+
+                       case 'Z':
+                       {
+                               char *endptr = NULL;
+                               double tmp;
+
+                               errno = 0;
+                               tmp = strtod (optarg, &endptr);
+                               if ((errno != 0) || (endptr == NULL) || (*endptr != 0) || (tmp < 0.0) || (tmp > 100.0))
+                               {
+                                       fprintf (stderr, "Ignoring invalid -Z argument: %s\n", optarg);
+                                       fprintf (stderr, "The \"-Z\" option requires a numeric argument between 0 and 100.\n");
+                               }
+                               else
+                                       opt_exit_status_threshold = tmp / 100.0;
+
+                               break;
+                       }
+
                        case 'h':
                                usage_exit (argv[0], 0);
                                break;
@@ -606,12 +680,106 @@ static void time_calc (struct timespec *ts_dest, /* {{{ */
 } /* }}} void time_calc */
 
 #if USE_NCURSES
+static _Bool has_utf8() /* {{{ */
+{
+# if HAVE_NCURSESW_NCURSES_H
+       if (!opt_utf8)
+       {
+               /* Automatically determine */
+               if (strcasecmp ("UTF-8", nl_langinfo (CODESET)) == 0)
+                       opt_utf8 = 2;
+               else
+                       opt_utf8 = 1;
+       }
+       return ((_Bool) (opt_utf8 - 1));
+# else
+       return (0);
+# endif
+} /* }}} _Bool has_utf8 */
+
+static int update_prettyping_graph (ping_context_t *ctx, /* {{{ */
+               double latency, unsigned int sequence)
+{
+       int color = OPING_RED;
+       char const *symbol = "!";
+       int symbolc = '!';
+
+       int x_max;
+       int x_pos;
+
+       x_max = getmaxx (ctx->window);
+       x_pos = ((sequence - 1) % (x_max - 4)) + 2;
+
+       if (latency >= 0.0)
+       {
+               double ratio;
+
+               size_t symbols_num = hist_symbols_acs_num;
+               size_t colors_num = 1;
+
+               size_t index_symbols;
+               size_t index_colors;
+               size_t intensity;
+
+               /* latency is in milliseconds, opt_interval is in seconds. */
+               ratio = (latency * 0.001) / opt_interval;
+               if (ratio > 1) {
+                       ratio = 1.0;
+               }
+
+               if (has_utf8 ())
+                       symbols_num = hist_symbols_utf8_num;
+
+               if (has_colors () == TRUE)
+                       colors_num = hist_colors_num;
+
+               intensity = (size_t) (ratio * ((double) (symbols_num * colors_num)));
+               if (intensity >= (symbols_num * colors_num))
+                       intensity = (symbols_num * colors_num) - 1;
+
+               index_symbols = intensity % symbols_num;
+               assert (index_symbols < symbols_num);
+
+               index_colors = intensity / symbols_num;
+               assert (index_colors < colors_num);
+
+               if (has_utf8())
+               {
+                       color = hist_colors_utf8[index_colors];
+                       symbol = hist_symbols_utf8[index_symbols];
+               }
+               else
+               {
+                       color = hist_colors_acs[index_colors];
+                       symbolc = hist_symbols_acs[index_symbols] | A_ALTCHARSET;
+               }
+       }
+       else /* if (!(latency >= 0.0)) */
+               wattron (ctx->window, A_BOLD);
+
+       if (has_colors () == TRUE)
+               wattron (ctx->window, COLOR_PAIR(color));
+
+       if (has_utf8())
+               mvwprintw (ctx->window, /* y = */ 3, /* x = */ x_pos, symbol);
+       else
+               mvwaddch (ctx->window, /* y = */ 3, /* x = */ x_pos, symbolc);
+
+       if (has_colors () == TRUE)
+               wattroff (ctx->window, COLOR_PAIR(color));
+
+       /* Use negation here to handle NaN correctly. */
+       if (!(latency >= 0.0))
+               wattroff (ctx->window, A_BOLD);
+
+       wprintw (ctx->window, " ");
+       return (0);
+} /* }}} int update_prettyping_graph */
+
 static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter) /* {{{ */
 {
        double latency = -1.0;
        size_t buffer_len = sizeof (latency);
-        int maxx;
-        getmaxyx(ctx->window, maxx, maxx);
 
        ping_iterator_get_info (iter, PING_INFO_LATENCY,
                        &latency, &buffer_len);
@@ -646,7 +814,7 @@ static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter)
 
                average = context_get_average (ctx);
                deviation = context_get_stddev (ctx);
-                       
+
                mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
                                "rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms",
                                ctx->latency_min,
@@ -655,55 +823,8 @@ static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter)
                                deviation);
        }
 
-       if (latency > 0.0)
-       {
-               if (has_colors () == TRUE)
-               {
-                       int color = OPING_GREEN_HIST;
-                        float ratio = 0;
-                        int index = 0;
-
-                        ratio = latency / PING_DEF_TTL;
-                        if (ratio > 1) {
-                          ratio = 1.0;
-                        }
-                        index = (int) ((ratio * BARS_LEN * 3) -1); /* 3 colors */
-                        if (index >= BARS_LEN) {
-                          color = OPING_YELLOW_HIST;
-                        }
-                        if (index >= 2*BARS_LEN) {
-                          color = OPING_RED_HIST;
-                        }
-                        /* HOST_PRINTF ("%%r%f-ia%d-", ratio, index); */
-                        index = index % BARS_LEN;
-                        /* HOST_PRINTF ("im%d-", index); */
-                        if (index < 0) {
-                          index = 0; /* safety check */
-                        }
-                        if (index >= BARS_LEN) {
-                          index = BARS_LEN - 1; /* safety check */
-                        }
-                        wattron (ctx->window, COLOR_PAIR(color));
-                        mvwprintw (ctx->window,
-                                   /* y = */ 3,
-                                   /* x = */ ( (sequence - 1) % (maxx - 4) ) + 2,
-                                   bars[index]);
-                       wattroff (ctx->window, COLOR_PAIR(color));
-                        wprintw (ctx->window, " ");
-               }
-               else
-               {
-                }
-        }
-        else {
-                wattron (ctx->window, COLOR_PAIR(OPING_RED) | A_BOLD);
-                mvwprintw (ctx->window,
-                           /* y = */ 3,
-                           /* x = */ ( (sequence - 1) % (maxx - 4) ) + 2,
-                           "!");
-                wattroff (ctx->window, COLOR_PAIR(OPING_RED) | A_BOLD);
-                wprintw (ctx->window, " ");
-        }
+       update_prettyping_graph (ctx, latency, sequence);
+
        wrefresh (ctx->window);
 
        return (0);
@@ -1026,9 +1147,13 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
 #endif
 } /* }}} void update_host_hook */
 
+/* Prints statistics for each host, cleans up the contexts and returns the
+ * number of hosts which failed to return more than the fraction
+ * opt_exit_status_threshold of pings. */
 static int post_loop_hook (pingobj_t *ping) /* {{{ */
 {
        pingobj_iter_t *iter;
+       int failure_count = 0;
 
 #if USE_NCURSES
        endwin ();
@@ -1048,6 +1173,13 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */
                                context_get_packet_loss (context),
                                context->latency_total);
 
+               {
+                       double pct_failed = 1.0 - (((double) context->req_rcvd)
+                                       / ((double) context->req_sent));
+                       if (pct_failed > opt_exit_status_threshold)
+                               failure_count++;
+               }
+
                if (context->req_rcvd != 0)
                {
                        double average;
@@ -1067,7 +1199,7 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */
                context_destroy (context);
        }
 
-       return (0);
+       return (failure_count);
 } /* }}} int post_loop_hook */
 
 int main (int argc, char **argv) /* {{{ */
@@ -1306,7 +1438,12 @@ int main (int argc, char **argv) /* {{{ */
                        return (1);
                }
 
-               if (ping_send (ping) < 0)
+               status = ping_send (ping);
+               if (status == -EINTR)
+               {
+                       continue;
+               }
+               else if (status < 0)
                {
                        fprintf (stderr, "ping_send failed: %s\n",
                                        ping_get_error (ping));
@@ -1339,14 +1476,13 @@ int main (int argc, char **argv) /* {{{ */
                /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
                while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
                {
-                       if (errno != EINTR)
+                       if (errno == EINTR)
                        {
-                               perror ("nanosleep");
-                               break;
+                               continue;
                        }
-                       else if (opt_count == 0)
+                       else
                        {
-                               /* sigint */
+                               perror ("nanosleep");
                                break;
                        }
                }
@@ -1357,11 +1493,19 @@ int main (int argc, char **argv) /* {{{ */
                        opt_count--;
        } /* while (opt_count != 0) */
 
-       post_loop_hook (ping);
+       /* Returns the number of failed hosts according to -Z. */
+       status = post_loop_hook (ping);
 
        ping_destroy (ping);
 
-       return (0);
+       if (status == 0)
+               exit (EXIT_SUCCESS);
+       else
+       {
+               if (status > 255)
+                       status = 255;
+               exit (status);
+       }
 } /* }}} int main */
 
 /* vim: set fdm=marker : */