From patchwork Mon Aug 12 13:41:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dean Marx X-Patchwork-Id: 143080 X-Patchwork-Delegate: juraj.linkes@pantheon.tech Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id CA997457A1; Mon, 12 Aug 2024 15:41:22 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 69A2740A87; Mon, 12 Aug 2024 15:41:12 +0200 (CEST) Received: from mail-vs1-f46.google.com (mail-vs1-f46.google.com [209.85.217.46]) by mails.dpdk.org (Postfix) with ESMTP id 7597140A71 for ; Mon, 12 Aug 2024 15:41:11 +0200 (CEST) Received: by mail-vs1-f46.google.com with SMTP id ada2fe7eead31-493d7455231so1371325137.0 for ; Mon, 12 Aug 2024 06:41:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1723470070; x=1724074870; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Ly5tDEb32WKPWMSwf0INxC6CoVafP/zd4S1dEjOWAwI=; b=X0rh8ufCFqIDc+X0BlPZjNjvjH1UL2SYF9H5fgevp22jl8WeKFi7XnTM90VPxYh3W0 0xVLw2QNn2U5WpoHMtP4Aw6/LgB71jy4P1eld+w+TiNxnZgFfa3xvMbgTHu+4BmuujHq Pv4UYykLu5SAQ5AL9EDfrgSeL/P/NDNFwgLec= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723470070; x=1724074870; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Ly5tDEb32WKPWMSwf0INxC6CoVafP/zd4S1dEjOWAwI=; b=cFjH3bXWamgk7aZCK0eXlsEadMsglBvCuGkAihmjwu+S+CBj6QZzTDn3GnbpdouPAN qiOgwk+RDV1cte+EbxClGcM8L1SMfWF2V1S0yEwShPFZmqTgteGZzDkk/+6wfkilvb/i UDresFvdKKCvWuxYxnSyC1lLC8icPdHWzS2CQmxrmjf4FK71zwqQ0u+lq3TADfnwd9Na 75DxxE3YY65E3qDs45vuq1dhRpyiZJGH5VEWLQWhvVHeqES4OGcoLPdRMRq1yB9zD+yf XOoXk9+M872MtmkvWJQ3XzxJ+LcESkmRzaUxWy2kwKpw3PAEw5Ir2nSz/kZNA3ZNGon/ /GOA== X-Gm-Message-State: AOJu0Yx/1n+Cc4AsV+oEBWOi44ZVS1USHuYkESkOBCAHKq761gVsQXcv YQR8NiBSLVQnk4iAYTrBH9ULG/PCbu/wiZ2VuKr28LCsja8i4hDVwlafKeOreco= X-Google-Smtp-Source: AGHT+IEA7U1Bx/h2O+Os7Gn45uhGOhaJV0iXbtc25YqTaHxGTADXTcoveFEGqkq5hFe4AodasseaGg== X-Received: by 2002:a05:6102:38c7:b0:492:aa42:e0ce with SMTP id ada2fe7eead31-49743ab1c8dmr483493137.20.1723470070492; Mon, 12 Aug 2024 06:41:10 -0700 (PDT) Received: from dean-laptop.iol.unh.edu ([2606:4100:3880:1271:f9bd:24da:464d:6294]) by smtp.gmail.com with ESMTPSA id af79cd13be357-7a4c7d624c7sm247544785a.23.2024.08.12.06.41.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Aug 2024 06:41:10 -0700 (PDT) From: Dean Marx To: probb@iol.unh.edu, npratte@iol.unh.edu, jspewock@iol.unh.edu, luca.vizzarro@arm.com, yoan.picchi@foss.arm.com, Honnappa.Nagarahalli@arm.com, paul.szczepanek@arm.com, juraj.linkes@pantheon.tech Cc: dev@dpdk.org, Dean Marx Subject: [RFC v1 2/2] dts: checksum offload test suite Date: Mon, 12 Aug 2024 09:41:24 -0400 Message-ID: <20240812134124.27637-3-dmarx@iol.unh.edu> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240812134124.27637-1-dmarx@iol.unh.edu> References: <20240812134124.27637-1-dmarx@iol.unh.edu> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org test suite for verifying layer 3/4 checksum offload features on poll mode driver. Depends-on: patch-142762 ("dts: add text parser for testpmd verbose output") Depends-on: patch-142691 ("dts: add send_packets to test suites and rework packet addressing") Signed-off-by: Dean Marx --- dts/framework/config/conf_yaml_schema.json | 3 +- dts/framework/remote_session/testpmd_shell.py | 2 +- dts/tests/TestSuite_checksum_offload.py | 288 ++++++++++++++++++ 3 files changed, 291 insertions(+), 2 deletions(-) create mode 100644 dts/tests/TestSuite_checksum_offload.py diff --git a/dts/framework/config/conf_yaml_schema.json b/dts/framework/config/conf_yaml_schema.json index f02a310bb5..a83a6786df 100644 --- a/dts/framework/config/conf_yaml_schema.json +++ b/dts/framework/config/conf_yaml_schema.json @@ -187,7 +187,8 @@ "enum": [ "hello_world", "os_udp", - "pmd_buffer_scatter" + "pmd_buffer_scatter", + "checksum_offload" ] }, "test_target": { diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py index be8fbdc295..01f378acc3 100644 --- a/dts/framework/remote_session/testpmd_shell.py +++ b/dts/framework/remote_session/testpmd_shell.py @@ -856,7 +856,7 @@ def csum_set_hw(self, layer: str, port_id: int, verify: bool = True) -> None: InteractiveCommandExecutionError: If checksum offload is not enabled successfully. """ csum_output = self.send_command(f"csum set {layer} hw {port_id}") - if (verify and ("Bad arguments" in csum_output or f"Please stop port {port_id} first")): + if (verify and ("Bad arguments" in csum_output or f"Please stop port {port_id} first" in csum_output)): self._logger.debug(f"Failed to set csum hw mode on port {port_id}:\n{csum_output}") raise InteractiveCommandExecutionError( f"Failed to set csum hw mode on port {port_id}" diff --git a/dts/tests/TestSuite_checksum_offload.py b/dts/tests/TestSuite_checksum_offload.py new file mode 100644 index 0000000000..7ce5897c34 --- /dev/null +++ b/dts/tests/TestSuite_checksum_offload.py @@ -0,0 +1,288 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2024 University of New Hampshire + +"""DPDK checksum offload testing suite. + +This suite verifies L3/L4 checksum offload features of the Poll Mode Driver. +On the Rx side, IPv4 and UDP/TCP checksum by hardware is checked to ensure +checksum flags match expected flags. On the Tx side, IPv4/UDP, IPv4/TCP, +IPv6/UDP, and IPv6/TCP insertion by hardware is checked to checksum flags +match expected flags. + +""" + +from typing import List + +from scapy.all import Packet # type: ignore[import-untyped] +from scapy.layers.inet import GRE, IP, TCP, UDP # type: ignore[import-untyped] +from scapy.layers.inet6 import IPv6 # type: ignore[import-untyped] +from scapy.layers.l2 import Dot1Q # type: ignore[import-untyped] +from scapy.layers.l2 import Ether # type: ignore[import-untyped] +from scapy.layers.vxlan import VXLAN # type: ignore[import-untyped] +from scapy.packet import Raw # type: ignore[import-untyped] + +from framework.remote_session.testpmd_shell import ( + SimpleForwardingModes, + TestPmdShell, + VerboseOLFlag, +) +from framework.test_suite import TestSuite + + +class TestChecksumOffload(TestSuite): + """Checksum offload test suite. + + This suite consists of 8 test cases: + 1. Insert checksum on transmit packet + 2. Do not insert checksum on transmit packet + 3. Validate Rx checksum valid flags + 4. Hardware checksum check L4 Rx + 5. Hardware checksum check L3 Rx + 6. Hardware checksum check L4 Tx + 7. Hardware checksum check L3 Tx + 8. Checksum offload with vlan + + """ + + def set_up_suite(self) -> None: + """Set up the test suite. + + Setup: + Verify that at least two port links are created when the + test run is initialized. + """ + self.verify(len(self._port_links) > 1, "Not enough port links.") + + def send_packet_and_verify( + self, packet_list: List[Packet], load: str, should_receive: bool + ) -> None: + """Send and verify packet is received on the traffic generator. + + Args: + packet: Scapy packet to send and verify. + load: Raw layer load attribute in the sent packet. + should_receive: Indicates whether the packet should be received by the traffic generator. + """ + for i in range(0, len(packet_list)): + received_packets = self.send_packet_and_capture(packet=packet_list[i]) + received = any( + packet.haslayer(Raw) and load in str(packet.load) for packet in received_packets + ) + self.verify( + received == should_receive, + f"Packet was {'dropped' if should_receive else 'received'}", + ) + + def send_packet_and_verify_checksum( + self, packet: Packet, goodL4: bool, goodIP: bool, testpmd: TestPmdShell + ) -> None: + """Send packet and verify verbose output matches expected output. + + Args: + packet: Scapy packet to send to DUT. + goodL4: Verifies RTE_MBUF_F_RX_L4_CKSUM_GOOD in verbose output + if :data:`True`, or RTE_MBUF_F_RX_L4_CKSUM_UNKOWN if :data:`False`. + goodIP: Verifies RTE_MBUF_F_RX_IP_CKSUM_GOOD in verbose output + if :data:`True`, or RTE_MBUF_F_RX_IP_CKSUM_UNKOWN if :data:`False`. + testpmd: Testpmd shell session to analyze verbose output of. + """ + testpmd.start() + self.send_packet_and_capture(packet=packet) + verbose_output = testpmd.extract_verbose_output(testpmd.stop()) + isL4 = any( + VerboseOLFlag.RTE_MBUF_F_RX_L4_CKSUM_GOOD in packet.ol_flags + for index in verbose_output + for packet in index.packets + ) + isIP = any( + VerboseOLFlag.RTE_MBUF_F_RX_IP_CKSUM_GOOD in packet.ol_flags + for index in verbose_output + for packet in index.packets + ) + self.verify(isL4 == goodL4, "Layer 4 checksum flag did not match expected checksum flag.") + self.verify(isIP == goodIP, "IP checksum flag did not match expected checksum flag.") + + def setup_hw_offload(self, testpmd: TestPmdShell) -> None: + """Sets IP, UDP, TCP, and SCTP layers to hardware offload.""" + testpmd.port_stop(port=0) + testpmd.csum_set_hw(layer="ip", port_id=0) + testpmd.csum_set_hw(layer="udp", port_id=0) + testpmd.csum_set_hw(layer="tcp", port_id=0) + testpmd.port_start(port=0) + + def test_insert_checksums(self) -> None: + """Enable checksum offload insertion and verify packet reception.""" + packet_list = [ + Ether() / IP() / UDP() / Raw("xxxxx"), + Ether() / IP() / TCP() / Raw("xxxxx"), + Ether() / IPv6(src="::1") / UDP() / Raw("xxxxx"), + Ether() / IPv6(src="::1") / TCP() / Raw("xxxxx"), + ] + with TestPmdShell(node=self.sut_node, enable_rx_cksum=True) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.csum) + testpmd.set_verbose(level=1) + self.setup_hw_offload(testpmd=testpmd) + testpmd.start() + self.send_packet_and_verify(packet_list=packet_list, load="xxxxx", should_receive=True) + for i in range(0, len(packet_list)): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=True, goodIP=True, testpmd=testpmd + ) + + def test_no_insert_checksums(self) -> None: + """Enable checksum offload insertion and verify packet reception.""" + packet_list = [ + Ether() / IP() / UDP() / Raw("xxxxx"), + Ether() / IP() / TCP() / Raw("xxxxx"), + Ether() / IPv6(src="::1") / UDP() / Raw("xxxxx"), + Ether() / IPv6(src="::1") / TCP() / Raw("xxxxx"), + ] + with TestPmdShell(node=self.sut_node, enable_rx_cksum=True) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.csum) + testpmd.set_verbose(level=1) + testpmd.start() + self.send_packet_and_verify(packet_list=packet_list, load="xxxxx", should_receive=True) + for i in range(0, len(packet_list)): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=True, goodIP=True, testpmd=testpmd + ) + + def test_validate_rx_checksum(self) -> None: + """Verify verbose output of Rx packets matches expected behavior.""" + packet_list = [ + Ether() / IP() / UDP(), + Ether() / IP() / TCP(), + Ether() / IPv6(src="::1") / UDP(), + Ether() / IPv6(src="::1") / TCP(), + Ether() / IP(chksum=0x0) / UDP(chksum=0xF), + Ether() / IP(chksum=0x0) / TCP(chksum=0xF), + Ether() / IPv6(src="::1") / UDP(chksum=0xF), + Ether() / IPv6(src="::1") / TCP(chksum=0xF), + ] + with TestPmdShell(node=self.sut_node, enable_rx_cksum=True) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.csum) + testpmd.set_verbose(level=1) + self.setup_hw_offload(testpmd=testpmd) + for i in range(0, 4): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=True, goodIP=True, testpmd=testpmd + ) + for i in range(4, 6): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=False, goodIP=False, testpmd=testpmd + ) + for i in range(6, 8): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=False, goodIP=True, testpmd=testpmd + ) + + def test_l4_rx_checksum(self) -> None: + """Tests L4 Rx checksum in a variety of scenarios.""" + packet_list = [ + Ether() / IP() / UDP(), + Ether() / IP() / TCP(), + Ether() / IP() / UDP(chksum=0xF), + Ether() / IP() / TCP(chksum=0xF), + ] + with TestPmdShell(node=self.sut_node, enable_rx_cksum=True) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.csum) + testpmd.set_verbose(level=1) + self.setup_hw_offload(testpmd=testpmd) + for i in range(0, 2): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=True, goodIP=True, testpmd=testpmd + ) + for i in range(2, 4): + # Originally had False for goodIP in the test plan, but that doesn't logically make sense + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=False, goodIP=True, testpmd=testpmd + ) + + def test_l3_rx_checksum(self) -> None: + """Tests L3 Rx checksum hardware offload.""" + packet_list = [ + Ether() / IP() / UDP(), + Ether() / IP() / TCP(), + Ether() / IP(chksum=0xF) / UDP(), + Ether() / IP(chksum=0xF) / TCP(), + ] + with TestPmdShell(node=self.sut_node, enable_rx_cksum=True) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.csum) + testpmd.set_verbose(level=1) + self.setup_hw_offload(testpmd=testpmd) + for i in range(0, 2): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=True, goodIP=True, testpmd=testpmd + ) + for i in range(2, 4): + # Originally had False for goodL4 in the test plan, but that doesn't logically make sense + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=True, goodIP=False, testpmd=testpmd + ) + + def test_l4_tx_checksum(self) -> None: + """Tests L4 Tx checksum in a variety of scenarios.""" + packet_list = [ + Ether() / IP() / UDP(chksum=0xB161), + Ether() / IP() / UDP(chksum=0xF), + Ether() / IP() / TCP(chksum=0x4904), + Ether() / IP() / TCP(chksum=0xF), + Ether() / IPv6() / UDP(chksum=0xAF62), + Ether() / IPv6() / UDP(chksum=0xF), + Ether() / IPv6() / TCP(chksum=0x4705), + Ether() / IPv6() / TCP(chksum=0xF), + Ether() / IP() / UDP() / VXLAN() / Ether() / IP() / UDP(chksum=0x9949), + Ether() / IP() / UDP() / VXLAN() / Ether() / IP() / UDP(chksum=0xF), + Ether() / IP() / UDP(chksum=0xF) / VXLAN() / Ether() / IP() / UDP(), + Ether() / IP() / UDP(chksum=0xF) / VXLAN() / Ether() / IP() / UDP(chksum=0xF), + Ether() / IP() / UDP() / VXLAN() / Ether() / IP() / TCP(chksum=0x30EC), + Ether() / IP() / UDP() / VXLAN() / Ether() / IP() / TCP(chksum=0xF), + Ether() / IP() / UDP(chksum=0xF) / VXLAN() / Ether() / IP() / TCP(), + Ether() / IP() / UDP(chksum=0xF) / VXLAN() / Ether() / IP() / TCP(chksum=0xF), + Ether() / IPv6() / UDP() / VXLAN() / Ether() / IPv6() / UDP(chksum=0x9949), + Ether() / IPv6() / UDP() / VXLAN() / Ether() / IPv6() / UDP(chksum=0xF), + Ether() / IPv6() / UDP(chksum=0xF) / VXLAN() / Ether() / IPv6() / UDP(), + Ether() / IPv6() / UDP(chksum=0xF) / VXLAN() / Ether() / IPv6() / UDP(chksum=0xF), + Ether() / IPv6() / UDP() / VXLAN() / Ether() / IPv6() / TCP(chksum=0x30EC), + Ether() / IPv6() / UDP() / VXLAN() / Ether() / IPv6() / TCP(chksum=0xF), + Ether() / IPv6() / UDP(chksum=0xF) / VXLAN() / Ether() / IPv6() / TCP(), + Ether() / IPv6() / UDP(chksum=0xF) / VXLAN() / Ether() / IPv6() / TCP(chksum=0xF), + Ether() / IP() / GRE() / IP() / UDP(chksum=0x8131), + Ether() / IP() / GRE() / IP() / UDP(chksum=0xF), + Ether() / IP() / GRE() / IP() / TCP(chksum=0x18D4), + Ether() / IP() / GRE() / IP() / TCP(chksum=0xF), + Ether() / IPv6() / GRE() / IPv6() / UDP(chksum=0x8131), + Ether() / IPv6() / GRE() / IPv6() / UDP(chksum=0xF), + Ether() / IPv6() / GRE() / IPv6() / TCP(chksum=0x18D4), + Ether() / IPv6() / GRE() / IPv6() / TCP(chksum=0xF), + ] + """This test case is based on verifying Tx checksum flags in the testpmd verbose + output, but these flags seem to vary depending on the type of NIC being used.""" + + def test_l3_tx_checksum(self) -> None: + """Tests L3 Tx checksum hardware offload.""" + packet_list = [Ether() / IP(chksum=0x7CCC) / TCP(), Ether() / IP(chksum=0xF) / TCP()] + """Another test based on verifying Tx checksum flags in verbose output.""" + + def test_vlan_checksum(self) -> None: + """Tests VLAN Rx checksum hardware offload and verify packet reception.""" + packet_list = [ + Ether() / Dot1Q(vlan=1) / IP(chksum=0x0) / UDP(chksum=0xF) / Raw("xxxxx"), + Ether() / Dot1Q(vlan=1) / IP(chksum=0x0) / TCP(chksum=0xF) / Raw("xxxxx"), + Ether() / Dot1Q(vlan=1) / IPv6(src="::1") / UDP(chksum=0xF) / Raw("xxxxx"), + Ether() / Dot1Q(vlan=1) / IPv6(src="::1") / TCP(chksum=0xF) / Raw("xxxxx"), + ] + with TestPmdShell(node=self.sut_node, enable_rx_cksum=True) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.csum) + testpmd.set_verbose(level=1) + self.setup_hw_offload(testpmd=testpmd) + testpmd.start() + self.send_packet_and_verify(packet_list=packet_list, load="xxxxx", should_receive=True) + for i in range(0, 2): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=False, goodIP=False, testpmd=testpmd + ) + for i in range(2, 4): + self.send_packet_and_verify_checksum( + packet=packet_list[i], goodL4=False, goodIP=True, testpmd=testpmd + )