src/oping.c: Add a "-g histrogram" option.
[liboping.git] / src / oping.c
index 6a82c59..381c8f3 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
@@ -122,6 +122,17 @@ static size_t const hist_colors_num = sizeof (hist_colors_utf8)
        / sizeof (hist_colors_utf8[0]);
 #endif
 
+/* "─" */
+#define BOXPLOT_WHISKER_BAR       (113 | A_ALTCHARSET)
+/* "├" */
+#define BOXPLOT_WHISKER_LEFT_END  (116 | A_ALTCHARSET)
+/* "┤" */
+#define BOXPLOT_WHISKER_RIGHT_END (117 | A_ALTCHARSET)
+/* Inverted */
+#define BOXPLOT_BOX               ' '
+/* "│", inverted */
+#define BOXPLOT_MEDIAN            (120 | A_ALTCHARSET)
+
 #include "oping.h"
 
 #ifndef _POSIX_SAVED_IDS
@@ -151,6 +162,11 @@ typedef struct ping_context
        double latency_total;
        double latency_total_square;
 
+/* 1000 + one "infinity" bucket. */
+#define OPING_HISTOGRAM_BUCKETS 1001
+       uint32_t *latency_histogram;
+       size_t latency_histogram_size;
+
 #if USE_NCURSES
        WINDOW *window;
 #endif
@@ -164,8 +180,11 @@ static char   *opt_filename   = NULL;
 static int     opt_count      = -1;
 static int     opt_send_ttl   = 64;
 static uint8_t opt_send_qos   = 0;
+#define OPING_DEFAULT_PERCENTILE 95.0
+static double  opt_percentile = -1.0;
 static double  opt_exit_status_threshold = 1.0;
 #if USE_NCURSES
+static int     opt_show_graph = 1;
 static int     opt_utf8       = 0;
 #endif
 
@@ -197,6 +216,10 @@ static ping_context_t *context_create (void) /* {{{ */
        ret->latency_total = 0.0;
        ret->latency_total_square = 0.0;
 
+       ret->latency_histogram_size = (size_t) OPING_HISTOGRAM_BUCKETS;
+       ret->latency_histogram = calloc (ret->latency_histogram_size,
+                       sizeof (*ret->latency_histogram));
+
 #if USE_NCURSES
        ret->window = NULL;
 #endif
@@ -217,6 +240,9 @@ static void context_destroy (ping_context_t *context) /* {{{ */
        }
 #endif
 
+       free (context->latency_histogram);
+       context->latency_histogram = NULL;
+
        free (context);
 } /* }}} void context_destroy */
 
@@ -234,6 +260,44 @@ static double context_get_average (ping_context_t *ctx) /* {{{ */
        return (ctx->latency_total / num_total);
 } /* }}} double context_get_average */
 
