Intel® Ethernet Controller E810 Application Device Queues (ADQ)

Configuration Guide

ID Date Version Classification
609008 07/04/2024 Public
Document Table of Contents
Document Table of Contents
Notices and Disclaimers Revision History Fixed and Known Issues - Read First Introduction ADQ Requirements ADQ System Under Test (SUT) Installation General System Tuning ADQ Setup Using ADQ Setup Script ADQ Configuration on SR-IOV Virtual Functions Troubleshooting Testing ADQ with Netperf Testing ADQ with Redis Testing ADQ with Memcached/rpc-perf Testing ADQ with NGINX Testing ADQ with AF_XDP Testing ADQ with Apache Traffic Server (ATS) Testing ADQ with VirtIO Appendix
Notices and Disclaimers
Revision History
Fixed and Known Issues - Read First
Fixed and Known Issues - Read First Fixed Issues Known Issues
Fixed Issues
ADQ PF Issues ADQ Setup Script Issues ADQ VF Issues
ADQ PF Issues
ADQ Setup Script Issues
ADQ VF Issues
Known Issues
ADQ PF Known Issues ADQ Setup Script Known Issues ADQ VF Known Issues
ADQ PF Known Issues
ADQ Setup Script Known Issues
ADQ VF Known Issues
Introduction
Introduction ADQ Overview ADQ Reference
ADQ Overview
ADQ Reference
ADQ Requirements
Hardware Requirements Software Requirements
Hardware Requirements
Software Requirements
ADQ System Under Test (SUT) Installation
Install OS Update Kernel (If Needed) Install ice Driver with ADQ Flags Install iproute2 (Update If Needed) Install cgroup Packages (If Needed)
Install OS
Update Kernel (If Needed)
Install ice Driver with ADQ Flags
Install iproute2 (Update If Needed)
Install cgroup Packages (If Needed)
General System Tuning
ADQ Setup Using ADQ Setup Script
ADQ Setup Using ADQ Setup Script ADQ Setup Script Prerequisites ADQ Setup Script Installation ADQ Setup Script Usage
ADQ Setup Script Prerequisites
ADQ Setup Script Installation
ADQ Setup Script Usage
ADQ Configuration on SR-IOV Virtual Functions
ADQ Configuration on SR-IOV Virtual Functions General SUT Configuration for VFs SUT Configuration Bare Metal VF SUT Configuration VF Inside a VM ADQ VF Configuration
General SUT Configuration for VFs
SUT Configuration Bare Metal VF
SUT Configuration VF Inside a VM
ADQ VF Configuration
Troubleshooting
Testing ADQ with Netperf
Testing ADQ with Netperf Installation and Configuration – Both Systems netperf Server netperf Client
Installation and Configuration – Both Systems
netperf Server
netperf Client
Testing ADQ with Redis
Testing ADQ with Redis Redis Server Setup Redis Clients (non-ADQ) Configuration
Redis Server Setup
Redis Clients (non-ADQ) Configuration
Testing ADQ with Memcached/rpc-perf
Testing ADQ with Memcached/rpc-perf Memcached Server Setup Memcached/rpc-perf Clients (non-ADQ) Configuration
Memcached Server Setup
Memcached/rpc-perf Clients (non-ADQ) Configuration
Testing ADQ with NGINX
Testing ADQ with NGINX NGINX Server Setup wrk Clients Configuration
NGINX Server Setup
wrk Clients Configuration
Testing ADQ with AF_XDP
Testing ADQ with AF_XDP AF_XDP Server Configuration Traffic Generator Example Configuration (Non-ADQ)
AF_XDP Server Configuration
Traffic Generator Example Configuration (Non-ADQ)
Traffic Generator Example Configuration (Non-ADQ) Traffic Pattern to Be Generated Example: Running DPDK-pktgen Traffic
Traffic Pattern to Be Generated
Example: Running DPDK-pktgen Traffic
Testing ADQ with Apache Traffic Server (ATS)
Testing ADQ with Apache Traffic Server (ATS) ATS Server Setup Vegeta Clients Configuration
ATS Server Setup
Vegeta Clients Configuration
Testing ADQ with VirtIO
Testing ADQ with VirtIO Installation and Configuration - Both Systems Run the Traffic
Installation and Configuration - Both Systems
Run the Traffic
Appendix
ADQ Configuration Reference (Manual)
ADQ Configuration Reference (Manual)
ADQ Configuration on SUT
ADQ Configuration on SUT
ADQ Configuration on SUT Adapter Preparation Configure ADQ Traffic Class (TC) on SUT Independent Pollers (Optional) Apply Adapter Tuning Configure Symmetric Queues Configure Intel® Ethernet Flow Director Settings Set cgroup Priority for Application Network Traffic (If Needed) Verify ADQ Application Traffic and Independent Pollers (If Applicable) Clear the ADQ Configuration
Adapter Preparation
Configure ADQ Traffic Class (TC) on SUT
Configure ADQ Traffic Class (TC) on SUT Create TCs TC Filtering Confirm TC Configuration
Create TCs
Create TCs TC Minimum Rate Creation TC Maximum Rate Creation TC Minimum and Maximum Rate Creation
TC Minimum Rate Creation
TC Maximum Rate Creation
TC Minimum and Maximum Rate Creation
TC Filtering
TC Filtering TC Filtering Requirements
TC Filtering Requirements
Confirm TC Configuration
Independent Pollers (Optional)
Independent Pollers (Optional) Independent Pollers Introduction Configure Independent Pollers
Independent Pollers Introduction
Configure Independent Pollers
Apply Adapter Tuning
Configure Symmetric Queues
Configure Intel® Ethernet Flow Director Settings
Set cgroup Priority for Application Network Traffic (If Needed)
Verify ADQ Application Traffic and Independent Pollers (If Applicable)
Clear the ADQ Configuration

