Implemented `-h' option.
[liboping.git] / 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; either version 2 of the License, or
8  * (at your option) any later version.
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 int    opt_count      = -1;
76
77 void sigint_handler (int signal)
78 {
79         /* Exit the loop */
80         opt_count = 0;
81 }
82
83 ping_context_t *context_create (void)
84 {
85         ping_context_t *ret;
86
87         if ((ret = malloc (sizeof (ping_context_t))) == NULL)
88                 return (NULL);
89
90         memset (ret, '\0', sizeof (ping_context_t));
91
92         ret->latency_min   = -1.0;
93         ret->latency_max   = -1.0;
94         ret->latency_total = 0.0;
95         ret->latency_total_square = 0.0;
96
97         return (ret);
98 }
99
100 void context_destroy (ping_context_t *context)
101 {
102         free (context);
103 }
104
105 void usage_exit (const char *name)
106 {
107         fprintf (stderr, "Usage: %s [-46] [-c count] [-i interval] host [host [host ...]]\n",
108                         name);
109         exit (1);
110 }
111
112 int read_options (int argc, char **argv)
113 {
114         int optchar;
115
116         while (1)
117         {
118                 optchar = getopt (argc, argv, "46c:hi:");
119
120                 if (optchar == -1)
121                         break;
122
123                 switch (optchar)
124                 {
125                         case '4':
126                         case '6':
127                                 opt_addrfamily = (optchar == '4') ? AF_INET : AF_INET6;
128                                 break;
129
130                         case 'c':
131                                 {
132                                         int new_count;
133                                         new_count = atoi (optarg);
134                                         if (new_count > 0)
135                                                 opt_count = new_count;
136                                 }
137                                 break;
138
139                         case 'i':
140                                 {
141                                         double new_interval;
142                                         new_interval = atof (optarg);
143                                         if (new_interval >= 0.2)
144                                                 opt_interval = new_interval;
145                                 }
146                                 break;
147
148                         case 'h':
149                         default:
150                                 usage_exit (argv[0]);
151                 }
152         }
153
154         return (optind);
155 }
156
157 void print_host (pingobj_iter_t *iter)
158 {
159         double   latency;
160         uint16_t sequence;
161         size_t   buffer_len;
162         ping_context_t *context;
163         
164         buffer_len = sizeof (latency);
165         ping_iterator_get_info (iter, PING_INFO_LATENCY,
166                         &latency, &buffer_len);
167
168         buffer_len = sizeof (sequence);
169         ping_iterator_get_info (iter, PING_INFO_SEQUENCE,
170                         &sequence, &buffer_len);
171
172         context = (ping_context_t *) ping_iterator_get_context (iter);
173
174         context->req_sent++;
175         if (latency > 0.0)
176         {
177                 context->req_rcvd++;
178                 context->latency_total += latency;
179                 context->latency_total_square += (latency * latency);
180
181                 if ((context->latency_max < 0.0) || (context->latency_max < latency))
182                         context->latency_max = latency;
183                 if ((context->latency_min < 0.0) || (context->latency_min > latency))
184                         context->latency_min = latency;
185
186                 printf ("echo reply from %s (%s): icmp_seq=%u time=%.2f ms\n",
187                                 context->host, context->addr,
188                                 (unsigned int) sequence, latency);
189         }
190         else
191         {
192                 printf ("echo reply from %s (%s): icmp_seq=%u timeout\n",
193                                 context->host, context->addr,
194                                 (unsigned int) sequence);
195         }
196 }
197
198 void time_normalize (struct timespec *ts)
199 {
200         while (ts->tv_nsec < 0)
201         {
202                 if (ts->tv_sec == 0)
203                 {
204                         ts->tv_nsec = 0;
205                         return;
206                 }
207
208                 ts->tv_sec  -= 1;
209                 ts->tv_nsec += 1000000000;
210         }
211
212         while (ts->tv_nsec >= 1000000000)
213         {
214                 ts->tv_sec  += 1;
215                 ts->tv_nsec -= 1000000000;
216         }
217 }
218
219 void time_calc (struct timespec *ts_dest,
220                 const struct timespec *ts_int,
221                 const struct timeval  *tv_begin,
222                 const struct timeval  *tv_end)
223 {
224         ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
225         ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
226         time_normalize (ts_dest);
227
228         /* Assure that `(begin + interval) > end'.
229          * This may seem overly complicated, but `tv_sec' is of type `time_t'
230          * which may be `unsigned. *sigh* */
231         if ((tv_end->tv_sec > ts_dest->tv_sec)
232                         || ((tv_end->tv_sec == ts_dest->tv_sec)
233                                 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
234         {
235                 ts_dest->tv_sec  = 0;
236                 ts_dest->tv_nsec = 0;
237                 return;
238         }
239
240         ts_dest->tv_sec = ts_dest->tv_sec - tv_end->tv_sec;
241         ts_dest->tv_nsec = ts_dest->tv_nsec - (tv_end->tv_usec * 1000);
242         time_normalize (ts_dest);
243 }
244
245 int main (int argc, char **argv)
246 {
247         pingobj_t      *ping;
248         pingobj_iter_t *iter;
249
250         struct sigaction sigint_action;
251
252         struct timeval  tv_begin;
253         struct timeval  tv_end;
254         struct timespec ts_wait;
255         struct timespec ts_int;
256
257         int optind;
258         int i;
259
260         optind = read_options (argc, argv);
261
262         if (optind >= argc)
263                 usage_exit (argv[0]);
264
265         if (geteuid () != 0)
266         {
267                 fprintf (stderr, "Need superuser privileges to open a RAW socket. Sorry.\n");
268                 return (1);
269         }
270
271         if ((ping = ping_construct ()) == NULL)
272         {
273                 fprintf (stderr, "ping_construct failed\n");
274                 return (1);
275         }
276
277         {
278                 double temp_sec;
279                 double temp_nsec;
280
281                 temp_nsec = modf (opt_interval, &temp_sec);
282                 ts_int.tv_sec  = (time_t) temp_sec;
283                 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
284
285                 /* printf ("ts_int = %i.%09li\n", (int) ts_int.tv_sec, ts_int.tv_nsec); */
286         }
287
288         if (opt_addrfamily != PING_DEF_AF)
289                 ping_setopt (ping, PING_OPT_AF, (void *) &opt_addrfamily);
290
291         for (i = optind; i < argc; i++)
292         {
293                 if (ping_host_add (ping, argv[i]) > 0)
294                 {
295                         fprintf (stderr, "ping_host_add (%s) failed\n", argv[i]);
296                         continue;
297                 }
298         }
299
300         for (iter = ping_iterator_get (ping);
301                         iter != NULL;
302                         iter = ping_iterator_next (iter))
303         {
304                 ping_context_t *context;
305                 size_t buffer_size;
306
307                 context = context_create ();
308
309                 buffer_size = sizeof (context->host);
310                 ping_iterator_get_info (iter, PING_INFO_HOSTNAME, context->host, &buffer_size);
311
312                 buffer_size = sizeof (context->addr);
313                 ping_iterator_get_info (iter, PING_INFO_ADDRESS, context->addr, &buffer_size);
314
315                 ping_iterator_set_context (iter, (void *) context);
316         }
317
318         memset (&sigint_action, '\0', sizeof (sigint_action));
319         sigint_action.sa_handler = sigint_handler;
320         if (sigaction (SIGINT, &sigint_action, NULL) < 0)
321         {
322                 perror ("sigaction");
323                 return (1);
324         }
325
326         while (opt_count != 0)
327         {
328                 int status;
329
330                 if (gettimeofday (&tv_begin, NULL) < 0)
331                 {
332                         perror ("gettimeofday");
333                         return (1);
334                 }
335
336                 if (ping_send (ping) < 0)
337                 {
338                         fprintf (stderr, "ping_send failed\n");
339                         return (1);
340                 }
341
342                 for (iter = ping_iterator_get (ping);
343                                 iter != NULL;
344                                 iter = ping_iterator_next (iter))
345                 {
346                         print_host (iter);
347                 }
348                 fflush (stdout);
349
350                 /* Don't sleep in the last iteration */
351                 if (opt_count == 1)
352                         break;
353
354                 if (gettimeofday (&tv_end, NULL) < 0)
355                 {
356                         perror ("gettimeofday");
357                         return (1);
358                 }
359
360                 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
361
362                 /* printf ("Sleeping for %i.%09li seconds\n", (int) ts_wait.tv_sec, ts_wait.tv_nsec); */
363                 while ((status = nanosleep (&ts_wait, &ts_wait)) != 0)
364                 {
365                         if (errno != EINTR)
366                         {
367                                 perror ("nanosleep");
368                                 break;
369                         }
370                         else if (opt_count == 0)
371                         {
372                                 /* sigint */
373                                 break;
374                         }
375                 }
376
377                 if (opt_count > 0)
378                         opt_count--;
379         } /* while (opt_count != 0) */
380
381         for (iter = ping_iterator_get (ping);
382                         iter != NULL;
383                         iter = ping_iterator_next (iter))
384         {
385                 ping_context_t *context;
386
387                 context = ping_iterator_get_context (iter);
388
389                 printf ("\n--- %s ping statistics ---\n"
390                                 "%i packets transmitted, %i received, %.2f%% packet loss, time %.1fms\n",
391                                 context->host, context->req_sent, context->req_rcvd,
392                                 100.0 * (context->req_sent - context->req_rcvd) / ((double) context->req_sent),
393                                 context->latency_total);
394
395                 if (context->req_rcvd != 0)
396                 {
397                         double num_total;
398                         double average;
399                         double deviation;
400
401                         num_total = (double) context->req_rcvd;
402
403                         average = context->latency_total / num_total;
404                         deviation = sqrt (context->latency_total_square - (num_total * average * average));
405
406                         printf ("rtt min/avg/max/sdev = %.3f/%.3f/%.3f/%.3f ms\n",
407                                         context->latency_min,
408                                         average,
409                                         context->latency_max,
410                                         deviation);
411                 }
412
413                 ping_iterator_set_context (iter, NULL);
414                 free (context);
415         }
416
417         ping_destroy (ping);
418
419         return (0);
420 }