+static double context_get_percentile (ping_context_t *ctx, /* {{{ */
+               double percentile)
+{
+       double threshold = percentile / 100.0;
+       uint32_t accumulated[ctx->latency_histogram_size];
+       double ratios[ctx->latency_histogram_size];
+       double index_to_ms_factor;
+       uint32_t num;
+       size_t i;
+
+       if (ctx->latency_histogram == NULL)
+               return (NAN);
+
+       accumulated[0] = ctx->latency_histogram[0];
+       for (i = 1; i < ctx->latency_histogram_size; i++)
+               accumulated[i] = accumulated[i - 1]
+                       + ctx->latency_histogram[i];
+       num = accumulated[ctx->latency_histogram_size - 1];
+
+       for (i = 0; i < ctx->latency_histogram_size; i++)
+       {
+               ratios[i] = ((double) accumulated[i]) / ((double) num);
+               if (ratios[i] >= threshold)
+                       break;
+       }
+
+       if (i >= ctx->latency_histogram_size)
+               return (NAN);
+       else if (i == (ctx->latency_histogram_size - 1))
+               return (INFINITY);
+
+       index_to_ms_factor = (1000.0 * opt_interval) / (ctx->latency_histogram_size - 1);
+
+       /* Multiply with i+1, because we're interested in the _upper_ bound of
+        * each bucket. */
+       return (index_to_ms_factor * ((double) (i + 1)));
+} /* }}} double context_get_percentile */
+
 static double context_get_stddev (ping_context_t *ctx) /* {{{ */
 {
        double num_total;
@@ -315,6 +379,7 @@ static void usage_exit (const char *name, int status) /* {{{ */
 #if USE_NCURSES
                        "  -u / -U      force / disable UTF-8 output\n"
 #endif
+                       "  -P percent   Report the n'th percentile of latency\n"
                        "  -Z percent   Exit with non-zero exit status if more than this percentage of\n"
                        "               probes timed out. (default: never)\n"
 
@@ -519,9 +584,9 @@ static int read_options (int argc, char **argv) /* {{{ */
 
        while (1)
        {
-               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:"
+               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:P:"
 #if USE_NCURSES
-                               "uU"
+                               "uUg:"
 #endif
                                );
 
@@ -540,7 +605,12 @@ static int read_options (int argc, char **argv) /* {{{ */
                                        int new_count;
                                        new_count = atoi (optarg);
                                        if (new_count > 0)
+                                       {
                                                opt_count = new_count;
+
+                                               if ((opt_percentile < 0.0) && (opt_count < 20))
+                                                       opt_percentile = 100.0 * (opt_count - 1) / opt_count;
+                                       }
                                        else
                                                fprintf(stderr, "Ignoring invalid count: %s\n",
                                                                optarg);
@@ -566,6 +636,7 @@ static int read_options (int argc, char **argv) /* {{{ */
                                                opt_interval = new_interval;
                                }
                                break;
+
                        case 'I':
                                {
                                        if (opt_srcaddr != NULL)
@@ -594,7 +665,34 @@ static int read_options (int argc, char **argv) /* {{{ */
                                set_opt_send_qos (optarg);
                                break;
 
+                       case 'P':
+                               {
+                                       double new_percentile;
+                                       new_percentile = atof (optarg);
+                                       if (isnan (new_percentile)
+                                                       || (new_percentile < 0.1)
+                                                       || (new_percentile > 100.0))
+                                               fprintf (stderr, "Ignoring invalid percentile: %s\n",
+                                                               optarg);
+                                       else
+                                               opt_percentile = new_percentile;
+                               }
+                               break;
+
 #if USE_NCURSES
+                       case 'g':
+                               if (strcasecmp ("none", optarg) == 0)
+                                       opt_show_graph = 0;
+                               else if (strcasecmp ("prettyping", optarg) == 0)
+                                       opt_show_graph = 1;
+                               else if (strcasecmp ("boxplot", optarg) == 0)
+                                       opt_show_graph = 2;
+                               else if (strcasecmp ("histogram", optarg) == 0)
+                                       opt_show_graph = 3;
+                               else
+                                       fprintf (stderr, "Unknown graph option: %s\n", optarg);
+                               break;
+
                        case 'u':
                                opt_utf8 = 2;
                                break;
@@ -624,11 +722,15 @@ static int read_options (int argc, char **argv) /* {{{ */
                        case 'h':
                                usage_exit (argv[0], 0);
                                break;
+
                        default:
                                usage_exit (argv[0], 1);
                }
        }
 
+       if (opt_percentile <= 0.0)
+               opt_percentile = OPING_DEFAULT_PERCENTILE;
+
        return (optind);
 } /* }}} read_options */
 
@@ -697,7 +799,104 @@ static _Bool has_utf8() /* {{{ */
 # endif
 } /* }}} _Bool has_utf8 */
 
