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