6 # Installs/updates the necessary boot blocks for the desired boot environment
8 # Lightly tested.. Intended to be installed, but until it matures, it will just
9 # be a boot tool for regression testing.
11 # insert code here to guess what you have -- yikes!
13 # Minimum size of FAT filesystems, in KB.
31 gpart show $dev | tail +2 | awk '$4 == "'$part'" { print $3; }'
36 case ${TARGET:-$(uname -m)} in
37 amd64) echo bootx64 ;;
38 arm64) echo bootaa64 ;;
39 i386) echo bootia32 ;;
41 *) die "machine type $(uname -m) doesn't support UEFI" ;;
46 local file sizekb loader device stagedir fatbits efibootname
52 if [ "$sizekb" -ge "$fat32min" ]; then
54 elif [ "$sizekb" -ge "$fat16min" ]; then
60 stagedir=$(mktemp -d /tmp/stand-test.XXXXXX)
61 mkdir -p "${stagedir}/EFI/BOOT"
62 efibootname=$(get_uefi_bootname)
63 cp "${loader}" "${stagedir}/EFI/BOOT/${efibootname}.efi"
65 -o fat_type=${fatbits} \
66 -o sectors_per_cluster=1 \
67 -o volume_label=EFISYS \
69 "${file}" "${stagedir}"
74 local dev file mntpt fstype efibootname kbfree loadersize efibootfile
75 local isboot1 existingbootentryloaderfile bootorder bootentry
81 mntpt=$(mktemp -d /tmp/stand-test.XXXXXX)
83 # See if we're using an existing (formatted) ESP
84 fstype=$(fstyp "${dev}")
86 if [ "${fstype}" != "msdosfs" ]; then
87 newfs_msdos -F 32 -c 1 -L EFISYS "${dev}" > /dev/null 2>&1
90 mount -t msdosfs "${dev}" "${mntpt}"
92 die "Failed to mount ${dev} as an msdosfs filesystem"
95 echo "Mounted ESP ${dev} on ${mntpt}"
97 efibootname=$(get_uefi_bootname)
98 kbfree=$(df -k "${mntpt}" | tail -1 | cut -w -f 4)
99 loadersize=$(stat -f %z "${file}")
100 loadersize=$((loadersize / 1024))
102 # Check if /EFI/BOOT/BOOTxx.EFI is the FreeBSD boot1.efi
103 # If it is, remove it to avoid leaving stale files around
104 efibootfile="${mntpt}/EFI/BOOT/${efibootname}.efi"
105 if [ -f "${efibootfile}" ]; then
106 isboot1=$(strings "${efibootfile}" | grep "FreeBSD EFI boot block")
108 if [ -n "${isboot1}" ] && [ "$kbfree" -lt "${loadersize}" ]; then
109 echo "Only ${kbfree}KB space remaining: removing old FreeBSD boot1.efi file /EFI/BOOT/${efibootname}.efi"
111 rmdir "${mntpt}/EFI/BOOT"
113 echo "${kbfree}KB space remaining on ESP: renaming old boot1.efi file /EFI/BOOT/${efibootname}.efi /EFI/BOOT/${efibootname}-old.efi"
114 mv "${efibootfile}" "${mntpt}/EFI/BOOT/${efibootname}-old.efi"
118 if [ ! -f "${mntpt}/EFI/freebsd/loader.efi" ] && [ "$kbfree" -lt "$loadersize" ]; then
121 echo "Failed to update the EFI System Partition ${dev}"
122 echo "Insufficient space remaining for ${file}"
123 echo "Run e.g \"mount -t msdosfs ${dev} /mnt\" to inspect it for files that can be removed."
127 mkdir -p "${mntpt}/EFI/freebsd"
129 # Keep a copy of the existing loader.efi in case there's a problem with the new one
130 if [ -f "${mntpt}/EFI/freebsd/loader.efi" ] && [ "$kbfree" -gt "$((loadersize * 2))" ]; then
131 cp "${mntpt}/EFI/freebsd/loader.efi" "${mntpt}/EFI/freebsd/loader-old.efi"
134 echo "Copying loader to /EFI/freebsd on ESP"
135 cp "${file}" "${mntpt}/EFI/freebsd/loader.efi"
137 if [ -n "${updatesystem}" ]; then
138 existingbootentryloaderfile=$(efibootmgr -v | grep "${mntpt}//EFI/freebsd/loader.efi")
140 if [ -z "$existingbootentryloaderfile" ]; then
141 # Try again without the double forward-slash in the path
142 existingbootentryloaderfile=$(efibootmgr -v | grep "${mntpt}/EFI/freebsd/loader.efi")
145 if [ -z "$existingbootentryloaderfile" ]; then
146 echo "Creating UEFI boot entry for FreeBSD"
147 efibootmgr --create --label FreeBSD --loader "${mntpt}/EFI/freebsd/loader.efi" > /dev/null
148 if [ $? -ne 0 ]; then
149 die "Failed to create new boot entry"
152 # When creating new entries, efibootmgr doesn't mark them active, so we need to
153 # do so. It doesn't make it easy to find which entry it just added, so rely on
154 # the fact that it places the new entry first in BootOrder.
155 bootorder=$(efivar --name 8be4df61-93ca-11d2-aa0d-00e098032b8c-BootOrder --print --no-name --hex | head -1)
156 bootentry=$(echo "${bootorder}" | cut -w -f 3)$(echo "${bootorder}" | cut -w -f 2)
157 echo "Marking UEFI boot entry ${bootentry} active"
158 efibootmgr --activate "${bootentry}" > /dev/null
160 echo "Existing UEFI FreeBSD boot entry found: not creating a new one"
163 # Configure for booting from removable media
164 if [ ! -d "${mntpt}/EFI/BOOT" ]; then
165 mkdir -p "${mntpt}/EFI/BOOT"
167 cp "${file}" "${mntpt}/EFI/BOOT/${efibootname}.efi"
172 echo "Finished updating ESP"
176 local file loaderfile
181 if [ -f "$file" ]; then
182 make_esp_file ${file} ${fat32min} ${loaderfile}
184 make_esp_device ${file} ${loaderfile}
192 s=$(find-part $dev "!239")
193 if [ -z "$s" ] ; then
194 s=$(find-part $dev "efi")
195 if [ -z "$s" ] ; then
196 die "No ESP slice found"
199 make_esp /dev/${dev}s${s} ${dst}/boot/loader.efi
206 idx=$(find-part $dev "efi")
207 if [ -z "$idx" ] ; then
208 die "No ESP partition found"
210 make_esp /dev/${dev}p${idx} ${dst}/boot/loader.efi
213 boot_nogeli_gpt_ufs_legacy() {
217 idx=$(find-part $dev "freebsd-boot")
218 if [ -z "$idx" ] ; then
219 die "No freebsd-boot partition found"
221 doit gpart bootcode -b ${gpt0} -p ${gpt2} -i $idx $dev
224 boot_nogeli_gpt_ufs_uefi() {
228 boot_nogeli_gpt_ufs_both() {
229 boot_nogeli_gpt_ufs_legacy $1 $2 $3
230 boot_nogeli_gpt_ufs_uefi $1 $2 $3
233 boot_nogeli_gpt_zfs_legacy() {
237 idx=$(find-part $dev "freebsd-boot")
238 if [ -z "$idx" ] ; then
239 die "No freebsd-boot partition found"
241 doit gpart bootcode -b ${gpt0} -p ${gptzfs2} -i $idx $dev
244 boot_nogeli_gpt_zfs_uefi() {
248 boot_nogeli_gpt_zfs_both() {
249 boot_nogeli_gpt_zfs_legacy $1 $2 $3
250 boot_nogeli_gpt_zfs_uefi $1 $2 $3
253 boot_nogeli_mbr_ufs_legacy() {
257 doit gpart bootcode -b ${mbr0} ${dev}
258 s=$(find-part $dev "freebsd")
259 if [ -z "$s" ] ; then
260 die "No freebsd slice found"
262 doit gpart bootcode -p ${mbr2} ${dev}s${s}
265 boot_nogeli_mbr_ufs_uefi() {
269 boot_nogeli_mbr_ufs_both() {
270 boot_nogeli_mbr_ufs_legacy $1 $2 $3
271 boot_nogeli_mbr_ufs_uefi $1 $2 $3
274 boot_nogeli_mbr_zfs_legacy() {
278 # search to find the BSD slice
279 s=$(find-part $dev "freebsd")
280 if [ -z "$s" ] ; then
281 die "No BSD slice found"
283 idx=$(find-part ${dev}s${s} "freebsd-zfs")
284 if [ -z "$idx" ] ; then
285 die "No freebsd-zfs slice found"
287 # search to find the freebsd-zfs partition within the slice
288 # Or just assume it is 'a' because it has to be since it fails otherwise
289 doit gpart bootcode -b ${dst}/boot/mbr ${dev}
290 dd if=${dst}/boot/zfsboot of=/tmp/zfsboot1 count=1
291 doit gpart bootcode -b /tmp/zfsboot1 ${dev}s${s} # Put boot1 into the start of part
292 sysctl kern.geom.debugflags=0x10 # Put boot2 into ZFS boot slot
293 doit dd if=${dst}/boot/zfsboot of=/dev/${dev}s${s}a skip=1 seek=1024
294 sysctl kern.geom.debugflags=0x0
297 boot_nogeli_mbr_zfs_uefi() {
301 boot_nogeli_mbr_zfs_both() {
302 boot_nogeli_mbr_zfs_legacy $1 $2 $3
303 boot_nogeli_mbr_zfs_uefi $1 $2 $3
306 boot_geli_gpt_ufs_legacy() {
307 boot_nogeli_gpt_ufs_legacy $1 $2 $3
310 boot_geli_gpt_ufs_uefi() {
311 boot_nogeli_gpt_ufs_uefi $1 $2 $3
314 boot_geli_gpt_ufs_both() {
315 boot_nogeli_gpt_ufs_both $1 $2 $3
318 boot_geli_gpt_zfs_legacy() {
319 boot_nogeli_gpt_zfs_legacy $1 $2 $3
322 boot_geli_gpt_zfs_uefi() {
323 boot_nogeli_gpt_zfs_uefi $1 $2 $3
326 boot_geli_gpt_zfs_both() {
327 boot_nogeli_gpt_zfs_both $1 $2 $3
330 # GELI+MBR is not a valid configuration
331 boot_geli_mbr_ufs_legacy() {
335 boot_geli_mbr_ufs_uefi() {
339 boot_geli_mbr_ufs_both() {
343 boot_geli_mbr_zfs_legacy() {
347 boot_geli_mbr_zfs_uefi() {
351 boot_geli_mbr_zfs_both() {
355 boot_nogeli_vtoc8_ufs_ofw() {
359 # For non-native builds, ensure that geom_part(4) supports VTOC8.
360 kldload geom_part_vtoc8.ko
361 doit gpart bootcode -p ${vtoc8} ${dev}
365 printf 'Usage: %s -b bios [-d destdir] -f fs [-g geli] [-h] [-o optargs] -s scheme <bootdev>\n' "$0"
367 printf ' bootdev device to install the boot code on\n'
368 printf ' -b bios bios type: legacy, uefi or both\n'
369 printf ' -d destdir destination filesystem root\n'
370 printf ' -f fs filesystem type: ufs or zfs\n'
371 printf ' -g geli yes or no\n'
372 printf ' -h this help/usage text\n'
373 printf ' -u Run commands such as efibootmgr to update the\n'
374 printf ' currently running system\n'
375 printf ' -o optargs optional arguments\n'
376 printf ' -s scheme mbr or gpt\n'
382 # Note: we really don't support geli boot in this script yet.
385 while getopts "b:d:f:g:ho:s:u" opt; do
398 [Yy][Ee][Ss]|geli) geli=geli ;;
418 if [ -n "${scheme}" ] && [ -n "${fs}" ] && [ -n "${bios}" ]; then
423 # For gpt, we need to install pmbr as the primary boot loader
425 gpt0=${srcroot}/boot/pmbr
426 gpt2=${srcroot}/boot/gptboot
427 gptzfs2=${srcroot}/boot/gptzfsboot
429 # For MBR, we have lots of choices, but select mbr, boot0 has issues with UEFI
430 mbr0=${srcroot}/boot/mbr
431 mbr2=${srcroot}/boot/boot
434 vtoc8=${srcroot}/boot/boot1
438 # Check if we've been given arguments. If not, this script is probably being
439 # sourced, so we shouldn't run anything.
440 if [ -n "${dev}" ]; then
441 eval boot_${geli}_${scheme}_${fs}_${bios} $dev $srcroot $opts || echo "Unsupported boot env: ${geli}-${scheme}-${fs}-${bios}"