-static int update_prettyping_graph (ping_context_t *ctx, /* {{{ */
+static int update_graph_boxplot (ping_context_t *ctx) /* {{{ */
+{
+       uint32_t *accumulated;
+       double *ratios;
+       uint32_t num;
+       size_t i;
+       size_t x_max;
+       size_t x;
+
+       x_max = (size_t) getmaxx (ctx->window);
+       if (x_max <= 4)
+               return (EINVAL);
+       x_max -= 4;
+
+       accumulated = calloc (x_max, sizeof (*accumulated));
+       ratios = calloc (x_max, sizeof (*ratios));
+
+       /* Downsample */
+       for (i = 0; i < ctx->latency_histogram_size; i++)
+       {
+               x = i * x_max / ctx->latency_histogram_size;
+               accumulated[x] += ctx->latency_histogram[i];
+       }
+
+       /* Sum */
+       for (x = 1; x < x_max; x++)
+               accumulated[x] += accumulated[x - 1];
+
+       num = accumulated[x_max - 1];
+
+       /* Calculate ratios */
+       for (x = 0; x < x_max; x++)
+               ratios[x] = ((double) accumulated[x]) / ((double) num);
+
+       for (x = 0; x < x_max; x++)
+       {
+               int symbol = ' ';
+               _Bool reverse = 0;
+
+               if (x == 0)
+               {
+                       if (ratios[x] >= 0.5)
+                       {
+                               symbol = BOXPLOT_MEDIAN;
+                               reverse = 1;
+                       }
+                       else if (ratios[x] > 0.25)
+                       {
+                               symbol = BOXPLOT_BOX;
+                               reverse = 1;
+                       }
+                       else if (ratios[x] > 0.025)
+                               symbol = BOXPLOT_WHISKER_BAR;
+                       else
+                               symbol = ' '; /* NOP */
+               }
+               else /* (x != 0) */
+               {
+                       if ((ratios[x - 1] < 0.5) && (ratios[x] >= 0.5))
+                       {
+                               symbol = BOXPLOT_MEDIAN;
+                               reverse = 1;
+                       }
+                       else if (((ratios[x] >= 0.25) && (ratios[x] <= 0.75))
+                                       || ((ratios[x - 1] < 0.75) && (ratios[x] > 0.75)))
+                       {
+                               symbol = BOXPLOT_BOX;
+                               reverse = 1;
+                       }
+                       else if ((ratios[x] < 0.5) && (ratios[x] >= 0.025))
+                       {
+                               if (ratios[x - 1] < 0.025)
+                                       symbol = BOXPLOT_WHISKER_LEFT_END;
+                               else
+                                       symbol = BOXPLOT_WHISKER_BAR;
+                       }
+                       else if ((ratios[x] > .5) && (ratios[x] < 0.975))
+                       {
+                               symbol = BOXPLOT_WHISKER_BAR;
+                       }
+                       else if ((ratios[x] >= 0.975) && (ratios[x - 1] < 0.975))
+                               symbol = BOXPLOT_WHISKER_RIGHT_END;
+               }
+
+               if (reverse)
+                       wattron (ctx->window, A_REVERSE);
+               mvwaddch (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
+               // mvwprintw (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
+               if (reverse)
+                       wattroff (ctx->window, A_REVERSE);
+       }
+
+       free (ratios);
+       free (accumulated);
+       return (0);
+} /* }}} int update_graph_boxplot */
+
+static int update_graph_prettyping (ping_context_t *ctx, /* {{{ */
                double latency, unsigned int sequence)
 {
        int color = OPING_RED;
@@ -774,7 +973,93 @@ static int update_prettyping_graph (ping_context_t *ctx, /* {{{ */
 
        wprintw (ctx->window, " ");
        return (0);
-} /* }}} int update_prettyping_graph */
+} /* }}} int update_graph_prettyping */
+
+static int update_graph_histogram (ping_context_t *ctx) /* {{{ */
+{
+       uint32_t *counters;
+       uint32_t *accumulated;
+       uint32_t num;
+       uint32_t max;
+       size_t i;
+       size_t x_max;
+       size_t x;
+
+       size_t symbols_num = hist_symbols_acs_num;
+
+       if (has_utf8 ())
+               symbols_num = hist_symbols_utf8_num;
+
+       x_max = (size_t) getmaxx (ctx->window);
+       if (x_max <= 4)
+               return (EINVAL);
+       x_max -= 4;
+
+       counters = calloc (x_max, sizeof (*counters));
+       accumulated = calloc (x_max, sizeof (*accumulated));
+
+       /* Downsample */
+       max = 0;
+       for (i = 0; i < ctx->latency_histogram_size; i++)
+       {
+               x = i * x_max / ctx->latency_histogram_size;
+               counters[x] += ctx->latency_histogram[i];
+               accumulated[x] = counters[x];
+
+               if (max < counters[x])
+                       max = counters[x];
+       }
+
+       /* Sum */
+       for (x = 1; x < x_max; x++)
+               accumulated[x] += accumulated[x - 1];
+       num = accumulated[x_max - 1];
+
+       /* Calculate ratios */
+       for (x = 0; x < x_max; x++)
+       {
+               double height = ((double) counters[x]) / ((double) max);
+               double ratio_this = ((double) accumulated[x]) / ((double) num);
+               double ratio_prev = 0.0;
+               size_t index;
+               int color = 0;
+
+               index = (size_t) (height * ((double) symbols_num));
+               if (index >= symbols_num)
+                       index = symbols_num - 1;
+
+               if (x > 0)
+                       ratio_prev = ((double) accumulated[x - 1]) / ((double) num);
+
+               if (has_colors () == TRUE)
+               {
+                       if ((ratio_this <= 0.5) || ((ratio_prev < 0.5) && (ratio_this > 0.5)))
+                               color = OPING_GREEN;
+                       else if ((ratio_this <= 0.95) || ((ratio_prev < 0.95) && (ratio_this > 0.95)))
+                               color = OPING_YELLOW;
+                       else
+                               color = OPING_RED;
+
+                       wattron (ctx->window, COLOR_PAIR(color));
+               }
+
+               if (counters[x] == 0)
+                       mvwaddch (ctx->window, /* y = */ 3, /* x = */ x + 2, ' ');
+               else if (has_utf8 ())
+                       mvwprintw (ctx->window, /* y = */ 3, /* x = */ x + 2,
+                                       hist_symbols_utf8[index]);
+               else
+                       mvwaddch (ctx->window, /* y = */ 3, /* x = */ x + 2,
+                                       hist_symbols_acs[index] | A_ALTCHARSET);
+
+               if (has_colors () == TRUE)
+                       wattroff (ctx->window, COLOR_PAIR(color));
+
+       }
+
+       free (accumulated);
+       return (0);
+} /* }}} int update_graph_histogram */
 
 static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter) /* {{{ */
 {
@@ -811,19 +1096,29 @@ static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter)
        {
                double average;
                double deviation;
+               double percentile;
 
                average = context_get_average (ctx);
                deviation = context_get_stddev (ctx);
+               percentile = context_get_percentile (ctx, opt_percentile);
 
                mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
-                               "rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms",
+                               "rtt min/avg/%.0f%%/max/sdev = "
+                               "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
+                               opt_percentile,
                                ctx->latency_min,
                                average,
+                               percentile,
                                ctx->latency_max,
                                deviation);
        }
 
