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 char *sstrdup (const char *s)
71 if((r = strdup (s)) == NULL)
73 DEBUG ("Not enough memory.");
80 /* Even though Posix requires "strerror_r" to return an "int",
81 * some systems (e.g. the GNU libc) return a "char *" _and_
82 * ignore the second argument ... -tokkee */
83 char *sstrerror (int errnum, char *buf, size_t buflen)
91 pthread_mutex_lock (&strerror_r_lock);
93 temp = strerror (errnum);
94 strncpy (buf, temp, buflen);
96 pthread_mutex_unlock (&strerror_r_lock);
98 /* #endif !HAVE_STRERROR_R */
100 #elif STRERROR_R_CHAR_P
103 temp = strerror_r (errnum, buf, buflen);
106 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
107 strncpy (buf, temp, buflen);
109 strncpy (buf, "strerror_r did not return "
110 "an error message", buflen);
113 /* #endif STRERROR_R_CHAR_P */
116 if (strerror_r (errnum, buf, buflen) != 0)
118 snprintf (buf, buflen, "Error #%i; "
119 "Additionally, strerror_r failed.",
122 #endif /* STRERROR_R_CHAR_P */
124 buf[buflen - 1] = '\0';
126 } /* char *sstrerror */
128 void *smalloc (size_t size)
132 if ((r = malloc (size)) == NULL)
134 DEBUG("Not enough memory.");
142 void sfree (void **ptr)
154 ssize_t sread (int fd, void *buf, size_t count)
165 status = read (fd, (void *) ptr, nleft);
167 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
175 DEBUG ("Received EOF from fd %i. "
176 "Closing fd and returning error.",
182 assert ((0 > status) || (nleft >= (size_t)status));
184 nleft = nleft - status;
192 ssize_t swrite (int fd, const void *buf, size_t count)
198 ptr = (const char *) buf;
203 status = write (fd, (const void *) ptr, nleft);
205 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
211 nleft = nleft - status;
218 int strsplit (char *string, char **fields, size_t size)
227 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
239 int strjoin (char *dst, size_t dst_len,
240 char **fields, size_t fields_num,
247 memset (dst, '\0', dst_len);
254 sep_len = strlen (sep);
256 for (i = 0; i < (int)fields_num; i++)
258 if ((i > 0) && (sep_len > 0))
260 if (dst_len <= sep_len)
263 strncat (dst, sep, dst_len);
267 field_len = strlen (fields[i]);
269 if (dst_len <= field_len)
272 strncat (dst, fields[i], dst_len);
273 dst_len -= field_len;
276 return (strlen (dst));
279 int strsubstitute (char *str, char c_from, char c_to)
298 } /* int strsubstitute */
300 int escape_slashes (char *buf, int buf_len)
304 if (strcmp (buf, "/") == 0)
309 strncpy (buf, "root", buf_len);
316 /* Move one to the left */
318 memmove (buf, buf + 1, buf_len - 1);
320 for (i = 0; i < buf_len - 1; i++)
324 else if (buf[i] == '/')
330 } /* int escape_slashes */
332 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret)
334 if ((tv0 == NULL) || (tv1 == NULL) || (ret == NULL))
337 if ((tv0->tv_sec < tv1->tv_sec)
338 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
341 ret->tv_sec = tv0->tv_sec - tv1->tv_sec;
342 ret->tv_nsec = 1000 * ((long) (tv0->tv_usec - tv1->tv_usec));
344 if (ret->tv_nsec < 0)
346 assert (ret->tv_sec > 0);
348 ret->tv_nsec += 1000000000;
355 int check_create_dir (const char *file_orig)
366 int last_is_file = 1;
367 int path_is_absolute = 0;
372 * Sanity checks first
374 if (file_orig == NULL)
377 if ((len = strlen (file_orig)) < 1)
383 * If `file_orig' ends in a slash the last component is a directory,
384 * otherwise it's a file. Act accordingly..
386 if (file_orig[len - 1] == '/')
388 if (file_orig[0] == '/')
389 path_is_absolute = 1;
392 * Create a copy for `strtok_r' to destroy
394 strncpy (file_copy, file_orig, 512);
395 file_copy[511] = '\0';
398 * Break into components. This will eat up several slashes in a row and
399 * remove leading and trailing slashes..
404 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
409 if (fields_num >= 16)
414 * For each component, do..
416 for (i = 0; i < (fields_num - last_is_file); i++)
419 * Do not create directories that start with a dot. This
420 * prevents `../../' attacks and other likely malicious
423 if (fields[i][0] == '.')
425 ERROR ("Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
430 * Join the components together again
433 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
434 fields, i + 1, "/") < 0)
436 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
440 if (stat (dir, &statbuf) == -1)
444 if (mkdir (dir, 0755) == -1)
447 ERROR ("check_create_dir: mkdir (%s): %s", dir,
449 errbuf, sizeof (errbuf)));
456 ERROR ("stat (%s): %s", dir,
457 sstrerror (errno, errbuf,
462 else if (!S_ISDIR (statbuf.st_mode))
464 ERROR ("stat (%s): Not a directory!", dir);
470 } /* check_create_dir */
473 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
480 snprintf (ident, 128, "%s,%i,%s", module, instance, name);
483 if (*ksp_ptr == NULL)
485 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
487 ERROR ("Cound not find kstat %s", ident);
491 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
493 WARNING ("kstat %s has wrong type", ident);
500 assert (*ksp_ptr != NULL);
501 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
504 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
506 WARNING ("kstat %s could not be read", ident);
510 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
512 WARNING ("kstat %s has wrong type", ident);
519 long long get_kstat_value (kstat_t *ksp, char *name)
522 long long retval = -1LL;
525 assert (ksp != NULL);
526 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
530 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
533 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
535 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
540 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
543 if (kn->data_type == KSTAT_DATA_INT32)
544 retval = (long long) kn->value.i32;
545 else if (kn->data_type == KSTAT_DATA_UINT32)
546 retval = (long long) kn->value.ui32;
547 else if (kn->data_type == KSTAT_DATA_INT64)
548 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
549 else if (kn->data_type == KSTAT_DATA_UINT64)
550 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
552 WARNING ("get_kstat_value: Not a numeric value: %s", name);
556 #endif /* HAVE_LIBKSTAT */
558 unsigned long long ntohll (unsigned long long n)
560 #if BYTE_ORDER == BIG_ENDIAN
563 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
565 } /* unsigned long long ntohll */
567 unsigned long long htonll (unsigned long long n)
569 #if BYTE_ORDER == BIG_ENDIAN
572 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
574 } /* unsigned long long htonll */
576 #if FP_LAYOUT_NEED_NOTHING
577 /* Well, we need nothing.. */
578 /* #endif FP_LAYOUT_NEED_NOTHING */
580 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
581 # if FP_LAYOUT_NEED_ENDIANFLIP
582 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
583 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
584 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
585 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
586 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
587 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
588 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
589 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
591 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
592 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
595 double ntohd (double d)
606 /* NAN in x86 byte order */
607 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
608 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
609 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
610 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
619 ret.integer = FP_CONVERT (tmp);
620 return (ret.floating);
624 double htond (double d)
635 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
636 ret.byte[4] = ret.byte[5] = 0x00;
639 return (ret.floating);
646 tmp = FP_CONVERT (ret.integer);
648 return (ret.floating);
651 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
653 int format_name (char *ret, int ret_len,
654 const char *hostname,
655 const char *plugin, const char *plugin_instance,
656 const char *type, const char *type_instance)
660 assert (plugin != NULL);
661 assert (type != NULL);
663 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
665 if ((type_instance == NULL) || (strlen (type_instance) == 0))
666 status = snprintf (ret, ret_len, "%s/%s/%s",
667 hostname, plugin, type);
669 status = snprintf (ret, ret_len, "%s/%s/%s-%s",
670 hostname, plugin, type,
675 if ((type_instance == NULL) || (strlen (type_instance) == 0))
676 status = snprintf (ret, ret_len, "%s/%s-%s/%s",
677 hostname, plugin, plugin_instance,
680 status = snprintf (ret, ret_len, "%s/%s-%s/%s-%s",
681 hostname, plugin, plugin_instance,
682 type, type_instance);
685 if ((status < 1) || (status >= ret_len))
688 } /* int format_name */
690 int parse_identifier (char *str, char **ret_host,
691 char **ret_plugin, char **ret_plugin_instance,
692 char **ret_type, char **ret_type_instance)
694 char *hostname = NULL;
696 char *plugin_instance = NULL;
698 char *type_instance = NULL;
701 if (hostname == NULL)
704 plugin = strchr (hostname, '/');
707 *plugin = '\0'; plugin++;
709 type = strchr (plugin, '/');
712 *type = '\0'; type++;
714 plugin_instance = strchr (plugin, '-');
715 if (plugin_instance != NULL)
717 *plugin_instance = '\0';
721 type_instance = strchr (type, '-');
722 if (type_instance != NULL)
724 *type_instance = '\0';
728 *ret_host = hostname;
729 *ret_plugin = plugin;
730 *ret_plugin_instance = plugin_instance;
732 *ret_type_instance = type_instance;
734 } /* int parse_identifier */
736 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
746 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
750 if (i >= vl->values_len)
755 if (strcmp ("N", ptr) == 0)
756 vl->time = time (NULL);
758 vl->time = (time_t) atoi (ptr);
762 if (strcmp ("U", ptr) == 0)
763 vl->values[i].gauge = NAN;
764 else if (ds->ds[i].type == DS_TYPE_COUNTER)
765 vl->values[i].counter = atoll (ptr);
766 else if (ds->ds[i].type == DS_TYPE_GAUGE)
767 vl->values[i].gauge = atof (ptr);
771 } /* while (strtok_r) */
773 if ((ptr != NULL) || (i != vl->values_len))
776 } /* int parse_values */
779 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
780 size_t buflen, struct passwd **pwbufp)
785 memset (pwbuf, '\0', sizeof (struct passwd));
787 pthread_mutex_lock (&getpwnam_r_lock);
791 pw = getpwnam (name);
794 status = (errno != 0) ? errno : ENOENT;
798 #define GETPWNAM_COPY_MEMBER(member) \
799 if (pw->member != NULL) \
801 int len = strlen (pw->member); \
807 sstrncpy (buf, pw->member, buflen); \
808 pwbuf->member = buf; \
810 buflen -= (len + 1); \
812 GETPWNAM_COPY_MEMBER(pw_name);
813 GETPWNAM_COPY_MEMBER(pw_passwd);
814 GETPWNAM_COPY_MEMBER(pw_gecos);
815 GETPWNAM_COPY_MEMBER(pw_dir);
816 GETPWNAM_COPY_MEMBER(pw_shell);
818 pwbuf->pw_uid = pw->pw_uid;
819 pwbuf->pw_gid = pw->pw_gid;
825 pthread_mutex_unlock (&getpwnam_r_lock);
828 } /* int getpwnam_r */
829 #endif /* !HAVE_GETPWNAM_R */
831 int notification_init (notification_t *n, int severity, const char *message,
833 const char *plugin, const char *plugin_instance,
834 const char *type, const char *type_instance)
836 memset (n, '\0', sizeof (notification_t));
838 n->severity = severity;
841 strncpy (n->message, message, sizeof (n->message));
843 strncpy (n->host, host, sizeof (n->host));
845 strncpy (n->plugin, plugin, sizeof (n->plugin));
846 if (plugin_instance != NULL)
847 strncpy (n->plugin_instance, plugin_instance,
848 sizeof (n->plugin_instance));
850 strncpy (n->type, type, sizeof (n->type));
851 if (type_instance != NULL)
852 strncpy (n->type_instance, type_instance,
853 sizeof (n->type_instance));
855 n->message[sizeof (n->message) - 1] = '\0';
856 n->host[sizeof (n->host) - 1] = '\0';
857 n->plugin[sizeof (n->plugin) - 1] = '\0';
858 n->plugin_instance[sizeof (n->plugin_instance) - 1] = '\0';
859 n->type[sizeof (n->type) - 1] = '\0';
860 n->type_instance[sizeof (n->type_instance) - 1] = '\0';
863 } /* int notification_init */