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 .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.
137 to exit when a guest issues an access to an I/O port that is not emulated.
138 This is intended for debug purposes.
142 kernels compiled with
143 .Cd "device bvmdebug" ,
144 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
145 via a local IPv4 address and this port.
146 This option will be deprecated in a future version.
148 Start a debug server that uses the GDB protocol to export guest state to a
150 An IPv4 TCP socket will be bound to the supplied
152 to listen for debugger connections.
153 Only a single debugger may be attached to the debug server at a time.
159 will pause execution at the first instruction waiting for a debugger to attach.
161 Print help message and exit.
163 Yield the virtual CPU thread when a HLT instruction is detected.
164 If this option is not specified, virtual CPUs will use 100% of a host CPU.
165 .It Fl l Op Ar help|lpcdev Ns Op , Ns Ar conf
166 Allow devices behind the LPC PCI-ISA bridge to be configured.
167 The only supported devices are the TTY-class devices
171 and the boot ROM device
175 print a list of supported LPC devices.
176 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
177 Guest physical memory size in bytes.
178 This must be the same size that was given to
181 The size argument may be suffixed with one of K, M, G or T (either upper
182 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
184 If no suffix is given, the value is assumed to be in megabytes.
188 .It Fl p Ar vcpu:hostcpu
189 Pin guest's virtual CPU
194 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
196 Resume a guest from a snapshot.
197 The guest memory contents are restored from
199 and the guest device and vCPU state are restored from the file
200 .Dq Ar file Ns .kern .
202 Note that the current snapshot file format requires that the configuration of
203 devices in the new VM match the VM from which the snapshot was taken by specifying the
209 The count of vCPUs and memory configuration are read from the snapshot.
210 .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
211 Configure a virtual PCI slot and function.
214 provides PCI bus emulation and virtual devices that can be attached to
216 There are 32 available slots, with the option of providing up to 8 functions
220 print a list of supported PCI devices.
222 .Ar pcislot[:function]
223 .Ar bus:pcislot:function
234 If not specified, the
237 If not specified, the
242 .It Li hostbridge | Li amd_hostbridge
244 Provide a simple host bridge.
245 This is usually configured at slot 0, and is required by most guest
249 emulation is identical but uses a PCI vendor ID of
252 PCI pass-through device.
254 Virtio network interface.
256 Virtio block storage interface.
258 Virtio SCSI interface.
260 Virtio RNG interface.
261 .It Li virtio-console
262 Virtio console interface, which exposes multiple ports
263 to the guest in the form of simple char devices for simple IO
264 between the guest and host userspaces.
266 AHCI controller attached to arbitrary devices.
268 AHCI controller attached to an ATAPI CD/DVD.
270 AHCI controller attached to a SATA hard-drive.
272 Intel e82545 network interface.
274 PCI 16550 serial device.
276 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
277 The LPC bridge emulation can only be configured on bus 0.
279 Raw framebuffer device attached to VNC server.
281 eXtensible Host Controller Interface (xHCI) USB controller.
283 NVM Express (NVMe) controller.
285 High Definition Audio Controller.
288 This optional parameter describes the backend for device emulations.
291 is not specified, the device emulation has no backend and can be
292 considered unconnected.
296 .It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
297 .It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
298 .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
302 is not specified, the MAC address is derived from a fixed OUI and the
303 remaining bytes from an MD5 hash of the slot and function numbers and
306 The MAC address is an ASCII string in
310 With virtio-net devices, the
312 parameter can be specified to inform the guest about the largest MTU
313 that should be allowed, expressed in bytes.
315 With netgraph backend, the
319 parameters must be specified to set the destination node and corresponding hook.
320 The optional parameters
324 may be used to set the
326 node name and source hook.
337 Block storage devices:
339 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
340 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
344 .Ar block-device-options
354 Force the file to be opened read-only.
355 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
356 Specify the logical and physical sector sizes of the emulated disk.
357 The physical sector size is optional and is equal to the logical sector size
358 if not explicitly specified.
363 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
367 .Ar scsi-device-options
370 .It Li iid= Ns Ar IID
371 Initiator ID to use when sending requests to specified CTL port.
372 The default value is 0.
378 Connect the serial port to the standard input and output of
383 Use the host TTY device for serial port I/O.
391 in the guest address space reserved for boot firmware.
394 Pass-through devices:
396 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
397 Connect to a PCI device on the host at the selector described by
405 Guest memory must be wired using the
407 option when a pass-through device is configured.
409 The host device must have been reserved at boot-time using the
411 loader variable as described in
414 Virtio console devices:
416 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
417 A maximum of 16 ports per device can be created.
418 Every port is named and corresponds to a Unix domain socket created by
421 accepts at most one connection per port at a time.
424 .Bl -bullet -offset 2n
426 Due to lack of destructors in
428 sockets on the filesystem must be cleaned up manually after
432 There is no way to use the "console port" feature, nor the console port
435 Emergency write is advertised, but no-op at present.
442 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
443 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
447 .It Ar IPv4:port No or Ar [IPv6%zone]:port
452 VNC should listen on.
453 The default is to listen on localhost IPv4 address and default VNC port 5900.
454 An IPv6 address must be enclosed in square brackets and may contain an
455 optional zone identifier.
456 .It Ar width No and Ar height
457 A display resolution, width and height, respectively.
458 If not specified, a default resolution of 1024x768 pixels will be used.
459 Minimal supported resolution is 640x480 pixels,
460 and maximum is 1920x1200 pixels.
462 Possible values for this option are
468 PCI graphics cards have a dual personality in that they are
469 standard PCI devices with BAR addressing, but may also
470 implicitly decode legacy VGA I/O space
473 .Pq 64KB at Ad 0xA0000 .
476 option should be used for guests that attempt to issue BIOS calls which result
477 in I/O port queries, and fail to boot if I/O decode is disabled.
481 option should be used along with the CSM BIOS capability in UEFI
482 to boot traditional BIOS guests that require the legacy VGA I/O and
483 memory regions to be available.
487 option should be used for the UEFI guests that assume that
488 VGA adapter is present if they detect the I/O ports.
489 An example of such a guest is
497 .Pq Lk https://wiki.freebsd.org/bhyve
498 for configuration notes of particular guests.
502 to only boot upon the initiation of a VNC connection, simplifying the
503 installation of operating systems that require immediate keyboard input.
504 This can be removed for post-installation use.
506 This type of authentication is known to be cryptographically weak and is not
507 intended for use on untrusted networks.
508 Many implementations will want to use stronger security, such as running
509 the session over an encrypted channel provided by IPsec or SSH.
516 A USB tablet device which provides precise cursor synchronization
523 Accepted device paths are:
528 .Ar ram=size_in_MiB .
530 Max number of queues.
532 Max elements in each queue.
534 Max number of concurrent I/O requests.
536 Sector size (defaults to blockif sector size).
538 Serial number with maximum 20 characters.
544 Playback device, typically
547 Recording device, typically
556 Set the universally unique identifier
558 in the guest's System Management BIOS System Information structure.
559 By default a UUID is generated from the host's hostname and
562 Ignore accesses to unimplemented Model Specific Registers (MSRs).
563 This is intended for debug purposes.
565 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
568 The guest's local APIC is configured in x2APIC mode.
570 Disable MPtable generation.
572 Alphanumeric name of the guest.
573 This should be the same as that created by
577 The current debug server provides limited support for debuggers.
579 Each virtual CPU is exposed to the debugger as a thread.
581 General purpose registers can be queried for each virtual CPU, but other
582 registers such as floating-point and system registers cannot be queried.
584 Memory (including memory mapped I/O regions) can be read and written by the debugger.
585 Memory operations use virtual addresses that are resolved to physical addresses
586 via the current virtual CPU's active address translation.
588 The running guest can be interrupted by the debugger at any time
589 .Pq for example, by pressing Ctrl-C in the debugger .
591 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
593 Breakpoints are supported on Intel CPUs that support single stepping.
594 Note that continuing from a breakpoint while interrupts are enabled in the
595 guest may not work as expected due to timer interrupts firing while single
596 stepping over the breakpoint.
599 deals with the following signals:
601 .Bl -tag -width indent -compact
603 Trigger ACPI poweroff for a VM
606 Exit status indicates how the VM was terminated:
608 .Bl -tag -width indent -compact
618 exited due to an error
621 If not using a boot ROM, the guest operating system must have been loaded with
623 or a similar boot loader before
626 Otherwise, the boot loader is not needed.
628 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
629 block device backed by the
631 filesystem image, and a serial port for the console:
632 .Bd -literal -offset indent
633 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
634 -l com1,stdio -A -H -P -m 1G vm1
637 Run a 24GB single-CPU virtual machine with three network ports, one of which
638 has a MAC address specified:
639 .Bd -literal -offset indent
640 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
641 -s 2:1,virtio-net,tap1 \\
642 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
643 -s 3,virtio-blk,/my/image -l com1,stdio \\
644 -A -H -P -m 24G bigvm
647 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
648 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
652 .Bd -literal -offset indent
654 -s 0,amd_hostbridge -s 1,lpc \\
655 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
656 hd:/images/disk.3,hd:/images/disk.4,\\
657 hd:/images/disk.5,hd:/images/disk.6,\\
658 hd:/images/disk.7,hd:/images/disk.8,\\
659 cd:/images/install.iso \\
660 -s 3,virtio-net,tap0 \\
661 -l com1,/dev/nmdm0A \\
665 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
666 that can be accessed via VNC at: 0.0.0.0:5900.
667 .Bd -literal -offset indent
668 bhyve -c 2 -m 4G -w -H \\
670 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
671 -s 4,ahci-hd,disk.img \\
672 -s 5,virtio-net,tap0 \\
673 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
675 -s 31,lpc -l com1,stdio \\
676 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
680 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
681 addresses on port 5900.
682 .Bd -literal -offset indent
683 bhyve -c 2 -m 4G -w -H \\
685 -s 4,ahci-hd,disk.img \\
686 -s 5,virtio-net,tap0 \\
687 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
689 -s 31,lpc -l com1,stdio \\
690 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
705 .%B 64 and IA-32 Architectures Software Developer’s Manual
713 .An Neel Natu Aq Mt neel@freebsd.org
714 .An Peter Grehan Aq Mt grehan@freebsd.org