share/man/man4/vmx.4

   1 .\"
   2 .\" Copyright (c) 2006,2013 Reyk Floeter <reyk@openbsd.org>
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $OpenBSD: src/share/man/man4/vmx.4,v 1.1 2013/05/31 20:18:44 reyk Exp $
  17 .\"
  18 .\" $FreeBSD$
  19 .\"
  20 .Dd March 17, 2014
  21 .Dt VMX 4
  22 .Os
  23 .Sh NAME
  24 .Nm vmx
  25 .Nd VMware VMXNET3 Virtual Interface Controller device
  26 .Sh SYNOPSIS
  27 To compile this driver into the kernel,
  28 place the following line in your
  29 kernel configuration file:
  30 .Bd -ragged -offset indent
  31 .Cd "device vmx"
  32 .Ed
  33 .Pp
  34 Alternatively, to load the driver as a
  35 module at boot time, place the following line in
  36 .Xr loader.conf 5 :
  37 .Bd -literal -offset indent
  38 if_vmx_load="YES"
  39 .Ed
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver provides support for the VMXNET3 virtual NIC available in virtual
  44 machines by VMware.
  45 It appears as a simple Ethernet device but is actually a virtual network
  46 interface to the underlying host operating system.
  47 .Pp
  48 This driver supports the
  49 .Ic VMXNET3
  50 driver protocol, as an alternative to the emulated
  51 .Xr pcn 4 ,
  52 .Xr em 4
  53 interfaces also available in the VMware environment.
  54 The
  55 .Nm
  56 driver is optimized for the virtual machine, it can provide advanced
  57 capabilities depending on the underlying host operating system and
  58 the physical network interface controller of the host.
  59 The
  60 .Nm
  61 driver supports features like multiqueue support, IPv6
  62 checksum offloading, MSI/MSI-X support and hardware VLAN tagging in
  63 VMware's VLAN Guest Tagging (VGT) mode.
  64 .Pp
  65 The
  66 .Nm
  67 driver supports VMXNET3 VMware virtual NICs provided by the virtual
  68 machine hardware version 7 or newer, as provided by the following
  69 products:
  70 .Pp
  71 .Bl -bullet -compact -offset indent
  72 .It
  73 VMware ESX/ESXi 4.0 and newer
  74 .It
  75 VMware Server 2.0 and newer
  76 .It
  77 VMware Workstation 6.5 and newer
  78 .It
  79 VMware Fusion 2.0 and newer
  80 .El
  81 .Pp
  82 For more information on configuring this device, see
  83 .Xr ifconfig 8 .
  84 .Sh MULTIPLE QUEUES
  85 The
  86 .Nm
  87 driver supports multiple transmit and receive queues.
  88 Multiple queues are only supported by certain VMware products, such as ESXi.
  89 The number of queues allocated depends on the presence of MSI-X,
  90 the number of configured CPUs,
  91 and the tunables listed below.
  92 .Fx
  93 does not enable MSI-X support on VMware by default.
  94 The
  95 .Va hw.pci.honor_msi_blacklist
  96 tunable must be disabled to enable MSI-X support.
  97 .Sh LOADER TUNABLES
  98 Tunables can be set at the
  99 .Xr loader 8
 100 prompt before booting the kernel or stored in
 101 .Xr loader.conf 5 .
 102 .Bl -tag -width indent
 103 .It Va hw.vmx.txnqueue
 104 .It Va hw.vmx. Ns Ar X Ns Va .txnqueue
 105 Maximum number of transmit queues allocated by default by the driver.
 106 The default value is 8.
 107 The maximum supported by the VMXNET3 virtual NIC is 8.
 108 .It Va hw.vmx.rxnqueue
 109 .It Va hw.vmx. Ns Ar X Ns Va .rxnqueue
 110 Maximum number of receive queues allocated by default by the driver.
 111 The default value is 8.
 112 The maximum supported by the VMXNET3 virtual NIC is 16.
 113 .It Va hw.vmx.txndesc
 114 .It Va hw.vmx. Ns Ar X Ns Va .txndesc
 115 .Pp
 116 Number of transmit descriptors allocated by the driver.
 117 The default value is 512.
 118 The value must be a multiple of 32, and the maximum is 4096.
 119 .It Va hw.vmx.rxndesc
 120 .It Va hw.vmx. Ns Ar X Ns Va .rxndesc
 121 .Pp
 122 Number of receive descriptors per ring allocated by the driver.
 123 The default value is 256.
 124 The value must be a multiple of 32, and the maximum is 2048.
 125 There are two rings so the actual usage is doubled.
 126 .El
 127 .Sh EXAMPLES
 128 The following entry must be added to the VMware configuration file
 129 to provide the
 130 .Nm
 131 device:
 132 .Bd -literal -offset indent
 133 ethernet0.virtualDev = "vmxnet3"
 134 .Ed
 135 .Sh SEE ALSO
 136 .Xr altq 4 ,
 137 .Xr arp 4 ,
 138 .Xr em 4 ,
 139 .Xr netintro 4 ,
 140 .Xr ng_ether 4 ,
 141 .Xr pcn 4 ,
 142 .Xr vlan 4 ,
 143 .Xr ifconfig 8
 144 .Sh AUTHORS
 145 .An -nosplit
 146 The
 147 .Nm
 148 driver was ported from
 149 .Ox
 150 and significantly rewritten by
 151 .An Bryan Venteicher Aq bryanv@freebsd.org .
 152 The
 153 .Ox
 154 driver was written by
 155 .An Tsubai Masanari .