1.\" Copyright (c) 2013 Peter Grehan 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd January 27, 2014 28.Dt BHYVE 8 29.Os 30.Sh NAME 31.Nm bhyve 32.Nd "run a guest operating system inside a virtual machine" 33.Sh SYNOPSIS 34.Nm 35.Op Fl aehwAHPW 36.Op Fl c Ar numcpus 37.Op Fl g Ar gdbport 38.Op Fl p Ar pinnedcpu 39.Op Fl s Ar slot,emulation Ns Op , Ns Ar conf 40.Op Fl l Ar lpcdev Ns Op , Ns Ar conf 41.Ar vmname 42.Sh DESCRIPTION 43.Nm 44is an experimental hypervisor that runs guest operating systems inside a 45virtual machine. 46.Pp 47Parameters such as the number of virtual CPUs, amount of guest memory, and 48I/O connectivity can be specified with command-line parameters. 49.Pp 50The guest operating system must be loaded with 51.Xr bhyveload 4 52or a similar boot loader before running 53.Nm . 54.Pp 55.Nm 56runs until the guest operating system reboots or an unhandled hypervisor 57exit is detected. 58.Sh OPTIONS 59.Bl -tag -width 10n 60.It Fl a 61Disallow use of the local APIC in X2APIC mode. 62.It Fl A 63Generate ACPI tables. 64Required for 65.Fx Ns /amd64 66guests. 67.It Fl c Ar numcpus 68Number of guest virtual CPUs. 69The default is 1 and the maximum is 16. 70.It Fl H 71Yield the virtual CPU thread when a HLT instruction is detected. 72If this option is not specified, virtual CPUs will use 100% of a host CPU. 73.It Fl g Ar gdbport 74For 75.Fx Ns /amd64 kernels compiled with 76.Cd "option bvmdebug" , 77allow a remote kernel kgdb to be relayed to the guest kernel gdb stub 78via a local IPv4 address and this port. 79This option will be deprecated in a future version. 80.It Fl p Ar pinnedcpu 81Force guest virtual CPUs to be pinned to host CPUs. 82Virtual CPU 83.Em n 84is pinned to host CPU 85.Em pinnedcpu+n . 86.It Fl P 87Force the guest virtual CPU to exit when a PAUSE instruction is detected. 88.It Fl W 89Force virtio PCI device emulations to use MSI interrupts instead of MSI-X 90interrupts. 91.It Fl s Ar slot,emulation Ns Op , Ns Ar conf 92Configure a virtual PCI slot and function. 93.Pp 94.Nm bhyve 95provides PCI bus emulation and virtual devices that can be attached to 96slots on the bus. 97There are 32 available slots, with the option of providing up to 8 functions 98per slot. 99.Bl -tag -width 10n 100.It Ar slot 101.Ar pcislot Ns Op Ar :function 102.Pp 103The 104.Ar pcislot 105value is 0 to 31 and the optional function value is 0 to 7. 106If not specified, the function value defaults to 0. 107.It Ar emulation 108.Bl -tag -width 10n 109.It Li hostbridge | Li amd_hostbridge 110.Pp 111Provide a simple host bridge. 112This is usually configured at slot 0, and is required by most guest 113operating systems. 114The 115.Li amd_hostbridge 116emulation is identical but uses a PCI vendor ID of 117.Li AMD . 118.It Li passthru 119PCI pass-through device. 120.It Li virtio-net 121Virtio network interface. 122.It Li virtio-blk 123Virtio block storage interface. 124.It Li ahci-cd 125AHCI controller attached to an ATAPI CD/DVD. 126.It Li ahci-hd 127AHCI controller attached to a SATA hard-drive. 128.It Li uart 129PCI 16550 serial device. 130.It Li lpc 131LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports. 132.El 133.It Op Ar conf 134This optional parameter describes the backend for device emulations. 135If 136.Ar conf 137is not specified, the device emulation has no backend and can be 138considered unconnected. 139.Pp 140Network devices: 141.Bl -tag -width 10n 142.It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx 143.It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx 144.Pp 145If 146.Ar mac 147is not specified, the MAC address is derived from a fixed OUI and the 148remaining bytes from an MD5 hash of the slot and function numbers and 149the device name. 150.Pp 151The MAC address is an ASCII string in 152.Xr ethers 5 153format. 154.El 155.Pp 156Block storage devices: 157.Bl -tag -width 10n 158.It Pa /filename Ns Oo , Ns Li nocache Oc Ns Oo , Ns Li direct Oc Ns Oo , Ns Li ro Oc 159.It Pa /dev/xxx Ns Oo , Ns Ar nocache Oc Ns Oo , Ns Ar direct Oc Ns Oo , Ns Ar ro Oc 160.Bl -tag -width 8n 161.It Li nocache 162Open the file with 163.Dv O_DIRECT . 164.It Li direct 165Open the file using 166.Dv O_SYNC . 167.It Li ro 168Force the file to be opened read-only. 169.El 170.Pp 171The 172.Li nocache , 173.Li direct , 174and 175.Li ro 176options are not available for virtio block devices. 177.El 178.Pp 179TTY devices: 180.Bl -tag -width 10n 181.It Li stdio 182Connect the serial port to the standard input and output of 183the bhyve process. 184.It Pa /dev/xxx 185Use the host TTY device for serial port I/O. 186.El 187.Pp 188Pass-through devices: 189.Bl -tag -width 10n 190.It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function 191Connect to a PCI device on the host at the selector described by 192.Ar slot , 193.Ar bus , 194and 195.Ar function 196numbers. 197.El 198.Pp 199The host device must have been reserved at boot-time using the 200.Va pptdev 201loader variable as described in 202.Xr vmm 4 . 203.El 204.It Fl l Ar lpcdev Ns Op , Ns Ar conf 205Allow devices behind the LPC PCI-ISA bridge to be configured. 206The only supported devices are the TTY-class devices, 207.Li com1 208and 209.Li com2 . 210.It Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t 211Guest physical memory size in bytes. 212This must be the same size that was given to 213.Xr bhyveload 8 . 214.Pp 215The size argument may be suffixed with one of K, M, G or T (either upper 216or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes, 217or terabytes. 218If no suffix is given, the value is assumed to be in megabytes. 219.It Fl e 220Force 221.Nm 222to exit when a guest issues an access to an I/O port that is not emulated. 223This is intended for debug purposes. 224.It Fl w 225Ignore accesses to unimplemented Model Specific Registers (MSRs). This is intended for debug purposes. 226.It Fl h 227Print help message and exit. 228.It Ar vmname 229Alphanumeric name of the guest. 230This should be the same as that created by 231.Xr bhyveload 8 . 232.El 233.Sh EXAMPLES 234The guest operating system must have been loaded with 235.Xr bhyveload 4 236or a similar boot loader before 237.Xr bhyve 4 238can be run. 239.Pp 240To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio 241block device backed by the 242.Pa /my/image 243filesystem image, and a serial port for the console: 244.Bd -literal -offset indent 245bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\ 246 -l com1,stdio -A -H -P -m 1G vm1 247.Ed 248.Pp 249Run a 24GB single-CPU virtual machine with three network ports, one of which 250has a MAC address specified: 251.Bd -literal -offset indent 252bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\ 253 -s 2:1,virtio-net,tap1 \\ 254 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\ 255 -s 3,virtio-blk,/my/image -l com1,stdio \\ 256 -A -H -P -m 24G bigvm 257.Ed 258.Pp 259Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI 260CD-ROM, a single virtio network port, an AMD hostbridge, and the console 261port connected to an 262.Xr nmdm 4 263null-model device. 264.Bd -literal -offset indent 265bhyve -c 4 \e\ 266 -s 0,amd_hostbridge -s 1,lpc \\ 267 -s 1:0,ahci-hd,/images/disk.1 \\ 268 -s 1:1,ahci-hd,/images/disk.2 \\ 269 -s 1:2,ahci-hd,/images/disk.3 \\ 270 -s 1:3,ahci-hd,/images/disk.4 \\ 271 -s 1:4,ahci-hd,/images/disk.5 \\ 272 -s 1:5,ahci-hd,/images/disk.6 \\ 273 -s 1:6,ahci-hd,/images/disk.7 \\ 274 -s 1:7,ahci-hd,/images/disk.8 \\ 275 -s 2,ahci-cd,/images.install.iso \\ 276 -s 3,virtio-net,tap0 \\ 277 -l com1,/dev/nmdm0A \\ 278 -A -H -P -m 8G 279.Ed 280.Sh SEE ALSO 281.Xr bhyve 4 , 282.Xr nmdm 4 , 283.Xr vmm 4 , 284.Xr ethers 5 , 285.Xr bhyvectl 8 , 286.Xr bhyveload 8 287.Sh HISTORY 288.Nm 289first appeared in 290.Fx 10.0 . 291.Sh AUTHORS 292.An Neel Natu Aq neel@freebsd.org 293.An Peter Grehan Aq grehan@freebsd.org 294