1 .\" Copyright (c) 2013 Peter Grehan
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd "run a guest operating system inside a virtual machine"
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
56 is a hypervisor that runs guest operating systems inside a
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.
62 If not using a boot ROM, the guest operating system must be loaded with
64 or a similar boot loader before running
66 otherwise, it is enough to run
68 with a boot ROM of choice.
71 runs until the guest operating system reboots or an unhandled hypervisor
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.
85 Enable a low-level console device supported by
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
100 The current maximum number of guest virtual CPUs is 16.
103 is not specified then it will be calculated from the other arguments.
104 The topology must be consistent in that the
106 must equal the product of
113 is specified more than once the last one has precedence.
115 Include guest memory in core file.
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.
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.
130 Start a debug server that uses the GDB protocol to export guest state to a
132 An IPv4 TCP socket will be bound to the supplied
134 to listen for debugger connections.
135 Only a single debugger may be attached to the debug server at a time.
141 will pause execution at the first instruction waiting for a debugger to attach.
143 Print help message and exit.
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
153 and the boot ROM device
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
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,
163 If no suffix is given, the value is assumed to be in megabytes.
167 .It Fl p Ar vcpu:hostcpu
168 Pin guest's virtual CPU
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.
178 provides PCI bus emulation and virtual devices that can be attached to
180 There are 32 available slots, with the option of providing up to 8 functions
184 .Ar pcislot[:function]
185 .Ar bus:pcislot:function
196 If not specified, the
199 If not specified, the
204 .It Li hostbridge | Li amd_hostbridge
206 Provide a simple host bridge.
207 This is usually configured at slot 0, and is required by most guest
211 emulation is identical but uses a PCI vendor ID of
214 PCI pass-through device.
216 Virtio network interface.
218 Virtio block storage interface.
220 Virtio SCSI interface.
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.
228 AHCI controller attached to arbitrary devices.
230 AHCI controller attached to an ATAPI CD/DVD.
232 AHCI controller attached to a SATA hard-drive.
234 Intel e82545 network interface.
236 PCI 16550 serial device.
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.
241 Raw framebuffer device attached to VNC server.
243 eXtensible Host Controller Interface (xHCI) USB controller.
245 NVM Express (NVMe) controller.
248 This optional parameter describes the backend for device emulations.
251 is not specified, the device emulation has no backend and can be
252 considered unconnected.
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
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
265 The MAC address is an ASCII string in
270 Block storage devices:
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
277 .Ar block-device-options
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.
296 .It Pa /dev/cam/ Ns Oo , Ns Ar port and initiator_id Oc
302 Connect the serial port to the standard input and output of
307 Use the host TTY device for serial port I/O.
315 in the guest address space reserved for boot firmware.
318 Pass-through devices:
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
329 Guest memory must be wired using the
331 option when a pass-through device is configured.
333 The host device must have been reserved at boot-time using the
335 loader variable as described in
338 Virtio console devices:
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
345 accepts at most one connection per port at a time.
348 .Bl -bullet -offset 2n
350 Due to lack of destructors in
352 sockets on the filesystem must be cleaned up manually after
356 There is no way to use the "console port" feature, nor the console port
359 Emergency write is advertised, but no-op at present.
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
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.
381 Possible values for this option are
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
392 .Pq 64KB at Ad 0xA0000 .
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.
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.
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
416 .Pq Lk https://wiki.freebsd.org/bhyve
417 for configuration notes of particular guests.
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.
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.
435 A USB tablet device which provides precise cursor synchronization
442 Accepted device paths are:
447 .Ar ram=size_in_MiB .
449 Max number of queues.
451 Max elements in each queue.
453 Max number of concurrent I/O requests.
455 Sector size (defaults to blockif sector size).
457 Serial number with maximum 20 characters.
465 Set the universally unique identifier
467 in the guest's System Management BIOS System Information structure.
468 By default a UUID is generated from the host's hostname and
471 Ignore accesses to unimplemented Model Specific Registers (MSRs).
472 This is intended for debug purposes.
474 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
477 The guest's local APIC is configured in x2APIC mode.
479 Disable MPtable generation.
481 Alphanumeric name of the guest.
482 This should be the same as that created by
486 The current debug server provides limited support for debuggers.
488 Each virtual CPU is exposed to the debugger as a thread.
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.
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.
497 The running guest can be interrupted by the debugger at any time
498 .Pq for example, by pressing Ctrl-C in the debugger .
500 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
502 Breakpoints are not supported.
505 deals with the following signals:
507 .Bl -tag -width indent -compact
509 Trigger ACPI poweroff for a VM
512 Exit status indicates how the VM was terminated:
514 .Bl -tag -width indent -compact
525 If not using a boot ROM, the guest operating system must have been loaded with
527 or a similar boot loader before
530 Otherwise, the boot loader is not needed.
532 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
533 block device backed by the
535 filesystem image, and a serial port for the console:
536 .Bd -literal -offset indent
537 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
538 -l com1,stdio -A -H -P -m 1G vm1
541 Run a 24GB single-CPU virtual machine with three network ports, one of which
542 has a MAC address specified:
543 .Bd -literal -offset indent
544 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
545 -s 2:1,virtio-net,tap1 \\
546 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
547 -s 3,virtio-blk,/my/image -l com1,stdio \\
548 -A -H -P -m 24G bigvm
551 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
552 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
556 .Bd -literal -offset indent
558 -s 0,amd_hostbridge -s 1,lpc \\
559 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
560 hd:/images/disk.3,hd:/images/disk.4,\\
561 hd:/images/disk.5,hd:/images/disk.6,\\
562 hd:/images/disk.7,hd:/images/disk.8,\\
563 cd:/images/install.iso \\
564 -s 3,virtio-net,tap0 \\
565 -l com1,/dev/nmdm0A \\
569 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
570 that can be accessed via VNC at: 0.0.0.0:5900.
571 .Bd -literal -offset indent
572 bhyve -c 2 -m 4G -w -H \\
574 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
575 -s 4,ahci-hd,disk.img \\
576 -s 5,virtio-net,tap0 \\
577 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
579 -s 31,lpc -l com1,stdio \\
580 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
595 .An Neel Natu Aq Mt neel@freebsd.org
596 .An Peter Grehan Aq Mt grehan@freebsd.org