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