Differential D17947 Diff 52044 tools/boot/install-boot.sh

Changeset View

Standalone View

tools/boot/install-boot.sh

#!/bin/sh		#!/bin/sh

# $FreeBSD$		# $FreeBSD$

#		#
# Installs/updates the necessary boot blocks for the desired boot environment		# Installs/updates the necessary boot blocks for the desired boot environment
#		#
# Lightly tested.. Intended to be installed, but until it matures, it will just		# Lightly tested.. Intended to be installed, but until it matures, it will just
# be a boot tool for regression testing.		# be a boot tool for regression testing.

# insert code here to guess what you have -- yikes!		# insert code here to guess what you have -- yikes!

		# Minimum size of FAT filesystems, in KB.
		impUnsubmitted Done Inline Actions Add a comment that says what units these are in? imp: Add a comment that says what units these are in?
		fat32min=33292
		fat16min=2100

die() {		die() {
echo $*		echo $*
exit 1		exit 1
}		}

doit() {		doit() {
echo $*		echo $*
eval $*		eval $*
}		}

find-part() {		find-part() {
dev=$1		dev=$1
part=$2		part=$2

gpart show $dev \| tail +2 \| awk '$4 == "'$part'" { print $3; }'		gpart show $dev \| tail +2 \| awk '$4 == "'$part'" { print $3; }'
}		}

