290ddd289541211e06539a5f4b77b716b151c564
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 static char *sensor_type_prefix[] =
85 {
86 "unknown",
87 "voltage",
88 "fanspeed",
89 "temperature",
90 NULL
91 };
93 typedef struct sensors_labeltypes {
94 char *label;
95 int type;
96 } sensors_labeltypes;
98 /*
99 * finite list of known labels extracted from lm_sensors
100 */
101 static sensors_labeltypes known_features[] =
102 {
103 { "fan1", SENSOR_TYPE_FANSPEED },
104 { "fan2", SENSOR_TYPE_FANSPEED },
105 { "fan3", SENSOR_TYPE_FANSPEED },
106 { "fan4", SENSOR_TYPE_FANSPEED },
107 { "fan5", SENSOR_TYPE_FANSPEED },
108 { "fan6", SENSOR_TYPE_FANSPEED },
109 { "fan7", SENSOR_TYPE_FANSPEED },
110 { "AIN2", SENSOR_TYPE_VOLTAGE },
111 { "AIN1", SENSOR_TYPE_VOLTAGE },
112 { "in10", SENSOR_TYPE_VOLTAGE },
113 { "in9", SENSOR_TYPE_VOLTAGE },
114 { "in8", SENSOR_TYPE_VOLTAGE },
115 { "in7", SENSOR_TYPE_VOLTAGE },
116 { "in6", SENSOR_TYPE_VOLTAGE },
117 { "in5", SENSOR_TYPE_VOLTAGE },
118 { "in4", SENSOR_TYPE_VOLTAGE },
119 { "in3", SENSOR_TYPE_VOLTAGE },
120 { "in2", SENSOR_TYPE_VOLTAGE },
121 { "in0", SENSOR_TYPE_VOLTAGE },
122 { "CPU_Temp", SENSOR_TYPE_TEMPERATURE },
123 { "remote_temp", SENSOR_TYPE_TEMPERATURE },
124 { "temp1", SENSOR_TYPE_TEMPERATURE },
125 { "temp2", SENSOR_TYPE_TEMPERATURE },
126 { "temp3", SENSOR_TYPE_TEMPERATURE },
127 { "temp4", SENSOR_TYPE_TEMPERATURE },
128 { "temp5", SENSOR_TYPE_TEMPERATURE },
129 { "temp6", SENSOR_TYPE_TEMPERATURE },
130 { "temp7", SENSOR_TYPE_TEMPERATURE },
131 { "temp", SENSOR_TYPE_TEMPERATURE },
132 { "Vccp2", SENSOR_TYPE_VOLTAGE },
133 { "Vccp1", SENSOR_TYPE_VOLTAGE },
134 { "vdd", SENSOR_TYPE_VOLTAGE },
135 { "vid5", SENSOR_TYPE_VOLTAGE },
136 { "vid4", SENSOR_TYPE_VOLTAGE },
137 { "vid3", SENSOR_TYPE_VOLTAGE },
138 { "vid2", SENSOR_TYPE_VOLTAGE },
139 { "vid1", SENSOR_TYPE_VOLTAGE },
140 { "vid", SENSOR_TYPE_VOLTAGE },
141 { "vin4", SENSOR_TYPE_VOLTAGE },
142 { "vin3", SENSOR_TYPE_VOLTAGE },
143 { "vin2", SENSOR_TYPE_VOLTAGE },
144 { "vin1", SENSOR_TYPE_VOLTAGE },
145 { "voltbatt", SENSOR_TYPE_VOLTAGE },
146 { "volt12", SENSOR_TYPE_VOLTAGE },
147 { "volt5", SENSOR_TYPE_VOLTAGE },
148 { "vrm", SENSOR_TYPE_VOLTAGE },
149 { "5.0V", SENSOR_TYPE_VOLTAGE },
150 { "5V", SENSOR_TYPE_VOLTAGE },
151 { "3.3V", SENSOR_TYPE_VOLTAGE },
152 { "2.5V", SENSOR_TYPE_VOLTAGE },
153 { "2.0V", SENSOR_TYPE_VOLTAGE },
154 { "12V", SENSOR_TYPE_VOLTAGE },
155 { 0, -1 }
156 };
157 /* end new naming */
159 static char *config_keys[] =
160 {
161 "Sensor",
162 "IgnoreSelected",
163 "ExtendedSensorNaming",
164 NULL
165 };
166 static int config_keys_num = 3;
168 static ignorelist_t *sensor_list;
170 /*
171 * sensor_extended_naming:
172 * 0 => default is to create chip-feature
173 * 1 => use new naming scheme chip-bus-address/type-feature
174 */
175 static int sensor_extended_naming = 0;
177 #ifdef HAVE_LIBSENSORS
178 typedef struct featurelist
179 {
180 const sensors_chip_name *chip;
181 const sensors_feature_data *data;
182 int type;
183 struct featurelist *next;
184 } featurelist_t;
186 featurelist_t *first_feature = NULL;
187 #endif /* defined (HAVE_LIBSENSORS) */
189 static int sensors_config (char *key, char *value)
190 {
191 if (sensor_list == NULL)
192 sensor_list = ignorelist_create (1);
194 if (strcasecmp (key, "Sensor") == 0)
195 {
196 if (ignorelist_add (sensor_list, value))
197 {
198 syslog (LOG_EMERG, "Cannot add value to ignorelist.");
199 return (1);
200 }
201 }
202 else if (strcasecmp (key, "IgnoreSelected") == 0)
203 {
204 ignorelist_set_invert (sensor_list, 1);
205 if ((strcasecmp (value, "True") == 0)
206 || (strcasecmp (value, "Yes") == 0)
207 || (strcasecmp (value, "On") == 0))
208 ignorelist_set_invert (sensor_list, 0);
209 }
210 else if (strcasecmp (key, "ExtendedSensorNaming") == 0)
211 {
212 if ((strcasecmp (value, "True") == 0)
213 || (strcasecmp (value, "Yes") == 0)
214 || (strcasecmp (value, "On") == 0))
215 sensor_extended_naming = 1;
216 else
217 sensor_extended_naming = 0;
218 }
219 else
220 {
221 return (-1);
222 }
224 return (0);
225 }
227 static void collectd_sensors_init (void)
228 {
229 #ifdef HAVE_LIBSENSORS
230 FILE *fh;
231 featurelist_t *last_feature = NULL;
232 featurelist_t *new_feature;
234 const sensors_chip_name *chip;
235 int chip_num;
237 const sensors_feature_data *data;
238 int data_num0, data_num1;
240 new_feature = first_feature;
241 while (new_feature != NULL)
242 {
243 last_feature = new_feature->next;
244 free (new_feature);
245 new_feature = last_feature;
246 }
248 #ifdef assert
249 assert (new_feature == NULL);
250 assert (last_feature == NULL);
251 #endif
253 if ((fh = fopen ("/etc/sensors.conf", "r")) == NULL)
254 return;
256 if (sensors_init (fh))
257 {
258 fclose (fh);
259 syslog (LOG_ERR, "sensors: Cannot initialize sensors. "
260 "Data will not be collected.");
261 return;
262 }
264 fclose (fh);
266 chip_num = 0;
267 while ((chip = sensors_get_detected_chips (&chip_num)) != NULL)
268 {
269 data = NULL;
270 data_num0 = data_num1 = 0;
272 while ((data = sensors_get_all_features (*chip, &data_num0, &data_num1))
273 != NULL)
274 {
275 int i;
277 /* "master features" only */
278 if (data->mapping != SENSORS_NO_MAPPING)
279 continue;
281 /* Only known features */
282 for (i = 0; known_features[i].type >= 0; i++)
283 {
284 if (strcmp (data->name, known_features[i].label) != 0)
285 continue;
287 /* skip ignored in sensors.conf */
288 if (sensors_get_ignored (*chip, data->number) == 0)
289 break;
291 DBG ("Adding feature: %s-%s-%s",
292 chip->prefix,
293 sensor_type_prefix[known_features[i].type],
294 data->name);
296 if ((new_feature = (featurelist_t *) malloc (sizeof (featurelist_t))) == NULL)
297 {
298 DBG ("sensors plugin: malloc: %s",
299 strerror (errno));
300 syslog (LOG_ERR, "sensors plugin: malloc: %s",
301 strerror (errno));
302 break;
303 }
305 new_feature->chip = chip;
306 new_feature->data = data;
307 new_feature->type = known_features[i].type;
308 new_feature->next = NULL;
310 if (first_feature == NULL)
311 {
312 first_feature = new_feature;
313 last_feature = new_feature;
314 }
315 else
316 {
317 last_feature->next = new_feature;
318 last_feature = new_feature;
319 }
321 /* stop searching known features at first found */
322 break;
323 } /* for i */
324 } /* while sensors_get_all_features */
325 } /* while sensors_get_detected_chips */
327 if (first_feature == NULL)
328 sensors_cleanup ();
329 #endif /* defined(HAVE_LIBSENSORS) */
331 return;
332 }
334 static void sensors_voltage_write (char *host, char *inst, char *val)
335 {
336 char file[BUFSIZE];
337 int status;
339 /* skip ignored in our config */
340 if (ignorelist_match (sensor_list, inst))
341 return;
343 /* extended sensor naming */
344 if(sensor_extended_naming)
345 status = snprintf (file, BUFSIZE, extended_filename_format, inst);
346 else
347 status = snprintf (file, BUFSIZE, old_filename_format, inst);
349 if ((status < 1) || (status >= BUFSIZE))
350 return;
352 rrd_update_file (host, file, val, sensor_voltage_ds_def, sensor_voltage_ds_num);
353 }
355 static void sensors_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, ds_def, ds_num);
374 }
376 #if SENSORS_HAVE_READ
377 static void sensors_submit (const char *feat_name,
378 const char *chip_prefix, double value, int type)
379 {
380 char buf[BUFSIZE];
381 char inst[BUFSIZE];
383 if (snprintf (inst, BUFSIZE, "%s-%s", chip_prefix, feat_name)
384 >= BUFSIZE)
385 return;
387 /* skip ignored in our config */
388 if (ignorelist_match (sensor_list, inst))
389 return;
391 if (snprintf (buf, BUFSIZE, "%u:%.3f", (unsigned int) curtime,
392 value) >= BUFSIZE)
393 return;
395 if (type == SENSOR_TYPE_VOLTAGE)
396 {
397 DBG ("%s: %s/%s, %s", MODULE_NAME_VOLTAGE,
398 sensor_type_prefix[type], inst, buf);
399 plugin_submit (MODULE_NAME_VOLTAGE, inst, buf);
400 }
401 else
402 {
403 DBG ("%s: %s/%s, %s", MODULE_NAME,
404 sensor_type_prefix[type], inst, buf);
405 plugin_submit (MODULE_NAME, inst, buf);
406 }
407 }
409 static void sensors_read (void)
410 {
411 featurelist_t *feature;
412 double value;
413 char chip_fullprefix[BUFSIZE];
415 for (feature = first_feature; feature != NULL; feature = feature->next)
416 {
417 if (sensors_get_feature (*feature->chip, feature->data->number, &value) < 0)
418 continue;
420 if (sensor_extended_naming)
421 {
422 /* full chip name logic borrowed from lm_sensors */
423 if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_ISA)
424 {
425 if (snprintf (chip_fullprefix, BUFSIZE, "%s-isa-%04x/%s",
426 feature->chip->prefix,
427 feature->chip->addr,
428 sensor_type_prefix[feature->type])
429 >= BUFSIZE)
430 continue;
431 }
432 else if (feature->chip->bus == SENSORS_CHIP_NAME_BUS_DUMMY)
433 {
434 if (snprintf (chip_fullprefix, BUFSIZE, "%s-%s-%04x/%s",
435 feature->chip->prefix,
436 feature->chip->busname,
437 feature->chip->addr,
438 sensor_type_prefix[feature->type])
439 >= BUFSIZE)
440 continue;
441 }
442 else
443 {
444 if (snprintf (chip_fullprefix, BUFSIZE, "%s-i2c-%d-%02x/%s",
445 feature->chip->prefix,
446 feature->chip->bus,
447 feature->chip->addr,
448 sensor_type_prefix[feature->type])
449 >= BUFSIZE)
450 continue;
451 }
453 sensors_submit (feature->data->name,
454 chip_fullprefix,
455 value, feature->type);
456 }
457 else
458 {
459 sensors_submit (feature->data->name,
460 feature->chip->prefix,
461 value, feature->type);
462 }
463 }
464 }
465 #else
466 # define sensors_read NULL
467 #endif /* SENSORS_HAVE_READ */
469 void module_register (void)
470 {
471 plugin_register (MODULE_NAME, collectd_sensors_init, sensors_read, sensors_write);
472 plugin_register (MODULE_NAME_VOLTAGE, NULL, NULL, sensors_voltage_write);
473 cf_register (MODULE_NAME, sensors_config, config_keys, config_keys_num);
474 }
476 #undef BUFSIZE
477 #undef MODULE_NAME