Code

autodetect unicode, and fallback to ACS scancodes on failure
[liboping.git] / src / oping.c
1 /**
2  * Object oriented C module to send ICMP and ICMPv6 `echo's.
3  * Copyright (C) 2006-2011  Florian octo Forster <ff at octo.it>
4  *
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
8  * applicable.
9  *
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.
14  *
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
18  */
20 #if HAVE_CONFIG_H
21 # include <config.h>
22 #endif
24 #if STDC_HEADERS
25 # include <stdlib.h>
26 # include <stdio.h>
27 # include <string.h>
28 # include <stdint.h>
29 # include <inttypes.h>
30 # include <errno.h>
31 # include <assert.h>
32 #else
33 # error "You don't have the standard C99 header files installed"
34 #endif /* STDC_HEADERS */
36 #if HAVE_UNISTD_H
37 # include <unistd.h>
38 #endif
40 #if HAVE_MATH_H
41 # include <math.h>
42 #endif
44 #if TIME_WITH_SYS_TIME
45 # include <sys/time.h>
46 # include <time.h>
47 #else
48 # if HAVE_SYS_TIME_H
49 #  include <sys/time.h>
50 # else
51 #  include <time.h>
52 # endif
53 #endif
55 #if HAVE_SYS_SOCKET_H
56 # include <sys/socket.h>
57 #endif
58 #if HAVE_NETINET_IN_H
59 # include <netinet/in.h>
60 #endif
61 #if HAVE_NETINET_IP_H
62 # include <netinet/ip.h>
63 #endif
65 #if HAVE_NETDB_H
66 # include <netdb.h> /* NI_MAXHOST */
67 #endif
69 #if HAVE_SIGNAL_H
70 # include <signal.h>
71 #endif
73 #if HAVE_SYS_TYPES_H
74 #include <sys/types.h>
75 #endif
77 #include <locale.h>
79 #if USE_NCURSES
80 # define NCURSES_OPAQUE 1
81 /* http://newsgroups.derkeiler.com/Archive/Rec/rec.games.roguelike.development/2010-09/msg00050.html */
82 # define _X_OPEN_SOURCE_EXTENDED
83 # include <ncursesw/ncurses.h>
85 /* some evilness: ncurses knows how to detect unicode, but won't
86    expose it, yet there's this function that does what we want, so we
87    steal it away from it */
88 extern int    _nc_unicode_locale(void);
90 # define OPING_GREEN 1
91 # define OPING_YELLOW 2
92 # define OPING_RED 3
93 # define OPING_GREEN_HIST 4
94 # define OPING_YELLOW_HIST 5
95 # define OPING_RED_HIST 6
97 static char const * const hist_symbols_utf8[] = {
98         "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█" };
99 static size_t const hist_symbols_utf8_num = sizeof (hist_symbols_utf8)
100         / sizeof (hist_symbols_utf8[0]);
102 /* scancodes for 6 levels of horizontal bars, ncurses-specific */
103 /* those are not the usual constants because those are not constant */
104 static int const hist_symbols_acs[] = {
105         115, /* ACS_S9 "⎽" */
106         114, /* ACS_S7 "⎼" */
107         113, /* ACS_S5 "─" */
108         112, /* ACS_S3 "⎻" */
109         111  /* ACS_S1 "⎺" */
110 };
111 static size_t const hist_symbols_acs_num = sizeof (hist_symbols_acs)
112         / sizeof (hist_symbols_acs[0]);
114 /* use different colors without a background for scancodes */
115 static int const hist_colors_utf8[] = {
116         OPING_GREEN_HIST, OPING_YELLOW_HIST, OPING_RED_HIST };
117 static int const hist_colors_acs[] = {
118         OPING_GREEN, OPING_YELLOW, OPING_RED };
119 /* assuming that both arrays are the same size */
120 static size_t const hist_colors_num = sizeof (hist_colors_utf8)
121         / sizeof (hist_colors_utf8[0]);
122 #endif
124 #include "oping.h"
126 #ifndef _POSIX_SAVED_IDS
127 # define _POSIX_SAVED_IDS 0
128 #endif
130 /* Remove GNU specific __attribute__ settings when using another compiler */
131 #if !__GNUC__
132 # define __attribute__(x) /**/
133 #endif
135 typedef struct ping_context
137         char host[NI_MAXHOST];
138         char addr[NI_MAXHOST];
140         int index;
141         int req_sent;
142         int req_rcvd;
144         double latency_min;
145         double latency_max;
146         double latency_total;
147         double latency_total_square;
149 #if USE_NCURSES
150         WINDOW *window;
151 #endif
152 } ping_context_t;
154 static double  opt_interval   = 1.0;
155 static int     opt_addrfamily = PING_DEF_AF;
156 static char   *opt_srcaddr    = NULL;
157 static char   *opt_device     = NULL;
158 static char   *opt_filename   = NULL;
159 static int     opt_count      = -1;
160 static int     opt_send_ttl   = 64;
161 static uint8_t opt_send_qos   = 0;
163 static int host_num = 0;
165 #if USE_NCURSES
166 static WINDOW *main_win = NULL;
167 #endif
169 static void sigint_handler (int signal) /* {{{ */
171         /* Make compiler happy */
172         signal = 0;
173         /* Exit the loop */
174         opt_count = 0;
175 } /* }}} void sigint_handler */
177 static ping_context_t *context_create (void) /* {{{ */
179         ping_context_t *ret;
181         if ((ret = malloc (sizeof (ping_context_t))) == NULL)
182                 return (NULL);
184         memset (ret, '\0', sizeof (ping_context_t));
186         ret->latency_min   = -1.0;
187         ret->latency_max   = -1.0;
188         ret->latency_total = 0.0;
189         ret->latency_total_square = 0.0;
191 #if USE_NCURSES
192         ret->window = NULL;
193 #endif
195         return (ret);
196 } /* }}} ping_context_t *context_create */
198 static void context_destroy (ping_context_t *context) /* {{{ */
200         if (context == NULL)
201                 return;
203 #if USE_NCURSES
204         if (context->window != NULL)
205         {
206                 delwin (context->window);
207                 context->window = NULL;
208         }
209 #endif
211         free (context);
212 } /* }}} void context_destroy */
214 static double context_get_average (ping_context_t *ctx) /* {{{ */
216         double num_total;
218         if (ctx == NULL)
219                 return (-1.0);
221         if (ctx->req_rcvd < 1)
222                 return (-0.0);
224         num_total = (double) ctx->req_rcvd;
225         return (ctx->latency_total / num_total);
226 } /* }}} double context_get_average */
228 static double context_get_stddev (ping_context_t *ctx) /* {{{ */
230         double num_total;
232         if (ctx == NULL)
233                 return (-1.0);
235         if (ctx->req_rcvd < 1)
236                 return (-0.0);
237         else if (ctx->req_rcvd < 2)
238                 return (0.0);
240         num_total = (double) ctx->req_rcvd;
241         return (sqrt (((num_total * ctx->latency_total_square)
242                                         - (ctx->latency_total * ctx->latency_total))
243                                 / (num_total * (num_total - 1.0))));
244 } /* }}} double context_get_stddev */
246 static double context_get_packet_loss (const ping_context_t *ctx) /* {{{ */
248         if (ctx == NULL)
249                 return (-1.0);
251         if (ctx->req_sent < 1)
252                 return (0.0);
254         return (100.0 * (ctx->req_sent - ctx->req_rcvd)
255                         / ((double) ctx->req_sent));
256 } /* }}} double context_get_packet_loss */
258 static int ping_initialize_contexts (pingobj_t *ping) /* {{{ */
260         pingobj_iter_t *iter;
261         int index;
263         if (ping == NULL)
264                 return (EINVAL);
266         index = 0;
267         for (iter = ping_iterator_get (ping);
268                         iter != NULL;
269                         iter = ping_iterator_next (iter))
270         {
271                 ping_context_t *context;
272                 size_t buffer_size;
274                 context = context_create ();
275                 context->index = index;
277                 buffer_size = sizeof (context->host);
278                 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
280                 buffer_size = sizeof (context->addr);
281                 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
283                 ping_iterator_set_context (iter, (void *) context);
285                 index++;
286         }
288         return (0);
289 } /* }}} int ping_initialize_contexts */
291 static void usage_exit (const char *name, int status) /* {{{ */
293         fprintf (stderr, "Usage: %s [OPTIONS] "
294                                 "-f filename | host [host [host ...]]\n"
296                         "\nAvailable options:\n"
297                         "  -4|-6        force the use of IPv4 or IPv6\n"
298                         "  -c count     number of ICMP packets to send\n"
299                         "  -i interval  interval with which to send ICMP packets\n"
300                         "  -t ttl       time to live for each ICMP packet\n"
301                         "  -Q qos       Quality of Service (QoS) of outgoing packets\n"
302                         "               Use \"-Q help\" for a list of valid options.\n"
303                         "  -I srcaddr   source address\n"
304                         "  -D device    outgoing interface name\n"
305                         "  -f filename  filename to read hosts from\n"
307                         "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
308                         "by Florian octo Forster <octo@verplant.org>\n"
309                         "for contributions see `AUTHORS'\n",
310                         name);
311         exit (status);
312 } /* }}} void usage_exit */
314 __attribute__((noreturn))
315 static void usage_qos_exit (const char *arg, int status) /* {{{ */
317         if (arg != 0)
318                 fprintf (stderr, "Invalid QoS argument: \"%s\"\n\n", arg);
320         fprintf (stderr, "Valid QoS arguments (option \"-Q\") are:\n"
321                         "\n"
322                         "  Differentiated Services (IPv4 and IPv6, RFC 2474)\n"
323                         "\n"
324                         "    be                     Best Effort (BE, default PHB).\n"
325                         "    ef                     Expedited Forwarding (EF) PHB group (RFC 3246).\n"
326                         "                           (low delay, low loss, low jitter)\n"
327                         "    va                     Voice Admit (VA) DSCP (RFC 5865).\n"
328                         "                           (capacity-admitted traffic)\n"
329                         "    af[1-4][1-3]           Assured Forwarding (AF) PHB group (RFC 2597).\n"
330                         "                           For example: \"af12\" (class 1, precedence 2)\n"
331                         "    cs[0-7]                Class Selector (CS) PHB group (RFC 2474).\n"
332                         "                           For example: \"cs1\" (priority traffic)\n"
333                         "\n"
334                         "  Type of Service (IPv4, RFC 1349, obsolete)\n"
335                         "\n"
336                         "    lowdelay     (%#04x)    minimize delay\n"
337                         "    throughput   (%#04x)    maximize throughput\n"
338                         "    reliability  (%#04x)    maximize reliability\n"
339                         "    mincost      (%#04x)    minimize monetary cost\n"
340                         "\n"
341                         "  Specify manually\n"
342                         "\n"
343                         "    0x00 - 0xff            Hexadecimal numeric specification.\n"
344                         "       0 -  255            Decimal numeric specification.\n"
345                         "\n",
346                         (unsigned int) IPTOS_LOWDELAY,
347                         (unsigned int) IPTOS_THROUGHPUT,
348                         (unsigned int) IPTOS_RELIABILITY,
349                         (unsigned int) IPTOS_MINCOST);
351         exit (status);
352 } /* }}} void usage_qos_exit */
354 static int set_opt_send_qos (const char *opt) /* {{{ */
356         if (opt == NULL)
357                 return (EINVAL);
359         if (strcasecmp ("help", opt) == 0)
360                 usage_qos_exit (/* arg = */ NULL, /* status = */ EXIT_SUCCESS);
361         /* DiffServ (RFC 2474): */
362         /* - Best effort (BE) */
363         else if (strcasecmp ("be", opt) == 0)
364                 opt_send_qos = 0;
365         /* - Expedited Forwarding (EF, RFC 3246) */
366         else if (strcasecmp ("ef", opt) == 0)
367                 opt_send_qos = 0xB8; /* == 0x2E << 2 */
368         /* - Voice Admit (VA, RFC 5865) */
369         else if (strcasecmp ("va", opt) == 0)
370                 opt_send_qos = 0xB0; /* == 0x2D << 2 */
371         /* - Assured Forwarding (AF, RFC 2597) */
372         else if ((strncasecmp ("af", opt, strlen ("af")) == 0)
373                         && (strlen (opt) == 4))
374         {
375                 uint8_t dscp;
376                 uint8_t class = 0;
377                 uint8_t prec = 0;
379                 /* There are four classes, AF1x, AF2x, AF3x, and AF4x. */
380                 if (opt[2] == '1')
381                         class = 1;
382                 else if (opt[2] == '2')
383                         class = 2;
384                 else if (opt[2] == '3')
385                         class = 3;
386                 else if (opt[2] == '4')
387                         class = 4;
388                 else
389                         usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
391                 /* In each class, there are three precedences, AFx1, AFx2, and AFx3 */
392                 if (opt[3] == '1')
393                         prec = 1;
394                 else if (opt[3] == '2')
395                         prec = 2;
396                 else if (opt[3] == '3')
397                         prec = 3;
398                 else
399                         usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
401                 dscp = (8 * class) + (2 * prec);
402                 /* The lower two bits are used for Explicit Congestion Notification (ECN) */
403                 opt_send_qos = dscp << 2;
404         }
405         /* - Class Selector (CS) */
406         else if ((strncasecmp ("cs", opt, strlen ("cs")) == 0)
407                         && (strlen (opt) == 3))
408         {
409                 uint8_t class;
411                 if ((opt[2] < '0') || (opt[2] > '7'))
412                         usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
414                 /* Not exactly legal by the C standard, but I don't know of any
415                  * system not supporting this hack. */
416                 class = ((uint8_t) opt[2]) - ((uint8_t) '0');
417                 opt_send_qos = class << 5;
418         }
419         /* Type of Service (RFC 1349) */
420         else if (strcasecmp ("lowdelay", opt) == 0)
421                 opt_send_qos = IPTOS_LOWDELAY;
422         else if (strcasecmp ("throughput", opt) == 0)
423                 opt_send_qos = IPTOS_THROUGHPUT;
424         else if (strcasecmp ("reliability", opt) == 0)
425                 opt_send_qos = IPTOS_RELIABILITY;
426         else if (strcasecmp ("mincost", opt) == 0)
427                 opt_send_qos = IPTOS_MINCOST;
428         /* Numeric value */
429         else
430         {
431                 unsigned long value;
432                 char *endptr;
434                 errno = 0;
435                 endptr = NULL;
436                 value = strtoul (opt, &endptr, /* base = */ 0);
437                 if ((errno != 0) || (endptr == opt)
438                                 || (endptr == NULL) || (*endptr != 0)
439                                 || (value > 0xff))
440                         usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
441                 
442                 opt_send_qos = (uint8_t) value;
443         }
445         return (0);
446 } /* }}} int set_opt_send_qos */
448 static char *format_qos (uint8_t qos, char *buffer, size_t buffer_size) /* {{{ */
450         uint8_t dscp;
451         uint8_t ecn;
452         char *dscp_str;
453         char *ecn_str;
455         dscp = qos >> 2;
456         ecn = qos & 0x03;
458         switch (dscp)
459         {
460                 case 0x00: dscp_str = "be";  break;
461                 case 0x2e: dscp_str = "ef";  break;
462                 case 0x2d: dscp_str = "va";  break;
463                 case 0x0a: dscp_str = "af11"; break;
464                 case 0x0c: dscp_str = "af12"; break;
465                 case 0x0e: dscp_str = "af13"; break;
466                 case 0x12: dscp_str = "af21"; break;
467                 case 0x14: dscp_str = "af22"; break;
468                 case 0x16: dscp_str = "af23"; break;
469                 case 0x1a: dscp_str = "af31"; break;
470                 case 0x1c: dscp_str = "af32"; break;
471                 case 0x1e: dscp_str = "af33"; break;
472                 case 0x22: dscp_str = "af41"; break;
473                 case 0x24: dscp_str = "af42"; break;
474                 case 0x26: dscp_str = "af43"; break;
475                 case 0x08: dscp_str = "cs1";  break;
476                 case 0x10: dscp_str = "cs2";  break;
477                 case 0x18: dscp_str = "cs3";  break;
478                 case 0x20: dscp_str = "cs4";  break;
479                 case 0x28: dscp_str = "cs5";  break;
480                 case 0x30: dscp_str = "cs6";  break;
481                 case 0x38: dscp_str = "cs7";  break;
482                 default:   dscp_str = NULL;
483         }
485         switch (ecn)
486         {
487                 case 0x01: ecn_str = ",ecn(1)"; break;
488                 case 0x02: ecn_str = ",ecn(0)"; break;
489                 case 0x03: ecn_str = ",ce"; break;
490                 default:   ecn_str = "";
491         }
493         if (dscp_str == NULL)
494                 snprintf (buffer, buffer_size, "0x%02x%s", dscp, ecn_str);
495         else
496                 snprintf (buffer, buffer_size, "%s%s", dscp_str, ecn_str);
497         buffer[buffer_size - 1] = 0;
499         return (buffer);
500 } /* }}} char *format_qos */
502 static int read_options (int argc, char **argv) /* {{{ */
504         int optchar;
506         while (1)
507         {
508                 optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:");
510                 if (optchar == -1)
511                         break;
513                 switch (optchar)
514                 {
515                         case '4':
516                         case '6':
517                                 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
518                                 break;
520                         case 'c':
521                                 {
522                                         int new_count;
523                                         new_count = atoi (optarg);
524                                         if (new_count > 0)
525                                                 opt_count = new_count;
526                                         else
527                                                 fprintf(stderr, "Ignoring invalid count: %s\n",
528                                                                 optarg);
529                                 }
530                                 break;
532                         case 'f':
533                                 {
534                                         if (opt_filename != NULL)
535                                                 free (opt_filename);
536                                         opt_filename = strdup (optarg);
537                                 }
538                                 break;
540                         case 'i':
541                                 {
542                                         double new_interval;
543                                         new_interval = atof (optarg);
544                                         if (new_interval < 0.001)
545                                                 fprintf (stderr, "Ignoring invalid interval: %s\n",
546                                                                 optarg);
547                                         else
548                                                 opt_interval = new_interval;
549                                 }
550                                 break;
551                         case 'I':
552                                 {
553                                         if (opt_srcaddr != NULL)
554                                                 free (opt_srcaddr);
555                                         opt_srcaddr = strdup (optarg);
556                                 }
557                                 break;
559                         case 'D':
560                                 opt_device = optarg;
561                                 break;
563                         case 't':
564                         {
565                                 int new_send_ttl;
566                                 new_send_ttl = atoi (optarg);
567                                 if ((new_send_ttl > 0) && (new_send_ttl < 256))
568                                         opt_send_ttl = new_send_ttl;
569                                 else
570                                         fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
571                                                         optarg);
572                                 break;
573                         }
575                         case 'Q':
576                                 set_opt_send_qos (optarg);
577                                 break;
579                         case 'h':
580                                 usage_exit (argv[0], 0);
581                                 break;
582                         default:
583                                 usage_exit (argv[0], 1);
584                 }
585         }
587         return (optind);
588 } /* }}} read_options */
590 static void time_normalize (struct timespec *ts) /* {{{ */
592         while (ts->tv_nsec < 0)
593         {
594                 if (ts->tv_sec == 0)
595                 {
596                         ts->tv_nsec = 0;
597                         return;
598                 }
600                 ts->tv_sec  -= 1;
601                 ts->tv_nsec += 1000000000;
602         }
604         while (ts->tv_nsec >= 1000000000)
605         {
606                 ts->tv_sec  += 1;
607                 ts->tv_nsec -= 1000000000;
608         }
609 } /* }}} void time_normalize */
611 static void time_calc (struct timespec *ts_dest, /* {{{ */
612                 const struct timespec *ts_int,
613                 const struct timeval  *tv_begin,
614                 const struct timeval  *tv_end)
616         ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
617         ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
618         time_normalize (ts_dest);
620         /* Assure that `(begin + interval) > end'.
621          * This may seem overly complicated, but `tv_sec' is of type `time_t'
622          * which may be `unsigned. *sigh* */
623         if ((tv_end->tv_sec > ts_dest->tv_sec)
624                         || ((tv_end->tv_sec == ts_dest->tv_sec)
625                                 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
626         {
627                 ts_dest->tv_sec  = 0;
628                 ts_dest->tv_nsec = 0;
629                 return;
630         }
632         ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
633         ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
634         time_normalize (ts_dest);
635 } /* }}} void time_calc */
637 #if USE_NCURSES
638 static int update_prettyping_graph (ping_context_t *ctx, /* {{{ */
639                 double latency, unsigned int sequence)
641         int color = OPING_RED;
642         char const *symbol = "!";
643         int symbolc = '!';
644         size_t hist_symbols_num;
645         size_t index_symbols;
647         int x_max;
648         int x_pos;
650         x_max = getmaxx (ctx->window);
651         x_pos = ((sequence - 1) % (x_max - 4)) + 2;
653         if (_nc_unicode_locale())
654         {
655                 hist_symbols_num = hist_symbols_utf8_num;
656         }
657         else {
658                 hist_symbols_num = hist_symbols_acs_num;
659         }
661         if (latency >= 0.0)
662         {
663                 double ratio;
664                 size_t intensity;
665                 size_t index_colors;
667                 ratio = latency / PING_DEF_TTL;
668                 if (ratio > 1) {
669                         ratio = 1.0;
670                 }
672                 intensity = (size_t) ((ratio * hist_symbols_num
673                                         * hist_colors_num) - 1);
675                 index_colors = intensity / hist_symbols_num;
676                 assert (index_colors < hist_colors_num);
678                 index_symbols = intensity % hist_symbols_num;
679                 if (_nc_unicode_locale())
680                 {
681                         color = hist_colors_utf8[index_colors];
682                         symbol = hist_symbols_utf8[index_symbols];
683                 }
684                 else
685                 {
686                         color = hist_colors_acs[index_colors];
687                         symbolc = hist_symbols_acs[index_symbols] | A_ALTCHARSET;
688                 }
689         }
690         else /* if (!(latency >= 0.0)) */
691                 wattron (ctx->window, A_BOLD);
693         wattron (ctx->window, COLOR_PAIR(color));
694         if (_nc_unicode_locale())
695         {
696                 mvwprintw (ctx->window,
697                            /* y = */ 3,
698                            /* x = */ x_pos,
699                            symbol);
700         }
701         else {
702                 mvwaddch (ctx->window,
703                           /* y = */ 3,
704                           /* x = */ x_pos,
705                           symbolc);
706         }
707         wattroff (ctx->window, COLOR_PAIR(color));
709         /* Use negation here to handle NaN correctly. */
710         if (!(latency >= 0.0))
711                 wattroff (ctx->window, A_BOLD);
713         wprintw (ctx->window, " ");
714         return (0);
715 } /* }}} int update_prettyping_graph */
717 static int update_stats_from_context (ping_context_t *ctx, pingobj_iter_t *iter) /* {{{ */
719         double latency = -1.0;
720         size_t buffer_len = sizeof (latency);
722         ping_iterator_get_info (iter, PING_INFO_LATENCY,
723                         &latency, &buffer_len);
725         unsigned int sequence = 0;
726         buffer_len = sizeof (sequence);
727         ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
728                         &sequence, &buffer_len);
731         if ((ctx == NULL) || (ctx->window == NULL))
732                 return (EINVAL);
734         /* werase (ctx->window); */
736         box (ctx->window, 0, 0);
737         wattron (ctx->window, A_BOLD);
738         mvwprintw (ctx->window, /* y = */ 0, /* x = */ 5,
739                         " %s ", ctx->host);
740         wattroff (ctx->window, A_BOLD);
741         wprintw (ctx->window, "ping statistics ");
742         mvwprintw (ctx->window, /* y = */ 1, /* x = */ 2,
743                         "%i packets transmitted, %i received, %.2f%% packet "
744                         "loss, time %.1fms",
745                         ctx->req_sent, ctx->req_rcvd,
746                         context_get_packet_loss (ctx),
747                         ctx->latency_total);
748         if (ctx->req_rcvd != 0)
749         {
750                 double average;
751                 double deviation;
753                 average = context_get_average (ctx);
754                 deviation = context_get_stddev (ctx);
755                         
756                 mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
757                                 "rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms",
758                                 ctx->latency_min,
759                                 average,
760                                 ctx->latency_max,
761                                 deviation);
762         }
764         if (has_colors () == TRUE)
765                 update_prettyping_graph (ctx, latency, sequence);
767         wrefresh (ctx->window);
769         return (0);
770 } /* }}} int update_stats_from_context */
772 static int on_resize (pingobj_t *ping) /* {{{ */
774         pingobj_iter_t *iter;
775         int width = 0;
776         int height = 0;
777         int main_win_height;
779         getmaxyx (stdscr, height, width);
780         if ((height < 1) || (width < 1))
781                 return (EINVAL);
783         main_win_height = height - (5 * host_num);
784         wresize (main_win, main_win_height, /* width = */ width);
785         /* Allow scrolling */
786         scrollok (main_win, TRUE);
787         /* wsetscrreg (main_win, 0, main_win_height - 1); */
788         /* Allow hardware accelerated scrolling. */
789         idlok (main_win, TRUE);
790         wrefresh (main_win);
792         for (iter = ping_iterator_get (ping);
793                         iter != NULL;
794                         iter = ping_iterator_next (iter))
795         {
796                 ping_context_t *context;
798                 context = ping_iterator_get_context (iter);
799                 if (context == NULL)
800                         continue;
802                 if (context->window != NULL)
803                 {
804                         delwin (context->window);
805                         context->window = NULL;
806                 }
807                 context->window = newwin (/* height = */ 5,
808                                 /* width = */ width,
809                                 /* y = */ main_win_height + (5 * context->index),
810                                 /* x = */ 0);
811         }
813         return (0);
814 } /* }}} */
816 static int check_resize (pingobj_t *ping) /* {{{ */
818         int need_resize = 0;
820         while (42)
821         {
822                 int key = wgetch (stdscr);
823                 if (key == ERR)
824                         break;
825                 else if (key == KEY_RESIZE)
826                         need_resize = 1;
827         }
829         if (need_resize)
830                 return (on_resize (ping));
831         else
832                 return (0);
833 } /* }}} int check_resize */
835 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
837         pingobj_iter_t *iter;
838         int width = 0;
839         int height = 0;
840         int main_win_height;
842         initscr ();
843         cbreak ();
844         noecho ();
845         nodelay (stdscr, TRUE);
847         getmaxyx (stdscr, height, width);
848         if ((height < 1) || (width < 1))
849                 return (EINVAL);
851         if (has_colors () == TRUE)
852         {
853                 start_color ();
854                 init_pair (OPING_GREEN,  COLOR_GREEN,  /* default = */ 0);
855                 init_pair (OPING_YELLOW, COLOR_YELLOW, /* default = */ 0);
856                 init_pair (OPING_RED,    COLOR_RED,    /* default = */ 0);
857                 init_pair (OPING_GREEN_HIST,  COLOR_GREEN,  COLOR_BLACK);
858                 init_pair (OPING_YELLOW_HIST, COLOR_YELLOW, COLOR_GREEN);
859                 init_pair (OPING_RED_HIST,    COLOR_RED,    COLOR_YELLOW);
860         }
862         main_win_height = height - (5 * host_num);
863         main_win = newwin (/* height = */ main_win_height,
864                         /* width = */ width,
865                         /* y = */ 0, /* x = */ 0);
866         /* Allow scrolling */
867         scrollok (main_win, TRUE);
868         /* wsetscrreg (main_win, 0, main_win_height - 1); */
869         /* Allow hardware accelerated scrolling. */
870         idlok (main_win, TRUE);
871         wmove (main_win, /* y = */ main_win_height - 1, /* x = */ 0);
872         wrefresh (main_win);
874         for (iter = ping_iterator_get (ping);
875                         iter != NULL;
876                         iter = ping_iterator_next (iter))
877         {
878                 ping_context_t *context;
880                 context = ping_iterator_get_context (iter);
881                 if (context == NULL)
882                         continue;
884                 if (context->window != NULL)
885                 {
886                         delwin (context->window);
887                         context->window = NULL;
888                 }
889                 context->window = newwin (/* height = */ 5,
890                                 /* width = */ width,
891                                 /* y = */ main_win_height + (5 * context->index),
892                                 /* x = */ 0);
893         }
896         /* Don't know what good this does exactly, but without this code
897          * "check_resize" will be called right after startup and *somehow*
898          * this leads to display errors. If we purge all initial characters
899          * here, the problem goes away. "wgetch" is non-blocking due to
900          * "nodelay" (see above). */
901         while (wgetch (stdscr) != ERR)
902         {
903                 /* eat up characters */;
904         }
906         return (0);
907 } /* }}} int pre_loop_hook */
909 static int pre_sleep_hook (pingobj_t *ping) /* {{{ */
911         return (check_resize (ping));
912 } /* }}} int pre_sleep_hook */
914 static int post_sleep_hook (pingobj_t *ping) /* {{{ */
916         return (check_resize (ping));
917 } /* }}} int pre_sleep_hook */
918 #else /* if !USE_NCURSES */
919 static int pre_loop_hook (pingobj_t *ping) /* {{{ */
921         pingobj_iter_t *iter;
923         for (iter = ping_iterator_get (ping);
924                         iter != NULL;
925                         iter = ping_iterator_next (iter))
926         {
927                 ping_context_t *ctx;
928                 size_t buffer_size;
930                 ctx = ping_iterator_get_context (iter);
931                 if (ctx == NULL)
932                         continue;
934                 buffer_size = 0;
935                 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
937                 printf ("PING %s (%s) %zu bytes of data.\n",
938                                 ctx->host, ctx->addr, buffer_size);
939         }
941         return (0);
942 } /* }}} int pre_loop_hook */
944 static int pre_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
946         fflush (stdout);
948         return (0);
949 } /* }}} int pre_sleep_hook */
951 static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
953         return (0);
954 } /* }}} int post_sleep_hook */
955 #endif
957 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
958                 __attribute__((unused)) int index)
960         double          latency;
961         unsigned int    sequence;
962         int             recv_ttl;
963         uint8_t         recv_qos;
964         char            recv_qos_str[16];
965         size_t          buffer_len;
966         size_t          data_len;
967         ping_context_t *context;
969         latency = -1.0;
970         buffer_len = sizeof (latency);
971         ping_iterator_get_info (iter, PING_INFO_LATENCY,
972                         &latency, &buffer_len);
974         sequence = 0;
975         buffer_len = sizeof (sequence);
976         ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
977                         &sequence, &buffer_len);
979         recv_ttl = -1;
980         buffer_len = sizeof (recv_ttl);
981         ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
982                         &recv_ttl, &buffer_len);
984         recv_qos = 0;
985         buffer_len = sizeof (recv_qos);
986         ping_iterator_get_info (iter, PING_INFO_RECV_QOS,
987                         &recv_qos, &buffer_len);
989         data_len = 0;
990         ping_iterator_get_info (iter, PING_INFO_DATA,
991                         NULL, &data_len);
993         context = (ping_context_t *) ping_iterator_get_context (iter);
995 #if USE_NCURSES
996 # define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
997 #else
998 # define HOST_PRINTF(...) printf(__VA_ARGS__)
999 #endif
1001         context->req_sent++;
1002         if (latency > 0.0)
1003         {
1004                 context->req_rcvd++;
1005                 context->latency_total += latency;
1006                 context->latency_total_square += (latency * latency);
1008                 if ((context->latency_max < 0.0) || (context->latency_max < latency))
1009                         context->latency_max = latency;
1010                 if ((context->latency_min < 0.0) || (context->latency_min > latency))
1011                         context->latency_min = latency;
1013 #if USE_NCURSES
1014                 if (has_colors () == TRUE)
1015                 {
1016                         int color = OPING_GREEN;
1017                         double average = context_get_average (context);
1018                         double stddev = context_get_stddev (context);
1020                         if ((latency < (average - (2 * stddev)))
1021                                         || (latency > (average + (2 * stddev))))
1022                                 color = OPING_RED;
1023                         else if ((latency < (average - stddev))
1024                                         || (latency > (average + stddev)))
1025                                 color = OPING_YELLOW;
1027                         HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1028                                         data_len, context->host, context->addr,
1029                                         sequence, recv_ttl,
1030                                         format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1031                         if ((recv_qos != 0) || (opt_send_qos != 0))
1032                         {
1033                                 HOST_PRINTF ("qos=%s ",
1034                                                 format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1035                         }
1036                         HOST_PRINTF ("time=");
1037                         wattron (main_win, COLOR_PAIR(color));
1038                         HOST_PRINTF ("%.2f", latency);
1039                         wattroff (main_win, COLOR_PAIR(color));
1040                         HOST_PRINTF (" ms\n");
1041                 }
1042                 else
1043                 {
1044 #endif
1045                 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
1046                                 data_len,
1047                                 context->host, context->addr,
1048                                 sequence, recv_ttl);
1049                 if ((recv_qos != 0) || (opt_send_qos != 0))
1050                 {
1051                         HOST_PRINTF ("qos=%s ",
1052                                         format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
1053                 }
1054                 HOST_PRINTF ("time=%.2f ms\n", latency);
1055 #if USE_NCURSES
1056                 }
1057 #endif
1058         }
1059         else
1060         {
1061 #if USE_NCURSES
1062                 if (has_colors () == TRUE)
1063                 {
1064                         HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u ",
1065                                         context->host, context->addr,
1066                                         sequence);
1067                         wattron (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1068                         HOST_PRINTF ("timeout");
1069                         wattroff (main_win, COLOR_PAIR(OPING_RED) | A_BOLD);
1070                         HOST_PRINTF ("\n");
1071                 }
1072                 else
1073                 {
1074 #endif
1075                 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
1076                                 context->host, context->addr,
1077                                 sequence);
1078 #if USE_NCURSES
1079                 }
1080 #endif
1081         }
1083 #if USE_NCURSES
1084         update_stats_from_context (context, iter);
1085         wrefresh (main_win);
1086 #endif
1087 } /* }}} void update_host_hook */
1089 static int post_loop_hook (pingobj_t *ping) /* {{{ */
1091         pingobj_iter_t *iter;
1093 #if USE_NCURSES
1094         endwin ();
1095 #endif
1097         for (iter = ping_iterator_get (ping);
1098                         iter != NULL;
1099                         iter = ping_iterator_next (iter))
1100         {
1101                 ping_context_t *context;
1103                 context = ping_iterator_get_context (iter);
1105                 printf ("\n--- %s ping statistics ---\n"
1106                                 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
1107                                 context->host, context->req_sent, context->req_rcvd,
1108                                 context_get_packet_loss (context),
1109                                 context->latency_total);
1111                 if (context->req_rcvd != 0)
1112                 {
1113                         double average;
1114                         double deviation;
1116                         average = context_get_average (context);
1117                         deviation = context_get_stddev (context);
1119                         printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
1120                                         context->latency_min,
1121                                         average,
1122                                         context->latency_max,
1123                                         deviation);
1124                 }
1126                 ping_iterator_set_context (iter, NULL);
1127                 context_destroy (context);
1128         }
1130         return (0);
1131 } /* }}} int post_loop_hook */
1133 int main (int argc, char **argv) /* {{{ */
1135         pingobj_t      *ping;
1136         pingobj_iter_t *iter;
1138         struct sigaction sigint_action;
1140         struct timeval  tv_begin;
1141         struct timeval  tv_end;
1142         struct timespec ts_wait;
1143         struct timespec ts_int;
1145         int optind;
1146         int i;
1147         int status;
1148 #if _POSIX_SAVED_IDS
1149         uid_t saved_set_uid;
1151         /* Save the old effective user id */
1152         saved_set_uid = geteuid ();
1153         /* Set the effective user ID to the real user ID without changing the
1154          * saved set-user ID */
1155         status = seteuid (getuid ());
1156         if (status != 0)
1157         {
1158                 fprintf (stderr, "Temporarily dropping privileges "
1159                                 "failed: %s\n", strerror (errno));
1160                 exit (EXIT_FAILURE);
1161         }
1162 #endif
1164         setlocale(LC_ALL, "");
1165         optind = read_options (argc, argv);
1167 #if !_POSIX_SAVED_IDS
1168         /* Cannot temporarily drop privileges -> reject every file but "-". */
1169         if ((opt_filename != NULL)
1170                         && (strcmp ("-", opt_filename) != 0)
1171                         && (getuid () != geteuid ()))
1172         {
1173                 fprintf (stderr, "Your real and effective user IDs don't "
1174                                 "match. Reading from a file (option '-f')\n"
1175                                 "is therefore too risky. You can still read "
1176                                 "from STDIN using '-f -' if you like.\n"
1177                                 "Sorry.\n");
1178                 exit (EXIT_FAILURE);
1179         }
1180 #endif
1182         if ((optind >= argc) && (opt_filename == NULL)) {
1183                 usage_exit (argv[0], 1);
1184         }
1186         if ((ping = ping_construct ()) == NULL)
1187         {
1188                 fprintf (stderr, "ping_construct failed\n");
1189                 return (1);
1190         }
1192         if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
1193         {
1194                 fprintf (stderr, "Setting TTL to %i failed: %s\n",
1195                                 opt_send_ttl, ping_get_error (ping));
1196         }
1198         if (ping_setopt (ping, PING_OPT_QOS, &opt_send_qos) != 0)
1199         {
1200                 fprintf (stderr, "Setting TOS to %i failed: %s\n",
1201                                 opt_send_qos, ping_get_error (ping));
1202         }
1204         {
1205                 double temp_sec;
1206                 double temp_nsec;
1208                 temp_nsec = modf (opt_interval, &temp_sec);
1209                 ts_int.tv_sec  = (time_t) temp_sec;
1210                 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
1212                 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
1213         }
1215         if (opt_addrfamily != PING_DEF_AF)
1216                 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
1218         if (opt_srcaddr != NULL)
1219         {
1220                 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
1221                 {
1222                         fprintf (stderr, "Setting source address failed: %s\n",
1223                                         ping_get_error (ping));
1224                 }
1225         }
1227         if (opt_device != NULL)
1228         {
1229                 if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
1230                 {
1231                         fprintf (stderr, "Setting device failed: %s\n",
1232                                         ping_get_error (ping));
1233                 }
1234         }
1236         if (opt_filename != NULL)
1237         {
1238                 FILE *infile;
1239                 char line[256];
1240                 char host[256];
1242                 if (strcmp (opt_filename, "-") == 0)
1243                         /* Open STDIN */
1244                         infile = fdopen(0, "r");
1245                 else
1246                         infile = fopen(opt_filename, "r");
1248                 if (infile == NULL)
1249                 {
1250                         fprintf (stderr, "Opening %s failed: %s\n",
1251                                         (strcmp (opt_filename, "-") == 0)
1252                                         ? "STDIN" : opt_filename,
1253                                         strerror(errno));
1254                         return (1);
1255                 }
1257 #if _POSIX_SAVED_IDS
1258                 /* Regain privileges */
1259                 status = seteuid (saved_set_uid);
1260                 if (status != 0)
1261                 {
1262                         fprintf (stderr, "Temporarily re-gaining privileges "
1263                                         "failed: %s\n", strerror (errno));
1264                         exit (EXIT_FAILURE);
1265                 }
1266 #endif
1268                 while (fgets(line, sizeof(line), infile))
1269                 {
1270                         /* Strip whitespace */
1271                         if (sscanf(line, "%s", host) != 1)
1272                                 continue;
1274                         if ((host[0] == 0) || (host[0] == '#'))
1275                                 continue;
1277                         if (ping_host_add(ping, host) < 0)
1278                         {
1279                                 const char *errmsg = ping_get_error (ping);
1281                                 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
1282                                 continue;
1283                         }
1284                         else
1285                         {
1286                                 host_num++;
1287                         }
1288                 }
1290 #if _POSIX_SAVED_IDS
1291                 /* Drop privileges */
1292                 status = seteuid (getuid ());
1293                 if (status != 0)
1294                 {
1295                         fprintf (stderr, "Temporarily dropping privileges "
1296                                         "failed: %s\n", strerror (errno));
1297                         exit (EXIT_FAILURE);
1298                 }
1299 #endif
1301                 fclose(infile);
1302         }
1304 #if _POSIX_SAVED_IDS
1305         /* Regain privileges */
1306         status = seteuid (saved_set_uid);
1307         if (status != 0)
1308         {
1309                 fprintf (stderr, "Temporarily re-gaining privileges "
1310                                 "failed: %s\n", strerror (errno));
1311                 exit (EXIT_FAILURE);
1312         }
1313 #endif
1315         for (i = optind; i < argc; i++)
1316         {
1317                 if (ping_host_add (ping, argv[i]) < 0)
1318                 {
1319                         const char *errmsg = ping_get_error (ping);
1321                         fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
1322                         continue;
1323                 }
1324                 else
1325                 {
1326                         host_num++;
1327                 }
1328         }
1330         /* Permanently drop root privileges if we're setuid-root. */
1331         status = setuid (getuid ());
1332         if (status != 0)
1333         {
1334                 fprintf (stderr, "Dropping privileges failed: %s\n",
1335                                 strerror (errno));
1336                 exit (EXIT_FAILURE);
1337         }
1339 #if _POSIX_SAVED_IDS
1340         saved_set_uid = (uid_t) -1;
1341 #endif
1343         ping_initialize_contexts (ping);
1345         if (i == 0)
1346                 return (1);
1348         memset (&sigint_action, '\0', sizeof (sigint_action));
1349         sigint_action.sa_handler = sigint_handler;
1350         if (sigaction (SIGINT, &sigint_action, NULL) < 0)
1351         {
1352                 perror ("sigaction");
1353                 return (1);
1354         }
1356         pre_loop_hook (ping);
1358         while (opt_count != 0)
1359         {
1360                 int index;
1361                 int status;
1363                 if (gettimeofday (&tv_begin, NULL) < 0)
1364                 {
1365                         perror ("gettimeofday");
1366                         return (1);
1367                 }
1369                 if (ping_send (ping) < 0)
1370                 {
1371                         fprintf (stderr, "ping_send failed: %s\n",
1372                                         ping_get_error (ping));
1373                         return (1);
1374                 }
1376                 index = 0;
1377                 for (iter = ping_iterator_get (ping);
1378                                 iter != NULL;
1379                                 iter = ping_iterator_next (iter))
1380                 {
1381                         update_host_hook (iter, index);
1382                         index++;
1383                 }
1385                 pre_sleep_hook (ping);
1387                 /* Don't sleep in the last iteration */
1388                 if (opt_count == 1)
1389                         break;
1391                 if (gettimeofday (&tv_end, NULL) < 0)
1392                 {
1393                         perror ("gettimeofday");
1394                         return (1);
1395                 }
1397                 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
1399                 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
1400                 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
1401                 {
1402                         if (errno != EINTR)
1403                         {
1404                                 perror ("nanosleep");
1405                                 break;
1406                         }
1407                         else if (opt_count == 0)
1408                         {
1409                                 /* sigint */
1410                                 break;
1411                         }
1412                 }
1414                 post_sleep_hook (ping);
1416                 if (opt_count > 0)
1417                         opt_count--;
1418         } /* while (opt_count != 0) */
1420         post_loop_hook (ping);
1422         ping_destroy (ping);
1424         return (0);
1425 } /* }}} int main */
1427 /* vim: set fdm=marker : */