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 int 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. ", fd);
237 assert((0 > status) || (nleft >= (size_t)status));
239 nleft = nleft - ((size_t)status);
240 ptr = ptr + ((size_t)status);
246 int swrite(int fd, const void *buf, size_t count) {
252 ptr = (const char *)buf;
260 /* checking for closed peer connection */
262 pfd.events = POLLIN | POLLHUP;
264 if (poll(&pfd, 1, 0) > 0) {
266 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
267 /* if recv returns zero (even though poll() said there is data to be
268 * read), that means the connection has been closed */
275 status = write(fd, (const void *)ptr, nleft);
277 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
281 return errno ? errno : status;
283 nleft = nleft - ((size_t)status);
284 ptr = ptr + ((size_t)status);
290 int strsplit(char *string, char **fields, size_t size) {
298 while ((fields[i] = strtok_r(ptr, " \t\r\n", &saveptr)) != NULL) {
309 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
315 size_t buffer_req = 0;
317 if (((fields_num != 0) && (fields == NULL)) ||
318 ((buffer_size != 0) && (buffer == NULL)))
324 if (buffer_size != 0)
325 avail = buffer_size - 1;
328 sep_len = strlen(sep);
330 for (size_t i = 0; i < fields_num; i++) {
331 size_t field_len = strlen(fields[i]);
334 buffer_req += sep_len;
335 buffer_req += field_len;
337 if ((i != 0) && (sep_len > 0)) {
338 if (sep_len >= avail) {
339 /* prevent subsequent iterations from writing to the
345 memcpy(ptr, sep, sep_len);
351 if (field_len > avail)
354 memcpy(ptr, fields[i], field_len);
362 return (int)buffer_req;
365 int escape_string(char *buffer, size_t buffer_size) {
369 /* Check if we need to escape at all first */
370 temp = strpbrk(buffer, " \t\"\\");
377 temp = calloc(1, buffer_size);
384 for (size_t i = 0; i < buffer_size; i++) {
385 if (buffer[i] == 0) {
387 } else if ((buffer[i] == '"') || (buffer[i] == '\\')) {
388 if (j > (buffer_size - 4))
391 temp[j + 1] = buffer[i];
394 if (j > (buffer_size - 3))
401 assert((j + 1) < buffer_size);
405 sstrncpy(buffer, temp, buffer_size);
408 } /* int escape_string */
410 int strunescape(char *buf, size_t buf_len) {
411 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i) {
415 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
416 ERROR("string unescape: backslash found at end of string.");
417 /* Ensure null-byte at the end of the buffer. */
422 switch (buf[i + 1]) {
437 /* Move everything after the position one position to the left.
438 * Add a null-byte as last character in the buffer. */
439 memmove(buf + i + 1, buf + i + 2, buf_len - i - 2);
440 buf[buf_len - 1] = 0;
443 } /* int strunescape */
445 size_t strstripnewline(char *buffer) {
446 size_t buffer_len = strlen(buffer);
448 while (buffer_len > 0) {
449 if ((buffer[buffer_len - 1] != '\n') && (buffer[buffer_len - 1] != '\r'))
452 buffer[buffer_len] = 0;
456 } /* size_t strstripnewline */
458 int escape_slashes(char *buffer, size_t buffer_size) {
461 buffer_len = strlen(buffer);
463 if (buffer_len <= 1) {
464 if (strcmp("/", buffer) == 0) {
467 sstrncpy(buffer, "root", buffer_size);
472 /* Move one to the left */
473 if (buffer[0] == '/') {
474 memmove(buffer, buffer + 1, buffer_len);
478 for (size_t i = 0; i < buffer_len; i++) {
479 if (buffer[i] == '/')
484 } /* int escape_slashes */
486 void replace_special(char *buffer, size_t buffer_size) {
487 for (size_t i = 0; i < buffer_size; i++) {
490 if ((!isalnum((int)buffer[i])) && (buffer[i] != '-'))
493 } /* void replace_special */
495 int timeval_cmp(struct timeval tv0, struct timeval tv1, struct timeval *delta) {
496 struct timeval *larger;
497 struct timeval *smaller;
501 NORMALIZE_TIMEVAL(tv0);
502 NORMALIZE_TIMEVAL(tv1);
504 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec)) {
512 if ((tv0.tv_sec < tv1.tv_sec) ||
513 ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec))) {
524 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
526 if (smaller->tv_usec <= larger->tv_usec)
527 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
530 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
534 assert((delta == NULL) ||
535 ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
538 } /* int timeval_cmp */
540 int check_create_dir(const char *file_orig) {
550 int last_is_file = 1;
551 int path_is_absolute = 0;
555 * Sanity checks first
557 if (file_orig == NULL)
560 if ((len = strlen(file_orig)) < 1)
562 else if (len >= sizeof(file_copy))
566 * If `file_orig' ends in a slash the last component is a directory,
567 * otherwise it's a file. Act accordingly..
569 if (file_orig[len - 1] == '/')
571 if (file_orig[0] == '/')
572 path_is_absolute = 1;
575 * Create a copy for `strtok_r' to destroy
577 sstrncpy(file_copy, file_orig, sizeof(file_copy));
580 * Break into components. This will eat up several slashes in a row and
581 * remove leading and trailing slashes..
586 while ((fields[fields_num] = strtok_r(ptr, "/", &saveptr)) != NULL) {
590 if (fields_num >= 16)
595 * For each component, do..
597 for (int i = 0; i < (fields_num - last_is_file); i++) {
599 * Do not create directories that start with a dot. This
600 * prevents `../../' attacks and other likely malicious
603 if (fields[i][0] == '.') {
604 ERROR("Cowardly refusing to create a directory that "
605 "begins with a `.' (dot): `%s'",
611 * Join the components together again
614 if (strjoin(dir + path_is_absolute, (size_t)(dir_len - path_is_absolute),
615 fields, (size_t)(i + 1), "/") < 0) {
616 ERROR("strjoin failed: `%s', component #%i", file_orig, i);
621 if ((stat(dir, &statbuf) == -1) && (lstat(dir, &statbuf) == -1)) {
622 if (errno == ENOENT) {
623 if (mkdir(dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
626 /* this might happen, if a different thread created
627 * the directory in the meantime
628 * => call stat() again to check for S_ISDIR() */
632 ERROR("check_create_dir: mkdir (%s): %s", dir, STRERRNO);
635 ERROR("check_create_dir: stat (%s): %s", dir, STRERRNO);
638 } else if (!S_ISDIR(statbuf.st_mode)) {
639 ERROR("check_create_dir: `%s' exists but is not "
649 } /* check_create_dir */
652 int get_kstat(kstat_t **ksp_ptr, char *module, int instance, char *name) {
660 snprintf(ident, sizeof(ident), "%s,%i,%s", module, instance, name);
662 *ksp_ptr = kstat_lookup(kc, module, instance, name);
663 if (*ksp_ptr == NULL) {
664 ERROR("get_kstat: Cound not find kstat %s", ident);
668 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
669 ERROR("get_kstat: kstat %s has wrong type", ident);
675 assert(*ksp_ptr != NULL);
676 assert((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
679 if (kstat_read(kc, *ksp_ptr, NULL) == -1) {
680 ERROR("get_kstat: kstat %s could not be read", ident);
684 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED) {
685 ERROR("get_kstat: kstat %s has wrong type", ident);
692 long long get_kstat_value(kstat_t *ksp, char *name) {
694 long long retval = -1LL;
697 ERROR("get_kstat_value (\"%s\"): ksp is NULL.", name);
699 } else if (ksp->ks_type != KSTAT_TYPE_NAMED) {
700 ERROR("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
701 "is not KSTAT_TYPE_NAMED (%#x).",
702 name, (unsigned int)ksp->ks_type, (unsigned int)KSTAT_TYPE_NAMED);
706 if ((kn = (kstat_named_t *)kstat_data_lookup(ksp, name)) == NULL)
709 if (kn->data_type == KSTAT_DATA_INT32)
710 retval = (long long)kn->value.i32;
711 else if (kn->data_type == KSTAT_DATA_UINT32)
712 retval = (long long)kn->value.ui32;
713 else if (kn->data_type == KSTAT_DATA_INT64)
715 (long long)kn->value.i64; /* According to ANSI C99 `long long' must hold
717 else if (kn->data_type == KSTAT_DATA_UINT64)
718 retval = (long long)kn->value.ui64; /* XXX: Might overflow! */
720 WARNING("get_kstat_value: Not a numeric value: %s", name);
724 #endif /* HAVE_LIBKSTAT */
727 unsigned long long ntohll(unsigned long long n) {
728 #if BYTE_ORDER == BIG_ENDIAN
731 return (((unsigned long long)ntohl(n)) << 32) + ntohl(n >> 32);
733 } /* unsigned long long ntohll */
735 unsigned long long htonll(unsigned long long n) {
736 #if BYTE_ORDER == BIG_ENDIAN
739 return (((unsigned long long)htonl(n)) << 32) + htonl(n >> 32);
741 } /* unsigned long long htonll */
742 #endif /* HAVE_HTONLL */
744 #if FP_LAYOUT_NEED_NOTHING
745 /* Well, we need nothing.. */
746 /* #endif FP_LAYOUT_NEED_NOTHING */
748 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
749 #if FP_LAYOUT_NEED_ENDIANFLIP
750 #define FP_CONVERT(A) \
751 ((((uint64_t)(A)&0xff00000000000000LL) >> 56) | \
752 (((uint64_t)(A)&0x00ff000000000000LL) >> 40) | \
753 (((uint64_t)(A)&0x0000ff0000000000LL) >> 24) | \
754 (((uint64_t)(A)&0x000000ff00000000LL) >> 8) | \
755 (((uint64_t)(A)&0x00000000ff000000LL) << 8) | \
756 (((uint64_t)(A)&0x0000000000ff0000LL) << 24) | \
757 (((uint64_t)(A)&0x000000000000ff00LL) << 40) | \
758 (((uint64_t)(A)&0x00000000000000ffLL) << 56))
760 #define FP_CONVERT(A) \
761 ((((uint64_t)(A)&0xffffffff00000000LL) >> 32) | \
762 (((uint64_t)(A)&0x00000000ffffffffLL) << 32))
765 double ntohd(double d) {
774 /* NAN in x86 byte order */
775 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00) && (ret.byte[2] == 0x00) &&
776 (ret.byte[3] == 0x00) && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00) &&
777 (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f)) {
783 ret.integer = FP_CONVERT(tmp);
788 double htond(double d) {
796 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
797 ret.byte[4] = ret.byte[5] = 0x00;
805 tmp = FP_CONVERT(ret.integer);
810 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
812 int format_name(char *ret, int ret_len, const char *hostname,
813 const char *plugin, const char *plugin_instance,
814 const char *type, const char *type_instance) {
819 buffer_size = (size_t)ret_len;
821 #define APPEND(str) \
823 size_t l = strlen(str); \
824 if (l >= buffer_size) \
826 memcpy(buffer, (str), l); \
831 assert(plugin != NULL);
832 assert(type != NULL);
837 if ((plugin_instance != NULL) && (plugin_instance[0] != 0)) {
839 APPEND(plugin_instance);
843 if ((type_instance != NULL) && (type_instance[0] != 0)) {
845 APPEND(type_instance);
847 assert(buffer_size > 0);
852 } /* int format_name */
854 int format_values(char *ret, size_t ret_len, /* {{{ */
855 const data_set_t *ds, const value_list_t *vl,
859 gauge_t *rates = NULL;
861 assert(0 == strcmp(ds->type, vl->type));
863 memset(ret, 0, ret_len);
865 #define BUFFER_ADD(...) \
867 status = snprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
871 } else if (((size_t)status) >= (ret_len - offset)) { \
875 offset += ((size_t)status); \
878 BUFFER_ADD("%.3f", CDTIME_T_TO_DOUBLE(vl->time));
880 for (size_t i = 0; i < ds->ds_num; i++) {
881 if (ds->ds[i].type == DS_TYPE_GAUGE)
882 BUFFER_ADD(":" GAUGE_FORMAT, vl->values[i].gauge);
883 else if (store_rates) {
885 rates = uc_get_rate(ds, vl);
887 WARNING("format_values: uc_get_rate failed.");
890 BUFFER_ADD(":" GAUGE_FORMAT, rates[i]);
891 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
892 BUFFER_ADD(":%llu", vl->values[i].counter);
893 else if (ds->ds[i].type == DS_TYPE_DERIVE)
894 BUFFER_ADD(":%" PRIi64, vl->values[i].derive);
895 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
896 BUFFER_ADD(":%" PRIu64, vl->values[i].absolute);
898 ERROR("format_values: Unknown data source type: %i", ds->ds[i].type);
902 } /* for ds->ds_num */
908 } /* }}} int format_values */
910 int parse_identifier(char *str, char **ret_host, char **ret_plugin,
911 char **ret_plugin_instance, char **ret_type,
912 char **ret_type_instance, char *default_host) {
913 char *hostname = NULL;
915 char *plugin_instance = NULL;
917 char *type_instance = NULL;
920 if (hostname == NULL)
923 plugin = strchr(hostname, '/');
929 type = strchr(plugin, '/');
931 if (default_host == NULL)
933 /* else: no host specified; use default */
936 hostname = default_host;
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,
979 /* default_host = */ NULL);
983 sstrncpy(vl->host, host, sizeof(vl->host));
984 sstrncpy(vl->plugin, plugin, sizeof(vl->plugin));
985 sstrncpy(vl->plugin_instance,
986 (plugin_instance != NULL) ? plugin_instance : "",
987 sizeof(vl->plugin_instance));
988 sstrncpy(vl->type, type, sizeof(vl->type));
989 sstrncpy(vl->type_instance, (type_instance != NULL) ? type_instance : "",
990 sizeof(vl->type_instance));
993 } /* }}} int parse_identifier_vl */
995 int parse_value(const char *value_orig, value_t *ret_value, int ds_type) {
1000 if (value_orig == NULL)
1003 value = strdup(value_orig);
1006 value_len = strlen(value);
1008 while ((value_len > 0) && isspace((int)value[value_len - 1])) {
1009 value[value_len - 1] = 0;
1014 case DS_TYPE_COUNTER:
1015 ret_value->counter = (counter_t)strtoull(value, &endptr, 0);
1019 ret_value->gauge = (gauge_t)strtod(value, &endptr);
1022 case DS_TYPE_DERIVE:
1023 ret_value->derive = (derive_t)strtoll(value, &endptr, 0);
1026 case DS_TYPE_ABSOLUTE:
1027 ret_value->absolute = (absolute_t)strtoull(value, &endptr, 0);
1032 ERROR("parse_value: Invalid data source type: %i.", ds_type);
1036 if (value == endptr) {
1037 ERROR("parse_value: Failed to parse string as %s: \"%s\".",
1038 DS_TYPE_TO_STRING(ds_type), value);
1041 } else if ((NULL != endptr) && ('\0' != *endptr))
1042 INFO("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1043 "Input string was \"%s\".",
1044 endptr, DS_TYPE_TO_STRING(ds_type), value_orig);
1048 } /* int parse_value */
1050 int parse_values(char *buffer, value_list_t *vl, const data_set_t *ds) {
1056 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1063 while ((ptr = strtok_r(dummy, ":", &saveptr)) != NULL) {
1066 if (i >= vl->values_len) {
1067 /* Make sure i is invalid. */
1072 if (vl->time == 0) {
1073 if (strcmp("N", ptr) == 0)
1074 vl->time = cdtime();
1076 char *endptr = NULL;
1080 tmp = strtod(ptr, &endptr);
1081 if ((errno != 0) /* Overflow */
1082 || (endptr == ptr) /* Invalid string */
1083 || (endptr == NULL) /* This should not happen */
1084 || (*endptr != 0)) /* Trailing chars */
1087 vl->time = DOUBLE_TO_CDTIME_T(tmp);
1093 if ((strcmp("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1094 vl->values[i].gauge = NAN;
1095 else if (0 != parse_value(ptr, &vl->values[i], ds->ds[i].type))
1099 } /* while (strtok_r) */
1101 if ((ptr != NULL) || (i == 0))
1104 } /* int parse_values */
1106 int parse_value_file(char const *path, value_t *ret_value, int ds_type) {
1110 fh = fopen(path, "r");
1114 if (fgets(buffer, sizeof(buffer), fh) == NULL) {
1121 strstripnewline(buffer);
1123 return parse_value(buffer, ret_value, ds_type);
1124 } /* int parse_value_file */
1126 #if !HAVE_GETPWNAM_R
1127 int getpwnam_r(const char *name, struct passwd *pwbuf, char *buf, size_t buflen,
1128 struct passwd **pwbufp) {
1132 memset(pwbuf, '\0', sizeof(struct passwd));
1134 pthread_mutex_lock(&getpwnam_r_lock);
1137 pw = getpwnam(name);
1139 status = (errno != 0) ? errno : ENOENT;
1143 #define GETPWNAM_COPY_MEMBER(member) \
1144 if (pw->member != NULL) { \
1145 int len = strlen(pw->member); \
1146 if (len >= buflen) { \
1150 sstrncpy(buf, pw->member, buflen); \
1151 pwbuf->member = buf; \
1153 buflen -= (len + 1); \
1155 GETPWNAM_COPY_MEMBER(pw_name);
1156 GETPWNAM_COPY_MEMBER(pw_passwd);
1157 GETPWNAM_COPY_MEMBER(pw_gecos);
1158 GETPWNAM_COPY_MEMBER(pw_dir);
1159 GETPWNAM_COPY_MEMBER(pw_shell);
1161 pwbuf->pw_uid = pw->pw_uid;
1162 pwbuf->pw_gid = pw->pw_gid;
1168 pthread_mutex_unlock(&getpwnam_r_lock);
1171 } /* int getpwnam_r */
1172 #endif /* !HAVE_GETPWNAM_R */
1174 int notification_init(notification_t *n, int severity, const char *message,
1175 const char *host, const char *plugin,
1176 const char *plugin_instance, const char *type,
1177 const char *type_instance) {
1178 memset(n, '\0', sizeof(notification_t));
1180 n->severity = severity;
1182 if (message != NULL)
1183 sstrncpy(n->message, message, sizeof(n->message));
1185 sstrncpy(n->host, host, sizeof(n->host));
1187 sstrncpy(n->plugin, plugin, sizeof(n->plugin));
1188 if (plugin_instance != NULL)
1189 sstrncpy(n->plugin_instance, plugin_instance, sizeof(n->plugin_instance));
1191 sstrncpy(n->type, type, sizeof(n->type));
1192 if (type_instance != NULL)
1193 sstrncpy(n->type_instance, type_instance, sizeof(n->type_instance));
1196 } /* int notification_init */
1198 int walk_directory(const char *dir, dirwalk_callback_f callback,
1199 void *user_data, int include_hidden) {
1208 if ((dh = opendir(dir)) == NULL) {
1209 ERROR("walk_directory: Cannot open '%s': %s", dir, STRERRNO);
1213 while ((ent = readdir(dh)) != NULL) {
1216 if (include_hidden) {
1217 if ((strcmp(".", ent->d_name) == 0) || (strcmp("..", ent->d_name) == 0))
1219 } else /* if (!include_hidden) */
1221 if (ent->d_name[0] == '.')
1225 status = (*callback)(dir, ent->d_name, user_data);
1234 if ((success == 0) && (failure > 0))
1239 ssize_t read_file_contents(const char *filename, char *buf, size_t bufsize) {
1243 fh = fopen(filename, "r");
1247 ret = (ssize_t)fread(buf, 1, bufsize, fh);
1248 if ((ret == 0) && (ferror(fh) != 0)) {
1249 ERROR("read_file_contents: Reading file \"%s\" failed.", filename);
1257 counter_t counter_diff(counter_t old_value, counter_t new_value) {
1260 if (old_value > new_value) {
1261 if (old_value <= 4294967295U)
1262 diff = (4294967295U - old_value) + new_value + 1;
1264 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1266 diff = new_value - old_value;
1270 } /* counter_t counter_diff */
1272 int rate_to_value(value_t *ret_value, gauge_t rate, /* {{{ */
1273 rate_to_value_state_t *state, int ds_type, cdtime_t t) {
1274 gauge_t delta_gauge;
1277 if (ds_type == DS_TYPE_GAUGE) {
1278 state->last_value.gauge = rate;
1279 state->last_time = t;
1281 *ret_value = state->last_value;
1285 /* Counter and absolute can't handle negative rates. Reset "last time"
1286 * to zero, so that the next valid rate will re-initialize the
1289 ((ds_type == DS_TYPE_COUNTER) || (ds_type == DS_TYPE_ABSOLUTE))) {
1290 memset(state, 0, sizeof(*state));
1294 /* Another invalid state: The time is not increasing. */
1295 if (t <= state->last_time) {
1296 memset(state, 0, sizeof(*state));
1300 delta_t = t - state->last_time;
1301 delta_gauge = (rate * CDTIME_T_TO_DOUBLE(delta_t)) + state->residual;
1303 /* Previous value is invalid. */
1304 if (state->last_time == 0) /* {{{ */
1306 if (ds_type == DS_TYPE_DERIVE) {
1307 state->last_value.derive = (derive_t)rate;
1308 state->residual = rate - ((gauge_t)state->last_value.derive);
1309 } else if (ds_type == DS_TYPE_COUNTER) {
1310 state->last_value.counter = (counter_t)rate;
1311 state->residual = rate - ((gauge_t)state->last_value.counter);
1312 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1313 state->last_value.absolute = (absolute_t)rate;
1314 state->residual = rate - ((gauge_t)state->last_value.absolute);
1319 state->last_time = t;
1323 if (ds_type == DS_TYPE_DERIVE) {
1324 derive_t delta_derive = (derive_t)delta_gauge;
1326 state->last_value.derive += delta_derive;
1327 state->residual = delta_gauge - ((gauge_t)delta_derive);
1328 } else if (ds_type == DS_TYPE_COUNTER) {
1329 counter_t delta_counter = (counter_t)delta_gauge;
1331 state->last_value.counter += delta_counter;
1332 state->residual = delta_gauge - ((gauge_t)delta_counter);
1333 } else if (ds_type == DS_TYPE_ABSOLUTE) {
1334 absolute_t delta_absolute = (absolute_t)delta_gauge;
1336 state->last_value.absolute = delta_absolute;
1337 state->residual = delta_gauge - ((gauge_t)delta_absolute);
1342 state->last_time = t;
1343 *ret_value = state->last_value;
1345 } /* }}} value_t rate_to_value */
1347 int value_to_rate(gauge_t *ret_rate, /* {{{ */
1348 value_t value, int ds_type, cdtime_t t,
1349 value_to_rate_state_t *state) {
1352 /* Another invalid state: The time is not increasing. */
1353 if (t <= state->last_time) {
1354 memset(state, 0, sizeof(*state));
1358 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1360 /* Previous value is invalid. */
1361 if (state->last_time == 0) {
1362 state->last_value = value;
1363 state->last_time = t;
1368 case DS_TYPE_DERIVE: {
1369 derive_t diff = value.derive - state->last_value.derive;
1370 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1373 case DS_TYPE_GAUGE: {
1374 *ret_rate = value.gauge;
1377 case DS_TYPE_COUNTER: {
1378 counter_t diff = counter_diff(state->last_value.counter, value.counter);
1379 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1382 case DS_TYPE_ABSOLUTE: {
1383 absolute_t diff = value.absolute;
1384 *ret_rate = ((gauge_t)diff) / ((gauge_t)interval);
1391 state->last_value = value;
1392 state->last_time = t;
1394 } /* }}} value_t rate_to_value */
1396 int service_name_to_port_number(const char *service_name) {
1397 struct addrinfo *ai_list;
1401 if (service_name == NULL)
1404 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC};
1406 status = getaddrinfo(/* node = */ NULL, service_name, &ai_hints, &ai_list);
1408 ERROR("service_name_to_port_number: getaddrinfo failed: %s",
1409 gai_strerror(status));
1413 service_number = -1;
1414 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1415 ai_ptr = ai_ptr->ai_next) {
1416 if (ai_ptr->ai_family == AF_INET) {
1417 struct sockaddr_in *sa;
1419 sa = (void *)ai_ptr->ai_addr;
1420 service_number = (int)ntohs(sa->sin_port);
1421 } else if (ai_ptr->ai_family == AF_INET6) {
1422 struct sockaddr_in6 *sa;
1424 sa = (void *)ai_ptr->ai_addr;
1425 service_number = (int)ntohs(sa->sin6_port);
1428 if ((service_number > 0) && (service_number <= 65535))
1432 freeaddrinfo(ai_list);
1434 if ((service_number > 0) && (service_number <= 65535))
1435 return service_number;
1437 } /* int service_name_to_port_number */
1439 void set_sock_opts(int sockfd) /* {{{ */
1444 status = getsockopt(sockfd, SOL_SOCKET, SO_TYPE, &socktype,
1445 &(socklen_t){sizeof(socktype)});
1447 WARNING("set_sock_opts: failed to determine socket type");
1451 if (socktype == SOCK_STREAM) {
1453 setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, &(int){1}, sizeof(int));
1455 WARNING("set_sock_opts: failed to set socket keepalive flag");
1458 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1459 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE, &tcp_keepidle,
1460 sizeof(tcp_keepidle));
1462 WARNING("set_sock_opts: failed to set socket tcp keepalive time");
1465 #ifdef TCP_KEEPINTVL
1467 ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1468 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL, &tcp_keepintvl,
1469 sizeof(tcp_keepintvl));
1471 WARNING("set_sock_opts: failed to set socket tcp keepalive interval");
1474 } /* }}} void set_sock_opts */
1476 int strtoderive(const char *string, derive_t *ret_value) /* {{{ */
1481 if ((string == NULL) || (ret_value == NULL))
1486 tmp = (derive_t)strtoll(string, &endptr, /* base = */ 0);
1487 if ((endptr == string) || (errno != 0))
1492 } /* }}} int strtoderive */
1494 int strtogauge(const char *string, gauge_t *ret_value) /* {{{ */
1497 char *endptr = NULL;
1499 if ((string == NULL) || (ret_value == NULL))
1504 tmp = (gauge_t)strtod(string, &endptr);
1507 else if ((endptr == NULL) || (*endptr != 0))
1512 } /* }}} int strtogauge */
1514 int strarray_add(char ***ret_array, size_t *ret_array_len,
1515 char const *str) /* {{{ */
1518 size_t array_len = *ret_array_len;
1523 array = realloc(*ret_array, (array_len + 1) * sizeof(*array));
1528 array[array_len] = strdup(str);
1529 if (array[array_len] == NULL)
1533 *ret_array_len = array_len;
1535 } /* }}} int strarray_add */
1537 void strarray_free(char **array, size_t array_len) /* {{{ */
1539 for (size_t i = 0; i < array_len; i++)
1542 } /* }}} void strarray_free */
1545 int check_capability(int arg) /* {{{ */
1547 cap_value_t cap_value = (cap_value_t)arg;
1549 cap_flag_value_t cap_flag_value;
1551 if (!CAP_IS_SUPPORTED(cap_value))
1554 if (!(cap = cap_get_proc())) {
1555 ERROR("check_capability: cap_get_proc failed.");
1559 if (cap_get_flag(cap, cap_value, CAP_EFFECTIVE, &cap_flag_value) < 0) {
1560 ERROR("check_capability: cap_get_flag failed.");
1566 return cap_flag_value != CAP_SET;
1567 } /* }}} int check_capability */
1569 int check_capability(__attribute__((unused)) int arg) /* {{{ */
1571 WARNING("check_capability: unsupported capability implementation. "
1572 "Some plugin(s) may require elevated privileges to work properly.");
1574 } /* }}} int check_capability */
1575 #endif /* HAVE_CAPABILITY */