make_esp() {		get_uefi_bootname() {
local dev dst mntpt

		case ${TARGET:-$(uname -m)} in
		amd64) echo bootx64.efi ;;
		arm64) echo bootaa64.efi ;;
		i386) echo bootia32.efi ;;
		arm) echo bootarm.efi ;;
		*) die "machine type $(uname -m) doesn't support UEFI" ;;
		impUnsubmitted Done Inline Actions don't know if we have a 'panic' routine :) imp: don't know if we have a 'panic' routine :)
		bcranAuthorUnsubmitted Done Inline Actions No, but we do have `die` bcran: No, but we do have `die`
		esac
		}

		make_esp_file() {
		local file sizekb loader device mntpt fatbits efibootname

		file=$1
		sizekb=$2
		loader=$3

		if [ $sizekb -ge $fat32min ]; then
		impUnsubmitted Done Inline Actions I'd be tempted to create constants for these magic numbers. Then the user of this file can also use them to prevent their proliferation. imp: I'd be tempted to create constants for these magic numbers. Then the user of this file can also…
		fatbits=32
		impUnsubmitted Done Inline Actions This is better expressed as follows get_uefi_bootname() { case ${TARGET:-$(uname -m)} amd64) echo bootx64.efi ;; arm64) echo bootaa64.efi ;; i386) echo bootia32.efi ;; arm) echo bootarm.efi ;; ) panic bogus ;; esac } generally shell scripts echo things rather than set global variables. Also, using the alternative value variable substitution lets you omit the repetition. imp:* This is better expressed as follows get_uefi_bootname() { case ${TARGET:-$(uname -m)} amd64)…
		jillesUnsubmitted Done Inline Actions Such an approach looks beautiful but may have performance and correctness implications since it runs the function in a subshell environment. I think setting variables (either named via a parameter or with a hard-coded name) is a perfectly acceptable approach. jilles: Such an approach looks beautiful but may have performance and correctness implications since it…
		impUnsubmitted Done Inline Actions This function is called once, and in the context my suggestions are fine. They won't cause any sort of regression in performance, and it's more likely to be correct (though I didn't change the { to ( to enforce the new sub-shell out of a desire to be efficient). imp: This function is called once, and in the context my suggestions are fine. They won't cause any…
		elif [ $sizekb -ge $fat16min ]; then
		fatbits=16
		else
		fatbits=12
		fi

		impUnsubmitted Done Inline Actions I'd add efibootfile here too, since it's just used in this function. imp: I'd add efibootfile here too, since it's just used in this function.
		dd if=/dev/zero of=${file} bs=1k count=${sizekb}
		device=$(mdconfig -a -t vnode -f ${file})
		newfs_msdos -F ${fatbits} -c 1 -L EFISYS /dev/${device}
		mntpt=$(mktemp -d /tmp/stand-test.XXXXXX)
		mount -t msdosfs /dev/${device} ${mntpt}
		mkdir -p ${mntpt}/EFI/BOOT
		efibootname=$(get_uefi_bootname)
		cp "${loader}" ${mntpt}/EFI/BOOT/${efibootname}
		umount ${mntpt}
		rmdir ${mntpt}
		mdconfig -d -u ${device}
		}

		make_esp_device() {
		local dev file mntpt fstype efibootname kbfree loadersize efibootfile
		local isboot1 existingbootentryloaderfile bootorder bootentry

		# ESP device node
dev=$1		dev=$1
dst=$2		file=$2
		impUnsubmitted Done Inline Actions efibootname=$(get_uefi_bootname) per above imp: efibootname=$(get_uefi_bootname) per above

newfs_msdos -a 32 ${dev}
mntpt=$(mktemp -d /tmp/stand-test.XXXXXX)		mntpt=$(mktemp -d /tmp/stand-test.XXXXXX)
mount -t msdos ${dev} ${mntpt}
mkdir -p ${mntpt}/efi/boot		# See if we're using an existing (formatted) ESP
cp ${dst}/boot/loader.efi ${mntpt}/efi/boot/bootx64.efi		fstype=$(fstyp ${dev})

		if [ $? -ne 0 ]; then
		die "fstyp ${dev} failed"
		fi

		if [ "${fstype}" != "msdosfs" ]; then
		newfs_msdos -F 32 -c 1 -L EFISYS ${dev}
		mount -t msdosfs ${dev} ${mntpt}
		fi

		mount -t msdosfs ${dev} ${mntpt}
		if [ $? -ne 0 ]; then
		die "Failed to mount ${dev} as an msdosfs filesystem"
		fi

		echo "Mounted ESP ${dev} on ${mntpt}"

		efibootname=$(get_uefi_bootname)
		kbfree=$(df -k ${mntpt} \| tail -1 \| cut -w -f 4)
		loadersize=$(stat -f %z ${file})
		loadersize=$(expr $loadersize / 1024)

		# Check if /EFI/BOOT/BOOTxx.EFI is the FreeBSD boot1.efi
		# If it is, remove it to avoid leaving stale files around
		efibootfile=${mntpt}/EFI/BOOT/${efibootname}
		if [ -f ${efibootfile} ]; then
		isboot1=$(strings ${efibootfile} \| grep "FreeBSD EFI boot block")

		if [ "${isboot1}" != "" ]; then
		echo "Removing old FreeBSD boot1.efi file ${efibootfile}"
		rm ${efibootfile}
		rmdir ${mntpt}/EFI/BOOT
		fi
		fi

		if [ $kbfree -lt $loadersize ]; then
umount ${mntpt}		umount ${mntpt}
rmdir ${mntpt}		rmdir ${mntpt}
		echo "Failed to update the EFI System Partition ${dev}"
		echo "Insufficient space remaining for ${file}"
		echo -n "Run e.g \"mount -t msdosfs ${dev} /mnt\" to inspect it for "
		echo "files that can be removed"
		die
		fi

		mkdir -p ${mntpt}/EFI/freebsd
		echo "Copying loader to /EFI/freebsd on ESP"
		cp ${file} ${mntpt}/EFI/freebsd/loader.efi
		if [ $? -ne 0 ]; then
		die "Failed to copy ${file}"
		fi

		existingbootentryloaderfile=$(efibootmgr -v \| grep "${mntpt}//EFI/freebsd/loader.efi")

		if [ "$existingbootentryloaderfile" == "" ]; then
		# Try again without the double forward-slash in the path
		existingbootentryloaderfile=$(efibootmgr -v \| grep "${mntpt}/EFI/freebsd/loader.efi")
		fi

		if [ "$existingbootentryloaderfile" == "" ]; then
		echo "Creating UEFI boot entry for FreeBSD"
		efibootmgr --create --label FreeBSD --loader ${mntpt}/EFI/freebsd/loader.efi > /dev/null
		if [ $? -ne 0 ]; then
		die "Failed to create new boot entry"
		fi

		bootorder=$(efivar --name 8be4df61-93ca-11d2-aa0d-00e098032b8c-BootOrder --print --no-name --hex)
		if [ "$bootorder" != "" ]; then
		bootentry=$(echo ${bootorder} \| cut -w -f 3)$(echo ${bootorder} \| cut -w -f 2)
		echo "Marking UEFI boot entry ${bootentry} active"
		efibootmgr --activate ${bootentry} > /dev/null
		if [ $? -ne 0 ]; then
		die "Failed to activate new boot entry"
		fi
		fi
		else
		echo "Existing UEFI FreeBSD boot entry found: not creating a new one"
		fi

		umount ${mntpt}
		rmdir ${mntpt}
		echo "Finished updating ESP"
}		}

		impUnsubmitted Done Inline Actions Are these two locals? I'd add them to the local list if so. I don't see where else they are used. imp: Are these two locals? I'd add them to the local list if so. I don't see where else they are…
		make_esp() {
		local file loaderfile

		file=$1
		loaderfile=$2

		if [ -f $file ]; then
		make_esp_file ${file} ${fat32min} ${loaderfile}
		else
		make_esp_device ${file} ${loaderfile}
		fi
		}

