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