X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Foping.c;h=3a04fcd1ecfe7a1529e7cff44dca9b161a1083bf;hb=ee13385b1c68103b7d57a745ee8a1ae908406df6;hp=5b75dae02efe461849361c8716d9e493b5c6690e;hpb=6cf6907d4c76235adfb19ca44ea354c8af254e2e;p=liboping.git diff --git a/src/oping.c b/src/oping.c index 5b75dae..3a04fcd 100644 --- a/src/oping.c +++ b/src/oping.c @@ -1,6 +1,6 @@ /** * Object oriented C module to send ICMP and ICMPv6 `echo's. - * Copyright (C) 2006-2011 Florian octo Forster + * Copyright (C) 2006-2014 Florian octo Forster * * 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 @@ -74,13 +74,52 @@ #include #endif +#include +#include + #if USE_NCURSES # define NCURSES_OPAQUE 1 -# include +/* http://newsgroups.derkeiler.com/Archive/Rec/rec.games.roguelike.development/2010-09/msg00050.html */ +# define _X_OPEN_SOURCE_EXTENDED + +# if HAVE_NCURSESW_NCURSES_H +# include +# elif HAVE_NCURSES_H +# include +# endif # define OPING_GREEN 1 # define OPING_YELLOW 2 # define OPING_RED 3 +# 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" @@ -89,6 +128,10 @@ # 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) /**/ @@ -108,6 +151,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 @@ -121,6 +169,12 @@ 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_utf8 = 0; +#endif static int host_num = 0; @@ -150,6 +204,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 @@ -170,6 +228,9 @@ static void context_destroy (ping_context_t *context) /* {{{ */ } #endif + free (context->latency_histogram); + context->latency_histogram = NULL; + free (context); } /* }}} void context_destroy */ @@ -187,6 +248,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; @@ -265,6 +364,12 @@ 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 + " -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" "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n" "by Florian octo Forster \n" @@ -467,7 +572,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:P:" +#if USE_NCURSES + "uU" +#endif + ); if (optchar == -1) break; @@ -484,7 +593,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); @@ -510,6 +624,7 @@ static int read_options (int argc, char **argv) /* {{{ */ opt_interval = new_interval; } break; + case 'I': { if (opt_srcaddr != NULL) @@ -538,6 +653,47 @@ 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 '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; @@ -546,6 +702,9 @@ static int read_options (int argc, char **argv) /* {{{ */ } } + if (opt_percentile <= 0.0) + opt_percentile = OPING_DEFAULT_PERCENTILE; + return (optind); } /* }}} read_options */ @@ -597,12 +756,120 @@ static void time_calc (struct timespec *ts_dest, /* {{{ */ } /* }}} void time_calc */ #if USE_NCURSES -static int update_stats_from_context (ping_context_t *ctx) /* {{{ */ +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); + + ping_iterator_get_info (iter, PING_INFO_LATENCY, + &latency, &buffer_len); + + unsigned int sequence = 0; + buffer_len = sizeof (sequence); + ping_iterator_get_info (iter, PING_INFO_SEQUENCE, + &sequence, &buffer_len); + + if ((ctx == NULL) || (ctx->window == NULL)) return (EINVAL); - werase (ctx->window); + /* werase (ctx->window); */ box (ctx->window, 0, 0); wattron (ctx->window, A_BOLD); @@ -620,18 +887,25 @@ static int update_stats_from_context (ping_context_t *ctx) /* {{{ */ { 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); + wrefresh (ctx->window); return (0); @@ -648,7 +922,7 @@ static int on_resize (pingobj_t *ping) /* {{{ */ if ((height < 1) || (width < 1)) return (EINVAL); - main_win_height = height - (4 * host_num); + main_win_height = height - (5 * host_num); wresize (main_win, main_win_height, /* width = */ width); /* Allow scrolling */ scrollok (main_win, TRUE); @@ -672,9 +946,9 @@ static int on_resize (pingobj_t *ping) /* {{{ */ delwin (context->window); context->window = NULL; } - context->window = newwin (/* height = */ 4, + context->window = newwin (/* height = */ 5, /* width = */ width, - /* y = */ main_win_height + (4 * context->index), + /* y = */ main_win_height + (5 * context->index), /* x = */ 0); } @@ -722,9 +996,12 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */ init_pair (OPING_GREEN, COLOR_GREEN, /* default = */ 0); init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ 0); init_pair (OPING_RED, COLOR_RED, /* default = */ 0); + init_pair (OPING_GREEN_HIST, COLOR_GREEN, COLOR_BLACK); + init_pair (OPING_YELLOW_HIST, COLOR_YELLOW, COLOR_GREEN); + init_pair (OPING_RED_HIST, COLOR_RED, COLOR_YELLOW); } - main_win_height = height - (4 * host_num); + main_win_height = height - (5 * host_num); main_win = newwin (/* height = */ main_win_height, /* width = */ width, /* y = */ 0, /* x = */ 0); @@ -751,9 +1028,9 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */ delwin (context->window); context->window = NULL; } - context->window = newwin (/* height = */ 4, + context->window = newwin (/* height = */ 5, /* width = */ width, - /* y = */ main_win_height + (4 * context->index), + /* y = */ main_win_height + (5 * context->index), /* x = */ 0); } @@ -819,6 +1096,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) { @@ -866,14 +1167,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) @@ -946,18 +1240,17 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */ } #if USE_NCURSES - update_stats_from_context (context); + update_stats_from_context (context, iter); wrefresh (main_win); #endif } /* }}} void update_host_hook */ -/* returns the number of significant failures: sum over hosts of - unreturned packets exceeding 50% of the number sent, rounding up. */ +/* 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; - /* failures to report: sum over hosts of number of failed - returns above 50% */ int failure_count = 0; #if USE_NCURSES @@ -979,23 +1272,28 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */ context->latency_total); { - /* threshold for counting failed returns is 50%, rounding up */ - int threshold = (context->req_sent + 1) / 2; - if (context->req_rcvd < threshold) - failure_count += threshold - context->req_rcvd; + 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; 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); } @@ -1038,6 +1336,7 @@ int main (int argc, char **argv) /* {{{ */ } #endif + setlocale(LC_ALL, ""); optind = read_options (argc, argv); #if !_POSIX_SAVED_IDS @@ -1242,7 +1541,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)); @@ -1275,14 +1579,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; } } @@ -1293,14 +1596,19 @@ int main (int argc, char **argv) /* {{{ */ opt_count--; } /* while (opt_count != 0) */ + /* Returns the number of failed hosts according to -Z. */ status = post_loop_hook (ping); ping_destroy (ping); - if (status) - return (EXIT_FAILURE + status); + if (status == 0) + exit (EXIT_SUCCESS); else - return (EXIT_SUCCESS); + { + if (status > 255) + status = 255; + exit (status); + } } /* }}} int main */ /* vim: set fdm=marker : */