usr.sbin/bhyve/bhyve.8

   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 aehwxAHPW
  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
  44 is an experimental hypervisor that runs guest operating systems inside a
  45 virtual machine.
  46 .Pp
  47 Parameters such as the number of virtual CPUs, amount of guest memory, and
  48 I/O connectivity can be specified with command-line parameters.
  49 .Pp
  50 The guest operating system must be loaded with
  51 .Xr bhyveload 4
  52 or a similar boot loader before running
  53 .Nm .
  54 .Pp
  55 .Nm
  56 runs until the guest operating system reboots or an unhandled hypervisor
  57 exit is detected.
  58 .Sh OPTIONS
  59 .Bl -tag -width 10n
  60 .It Fl a
  61 The guest's local APIC is configured in xAPIC mode.
  62
  63 The xAPIC mode is the default setting so this option is redundant. It will be
  64 deprecated in a future version.
  65 .It Fl A
  66 Generate ACPI tables.
  67 Required for
  68 .Fx Ns /amd64
  69 guests.
  70 .It Fl c Ar numcpus
  71 Number of guest virtual CPUs.
  72 The default is 1 and the maximum is 16.
  73 .It Fl H
  74 Yield the virtual CPU thread when a HLT instruction is detected.
  75 If this option is not specified, virtual CPUs will use 100% of a host CPU.
  76 .It Fl g Ar gdbport
  77 For
  78 .Fx Ns /amd64 kernels compiled with
  79 .Cd "option bvmdebug" ,
  80 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
  81 via a local IPv4 address and this port.
  82 This option will be deprecated in a future version.
  83 .It Fl p Ar pinnedcpu
  84 Force guest virtual CPUs to be pinned to host CPUs.
  85 Virtual CPU
  86 .Em n
  87 is pinned to host CPU
  88 .Em pinnedcpu+n .
  89 .It Fl P
  90 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
  91 .It Fl W
  92 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
  93 interrupts.
  94 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
  95 Configure a virtual PCI slot and function.
  96 .Pp
  97 .Nm bhyve
  98 provides PCI bus emulation and virtual devices that can be attached to
  99 slots on the bus.
 100 There are 32 available slots, with the option of providing up to 8 functions
 101 per slot.
 102 .Bl -tag -width 10n
 103 .It Ar slot
 104 .Ar pcislot[:function]
 105
 106 .Ar bus:pcislot:function
 107 .Pp
 108 The
 109 .Ar pcislot
 110 value is 0 to 31. The optional function value is 0 to 7. The optional
 111 .Ar bus
 112 value is 0 to 255.
 113 If not specified, the function value defaults to 0.
 114 If not specified, the bus value defaults to 0.
 115 .It Ar emulation
 116 .Bl -tag -width 10n
 117 .It Li hostbridge | Li amd_hostbridge
 118 .Pp
 119 Provide a simple host bridge.
 120 This is usually configured at slot 0, and is required by most guest
 121 operating systems.
 122 The
 123 .Li amd_hostbridge
 124 emulation is identical but uses a PCI vendor ID of
 125 .Li AMD .
 126 .It Li passthru
 127 PCI pass-through device.
 128 .It Li virtio-net
 129 Virtio network interface.
 130 .It Li virtio-blk
 131 Virtio block storage interface.
 132 .It Li ahci-cd
 133 AHCI controller attached to an ATAPI CD/DVD.
 134 .It Li ahci-hd
 135 AHCI controller attached to a SATA hard-drive.
 136 .It Li uart
 137 PCI 16550 serial device.
 138 .It Li lpc
 139 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports. The LPC bridge
 140 emulation can only be configured on bus 0.
 141 .El
 142 .It Op Ar conf
 143 This optional parameter describes the backend for device emulations.
 144 If
 145 .Ar conf
 146 is not specified, the device emulation has no backend and can be
 147 considered unconnected.
 148 .Pp
 149 Network devices:
 150 .Bl -tag -width 10n
 151 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 152 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 153 .Pp
 154 If
 155 .Ar mac
 156 is not specified, the MAC address is derived from a fixed OUI and the
 157 remaining bytes from an MD5 hash of the slot and function numbers and
 158 the device name.
 159 .Pp
 160 The MAC address is an ASCII string in
 161 .Xr ethers 5
 162 format.
 163 .El
 164 .Pp
 165 Block storage devices:
 166 .Bl -tag -width 10n
 167 .It Pa /filename Ns Oo , Ns Li nocache Oc Ns Oo , Ns Li direct Oc Ns Oo , Ns Li ro Oc
 168 .It Pa /dev/xxx Ns Oo , Ns Ar nocache Oc Ns Oo , Ns Ar direct Oc Ns Oo , Ns Ar ro Oc
 169 .Bl -tag -width 8n
 170 .It Li nocache
 171 Open the file with
 172 .Dv O_DIRECT .
 173 .It Li direct
 174 Open the file using
 175 .Dv O_SYNC .
 176 .It Li ro
 177 Force the file to be opened read-only.
 178 .El
 179 .Pp
 180 The
 181 .Li nocache ,
 182 .Li direct ,
 183 and
 184 .Li ro
 185 options are not available for virtio block devices.
 186 .El
 187 .Pp
 188 TTY devices:
 189 .Bl -tag -width 10n
 190 .It Li stdio
 191 Connect the serial port to the standard input and output of
 192 the bhyve process.
 193 .It Pa /dev/xxx
 194 Use the host TTY device for serial port I/O.
 195 .El
 196 .Pp
 197 Pass-through devices:
 198 .Bl -tag -width 10n
 199 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 200 Connect to a PCI device on the host at the selector described by
 201 .Ar slot ,
 202 .Ar bus ,
 203 and
 204 .Ar function
 205 numbers.
 206 .El
 207 .Pp
 208 The host device must have been reserved at boot-time using the
 209 .Va pptdev
 210 loader variable as described in
 211 .Xr vmm 4 .
 212 .El
 213 .It Fl l Ar lpcdev Ns Op , Ns Ar conf
 214 Allow devices behind the LPC PCI-ISA bridge to be configured.
 215 The only supported devices are the TTY-class devices,
 216 .Li com1
 217 and
 218 .Li com2 .
 219 .It Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
 220 Guest physical memory size in bytes.
 221 This must be the same size that was given to
 222 .Xr bhyveload 8 .
 223 .Pp
 224 The size argument may be suffixed with one of K, M, G or T (either upper
 225 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
 226 or terabytes.
 227 If no suffix is given, the value is assumed to be in megabytes.
 228 .It Fl e
 229 Force
 230 .Nm
 231 to exit when a guest issues an access to an I/O port that is not emulated.
 232 This is intended for debug purposes.
 233 .It Fl w
 234 Ignore accesses to unimplemented Model Specific Registers (MSRs). This is intended for debug purposes.
 235 .It Fl x
 236 The guest's local APIC is configured in x2APIC mode.
 237 .It Fl h
 238 Print help message and exit.
 239 .It Ar vmname
 240 Alphanumeric name of the guest.
 241 This should be the same as that created by
 242 .Xr bhyveload 8 .
 243 .El
 244 .Sh EXAMPLES
 245 The guest operating system must have been loaded with
 246 .Xr bhyveload 4
 247 or a similar boot loader before
 248 .Xr bhyve 4
 249 can be run.
 250 .Pp
 251 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 252 block device backed by the
 253 .Pa /my/image
 254 filesystem image, and a serial port for the console:
 255 .Bd -literal -offset indent
 256 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
 257   -l com1,stdio -A -H -P -m 1G vm1
 258 .Ed
 259 .Pp
 260 Run a 24GB single-CPU virtual machine with three network ports, one of which
 261 has a MAC address specified:
 262 .Bd -literal -offset indent
 263 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
 264   -s 2:1,virtio-net,tap1 \\
 265   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
 266   -s 3,virtio-blk,/my/image -l com1,stdio \\
 267   -A -H -P -m 24G bigvm
 268 .Ed
 269 .Pp
 270 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 271 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 272 port connected to an
 273 .Xr nmdm 4
 274 null-model device.
 275 .Bd -literal -offset indent
 276 bhyve -c 4 \e\
 277   -s 0,amd_hostbridge -s 1,lpc \\
 278   -s 1:0,ahci-hd,/images/disk.1 \\
 279   -s 1:1,ahci-hd,/images/disk.2 \\
 280   -s 1:2,ahci-hd,/images/disk.3 \\
 281   -s 1:3,ahci-hd,/images/disk.4 \\
 282   -s 1:4,ahci-hd,/images/disk.5 \\
 283   -s 1:5,ahci-hd,/images/disk.6 \\
 284   -s 1:6,ahci-hd,/images/disk.7 \\
 285   -s 1:7,ahci-hd,/images/disk.8 \\
 286   -s 2,ahci-cd,/images.install.iso \\
 287   -s 3,virtio-net,tap0 \\
 288   -l com1,/dev/nmdm0A \\
 289   -A -H -P -m 8G
 290 .Ed
 291 .Sh SEE ALSO
 292 .Xr bhyve 4 ,
 293 .Xr nmdm 4 ,
 294 .Xr vmm 4 ,
 295 .Xr ethers 5 ,
 296 .Xr bhyvectl 8 ,
 297 .Xr bhyveload 8
 298 .Sh HISTORY
 299 .Nm
 300 first appeared in
 301 .Fx 10.0 .
 302 .Sh AUTHORS
 303 .An Neel Natu Aq neel@freebsd.org
 304 .An Peter Grehan Aq grehan@freebsd.org