[packages/efi-boot-update.git] / efi-boot-update

#!/bin/sh

_SCRIPT_NAME=efi-boot-update
_SCRIPT_VERSION=0.1

. /etc/rc.d/init.d/functions

usage () {

    echo "Usage: $0 OPTIONS"
    echo "Update EFI boot loaders"
    echo
    echo "  --version      Show version number"
    echo "  --help, -h     This help message"
    echo "  --mount, -m    Try to mount /boot/efi first"
    echo "  --verbose, -v  Verbose output"
    echo "  --force        Force file updates"
    echo "  --auto         Automatic run from packages %post"
}

msg () {
    echo -E "efi-boot-update: $*" >&2
}

verbose () {
    if is_yes "$VERBOSE" ; then 
        echo -E "efi-boot-update: $*" >&2
    fi
}

verbose_cmd () {
    if is_yes "$VERBOSE" ; then
        echo -E "+$*" >&2
    fi
    "$@"
}


list_remove () {

    for item in $1 ; do
        if [ "$item" = "$2" ] ; then
            continue
        fi
        echo -nE "$item "
    done
}

update_file () {
    local cmd
    local src
    local dest
    while [ -n "$1" ] ; do
        case $1 in 
            --missingok)
                shift
                [ -e "$1" ] || return 0
                ;;
            --*)
                msg "update_file: ignoring unknown option: $1"
                shift
                ;;
            *)
                break
                ;;
        esac
    done
    src="$1"; shift
    dst="$1"; shift
    if [ -n "$*" ] ; then
        msg "update_file: unexpected arguments: $*"
        return 1
    fi
    if [ -z "$src" ] ; then
        msg "update_file: no source file"
        return 1
    fi
    if [ -z "$dst" ] ; then
        dst=`basename "$src"`
    fi
    if [ "${dst#/}" = "${dst}" ] ; then
        # relative path
        dst="$DESTDIR/$dst"
    fi
    if is_yes "$FORCE_UPDATES" ; then
        is_yes "$VERBOSE" && echo +cp --force --preserve=timestamps "$src" "$dst"
        cp --force --preserve=timestamps "$src" "$dst"
    else
        is_yes "$VERBOSE" && echo +cp --update --preserve=timestamps "$src" "$dst"
        cp --update --preserve=timestamps "$src" "$dst"
    fi
}

get_efibootmgr_opts() {
    local efi_disk
    local efi_partnum
    efi_disk=$(mount | awk '$3=="/boot/efi" {print $1}' 2>/dev/null)
    EFIBOOTMGR_OPTS="--gpt"
    if [ -n "$efi_disk" ] ; then
        efi_partnum="$(echo $efi_disk|sed -e's;^.*[^0-9]\([0-9]\+\)$;\1;')"
        efi_disk="$(echo $efi_disk|sed -e's;^\(.*\)[0-9]\+$;\1;')"
        if [ -b "$efi_disk" -a -n "$efi_partnum" ] ; then 
            EFIBOOTMGR_OPTS="$EFIBOOTMGR_OPTS --disk $efi_disk"
            EFIBOOTMGR_OPTS="$EFIBOOTMGR_OPTS --part $efi_partnum"
        fi
    fi
    echo -n $EFIBOOTMGR_OPTS
}

find_bootmgr_entry () {

    $EFIBOOTMGR | awk -v find="$1" '
/^Boot[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]\*?/ { 
                                sub(/^Boot/,""); 
                                sub(/\*/,""); 
                                num=$1; 
                                $1=""; 
                                gsub(/^[ \t]+|[ \t]+$/,""); 
                                if ($0 == find) print num
                            }'
}
        
remove_bootmgr_entry () {
    local bootnum
    bootnum=$(find_bootmgr_entry "$1")
    [ -n "$bootnum" ] || return 0
    verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --quiet --delete-bootnum -b "$bootnum"
    echo -n "$bootnum"
}

add_bootmgr_entry () {
    local label="$1"
    local binary="$2"
    local args="$3"
    local bootnum
    bootnum=$(find_bootmgr_entry "$label")

    if [ "${binary#/}" = "${binary}" ] ; then
        # relative path
        binary="$DESTDIR/$binary"
    fi
    binary="${binary#/boot/efi}"
    binary="$(echo -nE "$binary"|sed -e's;/;\\;g')"

    if [ -n "$bootnum" ] ; then
        echo -n "$args" | verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --quiet \
                            --bootnum "$bootnum" --loader "$binary" -@ -
    else
        echo -n "$args" | verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --create \
                            --quiet --label "$label" --loader "$binary" -@ -
        bootnum="$(find_bootmgr_entry "$label")"
    fi
    echo -n "$bootnum"
}

