
# 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.

from sos.report.plugins import Plugin, IndependentPlugin
from sos.utilities import is_executable


class Lstopo(Plugin, IndependentPlugin):

    short_desc = 'Machine topology information'

    plugin_name = "lstopo"
    profiles = ("system", "hardware")
    packages = (
        "hwloc-libs",
        "libhwloc5",
        "hwloc",
    )

    def setup(self):
        # binary depends on particular package, both require hwloc-libs one
        # hwloc-gui provides lstopo command
        # hwloc provides lstopo-no-graphics command
        if is_executable("lstopo"):
            cmd = "lstopo"
        else:
            cmd = "lstopo-no-graphics"
        self.add_cmd_output(f"{cmd} --whole-io --of console",
                            suggest_filename="lstopo.txt")
        self.add_cmd_output(f"{cmd} --whole-io --of xml",
                            suggest_filename="lstopo.xml")