2 * Object oriented C module to send ICMP and ICMPv6 `echo's.
3 * Copyright (C) 2006-2014 Florian octo Forster <ff at octo.it>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; only version 2 of the License is
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 # include <inttypes.h>
33 # error "You don't have the standard C99 header files installed"
34 #endif /* STDC_HEADERS */
44 #if TIME_WITH_SYS_TIME
45 # include <sys/time.h>
49 # include <sys/time.h>
56 # include <sys/socket.h>
59 # include <netinet/in.h>
62 # include <netinet/ip.h>
66 # include <netdb.h> /* NI_MAXHOST */
74 #include <sys/types.h>
81 # define NCURSES_OPAQUE 1
82 /* http://newsgroups.derkeiler.com/Archive/Rec/rec.games.roguelike.development/2010-09/msg00050.html */
83 # define _X_OPEN_SOURCE_EXTENDED
85 # if HAVE_NCURSESW_NCURSES_H
86 # include <ncursesw/ncurses.h>
91 # define OPING_GREEN 1
92 # define OPING_YELLOW 2
94 # define OPING_GREEN_HIST 4
95 # define OPING_YELLOW_HIST 5
96 # define OPING_RED_HIST 6
98 static char const * const hist_symbols_utf8[] = {
99 "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" };
100 static size_t const hist_symbols_utf8_num = sizeof (hist_symbols_utf8)
101 / sizeof (hist_symbols_utf8[0]);
103 /* scancodes for 6 levels of horizontal bars, ncurses-specific */
104 /* those are not the usual constants because those are not constant */
105 static int const hist_symbols_acs[] = {
106 115, /* ACS_S9 "⎽" */
107 114, /* ACS_S7 "⎼" */
108 113, /* ACS_S5 "─" */
109 112, /* ACS_S3 "⎻" */
112 static size_t const hist_symbols_acs_num = sizeof (hist_symbols_acs)
113 / sizeof (hist_symbols_acs[0]);
115 /* use different colors without a background for scancodes */
116 static int const hist_colors_utf8[] = {
117 OPING_GREEN_HIST, OPING_YELLOW_HIST, OPING_RED_HIST };
118 static int const hist_colors_acs[] = {
119 OPING_GREEN, OPING_YELLOW, OPING_RED };
120 /* assuming that both arrays are the same size */
121 static size_t const hist_colors_num = sizeof (hist_colors_utf8)
122 / sizeof (hist_colors_utf8[0]);
126 #define BOXPLOT_WHISKER_BAR (113 | A_ALTCHARSET)
128 #define BOXPLOT_WHISKER_LEFT_END (116 | A_ALTCHARSET)
130 #define BOXPLOT_WHISKER_RIGHT_END (117 | A_ALTCHARSET)
132 #define BOXPLOT_BOX ' '
134 #define BOXPLOT_MEDIAN (120 | A_ALTCHARSET)
138 #ifndef _POSIX_SAVED_IDS
139 # define _POSIX_SAVED_IDS 0
142 #ifndef IPTOS_MINCOST
143 # define IPTOS_MINCOST 0x02
146 /* Remove GNU specific __attribute__ settings when using another compiler */
148 # define __attribute__(x) /**/
151 typedef struct ping_context
153 char host[NI_MAXHOST];
154 char addr[NI_MAXHOST];
162 double latency_total;
163 double latency_total_square;
165 /* 1000 + one "infinity" bucket. */
166 #define OPING_HISTOGRAM_BUCKETS 1001
167 uint32_t *histogram_counters;
168 uint32_t *histogram_accumulated;
169 double *histogram_ratio;
170 size_t latency_histogram_size;
177 static double opt_interval = 1.0;
178 static int opt_addrfamily = PING_DEF_AF;
179 static char *opt_srcaddr = NULL;
180 static char *opt_device = NULL;
181 static char *opt_filename = NULL;
182 static int opt_count = -1;
183 static int opt_send_ttl = 64;
184 static uint8_t opt_send_qos = 0;
185 #define OPING_DEFAULT_PERCENTILE 95.0
186 static double opt_percentile = -1.0;
187 static double opt_exit_status_threshold = 1.0;
189 static int opt_show_graph = 1;
190 static int opt_utf8 = 0;
193 static int host_num = 0;
196 static WINDOW *main_win = NULL;
199 static void sigint_handler (int signal) /* {{{ */
201 /* Make compiler happy */
205 } /* }}} void sigint_handler */
207 static ping_context_t *context_create (void) /* {{{ */
211 if ((ret = malloc (sizeof (ping_context_t))) == NULL)
214 memset (ret, '\0', sizeof (ping_context_t));
216 ret->latency_min = -1.0;
217 ret->latency_max = -1.0;
218 ret->latency_total = 0.0;
219 ret->latency_total_square = 0.0;
221 ret->latency_histogram_size = (size_t) OPING_HISTOGRAM_BUCKETS;
222 ret->histogram_counters = calloc (ret->latency_histogram_size,
223 sizeof (*ret->histogram_counters));
224 ret->histogram_accumulated = calloc (ret->latency_histogram_size,
225 sizeof (*ret->histogram_accumulated));
226 ret->histogram_ratio = calloc (ret->latency_histogram_size,
227 sizeof (*ret->histogram_ratio));
234 } /* }}} ping_context_t *context_create */
236 static void context_destroy (ping_context_t *context) /* {{{ */
242 if (context->window != NULL)
244 delwin (context->window);
245 context->window = NULL;
249 free (context->histogram_counters);
250 context->histogram_counters = NULL;
252 free (context->histogram_accumulated);
253 context->histogram_accumulated = NULL;
255 free (context->histogram_ratio);
256 context->histogram_ratio = NULL;
259 } /* }}} void context_destroy */
261 static double context_get_average (ping_context_t *ctx) /* {{{ */
268 if (ctx->req_rcvd < 1)
271 num_total = (double) ctx->req_rcvd;
272 return (ctx->latency_total / num_total);
273 } /* }}} double context_get_average */
275 static double context_get_percentile (ping_context_t *ctx, /* {{{ */
278 double threshold = percentile / 100.0;
279 double index_to_ms_factor;
282 if (ctx->histogram_ratio == NULL)
285 for (i = 0; i < ctx->latency_histogram_size; i++)
286 if (ctx->histogram_ratio[i] >= threshold)
289 if (i >= ctx->latency_histogram_size)
291 else if (i == (ctx->latency_histogram_size - 1))
294 index_to_ms_factor = (1000.0 * opt_interval) / (ctx->latency_histogram_size - 1);
296 /* Multiply with i+1, because we're interested in the _upper_ bound of
298 return (index_to_ms_factor * ((double) (i + 1)));
299 } /* }}} double context_get_percentile */
301 static double context_get_stddev (ping_context_t *ctx) /* {{{ */
308 if (ctx->req_rcvd < 1)
310 else if (ctx->req_rcvd < 2)
313 num_total = (double) ctx->req_rcvd;
314 return (sqrt (((num_total * ctx->latency_total_square)
315 - (ctx->latency_total * ctx->latency_total))
316 / (num_total * (num_total - 1.0))));
317 } /* }}} double context_get_stddev */
319 static double context_get_packet_loss (const ping_context_t *ctx) /* {{{ */
324 if (ctx->req_sent < 1)
327 return (100.0 * (ctx->req_sent - ctx->req_rcvd)
328 / ((double) ctx->req_sent));
329 } /* }}} double context_get_packet_loss */
331 static int ping_initialize_contexts (pingobj_t *ping) /* {{{ */
333 pingobj_iter_t *iter;
340 for (iter = ping_iterator_get (ping);
342 iter = ping_iterator_next (iter))
344 ping_context_t *context;
347 context = context_create ();
348 context->index = index;
350 buffer_size = sizeof (context->host);
351 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
353 buffer_size = sizeof (context->addr);
354 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
356 ping_iterator_set_context (iter, (void *) context);
362 } /* }}} int ping_initialize_contexts */
364 static void usage_exit (const char *name, int status) /* {{{ */
366 fprintf (stderr, "Usage: %s [OPTIONS] "
367 "-f filename | host [host [host ...]]\n"
369 "\nAvailable options:\n"
370 " -4|-6 force the use of IPv4 or IPv6\n"
371 " -c count number of ICMP packets to send\n"
372 " -i interval interval with which to send ICMP packets\n"
373 " -t ttl time to live for each ICMP packet\n"
374 " -Q qos Quality of Service (QoS) of outgoing packets\n"
375 " Use \"-Q help\" for a list of valid options.\n"
376 " -I srcaddr source address\n"
377 " -D device outgoing interface name\n"
378 " -f filename filename to read hosts from\n"
380 " -u / -U force / disable UTF-8 output\n"
381 " -g graph graph type to draw\n"
383 " -P percent Report the n'th percentile of latency\n"
384 " -Z percent Exit with non-zero exit status if more than this percentage of\n"
385 " probes timed out. (default: never)\n"
387 "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
388 "by Florian octo Forster <octo@verplant.org>\n"
389 "for contributions see `AUTHORS'\n",
392 } /* }}} void usage_exit */
394 __attribute__((noreturn))
395 static void usage_qos_exit (const char *arg, int status) /* {{{ */
398 fprintf (stderr, "Invalid QoS argument: \"%s\"\n\n", arg);
400 fprintf (stderr, "Valid QoS arguments (option \"-Q\") are:\n"
402 " Differentiated Services (IPv4 and IPv6, RFC 2474)\n"
404 " be Best Effort (BE, default PHB).\n"
405 " ef Expedited Forwarding (EF) PHB group (RFC 3246).\n"
406 " (low delay, low loss, low jitter)\n"
407 " va Voice Admit (VA) DSCP (RFC 5865).\n"
408 " (capacity-admitted traffic)\n"
409 " af[1-4][1-3] Assured Forwarding (AF) PHB group (RFC 2597).\n"
410 " For example: \"af12\" (class 1, precedence 2)\n"
411 " cs[0-7] Class Selector (CS) PHB group (RFC 2474).\n"
412 " For example: \"cs1\" (priority traffic)\n"
414 " Type of Service (IPv4, RFC 1349, obsolete)\n"
416 " lowdelay (%#04x) minimize delay\n"
417 " throughput (%#04x) maximize throughput\n"
418 " reliability (%#04x) maximize reliability\n"
419 " mincost (%#04x) minimize monetary cost\n"
421 " Specify manually\n"
423 " 0x00 - 0xff Hexadecimal numeric specification.\n"
424 " 0 - 255 Decimal numeric specification.\n"
426 (unsigned int) IPTOS_LOWDELAY,
427 (unsigned int) IPTOS_THROUGHPUT,
428 (unsigned int) IPTOS_RELIABILITY,
429 (unsigned int) IPTOS_MINCOST);
432 } /* }}} void usage_qos_exit */
434 static int set_opt_send_qos (const char *opt) /* {{{ */
439 if (strcasecmp ("help", opt) == 0)
440 usage_qos_exit (/* arg = */ NULL, /* status = */ EXIT_SUCCESS);
441 /* DiffServ (RFC 2474): */
442 /* - Best effort (BE) */
443 else if (strcasecmp ("be", opt) == 0)
445 /* - Expedited Forwarding (EF, RFC 3246) */
446 else if (strcasecmp ("ef", opt) == 0)
447 opt_send_qos = 0xB8; /* == 0x2E << 2 */
448 /* - Voice Admit (VA, RFC 5865) */
449 else if (strcasecmp ("va", opt) == 0)
450 opt_send_qos = 0xB0; /* == 0x2D << 2 */
451 /* - Assured Forwarding (AF, RFC 2597) */
452 else if ((strncasecmp ("af", opt, strlen ("af")) == 0)
453 && (strlen (opt) == 4))
459 /* There are four classes, AF1x, AF2x, AF3x, and AF4x. */
462 else if (opt[2] == '2')
464 else if (opt[2] == '3')
466 else if (opt[2] == '4')
469 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
471 /* In each class, there are three precedences, AFx1, AFx2, and AFx3 */
474 else if (opt[3] == '2')
476 else if (opt[3] == '3')
479 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
481 dscp = (8 * class) + (2 * prec);
482 /* The lower two bits are used for Explicit Congestion Notification (ECN) */
483 opt_send_qos = dscp << 2;
485 /* - Class Selector (CS) */
486 else if ((strncasecmp ("cs", opt, strlen ("cs")) == 0)
487 && (strlen (opt) == 3))
491 if ((opt[2] < '0') || (opt[2] > '7'))
492 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
494 /* Not exactly legal by the C standard, but I don't know of any
495 * system not supporting this hack. */
496 class = ((uint8_t) opt[2]) - ((uint8_t) '0');
497 opt_send_qos = class << 5;
499 /* Type of Service (RFC 1349) */
500 else if (strcasecmp ("lowdelay", opt) == 0)
501 opt_send_qos = IPTOS_LOWDELAY;
502 else if (strcasecmp ("throughput", opt) == 0)
503 opt_send_qos = IPTOS_THROUGHPUT;
504 else if (strcasecmp ("reliability", opt) == 0)
505 opt_send_qos = IPTOS_RELIABILITY;
506 else if (strcasecmp ("mincost", opt) == 0)
507 opt_send_qos = IPTOS_MINCOST;
516 value = strtoul (opt, &endptr, /* base = */ 0);
517 if ((errno != 0) || (endptr == opt)
518 || (endptr == NULL) || (*endptr != 0)
520 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
522 opt_send_qos = (uint8_t) value;
526 } /* }}} int set_opt_send_qos */
528 static char *format_qos (uint8_t qos, char *buffer, size_t buffer_size) /* {{{ */
540 case 0x00: dscp_str = "be"; break;
541 case 0x2e: dscp_str = "ef"; break;
542 case 0x2d: dscp_str = "va"; break;
543 case 0x0a: dscp_str = "af11"; break;
544 case 0x0c: dscp_str = "af12"; break;
545 case 0x0e: dscp_str = "af13"; break;
546 case 0x12: dscp_str = "af21"; break;
547 case 0x14: dscp_str = "af22"; break;
548 case 0x16: dscp_str = "af23"; break;
549 case 0x1a: dscp_str = "af31"; break;
550 case 0x1c: dscp_str = "af32"; break;
551 case 0x1e: dscp_str = "af33"; break;
552 case 0x22: dscp_str = "af41"; break;
553 case 0x24: dscp_str = "af42"; break;
554 case 0x26: dscp_str = "af43"; break;
555 case 0x08: dscp_str = "cs1"; break;
556 case 0x10: dscp_str = "cs2"; break;
557 case 0x18: dscp_str = "cs3"; break;
558 case 0x20: dscp_str = "cs4"; break;
559 case 0x28: dscp_str = "cs5"; break;
560 case 0x30: dscp_str = "cs6"; break;
561 case 0x38: dscp_str = "cs7"; break;
562 default: dscp_str = NULL;
567 case 0x01: ecn_str = ",ecn(1)"; break;
568 case 0x02: ecn_str = ",ecn(0)"; break;
569 case 0x03: ecn_str = ",ce"; break;
570 default: ecn_str = "";
573 if (dscp_str == NULL)
574 snprintf (buffer, buffer_size, "0x%02x%s", dscp, ecn_str);
576 snprintf (buffer, buffer_size, "%s%s", dscp_str, ecn_str);
577 buffer[buffer_size - 1] = 0;
580 } /* }}} char *format_qos */
582 static int read_options (int argc, char **argv) /* {{{ */
588 optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:P:"
601 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
607 new_count = atoi (optarg);
610 opt_count = new_count;
612 if ((opt_percentile < 0.0) && (opt_count < 20))
613 opt_percentile = 100.0 * (opt_count - 1) / opt_count;
616 fprintf(stderr, "Ignoring invalid count: %s\n",
623 if (opt_filename != NULL)
625 opt_filename = strdup (optarg);
632 new_interval = atof (optarg);
633 if (new_interval < 0.001)
634 fprintf (stderr, "Ignoring invalid interval: %s\n",
637 opt_interval = new_interval;
643 if (opt_srcaddr != NULL)
645 opt_srcaddr = strdup (optarg);
656 new_send_ttl = atoi (optarg);
657 if ((new_send_ttl > 0) && (new_send_ttl < 256))
658 opt_send_ttl = new_send_ttl;
660 fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
666 set_opt_send_qos (optarg);
671 double new_percentile;
672 new_percentile = atof (optarg);
673 if (isnan (new_percentile)
674 || (new_percentile < 0.1)
675 || (new_percentile > 100.0))
676 fprintf (stderr, "Ignoring invalid percentile: %s\n",
679 opt_percentile = new_percentile;
685 if (strcasecmp ("none", optarg) == 0)
687 else if (strcasecmp ("prettyping", optarg) == 0)
689 else if (strcasecmp ("boxplot", optarg) == 0)
691 else if (strcasecmp ("histogram", optarg) == 0)
694 fprintf (stderr, "Unknown graph option: %s\n", optarg);
711 tmp = strtod (optarg, &endptr);
712 if ((errno != 0) || (endptr == NULL) || (*endptr != 0) || (tmp < 0.0) || (tmp > 100.0))
714 fprintf (stderr, "Ignoring invalid -Z argument: %s\n", optarg);
715 fprintf (stderr, "The \"-Z\" option requires a numeric argument between 0 and 100.\n");
718 opt_exit_status_threshold = tmp / 100.0;
724 usage_exit (argv[0], 0);
728 usage_exit (argv[0], 1);
732 if (opt_percentile <= 0.0)
733 opt_percentile = OPING_DEFAULT_PERCENTILE;
736 } /* }}} read_options */
738 static void time_normalize (struct timespec *ts) /* {{{ */
740 while (ts->tv_nsec < 0)
749 ts->tv_nsec += 1000000000;
752 while (ts->tv_nsec >= 1000000000)
755 ts->tv_nsec -= 1000000000;
757 } /* }}} void time_normalize */
759 static void time_calc (struct timespec *ts_dest, /* {{{ */
760 const struct timespec *ts_int,
761 const struct timeval *tv_begin,
762 const struct timeval *tv_end)
764 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
765 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
766 time_normalize (ts_dest);
768 /* Assure that `(begin + interval) > end'.
769 * This may seem overly complicated, but `tv_sec' is of type `time_t'
770 * which may be `unsigned. *sigh* */
771 if ((tv_end->tv_sec > ts_dest->tv_sec)
772 || ((tv_end->tv_sec == ts_dest->tv_sec)
773 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
776 ts_dest->tv_nsec = 0;
780 ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
781 ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
782 time_normalize (ts_dest);
783 } /* }}} void time_calc */
786 static _Bool has_utf8() /* {{{ */
788 # if HAVE_NCURSESW_NCURSES_H
791 /* Automatically determine */
792 if (strcasecmp ("UTF-8", nl_langinfo (CODESET)) == 0)
797 return ((_Bool) (opt_utf8 - 1));
801 } /* }}} _Bool has_utf8 */
803 static int update_graph_boxplot (ping_context_t *ctx) /* {{{ */
810 x_max = (size_t) getmaxx (ctx->window);
815 ratios = calloc (x_max, sizeof (*ratios));
818 for (i = 0; i < ctx->latency_histogram_size; i++)
820 x = i * x_max / ctx->latency_histogram_size;
821 ratios[x] = ctx->histogram_ratio[i];
824 for (x = 0; x < x_max; x++)
831 if (ratios[x] >= 0.5)
833 symbol = BOXPLOT_MEDIAN;
836 else if (ratios[x] > 0.25)
838 symbol = BOXPLOT_BOX;
841 else if (ratios[x] > 0.025)
842 symbol = BOXPLOT_WHISKER_BAR;
844 symbol = ' '; /* NOP */
848 if ((ratios[x - 1] < 0.5) && (ratios[x] >= 0.5))
850 symbol = BOXPLOT_MEDIAN;
853 else if (((ratios[x] >= 0.25) && (ratios[x] <= 0.75))
854 || ((ratios[x - 1] < 0.75) && (ratios[x] > 0.75)))
856 symbol = BOXPLOT_BOX;
859 else if ((ratios[x] < 0.5) && (ratios[x] >= 0.025))
861 if (ratios[x - 1] < 0.025)
862 symbol = BOXPLOT_WHISKER_LEFT_END;
864 symbol = BOXPLOT_WHISKER_BAR;
866 else if ((ratios[x] > .5) && (ratios[x] < 0.975))
868 symbol = BOXPLOT_WHISKER_BAR;
870 else if ((ratios[x] >= 0.975) && (ratios[x - 1] < 0.975))
871 symbol = BOXPLOT_WHISKER_RIGHT_END;
875 wattron (ctx->window, A_REVERSE);
876 mvwaddch (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
877 // mvwprintw (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
879 wattroff (ctx->window, A_REVERSE);
884 } /* }}} int update_graph_boxplot */
886 static int update_graph_prettyping (ping_context_t *ctx, /* {{{ */
887 double latency, unsigned int sequence)
889 int color = OPING_RED;
890 char const *symbol = "!";
896 x_max = getmaxx (ctx->window);
897 x_pos = ((sequence - 1) % (x_max - 4)) + 2;
903 size_t symbols_num = hist_symbols_acs_num;
904 size_t colors_num = 1;
906 size_t index_symbols;
910 /* latency is in milliseconds, opt_interval is in seconds. */
911 ratio = (latency * 0.001) / opt_interval;
917 symbols_num = hist_symbols_utf8_num;
919 if (has_colors () == TRUE)
920 colors_num = hist_colors_num;
922 intensity = (size_t) (ratio * ((double) (symbols_num * colors_num)));
923 if (intensity >= (symbols_num * colors_num))
924 intensity = (symbols_num * colors_num) - 1;
926 index_symbols = intensity % symbols_num;
927 assert (index_symbols < symbols_num);
929 index_colors = intensity / symbols_num;
930 assert (index_colors < colors_num);
934 color = hist_colors_utf8[index_colors];
935 symbol = hist_symbols_utf8[index_symbols];
939 color = hist_colors_acs[index_colors];
940 symbolc = hist_symbols_acs[index_symbols] | A_ALTCHARSET;
943 else /* if (!(latency >= 0.0)) */
944 wattron (ctx->window, A_BOLD);
946 if (has_colors () == TRUE)
947 wattron (ctx->window, COLOR_PAIR(color));
950 mvwprintw (ctx->window, /* y = */ 3, /* x = */ x_pos, symbol);
952 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x_pos, symbolc);
954 if (has_colors () == TRUE)
955 wattroff (ctx->window, COLOR_PAIR(color));
957 /* Use negation here to handle NaN correctly. */
958 if (!(latency >= 0.0))
959 wattroff (ctx->window, A_BOLD);
961 wprintw (ctx->window, " ");
963 } /* }}} int update_graph_prettyping */
965 static int update_graph_histogram (ping_context_t *ctx) /* {{{ */
968 uint32_t *accumulated;
975 size_t symbols_num = hist_symbols_acs_num;
978 symbols_num = hist_symbols_utf8_num;
980 x_max = (size_t) getmaxx (ctx->window);
985 counters = calloc (x_max, sizeof (*counters));
986 accumulated = calloc (x_max, sizeof (*accumulated));
990 for (i = 0; i < ctx->latency_histogram_size; i++)
992 x = i * x_max / ctx->latency_histogram_size;
993 counters[x] += ctx->histogram_counters[i];
994 accumulated[x] = counters[x];
996 if (max < counters[x])
1001 for (x = 1; x < x_max; x++)
1002 accumulated[x] += accumulated[x - 1];
1003 num = accumulated[x_max - 1];
1005 /* Calculate ratios */
1006 for (x = 0; x < x_max; x++)
1008 double height = ((double) counters[x]) / ((double) max);
1009 double ratio_this = ((double) accumulated[x]) / ((double) num);
1010 double ratio_prev = 0.0;
1014 index = (size_t) (height * ((double) symbols_num));
1015 if (index >= symbols_num)
1016 index = symbols_num - 1;
1019 ratio_prev = ((double) accumulated[x - 1]) / ((double) num);
1021 if (has_colors () == TRUE)
1023 if ((ratio_this <= 0.5) || ((ratio_prev < 0.5) && (ratio_this > 0.5)))
1024 color = OPING_GREEN;
1025 else if ((ratio_this <= 0.95) || ((ratio_prev < 0.95) && (ratio_this > 0.95)))
1026 color = OPING_YELLOW;
1030 wattron (ctx->window, COLOR_PAIR(color));
1033 if (counters[x] == 0)
1034 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x + 2, ' ');
1035 else if (has_utf8 ())
1036 mvwprintw (ctx->window, /* y = */ 3, /* x = */ x + 2,
1037 hist_symbols_utf8[index]);
1039 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x + 2,
1040 hist_symbols_acs[index] | A_ALTCHARSET);
1042 if (has_colors () == TRUE)
1043 wattroff (ctx->window, COLOR_PAIR(color));
1049 } /* }}} int update_graph_histogram */
1051 static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter) /* {{{ */
1053 double latency = -1.0;
1054 size_t buffer_len = sizeof (latency);
1056 ping_iterator_get_info (iter, PING_INFO_LATENCY,
1057 &latency, &buffer_len);
1059 unsigned int sequence = 0;
1060 buffer_len = sizeof (sequence);
1061 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
1062 &sequence, &buffer_len);
1065 if ((ctx == NULL) || (ctx->window == NULL))
1068 /* werase (ctx->window); */
1070 box (ctx->window, 0, 0);
1071 wattron (ctx->window, A_BOLD);
1072 mvwprintw (ctx->window, /* y = */ 0, /* x = */ 5,
1074 wattroff (ctx->window, A_BOLD);
1075 wprintw (ctx->window, "ping statistics ");
1076 mvwprintw (ctx->window, /* y = */ 1, /* x = */ 2,
1077 "%i packets transmitted, %i received, %.2f%% packet "
1078 "loss, time %.1fms",
1079 ctx->req_sent, ctx->req_rcvd,
1080 context_get_packet_loss (ctx),
1081 ctx->latency_total);
1082 if (ctx->req_rcvd != 0)
1088 average = context_get_average (ctx);
1089 deviation = context_get_stddev (ctx);
1090 percentile = context_get_percentile (ctx, opt_percentile);
1092 mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
1093 "rtt min/avg/%.0f%%/max/sdev = "
1094 "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
1103 if (opt_show_graph == 1)
1104 update_graph_prettyping (ctx, latency, sequence);
1105 else if (opt_show_graph == 2)
1106 update_graph_boxplot (ctx);
1107 else if (opt_show_graph == 3)
1108 update_graph_histogram (ctx);
1110 wrefresh (ctx->window);
1113 } /* }}} int update_stats_from_context */
1115 static int on_resize (pingobj_t *ping) /* {{{ */
1117 pingobj_iter_t *iter;
1120 int main_win_height;
1121 int box_height = (opt_show_graph == 0) ? 4 : 5;
1123 getmaxyx (stdscr, height, width);
1124 if ((height < 1) || (width < 1))
1127 main_win_height = height - (box_height * host_num);
1128 wresize (main_win, main_win_height, /* width = */ width);
1129 /* Allow scrolling */
1130 scrollok (main_win, TRUE);
1131 /* wsetscrreg (main_win, 0, main_win_height - 1); */
1132 /* Allow hardware accelerated scrolling. */
1133 idlok (main_win, TRUE);
1134 wrefresh (main_win);
1136 for (iter = ping_iterator_get (ping);
1138 iter = ping_iterator_next (iter))
1140 ping_context_t *context;
1142 context = ping_iterator_get_context (iter);
1143 if (context == NULL)
1146 if (context->window != NULL)
1148 delwin (context->window);
1149 context->window = NULL;
1151 context->window = newwin (/* height = */ box_height,
1152 /* width = */ width,
1153 /* y = */ main_win_height + (box_height * context->index),
1160 static int check_resize (pingobj_t *ping) /* {{{ */
1162 int need_resize = 0;
1166 int key = wgetch (stdscr);
1169 else if (key == KEY_RESIZE)
1174 return (on_resize (ping));
1177 } /* }}} int check_resize */
1179 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
1181 pingobj_iter_t *iter;
1184 int main_win_height;
1185 int box_height = (opt_show_graph == 0) ? 4 : 5;
1190 nodelay (stdscr, TRUE);
1192 getmaxyx (stdscr, height, width);
1193 if ((height < 1) || (width < 1))
1196 if (has_colors () == TRUE)
1199 init_pair (OPING_GREEN, COLOR_GREEN, /* default = */ 0);
1200 init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ 0);
1201 init_pair (OPING_RED, COLOR_RED, /* default = */ 0);
1202 init_pair (OPING_GREEN_HIST, COLOR_GREEN, COLOR_BLACK);
1203 init_pair (OPING_YELLOW_HIST, COLOR_YELLOW, COLOR_GREEN);
1204 init_pair (OPING_RED_HIST, COLOR_RED, COLOR_YELLOW);
1207 main_win_height = height - (box_height * host_num);
1208 main_win = newwin (/* height = */ main_win_height,
1209 /* width = */ width,
1210 /* y = */ 0, /* x = */ 0);
1211 /* Allow scrolling */
1212 scrollok (main_win, TRUE);
1213 /* wsetscrreg (main_win, 0, main_win_height - 1); */
1214 /* Allow hardware accelerated scrolling. */
1215 idlok (main_win, TRUE);
1216 wmove (main_win, /* y = */ main_win_height - 1, /* x = */ 0);
1217 wrefresh (main_win);
1219 for (iter = ping_iterator_get (ping);
1221 iter = ping_iterator_next (iter))
1223 ping_context_t *context;
1225 context = ping_iterator_get_context (iter);
1226 if (context == NULL)
1229 if (context->window != NULL)
1231 delwin (context->window);
1232 context->window = NULL;
1234 context->window = newwin (/* height = */ box_height,
1235 /* width = */ width,
1236 /* y = */ main_win_height + (box_height * context->index),
1241 /* Don't know what good this does exactly, but without this code
1242 * "check_resize" will be called right after startup and *somehow*
1243 * this leads to display errors. If we purge all initial characters
1244 * here, the problem goes away. "wgetch" is non-blocking due to
1245 * "nodelay" (see above). */
1246 while (wgetch (stdscr) != ERR)
1248 /* eat up characters */;
1252 } /* }}} int pre_loop_hook */
1254 static int pre_sleep_hook (pingobj_t *ping) /* {{{ */
1256 return (check_resize (ping));
1257 } /* }}} int pre_sleep_hook */
1259 static int post_sleep_hook (pingobj_t *ping) /* {{{ */
1261 return (check_resize (ping));
1262 } /* }}} int pre_sleep_hook */
1263 #else /* if !USE_NCURSES */
1264 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
1266 pingobj_iter_t *iter;
1268 for (iter = ping_iterator_get (ping);
1270 iter = ping_iterator_next (iter))
1272 ping_context_t *ctx;
1275 ctx = ping_iterator_get_context (iter);
1280 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
1282 printf ("PING %s (%s) %zu bytes of data.\n",
1283 ctx->host, ctx->addr, buffer_size);
1287 } /* }}} int pre_loop_hook */
1289 static int pre_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
1294 } /* }}} int pre_sleep_hook */
1296 static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
1299 } /* }}} int post_sleep_hook */
1302 static size_t latency_to_bucket (ping_context_t *ctx, double latency) /* {{{ */
1306 /* latency is in ms, opt_interval is in s. */
1307 bucket = (size_t) ((latency * (ctx->latency_histogram_size - 1))
1308 / (1000.0 * opt_interval));
1309 if (bucket >= ctx->latency_histogram_size)
1310 bucket = ctx->latency_histogram_size - 1;
1313 } /* }}} size_t latency_to_bucket */
1315 static void update_context (ping_context_t *context, double latency) /* {{{ */
1321 context->req_rcvd++;
1322 context->latency_total += latency;
1323 context->latency_total_square += (latency * latency);
1325 if ((context->latency_max < 0.0) || (context->latency_max < latency))
1326 context->latency_max = latency;
1327 if ((context->latency_min < 0.0) || (context->latency_min > latency))
1328 context->latency_min = latency;
1330 bucket = latency_to_bucket (context, latency);
1331 num = (double) context->req_rcvd;
1333 context->histogram_counters[bucket]++;
1335 context->histogram_accumulated[0] = context->histogram_counters[0];
1336 context->histogram_ratio[0] = ((double) context->histogram_accumulated[0]) / num;
1337 for (i = 1; i < context->latency_histogram_size; i++)
1339 context->histogram_accumulated[i] = context->histogram_accumulated[i - 1]
1340 + context->histogram_counters[i];
1341 context->histogram_ratio[i] = ((double) context->histogram_accumulated[i]) / num;
1343 } /* }}} void update_context */
1345 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
1346 __attribute__((unused)) int index)
1349 unsigned int sequence;
1352 char recv_qos_str[16];
1355 ping_context_t *context;
1358 buffer_len = sizeof (latency);
1359 ping_iterator_get_info (iter, PING_INFO_LATENCY,
1360 &latency, &buffer_len);
1363 buffer_len = sizeof (sequence);
1364 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
1365 &sequence, &buffer_len);
1368 buffer_len = sizeof (recv_ttl);
1369 ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
1370 &recv_ttl, &buffer_len);
1373 buffer_len = sizeof (recv_qos);
1374 ping_iterator_get_info (iter, PING_INFO_RECV_QOS,
1375 &recv_qos, &buffer_len);
1378 ping_iterator_get_info (iter, PING_INFO_DATA,
1381 context = (ping_context_t *) ping_iterator_get_context (iter);
1384 # define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
1386 # define HOST_PRINTF(...) printf(__VA_ARGS__)
1389 context->req_sent++;
1392 update_context (context, latency);
1395 if (has_colors () == TRUE)
1400 int color = OPING_GREEN;
1402 bucket = latency_to_bucket (context, latency);
1403 ratio_this = context->histogram_ratio[bucket];
1405 ratio_prev = context->histogram_ratio[bucket - 1];
1409 if ((ratio_this <= 0.5) ||
1410 ((ratio_prev < 0.5) && (ratio_this > 0.5)))
1411 color = OPING_GREEN;
1412 else if ((ratio_this <= 0.95) ||
1413 ((ratio_prev < 0.95) && (ratio_this > 0.95)))
1414 color = OPING_YELLOW;
1418 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1419 data_len, context->host, context->addr,
1421 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1422 if ((recv_qos != 0) || (opt_send_qos != 0))
1424 HOST_PRINTF ("qos=%s ",
1425 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1427 HOST_PRINTF ("time=");
1428 wattron (main_win, COLOR_PAIR(color));
1429 HOST_PRINTF ("%.2f", latency);
1430 wattroff (main_win, COLOR_PAIR(color));
1431 HOST_PRINTF (" ms\n");
1436 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1438 context->host, context->addr,
1439 sequence, recv_ttl);
1440 if ((recv_qos != 0) || (opt_send_qos != 0))
1442 HOST_PRINTF ("qos=%s ",
1443 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1445 HOST_PRINTF ("time=%.2f ms\n", latency);
1453 if (has_colors () == TRUE)
1455 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u ",
1456 context->host, context->addr,
1458 wattron (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1459 HOST_PRINTF ("timeout");
1460 wattroff (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1466 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
1467 context->host, context->addr,
1475 update_stats_from_context (context, iter);
1476 wrefresh (main_win);
1478 } /* }}} void update_host_hook */
1480 /* Prints statistics for each host, cleans up the contexts and returns the
1481 * number of hosts which failed to return more than the fraction
1482 * opt_exit_status_threshold of pings. */
1483 static int post_loop_hook (pingobj_t *ping) /* {{{ */
1485 pingobj_iter_t *iter;
1486 int failure_count = 0;
1492 for (iter = ping_iterator_get (ping);
1494 iter = ping_iterator_next (iter))
1496 ping_context_t *context;
1498 context = ping_iterator_get_context (iter);
1500 printf ("\n--- %s ping statistics ---\n"
1501 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
1502 context->host, context->req_sent, context->req_rcvd,
1503 context_get_packet_loss (context),
1504 context->latency_total);
1507 double pct_failed = 1.0 - (((double) context->req_rcvd)
1508 / ((double) context->req_sent));
1509 if (pct_failed > opt_exit_status_threshold)
1513 if (context->req_rcvd != 0)
1519 average = context_get_average (context);
1520 deviation = context_get_stddev (context);
1521 percentile = context_get_percentile (context, opt_percentile);
1523 printf ("rtt min/avg/%.0f%%/max/sdev = "
1524 "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
1526 context->latency_min,
1529 context->latency_max,
1533 ping_iterator_set_context (iter, NULL);
1534 context_destroy (context);
1537 return (failure_count);
1538 } /* }}} int post_loop_hook */
1540 int main (int argc, char **argv) /* {{{ */
1543 pingobj_iter_t *iter;
1545 struct sigaction sigint_action;
1547 struct timeval tv_begin;
1548 struct timeval tv_end;
1549 struct timespec ts_wait;
1550 struct timespec ts_int;
1555 #if _POSIX_SAVED_IDS
1556 uid_t saved_set_uid;
1558 /* Save the old effective user id */
1559 saved_set_uid = geteuid ();
1560 /* Set the effective user ID to the real user ID without changing the
1561 * saved set-user ID */
1562 status = seteuid (getuid ());
1565 fprintf (stderr, "Temporarily dropping privileges "
1566 "failed: %s\n", strerror (errno));
1567 exit (EXIT_FAILURE);
1571 setlocale(LC_ALL, "");
1572 optind = read_options (argc, argv);
1574 #if !_POSIX_SAVED_IDS
1575 /* Cannot temporarily drop privileges -> reject every file but "-". */
1576 if ((opt_filename != NULL)
1577 && (strcmp ("-", opt_filename) != 0)
1578 && (getuid () != geteuid ()))
1580 fprintf (stderr, "Your real and effective user IDs don't "
1581 "match. Reading from a file (option '-f')\n"
1582 "is therefore too risky. You can still read "
1583 "from STDIN using '-f -' if you like.\n"
1585 exit (EXIT_FAILURE);
1589 if ((optind >= argc) && (opt_filename == NULL)) {
1590 usage_exit (argv[0], 1);
1593 if ((ping = ping_construct ()) == NULL)
1595 fprintf (stderr, "ping_construct failed\n");
1599 if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
1601 fprintf (stderr, "Setting TTL to %i failed: %s\n",
1602 opt_send_ttl, ping_get_error (ping));
1605 if (ping_setopt (ping, PING_OPT_QOS, &opt_send_qos) != 0)
1607 fprintf (stderr, "Setting TOS to %i failed: %s\n",
1608 opt_send_qos, ping_get_error (ping));
1615 temp_nsec = modf (opt_interval, &temp_sec);
1616 ts_int.tv_sec = (time_t) temp_sec;
1617 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
1619 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
1622 if (opt_addrfamily != PING_DEF_AF)
1623 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
1625 if (opt_srcaddr != NULL)
1627 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
1629 fprintf (stderr, "Setting source address failed: %s\n",
1630 ping_get_error (ping));
1634 if (opt_device != NULL)
1636 if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
1638 fprintf (stderr, "Setting device failed: %s\n",
1639 ping_get_error (ping));
1643 if (opt_filename != NULL)
1649 if (strcmp (opt_filename, "-") == 0)
1651 infile = fdopen(0, "r");
1653 infile = fopen(opt_filename, "r");
1657 fprintf (stderr, "Opening %s failed: %s\n",
1658 (strcmp (opt_filename, "-") == 0)
1659 ? "STDIN" : opt_filename,
1664 #if _POSIX_SAVED_IDS
1665 /* Regain privileges */
1666 status = seteuid (saved_set_uid);
1669 fprintf (stderr, "Temporarily re-gaining privileges "
1670 "failed: %s\n", strerror (errno));
1671 exit (EXIT_FAILURE);
1675 while (fgets(line, sizeof(line), infile))
1677 /* Strip whitespace */
1678 if (sscanf(line, "%s", host) != 1)
1681 if ((host[0] == 0) || (host[0] == '#'))
1684 if (ping_host_add(ping, host) < 0)
1686 const char *errmsg = ping_get_error (ping);
1688 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
1697 #if _POSIX_SAVED_IDS
1698 /* Drop privileges */
1699 status = seteuid (getuid ());
1702 fprintf (stderr, "Temporarily dropping privileges "
1703 "failed: %s\n", strerror (errno));
1704 exit (EXIT_FAILURE);
1711 #if _POSIX_SAVED_IDS
1712 /* Regain privileges */
1713 status = seteuid (saved_set_uid);
1716 fprintf (stderr, "Temporarily re-gaining privileges "
1717 "failed: %s\n", strerror (errno));
1718 exit (EXIT_FAILURE);
1722 for (i = optind; i < argc; i++)
1724 if (ping_host_add (ping, argv[i]) < 0)
1726 const char *errmsg = ping_get_error (ping);
1728 fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
1737 /* Permanently drop root privileges if we're setuid-root. */
1738 status = setuid (getuid ());
1741 fprintf (stderr, "Dropping privileges failed: %s\n",
1743 exit (EXIT_FAILURE);
1746 #if _POSIX_SAVED_IDS
1747 saved_set_uid = (uid_t) -1;
1750 ping_initialize_contexts (ping);
1755 memset (&sigint_action, '\0', sizeof (sigint_action));
1756 sigint_action.sa_handler = sigint_handler;
1757 if (sigaction (SIGINT, &sigint_action, NULL) < 0)
1759 perror ("sigaction");
1763 pre_loop_hook (ping);
1765 while (opt_count != 0)
1770 if (gettimeofday (&tv_begin, NULL) < 0)
1772 perror ("gettimeofday");
1776 status = ping_send (ping);
1777 if (status == -EINTR)
1781 else if (status < 0)
1783 fprintf (stderr, "ping_send failed: %s\n",
1784 ping_get_error (ping));
1789 for (iter = ping_iterator_get (ping);
1791 iter = ping_iterator_next (iter))
1793 update_host_hook (iter, index);
1797 pre_sleep_hook (ping);
1799 /* Don't sleep in the last iteration */
1803 if (gettimeofday (&tv_end, NULL) < 0)
1805 perror ("gettimeofday");
1809 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
1811 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
1812 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
1820 perror ("nanosleep");
1825 post_sleep_hook (ping);
1829 } /* while (opt_count != 0) */
1831 /* Returns the number of failed hosts according to -Z. */
1832 status = post_loop_hook (ping);
1834 ping_destroy (ping);
1837 exit (EXIT_SUCCESS);
1844 } /* }}} int main */
1846 /* vim: set fdm=marker : */