1#!/usr/bin/python
2r"""
3#############################################################
4#    @file     openbmc_ffdc_list.py
5#
6#    @brief    List for FFDC ( First failure data capture )
7#              commands and files to be collected as a part
8#              of the test case failure.
9#############################################################
10"""
11
12# -------------------
13# FFDC default list
14# -------------------
15
16# -----------------------------------------------------------------
17# Dict Name {  Index string : { Key String :  Comand string} }
18# -----------------------------------------------------------------
19# Add cmd's needed to be part of the ffdc report manifest file
20FFDC_BMC_CMD = {
21    'DRIVER INFO':
22    {
23        # String Name         Command
24        'FW Level': 'cat /etc/os-release',
25        'FW Timestamp': 'cat /etc/timestamp',
26    },
27    'BMC DATA':
28    {
29        'BMC OS': 'uname -a',
30        'BMC Uptime': 'uptime',
31        'BMC File System Disk Space Usage': 'df -hT',
32    },
33    'APPLICATION DATA':
34    {
35        'BMC state': '/usr/sbin/obmcutil state',
36    },
37}
38
39# Add file name and correcponding command needed for BMC
40FFDC_BMC_FILE = {
41    'BMC FILES':
42    {
43        # File Name         Command
44        'BMC_proc_list': 'top -n 1 -b',
45        'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
46        'BMC_journalctl_nopager': 'journalctl --no-pager',
47        'BMC_journalctl_pretty': 'journalctl -o json-pretty',
48        'BMC_dmesg': 'dmesg',
49        'BMC_procinfo': 'cat /proc/cpuinfo',
50        'BMC_meminfo': 'cat /proc/meminfo',
51    },
52}
53
54# Add file name and correcponding command needed for all Linux distributions
55FFDC_OS_ALL_DISTROS_FILE = {
56    'OS FILES':
57    {
58        # File Name         Command
59        'OS_msglog': 'cat /sys/firmware/opal/msglog',
60        'OS_cpufrequency': 'ppc64_cpu --frequency',
61        'OS_dmesg': 'dmesg',
62        'OS_boot': 'cat /var/log/boot.log',
63        'OS_procinfo': 'cat /proc/cpuinfo',
64        'OS_meminfo': 'cat /proc/meminfo',
65        'OS_netstat': 'netstat -a',
66        'OS_lspci': 'lspci',
67        'OS_lscpu': 'lscpu',
68        'OS_lscfg': 'lscfg',
69    },
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',
78        'OS_kern': 'tail -n 50000 /var/log/kern.log',
79        'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
80        'OS_syslog': 'tail -n 200000 /var/log/syslog',
81        'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
82    },
83}
84
85# Add file name and correcponding command needed for RHEL Linux
86FFDC_OS_RHEL_FILE = {
87    'OS FILES':
88    {
89        # File Name         Command
90        'OS_rsct': '/usr/bin/ctversion -bv',
91        'OS_secure': 'cat /var/log/secure',
92        'OS_syslog': 'tail -n 200000 /var/log/messages',
93        'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
94    },
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',
103        'OS_syslog': 'tail -n 200000 /var/log/messages',
104        'OS_info': 'lsb_release -a; uname -a; rpm -qa',
105    },
106}
107
108OPENBMC_BASE = '/xyz/openbmc_project/'
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'
115
116# Add file name and correcponding Get Request
117FFDC_GET_REQUEST = {
118    'GET REQUESTS':
119    {
120        # File Name         Command
121        'FIRMWARE_list': ENUMERATE_SW,
122        'BMC_sensor_list': ENUMERATE_SENSORS,
123        'BMC_control_list': ENUMERATE_CONTROL,
124        'BMC_inventory': ENUMERATE_INVENTORY,
125        'BMC_elog': ENUMERATE_ELOG,
126        'BMC_led': ENUMERATE_LED,
127    },
128}
129
130
131# Define your keywords in method/utils and call here
132FFDC_METHOD_CALL = {
133    'BMC LOGS':
134    {
135        # Description             Keyword name
136        'FFDC Generic Report': 'BMC FFDC Manifest',
137        'BMC Specific Files': 'BMC FFDC Files',
138        'Get Request FFDC': 'BMC FFDC Get Requests',
139        'OS FFDC': 'OS FFDC Files',
140        'Core Files': 'SCP Coredump Files',
141        'SEL Log': 'Collect eSEL Log',
142        'Sys Inventory Files': 'System Inventory Files',
143    },
144}
145
146# -----------------------------------------------------------------
147
148
149# base class for FFDC default list
150class openbmc_ffdc_list():
151
152    def get_ffdc_bmc_cmd(self, i_type):
153        r"""
154        ########################################################################
155        #   @brief    This method returns the list from the dictionary for cmds
156        #   @param    i_type: @type string: string index lookup
157        #   @return   List of key pair from the dictionary
158        ########################################################################
159        """
160        return FFDC_BMC_CMD[i_type].items()
161
162    def get_ffdc_bmc_file(self, i_type):
163        r"""
164        ########################################################################
165        #   @brief    This method returns the list from the dictionary for scp
166        #   @param    i_type: @type string: string index lookup
167        #   @return   List of key pair from the dictionary
168        ########################################################################
169        """
170        return FFDC_BMC_FILE[i_type].items()
171
172    def get_ffdc_get_request(self, i_type):
173        r"""
174        ########################################################################
175        #   @brief    This method returns the list from the dictionary for scp
176        #   @param    i_type: @type string: string index lookup
177        #   @return   List of key pair from the dictionary
178        ########################################################################
179        """
180        return FFDC_GET_REQUEST[i_type].items()
181
182    def get_ffdc_cmd_index(self):
183        r"""
184        ########################################################################
185        #   @brief    This method returns the list index from dictionary
186        #   @return   List of index to the dictionary
187        ########################################################################
188        """
189        return FFDC_BMC_CMD.keys()
190
191    def get_ffdc_get_request_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_GET_REQUEST.keys()
199
200    def get_ffdc_file_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_BMC_FILE.keys()
208
209    def get_ffdc_method_index(self):
210        r"""
211        ########################################################################
212        #   @brief    This method returns the key pair from the dictionary
213        #   @return   Index of the method dictionary
214        ########################################################################
215        """
216        return FFDC_METHOD_CALL.keys()
217
218    def get_ffdc_method_desc(self,
219                             index):
220        r"""
221        ########################################################################
222        #   @brief   This method returns the just the keys from the dictionary.
223        #   @return  List of ffdc descriptions.
224        ########################################################################
225        """
226        return FFDC_METHOD_CALL[index].keys()
227
228    def get_ffdc_method_call(self, i_type):
229        r"""
230        ########################################################################
231        #   @brief    This method returns the key pair from the dictionary
232        #   @return   List of key pair keywords
233        ########################################################################
234        """
235        return FFDC_METHOD_CALL[i_type].items()
236
237    def get_ffdc_os_all_distros_index(self):
238        r"""
239        ########################################################################
240        #   @brief    This method returns the key pair from the dictionary
241        #   @return   Index of the method dictionary
242        ########################################################################
243        """
244        return FFDC_OS_ALL_DISTROS_FILE.keys()
245
246    def get_ffdc_os_all_distros_call(self, i_type):
247        r"""
248        ########################################################################
249        #   @brief    This method returns the key pair from the dictionary
250        #   @return   List of key pair keywords
251        ########################################################################
252        """
253        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
254
255    def get_ffdc_os_distro_index(self, distro):
256        r"""
257        ########################################################################
258        #   @brief    This method returns the key pair from the dictionary
259        #   @return   Index of the method dictionary
260        ########################################################################
261        """
262        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
263        return eval(distro_file).keys()
264
265    def get_ffdc_os_distro_call(self, i_type, distro):
266        r"""
267        ########################################################################
268        #   @brief    This method returns the key pair from the dictionary
269        #   @return   List of key pair keywords
270        ########################################################################
271        """
272        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
273        return eval(distro_file)[i_type].items()
274
275    def get_strip_string(self, i_str):
276        r"""
277        ########################################################################
278        #   @brief    Returns the stripped strings
279        #   @param    i_str: @type string: string name
280        #   @return   Remove all special chars and return the string
281        ########################################################################
282        """
283        return ''.join(e for e in i_str if e.isalnum())
284
285    def get_esel_index(self, esel_list):
286        r"""
287        #######################################################################
288        #   @brief    Returns the eSEL binary index.
289        #   @param    esel_ist: @type list: eSEL list.
290        #   @return   Index of "ESEL=" in the list.
291        #######################################################################
292        """
293        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
294        return index[0]
295