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' 109ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate' 110 111# Add file name and correcponding Get Request 112FFDC_GET_REQUEST = { 113 'GET REQUESTS': 114 { 115 # File Name Command 116 'FIRMWARE_list': ENUMERATE_SW, 117 'BMC_sensor_list': ENUMERATE_SENSORS, 118 'BMC_control_list': ENUMERATE_CONTROL, 119 'BMC_inventory': ENUMERATE_INVENTORY, 120 'BMC_elog': ENUMERATE_ELOG, 121 'BMC_led': ENUMERATE_LED, 122 'BMC_state': ENUMERATE_STATE, 123 'OCC_state': ENUMERATE_OCC, 124 'BMC_dumps': ENUMERATE_DUMPS, 125 }, 126} 127# Define your keywords in method/utils and call here 128FFDC_METHOD_CALL = { 129 'BMC LOGS': 130 { 131 # Description Keyword name 132 'FFDC Generic Report': 'BMC FFDC Manifest', 133 'BMC Specific Files': 'BMC FFDC Files', 134 'Get Request FFDC': 'BMC FFDC Get Requests', 135 'OS FFDC': 'OS FFDC Files', 136 'Core Files': 'SCP Coredump Files', 137 'SEL Log': 'Collect eSEL Log', 138 'Sys Inventory Files': 'System Inventory Files', 139 'Dump Log': 'Collect Dump Log', 140 'Dump Files': 'SCP Dump Files' 141 }, 142} 143# ----------------------------------------------------------------- 144# base class for FFDC default list 145 146 147class openbmc_ffdc_list(): 148 def get_ffdc_bmc_cmd(self, i_type): 149 r""" 150 ######################################################################## 151 # @brief This method returns the list from the dictionary for cmds 152 # @param i_type: @type string: string index lookup 153 # @return List of key pair from the dictionary 154 ######################################################################## 155 """ 156 return FFDC_BMC_CMD[i_type].items() 157 158 def get_ffdc_bmc_file(self, i_type): 159 r""" 160 ######################################################################## 161 # @brief This method returns the list from the dictionary for scp 162 # @param i_type: @type string: string index lookup 163 # @return List of key pair from the dictionary 164 ######################################################################## 165 """ 166 return FFDC_BMC_FILE[i_type].items() 167 168 def get_ffdc_get_request(self, i_type): 169 r""" 170 ######################################################################## 171 # @brief This method returns the list from the dictionary for scp 172 # @param i_type: @type string: string index lookup 173 # @return List of key pair from the dictionary 174 ######################################################################## 175 """ 176 return FFDC_GET_REQUEST[i_type].items() 177 178 def get_ffdc_cmd_index(self): 179 r""" 180 ######################################################################## 181 # @brief This method returns the list index from dictionary 182 # @return List of index to the dictionary 183 ######################################################################## 184 """ 185 return FFDC_BMC_CMD.keys() 186 187 def get_ffdc_get_request_index(self): 188 r""" 189 ######################################################################## 190 # @brief This method returns the list index from dictionary 191 # @return List of index to the dictionary 192 ######################################################################## 193 """ 194 return FFDC_GET_REQUEST.keys() 195 196 def get_ffdc_file_index(self): 197 r""" 198 ######################################################################## 199 # @brief This method returns the list index from dictionary 200 # @return List of index to the dictionary 201 ######################################################################## 202 """ 203 return FFDC_BMC_FILE.keys() 204 205 def get_ffdc_method_index(self): 206 r""" 207 ######################################################################## 208 # @brief This method returns the key pair from the dictionary 209 # @return Index of the method dictionary 210 ######################################################################## 211 """ 212 return FFDC_METHOD_CALL.keys() 213 214 def get_ffdc_method_desc(self, 215 index): 216 r""" 217 ######################################################################## 218 # @brief This method returns the just the keys from the dictionary. 219 # @return List of ffdc descriptions. 220 ######################################################################## 221 """ 222 return FFDC_METHOD_CALL[index].keys() 223 224 def get_ffdc_method_call(self, i_type): 225 r""" 226 ######################################################################## 227 # @brief This method returns the key pair from the dictionary 228 # @return List of key pair keywords 229 ######################################################################## 230 """ 231 return FFDC_METHOD_CALL[i_type].items() 232 233 def get_ffdc_os_all_distros_index(self): 234 r""" 235 ######################################################################## 236 # @brief This method returns the key pair from the dictionary 237 # @return Index of the method dictionary 238 ######################################################################## 239 """ 240 return FFDC_OS_ALL_DISTROS_FILE.keys() 241 242 def get_ffdc_os_all_distros_call(self, i_type): 243 r""" 244 ######################################################################## 245 # @brief This method returns the key pair from the dictionary 246 # @return List of key pair keywords 247 ######################################################################## 248 """ 249 return FFDC_OS_ALL_DISTROS_FILE[i_type].items() 250 251 def get_ffdc_os_distro_index(self, distro): 252 r""" 253 ######################################################################## 254 # @brief This method returns the key pair from the dictionary 255 # @return Index of the method dictionary 256 ######################################################################## 257 """ 258 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 259 return eval(distro_file).keys() 260 261 def get_ffdc_os_distro_call(self, i_type, distro): 262 r""" 263 ######################################################################## 264 # @brief This method returns the key pair from the dictionary 265 # @return List of key pair keywords 266 ######################################################################## 267 """ 268 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 269 return eval(distro_file)[i_type].items() 270 271 def get_strip_string(self, i_str): 272 r""" 273 ######################################################################## 274 # @brief Returns the stripped strings 275 # @param i_str: @type string: string name 276 # @return Remove all special chars and return the string 277 ######################################################################## 278 """ 279 return ''.join(e for e in i_str if e.isalnum()) 280 281 def get_esel_index(self, esel_list): 282 r""" 283 ####################################################################### 284 # @brief Returns the eSEL binary index. 285 # @param esel_ist: @type list: eSEL list. 286 # @return Index of "ESEL=" in the list. 287 ####################################################################### 288 """ 289 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str] 290 return index[0] 291 292 def get_dump_index(self, dump_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(dump_list) if 'DUMP=' in str] 301 return index[0] 302