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 collectd.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
31 * Henrique de Moraes Holschuh <hmh at debian.org>
32 * - use default libsensors config file on API 0x400
33 * - config SensorConfigFile option
40 #include "utils_ignorelist.h"
42 #if defined(HAVE_SENSORS_SENSORS_H)
43 #include <sensors/sensors.h>
46 #if !defined(SENSORS_API_VERSION)
47 #define SENSORS_API_VERSION 0x000
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
56 #if SENSORS_API_VERSION < 0x400
57 static char *sensor_type_name_map[] = {
58 #define SENSOR_TYPE_VOLTAGE 0
60 #define SENSOR_TYPE_FANSPEED 1
62 #define SENSOR_TYPE_TEMPERATURE 2
64 #define SENSOR_TYPE_POWER 3
66 #define SENSOR_TYPE_UNKNOWN 4
69 struct sensors_labeltypes_s {
73 typedef struct sensors_labeltypes_s sensors_labeltypes_t;
75 /* finite list of known labels extracted from lm_sensors */
76 static sensors_labeltypes_t known_features[] = {
77 {"fan1", SENSOR_TYPE_FANSPEED},
78 {"fan2", SENSOR_TYPE_FANSPEED},
79 {"fan3", SENSOR_TYPE_FANSPEED},
80 {"fan4", SENSOR_TYPE_FANSPEED},
81 {"fan5", SENSOR_TYPE_FANSPEED},
82 {"fan6", SENSOR_TYPE_FANSPEED},
83 {"fan7", SENSOR_TYPE_FANSPEED},
84 {"AIN2", SENSOR_TYPE_VOLTAGE},
85 {"AIN1", SENSOR_TYPE_VOLTAGE},
86 {"in10", SENSOR_TYPE_VOLTAGE},
87 {"in9", SENSOR_TYPE_VOLTAGE},
88 {"in8", SENSOR_TYPE_VOLTAGE},
89 {"in7", SENSOR_TYPE_VOLTAGE},
90 {"in6", SENSOR_TYPE_VOLTAGE},
91 {"in5", SENSOR_TYPE_VOLTAGE},
92 {"in4", SENSOR_TYPE_VOLTAGE},
93 {"in3", SENSOR_TYPE_VOLTAGE},
94 {"in2", SENSOR_TYPE_VOLTAGE},
95 {"in0", SENSOR_TYPE_VOLTAGE},
96 {"CPU_Temp", SENSOR_TYPE_TEMPERATURE},
97 {"remote_temp", SENSOR_TYPE_TEMPERATURE},
98 {"temp1", SENSOR_TYPE_TEMPERATURE},
99 {"temp2", SENSOR_TYPE_TEMPERATURE},
100 {"temp3", SENSOR_TYPE_TEMPERATURE},
101 {"temp4", SENSOR_TYPE_TEMPERATURE},
102 {"temp5", SENSOR_TYPE_TEMPERATURE},
103 {"temp6", SENSOR_TYPE_TEMPERATURE},
104 {"temp7", SENSOR_TYPE_TEMPERATURE},
105 {"temp", SENSOR_TYPE_TEMPERATURE},
106 {"Vccp2", SENSOR_TYPE_VOLTAGE},
107 {"Vccp1", SENSOR_TYPE_VOLTAGE},
108 {"vdd", SENSOR_TYPE_VOLTAGE},
109 {"vid5", SENSOR_TYPE_VOLTAGE},
110 {"vid4", SENSOR_TYPE_VOLTAGE},
111 {"vid3", SENSOR_TYPE_VOLTAGE},
112 {"vid2", SENSOR_TYPE_VOLTAGE},
113 {"vid1", SENSOR_TYPE_VOLTAGE},
114 {"vid", SENSOR_TYPE_VOLTAGE},
115 {"vin4", SENSOR_TYPE_VOLTAGE},
116 {"vin3", SENSOR_TYPE_VOLTAGE},
117 {"vin2", SENSOR_TYPE_VOLTAGE},
118 {"vin1", SENSOR_TYPE_VOLTAGE},
119 {"voltbatt", SENSOR_TYPE_VOLTAGE},
120 {"volt12", SENSOR_TYPE_VOLTAGE},
121 {"volt5", SENSOR_TYPE_VOLTAGE},
122 {"vrm", SENSOR_TYPE_VOLTAGE},
123 {"5.0V", SENSOR_TYPE_VOLTAGE},
124 {"5V", SENSOR_TYPE_VOLTAGE},
125 {"3.3V", SENSOR_TYPE_VOLTAGE},
126 {"2.5V", SENSOR_TYPE_VOLTAGE},
127 {"2.0V", SENSOR_TYPE_VOLTAGE},
128 {"12V", SENSOR_TYPE_VOLTAGE},
129 {"power1", SENSOR_TYPE_POWER}};
130 static int known_features_num = STATIC_ARRAY_SIZE(known_features);
132 #endif /* SENSORS_API_VERSION < 0x400 */
134 static const char *config_keys[] = {"Sensor", "IgnoreSelected",
135 "SensorConfigFile", "UseLabels"};
136 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
138 #if SENSORS_API_VERSION < 0x400
139 typedef struct featurelist {
140 const sensors_chip_name *chip;
141 const sensors_feature_data *data;
143 struct featurelist *next;
146 #ifndef SENSORS_CONF_PATH
147 #define SENSORS_CONF_PATH "/etc/sensors.conf"
149 static char *conffile = SENSORS_CONF_PATH;
150 /* #endif SENSORS_API_VERSION < 0x400 */
152 #elif (SENSORS_API_VERSION >= 0x400)
153 typedef struct featurelist {
154 const sensors_chip_name *chip;
155 const sensors_feature *feature;
156 const sensors_subfeature *subfeature;
157 struct featurelist *next;
160 static char *conffile;
161 static bool use_labels;
164 static featurelist_t *first_feature;
165 static ignorelist_t *sensor_list;
167 #if SENSORS_API_VERSION < 0x400
168 /* full chip name logic borrowed from lm_sensors */
169 static int sensors_snprintf_chip_name(char *buf, size_t buf_size,
170 const sensors_chip_name *chip) {
173 if (chip->bus == SENSORS_CHIP_NAME_BUS_ISA) {
174 status = snprintf(buf, buf_size, "%s-isa-%04x", chip->prefix, chip->addr);
175 } else if (chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY) {
176 status = snprintf(buf, buf_size, "%s-%s-%04x", chip->prefix, chip->busname,
179 status = snprintf(buf, buf_size, "%s-i2c-%d-%02x", chip->prefix, chip->bus,
184 } /* int sensors_snprintf_chip_name */
186 static int sensors_feature_name_to_type(const char *name) {
187 /* Yes, this is slow, but it's only ever done during initialization, so
188 * it's a one time cost.. */
189 for (int i = 0; i < known_features_num; i++)
190 if (strcasecmp(known_features[i].label, name) == 0)
191 return known_features[i].type;
193 return SENSOR_TYPE_UNKNOWN;
194 } /* int sensors_feature_name_to_type */
197 static int sensors_config(const char *key, const char *value) {
198 if (sensor_list == NULL)
199 sensor_list = ignorelist_create(1);
201 /* TODO: This setting exists for compatibility with old versions of
202 * lm-sensors. Remove support for those ancient versions in the next
204 if (strcasecmp(key, "SensorConfigFile") == 0) {
205 char *tmp = strdup(value);
210 } else if (strcasecmp(key, "Sensor") == 0) {
211 if (ignorelist_add(sensor_list, value)) {
212 ERROR("sensors plugin: "
213 "Cannot add value to ignorelist.");
216 } else if (strcasecmp(key, "IgnoreSelected") == 0) {
217 ignorelist_set_invert(sensor_list, 1);
219 ignorelist_set_invert(sensor_list, 0);
221 #if (SENSORS_API_VERSION >= 0x400)
222 else if (strcasecmp(key, "UseLabels") == 0) {
223 use_labels = IS_TRUE(value);
233 static void sensors_free_features(void) {
234 featurelist_t *nextft;
236 if (first_feature == NULL)
241 for (featurelist_t *thisft = first_feature; thisft != NULL; thisft = nextft) {
242 nextft = thisft->next;
245 first_feature = NULL;
248 static int sensors_load_conf(void) {
249 static int call_once;
252 featurelist_t *last_feature = NULL;
254 const sensors_chip_name *chip;
264 if (conffile != NULL) {
265 fh = fopen(conffile, "r");
267 ERROR("sensors plugin: fopen(%s) failed: %s", conffile, STRERRNO);
272 status = sensors_init(fh);
277 ERROR("sensors plugin: Cannot initialize sensors. "
278 "Data will not be collected.");
282 #if SENSORS_API_VERSION < 0x400
284 while ((chip = sensors_get_detected_chips(&chip_num)) != NULL) {
285 int feature_num0 = 0;
286 int feature_num1 = 0;
289 const sensors_feature_data *feature;
293 feature = sensors_get_all_features(*chip, &feature_num0, &feature_num1);
295 /* Check if all features have been read. */
299 /* "master features" only */
300 if (feature->mapping != SENSORS_NO_MAPPING) {
301 DEBUG("sensors plugin: sensors_load_conf: "
302 "Ignoring subfeature `%s', "
303 "because (feature->mapping "
304 "!= SENSORS_NO_MAPPING).",
309 /* skip ignored in sensors.conf */
310 if (sensors_get_ignored(*chip, feature->number) == 0) {
311 DEBUG("sensors plugin: sensors_load_conf: "
312 "Ignoring subfeature `%s', "
314 "`sensors_get_ignored' told "
320 feature_type = sensors_feature_name_to_type(feature->name);
321 if (feature_type == SENSOR_TYPE_UNKNOWN) {
322 DEBUG("sensors plugin: sensors_load_conf: "
323 "Ignoring subfeature `%s', "
324 "because its type is "
330 fl = calloc(1, sizeof(*fl));
332 ERROR("sensors plugin: calloc failed.");
338 fl->type = feature_type;
340 if (first_feature == NULL)
343 last_feature->next = fl;
345 } /* while sensors_get_all_features */
346 } /* while sensors_get_detected_chips */
347 /* #endif SENSORS_API_VERSION < 0x400 */
349 #elif (SENSORS_API_VERSION >= 0x400)
351 while ((chip = sensors_get_detected_chips(NULL, &chip_num)) != NULL) {
352 const sensors_feature *feature;
355 while ((feature = sensors_get_features(chip, &feature_num)) != NULL) {
356 const sensors_subfeature *subfeature;
357 int subfeature_num = 0;
359 /* Only handle voltage, fanspeeds and temperatures */
360 if ((feature->type != SENSORS_FEATURE_IN) &&
361 (feature->type != SENSORS_FEATURE_FAN) &&
362 (feature->type != SENSORS_FEATURE_TEMP) &&
363 #if SENSORS_API_VERSION >= 0x402
364 (feature->type != SENSORS_FEATURE_CURR) &&
366 #if SENSORS_API_VERSION >= 0x431
367 (feature->type != SENSORS_FEATURE_HUMIDITY) &&
369 (feature->type != SENSORS_FEATURE_POWER)) {
370 DEBUG("sensors plugin: sensors_load_conf: "
371 "Ignoring feature `%s', "
372 "because its type is not "
378 while ((subfeature = sensors_get_all_subfeatures(
379 chip, feature, &subfeature_num)) != NULL) {
382 if ((subfeature->type != SENSORS_SUBFEATURE_IN_INPUT) &&
383 (subfeature->type != SENSORS_SUBFEATURE_FAN_INPUT) &&
384 (subfeature->type != SENSORS_SUBFEATURE_TEMP_INPUT) &&
385 #if SENSORS_API_VERSION >= 0x402
386 (subfeature->type != SENSORS_SUBFEATURE_CURR_INPUT) &&
388 #if SENSORS_API_VERSION >= 0x431
389 (subfeature->type != SENSORS_SUBFEATURE_HUMIDITY_INPUT) &&
391 (subfeature->type != SENSORS_SUBFEATURE_POWER_INPUT))
394 fl = calloc(1, sizeof(*fl));
396 ERROR("sensors plugin: calloc failed.");
401 fl->feature = feature;
402 fl->subfeature = subfeature;
404 if (first_feature == NULL)
407 last_feature->next = fl;
409 } /* while (subfeature) */
410 } /* while (feature) */
412 #endif /* (SENSORS_API_VERSION >= 0x400) */
414 if (first_feature == NULL) {
416 INFO("sensors plugin: lm_sensors reports no "
417 "features. Data will not be collected.");
422 } /* int sensors_load_conf */
424 static int sensors_shutdown(void) {
425 sensors_free_features();
426 ignorelist_free(sensor_list);
429 } /* int sensors_shutdown */
431 static void sensors_submit(const char *plugin_instance, const char *type,
432 const char *type_instance, double value) {
433 char match_key[1024];
436 value_list_t vl = VALUE_LIST_INIT;
438 status = snprintf(match_key, sizeof(match_key), "%s/%s-%s", plugin_instance,
439 type, type_instance);
443 if (sensor_list != NULL) {
444 DEBUG("sensors plugin: Checking ignorelist for `%s'", match_key);
445 if (ignorelist_match(sensor_list, match_key))
449 vl.values = &(value_t){.gauge = value};
452 sstrncpy(vl.plugin, "sensors", sizeof(vl.plugin));
453 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
454 sstrncpy(vl.type, type, sizeof(vl.type));
455 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
457 plugin_dispatch_values(&vl);
458 } /* void sensors_submit */
460 static int sensors_read(void) {
461 if (sensors_load_conf() != 0)
464 #if SENSORS_API_VERSION < 0x400
465 for (featurelist_t *fl = first_feature; fl != NULL; fl = fl->next) {
468 char plugin_instance[DATA_MAX_NAME_LEN];
469 char type_instance[DATA_MAX_NAME_LEN];
471 status = sensors_get_feature(*fl->chip, fl->data->number, &value);
475 status = sensors_snprintf_chip_name(plugin_instance,
476 sizeof(plugin_instance), fl->chip);
480 sstrncpy(type_instance, fl->data->name, sizeof(type_instance));
482 sensors_submit(plugin_instance, sensor_type_name_map[fl->type],
483 type_instance, value);
484 } /* for fl = first_feature .. NULL */
485 /* #endif SENSORS_API_VERSION < 0x400 */
487 #elif (SENSORS_API_VERSION >= 0x400)
488 for (featurelist_t *fl = first_feature; fl != NULL; fl = fl->next) {
491 char plugin_instance[DATA_MAX_NAME_LEN];
492 char type_instance[DATA_MAX_NAME_LEN];
496 status = sensors_get_value(fl->chip, fl->subfeature->number, &value);
500 status = sensors_snprintf_chip_name(plugin_instance,
501 sizeof(plugin_instance), fl->chip);
506 sensor_label = sensors_get_label(fl->chip, fl->feature);
507 sstrncpy(type_instance, sensor_label, sizeof(type_instance));
510 sstrncpy(type_instance, fl->feature->name, sizeof(type_instance));
513 if (fl->feature->type == SENSORS_FEATURE_IN)
515 else if (fl->feature->type == SENSORS_FEATURE_FAN)
517 else if (fl->feature->type == SENSORS_FEATURE_TEMP)
518 type = "temperature";
519 else if (fl->feature->type == SENSORS_FEATURE_POWER)
521 #if SENSORS_API_VERSION >= 0x402
522 else if (fl->feature->type == SENSORS_FEATURE_CURR)
525 #if SENSORS_API_VERSION >= 0x431
526 else if (fl->feature->type == SENSORS_FEATURE_HUMIDITY)
532 sensors_submit(plugin_instance, type, type_instance, value);
533 } /* for fl = first_feature .. NULL */
534 #endif /* (SENSORS_API_VERSION >= 0x400) */
537 } /* int sensors_read */
539 void module_register(void) {
540 plugin_register_config("sensors", sensors_config, config_keys,
542 plugin_register_read("sensors", sensors_read);
543 plugin_register_shutdown("sensors", sensors_shutdown);
544 } /* void module_register */