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"
35 .Op Fl AabCDeHhPSuWwxY
52 .Cm help | Ar lpcdev Op Cm \&, Ar conf
59 .Cm K No | Cm k No | Cm M No | Cm m No | Cm G No | Cm g No | Cm T No | Cm t
63 .Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu
67 .Cm help | Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
74 is a hypervisor that runs guest operating systems inside a
77 Parameters such as the number of virtual CPUs, amount of guest memory, and
78 I/O connectivity can be specified with command-line parameters.
80 If not using a boot ROM, the guest operating system must be loaded with
82 or a similar boot loader before running
84 otherwise, it is enough to run
86 with a boot ROM of choice.
89 runs until the guest operating system reboots or an unhandled hypervisor
94 The guest's local APIC is configured in xAPIC mode.
95 The xAPIC mode is the default setting so this option is redundant.
96 It will be deprecated in a future version.
103 Enable a low-level console device supported by
105 kernels compiled with
106 .Cd "device bvmconsole" .
107 This option is deprecated and will be removed in
109 .It Fl c Op Ar setting ...
110 Number of guest virtual CPUs
111 and/or the CPU topology.
112 The default value for each of
119 The current maximum number of guest virtual CPUs is 16.
122 is not specified then it will be calculated from the other arguments.
123 The topology must be consistent in that the
125 must equal the product of
132 is specified more than once the last one has precedence.
134 Include guest memory in core file.
136 Destroy the VM on guest initiated power-off.
140 to exit when a guest issues an access to an I/O port that is not emulated.
141 This is intended for debug purposes.
145 kernels compiled with
146 .Cd "device bvmdebug" ,
147 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
148 via a local IPv4 address and this port.
149 This option is deprecated and will be removed in
152 Start a debug server that uses the GDB protocol to export guest state to a
154 An IPv4 TCP socket will be bound to the supplied
156 to listen for debugger connections.
157 Only a single debugger may be attached to the debug server at a time.
163 will pause execution at the first instruction waiting for a debugger to attach.
165 Print help message and exit.
167 Yield the virtual CPU thread when a HLT instruction is detected.
168 If this option is not specified, virtual CPUs will use 100% of a host CPU.
169 .It Fl l Op Ar help|lpcdev Ns Op , Ns Ar conf
170 Allow devices behind the LPC PCI-ISA bridge to be configured.
171 The only supported devices are the TTY-class devices
177 and the debug/test device
181 print a list of supported LPC devices.
182 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
183 Guest physical memory size in bytes.
184 This must be the same size that was given to
187 The size argument may be suffixed with one of K, M, G or T (either upper
188 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
190 If no suffix is given, the value is assumed to be in megabytes.
194 .It Fl p Ar vcpu:hostcpu
195 Pin guest's virtual CPU
200 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
202 Resume a guest from a snapshot.
203 The guest memory contents are restored from
205 and the guest device and vCPU state are restored from the file
206 .Dq Ar file Ns .kern .
208 Note that the current snapshot file format requires that the configuration of
209 devices in the new VM match the VM from which the snapshot was taken by specifying the
215 The count of vCPUs and memory configuration are read from the snapshot.
216 .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
217 Configure a virtual PCI slot and function.
220 provides PCI bus emulation and virtual devices that can be attached to
222 There are 32 available slots, with the option of providing up to 8 functions
226 print a list of supported PCI devices.
228 .Ar pcislot[:function]
229 .Ar bus:pcislot:function
240 If not specified, the
243 If not specified, the
248 .It Li hostbridge | Li amd_hostbridge
250 Provide a simple host bridge.
251 This is usually configured at slot 0, and is required by most guest
255 emulation is identical but uses a PCI vendor ID of
258 PCI pass-through device.
260 Virtio network interface.
262 Virtio block storage interface.
264 Virtio SCSI interface.
266 Virtio 9p (VirtFS) interface.
268 Virtio RNG interface.
269 .It Li virtio-console
270 Virtio console interface, which exposes multiple ports
271 to the guest in the form of simple char devices for simple IO
272 between the guest and host userspaces.
274 AHCI controller attached to arbitrary devices.
276 AHCI controller attached to an ATAPI CD/DVD.
278 AHCI controller attached to a SATA hard-drive.
280 Intel e82545 network interface.
282 PCI 16550 serial device.
284 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports, a boot ROM, and,
285 optionally, the debug/test device.
286 The LPC bridge emulation can only be configured on bus 0.
288 Raw framebuffer device attached to VNC server.
290 eXtensible Host Controller Interface (xHCI) USB controller.
292 NVM Express (NVMe) controller.
294 High Definition Audio Controller.
297 This optional parameter describes the backend for device emulations.
300 is not specified, the device emulation has no backend and can be
301 considered unconnected.
305 .It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
306 .It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
307 .It Ar netgraph,path=ADDRESS,peerhook=HOOK Ns Oo , Ns Ar socket=NAME Oc Ns Oo , Ns Ar hook=HOOK Oc Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
311 is not specified, the MAC address is derived from a fixed OUI and the
312 remaining bytes from an MD5 hash of the slot and function numbers and
315 The MAC address is an ASCII string in
319 With virtio-net devices, the
321 parameter can be specified to inform the guest about the largest MTU
322 that should be allowed, expressed in bytes.
324 With netgraph backend, the
328 parameters must be specified to set the destination node and corresponding hook.
329 The optional parameters
333 may be used to set the
335 node name and source hook.
346 Block storage devices:
348 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
349 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
353 .Ar block-device-options
363 Force the file to be opened read-only.
364 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
365 Specify the logical and physical sector sizes of the emulated disk.
366 The physical sector size is optional and is equal to the logical sector size
367 if not explicitly specified.
372 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
376 .Ar scsi-device-options
379 .It Li iid= Ns Ar IID
380 Initiator ID to use when sending requests to specified CTL port.
381 The default value is 0.
386 .It Pa sharename=/path/to/share[,9p-device-options]
390 .Ar 9p-device-options
394 Expose the share in read-only mode.
400 Connect the serial port to the standard input and output of
405 Use the host TTY device for serial port I/O.
413 in the guest address space reserved for boot firmware.
416 Pass-through devices:
418 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
419 Connect to a PCI device on the host at the selector described by
427 Guest memory must be wired using the
429 option when a pass-through device is configured.
431 The host device must have been reserved at boot-time using the
433 loader variable as described in
436 Virtio console devices:
438 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
439 A maximum of 16 ports per device can be created.
440 Every port is named and corresponds to a Unix domain socket created by
443 accepts at most one connection per port at a time.
446 .Bl -bullet -offset 2n
448 Due to lack of destructors in
450 sockets on the filesystem must be cleaned up manually after
454 There is no way to use the "console port" feature, nor the console port
457 Emergency write is advertised, but no-op at present.
464 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
465 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
469 .It Ar IPv4:port No or Ar [IPv6%zone]:port
474 VNC should listen on.
475 The default is to listen on localhost IPv4 address and default VNC port 5900.
476 An IPv6 address must be enclosed in square brackets and may contain an
477 optional zone identifier.
478 .It Ar width No and Ar height
479 A display resolution, width and height, respectively.
480 If not specified, a default resolution of 1024x768 pixels will be used.
481 Minimal supported resolution is 640x480 pixels,
482 and maximum is 1920x1200 pixels.
484 Possible values for this option are
490 PCI graphics cards have a dual personality in that they are
491 standard PCI devices with BAR addressing, but may also
492 implicitly decode legacy VGA I/O space
495 .Pq 64KB at Ad 0xA0000 .
498 option should be used for guests that attempt to issue BIOS calls which result
499 in I/O port queries, and fail to boot if I/O decode is disabled.
503 option should be used along with the CSM BIOS capability in UEFI
504 to boot traditional BIOS guests that require the legacy VGA I/O and
505 memory regions to be available.
509 option should be used for the UEFI guests that assume that
510 VGA adapter is present if they detect the I/O ports.
511 An example of such a guest is
519 .Pq Lk https://wiki.freebsd.org/bhyve
520 for configuration notes of particular guests.
524 to only boot upon the initiation of a VNC connection, simplifying the
525 installation of operating systems that require immediate keyboard input.
526 This can be removed for post-installation use.
528 This type of authentication is known to be cryptographically weak and is not
529 intended for use on untrusted networks.
530 Many implementations will want to use stronger security, such as running
531 the session over an encrypted channel provided by IPsec or SSH.
538 A USB tablet device which provides precise cursor synchronization
545 Accepted device paths are:
550 .Ar ram=size_in_MiB .
552 Max number of queues.
554 Max elements in each queue.
556 Max number of concurrent I/O requests.
558 Sector size (defaults to blockif sector size).
560 Serial number with maximum 20 characters.
566 Nominal Media Rotation Rate, known as RPM. value 1 will indicate device as Solid State Disk. default value is 0, not report.
568 Serial Number with maximum 20 characters.
570 Revision Number with maximum 8 characters.
572 Model Number with maximum 40 characters.
578 Playback device, typically
581 Recording device, typically
590 Set the universally unique identifier
592 in the guest's System Management BIOS System Information structure.
593 By default a UUID is generated from the host's hostname and
596 Ignore accesses to unimplemented Model Specific Registers (MSRs).
597 This is intended for debug purposes.
599 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
602 The guest's local APIC is configured in x2APIC mode.
604 Disable MPtable generation.
606 Alphanumeric name of the guest.
607 This should be the same as that created by
611 The current debug server provides limited support for debuggers.
613 Each virtual CPU is exposed to the debugger as a thread.
615 General purpose registers can be queried for each virtual CPU, but other
616 registers such as floating-point and system registers cannot be queried.
618 Memory (including memory mapped I/O regions) can be read and written by the debugger.
619 Memory operations use virtual addresses that are resolved to physical addresses
620 via the current virtual CPU's active address translation.
622 The running guest can be interrupted by the debugger at any time
623 .Pq for example, by pressing Ctrl-C in the debugger .
625 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
627 Breakpoints are supported on Intel CPUs that support single stepping.
628 Note that continuing from a breakpoint while interrupts are enabled in the
629 guest may not work as expected due to timer interrupts firing while single
630 stepping over the breakpoint.
633 deals with the following signals:
635 .Bl -tag -width indent -compact
637 Trigger ACPI poweroff for a VM
640 Exit status indicates how the VM was terminated:
642 .Bl -tag -width indent -compact
652 exited due to an error
655 If not using a boot ROM, the guest operating system must have been loaded with
657 or a similar boot loader before
660 Otherwise, the boot loader is not needed.
662 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
663 block device backed by the
665 filesystem image, and a serial port for the console:
666 .Bd -literal -offset indent
667 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
668 -l com1,stdio -A -H -P -m 1G vm1
671 Run a 24GB single-CPU virtual machine with three network ports, one of which
672 has a MAC address specified:
673 .Bd -literal -offset indent
674 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
675 -s 2:1,virtio-net,tap1 \\
676 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
677 -s 3,virtio-blk,/my/image -l com1,stdio \\
678 -A -H -P -m 24G bigvm
681 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
682 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
686 .Bd -literal -offset indent
688 -s 0,amd_hostbridge -s 1,lpc \\
689 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
690 hd:/images/disk.3,hd:/images/disk.4,\\
691 hd:/images/disk.5,hd:/images/disk.6,\\
692 hd:/images/disk.7,hd:/images/disk.8,\\
693 cd:/images/install.iso \\
694 -s 3,virtio-net,tap0 \\
695 -l com1,/dev/nmdm0A \\
699 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
700 that can be accessed via VNC at: 0.0.0.0:5900.
701 .Bd -literal -offset indent
702 bhyve -c 2 -m 4G -w -H \\
704 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
705 -s 4,ahci-hd,disk.img \\
706 -s 5,virtio-net,tap0 \\
707 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
709 -s 31,lpc -l com1,stdio \\
710 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
714 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
715 addresses on port 5900.
716 .Bd -literal -offset indent
717 bhyve -c 2 -m 4G -w -H \\
719 -s 4,ahci-hd,disk.img \\
720 -s 5,virtio-net,tap0 \\
721 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
723 -s 31,lpc -l com1,stdio \\
724 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
739 .%B 64 and IA-32 Architectures Software Developer’s Manual
747 .An Neel Natu Aq Mt neel@freebsd.org
748 .An Peter Grehan Aq Mt grehan@freebsd.org