blob: 25356df059f7f6a367b856736b2193ca6c45fee8 [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',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050047 },
48}
Gunnar Mills7e2cda22016-10-11 15:37:34 -050049# 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',
Gunnar Millsaca140d2016-10-26 13:05:10 -050058 'OS_procinfo': 'cat /proc/cpuinfo',
59 'OS_meminfo': 'cat /proc/meminfo',
60 'OS_netstat': 'netstat -a',
Steven Sombar60ade082017-08-16 11:27:26 -050061 'OS_lspci': 'lspci',
62 'OS_lscpu': 'lscpu',
63 'OS_lscfg': 'lscfg',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050064 },
65}
Gunnar Millscce185d2016-10-17 17:04:15 -050066# 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}
Gunnar Millscce185d2016-10-17 17:04:15 -050078# 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}
Gunnar Millscce185d2016-10-17 17:04:15 -050089# 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}
George Keishingf77ea872017-09-01 08:02:21 -050099OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500100OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600101ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500102ENUMERATE_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'
George Keishing9be77cd2017-11-13 07:52:08 -0600107ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
George Keishingba000382017-09-19 13:25:29 -0500108ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500109ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
110
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500111# Add file name and correcponding Get Request
112FFDC_GET_REQUEST = {
113 'GET REQUESTS':
114 {
115 # File Name Command
George Keishingf77ea872017-09-01 08:02:21 -0500116 'FIRMWARE_list': ENUMERATE_SW,
George Keishingfe5724d2016-11-23 09:25:36 -0600117 'BMC_sensor_list': ENUMERATE_SENSORS,
George Keishing49e24a72017-08-09 11:37:42 -0500118 'BMC_control_list': ENUMERATE_CONTROL,
George Keishingf77ea872017-09-01 08:02:21 -0500119 'BMC_inventory': ENUMERATE_INVENTORY,
George Keishingc06fc992017-02-22 09:01:08 -0600120 'BMC_elog': ENUMERATE_ELOG,
George Keishingf77ea872017-09-01 08:02:21 -0500121 'BMC_led': ENUMERATE_LED,
George Keishing9be77cd2017-11-13 07:52:08 -0600122 'BMC_state': ENUMERATE_STATE,
George Keishingba000382017-09-19 13:25:29 -0500123 'OCC_state': ENUMERATE_OCC,
Sweta Potthuria82efd62017-10-18 05:34:59 -0500124 'BMC_dumps': ENUMERATE_DUMPS,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500125 },
126}
George Keishing69e6f712016-09-12 06:30:09 -0500127# Define your keywords in method/utils and call here
128FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500129 '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',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500135 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600136 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500137 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500138 'Sys Inventory Files': 'System Inventory Files',
Sweta Potthuria82efd62017-10-18 05:34:59 -0500139 'Dump Log': 'Collect Dump Log',
140 'Dump Files': 'SCP Dump Files'
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500141 },
142}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500143# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500144# base class for FFDC default list
Gunnar Mills096cd562018-03-26 10:19:12 -0500145
146
George Keishing4346a412016-07-19 11:26:49 -0500147class openbmc_ffdc_list():
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500148 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 """
George Keishing69e6f712016-09-12 06:30:09 -0500156 return FFDC_BMC_CMD[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500157
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500158 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 """
George Keishing69e6f712016-09-12 06:30:09 -0500166 return FFDC_BMC_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500167
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500168 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500177
George Keishing69e6f712016-09-12 06:30:09 -0500178 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500179 r"""
180 ########################################################################
181 # @brief This method returns the list index from dictionary
182 # @return List of index to the dictionary
183 ########################################################################
184 """
George Keishing69e6f712016-09-12 06:30:09 -0500185 return FFDC_BMC_CMD.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500186
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500187 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500195
George Keishing69e6f712016-09-12 06:30:09 -0500196 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500197 r"""
198 ########################################################################
199 # @brief This method returns the list index from dictionary
200 # @return List of index to the dictionary
201 ########################################################################
202 """
George Keishing69e6f712016-09-12 06:30:09 -0500203 return FFDC_BMC_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500204
George Keishing69e6f712016-09-12 06:30:09 -0500205 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500206 r"""
207 ########################################################################
208 # @brief This method returns the key pair from the dictionary
209 # @return Index of the method dictionary
210 ########################################################################
211 """
George Keishing69e6f712016-09-12 06:30:09 -0500212 return FFDC_METHOD_CALL.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500213
Michael Walshe844e9a2017-04-20 16:51:10 -0500214 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500223
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500224 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 """
George Keishing69e6f712016-09-12 06:30:09 -0500231 return FFDC_METHOD_CALL[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500232
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500233 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500241
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500242 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500250
Gunnar Millscce185d2016-10-17 17:04:15 -0500251 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500260
Gunnar Millscce185d2016-10-17 17:04:15 -0500261 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()
Gunnar Mills096cd562018-03-26 10:19:12 -0500270
George Keishing4346a412016-07-19 11:26:49 -0500271 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500272 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 """
George Keishing4346a412016-07-19 11:26:49 -0500279 return ''.join(e for e in i_str if e.isalnum())
Gunnar Mills096cd562018-03-26 10:19:12 -0500280
George Keishing28da9482017-07-27 13:38:54 -0500281 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]
Sweta Potthuria82efd62017-10-18 05:34:59 -0500291
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]