2 * collectd - src/common.c
3 * Copyright (C) 2005 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"
28 extern int operating_mode;
31 extern kstat_ctl_t *kc;
35 static char *rra_def[] =
37 "RRA:AVERAGE:0.2:6:1500",
38 "RRA:AVERAGE:0.1:180:1680",
39 "RRA:AVERAGE:0.1:2160:1520",
41 "RRA:MIN:0.1:180:1680",
42 "RRA:MIN:0.1:2160:1520",
44 "RRA:MAX:0.1:180:1680",
45 "RRA:MAX:0.1:2160:1520",
48 static int rra_num = 9;
49 #endif /* HAVE_LIBRRD */
51 void sstrncpy (char *d, const char *s, int len)
57 char *sstrdup (const char *s)
64 if((r = strdup (s)) == NULL)
66 DBG ("Not enough memory.");
73 void *smalloc (size_t size)
77 if ((r = malloc (size)) == NULL)
79 DBG("Not enough memory.");
87 void sfree (void **ptr)
99 int strsplit (char *string, char **fields, size_t size)
106 while ((fields[i] = strtok (ptr, " \t")) != NULL)
118 int strjoin (char *dst, size_t dst_len,
119 char **fields, size_t fields_num,
126 memset (dst, '\0', dst_len);
133 sep_len = strlen (sep);
135 for (i = 0; i < fields_num; i++)
137 if ((i > 0) && (sep_len > 0))
139 if (dst_len <= sep_len)
142 strncat (dst, sep, dst_len);
146 field_len = strlen (fields[i]);
148 if (dst_len <= field_len)
151 strncat (dst, fields[i], dst_len);
152 dst_len -= field_len;
155 return (strlen (dst));
158 int strsubstitute (char *str, char c_from, char c_to)
179 int escape_slashes (char *buf, int buf_len)
183 if (strcmp (buf, "/") == 0)
188 strncpy (buf, "root", buf_len);
192 /* Move one to the left */
193 memmove (buf, buf + 1, buf_len - 1);
195 for (i = 0; i < buf_len - 1; i++)
199 else if (buf[i] == '/')
207 static int check_create_dir (const char *file_orig)
217 int last_is_file = 1;
222 * Sanity checks first
224 if (file_orig == NULL)
227 if ((len = strlen (file_orig)) < 1)
233 * If `file_orig' ends in a slash the last component is a directory,
234 * otherwise it's a file. Act accordingly..
236 if (file_orig[len - 1] == '/')
240 * Create a copy for `strtok' to destroy
242 strncpy (file_copy, file_orig, 512);
243 file_copy[511] = '\0';
246 * Break into components. This will eat up several slashes in a row and
247 * remove leading and trailing slashes..
251 while ((fields[fields_num] = strtok (ptr, "/")) != NULL)
256 if (fields_num >= 16)
261 * For each component, do..
263 for (i = 0; i < (fields_num - last_is_file); i++)
266 * Do not create directories that start with a dot. This
267 * prevents `../../' attacks and other likely malicious
270 if (fields[i][0] == '.')
272 syslog (LOG_ERR, "Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
277 * Join the components together again
279 if (strjoin (dir, dir_len, fields, i + 1, "/") < 0)
281 syslog (LOG_ERR, "strjoin failed: `%s', component #%i", file_orig, i);
285 if (stat (dir, &statbuf) == -1)
289 if (mkdir (dir, 0755) == -1)
291 syslog (LOG_ERR, "mkdir (%s): %s", dir, strerror (errno));
297 syslog (LOG_ERR, "stat (%s): %s", dir, strerror (errno));
301 else if (!S_ISDIR (statbuf.st_mode))
303 syslog (LOG_ERR, "stat (%s): Not a directory!", dir);
311 static int log_create_file (char *filename, char **ds_def, int ds_num)
316 log = fopen (filename, "w");
319 syslog (LOG_WARNING, "Failed to create %s: %s", filename,
324 fprintf (log, "epoch");
325 for (i = 0; i < ds_num; i++)
330 name = strchr (ds_def[i], ':');
333 syslog (LOG_WARNING, "Invalid DS definition '%s' for %s",
334 ds_def[i], filename);
341 tmp = strchr (name, ':');
344 syslog (LOG_WARNING, "Invalid DS definition '%s' for %s",
345 ds_def[i], filename);
351 /* The `%.*s' is needed because there is no null-byte behind
353 fprintf(log, ",%.*s", (tmp - name), name);
361 static int log_update_file (char *host, char *file, char *values,
362 char **ds_def, int ds_num)
367 char full_file[1024];
369 /* Cook the values a bit: Substitute colons with commas */
370 strsubstitute (values, ':', ',');
372 /* host == NULL => local mode */
375 if (snprintf (full_file, 1024, "%s/%s", host, file) >= 1024)
380 if (snprintf (full_file, 1024, "%s", file) >= 1024)
384 strncpy (full_file, file, 1024);
386 tmp = full_file + strlen (full_file) - 4;
389 /* Change the filename for logfiles. */
390 if (strncmp (tmp, ".rrd", 4) == 0)
395 /* TODO: Find a way to minimize the calls to `localtime', since
396 * they are pretty expensive.. */
398 tm = localtime (&now);
400 strftime (tmp, 1024 - (tmp - full_file), "-%Y-%m-%d", tm);
402 /* `localtime(3)' returns a pointer to static data,
403 * therefore the pointer may not be free'd. */
406 DBG ("The filename ends with `%s' which is unexpected.", tmp);
408 if (stat (full_file, &statbuf) == -1)
412 if (log_create_file (full_file, ds_def, ds_num))
417 syslog (LOG_ERR, "stat %s: %s", full_file, strerror (errno));
421 else if (!S_ISREG (statbuf.st_mode))
423 syslog (LOG_ERR, "stat %s: Not a regular file!", full_file);
428 fp = fopen (full_file, "a");
431 syslog (LOG_WARNING, "Failed to append to %s: %s", full_file,
435 fprintf(fp, "%s\n", values);
439 } /* int log_update_file */
442 static int rrd_create_file (char *filename, char **ds_def, int ds_num)
449 if (check_create_dir (filename))
452 argc = ds_num + rra_num + 4;
454 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
456 syslog (LOG_ERR, "rrd_create failed: %s", strerror (errno));
466 for (i = 0; i < ds_num; i++)
467 argv[j++] = ds_def[i];
468 for (i = 0; i < rra_num; i++)
469 argv[j++] = rra_def[i];
472 optind = 0; /* bug in librrd? */
474 if (rrd_create (argc, argv) == -1)
476 syslog (LOG_ERR, "rrd_create failed: %s: %s", filename, rrd_get_error ());
484 #endif /* HAVE_LIBRRD */
486 int rrd_update_file (char *host, char *file, char *values,
487 char **ds_def, int ds_num)
491 char full_file[1024];
492 char *argv[4] = { "update", full_file, values, NULL };
493 #endif /* HAVE_LIBRRD */
495 /* I'd rather have a function `common_update_file' to make this
496 * decission, but for that we'd need to touch all plugins.. */
497 if (operating_mode == MODE_LOG)
498 return (log_update_file (host, file, values,
502 /* host == NULL => local mode */
505 if (snprintf (full_file, 1024, "%s/%s", host, file) >= 1024)
510 if (snprintf (full_file, 1024, "%s", file) >= 1024)
514 if (stat (full_file, &statbuf) == -1)
518 if (rrd_create_file (full_file, ds_def, ds_num))
523 syslog (LOG_ERR, "stat %s: %s", full_file, strerror (errno));
527 else if (!S_ISREG (statbuf.st_mode))
529 syslog (LOG_ERR, "stat %s: Not a regular file!", full_file);
533 optind = 0; /* bug in librrd? */
535 if (rrd_update (3, argv) == -1)
537 syslog (LOG_WARNING, "rrd_update failed: %s: %s", full_file, rrd_get_error ());
541 /* #endif HAVE_LIBRRD */
544 syslog (LOG_ERR, "`rrd_update_file' was called, but collectd isn't linked against librrd!");
550 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
557 snprintf (ident, 128, "%s,%i,%s", module, instance, name);
560 if (*ksp_ptr == NULL)
562 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
564 syslog (LOG_ERR, "Cound not find kstat %s", ident);
568 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
570 syslog (LOG_WARNING, "kstat %s has wrong type", ident);
577 assert (*ksp_ptr != NULL);
578 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
581 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
583 syslog (LOG_WARNING, "kstat %s could not be read", ident);
587 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
589 syslog (LOG_WARNING, "kstat %s has wrong type", ident);
596 long long get_kstat_value (kstat_t *ksp, char *name)
599 long long retval = -1LL;
602 assert (ksp != NULL);
603 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
607 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
610 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
612 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
617 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
620 if (kn->data_type == KSTAT_DATA_INT32)
621 retval = (long long) kn->value.i32;
622 else if (kn->data_type == KSTAT_DATA_UINT32)
623 retval = (long long) kn->value.ui32;
624 else if (kn->data_type == KSTAT_DATA_INT64)
625 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
626 else if (kn->data_type == KSTAT_DATA_UINT64)
627 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
629 syslog (LOG_WARNING, "get_kstat_value: Not a numeric value: %s", name);
633 #endif /* HAVE_LIBKSTAT */