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) {
392 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
393 "because it is on ignore list.",
394 sensor_name_ptr, st->name);
398 /* FIXME: Use rate unit or base unit to scale the value */
400 sensor_type = ipmi_sensor_get_sensor_type(sensor);
403 * ipmitool/lib/ipmi_sdr.c sdr_sensor_has_analog_reading() has a notice
404 * about 'Threshold sensors' and 'analog readings'. Discrete sensor may
405 * have analog data, but discrete sensors support is not implemented
408 * ipmi_sensor_id_get_reading() supports only 'Threshold' sensors.
409 * See lib/sensor.c:4842, stand_ipmi_sensor_get_reading() for details.
411 if (!ipmi_sensor_get_is_readable(sensor)) {
412 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
413 "because it isn't readable! Its type: (%#x, %s). ",
414 sensor_name_ptr, st->name, sensor_type,
415 ipmi_sensor_get_sensor_type_string(sensor));
419 if (ipmi_sensor_get_event_reading_type(sensor) !=
420 IPMI_EVENT_READING_TYPE_THRESHOLD) {
421 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
422 "because it is discrete (%#x)! Its type: (%#x, %s). ",
423 sensor_name_ptr, st->name, sensor_type,
424 ipmi_sensor_get_event_reading_type(sensor),
425 ipmi_sensor_get_sensor_type_string(sensor));
429 switch (sensor_type) {
430 case IPMI_SENSOR_TYPE_TEMPERATURE:
431 type = "temperature";
434 case IPMI_SENSOR_TYPE_VOLTAGE:
438 case IPMI_SENSOR_TYPE_CURRENT:
442 case IPMI_SENSOR_TYPE_FAN:
446 case IPMI_SENSOR_TYPE_MEMORY:
451 /* try to get collectd DB type based on sensor base unit type */
452 if ((type = sensor_unit_to_type(sensor)) != NULL)
455 INFO("ipmi plugin: sensor_list_add: Ignore sensor `%s` of `%s`, "
456 "because I don't know how to handle its units (%#x, %#x, %#x). "
457 "Sensor type: (%#x, %s). If you need this sensor, please file "
458 "a bug report at http://collectd.org/.",
459 sensor_name_ptr, st->name, ipmi_sensor_get_base_unit(sensor),
460 ipmi_sensor_get_modifier_unit(sensor),
461 ipmi_sensor_get_rate_unit(sensor), sensor_type,
462 ipmi_sensor_get_sensor_type_string(sensor));
465 } /* switch (sensor_type) */
467 pthread_mutex_lock(&st->sensor_list_lock);
470 for (list_item = st->sensor_list; list_item != NULL;
471 list_item = list_item->next) {
472 if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
474 list_prev = list_item;
475 } /* for (list_item) */
477 if (list_item != NULL) {
478 pthread_mutex_unlock(&st->sensor_list_lock);
482 list_item = (c_ipmi_sensor_list_t *)calloc(1, sizeof(c_ipmi_sensor_list_t));
483 if (list_item == NULL) {
484 pthread_mutex_unlock(&st->sensor_list_lock);
488 list_item->instance = st;
489 list_item->sensor_id = ipmi_sensor_convert_to_id(sensor);
491 if (list_prev != NULL)
492 list_prev->next = list_item;
494 st->sensor_list = list_item;
496 /* if sensor provides the percentage value, use "percent" collectd type
497 and add the `percent` to the type instance of the reported value */
498 if (ipmi_sensor_get_percentage(sensor)) {
499 snprintf(list_item->type_instance, sizeof(list_item->type_instance),
500 "percent-%s", sensor_name_ptr);
503 /* use type instance as a name of the sensor */
504 sstrncpy(list_item->type_instance, sensor_name_ptr,
505 sizeof(list_item->type_instance));
508 sstrncpy(list_item->sensor_name, sensor_name_ptr,
509 sizeof(list_item->sensor_name));
510 sstrncpy(list_item->sensor_type, type, sizeof(list_item->sensor_type));
512 pthread_mutex_unlock(&st->sensor_list_lock);
514 if (st->notify_add && (st->init_in_progress == 0)) {
515 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
517 sstrncpy(n.type_instance, list_item->type_instance,
518 sizeof(n.type_instance));
519 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
520 snprintf(n.message, sizeof(n.message), "sensor %s added",
521 list_item->sensor_name);
523 plugin_dispatch_notification(&n);
527 } /* int sensor_list_add */
529 static int sensor_list_remove(c_ipmi_instance_t *st, ipmi_sensor_t *sensor) {
530 ipmi_sensor_id_t sensor_id;
531 c_ipmi_sensor_list_t *list_item;
532 c_ipmi_sensor_list_t *list_prev;
534 sensor_id = ipmi_sensor_convert_to_id(sensor);
536 pthread_mutex_lock(&st->sensor_list_lock);
539 for (list_item = st->sensor_list; list_item != NULL;
540 list_item = list_item->next) {
541 if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
543 list_prev = list_item;
544 } /* for (list_item) */
546 if (list_item == NULL) {
547 pthread_mutex_unlock(&st->sensor_list_lock);
551 if (list_prev == NULL)
552 st->sensor_list = list_item->next;
554 list_prev->next = list_item->next;
557 list_item->next = NULL;
559 pthread_mutex_unlock(&st->sensor_list_lock);
561 if (st->notify_remove && st->active) {
562 notification_t n = c_ipmi_notification_init(st, NOTIF_WARNING);
564 sstrncpy(n.type_instance, list_item->type_instance,
565 sizeof(n.type_instance));
566 sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
567 snprintf(n.message, sizeof(n.message), "sensor %s removed",
568 list_item->sensor_name);
570 plugin_dispatch_notification(&n);
575 } /* int sensor_list_remove */
577 static int sensor_list_read_all(c_ipmi_instance_t *st) {
578 pthread_mutex_lock(&st->sensor_list_lock);
580 for (c_ipmi_sensor_list_t *list_item = st->sensor_list; list_item != NULL;
581 list_item = list_item->next) {
582 DEBUG("ipmi plugin: try read sensor `%s` of `%s`, use: %d",
583 list_item->sensor_name, st->name, list_item->use);
585 /* Reading already initiated */
590 ipmi_sensor_id_get_reading(list_item->sensor_id, sensor_read_handler,
591 /* user data = */ (void *)list_item);
592 } /* for (list_item) */
594 pthread_mutex_unlock(&st->sensor_list_lock);
597 } /* int sensor_list_read_all */
599 static int sensor_list_remove_all(c_ipmi_instance_t *st) {
600 c_ipmi_sensor_list_t *list_item;
602 pthread_mutex_lock(&st->sensor_list_lock);
604 list_item = st->sensor_list;
605 st->sensor_list = NULL;
607 pthread_mutex_unlock(&st->sensor_list_lock);
609 while (list_item != NULL) {
610 c_ipmi_sensor_list_t *list_next = list_item->next;
614 list_item = list_next;
615 } /* while (list_item) */
618 } /* int sensor_list_remove_all */
620 static int sensor_convert_threshold_severity(enum ipmi_thresh_e severity) {
622 case IPMI_LOWER_NON_CRITICAL:
623 case IPMI_UPPER_NON_CRITICAL:
625 case IPMI_LOWER_CRITICAL:
626 case IPMI_UPPER_CRITICAL:
627 return NOTIF_WARNING;
628 case IPMI_LOWER_NON_RECOVERABLE:
629 case IPMI_UPPER_NON_RECOVERABLE:
630 return NOTIF_FAILURE;
633 } /* switch (severity) */
634 } /* int sensor_convert_threshold_severity */
636 static void add_event_common_data(notification_t *n, ipmi_sensor_t *sensor,
637 enum ipmi_event_dir_e dir,
638 ipmi_event_t *event) {
639 ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
641 plugin_notification_meta_add_string(n, "entity_name",
642 ipmi_entity_get_entity_id_string(ent));
643 plugin_notification_meta_add_signed_int(n, "entity_id",
644 ipmi_entity_get_entity_id(ent));
645 plugin_notification_meta_add_signed_int(n, "entity_instance",
646 ipmi_entity_get_entity_instance(ent));
647 plugin_notification_meta_add_boolean(n, "assert", dir == IPMI_ASSERTION);
650 plugin_notification_meta_add_signed_int(n, "event_type",
651 ipmi_event_get_type(event));
652 } /* void add_event_sensor_meta_data */
654 static int sensor_threshold_event_handler(
655 ipmi_sensor_t *sensor, enum ipmi_event_dir_e dir,
656 enum ipmi_thresh_e threshold, enum ipmi_event_value_dir_e high_low,
657 enum ipmi_value_present_e value_present, unsigned int raw_value,
658 double value, void *cb_data, ipmi_event_t *event) {
660 c_ipmi_instance_t *st = cb_data;
662 /* From the IPMI specification Chapter 2: Events.
663 * If a callback handles the event, then all future callbacks called due to
664 * the event will receive a NULL for the event. So be ready to handle a NULL
665 * event in all your event handlers. A NULL may also be passed to an event
666 * handler if the callback was not due to an event. */
668 return IPMI_EVENT_NOT_HANDLED;
670 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
671 /* offset is a table index and it's represented as enum of strings that are
672 organized in the way - high and low for each threshold severity level */
673 unsigned int offset = (2 * threshold) + high_low;
674 unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
675 unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
676 const char *event_state =
677 ipmi_get_reading_name(event_type, sensor_type, offset);
678 sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
679 if (value_present != IPMI_NO_VALUES_PRESENT)
680 snprintf(n.message, sizeof(n.message),
681 "sensor %s received event: %s, value is %f", n.type_instance,
684 snprintf(n.message, sizeof(n.message),
685 "sensor %s received event: %s, value not provided",
686 n.type_instance, event_state);
688 DEBUG("Threshold event received for sensor %s", n.type_instance);
690 sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
691 n.severity = sensor_convert_threshold_severity(threshold);
692 n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
694 plugin_notification_meta_add_string(&n, "severity",
695 ipmi_get_threshold_string(threshold));
696 plugin_notification_meta_add_string(&n, "direction",
697 ipmi_get_value_dir_string(high_low));
699 switch (value_present) {
700 case IPMI_BOTH_VALUES_PRESENT:
701 plugin_notification_meta_add_double(&n, "val", value);
702 /* both values present, so fall-through to add raw value too */
703 case IPMI_RAW_VALUE_PRESENT: {
704 char buf[DATA_MAX_NAME_LEN] = {0};
705 snprintf(buf, sizeof(buf), "0x%2.2x", raw_value);
706 plugin_notification_meta_add_string(&n, "raw", buf);
710 } /* switch (value_present) */
712 add_event_common_data(&n, sensor, dir, event);
714 plugin_dispatch_notification(&n);
715 plugin_notification_meta_free(n.meta);
717 /* Delete handled ipmi event from the list */
718 if (st->sel_clear_event) {
719 ipmi_event_delete(event, NULL, NULL);
720 return IPMI_EVENT_HANDLED;
723 return IPMI_EVENT_NOT_HANDLED;
724 } /* int sensor_threshold_event_handler */
726 static int sensor_discrete_event_handler(ipmi_sensor_t *sensor,
727 enum ipmi_event_dir_e dir, int offset,
728 int severity, int prev_severity,
729 void *cb_data, ipmi_event_t *event) {
731 c_ipmi_instance_t *st = cb_data;
733 /* From the IPMI specification Chapter 2: Events.
734 * If a callback handles the event, then all future callbacks called due to
735 * the event will receive a NULL for the event. So be ready to handle a NULL
736 * event in all your event handlers. A NULL may also be passed to an event
737 * handler if the callback was not due to an event. */
739 return IPMI_EVENT_NOT_HANDLED;
741 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
742 unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
743 unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
744 const char *event_state =
745 ipmi_get_reading_name(event_type, sensor_type, offset);
746 sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
747 snprintf(n.message, sizeof(n.message), "sensor %s received event: %s",
748 n.type_instance, event_state);
750 DEBUG("Discrete event received for sensor %s", n.type_instance);
752 sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
753 n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
755 plugin_notification_meta_add_signed_int(&n, "offset", offset);
758 plugin_notification_meta_add_signed_int(&n, "severity", severity);
760 if (prev_severity != -1)
761 plugin_notification_meta_add_signed_int(&n, "prevseverity", prev_severity);
763 add_event_common_data(&n, sensor, dir, event);
765 plugin_dispatch_notification(&n);
766 plugin_notification_meta_free(n.meta);
768 /* Delete handled ipmi event from the list */
769 if (st->sel_clear_event) {
770 ipmi_event_delete(event, NULL, NULL);
771 return IPMI_EVENT_HANDLED;
774 return IPMI_EVENT_NOT_HANDLED;
775 } /* int sensor_discrete_event_handler */
781 entity_sensor_update_handler(enum ipmi_update_e op,
782 ipmi_entity_t __attribute__((unused)) * entity,
783 ipmi_sensor_t *sensor, void *user_data) {
784 c_ipmi_instance_t *st = user_data;
785 char sensor_name[DATA_MAX_NAME_LEN] = {0};
787 sensor_get_name(sensor, sensor_name, sizeof(sensor_name));
788 if (ignorelist_match(st->ignorelist, sensor_name) != 0)
789 return; /* Ignore - sensor on ignore list */
791 if ((op == IPMI_ADDED) || (op == IPMI_CHANGED)) {
792 /* Will check for duplicate entries.. */
793 sensor_list_add(st, sensor);
795 if (st->sel_enabled) {
797 /* register threshold event handler */
798 if (ipmi_sensor_get_event_reading_type(sensor) ==
799 IPMI_EVENT_READING_TYPE_THRESHOLD)
800 status = ipmi_sensor_add_threshold_event_handler(
801 sensor, sensor_threshold_event_handler, st);
802 /* register discrete handler if discrete/specific sensor support events */
803 else if (ipmi_sensor_get_event_support(sensor) != IPMI_EVENT_SUPPORT_NONE)
804 status = ipmi_sensor_add_discrete_event_handler(
805 sensor, sensor_discrete_event_handler, st);
808 ERROR("Unable to add sensor %s event handler, status: %d", sensor_name,
812 } else if (op == IPMI_DELETED) {
813 sensor_list_remove(st, sensor);
815 if (st->sel_enabled) {
816 if (ipmi_sensor_get_event_reading_type(sensor) ==
817 IPMI_EVENT_READING_TYPE_THRESHOLD)
818 ipmi_sensor_remove_threshold_event_handler(
819 sensor, sensor_threshold_event_handler, st);
821 ipmi_sensor_remove_discrete_event_handler(
822 sensor, sensor_discrete_event_handler, st);
825 } /* void entity_sensor_update_handler */
831 domain_entity_update_handler(enum ipmi_update_e op,
832 ipmi_domain_t __attribute__((unused)) * domain,
833 ipmi_entity_t *entity, void *user_data) {
835 c_ipmi_instance_t *st = user_data;
837 if (op == IPMI_ADDED) {
838 status = ipmi_entity_add_sensor_update_handler(
839 entity, entity_sensor_update_handler, /* user data = */ (void *)st);
841 c_ipmi_error(st, "ipmi_entity_add_sensor_update_handler", status);
843 } else if (op == IPMI_DELETED) {
844 status = ipmi_entity_remove_sensor_update_handler(
845 entity, entity_sensor_update_handler, /* user data = */ (void *)st);
847 c_ipmi_error(st, "ipmi_entity_remove_sensor_update_handler", status);
850 } /* void domain_entity_update_handler */
852 static void smi_event_handler(ipmi_con_t __attribute__((unused)) * ipmi,
853 const ipmi_addr_t __attribute__((unused)) * addr,
854 unsigned int __attribute__((unused)) addr_len,
855 ipmi_event_t *event, void *cb_data) {
856 unsigned int type = ipmi_event_get_type(event);
857 ipmi_domain_t *domain = cb_data;
859 DEBUG("%s: Event received: type %u", __FUNCTION__, type);
862 /* It's not a standard IPMI event. */
865 /* force domain to reread SELs */
866 ipmi_domain_reread_sels(domain, NULL, NULL);
869 static void domain_connection_change_handler(ipmi_domain_t *domain, int err,
870 unsigned int conn_num,
871 unsigned int port_num,
875 DEBUG("domain_connection_change_handler (domain = %p, err = %i, "
876 "conn_num = %u, port_num = %u, still_connected = %i, "
878 (void *)domain, err, conn_num, port_num, still_connected, user_data);
880 c_ipmi_instance_t *st = user_data;
883 c_ipmi_error(st, "domain_connection_change_handler", err);
885 if (!still_connected) {
887 if (st->notify_conn && st->connected && st->init_in_progress == 0) {
888 notification_t n = c_ipmi_notification_init(st, NOTIF_FAILURE);
890 sstrncpy(n.message, "IPMI connection lost", sizeof(n.plugin));
892 plugin_dispatch_notification(&n);
899 if (st->notify_conn && !st->connected && st->init_in_progress == 0) {
900 notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
902 sstrncpy(n.message, "IPMI connection restored", sizeof(n.plugin));
904 plugin_dispatch_notification(&n);
909 int status = ipmi_domain_add_entity_update_handler(
910 domain, domain_entity_update_handler, /* user data = */ st);
912 c_ipmi_error(st, "ipmi_domain_add_entity_update_handler", status);
915 status = st->connection->add_event_handler(st->connection, smi_event_handler,
919 c_ipmi_error(st, "Failed to register smi event handler", status);
920 } /* void domain_connection_change_handler */
922 static int c_ipmi_thread_init(c_ipmi_instance_t *st) {
923 ipmi_domain_id_t domain_id;
926 if (st->connaddr != NULL) {
927 status = ipmi_ip_setup_con(
928 &st->connaddr, &(char *){IPMI_LAN_STD_PORT_STR}, 1, st->authtype,
929 (unsigned int)IPMI_PRIVILEGE_USER, st->username, strlen(st->username),
930 st->password, strlen(st->password), os_handler,
931 /* user data = */ NULL, &st->connection);
933 c_ipmi_error(st, "ipmi_ip_setup_con", status);
937 status = ipmi_smi_setup_con(/* if_num = */ 0, os_handler,
938 /* user data = */ NULL, &st->connection);
940 c_ipmi_error(st, "ipmi_smi_setup_con", status);
945 ipmi_open_option_t opts[] = {
946 {.option = IPMI_OPEN_OPTION_ALL, {.ival = 1}},
947 #ifdef IPMI_OPEN_OPTION_USE_CACHE
948 /* OpenIPMI-2.0.17 and later: Disable SDR cache in local file */
949 {.option = IPMI_OPEN_OPTION_USE_CACHE, {.ival = 0}},
954 * NOTE: Domain names must be unique. There is static `domains_list` common
955 * to all threads inside lib/domain.c and some ops are done by name.
957 status = ipmi_open_domain(
958 st->name, &st->connection, /* num_con = */ 1,
959 domain_connection_change_handler, /* user data = */ (void *)st,
960 /* domain_fully_up_handler = */ NULL, /* user data = */ NULL, opts,
961 STATIC_ARRAY_SIZE(opts), &domain_id);
963 c_ipmi_error(st, "ipmi_open_domain", status);
968 } /* int c_ipmi_thread_init */
970 static void *c_ipmi_thread_main(void *user_data) {
971 c_ipmi_instance_t *st = user_data;
973 int status = c_ipmi_thread_init(st);
975 ERROR("ipmi plugin: c_ipmi_thread_init failed.");
980 while (st->active != 0) {
981 struct timeval tv = {1, 0};
982 os_handler->perform_one_op(os_handler, &tv);
985 } /* void *c_ipmi_thread_main */
987 static c_ipmi_instance_t *c_ipmi_init_instance() {
988 c_ipmi_instance_t *st;
990 st = calloc(1, sizeof(*st));
992 ERROR("ipmi plugin: calloc failed.");
996 st->name = strdup("main");
997 if (st->name == NULL) {
999 ERROR("ipmi plugin: strdup() failed.");
1003 st->ignorelist = ignorelist_create(/* invert = */ 1);
1004 if (st->ignorelist == NULL) {
1007 ERROR("ipmi plugin: ignorelist_create() failed.");
1011 st->sensor_list = NULL;
1012 pthread_mutex_init(&st->sensor_list_lock, /* attr = */ NULL);
1015 st->connaddr = NULL;
1016 st->username = NULL;
1017 st->password = NULL;
1018 st->authtype = IPMI_AUTHTYPE_DEFAULT;
1023 } /* c_ipmi_instance_t *c_ipmi_init_instance */
1025 static void c_ipmi_free_instance(c_ipmi_instance_t *st) {
1029 assert(st->next == NULL);
1033 sfree(st->connaddr);
1034 sfree(st->username);
1035 sfree(st->password);
1037 ignorelist_free(st->ignorelist);
1038 pthread_mutex_destroy(&st->sensor_list_lock);
1040 } /* void c_ipmi_free_instance */
1042 static void c_ipmi_add_instance(c_ipmi_instance_t *instance) {
1043 if (instances == NULL) {
1044 instances = instance;
1048 c_ipmi_instance_t *last = instances;
1050 while (last->next != NULL)
1053 last->next = instance;
1054 } /* void c_ipmi_add_instance */
1056 static int c_ipmi_config_add_instance(oconfig_item_t *ci) {
1058 c_ipmi_instance_t *st = c_ipmi_init_instance();
1062 if (strcasecmp(ci->key, "Instance") == 0)
1063 status = cf_util_get_string(ci, &st->name);
1066 c_ipmi_free_instance(st);
1070 for (int i = 0; i < ci->children_num; i++) {
1071 oconfig_item_t *child = ci->children + i;
1073 if (strcasecmp("Sensor", child->key) == 0)
1074 ignorelist_add(st->ignorelist, child->values[0].value.string);
1075 else if (strcasecmp("IgnoreSelected", child->key) == 0) {
1077 status = cf_util_get_boolean(child, &t);
1080 ignorelist_set_invert(st->ignorelist, /* invert = */ !t);
1081 } else if (strcasecmp("NotifyIPMIConnectionState", child->key) == 0) {
1082 status = cf_util_get_boolean(child, &st->notify_conn);
1083 } else if (strcasecmp("NotifySensorAdd", child->key) == 0) {
1084 status = cf_util_get_boolean(child, &st->notify_add);
1085 } else if (strcasecmp("NotifySensorRemove", child->key) == 0) {
1086 status = cf_util_get_boolean(child, &st->notify_remove);
1087 } else if (strcasecmp("NotifySensorNotPresent", child->key) == 0) {
1088 status = cf_util_get_boolean(child, &st->notify_notpresent);
1089 } else if (strcasecmp("SELEnabled", child->key) == 0) {
1090 status = cf_util_get_boolean(child, &st->sel_enabled);
1091 } else if (strcasecmp("SELClearEvent", child->key) == 0) {
1092 status = cf_util_get_boolean(child, &st->sel_clear_event);
1093 } else if (strcasecmp("Host", child->key) == 0)
1094 status = cf_util_get_string(child, &st->host);
1095 else if (strcasecmp("Address", child->key) == 0)
1096 status = cf_util_get_string(child, &st->connaddr);
1097 else if (strcasecmp("Username", child->key) == 0)
1098 status = cf_util_get_string(child, &st->username);
1099 else if (strcasecmp("Password", child->key) == 0)
1100 status = cf_util_get_string(child, &st->password);
1101 else if (strcasecmp("AuthType", child->key) == 0) {
1103 status = cf_util_get_string_buffer(child, tmp, sizeof(tmp));
1107 if (strcasecmp("MD5", tmp) == 0)
1108 st->authtype = IPMI_AUTHTYPE_MD5;
1109 else if (strcasecmp("rmcp+", tmp) == 0)
1110 st->authtype = IPMI_AUTHTYPE_RMCP_PLUS;
1112 WARNING("ipmi plugin: The value \"%s\" is not valid for the "
1113 "\"AuthType\" option.",
1116 WARNING("ipmi plugin: Option `%s' not allowed here.", child->key);
1125 c_ipmi_free_instance(st);
1129 c_ipmi_add_instance(st);
1132 } /* int c_ipmi_config_add_instance */
1134 static int c_ipmi_config(oconfig_item_t *ci) {
1135 _Bool have_instance_block = 0;
1137 for (int i = 0; i < ci->children_num; i++) {
1138 oconfig_item_t *child = ci->children + i;
1140 if (strcasecmp("Instance", child->key) == 0) {
1141 int status = c_ipmi_config_add_instance(child);
1145 have_instance_block = 1;
1146 } else if (!have_instance_block) {
1147 /* Non-instance option: Assume legacy configuration (without <Instance />
1148 * blocks) and call c_ipmi_config_add_instance with the <Plugin /> block.
1150 WARNING("ipmi plugin: Legacy configuration found! Please update your "
1152 return c_ipmi_config_add_instance(ci);
1154 WARNING("ipmi plugin: The configuration option "
1155 "\"%s\" is not allowed here. Did you "
1156 "forget to add an <Instance /> block "
1157 "around the configuration?",
1161 } /* for (ci->children) */
1164 } /* int c_ipmi_config */
1166 static int c_ipmi_read(user_data_t *user_data) {
1167 c_ipmi_instance_t *st = user_data->data;
1169 if (st->active == 0) {
1170 INFO("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
1174 if (st->connected == 0)
1177 sensor_list_read_all(st);
1179 if (st->init_in_progress > 0)
1180 st->init_in_progress--;
1182 st->init_in_progress = 0;
1185 } /* int c_ipmi_read */
1187 static int c_ipmi_init(void) {
1188 c_ipmi_instance_t *st;
1189 char callback_name[3 * DATA_MAX_NAME_LEN];
1191 if (os_handler != NULL) {
1195 os_handler = ipmi_posix_thread_setup_os_handler(SIGIO);
1196 if (os_handler == NULL) {
1197 ERROR("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
1201 os_handler->set_log_handler(os_handler, c_ipmi_log);
1203 if (ipmi_init(os_handler) != 0) {
1204 ERROR("ipmi plugin: ipmi_init() failed.");
1205 os_handler->free_os_handler(os_handler);
1209 if (instances == NULL) {
1210 /* No instances were configured, let's start a default instance. */
1211 st = c_ipmi_init_instance();
1215 c_ipmi_add_instance(st);
1218 /* Don't send `ADD' notifications during startup (~ 1 minute) */
1219 int cycles = 1 + (int)(TIME_T_TO_CDTIME_T(60) / plugin_get_interval());
1222 while (NULL != st) {
1223 /* The `st->name` is used as "domain name" for ipmi_open_domain().
1224 * That value should be unique, so we do plugin_register_complex_read()
1225 * at first as it checks the uniqueness. */
1226 snprintf(callback_name, sizeof(callback_name), "ipmi/%s", st->name);
1232 int status = plugin_register_complex_read(
1233 /* group = */ "ipmi",
1234 /* name = */ callback_name,
1235 /* callback = */ c_ipmi_read,
1237 /* user_data = */ &ud);
1244 st->init_in_progress = cycles;
1247 status = plugin_thread_create(&st->thread_id, /* attr = */ NULL,
1249 /* user data = */ (void *)st, "ipmi");
1253 st->thread_id = (pthread_t){0};
1255 plugin_unregister_read(callback_name);
1257 ERROR("ipmi plugin: pthread_create failed for `%s`.", callback_name);
1264 } /* int c_ipmi_init */
1266 static int c_ipmi_shutdown(void) {
1267 c_ipmi_instance_t *st = instances;
1270 while (st != NULL) {
1271 c_ipmi_instance_t *next = st->next;
1276 if (!pthread_equal(st->thread_id, (pthread_t){0})) {
1277 pthread_join(st->thread_id, NULL);
1278 st->thread_id = (pthread_t){0};
1281 sensor_list_remove_all(st);
1282 c_ipmi_free_instance(st);
1287 os_handler->free_os_handler(os_handler);
1291 } /* int c_ipmi_shutdown */
1293 void module_register(void) {
1294 plugin_register_complex_config("ipmi", c_ipmi_config);
1295 plugin_register_init("ipmi", c_ipmi_init);
1296 plugin_register_shutdown("ipmi", c_ipmi_shutdown);
1297 } /* void module_register */