2 * collectd - src/ipmi.c
3 * Copyright (C) 2008-2009 Florian octo Forster
4 * Copyright (C) 2008 Peter Holik
5 * Copyright (C) 2009 Bruno Prémont
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at collectd.org>
22 * Peter Holik <peter at holik.at>
23 * Bruno Prémont <bonbons at linux-vserver.org>
24 * Pavel Rochnyak <pavel2000 ngs.ru>
31 #include "utils_ignorelist.h"
33 #include <OpenIPMI/ipmi_auth.h>
34 #include <OpenIPMI/ipmi_conn.h>
35 #include <OpenIPMI/ipmi_err.h>
36 #include <OpenIPMI/ipmi_lan.h>
37 #include <OpenIPMI/ipmi_posix.h>
38 #include <OpenIPMI/ipmi_smi.h>
39 #include <OpenIPMI/ipmiif.h>
41 #define ERR_BUF_SIZE 1024
46 struct c_ipmi_sensor_list_s;
47 typedef struct c_ipmi_sensor_list_s c_ipmi_sensor_list_t;
49 struct c_ipmi_instance_s {
51 ignorelist_t *ignorelist;
54 _Bool notify_notpresent;
57 _Bool sel_clear_event;
63 unsigned int authtype;
66 ipmi_con_t *connection;
67 pthread_mutex_t sensor_list_lock;
68 c_ipmi_sensor_list_t *sensor_list;
74 struct c_ipmi_instance_s *next;
76 typedef struct c_ipmi_instance_s c_ipmi_instance_t;
78 struct c_ipmi_sensor_list_s {
79 ipmi_sensor_id_t sensor_id;
80 char sensor_name[DATA_MAX_NAME_LEN];
81 char sensor_type[DATA_MAX_NAME_LEN];
82 int sensor_not_present;
83 c_ipmi_sensor_list_t *next;
84 c_ipmi_instance_t *instance;
89 * Module global variables
91 static os_handler_t *os_handler;
92 static c_ipmi_instance_t *instances = NULL;
95 * Misc private functions
97 static void c_ipmi_error(c_ipmi_instance_t *st, const char *func, int status) {
98 char errbuf[ERR_BUF_SIZE] = {0};
100 if (IPMI_IS_OS_ERR(status) || IPMI_IS_RMCPP_ERR(status) ||
101 IPMI_IS_IPMI_ERR(status)) {
102 ipmi_get_error_string(status, errbuf, sizeof(errbuf));
105 if (errbuf[0] == 0) {
106 snprintf(errbuf, sizeof(errbuf), "Unknown error %#x", status);
108 errbuf[sizeof(errbuf) - 1] = 0;
110 ERROR("ipmi plugin: %s failed for `%s`: %s", func, st->name, errbuf);
111 } /* void c_ipmi_error */
113 static void c_ipmi_log(os_handler_t *handler, const char *format,
114 enum ipmi_log_type_e log_type, va_list ap) {
115 char msg[ERR_BUF_SIZE];
117 vsnprintf(msg, sizeof(msg), format, ap);
121 INFO("ipmi plugin: %s", msg);
123 case IPMI_LOG_WARNING:
124 NOTICE("ipmi plugin: %s", msg);
126 case IPMI_LOG_SEVERE:
127 WARNING("ipmi plugin: %s", msg);
130 ERROR("ipmi plugin: %s", msg);
132 case IPMI_LOG_ERR_INFO:
133 ERROR("ipmi plugin: %s", msg);
136 case IPMI_LOG_DEBUG_START:
138 fprintf(stderr, "ipmi plugin: %s\n", msg);
140 case IPMI_LOG_DEBUG_CONT:
141 case IPMI_LOG_DEBUG_END:
142 fprintf(stderr, "%s\n", msg);
145 case IPMI_LOG_DEBUG_START:
147 case IPMI_LOG_DEBUG_CONT:
148 case IPMI_LOG_DEBUG_END:
152 } /* void c_ipmi_log */
157 /* Prototype for sensor_list_remove, so sensor_read_handler can call it. */
158 static int sensor_list_remove(c_ipmi_instance_t *st, ipmi_sensor_t *sensor);
160 static void sensor_read_handler(ipmi_sensor_t *sensor, int err,
161 enum ipmi_value_present_e value_present,
162 unsigned int __attribute__((unused)) raw_value,
163 double value, ipmi_states_t *states,
165 value_list_t vl = VALUE_LIST_INIT;
167 c_ipmi_sensor_list_t *list_item = (c_ipmi_sensor_list_t *)user_data;
168 c_ipmi_instance_t *st = list_item->instance;
173 if (IPMI_IS_IPMI_ERR(err) &&
174 IPMI_GET_IPMI_ERR(err) == IPMI_NOT_PRESENT_CC) {
175 if (list_item->sensor_not_present == 0) {
176 list_item->sensor_not_present = 1;
178 INFO("ipmi plugin: sensor_read_handler: sensor `%s` of `%s` "
180 list_item->sensor_name, st->name);
182 if (st->notify_notpresent) {
184 NOTIF_WARNING, cdtime(), "", "", "ipmi", "", "", "", NULL};
186 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g,
188 sstrncpy(n.type_instance, list_item->sensor_name,
189 sizeof(n.type_instance));
190 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
191 snprintf(n.message, sizeof(n.message), "sensor %s not present",
192 list_item->sensor_name);
194 plugin_dispatch_notification(&n);
197 } else if (IPMI_IS_IPMI_ERR(err) &&
198 IPMI_GET_IPMI_ERR(err) ==
199 IPMI_NOT_SUPPORTED_IN_PRESENT_STATE_CC) {
200 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` not ready.",
201 list_item->sensor_name, st->name);
202 } else if (IPMI_IS_IPMI_ERR(err) &&
203 IPMI_GET_IPMI_ERR(err) == IPMI_TIMEOUT_CC) {
204 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` timed out.",
205 list_item->sensor_name, st->name);
207 char errbuf[ERR_BUF_SIZE] = {0};
208 ipmi_get_error_string(err, errbuf, sizeof(errbuf) - 1);
210 if (IPMI_IS_IPMI_ERR(err))
211 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
213 list_item->sensor_name, st->name, errbuf);
214 else if (IPMI_IS_OS_ERR(err))
215 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
217 list_item->sensor_name, st->name, errbuf, IPMI_GET_OS_ERR(err));
218 else if (IPMI_IS_RMCPP_ERR(err))
219 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
221 list_item->sensor_name, st->name, errbuf);
222 else if (IPMI_IS_SOL_ERR(err))
223 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
225 list_item->sensor_name, st->name, errbuf, IPMI_GET_SOL_ERR(err));
227 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed "
228 "with error %#x. of class %#x",
229 list_item->sensor_name, st->name, err & 0xff, err & 0xffffff00);
232 } else if (list_item->sensor_not_present == 1) {
233 list_item->sensor_not_present = 0;
235 INFO("ipmi plugin: sensor_read_handler: sensor `%s` of `%s` present.",
236 list_item->sensor_name, st->name);
238 if (st->notify_notpresent) {
239 notification_t n = {NOTIF_OKAY, cdtime(), "", "", "ipmi",
242 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g,
244 sstrncpy(n.type_instance, list_item->sensor_name,
245 sizeof(n.type_instance));
246 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
247 snprintf(n.message, sizeof(n.message), "sensor %s present",
248 list_item->sensor_name);
250 plugin_dispatch_notification(&n);
254 if (value_present != IPMI_BOTH_VALUES_PRESENT) {
255 INFO("ipmi plugin: sensor_read_handler: Removing sensor `%s` of `%s`, "
256 "because it provides %s. If you need this sensor, "
257 "please file a bug report.",
258 list_item->sensor_name, st->name,
259 (value_present == IPMI_RAW_VALUE_PRESENT) ? "only the raw value"
261 sensor_list_remove(st, sensor);
265 if (!ipmi_is_sensor_scanning_enabled(states)) {
266 DEBUG("ipmi plugin: sensor_read_handler: Skipping sensor `%s` of `%s`, "
267 "it is in 'scanning disabled' state.",
268 list_item->sensor_name, st->name);
272 if (ipmi_is_initial_update_in_progress(states)) {
273 DEBUG("ipmi plugin: sensor_read_handler: Skipping sensor `%s` of `%s`, "
274 "it is in 'initial update in progress' state.",
275 list_item->sensor_name, st->name);
279 vl.values = &(value_t){.gauge = value};
282 if (st->host != NULL)
283 sstrncpy(vl.host, st->host, sizeof(vl.host));
284 sstrncpy(vl.plugin, "ipmi", sizeof(vl.plugin));
285 sstrncpy(vl.type, list_item->sensor_type, sizeof(vl.type));
286 sstrncpy(vl.type_instance, list_item->sensor_name, sizeof(vl.type_instance));
288 plugin_dispatch_values(&vl);
289 } /* void sensor_read_handler */
291 static void sensor_get_name(ipmi_sensor_t *sensor, char *buffer, int buf_len) {
292 char temp[DATA_MAX_NAME_LEN] = {0};
293 ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
294 const char *entity_id_string = ipmi_entity_get_entity_id_string(ent);
295 char sensor_name[DATA_MAX_NAME_LEN] = "";
296 char *sensor_name_ptr;
298 if ((buffer == NULL) || (buf_len == 0))
301 ipmi_sensor_get_name(sensor, temp, sizeof(temp));
302 temp[sizeof(temp) - 1] = 0;
304 if (entity_id_string != NULL && strlen(temp))
305 snprintf(sensor_name, sizeof(sensor_name), "%s %s", temp, entity_id_string);
306 else if (entity_id_string != NULL)
307 sstrncpy(sensor_name, entity_id_string, sizeof(sensor_name));
309 sstrncpy(sensor_name, temp, sizeof(sensor_name));
312 sstrncpy(temp, sensor_name, sizeof(temp));
313 sensor_name_ptr = strstr(temp, ").");
314 if (sensor_name_ptr != NULL) {
315 /* If name is something like "foo (123).bar",
316 * change that to "bar (123)".
317 * Both, sensor_name_ptr and sensor_id_ptr point to memory within the
318 * `temp' array, which holds a copy of the current `sensor_name'. */
321 /* `sensor_name_ptr' points to ").bar". */
322 sensor_name_ptr[1] = 0;
323 /* `temp' holds "foo (123)\0bar\0". */
324 sensor_name_ptr += 2;
325 /* `sensor_name_ptr' now points to "bar". */
327 sensor_id_ptr = strstr(temp, "(");
328 if (sensor_id_ptr != NULL) {
329 /* `sensor_id_ptr' now points to "(123)". */
330 snprintf(sensor_name, sizeof(sensor_name), "%s %s", sensor_name_ptr,
333 /* else: don't touch sensor_name. */
336 sstrncpy(buffer, sensor_name, buf_len);
339 static int sensor_list_add(c_ipmi_instance_t *st, ipmi_sensor_t *sensor) {
340 ipmi_sensor_id_t sensor_id;
341 c_ipmi_sensor_list_t *list_item;
342 c_ipmi_sensor_list_t *list_prev;
344 char buffer[DATA_MAX_NAME_LEN] = {0};
345 char *sensor_name_ptr = buffer;
349 sensor_id = ipmi_sensor_convert_to_id(sensor);
350 sensor_get_name(sensor, buffer, sizeof(buffer));
352 DEBUG("ipmi plugin: sensor_list_add: Found sensor `%s` of `%s`,"
354 " Event reading type: %#x"
356 " Event support: %#x",
357 sensor_name_ptr, st->name, ipmi_sensor_get_sensor_type(sensor),
358 ipmi_sensor_get_event_reading_type(sensor),
359 ipmi_sensor_get_sensor_direction(sensor),
360 ipmi_sensor_get_event_support(sensor));
362 /* Both `ignorelist' and `sensor_name_ptr' may be NULL. */
363 if (ignorelist_match(st->ignorelist, sensor_name_ptr) != 0)
366 /* FIXME: Use rate unit or base unit to scale the value */
368 sensor_type = ipmi_sensor_get_sensor_type(sensor);
371 * ipmitool/lib/ipmi_sdr.c sdr_sensor_has_analog_reading() has a notice
372 * about 'Threshold sensors' and 'analog readings'. Discrete sensor may
373 * have analog data, but discrete sensors support is not implemented
376 * ipmi_sensor_id_get_reading() supports only 'Threshold' sensors.
377 * See lib/sensor.c:4842, stand_ipmi_sensor_get_reading() for details.
379 if (!ipmi_sensor_get_is_readable(sensor)) {
380 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
381 "because it don't readable! Its type: (%#x, %s). ",
382 sensor_name_ptr, st->name, sensor_type,
383 ipmi_sensor_get_sensor_type_string(sensor));
387 if (ipmi_sensor_get_event_reading_type(sensor) !=
388 IPMI_EVENT_READING_TYPE_THRESHOLD) {
389 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
390 "because it is discrete (%#x)! Its type: (%#x, %s). ",
391 sensor_name_ptr, st->name, sensor_type,
392 ipmi_sensor_get_event_reading_type(sensor),
393 ipmi_sensor_get_sensor_type_string(sensor));
397 switch (sensor_type) {
398 case IPMI_SENSOR_TYPE_TEMPERATURE:
399 type = "temperature";
402 case IPMI_SENSOR_TYPE_VOLTAGE:
406 case IPMI_SENSOR_TYPE_CURRENT:
410 case IPMI_SENSOR_TYPE_FAN:
415 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
416 "because I don't know how to handle its type (%#x, %s). "
417 "If you need this sensor, please file a bug report.",
418 sensor_name_ptr, st->name, sensor_type,
419 ipmi_sensor_get_sensor_type_string(sensor));
422 } /* switch (sensor_type) */
424 pthread_mutex_lock(&st->sensor_list_lock);
427 for (list_item = st->sensor_list; list_item != NULL;
428 list_item = list_item->next) {
429 if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
431 list_prev = list_item;
432 } /* for (list_item) */
434 if (list_item != NULL) {
435 pthread_mutex_unlock(&st->sensor_list_lock);
439 list_item = (c_ipmi_sensor_list_t *)calloc(1, sizeof(c_ipmi_sensor_list_t));
440 if (list_item == NULL) {
441 pthread_mutex_unlock(&st->sensor_list_lock);
445 list_item->instance = st;
446 list_item->sensor_id = ipmi_sensor_convert_to_id(sensor);
448 if (list_prev != NULL)
449 list_prev->next = list_item;
451 st->sensor_list = list_item;
453 sstrncpy(list_item->sensor_name, sensor_name_ptr,
454 sizeof(list_item->sensor_name));
455 sstrncpy(list_item->sensor_type, type, sizeof(list_item->sensor_type));
457 pthread_mutex_unlock(&st->sensor_list_lock);
459 if (st->notify_add && (st->init_in_progress == 0)) {
460 notification_t n = {NOTIF_OKAY, cdtime(), "", "", "ipmi", "", "", "", NULL};
462 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g,
464 sstrncpy(n.type_instance, list_item->sensor_name, sizeof(n.type_instance));
465 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
466 snprintf(n.message, sizeof(n.message), "sensor %s added",
467 list_item->sensor_name);
469 plugin_dispatch_notification(&n);
473 } /* int sensor_list_add */
475 static int sensor_list_remove(c_ipmi_instance_t *st, ipmi_sensor_t *sensor) {
476 ipmi_sensor_id_t sensor_id;
477 c_ipmi_sensor_list_t *list_item;
478 c_ipmi_sensor_list_t *list_prev;
480 sensor_id = ipmi_sensor_convert_to_id(sensor);
482 pthread_mutex_lock(&st->sensor_list_lock);
485 for (list_item = st->sensor_list; list_item != NULL;
486 list_item = list_item->next) {
487 if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
489 list_prev = list_item;
490 } /* for (list_item) */
492 if (list_item == NULL) {
493 pthread_mutex_unlock(&st->sensor_list_lock);
497 if (list_prev == NULL)
498 st->sensor_list = list_item->next;
500 list_prev->next = list_item->next;
503 list_item->next = NULL;
505 pthread_mutex_unlock(&st->sensor_list_lock);
507 if (st->notify_remove && st->active) {
508 notification_t n = {NOTIF_WARNING, cdtime(), "", "", "ipmi", "", "", "",
511 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g,
513 sstrncpy(n.type_instance, list_item->sensor_name, sizeof(n.type_instance));
514 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
515 snprintf(n.message, sizeof(n.message), "sensor %s removed",
516 list_item->sensor_name);
518 plugin_dispatch_notification(&n);
523 } /* int sensor_list_remove */
525 static int sensor_list_read_all(c_ipmi_instance_t *st) {
526 pthread_mutex_lock(&st->sensor_list_lock);
528 for (c_ipmi_sensor_list_t *list_item = st->sensor_list; list_item != NULL;
529 list_item = list_item->next) {
530 DEBUG("ipmi plugin: try read sensor `%s` of `%s`, use: %d",
531 list_item->sensor_name, st->name, list_item->use);
533 /* Reading already initiated */
538 ipmi_sensor_id_get_reading(list_item->sensor_id, sensor_read_handler,
539 /* user data = */ (void *)list_item);
540 } /* for (list_item) */
542 pthread_mutex_unlock(&st->sensor_list_lock);
545 } /* int sensor_list_read_all */
547 static int sensor_list_remove_all(c_ipmi_instance_t *st) {
548 c_ipmi_sensor_list_t *list_item;
550 pthread_mutex_lock(&st->sensor_list_lock);
552 list_item = st->sensor_list;
553 st->sensor_list = NULL;
555 pthread_mutex_unlock(&st->sensor_list_lock);
557 while (list_item != NULL) {
558 c_ipmi_sensor_list_t *list_next = list_item->next;
562 list_item = list_next;
563 } /* while (list_item) */
566 } /* int sensor_list_remove_all */
568 static int sensor_convert_threshold_severity(enum ipmi_thresh_e severity) {
570 case IPMI_LOWER_NON_CRITICAL:
571 case IPMI_UPPER_NON_CRITICAL:
573 case IPMI_LOWER_CRITICAL:
574 case IPMI_UPPER_CRITICAL:
575 return NOTIF_WARNING;
576 case IPMI_LOWER_NON_RECOVERABLE:
577 case IPMI_UPPER_NON_RECOVERABLE:
578 return NOTIF_FAILURE;
581 } /* switch (severity) */
582 } /* int sensor_convert_threshold_severity */
584 static void add_event_common_data(notification_t *n, ipmi_sensor_t *sensor,
585 enum ipmi_event_dir_e dir,
586 ipmi_event_t *event) {
587 ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
589 plugin_notification_meta_add_string(n, "entity_name",
590 ipmi_entity_get_entity_id_string(ent));
591 plugin_notification_meta_add_signed_int(n, "entity_id",
592 ipmi_entity_get_entity_id(ent));
593 plugin_notification_meta_add_signed_int(n, "entity_instance",
594 ipmi_entity_get_entity_instance(ent));
595 plugin_notification_meta_add_boolean(n, "assert", dir == IPMI_ASSERTION);
598 plugin_notification_meta_add_signed_int(n, "event_type",
599 ipmi_event_get_type(event));
600 } /* void add_event_sensor_meta_data */
602 static int sensor_threshold_event_handler(
603 ipmi_sensor_t *sensor, enum ipmi_event_dir_e dir,
604 enum ipmi_thresh_e threshold, enum ipmi_event_value_dir_e high_low,
605 enum ipmi_value_present_e value_present, unsigned int raw_value,
606 double value, void *cb_data, ipmi_event_t *event) {
608 c_ipmi_instance_t *st = (c_ipmi_instance_t *)cb_data;
610 /* From the IPMI specification Chapter 2: Events.
611 * If a callback handles the event, then all future callbacks called due to
612 * the event will receive a NULL for the event. So be ready to handle a NULL
613 * event in all your event handlers. A NULL may also be passed to an event
614 * handler if the callback was not due to an event. */
616 return IPMI_EVENT_NOT_HANDLED;
618 /* offset is a table index and it's represented as enum of strings that are
619 organized in the way - high and low for each threshold severity level */
620 notification_t n = {NOTIF_OKAY, cdtime(), "", "", "ipmi", "", "", "", NULL};
621 unsigned int offset = (2 * threshold) + high_low;
622 unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
623 unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
624 const char *event_state =
625 ipmi_get_reading_name(event_type, sensor_type, offset);
626 sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
627 if (value_present != IPMI_NO_VALUES_PRESENT)
628 snprintf(n.message, sizeof(n.message),
629 "sensor %s received event: %s, value is %f", n.type_instance,
632 snprintf(n.message, sizeof(n.message),
633 "sensor %s received event: %s, value not provided",
634 n.type_instance, event_state);
636 DEBUG("Threshold event received for sensor %s", n.type_instance);
638 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g, sizeof(n.host));
639 sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
640 n.severity = sensor_convert_threshold_severity(threshold);
641 n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
643 plugin_notification_meta_add_string(&n, "severity",
644 ipmi_get_threshold_string(threshold));
645 plugin_notification_meta_add_string(&n, "direction",
646 ipmi_get_value_dir_string(high_low));
648 switch (value_present) {
649 case IPMI_BOTH_VALUES_PRESENT:
650 plugin_notification_meta_add_double(&n, "val", value);
651 /* both values present, so fall-through to add raw value too */
652 case IPMI_RAW_VALUE_PRESENT: {
653 char buf[DATA_MAX_NAME_LEN] = {0};
654 snprintf(buf, sizeof(buf), "0x%2.2x", raw_value);
655 plugin_notification_meta_add_string(&n, "raw", buf);
659 } /* switch (value_present) */
661 add_event_common_data(&n, sensor, dir, event);
663 plugin_dispatch_notification(&n);
664 plugin_notification_meta_free(n.meta);
666 /* Delete handled ipmi event from the list */
667 if (st->sel_clear_event) {
668 ipmi_event_delete(event, NULL, NULL);
669 return IPMI_EVENT_HANDLED;
672 return IPMI_EVENT_NOT_HANDLED;
673 } /* int sensor_threshold_event_handler */
675 static int sensor_discrete_event_handler(ipmi_sensor_t *sensor,
676 enum ipmi_event_dir_e dir, int offset,
677 int severity, int prev_severity,
678 void *cb_data, ipmi_event_t *event) {
680 c_ipmi_instance_t *st = (c_ipmi_instance_t *)cb_data;
682 /* From the IPMI specification Chapter 2: Events.
683 * If a callback handles the event, then all future callbacks called due to
684 * the event will receive a NULL for the event. So be ready to handle a NULL
685 * event in all your event handlers. A NULL may also be passed to an event
686 * handler if the callback was not due to an event. */
688 return IPMI_EVENT_NOT_HANDLED;
690 notification_t n = {NOTIF_OKAY, cdtime(), "", "", "ipmi", "", "", "", NULL};
691 unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
692 unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
693 const char *event_state =
694 ipmi_get_reading_name(event_type, sensor_type, offset);
695 sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
696 snprintf(n.message, sizeof(n.message), "sensor %s received event: %s",
697 n.type_instance, event_state);
699 DEBUG("Discrete event received for sensor %s", n.type_instance);
701 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g, sizeof(n.host));
702 sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
703 n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
705 plugin_notification_meta_add_signed_int(&n, "offset", offset);
708 plugin_notification_meta_add_signed_int(&n, "severity", severity);
710 if (prev_severity != -1)
711 plugin_notification_meta_add_signed_int(&n, "prevseverity", prev_severity);
713 add_event_common_data(&n, sensor, dir, event);
715 plugin_dispatch_notification(&n);
716 plugin_notification_meta_free(n.meta);
718 /* Delete handled ipmi event from the list */
719 if (st->sel_clear_event) {
720 ipmi_event_delete(event, NULL, NULL);
721 return IPMI_EVENT_HANDLED;
724 return IPMI_EVENT_NOT_HANDLED;
725 } /* int sensor_discrete_event_handler */
731 entity_sensor_update_handler(enum ipmi_update_e op,
732 ipmi_entity_t __attribute__((unused)) * entity,
733 ipmi_sensor_t *sensor, void *user_data) {
734 c_ipmi_instance_t *st = (c_ipmi_instance_t *)user_data;
736 if ((op == IPMI_ADDED) || (op == IPMI_CHANGED)) {
737 /* Will check for duplicate entries.. */
738 sensor_list_add(st, sensor);
740 if (st->sel_enabled) {
742 /* register threshold event if threshold sensor support events */
743 if ((ipmi_sensor_get_event_reading_type(sensor) ==
744 IPMI_EVENT_READING_TYPE_THRESHOLD) &&
745 (ipmi_sensor_get_threshold_access(sensor) !=
746 IPMI_THRESHOLD_ACCESS_SUPPORT_NONE))
747 status = ipmi_sensor_add_threshold_event_handler(
748 sensor, sensor_threshold_event_handler, st);
749 /* register discrete handler if discrete/specific sensor support events */
750 else if (ipmi_sensor_get_event_support(sensor) != IPMI_EVENT_SUPPORT_NONE)
751 status = ipmi_sensor_add_discrete_event_handler(
752 sensor, sensor_discrete_event_handler, st);
755 char buf[DATA_MAX_NAME_LEN] = {0};
756 sensor_get_name(sensor, buf, sizeof(buf));
757 ERROR("Unable to add sensor %s event handler, status: %d", buf, status);
760 } else if (op == IPMI_DELETED) {
761 sensor_list_remove(st, sensor);
763 if (st->sel_enabled) {
764 if (ipmi_sensor_get_event_reading_type(sensor) ==
765 IPMI_EVENT_READING_TYPE_THRESHOLD)
766 ipmi_sensor_remove_threshold_event_handler(
767 sensor, sensor_threshold_event_handler, st);
769 ipmi_sensor_remove_discrete_event_handler(
770 sensor, sensor_discrete_event_handler, st);
773 } /* void entity_sensor_update_handler */
779 domain_entity_update_handler(enum ipmi_update_e op,
780 ipmi_domain_t __attribute__((unused)) * domain,
781 ipmi_entity_t *entity, void *user_data) {
783 c_ipmi_instance_t *st = (c_ipmi_instance_t *)user_data;
785 if (op == IPMI_ADDED) {
786 status = ipmi_entity_add_sensor_update_handler(
787 entity, entity_sensor_update_handler, /* user data = */ (void *)st);
789 c_ipmi_error(st, "ipmi_entity_add_sensor_update_handler", status);
791 } else if (op == IPMI_DELETED) {
792 status = ipmi_entity_remove_sensor_update_handler(
793 entity, entity_sensor_update_handler, /* user data = */ (void *)st);
795 c_ipmi_error(st, "ipmi_entity_remove_sensor_update_handler", status);
798 } /* void domain_entity_update_handler */
800 static void smi_event_handler(ipmi_con_t __attribute__((unused)) * ipmi,
801 const ipmi_addr_t __attribute__((unused)) * addr,
802 unsigned int __attribute__((unused)) addr_len,
803 ipmi_event_t *event, void *cb_data) {
804 unsigned int type = ipmi_event_get_type(event);
805 ipmi_domain_t *domain = cb_data;
807 DEBUG("%s: Event received: type %u", __FUNCTION__, type);
810 /* It's not a standard IPMI event. */
813 /* force domain to reread SELs */
814 ipmi_domain_reread_sels(domain, NULL, NULL);
817 static void domain_connection_change_handler(ipmi_domain_t *domain, int err,
818 unsigned int conn_num,
819 unsigned int port_num,
823 DEBUG("domain_connection_change_handler (domain = %p, err = %i, "
824 "conn_num = %u, port_num = %u, still_connected = %i, "
826 (void *)domain, err, conn_num, port_num, still_connected, user_data);
828 c_ipmi_instance_t *st = (c_ipmi_instance_t *)user_data;
831 c_ipmi_error(st, "domain_connection_change_handler", err);
833 if (!still_connected) {
835 if (st->notify_conn && st->connected && st->init_in_progress == 0) {
836 notification_t n = {NOTIF_FAILURE, cdtime(), "", "", "ipmi", "", "", "",
839 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g,
841 sstrncpy(n.message, "IPMI connection lost", sizeof(n.plugin));
843 plugin_dispatch_notification(&n);
850 if (st->notify_conn && !st->connected && st->init_in_progress == 0) {
851 notification_t n = {NOTIF_OKAY, cdtime(), "", "", "ipmi", "", "", "", NULL};
853 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g,
855 sstrncpy(n.message, "IPMI connection restored", sizeof(n.plugin));
857 plugin_dispatch_notification(&n);
862 int status = ipmi_domain_add_entity_update_handler(
863 domain, domain_entity_update_handler, /* user data = */ st);
865 c_ipmi_error(st, "ipmi_domain_add_entity_update_handler", status);
868 status = st->connection->add_event_handler(st->connection, smi_event_handler,
872 c_ipmi_error(st, "Failed to register smi event handler", status);
873 } /* void domain_connection_change_handler */
875 static int c_ipmi_thread_init(c_ipmi_instance_t *st) {
876 ipmi_domain_id_t domain_id;
879 if (st->connaddr != NULL) {
880 char *ip_addrs[1] = {NULL}, *ports[1] = {NULL};
882 ip_addrs[0] = strdup(st->connaddr);
883 ports[0] = strdup(IPMI_LAN_STD_PORT_STR);
885 status = ipmi_ip_setup_con(ip_addrs, ports, 1, st->authtype,
886 (unsigned int)IPMI_PRIVILEGE_USER, st->username,
887 strlen(st->username), st->password,
888 strlen(st->password), os_handler,
889 /* user data = */ NULL, &st->connection);
891 c_ipmi_error(st, "ipmi_ip_setup_con", status);
895 status = ipmi_smi_setup_con(/* if_num = */ 0, os_handler,
896 /* user data = */ NULL, &st->connection);
898 c_ipmi_error(st, "ipmi_smi_setup_con", status);
903 size_t open_option_num = 0;
904 ipmi_open_option_t open_option[2];
906 open_option[open_option_num].option = IPMI_OPEN_OPTION_ALL;
907 open_option[open_option_num].ival = 1;
910 #ifdef IPMI_OPEN_OPTION_USE_CACHE
911 // This option appeared in OpenIPMI-2.0.17
912 open_option[open_option_num].option = IPMI_OPEN_OPTION_USE_CACHE;
913 open_option[open_option_num].ival = 0; /* Disable SDR cache in local file */
918 * NOTE: Domain names must be unique. There is static `domains_list` common
919 * to all threads inside lib/domain.c and some ops are done by name.
921 status = ipmi_open_domain(
922 st->name, &st->connection, /* num_con = */ 1,
923 domain_connection_change_handler, /* user data = */ (void *)st,
924 /* domain_fully_up_handler = */ NULL, /* user data = */ NULL, open_option,
925 open_option_num, &domain_id);
927 c_ipmi_error(st, "ipmi_open_domain", status);
932 } /* int c_ipmi_thread_init */
934 static void *c_ipmi_thread_main(void *user_data) {
935 c_ipmi_instance_t *st = (c_ipmi_instance_t *)user_data;
937 int status = c_ipmi_thread_init(st);
939 ERROR("ipmi plugin: c_ipmi_thread_init failed.");
944 while (st->active != 0) {
945 struct timeval tv = {1, 0};
946 os_handler->perform_one_op(os_handler, &tv);
949 } /* void *c_ipmi_thread_main */
951 static c_ipmi_instance_t *c_ipmi_init_instance() {
952 c_ipmi_instance_t *st;
954 st = calloc(1, sizeof(*st));
956 ERROR("ipmi plugin: calloc failed.");
960 st->name = strdup("main");
961 if (st->name == NULL) {
963 ERROR("ipmi plugin: strdup() failed.");
967 st->ignorelist = ignorelist_create(/* invert = */ 1);
968 if (st->ignorelist == NULL) {
971 ERROR("ipmi plugin: ignorelist_create() failed.");
975 st->sensor_list = NULL;
976 pthread_mutex_init(&st->sensor_list_lock, /* attr = */ NULL);
982 st->authtype = IPMI_AUTHTYPE_DEFAULT;
987 } /* c_ipmi_instance_t *c_ipmi_init_instance */
989 static void c_ipmi_free_instance(c_ipmi_instance_t *st) {
993 assert(st->next == NULL);
1001 ignorelist_free(st->ignorelist);
1002 pthread_mutex_destroy(&st->sensor_list_lock);
1004 } /* void c_ipmi_free_instance */
1006 static void c_ipmi_add_instance(c_ipmi_instance_t *instance) {
1007 if (instances == NULL) {
1008 instances = instance;
1012 c_ipmi_instance_t *last = instances;
1014 while (last->next != NULL)
1017 last->next = instance;
1018 } /* void c_ipmi_add_instance */
1020 static int c_ipmi_config_add_instance(oconfig_item_t *ci) {
1022 c_ipmi_instance_t *st = c_ipmi_init_instance();
1026 if (strcasecmp(ci->key, "Instance") == 0)
1027 status = cf_util_get_string(ci, &st->name);
1030 c_ipmi_free_instance(st);
1034 for (int i = 0; i < ci->children_num; i++) {
1035 oconfig_item_t *child = ci->children + i;
1037 if (strcasecmp("Sensor", child->key) == 0)
1038 ignorelist_add(st->ignorelist, ci->values[0].value.string);
1039 else if (strcasecmp("IgnoreSelected", child->key) == 0) {
1041 status = cf_util_get_boolean(child, &t);
1045 ignorelist_set_invert(st->ignorelist, /* invert = */ 0);
1047 ignorelist_set_invert(st->ignorelist, /* invert = */ 1);
1048 } else if (strcasecmp("NotifyIPMIConnectionState", child->key) == 0) {
1049 status = cf_util_get_boolean(child, &st->notify_conn);
1050 } else if (strcasecmp("NotifySensorAdd", child->key) == 0) {
1051 status = cf_util_get_boolean(child, &st->notify_add);
1052 } else if (strcasecmp("NotifySensorRemove", child->key) == 0) {
1053 status = cf_util_get_boolean(child, &st->notify_remove);
1054 } else if (strcasecmp("NotifySensorNotPresent", child->key) == 0) {
1055 status = cf_util_get_boolean(child, &st->notify_notpresent);
1056 } else if (strcasecmp("SELEnabled", child->key) == 0) {
1057 status = cf_util_get_boolean(child, &st->sel_enabled);
1058 } else if (strcasecmp("SELClearEvent", child->key) == 0) {
1059 status = cf_util_get_boolean(child, &st->sel_clear_event);
1060 } else if (strcasecmp("Host", child->key) == 0)
1061 status = cf_util_get_string(child, &st->host);
1062 else if (strcasecmp("Address", child->key) == 0)
1063 status = cf_util_get_string(child, &st->connaddr);
1064 else if (strcasecmp("Username", child->key) == 0)
1065 status = cf_util_get_string(child, &st->username);
1066 else if (strcasecmp("Password", child->key) == 0)
1067 status = cf_util_get_string(child, &st->password);
1068 else if (strcasecmp("AuthType", child->key) == 0) {
1070 status = cf_util_get_string_buffer(child, tmp, sizeof(tmp));
1074 if (strcasecmp("MD5", tmp) == 0)
1075 st->authtype = IPMI_AUTHTYPE_MD5;
1076 else if (strcasecmp("rmcp+", tmp) == 0)
1077 st->authtype = IPMI_AUTHTYPE_RMCP_PLUS;
1079 WARNING("ipmi plugin: The value \"%s\" is not valid for the "
1080 "\"AuthType\" option.",
1083 WARNING("ipmi plugin: Option `%s' not allowed here.", child->key);
1092 c_ipmi_free_instance(st);
1096 c_ipmi_add_instance(st);
1099 } /* int c_ipmi_config_add_instance */
1101 static int c_ipmi_config(oconfig_item_t *ci) {
1102 _Bool have_instance_block = 0;
1104 for (int i = 0; i < ci->children_num; i++) {
1105 oconfig_item_t *child = ci->children + i;
1107 if (strcasecmp("Instance", child->key) == 0) {
1108 int status = c_ipmi_config_add_instance(child);
1112 have_instance_block = 1;
1113 } else if (!have_instance_block) {
1114 /* Non-instance option: Assume legacy configuration (without <Instance />
1115 * blocks) and call c_ipmi_config_add_instance with the <Plugin /> block.
1117 return c_ipmi_config_add_instance(ci);
1119 WARNING("ipmi plugin: The configuration option "
1120 "\"%s\" is not allowed here. Did you "
1121 "forget to add an <Instance /> block "
1122 "around the configuration?",
1124 } /* for (ci->children) */
1127 } /* int c_ipmi_config */
1129 static int c_ipmi_read(user_data_t *user_data) {
1130 c_ipmi_instance_t *st = user_data->data;
1132 if ((st->active == 0) || (st->thread_id == (pthread_t)0)) {
1133 INFO("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
1137 if (st->connected == 0)
1140 sensor_list_read_all(st);
1142 if (st->init_in_progress > 0)
1143 st->init_in_progress--;
1145 st->init_in_progress = 0;
1148 } /* int c_ipmi_read */
1150 static int c_ipmi_init(void) {
1152 c_ipmi_instance_t *st;
1153 char callback_name[3 * DATA_MAX_NAME_LEN];
1155 os_handler = ipmi_posix_thread_setup_os_handler(SIGIO);
1156 if (os_handler == NULL) {
1157 ERROR("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
1161 os_handler->set_log_handler(os_handler, c_ipmi_log);
1163 if (ipmi_init(os_handler) != 0) {
1164 ERROR("ipmi plugin: ipmi_init() failed.");
1165 os_handler->free_os_handler(os_handler);
1169 /* Don't send `ADD' notifications during startup (~ 1 minute) */
1170 time_t iv = CDTIME_T_TO_TIME_T(plugin_get_interval());
1172 if (instances == NULL) {
1173 /* No instances were configured, let's start a default instance. */
1174 st = c_ipmi_init_instance();
1178 c_ipmi_add_instance(st);
1182 while (NULL != st) {
1183 /* The `st->name` is used as "domain name" for ipmi_open_domain().
1184 * That value should be unique, so we do plugin_register_complex_read()
1185 * at first as it checks the uniqueness. */
1186 snprintf(callback_name, sizeof(callback_name), "ipmi/%s", st->name);
1192 status = plugin_register_complex_read(
1193 /* group = */ "ipmi",
1194 /* name = */ callback_name,
1195 /* callback = */ c_ipmi_read,
1197 /* user_data = */ &ud);
1205 st->init_in_progress = 1 + (60 / iv);
1208 status = plugin_thread_create(&st->thread_id, /* attr = */ NULL,
1210 /* user data = */ (void *)st, "ipmi");
1214 st->thread_id = (pthread_t)0;
1216 plugin_unregister_read(callback_name);
1218 ERROR("ipmi plugin: pthread_create failed for `%s`.", callback_name);
1225 } /* int c_ipmi_init */
1227 static int c_ipmi_shutdown(void) {
1228 c_ipmi_instance_t *st = instances;
1231 while (st != NULL) {
1232 c_ipmi_instance_t *next = st->next;
1237 if (st->thread_id != (pthread_t)0) {
1238 pthread_join(st->thread_id, NULL);
1239 st->thread_id = (pthread_t)0;
1242 sensor_list_remove_all(st);
1243 c_ipmi_free_instance(st);
1248 os_handler->free_os_handler(os_handler);
1251 } /* int c_ipmi_shutdown */
1253 void module_register(void) {
1254 plugin_register_complex_config("ipmi", c_ipmi_config);
1255 plugin_register_init("ipmi", c_ipmi_init);
1256 plugin_register_shutdown("ipmi", c_ipmi_shutdown);
1257 } /* void module_register */