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>
30 #include "utils_debug.h"
36 extern int operating_mode;
39 extern kstat_ctl_t *kc;
44 static char *rra_def[] =
46 "RRA:AVERAGE:0.0:1:1500",
47 "RRA:AVERAGE:0.2:6:1500",
48 "RRA:AVERAGE:0.1:180:1680",
49 "RRA:AVERAGE:0.1:2160:1520",
52 "RRA:MIN:0.1:180:1680",
53 "RRA:MIN:0.1:2160:1520",
56 "RRA:MAX:0.1:180:1680",
57 "RRA:MAX:0.1:2160:1520",
60 static int rra_num = 12;
63 static int rra_timespans[] =
72 static int rra_timespans_num = 5;
74 static char *rra_types[] =
81 static int rra_types_num = 3;
82 #endif /* HAVE_LIBRRD */
84 void sstrncpy (char *d, const char *s, int len)
90 char *sstrdup (const char *s)
97 if((r = strdup (s)) == NULL)
99 DBG ("Not enough memory.");
106 void *smalloc (size_t size)
110 if ((r = malloc (size)) == NULL)
112 DBG("Not enough memory.");
120 void sfree (void **ptr)
132 ssize_t sread (int fd, void *buf, size_t count)
143 status = read (fd, (void *) ptr, nleft);
145 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
153 DBG ("Received EOF from fd %i. "
154 "Closing fd and returning error.",
160 assert (nleft >= status);
162 nleft = nleft - status;
170 ssize_t swrite (int fd, const void *buf, size_t count)
176 ptr = (const char *) buf;
181 status = write (fd, (const void *) ptr, nleft);
183 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
189 nleft = nleft - status;
196 int strsplit (char *string, char **fields, size_t size)
203 while ((fields[i] = strtok (ptr, " \t")) != NULL)
215 int strjoin (char *dst, size_t dst_len,
216 char **fields, size_t fields_num,
223 memset (dst, '\0', dst_len);
230 sep_len = strlen (sep);
232 for (i = 0; i < fields_num; i++)
234 if ((i > 0) && (sep_len > 0))
236 if (dst_len <= sep_len)
239 strncat (dst, sep, dst_len);
243 field_len = strlen (fields[i]);
245 if (dst_len <= field_len)
248 strncat (dst, fields[i], dst_len);
249 dst_len -= field_len;
252 return (strlen (dst));
255 int strsubstitute (char *str, char c_from, char c_to)
276 int escape_slashes (char *buf, int buf_len)
280 if (strcmp (buf, "/") == 0)
285 strncpy (buf, "root", buf_len);
289 /* Move one to the left */
290 memmove (buf, buf + 1, buf_len - 1);
292 for (i = 0; i < buf_len - 1; i++)
296 else if (buf[i] == '/')
304 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret)
306 if ((tv0 == NULL) || (tv1 == NULL) || (ret == NULL))
309 if ((tv0->tv_sec < tv1->tv_sec)
310 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
313 ret->tv_sec = tv0->tv_sec - tv1->tv_sec;
314 ret->tv_nsec = 1000 * ((long) (tv0->tv_usec - tv1->tv_usec));
316 if (ret->tv_nsec < 0)
318 assert (ret->tv_sec > 0);
320 ret->tv_nsec += 1000000000;
327 static int check_create_dir (const char *file_orig)
337 int last_is_file = 1;
342 * Sanity checks first
344 if (file_orig == NULL)
347 if ((len = strlen (file_orig)) < 1)
353 * If `file_orig' ends in a slash the last component is a directory,
354 * otherwise it's a file. Act accordingly..
356 if (file_orig[len - 1] == '/')
360 * Create a copy for `strtok' to destroy
362 strncpy (file_copy, file_orig, 512);
363 file_copy[511] = '\0';
366 * Break into components. This will eat up several slashes in a row and
367 * remove leading and trailing slashes..
371 while ((fields[fields_num] = strtok (ptr, "/")) != NULL)
376 if (fields_num >= 16)
381 * For each component, do..
383 for (i = 0; i < (fields_num - last_is_file); i++)
386 * Do not create directories that start with a dot. This
387 * prevents `../../' attacks and other likely malicious
390 if (fields[i][0] == '.')
392 syslog (LOG_ERR, "Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
397 * Join the components together again
399 if (strjoin (dir, dir_len, fields, i + 1, "/") < 0)
401 syslog (LOG_ERR, "strjoin failed: `%s', component #%i", file_orig, i);
405 if (stat (dir, &statbuf) == -1)
409 if (mkdir (dir, 0755) == -1)
411 syslog (LOG_ERR, "mkdir (%s): %s", dir, strerror (errno));
417 syslog (LOG_ERR, "stat (%s): %s", dir, strerror (errno));
421 else if (!S_ISDIR (statbuf.st_mode))
423 syslog (LOG_ERR, "stat (%s): Not a directory!", dir);
435 static int rra_get (char ***ret)
437 static char **rra_def = NULL;
438 static int rra_num = 0;
440 int rra_max = rra_timespans_num * rra_types_num;
452 if ((rra_num != 0) && (rra_def != NULL))
458 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
460 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
462 step = atoi (COLLECTD_STEP);
463 rows = atoi (COLLECTD_ROWS);
465 if ((step <= 0) || (rows <= 0))
472 for (i = 0; i < rra_timespans_num; i++)
474 span = rra_timespans[i];
476 if ((span / step) < rows)
482 cdp_len = (int) floor (((double) span) / ((double) (rows * step)));
484 cdp_num = (int) ceil (((double) span) / ((double) (cdp_len * step)));
486 for (j = 0; j < rra_types_num; j++)
488 if (rra_num >= rra_max)
491 if (snprintf (buffer, sizeof(buffer), "RRA:%s:%3.1f:%u:%u",
492 rra_types[j], COLLECTD_XFF,
493 cdp_len, cdp_num) >= sizeof (buffer))
495 syslog (LOG_ERR, "rra_get: Buffer would have been truncated.");
499 rra_def[rra_num++] = sstrdup (buffer);
504 DBG ("rra_num = %i", rra_num);
505 for (i = 0; i < rra_num; i++)
506 DBG (" %s", rra_def[i]);
512 #endif /* HAVE_LIBRRD */
514 static int log_create_file (char *filename, char **ds_def, int ds_num)
519 if (check_create_dir (filename))
522 log = fopen (filename, "w");
525 syslog (LOG_WARNING, "Failed to create %s: %s", filename,
530 fprintf (log, "epoch");
531 for (i = 0; i < ds_num; i++)
536 name = strchr (ds_def[i], ':');
539 syslog (LOG_WARNING, "Invalid DS definition '%s' for %s",
540 ds_def[i], filename);
547 tmp = strchr (name, ':');
550 syslog (LOG_WARNING, "Invalid DS definition '%s' for %s",
551 ds_def[i], filename);
557 /* The `%.*s' is needed because there is no null-byte behind
559 fprintf(log, ",%.*s", (int) (tmp - name), name);
567 static int log_update_file (char *host, char *file, char *values,
568 char **ds_def, int ds_num)
573 char full_file[1024];
575 /* Cook the values a bit: Substitute colons with commas */
576 strsubstitute (values, ':', ',');
578 /* host == NULL => local mode */
581 if (snprintf (full_file, 1024, "%s/%s", host, file) >= 1024)
586 if (snprintf (full_file, 1024, "%s", file) >= 1024)
590 strncpy (full_file, file, 1024);
592 tmp = full_file + strlen (full_file) - 4;
593 assert ((tmp != NULL) && (tmp > full_file));
595 /* Change the filename for logfiles. */
596 if (strncmp (tmp, ".rrd", 4) == 0)
601 /* TODO: Find a way to minimize the calls to `localtime', since
602 * they are pretty expensive.. */
604 tm = localtime (&now);
606 strftime (tmp, 1024 - (tmp - full_file), "-%Y-%m-%d", tm);
608 /* `localtime(3)' returns a pointer to static data,
609 * therefore the pointer may not be free'd. */
612 DBG ("The filename ends with `%s' which is unexpected.", tmp);
614 if (stat (full_file, &statbuf) == -1)
618 if (log_create_file (full_file, ds_def, ds_num))
623 syslog (LOG_ERR, "stat %s: %s", full_file, strerror (errno));
627 else if (!S_ISREG (statbuf.st_mode))
629 syslog (LOG_ERR, "stat %s: Not a regular file!", full_file);
634 fp = fopen (full_file, "a");
637 syslog (LOG_WARNING, "Failed to append to %s: %s", full_file,
641 fprintf(fp, "%s\n", values);
645 } /* int log_update_file */
648 static int rrd_create_file (char *filename, char **ds_def, int ds_num)
657 if (check_create_dir (filename))
660 if ((rra_num = rra_get (&rra_def)) < 1)
662 syslog (LOG_ERR, "rra_create failed: Could not calculate RRAs");
666 argc = ds_num + rra_num + 4;
668 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
670 syslog (LOG_ERR, "rrd_create failed: %s", strerror (errno));
677 argv[3] = COLLECTD_STEP;
680 for (i = 0; i < ds_num; i++)
681 argv[j++] = ds_def[i];
682 for (i = 0; i < rra_num; i++)
683 argv[j++] = rra_def[i];
686 optind = 0; /* bug in librrd? */
688 if (rrd_create (argc, argv) == -1)
690 syslog (LOG_ERR, "rrd_create failed: %s: %s", filename, rrd_get_error ());
698 #endif /* HAVE_LIBRRD */
700 int rrd_update_file (char *host, char *file, char *values,
701 char **ds_def, int ds_num)
705 char full_file[1024];
706 char *argv[4] = { "update", full_file, values, NULL };
707 #endif /* HAVE_LIBRRD */
709 /* I'd rather have a function `common_update_file' to make this
710 * decission, but for that we'd need to touch all plugins.. */
711 if (operating_mode == MODE_LOG)
712 return (log_update_file (host, file, values,
716 /* host == NULL => local mode */
719 if (snprintf (full_file, 1024, "%s/%s", host, file) >= 1024)
724 if (snprintf (full_file, 1024, "%s", file) >= 1024)
728 if (stat (full_file, &statbuf) == -1)
732 if (rrd_create_file (full_file, ds_def, ds_num))
737 syslog (LOG_ERR, "stat %s: %s", full_file, strerror (errno));
741 else if (!S_ISREG (statbuf.st_mode))
743 syslog (LOG_ERR, "stat %s: Not a regular file!", full_file);
747 optind = 0; /* bug in librrd? */
749 if (rrd_update (3, argv) == -1)
751 syslog (LOG_WARNING, "rrd_update failed: %s: %s", full_file, rrd_get_error ());
755 /* #endif HAVE_LIBRRD */
758 syslog (LOG_ERR, "`rrd_update_file' was called, but collectd isn't linked against librrd!");
764 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
771 snprintf (ident, 128, "%s,%i,%s", module, instance, name);
774 if (*ksp_ptr == NULL)
776 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
778 syslog (LOG_ERR, "Cound not find kstat %s", ident);
782 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
784 syslog (LOG_WARNING, "kstat %s has wrong type", ident);
791 assert (*ksp_ptr != NULL);
792 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
795 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
797 syslog (LOG_WARNING, "kstat %s could not be read", ident);
801 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
803 syslog (LOG_WARNING, "kstat %s has wrong type", ident);
810 long long get_kstat_value (kstat_t *ksp, char *name)
813 long long retval = -1LL;
816 assert (ksp != NULL);
817 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
821 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
824 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
826 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
831 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
834 if (kn->data_type == KSTAT_DATA_INT32)
835 retval = (long long) kn->value.i32;
836 else if (kn->data_type == KSTAT_DATA_UINT32)
837 retval = (long long) kn->value.ui32;
838 else if (kn->data_type == KSTAT_DATA_INT64)
839 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
840 else if (kn->data_type == KSTAT_DATA_UINT64)
841 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
843 syslog (LOG_WARNING, "get_kstat_value: Not a numeric value: %s", name);
847 #endif /* HAVE_LIBKSTAT */