Install OS

Install any Intel® Ethernet 800 Series supported Linux-based operating system with software development packages. This document has examples for RHEL 8.0+, but others can be used.

ADQ technology support might require a kernel update. ADQ requires capabilities in the Linux kernel available in LTS Linux kernel. Refer to the OS vendor's documentation for the base kernel version of an OS. Refer to kernel and operating system requirements in this section for ADQ-specific kernel support.

Note:The kernel-modules-extra package is required for RHEL 8.0 or higher: yum install -y kernel-modules-extra

ice-1.7.x and Earlier

  • Linux kernel v4.19.x or higher.
  • Inline Flow Director is configured using the channel-inline-flow-director ethtool private flag (set globally on the interface for all TCs).
  • ADQ kernel support has also been back-ported to the following operating systems, which are based on earlier base kernel versions. These operating systems do not require a kernel update even though their base kernel version is lower than 4.19.58:
    • RHEL 8.0 or higher (inbox kernel)
    • SLES 12 SP5 or higher (inbox kernel)
    • SLES 15 SP1 or higher (inbox kernel)
    • Ubuntu 20.04 or higher (inbox kernel)

ice-1.8.x and Later

  • Linux kernel v5.6 or higher, for devlink parameter support:

    https://www.kernel.org/doc/html/v5.6/networking/devlink/devlink-params.html

  • Inline Flow Director is configured using per-TC inline flow director.
  • The following operating systems contain kernels with devlink parameter support and do not require a kernel update even though their base kernel version may be lower than 5.6:
    • RHEL 8.6 or higher (inbox kernel)
    • RHEL 9.0 or higher (inbox kernel)
    • SLES 15 SP4 or higher (inbox kernel)
    • Ubuntu 20.10 or higher (inbox kernel)
Note:To check if a kernel has the required devlink parameter support: devlink dev param show

If the kernel supports devlink params, output is displayed for each E810 device interface. Otherwise, an error message is returned by the kernel, similar to: Command “param” not found.

In addition to the kernel requirements listed for ice-1.8.x and later, ice-1.9.x and later requires Linux kernel v5.12 or higher if using independent pollers with kthread based napi poll (earlier kernel versions use ksoftirqd threads to act as independent pollers). See Independent Pollers (Optional) for more details.

The following operating systems include kernel support for kthread-based napi poll and do not require a kernel update even though their base kernel version may be lower than 5.12:

  • RHEL 8.6 or higher (inbox kernel)
  • RHEL 9.0 or higher (inbox kernel)
  • SLES 15 SP4 or higher (inbox kernel)
Note:Some applications or use cases might require a newer version of the kernel than what is listed in this section. The kernel version listed here is required for ADQ feature support in the kernel. See application-specific sections in this document to verify if there are any additional kernel requirements for the application.

For operating systems that require a kernel update, proceed with updating the kernel following the instructions in Update Kernel (If Needed).

For operating systems that do not require a kernel update, move directly on to Install ice Driver with ADQ Flags.

Update Kernel (If Needed)