test suite for verifying layer 3/4 checksum offload
features on poll mode driver.
Signed-off-by: Dean Marx <dm...@iol.unh.edu>
---
dts/framework/config/conf_yaml_schema.json | 3 +-
dts/tests/TestSuite_checksum_offload.py | 274 +++++++++++++++++++++
2 files changed, 276 insertions(+), 1 deletion(-)
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 df390e8ae2..99ae7afe9b 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/tests/TestSuite_checksum_offload.py
b/dts/tests/TestSuite_checksum_offload.py
new file mode 100644
index 0000000000..f9aea1655e
--- /dev/null
+++ b/dts/tests/TestSuite_checksum_offload.py
@@ -0,0 +1,274 @@
+# 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.layers.inet import IP, TCP, UDP # type: ignore[import-untyped]
+from scapy.layers.inet6 import IPv6 # type: ignore[import-untyped]
+from scapy.layers.l2 import Dot1Q, Ether # type: ignore[import-untyped]
+from scapy.layers.sctp import SCTP # type: ignore[import-untyped]
+from scapy.packet import Packet, Raw # type: ignore[import-untyped]
+
+from framework.params.testpmd import SimpleForwardingModes
+from framework.remote_session.testpmd_shell import (
+ ChecksumOffloadOptions,
+ PacketOffloadFlag,
+ TestPmdShell,
+)
+from framework.test_suite import TestSuite, func_test
+from framework.testbed_model.capability import NicCapability, TopologyType,
requires
+
+
+@requires(topology_type=TopologyType.two_links)
+@requires(NicCapability.RX_OFFLOAD_CHECKSUM)
+@requires(NicCapability.RX_OFFLOAD_IPV4_CKSUM)
+@requires(NicCapability.RX_OFFLOAD_UDP_CKSUM)
+@requires(NicCapability.RX_OFFLOAD_TCP_CKSUM)
+class TestChecksumOffload(TestSuite):
+ """Checksum offload test suite.
+
+ This suite consists of 6 test cases:
+ 1. Insert checksum on transmit packet
+ 2. Do not insert checksum on transmit packet
+ 3. Hardware checksum check L4 Rx
+ 4. Hardware checksum check L3 Rx
+ 5. Validate Rx checksum valid flags
+ 6. Checksum offload with vlan
+
+ """
+
+ def send_packets_and_verify(
+ self, packet_list: List[Packet], load: str, should_receive: bool
+ ) -> None:
+ """Iterates through a list of packets and verifies they are received.
+
+ Args:
+ packet_list: List of Scapy packets 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, id: str
+ ) -> 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_UNKNOWN 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_UNKNOWN if
:data:`False`.
+ testpmd: Testpmd shell session to analyze verbose output of.
+ id: The destination mac address that matches the sent packet in
verbose output.
+ """
+ testpmd.start()
+ self.send_packet_and_capture(packet=packet)
+ verbose_output = testpmd.extract_verbose_output(testpmd.stop())
+ for packet in verbose_output:
+ if packet.dst_mac == id:
+ isIP = PacketOffloadFlag.RTE_MBUF_F_RX_IP_CKSUM_GOOD in
packet.ol_flags
+ isL4 = PacketOffloadFlag.RTE_MBUF_F_RX_L4_CKSUM_GOOD in
packet.ol_flags
+ 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, and TCP layers to hardware offload.
+
+ Args:
+ testpmd: Testpmd shell to configure.
+ """
+ testpmd.stop_all_ports()
+ offloads = (
+ ChecksumOffloadOptions.ip | ChecksumOffloadOptions.udp |
ChecksumOffloadOptions.tcp
+ )
+ testpmd.csum_set_hw(layers=offloads, port_id=0)
+ testpmd.start_all_ports()
+
+ @func_test
+ def test_insert_checksums(self) -> None:
+ """Enable checksum offload insertion and verify packet reception."""
+ mac_id = "00:00:00:00:00:01"
+ payload = "xxxxx"
+ packet_list = [
+ Ether(dst=mac_id) / IP() / UDP() / Raw(payload),
+ Ether(dst=mac_id) / IP() / TCP() / Raw(payload),
+ Ether(dst=mac_id) / IPv6(src="::1") / UDP() / Raw(payload),
+ Ether(dst=mac_id) / IPv6(src="::1") / TCP() / Raw(payload),
+ ]
+ 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_packets_and_verify(packet_list=packet_list,
load=payload, 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, id=mac_id
+ )
+
+ @func_test
+ def test_no_insert_checksums(self) -> None:
+ """Disable checksum offload insertion and verify packet reception."""
+ mac_id = "00:00:00:00:00:01"
+ payload = "xxxxx"
+ packet_list = [
+ Ether(dst=mac_id) / IP() / UDP() / Raw(payload),
+ Ether(dst=mac_id) / IP() / TCP() / Raw(payload),
+ Ether(dst=mac_id) / IPv6(src="::1") / UDP() / Raw(payload),
+ Ether(dst=mac_id) / IPv6(src="::1") / TCP() / Raw(payload),
+ ]
+ 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_packets_and_verify(packet_list=packet_list,
load=payload, 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, id=mac_id
+ )
+
+ @func_test
+ def test_l4_rx_checksum(self) -> None:
+ """Tests L4 Rx checksum in a variety of scenarios."""
+ mac_id = "00:00:00:00:00:01"
+ packet_list = [
+ Ether(dst=mac_id) / IP() / UDP(),
+ Ether(dst=mac_id) / IP() / TCP(),
+ Ether(dst=mac_id) / IP() / UDP(chksum=0xF),
+ Ether(dst=mac_id) / 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, id=mac_id
+ )
+ for i in range(2, 4):
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[i], goodL4=False, goodIP=True,
testpmd=testpmd, id=mac_id
+ )
+
+ @func_test
+ def test_l3_rx_checksum(self) -> None:
+ """Tests L3 Rx checksum hardware offload."""
+ mac_id = "00:00:00:00:00:01"
+ packet_list = [
+ Ether(dst=mac_id) / IP() / UDP(),
+ Ether(dst=mac_id) / IP() / TCP(),
+ Ether(dst=mac_id) / IP(chksum=0xF) / UDP(),
+ Ether(dst=mac_id) / 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, id=mac_id
+ )
+ for i in range(2, 4):
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[i], goodL4=True, goodIP=False,
testpmd=testpmd, id=mac_id
+ )
+
+ @func_test
+ def test_validate_rx_checksum(self) -> None:
+ """Verify verbose output of Rx packets matches expected behavior."""
+ mac_id = "00:00:00:00:00:01"
+ packet_list = [
+ Ether(dst=mac_id) / IP() / UDP(),
+ Ether(dst=mac_id) / IP() / TCP(),
+ Ether(dst=mac_id) / IPv6(src="::1") / UDP(),
+ Ether(dst=mac_id) / IPv6(src="::1") / TCP(),
+ Ether(dst=mac_id) / IP(chksum=0x0) / UDP(chksum=0xF),
+ Ether(dst=mac_id) / IP(chksum=0x0) / TCP(chksum=0xF),
+ Ether(dst=mac_id) / IPv6(src="::1") / UDP(chksum=0xF),
+ Ether(dst=mac_id) / 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, id=mac_id
+ )
+ for i in range(4, 6):
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[i], goodL4=False, goodIP=False,
testpmd=testpmd, id=mac_id
+ )
+ for i in range(6, 8):
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[i], goodL4=False, goodIP=True,
testpmd=testpmd, id=mac_id
+ )
+
+ @requires(NicCapability.RX_OFFLOAD_VLAN)
+ @func_test
+ def test_vlan_checksum(self) -> None:
+ """Test VLAN Rx checksum hardware offload and verify packet
reception."""
+ mac_id = "00:00:00:00:00:01"
+ payload = "xxxxx"
+ packet_list = [
+ Ether(dst=mac_id) / Dot1Q(vlan=1) / IP(chksum=0x0) /
UDP(chksum=0xF) / Raw(payload),
+ Ether(dst=mac_id) / Dot1Q(vlan=1) / IP(chksum=0x0) /
TCP(chksum=0xF) / Raw(payload),
+ Ether(dst=mac_id) / Dot1Q(vlan=1) / IPv6(src="::1") /
UDP(chksum=0xF) / Raw(payload),
+ Ether(dst=mac_id) / Dot1Q(vlan=1) / IPv6(src="::1") /
TCP(chksum=0xF) / Raw(payload),
+ ]
+ 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_packets_and_verify(packet_list=packet_list,
load=payload, 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, id=mac_id
+ )
+ for i in range(2, 4):
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[i], goodL4=False, goodIP=True,
testpmd=testpmd, id=mac_id
+ )
+
+ @requires(NicCapability.RX_OFFLOAD_SCTP_CKSUM)
+ @func_test
+ def test_validate_sctp_checksum(self) -> None:
+ """Test SCTP Rx checksum hardware offload and verify packet
reception."""
+ mac_id = "00:00:00:00:00:01"
+ packet_list = [
+ Ether(dst=mac_id) / IP() / SCTP(),
+ Ether(dst=mac_id) / IP() / SCTP(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)
+ testpmd.csum_set_hw(layers=ChecksumOffloadOptions.sctp)
+ testpmd.start()
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[0], goodL4=True, goodIP=True,
testpmd=testpmd, id=mac_id
+ )
+ self.send_packet_and_verify_checksum(
+ packet=packet_list[1], goodL4=False, goodIP=True,
testpmd=testpmd, id=mac_id
+ )
--
2.44.0
