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"
45 #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>
63 #ifdef HAVE_SYS_CAPABILITY_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)
86 strncpy (dest, src, n);
90 } /* char *sstrncpy */
92 int ssnprintf (char *dest, size_t n, const char *format, ...)
97 va_start (ap, format);
98 ret = vsnprintf (dest, n, format, ap);
103 } /* int ssnprintf */
105 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
107 char static_buffer[1024] = "";
109 size_t alloc_buffer_size;
113 /* Try printing into the static buffer. In many cases it will be
114 * sufficiently large and we can simply return a strdup() of this
116 va_start (ap, format);
117 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
122 /* "status" does not include the null byte. */
123 alloc_buffer_size = (size_t) (status + 1);
124 if (alloc_buffer_size <= sizeof (static_buffer))
125 return (strdup (static_buffer));
127 /* Allocate a buffer large enough to hold the string. */
128 alloc_buffer = calloc (1, alloc_buffer_size);
129 if (alloc_buffer == NULL)
132 /* Print again into this new buffer. */
133 va_start (ap, format);
134 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
138 sfree (alloc_buffer);
142 return (alloc_buffer);
143 } /* }}} char *ssnprintf_alloc */
145 char *sstrdup (const char *s)
153 /* Do not use `strdup' here, because it's not specified in POSIX. It's
154 * ``only'' an XSI extension. */
159 ERROR ("sstrdup: Out of memory.");
162 memcpy (r, s, sizeof (char) * sz);
165 } /* char *sstrdup */
167 /* Even though Posix requires "strerror_r" to return an "int",
168 * some systems (e.g. the GNU libc) return a "char *" _and_
169 * ignore the second argument ... -tokkee */
170 char *sstrerror (int errnum, char *buf, size_t buflen)
178 pthread_mutex_lock (&strerror_r_lock);
180 temp = strerror (errnum);
181 sstrncpy (buf, temp, buflen);
183 pthread_mutex_unlock (&strerror_r_lock);
185 /* #endif !HAVE_STRERROR_R */
187 #elif STRERROR_R_CHAR_P
190 temp = strerror_r (errnum, buf, buflen);
193 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
194 sstrncpy (buf, temp, buflen);
196 sstrncpy (buf, "strerror_r did not return "
197 "an error message", buflen);
200 /* #endif STRERROR_R_CHAR_P */
203 if (strerror_r (errnum, buf, buflen) != 0)
205 ssnprintf (buf, buflen, "Error #%i; "
206 "Additionally, strerror_r failed.",
209 #endif /* STRERROR_R_CHAR_P */
212 } /* char *sstrerror */
214 void *smalloc (size_t size)
218 if ((r = malloc (size)) == NULL)
220 ERROR ("Not enough memory.");
225 } /* void *smalloc */
228 void sfree (void **ptr)
240 ssize_t sread (int fd, void *buf, size_t count)
251 status = read (fd, (void *) ptr, nleft);
253 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
261 DEBUG ("Received EOF from fd %i. "
262 "Closing fd and returning error.",
268 assert ((0 > status) || (nleft >= (size_t)status));
270 nleft = nleft - ((size_t) status);
271 ptr = ptr + ((size_t) status);
278 ssize_t swrite (int fd, const void *buf, size_t count)
285 ptr = (const char *) buf;
291 /* checking for closed peer connection */
293 pfd.events = POLLIN | POLLHUP;
295 if (poll(&pfd, 1, 0) > 0) {
297 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
298 // if recv returns zero (even though poll() said there is data to be read),
299 // that means the connection has been closed
306 status = write (fd, (const void *) ptr, nleft);
308 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
314 nleft = nleft - ((size_t) status);
315 ptr = ptr + ((size_t) status);
321 int strsplit (char *string, char **fields, size_t size)
330 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
342 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
348 size_t buffer_req = 0;
350 if (((fields_num != 0) && (fields == NULL)) ||
351 ((buffer_size != 0) && (buffer == NULL)))
357 if (buffer_size != 0)
358 avail = buffer_size - 1;
361 sep_len = strlen(sep);
363 for (size_t i = 0; i < fields_num; i++) {
364 size_t field_len = strlen(fields[i]);
367 buffer_req += sep_len;
368 buffer_req += field_len;
370 if ((i != 0) && (sep_len > 0)) {
371 if (sep_len >= avail) {
372 /* prevent subsequent iterations from writing to the
378 memcpy(ptr, sep, sep_len);
384 if (field_len > avail)
387 memcpy(ptr, fields[i], field_len);
395 return (int)buffer_req;
398 int escape_string (char *buffer, size_t buffer_size)
403 /* Check if we need to escape at all first */
404 temp = strpbrk (buffer, " \t\"\\");
411 temp = calloc (1, buffer_size);
418 for (size_t i = 0; i < buffer_size; i++)
424 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
426 if (j > (buffer_size - 4))
429 temp[j + 1] = buffer[i];
434 if (j > (buffer_size - 3))
441 assert ((j + 1) < buffer_size);
445 sstrncpy (buffer, temp, buffer_size);
448 } /* int escape_string */
450 int strunescape (char *buf, size_t buf_len)
452 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
457 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
458 ERROR ("string unescape: backslash found at end of string.");
459 /* Ensure null-byte at the end of the buffer. */
464 switch (buf[i + 1]) {
479 /* Move everything after the position one position to the left.
480 * Add a null-byte as last character in the buffer. */
481 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
482 buf[buf_len - 1] = 0;
485 } /* int strunescape */
487 size_t strstripnewline (char *buffer)
489 size_t buffer_len = strlen (buffer);
491 while (buffer_len > 0)
493 if ((buffer[buffer_len - 1] != '\n')
494 && (buffer[buffer_len - 1] != '\r'))
497 buffer[buffer_len] = 0;
501 } /* size_t strstripnewline */
503 int escape_slashes (char *buffer, size_t buffer_size)
507 buffer_len = strlen (buffer);
511 if (strcmp ("/", buffer) == 0)
515 sstrncpy (buffer, "root", buffer_size);
520 /* Move one to the left */
521 if (buffer[0] == '/')
523 memmove (buffer, buffer + 1, buffer_len);
527 for (size_t i = 0; i < buffer_len; i++)
529 if (buffer[i] == '/')
534 } /* int escape_slashes */
536 void replace_special (char *buffer, size_t buffer_size)
538 for (size_t i = 0; i < buffer_size; i++)
542 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
545 } /* void replace_special */
547 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
549 struct timeval *larger;
550 struct timeval *smaller;
554 NORMALIZE_TIMEVAL (tv0);
555 NORMALIZE_TIMEVAL (tv1);
557 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
566 if ((tv0.tv_sec < tv1.tv_sec)
567 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
581 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
583 if (smaller->tv_usec <= larger->tv_usec)
584 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
588 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
592 assert ((delta == NULL)
593 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
596 } /* int timeval_cmp */
598 int check_create_dir (const char *file_orig)
609 int last_is_file = 1;
610 int path_is_absolute = 0;
614 * Sanity checks first
616 if (file_orig == NULL)
619 if ((len = strlen (file_orig)) < 1)
621 else if (len >= sizeof (file_copy))
625 * If `file_orig' ends in a slash the last component is a directory,
626 * otherwise it's a file. Act accordingly..
628 if (file_orig[len - 1] == '/')
630 if (file_orig[0] == '/')
631 path_is_absolute = 1;
634 * Create a copy for `strtok_r' to destroy
636 sstrncpy (file_copy, file_orig, sizeof (file_copy));
639 * Break into components. This will eat up several slashes in a row and
640 * remove leading and trailing slashes..
645 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
650 if (fields_num >= 16)
655 * For each component, do..
657 for (int i = 0; i < (fields_num - last_is_file); i++)
660 * Do not create directories that start with a dot. This
661 * prevents `../../' attacks and other likely malicious
664 if (fields[i][0] == '.')
666 ERROR ("Cowardly refusing to create a directory that "
667 "begins with a `.' (dot): `%s'", file_orig);
672 * Join the components together again
675 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
676 fields, (size_t) (i + 1), "/") < 0)
678 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
683 if ((stat (dir, &statbuf) == -1)
684 && (lstat (dir, &statbuf) == -1))
688 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
691 /* this might happen, if a different thread created
692 * the directory in the meantime
693 * => call stat() again to check for S_ISDIR() */
698 ERROR ("check_create_dir: mkdir (%s): %s", dir,
700 errbuf, sizeof (errbuf)));
706 ERROR ("check_create_dir: stat (%s): %s", dir,
707 sstrerror (errno, errbuf,
712 else if (!S_ISDIR (statbuf.st_mode))
714 ERROR ("check_create_dir: `%s' exists but is not "
715 "a directory!", dir);
723 } /* check_create_dir */
726 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
735 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
737 *ksp_ptr = kstat_lookup (kc, module, instance, name);
738 if (*ksp_ptr == NULL)
740 ERROR ("get_kstat: Cound not find kstat %s", ident);
744 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
746 ERROR ("get_kstat: kstat %s has wrong type", ident);
752 assert (*ksp_ptr != NULL);
753 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
756 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
758 ERROR ("get_kstat: kstat %s could not be read", ident);
762 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
764 ERROR ("get_kstat: kstat %s has wrong type", ident);
771 long long get_kstat_value (kstat_t *ksp, char *name)
774 long long retval = -1LL;
778 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
781 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
783 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
784 "is not KSTAT_TYPE_NAMED (%#x).",
786 (unsigned int) ksp->ks_type,
787 (unsigned int) KSTAT_TYPE_NAMED);
791 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
794 if (kn->data_type == KSTAT_DATA_INT32)
795 retval = (long long) kn->value.i32;
796 else if (kn->data_type == KSTAT_DATA_UINT32)
797 retval = (long long) kn->value.ui32;
798 else if (kn->data_type == KSTAT_DATA_INT64)
799 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
800 else if (kn->data_type == KSTAT_DATA_UINT64)
801 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
803 WARNING ("get_kstat_value: Not a numeric value: %s", name);
807 #endif /* HAVE_LIBKSTAT */
810 unsigned long long ntohll (unsigned long long n)
812 #if BYTE_ORDER == BIG_ENDIAN
815 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
817 } /* unsigned long long ntohll */
819 unsigned long long htonll (unsigned long long n)
821 #if BYTE_ORDER == BIG_ENDIAN
824 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
826 } /* unsigned long long htonll */
827 #endif /* HAVE_HTONLL */
829 #if FP_LAYOUT_NEED_NOTHING
830 /* Well, we need nothing.. */
831 /* #endif FP_LAYOUT_NEED_NOTHING */
833 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
834 # if FP_LAYOUT_NEED_ENDIANFLIP
835 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
836 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
837 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
838 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
839 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
840 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
841 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
842 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
844 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
845 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
848 double ntohd (double d)
859 /* NAN in x86 byte order */
860 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
861 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
862 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
863 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
872 ret.integer = FP_CONVERT (tmp);
873 return (ret.floating);
877 double htond (double d)
888 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
889 ret.byte[4] = ret.byte[5] = 0x00;
892 return (ret.floating);
899 tmp = FP_CONVERT (ret.integer);
901 return (ret.floating);
904 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
906 int format_name (char *ret, int ret_len,
907 const char *hostname,
908 const char *plugin, const char *plugin_instance,
909 const char *type, const char *type_instance)
915 buffer_size = (size_t) ret_len;
917 #define APPEND(str) do { \
918 size_t l = strlen (str); \
919 if (l >= buffer_size) \
921 memcpy (buffer, (str), l); \
922 buffer += l; buffer_size -= l; \
925 assert (plugin != NULL);
926 assert (type != NULL);
931 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
934 APPEND (plugin_instance);
938 if ((type_instance != NULL) && (type_instance[0] != 0))
941 APPEND (type_instance);
943 assert (buffer_size > 0);
948 } /* int format_name */
950 int format_values (char *ret, size_t ret_len, /* {{{ */
951 const data_set_t *ds, const value_list_t *vl,
956 gauge_t *rates = NULL;
958 assert (0 == strcmp (ds->type, vl->type));
960 memset (ret, 0, ret_len);
962 #define BUFFER_ADD(...) do { \
963 status = ssnprintf (ret + offset, ret_len - offset, \
970 else if (((size_t) status) >= (ret_len - offset)) \
976 offset += ((size_t) status); \
979 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
981 for (size_t i = 0; i < ds->ds_num; i++)
983 if (ds->ds[i].type == DS_TYPE_GAUGE)
984 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
985 else if (store_rates)
988 rates = uc_get_rate (ds, vl);
991 WARNING ("format_values: uc_get_rate failed.");
994 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
996 else if (ds->ds[i].type == DS_TYPE_COUNTER)
997 BUFFER_ADD (":%llu", vl->values[i].counter);
998 else if (ds->ds[i].type == DS_TYPE_DERIVE)
999 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
1000 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
1001 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
1004 ERROR ("format_values: Unknown data source type: %i",
1009 } /* for ds->ds_num */
1015 } /* }}} int format_values */
1017 int parse_identifier (char *str, char **ret_host,
1018 char **ret_plugin, char **ret_plugin_instance,
1019 char **ret_type, char **ret_type_instance)
1021 char *hostname = NULL;
1022 char *plugin = NULL;
1023 char *plugin_instance = NULL;
1025 char *type_instance = NULL;
1028 if (hostname == NULL)
1031 plugin = strchr (hostname, '/');
1034 *plugin = '\0'; plugin++;
1036 type = strchr (plugin, '/');
1039 *type = '\0'; type++;
1041 plugin_instance = strchr (plugin, '-');
1042 if (plugin_instance != NULL)
1044 *plugin_instance = '\0';
1048 type_instance = strchr (type, '-');
1049 if (type_instance != NULL)
1051 *type_instance = '\0';
1055 *ret_host = hostname;
1056 *ret_plugin = plugin;
1057 *ret_plugin_instance = plugin_instance;
1059 *ret_type_instance = type_instance;
1061 } /* int parse_identifier */
1063 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1065 char str_copy[6 * DATA_MAX_NAME_LEN];
1067 char *plugin = NULL;
1068 char *plugin_instance = NULL;
1070 char *type_instance = NULL;
1073 if ((str == NULL) || (vl == NULL))
1076 sstrncpy (str_copy, str, sizeof (str_copy));
1078 status = parse_identifier (str_copy, &host,
1079 &plugin, &plugin_instance,
1080 &type, &type_instance);
1084 sstrncpy (vl->host, host, sizeof (vl->host));
1085 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1086 sstrncpy (vl->plugin_instance,
1087 (plugin_instance != NULL) ? plugin_instance : "",
1088 sizeof (vl->plugin_instance));
1089 sstrncpy (vl->type, type, sizeof (vl->type));
1090 sstrncpy (vl->type_instance,
1091 (type_instance != NULL) ? type_instance : "",
1092 sizeof (vl->type_instance));
1095 } /* }}} int parse_identifier_vl */
1097 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1100 char *endptr = NULL;
1103 if (value_orig == NULL)
1106 value = strdup (value_orig);
1109 value_len = strlen (value);
1111 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1113 value[value_len - 1] = 0;
1119 case DS_TYPE_COUNTER:
1120 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1124 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1127 case DS_TYPE_DERIVE:
1128 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1131 case DS_TYPE_ABSOLUTE:
1132 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1137 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1141 if (value == endptr) {
1142 ERROR ("parse_value: Failed to parse string as %s: \"%s\".",
1143 DS_TYPE_TO_STRING (ds_type), value);
1147 else if ((NULL != endptr) && ('\0' != *endptr))
1148 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1149 "Input string was \"%s\".",
1150 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1154 } /* int parse_value */
1156 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1163 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1170 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1174 if (i >= vl->values_len)
1176 /* Make sure i is invalid. */
1183 if (strcmp ("N", ptr) == 0)
1184 vl->time = cdtime ();
1187 char *endptr = NULL;
1191 tmp = strtod (ptr, &endptr);
1192 if ((errno != 0) /* Overflow */
1193 || (endptr == ptr) /* Invalid string */
1194 || (endptr == NULL) /* This should not happen */
1195 || (*endptr != 0)) /* Trailing chars */
1198 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1204 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1205 vl->values[i].gauge = NAN;
1206 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1210 } /* while (strtok_r) */
1212 if ((ptr != NULL) || (i == 0))
1215 } /* int parse_values */
1217 int parse_value_file (char const *path, value_t *ret_value, int ds_type)
1222 fh = fopen (path, "r");
1226 if (fgets (buffer, sizeof (buffer), fh) == NULL)
1234 strstripnewline (buffer);
1236 return parse_value (buffer, ret_value, ds_type);
1237 } /* int parse_value_file */
1239 #if !HAVE_GETPWNAM_R
1240 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1241 size_t buflen, struct passwd **pwbufp)
1246 memset (pwbuf, '\0', sizeof (struct passwd));
1248 pthread_mutex_lock (&getpwnam_r_lock);
1252 pw = getpwnam (name);
1255 status = (errno != 0) ? errno : ENOENT;
1259 #define GETPWNAM_COPY_MEMBER(member) \
1260 if (pw->member != NULL) \
1262 int len = strlen (pw->member); \
1263 if (len >= buflen) \
1268 sstrncpy (buf, pw->member, buflen); \
1269 pwbuf->member = buf; \
1271 buflen -= (len + 1); \
1273 GETPWNAM_COPY_MEMBER(pw_name);
1274 GETPWNAM_COPY_MEMBER(pw_passwd);
1275 GETPWNAM_COPY_MEMBER(pw_gecos);
1276 GETPWNAM_COPY_MEMBER(pw_dir);
1277 GETPWNAM_COPY_MEMBER(pw_shell);
1279 pwbuf->pw_uid = pw->pw_uid;
1280 pwbuf->pw_gid = pw->pw_gid;
1286 pthread_mutex_unlock (&getpwnam_r_lock);
1289 } /* int getpwnam_r */
1290 #endif /* !HAVE_GETPWNAM_R */
1292 int notification_init (notification_t *n, int severity, const char *message,
1294 const char *plugin, const char *plugin_instance,
1295 const char *type, const char *type_instance)
1297 memset (n, '\0', sizeof (notification_t));
1299 n->severity = severity;
1301 if (message != NULL)
1302 sstrncpy (n->message, message, sizeof (n->message));
1304 sstrncpy (n->host, host, sizeof (n->host));
1306 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1307 if (plugin_instance != NULL)
1308 sstrncpy (n->plugin_instance, plugin_instance,
1309 sizeof (n->plugin_instance));
1311 sstrncpy (n->type, type, sizeof (n->type));
1312 if (type_instance != NULL)
1313 sstrncpy (n->type_instance, type_instance,
1314 sizeof (n->type_instance));
1317 } /* int notification_init */
1319 int walk_directory (const char *dir, dirwalk_callback_f callback,
1320 void *user_data, int include_hidden)
1330 if ((dh = opendir (dir)) == NULL)
1333 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1334 sstrerror (errno, errbuf, sizeof (errbuf)));
1338 while ((ent = readdir (dh)) != NULL)
1344 if ((strcmp (".", ent->d_name) == 0)
1345 || (strcmp ("..", ent->d_name) == 0))
1348 else /* if (!include_hidden) */
1350 if (ent->d_name[0]=='.')
1354 status = (*callback) (dir, ent->d_name, user_data);
1363 if ((success == 0) && (failure > 0))
1368 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1373 fh = fopen (filename, "r");
1377 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1378 if ((ret == 0) && (ferror (fh) != 0))
1380 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1389 counter_t counter_diff (counter_t old_value, counter_t new_value)
1393 if (old_value > new_value)
1395 if (old_value <= 4294967295U)
1396 diff = (4294967295U - old_value) + new_value + 1;
1398 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1402 diff = new_value - old_value;
1406 } /* counter_t counter_diff */
1408 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1409 rate_to_value_state_t *state,
1410 int ds_type, cdtime_t t)
1412 gauge_t delta_gauge;
1415 if (ds_type == DS_TYPE_GAUGE)
1417 state->last_value.gauge = rate;
1418 state->last_time = t;
1420 *ret_value = state->last_value;
1424 /* Counter and absolute can't handle negative rates. Reset "last time"
1425 * to zero, so that the next valid rate will re-initialize the
1428 && ((ds_type == DS_TYPE_COUNTER)
1429 || (ds_type == DS_TYPE_ABSOLUTE)))
1431 memset (state, 0, sizeof (*state));
1435 /* Another invalid state: The time is not increasing. */
1436 if (t <= state->last_time)
1438 memset (state, 0, sizeof (*state));
1442 delta_t = t - state->last_time;
1443 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1445 /* Previous value is invalid. */
1446 if (state->last_time == 0) /* {{{ */
1448 if (ds_type == DS_TYPE_DERIVE)
1450 state->last_value.derive = (derive_t) rate;
1451 state->residual = rate - ((gauge_t) state->last_value.derive);
1453 else if (ds_type == DS_TYPE_COUNTER)
1455 state->last_value.counter = (counter_t) rate;
1456 state->residual = rate - ((gauge_t) state->last_value.counter);
1458 else if (ds_type == DS_TYPE_ABSOLUTE)
1460 state->last_value.absolute = (absolute_t) rate;
1461 state->residual = rate - ((gauge_t) state->last_value.absolute);
1468 state->last_time = t;
1472 if (ds_type == DS_TYPE_DERIVE)
1474 derive_t delta_derive = (derive_t) delta_gauge;
1476 state->last_value.derive += delta_derive;
1477 state->residual = delta_gauge - ((gauge_t) delta_derive);
1479 else if (ds_type == DS_TYPE_COUNTER)
1481 counter_t delta_counter = (counter_t) delta_gauge;
1483 state->last_value.counter += delta_counter;
1484 state->residual = delta_gauge - ((gauge_t) delta_counter);
1486 else if (ds_type == DS_TYPE_ABSOLUTE)
1488 absolute_t delta_absolute = (absolute_t) delta_gauge;
1490 state->last_value.absolute = delta_absolute;
1491 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1498 state->last_time = t;
1499 *ret_value = state->last_value;
1501 } /* }}} value_t rate_to_value */
1503 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1504 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1508 /* Another invalid state: The time is not increasing. */
1509 if (t <= state->last_time)
1511 memset (state, 0, sizeof (*state));
1515 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1517 /* Previous value is invalid. */
1518 if (state->last_time == 0)
1520 state->last_value = value;
1521 state->last_time = t;
1526 case DS_TYPE_DERIVE: {
1527 derive_t diff = value.derive - state->last_value.derive;
1528 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1531 case DS_TYPE_GAUGE: {
1532 *ret_rate = value.gauge;
1535 case DS_TYPE_COUNTER: {
1536 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1537 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1540 case DS_TYPE_ABSOLUTE: {
1541 absolute_t diff = value.absolute;
1542 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1549 state->last_value = value;
1550 state->last_time = t;
1552 } /* }}} value_t rate_to_value */
1554 int service_name_to_port_number (const char *service_name)
1556 struct addrinfo *ai_list;
1560 if (service_name == NULL)
1563 struct addrinfo ai_hints = {
1564 .ai_family = AF_UNSPEC
1567 status = getaddrinfo (/* node = */ NULL, service_name,
1568 &ai_hints, &ai_list);
1571 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1572 gai_strerror (status));
1576 service_number = -1;
1577 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1579 if (ai_ptr->ai_family == AF_INET)
1581 struct sockaddr_in *sa;
1583 sa = (void *) ai_ptr->ai_addr;
1584 service_number = (int) ntohs (sa->sin_port);
1586 else if (ai_ptr->ai_family == AF_INET6)
1588 struct sockaddr_in6 *sa;
1590 sa = (void *) ai_ptr->ai_addr;
1591 service_number = (int) ntohs (sa->sin6_port);
1594 if ((service_number > 0) && (service_number <= 65535))
1598 freeaddrinfo (ai_list);
1600 if ((service_number > 0) && (service_number <= 65535))
1601 return (service_number);
1603 } /* int service_name_to_port_number */
1605 void set_sock_opts (int sockfd) /* {{{ */
1610 socklen_t socklen = sizeof (socklen_t);
1611 int so_keepalive = 1;
1613 status = getsockopt (sockfd, SOL_SOCKET, SO_TYPE, &socktype, &socklen);
1616 WARNING ("set_sock_opts: failed to determine socket type");
1620 if (socktype == SOCK_STREAM)
1622 status = setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE,
1623 &so_keepalive, sizeof (so_keepalive));
1625 WARNING ("set_sock_opts: failed to set socket keepalive flag");
1628 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1629 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE,
1630 &tcp_keepidle, sizeof (tcp_keepidle));
1632 WARNING ("set_sock_opts: failed to set socket tcp keepalive time");
1635 #ifdef TCP_KEEPINTVL
1636 int tcp_keepintvl = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1637 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL,
1638 &tcp_keepintvl, sizeof (tcp_keepintvl));
1640 WARNING ("set_sock_opts: failed to set socket tcp keepalive interval");
1643 } /* }}} void set_sock_opts */
1645 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1650 if ((string == NULL) || (ret_value == NULL))
1655 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1656 if ((endptr == string) || (errno != 0))
1661 } /* }}} int strtoderive */
1663 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1666 char *endptr = NULL;
1668 if ((string == NULL) || (ret_value == NULL))
1673 tmp = (gauge_t) strtod (string, &endptr);
1676 else if ((endptr == NULL) || (*endptr != 0))
1681 } /* }}} int strtogauge */
1683 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1686 size_t array_len = *ret_array_len;
1691 array = realloc (*ret_array,
1692 (array_len + 1) * sizeof (*array));
1697 array[array_len] = strdup (str);
1698 if (array[array_len] == NULL)
1702 *ret_array_len = array_len;
1704 } /* }}} int strarray_add */
1706 void strarray_free (char **array, size_t array_len) /* {{{ */
1708 for (size_t i = 0; i < array_len; i++)
1711 } /* }}} void strarray_free */
1713 #ifdef HAVE_SYS_CAPABILITY_H
1714 int check_capability (int capability) /* {{{ */
1716 #ifdef _LINUX_CAPABILITY_VERSION_3
1717 cap_user_header_t cap_header = calloc(1, sizeof (*cap_header));
1718 if (cap_header == NULL)
1720 ERROR("check_capability: calloc failed");
1724 cap_user_data_t cap_data = calloc(1, sizeof (*cap_data));
1725 if (cap_data == NULL)
1727 ERROR("check_capability: calloc failed");
1732 cap_header->pid = getpid();
1733 cap_header->version = _LINUX_CAPABILITY_VERSION;
1734 if (capget(cap_header, cap_data) < 0)
1736 ERROR("check_capability: capget failed");
1742 if ((cap_data->effective & (1 << capability)) == 0)
1755 WARNING ("check_capability: unsupported capability implementation. "
1756 "Some plugin(s) may require elevated privileges to work properly.");
1758 #endif /* _LINUX_CAPABILITY_VERSION_3 */
1759 } /* }}} int check_capability */
1760 #endif /* HAVE_SYS_CAPABILITY_H */