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 February 27, 2017
  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 memsize 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 memsize 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 .Pp
 118 .Ar memsize
 119 defaults to 256M.
 120 .It Fl p Ar vcpu:hostcpu
 121 Pin guest's virtual CPU
 122 .Em vcpu
 123 to
 124 .Em hostcpu .
 125 .It Fl P
 126 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
 127 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
 128 Configure a virtual PCI slot and function.
 129 .Pp
 130 .Nm
 131 provides PCI bus emulation and virtual devices that can be attached to
 132 slots on the bus.
 133 There are 32 available slots, with the option of providing up to 8 functions
 134 per slot.
 135 .Bl -tag -width 10n
 136 .It Ar slot
 137 .Ar pcislot[:function]
 138 .Ar bus:pcislot:function
 139 .Pp
 140 The
 141 .Ar pcislot
 142 value is 0 to 31.
 143 The optional
 144 .Ar function
 145 value is 0 to 7.
 146 The optional
 147 .Ar bus
 148 value is 0 to 255.
 149 If not specified, the
 150 .Ar function
 151 value defaults to 0.
 152 If not specified, the
 153 .Ar bus
 154 value defaults to 0.
 155 .It Ar emulation
 156 .Bl -tag -width 10n
 157 .It Li hostbridge | Li amd_hostbridge
 158 .Pp
 159 Provide a simple host bridge.
 160 This is usually configured at slot 0, and is required by most guest
 161 operating systems.
 162 The
 163 .Li amd_hostbridge
 164 emulation is identical but uses a PCI vendor ID of
 165 .Li AMD .
 166 .It Li passthru
 167 PCI pass-through device.
 168 .It Li virtio-net
 169 Virtio network interface.
 170 .It Li virtio-blk
 171 Virtio block storage interface.
 172 .It Li virtio-rnd
 173 Virtio RNG interface.
 174 .It Li virtio-console
 175 Virtio console interface, which exposes multiple ports
 176 to the guest in the form of simple char devices for simple IO
 177 between the guest and host userspaces.
 178 .It Li ahci
 179 AHCI controller attached to arbitrary devices.
 180 .It Li ahci-cd
 181 AHCI controller attached to an ATAPI CD/DVD.
 182 .It Li ahci-hd
 183 AHCI controller attached to a SATA hard-drive.
 184 .It Li e1000
 185 Intel e82545 network interface.
 186 .It Li uart
 187 PCI 16550 serial device.
 188 .It Li lpc
 189 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
 190 The LPC bridge emulation can only be configured on bus 0.
 191 .El
 192 .It Op Ar conf
 193 This optional parameter describes the backend for device emulations.
 194 If
 195 .Ar conf
 196 is not specified, the device emulation has no backend and can be
 197 considered unconnected.
 198 .Pp
 199 Network devices:
 200 .Bl -tag -width 10n
 201 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 202 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 203 .Pp
 204 If
 205 .Ar mac
 206 is not specified, the MAC address is derived from a fixed OUI and the
 207 remaining bytes from an MD5 hash of the slot and function numbers and
 208 the device name.
 209 .Pp
 210 The MAC address is an ASCII string in
 211 .Xr ethers 5
 212 format.
 213 .El
 214 .Pp
 215 Block storage devices:
 216 .Bl -tag -width 10n
 217 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
 218 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
 219 .El
 220 .Pp
 221 The
 222 .Ar block-device-options
 223 are:
 224 .Bl -tag -width 8n
 225 .It Li nocache
 226 Open the file with
 227 .Dv O_DIRECT .
 228 .It Li direct
 229 Open the file using
 230 .Dv O_SYNC .
 231 .It Li ro
 232 Force the file to be opened read-only.
 233 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
 234 Specify the logical and physical sector sizes of the emulated disk.
 235 The physical sector size is optional and is equal to the logical sector size
 236 if not explicitly specified.
 237 .El
 238 .Pp
 239 TTY devices:
 240 .Bl -tag -width 10n
 241 .It Li stdio
 242 Connect the serial port to the standard input and output of
 243 the
 244 .Nm
 245 process.
 246 .It Pa /dev/xxx
 247 Use the host TTY device for serial port I/O.
 248 .El
 249 .Pp
 250 Boot ROM device:
 251 .Bl -tag -width 10n
 252 .It Pa romfile
 253 Map
 254 .Ar romfile
 255 in the guest address space reserved for boot firmware.
 256 .El
 257 .Pp
 258 Pass-through devices:
 259 .Bl -tag -width 10n
 260 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 261 Connect to a PCI device on the host at the selector described by
 262 .Ar slot ,
 263 .Ar bus ,
 264 and
 265 .Ar function
 266 numbers.
 267 .El
 268 .Pp
 269 Guest memory must be wired using the
 270 .Fl S
 271 option when a pass-through device is configured.
 272 .Pp
 273 The host device must have been reserved at boot-time using the
 274 .Va pptdev
 275 loader variable as described in
 276 .Xr vmm 4 .
 277 .Pp
 278 Virtio console devices:
 279 .Bl -tag -width 10n
 280 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
 281 A maximum of 16 ports per device can be created.
 282 Every port is named and corresponds to a Unix domain socket created by
 283 .Nm .
 284 .Nm
 285 accepts at most one connection per port at a time.
 286 .Pp
 287 Limitations:
 288 .Bl -bullet -offset 2n
 289 .It
 290 Due to lack of destructors in
 291 .Nm ,
 292 sockets on the filesystem must be cleaned up manually after
 293 .Nm
 294 exits.
 295 .It
 296 There is no way to use the "console port" feature, nor the console port
 297 resize at present.
 298 .It
 299 Emergency write is advertised, but no-op at present.
 300 .El
 301 .El
 302 .El
 303 .It Fl S
 304 Wire guest memory.
 305 .It Fl u
 306 RTC keeps UTC time.
 307 .It Fl U Ar uuid
 308 Set the universally unique identifier
 309 .Pq UUID
 310 in the guest's System Management BIOS System Information structure.
 311 By default a UUID is generated from the host's hostname and
 312 .Ar vmname .
 313 .It Fl w
 314 Ignore accesses to unimplemented Model Specific Registers (MSRs).
 315 This is intended for debug purposes.
 316 .It Fl W
 317 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
 318 interrupts.
 319 .It Fl x
 320 The guest's local APIC is configured in x2APIC mode.
 321 .It Fl Y
 322 Disable MPtable generation.
 323 .It Ar vmname
 324 Alphanumeric name of the guest.
 325 This should be the same as that created by
 326 .Xr bhyveload 8 .
 327 .El
 328 .Sh SIGNAL HANDLING
 329 .Nm
 330 deals with the following signals:
 331 .Pp
 332 .Bl -tag -width indent -compact
 333 .It SIGTERM
 334 Trigger ACPI poweroff for a VM
 335 .El
 336 .Sh EXIT STATUS
 337 Exit status indicates how the VM was terminated:
 338 .Pp
 339 .Bl -tag -width indent -compact
 340 .It 0
 341 rebooted
 342 .It 1
 343 powered off
 344 .It 2
 345 halted
 346 .It 3
 347 triple fault
 348 .El
 349 .Sh EXAMPLES
 350 The guest operating system must have been loaded with
 351 .Xr bhyveload 8
 352 or a similar boot loader before
 353 .Xr bhyve 4
 354 can be run.
 355 .Pp
 356 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 357 block device backed by the
 358 .Pa /my/image
 359 filesystem image, and a serial port for the console:
 360 .Bd -literal -offset indent
 361 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
 362   -l com1,stdio -A -H -P -m 1G vm1
 363 .Ed
 364 .Pp
 365 Run a 24GB single-CPU virtual machine with three network ports, one of which
 366 has a MAC address specified:
 367 .Bd -literal -offset indent
 368 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
 369   -s 2:1,virtio-net,tap1 \\
 370   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
 371   -s 3,virtio-blk,/my/image -l com1,stdio \\
 372   -A -H -P -m 24G bigvm
 373 .Ed
 374 .Pp
 375 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 376 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 377 port connected to an
 378 .Xr nmdm 4
 379 null-modem device.
 380 .Bd -literal -offset indent
 381 bhyve -c 4 \\
 382   -s 0,amd_hostbridge -s 1,lpc \\
 383   -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
 384 hd:/images/disk.3,hd:/images/disk.4,\\
 385 hd:/images/disk.5,hd:/images/disk.6,\\
 386 hd:/images/disk.7,hd:/images/disk.8,\\
 387 cd:/images/install.iso \\
 388   -s 3,virtio-net,tap0 \\
 389   -l com1,/dev/nmdm0A \\
 390   -A -H -P -m 8G
 391 .Ed
 392 .Sh SEE ALSO
 393 .Xr bhyve 4 ,
 394 .Xr nmdm 4 ,
 395 .Xr vmm 4 ,
 396 .Xr ethers 5 ,
 397 .Xr bhyvectl 8 ,
 398 .Xr bhyveload 8
 399 .Sh HISTORY
 400 .Nm
 401 first appeared in
 402 .Fx 10.0 .
 403 .Sh AUTHORS
 404 .An Neel Natu Aq Mt neel@freebsd.org
 405 .An Peter Grehan Aq Mt grehan@freebsd.org