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>
64 extern kstat_ctl_t *kc;
68 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
72 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
75 char *sstrncpy (char *dest, const char *src, size_t n)
77 strncpy (dest, src, n);
81 } /* char *sstrncpy */
83 int ssnprintf (char *dest, size_t n, const char *format, ...)
88 va_start (ap, format);
89 ret = vsnprintf (dest, n, format, ap);
96 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
98 char static_buffer[1024] = "";
100 size_t alloc_buffer_size;
104 /* Try printing into the static buffer. In many cases it will be
105 * sufficiently large and we can simply return a strdup() of this
107 va_start (ap, format);
108 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
113 /* "status" does not include the null byte. */
114 alloc_buffer_size = (size_t) (status + 1);
115 if (alloc_buffer_size <= sizeof (static_buffer))
116 return (strdup (static_buffer));
118 /* Allocate a buffer large enough to hold the string. */
119 alloc_buffer = calloc (1, alloc_buffer_size);
120 if (alloc_buffer == NULL)
123 /* Print again into this new buffer. */
124 va_start (ap, format);
125 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
129 sfree (alloc_buffer);
133 return (alloc_buffer);
134 } /* }}} char *ssnprintf_alloc */
136 char *sstrdup (const char *s)
144 /* Do not use `strdup' here, because it's not specified in POSIX. It's
145 * ``only'' an XSI extension. */
150 ERROR ("sstrdup: Out of memory.");
153 memcpy (r, s, sizeof (char) * sz);
156 } /* char *sstrdup */
158 /* Even though Posix requires "strerror_r" to return an "int",
159 * some systems (e.g. the GNU libc) return a "char *" _and_
160 * ignore the second argument ... -tokkee */
161 char *sstrerror (int errnum, char *buf, size_t buflen)
169 pthread_mutex_lock (&strerror_r_lock);
171 temp = strerror (errnum);
172 sstrncpy (buf, temp, buflen);
174 pthread_mutex_unlock (&strerror_r_lock);
176 /* #endif !HAVE_STRERROR_R */
178 #elif STRERROR_R_CHAR_P
181 temp = strerror_r (errnum, buf, buflen);
184 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
185 sstrncpy (buf, temp, buflen);
187 sstrncpy (buf, "strerror_r did not return "
188 "an error message", buflen);
191 /* #endif STRERROR_R_CHAR_P */
194 if (strerror_r (errnum, buf, buflen) != 0)
196 ssnprintf (buf, buflen, "Error #%i; "
197 "Additionally, strerror_r failed.",
200 #endif /* STRERROR_R_CHAR_P */
203 } /* char *sstrerror */
205 void *smalloc (size_t size)
209 if ((r = malloc (size)) == NULL)
211 ERROR ("Not enough memory.");
216 } /* void *smalloc */
219 void sfree (void **ptr)
231 ssize_t sread (int fd, void *buf, size_t count)
242 status = read (fd, (void *) ptr, nleft);
244 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
252 DEBUG ("Received EOF from fd %i. "
253 "Closing fd and returning error.",
259 assert ((0 > status) || (nleft >= (size_t)status));
261 nleft = nleft - ((size_t) status);
262 ptr = ptr + ((size_t) status);
269 ssize_t swrite (int fd, const void *buf, size_t count)
276 ptr = (const char *) buf;
282 /* checking for closed peer connection */
284 pfd.events = POLLIN | POLLHUP;
286 if (poll(&pfd, 1, 0) > 0) {
288 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
289 // if recv returns zero (even though poll() said there is data to be read),
290 // that means the connection has been closed
297 status = write (fd, (const void *) ptr, nleft);
299 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
305 nleft = nleft - ((size_t) status);
306 ptr = ptr + ((size_t) status);
312 int strsplit (char *string, char **fields, size_t size)
321 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
333 int strjoin (char *buffer, size_t buffer_size,
334 char **fields, size_t fields_num,
341 if ((buffer_size < 1) || (fields_num == 0))
344 memset (buffer, 0, buffer_size);
346 avail = buffer_size - 1;
350 sep_len = strlen (sep);
352 for (size_t i = 0; i < fields_num; i++)
356 if ((i > 0) && (sep_len > 0))
361 memcpy (ptr, sep, sep_len);
366 field_len = strlen (fields[i]);
367 if (avail < field_len)
370 memcpy (ptr, fields[i], field_len);
375 assert (buffer[buffer_size - 1] == 0);
376 return ((int) strlen (buffer));
379 int escape_string (char *buffer, size_t buffer_size)
384 /* Check if we need to escape at all first */
385 temp = strpbrk (buffer, " \t\"\\");
392 temp = calloc (1, buffer_size);
399 for (size_t i = 0; i < buffer_size; i++)
405 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
407 if (j > (buffer_size - 4))
410 temp[j + 1] = buffer[i];
415 if (j > (buffer_size - 3))
422 assert ((j + 1) < buffer_size);
426 sstrncpy (buffer, temp, buffer_size);
429 } /* int escape_string */
431 int strunescape (char *buf, size_t buf_len)
433 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
438 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
439 ERROR ("string unescape: backslash found at end of string.");
440 /* Ensure null-byte at the end of the buffer. */
445 switch (buf[i + 1]) {
460 /* Move everything after the position one position to the left.
461 * Add a null-byte as last character in the buffer. */
462 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
463 buf[buf_len - 1] = 0;
466 } /* int strunescape */
468 size_t strstripnewline (char *buffer)
470 size_t buffer_len = strlen (buffer);
472 while (buffer_len > 0)
474 if ((buffer[buffer_len - 1] != '\n')
475 && (buffer[buffer_len - 1] != '\r'))
478 buffer[buffer_len] = 0;
482 } /* size_t strstripnewline */
484 int escape_slashes (char *buffer, size_t buffer_size)
488 buffer_len = strlen (buffer);
492 if (strcmp ("/", buffer) == 0)
496 sstrncpy (buffer, "root", buffer_size);
501 /* Move one to the left */
502 if (buffer[0] == '/')
504 memmove (buffer, buffer + 1, buffer_len);
508 for (size_t i = 0; i < buffer_len; i++)
510 if (buffer[i] == '/')
515 } /* int escape_slashes */
517 void replace_special (char *buffer, size_t buffer_size)
519 for (size_t i = 0; i < buffer_size; i++)
523 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
526 } /* void replace_special */
528 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
530 struct timeval *larger;
531 struct timeval *smaller;
535 NORMALIZE_TIMEVAL (tv0);
536 NORMALIZE_TIMEVAL (tv1);
538 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
547 if ((tv0.tv_sec < tv1.tv_sec)
548 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
562 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
564 if (smaller->tv_usec <= larger->tv_usec)
565 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
569 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
573 assert ((delta == NULL)
574 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
577 } /* int timeval_cmp */
579 int check_create_dir (const char *file_orig)
590 int last_is_file = 1;
591 int path_is_absolute = 0;
595 * Sanity checks first
597 if (file_orig == NULL)
600 if ((len = strlen (file_orig)) < 1)
602 else if (len >= sizeof (file_copy))
606 * If `file_orig' ends in a slash the last component is a directory,
607 * otherwise it's a file. Act accordingly..
609 if (file_orig[len - 1] == '/')
611 if (file_orig[0] == '/')
612 path_is_absolute = 1;
615 * Create a copy for `strtok_r' to destroy
617 sstrncpy (file_copy, file_orig, sizeof (file_copy));
620 * Break into components. This will eat up several slashes in a row and
621 * remove leading and trailing slashes..
626 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
631 if (fields_num >= 16)
636 * For each component, do..
638 for (int i = 0; i < (fields_num - last_is_file); i++)
641 * Do not create directories that start with a dot. This
642 * prevents `../../' attacks and other likely malicious
645 if (fields[i][0] == '.')
647 ERROR ("Cowardly refusing to create a directory that "
648 "begins with a `.' (dot): `%s'", file_orig);
653 * Join the components together again
656 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
657 fields, (size_t) (i + 1), "/") < 0)
659 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
664 if ((stat (dir, &statbuf) == -1)
665 && (lstat (dir, &statbuf) == -1))
669 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
672 /* this might happen, if a different thread created
673 * the directory in the meantime
674 * => call stat() again to check for S_ISDIR() */
679 ERROR ("check_create_dir: mkdir (%s): %s", dir,
681 errbuf, sizeof (errbuf)));
687 ERROR ("check_create_dir: stat (%s): %s", dir,
688 sstrerror (errno, errbuf,
693 else if (!S_ISDIR (statbuf.st_mode))
695 ERROR ("check_create_dir: `%s' exists but is not "
696 "a directory!", dir);
704 } /* check_create_dir */
707 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
716 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
718 *ksp_ptr = kstat_lookup (kc, module, instance, name);
719 if (*ksp_ptr == NULL)
721 ERROR ("get_kstat: Cound not find kstat %s", ident);
725 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
727 ERROR ("get_kstat: kstat %s has wrong type", ident);
733 assert (*ksp_ptr != NULL);
734 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
737 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
739 ERROR ("get_kstat: kstat %s could not be read", ident);
743 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
745 ERROR ("get_kstat: kstat %s has wrong type", ident);
752 long long get_kstat_value (kstat_t *ksp, char *name)
755 long long retval = -1LL;
759 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
762 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
764 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
765 "is not KSTAT_TYPE_NAMED (%#x).",
767 (unsigned int) ksp->ks_type,
768 (unsigned int) KSTAT_TYPE_NAMED);
772 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
775 if (kn->data_type == KSTAT_DATA_INT32)
776 retval = (long long) kn->value.i32;
777 else if (kn->data_type == KSTAT_DATA_UINT32)
778 retval = (long long) kn->value.ui32;
779 else if (kn->data_type == KSTAT_DATA_INT64)
780 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
781 else if (kn->data_type == KSTAT_DATA_UINT64)
782 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
784 WARNING ("get_kstat_value: Not a numeric value: %s", name);
788 #endif /* HAVE_LIBKSTAT */
791 unsigned long long ntohll (unsigned long long n)
793 #if BYTE_ORDER == BIG_ENDIAN
796 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
798 } /* unsigned long long ntohll */
800 unsigned long long htonll (unsigned long long n)
802 #if BYTE_ORDER == BIG_ENDIAN
805 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
807 } /* unsigned long long htonll */
808 #endif /* HAVE_HTONLL */
810 #if FP_LAYOUT_NEED_NOTHING
811 /* Well, we need nothing.. */
812 /* #endif FP_LAYOUT_NEED_NOTHING */
814 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
815 # if FP_LAYOUT_NEED_ENDIANFLIP
816 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
817 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
818 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
819 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
820 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
821 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
822 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
823 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
825 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
826 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
829 double ntohd (double d)
840 /* NAN in x86 byte order */
841 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
842 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
843 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
844 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
853 ret.integer = FP_CONVERT (tmp);
854 return (ret.floating);
858 double htond (double d)
869 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
870 ret.byte[4] = ret.byte[5] = 0x00;
873 return (ret.floating);
880 tmp = FP_CONVERT (ret.integer);
882 return (ret.floating);
885 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
887 int format_name (char *ret, int ret_len,
888 const char *hostname,
889 const char *plugin, const char *plugin_instance,
890 const char *type, const char *type_instance)
896 buffer_size = (size_t) ret_len;
898 #define APPEND(str) do { \
899 size_t l = strlen (str); \
900 if (l >= buffer_size) \
902 memcpy (buffer, (str), l); \
903 buffer += l; buffer_size -= l; \
906 assert (plugin != NULL);
907 assert (type != NULL);
912 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
915 APPEND (plugin_instance);
919 if ((type_instance != NULL) && (type_instance[0] != 0))
922 APPEND (type_instance);
924 assert (buffer_size > 0);
929 } /* int format_name */
931 int format_values (char *ret, size_t ret_len, /* {{{ */
932 const data_set_t *ds, const value_list_t *vl,
937 gauge_t *rates = NULL;
939 assert (0 == strcmp (ds->type, vl->type));
941 memset (ret, 0, ret_len);
943 #define BUFFER_ADD(...) do { \
944 status = ssnprintf (ret + offset, ret_len - offset, \
951 else if (((size_t) status) >= (ret_len - offset)) \
957 offset += ((size_t) status); \
960 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
962 for (size_t i = 0; i < ds->ds_num; i++)
964 if (ds->ds[i].type == DS_TYPE_GAUGE)
965 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
966 else if (store_rates)
969 rates = uc_get_rate (ds, vl);
972 WARNING ("format_values: uc_get_rate failed.");
975 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
977 else if (ds->ds[i].type == DS_TYPE_COUNTER)
978 BUFFER_ADD (":%llu", vl->values[i].counter);
979 else if (ds->ds[i].type == DS_TYPE_DERIVE)
980 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
981 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
982 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
985 ERROR ("format_values: Unknown data source type: %i",
990 } /* for ds->ds_num */
996 } /* }}} int format_values */
998 int parse_identifier (char *str, char **ret_host,
999 char **ret_plugin, char **ret_plugin_instance,
1000 char **ret_type, char **ret_type_instance)
1002 char *hostname = NULL;
1003 char *plugin = NULL;
1004 char *plugin_instance = NULL;
1006 char *type_instance = NULL;
1009 if (hostname == NULL)
1012 plugin = strchr (hostname, '/');
1015 *plugin = '\0'; plugin++;
1017 type = strchr (plugin, '/');
1020 *type = '\0'; type++;
1022 plugin_instance = strchr (plugin, '-');
1023 if (plugin_instance != NULL)
1025 *plugin_instance = '\0';
1029 type_instance = strchr (type, '-');
1030 if (type_instance != NULL)
1032 *type_instance = '\0';
1036 *ret_host = hostname;
1037 *ret_plugin = plugin;
1038 *ret_plugin_instance = plugin_instance;
1040 *ret_type_instance = type_instance;
1042 } /* int parse_identifier */
1044 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1046 char str_copy[6 * DATA_MAX_NAME_LEN];
1048 char *plugin = NULL;
1049 char *plugin_instance = NULL;
1051 char *type_instance = NULL;
1054 if ((str == NULL) || (vl == NULL))
1057 sstrncpy (str_copy, str, sizeof (str_copy));
1059 status = parse_identifier (str_copy, &host,
1060 &plugin, &plugin_instance,
1061 &type, &type_instance);
1065 sstrncpy (vl->host, host, sizeof (vl->host));
1066 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1067 sstrncpy (vl->plugin_instance,
1068 (plugin_instance != NULL) ? plugin_instance : "",
1069 sizeof (vl->plugin_instance));
1070 sstrncpy (vl->type, type, sizeof (vl->type));
1071 sstrncpy (vl->type_instance,
1072 (type_instance != NULL) ? type_instance : "",
1073 sizeof (vl->type_instance));
1076 } /* }}} int parse_identifier_vl */
1078 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1081 char *endptr = NULL;
1084 if (value_orig == NULL)
1087 value = strdup (value_orig);
1090 value_len = strlen (value);
1092 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1094 value[value_len - 1] = 0;
1100 case DS_TYPE_COUNTER:
1101 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1105 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1108 case DS_TYPE_DERIVE:
1109 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1112 case DS_TYPE_ABSOLUTE:
1113 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1118 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1122 if (value == endptr) {
1123 ERROR ("parse_value: Failed to parse string as %s: %s.",
1124 DS_TYPE_TO_STRING (ds_type), value);
1128 else if ((NULL != endptr) && ('\0' != *endptr))
1129 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1130 "Input string was \"%s\".",
1131 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1135 } /* int parse_value */
1137 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1144 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1151 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1155 if (i >= vl->values_len)
1157 /* Make sure i is invalid. */
1164 if (strcmp ("N", ptr) == 0)
1165 vl->time = cdtime ();
1168 char *endptr = NULL;
1172 tmp = strtod (ptr, &endptr);
1173 if ((errno != 0) /* Overflow */
1174 || (endptr == ptr) /* Invalid string */
1175 || (endptr == NULL) /* This should not happen */
1176 || (*endptr != 0)) /* Trailing chars */
1179 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1185 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1186 vl->values[i].gauge = NAN;
1187 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1191 } /* while (strtok_r) */
1193 if ((ptr != NULL) || (i == 0))
1196 } /* int parse_values */
1198 #if !HAVE_GETPWNAM_R
1199 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1200 size_t buflen, struct passwd **pwbufp)
1205 memset (pwbuf, '\0', sizeof (struct passwd));
1207 pthread_mutex_lock (&getpwnam_r_lock);
1211 pw = getpwnam (name);
1214 status = (errno != 0) ? errno : ENOENT;
1218 #define GETPWNAM_COPY_MEMBER(member) \
1219 if (pw->member != NULL) \
1221 int len = strlen (pw->member); \
1222 if (len >= buflen) \
1227 sstrncpy (buf, pw->member, buflen); \
1228 pwbuf->member = buf; \
1230 buflen -= (len + 1); \
1232 GETPWNAM_COPY_MEMBER(pw_name);
1233 GETPWNAM_COPY_MEMBER(pw_passwd);
1234 GETPWNAM_COPY_MEMBER(pw_gecos);
1235 GETPWNAM_COPY_MEMBER(pw_dir);
1236 GETPWNAM_COPY_MEMBER(pw_shell);
1238 pwbuf->pw_uid = pw->pw_uid;
1239 pwbuf->pw_gid = pw->pw_gid;
1245 pthread_mutex_unlock (&getpwnam_r_lock);
1248 } /* int getpwnam_r */
1249 #endif /* !HAVE_GETPWNAM_R */
1251 int notification_init (notification_t *n, int severity, const char *message,
1253 const char *plugin, const char *plugin_instance,
1254 const char *type, const char *type_instance)
1256 memset (n, '\0', sizeof (notification_t));
1258 n->severity = severity;
1260 if (message != NULL)
1261 sstrncpy (n->message, message, sizeof (n->message));
1263 sstrncpy (n->host, host, sizeof (n->host));
1265 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1266 if (plugin_instance != NULL)
1267 sstrncpy (n->plugin_instance, plugin_instance,
1268 sizeof (n->plugin_instance));
1270 sstrncpy (n->type, type, sizeof (n->type));
1271 if (type_instance != NULL)
1272 sstrncpy (n->type_instance, type_instance,
1273 sizeof (n->type_instance));
1276 } /* int notification_init */
1278 int walk_directory (const char *dir, dirwalk_callback_f callback,
1279 void *user_data, int include_hidden)
1289 if ((dh = opendir (dir)) == NULL)
1292 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1293 sstrerror (errno, errbuf, sizeof (errbuf)));
1297 while ((ent = readdir (dh)) != NULL)
1303 if ((strcmp (".", ent->d_name) == 0)
1304 || (strcmp ("..", ent->d_name) == 0))
1307 else /* if (!include_hidden) */
1309 if (ent->d_name[0]=='.')
1313 status = (*callback) (dir, ent->d_name, user_data);
1322 if ((success == 0) && (failure > 0))
1327 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1332 fh = fopen (filename, "r");
1336 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1337 if ((ret == 0) && (ferror (fh) != 0))
1339 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1348 counter_t counter_diff (counter_t old_value, counter_t new_value)
1352 if (old_value > new_value)
1354 if (old_value <= 4294967295U)
1355 diff = (4294967295U - old_value) + new_value + 1;
1357 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1361 diff = new_value - old_value;
1365 } /* counter_t counter_diff */
1367 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1368 rate_to_value_state_t *state,
1369 int ds_type, cdtime_t t)
1371 gauge_t delta_gauge;
1374 if (ds_type == DS_TYPE_GAUGE)
1376 state->last_value.gauge = rate;
1377 state->last_time = t;
1379 *ret_value = state->last_value;
1383 /* Counter and absolute can't handle negative rates. Reset "last time"
1384 * to zero, so that the next valid rate will re-initialize the
1387 && ((ds_type == DS_TYPE_COUNTER)
1388 || (ds_type == DS_TYPE_ABSOLUTE)))
1390 memset (state, 0, sizeof (*state));
1394 /* Another invalid state: The time is not increasing. */
1395 if (t <= state->last_time)
1397 memset (state, 0, sizeof (*state));
1401 delta_t = t - state->last_time;
1402 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1404 /* Previous value is invalid. */
1405 if (state->last_time == 0) /* {{{ */
1407 if (ds_type == DS_TYPE_DERIVE)
1409 state->last_value.derive = (derive_t) rate;
1410 state->residual = rate - ((gauge_t) state->last_value.derive);
1412 else if (ds_type == DS_TYPE_COUNTER)
1414 state->last_value.counter = (counter_t) rate;
1415 state->residual = rate - ((gauge_t) state->last_value.counter);
1417 else if (ds_type == DS_TYPE_ABSOLUTE)
1419 state->last_value.absolute = (absolute_t) rate;
1420 state->residual = rate - ((gauge_t) state->last_value.absolute);
1427 state->last_time = t;
1431 if (ds_type == DS_TYPE_DERIVE)
1433 derive_t delta_derive = (derive_t) delta_gauge;
1435 state->last_value.derive += delta_derive;
1436 state->residual = delta_gauge - ((gauge_t) delta_derive);
1438 else if (ds_type == DS_TYPE_COUNTER)
1440 counter_t delta_counter = (counter_t) delta_gauge;
1442 state->last_value.counter += delta_counter;
1443 state->residual = delta_gauge - ((gauge_t) delta_counter);
1445 else if (ds_type == DS_TYPE_ABSOLUTE)
1447 absolute_t delta_absolute = (absolute_t) delta_gauge;
1449 state->last_value.absolute = delta_absolute;
1450 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1457 state->last_time = t;
1458 *ret_value = state->last_value;
1460 } /* }}} value_t rate_to_value */
1462 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1463 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1467 /* Another invalid state: The time is not increasing. */
1468 if (t <= state->last_time)
1470 memset (state, 0, sizeof (*state));
1474 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1476 /* Previous value is invalid. */
1477 if (state->last_time == 0)
1479 state->last_value = value;
1480 state->last_time = t;
1485 case DS_TYPE_DERIVE: {
1486 derive_t diff = value.derive - state->last_value.derive;
1487 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1490 case DS_TYPE_GAUGE: {
1491 *ret_rate = value.gauge;
1494 case DS_TYPE_COUNTER: {
1495 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1496 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1499 case DS_TYPE_ABSOLUTE: {
1500 absolute_t diff = value.absolute;
1501 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1508 state->last_value = value;
1509 state->last_time = t;
1511 } /* }}} value_t rate_to_value */
1513 int service_name_to_port_number (const char *service_name)
1515 struct addrinfo *ai_list;
1519 if (service_name == NULL)
1522 struct addrinfo ai_hints = {
1523 .ai_family = AF_UNSPEC
1526 status = getaddrinfo (/* node = */ NULL, service_name,
1527 &ai_hints, &ai_list);
1530 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1531 gai_strerror (status));
1535 service_number = -1;
1536 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1538 if (ai_ptr->ai_family == AF_INET)
1540 struct sockaddr_in *sa;
1542 sa = (void *) ai_ptr->ai_addr;
1543 service_number = (int) ntohs (sa->sin_port);
1545 else if (ai_ptr->ai_family == AF_INET6)
1547 struct sockaddr_in6 *sa;
1549 sa = (void *) ai_ptr->ai_addr;
1550 service_number = (int) ntohs (sa->sin6_port);
1553 if ((service_number > 0) && (service_number <= 65535))
1557 freeaddrinfo (ai_list);
1559 if ((service_number > 0) && (service_number <= 65535))
1560 return (service_number);
1562 } /* int service_name_to_port_number */
1564 void set_sock_opts (int sockfd) /* {{{ */
1569 socklen_t socklen = sizeof (socklen_t);
1570 int so_keepalive = 1;
1571 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1572 int tcp_keepintvl = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1574 status = getsockopt (sockfd, SOL_SOCKET, SO_TYPE, &socktype, &socklen);
1577 WARNING ("set_sock_opts: failed to determine socket type");
1581 if (socktype == SOCK_STREAM)
1583 status = setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE,
1584 &so_keepalive, sizeof (so_keepalive));
1586 WARNING ("set_sock_opts: failed to set socket keepalive flag");
1589 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE,
1590 &tcp_keepidle, sizeof (tcp_keepidle));
1592 WARNING ("set_sock_opts: failed to set socket tcp keepalive time");
1595 #ifdef TCP_KEEPINTVL
1596 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL,
1597 &tcp_keepintvl, sizeof (tcp_keepintvl));
1599 WARNING ("set_sock_opts: failed to set socket tcp keepalive interval");
1602 } /* }}} void set_sock_opts */
1604 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1609 if ((string == NULL) || (ret_value == NULL))
1614 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1615 if ((endptr == string) || (errno != 0))
1620 } /* }}} int strtoderive */
1622 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1625 char *endptr = NULL;
1627 if ((string == NULL) || (ret_value == NULL))
1632 tmp = (gauge_t) strtod (string, &endptr);
1635 else if ((endptr == NULL) || (*endptr != 0))
1640 } /* }}} int strtogauge */
1642 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1645 size_t array_len = *ret_array_len;
1650 array = realloc (*ret_array,
1651 (array_len + 1) * sizeof (*array));
1656 array[array_len] = strdup (str);
1657 if (array[array_len] == NULL)
1661 *ret_array_len = array_len;
1663 } /* }}} int strarray_add */
1665 void strarray_free (char **array, size_t array_len) /* {{{ */
1667 for (size_t i = 0; i < array_len; i++)
1670 } /* }}} void strarray_free */