sensors plugin: Avoid assertion in ignorelist_match () when not configured.
[collectd.git] / src / sensors.c
index 05973ba..66cd5b2 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * collectd - src/sensors.c
- * Copyright (C) 2005  Florian octo Forster
+ * Copyright (C) 2005,2006  Florian octo Forster
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
  *
  * Authors:
  *   Florian octo Forster <octo at verplant.org>
+ *   
+ *   Lubos Stanek <lubek at users.sourceforge.net> Wed Oct 27, 2006
+ *   - config ExtendedSensorNaming option
+ *   - precise sensor feature selection (chip-bus-address/type-feature)
+ *     with ExtendedSensorNaming
+ *   - more sensor features (finite list)
+ *   - honor sensors.conf's ignored
+ *   - config Sensor option
+ *   - config IgnoreSelected option
  **/
 
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
+#include "configfile.h"
+#include "utils_ignorelist.h"
+#include "utils_debug.h"
 
 #define MODULE_NAME "sensors"
+#define MODULE_NAME_VOLTAGE MODULE_NAME"_voltage"
 
 #if defined(HAVE_SENSORS_SENSORS_H)
 # include <sensors/sensors.h>
@@ -40,8 +53,7 @@
 
 #define BUFSIZE 512
 
-static char *filename_format = "sensors-%s.rrd";
-
+/* temperature and fan sensors */
 static char *ds_def[] =
 {
        "DS:value:GAUGE:"COLLECTD_HEARTBEAT":U:U",
@@ -49,54 +61,257 @@ static char *ds_def[] =
 };
 static int ds_num = 1;
 
