2 * collectd - src/common.c
3 * Copyright (C) 2005-2007 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>
38 /* for ntohl and htonl */
40 # include <arpa/inet.h>
44 extern kstat_ctl_t *kc;
48 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
51 void sstrncpy (char *d, const char *s, int len)
57 char *sstrdup (const char *s)
64 if((r = strdup (s)) == NULL)
66 DEBUG ("Not enough memory.");
73 /* Even though Posix requires "strerror_r" to return an "int",
74 * some systems (e.g. the GNU libc) return a "char *" _and_
75 * ignore the second argument ... -tokkee */
76 char *sstrerror (int errnum, char *buf, size_t buflen)
79 #ifdef STRERROR_R_CHAR_P
80 buf = strerror_r (errnum, buf, buflen);
82 strerror_r (errnum, buf, buflen);
83 #endif /* STRERROR_R_CHAR_P */
85 } /* char *sstrerror */
87 void *smalloc (size_t size)
91 if ((r = malloc (size)) == NULL)
93 DEBUG("Not enough memory.");
101 void sfree (void **ptr)
113 ssize_t sread (int fd, void *buf, size_t count)
124 status = read (fd, (void *) ptr, nleft);
126 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
134 DEBUG ("Received EOF from fd %i. "
135 "Closing fd and returning error.",
141 assert (nleft >= status);
143 nleft = nleft - status;
151 ssize_t swrite (int fd, const void *buf, size_t count)
157 ptr = (const char *) buf;
162 status = write (fd, (const void *) ptr, nleft);
164 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
170 nleft = nleft - status;
177 int strsplit (char *string, char **fields, size_t size)
186 while ((fields[i] = strtok_r (ptr, " \t", &saveptr)) != NULL)
198 int strjoin (char *dst, size_t dst_len,
199 char **fields, size_t fields_num,
206 memset (dst, '\0', dst_len);
213 sep_len = strlen (sep);
215 for (i = 0; i < fields_num; i++)
217 if ((i > 0) && (sep_len > 0))
219 if (dst_len <= sep_len)
222 strncat (dst, sep, dst_len);
226 field_len = strlen (fields[i]);
228 if (dst_len <= field_len)
231 strncat (dst, fields[i], dst_len);
232 dst_len -= field_len;
235 return (strlen (dst));
238 int strsubstitute (char *str, char c_from, char c_to)
257 } /* int strsubstitute */
259 int escape_slashes (char *buf, int buf_len)
263 if (strcmp (buf, "/") == 0)
268 strncpy (buf, "root", buf_len);
275 /* Move one to the left */
277 memmove (buf, buf + 1, buf_len - 1);
279 for (i = 0; i < buf_len - 1; i++)
283 else if (buf[i] == '/')
289 } /* int escape_slashes */
291 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret)
293 if ((tv0 == NULL) || (tv1 == NULL) || (ret == NULL))
296 if ((tv0->tv_sec < tv1->tv_sec)
297 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
300 ret->tv_sec = tv0->tv_sec - tv1->tv_sec;
301 ret->tv_nsec = 1000 * ((long) (tv0->tv_usec - tv1->tv_usec));
303 if (ret->tv_nsec < 0)
305 assert (ret->tv_sec > 0);
307 ret->tv_nsec += 1000000000;
314 int check_create_dir (const char *file_orig)
325 int last_is_file = 1;
326 int path_is_absolute = 0;
331 * Sanity checks first
333 if (file_orig == NULL)
336 if ((len = strlen (file_orig)) < 1)
342 * If `file_orig' ends in a slash the last component is a directory,
343 * otherwise it's a file. Act accordingly..
345 if (file_orig[len - 1] == '/')
347 if (file_orig[0] == '/')
348 path_is_absolute = 1;
351 * Create a copy for `strtok_r' to destroy
353 strncpy (file_copy, file_orig, 512);
354 file_copy[511] = '\0';
357 * Break into components. This will eat up several slashes in a row and
358 * remove leading and trailing slashes..
363 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
368 if (fields_num >= 16)
373 * For each component, do..
375 for (i = 0; i < (fields_num - last_is_file); i++)
378 * Do not create directories that start with a dot. This
379 * prevents `../../' attacks and other likely malicious
382 if (fields[i][0] == '.')
384 ERROR ("Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
389 * Join the components together again
392 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
393 fields, i + 1, "/") < 0)
395 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
399 if (stat (dir, &statbuf) == -1)
403 if (mkdir (dir, 0755) == -1)
406 ERROR ("mkdir (%s): %s", dir,
408 errbuf, sizeof (errbuf)));
415 ERROR ("stat (%s): %s", dir,
416 sstrerror (errno, errbuf,
421 else if (!S_ISDIR (statbuf.st_mode))
423 ERROR ("stat (%s): Not a directory!", dir);
432 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
439 snprintf (ident, 128, "%s,%i,%s", module, instance, name);
442 if (*ksp_ptr == NULL)
444 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
446 ERROR ("Cound not find kstat %s", ident);
450 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
452 WARNING ("kstat %s has wrong type", ident);
459 assert (*ksp_ptr != NULL);
460 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
463 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
465 WARNING ("kstat %s could not be read", ident);
469 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
471 WARNING ("kstat %s has wrong type", ident);
478 long long get_kstat_value (kstat_t *ksp, char *name)
481 long long retval = -1LL;
484 assert (ksp != NULL);
485 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
489 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
492 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
494 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
499 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
502 if (kn->data_type == KSTAT_DATA_INT32)
503 retval = (long long) kn->value.i32;
504 else if (kn->data_type == KSTAT_DATA_UINT32)
505 retval = (long long) kn->value.ui32;
506 else if (kn->data_type == KSTAT_DATA_INT64)
507 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
508 else if (kn->data_type == KSTAT_DATA_UINT64)
509 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
511 WARNING ("get_kstat_value: Not a numeric value: %s", name);
515 #endif /* HAVE_LIBKSTAT */
517 unsigned long long ntohll (unsigned long long n)
519 #if __BYTE_ORDER == __BIG_ENDIAN
522 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
524 } /* unsigned long long ntohll */
526 unsigned long long htonll (unsigned long long n)
528 #if __BYTE_ORDER == __BIG_ENDIAN
531 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
533 } /* unsigned long long htonll */
535 int format_name (char *ret, int ret_len,
536 const char *hostname,
537 const char *plugin, const char *plugin_instance,
538 const char *type, const char *type_instance)
542 assert (plugin != NULL);
543 assert (type != NULL);
545 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
547 if ((type_instance == NULL) || (strlen (type_instance) == 0))
548 status = snprintf (ret, ret_len, "%s/%s/%s",
549 hostname, plugin, type);
551 status = snprintf (ret, ret_len, "%s/%s/%s-%s",
552 hostname, plugin, type,
557 if ((type_instance == NULL) || (strlen (type_instance) == 0))
558 status = snprintf (ret, ret_len, "%s/%s-%s/%s",
559 hostname, plugin, plugin_instance,
562 status = snprintf (ret, ret_len, "%s/%s-%s/%s-%s",
563 hostname, plugin, plugin_instance,
564 type, type_instance);
567 if ((status < 1) || (status >= ret_len))
570 } /* int format_name */
572 int parse_identifier (char *str, char **ret_host,
573 char **ret_plugin, char **ret_plugin_instance,
574 char **ret_type, char **ret_type_instance)
576 char *hostname = NULL;
578 char *plugin_instance = NULL;
580 char *type_instance = NULL;
583 if (hostname == NULL)
586 plugin = strchr (hostname, '/');
589 *plugin = '\0'; plugin++;
591 type = strchr (plugin, '/');
594 *type = '\0'; type++;
596 plugin_instance = strchr (plugin, '-');
597 if (plugin_instance != NULL)
599 *plugin_instance = '\0';
603 type_instance = strchr (type, '-');
604 if (type_instance != NULL)
606 *type_instance = '\0';
610 *ret_host = hostname;
611 *ret_plugin = plugin;
612 *ret_plugin_instance = plugin_instance;
614 *ret_type_instance = type_instance;
616 } /* int parse_identifier */
618 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
628 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
632 if (i >= vl->values_len)
637 if (strcmp ("N", ptr) == 0)
638 vl->time = time (NULL);
640 vl->time = (time_t) atoi (ptr);
644 if (strcmp ("U", ptr) == 0)
645 vl->values[i].gauge = NAN;
646 else if (ds->ds[i].type == DS_TYPE_COUNTER)
647 vl->values[i].counter = atoll (ptr);
648 else if (ds->ds[i].type == DS_TYPE_GAUGE)
649 vl->values[i].gauge = atof (ptr);
653 } /* while (strtok_r) */
655 if ((ptr != NULL) || (i != vl->values_len))
658 } /* int parse_values */
661 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
662 size_t buflen, struct passwd **pwbufp)
667 memset (pwbuf, '\0', sizeof (struct passwd));
669 pthread_mutex_lock (&getpwnam_r_lock);
673 pw = getpwnam (name);
676 status = (errno != 0) ? errno : ENOENT;
680 #define GETPWNAM_COPY_MEMBER(member) \
681 if (pw->member != NULL) \
683 int len = strlen (pw->member); \
689 sstrncpy (buf, pw->member, buflen); \
690 pwbuf->member = buf; \
692 buflen -= (len + 1); \
694 GETPWNAM_COPY_MEMBER(pw_name);
695 GETPWNAM_COPY_MEMBER(pw_passwd);
696 GETPWNAM_COPY_MEMBER(pw_gecos);
697 GETPWNAM_COPY_MEMBER(pw_dir);
698 GETPWNAM_COPY_MEMBER(pw_shell);
700 pwbuf->pw_uid = pw->pw_uid;
701 pwbuf->pw_gid = pw->pw_gid;
707 pthread_mutex_unlock (&getpwnam_r_lock);
710 } /* int getpwnam_r */