1#!/usr/bin/env python3 2 3r""" 4See help text for details. 5""" 6 7import sys 8 9save_path_0 = sys.path[0] 10del sys.path[0] 11 12from gen_arg import * # NOQA 13from gen_print import * # NOQA 14from gen_valid import * # NOQA 15from openbmc_ffdc_list import * # NOQA 16 17# Restore sys.path[0]. 18sys.path.insert(0, save_path_0) 19 20# Set exit_on_error for gen_valid functions. 21set_exit_on_error(True) 22 23parser = argparse.ArgumentParser( 24 usage="%(prog)s [OPTIONS]", 25 description="%(prog)s will print a colon-delimited list of all valid OBMC FFDC functions.\n\nExample:" 26 + "\n\n\nDump Log:FFDC Generic Report:Get Request FFDC:SEL Log:BMC Specific Files:Sys Inventory Files" 27 + ":Core Files:OS FFDC:Dump Files", 28 formatter_class=argparse.RawDescriptionHelpFormatter, 29 prefix_chars="-+", 30) 31 32# Populate stock_list with options we want. 33stock_list = [("test_mode", 0), ("quiet", 1), ("debug", 0)] 34 35 36def exit_function(signal_number=0, frame=None): 37 r""" 38 Execute whenever the program ends normally or with the signals that we catch (i.e. TERM, INT). 39 """ 40 41 dprint_executing() 42 dprint_var(signal_number) 43 44 qprint_pgm_footer() 45 46 47def signal_handler(signal_number, frame): 48 r""" 49 Handle signals. Without a function to catch a SIGTERM or SIGINT, our program would terminate immediately 50 with return code 143 and without calling our exit_function. 51 """ 52 53 # Our convention is to set up exit_function with atexit.register() so there is no need to explicitly 54 # call exit_function from here. 55 56 dprint_executing() 57 58 # Calling exit prevents us from returning to the code that was running when we received the signal. 59 exit(0) 60 61 62def validate_parms(): 63 r""" 64 Validate program parameters, etc. 65 """ 66 67 gen_post_validation(exit_function, signal_handler) 68 69 70def main(): 71 72 gen_get_options(parser, stock_list) 73 74 validate_parms() 75 76 qprint_pgm_header() 77 78 my_openbmc_ffdc_list = openbmc_ffdc_list() 79 ffdc_function_list = my_openbmc_ffdc_list.get_ffdc_method_desc("BMC LOGS") 80 # Convert from list to colon-delimited string. 81 ffdc_function_list = ":".join(ffdc_function_list) 82 print(ffdc_function_list) 83 84 85main() 86