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>
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 char *ssnprintf_alloc(char const *format, ...) /* {{{ */
93 char static_buffer[1024] = "";
95 size_t alloc_buffer_size;
99 /* Try printing into the static buffer. In many cases it will be
100 * sufficiently large and we can simply return a strdup() of this
102 va_start(ap, format);
103 status = vsnprintf(static_buffer, sizeof(static_buffer), format, ap);
108 /* "status" does not include the null byte. */
109 alloc_buffer_size = (size_t)(status + 1);
110 if (alloc_buffer_size <= sizeof(static_buffer))
111 return strdup(static_buffer);
113 /* Allocate a buffer large enough to hold the string. */
114 alloc_buffer = calloc(1, alloc_buffer_size);
115 if (alloc_buffer == NULL)
118 /* Print again into this new buffer. */
119 va_start(ap, format);
120 status = vsnprintf(alloc_buffer, alloc_buffer_size, format, ap);
128 } /* }}} char *ssnprintf_alloc */
130 char *sstrdup(const char *s) {
137 /* Do not use `strdup' here, because it's not specified in POSIX. It's
138 * ``only'' an XSI extension. */
142 ERROR("sstrdup: Out of memory.");
148 } /* char *sstrdup */
150 /* Even though Posix requires "strerror_r" to return an "int",
151 * some systems (e.g. the GNU libc) return a "char *" _and_
152 * ignore the second argument ... -tokkee */
153 char *sstrerror(int errnum, char *buf, size_t buflen) {
160 pthread_mutex_lock(&strerror_r_lock);
162 temp = strerror(errnum);
163 sstrncpy(buf, temp, buflen);
165 pthread_mutex_unlock(&strerror_r_lock);
167 /* #endif !HAVE_STRERROR_R */
169 #elif STRERROR_R_CHAR_P
172 temp = strerror_r(errnum, buf, buflen);
173 if (buf[0] == '\0') {
174 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
175 sstrncpy(buf, temp, buflen);
177 sstrncpy(buf, "strerror_r did not return "
182 /* #endif STRERROR_R_CHAR_P */
185 if (strerror_r(errnum, buf, buflen) != 0) {
186 snprintf(buf, buflen, "Error #%i; "
187 "Additionally, strerror_r failed.",
190 #endif /* STRERROR_R_CHAR_P */
193 } /* char *sstrerror */
195 void *smalloc(size_t size) {
198 if ((r = malloc(size)) == NULL) {
199 ERROR("Not enough memory.");
204 } /* void *smalloc */
207 void sfree (void **ptr)
219 int sread(int fd, void *buf, size_t count) {
228 status = read(fd, (void *)ptr, nleft);
230 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
237 DEBUG("Received EOF from fd %i. ", fd);
241 assert((0 > status) || (nleft >= (size_t)status));
243 nleft = nleft - ((size_t)status);
244 ptr = ptr + ((size_t)status);
250 int swrite(int fd, const void *buf, size_t count) {
256 ptr = (const char *)buf;
264 /* checking for closed peer connection */
266 pfd.events = POLLIN | POLLHUP;
268 if (poll(&pfd, 1, 0) > 0) {
270 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
271 /* if recv returns zero (even though poll() said there is data to be
272 * read), that means the connection has been closed */
279 status = write(fd, (const void *)ptr, nleft);
281 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
285 return errno ? errno : status;
287 nleft = nleft - ((size_t)status);
288 ptr = ptr + ((size_t)status);
294 int strsplit(char *string, char **fields, size_t size) {
302 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
313 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
319 size_t buffer_req = 0;
321 if (((fields_num != 0) && (fields == NULL)) ||
322 ((buffer_size != 0) && (buffer == NULL)))
328 if (buffer_size != 0)
329 avail = buffer_size - 1;
332 sep_len = strlen(sep);
334 for (size_t i = 0; i < fields_num; i++) {
335 size_t field_len = strlen(fields[i]);
338 buffer_req += sep_len;
339 buffer_req += field_len;
341 if ((i != 0) && (sep_len > 0)) {
342 if (sep_len >= avail) {
343 /* prevent subsequent iterations from writing to the
349 memcpy(ptr, sep, sep_len);
355 if (field_len > avail)
358 memcpy(ptr, fields[i], field_len);
366 return (int)buffer_req;
369 int escape_string(char *buffer, size_t buffer_size) {
373 /* Check if we need to escape at all first */
374 temp = strpbrk(buffer, " \t\"\\");
381 temp = calloc(1, buffer_size);
388 for (size_t i = 0; i < buffer_size; i++) {
389 if (buffer[i] == 0) {
391 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
392 if (j > (buffer_size - 4))
395 temp[j + 1] = buffer[i];
398 if (j > (buffer_size - 3))
405 assert((j + 1) < buffer_size);
409 sstrncpy(buffer, temp, buffer_size);
412 } /* int escape_string */
414 int strunescape(char *buf, size_t buf_len) {
415 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
419 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
420 ERROR("string unescape: backslash found at end of string.");
421 /* Ensure null-byte at the end of the buffer. */
426 switch (buf[i + 1]) {
441 /* Move everything after the position one position to the left.
442 * Add a null-byte as last character in the buffer. */
443 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
444 buf[buf_len - 1] = 0;
447 } /* int strunescape */
449 size_t strstripnewline(char *buffer) {
450 size_t buffer_len = strlen(buffer);
452 while (buffer_len > 0) {
453 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
456 buffer[buffer_len] = 0;
460 } /* size_t strstripnewline */
462 int escape_slashes(char *buffer, size_t buffer_size) {
465 buffer_len = strlen(buffer);
467 if (buffer_len <= 1) {
468 if (strcmp("/", buffer) == 0) {
471 sstrncpy(buffer, "root", buffer_size);
476 /* Move one to the left */
477 if (buffer[0] == '/') {
478 memmove(buffer, buffer + 1, buffer_len);
482 for (size_t i = 0; i < buffer_len; i++) {
483 if (buffer[i] == '/')
488 } /* int escape_slashes */
490 void replace_special(char *buffer, size_t buffer_size) {
491 for (size_t i = 0; i < buffer_size; i++) {
494 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
497 } /* void replace_special */
499 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
500 struct timeval *larger;
501 struct timeval *smaller;
505 NORMALIZE_TIMEVAL(tv0);
506 NORMALIZE_TIMEVAL(tv1);
508 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
516 if ((tv0.tv_sec < tv1.tv_sec) ||
517 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
528 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
530 if (smaller->tv_usec <= larger->tv_usec)
531 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
534 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
538 assert((delta == NULL) ||
539 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
542 } /* int timeval_cmp */
544 int check_create_dir(const char *file_orig) {
547 char file_copy[PATH_MAX];
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)) {
566 ERROR("check_create_dir: name (%s) is too long.", file_orig);
571 * If `file_orig' ends in a slash the last component is a directory,
572 * otherwise it's a file. Act accordingly..
574 if (file_orig[len - 1] == '/')
576 if (file_orig[0] == '/')
577 path_is_absolute = 1;
580 * Create a copy for `strtok_r' to destroy
582 sstrncpy(file_copy, file_orig, sizeof(file_copy));
585 * Break into components. This will eat up several slashes in a row and
586 * remove leading and trailing slashes..
591 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
595 if (fields_num >= 16)
600 * For each component, do..
602 for (int i = 0; i < (fields_num - last_is_file); i++) {
604 * Do not create directories that start with a dot. This
605 * prevents `../../' attacks and other likely malicious
608 if (fields[i][0] == '.') {
609 ERROR("Cowardly refusing to create a directory that "
610 "begins with a `.' (dot): `%s'",
616 * Join the components together again
619 if (strjoin(dir + path_is_absolute,
620 (size_t)(sizeof(dir) - path_is_absolute), fields,
621 (size_t)(i + 1), "/") < 0) {
622 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
627 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
628 if (errno == ENOENT) {
629 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
632 /* this might happen, if a different thread created
633 * the directory in the meantime
634 * => call stat() again to check for S_ISDIR() */
638 ERROR("check_create_dir: mkdir (%s): %s", dir, STRERRNO);
641 ERROR("check_create_dir: stat (%s): %s", dir, STRERRNO);
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(":%" PRIu64, (uint64_t)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) {
1215 ERROR("walk_directory: Cannot open '%s': %s", dir, STRERRNO);
1219 while ((ent = readdir(dh)) != NULL) {
1222 if (include_hidden) {
1223 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1225 } else /* if (!include_hidden) */
1227 if (ent->d_name[0] == '.')
1231 status = (*callback)(dir, ent->d_name, user_data);
1240 if ((success == 0) && (failure > 0))
1245 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1249 fh = fopen(filename, "r");
1253 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1254 if ((ret == 0) && (ferror(fh) != 0)) {
1255 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1263 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1266 if (old_value > new_value) {
1267 if (old_value <= 4294967295U)
1268 diff = (4294967295U - old_value) + new_value + 1;
1270 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1272 diff = new_value - old_value;
1276 } /* counter_t counter_diff */
1278 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1279 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1280 gauge_t delta_gauge;
1283 if (ds_type == DS_TYPE_GAUGE) {
1284 state->last_value.gauge = rate;
1285 state->last_time = t;
1287 *ret_value = state->last_value;
1291 /* Counter and absolute can't handle negative rates. Reset "last time"
1292 * to zero, so that the next valid rate will re-initialize the
1295 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1296 memset(state, 0, sizeof(*state));
1300 /* Another invalid state: The time is not increasing. */
1301 if (t <= state->last_time) {
1302 memset(state, 0, sizeof(*state));
1306 delta_t = t - state->last_time;
1307 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1309 /* Previous value is invalid. */
1310 if (state->last_time == 0) /* {{{ */
1312 if (ds_type == DS_TYPE_DERIVE) {
1313 state->last_value.derive = (derive_t)rate;
1314 state->residual = rate - ((gauge_t)state->last_value.derive);
1315 } else if (ds_type == DS_TYPE_COUNTER) {
1316 state->last_value.counter = (counter_t)rate;
1317 state->residual = rate - ((gauge_t)state->last_value.counter);
1318 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1319 state->last_value.absolute = (absolute_t)rate;
1320 state->residual = rate - ((gauge_t)state->last_value.absolute);
1325 state->last_time = t;
1329 if (ds_type == DS_TYPE_DERIVE) {
1330 derive_t delta_derive = (derive_t)delta_gauge;
1332 state->last_value.derive += delta_derive;
1333 state->residual = delta_gauge - ((gauge_t)delta_derive);
1334 } else if (ds_type == DS_TYPE_COUNTER) {
1335 counter_t delta_counter = (counter_t)delta_gauge;
1337 state->last_value.counter += delta_counter;
1338 state->residual = delta_gauge - ((gauge_t)delta_counter);
1339 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1340 absolute_t delta_absolute = (absolute_t)delta_gauge;
1342 state->last_value.absolute = delta_absolute;
1343 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1348 state->last_time = t;
1349 *ret_value = state->last_value;
1351 } /* }}} value_t rate_to_value */
1353 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1354 value_t value, int ds_type, cdtime_t t,
1355 value_to_rate_state_t *state) {
1358 /* Another invalid state: The time is not increasing. */
1359 if (t <= state->last_time) {
1360 memset(state, 0, sizeof(*state));
1364 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1366 /* Previous value is invalid. */
1367 if (state->last_time == 0) {
1368 state->last_value = value;
1369 state->last_time = t;
1374 case DS_TYPE_DERIVE: {
1375 derive_t diff = value.derive - state->last_value.derive;
1376 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1379 case DS_TYPE_GAUGE: {
1380 *ret_rate = value.gauge;
1383 case DS_TYPE_COUNTER: {
1384 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1385 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1388 case DS_TYPE_ABSOLUTE: {
1389 absolute_t diff = value.absolute;
1390 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1397 state->last_value = value;
1398 state->last_time = t;
1400 } /* }}} value_t rate_to_value */
1402 int service_name_to_port_number(const char *service_name) {
1403 struct addrinfo *ai_list;
1407 if (service_name == NULL)
1410 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1412 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1414 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1415 gai_strerror(status));
1419 service_number = -1;
1420 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1421 ai_ptr = ai_ptr->ai_next) {
1422 if (ai_ptr->ai_family == AF_INET) {
1423 struct sockaddr_in *sa;
1425 sa = (void *)ai_ptr->ai_addr;
1426 service_number = (int)ntohs(sa->sin_port);
1427 } else if (ai_ptr->ai_family == AF_INET6) {
1428 struct sockaddr_in6 *sa;
1430 sa = (void *)ai_ptr->ai_addr;
1431 service_number = (int)ntohs(sa->sin6_port);
1434 if ((service_number > 0) && (service_number <= 65535))
1438 freeaddrinfo(ai_list);
1440 if ((service_number > 0) && (service_number <= 65535))
1441 return service_number;
1443 } /* int service_name_to_port_number */
1445 void set_sock_opts(int sockfd) /* {{{ */
1450 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1451 &(socklen_t){sizeof(socktype)});
1453 WARNING("set_sock_opts: failed to determine socket type");
1457 if (socktype == SOCK_STREAM) {
1459 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1461 WARNING("set_sock_opts: failed to set socket keepalive flag");
1464 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1465 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1466 sizeof(tcp_keepidle));
1468 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1471 #ifdef TCP_KEEPINTVL
1473 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1474 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1475 sizeof(tcp_keepintvl));
1477 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1480 } /* }}} void set_sock_opts */
1482 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1487 if ((string == NULL) || (ret_value == NULL))
1492 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1493 if ((endptr == string) || (errno != 0))
1498 } /* }}} int strtoderive */
1500 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1503 char *endptr = NULL;
1505 if ((string == NULL) || (ret_value == NULL))
1510 tmp = (gauge_t)strtod(string, &endptr);
1513 else if ((endptr == NULL) || (*endptr != 0))
1518 } /* }}} int strtogauge */
1520 int strarray_add(char ***ret_array, size_t *ret_array_len,
1521 char const *str) /* {{{ */
1524 size_t array_len = *ret_array_len;
1529 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1534 array[array_len] = strdup(str);
1535 if (array[array_len] == NULL)
1539 *ret_array_len = array_len;
1541 } /* }}} int strarray_add */
1543 void strarray_free(char **array, size_t array_len) /* {{{ */
1545 for (size_t i = 0; i < array_len; i++)
1548 } /* }}} void strarray_free */
1551 int check_capability(int arg) /* {{{ */
1553 cap_value_t cap_value = (cap_value_t)arg;
1555 cap_flag_value_t cap_flag_value;
1557 if (!CAP_IS_SUPPORTED(cap_value))
1560 if (!(cap = cap_get_proc())) {
1561 ERROR("check_capability: cap_get_proc failed.");
1565 if (cap_get_flag(cap, cap_value, CAP_EFFECTIVE, &cap_flag_value) < 0) {
1566 ERROR("check_capability: cap_get_flag failed.");
1572 return cap_flag_value != CAP_SET;
1573 } /* }}} int check_capability */
1575 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1577 WARNING("check_capability: unsupported capability implementation. "
1578 "Some plugin(s) may require elevated privileges to work properly.");
1580 } /* }}} int check_capability */
1581 #endif /* HAVE_CAPABILITY */