2 * collectd - src/common.c
3 * Copyright (C) 2005-2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
20 * Niki W. Waibel <niki.waibel@gmx.net>
21 * Sebastian Harl <sh at tokkee.org>
22 * Michał Mirosław <mirq-linux at rere.qmqm.pl>
41 /* for ntohl and htonl */
43 # include <arpa/inet.h>
47 #include <sys/types.h>
48 #include <sys/socket.h>
52 extern kstat_ctl_t *kc;
56 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
60 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
63 char *sstrncpy (char *dest, const char *src, size_t n)
65 strncpy (dest, src, n);
69 } /* char *sstrncpy */
71 int ssnprintf (char *dest, size_t n, const char *format, ...)
76 va_start (ap, format);
77 ret = vsnprintf (dest, n, format, ap);
84 char *sstrdup (const char *s)
92 /* Do not use `strdup' here, because it's not specified in POSIX. It's
93 * ``only'' an XSI extension. */
95 r = (char *) malloc (sizeof (char) * sz);
98 ERROR ("sstrdup: Out of memory.");
101 memcpy (r, s, sizeof (char) * sz);
104 } /* char *sstrdup */
106 /* Even though Posix requires "strerror_r" to return an "int",
107 * some systems (e.g. the GNU libc) return a "char *" _and_
108 * ignore the second argument ... -tokkee */
109 char *sstrerror (int errnum, char *buf, size_t buflen)
117 pthread_mutex_lock (&strerror_r_lock);
119 temp = strerror (errnum);
120 sstrncpy (buf, temp, buflen);
122 pthread_mutex_unlock (&strerror_r_lock);
124 /* #endif !HAVE_STRERROR_R */
126 #elif STRERROR_R_CHAR_P
129 temp = strerror_r (errnum, buf, buflen);
132 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
133 sstrncpy (buf, temp, buflen);
135 sstrncpy (buf, "strerror_r did not return "
136 "an error message", buflen);
139 /* #endif STRERROR_R_CHAR_P */
142 if (strerror_r (errnum, buf, buflen) != 0)
144 ssnprintf (buf, buflen, "Error #%i; "
145 "Additionally, strerror_r failed.",
148 #endif /* STRERROR_R_CHAR_P */
151 } /* char *sstrerror */
153 void *smalloc (size_t size)
157 if ((r = malloc (size)) == NULL)
159 ERROR ("Not enough memory.");
164 } /* void *smalloc */
167 void sfree (void **ptr)
179 ssize_t sread (int fd, void *buf, size_t count)
190 status = read (fd, (void *) ptr, nleft);
192 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
200 DEBUG ("Received EOF from fd %i. "
201 "Closing fd and returning error.",
207 assert ((0 > status) || (nleft >= (size_t)status));
209 nleft = nleft - status;
217 ssize_t swrite (int fd, const void *buf, size_t count)
223 ptr = (const char *) buf;
228 status = write (fd, (const void *) ptr, nleft);
230 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
236 nleft = nleft - status;
243 int strsplit (char *string, char **fields, size_t size)
252 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
264 int strjoin (char *dst, size_t dst_len,
265 char **fields, size_t fields_num,
272 memset (dst, '\0', dst_len);
279 sep_len = strlen (sep);
281 for (i = 0; i < (int)fields_num; i++)
283 if ((i > 0) && (sep_len > 0))
285 if (dst_len <= sep_len)
288 strncat (dst, sep, dst_len);
292 field_len = strlen (fields[i]);
294 if (dst_len <= field_len)
297 strncat (dst, fields[i], dst_len);
298 dst_len -= field_len;
301 return (strlen (dst));
304 int strsubstitute (char *str, char c_from, char c_to)
323 } /* int strsubstitute */
325 int strunescape (char *buf, size_t buf_len)
329 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
334 if ((i >= buf_len) || (buf[i + 1] == '\0')) {
335 ERROR ("string unescape: backslash found at end of string.");
339 switch (buf[i + 1]) {
354 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
357 } /* int strunescape */
359 int escape_slashes (char *buf, int buf_len)
363 if (strcmp (buf, "/") == 0)
368 strncpy (buf, "root", buf_len);
375 /* Move one to the left */
377 memmove (buf, buf + 1, buf_len - 1);
379 for (i = 0; i < buf_len - 1; i++)
383 else if (buf[i] == '/')
389 } /* int escape_slashes */
391 void replace_special (char *buffer, size_t buffer_size)
395 for (i = 0; i < buffer_size; i++)
399 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
402 } /* void replace_special */
404 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
406 struct timeval *larger;
407 struct timeval *smaller;
411 NORMALIZE_TIMEVAL (tv0);
412 NORMALIZE_TIMEVAL (tv1);
414 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
423 if ((tv0.tv_sec < tv1.tv_sec)
424 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
438 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
440 if (smaller->tv_usec <= larger->tv_usec)
441 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
445 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
449 assert ((delta == NULL)
450 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
453 } /* int timeval_cmp */
455 int check_create_dir (const char *file_orig)
466 int last_is_file = 1;
467 int path_is_absolute = 0;
472 * Sanity checks first
474 if (file_orig == NULL)
477 if ((len = strlen (file_orig)) < 1)
479 else if (len >= sizeof (file_copy))
483 * If `file_orig' ends in a slash the last component is a directory,
484 * otherwise it's a file. Act accordingly..
486 if (file_orig[len - 1] == '/')
488 if (file_orig[0] == '/')
489 path_is_absolute = 1;
492 * Create a copy for `strtok_r' to destroy
494 sstrncpy (file_copy, file_orig, sizeof (file_copy));
497 * Break into components. This will eat up several slashes in a row and
498 * remove leading and trailing slashes..
503 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
508 if (fields_num >= 16)
513 * For each component, do..
515 for (i = 0; i < (fields_num - last_is_file); i++)
518 * Do not create directories that start with a dot. This
519 * prevents `../../' attacks and other likely malicious
522 if (fields[i][0] == '.')
524 ERROR ("Cowardly refusing to create a directory that "
525 "begins with a `.' (dot): `%s'", file_orig);
530 * Join the components together again
533 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
534 fields, i + 1, "/") < 0)
536 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
541 if (stat (dir, &statbuf) == -1)
545 if (mkdir (dir, 0755) == 0)
548 /* this might happen, if a different thread created
549 * the directory in the meantime
550 * => call stat() again to check for S_ISDIR() */
555 ERROR ("check_create_dir: mkdir (%s): %s", dir,
557 errbuf, sizeof (errbuf)));
563 ERROR ("check_create_dir: stat (%s): %s", dir,
564 sstrerror (errno, errbuf,
569 else if (!S_ISDIR (statbuf.st_mode))
571 ERROR ("check_create_dir: `%s' exists but is not "
572 "a directory!", dir);
580 } /* check_create_dir */
583 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
592 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
594 *ksp_ptr = kstat_lookup (kc, module, instance, name);
595 if (*ksp_ptr == NULL)
597 ERROR ("get_kstat: Cound not find kstat %s", ident);
601 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
603 ERROR ("get_kstat: kstat %s has wrong type", ident);
609 assert (*ksp_ptr != NULL);
610 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
613 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
615 ERROR ("get_kstat: kstat %s could not be read", ident);
619 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
621 ERROR ("get_kstat: kstat %s has wrong type", ident);
628 long long get_kstat_value (kstat_t *ksp, char *name)
631 long long retval = -1LL;
634 assert (ksp != NULL);
635 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
639 ERROR ("ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
642 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
644 ERROR ("ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
649 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
652 if (kn->data_type == KSTAT_DATA_INT32)
653 retval = (long long) kn->value.i32;
654 else if (kn->data_type == KSTAT_DATA_UINT32)
655 retval = (long long) kn->value.ui32;
656 else if (kn->data_type == KSTAT_DATA_INT64)
657 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
658 else if (kn->data_type == KSTAT_DATA_UINT64)
659 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
661 WARNING ("get_kstat_value: Not a numeric value: %s", name);
665 #endif /* HAVE_LIBKSTAT */
667 unsigned long long ntohll (unsigned long long n)
669 #if BYTE_ORDER == BIG_ENDIAN
672 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
674 } /* unsigned long long ntohll */
676 unsigned long long htonll (unsigned long long n)
678 #if BYTE_ORDER == BIG_ENDIAN
681 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
683 } /* unsigned long long htonll */
685 #if FP_LAYOUT_NEED_NOTHING
686 /* Well, we need nothing.. */
687 /* #endif FP_LAYOUT_NEED_NOTHING */
689 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
690 # if FP_LAYOUT_NEED_ENDIANFLIP
691 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
692 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
693 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
694 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
695 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
696 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
697 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
698 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
700 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
701 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
704 double ntohd (double d)
715 /* NAN in x86 byte order */
716 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
717 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
718 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
719 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
728 ret.integer = FP_CONVERT (tmp);
729 return (ret.floating);
733 double htond (double d)
744 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
745 ret.byte[4] = ret.byte[5] = 0x00;
748 return (ret.floating);
755 tmp = FP_CONVERT (ret.integer);
757 return (ret.floating);
760 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
762 int format_name (char *ret, int ret_len,
763 const char *hostname,
764 const char *plugin, const char *plugin_instance,
765 const char *type, const char *type_instance)
769 assert (plugin != NULL);
770 assert (type != NULL);
772 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
774 if ((type_instance == NULL) || (strlen (type_instance) == 0))
775 status = ssnprintf (ret, ret_len, "%s/%s/%s",
776 hostname, plugin, type);
778 status = ssnprintf (ret, ret_len, "%s/%s/%s-%s",
779 hostname, plugin, type,
784 if ((type_instance == NULL) || (strlen (type_instance) == 0))
785 status = ssnprintf (ret, ret_len, "%s/%s-%s/%s",
786 hostname, plugin, plugin_instance,
789 status = ssnprintf (ret, ret_len, "%s/%s-%s/%s-%s",
790 hostname, plugin, plugin_instance,
791 type, type_instance);
794 if ((status < 1) || (status >= ret_len))
797 } /* int format_name */
799 int parse_identifier (char *str, char **ret_host,
800 char **ret_plugin, char **ret_plugin_instance,
801 char **ret_type, char **ret_type_instance)
803 char *hostname = NULL;
805 char *plugin_instance = NULL;
807 char *type_instance = NULL;
810 if (hostname == NULL)
813 plugin = strchr (hostname, '/');
816 *plugin = '\0'; plugin++;
818 type = strchr (plugin, '/');
821 *type = '\0'; type++;
823 plugin_instance = strchr (plugin, '-');
824 if (plugin_instance != NULL)
826 *plugin_instance = '\0';
830 type_instance = strchr (type, '-');
831 if (type_instance != NULL)
833 *type_instance = '\0';
837 *ret_host = hostname;
838 *ret_plugin = plugin;
839 *ret_plugin_instance = plugin_instance;
841 *ret_type_instance = type_instance;
843 } /* int parse_identifier */
845 int parse_value (const char *value, value_t *ret_value, int ds_type)
851 case DS_TYPE_COUNTER:
852 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
856 ret_value->gauge = (gauge_t) strtod (value, &endptr);
860 ret_value->counter = (derive_t) strtoll (value, &endptr, 0);
863 case DS_TYPE_ABSOLUTE:
864 ret_value->counter = (absolute_t) strtoull (value, &endptr, 0);
868 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
872 if (value == endptr) {
873 ERROR ("parse_value: Failed to parse string as number: %s.", value);
876 else if ((NULL != endptr) && ('\0' != *endptr))
877 WARNING ("parse_value: Ignoring trailing garbage after number: %s.",
880 } /* int parse_value */
882 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
892 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
896 if (i >= vl->values_len)
898 /* Make sure i is invalid. */
899 i = vl->values_len + 1;
905 if (strcmp ("N", ptr) == 0)
906 vl->time = time (NULL);
908 vl->time = (time_t) atoi (ptr);
912 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
913 vl->values[i].gauge = NAN;
914 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
919 } /* while (strtok_r) */
921 if ((ptr != NULL) || (i != vl->values_len))
924 } /* int parse_values */
927 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
928 size_t buflen, struct passwd **pwbufp)
933 memset (pwbuf, '\0', sizeof (struct passwd));
935 pthread_mutex_lock (&getpwnam_r_lock);
939 pw = getpwnam (name);
942 status = (errno != 0) ? errno : ENOENT;
946 #define GETPWNAM_COPY_MEMBER(member) \
947 if (pw->member != NULL) \
949 int len = strlen (pw->member); \
955 sstrncpy (buf, pw->member, buflen); \
956 pwbuf->member = buf; \
958 buflen -= (len + 1); \
960 GETPWNAM_COPY_MEMBER(pw_name);
961 GETPWNAM_COPY_MEMBER(pw_passwd);
962 GETPWNAM_COPY_MEMBER(pw_gecos);
963 GETPWNAM_COPY_MEMBER(pw_dir);
964 GETPWNAM_COPY_MEMBER(pw_shell);
966 pwbuf->pw_uid = pw->pw_uid;
967 pwbuf->pw_gid = pw->pw_gid;
973 pthread_mutex_unlock (&getpwnam_r_lock);
976 } /* int getpwnam_r */
977 #endif /* !HAVE_GETPWNAM_R */
979 int notification_init (notification_t *n, int severity, const char *message,
981 const char *plugin, const char *plugin_instance,
982 const char *type, const char *type_instance)
984 memset (n, '\0', sizeof (notification_t));
986 n->severity = severity;
989 sstrncpy (n->message, message, sizeof (n->message));
991 sstrncpy (n->host, host, sizeof (n->host));
993 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
994 if (plugin_instance != NULL)
995 sstrncpy (n->plugin_instance, plugin_instance,
996 sizeof (n->plugin_instance));
998 sstrncpy (n->type, type, sizeof (n->type));
999 if (type_instance != NULL)
1000 sstrncpy (n->type_instance, type_instance,
1001 sizeof (n->type_instance));
1004 } /* int notification_init */
1006 int walk_directory (const char *dir, dirwalk_callback_f callback,
1017 if ((dh = opendir (dir)) == NULL)
1020 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1021 sstrerror (errno, errbuf, sizeof (errbuf)));
1025 while ((ent = readdir (dh)) != NULL)
1029 if (ent->d_name[0] == '.')
1032 status = (*callback) (dir, ent->d_name, user_data);
1041 if ((success == 0) && (failure > 0))
1046 int read_file_contents (const char *filename, char *buf, int bufsize)
1051 if ((fh = fopen (filename, "r")) == NULL)
1054 n = fread(buf, 1, bufsize, fh);
1060 counter_t counter_diff (counter_t old_value, counter_t new_value)
1064 if (old_value > new_value)
1066 if (old_value <= 4294967295U)
1067 diff = (4294967295U - old_value) + new_value;
1069 diff = (18446744073709551615ULL - old_value)
1074 diff = new_value - old_value;
1078 } /* counter_t counter_to_gauge */
1080 int service_name_to_port_number (const char *service_name)
1082 struct addrinfo *ai_list;
1083 struct addrinfo *ai_ptr;
1084 struct addrinfo ai_hints;
1088 if (service_name == NULL)
1092 memset (&ai_hints, 0, sizeof (ai_hints));
1093 ai_hints.ai_family = AF_UNSPEC;
1095 status = getaddrinfo (/* node = */ NULL, service_name,
1096 &ai_hints, &ai_list);
1099 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1100 gai_strerror (status));
1104 service_number = -1;
1105 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1107 if (ai_ptr->ai_family == AF_INET)
1109 struct sockaddr_in *sa;
1111 sa = (void *) ai_ptr->ai_addr;
1112 service_number = (int) ntohs (sa->sin_port);
1114 else if (ai_ptr->ai_family == AF_INET6)
1116 struct sockaddr_in6 *sa;
1118 sa = (void *) ai_ptr->ai_addr;
1119 service_number = (int) ntohs (sa->sin6_port);
1122 if ((service_number > 0) && (service_number <= 65535))
1126 freeaddrinfo (ai_list);
1128 if ((service_number > 0) && (service_number <= 65535))
1129 return (service_number);
1131 } /* int service_name_to_port_number */