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