1.\" 2.\" Copyright (c) 2018-2021 Maxime Villard, m00nbsd.net 3.\" All rights reserved. 4.\" 5.\" This code is part of the NVMM hypervisor. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.Dd July 29, 2021 29.Dt NVMM 4 30.Os 31.Sh NAME 32.Nm nvmm 33.Nd Lightweight Hypervisor 34.Sh SYNOPSIS 35To compile this driver into the kernel, 36place the following line in your 37kernel configuration file: 38.Bd -ragged -offset indent 39.Cd "pseudo-device nvmm" 40.Ed 41.Pp 42Alternatively, to load the driver as a 43module at boot time, place the following line in 44.Xr loader.conf 5 : 45.Bd -literal -offset indent 46nvmm_load="YES" 47.Ed 48.Sh DESCRIPTION 49The 50.Nm 51driver provides kernel support for hardware-accelerated virtualization. 52It is made of a generic MI frontend, to which MD backends can be plugged 53to implement the core virtualization. 54.Pp 55In practice, 56.Nm 57is used by the 58.Xr libnvmm 3 59API to implement hypervisors. 60.Sh SUPPORT 61The following backends are supported: 62.Bl -hyphen -compact -offset indent 63.It 64x86-SVM, for x86 AMD CPUs 65.It 66x86-VMX, for x86 Intel CPUs 67.El 68.Sh SEE ALSO 69.Xr libnvmm 3 , 70.Xr nvmmctl 8 71.Sh HISTORY 72.Nm 73first appeared in 74.Nx 759, 76and was ported to 77.Dx 786.1. 79.Sh AUTHORS 80The 81.Nm 82driver was written by 83.An Maxime Villard . 84