-       update_prettyping_graph (ctx, latency, sequence);
+       if (opt_show_graph == 1)
+               update_graph_prettyping (ctx, latency, sequence);
+       else if (opt_show_graph == 2)
+               update_graph_boxplot (ctx);
+       else if (opt_show_graph == 3)
+               update_graph_histogram (ctx);
 
        wrefresh (ctx->window);
 
@@ -836,12 +1131,13 @@ static int on_resize (pingobj_t *ping) /* {{{ */
        int width = 0;
        int height = 0;
        int main_win_height;
+       int box_height = (opt_show_graph == 0) ? 4 : 5;
 
        getmaxyx (stdscr, height, width);
        if ((height < 1) || (width < 1))
                return (EINVAL);
 
-       main_win_height = height - (5 * host_num);
+       main_win_height = height - (box_height * host_num);
        wresize (main_win, main_win_height, /* width = */ width);
        /* Allow scrolling */
        scrollok (main_win, TRUE);
@@ -865,9 +1161,9 @@ static int on_resize (pingobj_t *ping) /* {{{ */
                        delwin (context->window);
                        context->window = NULL;
                }
-               context->window = newwin (/* height = */ 5,
+               context->window = newwin (/* height = */ box_height,
                                /* width = */ width,
-                               /* y = */ main_win_height + (5 * context->index),
+                               /* y = */ main_win_height + (box_height * context->index),
                                /* x = */ 0);
        }
 
