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 char *ssnprintf_alloc(char const *format, ...) /* {{{ */
89 char static_buffer[1024] = "";
91 size_t alloc_buffer_size;
95 /* Try printing into the static buffer. In many cases it will be
96 * sufficiently large and we can simply return a strdup() of this
99 status = vsnprintf(static_buffer, sizeof(static_buffer), format, ap);
104 /* "status" does not include the null byte. */
105 alloc_buffer_size = (size_t)(status + 1);
106 if (alloc_buffer_size <= sizeof(static_buffer))
107 return strdup(static_buffer);
109 /* Allocate a buffer large enough to hold the string. */
110 alloc_buffer = calloc(1, alloc_buffer_size);
111 if (alloc_buffer == NULL)
114 /* Print again into this new buffer. */
115 va_start(ap, format);
116 status = vsnprintf(alloc_buffer, alloc_buffer_size, format, ap);
124 } /* }}} char *ssnprintf_alloc */
126 char *sstrdup(const char *s) {
133 /* Do not use `strdup' here, because it's not specified in POSIX. It's
134 * ``only'' an XSI extension. */
138 ERROR("sstrdup: Out of memory.");
144 } /* char *sstrdup */
146 /* Even though Posix requires "strerror_r" to return an "int",
147 * some systems (e.g. the GNU libc) return a "char *" _and_
148 * ignore the second argument ... -tokkee */
149 char *sstrerror(int errnum, char *buf, size_t buflen) {
156 pthread_mutex_lock(&strerror_r_lock);
158 temp = strerror(errnum);
159 sstrncpy(buf, temp, buflen);
161 pthread_mutex_unlock(&strerror_r_lock);
163 /* #endif !HAVE_STRERROR_R */
165 #elif STRERROR_R_CHAR_P
168 temp = strerror_r(errnum, buf, buflen);
169 if (buf[0] == '\0') {
170 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
171 sstrncpy(buf, temp, buflen);
173 sstrncpy(buf, "strerror_r did not return "
178 /* #endif STRERROR_R_CHAR_P */
181 if (strerror_r(errnum, buf, buflen) != 0) {
182 snprintf(buf, buflen, "Error #%i; "
183 "Additionally, strerror_r failed.",
186 #endif /* STRERROR_R_CHAR_P */
189 } /* char *sstrerror */
191 void *smalloc(size_t size) {
194 if ((r = malloc(size)) == NULL) {
195 ERROR("Not enough memory.");
200 } /* void *smalloc */
203 void sfree (void **ptr)
215 ssize_t sread(int fd, void *buf, size_t count) {
224 status = read(fd, (void *)ptr, nleft);
226 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
233 DEBUG("Received EOF from fd %i. "
234 "Closing fd and returning error.",
240 assert((0 > status) || (nleft >= (size_t)status));
242 nleft = nleft - ((size_t)status);
243 ptr = ptr + ((size_t)status);
249 ssize_t swrite(int fd, const void *buf, size_t count) {
255 ptr = (const char *)buf;
263 /* checking for closed peer connection */
265 pfd.events = POLLIN | POLLHUP;
267 if (poll(&pfd, 1, 0) > 0) {
269 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
270 /* if recv returns zero (even though poll() said there is data to be
271 * read), that means the connection has been closed */
272 return errno ? errno : -1;
277 status = write(fd, (const void *)ptr, nleft);
279 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
283 return errno ? errno : status;
285 nleft = nleft - ((size_t)status);
286 ptr = ptr + ((size_t)status);
292 int strsplit(char *string, char **fields, size_t size) {
300 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
311 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
317 size_t buffer_req = 0;
319 if (((fields_num != 0) && (fields == NULL)) ||
320 ((buffer_size != 0) && (buffer == NULL)))
326 if (buffer_size != 0)
327 avail = buffer_size - 1;
330 sep_len = strlen(sep);
332 for (size_t i = 0; i < fields_num; i++) {
333 size_t field_len = strlen(fields[i]);
336 buffer_req += sep_len;
337 buffer_req += field_len;
339 if ((i != 0) && (sep_len > 0)) {
340 if (sep_len >= avail) {
341 /* prevent subsequent iterations from writing to the
347 memcpy(ptr, sep, sep_len);
353 if (field_len > avail)
356 memcpy(ptr, fields[i], field_len);
364 return (int)buffer_req;
367 int escape_string(char *buffer, size_t buffer_size) {
371 /* Check if we need to escape at all first */
372 temp = strpbrk(buffer, " \t\"\\");
379 temp = calloc(1, buffer_size);
386 for (size_t i = 0; i < buffer_size; i++) {
387 if (buffer[i] == 0) {
389 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
390 if (j > (buffer_size - 4))
393 temp[j + 1] = buffer[i];
396 if (j > (buffer_size - 3))
403 assert((j + 1) < buffer_size);
407 sstrncpy(buffer, temp, buffer_size);
410 } /* int escape_string */
412 int strunescape(char *buf, size_t buf_len) {
413 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
417 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
418 ERROR("string unescape: backslash found at end of string.");
419 /* Ensure null-byte at the end of the buffer. */
424 switch (buf[i + 1]) {
439 /* Move everything after the position one position to the left.
440 * Add a null-byte as last character in the buffer. */
441 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
442 buf[buf_len - 1] = 0;
445 } /* int strunescape */
447 size_t strstripnewline(char *buffer) {
448 size_t buffer_len = strlen(buffer);
450 while (buffer_len > 0) {
451 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
454 buffer[buffer_len] = 0;
458 } /* size_t strstripnewline */
460 int escape_slashes(char *buffer, size_t buffer_size) {
463 buffer_len = strlen(buffer);
465 if (buffer_len <= 1) {
466 if (strcmp("/", buffer) == 0) {
469 sstrncpy(buffer, "root", buffer_size);
474 /* Move one to the left */
475 if (buffer[0] == '/') {
476 memmove(buffer, buffer + 1, buffer_len);
480 for (size_t i = 0; i < buffer_len; i++) {
481 if (buffer[i] == '/')
486 } /* int escape_slashes */
488 void replace_special(char *buffer, size_t buffer_size) {
489 for (size_t i = 0; i < buffer_size; i++) {
492 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
495 } /* void replace_special */
497 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
498 struct timeval *larger;
499 struct timeval *smaller;
503 NORMALIZE_TIMEVAL(tv0);
504 NORMALIZE_TIMEVAL(tv1);
506 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
514 if ((tv0.tv_sec < tv1.tv_sec) ||
515 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
526 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
528 if (smaller->tv_usec <= larger->tv_usec)
529 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
532 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
536 assert((delta == NULL) ||
537 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
540 } /* int timeval_cmp */
542 int check_create_dir(const char *file_orig) {
552 int last_is_file = 1;
553 int path_is_absolute = 0;
557 * Sanity checks first
559 if (file_orig == NULL)
562 if ((len = strlen(file_orig)) < 1)
564 else if (len >= sizeof(file_copy))
568 * If `file_orig' ends in a slash the last component is a directory,
569 * otherwise it's a file. Act accordingly..
571 if (file_orig[len - 1] == '/')
573 if (file_orig[0] == '/')
574 path_is_absolute = 1;
577 * Create a copy for `strtok_r' to destroy
579 sstrncpy(file_copy, file_orig, sizeof(file_copy));
582 * Break into components. This will eat up several slashes in a row and
583 * remove leading and trailing slashes..
588 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
592 if (fields_num >= 16)
597 * For each component, do..
599 for (int i = 0; i < (fields_num - last_is_file); i++) {
601 * Do not create directories that start with a dot. This
602 * prevents `../../' attacks and other likely malicious
605 if (fields[i][0] == '.') {
606 ERROR("Cowardly refusing to create a directory that "
607 "begins with a `.' (dot): `%s'",
613 * Join the components together again
616 if (strjoin(dir + path_is_absolute, (size_t)(dir_len - path_is_absolute),
617 fields, (size_t)(i + 1), "/") < 0) {
618 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
623 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
624 if (errno == ENOENT) {
625 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
628 /* this might happen, if a different thread created
629 * the directory in the meantime
630 * => call stat() again to check for S_ISDIR() */
635 ERROR("check_create_dir: mkdir (%s): %s", dir,
636 sstrerror(errno, errbuf, sizeof(errbuf)));
640 ERROR("check_create_dir: stat (%s): %s", dir,
641 sstrerror(errno, errbuf, sizeof(errbuf)));
644 } else if (!S_ISDIR(statbuf.st_mode)) {
645 ERROR("check_create_dir: `%s' exists but is not "
655 } /* check_create_dir */
658 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
666 snprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
668 *ksp_ptr = kstat_lookup(kc, module, instance, name);
669 if (*ksp_ptr == NULL) {
670 ERROR("get_kstat: Cound not find kstat %s", ident);
674 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
675 ERROR("get_kstat: kstat %s has wrong type", ident);
681 assert(*ksp_ptr != NULL);
682 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
685 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
686 ERROR("get_kstat: kstat %s could not be read", ident);
690 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
691 ERROR("get_kstat: kstat %s has wrong type", ident);
698 long long get_kstat_value(kstat_t *ksp, char *name) {
700 long long retval = -1LL;
703 ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
705 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
706 ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
707 "is not KSTAT_TYPE_NAMED (%#x).",
708 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
712 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
715 if (kn->data_type == KSTAT_DATA_INT32)
716 retval = (long long)kn->value.i32;
717 else if (kn->data_type == KSTAT_DATA_UINT32)
718 retval = (long long)kn->value.ui32;
719 else if (kn->data_type == KSTAT_DATA_INT64)
721 (long long)kn->value.i64; /* According to ANSI C99 `long long' must hold
723 else if (kn->data_type == KSTAT_DATA_UINT64)
724 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
726 WARNING("get_kstat_value: Not a numeric value: %s", name);
730 #endif /* HAVE_LIBKSTAT */
733 unsigned long long ntohll(unsigned long long n) {
734 #if BYTE_ORDER == BIG_ENDIAN
737 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
739 } /* unsigned long long ntohll */
741 unsigned long long htonll(unsigned long long n) {
742 #if BYTE_ORDER == BIG_ENDIAN
745 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
747 } /* unsigned long long htonll */
748 #endif /* HAVE_HTONLL */
750 #if FP_LAYOUT_NEED_NOTHING
751 /* Well, we need nothing.. */
752 /* #endif FP_LAYOUT_NEED_NOTHING */
754 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
755 #if FP_LAYOUT_NEED_ENDIANFLIP
756 #define FP_CONVERT(A) \
757 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
758 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
759 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
760 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
761 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
762 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
763 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
764 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
766 #define FP_CONVERT(A) \
767 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
768 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
771 double ntohd(double d) {
780 /* NAN in x86 byte order */
781 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
782 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
783 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
789 ret.integer = FP_CONVERT(tmp);
794 double htond(double d) {
802 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
803 ret.byte[4] = ret.byte[5] = 0x00;
811 tmp = FP_CONVERT(ret.integer);
816 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
818 int format_name(char *ret, int ret_len, const char *hostname,
819 const char *plugin, const char *plugin_instance,
820 const char *type, const char *type_instance) {
825 buffer_size = (size_t)ret_len;
827 #define APPEND(str) \
829 size_t l = strlen(str); \
830 if (l >= buffer_size) \
832 memcpy(buffer, (str), l); \
837 assert(plugin != NULL);
838 assert(type != NULL);
843 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
845 APPEND(plugin_instance);
849 if ((type_instance != NULL) && (type_instance[0] != 0)) {
851 APPEND(type_instance);
853 assert(buffer_size > 0);
858 } /* int format_name */
860 int format_values(char *ret, size_t ret_len, /* {{{ */
861 const data_set_t *ds, const value_list_t *vl,
865 gauge_t *rates = NULL;
867 assert(0 == strcmp(ds->type, vl->type));
869 memset(ret, 0, ret_len);
871 #define BUFFER_ADD(...) \
873 status = snprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
877 } else if (((size_t)status) >= (ret_len - offset)) { \
881 offset += ((size_t)status); \
884 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
886 for (size_t i = 0; i < ds->ds_num; i++) {
887 if (ds->ds[i].type == DS_TYPE_GAUGE)
888 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
889 else if (store_rates) {
891 rates = uc_get_rate(ds, vl);
893 WARNING("format_values: uc_get_rate failed.");
896 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
897 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
898 BUFFER_ADD(":%llu", vl->values[i].counter);
899 else if (ds->ds[i].type == DS_TYPE_DERIVE)
900 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
901 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
902 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
904 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
908 } /* for ds->ds_num */
914 } /* }}} int format_values */
916 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
917 char **ret_plugin_instance, char **ret_type,
918 char **ret_type_instance, char *default_host) {
919 char *hostname = NULL;
921 char *plugin_instance = NULL;
923 char *type_instance = NULL;
926 if (hostname == NULL)
929 plugin = strchr(hostname, '/');
935 type = strchr(plugin, '/');
937 if (default_host == NULL)
939 /* else: no host specified; use default */
942 hostname = default_host;
948 plugin_instance = strchr(plugin, '-');
949 if (plugin_instance != NULL) {
950 *plugin_instance = '\0';
954 type_instance = strchr(type, '-');
955 if (type_instance != NULL) {
956 *type_instance = '\0';
960 *ret_host = hostname;
961 *ret_plugin = plugin;
962 *ret_plugin_instance = plugin_instance;
964 *ret_type_instance = type_instance;
966 } /* int parse_identifier */
968 int parse_identifier_vl(const char *str, value_list_t *vl) /* {{{ */
970 char str_copy[6 * DATA_MAX_NAME_LEN];
973 char *plugin_instance = NULL;
975 char *type_instance = NULL;
978 if ((str == NULL) || (vl == NULL))
981 sstrncpy(str_copy, str, sizeof(str_copy));
983 status = parse_identifier(str_copy, &host, &plugin, &plugin_instance, &type,
985 /* default_host = */ NULL);
989 sstrncpy(vl->host, host, sizeof(vl->host));
990 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
991 sstrncpy(vl->plugin_instance,
992 (plugin_instance != NULL) ? plugin_instance : "",
993 sizeof(vl->plugin_instance));
994 sstrncpy(vl->type, type, sizeof(vl->type));
995 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
996 sizeof(vl->type_instance));
999 } /* }}} int parse_identifier_vl */
1001 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
1003 char *endptr = NULL;
1006 if (value_orig == NULL)
1009 value = strdup(value_orig);
1012 value_len = strlen(value);
1014 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1015 value[value_len - 1] = 0;
1020 case DS_TYPE_COUNTER:
1021 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1025 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1028 case DS_TYPE_DERIVE:
1029 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1032 case DS_TYPE_ABSOLUTE:
1033 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1038 ERROR("parse_value: Invalid data source type: %i.", ds_type);
1042 if (value == endptr) {
1043 ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1044 DS_TYPE_TO_STRING(ds_type), value);
1047 } else if ((NULL != endptr) && ('\0' != *endptr))
1048 INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1049 "Input string was \"%s\".",
1050 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1054 } /* int parse_value */
1056 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1062 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1069 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1072 if (i >= vl->values_len) {
1073 /* Make sure i is invalid. */
1078 if (vl->time == 0) {
1079 if (strcmp("N", ptr) == 0)
1080 vl->time = cdtime();
1082 char *endptr = NULL;
1086 tmp = strtod(ptr, &endptr);
1087 if ((errno != 0) /* Overflow */
1088 || (endptr == ptr) /* Invalid string */
1089 || (endptr == NULL) /* This should not happen */
1090 || (*endptr != 0)) /* Trailing chars */
1093 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1099 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1100 vl->values[i].gauge = NAN;
1101 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1105 } /* while (strtok_r) */
1107 if ((ptr != NULL) || (i == 0))
1110 } /* int parse_values */
1112 int parse_value_file(char const *path, value_t *ret_value, int ds_type) {
1116 fh = fopen(path, "r");
1120 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
1127 strstripnewline(buffer);
1129 return parse_value(buffer, ret_value, ds_type);
1130 } /* int parse_value_file */
1132 #if !HAVE_GETPWNAM_R
1133 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1134 struct passwd **pwbufp) {
1138 memset(pwbuf, '\0', sizeof(struct passwd));
1140 pthread_mutex_lock(&getpwnam_r_lock);
1143 pw = getpwnam(name);
1145 status = (errno != 0) ? errno : ENOENT;
1149 #define GETPWNAM_COPY_MEMBER(member) \
1150 if (pw->member != NULL) { \
1151 int len = strlen(pw->member); \
1152 if (len >= buflen) { \
1156 sstrncpy(buf, pw->member, buflen); \
1157 pwbuf->member = buf; \
1159 buflen -= (len + 1); \
1161 GETPWNAM_COPY_MEMBER(pw_name);
1162 GETPWNAM_COPY_MEMBER(pw_passwd);
1163 GETPWNAM_COPY_MEMBER(pw_gecos);
1164 GETPWNAM_COPY_MEMBER(pw_dir);
1165 GETPWNAM_COPY_MEMBER(pw_shell);
1167 pwbuf->pw_uid = pw->pw_uid;
1168 pwbuf->pw_gid = pw->pw_gid;
1174 pthread_mutex_unlock(&getpwnam_r_lock);
1177 } /* int getpwnam_r */
1178 #endif /* !HAVE_GETPWNAM_R */
1180 int notification_init(notification_t *n, int severity, const char *message,
1181 const char *host, const char *plugin,
1182 const char *plugin_instance, const char *type,
1183 const char *type_instance) {
1184 memset(n, '\0', sizeof(notification_t));
1186 n->severity = severity;
1188 if (message != NULL)
1189 sstrncpy(n->message, message, sizeof(n->message));
1191 sstrncpy(n->host, host, sizeof(n->host));
1193 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1194 if (plugin_instance != NULL)
1195 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1197 sstrncpy(n->type, type, sizeof(n->type));
1198 if (type_instance != NULL)
1199 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1202 } /* int notification_init */
1204 int walk_directory(const char *dir, dirwalk_callback_f callback,
1205 void *user_data, int include_hidden) {
1214 if ((dh = opendir(dir)) == NULL) {
1216 ERROR("walk_directory: Cannot open '%s': %s", dir,
1217 sstrerror(errno, errbuf, sizeof(errbuf)));
1221 while ((ent = readdir(dh)) != NULL) {
1224 if (include_hidden) {
1225 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1227 } else /* if (!include_hidden) */
1229 if (ent->d_name[0] == '.')
1233 status = (*callback)(dir, ent->d_name, user_data);
1242 if ((success == 0) && (failure > 0))
1247 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1251 fh = fopen(filename, "r");
1255 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1256 if ((ret == 0) && (ferror(fh) != 0)) {
1257 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1265 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1268 if (old_value > new_value) {
1269 if (old_value <= 4294967295U)
1270 diff = (4294967295U - old_value) + new_value + 1;
1272 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1274 diff = new_value - old_value;
1278 } /* counter_t counter_diff */
1280 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1281 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1282 gauge_t delta_gauge;
1285 if (ds_type == DS_TYPE_GAUGE) {
1286 state->last_value.gauge = rate;
1287 state->last_time = t;
1289 *ret_value = state->last_value;
1293 /* Counter and absolute can't handle negative rates. Reset "last time"
1294 * to zero, so that the next valid rate will re-initialize the
1297 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1298 memset(state, 0, sizeof(*state));
1302 /* Another invalid state: The time is not increasing. */
1303 if (t <= state->last_time) {
1304 memset(state, 0, sizeof(*state));
1308 delta_t = t - state->last_time;
1309 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1311 /* Previous value is invalid. */
1312 if (state->last_time == 0) /* {{{ */
1314 if (ds_type == DS_TYPE_DERIVE) {
1315 state->last_value.derive = (derive_t)rate;
1316 state->residual = rate - ((gauge_t)state->last_value.derive);
1317 } else if (ds_type == DS_TYPE_COUNTER) {
1318 state->last_value.counter = (counter_t)rate;
1319 state->residual = rate - ((gauge_t)state->last_value.counter);
1320 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1321 state->last_value.absolute = (absolute_t)rate;
1322 state->residual = rate - ((gauge_t)state->last_value.absolute);
1327 state->last_time = t;
1331 if (ds_type == DS_TYPE_DERIVE) {
1332 derive_t delta_derive = (derive_t)delta_gauge;
1334 state->last_value.derive += delta_derive;
1335 state->residual = delta_gauge - ((gauge_t)delta_derive);
1336 } else if (ds_type == DS_TYPE_COUNTER) {
1337 counter_t delta_counter = (counter_t)delta_gauge;
1339 state->last_value.counter += delta_counter;
1340 state->residual = delta_gauge - ((gauge_t)delta_counter);
1341 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1342 absolute_t delta_absolute = (absolute_t)delta_gauge;
1344 state->last_value.absolute = delta_absolute;
1345 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1350 state->last_time = t;
1351 *ret_value = state->last_value;
1353 } /* }}} value_t rate_to_value */
1355 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1356 value_t value, int ds_type, cdtime_t t,
1357 value_to_rate_state_t *state) {
1360 /* Another invalid state: The time is not increasing. */
1361 if (t <= state->last_time) {
1362 memset(state, 0, sizeof(*state));
1366 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1368 /* Previous value is invalid. */
1369 if (state->last_time == 0) {
1370 state->last_value = value;
1371 state->last_time = t;
1376 case DS_TYPE_DERIVE: {
1377 derive_t diff = value.derive - state->last_value.derive;
1378 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1381 case DS_TYPE_GAUGE: {
1382 *ret_rate = value.gauge;
1385 case DS_TYPE_COUNTER: {
1386 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1387 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1390 case DS_TYPE_ABSOLUTE: {
1391 absolute_t diff = value.absolute;
1392 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1399 state->last_value = value;
1400 state->last_time = t;
1402 } /* }}} value_t rate_to_value */
1404 int service_name_to_port_number(const char *service_name) {
1405 struct addrinfo *ai_list;
1409 if (service_name == NULL)
1412 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1414 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1416 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1417 gai_strerror(status));
1421 service_number = -1;
1422 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1423 ai_ptr = ai_ptr->ai_next) {
1424 if (ai_ptr->ai_family == AF_INET) {
1425 struct sockaddr_in *sa;
1427 sa = (void *)ai_ptr->ai_addr;
1428 service_number = (int)ntohs(sa->sin_port);
1429 } else if (ai_ptr->ai_family == AF_INET6) {
1430 struct sockaddr_in6 *sa;
1432 sa = (void *)ai_ptr->ai_addr;
1433 service_number = (int)ntohs(sa->sin6_port);
1436 if ((service_number > 0) && (service_number <= 65535))
1440 freeaddrinfo(ai_list);
1442 if ((service_number > 0) && (service_number <= 65535))
1443 return service_number;
1445 } /* int service_name_to_port_number */
1447 void set_sock_opts(int sockfd) /* {{{ */
1452 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1453 &(socklen_t){sizeof(socktype)});
1455 WARNING("set_sock_opts: failed to determine socket type");
1459 if (socktype == SOCK_STREAM) {
1461 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1463 WARNING("set_sock_opts: failed to set socket keepalive flag");
1466 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1467 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1468 sizeof(tcp_keepidle));
1470 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1473 #ifdef TCP_KEEPINTVL
1475 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1476 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1477 sizeof(tcp_keepintvl));
1479 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1482 } /* }}} void set_sock_opts */
1484 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1489 if ((string == NULL) || (ret_value == NULL))
1494 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1495 if ((endptr == string) || (errno != 0))
1500 } /* }}} int strtoderive */
1502 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1505 char *endptr = NULL;
1507 if ((string == NULL) || (ret_value == NULL))
1512 tmp = (gauge_t)strtod(string, &endptr);
1515 else if ((endptr == NULL) || (*endptr != 0))
1520 } /* }}} int strtogauge */
1522 int strarray_add(char ***ret_array, size_t *ret_array_len,
1523 char const *str) /* {{{ */
1526 size_t array_len = *ret_array_len;
1531 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1536 array[array_len] = strdup(str);
1537 if (array[array_len] == NULL)
1541 *ret_array_len = array_len;
1543 } /* }}} int strarray_add */
1545 void strarray_free(char **array, size_t array_len) /* {{{ */
1547 for (size_t i = 0; i < array_len; i++)
1550 } /* }}} void strarray_free */
1553 int check_capability(int arg) /* {{{ */
1555 cap_value_t cap_value = (cap_value_t)arg;
1557 cap_flag_value_t cap_flag_value;
1559 if (!CAP_IS_SUPPORTED(cap_value))
1562 if (!(cap = cap_get_proc())) {
1563 ERROR("check_capability: cap_get_proc failed.");
1567 if (cap_get_flag(cap, cap_value, CAP_EFFECTIVE, &cap_flag_value) < 0) {
1568 ERROR("check_capability: cap_get_flag failed.");
1574 return cap_flag_value != CAP_SET;
1575 } /* }}} int check_capability */
1577 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1579 WARNING("check_capability: unsupported capability implementation. "
1580 "Some plugin(s) may require elevated privileges to work properly.");
1582 } /* }}} int check_capability */
1583 #endif /* HAVE_CAPABILITY */