blob: ca5626341c5f1f0c638c9d4bbd83c8a6c3557494 [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',
Michael Walshef19da62018-04-25 16:13:49 -050057 'OS_opal_prd': 'cat /var/log/opal-prd*',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050058 'OS_boot': 'cat /var/log/boot.log',
Gunnar Millsaca140d2016-10-26 13:05:10 -050059 'OS_procinfo': 'cat /proc/cpuinfo',
60 'OS_meminfo': 'cat /proc/meminfo',
61 'OS_netstat': 'netstat -a',
Steven Sombar60ade082017-08-16 11:27:26 -050062 'OS_lspci': 'lspci',
63 'OS_lscpu': 'lscpu',
64 'OS_lscfg': 'lscfg',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050065 },
66}
Gunnar Millscce185d2016-10-17 17:04:15 -050067# Add file name and correcponding command needed for Ubuntu Linux
68FFDC_OS_UBUNTU_FILE = {
69 'OS FILES':
70 {
71 # File Name Command
72 'OS_isusb': 'lsusb -t ; lsusb -v',
73 'OS_kern': 'tail -n 50000 /var/log/kern.log',
74 'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
75 'OS_syslog': 'tail -n 200000 /var/log/syslog',
76 'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
77 },
78}
Gunnar Millscce185d2016-10-17 17:04:15 -050079# Add file name and correcponding command needed for RHEL Linux
80FFDC_OS_RHEL_FILE = {
81 'OS FILES':
82 {
83 # File Name Command
84 'OS_rsct': '/usr/bin/ctversion -bv',
85 'OS_secure': 'cat /var/log/secure',
86 'OS_syslog': 'tail -n 200000 /var/log/messages',
87 'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
88 },
89}
Gunnar Millscce185d2016-10-17 17:04:15 -050090# Add file name and correcponding command needed for RHEL Linux
91FFDC_OS_IBM_POWERKVM_FILE = {
92 'OS FILES':
93 {
94 # File Name Command
95 'OS_secure': 'cat /var/log/secure',
96 'OS_syslog': 'tail -n 200000 /var/log/messages',
97 'OS_info': 'lsb_release -a; uname -a; rpm -qa',
98 },
99}
George Keishingf77ea872017-09-01 08:02:21 -0500100OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500101OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600102ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500103ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
104ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
105ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
106ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
107ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
George Keishing9be77cd2017-11-13 07:52:08 -0600108ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
George Keishingba000382017-09-19 13:25:29 -0500109ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500110ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
111
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500112# Add file name and correcponding Get Request
113FFDC_GET_REQUEST = {
114 'GET REQUESTS':
115 {
116 # File Name Command
George Keishingf77ea872017-09-01 08:02:21 -0500117 'FIRMWARE_list': ENUMERATE_SW,
George Keishingfe5724d2016-11-23 09:25:36 -0600118 'BMC_sensor_list': ENUMERATE_SENSORS,
George Keishing49e24a72017-08-09 11:37:42 -0500119 'BMC_control_list': ENUMERATE_CONTROL,
George Keishingf77ea872017-09-01 08:02:21 -0500120 'BMC_inventory': ENUMERATE_INVENTORY,
George Keishingc06fc992017-02-22 09:01:08 -0600121 'BMC_elog': ENUMERATE_ELOG,
George Keishingf77ea872017-09-01 08:02:21 -0500122 'BMC_led': ENUMERATE_LED,
George Keishing9be77cd2017-11-13 07:52:08 -0600123 'BMC_state': ENUMERATE_STATE,
George Keishingba000382017-09-19 13:25:29 -0500124 'OCC_state': ENUMERATE_OCC,
Sweta Potthuria82efd62017-10-18 05:34:59 -0500125 'BMC_dumps': ENUMERATE_DUMPS,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500126 },
127}
George Keishing69e6f712016-09-12 06:30:09 -0500128# Define your keywords in method/utils and call here
129FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500130 'BMC LOGS':
131 {
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500132 # Description Keyword name
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500133 'FFDC Generic Report': 'BMC FFDC Manifest',
134 'BMC Specific Files': 'BMC FFDC Files',
135 'Get Request FFDC': 'BMC FFDC Get Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500136 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600137 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500138 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500139 'Sys Inventory Files': 'System Inventory Files',
Sweta Potthuria82efd62017-10-18 05:34:59 -0500140 'Dump Log': 'Collect Dump Log',
141 'Dump Files': 'SCP Dump Files'
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500142 },
143}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500144# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500145# base class for FFDC default list
Gunnar Mills096cd562018-03-26 10:19:12 -0500146
147
George Keishing4346a412016-07-19 11:26:49 -0500148class openbmc_ffdc_list():
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500149 def get_ffdc_bmc_cmd(self, i_type):
150 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500151 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500152 # @brief This method returns the list from the dictionary for cmds
153 # @param i_type: @type string: string index lookup
154 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500155 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500156 """
George Keishing69e6f712016-09-12 06:30:09 -0500157 return FFDC_BMC_CMD[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500158
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500159 def get_ffdc_bmc_file(self, i_type):
160 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500161 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500162 # @brief This method returns the list from the dictionary for scp
163 # @param i_type: @type string: string index lookup
164 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500165 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500166 """
George Keishing69e6f712016-09-12 06:30:09 -0500167 return FFDC_BMC_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500168
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500169 def get_ffdc_get_request(self, i_type):
170 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500171 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500172 # @brief This method returns the list from the dictionary for scp
173 # @param i_type: @type string: string index lookup
174 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500175 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500176 """
177 return FFDC_GET_REQUEST[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500178
George Keishing69e6f712016-09-12 06:30:09 -0500179 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500180 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500181 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500182 # @brief This method returns the list index from dictionary
183 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500184 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500185 """
George Keishing69e6f712016-09-12 06:30:09 -0500186 return FFDC_BMC_CMD.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500187
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500188 def get_ffdc_get_request_index(self):
189 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500190 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500191 # @brief This method returns the list index from dictionary
192 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500193 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500194 """
195 return FFDC_GET_REQUEST.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500196
George Keishing69e6f712016-09-12 06:30:09 -0500197 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500198 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500199 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500200 # @brief This method returns the list index from dictionary
201 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500202 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500203 """
George Keishing69e6f712016-09-12 06:30:09 -0500204 return FFDC_BMC_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500205
George Keishing69e6f712016-09-12 06:30:09 -0500206 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500207 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500208 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500209 # @brief This method returns the key pair from the dictionary
210 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500211 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500212 """
George Keishing69e6f712016-09-12 06:30:09 -0500213 return FFDC_METHOD_CALL.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500214
Michael Walshe844e9a2017-04-20 16:51:10 -0500215 def get_ffdc_method_desc(self,
216 index):
217 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500218 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500219 # @brief This method returns the just the keys from the dictionary.
220 # @return List of ffdc descriptions.
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500221 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500222 """
223 return FFDC_METHOD_CALL[index].keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500224
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500225 def get_ffdc_method_call(self, i_type):
226 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500227 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500228 # @brief This method returns the key pair from the dictionary
229 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500230 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500231 """
George Keishing69e6f712016-09-12 06:30:09 -0500232 return FFDC_METHOD_CALL[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500233
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500234 def get_ffdc_os_all_distros_index(self):
235 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500236 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500237 # @brief This method returns the key pair from the dictionary
238 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500239 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500240 """
241 return FFDC_OS_ALL_DISTROS_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500242
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500243 def get_ffdc_os_all_distros_call(self, i_type):
244 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500245 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500246 # @brief This method returns the key pair from the dictionary
247 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500248 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500249 """
250 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500251
Gunnar Millscce185d2016-10-17 17:04:15 -0500252 def get_ffdc_os_distro_index(self, distro):
253 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500254 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500255 # @brief This method returns the key pair from the dictionary
256 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500257 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500258 """
259 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
260 return eval(distro_file).keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500261
Gunnar Millscce185d2016-10-17 17:04:15 -0500262 def get_ffdc_os_distro_call(self, i_type, distro):
263 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500264 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500265 # @brief This method returns the key pair from the dictionary
266 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500267 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500268 """
269 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
270 return eval(distro_file)[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500271
George Keishing4346a412016-07-19 11:26:49 -0500272 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500273 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500274 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500275 # @brief Returns the stripped strings
276 # @param i_str: @type string: string name
277 # @return Remove all special chars and return the string
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500278 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500279 """
George Keishing4346a412016-07-19 11:26:49 -0500280 return ''.join(e for e in i_str if e.isalnum())
Gunnar Mills096cd562018-03-26 10:19:12 -0500281
George Keishing28da9482017-07-27 13:38:54 -0500282 def get_esel_index(self, esel_list):
283 r"""
284 #######################################################################
285 # @brief Returns the eSEL binary index.
286 # @param esel_ist: @type list: eSEL list.
287 # @return Index of "ESEL=" in the list.
288 #######################################################################
289 """
290 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
291 return index[0]
Sweta Potthuria82efd62017-10-18 05:34:59 -0500292
293 def get_dump_index(self, dump_list):
294 r"""
295 #######################################################################
296 # @brief Returns the eSEL binary index.
297 # @param esel_ist: @type list: eSEL list.
298 # @return Index of "ESEL=" in the list.
299 #######################################################################
300 """
301 index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
302 return index[0]