safe_string () {
    echo -n "$*" | tr -c '[a-zA-Z0-9_]' '_'
}

ALLOW_AUTO="no"
FORCE_UPDATES="no"
MOUNT_EFI_PARTITION="no"
LABEL_PREFIX=""
VERBOSE="no"

[ -e /etc/efi-boot/update.conf ] && . /etc/efi-boot/update.conf

AUTO_RUN=no

while [ -n "$*" ] ; do
    local arg
    arg="$1"
    shift
    case $arg in
        --help|-h)
            usage
            exit 0
            ;;
        --version)
            echo "$_SCRIPT_NAME $_SCRIPT_VERSION"
            exit 0
            ;;
        --mount|-m)
            MOUNT_EFI_PARTITION=yes
            ;;
        --verbose|-v)
            VERBOSE=yes
            ;;
        --force)
            FORCE_UPDATES="yes"
            ;;
        --auto)
            is_yes "$ALLOW_AUTO" || exit 0
            AUTO_RUN=yes
            ;;
        *)
            usage >&2
            exit 2
            ;;
    esac
done

if ! mountpoint -q /boot/efi ; then
    mkdir -p /boot/efi
    if is_yes "$MOUNT_EFI_PARTITION" ; then
        # first try via fstab
        if ! mount /boot/efi 2>/dev/null ; then
            local efi_device
            efi_device="$(/sbin/blkid -o device -l -t PARTUUID="54f69bcc-954d-4f97-8fef-80b359f9e4aa")"
            if [ -z "$efi_device" ] ; then
                msg "EFI system partition not found."
                exit 1
            fi
            mount -t vfat "$efi_device" /boot/efi
        fi
    fi
    if ! mountpoint -q /boot/efi ; then
        msg "EFI system partition not mounted."
        exit 1
    fi
fi

if [ -x /usr/sbin/efibootmgr ] ; then
    modprobe -q efivars
    EFIBOOTMGR=/usr/sbin/efibootmgr
    if ! $EFIBOOTMGR >/dev/null 2>&1 ; then
        msg "efibootmgr does not work (efivars interface not available?)"
        msg "won't update boot manager configuration"
        EFIBOOTMGR=/bin/true
    else
        EFIBOOTMGR_OPTS="$(get_efibootmgr_opts)"
    fi
else
    msg "efibootmgr missing, won't update the boot manager configuration"
    EFIBOOTMGR=/bin/true
fi

