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"
46 #include <sys/types.h>
51 #include <netinet/in.h>
54 #if HAVE_NETINET_TCP_H
55 #include <netinet/tcp.h>
58 /* for ntohl and htonl */
60 #include <arpa/inet.h>
64 #include <sys/capability.h>
68 extern kstat_ctl_t *kc;
71 /* AIX doesn't have MSG_DONTWAIT */
73 #define MSG_DONTWAIT MSG_NONBLOCK
77 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
81 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
84 char *sstrncpy(char *dest, const char *src, size_t n) {
85 strncpy(dest, src, n);
89 } /* char *sstrncpy */
91 int ssnprintf(char *dest, size_t n, const char *format, ...) {
96 ret = vsnprintf(dest, n, format, ap);
101 } /* int ssnprintf */
103 char *ssnprintf_alloc(char const *format, ...) /* {{{ */
105 char static_buffer[1024] = "";
107 size_t alloc_buffer_size;
111 /* Try printing into the static buffer. In many cases it will be
112 * sufficiently large and we can simply return a strdup() of this
114 va_start(ap, format);
115 status = vsnprintf(static_buffer, sizeof(static_buffer), format, ap);
120 /* "status" does not include the null byte. */
121 alloc_buffer_size = (size_t)(status + 1);
122 if (alloc_buffer_size <= sizeof(static_buffer))
123 return (strdup(static_buffer));
125 /* Allocate a buffer large enough to hold the string. */
126 alloc_buffer = calloc(1, alloc_buffer_size);
127 if (alloc_buffer == NULL)
130 /* Print again into this new buffer. */
131 va_start(ap, format);
132 status = vsnprintf(alloc_buffer, alloc_buffer_size, format, ap);
139 return (alloc_buffer);
140 } /* }}} char *ssnprintf_alloc */
142 char *sstrdup(const char *s) {
149 /* Do not use `strdup' here, because it's not specified in POSIX. It's
150 * ``only'' an XSI extension. */
154 ERROR("sstrdup: Out of memory.");
157 memcpy(r, s, sizeof(char) * sz);
160 } /* char *sstrdup */
162 /* Even though Posix requires "strerror_r" to return an "int",
163 * some systems (e.g. the GNU libc) return a "char *" _and_
164 * ignore the second argument ... -tokkee */
165 char *sstrerror(int errnum, char *buf, size_t buflen) {
172 pthread_mutex_lock(&strerror_r_lock);
174 temp = strerror(errnum);
175 sstrncpy(buf, temp, buflen);
177 pthread_mutex_unlock(&strerror_r_lock);
179 /* #endif !HAVE_STRERROR_R */
181 #elif STRERROR_R_CHAR_P
184 temp = strerror_r(errnum, buf, buflen);
185 if (buf[0] == '\0') {
186 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
187 sstrncpy(buf, temp, buflen);
189 sstrncpy(buf, "strerror_r did not return "
194 /* #endif STRERROR_R_CHAR_P */
197 if (strerror_r(errnum, buf, buflen) != 0) {
198 ssnprintf(buf, buflen, "Error #%i; "
199 "Additionally, strerror_r failed.",
202 #endif /* STRERROR_R_CHAR_P */
205 } /* char *sstrerror */
207 void *smalloc(size_t size) {
210 if ((r = malloc(size)) == NULL) {
211 ERROR("Not enough memory.");
216 } /* void *smalloc */
219 void sfree (void **ptr)
231 ssize_t sread(int fd, void *buf, size_t count) {
240 status = read(fd, (void *)ptr, nleft);
242 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
249 DEBUG("Received EOF from fd %i. "
250 "Closing fd and returning error.",
256 assert((0 > status) || (nleft >= (size_t)status));
258 nleft = nleft - ((size_t)status);
259 ptr = ptr + ((size_t)status);
265 ssize_t swrite(int fd, const void *buf, size_t count) {
271 ptr = (const char *)buf;
277 /* checking for closed peer connection */
279 pfd.events = POLLIN | POLLHUP;
281 if (poll(&pfd, 1, 0) > 0) {
283 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
284 // if recv returns zero (even though poll() said there is data to be
286 // that means the connection has been closed
292 status = write(fd, (const void *)ptr, nleft);
294 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
300 nleft = nleft - ((size_t)status);
301 ptr = ptr + ((size_t)status);
307 int strsplit(char *string, char **fields, size_t size) {
315 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
326 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
332 size_t buffer_req = 0;
334 if (((fields_num != 0) && (fields == NULL)) ||
335 ((buffer_size != 0) && (buffer == NULL)))
341 if (buffer_size != 0)
342 avail = buffer_size - 1;
345 sep_len = strlen(sep);
347 for (size_t i = 0; i < fields_num; i++) {
348 size_t field_len = strlen(fields[i]);
351 buffer_req += sep_len;
352 buffer_req += field_len;
354 if ((i != 0) && (sep_len > 0)) {
355 if (sep_len >= avail) {
356 /* prevent subsequent iterations from writing to the
362 memcpy(ptr, sep, sep_len);
368 if (field_len > avail)
371 memcpy(ptr, fields[i], field_len);
379 return (int)buffer_req;
382 int escape_string(char *buffer, size_t buffer_size) {
386 /* Check if we need to escape at all first */
387 temp = strpbrk(buffer, " \t\"\\");
394 temp = calloc(1, buffer_size);
401 for (size_t i = 0; i < buffer_size; i++) {
402 if (buffer[i] == 0) {
404 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
405 if (j > (buffer_size - 4))
408 temp[j + 1] = buffer[i];
411 if (j > (buffer_size - 3))
418 assert((j + 1) < buffer_size);
422 sstrncpy(buffer, temp, buffer_size);
425 } /* int escape_string */
427 int strunescape(char *buf, size_t buf_len) {
428 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
432 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
433 ERROR("string unescape: backslash found at end of string.");
434 /* Ensure null-byte at the end of the buffer. */
439 switch (buf[i + 1]) {
454 /* Move everything after the position one position to the left.
455 * Add a null-byte as last character in the buffer. */
456 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
457 buf[buf_len - 1] = 0;
460 } /* int strunescape */
462 size_t strstripnewline(char *buffer) {
463 size_t buffer_len = strlen(buffer);
465 while (buffer_len > 0) {
466 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
469 buffer[buffer_len] = 0;
473 } /* size_t strstripnewline */
475 int escape_slashes(char *buffer, size_t buffer_size) {
478 buffer_len = strlen(buffer);
480 if (buffer_len <= 1) {
481 if (strcmp("/", buffer) == 0) {
484 sstrncpy(buffer, "root", buffer_size);
489 /* Move one to the left */
490 if (buffer[0] == '/') {
491 memmove(buffer, buffer + 1, buffer_len);
495 for (size_t i = 0; i < buffer_len; i++) {
496 if (buffer[i] == '/')
501 } /* int escape_slashes */
503 void replace_special(char *buffer, size_t buffer_size) {
504 for (size_t i = 0; i < buffer_size; i++) {
507 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
510 } /* void replace_special */
512 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
513 struct timeval *larger;
514 struct timeval *smaller;
518 NORMALIZE_TIMEVAL(tv0);
519 NORMALIZE_TIMEVAL(tv1);
521 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
529 if ((tv0.tv_sec < tv1.tv_sec) ||
530 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
541 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
543 if (smaller->tv_usec <= larger->tv_usec)
544 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
547 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
551 assert((delta == NULL) ||
552 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
555 } /* int timeval_cmp */
557 int check_create_dir(const char *file_orig) {
567 int last_is_file = 1;
568 int path_is_absolute = 0;
572 * Sanity checks first
574 if (file_orig == NULL)
577 if ((len = strlen(file_orig)) < 1)
579 else if (len >= sizeof(file_copy))
583 * If `file_orig' ends in a slash the last component is a directory,
584 * otherwise it's a file. Act accordingly..
586 if (file_orig[len - 1] == '/')
588 if (file_orig[0] == '/')
589 path_is_absolute = 1;
592 * Create a copy for `strtok_r' to destroy
594 sstrncpy(file_copy, file_orig, sizeof(file_copy));
597 * Break into components. This will eat up several slashes in a row and
598 * remove leading and trailing slashes..
603 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
607 if (fields_num >= 16)
612 * For each component, do..
614 for (int i = 0; i < (fields_num - last_is_file); i++) {
616 * Do not create directories that start with a dot. This
617 * prevents `../../' attacks and other likely malicious
620 if (fields[i][0] == '.') {
621 ERROR("Cowardly refusing to create a directory that "
622 "begins with a `.' (dot): `%s'",
628 * Join the components together again
631 if (strjoin(dir + path_is_absolute, (size_t)(dir_len - path_is_absolute),
632 fields, (size_t)(i + 1), "/") < 0) {
633 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
638 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
639 if (errno == ENOENT) {
640 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
643 /* this might happen, if a different thread created
644 * the directory in the meantime
645 * => call stat() again to check for S_ISDIR() */
650 ERROR("check_create_dir: mkdir (%s): %s", dir,
651 sstrerror(errno, errbuf, sizeof(errbuf)));
655 ERROR("check_create_dir: stat (%s): %s", dir,
656 sstrerror(errno, errbuf, sizeof(errbuf)));
659 } else if (!S_ISDIR(statbuf.st_mode)) {
660 ERROR("check_create_dir: `%s' exists but is not "
670 } /* check_create_dir */
673 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
681 ssnprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
683 *ksp_ptr = kstat_lookup(kc, module, instance, name);
684 if (*ksp_ptr == NULL) {
685 ERROR("get_kstat: Cound not find kstat %s", ident);
689 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
690 ERROR("get_kstat: kstat %s has wrong type", ident);
696 assert(*ksp_ptr != NULL);
697 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
700 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
701 ERROR("get_kstat: kstat %s could not be read", ident);
705 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
706 ERROR("get_kstat: kstat %s has wrong type", ident);
713 long long get_kstat_value(kstat_t *ksp, char *name) {
715 long long retval = -1LL;
718 ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
720 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
721 ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
722 "is not KSTAT_TYPE_NAMED (%#x).",
723 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
727 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
730 if (kn->data_type == KSTAT_DATA_INT32)
731 retval = (long long)kn->value.i32;
732 else if (kn->data_type == KSTAT_DATA_UINT32)
733 retval = (long long)kn->value.ui32;
734 else if (kn->data_type == KSTAT_DATA_INT64)
736 (long long)kn->value.i64; /* According to ANSI C99 `long long' must hold
738 else if (kn->data_type == KSTAT_DATA_UINT64)
739 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
741 WARNING("get_kstat_value: Not a numeric value: %s", name);
745 #endif /* HAVE_LIBKSTAT */
748 unsigned long long ntohll(unsigned long long n) {
749 #if BYTE_ORDER == BIG_ENDIAN
752 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
754 } /* unsigned long long ntohll */
756 unsigned long long htonll(unsigned long long n) {
757 #if BYTE_ORDER == BIG_ENDIAN
760 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
762 } /* unsigned long long htonll */
763 #endif /* HAVE_HTONLL */
765 #if FP_LAYOUT_NEED_NOTHING
766 /* Well, we need nothing.. */
767 /* #endif FP_LAYOUT_NEED_NOTHING */
769 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
770 #if FP_LAYOUT_NEED_ENDIANFLIP
771 #define FP_CONVERT(A) \
772 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
773 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
774 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
775 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
776 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
777 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
778 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
779 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
781 #define FP_CONVERT(A) \
782 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
783 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
786 double ntohd(double d) {
795 /* NAN in x86 byte order */
796 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
797 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
798 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
804 ret.integer = FP_CONVERT(tmp);
805 return (ret.floating);
809 double htond(double d) {
817 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
818 ret.byte[4] = ret.byte[5] = 0x00;
821 return (ret.floating);
826 tmp = FP_CONVERT(ret.integer);
828 return (ret.floating);
831 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
833 int format_name(char *ret, int ret_len, const char *hostname,
834 const char *plugin, const char *plugin_instance,
835 const char *type, const char *type_instance) {
840 buffer_size = (size_t)ret_len;
842 #define APPEND(str) \
844 size_t l = strlen(str); \
845 if (l >= buffer_size) \
847 memcpy(buffer, (str), l); \
852 assert(plugin != NULL);
853 assert(type != NULL);
858 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
860 APPEND(plugin_instance);
864 if ((type_instance != NULL) && (type_instance[0] != 0)) {
866 APPEND(type_instance);
868 assert(buffer_size > 0);
873 } /* int format_name */
875 int format_values(char *ret, size_t ret_len, /* {{{ */
876 const data_set_t *ds, const value_list_t *vl,
880 gauge_t *rates = NULL;
882 assert(0 == strcmp(ds->type, vl->type));
884 memset(ret, 0, ret_len);
886 #define BUFFER_ADD(...) \
888 status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
892 } else if (((size_t)status) >= (ret_len - offset)) { \
896 offset += ((size_t)status); \
899 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
901 for (size_t i = 0; i < ds->ds_num; i++) {
902 if (ds->ds[i].type == DS_TYPE_GAUGE)
903 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
904 else if (store_rates) {
906 rates = uc_get_rate(ds, vl);
908 WARNING("format_values: uc_get_rate failed.");
911 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
912 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
913 BUFFER_ADD(":%llu", vl->values[i].counter);
914 else if (ds->ds[i].type == DS_TYPE_DERIVE)
915 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
916 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
917 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
919 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
923 } /* for ds->ds_num */
929 } /* }}} int format_values */
931 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
932 char **ret_plugin_instance, char **ret_type,
933 char **ret_type_instance, char *default_host) {
934 char *hostname = NULL;
936 char *plugin_instance = NULL;
938 char *type_instance = NULL;
941 if (hostname == NULL)
944 plugin = strchr(hostname, '/');
950 type = strchr(plugin, '/');
952 if (default_host == NULL)
954 /* else: no host specified; use default */
957 hostname = default_host;
963 plugin_instance = strchr(plugin, '-');
964 if (plugin_instance != NULL) {
965 *plugin_instance = '\0';
969 type_instance = strchr(type, '-');
970 if (type_instance != NULL) {
971 *type_instance = '\0';
975 *ret_host = hostname;
976 *ret_plugin = plugin;
977 *ret_plugin_instance = plugin_instance;
979 *ret_type_instance = type_instance;
981 } /* int parse_identifier */
983 int parse_identifier_vl(const char *str, value_list_t *vl) /* {{{ */
985 char str_copy[6 * DATA_MAX_NAME_LEN];
988 char *plugin_instance = NULL;
990 char *type_instance = NULL;
993 if ((str == NULL) || (vl == NULL))
996 sstrncpy(str_copy, str, sizeof(str_copy));
998 status = parse_identifier(str_copy, &host, &plugin, &plugin_instance, &type,
1000 /* default_host = */ NULL);
1004 sstrncpy(vl->host, host, sizeof(vl->host));
1005 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
1006 sstrncpy(vl->plugin_instance,
1007 (plugin_instance != NULL) ? plugin_instance : "",
1008 sizeof(vl->plugin_instance));
1009 sstrncpy(vl->type, type, sizeof(vl->type));
1010 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
1011 sizeof(vl->type_instance));
1014 } /* }}} int parse_identifier_vl */
1016 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
1018 char *endptr = NULL;
1021 if (value_orig == NULL)
1024 value = strdup(value_orig);
1027 value_len = strlen(value);
1029 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1030 value[value_len - 1] = 0;
1035 case DS_TYPE_COUNTER:
1036 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1040 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1043 case DS_TYPE_DERIVE:
1044 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1047 case DS_TYPE_ABSOLUTE:
1048 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1053 ERROR("parse_value: Invalid data source type: %i.", ds_type);
1057 if (value == endptr) {
1058 ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1059 DS_TYPE_TO_STRING(ds_type), value);
1062 } else if ((NULL != endptr) && ('\0' != *endptr))
1063 INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1064 "Input string was \"%s\".",
1065 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1069 } /* int parse_value */
1071 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1077 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1084 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1087 if (i >= vl->values_len) {
1088 /* Make sure i is invalid. */
1093 if (vl->time == 0) {
1094 if (strcmp("N", ptr) == 0)
1095 vl->time = cdtime();
1097 char *endptr = NULL;
1101 tmp = strtod(ptr, &endptr);
1102 if ((errno != 0) /* Overflow */
1103 || (endptr == ptr) /* Invalid string */
1104 || (endptr == NULL) /* This should not happen */
1105 || (*endptr != 0)) /* Trailing chars */
1108 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1114 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1115 vl->values[i].gauge = NAN;
1116 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1120 } /* while (strtok_r) */
1122 if ((ptr != NULL) || (i == 0))
1125 } /* int parse_values */
1127 int parse_value_file(char const *path, value_t *ret_value, int ds_type) {
1131 fh = fopen(path, "r");
1135 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
1142 strstripnewline(buffer);
1144 return parse_value(buffer, ret_value, ds_type);
1145 } /* int parse_value_file */
1147 #if !HAVE_GETPWNAM_R
1148 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1149 struct passwd **pwbufp) {
1153 memset(pwbuf, '\0', sizeof(struct passwd));
1155 pthread_mutex_lock(&getpwnam_r_lock);
1158 pw = getpwnam(name);
1160 status = (errno != 0) ? errno : ENOENT;
1164 #define GETPWNAM_COPY_MEMBER(member) \
1165 if (pw->member != NULL) { \
1166 int len = strlen(pw->member); \
1167 if (len >= buflen) { \
1171 sstrncpy(buf, pw->member, buflen); \
1172 pwbuf->member = buf; \
1174 buflen -= (len + 1); \
1176 GETPWNAM_COPY_MEMBER(pw_name);
1177 GETPWNAM_COPY_MEMBER(pw_passwd);
1178 GETPWNAM_COPY_MEMBER(pw_gecos);
1179 GETPWNAM_COPY_MEMBER(pw_dir);
1180 GETPWNAM_COPY_MEMBER(pw_shell);
1182 pwbuf->pw_uid = pw->pw_uid;
1183 pwbuf->pw_gid = pw->pw_gid;
1189 pthread_mutex_unlock(&getpwnam_r_lock);
1192 } /* int getpwnam_r */
1193 #endif /* !HAVE_GETPWNAM_R */
1195 int notification_init(notification_t *n, int severity, const char *message,
1196 const char *host, const char *plugin,
1197 const char *plugin_instance, const char *type,
1198 const char *type_instance) {
1199 memset(n, '\0', sizeof(notification_t));
1201 n->severity = severity;
1203 if (message != NULL)
1204 sstrncpy(n->message, message, sizeof(n->message));
1206 sstrncpy(n->host, host, sizeof(n->host));
1208 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1209 if (plugin_instance != NULL)
1210 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1212 sstrncpy(n->type, type, sizeof(n->type));
1213 if (type_instance != NULL)
1214 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1217 } /* int notification_init */
1219 int walk_directory(const char *dir, dirwalk_callback_f callback,
1220 void *user_data, int include_hidden) {
1229 if ((dh = opendir(dir)) == NULL) {
1231 ERROR("walk_directory: Cannot open '%s': %s", dir,
1232 sstrerror(errno, errbuf, sizeof(errbuf)));
1236 while ((ent = readdir(dh)) != NULL) {
1239 if (include_hidden) {
1240 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1242 } else /* if (!include_hidden) */
1244 if (ent->d_name[0] == '.')
1248 status = (*callback)(dir, ent->d_name, user_data);
1257 if ((success == 0) && (failure > 0))
1262 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1266 fh = fopen(filename, "r");
1270 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1271 if ((ret == 0) && (ferror(fh) != 0)) {
1272 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1280 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1283 if (old_value > new_value) {
1284 if (old_value <= 4294967295U)
1285 diff = (4294967295U - old_value) + new_value + 1;
1287 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1289 diff = new_value - old_value;
1293 } /* counter_t counter_diff */
1295 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1296 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1297 gauge_t delta_gauge;
1300 if (ds_type == DS_TYPE_GAUGE) {
1301 state->last_value.gauge = rate;
1302 state->last_time = t;
1304 *ret_value = state->last_value;
1308 /* Counter and absolute can't handle negative rates. Reset "last time"
1309 * to zero, so that the next valid rate will re-initialize the
1312 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1313 memset(state, 0, sizeof(*state));
1317 /* Another invalid state: The time is not increasing. */
1318 if (t <= state->last_time) {
1319 memset(state, 0, sizeof(*state));
1323 delta_t = t - state->last_time;
1324 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1326 /* Previous value is invalid. */
1327 if (state->last_time == 0) /* {{{ */
1329 if (ds_type == DS_TYPE_DERIVE) {
1330 state->last_value.derive = (derive_t)rate;
1331 state->residual = rate - ((gauge_t)state->last_value.derive);
1332 } else if (ds_type == DS_TYPE_COUNTER) {
1333 state->last_value.counter = (counter_t)rate;
1334 state->residual = rate - ((gauge_t)state->last_value.counter);
1335 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1336 state->last_value.absolute = (absolute_t)rate;
1337 state->residual = rate - ((gauge_t)state->last_value.absolute);
1342 state->last_time = t;
1346 if (ds_type == DS_TYPE_DERIVE) {
1347 derive_t delta_derive = (derive_t)delta_gauge;
1349 state->last_value.derive += delta_derive;
1350 state->residual = delta_gauge - ((gauge_t)delta_derive);
1351 } else if (ds_type == DS_TYPE_COUNTER) {
1352 counter_t delta_counter = (counter_t)delta_gauge;
1354 state->last_value.counter += delta_counter;
1355 state->residual = delta_gauge - ((gauge_t)delta_counter);
1356 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1357 absolute_t delta_absolute = (absolute_t)delta_gauge;
1359 state->last_value.absolute = delta_absolute;
1360 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1365 state->last_time = t;
1366 *ret_value = state->last_value;
1368 } /* }}} value_t rate_to_value */
1370 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1371 value_t value, int ds_type, cdtime_t t,
1372 value_to_rate_state_t *state) {
1375 /* Another invalid state: The time is not increasing. */
1376 if (t <= state->last_time) {
1377 memset(state, 0, sizeof(*state));
1381 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1383 /* Previous value is invalid. */
1384 if (state->last_time == 0) {
1385 state->last_value = value;
1386 state->last_time = t;
1391 case DS_TYPE_DERIVE: {
1392 derive_t diff = value.derive - state->last_value.derive;
1393 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1396 case DS_TYPE_GAUGE: {
1397 *ret_rate = value.gauge;
1400 case DS_TYPE_COUNTER: {
1401 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1402 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1405 case DS_TYPE_ABSOLUTE: {
1406 absolute_t diff = value.absolute;
1407 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1414 state->last_value = value;
1415 state->last_time = t;
1417 } /* }}} value_t rate_to_value */
1419 int service_name_to_port_number(const char *service_name) {
1420 struct addrinfo *ai_list;
1424 if (service_name == NULL)
1427 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1429 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1431 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1432 gai_strerror(status));
1436 service_number = -1;
1437 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1438 ai_ptr = ai_ptr->ai_next) {
1439 if (ai_ptr->ai_family == AF_INET) {
1440 struct sockaddr_in *sa;
1442 sa = (void *)ai_ptr->ai_addr;
1443 service_number = (int)ntohs(sa->sin_port);
1444 } else if (ai_ptr->ai_family == AF_INET6) {
1445 struct sockaddr_in6 *sa;
1447 sa = (void *)ai_ptr->ai_addr;
1448 service_number = (int)ntohs(sa->sin6_port);
1451 if ((service_number > 0) && (service_number <= 65535))
1455 freeaddrinfo(ai_list);
1457 if ((service_number > 0) && (service_number <= 65535))
1458 return (service_number);
1460 } /* int service_name_to_port_number */
1462 void set_sock_opts(int sockfd) /* {{{ */
1467 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1468 &(socklen_t){sizeof(socktype)});
1470 WARNING("set_sock_opts: failed to determine socket type");
1474 if (socktype == SOCK_STREAM) {
1476 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1478 WARNING("set_sock_opts: failed to set socket keepalive flag");
1481 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1482 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1483 sizeof(tcp_keepidle));
1485 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1488 #ifdef TCP_KEEPINTVL
1490 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1491 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1492 sizeof(tcp_keepintvl));
1494 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1497 } /* }}} void set_sock_opts */
1499 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1504 if ((string == NULL) || (ret_value == NULL))
1509 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1510 if ((endptr == string) || (errno != 0))
1515 } /* }}} int strtoderive */
1517 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1520 char *endptr = NULL;
1522 if ((string == NULL) || (ret_value == NULL))
1527 tmp = (gauge_t)strtod(string, &endptr);
1530 else if ((endptr == NULL) || (*endptr != 0))
1535 } /* }}} int strtogauge */
1537 int strarray_add(char ***ret_array, size_t *ret_array_len,
1538 char const *str) /* {{{ */
1541 size_t array_len = *ret_array_len;
1546 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1551 array[array_len] = strdup(str);
1552 if (array[array_len] == NULL)
1556 *ret_array_len = array_len;
1558 } /* }}} int strarray_add */
1560 void strarray_free(char **array, size_t array_len) /* {{{ */
1562 for (size_t i = 0; i < array_len; i++)
1565 } /* }}} void strarray_free */
1568 int check_capability(int arg) /* {{{ */
1570 cap_value_t cap = (cap_value_t)arg;
1572 if (!CAP_IS_SUPPORTED(cap))
1575 int have_cap = cap_get_bound(cap);
1580 } /* }}} int check_capability */
1582 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1584 WARNING("check_capability: unsupported capability implementation. "
1585 "Some plugin(s) may require elevated privileges to work properly.");
1587 } /* }}} int check_capability */
1588 #endif /* HAVE_CAPABILITY */