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