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)
84 if((r = strdup (s)) == NULL)
86 ERROR ("Not enough memory.");
93 /* Even though Posix requires "strerror_r" to return an "int",
94 * some systems (e.g. the GNU libc) return a "char *" _and_
95 * ignore the second argument ... -tokkee */
96 char *sstrerror (int errnum, char *buf, size_t buflen)
104 pthread_mutex_lock (&strerror_r_lock);
106 temp = strerror (errnum);
107 sstrncpy (buf, temp, buflen);
109 pthread_mutex_unlock (&strerror_r_lock);
111 /* #endif !HAVE_STRERROR_R */
113 #elif STRERROR_R_CHAR_P
116 temp = strerror_r (errnum, buf, buflen);
119 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
120 sstrncpy (buf, temp, buflen);
122 sstrncpy (buf, "strerror_r did not return "
123 "an error message", buflen);
126 /* #endif STRERROR_R_CHAR_P */
129 if (strerror_r (errnum, buf, buflen) != 0)
131 ssnprintf (buf, buflen, "Error #%i; "
132 "Additionally, strerror_r failed.",
135 #endif /* STRERROR_R_CHAR_P */
138 } /* char *sstrerror */
140 void *smalloc (size_t size)
144 if ((r = malloc (size)) == NULL)
146 ERROR ("Not enough memory.");
151 } /* void *smalloc */
154 void sfree (void **ptr)
166 ssize_t sread (int fd, void *buf, size_t count)
177 status = read (fd, (void *) ptr, nleft);
179 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
187 DEBUG ("Received EOF from fd %i. "
188 "Closing fd and returning error.",
194 assert ((0 > status) || (nleft >= (size_t)status));
196 nleft = nleft - status;
204 ssize_t swrite (int fd, const void *buf, size_t count)
210 ptr = (const char *) buf;
215 status = write (fd, (const void *) ptr, nleft);
217 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
223 nleft = nleft - status;
230 int strsplit (char *string, char **fields, size_t size)
239 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
251 int strjoin (char *dst, size_t dst_len,
252 char **fields, size_t fields_num,
259 memset (dst, '\0', dst_len);
266 sep_len = strlen (sep);
268 for (i = 0; i < (int)fields_num; i++)
270 if ((i > 0) && (sep_len > 0))
272 if (dst_len <= sep_len)
275 strncat (dst, sep, dst_len);
279 field_len = strlen (fields[i]);
281 if (dst_len <= field_len)
284 strncat (dst, fields[i], dst_len);
285 dst_len -= field_len;
288 return (strlen (dst));
291 int strsubstitute (char *str, char c_from, char c_to)
310 } /* int strsubstitute */
312 int escape_slashes (char *buf, int buf_len)
316 if (strcmp (buf, "/") == 0)
321 strncpy (buf, "root", buf_len);
328 /* Move one to the left */
330 memmove (buf, buf + 1, buf_len - 1);
332 for (i = 0; i < buf_len - 1; i++)
336 else if (buf[i] == '/')
342 } /* int escape_slashes */
344 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret)
346 if ((tv0 == NULL) || (tv1 == NULL) || (ret == NULL))
349 if ((tv0->tv_sec < tv1->tv_sec)
350 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
353 ret->tv_sec = tv0->tv_sec - tv1->tv_sec;
354 ret->tv_nsec = 1000 * ((long) (tv0->tv_usec - tv1->tv_usec));
356 if (ret->tv_nsec < 0)
358 assert (ret->tv_sec > 0);
360 ret->tv_nsec += 1000000000;
367 int check_create_dir (const char *file_orig)
378 int last_is_file = 1;
379 int path_is_absolute = 0;
384 * Sanity checks first
386 if (file_orig == NULL)
389 if ((len = strlen (file_orig)) < 1)
391 else if (len >= sizeof (file_copy))
395 * If `file_orig' ends in a slash the last component is a directory,
396 * otherwise it's a file. Act accordingly..
398 if (file_orig[len - 1] == '/')
400 if (file_orig[0] == '/')
401 path_is_absolute = 1;
404 * Create a copy for `strtok_r' to destroy
406 sstrncpy (file_copy, file_orig, sizeof (file_copy));
409 * Break into components. This will eat up several slashes in a row and
410 * remove leading and trailing slashes..
415 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
420 if (fields_num >= 16)
425 * For each component, do..
427 for (i = 0; i < (fields_num - last_is_file); i++)
430 * Do not create directories that start with a dot. This
431 * prevents `../../' attacks and other likely malicious
434 if (fields[i][0] == '.')
436 ERROR ("Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
441 * Join the components together again
444 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
445 fields, i + 1, "/") < 0)
447 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
451 if (stat (dir, &statbuf) == -1)
455 if (mkdir (dir, 0755) == -1)
458 ERROR ("check_create_dir: mkdir (%s): %s", dir,
460 errbuf, sizeof (errbuf)));
467 ERROR ("stat (%s): %s", dir,
468 sstrerror (errno, errbuf,
473 else if (!S_ISDIR (statbuf.st_mode))
475 ERROR ("stat (%s): Not a directory!", dir);
481 } /* check_create_dir */
484 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
491 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
493 if (*ksp_ptr == NULL)
495 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
497 ERROR ("Cound not find kstat %s", ident);
501 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
503 WARNING ("kstat %s has wrong type", ident);
510 assert (*ksp_ptr != NULL);
511 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
514 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
516 WARNING ("kstat %s could not be read", ident);
520 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
522 WARNING ("kstat %s has wrong type", ident);
529 long long get_kstat_value (kstat_t *ksp, char *name)
532 long long retval = -1LL;
535 assert (ksp != NULL);
536 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
540 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
543 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
545 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
550 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
553 if (kn->data_type == KSTAT_DATA_INT32)
554 retval = (long long) kn->value.i32;
555 else if (kn->data_type == KSTAT_DATA_UINT32)
556 retval = (long long) kn->value.ui32;
557 else if (kn->data_type == KSTAT_DATA_INT64)
558 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
559 else if (kn->data_type == KSTAT_DATA_UINT64)
560 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
562 WARNING ("get_kstat_value: Not a numeric value: %s", name);
566 #endif /* HAVE_LIBKSTAT */
568 unsigned long long ntohll (unsigned long long n)
570 #if BYTE_ORDER == BIG_ENDIAN
573 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
575 } /* unsigned long long ntohll */
577 unsigned long long htonll (unsigned long long n)
579 #if BYTE_ORDER == BIG_ENDIAN
582 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
584 } /* unsigned long long htonll */
586 #if FP_LAYOUT_NEED_NOTHING
587 /* Well, we need nothing.. */
588 /* #endif FP_LAYOUT_NEED_NOTHING */
590 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
591 # if FP_LAYOUT_NEED_ENDIANFLIP
592 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
593 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
594 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
595 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
596 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
597 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
598 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
599 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
601 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
602 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
605 double ntohd (double d)
616 /* NAN in x86 byte order */
617 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
618 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
619 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
620 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
629 ret.integer = FP_CONVERT (tmp);
630 return (ret.floating);
634 double htond (double d)
645 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
646 ret.byte[4] = ret.byte[5] = 0x00;
649 return (ret.floating);
656 tmp = FP_CONVERT (ret.integer);
658 return (ret.floating);
661 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
663 int format_name (char *ret, int ret_len,
664 const char *hostname,
665 const char *plugin, const char *plugin_instance,
666 const char *type, const char *type_instance)
670 assert (plugin != NULL);
671 assert (type != NULL);
673 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
675 if ((type_instance == NULL) || (strlen (type_instance) == 0))
676 status = ssnprintf (ret, ret_len, "%s/%s/%s",
677 hostname, plugin, type);
679 status = ssnprintf (ret, ret_len, "%s/%s/%s-%s",
680 hostname, plugin, type,
685 if ((type_instance == NULL) || (strlen (type_instance) == 0))
686 status = ssnprintf (ret, ret_len, "%s/%s-%s/%s",
687 hostname, plugin, plugin_instance,
690 status = ssnprintf (ret, ret_len, "%s/%s-%s/%s-%s",
691 hostname, plugin, plugin_instance,
692 type, type_instance);
695 if ((status < 1) || (status >= ret_len))
698 } /* int format_name */
700 int parse_identifier (char *str, char **ret_host,
701 char **ret_plugin, char **ret_plugin_instance,
702 char **ret_type, char **ret_type_instance)
704 char *hostname = NULL;
706 char *plugin_instance = NULL;
708 char *type_instance = NULL;
711 if (hostname == NULL)
714 plugin = strchr (hostname, '/');
717 *plugin = '\0'; plugin++;
719 type = strchr (plugin, '/');
722 *type = '\0'; type++;
724 plugin_instance = strchr (plugin, '-');
725 if (plugin_instance != NULL)
727 *plugin_instance = '\0';
731 type_instance = strchr (type, '-');
732 if (type_instance != NULL)
734 *type_instance = '\0';
738 *ret_host = hostname;
739 *ret_plugin = plugin;
740 *ret_plugin_instance = plugin_instance;
742 *ret_type_instance = type_instance;
744 } /* int parse_identifier */
746 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
756 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
760 if (i >= vl->values_len)
765 if (strcmp ("N", ptr) == 0)
766 vl->time = time (NULL);
768 vl->time = (time_t) atoi (ptr);
772 if (strcmp ("U", ptr) == 0)
773 vl->values[i].gauge = NAN;
774 else if (ds->ds[i].type == DS_TYPE_COUNTER)
775 vl->values[i].counter = atoll (ptr);
776 else if (ds->ds[i].type == DS_TYPE_GAUGE)
777 vl->values[i].gauge = atof (ptr);
781 } /* while (strtok_r) */
783 if ((ptr != NULL) || (i != vl->values_len))
786 } /* int parse_values */
789 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
790 size_t buflen, struct passwd **pwbufp)
795 memset (pwbuf, '\0', sizeof (struct passwd));
797 pthread_mutex_lock (&getpwnam_r_lock);
801 pw = getpwnam (name);
804 status = (errno != 0) ? errno : ENOENT;
808 #define GETPWNAM_COPY_MEMBER(member) \
809 if (pw->member != NULL) \
811 int len = strlen (pw->member); \
817 sstrncpy (buf, pw->member, buflen); \
818 pwbuf->member = buf; \
820 buflen -= (len + 1); \
822 GETPWNAM_COPY_MEMBER(pw_name);
823 GETPWNAM_COPY_MEMBER(pw_passwd);
824 GETPWNAM_COPY_MEMBER(pw_gecos);
825 GETPWNAM_COPY_MEMBER(pw_dir);
826 GETPWNAM_COPY_MEMBER(pw_shell);
828 pwbuf->pw_uid = pw->pw_uid;
829 pwbuf->pw_gid = pw->pw_gid;
835 pthread_mutex_unlock (&getpwnam_r_lock);
838 } /* int getpwnam_r */
839 #endif /* !HAVE_GETPWNAM_R */
841 int notification_init (notification_t *n, int severity, const char *message,
843 const char *plugin, const char *plugin_instance,
844 const char *type, const char *type_instance)
846 memset (n, '\0', sizeof (notification_t));
848 n->severity = severity;
851 sstrncpy (n->message, message, sizeof (n->message));
853 sstrncpy (n->host, host, sizeof (n->host));
855 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
856 if (plugin_instance != NULL)
857 sstrncpy (n->plugin_instance, plugin_instance,
858 sizeof (n->plugin_instance));
860 sstrncpy (n->type, type, sizeof (n->type));
861 if (type_instance != NULL)
862 sstrncpy (n->type_instance, type_instance,
863 sizeof (n->type_instance));
866 } /* int notification_init */
868 int walk_directory (const char *dir, dirwalk_callback_f callback,
879 if ((dh = opendir (dir)) == NULL)
882 ERROR ("walk_directory: Cannot open '%s': %s", dir,
883 sstrerror (errno, errbuf, sizeof (errbuf)));
887 while ((ent = readdir (dh)) != NULL)
891 if (ent->d_name[0] == '.')
894 status = (*callback) (dir, ent->d_name, user_data);
903 if ((success == 0) && (failure > 0))
908 int read_file_contents (const char *filename, char *buf, int bufsize)
913 if ((fh = fopen (filename, "r")) == NULL)
916 n = fread(buf, 1, bufsize, fh);