xref: /netbsd-src/share/man/man4/nvmm.4 (revision d9edfcdd69132acb0a8297ca9f14e5bf7d039666)
1.\"	$NetBSD: nvmm.4,v 1.8 2023/07/30 00:11:32 wiz Exp $
2.\"
3.\" Copyright (c) 2018-2020 Maxime Villard, m00nbsd.net
4.\" All rights reserved.
5.\"
6.\" This code is part of the NVMM hypervisor.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
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
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
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
27.\" SUCH DAMAGE.
28.\"
29.Dd July 30, 2023
30.Dt NVMM 4
31.Os
32.Sh NAME
33.Nm nvmm
34.Nd NetBSD Virtual Machine Monitor
35.Sh DESCRIPTION
36The
37.Nm
38driver provides kernel support for hardware-accelerated virtualization.
39It is made of a generic MI frontend, to which MD backends can be plugged
40to implement the core virtualization.
41.Pp
42In practice,
43.Nm
44is used by the
45.Xr libnvmm 3
46API to implement hypervisors.
47.Sh SUPPORT
48The following backends are supported:
49.Bl -hyphen -compact -offset indent
50.It
51x86-SVM, for x86 AMD CPUs
52.It
53x86-VMX, for x86 Intel CPUs
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.
58The earliest CPU family with this feature is Westmere, and not all
59later CPUs have it.
60.Sh SEE ALSO
61.Xr libnvmm 3 ,
62.Xr nvmmctl 8
63.Sh AUTHORS
64The
65.Nm
66driver was written by
67.An Maxime Villard .
68