Merge branch 'collectd-5.8'
[collectd.git] / 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;
99 static c_ipmi_instance_t *instances;
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 units (%#x, %#x, %#x). "
453          "Sensor type: (%#x, %s). If you need this sensor, please file "
454          "a bug report at http://collectd.org/.",
455          sensor_name_ptr, st->name, ipmi_sensor_get_base_unit(sensor),
456          ipmi_sensor_get_modifier_unit(sensor),
457          ipmi_sensor_get_rate_unit(sensor), sensor_type,
458          ipmi_sensor_get_sensor_type_string(sensor));
459     return -1;
460   }
461   } /* switch (sensor_type) */
462
463   pthread_mutex_lock(&st->sensor_list_lock);
464
465   list_prev = NULL;
466   for (list_item = st->sensor_list; list_item != NULL;
467        list_item = list_item->next) {
468     if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
469       break;
470     list_prev = list_item;
471   } /* for (list_item) */
472
473   if (list_item != NULL) {
474     pthread_mutex_unlock(&st->sensor_list_lock);
475     return 0;
476   }
477
478   list_item = (c_ipmi_sensor_list_t *)calloc(1, sizeof(c_ipmi_sensor_list_t));
479   if (list_item == NULL) {
480     pthread_mutex_unlock(&st->sensor_list_lock);
481     return -1;
482   }
483
484   list_item->instance = st;
485   list_item->sensor_id = ipmi_sensor_convert_to_id(sensor);
486
487   if (list_prev != NULL)
488     list_prev->next = list_item;
489   else
490     st->sensor_list = list_item;
491
492   /* if sensor provides the percentage value, use "percent" collectd type
493      and add the `percent` to the type instance of the reported value */
494   if (ipmi_sensor_get_percentage(sensor)) {
495     snprintf(list_item->type_instance, sizeof(list_item->type_instance),
496              "percent-%s", sensor_name_ptr);
497     type = "percent";
498   } else {
499     /* use type instance as a name of the sensor */
500     sstrncpy(list_item->type_instance, sensor_name_ptr,
501              sizeof(list_item->type_instance));
502   }
503
504   sstrncpy(list_item->sensor_name, sensor_name_ptr,
505            sizeof(list_item->sensor_name));
506   sstrncpy(list_item->sensor_type, type, sizeof(list_item->sensor_type));
507
508   pthread_mutex_unlock(&st->sensor_list_lock);
509
510   if (st->notify_add && (st->init_in_progress == 0)) {
511     notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
512
513     sstrncpy(n.type_instance, list_item->type_instance,
514              sizeof(n.type_instance));
515     sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
516     snprintf(n.message, sizeof(n.message), "sensor %s added",
517              list_item->sensor_name);
518
519     plugin_dispatch_notification(&n);
520   }
521
522   return 0;
523 } /* int sensor_list_add */
524
525 static int sensor_list_remove(c_ipmi_instance_t *st, ipmi_sensor_t *sensor) {
526   ipmi_sensor_id_t sensor_id;
527   c_ipmi_sensor_list_t *list_item;
528   c_ipmi_sensor_list_t *list_prev;
529
530   sensor_id = ipmi_sensor_convert_to_id(sensor);
531
532   pthread_mutex_lock(&st->sensor_list_lock);
533
534   list_prev = NULL;
535   for (list_item = st->sensor_list; list_item != NULL;
536        list_item = list_item->next) {
537     if (ipmi_cmp_sensor_id(sensor_id, list_item->sensor_id) == 0)
538       break;
539     list_prev = list_item;
540   } /* for (list_item) */
541
542   if (list_item == NULL) {
543     pthread_mutex_unlock(&st->sensor_list_lock);
544     return -1;
545   }
546
547   if (list_prev == NULL)
548     st->sensor_list = list_item->next;
549   else
550     list_prev->next = list_item->next;
551
552   list_prev = NULL;
553   list_item->next = NULL;
554
555   pthread_mutex_unlock(&st->sensor_list_lock);
556
557   if (st->notify_remove && st->active) {
558     notification_t n = c_ipmi_notification_init(st, NOTIF_WARNING);
559
560     sstrncpy(n.type_instance, list_item->type_instance,
561              sizeof(n.type_instance));
562     sstrncpy(n.type, list_item->sensor_type, sizeof(n.type));
563     snprintf(n.message, sizeof(n.message), "sensor %s removed",
564              list_item->sensor_name);
565
566     plugin_dispatch_notification(&n);
567   }
568
569   free(list_item);
570   return 0;
571 } /* int sensor_list_remove */
572
573 static int sensor_list_read_all(c_ipmi_instance_t *st) {
574   pthread_mutex_lock(&st->sensor_list_lock);
575
576   for (c_ipmi_sensor_list_t *list_item = st->sensor_list; list_item != NULL;
577        list_item = list_item->next) {
578     DEBUG("ipmi plugin: try read sensor `%s` of `%s`, use: %d",
579           list_item->sensor_name, st->name, list_item->use);
580
581     /* Reading already initiated */
582     if (list_item->use)
583       continue;
584
585     list_item->use++;
586     ipmi_sensor_id_get_reading(list_item->sensor_id, sensor_read_handler,
587                                /* user data = */ (void *)list_item);
588   } /* for (list_item) */
589
590   pthread_mutex_unlock(&st->sensor_list_lock);
591
592   return 0;
593 } /* int sensor_list_read_all */
594
595 static int sensor_list_remove_all(c_ipmi_instance_t *st) {
596   c_ipmi_sensor_list_t *list_item;
597
598   pthread_mutex_lock(&st->sensor_list_lock);
599
600   list_item = st->sensor_list;
601   st->sensor_list = NULL;
602
603   pthread_mutex_unlock(&st->sensor_list_lock);
604
605   while (list_item != NULL) {
606     c_ipmi_sensor_list_t *list_next = list_item->next;
607
608     free(list_item);
609
610     list_item = list_next;
611   } /* while (list_item) */
612
613   return 0;
614 } /* int sensor_list_remove_all */
615
616 static int sensor_convert_threshold_severity(enum ipmi_thresh_e severity) {
617   switch (severity) {
618   case IPMI_LOWER_NON_CRITICAL:
619   case IPMI_UPPER_NON_CRITICAL:
620     return NOTIF_OKAY;
621   case IPMI_LOWER_CRITICAL:
622   case IPMI_UPPER_CRITICAL:
623     return NOTIF_WARNING;
624   case IPMI_LOWER_NON_RECOVERABLE:
625   case IPMI_UPPER_NON_RECOVERABLE:
626     return NOTIF_FAILURE;
627   default:
628     return NOTIF_OKAY;
629   } /* switch (severity) */
630 } /* int sensor_convert_threshold_severity */
631
632 static void add_event_common_data(notification_t *n, ipmi_sensor_t *sensor,
633                                   enum ipmi_event_dir_e dir,
634                                   ipmi_event_t *event) {
635   ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
636
637   plugin_notification_meta_add_string(n, "entity_name",
638                                       ipmi_entity_get_entity_id_string(ent));
639   plugin_notification_meta_add_signed_int(n, "entity_id",
640                                           ipmi_entity_get_entity_id(ent));
641   plugin_notification_meta_add_signed_int(n, "entity_instance",
642                                           ipmi_entity_get_entity_instance(ent));
643   plugin_notification_meta_add_boolean(n, "assert", dir == IPMI_ASSERTION);
644
645   if (event)
646     plugin_notification_meta_add_signed_int(n, "event_type",
647                                             ipmi_event_get_type(event));
648 } /* void add_event_sensor_meta_data */
649
650 static int sensor_threshold_event_handler(
651     ipmi_sensor_t *sensor, enum ipmi_event_dir_e dir,
652     enum ipmi_thresh_e threshold, enum ipmi_event_value_dir_e high_low,
653     enum ipmi_value_present_e value_present, unsigned int raw_value,
654     double value, void *cb_data, ipmi_event_t *event) {
655
656   c_ipmi_instance_t *st = cb_data;
657
658   /* From the IPMI specification Chapter 2: Events.
659    * If a callback handles the event, then all future callbacks called due to
660    * the event will receive a NULL for the event. So be ready to handle a NULL
661    * event in all your event handlers. A NULL may also be passed to an event
662    * handler if the callback was not due to an event. */
663   if (event == NULL)
664     return IPMI_EVENT_NOT_HANDLED;
665
666   notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
667   /* offset is a table index and it's represented as enum of strings that are
668      organized in the way - high and low for each threshold severity level */
669   unsigned int offset = (2 * threshold) + high_low;
670   unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
671   unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
672   const char *event_state =
673       ipmi_get_reading_name(event_type, sensor_type, offset);
674   sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
675   if (value_present != IPMI_NO_VALUES_PRESENT)
676     snprintf(n.message, sizeof(n.message),
677              "sensor %s received event: %s, value is %f", n.type_instance,
678              event_state, value);
679   else
680     snprintf(n.message, sizeof(n.message),
681              "sensor %s received event: %s, value not provided",
682              n.type_instance, event_state);
683
684   DEBUG("Threshold event received for sensor %s", n.type_instance);
685
686   sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
687   n.severity = sensor_convert_threshold_severity(threshold);
688   n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
689
690   plugin_notification_meta_add_string(&n, "severity",
691                                       ipmi_get_threshold_string(threshold));
692   plugin_notification_meta_add_string(&n, "direction",
693                                       ipmi_get_value_dir_string(high_low));
694
695   switch (value_present) {
696   case IPMI_BOTH_VALUES_PRESENT:
697     plugin_notification_meta_add_double(&n, "val", value);
698   /* both values present, so fall-through to add raw value too */
699   case IPMI_RAW_VALUE_PRESENT: {
700     char buf[DATA_MAX_NAME_LEN] = {0};
701     snprintf(buf, sizeof(buf), "0x%2.2x", raw_value);
702     plugin_notification_meta_add_string(&n, "raw", buf);
703   } break;
704   default:
705     break;
706   } /* switch (value_present) */
707
708   add_event_common_data(&n, sensor, dir, event);
709
710   plugin_dispatch_notification(&n);
711   plugin_notification_meta_free(n.meta);
712
713   /* Delete handled ipmi event from the list */
714   if (st->sel_clear_event) {
715     ipmi_event_delete(event, NULL, NULL);
716     return IPMI_EVENT_HANDLED;
717   }
718
719   return IPMI_EVENT_NOT_HANDLED;
720 } /* int sensor_threshold_event_handler */
721
722 static int sensor_discrete_event_handler(ipmi_sensor_t *sensor,
723                                          enum ipmi_event_dir_e dir, int offset,
724                                          int severity, int prev_severity,
725                                          void *cb_data, ipmi_event_t *event) {
726
727   c_ipmi_instance_t *st = cb_data;
728
729   /* From the IPMI specification Chapter 2: Events.
730    * If a callback handles the event, then all future callbacks called due to
731    * the event will receive a NULL for the event. So be ready to handle a NULL
732    * event in all your event handlers. A NULL may also be passed to an event
733    * handler if the callback was not due to an event. */
734   if (event == NULL)
735     return IPMI_EVENT_NOT_HANDLED;
736
737   notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
738   unsigned int event_type = ipmi_sensor_get_event_reading_type(sensor);
739   unsigned int sensor_type = ipmi_sensor_get_sensor_type(sensor);
740   const char *event_state =
741       ipmi_get_reading_name(event_type, sensor_type, offset);
742   sensor_get_name(sensor, n.type_instance, sizeof(n.type_instance));
743   snprintf(n.message, sizeof(n.message), "sensor %s received event: %s",
744            n.type_instance, event_state);
745
746   DEBUG("Discrete event received for sensor %s", n.type_instance);
747
748   sstrncpy(n.type, ipmi_sensor_get_sensor_type_string(sensor), sizeof(n.type));
749   n.time = NS_TO_CDTIME_T(ipmi_event_get_timestamp(event));
750
751   plugin_notification_meta_add_signed_int(&n, "offset", offset);
752
753   if (severity != -1)
754     plugin_notification_meta_add_signed_int(&n, "severity", severity);
755
756   if (prev_severity != -1)
757     plugin_notification_meta_add_signed_int(&n, "prevseverity", prev_severity);
758
759   add_event_common_data(&n, sensor, dir, event);
760
761   plugin_dispatch_notification(&n);
762   plugin_notification_meta_free(n.meta);
763
764   /* Delete handled ipmi event from the list */
765   if (st->sel_clear_event) {
766     ipmi_event_delete(event, NULL, NULL);
767     return IPMI_EVENT_HANDLED;
768   }
769
770   return IPMI_EVENT_NOT_HANDLED;
771 } /* int sensor_discrete_event_handler */
772
773 /*
774  * Entity handlers
775  */
776 static void
777 entity_sensor_update_handler(enum ipmi_update_e op,
778                              ipmi_entity_t __attribute__((unused)) * entity,
779                              ipmi_sensor_t *sensor, void *user_data) {
780   c_ipmi_instance_t *st = user_data;
781
782   if ((op == IPMI_ADDED) || (op == IPMI_CHANGED)) {
783     /* Will check for duplicate entries.. */
784     sensor_list_add(st, sensor);
785
786     if (st->sel_enabled) {
787       int status = 0;
788       /* register threshold event handler */
789       if (ipmi_sensor_get_event_reading_type(sensor) ==
790           IPMI_EVENT_READING_TYPE_THRESHOLD)
791         status = ipmi_sensor_add_threshold_event_handler(
792             sensor, sensor_threshold_event_handler, st);
793       /* register discrete handler if discrete/specific sensor support events */
794       else if (ipmi_sensor_get_event_support(sensor) != IPMI_EVENT_SUPPORT_NONE)
795         status = ipmi_sensor_add_discrete_event_handler(
796             sensor, sensor_discrete_event_handler, st);
797
798       if (status) {
799         char buf[DATA_MAX_NAME_LEN] = {0};
800         sensor_get_name(sensor, buf, sizeof(buf));
801         ERROR("Unable to add sensor %s event handler, status: %d", buf, status);
802       }
803     }
804   } else if (op == IPMI_DELETED) {
805     sensor_list_remove(st, sensor);
806
807     if (st->sel_enabled) {
808       if (ipmi_sensor_get_event_reading_type(sensor) ==
809           IPMI_EVENT_READING_TYPE_THRESHOLD)
810         ipmi_sensor_remove_threshold_event_handler(
811             sensor, sensor_threshold_event_handler, st);
812       else
813         ipmi_sensor_remove_discrete_event_handler(
814             sensor, sensor_discrete_event_handler, st);
815     }
816   }
817 } /* void entity_sensor_update_handler */
818
819 /*
820  * Domain handlers
821  */
822 static void
823 domain_entity_update_handler(enum ipmi_update_e op,
824                              ipmi_domain_t __attribute__((unused)) * domain,
825                              ipmi_entity_t *entity, void *user_data) {
826   int status;
827   c_ipmi_instance_t *st = user_data;
828
829   if (op == IPMI_ADDED) {
830     status = ipmi_entity_add_sensor_update_handler(
831         entity, entity_sensor_update_handler, /* user data = */ (void *)st);
832     if (status != 0) {
833       c_ipmi_error(st, "ipmi_entity_add_sensor_update_handler", status);
834     }
835   } else if (op == IPMI_DELETED) {
836     status = ipmi_entity_remove_sensor_update_handler(
837         entity, entity_sensor_update_handler, /* user data = */ (void *)st);
838     if (status != 0) {
839       c_ipmi_error(st, "ipmi_entity_remove_sensor_update_handler", status);
840     }
841   }
842 } /* void domain_entity_update_handler */
843
844 static void smi_event_handler(ipmi_con_t __attribute__((unused)) * ipmi,
845                               const ipmi_addr_t __attribute__((unused)) * addr,
846                               unsigned int __attribute__((unused)) addr_len,
847                               ipmi_event_t *event, void *cb_data) {
848   unsigned int type = ipmi_event_get_type(event);
849   ipmi_domain_t *domain = cb_data;
850
851   DEBUG("%s: Event received: type %u", __FUNCTION__, type);
852
853   if (type != 0x02)
854     /* It's not a standard IPMI event. */
855     return;
856
857   /* force domain to reread SELs */
858   ipmi_domain_reread_sels(domain, NULL, NULL);
859 }
860
861 static void domain_connection_change_handler(ipmi_domain_t *domain, int err,
862                                              unsigned int conn_num,
863                                              unsigned int port_num,
864                                              int still_connected,
865                                              void *user_data) {
866
867   DEBUG("domain_connection_change_handler (domain = %p, err = %i, "
868         "conn_num = %u, port_num = %u, still_connected = %i, "
869         "user_data = %p);",
870         (void *)domain, err, conn_num, port_num, still_connected, user_data);
871
872   c_ipmi_instance_t *st = user_data;
873
874   if (err != 0)
875     c_ipmi_error(st, "domain_connection_change_handler", err);
876
877   if (!still_connected) {
878
879     if (st->notify_conn && st->connected && st->init_in_progress == 0) {
880       notification_t n = c_ipmi_notification_init(st, NOTIF_FAILURE);
881
882       sstrncpy(n.message, "IPMI connection lost", sizeof(n.plugin));
883
884       plugin_dispatch_notification(&n);
885     }
886
887     st->connected = false;
888     return;
889   }
890
891   if (st->notify_conn && !st->connected && st->init_in_progress == 0) {
892     notification_t n = c_ipmi_notification_init(st, NOTIF_OKAY);
893
894     sstrncpy(n.message, "IPMI connection restored", sizeof(n.plugin));
895
896     plugin_dispatch_notification(&n);
897   }
898
899   st->connected = true;
900
901   int status = ipmi_domain_add_entity_update_handler(
902       domain, domain_entity_update_handler, /* user data = */ st);
903   if (status != 0) {
904     c_ipmi_error(st, "ipmi_domain_add_entity_update_handler", status);
905   }
906
907   status = st->connection->add_event_handler(st->connection, smi_event_handler,
908                                              (void *)domain);
909
910   if (status != 0)
911     c_ipmi_error(st, "Failed to register smi event handler", status);
912 } /* void domain_connection_change_handler */
913
914 static int c_ipmi_thread_init(c_ipmi_instance_t *st) {
915   ipmi_domain_id_t domain_id;
916   int status;
917
918   if (st->connaddr != NULL) {
919     status = ipmi_ip_setup_con(
920         &st->connaddr, &(char *){IPMI_LAN_STD_PORT_STR}, 1, st->authtype,
921         (unsigned int)IPMI_PRIVILEGE_USER, st->username, strlen(st->username),
922         st->password, strlen(st->password), os_handler,
923         /* user data = */ NULL, &st->connection);
924     if (status != 0) {
925       c_ipmi_error(st, "ipmi_ip_setup_con", status);
926       return -1;
927     }
928   } else {
929     status = ipmi_smi_setup_con(/* if_num = */ 0, os_handler,
930                                 /* user data = */ NULL, &st->connection);
931     if (status != 0) {
932       c_ipmi_error(st, "ipmi_smi_setup_con", status);
933       return -1;
934     }
935   }
936
937   ipmi_open_option_t opts[] = {
938       {.option = IPMI_OPEN_OPTION_ALL, {.ival = 1}},
939 #ifdef IPMI_OPEN_OPTION_USE_CACHE
940       /* OpenIPMI-2.0.17 and later: Disable SDR cache in local file */
941       {.option = IPMI_OPEN_OPTION_USE_CACHE, {.ival = 0}},
942 #endif
943   };
944
945   /*
946    * NOTE: Domain names must be unique. There is static `domains_list` common
947    * to all threads inside lib/domain.c and some ops are done by name.
948    */
949   status = ipmi_open_domain(
950       st->name, &st->connection, /* num_con = */ 1,
951       domain_connection_change_handler, /* user data = */ (void *)st,
952       /* domain_fully_up_handler = */ NULL, /* user data = */ NULL, opts,
953       STATIC_ARRAY_SIZE(opts), &domain_id);
954   if (status != 0) {
955     c_ipmi_error(st, "ipmi_open_domain", status);
956     return -1;
957   }
958
959   return 0;
960 } /* int c_ipmi_thread_init */
961
962 static void *c_ipmi_thread_main(void *user_data) {
963   c_ipmi_instance_t *st = user_data;
964
965   int status = c_ipmi_thread_init(st);
966   if (status != 0) {
967     ERROR("ipmi plugin: c_ipmi_thread_init failed.");
968     st->active = false;
969     return (void *)-1;
970   }
971
972   while (st->active) {
973     struct timeval tv = {1, 0};
974     os_handler->perform_one_op(os_handler, &tv);
975   }
976   return (void *)0;
977 } /* void *c_ipmi_thread_main */
978
979 static c_ipmi_instance_t *c_ipmi_init_instance() {
980   c_ipmi_instance_t *st;
981
982   st = calloc(1, sizeof(*st));
983   if (st == NULL) {
984     ERROR("ipmi plugin: calloc failed.");
985     return NULL;
986   }
987
988   st->name = strdup("main");
989   if (st->name == NULL) {
990     sfree(st);
991     ERROR("ipmi plugin: strdup() failed.");
992     return NULL;
993   }
994
995   st->ignorelist = ignorelist_create(/* invert = */ 1);
996   if (st->ignorelist == NULL) {
997     sfree(st->name);
998     sfree(st);
999     ERROR("ipmi plugin: ignorelist_create() failed.");
1000     return NULL;
1001   }
1002
1003   st->sensor_list = NULL;
1004   pthread_mutex_init(&st->sensor_list_lock, /* attr = */ NULL);
1005
1006   st->host = NULL;
1007   st->connaddr = NULL;
1008   st->username = NULL;
1009   st->password = NULL;
1010   st->authtype = IPMI_AUTHTYPE_DEFAULT;
1011
1012   st->next = NULL;
1013
1014   return st;
1015 } /* c_ipmi_instance_t *c_ipmi_init_instance */
1016
1017 static void c_ipmi_free_instance(c_ipmi_instance_t *st) {
1018   if (st == NULL)
1019     return;
1020
1021   assert(st->next == NULL);
1022
1023   sfree(st->name);
1024   sfree(st->host);
1025   sfree(st->connaddr);
1026   sfree(st->username);
1027   sfree(st->password);
1028
1029   ignorelist_free(st->ignorelist);
1030   pthread_mutex_destroy(&st->sensor_list_lock);
1031   sfree(st);
1032 } /* void c_ipmi_free_instance */
1033
1034 static void c_ipmi_add_instance(c_ipmi_instance_t *instance) {
1035   if (instances == NULL) {
1036     instances = instance;
1037     return;
1038   }
1039
1040   c_ipmi_instance_t *last = instances;
1041
1042   while (last->next != NULL)
1043     last = last->next;
1044
1045   last->next = instance;
1046 } /* void c_ipmi_add_instance */
1047
1048 static int c_ipmi_config_add_instance(oconfig_item_t *ci) {
1049   int status = 0;
1050   c_ipmi_instance_t *st = c_ipmi_init_instance();
1051   if (st == NULL)
1052     return ENOMEM;
1053
1054   if (strcasecmp(ci->key, "Instance") == 0)
1055     status = cf_util_get_string(ci, &st->name);
1056
1057   if (status != 0) {
1058     c_ipmi_free_instance(st);
1059     return status;
1060   }
1061
1062   for (int i = 0; i < ci->children_num; i++) {
1063     oconfig_item_t *child = ci->children + i;
1064
1065     if (strcasecmp("Sensor", child->key) == 0) {
1066       char *value = NULL;
1067       status = cf_util_get_string(child, &value);
1068       if (status != 0)
1069         break;
1070       ignorelist_add(st->ignorelist, value);
1071       sfree(value);
1072     } else if (strcasecmp("IgnoreSelected", child->key) == 0) {
1073       bool t;
1074       status = cf_util_get_boolean(child, &t);
1075       if (status != 0)
1076         break;
1077       ignorelist_set_invert(st->ignorelist, /* invert = */ !t);
1078     } else if (strcasecmp("NotifyIPMIConnectionState", child->key) == 0) {
1079       status = cf_util_get_boolean(child, &st->notify_conn);
1080     } else if (strcasecmp("NotifySensorAdd", child->key) == 0) {
1081       status = cf_util_get_boolean(child, &st->notify_add);
1082     } else if (strcasecmp("NotifySensorRemove", child->key) == 0) {
1083       status = cf_util_get_boolean(child, &st->notify_remove);
1084     } else if (strcasecmp("NotifySensorNotPresent", child->key) == 0) {
1085       status = cf_util_get_boolean(child, &st->notify_notpresent);
1086     } else if (strcasecmp("SELEnabled", child->key) == 0) {
1087       status = cf_util_get_boolean(child, &st->sel_enabled);
1088     } else if (strcasecmp("SELClearEvent", child->key) == 0) {
1089       status = cf_util_get_boolean(child, &st->sel_clear_event);
1090     } else if (strcasecmp("Host", child->key) == 0)
1091       status = cf_util_get_string(child, &st->host);
1092     else if (strcasecmp("Address", child->key) == 0)
1093       status = cf_util_get_string(child, &st->connaddr);
1094     else if (strcasecmp("Username", child->key) == 0)
1095       status = cf_util_get_string(child, &st->username);
1096     else if (strcasecmp("Password", child->key) == 0)
1097       status = cf_util_get_string(child, &st->password);
1098     else if (strcasecmp("AuthType", child->key) == 0) {
1099       char tmp[8];
1100       status = cf_util_get_string_buffer(child, tmp, sizeof(tmp));
1101       if (status != 0)
1102         break;
1103
1104       if (strcasecmp("MD5", tmp) == 0)
1105         st->authtype = IPMI_AUTHTYPE_MD5;
1106       else if (strcasecmp("rmcp+", tmp) == 0)
1107         st->authtype = IPMI_AUTHTYPE_RMCP_PLUS;
1108       else
1109         WARNING("ipmi plugin: The value \"%s\" is not valid for the "
1110                 "\"AuthType\" option.",
1111                 tmp);
1112     } else {
1113       WARNING("ipmi plugin: Option `%s' not allowed here.", child->key);
1114       status = -1;
1115     }
1116
1117     if (status != 0)
1118       break;
1119   }
1120
1121   if (status != 0) {
1122     c_ipmi_free_instance(st);
1123     return status;
1124   }
1125
1126   c_ipmi_add_instance(st);
1127
1128   return 0;
1129 } /* int c_ipmi_config_add_instance */
1130
1131 static int c_ipmi_config(oconfig_item_t *ci) {
1132   bool have_instance_block = 0;
1133
1134   for (int i = 0; i < ci->children_num; i++) {
1135     oconfig_item_t *child = ci->children + i;
1136
1137     if (strcasecmp("Instance", child->key) == 0) {
1138       int status = c_ipmi_config_add_instance(child);
1139       if (status != 0)
1140         return status;
1141
1142       have_instance_block = 1;
1143     } else if (!have_instance_block) {
1144       /* Non-instance option: Assume legacy configuration (without <Instance />
1145        * blocks) and call c_ipmi_config_add_instance with the <Plugin /> block.
1146        */
1147       WARNING("ipmi plugin: Legacy configuration found! Please update your "
1148               "config file.");
1149       return c_ipmi_config_add_instance(ci);
1150     } else {
1151       WARNING("ipmi plugin: The configuration option "
1152               "\"%s\" is not allowed here. Did you "
1153               "forget to add an <Instance /> block "
1154               "around the configuration?",
1155               child->key);
1156       return -1;
1157     }
1158   } /* for (ci->children) */
1159
1160   return 0;
1161 } /* int c_ipmi_config */
1162
1163 static int c_ipmi_read(user_data_t *user_data) {
1164   c_ipmi_instance_t *st = user_data->data;
1165
1166   if (st->active == false) {
1167     INFO("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
1168     return -1;
1169   }
1170
1171   if (st->connected == false)
1172     return 0;
1173
1174   sensor_list_read_all(st);
1175
1176   if (st->init_in_progress > 0)
1177     st->init_in_progress--;
1178   else
1179     st->init_in_progress = 0;
1180
1181   return 0;
1182 } /* int c_ipmi_read */
1183
1184 static int c_ipmi_init(void) {
1185   c_ipmi_instance_t *st;
1186   char callback_name[3 * DATA_MAX_NAME_LEN];
1187
1188   if (os_handler != NULL) {
1189     return 0;
1190   }
1191
1192   os_handler = ipmi_posix_thread_setup_os_handler(SIGIO);
1193   if (os_handler == NULL) {
1194     ERROR("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
1195     return -1;
1196   }
1197
1198   os_handler->set_log_handler(os_handler, c_ipmi_log);
1199
1200   if (ipmi_init(os_handler) != 0) {
1201     ERROR("ipmi plugin: ipmi_init() failed.");
1202     os_handler->free_os_handler(os_handler);
1203     return -1;
1204   };
1205
1206   if (instances == NULL) {
1207     /* No instances were configured, let's start a default instance. */
1208     st = c_ipmi_init_instance();
1209     if (st == NULL)
1210       return ENOMEM;
1211
1212     c_ipmi_add_instance(st);
1213   }
1214
1215   /* Don't send `ADD' notifications during startup (~ 1 minute) */
1216   int cycles = 1 + (int)(TIME_T_TO_CDTIME_T(60) / plugin_get_interval());
1217
1218   st = instances;
1219   while (NULL != st) {
1220     /* The `st->name` is used as "domain name" for ipmi_open_domain().
1221      * That value should be unique, so we do plugin_register_complex_read()
1222      * at first as it checks the uniqueness. */
1223     snprintf(callback_name, sizeof(callback_name), "ipmi/%s", st->name);
1224
1225     user_data_t ud = {
1226         .data = st,
1227     };
1228
1229     int status = plugin_register_complex_read(
1230         /* group     = */ "ipmi",
1231         /* name      = */ callback_name,
1232         /* callback  = */ c_ipmi_read,
1233         /* interval  = */ 0,
1234         /* user_data = */ &ud);
1235
1236     if (status != 0) {
1237       st = st->next;
1238       continue;
1239     }
1240
1241     st->init_in_progress = cycles;
1242     st->active = true;
1243
1244     status = plugin_thread_create(&st->thread_id, /* attr = */ NULL,
1245                                   c_ipmi_thread_main,
1246                                   /* user data = */ (void *)st, "ipmi");
1247
1248     if (status != 0) {
1249       st->active = false;
1250       st->thread_id = (pthread_t){0};
1251
1252       plugin_unregister_read(callback_name);
1253
1254       ERROR("ipmi plugin: pthread_create failed for `%s`.", callback_name);
1255     }
1256
1257     st = st->next;
1258   }
1259
1260   return 0;
1261 } /* int c_ipmi_init */
1262
1263 static int c_ipmi_shutdown(void) {
1264   c_ipmi_instance_t *st = instances;
1265   instances = NULL;
1266
1267   while (st != NULL) {
1268     c_ipmi_instance_t *next = st->next;
1269
1270     st->next = NULL;
1271     st->active = false;
1272
1273     if (!pthread_equal(st->thread_id, (pthread_t){0})) {
1274       pthread_join(st->thread_id, NULL);
1275       st->thread_id = (pthread_t){0};
1276     }
1277
1278     sensor_list_remove_all(st);
1279     c_ipmi_free_instance(st);
1280
1281     st = next;
1282   }
1283
1284   os_handler->free_os_handler(os_handler);
1285   os_handler = NULL;
1286
1287   return 0;
1288 } /* int c_ipmi_shutdown */
1289
1290 void module_register(void) {
1291   plugin_register_complex_config("ipmi", c_ipmi_config);
1292   plugin_register_init("ipmi", c_ipmi_init);
1293   plugin_register_shutdown("ipmi", c_ipmi_shutdown);
1294 } /* void module_register */