src/sensors.c

   1 /**
   2  * collectd - src/sensors.c
   3  * Copyright (C) 2005,2006  Florian octo Forster
   4  *
   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; either version 2 of the License, or (at your
   8  * option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Florian octo Forster <octo at verplant.org>
  21  *
  22  *   Lubos Stanek <lubek at users.sourceforge.net> Wed Oct 27, 2006
  23  *   - config ExtendedSensorNaming option
  24  *   - precise sensor feature selection (chip-bus-address/type-feature)
  25  *     with ExtendedSensorNaming
  26  *   - more sensor features (finite list)
  27  *   - honor sensors.conf's ignored
  28  *   - config Sensor option
  29  *   - config IgnoreSelected option
  30  **/
  31
  32 #include "collectd.h"
  33 #include "common.h"
  34 #include "plugin.h"
  35 #include "configfile.h"
  36 #include "utils_ignorelist.h"
  37 #include "utils_debug.h"
  38
  39 #define MODULE_NAME "sensors"
  40 #define MODULE_NAME_VOLTAGE MODULE_NAME"_voltage"
  41
  42 #if defined(HAVE_SENSORS_SENSORS_H)
  43 # include <sensors/sensors.h>
  44 #else
  45 # undef HAVE_LIBSENSORS
  46 #endif
  47
  48 #if defined(HAVE_LIBSENSORS)
  49 # define SENSORS_HAVE_READ 1
  50 #else
  51 # define SENSORS_HAVE_READ 0
  52 #endif
  53
  54 #define BUFSIZE 512
  55
  56 /* temperature and fan sensors */
  57 static char *ds_def[] =
  58 {
  59         "DS:value:GAUGE:"COLLECTD_HEARTBEAT":U:U",
  60         NULL
  61 };
  62 static int ds_num = 1;
  63
  64 /* voltage sensors */
  65 static char *sensor_voltage_ds_def[] =
  66 {
  67         "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":U:U",
  68         NULL
  69 };
  70 static int sensor_voltage_ds_num = 1;
  71
  72 /* old naming */
  73 static char *old_filename_format = "sensors-%s.rrd";
  74 /* end old naming */
  75
  76 /* new naming <chip-bus-address/type-feature */
  77 static char *extended_filename_format = "lm_sensors-%s.rrd";
  78
  79 #define SENSOR_TYPE_UNKNOWN 0
  80 #define SENSOR_TYPE_VOLTAGE 1
  81 #define SENSOR_TYPE_FANSPEED 2
  82 #define SENSOR_TYPE_TEMPERATURE 3
  83
  84 #if SENSORS_HAVE_READ
  85 static char *sensor_type_prefix[] =
  86 {
  87         "unknown",
  88         "voltage",
  89         "fanspeed",
  90         "temperature",
  91         NULL
  92 };
  93 #endif
  94
  95 typedef struct sensors_labeltypes {
  96         char *label;
  97         int type;
  98 } sensors_labeltypes;
  99
 100 /*
 101  * finite list of known labels extracted from lm_sensors
 102  */
 103 #if SENSORS_HAVE_READ
 104 static sensors_labeltypes known_features[] =
 105 {
 106         { "fan1", SENSOR_TYPE_FANSPEED },
 107         { "fan2", SENSOR_TYPE_FANSPEED },
 108         { "fan3", SENSOR_TYPE_FANSPEED },
 109         { "fan4", SENSOR_TYPE_FANSPEED },
 110         { "fan5", SENSOR_TYPE_FANSPEED },
 111         { "fan6", SENSOR_TYPE_FANSPEED },
 112         { "fan7", SENSOR_TYPE_FANSPEED },
 113         { "AIN2", SENSOR_TYPE_VOLTAGE },
 114         { "AIN1", SENSOR_TYPE_VOLTAGE },
 115         { "in10", SENSOR_TYPE_VOLTAGE },
 116         { "in9", SENSOR_TYPE_VOLTAGE },
 117         { "in8", SENSOR_TYPE_VOLTAGE },
 118         { "in7", SENSOR_TYPE_VOLTAGE },
 119         { "in6", SENSOR_TYPE_VOLTAGE },
 120         { "in5", SENSOR_TYPE_VOLTAGE },
 121         { "in4", SENSOR_TYPE_VOLTAGE },
 122         { "in3", SENSOR_TYPE_VOLTAGE },
 123         { "in2", SENSOR_TYPE_VOLTAGE },
 124         { "in0", SENSOR_TYPE_VOLTAGE },
 125         { "CPU_Temp", SENSOR_TYPE_TEMPERATURE },
 126         { "remote_temp", SENSOR_TYPE_TEMPERATURE },
 127         { "temp1", SENSOR_TYPE_TEMPERATURE },
 128         { "temp2", SENSOR_TYPE_TEMPERATURE },
 129         { "temp3", SENSOR_TYPE_TEMPERATURE },
 130         { "temp4", SENSOR_TYPE_TEMPERATURE },
 131         { "temp5", SENSOR_TYPE_TEMPERATURE },
 132         { "temp6", SENSOR_TYPE_TEMPERATURE },
 133         { "temp7", SENSOR_TYPE_TEMPERATURE },
 134         { "temp", SENSOR_TYPE_TEMPERATURE },
 135         { "Vccp2", SENSOR_TYPE_VOLTAGE },
 136         { "Vccp1", SENSOR_TYPE_VOLTAGE },
 137         { "vdd", SENSOR_TYPE_VOLTAGE },
 138         { "vid5", SENSOR_TYPE_VOLTAGE },
 139         { "vid4", SENSOR_TYPE_VOLTAGE },
 140         { "vid3", SENSOR_TYPE_VOLTAGE },
 141         { "vid2", SENSOR_TYPE_VOLTAGE },
 142         { "vid1", SENSOR_TYPE_VOLTAGE },
 143         { "vid", SENSOR_TYPE_VOLTAGE },
 144         { "vin4", SENSOR_TYPE_VOLTAGE },
 145         { "vin3", SENSOR_TYPE_VOLTAGE },
 146         { "vin2", SENSOR_TYPE_VOLTAGE },
 147         { "vin1", SENSOR_TYPE_VOLTAGE },
 148         { "voltbatt", SENSOR_TYPE_VOLTAGE },
 149         { "volt12", SENSOR_TYPE_VOLTAGE },
 150         { "volt5", SENSOR_TYPE_VOLTAGE },
 151         { "vrm", SENSOR_TYPE_VOLTAGE },
 152         { "5.0V", SENSOR_TYPE_VOLTAGE },
 153         { "5V", SENSOR_TYPE_VOLTAGE },
 154         { "3.3V", SENSOR_TYPE_VOLTAGE },
 155         { "2.5V", SENSOR_TYPE_VOLTAGE },
 156         { "2.0V", SENSOR_TYPE_VOLTAGE },
 157         { "12V", SENSOR_TYPE_VOLTAGE },
 158         { 0, -1 }
 159 };
 160 #endif
 161 /* end new naming */
 162
 163 static char *config_keys[] =
 164 {
 165         "Sensor",
 166         "IgnoreSelected",
 167         "ExtendedSensorNaming",
 168         NULL
 169 };
 170 static int config_keys_num = 3;
 171
 172 static ignorelist_t *sensor_list;
 173
 174 /*
 175  * sensor_extended_naming:
 176  * 0 => default is to create chip-feature
 177  * 1 => use new naming scheme chip-bus-address/type-feature
 178  */
 179 static int sensor_extended_naming = 0;
 180
 181 #if SENSORS_HAVE_READ
 182 #  ifndef SENSORS_CONF_PATH
 183 #    define SENSORS_CONF_PATH "/etc/sensors.conf"
 184 #  endif
 185
 186 static const char *conffile = SENSORS_CONF_PATH;
 187 /* SENSORS_CONF_PATH */
 188
 189 /*
 190  * remember stat of the loaded config
 191  */
 192 static time_t sensors_config_mtime = 0;
 193
 194 typedef struct featurelist
 195 {
 196         const sensors_chip_name    *chip;
 197         const sensors_feature_data *data;
 198         int                         type;
 199         struct featurelist         *next;
 200 } featurelist_t;
 201
 202 featurelist_t *first_feature = NULL;
 203 #endif /* if SENSORS_HAVE_READ */
 204
 205 static int sensors_config (char *key, char *value)
 206 {
 207         if (sensor_list == NULL)
 208                 sensor_list = ignorelist_create (1);
 209
 210         if (strcasecmp (key, "Sensor") == 0)
 211         {
 212                 if (ignorelist_add (sensor_list, value))
 213                 {
 214                         syslog (LOG_EMERG, MODULE_NAME": Cannot add value to ignorelist.");
 215                         return (1);
 216                 }
 217         }
 218         else if (strcasecmp (key, "IgnoreSelected") == 0)
 219         {
 220                 ignorelist_set_invert (sensor_list, 1);
 221                 if ((strcasecmp (value, "True") == 0)
 222                                 || (strcasecmp (value, "Yes") == 0)
 223                                 || (strcasecmp (value, "On") == 0))
 224                         ignorelist_set_invert (sensor_list, 0);
 225         }
 226         else if (strcasecmp (key, "ExtendedSensorNaming") == 0)
 227         {
 228                 if ((strcasecmp (value, "True") == 0)
 229                                 || (strcasecmp (value, "Yes") == 0)
 230                                 || (strcasecmp (value, "On") == 0))
 231                         sensor_extended_naming = 1;
 232                 else
 233                         sensor_extended_naming = 0;
 234         }
 235         else
 236         {
 237                 return (-1);
 238         }
 239
 240         return (0);
 241 }
 242
 243 #if SENSORS_HAVE_READ
 244 void sensors_free_features (void)
 245 {
 246         featurelist_t *thisft;
 247         featurelist_t *nextft;
 248
 249         if (first_feature == NULL)
 250                 return;
 251
 252         sensors_cleanup ();
 253
 254         for (thisft = first_feature; thisft != NULL; thisft = nextft)
 255         {
 256                 nextft = thisft->next;
 257                 sfree (thisft);
 258         }
 259         first_feature = NULL;
 260 }
 261
 262 static void sensors_load_conf (void)
 263 {
 264         FILE *fh;
 265         featurelist_t *last_feature = NULL;
 266         featurelist_t *new_feature = NULL;
 267
 268         const sensors_chip_name *chip;
 269         int chip_num;
 270
 271         const sensors_feature_data *data;
 272         int data_num0, data_num1;
 273
 274         struct stat statbuf;
 275         int status;
 276
 277         status = stat (conffile, &statbuf);
 278         if (status != 0)
 279         {
 280                 syslog (LOG_ERR, MODULE_NAME": stat(%s) failed: %s",
 281                                 conffile, strerror (errno));
 282                 sensors_config_mtime = 0;
 283         }
 284
 285         if ((sensors_config_mtime != 0)
 286                         && (sensors_config_mtime == statbuf.st_mtime))
 287                 return;
 288
 289         if (sensors_config_mtime != 0)
 290         {
 291                 syslog (LOG_NOTICE, MODULE_NAME": Reloading config from %s",
 292                                 conffile);
 293                 sensors_free_features ();
 294                 sensors_config_mtime = 0;
 295         }
 296
 297         fh = fopen (conffile, "r");
 298         if (fh == NULL)
 299         {
 300                 syslog (LOG_ERR, MODULE_NAME": fopen(%s) failed: %s",
 301                                 conffile, strerror(errno));
 302                 return;
 303         }
 304
 305         status = sensors_init (fh);
 306         fclose (fh);
 307         if (status != 0)
 308         {
 309                 syslog (LOG_ERR, MODULE_NAME": Cannot initialize sensors. "
 310                                 "Data will not be collected.");
 311                 return;
 312         }
 313
 314         sensors_config_mtime = statbuf.st_mtime;
 315
 316         chip_num = 0;
 317         while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
 318         {
 319                 data = NULL;
 320                 data_num0 = data_num1 = 0;
 321
 322                 while ((data = sensors_get_all_features (*chip, &data_num0, &data_num1))
 323                                 != NULL)
 324                 {
 325                         int i;
 326
 327                         /* "master features" only */
 328                         if (data->mapping != SENSORS_NO_MAPPING)
 329                                 continue;
 330
 331                         /* Only known features */
 332                         for (i = 0; known_features[i].type >= 0; i++)
 333                         {
 334                                 if (strcmp (data->name, known_features[i].label) != 0)
 335                                         continue;
 336
 337                                 /* skip ignored in sensors.conf */
 338                                 if (sensors_get_ignored (*chip, data->number) == 0)
 339                                         break;
 340
 341                                 DBG ("Adding feature: %s-%s-%s",
 342                                                 chip->prefix,
 343                                                 sensor_type_prefix[known_features[i].type],
 344                                                 data->name);
 345
 346                                 if ((new_feature = (featurelist_t *) malloc (sizeof (featurelist_t))) == NULL)
 347                                 {
 348                                         DBG ("malloc: %s", strerror (errno));
 349                                         syslog (LOG_ERR, MODULE_NAME":  malloc: %s",
 350                                                         strerror (errno));
 351                                         break;
 352                                 }
 353
 354                                 new_feature->chip = chip;
 355                                 new_feature->data = data;
 356                                 new_feature->type = known_features[i].type;
 357                                 new_feature->next = NULL;
 358
 359                                 if (first_feature == NULL)
 360                                 {
 361                                         first_feature = new_feature;
 362                                         last_feature  = new_feature;
 363                                 }
 364                                 else
 365                                 {
 366                                         last_feature->next = new_feature;
 367                                         last_feature = new_feature;
 368                                 }
 369
 370                                 /* stop searching known features at first found */
 371                                 break;
 372                         } /* for i */
 373                 } /* while sensors_get_all_features */
 374         } /* while sensors_get_detected_chips */
 375
 376         if (first_feature == NULL)
 377         {
 378                 sensors_cleanup ();
 379                 syslog (LOG_INFO, MODULE_NAME": lm_sensors reports no features. "
 380                         "Data will not be collected.");
 381         }
 382 } /* void sensors_load_conf */
 383 #endif /* if SENSORS_HAVE_READ */
 384
 385 static void collectd_sensors_init (void)
 386 {
 387         return;
 388 }
 389
 390 static void sensors_shutdown (void)
 391 {
 392 #if SENSORS_HAVE_READ
 393         sensors_free_features ();
 394 #endif /* if SENSORS_HAVE_READ */
 395
 396         ignorelist_free (sensor_list);
 397 }
 398
 399 static void sensors_voltage_write (char *host, char *inst, char *val)
 400 {
 401         char file[BUFSIZE];
 402         int status;
 403
 404         /* skip ignored in our config */
 405         if (ignorelist_match (sensor_list, inst))
 406                 return;
 407
 408         /* extended sensor naming */
 409         if(sensor_extended_naming)
 410                 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
 411         else
 412                 status = snprintf (file, BUFSIZE, old_filename_format, inst);
 413
 414         if ((status < 1) || (status >= BUFSIZE))
 415                 return;
 416
 417         rrd_update_file (host, file, val, sensor_voltage_ds_def, sensor_voltage_ds_num);
 418 }
 419
 420 static void sensors_write (char *host, char *inst, char *val)
 421 {
 422         char file[BUFSIZE];
 423         int status;
 424
 425         /* skip ignored in our config */
 426         if (ignorelist_match (sensor_list, inst))
 427                 return;
 428
 429         /* extended sensor naming */
 430         if (sensor_extended_naming)
 431                 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
 432         else
 433                 status = snprintf (file, BUFSIZE, old_filename_format, inst);
 434
 435         if ((status < 1) || (status >= BUFSIZE))
 436                 return;
 437
 438         rrd_update_file (host, file, val, ds_def, ds_num);
 439 }
 440
 441 #if SENSORS_HAVE_READ
 442 static void sensors_submit (const char *feat_name,
 443                 const char *chip_prefix, double value, int type)
 444 {
 445         char buf[BUFSIZE];
 446         char inst[BUFSIZE];
 447
 448         if (snprintf (inst, BUFSIZE, "%s-%s", chip_prefix, feat_name)
 449                         >= BUFSIZE)
 450                 return;
 451
 452         /* skip ignored in our config */
 453         if (ignorelist_match (sensor_list, inst))
 454                 return;
 455
 456         if (snprintf (buf, BUFSIZE, "%u:%.3f", (unsigned int) curtime,
 457                                 value) >= BUFSIZE)
 458                 return;
 459
 460         if (type == SENSOR_TYPE_VOLTAGE)
 461         {
 462                 DBG ("%s: %s/%s, %s", MODULE_NAME_VOLTAGE,
 463                                 sensor_type_prefix[type], inst, buf);
 464                 plugin_submit (MODULE_NAME_VOLTAGE, inst, buf);
 465         }
 466         else
 467         {
 468                 DBG ("%s: %s/%s, %s", MODULE_NAME,
 469                                 sensor_type_prefix[type], inst, buf);
 470                 plugin_submit (MODULE_NAME, inst, buf);
 471         }
 472 }
 473
 474 static void sensors_read (void)
 475 {
 476         featurelist_t *feature;
 477         double value;
 478         char chip_fullprefix[BUFSIZE];
 479
 480         sensors_load_conf ();
 481
 482         for (feature = first_feature; feature != NULL; feature = feature->next)
 483         {
 484                 if (sensors_get_feature (*feature->chip, feature->data->number, &value) < 0)
 485                         continue;
 486
 487                 if (sensor_extended_naming)
 488                 {
 489                         /* full chip name logic borrowed from lm_sensors */
 490                         if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
 491                         {
 492                                 if (snprintf (chip_fullprefix, BUFSIZE, "%s-isa-%04x/%s",
 493                                                         feature->chip->prefix,
 494                                                         feature->chip->addr,
 495                                                         sensor_type_prefix[feature->type])
 496                                                 >= BUFSIZE)
 497                                         continue;
 498                         }
 499                         else if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
 500                         {
 501                                 if (snprintf (chip_fullprefix, BUFSIZE, "%s-%s-%04x/%s",
 502                                                         feature->chip->prefix,
 503                                                         feature->chip->busname,
 504                                                         feature->chip->addr,
 505                                                         sensor_type_prefix[feature->type])
 506                                                 >= BUFSIZE)
 507                                         continue;
 508                         }
 509                         else
 510                         {
 511                                 if (snprintf (chip_fullprefix, BUFSIZE, "%s-i2c-%d-%02x/%s",
 512                                                         feature->chip->prefix,
 513                                                         feature->chip->bus,
 514                                                         feature->chip->addr,
 515                                                         sensor_type_prefix[feature->type])
 516                                                 >= BUFSIZE)
 517                                         continue;
 518                         }
 519
 520                         sensors_submit (feature->data->name,
 521                                         chip_fullprefix,
 522                                         value, feature->type);
 523                 }
 524                 else
 525                 {
 526                         sensors_submit (feature->data->name,
 527                                         feature->chip->prefix,
 528                                         value, feature->type);
 529                 }
 530         } /* for feature = first_feature .. NULL */
 531 } /* void sensors_read */
 532 #else
 533 # define sensors_read NULL
 534 #endif /* SENSORS_HAVE_READ */
 535
 536 void module_register (void)
 537 {
 538         plugin_register (MODULE_NAME, collectd_sensors_init, sensors_read, sensors_write);
 539         plugin_register (MODULE_NAME_VOLTAGE, NULL, NULL, sensors_voltage_write);
 540         plugin_register_shutdown (MODULE_NAME, sensors_shutdown);
 541         cf_register (MODULE_NAME, sensors_config, config_keys, config_keys_num);
 542 }
 543
 544 #undef BUFSIZE
 545 #undef MODULE_NAME