f0cfa1b168
Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. Commit these apart because compile testing doesn't guarantee I didn't made some nasty mistake. No functional change intended.
379 lines
9.3 KiB
Bash
Executable File
379 lines
9.3 KiB
Bash
Executable File
#!/bin/sh
|
|
#
|
|
# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
#
|
|
# Copyright (c) 2013 NetApp, Inc.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions
|
|
# are met:
|
|
# 1. Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# 2. Redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
# SUCH DAMAGE.
|
|
#
|
|
# $FreeBSD$
|
|
#
|
|
|
|
LOADER=/usr/sbin/bhyveload
|
|
BHYVECTL=/usr/sbin/bhyvectl
|
|
FBSDRUN=/usr/sbin/bhyve
|
|
|
|
DEFAULT_MEMSIZE=512M
|
|
DEFAULT_CPUS=2
|
|
DEFAULT_TAPDEV=tap0
|
|
DEFAULT_CONSOLE=stdio
|
|
|
|
DEFAULT_VIRTIO_DISK="./diskdev"
|
|
DEFAULT_ISOFILE="./release.iso"
|
|
|
|
errmsg() {
|
|
echo "*** $1"
|
|
}
|
|
|
|
usage() {
|
|
local msg=$1
|
|
|
|
echo "Usage: vmrun.sh [-aAEhiTv] [-c <CPUs>] [-C <console>] [-d <disk file>]"
|
|
echo " [-e <name=value>] [-f <path of firmware>] [-F <size>]"
|
|
echo " [-g <gdbport> ] [-H <directory>]"
|
|
echo " [-I <location of installation iso>] [-l <loader>]"
|
|
echo " [-L <VNC IP for UEFI framebuffer>]"
|
|
echo " [-m <memsize>] [-P <port>] [-t <tapdev>] <vmname>"
|
|
echo ""
|
|
echo " -h: display this help message"
|
|
echo " -a: force memory mapped local APIC access"
|
|
echo " -A: use AHCI disk emulation instead of virtio"
|
|
echo " -c: number of virtual cpus (default is ${DEFAULT_CPUS})"
|
|
echo " -C: console device (default is ${DEFAULT_CONSOLE})"
|
|
echo " -d: virtio diskdev file (default is ${DEFAULT_VIRTIO_DISK})"
|
|
echo " -e: set FreeBSD loader environment variable"
|
|
echo " -E: Use UEFI mode"
|
|
echo " -f: Use a specific UEFI firmware"
|
|
echo " -F: Use a custom UEFI GOP framebuffer size (default: w=1024,h=768)"
|
|
echo " -g: listen for connection from kgdb at <gdbport>"
|
|
echo " -H: host filesystem to export to the loader"
|
|
echo " -i: force boot of the Installation CDROM image"
|
|
echo " -I: Installation CDROM image location (default is ${DEFAULT_ISOFILE})"
|
|
echo " -l: the OS loader to use (default is /boot/userboot.so)"
|
|
echo " -L: IP address for UEFI GOP VNC server (default: 127.0.0.1)"
|
|
echo " -m: memory size (default is ${DEFAULT_MEMSIZE})"
|
|
echo " -p: pass-through a host PCI device at bus/slot/func (e.g. 10/0/0)"
|
|
echo " -P: UEFI GOP VNC port (default: 5900)"
|
|
echo " -t: tap device for virtio-net (default is $DEFAULT_TAPDEV)"
|
|
echo " -T: Enable tablet device (for UEFI GOP)"
|
|
echo " -u: RTC keeps UTC time"
|
|
echo " -v: Wait for VNC client connection before booting VM"
|
|
echo " -w: ignore unimplemented MSRs"
|
|
echo ""
|
|
[ -n "$msg" ] && errmsg "$msg"
|
|
exit 1
|
|
}
|
|
|
|
if [ `id -u` -ne 0 ]; then
|
|
errmsg "This script must be executed with superuser privileges"
|
|
exit 1
|
|
fi
|
|
|
|
kldstat -n vmm > /dev/null 2>&1
|
|
if [ $? -ne 0 ]; then
|
|
errmsg "vmm.ko is not loaded"
|
|
exit 1
|
|
fi
|
|
|
|
force_install=0
|
|
isofile=${DEFAULT_ISOFILE}
|
|
memsize=${DEFAULT_MEMSIZE}
|
|
console=${DEFAULT_CONSOLE}
|
|
cpus=${DEFAULT_CPUS}
|
|
tap_total=0
|
|
disk_total=0
|
|
disk_emulation="virtio-blk"
|
|
gdbport=0
|
|
loader_opt=""
|
|
bhyverun_opt="-H -A -P"
|
|
pass_total=0
|
|
|
|
# EFI-specific options
|
|
efi_mode=0
|
|
efi_firmware="/usr/local/share/uefi-firmware/BHYVE_UEFI.fd"
|
|
vncwait=""
|
|
vnchost="127.0.0.1"
|
|
vncport=5900
|
|
fbsize="w=1024,h=768"
|
|
tablet=""
|
|
|
|
while getopts aAc:C:d:e:Ef:F:g:hH:iI:l:m:p:P:t:Tuvw c ; do
|
|
case $c in
|
|
a)
|
|
bhyverun_opt="${bhyverun_opt} -a"
|
|
;;
|
|
A)
|
|
disk_emulation="ahci-hd"
|
|
;;
|
|
c)
|
|
cpus=${OPTARG}
|
|
;;
|
|
C)
|
|
console=${OPTARG}
|
|
;;
|
|
d)
|
|
disk_dev=${OPTARG%%,*}
|
|
disk_opts=${OPTARG#${disk_dev}}
|
|
eval "disk_dev${disk_total}=\"${disk_dev}\""
|
|
eval "disk_opts${disk_total}=\"${disk_opts}\""
|
|
disk_total=$(($disk_total + 1))
|
|
;;
|
|
e)
|
|
loader_opt="${loader_opt} -e ${OPTARG}"
|
|
;;
|
|
E)
|
|
efi_mode=1
|
|
;;
|
|
f)
|
|
efi_firmware="${OPTARG}"
|
|
;;
|
|
F)
|
|
fbsize="${OPTARG}"
|
|
;;
|
|
g)
|
|
gdbport=${OPTARG}
|
|
;;
|
|
H)
|
|
host_base=`realpath ${OPTARG}`
|
|
;;
|
|
i)
|
|
force_install=1
|
|
;;
|
|
I)
|
|
isofile=${OPTARG}
|
|
;;
|
|
l)
|
|
loader_opt="${loader_opt} -l ${OPTARG}"
|
|
;;
|
|
L)
|
|
vnchost="${OPTARG}"
|
|
;;
|
|
m)
|
|
memsize=${OPTARG}
|
|
;;
|
|
p)
|
|
eval "pass_dev${pass_total}=\"${OPTARG}\""
|
|
pass_total=$(($pass_total + 1))
|
|
;;
|
|
P)
|
|
vncport="${OPTARG}"
|
|
;;
|
|
t)
|
|
eval "tap_dev${tap_total}=\"${OPTARG}\""
|
|
tap_total=$(($tap_total + 1))
|
|
;;
|
|
T)
|
|
tablet="-s 30,xhci,tablet"
|
|
;;
|
|
u)
|
|
bhyverun_opt="${bhyverun_opt} -u"
|
|
;;
|
|
v)
|
|
vncwait=",wait"
|
|
;;
|
|
w)
|
|
bhyverun_opt="${bhyverun_opt} -w"
|
|
;;
|
|
*)
|
|
usage
|
|
;;
|
|
esac
|
|
done
|
|
|
|
if [ $tap_total -eq 0 ] ; then
|
|
tap_total=1
|
|
tap_dev0="${DEFAULT_TAPDEV}"
|
|
fi
|
|
if [ $disk_total -eq 0 ] ; then
|
|
disk_total=1
|
|
disk_dev0="${DEFAULT_VIRTIO_DISK}"
|
|
|
|
fi
|
|
|
|
shift $((${OPTIND} - 1))
|
|
|
|
if [ $# -ne 1 ]; then
|
|
usage "virtual machine name not specified"
|
|
fi
|
|
|
|
vmname="$1"
|
|
if [ -n "${host_base}" ]; then
|
|
loader_opt="${loader_opt} -h ${host_base}"
|
|
fi
|
|
|
|
# If PCI passthru devices are configured then guest memory must be wired
|
|
if [ ${pass_total} -gt 0 ]; then
|
|
loader_opt="${loader_opt} -S"
|
|
bhyverun_opt="${bhyverun_opt} -S"
|
|
fi
|
|
|
|
if [ ${efi_mode} -gt 0 ]; then
|
|
if [ ! -f ${efi_firmware} ]; then
|
|
echo "Error: EFI Firmware ${efi_firmware} doesn't exist. Try: pkg install uefi-edk2-bhyve"
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
make_and_check_diskdev()
|
|
{
|
|
local virtio_diskdev="$1"
|
|
# Create the virtio diskdev file if needed
|
|
if [ ! -e ${virtio_diskdev} ]; then
|
|
echo "virtio disk device file \"${virtio_diskdev}\" does not exist."
|
|
echo "Creating it ..."
|
|
truncate -s 8G ${virtio_diskdev} > /dev/null
|
|
fi
|
|
|
|
if [ ! -r ${virtio_diskdev} ]; then
|
|
echo "virtio disk device file \"${virtio_diskdev}\" is not readable"
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -w ${virtio_diskdev} ]; then
|
|
echo "virtio disk device file \"${virtio_diskdev}\" is not writable"
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
echo "Launching virtual machine \"$vmname\" ..."
|
|
|
|
first_diskdev="$disk_dev0"
|
|
|
|
${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1
|
|
|
|
while [ 1 ]; do
|
|
|
|
file -s ${first_diskdev} | grep "boot sector" > /dev/null
|
|
rc=$?
|
|
if [ $rc -ne 0 ]; then
|
|
file -s ${first_diskdev} | grep ": Unix Fast File sys" > /dev/null
|
|
rc=$?
|
|
fi
|
|
if [ $rc -ne 0 ]; then
|
|
need_install=1
|
|
else
|
|
need_install=0
|
|
fi
|
|
|
|
if [ $force_install -eq 1 -o $need_install -eq 1 ]; then
|
|
if [ ! -r ${isofile} ]; then
|
|
echo -n "Installation CDROM image \"${isofile}\" "
|
|
echo "is not readable"
|
|
exit 1
|
|
fi
|
|
BOOTDISKS="-d ${isofile}"
|
|
installer_opt="-s 31:0,ahci-cd,${isofile}"
|
|
else
|
|
BOOTDISKS=""
|
|
i=0
|
|
while [ $i -lt $disk_total ] ; do
|
|
eval "disk=\$disk_dev${i}"
|
|
if [ -r ${disk} ] ; then
|
|
BOOTDISKS="$BOOTDISKS -d ${disk} "
|
|
fi
|
|
i=$(($i + 1))
|
|
done
|
|
installer_opt=""
|
|
fi
|
|
|
|
if [ ${efi_mode} -eq 0 ]; then
|
|
${LOADER} -c ${console} -m ${memsize} ${BOOTDISKS} ${loader_opt} \
|
|
${vmname}
|
|
bhyve_exit=$?
|
|
if [ $bhyve_exit -ne 0 ]; then
|
|
break
|
|
fi
|
|
fi
|
|
|
|
#
|
|
# Build up args for additional tap and disk devices now.
|
|
#
|
|
nextslot=2 # slot 0 is hostbridge, slot 1 is lpc
|
|
devargs="" # accumulate disk/tap args here
|
|
i=0
|
|
while [ $i -lt $tap_total ] ; do
|
|
eval "tapname=\$tap_dev${i}"
|
|
devargs="$devargs -s $nextslot:0,virtio-net,${tapname} "
|
|
nextslot=$(($nextslot + 1))
|
|
i=$(($i + 1))
|
|
done
|
|
|
|
i=0
|
|
while [ $i -lt $disk_total ] ; do
|
|
eval "disk=\$disk_dev${i}"
|
|
eval "opts=\$disk_opts${i}"
|
|
make_and_check_diskdev "${disk}"
|
|
devargs="$devargs -s $nextslot:0,$disk_emulation,${disk}${opts} "
|
|
nextslot=$(($nextslot + 1))
|
|
i=$(($i + 1))
|
|
done
|
|
|
|
i=0
|
|
while [ $i -lt $pass_total ] ; do
|
|
eval "pass=\$pass_dev${i}"
|
|
devargs="$devargs -s $nextslot:0,passthru,${pass} "
|
|
nextslot=$(($nextslot + 1))
|
|
i=$(($i + 1))
|
|
done
|
|
|
|
efiargs=""
|
|
if [ ${efi_mode} -gt 0 ]; then
|
|
efiargs="-s 29,fbuf,tcp=${vnchost}:${vncport},${fbsize}${vncwait}"
|
|
efiargs="${efiargs} -l bootrom,${efi_firmware}"
|
|
efiargs="${efiargs} ${tablet}"
|
|
fi
|
|
|
|
${FBSDRUN} -c ${cpus} -m ${memsize} ${bhyverun_opt} \
|
|
-g ${gdbport} \
|
|
-s 0:0,hostbridge \
|
|
-s 1:0,lpc \
|
|
${efiargs} \
|
|
${devargs} \
|
|
-l com1,${console} \
|
|
${installer_opt} \
|
|
${vmname}
|
|
|
|
bhyve_exit=$?
|
|
# bhyve returns the following status codes:
|
|
# 0 - VM has been reset
|
|
# 1 - VM has been powered off
|
|
# 2 - VM has been halted
|
|
# 3 - VM generated a triple fault
|
|
# all other non-zero status codes are errors
|
|
#
|
|
if [ $bhyve_exit -ne 0 ]; then
|
|
break
|
|
fi
|
|
done
|
|
|
|
|
|
case $bhyve_exit in
|
|
0|1|2)
|
|
# Cleanup /dev/vmm entry when bhyve did not exit
|
|
# due to an error.
|
|
${BHYVECTL} --vm=${vmname} --destroy > /dev/null 2>&1
|
|
;;
|
|
esac
|
|
|
|
exit $bhyve_exit
|