1#!/usr/bin/python
2r"""
3#    @file     openbmc_ffdc_list.py
4#    @brief    List for FFDC ( First failure data capture )
5#              commands and files to be collected as a part
6#              of the test case failure.
7"""
8# -------------------
9# FFDC default list
10# -------------------
11# -----------------------------------------------------------------
12# Dict Name {  Index string : { Key String :  Command string} }
13# -----------------------------------------------------------------
14# Add cmd's needed to be part of the ffdc report manifest file
15FFDC_BMC_CMD = {
16    'DRIVER INFO':
17    {
18        # String Name         Command
19        'FW Level': 'cat /etc/os-release',
20        'FW Timestamp': 'cat /etc/timestamp',
21    },
22    'BMC DATA':
23    {
24        'BMC OS': 'uname -a',
25        'BMC Uptime': 'uptime',
26        'BMC File System Disk Space Usage': 'df -hT',
27        'BMC Date Time': 'date;/sbin/hwclock --show;/usr/bin/timedatectl'
28    },
29    'APPLICATION DATA':
30    {
31        'BMC state': '/usr/bin/obmcutil state',
32    },
33}
34# Add file name and correcponding command needed for BMC
35FFDC_BMC_FILE = {
36    'BMC FILES':
37    {
38        # File Name         Command
39        'BMC_flash_side': 'cat /sys/class/watchdog/watchdog1/bootstatus',
40        'BMC_proc_list': 'top -n 1 -b',
41        'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
42        'BMC_journalctl_nopager': 'journalctl --no-pager',
43        'BMC_journalctl_pretty': 'journalctl -o json-pretty',
44        'BMC_dmesg': 'dmesg',
45        'BMC_procinfo': 'cat /proc/cpuinfo',
46        'BMC_meminfo': 'cat /proc/meminfo',
47        'BMC_systemd': 'systemctl status --all',
48        'SOL': 'cat /var/log/obmc-console.log',
49    },
50}
51# Add file name and correcponding command needed for all Linux distributions
52FFDC_OS_ALL_DISTROS_FILE = {
53    'OS FILES':
54    {
55        # File Name         Command
56        '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',
68    },
69}
70# Add file name and correcponding command needed for Ubuntu Linux
71FFDC_OS_UBUNTU_FILE = {
72    'OS FILES':
73    {
74        # File Name         Command
75        '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',
82    },
83}
84# Add file name and correcponding command needed for RHEL Linux
85FFDC_OS_RHEL_FILE = {
86    'OS FILES':
87    {
88        # File Name         Command
89        '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',
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 >/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',
107    },
108}
109OPENBMC_BASE = '/xyz/openbmc_project/'
110OPENPOWER_BASE = '/org/open_power/'
111ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
112ENUMERATE_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'
117ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
118ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
119ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
120ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
121
122# Add file name and correcponding Get Request
123FFDC_GET_REQUEST = {
124    'GET REQUESTS':
125    {
126        # File Name         Command
127        'FIRMWARE_list': ENUMERATE_SW,
128        'BMC_sensor_list': ENUMERATE_SENSORS,
129        'BMC_control_list': ENUMERATE_CONTROL,
130        'BMC_inventory': ENUMERATE_INVENTORY,
131        'BMC_elog': ENUMERATE_ELOG,
132        'BMC_led': ENUMERATE_LED,
133        'BMC_state': ENUMERATE_STATE,
134        'OCC_state': ENUMERATE_OCC,
135        'BMC_dumps': ENUMERATE_DUMPS,
136        'BMC_USER': ENUMERATE_USER,
137    },
138}
139# Define your keywords in method/utils and call here
140FFDC_METHOD_CALL = {
141    'BMC LOGS':
142    {
143        # Description               Keyword name
144        'FFDC Generic Report': 'BMC FFDC Manifest',
145        'BMC Specific Files': 'BMC FFDC Files',
146        'Get Request FFDC': 'BMC FFDC Get Requests',
147        'OS FFDC': 'OS FFDC Files',
148        'Core Files': 'SCP Coredump Files',
149        'SEL Log': 'Collect eSEL Log',
150        'Sys Inventory Files': 'System Inventory Files',
151        'Dump Log': 'Collect Dump Log',
152        'Dump Files': 'SCP Dump Files',
153        'Redfish Log': 'Enumerate Redfish Resources',
154    },
155}
156# -----------------------------------------------------------------
157# base class for FFDC default list
158
159
160class openbmc_ffdc_list():
161    def get_ffdc_bmc_cmd(self, i_type):
162        r"""
163        #######################################################################
164        #   @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
167        #######################################################################
168        """
169        return FFDC_BMC_CMD[i_type].items()
170
171    def get_ffdc_bmc_file(self, i_type):
172        r"""
173        #######################################################################
174        #   @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
177        #######################################################################
178        """
179        return FFDC_BMC_FILE[i_type].items()
180
181    def get_ffdc_get_request(self, i_type):
182        r"""
183        #######################################################################
184        #   @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
187        #######################################################################
188        """
189        return FFDC_GET_REQUEST[i_type].items()
190
191    def get_ffdc_cmd_index(self):
192        r"""
193        #######################################################################
194        #   @brief    This method returns the list index from dictionary
195        #   @return   List of index to the dictionary
196        #######################################################################
197        """
198        return FFDC_BMC_CMD.keys()
199
200    def get_ffdc_get_request_index(self):
201        r"""
202        #######################################################################
203        #   @brief    This method returns the list index from dictionary
204        #   @return   List of index to the dictionary
205        #######################################################################
206        """
207        return FFDC_GET_REQUEST.keys()
208
209    def get_ffdc_file_index(self):
210        r"""
211        #######################################################################
212        #   @brief    This method returns the list index from dictionary
213        #   @return   List of index to the dictionary
214        #######################################################################
215        """
216        return FFDC_BMC_FILE.keys()
217
218    def get_ffdc_method_index(self):
219        r"""
220        #######################################################################
221        #   @brief    This method returns the key pair from the dictionary
222        #   @return   Index of the method dictionary
223        #######################################################################
224        """
225        return FFDC_METHOD_CALL.keys()
226
227    def get_ffdc_method_desc(self,
228                             index):
229        r"""
230        #######################################################################
231        #   @brief   This method returns the just the keys from the dictionary.
232        #   @return  List of ffdc descriptions.
233        #######################################################################
234        """
235        return FFDC_METHOD_CALL[index].keys()
236
237    def get_ffdc_method_call(self, i_type):
238        r"""
239        #######################################################################
240        #   @brief    This method returns the key pair from the dictionary
241        #   @return   List of key pair keywords
242        #######################################################################
243        """
244        return FFDC_METHOD_CALL[i_type].items()
245
246    def get_ffdc_os_all_distros_index(self):
247        r"""
248        #######################################################################
249        #   @brief    This method returns the key pair from the dictionary
250        #   @return   Index of the method dictionary
251        #######################################################################
252        """
253        return FFDC_OS_ALL_DISTROS_FILE.keys()
254
255    def get_ffdc_os_all_distros_call(self, i_type):
256        r"""
257        #######################################################################
258        #   @brief    This method returns the key pair from the dictionary
259        #   @return   List of key pair keywords
260        #######################################################################
261        """
262        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
263
264    def get_ffdc_os_distro_index(self, distro):
265        r"""
266        #######################################################################
267        #   @brief    This method returns the key pair from the dictionary
268        #   @return   Index of the method dictionary
269        #######################################################################
270        """
271        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
272        return eval(distro_file).keys()
273
274    def get_ffdc_os_distro_call(self, i_type, distro):
275        r"""
276        #######################################################################
277        #   @brief    This method returns the key pair from the dictionary
278        #   @return   List of key pair keywords
279        #######################################################################
280        """
281        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
282        return eval(distro_file)[i_type].items()
283
284    def get_strip_string(self, i_str):
285        r"""
286        #######################################################################
287        #   @brief    Returns the stripped strings
288        #   @param    i_str: @type string: string name
289        #   @return   Remove all special chars and return the string
290        #######################################################################
291        """
292        return ''.join(e for e in i_str if e.isalnum())
293
294    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]
304
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]
315