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 **/
36 #include "collectd.h"
38 #include "common.h"
39 #include "plugin.h"
40 #include "utils_ignorelist.h"
42 #if defined(HAVE_SENSORS_SENSORS_H)
43 #include <sensors/sensors.h>
44 #endif
46 #if !defined(SENSORS_API_VERSION)
47 #define SENSORS_API_VERSION 0x000
48 #endif
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 #define SENSOR_TYPE_VOLTAGE 0
59 "voltage",
60 #define SENSOR_TYPE_FANSPEED 1
61 "fanspeed",
62 #define SENSOR_TYPE_TEMPERATURE 2
63 "temperature",
64 #define SENSOR_TYPE_POWER 3
65 "power",
66 #define SENSOR_TYPE_UNKNOWN 4
67 NULL};
69 struct sensors_labeltypes_s {
70 char *label;
71 int type;
72 };
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);
131 /* end new naming */
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;
142 int type;
143 struct featurelist *next;
144 } featurelist_t;
146 #ifndef SENSORS_CONF_PATH
147 #define SENSORS_CONF_PATH "/etc/sensors.conf"
148 #endif
149 static char *conffile = SENSORS_CONF_PATH;
150 /* #endif SENSORS_API_VERSION < 0x400 */
152 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
153 typedef struct featurelist {
154 const sensors_chip_name *chip;
155 const sensors_feature *feature;
156 const sensors_subfeature *subfeature;
157 struct featurelist *next;
158 } featurelist_t;
160 static char *conffile = NULL;
161 static _Bool use_labels = 0;
162 /* #endif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
164 #else /* if SENSORS_API_VERSION >= 0x500 */
165 #error "This version of libsensors is not supported yet. Please report this " \
166 "as bug."
167 #endif
169 static featurelist_t *first_feature = NULL;
170 static ignorelist_t *sensor_list;
172 #if SENSORS_API_VERSION < 0x400
173 /* full chip name logic borrowed from lm_sensors */
174 static int sensors_snprintf_chip_name(char *buf, size_t buf_size,
175 const sensors_chip_name *chip) {
176 int status = -1;
178 if (chip->bus == SENSORS_CHIP_NAME_BUS_ISA) {
179 status = ssnprintf(buf, buf_size, "%s-isa-%04x", chip->prefix, chip->addr);
180 } else if (chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY) {
181 status = snprintf(buf, buf_size, "%s-%s-%04x", chip->prefix, chip->busname,
182 chip->addr);
183 } else {
184 status = snprintf(buf, buf_size, "%s-i2c-%d-%02x", chip->prefix, chip->bus,
185 chip->addr);
186 }
188 return (status);
189 } /* int sensors_snprintf_chip_name */
191 static int sensors_feature_name_to_type(const char *name) {
192 /* Yes, this is slow, but it's only ever done during initialization, so
193 * it's a one time cost.. */
194 for (int i = 0; i < known_features_num; i++)
195 if (strcasecmp(known_features[i].label, name) == 0)
196 return (known_features[i].type);
198 return (SENSOR_TYPE_UNKNOWN);
199 } /* int sensors_feature_name_to_type */
200 #endif
202 static int sensors_config(const char *key, const char *value) {
203 if (sensor_list == NULL)
204 sensor_list = ignorelist_create(1);
206 /* TODO: This setting exists for compatibility with old versions of
207 * lm-sensors. Remove support for those ancient versions in the next
208 * major release. */
209 if (strcasecmp(key, "SensorConfigFile") == 0) {
210 char *tmp = strdup(value);
211 if (tmp != NULL) {
212 sfree(conffile);
213 conffile = tmp;
214 }
215 } else if (strcasecmp(key, "Sensor") == 0) {
216 if (ignorelist_add(sensor_list, value)) {
217 ERROR("sensors plugin: "
218 "Cannot add value to ignorelist.");
219 return (1);
220 }
221 } else if (strcasecmp(key, "IgnoreSelected") == 0) {
222 ignorelist_set_invert(sensor_list, 1);
223 if (IS_TRUE(value))
224 ignorelist_set_invert(sensor_list, 0);
225 }
226 #if (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
227 else if (strcasecmp(key, "UseLabels") == 0) {
228 use_labels = IS_TRUE(value) ? 1 : 0;
229 }
230 #endif
231 else {
232 return (-1);
233 }
235 return (0);
236 }
238 static void sensors_free_features(void) {
239 featurelist_t *nextft;
241 if (first_feature == NULL)
242 return;
244 sensors_cleanup();
246 for (featurelist_t *thisft = first_feature; thisft != NULL; thisft = nextft) {
247 nextft = thisft->next;
248 sfree(thisft);
249 }
250 first_feature = NULL;
251 }
253 static int sensors_load_conf(void) {
254 static int call_once = 0;
256 FILE *fh = NULL;
257 featurelist_t *last_feature = NULL;
259 const sensors_chip_name *chip;
260 int chip_num;
262 int status;
264 if (call_once)
265 return 0;
267 call_once = 1;
269 if (conffile != NULL) {
270 fh = fopen(conffile, "r");
271 if (fh == NULL) {
272 char errbuf[1024];
273 ERROR("sensors plugin: fopen(%s) failed: %s", conffile,
274 sstrerror(errno, errbuf, sizeof(errbuf)));
275 return (-1);
276 }
277 }
279 status = sensors_init(fh);
280 if (fh)
281 fclose(fh);
283 if (status != 0) {
284 ERROR("sensors plugin: Cannot initialize sensors. "
285 "Data will not be collected.");
286 return (-1);
287 }
289 #if SENSORS_API_VERSION < 0x400
290 chip_num = 0;
291 while ((chip = sensors_get_detected_chips(&chip_num)) != NULL) {
292 int feature_num0 = 0;
293 int feature_num1 = 0;
295 while (42) {
296 const sensors_feature_data *feature;
297 int feature_type;
298 featurelist_t *fl;
300 feature = sensors_get_all_features(*chip, &feature_num0, &feature_num1);
302 /* Check if all features have been read. */
303 if (feature == NULL)
304 break;
306 /* "master features" only */
307 if (feature->mapping != SENSORS_NO_MAPPING) {
308 DEBUG("sensors plugin: sensors_load_conf: "
309 "Ignoring subfeature `%s', "
310 "because (feature->mapping "
311 "!= SENSORS_NO_MAPPING).",
312 feature->name);
313 continue;
314 }
316 /* skip ignored in sensors.conf */
317 if (sensors_get_ignored(*chip, feature->number) == 0) {
318 DEBUG("sensors plugin: sensors_load_conf: "
319 "Ignoring subfeature `%s', "
320 "because "
321 "`sensors_get_ignored' told "
322 "me so.",
323 feature->name);
324 continue;
325 }
327 feature_type = sensors_feature_name_to_type(feature->name);
328 if (feature_type == SENSOR_TYPE_UNKNOWN) {
329 DEBUG("sensors plugin: sensors_load_conf: "
330 "Ignoring subfeature `%s', "
331 "because its type is "
332 "unknown.",
333 feature->name);
334 continue;
335 }
337 fl = calloc(1, sizeof(*fl));
338 if (fl == NULL) {
339 ERROR("sensors plugin: calloc failed.");
340 continue;
341 }
343 fl->chip = chip;
344 fl->data = feature;
345 fl->type = feature_type;
347 if (first_feature == NULL)
348 first_feature = fl;
349 else
350 last_feature->next = fl;
351 last_feature = fl;
352 } /* while sensors_get_all_features */
353 } /* while sensors_get_detected_chips */
354 /* #endif SENSORS_API_VERSION < 0x400 */
356 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
357 chip_num = 0;
358 while ((chip = sensors_get_detected_chips(NULL, &chip_num)) != NULL) {
359 const sensors_feature *feature;
360 int feature_num = 0;
362 while ((feature = sensors_get_features(chip, &feature_num)) != NULL) {
363 const sensors_subfeature *subfeature;
364 int subfeature_num = 0;
366 /* Only handle voltage, fanspeeds and temperatures */
367 if ((feature->type != SENSORS_FEATURE_IN) &&
368 (feature->type != SENSORS_FEATURE_FAN) &&
369 (feature->type != SENSORS_FEATURE_TEMP) &&
370 (feature->type != SENSORS_FEATURE_POWER)) {
371 DEBUG("sensors plugin: sensors_load_conf: "
372 "Ignoring feature `%s', "
373 "because its type is not "
374 "supported.",
375 feature->name);
376 continue;
377 }
379 while ((subfeature = sensors_get_all_subfeatures(
380 chip, feature, &subfeature_num)) != NULL) {
381 featurelist_t *fl;
383 if ((subfeature->type != SENSORS_SUBFEATURE_IN_INPUT) &&
384 (subfeature->type != SENSORS_SUBFEATURE_FAN_INPUT) &&
385 (subfeature->type != SENSORS_SUBFEATURE_TEMP_INPUT) &&
386 (subfeature->type != SENSORS_SUBFEATURE_POWER_INPUT))
387 continue;
389 fl = calloc(1, sizeof(*fl));
390 if (fl == NULL) {
391 ERROR("sensors plugin: calloc failed.");
392 continue;
393 }
395 fl->chip = chip;
396 fl->feature = feature;
397 fl->subfeature = subfeature;
399 if (first_feature == NULL)
400 first_feature = fl;
401 else
402 last_feature->next = fl;
403 last_feature = fl;
404 } /* while (subfeature) */
405 } /* while (feature) */
406 } /* while (chip) */
407 #endif /* (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
409 if (first_feature == NULL) {
410 sensors_cleanup();
411 INFO("sensors plugin: lm_sensors reports no "
412 "features. Data will not be collected.");
413 return (-1);
414 }
416 return (0);
417 } /* int sensors_load_conf */
419 static int sensors_shutdown(void) {
420 sensors_free_features();
421 ignorelist_free(sensor_list);
423 return (0);
424 } /* int sensors_shutdown */
426 static void sensors_submit(const char *plugin_instance, const char *type,
427 const char *type_instance, double val) {
428 char match_key[1024];
429 int status;
431 value_t values[1];
432 value_list_t vl = VALUE_LIST_INIT;
434 status = ssnprintf(match_key, sizeof(match_key), "%s/%s-%s", plugin_instance,
435 type, type_instance);
436 if (status < 1)
437 return;
439 if (sensor_list != NULL) {
440 DEBUG("sensors plugin: Checking ignorelist for `%s'", match_key);
441 if (ignorelist_match(sensor_list, match_key))
442 return;
443 }
445 values[0].gauge = val;
447 vl.values = values;
448 vl.values_len = 1;
450 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
451 sstrncpy(vl.plugin, "sensors", sizeof(vl.plugin));
452 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
453 sstrncpy(vl.type, type, sizeof(vl.type));
454 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
456 plugin_dispatch_values(&vl);
457 } /* void sensors_submit */
459 static int sensors_read(void) {
460 if (sensors_load_conf() != 0)
461 return (-1);
463 #if SENSORS_API_VERSION < 0x400
464 for (featurelist_t *fl = first_feature; fl != NULL; fl = fl->next) {
465 double value;
466 int status;
467 char plugin_instance[DATA_MAX_NAME_LEN];
468 char type_instance[DATA_MAX_NAME_LEN];
470 status = sensors_get_feature(*fl->chip, fl->data->number, &value);
471 if (status < 0)
472 continue;
474 status = sensors_snprintf_chip_name(plugin_instance,
475 sizeof(plugin_instance), fl->chip);
476 if (status < 0)
477 continue;
479 sstrncpy(type_instance, fl->data->name, sizeof(type_instance));
481 sensors_submit(plugin_instance, sensor_type_name_map[fl->type],
482 type_instance, value);
483 } /* for fl = first_feature .. NULL */
484 /* #endif SENSORS_API_VERSION < 0x400 */
486 #elif (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500)
487 for (featurelist_t *fl = first_feature; fl != NULL; fl = fl->next) {
488 double value;
489 int status;
490 char plugin_instance[DATA_MAX_NAME_LEN];
491 char type_instance[DATA_MAX_NAME_LEN];
492 char *sensor_label;
493 const char *type;
495 status = sensors_get_value(fl->chip, fl->subfeature->number, &value);
496 if (status < 0)
497 continue;
499 status = sensors_snprintf_chip_name(plugin_instance,
500 sizeof(plugin_instance), fl->chip);
501 if (status < 0)
502 continue;
504 if (use_labels) {
505 sensor_label = sensors_get_label(fl->chip, fl->feature);
506 sstrncpy(type_instance, sensor_label, sizeof(type_instance));
507 free(sensor_label);
508 } else {
509 sstrncpy(type_instance, fl->feature->name, sizeof(type_instance));
510 }
512 if (fl->feature->type == SENSORS_FEATURE_IN)
513 type = "voltage";
514 else if (fl->feature->type == SENSORS_FEATURE_FAN)
515 type = "fanspeed";
516 else if (fl->feature->type == SENSORS_FEATURE_TEMP)
517 type = "temperature";
518 else if (fl->feature->type == SENSORS_FEATURE_POWER)
519 type = "power";
520 else
521 continue;
523 sensors_submit(plugin_instance, type, type_instance, value);
524 } /* for fl = first_feature .. NULL */
525 #endif /* (SENSORS_API_VERSION >= 0x400) && (SENSORS_API_VERSION < 0x500) */
527 return (0);
528 } /* int sensors_read */
530 void module_register(void) {
531 plugin_register_config("sensors", sensors_config, config_keys,
532 config_keys_num);
533 plugin_register_read("sensors", sensors_read);
534 plugin_register_shutdown("sensors", sensors_shutdown);
535 } /* void module_register */