Sat Jul 29 23:11:51 2023 UTC ()
nvmm(4): Document that VMX Unrestricted Guest is required


(gdt)
diff -r1.6 -r1.7 src/share/man/man4/nvmm.4
cvs diff -r1.6 -r1.7 src/share/man/man4/nvmm.4 (expand / switch to unified diff)

--- src/share/man/man4/nvmm.4 2020/09/05 07:22:25 1.6
+++ src/share/man/man4/nvmm.4 2023/07/29 23:11:50 1.7
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: nvmm.4,v 1.6 2020/09/05 07:22:25 maxv Exp $ 1.\" $NetBSD: nvmm.4,v 1.7 2023/07/29 23:11:50 gdt Exp $
2.\" 2.\"
3.\" Copyright (c) 2018-2020 Maxime Villard, m00nbsd.net 3.\" Copyright (c) 2018-2020 Maxime Villard, m00nbsd.net
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" This code is part of the NVMM hypervisor. 6.\" This code is part of the NVMM hypervisor.
7.\" 7.\"
8.\" Redistribution and use in source and binary forms, with or without 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions 9.\" modification, are permitted provided that the following conditions
10.\" are met: 10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright 11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer. 12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the 14.\" notice, this list of conditions and the following disclaimer in the
@@ -16,47 +16,51 @@ @@ -16,47 +16,51 @@
16.\" 16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE. 27.\" SUCH DAMAGE.
28.\" 28.\"
29.Dd February 9, 2020 29.Dd July 30, 2023
30.Dt NVMM 4 30.Dt NVMM 4
31.Os 31.Os
32.Sh NAME 32.Sh NAME
33.Nm nvmm 33.Nm nvmm
34.Nd NetBSD Virtual Machine Monitor 34.Nd NetBSD Virtual Machine Monitor
35.Sh DESCRIPTION 35.Sh DESCRIPTION
36The 36The
37.Nm 37.Nm
38driver provides kernel support for hardware-accelerated virtualization. 38driver provides kernel support for hardware-accelerated virtualization.
39It is made of a generic MI frontend, to which MD backends can be plugged 39It is made of a generic MI frontend, to which MD backends can be plugged
40to implement the core virtualization. 40to implement the core virtualization.
41.Pp 41.Pp
42In practice, 42In practice,
43.Nm 43.Nm
44is used by the 44is used by the
45.Xr libnvmm 3 45.Xr libnvmm 3
46API to implement hypervisors. 46API to implement hypervisors.
47.Sh SUPPORT 47.Sh SUPPORT
48The following backends are supported: 48The following backends are supported:
49.Bl -hyphen -compact -offset indent 49.Bl -hyphen -compact -offset indent
50.It 50.It
51x86-SVM, for x86 AMD CPUs 51x86-SVM, for x86 AMD CPUs
52.It 52.It
53x86-VMX, for x86 Intel CPUs 53x86-VMX, for x86 Intel CPUs
54.El 54.El
 55Note that for VMX support, the CPU must also support "VMX Unrestricted
 56Guest", which is only present if Extended Page Tables (EPT) is
 57supported. The earliest CPU family with this feature is Westmere, and
 58not all later CPUs have it.
55.Sh SEE ALSO 59.Sh SEE ALSO
56.Xr libnvmm 3 , 60.Xr libnvmm 3 ,
57.Xr nvmmctl 8 61.Xr nvmmctl 8
58.Sh AUTHORS 62.Sh AUTHORS
59The 63The
60.Nm 64.Nm
61driver was written by 65driver was written by
62.An Maxime Villard . 66.An Maxime Villard .