1#!/usr/bin/python 2r""" 3# @file openbmc_ffdc_list.py 4# @brief List for FFDC ( First failure data capture ) 5# commands and files to be collected as a part 6# of the test case failure. 7""" 8# ------------------- 9# FFDC default list 10# ------------------- 11# ----------------------------------------------------------------- 12# Dict Name { Index string : { Key String : Command string} } 13# ----------------------------------------------------------------- 14# Add cmd's needed to be part of the ffdc report manifest file 15FFDC_BMC_CMD = { 16 'DRIVER INFO': 17 { 18 # String Name Command 19 'FW Level': 'cat /etc/os-release', 20 'FW Timestamp': 'cat /etc/timestamp', 21 }, 22 'BMC DATA': 23 { 24 'BMC OS': 'uname -a', 25 'BMC Uptime': 'uptime', 26 'BMC File System Disk Space Usage': 'df -hT', 27 'BMC Date Time': 'date;/sbin/hwclock --show;/usr/bin/timedatectl' 28 }, 29 'APPLICATION DATA': 30 { 31 'BMC state': '/usr/sbin/obmcutil state', 32 }, 33} 34# Add file name and correcponding command needed for BMC 35FFDC_BMC_FILE = { 36 'BMC FILES': 37 { 38 # File Name Command 39 'BMC_proc_list': 'top -n 1 -b', 40 'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/', 41 'BMC_journalctl_nopager': 'journalctl --no-pager', 42 'BMC_journalctl_pretty': 'journalctl -o json-pretty', 43 'BMC_dmesg': 'dmesg', 44 'BMC_procinfo': 'cat /proc/cpuinfo', 45 'BMC_meminfo': 'cat /proc/meminfo', 46 'BMC_systemd': 'systemctl status --all', 47 }, 48} 49# Add file name and correcponding command needed for all Linux distributions 50FFDC_OS_ALL_DISTROS_FILE = { 51 'OS FILES': 52 { 53 # File Name Command 54 'OS_msglog': 'cat /sys/firmware/opal/msglog', 55 'OS_cpufrequency': 'ppc64_cpu --frequency', 56 'OS_dmesg': 'dmesg', 57 'OS_boot': 'cat /var/log/boot.log', 58 'OS_procinfo': 'cat /proc/cpuinfo', 59 'OS_meminfo': 'cat /proc/meminfo', 60 'OS_netstat': 'netstat -a', 61 'OS_lspci': 'lspci', 62 'OS_lscpu': 'lscpu', 63 'OS_lscfg': 'lscfg', 64 }, 65} 66# Add file name and correcponding command needed for Ubuntu Linux 67FFDC_OS_UBUNTU_FILE = { 68 'OS FILES': 69 { 70 # File Name Command 71 'OS_isusb': 'lsusb -t ; lsusb -v', 72 'OS_kern': 'tail -n 50000 /var/log/kern.log', 73 'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1', 74 'OS_syslog': 'tail -n 200000 /var/log/syslog', 75 'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool', 76 }, 77} 78# Add file name and correcponding command needed for RHEL Linux 79FFDC_OS_RHEL_FILE = { 80 'OS FILES': 81 { 82 # File Name Command 83 'OS_rsct': '/usr/bin/ctversion -bv', 84 'OS_secure': 'cat /var/log/secure', 85 'OS_syslog': 'tail -n 200000 /var/log/messages', 86 'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa', 87 }, 88} 89# Add file name and correcponding command needed for RHEL Linux 90FFDC_OS_IBM_POWERKVM_FILE = { 91 'OS FILES': 92 { 93 # File Name Command 94 'OS_secure': 'cat /var/log/secure', 95 'OS_syslog': 'tail -n 200000 /var/log/messages', 96 'OS_info': 'lsb_release -a; uname -a; rpm -qa', 97 }, 98} 99OPENBMC_BASE = '/xyz/openbmc_project/' 100OPENPOWER_BASE = '/org/open_power/' 101ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate' 102ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate' 103ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate' 104ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate' 105ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate' 106ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate' 107ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate' 108ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate' 109# Add file name and correcponding Get Request 110FFDC_GET_REQUEST = { 111 'GET REQUESTS': 112 { 113 # File Name Command 114 'FIRMWARE_list': ENUMERATE_SW, 115 'BMC_sensor_list': ENUMERATE_SENSORS, 116 'BMC_control_list': ENUMERATE_CONTROL, 117 'BMC_inventory': ENUMERATE_INVENTORY, 118 'BMC_elog': ENUMERATE_ELOG, 119 'BMC_led': ENUMERATE_LED, 120 'BMC_state': ENUMERATE_STATE, 121 'OCC_state': ENUMERATE_OCC, 122 }, 123} 124# Define your keywords in method/utils and call here 125FFDC_METHOD_CALL = { 126 'BMC LOGS': 127 { 128 # Description Keyword name 129 'FFDC Generic Report': 'BMC FFDC Manifest', 130 'BMC Specific Files': 'BMC FFDC Files', 131 'Get Request FFDC': 'BMC FFDC Get Requests', 132 'OS FFDC': 'OS FFDC Files', 133 'Core Files': 'SCP Coredump Files', 134 'SEL Log': 'Collect eSEL Log', 135 'Sys Inventory Files': 'System Inventory Files', 136 }, 137} 138# ----------------------------------------------------------------- 139# base class for FFDC default list 140class openbmc_ffdc_list(): 141 def get_ffdc_bmc_cmd(self, i_type): 142 r""" 143 ######################################################################## 144 # @brief This method returns the list from the dictionary for cmds 145 # @param i_type: @type string: string index lookup 146 # @return List of key pair from the dictionary 147 ######################################################################## 148 """ 149 return FFDC_BMC_CMD[i_type].items() 150 def get_ffdc_bmc_file(self, i_type): 151 r""" 152 ######################################################################## 153 # @brief This method returns the list from the dictionary for scp 154 # @param i_type: @type string: string index lookup 155 # @return List of key pair from the dictionary 156 ######################################################################## 157 """ 158 return FFDC_BMC_FILE[i_type].items() 159 def get_ffdc_get_request(self, i_type): 160 r""" 161 ######################################################################## 162 # @brief This method returns the list from the dictionary for scp 163 # @param i_type: @type string: string index lookup 164 # @return List of key pair from the dictionary 165 ######################################################################## 166 """ 167 return FFDC_GET_REQUEST[i_type].items() 168 def get_ffdc_cmd_index(self): 169 r""" 170 ######################################################################## 171 # @brief This method returns the list index from dictionary 172 # @return List of index to the dictionary 173 ######################################################################## 174 """ 175 return FFDC_BMC_CMD.keys() 176 def get_ffdc_get_request_index(self): 177 r""" 178 ######################################################################## 179 # @brief This method returns the list index from dictionary 180 # @return List of index to the dictionary 181 ######################################################################## 182 """ 183 return FFDC_GET_REQUEST.keys() 184 def get_ffdc_file_index(self): 185 r""" 186 ######################################################################## 187 # @brief This method returns the list index from dictionary 188 # @return List of index to the dictionary 189 ######################################################################## 190 """ 191 return FFDC_BMC_FILE.keys() 192 def get_ffdc_method_index(self): 193 r""" 194 ######################################################################## 195 # @brief This method returns the key pair from the dictionary 196 # @return Index of the method dictionary 197 ######################################################################## 198 """ 199 return FFDC_METHOD_CALL.keys() 200 def get_ffdc_method_desc(self, 201 index): 202 r""" 203 ######################################################################## 204 # @brief This method returns the just the keys from the dictionary. 205 # @return List of ffdc descriptions. 206 ######################################################################## 207 """ 208 return FFDC_METHOD_CALL[index].keys() 209 def get_ffdc_method_call(self, i_type): 210 r""" 211 ######################################################################## 212 # @brief This method returns the key pair from the dictionary 213 # @return List of key pair keywords 214 ######################################################################## 215 """ 216 return FFDC_METHOD_CALL[i_type].items() 217 def get_ffdc_os_all_distros_index(self): 218 r""" 219 ######################################################################## 220 # @brief This method returns the key pair from the dictionary 221 # @return Index of the method dictionary 222 ######################################################################## 223 """ 224 return FFDC_OS_ALL_DISTROS_FILE.keys() 225 def get_ffdc_os_all_distros_call(self, i_type): 226 r""" 227 ######################################################################## 228 # @brief This method returns the key pair from the dictionary 229 # @return List of key pair keywords 230 ######################################################################## 231 """ 232 return FFDC_OS_ALL_DISTROS_FILE[i_type].items() 233 def get_ffdc_os_distro_index(self, distro): 234 r""" 235 ######################################################################## 236 # @brief This method returns the key pair from the dictionary 237 # @return Index of the method dictionary 238 ######################################################################## 239 """ 240 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 241 return eval(distro_file).keys() 242 def get_ffdc_os_distro_call(self, i_type, distro): 243 r""" 244 ######################################################################## 245 # @brief This method returns the key pair from the dictionary 246 # @return List of key pair keywords 247 ######################################################################## 248 """ 249 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 250 return eval(distro_file)[i_type].items() 251 def get_strip_string(self, i_str): 252 r""" 253 ######################################################################## 254 # @brief Returns the stripped strings 255 # @param i_str: @type string: string name 256 # @return Remove all special chars and return the string 257 ######################################################################## 258 """ 259 return ''.join(e for e in i_str if e.isalnum()) 260 def get_esel_index(self, esel_list): 261 r""" 262 ####################################################################### 263 # @brief Returns the eSEL binary index. 264 # @param esel_ist: @type list: eSEL list. 265 # @return Index of "ESEL=" in the list. 266 ####################################################################### 267 """ 268 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str] 269 return index[0] 270