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;
72 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
76 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
79 char *sstrncpy (char *dest, const char *src, size_t n)
81 strncpy (dest, src, n);
85 } /* char *sstrncpy */
87 int ssnprintf (char *dest, size_t n, const char *format, ...)
92 va_start (ap, format);
93 ret = vsnprintf (dest, n, format, ap);
100 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
102 char static_buffer[1024] = "";
104 size_t alloc_buffer_size;
108 /* Try printing into the static buffer. In many cases it will be
109 * sufficiently large and we can simply return a strdup() of this
111 va_start (ap, format);
112 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
117 /* "status" does not include the null byte. */
118 alloc_buffer_size = (size_t) (status + 1);
119 if (alloc_buffer_size <= sizeof (static_buffer))
120 return (strdup (static_buffer));
122 /* Allocate a buffer large enough to hold the string. */
123 alloc_buffer = calloc (1, alloc_buffer_size);
124 if (alloc_buffer == NULL)
127 /* Print again into this new buffer. */
128 va_start (ap, format);
129 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
133 sfree (alloc_buffer);
137 return (alloc_buffer);
138 } /* }}} char *ssnprintf_alloc */
140 char *sstrdup (const char *s)
148 /* Do not use `strdup' here, because it's not specified in POSIX. It's
149 * ``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)
173 pthread_mutex_lock (&strerror_r_lock);
175 temp = strerror (errnum);
176 sstrncpy (buf, temp, buflen);
178 pthread_mutex_unlock (&strerror_r_lock);
180 /* #endif !HAVE_STRERROR_R */
182 #elif STRERROR_R_CHAR_P
185 temp = strerror_r (errnum, buf, buflen);
188 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
189 sstrncpy (buf, temp, buflen);
191 sstrncpy (buf, "strerror_r did not return "
192 "an error message", buflen);
195 /* #endif STRERROR_R_CHAR_P */
198 if (strerror_r (errnum, buf, buflen) != 0)
200 ssnprintf (buf, buflen, "Error #%i; "
201 "Additionally, strerror_r failed.",
204 #endif /* STRERROR_R_CHAR_P */
207 } /* char *sstrerror */
209 void *smalloc (size_t size)
213 if ((r = malloc (size)) == NULL)
215 ERROR ("Not enough memory.");
220 } /* void *smalloc */
223 void sfree (void **ptr)
235 ssize_t sread (int fd, void *buf, size_t count)
246 status = read (fd, (void *) ptr, nleft);
248 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
256 DEBUG ("Received EOF from fd %i. "
257 "Closing fd and returning error.",
263 assert ((0 > status) || (nleft >= (size_t)status));
265 nleft = nleft - ((size_t) status);
266 ptr = ptr + ((size_t) status);
273 ssize_t swrite (int fd, const void *buf, size_t count)
280 ptr = (const char *) buf;
286 /* checking for closed peer connection */
288 pfd.events = POLLIN | POLLHUP;
290 if (poll(&pfd, 1, 0) > 0) {
292 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
293 // if recv returns zero (even though poll() said there is data to be read),
294 // that means the connection has been closed
301 status = write (fd, (const void *) ptr, nleft);
303 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
309 nleft = nleft - ((size_t) status);
310 ptr = ptr + ((size_t) status);
316 int strsplit (char *string, char **fields, size_t size)
325 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
337 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
343 size_t buffer_req = 0;
345 if (((fields_num != 0) && (fields == NULL)) ||
346 ((buffer_size != 0) && (buffer == NULL)))
352 if (buffer_size != 0)
353 avail = buffer_size - 1;
356 sep_len = strlen(sep);
358 for (size_t i = 0; i < fields_num; i++) {
359 size_t field_len = strlen(fields[i]);
362 buffer_req += sep_len;
363 buffer_req += field_len;
365 if ((i != 0) && (sep_len > 0)) {
366 if (sep_len >= avail) {
367 /* prevent subsequent iterations from writing to the
373 memcpy(ptr, sep, sep_len);
379 if (field_len > avail)
382 memcpy(ptr, fields[i], field_len);
390 return (int)buffer_req;
393 int escape_string (char *buffer, size_t buffer_size)
398 /* Check if we need to escape at all first */
399 temp = strpbrk (buffer, " \t\"\\");
406 temp = calloc (1, buffer_size);
413 for (size_t i = 0; i < buffer_size; i++)
419 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
421 if (j > (buffer_size - 4))
424 temp[j + 1] = buffer[i];
429 if (j > (buffer_size - 3))
436 assert ((j + 1) < buffer_size);
440 sstrncpy (buffer, temp, buffer_size);
443 } /* int escape_string */
445 int strunescape (char *buf, size_t buf_len)
447 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
452 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
453 ERROR ("string unescape: backslash found at end of string.");
454 /* Ensure null-byte at the end of the buffer. */
459 switch (buf[i + 1]) {
474 /* Move everything after the position one position to the left.
475 * Add a null-byte as last character in the buffer. */
476 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
477 buf[buf_len - 1] = 0;
480 } /* int strunescape */
482 size_t strstripnewline (char *buffer)
484 size_t buffer_len = strlen (buffer);
486 while (buffer_len > 0)
488 if ((buffer[buffer_len - 1] != '\n')
489 && (buffer[buffer_len - 1] != '\r'))
492 buffer[buffer_len] = 0;
496 } /* size_t strstripnewline */
498 int escape_slashes (char *buffer, size_t buffer_size)
502 buffer_len = strlen (buffer);
506 if (strcmp ("/", buffer) == 0)
510 sstrncpy (buffer, "root", buffer_size);
515 /* Move one to the left */
516 if (buffer[0] == '/')
518 memmove (buffer, buffer + 1, buffer_len);
522 for (size_t i = 0; i < buffer_len; i++)
524 if (buffer[i] == '/')
529 } /* int escape_slashes */
531 void replace_special (char *buffer, size_t buffer_size)
533 for (size_t i = 0; i < buffer_size; i++)
537 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
540 } /* void replace_special */
542 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
544 struct timeval *larger;
545 struct timeval *smaller;
549 NORMALIZE_TIMEVAL (tv0);
550 NORMALIZE_TIMEVAL (tv1);
552 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
561 if ((tv0.tv_sec < tv1.tv_sec)
562 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
576 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
578 if (smaller->tv_usec <= larger->tv_usec)
579 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
583 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
587 assert ((delta == NULL)
588 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
591 } /* int timeval_cmp */
593 int check_create_dir (const char *file_orig)
604 int last_is_file = 1;
605 int path_is_absolute = 0;
609 * Sanity checks first
611 if (file_orig == NULL)
614 if ((len = strlen (file_orig)) < 1)
616 else if (len >= sizeof (file_copy))
620 * If `file_orig' ends in a slash the last component is a directory,
621 * otherwise it's a file. Act accordingly..
623 if (file_orig[len - 1] == '/')
625 if (file_orig[0] == '/')
626 path_is_absolute = 1;
629 * Create a copy for `strtok_r' to destroy
631 sstrncpy (file_copy, file_orig, sizeof (file_copy));
634 * Break into components. This will eat up several slashes in a row and
635 * remove leading and trailing slashes..
640 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
645 if (fields_num >= 16)
650 * For each component, do..
652 for (int i = 0; i < (fields_num - last_is_file); i++)
655 * Do not create directories that start with a dot. This
656 * prevents `../../' attacks and other likely malicious
659 if (fields[i][0] == '.')
661 ERROR ("Cowardly refusing to create a directory that "
662 "begins with a `.' (dot): `%s'", file_orig);
667 * Join the components together again
670 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
671 fields, (size_t) (i + 1), "/") < 0)
673 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
678 if ((stat (dir, &statbuf) == -1)
679 && (lstat (dir, &statbuf) == -1))
683 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
686 /* this might happen, if a different thread created
687 * the directory in the meantime
688 * => call stat() again to check for S_ISDIR() */
693 ERROR ("check_create_dir: mkdir (%s): %s", dir,
695 errbuf, sizeof (errbuf)));
701 ERROR ("check_create_dir: stat (%s): %s", dir,
702 sstrerror (errno, errbuf,
707 else if (!S_ISDIR (statbuf.st_mode))
709 ERROR ("check_create_dir: `%s' exists but is not "
710 "a directory!", dir);
718 } /* check_create_dir */
721 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
730 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
732 *ksp_ptr = kstat_lookup (kc, module, instance, name);
733 if (*ksp_ptr == NULL)
735 ERROR ("get_kstat: Cound not find kstat %s", ident);
739 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
741 ERROR ("get_kstat: kstat %s has wrong type", ident);
747 assert (*ksp_ptr != NULL);
748 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
751 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
753 ERROR ("get_kstat: kstat %s could not be read", ident);
757 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
759 ERROR ("get_kstat: kstat %s has wrong type", ident);
766 long long get_kstat_value (kstat_t *ksp, char *name)
769 long long retval = -1LL;
773 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
776 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
778 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
779 "is not KSTAT_TYPE_NAMED (%#x).",
781 (unsigned int) ksp->ks_type,
782 (unsigned int) KSTAT_TYPE_NAMED);
786 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
789 if (kn->data_type == KSTAT_DATA_INT32)
790 retval = (long long) kn->value.i32;
791 else if (kn->data_type == KSTAT_DATA_UINT32)
792 retval = (long long) kn->value.ui32;
793 else if (kn->data_type == KSTAT_DATA_INT64)
794 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
795 else if (kn->data_type == KSTAT_DATA_UINT64)
796 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
798 WARNING ("get_kstat_value: Not a numeric value: %s", name);
802 #endif /* HAVE_LIBKSTAT */
805 unsigned long long ntohll (unsigned long long n)
807 #if BYTE_ORDER == BIG_ENDIAN
810 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
812 } /* unsigned long long ntohll */
814 unsigned long long htonll (unsigned long long n)
816 #if BYTE_ORDER == BIG_ENDIAN
819 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
821 } /* unsigned long long htonll */
822 #endif /* HAVE_HTONLL */
824 #if FP_LAYOUT_NEED_NOTHING
825 /* Well, we need nothing.. */
826 /* #endif FP_LAYOUT_NEED_NOTHING */
828 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
829 # if FP_LAYOUT_NEED_ENDIANFLIP
830 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
831 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
832 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
833 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
834 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
835 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
836 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
837 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
839 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
840 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
843 double ntohd (double d)
854 /* NAN in x86 byte order */
855 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
856 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
857 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
858 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
867 ret.integer = FP_CONVERT (tmp);
868 return (ret.floating);
872 double htond (double d)
883 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
884 ret.byte[4] = ret.byte[5] = 0x00;
887 return (ret.floating);
894 tmp = FP_CONVERT (ret.integer);
896 return (ret.floating);
899 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
901 int format_name (char *ret, int ret_len,
902 const char *hostname,
903 const char *plugin, const char *plugin_instance,
904 const char *type, const char *type_instance)
910 buffer_size = (size_t) ret_len;
912 #define APPEND(str) do { \
913 size_t l = strlen (str); \
914 if (l >= buffer_size) \
916 memcpy (buffer, (str), l); \
917 buffer += l; buffer_size -= l; \
920 assert (plugin != NULL);
921 assert (type != NULL);
926 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
929 APPEND (plugin_instance);
933 if ((type_instance != NULL) && (type_instance[0] != 0))
936 APPEND (type_instance);
938 assert (buffer_size > 0);
943 } /* int format_name */
945 int format_values (char *ret, size_t ret_len, /* {{{ */
946 const data_set_t *ds, const value_list_t *vl,
951 gauge_t *rates = NULL;
953 assert (0 == strcmp (ds->type, vl->type));
955 memset (ret, 0, ret_len);
957 #define BUFFER_ADD(...) do { \
958 status = ssnprintf (ret + offset, ret_len - offset, \
965 else if (((size_t) status) >= (ret_len - offset)) \
971 offset += ((size_t) status); \
974 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
976 for (size_t i = 0; i < ds->ds_num; i++)
978 if (ds->ds[i].type == DS_TYPE_GAUGE)
979 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
980 else if (store_rates)
983 rates = uc_get_rate (ds, vl);
986 WARNING ("format_values: uc_get_rate failed.");
989 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
991 else if (ds->ds[i].type == DS_TYPE_COUNTER)
992 BUFFER_ADD (":%llu", vl->values[i].counter);
993 else if (ds->ds[i].type == DS_TYPE_DERIVE)
994 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
995 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
996 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
999 ERROR ("format_values: Unknown data source type: %i",
1004 } /* for ds->ds_num */
1010 } /* }}} int format_values */
1012 int parse_identifier (char *str, char **ret_host,
1013 char **ret_plugin, char **ret_plugin_instance,
1014 char **ret_type, char **ret_type_instance,
1017 char *hostname = NULL;
1018 char *plugin = NULL;
1019 char *plugin_instance = NULL;
1021 char *type_instance = NULL;
1024 if (hostname == NULL)
1027 plugin = strchr (hostname, '/');
1030 *plugin = '\0'; plugin++;
1032 type = strchr (plugin, '/');
1035 if (default_host == NULL)
1037 /* else: no host specified; use default */
1040 hostname = default_host;
1048 plugin_instance = strchr (plugin, '-');
1049 if (plugin_instance != NULL)
1051 *plugin_instance = '\0';
1055 type_instance = strchr (type, '-');
1056 if (type_instance != NULL)
1058 *type_instance = '\0';
1062 *ret_host = hostname;
1063 *ret_plugin = plugin;
1064 *ret_plugin_instance = plugin_instance;
1066 *ret_type_instance = type_instance;
1068 } /* int parse_identifier */
1070 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1072 char str_copy[6 * DATA_MAX_NAME_LEN];
1074 char *plugin = NULL;
1075 char *plugin_instance = NULL;
1077 char *type_instance = NULL;
1080 if ((str == NULL) || (vl == NULL))
1083 sstrncpy (str_copy, str, sizeof (str_copy));
1085 status = parse_identifier (str_copy, &host,
1086 &plugin, &plugin_instance,
1087 &type, &type_instance,
1088 /* default_host = */ NULL);
1092 sstrncpy (vl->host, host, sizeof (vl->host));
1093 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1094 sstrncpy (vl->plugin_instance,
1095 (plugin_instance != NULL) ? plugin_instance : "",
1096 sizeof (vl->plugin_instance));
1097 sstrncpy (vl->type, type, sizeof (vl->type));
1098 sstrncpy (vl->type_instance,
1099 (type_instance != NULL) ? type_instance : "",
1100 sizeof (vl->type_instance));
1103 } /* }}} int parse_identifier_vl */
1105 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1108 char *endptr = NULL;
1111 if (value_orig == NULL)
1114 value = strdup (value_orig);
1117 value_len = strlen (value);
1119 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1121 value[value_len - 1] = 0;
1127 case DS_TYPE_COUNTER:
1128 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1132 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1135 case DS_TYPE_DERIVE:
1136 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1139 case DS_TYPE_ABSOLUTE:
1140 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1145 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1149 if (value == endptr) {
1150 ERROR ("parse_value: Failed to parse string as %s: %s.",
1151 DS_TYPE_TO_STRING (ds_type), value);
1155 else if ((NULL != endptr) && ('\0' != *endptr))
1156 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1157 "Input string was \"%s\".",
1158 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1162 } /* int parse_value */
1164 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1171 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1178 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1182 if (i >= vl->values_len)
1184 /* Make sure i is invalid. */
1191 if (strcmp ("N", ptr) == 0)
1192 vl->time = cdtime ();
1195 char *endptr = NULL;
1199 tmp = strtod (ptr, &endptr);
1200 if ((errno != 0) /* Overflow */
1201 || (endptr == ptr) /* Invalid string */
1202 || (endptr == NULL) /* This should not happen */
1203 || (*endptr != 0)) /* Trailing chars */
1206 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1212 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1213 vl->values[i].gauge = NAN;
1214 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1218 } /* while (strtok_r) */
1220 if ((ptr != NULL) || (i == 0))
1223 } /* int parse_values */
1225 int parse_value_file (char const *path, value_t *ret_value, int ds_type)
1230 fh = fopen (path, "r");
1234 if (fgets (buffer, sizeof (buffer), fh) == NULL)
1242 strstripnewline (buffer);
1244 return parse_value (buffer, ret_value, ds_type);
1245 } /* int parse_value_file */
1247 #if !HAVE_GETPWNAM_R
1248 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1249 size_t buflen, struct passwd **pwbufp)
1254 memset (pwbuf, '\0', sizeof (struct passwd));
1256 pthread_mutex_lock (&getpwnam_r_lock);
1260 pw = getpwnam (name);
1263 status = (errno != 0) ? errno : ENOENT;
1267 #define GETPWNAM_COPY_MEMBER(member) \
1268 if (pw->member != NULL) \
1270 int len = strlen (pw->member); \
1271 if (len >= buflen) \
1276 sstrncpy (buf, pw->member, buflen); \
1277 pwbuf->member = buf; \
1279 buflen -= (len + 1); \
1281 GETPWNAM_COPY_MEMBER(pw_name);
1282 GETPWNAM_COPY_MEMBER(pw_passwd);
1283 GETPWNAM_COPY_MEMBER(pw_gecos);
1284 GETPWNAM_COPY_MEMBER(pw_dir);
1285 GETPWNAM_COPY_MEMBER(pw_shell);
1287 pwbuf->pw_uid = pw->pw_uid;
1288 pwbuf->pw_gid = pw->pw_gid;
1294 pthread_mutex_unlock (&getpwnam_r_lock);
1297 } /* int getpwnam_r */
1298 #endif /* !HAVE_GETPWNAM_R */
1300 int notification_init (notification_t *n, int severity, const char *message,
1302 const char *plugin, const char *plugin_instance,
1303 const char *type, const char *type_instance)
1305 memset (n, '\0', sizeof (notification_t));
1307 n->severity = severity;
1309 if (message != NULL)
1310 sstrncpy (n->message, message, sizeof (n->message));
1312 sstrncpy (n->host, host, sizeof (n->host));
1314 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1315 if (plugin_instance != NULL)
1316 sstrncpy (n->plugin_instance, plugin_instance,
1317 sizeof (n->plugin_instance));
1319 sstrncpy (n->type, type, sizeof (n->type));
1320 if (type_instance != NULL)
1321 sstrncpy (n->type_instance, type_instance,
1322 sizeof (n->type_instance));
1325 } /* int notification_init */
1327 int walk_directory (const char *dir, dirwalk_callback_f callback,
1328 void *user_data, int include_hidden)
1338 if ((dh = opendir (dir)) == NULL)
1341 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1342 sstrerror (errno, errbuf, sizeof (errbuf)));
1346 while ((ent = readdir (dh)) != NULL)
1352 if ((strcmp (".", ent->d_name) == 0)
1353 || (strcmp ("..", ent->d_name) == 0))
1356 else /* if (!include_hidden) */
1358 if (ent->d_name[0]=='.')
1362 status = (*callback) (dir, ent->d_name, user_data);
1371 if ((success == 0) && (failure > 0))
1376 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1381 fh = fopen (filename, "r");
1385 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1386 if ((ret == 0) && (ferror (fh) != 0))
1388 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1397 counter_t counter_diff (counter_t old_value, counter_t new_value)
1401 if (old_value > new_value)
1403 if (old_value <= 4294967295U)
1404 diff = (4294967295U - old_value) + new_value + 1;
1406 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1410 diff = new_value - old_value;
1414 } /* counter_t counter_diff */
1416 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1417 rate_to_value_state_t *state,
1418 int ds_type, cdtime_t t)
1420 gauge_t delta_gauge;
1423 if (ds_type == DS_TYPE_GAUGE)
1425 state->last_value.gauge = rate;
1426 state->last_time = t;
1428 *ret_value = state->last_value;
1432 /* Counter and absolute can't handle negative rates. Reset "last time"
1433 * to zero, so that the next valid rate will re-initialize the
1436 && ((ds_type == DS_TYPE_COUNTER)
1437 || (ds_type == DS_TYPE_ABSOLUTE)))
1439 memset (state, 0, sizeof (*state));
1443 /* Another invalid state: The time is not increasing. */
1444 if (t <= state->last_time)
1446 memset (state, 0, sizeof (*state));
1450 delta_t = t - state->last_time;
1451 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1453 /* Previous value is invalid. */
1454 if (state->last_time == 0) /* {{{ */
1456 if (ds_type == DS_TYPE_DERIVE)
1458 state->last_value.derive = (derive_t) rate;
1459 state->residual = rate - ((gauge_t) state->last_value.derive);
1461 else if (ds_type == DS_TYPE_COUNTER)
1463 state->last_value.counter = (counter_t) rate;
1464 state->residual = rate - ((gauge_t) state->last_value.counter);
1466 else if (ds_type == DS_TYPE_ABSOLUTE)
1468 state->last_value.absolute = (absolute_t) rate;
1469 state->residual = rate - ((gauge_t) state->last_value.absolute);
1476 state->last_time = t;
1480 if (ds_type == DS_TYPE_DERIVE)
1482 derive_t delta_derive = (derive_t) delta_gauge;
1484 state->last_value.derive += delta_derive;
1485 state->residual = delta_gauge - ((gauge_t) delta_derive);
1487 else if (ds_type == DS_TYPE_COUNTER)
1489 counter_t delta_counter = (counter_t) delta_gauge;
1491 state->last_value.counter += delta_counter;
1492 state->residual = delta_gauge - ((gauge_t) delta_counter);
1494 else if (ds_type == DS_TYPE_ABSOLUTE)
1496 absolute_t delta_absolute = (absolute_t) delta_gauge;
1498 state->last_value.absolute = delta_absolute;
1499 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1506 state->last_time = t;
1507 *ret_value = state->last_value;
1509 } /* }}} value_t rate_to_value */
1511 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1512 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1516 /* Another invalid state: The time is not increasing. */
1517 if (t <= state->last_time)
1519 memset (state, 0, sizeof (*state));
1523 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1525 /* Previous value is invalid. */
1526 if (state->last_time == 0)
1528 state->last_value = value;
1529 state->last_time = t;
1534 case DS_TYPE_DERIVE: {
1535 derive_t diff = value.derive - state->last_value.derive;
1536 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1539 case DS_TYPE_GAUGE: {
1540 *ret_rate = value.gauge;
1543 case DS_TYPE_COUNTER: {
1544 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1545 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1548 case DS_TYPE_ABSOLUTE: {
1549 absolute_t diff = value.absolute;
1550 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1557 state->last_value = value;
1558 state->last_time = t;
1560 } /* }}} value_t rate_to_value */
1562 int service_name_to_port_number (const char *service_name)
1564 struct addrinfo *ai_list;
1568 if (service_name == NULL)
1571 struct addrinfo ai_hints = {
1572 .ai_family = AF_UNSPEC
1575 status = getaddrinfo (/* node = */ NULL, service_name,
1576 &ai_hints, &ai_list);
1579 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1580 gai_strerror (status));
1584 service_number = -1;
1585 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1587 if (ai_ptr->ai_family == AF_INET)
1589 struct sockaddr_in *sa;
1591 sa = (void *) ai_ptr->ai_addr;
1592 service_number = (int) ntohs (sa->sin_port);
1594 else if (ai_ptr->ai_family == AF_INET6)
1596 struct sockaddr_in6 *sa;
1598 sa = (void *) ai_ptr->ai_addr;
1599 service_number = (int) ntohs (sa->sin6_port);
1602 if ((service_number > 0) && (service_number <= 65535))
1606 freeaddrinfo (ai_list);
1608 if ((service_number > 0) && (service_number <= 65535))
1609 return (service_number);
1611 } /* int service_name_to_port_number */
1613 void set_sock_opts (int sockfd) /* {{{ */
1618 socklen_t socklen = sizeof (socklen_t);
1619 int so_keepalive = 1;
1621 status = getsockopt (sockfd, SOL_SOCKET, SO_TYPE, &socktype, &socklen);
1624 WARNING ("set_sock_opts: failed to determine socket type");
1628 if (socktype == SOCK_STREAM)
1630 status = setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE,
1631 &so_keepalive, sizeof (so_keepalive));
1633 WARNING ("set_sock_opts: failed to set socket keepalive flag");
1636 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1637 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE,
1638 &tcp_keepidle, sizeof (tcp_keepidle));
1640 WARNING ("set_sock_opts: failed to set socket tcp keepalive time");
1643 #ifdef TCP_KEEPINTVL
1644 int tcp_keepintvl = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1645 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL,
1646 &tcp_keepintvl, sizeof (tcp_keepintvl));
1648 WARNING ("set_sock_opts: failed to set socket tcp keepalive interval");
1651 } /* }}} void set_sock_opts */
1653 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1658 if ((string == NULL) || (ret_value == NULL))
1663 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1664 if ((endptr == string) || (errno != 0))
1669 } /* }}} int strtoderive */
1671 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1674 char *endptr = NULL;
1676 if ((string == NULL) || (ret_value == NULL))
1681 tmp = (gauge_t) strtod (string, &endptr);
1684 else if ((endptr == NULL) || (*endptr != 0))
1689 } /* }}} int strtogauge */
1691 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1694 size_t array_len = *ret_array_len;
1699 array = realloc (*ret_array,
1700 (array_len + 1) * sizeof (*array));
1705 array[array_len] = strdup (str);
1706 if (array[array_len] == NULL)
1710 *ret_array_len = array_len;
1712 } /* }}} int strarray_add */
1714 void strarray_free (char **array, size_t array_len) /* {{{ */
1716 for (size_t i = 0; i < array_len; i++)
1719 } /* }}} void strarray_free */
1721 #ifdef HAVE_SYS_CAPABILITY_H
1722 int check_capability (int capability) /* {{{ */
1724 #ifdef _LINUX_CAPABILITY_VERSION_3
1725 cap_user_header_t cap_header = calloc(1, sizeof (*cap_header));
1726 if (cap_header == NULL)
1728 ERROR("check_capability: calloc failed");
1732 cap_user_data_t cap_data = calloc(1, sizeof (*cap_data));
1733 if (cap_data == NULL)
1735 ERROR("check_capability: calloc failed");
1740 cap_header->pid = getpid();
1741 cap_header->version = _LINUX_CAPABILITY_VERSION;
1742 if (capget(cap_header, cap_data) < 0)
1744 ERROR("check_capability: capget failed");
1750 if ((cap_data->effective & (1 << capability)) == 0)
1763 WARNING ("check_capability: unsupported capability implementation. "
1764 "Some plugin(s) may require elevated privileges to work properly.");
1766 #endif /* _LINUX_CAPABILITY_VERSION_3 */
1767 } /* }}} int check_capability */
1768 #endif /* HAVE_SYS_CAPABILITY_H */