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 memsize 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 If not using a boot ROM, the guest operating system must be loaded with
54 or a similar boot loader before running
56 otherwise, it is enough to run
58 with a boot ROM of choice.
61 runs until the guest operating system reboots or an unhandled hypervisor
66 The guest's local APIC is configured in xAPIC mode.
67 The xAPIC mode is the default setting so this option is redundant.
68 It will be deprecated in a future version.
75 Enable a low-level console device supported by
78 .Cd "device bvmconsole" .
79 This option will be deprecated in a future version.
81 Number of guest virtual CPUs.
82 The default is 1 and the maximum is 16.
84 Include guest memory in core file.
88 to exit when a guest issues an access to an I/O port that is not emulated.
89 This is intended for debug purposes.
94 .Cd "device bvmdebug" ,
95 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
96 via a local IPv4 address and this port.
97 This option will be deprecated in a future version.
99 Print help message and exit.
101 Yield the virtual CPU thread when a HLT instruction is detected.
102 If this option is not specified, virtual CPUs will use 100% of a host CPU.
103 .It Fl l Ar lpcdev Ns Op , Ns Ar conf
104 Allow devices behind the LPC PCI-ISA bridge to be configured.
105 The only supported devices are the TTY-class devices
109 and the boot ROM device
111 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
112 Guest physical memory size in bytes.
113 This must be the same size that was given to
116 The size argument may be suffixed with one of K, M, G or T (either upper
117 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
119 If no suffix is given, the value is assumed to be in megabytes.
123 .It Fl p Ar vcpu:hostcpu
124 Pin guest's virtual CPU
129 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
130 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
131 Configure a virtual PCI slot and function.
134 provides PCI bus emulation and virtual devices that can be attached to
136 There are 32 available slots, with the option of providing up to 8 functions
140 .Ar pcislot[:function]
141 .Ar bus:pcislot:function
152 If not specified, the
155 If not specified, the
160 .It Li hostbridge | Li amd_hostbridge
162 Provide a simple host bridge.
163 This is usually configured at slot 0, and is required by most guest
167 emulation is identical but uses a PCI vendor ID of
170 PCI pass-through device.
172 Virtio network interface.
174 Virtio block storage interface.
176 Virtio RNG interface.
177 .It Li virtio-console
178 Virtio console interface, which exposes multiple ports
179 to the guest in the form of simple char devices for simple IO
180 between the guest and host userspaces.
182 AHCI controller attached to arbitrary devices.
184 AHCI controller attached to an ATAPI CD/DVD.
186 AHCI controller attached to a SATA hard-drive.
188 Intel e82545 network interface.
190 PCI 16550 serial device.
192 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
193 The LPC bridge emulation can only be configured on bus 0.
195 Raw framebuffer device attached to VNC server.
197 eXtensible Host Controller Interface (xHCI) USB controller.
200 This optional parameter describes the backend for device emulations.
203 is not specified, the device emulation has no backend and can be
204 considered unconnected.
208 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
209 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
213 is not specified, the MAC address is derived from a fixed OUI and the
214 remaining bytes from an MD5 hash of the slot and function numbers and
217 The MAC address is an ASCII string in
222 Block storage devices:
224 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
225 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
229 .Ar block-device-options
239 Force the file to be opened read-only.
240 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
241 Specify the logical and physical sector sizes of the emulated disk.
242 The physical sector size is optional and is equal to the logical sector size
243 if not explicitly specified.
249 Connect the serial port to the standard input and output of
254 Use the host TTY device for serial port I/O.
262 in the guest address space reserved for boot firmware.
265 Pass-through devices:
267 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
268 Connect to a PCI device on the host at the selector described by
276 Guest memory must be wired using the
278 option when a pass-through device is configured.
280 The host device must have been reserved at boot-time using the
282 loader variable as described in
285 Virtio console devices:
287 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
288 A maximum of 16 ports per device can be created.
289 Every port is named and corresponds to a Unix domain socket created by
292 accepts at most one connection per port at a time.
295 .Bl -bullet -offset 2n
297 Due to lack of destructors in
299 sockets on the filesystem must be cleaned up manually after
303 There is no way to use the "console port" feature, nor the console port
306 Emergency write is advertised, but no-op at present.
313 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
314 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
318 .It Ar IPv4:port No or Ar [IPv6%zone]:port
323 VNC should listen on.
324 The default is to listen on localhost IPv4 address and default VNC port 5900.
325 An IPv6 address must be enclosed in square brackets and may contain an
326 optional zone identifer.
327 .It Ar width No and Ar height
328 A display resolution, width and height, respectively.
329 If not specified, a default resolution of 1024x768 pixels will be used.
330 Minimal supported resolution is 640x480 pixels,
331 and maximum is 1920x1200 pixels.
333 Possible values for this option are
339 PCI graphics cards have a dual personality in that they are
340 standard PCI devices with BAR addressing, but may also
341 implicitly decode legacy VGA I/O space
344 .Pq 64KB at Ad 0xA0000 .
347 option should be used for guests that attempt to issue BIOS calls which result
348 in I/O port queries, and fail to boot if I/O decode is disabled.
352 option should be used along with the CSM BIOS capability in UEFI
353 to boot traditional BIOS guests that require the legacy VGA I/O and
354 memory regions to be available.
358 option should be used for the UEFI guests that assume that
359 VGA adapter is present if they detect the I/O ports.
360 An example of such a guest is
368 .Pq Lk https://wiki.freebsd.org/bhyve
369 for configuration notes of particular guests.
373 to only boot upon the initiation of a VNC connection, simplifying the
374 installation of operating systems that require immediate keyboard input.
375 This can be removed for post-installation use.
377 This type of authentication is known to be cryptographically weak and is not
378 intended for use on untrusted networks.
379 Many implementations will want to use stronger security, such as running
380 the session over an encrypted channel provided by IPsec or SSH.
387 A USB tablet device which provides precise cursor synchronization
396 Set the universally unique identifier
398 in the guest's System Management BIOS System Information structure.
399 By default a UUID is generated from the host's hostname and
402 Ignore accesses to unimplemented Model Specific Registers (MSRs).
403 This is intended for debug purposes.
405 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
408 The guest's local APIC is configured in x2APIC mode.
410 Disable MPtable generation.
412 Alphanumeric name of the guest.
413 This should be the same as that created by
418 deals with the following signals:
420 .Bl -tag -width indent -compact
422 Trigger ACPI poweroff for a VM
425 Exit status indicates how the VM was terminated:
427 .Bl -tag -width indent -compact
437 exited due to an error
440 If not using a boot ROM, the guest operating system must have been loaded with
442 or a similar boot loader before
445 Otherwise, the boot loader is not needed.
447 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
448 block device backed by the
450 filesystem image, and a serial port for the console:
451 .Bd -literal -offset indent
452 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
453 -l com1,stdio -A -H -P -m 1G vm1
456 Run a 24GB single-CPU virtual machine with three network ports, one of which
457 has a MAC address specified:
458 .Bd -literal -offset indent
459 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
460 -s 2:1,virtio-net,tap1 \\
461 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
462 -s 3,virtio-blk,/my/image -l com1,stdio \\
463 -A -H -P -m 24G bigvm
466 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
467 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
471 .Bd -literal -offset indent
473 -s 0,amd_hostbridge -s 1,lpc \\
474 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
475 hd:/images/disk.3,hd:/images/disk.4,\\
476 hd:/images/disk.5,hd:/images/disk.6,\\
477 hd:/images/disk.7,hd:/images/disk.8,\\
478 cd:/images/install.iso \\
479 -s 3,virtio-net,tap0 \\
480 -l com1,/dev/nmdm0A \\
484 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
485 that can be accessed via VNC at: 0.0.0.0:5900.
486 .Bd -literal -offset indent
487 bhyve -c 2 -m 4G -w -H \\
489 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
490 -s 4,ahci-hd,disk.img \\
491 -s 5,virtio-net,tap0 \\
492 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
494 -s 31,lpc -l com1,stdio \\
495 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
499 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
500 addresses on port 5900.
501 .Bd -literal -offset indent
502 bhyve -c 2 -m 4G -w -H \\
504 -s 4,ahci-hd,disk.img \\
505 -s 5,virtio-net,tap0 \\
506 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
508 -s 31,lpc -l com1,stdio \\
509 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
522 .%B 64 and IA-32 Architectures Software Developer’s Manual
530 .An Neel Natu Aq Mt neel@freebsd.org
531 .An Peter Grehan Aq Mt grehan@freebsd.org