share/man/man4/vmm.4

   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 .Dd December 19, 2013
  26 .Dt VMM 4
  27 .Os
  28 .Sh NAME
  29 .Nm vmm.ko
  30 .Nd "bhyve virtual machine monitor"
  31 .Sh SYNOPSIS
  32 To load the driver as a module at boot, add this line to
  33 .Xr loader.conf 5 :
  34 .Bd -literal -offset indent
  35 .Cd vmm_load="YES"
  36 .Ed
  37 .Pp
  38 The module can also be loaded manually with
  39 .Xr kldload 8 :
  40 .Bd -literal -offset indent
  41 kldload vmm
  42 .Ed
  43 .Sh DESCRIPTION
  44 .Nm
  45 provides the kernel portion of the
  46 .Xr bhyve 4
  47 hypervisor.
  48 .Pp
  49 An Intel CPU with VT-x/EPT or AMD CPU with SVM support is required.
  50 .Pp
  51 PCI device passthrough to a virtual machine requires
  52 hardware with VT-d support.
  53 .Sh PCI PASSTHROUGH
  54 When the hardware supports VT-d, and
  55 .Nm
  56 has been loaded at boot time,
  57 PCI devices can be reserved for use by the hypervisor.
  58 Entries consisting of the PCI
  59 .Ar bus Ns / Ns Ar slot Ns / Ns Ar function
  60 are added to the
  61 .Va pptdevs
  62 .Xr loader.conf 5
  63 variable.
  64 Additional entries are separated by spaces.
  65 Host PCI devices that match an entry will be assigned to the hypervisor
  66 and will not be probed by
  67 .Fx
  68 device drivers.
  69 See the
  70 .Sx EXAMPLES
  71 section below for sample usage.
  72 .Pp
  73 A large number of PCI device entries may require a string longer than the
  74 128-character limit of
  75 .Xr loader.conf 5
  76 variables.
  77 The
  78 .Va pptdevs2
  79 and
  80 .Va pptdevs3
  81 variables can be used for additional entries.
  82 .Sh EXAMPLES
  83 Reserve three PCI devices for use by the hypervisor: bus 10 slot 0 function 0,
  84 bus 6 slot 5 function 0, and bus 6 slot 5 function 1.
  85 .Bd -literal -offset indent
  86 pptdevs="10/0/0 6/5/0 6/5/1"
  87 .Ed
  88 .Sh SEE ALSO
  89 .Xr bhyve 4 ,
  90 .Xr loader.conf 5 ,
  91 .Xr bhyve 8 ,
  92 .Xr bhyveload 8 ,
  93 .Xr kldload 8
  94 .Sh HISTORY
  95 .Nm vmm.ko
  96 first appeared in
  97 .Fx 10.0 .
  98 .Sh AUTHORS
  99 .An Neel Natu Aq neel@freebsd.org
 100 .An Peter Grehan Aq grehan@freebsd.org