make_esp_mbr() {		make_esp_mbr() {
dev=$1		dev=$1
dst=$2		dst=$2

s=$(find-part $dev "!239")		s=$(find-part $dev "!239")
if [ -z "$s" ] ; then		if [ -z "$s" ] ; then
s=$(find-part $dev "efi")		s=$(find-part $dev "efi")
if [ -z "$s" ] ; then		if [ -z "$s" ] ; then
die "No ESP slice found"		die "No ESP slice found"
fi		fi
fi		fi
make_esp /dev/${dev}s${s} ${dst}		make_esp /dev/${dev}s${s} ${dst}/boot/loader.efi
		impUnsubmitted Done Inline Actions I would be tempted to go a slightly more conservative route of renaming it instead. That would allow someone to recover back to this if they have a bad new loader. imp: I would be tempted to go a slightly more conservative route of renaming it instead. That would…
		bcranAuthorUnsubmitted Done Inline Actions The problem is that many systems will o my have 800KB available on the ESP. So in those situations it’s not possible to have more than one copy. bcran: The problem is that many systems will o my have 800KB available on the ESP. So in those…
}		}

make_esp_gpt() {		make_esp_gpt() {
dev=$1		dev=$1
dst=$2		dst=$2

idx=$(find-part $dev "efi")		idx=$(find-part $dev "efi")
if [ -z "$idx" ] ; then		if [ -z "$idx" ] ; then
die "No ESP partition found"		die "No ESP partition found"
fi		fi
make_esp /dev/${dev}p${idx} ${dst}		make_esp /dev/${dev}p${idx} ${dst}/boot/loader.efi
}		}

boot_nogeli_gpt_ufs_legacy() {		boot_nogeli_gpt_ufs_legacy() {
dev=$1		dev=$1
dst=$2		dst=$2

idx=$(find-part $dev "freebsd-boot")		idx=$(find-part $dev "freebsd-boot")
if [ -z "$idx" ] ; then		if [ -z "$idx" ] ; then
die "No freebsd-boot partition found"		die "No freebsd-boot partition found"
fi		fi
doit gpart bootcode -b ${gpt0} -p ${gpt2} -i $idx $dev		doit gpart bootcode -b ${gpt0} -p ${gpt2} -i $idx $dev
}		}

boot_nogeli_gpt_ufs_uefi() {		boot_nogeli_gpt_ufs_uefi() {
make_esp_gpt $1 $2		make_esp_gpt $1 $2
}		}

boot_nogeli_gpt_ufs_both() {		boot_nogeli_gpt_ufs_both() {
boot_nogeli_gpt_ufs_legacy $1 $2 $3		boot_nogeli_gpt_ufs_legacy $1 $2 $3
boot_nogeli_gpt_ufs_uefi $1 $2 $3		boot_nogeli_gpt_ufs_uefi $1 $2 $3
}		}

		impUnsubmitted Done Inline Actions This looks weird... What are you trying to accomplish? imp: This looks weird... What are you trying to accomplish?
		bcranAuthorUnsubmitted Done Inline Actions Oh that needs a comment. efibootmgr doesn’t mark new entries active, so this code figures out what number it is and runs the command to activate it. bcran: Oh that needs a comment. efibootmgr doesn’t mark new entries active, so this code figures out…
		bcranAuthorUnsubmitted Done Inline Actions I'm trying to see if there's an existing boot entry - filtering out other OSes that use different paths to their loader. If there is, we don't need to create a new one. bcran: I'm trying to see if there's an existing boot entry - filtering out other OSes that use…
