"""
GRUB configuration files
========================
This parser reads the configuration of the GRand Unified Bootloader, versions
1 or 2.
This is currently a fairly simple parsing process. Data read from the file
is put into roughly three categories:
* **configs**: lines read from the file that aren't boot options (i.e.
excluding lines that go in the *title* and *menuentry* sections). These
are split into pairs on the first '=' sign.
* **title**: (GRUB v1 only) lines prefixed by the word 'title'. All following
lines up to the next title line are folded together.
* **menuentry**: (GRUB v2 only) lines prefixed by the word 'menuentry'. All
following lines up to the line starting with '}' are treated as part of one
menu entry.
Each of these categories is (currently) stored as a simple list of tuples.
* For the **configs** dict, the key-value pairs based on the line, split
on the first '=' character. If nothing is found after the '=' character,
then the value is `''`.
* For the **title** and **menuentry** list, dict of each boot entry is stored.
* The items will be key-value pairs, e.g. ``load_video`` will be stored
as ``{'load_video': ''}`` and ``set root='hd0,msdos1'`` will be stored
as ``{'set': "root='hd0,msdos1'"}``.
.. note::
For GRUB version 2, all lines between the ``if`` and ``fi`` will be ignored
due to we cannot analyze the result of the bash conditions.
Parsers provided by this module are:
Grub1Config - file ``/boot/grub.conf``
--------------------------------------
Grub1EFIConfig - file ``/boot/efi/EFI/redhat/grub.conf``
--------------------------------------------------------
Grub2Config - file ``/boot/grub/grub2.cfg``
-------------------------------------------
Grub2EFIConfig - file ``/boot/efi/EFI/redhat/grub.cfg``
-------------------------------------------------------
BootLoaderEntries - file ``/boot/loader/entries/*.conf``
--------------------------------------------------------
"""
from insights.components.rhel_version import IsRhel6, IsRhel7, IsRhel8, IsRhel9
from insights.core import Parser
from insights.core.exceptions import ParseException, SkipComponent
from insights.core.plugins import parser
from insights.parsers import get_active_lines
from insights.specs import Specs
[docs]
class BootEntry(dict):
"""
An object representing a boot entry in the Grub Configuration.
Attributes:
name (str): Name of the boot entry
cmdline (str): Cmdline of the boot entry
"""
def __init__(self, data={}):
self.update(data)
self.name = data.get('name', '')
self.cmdline = data.get('cmdline', '')
[docs]
class GrubConfig(Parser, dict):
"""
Parser for configuration for both GRUB versions 1 and 2.
"""
[docs]
def parse_content(self, content):
"""
Parse grub configuration file to create a dict with this structure::
{
"configs": {
name1: [val1, val2, ...]
name2: [val],
...
},
"title": [
{title: name1, kernel: [val], ...},
{title: name2, module: [val1, val2], ...},
],
"menuentry": [
{menuentry: name1, insmod: [val1, val2], ...},
{menuentry: name2, linux16: [val], ...},
],
}
"""
def _skip_script(line):
# Skip the script in Grub2
if line.startswith('if'):
_skip_script.if_idx += 1
elif line.startswith('fi'):
_skip_script.if_idx -= 1
return _skip_script.if_idx
def _parser_line(line):
sp = [i.strip() for i in line.split(None, 1)]
val = sp[1] if len(sp) > 1 else ''
if sp[0] not in entry:
entry[sp[0]] = []
entry[sp[0]].append(val)
# Handle the cmdline
if sp[0].startswith(('kernel', 'linux')):
b_entry['cmdline'] = val
def _parser_entry_line(line):
if line.startswith('title '):
name = line.split('title', 1)[1].strip()
b_entry['name'] = entry['title'] = name
else:
sp = line.split('menuentry', 1)[1].split('{', 1)
name = sp[0].strip()
if not name:
raise ParseException("Cannot parse menuentry line: {0}".format(line_raw))
b_entry['name'] = entry['menuentry'] = name
# More things after the {
if len(sp) > 1 and sp[1]:
_parser_line(sp[1])
self.configs = {}
self._boot_entries = []
self.entries = []
b_entry = {}
entry = {}
_skip_script.if_idx = 0
for line_raw in get_active_lines(content):
# Handle of lines {
# Remove the heading and trailing whitespace and curly brackets
line = line_raw.strip('{} \t')
if_idx = _skip_script(line)
if if_idx == 0 and line and not line.startswith('fi'):
# Handle the title / menuentry {
if line.startswith(('title ', 'menuentry')):
self.entries.append(entry) if entry else None
self._boot_entries.append(BootEntry(b_entry)) if b_entry else None
b_entry = {}
entry = {}
_parser_entry_line(line)
# } End of title / menuentry handling
# Lines inside of an entry
elif entry:
_parser_line(line)
# Lines outside of entries
else:
sep = '=' if '=' in line else None
sp = [i.strip() for i in line.split(sep, 1)]
if sp[0] not in self.configs:
self.configs[sp[0]] = []
self.configs[sp[0]].append(sp[1] if len(sp) > 1 else '')
# } End of outside of entry
# } End of lines handling
# Store the last entry
self.entries.append(entry) if entry else None
self.boot_entries.append(BootEntry(b_entry)) if b_entry else None
self.update({'configs': self.configs}) if self.configs else None
self._is_kdump_iommu_enabled_ = self._is_kdump_iommu_enabled()
self._kernel_initrds = get_kernel_initrds(self.entries)
def _is_kdump_iommu_enabled(self):
for l in self._boot_entries:
if "intel_iommu=on" in l.get('cmdline', ''):
return True
return False
@property
def boot_entries(self):
"""
Get all boot entries in GRUB configuration.
Returns:
(list): A list of :class:`insights.parsers.grub_conf.BootEntry`
objects for each boot entry in below format:
- 'name': "Red Hat Enterprise Linux Server"
- 'cmdline': "kernel /vmlinuz-2.6.32-431.11.2.el6.x86_64 crashkernel=128M rhgb quiet"
"""
return self._boot_entries
@property
def is_kdump_iommu_enabled(self):
"""
Does any kernel have 'intel_iommu=on' set?
Returns:
(bool): ``True`` when 'intel_iommu=on' is set, otherwise returns ``False``
"""
return self._is_kdump_iommu_enabled_
@property
def kernel_initrds(self):
"""
Get the `kernel` and `initrd` files referenced in GRUB configuration files
Returns:
(dict): Returns a dict of the `kernel` and `initrd` files referenced
in GRUB configuration files
"""
return self._kernel_initrds
[docs]
@parser(Specs.grub_conf, [IsRhel6, IsRhel7])
class Grub1Config(GrubConfig):
"""
Parser for configuration for GRUB version 1.
Examples:
>>> grub1_content = '''
... default=0
... timeout=0
... splashimage=(hd0,0)/grub/splash.xpm.gz
... hiddenmenu
... title Red Hat Enterprise Linux Server (2.6.32-431.17.1.el6.x86_64)
... kernel /vmlinuz-2.6.32-431.17.1.el6.x86_64 crashkernel=128M rhgb quiet
... title Red Hat Enterprise Linux Server (2.6.32-431.11.2.el6.x86_64)
... kernel /vmlinuz-2.6.32-431.11.2.el6.x86_64 crashkernel=128M rhgb quiet
... '''.strip()
>>> grub1_config.configs.get('default')
['0']
>>> grub1_config.configs.get('hiddenmenu')
['']
>>> grub1_config['title'][0]['kernel']
['/vmlinuz-2.6.32-431.17.1.el6.x86_64 crashkernel=128M rhgb quiet']
>>> grub1_config.entries[1]['title']
'Red Hat Enterprise Linux Server (2.6.32-431.11.2.el6.x86_64)'
>>> grub1_config.boot_entries[1].name
'Red Hat Enterprise Linux Server (2.6.32-431.11.2.el6.x86_64)'
>>> grub1_config.boot_entries[1].cmdline
'/vmlinuz-2.6.32-431.11.2.el6.x86_64 crashkernel=128M rhgb quiet'
>>> grub1_config.is_kdump_iommu_enabled
False
>>> grub1_config.kernel_initrds['grub_kernels']
['vmlinuz-2.6.32-431.17.1.el6.x86_64', 'vmlinuz-2.6.32-431.11.2.el6.x86_64']
"""
def __init__(self, *args, **kwargs):
super(Grub1Config, self).__init__(*args, **kwargs)
self._version = 1
self._efi = False
self.update({'title': self.entries})
[docs]
def get_current_title(self):
"""
Get the current default title from the ``default`` option in the
main configuration. (GRUB v1 only)
Returns:
list: A list of dict contains all settings of the default boot entry:
- {title: name1, kernel: [val], ...},
"""
# if no 'default' in grub.conf, set default to 0
idx = '0'
for k, v in self.configs.items():
if k == 'default':
idx = v[-1]
break
if idx.isdigit():
idx = int(idx)
if len(self.entries) > idx:
return self.entries[idx]
return None
[docs]
@parser(Specs.grub_efi_conf, [IsRhel6, IsRhel7])
class Grub1EFIConfig(Grub1Config):
"""
Parses grub v1 configuration for EFI-based systems
Content of grub-efi.conf is the same as grub.conf
"""
def __init__(self, *args, **kwargs):
super(Grub1EFIConfig, self).__init__(*args, **kwargs)
self._efi = True
[docs]
@parser(Specs.grub2_cfg, [IsRhel6, IsRhel7, IsRhel8, IsRhel9])
class Grub2Config(GrubConfig):
"""
Parser for configuration for GRUB version 2.
Examples:
>>> grub2_content = '''
... ### BEGIN /etc/grub.d/00_header ###
... set pager=1
... /
... if [ -s $prefix/grubenv ]; then
... load_env
... fi
... #[...]
... if [ x"${feature_menuentry_id}" = xy ]; then
... menuentry_id_option="--id"
... else
... menuentry_id_option=""
... fi
... #[...]
... ### BEGIN /etc/grub.d/10_linux ###
... menuentry 'Red Hat Enterprise Linux Workstation (3.10.0-327.36.3.el7.x86_64) 7.2 (Maipo)' $menuentry_id_option 'gnulinux-3.10.0-123.13.2.el7.x86_64-advanced-fbff9f50-62c3-484e-bca5-d53f672cda7c' {
... load_video
... set gfxpayload=keep
... insmod gzio
... insmod part_msdos
... insmod ext2
... set root='hd0,msdos1'
... if [ x$feature_platform_search_hint = xy ]; then
... search --no-floppy --fs-uuid --set=root --hint-bios=hd0,msdos1 --hint-efi=hd0,msdos1 --hint-baremetal=ahci0,msdos1 --hint='hd0,msdos1' 1184ab74-77b5-4cfa-81d3-fb87b0457577
... else
... search --no-floppy --fs-uuid --set=root 1184ab74-77b5-4cfa-81d3-fb87b0457577
... fi
... linux16 /vmlinuz-3.10.0-327.36.3.el7.x86_64 root=/dev/RHEL7CSB/Root ro rd.lvm.lv=RHEL7CSB/Root rd.luks.uuid=luks-96c66446-77fd-4431-9508-f6912bd84194 crashkernel=128M@16M rd.lvm.lv=RHEL7CSB/Swap vconsole.font=latarcyrheb-sun16 rhgb quiet LANG=en_GB.utf8
... initrd16 /initramfs-3.10.0-327.36.3.el7.x86_64.img
... }
... '''.strip()
>>> grub2_config['configs']
{'set pager': ['1'], '/': ['']}
>>> grub2_config.entries[0]['menuentry']
"'Red Hat Enterprise Linux Workstation (3.10.0-327.36.3.el7.x86_64) 7.2 (Maipo)' $menuentry_id_option 'gnulinux-3.10.0-123.13.2.el7.x86_64-advanced-fbff9f50-62c3-484e-bca5-d53f672cda7c'"
>>> grub2_config['menuentry'][0]['insmod']
['gzio', 'part_msdos', 'ext2']
>>> grub2_config.boot_entries[0].name
"'Red Hat Enterprise Linux Workstation (3.10.0-327.36.3.el7.x86_64) 7.2 (Maipo)' $menuentry_id_option 'gnulinux-3.10.0-123.13.2.el7.x86_64-advanced-fbff9f50-62c3-484e-bca5-d53f672cda7c'"
>>> grub2_config.boot_entries[0].cmdline
'/vmlinuz-3.10.0-327.36.3.el7.x86_64 root=/dev/RHEL7CSB/Root ro rd.lvm.lv=RHEL7CSB/Root rd.luks.uuid=luks-96c66446-77fd-4431-9508-f6912bd84194 crashkernel=128M@16M rd.lvm.lv=RHEL7CSB/Swap vconsole.font=latarcyrheb-sun16 rhgb quiet LANG=en_GB.utf8'
>>> grub2_config.kernel_initrds['grub_kernels'][0]
'vmlinuz-3.10.0-327.36.3.el7.x86_64'
>>> grub2_config.is_kdump_iommu_enabled
False
"""
def __init__(self, *args, **kwargs):
super(Grub2Config, self).__init__(*args, **kwargs)
self._version = 2
self._efi = False
self.update({'menuentry': self.entries})
[docs]
@parser(Specs.grub2_efi_cfg, [IsRhel6, IsRhel7, IsRhel8])
class Grub2EFIConfig(Grub2Config):
"""Parses grub2 configuration for EFI-based systems"""
def __init__(self, *args, **kwargs):
super(Grub2EFIConfig, self).__init__(*args, **kwargs)
self._version = 2
self._efi = True
[docs]
@parser(Specs.boot_loader_entries, [IsRhel8, IsRhel9])
class BootLoaderEntries(Parser, dict):
"""
Parses the ``/boot/loader/entries/*.conf`` files.
Attributes:
title(str): the name of the boot entry
cmdline(str): the cmdline of the saved boot entry
Raises:
SkipComponent: when input content is empty or no useful data.
"""
[docs]
def parse_content(self, content):
"""
Parses the ``/boot/loader/entries/*.conf`` files.
"""
if not content:
raise SkipComponent()
self.entry = {}
self.title = ''
self.cmdline = ''
for line in content:
key, value = [i.strip() for i in line.split(None, 1)]
self.entry[key] = value
if key == 'options':
self.cmdline = value
if not self.entry:
raise SkipComponent()
self.update(self.entry)
self.title = self.entry.get('title')
self.is_kdump_iommu_enabled = "intel_iommu=on" in self.cmdline
def get_kernel_initrds(entries):
kernels = []
initrds = []
for entry in entries:
for name, value in entry.items():
v = []
if (name.startswith(('module', 'kernel', 'linux', 'initrd'))):
if isinstance(value, list):
v = [i.split()[0].split('/')[-1] for i in value if i]
elif value and isinstance(value, str):
v = [value.split()[0].split('/')[-1]]
if v:
if name.startswith('module'):
kernels.extend([i for i in v if 'vmlinuz' in i])
initrds.extend([i for i in v if 'initrd' in i or 'initramfs' in i])
elif (name.startswith(('kernel', 'linux'))):
if any('ipxe.lkrn' in i for i in v):
# Machine PXE boots the kernel, assume all is ok
return {}
elif 'xen.gz' not in v:
kernels.extend([i for i in v if 'xen.gz' not in i])
elif name.startswith('initrd') or name.startswith('initrd16'):
initrds.extend(v)
return {'grub_kernels': kernels, 'grub_initrds': initrds}