2 * collectd - src/ipmi.c
3 * Copyright (C) 2008 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
25 #include "utils_ignorelist.h"
29 #include <OpenIPMI/ipmiif.h>
30 #include <OpenIPMI/ipmi_err.h>
31 #include <OpenIPMI/ipmi_posix.h>
32 #include <OpenIPMI/ipmi_conn.h>
33 #include <OpenIPMI/ipmi_smi.h>
38 struct c_ipmi_sensor_list_s;
39 typedef struct c_ipmi_sensor_list_s c_ipmi_sensor_list_t;
41 struct c_ipmi_sensor_list_s
43 ipmi_sensor_id_t sensor_id;
44 c_ipmi_sensor_list_t *next;
48 * Module global variables
50 static pthread_mutex_t sensor_list_lock = PTHREAD_MUTEX_INITIALIZER;
51 static c_ipmi_sensor_list_t *sensor_list = NULL;
53 static int c_ipmi_active = 0;
54 static pthread_t thread_id = (pthread_t) 0;
56 static const char *config_keys[] =
61 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
63 static ignorelist_t *ignorelist = NULL;
66 * Misc private functions
68 static void c_ipmi_error (const char *func, int status)
72 memset (errbuf, 0, sizeof (errbuf));
74 if (IPMI_IS_OS_ERR (status))
76 sstrerror (IPMI_GET_OS_ERR (status), errbuf, sizeof (errbuf));
78 else if (IPMI_IS_IPMI_ERR (status))
80 ipmi_get_error_string (IPMI_GET_IPMI_ERR (status), errbuf, sizeof (errbuf));
85 ssnprintf (errbuf, sizeof (errbuf), "Unknown error %#x", status);
87 errbuf[sizeof (errbuf) - 1] = 0;
89 ERROR ("ipmi plugin: %s failed: %s", func, errbuf);
90 } /* void c_ipmi_error */
95 /* Prototype for sensor_list_remove, so sensor_read_handler can call it. */
96 static int sensor_list_remove (ipmi_sensor_t *sensor);
98 static void sensor_read_handler (ipmi_sensor_t *sensor,
100 enum ipmi_value_present_e value_present,
101 unsigned int raw_value,
103 ipmi_states_t *states,
107 value_list_t vl = VALUE_LIST_INIT;
109 char sensor_name[IPMI_SENSOR_NAME_LEN];
110 char *sensor_name_ptr;
114 memset (sensor_name, 0, sizeof (sensor_name));
115 ipmi_sensor_get_name (sensor, sensor_name, sizeof (sensor_name));
116 sensor_name[sizeof (sensor_name) - 1] = 0;
118 sensor_name_ptr = strstr (sensor_name, ").");
119 if (sensor_name_ptr == NULL)
120 sensor_name_ptr = sensor_name;
122 sensor_name_ptr += 2;
126 INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
127 "because it failed with status %#x.",
128 sensor_name_ptr, err);
129 sensor_list_remove (sensor);
133 if (value_present != IPMI_BOTH_VALUES_PRESENT)
135 INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
136 "because it provides %s. If you need this sensor, "
137 "please file a bug report.",
139 (value_present == IPMI_RAW_VALUE_PRESENT)
140 ? "only the raw value"
142 sensor_list_remove (sensor);
146 /* Both `ignorelist' and `plugin_instance' may be NULL. */
147 if (ignorelist_match (ignorelist, sensor_name_ptr) != 0)
149 sensor_list_remove (sensor);
153 /* FIXME: Use rate unit or base unit to scale the value */
155 sensor_type = ipmi_sensor_get_sensor_type (sensor);
158 case IPMI_SENSOR_TYPE_TEMPERATURE:
159 type = "temperature";
162 case IPMI_SENSOR_TYPE_VOLTAGE:
166 case IPMI_SENSOR_TYPE_CURRENT:
170 case IPMI_SENSOR_TYPE_FAN:
176 const char *sensor_type_str;
178 sensor_type_str = ipmi_sensor_get_sensor_type_string (sensor);
179 INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
180 "because I don't know how to handle its type (%#x, %s). "
181 "If you need this sensor, please file a bug report.",
182 sensor_name_ptr, sensor_type, sensor_type_str);
183 sensor_list_remove (sensor);
186 } /* switch (sensor_type) */
188 values[0].gauge = value;
192 vl.time = time (NULL);
194 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
195 sstrncpy (vl.plugin, "ipmi", sizeof (vl.plugin));
196 sstrncpy (vl.type_instance, sensor_name_ptr, sizeof (vl.type_instance));
198 plugin_dispatch_values (type, &vl);
199 } /* void sensor_read_handler */
201 static int sensor_list_add (ipmi_sensor_t *sensor)
203 ipmi_sensor_id_t sensor_id;
204 c_ipmi_sensor_list_t *list_item;
205 c_ipmi_sensor_list_t *list_prev;
207 sensor_id = ipmi_sensor_convert_to_id (sensor);
209 pthread_mutex_lock (&sensor_list_lock);
212 for (list_item = sensor_list;
214 list_item = list_item->next)
216 if (ipmi_cmp_sensor_id (sensor_id, list_item->sensor_id) == 0)
218 list_prev = list_item;
219 } /* for (list_item) */
221 if (list_item != NULL)
223 pthread_mutex_unlock (&sensor_list_lock);
227 list_item = (c_ipmi_sensor_list_t *) calloc (1, sizeof (c_ipmi_sensor_list_t));
228 if (list_item == NULL)
230 pthread_mutex_unlock (&sensor_list_lock);
234 list_item->sensor_id = ipmi_sensor_convert_to_id (sensor);
236 if (list_prev != NULL)
237 list_prev->next = list_item;
239 sensor_list = list_item;
241 pthread_mutex_unlock (&sensor_list_lock);
244 } /* int sensor_list_add */
246 static int sensor_list_remove (ipmi_sensor_t *sensor)
248 ipmi_sensor_id_t sensor_id;
249 c_ipmi_sensor_list_t *list_item;
250 c_ipmi_sensor_list_t *list_prev;
252 sensor_id = ipmi_sensor_convert_to_id (sensor);
254 pthread_mutex_lock (&sensor_list_lock);
257 for (list_item = sensor_list;
259 list_item = list_item->next)
261 if (ipmi_cmp_sensor_id (sensor_id, list_item->sensor_id) == 0)
263 list_prev = list_item;
264 } /* for (list_item) */
266 if (list_item == NULL)
268 pthread_mutex_unlock (&sensor_list_lock);
272 if (list_prev == NULL)
273 sensor_list = list_item->next;
275 list_prev->next = list_item->next;
278 list_item->next = NULL;
280 pthread_mutex_unlock (&sensor_list_lock);
284 } /* int sensor_list_remove */
286 static int sensor_list_read_all (void)
288 c_ipmi_sensor_list_t *list_item;
290 pthread_mutex_lock (&sensor_list_lock);
292 for (list_item = sensor_list;
294 list_item = list_item->next)
296 ipmi_sensor_id_get_reading (list_item->sensor_id,
297 sensor_read_handler, /* user data = */ NULL);
298 } /* for (list_item) */
300 pthread_mutex_unlock (&sensor_list_lock);
303 } /* int sensor_list_read_all */
305 static int sensor_list_remove_all (void)
307 c_ipmi_sensor_list_t *list_item;
309 pthread_mutex_lock (&sensor_list_lock);
311 list_item = sensor_list;
314 pthread_mutex_unlock (&sensor_list_lock);
316 while (list_item != NULL)
318 c_ipmi_sensor_list_t *list_next = list_item->next;
322 list_item = list_next;
323 } /* while (list_item) */
326 } /* int sensor_list_remove_all */
331 static void entity_sensor_update_handler (enum ipmi_update_e op,
332 ipmi_entity_t *entity,
333 ipmi_sensor_t *sensor,
336 /* TODO: Ignore sensors we cannot read */
338 if ((op == IPMI_ADDED) || (op == IPMI_CHANGED))
340 /* Will check for duplicate entries.. */
341 sensor_list_add (sensor);
343 else if (op == IPMI_DELETED)
345 sensor_list_remove (sensor);
347 } /* void entity_sensor_update_handler */
352 static void domain_entity_update_handler (enum ipmi_update_e op,
353 ipmi_domain_t *domain,
354 ipmi_entity_t *entity,
359 if (op == IPMI_ADDED)
361 status = ipmi_entity_add_sensor_update_handler (entity,
362 entity_sensor_update_handler, /* user data = */ NULL);
365 c_ipmi_error ("ipmi_entity_add_sensor_update_handler", status);
368 else if (op == IPMI_DELETED)
370 status = ipmi_entity_remove_sensor_update_handler (entity,
371 entity_sensor_update_handler, /* user data = */ NULL);
374 c_ipmi_error ("ipmi_entity_remove_sensor_update_handler", status);
377 } /* void domain_entity_update_handler */
379 static void domain_connection_change_handler (ipmi_domain_t *domain,
381 unsigned int conn_num,
382 unsigned int port_num,
388 DEBUG ("domain_connection_change_handler (domain = %p, err = %i, "
389 "conn_num = %u, port_num = %u, still_connected = %i, "
390 "user_data = %p);\n",
391 (void *) domain, err, conn_num, port_num, still_connected, user_data);
393 status = ipmi_domain_add_entity_update_handler (domain,
394 domain_entity_update_handler, /* user data = */ NULL);
397 c_ipmi_error ("ipmi_domain_add_entity_update_handler", status);
399 } /* void domain_connection_change_handler */
401 static int thread_init (os_handler_t **ret_os_handler)
403 os_handler_t *os_handler;
404 ipmi_open_option_t open_option[1];
405 ipmi_con_t *smi_connection = NULL;
406 ipmi_domain_id_t domain_id;
409 os_handler = ipmi_posix_thread_setup_os_handler (SIGUSR2);
410 if (os_handler == NULL)
412 ERROR ("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
416 ipmi_init (os_handler);
418 status = ipmi_smi_setup_con (/* if_num = */ 0,
420 /* user data = */ NULL,
424 c_ipmi_error ("ipmi_smi_setup_con", status);
428 memset (open_option, 0, sizeof (open_option));
429 open_option[0].option = IPMI_OPEN_OPTION_ALL;
430 open_option[0].ival = 1;
432 status = ipmi_open_domain ("mydomain", &smi_connection, /* num_con = */ 1,
433 domain_connection_change_handler, /* user data = */ NULL,
434 /* domain_fully_up_handler = */ NULL, /* user data = */ NULL,
435 open_option, sizeof (open_option) / sizeof (open_option[0]),
439 c_ipmi_error ("ipmi_open_domain", status);
443 *ret_os_handler = os_handler;
445 } /* int thread_init */
447 static void *thread_main (void *user_data)
450 os_handler_t *os_handler = NULL;
452 status = thread_init (&os_handler);
455 ERROR ("ipmi plugin: thread_init failed.\n");
456 return ((void *) -1);
459 while (c_ipmi_active != 0)
461 struct timeval tv = { 1, 0 };
462 os_handler->perform_one_op (os_handler, &tv);
465 ipmi_posix_thread_free_os_handler (os_handler);
468 } /* void *thread_main */
470 static int c_ipmi_config (const char *key, const char *value)
472 if (ignorelist == NULL)
473 ignorelist = ignorelist_create (/* invert = */ 1);
474 if (ignorelist == NULL)
477 if (strcasecmp ("Sensor", key) == 0)
479 ignorelist_add (ignorelist, value);
481 else if (strcasecmp ("IgnoreSelected", key) == 0)
484 if ((strcasecmp ("True", value) == 0)
485 || (strcasecmp ("Yes", value) == 0)
486 || (strcasecmp ("On", value) == 0))
488 ignorelist_set_invert (ignorelist, invert);
496 } /* int c_ipmi_config */
498 static int c_ipmi_init (void)
504 status = pthread_create (&thread_id, /* attr = */ NULL, thread_main,
505 /* user data = */ NULL);
509 thread_id = (pthread_t) 0;
510 ERROR ("ipmi plugin: pthread_create failed.");
515 } /* int c_ipmi_init */
517 static int c_ipmi_read (void)
519 if ((c_ipmi_active == 0) || (thread_id == (pthread_t) 0))
521 INFO ("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
525 sensor_list_read_all ();
528 } /* int c_ipmi_read */
530 static int c_ipmi_shutdown (void)
534 if (thread_id != (pthread_t) 0)
536 pthread_join (thread_id, NULL);
537 thread_id = (pthread_t) 0;
540 sensor_list_remove_all ();
543 } /* int c_ipmi_shutdown */
545 void module_register (void)
547 plugin_register_config ("ipmi", c_ipmi_config,
548 config_keys, config_keys_num);
549 plugin_register_init ("ipmi", c_ipmi_init);
550 plugin_register_read ("ipmi", c_ipmi_read);
551 plugin_register_shutdown ("ipmi", c_ipmi_shutdown);
552 } /* void module_register */
554 /* vim: set sw=2 sts=2 ts=8 fdm=marker et : */