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 will be deprecated in a future version.
108 .It Fl c Op Ar setting ...
109 Number of guest virtual CPUs
110 and/or the CPU topology.
111 The default value for each of
118 The current maximum number of guest virtual CPUs is 16.
121 is not specified then it will be calculated from the other arguments.
122 The topology must be consistent in that the
124 must equal the product of
131 is specified more than once the last one has precedence.
133 Include guest memory in core file.
135 Destroy the VM on guest initiated power-off.
139 to exit when a guest issues an access to an I/O port that is not emulated.
140 This is intended for debug purposes.
144 kernels compiled with
145 .Cd "device bvmdebug" ,
146 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
147 via a local IPv4 address and this port.
148 This option will be deprecated in a future version.
150 Start a debug server that uses the GDB protocol to export guest state to a
152 An IPv4 TCP socket will be bound to the supplied
154 to listen for debugger connections.
155 Only a single debugger may be attached to the debug server at a time.
161 will pause execution at the first instruction waiting for a debugger to attach.
163 Print help message and exit.
165 Yield the virtual CPU thread when a HLT instruction is detected.
166 If this option is not specified, virtual CPUs will use 100% of a host CPU.
167 .It Fl l Op Ar help|lpcdev Ns Op , Ns Ar conf
168 Allow devices behind the LPC PCI-ISA bridge to be configured.
169 The only supported devices are the TTY-class devices
173 and the boot ROM device
177 print a list of supported LPC devices.
178 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
179 Guest physical memory size in bytes.
180 This must be the same size that was given to
183 The size argument may be suffixed with one of K, M, G or T (either upper
184 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
186 If no suffix is given, the value is assumed to be in megabytes.
190 .It Fl p Ar vcpu:hostcpu
191 Pin guest's virtual CPU
196 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
198 Resume a guest from a snapshot.
199 The guest memory contents are restored from
201 and the guest device and vCPU state are restored from the file
202 .Dq Ar file Ns .kern .
204 Note that the current snapshot file format requires that the configuration of
205 devices in the new VM match the VM from which the snapshot was taken by specifying the
211 The count of vCPUs and memory configuration are read from the snapshot.
212 .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
213 Configure a virtual PCI slot and function.
216 provides PCI bus emulation and virtual devices that can be attached to
218 There are 32 available slots, with the option of providing up to 8 functions
222 print a list of supported PCI devices.
224 .Ar pcislot[:function]
225 .Ar bus:pcislot:function
236 If not specified, the
239 If not specified, the
244 .It Li hostbridge | Li amd_hostbridge
246 Provide a simple host bridge.
247 This is usually configured at slot 0, and is required by most guest
251 emulation is identical but uses a PCI vendor ID of
254 PCI pass-through device.
256 Virtio network interface.
258 Virtio block storage interface.
260 Virtio SCSI interface.
262 Virtio 9p (VirtFS) interface.
264 Virtio RNG interface.
265 .It Li virtio-console
266 Virtio console interface, which exposes multiple ports
267 to the guest in the form of simple char devices for simple IO
268 between the guest and host userspaces.
270 AHCI controller attached to arbitrary devices.
272 AHCI controller attached to an ATAPI CD/DVD.
274 AHCI controller attached to a SATA hard-drive.
276 Intel e82545 network interface.
278 PCI 16550 serial device.
280 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
281 The LPC bridge emulation can only be configured on bus 0.
283 Raw framebuffer device attached to VNC server.
285 eXtensible Host Controller Interface (xHCI) USB controller.
287 NVM Express (NVMe) controller.
289 High Definition Audio Controller.
292 This optional parameter describes the backend for device emulations.
295 is not specified, the device emulation has no backend and can be
296 considered unconnected.
300 .It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
301 .It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
302 .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
306 is not specified, the MAC address is derived from a fixed OUI and the
307 remaining bytes from an MD5 hash of the slot and function numbers and
310 The MAC address is an ASCII string in
314 With virtio-net devices, the
316 parameter can be specified to inform the guest about the largest MTU
317 that should be allowed, expressed in bytes.
319 With netgraph backend, the
323 parameters must be specified to set the destination node and corresponding hook.
324 The optional parameters
328 may be used to set the
330 node name and source hook.
341 Block storage devices:
343 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
344 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
348 .Ar block-device-options
358 Force the file to be opened read-only.
359 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
360 Specify the logical and physical sector sizes of the emulated disk.
361 The physical sector size is optional and is equal to the logical sector size
362 if not explicitly specified.
367 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
371 .Ar scsi-device-options
374 .It Li iid= Ns Ar IID
375 Initiator ID to use when sending requests to specified CTL port.
376 The default value is 0.
381 .It Pa sharename=/path/to/share[,9p-device-options]
385 .Ar 9p-device-options
389 Expose the share in read-only mode.
395 Connect the serial port to the standard input and output of
400 Use the host TTY device for serial port I/O.
408 in the guest address space reserved for boot firmware.
411 Pass-through devices:
413 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
414 Connect to a PCI device on the host at the selector described by
422 Guest memory must be wired using the
424 option when a pass-through device is configured.
426 The host device must have been reserved at boot-time using the
428 loader variable as described in
431 Virtio console devices:
433 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
434 A maximum of 16 ports per device can be created.
435 Every port is named and corresponds to a Unix domain socket created by
438 accepts at most one connection per port at a time.
441 .Bl -bullet -offset 2n
443 Due to lack of destructors in
445 sockets on the filesystem must be cleaned up manually after
449 There is no way to use the "console port" feature, nor the console port
452 Emergency write is advertised, but no-op at present.
459 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
460 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
464 .It Ar IPv4:port No or Ar [IPv6%zone]:port
469 VNC should listen on.
470 The default is to listen on localhost IPv4 address and default VNC port 5900.
471 An IPv6 address must be enclosed in square brackets and may contain an
472 optional zone identifier.
473 .It Ar width No and Ar height
474 A display resolution, width and height, respectively.
475 If not specified, a default resolution of 1024x768 pixels will be used.
476 Minimal supported resolution is 640x480 pixels,
477 and maximum is 1920x1200 pixels.
479 Possible values for this option are
485 PCI graphics cards have a dual personality in that they are
486 standard PCI devices with BAR addressing, but may also
487 implicitly decode legacy VGA I/O space
490 .Pq 64KB at Ad 0xA0000 .
493 option should be used for guests that attempt to issue BIOS calls which result
494 in I/O port queries, and fail to boot if I/O decode is disabled.
498 option should be used along with the CSM BIOS capability in UEFI
499 to boot traditional BIOS guests that require the legacy VGA I/O and
500 memory regions to be available.
504 option should be used for the UEFI guests that assume that
505 VGA adapter is present if they detect the I/O ports.
506 An example of such a guest is
514 .Pq Lk https://wiki.freebsd.org/bhyve
515 for configuration notes of particular guests.
519 to only boot upon the initiation of a VNC connection, simplifying the
520 installation of operating systems that require immediate keyboard input.
521 This can be removed for post-installation use.
523 This type of authentication is known to be cryptographically weak and is not
524 intended for use on untrusted networks.
525 Many implementations will want to use stronger security, such as running
526 the session over an encrypted channel provided by IPsec or SSH.
533 A USB tablet device which provides precise cursor synchronization
540 Accepted device paths are:
545 .Ar ram=size_in_MiB .
547 Max number of queues.
549 Max elements in each queue.
551 Max number of concurrent I/O requests.
553 Sector size (defaults to blockif sector size).
555 Serial number with maximum 20 characters.
561 Nominal Media Rotation Rate, known as RPM. value 1 will indicate device as Solid State Disk. default value is 0, not report.
563 Serial Number with maximum 20 characters.
565 Revision Number with maximum 8 characters.
567 Model Number with maximum 40 characters.
573 Playback device, typically
576 Recording device, typically
585 Set the universally unique identifier
587 in the guest's System Management BIOS System Information structure.
588 By default a UUID is generated from the host's hostname and
591 Ignore accesses to unimplemented Model Specific Registers (MSRs).
592 This is intended for debug purposes.
594 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
597 The guest's local APIC is configured in x2APIC mode.
599 Disable MPtable generation.
601 Alphanumeric name of the guest.
602 This should be the same as that created by
606 The current debug server provides limited support for debuggers.
608 Each virtual CPU is exposed to the debugger as a thread.
610 General purpose registers can be queried for each virtual CPU, but other
611 registers such as floating-point and system registers cannot be queried.
613 Memory (including memory mapped I/O regions) can be read and written by the debugger.
614 Memory operations use virtual addresses that are resolved to physical addresses
615 via the current virtual CPU's active address translation.
617 The running guest can be interrupted by the debugger at any time
618 .Pq for example, by pressing Ctrl-C in the debugger .
620 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
622 Breakpoints are supported on Intel CPUs that support single stepping.
623 Note that continuing from a breakpoint while interrupts are enabled in the
624 guest may not work as expected due to timer interrupts firing while single
625 stepping over the breakpoint.
628 deals with the following signals:
630 .Bl -tag -width indent -compact
632 Trigger ACPI poweroff for a VM
635 Exit status indicates how the VM was terminated:
637 .Bl -tag -width indent -compact
647 exited due to an error
650 If not using a boot ROM, the guest operating system must have been loaded with
652 or a similar boot loader before
655 Otherwise, the boot loader is not needed.
657 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
658 block device backed by the
660 filesystem image, and a serial port for the console:
661 .Bd -literal -offset indent
662 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
663 -l com1,stdio -A -H -P -m 1G vm1
666 Run a 24GB single-CPU virtual machine with three network ports, one of which
667 has a MAC address specified:
668 .Bd -literal -offset indent
669 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
670 -s 2:1,virtio-net,tap1 \\
671 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
672 -s 3,virtio-blk,/my/image -l com1,stdio \\
673 -A -H -P -m 24G bigvm
676 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
677 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
681 .Bd -literal -offset indent
683 -s 0,amd_hostbridge -s 1,lpc \\
684 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
685 hd:/images/disk.3,hd:/images/disk.4,\\
686 hd:/images/disk.5,hd:/images/disk.6,\\
687 hd:/images/disk.7,hd:/images/disk.8,\\
688 cd:/images/install.iso \\
689 -s 3,virtio-net,tap0 \\
690 -l com1,/dev/nmdm0A \\
694 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
695 that can be accessed via VNC at: 0.0.0.0:5900.
696 .Bd -literal -offset indent
697 bhyve -c 2 -m 4G -w -H \\
699 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
700 -s 4,ahci-hd,disk.img \\
701 -s 5,virtio-net,tap0 \\
702 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
704 -s 31,lpc -l com1,stdio \\
705 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
709 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
710 addresses on port 5900.
711 .Bd -literal -offset indent
712 bhyve -c 2 -m 4G -w -H \\
714 -s 4,ahci-hd,disk.img \\
715 -s 5,virtio-net,tap0 \\
716 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
718 -s 31,lpc -l com1,stdio \\
719 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
734 .%B 64 and IA-32 Architectures Software Developer’s Manual
742 .An Neel Natu Aq Mt neel@freebsd.org
743 .An Peter Grehan Aq Mt grehan@freebsd.org