release/tools/vmimage.subr

   1 #!/bin/sh
   2 #
   3 # $FreeBSD$
   4 #
   5 #
   6 # Common functions for virtual machine image build scripts.
   7 #
   8
   9 export PATH="/bin:/usr/bin:/sbin:/usr/sbin:/usr/local/bin:/usr/local/sbin"
  10 trap "cleanup" INT QUIT TRAP ABRT TERM
  11
  12 write_partition_layout() {
  13         if [ -z "${NOSWAP}" ]; then
  14                 SWAPOPT="-p freebsd-swap/swapfs::${SWAPSIZE}"
  15         fi
  16
  17         _OBJDIR="$(make -C ${WORLDDIR} -V .OBJDIR)"
  18         _OBJDIR="$(realpath ${_OBJDIR})"
  19         if [ -d "${_OBJDIR%%/usr/src}/${TARGET}.${TARGET_ARCH}" ]; then
  20                 BOOTFILES="/${_OBJDIR%%/usr/src}/${TARGET}.${TARGET_ARCH}/usr/src/sys/boot"
  21         else
  22                 BOOTFILES="/${_OBJDIR}/sys/boot"
  23         fi
  24
  25         case "${TARGET}:${TARGET_ARCH}" in
  26                 amd64:amd64 | i386:i386)
  27                         mkimg -s gpt -f ${VMFORMAT} \
  28                                 -b ${BOOTFILES}/i386/pmbr/pmbr \
  29                                 -p freebsd-boot/bootfs:=${BOOTFILES}/i386/gptboot/gptboot \
  30                                 ${SWAPOPT} \
  31                                 -p freebsd-ufs/rootfs:=${VMBASE} \
  32                                 -o ${VMIMAGE}
  33                         ;;
  34                 arm64:aarch64)
  35                         mkimg -s mbr -f ${VMFORMAT} \
  36                                 -p efi:=${BOOTFILES}/efi/boot1/boot1.efifat \
  37                                 -p freebsd:=${VMBASE} \
  38                                 -o ${VMIMAGE}
  39                         ;;
  40                 powerpc:powerpc*)
  41                         mkimg -s apm -f ${VMFORMAT} \
  42                                 -p apple-boot/bootfs:=${BOOTFILES}/powerpc/boot1.chrp/boot1.hfs \
  43                                 ${SWAPOPT} \
  44                                 -p freebsd-ufs/rootfs:=${VMBASE} \
  45                                 -o ${VMIMAGE}
  46                         ;;
  47                 *)
  48                         # ENOTSUPP
  49                         return 1
  50                         ;;
  51         esac
  52
  53         return 0
  54 }
  55
  56 err() {
  57         printf "${@}\n"
  58         cleanup
  59         return 1
  60 }
  61
  62 cleanup() {
  63         if [ -c "${DESTDIR}/dev/null" ]; then
  64                 umount_loop ${DESTDIR}/dev 2>/dev/null
  65         fi
  66         umount_loop ${DESTDIR}
  67         if [ ! -z "${mddev}" ]; then
  68                 mdconfig -d -u ${mddev}
  69         fi
  70
  71         return 0
  72 }
  73
  74 vm_create_base() {
  75         # Creates the UFS root filesystem for the virtual machine disk,
  76         # written to the formatted disk image with mkimg(1).
  77
  78         mkdir -p ${DESTDIR}
  79         truncate -s ${VMSIZE} ${VMBASE}
  80         mddev=$(mdconfig -f ${VMBASE})
  81         newfs -L rootfs /dev/${mddev}
  82         mount /dev/${mddev} ${DESTDIR}
  83
  84         return 0
  85 }
  86
  87 vm_copy_base() {
  88         # Creates a new UFS root filesystem and copies the contents of the
  89         # current root filesystem into it.  This produces a "clean" disk
  90         # image without any remnants of files which were created temporarily
  91         # during image-creation and have since been deleted (e.g., downloaded
  92         # package archives).
  93
  94         mkdir -p ${DESTDIR}/old
  95         mdold=$(mdconfig -f ${VMBASE})
  96         mount /dev/${mdold} ${DESTDIR}/old
  97
  98         truncate -s ${VMSIZE} ${VMBASE}.tmp
  99         mkdir -p ${DESTDIR}/new
 100         mdnew=$(mdconfig -f ${VMBASE}.tmp)
 101         newfs -L rootfs /dev/${mdnew}
 102         mount /dev/${mdnew} ${DESTDIR}/new
 103
 104         tar -cf- -C ${DESTDIR}/old . | tar -xUf- -C ${DESTDIR}/new
 105
 106         umount_loop /dev/${mdold}
 107         rmdir ${DESTDIR}/old
 108         mdconfig -d -u ${mdold}
 109
 110         umount_loop /dev/${mdnew}
 111         rmdir ${DESTDIR}/new
 112         tunefs -n enable /dev/${mdnew}
 113         mdconfig -d -u ${mdnew}
 114         mv ${VMBASE}.tmp ${VMBASE}
 115 }
 116
 117 vm_install_base() {
 118         # Installs the FreeBSD userland/kernel to the virtual machine disk.
 119
 120         cd ${WORLDDIR} && \
 121                 make DESTDIR=${DESTDIR} \
 122                 installworld installkernel distribution || \
 123                 err "\n\nCannot install the base system to ${DESTDIR}."
 124
 125         echo '# Custom /etc/fstab for FreeBSD VM images' \
 126                 > ${DESTDIR}/etc/fstab
 127         echo "/dev/${ROOTLABEL}/rootfs   /       ufs     rw      1       1" \
 128                 >> ${DESTDIR}/etc/fstab
 129         if [ -z "${NOSWAP}" ]; then
 130                 echo '/dev/gpt/swapfs  none    swap    sw      0       0' \
 131                         >> ${DESTDIR}/etc/fstab
 132         fi
 133
 134         mkdir -p ${DESTDIR}/dev
 135         mount -t devfs devfs ${DESTDIR}/dev
 136         chroot ${DESTDIR} /usr/bin/newaliases
 137         chroot ${DESTDIR} /etc/rc.d/ldconfig forcestart
 138         umount_loop ${DESTDIR}/dev
 139
 140         cp /etc/resolv.conf ${DESTDIR}/etc/resolv.conf
 141
 142         return 0
 143 }
 144
 145 vm_extra_install_base() {
 146         # Prototype.  When overridden, runs extra post-installworld commands
 147         # as needed, based on the target virtual machine image or cloud
 148         # provider image target.
 149
 150         return 0
 151 }
 152
 153 vm_extra_enable_services() {
 154         if [ ! -z "${VM_RC_LIST}" ]; then
 155                 for _rcvar in ${VM_RC_LIST}; do
 156                         echo ${_rcvar}_enable="YES" >> ${DESTDIR}/etc/rc.conf
 157                 done
 158         fi
 159
 160         if [ -z "${VMCONFIG}" -o -c "${VMCONFIG}" ]; then
 161                 echo 'ifconfig_DEFAULT="DHCP inet6 accept_rtadv"' >> \
 162                         ${DESTDIR}/etc/rc.conf
 163         fi
 164
 165         return 0
 166 }
 167
 168 vm_extra_install_packages() {
 169         if [ -z "${VM_EXTRA_PACKAGES}" ]; then
 170                 return 0
 171         fi
 172         mkdir -p ${DESTDIR}/dev
 173         mount -t devfs devfs ${DESTDIR}/dev
 174         chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
 175                 /usr/sbin/pkg bootstrap -y
 176         chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
 177                 /usr/sbin/pkg install -y ${VM_EXTRA_PACKAGES}
 178         umount_loop ${DESTDIR}/dev
 179
 180         return 0
 181 }
 182
 183 vm_extra_install_ports() {
 184         # Prototype.  When overridden, installs additional ports within the
 185         # virtual machine environment.
 186
 187         return 0
 188 }
 189
 190 vm_extra_pre_umount() {
 191         # Prototype.  When overridden, performs additional tasks within the
 192         # virtual machine environment prior to unmounting the filesystem.
 193         # Note: When overriding this function, removing resolv.conf in the
 194         # disk image must be included.
 195
 196         rm -f ${DESTDIR}/etc/resolv.conf
 197         return 0
 198 }
 199
 200 vm_extra_pkg_rmcache() {
 201         if [ -e ${DESTDIR}/usr/local/sbin/pkg ]; then
 202                 chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
 203                         /usr/local/sbin/pkg clean -y -a
 204         fi
 205
 206         return 0
 207 }
 208
 209 umount_loop() {
 210         DIR=$1
 211         i=0
 212         sync
 213         while ! umount ${DIR}; do
 214                 i=$(( $i + 1 ))
 215                 if [ $i -ge 10 ]; then
 216                         # This should never happen.  But, it has happened.
 217                         echo "Cannot umount(8) ${DIR}"
 218                         echo "Something has gone horribly wrong."
 219                         return 1
 220                 fi
 221                 sleep 1
 222         done
 223
 224         return 0
 225 }
 226
 227 vm_create_disk() {
 228         echo "Creating image...  Please wait."
 229         echo
 230
 231         write_partition_layout || return 1
 232
 233         return 0
 234 }
 235
 236 vm_extra_create_disk() {
 237
 238         return 0
 239 }
 240