src/ipmi.c

   1 /**
   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
   6  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Authors:
  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>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "plugin.h"
  31 #include "utils_ignorelist.h"
  32
  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>
  40
  41 #define ERR_BUF_SIZE 1024
  42
  43 /*
  44  * Private data types
  45  */
  46 struct c_ipmi_sensor_list_s;
  47 typedef struct c_ipmi_sensor_list_s c_ipmi_sensor_list_t;
  48
  49 struct c_ipmi_instance_s {
  50   char *name;
  51   ignorelist_t *ignorelist;
  52   _Bool notify_add;
  53   _Bool notify_remove;
  54   _Bool notify_notpresent;
  55   _Bool notify_conn;
  56   _Bool sel_enabled;
  57   _Bool sel_clear_event;
  58
  59   char *host;
  60   char *connaddr;
  61   char *username;
  62   char *password;
  63   unsigned int authtype;
  64
  65   _Bool connected;
  66   ipmi_con_t *connection;
  67   pthread_mutex_t sensor_list_lock;
  68   c_ipmi_sensor_list_t *sensor_list;
  69
  70   _Bool active;
  71   pthread_t thread_id;
  72   int init_in_progress;
  73
  74   struct c_ipmi_instance_s *next;
  75 };
  76 typedef struct c_ipmi_instance_s c_ipmi_instance_t;
  77
  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;
  86   unsigned int use;
  87 };
  88
  89 struct c_ipmi_db_type_map_s {
  90   enum ipmi_unit_type_e type;
  91   const char *type_name;
  92 };
  93 typedef struct c_ipmi_db_type_map_s c_ipmi_db_type_map_t;
  94
  95 /*
  96  * Module global variables
  97  */
  98 static os_handler_t *os_handler = NULL;
  99 static c_ipmi_instance_t *instances = NULL;
 100
 101 /*
 102  * Misc private functions
 103  */
 104 static void c_ipmi_error(c_ipmi_instance_t *st, const char *func, int status) {
 105   char errbuf[ERR_BUF_SIZE] = {0};
 106
 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));
 110   }
 111
 112   if (errbuf[0] == 0) {
 113     snprintf(errbuf, sizeof(errbuf), "Unknown error %#x", status);
 114   }
 115   errbuf[sizeof(errbuf) - 1] = 0;
 116
 117   ERROR("ipmi plugin: %s failed for `%s`: %s", func, st->name, errbuf);
 118 } /* void c_ipmi_error */
 119
 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];
 123
 124   vsnprintf(msg, sizeof(msg), format, ap);
 125
 126   switch (log_type) {
 127   case IPMI_LOG_INFO:
 128     INFO("ipmi plugin: %s", msg);
 129     break;
 130   case IPMI_LOG_WARNING:
 131     NOTICE("ipmi plugin: %s", msg);
 132     break;
 133   case IPMI_LOG_SEVERE:
 134     WARNING("ipmi plugin: %s", msg);
 135     break;
 136   case IPMI_LOG_FATAL:
 137     ERROR("ipmi plugin: %s", msg);
 138     break;
 139   case IPMI_LOG_ERR_INFO:
 140     ERROR("ipmi plugin: %s", msg);
 141     break;
 142 #if COLLECT_DEBUG
 143   case IPMI_LOG_DEBUG_START:
 144   case IPMI_LOG_DEBUG:
 145     DEBUG("ipmi plugin: %s", msg);
 146     break;
 147   case IPMI_LOG_DEBUG_CONT:
 148   case IPMI_LOG_DEBUG_END:
 149     DEBUG("%s", msg);
 150     break;
 151 #else
 152   case IPMI_LOG_DEBUG_START:
 153   case IPMI_LOG_DEBUG:
 154   case IPMI_LOG_DEBUG_CONT:
 155   case IPMI_LOG_DEBUG_END:
 156     break;
 157 #endif
 158   }
 159 } /* void c_ipmi_log */
 160
 161 static notification_t c_ipmi_notification_init(c_ipmi_instance_t const *st,
 162                                                int severity) {
 163   notification_t n = {severity, cdtime(), "", "", "ipmi", "", "", "", NULL};
 164
 165   sstrncpy(n.host, (st->host != NULL) ? st->host : hostname_g, sizeof(n.host));
 166   return n;
 167 } /* notification_t c_ipmi_notification_init */
 168
 169 /*
 170  * Sensor handlers
 171  */
 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);
 174
 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,
 179                                 void *user_data) {
 180   value_list_t vl = VALUE_LIST_INIT;
 181
 182   c_ipmi_sensor_list_t *list_item = user_data;
 183   c_ipmi_instance_t *st = list_item->instance;
 184
 185   list_item->use--;
 186
 187   if (err != 0) {
 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;
 192
 193         INFO("ipmi plugin: sensor_read_handler: sensor `%s` of `%s` "
 194              "not present.",
 195              list_item->sensor_name, st->name);
 196
 197         if (st->notify_notpresent) {
 198           notification_t n = c_ipmi_notification_init(st, NOTIF_WARNING);
 199
 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);
 205
 206           plugin_dispatch_notification(&n);
 207         }
 208       }
 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);
 218     } else {
 219       char errbuf[ERR_BUF_SIZE] = {0};
 220       ipmi_get_error_string(err, errbuf, sizeof(errbuf) - 1);
 221
 222       if (IPMI_IS_IPMI_ERR(err))
 223         INFO("ipmi plugin: sensor_read_handler: Sensor `%s` of `%s` failed: "
 224              "%s.",
 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: "
 228              "%s (%#x).",
 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: "
 232              "%s.",
 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: "
 236              "%s (%#x).",
 237              list_item->sensor_name, st->name, errbuf, IPMI_GET_SOL_ERR(err));
 238       else
 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);
 242     }
 243     return;
 244   } else if (list_item->sensor_not_present == 1) {
 245     list_item->sensor_not_present = 0;
 246
 247     INFO("ipmi plugin: sensor_read_handler: sensor `%s` of `%s` present.",
 248          list_item->sensor_name, st->name);
 249
 250     if (st->notify_notpresent) {
 251       notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
 252
 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);
 258
 259       plugin_dispatch_notification(&n);
 260     }
 261   }
 262
 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"
 269                                                    : "no value");
 270     sensor_list_remove(st, sensor);
 271     return;
 272   }
 273
 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);
 278     return;
 279   }
 280
 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);
 285     return;
 286   }
 287
 288   vl.values = &(value_t){.gauge = value};
 289   vl.values_len = 1;
 290
 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));
 297
 298   plugin_dispatch_values(&vl);
 299 } /* void sensor_read_handler */
 300
 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;
 307
 308   if ((buffer == NULL) || (buf_len == 0))
 309     return;
 310
 311   ipmi_sensor_get_name(sensor, temp, sizeof(temp));
 312   temp[sizeof(temp) - 1] = 0;
 313
 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));
 318   else
 319     sstrncpy(sensor_name, temp, sizeof(sensor_name));
 320
 321   if (strlen(temp)) {
 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'. */
 329       char *sensor_id_ptr;
 330
 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". */
 336
 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,
 341                  sensor_id_ptr);
 342       }
 343       /* else: don't touch sensor_name. */
 344     }
 345   }
 346   sstrncpy(buffer, sensor_name, buf_len);
 347 }
 348
 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"}};
 352
 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))
 356     return NULL;
 357
 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;
 363
 364   return NULL;
 365 } /* const char* sensor_unit_to_type */
 366
 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;
 371
 372   char buffer[DATA_MAX_NAME_LEN] = {0};
 373   char *sensor_name_ptr = buffer;
 374   int sensor_type;
 375   const char *type;
 376
 377   sensor_id = ipmi_sensor_convert_to_id(sensor);
 378   sensor_get_name(sensor, buffer, sizeof(buffer));
 379
 380   DEBUG("ipmi plugin: sensor_list_add: Found sensor `%s` of `%s`,"
 381         " Type: %#x"
 382         " Event reading type: %#x"
 383         " Direction: %#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));
 389
 390   /* Both `ignorelist' and `sensor_name_ptr' may be NULL. */
 391   if (ignorelist_match(st->ignorelist, sensor_name_ptr) != 0)
 392     return 0;
 393
 394   /* FIXME: Use rate unit or base unit to scale the value */
 395
 396   sensor_type = ipmi_sensor_get_sensor_type(sensor);
 397
 398   /*
 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
 402    * in Collectd yet.
 403    *
 404    * ipmi_sensor_id_get_reading() supports only 'Threshold' sensors.
 405    * See lib/sensor.c:4842, stand_ipmi_sensor_get_reading() for details.
 406    */
 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));
 412     return -1;
 413   }
 414
 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));
 422     return -1;
 423   }
 424
 425   switch (sensor_type) {
 426   case IPMI_SENSOR_TYPE_TEMPERATURE:
 427     type = "temperature";
 428     break;
 429
 430   case IPMI_SENSOR_TYPE_VOLTAGE:
 431     type = "voltage";
 432     break;
 433
 434   case IPMI_SENSOR_TYPE_CURRENT:
 435     type = "current";
 436     break;
 437
 438   case IPMI_SENSOR_TYPE_FAN:
 439     type = "fanspeed";
 440     break;
 441
 442   case IPMI_SENSOR_TYPE_MEMORY:
 443     type = "memory";
 444     break;
 445
 446   default: {
 447     /* try to get collectd DB type based on sensor base unit type */
 448     if ((type = sensor_unit_to_type(sensor)) != NULL)
 449       break;
 450
 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));
 456     return -1;
 457   }
 458   } /* switch (sensor_type) */
 459
 460   pthread_mutex_lock(&st->sensor_list_lock);
 461
 462   list_prev = NULL;
 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)
 466       break;
 467     list_prev = list_item;
 468   } /* for (list_item) */
 469
 470   if (list_item != NULL) {
 471     pthread_mutex_unlock(&st->sensor_list_lock);
 472     return 0;
 473   }
 474
 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);
 478     return -1;
 479   }
 480
 481   list_item->instance = st;
 482   list_item->sensor_id = ipmi_sensor_convert_to_id(sensor);
 483
 484   if (list_prev != NULL)
 485     list_prev->next = list_item;
 486   else
 487     st->sensor_list = list_item;
 488
 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);
 494     type = "percent";
 495   } else {
 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));
 499   }
 500
 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));
 504
 505   pthread_mutex_unlock(&st->sensor_list_lock);
 506
 507   if (st->notify_add && (st->init_in_progress == 0)) {
 508     notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
 509
 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);
 515
 516     plugin_dispatch_notification(&n);
 517   }
 518
 519   return 0;
 520 } /* int sensor_list_add */
 521
 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;
 526
 527   sensor_id = ipmi_sensor_convert_to_id(sensor);
 528
 529   pthread_mutex_lock(&st->sensor_list_lock);
 530
 531   list_prev = NULL;
 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)
 535       break;
 536     list_prev = list_item;
 537   } /* for (list_item) */
 538
 539   if (list_item == NULL) {
 540     pthread_mutex_unlock(&st->sensor_list_lock);
 541     return -1;
 542   }
 543
 544   if (list_prev == NULL)
 545     st->sensor_list = list_item->next;
 546   else
 547     list_prev->next = list_item->next;
 548
 549   list_prev = NULL;
 550   list_item->next = NULL;
 551
 552   pthread_mutex_unlock(&st->sensor_list_lock);
 553
 554   if (st->notify_remove && st->active) {
 555     notification_t n = c_ipmi_notification_init(st, NOTIF_WARNING);
 556
 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);
 562
 563     plugin_dispatch_notification(&n);
 564   }
 565
 566   free(list_item);
 567   return 0;
 568 } /* int sensor_list_remove */
 569
 570 static int sensor_list_read_all(c_ipmi_instance_t *st) {
 571   pthread_mutex_lock(&st->sensor_list_lock);
 572
 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);
 577
 578     /* Reading already initiated */
 579     if (list_item->use)
 580       continue;
 581
 582     list_item->use++;
 583     ipmi_sensor_id_get_reading(list_item->sensor_id, sensor_read_handler,
 584                                /* user data = */ (void *)list_item);
 585   } /* for (list_item) */
 586
 587   pthread_mutex_unlock(&st->sensor_list_lock);
 588
 589   return 0;
 590 } /* int sensor_list_read_all */
 591
 592 static int sensor_list_remove_all(c_ipmi_instance_t *st) {
 593   c_ipmi_sensor_list_t *list_item;
 594
 595   pthread_mutex_lock(&st->sensor_list_lock);
 596
 597   list_item = st->sensor_list;
 598   st->sensor_list = NULL;
 599
 600   pthread_mutex_unlock(&st->sensor_list_lock);
 601
 602   while (list_item != NULL) {
 603     c_ipmi_sensor_list_t *list_next = list_item->next;
 604
 605     free(list_item);
 606
 607     list_item = list_next;
 608   } /* while (list_item) */
 609
 610   return 0;
 611 } /* int sensor_list_remove_all */
 612
 613 static int sensor_convert_threshold_severity(enum ipmi_thresh_e severity) {
 614   switch (severity) {
 615   case IPMI_LOWER_NON_CRITICAL:
 616   case IPMI_UPPER_NON_CRITICAL:
 617     return NOTIF_OKAY;
 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;
 624   default:
 625     return NOTIF_OKAY;
 626   } /* switch (severity) */
 627 } /* int sensor_convert_threshold_severity */
 628
 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);
 633
 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);
 641
 642   if (event)
 643     plugin_notification_meta_add_signed_int(n, "event_type",
 644                                             ipmi_event_get_type(event));
 645 } /* void add_event_sensor_meta_data */
 646
 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) {
 652
 653   c_ipmi_instance_t *st = cb_data;
 654
 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. */
 660   if (event == NULL)
 661     return IPMI_EVENT_NOT_HANDLED;
 662
 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,
 675              event_state, value);
 676   else
 677     snprintf(n.message, sizeof(n.message),
 678              "sensor %s received event: %s, value not provided",
 679              n.type_instance, event_state);
 680
 681   DEBUG("Threshold event received for sensor %s", n.type_instance);
 682
 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));
 686
 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));
 691
 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);
 700   } break;
 701   default:
 702     break;
 703   } /* switch (value_present) */
 704
 705   add_event_common_data(&n, sensor, dir, event);
 706
 707   plugin_dispatch_notification(&n);
 708   plugin_notification_meta_free(n.meta);
 709
 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;
 714   }
 715
 716   return IPMI_EVENT_NOT_HANDLED;
 717 } /* int sensor_threshold_event_handler */
 718
 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) {
 723
 724   c_ipmi_instance_t *st = cb_data;
 725
 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. */
 731   if (event == NULL)
 732     return IPMI_EVENT_NOT_HANDLED;
 733
 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);
 742
 743   DEBUG("Discrete event received for sensor %s", n.type_instance);
 744
 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));
 747
 748   plugin_notification_meta_add_signed_int(&n, "offset", offset);
 749
 750   if (severity != -1)
 751     plugin_notification_meta_add_signed_int(&n, "severity", severity);
 752
 753   if (prev_severity != -1)
 754     plugin_notification_meta_add_signed_int(&n, "prevseverity", prev_severity);
 755
 756   add_event_common_data(&n, sensor, dir, event);
 757
 758   plugin_dispatch_notification(&n);
 759   plugin_notification_meta_free(n.meta);
 760
 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;
 765   }
 766
 767   return IPMI_EVENT_NOT_HANDLED;
 768 } /* int sensor_discrete_event_handler */
 769
 770 /*
 771  * Entity handlers
 772  */
 773 static void
 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;
 778
 779   if ((op == IPMI_ADDED) || (op == IPMI_CHANGED)) {
 780     /* Will check for duplicate entries.. */
 781     sensor_list_add(st, sensor);
 782
 783     if (st->sel_enabled) {
 784       int status = 0;
 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);
 796
 797       if (status) {
 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);
 801       }
 802     }
 803   } else if (op == IPMI_DELETED) {
 804     sensor_list_remove(st, sensor);
 805
 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);
 811       else
 812         ipmi_sensor_remove_discrete_event_handler(
 813             sensor, sensor_discrete_event_handler, st);
 814     }
 815   }
 816 } /* void entity_sensor_update_handler */
 817
 818 /*
 819  * Domain handlers
 820  */
 821 static void
 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) {
 825   int status;
 826   c_ipmi_instance_t *st = user_data;
 827
 828   if (op == IPMI_ADDED) {
 829     status = ipmi_entity_add_sensor_update_handler(
 830         entity, entity_sensor_update_handler, /* user data = */ (void *)st);
 831     if (status != 0) {
 832       c_ipmi_error(st, "ipmi_entity_add_sensor_update_handler", status);
 833     }
 834   } else if (op == IPMI_DELETED) {
 835     status = ipmi_entity_remove_sensor_update_handler(
 836         entity, entity_sensor_update_handler, /* user data = */ (void *)st);
 837     if (status != 0) {
 838       c_ipmi_error(st, "ipmi_entity_remove_sensor_update_handler", status);
 839     }
 840   }
 841 } /* void domain_entity_update_handler */
 842
 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;
 849
 850   DEBUG("%s: Event received: type %u", __FUNCTION__, type);
 851
 852   if (type != 0x02)
 853     /* It's not a standard IPMI event. */
 854     return;
 855
 856   /* force domain to reread SELs */
 857   ipmi_domain_reread_sels(domain, NULL, NULL);
 858 }
 859
 860 static void domain_connection_change_handler(ipmi_domain_t *domain, int err,
 861                                              unsigned int conn_num,
 862                                              unsigned int port_num,
 863                                              int still_connected,
 864                                              void *user_data) {
 865
 866   DEBUG("domain_connection_change_handler (domain = %p, err = %i, "
 867         "conn_num = %u, port_num = %u, still_connected = %i, "
 868         "user_data = %p);",
 869         (void *)domain, err, conn_num, port_num, still_connected, user_data);
 870
 871   c_ipmi_instance_t *st = user_data;
 872
 873   if (err != 0)
 874     c_ipmi_error(st, "domain_connection_change_handler", err);
 875
 876   if (!still_connected) {
 877
 878     if (st->notify_conn && st->connected && st->init_in_progress == 0) {
 879       notification_t n = c_ipmi_notification_init(st, NOTIF_FAILURE);
 880
 881       sstrncpy(n.message, "IPMI connection lost", sizeof(n.plugin));
 882
 883       plugin_dispatch_notification(&n);
 884     }
 885
 886     st->connected = 0;
 887     return;
 888   }
 889
 890   if (st->notify_conn && !st->connected && st->init_in_progress == 0) {
 891     notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
 892
 893     sstrncpy(n.message, "IPMI connection restored", sizeof(n.plugin));
 894
 895     plugin_dispatch_notification(&n);
 896   }
 897
 898   st->connected = 1;
 899
 900   int status = ipmi_domain_add_entity_update_handler(
 901       domain, domain_entity_update_handler, /* user data = */ st);
 902   if (status != 0) {
 903     c_ipmi_error(st, "ipmi_domain_add_entity_update_handler", status);
 904   }
 905
 906   status = st->connection->add_event_handler(st->connection, smi_event_handler,
 907                                              (void *)domain);
 908
 909   if (status != 0)
 910     c_ipmi_error(st, "Failed to register smi event handler", status);
 911 } /* void domain_connection_change_handler */
 912
 913 static int c_ipmi_thread_init(c_ipmi_instance_t *st) {
 914   ipmi_domain_id_t domain_id;
 915   int status;
 916
 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);
 923     if (status != 0) {
 924       c_ipmi_error(st, "ipmi_ip_setup_con", status);
 925       return -1;
 926     }
 927   } else {
 928     status = ipmi_smi_setup_con(/* if_num = */ 0, os_handler,
 929                                 /* user data = */ NULL, &st->connection);
 930     if (status != 0) {
 931       c_ipmi_error(st, "ipmi_smi_setup_con", status);
 932       return -1;
 933     }
 934   }
 935
 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}},
 941 #endif
 942   };
 943
 944   /*
 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.
 947    */
 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);
 953   if (status != 0) {
 954     c_ipmi_error(st, "ipmi_open_domain", status);
 955     return -1;
 956   }
 957
 958   return 0;
 959 } /* int c_ipmi_thread_init */
 960
 961 static void *c_ipmi_thread_main(void *user_data) {
 962   c_ipmi_instance_t *st = user_data;
 963
 964   int status = c_ipmi_thread_init(st);
 965   if (status != 0) {
 966     ERROR("ipmi plugin: c_ipmi_thread_init failed.");
 967     st->active = 0;
 968     return (void *)-1;
 969   }
 970
 971   while (st->active != 0) {
 972     struct timeval tv = {1, 0};
 973     os_handler->perform_one_op(os_handler, &tv);
 974   }
 975   return (void *)0;
 976 } /* void *c_ipmi_thread_main */
 977
 978 static c_ipmi_instance_t *c_ipmi_init_instance() {
 979   c_ipmi_instance_t *st;
 980
 981   st = calloc(1, sizeof(*st));
 982   if (st == NULL) {
 983     ERROR("ipmi plugin: calloc failed.");
 984     return NULL;
 985   }
 986
 987   st->name = strdup("main");
 988   if (st->name == NULL) {
 989     sfree(st);
 990     ERROR("ipmi plugin: strdup() failed.");
 991     return NULL;
 992   }
 993
 994   st->ignorelist = ignorelist_create(/* invert = */ 1);
 995   if (st->ignorelist == NULL) {
 996     sfree(st->name);
 997     sfree(st);
 998     ERROR("ipmi plugin: ignorelist_create() failed.");
 999     return NULL;
1000   }
1001
1002   st->sensor_list = NULL;
1003   pthread_mutex_init(&st->sensor_list_lock, /* attr = */ NULL);
1004
1005   st->host = NULL;
1006   st->connaddr = NULL;
1007   st->username = NULL;
1008   st->password = NULL;
1009   st->authtype = IPMI_AUTHTYPE_DEFAULT;
1010
1011   st->next = NULL;
1012
1013   return st;
1014 } /* c_ipmi_instance_t *c_ipmi_init_instance */
1015
1016 static void c_ipmi_free_instance(c_ipmi_instance_t *st) {
1017   if (st == NULL)
1018     return;
1019
1020   assert(st->next == NULL);
1021
1022   sfree(st->name);
1023   sfree(st->host);
1024   sfree(st->connaddr);
1025   sfree(st->username);
1026   sfree(st->password);
1027
1028   ignorelist_free(st->ignorelist);
1029   pthread_mutex_destroy(&st->sensor_list_lock);
1030   sfree(st);
1031 } /* void c_ipmi_free_instance */
1032
1033 static void c_ipmi_add_instance(c_ipmi_instance_t *instance) {
1034   if (instances == NULL) {
1035     instances = instance;
1036     return;
1037   }
1038
1039   c_ipmi_instance_t *last = instances;
1040
1041   while (last->next != NULL)
1042     last = last->next;
1043
1044   last->next = instance;
1045 } /* void c_ipmi_add_instance */
1046
1047 static int c_ipmi_config_add_instance(oconfig_item_t *ci) {
1048   int status = 0;
1049   c_ipmi_instance_t *st = c_ipmi_init_instance();
1050   if (st == NULL)
1051     return ENOMEM;
1052
1053   if (strcasecmp(ci->key, "Instance") == 0)
1054     status = cf_util_get_string(ci, &st->name);
1055
1056   if (status != 0) {
1057     c_ipmi_free_instance(st);
1058     return status;
1059   }
1060
1061   for (int i = 0; i < ci->children_num; i++) {
1062     oconfig_item_t *child = ci->children + i;
1063
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) {
1067       _Bool t;
1068       status = cf_util_get_boolean(child, &t);
1069       if (status != 0)
1070         break;
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) {
1093       char tmp[8];
1094       status = cf_util_get_string_buffer(child, tmp, sizeof(tmp));
1095       if (status != 0)
1096         break;
1097
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;
1102       else
1103         WARNING("ipmi plugin: The value \"%s\" is not valid for the "
1104                 "\"AuthType\" option.",
1105                 tmp);
1106     } else {
1107       WARNING("ipmi plugin: Option `%s' not allowed here.", child->key);
1108       status = -1;
1109     }
1110
1111     if (status != 0)
1112       break;
1113   }
1114
1115   if (status != 0) {
1116     c_ipmi_free_instance(st);
1117     return status;
1118   }
1119
1120   c_ipmi_add_instance(st);
1121
1122   return 0;
1123 } /* int c_ipmi_config_add_instance */
1124
1125 static int c_ipmi_config(oconfig_item_t *ci) {
1126   _Bool have_instance_block = 0;
1127
1128   for (int i = 0; i < ci->children_num; i++) {
1129     oconfig_item_t *child = ci->children + i;
1130
1131     if (strcasecmp("Instance", child->key) == 0) {
1132       int status = c_ipmi_config_add_instance(child);
1133       if (status != 0)
1134         return status;
1135
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.
1140        */
1141       WARNING("ipmi plugin: Legacy configuration found! Please update your "
1142               "config file.");
1143       return c_ipmi_config_add_instance(ci);
1144     } else {
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?",
1149               child->key);
1150       return -1;
1151     }
1152   } /* for (ci->children) */
1153
1154   return 0;
1155 } /* int c_ipmi_config */
1156
1157 static int c_ipmi_read(user_data_t *user_data) {
1158   c_ipmi_instance_t *st = user_data->data;
1159
1160   if (st->active == 0) {
1161     INFO("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
1162     return -1;
1163   }
1164
1165   if (st->connected == 0)
1166     return 0;
1167
1168   sensor_list_read_all(st);
1169
1170   if (st->init_in_progress > 0)
1171     st->init_in_progress--;
1172   else
1173     st->init_in_progress = 0;
1174
1175   return 0;
1176 } /* int c_ipmi_read */
1177
1178 static int c_ipmi_init(void) {
1179   c_ipmi_instance_t *st;
1180   char callback_name[3 * DATA_MAX_NAME_LEN];
1181
1182   if (os_handler != NULL) {
1183     return 0;
1184   }
1185
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.");
1189     return -1;
1190   }
1191
1192   os_handler->set_log_handler(os_handler, c_ipmi_log);
1193
1194   if (ipmi_init(os_handler) != 0) {
1195     ERROR("ipmi plugin: ipmi_init() failed.");
1196     os_handler->free_os_handler(os_handler);
1197     return -1;
1198   };
1199
1200   if (instances == NULL) {
1201     /* No instances were configured, let's start a default instance. */
1202     st = c_ipmi_init_instance();
1203     if (st == NULL)
1204       return ENOMEM;
1205
1206     c_ipmi_add_instance(st);
1207   }
1208
1209   /* Don't send `ADD' notifications during startup (~ 1 minute) */
1210   int cycles = 1 + (60 / CDTIME_T_TO_TIME_T(plugin_get_interval()));
1211
1212   st = instances;
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);
1218
1219     user_data_t ud = {
1220         .data = st,
1221     };
1222
1223     int status = plugin_register_complex_read(
1224         /* group     = */ "ipmi",
1225         /* name      = */ callback_name,
1226         /* callback  = */ c_ipmi_read,
1227         /* interval  = */ 0,
1228         /* user_data = */ &ud);
1229
1230     if (status != 0) {
1231       st = st->next;
1232       continue;
1233     }
1234
1235     st->init_in_progress = cycles;
1236     st->active = 1;
1237
1238     status = plugin_thread_create(&st->thread_id, /* attr = */ NULL,
1239                                   c_ipmi_thread_main,
1240                                   /* user data = */ (void *)st, "ipmi");
1241
1242     if (status != 0) {
1243       st->active = 0;
1244       st->thread_id = (pthread_t){0};
1245
1246       plugin_unregister_read(callback_name);
1247
1248       ERROR("ipmi plugin: pthread_create failed for `%s`.", callback_name);
1249     }
1250
1251     st = st->next;
1252   }
1253
1254   return 0;
1255 } /* int c_ipmi_init */
1256
1257 static int c_ipmi_shutdown(void) {
1258   c_ipmi_instance_t *st = instances;
1259   instances = NULL;
1260
1261   while (st != NULL) {
1262     c_ipmi_instance_t *next = st->next;
1263
1264     st->next = NULL;
1265     st->active = 0;
1266
1267     if (!pthread_equal(st->thread_id, (pthread_t){0})) {
1268       pthread_join(st->thread_id, NULL);
1269       st->thread_id = (pthread_t){0};
1270     }
1271
1272     sensor_list_remove_all(st);
1273     c_ipmi_free_instance(st);
1274
1275     st = next;
1276   }
1277
1278   os_handler->free_os_handler(os_handler);
1279   os_handler = NULL;
1280
1281   return 0;
1282 } /* int c_ipmi_shutdown */
1283
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 */