2 * collectd - src/sensors.c
3 * Copyright (C) 2005-2008 Florian octo Forster
4 * Copyright (C) 2006 Luboš Staněk
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.
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.
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
20 * Florian octo Forster <octo at verplant.org>
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
35 #include "configfile.h"
36 #include "utils_ignorelist.h"
38 #if defined(HAVE_SENSORS_SENSORS_H)
39 # include <sensors/sensors.h>
42 #if !defined(SENSORS_API_VERSION)
43 # define SENSORS_API_VERSION 0x000
47 * The sensors library prior to version 3.0 (internal version 0x400) didn't
48 * report the type of values, only a name. The following lists are there to
49 * convert from the names to the type. They are not used with the new
52 #if SENSORS_API_VERSION < 0x400
53 static char *sensor_type_name_map[] =
55 # define SENSOR_TYPE_VOLTAGE 0
57 # define SENSOR_TYPE_FANSPEED 1
59 # define SENSOR_TYPE_TEMPERATURE 2
61 # define SENSOR_TYPE_UNKNOWN 3
65 struct sensors_labeltypes_s
70 typedef struct sensors_labeltypes_s sensors_labeltypes_t;
72 /* finite list of known labels extracted from lm_sensors */
73 static sensors_labeltypes_t known_features[] =
75 { "fan1", SENSOR_TYPE_FANSPEED },
76 { "fan2", SENSOR_TYPE_FANSPEED },
77 { "fan3", SENSOR_TYPE_FANSPEED },
78 { "fan4", SENSOR_TYPE_FANSPEED },
79 { "fan5", SENSOR_TYPE_FANSPEED },
80 { "fan6", SENSOR_TYPE_FANSPEED },
81 { "fan7", SENSOR_TYPE_FANSPEED },
82 { "AIN2", SENSOR_TYPE_VOLTAGE },
83 { "AIN1", SENSOR_TYPE_VOLTAGE },
84 { "in10", SENSOR_TYPE_VOLTAGE },
85 { "in9", SENSOR_TYPE_VOLTAGE },
86 { "in8", SENSOR_TYPE_VOLTAGE },
87 { "in7", SENSOR_TYPE_VOLTAGE },
88 { "in6", SENSOR_TYPE_VOLTAGE },
89 { "in5", SENSOR_TYPE_VOLTAGE },
90 { "in4", SENSOR_TYPE_VOLTAGE },
91 { "in3", SENSOR_TYPE_VOLTAGE },
92 { "in2", SENSOR_TYPE_VOLTAGE },
93 { "in0", SENSOR_TYPE_VOLTAGE },
94 { "CPU_Temp", SENSOR_TYPE_TEMPERATURE },
95 { "remote_temp", SENSOR_TYPE_TEMPERATURE },
96 { "temp1", SENSOR_TYPE_TEMPERATURE },
97 { "temp2", SENSOR_TYPE_TEMPERATURE },
98 { "temp3", SENSOR_TYPE_TEMPERATURE },
99 { "temp4", SENSOR_TYPE_TEMPERATURE },
100 { "temp5", SENSOR_TYPE_TEMPERATURE },
101 { "temp6", SENSOR_TYPE_TEMPERATURE },
102 { "temp7", SENSOR_TYPE_TEMPERATURE },
103 { "temp", SENSOR_TYPE_TEMPERATURE },
104 { "Vccp2", SENSOR_TYPE_VOLTAGE },
105 { "Vccp1", SENSOR_TYPE_VOLTAGE },
106 { "vdd", SENSOR_TYPE_VOLTAGE },
107 { "vid5", SENSOR_TYPE_VOLTAGE },
108 { "vid4", SENSOR_TYPE_VOLTAGE },
109 { "vid3", SENSOR_TYPE_VOLTAGE },
110 { "vid2", SENSOR_TYPE_VOLTAGE },
111 { "vid1", SENSOR_TYPE_VOLTAGE },
112 { "vid", SENSOR_TYPE_VOLTAGE },
113 { "vin4", SENSOR_TYPE_VOLTAGE },
114 { "vin3", SENSOR_TYPE_VOLTAGE },
115 { "vin2", SENSOR_TYPE_VOLTAGE },
116 { "vin1", SENSOR_TYPE_VOLTAGE },
117 { "voltbatt", SENSOR_TYPE_VOLTAGE },
118 { "volt12", SENSOR_TYPE_VOLTAGE },
119 { "volt5", SENSOR_TYPE_VOLTAGE },
120 { "vrm", SENSOR_TYPE_VOLTAGE },
121 { "5.0V", SENSOR_TYPE_VOLTAGE },
122 { "5V", SENSOR_TYPE_VOLTAGE },
123 { "3.3V", SENSOR_TYPE_VOLTAGE },
124 { "2.5V", SENSOR_TYPE_VOLTAGE },
125 { "2.0V", SENSOR_TYPE_VOLTAGE },
126 { "12V", SENSOR_TYPE_VOLTAGE }
128 static int known_features_num = STATIC_ARRAY_SIZE (known_features);
130 #endif /* SENSORS_API_VERSION < 0x400 */
132 static const char *config_keys[] =
137 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
139 #if SENSORS_API_VERSION < 0x400
140 typedef struct featurelist
142 const sensors_chip_name *chip;
143 const sensors_feature_data *data;
145 struct featurelist *next;
148 # ifndef SENSORS_CONF_PATH
149 # define SENSORS_CONF_PATH "/etc/sensors.conf"
151 /* #endif SENSORS_API_VERSION < 0x400 */
153 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
154 typedef struct featurelist
156 const sensors_chip_name *chip;
157 const sensors_feature *feature;
158 const sensors_subfeature *subfeature;
159 struct featurelist *next;
162 # ifndef SENSORS_CONF_PATH
163 # define SENSORS_CONF_PATH "/etc/sensors3.conf"
165 /* #endif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
167 #else /* if SENSORS_API_VERSION >= 0x500 */
168 # error "This version of libsensors is not supported yet. Please report this " \
172 static const char *conffile = SENSORS_CONF_PATH;
173 featurelist_t *first_feature = NULL;
174 static ignorelist_t *sensor_list;
175 static time_t sensors_config_mtime = 0;
177 #if SENSORS_API_VERSION < 0x400
178 /* full chip name logic borrowed from lm_sensors */
179 static int sensors_snprintf_chip_name (char *buf, size_t buf_size,
180 const sensors_chip_name *chip)
184 if (chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
186 status = ssnprintf (buf, buf_size,
191 else if (chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
193 status = snprintf (buf, buf_size, "%s-%s-%04x",
200 status = snprintf (buf, buf_size, "%s-i2c-%d-%02x",
207 } /* int sensors_snprintf_chip_name */
209 static int sensors_feature_name_to_type (const char *name)
213 /* Yes, this is slow, but it's only ever done during initialization, so
214 * it's a one time cost.. */
215 for (i = 0; i < known_features_num; i++)
216 if (strcasecmp (known_features[i].label, name) == 0)
217 return (known_features[i].type);
219 return (SENSOR_TYPE_UNKNOWN);
220 } /* int sensors_feature_name_to_type */
223 static int sensors_config (const char *key, const char *value)
225 if (sensor_list == NULL)
226 sensor_list = ignorelist_create (1);
228 if (strcasecmp (key, "Sensor") == 0)
230 if (ignorelist_add (sensor_list, value))
232 ERROR ("sensors plugin: "
233 "Cannot add value to ignorelist.");
237 else if (strcasecmp (key, "IgnoreSelected") == 0)
239 ignorelist_set_invert (sensor_list, 1);
240 if ((strcasecmp (value, "True") == 0)
241 || (strcasecmp (value, "Yes") == 0)
242 || (strcasecmp (value, "On") == 0))
243 ignorelist_set_invert (sensor_list, 0);
253 void sensors_free_features (void)
255 featurelist_t *thisft;
256 featurelist_t *nextft;
258 if (first_feature == NULL)
263 for (thisft = first_feature; thisft != NULL; thisft = nextft)
265 nextft = thisft->next;
268 first_feature = NULL;
271 static int sensors_load_conf (void)
274 featurelist_t *last_feature = NULL;
276 const sensors_chip_name *chip;
282 status = stat (conffile, &statbuf);
286 ERROR ("sensors plugin: stat (%s) failed: %s", conffile,
287 sstrerror (errno, errbuf, sizeof (errbuf)));
288 sensors_config_mtime = 0;
291 if ((sensors_config_mtime != 0)
292 && (sensors_config_mtime == statbuf.st_mtime))
295 if (sensors_config_mtime != 0)
297 NOTICE ("sensors plugin: Reloading config from %s",
299 sensors_free_features ();
300 sensors_config_mtime = 0;
303 fh = fopen (conffile, "r");
307 ERROR ("sensors plugin: fopen(%s) failed: %s", conffile,
308 sstrerror (errno, errbuf, sizeof (errbuf)));
312 status = sensors_init (fh);
316 ERROR ("sensors plugin: Cannot initialize sensors. "
317 "Data will not be collected.");
321 sensors_config_mtime = statbuf.st_mtime;
323 #if SENSORS_API_VERSION < 0x400
325 while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
327 int feature_num0 = 0;
328 int feature_num1 = 0;
332 const sensors_feature_data *feature;
336 feature = sensors_get_all_features (*chip,
337 &feature_num0, &feature_num1);
339 /* Check if all features have been read. */
343 /* "master features" only */
344 if (feature->mapping != SENSORS_NO_MAPPING)
346 DEBUG ("sensors plugin: sensors_load_conf: "
347 "Ignoring subfeature `%s', "
348 "because (feature->mapping "
349 "!= SENSORS_NO_MAPPING).",
354 /* skip ignored in sensors.conf */
355 if (sensors_get_ignored (*chip, feature->number) == 0)
357 DEBUG ("sensors plugin: sensors_load_conf: "
358 "Ignoring subfeature `%s', "
360 "`sensors_get_ignored' told "
366 feature_type = sensors_feature_name_to_type (
368 if (feature_type == SENSOR_TYPE_UNKNOWN)
370 DEBUG ("sensors plugin: sensors_load_conf: "
371 "Ignoring subfeature `%s', "
372 "because its type is "
378 fl = (featurelist_t *) malloc (sizeof (featurelist_t));
381 ERROR ("sensors plugin: malloc failed.");
384 memset (fl, '\0', sizeof (featurelist_t));
388 fl->type = feature_type;
390 if (first_feature == NULL)
393 last_feature->next = fl;
395 } /* while sensors_get_all_features */
396 } /* while sensors_get_detected_chips */
397 /* #endif SENSORS_API_VERSION < 0x400 */
399 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
401 while ((chip = sensors_get_detected_chips (NULL, &chip_num)) != NULL)
403 const sensors_feature *feature;
406 while ((feature = sensors_get_features (chip, &feature_num)) != NULL)
408 const sensors_subfeature *subfeature;
409 int subfeature_num = 0;
411 /* Only handle voltage, fanspeeds and temperatures */
412 if ((feature->type != SENSORS_FEATURE_IN)
413 && (feature->type != SENSORS_FEATURE_FAN)
414 && (feature->type != SENSORS_FEATURE_TEMP))
416 DEBUG ("sensors plugin: sensors_load_conf: "
417 "Ignoring feature `%s', "
418 "because its type is not "
419 "supported.", feature->name);
423 while ((subfeature = sensors_get_all_subfeatures (chip,
424 feature, &subfeature_num)) != NULL)
428 if ((subfeature->type != SENSORS_SUBFEATURE_IN_INPUT)
429 && (subfeature->type != SENSORS_SUBFEATURE_FAN_INPUT)
430 && (subfeature->type != SENSORS_SUBFEATURE_TEMP_INPUT))
433 fl = (featurelist_t *) malloc (sizeof (featurelist_t));
436 ERROR ("sensors plugin: malloc failed.");
439 memset (fl, '\0', sizeof (featurelist_t));
442 fl->feature = feature;
443 fl->subfeature = subfeature;
445 if (first_feature == NULL)
448 last_feature->next = fl;
450 } /* while (subfeature) */
451 } /* while (feature) */
453 #endif /* (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
455 if (first_feature == NULL)
458 INFO ("sensors plugin: lm_sensors reports no "
459 "features. Data will not be collected.");
464 } /* int sensors_load_conf */
466 static int sensors_shutdown (void)
468 sensors_free_features ();
469 ignorelist_free (sensor_list);
472 } /* int sensors_shutdown */
474 static void sensors_submit (const char *plugin_instance,
475 const char *type, const char *type_instance,
478 char match_key[1024];
482 value_list_t vl = VALUE_LIST_INIT;
484 status = ssnprintf (match_key, sizeof (match_key), "%s/%s-%s",
485 plugin_instance, type, type_instance);
489 if (sensor_list != NULL)
491 DEBUG ("sensors plugin: Checking ignorelist for `%s'", match_key);
492 if (ignorelist_match (sensor_list, match_key))
496 values[0].gauge = val;
501 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
502 sstrncpy (vl.plugin, "sensors", sizeof (vl.plugin));
503 sstrncpy (vl.plugin_instance, plugin_instance,
504 sizeof (vl.plugin_instance));
505 sstrncpy (vl.type, type, sizeof (vl.type));
506 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
508 plugin_dispatch_values (&vl);
509 } /* void sensors_submit */
511 static int sensors_read (void)
515 if (sensors_load_conf () != 0)
518 #if SENSORS_API_VERSION < 0x400
519 for (fl = first_feature; fl != NULL; fl = fl->next)
523 char plugin_instance[DATA_MAX_NAME_LEN];
524 char type_instance[DATA_MAX_NAME_LEN];
526 status = sensors_get_feature (*fl->chip,
527 fl->data->number, &value);
531 status = sensors_snprintf_chip_name (plugin_instance,
532 sizeof (plugin_instance), fl->chip);
536 sstrncpy (type_instance, fl->data->name,
537 sizeof (type_instance));
539 sensors_submit (plugin_instance,
540 sensor_type_name_map[fl->type],
543 } /* for fl = first_feature .. NULL */
544 /* #endif SENSORS_API_VERSION < 0x400 */
546 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
547 for (fl = first_feature; fl != NULL; fl = fl->next)
551 char plugin_instance[DATA_MAX_NAME_LEN];
552 char type_instance[DATA_MAX_NAME_LEN];
555 status = sensors_get_value (fl->chip,
556 fl->subfeature->number, &value);
560 status = sensors_snprintf_chip_name (plugin_instance,
561 sizeof (plugin_instance), fl->chip);
565 sstrncpy (type_instance, fl->feature->name,
566 sizeof (type_instance));
568 if (fl->feature->type == SENSORS_FEATURE_IN)
570 else if (fl->feature->type
571 == SENSORS_FEATURE_FAN)
573 else if (fl->feature->type
574 == SENSORS_FEATURE_TEMP)
575 type = "temperature";
579 sensors_submit (plugin_instance, type, type_instance, value);
580 } /* for fl = first_feature .. NULL */
581 #endif /* (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
584 } /* int sensors_read */
586 void module_register (void)
588 plugin_register_config ("sensors", sensors_config,
589 config_keys, config_keys_num);
590 plugin_register_read ("sensors", sensors_read);
591 plugin_register_shutdown ("sensors", sensors_shutdown);
592 } /* void module_register */