diff options
| author | Roman Bogorodskiy <novel@FreeBSD.org> | 2026-07-22 17:02:47 +0000 |
|---|---|---|
| committer | Roman Bogorodskiy <novel@FreeBSD.org> | 2026-08-14 15:58:00 +0000 |
| commit | a257e2dc9c6ecd3db41e1aa27a5297a0f328694a (patch) | |
| tree | b4ac988d710cfde4ece7e138056493137daca1da | |
| parent | 5729a0b45cd1a24c8b82d161de4711b4e004498d (diff) | |
bhyve: document missing options in bhyve_config(5)
Document a few options that are currently supported but
not covered in bhyve_config(5):
- monitor
- vcpu.N.cpuset
- domains.N.{size,cpus,domain_policy}
- console (for arm64 and riscv)
MFC after: 1 week
Reviewed by: bnovkov, jhb
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D58399
| -rw-r--r-- | usr.sbin/bhyve/bhyve_config.5 | 51 |
1 files changed, 49 insertions, 2 deletions
diff --git a/usr.sbin/bhyve/bhyve_config.5 b/usr.sbin/bhyve/bhyve_config.5 index 8ed2281f43a9..aca87bbe08b1 100644 --- a/usr.sbin/bhyve/bhyve_config.5 +++ b/usr.sbin/bhyve/bhyve_config.5 @@ -24,7 +24,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd August 10, 2026 +.Dd August 14, 2026 .Dt BHYVE_CONFIG 5 .Os .Sh NAME @@ -236,9 +236,19 @@ to store its service files, such as the checkpoint socket. Overriding this path is useful when running .Xr bhyve 8 as an unprivileged user. +.It Va monitor Ta bool Ta false Ta +Run the VM in +.Ql monitor +mode. +More details are provided in +.Xr bhyve 8 . +.It Va vcpu.N.cpuset Ta string Ta none Ta +Comma-separated host CPU IDs and ranges to which virtual CPU +.Em N +is pinned. .El .Ss x86-Specific Settings -.Bl -column "x86.vmexit_on_pause" "integer" "Default" +.Bl -column "domains.N.domain_policy" "integer" "Default" .It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description .It Va x86.mptable Ta bool Ta true Ta Generate an MPTable. @@ -265,6 +275,43 @@ This allows idle guest CPUs to yield the host CPU. Force a VM exit when a guest CPU executes the .Dv PAUSE instruction. +.It Va domains.N.size Ta string Ta Ta +Guest physical memory size assigned to NUMA domain +.Em N . +The value must be formatted as described in +.Xr expand_number 3 . +If at least one NUMA domain is configured without a memory size, +the configured guest memory is split evenly across all configured domains. +.It Va domains.N.cpus Ta string Ta Ta +Comma-separated guest CPU IDs and ranges assigned to NUMA domain +.Em N . +This setting is required for each configured NUMA domain. +.It Va domains.N.domain_policy Ta string Ta Ta +Host NUMA memory allocation policy for the memory backing NUMA domain +.Em N . +The value uses the policy format accepted by +.Xr cpuset 1 +with the +.Fl n +option. +.El +.Ss arm64 and RISC-V Specific Settings +.Bl -column "console" "string" "Default" +.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description +.It Va console Ta string Ta Ta +Backend device for the console. +Supported backends are a character device pathname, +.Dq stdio , +and +.Ql tcp=ip:port . +The +.Dq stdio +backend uses standard input and output of the +.Xr bhyve 8 +process. +The +.Ql tcp=ip:port +backend listens for TCP connections. .El .Sh DEVICE SETTINGS Device settings are stored under a device node. |