boot_nogeli_gpt_zfs_legacy() {		boot_nogeli_gpt_zfs_legacy() {
dev=$1		dev=$1
dst=$2		dst=$2

idx=$(find-part $dev "freebsd-boot")		idx=$(find-part $dev "freebsd-boot")
if [ -z "$idx" ] ; then		if [ -z "$idx" ] ; then
die "No freebsd-boot partition found"		die "No freebsd-boot partition found"
fi		fi
▲ Show 20 Lines • Show All 115 Lines • ▼ Show 20 Lines	boot_nogeli_vtoc8_ufs_ofw() {
dev=$1		dev=$1
dst=$2		dst=$2

# For non-native builds, ensure that geom_part(4) supports VTOC8.		# For non-native builds, ensure that geom_part(4) supports VTOC8.
kldload geom_part_vtoc8.ko		kldload geom_part_vtoc8.ko
doit gpart bootcode -p ${vtoc8} ${dev}		doit gpart bootcode -p ${vtoc8} ${dev}
}		}

DESTDIR=/		usage() {
		printf 'Usage: %s -b bios [-d destdir] -f fs [-g geli] [-h] [-o optargs] -s scheme <bootdev>\n' $0
		printf 'Options:\n'
		printf ' bootdev device to install the boot code on\n'
		printf ' -b bios bios type: legacy, uefi or both\n'
		printf ' -d destdir destination filesystem root\n'
		printf ' -f fs filesystem type: ufs or zfs\n'
		printf ' -g geli yes or no\n'
		printf ' -h this help/usage text\n'
		printf ' -o optargs optional arguments\n'
		printf ' -s scheme mbr or gpt\n'
		exit 0
		}

		srcroot=/

# Note: we really don't support geli boot in this script yet.		# Note: we really don't support geli boot in this script yet.
geli=nogeli		geli=nogeli

while getopts "b:d:f:g:o:s:" opt; do		while getopts "b:d:f:g:ho:s:" opt; do
case "$opt" in		case "$opt" in
b)		b)
bios=${OPTARG}		bios=${OPTARG}
;;		;;
d)		d)
DESTDIR=${OPTARG}		srcroot=${OPTARG}
		impUnsubmitted Done Inline Actions This doesn't look right at all. srcroot seems to be /usr/src, while DESTDIR is where we install into... Is that intentional? If so, that seems like a poorly named variable. imp: This doesn't look right at all. srcroot seems to be /usr/src, while DESTDIR is where we install…
		bcranAuthorUnsubmitted Done Inline Actions Here, srcroot is where we’re copying files from, to install onto the ESP. bcran: Here, srcroot is where we’re copying files from, to install onto the ESP.
;;		;;
f)		f)
fs=${OPTARG}		fs=${OPTARG}
;;		;;
g)		g)
case ${OPTARG} in		case ${OPTARG} in
[Yy][Ee][Ss]\|geli) geli=geli ;;		[Yy][Ee][Ss]\|geli) geli=geli ;;
*) geli=nogeli ;;		*) geli=nogeli ;;
esac		esac
;;		;;
o)		o)
		impUnsubmitted Done Inline Actions I'd also match ? here. getopts returns ? when there's no args in the getopt list that match. imp: I'd also match ? here. getopts returns ? when there's no args in the getopt list that match.
opts=${OPTARG}		opts=${OPTARG}
;;		;;
s)		s)
scheme=${OPTARG}		scheme=${OPTARG}
;;		;;

		?\|h)
		usage
		;;
esac		esac
done		done

		if [ "${scheme}" != "" -a "${fs}" != "" -a "${bios}" != "" ]; then
shift $((OPTIND-1))		shift $((OPTIND-1))
dev=$1		dev=$1
		fi

# For gpt, we need to install pmbr as the primary boot loader		# For gpt, we need to install pmbr as the primary boot loader
# it knows about		# it knows about
gpt0=${DESTDIR}/boot/pmbr		gpt0=${srcroot}/boot/pmbr
gpt2=${DESTDIR}/boot/gptboot		gpt2=${srcroot}/boot/gptboot
gptzfs2=${DESTDIR}/boot/gptzfsboot		gptzfs2=${srcroot}/boot/gptzfsboot

# For MBR, we have lots of choices, but select mbr, boot0 has issues with UEFI		# For MBR, we have lots of choices, but select mbr, boot0 has issues with UEFI
mbr0=${DESTDIR}/boot/mbr		mbr0=${srcroot}/boot/mbr
mbr2=${DESTDIR}/boot/boot		mbr2=${srcroot}/boot/boot

# VTOC8		# VTOC8
vtoc8=${DESTDIR}/boot/boot1		vtoc8=${srcroot}/boot/boot1

# sanity check here		# sanity check here

eval boot_${geli}_${scheme}_${fs}_${bios} $dev $DESTDIR $opts \|\| echo "Unsupported boot env: ${geli}-${scheme}-${fs}-${bios}"		# Check if we've been given arguments. If not, this script is probably being
		# sourced, so we shouldn't run anything.
		if [ "${dev}" != "" ]; then
		eval boot_${geli}_${scheme}_${fs}_${bios} $dev $srcroot $opts \|\| echo "Unsupported boot env: ${geli}-${scheme}-${fs}-${bios}"
		fi