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 "       -p: pass-through a host PCI device at bus/slot/func (e.g. 10/0/0)"
  66         echo "       -t: tap device for virtio-net (default is $DEFAULT_TAPDEV)"
  67         echo ""
  68         [ -n "$msg" ] && errmsg "$msg"
  69         exit 1
  70 }
  71
  72 if [ `id -u` -ne 0 ]; then
  73         errmsg "This script must be executed with superuser privileges"
  74         exit 1
  75 fi
  76
  77 kldstat -n vmm > /dev/null 2>&1
  78 if [ $? -ne 0 ]; then
  79         errmsg "vmm.ko is not loaded"
  80         exit 1
  81 fi
  82
  83 force_install=0
  84 isofile=${DEFAULT_ISOFILE}
  85 memsize=${DEFAULT_MEMSIZE}
  86 console=${DEFAULT_CONSOLE}
  87 cpus=${DEFAULT_CPUS}
  88 tap_total=0
  89 disk_total=0
  90 apic_opt=""
  91 gdbport=0
  92 loader_opt=""
  93 pass_total=0
  94
  95 while getopts ac:C:d:e:g:hH:iI:m:p:t: c ; do
  96         case $c in
  97         a)
  98                 apic_opt="-a"
  99                 ;;
 100         c)
 101                 cpus=${OPTARG}
 102                 ;;
 103         C)
 104                 console=${OPTARG}
 105                 ;;
 106         d)
 107                 disk_dev=${OPTARG%%,*}
 108                 disk_opts=${OPTARG#${disk_dev}}
 109                 eval "disk_dev${disk_total}=\"${disk_dev}\""
 110                 eval "disk_opts${disk_total}=\"${disk_opts}\""
 111                 disk_total=$(($disk_total + 1))
 112                 ;;
 113         e)
 114                 loader_opt="${loader_opt} -e ${OPTARG}"
 115                 ;;
 116         g)
 117                 gdbport=${OPTARG}
 118                 ;;
 119         H)
 120                 host_base=`realpath ${OPTARG}`
 121                 ;;
 122         i)
 123                 force_install=1
 124                 ;;
 125         I)
 126                 isofile=${OPTARG}
 127                 ;;
 128         m)
 129                 memsize=${OPTARG}
 130                 ;;
 131         p)
 132                 eval "pass_dev${pass_total}=\"${OPTARG}\""
 133                 pass_total=$(($pass_total + 1))
 134                 ;;
 135         t)
 136                 eval "tap_dev${tap_total}=\"${OPTARG}\""
 137                 tap_total=$(($tap_total + 1))
 138                 ;;
 139         *)
 140                 usage
 141                 ;;
 142         esac
 143 done
 144
 145 if [ $tap_total -eq 0 ] ; then
 146     tap_total=1
 147     tap_dev0="${DEFAULT_TAPDEV}"
 148 fi
 149 if [ $disk_total -eq 0 ] ; then
 150     disk_total=1
 151     disk_dev0="${DEFAULT_VIRTIO_DISK}"
 152
 153 fi
 154
 155 shift $((${OPTIND} - 1))
 156
 157 if [ $# -ne 1 ]; then
 158         usage "virtual machine name not specified"
 159 fi
 160
 161 vmname="$1"
 162 if [ -n "${host_base}" ]; then
 163         loader_opt="${loader_opt} -h ${host_base}"
 164 fi
 165
 166 make_and_check_diskdev()
 167 {
 168     local virtio_diskdev="$1"
 169     # Create the virtio diskdev file if needed
 170     if [ ! -f ${virtio_diskdev} ]; then
 171             echo "virtio disk device file \"${virtio_diskdev}\" does not exist."
 172             echo "Creating it ..."
 173             truncate -s 8G ${virtio_diskdev} > /dev/null
 174     fi
 175
 176     if [ ! -r ${virtio_diskdev} ]; then
 177             echo "virtio disk device file \"${virtio_diskdev}\" is not readable"
 178             exit 1
 179     fi
 180
 181     if [ ! -w ${virtio_diskdev} ]; then
 182             echo "virtio disk device file \"${virtio_diskdev}\" is not writable"
 183             exit 1
 184     fi
 185 }
 186
 187 echo "Launching virtual machine \"$vmname\" ..."
 188
 189 first_diskdev="$disk_dev0"
 190
 191 ${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1
 192
 193 while [ 1 ]; do
 194
 195         file -s ${first_diskdev} | grep "boot sector" > /dev/null
 196         rc=$?
 197         if [ $rc -ne 0 ]; then
 198                 file -s ${first_diskdev} | grep ": Unix Fast File sys" > /dev/null
 199                 rc=$?
 200         fi
 201         if [ $rc -ne 0 ]; then
 202                 need_install=1
 203         else
 204                 need_install=0
 205         fi
 206
 207         if [ $force_install -eq 1 -o $need_install -eq 1 ]; then
 208                 if [ ! -r ${isofile} ]; then
 209                         echo -n "Installation CDROM image \"${isofile}\" "
 210                         echo    "is not readable"
 211                         exit 1
 212                 fi
 213                 BOOTDISKS="-d ${isofile}"
 214                 installer_opt="-s 31:0,ahci-cd,${isofile}"
 215         else
 216                 BOOTDISKS=""
 217                 i=0
 218                 while [ $i -lt $disk_total ] ; do
 219                         eval "disk=\$disk_dev${i}"
 220                         if [ -r ${disk} ] ; then
 221                                 BOOTDISKS="$BOOTDISKS -d ${disk} "
 222                         fi
 223                         i=$(($i + 1))
 224                 done
 225                 installer_opt=""
 226         fi
 227
 228         ${LOADER} -c ${console} -m ${memsize} ${BOOTDISKS} ${loader_opt} \
 229                 ${vmname}
 230         bhyve_exit=$?
 231         if [ $bhyve_exit -ne 0 ]; then
 232                 break
 233         fi
 234
 235         #
 236         # Build up args for additional tap and disk devices now.
 237         #
 238         nextslot=2  # slot 0 is hostbridge, slot 1 is lpc
 239         devargs=""  # accumulate disk/tap args here
 240         i=0
 241         while [ $i -lt $tap_total ] ; do
 242             eval "tapname=\$tap_dev${i}"
 243             devargs="$devargs -s $nextslot:0,virtio-net,${tapname} "
 244             nextslot=$(($nextslot + 1))
 245             i=$(($i + 1))
 246         done
 247
 248         i=0
 249         while [ $i -lt $disk_total ] ; do
 250             eval "disk=\$disk_dev${i}"
 251             eval "opts=\$disk_opts${i}"
 252             make_and_check_diskdev "${disk}"
 253             devargs="$devargs -s $nextslot:0,virtio-blk,${disk}${opts} "
 254             nextslot=$(($nextslot + 1))
 255             i=$(($i + 1))
 256         done
 257
 258         i=0
 259         while [ $i -lt $pass_total ] ; do
 260             eval "pass=\$pass_dev${i}"
 261             devargs="$devargs -s $nextslot:0,passthru,${pass} "
 262             nextslot=$(($nextslot + 1))
 263             i=$(($i + 1))
 264         done
 265
 266         ${FBSDRUN} -c ${cpus} -m ${memsize} ${apic_opt} -A -H -P        \
 267                 -g ${gdbport}                                           \
 268                 -s 0:0,hostbridge                                       \
 269                 -s 1:0,lpc                                              \
 270                 ${devargs}                                              \
 271                 -l com1,${console}                                      \
 272                 ${installer_opt}                                        \
 273                 ${vmname}
 274
 275         bhyve_exit=$?
 276         # bhyve returns the following status codes:
 277         #  0 - VM has been reset
 278         #  1 - VM has been powered off
 279         #  2 - VM has been halted
 280         #  3 - VM generated a triple fault
 281         #  all other non-zero status codes are errors
 282         #
 283         if [ $bhyve_exit -ne 0 ]; then
 284                 break
 285         fi
 286 done
 287
 288
 289 case $bhyve_exit in
 290         0|1|2)
 291                 # Cleanup /dev/vmm entry when bhyve did not exit
 292                 # due to an error.
 293                 ${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1
 294                 ;;
 295 esac
 296
 297 exit $bhyve_exit