-#ifdef HAVE_LIBSENSORS
+/* voltage sensors */
+static char *sensor_voltage_ds_def[] = 
+{
+       "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":U:U",
+       NULL
+};
+static int sensor_voltage_ds_num = 1;
+
+/* old naming */
+static char *old_filename_format = "sensors-%s.rrd";
+/* end old naming */
+
+/* new naming <chip-bus-address/type-feature */
+static char *extended_filename_format = "lm_sensors-%s.rrd";
+
+#define SENSOR_TYPE_UNKNOWN 0
+#define SENSOR_TYPE_VOLTAGE 1
+#define SENSOR_TYPE_FANSPEED 2
+#define SENSOR_TYPE_TEMPERATURE 3
+
+#if SENSORS_HAVE_READ
+static char *sensor_type_prefix[] =
+{
+       "unknown",
+       "voltage",
+       "fanspeed",
+       "temperature",
+       NULL
+};
+#endif
+
+typedef struct sensors_labeltypes {
+       char *label;
+       int type;
+} sensors_labeltypes;
+
+/*
+ * finite list of known labels extracted from lm_sensors
+ */
+#if SENSORS_HAVE_READ
+static sensors_labeltypes known_features[] = 
+{
+       { "fan1", SENSOR_TYPE_FANSPEED },
+       { "fan2", SENSOR_TYPE_FANSPEED },
+       { "fan3", SENSOR_TYPE_FANSPEED },
+       { "fan4", SENSOR_TYPE_FANSPEED },
+       { "fan5", SENSOR_TYPE_FANSPEED },
+       { "fan6", SENSOR_TYPE_FANSPEED },
+       { "fan7", SENSOR_TYPE_FANSPEED },
+       { "AIN2", SENSOR_TYPE_VOLTAGE },
+       { "AIN1", SENSOR_TYPE_VOLTAGE },
+       { "in10", SENSOR_TYPE_VOLTAGE },
+       { "in9", SENSOR_TYPE_VOLTAGE },
+       { "in8", SENSOR_TYPE_VOLTAGE },
+       { "in7", SENSOR_TYPE_VOLTAGE },
+       { "in6", SENSOR_TYPE_VOLTAGE },
+       { "in5", SENSOR_TYPE_VOLTAGE },
+       { "in4", SENSOR_TYPE_VOLTAGE },
+       { "in3", SENSOR_TYPE_VOLTAGE },
+       { "in2", SENSOR_TYPE_VOLTAGE },
+       { "in0", SENSOR_TYPE_VOLTAGE },
+       { "CPU_Temp", SENSOR_TYPE_TEMPERATURE },
+       { "remote_temp", SENSOR_TYPE_TEMPERATURE },
+       { "temp1", SENSOR_TYPE_TEMPERATURE },
+       { "temp2", SENSOR_TYPE_TEMPERATURE },
+       { "temp3", SENSOR_TYPE_TEMPERATURE },
+       { "temp4", SENSOR_TYPE_TEMPERATURE },
+       { "temp5", SENSOR_TYPE_TEMPERATURE },
+       { "temp6", SENSOR_TYPE_TEMPERATURE },
+       { "temp7", SENSOR_TYPE_TEMPERATURE },
+       { "temp", SENSOR_TYPE_TEMPERATURE },
+       { "Vccp2", SENSOR_TYPE_VOLTAGE },
+       { "Vccp1", SENSOR_TYPE_VOLTAGE },
+       { "vdd", SENSOR_TYPE_VOLTAGE },
+       { "vid5", SENSOR_TYPE_VOLTAGE },
+       { "vid4", SENSOR_TYPE_VOLTAGE },
+       { "vid3", SENSOR_TYPE_VOLTAGE },
+       { "vid2", SENSOR_TYPE_VOLTAGE },
+       { "vid1", SENSOR_TYPE_VOLTAGE },
+       { "vid", SENSOR_TYPE_VOLTAGE },
+       { "vin4", SENSOR_TYPE_VOLTAGE },
+       { "vin3", SENSOR_TYPE_VOLTAGE },
+       { "vin2", SENSOR_TYPE_VOLTAGE },
+       { "vin1", SENSOR_TYPE_VOLTAGE },
+       { "voltbatt", SENSOR_TYPE_VOLTAGE },
+       { "volt12", SENSOR_TYPE_VOLTAGE },
+       { "volt5", SENSOR_TYPE_VOLTAGE },
+       { "vrm", SENSOR_TYPE_VOLTAGE },
+       { "5.0V", SENSOR_TYPE_VOLTAGE },
+       { "5V", SENSOR_TYPE_VOLTAGE },
+       { "3.3V", SENSOR_TYPE_VOLTAGE },
+       { "2.5V", SENSOR_TYPE_VOLTAGE },
+       { "2.0V", SENSOR_TYPE_VOLTAGE },
+       { "12V", SENSOR_TYPE_VOLTAGE },
+       { 0, -1 }
+};
+#endif
+/* end new naming */
+
+static char *config_keys[] =
+{
+       "Sensor",
+       "IgnoreSelected",
+       "ExtendedSensorNaming",
+       NULL
+};
+static int config_keys_num = 3;
+
+static ignorelist_t *sensor_list;
+
+/* 
+ * sensor_extended_naming:
+ * 0 => default is to create chip-feature
+ * 1 => use new naming scheme chip-bus-address/type-feature
+ */
+static int sensor_extended_naming = 0;
+
+#if SENSORS_HAVE_READ
+#  ifndef SENSORS_CONF_PATH
+#    define SENSORS_CONF_PATH "/etc/sensors.conf"
+#  endif
+
+static const char *conffile = SENSORS_CONF_PATH;
+/* SENSORS_CONF_PATH */
+
+/*
+ * remember stat of the loaded config
+ */
+static time_t sensors_config_mtime = 0;
+
 typedef struct featurelist
 {
        const sensors_chip_name    *chip;
        const sensors_feature_data *data;
+       int                         type;
        struct featurelist         *next;
 } featurelist_t;
 
 featurelist_t *first_feature = NULL;
-#endif /* defined (HAVE_LIBSENSORS) */
+#endif /* if SENSORS_HAVE_READ */
 
