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"
52 .Oo Ar bind_address Cm \&: Oc
56 .Op Fl k Ar config_file
60 .Ar lpcdev Op Cm \&, Ar conf
67 .Cm K | Cm k | Cm M | Cm m | Cm G | Cm g | Cm T | Cm t
71 .Op Fl o Ar var Ns Cm = Ns Ar value
72 .Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu
76 .Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
87 is a hypervisor that runs guest operating systems inside a
90 Parameters such as the number of virtual CPUs, amount of guest memory, and
91 I/O connectivity can be specified with command-line parameters.
93 If not using a boot ROM, the guest operating system must be loaded with
95 or a similar boot loader before running
97 otherwise, it is enough to run
99 with a boot ROM of choice.
102 runs until the guest operating system reboots or an unhandled hypervisor
107 Generate ACPI tables.
112 The guest's local APIC is configured in xAPIC mode.
113 The xAPIC mode is the default setting so this option is redundant.
114 It will be deprecated in a future version.
116 Include guest memory in core file.
117 .It Fl c Op Ar setting ...
118 Number of guest virtual CPUs
119 and/or the CPU topology.
120 The default value for each of
127 The current maximum number of guest virtual CPUs is 16.
130 is not specified then it will be calculated from the other arguments.
131 The topology must be consistent in that the
133 must equal the product of
140 is specified more than once the last one has precedence.
142 Destroy the VM on guest initiated power-off.
146 to exit when a guest issues an access to an I/O port that is not emulated.
147 This is intended for debug purposes.
151 .Oo Ar bind_address Cm \&: Oc
155 Start a debug server that uses the GDB protocol to export guest state to a
157 An IPv4 TCP socket will be bound to the supplied
161 to listen for debugger connections.
162 Only a single debugger may be attached to the debug server at a time.
163 If the option begins with
166 will pause execution at the first instruction waiting for a debugger to attach.
168 Yield the virtual CPU thread when a HLT instruction is detected.
169 If this option is not specified, virtual CPUs will use 100% of a host CPU.
171 Print help message and exit.
172 .It Fl k Ar config_file
173 Set configuration variables from a simple, key-value config file.
174 Each line of the config file is expected to consist of a config variable
177 Specify the keyboard layout.
178 The value that can be specified sets the file name in
179 .Ar /usr/share/bhyve/kbdlayout .
180 This specification only works when loaded with UEFI mode for VNC.
181 When using a VNC client that supports QEMU Extended Key Event Message (e.g. TigerVNC), this option isn't needed.
182 When using a VNC client that doesn't support QEMU Extended Key Event Message (e.g. tightVNC), the layout defaults to the US keyboard unless specified otherwise.
185 No spaces are permitted between the variable name, equals sign, or
187 Blank lines and lines starting with
194 Print a list of supported LPC devices.
195 .It Fl l Ar lpcdev Ns Op Cm \&, Ns Ar conf
196 Allow devices behind the LPC PCI-ISA bridge to be configured.
197 The only supported devices are the TTY-class devices
198 .Cm com1 , com2 , com3 ,
203 and the debug/test device
206 The possible values for the
208 argument are listed in the
212 .Fl m Ar memsize Ns Oo
214 .Cm K | k | M | m | G | g | T | t
218 Set the guest physical memory size
219 This must be the same size that was given to
222 The size argument may be suffixed with one of
226 (either upper or lower case)
227 to indicate a multiple of kilobytes, megabytes, gigabytes, or terabytes.
228 If no suffix is given, the value is assumed to be in megabytes.
231 .It Fl o Ar var Ns Cm = Ns Ar value
232 Set the configuration variable
237 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
238 .It Fl p Ar vcpu Ns Cm \& : Ns Ar hostcpu
239 Pin guest's virtual CPU
244 Resume a guest from a snapshot.
245 The guest memory contents are restored from
247 and the guest device and vCPU state are restored from the file
248 .Dq Ar file Ns .kern .
250 Note that the current snapshot file format requires that the configuration of
251 devices in the new VM match the VM from which the snapshot was taken by specifying the
257 The count of vCPUs and memory configuration are read from the snapshot.
261 Print a list of supported PCI devices.
262 .It Fl s Ar slot Ns Cm \&, Ns Ar emulation Ns Op Cm \&, Ns Ar conf
263 Configure a virtual PCI slot and function.
266 provides PCI bus emulation and virtual devices that can be attached to
268 There are 32 available slots, with the option of providing up to 8 functions
273 can be specified in one of the following formats:
280 .Ar pcislot Cm \&: Ar function
284 .Ar bus Cm \&: Ar pcislot Cm \&: Ar function
297 If not specified, the
300 If not specified, the
307 can be one of the following:
308 .Bl -tag -width "amd_hostbridge"
310 A simple host bridge.
311 This is usually configured at slot 0, and is required by most guest
313 .It Cm amd_hostbridge
314 Emulation identical to
316 using a PCI vendor ID of AMD.
318 PCI pass-through device.
320 Virtio network interface.
322 Virtio block storage interface.
324 Virtio SCSI interface.
326 Virtio 9p (VirtFS) interface.
328 Virtio RNG interface.
329 .It Cm virtio-console
330 Virtio console interface, which exposes multiple ports
331 to the guest in the form of simple char devices for simple IO
332 between the guest and host userspaces.
334 Virtio input interface.
336 AHCI controller attached to arbitrary devices.
338 AHCI controller attached to an ATAPI CD/DVD.
340 AHCI controller attached to a SATA hard drive.
342 Intel e82545 network interface.
344 PCI 16550 serial device.
346 LPC PCI-ISA bridge with COM1, COM2, COM3, and COM4 16550 serial ports,
348 optionally, the debug/test device.
349 The LPC bridge emulation can only be configured on bus 0.
351 Raw framebuffer device attached to VNC server.
353 eXtensible Host Controller Interface (xHCI) USB controller.
355 NVM Express (NVMe) controller.
357 High Definition Audio Controller.
360 The optional parameter
362 describes the backend for device emulations.
365 is not specified, the device emulation has no backend and can be
366 considered unconnected.
368 Network device backends:
374 .Op Cm \&,mac= Ar xx:xx:xx:xx:xx:xx
380 .Op Cm \&,mac= Ar xx:xx:xx:xx:xx:xx
385 .Cm netgraph,path= Ar ADDRESS Cm \&,peerhook= Ar HOOK
386 .Op Cm \&,socket= Ar NAME
387 .Op Cm \&,hook= Ar HOOK
388 .Op Cm \&,mac= Ar xx:xx:xx:xx:xx:xx
395 is not specified, the MAC address is derived from a fixed OUI and the
396 remaining bytes from an MD5 hash of the slot and function numbers and
399 The MAC address is an ASCII string in
407 parameter can be specified to inform the guest about the largest MTU
408 that should be allowed, expressed in bytes.
416 parameters must be specified to set the destination node and corresponding hook.
417 The optional parameters
421 may be used to set the
423 node name and source hook.
433 Block storage device backends:
437 .Ar /filename Op Cm \&, Ar block-device-options
439 .Ar /dev/xxx Op Cm \&, Ar block-device-options
444 .Ar block-device-options
454 Force the file to be opened read-only.
455 .It Cm sectorsize= Ns Ar logical Ns Oo Cm \&/ Ns Ar physical Oc
456 Specify the logical and physical sector sizes of the emulated disk.
457 The physical sector size is optional and is equal to the logical sector size
458 if not explicitly specified.
460 Disable emulation of guest trim requests via
465 SCSI device backends:
469 .Pa /dev/cam/ctl Oo Ar pp Cm \&. Ar vp Oc Oo Cm \&, Ar scsi-device-options Oc
474 .Ar scsi-device-options
477 .It Cm iid= Ns Ar IID
478 Initiator ID to use when sending requests to specified CTL port.
479 The default value is 0.
486 .Ar sharename Cm = Ar /path/to/share Op Cm \&, Ar 9p-device-options
491 .Ar 9p-device-options
495 Expose the share in read-only mode.
501 Connect the serial port to the standard input and output of
506 Use the host TTY device for serial port I/O.
509 Boot ROM device backends:
511 .It Ar romfile Ns Op Cm \&, Ns Ar varfile
514 in the guest address space reserved for boot firmware.
517 is provided, that file is also mapped in the boot firmware guest
518 address space, and any modifications the guest makes will be saved
522 Pass-through device backends:
524 .It Ns Ar slot Ns Cm \&/ Ns Ar bus Ns Cm \&/ Ns Ar function
525 Connect to a PCI device on the host at the selector described by
531 .It Cm rom= Ns Ar romfile
534 as option ROM to the PCI device.
535 The ROM will be loaded by firmware and should be capable of initializing the device.
538 Guest memory must be wired using the
540 option when a pass-through device is configured.
542 The host device must have been reserved at boot-time using the
544 loader variable as described in
547 Virtio console device backends:
551 .Cm port1= Ns Ar /path/to/port1.sock Ns Op Cm ,port Ns Ar N Cm \&= Ns Ar /path/to/port2.sock No \~ Ar ...
555 A maximum of 16 ports per device can be created.
556 Every port is named and corresponds to a Unix domain socket created by
559 accepts at most one connection per port at a time.
564 Due to lack of destructors in
566 sockets on the filesystem must be cleaned up manually after
570 There is no way to use the
572 feature, nor the console port
575 Emergency write is advertised, but no-op at present.
578 Virtio input device backends:
580 .It Ar /dev/input/eventX
582 .Ar /dev/input/eventX
583 to guest by VirtIO Input Interface.
586 Framebuffer devices backends:
590 .Op Cm rfb= Ar ip-and-port
593 .Op Cm ,vga= Ar vgaconf
595 .Op Cm ,password= Ar password
599 Configuration options are defined as follows:
601 .It Cm rfb= Ns Ar ip-and-port Pq or Cm tcp= Ns Ar ip-and-port
602 An IP address and a port VNC should listen on.
603 There are two formats:
613 .Cm \&[ Ar IPv6%zone Cm \&] Cm \&: Ar port
617 The default is to listen on localhost IPv4 address and default VNC port 5900.
618 An IPv6 address must be enclosed in square brackets and may contain an
619 optional zone identifier.
620 .It Cm w= Ns Ar width No and Cm h= Ns Ar height
621 A display resolution, width and height, respectively.
622 If not specified, a default resolution of 1024x768 pixels will be used.
623 Minimal supported resolution is 640x480 pixels,
624 and maximum is 1920x1200 pixels.
625 .It Cm vga= Ns Ar vgaconf
626 Possible values for this option are
632 PCI graphics cards have a dual personality in that they are
633 standard PCI devices with BAR addressing, but may also
634 implicitly decode legacy VGA I/O space
637 .Pq 64KB at Ad 0xA0000 .
640 option should be used for guests that attempt to issue BIOS calls which result
641 in I/O port queries, and fail to boot if I/O decode is disabled.
645 option should be used along with the CSM BIOS capability in UEFI
646 to boot traditional BIOS guests that require the legacy VGA I/O and
647 memory regions to be available.
651 option should be used for the UEFI guests that assume that
652 VGA adapter is present if they detect the I/O ports.
653 An example of such a guest is
661 .Pq Lk https://wiki.freebsd.org/bhyve
662 for configuration notes of particular guests.
666 to only boot upon the initiation of a VNC connection, simplifying the
667 installation of operating systems that require immediate keyboard input.
668 This can be removed for post-installation use.
669 .It Cm password= Ns Ar password
670 This type of authentication is known to be cryptographically weak and is not
671 intended for use on untrusted networks.
672 Many implementations will want to use stronger security, such as running
673 the session over an encrypted channel provided by IPsec or SSH.
676 xHCI USB device backends:
679 A USB tablet device which provides precise cursor synchronization
683 NVMe device backends:
690 .Op Cm ,ioslots= Ar #
698 Configuration options are defined as follows:
701 Accepted device paths are:
706 .Cm ram= Ns Ar size_in_MiB .
708 Max number of queues.
710 Max elements in each queue.
712 Max number of concurrent I/O requests.
714 Sector size (defaults to blockif sector size).
716 Serial number with maximum 20 characters.
718 IEEE Extended Unique Identifier (8 byte value).
720 DataSet Management support.
721 Supported values are:
727 AHCI device backends:
731 .Op Oo Cm hd\&: | cd\&: Oc Ar path
732 .Op Cm ,nmrr= Ar nmrr
739 Configuration options are defined as follows:
742 Nominal Media Rotation Rate, known as RPM.
743 Value 1 will indicate device as Solid State Disk.
744 Default value is 0, not report.
746 Serial Number with maximum 20 characters.
748 Revision Number with maximum 8 characters.
750 Model Number with maximum 40 characters.
753 HD Audio device backends:
757 .Op Cm play= Ar playback
758 .Op Cm ,rec= Ar recording
762 Configuration options are defined as follows:
765 Playback device, typically
768 Recording device, typically
772 Set the universally unique identifier
774 in the guest's System Management BIOS System Information structure.
775 By default a UUID is generated from the host's hostname and
780 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
783 Ignore accesses to unimplemented Model Specific Registers (MSRs).
784 This is intended for debug purposes.
786 The guest's local APIC is configured in x2APIC mode.
788 Disable MPtable generation.
790 Alphanumeric name of the guest.
791 This should be the same as that created by
794 .Sh CONFIGURATION VARIABLES
796 uses an internal tree of configuration variables to describe global and
801 it parses command line options (including config files) in the order given
803 Each command line option sets one or more configuration variables.
807 option creates a new tree node for a PCI device and sets one or more variables
808 under that node including the device model and device model-specific variables.
809 Variables may be set multiple times during this parsing stage with the final
810 value overriding previous values.
812 Once all of the command line options have been processed,
813 the configuration values are frozen.
815 then uses the value of configuration values to initialize device models
818 More details on configuration variables can be found in
821 The current debug server provides limited support for debuggers.
823 Each virtual CPU is exposed to the debugger as a thread.
825 General purpose registers can be queried for each virtual CPU, but other
826 registers such as floating-point and system registers cannot be queried.
828 Memory (including memory mapped I/O regions) can be read and written by the debugger.
829 Memory operations use virtual addresses that are resolved to physical addresses
830 via the current virtual CPU's active address translation.
832 The running guest can be interrupted by the debugger at any time
833 .Pq for example, by pressing Ctrl-C in the debugger .
835 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
837 Breakpoints are supported on Intel CPUs that support single stepping.
838 Note that continuing from a breakpoint while interrupts are enabled in the
839 guest may not work as expected due to timer interrupts firing while single
840 stepping over the breakpoint.
843 deals with the following signals:
845 .Bl -tag -width SIGTERM -compact
847 Trigger ACPI poweroff for a VM
850 Exit status indicates how the VM was terminated:
852 .Bl -tag -width indent -compact
862 exited due to an error
865 If not using a boot ROM, the guest operating system must have been loaded with
867 or a similar boot loader before
870 Otherwise, the boot loader is not needed.
872 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
873 block device backed by the
875 filesystem image, and a serial port for the console:
876 .Bd -literal -offset indent
877 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
878 -l com1,stdio -A -H -P -m 1G vm1
881 Run a 24GB single-CPU virtual machine with three network ports, one of which
882 has a MAC address specified:
883 .Bd -literal -offset indent
884 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
885 -s 2:1,virtio-net,tap1 \\
886 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
887 -s 3,virtio-blk,/my/image -l com1,stdio \\
888 -A -H -P -m 24G bigvm
891 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
892 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
896 .Bd -literal -offset indent
898 -s 0,amd_hostbridge -s 1,lpc \\
899 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
900 hd:/images/disk.3,hd:/images/disk.4,\\
901 hd:/images/disk.5,hd:/images/disk.6,\\
902 hd:/images/disk.7,hd:/images/disk.8,\\
903 cd:/images/install.iso \\
904 -s 3,virtio-net,tap0 \\
905 -l com1,/dev/nmdm0A \\
909 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
910 that can be accessed via VNC at: 0.0.0.0:5900.
911 .Bd -literal -offset indent
912 bhyve -c 2 -m 4G -w -H \\
914 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
915 -s 4,ahci-hd,disk.img \\
916 -s 5,virtio-net,tap0 \\
917 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
919 -s 31,lpc -l com1,stdio \\
920 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
924 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
925 addresses on port 5900.
926 .Bd -literal -offset indent
927 bhyve -c 2 -m 4G -w -H \\
929 -s 4,ahci-hd,disk.img \\
930 -s 5,virtio-net,tap0 \\
931 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
933 -s 31,lpc -l com1,stdio \\
934 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
938 Run a UEFI virtual machine with a VARS file to save EFI variables.
941 will write guest modifications to the given VARS file.
942 Be sure to create a per-guest copy of the template VARS file from
944 .Bd -literal -offset indent
945 bhyve -c 2 -m 4g -w -H \\
947 -s 31,lpc -p com1,stdio \\
948 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI_CODE.fd,BHYVE_UEFI_VARS.fd
964 .%B 64 and IA-32 Architectures Software Developer’s Manual
972 .An Neel Natu Aq Mt neel@freebsd.org
973 .An Peter Grehan Aq Mt grehan@freebsd.org
projects / FreeBSD / FreeBSD.git / blob