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