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