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