blob: 27e9b7789336fe01b879be335351549eb26217d7 [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#############################################################
4# @file openbmc_ffdc_list.py
George Keishing4346a412016-07-19 11:26:49 -05005#
6# @brief List for FFDC ( First failure data capture )
7# commands and files to be collected as a part
8# of the test case failure.
9#############################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -050010"""
George Keishing4346a412016-07-19 11:26:49 -050011
Gunnar Millsa812e0f2016-09-29 20:30:03 -050012# -------------------
George Keishing4346a412016-07-19 11:26:49 -050013# FFDC default list
Gunnar Millsa812e0f2016-09-29 20:30:03 -050014# -------------------
George Keishing4346a412016-07-19 11:26:49 -050015
Gunnar Millsa812e0f2016-09-29 20:30:03 -050016# -----------------------------------------------------------------
17# Dict Name { Index string : { Key String : Comand string} }
18# -----------------------------------------------------------------
George Keishing69e6f712016-09-12 06:30:09 -050019# Add cmd's needed to be part of the ffdc report manifest file
20FFDC_BMC_CMD = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050021 'DRIVER INFO':
22 {
23 # String Name Command
Gunnar Millsa812e0f2016-09-29 20:30:03 -050024 'FW Level': 'cat /etc/os-release',
George Keishingc5ab1b62017-08-16 13:51:14 -050025 'FW Timestamp': 'cat /etc/timestamp',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050026 },
27 'BMC DATA':
28 {
29 'BMC OS': 'uname -a',
30 'BMC Uptime': 'uptime',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050031 'BMC File System Disk Space Usage': 'df -hT',
32 },
33 'APPLICATION DATA':
34 {
Michael Walshe53e47a2017-06-30 17:03:24 -050035 'BMC state': '/usr/sbin/obmcutil state',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050036 },
37}
George Keishing4346a412016-07-19 11:26:49 -050038
George Keishing69e6f712016-09-12 06:30:09 -050039# Add file name and correcponding command needed for BMC
40FFDC_BMC_FILE = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050041 'BMC FILES':
42 {
43 # File Name Command
44 'BMC_proc_list': 'top -n 1 -b',
George Keishing158a76c2017-07-18 00:53:37 -050045 'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
George Keishingf6cc55e2017-08-30 04:16:21 -050046 'BMC_journalctl_nopager': 'journalctl --no-pager',
47 'BMC_journalctl_pretty': 'journalctl -o json-pretty',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050048 'BMC_dmesg': 'dmesg',
Gunnar Millsaca140d2016-10-26 13:05:10 -050049 'BMC_procinfo': 'cat /proc/cpuinfo',
50 'BMC_meminfo': 'cat /proc/meminfo',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050051 },
52}
53
Gunnar Mills7e2cda22016-10-11 15:37:34 -050054# Add file name and correcponding command needed for all Linux distributions
55FFDC_OS_ALL_DISTROS_FILE = {
56 'OS FILES':
57 {
58 # File Name Command
59 'OS_msglog': 'cat /sys/firmware/opal/msglog',
60 'OS_cpufrequency': 'ppc64_cpu --frequency',
61 'OS_dmesg': 'dmesg',
62 'OS_boot': 'cat /var/log/boot.log',
Gunnar Millsaca140d2016-10-26 13:05:10 -050063 'OS_procinfo': 'cat /proc/cpuinfo',
64 'OS_meminfo': 'cat /proc/meminfo',
65 'OS_netstat': 'netstat -a',
Steven Sombar60ade082017-08-16 11:27:26 -050066 'OS_lspci': 'lspci',
67 'OS_lscpu': 'lscpu',
68 'OS_lscfg': 'lscfg',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050069 },
70}
71
Gunnar Millscce185d2016-10-17 17:04:15 -050072# Add file name and correcponding command needed for Ubuntu Linux
73FFDC_OS_UBUNTU_FILE = {
74 'OS FILES':
75 {
76 # File Name Command
77 'OS_isusb': 'lsusb -t ; lsusb -v',
78 'OS_kern': 'tail -n 50000 /var/log/kern.log',
79 'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
80 'OS_syslog': 'tail -n 200000 /var/log/syslog',
81 'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
82 },
83}
84
85# Add file name and correcponding command needed for RHEL Linux
86FFDC_OS_RHEL_FILE = {
87 'OS FILES':
88 {
89 # File Name Command
90 'OS_rsct': '/usr/bin/ctversion -bv',
91 'OS_secure': 'cat /var/log/secure',
92 'OS_syslog': 'tail -n 200000 /var/log/messages',
93 'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
94 },
95}
96
97# Add file name and correcponding command needed for RHEL Linux
98FFDC_OS_IBM_POWERKVM_FILE = {
99 'OS FILES':
100 {
101 # File Name Command
102 'OS_secure': 'cat /var/log/secure',
103 'OS_syslog': 'tail -n 200000 /var/log/messages',
104 'OS_info': 'lsb_release -a; uname -a; rpm -qa',
105 },
106}
107
George Keishingf77ea872017-09-01 08:02:21 -0500108OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500109OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600110ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500111ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
112ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
113ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
114ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
115ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
George Keishingba000382017-09-19 13:25:29 -0500116ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
George Keishing49e24a72017-08-09 11:37:42 -0500117
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500118# Add file name and correcponding Get Request
119FFDC_GET_REQUEST = {
120 'GET REQUESTS':
121 {
122 # File Name Command
George Keishingf77ea872017-09-01 08:02:21 -0500123 'FIRMWARE_list': ENUMERATE_SW,
George Keishingfe5724d2016-11-23 09:25:36 -0600124 'BMC_sensor_list': ENUMERATE_SENSORS,
George Keishing49e24a72017-08-09 11:37:42 -0500125 'BMC_control_list': ENUMERATE_CONTROL,
George Keishingf77ea872017-09-01 08:02:21 -0500126 'BMC_inventory': ENUMERATE_INVENTORY,
George Keishingc06fc992017-02-22 09:01:08 -0600127 'BMC_elog': ENUMERATE_ELOG,
George Keishingf77ea872017-09-01 08:02:21 -0500128 'BMC_led': ENUMERATE_LED,
George Keishingba000382017-09-19 13:25:29 -0500129 'OCC_state': ENUMERATE_OCC,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500130 },
131}
132
George Keishing69e6f712016-09-12 06:30:09 -0500133
134# Define your keywords in method/utils and call here
135FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500136 'BMC LOGS':
137 {
138 # Description Keyword name
139 'FFDC Generic Report': 'BMC FFDC Manifest',
140 'BMC Specific Files': 'BMC FFDC Files',
141 'Get Request FFDC': 'BMC FFDC Get Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500142 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600143 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500144 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500145 'Sys Inventory Files': 'System Inventory Files',
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500146 },
147}
George Keishing4346a412016-07-19 11:26:49 -0500148
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500149# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500150
151
152# base class for FFDC default list
153class openbmc_ffdc_list():
154
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500155 def get_ffdc_bmc_cmd(self, i_type):
156 r"""
157 ########################################################################
158 # @brief This method returns the list from the dictionary for cmds
159 # @param i_type: @type string: string index lookup
160 # @return List of key pair from the dictionary
161 ########################################################################
162 """
George Keishing69e6f712016-09-12 06:30:09 -0500163 return FFDC_BMC_CMD[i_type].items()
George Keishing4346a412016-07-19 11:26:49 -0500164
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500165 def get_ffdc_bmc_file(self, i_type):
166 r"""
167 ########################################################################
168 # @brief This method returns the list from the dictionary for scp
169 # @param i_type: @type string: string index lookup
170 # @return List of key pair from the dictionary
171 ########################################################################
172 """
George Keishing69e6f712016-09-12 06:30:09 -0500173 return FFDC_BMC_FILE[i_type].items()
George Keishing4346a412016-07-19 11:26:49 -0500174
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500175 def get_ffdc_get_request(self, i_type):
176 r"""
177 ########################################################################
178 # @brief This method returns the list from the dictionary for scp
179 # @param i_type: @type string: string index lookup
180 # @return List of key pair from the dictionary
181 ########################################################################
182 """
183 return FFDC_GET_REQUEST[i_type].items()
184
George Keishing69e6f712016-09-12 06:30:09 -0500185 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500186 r"""
187 ########################################################################
188 # @brief This method returns the list index from dictionary
189 # @return List of index to the dictionary
190 ########################################################################
191 """
George Keishing69e6f712016-09-12 06:30:09 -0500192 return FFDC_BMC_CMD.keys()
193
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500194 def get_ffdc_get_request_index(self):
195 r"""
196 ########################################################################
197 # @brief This method returns the list index from dictionary
198 # @return List of index to the dictionary
199 ########################################################################
200 """
201 return FFDC_GET_REQUEST.keys()
202
George Keishing69e6f712016-09-12 06:30:09 -0500203 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500204 r"""
205 ########################################################################
206 # @brief This method returns the list index from dictionary
207 # @return List of index to the dictionary
208 ########################################################################
209 """
George Keishing69e6f712016-09-12 06:30:09 -0500210 return FFDC_BMC_FILE.keys()
211
George Keishing69e6f712016-09-12 06:30:09 -0500212 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500213 r"""
214 ########################################################################
215 # @brief This method returns the key pair from the dictionary
216 # @return Index of the method dictionary
217 ########################################################################
218 """
George Keishing69e6f712016-09-12 06:30:09 -0500219 return FFDC_METHOD_CALL.keys()
220
Michael Walshe844e9a2017-04-20 16:51:10 -0500221 def get_ffdc_method_desc(self,
222 index):
223 r"""
224 ########################################################################
225 # @brief This method returns the just the keys from the dictionary.
226 # @return List of ffdc descriptions.
227 ########################################################################
228 """
229 return FFDC_METHOD_CALL[index].keys()
230
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500231 def get_ffdc_method_call(self, i_type):
232 r"""
233 ########################################################################
234 # @brief This method returns the key pair from the dictionary
235 # @return List of key pair keywords
236 ########################################################################
237 """
George Keishing69e6f712016-09-12 06:30:09 -0500238 return FFDC_METHOD_CALL[i_type].items()
George Keishing4346a412016-07-19 11:26:49 -0500239
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500240 def get_ffdc_os_all_distros_index(self):
241 r"""
242 ########################################################################
243 # @brief This method returns the key pair from the dictionary
244 # @return Index of the method dictionary
245 ########################################################################
246 """
247 return FFDC_OS_ALL_DISTROS_FILE.keys()
248
249 def get_ffdc_os_all_distros_call(self, i_type):
250 r"""
251 ########################################################################
252 # @brief This method returns the key pair from the dictionary
253 # @return List of key pair keywords
254 ########################################################################
255 """
256 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
257
Gunnar Millscce185d2016-10-17 17:04:15 -0500258 def get_ffdc_os_distro_index(self, distro):
259 r"""
260 ########################################################################
261 # @brief This method returns the key pair from the dictionary
262 # @return Index of the method dictionary
263 ########################################################################
264 """
265 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
266 return eval(distro_file).keys()
267
268 def get_ffdc_os_distro_call(self, i_type, distro):
269 r"""
270 ########################################################################
271 # @brief This method returns the key pair from the dictionary
272 # @return List of key pair keywords
273 ########################################################################
274 """
275 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
276 return eval(distro_file)[i_type].items()
277
George Keishing4346a412016-07-19 11:26:49 -0500278 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500279 r"""
280 ########################################################################
281 # @brief Returns the stripped strings
282 # @param i_str: @type string: string name
283 # @return Remove all special chars and return the string
284 ########################################################################
285 """
George Keishing4346a412016-07-19 11:26:49 -0500286 return ''.join(e for e in i_str if e.isalnum())
George Keishing28da9482017-07-27 13:38:54 -0500287
288 def get_esel_index(self, esel_list):
289 r"""
290 #######################################################################
291 # @brief Returns the eSEL binary index.
292 # @param esel_ist: @type list: eSEL list.
293 # @return Index of "ESEL=" in the list.
294 #######################################################################
295 """
296 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
297 return index[0]