-static void collectd_sensors_init (void)
+static int sensors_config (char *key, char *value)
+{
+       if (sensor_list == NULL)
+               sensor_list = ignorelist_create (1);
+
+       if (strcasecmp (key, "Sensor") == 0)
+       {
+               if (ignorelist_add (sensor_list, value))
+               {
+                       syslog (LOG_EMERG, MODULE_NAME": Cannot add value to ignorelist.");
+                       return (1);
+               }
+       }
+       else if (strcasecmp (key, "IgnoreSelected") == 0)
+       {
+               ignorelist_set_invert (sensor_list, 1);
+               if ((strcasecmp (value, "True") == 0)
+                               || (strcasecmp (value, "Yes") == 0)
+                               || (strcasecmp (value, "On") == 0))
+                       ignorelist_set_invert (sensor_list, 0);
+       }
+       else if (strcasecmp (key, "ExtendedSensorNaming") == 0)
+       {
+               if ((strcasecmp (value, "True") == 0)
+                               || (strcasecmp (value, "Yes") == 0)
+                               || (strcasecmp (value, "On") == 0))
+                       sensor_extended_naming = 1;
+               else
+                       sensor_extended_naming = 0;
+       }
+       else
+       {
+               return (-1);
+       }
+
+       return (0);
+}
+
+#if SENSORS_HAVE_READ
+void sensors_free_features (void)
+{
+       featurelist_t *thisft;
+       featurelist_t *nextft;
+
+       if (first_feature == NULL)
+               return;
+
+       sensors_cleanup ();
+
+       for (thisft = first_feature; thisft != NULL; thisft = nextft)
+       {
+               nextft = thisft->next;
+               sfree (thisft);
+       }
+       first_feature = NULL;
+}
+
+static void sensors_load_conf (void)
 {
-#ifdef HAVE_LIBSENSORS
        FILE *fh;
        featurelist_t *last_feature = NULL;
-       featurelist_t *new_feature;
+       featurelist_t *new_feature = NULL;
        
        const sensors_chip_name *chip;
        int chip_num;
 
        const sensors_feature_data *data;
        int data_num0, data_num1;
+
+       struct stat statbuf;
+       int status;
        
-       new_feature = first_feature;
-       while (new_feature != NULL)
+       status = stat (conffile, &statbuf);
+       if (status != 0)
        {
-               last_feature = new_feature->next;
-               free (new_feature);
-               new_feature = last_feature;
+               syslog (LOG_ERR, MODULE_NAME": stat(%s) failed: %s",
+                               conffile, strerror (errno));
+               sensors_config_mtime = 0;
        }
 
-#ifdef assert
-       assert (new_feature == NULL);
-       assert (last_feature == NULL);
-#endif
-
-       if ((fh = fopen ("/etc/sensors.conf", "r")) == NULL)
+       if ((sensors_config_mtime != 0)
+                       && (sensors_config_mtime == statbuf.st_mtime))
                return;
 
-       if (sensors_init (fh))
+       if (sensors_config_mtime != 0)
+       {
+               syslog (LOG_NOTICE, MODULE_NAME": Reloading config from %s",
+                               conffile);
+               sensors_free_features ();
+               sensors_config_mtime = 0;
+       }
+
+       fh = fopen (conffile, "r");
+       if (fh == NULL)
        {
-               fclose (fh);
-               syslog (LOG_ERR, "sensors: Cannot initialize sensors. Data will not be collected.");
+               syslog (LOG_ERR, MODULE_NAME": fopen(%s) failed: %s",
+                               conffile, strerror(errno));
                return;
        }
 
+       status = sensors_init (fh);
        fclose (fh);
+       if (status != 0)
+       {
+               syslog (LOG_ERR, MODULE_NAME": Cannot initialize sensors. "
+                               "Data will not be collected.");
+               return;
+       }
+
+       sensors_config_mtime = statbuf.st_mtime;
 
        chip_num = 0;
        while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
@@ -104,93 +319,217 @@ static void collectd_sensors_init (void)
                data = NULL;
                data_num0 = data_num1 = 0;
 
-               while ((data = sensors_get_all_features (*chip, &data_num0, &data_num1)) != NULL)
+               while ((data = sensors_get_all_features (*chip, &data_num0, &data_num1))
+                               != NULL)
                {
+                       int i;
+
                        /* "master features" only */
                        if (data->mapping != SENSORS_NO_MAPPING)
                                continue;
 
-                       /* Only temperature for now.. */
-                       if (strncmp (data->name, "temp", 4)
-                                       && strncmp (data->name, "fan", 3))
-                               continue;
-
-                       if ((new_feature = (featurelist_t *) malloc (sizeof (featurelist_t))) == NULL)
-                       {
-                               perror ("malloc");
-                               continue;
-                       }
-
-                       /*
-                       syslog (LOG_INFO, "sensors: Adding feature: %s/%s", chip->prefix, data->name);
-                       */
-
-                       new_feature->chip = chip;
-                       new_feature->data = data;
-                       new_feature->next = NULL;
-
-                       if (first_feature == NULL)
-                       {
-                               first_feature = new_feature;
-                               last_feature  = new_feature;
-                       }
-                       else
+                       /* Only known features */
+                       for (i = 0; known_features[i].type >= 0; i++)
                        {
-                               last_feature->next = new_feature;
-                               last_feature = new_feature;
-                       }
-               }
-       }
+                               if (strcmp (data->name, known_features[i].label) != 0)
+                                       continue;
+
+                               /* skip ignored in sensors.conf */
+                               if (sensors_get_ignored (*chip, data->number) == 0)
+                                       break;
+
+                               DBG ("Adding feature: %s-%s-%s",
+                                               chip->prefix,
+                                               sensor_type_prefix[known_features[i].type],
+                                               data->name);
+
+                               if ((new_feature = (featurelist_t *) malloc (sizeof (featurelist_t))) == NULL)
+                               {
+                                       DBG ("malloc: %s", strerror (errno));
+                                       syslog (LOG_ERR, MODULE_NAME":  malloc: %s",
+                                                       strerror (errno));
+                                       break;
+                               }
+
+                               new_feature->chip = chip;
+                               new_feature->data = data;
+                               new_feature->type = known_features[i].type;
+                               new_feature->next = NULL;
+
+                               if (first_feature == NULL)
+                               {
+                                       first_feature = new_feature;
+                                       last_feature  = new_feature;
+                               }
+                               else
+                               {
+                                       last_feature->next = new_feature;
+                                       last_feature = new_feature;
+                               }
+
+                               /* stop searching known features at first found */
+                               break;
+                       } /* for i */
+               } /* while sensors_get_all_features */
+       } /* while sensors_get_detected_chips */
 
        if (first_feature == NULL)
