2 * collectd - src/common.c
3 * Copyright (C) 2005,2006 Florian octo Forster
5 * This program is free software; you can redistribute it and/
6 * or modify it under the terms of the GNU General Public Li-
7 * cence as published by the Free Software Foundation; either
8 * version 2 of the Licence, or any later version.
10 * This program is distributed in the hope that it will be use-
11 * ful, but WITHOUT ANY WARRANTY; without even the implied war-
12 * ranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 * See the GNU General Public Licence for more details.
15 * You should have received a copy of the GNU General Public
16 * Licence along with this program; if not, write to the Free
17 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
21 * Florian octo Forster <octo at verplant.org>
22 * Niki W. Waibel <niki.waibel@gmx.net>
26 #include "utils_debug.h"
32 extern int operating_mode;
35 extern kstat_ctl_t *kc;
40 static char *rra_def[] =
42 "RRA:AVERAGE:0.0:1:1500",
43 "RRA:AVERAGE:0.2:6:1500",
44 "RRA:AVERAGE:0.1:180:1680",
45 "RRA:AVERAGE:0.1:2160:1520",
48 "RRA:MIN:0.1:180:1680",
49 "RRA:MIN:0.1:2160:1520",
52 "RRA:MAX:0.1:180:1680",
53 "RRA:MAX:0.1:2160:1520",
56 static int rra_num = 12;
59 static int rra_timespans[] =
68 static int rra_timespans_num = 5;
70 static char *rra_types[] =
77 static int rra_types_num = 3;
78 #endif /* HAVE_LIBRRD */
80 void sstrncpy (char *d, const char *s, int len)
86 char *sstrdup (const char *s)
93 if((r = strdup (s)) == NULL)
95 DBG ("Not enough memory.");
102 void *smalloc (size_t size)
106 if ((r = malloc (size)) == NULL)
108 DBG("Not enough memory.");
116 void sfree (void **ptr)
128 ssize_t sread (int fd, void *buf, size_t count)
139 status = read (fd, (void *) ptr, nleft);
141 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
149 DBG ("Received EOF from fd %i. "
150 "Closing fd and returning error.",
156 assert (nleft >= status);
158 nleft = nleft - status;
166 ssize_t swrite (int fd, const void *buf, size_t count)
172 ptr = (const char *) buf;
177 status = write (fd, (const void *) ptr, nleft);
179 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
185 nleft = nleft - status;
192 int strsplit (char *string, char **fields, size_t size)
199 while ((fields[i] = strtok (ptr, " \t")) != NULL)
211 int strjoin (char *dst, size_t dst_len,
212 char **fields, size_t fields_num,
219 memset (dst, '\0', dst_len);
226 sep_len = strlen (sep);
228 for (i = 0; i < fields_num; i++)
230 if ((i > 0) && (sep_len > 0))
232 if (dst_len <= sep_len)
235 strncat (dst, sep, dst_len);
239 field_len = strlen (fields[i]);
241 if (dst_len <= field_len)
244 strncat (dst, fields[i], dst_len);
245 dst_len -= field_len;
248 return (strlen (dst));
251 int strsubstitute (char *str, char c_from, char c_to)
272 int escape_slashes (char *buf, int buf_len)
276 if (strcmp (buf, "/") == 0)
281 strncpy (buf, "root", buf_len);
285 /* Move one to the left */
286 memmove (buf, buf + 1, buf_len - 1);
288 for (i = 0; i < buf_len - 1; i++)
292 else if (buf[i] == '/')
300 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret)
302 if ((tv0 == NULL) || (tv1 == NULL) || (ret == NULL))
305 if ((tv0->tv_sec < tv1->tv_sec)
306 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
309 ret->tv_sec = tv0->tv_sec - tv1->tv_sec;
310 ret->tv_nsec = 1000 * ((long) (tv0->tv_usec - tv1->tv_usec));
312 if (ret->tv_nsec < 0)
314 assert (ret->tv_sec > 0);
316 ret->tv_nsec += 1000000000;
323 static int check_create_dir (const char *file_orig)
333 int last_is_file = 1;
338 * Sanity checks first
340 if (file_orig == NULL)
343 if ((len = strlen (file_orig)) < 1)
349 * If `file_orig' ends in a slash the last component is a directory,
350 * otherwise it's a file. Act accordingly..
352 if (file_orig[len - 1] == '/')
356 * Create a copy for `strtok' to destroy
358 strncpy (file_copy, file_orig, 512);
359 file_copy[511] = '\0';
362 * Break into components. This will eat up several slashes in a row and
363 * remove leading and trailing slashes..
367 while ((fields[fields_num] = strtok (ptr, "/")) != NULL)
372 if (fields_num >= 16)
377 * For each component, do..
379 for (i = 0; i < (fields_num - last_is_file); i++)
382 * Do not create directories that start with a dot. This
383 * prevents `../../' attacks and other likely malicious
386 if (fields[i][0] == '.')
388 syslog (LOG_ERR, "Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
393 * Join the components together again
395 if (strjoin (dir, dir_len, fields, i + 1, "/") < 0)
397 syslog (LOG_ERR, "strjoin failed: `%s', component #%i", file_orig, i);
401 if (stat (dir, &statbuf) == -1)
405 if (mkdir (dir, 0755) == -1)
407 syslog (LOG_ERR, "mkdir (%s): %s", dir, strerror (errno));
413 syslog (LOG_ERR, "stat (%s): %s", dir, strerror (errno));
417 else if (!S_ISDIR (statbuf.st_mode))
419 syslog (LOG_ERR, "stat (%s): Not a directory!", dir);
431 static int rra_get (char ***ret)
433 static char **rra_def = NULL;
434 static int rra_num = 0;
436 int rra_max = rra_timespans_num * rra_types_num;
448 if ((rra_num != 0) && (rra_def != NULL))
454 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
456 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
458 step = atoi (COLLECTD_STEP);
459 rows = atoi (COLLECTD_ROWS);
461 if ((step <= 0) || (rows <= 0))
468 for (i = 0; i < rra_timespans_num; i++)
470 span = rra_timespans[i];
472 if ((span / step) < rows)
478 cdp_len = (int) floor (((double) span) / ((double) (rows * step)));
480 cdp_num = (int) ceil (((double) span) / ((double) (cdp_len * step)));
482 for (j = 0; j < rra_types_num; j++)
484 if (rra_num >= rra_max)
487 if (snprintf (buffer, sizeof(buffer), "RRA:%s:%3.1f:%u:%u",
488 rra_types[j], COLLECTD_XFF,
489 cdp_len, cdp_num) >= sizeof (buffer))
491 syslog (LOG_ERR, "rra_get: Buffer would have been truncated.");
495 rra_def[rra_num++] = sstrdup (buffer);
500 DBG ("rra_num = %i", rra_num);
501 for (i = 0; i < rra_num; i++)
502 DBG (" %s", rra_def[i]);
508 #endif /* HAVE_LIBRRD */
510 static int log_create_file (char *filename, char **ds_def, int ds_num)
515 if (check_create_dir (filename))
518 log = fopen (filename, "w");
521 syslog (LOG_WARNING, "Failed to create %s: %s", filename,
526 fprintf (log, "epoch");
527 for (i = 0; i < ds_num; i++)
532 name = strchr (ds_def[i], ':');
535 syslog (LOG_WARNING, "Invalid DS definition '%s' for %s",
536 ds_def[i], filename);
543 tmp = strchr (name, ':');
546 syslog (LOG_WARNING, "Invalid DS definition '%s' for %s",
547 ds_def[i], filename);
553 /* The `%.*s' is needed because there is no null-byte behind
555 fprintf(log, ",%.*s", (int) (tmp - name), name);
563 static int log_update_file (char *host, char *file, char *values,
564 char **ds_def, int ds_num)
569 char full_file[1024];
571 /* Cook the values a bit: Substitute colons with commas */
572 strsubstitute (values, ':', ',');
574 /* host == NULL => local mode */
577 if (snprintf (full_file, 1024, "%s/%s", host, file) >= 1024)
582 if (snprintf (full_file, 1024, "%s", file) >= 1024)
586 strncpy (full_file, file, 1024);
588 tmp = full_file + strlen (full_file) - 4;
589 assert ((tmp != NULL) && (tmp > full_file));
591 /* Change the filename for logfiles. */
592 if (strncmp (tmp, ".rrd", 4) == 0)
597 /* TODO: Find a way to minimize the calls to `localtime', since
598 * they are pretty expensive.. */
600 tm = localtime (&now);
602 strftime (tmp, 1024 - (tmp - full_file), "-%Y-%m-%d", tm);
604 /* `localtime(3)' returns a pointer to static data,
605 * therefore the pointer may not be free'd. */
608 DBG ("The filename ends with `%s' which is unexpected.", tmp);
610 if (stat (full_file, &statbuf) == -1)
614 if (log_create_file (full_file, ds_def, ds_num))
619 syslog (LOG_ERR, "stat %s: %s", full_file, strerror (errno));
623 else if (!S_ISREG (statbuf.st_mode))
625 syslog (LOG_ERR, "stat %s: Not a regular file!", full_file);
630 fp = fopen (full_file, "a");
633 syslog (LOG_WARNING, "Failed to append to %s: %s", full_file,
637 fprintf(fp, "%s\n", values);
641 } /* int log_update_file */
644 static int rrd_create_file (char *filename, char **ds_def, int ds_num)
653 if (check_create_dir (filename))
656 if ((rra_num = rra_get (&rra_def)) < 1)
658 syslog (LOG_ERR, "rra_create failed: Could not calculate RRAs");
662 argc = ds_num + rra_num + 4;
664 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
666 syslog (LOG_ERR, "rrd_create failed: %s", strerror (errno));
673 argv[3] = COLLECTD_STEP;
676 for (i = 0; i < ds_num; i++)
677 argv[j++] = ds_def[i];
678 for (i = 0; i < rra_num; i++)
679 argv[j++] = rra_def[i];
682 optind = 0; /* bug in librrd? */
684 if (rrd_create (argc, argv) == -1)
686 syslog (LOG_ERR, "rrd_create failed: %s: %s", filename, rrd_get_error ());
694 #endif /* HAVE_LIBRRD */
696 int rrd_update_file (char *host, char *file, char *values,
697 char **ds_def, int ds_num)
701 char full_file[1024];
702 char *argv[4] = { "update", full_file, values, NULL };
703 #endif /* HAVE_LIBRRD */
705 /* I'd rather have a function `common_update_file' to make this
706 * decission, but for that we'd need to touch all plugins.. */
707 if (operating_mode == MODE_LOG)
708 return (log_update_file (host, file, values,
712 /* host == NULL => local mode */
715 if (snprintf (full_file, 1024, "%s/%s", host, file) >= 1024)
720 if (snprintf (full_file, 1024, "%s", file) >= 1024)
724 if (stat (full_file, &statbuf) == -1)
728 if (rrd_create_file (full_file, ds_def, ds_num))
733 syslog (LOG_ERR, "stat %s: %s", full_file, strerror (errno));
737 else if (!S_ISREG (statbuf.st_mode))
739 syslog (LOG_ERR, "stat %s: Not a regular file!", full_file);
743 optind = 0; /* bug in librrd? */
745 if (rrd_update (3, argv) == -1)
747 syslog (LOG_WARNING, "rrd_update failed: %s: %s", full_file, rrd_get_error ());
751 /* #endif HAVE_LIBRRD */
754 syslog (LOG_ERR, "`rrd_update_file' was called, but collectd isn't linked against librrd!");
760 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
767 snprintf (ident, 128, "%s,%i,%s", module, instance, name);
770 if (*ksp_ptr == NULL)
772 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
774 syslog (LOG_ERR, "Cound not find kstat %s", ident);
778 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
780 syslog (LOG_WARNING, "kstat %s has wrong type", ident);
787 assert (*ksp_ptr != NULL);
788 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
791 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
793 syslog (LOG_WARNING, "kstat %s could not be read", ident);
797 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
799 syslog (LOG_WARNING, "kstat %s has wrong type", ident);
806 long long get_kstat_value (kstat_t *ksp, char *name)
809 long long retval = -1LL;
812 assert (ksp != NULL);
813 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
817 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
820 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
822 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
827 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
830 if (kn->data_type == KSTAT_DATA_INT32)
831 retval = (long long) kn->value.i32;
832 else if (kn->data_type == KSTAT_DATA_UINT32)
833 retval = (long long) kn->value.ui32;
834 else if (kn->data_type == KSTAT_DATA_INT64)
835 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
836 else if (kn->data_type == KSTAT_DATA_UINT64)
837 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
839 syslog (LOG_WARNING, "get_kstat_value: Not a numeric value: %s", name);
843 #endif /* HAVE_LIBKSTAT */