oping manual page: Document the "-g histogram" option.
[liboping.git] / src / oping.c
index b7ef045..367227a 100644 (file)
@@ -123,14 +123,15 @@ static size_t const hist_colors_num = sizeof (hist_colors_utf8)
 #endif
 
 /* "─" */
-#define BOXPLOT_WHISKER_BAR (113 | A_ALTCHARSET)
+#define BOXPLOT_WHISKER_BAR       (113 | A_ALTCHARSET)
 /* "├" */
-#define BOXPLOT_WHISKER_LEFT_END (116 | A_ALTCHARSET)
+#define BOXPLOT_WHISKER_LEFT_END  (116 | A_ALTCHARSET)
 /* "┤" */
 #define BOXPLOT_WHISKER_RIGHT_END (117 | A_ALTCHARSET)
-#define BOXPLOT_BOX ' '
-/* "│" */
-#define BOXPLOT_MEDIAN (120 | A_ALTCHARSET)
+/* Inverted */
+#define BOXPLOT_BOX               ' '
+/* "│", inverted */
+#define BOXPLOT_MEDIAN            (120 | A_ALTCHARSET)
 
 #include "oping.h"
 
@@ -183,6 +184,7 @@ static uint8_t opt_send_qos   = 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
 
@@ -376,6 +378,7 @@ static void usage_exit (const char *name, int status) /* {{{ */
                        "  -f filename  filename to read hosts from\n"
 #if USE_NCURSES
                        "  -u / -U      force / disable UTF-8 output\n"
+                       "  -g graph     graph type to draw\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"
@@ -584,7 +587,7 @@ static int read_options (int argc, char **argv) /* {{{ */
        {
                optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:P:"
 #if USE_NCURSES
-                               "uU"
+                               "uUg:"
 #endif
                                );
 
@@ -678,6 +681,19 @@ static int read_options (int argc, char **argv) /* {{{ */
                                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;
@@ -707,6 +723,7 @@ static int read_options (int argc, char **argv) /* {{{ */
                        case 'h':
                                usage_exit (argv[0], 0);
                                break;
+
                        default:
                                usage_exit (argv[0], 1);
                }
@@ -783,7 +800,7 @@ static _Bool has_utf8() /* {{{ */
 # endif
 } /* }}} _Bool has_utf8 */
 
-static int update_boxplot (ping_context_t *ctx) /* {{{ */
+static int update_graph_boxplot (ping_context_t *ctx) /* {{{ */
 {
        uint32_t *accumulated;
        double *ratios;
@@ -878,9 +895,9 @@ static int update_boxplot (ping_context_t *ctx) /* {{{ */
        free (ratios);
        free (accumulated);
        return (0);
-} /* }}} int update_boxplot */
+} /* }}} int update_graph_boxplot */
 
-static int update_prettyping_graph (ping_context_t *ctx, /* {{{ */
+static int update_graph_prettyping (ping_context_t *ctx, /* {{{ */
                double latency, unsigned int sequence)
 {
        int color = OPING_RED;
@@ -957,7 +974,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) /* {{{ */
 {
@@ -1011,7 +1114,12 @@ static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter)
                                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);
 
@@ -1024,12 +1132,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);
@@ -1053,9 +1162,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);
        }
 
@@ -1087,6 +1196,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 ();
@@ -1108,7 +1218,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);
@@ -1135,9 +1245,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);
        }