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