1 /**
2 * collectd - src/ping.c
3 * Copyright (C) 2005-2012 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 **/
27 #include "collectd.h"
29 #include "common.h"
30 #include "plugin.h"
31 #include "configfile.h"
32 #include "utils_complain.h"
34 #include <netinet/in.h>
35 #if HAVE_NETDB_H
36 # include <netdb.h> /* NI_MAXHOST */
37 #endif
39 #include <oping.h>
41 #ifndef NI_MAXHOST
42 # define NI_MAXHOST 1025
43 #endif
45 #if defined(OPING_VERSION) && (OPING_VERSION >= 1003000)
46 # define HAVE_OPING_1_3
47 #endif
49 /*
50 * Private data types
51 */
52 struct hostlist_s
53 {
54 char *host;
56 uint32_t pkg_sent;
57 uint32_t pkg_recv;
58 uint32_t pkg_missed;
60 double latency_total;
61 double latency_squared;
63 struct hostlist_s *next;
64 };
65 typedef struct hostlist_s hostlist_t;
67 /*
68 * Private variables
69 */
70 static hostlist_t *hostlist_head = NULL;
72 static char *ping_source = NULL;
73 #ifdef HAVE_OPING_1_3
74 static char *ping_device = NULL;
75 #endif
76 static char *ping_data = NULL;
77 static int ping_ttl = PING_DEF_TTL;
78 static double ping_interval = 1.0;
79 static double ping_timeout = 0.9;
80 static int ping_max_missed = -1;
82 static int ping_thread_loop = 0;
83 static int ping_thread_error = 0;
84 static pthread_t ping_thread_id;
85 static pthread_mutex_t ping_lock = PTHREAD_MUTEX_INITIALIZER;
86 static pthread_cond_t ping_cond = PTHREAD_COND_INITIALIZER;
88 static const char *config_keys[] =
89 {
90 "Host",
91 "SourceAddress",
92 #ifdef HAVE_OPING_1_3
93 "Device",
94 #endif
95 "Size",
96 "TTL",
97 "Interval",
98 "Timeout",
99 "MaxMissed"
100 };
101 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
103 /*
104 * Private functions
105 */
106 /* Assure that `ts->tv_nsec' is in the range 0 .. 999999999 */
107 static void time_normalize (struct timespec *ts) /* {{{ */
108 {
109 while (ts->tv_nsec < 0)
110 {
111 if (ts->tv_sec == 0)
112 {
113 ts->tv_nsec = 0;
114 return;
115 }
117 ts->tv_sec -= 1;
118 ts->tv_nsec += 1000000000;
119 }
121 while (ts->tv_nsec >= 1000000000)
122 {
123 ts->tv_sec += 1;
124 ts->tv_nsec -= 1000000000;
125 }
126 } /* }}} void time_normalize */
128 /* Add `ts_int' to `tv_begin' and store the result in `ts_dest'. If the result
129 * is larger than `tv_end', copy `tv_end' to `ts_dest' instead. */
130 static void time_calc (struct timespec *ts_dest, /* {{{ */
131 const struct timespec *ts_int,
132 const struct timeval *tv_begin,
133 const struct timeval *tv_end)
134 {
135 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
136 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
137 time_normalize (ts_dest);
139 /* Assure that `(begin + interval) > end'.
140 * This may seem overly complicated, but `tv_sec' is of type `time_t'
141 * which may be `unsigned. *sigh* */
142 if ((tv_end->tv_sec > ts_dest->tv_sec)
143 || ((tv_end->tv_sec == ts_dest->tv_sec)
144 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
145 {
146 ts_dest->tv_sec = tv_end->tv_sec;
147 ts_dest->tv_nsec = 1000 * tv_end->tv_usec;
148 }
150 time_normalize (ts_dest);
151 } /* }}} void time_calc */
153 static int ping_dispatch_all (pingobj_t *pingobj) /* {{{ */
154 {
155 hostlist_t *hl;
156 int status;
158 for (pingobj_iter_t *iter = ping_iterator_get (pingobj);
159 iter != NULL;
160 iter = ping_iterator_next (iter))
161 { /* {{{ */
162 char userhost[NI_MAXHOST];
163 double latency;
164 size_t param_size;
166 param_size = sizeof (userhost);
167 status = ping_iterator_get_info (iter,
168 #ifdef PING_INFO_USERNAME
169 PING_INFO_USERNAME,
170 #else
171 PING_INFO_HOSTNAME,
172 #endif
173 userhost, ¶m_size);
174 if (status != 0)
175 {
176 WARNING ("ping plugin: ping_iterator_get_info failed: %s",
177 ping_get_error (pingobj));
178 continue;
179 }
181 for (hl = hostlist_head; hl != NULL; hl = hl->next)
182 if (strcmp (userhost, hl->host) == 0)
183 break;
185 if (hl == NULL)
186 {
187 WARNING ("ping plugin: Cannot find host %s.", userhost);
188 continue;
189 }
191 param_size = sizeof (latency);
192 status = ping_iterator_get_info (iter, PING_INFO_LATENCY,
193 (void *) &latency, ¶m_size);
194 if (status != 0)
195 {
196 WARNING ("ping plugin: ping_iterator_get_info failed: %s",
197 ping_get_error (pingobj));
198 continue;
199 }
201 hl->pkg_sent++;
202 if (latency >= 0.0)
203 {
204 hl->pkg_recv++;
205 hl->latency_total += latency;
206 hl->latency_squared += (latency * latency);
208 /* reset missed packages counter */
209 hl->pkg_missed = 0;
210 } else
211 hl->pkg_missed++;
213 /* if the host did not answer our last N packages, trigger a resolv. */
214 if ((ping_max_missed >= 0)
215 && (hl->pkg_missed >= ((uint32_t) ping_max_missed)))
216 { /* {{{ */
217 /* we reset the missed package counter here, since we only want to
218 * trigger a resolv every N packages and not every package _AFTER_ N
219 * missed packages */
220 hl->pkg_missed = 0;
222 WARNING ("ping plugin: host %s has not answered %d PING requests,"
223 " triggering resolve", hl->host, ping_max_missed);
225 /* we trigger the resolv simply be removeing and adding the host to our
226 * ping object */
227 status = ping_host_remove (pingobj, hl->host);
228 if (status != 0)
229 {
230 WARNING ("ping plugin: ping_host_remove (%s) failed.", hl->host);
231 }
232 else
233 {
234 status = ping_host_add (pingobj, hl->host);
235 if (status != 0)
236 ERROR ("ping plugin: ping_host_add (%s) failed.", hl->host);
237 }
238 } /* }}} ping_max_missed */
239 } /* }}} for (iter) */
241 return (0);
242 } /* }}} int ping_dispatch_all */
244 static void *ping_thread (void *arg) /* {{{ */
245 {
246 pingobj_t *pingobj = NULL;
248 struct timeval tv_begin;
249 struct timeval tv_end;
250 struct timespec ts_wait;
251 struct timespec ts_int;
253 int count;
255 c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
257 pthread_mutex_lock (&ping_lock);
259 pingobj = ping_construct ();
260 if (pingobj == NULL)
261 {
262 ERROR ("ping plugin: ping_construct failed.");
263 ping_thread_error = 1;
264 pthread_mutex_unlock (&ping_lock);
265 return ((void *) -1);
266 }
268 if (ping_source != NULL)
269 if (ping_setopt (pingobj, PING_OPT_SOURCE, (void *) ping_source) != 0)
270 ERROR ("ping plugin: Failed to set source address: %s",
271 ping_get_error (pingobj));
273 #ifdef HAVE_OPING_1_3
274 if (ping_device != NULL)
275 if (ping_setopt (pingobj, PING_OPT_DEVICE, (void *) ping_device) != 0)
276 ERROR ("ping plugin: Failed to set device: %s",
277 ping_get_error (pingobj));
278 #endif
280 ping_setopt (pingobj, PING_OPT_TIMEOUT, (void *) &ping_timeout);
281 ping_setopt (pingobj, PING_OPT_TTL, (void *) &ping_ttl);
283 if (ping_data != NULL)
284 ping_setopt (pingobj, PING_OPT_DATA, (void *) ping_data);
286 /* Add all the hosts to the ping object. */
287 count = 0;
288 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next)
289 {
290 int tmp_status;
291 tmp_status = ping_host_add (pingobj, hl->host);
292 if (tmp_status != 0)
293 WARNING ("ping plugin: ping_host_add (%s) failed: %s",
294 hl->host, ping_get_error (pingobj));
295 else
296 count++;
297 }
299 if (count == 0)
300 {
301 ERROR ("ping plugin: No host could be added to ping object. Giving up.");
302 ping_thread_error = 1;
303 pthread_mutex_unlock (&ping_lock);
304 return ((void *) -1);
305 }
307 /* Set up `ts_int' */
308 {
309 double temp_sec;
310 double temp_nsec;
312 temp_nsec = modf (ping_interval, &temp_sec);
313 ts_int.tv_sec = (time_t) temp_sec;
314 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
315 }
317 while (ping_thread_loop > 0)
318 {
319 int status;
320 _Bool send_successful = 0;
322 if (gettimeofday (&tv_begin, NULL) < 0)
323 {
324 char errbuf[1024];
325 ERROR ("ping plugin: gettimeofday failed: %s",
326 sstrerror (errno, errbuf, sizeof (errbuf)));
327 ping_thread_error = 1;
328 break;
329 }
331 pthread_mutex_unlock (&ping_lock);
333 status = ping_send (pingobj);
334 if (status < 0)
335 {
336 c_complain (LOG_ERR, &complaint, "ping plugin: ping_send failed: %s",
337 ping_get_error (pingobj));
338 }
339 else
340 {
341 c_release (LOG_NOTICE, &complaint, "ping plugin: ping_send succeeded.");
342 send_successful = 1;
343 }
345 pthread_mutex_lock (&ping_lock);
347 if (ping_thread_loop <= 0)
348 break;
350 if (send_successful)
351 (void) ping_dispatch_all (pingobj);
353 if (gettimeofday (&tv_end, NULL) < 0)
354 {
355 char errbuf[1024];
356 ERROR ("ping plugin: gettimeofday failed: %s",
357 sstrerror (errno, errbuf, sizeof (errbuf)));
358 ping_thread_error = 1;
359 break;
360 }
362 /* Calculate the absolute time until which to wait and store it in
363 * `ts_wait'. */
364 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
366 pthread_cond_timedwait (&ping_cond, &ping_lock, &ts_wait);
367 if (ping_thread_loop <= 0)
368 break;
369 } /* while (ping_thread_loop > 0) */
371 pthread_mutex_unlock (&ping_lock);
372 ping_destroy (pingobj);
374 return ((void *) 0);
375 } /* }}} void *ping_thread */
377 static int start_thread (void) /* {{{ */
378 {
379 int status;
381 pthread_mutex_lock (&ping_lock);
383 if (ping_thread_loop != 0)
384 {
385 pthread_mutex_unlock (&ping_lock);
386 return (0);
387 }
389 ping_thread_loop = 1;
390 ping_thread_error = 0;
391 status = plugin_thread_create (&ping_thread_id, /* attr = */ NULL,
392 ping_thread, /* arg = */ (void *) 0);
393 if (status != 0)
394 {
395 ping_thread_loop = 0;
396 ERROR ("ping plugin: Starting thread failed.");
397 pthread_mutex_unlock (&ping_lock);
398 return (-1);
399 }
401 pthread_mutex_unlock (&ping_lock);
402 return (0);
403 } /* }}} int start_thread */
405 static int stop_thread (void) /* {{{ */
406 {
407 int status;
409 pthread_mutex_lock (&ping_lock);
411 if (ping_thread_loop == 0)
412 {
413 pthread_mutex_unlock (&ping_lock);
414 return (-1);
415 }
417 ping_thread_loop = 0;
418 pthread_cond_broadcast (&ping_cond);
419 pthread_mutex_unlock (&ping_lock);
421 status = pthread_join (ping_thread_id, /* return = */ NULL);
422 if (status != 0)
423 {
424 ERROR ("ping plugin: Stopping thread failed.");
425 status = -1;
426 }
428 pthread_mutex_lock (&ping_lock);
429 memset (&ping_thread_id, 0, sizeof (ping_thread_id));
430 ping_thread_error = 0;
431 pthread_mutex_unlock (&ping_lock);
433 return (status);
434 } /* }}} int stop_thread */
436 static int ping_init (void) /* {{{ */
437 {
438 if (hostlist_head == NULL)
439 {
440 NOTICE ("ping plugin: No hosts have been configured.");
441 return (-1);
442 }
444 if (ping_timeout > ping_interval)
445 {
446 ping_timeout = 0.9 * ping_interval;
447 WARNING ("ping plugin: Timeout is greater than interval. "
448 "Will use a timeout of %gs.", ping_timeout);
449 }
451 return (start_thread ());
452 } /* }}} int ping_init */
454 static int config_set_string (const char *name, /* {{{ */
455 char **var, const char *value)
456 {
457 char *tmp;
459 tmp = strdup (value);
460 if (tmp == NULL)
461 {
462 char errbuf[1024];
463 ERROR ("ping plugin: Setting `%s' to `%s' failed: strdup failed: %s",
464 name, value, sstrerror (errno, errbuf, sizeof (errbuf)));
465 return (1);
466 }
468 if (*var != NULL)
469 free (*var);
470 *var = tmp;
471 return (0);
472 } /* }}} int config_set_string */
474 static int ping_config (const char *key, const char *value) /* {{{ */
475 {
476 if (strcasecmp (key, "Host") == 0)
477 {
478 hostlist_t *hl;
479 char *host;
481 hl = malloc (sizeof (*hl));
482 if (hl == NULL)
483 {
484 char errbuf[1024];
485 ERROR ("ping plugin: malloc failed: %s",
486 sstrerror (errno, errbuf, sizeof (errbuf)));
487 return (1);
488 }
490 host = strdup (value);
491 if (host == NULL)
492 {
493 char errbuf[1024];
494 sfree (hl);
495 ERROR ("ping plugin: strdup failed: %s",
496 sstrerror (errno, errbuf, sizeof (errbuf)));
497 return (1);
498 }
500 hl->host = host;
501 hl->pkg_sent = 0;
502 hl->pkg_recv = 0;
503 hl->pkg_missed = 0;
504 hl->latency_total = 0.0;
505 hl->latency_squared = 0.0;
506 hl->next = hostlist_head;
507 hostlist_head = hl;
508 }
509 else if (strcasecmp (key, "SourceAddress") == 0)
510 {
511 int status = config_set_string (key, &ping_source, value);
512 if (status != 0)
513 return (status);
514 }
515 #ifdef HAVE_OPING_1_3
516 else if (strcasecmp (key, "Device") == 0)
517 {
518 int status = config_set_string (key, &ping_device, value);
519 if (status != 0)
520 return (status);
521 }
522 #endif
523 else if (strcasecmp (key, "TTL") == 0)
524 {
525 int ttl = atoi (value);
526 if ((ttl > 0) && (ttl <= 255))
527 ping_ttl = ttl;
528 else
529 WARNING ("ping plugin: Ignoring invalid TTL %i.", ttl);
530 }
531 else if (strcasecmp (key, "Interval") == 0)
532 {
533 double tmp;
535 tmp = atof (value);
536 if (tmp > 0.0)
537 ping_interval = tmp;
538 else
539 WARNING ("ping plugin: Ignoring invalid interval %g (%s)",
540 tmp, value);
541 }
542 else if (strcasecmp (key, "Size") == 0) {
543 size_t size = (size_t) atoi (value);
545 /* Max IP packet size - (IPv6 + ICMP) = 65535 - (40 + 8) = 65487 */
546 if (size <= 65487)
547 {
548 sfree (ping_data);
549 ping_data = malloc (size + 1);
550 if (ping_data == NULL)
551 {
552 ERROR ("ping plugin: malloc failed.");
553 return (1);
554 }
556 /* Note: By default oping is using constant string
557 * "liboping -- ICMP ping library <http://octo.it/liboping/>"
558 * which is exactly 56 bytes.
559 *
560 * Optimally we would follow the ping(1) behaviour, but we
561 * cannot use byte 00 or start data payload at exactly same
562 * location, due to oping library limitations. */
563 for (size_t i = 0; i < size; i++) /* {{{ */
564 {
565 /* This restricts data pattern to be only composed of easily
566 * printable characters, and not NUL character. */
567 ping_data[i] = ('0' + i % 64);
568 } /* }}} for (i = 0; i < size; i++) */
569 ping_data[size] = 0;
570 } else
571 WARNING ("ping plugin: Ignoring invalid Size %zu.", size);
572 }
573 else if (strcasecmp (key, "Timeout") == 0)
574 {
575 double tmp;
577 tmp = atof (value);
578 if (tmp > 0.0)
579 ping_timeout = tmp;
580 else
581 WARNING ("ping plugin: Ignoring invalid timeout %g (%s)",
582 tmp, value);
583 }
584 else if (strcasecmp (key, "MaxMissed") == 0)
585 {
586 ping_max_missed = atoi (value);
587 if (ping_max_missed < 0)
588 INFO ("ping plugin: MaxMissed < 0, disabled re-resolving of hosts");
589 }
590 else
591 {
592 return (-1);
593 }
595 return (0);
596 } /* }}} int ping_config */
598 static void submit (const char *host, const char *type, /* {{{ */
599 gauge_t value)
600 {
601 value_t values[1];
602 value_list_t vl = VALUE_LIST_INIT;
604 values[0].gauge = value;
606 vl.values = values;
607 vl.values_len = 1;
608 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
609 sstrncpy (vl.plugin, "ping", sizeof (vl.plugin));
610 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
611 sstrncpy (vl.type_instance, host, sizeof (vl.type_instance));
612 sstrncpy (vl.type, type, sizeof (vl.type));
614 plugin_dispatch_values (&vl);
615 } /* }}} void ping_submit */
617 static int ping_read (void) /* {{{ */
618 {
619 if (ping_thread_error != 0)
620 {
621 ERROR ("ping plugin: The ping thread had a problem. Restarting it.");
623 stop_thread ();
625 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next)
626 {
627 hl->pkg_sent = 0;
628 hl->pkg_recv = 0;
629 hl->latency_total = 0.0;
630 hl->latency_squared = 0.0;
631 }
633 start_thread ();
635 return (-1);
636 } /* if (ping_thread_error != 0) */
638 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) /* {{{ */
639 {
640 uint32_t pkg_sent;
641 uint32_t pkg_recv;
642 double latency_total;
643 double latency_squared;
645 double latency_average;
646 double latency_stddev;
648 double droprate;
650 /* Locking here works, because the structure of the linked list is only
651 * changed during configure and shutdown. */
652 pthread_mutex_lock (&ping_lock);
654 pkg_sent = hl->pkg_sent;
655 pkg_recv = hl->pkg_recv;
656 latency_total = hl->latency_total;
657 latency_squared = hl->latency_squared;
659 hl->pkg_sent = 0;
660 hl->pkg_recv = 0;
661 hl->latency_total = 0.0;
662 hl->latency_squared = 0.0;
664 pthread_mutex_unlock (&ping_lock);
666 /* This e. g. happens when starting up. */
667 if (pkg_sent == 0)
668 {
669 DEBUG ("ping plugin: No packages for host %s have been sent.",
670 hl->host);
671 continue;
672 }
674 /* Calculate average. Beware of division by zero. */
675 if (pkg_recv == 0)
676 latency_average = NAN;
677 else
678 latency_average = latency_total / ((double) pkg_recv);
680 /* Calculate standard deviation. Beware even more of division by zero. */
681 if (pkg_recv == 0)
682 latency_stddev = NAN;
683 else if (pkg_recv == 1)
684 latency_stddev = 0.0;
685 else
686 latency_stddev = sqrt (((((double) pkg_recv) * latency_squared)
687 - (latency_total * latency_total))
688 / ((double) (pkg_recv * (pkg_recv - 1))));
690 /* Calculate drop rate. */
691 droprate = ((double) (pkg_sent - pkg_recv)) / ((double) pkg_sent);
693 submit (hl->host, "ping", latency_average);
694 submit (hl->host, "ping_stddev", latency_stddev);
695 submit (hl->host, "ping_droprate", droprate);
696 } /* }}} for (hl = hostlist_head; hl != NULL; hl = hl->next) */
698 return (0);
699 } /* }}} int ping_read */
701 static int ping_shutdown (void) /* {{{ */
702 {
703 hostlist_t *hl;
705 INFO ("ping plugin: Shutting down thread.");
706 if (stop_thread () < 0)
707 return (-1);
709 hl = hostlist_head;
710 while (hl != NULL)
711 {
712 hostlist_t *hl_next;
714 hl_next = hl->next;
716 sfree (hl->host);
717 sfree (hl);
719 hl = hl_next;
720 }
722 if (ping_data != NULL) {
723 free (ping_data);
724 ping_data = NULL;
725 }
727 return (0);
728 } /* }}} int ping_shutdown */
730 void module_register (void)
731 {
732 plugin_register_config ("ping", ping_config,
733 config_keys, config_keys_num);
734 plugin_register_init ("ping", ping_init);
735 plugin_register_read ("ping", ping_read);
736 plugin_register_shutdown ("ping", ping_shutdown);
737 } /* void module_register */
739 /* vim: set sw=2 sts=2 et fdm=marker : */