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/sbin/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_proc_list': 'top -n 1 -b',
40        'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
41        'BMC_journalctl_nopager': 'journalctl --no-pager',
42        'BMC_journalctl_pretty': 'journalctl -o json-pretty',
43        'BMC_dmesg': 'dmesg',
44        'BMC_procinfo': 'cat /proc/cpuinfo',
45        'BMC_meminfo': 'cat /proc/meminfo',
46        'BMC_systemd': 'systemctl status --all',
47    },
48}
49# 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',
57        'OS_opal_prd': 'cat /var/log/opal-prd*',
58        'OS_boot': 'cat /var/log/boot.log',
59        'OS_procinfo': 'cat /proc/cpuinfo',
60        'OS_meminfo': 'cat /proc/meminfo',
61        'OS_netstat': 'netstat -a',
62        'OS_lspci': 'lspci',
63        'OS_lscpu': 'lscpu',
64        'OS_lscfg': 'lscfg',
65    },
66}
67# 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}
79# 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}
90# 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}
100OPENBMC_BASE = '/xyz/openbmc_project/'
101OPENPOWER_BASE = '/org/open_power/'
102ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
103ENUMERATE_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'
108ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
109ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
110ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
111ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
112
113# Add file name and correcponding Get Request
114FFDC_GET_REQUEST = {
115    'GET REQUESTS':
116    {
117        # File Name         Command
118        'FIRMWARE_list': ENUMERATE_SW,
119        'BMC_sensor_list': ENUMERATE_SENSORS,
120        'BMC_control_list': ENUMERATE_CONTROL,
121        'BMC_inventory': ENUMERATE_INVENTORY,
122        'BMC_elog': ENUMERATE_ELOG,
123        'BMC_led': ENUMERATE_LED,
124        'BMC_state': ENUMERATE_STATE,
125        'OCC_state': ENUMERATE_OCC,
126        'BMC_dumps': ENUMERATE_DUMPS,
127        'BMC_USER': ENUMERATE_USER,
128    },
129}
130# Define your keywords in method/utils and call here
131FFDC_METHOD_CALL = {
132    'BMC LOGS':
133    {
134        # Description               Keyword name
135        'FFDC Generic Report': 'BMC FFDC Manifest',
136        'BMC Specific Files': 'BMC FFDC Files',
137        'Get Request FFDC': 'BMC FFDC Get Requests',
138        'OS FFDC': 'OS FFDC Files',
139        'Core Files': 'SCP Coredump Files',
140        'SEL Log': 'Collect eSEL Log',
141        'Sys Inventory Files': 'System Inventory Files',
142        'Dump Log': 'Collect Dump Log',
143        'Dump Files': 'SCP Dump Files'
144    },
145}
146# -----------------------------------------------------------------
147# base class for FFDC default list
148
149
150class openbmc_ffdc_list():
151    def get_ffdc_bmc_cmd(self, i_type):
152        r"""
153        #######################################################################
154        #   @brief    This method returns the list from the dictionary for cmds
155        #   @param    i_type: @type string: string index lookup
156        #   @return   List of key pair from the dictionary
157        #######################################################################
158        """
159        return FFDC_BMC_CMD[i_type].items()
160
161    def get_ffdc_bmc_file(self, i_type):
162        r"""
163        #######################################################################
164        #   @brief    This method returns the list from the dictionary for scp
165        #   @param    i_type: @type string: string index lookup
166        #   @return   List of key pair from the dictionary
167        #######################################################################
168        """
169        return FFDC_BMC_FILE[i_type].items()
170
171    def get_ffdc_get_request(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_GET_REQUEST[i_type].items()
180
181    def get_ffdc_cmd_index(self):
182        r"""
183        #######################################################################
184        #   @brief    This method returns the list index from dictionary
185        #   @return   List of index to the dictionary
186        #######################################################################
187        """
188        return FFDC_BMC_CMD.keys()
189
190    def get_ffdc_get_request_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_GET_REQUEST.keys()
198
199    def get_ffdc_file_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_BMC_FILE.keys()
207
208    def get_ffdc_method_index(self):
209        r"""
210        #######################################################################
211        #   @brief    This method returns the key pair from the dictionary
212        #   @return   Index of the method dictionary
213        #######################################################################
214        """
215        return FFDC_METHOD_CALL.keys()
216
217    def get_ffdc_method_desc(self,
218                             index):
219        r"""
220        #######################################################################
221        #   @brief   This method returns the just the keys from the dictionary.
222        #   @return  List of ffdc descriptions.
223        #######################################################################
224        """
225        return FFDC_METHOD_CALL[index].keys()
226
227    def get_ffdc_method_call(self, i_type):
228        r"""
229        #######################################################################
230        #   @brief    This method returns the key pair from the dictionary
231        #   @return   List of key pair keywords
232        #######################################################################
233        """
234        return FFDC_METHOD_CALL[i_type].items()
235
236    def get_ffdc_os_all_distros_index(self):
237        r"""
238        #######################################################################
239        #   @brief    This method returns the key pair from the dictionary
240        #   @return   Index of the method dictionary
241        #######################################################################
242        """
243        return FFDC_OS_ALL_DISTROS_FILE.keys()
244
245    def get_ffdc_os_all_distros_call(self, i_type):
246        r"""
247        #######################################################################
248        #   @brief    This method returns the key pair from the dictionary
249        #   @return   List of key pair keywords
250        #######################################################################
251        """
252        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
253
254    def get_ffdc_os_distro_index(self, distro):
255        r"""
256        #######################################################################
257        #   @brief    This method returns the key pair from the dictionary
258        #   @return   Index of the method dictionary
259        #######################################################################
260        """
261        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
262        return eval(distro_file).keys()
263
264    def get_ffdc_os_distro_call(self, i_type, distro):
265        r"""
266        #######################################################################
267        #   @brief    This method returns the key pair from the dictionary
268        #   @return   List of key pair keywords
269        #######################################################################
270        """
271        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
272        return eval(distro_file)[i_type].items()
273
274    def get_strip_string(self, i_str):
275        r"""
276        #######################################################################
277        #   @brief    Returns the stripped strings
278        #   @param    i_str: @type string: string name
279        #   @return   Remove all special chars and return the string
280        #######################################################################
281        """
282        return ''.join(e for e in i_str if e.isalnum())
283
284    def get_esel_index(self, esel_list):
285        r"""
286        #######################################################################
287        #   @brief    Returns the eSEL binary index.
288        #   @param    esel_ist: @type list: eSEL list.
289        #   @return   Index of "ESEL=" in the list.
290        #######################################################################
291        """
292        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
293        return index[0]
294
295    def get_dump_index(self, dump_list):
296        r"""
297        #######################################################################
298        #   @brief    Returns the eSEL binary index.
299        #   @param    esel_ist: @type list: eSEL list.
300        #   @return   Index of "ESEL=" in the list.
301        #######################################################################
302        """
303        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
304        return index[0]
305