1#!/bin/sh 2# 3# 4# 5# Common functions for virtual machine image build scripts. 6# 7 8scriptdir=$(dirname $(realpath $0)) 9. ${scriptdir}/../scripts/tools.subr 10. ${scriptdir}/../../tools/boot/install-boot.sh 11 12export PATH="/bin:/usr/bin:/sbin:/usr/sbin:/usr/local/bin:/usr/local/sbin" 13trap "cleanup" INT QUIT TRAP ABRT TERM 14 15# Platform-specific large-scale setup 16# Most platforms use GPT, so put that as default, then special cases 17PARTSCHEME=gpt 18ROOTLABEL="gpt" 19case "${TARGET}:${TARGET_ARCH}" in 20 powerpc:powerpc*) 21 PARTSCHEME=mbr 22 ROOTLABEL="ufs" 23 NOSWAP=yes # Can't label swap partition with MBR, so no swap 24 ;; 25esac 26 27err() { 28 printf "${@}\n" 29 cleanup 30 return 1 31} 32 33cleanup() { 34 if [ -c "${DESTDIR}/dev/null" ]; then 35 umount_loop ${DESTDIR}/dev 2>/dev/null 36 fi 37 38 return 0 39} 40 41metalog_add_data() { 42 if [ -n "${NO_ROOT}" ]; then 43 echo "$1 type=file uname=root gname=wheel mode=0644" >> \ 44 ${DESTDIR}/METALOG 45 fi 46} 47 48vm_create_base() { 49 50 mkdir -p ${DESTDIR} 51 52 return 0 53} 54 55vm_copy_base() { 56 # Defunct 57 return 0 58} 59 60vm_install_base() { 61 # Installs the FreeBSD userland/kernel to the virtual machine disk. 62 63 cd ${WORLDDIR} && \ 64 make DESTDIR=${DESTDIR} ${INSTALLOPTS} \ 65 installworld installkernel distribution || \ 66 err "\n\nCannot install the base system to ${DESTDIR}." 67 68 # Bootstrap etcupdate(8) database. 69 mkdir -p ${DESTDIR}/var/db/etcupdate 70 etcupdate extract -B \ 71 -M "TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}" \ 72 -s ${WORLDDIR} -d ${DESTDIR}/var/db/etcupdate \ 73 -L /dev/stdout ${NO_ROOT:+-N} 74 if [ -n "${NO_ROOT}" ]; then 75 # Reroot etcupdate's internal METALOG to the whole tree 76 sed -n 's,^\.,./var/db/etcupdate/current,p' \ 77 ${DESTDIR}/var/db/etcupdate/current/METALOG | \ 78 env -i LC_COLLATE=C sort >> ${DESTDIR}/METALOG 79 rm ${DESTDIR}/var/db/etcupdate/current/METALOG 80 fi 81 82 echo '# Custom /etc/fstab for FreeBSD VM images' \ 83 > ${DESTDIR}/etc/fstab 84 if [ "${VMFS}" != zfs ]; then 85 echo "/dev/${ROOTLABEL}/rootfs / ${VMFS} rw 1 1" \ 86 >> ${DESTDIR}/etc/fstab 87 fi 88 if [ -z "${NOSWAP}" ]; then 89 echo '/dev/gpt/swapfs none swap sw 0 0' \ 90 >> ${DESTDIR}/etc/fstab 91 fi 92 metalog_add_data ./etc/fstab 93 94 local hostname 95 hostname="$(echo $(uname -o) | tr '[:upper:]' '[:lower:]')" 96 echo "hostname=\"${hostname}\"" >> ${DESTDIR}/etc/rc.conf 97 metalog_add_data ./etc/rc.conf 98 if [ "${VMFS}" = zfs ]; then 99 echo "zfs_enable=\"YES\"" >> ${DESTDIR}/etc/rc.conf 100 echo "zpool_reguid=\"zroot\"" >> ${DESTDIR}/etc/rc.conf 101 echo "zpool_upgrade=\"zroot\"" >> ${DESTDIR}/etc/rc.conf 102 echo "kern.geom.label.disk_ident.enable=0" >> ${DESTDIR}/boot/loader.conf 103 echo "zfs_load=YES" >> ${DESTDIR}/boot/loader.conf 104 metalog_add_data ./boot/loader.conf 105 fi 106 107 return 0 108} 109 110vm_emulation_setup() { 111 if [ -n "${WITHOUT_QEMU}" ]; then 112 return 0 113 fi 114 if [ -n "${QEMUSTATIC}" ]; then 115 export EMULATOR=/qemu 116 cp ${QEMUSTATIC} ${DESTDIR}/${EMULATOR} 117 fi 118 119 mkdir -p ${DESTDIR}/dev 120 mount -t devfs devfs ${DESTDIR}/dev 121 chroot ${DESTDIR} ${EMULATOR} /usr/bin/newaliases 122 chroot ${DESTDIR} ${EMULATOR} /bin/sh /etc/rc.d/ldconfig forcestart 123 cp /etc/resolv.conf ${DESTDIR}/etc/resolv.conf 124 125 return 0 126} 127 128vm_extra_install_base() { 129 # Prototype. When overridden, runs extra post-installworld commands 130 # as needed, based on the target virtual machine image or cloud 131 # provider image target. 132 133 return 0 134} 135 136vm_extra_enable_services() { 137 if [ -n "${VM_RC_LIST}" ]; then 138 for _rcvar in ${VM_RC_LIST}; do 139 echo ${_rcvar}_enable="YES" >> ${DESTDIR}/etc/rc.conf 140 done 141 fi 142 143 if [ -z "${VMCONFIG}" -o -c "${VMCONFIG}" ]; then 144 echo 'ifconfig_DEFAULT="DHCP inet6 accept_rtadv"' >> \ 145 ${DESTDIR}/etc/rc.conf 146 # Expand the filesystem to fill the disk. 147 echo 'growfs_enable="YES"' >> ${DESTDIR}/etc/rc.conf 148 touch ${DESTDIR}/firstboot 149 fi 150 151 return 0 152} 153 154vm_extra_install_packages() { 155 if [ -n "${WITHOUT_QEMU}" ]; then 156 return 0 157 fi 158 159 if [ -z "${VM_EXTRA_PACKAGES}" ]; then 160 return 0 161 fi 162 chroot ${DESTDIR} ${EMULATOR} env ASSUME_ALWAYS_YES=yes \ 163 /usr/sbin/pkg bootstrap -y 164 for p in ${VM_EXTRA_PACKAGES}; do 165 chroot ${DESTDIR} ${EMULATOR} env ASSUME_ALWAYS_YES=yes \ 166 /usr/sbin/pkg install -y ${p} 167 done 168 169 return 0 170} 171 172vm_extra_install_ports() { 173 # Prototype. When overridden, installs additional ports within the 174 # virtual machine environment. 175 176 return 0 177} 178 179vm_extra_pre_umount() { 180 # Prototype. When overridden, performs additional tasks within the 181 # virtual machine environment prior to unmounting the filesystem. 182 183 return 0 184} 185 186vm_emulation_cleanup() { 187 if [ -n "${WITHOUT_QEMU}" ]; then 188 return 0 189 fi 190 191 if ! [ -z "${QEMUSTATIC}" ]; then 192 rm -f ${DESTDIR}/${EMULATOR} 193 fi 194 rm -f ${DESTDIR}/etc/resolv.conf 195 umount_loop ${DESTDIR}/dev 196 return 0 197} 198 199vm_extra_pkg_rmcache() { 200 if [ -e ${DESTDIR}/usr/local/sbin/pkg ]; then 201 chroot ${DESTDIR} ${EMULATOR} env ASSUME_ALWAYS_YES=yes \ 202 /usr/local/sbin/pkg clean -y -a 203 fi 204 205 return 0 206} 207 208buildfs() { 209 local md tmppool 210 211 case "${VMFS}" in 212 ufs) 213 cd ${DESTDIR} && ${MAKEFS} ${MAKEFSARGS} -o label=rootfs -o version=2 -o softupdates=1 \ 214 ${VMBASE} .${NO_ROOT:+/METALOG} 215 ;; 216 zfs) 217 cd ${DESTDIR} && ${MAKEFS} -t zfs ${MAKEFSARGS} \ 218 -o poolname=zroot -o bootfs=zroot/ROOT/default -o rootpath=/ \ 219 -o fs=zroot\;mountpoint=none \ 220 -o fs=zroot/ROOT\;mountpoint=none \ 221 -o fs=zroot/ROOT/default\;mountpoint=/\;canmount=noauto \ 222 -o fs=zroot/home\;mountpoint=/home \ 223 -o fs=zroot/tmp\;mountpoint=/tmp\;exec=on\;setuid=off \ 224 -o fs=zroot/usr\;mountpoint=/usr\;canmount=off \ 225 -o fs=zroot/usr/ports\;setuid=off \ 226 -o fs=zroot/usr/src \ 227 -o fs=zroot/usr/obj \ 228 -o fs=zroot/var\;mountpoint=/var\;canmount=off \ 229 -o fs=zroot/var/audit\;setuid=off\;exec=off \ 230 -o fs=zroot/var/crash\;setuid=off\;exec=off \ 231 -o fs=zroot/var/log\;setuid=off\;exec=off \ 232 -o fs=zroot/var/mail\;atime=on \ 233 -o fs=zroot/var/tmp\;setuid=off \ 234 ${VMBASE} .${NO_ROOT:+/METALOG} 235 ;; 236 *) 237 echo "Unexpected VMFS value '${VMFS}'" 238 exit 1 239 ;; 240 esac 241} 242 243umount_loop() { 244 DIR=$1 245 i=0 246 sync 247 while ! umount ${DIR}; do 248 i=$(( $i + 1 )) 249 if [ $i -ge 10 ]; then 250 # This should never happen. But, it has happened. 251 echo "Cannot umount(8) ${DIR}" 252 echo "Something has gone horribly wrong." 253 return 1 254 fi 255 sleep 1 256 done 257 258 return 0 259} 260 261vm_create_disk() { 262 local BOOTFILES BOOTPARTSOFFSET FSPARTTYPE X86GPTBOOTFILE 263 264 if [ -z "${NOSWAP}" ]; then 265 SWAPOPT="-p freebsd-swap/swapfs::${SWAPSIZE}" 266 fi 267 268 if [ -n "${VM_BOOTPARTSOFFSET}" ]; then 269 BOOTPARTSOFFSET=":${VM_BOOTPARTSOFFSET}" 270 fi 271 272 if [ -n "${CONFIG_DRIVE}" ]; then 273 CONFIG_DRIVE="-p freebsd/config-drive::${CONFIG_DRIVE_SIZE}" 274 fi 275 276 case "${VMFS}" in 277 ufs) 278 FSPARTTYPE=freebsd-ufs 279 X86GPTBOOTFILE=i386/gptboot/gptboot 280 ;; 281 zfs) 282 FSPARTTYPE=freebsd-zfs 283 X86GPTBOOTFILE=i386/gptzfsboot/gptzfsboot 284 ;; 285 *) 286 echo "Unexpected VMFS value '${VMFS}'" 287 return 1 288 ;; 289 esac 290 291 echo "Creating image... Please wait." 292 echo 293 294 BOOTFILES="$(env TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH} \ 295 WITH_UNIFIED_OBJDIR=yes \ 296 make -C ${WORLDDIR}/stand -V .OBJDIR)" 297 BOOTFILES="$(realpath ${BOOTFILES})" 298 MAKEFSARGS="-s ${VMSIZE} -D" 299 300 case "${TARGET}:${TARGET_ARCH}" in 301 amd64:amd64 | i386:i386) 302 ESP=yes 303 BOOTPARTS="-b ${BOOTFILES}/i386/pmbr/pmbr \ 304 -p freebsd-boot/bootfs:=${BOOTFILES}/${X86GPTBOOTFILE}${BOOTPARTSOFFSET}" 305 ROOTFSPART="-p ${FSPARTTYPE}/rootfs:=${VMBASE}" 306 MAKEFSARGS="$MAKEFSARGS -B little" 307 ;; 308 arm:armv7 | arm64:aarch64 | riscv:riscv64*) 309 ESP=yes 310 BOOTPARTS= 311 ROOTFSPART="-p ${FSPARTTYPE}/rootfs:=${VMBASE}" 312 MAKEFSARGS="$MAKEFSARGS -B little" 313 ;; 314 powerpc:powerpc*) 315 ESP=no 316 BOOTPARTS="-p prepboot:=${BOOTFILES}/powerpc/boot1.chrp/boot1.elf -a 1" 317 ROOTFSPART="-p freebsd:=${VMBASE}" 318 if [ ${TARGET_ARCH} = powerpc64le ]; then 319 MAKEFSARGS="$MAKEFSARGS -B little" 320 else 321 MAKEFSARGS="$MAKEFSARGS -B big" 322 fi 323 ;; 324 *) 325 echo "vmimage.subr: unsupported target '${TARGET}:${TARGET_ARCH}'" >&2 326 exit 1 327 ;; 328 esac 329 330 if [ ${ESP} = "yes" ]; then 331 # Create an ESP 332 espfilename=$(mktemp /tmp/efiboot.XXXXXX) 333 make_esp_file ${espfilename} ${fat32min} ${BOOTFILES}/efi/loader_lua/loader_lua.efi 334 BOOTPARTS="${BOOTPARTS} -p efi/efiboot0:=${espfilename}" 335 336 # Add this to fstab 337 mkdir -p ${DESTDIR}/boot/efi 338 echo "/dev/${ROOTLABEL}/efiboot0 /boot/efi msdosfs rw 2 2" \ 339 >> ${DESTDIR}/etc/fstab 340 fi 341 342 echo "Building filesystem... Please wait." 343 buildfs 344 345 echo "Building final disk image... Please wait." 346 ${MKIMG} -s ${PARTSCHEME} -f ${VMFORMAT} \ 347 ${BOOTPARTS} \ 348 ${SWAPOPT} \ 349 ${CONFIG_DRIVE} \ 350 ${ROOTFSPART} \ 351 -o ${VMIMAGE} 352 353 echo "Disk image ${VMIMAGE} created." 354 355 if [ ${ESP} = "yes" ]; then 356 rm ${espfilename} 357 fi 358 359 return 0 360} 361 362vm_extra_create_disk() { 363 364 return 0 365} 366 367touch_firstboot() { 368 touch ${DESTDIR}/firstboot 369 metalog_add_data ./firstboot 370} 371