src/sensors.c

   1 /**
   2  * collectd - src/sensors.c
   3  * Copyright (C) 2005-2008  Florian octo Forster
   4  * Copyright (C) 2006       Luboš Staněk
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; only version 2 of the License is applicable.
   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 collectd.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  *   Henrique de Moraes Holschuh <hmh at debian.org>
  32  *   - use default libsensors config file on API 0x400
  33  *   - config SensorConfigFile option
  34  **/
  35
  36 #include "collectd.h"
  37
  38 #include "common.h"
  39 #include "plugin.h"
  40 #include "utils_ignorelist.h"
  41
  42 #if defined(HAVE_SENSORS_SENSORS_H)
  43 # include <sensors/sensors.h>
  44 #endif
  45
  46 #if !defined(SENSORS_API_VERSION)
  47 # define SENSORS_API_VERSION 0x000
  48 #endif
  49
  50 /*
  51  * The sensors library prior to version 3.0 (internal version 0x400) didn't
  52  * report the type of values, only a name. The following lists are there to
  53  * convert from the names to the type. They are not used with the new
  54  * interface.
  55  */
  56 #if SENSORS_API_VERSION < 0x400
  57 static char *sensor_type_name_map[] =
  58 {
  59 # define SENSOR_TYPE_VOLTAGE     0
  60         "voltage",
  61 # define SENSOR_TYPE_FANSPEED    1
  62         "fanspeed",
  63 # define SENSOR_TYPE_TEMPERATURE 2
  64         "temperature",
  65 # define SENSOR_TYPE_POWER       3
  66         "power",
  67 # define SENSOR_TYPE_UNKNOWN     4
  68         NULL
  69 };
  70
  71 struct sensors_labeltypes_s
  72 {
  73         char *label;
  74         int type;
  75 };
  76 typedef struct sensors_labeltypes_s sensors_labeltypes_t;
  77
  78 /* finite list of known labels extracted from lm_sensors */
  79 static sensors_labeltypes_t known_features[] =
  80 {
  81         { "fan1", SENSOR_TYPE_FANSPEED },
  82         { "fan2", SENSOR_TYPE_FANSPEED },
  83         { "fan3", SENSOR_TYPE_FANSPEED },
  84         { "fan4", SENSOR_TYPE_FANSPEED },
  85         { "fan5", SENSOR_TYPE_FANSPEED },
  86         { "fan6", SENSOR_TYPE_FANSPEED },
  87         { "fan7", SENSOR_TYPE_FANSPEED },
  88         { "AIN2", SENSOR_TYPE_VOLTAGE },
  89         { "AIN1", SENSOR_TYPE_VOLTAGE },
  90         { "in10", SENSOR_TYPE_VOLTAGE },
  91         { "in9", SENSOR_TYPE_VOLTAGE },
  92         { "in8", SENSOR_TYPE_VOLTAGE },
  93         { "in7", SENSOR_TYPE_VOLTAGE },
  94         { "in6", SENSOR_TYPE_VOLTAGE },
  95         { "in5", SENSOR_TYPE_VOLTAGE },
  96         { "in4", SENSOR_TYPE_VOLTAGE },
  97         { "in3", SENSOR_TYPE_VOLTAGE },
  98         { "in2", SENSOR_TYPE_VOLTAGE },
  99         { "in0", SENSOR_TYPE_VOLTAGE },
 100         { "CPU_Temp", SENSOR_TYPE_TEMPERATURE },
 101         { "remote_temp", SENSOR_TYPE_TEMPERATURE },
 102         { "temp1", SENSOR_TYPE_TEMPERATURE },
 103         { "temp2", SENSOR_TYPE_TEMPERATURE },
 104         { "temp3", SENSOR_TYPE_TEMPERATURE },
 105         { "temp4", SENSOR_TYPE_TEMPERATURE },
 106         { "temp5", SENSOR_TYPE_TEMPERATURE },
 107         { "temp6", SENSOR_TYPE_TEMPERATURE },
 108         { "temp7", SENSOR_TYPE_TEMPERATURE },
 109         { "temp", SENSOR_TYPE_TEMPERATURE },
 110         { "Vccp2", SENSOR_TYPE_VOLTAGE },
 111         { "Vccp1", SENSOR_TYPE_VOLTAGE },
 112         { "vdd", SENSOR_TYPE_VOLTAGE },
 113         { "vid5", SENSOR_TYPE_VOLTAGE },
 114         { "vid4", SENSOR_TYPE_VOLTAGE },
 115         { "vid3", SENSOR_TYPE_VOLTAGE },
 116         { "vid2", SENSOR_TYPE_VOLTAGE },
 117         { "vid1", SENSOR_TYPE_VOLTAGE },
 118         { "vid", SENSOR_TYPE_VOLTAGE },
 119         { "vin4", SENSOR_TYPE_VOLTAGE },
 120         { "vin3", SENSOR_TYPE_VOLTAGE },
 121         { "vin2", SENSOR_TYPE_VOLTAGE },
 122         { "vin1", SENSOR_TYPE_VOLTAGE },
 123         { "voltbatt", SENSOR_TYPE_VOLTAGE },
 124         { "volt12", SENSOR_TYPE_VOLTAGE },
 125         { "volt5", SENSOR_TYPE_VOLTAGE },
 126         { "vrm", SENSOR_TYPE_VOLTAGE },
 127         { "5.0V", SENSOR_TYPE_VOLTAGE },
 128         { "5V", SENSOR_TYPE_VOLTAGE },
 129         { "3.3V", SENSOR_TYPE_VOLTAGE },
 130         { "2.5V", SENSOR_TYPE_VOLTAGE },
 131         { "2.0V", SENSOR_TYPE_VOLTAGE },
 132         { "12V", SENSOR_TYPE_VOLTAGE },
 133         { "power1", SENSOR_TYPE_POWER }
 134 };
 135 static int known_features_num = STATIC_ARRAY_SIZE (known_features);
 136 /* end new naming */
 137 #endif /* SENSORS_API_VERSION < 0x400 */
 138
 139 static const char *config_keys[] =
 140 {
 141         "Sensor",
 142         "IgnoreSelected",
 143         "SensorConfigFile",
 144         "UseLabels"
 145 };
 146 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 147
 148 #if SENSORS_API_VERSION < 0x400
 149 typedef struct featurelist
 150 {
 151         const sensors_chip_name    *chip;
 152         const sensors_feature_data *data;
 153         int                         type;
 154         struct featurelist         *next;
 155 } featurelist_t;
 156
 157 # ifndef SENSORS_CONF_PATH
 158 #  define SENSORS_CONF_PATH "/etc/sensors.conf"
 159 # endif
 160 static char *conffile = SENSORS_CONF_PATH;
 161 /* #endif SENSORS_API_VERSION < 0x400 */
 162
 163 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
 164 typedef struct featurelist
 165 {
 166         const sensors_chip_name    *chip;
 167         const sensors_feature      *feature;
 168         const sensors_subfeature   *subfeature;
 169         struct featurelist         *next;
 170 } featurelist_t;
 171
 172 static char *conffile = NULL;
 173 static _Bool use_labels = 0;
 174 /* #endif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
 175
 176 #else /* if SENSORS_API_VERSION >= 0x500 */
 177 # error "This version of libsensors is not supported yet. Please report this " \
 178         "as bug."
 179 #endif
 180
 181 static featurelist_t *first_feature = NULL;
 182 static ignorelist_t *sensor_list;
 183
 184 #if SENSORS_API_VERSION < 0x400
 185 /* full chip name logic borrowed from lm_sensors */
 186 static int sensors_snprintf_chip_name (char *buf, size_t buf_size,
 187                 const sensors_chip_name *chip)
 188 {
 189         int status = -1;
 190
 191         if (chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
 192         {
 193                 status = ssnprintf (buf, buf_size,
 194                                 "%s-isa-%04x",
 195                                 chip->prefix,
 196                                 chip->addr);
 197         }
 198         else if (chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
 199         {
 200                 status = snprintf (buf, buf_size, "%s-%s-%04x",
 201                                 chip->prefix,
 202                                 chip->busname,
 203                                 chip->addr);
 204         }
 205         else
 206         {
 207                 status = snprintf (buf, buf_size, "%s-i2c-%d-%02x",
 208                                 chip->prefix,
 209                                 chip->bus,
 210                                 chip->addr);
 211         }
 212
 213         return (status);
 214 } /* int sensors_snprintf_chip_name */
 215
 216 static int sensors_feature_name_to_type (const char *name)
 217 {
 218         /* Yes, this is slow, but it's only ever done during initialization, so
 219          * it's a one time cost.. */
 220         for (int i = 0; i < known_features_num; i++)
 221                 if (strcasecmp (known_features[i].label, name) == 0)
 222                         return (known_features[i].type);
 223
 224         return (SENSOR_TYPE_UNKNOWN);
 225 } /* int sensors_feature_name_to_type */
 226 #endif
 227
 228 static int sensors_config (const char *key, const char *value)
 229 {
 230         if (sensor_list == NULL)
 231                 sensor_list = ignorelist_create (1);
 232
 233         /* TODO: This setting exists for compatibility with old versions of
 234          * lm-sensors. Remove support for those ancient versions in the next
 235          * major release. */
 236         if (strcasecmp (key, "SensorConfigFile") == 0)
 237         {
 238                 char *tmp = strdup (value);
 239                 if (tmp != NULL)
 240                 {
 241                         sfree (conffile);
 242                         conffile = tmp;
 243                 }
 244         }
 245         else if (strcasecmp (key, "Sensor") == 0)
 246         {
 247                 if (ignorelist_add (sensor_list, value))
 248                 {
 249                         ERROR ("sensors plugin: "
 250                                         "Cannot add value to ignorelist.");
 251                         return (1);
 252                 }
 253         }
 254         else if (strcasecmp (key, "IgnoreSelected") == 0)
 255         {
 256                 ignorelist_set_invert (sensor_list, 1);
 257                 if (IS_TRUE (value))
 258                         ignorelist_set_invert (sensor_list, 0);
 259         }
 260 #if (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
 261         else if (strcasecmp (key, "UseLabels") == 0)
 262         {
 263                 use_labels = IS_TRUE (value) ? 1 : 0;
 264         }
 265 #endif
 266         else
 267         {
 268                 return (-1);
 269         }
 270
 271         return (0);
 272 }
 273
 274 static void sensors_free_features (void)
 275 {
 276         featurelist_t *nextft;
 277
 278         if (first_feature == NULL)
 279                 return;
 280
 281         sensors_cleanup ();
 282
 283         for (featurelist_t *thisft = first_feature; thisft != NULL; thisft = nextft)
 284         {
 285                 nextft = thisft->next;
 286                 sfree (thisft);
 287         }
 288         first_feature = NULL;
 289 }
 290
 291 static int sensors_load_conf (void)
 292 {
 293         static int call_once = 0;
 294
 295         FILE *fh = NULL;
 296         featurelist_t *last_feature = NULL;
 297
 298         const sensors_chip_name *chip;
 299         int chip_num;
 300
 301         int status;
 302
 303         if (call_once)
 304                 return 0;
 305
 306         call_once = 1;
 307
 308         if (conffile != NULL)
 309         {
 310                 fh = fopen (conffile, "r");
 311                 if (fh == NULL)
 312                 {
 313                         char errbuf[1024];
 314                         ERROR ("sensors plugin: fopen(%s) failed: %s", conffile,
 315                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 316                         return (-1);
 317                 }
 318         }
 319
 320         status = sensors_init (fh);
 321         if (fh)
 322                 fclose (fh);
 323
 324         if (status != 0)
 325         {
 326                 ERROR ("sensors plugin: Cannot initialize sensors. "
 327                                 "Data will not be collected.");
 328                 return (-1);
 329         }
 330
 331 #if SENSORS_API_VERSION < 0x400
 332         chip_num = 0;
 333         while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
 334         {
 335                 int feature_num0 = 0;
 336                 int feature_num1 = 0;
 337
 338                 while (42)
 339                 {
 340                         const sensors_feature_data *feature;
 341                         int feature_type;
 342                         featurelist_t *fl;
 343
 344                         feature = sensors_get_all_features (*chip,
 345                                         &feature_num0, &feature_num1);
 346
 347                         /* Check if all features have been read. */
 348                         if (feature == NULL)
 349                                 break;
 350
 351                         /* "master features" only */
 352                         if (feature->mapping != SENSORS_NO_MAPPING)
 353                         {
 354                                 DEBUG ("sensors plugin: sensors_load_conf: "
 355                                                 "Ignoring subfeature `%s', "
 356                                                 "because (feature->mapping "
 357                                                 "!= SENSORS_NO_MAPPING).",
 358                                                 feature->name);
 359                                 continue;
 360                         }
 361
 362                         /* skip ignored in sensors.conf */
 363                         if (sensors_get_ignored (*chip, feature->number) == 0)
 364                         {
 365                                 DEBUG ("sensors plugin: sensors_load_conf: "
 366                                                 "Ignoring subfeature `%s', "
 367                                                 "because "
 368                                                 "`sensors_get_ignored' told "
 369                                                 "me so.",
 370                                                 feature->name);
 371                                 continue;
 372                         }
 373
 374                         feature_type = sensors_feature_name_to_type (
 375                                         feature->name);
 376                         if (feature_type == SENSOR_TYPE_UNKNOWN)
 377                         {
 378                                 DEBUG ("sensors plugin: sensors_load_conf: "
 379                                                 "Ignoring subfeature `%s', "
 380                                                 "because its type is "
 381                                                 "unknown.",
 382                                                 feature->name);
 383                                 continue;
 384                         }
 385
 386                         fl = calloc (1, sizeof (*fl));
 387                         if (fl == NULL)
 388                         {
 389                                 ERROR ("sensors plugin: calloc failed.");
 390                                 continue;
 391                         }
 392
 393                         fl->chip = chip;
 394                         fl->data = feature;
 395                         fl->type = feature_type;
 396
 397                         if (first_feature == NULL)
 398                                 first_feature = fl;
 399                         else
 400                                 last_feature->next = fl;
 401                         last_feature = fl;
 402                 } /* while sensors_get_all_features */
 403         } /* while sensors_get_detected_chips */
 404 /* #endif SENSORS_API_VERSION < 0x400 */
 405
 406 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
 407         chip_num = 0;
 408         while ((chip = sensors_get_detected_chips (NULL, &chip_num)) != NULL)
 409         {
 410                 const sensors_feature *feature;
 411                 int feature_num = 0;
 412
 413                 while ((feature = sensors_get_features (chip, &feature_num)) != NULL)
 414                 {
 415                         const sensors_subfeature *subfeature;
 416                         int subfeature_num = 0;
 417
 418                         /* Only handle voltage, fanspeeds and temperatures */
 419                         if ((feature->type != SENSORS_FEATURE_IN)
 420                                         && (feature->type != SENSORS_FEATURE_FAN)
 421                                         && (feature->type != SENSORS_FEATURE_TEMP)
 422                                         && (feature->type != SENSORS_FEATURE_POWER))
 423                         {
 424                                 DEBUG ("sensors plugin: sensors_load_conf: "
 425                                                 "Ignoring feature `%s', "
 426                                                 "because its type is not "
 427                                                 "supported.", feature->name);
 428                                 continue;
 429                         }
 430
 431                         while ((subfeature = sensors_get_all_subfeatures (chip,
 432                                                         feature, &subfeature_num)) != NULL)
 433                         {
 434                                 featurelist_t *fl;
 435
 436                                 if ((subfeature->type != SENSORS_SUBFEATURE_IN_INPUT)
 437                                                 && (subfeature->type != SENSORS_SUBFEATURE_FAN_INPUT)
 438                                                 && (subfeature->type != SENSORS_SUBFEATURE_TEMP_INPUT)
 439                                                 && (subfeature->type != SENSORS_SUBFEATURE_POWER_INPUT))
 440                                         continue;
 441
 442                                 fl = calloc (1, sizeof (*fl));
 443                                 if (fl == NULL)
 444                                 {
 445                                         ERROR ("sensors plugin: calloc failed.");
 446                                         continue;
 447                                 }
 448
 449                                 fl->chip = chip;
 450                                 fl->feature = feature;
 451                                 fl->subfeature = subfeature;
 452
 453                                 if (first_feature == NULL)
 454                                         first_feature = fl;
 455                                 else
 456                                         last_feature->next = fl;
 457                                 last_feature  = fl;
 458                         } /* while (subfeature) */
 459                 } /* while (feature) */
 460         } /* while (chip) */
 461 #endif /* (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
 462
 463         if (first_feature == NULL)
 464         {
 465                 sensors_cleanup ();
 466                 INFO ("sensors plugin: lm_sensors reports no "
 467                                 "features. Data will not be collected.");
 468                 return (-1);
 469         }
 470
 471         return (0);
 472 } /* int sensors_load_conf */
 473
 474 static int sensors_shutdown (void)
 475 {
 476         sensors_free_features ();
 477         ignorelist_free (sensor_list);
 478
 479         return (0);
 480 } /* int sensors_shutdown */
 481
 482 static void sensors_submit (const char *plugin_instance,
 483                 const char *type, const char *type_instance,
 484                 double value)
 485 {
 486         char match_key[1024];
 487         int status;
 488
 489         value_list_t vl = VALUE_LIST_INIT;
 490
 491         status = ssnprintf (match_key, sizeof (match_key), "%s/%s-%s",
 492                         plugin_instance, type, type_instance);
 493         if (status < 1)
 494                 return;
 495
 496         if (sensor_list != NULL)
 497         {
 498                 DEBUG ("sensors plugin: Checking ignorelist for `%s'", match_key);
 499                 if (ignorelist_match (sensor_list, match_key))
 500                         return;
 501         }
 502
 503         vl.values = &(value_t) { .gauge = value };
 504         vl.values_len = 1;
 505
 506         sstrncpy (vl.plugin, "sensors", sizeof (vl.plugin));
 507         sstrncpy (vl.plugin_instance, plugin_instance,
 508                         sizeof (vl.plugin_instance));
 509         sstrncpy (vl.type, type, sizeof (vl.type));
 510         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 511
 512         plugin_dispatch_values (&vl);
 513 } /* void sensors_submit */
 514
 515 static int sensors_read (void)
 516 {
 517         if (sensors_load_conf () != 0)
 518                 return (-1);
 519
 520 #if SENSORS_API_VERSION < 0x400
 521         for (featurelist_t *fl = first_feature; fl != NULL; fl = fl->next)
 522         {
 523                 double value;
 524                 int status;
 525                 char plugin_instance[DATA_MAX_NAME_LEN];
 526                 char type_instance[DATA_MAX_NAME_LEN];
 527
 528                 status = sensors_get_feature (*fl->chip,
 529                                 fl->data->number, &value);
 530                 if (status < 0)
 531                         continue;
 532
 533                 status = sensors_snprintf_chip_name (plugin_instance,
 534                                 sizeof (plugin_instance), fl->chip);
 535                 if (status < 0)
 536                         continue;
 537
 538                 sstrncpy (type_instance, fl->data->name,
 539                                 sizeof (type_instance));
 540
 541                 sensors_submit (plugin_instance,
 542                                 sensor_type_name_map[fl->type],
 543                                 type_instance,
 544                                 value);
 545         } /* for fl = first_feature .. NULL */
 546 /* #endif SENSORS_API_VERSION < 0x400 */
 547
 548 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
 549         for (featurelist_t *fl = first_feature; fl != NULL; fl = fl->next)
 550         {
 551                 double value;
 552                 int status;
 553                 char plugin_instance[DATA_MAX_NAME_LEN];
 554                 char type_instance[DATA_MAX_NAME_LEN];
 555                 char *sensor_label;
 556                 const char *type;
 557
 558                 status = sensors_get_value (fl->chip,
 559                                 fl->subfeature->number, &value);
 560                 if (status < 0)
 561                         continue;
 562
 563                 status = sensors_snprintf_chip_name (plugin_instance,
 564                                 sizeof (plugin_instance), fl->chip);
 565                 if (status < 0)
 566                         continue;
 567
 568                 if (use_labels)
 569                 {
 570                         sensor_label = sensors_get_label (fl->chip, fl->feature);
 571                         sstrncpy (type_instance, sensor_label, sizeof (type_instance));
 572                         free (sensor_label);
 573                 }
 574                 else
 575                 {
 576                         sstrncpy (type_instance, fl->feature->name,
 577                                         sizeof (type_instance));
 578                 }
 579
 580                 if (fl->feature->type == SENSORS_FEATURE_IN)
 581                         type = "voltage";
 582                 else if (fl->feature->type
 583                                 == SENSORS_FEATURE_FAN)
 584                         type = "fanspeed";
 585                 else if (fl->feature->type
 586                                 == SENSORS_FEATURE_TEMP)
 587                         type = "temperature";
 588                 else if (fl->feature->type
 589                                 == SENSORS_FEATURE_POWER)
 590                         type = "power";
 591                 else
 592                         continue;
 593
 594                 sensors_submit (plugin_instance, type, type_instance, value);
 595         } /* for fl = first_feature .. NULL */
 596 #endif /* (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
 597
 598         return (0);
 599 } /* int sensors_read */
 600
 601 void module_register (void)
 602 {
 603         plugin_register_config ("sensors", sensors_config,
 604                         config_keys, config_keys_num);
 605         plugin_register_read ("sensors", sensors_read);
 606         plugin_register_shutdown ("sensors", sensors_shutdown);
 607 } /* void module_register */