doc/guides/nics/enic.rst

   1 ..  BSD LICENSE
   2     Copyright (c) 2015, Cisco Systems, Inc.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     1. Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11
  12     2. Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in
  14     the documentation and/or other materials provided with the
  15     distribution.
  16
  17     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  20     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  21     COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  23     BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  25     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27     ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28     POSSIBILITY OF SUCH DAMAGE.
  29
  30 ENIC Poll Mode Driver
  31 =====================
  32
  33 ENIC PMD is the DPDK poll-mode driver for the Cisco System Inc. VIC Ethernet
  34 NICs. These adapters are also referred to as vNICs below. If you are running
  35 or would like to run DPDK software applications on Cisco UCS servers using
  36 Cisco VIC adapters the following documentation is relevant.
  37
  38 How to obtain ENIC PMD integrated DPDK
  39 --------------------------------------
  40
  41 ENIC PMD support is integrated into the DPDK suite. dpdk-<version>.tar.gz
  42 should be downloaded from http://core.dpdk.org/download/
  43
  44
  45 Configuration information
  46 -------------------------
  47
  48 - **DPDK Configuration Parameters**
  49
  50   The following configuration options are available for the ENIC PMD:
  51
  52   - **CONFIG_RTE_LIBRTE_ENIC_PMD** (default y): Enables or disables inclusion
  53     of the ENIC PMD driver in the DPDK compilation.
  54
  55   - **CONFIG_RTE_LIBRTE_ENIC_DEBUG** (default n): Enables or disables debug
  56     logging within the ENIC PMD driver.
  57
  58 - **vNIC Configuration Parameters**
  59
  60   - **Number of Queues**
  61
  62     The maximum number of receive queues (RQs), work queues (WQs) and
  63     completion queues (CQs) are configurable on a per vNIC basis
  64     through the Cisco UCS Manager (CIMC or UCSM).
  65
  66     These values should be configured as follows:
  67
  68     - The number of WQs should be greater or equal to the value of the
  69       expected nb_tx_q parameter in the call to the
  70       rte_eth_dev_configure()
  71
  72     - The number of RQs configured in the vNIC should be greater or
  73       equal to *twice* the value of the expected nb_rx_q parameter in
  74       the call to rte_eth_dev_configure().  With the addition of rx
  75       scatter, a pair of RQs on the vnic is needed for each receive
  76       queue used by DPDK, even if rx scatter is not being used.
  77       Having a vNIC with only 1 RQ is not a valid configuration, and
  78       will fail with an error message.
  79
  80     - The number of CQs should set so that there is one CQ for each
  81       WQ, and one CQ for each pair of RQs.
  82
  83     For example: If the application requires 3 Rx queues, and 3 Tx
  84     queues, the vNIC should be configured to have at least 3 WQs, 6
  85     RQs (3 pairs), and 6 CQs (3 for use by WQs + 3 for use by the 3
  86     pairs of RQs).
  87
  88   - **Size of Queues**
  89
  90     Likewise, the number of receive and transmit descriptors are configurable on
  91     a per vNIC bases via the UCS Manager and should be greater than or equal to
  92     the nb_rx_desc and   nb_tx_desc parameters expected to be used in the calls
  93     to rte_eth_rx_queue_setup() and rte_eth_tx_queue_setup() respectively.
  94     An application requesting more than the set size will be limited to that
  95     size.
  96
  97     Unless there is a lack of resources due to creating many vNICs, it
  98     is recommended that the WQ and RQ sizes be set to the maximum.  This
  99     gives the application the greatest amount of flexibility in its
 100     queue configuration.
 101
 102     - *Note*: Since the introduction of rx scatter, for performance
 103       reasons, this PMD uses two RQs on the vNIC per receive queue in
 104       DPDK.  One RQ holds descriptors for the start of a packet the
 105       second RQ holds the descriptors for the rest of the fragments of
 106       a packet.  This means that the nb_rx_desc parameter to
 107       rte_eth_rx_queue_setup() can be a greater than 4096.  The exact
 108       amount will depend on the size of the mbufs being used for
 109       receives, and the MTU size.
 110
 111       For example: If the mbuf size is 2048, and the MTU is 9000, then
 112       receiving a full size packet will take 5 descriptors, 1 from the
 113       start of packet queue, and 4 from the second queue.  Assuming
 114       that the RQ size was set to the maximum of 4096, then the
 115       application can specify up to 1024 + 4096 as the nb_rx_desc
 116       parameter to rte_eth_rx_queue_setup().
 117
 118   - **Interrupts**
 119
 120     Only one interrupt per vNIC interface should be configured in the UCS
 121     manager regardless of the number receive/transmit queues. The ENIC PMD
 122     uses this interrupt to get information about link status and errors
 123     in the fast path.
 124
 125 .. _enic-flow-director:
 126
 127 Flow director support
 128 ---------------------
 129
 130 Advanced filtering support was added to 1300 series VIC firmware starting
 131 with version 2.0.13 for C-series UCS servers and version 3.1.2 for UCSM
 132 managed blade servers. In order to enable advanced filtering the 'Advanced
 133 filter' radio button should be enabled via CIMC or UCSM followed by a reboot
 134 of the server.
 135
 136 With advanced filters, perfect matching of all fields of IPv4, IPv6 headers
 137 as well as TCP, UDP and SCTP L4 headers is available through flow director.
 138 Masking of these feilds for partial match is also supported.
 139
 140 Without advanced filter support, the flow director is limited to IPv4
 141 perfect filtering of the 5-tuple with no masking of fields supported.
 142
 143 Ingress VLAN Rewrite
 144 --------------------
 145
 146 VIC adapters can tag, untag, or modify the VLAN headers of ingress
 147 packets. The ingress VLAN rewrite mode controls this behavior. By
 148 default, it is set to pass-through, where the NIC does not modify the
 149 VLAN header in any way so that the application can see the original
 150 header. This mode is sufficient for many applications, but may not be
 151 suitable for others. Such applications may change the mode by setting
 152 ``devargs`` parameter ``ig-vlan-rewrite`` to one of the following.
 153
 154 - ``pass``: Pass-through mode. The NIC does not modify the VLAN
 155   header. This is the default mode.
 156
 157 - ``priority``: Priority-tag default VLAN mode. If the ingress packet
 158   is tagged with the default VLAN, the NIC replaces its VLAN header
 159   with the priority tag (VLAN ID 0).
 160
 161 - ``trunk``: Default trunk mode. The NIC tags untagged ingress packets
 162   with the default VLAN. Tagged ingress packets are not modified. To
 163   the application, every packet appears as tagged.
 164
 165 - ``untag``: Untag default VLAN mode. If the ingress packet is tagged
 166   with the default VLAN, the NIC removes or untags its VLAN header so
 167   that the application sees an untagged packet. As a result, the
 168   default VLAN becomes `untagged`. This mode can be useful for
 169   applications such as OVS-DPDK performance benchmarks that utilize
 170   only the default VLAN and want to see only untagged packets.
 171
 172 Limitations
 173 -----------
 174
 175 - **VLAN 0 Priority Tagging**
 176
 177   If a vNIC is configured in TRUNK mode by the UCS manager, the adapter will
 178   priority tag egress packets according to 802.1Q if they were not already
 179   VLAN tagged by software. If the adapter is connected to a properly configured
 180   switch, there will be no unexpected behavior.
 181
 182   In test setups where an Ethernet port of a Cisco adapter in TRUNK mode is
 183   connected point-to-point to another adapter port or connected though a router
 184   instead of a switch, all ingress packets will be VLAN tagged. Programs such
 185   as l3fwd may not account for VLAN tags in packets and may misbehave. One
 186   solution is to enable VLAN stripping on ingress so the VLAN tag is removed
 187   from the packet and put into the mbuf->vlan_tci field. Here is an example
 188   of how to accomplish this:
 189
 190 .. code-block:: console
 191
 192      vlan_offload = rte_eth_dev_get_vlan_offload(port);
 193      vlan_offload |= ETH_VLAN_STRIP_OFFLOAD;
 194      rte_eth_dev_set_vlan_offload(port, vlan_offload);
 195
 196 Another alternative is modify the adapter's ingress VLAN rewrite mode so that
 197 packets with the default VLAN tag are stripped by the adapter and presented to
 198 DPDK as untagged packets. In this case mbuf->vlan_tci and the PKT_RX_VLAN and
 199 PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the
 200 ``devargs`` parameter ``ig-vlan-rewrite=untag``. For example::
 201
 202     -w 12:00.0,ig-vlan-rewrite=untag
 203
 204 - Limited flow director support on 1200 series and 1300 series Cisco VIC
 205   adapters with old firmware. Please see :ref:`enic-flow-director`.
 206
 207 - Flow director features are not supported on generation 1 Cisco VIC adapters
 208   (M81KR and P81E)
 209
 210 How to build the suite?
 211 -----------------------
 212 The build instructions for the DPDK suite should be followed. By default
 213 the ENIC PMD library will be built into the DPDK library.
 214
 215 For configuring and using UIO and VFIO frameworks, please refer the
 216 documentation that comes with DPDK suite.
 217
 218 Supported Cisco VIC adapters
 219 ----------------------------
 220
 221 ENIC PMD supports all recent generations of Cisco VIC adapters including:
 222
 223 - VIC 1280
 224 - VIC 1240
 225 - VIC 1225
 226 - VIC 1285
 227 - VIC 1225T
 228 - VIC 1227
 229 - VIC 1227T
 230 - VIC 1380
 231 - VIC 1340
 232 - VIC 1385
 233 - VIC 1387
 234
 235 Supported Operating Systems
 236 ---------------------------
 237 Any Linux distribution fulfilling the conditions described in Dependencies
 238 section of DPDK documentation.
 239
 240 Supported features
 241 ------------------
 242 - Unicast, multicast and broadcast transmission and reception
 243 - Receive queue polling
 244 - Port Hardware Statistics
 245 - Hardware VLAN acceleration
 246 - IP checksum offload
 247 - Receive side VLAN stripping
 248 - Multiple receive and transmit queues
 249 - Flow Director ADD, UPDATE, DELETE, STATS operation support IPv4 and IPv6
 250 - Promiscuous mode
 251 - Setting RX VLAN (supported via UCSM/CIMC only)
 252 - VLAN filtering (supported via UCSM/CIMC only)
 253 - Execution of application by unprivileged system users
 254 - IPV4, IPV6 and TCP RSS hashing
 255 - Scattered Rx
 256 - MTU update
 257
 258 Known bugs and Unsupported features in this release
 259 ---------------------------------------------------
 260 - Signature or flex byte based flow direction
 261 - Drop feature of flow direction
 262 - VLAN based flow direction
 263 - non-IPV4 flow direction
 264 - Setting of extended VLAN
 265 - UDP RSS hashing
 266 - MTU update only works if Scattered Rx mode is disabled
 267
 268 Prerequisites
 269 -------------
 270 - Prepare the system as recommended by DPDK suite.  This includes environment
 271   variables, hugepages configuration, tool-chains and configuration
 272 - Insert vfio-pci kernel module using the command 'modprobe vfio-pci' if the
 273   user wants to use VFIO framework
 274 - Insert uio kernel module using the command 'modprobe uio' if the user wants
 275   to use UIO framework
 276 - DPDK suite should be configured based on the user's decision to use VFIO or
 277   UIO framework
 278 - If the vNIC device(s) to be used is bound to the kernel mode Ethernet driver
 279   (enic), use 'ifconfig' to bring the interface down. The dpdk-devbind.py tool
 280   can then be used to unbind the device's bus id from the enic kernel mode
 281   driver.
 282 - Bind the intended vNIC to vfio-pci in case the user wants ENIC PMD to use
 283   VFIO framework using dpdk-devbind.py.
 284 - Bind the intended vNIC to igb_uio in case the user wants ENIC PMD to use
 285   UIO framework using dpdk-devbind.py.
 286
 287 At this point the system should be ready to run DPDK applications. Once the
 288 application runs to completion, the vNIC can be detached from vfio-pci or
 289 igb_uio if necessary.
 290
 291 Root privilege is required to bind and unbind vNICs to/from VFIO/UIO.
 292 VFIO framework helps an unprivileged user to run the applications.
 293 For an unprivileged user to run the applications on DPDK and ENIC PMD,
 294 it may be necessary to increase the maximum locked memory of the user.
 295 The following command could be used to do this.
 296
 297 .. code-block:: console
 298
 299     sudo sh -c "ulimit -l <value in Kilo Bytes>"
 300
 301 The value depends on the memory configuration of the application, DPDK and
 302 PMD.  Typically, the limit has to be raised to higher than 2GB.
 303 e.g., 2621440
 304
 305 The compilation of any unused drivers can be disabled using the
 306 configuration file in config/ directory (e.g., config/common_linuxapp).
 307 This would help in bringing down the time taken for building the
 308 libraries and the initialization time of the application.
 309
 310 Additional Reference
 311 --------------------
 312 - http://www.cisco.com/c/en/us/products/servers-unified-computing
 313
 314 Contact Information
 315 -------------------
 316 Any questions or bugs should be reported to DPDK community and to the ENIC PMD
 317 maintainers:
 318
 319 - John Daley <johndale@cisco.com>
 320 - Nelson Escobar <neescoba@cisco.com>