+       {
                sensors_cleanup ();
-#endif /* defined(HAVE_LIBSENSORS) */
+               syslog (LOG_INFO, MODULE_NAME": lm_sensors reports no features. "
+                       "Data will not be collected.");
+       }
+} /* void sensors_load_conf */
+#endif /* if SENSORS_HAVE_READ */
 
+static void collectd_sensors_init (void)
+{
        return;
 }
 
+static void sensors_shutdown (void)
+{
+#if SENSORS_HAVE_READ
+       sensors_free_features ();
+#endif /* if SENSORS_HAVE_READ */
+
+       if (NULL != sensor_list)
+               ignorelist_free (sensor_list);
+}
+
+static void sensors_voltage_write (char *host, char *inst, char *val)
+{
+       char file[BUFSIZE];
+       int status;
+
+       /* skip ignored in our config */
+       if ((NULL != sensor_list) && ignorelist_match (sensor_list, inst))
+               return;
+
+       /* extended sensor naming */
+       if(sensor_extended_naming)
+               status = snprintf (file, BUFSIZE, extended_filename_format, inst);
+       else
+               status = snprintf (file, BUFSIZE, old_filename_format, inst);
+
+       if ((status < 1) || (status >= BUFSIZE))
+               return;
+
+       rrd_update_file (host, file, val, sensor_voltage_ds_def, sensor_voltage_ds_num);
+}
+
 static void sensors_write (char *host, char *inst, char *val)
 {
        char file[BUFSIZE];
        int status;
 
-       status = snprintf (file, BUFSIZE, filename_format, inst);
-       if (status < 1)
+       /* skip ignored in our config */
+       if ((NULL != sensor_list) && ignorelist_match (sensor_list, inst))
                return;
-       else if (status >= BUFSIZE)
+
+       /* extended sensor naming */
+       if (sensor_extended_naming)
+               status = snprintf (file, BUFSIZE, extended_filename_format, inst);
+       else
+               status = snprintf (file, BUFSIZE, old_filename_format, inst);
+
+       if ((status < 1) || (status >= BUFSIZE))
                return;
 
        rrd_update_file (host, file, val, ds_def, ds_num);
 }
 
 #if SENSORS_HAVE_READ
