# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

# This plugin enables collection of logs for Power systems and more
# specific logs for Pseries, PowerNV platforms.

from sos.report.plugins import Plugin, IndependentPlugin


class PowerPC(Plugin, IndependentPlugin):

    short_desc = 'IBM Power systems'

    plugin_name = 'powerpc'
    profiles = ('system', 'hardware')
    architectures = ('ppc.*',)

    def setup(self):
        try:
            with open(self.path_join('/proc/cpuinfo'), 'r',
                      encoding='UTF-8') as file:
                contents = file.read()
                isp_series = "pSeries" in contents
                is_power_nv = "PowerNV" in contents
        except IOError:
            isp_series = False
            is_power_nv = False

        if isp_series or is_power_nv:
            self.add_copy_spec([
                "/proc/device-tree/",
                "/proc/loadavg",
                "/proc/locks",
                "/proc/misc",
                "/proc/swaps",
                "/proc/version",
                "/dev/nvram",
                "/var/lib/lsvpd/",
                "/var/log/lp_diag.log",
                "/etc/ct_node_id"
            ])
            self.add_cmd_output([
                "ppc64_cpu --info",
                "ppc64_cpu --smt",
                "ppc64_cpu --cores-present",
                "ppc64_cpu --cores-on",
                "ppc64_cpu --run-mode",
                "ppc64_cpu --frequency",
                "ppc64_cpu --dscr",
                "diag_encl -v",
                "lsvpd -D",
                "lsmcode -A",
                "lscfg -v",
                "opal-elog-parse -s",
                "opal-elog-parse -a",
                "opal-elog-parse -l",
                "lssrc -a",
                "lsrsrc IBM.MCP",
                "rmcdomainstatus -s ctrmc",
                "rmcdomainstatus -s ctrmc -a ip"
            ])

        if isp_series:
            self.add_copy_spec([
                "/proc/ppc64/lparcfg",
                "/proc/ppc64/eeh",
                "/proc/ppc64/systemcfg",
                "/var/log/platform",
                "/var/log/drmgr",
                "/var/log/drmgr.0",
                "/var/log/hcnmgr",
                "/var/log/rtas_errd.log",
                "/var/ct/IBM.DRM.stderr",
                "/var/ct/IW/log/mc/IBM.DRM/trace*"
            ])
            ctsnap_path = self.get_cmd_output_path(name="ctsnap", make=True)
            self.add_cmd_output([
                "servicelog --dump",
                "servicelog_notify --list",
                "usysattn",
                "usysident",
                "serv_config -l",
                "bootlist -m both -r",
                "lparstat -i",
                "lparnumascore",
                "lparnumascore -c cpu -d 4",
                "lparnumascore -c mem -d 3",
                f"ctsnap -xrunrpttr -d {ctsnap_path}",
                "lsdevinfo",
                "lsslot",
                "amsstat"
            ])

            # Due to the lack of options in invscout for generating log files
            # in locations other than /var/adm/invscout/, it is necessary to
            # run invscout commands prior to collecting the log files.
            self.collect_cmd_output("invscout")
            self.collect_cmd_output("invscout -v")
            self.add_copy_spec(["/var/adm/invscout/*"])

            self.add_service_status([
                "hcn-init",
                "ctrmc"
            ])

        if is_power_nv:
            self.add_copy_spec([
                "/proc/ppc64/eeh",
                "/proc/ppc64/systemcfg",
                "/proc/ppc64/topology_updates",
                "/sys/firmware/opal/msglog",
                "/var/log/opal-elog/",
                "/var/log/opal-prd",
                "/var/log/opal-prd.log*"
            ])
            self.add_cmd_output([
                "opal-prd --expert-mode run nvdimm_info"
            ])
            self.add_dir_listing('/var/log/dump')

# vim: set et ts=4 sw=4 :
