2 * collectd - src/ping.c
3 * Copyright (C) 2005-2012 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
31 #include "utils_complain.h"
33 #include <netinet/in.h>
35 #include <netdb.h> /* NI_MAXHOST */
38 #ifdef HAVE_SYS_CAPABILITY_H
39 #include <sys/capability.h>
45 #define NI_MAXHOST 1025
48 #if defined(OPING_VERSION) && (OPING_VERSION >= 1003000)
49 #define HAVE_OPING_1_3
63 double latency_squared;
65 struct hostlist_s *next;
67 typedef struct hostlist_s hostlist_t;
72 static hostlist_t *hostlist_head = NULL;
74 static char *ping_source = NULL;
76 static char *ping_device = NULL;
78 static char *ping_data = NULL;
79 static int ping_ttl = PING_DEF_TTL;
80 static double ping_interval = 1.0;
81 static double ping_timeout = 0.9;
82 static int ping_max_missed = -1;
84 static pthread_mutex_t ping_lock = PTHREAD_MUTEX_INITIALIZER;
85 static pthread_cond_t ping_cond = PTHREAD_COND_INITIALIZER;
86 static int ping_thread_loop = 0;
87 static int ping_thread_error = 0;
88 static pthread_t ping_thread_id;
90 static const char *config_keys[] = {"Host", "SourceAddress",
94 "Size", "TTL", "Interval",
95 "Timeout", "MaxMissed"};
96 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
101 /* Assure that `ts->tv_nsec' is in the range 0 .. 999999999 */
102 static void time_normalize(struct timespec *ts) /* {{{ */
104 while (ts->tv_nsec < 0) {
105 if (ts->tv_sec == 0) {
111 ts->tv_nsec += 1000000000;
114 while (ts->tv_nsec >= 1000000000) {
116 ts->tv_nsec -= 1000000000;
118 } /* }}} void time_normalize */
120 /* Add `ts_int' to `tv_begin' and store the result in `ts_dest'. If the result
121 * is larger than `tv_end', copy `tv_end' to `ts_dest' instead. */
122 static void time_calc(struct timespec *ts_dest, /* {{{ */
123 const struct timespec *ts_int,
124 const struct timeval *tv_begin,
125 const struct timeval *tv_end) {
126 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
127 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
128 time_normalize(ts_dest);
130 /* Assure that `(begin + interval) > end'.
131 * This may seem overly complicated, but `tv_sec' is of type `time_t'
132 * which may be `unsigned. *sigh* */
133 if ((tv_end->tv_sec > ts_dest->tv_sec) ||
134 ((tv_end->tv_sec == ts_dest->tv_sec) &&
135 ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec))) {
136 ts_dest->tv_sec = tv_end->tv_sec;
137 ts_dest->tv_nsec = 1000 * tv_end->tv_usec;
140 time_normalize(ts_dest);
141 } /* }}} void time_calc */
143 static int ping_dispatch_all(pingobj_t *pingobj) /* {{{ */
148 for (pingobj_iter_t *iter = ping_iterator_get(pingobj); iter != NULL;
149 iter = ping_iterator_next(iter)) { /* {{{ */
150 char userhost[NI_MAXHOST];
154 param_size = sizeof(userhost);
155 status = ping_iterator_get_info(iter,
156 #ifdef PING_INFO_USERNAME
161 userhost, ¶m_size);
163 WARNING("ping plugin: ping_iterator_get_info failed: %s",
164 ping_get_error(pingobj));
168 for (hl = hostlist_head; hl != NULL; hl = hl->next)
169 if (strcmp(userhost, hl->host) == 0)
173 WARNING("ping plugin: Cannot find host %s.", userhost);
177 param_size = sizeof(latency);
178 status = ping_iterator_get_info(iter, PING_INFO_LATENCY, (void *)&latency,
181 WARNING("ping plugin: ping_iterator_get_info failed: %s",
182 ping_get_error(pingobj));
187 if (latency >= 0.0) {
189 hl->latency_total += latency;
190 hl->latency_squared += (latency * latency);
192 /* reset missed packages counter */
197 /* if the host did not answer our last N packages, trigger a resolv. */
198 if ((ping_max_missed >= 0) &&
199 (hl->pkg_missed >= ((uint32_t)ping_max_missed))) { /* {{{ */
200 /* we reset the missed package counter here, since we only want to
201 * trigger a resolv every N packages and not every package _AFTER_ N
205 WARNING("ping plugin: host %s has not answered %d PING requests,"
206 " triggering resolve",
207 hl->host, ping_max_missed);
209 /* we trigger the resolv simply be removeing and adding the host to our
211 status = ping_host_remove(pingobj, hl->host);
213 WARNING("ping plugin: ping_host_remove (%s) failed.", hl->host);
215 status = ping_host_add(pingobj, hl->host);
217 ERROR("ping plugin: ping_host_add (%s) failed.", hl->host);
219 } /* }}} ping_max_missed */
220 } /* }}} for (iter) */
223 } /* }}} int ping_dispatch_all */
225 static void *ping_thread(void *arg) /* {{{ */
227 struct timeval tv_begin;
228 struct timeval tv_end;
229 struct timespec ts_wait;
230 struct timespec ts_int;
234 c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
236 pingobj_t *pingobj = ping_construct();
237 if (pingobj == NULL) {
238 ERROR("ping plugin: ping_construct failed.");
239 pthread_mutex_lock(&ping_lock);
240 ping_thread_error = 1;
241 pthread_mutex_unlock(&ping_lock);
245 if (ping_source != NULL)
246 if (ping_setopt(pingobj, PING_OPT_SOURCE, (void *)ping_source) != 0)
247 ERROR("ping plugin: Failed to set source address: %s",
248 ping_get_error(pingobj));
250 #ifdef HAVE_OPING_1_3
251 if (ping_device != NULL)
252 if (ping_setopt(pingobj, PING_OPT_DEVICE, (void *)ping_device) != 0)
253 ERROR("ping plugin: Failed to set device: %s", ping_get_error(pingobj));
256 ping_setopt(pingobj, PING_OPT_TIMEOUT, (void *)&ping_timeout);
257 ping_setopt(pingobj, PING_OPT_TTL, (void *)&ping_ttl);
259 if (ping_data != NULL)
260 ping_setopt(pingobj, PING_OPT_DATA, (void *)ping_data);
262 /* Add all the hosts to the ping object. */
264 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) {
266 tmp_status = ping_host_add(pingobj, hl->host);
268 WARNING("ping plugin: ping_host_add (%s) failed: %s", hl->host,
269 ping_get_error(pingobj));
275 ERROR("ping plugin: No host could be added to ping object. Giving up.");
276 pthread_mutex_lock(&ping_lock);
277 ping_thread_error = 1;
278 pthread_mutex_unlock(&ping_lock);
282 /* Set up `ts_int' */
287 temp_nsec = modf(ping_interval, &temp_sec);
288 ts_int.tv_sec = (time_t)temp_sec;
289 ts_int.tv_nsec = (long)(temp_nsec * 1000000000L);
292 pthread_mutex_lock(&ping_lock);
293 while (ping_thread_loop > 0) {
294 _Bool send_successful = 0;
296 if (gettimeofday(&tv_begin, NULL) < 0) {
297 ERROR("ping plugin: gettimeofday failed: %s", STRERRNO);
298 ping_thread_error = 1;
302 pthread_mutex_unlock(&ping_lock);
304 int status = ping_send(pingobj);
306 c_complain(LOG_ERR, &complaint, "ping plugin: ping_send failed: %s",
307 ping_get_error(pingobj));
309 c_release(LOG_NOTICE, &complaint, "ping plugin: ping_send succeeded.");
313 pthread_mutex_lock(&ping_lock);
315 if (ping_thread_loop <= 0)
319 (void)ping_dispatch_all(pingobj);
321 if (gettimeofday(&tv_end, NULL) < 0) {
322 ERROR("ping plugin: gettimeofday failed: %s", STRERRNO);
323 ping_thread_error = 1;
327 /* Calculate the absolute time until which to wait and store it in
329 time_calc(&ts_wait, &ts_int, &tv_begin, &tv_end);
331 pthread_cond_timedwait(&ping_cond, &ping_lock, &ts_wait);
332 if (ping_thread_loop <= 0)
334 } /* while (ping_thread_loop > 0) */
336 pthread_mutex_unlock(&ping_lock);
337 ping_destroy(pingobj);
340 } /* }}} void *ping_thread */
342 static int start_thread(void) /* {{{ */
346 pthread_mutex_lock(&ping_lock);
348 if (ping_thread_loop != 0) {
349 pthread_mutex_unlock(&ping_lock);
353 ping_thread_loop = 1;
354 ping_thread_error = 0;
355 status = plugin_thread_create(&ping_thread_id, /* attr = */ NULL, ping_thread,
356 /* arg = */ (void *)0, "ping");
358 ping_thread_loop = 0;
359 ERROR("ping plugin: Starting thread failed.");
360 pthread_mutex_unlock(&ping_lock);
364 pthread_mutex_unlock(&ping_lock);
366 } /* }}} int start_thread */
368 static int stop_thread(void) /* {{{ */
372 pthread_mutex_lock(&ping_lock);
374 if (ping_thread_loop == 0) {
375 pthread_mutex_unlock(&ping_lock);
379 ping_thread_loop = 0;
380 pthread_cond_broadcast(&ping_cond);
381 pthread_mutex_unlock(&ping_lock);
383 status = pthread_join(ping_thread_id, /* return = */ NULL);
385 ERROR("ping plugin: Stopping thread failed.");
389 pthread_mutex_lock(&ping_lock);
390 memset(&ping_thread_id, 0, sizeof(ping_thread_id));
391 ping_thread_error = 0;
392 pthread_mutex_unlock(&ping_lock);
395 } /* }}} int stop_thread */
397 static int ping_init(void) /* {{{ */
399 if (hostlist_head == NULL) {
400 NOTICE("ping plugin: No hosts have been configured.");
404 if (ping_timeout > ping_interval) {
405 ping_timeout = 0.9 * ping_interval;
406 WARNING("ping plugin: Timeout is greater than interval. "
407 "Will use a timeout of %gs.",
411 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_NET_RAW)
412 if (check_capability(CAP_NET_RAW) != 0) {
414 WARNING("ping plugin: Running collectd as root, but the CAP_NET_RAW "
415 "capability is missing. The plugin's read function will probably "
416 "fail. Is your init system dropping capabilities?");
418 WARNING("ping plugin: collectd doesn't have the CAP_NET_RAW capability. "
419 "If you don't want to run collectd as root, try running \"setcap "
420 "cap_net_raw=ep\" on the collectd binary.");
424 return start_thread();
425 } /* }}} int ping_init */
427 static int config_set_string(const char *name, /* {{{ */
428 char **var, const char *value) {
433 ERROR("ping plugin: Setting `%s' to `%s' failed: strdup failed: %s", name,
442 } /* }}} int config_set_string */
444 static int ping_config(const char *key, const char *value) /* {{{ */
446 if (strcasecmp(key, "Host") == 0) {
450 hl = malloc(sizeof(*hl));
452 ERROR("ping plugin: malloc failed: %s", STRERRNO);
456 host = strdup(value);
459 ERROR("ping plugin: strdup failed: %s", STRERRNO);
467 hl->latency_total = 0.0;
468 hl->latency_squared = 0.0;
469 hl->next = hostlist_head;
471 } else if (strcasecmp(key, "SourceAddress") == 0) {
472 int status = config_set_string(key, &ping_source, value);
476 #ifdef HAVE_OPING_1_3
477 else if (strcasecmp(key, "Device") == 0) {
478 int status = config_set_string(key, &ping_device, value);
483 else if (strcasecmp(key, "TTL") == 0) {
484 int ttl = atoi(value);
485 if ((ttl > 0) && (ttl <= 255))
488 WARNING("ping plugin: Ignoring invalid TTL %i.", ttl);
489 } else if (strcasecmp(key, "Interval") == 0) {
496 WARNING("ping plugin: Ignoring invalid interval %g (%s)", tmp, value);
497 } else if (strcasecmp(key, "Size") == 0) {
498 size_t size = (size_t)atoi(value);
500 /* Max IP packet size - (IPv6 + ICMP) = 65535 - (40 + 8) = 65487 */
503 ping_data = malloc(size + 1);
504 if (ping_data == NULL) {
505 ERROR("ping plugin: malloc failed.");
509 /* Note: By default oping is using constant string
510 * "liboping -- ICMP ping library <http://octo.it/liboping/>"
511 * which is exactly 56 bytes.
513 * Optimally we would follow the ping(1) behaviour, but we
514 * cannot use byte 00 or start data payload at exactly same
515 * location, due to oping library limitations. */
516 for (size_t i = 0; i < size; i++) /* {{{ */
518 /* This restricts data pattern to be only composed of easily
519 * printable characters, and not NUL character. */
520 ping_data[i] = ('0' + i % 64);
521 } /* }}} for (i = 0; i < size; i++) */
524 WARNING("ping plugin: Ignoring invalid Size %" PRIsz ".", size);
525 } else if (strcasecmp(key, "Timeout") == 0) {
532 WARNING("ping plugin: Ignoring invalid timeout %g (%s)", tmp, value);
533 } else if (strcasecmp(key, "MaxMissed") == 0) {
534 ping_max_missed = atoi(value);
535 if (ping_max_missed < 0)
536 INFO("ping plugin: MaxMissed < 0, disabled re-resolving of hosts");
542 } /* }}} int ping_config */
544 static void submit(const char *host, const char *type, /* {{{ */
546 value_list_t vl = VALUE_LIST_INIT;
548 vl.values = &(value_t){.gauge = value};
550 sstrncpy(vl.plugin, "ping", sizeof(vl.plugin));
551 sstrncpy(vl.type_instance, host, sizeof(vl.type_instance));
552 sstrncpy(vl.type, type, sizeof(vl.type));
554 plugin_dispatch_values(&vl);
555 } /* }}} void ping_submit */
557 static int ping_read(void) /* {{{ */
559 if (ping_thread_error != 0) {
560 ERROR("ping plugin: The ping thread had a problem. Restarting it.");
564 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) {
567 hl->latency_total = 0.0;
568 hl->latency_squared = 0.0;
574 } /* if (ping_thread_error != 0) */
576 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) /* {{{ */
580 double latency_total;
581 double latency_squared;
583 double latency_average;
584 double latency_stddev;
588 /* Locking here works, because the structure of the linked list is only
589 * changed during configure and shutdown. */
590 pthread_mutex_lock(&ping_lock);
592 pkg_sent = hl->pkg_sent;
593 pkg_recv = hl->pkg_recv;
594 latency_total = hl->latency_total;
595 latency_squared = hl->latency_squared;
599 hl->latency_total = 0.0;
600 hl->latency_squared = 0.0;
602 pthread_mutex_unlock(&ping_lock);
604 /* This e. g. happens when starting up. */
606 DEBUG("ping plugin: No packages for host %s have been sent.", hl->host);
610 /* Calculate average. Beware of division by zero. */
612 latency_average = NAN;
614 latency_average = latency_total / ((double)pkg_recv);
616 /* Calculate standard deviation. Beware even more of division by zero. */
618 latency_stddev = NAN;
619 else if (pkg_recv == 1)
620 latency_stddev = 0.0;
622 latency_stddev = sqrt(((((double)pkg_recv) * latency_squared) -
623 (latency_total * latency_total)) /
624 ((double)(pkg_recv * (pkg_recv - 1))));
626 /* Calculate drop rate. */
627 droprate = ((double)(pkg_sent - pkg_recv)) / ((double)pkg_sent);
629 submit(hl->host, "ping", latency_average);
630 submit(hl->host, "ping_stddev", latency_stddev);
631 submit(hl->host, "ping_droprate", droprate);
632 } /* }}} for (hl = hostlist_head; hl != NULL; hl = hl->next) */
635 } /* }}} int ping_read */
637 static int ping_shutdown(void) /* {{{ */
641 INFO("ping plugin: Shutting down thread.");
642 if (stop_thread() < 0)
657 if (ping_data != NULL) {
663 } /* }}} int ping_shutdown */
665 void module_register(void) {
666 plugin_register_config("ping", ping_config, config_keys, config_keys_num);
667 plugin_register_init("ping", ping_init);
668 plugin_register_read("ping", ping_read);
669 plugin_register_shutdown("ping", ping_shutdown);
670 } /* void module_register */