Home

MLNX_EN for Linux User Manual

1. Support and Updates Webpage Please visit http www mellanox com gt Products gt Software gt Ethernet Drivers gt Linux Drivers for downloads FAQ troubleshooting future updates to this manual etc Mellanox Technologies 9 J Rev 2 3 1 0 0 Overview 1 Overview This document provides information on the MLNX EN Linux driver and instructions for install ing the driver on Mellanox ConnectX adapter cards supporting 10Gb s and 40Gb s Ethernet The MLNX_EN driver release exposes the following capabilities Single Dual port Up to 16 Rx queues per port 16 Tx queues per port Rx steering mode Receive Core Affinity RCA MSI X or INTx Adaptive interrupt moderation HW Tx Rx checksum calculation Large Send Offload 1 e TCP Segmentation Offload Large Receive Offload Multi core NAPI support VLAN Tx Rx acceleration HW VLAN stripping insertion Ethtool support Net device statistics SR IOV support Flow steering Ethernet Time Stamping at beta level 1 1 MLNX EN Package Contents 1 1 1 Tarball Package MLNX_EN for Linux is provided as a tarball that includes source code and firmware The tarball contains an installation script called install sh that performs the necessary steps to accomplish the following e Discover the currently installed kernel Uninstall any previously installed MLNX OFED MLNX EN packages Install the MLNX EN binary if they are available for the current kernel Identify
2. Toadd a VLAN In the example below the following state exist cat sys class net eth5 v 0 vlan set oper 012 3 admin 0 1 2 3 Step 1 Make an operational VLAN set identical to the administration VLAN echo 2 3 4 5 6 gt sys class net eth5 vf0 vlan set The delta will be added to the operational state immediately 4 5 6 cat sys class net eth5 v 0 vlan set open O 1 eg 4 5 G admin 23 45 6 Step 2 Reset the VF for changes to take effect 42 Mellanox Technologies Rev 2 3 1 0 0 3 4 2 Ethernet VXLAN 3 4 2 1 Prerequisites HCA ConnectX 3 Pro Firmware 2 31 5020 or higher RHEL7 Ubuntu 14 04 or upstream kernel 3 12 10 or higher DMFS enabled 3 4 2 2 Enabling VXLAN To enable the vxlan offloads support load the mix4 core driver with Device Managed Flow steering DMFS enabled Best would be to create an etc modprobe d mlx4 conf file with the following contents enable DMFS gt enable VXLAN offloads on CX3 pro options mlx4 core log num mgm entry size 1 To verify VXLAN is enabled verify the Ethernet net device created by the mlx4 en driver advertises the NETIF F GSO UpP TUNNEL feature which can be seen by the eththool K DEV grep udp For example ethtool k eth0 grep udp tnl tx udp tnl segmentation on Make sure that the VXLAN tunnel is set over UDP port 4789 which is the ConnectX firmware default If using standard Linux bridge and not open vswitch set the following etc mo
3. Counter Description IX packets Total packets successfully received on ring i rx lt i gt _bytes Total bytes in successfully received packets on ring i tx lt i gt _packets Total packets successfully transmitted on ring i tx lt 1 gt _bytes Total bytes in successfully transmitted packets on ring 1 Mellanox Technologies 57 J Rev 2 3 1 0 0 Troubleshooting 4 Troubleshooting You may be able to easily resolve the issues described in this section If a problem persists and you are unable to resolve it yourself please contact your Mellanox representative or Mellanox Support at support mellanox com 4 1 General Related Issues Table 15 General Related Issues Issue Cause Solution Ra The system panics when Malfunction hardware com Remove the failed adapter it is booted with a failed ponent 2 Reboot the system adapter installed Mellanox adapter is not PCI slot or adapter PCI 1 Run 1spci identified as a PCI connector dysfunctionality 2 Reseat the adapter in its PCI slot or device insert the adapter to a different PCI slot If the PCI slot confirmed to be func tional the adapter should be replaced Mellanox adapters are Misidentification of the Run the command below and check not installed in the sys Mellanox adapter installed Mellanox s MAC to identify the Mella tem nox adapter installed lspci grep Mellanox or lspci d 15b3 Mellanox MACs start with 00 02 C9 xx xx
4. Admin privileged user can enable disable time stamping through calling ioctl sock SIOCSHWT STAMP amp ifreq with following values Send side time sampling Mellanox Technologies 25 J Rev 2 3 1 0 0 Feature Overview and Configuration Enabled by ifreq hwtstamp config tx type when 26 Mellanox Technologies Rev 2 3 1 0 0 Receive side time sampling Enabled by ifreq hwtstamp config rx filter when possible values for hwtstamp config rx filter enum hwtstamp rx filters time stamp no incoming packet at all HWTSTAMP FILTER NONE time stamp any incoming packet HWTSTAMP FILTER ALL return value time stamp all packets requested plus some others HWTSTAMP FILTER SOME PTP v1 UDP any kind of event packet HWTSTAMP FILTER PTP V1 L4 EVENT PTP v1 UDP Sync packet HWTSTAMP FILTER PTP V1 L4 SYNC PTP v1 UDP Delay reg packet HWTSTAMP FILTER PTP V1 L4 DELAY REQ PTP v2 UDP any kind of event packet HWTSTAMP FILTER PTP V2 L4 EVENT PTP v2 UDP Sync packet HWTSTAMP FILTER PTP V2 L4 SYNC PTP v2 UDP Delay reg packet HWTSTAMP FILTER PTP V2 L4 DELAY REQ 802 AS1 Ethernet any kind of event packet HWTSTAMP FILTER PTP V2 L2 EVENT 802 AS1 Ethernet Sync packet HWTSTAMP FILTER PTP V2 L2 SYNC 802 AS1 Ethernet Delay req packet HWTSTAMP FILTER PTP V2 L2 DELAY REQ PTP v2 802 A81 a
5. mlx4 core log num mgm entry size value Step3 Restart the driver To disable Flow Steering Step 1 Open the etc modprobe d mlnx conf file Step 2 Remove the options mlx4 core log num mgm entry size value Step3 Restart the driver 3 3 2 Flow Steering Support To determine which Flow Steering features are supported ethtool show priv flags eth4 The following output is shown mlx4 flow steering ethernet 12 on Creating Ethernet L2 MAC rules is supported mlx4 flow steering ipv4 on Creating IPv4 rules is supported mlx4 flow steering tcp on Creating TCP UDP rules is supported Flow Steering support in InfiniBand is determined according to the EXP MANAGED FLOW STEERING flag af 3 3 3 A0 Static Device Managed Flow Steering This mode enables fast steering however it might impact flexibility Using it increases the packet rate performance by 30 with the following limitations for Ethernet link layer unicast QPs Limits the number of opened RSS Kernel QPs to 96 MACS should be unique 1 MAC per 1 QP The number of VFs is limited Mellanox Technologies 29 J Rev 2 3 1 0 0 Feature Overview and Configuration 3 3 4 When creating Flow Steering rules for user QPs only MAC gt QP rules are allowed Both MACs and QPs should be unique between rules Only 62 such rules could be cre ated When creating rules with Ethtool MAC gt QP rules could be used where the QP must be the
6. 57 Table 15 General Related Issues 1 0 0 0 cc cette nen ene n ees 58 Table 16 Ethernet Related Issues 0 1 nett eee eee n nes 58 Table 17 Performance Related Issues 1 0 oct tenet eens 60 Table 18 SR IOV Related ISSUES y piire a E a NE EA hh 60 Mellanox Technologies 5 J Rev 2 3 1 0 0 Document Revision History Table 1 Document Revision History Release Date Description 2 3 1 0 0 September 2014 e Added the following sections Section 1 1 1 Tarball Package on page 10 Section 1 1 3 Firmware on page 11 Section 1 1 4 Directory Structure on page 11 Section 1 2 1 mlx4 Module Parameters on page 12 Section 2 2 Downloading MLNX EN on page 14 Section 2 3 1 Installation Modes on page 14 Section 3 3 2 Flow Steering Support on page 29 Section 3 3 3 AO Static Device Managed Flow Steer ing on page 29 Section 3 4 1 7 Virtual Guest Tagging VGT on page 41 Section 3 5 1 Reset Flow on page 44 Section 3 9 Explicit Congestion Notification ECN on page 50 Section 4 1 General Related Issues on page 58 Section 4 2 Ethernet Related Issues on page 58 Section 4 3 Performance Related Issues on page 60 Section 4 4 SR IOV Related Issues on page 60 Updated the following section Section 3 3 1 Enable Disable Flow Steering on page 28 Section 3 4 1 2 Setting Up SR IOV on page 32 Section 3 6 Ethtool on page 44 2 2
7. A user s sk priois mapped to UP which in turn is mapped into TC Indicating the UP e When the user uses sk prio it is mapped into a UP by the tc tool This is done by the tc wrap py tool which gets a list of lt 16 comma separated UP and maps the sk prio to the specified UP For example tc wrap py ieth0 u 1 5 maps sk prio 0 of etho device to UP 1 and sk prio 1to UP 5 Setting set egress map in VLAN maps the skb priority of the VLAN to a v1an qos The v1an qos is represents a UP for the VLAN device n RoCE rdma set option with RbMA oPTION ID TOS could be used to set the UP When creating QPs the s1 field in ibv modify qp command represents the UP Indicating the TC After mapping the skb priority to UP one should map the UP into a TC This assigns the user priority to a specific hardware traffic class In order to do that n1nx qos should be used m1nx qos gets a list of a mapping between UPs to TCs For example m1nx qos ieth0 p 0 0 0 0 1 1 1 1 maps UPs 0 3 to Tco and Ups 4 7 to Tc1 3 1 4 Quality of Service Properties The different QoS properties that can be assigned to a TC are Strict Priority see Strict Priority e Minimal Bandwidth Guarantee ETS see Minimal Bandwidth Guarantee ETS Rate Limit see Rate Limit 3 1 4 1 Strict Priority When setting a TC s transmission algorithm to be strict then this TC has absolute strict prior ity over other TC strict priorities coming befo
8. If the HCA does not support SR IOV please contact Mellanox Support support mellanox com 34 Mellanox Technologies Rev 2 3 1 0 0 Parameter Recommended Value num vfs Ifabsent or zero no VFs will be available e Ifits value is a single number in the range of 0 63 The driver will enable the num v s VFs on the HCA and this will be applied to all ConnectX amp HCAs on the host Ifits a triplet x y z applies only if all ports are config ured as Ethernet the driver creates xsingle port VFs on physical port 1 ysingle port VFs on physical port 2 applies only if such a port exist zn port VFs where n is the number of physical ports on device This applies to all ConnectX HCAs on the host fits format is a string The string specifies the num vfs parameter separately per installed HCA The string format is bb dd f v bb dd f v bb dd f bus device function of the PF of the HCA v number of VFs to enable for that HCA which is either a single value or a triplet as described above For example num vfs 5 The driver will enable 5 VFs on the HCA and this will be applied to all ConnectX HCAs on the host num vfs 00 04 0 5 00 07 0 8 The driver will enable 5 VFs on the HCA positioned in BDF 00 04 0 and 8 on the one in 00 07 0 num vfs 1 2 3 The driver will enable 1 VF on physical port 1 2 VFs on physical port 2 and 3 dual port VFs applies only to dual port HCA when all ports are E
9. It works by aggregating multiple incoming packets from a single stream into a larger buffer before they are passed higher up the networking stack thus reducing the number of packets that have to be processed LRO is available in kernel versions 3 1 for untagged traffic Note LRO will be done whenever possible Otherwise GRO will be done Generic Receive Offload GRO is available throughout all kernels Hardware Vlan Striping Offload rxvlan When enabled received VIAN traffic will be stripped from the VLAN tag by the hardware ethtool c eth lt x gt Queries interrupt coalescing settings ethtool C eth lt x gt adaptive rx Enables disables adaptive interrupt moderation onjoff By default the driver uses adaptive interrupt moderation for the receive path which adjusts the moderation time to the traffic pattern Mellanox Technologies 45 J Rev 2 3 1 0 0 Feature Overview and Configuration Table 7 ethtool Supported Options Options Description ethtool C eth lt x gt pkt rate low N pkt rate high N rx usecs low N rx usecs high N Sets the values for packet rate limits and for moderation time high and low values Above an upper limit of packet rate adaptive mod eration will set the moderation time to its highest value Below a lower limit of packet rate the moderation time will be set to its lowest value ethtool C eth lt x gt rx usecs N rx frames N Sets
10. 1 0 1 May 2014 e Added the following sections Section 3 4 1 6 3 Mapping VFs to Ports using the mlnx get vfs pl Tool on page 41 Section 3 6 Ethtool on page 44 Section 3 8 Quantized Congestion Control on page 47 Section 3 8 Quantized Congestion Control on page 47 Section 3 10 Power Management on page 52 Section 3 11 XOR RSS Hash Function on page 52 Updated the following section Section 3 4 1 2 Setting Up SR IOV on page 32 Removed the following sections Burning Firmware with SR IOV Performance 2 1 1 0 0 January 2014 Added Section 3 12 Ethernet Performance Counters on page 52 6 Mellanox Technologies J Rev 2 3 1 0 0 Table 1 Document Revision History Release Date Description 2 0 3 0 0 October 2013 Added the following sections Section 3 4 1 Single Root IO Virtualization SR IOV on page 31 Section 3 3 Flow Steering on page 28 Section 3 2 Time Stamping Service on page 25 Mellanox Technologies 7 J Rev 2 3 1 0 0 About this Manual This Preface provides general information concerning the scope and organization of this User s Manual Intended Audience This manual is intended for system administrators responsible for the installation configuration management and maintenance of the software and hardware of VPI InfiniBand Ethernet adapter cards It is also intended for application developers Common
11. 2 3 1 0 0 tgz Step3 Change the working directory gt cd ming en 2 3 1 0 0 Step 4 Run the installation script gt install sh 2 3 2 1 Installing MLNX EN on XenServer6 1 gt To install mlnx en 2 3 1 0 0 on XenServer6 1 rpm ihv RPMS xenserver6ul i386 uname r mlnx en rpm 2 4 Loading MLNX EN Step 1 Make sure no previous driver version is currently loaded gt modprobe r mlx4 en Step 2 Load the new driver version gt modprobe mlx4 en The result is a new net device appearing in the ifconfig a output For details on driver usage and configuration please refer to Section 2 8 Firmware Programming on page 16 On Ubuntu OS the mlnx en service is responsible for loading the mlx4 en driver upon boot Mellanox Technologies 15 J Rev 2 3 1 0 0 Installation 2 5 2 6 2 7 2 8 2 8 1 Unloading MLNX_EN gt To unload the Ethernet driver gt modprobe r mlx4 en Uninstalling MLNX EN Use the script sbin mlnx en uninstall sh to uninstall the Mellanox OFED package Recompiling MLNX EN gt To recompile the driver Step 1 Enter the source directory cd usr src mellanox mlnx en 2 0 Step2 Apply kernel backport patch gt scripts mlnx en patch sh Step 3 Compile the driver sources gt make Step 4 Install the driver kernel modules gt make install Firmware Programming The adapter card was shipped with the most current firmware available This sectio
12. Flow Steering Flow Steering is applicable to the mlx4 driver only Flow steering is a new model which steers network flows based on flow specifications to specific QPs Those flows can be either unicast or multicast network flows In order to maintain flexibil ity domains and priorities are used Flow steering uses a methodology of flow attribute which is a combination of L2 L4 flow specifications a destination QP and a priority Flow steering rules could be inserted either by using ethtool or by using InfiniBand verbs The verbs abstraction uses an opposed terminology of a flow attribute ibv flow attr defined by a combination of specifi cations struct ibv_flow_spec_ 3 3 1 Enable Disable Flow Steering Flow steering is generally enabled when the 1og_num_mgm_entry_size module parameter is non positive e g 1og num mgm entry size meaning the absolute value of the parameter is a bit field Every bit indicates a condition or an option regarding the flow steering mechanism reserved b2 b1 bo bit Operation Description b0 Force device managed Flow When set to 1 it forces HCA to be enabled regardless of Steering whether NC SI Flow Steering is supported or not bl Disable IPoIB Flow Steering When set to 1 it disables the support of IPoIB Flow Steer ing This bit should be set to 1 when b2 Enable AO static DMFS steering is used see Section 3 3 3 AO Static Device Managed Flow S
13. en_ecn module parameter of mlx4 ib to 1 options mlx4 ib en ecn 1 Enabling ECN To enable ECN on the hosts Step 1 Enable ECN in sysfs proc sys net ipv4 tcp ecn 1 Step 2 Enable ECN CLI options mlx4 ib en ecn 1 Step3 Restart the driver etc init d openibd restart Step 4 Mount debugfs to access ECN attributes mount t debugfs none sys kernel debug Please note mounting of debugfs is required The following is an example for ECN configuration through debugfs echo to enable attribute sys kernel debug mlx4_ib lt device gt ecn lt algo gt ports 1 params prios lt prio gt lt the requested attribute gt ENC supports the following algorithms r roce ecn rp e r roce ecn np Each algorithm has a set of relevant parameters and statistics which are defined per device per port per priority 50 Mellanox Technologies Rev 2 3 1 0 0 r roce ecn np has an extra set of general parameters which are defined per device ECN and QCN are not compatible When using ECN QCN and all its related dae d mons utilities that could enable it i e Ildpad should be turned OFF Mellanox Technologies 51 J Rev 2 3 1 0 0 Feature Overview and Configuration 3 9 2 Various ECN Paths The following are the paths to ECM algorithm general parameters and counters The path to an algorithm attribute is except for general parameters sys kernel debug mlx4_ib DEVICE ecn algorithm ports port params prios prio
14. indirection RSS QP Creating rules that indirect traffic to other rings is not allowed Ethtool MAC rules to drop packets action 1 are supported RFS is not supported in this mode VLAN is not supported in this mode Flow Domains and Priorities Flow steering defines the concept of domain and priority Each domain represents a user agent that can attach a flow The domains are prioritized A higher priority domain will always super sede a lower priority domain when their flow specifications overlap Setting a lower priority value will result in higher priority In addition to the domain there is priority within each of the domains Each domain can have at most 2 12 priorities in accordance to its needs The following are the domains at a descending order of priority Ethtool Ethtool domain is used to attach an RX ring specifically its QP to a specified flow Please refer to the most recent ethtool manpage for all the ways to specify a flow Examples e ethtool U eth5 flow type ether dst 00 11 22 33 44 55 loc 5 action 2 All packets that contain the above destination MAC address are to be steered into rx ring 2 its underlying QP with priority 5 within the ethtool domain ethtool U eth5 flow type tcp4 src ip 1 2 3 4 dst port 8888 loc 5 action 2 All packets that contain the above destination IP address and source port are to be steered into rx ring 2 When destination MAC is not given the user s destination MAC is fille
15. port types 1 ib 2 eth 3 auto 4 N A If only a single port is available use the N A port type for port2 Se AN log num gp log maximum number of QPs per HCA default 19 int log num srq log maximum number of SRQs per HCA default 16 int log rdmarc per qp log number of RDMARC buffers per QP default 4 int log num cq log maximum number of CQs per HCA default 16 int log num mcg log maximum number of multicast groups per HCA default 13 int log num mpt log maximum number of memory protection table entries per HCA default 19 int log num mtt log maximum number of memory translation table segments per HCA default max 20 2 MTTs for register all of the host mem ory limited to 30 int enable qos Enable Quality of Service support in the HCA default off bool internal err reset Reset device on internal errors if non zero default is 1 int 1 2 1 2 mlx4 en Parameters inline thold Threshold for using inline data int Default and max value is 104 bytes Saves PCI read operation transaction packet less then threshold size will be copied to hw buffer directly udp rss Enable RSS for incoming UDP traffic uint On by default Once disabled no RSS for incoming UDP traffic will be done pfctx Priority based Flow Control policy on TX 7 0 Per priority bit mask uint pfcrx Priority based Flow Control policy on RX 7 0 Per priority bit mask uint Mellanox Technologies
16. the currently installed HCAs and perform the required firmware updates 10 Mellanox Technologies Rev 2 3 1 0 0 1 1 2 Software Components MLNX_EN contains the following software components Table 5 MLNX_EN Software Components Components Description mlx4 driver mlx4 is the low level driver implementation for the ConnectX adapters designed by Mellanox Technologies The ConnectX can operate as an InfiniBand adapter and as an Ethernet NIC To accommodate the two flavors the driver is split into modules mlx4 core mlx4 en and mlx4 ib Note mlx4 ib is not part of this package mlx4 core Handles low level functions like device initialization and firmware commands processing Also controls resource allocation so that the InfiniBand Ethernet and FC functions can share a device without interfering with each other mlx4 en Handles Ethernet specific functions and plugs into the netdev mid layer mstflint An application to burn a firmware binary image Software modules Source code for all software modules for use under conditions mentioned in the modules LICENSE files Documentation Release Notes User Manual 1 1 3 Firmware The tarball image includes the following firmware items Firmware images bin format for ConnectX 2 ConnectX 3 ConnectX 3 Pro network adapters Firmware configuration INI files for Mellanox standard network adapter cards and custom cards 1 1 4 Director
17. to map device func tion numbers to their num vfs values e g 0000 04 00 0 5 002b 1c 0b a 15 Hexadecimal digits for the device function e g 002b 1c 0b a and decimal for num vfs value e g 15 string Either a single value e g 3 to indicate that the Hypervi Sor driver itself should activate this number of VFs for each HCA on the host or a string to map device function numbers to their probe vf values e g 0000 04 00 0 3 002b 1c 0b a 13 Hexadecimal digits for the device function e g 002b 1c 0b a and decimal for probe vf value e g 13 string log mgm size that defines the num of qp per mcg for example 10 gives 248 range 7 log num mgm entry size 12 To activate device managed flow steering when available set to 1 int Enable steering mode for higher packet rate default off int Enable fast packet drop when no recieve WQEs are posted int Enable 64 byte CQEs EQEs when the FW supports this if non zero default 1 int Log2 max number of MACs per ETH port 1 7 int Obsolete Log2 max number of VLANs per ETH port 0 7 int Log2 number of MTT entries per segment 0 7 default 0 int 12 Mellanox Technologies Rev 2 3 1 0 0 port type array Either pair of values e g 1 2 to define uniform port1 port2 types configuration for all devices functions or a String to map device function numbers to their pair of port types values e g 0000 04 00 0 1 2 002b 1c 0b a 1 1 Valid
18. will itself activate that number of VFs All these VFs will run on the Hyper visor This number will apply to all ConnectX HCAs on that host e Ifits a triplet x y z applies only if all ports are config ured as Ethernet the driver probes x single port VFs on physical port 1 y single port VFs on physical port 2 applies only if such a port exist zn port VFs where n is the number of physical ports on device Those VFs are attached to the hypervisor fits format is a string the string specifies the probe vf parameter separately per installed HCA The string format is bb dd f v bb dd f v bb dd f bus device function of the PF of the HCA y number of VFs to use in the PF driver for that HCA which is either a single value or a triplet as described above For example probe vfs 5 The PF driver will activate 5 VFs on the HCA and this will be applied to all ConnectX HCAs on the host probe vfs 00 04 0 5 00 07 0 8 The PF driver will activate 5 VFs on the HCA positioned in BDF 00 04 0 and 8 for the one in 00 07 0 36 Mellanox Technologies Rev 2 3 1 0 0 Parameter Recommended Value probe_vf probe_vf 1 2 3 The PF driver will activate 1 VF on physical port 1 2 VFs on physical port 2 and 3 dual port VFs applies only to dual port HCA when all ports are Ethernet ports This applies to all ConnectX HCAs in the host probe vf 00 04 0 5 6 7 00 07 0 8 9 10 The PF dri
19. working Mellanox Technologies 33 J Rev 2 3 1 0 0 Feature Overview and Configuration Step 7 Step 8 Parameter Recommended Value sriov en true 2 Add the above fields to the INI if they are missing 3 Set the total vfs parameter to the desired number if you need to change the num ber of total VFs 4 Reburn the firmware using the mlxburn tool if the fields above were added to the INI or the total v s parameter was modified If the mlxburn is not installed please downloaded it from the Mellanox website http www mellanox com gt products gt Firmware tools mlxburn fw fw ConnectX3 rel mlx dev dev mst mt4099 pci cr0 conf MCX341A XCG Ax ini If the current firmware version is the same as one provided with MLNX EN run it in combination with the force fw update parameter P This configuration option is supported only in HCAs that their configuration file INI is included in MLNX_EN ae Create the text file etc modprobe d mlx4 core conf if it does not exist otherwise delete its contents Insert an option line in the etc modprobe d mlx4 core conf file to set the number of VFs the protocol type per port and the allowed number of virtual functions to be used by the physical function driver probe vf options mlx4 core num vfs 5 probe vf 1 l 2 If SR IOV is supported to enable SR IOV if it is not enabled it is sufficient to set sriov en true in the INI
20. 13 J Rev 2 3 1 0 0 Installation 2 2 1 2 2 2 3 2 3 1 Installation This chapter describes how to install and test the MLNX EN for Linux package on a single host machine with Mellanox InfiniBand and or Ethernet adapter hardware installed Software Dependencies To install the driver software kernel sources must be installed on the machine MLNX EN driver cannot coexist with OFED software on the same machine Hence when installing MLNX EN all OFED packages should be removed run the m1nx en install script Downloading MLNX EN Step 1 Verify that the system has a Mellanox network adapter HCA NIC installed The following example shows a system with an installed Mellanox HCA lspci v grep Mellanox 06 00 0 Network controller Mellanox Technologies MT27500 Family ConnectX 3 Subsystem Mellanox Technologies Device 0024 Step 2 Download the tarball image to your host The image s name has the format MLNX_EN lt ver gt tgz You can download it from http www mellanox com gt Products gt Software Ethernet Drivers Step 3 Use the md5sum utility to confirm the file integrity of your tarball image Installing MLNX EN The installation script m1nx en install performs the following Discover the currently installed kernel Uninstall any previously installed MLNX OFED MLNX EN packages Install the MLNX EN binary if they are available for the current kernel Identifies the currently installed Ethernet n
21. 2 Set the same number of VFS for the is reported in dmesg ware driver mlx4 core 0000 xx xx 0 Failed to enable SR IOV continuing without SR IOV err 22 Failed to enable SR IOV is disabled in the Check that the SR IOV is enabled in the SR IOV BIOS BIOS see Section 3 4 1 2 Setting Up The following message SR IOV on page 32 is reported in dmesg mlx4 core 0000 xx xx 0 Failed to enable SR IOV continuing without SR IOV err 12 60 Mellanox Technologies Rev 2 3 1 0 0 Table 18 SR IOV Related Issues Issue Cause Solution When assigning a VF to SR IOV and virtualization 1 Verify they are both enabled in the BIOS a VM the following are not enabled in the 2 Add to the GRUB configuration file to message is reported on BIOS the following kernel parameter the screen intel immun on PCI assgine error see Section 3 4 1 2 Setting Up SR requires KVM sup IOV on page 32 port Mellanox Technologies 61 J
22. AGE Mellanox TECHNOLOGIES Mellanox Technologies Mellanox Technologies Ltd 350 Oakmead Parkway Suite 100 Beit Mellanox Sunnyvale CA 94085 PO Box 586 Yokneam 20692 U S A Israel www mellanox com www mellanox com Tel 408 970 3400 Tel 972 0 74 723 7200 Fax 408 970 3403 Fax 972 0 4 959 3245 Copyright 2014 Mellanox Technologies All Rights Reserved Mellanox Mellanox logo BridgeX ConnectX Connect IB CoolBox CORE Direct InfiniBridge InfiniHost InfiniScale MetroX MLNX OS PhyX ScalableHPC SwitchX UFM Virtual Protocol Interconnect and Voltaire are registered trademarks of Mellanox Technologies Ltd ExtendX FabricIT Mellanox Open Ethernet Mellanox Virtual Modular Switch MetroDX TestX Unbreakable Link are trademarks of Mellanox Technologies Ltd All other trademarks are property of their respective owners 2 Mellanox Technologies Document Number 2950 Rev 2 3 1 0 0 Table of Contents Table of Contents 5 3k oe es a e reves pe E Res Ob eee ee tees eee eee ed d Eist f Tables ceased ku A ed ie ited Bai ieee oie vedere ETE Xe pee eie ca Chapter 1 Overview eee Cove ERR AE e a ee or ene ewe deba sex aea dU 1 1 MLNX EN Package Contents llle 10 LT 1 Tarball Packagesz e da tte e e e 10 1 1 2 Software Components seeni KEA e A E 11 E Eiiwales oO tirpo phat ewer ody Melee i eke ah dale wh ee ra wale eee ales 11 1 1 4 Directo
23. Abbreviations and Acronyms Table 2 Abbreviations and Acronyms RN j Whole Word Description B Capital B is used to indicate size in bytes or multiples of bytes e g IKB 1024 bytes and 1MB 1048576 bytes b Small b is used to indicate size in bits or multiples of bits e g IKb 1024 bits FW Firmware HW Hardware LSB Least significant byte Isb Least significant bit MSB Most significant byte msb Most significant bit NIC Network Interface Card SW Software VPI Virtual Protocol Interconnect PFC Priority Flow Control PR Path Record RDS Reliable Datagram Sockets SL Service Level QoS Quality of Service ULP Upper Level Protocol VL Virtual Lane 8 Mellanox Technologies Glossary Rev 2 3 1 0 0 The following is a list of concepts and terms related to InfiniBand in general and to Subnet Man agers in particular It is included here for ease of reference but the main reference remains the InfiniBand Architecture Specification Table 3 Glossary Channel Adapter CA An IB device that terminates an IB link and executes transport functions This Host Channel Adapter may be an HCA Host CA or a TCA Target CA HCA HCA Card A network adapter card based on an InfiniBand channel adapter device IB Devices Integrated circuit implementing InfiniBand compliant communication In Band A term assigned to admi
24. Mellanox TECHNOLOGIES Connect Accelerate Outperform MLNX_EN for Linux User Manual Rev 2 3 1 0 0 www mellanox com Rev 2 3 1 0 0 NOTE THIS HARDWARE SOFTWARE OR TEST SUITE PRODUCT PRODUCT S AND ITS RELATED DOCUMENTATION ARE PROVIDED BY MELLANOX TECHNOLOGIES AS IS WITH ALL FAULTS OF ANY KIND AND SOLELY FOR THE PURPOSE OF AIDING THE CUSTOMER IN TESTING APPLICATIONS THAT USE THE PRODUCTS IN DESIGNATED SOLUTIONS THE CUSTOMER S MANUFACTURING TEST ENVIRONMENT HAS NOT MET THE STANDARDS SET BY MELLANOX TECHNOLOGIES TO FULLY QUALIFY THE PRODUCTO S AND OR THE SYSTEM USING IT THEREFORE MELLANOX TECHNOLOGIES CANNOT AND DOES NOT GUARANTEE OR WARRANT THAT THE PRODUCTS WILL OPERATE WITH THE HIGHEST QUALITY ANY EXPRESS OR IMPLIED WARRANTIES INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT ARE DISCLAIMED IN NO EVENT SHALL MELLANOX BE LIABLE TO CUSTOMER OR ANY THIRD PARTIES FOR ANY DIRECT INDIRECT SPECIAL EXEMPLARY OR CONSEQUENTIAL DAMAGES OF ANY KIND INCLUDING BUT NOT LIMITED TO PAYMENT FOR PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES LOSS OF USE DATA OR PROFITS OR BUSINESS INTERRUPTION HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY WHETHER IN CONTRACT STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY FROM THE USE OF THE PRODUCT S AND RELATED DOCUMENTATION EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAM
25. Technologies 47 J Rev 2 3 1 0 0 Feature Overview and Configuration Usage minx gcn i interface options Options version Show program s version number and exit h help Show this help message and exit i INTF interface INTF Interface name g TYPE get type TYPE Type of information to get statistics param eters rpg enable RPG ENABLE LIST Set value of rpg enable according to prior ity use spaces between values and 1 for unknown values rppp max rps RPPP MAX RPS LIST Set value of rppp max rps according to prior ity use spaces between values and 1 for unknown values rpg time reset RPG TIME RESET LIST Set value of rpg time reset according to pri ority use spaces between values and 1 for unknown values rpg byte reset RPG BYTE RESET LIST Set value of rpg byte reset according to pri ority use spaces between values and 1 for unknown values rpg threshold RPG THRESHOLD LIST Set value of rpg threshold according to pri ority use spaces between values and 1 for unknown values rpg max rate RPG MAX RATE LIST Set value of rpg max rate according to prior ity use spaces between values and 1 for unknown values rpg ai rate RPG AI RATE LIST Set value of rpg ai rate according to prior ity use spaces between values and 1 for unknown values rpg hai rate RPG HAI RATE LIST Set value of rpg hai rate according to prior ity use spaces between va
26. attribute The path to a general parameter is sys kernel debug mlx4_ib DEVICE ecn r roce ecn np gen params attribute The path to a counter is sys kernel debug mlx4 ib DEVICE ecn algorithm ports port statistics prios prio counter 3 10 Power Management pm qos API is used by mlx4 en to enforce minimum DMA latency requirement on the system when ingress traffic is detected Additionally it decreases packet loss on systems configured with abundant power state profile when Flow Control is disabled The pm qos API contains the following functions pm qos add request pm qos update request pm qos remove request pm qos feature is both global and static once a request is issued it is enforced on all CPUs and does not change in time MLNX EN v2 2 1 0 1 and onwards provides an option to trigger a request when required and to remove it when no longer required It is disabled by default and can be set unset through the eth tool priv flags For further information on how to enable disable this feature please refer to Table 7 ethtool Supported Options on page 45 3 11 XOR RSS Hash Function The device has the ability to use XOR as the RSS distribution function instead of the default Toplitz function The XOR function can be better distributed among driver s receive queues in small number of streams where it distributes each TCP UDP stream to a different queue MLNX EN v2 2 1 0 0 and onwards provid
27. be up to 10 VLANs including the VLAN 0 that is added for untagged priority tagged traffic This behavior applies to all VF traffic plain Ethernet and all RoCE transports e VGT allowed VLAN sets may be only extended when the VF is online An operational VLAN set becomes identical as the administration VLAN set only after a VF reset Mellanox Technologies 41 J Rev 2 3 1 0 0 Feature Overview and Configuration e VGT is available in DMFS mode only 3 4 1 7 1 Configuring VGT The default operating mode is VGT cat sys class net eth5 vf0 vlan set oper admin Both states operational and administrative are empty If you set the vlan set parameter with more the 10 VLAN IDs the driver chooses the first 10 VLAN IDs provided and ignores all the rest p gt To enable VGT mode Step 1 Set the corresponding port VF in the example below port ethS VFO list of allowed VLANs echo 012345678 9 gt sys class net eth5 vf 0 vlan_set Where o specifies if untagged priority tagged traffic is allowed Meaning if the below command is ran you will not be able to send receive untagged traf fic echo 1234567 8 9 10 gt sys class net eth5 v 0 vlan set Step2 Reboot the relevant VM for changes to take effect or run etc init d openibd restart To disable VGT mode Step 1 Set the VLAN echo sys class net eth5 vf0 vlan set Step2 Reboot the relevant VM for changes to take effect or run etc init d openibd restart
28. d probe d vxlan conf options vxlan udp port 4789 3 4 2 3 Important Notes VXLAN tunneling adds 50 bytes 14 eth 20 ip 8 udp 8 vxlan to the VM Ethernet frame Please verify that either the MTU of the NIC who sends the packets e g the VM virtio net NIC or the host side veth device or the uplink takes into account the tunneling overhead Meaning the MTU of the sending NIC has to be decremented by 50 bytes e g 1450 instead of 1500 or the uplink NIC MTU has to be incremented by 50 bytes e g 1550 instead of 1500 From upstream 3 15 rcl and onward it is possible to use arbitrary UDP port for VXLAN Note that this requires firmware version 2 31 2800 or higher Additionally you need to enable this kernel configuration option CONFIG_MLX4 EN VXLAN y On upstream kernels 3 12 3 13 GRO with VXLAN is not supported Mellanox Technologies 43 J Rev 2 3 1 0 0 Feature Overview and Configuration 3 5 Resiliency 3 5 1 Reset Flow Reset Flow is activated by default once a fatal device error is recognized Both the HCA and the software are reset the ULPs and user application are notified about it and a recovery process is performed once the event is raised The Reset Flow is activated by the mlx4 core module parameter internal err reset and its default value is 1 3 5 1 1 Kernel ULPs Once a fatal device error is recognized an IB EVENT DEVICE FATAL event is created ULPs are notified about the incident an
29. d automatically e ethtool u eth5 Shows all of ethtool s steering rule When configuring two rules with the same priority the second rule will overwrite the first one so this ethtool interface is effectively a table Inserting Flow Steering rules in the kernel requires support from both the ethtool in the user space and in kernel v2 6 28 MLXA Driver Support The mlx4 driver supports only a subset of the flow specification the ethtool API defines Asking for an unsupported flow specification will result with an invalid value failure The following are the flow specific parameters Table 6 Flow Specific Parameters ether tcp4 udp4 ip4 Mandatory dst src ip dst ip 30 Mellanox Technologies Rev 2 3 1 0 0 Table 6 Flow Specific Parameters ether tcp4 udp4 ip4 Optional vlan Src ip dst ip src src ip dst ip vlan port dst port vlan e RFS RFS is an in kernel logic responsible for load balancing between CPUs by attaching flows to CPUs that are used by flow s owner applications This domain allows the RFS mechanism to use the flow steering infrastructure to support the RFS logic by implementing the ndo xx flow steer which in turn calls the underlying flow steering mechanism with the RFS domain Enabling the RFS requires enabling the ntuple flag via the ethtool For example to enable ntuple for eth0 run ethtool K eth0 ntuple on RFS requires the
30. d outstanding WQEs are simulated to be returned with flush in error message to enable each ULP to close its resources and not get stuck via calling its remove one callback as part of Reset Flow Once the unload part is terminated each ULP is called with its add_one callback its resources are re initialized and it is re activated 3 5 1 2 SR IOV If the Physical Function recognizes the error it notifies all the VFs about it by marking their communication channel with that information consequently all the VFs and the PF are reset If the VF encounters an error only that VF is reset whereas the PF and other VFs continue to work unaffected 3 5 1 3 Forcing the VF to Reset If an outside reset is forced by using the PCI sysfs entry for a VF a reset is executed on that VF once it runs any command over its communication channel For example the below command can be used on a hypervisor to reset a VF defined by 0000 04 00 1 echo 1 gt sys bus pci devices 0000 04 00 1 reset 3 5 1 4 Advanced Error Reporting AER AER a mechanism used by the driver to get notifications upon PCI errors is supported only in native mode ULPs are called with remove one add one and expect to continue working prop erly after that flow User space application will work in same mode as defined in the Reset Flow above 3 6 Ethtool ethtool is a standard Linux utility for controlling network drivers and hardware particularly for wi
31. dev PF device vf NUM mac lt LLADDR gt For legacy guests which do not generate random MACS the adminstrator should always configure their MAC addresses via ip link as above Spoof checking Spoof checking is currently available only on upstream kernels newer than 3 1 ip link set dev lt PF device gt vf lt NUM gt spoofchk on off 3 4 1 6 3 Mapping VFs to Ports using the mInx get vfs pl Tool To map the PCI representation in BDF to the respective ports mlnx get vfs pl The output is as following BDF 0000 04 00 0 iow dg 2 vf0 0000 04 00 1 v l 0000 04 00 2 orice 2g 2 vf2 0000 04 00 3 vf3 0000 04 00 4 Both 1 vf4 0000 04 00 5 3 4 1 7 Virtual Guest Tagging VGT VGT is an advanced mode of Virtual Guest Tagging VGT in which a VF is allowed to tag its own packets as in VGT but is still subject to an administrative VLAN trunk policy The policy determines which VLAN IDs are allowed to be transmitted or received The policy does not determine the user priority which is left unchanged Packets can be send in one of the following modes when the VF is allowed to send receive untagged and priority tagged traffic and when it is not No default VLAN is defined for VGT port The send packets are passed to the eSwitch only if they match the set and the received packets are forwarded to the VF only if they match the set The following are current VGT limitations The size of the VLAN set is defined to
32. e is connected on come up while port physical state is Polling to the port or the port on the other end of the cable is disabled both ends or use a known working cable Check the status of the connected port using the ibportstate com mand and enable it if necessary Physical link fails to come up while port physical state is Dis abled The port was manually dis abled Restart the driver etc init d openibd restart Mellanox Technologies 59 J Rev 2 3 1 0 0 Troubleshooting 4 3 Performance Related Issues Table 17 Performance Related Issues Issue Cause Solution The driver works but the These recommendations may assist with transmit and or receive gaining immediate improvement data rates are not opti 1 Confirm PCI link negotiated uses its mal maximum capability 2 Stop the IRQ Balancer service etc init d irq balancer stop 3 Start mInx affinity service mlnx affinity start For best performance practices please referto the Performance Tuning Guide for Mellanox Network Adapters www mellanox com gt Products gt InfiniBand VPI Drivers gt Linux SW Drivers 4 4 SR IOV Related Issues Table 18 SR IOV Related Issues Issue Cause Solution Failed to enable The number of VFs config 1 Check the firmware SR IOV configura SR IOV ured in the driver is higher tion run the mlxconfig tool The following message than configured in the firm
33. ection and manage its guarantees limitations and its priority over other flows This is accomplished by mapping the user s priority to a hardware TC traffic class through a 2 3 stages process The TC is assigned with the QoS attributes and the different flows behave accordingly 3 1 1 Mapping Traffic to Traffic Classes Mapping traffic to TCs consists of several actions which are user controllable some controlled by the application itself and others by the system network administrators The following is the general mapping traffic to Traffic Classes flow 1 The application sets the required Type of Service ToS 2 The ToS is translated into a Socket Priority sk_prio 3 The sk_prio is mapped to a User Priority UP by the system administrator some applica tions set sk_prio directly 4 The UP is mapped to TC by the network system administrator 5 TCs hold the actual QoS parameters QoS can be applied on the following types of traffic However the general QoS flow may vary among them Plain Ethernet Applications use regular inet sockets and the traffic passes via the ker nel Ethernet driver e RoCE Applications use the RDMA API to transmit using QPs Raw Ethernet QP Application use VERBs API to transmit using a Raw Ethernet QP 3 1 2 Plain Ethernet Quality of Service Mapping Applications use regular inet sockets and the traffic passes via the kernel Ethernet driver The following is the Plain Ethernet QoS mapping flo
34. es an option to change the working RSS hash function from Toplitz to XOR and vice versa through ethtool priv flags For further information please refer to Table 7 ethtool Supported Options on page 45 3 12 Ethernet Performance Counters Counters are used to provide information about how well an operating system an application a service or a driver is performing The counter data helps determine system bottlenecks and fine tune the system and application performance The operating system network and devices pro vide counter data that an application can consume to provide users with a graphical view of how well the system is performing 52 Mellanox Technologies Rev 2 3 1 0 0 The counter index is a QP attribute given in the QP context Multiple QPs may be associated with the same counter set If multiple QPs share the same counter its value represents the cumulative total ConnectX 3 support 127 different counters which allocated e 4 counters reserved for PF 2 counters for each port 2counters reserved for VF 1 counter for each port All other counters if exist are allocated by demand e RoCE counters are available only through sysfs located under e sys class infiniband mlx4 ports counters e sys class infiniband mlx4_ ports counters_ext Physical Function can also read Virtual Functions port counters through sysfs located under e sys class net eth vf _statistics To display the networ
35. es with a length type field value in the decimal range 1535 1501 rx_lt 64 bytes packets Number of received 64 or less octet frames rx 127 bytes packets Number of received 65 to 127 octet frames rx 255 bytes packets Number of received 128 to 255 octet frames rx 511 bytes packets Number of received 256 to 511 octet frames rx 1023 bytes packets Number of received 512 to 1023 octet frames rx 1518 bytes packets Number of received 1024 to 1518 octet frames rx 1522 bytes packets Number of received 1519 to 1522 octet frames rx 1548 bytes packets Number of received 1523 to 1548 octet frames rx gt 1548 bytes packets Number of received 1549 or greater octet frames Table 9 Port OUT Counters Counter Description tx packets Total packets successfully transmitted tx bytes Total bytes in successfully transmitted packets tx multicast packets Total multicast packets successfully transmitted tx broadcast packets Total broadcast packets successfully transmitted tx errors Number of frames that failed to transmit tx dropped Number of transmitted frames that were dropped tx lt 64 bytes packets Number of transmitted 64 or less octet frames tx 127 bytes packets Number of transmitted 65 to 127 octet frames tx 255 bytes packets Number of transmitted 128 to 255 octet frames tx 511 bytes packets Number of transmitted 256 to 511 octet frames tx 1023 bytes packets Number of transmitted 512 to 1023 octe
36. etwork adapters and automatically upgrades the firmware Installation Modes minx en installer supports 2 modes of installation The install scripts selects the mode of driver installation depending of the running OS kernel version Kernel Module Packaging KMP mode where the source rpm is rebuilt for each installed flavor of the kernel This mode is used for RedHat and SUSE distributions Non KMP installation mode where the sources are rebuilt with the running kernel This mode is used for vanilla kernels If the Vanilla kernel is installed as rpm please use the disable kmp flag when installing the driver 14 Mellanox Technologies Rev 2 3 1 0 0 The package consists of several source RPMs The install script rebuilds the source RPMs and then installs the created binary RPMs The created kernel module binaries are located at For KMP RPMs installation OnSLES mellanox mlnx en kmp RPM 1ib modules kernel ver updates mellanox mlnx en On RHEL kmod mellanox mlnx en RPM lib modules lt kernel ver gt extra mellanox mlnx en For non KMP RPMs mlnx en RPM OnSLES 1ib modules kernel ver updates mlnx en On RHEL 1ib modules kernel ver extra mlnx en The kernel module sources are placed under usr src mellanox mlnx en lt ver gt 2 3 2 Installation Procedure Step 1 Login to the installation machine as root Step 2 Extract the tarball image on your machine gt tar xzvf mlnx en
37. he maprio queue discipline In kernels that do not support maprio such as 2 6 34 an alternate mapping is created in sysfs The tc wrap py tool will use either the sysfs or the tc tool to configure the sk prio to UP mapping Usage tc wrap py i interface options Options version show program s version number and exit h help show this help message and exit u SKPRIO UP skprio up SKPRIO UP maps sk prio to UP LIST is 16 comma separated UP index of element is sk prio i INTF interface INTF Interface name Example set skprio 0 2 to UPO and skprio 3 7 to UP1 on eth4 UP 0 Skprio 0 Skprio 1 Skprio 2 tos 8 Skprio 7 Skprio 8 Skprio 9 Skprio 10 Skprio 11 Skprio 12 Skprio 13 Skprio 14 Skprio 15 DEC Skprio 3 Skprio 4 tos 24 Skprio 5 Skprio 6 tos 16 UP 2 we 3 UP 4 UPS UP 6 UP 7 24 Mellanox Technologies Rev 2 3 1 0 0 3 1 5 3 Additional Tools tc tool compiled with the sch mqprio module is required to support kernel v2 6 32 or higher This is a part of iproute2 package v2 6 32 19 or higher Otherwise an alternative custom sysfs interface 1s available mlnx qos tool package ofed scripts requires python gt 2 5 toc wrap py package ofed scripts requires python gt 2 5 3 2 Time Stamping Service P Time Stamping is currently at beta level d Please be aware that everything listed here is subject to change Time Stamping is curren
38. k device Ethernet statistics you can run Ethtool S lt devname gt Table 8 Port IN Counters Counter Description rx_packets Total packets successfully received rx bytes Total bytes in successfully received packets rx multicast packets Total multicast packets successfully received rx broadcast packets Total broadcast packets successfully received rx_errors Number of receive packets that contained errors preventing them from being deliverable to a higher layer protocol rx_dropped Number of receive packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher layer protocol rx_length_errors Number of received frames that were dropped due to an error in frame length TX_OVer_errors Number of received frames that were dropped due to overflow IX CIC errors Number of received frames with a bad CRC that are not runts jabbers or alignment errors rx jabbers Number of received frames with a length greater than MTU octets and a bad CRC rx in range length error Number of received frames with a length type field value in the decimal range 1500 46 42 1s also counted for VLANtagged frames Mellanox Technologies 53 J Rev 2 3 1 0 0 Feature Overview and Configuration Table 8 Port IN Counters Counter Description rx out range length error Number of received fram
39. kernel to be compiled with the coNFIG_RFS_ACCEL option This options is available in kernels 2 6 39 and above Furthermore RFS requires Device Managed Flow Steering support P RES cannot function if LRO is enabled LRO can be disabled via ethtool Aha Allof the rest The lowest priority domain serves the following users The mlx4 Ethernet driver attaches its unicast and multicast MACs addresses to its QP using L2 flow specifications Fragmented UDP traffic cannot be steered It is treated as other protocol by hardware i from the first packet and not considered as UDP traffic 3 4 Virtualization 3 4 1 Single Root IO Virtualization SR IOV Single Root IO Virtualization SR IOV is a technology that allows a physical PCIe device to present itself multiple times through the PCIe bus This technology enables multiple virtual instances of the device with separate resources Mellanox adapters are capable of exposing in ConnectX 3 adapter cards up to 126 virtual instances called Virtual Functions VFs These vir tual functions can then be provisioned separately Each VF can be seen as an addition device con nected to the Physical Function It shares the same resources with the Physical Function and its number of ports equals those of the Physical Function SR IOV is commonly used in conjunction with an SR IOV enabled hypervisor to provide virtual machines direct hardware access to network resources hence increasing its performa
40. lity of Service Tools 3 1 5 1 mlnx qos mlnx qos is a centralized tool used to configure QoS features of the local host It communicates directly with the driver thus does not require setting up a DCBX daemon on the system The minx qos tool enables the administrator of the system to Inspect the current QoS mappings and configuration The tool will also display maps configured by TC and vconfig set egress map tools in order to give a centralized view of all QoS mappings Set UP to TC mapping Assign a transmission algorithm to each TC strict or ETS Set minimal BW guarantee to ETS TCs Setrate limit to TCs For unlimited ratelimit set the ratelimit to 0 P Usage mlnx qos i interface options Mellanox Technologies 21 J Rev 2 3 1 0 0 Feature Overview and Configuration Options 3 1 5 1 1 Get Current Configuration 22 Mellanox Technologies Rev 2 3 1 0 0 3 1 5 1 2 Set ratelimit 3Gbps for tc0 4Gbps for tc1 and 2Gbps for tc2 3 1 5 1 3 Configure QoS map UP 0 7 to tc0 1 2 3 to tc1 and 4 5 6 to tc 2 set tc0 tc1 as ets and tc2 as strict divide ets 30 for tc0 and 70 for tc1 Mellanox Technologies 23 Rev 2 3 1 0 0 Feature Overview and Configuration vos 7 tc 1 ratelimit 4 Gbps tsa ets bw 70 tes wide 2 bias E tc 2 ratelimit 2 Gbps tsa strict og A mas 5 up 6 3 1 5 2 tcand tc_wrap py The tc tool is used to setup sk prio to UP mapping using t
41. lues and 1 for unknown values rpg gd RPG GD LIST Set value of rpg gd according to priority use spaces between values and 1 for unknown values rpg min dec fac RPG MIN DEC FAC LIST Set value of rpg min dec fac according to priority use spaces between values and 1 for unknown values rpg min rate RPG MIN RATE LIST Set value of rpg min rate according to prior ity use spaces between values and 1 for unknown values cndd state machine CNDD STATE MACHINE LIST Set value of cndd state machine according to priority use spaces between values and 1 for unknown values To get QCN current configuration sorted by priority minx qcn i eth2 g parameters 48 Mellanox Technologies Rev 2 3 1 0 0 gt To show QCN s statistics sorted by priority mlnx gcn i eth2 g statistics Example output when running mlnx_qcn i eth2 g parameters priority 0 rpg enable 0 rppp max rps 1000 rpg time reset 1464 rpg byte reset 150000 rpg threshold 5 rpg max rate 40000 rpg ai rate 10 rpg hai rate 50 rpg gd 8 rpg min dec fac 2 rpg min rate 10 cndd state machine 0 pxcgsesiew dia rpg enable 0 rppp max rps 1000 rpg time reset 1464 rpg byte reset 150000 rpg threshold 5 rpg max rate 40000 rpg ai rate 10 rpg hai rate 50 rpg gd 8 rpg min dec fac 2 rpg min rate 10 cndd state machine 0 priority 7 rpg enable 0 rppp max rps 1000 rpg time reset 1464 rpg byte rese
42. n is intended for future firmware upgrades and provides instructions for 1 installing Mellanox firmware update tools MFT 2 downloading FW and 3 updating adapter card firmware Installing Firmware Tools The driver package compiles and installs the Mellanox mstflint utility under usr local bin You may also use this tool to burn a card specific firmware binary image See the file tmp mlnx en src utils mstflint README file for details Alternatively you can download the current Mellanox Firmware Tools package MFT from www mellanox com gt Products gt Adapter IB VPI SW gt Firmware Tools The tools package to download is MFT SW for Linux tarball name is mft X X X tgz For help in identifying your adapter card please visit http www mellanox com content pages php pg firmware HCA FW identification 16 Mellanox Technologies Rev 2 3 1 0 0 2 8 2 Updating Adapter Card Firmware Using a card specific binary firmware image file enter the following command gt mstflint d pci device i image name bin b For burning firmware using the MFT package please check the MFT User Manual under www mellanox com gt Products gt Software gt InfiniBand VPI Drivers gt Firmware Tools After burning a new firmware reboot the machine for changes to take effect Ahi 2 9 Ethernet Driver Usage and Configuration To assign an IP address to the interface gt ifconfig eth lt x gt ip a x is the OS a
43. nce In this chapter we will demonstrate setup and configuration of SR IOV in a Red Hat Linux envi ronment using Mellanox ConnectX VPI adapter cards family Mellanox Technologies 31 J Rev 2 3 1 0 0 Feature Overview and Configuration 3 4 1 1 System Requirements To set up an SR IOV environment the following is required MLNX EN Driver Aserver blade with an SR IOV capable motherboard BIOS Hypervisor that supports SR IOV such as Red Hat Enterprise Linux Server Version 6 Mellanox ConnectX VPI Adapter Card family with SR IOV capability 3 4 1 2 Setting Up SR IOV Depending on your system perform the steps below to set up your BIOS The figures used in this section are for illustration purposes only For further information please refer to the appropriate BIOS User Manual Step 1 Enable SR IOV in the system BIOS BIOS SETUP UTILITY Step 2 Enable Intel Virtualization Technology lun dering Step 3 Install the hypervisor that supports SR IOV 2 Mellanox Technologies J Rev 2 3 1 0 0 Step 4 Depending on your system update the boot grub grub conf file to include a similar command line load parameter for the Linux kernel For example to Intel systems add default 0 timeout 5 splashimage hd0 0 grub splash xpm gz hiddenmenu title Red Hat Enterprise Linux Server 2 6 32 36 x86 645 root hd0 0 kernel vmlinuz 2 6 32 36 x86 64 ro root dev VolGroup00 LogVol00 rhgb quiet i
44. nfiniBand Mellanox Technologies MT27500 Family ConnectX 3 Virtual Function rev b0 03 00 3 InfiniBand Mellanox Technologies MT27500 Family ConnectX 3 Virtual Function rev b0 03 00 4 InfiniBand Mellanox Technologies MT27500 Family ConnectX 3 Virtual Function rev b0 03 00 5 InfiniBand Mellanox Technologies MT27500 Family ConnectX 3 Virtual Function rev b0 Where e 03 00 represents the Physical Function Mellanox Technologies 37 J Rev 2 3 1 0 0 Feature Overview and Configuration e 03 00 X represents the Virtual Function connected to the Physical Function 3 4 1 3 Enabling SR IOV and Para Virtualization on the Same Setup To enable SR IOV and Para Virtualization on the same setup Step 1 Create a bridge vim etc sysconfig network scripts ifcfg bridgeO DEVICE bridge0 TYPE Bridge IPADDRS12 195 15 1 NETMASK 255 255 0 0 BOOTPROTO static ONBOOT yes NM CONTROLLED no DELAY 0 Step 2 Change the related interface in the example below bridge0 is created over eth5 DEVICE eth5 BOOTPROTO none STARTMODE on HWADDRz00 02 c9 2e 66 52 TYPE Ethernet NM CONTROLLED no ONBOOT yes BRIDGE bridge0 Step 3 Restart the service network Step 4 Attach a virtual NIC to VM ifconfig a eth6 Link encap Ethernet HWaddr 52 54 00 E7 77 99 inet addr 13 195 15 5 Bcast 13 195 255 255 Mask 255 255 0 0 inet6 addr fe80 5054 ff fee7 7799 64 Scope Link UP BROADCAST RUNNING MULTICAST MTU 1500 Metric 1 RX packets 481 e
45. ng or the administrator may configure the Hypervisor to silently force packets to be associated with a VLan Qos Vlan Switch Tagging In the latter case untagged or priority tagged outgoing packets from the guest will have the VLAN tag inserted and incoming packets will have the VLAN tag removed Any vlan tagged packets sent by the VF are silently dropped The default behavior is VGT The feature may be controlled on the Hypervisor from userspace via iprout2 netlink ip link set dev DEVICE group DEVGROUP up down vf NUM mac LLADDR vlan VLANID qos VLAN QOS spoofchk on off use ip link set dev PF device vf NUM vlan vlan id qos lt qos gt where NUM 0 max vf num e vlan id 0 4095 4095 means set VGT e qos 0 7 For example ip link set dev eth2 vf 2 qos 3 sets VST mode for VF 2 belonging to PF eth2 with qos 3 ip link set dev eth2 vf 4095 sets mode for VF 2 back to VGT 40 Mellanox Technologies Rev 2 3 1 0 0 3 4 1 6 2 Additional Ethernet VF Configuration Options Guest MAC configuration By default guest MAC addresses are configured to be all zeroes In the MLNX EN guest driver if a guest sees a zero MAC it generates a random MAC address for itself If the administrator wishes the guest to always start up with the same MAC he she should configure guest MACS before the guest driver comes up The guest MAC may be configured by using ip link set
46. nicast packets sent successfully vport lt i gt tx unicast bytes Unicast packet bytes sent successfully vportci tx multicast pack ets Multicast packets sent successfully vportci tx multicast byte S Multicast packet bytes sent successfully vport lt i gt _tx broadcast pac kets Broadcast packets sent successfully vportci tx broadcast byte S Broadcast packet bytes sent successfully vport i tx errors Packets dropped due to transmit errors Table 13 SW Statistics Counter Description rx lro aggregated Number of packets aggregated rx lro flushed Number of LRO flush to the stack rx lro no desc Number of times LRO description was not found 56 Mellanox Technologies Rev 2 3 1 0 0 Table 13 SW Statistics Counter Description rx alloc failed Number of times failed preparing receive descriptor IX csum good Number of packets received with good checksum rx csum none Number of packets received with no checksum indication tx chksum offload Number of packets transmitted with checksum offload tx queue stopped Number of times transmit queue suspended tx wake queue Number of times transmit queue resumed tx timeout Number of times transmitter timeout tx tso packets Number of packet that were aggregated Table 14 Per Ring SW Statistics where i is the ring per configuration
47. nistration activities traversing the IB connectivity only Local Port The IB port of the HCA through which IBDIAG tools connect to the IB fabric Master Subnet Manager The Subnet Manager that is authoritative that has the reference configuration information for the subnet See Subnet Manager Multicast Forwarding Tables A table that exists in every switch providing the list of ports to forward received multicast packet The table is organized by MLID Network Interface Card NIC A network adapter card that plugs into the PCI Express slot and provides one or more ports to an Ethernet network Unicast Linear For warding Tables LFT A table that exists in every switch providing the port through which packets should be sent to each LID Virtual Protocol Inter connet VPI A Mellanox Technologies technology that allows Mellanox channel adapter devices ConnectX to simultaneously connect to an InfiniBand subnet and a 10GigE subnet each subnet connects to one of the adpater ports Related Documentation Table 4 Reference Documents Document Name Description IEEE Std 802 3ae 2002 Amendment to IEEE Std 802 3 2002 Document PDF SS94996 Part 3 Carrier Sense Multiple Access with Collision Detection CSMA CD Access Method and Physical Layer Specifications Amendment Media Access Control MAC Parame ters Physical Layers and Management Parameters for 10 Gb s Operation
48. ntel iommuzon initrd initrd 2 6 32 36 x86 64 img a Please make sure the parameter intel jiommu on exists when updating the boot grub grub conf file otherwise SR IOV cannot be loaded Step 5 Install the MLNX EN driver for Linux that supports SR IOV SR IOV can be enabled and managed by using one of the following methods Burn firmware with SR IOV support where the number of virtual functions VFs will be set to 16 enable sriov Runthe mlxconfig tool and set the SRIOV EN parameter to 1 without re burning the firmware SRIOV EN 1 For further information please refer to section mlxconfig Changing Device Configuration Tool in the MFT User Manual www mellanox com gt Products gt Software gt Firmware Tools Step 6 Verify the HCA is configured to support SR IOV root selene mstflint dev lt PCI Device gt dc 1 Verify in the HCA section the following fields appear HCA num pfs 1 Goul vis Ub sriov_en true Parameter Recommended Value num_pfs 1 Note This field is optional and might not always appear total_vfs When using firmware version 2 31 5000 and above the recommended value is 126 When using firmware version 2 30 8000 and below the recommended value is 63 Note Before setting number of VFs in SR IOV please make sure your system can support that amount of VFs Setting number of VFs larger than what your Hardware and Software can support may cause your system to cease
49. ny layer any kind of event packet HWTSTAMP FILTER PTP V2 EVENT PTP v2 802 AS1 any layer Sync packet HWTSTAMP FILTER PTP V2 SYNC PTP v2 802 AS1 any layer Delay req packet HWTSTAMP FILTER PTP V2 DELAY REQ Note for receive side time stamping currently only HWTSTAMP FILTER NONE and HWTSTAMP FILTER ALL are supported 3 2 2 Getting Time Stamping Once time stamping is enabled time stamp 1s placed in the socket Ancillary data recvmsg can be used to get this control message for regular incoming packets For send time stamps the outgo ing packet is looped back to the socket s error queue with the send time stamp s attached It can be received with recvmsg flags MSG ERRQUEUE The call returns the original outgoing packet data including all headers preprended down to and including the link layer the scm timestamping control message and a sock extended err control message with ee errno ENOMSG and ee origin SO EE ORIGIN TIMESTAMPING A socket with such a pending bounced packet is ready for reading as far as select is concerned If the outgoing Mellanox Technologies 27 J Rev 2 3 1 0 0 Feature Overview and Configuration packet has to be fragmented then only the first fragment is time stamped and returned to the sending socket When time stamping is enabled VLAN stripping is disabled k For more info please refer to Documentation networking timestamping txt in kernel org 3 3
50. o reduce packet drops in lossy environments and mitigate congestion spreading and resulting victim flows in lossless environments The Quantized Congestion Notification QCN IEEE standard 802 1Qau provides congestion control for long lived flows in limited bandwidth delay product Ethernet networks It is part of the IEEE Data Center Bridging DCB protocol suite which also includes ETS PFC and DCBX QCN in conducted at L2 and is targeted for hardware implementations QCN applies to all Ethernet packets and all transports and both the host and switch behavior is detailed in the standard QCN user interface allows the user to configure QCN activity QCN configuration and retrieval of information is done by the m1nx qcn tool The command interface provides the user with a set of changeable attributes and with information regarding QCN s counters and statistics All parameters and statistics are defined per port and priority QCN command interface is available 1f and only the hardware supports it 3 8 1 QCN Tool mlnx qcn mlnx_qcn is a tool used to configure QCN attributes of the local host It communicates directly with the driver thus does not require setting up a DCBX daemon on the system The mlnx qcn enables the user to nspect the current QCN configurations for a certain port sorted by priority nspect the current QCN statistics and counters for a certain port sorted by priority Set values of chosen QCN parameters Mellanox
51. ooting cc ccc ccc c ec cee hh Hh hh nn n 58 4 1 General Related Issues 0 0 0 ccc eee en 58 4 2 Ethernet Related Issues llle 58 4 3 Performance Related Issues 0 0 2 00 0 cece cece tenet enn 60 44 SR IOV Related Issues asec seo claw steed ow RR pleat ea wl ed wens da 60 4 Mellanox Technologies J Rev 2 3 1 0 0 List of Tables Table 1 Document Revision History 0 ccc cent ence enna 6 Table 2 Abbreviations and Acronyms 0 00 ccc eect nent n teen eas 8 Table 3 Glossary ssa deg sator Gate taken Een ae RE aan ee eR EN ERE WERE E Male Sansa ee 9 Table 4 Reference Documents 0 000 eh 9 Table 5 MLNX EN Software Components 0000s cee cece e 11 Table 6 Flow Specific Parameters o oooooooooororrr e 30 Table 7 ethtool Supported Opti0NS ooooooooococrrr nee eee ene 45 Table Port IN Counters 3e sate di dai ake Mae BERR RI reste 53 Table 9 Pot OUT Counters a od ees 54 Table 10 Port VLAN Priority Tagging where lt i gt is in the range 0 7 000000 55 Table 11 Port Pause where lt i gt is in the range 0 7 20 ccc teen ene 55 Table 12 VPort Statistics where lt i gt lt empty_string gt is the PF and ranges 1 NumOfVf per VF 56 Table 13 SW Statistics xe ede eere ere Tenis erp Men d gue bala er ola OR Leh aes 56 Table 14 Per Ring SW Statistics where lt i gt is the ring I per configuration
52. pause frame settings gt ethtool a eth x gt To set pause frame settings gt ethtool A eth x rx on off tx on off To query ring size values gt ethtool g eth lt x gt gt To modify rings size gt ethtool G eth lt x gt rx lt N gt tx lt N gt gt To obtain additional device statistics gt ethtool S eth lt x gt To perform a self diagnostics test gt ethtool t eth lt x gt The driver defaults to the following parameters Both ports are activated 1 e a net device is created for each port The number of Rx rings for each port is the nearest power of 2 of number of cpu cores limited by 16 LRO is enabled with 32 concurrent sessions per Rx ring Some of these values can be changed using module parameters which can be displayed by run ning gt modinfo mlx4 en To set non default values to module parameters add to the etc modprobe cont file options mlx4 en param name value param name value Values of all parameters can be observed in sys module mlx4 en parameters 2 10 Performance Tunining For further information on Linux performance please refer to the Performance Tuning Guide for Mellanox Network Adapters 18 Mellanox Technologies Rev 2 3 1 0 0 3 Feature Overview and Configuration 3 1 Quality of Service Quality of Service QoS is a mechanism of assigning a priority to a network flow socket rdma_cm conn
53. re it as determined by the TC number TC 7 is highest priority TC 0 is lowest It also has an absolute priority over non strict TCs ETS 20 Mellanox Technologies Rev 2 3 1 0 0 This property needs to be used with care as it may easily cause starvation of other TCs A higher strict priority TC is always given the first chance to transmit Only if the highest strict priority TC has nothing more to transmit will the next highest TC be considered Non strict priority TCs will be considered last to transmit This property is extremely useful for low latency low bandwidth traffic Traffic that needs to get immediate service when it exists but is not of high volume to starve other transmitters in the sys tem 3 1 4 2 Minimal Bandwidth Guarantee ETS After servicing the strict priority TCs the amount of bandwidth BW left on the wire may be split among other TCs according to a minimal guarantee policy If for instance TCO is set to 80 guarantee and TC1 to 20 the TCs sum must be 100 then the BW left after servicing all strict priority TCs will be split according to this ratio Since this is a minimal guarantee there is no maximum enforcement This means in the same example that if TC1 did not use its share of 20 the reminder will be used by TCO 3 1 4 3 Rate Limit Rate limit defines a maximum bandwidth allowed for a TC Please note that 10 deviation from the requested values is considered acceptable 3 1 5 Qua
54. red Ethernet devices It can be used to Get identification and diagnostic information Get extended device statistics 1 A fatal device error can be a timeout from a firmware command an error on a firmware closing command communication channel not being responsive in a VF etc 44 Mellanox Technologies Rev 2 3 1 0 0 e Control speed duplex autonegotiation and flow control for Ethernet devices Control checksum offload and other hardware offload features Control DMA ring sizes and interrupt moderation The following are the ethtool supported options Table 7 ethtool Supported Options Options Description ethtool i eth lt x gt Checks driver and device information For example gt ethtool i eth2 driver mlx4 en MT 0DD0120009 CX3 version 2 1 6 Aug 2013 firmware version 2 30 3000 bus info 0000 1a 00 0 ethtool k eth lt x gt Queries the stateless offload status ethtool K eth lt x gt rx onloff tx Sets the stateless offload status onloff sg onjoff tso onjoff Iro TCP Segmentation Offload TSO Generic Segmentation onjoff gro on off gso onjoff Offload GSO increase outbound throughput by reducing rxvlan onjoft CPU overhead It works by queuing up large buffers and letting the network interface card split them into separate packets Large Receive Offload LRO increases inbound through put of high bandwidth network connections by reducing CPU overhead
55. rrors 0 dropped 0 overruns 0 frame 0 TX packets 450 errors 0 dropped 0 overruns 0 carrier 0 collisions 0 txqueuelen 1000 RX bytes 22440 21 9 KiB TX bytes 19232 18 7 KiB Interrupt 10 Base address 0xa000 38 Mellanox Technologies Rev 2 3 1 0 0 Step 5 Add the MAC 52 54 00 E7 77 99 to the sys class net eth5 fdb table on HV Before cat sys class net eth5 fdb 3335533100510 011021302 33 33 ff 2e 66 52 01 00 5e 00 00 01 33 33 00 00 00 01 Do echo 52 54 00 E7 77 99 gt sys class net eth5 fdb After cat sys class net eth5 fdb 52 54 00 e7 77 99 33 53 00200 02 02 so 002 Mis00sScs 0000801 argo OO OI 3 4 1 4 Assigning a Virtual Function to a Virtual Machine This section will describe a mechanism for adding a SR IOV VF to a Virtual Machine 3 4 1 4 1 Assigning the SR IOV Virtual Function to the Red Hat KVM VM Server Step 1 Run the virt manager Step2 Double click on the virtual machine and open its Properties Step 3 Goto Details Add hardware gt PCI host device Bie Virtual Machine View Send Key 0 G gt Add new virtual hardware e C x Adding Virtual Hardware This assistant will guide you through adding a new piece of virtual hardware First select what type of hardware you wish to add Hardware type __ Storage W Network input arale O Physical Host Device BD video Bj watchdog X Cancel amp Forward sl Add Hardware Remove Step 4 Choose a Mellanox
56. ry Structure ios Rec ee be er ew ea ee Pee 11 1 2 Module Parameters 0 cece ene e a 12 1 2 1 mlx4 Module Parameters 00 eee cece teenies 12 Chapter 2 Installation coto Sa nek t nl A dis gtd sid wed paret VA 2 1 Software Dependencies 0 0 cece n 14 2 2 Downloading MLNX EN 0 0 cece tenn eens 14 2 3 installing MENXCEN estet tI A Re 14 2 3 1 Installation Modest ala gg metes 14 2 3 2 Installation Procedure oc soc cee eee eR ee ER ERR 15 2 4 Loading MENX EN ss sic a ib HE VERRE SERES Eten 15 2 5 Unloading MENX EN ser a erts ace V ere ai 16 2 6 Uninstalling MLNX EN ssssssee ern 16 2 7 Recompiling MLNX EN sss ern 16 2 8 Firmware Programming llle een 16 2 8 1 Installing Firmware Tools 2 0 cee eee nee 16 2 8 2 Updating Adapter Card Firmware 2 0 0 cee eee eee 17 2 9 Ethernet Driver Usage and Configuration 0 00 e eee eee 17 2 10 Performance Tunining 0 ccc ccc rn 18 Chapter 3 Feature Overview and Configuration o oooooooomomo 19 3 1 Quahtycof Service oet res t enu a enc e Cmq 19 3 1 1 Mapping Traffic to Traffic Classes eene 19 3 1 2 Plain Ethernet Quality of Service Mapping 00 0000 cee eee eee 19 3 1 3 Map Priorities with tc wrap py mlnx qos 0 ce eee eee eens 20 3 1 4 Quality of Service Properties 0 0 eee eh 20 3 1 5 Quality of Service Tools ereen EE a cect
57. ssigned interface number gt To check driver and device information gt ethtool i eth x Example gt ethtool i eth2 driver mlx4 en version 2 1 8 Oct 06 2013 firmware version 2 30 3110 bus info 0000 1a 00 0 To query stateless offload status gt ethtool k eth lt x gt To set stateless offload status gt ethtool K eth x rx on off tx on off sg on off tso on off lro on off To query interrupt coalescing settings gt ethtool c eth x To enable disable adaptive interrupt moderation H ethtool C eth x adaptive rx on off By default the driver uses adaptive interrupt moderation for the receive path which adjusts the mod eration time to the traffic pattern gt To set the values for packet rate limits and for moderation time high and low gt ethtool C eth x pkt rate low N pkt rate high N rx usecs low N rx usecs high N Above an upper limit of packet rate adaptive moderation will set the moderation time to its highest value Below a lower limit of packet rate the moderation time will be set to its lowest value gt To set interrupt coalescing settings when adaptive moderation is disabled gt ethtool C eth x rx usecs N rx frames N Mellanox Technologies 17 J Rev 2 3 1 0 0 Installation P usec settings correspond to the time to wait after the last packet is sent received before triggering an interrupt To query
58. sum Offload MLNX EN supports the following Receive IP L4 Checksum Offload modes 46 Mellanox Technologies Rev 2 3 1 0 0 CHECKSUM UNNECESSARY By setting this mode the driver indicates to the Linux Networking Stack that the hardware successfully validated the IP and L4 checksum so the Linux Networking Stack does not need to deal with IP L4 Checksum validation Checksum Unnecessary is passed to the OS when all of the following are true Ethtool k lt DEV gt shows rx checksumming on Received TCP UDP packet and both IP checksum and L4 protocol checksum are correct CHECKSUM COMPLETE When the checksum validation cannot be done or fails the driver still reports to the OS the calculated by hardware checksum value This allows accelerating checksum validation in Linux Networking Stack since it does not have to calculate the whole checksum including payload by itself Checksum Complete is passed to OS when all of the following are true Ethtool k lt DEV gt shows rx checksumming on Using ConnectX 3 firmware version 2 31 7000 and up Received IpV4 IpV6 non TCP UDP packet CHECKSUM NONE By setting this mode the driver indicates to the Linux Network ing Stack that the hardware failed to validate the IP or L4 checksum so the Linux Net working Stack must calculate and validate the IP L4 Checksum Checksum None is passed to OS for all other cases 3 8 Quantized Congestion Control Congestion control is used t
59. t 150000 rpg threshold 5 rpg max rate 40000 rpg ai rate 10 rpg hai rate 50 rpg gd 8 rpg min dec fac 2 rpg min rate 10 cndd state machine 0 3 8 2 Setting QCN Configuration Setting the QCN parameters requires updating its value for each priority 1 indicates no change in the current value Mellanox Technologies 49 J Rev 2 3 1 0 0 Feature Overview and Configuration 3 9 3 9 1 Example for setting rp g enable in order to enable QCN for priorities 3 5 6 wlm fea l etha mpgaenab le ol ol 1 1 1 1 oil Example for setting rpg_hai_rate for priorities 1 6 7 lee oem eun pano aue G0 l lt il sil il lt i 60 50 Explicit Congestion Notification ECN ECN is an extension to the IP protocol It allows reliable communication by notifying all ends of communication when a congestion occurs This is done without dropping packets Please note that since this feature requires all nodes in the path nodes routers etc between the communicating nodes to support ECN to ensure reliable communication ECN is marked as 2 bits in the traffic control IP header This ENC implementation refers to both RoCE and Routable RoCE ECN command interface is use to configure ECN activity The access to it is through the file sys tem mount of debugfs is required The interface provides a set of changeable attributes and information regarding ECN s counters and statistics Enabling the ECN command interface is done by setting the
60. t frames tx 1518 bytes packets Number of transmitted 1024 to 1518 octet frames tx 1522 bytes packets Number of transmitted 1519 to 1522 octet frames tx 1548 bytes packets Number of transmitted 1523 to 1548 octet frames 54 Mellanox Technologies Rev 2 3 1 0 0 Table 9 Port OUT Counters Counter Description tx gt 1548 bytes packets Number of transmitted 1549 or greater octet frames Table 10 Port VLAN Priority Tagging where i is in the range O 7 Counter Description IX prio i packets Total packets successfully received with priority 1 IX prio i bytes Total bytes in successfully received packets with priority i rx novlan packets Total packets successfully received with no VLAN priority rx novlan bytes Total bytes in successfully received packets with no VLAN pri ority tx prio i packets Total packets successfully transmitted with priority 1 tx prio i bytes Total bytes in successfully transmitted packets with priority i tx novlan packets Total packets successfully transmitted with no VLAN priority tx novlan bytes Total bytes in successfully transmitted packets with no VLAN priority Table 11 Port Pause where i is in the range 0 7 Counter Description IX pause prio lt i gt The total number of PAUSE frames received from the far end port rx pause duration prio i The total time in microseconds
61. t teen eens 21 3 2 Time Stamping Service ern 25 3 2 1 Enabling Time Stamping 0 0 0c eect ees 25 3 2 2 Getting Time Stamping 0 0 ect teee eens 27 3 3 Flow Steermg som tea oes ss 28 3 3 1 Enable Disable Flow Steering 0 cece ccc teens 28 3 3 2 Flow Steering Support 0 cece teens 29 3 3 3 AO Static Device Managed Flow Steering 00 0 0 e eee eee 29 3 3 4 Flow Domains and Priorities 5 leere 30 3 4 Virtualization 5r eee D T RE Latet etos eR Red at kta 31 Mellanox Technologies 3 J Rev 2 3 1 0 0 3 4 1 Single Root IO Virtualization SR IOV 20 0 cece eee 31 3452 Ethernet VXLAN si ek Ee Pi be Rhea SL E C VER ER 43 3 5 gt Resiliency ee teet dd ah hilt tide i 44 3521 Reset Blow ssn obs VECES COMEDOR OE ERR dela 44 3 6 Ethtoolurr cie eho ad Meee eve bea en 44 Z Checksum Offload ir ertet tex epe had ees Omelet 46 3 8 Quantized Congestion Control 00 0 cece eens 47 3 8 1 QCN Tool mlnx qen ici ii a vere Ge ee 47 3 8 2 Setting QCN Configuration 49 3 9 Explicit Congestion Notification ECN 0 0 0 0 ccc eee 50 3 0 1 Enabling ECN 5 2 ue tue ad eee CRE ded un 50 3 92 Various ECN Paths od 5b aoe and ie pod Sys Cr pd seeds 52 3 10 Power Management 0 0 cece he 52 3 11 XOR RSS Hash Function 0 cee cette eens 52 3 12 Ethernet Performance Counters 0 0 0 0 cece cee een ene es 52 Chapter 4 Troublesh
62. teering on page 29 b2 Enable AO static DMFS When set to 1 AO static DMFS steering is enabled This steering see Section 3 3 3 bit should be set to 0 when b1 Disable IPoIB Flow Steer AO Static Device Managed ing is 0 Flow Steering on page 29 28 Mellanox Technologies Rev 2 3 1 0 0 bit Operation Description b3 Enable DMFS only if the When set to 1 DMFS is enabled only if the HCA supports HCA supports more than more than 64 QPs attached to the same rule For example 64QPs per MCG entry attaching 64VFs to the same multicast address causes 64QPs to be attached to the same MCG If the HCA sup ports less than 64 QPs per MCG BO is used For example a value of 7 means forcing flow steering regardless of NC SI flow steering sup port disabling IPoIB flow steering support and enabling AO static DMFS steering The default value of log_num mgm entry size is 10 Meaning Ethernet Flow Steering i e IPoIB DMFS is disabled by default is enabled by default if NC SI DMFS is supported and the HCA supports at least 64 QPs per MCG entry Otherwise L2 steering BO is used When using SR IOV flow steering is enabled if there is an adequate amount of space to store the flow steering table for the guest master To enable Flow Steering Step 1 Open the etc modprobe d mlnx conf file Step2 Set the parameter 1og num mgm entry size to a non positive value by writing the option
63. that far end port was requested to gt pause transmission of packets rx pause transition prio lt i The number of receiver transitions from XON state paused to gt XOFF state non paused tx pause prio lt i gt The total number of PAUSE frames sent to the far end port tx pause duration prio i The total time in microseconds that transmission of packets has been paused tx pause transition prio i The number of transmitter transitions from XON state paused gt to XOFF state non paused Mellanox Technologies 55 J Table 12 VPort Statistics where i empty string is the PF and ranges 1 NumOfVf per VF Rev 2 3 1 0 0 Feature Overview and Configuration Counter Description vport lt i gt _rx_unicast_packet S Unicast packets received successfully vport lt i gt rx unicast bytes Unicast packet bytes received successfully vport lt i gt rx multicast pack ets Multicast packets received successfully vportci rx multicast byte S Multicast packet bytes received successfully vportci rx broadcast pac kets Broadcast packets received successfully vport lt i gt _rx broadcast byte S Broadcast packet bytes received successfully vportci rx dropped Received packets discarded due to out of buffer condition vportci rx errors Received packets discarded due to receive error condition vport lt i gt tx unicast packet S U
64. the interrupt coalescing settings when the adaptive moderation is disabled Note usec settings correspond to the time to wait after the last packet is sent received before triggering an inter rupt ethtool a eth lt x gt Queries the pause frame settings ethtool A eth lt x gt rx on off tx onloff Sets the pause frame settings ethtool g eth lt x gt Queries the ring size values ethtool G eth lt x gt rx lt N gt tx lt N gt Modifies the rings size ethtool S eth lt x gt Obtains additional device statistics ethtool t eth lt x gt Performs a self diagnostics test ethtool s eth lt x gt msglvl N Changes the current driver message level ethtool T eth lt x gt Shows time stamping capabilities ethtool 1 eth lt x gt Shows the number of channels ethtool L eth lt x gt rx lt N gt tx lt N gt Sets the number of channels etthtool m dump module eeprom eth lt x gt raw onjoff hex onjoff offset N length N Queries Decodes the cable module eeprom information ethtool show priv flags eth lt x gt Shows driver private flags and their states on off Private flags are pm qos request low latency e mlx4 rss xor hash function qcn disable 32 14 4 e ethtool set priv flags eth lt x gt priv flag lt on off gt Enables disables driver feature matching the given private flag Check
65. thernet ports num vfs 00 04 0 5 6 7 00 07 0 8 9 10 The driver will enable HCA positioned in BDF 00 04 0 Ssingle VFs on port 1 e 6single VFs on port 2 7 dual port VFs HCA positioned in BDF 00 07 0 Ssingle VFs on port 1 Osingle VFs on port 2 10 dual port VFs Applies when all ports are configure as Ethernet in dual port HCAs Mellanox Technologies 35 J Rev 2 3 1 0 0 Feature Overview and Configuration Parameter Recommended Value num vfs Notes e PFs not included in the above list will not have SR IOV enabled Triplets and single port VFs are only valid when all ports are configured as Ethernet When an InfiniBand port exists only num v s a syntax is valid where a is a single value that represents the number of VFs The second parameter in a triplet is valid only when there are more than 1 physical port In a triplet x z lt 63 and y z lt 63 the maximum number of VFs on each physical port must be 63 port type array Specifies the protocol type of the ports It is either one array of 2 port types t1 t2 for all devices or list of BDF to port type array bb dd f t1 t2 string Valid port types 1 ib 2 eth 3 auto 4 N A If only a single port is available use the N A port type for port2 e g 1 4 probe vf Ifabsent or zero no VF interfaces will be loaded in the Hypervisor host e fnum vfsisa number in the range of 1 63 the driver running on the Hypervisor
66. tly supported in ConnectX 3 ConnectX 3 Pro adapter cards only Time stamping is the process of keeping track of the creation of a packet A time stamping ser vice supports assertions of proof that a datum existed before a particular time Incoming packets are time stamped before they are distributed on the PCI depending on the congestion in the PCI buffers Outgoing packets are time stamped very close to placing them on the wire 3 2 1 Enabling Time Stamping Time stamping is off by default and should be enabled before use gt To enable time stamping for a socket Call setsockopt with SO TIMESTAMPING and with the following flags SOF TIMESTAMPING TX HARDWARE try to obtain send time stamp in hardware SOF TIMESTAMPING TX SOFTWARE if SOF TIMESTAMPING TX HARDWARE is off or fails then do it in software SOF TIMESTAMPING RX HARDWARE return the original unmodified time stamp as generated by the hardware SOF TIMESTAMPING RX SOFTWARE if SOF TIMESTAMPING RX HARDWARE is off or fails then do it in software SOF TIMESTAMPING RAW HARDWARE return original raw hardware time stamp SOF TIMESTAMPING SYS HARDWARE return hardware time stamp transformed to the system time base SOF TIMESTAMPING SOFTWARE return system time stamp generated in software SOF TIMESTAMPING TX RX determine how time stamps are generated SOF TIMESTAMPING RAW SYS determine how they are reported To enable time stamping for a net device
67. ver will activate HCA positioned in BDF 00 04 0 Ssingle VFs on port 1 6single VFs on port 2 7 dual port VFs HCA positioned in BDF 00 07 0 Ssingle VFs on port 1 Osingle VFs on port 2 10 dual port VFs Applies when all ports are configure as Ethernet in dual port HCAs Notes PFs not included in the above list will not activate any of their VFs in the PF driver Triplets and single port VFs are only valid when all ports are configured as Ethernet When an InfiniBand port exist only probe vf a syntax is valid where a is a single value that represents the number of VFs The second parameter in a triplet is valid only when there are more than 1 physical port Every value either a value in a triplet or a single value should be less than or equal to the respective value of num v s parameter The example above loads the driver with 5 VFs num vfs The standard use of a VF is a single VF per a single VM However the number of VFs varies upon the working mode requirements Step 9 Reboot the server gt d If the SR IOV is not supported by the server the machine might not come out of boot load Step 10 Load the driver and verify the SR IOV is supported Run lspci grep Mellanox 03 00 0 InfiniBand Mellanox Technologies MT26428 ConnectX VPI PCIe 2 0 5GT s IB QDR 10GigE rev b0 03 00 1 InfiniBand Mellanox Technologies MT27500 Family ConnectX 3 Virtual Function rev b0 03 00 2 I
68. virtual function according to its PCI device e g 00 03 1 Step 5 If the Virtual Machine is up reboot it otherwise start it Step 6 Log into the virtual machine and verify that it recognizes the Mellanox card Run lspci grep Mellanox 00 03 0 InfiniBand Mellanox Technologies MT27500 Family ConnectX 3 Virtual Function rev b0 Mellanox Technologies 39 J Rev 2 3 1 0 0 Feature Overview and Configuration 3 4 1 5 3 4 1 6 3 4 1 6 1 Step 7 Add the device to the etc sysconfig network scripts ifcfg ethx configuration file The MAC address for every virtual function is configured randomly therefore it is not necessary to add it Uninstalling SR IOV Driver gt To uninstall SR IOV driver perform the following Step 1 For Hypervisors detach all the Virtual Functions VF from all the Virtual Machines VM or stop the Virtual Machines that use the Virtual Functions Please be aware stopping the driver when there are VMs that use the VFs will cause machine to hang Step2 Run the script below Please be aware uninstalling the driver deletes the entire driver s file but does not unload the driver sbin mlnx en uninstall sh MLNX EN uninstall done Step3 Restart the server Ethernet Virtual Function Configuration when Running SR IOV VLAN Guest Tagging VGT and VLAN Switch Tagging VST When running ETH ports on VFs the ports may be configured to simply pass through packets as is from VFs Vlan Guest Taggi
69. w 1 The application sets the ToS of the socket using setsockopt 1P Tos value 2 ToS is translated into the sk prio using a fixed translation TOS 0 sk prio 0 TOS 8 sk prio 2 TOS 24 sk prio 4 TOS 16 sk prio 6 3 The Socket Priority is mapped to the UP Ifthe underlying device is a VLAN device egress map is used controlled by the vconfig command This is per VLAN mapping Ifthe underlying device is not a VLAN device the tc command is used In this case even though tc manual states that the mapping is from the sk prio to the TC number the mlx4 en driver interprets this as a sk prio to UP mapping Mellanox Technologies 19 J Rev 2 3 1 0 0 Feature Overview and Configuration Mapping the sk prio to the UP is done by using tc wrap py i dev name u 0 1 2 3 4 5 6 7 4 The the UP is mapped to the TC as configured by the m1nx qos tool or by the 11dpad daemon if DCBX is used Socket applications can use setsockopt SK_PRIO value to directly set the sk_prio P of the socket In this case the ToS to sk prio fixed mapping is not needed This allows the application and the administrator to utilize more than the 4 values possible via ToS In case of VLAN interface the UP obtained according to the above mapping is also used P in the VLAN tag of the traffic 3 1 3 Map Priorities with tc wrap py mlnx qos Network flow that can be managed by QoS attributes is described by a User Priority UP
70. xx 00 25 8B xx xx xx or F4 52 14 xx xx xx 4 2 Ethernet Related Issues Table 16 Ethernet Related Issues Issue Cause Solution No link Misconfiguration of the Ensure the switch port is not down switch port or using a cable Ensure the switch port rate is config not supporting link rate ured to the same rate as the adapter s port 58 Mellanox Technologies Table 16 Ethernet Related Issues Rev 2 3 1 0 0 Issue Cause Solution Degraded performance is measured when hav ing a mixed rate envi ronment 10GbE 40GbE and 56GbE Sending traffic from a node with a higher rate to a node with lower rate Enable Flow Control on both switch s ports and nodes On the server side run ethtool A interface rx on tx on On the switch side run the following command on the relevant interface send on force and receive on force No link with break out cable Misuse of the break out cable or misconfiguration of the switch s split ports Use supported ports on the switch with proper configuration For fur ther information please refer to the MLNX OS User Manual Make sure the QSFP break out cable side is connected to the SwitchX Physical link fails to The adapter is running an Install the latest firmware on the negotiate to maximum outdated firmware adapter supported rate Physical link fails to The cable is not connected Ensure that the cabl
71. y Structure The tarball image of MLNX EN contains the following files and directories e installsh This is the MLNX EN installation script e minx en uninstall sh This is the MLNX EN un installation script firmware Directory of the Mellanox HCA firmware images SOURCES Directory of the MLNX EN source tarball SRPM based A script required to rebuild MLNX EN for customized kernel version on supported RPM based Linux Distribution Mellanox Technologies 11 J Rev 2 3 1 0 0 Overview 1 2 Module Parameters 1 2 1 mlx4 Module Parameters In order to set m1x4 parameters add the following line s to etc modprobe conf options mlx4 core parameter value and or options mlx4 en parameter lt value gt The following sections list the available m1x4 parameters 1 2 1 1 mlx4 core Parameters set 4k mtu debug level msi X enable sys tune block loopback num vfs probe vf log num mgm entry size high rate steer fast drop enable 64b cqe ege log num mac log num vlan log mtts per seg Obsolete attempt to set 4K MTU to all ConnectX ports int Enable debug tracing if 0 int 0 don t use MSI X IS SANS gt 1 limit number of MSI X irqs to msi x non SRIOV only int Tune the cpu s for better performance default 0 int Block multicast loopback packets if 0 default 1 int Either a single value e g 5 to define uniform num vfs value for all devices functions or a string

MLNX_EN for Linux User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents