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)
131 #define BOXPLOT_BOX ' '
133 #define BOXPLOT_MEDIAN (120 | A_ALTCHARSET)
137 #ifndef _POSIX_SAVED_IDS
138 # define _POSIX_SAVED_IDS 0
141 #ifndef IPTOS_MINCOST
142 # define IPTOS_MINCOST 0x02
145 /* Remove GNU specific __attribute__ settings when using another compiler */
147 # define __attribute__(x) /**/
150 typedef struct ping_context
152 char host[NI_MAXHOST];
153 char addr[NI_MAXHOST];
161 double latency_total;
162 double latency_total_square;
164 /* 1000 + one "infinity" bucket. */
165 #define OPING_HISTOGRAM_BUCKETS 1001
166 uint32_t *latency_histogram;
167 size_t latency_histogram_size;
174 static double opt_interval = 1.0;
175 static int opt_addrfamily = PING_DEF_AF;
176 static char *opt_srcaddr = NULL;
177 static char *opt_device = NULL;
178 static char *opt_filename = NULL;
179 static int opt_count = -1;
180 static int opt_send_ttl = 64;
181 static uint8_t opt_send_qos = 0;
182 #define OPING_DEFAULT_PERCENTILE 95.0
183 static double opt_percentile = -1.0;
184 static double opt_exit_status_threshold = 1.0;
186 static int opt_utf8 = 0;
189 static int host_num = 0;
192 static WINDOW *main_win = NULL;
195 static void sigint_handler (int signal) /* {{{ */
197 /* Make compiler happy */
201 } /* }}} void sigint_handler */
203 static ping_context_t *context_create (void) /* {{{ */
207 if ((ret = malloc (sizeof (ping_context_t))) == NULL)
210 memset (ret, '\0', sizeof (ping_context_t));
212 ret->latency_min = -1.0;
213 ret->latency_max = -1.0;
214 ret->latency_total = 0.0;
215 ret->latency_total_square = 0.0;
217 ret->latency_histogram_size = (size_t) OPING_HISTOGRAM_BUCKETS;
218 ret->latency_histogram = calloc (ret->latency_histogram_size,
219 sizeof (*ret->latency_histogram));
226 } /* }}} ping_context_t *context_create */
228 static void context_destroy (ping_context_t *context) /* {{{ */
234 if (context->window != NULL)
236 delwin (context->window);
237 context->window = NULL;
241 free (context->latency_histogram);
242 context->latency_histogram = NULL;
245 } /* }}} void context_destroy */
247 static double context_get_average (ping_context_t *ctx) /* {{{ */
254 if (ctx->req_rcvd < 1)
257 num_total = (double) ctx->req_rcvd;
258 return (ctx->latency_total / num_total);
259 } /* }}} double context_get_average */
261 static double context_get_percentile (ping_context_t *ctx, /* {{{ */
264 double threshold = percentile / 100.0;
265 uint32_t accumulated[ctx->latency_histogram_size];
266 double ratios[ctx->latency_histogram_size];
267 double index_to_ms_factor;
271 if (ctx->latency_histogram == NULL)
274 accumulated[0] = ctx->latency_histogram[0];
275 for (i = 1; i < ctx->latency_histogram_size; i++)
276 accumulated[i] = accumulated[i - 1]
277 + ctx->latency_histogram[i];
278 num = accumulated[ctx->latency_histogram_size - 1];
280 for (i = 0; i < ctx->latency_histogram_size; i++)
282 ratios[i] = ((double) accumulated[i]) / ((double) num);
283 if (ratios[i] >= threshold)
287 if (i >= ctx->latency_histogram_size)
289 else if (i == (ctx->latency_histogram_size - 1))
292 index_to_ms_factor = (1000.0 * opt_interval) / (ctx->latency_histogram_size - 1);
294 /* Multiply with i+1, because we're interested in the _upper_ bound of
296 return (index_to_ms_factor * ((double) (i + 1)));
297 } /* }}} double context_get_percentile */
299 static double context_get_stddev (ping_context_t *ctx) /* {{{ */
306 if (ctx->req_rcvd < 1)
308 else if (ctx->req_rcvd < 2)
311 num_total = (double) ctx->req_rcvd;
312 return (sqrt (((num_total * ctx->latency_total_square)
313 - (ctx->latency_total * ctx->latency_total))
314 / (num_total * (num_total - 1.0))));
315 } /* }}} double context_get_stddev */
317 static double context_get_packet_loss (const ping_context_t *ctx) /* {{{ */
322 if (ctx->req_sent < 1)
325 return (100.0 * (ctx->req_sent - ctx->req_rcvd)
326 / ((double) ctx->req_sent));
327 } /* }}} double context_get_packet_loss */
329 static int ping_initialize_contexts (pingobj_t *ping) /* {{{ */
331 pingobj_iter_t *iter;
338 for (iter = ping_iterator_get (ping);
340 iter = ping_iterator_next (iter))
342 ping_context_t *context;
345 context = context_create ();
346 context->index = index;
348 buffer_size = sizeof (context->host);
349 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
351 buffer_size = sizeof (context->addr);
352 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
354 ping_iterator_set_context (iter, (void *) context);
360 } /* }}} int ping_initialize_contexts */
362 static void usage_exit (const char *name, int status) /* {{{ */
364 fprintf (stderr, "Usage: %s [OPTIONS] "
365 "-f filename | host [host [host ...]]\n"
367 "\nAvailable options:\n"
368 " -4|-6 force the use of IPv4 or IPv6\n"
369 " -c count number of ICMP packets to send\n"
370 " -i interval interval with which to send ICMP packets\n"
371 " -t ttl time to live for each ICMP packet\n"
372 " -Q qos Quality of Service (QoS) of outgoing packets\n"
373 " Use \"-Q help\" for a list of valid options.\n"
374 " -I srcaddr source address\n"
375 " -D device outgoing interface name\n"
376 " -f filename filename to read hosts from\n"
378 " -u / -U force / disable UTF-8 output\n"
380 " -P percent Report the n'th percentile of latency\n"
381 " -Z percent Exit with non-zero exit status if more than this percentage of\n"
382 " probes timed out. (default: never)\n"
384 "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
385 "by Florian octo Forster <octo@verplant.org>\n"
386 "for contributions see `AUTHORS'\n",
389 } /* }}} void usage_exit */
391 __attribute__((noreturn))
392 static void usage_qos_exit (const char *arg, int status) /* {{{ */
395 fprintf (stderr, "Invalid QoS argument: \"%s\"\n\n", arg);
397 fprintf (stderr, "Valid QoS arguments (option \"-Q\") are:\n"
399 " Differentiated Services (IPv4 and IPv6, RFC 2474)\n"
401 " be Best Effort (BE, default PHB).\n"
402 " ef Expedited Forwarding (EF) PHB group (RFC 3246).\n"
403 " (low delay, low loss, low jitter)\n"
404 " va Voice Admit (VA) DSCP (RFC 5865).\n"
405 " (capacity-admitted traffic)\n"
406 " af[1-4][1-3] Assured Forwarding (AF) PHB group (RFC 2597).\n"
407 " For example: \"af12\" (class 1, precedence 2)\n"
408 " cs[0-7] Class Selector (CS) PHB group (RFC 2474).\n"
409 " For example: \"cs1\" (priority traffic)\n"
411 " Type of Service (IPv4, RFC 1349, obsolete)\n"
413 " lowdelay (%#04x) minimize delay\n"
414 " throughput (%#04x) maximize throughput\n"
415 " reliability (%#04x) maximize reliability\n"
416 " mincost (%#04x) minimize monetary cost\n"
418 " Specify manually\n"
420 " 0x00 - 0xff Hexadecimal numeric specification.\n"
421 " 0 - 255 Decimal numeric specification.\n"
423 (unsigned int) IPTOS_LOWDELAY,
424 (unsigned int) IPTOS_THROUGHPUT,
425 (unsigned int) IPTOS_RELIABILITY,
426 (unsigned int) IPTOS_MINCOST);
429 } /* }}} void usage_qos_exit */
431 static int set_opt_send_qos (const char *opt) /* {{{ */
436 if (strcasecmp ("help", opt) == 0)
437 usage_qos_exit (/* arg = */ NULL, /* status = */ EXIT_SUCCESS);
438 /* DiffServ (RFC 2474): */
439 /* - Best effort (BE) */
440 else if (strcasecmp ("be", opt) == 0)
442 /* - Expedited Forwarding (EF, RFC 3246) */
443 else if (strcasecmp ("ef", opt) == 0)
444 opt_send_qos = 0xB8; /* == 0x2E << 2 */
445 /* - Voice Admit (VA, RFC 5865) */
446 else if (strcasecmp ("va", opt) == 0)
447 opt_send_qos = 0xB0; /* == 0x2D << 2 */
448 /* - Assured Forwarding (AF, RFC 2597) */
449 else if ((strncasecmp ("af", opt, strlen ("af")) == 0)
450 && (strlen (opt) == 4))
456 /* There are four classes, AF1x, AF2x, AF3x, and AF4x. */
459 else if (opt[2] == '2')
461 else if (opt[2] == '3')
463 else if (opt[2] == '4')
466 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
468 /* In each class, there are three precedences, AFx1, AFx2, and AFx3 */
471 else if (opt[3] == '2')
473 else if (opt[3] == '3')
476 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
478 dscp = (8 * class) + (2 * prec);
479 /* The lower two bits are used for Explicit Congestion Notification (ECN) */
480 opt_send_qos = dscp << 2;
482 /* - Class Selector (CS) */
483 else if ((strncasecmp ("cs", opt, strlen ("cs")) == 0)
484 && (strlen (opt) == 3))
488 if ((opt[2] < '0') || (opt[2] > '7'))
489 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
491 /* Not exactly legal by the C standard, but I don't know of any
492 * system not supporting this hack. */
493 class = ((uint8_t) opt[2]) - ((uint8_t) '0');
494 opt_send_qos = class << 5;
496 /* Type of Service (RFC 1349) */
497 else if (strcasecmp ("lowdelay", opt) == 0)
498 opt_send_qos = IPTOS_LOWDELAY;
499 else if (strcasecmp ("throughput", opt) == 0)
500 opt_send_qos = IPTOS_THROUGHPUT;
501 else if (strcasecmp ("reliability", opt) == 0)
502 opt_send_qos = IPTOS_RELIABILITY;
503 else if (strcasecmp ("mincost", opt) == 0)
504 opt_send_qos = IPTOS_MINCOST;
513 value = strtoul (opt, &endptr, /* base = */ 0);
514 if ((errno != 0) || (endptr == opt)
515 || (endptr == NULL) || (*endptr != 0)
517 usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
519 opt_send_qos = (uint8_t) value;
523 } /* }}} int set_opt_send_qos */
525 static char *format_qos (uint8_t qos, char *buffer, size_t buffer_size) /* {{{ */
537 case 0x00: dscp_str = "be"; break;
538 case 0x2e: dscp_str = "ef"; break;
539 case 0x2d: dscp_str = "va"; break;
540 case 0x0a: dscp_str = "af11"; break;
541 case 0x0c: dscp_str = "af12"; break;
542 case 0x0e: dscp_str = "af13"; break;
543 case 0x12: dscp_str = "af21"; break;
544 case 0x14: dscp_str = "af22"; break;
545 case 0x16: dscp_str = "af23"; break;
546 case 0x1a: dscp_str = "af31"; break;
547 case 0x1c: dscp_str = "af32"; break;
548 case 0x1e: dscp_str = "af33"; break;
549 case 0x22: dscp_str = "af41"; break;
550 case 0x24: dscp_str = "af42"; break;
551 case 0x26: dscp_str = "af43"; break;
552 case 0x08: dscp_str = "cs1"; break;
553 case 0x10: dscp_str = "cs2"; break;
554 case 0x18: dscp_str = "cs3"; break;
555 case 0x20: dscp_str = "cs4"; break;
556 case 0x28: dscp_str = "cs5"; break;
557 case 0x30: dscp_str = "cs6"; break;
558 case 0x38: dscp_str = "cs7"; break;
559 default: dscp_str = NULL;
564 case 0x01: ecn_str = ",ecn(1)"; break;
565 case 0x02: ecn_str = ",ecn(0)"; break;
566 case 0x03: ecn_str = ",ce"; break;
567 default: ecn_str = "";
570 if (dscp_str == NULL)
571 snprintf (buffer, buffer_size, "0x%02x%s", dscp, ecn_str);
573 snprintf (buffer, buffer_size, "%s%s", dscp_str, ecn_str);
574 buffer[buffer_size - 1] = 0;
577 } /* }}} char *format_qos */
579 static int read_options (int argc, char **argv) /* {{{ */
585 optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:P:"
598 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
604 new_count = atoi (optarg);
607 opt_count = new_count;
609 if ((opt_percentile < 0.0) && (opt_count < 20))
610 opt_percentile = 100.0 * (opt_count - 1) / opt_count;
613 fprintf(stderr, "Ignoring invalid count: %s\n",
620 if (opt_filename != NULL)
622 opt_filename = strdup (optarg);
629 new_interval = atof (optarg);
630 if (new_interval < 0.001)
631 fprintf (stderr, "Ignoring invalid interval: %s\n",
634 opt_interval = new_interval;
640 if (opt_srcaddr != NULL)
642 opt_srcaddr = strdup (optarg);
653 new_send_ttl = atoi (optarg);
654 if ((new_send_ttl > 0) && (new_send_ttl < 256))
655 opt_send_ttl = new_send_ttl;
657 fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
663 set_opt_send_qos (optarg);
668 double new_percentile;
669 new_percentile = atof (optarg);
670 if (isnan (new_percentile)
671 || (new_percentile < 0.1)
672 || (new_percentile > 100.0))
673 fprintf (stderr, "Ignoring invalid percentile: %s\n",
676 opt_percentile = new_percentile;
695 tmp = strtod (optarg, &endptr);
696 if ((errno != 0) || (endptr == NULL) || (*endptr != 0) || (tmp < 0.0) || (tmp > 100.0))
698 fprintf (stderr, "Ignoring invalid -Z argument: %s\n", optarg);
699 fprintf (stderr, "The \"-Z\" option requires a numeric argument between 0 and 100.\n");
702 opt_exit_status_threshold = tmp / 100.0;
708 usage_exit (argv[0], 0);
711 usage_exit (argv[0], 1);
715 if (opt_percentile <= 0.0)
716 opt_percentile = OPING_DEFAULT_PERCENTILE;
719 } /* }}} read_options */
721 static void time_normalize (struct timespec *ts) /* {{{ */
723 while (ts->tv_nsec < 0)
732 ts->tv_nsec += 1000000000;
735 while (ts->tv_nsec >= 1000000000)
738 ts->tv_nsec -= 1000000000;
740 } /* }}} void time_normalize */
742 static void time_calc (struct timespec *ts_dest, /* {{{ */
743 const struct timespec *ts_int,
744 const struct timeval *tv_begin,
745 const struct timeval *tv_end)
747 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
748 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
749 time_normalize (ts_dest);
751 /* Assure that `(begin + interval) > end'.
752 * This may seem overly complicated, but `tv_sec' is of type `time_t'
753 * which may be `unsigned. *sigh* */
754 if ((tv_end->tv_sec > ts_dest->tv_sec)
755 || ((tv_end->tv_sec == ts_dest->tv_sec)
756 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
759 ts_dest->tv_nsec = 0;
763 ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
764 ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
765 time_normalize (ts_dest);
766 } /* }}} void time_calc */
769 static _Bool has_utf8() /* {{{ */
771 # if HAVE_NCURSESW_NCURSES_H
774 /* Automatically determine */
775 if (strcasecmp ("UTF-8", nl_langinfo (CODESET)) == 0)
780 return ((_Bool) (opt_utf8 - 1));
784 } /* }}} _Bool has_utf8 */
786 static int update_boxplot (ping_context_t *ctx) /* {{{ */
788 uint32_t *accumulated;
795 x_max = (size_t) getmaxx (ctx->window);
800 accumulated = calloc (x_max, sizeof (*accumulated));
801 ratios = calloc (x_max, sizeof (*ratios));
804 for (i = 0; i < ctx->latency_histogram_size; i++)
806 x = i * x_max / ctx->latency_histogram_size;
807 accumulated[x] += ctx->latency_histogram[i];
811 for (x = 1; x < x_max; x++)
812 accumulated[x] += accumulated[x - 1];
814 num = accumulated[x_max - 1];
816 /* Calculate ratios */
817 for (x = 0; x < x_max; x++)
818 ratios[x] = ((double) accumulated[x]) / ((double) num);
820 for (x = 0; x < x_max; x++)
827 if (ratios[x] >= 0.5)
829 symbol = BOXPLOT_MEDIAN;
832 else if (ratios[x] > 0.25)
834 symbol = BOXPLOT_BOX;
837 else if (ratios[x] > 0.025)
838 symbol = BOXPLOT_WHISKER_BAR;
840 symbol = ' '; /* NOP */
844 if ((ratios[x - 1] < 0.5) && (ratios[x] >= 0.5))
846 symbol = BOXPLOT_MEDIAN;
849 else if (((ratios[x] >= 0.25) && (ratios[x] <= 0.75))
850 || ((ratios[x - 1] < 0.75) && (ratios[x] > 0.75)))
852 symbol = BOXPLOT_BOX;
855 else if ((ratios[x] < 0.5) && (ratios[x] >= 0.025))
857 if (ratios[x - 1] < 0.025)
858 symbol = BOXPLOT_WHISKER_LEFT_END;
860 symbol = BOXPLOT_WHISKER_BAR;
862 else if ((ratios[x] > .5) && (ratios[x] < 0.975))
864 symbol = BOXPLOT_WHISKER_BAR;
866 else if ((ratios[x] >= 0.975) && (ratios[x - 1] < 0.975))
867 symbol = BOXPLOT_WHISKER_RIGHT_END;
871 wattron (ctx->window, A_REVERSE);
872 mvwaddch (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
873 // mvwprintw (ctx->window, /* y = */ 3, /* x = */ (int) (x + 2), symbol);
875 wattroff (ctx->window, A_REVERSE);
881 } /* }}} int update_boxplot */
883 static int update_prettyping_graph (ping_context_t *ctx, /* {{{ */
884 double latency, unsigned int sequence)
886 int color = OPING_RED;
887 char const *symbol = "!";
893 x_max = getmaxx (ctx->window);
894 x_pos = ((sequence - 1) % (x_max - 4)) + 2;
900 size_t symbols_num = hist_symbols_acs_num;
901 size_t colors_num = 1;
903 size_t index_symbols;
907 /* latency is in milliseconds, opt_interval is in seconds. */
908 ratio = (latency * 0.001) / opt_interval;
914 symbols_num = hist_symbols_utf8_num;
916 if (has_colors () == TRUE)
917 colors_num = hist_colors_num;
919 intensity = (size_t) (ratio * ((double) (symbols_num * colors_num)));
920 if (intensity >= (symbols_num * colors_num))
921 intensity = (symbols_num * colors_num) - 1;
923 index_symbols = intensity % symbols_num;
924 assert (index_symbols < symbols_num);
926 index_colors = intensity / symbols_num;
927 assert (index_colors < colors_num);
931 color = hist_colors_utf8[index_colors];
932 symbol = hist_symbols_utf8[index_symbols];
936 color = hist_colors_acs[index_colors];
937 symbolc = hist_symbols_acs[index_symbols] | A_ALTCHARSET;
940 else /* if (!(latency >= 0.0)) */
941 wattron (ctx->window, A_BOLD);
943 if (has_colors () == TRUE)
944 wattron (ctx->window, COLOR_PAIR(color));
947 mvwprintw (ctx->window, /* y = */ 3, /* x = */ x_pos, symbol);
949 mvwaddch (ctx->window, /* y = */ 3, /* x = */ x_pos, symbolc);
951 if (has_colors () == TRUE)
952 wattroff (ctx->window, COLOR_PAIR(color));
954 /* Use negation here to handle NaN correctly. */
955 if (!(latency >= 0.0))
956 wattroff (ctx->window, A_BOLD);
958 wprintw (ctx->window, " ");
960 } /* }}} int update_prettyping_graph */
962 static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter) /* {{{ */
964 double latency = -1.0;
965 size_t buffer_len = sizeof (latency);
967 ping_iterator_get_info (iter, PING_INFO_LATENCY,
968 &latency, &buffer_len);
970 unsigned int sequence = 0;
971 buffer_len = sizeof (sequence);
972 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
973 &sequence, &buffer_len);
976 if ((ctx == NULL) || (ctx->window == NULL))
979 /* werase (ctx->window); */
981 box (ctx->window, 0, 0);
982 wattron (ctx->window, A_BOLD);
983 mvwprintw (ctx->window, /* y = */ 0, /* x = */ 5,
985 wattroff (ctx->window, A_BOLD);
986 wprintw (ctx->window, "ping statistics ");
987 mvwprintw (ctx->window, /* y = */ 1, /* x = */ 2,
988 "%i packets transmitted, %i received, %.2f%% packet "
990 ctx->req_sent, ctx->req_rcvd,
991 context_get_packet_loss (ctx),
993 if (ctx->req_rcvd != 0)
999 average = context_get_average (ctx);
1000 deviation = context_get_stddev (ctx);
1001 percentile = context_get_percentile (ctx, opt_percentile);
1003 mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
1004 "rtt min/avg/%.0f%%/max/sdev = "
1005 "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
1014 update_prettyping_graph (ctx, latency, sequence);
1016 wrefresh (ctx->window);
1019 } /* }}} int update_stats_from_context */
1021 static int on_resize (pingobj_t *ping) /* {{{ */
1023 pingobj_iter_t *iter;
1026 int main_win_height;
1028 getmaxyx (stdscr, height, width);
1029 if ((height < 1) || (width < 1))
1032 main_win_height = height - (5 * host_num);
1033 wresize (main_win, main_win_height, /* width = */ width);
1034 /* Allow scrolling */
1035 scrollok (main_win, TRUE);
1036 /* wsetscrreg (main_win, 0, main_win_height - 1); */
1037 /* Allow hardware accelerated scrolling. */
1038 idlok (main_win, TRUE);
1039 wrefresh (main_win);
1041 for (iter = ping_iterator_get (ping);
1043 iter = ping_iterator_next (iter))
1045 ping_context_t *context;
1047 context = ping_iterator_get_context (iter);
1048 if (context == NULL)
1051 if (context->window != NULL)
1053 delwin (context->window);
1054 context->window = NULL;
1056 context->window = newwin (/* height = */ 5,
1057 /* width = */ width,
1058 /* y = */ main_win_height + (5 * context->index),
1065 static int check_resize (pingobj_t *ping) /* {{{ */
1067 int need_resize = 0;
1071 int key = wgetch (stdscr);
1074 else if (key == KEY_RESIZE)
1079 return (on_resize (ping));
1082 } /* }}} int check_resize */
1084 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
1086 pingobj_iter_t *iter;
1089 int main_win_height;
1094 nodelay (stdscr, TRUE);
1096 getmaxyx (stdscr, height, width);
1097 if ((height < 1) || (width < 1))
1100 if (has_colors () == TRUE)
1103 init_pair (OPING_GREEN, COLOR_GREEN, /* default = */ 0);
1104 init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ 0);
1105 init_pair (OPING_RED, COLOR_RED, /* default = */ 0);
1106 init_pair (OPING_GREEN_HIST, COLOR_GREEN, COLOR_BLACK);
1107 init_pair (OPING_YELLOW_HIST, COLOR_YELLOW, COLOR_GREEN);
1108 init_pair (OPING_RED_HIST, COLOR_RED, COLOR_YELLOW);
1111 main_win_height = height - (5 * host_num);
1112 main_win = newwin (/* height = */ main_win_height,
1113 /* width = */ width,
1114 /* y = */ 0, /* x = */ 0);
1115 /* Allow scrolling */
1116 scrollok (main_win, TRUE);
1117 /* wsetscrreg (main_win, 0, main_win_height - 1); */
1118 /* Allow hardware accelerated scrolling. */
1119 idlok (main_win, TRUE);
1120 wmove (main_win, /* y = */ main_win_height - 1, /* x = */ 0);
1121 wrefresh (main_win);
1123 for (iter = ping_iterator_get (ping);
1125 iter = ping_iterator_next (iter))
1127 ping_context_t *context;
1129 context = ping_iterator_get_context (iter);
1130 if (context == NULL)
1133 if (context->window != NULL)
1135 delwin (context->window);
1136 context->window = NULL;
1138 context->window = newwin (/* height = */ 5,
1139 /* width = */ width,
1140 /* y = */ main_win_height + (5 * context->index),
1145 /* Don't know what good this does exactly, but without this code
1146 * "check_resize" will be called right after startup and *somehow*
1147 * this leads to display errors. If we purge all initial characters
1148 * here, the problem goes away. "wgetch" is non-blocking due to
1149 * "nodelay" (see above). */
1150 while (wgetch (stdscr) != ERR)
1152 /* eat up characters */;
1156 } /* }}} int pre_loop_hook */
1158 static int pre_sleep_hook (pingobj_t *ping) /* {{{ */
1160 return (check_resize (ping));
1161 } /* }}} int pre_sleep_hook */
1163 static int post_sleep_hook (pingobj_t *ping) /* {{{ */
1165 return (check_resize (ping));
1166 } /* }}} int pre_sleep_hook */
1167 #else /* if !USE_NCURSES */
1168 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
1170 pingobj_iter_t *iter;
1172 for (iter = ping_iterator_get (ping);
1174 iter = ping_iterator_next (iter))
1176 ping_context_t *ctx;
1179 ctx = ping_iterator_get_context (iter);
1184 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
1186 printf ("PING %s (%s) %zu bytes of data.\n",
1187 ctx->host, ctx->addr, buffer_size);
1191 } /* }}} int pre_loop_hook */
1193 static int pre_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
1198 } /* }}} int pre_sleep_hook */
1200 static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
1203 } /* }}} int post_sleep_hook */
1206 static void update_context (ping_context_t *context, double latency) /* {{{ */
1210 context->req_rcvd++;
1211 context->latency_total += latency;
1212 context->latency_total_square += (latency * latency);
1214 if ((context->latency_max < 0.0) || (context->latency_max < latency))
1215 context->latency_max = latency;
1216 if ((context->latency_min < 0.0) || (context->latency_min > latency))
1217 context->latency_min = latency;
1219 if (context->latency_histogram == NULL)
1222 /* latency is in ms, opt_interval is in s. */
1223 bucket = (size_t) ((latency * (context->latency_histogram_size - 1))
1224 / (1000.0 * opt_interval));
1225 if (bucket >= context->latency_histogram_size)
1226 bucket = context->latency_histogram_size - 1;
1227 context->latency_histogram[bucket]++;
1228 } /* }}} void update_context */
1230 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
1231 __attribute__((unused)) int index)
1234 unsigned int sequence;
1237 char recv_qos_str[16];
1240 ping_context_t *context;
1243 buffer_len = sizeof (latency);
1244 ping_iterator_get_info (iter, PING_INFO_LATENCY,
1245 &latency, &buffer_len);
1248 buffer_len = sizeof (sequence);
1249 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
1250 &sequence, &buffer_len);
1253 buffer_len = sizeof (recv_ttl);
1254 ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
1255 &recv_ttl, &buffer_len);
1258 buffer_len = sizeof (recv_qos);
1259 ping_iterator_get_info (iter, PING_INFO_RECV_QOS,
1260 &recv_qos, &buffer_len);
1263 ping_iterator_get_info (iter, PING_INFO_DATA,
1266 context = (ping_context_t *) ping_iterator_get_context (iter);
1269 # define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
1271 # define HOST_PRINTF(...) printf(__VA_ARGS__)
1274 context->req_sent++;
1277 update_context (context, latency);
1280 if (has_colors () == TRUE)
1282 int color = OPING_GREEN;
1283 double average = context_get_average (context);
1284 double stddev = context_get_stddev (context);
1286 if ((latency < (average - (2 * stddev)))
1287 || (latency > (average + (2 * stddev))))
1289 else if ((latency < (average - stddev))
1290 || (latency > (average + stddev)))
1291 color = OPING_YELLOW;
1293 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1294 data_len, context->host, context->addr,
1296 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1297 if ((recv_qos != 0) || (opt_send_qos != 0))
1299 HOST_PRINTF ("qos=%s ",
1300 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1302 HOST_PRINTF ("time=");
1303 wattron (main_win, COLOR_PAIR(color));
1304 HOST_PRINTF ("%.2f", latency);
1305 wattroff (main_win, COLOR_PAIR(color));
1306 HOST_PRINTF (" ms\n");
1311 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1313 context->host, context->addr,
1314 sequence, recv_ttl);
1315 if ((recv_qos != 0) || (opt_send_qos != 0))
1317 HOST_PRINTF ("qos=%s ",
1318 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1320 HOST_PRINTF ("time=%.2f ms\n", latency);
1328 if (has_colors () == TRUE)
1330 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u ",
1331 context->host, context->addr,
1333 wattron (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1334 HOST_PRINTF ("timeout");
1335 wattroff (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1341 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
1342 context->host, context->addr,
1350 update_stats_from_context (context, iter);
1351 wrefresh (main_win);
1353 } /* }}} void update_host_hook */
1355 /* Prints statistics for each host, cleans up the contexts and returns the
1356 * number of hosts which failed to return more than the fraction
1357 * opt_exit_status_threshold of pings. */
1358 static int post_loop_hook (pingobj_t *ping) /* {{{ */
1360 pingobj_iter_t *iter;
1361 int failure_count = 0;
1367 for (iter = ping_iterator_get (ping);
1369 iter = ping_iterator_next (iter))
1371 ping_context_t *context;
1373 context = ping_iterator_get_context (iter);
1375 printf ("\n--- %s ping statistics ---\n"
1376 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
1377 context->host, context->req_sent, context->req_rcvd,
1378 context_get_packet_loss (context),
1379 context->latency_total);
1382 double pct_failed = 1.0 - (((double) context->req_rcvd)
1383 / ((double) context->req_sent));
1384 if (pct_failed > opt_exit_status_threshold)
1388 if (context->req_rcvd != 0)
1394 average = context_get_average (context);
1395 deviation = context_get_stddev (context);
1396 percentile = context_get_percentile (context, opt_percentile);
1398 printf ("rtt min/avg/%.0f%%/max/sdev = "
1399 "%.3f/%.3f/%.0f/%.3f/%.3f ms\n",
1401 context->latency_min,
1404 context->latency_max,
1408 ping_iterator_set_context (iter, NULL);
1409 context_destroy (context);
1412 return (failure_count);
1413 } /* }}} int post_loop_hook */
1415 int main (int argc, char **argv) /* {{{ */
1418 pingobj_iter_t *iter;
1420 struct sigaction sigint_action;
1422 struct timeval tv_begin;
1423 struct timeval tv_end;
1424 struct timespec ts_wait;
1425 struct timespec ts_int;
1430 #if _POSIX_SAVED_IDS
1431 uid_t saved_set_uid;
1433 /* Save the old effective user id */
1434 saved_set_uid = geteuid ();
1435 /* Set the effective user ID to the real user ID without changing the
1436 * saved set-user ID */
1437 status = seteuid (getuid ());
1440 fprintf (stderr, "Temporarily dropping privileges "
1441 "failed: %s\n", strerror (errno));
1442 exit (EXIT_FAILURE);
1446 setlocale(LC_ALL, "");
1447 optind = read_options (argc, argv);
1449 #if !_POSIX_SAVED_IDS
1450 /* Cannot temporarily drop privileges -> reject every file but "-". */
1451 if ((opt_filename != NULL)
1452 && (strcmp ("-", opt_filename) != 0)
1453 && (getuid () != geteuid ()))
1455 fprintf (stderr, "Your real and effective user IDs don't "
1456 "match. Reading from a file (option '-f')\n"
1457 "is therefore too risky. You can still read "
1458 "from STDIN using '-f -' if you like.\n"
1460 exit (EXIT_FAILURE);
1464 if ((optind >= argc) && (opt_filename == NULL)) {
1465 usage_exit (argv[0], 1);
1468 if ((ping = ping_construct ()) == NULL)
1470 fprintf (stderr, "ping_construct failed\n");
1474 if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
1476 fprintf (stderr, "Setting TTL to %i failed: %s\n",
1477 opt_send_ttl, ping_get_error (ping));
1480 if (ping_setopt (ping, PING_OPT_QOS, &opt_send_qos) != 0)
1482 fprintf (stderr, "Setting TOS to %i failed: %s\n",
1483 opt_send_qos, ping_get_error (ping));
1490 temp_nsec = modf (opt_interval, &temp_sec);
1491 ts_int.tv_sec = (time_t) temp_sec;
1492 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
1494 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
1497 if (opt_addrfamily != PING_DEF_AF)
1498 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
1500 if (opt_srcaddr != NULL)
1502 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
1504 fprintf (stderr, "Setting source address failed: %s\n",
1505 ping_get_error (ping));
1509 if (opt_device != NULL)
1511 if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
1513 fprintf (stderr, "Setting device failed: %s\n",
1514 ping_get_error (ping));
1518 if (opt_filename != NULL)
1524 if (strcmp (opt_filename, "-") == 0)
1526 infile = fdopen(0, "r");
1528 infile = fopen(opt_filename, "r");
1532 fprintf (stderr, "Opening %s failed: %s\n",
1533 (strcmp (opt_filename, "-") == 0)
1534 ? "STDIN" : opt_filename,
1539 #if _POSIX_SAVED_IDS
1540 /* Regain privileges */
1541 status = seteuid (saved_set_uid);
1544 fprintf (stderr, "Temporarily re-gaining privileges "
1545 "failed: %s\n", strerror (errno));
1546 exit (EXIT_FAILURE);
1550 while (fgets(line, sizeof(line), infile))
1552 /* Strip whitespace */
1553 if (sscanf(line, "%s", host) != 1)
1556 if ((host[0] == 0) || (host[0] == '#'))
1559 if (ping_host_add(ping, host) < 0)
1561 const char *errmsg = ping_get_error (ping);
1563 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
1572 #if _POSIX_SAVED_IDS
1573 /* Drop privileges */
1574 status = seteuid (getuid ());
1577 fprintf (stderr, "Temporarily dropping privileges "
1578 "failed: %s\n", strerror (errno));
1579 exit (EXIT_FAILURE);
1586 #if _POSIX_SAVED_IDS
1587 /* Regain privileges */
1588 status = seteuid (saved_set_uid);
1591 fprintf (stderr, "Temporarily re-gaining privileges "
1592 "failed: %s\n", strerror (errno));
1593 exit (EXIT_FAILURE);
1597 for (i = optind; i < argc; i++)
1599 if (ping_host_add (ping, argv[i]) < 0)
1601 const char *errmsg = ping_get_error (ping);
1603 fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
1612 /* Permanently drop root privileges if we're setuid-root. */
1613 status = setuid (getuid ());
1616 fprintf (stderr, "Dropping privileges failed: %s\n",
1618 exit (EXIT_FAILURE);
1621 #if _POSIX_SAVED_IDS
1622 saved_set_uid = (uid_t) -1;
1625 ping_initialize_contexts (ping);
1630 memset (&sigint_action, '\0', sizeof (sigint_action));
1631 sigint_action.sa_handler = sigint_handler;
1632 if (sigaction (SIGINT, &sigint_action, NULL) < 0)
1634 perror ("sigaction");
1638 pre_loop_hook (ping);
1640 while (opt_count != 0)
1645 if (gettimeofday (&tv_begin, NULL) < 0)
1647 perror ("gettimeofday");
1651 status = ping_send (ping);
1652 if (status == -EINTR)
1656 else if (status < 0)
1658 fprintf (stderr, "ping_send failed: %s\n",
1659 ping_get_error (ping));
1664 for (iter = ping_iterator_get (ping);
1666 iter = ping_iterator_next (iter))
1668 update_host_hook (iter, index);
1672 pre_sleep_hook (ping);
1674 /* Don't sleep in the last iteration */
1678 if (gettimeofday (&tv_end, NULL) < 0)
1680 perror ("gettimeofday");
1684 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
1686 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
1687 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
1695 perror ("nanosleep");
1700 post_sleep_hook (ping);
1704 } /* while (opt_count != 0) */
1706 /* Returns the number of failed hosts according to -Z. */
1707 status = post_loop_hook (ping);
1709 ping_destroy (ping);
1712 exit (EXIT_SUCCESS);
1719 } /* }}} int main */
1721 /* vim: set fdm=marker : */