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>
38 #include "utils_cache.h"
42 #include <sys/types.h>
47 #include <netinet/in.h>
50 #if HAVE_NETINET_TCP_H
51 #include <netinet/tcp.h>
54 /* for ntohl and htonl */
56 #include <arpa/inet.h>
60 #include <sys/capability.h>
64 extern kstat_ctl_t *kc;
67 /* AIX doesn't have MSG_DONTWAIT */
69 #define MSG_DONTWAIT MSG_NONBLOCK
73 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
77 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
80 char *sstrncpy(char *dest, const char *src, size_t n) {
81 strncpy(dest, src, n);
85 } /* char *sstrncpy */
87 int ssnprintf(char *dest, size_t n, const char *format, ...) {
92 ret = vsnprintf(dest, n, format, ap);
99 char *ssnprintf_alloc(char const *format, ...) /* {{{ */
101 char static_buffer[1024] = "";
103 size_t alloc_buffer_size;
107 /* Try printing into the static buffer. In many cases it will be
108 * sufficiently large and we can simply return a strdup() of this
110 va_start(ap, format);
111 status = vsnprintf(static_buffer, sizeof(static_buffer), format, ap);
116 /* "status" does not include the null byte. */
117 alloc_buffer_size = (size_t)(status + 1);
118 if (alloc_buffer_size <= sizeof(static_buffer))
119 return (strdup(static_buffer));
121 /* Allocate a buffer large enough to hold the string. */
122 alloc_buffer = calloc(1, alloc_buffer_size);
123 if (alloc_buffer == NULL)
126 /* Print again into this new buffer. */
127 va_start(ap, format);
128 status = vsnprintf(alloc_buffer, alloc_buffer_size, format, ap);
135 return (alloc_buffer);
136 } /* }}} char *ssnprintf_alloc */
138 char *sstrdup(const char *s) {
145 /* Do not use `strdup' here, because it's not specified in POSIX. It's
146 * ``only'' an XSI extension. */
150 ERROR("sstrdup: Out of memory.");
153 memcpy(r, s, sizeof(char) * sz);
156 } /* char *sstrdup */
158 /* Even though Posix requires "strerror_r" to return an "int",
159 * some systems (e.g. the GNU libc) return a "char *" _and_
160 * ignore the second argument ... -tokkee */
161 char *sstrerror(int errnum, char *buf, size_t buflen) {
168 pthread_mutex_lock(&strerror_r_lock);
170 temp = strerror(errnum);
171 sstrncpy(buf, temp, buflen);
173 pthread_mutex_unlock(&strerror_r_lock);
175 /* #endif !HAVE_STRERROR_R */
177 #elif STRERROR_R_CHAR_P
180 temp = strerror_r(errnum, buf, buflen);
181 if (buf[0] == '\0') {
182 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
183 sstrncpy(buf, temp, buflen);
185 sstrncpy(buf, "strerror_r did not return "
190 /* #endif STRERROR_R_CHAR_P */
193 if (strerror_r(errnum, buf, buflen) != 0) {
194 ssnprintf(buf, buflen, "Error #%i; "
195 "Additionally, strerror_r failed.",
198 #endif /* STRERROR_R_CHAR_P */
201 } /* char *sstrerror */
203 void *smalloc(size_t size) {
206 if ((r = malloc(size)) == NULL) {
207 ERROR("Not enough memory.");
212 } /* void *smalloc */
215 void sfree (void **ptr)
227 ssize_t sread(int fd, void *buf, size_t count) {
236 status = read(fd, (void *)ptr, nleft);
238 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
245 DEBUG("Received EOF from fd %i. "
246 "Closing fd and returning error.",
252 assert((0 > status) || (nleft >= (size_t)status));
254 nleft = nleft - ((size_t)status);
255 ptr = ptr + ((size_t)status);
261 ssize_t swrite(int fd, const void *buf, size_t count) {
267 ptr = (const char *)buf;
273 /* checking for closed peer connection */
275 pfd.events = POLLIN | POLLHUP;
277 if (poll(&pfd, 1, 0) > 0) {
279 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
280 // if recv returns zero (even though poll() said there is data to be
282 // that means the connection has been closed
288 status = write(fd, (const void *)ptr, nleft);
290 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
296 nleft = nleft - ((size_t)status);
297 ptr = ptr + ((size_t)status);
303 int strsplit(char *string, char **fields, size_t size) {
311 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
322 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
328 size_t buffer_req = 0;
330 if (((fields_num != 0) && (fields == NULL)) ||
331 ((buffer_size != 0) && (buffer == NULL)))
337 if (buffer_size != 0)
338 avail = buffer_size - 1;
341 sep_len = strlen(sep);
343 for (size_t i = 0; i < fields_num; i++) {
344 size_t field_len = strlen(fields[i]);
347 buffer_req += sep_len;
348 buffer_req += field_len;
350 if ((i != 0) && (sep_len > 0)) {
351 if (sep_len >= avail) {
352 /* prevent subsequent iterations from writing to the
358 memcpy(ptr, sep, sep_len);
364 if (field_len > avail)
367 memcpy(ptr, fields[i], field_len);
375 return (int)buffer_req;
378 int escape_string(char *buffer, size_t buffer_size) {
382 /* Check if we need to escape at all first */
383 temp = strpbrk(buffer, " \t\"\\");
390 temp = calloc(1, buffer_size);
397 for (size_t i = 0; i < buffer_size; i++) {
398 if (buffer[i] == 0) {
400 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
401 if (j > (buffer_size - 4))
404 temp[j + 1] = buffer[i];
407 if (j > (buffer_size - 3))
414 assert((j + 1) < buffer_size);
418 sstrncpy(buffer, temp, buffer_size);
421 } /* int escape_string */
423 int strunescape(char *buf, size_t buf_len) {
424 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
428 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
429 ERROR("string unescape: backslash found at end of string.");
430 /* Ensure null-byte at the end of the buffer. */
435 switch (buf[i + 1]) {
450 /* Move everything after the position one position to the left.
451 * Add a null-byte as last character in the buffer. */
452 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
453 buf[buf_len - 1] = 0;
456 } /* int strunescape */
458 size_t strstripnewline(char *buffer) {
459 size_t buffer_len = strlen(buffer);
461 while (buffer_len > 0) {
462 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
465 buffer[buffer_len] = 0;
469 } /* size_t strstripnewline */
471 int escape_slashes(char *buffer, size_t buffer_size) {
474 buffer_len = strlen(buffer);
476 if (buffer_len <= 1) {
477 if (strcmp("/", buffer) == 0) {
480 sstrncpy(buffer, "root", buffer_size);
485 /* Move one to the left */
486 if (buffer[0] == '/') {
487 memmove(buffer, buffer + 1, buffer_len);
491 for (size_t i = 0; i < buffer_len; i++) {
492 if (buffer[i] == '/')
497 } /* int escape_slashes */
499 void replace_special(char *buffer, size_t buffer_size) {
500 for (size_t i = 0; i < buffer_size; i++) {
503 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
506 } /* void replace_special */
508 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
509 struct timeval *larger;
510 struct timeval *smaller;
514 NORMALIZE_TIMEVAL(tv0);
515 NORMALIZE_TIMEVAL(tv1);
517 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
525 if ((tv0.tv_sec < tv1.tv_sec) ||
526 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
537 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
539 if (smaller->tv_usec <= larger->tv_usec)
540 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
543 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
547 assert((delta == NULL) ||
548 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
551 } /* int timeval_cmp */
553 int check_create_dir(const char *file_orig) {
563 int last_is_file = 1;
564 int path_is_absolute = 0;
568 * Sanity checks first
570 if (file_orig == NULL)
573 if ((len = strlen(file_orig)) < 1)
575 else if (len >= sizeof(file_copy))
579 * If `file_orig' ends in a slash the last component is a directory,
580 * otherwise it's a file. Act accordingly..
582 if (file_orig[len - 1] == '/')
584 if (file_orig[0] == '/')
585 path_is_absolute = 1;
588 * Create a copy for `strtok_r' to destroy
590 sstrncpy(file_copy, file_orig, sizeof(file_copy));
593 * Break into components. This will eat up several slashes in a row and
594 * remove leading and trailing slashes..
599 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
603 if (fields_num >= 16)
608 * For each component, do..
610 for (int i = 0; i < (fields_num - last_is_file); i++) {
612 * Do not create directories that start with a dot. This
613 * prevents `../../' attacks and other likely malicious
616 if (fields[i][0] == '.') {
617 ERROR("Cowardly refusing to create a directory that "
618 "begins with a `.' (dot): `%s'",
624 * Join the components together again
627 if (strjoin(dir + path_is_absolute, (size_t)(dir_len - path_is_absolute),
628 fields, (size_t)(i + 1), "/") < 0) {
629 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
634 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
635 if (errno == ENOENT) {
636 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
639 /* this might happen, if a different thread created
640 * the directory in the meantime
641 * => call stat() again to check for S_ISDIR() */
646 ERROR("check_create_dir: mkdir (%s): %s", dir,
647 sstrerror(errno, errbuf, sizeof(errbuf)));
651 ERROR("check_create_dir: stat (%s): %s", dir,
652 sstrerror(errno, errbuf, sizeof(errbuf)));
655 } else if (!S_ISDIR(statbuf.st_mode)) {
656 ERROR("check_create_dir: `%s' exists but is not "
666 } /* check_create_dir */
669 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
677 ssnprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
679 *ksp_ptr = kstat_lookup(kc, module, instance, name);
680 if (*ksp_ptr == NULL) {
681 ERROR("get_kstat: Cound not find kstat %s", ident);
685 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
686 ERROR("get_kstat: kstat %s has wrong type", ident);
692 assert(*ksp_ptr != NULL);
693 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
696 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
697 ERROR("get_kstat: kstat %s could not be read", ident);
701 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
702 ERROR("get_kstat: kstat %s has wrong type", ident);
709 long long get_kstat_value(kstat_t *ksp, char *name) {
711 long long retval = -1LL;
714 ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
716 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
717 ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
718 "is not KSTAT_TYPE_NAMED (%#x).",
719 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
723 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
726 if (kn->data_type == KSTAT_DATA_INT32)
727 retval = (long long)kn->value.i32;
728 else if (kn->data_type == KSTAT_DATA_UINT32)
729 retval = (long long)kn->value.ui32;
730 else if (kn->data_type == KSTAT_DATA_INT64)
732 (long long)kn->value.i64; /* According to ANSI C99 `long long' must hold
734 else if (kn->data_type == KSTAT_DATA_UINT64)
735 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
737 WARNING("get_kstat_value: Not a numeric value: %s", name);
741 #endif /* HAVE_LIBKSTAT */
744 unsigned long long ntohll(unsigned long long n) {
745 #if BYTE_ORDER == BIG_ENDIAN
748 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
750 } /* unsigned long long ntohll */
752 unsigned long long htonll(unsigned long long n) {
753 #if BYTE_ORDER == BIG_ENDIAN
756 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
758 } /* unsigned long long htonll */
759 #endif /* HAVE_HTONLL */
761 #if FP_LAYOUT_NEED_NOTHING
762 /* Well, we need nothing.. */
763 /* #endif FP_LAYOUT_NEED_NOTHING */
765 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
766 #if FP_LAYOUT_NEED_ENDIANFLIP
767 #define FP_CONVERT(A) \
768 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
769 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
770 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
771 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
772 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
773 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
774 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
775 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
777 #define FP_CONVERT(A) \
778 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
779 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
782 double ntohd(double d) {
791 /* NAN in x86 byte order */
792 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
793 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
794 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
800 ret.integer = FP_CONVERT(tmp);
801 return (ret.floating);
805 double htond(double d) {
813 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
814 ret.byte[4] = ret.byte[5] = 0x00;
817 return (ret.floating);
822 tmp = FP_CONVERT(ret.integer);
824 return (ret.floating);
827 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
829 int format_name(char *ret, int ret_len, const char *hostname,
830 const char *plugin, const char *plugin_instance,
831 const char *type, const char *type_instance) {
836 buffer_size = (size_t)ret_len;
838 #define APPEND(str) \
840 size_t l = strlen(str); \
841 if (l >= buffer_size) \
843 memcpy(buffer, (str), l); \
848 assert(plugin != NULL);
849 assert(type != NULL);
854 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
856 APPEND(plugin_instance);
860 if ((type_instance != NULL) && (type_instance[0] != 0)) {
862 APPEND(type_instance);
864 assert(buffer_size > 0);
869 } /* int format_name */
871 int format_values(char *ret, size_t ret_len, /* {{{ */
872 const data_set_t *ds, const value_list_t *vl,
876 gauge_t *rates = NULL;
878 assert(0 == strcmp(ds->type, vl->type));
880 memset(ret, 0, ret_len);
882 #define BUFFER_ADD(...) \
884 status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
888 } else if (((size_t)status) >= (ret_len - offset)) { \
892 offset += ((size_t)status); \
895 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
897 for (size_t i = 0; i < ds->ds_num; i++) {
898 if (ds->ds[i].type == DS_TYPE_GAUGE)
899 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
900 else if (store_rates) {
902 rates = uc_get_rate(ds, vl);
904 WARNING("format_values: uc_get_rate failed.");
907 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
908 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
909 BUFFER_ADD(":%llu", vl->values[i].counter);
910 else if (ds->ds[i].type == DS_TYPE_DERIVE)
911 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
912 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
913 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
915 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
919 } /* for ds->ds_num */
925 } /* }}} int format_values */
927 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
928 char **ret_plugin_instance, char **ret_type,
929 char **ret_type_instance, char *default_host) {
930 char *hostname = NULL;
932 char *plugin_instance = NULL;
934 char *type_instance = NULL;
937 if (hostname == NULL)
940 plugin = strchr(hostname, '/');
946 type = strchr(plugin, '/');
948 if (default_host == NULL)
950 /* else: no host specified; use default */
953 hostname = default_host;
959 plugin_instance = strchr(plugin, '-');
960 if (plugin_instance != NULL) {
961 *plugin_instance = '\0';
965 type_instance = strchr(type, '-');
966 if (type_instance != NULL) {
967 *type_instance = '\0';
971 *ret_host = hostname;
972 *ret_plugin = plugin;
973 *ret_plugin_instance = plugin_instance;
975 *ret_type_instance = type_instance;
977 } /* int parse_identifier */
979 int parse_identifier_vl(const char *str, value_list_t *vl) /* {{{ */
981 char str_copy[6 * DATA_MAX_NAME_LEN];
984 char *plugin_instance = NULL;
986 char *type_instance = NULL;
989 if ((str == NULL) || (vl == NULL))
992 sstrncpy(str_copy, str, sizeof(str_copy));
994 status = parse_identifier(str_copy, &host, &plugin, &plugin_instance, &type,
996 /* default_host = */ NULL);
1000 sstrncpy(vl->host, host, sizeof(vl->host));
1001 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
1002 sstrncpy(vl->plugin_instance,
1003 (plugin_instance != NULL) ? plugin_instance : "",
1004 sizeof(vl->plugin_instance));
1005 sstrncpy(vl->type, type, sizeof(vl->type));
1006 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
1007 sizeof(vl->type_instance));
1010 } /* }}} int parse_identifier_vl */
1012 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
1014 char *endptr = NULL;
1017 if (value_orig == NULL)
1020 value = strdup(value_orig);
1023 value_len = strlen(value);
1025 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1026 value[value_len - 1] = 0;
1031 case DS_TYPE_COUNTER:
1032 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1036 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1039 case DS_TYPE_DERIVE:
1040 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1043 case DS_TYPE_ABSOLUTE:
1044 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1049 ERROR("parse_value: Invalid data source type: %i.", ds_type);
1053 if (value == endptr) {
1054 ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1055 DS_TYPE_TO_STRING(ds_type), value);
1058 } else if ((NULL != endptr) && ('\0' != *endptr))
1059 INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1060 "Input string was \"%s\".",
1061 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1065 } /* int parse_value */
1067 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1073 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1080 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1083 if (i >= vl->values_len) {
1084 /* Make sure i is invalid. */
1089 if (vl->time == 0) {
1090 if (strcmp("N", ptr) == 0)
1091 vl->time = cdtime();
1093 char *endptr = NULL;
1097 tmp = strtod(ptr, &endptr);
1098 if ((errno != 0) /* Overflow */
1099 || (endptr == ptr) /* Invalid string */
1100 || (endptr == NULL) /* This should not happen */
1101 || (*endptr != 0)) /* Trailing chars */
1104 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1110 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1111 vl->values[i].gauge = NAN;
1112 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1116 } /* while (strtok_r) */
1118 if ((ptr != NULL) || (i == 0))
1121 } /* int parse_values */
1123 int parse_value_file(char const *path, value_t *ret_value, int ds_type) {
1127 fh = fopen(path, "r");
1131 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
1138 strstripnewline(buffer);
1140 return parse_value(buffer, ret_value, ds_type);
1141 } /* int parse_value_file */
1143 #if !HAVE_GETPWNAM_R
1144 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1145 struct passwd **pwbufp) {
1149 memset(pwbuf, '\0', sizeof(struct passwd));
1151 pthread_mutex_lock(&getpwnam_r_lock);
1154 pw = getpwnam(name);
1156 status = (errno != 0) ? errno : ENOENT;
1160 #define GETPWNAM_COPY_MEMBER(member) \
1161 if (pw->member != NULL) { \
1162 int len = strlen(pw->member); \
1163 if (len >= buflen) { \
1167 sstrncpy(buf, pw->member, buflen); \
1168 pwbuf->member = buf; \
1170 buflen -= (len + 1); \
1172 GETPWNAM_COPY_MEMBER(pw_name);
1173 GETPWNAM_COPY_MEMBER(pw_passwd);
1174 GETPWNAM_COPY_MEMBER(pw_gecos);
1175 GETPWNAM_COPY_MEMBER(pw_dir);
1176 GETPWNAM_COPY_MEMBER(pw_shell);
1178 pwbuf->pw_uid = pw->pw_uid;
1179 pwbuf->pw_gid = pw->pw_gid;
1185 pthread_mutex_unlock(&getpwnam_r_lock);
1188 } /* int getpwnam_r */
1189 #endif /* !HAVE_GETPWNAM_R */
1191 int notification_init(notification_t *n, int severity, const char *message,
1192 const char *host, const char *plugin,
1193 const char *plugin_instance, const char *type,
1194 const char *type_instance) {
1195 memset(n, '\0', sizeof(notification_t));
1197 n->severity = severity;
1199 if (message != NULL)
1200 sstrncpy(n->message, message, sizeof(n->message));
1202 sstrncpy(n->host, host, sizeof(n->host));
1204 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1205 if (plugin_instance != NULL)
1206 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1208 sstrncpy(n->type, type, sizeof(n->type));
1209 if (type_instance != NULL)
1210 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1213 } /* int notification_init */
1215 int walk_directory(const char *dir, dirwalk_callback_f callback,
1216 void *user_data, int include_hidden) {
1225 if ((dh = opendir(dir)) == NULL) {
1227 ERROR("walk_directory: Cannot open '%s': %s", dir,
1228 sstrerror(errno, errbuf, sizeof(errbuf)));
1232 while ((ent = readdir(dh)) != NULL) {
1235 if (include_hidden) {
1236 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1238 } else /* if (!include_hidden) */
1240 if (ent->d_name[0] == '.')
1244 status = (*callback)(dir, ent->d_name, user_data);
1253 if ((success == 0) && (failure > 0))
1258 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1262 fh = fopen(filename, "r");
1266 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1267 if ((ret == 0) && (ferror(fh) != 0)) {
1268 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1276 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1279 if (old_value > new_value) {
1280 if (old_value <= 4294967295U)
1281 diff = (4294967295U - old_value) + new_value + 1;
1283 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1285 diff = new_value - old_value;
1289 } /* counter_t counter_diff */
1291 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1292 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1293 gauge_t delta_gauge;
1296 if (ds_type == DS_TYPE_GAUGE) {
1297 state->last_value.gauge = rate;
1298 state->last_time = t;
1300 *ret_value = state->last_value;
1304 /* Counter and absolute can't handle negative rates. Reset "last time"
1305 * to zero, so that the next valid rate will re-initialize the
1308 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1309 memset(state, 0, sizeof(*state));
1313 /* Another invalid state: The time is not increasing. */
1314 if (t <= state->last_time) {
1315 memset(state, 0, sizeof(*state));
1319 delta_t = t - state->last_time;
1320 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1322 /* Previous value is invalid. */
1323 if (state->last_time == 0) /* {{{ */
1325 if (ds_type == DS_TYPE_DERIVE) {
1326 state->last_value.derive = (derive_t)rate;
1327 state->residual = rate - ((gauge_t)state->last_value.derive);
1328 } else if (ds_type == DS_TYPE_COUNTER) {
1329 state->last_value.counter = (counter_t)rate;
1330 state->residual = rate - ((gauge_t)state->last_value.counter);
1331 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1332 state->last_value.absolute = (absolute_t)rate;
1333 state->residual = rate - ((gauge_t)state->last_value.absolute);
1338 state->last_time = t;
1342 if (ds_type == DS_TYPE_DERIVE) {
1343 derive_t delta_derive = (derive_t)delta_gauge;
1345 state->last_value.derive += delta_derive;
1346 state->residual = delta_gauge - ((gauge_t)delta_derive);
1347 } else if (ds_type == DS_TYPE_COUNTER) {
1348 counter_t delta_counter = (counter_t)delta_gauge;
1350 state->last_value.counter += delta_counter;
1351 state->residual = delta_gauge - ((gauge_t)delta_counter);
1352 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1353 absolute_t delta_absolute = (absolute_t)delta_gauge;
1355 state->last_value.absolute = delta_absolute;
1356 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1361 state->last_time = t;
1362 *ret_value = state->last_value;
1364 } /* }}} value_t rate_to_value */
1366 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1367 value_t value, int ds_type, cdtime_t t,
1368 value_to_rate_state_t *state) {
1371 /* Another invalid state: The time is not increasing. */
1372 if (t <= state->last_time) {
1373 memset(state, 0, sizeof(*state));
1377 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1379 /* Previous value is invalid. */
1380 if (state->last_time == 0) {
1381 state->last_value = value;
1382 state->last_time = t;
1387 case DS_TYPE_DERIVE: {
1388 derive_t diff = value.derive - state->last_value.derive;
1389 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1392 case DS_TYPE_GAUGE: {
1393 *ret_rate = value.gauge;
1396 case DS_TYPE_COUNTER: {
1397 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1398 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1401 case DS_TYPE_ABSOLUTE: {
1402 absolute_t diff = value.absolute;
1403 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1410 state->last_value = value;
1411 state->last_time = t;
1413 } /* }}} value_t rate_to_value */
1415 int service_name_to_port_number(const char *service_name) {
1416 struct addrinfo *ai_list;
1420 if (service_name == NULL)
1423 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1425 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1427 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1428 gai_strerror(status));
1432 service_number = -1;
1433 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1434 ai_ptr = ai_ptr->ai_next) {
1435 if (ai_ptr->ai_family == AF_INET) {
1436 struct sockaddr_in *sa;
1438 sa = (void *)ai_ptr->ai_addr;
1439 service_number = (int)ntohs(sa->sin_port);
1440 } else if (ai_ptr->ai_family == AF_INET6) {
1441 struct sockaddr_in6 *sa;
1443 sa = (void *)ai_ptr->ai_addr;
1444 service_number = (int)ntohs(sa->sin6_port);
1447 if ((service_number > 0) && (service_number <= 65535))
1451 freeaddrinfo(ai_list);
1453 if ((service_number > 0) && (service_number <= 65535))
1454 return (service_number);
1456 } /* int service_name_to_port_number */
1458 void set_sock_opts(int sockfd) /* {{{ */
1463 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1464 &(socklen_t){sizeof(socktype)});
1466 WARNING("set_sock_opts: failed to determine socket type");
1470 if (socktype == SOCK_STREAM) {
1472 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1474 WARNING("set_sock_opts: failed to set socket keepalive flag");
1477 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1478 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1479 sizeof(tcp_keepidle));
1481 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1484 #ifdef TCP_KEEPINTVL
1486 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1487 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1488 sizeof(tcp_keepintvl));
1490 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1493 } /* }}} void set_sock_opts */
1495 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1500 if ((string == NULL) || (ret_value == NULL))
1505 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1506 if ((endptr == string) || (errno != 0))
1511 } /* }}} int strtoderive */
1513 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1516 char *endptr = NULL;
1518 if ((string == NULL) || (ret_value == NULL))
1523 tmp = (gauge_t)strtod(string, &endptr);
1526 else if ((endptr == NULL) || (*endptr != 0))
1531 } /* }}} int strtogauge */
1533 int strarray_add(char ***ret_array, size_t *ret_array_len,
1534 char const *str) /* {{{ */
1537 size_t array_len = *ret_array_len;
1542 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1547 array[array_len] = strdup(str);
1548 if (array[array_len] == NULL)
1552 *ret_array_len = array_len;
1554 } /* }}} int strarray_add */
1556 void strarray_free(char **array, size_t array_len) /* {{{ */
1558 for (size_t i = 0; i < array_len; i++)
1561 } /* }}} void strarray_free */
1564 int check_capability(int arg) /* {{{ */
1566 cap_value_t cap = (cap_value_t)arg;
1568 if (!CAP_IS_SUPPORTED(cap))
1571 int have_cap = cap_get_bound(cap);
1576 } /* }}} int check_capability */
1578 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1580 WARNING("check_capability: unsupported capability implementation. "
1581 "Some plugin(s) may require elevated privileges to work properly.");
1583 } /* }}} int check_capability */
1584 #endif /* HAVE_CAPABILITY */