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 print_host (pingobj_iter_t *iter)
306 unsigned int sequence;
310 ping_context_t *context;
313 buffer_len = sizeof (latency);
314 ping_iterator_get_info (iter, PING_INFO_LATENCY,
315 &latency, &buffer_len);
318 buffer_len = sizeof (sequence);
319 ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
320 &sequence, &buffer_len);
323 buffer_len = sizeof (recv_ttl);
324 ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
325 &recv_ttl, &buffer_len);
328 ping_iterator_get_info (iter, PING_INFO_DATA,
331 context = (ping_context_t *) ping_iterator_get_context (iter);
334 # define HOST_PRINTF(...) wprintw(main_win, __VA_ARGS__)
336 # define HOST_PRINTF(...) printf(__VA_ARGS__)
343 context->latency_total += latency;
344 context->latency_total_square += (latency * latency);
346 if ((context->latency_max < 0.0) || (context->latency_max < latency))
347 context->latency_max = latency;
348 if ((context->latency_min < 0.0) || (context->latency_min > latency))
349 context->latency_min = latency;
351 HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i "
354 context->host, context->addr,
355 sequence, recv_ttl, latency);
359 HOST_PRINTF ("echo reply from %s (%s): icmp_seq=%u timeout\n",
360 context->host, context->addr,
366 werase (context->window);
367 box (context->window, 0, 0);
368 mvwprintw (context->window, /* y = */ 0, /* x = */ 5,
369 " %s ping statistics ",
371 mvwprintw (context->window, /* y = */ 1, /* x = */ 2,
372 "%i packets transmitted, %i received, %.2f%% packet "
374 context->req_sent, context->req_rcvd,
375 100.0 * (context->req_sent - context->req_rcvd) / ((double) context->req_sent),
376 context->latency_total);
377 if (context->req_rcvd != 0)
382 average = context_get_average (context);
383 deviation = context_get_stddev (context);
385 mvwprintw (context->window, /* y = */ 2, /* x = */ 2,
386 "rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms",
387 context->latency_min,
389 context->latency_max,
392 wrefresh (context->window);
396 static void time_normalize (struct timespec *ts)
398 while (ts->tv_nsec < 0)
407 ts->tv_nsec += 1000000000;
410 while (ts->tv_nsec >= 1000000000)
413 ts->tv_nsec -= 1000000000;
417 static void time_calc (struct timespec *ts_dest, /* {{{ */
418 const struct timespec *ts_int,
419 const struct timeval *tv_begin,
420 const struct timeval *tv_end)
422 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
423 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
424 time_normalize (ts_dest);
426 /* Assure that `(begin + interval) > end'.
427 * This may seem overly complicated, but `tv_sec' is of type `time_t'
428 * which may be `unsigned. *sigh* */
429 if ((tv_end->tv_sec > ts_dest->tv_sec)
430 || ((tv_end->tv_sec == ts_dest->tv_sec)
431 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
434 ts_dest->tv_nsec = 0;
438 ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
439 ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
440 time_normalize (ts_dest);
441 } /* }}} void time_calc */
443 static int print_header (pingobj_t *ping) /* {{{ */
445 pingobj_iter_t *iter;
455 for (iter = ping_iterator_get (ping);
457 iter = ping_iterator_next (iter))
459 ping_context_t *context;
462 context = context_create ();
464 buffer_size = sizeof (context->host);
465 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
467 buffer_size = sizeof (context->addr);
468 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
471 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
474 context->window = newwin (/* height = */ 4, COLS,
475 /* start y = */ 4*i, /* start x = */ 0);
476 box (context->window, 0, 0);
477 mvwprintw (context->window, /* y = */ 0, /* x = */ 5,
478 " %s ping statistics ",
480 wrefresh (context->window);
481 #else /* !USE_NCURSES */
482 printf ("PING %s (%s) %zu bytes of data.\n",
483 context->host, context->addr, buffer_size);
486 ping_iterator_set_context (iter, (void *) context);
493 main_win = newwin (LINES - 4*i, COLS, 4*i, 0);
494 scrollok (main_win, TRUE);
498 } /* }}} int print_header */
500 static int print_footer (pingobj_t *ping)
502 pingobj_iter_t *iter;
508 for (iter = ping_iterator_get (ping);
510 iter = ping_iterator_next (iter))
512 ping_context_t *context;
514 context = ping_iterator_get_context (iter);
516 printf ("\n--- %s ping statistics ---\n"
517 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
518 context->host, context->req_sent, context->req_rcvd,
519 context_get_packet_loss (context),
520 context->latency_total);
522 if (context->req_rcvd != 0)
527 average = context_get_average (context);
528 deviation = context_get_stddev (context);
530 printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
531 context->latency_min,
533 context->latency_max,
537 ping_iterator_set_context (iter, NULL);
538 context_destroy (context);
542 } /* }}} int print_footer */
544 int main (int argc, char **argv) /* {{{ */
547 pingobj_iter_t *iter;
549 struct sigaction sigint_action;
551 struct timeval tv_begin;
552 struct timeval tv_end;
553 struct timespec ts_wait;
554 struct timespec ts_int;
562 /* Save the old effective user id */
563 saved_set_uid = geteuid ();
564 /* Set the effective user ID to the real user ID without changing the
565 * saved set-user ID */
566 status = seteuid (getuid ());
569 fprintf (stderr, "Temporarily dropping privileges "
570 "failed: %s\n", strerror (errno));
575 optind = read_options (argc, argv);
577 #if !_POSIX_SAVED_IDS
578 /* Cannot temporarily drop privileges -> reject every file but "-". */
579 if ((opt_filename != NULL)
580 && (strcmp ("-", opt_filename) != 0)
581 && (getuid () != geteuid ()))
583 fprintf (stderr, "Your real and effective user IDs don't "
584 "match. Reading from a file (option '-f')\n"
585 "is therefore too risky. You can still read "
586 "from STDIN using '-f -' if you like.\n"
592 if ((optind >= argc) && (opt_filename == NULL)) {
593 usage_exit (argv[0], 1);
596 if ((ping = ping_construct ()) == NULL)
598 fprintf (stderr, "ping_construct failed\n");
602 if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
604 fprintf (stderr, "Setting TTL to %i failed: %s\n",
605 opt_send_ttl, ping_get_error (ping));
612 temp_nsec = modf (opt_interval, &temp_sec);
613 ts_int.tv_sec = (time_t) temp_sec;
614 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
616 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
619 if (opt_addrfamily != PING_DEF_AF)
620 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
622 if (opt_srcaddr != NULL)
624 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
626 fprintf (stderr, "Setting source address failed: %s\n",
627 ping_get_error (ping));
631 if (opt_device != NULL)
633 if (ping_setopt (ping, PING_OPT_DEVICE, (void *) opt_device) != 0)
635 fprintf (stderr, "Setting device failed: %s\n",
636 ping_get_error (ping));
640 if (opt_filename != NULL)
646 if (strcmp (opt_filename, "-") == 0)
648 infile = fdopen(0, "r");
650 infile = fopen(opt_filename, "r");
654 fprintf (stderr, "Opening %s failed: %s\n",
655 (strcmp (opt_filename, "-") == 0)
656 ? "STDIN" : opt_filename,
662 /* Regain privileges */
663 status = seteuid (saved_set_uid);
666 fprintf (stderr, "Temporarily re-gaining privileges "
667 "failed: %s\n", strerror (errno));
672 while (fgets(line, sizeof(line), infile))
674 /* Strip whitespace */
675 if (sscanf(line, "%s", host) != 1)
678 if ((host[0] == 0) || (host[0] == '#'))
681 if (ping_host_add(ping, host) < 0)
683 const char *errmsg = ping_get_error (ping);
685 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
691 /* Drop privileges */
692 status = seteuid (getuid ());
695 fprintf (stderr, "Temporarily dropping privileges "
696 "failed: %s\n", strerror (errno));
705 /* Regain privileges */
706 status = seteuid (saved_set_uid);
709 fprintf (stderr, "Temporarily re-gaining privileges "
710 "failed: %s\n", strerror (errno));
715 for (i = optind; i < argc; i++)
717 if (ping_host_add (ping, argv[i]) < 0)
719 const char *errmsg = ping_get_error (ping);
721 fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
726 /* Permanently drop root privileges if we're setuid-root. */
727 status = setuid (getuid ());
730 fprintf (stderr, "Dropping privileges failed: %s\n",
736 saved_set_uid = (uid_t) -1;
744 memset (&sigint_action, '\0', sizeof (sigint_action));
745 sigint_action.sa_handler = sigint_handler;
746 if (sigaction (SIGINT, &sigint_action, NULL) < 0)
748 perror ("sigaction");
752 while (opt_count != 0)
756 if (gettimeofday (&tv_begin, NULL) < 0)
758 perror ("gettimeofday");
762 if (ping_send (ping) < 0)
764 fprintf (stderr, "ping_send failed: %s\n",
765 ping_get_error (ping));
769 for (iter = ping_iterator_get (ping);
771 iter = ping_iterator_next (iter))
777 /* Don't sleep in the last iteration */
781 if (gettimeofday (&tv_end, NULL) < 0)
783 perror ("gettimeofday");
787 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
789 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
790 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
794 perror ("nanosleep");
797 else if (opt_count == 0)
806 } /* while (opt_count != 0) */
815 /* vim: set fdm=marker : */