[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 "efi-boot-update: $*" >&2
}

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

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


list_remove () {

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