diff --git a/man/kernel-install.xml b/man/kernel-install.xml index 29b0d8eb54..f3fdc961f4 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -108,6 +108,14 @@ is missing), or "Linux KERNEL-VERSION", if unset. If $KERNEL_INSTALL_LAYOUT is not "bls", this plugin does nothing. + + 90-uki-copy.install copies a file + uki.efi from $KERNEL_INSTALL_STAGING_AREA or if it does + not exist the KERNEL-IMAGE argument, iff it has a + .efi extension, to + $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION.efi. + + If $KERNEL_INSTALL_LAYOUT is not "uki", this plugin does nothing. @@ -132,6 +140,9 @@ 90-loaderentry.install removes the file $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION.conf. + + 90-uki-copy.install removes the file + $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION.efi. @@ -213,7 +224,7 @@ (EFI System Partition) are mounted, and also conceptually referred to as $BOOT. Can be overridden by setting $BOOT_ROOT (see below). - $KERNEL_INSTALL_LAYOUT=bls|other|... is set for the plugins to specify the + $KERNEL_INSTALL_LAYOUT=bls|uki|other|... is set for the plugins to specify the installation layout. Defaults to if $BOOT/ENTRY-TOKEN exists, or otherwise. Additional layout names may be defined by convention. If a plugin uses a special layout, @@ -235,6 +246,18 @@ Implemented by 90-loaderentry.install. + + uki + + Standard Boot Loader + Specification Type #2 layout, compatible with + systemd-boot7: + unified kernel images under $BOOT/EFI/Linux as + $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION[+TRIES].efi. + Implemented by 90-uki-copy.install. + + other @@ -312,12 +335,15 @@ /etc/kernel/tries - Read by 90-loaderentry.install. If this file exists a numeric value is read from - it and the naming of the generated entry file is slightly altered to include it as - $BOOT/loader/entries/MACHINE-ID-KERNEL-VERSION+TRIES.conf. This + Read by 90-loaderentry.install and + 90-uki-copy.install. If this file exists a numeric value is read from it + and the naming of the generated entry file or UKI is slightly altered to include it as + $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION+TRIES.conf + or + $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION+TRIES.conf, respectively. This is useful for boot loaders such as - systemd-boot7 which - implement boot attempt counting with a counter embedded in the entry file name. + systemd-boot7 + which implement boot attempt counting with a counter embedded in the entry file name. $KERNEL_INSTALL_CONF_ROOT may be used to override the path. diff --git a/src/kernel-install/90-uki-copy.install b/src/kernel-install/90-uki-copy.install new file mode 100755 index 0000000000..d6e3deb723 --- /dev/null +++ b/src/kernel-install/90-uki-copy.install @@ -0,0 +1,97 @@ +#!/bin/sh +# -*- mode: shell-script; indent-tabs-mode: nil; sh-basic-offset: 4; -*- +# ex: ts=8 sw=4 sts=4 et filetype=sh +# SPDX-License-Identifier: LGPL-2.1-or-later +# +# This file is part of systemd. +# +# systemd is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation; either version 2.1 of the License, or +# (at your option) any later version. +# +# systemd 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 Lesser General Public License +# along with systemd; If not, see . + +set -e + +COMMAND="${1:?}" +KERNEL_VERSION="${2:?}" +# shellcheck disable=SC2034 +ENTRY_DIR_ABS="$3" +KERNEL_IMAGE="$4" + +[ "$KERNEL_INSTALL_LAYOUT" = "uki" ] || exit 0 + +ENTRY_TOKEN="$KERNEL_INSTALL_ENTRY_TOKEN" +BOOT_ROOT="$KERNEL_INSTALL_BOOT_ROOT" + +UKI_DIR="$BOOT_ROOT/EFI/Linux" + +case "$COMMAND" in + remove) + [ "$KERNEL_INSTALL_VERBOSE" -gt 0 ] && \ + echo "Removing $UKI_DIR/$ENTRY_TOKEN-$KERNEL_VERSION*.efi" + exec rm -f \ + "$UKI_DIR/$ENTRY_TOKEN-$KERNEL_VERSION.efi" \ + "$UKI_DIR/$ENTRY_TOKEN-$KERNEL_VERSION+"*".efi" + ;; + add) + ;; + *) + exit 0 + ;; +esac + +if ! [ -d "$UKI_DIR" ]; then + echo "Error: entry directory '$UKI_DIR' does not exist" >&2 + exit 1 +fi + +TRIES_FILE="${KERNEL_INSTALL_CONF_ROOT:-/etc/kernel}/tries" + +if [ -f "$TRIES_FILE" ]; then + read -r TRIES <"$TRIES_FILE" + if ! echo "$TRIES" | grep -q '^[0-9][0-9]*$'; then + echo "$TRIES_FILE does not contain an integer." >&2 + exit 1 + fi + UKI_FILE="$UKI_DIR/$ENTRY_TOKEN-$KERNEL_VERSION+$TRIES.efi" +else + UKI_FILE="$UKI_DIR/$ENTRY_TOKEN-$KERNEL_VERSION.efi" +fi + +# If there is a UKI named uki.efi on the staging area use that, if not use what +# was passed in as $KERNEL_IMAGE but insist it has a .efi extension +if [ -f "$KERNEL_INSTALL_STAGING_AREA/uki.efi" ]; then + [ "$KERNEL_INSTALL_VERBOSE" -gt 0 ] && echo "Installing $KERNEL_INSTALL_STAGING_AREA/uki.efi" + install -m 0644 "$KERNEL_INSTALL_STAGING_AREA/uki.efi" "$UKI_FILE" || { + echo "Error: could not copy '$KERNEL_INSTALL_STAGING_AREA/uki.efi' to '$UKI_FILE'." >&2 + exit 1 + } +elif [ -n "$KERNEL_IMAGE" ]; then + [ -f "$KERNEL_IMAGE" ] || { + echo "Error: UKI '$KERNEL_IMAGE' not a file." >&2 + exit 1 + } + [ "$KERNEL_IMAGE" != "${KERNEL_IMAGE%*.efi}.efi" ] && { + echo "Error: $KERNEL_IMAGE is missing .efi suffix." >&2 + exit 1 + } + [ "$KERNEL_INSTALL_VERBOSE" -gt 0 ] && echo "Installing $KERNEL_IMAGE" + install -m 0644 "$KERNEL_IMAGE" "$UKI_FILE" || { + echo "Error: could not copy '$KERNEL_IMAGE' to '$UKI_FILE'." >&2 + exit 1 + } +else + [ "$KERNEL_INSTALL_VERBOSE" -gt 0 ] && echo "No UKI available. Nothing to do." + exit 0 +fi +chown root:root "$UKI_FILE" || : + +exit 0 diff --git a/src/kernel-install/meson.build b/src/kernel-install/meson.build index e5cfdb824c..b0b6c27ede 100644 --- a/src/kernel-install/meson.build +++ b/src/kernel-install/meson.build @@ -12,6 +12,8 @@ loaderentry_install = custom_target( install_mode : 'rwxr-xr-x', install_dir : kernelinstalldir) +uki_copy_install = files('90-uki-copy.install') + if want_kernel_install install_data('50-depmod.install', install_mode : 'rwxr-xr-x',