2 * Object oriented C module to send ICMP and ICMPv6 `echo's.
3 * Copyright (C) 2006-2010 Florian octo Forster <octo at verplant.org>
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
31 # error "You don't have the standard C99 header files installed"
32 #endif /* STDC_HEADERS */
42 #if TIME_WITH_SYS_TIME
43 # include <sys/time.h>
47 # include <sys/time.h>
54 # include <netdb.h> /* NI_MAXHOST */
62 #include <sys/types.h>
71 #ifndef _POSIX_SAVED_IDS
72 # define _POSIX_SAVED_IDS 0
75 typedef struct ping_context
77 char host[NI_MAXHOST];
78 char addr[NI_MAXHOST];
86 double latency_total_square;
93 static double opt_interval = 1.0;
94 static int opt_addrfamily = PING_DEF_AF;
95 static char *opt_srcaddr = NULL;
96 static char *opt_device = NULL;
97 static char *opt_filename = NULL;
98 static int opt_count = -1;
99 static int opt_send_ttl = 64;
102 static WINDOW *main_win = NULL;
105 static void sigint_handler (int signal) /* {{{ */
107 /* Make compiler happy */
111 } /* }}} void sigint_handler */
113 static ping_context_t *context_create (void)
117 if ((ret = malloc (sizeof (ping_context_t))) == NULL)
120 memset (ret, '\0', sizeof (ping_context_t));
122 ret->latency_min = -1.0;
123 ret->latency_max = -1.0;
124 ret->latency_total = 0.0;
125 ret->latency_total_square = 0.0;
134 static void context_destroy (ping_context_t *context)
140 if (context->window != NULL)
142 delwin (context->window);
143 context->window = NULL;
150 static double context_get_average (ping_context_t *ctx) /* {{{ */
157 if (ctx->req_rcvd < 1)
160 num_total = (double) ctx->req_rcvd;
161 return (ctx->latency_total / num_total);
162 } /* }}} double context_get_average */
164 static double context_get_stddev (ping_context_t *ctx) /* {{{ */
171 if (ctx->req_rcvd < 1)
173 else if (ctx->req_rcvd < 2)
176 num_total = (double) ctx->req_rcvd;
177 return (sqrt (((num_total * ctx->latency_total_square)
178 - (ctx->latency_total * ctx->latency_total))
179 / (num_total * (num_total - 1.0))));
180 } /* }}} double context_get_stddev */
182 static double context_get_packet_loss (const ping_context_t *ctx) /* {{{ */
187 if (ctx->req_sent < 1)
190 return (100.0 * (ctx->req_sent - ctx->req_rcvd)
191 / ((double) ctx->req_sent));
192 } /* }}} double context_get_packet_loss */
194 static void usage_exit (const char *name, int status)
198 name_length = (int) strlen (name);
200 fprintf (stderr, "Usage: %s [OPTIONS] "
201 "-f filename | host [host [host ...]]\n"
203 "\nAvailable options:\n"
204 " -4|-6 force the use of IPv4 or IPv6\n"
205 " -c count number of ICMP packets to send\n"
206 " -i interval interval with which to send ICMP packets\n"
207 " -t ttl time to live for each ICMP packet\n"
208 " -I srcaddr source address\n"
209 " -D device outgoing interface name\n"
210 " -f filename filename to read hosts from\n"
212 "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
213 "by Florian octo Forster <octo@verplant.org>\n"
214 "for contributions see `AUTHORS'\n",
219 static int read_options (int argc, char **argv) /* {{{ */
225 optchar = getopt (argc, argv, "46c:hi:I:t:f:D:");
234 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
240 new_count = atoi (optarg);
242 opt_count = new_count;
244 fprintf(stderr, "Ignoring invalid count: %s\n",
251 if (opt_filename != NULL)
253 opt_filename = strdup (optarg);
260 new_interval = atof (optarg);
261 if (new_interval < 0.001)
262 fprintf (stderr, "Ignoring invalid interval: %s\n",
265 opt_interval = new_interval;
270 if (opt_srcaddr != NULL)
272 opt_srcaddr = strdup (optarg);
283 new_send_ttl = atoi (optarg);
284 if ((new_send_ttl > 0) && (new_send_ttl < 256))
285 opt_send_ttl = new_send_ttl;
287 fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
293 usage_exit (argv[0], 0);
296 usage_exit (argv[0], 1);
301 } /* }}} read_options */
303 static void time_normalize (struct timespec *ts) /* {{{ */
305 while (ts->tv_nsec < 0)
314 ts->tv_nsec += 1000000000;
317 while (ts->tv_nsec >= 1000000000)
320 ts->tv_nsec -= 1000000000;
322 } /* }}} void time_normalize */
324 static void time_calc (struct timespec *ts_dest, /* {{{ */
325 const struct timespec *ts_int,
326 const struct timeval *tv_begin,
327 const struct timeval *tv_end)
329 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
330 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
331 time_normalize (ts_dest);
333 /* Assure that `(begin + interval) > end'.
334 * This may seem overly complicated, but `tv_sec' is of type `time_t'
335 * which may be `unsigned. *sigh* */
336 if ((tv_end->tv_sec > ts_dest->tv_sec)
337 || ((tv_end->tv_sec == ts_dest->tv_sec)
338 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
341 ts_dest->tv_nsec = 0;
345 ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
346 ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
347 time_normalize (ts_dest);
348 } /* }}} void time_calc */
351 static int context_window_repaint (ping_context_t *ctx, /* {{{ */
357 if (ctx->window == NULL)
359 ctx->window = newwin (/* height = */ 4, /* width = */ 0,
360 /* start y = */ 4 * index, /* start x = */ 0);
362 else /* if (ctx->window != NULL) */
364 werase (ctx->window);
367 box (ctx->window, 0, 0);
368 wattron (ctx->window, A_BOLD);
369 mvwprintw (ctx->window, /* y = */ 0, /* x = */ 5,
371 wattroff (ctx->window, A_BOLD);
372 wprintw (ctx->window, "ping statistics ");
373 mvwprintw (ctx->window, /* y = */ 1, /* x = */ 2,
374 "%i packets transmitted, %i received, %.2f%% packet "
376 ctx->req_sent, ctx->req_rcvd,
377 context_get_packet_loss (ctx),
379 if (ctx->req_rcvd != 0)
384 average = context_get_average (ctx);
385 deviation = context_get_stddev (ctx);
387 mvwprintw (ctx->window, /* y = */ 2, /* x = */ 2,
388 "rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms",
395 wrefresh (ctx->window);
398 } /* }}} int context_window_repaint */
400 static int resize_windows (pingobj_t *ping) /* {{{ */
403 pingobj_iter_t *iter;
410 int key = wgetch (stdscr);
413 else if (key == KEY_RESIZE)
420 getmaxyx (stdscr, height, width);
421 if ((height < 1) || (width < 1))
425 for (iter = ping_iterator_get (ping);
427 iter = ping_iterator_next (iter))
429 ping_context_t *ctx = ping_iterator_get_context (iter);
431 if (ctx->window == NULL)
437 wresize (ctx->window, 4, width);
438 context_window_repaint (ctx, index);
443 if (main_win != NULL)
445 wresize (main_win, height - (4 * index), width);
446 /* touchwin (main_win); */
447 /* wrefresh (main_win); */
448 clearok (main_win, TRUE);
452 } /* }}} int resize_windows */
455 static void print_host (pingobj_iter_t *iter, /* {{{ */
459 unsigned int sequence;
463 ping_context_t *context;
466 buffer_len = sizeof (latency);
467 ping_iterator_get_info (iter, PING_INFO_LATENCY,
468 &latency, &buffer_len);
471 buffer_len = sizeof (sequence);
472 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
473 &sequence, &buffer_len);
476 buffer_len = sizeof (recv_ttl);
477 ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
478 &recv_ttl, &buffer_len);
481 ping_iterator_get_info (iter, PING_INFO_DATA,
484 context = (ping_context_t *) ping_iterator_get_context (iter);
487 # define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
489 # define HOST_PRINTF(...) printf(__VA_ARGS__)
496 context->latency_total += latency;
497 context->latency_total_square += (latency * latency);
499 if ((context->latency_max < 0.0) || (context->latency_max < latency))
500 context->latency_max = latency;
501 if ((context->latency_min < 0.0) || (context->latency_min > latency))
502 context->latency_min = latency;
504 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i "
507 context->host, context->addr,
508 sequence, recv_ttl, latency);
512 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
513 context->host, context->addr,
518 context_window_repaint (context, index);
521 } /* }}} void print_host */
523 static int print_header (pingobj_t *ping) /* {{{ */
525 pingobj_iter_t *iter;
532 nodelay (stdscr, TRUE);
536 for (iter = ping_iterator_get (ping);
538 iter = ping_iterator_next (iter))
540 ping_context_t *context;
543 context = context_create ();
545 buffer_size = sizeof (context->host);
546 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
548 buffer_size = sizeof (context->addr);
549 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
552 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
555 context_window_repaint (context, index);
556 #else /* !USE_NCURSES */
557 printf ("PING %s (%s) %zu bytes of data.\n",
558 context->host, context->addr, buffer_size);
561 ping_iterator_set_context (iter, (void *) context);
567 main_win = newwin (/* height = */ 0, /* width = */ 0,
568 /* y = */ 4 * index, /* x = */ 0);
569 /* Allow scrolling */
570 scrollok (main_win, TRUE);
571 /* Allow hardware accelerated scrolling. */
572 idlok (main_win, TRUE);
574 /* Don't know what good this does exactly, but without this code
575 * "resize_windows" will be called right after startup and *somehow*
576 * this leads to display errors. If we purge all initial characters
577 * here, the problem goes away. "wgetch" is non-blocking due to
578 * "nodelay" (see above). */
579 while (wgetch (stdscr) != ERR)
581 /* eat up characters */;
586 } /* }}} int print_header */
588 static int print_footer (pingobj_t *ping) /* {{{ */
590 pingobj_iter_t *iter;
596 for (iter = ping_iterator_get (ping);
598 iter = ping_iterator_next (iter))
600 ping_context_t *context;
602 context = ping_iterator_get_context (iter);
604 printf ("\n--- %s ping statistics ---\n"
605 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
606 context->host, context->req_sent, context->req_rcvd,
607 context_get_packet_loss (context),
608 context->latency_total);
610 if (context->req_rcvd != 0)
615 average = context_get_average (context);
616 deviation = context_get_stddev (context);
618 printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
619 context->latency_min,
621 context->latency_max,
625 ping_iterator_set_context (iter, NULL);
626 context_destroy (context);
630 } /* }}} int print_footer */
632 int main (int argc, char **argv) /* {{{ */
635 pingobj_iter_t *iter;
637 struct sigaction sigint_action;
639 struct timeval tv_begin;
640 struct timeval tv_end;
641 struct timespec ts_wait;
642 struct timespec ts_int;
650 /* Save the old effective user id */
651 saved_set_uid = geteuid ();
652 /* Set the effective user ID to the real user ID without changing the
653 * saved set-user ID */
654 status = seteuid (getuid ());
657 fprintf (stderr, "Temporarily dropping privileges "
658 "failed: %s\n", strerror (errno));
663 optind = read_options (argc, argv);
665 #if !_POSIX_SAVED_IDS
666 /* Cannot temporarily drop privileges -> reject every file but "-". */
667 if ((opt_filename != NULL)
668 && (strcmp ("-", opt_filename) != 0)
669 && (getuid () != geteuid ()))
671 fprintf (stderr, "Your real and effective user IDs don't "
672 "match. Reading from a file (option '-f')\n"
673 "is therefore too risky. You can still read "
674 "from STDIN using '-f -' if you like.\n"
680 if ((optind >= argc) && (opt_filename == NULL)) {
681 usage_exit (argv[0], 1);
684 if ((ping = ping_construct ()) == NULL)
686 fprintf (stderr, "ping_construct failed\n");
690 if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
692 fprintf (stderr, "Setting TTL to %i failed: %s\n",
693 opt_send_ttl, ping_get_error (ping));
700 temp_nsec = modf (opt_interval, &temp_sec);
701 ts_int.tv_sec = (time_t) temp_sec;
702 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
704 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
707 if (opt_addrfamily != PING_DEF_AF)
708 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
710 if (opt_srcaddr != NULL)
712 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
714 fprintf (stderr, "Setting source address failed: %s\n",
715 ping_get_error (ping));
719 if (opt_device != NULL)
721 if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
723 fprintf (stderr, "Setting device failed: %s\n",
724 ping_get_error (ping));
728 if (opt_filename != NULL)
734 if (strcmp (opt_filename, "-") == 0)
736 infile = fdopen(0, "r");
738 infile = fopen(opt_filename, "r");
742 fprintf (stderr, "Opening %s failed: %s\n",
743 (strcmp (opt_filename, "-") == 0)
744 ? "STDIN" : opt_filename,
750 /* Regain privileges */
751 status = seteuid (saved_set_uid);
754 fprintf (stderr, "Temporarily re-gaining privileges "
755 "failed: %s\n", strerror (errno));
760 while (fgets(line, sizeof(line), infile))
762 /* Strip whitespace */
763 if (sscanf(line, "%s", host) != 1)
766 if ((host[0] == 0) || (host[0] == '#'))
769 if (ping_host_add(ping, host) < 0)
771 const char *errmsg = ping_get_error (ping);
773 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
779 /* Drop privileges */
780 status = seteuid (getuid ());
783 fprintf (stderr, "Temporarily dropping privileges "
784 "failed: %s\n", strerror (errno));
793 /* Regain privileges */
794 status = seteuid (saved_set_uid);
797 fprintf (stderr, "Temporarily re-gaining privileges "
798 "failed: %s\n", strerror (errno));
803 for (i = optind; i < argc; i++)
805 if (ping_host_add (ping, argv[i]) < 0)
807 const char *errmsg = ping_get_error (ping);
809 fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
814 /* Permanently drop root privileges if we're setuid-root. */
815 status = setuid (getuid ());
818 fprintf (stderr, "Dropping privileges failed: %s\n",
824 saved_set_uid = (uid_t) -1;
832 memset (&sigint_action, '\0', sizeof (sigint_action));
833 sigint_action.sa_handler = sigint_handler;
834 if (sigaction (SIGINT, &sigint_action, NULL) < 0)
836 perror ("sigaction");
840 while (opt_count != 0)
845 if (gettimeofday (&tv_begin, NULL) < 0)
847 perror ("gettimeofday");
851 if (ping_send (ping) < 0)
853 fprintf (stderr, "ping_send failed: %s\n",
854 ping_get_error (ping));
859 for (iter = ping_iterator_get (ping);
861 iter = ping_iterator_next (iter))
863 print_host (iter, index);
870 /* Don't sleep in the last iteration */
874 if (gettimeofday (&tv_end, NULL) < 0)
876 perror ("gettimeofday");
880 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
882 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
883 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
887 perror ("nanosleep");
890 else if (opt_count == 0)
897 resize_windows (ping);
902 resize_windows (ping);
907 } /* while (opt_count != 0) */
916 /* vim: set fdm=marker : */