2 * collectd - src/common.c
3 * Copyright (C) 2005-2008 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 extern kstat_ctl_t *kc;
51 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
55 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
58 char *sstrncpy (char *dest, const char *src, size_t n)
60 strncpy (dest, src, n);
64 } /* char *sstrncpy */
66 int ssnprintf (char *dest, size_t n, const char *format, ...)
71 va_start (ap, format);
72 ret = vsnprintf (dest, n, format, ap);
79 char *sstrdup (const char *s)
87 /* Do not use `strdup' here, because it's not specified in POSIX. It's
88 * ``only'' an XSI extension. */
90 r = (char *) malloc (sizeof (char) * sz);
93 ERROR ("sstrdup: Out of memory.");
96 memcpy (r, s, sizeof (char) * sz);
101 /* Even though Posix requires "strerror_r" to return an "int",
102 * some systems (e.g. the GNU libc) return a "char *" _and_
103 * ignore the second argument ... -tokkee */
104 char *sstrerror (int errnum, char *buf, size_t buflen)
112 pthread_mutex_lock (&strerror_r_lock);
114 temp = strerror (errnum);
115 sstrncpy (buf, temp, buflen);
117 pthread_mutex_unlock (&strerror_r_lock);
119 /* #endif !HAVE_STRERROR_R */
121 #elif STRERROR_R_CHAR_P
124 temp = strerror_r (errnum, buf, buflen);
127 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
128 sstrncpy (buf, temp, buflen);
130 sstrncpy (buf, "strerror_r did not return "
131 "an error message", buflen);
134 /* #endif STRERROR_R_CHAR_P */
137 if (strerror_r (errnum, buf, buflen) != 0)
139 ssnprintf (buf, buflen, "Error #%i; "
140 "Additionally, strerror_r failed.",
143 #endif /* STRERROR_R_CHAR_P */
146 } /* char *sstrerror */
148 void *smalloc (size_t size)
152 if ((r = malloc (size)) == NULL)
154 ERROR ("Not enough memory.");
159 } /* void *smalloc */
162 void sfree (void **ptr)
174 ssize_t sread (int fd, void *buf, size_t count)
185 status = read (fd, (void *) ptr, nleft);
187 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
195 DEBUG ("Received EOF from fd %i. "
196 "Closing fd and returning error.",
202 assert ((0 > status) || (nleft >= (size_t)status));
204 nleft = nleft - status;
212 ssize_t swrite (int fd, const void *buf, size_t count)
218 ptr = (const char *) buf;
223 status = write (fd, (const void *) ptr, nleft);
225 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
231 nleft = nleft - status;
238 int strsplit (char *string, char **fields, size_t size)
247 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
259 int strjoin (char *dst, size_t dst_len,
260 char **fields, size_t fields_num,
267 memset (dst, '\0', dst_len);
274 sep_len = strlen (sep);
276 for (i = 0; i < (int)fields_num; i++)
278 if ((i > 0) && (sep_len > 0))
280 if (dst_len <= sep_len)
283 strncat (dst, sep, dst_len);
287 field_len = strlen (fields[i]);
289 if (dst_len <= field_len)
292 strncat (dst, fields[i], dst_len);
293 dst_len -= field_len;
296 return (strlen (dst));
299 int strsubstitute (char *str, char c_from, char c_to)
318 } /* int strsubstitute */
320 int escape_slashes (char *buf, int buf_len)
324 if (strcmp (buf, "/") == 0)
329 strncpy (buf, "root", buf_len);
336 /* Move one to the left */
338 memmove (buf, buf + 1, buf_len - 1);
340 for (i = 0; i < buf_len - 1; i++)
344 else if (buf[i] == '/')
350 } /* int escape_slashes */
352 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
354 struct timeval *larger;
355 struct timeval *smaller;
359 NORMALIZE_TIMEVAL (tv0);
360 NORMALIZE_TIMEVAL (tv1);
362 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
371 if ((tv0.tv_sec < tv1.tv_sec)
372 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
386 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
388 if (smaller->tv_usec <= larger->tv_usec)
389 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
393 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
397 assert ((delta == NULL)
398 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
401 } /* int timeval_cmp */
403 int check_create_dir (const char *file_orig)
414 int last_is_file = 1;
415 int path_is_absolute = 0;
420 * Sanity checks first
422 if (file_orig == NULL)
425 if ((len = strlen (file_orig)) < 1)
427 else if (len >= sizeof (file_copy))
431 * If `file_orig' ends in a slash the last component is a directory,
432 * otherwise it's a file. Act accordingly..
434 if (file_orig[len - 1] == '/')
436 if (file_orig[0] == '/')
437 path_is_absolute = 1;
440 * Create a copy for `strtok_r' to destroy
442 sstrncpy (file_copy, file_orig, sizeof (file_copy));
445 * Break into components. This will eat up several slashes in a row and
446 * remove leading and trailing slashes..
451 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
456 if (fields_num >= 16)
461 * For each component, do..
463 for (i = 0; i < (fields_num - last_is_file); i++)
466 * Do not create directories that start with a dot. This
467 * prevents `../../' attacks and other likely malicious
470 if (fields[i][0] == '.')
472 ERROR ("Cowardly refusing to create a directory that "
473 "begins with a `.' (dot): `%s'", file_orig);
478 * Join the components together again
481 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
482 fields, i + 1, "/") < 0)
484 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
489 if (stat (dir, &statbuf) == -1)
493 if (mkdir (dir, 0755) == 0)
496 /* this might happen, if a different thread created
497 * the directory in the meantime
498 * => call stat() again to check for S_ISDIR() */
503 ERROR ("check_create_dir: mkdir (%s): %s", dir,
505 errbuf, sizeof (errbuf)));
511 ERROR ("check_create_dir: stat (%s): %s", dir,
512 sstrerror (errno, errbuf,
517 else if (!S_ISDIR (statbuf.st_mode))
519 ERROR ("check_create_dir: `%s' exists but is not "
520 "a directory!", dir);
528 } /* check_create_dir */
531 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
540 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
542 *ksp_ptr = kstat_lookup (kc, module, instance, name);
543 if (*ksp_ptr == NULL)
545 ERROR ("get_kstat: Cound not find kstat %s", ident);
549 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
551 ERROR ("get_kstat: kstat %s has wrong type", ident);
557 assert (*ksp_ptr != NULL);
558 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
561 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
563 ERROR ("get_kstat: kstat %s could not be read", ident);
567 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
569 ERROR ("get_kstat: kstat %s has wrong type", ident);
576 long long get_kstat_value (kstat_t *ksp, char *name)
579 long long retval = -1LL;
582 assert (ksp != NULL);
583 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
587 ERROR ("ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
590 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
592 ERROR ("ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
597 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
600 if (kn->data_type == KSTAT_DATA_INT32)
601 retval = (long long) kn->value.i32;
602 else if (kn->data_type == KSTAT_DATA_UINT32)
603 retval = (long long) kn->value.ui32;
604 else if (kn->data_type == KSTAT_DATA_INT64)
605 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
606 else if (kn->data_type == KSTAT_DATA_UINT64)
607 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
609 WARNING ("get_kstat_value: Not a numeric value: %s", name);
613 #endif /* HAVE_LIBKSTAT */
615 unsigned long long ntohll (unsigned long long n)
617 #if BYTE_ORDER == BIG_ENDIAN
620 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
622 } /* unsigned long long ntohll */
624 unsigned long long htonll (unsigned long long n)
626 #if BYTE_ORDER == BIG_ENDIAN
629 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
631 } /* unsigned long long htonll */
633 #if FP_LAYOUT_NEED_NOTHING
634 /* Well, we need nothing.. */
635 /* #endif FP_LAYOUT_NEED_NOTHING */
637 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
638 # if FP_LAYOUT_NEED_ENDIANFLIP
639 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
640 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
641 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
642 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
643 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
644 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
645 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
646 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
648 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
649 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
652 double ntohd (double d)
663 /* NAN in x86 byte order */
664 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
665 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
666 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
667 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
676 ret.integer = FP_CONVERT (tmp);
677 return (ret.floating);
681 double htond (double d)
692 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
693 ret.byte[4] = ret.byte[5] = 0x00;
696 return (ret.floating);
703 tmp = FP_CONVERT (ret.integer);
705 return (ret.floating);
708 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
710 int format_name (char *ret, int ret_len,
711 const char *hostname,
712 const char *plugin, const char *plugin_instance,
713 const char *type, const char *type_instance)
717 assert (plugin != NULL);
718 assert (type != NULL);
720 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
722 if ((type_instance == NULL) || (strlen (type_instance) == 0))
723 status = ssnprintf (ret, ret_len, "%s/%s/%s",
724 hostname, plugin, type);
726 status = ssnprintf (ret, ret_len, "%s/%s/%s-%s",
727 hostname, plugin, type,
732 if ((type_instance == NULL) || (strlen (type_instance) == 0))
733 status = ssnprintf (ret, ret_len, "%s/%s-%s/%s",
734 hostname, plugin, plugin_instance,
737 status = ssnprintf (ret, ret_len, "%s/%s-%s/%s-%s",
738 hostname, plugin, plugin_instance,
739 type, type_instance);
742 if ((status < 1) || (status >= ret_len))
745 } /* int format_name */
747 int parse_identifier (char *str, char **ret_host,
748 char **ret_plugin, char **ret_plugin_instance,
749 char **ret_type, char **ret_type_instance)
751 char *hostname = NULL;
753 char *plugin_instance = NULL;
755 char *type_instance = NULL;
758 if (hostname == NULL)
761 plugin = strchr (hostname, '/');
764 *plugin = '\0'; plugin++;
766 type = strchr (plugin, '/');
769 *type = '\0'; type++;
771 plugin_instance = strchr (plugin, '-');
772 if (plugin_instance != NULL)
774 *plugin_instance = '\0';
778 type_instance = strchr (type, '-');
779 if (type_instance != NULL)
781 *type_instance = '\0';
785 *ret_host = hostname;
786 *ret_plugin = plugin;
787 *ret_plugin_instance = plugin_instance;
789 *ret_type_instance = type_instance;
791 } /* int parse_identifier */
793 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
803 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
807 if (i >= vl->values_len)
812 if (strcmp ("N", ptr) == 0)
813 vl->time = time (NULL);
815 vl->time = (time_t) atoi (ptr);
819 if (strcmp ("U", ptr) == 0)
820 vl->values[i].gauge = NAN;
821 else if (ds->ds[i].type == DS_TYPE_COUNTER)
822 vl->values[i].counter = atoll (ptr);
823 else if (ds->ds[i].type == DS_TYPE_GAUGE)
824 vl->values[i].gauge = atof (ptr);
828 } /* while (strtok_r) */
830 if ((ptr != NULL) || (i != vl->values_len))
833 } /* int parse_values */
836 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
837 size_t buflen, struct passwd **pwbufp)
842 memset (pwbuf, '\0', sizeof (struct passwd));
844 pthread_mutex_lock (&getpwnam_r_lock);
848 pw = getpwnam (name);
851 status = (errno != 0) ? errno : ENOENT;
855 #define GETPWNAM_COPY_MEMBER(member) \
856 if (pw->member != NULL) \
858 int len = strlen (pw->member); \
864 sstrncpy (buf, pw->member, buflen); \
865 pwbuf->member = buf; \
867 buflen -= (len + 1); \
869 GETPWNAM_COPY_MEMBER(pw_name);
870 GETPWNAM_COPY_MEMBER(pw_passwd);
871 GETPWNAM_COPY_MEMBER(pw_gecos);
872 GETPWNAM_COPY_MEMBER(pw_dir);
873 GETPWNAM_COPY_MEMBER(pw_shell);
875 pwbuf->pw_uid = pw->pw_uid;
876 pwbuf->pw_gid = pw->pw_gid;
882 pthread_mutex_unlock (&getpwnam_r_lock);
885 } /* int getpwnam_r */
886 #endif /* !HAVE_GETPWNAM_R */
888 int notification_init (notification_t *n, int severity, const char *message,
890 const char *plugin, const char *plugin_instance,
891 const char *type, const char *type_instance)
893 memset (n, '\0', sizeof (notification_t));
895 n->severity = severity;
898 sstrncpy (n->message, message, sizeof (n->message));
900 sstrncpy (n->host, host, sizeof (n->host));
902 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
903 if (plugin_instance != NULL)
904 sstrncpy (n->plugin_instance, plugin_instance,
905 sizeof (n->plugin_instance));
907 sstrncpy (n->type, type, sizeof (n->type));
908 if (type_instance != NULL)
909 sstrncpy (n->type_instance, type_instance,
910 sizeof (n->type_instance));
913 } /* int notification_init */
915 int walk_directory (const char *dir, dirwalk_callback_f callback,
926 if ((dh = opendir (dir)) == NULL)
929 ERROR ("walk_directory: Cannot open '%s': %s", dir,
930 sstrerror (errno, errbuf, sizeof (errbuf)));
934 while ((ent = readdir (dh)) != NULL)
938 if (ent->d_name[0] == '.')
941 status = (*callback) (dir, ent->d_name, user_data);
950 if ((success == 0) && (failure > 0))
955 int read_file_contents (const char *filename, char *buf, int bufsize)
960 if ((fh = fopen (filename, "r")) == NULL)
963 n = fread(buf, 1, bufsize, fh);
969 counter_t counter_diff (counter_t old_value, counter_t new_value)
973 if (old_value > new_value)
975 if (old_value <= 4294967295U)
976 diff = (4294967295U - old_value) + new_value;
978 diff = (18446744073709551615ULL - old_value)
983 diff = new_value - old_value;
987 } /* counter_t counter_to_gauge */