Code

bind plugin: Fix a counter vs. gauge problem with memory statistics.
[collectd.git] / src / ipmi.c
1 /**
2  * collectd - src/ipmi.c
3  * Copyright (C) 2008  Florian octo Forster
4  * Copyright (C) 2008  Peter Holik
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation; only version 2 of the License is applicable.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Florian octo Forster <octo at verplant.org>
21  *   Peter Holik <peter at holik.at>
22  **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
27 #include "utils_ignorelist.h"
29 #include <pthread.h>
31 #include <OpenIPMI/ipmiif.h>
32 #include <OpenIPMI/ipmi_err.h>
33 #include <OpenIPMI/ipmi_posix.h>
34 #include <OpenIPMI/ipmi_conn.h>
35 #include <OpenIPMI/ipmi_smi.h>
37 /*
38  * Private data types
39  */
40 struct c_ipmi_sensor_list_s;
41 typedef struct c_ipmi_sensor_list_s c_ipmi_sensor_list_t;
43 struct c_ipmi_sensor_list_s
44 {
45   ipmi_sensor_id_t sensor_id;
46   char sensor_name[DATA_MAX_NAME_LEN];
47   char sensor_type[DATA_MAX_NAME_LEN];
48   int sensor_not_present;
49   c_ipmi_sensor_list_t *next;
50 };
52 /*
53  * Module global variables
54  */
55 static pthread_mutex_t sensor_list_lock = PTHREAD_MUTEX_INITIALIZER;
56 static c_ipmi_sensor_list_t *sensor_list = NULL;
58 static int c_ipmi_init_in_progress = 0;
59 static int c_ipmi_active = 0;
60 static pthread_t thread_id = (pthread_t) 0;
62 static const char *config_keys[] =
63 {
64         "Sensor",
65         "IgnoreSelected",
66         "NotifySensorAdd",
67         "NotifySensorRemove",
68         "NotifySensorNotPresent"
69 };
70 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
72 static ignorelist_t *ignorelist = NULL;
74 static int c_ipmi_nofiy_add = 0;
75 static int c_ipmi_nofiy_remove = 0;
76 static int c_ipmi_nofiy_notpresent = 0;
78 /*
79  * Misc private functions
80  */
81 static void c_ipmi_error (const char *func, int status)
82 {
83   char errbuf[4096];
85   memset (errbuf, 0, sizeof (errbuf));
87   if (IPMI_IS_OS_ERR (status))
88   {
89     sstrerror (IPMI_GET_OS_ERR (status), errbuf, sizeof (errbuf));
90   }
91   else if (IPMI_IS_IPMI_ERR (status))
92   {
93     ipmi_get_error_string (IPMI_GET_IPMI_ERR (status), errbuf, sizeof (errbuf));
94   }
96   if (errbuf[0] == 0)
97   {
98     ssnprintf (errbuf, sizeof (errbuf), "Unknown error %#x", status);
99   }
100   errbuf[sizeof (errbuf) - 1] = 0;
102   ERROR ("ipmi plugin: %s failed: %s", func, errbuf);
103 } /* void c_ipmi_error */
105 /*
106  * Sensor handlers
107  */
108 /* Prototype for sensor_list_remove, so sensor_read_handler can call it. */
109 static int sensor_list_remove (ipmi_sensor_t *sensor);
111 static void sensor_read_handler (ipmi_sensor_t *sensor,
112     int err,
113     enum ipmi_value_present_e value_present,
114     unsigned int __attribute__((unused)) raw_value,
115     double value,
116     ipmi_states_t __attribute__((unused)) *states,
117     void *user_data)
119   value_t values[1];
120   value_list_t vl = VALUE_LIST_INIT;
122   c_ipmi_sensor_list_t *list_item = (c_ipmi_sensor_list_t *)user_data;
124   if (err != 0)
125   {
126     if ((err & 0xff) == IPMI_NOT_PRESENT_CC)
127     {
128       if (list_item->sensor_not_present == 0)
129       {
130         list_item->sensor_not_present = 1;
132         INFO ("ipmi plugin: sensor_read_handler: sensor %s "
133             "not present.", list_item->sensor_name);
135         if (c_ipmi_nofiy_notpresent)
136         {
137           notification_t n = { NOTIF_WARNING, time(NULL), "", "", "ipmi",
138             "", "", "", NULL };
140           sstrncpy (n.host, hostname_g, sizeof (n.host));
141           sstrncpy (n.type_instance, list_item->sensor_name,
142               sizeof (n.type_instance));
143           sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
144           ssnprintf (n.message, sizeof (n.message),
145               "sensor %s not present", list_item->sensor_name);
147           plugin_dispatch_notification (&n);
148         }
149       }
150     }
151     else if (IPMI_IS_IPMI_ERR(err) && IPMI_GET_IPMI_ERR(err) == IPMI_NOT_SUPPORTED_IN_PRESENT_STATE_CC)
152     {
153       INFO ("ipmi plugin: sensor_read_handler: Sensor %s not ready",
154           list_item->sensor_name);
155     }
156     else
157     {
158       if (IPMI_IS_IPMI_ERR(err))
159         INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
160             "because it failed with IPMI error %#x.",
161             list_item->sensor_name, IPMI_GET_IPMI_ERR(err));
162       else if (IPMI_IS_OS_ERR(err))
163         INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
164             "because it failed with OS error %#x.",
165             list_item->sensor_name, IPMI_GET_OS_ERR(err));
166       else if (IPMI_IS_RMCPP_ERR(err))
167         INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
168             "because it failed with RMCPP error %#x.",
169             list_item->sensor_name, IPMI_GET_RMCPP_ERR(err));
170       else if (IPMI_IS_SOL_ERR(err))
171         INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
172             "because it failed with RMCPP error %#x.",
173             list_item->sensor_name, IPMI_GET_SOL_ERR(err));
174       else
175         INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
176             "because it failed with error %#x. of class %#x",
177             list_item->sensor_name, err & 0xff, err & 0xffffff00);
178       sensor_list_remove (sensor);
179     }
180     return;
181   }
182   else if (list_item->sensor_not_present == 1)
183   {
184     list_item->sensor_not_present = 0;
186     INFO ("ipmi plugin: sensor_read_handler: sensor %s present.",
187         list_item->sensor_name);
189     if (c_ipmi_nofiy_notpresent)
190     {
191       notification_t n = { NOTIF_OKAY, time(NULL), "", "", "ipmi",
192         "", "", "", NULL };
194       sstrncpy (n.host, hostname_g, sizeof (n.host));
195       sstrncpy (n.type_instance, list_item->sensor_name,
196           sizeof (n.type_instance));
197       sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
198       ssnprintf (n.message, sizeof (n.message),
199           "sensor %s present", list_item->sensor_name);
201       plugin_dispatch_notification (&n);
202     }
203   }
205   if (value_present != IPMI_BOTH_VALUES_PRESENT)
206   {
207     INFO ("ipmi plugin: sensor_read_handler: Removing sensor %s, "
208         "because it provides %s. If you need this sensor, "
209         "please file a bug report.",
210         list_item->sensor_name,
211         (value_present == IPMI_RAW_VALUE_PRESENT)
212         ? "only the raw value"
213         : "no value");
214     sensor_list_remove (sensor);
215     return;
216   }
218   values[0].gauge = value;
220   vl.values = values;
221   vl.values_len = 1;
223   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
224   sstrncpy (vl.plugin, "ipmi", sizeof (vl.plugin));
225   sstrncpy (vl.type, list_item->sensor_type, sizeof (vl.type));
226   sstrncpy (vl.type_instance, list_item->sensor_name, sizeof (vl.type_instance));
228   plugin_dispatch_values (&vl);
229 } /* void sensor_read_handler */
231 static int sensor_list_add (ipmi_sensor_t *sensor)
233   ipmi_sensor_id_t sensor_id;
234   c_ipmi_sensor_list_t *list_item;
235   c_ipmi_sensor_list_t *list_prev;
237   char sensor_name[DATA_MAX_NAME_LEN];
238   char *sensor_name_ptr;
239   int sensor_type, len;
240   const char *type;
241   ipmi_entity_t *ent = ipmi_sensor_get_entity(sensor);
243   sensor_id = ipmi_sensor_convert_to_id (sensor);
245   memset (sensor_name, 0, sizeof (sensor_name));
246   ipmi_sensor_get_name (sensor, sensor_name, sizeof (sensor_name));
247   sensor_name[sizeof (sensor_name) - 1] = 0;
249   len = DATA_MAX_NAME_LEN - strlen(sensor_name);
250   strncat(sensor_name, " ", len--);
251   strncat(sensor_name, ipmi_entity_get_entity_id_string(ent), len);
253   sensor_name_ptr = strstr (sensor_name, ").");
254   if (sensor_name_ptr == NULL)
255     sensor_name_ptr = sensor_name;
256   else
257   {
258     char *sensor_name_ptr_id = strstr (sensor_name, "(");
260     sensor_name_ptr += 2;
261     len = DATA_MAX_NAME_LEN - strlen(sensor_name);
262     strncat(sensor_name, " ", len--);
263     strncat(sensor_name, sensor_name_ptr_id, 
264       MIN(sensor_name_ptr - sensor_name_ptr_id - 1, len));
265   }
267   /* Both `ignorelist' and `plugin_instance' may be NULL. */
268   if (ignorelist_match (ignorelist, sensor_name_ptr) != 0)
269     return (0);
271   /* FIXME: Use rate unit or base unit to scale the value */
273   sensor_type = ipmi_sensor_get_sensor_type (sensor);
274   switch (sensor_type)
275   {
276     case IPMI_SENSOR_TYPE_TEMPERATURE:
277       type = "temperature";
278       break;
280     case IPMI_SENSOR_TYPE_VOLTAGE:
281       type = "voltage";
282       break;
284     case IPMI_SENSOR_TYPE_CURRENT:
285       type = "current";
286       break;
288     case IPMI_SENSOR_TYPE_FAN:
289       type = "fanspeed";
290       break;
292     default:
293       {
294         const char *sensor_type_str;
296         sensor_type_str = ipmi_sensor_get_sensor_type_string (sensor);
297         INFO ("ipmi plugin: sensor_list_add: Ignore sensor %s, "
298             "because I don't know how to handle its type (%#x, %s). "
299             "If you need this sensor, please file a bug report.",
300             sensor_name_ptr, sensor_type, sensor_type_str);
301         return (-1);
302       }
303   } /* switch (sensor_type) */
305   pthread_mutex_lock (&sensor_list_lock);
307   list_prev = NULL;
308   for (list_item = sensor_list;
309       list_item != NULL;
310       list_item = list_item->next)
311   {
312     if (ipmi_cmp_sensor_id (sensor_id, list_item->sensor_id) == 0)
313       break;
314     list_prev = list_item;
315   } /* for (list_item) */
317   if (list_item != NULL)
318   {
319     pthread_mutex_unlock (&sensor_list_lock);
320     return (0);
321   }
323   list_item = (c_ipmi_sensor_list_t *) calloc (1, sizeof (c_ipmi_sensor_list_t));
324   if (list_item == NULL)
325   {
326     pthread_mutex_unlock (&sensor_list_lock);
327     return (-1);
328   }
330   list_item->sensor_id = ipmi_sensor_convert_to_id (sensor);
332   if (list_prev != NULL)
333     list_prev->next = list_item;
334   else
335     sensor_list = list_item;
337   sstrncpy (list_item->sensor_name, sensor_name_ptr,
338             sizeof (list_item->sensor_name));
339   sstrncpy (list_item->sensor_type, type, sizeof (list_item->sensor_type));
341   pthread_mutex_unlock (&sensor_list_lock);
343   if (c_ipmi_nofiy_add && (c_ipmi_init_in_progress == 0))
344   {
345     notification_t n = { NOTIF_OKAY, time(NULL), "", "", "ipmi",
346                          "", "", "", NULL };
348     sstrncpy (n.host, hostname_g, sizeof (n.host));
349     sstrncpy (n.type_instance, list_item->sensor_name,
350               sizeof (n.type_instance));
351     sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
352     ssnprintf (n.message, sizeof (n.message),
353               "sensor %s added", list_item->sensor_name);
355     plugin_dispatch_notification (&n);
356   }
358   return (0);
359 } /* int sensor_list_add */
361 static int sensor_list_remove (ipmi_sensor_t *sensor)
363   ipmi_sensor_id_t sensor_id;
364   c_ipmi_sensor_list_t *list_item;
365   c_ipmi_sensor_list_t *list_prev;
367   sensor_id = ipmi_sensor_convert_to_id (sensor);
369   pthread_mutex_lock (&sensor_list_lock);
371   list_prev = NULL;
372   for (list_item = sensor_list;
373       list_item != NULL;
374       list_item = list_item->next)
375   {
376     if (ipmi_cmp_sensor_id (sensor_id, list_item->sensor_id) == 0)
377       break;
378     list_prev = list_item;
379   } /* for (list_item) */
381   if (list_item == NULL)
382   {
383     pthread_mutex_unlock (&sensor_list_lock);
384     return (-1);
385   }
387   if (list_prev == NULL)
388     sensor_list = list_item->next;
389   else
390     list_prev->next = list_item->next;
392   list_prev = NULL;
393   list_item->next = NULL;
395   pthread_mutex_unlock (&sensor_list_lock);
397   if (c_ipmi_nofiy_remove && c_ipmi_active)
398   {
399     notification_t n = { NOTIF_WARNING, time(NULL), "", "",
400                          "ipmi", "", "", "", NULL };
402     sstrncpy (n.host, hostname_g, sizeof (n.host));
403     sstrncpy (n.type_instance, list_item->sensor_name,
404               sizeof (n.type_instance));
405     sstrncpy (n.type, list_item->sensor_type, sizeof (n.type));
406     ssnprintf (n.message, sizeof (n.message),
407               "sensor %s removed", list_item->sensor_name);
409     plugin_dispatch_notification (&n);
410   }
412   free (list_item);
413   return (0);
414 } /* int sensor_list_remove */
416 static int sensor_list_read_all (void)
418   c_ipmi_sensor_list_t *list_item;
420   pthread_mutex_lock (&sensor_list_lock);
422   for (list_item = sensor_list;
423       list_item != NULL;
424       list_item = list_item->next)
425   {
426     ipmi_sensor_id_get_reading (list_item->sensor_id,
427         sensor_read_handler, /* user data = */ list_item);
428   } /* for (list_item) */
430   pthread_mutex_unlock (&sensor_list_lock);
432   return (0);
433 } /* int sensor_list_read_all */
435 static int sensor_list_remove_all (void)
437   c_ipmi_sensor_list_t *list_item;
439   pthread_mutex_lock (&sensor_list_lock);
441   list_item = sensor_list;
442   sensor_list = NULL;
444   pthread_mutex_unlock (&sensor_list_lock);
446   while (list_item != NULL)
447   {
448     c_ipmi_sensor_list_t *list_next = list_item->next;
450     free (list_item);
452     list_item = list_next;
453   } /* while (list_item) */
455   return (0);
456 } /* int sensor_list_remove_all */
458 /*
459  * Entity handlers
460  */
461 static void entity_sensor_update_handler (enum ipmi_update_e op,
462     ipmi_entity_t __attribute__((unused)) *entity,
463     ipmi_sensor_t *sensor,
464     void __attribute__((unused)) *user_data)
466   /* TODO: Ignore sensors we cannot read */
468   if ((op == IPMI_ADDED) || (op == IPMI_CHANGED))
469   {
470     /* Will check for duplicate entries.. */
471     sensor_list_add (sensor);
472   }
473   else if (op == IPMI_DELETED)
474   {
475     sensor_list_remove (sensor);
476   }
477 } /* void entity_sensor_update_handler */
479 /*
480  * Domain handlers
481  */
482 static void domain_entity_update_handler (enum ipmi_update_e op,
483     ipmi_domain_t __attribute__((unused)) *domain,
484     ipmi_entity_t *entity,
485     void __attribute__((unused)) *user_data)
487   int status;
489   if (op == IPMI_ADDED)
490   {
491     status = ipmi_entity_add_sensor_update_handler (entity,
492         entity_sensor_update_handler, /* user data = */ NULL);
493     if (status != 0)
494     {
495       c_ipmi_error ("ipmi_entity_add_sensor_update_handler", status);
496     }
497   }
498   else if (op == IPMI_DELETED)
499   {
500     status = ipmi_entity_remove_sensor_update_handler (entity,
501         entity_sensor_update_handler, /* user data = */ NULL);
502     if (status != 0)
503     {
504       c_ipmi_error ("ipmi_entity_remove_sensor_update_handler", status);
505     }
506   }
507 } /* void domain_entity_update_handler */
509 static void domain_connection_change_handler (ipmi_domain_t *domain,
510     int err,
511     unsigned int conn_num,
512     unsigned int port_num,
513     int still_connected,
514     void *user_data)
516   int status;
518   DEBUG ("domain_connection_change_handler (domain = %p, err = %i, "
519       "conn_num = %u, port_num = %u, still_connected = %i, "
520       "user_data = %p);\n",
521       (void *) domain, err, conn_num, port_num, still_connected, user_data);
523   status = ipmi_domain_add_entity_update_handler (domain,
524       domain_entity_update_handler, /* user data = */ NULL);
525   if (status != 0)
526   {
527     c_ipmi_error ("ipmi_domain_add_entity_update_handler", status);
528   }
529 } /* void domain_connection_change_handler */
531 static int thread_init (os_handler_t **ret_os_handler)
533   os_handler_t *os_handler;
534   ipmi_open_option_t open_option[1];
535   ipmi_con_t *smi_connection = NULL;
536   ipmi_domain_id_t domain_id;
537   int status;
539   os_handler = ipmi_posix_thread_setup_os_handler (SIGUSR2);
540   if (os_handler == NULL)
541   {
542     ERROR ("ipmi plugin: ipmi_posix_thread_setup_os_handler failed.");
543     return (-1);
544   }
546   ipmi_init (os_handler);
548   status = ipmi_smi_setup_con (/* if_num = */ 0,
549       os_handler,
550       /* user data = */ NULL,
551       &smi_connection);
552   if (status != 0)
553   {
554     c_ipmi_error ("ipmi_smi_setup_con", status);
555     return (-1);
556   }
558   memset (open_option, 0, sizeof (open_option));
559   open_option[0].option = IPMI_OPEN_OPTION_ALL;
560   open_option[0].ival = 1;
562   status = ipmi_open_domain ("mydomain", &smi_connection, /* num_con = */ 1,
563       domain_connection_change_handler, /* user data = */ NULL,
564       /* domain_fully_up_handler = */ NULL, /* user data = */ NULL,
565       open_option, sizeof (open_option) / sizeof (open_option[0]),
566       &domain_id);
567   if (status != 0)
568   {
569     c_ipmi_error ("ipmi_open_domain", status);
570     return (-1);
571   }
573   *ret_os_handler = os_handler;
574   return (0);
575 } /* int thread_init */
577 static void *thread_main (void __attribute__((unused)) *user_data)
579   int status;
580   os_handler_t *os_handler = NULL;
582   status = thread_init (&os_handler);
583   if (status != 0)
584   {
585     ERROR ("ipmi plugin: thread_init failed.\n");
586     return ((void *) -1);
587   }
589   while (c_ipmi_active != 0)
590   {
591     struct timeval tv = { 1, 0 };
592     os_handler->perform_one_op (os_handler, &tv);
593   }
595   ipmi_posix_thread_free_os_handler (os_handler);
597   return ((void *) 0);
598 } /* void *thread_main */
600 static int c_ipmi_config (const char *key, const char *value)
602   if (ignorelist == NULL)
603     ignorelist = ignorelist_create (/* invert = */ 1);
604   if (ignorelist == NULL)
605     return (1);
607   if (strcasecmp ("Sensor", key) == 0)
608   {
609     ignorelist_add (ignorelist, value);
610   }
611   else if (strcasecmp ("IgnoreSelected", key) == 0)
612   {
613     int invert = 1;
614     if ((strcasecmp ("True", value) == 0)
615         || (strcasecmp ("Yes", value) == 0)
616         || (strcasecmp ("On", value) == 0))
617       invert = 0;
618     ignorelist_set_invert (ignorelist, invert);
619   }
620   else if (strcasecmp ("NotifySensorAdd", key) == 0)
621   {
622     if ((strcasecmp ("True", value) == 0)
623         || (strcasecmp ("Yes", value) == 0)
624         || (strcasecmp ("On", value) == 0))
625       c_ipmi_nofiy_add = 1;
626   }
627   else if (strcasecmp ("NotifySensorRemove", key) == 0)
628   {
629     if ((strcasecmp ("True", value) == 0)
630         || (strcasecmp ("Yes", value) == 0)
631         || (strcasecmp ("On", value) == 0))
632       c_ipmi_nofiy_remove = 1;
633   }
634   else if (strcasecmp ("NotifySensorNotPresent", key) == 0)
635   {
636     if ((strcasecmp ("True", value) == 0)
637         || (strcasecmp ("Yes", value) == 0)
638         || (strcasecmp ("On", value) == 0))
639       c_ipmi_nofiy_notpresent = 1;
640   }
641   else
642   {
643     return (-1);
644   }
646   return (0);
647 } /* int c_ipmi_config */
649 static int c_ipmi_init (void)
651   int status;
653   /* Don't send `ADD' notifications during startup (~ 1 minute) */
654   c_ipmi_init_in_progress = 1 + (60 / interval_g);
656   c_ipmi_active = 1;
658   status = pthread_create (&thread_id, /* attr = */ NULL, thread_main,
659       /* user data = */ NULL);
660   if (status != 0)
661   {
662     c_ipmi_active = 0;
663     thread_id = (pthread_t) 0;
664     ERROR ("ipmi plugin: pthread_create failed.");
665     return (-1);
666   }
668   return (0);
669 } /* int c_ipmi_init */
671 static int c_ipmi_read (void)
673   if ((c_ipmi_active == 0) || (thread_id == (pthread_t) 0))
674   {
675     INFO ("ipmi plugin: c_ipmi_read: I'm not active, returning false.");
676     return (-1);
677   }
679   sensor_list_read_all ();
681   if (c_ipmi_init_in_progress > 0)
682     c_ipmi_init_in_progress--;
683   else
684     c_ipmi_init_in_progress = 0;
686   return (0);
687 } /* int c_ipmi_read */
689 static int c_ipmi_shutdown (void)
691   c_ipmi_active = 0;
693   if (thread_id != (pthread_t) 0)
694   {
695     pthread_join (thread_id, NULL);
696     thread_id = (pthread_t) 0;
697   }
699   sensor_list_remove_all ();
701   return (0);
702 } /* int c_ipmi_shutdown */
704 void module_register (void)
706   plugin_register_config ("ipmi", c_ipmi_config,
707       config_keys, config_keys_num);
708   plugin_register_init ("ipmi", c_ipmi_init);
709   plugin_register_read ("ipmi", c_ipmi_read);
710   plugin_register_shutdown ("ipmi", c_ipmi_shutdown);
711 } /* void module_register */
713 /* vim: set sw=2 sts=2 ts=8 fdm=marker et : */