src/oping.c: Add median and 'n'th percentile, remove average and stddev.
[liboping.git] / src / oping.c
index 381c8f3..ff06670 100644 (file)
@@ -95,6 +95,9 @@
 # define OPING_YELLOW_HIST 5
 # define OPING_RED_HIST 6
 
+double const threshold_green = 0.8;
+double const threshold_yellow = 0.95;
+
 static char const * const hist_symbols_utf8[] = {
        "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" };
 static size_t const hist_symbols_utf8_num = sizeof (hist_symbols_utf8)
@@ -160,11 +163,12 @@ typedef struct ping_context
        double latency_min;
        double latency_max;
        double latency_total;
-       double latency_total_square;
 
 /* 1000 + one "infinity" bucket. */
 #define OPING_HISTOGRAM_BUCKETS 1001
-       uint32_t *latency_histogram;
+       uint32_t *histogram_counters;
+       uint32_t *histogram_accumulated;
+       double *histogram_ratio;
        size_t latency_histogram_size;
 
 #if USE_NCURSES
@@ -214,11 +218,14 @@ static ping_context_t *context_create (void) /* {{{ */
        ret->latency_min   = -1.0;
        ret->latency_max   = -1.0;
        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));
+       ret->histogram_counters = calloc (ret->latency_histogram_size,
+                       sizeof (*ret->histogram_counters));
+       ret->histogram_accumulated = calloc (ret->latency_histogram_size,
+                       sizeof (*ret->histogram_accumulated));
+       ret->histogram_ratio = calloc (ret->latency_histogram_size,
+                       sizeof (*ret->histogram_ratio));
 
 #if USE_NCURSES
        ret->window = NULL;
@@ -240,51 +247,32 @@ static void context_destroy (ping_context_t *context) /* {{{ */
        }
 #endif
 
-       free (context->latency_histogram);
-       context->latency_histogram = NULL;
-
-       free (context);
-} /* }}} void context_destroy */
-
-static double context_get_average (ping_context_t *ctx) /* {{{ */
-{
-       double num_total;
+       free (context->histogram_counters);
+       context->histogram_counters = NULL;
 
-       if (ctx == NULL)
-               return (-1.0);
+       free (context->histogram_accumulated);
+       context->histogram_accumulated = NULL;
 
-       if (ctx->req_rcvd < 1)
-               return (-0.0);
+       free (context->histogram_ratio);
+       context->histogram_ratio = NULL;
 
-       num_total = (double) ctx->req_rcvd;
-       return (ctx->latency_total / num_total);
-} /* }}} double context_get_average */
+       free (context);
+} /* }}} void context_destroy */
 
 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;
+       double ret;
 
-       if (ctx->latency_histogram == NULL)
+       if (ctx->histogram_ratio == 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)
+               if (ctx->histogram_ratio[i] >= threshold)
                        break;
-       }
 
        if (i >= ctx->latency_histogram_size)
                return (NAN);
@@ -295,26 +283,14 @@ static double context_get_percentile (ping_context_t *ctx, /* {{{ */
 
        /* 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 */
+       ret = (index_to_ms_factor * ((double) (i + 1)));
 
-static double context_get_stddev (ping_context_t *ctx) /* {{{ */
-{
-       double num_total;
-
-       if (ctx == NULL)
-               return (-1.0);
+       /* Avoid reporting a higher latency than latency_max. */
+       if (ret > ctx->latency_max)
+               ret = ctx->latency_max;
 
-       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 */
+       return (ret);
+} /* }}} double context_get_percentile */
 
 static double context_get_packet_loss (const ping_context_t *ctx) /* {{{ */
 {
@@ -378,6 +354,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"
@@ -801,38 +778,25 @@ static _Bool has_utf8() /* {{{ */
 
 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)
+       if (x_max <= 8)
                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];
+               ratios[x] = ctx->histogram_ratio[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 = ' ';
@@ -892,7 +856,6 @@ static int update_graph_boxplot (ping_context_t *ctx) /* {{{ */
        }
 
        free (ratios);
-       free (accumulated);
        return (0);
 } /* }}} int update_graph_boxplot */
 
