Differential D26035 Diff 83362 usr.sbin/bhyve/bhyve.8

Changeset View

Standalone View

usr.sbin/bhyve/bhyve.8

Show All 40 Lines
.Ar numcpus		.Ar numcpus
.Oc		.Oc
.Op Cm ,sockets= Ar n		.Op Cm ,sockets= Ar n
.Op Cm ,cores= Ar n		.Op Cm ,cores= Ar n
.Op Cm ,threads= Ar n		.Op Cm ,threads= Ar n
.Oc		.Oc
.Sm on		.Sm on
.Op Fl G Ar port		.Op Fl G Ar port
		.Op Fl k Ar file
.Oo Fl l		.Oo Fl l
.Sm off		.Sm off
.Cm help \| Ar lpcdev Op Cm \&, Ar conf		.Cm help \| Ar lpcdev Op Cm \&, Ar conf
.Sm on		.Sm on
.Oc		.Oc
.Oo Fl m		.Oo Fl m
.Sm off		.Sm off
.Ar memsize		.Ar memsize
.Oo		.Oo
.Cm K No \| Cm k No \| Cm M No \| Cm m No \| Cm G No \| Cm g No \| Cm T No \| Cm t		.Cm K No \| Cm k No \| Cm M No \| Cm m No \| Cm G No \| Cm g No \| Cm T No \| Cm t
.Oc		.Oc
.Sm on		.Sm on
.Oc		.Oc
		.Op Fl o Ar var Ns Cm = Ns Ar value
.Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu		.Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu
.Op Fl r Ar file		.Op Fl r Ar file
.Oo Fl s		.Oo Fl s
.Sm off		.Sm off
.Cm help \| Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf		.Cm help \| Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
.Sm on		.Sm on
.Oc		.Oc
.Op Fl U Ar uuid		.Op Fl U Ar uuid
▲ Show 20 Lines • Show All 74 Lines • ▼ Show 20 Lines
.Sq w ,		.Sq w ,
.Nm		.Nm
will pause execution at the first instruction waiting for a debugger to attach.		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 k Ar file
		Set configuration variables from a simple, key-value config file.
		Each line of the config file is expected to consist of a config variable
		name, an equals sign
		.Pq Sq = ,
		and a value.
		No spaces are permitted between the variable name, equals sign, or
		value.
		Blank lines and lines starting with
		.Sq #
		are ignored.
.It Fl l Op Ar help\|lpcdev Ns Op , Ns Ar conf		.It Fl l Op Ar help\|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
.Ar com1		.Ar com1
through		through
.Ar com4 ,		.Ar com4 ,
the boot ROM device		the boot ROM device
.Ar bootrom ,		.Ar bootrom ,
Show All 9 Lines
.Pp		.Pp
The size argument may be suffixed with one of K, M, G or T (either upper		The size argument may be suffixed with one of K, M, G or T (either upper
or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,		or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
or terabytes.		or terabytes.
If no suffix is given, the value is assumed to be in megabytes.		If no suffix is given, the value is assumed to be in megabytes.
.Pp		.Pp
.Ar memsize		.Ar memsize
defaults to 256M.		defaults to 256M.
		.It Fl o Ar var Ns Cm = Ns Ar value
		Set the configuration variable
		.Ar var
		to
		.Ar value .
.It Fl p Ar vcpu:hostcpu		.It Fl p Ar vcpu:hostcpu
Pin guest's virtual CPU		Pin guest's virtual CPU
.Em vcpu		.Em vcpu
to		to
.Em hostcpu .		.Em hostcpu .
.It Fl P		.It Fl P
Force the guest virtual CPU to exit when a PAUSE instruction is detected.		Force the guest virtual CPU to exit when a PAUSE instruction is detected.
.It Fl r Ar file		.It Fl r Ar file
▲ Show 20 Lines • Show All 404 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 CONFIGURATION VARIABLES
		.Nm
		uses an internal tree of configuration variables to describe global and
		per-device settings.
		When
		.Nm
		starts,
		it parses command line options (including config files) in the order given
		on the command line.
		Each command line option sets one or more configuration variables.
		For example,
		the
		.Fl s
		option creates a new tree node for a PCI device and sets one or more variables
		under that node including the device model and device model-specific variables.
		Variables may be set multiple times during this parsing stage with the final
		value overriding previous values.
		.Pp
		Once all of the command line options have been processed,
		the configuration values are frozen.
		.Nm
		then uses the value of configuration values to initialize device models
		and global settings.
		.Pp
		More details on configuration variables can be found in
		.Xr bhyve_config 5 .
.Sh DEBUG SERVER		.Sh DEBUG SERVER
The current debug server provides limited support for debuggers.		The current debug server provides limited support for debuggers.
.Ss Registers		.Ss Registers
Each virtual CPU is exposed to the debugger as a thread.		Each virtual CPU is exposed to the debugger as a thread.
.Pp		.Pp
General purpose registers can be queried for each virtual CPU, but other		General purpose registers can be queried for each virtual CPU, but other
registers such as floating-point and system registers cannot be queried.		registers such as floating-point and system registers cannot be queried.
.Ss Memory		.Ss Memory
▲ Show 20 Lines • Show All 107 Lines • ▼ Show 20 Lines	bhyve -c 2 -m 4G -w -H \\
uefivm		uefivm
.Ed		.Ed
.Sh SEE ALSO		.Sh SEE ALSO
.Xr bhyve 4 ,		.Xr bhyve 4 ,
.Xr netgraph 4 ,		.Xr netgraph 4 ,
.Xr ng_socket 4 ,		.Xr ng_socket 4 ,
.Xr nmdm 4 ,		.Xr nmdm 4 ,
.Xr vmm 4 ,		.Xr vmm 4 ,
		.Xr bhyve_config 5 ,
.Xr ethers 5 ,		.Xr ethers 5 ,
.Xr bhyvectl 8 ,		.Xr bhyvectl 8 ,
.Xr bhyveload 8		.Xr bhyveload 8
.Pp		.Pp
.Rs		.Rs
.%A Intel		.%A Intel
.%B 64 and IA-32 Architectures Software Developer’s Manual		.%B 64 and IA-32 Architectures Software Developer’s Manual
.%V Volume 3		.%V Volume 3
.Re		.Re
.Sh HISTORY		.Sh HISTORY
.Nm		.Nm
first appeared in		first appeared in
.Fx 10.0 .		.Fx 10.0 .
.Sh AUTHORS		.Sh AUTHORS
.An Neel Natu Aq Mt neel@freebsd.org		.An Neel Natu Aq Mt neel@freebsd.org
.An Peter Grehan Aq Mt grehan@freebsd.org		.An Peter Grehan Aq Mt grehan@freebsd.org