blob: 55ab33200cb38d9ed5117d172444da4f0034190d [file] [log] [blame]
George Keishing4346a412016-07-19 11:26:49 -05001#!/usr/bin/python
Gunnar Millsa812e0f2016-09-29 20:30:03 -05002r"""
George Keishing4346a412016-07-19 11:26:49 -05003# @file openbmc_ffdc_list.py
George Keishing4346a412016-07-19 11:26:49 -05004# @brief List for FFDC ( First failure data capture )
5# commands and files to be collected as a part
6# of the test case failure.
Gunnar Millsa812e0f2016-09-29 20:30:03 -05007"""
Gunnar Millsa812e0f2016-09-29 20:30:03 -05008# -------------------
George Keishing4346a412016-07-19 11:26:49 -05009# FFDC default list
Gunnar Millsa812e0f2016-09-29 20:30:03 -050010# -------------------
Gunnar Millsa812e0f2016-09-29 20:30:03 -050011# -----------------------------------------------------------------
Gunnar Mills28e403b2017-10-25 16:16:38 -050012# Dict Name { Index string : { Key String : Command string} }
Gunnar Millsa812e0f2016-09-29 20:30:03 -050013# -----------------------------------------------------------------
George Keishing69e6f712016-09-12 06:30:09 -050014# Add cmd's needed to be part of the ffdc report manifest file
15FFDC_BMC_CMD = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050016 'DRIVER INFO':
17 {
18 # String Name Command
Gunnar Millsa812e0f2016-09-29 20:30:03 -050019 'FW Level': 'cat /etc/os-release',
George Keishingc5ab1b62017-08-16 13:51:14 -050020 'FW Timestamp': 'cat /etc/timestamp',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050021 },
22 'BMC DATA':
23 {
24 'BMC OS': 'uname -a',
25 'BMC Uptime': 'uptime',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050026 'BMC File System Disk Space Usage': 'df -hT',
George Keishing342bcea2017-11-11 03:08:54 -060027 'BMC Date Time': 'date;/sbin/hwclock --show;/usr/bin/timedatectl'
Gunnar Millsa812e0f2016-09-29 20:30:03 -050028 },
29 'APPLICATION DATA':
30 {
George Keishing5bcbfba2019-04-19 12:31:16 -050031 'BMC state': '/usr/bin/obmcutil state',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050032 },
33}
George Keishing69e6f712016-09-12 06:30:09 -050034# Add file name and correcponding command needed for BMC
35FFDC_BMC_FILE = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050036 'BMC FILES':
37 {
38 # File Name Command
George Keishing5bf54f52019-04-09 14:30:21 -050039 'BMC_flash_side': 'cat /sys/class/watchdog/watchdog1/bootstatus',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050040 'BMC_proc_list': 'top -n 1 -b',
George Keishing158a76c2017-07-18 00:53:37 -050041 'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
George Keishingf6cc55e2017-08-30 04:16:21 -050042 'BMC_journalctl_nopager': 'journalctl --no-pager',
43 'BMC_journalctl_pretty': 'journalctl -o json-pretty',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050044 'BMC_dmesg': 'dmesg',
Gunnar Millsaca140d2016-10-26 13:05:10 -050045 'BMC_procinfo': 'cat /proc/cpuinfo',
46 'BMC_meminfo': 'cat /proc/meminfo',
George Keishing6ce48132017-11-13 10:46:02 -060047 'BMC_systemd': 'systemctl status --all',
George Keishing0a579cb2018-11-26 21:41:06 -060048 'SOL': 'cat /var/log/obmc-console.log',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050049 },
50}
Gunnar Mills7e2cda22016-10-11 15:37:34 -050051# Add file name and correcponding command needed for all Linux distributions
52FFDC_OS_ALL_DISTROS_FILE = {
53 'OS FILES':
54 {
55 # File Name Command
Steven Sombarfc024cb2019-04-22 11:16:16 -050056 'OS_msglog': 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1',
57 'OS_cpufrequency': 'ppc64_cpu --frequency '
58 + '>/tmp/OS_cpufrequency.txt 2>&1',
59 'OS_dmesg': 'dmesg >/tmp/OS_dmesg.txt 2>&1',
60 'OS_opal_prd': 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1',
61 'OS_boot': 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1',
62 'OS_procinfo': 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1',
63 'OS_meminfo': 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1',
64 'OS_netstat': 'netstat -a >/tmp/OS_netstat.txt 2>&1',
65 'OS_lspci': 'lspci >/tmp/OS_lspci.txt 2>&1',
66 'OS_lscpu': 'lscpu >/tmp/OS_lscpu.txt 2>&1',
67 'OS_lscfg': 'lscfg >/tmp/OS_lscfg.txt 2>&1',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050068 },
69}
Gunnar Millscce185d2016-10-17 17:04:15 -050070# Add file name and correcponding command needed for Ubuntu Linux
71FFDC_OS_UBUNTU_FILE = {
72 'OS FILES':
73 {
74 # File Name Command
Steven Sombarfc024cb2019-04-22 11:16:16 -050075 'OS_isusb': '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isub.txt 2>&1',
76 'OS_kern': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1',
77 'OS_authlog': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } '
78 + '>/tmp/OS_authlog.txt 2>&1',
79 'OS_syslog': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1',
80 'OS_info': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } '
81 + '>/tmp/OS_info.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -050082 },
83}
Gunnar Millscce185d2016-10-17 17:04:15 -050084# Add file name and correcponding command needed for RHEL Linux
85FFDC_OS_RHEL_FILE = {
86 'OS FILES':
87 {
88 # File Name Command
Steven Sombarfc024cb2019-04-22 11:16:16 -050089 'OS_rsct': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1',
90 'OS_secure': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
91 'OS_syslog': 'tail -n 200000 /var/log/messages '
92 + '>/tmp/OS_syslog.txt 2>&1',
93 'OS_info': '{ lsb_release -a; cat /etc/redhat-release; '
94 + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -050095 },
96}
Gunnar Millscce185d2016-10-17 17:04:15 -050097# Add file name and correcponding command needed for RHEL Linux
98FFDC_OS_IBM_POWERKVM_FILE = {
99 'OS FILES':
100 {
101 # File Name Command
Steven Sombarfc024cb2019-04-22 11:16:16 -0500102 'OS_secure': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
103 'OS_syslog': 'tail -n 200000 /var/log/messages '
104 + '>/tmp/OS_syslog.txt 2>&1',
105 'OS_info': '{ lsb_release -a; uname -a; rpm -qa ; } '
106 + '>/tmp/OS_info.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -0500107 },
108}
George Keishingf77ea872017-09-01 08:02:21 -0500109OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500110OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600111ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500112ENUMERATE_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'
George Keishing9be77cd2017-11-13 07:52:08 -0600117ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
George Keishing8d500452019-04-03 07:42:25 -0500118ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500119ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
George Keishing42ebe192018-10-10 14:17:51 -0500120ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500121
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500122# Add file name and correcponding Get Request
123FFDC_GET_REQUEST = {
124 'GET REQUESTS':
125 {
126 # File Name Command
George Keishingf77ea872017-09-01 08:02:21 -0500127 'FIRMWARE_list': ENUMERATE_SW,
George Keishingfe5724d2016-11-23 09:25:36 -0600128 'BMC_sensor_list': ENUMERATE_SENSORS,
George Keishing49e24a72017-08-09 11:37:42 -0500129 'BMC_control_list': ENUMERATE_CONTROL,
George Keishingf77ea872017-09-01 08:02:21 -0500130 'BMC_inventory': ENUMERATE_INVENTORY,
George Keishingc06fc992017-02-22 09:01:08 -0600131 'BMC_elog': ENUMERATE_ELOG,
George Keishingf77ea872017-09-01 08:02:21 -0500132 'BMC_led': ENUMERATE_LED,
George Keishing9be77cd2017-11-13 07:52:08 -0600133 'BMC_state': ENUMERATE_STATE,
George Keishingba000382017-09-19 13:25:29 -0500134 'OCC_state': ENUMERATE_OCC,
Sweta Potthuria82efd62017-10-18 05:34:59 -0500135 'BMC_dumps': ENUMERATE_DUMPS,
George Keishing42ebe192018-10-10 14:17:51 -0500136 'BMC_USER': ENUMERATE_USER,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500137 },
138}
George Keishing69e6f712016-09-12 06:30:09 -0500139# Define your keywords in method/utils and call here
140FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500141 'BMC LOGS':
142 {
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500143 # Description Keyword name
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500144 'FFDC Generic Report': 'BMC FFDC Manifest',
145 'BMC Specific Files': 'BMC FFDC Files',
146 'Get Request FFDC': 'BMC FFDC Get Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500147 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600148 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500149 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500150 'Sys Inventory Files': 'System Inventory Files',
Sweta Potthuria82efd62017-10-18 05:34:59 -0500151 'Dump Log': 'Collect Dump Log',
Steven Sombar2da175f2019-02-04 10:32:58 -0600152 'Dump Files': 'SCP Dump Files',
153 'Redfish Log': 'Enumerate Redfish Resources',
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500154 },
155}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500156# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500157# base class for FFDC default list
Gunnar Mills096cd562018-03-26 10:19:12 -0500158
159
George Keishing4346a412016-07-19 11:26:49 -0500160class openbmc_ffdc_list():
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500161 def get_ffdc_bmc_cmd(self, i_type):
162 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500163 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500164 # @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
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500167 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500168 """
George Keishing69e6f712016-09-12 06:30:09 -0500169 return FFDC_BMC_CMD[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500170
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500171 def get_ffdc_bmc_file(self, i_type):
172 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500173 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500174 # @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
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500177 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500178 """
George Keishing69e6f712016-09-12 06:30:09 -0500179 return FFDC_BMC_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500180
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500181 def get_ffdc_get_request(self, i_type):
182 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500183 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500184 # @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
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500187 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500188 """
189 return FFDC_GET_REQUEST[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500190
George Keishing69e6f712016-09-12 06:30:09 -0500191 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500192 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500193 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500194 # @brief This method returns the list index from dictionary
195 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500196 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500197 """
George Keishing69e6f712016-09-12 06:30:09 -0500198 return FFDC_BMC_CMD.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500199
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500200 def get_ffdc_get_request_index(self):
201 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500202 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500203 # @brief This method returns the list index from dictionary
204 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500205 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500206 """
207 return FFDC_GET_REQUEST.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500208
George Keishing69e6f712016-09-12 06:30:09 -0500209 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500210 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500211 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500212 # @brief This method returns the list index from dictionary
213 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500214 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500215 """
George Keishing69e6f712016-09-12 06:30:09 -0500216 return FFDC_BMC_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500217
George Keishing69e6f712016-09-12 06:30:09 -0500218 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500219 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500220 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500221 # @brief This method returns the key pair from the dictionary
222 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500223 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500224 """
George Keishing69e6f712016-09-12 06:30:09 -0500225 return FFDC_METHOD_CALL.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500226
Michael Walshe844e9a2017-04-20 16:51:10 -0500227 def get_ffdc_method_desc(self,
228 index):
229 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500230 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500231 # @brief This method returns the just the keys from the dictionary.
232 # @return List of ffdc descriptions.
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500233 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500234 """
235 return FFDC_METHOD_CALL[index].keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500236
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500237 def get_ffdc_method_call(self, i_type):
238 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500239 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500240 # @brief This method returns the key pair from the dictionary
241 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500242 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500243 """
George Keishing69e6f712016-09-12 06:30:09 -0500244 return FFDC_METHOD_CALL[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500245
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500246 def get_ffdc_os_all_distros_index(self):
247 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500248 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500249 # @brief This method returns the key pair from the dictionary
250 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500251 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500252 """
253 return FFDC_OS_ALL_DISTROS_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500254
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500255 def get_ffdc_os_all_distros_call(self, i_type):
256 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500257 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500258 # @brief This method returns the key pair from the dictionary
259 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500260 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500261 """
262 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500263
Gunnar Millscce185d2016-10-17 17:04:15 -0500264 def get_ffdc_os_distro_index(self, distro):
265 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500266 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500267 # @brief This method returns the key pair from the dictionary
268 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500269 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500270 """
271 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
272 return eval(distro_file).keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500273
Gunnar Millscce185d2016-10-17 17:04:15 -0500274 def get_ffdc_os_distro_call(self, i_type, distro):
275 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500276 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500277 # @brief This method returns the key pair from the dictionary
278 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500279 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500280 """
281 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
282 return eval(distro_file)[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500283
George Keishing4346a412016-07-19 11:26:49 -0500284 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500285 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500286 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500287 # @brief Returns the stripped strings
288 # @param i_str: @type string: string name
289 # @return Remove all special chars and return the string
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500290 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500291 """
George Keishing4346a412016-07-19 11:26:49 -0500292 return ''.join(e for e in i_str if e.isalnum())
Gunnar Mills096cd562018-03-26 10:19:12 -0500293
George Keishing28da9482017-07-27 13:38:54 -0500294 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]
Sweta Potthuria82efd62017-10-18 05:34:59 -0500304
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]