2 * collectd - src/sensors.c
3 * Copyright (C) 2005,2006 Florian octo Forster
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.
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"
37 #include "utils_debug.h"
39 #define MODULE_NAME "sensors"
40 #define MODULE_NAME_VOLTAGE MODULE_NAME"_voltage"
42 #if defined(HAVE_SENSORS_SENSORS_H)
43 # include <sensors/sensors.h>
45 # undef HAVE_LIBSENSORS
48 #if defined(HAVE_LIBSENSORS)
49 # define SENSORS_HAVE_READ 1
51 # define SENSORS_HAVE_READ 0
56 /* temperature and fan sensors */
57 static char *ds_def[] =
59 "DS:value:GAUGE:"COLLECTD_HEARTBEAT":U:U",
62 static int ds_num = 1;
65 static char *sensor_voltage_ds_def[] =
67 "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":U:U",
70 static int sensor_voltage_ds_num = 1;
73 static char *old_filename_format = "sensors-%s.rrd";
76 /* new naming <chip-bus-address/type-feature */
77 static char *extended_filename_format = "lm_sensors-%s.rrd";
79 #define SENSOR_TYPE_UNKNOWN 0
80 #define SENSOR_TYPE_VOLTAGE 1
81 #define SENSOR_TYPE_FANSPEED 2
82 #define SENSOR_TYPE_TEMPERATURE 3
85 static char *sensor_type_prefix[] =
95 typedef struct sensors_labeltypes {
101 * finite list of known labels extracted from lm_sensors
103 #if SENSORS_HAVE_READ
104 static sensors_labeltypes known_features[] =
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 },
163 static char *config_keys[] =
167 "ExtendedSensorNaming",
170 static int config_keys_num = 3;
172 static ignorelist_t *sensor_list;
175 * sensor_extended_naming:
176 * 0 => default is to create chip-feature
177 * 1 => use new naming scheme chip-bus-address/type-feature
179 static int sensor_extended_naming = 0;
181 #if SENSORS_HAVE_READ
182 #ifndef SENSORS_CONF_PATH
183 # define SENSORS_CONF_PATH "/etc/sensors.conf"
185 static const char *conffile = SENSORS_CONF_PATH;
186 /* SENSORS_CONF_PATH */
189 * remember stat of the loaded config
191 static struct stat sensors_conf_stat;
192 static int sensors_conf_loaded = 0;
194 typedef struct featurelist
196 const sensors_chip_name *chip;
197 const sensors_feature_data *data;
199 struct featurelist *next;
202 featurelist_t *first_feature = NULL;
203 #endif /* if SENSORS_HAVE_READ */
205 static int sensors_config (char *key, char *value)
207 if (sensor_list == NULL)
208 sensor_list = ignorelist_create (1);
210 if (strcasecmp (key, "Sensor") == 0)
212 if (ignorelist_add (sensor_list, value))
214 syslog (LOG_EMERG, MODULE_NAME": Cannot add value to ignorelist.");
218 else if (strcasecmp (key, "IgnoreSelected") == 0)
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);
226 else if (strcasecmp (key, "ExtendedSensorNaming") == 0)
228 if ((strcasecmp (value, "True") == 0)
229 || (strcasecmp (value, "Yes") == 0)
230 || (strcasecmp (value, "On") == 0))
231 sensor_extended_naming = 1;
233 sensor_extended_naming = 0;
243 #if SENSORS_HAVE_READ
244 void sensors_free_features (void)
246 featurelist_t *thisft;
247 featurelist_t *nextft;
249 if (sensors_conf_loaded)
252 sensors_conf_loaded = 0;
255 for (thisft = first_feature; thisft != NULL; thisft = nextft)
257 nextft = thisft->next;
260 first_feature = NULL;
263 static void sensors_load_conf (int firsttime)
266 featurelist_t *last_feature = NULL;
267 featurelist_t *new_feature;
269 const sensors_chip_name *chip;
272 const sensors_feature_data *data;
273 int data_num0, data_num1;
275 sensors_free_features ();
276 new_feature = first_feature;
279 assert (new_feature == NULL);
280 assert (last_feature == NULL);
283 if ((fh = fopen (conffile, "r")) == NULL)
285 syslog (LOG_ERR, MODULE_NAME": cannot open %s: %s. "
286 "Data will not be collected.", conffile, strerror(errno));
290 if (sensors_init (fh))
293 syslog (LOG_ERR, MODULE_NAME": Cannot initialize sensors. "
294 "Data will not be collected.");
298 /* remember file status to detect changes */
299 if (fstat (fileno (fh), &sensors_conf_stat) == -1)
302 syslog (LOG_ERR, MODULE_NAME": cannot fstat %s: %s "
303 "Data will not be collected.", conffile, strerror(errno));
310 while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
313 data_num0 = data_num1 = 0;
315 while ((data = sensors_get_all_features (*chip, &data_num0, &data_num1))
320 /* "master features" only */
321 if (data->mapping != SENSORS_NO_MAPPING)
324 /* Only known features */
325 for (i = 0; known_features[i].type >= 0; i++)
327 if (strcmp (data->name, known_features[i].label) != 0)
330 /* skip ignored in sensors.conf */
331 if (sensors_get_ignored (*chip, data->number) == 0)
334 DBG ("Adding feature: %s-%s-%s",
336 sensor_type_prefix[known_features[i].type],
339 if ((new_feature = (featurelist_t *) malloc (sizeof (featurelist_t))) == NULL)
341 DBG ("malloc: %s", strerror (errno));
342 syslog (LOG_ERR, MODULE_NAME": malloc: %s",
347 new_feature->chip = chip;
348 new_feature->data = data;
349 new_feature->type = known_features[i].type;
350 new_feature->next = NULL;
352 if (first_feature == NULL)
354 first_feature = new_feature;
355 last_feature = new_feature;
359 last_feature->next = new_feature;
360 last_feature = new_feature;
363 /* stop searching known features at first found */
366 } /* while sensors_get_all_features */
367 } /* while sensors_get_detected_chips */
370 syslog (LOG_INFO, MODULE_NAME": lm_sensors' configuration reloaded.");
372 if (first_feature == NULL)
375 sensors_conf_loaded = 0;
376 syslog (LOG_INFO, MODULE_NAME": lm_sensors reports no features. "
377 "Data will not be collected.");
380 sensors_conf_loaded = 1;
382 #endif /* if SENSORS_HAVE_READ */
384 static void collectd_sensors_init (void)
386 #if SENSORS_HAVE_READ
387 sensors_load_conf (1);
388 #endif /* if SENSORS_HAVE_READ */
391 static void sensors_shutdown (void)
393 #if SENSORS_HAVE_READ
394 sensors_free_features ();
395 #endif /* if SENSORS_HAVE_READ */
397 ignorelist_free (sensor_list);
400 static void sensors_voltage_write (char *host, char *inst, char *val)
405 /* skip ignored in our config */
406 if (ignorelist_match (sensor_list, inst))
409 /* extended sensor naming */
410 if(sensor_extended_naming)
411 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
413 status = snprintf (file, BUFSIZE, old_filename_format, inst);
415 if ((status < 1) || (status >= BUFSIZE))
418 rrd_update_file (host, file, val, sensor_voltage_ds_def, sensor_voltage_ds_num);
421 static void sensors_write (char *host, char *inst, char *val)
426 /* skip ignored in our config */
427 if (ignorelist_match (sensor_list, inst))
430 /* extended sensor naming */
431 if (sensor_extended_naming)
432 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
434 status = snprintf (file, BUFSIZE, old_filename_format, inst);
436 if ((status < 1) || (status >= BUFSIZE))
439 rrd_update_file (host, file, val, ds_def, ds_num);
442 #if SENSORS_HAVE_READ
443 static void sensors_submit (const char *feat_name,
444 const char *chip_prefix, double value, int type)
449 if (snprintf (inst, BUFSIZE, "%s-%s", chip_prefix, feat_name)
453 /* skip ignored in our config */
454 if (ignorelist_match (sensor_list, inst))
457 if (snprintf (buf, BUFSIZE, "%u:%.3f", (unsigned int) curtime,
461 if (type == SENSOR_TYPE_VOLTAGE)
463 DBG ("%s: %s/%s, %s", MODULE_NAME_VOLTAGE,
464 sensor_type_prefix[type], inst, buf);
465 plugin_submit (MODULE_NAME_VOLTAGE, inst, buf);
469 DBG ("%s: %s/%s, %s", MODULE_NAME,
470 sensor_type_prefix[type], inst, buf);
471 plugin_submit (MODULE_NAME, inst, buf);
475 static void sensors_read (void)
477 featurelist_t *feature;
479 char chip_fullprefix[BUFSIZE];
480 struct stat changedbuf;
482 /* check sensors.conf for changes */
483 if (sensors_conf_loaded)
485 if (stat (conffile, &changedbuf) == -1)
487 syslog (LOG_ERR, MODULE_NAME": cannot stat %s: %s",
488 conffile, strerror(errno));
490 * sensors.conf does not exist,
491 * throw away previous conf
493 sensors_load_conf (0);
497 if ((changedbuf.st_size != sensors_conf_stat.st_size) ||
498 (changedbuf.st_mtime != sensors_conf_stat.st_mtime) ||
499 (changedbuf.st_ino != sensors_conf_stat.st_ino))
501 sensors_load_conf (0);
506 for (feature = first_feature; feature != NULL; feature = feature->next)
508 if (sensors_get_feature (*feature->chip, feature->data->number, &value) < 0)
511 if (sensor_extended_naming)
513 /* full chip name logic borrowed from lm_sensors */
514 if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
516 if (snprintf (chip_fullprefix, BUFSIZE, "%s-isa-%04x/%s",
517 feature->chip->prefix,
519 sensor_type_prefix[feature->type])
523 else if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
525 if (snprintf (chip_fullprefix, BUFSIZE, "%s-%s-%04x/%s",
526 feature->chip->prefix,
527 feature->chip->busname,
529 sensor_type_prefix[feature->type])
535 if (snprintf (chip_fullprefix, BUFSIZE, "%s-i2c-%d-%02x/%s",
536 feature->chip->prefix,
539 sensor_type_prefix[feature->type])
544 sensors_submit (feature->data->name,
546 value, feature->type);
550 sensors_submit (feature->data->name,
551 feature->chip->prefix,
552 value, feature->type);
557 # define sensors_read NULL
558 #endif /* SENSORS_HAVE_READ */
560 void module_register (void)
562 plugin_register (MODULE_NAME, collectd_sensors_init, sensors_read, sensors_write);
563 plugin_register (MODULE_NAME_VOLTAGE, NULL, NULL, sensors_voltage_write);
564 plugin_register_shutdown (MODULE_NAME, sensors_shutdown);
565 cf_register (MODULE_NAME, sensors_config, config_keys, config_keys_num);