src/liboping.c: Added the `username' field which holds the name provided by the user.
[liboping.git] / src / liboping.c
1 /**
2  * Object oriented C module to send ICMP and ICMPv6 `echo's.
3  * Copyright (C) 2006-2008  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_UNISTD_H
35 # include <unistd.h>
36 #endif
37
38 #if HAVE_FCNTL_H
39 # include <fcntl.h>
40 #endif
41 #if HAVE_SYS_TYPES_H
42 # include <sys/types.h>
43 #endif
44 #if HAVE_SYS_STAT_H
45 # include <sys/stat.h>
46 #endif
47
48 #if TIME_WITH_SYS_TIME
49 # include <sys/time.h>
50 # include <time.h>
51 #else
52 # if HAVE_SYS_TIME_H
53 #  include <sys/time.h>
54 # else
55 #  include <time.h>
56 # endif
57 #endif
58
59 #if HAVE_SYS_SOCKET_H
60 # include <sys/socket.h>
61 #endif
62 #if HAVE_NETDB_H
63 # include <netdb.h>
64 #endif
65
66 #if HAVE_NETINET_IN_SYSTM_H
67 # include <netinet/in_systm.h>
68 #endif
69 #if HAVE_NETINET_IN_H
70 # include <netinet/in.h>
71 #endif
72 #if HAVE_NETINET_IP_H
73 # include <netinet/ip.h>
74 #endif
75 #if HAVE_NETINET_IP_ICMP_H
76 # include <netinet/ip_icmp.h>
77 #endif
78 #ifdef HAVE_NETINET_IP_VAR_H
79 # include <netinet/ip_var.h>
80 #endif
81 #if HAVE_NETINET_IP6_H
82 # include <netinet/ip6.h>
83 #endif
84 #if HAVE_NETINET_ICMP6_H
85 # include <netinet/icmp6.h>
86 #endif
87
88 #include "oping.h"
89
90 #if WITH_DEBUG
91 # define dprintf(...) printf ("%s[%4i]: %-20s: ", __FILE__, __LINE__, __FUNCTION__); printf (__VA_ARGS__)
92 #else
93 # define dprintf(...) /**/
94 #endif
95
96 #define PING_ERRMSG_LEN 256
97
98 struct pinghost
99 {
100         /* username: name passed in by the user */
101         char                    *username;
102         /* hostname: name returned by the reverse lookup */
103         char                    *hostname;
104         struct sockaddr_storage *addr;
105         socklen_t                addrlen;
106         int                      addrfamily;
107         int                      fd;
108         int                      ident;
109         int                      sequence;
110         struct timeval          *timer;
111         double                   latency;
112         char                    *data;
113
114         void                    *context;
115
116         struct pinghost         *next;
117 };
118
119 struct pingobj
120 {
121         double                   timeout;
122         int                      ttl;
123         int                      addrfamily;
124         char                    *data;
125
126         struct sockaddr_storage *srcaddr;
127         socklen_t                srcaddrlen;
128
129         char                     errmsg[PING_ERRMSG_LEN];
130
131         pinghost_t              *head;
132 };
133
134 /*
135  * private (static) functions
136  */
137 static void ping_set_error (pingobj_t *obj, const char *function,
138                 const char *message)
139 {
140         snprintf (obj->errmsg, PING_ERRMSG_LEN, "%s: %s", function, message);
141         obj->errmsg[PING_ERRMSG_LEN - 1] = '\0';
142 }
143
144 static int ping_timeval_add (struct timeval *tv1, struct timeval *tv2,
145                 struct timeval *res)
146 {
147         res->tv_sec  = tv1->tv_sec  + tv2->tv_sec;
148         res->tv_usec = tv1->tv_usec + tv2->tv_usec;
149
150         while (res->tv_usec > 1000000)
151         {
152                 res->tv_usec -= 1000000;
153                 res->tv_sec++;
154         }
155
156         return (0);
157 }
158
159 static int ping_timeval_sub (struct timeval *tv1, struct timeval *tv2,
160                 struct timeval *res)
161 {
162
163         if ((tv1->tv_sec < tv2->tv_sec)
164                         || ((tv1->tv_sec == tv2->tv_sec)
165                                 && (tv1->tv_usec < tv2->tv_usec)))
166                 return (-1);
167
168         res->tv_sec  = tv1->tv_sec  - tv2->tv_sec;
169         res->tv_usec = tv1->tv_usec - tv2->tv_usec;
170
171         assert ((res->tv_sec > 0) || ((res->tv_sec == 0) && (res->tv_usec > 0)));
172
173         while (res->tv_usec < 0)
174         {
175                 res->tv_usec += 1000000;
176                 res->tv_sec--;
177         }
178
179         return (0);
180 }
181
182 static uint16_t ping_icmp4_checksum (char *buf, size_t len)
183 {
184         uint32_t sum = 0;
185         uint16_t ret = 0;
186
187         uint16_t *ptr;
188
189         for (ptr = (uint16_t *) buf; len > 1; ptr++, len -= 2)
190                 sum += *ptr;
191
192         if (len == 1)
193         {
194                 *(char *) &ret = *(char *) ptr;
195                 sum += ret;
196         }
197
198         /* Do this twice to get all possible carries.. */
199         sum = (sum >> 16) + (sum & 0xFFFF);
200         sum = (sum >> 16) + (sum & 0xFFFF);
201
202         ret = ~sum;
203
204         return (ret);
205 }
206
207 static pinghost_t *ping_receive_ipv4 (pinghost_t *ph, char *buffer, size_t buffer_len)
208 {
209         struct ip *ip_hdr;
210         struct icmp *icmp_hdr;
211
212         size_t ip_hdr_len;
213
214         uint16_t recv_checksum;
215         uint16_t calc_checksum;
216
217         uint16_t ident;
218         uint16_t seq;
219
220         pinghost_t *ptr;
221
222         if (buffer_len < sizeof (struct ip))
223                 return (NULL);
224
225         ip_hdr     = (struct ip *) buffer;
226         ip_hdr_len = ip_hdr->ip_hl << 2;
227
228         if (buffer_len < ip_hdr_len)
229                 return (NULL);
230
231         buffer     += ip_hdr_len;
232         buffer_len -= ip_hdr_len;
233
234         if (buffer_len < sizeof (struct icmp))
235                 return (NULL);
236
237         icmp_hdr = (struct icmp *) buffer;
238         buffer     += sizeof (struct icmp);
239         buffer_len -= sizeof (struct icmp);
240
241         if (icmp_hdr->icmp_type != ICMP_ECHOREPLY)
242         {
243                 dprintf ("Unexpected ICMP type: %i\n", icmp_hdr->icmp_type);
244                 return (NULL);
245         }
246
247         recv_checksum = icmp_hdr->icmp_cksum;
248         icmp_hdr->icmp_cksum = 0;
249         calc_checksum = ping_icmp4_checksum ((char *) icmp_hdr,
250                         sizeof (struct icmp) + buffer_len);
251
252         if (recv_checksum != calc_checksum)
253         {
254                 dprintf ("Checksum missmatch: Got 0x%04x, calculated 0x%04x\n",
255                                 recv_checksum, calc_checksum);
256                 return (NULL);
257         }
258
259         ident = ntohs (icmp_hdr->icmp_id);
260         seq   = ntohs (icmp_hdr->icmp_seq);
261
262         for (ptr = ph; ptr != NULL; ptr = ptr->next)
263         {
264                 dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
265                                 ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
266
267                 if (ptr->addrfamily != AF_INET)
268                         continue;
269
270                 if (!timerisset (ptr->timer))
271                         continue;
272
273                 if (ptr->ident != ident)
274                         continue;
275
276                 if (((ptr->sequence - 1) & 0xFFFF) != seq)
277                         continue;
278
279                 dprintf ("Match found: hostname = %s, ident = 0x%04x, seq = %i\n",
280                                 ptr->hostname, ident, seq);
281
282                 break;
283         }
284
285         if (ptr == NULL)
286         {
287                 dprintf ("No match found for ident = 0x%04x, seq = %i\n",
288                                 ident, seq);
289         }
290
291         return (ptr);
292 }
293
294 static pinghost_t *ping_receive_ipv6 (pinghost_t *ph, char *buffer, size_t buffer_len)
295 {
296         struct icmp6_hdr *icmp_hdr;
297
298         uint16_t ident;
299         uint16_t seq;
300
301         pinghost_t *ptr;
302
303         if (buffer_len < sizeof (struct icmp6_hdr))
304                 return (NULL);
305
306         icmp_hdr = (struct icmp6_hdr *) buffer;
307         buffer     += sizeof (struct icmp);
308         buffer_len -= sizeof (struct icmp);
309
310         if (icmp_hdr->icmp6_type != ICMP6_ECHO_REPLY)
311         {
312                 dprintf ("Unexpected ICMP type: %02x\n", icmp_hdr->icmp6_type);
313                 return (NULL);
314         }
315
316         if (icmp_hdr->icmp6_code != 0)
317         {
318                 dprintf ("Unexpected ICMP code: %02x\n", icmp_hdr->icmp6_code);
319                 return (NULL);
320         }
321
322         ident = ntohs (icmp_hdr->icmp6_id);
323         seq   = ntohs (icmp_hdr->icmp6_seq);
324
325         for (ptr = ph; ptr != NULL; ptr = ptr->next)
326         {
327                 dprintf ("hostname = %s, ident = 0x%04x, seq = %i\n",
328                                 ptr->hostname, ptr->ident, ((ptr->sequence - 1) & 0xFFFF));
329
330                 if (ptr->addrfamily != AF_INET6)
331                         continue;
332
333                 if (!timerisset (ptr->timer))
334                         continue;
335
336                 if (ptr->ident != ident)
337                         continue;
338
339                 if (((ptr->sequence - 1) & 0xFFFF) != seq)
340                         continue;
341
342                 dprintf ("Match found: hostname = %s, ident = 0x%04x, seq = %i\n",
343                                 ptr->hostname, ident, seq);
344
345                 break;
346         }
347
348         if (ptr == NULL)
349         {
350                 dprintf ("No match found for ident = 0x%04x, seq = %i\n",
351                                 ident, seq);
352         }
353
354         return (ptr);
355 }
356
357 static int ping_receive_one (int fd, pinghost_t *ph, struct timeval *now)
358 {
359         char   buffer[4096];
360         size_t buffer_len;
361
362         struct timeval diff;
363
364         pinghost_t *host = NULL;
365
366         struct sockaddr_storage sa;
367         socklen_t               sa_len;
368
369         sa_len = sizeof (sa);
370
371         buffer_len = recvfrom (fd, buffer, sizeof (buffer), 0,
372                         (struct sockaddr *) &sa, &sa_len);
373         if (buffer_len == -1)
374         {
375                 dprintf ("recvfrom: %s\n", strerror (errno));
376                 return (-1);
377         }
378
379         dprintf ("Read %u bytes from fd = %i\n", (unsigned int) buffer_len, fd);
380
381         if (sa.ss_family == AF_INET)
382         {
383                 if ((host = ping_receive_ipv4 (ph, buffer, buffer_len)) == NULL)
384                         return (-1);
385         }
386         else if (sa.ss_family == AF_INET6)
387         {
388                 if ((host = ping_receive_ipv6 (ph, buffer, buffer_len)) == NULL)
389                         return (-1);
390         }
391
392         dprintf ("rcvd: %12i.%06i\n",
393                         (int) now->tv_sec,
394                         (int) now->tv_usec);
395         dprintf ("sent: %12i.%06i\n",
396                         (int) host->timer->tv_sec,
397                         (int) host->timer->tv_usec);
398
399         if (ping_timeval_sub (now, host->timer, &diff) < 0)
400         {
401                 timerclear (host->timer);
402                 return (-1);
403         }
404
405         dprintf ("diff: %12i.%06i\n",
406                         (int) diff.tv_sec,
407                         (int) diff.tv_usec);
408
409         host->latency  = ((double) diff.tv_usec) / 1000.0;
410         host->latency += ((double) diff.tv_sec)  * 1000.0;
411
412         timerclear (host->timer);
413
414         return (0);
415 }
416
417 static int ping_receive_all (pingobj_t *obj)
418 {
419         fd_set readfds;
420         int num_readfds;
421         int max_readfds;
422
423         pinghost_t *ph;
424         pinghost_t *ptr;
425
426         struct timeval endtime;
427         struct timeval nowtime;
428         struct timeval timeout;
429         int status;
430
431         int ret;
432
433         ph = obj->head;
434         ret = 0;
435
436         for (ptr = ph; ptr != NULL; ptr = ptr->next)
437                 ptr->latency = -1.0;
438
439         if (gettimeofday (&nowtime, NULL) == -1)
440         {
441                 ping_set_error (obj, "gettimeofday", strerror (errno));
442                 return (-1);
443         }
444
445         /* Set up timeout */
446         timeout.tv_sec = (time_t) obj->timeout;
447         timeout.tv_usec = (suseconds_t) (1000000 * (obj->timeout - ((double) timeout.tv_sec)));
448
449         dprintf ("Set timeout to %i.%06i seconds\n",
450                         (int) timeout.tv_sec,
451                         (int) timeout.tv_usec);
452
453         ping_timeval_add (&nowtime, &timeout, &endtime);
454
455         while (1)
456         {
457                 FD_ZERO (&readfds);
458                 num_readfds =  0;
459                 max_readfds = -1;
460
461                 for (ptr = ph; ptr != NULL; ptr = ptr->next)
462                 {
463                         if (!timerisset (ptr->timer))
464                                 continue;
465
466                         FD_SET (ptr->fd, &readfds);
467                         num_readfds++;
468
469                         if (max_readfds < ptr->fd)
470                                 max_readfds = ptr->fd;
471                 }
472
473                 if (num_readfds == 0)
474                         break;
475
476                 if (gettimeofday (&nowtime, NULL) == -1)
477                 {
478                         ping_set_error (obj, "gettimeofday", strerror (errno));
479                         return (-1);
480                 }
481
482                 if (ping_timeval_sub (&endtime, &nowtime, &timeout) == -1)
483                         break;
484
485                 dprintf ("Waiting on %i sockets for %i.%06i seconds\n", num_readfds,
486                                 (int) timeout.tv_sec,
487                                 (int) timeout.tv_usec);
488
489                 status = select (max_readfds + 1, &readfds, NULL, NULL, &timeout);
490
491                 if (gettimeofday (&nowtime, NULL) == -1)
492                 {
493                         ping_set_error (obj, "gettimeofday", strerror (errno));
494                         return (-1);
495                 }
496                 
497                 if ((status == -1) && (errno == EINTR))
498                 {
499                         dprintf ("select was interrupted by signal..\n");
500                         continue;
501                 }
502                 else if (status < 0)
503                 {
504                         dprintf ("select: %s\n", strerror (errno));
505                         break;
506                 }
507                 else if (status == 0)
508                 {
509                         dprintf ("select timed out\n");
510                         break;
511                 }
512
513                 for (ptr = ph; ptr != NULL; ptr = ptr->next)
514                 {
515                         if (FD_ISSET (ptr->fd, &readfds))
516                                 if (ping_receive_one (ptr->fd, ph, &nowtime) == 0)
517                                         ret++;
518                 }
519         } /* while (1) */
520         
521         return (ret);
522 }
523
524 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
525  * Sending functions:                                                        *
526  *                                                                           *
527  * ping_send_all                                                             *
528  * +-> ping_send_one_ipv4                                                    *
529  * `-> ping_send_one_ipv6                                                    *
530  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
531 static ssize_t ping_sendto (pingobj_t *obj, pinghost_t *ph,
532                 const void *buf, size_t buflen)
533 {
534         ssize_t ret;
535
536         if (gettimeofday (ph->timer, NULL) == -1)
537         {
538                 timerclear (ph->timer);
539                 return (-1);
540         }
541
542         ret = sendto (ph->fd, buf, buflen, 0,
543                         (struct sockaddr *) ph->addr, ph->addrlen);
544
545         if (ret < 0)
546         {
547 #if defined(EHOSTUNREACH)
548                 if (errno == EHOSTUNREACH)
549                         return (0);
550 #endif
551 #if defined(ENETUNREACH)
552                 if (errno == ENETUNREACH)
553                         return (0);
554 #endif
555                 ping_set_error (obj, "sendto", strerror (errno));
556         }
557
558         return (ret);
559 }
560
561 static int ping_send_one_ipv4 (pingobj_t *obj, pinghost_t *ph)
562 {
563         struct icmp *icmp4;
564         int status;
565
566         char buf[4096];
567         int  buflen;
568
569         char *data;
570         int   datalen;
571
572         dprintf ("ph->hostname = %s\n", ph->hostname);
573
574         memset (buf, '\0', sizeof (buf));
575         icmp4 = (struct icmp *) buf;
576         data  = (char *) (icmp4 + 1);
577
578         icmp4->icmp_type  = ICMP_ECHO;
579         icmp4->icmp_code  = 0;
580         icmp4->icmp_cksum = 0;
581         icmp4->icmp_id    = htons (ph->ident);
582         icmp4->icmp_seq   = htons (ph->sequence);
583
584         buflen = 4096 - sizeof (struct icmp);
585         strncpy (data, ph->data, buflen);
586         datalen = strlen (data);
587
588         buflen = datalen + sizeof (struct icmp);
589
590         icmp4->icmp_cksum = ping_icmp4_checksum (buf, buflen);
591
592         dprintf ("Sending ICMPv4 package with ID 0x%04x\n", ph->ident);
593
594         status = ping_sendto (obj, ph, buf, buflen);
595         if (status < 0)
596         {
597                 perror ("ping_sendto");
598                 return (-1);
599         }
600
601         dprintf ("sendto: status = %i\n", status);
602
603         return (0);
604 }
605
606 static int ping_send_one_ipv6 (pingobj_t *obj, pinghost_t *ph)
607 {
608         struct icmp6_hdr *icmp6;
609         int status;
610
611         char buf[4096];
612         int  buflen;
613
614         char *data;
615         int   datalen;
616
617         dprintf ("ph->hostname = %s\n", ph->hostname);
618
619         memset (buf, '\0', sizeof (buf));
620         icmp6 = (struct icmp6_hdr *) buf;
621         data  = (char *) (icmp6 + 1);
622
623         icmp6->icmp6_type  = ICMP6_ECHO_REQUEST;
624         icmp6->icmp6_code  = 0;
625         /* The checksum will be calculated by the TCP/IP stack.  */
626         /* FIXME */
627         icmp6->icmp6_cksum = 0;
628         icmp6->icmp6_id    = htons (ph->ident);
629         icmp6->icmp6_seq   = htons (ph->sequence);
630
631         buflen = 4096 - sizeof (struct icmp6_hdr);
632         strncpy (data, ph->data, buflen);
633         datalen = strlen (data);
634
635         buflen = datalen + sizeof (struct icmp6_hdr);
636
637         dprintf ("Sending ICMPv6 package with ID 0x%04x\n", ph->ident);
638
639         status = ping_sendto (obj, ph, buf, buflen);
640         if (status < 0)
641         {
642                 perror ("ping_sendto");
643                 return (-1);
644         }
645
646         dprintf ("sendto: status = %i\n", status);
647
648         return (0);
649 }
650
651 static int ping_send_all (pingobj_t *obj)
652 {
653         pinghost_t *ph;
654         pinghost_t *ptr;
655
656         int ret;
657
658         ret = 0;
659         ph = obj->head;
660
661         for (ptr = ph; ptr != NULL; ptr = ptr->next)
662         {
663                 /* start timer.. The GNU `ping6' starts the timer before
664                  * sending the packet, so I will do that too */
665                 if (gettimeofday (ptr->timer, NULL) == -1)
666                 {
667                         dprintf ("gettimeofday: %s\n", strerror (errno));
668                         timerclear (ptr->timer);
669                         ret--;
670                         continue;
671                 }
672                 else
673                 {
674                         dprintf ("timer set for hostname = %s\n", ptr->hostname);
675                 }
676
677                 if (ptr->addrfamily == AF_INET6)
678                 {       
679                         dprintf ("Sending ICMPv6 echo request to `%s'\n", ptr->hostname);
680                         if (ping_send_one_ipv6 (obj, ptr) != 0)
681                         {
682                                 timerclear (ptr->timer);
683                                 ret--;
684                                 continue;
685                         }
686                 }
687                 else if (ptr->addrfamily == AF_INET)
688                 {
689                         dprintf ("Sending ICMPv4 echo request to `%s'\n", ptr->hostname);
690                         if (ping_send_one_ipv4 (obj, ptr) != 0)
691                         {
692                                 timerclear (ptr->timer);
693                                 ret--;
694                                 continue;
695                         }
696                 }
697                 else /* this should not happen */
698                 {
699                         dprintf ("Unknown address family: %i\n", ptr->addrfamily);
700                         timerclear (ptr->timer);
701                         ret--;
702                         continue;
703                 }
704
705                 ptr->sequence++;
706         }
707
708         return (ret);
709 }
710
711 /*
712  * Set the TTL of a socket protocol independently.
713  */
714 static int ping_set_ttl (pinghost_t *ph, int ttl)
715 {
716         int ret = -2;
717
718         if (ph->addrfamily == AF_INET)
719         {
720                 ret = setsockopt (ph->fd, IPPROTO_IP, IP_TTL, &ttl, sizeof (ttl));
721         }
722         else if (ph->addrfamily == AF_INET6)
723         {
724                 ret = setsockopt (ph->fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, &ttl, sizeof (ttl));
725         }
726
727         return (ret);
728 }
729
730 static int ping_get_ident (void)
731 {
732         int fd;
733         static int did_seed = 0;
734
735         int retval;
736
737         if (did_seed == 0)
738         {
739                 if ((fd = open ("/dev/urandom", O_RDONLY)) != -1)
740                 {
741                         unsigned int seed;
742
743                         if (read (fd, &seed, sizeof (seed)) != -1)
744                         {
745                                 did_seed = 1;
746                                 dprintf ("Random seed: %i\n", seed);
747                                 srandom (seed);
748                         }
749
750                         close (fd);
751                 }
752                 else
753                 {
754                         dprintf ("open (/dev/urandom): %s\n", strerror (errno));
755                 }
756         }
757
758         retval = (int) random ();
759
760         dprintf ("Random number: %i\n", retval);
761         
762         return (retval);
763 }
764
765 static pinghost_t *ping_alloc (void)
766 {
767         pinghost_t *ph;
768         size_t      ph_size;
769
770         ph_size = sizeof (pinghost_t)
771                 + sizeof (struct sockaddr_storage)
772                 + sizeof (struct timeval);
773
774         ph = (pinghost_t *) malloc (ph_size);
775         if (ph == NULL)
776                 return (NULL);
777
778         memset (ph, '\0', ph_size);
779
780         ph->timer   = (struct timeval *) (ph + 1);
781         ph->addr    = (struct sockaddr_storage *) (ph->timer + 1);
782
783         ph->addrlen = sizeof (struct sockaddr_storage);
784         ph->fd      = -1;
785         ph->latency = -1.0;
786         ph->ident   = ping_get_ident () & 0xFFFF;
787
788         return (ph);
789 }
790
791 static void ping_free (pinghost_t *ph)
792 {
793         if (ph->fd >= 0)
794                 close (ph->fd);
795         
796         if (ph->username != NULL)
797                 free (ph->username);
798
799         if (ph->hostname != NULL)
800                 free (ph->hostname);
801
802         if (ph->data != NULL)
803                 free (ph->data);
804
805         free (ph);
806 }
807
808 /*
809  * public methods
810  */
811 const char *ping_get_error (pingobj_t *obj)
812 {
813         return (obj->errmsg);
814 }
815
816 pingobj_t *ping_construct (void)
817 {
818         pingobj_t *obj;
819
820         if ((obj = (pingobj_t *) malloc (sizeof (pingobj_t))) == NULL)
821                 return (NULL);
822         memset (obj, '\0', sizeof (pingobj_t));
823
824         obj->timeout    = PING_DEF_TIMEOUT;
825         obj->ttl        = PING_DEF_TTL;
826         obj->addrfamily = PING_DEF_AF;
827         obj->data       = strdup (PING_DEF_DATA);
828
829         return (obj);
830 }
831
832 void ping_destroy (pingobj_t *obj)
833 {
834         pinghost_t *current;
835         pinghost_t *next;
836
837         current = obj->head;
838         next = NULL;
839
840         while (current != NULL)
841         {
842                 next = current->next;
843                 ping_free (current);
844                 current = next;
845         }
846
847         if (obj->data != NULL)
848                 free (obj->data);
849
850         if (obj->srcaddr != NULL)
851                 free (obj->srcaddr);
852
853         free (obj);
854
855         return;
856 }
857
858 int ping_setopt (pingobj_t *obj, int option, void *value)
859 {
860         int ret = 0;
861
862         switch (option)
863         {
864                 case PING_OPT_TIMEOUT:
865                         obj->timeout = *((double *) value);
866                         if (obj->timeout < 0.0)
867                         {
868                                 obj->timeout = PING_DEF_TIMEOUT;
869                                 ret = -1;
870                         }
871                         break;
872
873                 case PING_OPT_TTL:
874                         obj->ttl = *((int *) value);
875                         if ((obj->ttl < 1) || (obj->ttl > 255))
876                         {
877                                 obj->ttl = PING_DEF_TTL;
878                                 ret = -1;
879                         }
880                         break;
881
882                 case PING_OPT_AF:
883                         obj->addrfamily = *((int *) value);
884                         if ((obj->addrfamily != AF_UNSPEC)
885                                         && (obj->addrfamily != AF_INET)
886                                         && (obj->addrfamily != AF_INET6))
887                         {
888                                 obj->addrfamily = PING_DEF_AF;
889                                 ret = -1;
890                         }
891                         if (obj->srcaddr != NULL)
892                         {
893                                 free (obj->srcaddr);
894                                 obj->srcaddr = NULL;
895                         }
896                         break;
897
898                 case PING_OPT_DATA:
899                         if (obj->data != NULL)
900                         {
901                                 free (obj->data);
902                                 obj->data = NULL;
903                         }
904                         obj->data = strdup ((const char *) value);
905                         break;
906
907                 case PING_OPT_SOURCE:
908                 {
909                         char            *hostname = (char *) value;
910                         struct addrinfo  ai_hints;
911                         struct addrinfo *ai_list;
912                         int              status;
913 #if WITH_DEBUG
914                         if (obj->addrfamily != AF_UNSPEC)
915                         {
916                                 dprintf ("Resetting obj->addrfamily to AF_UNSPEC.\n");
917                         }
918 #endif
919                         memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
920                         ai_hints.ai_family = obj->addrfamily = AF_UNSPEC;
921 #if defined(AI_ADDRCONFIG)
922                         ai_hints.ai_flags = AI_ADDRCONFIG;
923 #endif
924                         status = getaddrinfo (hostname, NULL, &ai_hints, &ai_list);
925                         if (status != 0)
926                         {
927                                 ping_set_error (obj, "getaddrinfo",
928                                                 status == EAI_SYSTEM
929                                                 ? strerror (errno)
930                                                 : gai_strerror (status));
931                                 ret = -1;
932                                 break;
933                         }
934 #if WITH_DEBUG
935                         if (ai_list->ai_next != NULL)
936                         {
937                                 dprintf ("hostname = `%s' is ambiguous.\n", hostname);
938                         }
939 #endif
940                         if (obj->srcaddr == NULL)
941                         {
942                                 obj->srcaddrlen = 0;
943                                 obj->srcaddr = (struct sockaddr_storage *) malloc (sizeof (struct sockaddr_storage));
944                                 if (obj->srcaddr == NULL)
945                                 {
946                                         ping_set_error (obj, "malloc",
947                                                         strerror (errno));
948                                         ret = -1;
949                                         freeaddrinfo (ai_list);
950                                         break;
951                                 }
952                         }
953                         memset ((void *) obj->srcaddr, '\0', sizeof (struct sockaddr_storage));
954                         assert (ai_list->ai_addrlen <= sizeof (struct sockaddr_storage));
955                         memcpy ((void *) obj->srcaddr, (const void *) ai_list->ai_addr,
956                                         ai_list->ai_addrlen);
957                         obj->srcaddrlen = ai_list->ai_addrlen;
958                         obj->addrfamily = ai_list->ai_family;
959
960                         freeaddrinfo (ai_list);
961                 } /* case PING_OPT_SOURCE */
962                 break;
963
964                 default:
965                         ret = -2;
966         } /* switch (option) */
967
968         return (ret);
969 } /* int ping_setopt */
970
971
972 int ping_send (pingobj_t *obj)
973 {
974         int ret;
975
976         if (ping_send_all (obj) < 0)
977                 return (-1);
978
979         if ((ret = ping_receive_all (obj)) < 0)
980                 return (-2);
981
982         return (ret);
983 }
984
985 static pinghost_t *ping_host_search (pinghost_t *ph, const char *host)
986 {
987         while (ph != NULL)
988         {
989                 if (strcasecmp (ph->username, host) == 0)
990                         break;
991
992                 ph = ph->next;
993         }
994
995         return (ph);
996 }
997
998 int ping_host_add (pingobj_t *obj, const char *host)
999 {
1000         pinghost_t *ph;
1001
1002         struct sockaddr_storage sockaddr;
1003         socklen_t               sockaddr_len;
1004
1005         struct addrinfo  ai_hints;
1006         struct addrinfo *ai_list, *ai_ptr;
1007         int              ai_return;
1008
1009         dprintf ("host = %s\n", host);
1010
1011         if (ping_host_search (obj->head, host) != NULL)
1012                 return (0);
1013
1014         memset (&ai_hints, '\0', sizeof (ai_hints));
1015         ai_hints.ai_flags     = 0;
1016 #ifdef AI_ADDRCONFIG
1017         ai_hints.ai_flags    |= AI_ADDRCONFIG;
1018 #endif
1019 #ifdef AI_CANONNAME
1020         ai_hints.ai_flags    |= AI_CANONNAME;
1021 #endif
1022         ai_hints.ai_family    = obj->addrfamily;
1023         ai_hints.ai_socktype  = SOCK_RAW;
1024
1025         if ((ph = ping_alloc ()) == NULL)
1026         {
1027                 dprintf ("Out of memory!\n");
1028                 return (-1);
1029         }
1030
1031         if ((ph->username = strdup (host)) == NULL)
1032         {
1033                 dprintf ("Out of memory!\n");
1034                 ping_set_error (obj, "strdup", strerror (errno));
1035                 ping_free (ph);
1036                 return (-1);
1037         }
1038
1039         if ((ph->hostname = strdup (host)) == NULL)
1040         {
1041                 dprintf ("Out of memory!\n");
1042                 ping_set_error (obj, "strdup", strerror (errno));
1043                 ping_free (ph);
1044                 return (-1);
1045         }
1046
1047         /* obj->data is not garuanteed to be != NULL */
1048         if ((ph->data = strdup (obj->data == NULL ? PING_DEF_DATA : obj->data)) == NULL)
1049         {
1050                 dprintf ("Out of memory!\n");
1051                 ping_set_error (obj, "strdup", strerror (errno));
1052                 ping_free (ph);
1053                 return (-1);
1054         }
1055
1056         if ((ai_return = getaddrinfo (host, NULL, &ai_hints, &ai_list)) != 0)
1057         {
1058                 dprintf ("getaddrinfo failed\n");
1059                 ping_set_error (obj, "getaddrinfo",
1060                                 (ai_return == EAI_SYSTEM)
1061                                 ? strerror (errno)
1062                                 : gai_strerror (ai_return));
1063                 ping_free (ph);
1064                 return (-1);
1065         }
1066
1067         if (ai_list == NULL)
1068                 ping_set_error (obj, "getaddrinfo", "No hosts returned");
1069
1070         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1071         {
1072                 ph->fd = -1;
1073
1074                 sockaddr_len = sizeof (sockaddr);
1075                 memset (&sockaddr, '\0', sockaddr_len);
1076
1077                 if (ai_ptr->ai_family == AF_INET)
1078                 {
1079                         struct sockaddr_in *si;
1080
1081                         si = (struct sockaddr_in *) &sockaddr;
1082                         si->sin_family = AF_INET;
1083                         si->sin_port   = htons (ph->ident);
1084                         si->sin_addr.s_addr = htonl (INADDR_ANY);
1085
1086                         ai_ptr->ai_socktype = SOCK_RAW;
1087                         ai_ptr->ai_protocol = IPPROTO_ICMP;
1088                 }
1089                 else if (ai_ptr->ai_family == AF_INET6)
1090                 {
1091                         struct sockaddr_in6 *si;
1092
1093                         si = (struct sockaddr_in6 *) &sockaddr;
1094                         si->sin6_family = AF_INET6;
1095                         si->sin6_port   = htons (ph->ident);
1096                         si->sin6_addr   = in6addr_any;
1097
1098                         ai_ptr->ai_socktype = SOCK_RAW;
1099                         ai_ptr->ai_protocol = IPPROTO_ICMPV6;
1100                 }
1101                 else
1102                 {
1103                         char errmsg[PING_ERRMSG_LEN];
1104
1105                         snprintf (errmsg, PING_ERRMSG_LEN, "Unknown `ai_family': %i", ai_ptr->ai_family);
1106                         errmsg[PING_ERRMSG_LEN - 1] = '\0';
1107
1108                         dprintf (errmsg);
1109                         ping_set_error (obj, "getaddrinfo", errmsg);
1110                         continue;
1111                 }
1112
1113                 /* TODO: Move this to a static function `ping_open_socket' and
1114                  * call it whenever the socket dies. */
1115                 ph->fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
1116                 if (ph->fd == -1)
1117                 {
1118                         dprintf ("socket: %s\n", strerror (errno));
1119                         ping_set_error (obj, "socket", strerror (errno));
1120                         continue;
1121                 }
1122
1123                 if (obj->srcaddr != NULL)
1124                 {
1125                         assert (obj->srcaddrlen > 0);
1126                         assert (obj->srcaddrlen <= sizeof (struct sockaddr_storage));
1127
1128                         if (bind (ph->fd, (struct sockaddr *) obj->srcaddr, obj->srcaddrlen) == -1)
1129                         {
1130                                 dprintf ("bind: %s\n", strerror (errno));
1131                                 ping_set_error (obj, "bind", strerror (errno));
1132                                 close (ph->fd);
1133                                 ph->fd = -1;
1134                                 continue;
1135                         }
1136                 }
1137
1138                 assert (sizeof (struct sockaddr_storage) >= ai_ptr->ai_addrlen);
1139                 memset (ph->addr, '\0', sizeof (struct sockaddr_storage));
1140                 memcpy (ph->addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
1141                 ph->addrlen = ai_ptr->ai_addrlen;
1142                 ph->addrfamily = ai_ptr->ai_family;
1143
1144 #ifdef AI_CANONNAME
1145                 if ((ai_ptr->ai_canonname != NULL)
1146                                 && (strcmp (ph->hostname, ai_ptr->ai_canonname) != 0))
1147                 {
1148                         char *old_hostname;
1149
1150                         dprintf ("ph->hostname = %s; ai_ptr->ai_canonname = %s;\n",
1151                                         ph->hostname, ai_ptr->ai_canonname);
1152
1153                         old_hostname = ph->hostname;
1154                         if ((ph->hostname = strdup (ai_ptr->ai_canonname)) == NULL)
1155                         {
1156                                 /* strdup failed, falling back to old hostname */
1157                                 ph->hostname = old_hostname;
1158                         }
1159                         else if (old_hostname != NULL)
1160                         {
1161                                 free (old_hostname);
1162                         }
1163                 }
1164 #endif /* AI_CANONNAME */
1165
1166                 break;
1167         }
1168
1169         freeaddrinfo (ai_list);
1170
1171         if (ph->fd < 0)
1172         {
1173                 ping_free (ph);
1174                 return (-1);
1175         }
1176
1177         /*
1178          * Adding in the front is much easier, but then the iterator will
1179          * return the host that was added last as first host. That's just not
1180          * nice. -octo
1181          */
1182         if (obj->head == NULL)
1183         {
1184                 obj->head = ph;
1185         }
1186         else
1187         {
1188                 pinghost_t *hptr;
1189
1190                 hptr = obj->head;
1191                 while (hptr->next != NULL)
1192                         hptr = hptr->next;
1193
1194                 assert ((hptr != NULL) && (hptr->next == NULL));
1195                 hptr->next = ph;
1196         }
1197
1198         ping_set_ttl (ph, obj->ttl);
1199
1200         return (0);
1201 }
1202
1203 int ping_host_remove (pingobj_t *obj, const char *host)
1204 {
1205         pinghost_t *pre, *cur;
1206
1207         pre = NULL;
1208         cur = obj->head;
1209
1210         while (cur != NULL)
1211         {
1212                 if (strcasecmp (host, cur->username) == 0)
1213                         break;
1214
1215                 pre = cur;
1216                 cur = cur->next;
1217         }
1218
1219         if (cur == NULL)
1220         {
1221                 ping_set_error (obj, "ping_host_remove", "Host not found");
1222                 return (-1);
1223         }
1224
1225         if (pre == NULL)
1226                 obj->head = cur->next;
1227         else
1228                 pre->next = cur->next;
1229         
1230         ping_free (cur);
1231
1232         return (0);
1233 }
1234
1235 pingobj_iter_t *ping_iterator_get (pingobj_t *obj)
1236 {
1237         return ((pingobj_iter_t *) obj->head);
1238 }
1239
1240 pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter)
1241 {
1242         return ((pingobj_iter_t *) iter->next);
1243 }
1244
1245 int ping_iterator_get_info (pingobj_iter_t *iter, int info,
1246                 void *buffer, size_t *buffer_len)
1247 {
1248         int ret = EINVAL;
1249
1250         size_t orig_buffer_len = *buffer_len;
1251
1252         switch (info)
1253         {
1254                 case PING_INFO_USERNAME:
1255                         ret = ENOMEM;
1256                         *buffer_len = strlen (iter->username);
1257                         if (orig_buffer_len <= *buffer_len)
1258                                 break;
1259                         /* Since (orig_buffer_len > *buffer_len) `strncpy'
1260                          * will copy `*buffer_len' and pad the rest of
1261                          * `buffer' with null-bytes */
1262                         strncpy (buffer, iter->username, orig_buffer_len);
1263                         ret = 0;
1264                         break;
1265
1266                 case PING_INFO_HOSTNAME:
1267                         ret = ENOMEM;
1268                         *buffer_len = strlen (iter->hostname);
1269                         if (orig_buffer_len <= *buffer_len)
1270                                 break;
1271                         /* Since (orig_buffer_len > *buffer_len) `strncpy'
1272                          * will copy `*buffer_len' and pad the rest of
1273                          * `buffer' with null-bytes */
1274                         strncpy (buffer, iter->hostname, orig_buffer_len);
1275                         ret = 0;
1276                         break;
1277
1278                 case PING_INFO_ADDRESS:
1279                         ret = getnameinfo ((struct sockaddr *) iter->addr,
1280                                         iter->addrlen,
1281                                         (char *) buffer,
1282                                         *buffer_len,
1283                                         NULL, 0,
1284                                         NI_NUMERICHOST);
1285                         if (ret != 0)
1286                         {
1287                                 if ((ret == EAI_MEMORY)
1288 #ifdef EAI_OVERFLOW
1289                                                 || (ret == EAI_OVERFLOW)
1290 #endif
1291                                    )
1292                                         ret = ENOMEM;
1293                                 else if (ret == EAI_SYSTEM)
1294                                         ret = errno;
1295                                 else
1296                                         ret = EINVAL;
1297                         }
1298                         break;
1299
1300                 case PING_INFO_FAMILY:
1301                         ret = ENOMEM;
1302                         *buffer_len = sizeof (int);
1303                         if (orig_buffer_len < sizeof (int))
1304                                 break;
1305                         *((int *) buffer) = iter->addrfamily;
1306                         ret = 0;
1307                         break;
1308
1309                 case PING_INFO_LATENCY:
1310                         ret = ENOMEM;
1311                         *buffer_len = sizeof (double);
1312                         if (orig_buffer_len < sizeof (double))
1313                                 break;
1314                         *((double *) buffer) = iter->latency;
1315                         ret = 0;
1316                         break;
1317
1318                 case PING_INFO_SEQUENCE:
1319                         ret = ENOMEM;
1320                         *buffer_len = sizeof (unsigned int);
1321                         if (orig_buffer_len < sizeof (unsigned int))
1322                                 break;
1323                         *((unsigned int *) buffer) = (unsigned int) iter->sequence;
1324                         ret = 0;
1325                         break;
1326
1327                 case PING_INFO_IDENT:
1328                         ret = ENOMEM;
1329                         *buffer_len = sizeof (uint16_t);
1330                         if (orig_buffer_len < sizeof (uint16_t))
1331                                 break;
1332                         *((uint16_t *) buffer) = (uint16_t) iter->ident;
1333                         ret = 0;
1334                         break;
1335
1336                 case PING_INFO_DATA:
1337                         ret = ENOMEM;
1338                         *buffer_len = strlen (iter->data);
1339                         if (orig_buffer_len < *buffer_len)
1340                                 break;
1341                         strncpy ((char *) buffer, iter->data, orig_buffer_len);
1342                         ret = 0;
1343                         break;
1344         }
1345
1346         return (ret);
1347 }
1348
1349 void *ping_iterator_get_context (pingobj_iter_t *iter)
1350 {
1351         return (iter->context);
1352 }
1353
1354 void ping_iterator_set_context (pingobj_iter_t *iter, void *context)
1355 {
1356         iter->context = context;
1357 }