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
66 .Cm help | Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
73 is a hypervisor that runs guest operating systems inside a
76 Parameters such as the number of virtual CPUs, amount of guest memory, and
77 I/O connectivity can be specified with command-line parameters.
79 If not using a boot ROM, the guest operating system must be loaded with
81 or a similar boot loader before running
83 otherwise, it is enough to run
85 with a boot ROM of choice.
88 runs until the guest operating system reboots or an unhandled hypervisor
93 The guest's local APIC is configured in xAPIC mode.
94 The xAPIC mode is the default setting so this option is redundant.
95 It will be deprecated in a future version.
102 Enable a low-level console device supported by
104 kernels compiled with
105 .Cd "device bvmconsole" .
106 This option will be deprecated in a future version.
107 .It Fl c Op Ar setting ...
108 Number of guest virtual CPUs
109 and/or the CPU topology.
110 The default value for each of
117 The current maximum number of guest virtual CPUs is 16.
120 is not specified then it will be calculated from the other arguments.
121 The topology must be consistent in that the
123 must equal the product of
130 is specified more than once the last one has precedence.
132 Include guest memory in core file.
136 to exit when a guest issues an access to an I/O port that is not emulated.
137 This is intended for debug purposes.
141 kernels compiled with
142 .Cd "device bvmdebug" ,
143 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
144 via a local IPv4 address and this port.
145 This option will be deprecated in a future version.
147 Start a debug server that uses the GDB protocol to export guest state to a
149 An IPv4 TCP socket will be bound to the supplied
151 to listen for debugger connections.
152 Only a single debugger may be attached to the debug server at a time.
158 will pause execution at the first instruction waiting for a debugger to attach.
160 Print help message and exit.
162 Yield the virtual CPU thread when a HLT instruction is detected.
163 If this option is not specified, virtual CPUs will use 100% of a host CPU.
164 .It Fl l Op Ar help|lpcdev Ns Op , Ns Ar conf
165 Allow devices behind the LPC PCI-ISA bridge to be configured.
166 The only supported devices are the TTY-class devices
170 and the boot ROM device
174 print a list of supported LPC devices.
175 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
176 Guest physical memory size in bytes.
177 This must be the same size that was given to
180 The size argument may be suffixed with one of K, M, G or T (either upper
181 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
183 If no suffix is given, the value is assumed to be in megabytes.
187 .It Fl p Ar vcpu:hostcpu
188 Pin guest's virtual CPU
193 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
194 .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
195 Configure a virtual PCI slot and function.
198 provides PCI bus emulation and virtual devices that can be attached to
200 There are 32 available slots, with the option of providing up to 8 functions
204 print a list of supported PCI devices.
206 .Ar pcislot[:function]
207 .Ar bus:pcislot:function
218 If not specified, the
221 If not specified, the
226 .It Li hostbridge | Li amd_hostbridge
228 Provide a simple host bridge.
229 This is usually configured at slot 0, and is required by most guest
233 emulation is identical but uses a PCI vendor ID of
236 PCI pass-through device.
238 Virtio network interface.
240 Virtio block storage interface.
242 Virtio SCSI interface.
244 Virtio RNG interface.
245 .It Li virtio-console
246 Virtio console interface, which exposes multiple ports
247 to the guest in the form of simple char devices for simple IO
248 between the guest and host userspaces.
250 AHCI controller attached to arbitrary devices.
252 AHCI controller attached to an ATAPI CD/DVD.
254 AHCI controller attached to a SATA hard-drive.
256 Intel e82545 network interface.
258 PCI 16550 serial device.
260 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
261 The LPC bridge emulation can only be configured on bus 0.
263 Raw framebuffer device attached to VNC server.
265 eXtensible Host Controller Interface (xHCI) USB controller.
267 NVM Express (NVMe) controller.
269 High Definition Audio Controller.
272 This optional parameter describes the backend for device emulations.
275 is not specified, the device emulation has no backend and can be
276 considered unconnected.
280 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
281 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
285 is not specified, the MAC address is derived from a fixed OUI and the
286 remaining bytes from an MD5 hash of the slot and function numbers and
289 The MAC address is an ASCII string in
294 Block storage devices:
296 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
297 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
301 .Ar block-device-options
311 Force the file to be opened read-only.
312 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
313 Specify the logical and physical sector sizes of the emulated disk.
314 The physical sector size is optional and is equal to the logical sector size
315 if not explicitly specified.
320 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
324 .Ar scsi-device-options
327 .It Li iid= Ns Ar IID
328 Initiator ID to use when sending requests to specified CTL port.
329 The default value is 0.
335 Connect the serial port to the standard input and output of
340 Use the host TTY device for serial port I/O.
348 in the guest address space reserved for boot firmware.
351 Pass-through devices:
353 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
354 Connect to a PCI device on the host at the selector described by
362 Guest memory must be wired using the
364 option when a pass-through device is configured.
366 The host device must have been reserved at boot-time using the
368 loader variable as described in
371 Virtio console devices:
373 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
374 A maximum of 16 ports per device can be created.
375 Every port is named and corresponds to a Unix domain socket created by
378 accepts at most one connection per port at a time.
381 .Bl -bullet -offset 2n
383 Due to lack of destructors in
385 sockets on the filesystem must be cleaned up manually after
389 There is no way to use the "console port" feature, nor the console port
392 Emergency write is advertised, but no-op at present.
399 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
400 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
404 .It Ar IPv4:port No or Ar [IPv6%zone]:port
409 VNC should listen on.
410 The default is to listen on localhost IPv4 address and default VNC port 5900.
411 An IPv6 address must be enclosed in square brackets and may contain an
412 optional zone identifier.
413 .It Ar width No and Ar height
414 A display resolution, width and height, respectively.
415 If not specified, a default resolution of 1024x768 pixels will be used.
416 Minimal supported resolution is 640x480 pixels,
417 and maximum is 1920x1200 pixels.
419 Possible values for this option are
425 PCI graphics cards have a dual personality in that they are
426 standard PCI devices with BAR addressing, but may also
427 implicitly decode legacy VGA I/O space
430 .Pq 64KB at Ad 0xA0000 .
433 option should be used for guests that attempt to issue BIOS calls which result
434 in I/O port queries, and fail to boot if I/O decode is disabled.
438 option should be used along with the CSM BIOS capability in UEFI
439 to boot traditional BIOS guests that require the legacy VGA I/O and
440 memory regions to be available.
444 option should be used for the UEFI guests that assume that
445 VGA adapter is present if they detect the I/O ports.
446 An example of such a guest is
454 .Pq Lk https://wiki.freebsd.org/bhyve
455 for configuration notes of particular guests.
459 to only boot upon the initiation of a VNC connection, simplifying the
460 installation of operating systems that require immediate keyboard input.
461 This can be removed for post-installation use.
463 This type of authentication is known to be cryptographically weak and is not
464 intended for use on untrusted networks.
465 Many implementations will want to use stronger security, such as running
466 the session over an encrypted channel provided by IPsec or SSH.
473 A USB tablet device which provides precise cursor synchronization
480 Accepted device paths are:
485 .Ar ram=size_in_MiB .
487 Max number of queues.
489 Max elements in each queue.
491 Max number of concurrent I/O requests.
493 Sector size (defaults to blockif sector size).
495 Serial number with maximum 20 characters.
501 Playback device, typically
504 Recording device, typically
513 Set the universally unique identifier
515 in the guest's System Management BIOS System Information structure.
516 By default a UUID is generated from the host's hostname and
519 Ignore accesses to unimplemented Model Specific Registers (MSRs).
520 This is intended for debug purposes.
522 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
525 The guest's local APIC is configured in x2APIC mode.
527 Disable MPtable generation.
529 Alphanumeric name of the guest.
530 This should be the same as that created by
534 The current debug server provides limited support for debuggers.
536 Each virtual CPU is exposed to the debugger as a thread.
538 General purpose registers can be queried for each virtual CPU, but other
539 registers such as floating-point and system registers cannot be queried.
541 Memory (including memory mapped I/O regions) can be read and written by the debugger.
542 Memory operations use virtual addresses that are resolved to physical addresses
543 via the current virtual CPU's active address translation.
545 The running guest can be interrupted by the debugger at any time
546 .Pq for example, by pressing Ctrl-C in the debugger .
548 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
550 Breakpoints are supported on Intel CPUs that support single stepping.
551 Note that continuing from a breakpoint while interrupts are enabled in the
552 guest may not work as expected due to timer interrupts firing while single
553 stepping over the breakpoint.
556 deals with the following signals:
558 .Bl -tag -width indent -compact
560 Trigger ACPI poweroff for a VM
563 Exit status indicates how the VM was terminated:
565 .Bl -tag -width indent -compact
575 exited due to an error
578 If not using a boot ROM, the guest operating system must have been loaded with
580 or a similar boot loader before
583 Otherwise, the boot loader is not needed.
585 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
586 block device backed by the
588 filesystem image, and a serial port for the console:
589 .Bd -literal -offset indent
590 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
591 -l com1,stdio -A -H -P -m 1G vm1
594 Run a 24GB single-CPU virtual machine with three network ports, one of which
595 has a MAC address specified:
596 .Bd -literal -offset indent
597 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
598 -s 2:1,virtio-net,tap1 \\
599 -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
600 -s 3,virtio-blk,/my/image -l com1,stdio \\
601 -A -H -P -m 24G bigvm
604 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
605 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
609 .Bd -literal -offset indent
611 -s 0,amd_hostbridge -s 1,lpc \\
612 -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
613 hd:/images/disk.3,hd:/images/disk.4,\\
614 hd:/images/disk.5,hd:/images/disk.6,\\
615 hd:/images/disk.7,hd:/images/disk.8,\\
616 cd:/images/install.iso \\
617 -s 3,virtio-net,tap0 \\
618 -l com1,/dev/nmdm0A \\
622 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
623 that can be accessed via VNC at: 0.0.0.0:5900.
624 .Bd -literal -offset indent
625 bhyve -c 2 -m 4G -w -H \\
627 -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
628 -s 4,ahci-hd,disk.img \\
629 -s 5,virtio-net,tap0 \\
630 -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
632 -s 31,lpc -l com1,stdio \\
633 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
637 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
638 addresses on port 5900.
639 .Bd -literal -offset indent
640 bhyve -c 2 -m 4G -w -H \\
642 -s 4,ahci-hd,disk.img \\
643 -s 5,virtio-net,tap0 \\
644 -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
646 -s 31,lpc -l com1,stdio \\
647 -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
660 .%B 64 and IA-32 Architectures Software Developer’s Manual
668 .An Neel Natu Aq Mt neel@freebsd.org
669 .An Peter Grehan Aq Mt grehan@freebsd.org