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;cat /proc/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 >/tmp/BMC_flash_side.txt 2>&1',
40        'BMC_proc_list': 'top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1',
41        'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1',
42        'BMC_journalctl_nopager': 'journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1',
43        'BMC_journalctl_pretty': 'journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.txt 2>&1',
44        'BMC_dmesg': 'dmesg >/tmp/BMC_dmesg.txt 2>&1',
45        'BMC_procinfo': 'cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1',
46        'BMC_meminfo': 'cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1',
47        'BMC_systemd': 'systemctl status --all >/tmp/BMC_systemd.txt 2>&1',
48        'BMC_obmc_console': 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1',
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        'OS_journalctl_nopager': 'journalctl --no-pager -b '
69                                 + '> /tmp/OS_journalctl_nopager.txt  2>&1',
70    },
71}
72# 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 ; } >/tmp/OS_isub.txt 2>&1',
78        'OS_kern': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1',
79        'OS_authlog': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } '
80                      + '>/tmp/OS_authlog.txt 2>&1',
81        'OS_syslog': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1',
82        'OS_info': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } '
83                   + '>/tmp/OS_info.txt 2>&1',
84        'OS_sosreport': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
85                   + '/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
86    },
87}
88# Add file name and correcponding command needed for RHEL Linux
89FFDC_OS_RHEL_FILE = {
90    'OS FILES':
91    {
92        # File Name         Command
93        'OS_rsct': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1',
94        'OS_secure': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
95        'OS_syslog': 'tail -n 200000 /var/log/messages '
96                     + '>/tmp/OS_syslog.txt 2>&1',
97        'OS_info': '{ lsb_release -a; cat /etc/redhat-release; '
98                   + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1',
99        'OS_sosreport': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
100                   + '/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
101    },
102}
103# Add file name and correcponding command needed for RHEL Linux
104FFDC_OS_IBM_POWERKVM_FILE = {
105    'OS FILES':
106    {
107        # File Name         Command
108        'OS_secure': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
109        'OS_syslog': 'tail -n 200000 /var/log/messages '
110                     + '>/tmp/OS_syslog.txt 2>&1',
111        'OS_info': '{ lsb_release -a; uname -a; rpm -qa ; } '
112                   + '>/tmp/OS_info.txt 2>&1',
113    },
114}
115OPENBMC_BASE = '/xyz/openbmc_project/'
116OPENPOWER_BASE = '/org/open_power/'
117ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
118ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
119ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
120ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
121ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
122ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
123ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
124ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
125ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
126ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
127
128# Add file name and correcponding Get Request
129FFDC_GET_REQUEST = {
130    'GET REQUESTS':
131    {
132        # File Name         Command
133        'FIRMWARE_list': ENUMERATE_SW,
134        'BMC_sensor_list': ENUMERATE_SENSORS,
135        'BMC_control_list': ENUMERATE_CONTROL,
136        'BMC_inventory': ENUMERATE_INVENTORY,
137        'BMC_elog': ENUMERATE_ELOG,
138        'BMC_led': ENUMERATE_LED,
139        'BMC_state': ENUMERATE_STATE,
140        'OCC_state': ENUMERATE_OCC,
141        'BMC_dumps': ENUMERATE_DUMPS,
142        'BMC_USER': ENUMERATE_USER,
143    },
144}
145# Define your keywords in method/utils and call here
146FFDC_METHOD_CALL = {
147    'BMC LOGS':
148    {
149        # Description               Keyword name
150        'FFDC Generic Report': 'BMC FFDC Manifest',
151        'BMC Specific Files': 'BMC FFDC Files',
152        'Get Request FFDC': 'BMC FFDC Get Requests',
153        'OS FFDC': 'OS FFDC Files',
154        'Core Files': 'SCP Coredump Files',
155        'SEL Log': 'Collect eSEL Log',
156        'Sys Inventory Files': 'System Inventory Files',
157        'Dump Log': 'Collect Dump Log',
158        'Dump Files': 'SCP Dump Files',
159        'Redfish Log': 'Enumerate Redfish Resources',
160    },
161}
162# -----------------------------------------------------------------
163# base class for FFDC default list
164
165
166class openbmc_ffdc_list():
167    def get_ffdc_bmc_cmd(self, i_type):
168        r"""
169        #######################################################################
170        #   @brief    This method returns the list from the dictionary for cmds
171        #   @param    i_type: @type string: string index lookup
172        #   @return   List of key pair from the dictionary
173        #######################################################################
174        """
175        return FFDC_BMC_CMD[i_type].items()
176
177    def get_ffdc_bmc_file(self, i_type):
178        r"""
179        #######################################################################
180        #   @brief    This method returns the list from the dictionary for scp
181        #   @param    i_type: @type string: string index lookup
182        #   @return   List of key pair from the dictionary
183        #######################################################################
184        """
185        return FFDC_BMC_FILE[i_type].items()
186
187    def get_ffdc_get_request(self, i_type):
188        r"""
189        #######################################################################
190        #   @brief    This method returns the list from the dictionary for scp
191        #   @param    i_type: @type string: string index lookup
192        #   @return   List of key pair from the dictionary
193        #######################################################################
194        """
195        return FFDC_GET_REQUEST[i_type].items()
196
197    def get_ffdc_cmd_index(self):
198        r"""
199        #######################################################################
200        #   @brief    This method returns the list index from dictionary
201        #   @return   List of index to the dictionary
202        #######################################################################
203        """
204        return FFDC_BMC_CMD.keys()
205
206    def get_ffdc_get_request_index(self):
207        r"""
208        #######################################################################
209        #   @brief    This method returns the list index from dictionary
210        #   @return   List of index to the dictionary
211        #######################################################################
212        """
213        return FFDC_GET_REQUEST.keys()
214
215    def get_ffdc_file_index(self):
216        r"""
217        #######################################################################
218        #   @brief    This method returns the list index from dictionary
219        #   @return   List of index to the dictionary
220        #######################################################################
221        """
222        return FFDC_BMC_FILE.keys()
223
224    def get_ffdc_method_index(self):
225        r"""
226        #######################################################################
227        #   @brief    This method returns the key pair from the dictionary
228        #   @return   Index of the method dictionary
229        #######################################################################
230        """
231        return FFDC_METHOD_CALL.keys()
232
233    def get_ffdc_method_desc(self,
234                             index):
235        r"""
236        #######################################################################
237        #   @brief   This method returns the just the keys from the dictionary.
238        #   @return  List of ffdc descriptions.
239        #######################################################################
240        """
241        return FFDC_METHOD_CALL[index].keys()
242
243    def get_ffdc_method_call(self, i_type):
244        r"""
245        #######################################################################
246        #   @brief    This method returns the key pair from the dictionary
247        #   @return   List of key pair keywords
248        #######################################################################
249        """
250        return FFDC_METHOD_CALL[i_type].items()
251
252    def get_ffdc_os_all_distros_index(self):
253        r"""
254        #######################################################################
255        #   @brief    This method returns the key pair from the dictionary
256        #   @return   Index of the method dictionary
257        #######################################################################
258        """
259        return FFDC_OS_ALL_DISTROS_FILE.keys()
260
261    def get_ffdc_os_all_distros_call(self, i_type):
262        r"""
263        #######################################################################
264        #   @brief    This method returns the key pair from the dictionary
265        #   @return   List of key pair keywords
266        #######################################################################
267        """
268        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
269
270    def get_ffdc_os_distro_index(self, distro):
271        r"""
272        #######################################################################
273        #   @brief    This method returns the key pair from the dictionary
274        #   @return   Index of the method dictionary
275        #######################################################################
276        """
277        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
278        return eval(distro_file).keys()
279
280    def get_ffdc_os_distro_call(self, i_type, distro):
281        r"""
282        #######################################################################
283        #   @brief    This method returns the key pair from the dictionary
284        #   @return   List of key pair keywords
285        #######################################################################
286        """
287        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
288        return eval(distro_file)[i_type].items()
289
290    def get_strip_string(self, i_str):
291        r"""
292        #######################################################################
293        #   @brief    Returns the stripped strings
294        #   @param    i_str: @type string: string name
295        #   @return   Remove all special chars and return the string
296        #######################################################################
297        """
298        return ''.join(e for e in i_str if e.isalnum())
299
300    def get_esel_index(self, esel_list):
301        r"""
302        #######################################################################
303        #   @brief    Returns the eSEL binary index.
304        #   @param    esel_ist: @type list: eSEL list.
305        #   @return   Index of "ESEL=" in the list.
306        #######################################################################
307        """
308        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
309        return index[0]
310
311    def get_dump_index(self, dump_list):
312        r"""
313        #######################################################################
314        #   @brief    Returns the eSEL binary index.
315        #   @param    esel_ist: @type list: eSEL list.
316        #   @return   Index of "ESEL=" in the list.
317        #######################################################################
318        """
319        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
320        return index[0]
321