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 Jul 11, 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-scsi
 220 Virtio SCSI interface.
 221 .It Li virtio-rnd
 222 Virtio RNG interface.
 223 .It Li virtio-console
 224 Virtio console interface, which exposes multiple ports
 225 to the guest in the form of simple char devices for simple IO
 226 between the guest and host userspaces.
 227 .It Li ahci
 228 AHCI controller attached to arbitrary devices.
 229 .It Li ahci-cd
 230 AHCI controller attached to an ATAPI CD/DVD.
 231 .It Li ahci-hd
 232 AHCI controller attached to a SATA hard-drive.
 233 .It Li e1000
 234 Intel e82545 network interface.
 235 .It Li uart
 236 PCI 16550 serial device.
 237 .It Li lpc
 238 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
 239 The LPC bridge emulation can only be configured on bus 0.
 240 .It Li fbuf
 241 Raw framebuffer device attached to VNC server.
 242 .It Li xhci
 243 eXtensible Host Controller Interface (xHCI) USB controller.
 244 .It Li nvme
 245 NVM Express (NVMe) controller.
 246 .El
 247 .It Op Ar conf
 248 This optional parameter describes the backend for device emulations.
 249 If
 250 .Ar conf
 251 is not specified, the device emulation has no backend and can be
 252 considered unconnected.
 253 .Pp
 254 Network devices:
 255 .Bl -tag -width 10n
 256 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 257 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 258 .Pp
 259 If
 260 .Ar mac
 261 is not specified, the MAC address is derived from a fixed OUI and the
 262 remaining bytes from an MD5 hash of the slot and function numbers and
 263 the device name.
 264 .Pp
 265 The MAC address is an ASCII string in
 266 .Xr ethers 5
 267 format.
 268 .El
 269 .Pp
 270 Block storage devices:
 271 .Bl -tag -width 10n
 272 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
 273 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
 274 .El
 275 .Pp
 276 The
 277 .Ar block-device-options
 278 are:
 279 .Bl -tag -width 8n
 280 .It Li nocache
 281 Open the file with
 282 .Dv O_DIRECT .
 283 .It Li direct
 284 Open the file using
 285 .Dv O_SYNC .
 286 .It Li ro
 287 Force the file to be opened read-only.
 288 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
 289 Specify the logical and physical sector sizes of the emulated disk.
 290 The physical sector size is optional and is equal to the logical sector size
 291 if not explicitly specified.
 292 .El
 293 .Pp
 294 SCSI devices:
 295 .Bl -tag -width 10n
 296 .It Pa /dev/cam/ Ns Oo , Ns Ar port and initiator_id Oc
 297 .El
 298 .Pp
 299 TTY devices:
 300 .Bl -tag -width 10n
 301 .It Li stdio
 302 Connect the serial port to the standard input and output of
 303 the
 304 .Nm
 305 process.
 306 .It Pa /dev/xxx
 307 Use the host TTY device for serial port I/O.
 308 .El
 309 .Pp
 310 Boot ROM device:
 311 .Bl -tag -width 10n
 312 .It Pa romfile
 313 Map
 314 .Ar romfile
 315 in the guest address space reserved for boot firmware.
 316 .El
 317 .Pp
 318 Pass-through devices:
 319 .Bl -tag -width 10n
 320 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 321 Connect to a PCI device on the host at the selector described by
 322 .Ar slot ,
 323 .Ar bus ,
 324 and
 325 .Ar function
 326 numbers.
 327 .El
 328 .Pp
 329 Guest memory must be wired using the
 330 .Fl S
 331 option when a pass-through device is configured.
 332 .Pp
 333 The host device must have been reserved at boot-time using the
 334 .Va pptdev
 335 loader variable as described in
 336 .Xr vmm 4 .
 337 .Pp
 338 Virtio console devices:
 339 .Bl -tag -width 10n
 340 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
 341 A maximum of 16 ports per device can be created.
 342 Every port is named and corresponds to a Unix domain socket created by
 343 .Nm .
 344 .Nm
 345 accepts at most one connection per port at a time.
 346 .Pp
 347 Limitations:
 348 .Bl -bullet -offset 2n
 349 .It
 350 Due to lack of destructors in
 351 .Nm ,
 352 sockets on the filesystem must be cleaned up manually after
 353 .Nm
 354 exits.
 355 .It
 356 There is no way to use the "console port" feature, nor the console port
 357 resize at present.
 358 .It
 359 Emergency write is advertised, but no-op at present.
 360 .El
 361 .El
 362 .Pp
 363 Framebuffer devices:
 364 .Bl -tag -width 10n
 365 .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
 366 .Bl -tag -width 8n
 367 .It Ar IP:port
 368 An
 369 .Ar IP
 370 address and a
 371 .Ar port
 372 VNC should listen on.
 373 The default is to listen on localhost IPv4 address and default VNC port 5900.
 374 Listening on an IPv6 address is not supported.
 375 .It Ar width No and Ar height
 376 A display resolution, width and height, respectively.
 377 If not specified, a default resolution of 1024x768 pixels will be used.
 378 Minimal supported resolution is 640x480 pixels,
 379 and maximum is 1920x1200 pixels.
 380 .It Ar vgaconf
 381 Possible values for this option are
 382 .Dq io
 383 (default),
 384 .Dq on
 385 , and
 386 .Dq off .
 387 PCI graphics cards have a dual personality in that they are
 388 standard PCI devices with BAR addressing, but may also
 389 implicitly decode legacy VGA I/O space
 390 .Pq Ad 0x3c0-3df
 391 and memory space
 392 .Pq 64KB at Ad 0xA0000 .
 393 The default
 394 .Dq io
 395 option should be used for guests that attempt to issue BIOS
 396 calls which result in I/O port queries, and fail to boot if I/O decode is disabled.
 397 .Pp
 398 The
 399 .Dq on
 400 option should be used along with the CSM BIOS capability in UEFI
 401 to boot traditional BIOS guests that require the legacy VGA I/O and
 402 memory regions to be available.
 403 .Pp
 404 The
 405 .Dq off
 406 option should be used for the UEFI guests that assume that
 407 VGA adapter is present if they detect the I/O ports.
 408 An example of such a guest is
 409 .Ox
 410 in UEFI mode.
 411 .Pp
 412 Please refer to the
 413 .Nm
 414 .Fx
 415 wiki page
 416 .Pq Lk https://wiki.freebsd.org/bhyve
 417 for configuration notes of particular guests.
 418 .It wait
 419 Instruct
 420 .Nm
 421 to only boot upon the initiation of a VNC connection, simplifying the installation
 422 of operating systems that require immediate keyboard input.
 423 This can be removed for post-installation use.
 424 .It password
 425 This type of authentication is known to be cryptographically weak and is not
 426 intended for use on untrusted networks.
 427 Many implementations will want to use stronger security, such as running
 428 the session over an encrypted channel provided by IPsec or SSH.
 429 .El
 430 .El
 431 .Pp
 432 xHCI USB devices:
 433 .Bl -tag -width 10n
 434 .It Li tablet
 435 A USB tablet device which provides precise cursor synchronization
 436 when using VNC.
 437 .El
 438 .Pp
 439 NVMe devices:
 440 .Bl -tag -width 10n
 441 .It Li devpath
 442 Accepted device paths are:
 443 .Ar /dev/blockdev
 444 or
 445 .Ar /path/to/image
 446 or
 447 .Ar ram=size_in_MiB .
 448 .It Li maxq
 449 Max number of queues.
 450 .It Li qsz
 451 Max elements in each queue.
 452 .It Li ioslots
 453 Max number of concurrent I/O requests.
 454 .It Li sectsz
 455 Sector size (defaults to blockif sector size).
 456 .It Li ser
 457 Serial number with maximum 20 characters.
 458 .El
 459 .El
 460 .It Fl S
 461 Wire guest memory.
 462 .It Fl u
 463 RTC keeps UTC time.
 464 .It Fl U Ar uuid
 465 Set the universally unique identifier
 466 .Pq UUID
 467 in the guest's System Management BIOS System Information structure.
 468 By default a UUID is generated from the host's hostname and
 469 .Ar vmname .
 470 .It Fl w
 471 Ignore accesses to unimplemented Model Specific Registers (MSRs).
 472 This is intended for debug purposes.
 473 .It Fl W
 474 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
 475 interrupts.
 476 .It Fl x
 477 The guest's local APIC is configured in x2APIC mode.
 478 .It Fl Y
 479 Disable MPtable generation.
 480 .It Ar vmname
 481 Alphanumeric name of the guest.
 482 This should be the same as that created by
 483 .Xr bhyveload 8 .
 484 .El
 485 .Sh DEBUG SERVER
 486 The current debug server provides limited support for debuggers.
 487 .Ss Registers
 488 Each virtual CPU is exposed to the debugger as a thread.
 489 .Pp
 490 General purpose registers can be queried for each virtual CPU, but other
 491 registers such as floating-point and system registers cannot be queried.
 492 .Ss Memory
 493 Memory (including memory mapped I/O regions) can be read by the debugger,
 494 but not written.  Memory operations use virtual addresses that are resolved
 495 to physical addresses via the current virtual CPU's active address translation.
 496 .Ss Control
 497 The running guest can be interrupted by the debugger at any time
 498 .Pq for example, by pressing Ctrl-C in the debugger .
 499 .Pp
 500 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
 501 .Pp
 502 Breakpoints are not supported.
 503 .Sh SIGNAL HANDLING
 504 .Nm
 505 deals with the following signals:
 506 .Pp
 507 .Bl -tag -width indent -compact
 508 .It SIGTERM
 509 Trigger ACPI poweroff for a VM
 510 .El
 511 .Sh EXIT STATUS
 512 Exit status indicates how the VM was terminated:
 513 .Pp
 514 .Bl -tag -width indent -compact
 515 .It 0
 516 rebooted
 517 .It 1
 518 powered off
 519 .It 2
 520 halted
 521 .It 3
 522 triple fault
 523 .It 4
 524 exited due to an error
 525 .El
 526 .Sh EXAMPLES
 527 If not using a boot ROM, the guest operating system must have been loaded with
 528 .Xr bhyveload 8
 529 or a similar boot loader before
 530 .Xr bhyve 4
 531 can be run.
 532 Otherwise, the boot loader is not needed.
 533 .Pp
 534 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 535 block device backed by the
 536 .Pa /my/image
 537 filesystem image, and a serial port for the console:
 538 .Bd -literal -offset indent
 539 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
 540   -l com1,stdio -A -H -P -m 1G vm1
 541 .Ed
 542 .Pp
 543 Run a 24GB single-CPU virtual machine with three network ports, one of which
 544 has a MAC address specified:
 545 .Bd -literal -offset indent
 546 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
 547   -s 2:1,virtio-net,tap1 \\
 548   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
 549   -s 3,virtio-blk,/my/image -l com1,stdio \\
 550   -A -H -P -m 24G bigvm
 551 .Ed
 552 .Pp
 553 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 554 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 555 port connected to an
 556 .Xr nmdm 4
 557 null-modem device.
 558 .Bd -literal -offset indent
 559 bhyve -c 4 \\
 560   -s 0,amd_hostbridge -s 1,lpc \\
 561   -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
 562 hd:/images/disk.3,hd:/images/disk.4,\\
 563 hd:/images/disk.5,hd:/images/disk.6,\\
 564 hd:/images/disk.7,hd:/images/disk.8,\\
 565 cd:/images/install.iso \\
 566   -s 3,virtio-net,tap0 \\
 567   -l com1,/dev/nmdm0A \\
 568   -A -H -P -m 8G
 569 .Ed
 570 .Pp
 571 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
 572 that can be accessed via VNC at: 0.0.0.0:5900.
 573 .Bd -literal -offset indent
 574 bhyve -c 2 -m 4G -w -H \\
 575   -s 0,hostbridge \\
 576   -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
 577   -s 4,ahci-hd,disk.img \\
 578   -s 5,virtio-net,tap0 \\
 579   -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
 580   -s 30,xhci,tablet \\
 581   -s 31,lpc -l com1,stdio \\
 582   -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
 583    uefivm
 584 .Ed
 585 .Sh SEE ALSO
 586 .Xr bhyve 4 ,
 587 .Xr nmdm 4 ,
 588 .Xr vmm 4 ,
 589 .Xr ethers 5 ,
 590 .Xr bhyvectl 8 ,
 591 .Xr bhyveload 8
 592 .Sh HISTORY
 593 .Nm
 594 first appeared in
 595 .Fx 10.0 .
 596 .Sh AUTHORS
 597 .An Neel Natu Aq Mt neel@freebsd.org
 598 .An Peter Grehan Aq Mt grehan@freebsd.org