1.\" Copyright (c) 2013 Peter Grehan 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd December 19, 2013 28.Dt VMM 4 29.Os 30.Sh NAME 31.Nm vmm.ko 32.Nd "bhyve virtual machine monitor" 33.Sh SYNOPSIS 34.Pp 35To load the driver as a module at boot, add this line to 36.Xr loader.conf 5 : 37.Bd -literal -offset indent 38.Cd vmm_load="YES" 39.Ed 40.Pp 41The module can also be loaded manually with 42.Xr kldload 8 : 43.Bd -literal -offset indent 44kldload vmm 45.Ed 46.Sh DESCRIPTION 47.Nm 48provides the kernel portion of the 49.Xr bhyve 4 50hypervisor. 51.Pp 52An Intel CPU with VT-x/EPT or AMD CPU with SVM support is required. 53.Pp 54PCI device passthrough to a virtual machine requires 55hardware with VT-d support. 56.Sh PCI PASSTHROUGH 57When the hardware supports VT-d, and 58.Nm 59has been loaded at boot time, 60PCI devices can be reserved for use by the hypervisor. 61Entries consisting of the PCI 62.Ar bus Ns / Ns Ar slot Ns / Ns Ar function 63are added to the 64.Va pptdevs 65.Xr loader.conf 5 66variable. 67Additional entries are separated by spaces. 68Host PCI devices that match an entry will be assigned to the hypervisor 69and will not be probed by 70.Fx 71device drivers. 72See the 73.Sx EXAMPLES 74section below for sample usage. 75.Pp 76A large number of PCI device entries may require a string longer than the 77128-character limit of 78.Xr loader.conf 5 79variables. 80The 81.Va pptdevs2 82and 83.Va pptdevs3 84variables can be used for additional entries. 85.Sh EXAMPLES 86Reserve three PCI devices for use by the hypervisor: bus 10 slot 0 function 0, 87bus 6 slot 5 function 0, and bus 6 slot 5 function 1. 88.Bd -literal -offset indent 89pptdevs="10/0/0 6/5/0 6/5/1" 90.Ed 91.Sh SEE ALSO 92.Xr bhyve 4 , 93.Xr loader.conf 5 , 94.Xr bhyve 8 , 95.Xr bhyveload 8 , 96.Xr kldload 8 97.Sh HISTORY 98.Nm vmm.ko 99first appeared in 100.Fx 10.0 . 101.Sh AUTHORS 102.An Neel Natu Aq neel@freebsd.org 103.An Peter Grehan Aq grehan@freebsd.org 104 105 106