9cf0858ffeeff3c65b754c42896b325cdb85eeaa
1 /**
2 * collectd - src/sensors.c
3 * Copyright (C) 2005,2006 Florian octo Forster
4 *
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.
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 verplant.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 **/
32 #include "collectd.h"
33 #include "common.h"
34 #include "plugin.h"
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>
44 #else
45 # undef HAVE_LIBSENSORS
46 #endif
48 #if defined(HAVE_LIBSENSORS)
49 # define SENSORS_HAVE_READ 1
50 #else
51 # define SENSORS_HAVE_READ 0
52 #endif
54 #define BUFSIZE 512
56 /* temperature and fan sensors */
57 static char *ds_def[] =
58 {
59 "DS:value:GAUGE:"COLLECTD_HEARTBEAT":U:U",
60 NULL
61 };
62 static int ds_num = 1;
64 /* voltage sensors */
65 static char *sensor_voltage_ds_def[] =
66 {
67 "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":U:U",
68 NULL
69 };
70 static int sensor_voltage_ds_num = 1;
72 /* old naming */
73 static char *old_filename_format = "sensors-%s.rrd";
74 /* end old naming */
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
84 #if SENSORS_HAVE_READ
85 static char *sensor_type_prefix[] =
86 {
87 "unknown",
88 "voltage",
89 "fanspeed",
90 "temperature",
91 NULL
92 };
93 #endif
95 typedef struct sensors_labeltypes {
96 char *label;
97 int type;
98 } sensors_labeltypes;
100 /*
101 * finite list of known labels extracted from lm_sensors
102 */
103 #if SENSORS_HAVE_READ
104 static sensors_labeltypes known_features[] =
105 {
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 },
158 { 0, -1 }
159 };
160 #endif
161 /* end new naming */
163 static char *config_keys[] =
164 {
165 "Sensor",
166 "IgnoreSelected",
167 "ExtendedSensorNaming",
168 NULL
169 };
170 static int config_keys_num = 3;
172 static ignorelist_t *sensor_list;
174 /*
175 * sensor_extended_naming:
176 * 0 => default is to create chip-feature
177 * 1 => use new naming scheme chip-bus-address/type-feature
178 */
179 static int sensor_extended_naming = 0;
181 #if SENSORS_HAVE_READ
182 typedef struct featurelist
183 {
184 const sensors_chip_name *chip;
185 const sensors_feature_data *data;
186 int type;
187 struct featurelist *next;
188 } featurelist_t;
190 featurelist_t *first_feature = NULL;
191 #endif /* if SENSORS_HAVE_READ */
193 static int sensors_config (char *key, char *value)
194 {
195 if (sensor_list == NULL)
196 sensor_list = ignorelist_create (1);
198 if (strcasecmp (key, "Sensor") == 0)
199 {
200 if (ignorelist_add (sensor_list, value))
201 {
202 syslog (LOG_EMERG, "Cannot add value to ignorelist.");
203 return (1);
204 }
205 }
206 else if (strcasecmp (key, "IgnoreSelected") == 0)
207 {
208 ignorelist_set_invert (sensor_list, 1);
209 if ((strcasecmp (value, "True") == 0)
210 || (strcasecmp (value, "Yes") == 0)
211 || (strcasecmp (value, "On") == 0))
212 ignorelist_set_invert (sensor_list, 0);
213 }
214 else if (strcasecmp (key, "ExtendedSensorNaming") == 0)
215 {
216 if ((strcasecmp (value, "True") == 0)
217 || (strcasecmp (value, "Yes") == 0)
218 || (strcasecmp (value, "On") == 0))
219 sensor_extended_naming = 1;
220 else
221 sensor_extended_naming = 0;
222 }
223 else
224 {
225 return (-1);
226 }
228 return (0);
229 }
231 static void collectd_sensors_init (void)
232 {
233 #if SENSORS_HAVE_READ
234 FILE *fh;
235 featurelist_t *last_feature = NULL;
236 featurelist_t *new_feature;
238 const sensors_chip_name *chip;
239 int chip_num;
241 const sensors_feature_data *data;
242 int data_num0, data_num1;
244 new_feature = first_feature;
245 while (new_feature != NULL)
246 {
247 last_feature = new_feature->next;
248 free (new_feature);
249 new_feature = last_feature;
250 }
252 #ifdef assert
253 assert (new_feature == NULL);
254 assert (last_feature == NULL);
255 #endif
257 if ((fh = fopen ("/etc/sensors.conf", "r")) == NULL)
258 return;
260 if (sensors_init (fh))
261 {
262 fclose (fh);
263 syslog (LOG_ERR, "sensors: Cannot initialize sensors. "
264 "Data will not be collected.");
265 return;
266 }
268 fclose (fh);
270 chip_num = 0;
271 while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
272 {
273 data = NULL;
274 data_num0 = data_num1 = 0;
276 while ((data = sensors_get_all_features (*chip, &data_num0, &data_num1))
277 != NULL)
278 {
279 int i;
281 /* "master features" only */
282 if (data->mapping != SENSORS_NO_MAPPING)
283 continue;
285 /* Only known features */
286 for (i = 0; known_features[i].type >= 0; i++)
287 {
288 if (strcmp (data->name, known_features[i].label) != 0)
289 continue;
291 /* skip ignored in sensors.conf */
292 if (sensors_get_ignored (*chip, data->number) == 0)
293 break;
295 DBG ("Adding feature: %s-%s-%s",
296 chip->prefix,
297 sensor_type_prefix[known_features[i].type],
298 data->name);
300 if ((new_feature = (featurelist_t *) malloc (sizeof (featurelist_t))) == NULL)
301 {
302 DBG ("sensors plugin: malloc: %s",
303 strerror (errno));
304 syslog (LOG_ERR, "sensors plugin: malloc: %s",
305 strerror (errno));
306 break;
307 }
309 new_feature->chip = chip;
310 new_feature->data = data;
311 new_feature->type = known_features[i].type;
312 new_feature->next = NULL;
314 if (first_feature == NULL)
315 {
316 first_feature = new_feature;
317 last_feature = new_feature;
318 }
319 else
320 {
321 last_feature->next = new_feature;
322 last_feature = new_feature;
323 }
325 /* stop searching known features at first found */
326 break;
327 } /* for i */
328 } /* while sensors_get_all_features */
329 } /* while sensors_get_detected_chips */
331 if (first_feature == NULL)
332 sensors_cleanup ();
333 #endif /* if SENSORS_HAVE_READ */
335 return;
336 }
338 static void sensors_shutdown (void)
339 {
340 featurelist_t *thisft = first_feature;
341 featurelist_t *nextft;
343 ignorelist_free (sensor_list);
345 while (thisft != NULL)
346 {
347 nextft = thisft->next;
348 sfree (thisft);
349 thisft = nextft;
350 }
352 sensors_cleanup ();
353 }
355 static void sensors_voltage_write (char *host, char *inst, char *val)
356 {
357 char file[BUFSIZE];
358 int status;
360 /* skip ignored in our config */
361 if (ignorelist_match (sensor_list, inst))
362 return;
364 /* extended sensor naming */
365 if(sensor_extended_naming)
366 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
367 else
368 status = snprintf (file, BUFSIZE, old_filename_format, inst);
370 if ((status < 1) || (status >= BUFSIZE))
371 return;
373 rrd_update_file (host, file, val, sensor_voltage_ds_def, sensor_voltage_ds_num);
374 }
376 static void sensors_write (char *host, char *inst, char *val)
377 {
378 char file[BUFSIZE];
379 int status;
381 /* skip ignored in our config */
382 if (ignorelist_match (sensor_list, inst))
383 return;
385 /* extended sensor naming */
386 if (sensor_extended_naming)
387 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
388 else
389 status = snprintf (file, BUFSIZE, old_filename_format, inst);
391 if ((status < 1) || (status >= BUFSIZE))
392 return;
394 rrd_update_file (host, file, val, ds_def, ds_num);
395 }
397 #if SENSORS_HAVE_READ
398 static void sensors_submit (const char *feat_name,
399 const char *chip_prefix, double value, int type)
400 {
401 char buf[BUFSIZE];
402 char inst[BUFSIZE];
404 if (snprintf (inst, BUFSIZE, "%s-%s", chip_prefix, feat_name)
405 >= BUFSIZE)
406 return;
408 /* skip ignored in our config */
409 if (ignorelist_match (sensor_list, inst))
410 return;
412 if (snprintf (buf, BUFSIZE, "%u:%.3f", (unsigned int) curtime,
413 value) >= BUFSIZE)
414 return;
416 if (type == SENSOR_TYPE_VOLTAGE)
417 {
418 DBG ("%s: %s/%s, %s", MODULE_NAME_VOLTAGE,
419 sensor_type_prefix[type], inst, buf);
420 plugin_submit (MODULE_NAME_VOLTAGE, inst, buf);
421 }
422 else
423 {
424 DBG ("%s: %s/%s, %s", MODULE_NAME,
425 sensor_type_prefix[type], inst, buf);
426 plugin_submit (MODULE_NAME, inst, buf);
427 }
428 }
430 static void sensors_read (void)
431 {
432 featurelist_t *feature;
433 double value;
434 char chip_fullprefix[BUFSIZE];
436 for (feature = first_feature; feature != NULL; feature = feature->next)
437 {
438 if (sensors_get_feature (*feature->chip, feature->data->number, &value) < 0)
439 continue;
441 if (sensor_extended_naming)
442 {
443 /* full chip name logic borrowed from lm_sensors */
444 if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
445 {
446 if (snprintf (chip_fullprefix, BUFSIZE, "%s-isa-%04x/%s",
447 feature->chip->prefix,
448 feature->chip->addr,
449 sensor_type_prefix[feature->type])
450 >= BUFSIZE)
451 continue;
452 }
453 else if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
454 {
455 if (snprintf (chip_fullprefix, BUFSIZE, "%s-%s-%04x/%s",
456 feature->chip->prefix,
457 feature->chip->busname,
458 feature->chip->addr,
459 sensor_type_prefix[feature->type])
460 >= BUFSIZE)
461 continue;
462 }
463 else
464 {
465 if (snprintf (chip_fullprefix, BUFSIZE, "%s-i2c-%d-%02x/%s",
466 feature->chip->prefix,
467 feature->chip->bus,
468 feature->chip->addr,
469 sensor_type_prefix[feature->type])
470 >= BUFSIZE)
471 continue;
472 }
474 sensors_submit (feature->data->name,
475 chip_fullprefix,
476 value, feature->type);
477 }
478 else
479 {
480 sensors_submit (feature->data->name,
481 feature->chip->prefix,
482 value, feature->type);
483 }
484 }
485 }
486 #else
487 # define sensors_read NULL
488 #endif /* SENSORS_HAVE_READ */
490 void module_register (void)
491 {
492 plugin_register (MODULE_NAME, collectd_sensors_init, sensors_read, sensors_write);
493 plugin_register (MODULE_NAME_VOLTAGE, NULL, NULL, sensors_voltage_write);
494 plugin_register_shutdown (MODULE_NAME, sensors_shutdown);
495 cf_register (MODULE_NAME, sensors_config, config_keys, config_keys_num);
496 }
498 #undef BUFSIZE
499 #undef MODULE_NAME