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"
38 .Op Fl l Ar lpcdev Ns Op , Ns Ar conf
39 .Op Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
40 .Op Fl p Ar vcpu:hostcpu
41 .Op Fl s Ar slot,emulation Ns Op , Ns Ar conf
46 is a hypervisor that runs guest operating systems inside a
49 Parameters such as the number of virtual CPUs, amount of guest memory, and
50 I/O connectivity can be specified with command-line parameters.
52 The guest operating system must be loaded with
54 or a similar boot loader before running
58 runs until the guest operating system reboots or an unhandled hypervisor
63 The guest's local APIC is configured in xAPIC mode.
64 The xAPIC mode is the default setting so this option is redundant.
65 It will be deprecated in a future version.
72 Enable a low-level console device supported by
75 .Cd "device bvmconsole" .
76 This option will be deprecated in a future version.
78 Number of guest virtual CPUs.
79 The default is 1 and the maximum is 16.
81 Include guest memory in core file.
85 to exit when a guest issues an access to an I/O port that is not emulated.
86 This is intended for debug purposes.
91 .Cd "device bvmdebug" ,
92 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
93 via a local IPv4 address and this port.
94 This option will be deprecated in a future version.
96 Print help message and exit.
98 Yield the virtual CPU thread when a HLT instruction is detected.
99 If this option is not specified, virtual CPUs will use 100% of a host CPU.
100 .It Fl l Ar lpcdev Ns Op , Ns Ar conf
101 Allow devices behind the LPC PCI-ISA bridge to be configured.
102 The only supported devices are the TTY-class devices
106 and the boot ROM device
108 .It Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
109 Guest physical memory size in bytes.
110 This must be the same size that was given to
113 The size argument may be suffixed with one of K, M, G or T (either upper
114 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
116 If no suffix is given, the value is assumed to be in megabytes.
117 .It Fl p Ar vcpu:hostcpu
118 Pin guest's virtual CPU
123 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
124 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
125 Configure a virtual PCI slot and function.
128 provides PCI bus emulation and virtual devices that can be attached to
130 There are 32 available slots, with the option of providing up to 8 functions
134 .Ar pcislot[:function]
135 .Ar bus:pcislot:function
146 If not specified, the
149 If not specified, the
154 .It Li hostbridge | Li amd_hostbridge
156 Provide a simple host bridge.
157 This is usually configured at slot 0, and is required by most guest
161 emulation is identical but uses a PCI vendor ID of
164 PCI pass-through device.
166 Virtio network interface.
168 Virtio block storage interface.
170 Virtio RNG interface.
172 AHCI controller attached to an ATAPI CD/DVD.
174 AHCI controller attached to a SATA hard-drive.
176 PCI 16550 serial device.
178 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
179 The LPC bridge emulation can only be configured on bus 0.
182 This optional parameter describes the backend for device emulations.
185 is not specified, the device emulation has no backend and can be
186 considered unconnected.
190 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
191 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
195 is not specified, the MAC address is derived from a fixed OUI and the
196 remaining bytes from an MD5 hash of the slot and function numbers and
199 The MAC address is an ASCII string in
204 Block storage devices:
206 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
207 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
211 .Ar block-device-options
221 Force the file to be opened read-only.
222 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
223 Specify the logical and physical sector sizes of the emulated disk.
224 The physical sector size is optional and is equal to the logical sector size
225 if not explicitly specified.
231 Connect the serial port to the standard input and output of
236 Use the host TTY device for serial port I/O.
244 in the guest address space reserved for boot firmware.
247 Pass-through devices:
249 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
250 Connect to a PCI device on the host at the selector described by
258 Guest memory must be wired using the
260 option when a pass-through device is configured.
262 The host device must have been reserved at boot-time using the
264 loader variable as described in
272 Set the universally unique identifier
274 in the guest's System Management BIOS System Information structure.
275 By default a UUID is generated from the host's hostname and
278 Ignore accesses to unimplemented Model Specific Registers (MSRs).
279 This is intended for debug purposes.
281 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
284 The guest's local APIC is configured in x2APIC mode.
286 Disable MPtable generation.
288 Alphanumeric name of the guest.
289 This should be the same as that created by
293 The guest operating system must have been loaded with
295 or a similar boot loader before
299 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
300 block device backed by the
302 filesystem image, and a serial port for the console:
303 .Bd -literal -offset indent
304 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
305 -l com1,stdio -A -H -P -m 1G vm1
308 Run a 24GB single-CPU virtual machine with three network ports, one of which
309 has a MAC address specified:
310 .Bd -literal -offset indent
311 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
312 -s 2:1,virtio-net,tap1 \\
313 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
314 -s 3,virtio-blk,/my/image -l com1,stdio \\
315 -A -H -P -m 24G bigvm
318 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
319 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
323 .Bd -literal -offset indent
325 -s 0,amd_hostbridge -s 1,lpc \\
326 -s 1:0,ahci-hd,/images/disk.1 \\
327 -s 1:1,ahci-hd,/images/disk.2 \\
328 -s 1:2,ahci-hd,/images/disk.3 \\
329 -s 1:3,ahci-hd,/images/disk.4 \\
330 -s 1:4,ahci-hd,/images/disk.5 \\
331 -s 1:5,ahci-hd,/images/disk.6 \\
332 -s 1:6,ahci-hd,/images/disk.7 \\
333 -s 1:7,ahci-hd,/images/disk.8 \\
334 -s 2,ahci-cd,/images/install.iso \\
335 -s 3,virtio-net,tap0 \\
336 -l com1,/dev/nmdm0A \\
351 .An Neel Natu Aq neel@freebsd.org
352 .An Peter Grehan Aq grehan@freebsd.org