@@ -899,6 +1195,7 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */
        int width = 0;
        int height = 0;
        int main_win_height;
+       int box_height = (opt_show_graph == 0) ? 4 : 5;
 
        initscr ();
        cbreak ();
@@ -920,7 +1217,7 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */
                init_pair (OPING_RED_HIST,    COLOR_RED,    COLOR_YELLOW);
        }
 
-       main_win_height = height - (5 * host_num);
+       main_win_height = height - (box_height * host_num);
        main_win = newwin (/* height = */ main_win_height,
                        /* width = */ width,
                        /* y = */ 0, /* x = */ 0);
@@ -947,9 +1244,9 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */
                        delwin (context->window);
                        context->window = NULL;
                }
-               context->window = newwin (/* height = */ 5,
+               context->window = newwin (/* height = */ box_height,
                                /* width = */ width,
-                               /* y = */ main_win_height + (5 * context->index),
+                               /* y = */ main_win_height + (box_height * context->index),
                                /* x = */ 0);
        }
 
@@ -1015,6 +1312,30 @@ static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
 } /* }}} int post_sleep_hook */
 #endif
 
+static void update_context (ping_context_t *context, double latency) /* {{{ */
+{
+       size_t bucket;
+
+       context->req_rcvd++;
+       context->latency_total += latency;
+       context->latency_total_square += (latency * latency);
+
+       if ((context->latency_max < 0.0) || (context->latency_max < latency))
+               context->latency_max = latency;
+       if ((context->latency_min < 0.0) || (context->latency_min > latency))
+               context->latency_min = latency;
+
+       if (context->latency_histogram == NULL)
+               return;
+
+       /* latency is in ms, opt_interval is in s. */
+       bucket = (size_t) ((latency * (context->latency_histogram_size - 1))
+                       / (1000.0 * opt_interval));
+       if (bucket >= context->latency_histogram_size)
+               bucket = context->latency_histogram_size - 1;
+       context->latency_histogram[bucket]++;
+} /* }}} void update_context */
+
 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
                __attribute__((unused)) int index)
 {
@@ -1062,14 +1383,7 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
        context->req_sent++;
        if (latency > 0.0)
        {
-               context->req_rcvd++;
-               context->latency_total += latency;
-               context->latency_total_square += (latency * latency);
-
-               if ((context->latency_max < 0.0) || (context->latency_max < latency))
-                       context->latency_max = latency;
-               if ((context->latency_min < 0.0) || (context->latency_min > latency))
-                       context->latency_min = latency;
+               update_context (context, latency);
 
 #if USE_NCURSES
                if (has_colors () == TRUE)
@@ -1184,13 +1498,18 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */
                {
                        double average;
                        double deviation;
+                       double percentile;
 
                        average = context_get_average (context);
                        deviation = context_get_stddev (context);
+                       percentile = context_get_percentile (context, opt_percentile);
 
-                       printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
+                       printf ("rtt min/avg/%.0f%%/max/sdev = "
+                                       "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
+                                       opt_percentile,
                                        context->latency_min,
                                        average,
+                                       percentile,
                                        context->latency_max,
                                        deviation);
                }