share/examples/bhyve/vmrun.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2013 NetApp, Inc.
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 # $FreeBSD$
  28 #
  29
  30 LOADER=/usr/sbin/bhyveload
  31 BHYVECTL=/usr/sbin/bhyvectl
  32 FBSDRUN=/usr/sbin/bhyve
  33
  34 DEFAULT_MEMSIZE=512M
  35 DEFAULT_CPUS=2
  36 DEFAULT_TAPDEV=tap0
  37 DEFAULT_CONSOLE=stdio
  38
  39 DEFAULT_VIRTIO_DISK="./diskdev"
  40 DEFAULT_ISOFILE="./release.iso"
  41
  42 errmsg() {
  43         echo "*** $1"
  44 }
  45
  46 usage() {
  47         local msg=$1
  48
  49         echo "Usage: vmrun.sh [-ahi] [-c <CPUs>] [-C <console>] [-d <disk file>]"
  50         echo "                [-e <name=value>] [-g <gdbport> ] [-H <directory>]"
  51         echo "                [-I <location of installation iso>] [-m <memsize>]"
  52         echo "                [-t <tapdev>] <vmname>"
  53         echo ""
  54         echo "       -h: display this help message"
  55         echo "       -a: force memory mapped local APIC access"
  56         echo "       -c: number of virtual cpus (default is ${DEFAULT_CPUS})"
  57         echo "       -C: console device (default is ${DEFAULT_CONSOLE})"
  58         echo "       -d: virtio diskdev file (default is ${DEFAULT_VIRTIO_DISK})"
  59         echo "       -e: set FreeBSD loader environment variable"
  60         echo "       -g: listen for connection from kgdb at <gdbport>"
  61         echo "       -H: host filesystem to export to the loader"
  62         echo "       -i: force boot of the Installation CDROM image"
  63         echo "       -I: Installation CDROM image location (default is ${DEFAULT_ISOFILE})"
  64         echo "       -m: memory size (default is ${DEFAULT_MEMSIZE})"
  65         echo "       -t: tap device for virtio-net (default is $DEFAULT_TAPDEV)"
  66         echo ""
  67         [ -n "$msg" ] && errmsg "$msg"
  68         exit 1
  69 }
  70
  71 if [ `id -u` -ne 0 ]; then
  72         errmsg "This script must be executed with superuser privileges"
  73         exit 1
  74 fi
  75
  76 kldstat -n vmm > /dev/null 2>&1
  77 if [ $? -ne 0 ]; then
  78         errmsg "vmm.ko is not loaded"
  79         exit 1
  80 fi
  81
  82 force_install=0
  83 isofile=${DEFAULT_ISOFILE}
  84 memsize=${DEFAULT_MEMSIZE}
  85 console=${DEFAULT_CONSOLE}
  86 cpus=${DEFAULT_CPUS}
  87 tap_total=0
  88 disk_total=0
  89 apic_opt=""
  90 gdbport=0
  91 loader_opt=""
  92
  93 while getopts ac:C:d:e:g:hH:iI:m:t: c ; do
  94         case $c in
  95         a)
  96                 apic_opt="-a"
  97                 ;;
  98         c)
  99                 cpus=${OPTARG}
 100                 ;;
 101         C)
 102                 console=${OPTARG}
 103                 ;;
 104         d)
 105                 disk_dev=${OPTARG%%,*}
 106                 disk_opts=${OPTARG#${disk_dev}}
 107                 eval "disk_dev${disk_total}=\"${disk_dev}\""
 108                 eval "disk_opts${disk_total}=\"${disk_opts}\""
 109                 disk_total=$(($disk_total + 1))
 110                 ;;
 111         e)
 112                 loader_opt="${loader_opt} -e ${OPTARG}"
 113                 ;;
 114         g)
 115                 gdbport=${OPTARG}
 116                 ;;
 117         H)
 118                 host_base=`realpath ${OPTARG}`
 119                 ;;
 120         i)
 121                 force_install=1
 122                 ;;
 123         I)
 124                 isofile=${OPTARG}
 125                 ;;
 126         m)
 127                 memsize=${OPTARG}
 128                 ;;
 129         t)
 130                 eval "tap_dev${tap_total}=\"${OPTARG}\""
 131                 tap_total=$(($tap_total + 1))
 132                 ;;
 133         *)
 134                 usage
 135                 ;;
 136         esac
 137 done
 138
 139 if [ $tap_total -eq 0 ] ; then
 140     tap_total=1
 141     tap_dev0="${DEFAULT_TAPDEV}"
 142 fi
 143 if [ $disk_total -eq 0 ] ; then
 144     disk_total=1
 145     disk_dev0="${DEFAULT_VIRTIO_DISK}"
 146
 147 fi
 148
 149 shift $((${OPTIND} - 1))
 150
 151 if [ $# -ne 1 ]; then
 152         usage "virtual machine name not specified"
 153 fi
 154
 155 vmname="$1"
 156 if [ -n "${host_base}" ]; then
 157         loader_opt="${loader_opt} -h ${host_base}"
 158 fi
 159
 160 make_and_check_diskdev()
 161 {
 162     local virtio_diskdev="$1"
 163     # Create the virtio diskdev file if needed
 164     if [ ! -f ${virtio_diskdev} ]; then
 165             echo "virtio disk device file \"${virtio_diskdev}\" does not exist."
 166             echo "Creating it ..."
 167             truncate -s 8G ${virtio_diskdev} > /dev/null
 168     fi
 169
 170     if [ ! -r ${virtio_diskdev} ]; then
 171             echo "virtio disk device file \"${virtio_diskdev}\" is not readable"
 172             exit 1
 173     fi
 174
 175     if [ ! -w ${virtio_diskdev} ]; then
 176             echo "virtio disk device file \"${virtio_diskdev}\" is not writable"
 177             exit 1
 178     fi
 179 }
 180
 181 echo "Launching virtual machine \"$vmname\" ..."
 182
 183 first_diskdev="$disk_dev0"
 184
 185 ${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1
 186
 187 while [ 1 ]; do
 188
 189         file -s ${first_diskdev} | grep "boot sector" > /dev/null
 190         rc=$?
 191         if [ $rc -ne 0 ]; then
 192                 file -s ${first_diskdev} | grep ": Unix Fast File sys" > /dev/null
 193                 rc=$?
 194         fi
 195         if [ $rc -ne 0 ]; then
 196                 need_install=1
 197         else
 198                 need_install=0
 199         fi
 200
 201         if [ $force_install -eq 1 -o $need_install -eq 1 ]; then
 202                 if [ ! -r ${isofile} ]; then
 203                         echo -n "Installation CDROM image \"${isofile}\" "
 204                         echo    "is not readable"
 205                         exit 1
 206                 fi
 207                 BOOTDISKS="-d ${isofile}"
 208                 installer_opt="-s 31:0,ahci-cd,${isofile}"
 209         else
 210                 BOOTDISKS=""
 211                 i=0
 212                 while [ $i -lt $disk_total ] ; do
 213                         eval "disk=\$disk_dev${i}"
 214                         if [ -r ${disk} ] ; then
 215                                 BOOTDISKS="$BOOTDISKS -d ${disk} "
 216                         fi
 217                         i=$(($i + 1))
 218                 done
 219                 installer_opt=""
 220         fi
 221
 222         ${LOADER} -c ${console} -m ${memsize} ${BOOTDISKS} ${loader_opt} \
 223                 ${vmname}
 224         bhyve_exit=$?
 225         if [ $bhyve_exit -ne 0 ]; then
 226                 break
 227         fi
 228
 229         #
 230         # Build up args for additional tap and disk devices now.
 231         #
 232         nextslot=2  # slot 0 is hostbridge, slot 1 is lpc
 233         devargs=""  # accumulate disk/tap args here
 234         i=0
 235         while [ $i -lt $tap_total ] ; do
 236             eval "tapname=\$tap_dev${i}"
 237             devargs="$devargs -s $nextslot:0,virtio-net,${tapname} "
 238             nextslot=$(($nextslot + 1))
 239             i=$(($i + 1))
 240         done
 241
 242         i=0
 243         while [ $i -lt $disk_total ] ; do
 244             eval "disk=\$disk_dev${i}"
 245             eval "opts=\$disk_opts${i}"
 246             make_and_check_diskdev "${disk}"
 247             devargs="$devargs -s $nextslot:0,virtio-blk,${disk}${opts} "
 248             nextslot=$(($nextslot + 1))
 249             i=$(($i + 1))
 250         done
 251
 252         ${FBSDRUN} -c ${cpus} -m ${memsize} ${apic_opt} -A -H -P        \
 253                 -g ${gdbport}                                           \
 254                 -s 0:0,hostbridge                                       \
 255                 -s 1:0,lpc                                              \
 256                 ${devargs}                                              \
 257                 -l com1,${console}                                      \
 258                 ${installer_opt}                                        \
 259                 ${vmname}
 260
 261         bhyve_exit=$?
 262         # bhyve returns the following status codes:
 263         #  0 - VM has been reset
 264         #  1 - VM has been powered off
 265         #  2 - VM has been halted
 266         #  3 - VM generated a triple fault
 267         #  all other non-zero status codes are errors
 268         #
 269         if [ $bhyve_exit -ne 0 ]; then
 270                 break
 271         fi
 272 done
 273
 274
 275 case $bhyve_exit in
 276         0|1|2)
 277                 # Cleanup /dev/vmm entry when bhyve did not exit
 278                 # due to an error.
 279                 ${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1
 280                 ;;
 281 esac
 282
 283 exit $bhyve_exit