portage/build_defs/package_contents.bzl

# Copyright 2023 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

load("common.bzl", "ContentLayerTypesInfo", "ContentLayersInfo")

def _generate_contents_layer(
        ctx,
        binary_package,
        output_name,
        image_prefix,
        vdb_prefix,
        host,
        sparse_vdb,
        drop_revision,
        executable_action_wrapper,
        executable_extract_package):
    output_contents_dir = ctx.actions.declare_directory(output_name)
    output_log = ctx.actions.declare_file(output_name + ".log")

    arguments = ctx.actions.args()
    arguments.add_all([
        "--log",
        output_log,
        executable_extract_package,
        "--input-binary-package",
        binary_package,
        "--output-directory",
        output_contents_dir,
        "--image-prefix=" + image_prefix,
        "--vdb-prefix=" + vdb_prefix,
    ], expand_directories = False)

    if sparse_vdb:
        arguments.add("--sparse-vdb")

    if drop_revision:
        arguments.add("--drop-revision")

    if host:
        arguments.add("--host")

    ctx.actions.run(
        inputs = [binary_package],
        outputs = [output_contents_dir, output_log],
        executable = executable_action_wrapper,
        tools = [executable_extract_package],
        arguments = [arguments],
        execution_requirements = {
            # Disable sandbox to avoid creating a symlink forest.
            # This does not affect hermeticity since ebuild runs in a container.
            "no-sandbox": "",
            # Send SIGTERM instead of SIGKILL on user interruption.
            "supports-graceful-termination": "",
        },
        progress_message = "Extracting %{label}",
    )

    return output_contents_dir

def generate_contents(
        ctx,
        binary_package,
        output_prefix,
        board,
        executable_action_wrapper,
        executable_extract_package):
    """
    Defines actions that build contents layers from a binary package.

    Args:
        ctx: ctx: A context object passed to the rule implementation.
        binary_package: File: Binary package file.
        output_prefix: str: A file name prefix to prepend to output directories
            defined in this function.
        board: str: The target board name to install a package for. If it is
            non-empty, the package is to be installed to the corresponding
            sysroot (ROOT="/build/<board>"). If it is an empty string, the
            package is to be installed to the host (ROOT="/").
        executable_action_wrapper: File: An executable file of action_wrapper.
        executable_extract_package: File: An executable file of extract_package.

    Returns:
        ContentLayerTypesInfo: A struct suitable to set in
            BinaryPackageInfo.contents.
    """
    if board:
        name = board
        sysroot = "/build/%s" % board
        host = board == "amd64-host"
    else:
        name = "host"
        sysroot = "/"
        host = True

    prefix = sysroot.lstrip("/")

    return ContentLayerTypesInfo(
        sysroot = sysroot,
        full = ContentLayersInfo(
            installed = _generate_contents_layer(
                ctx = ctx,
                binary_package = binary_package,
                output_name = "%s.%s.full.installed.contents" % (output_prefix, name),
                image_prefix = prefix,
                vdb_prefix = prefix,
                host = host,
                sparse_vdb = False,
                drop_revision = False,
                executable_action_wrapper = executable_action_wrapper,
                executable_extract_package = executable_extract_package,
            ),
            staged = _generate_contents_layer(
                ctx = ctx,
                binary_package = binary_package,
                output_name = "%s.%s.full.staged.contents" % (output_prefix, name),
                image_prefix = ".image",
                vdb_prefix = prefix,
                host = host,
                sparse_vdb = False,
                drop_revision = False,
                executable_action_wrapper = executable_action_wrapper,
                executable_extract_package = executable_extract_package,
            ),
        ),
        internal = ContentLayersInfo(
            installed = _generate_contents_layer(
                ctx = ctx,
                binary_package = binary_package,
                output_name = "%s.%s.sparse.installed.contents" % (output_prefix, name),
                image_prefix = prefix,
                vdb_prefix = prefix,
                host = host,
                # We don't need most of the vdb once the package has been installed.
                sparse_vdb = True,
                drop_revision = True,
                executable_action_wrapper = executable_action_wrapper,
                executable_extract_package = executable_extract_package,
            ),
            staged = _generate_contents_layer(
                ctx = ctx,
                binary_package = binary_package,
                output_name = "%s.%s.sparse.staged.contents" % (output_prefix, name),
                image_prefix = ".image",
                vdb_prefix = prefix,
                host = host,
                # We need the full vdb so we can run the install hooks.
                sparse_vdb = False,
                drop_revision = True,
                executable_action_wrapper = executable_action_wrapper,
                executable_extract_package = executable_extract_package,
            ),
        ),
    )