@@ -1003,7 +966,7 @@ static int update_graph_histogram (ping_context_t *ctx) /* {{{ */
        for (i = 0; i < ctx->latency_histogram_size; i++)
        {
                x = i * x_max / ctx->latency_histogram_size;
-               counters[x] += ctx->latency_histogram[i];
+               counters[x] += ctx->histogram_counters[i];
                accumulated[x] = counters[x];
 
                if (max < counters[x])
@@ -1033,9 +996,13 @@ static int update_graph_histogram (ping_context_t *ctx) /* {{{ */
 
                if (has_colors () == TRUE)
                {
-                       if ((ratio_this <= 0.5) || ((ratio_prev < 0.5) && (ratio_this > 0.5)))
+                       if ((ratio_this <= threshold_green)
+                                       || ((ratio_prev < threshold_green)
+                                               && (ratio_this > threshold_green)))
                                color = OPING_GREEN;
-                       else if ((ratio_this <= 0.95) || ((ratio_prev < 0.95) && (ratio_this > 0.95)))
+                       else if ((ratio_this <= threshold_yellow)
+                                       || ((ratio_prev < threshold_yellow)
+                                               && (ratio_this > threshold_yellow)))
                                color = OPING_YELLOW;
                        else
                                color = OPING_RED;
@@ -1094,23 +1061,17 @@ static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter)
                        ctx->latency_total);
        if (ctx->req_rcvd != 0)
        {
-               double average;
-               double deviation;
+               double median;
                double percentile;
 
-               average = context_get_average (ctx);
-               deviation = context_get_stddev (ctx);
+               median = context_get_percentile (ctx, 50.0);
                percentile = context_get_percentile (ctx, opt_percentile);
 
                mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
-                               "rtt min/avg/%.0f%%/max/sdev = "
-                               "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
-                               opt_percentile,
-                               ctx->latency_min,
-                               average,
-                               percentile,
-                               ctx->latency_max,
-                               deviation);
+                               "RTT[ms]: min = %.0f, median = %.0f, p(%.0f) = %.0f, max = %.0f",
+                               ctx->latency_min, median,
+                               opt_percentile, percentile,
+                               ctx->latency_max);
        }
 
        if (opt_show_graph == 1)
@@ -1312,28 +1273,46 @@ static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
 } /* }}} int post_sleep_hook */
 #endif
 
+static size_t latency_to_bucket (ping_context_t *ctx, double latency) /* {{{ */
+{
+       size_t bucket;
+
+       /* latency is in ms, opt_interval is in s. */
+       bucket = (size_t) ((latency * (ctx->latency_histogram_size - 1))
+                       / (1000.0 * opt_interval));
+       if (bucket >= ctx->latency_histogram_size)
+               bucket = ctx->latency_histogram_size - 1;
+
+       return (bucket);
+} /* }}} size_t latency_to_bucket */
+
 static void update_context (ping_context_t *context, double latency) /* {{{ */
 {
        size_t bucket;
+       size_t i;
+       double num;
 
        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;
+       bucket = latency_to_bucket (context, latency);
+       num = (double) context->req_rcvd;
 
-       /* 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]++;
+       context->histogram_counters[bucket]++;
+
+       context->histogram_accumulated[0] = context->histogram_counters[0];
+       context->histogram_ratio[0] = ((double) context->histogram_accumulated[0]) / num;
+       for (i = 1; i < context->latency_histogram_size; i++)
+       {
+               context->histogram_accumulated[i] = context->histogram_accumulated[i - 1]
+                       + context->histogram_counters[i];
+               context->histogram_ratio[i] = ((double) context->histogram_accumulated[i]) / num;
+       }
 } /* }}} void update_context */
 
 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
@@ -1388,16 +1367,28 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
 #if USE_NCURSES
                if (has_colors () == TRUE)
                {
+                       size_t bucket;
+                       double ratio_this;
+                       double ratio_prev;
                        int color = OPING_GREEN;
-                       double average = context_get_average (context);
-                       double stddev = context_get_stddev (context);
 
-                       if ((latency < (average - (2 * stddev)))
-                                       || (latency > (average + (2 * stddev))))
-                               color = OPING_RED;
-                       else if ((latency < (average - stddev))
-                                       || (latency > (average + stddev)))
+                       bucket = latency_to_bucket (context, latency);
+                       ratio_this = context->histogram_ratio[bucket];
+                       if (bucket > 0)
+                               ratio_prev = context->histogram_ratio[bucket - 1];
+                       else
+                               ratio_prev = 0.0;
+
+                       if ((ratio_this <= threshold_green)
+                                       || ((ratio_prev < threshold_green)
+                                               && (ratio_this > threshold_green)))
+                               color = OPING_GREEN;
+                       else if ((ratio_this <= threshold_yellow)
+                                       || ((ratio_prev < threshold_yellow)
+                                               && (ratio_this > threshold_yellow)))
                                color = OPING_YELLOW;
+                       else
+                               color = OPING_RED;
 
                        HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
                                        data_len, context->host, context->addr,
@@ -1431,7 +1422,7 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
                }
 #endif
        }
-       else
+       else /* if (!(latency > 0.0)) */
        {
 #if USE_NCURSES
                if (has_colors () == TRUE)
@@ -1496,22 +1487,16 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */
 
                if (context->req_rcvd != 0)
                {
-                       double average;
-                       double deviation;
+                       double median;
                        double percentile;
 
-                       average = context_get_average (context);
-                       deviation = context_get_stddev (context);
+                       median = context_get_percentile (context, 50.0);
                        percentile = context_get_percentile (context, opt_percentile);
 
-                       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);
+                       printf ("RTT[ms]: min = %.0f, median = %.0f, p(%.0f) = %.0f, max = %.0f\n",
+                                       context->latency_min, median,
+                                       opt_percentile, percentile,
+                                       context->latency_max);
                }
 
                ping_iterator_set_context (iter, NULL);
@@ -1727,6 +1712,9 @@ int main (int argc, char **argv) /* {{{ */
                exit (EXIT_FAILURE);
        }
 
+       if (host_num == 0)
+               exit (EXIT_FAILURE);
+
 #if _POSIX_SAVED_IDS
        saved_set_uid = (uid_t) -1;
 #endif