mirror of
https://git.yoctoproject.org/poky
synced 2026-02-11 03:03:02 +01:00
14dcd18f6c
By default, wic updates the /etc/fstab in the rootfs to include details of additional partitions described in the selected wks file. If this modification is performed in place, other tasks which create an image file from the rootfs directory (e.g. do_image_tar and do_image_ext4) will pick up the modified fstab file which would not be appropriate for those images as they do not include the additional partitions described in the wks file. wic does undo modifications to the fstab file once it has finished creating the filesystem image, however this leaves open a race condition if one of the other tasks reads the contents of the fstab file from the rootfs directory between the point where wic modifies the fstab file and the point where wic restores the files original content. This could be solved by adding a lockfile for tasks which use the rootfs directory to ensure that no other such task is reading the rootfs directory while do_image_wic is running. This would serialize several do_image_* tasks and result in slower builds, especially for large images. Another drawback of this solution is that it is hard to selectively optimise - adding lockfiles to do_image_* tasks would result in these tasks always being serialized even if no fstab modification will take place. An alternative solution is to copy the rootfs directory when fstab needs to be modified. The code to do this in wic already exists as it is needed when including or excluding content in the rootfs. This still results in an impact on build times but the copy uses hardlinks if possible (so little data is actually copied) and we can make selective optimisations to improve things. The rootfs copy will only take place if fstab modification is required (or if it was already needed to include or exclude rootfs content). We can also follow up with further optimisations after this commit. So this second solution is chosen. Fixes [Yocto #13994] (From OE-Core rev: 9414007dd73ffd41d1e9c68bae152e8cbb3c28a2) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit ce682a73b7447652f898ce1d1d0416a456df5416) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
176 lines
7.1 KiB
Python
176 lines
7.1 KiB
Python
#
|
|
# Copyright (c) 2014, Intel Corporation.
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# DESCRIPTION
|
|
# This implements the 'rootfs' source plugin class for 'wic'
|
|
#
|
|
# AUTHORS
|
|
# Tom Zanussi <tom.zanussi (at] linux.intel.com>
|
|
# Joao Henrique Ferreira de Freitas <joaohf (at] gmail.com>
|
|
#
|
|
|
|
import logging
|
|
import os
|
|
import shutil
|
|
import sys
|
|
|
|
from oe.path import copyhardlinktree
|
|
|
|
from wic import WicError
|
|
from wic.pluginbase import SourcePlugin
|
|
from wic.misc import get_bitbake_var, exec_native_cmd
|
|
|
|
logger = logging.getLogger('wic')
|
|
|
|
class RootfsPlugin(SourcePlugin):
|
|
"""
|
|
Populate partition content from a rootfs directory.
|
|
"""
|
|
|
|
name = 'rootfs'
|
|
|
|
@staticmethod
|
|
def __get_rootfs_dir(rootfs_dir):
|
|
if os.path.isdir(rootfs_dir):
|
|
return os.path.realpath(rootfs_dir)
|
|
|
|
image_rootfs_dir = get_bitbake_var("IMAGE_ROOTFS", rootfs_dir)
|
|
if not os.path.isdir(image_rootfs_dir):
|
|
raise WicError("No valid artifact IMAGE_ROOTFS from image "
|
|
"named %s has been found at %s, exiting." %
|
|
(rootfs_dir, image_rootfs_dir))
|
|
|
|
return os.path.realpath(image_rootfs_dir)
|
|
|
|
@staticmethod
|
|
def __get_pseudo(native_sysroot, rootfs, pseudo_dir):
|
|
pseudo = "export PSEUDO_PREFIX=%s/usr;" % native_sysroot
|
|
pseudo += "export PSEUDO_LOCALSTATEDIR=%s;" % pseudo_dir
|
|
pseudo += "export PSEUDO_PASSWD=%s;" % rootfs
|
|
pseudo += "export PSEUDO_NOSYMLINKEXP=1;"
|
|
pseudo += "%s " % get_bitbake_var("FAKEROOTCMD")
|
|
return pseudo
|
|
|
|
@classmethod
|
|
def do_prepare_partition(cls, part, source_params, cr, cr_workdir,
|
|
oe_builddir, bootimg_dir, kernel_dir,
|
|
krootfs_dir, native_sysroot):
|
|
"""
|
|
Called to do the actual content population for a partition i.e. it
|
|
'prepares' the partition to be incorporated into the image.
|
|
In this case, prepare content for legacy bios boot partition.
|
|
"""
|
|
if part.rootfs_dir is None:
|
|
if not 'ROOTFS_DIR' in krootfs_dir:
|
|
raise WicError("Couldn't find --rootfs-dir, exiting")
|
|
|
|
rootfs_dir = krootfs_dir['ROOTFS_DIR']
|
|
else:
|
|
if part.rootfs_dir in krootfs_dir:
|
|
rootfs_dir = krootfs_dir[part.rootfs_dir]
|
|
elif part.rootfs_dir:
|
|
rootfs_dir = part.rootfs_dir
|
|
else:
|
|
raise WicError("Couldn't find --rootfs-dir=%s connection or "
|
|
"it is not a valid path, exiting" % part.rootfs_dir)
|
|
|
|
part.rootfs_dir = cls.__get_rootfs_dir(rootfs_dir)
|
|
pseudo_dir = os.path.join(part.rootfs_dir, "../pseudo")
|
|
if not os.path.lexists(pseudo_dir):
|
|
logger.warn("%s folder does not exist. "
|
|
"Usernames and permissions will be invalid " % pseudo_dir)
|
|
pseudo_dir = None
|
|
|
|
new_rootfs = None
|
|
new_pseudo = None
|
|
# Handle excluded paths.
|
|
if part.exclude_path or part.include_path or part.change_directory or part.updated_fstab_path:
|
|
# We need a new rootfs directory we can safely modify without
|
|
# interfering with other tasks. Copy to workdir.
|
|
new_rootfs = os.path.realpath(os.path.join(cr_workdir, "rootfs%d" % part.lineno))
|
|
|
|
if os.path.lexists(new_rootfs):
|
|
shutil.rmtree(os.path.join(new_rootfs))
|
|
|
|
if part.change_directory:
|
|
cd = part.change_directory
|
|
if cd[-1] == '/':
|
|
cd = cd[:-1]
|
|
if os.path.isabs(cd):
|
|
logger.error("Must be relative: --change-directory=%s" % cd)
|
|
sys.exit(1)
|
|
orig_dir = os.path.realpath(os.path.join(part.rootfs_dir, cd))
|
|
if not orig_dir.startswith(part.rootfs_dir):
|
|
logger.error("'%s' points to a path outside the rootfs" % orig_dir)
|
|
sys.exit(1)
|
|
|
|
else:
|
|
orig_dir = part.rootfs_dir
|
|
copyhardlinktree(orig_dir, new_rootfs)
|
|
|
|
# Convert the pseudo directory to its new location
|
|
if (pseudo_dir):
|
|
new_pseudo = os.path.realpath(
|
|
os.path.join(cr_workdir, "pseudo%d" % part.lineno))
|
|
if os.path.lexists(new_pseudo):
|
|
shutil.rmtree(new_pseudo)
|
|
os.mkdir(new_pseudo)
|
|
shutil.copy(os.path.join(pseudo_dir, "files.db"),
|
|
os.path.join(new_pseudo, "files.db"))
|
|
|
|
pseudo_cmd = "%s -B -m %s -M %s" % (cls.__get_pseudo(native_sysroot,
|
|
new_rootfs,
|
|
new_pseudo),
|
|
orig_dir, new_rootfs)
|
|
exec_native_cmd(pseudo_cmd, native_sysroot)
|
|
|
|
for path in part.include_path or []:
|
|
copyhardlinktree(path, new_rootfs)
|
|
|
|
for orig_path in part.exclude_path or []:
|
|
path = orig_path
|
|
if os.path.isabs(path):
|
|
logger.error("Must be relative: --exclude-path=%s" % orig_path)
|
|
sys.exit(1)
|
|
|
|
full_path = os.path.realpath(os.path.join(new_rootfs, path))
|
|
|
|
# Disallow climbing outside of parent directory using '..',
|
|
# because doing so could be quite disastrous (we will delete the
|
|
# directory).
|
|
if not full_path.startswith(new_rootfs):
|
|
logger.error("'%s' points to a path outside the rootfs" % orig_path)
|
|
sys.exit(1)
|
|
|
|
if new_pseudo:
|
|
pseudo = cls.__get_pseudo(native_sysroot, new_rootfs, new_pseudo)
|
|
else:
|
|
pseudo = None
|
|
if path.endswith(os.sep):
|
|
# Delete content only.
|
|
for entry in os.listdir(full_path):
|
|
full_entry = os.path.join(full_path, entry)
|
|
rm_cmd = "rm -rf %s" % (full_entry)
|
|
exec_native_cmd(rm_cmd, native_sysroot, pseudo)
|
|
else:
|
|
# Delete whole directory.
|
|
rm_cmd = "rm -rf %s" % (full_path)
|
|
exec_native_cmd(rm_cmd, native_sysroot, pseudo)
|
|
|
|
has_fstab = os.path.exists(os.path.join(new_rootfs, "etc/fstab"))
|
|
if part.updated_fstab_path and has_fstab:
|
|
fstab_path = os.path.join(new_rootfs, "etc/fstab")
|
|
# Assume that fstab should always be owned by root with fixed permissions
|
|
install_cmd = "install -m 0644 %s %s" % (part.updated_fstab_path, fstab_path)
|
|
if new_pseudo:
|
|
pseudo = cls.__get_pseudo(native_sysroot, new_rootfs, new_pseudo)
|
|
else:
|
|
pseudo = None
|
|
exec_native_cmd(install_cmd, native_sysroot, pseudo)
|
|
|
|
part.prepare_rootfs(cr_workdir, oe_builddir,
|
|
new_rootfs or part.rootfs_dir, native_sysroot,
|
|
pseudo_dir = new_pseudo or pseudo_dir)
|