Mellanox OFED Linux User’s Manual

1 Mellanox OFED for Linux user Manual Rev Software version Mellanox Technologies 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 PRODUCT(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.

2 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. DAMAGE. Mellanox Technologies 350 Oakmead Parkway Suite 100.

3 Sunnyvale, CA 94085. Tel: (408) 970-3400. Fax: (408) 970-3403. Copyright 2018. Mellanox Technologies Ltd. All Rights Reserved. Mellanox , Mellanox logo, Connect -IB , ConnectX , CORE-Direct , GPUD irect , LinkX , Mellanox Multi -Host , Mellanox Socket Direct , UFM , and Virtual Protocol Interconnect are registered trademarks of Mellano Technologies,Ltd. For the complete and most updated list of Mellanox trademarks, visit All other trademarks are property of their respective owners. Document Number: 2877 Mellanox Technologies 2. Table of Contents Table of Contents .. 3. List of Tables .. 10. Chapter 1 Overview .. 20. Stack Architecture .. 21. mlx4 VPI Driver .. 21. mlx5 Driver.

4 22. Mid-layer Core.. 23. Upper Layer Protocols (ULPs).. 23. IP over IB (IPoIB) .. 23. iSCSI Extensions for RDMA (iSER) .. 23. SCSI RDMA Protocol (SRP).. 24. user Direct Access Programming Library (uDAPL) .. 24. MPI .. 24. InfiniBand Subnet Manager .. 24. Diagnostic Utilities .. 24. Mellanox Firmware Tools .. 25. Mellanox OFED Package.. 25. ISO Image.. 25. Software Components .. 25. Firmware .. 26. Directory Structure .. 26. Module Parameters .. 27. mlx4 Module Parameters .. 27. mlx4_ib Parameters.. 27. mlx4_core Parameters .. 28. mlx4_en Parameters .. 30. mlx5_core Module Parameters .. 30. ib_core Parameters.. 31. ib_ipoib Parameters .. 31. Device Capabilities .. 31. Chapter 2 Installation.

5 32. Hardware and Software Requirements .. 32. Downloading Mellanox OFED .. 32. Installing Mellanox OFED .. 33. Installation Script .. 33. Installation Procedure.. 35. Installation Results .. 38. Rev Mellanox Technologies 3. Installation Logging .. 38. openibd Script .. 39. Driver Load Upon System Boot .. 39. mlnxofedinstall Return Codes .. 40. Additional Installation Procedures .. 40. Installing MLNX_OFED on Innova IPsec Adapter Cards .. 40. Installing MLNX_OFED Using YUM .. 40. Installing MLNX_OFED Using apt-get .. 43. Installing Upstream rdma-core Libraries .. 45. Installing libdisni Package .. 46. Installing NEO-Host Using mlnxofedinstall Script .. 46. Uninstalling Mellanox OFED.

6 46. Updating Firmware After Installation .. 46. Updating the Device Online .. 46. Updating Firmware and FPGA Image on Innova IPsec Cards .. 48. Updating the Device Manually.. 48. Updating the Device Firmware Automatically upon System Boot .. 49. UEFI Secure Boot .. 49. Enrolling Mellanox 's Public Key On your Systems .. 49. Removing Signature from Kernel Modules .. 50. Performance Tuning .. 50. Chapter 3 Features Overview and Configuration .. 51. Ethernet Network .. 51. Interface.. 51. ConnectX-3/ConnectX-3 Pro Port Type Management .. 51. ConnectX-4 and above Port Type Management/VPI Cards Configuration 52. Counters .. 52. Persistent Naming .. 53. Quality of Service (QoS).

7 54. Mapping Traffic to Traffic Classes .. 54. Plain Ethernet Quality of Service Mapping .. 54. RoCE Quality of Service Mapping .. 55. Map Priorities with set_egress_map .. 56. Quality of Service Properties .. 56. Quality of Service Tools.. 57. Packet Pacing .. 63. Quantized Congestion Notification (QCN) .. 65. QCN Tool - mlnx_qcn.. 65. Setting QCN Configuration .. 67. Ethtool .. 68. Checksum Offload .. 72. Ignore Frame Check Sequence (FCS) Errors .. 73. Rev Mellanox Technologies 4. RDMA over Converged Ethernet (RoCE) .. 73. RoCE Modes .. 74. GID Table Population.. 76. RoCE Lossless Ethernet Configuration .. 79. Type Of Service (ToS).. 85. RoCE LAG (ConnectX-3/ConnectX-3 Pro).

8 85. RoCE LAG (ConnectX-4/ConnectX-4 Lx/ConnectX-5) .. 87. Soft RoCE .. 88. Enabling/Disabling RoCE on VFs (ConnectX-4) .. 88. Force DSCP .. 89. Force Time to Live (TTL) .. 89. Flow Control .. 90. Priority Flow Control (PFC) .. 90. Dropless Receive Queue (RQ).. 94. Explicit Congestion Notification (ECN) .. 96. Enabling ECN on ConnectX-4/ConnectX-4 Lx/ConnectX-5 .. 96. RSS Support.. 97. RSS Hash Function .. 97. RSS Verbs Support for ConnectX-4 HCAs .. 98. Time-Stamping .. 99. Time-Stamping Service.. 99. RoCE Time Stamping .. 103. One Pulse Per Second (1 PPS) .. 105. Flow Steering .. 106. Enable/Disable Flow Steering .. 106. Flow Steering Support .. 107. A0 Static Device Managed Flow Steering.

9 108. Flow Domains and Priorities .. 108. Flow Steering Dump Tool .. 112. Wake-on-LAN (WoL).. 112. Hardware Accelerated VLAN (Q-in-Q Tunneling) .. 112. Requirements.. 113. VLAN Stripping in Linux Verbs .. 113. Offloaded Traffic Sniffer.. 113. Physical Address Memory Allocation .. 114. Dump Configuration .. 115. Local Loopback Disable .. 117. InfiniBand Network.. 117. Interface.. 117. ConnectX-3/ConnectX-3 Pro Port Type Management .. 117. ConnectX-4 Port Type Management .. 117. RDMA Counters .. 117. OpenSM .. 117. Rev Mellanox Technologies 5. opensm .. 118. osmtest.. 119. Partitions .. 119. Effect of Topology Changes .. 123. Routing Algorithms .. 123. Quality of Service Management in OpenSM.

10 146. Enhanced QoS .. 156. QoS Configuration Examples .. 157. Congestion Control Manager .. 166. DOS MAD Prevention .. 170. MAD Congestion Control .. 170. IB Router Support in OpenSM .. 171. OpenSM Activity Report .. 172. Offsweep Balancing .. 173. Quality of Service (QoS) .. 174. QoS Architecture .. 175. Supported Policy .. 175. CMA Features.. 176. Secure Host .. 177. Secure Mode Operation .. 177. IP over InfiniBand (IPoIB) .. 179. Upper Layer Protocol (ULP) .. 179. Enhanced IPoIB .. 184. IPoIB Mode Setting .. 184. Port Configuration .. 185. IPoIB Configuration .. 185. Subinterfaces .. 188. Verifying IPoIB Functionality.. 190. Bonding IPoIB.. 190. Dynamic PKey Change .. 191.