1 /**
2 * collectd - src/ipmi.c
3 * Copyright (C) 2008 Florian octo Forster
4 * Copyright (C) 2008 Peter Holik
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 verplant.org>
21 * Peter Holik <peter at holik.at>
22 **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
27 #include "utils_ignorelist.h"
29 #include <pthread.h>
31 #include <OpenIPMI/ipmiif.h>
32 #include <OpenIPMI/ipmi_err.h>
33 #include <OpenIPMI/ipmi_posix.h>
34 #include <OpenIPMI/ipmi_conn.h>
35 #include <OpenIPMI/ipmi_smi.h>
37 /*
38 * Private data types
39 */
40 struct c_ipmi_sensor_list_s;
41 typedef struct c_ipmi_sensor_list_s c_ipmi_sensor_list_t;
43 struct c_ipmi_sensor_list_s
44 {
45 ipmi_sensor_id_t sensor_id;
46 char sensor_name[DATA_MAX_NAME_LEN];
47 char sensor_type[DATA_MAX_NAME_LEN];
48 int sensor_not_present;
49 c_ipmi_sensor_list_t *next;
50 };
52 /*
53 * Module global variables
54 */
55 static pthread_mutex_t sensor_list_lock = PTHREAD_MUTEX_INITIALIZER;
56 static c_ipmi_sensor_list_t *sensor_list = NULL;
58 static int c_ipmi_init_in_progress = 0;
59 static int c_ipmi_active = 0;
60 static pthread_t thread_id = (pthread_t) 0;
62 static const char *config_keys[] =
63 {
64 "Sensor",
65 "IgnoreSelected",
66 "NotifySensorAdd",
67 "NotifySensorRemove",
68 "NotifySensorNotPresent"
69 };
70 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
72 static ignorelist_t *ignorelist = NULL;
74 static int c_ipmi_nofiy_add = 0;
75 static int c_ipmi_nofiy_remove = 0;
76 static int c_ipmi_nofiy_notpresent = 0;
78 /*
79 * Misc private functions
80 */
81 static void c_ipmi_error (const char *func, int status)
82 {
83 char errbuf[4096];
85 memset (errbuf, 0, sizeof (errbuf));
87 if (IPMI_IS_OS_ERR (status))
88 {
89 sstrerror (IPMI_GET_OS_ERR (status), errbuf, sizeof (errbuf));
90 }
91 else if (IPMI_IS_IPMI_ERR (status))
92 {
93 ipmi_get_error_string (IPMI_GET_IPMI_ERR (status), errbuf, sizeof (errbuf));
94 }
96 if (errbuf[0] == 0)
97 {
98 ssnprintf (errbuf, sizeof (errbuf), "Unknown error %#x", status);
99 }
100 errbuf[sizeof (errbuf) - 1] = 0;
102 ERROR ("ipmi plugin: %s failed: %s", func, errbuf);
103 } /* void c_ipmi_error */
105 /*
106 * Sensor handlers
107 */
108 /* Prototype for sensor_list_remove, so sensor_read_handler can call it. */
109 static int sensor_list_remove (ipmi_sensor_t *sensor);
111 static void sensor_read_handler (ipmi_sensor_t *sensor,
112 int err,
113 enum ipmi_value_present_e value_present,
114 unsigned int raw_value,
115 double value,
116 ipmi_states_t *states,
117 void *user_data)
118 {
119 value_t values[1];
120 value_list_t vl = VALUE_LIST_INIT;
122 c_ipmi_sensor_list_t *list_item = (c_ipmi_sensor_list_t *)user_data;
124 if (err != 0)
125 {
126 if ((err & 0xff) == IPMI_NOT_PRESENT_CC)
127 {
128 if (list_item->sensor_not_present == 0)
129 {
130 list_item->sensor_not_present = 1;
132 INFO ("ipmi plugin: sensor_read_handler: sensor %s "
133 "not present.", list_item->sensor_name);
135 if (c_ipmi_nofiy_notpresent)
136 {
137 notification_t n = { NOTIF_WARNING, time(NULL), "", "", "ipmi",
138 "", "", "", NULL };
140 sstrncpy (n.host, hostname_g, sizeof (n.host));
141 sstrncpy (n.type_instance, list_item->sensor_name,
142 sizeof (n.type_instance));
143 sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
144 ssnprintf (n.message, sizeof (n.message),
145 "sensor %s not present", list_item->sensor_name);
147 plugin_dispatch_notification (&n);
148 }
149 }
150 }
151 else
152 {
153 INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
154 "because it failed with status %#x.",
155 list_item->sensor_name, err);
156 sensor_list_remove (sensor);
157 }
158 return;
159 }
160 else if (list_item->sensor_not_present == 1)
161 {
162 list_item->sensor_not_present = 0;
164 INFO ("ipmi plugin: sensor_read_handler: sensor %s present.",
165 list_item->sensor_name);
167 if (c_ipmi_nofiy_notpresent)
168 {
169 notification_t n = { NOTIF_OKAY, time(NULL), "", "", "ipmi",
170 "", "", "", NULL };
172 sstrncpy (n.host, hostname_g, sizeof (n.host));
173 sstrncpy (n.type_instance, list_item->sensor_name,
174 sizeof (n.type_instance));
175 sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
176 ssnprintf (n.message, sizeof (n.message),
177 "sensor %s present", list_item->sensor_name);
179 plugin_dispatch_notification (&n);
180 }
181 }
183 if (value_present != IPMI_BOTH_VALUES_PRESENT)
184 {
185 INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
186 "because it provides %s. If you need this sensor, "
187 "please file a bug report.",
188 list_item->sensor_name,
189 (value_present == IPMI_RAW_VALUE_PRESENT)
190 ? "only the raw value"
191 : "no value");
192 sensor_list_remove (sensor);
193 return;
194 }
196 values[0].gauge = value;
198 vl.values = values;
199 vl.values_len = 1;
200 vl.time = time (NULL);
202 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
203 sstrncpy (vl.plugin, "ipmi", sizeof (vl.plugin));
204 sstrncpy (vl.type, list_item->sensor_type, sizeof (vl.type));
205 sstrncpy (vl.type_instance, list_item->sensor_name, sizeof (vl.type_instance));
207 plugin_dispatch_values (&vl);
208 } /* void sensor_read_handler */
210 static int sensor_list_add (ipmi_sensor_t *sensor)
211 {
212 ipmi_sensor_id_t sensor_id;
213 c_ipmi_sensor_list_t *list_item;
214 c_ipmi_sensor_list_t *list_prev;
216 char sensor_name[DATA_MAX_NAME_LEN];
217 char *sensor_name_ptr;
218 int sensor_type, len;
219 const char *type;
220 ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
222 sensor_id = ipmi_sensor_convert_to_id (sensor);
224 memset (sensor_name, 0, sizeof (sensor_name));
225 ipmi_sensor_get_name (sensor, sensor_name, sizeof (sensor_name));
226 sensor_name[sizeof (sensor_name) - 1] = 0;
228 len = DATA_MAX_NAME_LEN - strlen(sensor_name);
229 strncat(sensor_name, " ", len--);
230 strncat(sensor_name, ipmi_entity_get_entity_id_string(ent), len);
232 sensor_name_ptr = strstr (sensor_name, ").");
233 if (sensor_name_ptr == NULL)
234 sensor_name_ptr = sensor_name;
235 else
236 {
237 char *sensor_name_ptr_id = strstr (sensor_name, "(");
239 sensor_name_ptr += 2;
240 len = DATA_MAX_NAME_LEN - strlen(sensor_name);
241 strncat(sensor_name, " ", len--);
242 strncat(sensor_name, sensor_name_ptr_id,
243 MIN(sensor_name_ptr - sensor_name_ptr_id - 1, len));
244 }
246 /* Both `ignorelist' and `plugin_instance' may be NULL. */
247 if (ignorelist_match (ignorelist, sensor_name_ptr) != 0)
248 return (0);
250 /* FIXME: Use rate unit or base unit to scale the value */
252 sensor_type = ipmi_sensor_get_sensor_type (sensor);
253 switch (sensor_type)
254 {
255 case IPMI_SENSOR_TYPE_TEMPERATURE:
256 type = "temperature";
257 break;
259 case IPMI_SENSOR_TYPE_VOLTAGE:
260 type = "voltage";
261 break;
263 case IPMI_SENSOR_TYPE_CURRENT:
264 type = "current";
265 break;
267 case IPMI_SENSOR_TYPE_FAN:
268 type = "fanspeed";
269 break;
271 default:
272 {
273 const char *sensor_type_str;
275 sensor_type_str = ipmi_sensor_get_sensor_type_string (sensor);
276 INFO ("ipmi plugin: sensor_list_add: Ignore sensor %s, "
277 "because I don't know how to handle its type (%#x, %s). "
278 "If you need this sensor, please file a bug report.",
279 sensor_name_ptr, sensor_type, sensor_type_str);
280 return (-1);
281 }
282 } /* switch (sensor_type) */
284 pthread_mutex_lock (&sensor_list_lock);
286 list_prev = NULL;
287 for (list_item = sensor_list;
288 list_item != NULL;
289 list_item = list_item->next)
290 {
291 if (ipmi_cmp_sensor_id (sensor_id, list_item->sensor_id) == 0)
292 break;
293 list_prev = list_item;
294 } /* for (list_item) */
296 if (list_item != NULL)
297 {
298 pthread_mutex_unlock (&sensor_list_lock);
299 return (0);
300 }
302 list_item = (c_ipmi_sensor_list_t *) calloc (1, sizeof (c_ipmi_sensor_list_t));
303 if (list_item == NULL)
304 {
305 pthread_mutex_unlock (&sensor_list_lock);
306 return (-1);
307 }
309 list_item->sensor_id = ipmi_sensor_convert_to_id (sensor);
311 if (list_prev != NULL)
312 list_prev->next = list_item;
313 else
314 sensor_list = list_item;
316 sstrncpy (list_item->sensor_name, sensor_name_ptr,
317 sizeof (list_item->sensor_name));
318 sstrncpy (list_item->sensor_type, type, sizeof (list_item->sensor_type));
320 pthread_mutex_unlock (&sensor_list_lock);
322 if (c_ipmi_nofiy_add && (c_ipmi_init_in_progress == 0))
323 {
324 notification_t n = { NOTIF_OKAY, time(NULL), "", "", "ipmi",
325 "", "", "", NULL };
327 sstrncpy (n.host, hostname_g, sizeof (n.host));
328 sstrncpy (n.type_instance, list_item->sensor_name,
329 sizeof (n.type_instance));
330 sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
331 ssnprintf (n.message, sizeof (n.message),
332 "sensor %s added", list_item->sensor_name);
334 plugin_dispatch_notification (&n);
335 }
337 return (0);
338 } /* int sensor_list_add */
340 static int sensor_list_remove (ipmi_sensor_t *sensor)
341 {
342 ipmi_sensor_id_t sensor_id;
343 c_ipmi_sensor_list_t *list_item;
344 c_ipmi_sensor_list_t *list_prev;
346 sensor_id = ipmi_sensor_convert_to_id (sensor);
348 pthread_mutex_lock (&sensor_list_lock);
350 list_prev = NULL;
351 for (list_item = sensor_list;
352 list_item != NULL;
353 list_item = list_item->next)
354 {
355 if (ipmi_cmp_sensor_id (sensor_id, list_item->sensor_id) == 0)
356 break;
357 list_prev = list_item;
358 } /* for (list_item) */
360 if (list_item == NULL)
361 {
362 pthread_mutex_unlock (&sensor_list_lock);
363 return (-1);
364 }
366 if (list_prev == NULL)
367 sensor_list = list_item->next;
368 else
369 list_prev->next = list_item->next;
371 list_prev = NULL;
372 list_item->next = NULL;
374 pthread_mutex_unlock (&sensor_list_lock);
376 if (c_ipmi_nofiy_remove && c_ipmi_active)
377 {
378 notification_t n = { NOTIF_WARNING, time(NULL), "", "",
379 "ipmi", "", "", "", NULL };
381 sstrncpy (n.host, hostname_g, sizeof (n.host));
382 sstrncpy (n.type_instance, list_item->sensor_name,
383 sizeof (n.type_instance));
384 sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
385 ssnprintf (n.message, sizeof (n.message),
386 "sensor %s removed", list_item->sensor_name);
388 plugin_dispatch_notification (&n);
389 }
391 free (list_item);
392 return (0);
393 } /* int sensor_list_remove */
395 static int sensor_list_read_all (void)
396 {
397 c_ipmi_sensor_list_t *list_item;
399 pthread_mutex_lock (&sensor_list_lock);
401 for (list_item = sensor_list;
402 list_item != NULL;
403 list_item = list_item->next)
404 {
405 ipmi_sensor_id_get_reading (list_item->sensor_id,
406 sensor_read_handler, /* user data = */ list_item);
407 } /* for (list_item) */
409 pthread_mutex_unlock (&sensor_list_lock);
411 return (0);
412 } /* int sensor_list_read_all */
414 static int sensor_list_remove_all (void)
415 {
416 c_ipmi_sensor_list_t *list_item;
418 pthread_mutex_lock (&sensor_list_lock);
420 list_item = sensor_list;
421 sensor_list = NULL;
423 pthread_mutex_unlock (&sensor_list_lock);
425 while (list_item != NULL)
426 {
427 c_ipmi_sensor_list_t *list_next = list_item->next;
429 free (list_item);
431 list_item = list_next;
432 } /* while (list_item) */
434 return (0);
435 } /* int sensor_list_remove_all */
437 /*
438 * Entity handlers
439 */
440 static void entity_sensor_update_handler (enum ipmi_update_e op,
441 ipmi_entity_t *entity,
442 ipmi_sensor_t *sensor,
443 void *user_data)
444 {
445 /* TODO: Ignore sensors we cannot read */
447 if ((op == IPMI_ADDED) || (op == IPMI_CHANGED))
448 {
449 /* Will check for duplicate entries.. */
450 sensor_list_add (sensor);
451 }
452 else if (op == IPMI_DELETED)
453 {
454 sensor_list_remove (sensor);
455 }
456 } /* void entity_sensor_update_handler */
458 /*
459 * Domain handlers
460 */
461 static void domain_entity_update_handler (enum ipmi_update_e op,
462 ipmi_domain_t *domain,
463 ipmi_entity_t *entity,
464 void *user_data)
465 {
466 int status;
468 if (op == IPMI_ADDED)
469 {
470 status = ipmi_entity_add_sensor_update_handler (entity,
471 entity_sensor_update_handler, /* user data = */ NULL);
472 if (status != 0)
473 {
474 c_ipmi_error ("ipmi_entity_add_sensor_update_handler", status);
475 }
476 }
477 else if (op == IPMI_DELETED)
478 {
479 status = ipmi_entity_remove_sensor_update_handler (entity,
480 entity_sensor_update_handler, /* user data = */ NULL);
481 if (status != 0)
482 {
483 c_ipmi_error ("ipmi_entity_remove_sensor_update_handler", status);
484 }
485 }
486 } /* void domain_entity_update_handler */
488 static void domain_connection_change_handler (ipmi_domain_t *domain,
489 int err,
490 unsigned int conn_num,
491 unsigned int port_num,
492 int still_connected,
493 void *user_data)
494 {
495 int status;
497 printf ("domain_connection_change_handler (domain = %p, err = %i, "
498 "conn_num = %u, port_num = %u, still_connected = %i, "
499 "user_data = %p);\n",
500 (void *) domain, err, conn_num, port_num, still_connected, user_data);
502 status = ipmi_domain_add_entity_update_handler (domain,
503 domain_entity_update_handler, /* user data = */ NULL);
504 if (status != 0)
505 {
506 c_ipmi_error ("ipmi_domain_add_entity_update_handler", status);
507 }
508 } /* void domain_connection_change_handler */
510 static int thread_init (os_handler_t **ret_os_handler)
511 {
512 os_handler_t *os_handler;
513 ipmi_open_option_t open_option[1];
514 ipmi_con_t *smi_connection = NULL;
515 ipmi_domain_id_t domain_id;
516 int status;
518 os_handler = ipmi_posix_thread_setup_os_handler (SIGUSR2);
519 if (os_handler == NULL)
520 {
521 ERROR ("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
522 return (-1);
523 }
525 ipmi_init (os_handler);
527 status = ipmi_smi_setup_con (/* if_num = */ 0,
528 os_handler,
529 /* user data = */ NULL,
530 &smi_connection);
531 if (status != 0)
532 {
533 c_ipmi_error ("ipmi_smi_setup_con", status);
534 return (-1);
535 }
537 memset (open_option, 0, sizeof (open_option));
538 open_option[0].option = IPMI_OPEN_OPTION_ALL;
539 open_option[0].ival = 1;
541 status = ipmi_open_domain ("mydomain", &smi_connection, /* num_con = */ 1,
542 domain_connection_change_handler, /* user data = */ NULL,
543 /* domain_fully_up_handler = */ NULL, /* user data = */ NULL,
544 open_option, sizeof (open_option) / sizeof (open_option[0]),
545 &domain_id);
546 if (status != 0)
547 {
548 c_ipmi_error ("ipmi_open_domain", status);
549 return (-1);
550 }
552 *ret_os_handler = os_handler;
553 return (0);
554 } /* int thread_init */
556 static void *thread_main (void *user_data)
557 {
558 int status;
559 os_handler_t *os_handler = NULL;
561 status = thread_init (&os_handler);
562 if (status != 0)
563 {
564 fprintf (stderr, "ipmi plugin: thread_init failed.\n");
565 return ((void *) -1);
566 }
568 while (c_ipmi_active != 0)
569 {
570 struct timeval tv = { 1, 0 };
571 os_handler->perform_one_op (os_handler, &tv);
572 }
574 ipmi_posix_thread_free_os_handler (os_handler);
576 return ((void *) 0);
577 } /* void *thread_main */
579 static int c_ipmi_config (const char *key, const char *value)
580 {
581 if (ignorelist == NULL)
582 ignorelist = ignorelist_create (/* invert = */ 1);
583 if (ignorelist == NULL)
584 return (1);
586 if (strcasecmp ("Sensor", key) == 0)
587 {
588 ignorelist_add (ignorelist, value);
589 }
590 else if (strcasecmp ("IgnoreSelected", key) == 0)
591 {
592 int invert = 1;
593 if ((strcasecmp ("True", value) == 0)
594 || (strcasecmp ("Yes", value) == 0)
595 || (strcasecmp ("On", value) == 0))
596 invert = 0;
597 ignorelist_set_invert (ignorelist, invert);
598 }
599 else if (strcasecmp ("NotifySensorAdd", key) == 0)
600 {
601 if ((strcasecmp ("True", value) == 0)
602 || (strcasecmp ("Yes", value) == 0)
603 || (strcasecmp ("On", value) == 0))
604 c_ipmi_nofiy_add = 1;
605 }
606 else if (strcasecmp ("NotifySensorRemove", key) == 0)
607 {
608 if ((strcasecmp ("True", value) == 0)
609 || (strcasecmp ("Yes", value) == 0)
610 || (strcasecmp ("On", value) == 0))
611 c_ipmi_nofiy_remove = 1;
612 }
613 else if (strcasecmp ("NotifySensorNotPresent", key) == 0)
614 {
615 if ((strcasecmp ("True", value) == 0)
616 || (strcasecmp ("Yes", value) == 0)
617 || (strcasecmp ("On", value) == 0))
618 c_ipmi_nofiy_notpresent = 1;
619 }
620 else
621 {
622 return (-1);
623 }
625 return (0);
626 } /* int c_ipmi_config */
628 static int c_ipmi_init (void)
629 {
630 int status;
632 /* Don't send `ADD' notifications during startup (~ 1 minute) */
633 c_ipmi_init_in_progress = 1 + (60 / interval_g);
635 c_ipmi_active = 1;
637 status = pthread_create (&thread_id, /* attr = */ NULL, thread_main,
638 /* user data = */ NULL);
639 if (status != 0)
640 {
641 c_ipmi_active = 0;
642 thread_id = (pthread_t) 0;
643 ERROR ("ipmi plugin: pthread_create failed.");
644 return (-1);
645 }
647 return (0);
648 } /* int c_ipmi_init */
650 static int c_ipmi_read (void)
651 {
652 if ((c_ipmi_active == 0) || (thread_id == (pthread_t) 0))
653 {
654 INFO ("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
655 return (-1);
656 }
658 sensor_list_read_all ();
660 if (c_ipmi_init_in_progress > 0)
661 c_ipmi_init_in_progress--;
662 else
663 c_ipmi_init_in_progress = 0;
665 return (0);
666 } /* int c_ipmi_read */
668 static int c_ipmi_shutdown (void)
669 {
670 c_ipmi_active = 0;
672 if (thread_id != (pthread_t) 0)
673 {
674 pthread_join (thread_id, NULL);
675 thread_id = (pthread_t) 0;
676 }
678 sensor_list_remove_all ();
680 return (0);
681 } /* int c_ipmi_shutdown */
683 void module_register (void)
684 {
685 plugin_register_config ("ipmi", c_ipmi_config,
686 config_keys, config_keys_num);
687 plugin_register_init ("ipmi", c_ipmi_init);
688 plugin_register_read ("ipmi", c_ipmi_read);
689 plugin_register_shutdown ("ipmi", c_ipmi_shutdown);
690 } /* void module_register */
692 /* vim: set sw=2 sts=2 ts=8 fdm=marker et : */