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 May 1, 2018
  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 .Oo
  37 .Fl c\~ Ns
  38 .Oo
  39 .Op Ar cpus= Ns
  40 .Ar numcpus Ns
  41 .Oc Ns
  42 .Op Ar ,sockets=n Ns
  43 .Op Ar ,cores=n Ns
  44 .Op Ar ,threads=n
  45 .Oc
  46 .Op Fl g Ar gdbport
  47 .Op Fl l Ar lpcdev Ns Op , Ns Ar conf
  48 .Op Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
  49 .Op Fl p Ar vcpu:hostcpu
  50 .Op Fl s Ar slot,emulation Ns Op , Ns Ar conf
  51 .Op Fl G Ar port
  52 .Op Fl U Ar uuid
  53 .Ar vmname
  54 .Sh DESCRIPTION
  55 .Nm
  56 is a hypervisor that runs guest operating systems inside a
  57 virtual machine.
  58 .Pp
  59 Parameters such as the number of virtual CPUs, amount of guest memory, and
  60 I/O connectivity can be specified with command-line parameters.
  61 .Pp
  62 If not using a boot ROM, the guest operating system must be loaded with
  63 .Xr bhyveload 8
  64 or a similar boot loader before running
  65 .Nm ,
  66 otherwise, it is enough to run
  67 .Nm
  68 with a boot ROM of choice.
  69 .Pp
  70 .Nm
  71 runs until the guest operating system reboots or an unhandled hypervisor
  72 exit is detected.
  73 .Sh OPTIONS
  74 .Bl -tag -width 10n
  75 .It Fl a
  76 The guest's local APIC is configured in xAPIC mode.
  77 The xAPIC mode is the default setting so this option is redundant.
  78 It will be deprecated in a future version.
  79 .It Fl A
  80 Generate ACPI tables.
  81 Required for
  82 .Fx Ns /amd64
  83 guests.
  84 .It Fl b
  85 Enable a low-level console device supported by
  86 .Fx
  87 kernels compiled with
  88 .Cd "device bvmconsole" .
  89 This option will be deprecated in a future version.
  90 .It Fl c Op Ar setting ...
  91 Number of guest virtual CPUs
  92 and/or the CPU topology.
  93 The default value for each of
  94 .Ar numcpus ,
  95 .Ar sockets ,
  96 .Ar cores ,
  97 and
  98 .Ar threads
  99 is 1.
 100 The current maximum number of guest virtual CPUs is 16.
 101 If
 102 .Ar numcpus
 103 is not specified then it will be calculated from the other arguments.
 104 The topology must be consistent in that the
 105 .Ar numcpus
 106 must equal the product of
 107 .Ar sockets ,
 108 .Ar cores ,
 109 and
 110 .Ar threads .
 111 If a
 112 .Ar setting
 113 is specified more than once the last one has precedence.
 114 .It Fl C
 115 Include guest memory in core file.
 116 .It Fl e
 117 Force
 118 .Nm
 119 to exit when a guest issues an access to an I/O port that is not emulated.
 120 This is intended for debug purposes.
 121 .It Fl g Ar gdbport
 122 For
 123 .Fx
 124 kernels compiled with
 125 .Cd "device bvmdebug" ,
 126 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
 127 via a local IPv4 address and this port.
 128 This option will be deprecated in a future version.
 129 .It Fl G Ar port
 130 Start a debug server that uses the GDB protocol to export guest state to a
 131 debugger.
 132 An IPv4 TCP socket will be bound to the supplied
 133 .Ar port
 134 to listen for debugger connections.
 135 Only a single debugger may be attached to the debug server at a time.
 136 If
 137 .Ar port
 138 begins with
 139 .Sq w ,
 140 .Nm
 141 will pause execution at the first instruction waiting for a debugger to attach.
 142 .It Fl h
 143 Print help message and exit.
 144 .It Fl H
 145 Yield the virtual CPU thread when a HLT instruction is detected.
 146 If this option is not specified, virtual CPUs will use 100% of a host CPU.
 147 .It Fl l Ar lpcdev Ns Op , Ns Ar conf
 148 Allow devices behind the LPC PCI-ISA bridge to be configured.
 149 The only supported devices are the TTY-class devices
 150 .Ar com1
 151 and
 152 .Ar com2
 153 and the boot ROM device
 154 .Ar bootrom .
 155 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
 156 Guest physical memory size in bytes.
 157 This must be the same size that was given to
 158 .Xr bhyveload 8 .
 159 .Pp
 160 The size argument may be suffixed with one of K, M, G or T (either upper
 161 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
 162 or terabytes.
 163 If no suffix is given, the value is assumed to be in megabytes.
 164 .Pp
 165 .Ar memsize
 166 defaults to 256M.
 167 .It Fl p Ar vcpu:hostcpu
 168 Pin guest's virtual CPU
 169 .Em vcpu
 170 to
 171 .Em hostcpu .
 172 .It Fl P
 173 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
 174 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
 175 Configure a virtual PCI slot and function.
 176 .Pp
 177 .Nm
 178 provides PCI bus emulation and virtual devices that can be attached to
 179 slots on the bus.
 180 There are 32 available slots, with the option of providing up to 8 functions
 181 per slot.
 182 .Bl -tag -width 10n
 183 .It Ar slot
 184 .Ar pcislot[:function]
 185 .Ar bus:pcislot:function
 186 .Pp
 187 The
 188 .Ar pcislot
 189 value is 0 to 31.
 190 The optional
 191 .Ar function
 192 value is 0 to 7.
 193 The optional
 194 .Ar bus
 195 value is 0 to 255.
 196 If not specified, the
 197 .Ar function
 198 value defaults to 0.
 199 If not specified, the
 200 .Ar bus
 201 value defaults to 0.
 202 .It Ar emulation
 203 .Bl -tag -width 10n
 204 .It Li hostbridge | Li amd_hostbridge
 205 .Pp
 206 Provide a simple host bridge.
 207 This is usually configured at slot 0, and is required by most guest
 208 operating systems.
 209 The
 210 .Li amd_hostbridge
 211 emulation is identical but uses a PCI vendor ID of
 212 .Li AMD .
 213 .It Li passthru
 214 PCI pass-through device.
 215 .It Li virtio-net
 216 Virtio network interface.
 217 .It Li virtio-blk
 218 Virtio block storage interface.
 219 .It Li virtio-rnd
 220 Virtio RNG interface.
 221 .It Li virtio-console
 222 Virtio console interface, which exposes multiple ports
 223 to the guest in the form of simple char devices for simple IO
 224 between the guest and host userspaces.
 225 .It Li ahci
 226 AHCI controller attached to arbitrary devices.
 227 .It Li ahci-cd
 228 AHCI controller attached to an ATAPI CD/DVD.
 229 .It Li ahci-hd
 230 AHCI controller attached to a SATA hard-drive.
 231 .It Li e1000
 232 Intel e82545 network interface.
 233 .It Li uart
 234 PCI 16550 serial device.
 235 .It Li lpc
 236 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
 237 The LPC bridge emulation can only be configured on bus 0.
 238 .It Li fbuf
 239 Raw framebuffer device attached to VNC server.
 240 .It Li xhci
 241 eXtensible Host Controller Interface (xHCI) USB controller.
 242 .El
 243 .It Op Ar conf
 244 This optional parameter describes the backend for device emulations.
 245 If
 246 .Ar conf
 247 is not specified, the device emulation has no backend and can be
 248 considered unconnected.
 249 .Pp
 250 Network devices:
 251 .Bl -tag -width 10n
 252 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 253 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 254 .Pp
 255 If
 256 .Ar mac
 257 is not specified, the MAC address is derived from a fixed OUI and the
 258 remaining bytes from an MD5 hash of the slot and function numbers and
 259 the device name.
 260 .Pp
 261 The MAC address is an ASCII string in
 262 .Xr ethers 5
 263 format.
 264 .El
 265 .Pp
 266 Block storage devices:
 267 .Bl -tag -width 10n
 268 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
 269 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
 270 .El
 271 .Pp
 272 The
 273 .Ar block-device-options
 274 are:
 275 .Bl -tag -width 8n
 276 .It Li nocache
 277 Open the file with
 278 .Dv O_DIRECT .
 279 .It Li direct
 280 Open the file using
 281 .Dv O_SYNC .
 282 .It Li ro
 283 Force the file to be opened read-only.
 284 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
 285 Specify the logical and physical sector sizes of the emulated disk.
 286 The physical sector size is optional and is equal to the logical sector size
 287 if not explicitly specified.
 288 .El
 289 .Pp
 290 TTY devices:
 291 .Bl -tag -width 10n
 292 .It Li stdio
 293 Connect the serial port to the standard input and output of
 294 the
 295 .Nm
 296 process.
 297 .It Pa /dev/xxx
 298 Use the host TTY device for serial port I/O.
 299 .El
 300 .Pp
 301 Boot ROM device:
 302 .Bl -tag -width 10n
 303 .It Pa romfile
 304 Map
 305 .Ar romfile
 306 in the guest address space reserved for boot firmware.
 307 .El
 308 .Pp
 309 Pass-through devices:
 310 .Bl -tag -width 10n
 311 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 312 Connect to a PCI device on the host at the selector described by
 313 .Ar slot ,
 314 .Ar bus ,
 315 and
 316 .Ar function
 317 numbers.
 318 .El
 319 .Pp
 320 Guest memory must be wired using the
 321 .Fl S
 322 option when a pass-through device is configured.
 323 .Pp
 324 The host device must have been reserved at boot-time using the
 325 .Va pptdev
 326 loader variable as described in
 327 .Xr vmm 4 .
 328 .Pp
 329 Virtio console devices:
 330 .Bl -tag -width 10n
 331 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
 332 A maximum of 16 ports per device can be created.
 333 Every port is named and corresponds to a Unix domain socket created by
 334 .Nm .
 335 .Nm
 336 accepts at most one connection per port at a time.
 337 .Pp
 338 Limitations:
 339 .Bl -bullet -offset 2n
 340 .It
 341 Due to lack of destructors in
 342 .Nm ,
 343 sockets on the filesystem must be cleaned up manually after
 344 .Nm
 345 exits.
 346 .It
 347 There is no way to use the "console port" feature, nor the console port
 348 resize at present.
 349 .It
 350 Emergency write is advertised, but no-op at present.
 351 .El
 352 .El
 353 .Pp
 354 Framebuffer devices:
 355 .Bl -tag -width 10n
 356 .It Oo rfb= Ns Oo Ar IP: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns Ar password Oc
 357 .Bl -tag -width 8n
 358 .It Ar IP:port
 359 An
 360 .Ar IP
 361 address and a
 362 .Ar port
 363 VNC should listen on.
 364 The default is to listen on localhost IPv4 address and default VNC port 5900.
 365 Listening on an IPv6 address is not supported.
 366 .It Ar width No and Ar height
 367 A display resolution, width and height, respectively.
 368 If not specified, a default resolution of 1024x768 pixels will be used.
 369 Minimal supported resolution is 640x480 pixels,
 370 and maximum is 1920x1200 pixels.
 371 .It Ar vgaconf
 372 Possible values for this option are
 373 .Dq io
 374 (default),
 375 .Dq on
 376 , and
 377 .Dq off .
 378 PCI graphics cards have a dual personality in that they are
 379 standard PCI devices with BAR addressing, but may also
 380 implicitly decode legacy VGA I/O space
 381 .Pq Ad 0x3c0-3df
 382 and memory space
 383 .Pq 64KB at Ad 0xA0000 .
 384 The default
 385 .Dq io
 386 option should be used for guests that attempt to issue BIOS
 387 calls which result in I/O port queries, and fail to boot if I/O decode is disabled.
 388 .Pp
 389 The
 390 .Dq on
 391 option should be used along with the CSM BIOS capability in UEFI
 392 to boot traditional BIOS guests that require the legacy VGA I/O and
 393 memory regions to be available.
 394 .Pp
 395 The
 396 .Dq off
 397 option should be used for the UEFI guests that assume that
 398 VGA adapter is present if they detect the I/O ports.
 399 An example of such a guest is
 400 .Ox
 401 in UEFI mode.
 402 .Pp
 403 Please refer to the
 404 .Nm
 405 .Fx
 406 wiki page
 407 .Pq Lk https://wiki.freebsd.org/bhyve
 408 for configuration notes of particular guests.
 409 .It wait
 410 Instruct
 411 .Nm
 412 to only boot upon the initiation of a VNC connection, simplifying the installation
 413 of operating systems that require immediate keyboard input.
 414 This can be removed for post-installation use.
 415 .It password
 416 This type of authentication is known to be cryptographically weak and is not
 417 intended for use on untrusted networks.
 418 Many implementations will want to use stronger security, such as running
 419 the session over an encrypted channel provided by IPsec or SSH.
 420 .El
 421 .El
 422 .Pp
 423 xHCI USB devices:
 424 .Bl -tag -width 10n
 425 .It Li tablet
 426 A USB tablet device which provides precise cursor synchronization
 427 when using VNC.
 428 .El
 429 .El
 430 .It Fl S
 431 Wire guest memory.
 432 .It Fl u
 433 RTC keeps UTC time.
 434 .It Fl U Ar uuid
 435 Set the universally unique identifier
 436 .Pq UUID
 437 in the guest's System Management BIOS System Information structure.
 438 By default a UUID is generated from the host's hostname and
 439 .Ar vmname .
 440 .It Fl w
 441 Ignore accesses to unimplemented Model Specific Registers (MSRs).
 442 This is intended for debug purposes.
 443 .It Fl W
 444 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
 445 interrupts.
 446 .It Fl x
 447 The guest's local APIC is configured in x2APIC mode.
 448 .It Fl Y
 449 Disable MPtable generation.
 450 .It Ar vmname
 451 Alphanumeric name of the guest.
 452 This should be the same as that created by
 453 .Xr bhyveload 8 .
 454 .El
 455 .Sh DEBUG SERVER
 456 The current debug server provides limited support for debuggers.
 457 .Ss Registers
 458 Each virtual CPU is exposed to the debugger as a thread.
 459 .Pp
 460 General purpose registers can be queried for each virtual CPU, but other
 461 registers such as floating-point and system registers cannot be queried.
 462 .Ss Memory
 463 Memory (including memory mapped I/O regions) can be read by the debugger,
 464 but not written.  Memory operations use virtual addresses that are resolved
 465 to physical addresses via the current virtual CPU's active address translation.
 466 .Ss Control
 467 The running guest can be interrupted by the debugger at any time
 468 .Pq for example, by pressing Ctrl-C in the debugger .
 469 .Pp
 470 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
 471 .Pp
 472 Breakpoints are not supported.
 473 .Sh SIGNAL HANDLING
 474 .Nm
 475 deals with the following signals:
 476 .Pp
 477 .Bl -tag -width indent -compact
 478 .It SIGTERM
 479 Trigger ACPI poweroff for a VM
 480 .El
 481 .Sh EXIT STATUS
 482 Exit status indicates how the VM was terminated:
 483 .Pp
 484 .Bl -tag -width indent -compact
 485 .It 0
 486 rebooted
 487 .It 1
 488 powered off
 489 .It 2
 490 halted
 491 .It 3
 492 triple fault
 493 .El
 494 .Sh EXAMPLES
 495 If not using a boot ROM, the guest operating system must have been loaded with
 496 .Xr bhyveload 8
 497 or a similar boot loader before
 498 .Xr bhyve 4
 499 can be run.
 500 Otherwise, the boot loader is not needed.
 501 .Pp
 502 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 503 block device backed by the
 504 .Pa /my/image
 505 filesystem image, and a serial port for the console:
 506 .Bd -literal -offset indent
 507 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
 508   -l com1,stdio -A -H -P -m 1G vm1
 509 .Ed
 510 .Pp
 511 Run a 24GB single-CPU virtual machine with three network ports, one of which
 512 has a MAC address specified:
 513 .Bd -literal -offset indent
 514 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
 515   -s 2:1,virtio-net,tap1 \\
 516   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
 517   -s 3,virtio-blk,/my/image -l com1,stdio \\
 518   -A -H -P -m 24G bigvm
 519 .Ed
 520 .Pp
 521 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 522 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 523 port connected to an
 524 .Xr nmdm 4
 525 null-modem device.
 526 .Bd -literal -offset indent
 527 bhyve -c 4 \\
 528   -s 0,amd_hostbridge -s 1,lpc \\
 529   -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
 530 hd:/images/disk.3,hd:/images/disk.4,\\
 531 hd:/images/disk.5,hd:/images/disk.6,\\
 532 hd:/images/disk.7,hd:/images/disk.8,\\
 533 cd:/images/install.iso \\
 534   -s 3,virtio-net,tap0 \\
 535   -l com1,/dev/nmdm0A \\
 536   -A -H -P -m 8G
 537 .Ed
 538 .Pp
 539 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
 540 that can be accessed via VNC at: 0.0.0.0:5900.
 541 .Bd -literal -offset indent
 542 bhyve -c 2 -m 4G -w -H \\
 543   -s 0,hostbridge \\
 544   -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
 545   -s 4,ahci-hd,disk.img \\
 546   -s 5,virtio-net,tap0 \\
 547   -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
 548   -s 30,xhci,tablet \\
 549   -s 31,lpc -l com1,stdio \\
 550   -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
 551    uefivm
 552 .Ed
 553 .Sh SEE ALSO
 554 .Xr bhyve 4 ,
 555 .Xr nmdm 4 ,
 556 .Xr vmm 4 ,
 557 .Xr ethers 5 ,
 558 .Xr bhyvectl 8 ,
 559 .Xr bhyveload 8
 560 .Sh HISTORY
 561 .Nm
 562 first appeared in
 563 .Fx 10.0 .
 564 .Sh AUTHORS
 565 .An Neel Natu Aq Mt neel@freebsd.org
 566 .An Peter Grehan Aq Mt grehan@freebsd.org