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