src/oping.c

   1 /**
   2  * Object oriented C module to send ICMP and ICMPv6 `echo's.
   3  * Copyright (C) 2006  Florian octo Forster <octo at verplant.org>
   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  */
  19
  20 #if HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 #if STDC_HEADERS
  25 # include <stdlib.h>
  26 # include <stdio.h>
  27 # include <string.h>
  28 # include <errno.h>
  29 # include <assert.h>
  30 #else
  31 # error "You don't have the standard C99 header files installed"
  32 #endif /* STDC_HEADERS */
  33
  34 #if HAVE_MATH_H
  35 # include <math.h>
  36 #endif
  37
  38 #if TIME_WITH_SYS_TIME
  39 # include <sys/time.h>
  40 # include <time.h>
  41 #else
  42 # if HAVE_SYS_TIME_H
  43 #  include <sys/time.h>
  44 # else
  45 #  include <time.h>
  46 # endif
  47 #endif
  48
  49 #if HAVE_NETDB_H
  50 # include <netdb.h> /* NI_MAXHOST */
  51 #endif
  52
  53 #if HAVE_SIGNAL_H
  54 # include <signal.h>
  55 #endif
  56
  57 #include "oping.h"
  58
  59 typedef struct ping_context
  60 {
  61         char host[NI_MAXHOST];
  62         char addr[NI_MAXHOST];
  63
  64         int req_sent;
  65         int req_rcvd;
  66
  67         double latency_min;
  68         double latency_max;
  69         double latency_total;
  70         double latency_total_square;
  71 } ping_context_t;
  72
  73 static double  opt_interval   = 1.0;
  74 static int     opt_addrfamily = PING_DEF_AF;
  75 static char   *opt_srcaddr    = NULL;
  76 static char   *opt_filename   = NULL;
  77 static int     opt_count      = -1;
  78 static int     opt_send_ttl   = 64;
  79
  80 static void sigint_handler (int signal)
  81 {
  82         /* Make compiler happy */
  83         signal = 0;
  84         /* Exit the loop */
  85         opt_count = 0;
  86 }
  87
  88 static ping_context_t *context_create (void)
  89 {
  90         ping_context_t *ret;
  91
  92         if ((ret = malloc (sizeof (ping_context_t))) == NULL)
  93                 return (NULL);
  94
  95         memset (ret, '\0', sizeof (ping_context_t));
  96
  97         ret->latency_min   = -1.0;
  98         ret->latency_max   = -1.0;
  99         ret->latency_total = 0.0;
 100         ret->latency_total_square = 0.0;
 101
 102         return (ret);
 103 }
 104
 105 static void context_destroy (ping_context_t *context)
 106 {
 107         free (context);
 108 }
 109
 110 static void usage_exit (const char *name)
 111 {
 112         int name_length;
 113
 114         name_length = (int) strlen (name);
 115
 116         fprintf (stderr, "Usage: %s [OPTIONS] "
 117                                 "-f filename | host [host [host ...]]\n"
 118
 119                         "\nAvailable options:\n"
 120                         "  -4|-6        force the use of IPv4 or IPv6\n"
 121                         "  -c count     number of ICMP packets to send\n"
 122                         "  -i interval  interval with which to send ICMP packets\n"
 123                         "  -t ttl       time to live for each ICMP packet\n"
 124                         "  -I srcaddr   source address\n"
 125                         "  -f filename  filename to read hosts from\n"
 126
 127                         "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
 128                         "by Florian octo Forster <octo@verplant.org>\n"
 129                         "for contributions see `AUTHORS'\n",
 130                         name);
 131         exit (1);
 132 }
 133
 134 static int read_options (int argc, char **argv)
 135 {
 136         int optchar;
 137
 138         while (1)
 139         {
 140                 optchar = getopt (argc, argv, "46c:hi:I:t:f:");
 141
 142                 if (optchar == -1)
 143                         break;
 144
 145                 switch (optchar)
 146                 {
 147                         case '4':
 148                         case '6':
 149                                 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
 150                                 break;
 151
 152                         case 'c':
 153                                 {
 154                                         int new_count;
 155                                         new_count = atoi (optarg);
 156                                         if (new_count > 0)
 157                                                 opt_count = new_count;
 158                                         else
 159                                                 fprintf(stderr, "Ignoring invalid count: %s\n",
 160                                                                 optarg);
 161                                 }
 162                                 break;
 163
 164                         case 'f':
 165                                 {
 166                                         if (opt_filename != NULL)
 167                                                 free (opt_filename);
 168                                         opt_filename = strdup (optarg);
 169                                 }
 170                                 break;
 171
 172                         case 'i':
 173                                 {
 174                                         double new_interval;
 175                                         new_interval = atof (optarg);
 176                                         if (new_interval < 0.001)
 177                                                 fprintf (stderr, "Ignoring invalid interval: %s\n",
 178                                                                 optarg);
 179                                         else
 180                                                 opt_interval = new_interval;
 181                                 }
 182                                 break;
 183                         case 'I':
 184                                 {
 185                                         if (opt_srcaddr != NULL)
 186                                                 free (opt_srcaddr);
 187                                         opt_srcaddr = strdup (optarg);
 188                                 }
 189                                 break;
 190
 191                         case 't':
 192                         {
 193                                 int new_send_ttl;
 194                                 new_send_ttl = atoi (optarg);
 195                                 if ((new_send_ttl > 0) && (new_send_ttl < 256))
 196                                         opt_send_ttl = new_send_ttl;
 197                                 else
 198                                         fprintf (stderr, "Ignoring invalid TTL argument: %s\n",
 199                                                         optarg);
 200                                 break;
 201                         }
 202
 203                         case 'h':
 204                         default:
 205                                 usage_exit (argv[0]);
 206                 }
 207         }
 208
 209         return (optind);
 210 }
 211
 212 static void print_host (pingobj_iter_t *iter)
 213 {
 214         double          latency;
 215         unsigned int    sequence;
 216         int             recv_ttl;
 217         size_t          buffer_len;
 218         size_t          data_len;
 219         ping_context_t *context;
 220
 221         latency = -1.0;
 222         buffer_len = sizeof (latency);
 223         ping_iterator_get_info (iter, PING_INFO_LATENCY,
 224                         &latency, &buffer_len);
 225
 226         sequence = 0;
 227         buffer_len = sizeof (sequence);
 228         ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
 229                         &sequence, &buffer_len);
 230
 231         recv_ttl = -1;
 232         buffer_len = sizeof (recv_ttl);
 233         ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
 234                         &recv_ttl, &buffer_len);
 235
 236         data_len = 0;
 237         ping_iterator_get_info (iter, PING_INFO_DATA,
 238                         NULL, &data_len);
 239
 240         context = (ping_context_t *) ping_iterator_get_context (iter);
 241
 242         context->req_sent++;
 243         if (latency > 0.0)
 244         {
 245                 context->req_rcvd++;
 246                 context->latency_total += latency;
 247                 context->latency_total_square += (latency * latency);
 248
 249                 if ((context->latency_max < 0.0) || (context->latency_max < latency))
 250                         context->latency_max = latency;
 251                 if ((context->latency_min < 0.0) || (context->latency_min > latency))
 252                         context->latency_min = latency;
 253
 254                 printf ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i time=%.2f ms\n",
 255                                 data_len,
 256                                 context->host, context->addr,
 257                                 sequence, recv_ttl, latency);
 258         }
 259         else
 260         {
 261                 printf ("echo reply from %s (%s): icmp_seq=%u timeout\n",
 262                                 context->host, context->addr,
 263                                 sequence);
 264         }
 265 }
 266
 267 static void time_normalize (struct timespec *ts)
 268 {
 269         while (ts->tv_nsec < 0)
 270         {
 271                 if (ts->tv_sec == 0)
 272                 {
 273                         ts->tv_nsec = 0;
 274                         return;
 275                 }
 276
 277                 ts->tv_sec  -= 1;
 278                 ts->tv_nsec += 1000000000;
 279         }
 280
 281         while (ts->tv_nsec >= 1000000000)
 282         {
 283                 ts->tv_sec  += 1;
 284                 ts->tv_nsec -= 1000000000;
 285         }
 286 }
 287
 288 static void time_calc (struct timespec *ts_dest,
 289                 const struct timespec *ts_int,
 290                 const struct timeval  *tv_begin,
 291                 const struct timeval  *tv_end)
 292 {
 293         ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
 294         ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
 295         time_normalize (ts_dest);
 296
 297         /* Assure that `(begin + interval) > end'.
 298          * This may seem overly complicated, but `tv_sec' is of type `time_t'
 299          * which may be `unsigned. *sigh* */
 300         if ((tv_end->tv_sec > ts_dest->tv_sec)
 301                         || ((tv_end->tv_sec == ts_dest->tv_sec)
 302                                 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
 303         {
 304                 ts_dest->tv_sec  = 0;
 305                 ts_dest->tv_nsec = 0;
 306                 return;
 307         }
 308
 309         ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
 310         ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
 311         time_normalize (ts_dest);
 312 }
 313
 314 int main (int argc, char **argv)
 315 {
 316         pingobj_t      *ping;
 317         pingobj_iter_t *iter;
 318
 319         struct sigaction sigint_action;
 320
 321         struct timeval  tv_begin;
 322         struct timeval  tv_end;
 323         struct timespec ts_wait;
 324         struct timespec ts_int;
 325
 326         int optind;
 327         int i;
 328
 329         optind = read_options (argc, argv);
 330
 331         if ((optind >= argc) && (opt_filename == NULL)) {
 332                 usage_exit (argv[0]);
 333         }
 334
 335         if (geteuid () != 0)
 336         {
 337                 fprintf (stderr, "Need superuser privileges to open a RAW socket. Sorry.\n");
 338                 return (1);
 339         }
 340
 341         if ((ping = ping_construct ()) == NULL)
 342         {
 343                 fprintf (stderr, "ping_construct failed\n");
 344                 return (1);
 345         }
 346
 347         if (ping_setopt (ping, PING_OPT_TTL, &opt_send_ttl) != 0)
 348         {
 349                 fprintf (stderr, "Setting TTL to %i failed: %s\n",
 350                                 opt_send_ttl, ping_get_error (ping));
 351         }
 352
 353         {
 354                 double temp_sec;
 355                 double temp_nsec;
 356
 357                 temp_nsec = modf (opt_interval, &temp_sec);
 358                 ts_int.tv_sec  = (time_t) temp_sec;
 359                 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
 360
 361                 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
 362         }
 363
 364         if (opt_addrfamily != PING_DEF_AF)
 365                 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
 366
 367         if (opt_srcaddr != NULL)
 368         {
 369                 if (ping_setopt (ping, PING_OPT_SOURCE, (void *) opt_srcaddr) != 0)
 370                 {
 371                         fprintf (stderr, "Setting source address failed: %s\n",
 372                                         ping_get_error (ping));
 373                 }
 374         }
 375
 376         if (opt_filename != NULL)
 377         {
 378                 FILE *infile;
 379                 char line[256];
 380                 char host[256];
 381
 382                 if (strcmp (opt_filename, "-") == 0)
 383                         /* Open STDIN */
 384                         infile = fdopen(0, "r");
 385                 else
 386                         infile = fopen(opt_filename, "r");
 387
 388                 if (infile == NULL)
 389                 {
 390                         fprintf (stderr, "Opening %s failed: %s\n",
 391                                         (strcmp (opt_filename, "-") == 0)
 392                                         ? "STDIN" : opt_filename,
 393                                         strerror(errno));
 394                         return (1);
 395                 }
 396
 397                 while (fgets(line, sizeof(line), infile))
 398                 {
 399                         /* Strip whitespace */
 400                         if (sscanf(line, "%s", host) != 1)
 401                                 continue;
 402
 403                         if ((host[0] == 0) || (host[0] == '#'))
 404                                 continue;
 405
 406                         if (ping_host_add(ping, host) < 0)
 407                         {
 408                                 const char *errmsg = ping_get_error (ping);
 409
 410                                 fprintf (stderr, "Adding host `%s' failed: %s\n", host, errmsg);
 411                                 continue;
 412                         }
 413                 }
 414
 415                 fclose(infile);
 416         }
 417
 418         for (i = optind; i < argc; i++)
 419         {
 420                 if (ping_host_add (ping, argv[i]) < 0)
 421                 {
 422                         const char *errmsg = ping_get_error (ping);
 423
 424                         fprintf (stderr, "Adding host `%s' failed: %s\n", argv[i], errmsg);
 425                         continue;
 426                 }
 427         }
 428
 429         /* Drop root privileges if we're setuid-root. */
 430         setuid (getuid ());
 431
 432         i = 0;
 433         for (iter = ping_iterator_get (ping);
 434                         iter != NULL;
 435                         iter = ping_iterator_next (iter))
 436         {
 437                 ping_context_t *context;
 438                 size_t buffer_size;
 439
 440                 context = context_create ();
 441
 442                 buffer_size = sizeof (context->host);
 443                 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
 444
 445                 buffer_size = sizeof (context->addr);
 446                 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
 447
 448                 buffer_size = 0;
 449                 ping_iterator_get_info (iter, PING_INFO_DATA, NULL, &buffer_size);
 450
 451                 printf ("PING %s (%s) %zu bytes of data.\n",
 452                                 context->host, context->addr, buffer_size);
 453
 454                 ping_iterator_set_context (iter, (void *) context);
 455
 456                 i++;
 457         }
 458
 459         if (i == 0)
 460                 return (1);
 461
 462         memset (&sigint_action, '\0', sizeof (sigint_action));
 463         sigint_action.sa_handler = sigint_handler;
 464         if (sigaction (SIGINT, &sigint_action, NULL) < 0)
 465         {
 466                 perror ("sigaction");
 467                 return (1);
 468         }
 469
 470         while (opt_count != 0)
 471         {
 472                 int status;
 473
 474                 if (gettimeofday (&tv_begin, NULL) < 0)
 475                 {
 476                         perror ("gettimeofday");
 477                         return (1);
 478                 }
 479
 480                 if (ping_send (ping) < 0)
 481                 {
 482                         fprintf (stderr, "ping_send failed: %s\n",
 483                                         ping_get_error (ping));
 484                         return (1);
 485                 }
 486
 487                 for (iter = ping_iterator_get (ping);
 488                                 iter != NULL;
 489                                 iter = ping_iterator_next (iter))
 490                 {
 491                         print_host (iter);
 492                 }
 493                 fflush (stdout);
 494
 495                 /* Don't sleep in the last iteration */
 496                 if (opt_count == 1)
 497                         break;
 498
 499                 if (gettimeofday (&tv_end, NULL) < 0)
 500                 {
 501                         perror ("gettimeofday");
 502                         return (1);
 503                 }
 504
 505                 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
 506
 507                 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
 508                 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
 509                 {
 510                         if (errno != EINTR)
 511                         {
 512                                 perror ("nanosleep");
 513                                 break;
 514                         }
 515                         else if (opt_count == 0)
 516                         {
 517                                 /* sigint */
 518                                 break;
 519                         }
 520                 }
 521
 522                 if (opt_count > 0)
 523                         opt_count--;
 524         } /* while (opt_count != 0) */
 525
 526         for (iter = ping_iterator_get (ping);
 527                         iter != NULL;
 528                         iter = ping_iterator_next (iter))
 529         {
 530                 ping_context_t *context;
 531
 532                 context = ping_iterator_get_context (iter);
 533
 534                 printf ("\n--- %s ping statistics ---\n"
 535                                 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
 536                                 context->host, context->req_sent, context->req_rcvd,
 537                                 100.0 * (context->req_sent - context->req_rcvd) / ((double) context->req_sent),
 538                                 context->latency_total);
 539
 540                 if (context->req_rcvd != 0)
 541                 {
 542                         double num_total;
 543                         double average;
 544                         double deviation;
 545
 546                         num_total = (double) context->req_rcvd;
 547
 548                         average = context->latency_total / num_total;
 549                         deviation = sqrt (((num_total * context->latency_total_square) - (context->latency_total * context->latency_total))
 550                                         / (num_total * (num_total - 1.0)));
 551
 552                         printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
 553                                         context->latency_min,
 554                                         average,
 555                                         context->latency_max,
 556                                         deviation);
 557                 }
 558
 559                 ping_iterator_set_context (iter, NULL);
 560                 context_destroy (context);
 561         }
 562
 563         ping_destroy (ping);
 564
 565         return (0);
 566 }