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;cat /proc/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/bin/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_flash_side.txt': 'cat /sys/class/watchdog/watchdog1/bootstatus >/tmp/BMC_flash_side.txt 2>&1', 40 'BMC_hwmon.txt': 'grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1', 41 'BMC_proc_list.txt': 'top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1', 42 'BMC_proc_fd_active_list.txt': 'ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1', 43 'BMC_journalctl_nopager.txt': 'journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1', 44 'BMC_journalctl_pretty.json': 'journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json 2>&1', 45 'BMC_dmesg.txt': 'dmesg >/tmp/BMC_dmesg.txt 2>&1', 46 'BMC_procinfo.txt': 'cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1', 47 'BMC_meminfo.txt': 'cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1', 48 'BMC_systemd.txt': 'systemctl status --all >/tmp/BMC_systemd.txt 2>&1', 49 'BMC_failed_service.txt': 'systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1', 50 'BMC_list_service.txt': 'systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1', 51 'BMC_obmc_console.txt': 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1', 52 'PEL_logs_list.json': 'peltool -l >/tmp/PEL_logs_list.json 2>&1', 53 'PEL_logs_display.json': 'peltool -a >/tmp/PEL_logs_display.json 2>&1', 54 }, 55} 56# Add file name and corresponding command needed for all Linux distributions 57FFDC_OS_ALL_DISTROS_FILE = { 58 'OS FILES': 59 { 60 # File Name Command 61 'OS_msglog.txt': 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1', 62 'OS_cpufrequency.txt': 'ppc64_cpu --frequency ' 63 + '>/tmp/OS_cpufrequency.txt 2>&1', 64 'OS_dmesg.txt': 'dmesg >/tmp/OS_dmesg.txt 2>&1', 65 'OS_opal_prd.txt': 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1', 66 'OS_boot.txt': 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1', 67 'OS_procinfo.txt': 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1', 68 'OS_meminfo.txt': 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1', 69 'OS_netstat.txt': 'netstat -a >/tmp/OS_netstat.txt 2>&1', 70 'OS_lspci.txt': 'lspci >/tmp/OS_lspci.txt 2>&1', 71 'OS_lscpu.txt': 'lscpu >/tmp/OS_lscpu.txt 2>&1', 72 'OS_lscfg.txt': 'lscfg >/tmp/OS_lscfg.txt 2>&1', 73 'OS_journalctl_nopager.txt': 'journalctl --no-pager -b ' 74 + '> /tmp/OS_journalctl_nopager.txt 2>&1', 75 }, 76} 77# Add file name and correcponding command needed for Ubuntu Linux 78FFDC_OS_UBUNTU_FILE = { 79 'OS FILES': 80 { 81 # File Name Command 82 'OS_isusb.txt': '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isub.txt 2>&1', 83 'OS_kern.txt': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1', 84 'OS_authlog.txt': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } ' 85 + '>/tmp/OS_authlog.txt 2>&1', 86 'OS_syslog.txt': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1', 87 'OS_info.txt': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } ' 88 + '>/tmp/OS_info.txt 2>&1', 89 'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir ' 90 + '/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1', 91 }, 92} 93# Add file name and correcponding command needed for RHEL Linux 94FFDC_OS_RHEL_FILE = { 95 'OS FILES': 96 { 97 # File Name Command 98 'OS_rsct.txt': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1', 99 'OS_secure.txt': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1', 100 'OS_syslog.txt': 'tail -n 200000 /var/log/messages ' 101 + '>/tmp/OS_syslog.txt 2>&1', 102 'OS_info.txt': '{ lsb_release -a; cat /etc/redhat-release; ' 103 + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1', 104 'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir ' 105 + '/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1', 106 }, 107} 108 109OPENBMC_BASE = '/xyz/openbmc_project/' 110OPENPOWER_BASE = '/org/open_power/' 111ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate' 112ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate' 113ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate' 114ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate' 115ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate' 116ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate' 117ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate' 118ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate' 119ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate' 120ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate' 121 122# Add file name and correcponding Get Request 123FFDC_GET_REQUEST = { 124 'GET REQUESTS': 125 { 126 # File Name Command 127 'FIRMWARE_list.txt': ENUMERATE_SW, 128 'BMC_sensor_list.txt': ENUMERATE_SENSORS, 129 'BMC_control_list.txt': ENUMERATE_CONTROL, 130 'BMC_inventory.txt': ENUMERATE_INVENTORY, 131 'BMC_elog.txt': ENUMERATE_ELOG, 132 'BMC_led.txt': ENUMERATE_LED, 133 'BMC_state.txt': ENUMERATE_STATE, 134 'OCC_state.txt': ENUMERATE_OCC, 135 'BMC_dumps.txt': ENUMERATE_DUMPS, 136 'BMC_USER.txt': ENUMERATE_USER, 137 }, 138} 139# Define your keywords in method/utils and call here 140FFDC_METHOD_CALL = { 141 'BMC LOGS': 142 { 143 # Description Keyword name 144 'FFDC Generic Report': 'BMC FFDC Manifest', 145 'BMC Specific Files': 'BMC FFDC Files', 146 'Get Request FFDC': 'BMC FFDC Get Requests', 147 'OS FFDC': 'OS FFDC Files', 148 'Core Files': 'SCP Coredump Files', 149 'SEL Log': 'Collect eSEL Log', 150 'Sys Inventory Files': 'System Inventory Files', 151 'Dump Log': 'Collect Dump Log', 152 'Dump Files': 'SCP Dump Files', 153 'PEL Files': 'Collect PEL Log', 154 'Redfish Log': 'Enumerate Redfish Resources', 155 }, 156} 157# ----------------------------------------------------------------- 158# base class for FFDC default list 159 160 161class openbmc_ffdc_list(): 162 def get_ffdc_bmc_cmd(self, i_type): 163 r""" 164 ####################################################################### 165 # @brief This method returns the list from the dictionary for cmds 166 # @param i_type: @type string: string index lookup 167 # @return List of key pair from the dictionary 168 ####################################################################### 169 """ 170 return FFDC_BMC_CMD[i_type].items() 171 172 def get_ffdc_bmc_file(self, i_type): 173 r""" 174 ####################################################################### 175 # @brief This method returns the list from the dictionary for scp 176 # @param i_type: @type string: string index lookup 177 # @return List of key pair from the dictionary 178 ####################################################################### 179 """ 180 return FFDC_BMC_FILE[i_type].items() 181 182 def get_ffdc_get_request(self, i_type): 183 r""" 184 ####################################################################### 185 # @brief This method returns the list from the dictionary for scp 186 # @param i_type: @type string: string index lookup 187 # @return List of key pair from the dictionary 188 ####################################################################### 189 """ 190 return FFDC_GET_REQUEST[i_type].items() 191 192 def get_ffdc_cmd_index(self): 193 r""" 194 ####################################################################### 195 # @brief This method returns the list index from dictionary 196 # @return List of index to the dictionary 197 ####################################################################### 198 """ 199 return FFDC_BMC_CMD.keys() 200 201 def get_ffdc_get_request_index(self): 202 r""" 203 ####################################################################### 204 # @brief This method returns the list index from dictionary 205 # @return List of index to the dictionary 206 ####################################################################### 207 """ 208 return FFDC_GET_REQUEST.keys() 209 210 def get_ffdc_file_index(self): 211 r""" 212 ####################################################################### 213 # @brief This method returns the list index from dictionary 214 # @return List of index to the dictionary 215 ####################################################################### 216 """ 217 return FFDC_BMC_FILE.keys() 218 219 def get_ffdc_method_index(self): 220 r""" 221 ####################################################################### 222 # @brief This method returns the key pair from the dictionary 223 # @return Index of the method dictionary 224 ####################################################################### 225 """ 226 return FFDC_METHOD_CALL.keys() 227 228 def get_ffdc_method_desc(self, 229 index): 230 r""" 231 ####################################################################### 232 # @brief This method returns the just the keys from the dictionary. 233 # @return List of ffdc descriptions. 234 ####################################################################### 235 """ 236 return FFDC_METHOD_CALL[index].keys() 237 238 def get_ffdc_method_call(self, i_type): 239 r""" 240 ####################################################################### 241 # @brief This method returns the key pair from the dictionary 242 # @return List of key pair keywords 243 ####################################################################### 244 """ 245 return FFDC_METHOD_CALL[i_type].items() 246 247 def get_ffdc_os_all_distros_index(self): 248 r""" 249 ####################################################################### 250 # @brief This method returns the key pair from the dictionary 251 # @return Index of the method dictionary 252 ####################################################################### 253 """ 254 return FFDC_OS_ALL_DISTROS_FILE.keys() 255 256 def get_ffdc_os_all_distros_call(self, i_type): 257 r""" 258 ####################################################################### 259 # @brief This method returns the key pair from the dictionary 260 # @return List of key pair keywords 261 ####################################################################### 262 """ 263 return FFDC_OS_ALL_DISTROS_FILE[i_type].items() 264 265 def get_ffdc_os_distro_index(self, distro): 266 r""" 267 ####################################################################### 268 # @brief This method returns the key pair from the dictionary 269 # @return Index of the method dictionary 270 ####################################################################### 271 """ 272 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 273 return eval(distro_file).keys() 274 275 def get_ffdc_os_distro_call(self, i_type, distro): 276 r""" 277 ####################################################################### 278 # @brief This method returns the key pair from the dictionary 279 # @return List of key pair keywords 280 ####################################################################### 281 """ 282 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 283 return eval(distro_file)[i_type].items() 284 285 def get_strip_string(self, i_str): 286 r""" 287 ####################################################################### 288 # @brief Returns the stripped strings 289 # @param i_str: @type string: string name 290 # @return Remove all special chars and return the string 291 ####################################################################### 292 """ 293 return ''.join(e for e in i_str if e.isalnum()) 294 295 def get_esel_index(self, esel_list): 296 r""" 297 ####################################################################### 298 # @brief Returns the eSEL binary index. 299 # @param esel_ist: @type list: eSEL list. 300 # @return Index of "ESEL=" in the list. 301 ####################################################################### 302 """ 303 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str] 304 return index[0] 305 306 def get_dump_index(self, dump_list): 307 r""" 308 ####################################################################### 309 # @brief Returns the eSEL binary index. 310 # @param esel_ist: @type list: eSEL list. 311 # @return Index of "ESEL=" in the list. 312 ####################################################################### 313 """ 314 index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str] 315 return index[0] 316