for bootloader_conf in /etc/efi-boot/update.d/*.conf ; do
    if [ ! -e "$bootloader_conf" ] ; then
        continue
    fi
    ENABLED=yes
    CONFIG_NAME="$(basename "$bootloader_conf" .conf)"
    LABEL="$CONFIG_NAME"
    ARCH="$(uname -m)"
    BINARY=""
    ARGS=""
    install_files() {
        /bin/true
    }

    . "$bootloader_conf" || continue

    LABEL="$LABEL_PREFIX$LABEL"

    if ! is_yes "$ENABLED" ; then
        remove_bootmgr_entry "$LABEL" >/dev/null
        continue
    fi

    local efi_arch
    if [[ "$ARCH" = i?86 || "$ARCH" = pentium[45] || "$ARCH" = "athlon" ]] ; then
        # %ix86
        efi_arch=ia32
    elif [[ "$ARCH" = "x86_64" || "$ARCH" = "amd64" || "$ARCH" = "ia32e" ]] ; then
        # %x8664
        efi_arch=x64
    else
        efi_arch="$ARCH"
    fi
    DESTDIR="/boot/efi/EFI/$(echo -n "$PLATFORM_DIR"|sed -e's/@ARCH@/'"$efi_arch"'/')"
    mkdir -p "$DESTDIR"

    verbose "Updating $LABEL..."
    install_files
    if [ -n "$BINARY" ] ; then
            bootnum="$(add_bootmgr_entry "$LABEL" "$BINARY" "$ARGS")"
            eval "_$(safe_string ${CONFIG_NAME})_bootnum=\"$bootnum\""
    fi
done

if [ -n "$ORDER" -a "$EFIBOOTMGR" != "/bin/true" ] ; then
    # set up the configured boot order, not removing any existing entries
    tail="$($EFIBOOTMGR | awk '/^BootOrder:/ {gsub(/,/," ",$2); print $2}')"
    head=""
    for config_name in $ORDER ; do
        eval "bootnum=\$_$(safe_string ${config_name})_bootnum"
        if [ -z "$bootnum" ] ; then
            verbose "Cannot find '$config_name' config - won't add to boot order."
            continue
        fi
        tail="$(list_remove "$tail" "$bootnum")"
        head="$head $bootnum"
    done
    bootorder="$(echo -n $head $tail | sed -e's/ /,/g')"
    if [ -n "$bootorder" ] ; then
        verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --quiet --bootorder "$bootorder"
    fi
fi

if ! is_yes "$ALLOW_AUTO" && ! is_yes "$AUTO_RUN"; then
    msg "ALLOW_AUTO is not enabled in /etc/efi-boot/update.conf,"
    msg "files will not be automatically updated on upgrades."
fi

# vi: ft=sh sw=4 sts=4 et
Commit	Line	Data
7a63766a JK	1	#!/bin/sh
	2
	3	_SCRIPT_NAME=efi-boot-update
7d8cd73a	4	_SCRIPT_VERSION=0.1
7a63766a JK	5
	6	. /etc/rc.d/init.d/functions
	7
	8	usage () {
	9
	10	echo "Usage: $0 OPTIONS"
	11	echo "Update EFI boot loaders"
	12	echo
	13	echo " --version Show version number"
	14	echo " --help, -h This help message"
	15	echo " --mount, -m Try to mount /boot/efi first"
	16	echo " --verbose, -v Verbose output"
	17	echo " --force Force file updates"
fe76538b	18	echo " --auto Automatic run from packages %post"
7a63766a JK	19	}
	20
	21	msg () {
7a5c96c9	22	echo -E "efi-boot-update: $*" >&2
7a63766a JK	23	}
	24
	25	verbose () {
	26	if is_yes "$VERBOSE" ; then
7a5c96c9	27	echo -E "efi-boot-update: $*" >&2
7a63766a JK	28	fi
	29	}
	30
	31	verbose_cmd () {
	32	if is_yes "$VERBOSE" ; then
7a5c96c9	33	echo -E "+$*" >&2
7a63766a JK	34	fi
	35	"$@"
	36	}
	37
	38
	39	list_remove () {
	40
	41	for item in $1 ; do
	42	if [ "$item" = "$2" ] ; then
	43	continue
	44	fi
7a5c96c9	45	echo -nE "$item "
7a63766a JK	46	done
	47	}
	48
	49	update_file () {
	50	local cmd
	51	local src
	52	local dest
	53	while [ -n "$1" ] ; do
	54	case $1 in
	55	--missingok)
	56	shift
	57	[ -e "$1" ] \|\| return 0
	58	;;
	59	--*)
	60	msg "update_file: ignoring unknown option: $1"
	61	shift
	62	;;
	63	*)
	64	break
	65	;;
	66	esac
	67	done
	68	src="$1"; shift
560a4357	69	dst="$1"; shift
7a63766a JK	70	if [ -n "$*" ] ; then
	71	msg "update_file: unexpected arguments: $*"
	72	return 1
	73	fi
560a4357 JK	74	if [ -z "$src" ] ; then
	75	msg "update_file: no source file"
	76	return 1
	77	fi
	78	if [ -z "$dst" ] ; then
	79	dst=`basename "$src"`
	80	fi
7a63766a JK	81	if [ "${dst#/}" = "${dst}" ] ; then
	82	# relative path
	83	dst="$DESTDIR/$dst"
	84	fi
	85	if is_yes "$FORCE_UPDATES" ; then
	86	is_yes "$VERBOSE" && echo +cp --force --preserve=timestamps "$src" "$dst"
	87	cp --force --preserve=timestamps "$src" "$dst"
	88	else
	89	is_yes "$VERBOSE" && echo +cp --update --preserve=timestamps "$src" "$dst"
	90	cp --update --preserve=timestamps "$src" "$dst"
	91	fi
	92	}
	93
	94	get_efibootmgr_opts() {
	95	local efi_disk
	96	local efi_partnum
	97	efi_disk=$(mount \| awk '$3=="/boot/efi" {print $1}' 2>/dev/null)
	98	EFIBOOTMGR_OPTS="--gpt"
	99	if [ -n "$efi_disk" ] ; then
	100	efi_partnum="$(echo $efi_disk\|sed -e's;^.*[^0-9]\([0-9]\+\)$;\1;')"
	101	efi_disk="$(echo $efi_disk\|sed -e's;^\(.*\)[0-9]\+$;\1;')"
	102	if [ -b "$efi_disk" -a -n "$efi_partnum" ] ; then
	103	EFIBOOTMGR_OPTS="$EFIBOOTMGR_OPTS --disk $efi_disk"
	104	EFIBOOTMGR_OPTS="$EFIBOOTMGR_OPTS --part $efi_partnum"
	105	fi
	106	fi
	107	echo -n $EFIBOOTMGR_OPTS
	108	}
	109
	110	find_bootmgr_entry () {
	111
	112	$EFIBOOTMGR \| awk -v find="$1" '
	113	/^Boot[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]\*?/ {
	114	sub(/^Boot/,"");
	115	sub(/\*/,"");
	116	num=$1;
	117	$1="";
	118	gsub(/^[ \t]+\|[ \t]+$/,"");
	119	if ($0 == find) print num
	120	}'
	121	}
	122
	123	remove_bootmgr_entry () {
	124	local bootnum
	125	bootnum=$(find_bootmgr_entry "$1")
	126	[ -n "$bootnum" ] \|\| return 0
c1469194	127	verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --quiet --delete-bootnum -b "$bootnum"
7a63766a JK	128	echo -n "$bootnum"
	129	}
	130
	131	add_bootmgr_entry () {
6451bc22 JK	132	local label="$1"
	133	local binary="$2"
	134	local args="$3"
7a63766a JK	135	local bootnum
	136	bootnum=$(find_bootmgr_entry "$label")
	137
	138	if [ "${binary#/}" = "${binary}" ] ; then
	139	# relative path
	140	binary="$DESTDIR/$binary"
	141	fi
	142	binary="${binary#/boot/efi}"
7a5c96c9	143	binary="$(echo -nE "$binary"\|sed -e's;/;\\;g')"
7a63766a JK	144
	145	if [ -n "$bootnum" ] ; then
	146	echo -n "$args" \| verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --quiet \
	147	--bootnum "$bootnum" --loader "$binary" -@ -
	148	else
	149	echo -n "$args" \| verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --create \
	150	--quiet --label "$label" --loader "$binary" -@ -
	151	bootnum="$(find_bootmgr_entry "$label")"
	152	fi
	153	echo -n "$bootnum"
	154	}
	155
