Source code for insights.parsers.modinfo

"""
KernelModulesInfo - Command ``modinfo filtered_modules``
--------------------------------------------------------
"""

from insights import parser, CommandParser
from insights.parsers import SkipException
from insights.specs import Specs
from insights.util import deprecated


[docs]class ModInfo(dict): """ Base class for the information about a kernel module, the module info will be stored in dictionary format. Besides of that, the following utility properties are provided as well. """
[docs] @classmethod def from_content(cls, content): """ A classmethod to generated a `ModInfo` object from the given `content` list. Two more keys `module_name` and `module_deps` will be created as well per the `content`. Raises: SkipException: When nothing need to check to a dict. """ if not content: raise SkipException("No Contents") data = {} for line in content: line = line.strip() if ':' in line: key, value = [l.strip() for l in line.split(':', 1)] if key not in data: data[key] = value else: old_val = data[key] data[key] = [old_val] if isinstance(old_val, str) else old_val data[key].append(value) if not data: raise SkipException("No Parsed Contents") data['module_deps'] = [mod for mod in data.get('depends', '').split(',')] data['module_name'] = data.get('filename', '').rsplit('/')[-1].split('.')[0] return cls(data)
@property def module_name(self): """ (str): This will return kernel module name when set, else empty str. """ return self.get('module_name', '') @property def module_path(self): """ (str): This will return kernel module path when set, else `None`. """ return self.get('filename', '') @property def module_deps(self): """ (list): This will return the list of kernel modules depend on the kernel module when set, else `[]`. """ return self.get('module_deps', []) @property def module_firmware(self): """ (list): This will return the list of firmwares used by this module when set, else `[]`. """ return self.get('firmware', []) @property def module_alias(self): """ (list): This will return the list of alias to this kernel module when set, else `[]`. """ return self.get('alias', []) @property def module_parm(self): """ (list): This will return the list of parms for this kernel module when set, else `[]`. """ return self.get('parm', []) @property def module_version(self): """ (str): This will return the kernel module version when set, else empty string. """ return self.get('version', '') @property def module_signer(self): """ (str): This will return the signer of kernel module when set, else empty string. """ return self.get('signer', '') @property def module_details(self): """ (dict): This will return the kernel module details when set. """ return self
[docs]@parser(Specs.modinfo_filtered_modules) class KernelModulesInfo(CommandParser, dict): """ Class to parse the information about filtered kernel modules collected by "modinfo filtered_modules". The result will be stored in a dictionary. The key is the module name, the value is a instance of ModInfo with more details. Sample output:: filename: /lib/modules/3.10.0-957.10.1.el7.x86_64/kernel/drivers/net/vmxnet3/vmxnet3.ko.xz version: 1.4.14.0-k license: GPL v2 description: VMware vmxnet3 virtual NIC driver author: VMware, Inc. retpoline: Y rhelversion: 7.6 srcversion: 7E672688ACACBDD2E363B63 alias: pci:v000015ADd000007B0sv*sd*bc*sc*i* depends: intree: Y vermagic: 3.10.0-957.10.1.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: A5:70:18:DF:B6:C9:D6:1F:CF:CE:0A:3D:02:8B:B3:69:BD:76:CA:ED sig_hashalgo: sha256 filename: /lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz firmware: i40e/i40e-e2-7.13.1.0.fw firmware: i40e/i40e-e1h-7.13.1.0.fw version: 2.3.2-k license: GPL description: Intel(R) Ethernet Connection XL710 Network Driver author: Intel Corporation, <e1000-devel@lists.sourceforge.net> retpoline: Y rhelversion: 7.7 srcversion: DC5C250666ADD8603966656 alias: pci:v00008086d0000158Bsv*sd*bc*sc*i* alias: pci:v00008086d0000158Asv*sd*bc*sc*i* depends: ptp intree: Y vermagic: 3.10.0-993.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: 81:7C:CB:07:72:4E:7F:B8:15:24:10:F9:27:2D:AA:CF:80:3E:CE:59 sig_hashalgo: sha256 parm: debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint) parm: int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int) Raises: SkipException: When nothing need to parse. Examples: >>> from insights.core.filters import add_filter >>> from insights.specs import Specs >>> add_filter(Specs.modinfo_modules, 'i40e') >>> add_filter(Specs.modinfo_modules, 'vmxnet3') >>> type(mods_info) <class 'insights.parsers.modinfo.KernelModulesInfo'> >>> 'i40e' in mods_info True >>> mods_info['i40e'].module_version '2.3.2-k' >>> mods_info['i40e'].module_path '/lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz' >>> sorted(mods_info['i40e'].module_firmware) ['i40e/i40e-e1h-7.13.1.0.fw', 'i40e/i40e-e2-7.13.1.0.fw'] >>> sorted(mods_info['i40e'].module_alias) ['pci:v00008086d0000158Asv*sd*bc*sc*i*', 'pci:v00008086d0000158Bsv*sd*bc*sc*i*'] >>> sorted(mods_info['i40e'].module_parm) ['debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint)', 'int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int)'] >>> 'vmxnet3' in mods_info True Attributes: retpoline_y (set): A set of names of the modules with the attribute "retpoline: Y". retpoline_n (set): A set of names of the modules with the attribute "retpoline: N". """
[docs] def parse_content(self, content): if (not content) or (not self.file_path): raise SkipException("No Contents") self.retpoline_y = set() self.retpoline_n = set() idx = None for i, line in enumerate(content): if line.startswith('filename:'): if idx is not None: m = ModInfo.from_content(content[idx:i]) name = m.module_name self[name] = m self.retpoline_y.add(name) if m.get('retpoline') == 'Y' else None self.retpoline_n.add(name) if m.get('retpoline') == 'N' else None idx = i if idx is not None and idx < len(content): m = ModInfo.from_content(content[idx:]) name = m.module_name self[name] = m self.retpoline_y.add(name) if m.get('retpoline') == 'Y' else None self.retpoline_n.add(name) if m.get('retpoline') == 'N' else None if len(self) == 0: raise SkipException("No Parsed Contents")
[docs]@parser(Specs.modinfo_all) class ModInfoAll(KernelModulesInfo): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Class to parse the information about all kernel modules, the module info will be stored in dictionary format. Sample output:: filename: /lib/modules/3.10.0-957.10.1.el7.x86_64/kernel/drivers/net/vmxnet3/vmxnet3.ko.xz version: 1.4.14.0-k license: GPL v2 description: VMware vmxnet3 virtual NIC driver author: VMware, Inc. retpoline: Y rhelversion: 7.6 srcversion: 7E672688ACACBDD2E363B63 alias: pci:v000015ADd000007B0sv*sd*bc*sc*i* depends: intree: Y vermagic: 3.10.0-957.10.1.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: A5:70:18:DF:B6:C9:D6:1F:CF:CE:0A:3D:02:8B:B3:69:BD:76:CA:ED sig_hashalgo: sha256 filename: /lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz firmware: i40e/i40e-e2-7.13.1.0.fw firmware: i40e/i40e-e1h-7.13.1.0.fw version: 2.3.2-k license: GPL description: Intel(R) Ethernet Connection XL710 Network Driver author: Intel Corporation, <e1000-devel@lists.sourceforge.net> retpoline: Y rhelversion: 7.7 srcversion: DC5C250666ADD8603966656 alias: pci:v00008086d0000158Bsv*sd*bc*sc*i* alias: pci:v00008086d0000158Asv*sd*bc*sc*i* depends: ptp intree: Y vermagic: 3.10.0-993.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: 81:7C:CB:07:72:4E:7F:B8:15:24:10:F9:27:2D:AA:CF:80:3E:CE:59 sig_hashalgo: sha256 parm: debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint) parm: int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int) Raises: SkipException: When nothing need to parse. Examples: >>> type(modinfo_all) <class 'insights.parsers.modinfo.ModInfoAll'> >>> 'i40e' in modinfo_all True >>> modinfo_all['i40e'].module_version '2.3.2-k' >>> modinfo_all['i40e'].module_path '/lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz' >>> sorted(modinfo_all['i40e'].module_firmware) ['i40e/i40e-e1h-7.13.1.0.fw', 'i40e/i40e-e2-7.13.1.0.fw'] >>> sorted(modinfo_all['i40e'].module_alias) ['pci:v00008086d0000158Asv*sd*bc*sc*i*', 'pci:v00008086d0000158Bsv*sd*bc*sc*i*'] >>> sorted(modinfo_all['i40e'].module_parm) ['debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint)', 'int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int)'] >>> 'vmxnet3' in modinfo_all True Attributes: retpoline_y (set): A set of names of the modules with the attribute "retpoline: Y". retpoline_n (set): A set of names of the modules with the attribute "retpoline: N". """ def __init__(self, *args, **kwargs): deprecated( ModInfoAll, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoAll, self).__init__(*args, **kwargs)
[docs]@parser(Specs.modinfo) class ModInfoEach(CommandParser, ModInfo): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Parses the output of ``modinfo %s`` command, where %s is any of the loaded modules. Sample output:: filename: /lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz firmware: i40e/i40e-e2-7.13.1.0.fw firmware: i40e/i40e-e1h-7.13.1.0.fw version: 2.3.2-k license: GPL description: Intel(R) Ethernet Connection XL710 Network Driver author: Intel Corporation, <e1000-devel@lists.sourceforge.net> retpoline: Y rhelversion: 7.7 srcversion: DC5C250666ADD8603966656 alias: pci:v00008086d0000158Bsv*sd*bc*sc*i* alias: pci:v00008086d0000158Asv*sd*bc*sc*i* depends: ptp intree: Y vermagic: 3.10.0-993.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: 81:7C:CB:07:72:4E:7F:B8:15:24:10:F9:27:2D:AA:CF:80:3E:CE:59 sig_hashalgo: sha256 parm: debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint) parm: int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int) Raises: SkipException: When nothing is need to parse Examples: >>> type(modinfo_obj) <class 'insights.parsers.modinfo.ModInfoEach'> >>> modinfo_obj.module_name 'i40e' >>> modinfo_obj.module_version '2.3.2-k' >>> modinfo_obj.module_path '/lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz' >>> sorted(modinfo_obj.module_firmware) ['i40e/i40e-e1h-7.13.1.0.fw', 'i40e/i40e-e2-7.13.1.0.fw'] >>> sorted(modinfo_obj.module_alias) ['pci:v00008086d0000158Asv*sd*bc*sc*i*', 'pci:v00008086d0000158Bsv*sd*bc*sc*i*'] >>> sorted(modinfo_obj.module_parm) ['debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint)', 'int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int)'] """ def __init__(self, *args, **kwargs): deprecated( ModInfoEach, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoEach, self).__init__(*args, **kwargs)
[docs] def parse_content(self, content): self.update(ModInfo.from_content(content))
@property def data(self): """ (dict): This will return the kernel module details when set. """ return self
[docs]@parser(Specs.modinfo_i40e) class ModInfoI40e(ModInfoEach): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Parses output of ``modinfo i40e`` command. Sample ``modinfo i40e`` output:: filename: /lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz firmware: i40e/i40e-e2-7.13.1.0.fw firmware: i40e/i40e-e1h-7.13.1.0.fw version: 2.3.2-k license: GPL description: Intel(R) Ethernet Connection XL710 Network Driver author: Intel Corporation, <e1000-devel@lists.sourceforge.net> retpoline: Y rhelversion: 7.7 srcversion: DC5C250666ADD8603966656 alias: pci:v00008086d0000158Bsv*sd*bc*sc*i* alias: pci:v00008086d0000158Asv*sd*bc*sc*i* depends: ptp intree: Y vermagic: 3.10.0-993.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: 81:7C:CB:07:72:4E:7F:B8:15:24:10:F9:27:2D:AA:CF:80:3E:CE:59 sig_hashalgo: sha256 parm: debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint) parm: int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int) Examples: >>> type(modinfo_i40e) <class 'insights.parsers.modinfo.ModInfoI40e'> >>> modinfo_i40e.module_name 'i40e' >>> modinfo_i40e.module_version '2.3.2-k' >>> modinfo_i40e.module_path '/lib/modules/3.10.0-993.el7.x86_64/kernel/drivers/net/ethernet/intel/i40e/i40e.ko.xz' >>> 'firmware' in modinfo_i40e True >>> sorted(modinfo_i40e.module_firmware) == sorted(['i40e/i40e-e2-7.13.1.0.fw', 'i40e/i40e-e1h-7.13.1.0.fw']) True >>> sorted(modinfo_i40e.module_alias) == sorted(['pci:v00008086d0000158Asv*sd*bc*sc*i*', 'pci:v00008086d0000158Bsv*sd*bc*sc*i*']) True >>> sorted(modinfo_i40e.module_parm) == sorted(['debug:Debug level (0=none,...,16=all), Debug mask (0x8XXXXXXX) (uint)', 'int_mode: Force interrupt mode other than MSI-X (1 INT#x; 2 MSI) (int)']) True """ def __init__(self, *args, **kwargs): deprecated( ModInfoI40e, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoI40e, self).__init__(*args, **kwargs)
[docs]@parser(Specs.modinfo_vmxnet3) class ModInfoVmxnet3(ModInfoEach): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Parses output of ``modinfo vmxnet3`` command. Sample ``modinfo vmxnet3`` output:: filename: /lib/modules/3.10.0-957.10.1.el7.x86_64/kernel/drivers/net/vmxnet3/vmxnet3.ko.xz version: 1.4.14.0-k license: GPL v2 description: VMware vmxnet3 virtual NIC driver author: VMware, Inc. retpoline: Y rhelversion: 7.6 srcversion: 7E672688ACACBDD2E363B63 alias: pci:v000015ADd000007B0sv*sd*bc*sc*i* depends: intree: Y vermagic: 3.10.0-957.10.1.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: A5:70:18:DF:B6:C9:D6:1F:CF:CE:0A:3D:02:8B:B3:69:BD:76:CA:ED sig_hashalgo: sha256 Examples: >>> type(modinfo_drv) <class 'insights.parsers.modinfo.ModInfoVmxnet3'> >>> modinfo_drv.module_name 'vmxnet3' >>> modinfo_drv.module_version '1.4.14.0-k' >>> modinfo_drv.module_signer 'Red Hat Enterprise Linux kernel signing key' >>> modinfo_drv.module_alias 'pci:v000015ADd000007B0sv*sd*bc*sc*i*' """ def __init__(self, *args, **kwargs): deprecated( ModInfoVmxnet3, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoVmxnet3, self).__init__(*args, **kwargs)
[docs]@parser(Specs.modinfo_igb) class ModInfoIgb(ModInfoEach): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Parses output of ``modinfo igb`` command. Sample ``modinfo igb`` output:: filename: /lib/modules/3.10.0-327.10.1.el7.jump7.x86_64/kernel/drivers/net/ethernet/intel/igb/igb.ko version: 5.2.15-k license: GPL description: Intel(R) Gigabit Ethernet Network Driver author: Intel Corporation, <e1000-devel@lists.sourceforge.net> rhelversion: 7.2 srcversion: 9CF4D446FA2E882F6BA0A17 alias: pci:v00008086d000010D6sv*sd*bc*sc*i* depends: i2c-core,ptp,dca,i2c-algo-bit intree: Y vermagic: 3.10.0-327.10.1.el7.jump7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: C9:10:C7:BB:C3:C7:10:A1:68:A6:F3:6D:45:22:90:B7:5A:D4:B0:7A sig_hashalgo: sha256 parm: max_vfs:Maximum number of virtual functions to allocate per physical function (uint) parm: debug:Debug level (0=none,...,16=all) (int) Examples: >>> type(modinfo_igb) <class 'insights.parsers.modinfo.ModInfoIgb'> >>> modinfo_igb.module_name 'igb' >>> modinfo_igb.module_version '5.2.15-k' >>> modinfo_igb.module_signer 'Red Hat Enterprise Linux kernel signing key' >>> modinfo_igb.module_alias 'pci:v00008086d000010D6sv*sd*bc*sc*i*' """ def __init__(self, *args, **kwargs): deprecated( ModInfoIgb, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoIgb, self).__init__(*args, **kwargs)
[docs]@parser(Specs.modinfo_ixgbe) class ModInfoIxgbe(ModInfoEach): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Parses output of ``modinfo ixgbe`` command. Sample ``modinfo ixgbe`` output:: filename: /lib/modules/3.10.0-514.6.1.el7.jump3.x86_64/kernel/drivers/net/ethernet/intel/ixgbe/ixgbe.ko version: 4.4.0-k-rh7.3 license: GPL description: Intel(R) 10 Gigabit PCI Express Network Driver author: Intel Corporation, <linux.nics@intel.com> rhelversion: 7.3 srcversion: 24F0195E8A357701DE1B32E alias: pci:v00008086d000015CEsv*sd*bc*sc*i* depends: i2c-core,ptp,dca,i2c-algo-bit intree: Y vermagic: 3.10.0-514.6.1.el7.jump3.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: 69:10:6E:D5:83:0D:2C:66:97:41:91:7B:0F:57:D4:1D:95:A2:8A:EB sig_hashalgo: sha256 parm: max_vfs:Maximum number of virtual functions to allocate per physical function (uint) parm: debug:Debug level (0=none,...,16=all) (int) Examples: >>> type(modinfo_ixgbe) <class 'insights.parsers.modinfo.ModInfoIxgbe'> >>> modinfo_ixgbe.module_name 'ixgbe' >>> modinfo_ixgbe.module_version '4.4.0-k-rh7.3' >>> modinfo_ixgbe.module_signer 'Red Hat Enterprise Linux kernel signing key' >>> modinfo_ixgbe.module_alias 'pci:v00008086d000015CEsv*sd*bc*sc*i*' """ def __init__(self, *args, **kwargs): deprecated( ModInfoIxgbe, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoIxgbe, self).__init__(*args, **kwargs)
[docs]@parser(Specs.modinfo_veth) class ModInfoVeth(ModInfoEach): """ .. warning:: This parser is deprecated, please use :py:class:`insights.parsers.modinfo.KernelModulesInfo` instead. Parses output of ``modinfo veth`` command. Sample ``modinfo veth`` output:: filename: /lib/modules/3.10.0-327.el7.x86_64/kernel/drivers/net/veth.ko alias: rtnl-link-veth license: GPL v2 description: Virtual Ethernet Tunnel rhelversion: 7.2 srcversion: 25C6BF3D2F35CAF3A252F12 depends: intree: Y vermagic: 3.10.0-327.el7.x86_64 SMP mod_unload modversions signer: Red Hat Enterprise Linux kernel signing key sig_key: BC:73:C3:CE:E8:9E:5E:AE:99:4A:E5:0A:0D:B1:F0:FE:E3:FC:09:13 sig_hashalgo: sha256 Examples: >>> type(modinfo_veth) <class 'insights.parsers.modinfo.ModInfoVeth'> >>> modinfo_veth.module_name 'veth' >>> modinfo_veth.module_signer 'Red Hat Enterprise Linux kernel signing key' """ def __init__(self, *args, **kwargs): deprecated( ModInfoVeth, 'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.' ) super(ModInfoVeth, self).__init__(*args, **kwargs)