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