Differential D15022 Diff 42033 head/usr.sbin/bhyve/bhyve.8

Changeset View

Standalone View

head/usr.sbin/bhyve/bhyve.8

	Show All 18 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd April 6, 2018			.Dd May 1, 2018
	.Dt BHYVE 8			.Dt BHYVE 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm bhyve			.Nm bhyve
	.Nd "run a guest operating system inside a virtual machine"			.Nd "run a guest operating system inside a virtual machine"
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Op Fl abehuwxACHPSWY			.Op Fl abehuwxACHPSWY
	.Oo			.Oo
	.Fl c\~ Ns			.Fl c\~ Ns
	.Oo			.Oo
	.Op Ar cpus= Ns			.Op Ar cpus= Ns
	.Ar numcpus Ns			.Ar numcpus Ns
	.Oc Ns			.Oc Ns
	.Op Ar ,sockets=n Ns			.Op Ar ,sockets=n Ns
	.Op Ar ,cores=n Ns			.Op Ar ,cores=n Ns
	.Op Ar ,threads=n			.Op Ar ,threads=n
	.Oc			.Oc
	.Op Fl g Ar gdbport			.Op Fl g Ar gdbport
	.Op Fl l Ar lpcdev Ns Op , Ns Ar conf			.Op Fl l Ar lpcdev Ns Op , Ns Ar conf
	.Op Fl m Ar memsize Ns Op Ar K\|k\|M\|m\|G\|g\|T\|t			.Op Fl m Ar memsize Ns Op Ar K\|k\|M\|m\|G\|g\|T\|t
	.Op Fl p Ar vcpu:hostcpu			.Op Fl p Ar vcpu:hostcpu
	.Op Fl s Ar slot,emulation Ns Op , Ns Ar conf			.Op Fl s Ar slot,emulation Ns Op , Ns Ar conf
				.Op Fl G Ar port
	.Op Fl U Ar uuid			.Op Fl U Ar uuid
	.Ar vmname			.Ar vmname
	.Sh DESCRIPTION			.Sh DESCRIPTION
	.Nm			.Nm
	is a hypervisor that runs guest operating systems inside a			is a hypervisor that runs guest operating systems inside a
	virtual machine.			virtual machine.
	.Pp			.Pp
	Parameters such as the number of virtual CPUs, amount of guest memory, and			Parameters such as the number of virtual CPUs, amount of guest memory, and
	▲ Show 20 Lines • Show All 61 Lines • ▼ Show 20 Lines
	.It Fl g Ar gdbport			.It Fl g Ar gdbport
	For			For
	.Fx			.Fx
	kernels compiled with			kernels compiled with
	.Cd "device bvmdebug" ,			.Cd "device bvmdebug" ,
	allow a remote kernel kgdb to be relayed to the guest kernel gdb stub			allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
	via a local IPv4 address and this port.			via a local IPv4 address and this port.
	This option will be deprecated in a future version.			This option will be deprecated in a future version.
				.It Fl G Ar port
				Start a debug server that uses the GDB protocol to export guest state to a
				debugger.
				An IPv4 TCP socket will be bound to the supplied
				.Ar port
				to listen for debugger connections.
				Only a single debugger may be attached to the debug server at a time.
				If
				.Ar port
				begins with
				.Sq w ,
				.Nm
				will pause execution at the first instruction waiting for a debugger to attach.
	.It Fl h			.It Fl h
	Print help message and exit.			Print help message and exit.
	.It Fl H			.It Fl H
	Yield the virtual CPU thread when a HLT instruction is detected.			Yield the virtual CPU thread when a HLT instruction is detected.
	If this option is not specified, virtual CPUs will use 100% of a host CPU.			If this option is not specified, virtual CPUs will use 100% of a host CPU.
	.It Fl l Ar lpcdev Ns Op , Ns Ar conf			.It Fl l Ar lpcdev Ns Op , Ns Ar conf
	Allow devices behind the LPC PCI-ISA bridge to be configured.			Allow devices behind the LPC PCI-ISA bridge to be configured.
	The only supported devices are the TTY-class devices			The only supported devices are the TTY-class devices
	▲ Show 20 Lines • Show All 297 Lines • ▼ Show 20 Lines
	The guest's local APIC is configured in x2APIC mode.			The guest's local APIC is configured in x2APIC mode.
	.It Fl Y			.It Fl Y
	Disable MPtable generation.			Disable MPtable generation.
	.It Ar vmname			.It Ar vmname
	Alphanumeric name of the guest.			Alphanumeric name of the guest.
	This should be the same as that created by			This should be the same as that created by
	.Xr bhyveload 8 .			.Xr bhyveload 8 .
	.El			.El
				.Sh DEBUG SERVER
				The current debug server provides limited support for debuggers.
				.Ss Registers
				Each virtual CPU is exposed to the debugger as a thread.
				.Pp
				General purpose registers can be queried for each virtual CPU, but other
				registers such as floating-point and system registers cannot be queried.
				.Ss Memory
				Memory (including memory mapped I/O regions) can be read by the debugger,
				but not written. Memory operations use virtual addresses that are resolved
				to physical addresses via the current virtual CPU's active address translation.
				.Ss Control
				The running guest can be interrupted by the debugger at any time
				.Pq for example, by pressing Ctrl-C in the debugger .
				.Pp
				Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
				.Pp
				Breakpoints are not supported.
	.Sh SIGNAL HANDLING			.Sh SIGNAL HANDLING
	.Nm			.Nm
	deals with the following signals:			deals with the following signals:
	.Pp			.Pp
	.Bl -tag -width indent -compact			.Bl -tag -width indent -compact
	.It SIGTERM			.It SIGTERM
	Trigger ACPI poweroff for a VM			Trigger ACPI poweroff for a VM
	.El			.El
	▲ Show 20 Lines • Show All 86 Lines • Show Last 20 Lines