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 int ping_thread_loop = 0;
85 static int ping_thread_error = 0;
86 static pthread_t ping_thread_id;
87 static pthread_mutex_t ping_lock = PTHREAD_MUTEX_INITIALIZER;
88 static pthread_cond_t ping_cond = PTHREAD_COND_INITIALIZER;
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 pingobj_t *pingobj = NULL;
229 struct timeval tv_begin;
230 struct timeval tv_end;
231 struct timespec ts_wait;
232 struct timespec ts_int;
236 c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
238 pthread_mutex_lock(&ping_lock);
240 pingobj = ping_construct();
241 if (pingobj == NULL) {
242 ERROR("ping plugin: ping_construct failed.");
243 ping_thread_error = 1;
244 pthread_mutex_unlock(&ping_lock);
248 if (ping_source != NULL)
249 if (ping_setopt(pingobj, PING_OPT_SOURCE, (void *)ping_source) != 0)
250 ERROR("ping plugin: Failed to set source address: %s",
251 ping_get_error(pingobj));
253 #ifdef HAVE_OPING_1_3
254 if (ping_device != NULL)
255 if (ping_setopt(pingobj, PING_OPT_DEVICE, (void *)ping_device) != 0)
256 ERROR("ping plugin: Failed to set device: %s", ping_get_error(pingobj));
259 ping_setopt(pingobj, PING_OPT_TIMEOUT, (void *)&ping_timeout);
260 ping_setopt(pingobj, PING_OPT_TTL, (void *)&ping_ttl);
262 if (ping_data != NULL)
263 ping_setopt(pingobj, PING_OPT_DATA, (void *)ping_data);
265 /* Add all the hosts to the ping object. */
267 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) {
269 tmp_status = ping_host_add(pingobj, hl->host);
271 WARNING("ping plugin: ping_host_add (%s) failed: %s", hl->host,
272 ping_get_error(pingobj));
278 ERROR("ping plugin: No host could be added to ping object. Giving up.");
279 ping_thread_error = 1;
280 pthread_mutex_unlock(&ping_lock);
284 /* Set up `ts_int' */
289 temp_nsec = modf(ping_interval, &temp_sec);
290 ts_int.tv_sec = (time_t)temp_sec;
291 ts_int.tv_nsec = (long)(temp_nsec * 1000000000L);
294 while (ping_thread_loop > 0) {
296 _Bool send_successful = 0;
298 if (gettimeofday(&tv_begin, NULL) < 0) {
299 ERROR("ping plugin: gettimeofday failed: %s", STRERRNO);
300 ping_thread_error = 1;
304 pthread_mutex_unlock(&ping_lock);
306 status = ping_send(pingobj);
308 c_complain(LOG_ERR, &complaint, "ping plugin: ping_send failed: %s",
309 ping_get_error(pingobj));
311 c_release(LOG_NOTICE, &complaint, "ping plugin: ping_send succeeded.");
315 pthread_mutex_lock(&ping_lock);
317 if (ping_thread_loop <= 0)
321 (void)ping_dispatch_all(pingobj);
323 if (gettimeofday(&tv_end, NULL) < 0) {
324 ERROR("ping plugin: gettimeofday failed: %s", STRERRNO);
325 ping_thread_error = 1;
329 /* Calculate the absolute time until which to wait and store it in
331 time_calc(&ts_wait, &ts_int, &tv_begin, &tv_end);
333 pthread_cond_timedwait(&ping_cond, &ping_lock, &ts_wait);
334 if (ping_thread_loop <= 0)
336 } /* while (ping_thread_loop > 0) */
338 pthread_mutex_unlock(&ping_lock);
339 ping_destroy(pingobj);
342 } /* }}} void *ping_thread */
344 static int start_thread(void) /* {{{ */
348 pthread_mutex_lock(&ping_lock);
350 if (ping_thread_loop != 0) {
351 pthread_mutex_unlock(&ping_lock);
355 ping_thread_loop = 1;
356 ping_thread_error = 0;
357 status = plugin_thread_create(&ping_thread_id, /* attr = */ NULL, ping_thread,
358 /* arg = */ (void *)0, "ping");
360 ping_thread_loop = 0;
361 ERROR("ping plugin: Starting thread failed.");
362 pthread_mutex_unlock(&ping_lock);
366 pthread_mutex_unlock(&ping_lock);
368 } /* }}} int start_thread */
370 static int stop_thread(void) /* {{{ */
374 pthread_mutex_lock(&ping_lock);
376 if (ping_thread_loop == 0) {
377 pthread_mutex_unlock(&ping_lock);
381 ping_thread_loop = 0;
382 pthread_cond_broadcast(&ping_cond);
383 pthread_mutex_unlock(&ping_lock);
385 status = pthread_join(ping_thread_id, /* return = */ NULL);
387 ERROR("ping plugin: Stopping thread failed.");
391 pthread_mutex_lock(&ping_lock);
392 memset(&ping_thread_id, 0, sizeof(ping_thread_id));
393 ping_thread_error = 0;
394 pthread_mutex_unlock(&ping_lock);
397 } /* }}} int stop_thread */
399 static int ping_init(void) /* {{{ */
401 if (hostlist_head == NULL) {
402 NOTICE("ping plugin: No hosts have been configured.");
406 if (ping_timeout > ping_interval) {
407 ping_timeout = 0.9 * ping_interval;
408 WARNING("ping plugin: Timeout is greater than interval. "
409 "Will use a timeout of %gs.",
413 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_NET_RAW)
414 if (check_capability(CAP_NET_RAW) != 0) {
416 WARNING("ping plugin: Running collectd as root, but the CAP_NET_RAW "
417 "capability is missing. The plugin's read function will probably "
418 "fail. Is your init system dropping capabilities?");
420 WARNING("ping plugin: collectd doesn't have the CAP_NET_RAW capability. "
421 "If you don't want to run collectd as root, try running \"setcap "
422 "cap_net_raw=ep\" on the collectd binary.");
426 return start_thread();
427 } /* }}} int ping_init */
429 static int config_set_string(const char *name, /* {{{ */
430 char **var, const char *value) {
435 ERROR("ping plugin: Setting `%s' to `%s' failed: strdup failed: %s", name,
444 } /* }}} int config_set_string */
446 static int ping_config(const char *key, const char *value) /* {{{ */
448 if (strcasecmp(key, "Host") == 0) {
452 hl = malloc(sizeof(*hl));
454 ERROR("ping plugin: malloc failed: %s", STRERRNO);
458 host = strdup(value);
461 ERROR("ping plugin: strdup failed: %s", STRERRNO);
469 hl->latency_total = 0.0;
470 hl->latency_squared = 0.0;
471 hl->next = hostlist_head;
473 } else if (strcasecmp(key, "SourceAddress") == 0) {
474 int status = config_set_string(key, &ping_source, value);
478 #ifdef HAVE_OPING_1_3
479 else if (strcasecmp(key, "Device") == 0) {
480 int status = config_set_string(key, &ping_device, value);
485 else if (strcasecmp(key, "TTL") == 0) {
486 int ttl = atoi(value);
487 if ((ttl > 0) && (ttl <= 255))
490 WARNING("ping plugin: Ignoring invalid TTL %i.", ttl);
491 } else if (strcasecmp(key, "Interval") == 0) {
498 WARNING("ping plugin: Ignoring invalid interval %g (%s)", tmp, value);
499 } else if (strcasecmp(key, "Size") == 0) {
500 size_t size = (size_t)atoi(value);
502 /* Max IP packet size - (IPv6 + ICMP) = 65535 - (40 + 8) = 65487 */
505 ping_data = malloc(size + 1);
506 if (ping_data == NULL) {
507 ERROR("ping plugin: malloc failed.");
511 /* Note: By default oping is using constant string
512 * "liboping -- ICMP ping library <http://octo.it/liboping/>"
513 * which is exactly 56 bytes.
515 * Optimally we would follow the ping(1) behaviour, but we
516 * cannot use byte 00 or start data payload at exactly same
517 * location, due to oping library limitations. */
518 for (size_t i = 0; i < size; i++) /* {{{ */
520 /* This restricts data pattern to be only composed of easily
521 * printable characters, and not NUL character. */
522 ping_data[i] = ('0' + i % 64);
523 } /* }}} for (i = 0; i < size; i++) */
526 WARNING("ping plugin: Ignoring invalid Size %zu.", size);
527 } else if (strcasecmp(key, "Timeout") == 0) {
534 WARNING("ping plugin: Ignoring invalid timeout %g (%s)", tmp, value);
535 } else if (strcasecmp(key, "MaxMissed") == 0) {
536 ping_max_missed = atoi(value);
537 if (ping_max_missed < 0)
538 INFO("ping plugin: MaxMissed < 0, disabled re-resolving of hosts");
544 } /* }}} int ping_config */
546 static void submit(const char *host, const char *type, /* {{{ */
548 value_list_t vl = VALUE_LIST_INIT;
550 vl.values = &(value_t){.gauge = value};
552 sstrncpy(vl.plugin, "ping", sizeof(vl.plugin));
553 sstrncpy(vl.type_instance, host, sizeof(vl.type_instance));
554 sstrncpy(vl.type, type, sizeof(vl.type));
556 plugin_dispatch_values(&vl);
557 } /* }}} void ping_submit */
559 static int ping_read(void) /* {{{ */
561 if (ping_thread_error != 0) {
562 ERROR("ping plugin: The ping thread had a problem. Restarting it.");
566 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) {
569 hl->latency_total = 0.0;
570 hl->latency_squared = 0.0;
576 } /* if (ping_thread_error != 0) */
578 for (hostlist_t *hl = hostlist_head; hl != NULL; hl = hl->next) /* {{{ */
582 double latency_total;
583 double latency_squared;
585 double latency_average;
586 double latency_stddev;
590 /* Locking here works, because the structure of the linked list is only
591 * changed during configure and shutdown. */
592 pthread_mutex_lock(&ping_lock);
594 pkg_sent = hl->pkg_sent;
595 pkg_recv = hl->pkg_recv;
596 latency_total = hl->latency_total;
597 latency_squared = hl->latency_squared;
601 hl->latency_total = 0.0;
602 hl->latency_squared = 0.0;
604 pthread_mutex_unlock(&ping_lock);
606 /* This e. g. happens when starting up. */
608 DEBUG("ping plugin: No packages for host %s have been sent.", hl->host);
612 /* Calculate average. Beware of division by zero. */
614 latency_average = NAN;
616 latency_average = latency_total / ((double)pkg_recv);
618 /* Calculate standard deviation. Beware even more of division by zero. */
620 latency_stddev = NAN;
621 else if (pkg_recv == 1)
622 latency_stddev = 0.0;
624 latency_stddev = sqrt(((((double)pkg_recv) * latency_squared) -
625 (latency_total * latency_total)) /
626 ((double)(pkg_recv * (pkg_recv - 1))));
628 /* Calculate drop rate. */
629 droprate = ((double)(pkg_sent - pkg_recv)) / ((double)pkg_sent);
631 submit(hl->host, "ping", latency_average);
632 submit(hl->host, "ping_stddev", latency_stddev);
633 submit(hl->host, "ping_droprate", droprate);
634 } /* }}} for (hl = hostlist_head; hl != NULL; hl = hl->next) */
637 } /* }}} int ping_read */
639 static int ping_shutdown(void) /* {{{ */
643 INFO("ping plugin: Shutting down thread.");
644 if (stop_thread() < 0)
659 if (ping_data != NULL) {
665 } /* }}} int ping_shutdown */
667 void module_register(void) {
668 plugin_register_config("ping", ping_config, config_keys, config_keys_num);
669 plugin_register_init("ping", ping_init);
670 plugin_register_read("ping", ping_read);
671 plugin_register_shutdown("ping", ping_shutdown);
672 } /* void module_register */