fff9d424 JK	156	safe_string () {
	157	echo -n "$*" \| tr -c '[a-zA-Z0-9_]' '_'
	158	}
	159
fe76538b	160	ALLOW_AUTO="no"
7a63766a JK	161	FORCE_UPDATES="no"
	162	MOUNT_EFI_PARTITION="no"
	163	LABEL_PREFIX=""
7a63766a JK	164	VERBOSE="no"
	165
	166	[ -e /etc/efi-boot/update.conf ] && . /etc/efi-boot/update.conf
	167
fe76538b JK	168	AUTO_RUN=no
fe76538b JK	169
7a63766a JK	170	while [ -n "$*" ] ; do
	171	local arg
	172	arg="$1"
	173	shift
	174	case $arg in
	175	--help\|-h)
	176	usage
	177	exit 0
	178	;;
	179	--version)
	180	echo "$_SCRIPT_NAME $_SCRIPT_VERSION"
	181	exit 0
	182	;;
	183	--mount\|-m)
	184	MOUNT_EFI_PARTITION=yes
	185	;;
	186	--verbose\|-v)
	187	VERBOSE=yes
	188	;;
	189	--force)
	190	FORCE_UPDATES="yes"
	191	;;
fe76538b JK	192	--auto)
	193	is_yes "$ALLOW_AUTO" \|\| exit 0
	194	AUTO_RUN=yes
	195	;;
