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 30LOADER=/usr/sbin/bhyveload 31BHYVECTL=/usr/sbin/bhyvectl 32FBSDRUN=/usr/sbin/bhyve 33 34DEFAULT_MEMSIZE=512M 35DEFAULT_CPUS=2 36DEFAULT_TAPDEV=tap0 37DEFAULT_CONSOLE=stdio 38 39DEFAULT_VIRTIO_DISK="./diskdev" 40DEFAULT_ISOFILE="./release.iso" 41 42usage() { 43 echo "Usage: vmrun.sh [-ahi] [-c <CPUs>] [-C <console>] [-d <disk file>]" 44 echo " [-e <name=value>] [-g <gdbport> ] [-H <directory>]" 45 echo " [-I <location of installation iso>] [-m <memsize>]" 46 echo " [-t <tapdev>] <vmname>" 47 echo "" 48 echo " -h: display this help message" 49 echo " -a: force memory mapped local APIC access" 50 echo " -c: number of virtual cpus (default is ${DEFAULT_CPUS})" 51 echo " -C: console device (default is ${DEFAULT_CONSOLE})" 52 echo " -d: virtio diskdev file (default is ${DEFAULT_VIRTIO_DISK})" 53 echo " -e: set FreeBSD loader environment variable" 54 echo " -g: listen for connection from kgdb at <gdbport>" 55 echo " -H: host filesystem to export to the loader" 56 echo " -i: force boot of the Installation CDROM image" 57 echo " -I: Installation CDROM image location (default is ${DEFAULT_ISOFILE})" 58 echo " -m: memory size (default is ${DEFAULT_MEMSIZE})" 59 echo " -t: tap device for virtio-net (default is $DEFAULT_TAPDEV)" 60 echo "" 61 echo " This script needs to be executed with superuser privileges" 62 echo "" 63 exit 1 64} 65 66if [ `id -u` -ne 0 ]; then 67 usage 68fi 69 70kldstat -n vmm > /dev/null 2>&1 71if [ $? -ne 0 ]; then 72 echo "vmm.ko is not loaded!" 73 exit 1 74fi 75 76force_install=0 77isofile=${DEFAULT_ISOFILE} 78memsize=${DEFAULT_MEMSIZE} 79console=${DEFAULT_CONSOLE} 80cpus=${DEFAULT_CPUS} 81tap_total=0 82disk_total=0 83apic_opt="" 84gdbport=0 85loader_opt="" 86 87while getopts ac:C:d:e:g:hH:iI:m:t: c ; do 88 case $c in 89 a) 90 apic_opt="-a" 91 ;; 92 c) 93 cpus=${OPTARG} 94 ;; 95 C) 96 console=${OPTARG} 97 ;; 98 d) 99 eval "disk_dev${disk_total}=\"${OPTARG}\"" 100 disk_total=$(($disk_total + 1)) 101 ;; 102 e) 103 loader_opt="${loader_opt} -e ${OPTARG}" 104 ;; 105 g) 106 gdbport=${OPTARG} 107 ;; 108 H) 109 host_base=`realpath ${OPTARG}` 110 ;; 111 i) 112 force_install=1 113 ;; 114 I) 115 isofile=${OPTARG} 116 ;; 117 m) 118 memsize=${OPTARG} 119 ;; 120 t) 121 eval "tap_dev${tap_total}=\"${OPTARG}\"" 122 tap_total=$(($tap_total + 1)) 123 ;; 124 *) 125 usage 126 ;; 127 esac 128done 129 130if [ $tap_total -eq 0 ] ; then 131 tap_total=1 132 tap_dev0="${DEFAULT_TAPDEV}" 133fi 134if [ $disk_total -eq 0 ] ; then 135 disk_total=1 136 disk_dev0="${DEFAULT_VIRTIO_DISK}" 137 138fi 139 140shift $((${OPTIND} - 1)) 141 142if [ $# -ne 1 ]; then 143 usage 144fi 145 146vmname="$1" 147if [ -n "${host_base}" ]; then 148 loader_opt="${loader_opt} -h ${host_base}" 149fi 150 151make_and_check_diskdev() 152{ 153 local virtio_diskdev="$1" 154 # Create the virtio diskdev file if needed 155 if [ ! -e ${virtio_diskdev} ]; then 156 echo "virtio disk device file \"${virtio_diskdev}\" does not exist." 157 echo "Creating it ..." 158 truncate -s 8G ${virtio_diskdev} > /dev/null 159 fi 160 161 if [ ! -r ${virtio_diskdev} ]; then 162 echo "virtio disk device file \"${virtio_diskdev}\" is not readable" 163 exit 1 164 fi 165 166 if [ ! -w ${virtio_diskdev} ]; then 167 echo "virtio disk device file \"${virtio_diskdev}\" is not writable" 168 exit 1 169 fi 170} 171 172echo "Launching virtual machine \"$vmname\" ..." 173 174virtio_diskdev="$disk_dev0" 175 176${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1 177 178while [ 1 ]; do 179 180 file -s ${virtio_diskdev} | grep "boot sector" > /dev/null 181 rc=$? 182 if [ $rc -ne 0 ]; then 183 file -s ${virtio_diskdev} | grep ": Unix Fast File sys" > /dev/null 184 rc=$? 185 fi 186 if [ $rc -ne 0 ]; then 187 need_install=1 188 else 189 need_install=0 190 fi 191 192 if [ $force_install -eq 1 -o $need_install -eq 1 ]; then 193 if [ ! -r ${isofile} ]; then 194 echo -n "Installation CDROM image \"${isofile}\" " 195 echo "is not readable" 196 exit 1 197 fi 198 BOOTDISK=${isofile} 199 installer_opt="-s 31:0,ahci-cd,${BOOTDISK}" 200 else 201 BOOTDISK=${virtio_diskdev} 202 installer_opt="" 203 fi 204 205 ${LOADER} -c ${console} -m ${memsize} -d ${BOOTDISK} ${loader_opt} \ 206 ${vmname} 207 bhyve_exit=$? 208 if [ $bhyve_exit -ne 0 ]; then 209 break 210 fi 211 212 # 213 # Build up args for additional tap and disk devices now. 214 # 215 nextslot=2 # slot 0 is hostbridge, slot 1 is lpc 216 devargs="" # accumulate disk/tap args here 217 i=0 218 while [ $i -lt $tap_total ] ; do 219 eval "tapname=\$tap_dev${i}" 220 devargs="$devargs -s $nextslot:0,virtio-net,${tapname} " 221 nextslot=$(($nextslot + 1)) 222 i=$(($i + 1)) 223 done 224 225 i=0 226 while [ $i -lt $disk_total ] ; do 227 eval "disk=\$disk_dev${i}" 228 make_and_check_diskdev "${disk}" 229 devargs="$devargs -s $nextslot:0,virtio-blk,${disk} " 230 nextslot=$(($nextslot + 1)) 231 i=$(($i + 1)) 232 done 233 234 ${FBSDRUN} -c ${cpus} -m ${memsize} ${apic_opt} -A -H -P \ 235 -g ${gdbport} \ 236 -s 0:0,hostbridge \ 237 -s 1:0,lpc \ 238 ${devargs} \ 239 -l com1,${console} \ 240 ${installer_opt} \ 241 ${vmname} 242 243 bhyve_exit=$? 244 # bhyve returns the following status codes: 245 # 0 - VM has been reset 246 # 1 - VM has been powered off 247 # 2 - VM has been halted 248 # 3 - VM generated a triple fault 249 # all other non-zero status codes are errors 250 # 251 if [ $bhyve_exit -ne 0 ]; then 252 break 253 fi 254done 255 256 257case $bhyve_exit in 258 0|1|2) 259 # Cleanup /dev/vmm entry when bhyve did not exit 260 # due to an error. 261 ${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1 262 ;; 263esac 264 265exit $bhyve_exit 266