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 if ((buffer_size < 1) || (fields_num == 0))
335 memset(buffer, 0, buffer_size);
337 avail = buffer_size - 1;
341 sep_len = strlen(sep);
343 for (size_t i = 0; i < fields_num; i++) {
346 if ((i > 0) && (sep_len > 0)) {
350 memcpy(ptr, sep, sep_len);
355 field_len = strlen(fields[i]);
356 if (avail < field_len)
359 memcpy(ptr, fields[i], field_len);
364 assert(buffer[buffer_size - 1] == 0);
365 return ((int)strlen(buffer));
368 int escape_string(char *buffer, size_t buffer_size) {
372 /* Check if we need to escape at all first */
373 temp = strpbrk(buffer, " \t\"\\");
380 temp = calloc(1, buffer_size);
387 for (size_t i = 0; i < buffer_size; i++) {
388 if (buffer[i] == 0) {
390 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
391 if (j > (buffer_size - 4))
394 temp[j + 1] = buffer[i];
397 if (j > (buffer_size - 3))
404 assert((j + 1) < buffer_size);
408 sstrncpy(buffer, temp, buffer_size);
411 } /* int escape_string */
413 int strunescape(char *buf, size_t buf_len) {
414 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
418 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
419 ERROR("string unescape: backslash found at end of string.");
420 /* Ensure null-byte at the end of the buffer. */
425 switch (buf[i + 1]) {
440 /* Move everything after the position one position to the left.
441 * Add a null-byte as last character in the buffer. */
442 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
443 buf[buf_len - 1] = 0;
446 } /* int strunescape */
448 size_t strstripnewline(char *buffer) {
449 size_t buffer_len = strlen(buffer);
451 while (buffer_len > 0) {
452 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
455 buffer[buffer_len] = 0;
459 } /* size_t strstripnewline */
461 int escape_slashes(char *buffer, size_t buffer_size) {
464 buffer_len = strlen(buffer);
466 if (buffer_len <= 1) {
467 if (strcmp("/", buffer) == 0) {
470 sstrncpy(buffer, "root", buffer_size);
475 /* Move one to the left */
476 if (buffer[0] == '/') {
477 memmove(buffer, buffer + 1, buffer_len);
481 for (size_t i = 0; i < buffer_len; i++) {
482 if (buffer[i] == '/')
487 } /* int escape_slashes */
489 void replace_special(char *buffer, size_t buffer_size) {
490 for (size_t i = 0; i < buffer_size; i++) {
493 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
496 } /* void replace_special */
498 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
499 struct timeval *larger;
500 struct timeval *smaller;
504 NORMALIZE_TIMEVAL(tv0);
505 NORMALIZE_TIMEVAL(tv1);
507 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
515 if ((tv0.tv_sec < tv1.tv_sec) ||
516 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
527 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
529 if (smaller->tv_usec <= larger->tv_usec)
530 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
533 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
537 assert((delta == NULL) ||
538 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
541 } /* int timeval_cmp */
543 int check_create_dir(const char *file_orig) {
553 int last_is_file = 1;
554 int path_is_absolute = 0;
558 * Sanity checks first
560 if (file_orig == NULL)
563 if ((len = strlen(file_orig)) < 1)
565 else if (len >= sizeof(file_copy))
569 * If `file_orig' ends in a slash the last component is a directory,
570 * otherwise it's a file. Act accordingly..
572 if (file_orig[len - 1] == '/')
574 if (file_orig[0] == '/')
575 path_is_absolute = 1;
578 * Create a copy for `strtok_r' to destroy
580 sstrncpy(file_copy, file_orig, sizeof(file_copy));
583 * Break into components. This will eat up several slashes in a row and
584 * remove leading and trailing slashes..
589 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
593 if (fields_num >= 16)
598 * For each component, do..
600 for (int i = 0; i < (fields_num - last_is_file); i++) {
602 * Do not create directories that start with a dot. This
603 * prevents `../../' attacks and other likely malicious
606 if (fields[i][0] == '.') {
607 ERROR("Cowardly refusing to create a directory that "
608 "begins with a `.' (dot): `%s'",
614 * Join the components together again
617 if (strjoin(dir + path_is_absolute, (size_t)(dir_len - path_is_absolute),
618 fields, (size_t)(i + 1), "/") < 0) {
619 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
624 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
625 if (errno == ENOENT) {
626 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
629 /* this might happen, if a different thread created
630 * the directory in the meantime
631 * => call stat() again to check for S_ISDIR() */
636 ERROR("check_create_dir: mkdir (%s): %s", dir,
637 sstrerror(errno, errbuf, sizeof(errbuf)));
641 ERROR("check_create_dir: stat (%s): %s", dir,
642 sstrerror(errno, errbuf, sizeof(errbuf)));
645 } else if (!S_ISDIR(statbuf.st_mode)) {
646 ERROR("check_create_dir: `%s' exists but is not "
656 } /* check_create_dir */
659 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
667 ssnprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
669 *ksp_ptr = kstat_lookup(kc, module, instance, name);
670 if (*ksp_ptr == NULL) {
671 ERROR("get_kstat: Cound not find kstat %s", ident);
675 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
676 ERROR("get_kstat: kstat %s has wrong type", ident);
682 assert(*ksp_ptr != NULL);
683 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
686 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
687 ERROR("get_kstat: kstat %s could not be read", ident);
691 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
692 ERROR("get_kstat: kstat %s has wrong type", ident);
699 long long get_kstat_value(kstat_t *ksp, char *name) {
701 long long retval = -1LL;
704 ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
706 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
707 ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
708 "is not KSTAT_TYPE_NAMED (%#x).",
709 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
713 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
716 if (kn->data_type == KSTAT_DATA_INT32)
717 retval = (long long)kn->value.i32;
718 else if (kn->data_type == KSTAT_DATA_UINT32)
719 retval = (long long)kn->value.ui32;
720 else if (kn->data_type == KSTAT_DATA_INT64)
722 (long long)kn->value.i64; /* According to ANSI C99 `long long' must hold
724 else if (kn->data_type == KSTAT_DATA_UINT64)
725 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
727 WARNING("get_kstat_value: Not a numeric value: %s", name);
731 #endif /* HAVE_LIBKSTAT */
734 unsigned long long ntohll(unsigned long long n) {
735 #if BYTE_ORDER == BIG_ENDIAN
738 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
740 } /* unsigned long long ntohll */
742 unsigned long long htonll(unsigned long long n) {
743 #if BYTE_ORDER == BIG_ENDIAN
746 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
748 } /* unsigned long long htonll */
749 #endif /* HAVE_HTONLL */
751 #if FP_LAYOUT_NEED_NOTHING
752 /* Well, we need nothing.. */
753 /* #endif FP_LAYOUT_NEED_NOTHING */
755 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
756 #if FP_LAYOUT_NEED_ENDIANFLIP
757 #define FP_CONVERT(A) \
758 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
759 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
760 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
761 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
762 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
763 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
764 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
765 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
767 #define FP_CONVERT(A) \
768 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
769 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
772 double ntohd(double d) {
781 /* NAN in x86 byte order */
782 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
783 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
784 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
790 ret.integer = FP_CONVERT(tmp);
791 return (ret.floating);
795 double htond(double d) {
803 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
804 ret.byte[4] = ret.byte[5] = 0x00;
807 return (ret.floating);
812 tmp = FP_CONVERT(ret.integer);
814 return (ret.floating);
817 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
819 int format_name(char *ret, int ret_len, const char *hostname,
820 const char *plugin, const char *plugin_instance,
821 const char *type, const char *type_instance) {
826 buffer_size = (size_t)ret_len;
828 #define APPEND(str) \
830 size_t l = strlen(str); \
831 if (l >= buffer_size) \
833 memcpy(buffer, (str), l); \
838 assert(plugin != NULL);
839 assert(type != NULL);
844 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
846 APPEND(plugin_instance);
850 if ((type_instance != NULL) && (type_instance[0] != 0)) {
852 APPEND(type_instance);
854 assert(buffer_size > 0);
859 } /* int format_name */
861 int format_values(char *ret, size_t ret_len, /* {{{ */
862 const data_set_t *ds, const value_list_t *vl,
866 gauge_t *rates = NULL;
868 assert(0 == strcmp(ds->type, vl->type));
870 memset(ret, 0, ret_len);
872 #define BUFFER_ADD(...) \
874 status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
878 } else if (((size_t)status) >= (ret_len - offset)) { \
882 offset += ((size_t)status); \
885 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
887 for (size_t i = 0; i < ds->ds_num; i++) {
888 if (ds->ds[i].type == DS_TYPE_GAUGE)
889 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
890 else if (store_rates) {
892 rates = uc_get_rate(ds, vl);
894 WARNING("format_values: uc_get_rate failed.");
897 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
898 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
899 BUFFER_ADD(":%llu", vl->values[i].counter);
900 else if (ds->ds[i].type == DS_TYPE_DERIVE)
901 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
902 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
903 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
905 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
909 } /* for ds->ds_num */
915 } /* }}} int format_values */
917 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
918 char **ret_plugin_instance, char **ret_type,
919 char **ret_type_instance) {
920 char *hostname = NULL;
922 char *plugin_instance = NULL;
924 char *type_instance = NULL;
927 if (hostname == NULL)
930 plugin = strchr(hostname, '/');
936 type = strchr(plugin, '/');
942 plugin_instance = strchr(plugin, '-');
943 if (plugin_instance != NULL) {
944 *plugin_instance = '\0';
948 type_instance = strchr(type, '-');
949 if (type_instance != NULL) {
950 *type_instance = '\0';
954 *ret_host = hostname;
955 *ret_plugin = plugin;
956 *ret_plugin_instance = plugin_instance;
958 *ret_type_instance = type_instance;
960 } /* int parse_identifier */
962 int parse_identifier_vl(const char *str, value_list_t *vl) /* {{{ */
964 char str_copy[6 * DATA_MAX_NAME_LEN];
967 char *plugin_instance = NULL;
969 char *type_instance = NULL;
972 if ((str == NULL) || (vl == NULL))
975 sstrncpy(str_copy, str, sizeof(str_copy));
977 status = parse_identifier(str_copy, &host, &plugin, &plugin_instance, &type,
982 sstrncpy(vl->host, host, sizeof(vl->host));
983 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
984 sstrncpy(vl->plugin_instance,
985 (plugin_instance != NULL) ? plugin_instance : "",
986 sizeof(vl->plugin_instance));
987 sstrncpy(vl->type, type, sizeof(vl->type));
988 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
989 sizeof(vl->type_instance));
992 } /* }}} int parse_identifier_vl */
994 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
999 if (value_orig == NULL)
1002 value = strdup(value_orig);
1005 value_len = strlen(value);
1007 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1008 value[value_len - 1] = 0;
1013 case DS_TYPE_COUNTER:
1014 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1018 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1021 case DS_TYPE_DERIVE:
1022 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1025 case DS_TYPE_ABSOLUTE:
1026 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1031 ERROR("parse_value: Invalid data source type: %i.", ds_type);
1035 if (value == endptr) {
1036 ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1037 DS_TYPE_TO_STRING(ds_type), value);
1040 } else if ((NULL != endptr) && ('\0' != *endptr))
1041 INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1042 "Input string was \"%s\".",
1043 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1047 } /* int parse_value */
1049 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1055 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1062 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1065 if (i >= vl->values_len) {
1066 /* Make sure i is invalid. */
1071 if (vl->time == 0) {
1072 if (strcmp("N", ptr) == 0)
1073 vl->time = cdtime();
1075 char *endptr = NULL;
1079 tmp = strtod(ptr, &endptr);
1080 if ((errno != 0) /* Overflow */
1081 || (endptr == ptr) /* Invalid string */
1082 || (endptr == NULL) /* This should not happen */
1083 || (*endptr != 0)) /* Trailing chars */
1086 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1092 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1093 vl->values[i].gauge = NAN;
1094 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1098 } /* while (strtok_r) */
1100 if ((ptr != NULL) || (i == 0))
1103 } /* int parse_values */
1105 #if !HAVE_GETPWNAM_R
1106 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1107 struct passwd **pwbufp) {
1111 memset(pwbuf, '\0', sizeof(struct passwd));
1113 pthread_mutex_lock(&getpwnam_r_lock);
1116 pw = getpwnam(name);
1118 status = (errno != 0) ? errno : ENOENT;
1122 #define GETPWNAM_COPY_MEMBER(member) \
1123 if (pw->member != NULL) { \
1124 int len = strlen(pw->member); \
1125 if (len >= buflen) { \
1129 sstrncpy(buf, pw->member, buflen); \
1130 pwbuf->member = buf; \
1132 buflen -= (len + 1); \
1134 GETPWNAM_COPY_MEMBER(pw_name);
1135 GETPWNAM_COPY_MEMBER(pw_passwd);
1136 GETPWNAM_COPY_MEMBER(pw_gecos);
1137 GETPWNAM_COPY_MEMBER(pw_dir);
1138 GETPWNAM_COPY_MEMBER(pw_shell);
1140 pwbuf->pw_uid = pw->pw_uid;
1141 pwbuf->pw_gid = pw->pw_gid;
1147 pthread_mutex_unlock(&getpwnam_r_lock);
1150 } /* int getpwnam_r */
1151 #endif /* !HAVE_GETPWNAM_R */
1153 int notification_init(notification_t *n, int severity, const char *message,
1154 const char *host, const char *plugin,
1155 const char *plugin_instance, const char *type,
1156 const char *type_instance) {
1157 memset(n, '\0', sizeof(notification_t));
1159 n->severity = severity;
1161 if (message != NULL)
1162 sstrncpy(n->message, message, sizeof(n->message));
1164 sstrncpy(n->host, host, sizeof(n->host));
1166 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1167 if (plugin_instance != NULL)
1168 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1170 sstrncpy(n->type, type, sizeof(n->type));
1171 if (type_instance != NULL)
1172 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1175 } /* int notification_init */
1177 int walk_directory(const char *dir, dirwalk_callback_f callback,
1178 void *user_data, int include_hidden) {
1187 if ((dh = opendir(dir)) == NULL) {
1189 ERROR("walk_directory: Cannot open '%s': %s", dir,
1190 sstrerror(errno, errbuf, sizeof(errbuf)));
1194 while ((ent = readdir(dh)) != NULL) {
1197 if (include_hidden) {
1198 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1200 } else /* if (!include_hidden) */
1202 if (ent->d_name[0] == '.')
1206 status = (*callback)(dir, ent->d_name, user_data);
1215 if ((success == 0) && (failure > 0))
1220 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1224 fh = fopen(filename, "r");
1228 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1229 if ((ret == 0) && (ferror(fh) != 0)) {
1230 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1238 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1241 if (old_value > new_value) {
1242 if (old_value <= 4294967295U)
1243 diff = (4294967295U - old_value) + new_value + 1;
1245 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1247 diff = new_value - old_value;
1251 } /* counter_t counter_diff */
1253 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1254 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1255 gauge_t delta_gauge;
1258 if (ds_type == DS_TYPE_GAUGE) {
1259 state->last_value.gauge = rate;
1260 state->last_time = t;
1262 *ret_value = state->last_value;
1266 /* Counter and absolute can't handle negative rates. Reset "last time"
1267 * to zero, so that the next valid rate will re-initialize the
1270 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1271 memset(state, 0, sizeof(*state));
1275 /* Another invalid state: The time is not increasing. */
1276 if (t <= state->last_time) {
1277 memset(state, 0, sizeof(*state));
1281 delta_t = t - state->last_time;
1282 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1284 /* Previous value is invalid. */
1285 if (state->last_time == 0) /* {{{ */
1287 if (ds_type == DS_TYPE_DERIVE) {
1288 state->last_value.derive = (derive_t)rate;
1289 state->residual = rate - ((gauge_t)state->last_value.derive);
1290 } else if (ds_type == DS_TYPE_COUNTER) {
1291 state->last_value.counter = (counter_t)rate;
1292 state->residual = rate - ((gauge_t)state->last_value.counter);
1293 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1294 state->last_value.absolute = (absolute_t)rate;
1295 state->residual = rate - ((gauge_t)state->last_value.absolute);
1300 state->last_time = t;
1304 if (ds_type == DS_TYPE_DERIVE) {
1305 derive_t delta_derive = (derive_t)delta_gauge;
1307 state->last_value.derive += delta_derive;
1308 state->residual = delta_gauge - ((gauge_t)delta_derive);
1309 } else if (ds_type == DS_TYPE_COUNTER) {
1310 counter_t delta_counter = (counter_t)delta_gauge;
1312 state->last_value.counter += delta_counter;
1313 state->residual = delta_gauge - ((gauge_t)delta_counter);
1314 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1315 absolute_t delta_absolute = (absolute_t)delta_gauge;
1317 state->last_value.absolute = delta_absolute;
1318 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1323 state->last_time = t;
1324 *ret_value = state->last_value;
1326 } /* }}} value_t rate_to_value */
1328 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1329 value_t value, int ds_type, cdtime_t t,
1330 value_to_rate_state_t *state) {
1333 /* Another invalid state: The time is not increasing. */
1334 if (t <= state->last_time) {
1335 memset(state, 0, sizeof(*state));
1339 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1341 /* Previous value is invalid. */
1342 if (state->last_time == 0) {
1343 state->last_value = value;
1344 state->last_time = t;
1349 case DS_TYPE_DERIVE: {
1350 derive_t diff = value.derive - state->last_value.derive;
1351 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1354 case DS_TYPE_GAUGE: {
1355 *ret_rate = value.gauge;
1358 case DS_TYPE_COUNTER: {
1359 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1360 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1363 case DS_TYPE_ABSOLUTE: {
1364 absolute_t diff = value.absolute;
1365 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1372 state->last_value = value;
1373 state->last_time = t;
1375 } /* }}} value_t rate_to_value */
1377 int service_name_to_port_number(const char *service_name) {
1378 struct addrinfo *ai_list;
1382 if (service_name == NULL)
1385 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1387 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1389 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1390 gai_strerror(status));
1394 service_number = -1;
1395 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1396 ai_ptr = ai_ptr->ai_next) {
1397 if (ai_ptr->ai_family == AF_INET) {
1398 struct sockaddr_in *sa;
1400 sa = (void *)ai_ptr->ai_addr;
1401 service_number = (int)ntohs(sa->sin_port);
1402 } else if (ai_ptr->ai_family == AF_INET6) {
1403 struct sockaddr_in6 *sa;
1405 sa = (void *)ai_ptr->ai_addr;
1406 service_number = (int)ntohs(sa->sin6_port);
1409 if ((service_number > 0) && (service_number <= 65535))
1413 freeaddrinfo(ai_list);
1415 if ((service_number > 0) && (service_number <= 65535))
1416 return (service_number);
1418 } /* int service_name_to_port_number */
1420 void set_sock_opts(int sockfd) /* {{{ */
1425 socklen_t socklen = sizeof(socklen_t);
1426 int so_keepalive = 1;
1428 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype, &socklen);
1430 WARNING("set_sock_opts: failed to determine socket type");
1434 if (socktype == SOCK_STREAM) {
1435 status = setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &so_keepalive,
1436 sizeof(so_keepalive));
1438 WARNING("set_sock_opts: failed to set socket keepalive flag");
1441 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1442 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1443 sizeof(tcp_keepidle));
1445 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1448 #ifdef TCP_KEEPINTVL
1450 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1451 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1452 sizeof(tcp_keepintvl));
1454 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1457 } /* }}} void set_sock_opts */
1459 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1464 if ((string == NULL) || (ret_value == NULL))
1469 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1470 if ((endptr == string) || (errno != 0))
1475 } /* }}} int strtoderive */
1477 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1480 char *endptr = NULL;
1482 if ((string == NULL) || (ret_value == NULL))
1487 tmp = (gauge_t)strtod(string, &endptr);
1490 else if ((endptr == NULL) || (*endptr != 0))
1495 } /* }}} int strtogauge */
1497 int strarray_add(char ***ret_array, size_t *ret_array_len,
1498 char const *str) /* {{{ */
1501 size_t array_len = *ret_array_len;
1506 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1511 array[array_len] = strdup(str);
1512 if (array[array_len] == NULL)
1516 *ret_array_len = array_len;
1518 } /* }}} int strarray_add */
1520 void strarray_free(char **array, size_t array_len) /* {{{ */
1522 for (size_t i = 0; i < array_len; i++)
1525 } /* }}} void strarray_free */
1528 int check_capability(int arg) /* {{{ */
1530 cap_value_t cap = (cap_value_t)arg;
1532 if (!CAP_IS_SUPPORTED(cap))
1535 int have_cap = cap_get_bound(cap);
1540 } /* }}} int check_capability */
1542 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1544 WARNING("check_capability: unsupported capability implementation. "
1545 "Some plugin(s) may require elevated privileges to work properly.");
1547 } /* }}} int check_capability */
1548 #endif /* HAVE_CAPABILITY */