7a63766a JK	196	*)
	197	usage >&2
	198	exit 2
	199	;;
	200	esac
	201	done
	202
	203	if ! mountpoint -q /boot/efi ; then
	204	mkdir -p /boot/efi
	205	if is_yes "$MOUNT_EFI_PARTITION" ; then
	206	# first try via fstab
	207	if ! mount /boot/efi 2>/dev/null ; then
	208	local efi_device
	209	efi_device="$(/sbin/blkid -o device -l -t PARTUUID="54f69bcc-954d-4f97-8fef-80b359f9e4aa")"
	210	if [ -z "$efi_device" ] ; then
	211	msg "EFI system partition not found."
	212	exit 1
	213	fi
	214	mount -t vfat "$efi_device" /boot/efi
	215	fi
	216	fi
	217	if ! mountpoint -q /boot/efi ; then
	218	msg "EFI system partition not mounted."
	219	exit 1
	220	fi
	221	fi
	222
	223	if [ -x /usr/sbin/efibootmgr ] ; then
	224	modprobe -q efivars
	225	EFIBOOTMGR=/usr/sbin/efibootmgr
	226	if ! $EFIBOOTMGR >/dev/null 2>&1 ; then
	227	msg "efibootmgr does not work (efivars interface not available?)"
	228	msg "won't update boot manager configuration"
	229	EFIBOOTMGR=/bin/true
	230	else
	231	EFIBOOTMGR_OPTS="$(get_efibootmgr_opts)"
	232	fi
	233	else
	234	msg "efibootmgr missing, won't update the boot manager configuration"
	235	EFIBOOTMGR=/bin/true
	236	fi
	237
7a63766a JK	238	for bootloader_conf in /etc/efi-boot/update.d/*.conf ; do
	239	if [ ! -e "$bootloader_conf" ] ; then
	240	continue
	241	fi
	242	ENABLED=yes
	243	CONFIG_NAME="$(basename "$bootloader_conf" .conf)"
	244	LABEL="$CONFIG_NAME"
	245	ARCH="$(uname -m)"
	246	BINARY=""
	247	ARGS=""
27eab27d JK	248	install_files() {
	249	/bin/true
	250	}
7a63766a JK	251
	252	. "$bootloader_conf" \|\| continue
	253
	254	LABEL="$LABEL_PREFIX$LABEL"
	255
	256	if ! is_yes "$ENABLED" ; then
07ca222f	257	remove_bootmgr_entry "$LABEL" >/dev/null
7a63766a JK	258	continue
	259	fi
	260
5b02c492 JK	261	local efi_arch
	262	if [[ "$ARCH" = i?86 \|\| "$ARCH" = pentium[45] \|\| "$ARCH" = "athlon" ]] ; then
	263	# %ix86
f8b86fe2	264	efi_arch=ia32
5b02c492 JK	265	elif [[ "$ARCH" = "x86_64" \|\| "$ARCH" = "amd64" \|\| "$ARCH" = "ia32e" ]] ; then
	266	# %x8664
	267	efi_arch=x64
	268	else
	269	efi_arch="$ARCH"
	270	fi
	271	DESTDIR="/boot/efi/EFI/$(echo -n "$PLATFORM_DIR"\|sed -e's/@ARCH@/'"$efi_arch"'/')"
7a63766a JK	272	mkdir -p "$DESTDIR"
	273
	274	verbose "Updating $LABEL..."
	275	install_files
	276	if [ -n "$BINARY" ] ; then
	277	bootnum="$(add_bootmgr_entry "$LABEL" "$BINARY" "$ARGS")"
fff9d424	278	eval "_$(safe_string ${CONFIG_NAME})_bootnum=\"$bootnum\""
7a63766a JK	279	fi
	280	done
	281
da8a0db5	282	if [ -n "$ORDER" -a "$EFIBOOTMGR" != "/bin/true" ] ; then
7a63766a	283	# set up the configured boot order, not removing any existing entries
da8a0db5	284	tail="$($EFIBOOTMGR \| awk '/^BootOrder:/ {gsub(/,/," ",$2); print $2}')"
7a63766a JK	285	head=""
7a63766a JK	286	for config_name in $ORDER ; do
fff9d424	287	eval "bootnum=\$_$(safe_string ${config_name})_bootnum"
7a63766a	288	if [ -z "$bootnum" ] ; then
fff9d424	289	verbose "Cannot find '$config_name' config - won't add to boot order."
7a63766a JK	290	continue
	291	fi
	292	tail="$(list_remove "$tail" "$bootnum")"
	293	head="$head $bootnum"
	294	done
	295	bootorder="$(echo -n $head $tail \| sed -e's/ /,/g')"
	296	if [ -n "$bootorder" ] ; then
	297	verbose_cmd $EFIBOOTMGR $EFIBOOTMGR_OPTS --quiet --bootorder "$bootorder"
	298	fi
	299	fi
	300
fe76538b JK	301	if ! is_yes "$ALLOW_AUTO" && ! is_yes "$AUTO_RUN"; then
	302	msg "ALLOW_AUTO is not enabled in /etc/efi-boot/update.conf,"
	303	msg "files will not be automatically updated on upgrades."
	304	fi
	305
7a63766a	306	# vi: ft=sh sw=4 sts=4 et