snmp/lustre-snmp-trap.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   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 version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * snmp/lustre-snmp-trap.c
  35  *
  36  * Author: PJ Kirner <pjkirner@clusterfs.com>
  37  */
  38
  39 /*
  40  *   include important headers
  41  */
  42
  43 #include <net-snmp/net-snmp-config.h>
  44 #include <net-snmp/net-snmp-includes.h>
  45 #include <net-snmp/agent/net-snmp-agent-includes.h>
  46
  47 /*
  48  *  include our .h file
  49  */
  50
  51 #include <sys/types.h>
  52 #include <sys/vfs.h>
  53 #include <dirent.h>
  54 #include <sys/stat.h>
  55 #include <unistd.h>
  56 #include <stdio.h>
  57 #include <stdarg.h>
  58 #include <ctype.h>
  59 #include "lustre-snmp-util.h"
  60
  61 /**************************************************************************
  62  * Constants
  63  *************************************************************************/
  64
  65 #define DEFAULT_POLL_INTERVAL_SECONDS   60
  66 #define POLL_INTERVAL_ENV_VAR           "LSNMP_POLL_INTERVAL"
  67 #define SNMP_HEALTH_CHECK_TEST_FILE     "LSNMP_HEALTH_CHECK_TEST_FILE"
  68
  69 /**************************************************************************
  70  * Trap OIDS
  71  *************************************************************************/
  72
  73 static oid objid_snmptrap[] =
  74     { 1,3,6,1,6,3,1,1,4,1,0};
  75 static oid lustre_portals_trap[] =
  76     { 1,3,6,1,4,1,13140,2,1,0,1};
  77 static oid lustre_portals_trap_string[]=
  78     { 1,3,6,1,4,1,13140,2,1,0,2};
  79 static oid lustre_unhealthy_trap[] =
  80     { 1,3,6,1,4,1,13140,2,1,0,3};
  81 static oid lustre_unhealthy_trap_device_name_string[]=
  82     { 1,3,6,1,4,1,13140,2,1,0,4};
  83 static oid lustre_unhealthy_trap_reason_string[]=
  84     { 1,3,6,1,4,1,13140,2,1,0,5};
  85
  86 /**************************************************************************
  87  * Data structures
  88  *************************************************************************/
  89
  90 typedef struct obd_unhealthy_entry_struct{
  91
  92     /*1-if seen as part of the the is_unhealthy scan, otherwise 0*/
  93     int seen;
  94
  95     /*single linked list pointer*/
  96     struct obd_unhealthy_entry_struct *next;
  97
  98     /*obdname - variable size*/
  99     char name[0];
 100
 101 }obd_unhealthy_entry;
 102
 103 /**************************************************************************
 104  * Local functions
 105  *************************************************************************/
 106
 107 int get_poll_interval_seconds();
 108 void health_poll_worker(unsigned int registration_number, void *clientarg);
 109 void send_portals_catastrophe_trap(char *reason_string);
 110 void send_obd_unhealthy_trap(char *obd_name,char *reason_string);
 111 int is_obd_newly_unhealthy(const char* obd_name);
 112 void obd_unhealthy_scan(void);
 113 void health_entry_parser(void);
 114
 115 /**************************************************************************
 116  * Global variables
 117  *************************************************************************/
 118
 119 static int g_sent_portals_catastrophe = 0;
 120 static obd_unhealthy_entry* g_obd_unhealthy_list = NULL;
 121 static int g_poll_interval_seconds;
 122 static unsigned int g_registration_handle;
 123 static char *g_health_check_test_file = 0;
 124
 125 /*****************************************************************************
 126  * Function: initialize_trap_handler
 127  *
 128  * Description: Initlized the trap poll haalder.
 129  *
 130  * Input:   void
 131  *
 132  * Output:  Global g_poll_interval_seconds is set.
 133  *
 134  ****************************************************************************/
 135
 136 void initialize_trap_handler(void)
 137 {
 138     g_poll_interval_seconds = get_poll_interval_seconds();
 139
 140     g_registration_handle = snmp_alarm_register(g_poll_interval_seconds, 0, health_poll_worker, NULL);
 141     if (g_registration_handle == 0)
 142         report("%s %s: line %d %s", __FILE__, __FUNCTION__, __LINE__,
 143             "snmp_alarm_register failed");
 144
 145     DEBUGMSGTL(("lsnmpd","lsnmp alarm registered poll interval = %d seconds\n",g_poll_interval_seconds));
 146
 147     g_health_check_test_file = getenv(SNMP_HEALTH_CHECK_TEST_FILE);
 148     if(g_health_check_test_file != 0)
 149         DEBUGMSGTL(("lsnmpd","lsnmp health check test file set to  \'%s\'\n",g_health_check_test_file));
 150 }
 151
 152 /*****************************************************************************
 153  * Function: terminate_trap_handler
 154  *
 155  * Description: Terminate the trap poll haalder.
 156  *
 157  * Input:   void
 158  *
 159  * Output:  Global g_poll_interval_seconds is set.
 160  *
 161  ****************************************************************************/
 162
 163 void terminate_trap_handler(void)
 164 {
 165     snmp_alarm_unregister(g_registration_handle);
 166 }
 167
 168 /*****************************************************************************
 169  * Function: get_poll_interval_seconds
 170  *
 171  * Description: This function used to get the poll period for timer, which
 172  *              is used to read throughput values periodically.
 173  * Input:   void
 174  * Output:  Alarm period, default value(if env var not set) otherwise.
 175  ****************************************************************************/
 176
 177 int get_poll_interval_seconds()
 178 {
 179     char *alarm_period;
 180     int ret_val = DEFAULT_POLL_INTERVAL_SECONDS;
 181
 182     /* Get Alarm period for reading the Lustre client table. */
 183
 184     alarm_period = getenv(POLL_INTERVAL_ENV_VAR);
 185     if (alarm_period != NULL) {
 186         char *ptr = alarm_period;
 187         while(isdigit(*ptr)) ptr++;
 188
 189         /* if we have only digits then conver it*/
 190         if (*ptr == '\0') {
 191             int time = atoi(alarm_period);
 192             if (time > 0)
 193                 ret_val = time; /* Alarm period in seconds */
 194         }
 195     }
 196     return ret_val;
 197 }
 198
 199 /*****************************************************************************
 200  * Function:  health_poll_worker
 201  *
 202  * Description: This is the routine registered to system timer for updating
 203  *     the throughput values for all the clients and its respective osc(s).
 204  *
 205  * Input:  'registration_number` value obtained during the alarm registration
 206  *         'clientarg' pointing to user defined data type.
 207  * Output: void
 208  *****************************************************************************/
 209
 210 void health_poll_worker(unsigned int registration_number, void *clientarg)
 211 {
 212     health_entry_parser();
 213
 214     /* Register the function again to call after lustre_alarm_period */
 215     if (!snmp_alarm_register(g_poll_interval_seconds, 0, health_poll_worker, NULL)) {
 216         report("%s %s:line %d %s", __FILE__, __FUNCTION__, __LINE__,
 217                "snmp_alarm_register failed");
 218     }
 219 }
 220
 221 /*****************************************************************************
 222  * Function:  health_entry_parser
 223  *
 224  * Description: This routine is called to parse the health_check entry
 225  *              and send traps
 226  * Input:  'None
 227  * Output: void
 228  *****************************************************************************/
 229
 230  void health_entry_parser(void)
 231 {
 232     FILE    *fptr = NULL;
 233     char string[MAX_LINE_SIZE];
 234     int b_seen_portals_catastrophe = 0;
 235     const char *filename =  g_health_check_test_file == 0 ?
 236             LUSTRE_PATH FILENAME_SYSHEALTHCHECK :
 237             g_health_check_test_file;
 238
 239     /*DEBUGMSGTL(("lsnmpd","health_entry_parser(%s)\n",filename));*/
 240
 241     /* Open the file.  Use the test file env variable if
 242        there is one */
 243     fptr = fopen(filename,"r");
 244
 245     /* If the path is not found do nothing */
 246     if( NULL == fptr)
 247         return;
 248
 249     while( NULL != fgets(string, sizeof(string), fptr)){
 250
 251         /*DEBUGMSGTL(("lsnmpd","health_entry_parser() looking at = \'%s\'\n",string));*/
 252
 253         /*
 254          * First handle the portals catastrophe
 255          * Look for the string "LBUG"
 256          */
 257         if(0 == strncmp(string,"LBUG",4)){
 258             /*
 259              * If we haven't sent the catastrophe message yet
 260              * send it now.  And keep track that we've sent it
 261              */
 262             if(!g_sent_portals_catastrophe){
 263                 send_portals_catastrophe_trap("LBUG");
 264                 g_sent_portals_catastrophe = 1;
 265             }
 266             b_seen_portals_catastrophe = 1;
 267         }
 268
 269         /*
 270          * Now handle any of the OBD object failures
 271          * look for "device <OBDNAME> reported unhealthy"
 272          */
 273         else if(0 == strncmp(string,"device ",7)){
 274             char *obd_name = string+7;
 275             char *space_after_obd_name;
 276
 277             /*
 278              * Now find the space after the obd name
 279              * Again if there is no space we're in trouble
 280              */
 281             space_after_obd_name = strchr(obd_name,' ');
 282             if(space_after_obd_name == 0)
 283                 break;
 284
 285             /*
 286              * Null terminate the obd_name
 287              */
 288             *space_after_obd_name = 0;
 289
 290             DEBUGMSGTL(("lsnmpd","Looking at obd=%s\n",obd_name));
 291
 292             /*
 293              * If we haven't sent a trap for this one
 294              * then send it now
 295              */
 296             if(is_obd_newly_unhealthy(obd_name))
 297                 send_obd_unhealthy_trap(obd_name,"unhealthy");
 298         }
 299     }
 300
 301     /* If we don't find it reset the catastrope flag*/
 302     if(!b_seen_portals_catastrophe && g_sent_portals_catastrophe)
 303     {
 304         DEBUGMSGTL(("lsnmpd","LBUG has been cleared\n"));
 305         g_sent_portals_catastrophe = 0;
 306     }
 307
 308     /*
 309      *  Any <OBDNAMES> that weren't queried above are now unhealthy.
 310      * Scan through and cleanup the newly healthy obds
 311      */
 312     obd_unhealthy_scan();
 313
 314     fclose(fptr);
 315 }
 316
 317 /*****************************************************************************
 318  * Function:  send_portals_catastrophe_trap
 319  *
 320  * Description: Send the SNMP V2 trap
 321  *
 322  * Input:  'reason_string' the reason for the catastrope.
 323
 324  * Output: none
 325  *****************************************************************************/
 326
 327 void send_portals_catastrophe_trap(char *reason_string)
 328 {
 329     /*
 330      * Setup the trap variables.
 331      * It's a linked list of netsnmp_variable_list items.
 332      */
 333     netsnmp_variable_list var_trap[2];
 334
 335     DEBUGMSGTL(("lsnmpd","Sending portals catastrophe trap reason=%s\n",reason_string));
 336
 337     /*
 338      * Setup the first variable in the trap data.
 339      * Have it chain to another variable.
 340      */
 341     var_trap[0].next_variable = &var_trap[1];
 342
 343     /*The "name" must be the standard snmp "trap" OID.*/
 344     var_trap[0].name = objid_snmptrap;
 345     var_trap[0].name_length = sizeof(objid_snmptrap) / sizeof(oid);
 346
 347     /*But the data contained in this variable, is an OID that is the trap OID.*/
 348     var_trap[0].type = ASN_OBJECT_ID;
 349     var_trap[0].val.objid = lustre_portals_trap;
 350     var_trap[0].val_len = sizeof(lustre_portals_trap);
 351
 352     /*
 353      * Setup the second variable in the trap data.
 354      * It is the last in the chain so set next to NULL
 355      */
 356     var_trap[1].next_variable = NULL;
 357
 358     /* The "name" is the OID of the portals trap reason string */
 359     var_trap[1].name = lustre_portals_trap_string;
 360     var_trap[1].name_length = sizeof(lustre_portals_trap_string) / sizeof(oid);
 361
 362     /* And the data is an octet string, that contains the actually reason
 363      * string */
 364     var_trap[1].type = ASN_OCTET_STR;
 365     var_trap[1].val.string = (unsigned char *)reason_string;
 366     var_trap[1].val_len = strlen(reason_string);
 367
 368     /*And now send off the trap*/
 369     send_v2trap(var_trap);
 370 }
 371
 372
 373 /*****************************************************************************
 374  * Function:  send_obd_unhealthy_trap
 375  *
 376  * Description: Send the SNMP V2 trap
 377  *
 378  * Input:  'obd_name' the name of the obd
 379  *         'reason_string' the reason for the catastrope.
 380  * Output: none
 381  *****************************************************************************/
 382
 383 void send_obd_unhealthy_trap(char *obd_name,char *reason_string)
 384 {
 385     /*
 386      * Setup the trap variables.
 387      * It's a linked list of netsnmp_variable_list items.
 388      */
 389     netsnmp_variable_list var_trap[3];
 390
 391     DEBUGMSGTL(("lsnmpd","Sending OBD unhealthy trap obd=%s reason=%s\n",obd_name,reason_string));
 392
 393     /*
 394      * Setup the first variable in the trap data.
 395      * Have it chain to another variable.
 396      */
 397     var_trap[0].next_variable = &var_trap[1];
 398
 399     /*The "name" must be the standard snmp "trap" OID.*/
 400     var_trap[0].name = objid_snmptrap;
 401     var_trap[0].name_length = sizeof(objid_snmptrap) / sizeof(oid);
 402
 403     /*But the data contained in this variable, is an OID that is the trap OID.*/
 404     var_trap[0].type = ASN_OBJECT_ID;
 405     var_trap[0].val.objid = lustre_unhealthy_trap;
 406     var_trap[0].val_len = sizeof(lustre_unhealthy_trap);
 407
 408     /*
 409      * Setup the second variable in the trap data.
 410      * Have it chain to another variable.
 411      */
 412     var_trap[1].next_variable = &var_trap[2];;
 413
 414     /* The "name" is the OID of the portals trap reason string */
 415     var_trap[1].name = lustre_unhealthy_trap_device_name_string;
 416     var_trap[1].name_length = sizeof(lustre_unhealthy_trap_device_name_string) / sizeof(oid);
 417
 418     /* And the data is an octet string, that contains the actual reason
 419      * string */
 420     var_trap[1].type = ASN_OCTET_STR;
 421     var_trap[1].val.string = (unsigned char *)obd_name;
 422     var_trap[1].val_len = strlen(obd_name);
 423
 424     /*
 425      * Setup the third variable in the trap data.
 426      * It is the last in the chain so set next to NULL
 427      */
 428     var_trap[2].next_variable = NULL;
 429
 430     /* The "name" is the OID of the portals trap reason string */
 431     var_trap[2].name = lustre_unhealthy_trap_reason_string;
 432     var_trap[2].name_length = sizeof(lustre_unhealthy_trap_reason_string) / sizeof(oid);
 433
 434     /* And the data is an octet string, that contains the actual reason
 435      * string */
 436     var_trap[2].type = ASN_OCTET_STR;
 437     var_trap[2].val.string = (unsigned char *)reason_string;
 438     var_trap[2].val_len = strlen(reason_string);
 439
 440     /*And now send off the trap*/
 441     send_v2trap(var_trap);
 442 }
 443
 444
 445 /*****************************************************************************
 446  * Function:  is_obd_newly_unhealthy
 447  *
 448  * Description: Deterime if the obd is going from health->unhealth
 449  *              Also mark all unhealhy (new and old) as seen.
 450  *
 451  * Input:  'obd_name' the name of the obd
 452  *
 453  * Output: 1 if newly unhealthy 0 if previolsy unhealthy
 454  *****************************************************************************/
 455
 456 int is_obd_newly_unhealthy(const char* obd_name)
 457 {
 458     /*for all elements in g_obd_unhealthy_list*/
 459     obd_unhealthy_entry* walker;
 460     obd_unhealthy_entry* entry;
 461     int name_len;
 462
 463     for(walker = g_obd_unhealthy_list; walker != 0; walker = walker->next)
 464     {
 465         /*If the names match*/
 466         if(0 == strcmp (walker->name,obd_name))
 467         {
 468             /* Commented out because it was just to noisy!
 469              * DEBUGMSGTL(("lsnmpd","obd %s was already unhealthy\n",obd_name));
 470              */
 471
 472             /*Mark the entry as seen, and return that it was previously unhealthy*/
 473             walker->seen =1;
 474             return 0;
 475         }
 476     }
 477
 478     DEBUGMSGTL(("lsnmpd","obd %s is now unhealthy\n",obd_name));
 479
 480     /*We didn't find an entry so we need to create a new one. */
 481     /*Calculate the obd_name length*/
 482     name_len = strlen(obd_name)+1;
 483
 484     /*Allocate a new entry*/
 485     entry = malloc(sizeof(*entry) + name_len);
 486
 487     /*Put this element at the front of the list*/
 488     entry->next = g_obd_unhealthy_list;
 489     g_obd_unhealthy_list = entry;
 490
 491     /*Mark it initially as seen*/
 492     entry->seen = 1;
 493
 494     /*And copy the entry name*/
 495     memcpy(entry->name,obd_name,name_len);
 496
 497     /*return this obd as newly unhealthy.*/
 498     return 1;
 499 }
 500
 501
 502 /*****************************************************************************
 503  * Function:  obd_unhealthy_scan
 504  *
 505  * Description: Deterime if any obd is going from unhealthy->healthy
 506  *              Any of the obds that weren't "seen" by the
 507  *              is_obd_newly_unhealthy() pass are now health so
 508  *              remove them from the lists
 509  *              Also clear all "seen" flags.
 510  *
 511  * Input:  None
 512  * Output: None
 513  *****************************************************************************/
 514
 515 void obd_unhealthy_scan(void)
 516 {
 517     /*fore all elements in g_obd_unhealthy_list*/
 518     obd_unhealthy_entry* walker = g_obd_unhealthy_list;
 519     obd_unhealthy_entry* prev = 0;
 520     while(walker != 0)
 521     {
 522         /*remove any that was not seen as unhealthy the last time*/
 523         if(walker->seen == 0)
 524         {
 525             /*Remove element from the list, but first fix up the walker pointer*/
 526             obd_unhealthy_entry* temp = walker;
 527
 528             DEBUGMSGTL(("lsnmpd","obd %s is now healthy\n",walker->name));
 529
 530             walker = walker->next;
 531
 532             /*Now adjust the pointers to effectively remove this entry*/
 533             if(prev == 0)
 534                 g_obd_unhealthy_list = walker;
 535             else
 536                 prev->next = walker;
 537
 538             /*And free the pointer. */
 539             free(temp);
 540             /*walker and prev are correctly setup so we can go around the loop again.*/
 541         }
 542
 543         /*Mark all other entries as NOT seen for next pass through*/
 544         else
 545         {
 546             walker->seen = 0;
 547             /*Go onto the next entry*/
 548             prev = walker;
 549             walker = walker->next;
 550         }
 551     }
 552 }