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 double const threshold_green = 0.8;
99 double const threshold_yellow = 0.95;
101 static char const * const hist_symbols_utf8[] = {
102 "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" };
103 static size_t const hist_symbols_utf8_num = sizeof (hist_symbols_utf8)
104 / sizeof (hist_symbols_utf8[0]);
106 /* scancodes for 6 levels of horizontal bars, ncurses-specific */
107 /* those are not the usual constants because those are not constant */
108 static int const hist_symbols_acs[] = {
109 115, /* ACS_S9 "⎽" */
110 114, /* ACS_S7 "⎼" */
111 113, /* ACS_S5 "─" */
112 112, /* ACS_S3 "⎻" */
115 static size_t const hist_symbols_acs_num = sizeof (hist_symbols_acs)
116 / sizeof (hist_symbols_acs[0]);
118 /* use different colors without a background for scancodes */
119 static int const hist_colors_utf8[] = {
120 OPING_GREEN_HIST, OPING_YELLOW_HIST, OPING_RED_HIST };
121 static int const hist_colors_acs[] = {
122 OPING_GREEN, OPING_YELLOW, OPING_RED };
123 /* assuming that both arrays are the same size */
124 static size_t const hist_colors_num = sizeof (hist_colors_utf8)
125 / sizeof (hist_colors_utf8[0]);
129 #define BOXPLOT_WHISKER_BAR (113 | A_ALTCHARSET)
131 #define BOXPLOT_WHISKER_LEFT_END (116 | A_ALTCHARSET)
133 #define BOXPLOT_WHISKER_RIGHT_END (117 | A_ALTCHARSET)
135 #define BOXPLOT_BOX ' '
137 #define BOXPLOT_MEDIAN (120 | A_ALTCHARSET)
141 #ifndef _POSIX_SAVED_IDS
142 # define _POSIX_SAVED_IDS 0
145 #ifndef IPTOS_MINCOST
146 # define IPTOS_MINCOST 0x02
149 /* Remove GNU specific __attribute__ settings when using another compiler */
151 # define __attribute__(x) /**/
154 typedef struct ping_context
156 char host[NI_MAXHOST];
157 char addr[NI_MAXHOST];
165 double latency_total;
166 double latency_total_square;
168 /* 1000 + one "infinity" bucket. */
169 #define OPING_HISTOGRAM_BUCKETS 1001
170 uint32_t *histogram_counters;
171 uint32_t *histogram_accumulated;
172 double *histogram_ratio;
173 size_t latency_histogram_size;
180 static double opt_interval = 1.0;
181 static int opt_addrfamily = PING_DEF_AF;
182 static char *opt_srcaddr = NULL;
183 static char *opt_device = NULL;
184 static char *opt_filename = NULL;
185 static int opt_count = -1;
186 static int opt_send_ttl = 64;
187 static uint8_t opt_send_qos = 0;
188 #define OPING_DEFAULT_PERCENTILE 95.0
189 static double opt_percentile = -1.0;
190 static double opt_exit_status_threshold = 1.0;
192 static int opt_show_graph = 1;
193 static int opt_utf8 = 0;
196 static int host_num = 0;
199 static WINDOW *main_win = NULL;
202 static void sigint_handler (int signal) /* {{{ */
204 /* Make compiler happy */
208 } /* }}} void sigint_handler */
210 static ping_context_t *context_create (void) /* {{{ */
214 if ((ret = malloc (sizeof (ping_context_t))) == NULL)
217 memset (ret, '\0', sizeof (ping_context_t));
219 ret->latency_min = -1.0;
220 ret->latency_max = -1.0;
221 ret->latency_total = 0.0;
222 ret->latency_total_square = 0.0;
224 ret->latency_histogram_size = (size_t) OPING_HISTOGRAM_BUCKETS;
225 ret->histogram_counters = calloc (ret->latency_histogram_size,
226 sizeof (*ret->histogram_counters));
227 ret->histogram_accumulated = calloc (ret->latency_histogram_size,
228 sizeof (*ret->histogram_accumulated));
229 ret->histogram_ratio = calloc (ret->latency_histogram_size,
230 sizeof (*ret->histogram_ratio));
237 } /* }}} ping_context_t *context_create */
239 static void context_destroy (ping_context_t *context) /* {{{ */
245 if (context->window != NULL)
247 delwin (context->window);
248 context->window = NULL;
252 free (context->histogram_counters);
253 context->histogram_counters = NULL;
255 free (context->histogram_accumulated);
256 context->histogram_accumulated = NULL;
258 free (context->histogram_ratio);
259 context->histogram_ratio = NULL;
262 } /* }}} void context_destroy */
264 static double context_get_average (ping_context_t *ctx) /* {{{ */
271 if (ctx->req_rcvd < 1)
274 num_total = (double) ctx->req_rcvd;
275 return (ctx->latency_total / num_total);
276 } /* }}} double context_get_average */
278 static double context_get_percentile (ping_context_t *ctx, /* {{{ */
281 double threshold = percentile / 100.0;
282 double index_to_ms_factor;
286 if (ctx->histogram_ratio == NULL)
289 for (i = 0; i < ctx->latency_histogram_size; i++)
290 if (ctx->histogram_ratio[i] >= threshold)
293 if (i >= ctx->latency_histogram_size)
295 else if (i == (ctx->latency_histogram_size - 1))
298 index_to_ms_factor = (1000.0 * opt_interval) / (ctx->latency_histogram_size - 1);
300 /* Multiply with i+1, because we're interested in the _upper_ bound of
302 ret = (index_to_ms_factor * ((double) (i + 1)));
304 /* Avoid reporting a higher latency than latency_max. */
305 if (ret > ctx->latency_max)
306 ret = ctx->latency_max;
309 } /* }}} double context_get_percentile */
311 static double context_get_stddev (ping_context_t *ctx) /* {{{ */
318 if (ctx->req_rcvd < 1)
320 else if (ctx->req_rcvd < 2)
323 num_total = (double) ctx->req_rcvd;
324 return (sqrt (((num_total * ctx->latency_total_square)
325 - (ctx->latency_total * ctx->latency_total))
326 / (num_total * (num_total - 1.0))));
327 } /* }}} double context_get_stddev */
329 static double context_get_packet_loss (const ping_context_t *ctx) /* {{{ */
334 if (ctx->req_sent < 1)
337 return (100.0 * (ctx->req_sent - ctx->req_rcvd)
338 / ((double) ctx->req_sent));
339 } /* }}} double context_get_packet_loss */
341 static int ping_initialize_contexts (pingobj_t *ping) /* {{{ */
343 pingobj_iter_t *iter;
350 for (iter = ping_iterator_get (ping);
352 iter = ping_iterator_next (iter))
354 ping_context_t *context;
357 context = context_create ();
358 context->index = index;
360 buffer_size = sizeof (context->host);
361 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
363 buffer_size = sizeof (context->addr);
364 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
366 ping_iterator_set_context (iter, (void *) context);
372 } /* }}} int ping_initialize_contexts */
374 static void usage_exit (const char *name, int status) /* {{{ */
376 fprintf (stderr, "Usage: %s [OPTIONS] "
377 "-f filename | host [host [host ...]]\n"
379 "\nAvailable options:\n"
380 " -4|-6 force the use of IPv4 or IPv6\n"
381 " -c count number of ICMP packets to send\n"
382 " -i interval interval with which to send ICMP packets\n"
383 " -t ttl time to live for each ICMP packet\n"
384 " -Q qos Quality of Service (QoS) of outgoing packets\n"
385 " Use \"-Q help\" for a list of valid options.\n"
386 " -I srcaddr source address\n"
387 " -D device outgoing interface name\n"
388 " -f filename filename to read hosts from\n"
390 " -u / -U force / disable UTF-8 output\n"
391 " -g graph graph type to draw\n"
393 " -P percent Report the n'th percentile of latency\n"
394 " -Z percent Exit with non-zero exit status if more than this percentage of\n"
395 " probes timed out. (default: never)\n"
397 "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
398 "by Florian octo Forster <octo@verplant.org>\n"
399 "for contributions see `AUTHORS'\n",
402 } /* }}} void usage_exit */
404 __attribute__((noreturn))
405 static void usage_qos_exit (const char *arg, int status) /* {{{ */
408 fprintf (stderr, "Invalid QoS argument: \"%s\"\n\n", arg);
410 fprintf (stderr, "Valid QoS arguments (option \"-Q\") are:\n"
412 " Differentiated Services (IPv4 and IPv6, RFC 2474)\n"
414 " be Best Effort (BE, default PHB).\n"
415 " ef Expedited Forwarding (EF) PHB group (RFC 3246).\n"
416 " (low delay, low loss, low jitter)\n"
417 " va Voice Admit (VA) DSCP (RFC 5865).\n"
418 " (capacity-admitted traffic)\n"
419 " af[1-4][1-3] Assured Forwarding (AF) PHB group (RFC 2597).\n"
420 " For example: \"af12\" (class 1, precedence 2)\n"
421 " cs[0-7] Class Selector (CS) PHB group (RFC 2474).\n"
422 " For example: \"cs1\" (priority traffic)\n"
424 " Type of Service (IPv4, RFC 1349, obsolete)\n"
426 " lowdelay (%#04x) minimize delay\n"
427 " throughput (%#04x) maximize throughput\n"
428 " reliability (%#04x) maximize reliability\n"
429 " mincost (%#04x) minimize monetary cost\n"
431 " Specify manually\n"
433 " 0x00 - 0xff Hexadecimal numeric specification.\n"
434 " 0 - 255 Decimal numeric specification.\n"
436 (unsigned int) IPTOS_LOWDELAY,
437 (unsigned int) IPTOS_THROUGHPUT,
438 (unsigned int) IPTOS_RELIABILITY,
439 (unsigned int) IPTOS_MINCOST);
442 } /* }}} void usage_qos_exit */
444 static int set_opt_send_qos (const char *opt) /* {{{ */
449 if (strcasecmp ("help", opt) == 0)
450 usage_qos_exit (/* arg = */ NULL, /* status = */ EXIT_SUCCESS);
451 /* DiffServ (RFC 2474): */
452 /* - Best effort (BE) */
453 else if (strcasecmp ("be", opt) == 0)
455 /* - Expedited Forwarding (EF, RFC 3246) */
456 else if (strcasecmp ("ef", opt) == 0)
457 opt_send_qos = 0xB8; /* == 0x2E << 2 */
458 /* - Voice Admit (VA, RFC 5865) */
459 else if (strcasecmp ("va", opt) == 0)
460 opt_send_qos = 0xB0; /* == 0x2D << 2 */
461 /* - Assured Forwarding (AF, RFC 2597) */
462 else if ((strncasecmp ("af", opt, strlen ("af")) == 0)
463 && (strlen (opt) == 4))
469 /* There are four classes, AF1x, AF2x, AF3x, and AF4x. */
472 else if (opt[2] == '2')
474 else if (opt[2] == '3')
476 else if (opt[2] == '4')
479 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
481 /* In each class, there are three precedences, AFx1, AFx2, and AFx3 */
484 else if (opt[3] == '2')
486 else if (opt[3] == '3')
489 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
491 dscp = (8 * class) + (2 * prec);
492 /* The lower two bits are used for Explicit Congestion Notification (ECN) */
493 opt_send_qos = dscp << 2;
495 /* - Class Selector (CS) */
496 else if ((strncasecmp ("cs", opt, strlen ("cs")) == 0)
497 && (strlen (opt) == 3))
501 if ((opt[2] < '0') || (opt[2] > '7'))
502 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
504 /* Not exactly legal by the C standard, but I don't know of any
505 * system not supporting this hack. */
506 class = ((uint8_t) opt[2]) - ((uint8_t) '0');
507 opt_send_qos = class << 5;
509 /* Type of Service (RFC 1349) */
510 else if (strcasecmp ("lowdelay", opt) == 0)
511 opt_send_qos = IPTOS_LOWDELAY;
512 else if (strcasecmp ("throughput", opt) == 0)
513 opt_send_qos = IPTOS_THROUGHPUT;
514 else if (strcasecmp ("reliability", opt) == 0)
515 opt_send_qos = IPTOS_RELIABILITY;
516 else if (strcasecmp ("mincost", opt) == 0)
517 opt_send_qos = IPTOS_MINCOST;
526 value = strtoul (opt, &endptr, /* base = */ 0);
527 if ((errno != 0) || (endptr == opt)
528 || (endptr == NULL) || (*endptr != 0)
530 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
532 opt_send_qos = (uint8_t) value;
536 } /* }}} int set_opt_send_qos */
538 static char *format_qos (uint8_t qos, char *buffer, size_t buffer_size) /* {{{ */
550 case 0x00: dscp_str = "be"; break;
551 case 0x2e: dscp_str = "ef"; break;
552 case 0x2d: dscp_str = "va"; break;
553 case 0x0a: dscp_str = "af11"; break;
554 case 0x0c: dscp_str = "af12"; break;
555 case 0x0e: dscp_str = "af13"; break;
556 case 0x12: dscp_str = "af21"; break;
557 case 0x14: dscp_str = "af22"; break;
558 case 0x16: dscp_str = "af23"; break;
559 case 0x1a: dscp_str = "af31"; break;
560 case 0x1c: dscp_str = "af32"; break;
561 case 0x1e: dscp_str = "af33"; break;
562 case 0x22: dscp_str = "af41"; break;
563 case 0x24: dscp_str = "af42"; break;
564 case 0x26: dscp_str = "af43"; break;
565 case 0x08: dscp_str = "cs1"; break;
566 case 0x10: dscp_str = "cs2"; break;
567 case 0x18: dscp_str = "cs3"; break;
568 case 0x20: dscp_str = "cs4"; break;
569 case 0x28: dscp_str = "cs5"; break;
570 case 0x30: dscp_str = "cs6"; break;
571 case 0x38: dscp_str = "cs7"; break;
572 default: dscp_str = NULL;
577 case 0x01: ecn_str = ",ecn(1)"; break;
578 case 0x02: ecn_str = ",ecn(0)"; break;
579 case 0x03: ecn_str = ",ce"; break;
580 default: ecn_str = "";
583 if (dscp_str == NULL)
584 snprintf (buffer, buffer_size, "0x%02x%s", dscp, ecn_str);
586 snprintf (buffer, buffer_size, "%s%s", dscp_str, ecn_str);
587 buffer[buffer_size - 1] = 0;
590 } /* }}} char *format_qos */
592 static int read_options (int argc, char **argv) /* {{{ */
598 optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:P:"
611 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
617 new_count = atoi (optarg);
620 opt_count = new_count;
622 if ((opt_percentile < 0.0) && (opt_count < 20))
623 opt_percentile = 100.0 * (opt_count - 1) / opt_count;
626 fprintf(stderr, "Ignoring invalid count: %s\n",
633 if (opt_filename != NULL)
635 opt_filename = strdup (optarg);
642 new_interval = atof (optarg);
643 if (new_interval < 0.001)
644 fprintf (stderr, "Ignoring invalid interval: %s\n",
647 opt_interval = new_interval;
653 if (opt_srcaddr != NULL)
655 opt_srcaddr = strdup (optarg);
666 new_send_ttl = atoi (optarg);
667 if ((new_send_ttl > 0) && (new_send_ttl < 256))
668 opt_send_ttl = new_send_ttl;
670 fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
676 set_opt_send_qos (optarg);
681 double new_percentile;
682 new_percentile = atof (optarg);
683 if (isnan (new_percentile)
684 || (new_percentile < 0.1)
685 || (new_percentile > 100.0))
686 fprintf (stderr, "Ignoring invalid percentile: %s\n",
689 opt_percentile = new_percentile;
695 if (strcasecmp ("none", optarg) == 0)
697 else if (strcasecmp ("prettyping", optarg) == 0)
699 else if (strcasecmp ("boxplot", optarg) == 0)
701 else if (strcasecmp ("histogram", optarg) == 0)
704 fprintf (stderr, "Unknown graph option: %s\n", optarg);
721 tmp = strtod (optarg, &endptr);
722 if ((errno != 0) || (endptr == NULL) || (*endptr != 0) || (tmp < 0.0) || (tmp > 100.0))
724 fprintf (stderr, "Ignoring invalid -Z argument: %s\n", optarg);
725 fprintf (stderr, "The \"-Z\" option requires a numeric argument between 0 and 100.\n");
728 opt_exit_status_threshold = tmp / 100.0;
734 usage_exit (argv[0], 0);
738 usage_exit (argv[0], 1);
742 if (opt_percentile <= 0.0)
743 opt_percentile = OPING_DEFAULT_PERCENTILE;
746 } /* }}} read_options */
748 static void time_normalize (struct timespec *ts) /* {{{ */
750 while (ts->tv_nsec < 0)
759 ts->tv_nsec += 1000000000;
762 while (ts->tv_nsec >= 1000000000)
765 ts->tv_nsec -= 1000000000;
767 } /* }}} void time_normalize */
769 static void time_calc (struct timespec *ts_dest, /* {{{ */
770 const struct timespec *ts_int,
771 const struct timeval *tv_begin,
772 const struct timeval *tv_end)
774 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
775 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
776 time_normalize (ts_dest);
778 /* Assure that `(begin + interval) > end'.
779 * This may seem overly complicated, but `tv_sec' is of type `time_t'
780 * which may be `unsigned. *sigh* */
781 if ((tv_end->tv_sec > ts_dest->tv_sec)
782 || ((tv_end->tv_sec == ts_dest->tv_sec)
783 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
786 ts_dest->tv_nsec = 0;
790 ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
791 ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
792 time_normalize (ts_dest);
793 } /* }}} void time_calc */
796 static _Bool has_utf8() /* {{{ */
798 # if HAVE_NCURSESW_NCURSES_H
801 /* Automatically determine */
802 if (strcasecmp ("UTF-8", nl_langinfo (CODESET)) == 0)
807 return ((_Bool) (opt_utf8 - 1));
811 } /* }}} _Bool has_utf8 */
813 static int update_graph_boxplot (ping_context_t *ctx) /* {{{ */
820 x_max = (size_t) getmaxx (ctx->window);
825 ratios = calloc (x_max, sizeof (*ratios));
828 for (i = 0; i < ctx->latency_histogram_size; i++)
830 x = i * x_max / ctx->latency_histogram_size;
831 ratios[x] = ctx->histogram_ratio[i];
834 for (x = 0; x < x_max; x++)
841 if (ratios[x] >= 0.5)
843 symbol = BOXPLOT_MEDIAN;
846 else if (ratios[x] > 0.25)
848 symbol = BOXPLOT_BOX;
851 else if (ratios[x] > 0.025)
852 symbol = BOXPLOT_WHISKER_BAR;
854 symbol = ' '; /* NOP */
858 if ((ratios[x - 1] < 0.5) && (ratios[x] >= 0.5))
860 symbol = BOXPLOT_MEDIAN;
863 else if (((ratios[x] >= 0.25) && (ratios[x] <= 0.75))
864 || ((ratios[x - 1] < 0.75) && (ratios[x] > 0.75)))
866 symbol = BOXPLOT_BOX;
869 else if ((ratios[x] < 0.5) && (ratios[x] >= 0.025))
871 if (ratios[x - 1] < 0.025)
872 symbol = BOXPLOT_WHISKER_LEFT_END;
874 symbol = BOXPLOT_WHISKER_BAR;
876 else if ((ratios[x] > .5) && (ratios[x] < 0.975))
878 symbol = BOXPLOT_WHISKER_BAR;
880 else if ((ratios[x] >= 0.975) && (ratios[x - 1] < 0.975))
881 symbol = BOXPLOT_WHISKER_RIGHT_END;
885 wattron (ctx->window, A_REVERSE);
886 mvwaddch (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
887 // mvwprintw (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
889 wattroff (ctx->window, A_REVERSE);
894 } /* }}} int update_graph_boxplot */
896 static int update_graph_prettyping (ping_context_t *ctx, /* {{{ */
897 double latency, unsigned int sequence)
899 int color = OPING_RED;
900 char const *symbol = "!";
906 x_max = getmaxx (ctx->window);
907 x_pos = ((sequence - 1) % (x_max - 4)) + 2;
913 size_t symbols_num = hist_symbols_acs_num;
914 size_t colors_num = 1;
916 size_t index_symbols;
920 /* latency is in milliseconds, opt_interval is in seconds. */
921 ratio = (latency * 0.001) / opt_interval;
927 symbols_num = hist_symbols_utf8_num;
929 if (has_colors () == TRUE)
930 colors_num = hist_colors_num;
932 intensity = (size_t) (ratio * ((double) (symbols_num * colors_num)));
933 if (intensity >= (symbols_num * colors_num))
934 intensity = (symbols_num * colors_num) - 1;
936 index_symbols = intensity % symbols_num;
937 assert (index_symbols < symbols_num);
939 index_colors = intensity / symbols_num;
940 assert (index_colors < colors_num);
944 color = hist_colors_utf8[index_colors];
945 symbol = hist_symbols_utf8[index_symbols];
949 color = hist_colors_acs[index_colors];
950 symbolc = hist_symbols_acs[index_symbols] | A_ALTCHARSET;
953 else /* if (!(latency >= 0.0)) */
954 wattron (ctx->window, A_BOLD);
956 if (has_colors () == TRUE)
957 wattron (ctx->window, COLOR_PAIR(color));
960 mvwprintw (ctx->window, /* y = */ 3, /* x = */ x_pos, symbol);
962 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x_pos, symbolc);
964 if (has_colors () == TRUE)
965 wattroff (ctx->window, COLOR_PAIR(color));
967 /* Use negation here to handle NaN correctly. */
968 if (!(latency >= 0.0))
969 wattroff (ctx->window, A_BOLD);
971 wprintw (ctx->window, " ");
973 } /* }}} int update_graph_prettyping */
975 static int update_graph_histogram (ping_context_t *ctx) /* {{{ */
978 uint32_t *accumulated;
985 size_t symbols_num = hist_symbols_acs_num;
988 symbols_num = hist_symbols_utf8_num;
990 x_max = (size_t) getmaxx (ctx->window);
995 counters = calloc (x_max, sizeof (*counters));
996 accumulated = calloc (x_max, sizeof (*accumulated));
1000 for (i = 0; i < ctx->latency_histogram_size; i++)
1002 x = i * x_max / ctx->latency_histogram_size;
1003 counters[x] += ctx->histogram_counters[i];
1004 accumulated[x] = counters[x];
1006 if (max < counters[x])
1011 for (x = 1; x < x_max; x++)
1012 accumulated[x] += accumulated[x - 1];
1013 num = accumulated[x_max - 1];
1015 /* Calculate ratios */
1016 for (x = 0; x < x_max; x++)
1018 double height = ((double) counters[x]) / ((double) max);
1019 double ratio_this = ((double) accumulated[x]) / ((double) num);
1020 double ratio_prev = 0.0;
1024 index = (size_t) (height * ((double) symbols_num));
1025 if (index >= symbols_num)
1026 index = symbols_num - 1;
1029 ratio_prev = ((double) accumulated[x - 1]) / ((double) num);
1031 if (has_colors () == TRUE)
1033 if ((ratio_this <= threshold_green)
1034 || ((ratio_prev < threshold_green)
1035 && (ratio_this > threshold_green)))
1036 color = OPING_GREEN;
1037 else if ((ratio_this <= threshold_yellow)
1038 || ((ratio_prev < threshold_yellow)
1039 && (ratio_this > threshold_yellow)))
1040 color = OPING_YELLOW;
1044 wattron (ctx->window, COLOR_PAIR(color));
1047 if (counters[x] == 0)
1048 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x + 2, ' ');
1049 else if (has_utf8 ())
1050 mvwprintw (ctx->window, /* y = */ 3, /* x = */ x + 2,
1051 hist_symbols_utf8[index]);
1053 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x + 2,
1054 hist_symbols_acs[index] | A_ALTCHARSET);
1056 if (has_colors () == TRUE)
1057 wattroff (ctx->window, COLOR_PAIR(color));
1063 } /* }}} int update_graph_histogram */
1065 static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter) /* {{{ */
1067 double latency = -1.0;
1068 size_t buffer_len = sizeof (latency);
1070 ping_iterator_get_info (iter, PING_INFO_LATENCY,
1071 &latency, &buffer_len);
1073 unsigned int sequence = 0;
1074 buffer_len = sizeof (sequence);
1075 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
1076 &sequence, &buffer_len);
1079 if ((ctx == NULL) || (ctx->window == NULL))
1082 /* werase (ctx->window); */
1084 box (ctx->window, 0, 0);
1085 wattron (ctx->window, A_BOLD);
1086 mvwprintw (ctx->window, /* y = */ 0, /* x = */ 5,
1088 wattroff (ctx->window, A_BOLD);
1089 wprintw (ctx->window, "ping statistics ");
1090 mvwprintw (ctx->window, /* y = */ 1, /* x = */ 2,
1091 "%i packets transmitted, %i received, %.2f%% packet "
1092 "loss, time %.1fms",
1093 ctx->req_sent, ctx->req_rcvd,
1094 context_get_packet_loss (ctx),
1095 ctx->latency_total);
1096 if (ctx->req_rcvd != 0)
1102 average = context_get_average (ctx);
1103 deviation = context_get_stddev (ctx);
1104 percentile = context_get_percentile (ctx, opt_percentile);
1106 mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
1107 "rtt min/avg/%.0f%%/max/sdev = "
1108 "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
1117 if (opt_show_graph == 1)
1118 update_graph_prettyping (ctx, latency, sequence);
1119 else if (opt_show_graph == 2)
1120 update_graph_boxplot (ctx);
1121 else if (opt_show_graph == 3)
1122 update_graph_histogram (ctx);
1124 wrefresh (ctx->window);
1127 } /* }}} int update_stats_from_context */
1129 static int on_resize (pingobj_t *ping) /* {{{ */
1131 pingobj_iter_t *iter;
1134 int main_win_height;
1135 int box_height = (opt_show_graph == 0) ? 4 : 5;
1137 getmaxyx (stdscr, height, width);
1138 if ((height < 1) || (width < 1))
1141 main_win_height = height - (box_height * host_num);
1142 wresize (main_win, main_win_height, /* width = */ width);
1143 /* Allow scrolling */
1144 scrollok (main_win, TRUE);
1145 /* wsetscrreg (main_win, 0, main_win_height - 1); */
1146 /* Allow hardware accelerated scrolling. */
1147 idlok (main_win, TRUE);
1148 wrefresh (main_win);
1150 for (iter = ping_iterator_get (ping);
1152 iter = ping_iterator_next (iter))
1154 ping_context_t *context;
1156 context = ping_iterator_get_context (iter);
1157 if (context == NULL)
1160 if (context->window != NULL)
1162 delwin (context->window);
1163 context->window = NULL;
1165 context->window = newwin (/* height = */ box_height,
1166 /* width = */ width,
1167 /* y = */ main_win_height + (box_height * context->index),
1174 static int check_resize (pingobj_t *ping) /* {{{ */
1176 int need_resize = 0;
1180 int key = wgetch (stdscr);
1183 else if (key == KEY_RESIZE)
1188 return (on_resize (ping));
1191 } /* }}} int check_resize */
1193 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
1195 pingobj_iter_t *iter;
1198 int main_win_height;
1199 int box_height = (opt_show_graph == 0) ? 4 : 5;
1204 nodelay (stdscr, TRUE);
1206 getmaxyx (stdscr, height, width);
1207 if ((height < 1) || (width < 1))
1210 if (has_colors () == TRUE)
1213 init_pair (OPING_GREEN, COLOR_GREEN, /* default = */ 0);
1214 init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ 0);
1215 init_pair (OPING_RED, COLOR_RED, /* default = */ 0);
1216 init_pair (OPING_GREEN_HIST, COLOR_GREEN, COLOR_BLACK);
1217 init_pair (OPING_YELLOW_HIST, COLOR_YELLOW, COLOR_GREEN);
1218 init_pair (OPING_RED_HIST, COLOR_RED, COLOR_YELLOW);
1221 main_win_height = height - (box_height * host_num);
1222 main_win = newwin (/* height = */ main_win_height,
1223 /* width = */ width,
1224 /* y = */ 0, /* x = */ 0);
1225 /* Allow scrolling */
1226 scrollok (main_win, TRUE);
1227 /* wsetscrreg (main_win, 0, main_win_height - 1); */
1228 /* Allow hardware accelerated scrolling. */
1229 idlok (main_win, TRUE);
1230 wmove (main_win, /* y = */ main_win_height - 1, /* x = */ 0);
1231 wrefresh (main_win);
1233 for (iter = ping_iterator_get (ping);
1235 iter = ping_iterator_next (iter))
1237 ping_context_t *context;
1239 context = ping_iterator_get_context (iter);
1240 if (context == NULL)
1243 if (context->window != NULL)
1245 delwin (context->window);
1246 context->window = NULL;
1248 context->window = newwin (/* height = */ box_height,
1249 /* width = */ width,
1250 /* y = */ main_win_height + (box_height * context->index),
1255 /* Don't know what good this does exactly, but without this code
1256 * "check_resize" will be called right after startup and *somehow*
1257 * this leads to display errors. If we purge all initial characters
1258 * here, the problem goes away. "wgetch" is non-blocking due to
1259 * "nodelay" (see above). */
1260 while (wgetch (stdscr) != ERR)
1262 /* eat up characters */;
1266 } /* }}} int pre_loop_hook */
1268 static int pre_sleep_hook (pingobj_t *ping) /* {{{ */
1270 return (check_resize (ping));
1271 } /* }}} int pre_sleep_hook */
1273 static int post_sleep_hook (pingobj_t *ping) /* {{{ */
1275 return (check_resize (ping));
1276 } /* }}} int pre_sleep_hook */
1277 #else /* if !USE_NCURSES */
1278 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
1280 pingobj_iter_t *iter;
1282 for (iter = ping_iterator_get (ping);
1284 iter = ping_iterator_next (iter))
1286 ping_context_t *ctx;
1289 ctx = ping_iterator_get_context (iter);
1294 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
1296 printf ("PING %s (%s) %zu bytes of data.\n",
1297 ctx->host, ctx->addr, buffer_size);
1301 } /* }}} int pre_loop_hook */
1303 static int pre_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
1308 } /* }}} int pre_sleep_hook */
1310 static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
1313 } /* }}} int post_sleep_hook */
1316 static size_t latency_to_bucket (ping_context_t *ctx, double latency) /* {{{ */
1320 /* latency is in ms, opt_interval is in s. */
1321 bucket = (size_t) ((latency * (ctx->latency_histogram_size - 1))
1322 / (1000.0 * opt_interval));
1323 if (bucket >= ctx->latency_histogram_size)
1324 bucket = ctx->latency_histogram_size - 1;
1327 } /* }}} size_t latency_to_bucket */
1329 static void update_context (ping_context_t *context, double latency) /* {{{ */
1335 context->req_rcvd++;
1336 context->latency_total += latency;
1337 context->latency_total_square += (latency * latency);
1339 if ((context->latency_max < 0.0) || (context->latency_max < latency))
1340 context->latency_max = latency;
1341 if ((context->latency_min < 0.0) || (context->latency_min > latency))
1342 context->latency_min = latency;
1344 bucket = latency_to_bucket (context, latency);
1345 num = (double) context->req_rcvd;
1347 context->histogram_counters[bucket]++;
1349 context->histogram_accumulated[0] = context->histogram_counters[0];
1350 context->histogram_ratio[0] = ((double) context->histogram_accumulated[0]) / num;
1351 for (i = 1; i < context->latency_histogram_size; i++)
1353 context->histogram_accumulated[i] = context->histogram_accumulated[i - 1]
1354 + context->histogram_counters[i];
1355 context->histogram_ratio[i] = ((double) context->histogram_accumulated[i]) / num;
1357 } /* }}} void update_context */
1359 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
1360 __attribute__((unused)) int index)
1363 unsigned int sequence;
1366 char recv_qos_str[16];
1369 ping_context_t *context;
1372 buffer_len = sizeof (latency);
1373 ping_iterator_get_info (iter, PING_INFO_LATENCY,
1374 &latency, &buffer_len);
1377 buffer_len = sizeof (sequence);
1378 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
1379 &sequence, &buffer_len);
1382 buffer_len = sizeof (recv_ttl);
1383 ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
1384 &recv_ttl, &buffer_len);
1387 buffer_len = sizeof (recv_qos);
1388 ping_iterator_get_info (iter, PING_INFO_RECV_QOS,
1389 &recv_qos, &buffer_len);
1392 ping_iterator_get_info (iter, PING_INFO_DATA,
1395 context = (ping_context_t *) ping_iterator_get_context (iter);
1398 # define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
1400 # define HOST_PRINTF(...) printf(__VA_ARGS__)
1403 context->req_sent++;
1406 update_context (context, latency);
1409 if (has_colors () == TRUE)
1414 int color = OPING_GREEN;
1416 bucket = latency_to_bucket (context, latency);
1417 ratio_this = context->histogram_ratio[bucket];
1419 ratio_prev = context->histogram_ratio[bucket - 1];
1423 if ((ratio_this <= threshold_green)
1424 || ((ratio_prev < threshold_green)
1425 && (ratio_this > threshold_green)))
1426 color = OPING_GREEN;
1427 else if ((ratio_this <= threshold_yellow)
1428 || ((ratio_prev < threshold_yellow)
1429 && (ratio_this > threshold_yellow)))
1430 color = OPING_YELLOW;
1434 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1435 data_len, context->host, context->addr,
1437 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1438 if ((recv_qos != 0) || (opt_send_qos != 0))
1440 HOST_PRINTF ("qos=%s ",
1441 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1443 HOST_PRINTF ("time=");
1444 wattron (main_win, COLOR_PAIR(color));
1445 HOST_PRINTF ("%.2f", latency);
1446 wattroff (main_win, COLOR_PAIR(color));
1447 HOST_PRINTF (" ms\n");
1452 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1454 context->host, context->addr,
1455 sequence, recv_ttl);
1456 if ((recv_qos != 0) || (opt_send_qos != 0))
1458 HOST_PRINTF ("qos=%s ",
1459 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1461 HOST_PRINTF ("time=%.2f ms\n", latency);
1469 if (has_colors () == TRUE)
1471 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u ",
1472 context->host, context->addr,
1474 wattron (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1475 HOST_PRINTF ("timeout");
1476 wattroff (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1482 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
1483 context->host, context->addr,
1491 update_stats_from_context (context, iter);
1492 wrefresh (main_win);
1494 } /* }}} void update_host_hook */
1496 /* Prints statistics for each host, cleans up the contexts and returns the
1497 * number of hosts which failed to return more than the fraction
1498 * opt_exit_status_threshold of pings. */
1499 static int post_loop_hook (pingobj_t *ping) /* {{{ */
1501 pingobj_iter_t *iter;
1502 int failure_count = 0;
1508 for (iter = ping_iterator_get (ping);
1510 iter = ping_iterator_next (iter))
1512 ping_context_t *context;
1514 context = ping_iterator_get_context (iter);
1516 printf ("\n--- %s ping statistics ---\n"
1517 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
1518 context->host, context->req_sent, context->req_rcvd,
1519 context_get_packet_loss (context),
1520 context->latency_total);
1523 double pct_failed = 1.0 - (((double) context->req_rcvd)
1524 / ((double) context->req_sent));
1525 if (pct_failed > opt_exit_status_threshold)
1529 if (context->req_rcvd != 0)
1535 average = context_get_average (context);
1536 deviation = context_get_stddev (context);
1537 percentile = context_get_percentile (context, opt_percentile);
1539 printf ("rtt min/avg/%.0f%%/max/sdev = "
1540 "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
1542 context->latency_min,
1545 context->latency_max,
1549 ping_iterator_set_context (iter, NULL);
1550 context_destroy (context);
1553 return (failure_count);
1554 } /* }}} int post_loop_hook */
1556 int main (int argc, char **argv) /* {{{ */
1559 pingobj_iter_t *iter;
1561 struct sigaction sigint_action;
1563 struct timeval tv_begin;
1564 struct timeval tv_end;
1565 struct timespec ts_wait;
1566 struct timespec ts_int;
1571 #if _POSIX_SAVED_IDS
1572 uid_t saved_set_uid;
1574 /* Save the old effective user id */
1575 saved_set_uid = geteuid ();
1576 /* Set the effective user ID to the real user ID without changing the
1577 * saved set-user ID */
1578 status = seteuid (getuid ());
1581 fprintf (stderr, "Temporarily dropping privileges "
1582 "failed: %s\n", strerror (errno));
1583 exit (EXIT_FAILURE);
1587 setlocale(LC_ALL, "");
1588 optind = read_options (argc, argv);
1590 #if !_POSIX_SAVED_IDS
1591 /* Cannot temporarily drop privileges -> reject every file but "-". */
1592 if ((opt_filename != NULL)
1593 && (strcmp ("-", opt_filename) != 0)
1594 && (getuid () != geteuid ()))
1596 fprintf (stderr, "Your real and effective user IDs don't "
1597 "match. Reading from a file (option '-f')\n"
1598 "is therefore too risky. You can still read "
1599 "from STDIN using '-f -' if you like.\n"
1601 exit (EXIT_FAILURE);
1605 if ((optind >= argc) && (opt_filename == NULL)) {
1606 usage_exit (argv[0], 1);
1609 if ((ping = ping_construct ()) == NULL)
1611 fprintf (stderr, "ping_construct failed\n");
1615 if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
1617 fprintf (stderr, "Setting TTL to %i failed: %s\n",
1618 opt_send_ttl, ping_get_error (ping));
1621 if (ping_setopt (ping, PING_OPT_QOS, &opt_send_qos) != 0)
1623 fprintf (stderr, "Setting TOS to %i failed: %s\n",
1624 opt_send_qos, ping_get_error (ping));
1631 temp_nsec = modf (opt_interval, &temp_sec);
1632 ts_int.tv_sec = (time_t) temp_sec;
1633 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
1635 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
1638 if (opt_addrfamily != PING_DEF_AF)
1639 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
1641 if (opt_srcaddr != NULL)
1643 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
1645 fprintf (stderr, "Setting source address failed: %s\n",
1646 ping_get_error (ping));
1650 if (opt_device != NULL)
1652 if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
1654 fprintf (stderr, "Setting device failed: %s\n",
1655 ping_get_error (ping));
1659 if (opt_filename != NULL)
1665 if (strcmp (opt_filename, "-") == 0)
1667 infile = fdopen(0, "r");
1669 infile = fopen(opt_filename, "r");
1673 fprintf (stderr, "Opening %s failed: %s\n",
1674 (strcmp (opt_filename, "-") == 0)
1675 ? "STDIN" : opt_filename,
1680 #if _POSIX_SAVED_IDS
1681 /* Regain privileges */
1682 status = seteuid (saved_set_uid);
1685 fprintf (stderr, "Temporarily re-gaining privileges "
1686 "failed: %s\n", strerror (errno));
1687 exit (EXIT_FAILURE);
1691 while (fgets(line, sizeof(line), infile))
1693 /* Strip whitespace */
1694 if (sscanf(line, "%s", host) != 1)
1697 if ((host[0] == 0) || (host[0] == '#'))
1700 if (ping_host_add(ping, host) < 0)
1702 const char *errmsg = ping_get_error (ping);
1704 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
1713 #if _POSIX_SAVED_IDS
1714 /* Drop privileges */
1715 status = seteuid (getuid ());
1718 fprintf (stderr, "Temporarily dropping privileges "
1719 "failed: %s\n", strerror (errno));
1720 exit (EXIT_FAILURE);
1727 #if _POSIX_SAVED_IDS
1728 /* Regain privileges */
1729 status = seteuid (saved_set_uid);
1732 fprintf (stderr, "Temporarily re-gaining privileges "
1733 "failed: %s\n", strerror (errno));
1734 exit (EXIT_FAILURE);
1738 for (i = optind; i < argc; i++)
1740 if (ping_host_add (ping, argv[i]) < 0)
1742 const char *errmsg = ping_get_error (ping);
1744 fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
1753 /* Permanently drop root privileges if we're setuid-root. */
1754 status = setuid (getuid ());
1757 fprintf (stderr, "Dropping privileges failed: %s\n",
1759 exit (EXIT_FAILURE);
1763 exit (EXIT_FAILURE);
1765 #if _POSIX_SAVED_IDS
1766 saved_set_uid = (uid_t) -1;
1769 ping_initialize_contexts (ping);
1774 memset (&sigint_action, '\0', sizeof (sigint_action));
1775 sigint_action.sa_handler = sigint_handler;
1776 if (sigaction (SIGINT, &sigint_action, NULL) < 0)
1778 perror ("sigaction");
1782 pre_loop_hook (ping);
1784 while (opt_count != 0)
1789 if (gettimeofday (&tv_begin, NULL) < 0)
1791 perror ("gettimeofday");
1795 status = ping_send (ping);
1796 if (status == -EINTR)
1800 else if (status < 0)
1802 fprintf (stderr, "ping_send failed: %s\n",
1803 ping_get_error (ping));
1808 for (iter = ping_iterator_get (ping);
1810 iter = ping_iterator_next (iter))
1812 update_host_hook (iter, index);
1816 pre_sleep_hook (ping);
1818 /* Don't sleep in the last iteration */
1822 if (gettimeofday (&tv_end, NULL) < 0)
1824 perror ("gettimeofday");
1828 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
1830 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
1831 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
1839 perror ("nanosleep");
1844 post_sleep_hook (ping);
1848 } /* while (opt_count != 0) */
1850 /* Returns the number of failed hosts according to -Z. */
1851 status = post_loop_hook (ping);
1853 ping_destroy (ping);
1856 exit (EXIT_SUCCESS);
1863 } /* }}} int main */
1865 /* vim: set fdm=marker : */