blob: 6506fc9e68268517f7c1d3f2aed9790ff9af9e28 [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 {
Michael Walshe53e47a2017-06-30 17:03:24 -050031 'BMC state': '/usr/sbin/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
39 'BMC_proc_list': 'top -n 1 -b',
George Keishing158a76c2017-07-18 00:53:37 -050040 'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
George Keishingf6cc55e2017-08-30 04:16:21 -050041 'BMC_journalctl_nopager': 'journalctl --no-pager',
42 'BMC_journalctl_pretty': 'journalctl -o json-pretty',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050043 'BMC_dmesg': 'dmesg',
Gunnar Millsaca140d2016-10-26 13:05:10 -050044 'BMC_procinfo': 'cat /proc/cpuinfo',
45 'BMC_meminfo': 'cat /proc/meminfo',
George Keishing6ce48132017-11-13 10:46:02 -060046 'BMC_systemd': 'systemctl status --all',
George Keishing0a579cb2018-11-26 21:41:06 -060047 'SOL': 'cat /var/log/obmc-console.log',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050048 },
49}
Gunnar Mills7e2cda22016-10-11 15:37:34 -050050# Add file name and correcponding command needed for all Linux distributions
51FFDC_OS_ALL_DISTROS_FILE = {
52 'OS FILES':
53 {
54 # File Name Command
55 'OS_msglog': 'cat /sys/firmware/opal/msglog',
56 'OS_cpufrequency': 'ppc64_cpu --frequency',
57 'OS_dmesg': 'dmesg',
Michael Walshef19da62018-04-25 16:13:49 -050058 'OS_opal_prd': 'cat /var/log/opal-prd*',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050059 'OS_boot': 'cat /var/log/boot.log',
Gunnar Millsaca140d2016-10-26 13:05:10 -050060 'OS_procinfo': 'cat /proc/cpuinfo',
61 'OS_meminfo': 'cat /proc/meminfo',
62 'OS_netstat': 'netstat -a',
Steven Sombar60ade082017-08-16 11:27:26 -050063 'OS_lspci': 'lspci',
64 'OS_lscpu': 'lscpu',
65 'OS_lscfg': 'lscfg',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050066 },
67}
Gunnar Millscce185d2016-10-17 17:04:15 -050068# Add file name and correcponding command needed for Ubuntu Linux
69FFDC_OS_UBUNTU_FILE = {
70 'OS FILES':
71 {
72 # File Name Command
73 'OS_isusb': 'lsusb -t ; lsusb -v',
74 'OS_kern': 'tail -n 50000 /var/log/kern.log',
75 'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
76 'OS_syslog': 'tail -n 200000 /var/log/syslog',
77 'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
78 },
79}
Gunnar Millscce185d2016-10-17 17:04:15 -050080# Add file name and correcponding command needed for RHEL Linux
81FFDC_OS_RHEL_FILE = {
82 'OS FILES':
83 {
84 # File Name Command
85 'OS_rsct': '/usr/bin/ctversion -bv',
86 'OS_secure': 'cat /var/log/secure',
87 'OS_syslog': 'tail -n 200000 /var/log/messages',
88 'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
89 },
90}
Gunnar Millscce185d2016-10-17 17:04:15 -050091# Add file name and correcponding command needed for RHEL Linux
92FFDC_OS_IBM_POWERKVM_FILE = {
93 'OS FILES':
94 {
95 # File Name Command
96 'OS_secure': 'cat /var/log/secure',
97 'OS_syslog': 'tail -n 200000 /var/log/messages',
98 'OS_info': 'lsb_release -a; uname -a; rpm -qa',
99 },
100}
George Keishingf77ea872017-09-01 08:02:21 -0500101OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500102OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600103ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500104ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
105ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
106ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
107ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
108ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
George Keishing9be77cd2017-11-13 07:52:08 -0600109ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
George Keishingba000382017-09-19 13:25:29 -0500110ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500111ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
George Keishing42ebe192018-10-10 14:17:51 -0500112ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500113
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500114# Add file name and correcponding Get Request
115FFDC_GET_REQUEST = {
116 'GET REQUESTS':
117 {
118 # File Name Command
George Keishingf77ea872017-09-01 08:02:21 -0500119 'FIRMWARE_list': ENUMERATE_SW,
George Keishingfe5724d2016-11-23 09:25:36 -0600120 'BMC_sensor_list': ENUMERATE_SENSORS,
George Keishing49e24a72017-08-09 11:37:42 -0500121 'BMC_control_list': ENUMERATE_CONTROL,
George Keishingf77ea872017-09-01 08:02:21 -0500122 'BMC_inventory': ENUMERATE_INVENTORY,
George Keishingc06fc992017-02-22 09:01:08 -0600123 'BMC_elog': ENUMERATE_ELOG,
George Keishingf77ea872017-09-01 08:02:21 -0500124 'BMC_led': ENUMERATE_LED,
George Keishing9be77cd2017-11-13 07:52:08 -0600125 'BMC_state': ENUMERATE_STATE,
George Keishingba000382017-09-19 13:25:29 -0500126 'OCC_state': ENUMERATE_OCC,
Sweta Potthuria82efd62017-10-18 05:34:59 -0500127 'BMC_dumps': ENUMERATE_DUMPS,
George Keishing42ebe192018-10-10 14:17:51 -0500128 'BMC_USER': ENUMERATE_USER,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500129 },
130}
George Keishing69e6f712016-09-12 06:30:09 -0500131# Define your keywords in method/utils and call here
132FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500133 'BMC LOGS':
134 {
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500135 # Description Keyword name
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500136 'FFDC Generic Report': 'BMC FFDC Manifest',
137 'BMC Specific Files': 'BMC FFDC Files',
138 'Get Request FFDC': 'BMC FFDC Get Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500139 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600140 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500141 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500142 'Sys Inventory Files': 'System Inventory Files',
Sweta Potthuria82efd62017-10-18 05:34:59 -0500143 'Dump Log': 'Collect Dump Log',
Steven Sombar2da175f2019-02-04 10:32:58 -0600144 'Dump Files': 'SCP Dump Files',
145 'Redfish Log': 'Enumerate Redfish Resources',
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500146 },
147}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500148# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500149# base class for FFDC default list
Gunnar Mills096cd562018-03-26 10:19:12 -0500150
151
George Keishing4346a412016-07-19 11:26:49 -0500152class openbmc_ffdc_list():
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500153 def get_ffdc_bmc_cmd(self, i_type):
154 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500155 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500156 # @brief This method returns the list from the dictionary for cmds
157 # @param i_type: @type string: string index lookup
158 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500159 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500160 """
George Keishing69e6f712016-09-12 06:30:09 -0500161 return FFDC_BMC_CMD[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500162
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500163 def get_ffdc_bmc_file(self, i_type):
164 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500165 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500166 # @brief This method returns the list from the dictionary for scp
167 # @param i_type: @type string: string index lookup
168 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500169 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500170 """
George Keishing69e6f712016-09-12 06:30:09 -0500171 return FFDC_BMC_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500172
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500173 def get_ffdc_get_request(self, i_type):
174 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500175 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500176 # @brief This method returns the list from the dictionary for scp
177 # @param i_type: @type string: string index lookup
178 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500179 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500180 """
181 return FFDC_GET_REQUEST[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500182
George Keishing69e6f712016-09-12 06:30:09 -0500183 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500184 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500185 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500186 # @brief This method returns the list index from dictionary
187 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500188 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500189 """
George Keishing69e6f712016-09-12 06:30:09 -0500190 return FFDC_BMC_CMD.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500191
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500192 def get_ffdc_get_request_index(self):
193 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500194 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500195 # @brief This method returns the list index from dictionary
196 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500197 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500198 """
199 return FFDC_GET_REQUEST.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500200
George Keishing69e6f712016-09-12 06:30:09 -0500201 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500202 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500203 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500204 # @brief This method returns the list index from dictionary
205 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500206 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500207 """
George Keishing69e6f712016-09-12 06:30:09 -0500208 return FFDC_BMC_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500209
George Keishing69e6f712016-09-12 06:30:09 -0500210 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500211 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500212 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500213 # @brief This method returns the key pair from the dictionary
214 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500215 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500216 """
George Keishing69e6f712016-09-12 06:30:09 -0500217 return FFDC_METHOD_CALL.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500218
Michael Walshe844e9a2017-04-20 16:51:10 -0500219 def get_ffdc_method_desc(self,
220 index):
221 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500222 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500223 # @brief This method returns the just the keys from the dictionary.
224 # @return List of ffdc descriptions.
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500225 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500226 """
227 return FFDC_METHOD_CALL[index].keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500228
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500229 def get_ffdc_method_call(self, i_type):
230 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500231 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500232 # @brief This method returns the key pair from the dictionary
233 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500234 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500235 """
George Keishing69e6f712016-09-12 06:30:09 -0500236 return FFDC_METHOD_CALL[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500237
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500238 def get_ffdc_os_all_distros_index(self):
239 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500240 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500241 # @brief This method returns the key pair from the dictionary
242 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500243 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500244 """
245 return FFDC_OS_ALL_DISTROS_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500246
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500247 def get_ffdc_os_all_distros_call(self, i_type):
248 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500249 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500250 # @brief This method returns the key pair from the dictionary
251 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500252 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500253 """
254 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500255
Gunnar Millscce185d2016-10-17 17:04:15 -0500256 def get_ffdc_os_distro_index(self, distro):
257 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500258 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500259 # @brief This method returns the key pair from the dictionary
260 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500261 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500262 """
263 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
264 return eval(distro_file).keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500265
Gunnar Millscce185d2016-10-17 17:04:15 -0500266 def get_ffdc_os_distro_call(self, i_type, distro):
267 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500268 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500269 # @brief This method returns the key pair from the dictionary
270 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500271 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500272 """
273 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
274 return eval(distro_file)[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500275
George Keishing4346a412016-07-19 11:26:49 -0500276 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500277 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500278 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500279 # @brief Returns the stripped strings
280 # @param i_str: @type string: string name
281 # @return Remove all special chars and return the string
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500282 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500283 """
George Keishing4346a412016-07-19 11:26:49 -0500284 return ''.join(e for e in i_str if e.isalnum())
Gunnar Mills096cd562018-03-26 10:19:12 -0500285
George Keishing28da9482017-07-27 13:38:54 -0500286 def get_esel_index(self, esel_list):
287 r"""
288 #######################################################################
289 # @brief Returns the eSEL binary index.
290 # @param esel_ist: @type list: eSEL list.
291 # @return Index of "ESEL=" in the list.
292 #######################################################################
293 """
294 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
295 return index[0]
Sweta Potthuria82efd62017-10-18 05:34:59 -0500296
297 def get_dump_index(self, dump_list):
298 r"""
299 #######################################################################
300 # @brief Returns the eSEL binary index.
301 # @param esel_ist: @type list: eSEL list.
302 # @return Index of "ESEL=" in the list.
303 #######################################################################
304 """
305 index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
306 return index[0]