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;
275 /* checking for closed peer connection */
277 pfd.events = POLLIN | POLLHUP;
279 if (poll(&pfd, 1, 0) > 0) {
281 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
282 /* if recv returns zero (even though poll() said there is data to be
283 * read), that means the connection has been closed */
284 return errno ? errno : -1;
289 status = write(fd, (const void *)ptr, nleft);
291 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
295 return errno ? errno : status;
297 nleft = nleft - ((size_t)status);
298 ptr = ptr + ((size_t)status);
304 int strsplit(char *string, char **fields, size_t size) {
312 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
323 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
329 size_t buffer_req = 0;
331 if (((fields_num != 0) && (fields == NULL)) ||
332 ((buffer_size != 0) && (buffer == NULL)))
338 if (buffer_size != 0)
339 avail = buffer_size - 1;
342 sep_len = strlen(sep);
344 for (size_t i = 0; i < fields_num; i++) {
345 size_t field_len = strlen(fields[i]);
348 buffer_req += sep_len;
349 buffer_req += field_len;
351 if ((i != 0) && (sep_len > 0)) {
352 if (sep_len >= avail) {
353 /* prevent subsequent iterations from writing to the
359 memcpy(ptr, sep, sep_len);
365 if (field_len > avail)
368 memcpy(ptr, fields[i], field_len);
376 return (int)buffer_req;
379 int escape_string(char *buffer, size_t buffer_size) {
383 /* Check if we need to escape at all first */
384 temp = strpbrk(buffer, " \t\"\\");
391 temp = calloc(1, buffer_size);
398 for (size_t i = 0; i < buffer_size; i++) {
399 if (buffer[i] == 0) {
401 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
402 if (j > (buffer_size - 4))
405 temp[j + 1] = buffer[i];
408 if (j > (buffer_size - 3))
415 assert((j + 1) < buffer_size);
419 sstrncpy(buffer, temp, buffer_size);
422 } /* int escape_string */
424 int strunescape(char *buf, size_t buf_len) {
425 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
429 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
430 ERROR("string unescape: backslash found at end of string.");
431 /* Ensure null-byte at the end of the buffer. */
436 switch (buf[i + 1]) {
451 /* Move everything after the position one position to the left.
452 * Add a null-byte as last character in the buffer. */
453 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
454 buf[buf_len - 1] = 0;
457 } /* int strunescape */
459 size_t strstripnewline(char *buffer) {
460 size_t buffer_len = strlen(buffer);
462 while (buffer_len > 0) {
463 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
466 buffer[buffer_len] = 0;
470 } /* size_t strstripnewline */
472 int escape_slashes(char *buffer, size_t buffer_size) {
475 buffer_len = strlen(buffer);
477 if (buffer_len <= 1) {
478 if (strcmp("/", buffer) == 0) {
481 sstrncpy(buffer, "root", buffer_size);
486 /* Move one to the left */
487 if (buffer[0] == '/') {
488 memmove(buffer, buffer + 1, buffer_len);
492 for (size_t i = 0; i < buffer_len; i++) {
493 if (buffer[i] == '/')
498 } /* int escape_slashes */
500 void replace_special(char *buffer, size_t buffer_size) {
501 for (size_t i = 0; i < buffer_size; i++) {
504 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
507 } /* void replace_special */
509 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
510 struct timeval *larger;
511 struct timeval *smaller;
515 NORMALIZE_TIMEVAL(tv0);
516 NORMALIZE_TIMEVAL(tv1);
518 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
526 if ((tv0.tv_sec < tv1.tv_sec) ||
527 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
538 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
540 if (smaller->tv_usec <= larger->tv_usec)
541 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
544 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
548 assert((delta == NULL) ||
549 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
552 } /* int timeval_cmp */
554 int check_create_dir(const char *file_orig) {
564 int last_is_file = 1;
565 int path_is_absolute = 0;
569 * Sanity checks first
571 if (file_orig == NULL)
574 if ((len = strlen(file_orig)) < 1)
576 else if (len >= sizeof(file_copy))
580 * If `file_orig' ends in a slash the last component is a directory,
581 * otherwise it's a file. Act accordingly..
583 if (file_orig[len - 1] == '/')
585 if (file_orig[0] == '/')
586 path_is_absolute = 1;
589 * Create a copy for `strtok_r' to destroy
591 sstrncpy(file_copy, file_orig, sizeof(file_copy));
594 * Break into components. This will eat up several slashes in a row and
595 * remove leading and trailing slashes..
600 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
604 if (fields_num >= 16)
609 * For each component, do..
611 for (int i = 0; i < (fields_num - last_is_file); i++) {
613 * Do not create directories that start with a dot. This
614 * prevents `../../' attacks and other likely malicious
617 if (fields[i][0] == '.') {
618 ERROR("Cowardly refusing to create a directory that "
619 "begins with a `.' (dot): `%s'",
625 * Join the components together again
628 if (strjoin(dir + path_is_absolute, (size_t)(dir_len - path_is_absolute),
629 fields, (size_t)(i + 1), "/") < 0) {
630 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
635 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
636 if (errno == ENOENT) {
637 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
640 /* this might happen, if a different thread created
641 * the directory in the meantime
642 * => call stat() again to check for S_ISDIR() */
647 ERROR("check_create_dir: mkdir (%s): %s", dir,
648 sstrerror(errno, errbuf, sizeof(errbuf)));
652 ERROR("check_create_dir: stat (%s): %s", dir,
653 sstrerror(errno, errbuf, sizeof(errbuf)));
656 } else if (!S_ISDIR(statbuf.st_mode)) {
657 ERROR("check_create_dir: `%s' exists but is not "
667 } /* check_create_dir */
670 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
678 ssnprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
680 *ksp_ptr = kstat_lookup(kc, module, instance, name);
681 if (*ksp_ptr == NULL) {
682 ERROR("get_kstat: Cound not find kstat %s", ident);
686 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
687 ERROR("get_kstat: kstat %s has wrong type", ident);
693 assert(*ksp_ptr != NULL);
694 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
697 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
698 ERROR("get_kstat: kstat %s could not be read", ident);
702 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
703 ERROR("get_kstat: kstat %s has wrong type", ident);
710 long long get_kstat_value(kstat_t *ksp, char *name) {
712 long long retval = -1LL;
715 ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
717 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
718 ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
719 "is not KSTAT_TYPE_NAMED (%#x).",
720 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
724 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
727 if (kn->data_type == KSTAT_DATA_INT32)
728 retval = (long long)kn->value.i32;
729 else if (kn->data_type == KSTAT_DATA_UINT32)
730 retval = (long long)kn->value.ui32;
731 else if (kn->data_type == KSTAT_DATA_INT64)
733 (long long)kn->value.i64; /* According to ANSI C99 `long long' must hold
735 else if (kn->data_type == KSTAT_DATA_UINT64)
736 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
738 WARNING("get_kstat_value: Not a numeric value: %s", name);
742 #endif /* HAVE_LIBKSTAT */
745 unsigned long long ntohll(unsigned long long n) {
746 #if BYTE_ORDER == BIG_ENDIAN
749 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
751 } /* unsigned long long ntohll */
753 unsigned long long htonll(unsigned long long n) {
754 #if BYTE_ORDER == BIG_ENDIAN
757 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
759 } /* unsigned long long htonll */
760 #endif /* HAVE_HTONLL */
762 #if FP_LAYOUT_NEED_NOTHING
763 /* Well, we need nothing.. */
764 /* #endif FP_LAYOUT_NEED_NOTHING */
766 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
767 #if FP_LAYOUT_NEED_ENDIANFLIP
768 #define FP_CONVERT(A) \
769 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
770 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
771 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
772 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
773 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
774 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
775 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
776 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
778 #define FP_CONVERT(A) \
779 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
780 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
783 double ntohd(double d) {
792 /* NAN in x86 byte order */
793 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
794 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
795 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
801 ret.integer = FP_CONVERT(tmp);
802 return (ret.floating);
806 double htond(double d) {
814 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
815 ret.byte[4] = ret.byte[5] = 0x00;
818 return (ret.floating);
823 tmp = FP_CONVERT(ret.integer);
825 return (ret.floating);
828 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
830 int format_name(char *ret, int ret_len, const char *hostname,
831 const char *plugin, const char *plugin_instance,
832 const char *type, const char *type_instance) {
837 buffer_size = (size_t)ret_len;
839 #define APPEND(str) \
841 size_t l = strlen(str); \
842 if (l >= buffer_size) \
844 memcpy(buffer, (str), l); \
849 assert(plugin != NULL);
850 assert(type != NULL);
855 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
857 APPEND(plugin_instance);
861 if ((type_instance != NULL) && (type_instance[0] != 0)) {
863 APPEND(type_instance);
865 assert(buffer_size > 0);
870 } /* int format_name */
872 int format_values(char *ret, size_t ret_len, /* {{{ */
873 const data_set_t *ds, const value_list_t *vl,
877 gauge_t *rates = NULL;
879 assert(0 == strcmp(ds->type, vl->type));
881 memset(ret, 0, ret_len);
883 #define BUFFER_ADD(...) \
885 status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
889 } else if (((size_t)status) >= (ret_len - offset)) { \
893 offset += ((size_t)status); \
896 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
898 for (size_t i = 0; i < ds->ds_num; i++) {
899 if (ds->ds[i].type == DS_TYPE_GAUGE)
900 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
901 else if (store_rates) {
903 rates = uc_get_rate(ds, vl);
905 WARNING("format_values: uc_get_rate failed.");
908 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
909 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
910 BUFFER_ADD(":%llu", vl->values[i].counter);
911 else if (ds->ds[i].type == DS_TYPE_DERIVE)
912 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
913 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
914 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
916 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
920 } /* for ds->ds_num */
926 } /* }}} int format_values */
928 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
929 char **ret_plugin_instance, char **ret_type,
930 char **ret_type_instance, char *default_host) {
931 char *hostname = NULL;
933 char *plugin_instance = NULL;
935 char *type_instance = NULL;
938 if (hostname == NULL)
941 plugin = strchr(hostname, '/');
947 type = strchr(plugin, '/');
949 if (default_host == NULL)
951 /* else: no host specified; use default */
954 hostname = default_host;
960 plugin_instance = strchr(plugin, '-');
961 if (plugin_instance != NULL) {
962 *plugin_instance = '\0';
966 type_instance = strchr(type, '-');
967 if (type_instance != NULL) {
968 *type_instance = '\0';
972 *ret_host = hostname;
973 *ret_plugin = plugin;
974 *ret_plugin_instance = plugin_instance;
976 *ret_type_instance = type_instance;
978 } /* int parse_identifier */
980 int parse_identifier_vl(const char *str, value_list_t *vl) /* {{{ */
982 char str_copy[6 * DATA_MAX_NAME_LEN];
985 char *plugin_instance = NULL;
987 char *type_instance = NULL;
990 if ((str == NULL) || (vl == NULL))
993 sstrncpy(str_copy, str, sizeof(str_copy));
995 status = parse_identifier(str_copy, &host, &plugin, &plugin_instance, &type,
997 /* default_host = */ NULL);
1001 sstrncpy(vl->host, host, sizeof(vl->host));
1002 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
1003 sstrncpy(vl->plugin_instance,
1004 (plugin_instance != NULL) ? plugin_instance : "",
1005 sizeof(vl->plugin_instance));
1006 sstrncpy(vl->type, type, sizeof(vl->type));
1007 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
1008 sizeof(vl->type_instance));
1011 } /* }}} int parse_identifier_vl */
1013 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
1015 char *endptr = NULL;
1018 if (value_orig == NULL)
1021 value = strdup(value_orig);
1024 value_len = strlen(value);
1026 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1027 value[value_len - 1] = 0;
1032 case DS_TYPE_COUNTER:
1033 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1037 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1040 case DS_TYPE_DERIVE:
1041 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1044 case DS_TYPE_ABSOLUTE:
1045 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1050 ERROR("parse_value: Invalid data source type: %i.", ds_type);
1054 if (value == endptr) {
1055 ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1056 DS_TYPE_TO_STRING(ds_type), value);
1059 } else if ((NULL != endptr) && ('\0' != *endptr))
1060 INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1061 "Input string was \"%s\".",
1062 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1066 } /* int parse_value */
1068 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1074 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1081 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1084 if (i >= vl->values_len) {
1085 /* Make sure i is invalid. */
1090 if (vl->time == 0) {
1091 if (strcmp("N", ptr) == 0)
1092 vl->time = cdtime();
1094 char *endptr = NULL;
1098 tmp = strtod(ptr, &endptr);
1099 if ((errno != 0) /* Overflow */
1100 || (endptr == ptr) /* Invalid string */
1101 || (endptr == NULL) /* This should not happen */
1102 || (*endptr != 0)) /* Trailing chars */
1105 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1111 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1112 vl->values[i].gauge = NAN;
1113 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1117 } /* while (strtok_r) */
1119 if ((ptr != NULL) || (i == 0))
1122 } /* int parse_values */
1124 int parse_value_file(char const *path, value_t *ret_value, int ds_type) {
1128 fh = fopen(path, "r");
1132 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
1139 strstripnewline(buffer);
1141 return parse_value(buffer, ret_value, ds_type);
1142 } /* int parse_value_file */
1144 #if !HAVE_GETPWNAM_R
1145 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1146 struct passwd **pwbufp) {
1150 memset(pwbuf, '\0', sizeof(struct passwd));
1152 pthread_mutex_lock(&getpwnam_r_lock);
1155 pw = getpwnam(name);
1157 status = (errno != 0) ? errno : ENOENT;
1161 #define GETPWNAM_COPY_MEMBER(member) \
1162 if (pw->member != NULL) { \
1163 int len = strlen(pw->member); \
1164 if (len >= buflen) { \
1168 sstrncpy(buf, pw->member, buflen); \
1169 pwbuf->member = buf; \
1171 buflen -= (len + 1); \
1173 GETPWNAM_COPY_MEMBER(pw_name);
1174 GETPWNAM_COPY_MEMBER(pw_passwd);
1175 GETPWNAM_COPY_MEMBER(pw_gecos);
1176 GETPWNAM_COPY_MEMBER(pw_dir);
1177 GETPWNAM_COPY_MEMBER(pw_shell);
1179 pwbuf->pw_uid = pw->pw_uid;
1180 pwbuf->pw_gid = pw->pw_gid;
1186 pthread_mutex_unlock(&getpwnam_r_lock);
1189 } /* int getpwnam_r */
1190 #endif /* !HAVE_GETPWNAM_R */
1192 int notification_init(notification_t *n, int severity, const char *message,
1193 const char *host, const char *plugin,
1194 const char *plugin_instance, const char *type,
1195 const char *type_instance) {
1196 memset(n, '\0', sizeof(notification_t));
1198 n->severity = severity;
1200 if (message != NULL)
1201 sstrncpy(n->message, message, sizeof(n->message));
1203 sstrncpy(n->host, host, sizeof(n->host));
1205 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1206 if (plugin_instance != NULL)
1207 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1209 sstrncpy(n->type, type, sizeof(n->type));
1210 if (type_instance != NULL)
1211 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1214 } /* int notification_init */
1216 int walk_directory(const char *dir, dirwalk_callback_f callback,
1217 void *user_data, int include_hidden) {
1226 if ((dh = opendir(dir)) == NULL) {
1228 ERROR("walk_directory: Cannot open '%s': %s", dir,
1229 sstrerror(errno, errbuf, sizeof(errbuf)));
1233 while ((ent = readdir(dh)) != NULL) {
1236 if (include_hidden) {
1237 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1239 } else /* if (!include_hidden) */
1241 if (ent->d_name[0] == '.')
1245 status = (*callback)(dir, ent->d_name, user_data);
1254 if ((success == 0) && (failure > 0))
1259 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1263 fh = fopen(filename, "r");
1267 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1268 if ((ret == 0) && (ferror(fh) != 0)) {
1269 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1277 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1280 if (old_value > new_value) {
1281 if (old_value <= 4294967295U)
1282 diff = (4294967295U - old_value) + new_value + 1;
1284 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1286 diff = new_value - old_value;
1290 } /* counter_t counter_diff */
1292 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1293 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1294 gauge_t delta_gauge;
1297 if (ds_type == DS_TYPE_GAUGE) {
1298 state->last_value.gauge = rate;
1299 state->last_time = t;
1301 *ret_value = state->last_value;
1305 /* Counter and absolute can't handle negative rates. Reset "last time"
1306 * to zero, so that the next valid rate will re-initialize the
1309 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1310 memset(state, 0, sizeof(*state));
1314 /* Another invalid state: The time is not increasing. */
1315 if (t <= state->last_time) {
1316 memset(state, 0, sizeof(*state));
1320 delta_t = t - state->last_time;
1321 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1323 /* Previous value is invalid. */
1324 if (state->last_time == 0) /* {{{ */
1326 if (ds_type == DS_TYPE_DERIVE) {
1327 state->last_value.derive = (derive_t)rate;
1328 state->residual = rate - ((gauge_t)state->last_value.derive);
1329 } else if (ds_type == DS_TYPE_COUNTER) {
1330 state->last_value.counter = (counter_t)rate;
1331 state->residual = rate - ((gauge_t)state->last_value.counter);
1332 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1333 state->last_value.absolute = (absolute_t)rate;
1334 state->residual = rate - ((gauge_t)state->last_value.absolute);
1339 state->last_time = t;
1343 if (ds_type == DS_TYPE_DERIVE) {
1344 derive_t delta_derive = (derive_t)delta_gauge;
1346 state->last_value.derive += delta_derive;
1347 state->residual = delta_gauge - ((gauge_t)delta_derive);
1348 } else if (ds_type == DS_TYPE_COUNTER) {
1349 counter_t delta_counter = (counter_t)delta_gauge;
1351 state->last_value.counter += delta_counter;
1352 state->residual = delta_gauge - ((gauge_t)delta_counter);
1353 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1354 absolute_t delta_absolute = (absolute_t)delta_gauge;
1356 state->last_value.absolute = delta_absolute;
1357 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1362 state->last_time = t;
1363 *ret_value = state->last_value;
1365 } /* }}} value_t rate_to_value */
1367 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1368 value_t value, int ds_type, cdtime_t t,
1369 value_to_rate_state_t *state) {
1372 /* Another invalid state: The time is not increasing. */
1373 if (t <= state->last_time) {
1374 memset(state, 0, sizeof(*state));
1378 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1380 /* Previous value is invalid. */
1381 if (state->last_time == 0) {
1382 state->last_value = value;
1383 state->last_time = t;
1388 case DS_TYPE_DERIVE: {
1389 derive_t diff = value.derive - state->last_value.derive;
1390 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1393 case DS_TYPE_GAUGE: {
1394 *ret_rate = value.gauge;
1397 case DS_TYPE_COUNTER: {
1398 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1399 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1402 case DS_TYPE_ABSOLUTE: {
1403 absolute_t diff = value.absolute;
1404 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1411 state->last_value = value;
1412 state->last_time = t;
1414 } /* }}} value_t rate_to_value */
1416 int service_name_to_port_number(const char *service_name) {
1417 struct addrinfo *ai_list;
1421 if (service_name == NULL)
1424 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1426 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1428 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1429 gai_strerror(status));
1433 service_number = -1;
1434 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1435 ai_ptr = ai_ptr->ai_next) {
1436 if (ai_ptr->ai_family == AF_INET) {
1437 struct sockaddr_in *sa;
1439 sa = (void *)ai_ptr->ai_addr;
1440 service_number = (int)ntohs(sa->sin_port);
1441 } else if (ai_ptr->ai_family == AF_INET6) {
1442 struct sockaddr_in6 *sa;
1444 sa = (void *)ai_ptr->ai_addr;
1445 service_number = (int)ntohs(sa->sin6_port);
1448 if ((service_number > 0) && (service_number <= 65535))
1452 freeaddrinfo(ai_list);
1454 if ((service_number > 0) && (service_number <= 65535))
1455 return (service_number);
1457 } /* int service_name_to_port_number */
1459 void set_sock_opts(int sockfd) /* {{{ */
1464 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1465 &(socklen_t){sizeof(socktype)});
1467 WARNING("set_sock_opts: failed to determine socket type");
1471 if (socktype == SOCK_STREAM) {
1473 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1475 WARNING("set_sock_opts: failed to set socket keepalive flag");
1478 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1479 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1480 sizeof(tcp_keepidle));
1482 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1485 #ifdef TCP_KEEPINTVL
1487 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1488 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1489 sizeof(tcp_keepintvl));
1491 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1494 } /* }}} void set_sock_opts */
1496 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1501 if ((string == NULL) || (ret_value == NULL))
1506 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1507 if ((endptr == string) || (errno != 0))
1512 } /* }}} int strtoderive */
1514 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1517 char *endptr = NULL;
1519 if ((string == NULL) || (ret_value == NULL))
1524 tmp = (gauge_t)strtod(string, &endptr);
1527 else if ((endptr == NULL) || (*endptr != 0))
1532 } /* }}} int strtogauge */
1534 int strarray_add(char ***ret_array, size_t *ret_array_len,
1535 char const *str) /* {{{ */
1538 size_t array_len = *ret_array_len;
1543 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1548 array[array_len] = strdup(str);
1549 if (array[array_len] == NULL)
1553 *ret_array_len = array_len;
1555 } /* }}} int strarray_add */
1557 void strarray_free(char **array, size_t array_len) /* {{{ */
1559 for (size_t i = 0; i < array_len; i++)
1562 } /* }}} void strarray_free */
1565 int check_capability(int arg) /* {{{ */
1567 cap_value_t cap_value = (cap_value_t)arg;
1569 cap_flag_value_t cap_flag_value;
1571 if (!CAP_IS_SUPPORTED(cap_value))
1574 if (!(cap = cap_get_proc())) {
1575 ERROR("check_capability: cap_get_proc failed.");
1579 if (cap_get_flag(cap, cap_value, CAP_EFFECTIVE, &cap_flag_value) < 0) {
1580 ERROR("check_capability: cap_get_flag failed.");
1586 return (cap_flag_value != CAP_SET);
1587 } /* }}} int check_capability */
1589 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1591 WARNING("check_capability: unsupported capability implementation. "
1592 "Some plugin(s) may require elevated privileges to work properly.");
1594 } /* }}} int check_capability */
1595 #endif /* HAVE_CAPABILITY */