-static void sensors_submit (const char *feat_name, const char *chip_prefix, double value)
+static void sensors_submit (const char *feat_name,
+               const char *chip_prefix, double value, int type)
 {
        char buf[BUFSIZE];
        char inst[BUFSIZE];
 
-       if (snprintf (buf, BUFSIZE, "%u:%.3f", (unsigned int) curtime, value) >= BUFSIZE)
+       if (snprintf (inst, BUFSIZE, "%s-%s", chip_prefix, feat_name)
+                       >= BUFSIZE)
+               return;
+
+       /* skip ignored in our config */
+       if ((NULL != sensor_list) && ignorelist_match (sensor_list, inst))
                return;
 
-       if (snprintf (inst, BUFSIZE, "%s-%s", chip_prefix, feat_name) >= BUFSIZE)
+       if (snprintf (buf, BUFSIZE, "%u:%.3f", (unsigned int) curtime,
+                               value) >= BUFSIZE)
                return;
 
-       plugin_submit (MODULE_NAME, inst, buf);
+       if (type == SENSOR_TYPE_VOLTAGE)
+       {
+               DBG ("%s: %s/%s, %s", MODULE_NAME_VOLTAGE,
+                               sensor_type_prefix[type], inst, buf);
+               plugin_submit (MODULE_NAME_VOLTAGE, inst, buf);
+       }
+       else
+       {
+               DBG ("%s: %s/%s, %s", MODULE_NAME,
+                               sensor_type_prefix[type], inst, buf);
+               plugin_submit (MODULE_NAME, inst, buf);
+       }
 }
 
 static void sensors_read (void)
 {
        featurelist_t *feature;
        double value;
+       char chip_fullprefix[BUFSIZE];
+
+       sensors_load_conf ();
 
        for (feature = first_feature; feature != NULL; feature = feature->next)
        {
                if (sensors_get_feature (*feature->chip, feature->data->number, &value) < 0)
                        continue;
 
-               sensors_submit (feature->data->name, feature->chip->prefix, value);
-       }
-}
+               if (sensor_extended_naming)
+               {
+                       /* full chip name logic borrowed from lm_sensors */
+                       if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
+                       {
+                               if (snprintf (chip_fullprefix, BUFSIZE, "%s-isa-%04x/%s",
+                                                       feature->chip->prefix,
+                                                       feature->chip->addr,
+                                                       sensor_type_prefix[feature->type])
+                                               >= BUFSIZE)
+                                       continue;
+                       }
+                       else if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
+                       {
+                               if (snprintf (chip_fullprefix, BUFSIZE, "%s-%s-%04x/%s",
+                                                       feature->chip->prefix,
+                                                       feature->chip->busname,
+                                                       feature->chip->addr,
+                                                       sensor_type_prefix[feature->type])
+                                               >= BUFSIZE)
+                                       continue;
+                       }
+                       else
+                       {
+                               if (snprintf (chip_fullprefix, BUFSIZE, "%s-i2c-%d-%02x/%s",
+                                                       feature->chip->prefix,
+                                                       feature->chip->bus,
+                                                       feature->chip->addr,
+                                                       sensor_type_prefix[feature->type])
+                                               >= BUFSIZE)
+                                       continue;
+                       }
+
+                       sensors_submit (feature->data->name,
+                                       chip_fullprefix,
+                                       value, feature->type);
+               }
+               else
+               {
+                       sensors_submit (feature->data->name,
+                                       feature->chip->prefix,
+                                       value, feature->type);
+               }
+       } /* for feature = first_feature .. NULL */
+} /* void sensors_read */
 #else
 # define sensors_read NULL
 #endif /* SENSORS_HAVE_READ */
@@ -198,6 +537,9 @@ static void sensors_read (void)
 void module_register (void)
 {
        plugin_register (MODULE_NAME, collectd_sensors_init, sensors_read, sensors_write);
+       plugin_register (MODULE_NAME_VOLTAGE, NULL, NULL, sensors_voltage_write);
+       plugin_register_shutdown (MODULE_NAME, sensors_shutdown);
+       cf_register (MODULE_NAME, sensors_config, config_keys, config_keys_num);
 }
 
 #undef BUFSIZE