# Copyright (c) 2015 SUSE Linux GmbH. All rights reserved.
#
# This file is part of kiwi.
#
# kiwi is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# kiwi is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with kiwi. If not, see <http://www.gnu.org/licenses/>
#
import os
import logging
from contextlib import ExitStack
from typing import (
List, Optional, Dict
)
# project
from kiwi.command import Command
from kiwi.system.kernel import Kernel
from kiwi.boot.image.base import BootImageBase
from kiwi.defaults import Defaults
from kiwi.system.profile import Profile
from kiwi.system.setup import SystemSetup
from kiwi.system.identifier import SystemIdentifier
from kiwi.mount_manager import MountManager
log = logging.getLogger('kiwi')
[docs]
class BootImageDracut(BootImageBase):
"""
**Implements creation of dracut boot(initrd) images.**
"""
[docs]
@staticmethod
def has_initrd_support() -> bool:
"""
This instance supports initrd preparation and creation
"""
return True
[docs]
def post_init(self) -> None:
"""
Post initialization method
Initialize empty list of dracut caller options
"""
# signing keys are only taken into account on install of
# packages. As dracut runs from a pre defined root directory,
# no signing keys will be used in the process of creating
# an initrd with dracut
self.signing_keys = None
# Initialize empty list of dracut caller options
self.dracut_options: List[str] = []
self.included_files: List[str] = []
self.delete_after_include_files: List[str] = []
self.modules: List[str] = []
self.add_modules: List[str] = []
self.omit_modules: List[str] = []
self.available_modules = self._get_modules()
self.add_drivers: List[str] = []
self.omit_drivers: List[str] = []
self.available_drivers = self._get_drivers()
[docs]
def include_file(
self, filename: str, install_media: bool = False,
delete_after_include: bool = False
) -> None:
"""
Include file to dracut boot image
:param str filename: file path name
:param bool install_media: unused
"""
self.included_files.append('--install')
self.included_files.append(filename)
if delete_after_include:
self.delete_after_include_files.append(filename)
[docs]
def include_module(self, module: str, install_media: bool = False) -> None:
"""
Include module to dracut boot image
:param str module: module to include
:param bool install_media: unused
"""
warn_msg = 'module "{0}" not included in initrd'.format(module)
if self._module_available(module):
if module not in self.add_modules:
self.add_modules.append(module)
else:
log.warning(warn_msg)
[docs]
def omit_module(self, module: str, install_media: bool = False) -> None:
"""
Omit module to dracut boot image
:param str module: module to omit
:param bool install_media: unused
"""
if module not in self.omit_modules:
self.omit_modules.append(module)
[docs]
def set_static_modules(
self, modules: List[str], install_media: bool = False
) -> None:
"""
Set static dracut modules list for boot image
:param list modules: list of the modules to include
:param bool install_media: unused
"""
self.modules = modules
[docs]
def include_driver(self, driver: str, install_media: bool = False) -> None:
"""
Include driver to dracut boot image
:param str driver: driver to include
:param bool install_media: unused
"""
warn_msg = 'driver "{0}" not included in initrd'.format(driver)
if self._driver_available(driver):
if driver not in self.add_drivers:
self.add_drivers.append(driver)
else:
log.warning(warn_msg)
[docs]
def omit_driver(self, driver: str, install_media: bool = False) -> None:
"""
Omit driver to dracut boot image
:param str driver: driver to omit
:param bool install_media: unused
"""
if driver not in self.omit_drivers:
self.omit_drivers.append(driver)
[docs]
def write_system_config_file(
self, config: Dict, config_file: Optional[str] = None
) -> None:
"""
Writes modules configuration into a dracut configuration file.
:param dict config: a dictionary containing the modules to add and omit
:param str conf_file: configuration file to write
"""
dracut_config = []
if not config_file:
config_file = os.path.normpath(
self.boot_root_directory + Defaults.get_dracut_conf_name()
)
if config.get('modules'):
modules = [
module for module in config['modules']
if self._module_available(module)
]
dracut_config.append(
'add_dracutmodules+=" {0} "\n'.format(' '.join(modules))
)
if config.get('omit_modules'):
dracut_config.append(
'omit_dracutmodules+=" {0} "\n'.format(
' '.join(config['omit_modules'])
)
)
if config.get('install_items'):
dracut_config.append(
'install_items+=" {0} "\n'.format(
' '.join(config['install_items'])
)
)
if config.get('drivers'):
drivers = [
driver for driver in config['drivers']
if self._driver_available(driver)
]
dracut_config.append(
'add_drivers+=" {0} "\n'.format(' '.join(drivers))
)
if config.get('omit_drivers'):
dracut_config.append(
'omit_drivers+=" {0} "\n'.format(
' '.join(config['omit_drivers'])
)
)
if dracut_config and config_file:
with open(config_file, 'w') as config_handle:
config_handle.writelines(dracut_config)
[docs]
def prepare(self) -> None:
"""
Prepare dracut caller environment
* Setup machine_id(s) to be generic and rebuild by dracut on boot
"""
setup = SystemSetup(
self.xml_state, self.boot_root_directory
)
setup.setup_machine_id()
self.dracut_options.append('--install')
self.dracut_options.append('/.profile')
[docs]
def add_argument(self, option: str, value: str = '') -> None:
"""
Add caller argument to boot image creation tool
:param str option: argument name
:param str value: optional argument value
"""
self.dracut_options.append(option)
if value:
self.dracut_options.append(value)
[docs]
def create_uki(self, cmdline: str) -> str:
"""
Create UKI EFI binary
"""
if self.is_prepared():
log.info('Creating generic UKI EFI binary')
self._create_profile_environment()
kernel_info = Kernel(self.boot_root_directory)
kernel_details = kernel_info.get_kernel(raise_on_not_found=True)
boot_names = self.get_boot_names()
uki_base_name = \
f'{boot_names.initrd_name}.efi'
uki_base_name = uki_base_name.replace(
'initrd-', 'vmlinuz-'
)
included_files = self.included_files
modules_args = [
'--modules', ' {0} '.format(' '.join(self.modules))
] if self.modules else []
modules_args += [
'--add', ' {0} '.format(' '.join(self.add_modules))
] if self.add_modules else []
modules_args += [
'--omit', ' {0} '.format(' '.join(self.omit_modules))
] if self.omit_modules else []
drivers_arg = [
'--drivers', ' {0} '.format(' '.join(self.add_drivers))
] if self.add_drivers else []
drivers_arg += [
'--omit-drivers', ' {0} '.format(' '.join(self.omit_drivers))
] if self.omit_drivers else []
options = self.dracut_options + modules_args + drivers_arg + included_files
if kernel_details:
with ExitStack() as stack:
device_mount = MountManager(
device='/dev',
mountpoint=self.boot_root_directory + '/dev'
)
stack.push(device_mount)
device_mount.bind_mount()
proc_mount = MountManager(
device='/proc',
mountpoint=self.boot_root_directory + '/proc'
)
stack.push(proc_mount)
proc_mount.bind_mount()
dracut_call = Command.run(
[
'chroot', self.boot_root_directory,
'dracut',
'--no-hostonly',
'--no-hostonly-cmdline',
'--force',
'--verbose',
'--reproducible',
'--kver', kernel_details.version,
'--uefi',
'--kernel-cmdline', cmdline
] + options + [
uki_base_name
],
stderr_to_stdout=True
)
log.debug(dracut_call.output)
Command.run(
[
'mv',
os.sep.join(
[self.boot_root_directory, uki_base_name]
),
f'{self.target_dir}/kiwi.efi'
]
)
for filename in self.delete_after_include_files:
os.unlink(f'{self.boot_root_directory}/{filename}')
return os.path.normpath(
os.sep.join([self.target_dir, 'kiwi.efi'])
)
return ''
[docs]
def create_initrd(
self, mbrid: Optional[SystemIdentifier] = None,
basename: Optional[str] = None, install_initrd: bool = False
) -> None:
"""
Create kiwi .profile environment to be included in dracut initrd.
Call dracut as chroot operation to create the initrd and move
the result into the image build target directory
:param SystemIdentifier mbrid: unused
:param str basename: base initrd file name
:param bool install_initrd: unused
"""
if self.is_prepared():
log.info('Creating generic dracut initrd archive')
self._create_profile_environment()
kernel_info = Kernel(self.boot_root_directory)
kernel_details = kernel_info.get_kernel(raise_on_not_found=True)
if basename:
dracut_initrd_basename = basename
else:
dracut_initrd_basename = self.initrd_base_name
included_files = self.included_files
modules_args = [
'--modules', ' {0} '.format(' '.join(self.modules))
] if self.modules else []
modules_args += [
'--add', ' {0} '.format(' '.join(self.add_modules))
] if self.add_modules else []
modules_args += [
'--omit', ' {0} '.format(' '.join(self.omit_modules))
] if self.omit_modules else []
drivers_arg = [
'--drivers', ' {0} '.format(' '.join(self.add_drivers))
] if self.add_drivers else []
drivers_arg += [
'--omit-drivers', ' {0} '.format(' '.join(self.omit_drivers))
] if self.omit_drivers else []
options = self.dracut_options + modules_args + drivers_arg + included_files
if kernel_details:
with ExitStack() as stack:
device_mount = MountManager(
device='/dev',
mountpoint=self.boot_root_directory + '/dev'
)
stack.push(device_mount)
device_mount.bind_mount()
proc_mount = MountManager(
device='/proc',
mountpoint=self.boot_root_directory + '/proc'
)
stack.push(proc_mount)
proc_mount.bind_mount()
dracut_call = Command.run(
[
'chroot', self.boot_root_directory,
'dracut', '--verbose',
'--reproducible',
'--no-hostonly',
'--no-hostonly-cmdline'
] + options + [
dracut_initrd_basename,
kernel_details.version
],
stderr_to_stdout=True
)
log.debug(dracut_call.output)
Command.run(
[
'mv',
os.sep.join(
[self.boot_root_directory, dracut_initrd_basename]
),
self.target_dir
]
)
self.initrd_filename = os.sep.join(
[self.target_dir, dracut_initrd_basename]
)
Command.run(
['chmod', '644', self.initrd_filename]
)
for filename in self.delete_after_include_files:
os.unlink(f'{self.boot_root_directory}/{filename}')
def _get_modules(self) -> List[str]:
cmd = Command.run(
[
'chroot', self.boot_root_directory,
'dracut', '--list-modules', '--no-kernel'
]
)
return cmd.output.splitlines()
def _get_drivers(self) -> List[str]:
try:
kernel_info = Kernel(self.boot_root_directory).get_kernel()
if not kernel_info:
log.warning("No kernel found in boot directory")
return []
cmd = Command.run(
[
'chroot', self.boot_root_directory,
'cat', f'/lib/modules/{kernel_info.version}/modules.dep'
]
)
drivers = [
os.path.basename(line.split(':')[0].strip()).split('.ko')[0]
for line in cmd.output.splitlines()
if line.strip()
]
return drivers
except Exception as e:
log.warning(f"Error reading drivers: {str(e)}")
return []
def _module_available(self, module: str) -> bool:
warn_msg = 'dracut module "{0}" not found in the root tree'
if module in self.available_modules:
return True
log.warning(warn_msg.format(module))
return False
def _driver_available(self, driver: str) -> bool:
warn_msg = 'dracut driver "{0}" not found in the root tree'
if driver in self.available_drivers:
return True
log.warning(warn_msg.format(driver))
return False
def _create_profile_environment(self) -> None:
profile = Profile(self.xml_state)
defaults = Defaults()
defaults.to_profile(profile)
profile.create(
Defaults.get_profile_file(self.boot_root_directory)
)