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 char type_instance[DATA_MAX_NAME_LEN];
83 int sensor_not_present;
84 c_ipmi_sensor_list_t *next;
85 c_ipmi_instance_t *instance;
89 struct c_ipmi_db_type_map_s {
90 enum ipmi_unit_type_e type;
91 const char *type_name;
93 typedef struct c_ipmi_db_type_map_s c_ipmi_db_type_map_t;
96 * Module global variables
98 static os_handler_t *os_handler = NULL;
99 static c_ipmi_instance_t *instances = NULL;
102 * Misc private functions
104 static void c_ipmi_error(c_ipmi_instance_t *st, const char *func, int status) {
105 char errbuf[ERR_BUF_SIZE] = {0};
107 if (IPMI_IS_OS_ERR(status) || IPMI_IS_RMCPP_ERR(status) ||
108 IPMI_IS_IPMI_ERR(status)) {
109 ipmi_get_error_string(status, errbuf, sizeof(errbuf));
112 if (errbuf[0] == 0) {
113 snprintf(errbuf, sizeof(errbuf), "Unknown error %#x", status);
115 errbuf[sizeof(errbuf) - 1] = 0;
117 ERROR("ipmi plugin: %s failed for `%s`: %s", func, st->name, errbuf);
118 } /* void c_ipmi_error */
120 static void c_ipmi_log(os_handler_t *handler, const char *format,
121 enum ipmi_log_type_e log_type, va_list ap) {
122 char msg[ERR_BUF_SIZE];
124 vsnprintf(msg, sizeof(msg), format, ap);
128 INFO("ipmi plugin: %s", msg);
130 case IPMI_LOG_WARNING:
131 NOTICE("ipmi plugin: %s", msg);
133 case IPMI_LOG_SEVERE:
134 WARNING("ipmi plugin: %s", msg);
137 ERROR("ipmi plugin: %s", msg);
139 case IPMI_LOG_ERR_INFO:
140 ERROR("ipmi plugin: %s", msg);
143 case IPMI_LOG_DEBUG_START:
145 DEBUG("ipmi plugin: %s", msg);
147 case IPMI_LOG_DEBUG_CONT:
148 case IPMI_LOG_DEBUG_END:
152 case IPMI_LOG_DEBUG_START:
154 case IPMI_LOG_DEBUG_CONT:
155 case IPMI_LOG_DEBUG_END:
159 } /* void c_ipmi_log */
161 static notification_t c_ipmi_notification_init(c_ipmi_instance_t const *st,
163 notification_t n = {severity, cdtime(), "", "", "ipmi", "", "", "", NULL};
165 sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g, sizeof(n.host));
167 } /* notification_t c_ipmi_notification_init */
172 /* Prototype for sensor_list_remove, so sensor_read_handler can call it. */
173 static int sensor_list_remove(c_ipmi_instance_t *st, ipmi_sensor_t *sensor);
175 static void sensor_read_handler(ipmi_sensor_t *sensor, int err,
176 enum ipmi_value_present_e value_present,
177 unsigned int __attribute__((unused)) raw_value,
178 double value, ipmi_states_t *states,
180 value_list_t vl = VALUE_LIST_INIT;
182 c_ipmi_sensor_list_t *list_item = user_data;
183 c_ipmi_instance_t *st = list_item->instance;
188 if (IPMI_IS_IPMI_ERR(err) &&
189 IPMI_GET_IPMI_ERR(err) == IPMI_NOT_PRESENT_CC) {
190 if (list_item->sensor_not_present == 0) {
191 list_item->sensor_not_present = 1;
193 INFO("ipmi plugin: sensor_read_handler: sensor `%s` of `%s` "
195 list_item->sensor_name, st->name);
197 if (st->notify_notpresent) {
198 notification_t n = c_ipmi_notification_init(st, NOTIF_WARNING);
200 sstrncpy(n.type_instance, list_item->type_instance,
201 sizeof(n.type_instance));
202 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
203 snprintf(n.message, sizeof(n.message), "sensor %s not present",
204 list_item->sensor_name);
206 plugin_dispatch_notification(&n);
209 } else if (IPMI_IS_IPMI_ERR(err) &&
210 IPMI_GET_IPMI_ERR(err) ==
211 IPMI_NOT_SUPPORTED_IN_PRESENT_STATE_CC) {
212 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` not ready.",
213 list_item->sensor_name, st->name);
214 } else if (IPMI_IS_IPMI_ERR(err) &&
215 IPMI_GET_IPMI_ERR(err) == IPMI_TIMEOUT_CC) {
216 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` timed out.",
217 list_item->sensor_name, st->name);
219 char errbuf[ERR_BUF_SIZE] = {0};
220 ipmi_get_error_string(err, errbuf, sizeof(errbuf) - 1);
222 if (IPMI_IS_IPMI_ERR(err))
223 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
225 list_item->sensor_name, st->name, errbuf);
226 else if (IPMI_IS_OS_ERR(err))
227 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
229 list_item->sensor_name, st->name, errbuf, IPMI_GET_OS_ERR(err));
230 else if (IPMI_IS_RMCPP_ERR(err))
231 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
233 list_item->sensor_name, st->name, errbuf);
234 else if (IPMI_IS_SOL_ERR(err))
235 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
237 list_item->sensor_name, st->name, errbuf, IPMI_GET_SOL_ERR(err));
239 INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed "
240 "with error %#x. of class %#x",
241 list_item->sensor_name, st->name, err & 0xff, err & 0xffffff00);
244 } else if (list_item->sensor_not_present == 1) {
245 list_item->sensor_not_present = 0;
247 INFO("ipmi plugin: sensor_read_handler: sensor `%s` of `%s` present.",
248 list_item->sensor_name, st->name);
250 if (st->notify_notpresent) {
251 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
253 sstrncpy(n.type_instance, list_item->type_instance,
254 sizeof(n.type_instance));
255 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
256 snprintf(n.message, sizeof(n.message), "sensor %s present",
257 list_item->sensor_name);
259 plugin_dispatch_notification(&n);
263 if (value_present != IPMI_BOTH_VALUES_PRESENT) {
264 INFO("ipmi plugin: sensor_read_handler: Removing sensor `%s` of `%s`, "
265 "because it provides %s. If you need this sensor, "
266 "please file a bug report.",
267 list_item->sensor_name, st->name,
268 (value_present == IPMI_RAW_VALUE_PRESENT) ? "only the raw value"
270 sensor_list_remove(st, sensor);
274 if (!ipmi_is_sensor_scanning_enabled(states)) {
275 DEBUG("ipmi plugin: sensor_read_handler: Skipping sensor `%s` of `%s`, "
276 "it is in 'scanning disabled' state.",
277 list_item->sensor_name, st->name);
281 if (ipmi_is_initial_update_in_progress(states)) {
282 DEBUG("ipmi plugin: sensor_read_handler: Skipping sensor `%s` of `%s`, "
283 "it is in 'initial update in progress' state.",
284 list_item->sensor_name, st->name);
288 vl.values = &(value_t){.gauge = value};
291 if (st->host != NULL)
292 sstrncpy(vl.host, st->host, sizeof(vl.host));
293 sstrncpy(vl.plugin, "ipmi", sizeof(vl.plugin));
294 sstrncpy(vl.type, list_item->sensor_type, sizeof(vl.type));
295 sstrncpy(vl.type_instance, list_item->type_instance,
296 sizeof(vl.type_instance));
298 plugin_dispatch_values(&vl);
299 } /* void sensor_read_handler */
301 static void sensor_get_name(ipmi_sensor_t *sensor, char *buffer, int buf_len) {
302 char temp[DATA_MAX_NAME_LEN] = {0};
303 ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
304 const char *entity_id_string = ipmi_entity_get_entity_id_string(ent);
305 char sensor_name[DATA_MAX_NAME_LEN] = "";
306 char *sensor_name_ptr;
308 if ((buffer == NULL) || (buf_len == 0))
311 ipmi_sensor_get_name(sensor, temp, sizeof(temp));
312 temp[sizeof(temp) - 1] = 0;
314 if (entity_id_string != NULL && strlen(temp))
315 snprintf(sensor_name, sizeof(sensor_name), "%s %s", temp, entity_id_string);
316 else if (entity_id_string != NULL)
317 sstrncpy(sensor_name, entity_id_string, sizeof(sensor_name));
319 sstrncpy(sensor_name, temp, sizeof(sensor_name));
322 sstrncpy(temp, sensor_name, sizeof(temp));
323 sensor_name_ptr = strstr(temp, ").");
324 if (sensor_name_ptr != NULL) {
325 /* If name is something like "foo (123).bar",
326 * change that to "bar (123)".
327 * Both, sensor_name_ptr and sensor_id_ptr point to memory within the
328 * `temp' array, which holds a copy of the current `sensor_name'. */
331 /* `sensor_name_ptr' points to ").bar". */
332 sensor_name_ptr[1] = 0;
333 /* `temp' holds "foo (123)\0bar\0". */
334 sensor_name_ptr += 2;
335 /* `sensor_name_ptr' now points to "bar". */
337 sensor_id_ptr = strstr(temp, "(");
338 if (sensor_id_ptr != NULL) {
339 /* `sensor_id_ptr' now points to "(123)". */
340 snprintf(sensor_name, sizeof(sensor_name), "%s %s", sensor_name_ptr,
343 /* else: don't touch sensor_name. */
346 sstrncpy(buffer, sensor_name, buf_len);
349 static const char *sensor_unit_to_type(ipmi_sensor_t *sensor) {
350 static const c_ipmi_db_type_map_t ipmi_db_type_map[] = {
351 {IPMI_UNIT_TYPE_WATTS, "power"}, {IPMI_UNIT_TYPE_CFM, "flow"}};
353 /* check the modifier and rate of the sensor value */
354 if ((ipmi_sensor_get_modifier_unit_use(sensor) != IPMI_MODIFIER_UNIT_NONE) ||
355 (ipmi_sensor_get_rate_unit(sensor) != IPMI_RATE_UNIT_NONE))
358 /* find the db type by using sensor base unit type */
359 enum ipmi_unit_type_e ipmi_type = ipmi_sensor_get_base_unit(sensor);
360 for (int i = 0; i < STATIC_ARRAY_SIZE(ipmi_db_type_map); i++)
361 if (ipmi_db_type_map[i].type == ipmi_type)
362 return ipmi_db_type_map[i].type_name;
365 } /* const char* sensor_unit_to_type */
367 static int sensor_list_add(c_ipmi_instance_t *st, ipmi_sensor_t *sensor) {
368 ipmi_sensor_id_t sensor_id;
369 c_ipmi_sensor_list_t *list_item;
370 c_ipmi_sensor_list_t *list_prev;
372 char buffer[DATA_MAX_NAME_LEN] = {0};
373 char *sensor_name_ptr = buffer;
377 sensor_id = ipmi_sensor_convert_to_id(sensor);
378 sensor_get_name(sensor, buffer, sizeof(buffer));
380 DEBUG("ipmi plugin: sensor_list_add: Found sensor `%s` of `%s`,"
382 " Event reading type: %#x"
384 " Event support: %#x",
385 sensor_name_ptr, st->name, ipmi_sensor_get_sensor_type(sensor),
386 ipmi_sensor_get_event_reading_type(sensor),
387 ipmi_sensor_get_sensor_direction(sensor),
388 ipmi_sensor_get_event_support(sensor));
390 /* Both `ignorelist' and `sensor_name_ptr' may be NULL. */
391 if (ignorelist_match(st->ignorelist, sensor_name_ptr) != 0)
394 /* FIXME: Use rate unit or base unit to scale the value */
396 sensor_type = ipmi_sensor_get_sensor_type(sensor);
399 * ipmitool/lib/ipmi_sdr.c sdr_sensor_has_analog_reading() has a notice
400 * about 'Threshold sensors' and 'analog readings'. Discrete sensor may
401 * have analog data, but discrete sensors support is not implemented
404 * ipmi_sensor_id_get_reading() supports only 'Threshold' sensors.
405 * See lib/sensor.c:4842, stand_ipmi_sensor_get_reading() for details.
407 if (!ipmi_sensor_get_is_readable(sensor)) {
408 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
409 "because it isn't readable! Its type: (%#x, %s). ",
410 sensor_name_ptr, st->name, sensor_type,
411 ipmi_sensor_get_sensor_type_string(sensor));
415 if (ipmi_sensor_get_event_reading_type(sensor) !=
416 IPMI_EVENT_READING_TYPE_THRESHOLD) {
417 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
418 "because it is discrete (%#x)! Its type: (%#x, %s). ",
419 sensor_name_ptr, st->name, sensor_type,
420 ipmi_sensor_get_event_reading_type(sensor),
421 ipmi_sensor_get_sensor_type_string(sensor));
425 switch (sensor_type) {
426 case IPMI_SENSOR_TYPE_TEMPERATURE:
427 type = "temperature";
430 case IPMI_SENSOR_TYPE_VOLTAGE:
434 case IPMI_SENSOR_TYPE_CURRENT:
438 case IPMI_SENSOR_TYPE_FAN:
442 case IPMI_SENSOR_TYPE_MEMORY:
447 /* try to get collectd DB type based on sensor base unit type */
448 if ((type = sensor_unit_to_type(sensor)) != NULL)
451 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
452 "because I don't know how to handle its type (%#x, %s). "
453 "If you need this sensor, please file a bug report.",
454 sensor_name_ptr, st->name, sensor_type,
455 ipmi_sensor_get_sensor_type_string(sensor));
458 } /* switch (sensor_type) */
460 pthread_mutex_lock(&st->sensor_list_lock);
463 for (list_item = st->sensor_list; list_item != NULL;
464 list_item = list_item->next) {
465 if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
467 list_prev = list_item;
468 } /* for (list_item) */
470 if (list_item != NULL) {
471 pthread_mutex_unlock(&st->sensor_list_lock);
475 list_item = (c_ipmi_sensor_list_t *)calloc(1, sizeof(c_ipmi_sensor_list_t));
476 if (list_item == NULL) {
477 pthread_mutex_unlock(&st->sensor_list_lock);
481 list_item->instance = st;
482 list_item->sensor_id = ipmi_sensor_convert_to_id(sensor);
484 if (list_prev != NULL)
485 list_prev->next = list_item;
487 st->sensor_list = list_item;
489 /* if sensor provides the percentage value, use "percent" collectd type
490 and add the `percent` to the type instance of the reported value */
491 if (ipmi_sensor_get_percentage(sensor)) {
492 snprintf(list_item->type_instance, sizeof(list_item->type_instance),
493 "percent-%s", sensor_name_ptr);
496 /* use type instance as a name of the sensor */
497 sstrncpy(list_item->type_instance, sensor_name_ptr,
498 sizeof(list_item->type_instance));
501 sstrncpy(list_item->sensor_name, sensor_name_ptr,
502 sizeof(list_item->sensor_name));
503 sstrncpy(list_item->sensor_type, type, sizeof(list_item->sensor_type));
505 pthread_mutex_unlock(&st->sensor_list_lock);
507 if (st->notify_add && (st->init_in_progress == 0)) {
508 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
510 sstrncpy(n.type_instance, list_item->type_instance,
511 sizeof(n.type_instance));
512 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
513 snprintf(n.message, sizeof(n.message), "sensor %s added",
514 list_item->sensor_name);
516 plugin_dispatch_notification(&n);
520 } /* int sensor_list_add */
522 static int sensor_list_remove(c_ipmi_instance_t *st, ipmi_sensor_t *sensor) {
523 ipmi_sensor_id_t sensor_id;
524 c_ipmi_sensor_list_t *list_item;
525 c_ipmi_sensor_list_t *list_prev;
527 sensor_id = ipmi_sensor_convert_to_id(sensor);
529 pthread_mutex_lock(&st->sensor_list_lock);
532 for (list_item = st->sensor_list; list_item != NULL;
533 list_item = list_item->next) {
534 if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
536 list_prev = list_item;
537 } /* for (list_item) */
539 if (list_item == NULL) {
540 pthread_mutex_unlock(&st->sensor_list_lock);
544 if (list_prev == NULL)
545 st->sensor_list = list_item->next;
547 list_prev->next = list_item->next;
550 list_item->next = NULL;
552 pthread_mutex_unlock(&st->sensor_list_lock);
554 if (st->notify_remove && st->active) {
555 notification_t n = c_ipmi_notification_init(st, NOTIF_WARNING);
557 sstrncpy(n.type_instance, list_item->type_instance,
558 sizeof(n.type_instance));
559 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
560 snprintf(n.message, sizeof(n.message), "sensor %s removed",
561 list_item->sensor_name);
563 plugin_dispatch_notification(&n);
568 } /* int sensor_list_remove */
570 static int sensor_list_read_all(c_ipmi_instance_t *st) {
571 pthread_mutex_lock(&st->sensor_list_lock);
573 for (c_ipmi_sensor_list_t *list_item = st->sensor_list; list_item != NULL;
574 list_item = list_item->next) {
575 DEBUG("ipmi plugin: try read sensor `%s` of `%s`, use: %d",
576 list_item->sensor_name, st->name, list_item->use);
578 /* Reading already initiated */
583 ipmi_sensor_id_get_reading(list_item->sensor_id, sensor_read_handler,
584 /* user data = */ (void *)list_item);
585 } /* for (list_item) */
587 pthread_mutex_unlock(&st->sensor_list_lock);
590 } /* int sensor_list_read_all */
592 static int sensor_list_remove_all(c_ipmi_instance_t *st) {
593 c_ipmi_sensor_list_t *list_item;
595 pthread_mutex_lock(&st->sensor_list_lock);
597 list_item = st->sensor_list;
598 st->sensor_list = NULL;
600 pthread_mutex_unlock(&st->sensor_list_lock);
602 while (list_item != NULL) {
603 c_ipmi_sensor_list_t *list_next = list_item->next;
607 list_item = list_next;
608 } /* while (list_item) */
611 } /* int sensor_list_remove_all */
613 static int sensor_convert_threshold_severity(enum ipmi_thresh_e severity) {
615 case IPMI_LOWER_NON_CRITICAL:
616 case IPMI_UPPER_NON_CRITICAL:
618 case IPMI_LOWER_CRITICAL:
619 case IPMI_UPPER_CRITICAL:
620 return NOTIF_WARNING;
621 case IPMI_LOWER_NON_RECOVERABLE:
622 case IPMI_UPPER_NON_RECOVERABLE:
623 return NOTIF_FAILURE;
626 } /* switch (severity) */
627 } /* int sensor_convert_threshold_severity */
629 static void add_event_common_data(notification_t *n, ipmi_sensor_t *sensor,
630 enum ipmi_event_dir_e dir,
631 ipmi_event_t *event) {
632 ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
634 plugin_notification_meta_add_string(n, "entity_name",
635 ipmi_entity_get_entity_id_string(ent));
636 plugin_notification_meta_add_signed_int(n, "entity_id",
637 ipmi_entity_get_entity_id(ent));
638 plugin_notification_meta_add_signed_int(n, "entity_instance",
639 ipmi_entity_get_entity_instance(ent));
640 plugin_notification_meta_add_boolean(n, "assert", dir == IPMI_ASSERTION);
643 plugin_notification_meta_add_signed_int(n, "event_type",
644 ipmi_event_get_type(event));
645 } /* void add_event_sensor_meta_data */
647 static int sensor_threshold_event_handler(
648 ipmi_sensor_t *sensor, enum ipmi_event_dir_e dir,
649 enum ipmi_thresh_e threshold, enum ipmi_event_value_dir_e high_low,
650 enum ipmi_value_present_e value_present, unsigned int raw_value,
651 double value, void *cb_data, ipmi_event_t *event) {
653 c_ipmi_instance_t *st = cb_data;
655 /* From the IPMI specification Chapter 2: Events.
656 * If a callback handles the event, then all future callbacks called due to
657 * the event will receive a NULL for the event. So be ready to handle a NULL
658 * event in all your event handlers. A NULL may also be passed to an event
659 * handler if the callback was not due to an event. */
661 return IPMI_EVENT_NOT_HANDLED;
663 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
664 /* offset is a table index and it's represented as enum of strings that are
665 organized in the way - high and low for each threshold severity level */
666 unsigned int offset = (2 * threshold) + high_low;
667 unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
668 unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
669 const char *event_state =
670 ipmi_get_reading_name(event_type, sensor_type, offset);
671 sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
672 if (value_present != IPMI_NO_VALUES_PRESENT)
673 snprintf(n.message, sizeof(n.message),
674 "sensor %s received event: %s, value is %f", n.type_instance,
677 snprintf(n.message, sizeof(n.message),
678 "sensor %s received event: %s, value not provided",
679 n.type_instance, event_state);
681 DEBUG("Threshold event received for sensor %s", n.type_instance);
683 sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
684 n.severity = sensor_convert_threshold_severity(threshold);
685 n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
687 plugin_notification_meta_add_string(&n, "severity",
688 ipmi_get_threshold_string(threshold));
689 plugin_notification_meta_add_string(&n, "direction",
690 ipmi_get_value_dir_string(high_low));
692 switch (value_present) {
693 case IPMI_BOTH_VALUES_PRESENT:
694 plugin_notification_meta_add_double(&n, "val", value);
695 /* both values present, so fall-through to add raw value too */
696 case IPMI_RAW_VALUE_PRESENT: {
697 char buf[DATA_MAX_NAME_LEN] = {0};
698 snprintf(buf, sizeof(buf), "0x%2.2x", raw_value);
699 plugin_notification_meta_add_string(&n, "raw", buf);
703 } /* switch (value_present) */
705 add_event_common_data(&n, sensor, dir, event);
707 plugin_dispatch_notification(&n);
708 plugin_notification_meta_free(n.meta);
710 /* Delete handled ipmi event from the list */
711 if (st->sel_clear_event) {
712 ipmi_event_delete(event, NULL, NULL);
713 return IPMI_EVENT_HANDLED;
716 return IPMI_EVENT_NOT_HANDLED;
717 } /* int sensor_threshold_event_handler */
719 static int sensor_discrete_event_handler(ipmi_sensor_t *sensor,
720 enum ipmi_event_dir_e dir, int offset,
721 int severity, int prev_severity,
722 void *cb_data, ipmi_event_t *event) {
724 c_ipmi_instance_t *st = cb_data;
726 /* From the IPMI specification Chapter 2: Events.
727 * If a callback handles the event, then all future callbacks called due to
728 * the event will receive a NULL for the event. So be ready to handle a NULL
729 * event in all your event handlers. A NULL may also be passed to an event
730 * handler if the callback was not due to an event. */
732 return IPMI_EVENT_NOT_HANDLED;
734 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
735 unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
736 unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
737 const char *event_state =
738 ipmi_get_reading_name(event_type, sensor_type, offset);
739 sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
740 snprintf(n.message, sizeof(n.message), "sensor %s received event: %s",
741 n.type_instance, event_state);
743 DEBUG("Discrete event received for sensor %s", n.type_instance);
745 sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
746 n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
748 plugin_notification_meta_add_signed_int(&n, "offset", offset);
751 plugin_notification_meta_add_signed_int(&n, "severity", severity);
753 if (prev_severity != -1)
754 plugin_notification_meta_add_signed_int(&n, "prevseverity", prev_severity);
756 add_event_common_data(&n, sensor, dir, event);
758 plugin_dispatch_notification(&n);
759 plugin_notification_meta_free(n.meta);
761 /* Delete handled ipmi event from the list */
762 if (st->sel_clear_event) {
763 ipmi_event_delete(event, NULL, NULL);
764 return IPMI_EVENT_HANDLED;
767 return IPMI_EVENT_NOT_HANDLED;
768 } /* int sensor_discrete_event_handler */
774 entity_sensor_update_handler(enum ipmi_update_e op,
775 ipmi_entity_t __attribute__((unused)) * entity,
776 ipmi_sensor_t *sensor, void *user_data) {
777 c_ipmi_instance_t *st = user_data;
779 if ((op == IPMI_ADDED) || (op == IPMI_CHANGED)) {
780 /* Will check for duplicate entries.. */
781 sensor_list_add(st, sensor);
783 if (st->sel_enabled) {
785 /* register threshold event if threshold sensor support events */
786 if ((ipmi_sensor_get_event_reading_type(sensor) ==
787 IPMI_EVENT_READING_TYPE_THRESHOLD) &&
788 (ipmi_sensor_get_threshold_access(sensor) !=
789 IPMI_THRESHOLD_ACCESS_SUPPORT_NONE))
790 status = ipmi_sensor_add_threshold_event_handler(
791 sensor, sensor_threshold_event_handler, st);
792 /* register discrete handler if discrete/specific sensor support events */
793 else if (ipmi_sensor_get_event_support(sensor) != IPMI_EVENT_SUPPORT_NONE)
794 status = ipmi_sensor_add_discrete_event_handler(
795 sensor, sensor_discrete_event_handler, st);
798 char buf[DATA_MAX_NAME_LEN] = {0};
799 sensor_get_name(sensor, buf, sizeof(buf));
800 ERROR("Unable to add sensor %s event handler, status: %d", buf, status);
803 } else if (op == IPMI_DELETED) {
804 sensor_list_remove(st, sensor);
806 if (st->sel_enabled) {
807 if (ipmi_sensor_get_event_reading_type(sensor) ==
808 IPMI_EVENT_READING_TYPE_THRESHOLD)
809 ipmi_sensor_remove_threshold_event_handler(
810 sensor, sensor_threshold_event_handler, st);
812 ipmi_sensor_remove_discrete_event_handler(
813 sensor, sensor_discrete_event_handler, st);
816 } /* void entity_sensor_update_handler */
822 domain_entity_update_handler(enum ipmi_update_e op,
823 ipmi_domain_t __attribute__((unused)) * domain,
824 ipmi_entity_t *entity, void *user_data) {
826 c_ipmi_instance_t *st = user_data;
828 if (op == IPMI_ADDED) {
829 status = ipmi_entity_add_sensor_update_handler(
830 entity, entity_sensor_update_handler, /* user data = */ (void *)st);
832 c_ipmi_error(st, "ipmi_entity_add_sensor_update_handler", status);
834 } else if (op == IPMI_DELETED) {
835 status = ipmi_entity_remove_sensor_update_handler(
836 entity, entity_sensor_update_handler, /* user data = */ (void *)st);
838 c_ipmi_error(st, "ipmi_entity_remove_sensor_update_handler", status);
841 } /* void domain_entity_update_handler */
843 static void smi_event_handler(ipmi_con_t __attribute__((unused)) * ipmi,
844 const ipmi_addr_t __attribute__((unused)) * addr,
845 unsigned int __attribute__((unused)) addr_len,
846 ipmi_event_t *event, void *cb_data) {
847 unsigned int type = ipmi_event_get_type(event);
848 ipmi_domain_t *domain = cb_data;
850 DEBUG("%s: Event received: type %u", __FUNCTION__, type);
853 /* It's not a standard IPMI event. */
856 /* force domain to reread SELs */
857 ipmi_domain_reread_sels(domain, NULL, NULL);
860 static void domain_connection_change_handler(ipmi_domain_t *domain, int err,
861 unsigned int conn_num,
862 unsigned int port_num,
866 DEBUG("domain_connection_change_handler (domain = %p, err = %i, "
867 "conn_num = %u, port_num = %u, still_connected = %i, "
869 (void *)domain, err, conn_num, port_num, still_connected, user_data);
871 c_ipmi_instance_t *st = user_data;
874 c_ipmi_error(st, "domain_connection_change_handler", err);
876 if (!still_connected) {
878 if (st->notify_conn && st->connected && st->init_in_progress == 0) {
879 notification_t n = c_ipmi_notification_init(st, NOTIF_FAILURE);
881 sstrncpy(n.message, "IPMI connection lost", sizeof(n.plugin));
883 plugin_dispatch_notification(&n);
890 if (st->notify_conn && !st->connected && st->init_in_progress == 0) {
891 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
893 sstrncpy(n.message, "IPMI connection restored", sizeof(n.plugin));
895 plugin_dispatch_notification(&n);
900 int status = ipmi_domain_add_entity_update_handler(
901 domain, domain_entity_update_handler, /* user data = */ st);
903 c_ipmi_error(st, "ipmi_domain_add_entity_update_handler", status);
906 status = st->connection->add_event_handler(st->connection, smi_event_handler,
910 c_ipmi_error(st, "Failed to register smi event handler", status);
911 } /* void domain_connection_change_handler */
913 static int c_ipmi_thread_init(c_ipmi_instance_t *st) {
914 ipmi_domain_id_t domain_id;
917 if (st->connaddr != NULL) {
918 status = ipmi_ip_setup_con(
919 &st->connaddr, &(char *){IPMI_LAN_STD_PORT_STR}, 1, st->authtype,
920 (unsigned int)IPMI_PRIVILEGE_USER, st->username, strlen(st->username),
921 st->password, strlen(st->password), os_handler,
922 /* user data = */ NULL, &st->connection);
924 c_ipmi_error(st, "ipmi_ip_setup_con", status);
928 status = ipmi_smi_setup_con(/* if_num = */ 0, os_handler,
929 /* user data = */ NULL, &st->connection);
931 c_ipmi_error(st, "ipmi_smi_setup_con", status);
936 ipmi_open_option_t opts[] = {
937 {.option = IPMI_OPEN_OPTION_ALL, {.ival = 1}},
938 #ifdef IPMI_OPEN_OPTION_USE_CACHE
939 /* OpenIPMI-2.0.17 and later: Disable SDR cache in local file */
940 {.option = IPMI_OPEN_OPTION_USE_CACHE, {.ival = 0}},
945 * NOTE: Domain names must be unique. There is static `domains_list` common
946 * to all threads inside lib/domain.c and some ops are done by name.
948 status = ipmi_open_domain(
949 st->name, &st->connection, /* num_con = */ 1,
950 domain_connection_change_handler, /* user data = */ (void *)st,
951 /* domain_fully_up_handler = */ NULL, /* user data = */ NULL, opts,
952 STATIC_ARRAY_SIZE(opts), &domain_id);
954 c_ipmi_error(st, "ipmi_open_domain", status);
959 } /* int c_ipmi_thread_init */
961 static void *c_ipmi_thread_main(void *user_data) {
962 c_ipmi_instance_t *st = user_data;
964 int status = c_ipmi_thread_init(st);
966 ERROR("ipmi plugin: c_ipmi_thread_init failed.");
971 while (st->active != 0) {
972 struct timeval tv = {1, 0};
973 os_handler->perform_one_op(os_handler, &tv);
976 } /* void *c_ipmi_thread_main */
978 static c_ipmi_instance_t *c_ipmi_init_instance() {
979 c_ipmi_instance_t *st;
981 st = calloc(1, sizeof(*st));
983 ERROR("ipmi plugin: calloc failed.");
987 st->name = strdup("main");
988 if (st->name == NULL) {
990 ERROR("ipmi plugin: strdup() failed.");
994 st->ignorelist = ignorelist_create(/* invert = */ 1);
995 if (st->ignorelist == NULL) {
998 ERROR("ipmi plugin: ignorelist_create() failed.");
1002 st->sensor_list = NULL;
1003 pthread_mutex_init(&st->sensor_list_lock, /* attr = */ NULL);
1006 st->connaddr = NULL;
1007 st->username = NULL;
1008 st->password = NULL;
1009 st->authtype = IPMI_AUTHTYPE_DEFAULT;
1014 } /* c_ipmi_instance_t *c_ipmi_init_instance */
1016 static void c_ipmi_free_instance(c_ipmi_instance_t *st) {
1020 assert(st->next == NULL);
1024 sfree(st->connaddr);
1025 sfree(st->username);
1026 sfree(st->password);
1028 ignorelist_free(st->ignorelist);
1029 pthread_mutex_destroy(&st->sensor_list_lock);
1031 } /* void c_ipmi_free_instance */
1033 static void c_ipmi_add_instance(c_ipmi_instance_t *instance) {
1034 if (instances == NULL) {
1035 instances = instance;
1039 c_ipmi_instance_t *last = instances;
1041 while (last->next != NULL)
1044 last->next = instance;
1045 } /* void c_ipmi_add_instance */
1047 static int c_ipmi_config_add_instance(oconfig_item_t *ci) {
1049 c_ipmi_instance_t *st = c_ipmi_init_instance();
1053 if (strcasecmp(ci->key, "Instance") == 0)
1054 status = cf_util_get_string(ci, &st->name);
1057 c_ipmi_free_instance(st);
1061 for (int i = 0; i < ci->children_num; i++) {
1062 oconfig_item_t *child = ci->children + i;
1064 if (strcasecmp("Sensor", child->key) == 0)
1065 ignorelist_add(st->ignorelist, ci->values[0].value.string);
1066 else if (strcasecmp("IgnoreSelected", child->key) == 0) {
1068 status = cf_util_get_boolean(child, &t);
1071 ignorelist_set_invert(st->ignorelist, /* invert = */ !t);
1072 } else if (strcasecmp("NotifyIPMIConnectionState", child->key) == 0) {
1073 status = cf_util_get_boolean(child, &st->notify_conn);
1074 } else if (strcasecmp("NotifySensorAdd", child->key) == 0) {
1075 status = cf_util_get_boolean(child, &st->notify_add);
1076 } else if (strcasecmp("NotifySensorRemove", child->key) == 0) {
1077 status = cf_util_get_boolean(child, &st->notify_remove);
1078 } else if (strcasecmp("NotifySensorNotPresent", child->key) == 0) {
1079 status = cf_util_get_boolean(child, &st->notify_notpresent);
1080 } else if (strcasecmp("SELEnabled", child->key) == 0) {
1081 status = cf_util_get_boolean(child, &st->sel_enabled);
1082 } else if (strcasecmp("SELClearEvent", child->key) == 0) {
1083 status = cf_util_get_boolean(child, &st->sel_clear_event);
1084 } else if (strcasecmp("Host", child->key) == 0)
1085 status = cf_util_get_string(child, &st->host);
1086 else if (strcasecmp("Address", child->key) == 0)
1087 status = cf_util_get_string(child, &st->connaddr);
1088 else if (strcasecmp("Username", child->key) == 0)
1089 status = cf_util_get_string(child, &st->username);
1090 else if (strcasecmp("Password", child->key) == 0)
1091 status = cf_util_get_string(child, &st->password);
1092 else if (strcasecmp("AuthType", child->key) == 0) {
1094 status = cf_util_get_string_buffer(child, tmp, sizeof(tmp));
1098 if (strcasecmp("MD5", tmp) == 0)
1099 st->authtype = IPMI_AUTHTYPE_MD5;
1100 else if (strcasecmp("rmcp+", tmp) == 0)
1101 st->authtype = IPMI_AUTHTYPE_RMCP_PLUS;
1103 WARNING("ipmi plugin: The value \"%s\" is not valid for the "
1104 "\"AuthType\" option.",
1107 WARNING("ipmi plugin: Option `%s' not allowed here.", child->key);
1116 c_ipmi_free_instance(st);
1120 c_ipmi_add_instance(st);
1123 } /* int c_ipmi_config_add_instance */
1125 static int c_ipmi_config(oconfig_item_t *ci) {
1126 _Bool have_instance_block = 0;
1128 for (int i = 0; i < ci->children_num; i++) {
1129 oconfig_item_t *child = ci->children + i;
1131 if (strcasecmp("Instance", child->key) == 0) {
1132 int status = c_ipmi_config_add_instance(child);
1136 have_instance_block = 1;
1137 } else if (!have_instance_block) {
1138 /* Non-instance option: Assume legacy configuration (without <Instance />
1139 * blocks) and call c_ipmi_config_add_instance with the <Plugin /> block.
1141 WARNING("ipmi plugin: Legacy configuration found! Please update your "
1143 return c_ipmi_config_add_instance(ci);
1145 WARNING("ipmi plugin: The configuration option "
1146 "\"%s\" is not allowed here. Did you "
1147 "forget to add an <Instance /> block "
1148 "around the configuration?",
1152 } /* for (ci->children) */
1155 } /* int c_ipmi_config */
1157 static int c_ipmi_read(user_data_t *user_data) {
1158 c_ipmi_instance_t *st = user_data->data;
1160 if (st->active == 0) {
1161 INFO("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
1165 if (st->connected == 0)
1168 sensor_list_read_all(st);
1170 if (st->init_in_progress > 0)
1171 st->init_in_progress--;
1173 st->init_in_progress = 0;
1176 } /* int c_ipmi_read */
1178 static int c_ipmi_init(void) {
1179 c_ipmi_instance_t *st;
1180 char callback_name[3 * DATA_MAX_NAME_LEN];
1182 if (os_handler != NULL) {
1186 os_handler = ipmi_posix_thread_setup_os_handler(SIGIO);
1187 if (os_handler == NULL) {
1188 ERROR("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
1192 os_handler->set_log_handler(os_handler, c_ipmi_log);
1194 if (ipmi_init(os_handler) != 0) {
1195 ERROR("ipmi plugin: ipmi_init() failed.");
1196 os_handler->free_os_handler(os_handler);
1200 if (instances == NULL) {
1201 /* No instances were configured, let's start a default instance. */
1202 st = c_ipmi_init_instance();
1206 c_ipmi_add_instance(st);
1209 /* Don't send `ADD' notifications during startup (~ 1 minute) */
1210 int cycles = 1 + (60 / CDTIME_T_TO_TIME_T(plugin_get_interval()));
1213 while (NULL != st) {
1214 /* The `st->name` is used as "domain name" for ipmi_open_domain().
1215 * That value should be unique, so we do plugin_register_complex_read()
1216 * at first as it checks the uniqueness. */
1217 snprintf(callback_name, sizeof(callback_name), "ipmi/%s", st->name);
1223 int status = plugin_register_complex_read(
1224 /* group = */ "ipmi",
1225 /* name = */ callback_name,
1226 /* callback = */ c_ipmi_read,
1228 /* user_data = */ &ud);
1235 st->init_in_progress = cycles;
1238 status = plugin_thread_create(&st->thread_id, /* attr = */ NULL,
1240 /* user data = */ (void *)st, "ipmi");
1244 st->thread_id = (pthread_t){0};
1246 plugin_unregister_read(callback_name);
1248 ERROR("ipmi plugin: pthread_create failed for `%s`.", callback_name);
1255 } /* int c_ipmi_init */
1257 static int c_ipmi_shutdown(void) {
1258 c_ipmi_instance_t *st = instances;
1261 while (st != NULL) {
1262 c_ipmi_instance_t *next = st->next;
1267 if (!pthread_equal(st->thread_id, (pthread_t){0})) {
1268 pthread_join(st->thread_id, NULL);
1269 st->thread_id = (pthread_t){0};
1272 sensor_list_remove_all(st);
1273 c_ipmi_free_instance(st);
1278 os_handler->free_os_handler(os_handler);
1282 } /* int c_ipmi_shutdown */
1284 void module_register(void) {
1285 plugin_register_complex_config("ipmi", c_ipmi_config);
1286 plugin_register_init("ipmi", c_ipmi_init);
1287 plugin_register_shutdown("ipmi", c_ipmi_shutdown);
1288 } /* void module_register */