2 * collectd - src/common.c
3 * Copyright (C) 2005-2014 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>
25 * Niki W. Waibel <niki.waibel@gmx.net>
26 * Sebastian Harl <sh at tokkee.org>
27 * Michał Mirosław <mirq-linux at rere.qmqm.pl>
33 #include "utils/common/common.h"
34 #include "utils_cache.h"
38 #include <sys/types.h>
43 #include <netinet/in.h>
46 #if HAVE_NETINET_TCP_H
47 #include <netinet/tcp.h>
50 /* for ntohl and htonl */
52 #include <arpa/inet.h>
56 #include <sys/capability.h>
64 extern kstat_ctl_t *kc;
67 #if !defined(MSG_DONTWAIT)
68 #if defined(MSG_NONBLOCK)
69 /* AIX doesn't have MSG_DONTWAIT */
70 #define MSG_DONTWAIT MSG_NONBLOCK
72 /* Windows doesn't have MSG_DONTWAIT or MSG_NONBLOCK */
73 #define MSG_DONTWAIT 0
74 #endif /* defined(MSG_NONBLOCK) */
75 #endif /* !defined(MSG_DONTWAIT) */
77 #if !HAVE_GETPWNAM_R && defined(HAVE_GETPWNAM)
78 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
82 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
85 char *sstrncpy(char *dest, const char *src, size_t n) {
86 strncpy(dest, src, n);
90 } /* char *sstrncpy */
92 /* ssnprintf returns zero on success, one if truncation occurred
93 and a negative integer onerror. */
94 int ssnprintf(char *str, size_t sz, const char *format, ...) {
98 int ret = vsnprintf(str, sz, format, ap);
105 return (size_t)ret >= sz;
106 } /* int ssnprintf */
108 char *ssnprintf_alloc(char const *format, ...) /* {{{ */
110 char static_buffer[1024] = "";
112 size_t alloc_buffer_size;
116 /* Try printing into the static buffer. In many cases it will be
117 * sufficiently large and we can simply return a strdup() of this
119 va_start(ap, format);
120 status = vsnprintf(static_buffer, sizeof(static_buffer), format, ap);
125 /* "status" does not include the null byte. */
126 alloc_buffer_size = (size_t)(status + 1);
127 if (alloc_buffer_size <= sizeof(static_buffer))
128 return strdup(static_buffer);
130 /* Allocate a buffer large enough to hold the string. */
131 alloc_buffer = calloc(1, alloc_buffer_size);
132 if (alloc_buffer == NULL)
135 /* Print again into this new buffer. */
136 va_start(ap, format);
137 status = vsnprintf(alloc_buffer, alloc_buffer_size, format, ap);
145 } /* }}} char *ssnprintf_alloc */
147 char *sstrdup(const char *s) {
154 /* Do not use `strdup' here, because it's not specified in POSIX. It's
155 * ``only'' an XSI extension. */
159 ERROR("sstrdup: Out of memory.");
165 } /* char *sstrdup */
167 /* Even though Posix requires "strerror_r" to return an "int",
168 * some systems (e.g. the GNU libc) return a "char *" _and_
169 * ignore the second argument ... -tokkee */
170 char *sstrerror(int errnum, char *buf, size_t buflen) {
177 pthread_mutex_lock(&strerror_r_lock);
179 temp = strerror(errnum);
180 sstrncpy(buf, temp, buflen);
182 pthread_mutex_unlock(&strerror_r_lock);
184 /* #endif !HAVE_STRERROR_R */
186 #elif STRERROR_R_CHAR_P
189 temp = strerror_r(errnum, buf, buflen);
190 if (buf[0] == '\0') {
191 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
192 sstrncpy(buf, temp, buflen);
195 "strerror_r did not return "
200 /* #endif STRERROR_R_CHAR_P */
203 if (strerror_r(errnum, buf, buflen) != 0) {
204 snprintf(buf, buflen,
206 "Additionally, strerror_r failed.",
209 #endif /* STRERROR_R_CHAR_P */
212 } /* char *sstrerror */
214 void *smalloc(size_t size) {
217 if ((r = malloc(size)) == NULL) {
218 ERROR("Not enough memory.");
223 } /* void *smalloc */
226 void sfree (void **ptr)
238 int sread(int fd, void *buf, size_t count) {
247 status = read(fd, (void *)ptr, nleft);
249 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
256 DEBUG("Received EOF from fd %i. ", fd);
260 assert((0 > status) || (nleft >= (size_t)status));
262 nleft = nleft - ((size_t)status);
263 ptr = ptr + ((size_t)status);
269 int swrite(int fd, const void *buf, size_t count) {
275 ptr = (const char *)buf;
283 /* checking for closed peer connection */
285 pfd.events = POLLIN | POLLHUP;
287 if (poll(&pfd, 1, 0) > 0) {
289 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
290 /* if recv returns zero (even though poll() said there is data to be
291 * read), that means the connection has been closed */
298 status = write(fd, (const void *)ptr, nleft);
300 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
304 return errno ? errno : status;
306 nleft = nleft - ((size_t)status);
307 ptr = ptr + ((size_t)status);
313 int strsplit(char *string, char **fields, size_t size) {
321 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
332 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
338 size_t buffer_req = 0;
340 if (((fields_num != 0) && (fields == NULL)) ||
341 ((buffer_size != 0) && (buffer == NULL)))
347 if (buffer_size != 0)
348 avail = buffer_size - 1;
351 sep_len = strlen(sep);
353 for (size_t i = 0; i < fields_num; i++) {
354 size_t field_len = strlen(fields[i]);
357 buffer_req += sep_len;
358 buffer_req += field_len;
360 if (buffer_size == 0)
363 if ((i != 0) && (sep_len > 0)) {
364 if (sep_len >= avail) {
365 /* prevent subsequent iterations from writing to the
371 memcpy(ptr, sep, sep_len);
377 if (field_len > avail)
380 memcpy(ptr, fields[i], field_len);
388 return (int)buffer_req;
391 int escape_string(char *buffer, size_t buffer_size) {
395 /* Check if we need to escape at all first */
396 temp = strpbrk(buffer, " \t\"\\");
403 temp = calloc(1, buffer_size);
410 for (size_t i = 0; i < buffer_size; i++) {
411 if (buffer[i] == 0) {
413 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
414 if (j > (buffer_size - 4))
417 temp[j + 1] = buffer[i];
420 if (j > (buffer_size - 3))
427 assert((j + 1) < buffer_size);
431 sstrncpy(buffer, temp, buffer_size);
434 } /* int escape_string */
436 int strunescape(char *buf, size_t buf_len) {
437 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
441 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
442 P_ERROR("string unescape: backslash found at end of string.");
443 /* Ensure null-byte at the end of the buffer. */
448 switch (buf[i + 1]) {
463 /* Move everything after the position one position to the left.
464 * Add a null-byte as last character in the buffer. */
465 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
466 buf[buf_len - 1] = '\0';
469 } /* int strunescape */
471 size_t strstripnewline(char *buffer) {
472 size_t buffer_len = strlen(buffer);
474 while (buffer_len > 0) {
475 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
478 buffer[buffer_len] = 0;
482 } /* size_t strstripnewline */
484 int escape_slashes(char *buffer, size_t buffer_size) {
487 buffer_len = strlen(buffer);
489 if (buffer_len <= 1) {
490 if (strcmp("/", buffer) == 0) {
493 sstrncpy(buffer, "root", buffer_size);
498 /* Move one to the left */
499 if (buffer[0] == '/') {
500 memmove(buffer, buffer + 1, buffer_len);
504 for (size_t i = 0; i < buffer_len; i++) {
505 if (buffer[i] == '/')
510 } /* int escape_slashes */
512 void replace_special(char *buffer, size_t buffer_size) {
513 for (size_t i = 0; i < buffer_size; i++) {
516 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
519 } /* void replace_special */
521 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
522 struct timeval *larger;
523 struct timeval *smaller;
527 NORMALIZE_TIMEVAL(tv0);
528 NORMALIZE_TIMEVAL(tv1);
530 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
538 if ((tv0.tv_sec < tv1.tv_sec) ||
539 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
550 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
552 if (smaller->tv_usec <= larger->tv_usec)
553 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
556 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
560 assert((delta == NULL) ||
561 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
564 } /* int timeval_cmp */
566 int check_create_dir(const char *file_orig) {
569 char file_copy[PATH_MAX];
575 int last_is_file = 1;
576 int path_is_absolute = 0;
580 * Sanity checks first
582 if (file_orig == NULL)
585 if ((len = strlen(file_orig)) < 1)
587 else if (len >= sizeof(file_copy)) {
588 ERROR("check_create_dir: name (%s) is too long.", file_orig);
593 * If `file_orig' ends in a slash the last component is a directory,
594 * otherwise it's a file. Act accordingly..
596 if (file_orig[len - 1] == '/')
598 if (file_orig[0] == '/')
599 path_is_absolute = 1;
602 * Create a copy for `strtok_r' to destroy
604 sstrncpy(file_copy, file_orig, sizeof(file_copy));
607 * Break into components. This will eat up several slashes in a row and
608 * remove leading and trailing slashes..
613 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
617 if (fields_num >= 16)
622 * For each component, do..
624 for (int i = 0; i < (fields_num - last_is_file); i++) {
626 * Do not create directories that start with a dot. This
627 * prevents `../../' attacks and other likely malicious
630 if (fields[i][0] == '.') {
631 P_ERROR("Cowardly refusing to create a directory that "
632 "begins with a `.' (dot): `%s'",
638 * Join the components together again
641 if (strjoin(dir + path_is_absolute,
642 (size_t)(sizeof(dir) - path_is_absolute), fields,
643 (size_t)(i + 1), "/") < 0) {
644 P_ERROR("strjoin failed: `%s', component #%i", file_orig, i);
649 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
650 if (errno == ENOENT) {
651 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
654 /* this might happen, if a different thread created
655 * the directory in the meantime
656 * => call stat() again to check for S_ISDIR() */
660 P_ERROR("check_create_dir: mkdir (%s): %s", dir, STRERRNO);
663 P_ERROR("check_create_dir: stat (%s): %s", dir, STRERRNO);
666 } else if (!S_ISDIR(statbuf.st_mode)) {
667 P_ERROR("check_create_dir: `%s' exists but is not "
677 } /* check_create_dir */
680 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
688 snprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
690 *ksp_ptr = kstat_lookup(kc, module, instance, name);
691 if (*ksp_ptr == NULL) {
692 P_ERROR("get_kstat: Cound not find kstat %s", ident);
696 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
697 P_ERROR("get_kstat: kstat %s has wrong type", ident);
703 assert(*ksp_ptr != NULL);
704 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
707 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
708 P_ERROR("get_kstat: kstat %s could not be read", ident);
712 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
713 P_ERROR("get_kstat: kstat %s has wrong type", ident);
720 long long get_kstat_value(kstat_t *ksp, char *name) {
722 long long retval = -1LL;
725 P_ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
727 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
728 P_ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
729 "is not KSTAT_TYPE_NAMED (%#x).",
730 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
734 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
737 if (kn->data_type == KSTAT_DATA_INT32)
738 retval = (long long)kn->value.i32;
739 else if (kn->data_type == KSTAT_DATA_UINT32)
740 retval = (long long)kn->value.ui32;
741 else if (kn->data_type == KSTAT_DATA_INT64)
742 retval = (long long)kn->value.i64; /* According to ANSI C99 `long long' must
743 hold at least 64 bits */
744 else if (kn->data_type == KSTAT_DATA_UINT64)
745 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
747 P_WARNING("get_kstat_value: Not a numeric value: %s", name);
751 #endif /* HAVE_LIBKSTAT */
754 unsigned long long ntohll(unsigned long long n) {
755 #if BYTE_ORDER == BIG_ENDIAN
758 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
760 } /* unsigned long long ntohll */
762 unsigned long long htonll(unsigned long long n) {
763 #if BYTE_ORDER == BIG_ENDIAN
766 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
768 } /* unsigned long long htonll */
769 #endif /* HAVE_HTONLL */
771 #if FP_LAYOUT_NEED_NOTHING
772 /* Well, we need nothing.. */
773 /* #endif FP_LAYOUT_NEED_NOTHING */
775 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
776 #if FP_LAYOUT_NEED_ENDIANFLIP
777 #define FP_CONVERT(A) \
778 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
779 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
780 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
781 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
782 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
783 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
784 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
785 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
787 #define FP_CONVERT(A) \
788 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
789 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
792 double ntohd(double d) {
801 /* NAN in x86 byte order */
802 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
803 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
804 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
810 ret.integer = FP_CONVERT(tmp);
815 double htond(double d) {
823 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
824 ret.byte[4] = ret.byte[5] = 0x00;
832 tmp = FP_CONVERT(ret.integer);
837 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
839 int format_name(char *ret, int ret_len, const char *hostname,
840 const char *plugin, const char *plugin_instance,
841 const char *type, const char *type_instance) {
846 buffer_size = (size_t)ret_len;
848 #define APPEND(str) \
850 size_t l = strlen(str); \
851 if (l >= buffer_size) \
853 memcpy(buffer, (str), l); \
858 assert(plugin != NULL);
859 assert(type != NULL);
864 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
866 APPEND(plugin_instance);
870 if ((type_instance != NULL) && (type_instance[0] != 0)) {
872 APPEND(type_instance);
874 assert(buffer_size > 0);
879 } /* int format_name */
881 int format_values(char *ret, size_t ret_len, /* {{{ */
882 const data_set_t *ds, const value_list_t *vl,
886 gauge_t *rates = NULL;
888 assert(0 == strcmp(ds->type, vl->type));
890 memset(ret, 0, ret_len);
892 #define BUFFER_ADD(...) \
894 status = snprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
898 } else if (((size_t)status) >= (ret_len - offset)) { \
902 offset += ((size_t)status); \
905 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
907 for (size_t i = 0; i < ds->ds_num; i++) {
908 if (ds->ds[i].type == DS_TYPE_GAUGE)
909 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
910 else if (store_rates) {
912 rates = uc_get_rate(ds, vl);
914 WARNING("format_values: uc_get_rate failed.");
917 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
918 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
919 BUFFER_ADD(":%" PRIu64, (uint64_t)vl->values[i].counter);
920 else if (ds->ds[i].type == DS_TYPE_DERIVE)
921 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
922 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
923 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
925 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
929 } /* for ds->ds_num */
935 } /* }}} int format_values */
937 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
938 char **ret_plugin_instance, char **ret_type,
939 char **ret_type_instance, char *default_host) {
940 char *hostname = NULL;
942 char *plugin_instance = NULL;
944 char *type_instance = NULL;
947 if (hostname == NULL)
950 plugin = strchr(hostname, '/');
956 type = strchr(plugin, '/');
958 if (default_host == NULL)
960 /* else: no host specified; use default */
963 hostname = default_host;
969 plugin_instance = strchr(plugin, '-');
970 if (plugin_instance != NULL) {
971 *plugin_instance = '\0';
975 type_instance = strchr(type, '-');
976 if (type_instance != NULL) {
977 *type_instance = '\0';
981 *ret_host = hostname;
982 *ret_plugin = plugin;
983 *ret_plugin_instance = plugin_instance;
985 *ret_type_instance = type_instance;
987 } /* int parse_identifier */
989 int parse_identifier_vl(const char *str, value_list_t *vl) /* {{{ */
991 char str_copy[6 * DATA_MAX_NAME_LEN];
994 char *plugin_instance = NULL;
996 char *type_instance = NULL;
999 if ((str == NULL) || (vl == NULL))
1002 sstrncpy(str_copy, str, sizeof(str_copy));
1004 status = parse_identifier(str_copy, &host, &plugin, &plugin_instance, &type,
1006 /* default_host = */ NULL);
1010 sstrncpy(vl->host, host, sizeof(vl->host));
1011 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
1012 sstrncpy(vl->plugin_instance,
1013 (plugin_instance != NULL) ? plugin_instance : "",
1014 sizeof(vl->plugin_instance));
1015 sstrncpy(vl->type, type, sizeof(vl->type));
1016 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
1017 sizeof(vl->type_instance));
1020 } /* }}} int parse_identifier_vl */
1022 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
1024 char *endptr = NULL;
1027 if (value_orig == NULL)
1030 value = strdup(value_orig);
1033 value_len = strlen(value);
1035 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1036 value[value_len - 1] = '\0';
1041 case DS_TYPE_COUNTER:
1042 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1046 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1049 case DS_TYPE_DERIVE:
1050 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1053 case DS_TYPE_ABSOLUTE:
1054 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1059 P_ERROR("parse_value: Invalid data source type: %i.", ds_type);
1063 if (value == endptr) {
1064 P_ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1065 DS_TYPE_TO_STRING(ds_type), value);
1068 } else if ((NULL != endptr) && ('\0' != *endptr))
1069 P_INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1070 "Input string was \"%s\".",
1071 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1075 } /* int parse_value */
1077 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1083 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1090 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1093 if (i >= vl->values_len) {
1094 /* Make sure i is invalid. */
1099 if (vl->time == 0) {
1100 if (strcmp("N", ptr) == 0)
1101 vl->time = cdtime();
1103 char *endptr = NULL;
1107 tmp = strtod(ptr, &endptr);
1108 if ((errno != 0) /* Overflow */
1109 || (endptr == ptr) /* Invalid string */
1110 || (endptr == NULL) /* This should not happen */
1111 || (*endptr != 0)) /* Trailing chars */
1114 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1120 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1121 vl->values[i].gauge = NAN;
1122 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1126 } /* while (strtok_r) */
1128 if ((ptr != NULL) || (i == 0))
1131 } /* int parse_values */
1133 int parse_value_file(char const *path, value_t *ret_value, int ds_type) {
1137 fh = fopen(path, "r");
1141 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
1148 strstripnewline(buffer);
1150 return parse_value(buffer, ret_value, ds_type);
1151 } /* int parse_value_file */
1153 #if !HAVE_GETPWNAM_R
1154 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1155 struct passwd **pwbufp) {
1156 #ifndef HAVE_GETPWNAM
1162 memset(pwbuf, '\0', sizeof(struct passwd));
1164 pthread_mutex_lock(&getpwnam_r_lock);
1167 pw = getpwnam(name);
1169 status = (errno != 0) ? errno : ENOENT;
1173 #define GETPWNAM_COPY_MEMBER(member) \
1174 if (pw->member != NULL) { \
1175 int len = strlen(pw->member); \
1176 if (len >= buflen) { \
1180 sstrncpy(buf, pw->member, buflen); \
1181 pwbuf->member = buf; \
1183 buflen -= (len + 1); \
1185 GETPWNAM_COPY_MEMBER(pw_name);
1186 GETPWNAM_COPY_MEMBER(pw_passwd);
1187 GETPWNAM_COPY_MEMBER(pw_gecos);
1188 GETPWNAM_COPY_MEMBER(pw_dir);
1189 GETPWNAM_COPY_MEMBER(pw_shell);
1191 pwbuf->pw_uid = pw->pw_uid;
1192 pwbuf->pw_gid = pw->pw_gid;
1198 pthread_mutex_unlock(&getpwnam_r_lock);
1201 #endif /* HAVE_GETPWNAM */
1202 } /* int getpwnam_r */
1203 #endif /* !HAVE_GETPWNAM_R */
1205 int notification_init(notification_t *n, int severity, const char *message,
1206 const char *host, const char *plugin,
1207 const char *plugin_instance, const char *type,
1208 const char *type_instance) {
1209 memset(n, '\0', sizeof(notification_t));
1211 n->severity = severity;
1213 if (message != NULL)
1214 sstrncpy(n->message, message, sizeof(n->message));
1216 sstrncpy(n->host, host, sizeof(n->host));
1218 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1219 if (plugin_instance != NULL)
1220 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1222 sstrncpy(n->type, type, sizeof(n->type));
1223 if (type_instance != NULL)
1224 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1227 } /* int notification_init */
1229 int walk_directory(const char *dir, dirwalk_callback_f callback,
1230 void *user_data, int include_hidden) {
1239 if ((dh = opendir(dir)) == NULL) {
1240 P_ERROR("walk_directory: Cannot open '%s': %s", dir, STRERRNO);
1244 while ((ent = readdir(dh)) != NULL) {
1247 if (include_hidden) {
1248 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1250 } else /* if (!include_hidden) */
1252 if (ent->d_name[0] == '.')
1256 status = (*callback)(dir, ent->d_name, user_data);
1265 if ((success == 0) && (failure > 0))
1270 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1274 fh = fopen(filename, "r");
1278 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1279 if ((ret == 0) && (ferror(fh) != 0)) {
1280 P_ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1288 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1291 if (old_value > new_value) {
1292 if (old_value <= 4294967295U)
1293 diff = (4294967295U - old_value) + new_value + 1;
1295 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1297 diff = new_value - old_value;
1301 } /* counter_t counter_diff */
1303 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1304 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1305 gauge_t delta_gauge;
1308 if (ds_type == DS_TYPE_GAUGE) {
1309 state->last_value.gauge = rate;
1310 state->last_time = t;
1312 *ret_value = state->last_value;
1316 /* Counter and absolute can't handle negative rates. Reset "last time"
1317 * to zero, so that the next valid rate will re-initialize the
1320 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1321 memset(state, 0, sizeof(*state));
1325 /* Another invalid state: The time is not increasing. */
1326 if (t <= state->last_time) {
1327 memset(state, 0, sizeof(*state));
1331 delta_t = t - state->last_time;
1332 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1334 /* Previous value is invalid. */
1335 if (state->last_time == 0) /* {{{ */
1337 if (ds_type == DS_TYPE_DERIVE) {
1338 state->last_value.derive = (derive_t)rate;
1339 state->residual = rate - ((gauge_t)state->last_value.derive);
1340 } else if (ds_type == DS_TYPE_COUNTER) {
1341 state->last_value.counter = (counter_t)rate;
1342 state->residual = rate - ((gauge_t)state->last_value.counter);
1343 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1344 state->last_value.absolute = (absolute_t)rate;
1345 state->residual = rate - ((gauge_t)state->last_value.absolute);
1350 state->last_time = t;
1354 if (ds_type == DS_TYPE_DERIVE) {
1355 derive_t delta_derive = (derive_t)delta_gauge;
1357 state->last_value.derive += delta_derive;
1358 state->residual = delta_gauge - ((gauge_t)delta_derive);
1359 } else if (ds_type == DS_TYPE_COUNTER) {
1360 counter_t delta_counter = (counter_t)delta_gauge;
1362 state->last_value.counter += delta_counter;
1363 state->residual = delta_gauge - ((gauge_t)delta_counter);
1364 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1365 absolute_t delta_absolute = (absolute_t)delta_gauge;
1367 state->last_value.absolute = delta_absolute;
1368 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1373 state->last_time = t;
1374 *ret_value = state->last_value;
1376 } /* }}} value_t rate_to_value */
1378 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1379 value_t value, int ds_type, cdtime_t t,
1380 value_to_rate_state_t *state) {
1383 /* Another invalid state: The time is not increasing. */
1384 if (t <= state->last_time) {
1385 memset(state, 0, sizeof(*state));
1389 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1391 /* Previous value is invalid. */
1392 if (state->last_time == 0) {
1393 state->last_value = value;
1394 state->last_time = t;
1399 case DS_TYPE_DERIVE: {
1400 derive_t diff = value.derive - state->last_value.derive;
1401 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1404 case DS_TYPE_GAUGE: {
1405 *ret_rate = value.gauge;
1408 case DS_TYPE_COUNTER: {
1409 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1410 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1413 case DS_TYPE_ABSOLUTE: {
1414 absolute_t diff = value.absolute;
1415 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1422 state->last_value = value;
1423 state->last_time = t;
1425 } /* }}} value_t rate_to_value */
1427 int service_name_to_port_number(const char *service_name) {
1428 struct addrinfo *ai_list;
1432 if (service_name == NULL)
1435 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1437 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1439 P_ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1440 gai_strerror(status));
1444 service_number = -1;
1445 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1446 ai_ptr = ai_ptr->ai_next) {
1447 if (ai_ptr->ai_family == AF_INET) {
1448 struct sockaddr_in *sa;
1450 sa = (void *)ai_ptr->ai_addr;
1451 service_number = (int)ntohs(sa->sin_port);
1452 } else if (ai_ptr->ai_family == AF_INET6) {
1453 struct sockaddr_in6 *sa;
1455 sa = (void *)ai_ptr->ai_addr;
1456 service_number = (int)ntohs(sa->sin6_port);
1459 if (service_number > 0)
1463 freeaddrinfo(ai_list);
1465 if (service_number > 0)
1466 return service_number;
1468 } /* int service_name_to_port_number */
1470 void set_sock_opts(int sockfd) /* {{{ */
1475 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1476 &(socklen_t){sizeof(socktype)});
1478 P_WARNING("set_sock_opts: failed to determine socket type");
1482 if (socktype == SOCK_STREAM) {
1484 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1486 P_WARNING("set_sock_opts: failed to set socket keepalive flag");
1489 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1490 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1491 sizeof(tcp_keepidle));
1493 P_WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1496 #ifdef TCP_KEEPINTVL
1498 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1499 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1500 sizeof(tcp_keepintvl));
1502 P_WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1505 } /* }}} void set_sock_opts */
1507 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1512 if ((string == NULL) || (ret_value == NULL))
1517 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1518 if ((endptr == string) || (errno != 0))
1523 } /* }}} int strtoderive */
1525 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1528 char *endptr = NULL;
1530 if ((string == NULL) || (ret_value == NULL))
1535 tmp = (gauge_t)strtod(string, &endptr);
1538 else if ((endptr == NULL) || (*endptr != 0))
1543 } /* }}} int strtogauge */
1545 int strarray_add(char ***ret_array, size_t *ret_array_len,
1546 char const *str) /* {{{ */
1549 size_t array_len = *ret_array_len;
1554 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1559 array[array_len] = strdup(str);
1560 if (array[array_len] == NULL)
1564 *ret_array_len = array_len;
1566 } /* }}} int strarray_add */
1568 void strarray_free(char **array, size_t array_len) /* {{{ */
1570 for (size_t i = 0; i < array_len; i++)
1573 } /* }}} void strarray_free */
1576 int check_capability(int arg) /* {{{ */
1578 cap_value_t cap_value = (cap_value_t)arg;
1580 cap_flag_value_t cap_flag_value;
1582 if (!CAP_IS_SUPPORTED(cap_value))
1585 if (!(cap = cap_get_proc())) {
1586 P_ERROR("check_capability: cap_get_proc failed.");
1590 if (cap_get_flag(cap, cap_value, CAP_EFFECTIVE, &cap_flag_value) < 0) {
1591 P_ERROR("check_capability: cap_get_flag failed.");
1597 return cap_flag_value != CAP_SET;
1598 } /* }}} int check_capability */
1600 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1602 P_WARNING("check_capability: unsupported capability implementation. "
1603 "Some plugin(s) may require elevated privileges to work properly.");
1605 } /* }}} int check_capability */
1606 #endif /* HAVE_CAPABILITY */