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 RNG interface.
263 .It Li virtio-console
264 Virtio console interface, which exposes multiple ports
265 to the guest in the form of simple char devices for simple IO
266 between the guest and host userspaces.
268 AHCI controller attached to arbitrary devices.
270 AHCI controller attached to an ATAPI CD/DVD.
272 AHCI controller attached to a SATA hard-drive.
274 Intel e82545 network interface.
276 PCI 16550 serial device.
278 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
279 The LPC bridge emulation can only be configured on bus 0.
281 Raw framebuffer device attached to VNC server.
283 eXtensible Host Controller Interface (xHCI) USB controller.
285 NVM Express (NVMe) controller.
287 High Definition Audio Controller.
290 This optional parameter describes the backend for device emulations.
293 is not specified, the device emulation has no backend and can be
294 considered unconnected.
298 .It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
299 .It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
300 .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
304 is not specified, the MAC address is derived from a fixed OUI and the
305 remaining bytes from an MD5 hash of the slot and function numbers and
308 The MAC address is an ASCII string in
312 With virtio-net devices, the
314 parameter can be specified to inform the guest about the largest MTU
315 that should be allowed, expressed in bytes.
317 With netgraph backend, the
321 parameters must be specified to set the destination node and corresponding hook.
322 The optional parameters
326 may be used to set the
328 node name and source hook.
339 Block storage devices:
341 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
342 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
346 .Ar block-device-options
356 Force the file to be opened read-only.
357 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
358 Specify the logical and physical sector sizes of the emulated disk.
359 The physical sector size is optional and is equal to the logical sector size
360 if not explicitly specified.
365 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
369 .Ar scsi-device-options
372 .It Li iid= Ns Ar IID
373 Initiator ID to use when sending requests to specified CTL port.
374 The default value is 0.
380 Connect the serial port to the standard input and output of
385 Use the host TTY device for serial port I/O.
393 in the guest address space reserved for boot firmware.
396 Pass-through devices:
398 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
399 Connect to a PCI device on the host at the selector described by
407 Guest memory must be wired using the
409 option when a pass-through device is configured.
411 The host device must have been reserved at boot-time using the
413 loader variable as described in
416 Virtio console devices:
418 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
419 A maximum of 16 ports per device can be created.
420 Every port is named and corresponds to a Unix domain socket created by
423 accepts at most one connection per port at a time.
426 .Bl -bullet -offset 2n
428 Due to lack of destructors in
430 sockets on the filesystem must be cleaned up manually after
434 There is no way to use the "console port" feature, nor the console port
437 Emergency write is advertised, but no-op at present.
444 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
445 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
449 .It Ar IPv4:port No or Ar [IPv6%zone]:port
454 VNC should listen on.
455 The default is to listen on localhost IPv4 address and default VNC port 5900.
456 An IPv6 address must be enclosed in square brackets and may contain an
457 optional zone identifier.
458 .It Ar width No and Ar height
459 A display resolution, width and height, respectively.
460 If not specified, a default resolution of 1024x768 pixels will be used.
461 Minimal supported resolution is 640x480 pixels,
462 and maximum is 1920x1200 pixels.
464 Possible values for this option are
470 PCI graphics cards have a dual personality in that they are
471 standard PCI devices with BAR addressing, but may also
472 implicitly decode legacy VGA I/O space
475 .Pq 64KB at Ad 0xA0000 .
478 option should be used for guests that attempt to issue BIOS calls which result
479 in I/O port queries, and fail to boot if I/O decode is disabled.
483 option should be used along with the CSM BIOS capability in UEFI
484 to boot traditional BIOS guests that require the legacy VGA I/O and
485 memory regions to be available.
489 option should be used for the UEFI guests that assume that
490 VGA adapter is present if they detect the I/O ports.
491 An example of such a guest is
499 .Pq Lk https://wiki.freebsd.org/bhyve
500 for configuration notes of particular guests.
504 to only boot upon the initiation of a VNC connection, simplifying the
505 installation of operating systems that require immediate keyboard input.
506 This can be removed for post-installation use.
508 This type of authentication is known to be cryptographically weak and is not
509 intended for use on untrusted networks.
510 Many implementations will want to use stronger security, such as running
511 the session over an encrypted channel provided by IPsec or SSH.
518 A USB tablet device which provides precise cursor synchronization
525 Accepted device paths are:
530 .Ar ram=size_in_MiB .
532 Max number of queues.
534 Max elements in each queue.
536 Max number of concurrent I/O requests.
538 Sector size (defaults to blockif sector size).
540 Serial number with maximum 20 characters.
546 Nominal Media Rotation Rate, known as RPM. value 1 will indicate device as Solid State Disk. default value is 0, not report.
548 Serial Number with maximum 20 characters.
550 Revision Number with maximum 8 characters.
552 Model Number with maximum 40 characters.
558 Playback device, typically
561 Recording device, typically
570 Set the universally unique identifier
572 in the guest's System Management BIOS System Information structure.
573 By default a UUID is generated from the host's hostname and
576 Ignore accesses to unimplemented Model Specific Registers (MSRs).
577 This is intended for debug purposes.
579 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
582 The guest's local APIC is configured in x2APIC mode.
584 Disable MPtable generation.
586 Alphanumeric name of the guest.
587 This should be the same as that created by
591 The current debug server provides limited support for debuggers.
593 Each virtual CPU is exposed to the debugger as a thread.
595 General purpose registers can be queried for each virtual CPU, but other
596 registers such as floating-point and system registers cannot be queried.
598 Memory (including memory mapped I/O regions) can be read and written by the debugger.
599 Memory operations use virtual addresses that are resolved to physical addresses
600 via the current virtual CPU's active address translation.
602 The running guest can be interrupted by the debugger at any time
603 .Pq for example, by pressing Ctrl-C in the debugger .
605 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
607 Breakpoints are supported on Intel CPUs that support single stepping.
608 Note that continuing from a breakpoint while interrupts are enabled in the
609 guest may not work as expected due to timer interrupts firing while single
610 stepping over the breakpoint.
613 deals with the following signals:
615 .Bl -tag -width indent -compact
617 Trigger ACPI poweroff for a VM
620 Exit status indicates how the VM was terminated:
622 .Bl -tag -width indent -compact
632 exited due to an error
635 If not using a boot ROM, the guest operating system must have been loaded with
637 or a similar boot loader before
640 Otherwise, the boot loader is not needed.
642 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
643 block device backed by the
645 filesystem image, and a serial port for the console:
646 .Bd -literal -offset indent
647 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
648 -l com1,stdio -A -H -P -m 1G vm1
651 Run a 24GB single-CPU virtual machine with three network ports, one of which
652 has a MAC address specified:
653 .Bd -literal -offset indent
654 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
655 -s 2:1,virtio-net,tap1 \\
656 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
657 -s 3,virtio-blk,/my/image -l com1,stdio \\
658 -A -H -P -m 24G bigvm
661 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
662 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
666 .Bd -literal -offset indent
668 -s 0,amd_hostbridge -s 1,lpc \\
669 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
670 hd:/images/disk.3,hd:/images/disk.4,\\
671 hd:/images/disk.5,hd:/images/disk.6,\\
672 hd:/images/disk.7,hd:/images/disk.8,\\
673 cd:/images/install.iso \\
674 -s 3,virtio-net,tap0 \\
675 -l com1,/dev/nmdm0A \\
679 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
680 that can be accessed via VNC at: 0.0.0.0:5900.
681 .Bd -literal -offset indent
682 bhyve -c 2 -m 4G -w -H \\
684 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
685 -s 4,ahci-hd,disk.img \\
686 -s 5,virtio-net,tap0 \\
687 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
689 -s 31,lpc -l com1,stdio \\
690 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
694 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
695 addresses on port 5900.
696 .Bd -literal -offset indent
697 bhyve -c 2 -m 4G -w -H \\
699 -s 4,ahci-hd,disk.img \\
700 -s 5,virtio-net,tap0 \\
701 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
703 -s 31,lpc -l com1,stdio \\
704 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
719 .%B 64 and IA-32 Architectures Software Developer’s Manual
727 .An Neel Natu Aq Mt neel@freebsd.org
728 .An Peter Grehan Aq Mt grehan@freebsd.org