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>
39 /* for ntohl and htonl */
41 # include <arpa/inet.h>
45 extern kstat_ctl_t *kc;
49 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
53 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
56 char *sstrncpy (char *dest, const char *src, size_t n)
58 strncpy (dest, src, n);
62 } /* char *sstrncpy */
64 int ssnprintf (char *dest, size_t n, const char *format, ...)
69 va_start (ap, format);
70 ret = vsnprintf (dest, n, format, ap);
77 char *sstrdup (const char *s)
85 /* Do not use `strdup' here, because it's not specified in POSIX. It's
86 * ``only'' an XSI extension. */
88 r = (char *) malloc (sizeof (char) * sz);
91 ERROR ("sstrdup: Out of memory.");
94 memcpy (r, s, sizeof (char) * sz);
99 /* Even though Posix requires "strerror_r" to return an "int",
100 * some systems (e.g. the GNU libc) return a "char *" _and_
101 * ignore the second argument ... -tokkee */
102 char *sstrerror (int errnum, char *buf, size_t buflen)
110 pthread_mutex_lock (&strerror_r_lock);
112 temp = strerror (errnum);
113 sstrncpy (buf, temp, buflen);
115 pthread_mutex_unlock (&strerror_r_lock);
117 /* #endif !HAVE_STRERROR_R */
119 #elif STRERROR_R_CHAR_P
122 temp = strerror_r (errnum, buf, buflen);
125 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
126 sstrncpy (buf, temp, buflen);
128 sstrncpy (buf, "strerror_r did not return "
129 "an error message", buflen);
132 /* #endif STRERROR_R_CHAR_P */
135 if (strerror_r (errnum, buf, buflen) != 0)
137 ssnprintf (buf, buflen, "Error #%i; "
138 "Additionally, strerror_r failed.",
141 #endif /* STRERROR_R_CHAR_P */
144 } /* char *sstrerror */
146 void *smalloc (size_t size)
150 if ((r = malloc (size)) == NULL)
152 ERROR ("Not enough memory.");
157 } /* void *smalloc */
160 void sfree (void **ptr)
172 ssize_t sread (int fd, void *buf, size_t count)
183 status = read (fd, (void *) ptr, nleft);
185 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
193 DEBUG ("Received EOF from fd %i. "
194 "Closing fd and returning error.",
200 assert ((0 > status) || (nleft >= (size_t)status));
202 nleft = nleft - status;
210 ssize_t swrite (int fd, const void *buf, size_t count)
216 ptr = (const char *) buf;
221 status = write (fd, (const void *) ptr, nleft);
223 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
229 nleft = nleft - status;
236 int strsplit (char *string, char **fields, size_t size)
245 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
257 int strjoin (char *dst, size_t dst_len,
258 char **fields, size_t fields_num,
265 memset (dst, '\0', dst_len);
272 sep_len = strlen (sep);
274 for (i = 0; i < (int)fields_num; i++)
276 if ((i > 0) && (sep_len > 0))
278 if (dst_len <= sep_len)
281 strncat (dst, sep, dst_len);
285 field_len = strlen (fields[i]);
287 if (dst_len <= field_len)
290 strncat (dst, fields[i], dst_len);
291 dst_len -= field_len;
294 return (strlen (dst));
297 int strsubstitute (char *str, char c_from, char c_to)
316 } /* int strsubstitute */
318 int escape_slashes (char *buf, int buf_len)
322 if (strcmp (buf, "/") == 0)
327 strncpy (buf, "root", buf_len);
334 /* Move one to the left */
336 memmove (buf, buf + 1, buf_len - 1);
338 for (i = 0; i < buf_len - 1; i++)
342 else if (buf[i] == '/')
348 } /* int escape_slashes */
350 void replace_special (char *buffer, size_t buffer_size)
354 for (i = 0; i < buffer_size; i++)
358 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
361 } /* void replace_special */
363 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
365 struct timeval *larger;
366 struct timeval *smaller;
370 NORMALIZE_TIMEVAL (tv0);
371 NORMALIZE_TIMEVAL (tv1);
373 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
382 if ((tv0.tv_sec < tv1.tv_sec)
383 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
397 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
399 if (smaller->tv_usec <= larger->tv_usec)
400 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
404 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
408 assert ((delta == NULL)
409 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
412 } /* int timeval_cmp */
414 int check_create_dir (const char *file_orig)
425 int last_is_file = 1;
426 int path_is_absolute = 0;
431 * Sanity checks first
433 if (file_orig == NULL)
436 if ((len = strlen (file_orig)) < 1)
438 else if (len >= sizeof (file_copy))
442 * If `file_orig' ends in a slash the last component is a directory,
443 * otherwise it's a file. Act accordingly..
445 if (file_orig[len - 1] == '/')
447 if (file_orig[0] == '/')
448 path_is_absolute = 1;
451 * Create a copy for `strtok_r' to destroy
453 sstrncpy (file_copy, file_orig, sizeof (file_copy));
456 * Break into components. This will eat up several slashes in a row and
457 * remove leading and trailing slashes..
462 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
467 if (fields_num >= 16)
472 * For each component, do..
474 for (i = 0; i < (fields_num - last_is_file); i++)
477 * Do not create directories that start with a dot. This
478 * prevents `../../' attacks and other likely malicious
481 if (fields[i][0] == '.')
483 ERROR ("Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
488 * Join the components together again
491 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
492 fields, i + 1, "/") < 0)
494 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
498 if (stat (dir, &statbuf) == -1)
502 if (mkdir (dir, 0755) == -1)
505 ERROR ("check_create_dir: mkdir (%s): %s", dir,
507 errbuf, sizeof (errbuf)));
514 ERROR ("stat (%s): %s", dir,
515 sstrerror (errno, errbuf,
520 else if (!S_ISDIR (statbuf.st_mode))
522 ERROR ("stat (%s): Not a directory!", dir);
528 } /* check_create_dir */
531 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
538 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
540 if (*ksp_ptr == NULL)
542 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
544 ERROR ("Cound not find kstat %s", ident);
548 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
550 WARNING ("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 WARNING ("kstat %s could not be read", ident);
567 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
569 WARNING ("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_value (char *value, value_t *ret_value, const data_source_t ds)
797 if (DS_TYPE_COUNTER == ds.type)
798 ret_value->counter = (counter_t)strtoll (value, &endptr, 0);
799 else if (DS_TYPE_GAUGE == ds.type)
800 ret_value->gauge = (gauge_t)strtod (value, &endptr);
802 ERROR ("parse_value: Invalid data source \"%s\" "
803 "(type = %i).", ds.name, ds.type);
807 if (value == endptr) {
808 ERROR ("parse_value: Failed to parse string as number: %s.", value);
811 else if ((NULL != endptr) && ('\0' != *endptr))
812 WARNING ("parse_value: Ignoring trailing garbage after number: %s.",
815 } /* int parse_value */
817 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
827 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
831 if (i >= vl->values_len)
836 if (strcmp ("N", ptr) == 0)
837 vl->time = time (NULL);
839 vl->time = (time_t) atoi (ptr);
843 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
844 vl->values[i].gauge = NAN;
845 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i]))
850 } /* while (strtok_r) */
852 if ((ptr != NULL) || (i != vl->values_len))
855 } /* int parse_values */
858 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
859 size_t buflen, struct passwd **pwbufp)
864 memset (pwbuf, '\0', sizeof (struct passwd));
866 pthread_mutex_lock (&getpwnam_r_lock);
870 pw = getpwnam (name);
873 status = (errno != 0) ? errno : ENOENT;
877 #define GETPWNAM_COPY_MEMBER(member) \
878 if (pw->member != NULL) \
880 int len = strlen (pw->member); \
886 sstrncpy (buf, pw->member, buflen); \
887 pwbuf->member = buf; \
889 buflen -= (len + 1); \
891 GETPWNAM_COPY_MEMBER(pw_name);
892 GETPWNAM_COPY_MEMBER(pw_passwd);
893 GETPWNAM_COPY_MEMBER(pw_gecos);
894 GETPWNAM_COPY_MEMBER(pw_dir);
895 GETPWNAM_COPY_MEMBER(pw_shell);
897 pwbuf->pw_uid = pw->pw_uid;
898 pwbuf->pw_gid = pw->pw_gid;
904 pthread_mutex_unlock (&getpwnam_r_lock);
907 } /* int getpwnam_r */
908 #endif /* !HAVE_GETPWNAM_R */
910 int notification_init (notification_t *n, int severity, const char *message,
912 const char *plugin, const char *plugin_instance,
913 const char *type, const char *type_instance)
915 memset (n, '\0', sizeof (notification_t));
917 n->severity = severity;
920 sstrncpy (n->message, message, sizeof (n->message));
922 sstrncpy (n->host, host, sizeof (n->host));
924 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
925 if (plugin_instance != NULL)
926 sstrncpy (n->plugin_instance, plugin_instance,
927 sizeof (n->plugin_instance));
929 sstrncpy (n->type, type, sizeof (n->type));
930 if (type_instance != NULL)
931 sstrncpy (n->type_instance, type_instance,
932 sizeof (n->type_instance));
935 } /* int notification_init */
937 int walk_directory (const char *dir, dirwalk_callback_f callback,
948 if ((dh = opendir (dir)) == NULL)
951 ERROR ("walk_directory: Cannot open '%s': %s", dir,
952 sstrerror (errno, errbuf, sizeof (errbuf)));
956 while ((ent = readdir (dh)) != NULL)
960 if (ent->d_name[0] == '.')
963 status = (*callback) (dir, ent->d_name, user_data);
972 if ((success == 0) && (failure > 0))
977 int read_file_contents (const char *filename, char *buf, int bufsize)
982 if ((fh = fopen (filename, "r")) == NULL)
985 n = fread(buf, 1, bufsize, fh);
991 counter_t counter_diff (counter_t old_value, counter_t new_value)
995 if (old_value > new_value)
997 if (old_value <= 4294967295U)
998 diff = (4294967295U - old_value) + new_value;
1000 diff = (18446744073709551615ULL - old_value)
1005 diff = new_value - old_value;
1009 } /* counter_t counter_to_gauge */