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[:function] 102 103.Ar bus:pcislot:function 104.Pp 105The 106.Ar pcislot 107value is 0 to 31. The optional function value is 0 to 7. The optional 108.Ar bus 109value is 0 to 255. 110If not specified, the function value defaults to 0. 111If not specified, the bus value defaults to 0. 112.It Ar emulation 113.Bl -tag -width 10n 114.It Li hostbridge | Li amd_hostbridge 115.Pp 116Provide a simple host bridge. 117This is usually configured at slot 0, and is required by most guest 118operating systems. 119The 120.Li amd_hostbridge 121emulation is identical but uses a PCI vendor ID of 122.Li AMD . 123.It Li passthru 124PCI pass-through device. 125.It Li virtio-net 126Virtio network interface. 127.It Li virtio-blk 128Virtio block storage interface. 129.It Li ahci-cd 130AHCI controller attached to an ATAPI CD/DVD. 131.It Li ahci-hd 132AHCI controller attached to a SATA hard-drive. 133.It Li uart 134PCI 16550 serial device. 135.It Li lpc 136LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports. The LPC bridge 137emulation can only be configured on bus 0. 138.El 139.It Op Ar conf 140This optional parameter describes the backend for device emulations. 141If 142.Ar conf 143is not specified, the device emulation has no backend and can be 144considered unconnected. 145.Pp 146Network devices: 147.Bl -tag -width 10n 148.It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx 149.It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx 150.Pp 151If 152.Ar mac 153is not specified, the MAC address is derived from a fixed OUI and the 154remaining bytes from an MD5 hash of the slot and function numbers and 155the device name. 156.Pp 157The MAC address is an ASCII string in 158.Xr ethers 5 159format. 160.El 161.Pp 162Block storage devices: 163.Bl -tag -width 10n 164.It Pa /filename Ns Oo , Ns Li nocache Oc Ns Oo , Ns Li direct Oc Ns Oo , Ns Li ro Oc 165.It Pa /dev/xxx Ns Oo , Ns Ar nocache Oc Ns Oo , Ns Ar direct Oc Ns Oo , Ns Ar ro Oc 166.Bl -tag -width 8n 167.It Li nocache 168Open the file with 169.Dv O_DIRECT . 170.It Li direct 171Open the file using 172.Dv O_SYNC . 173.It Li ro 174Force the file to be opened read-only. 175.El 176.Pp 177The 178.Li nocache , 179.Li direct , 180and 181.Li ro 182options are not available for virtio block devices. 183.El 184.Pp 185TTY devices: 186.Bl -tag -width 10n 187.It Li stdio 188Connect the serial port to the standard input and output of 189the bhyve process. 190.It Pa /dev/xxx 191Use the host TTY device for serial port I/O. 192.El 193.Pp 194Pass-through devices: 195.Bl -tag -width 10n 196.It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function 197Connect to a PCI device on the host at the selector described by 198.Ar slot , 199.Ar bus , 200and 201.Ar function 202numbers. 203.El 204.Pp 205The host device must have been reserved at boot-time using the 206.Va pptdev 207loader variable as described in 208.Xr vmm 4 . 209.El 210.It Fl l Ar lpcdev Ns Op , Ns Ar conf 211Allow devices behind the LPC PCI-ISA bridge to be configured. 212The only supported devices are the TTY-class devices, 213.Li com1 214and 215.Li com2 . 216.It Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t 217Guest physical memory size in bytes. 218This must be the same size that was given to 219.Xr bhyveload 8 . 220.Pp 221The size argument may be suffixed with one of K, M, G or T (either upper 222or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes, 223or terabytes. 224If no suffix is given, the value is assumed to be in megabytes. 225.It Fl e 226Force 227.Nm 228to exit when a guest issues an access to an I/O port that is not emulated. 229This is intended for debug purposes. 230.It Fl w 231Ignore accesses to unimplemented Model Specific Registers (MSRs). This is intended for debug purposes. 232.It Fl h 233Print help message and exit. 234.It Ar vmname 235Alphanumeric name of the guest. 236This should be the same as that created by 237.Xr bhyveload 8 . 238.El 239.Sh EXAMPLES 240The guest operating system must have been loaded with 241.Xr bhyveload 4 242or a similar boot loader before 243.Xr bhyve 4 244can be run. 245.Pp 246To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio 247block device backed by the 248.Pa /my/image 249filesystem image, and a serial port for the console: 250.Bd -literal -offset indent 251bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\ 252 -l com1,stdio -A -H -P -m 1G vm1 253.Ed 254.Pp 255Run a 24GB single-CPU virtual machine with three network ports, one of which 256has a MAC address specified: 257.Bd -literal -offset indent 258bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\ 259 -s 2:1,virtio-net,tap1 \\ 260 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\ 261 -s 3,virtio-blk,/my/image -l com1,stdio \\ 262 -A -H -P -m 24G bigvm 263.Ed 264.Pp 265Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI 266CD-ROM, a single virtio network port, an AMD hostbridge, and the console 267port connected to an 268.Xr nmdm 4 269null-model device. 270.Bd -literal -offset indent 271bhyve -c 4 \e\ 272 -s 0,amd_hostbridge -s 1,lpc \\ 273 -s 1:0,ahci-hd,/images/disk.1 \\ 274 -s 1:1,ahci-hd,/images/disk.2 \\ 275 -s 1:2,ahci-hd,/images/disk.3 \\ 276 -s 1:3,ahci-hd,/images/disk.4 \\ 277 -s 1:4,ahci-hd,/images/disk.5 \\ 278 -s 1:5,ahci-hd,/images/disk.6 \\ 279 -s 1:6,ahci-hd,/images/disk.7 \\ 280 -s 1:7,ahci-hd,/images/disk.8 \\ 281 -s 2,ahci-cd,/images.install.iso \\ 282 -s 3,virtio-net,tap0 \\ 283 -l com1,/dev/nmdm0A \\ 284 -A -H -P -m 8G 285.Ed 286.Sh SEE ALSO 287.Xr bhyve 4 , 288.Xr nmdm 4 , 289.Xr vmm 4 , 290.Xr ethers 5 , 291.Xr bhyvectl 8 , 292.Xr bhyveload 8 293.Sh HISTORY 294.Nm 295first appeared in 296.Fx 10.0 . 297.Sh AUTHORS 298.An Neel Natu Aq neel@freebsd.org 299.An Peter Grehan Aq grehan@freebsd.org 300