[PATCH v13] dts: port over queue start/stop suite

[Dean Marx <dmarx@iol.unh.edu>]

This suite tests the ability of the Poll Mode Driver
to enable and disable Rx/Tx queues on a port.
The verify argument in the deferred start method has been excluded
due to a bug in testpmd, which renders checking port queue info
for deferred start status impossible within a single method.

Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
Reviewed-by: Jeremy Spewock <jspewock@iol.unh.edu>
---
 dts/framework/remote_session/testpmd_shell.py |  18 +++
 dts/tests/TestSuite_queue_start_stop.py       | 141 ++++++++++++++++++
 2 files changed, 159 insertions(+)
 create mode 100644 dts/tests/TestSuite_queue_start_stop.py

diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py
index d187eaea94..3c5372614b 100644
--- a/dts/framework/remote_session/testpmd_shell.py
+++ b/dts/framework/remote_session/testpmd_shell.py
@@ -2242,6 +2242,24 @@ def set_queue_ring_size(
                     f"Failed to update ring size of queue {queue_id} on port {port_id}"
                 )
 
+    @requires_stopped_ports
+    def set_queue_deferred_start(
+        self, port_id: int, queue_id: int, is_rx_queue: bool, on: bool
+    ) -> None:
+        """Set the deferred start attribute of the specified queue on/off.
+
+        Args:
+            port_id: The port that the queue resides on.
+            queue_id: The ID of the queue on the port.
+            is_rx_queue: Whether to modify an RX or TX queue. If :data:`True` an RX queue will be
+                updated, otherwise a TX queue will be updated.
+            on: Whether to set deferred start mode on or off. If :data:`True` deferred start will
+                be turned on, otherwise it will be turned off.
+        """
+        queue_type = "rxq" if is_rx_queue else "txq"
+        action = "on" if on else "off"
+        self.send_command(f"port {port_id} {queue_type} {queue_id} deferred_start {action}")
+
     def _update_capabilities_from_flag(
         self,
         supported_capabilities: MutableSet["NicCapability"],
diff --git a/dts/tests/TestSuite_queue_start_stop.py b/dts/tests/TestSuite_queue_start_stop.py
new file mode 100644
index 0000000000..c391edfc87
--- /dev/null
+++ b/dts/tests/TestSuite_queue_start_stop.py
@@ -0,0 +1,141 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2024 University of New Hampshire
+
+"""Rx/Tx queue start and stop functionality suite.
+
+This suite tests the ability of the poll mode driver to start and
+stop either the Rx or Tx queue (depending on the port) during runtime,
+and verify that packets are not received when one is disabled.
+
+Given a paired port topology, the Rx queue will be disabled on port 0,
+and the Tx queue will be disabled on port 1.
+
+"""
+
+from scapy.layers.inet import IP  # type: ignore[import-untyped]
+from scapy.layers.l2 import Ether  # type: ignore[import-untyped]
+from scapy.packet import Raw  # type: ignore[import-untyped]
+
+from framework.remote_session.testpmd_shell import SimpleForwardingModes, 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.RUNTIME_RX_QUEUE_SETUP)
+@requires(NicCapability.RUNTIME_TX_QUEUE_SETUP)
+class TestQueueStartStop(TestSuite):
+    """DPDK Queue start/stop test suite.
+
+    Ensures Rx/Tx queue on a port can be disabled and enabled.
+    Verifies packets are not received when either queue is disabled.
+    The suite contains four test cases, two Rx queue start/stop and
+    two Tx queue start/stop, which each disable the corresponding
+    queue and verify that packets are not received/forwarded. There
+    are two cases that verify deferred start mode produces the expected
+    behavior in both the Rx and Tx queue.
+    """
+
+    def send_packet_and_verify(self, should_receive: bool = True) -> None:
+        """Generate a packet, send to the DUT, and verify it is forwarded back.
+
+        Args:
+            should_receive: Indicate whether the packet should be received.
+        """
+        packet = Ether() / IP() / Raw(load="xxxxx")
+        received = self.send_packet_and_capture(packet)
+        contains_packet = any(
+            packet.haslayer(Raw) and b"xxxxx" in packet.load for packet in received
+        )
+        self.verify(
+            should_receive == contains_packet,
+            f"Packet was {'dropped' if should_receive else 'received'}",
+        )
+
+    @func_test
+    def test_rx_queue_start_stop(self) -> None:
+        """Rx queue start stop test.
+
+        Steps:
+            Launch testpmd, stop Rx queue 0 on port 0.
+        Verify:
+            Send a packet on port 0, ensure it is not received.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd.set_forward_mode(SimpleForwardingModes.mac)
+            testpmd.stop_port_queue(0, 0, True)
+            testpmd.start()
+            self.send_packet_and_verify(should_receive=False)
+            stats = testpmd.show_port_stats(port_id=0)
+            self.verify(
+                stats.rx_packets == 0,
+                "Packets were received on Rx queue when it should've been disabled",
+            )
+
+    @func_test
+    def test_tx_queue_start_stop(self) -> None:
+        """Tx queue start stop test.
+
+        Steps:
+            Launch testpmd, stop Tx queue 0 on port 0.
+        Verify:
+            Send a packet on port 0, ensure it is not forwarded.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd.set_forward_mode(SimpleForwardingModes.mac)
+            testpmd.stop_port_queue(1, 0, False)
+            testpmd.start()
+            self.send_packet_and_verify(should_receive=False)
+            stats = testpmd.show_port_stats(port_id=1)
+            self.verify(
+                stats.tx_packets == 0,
+                "Packets were forwarded on Tx queue when it should've been disabled",
+            )
+
+    @func_test
+    def test_rx_queue_deferred_start(self) -> None:
+        """Rx queue deferred start stop test.
+
+        Steps:
+            Launch testpmd, enable deferred start on Rx queue 0 port 0.
+            Stop Rx queue 0 on port 0.
+        Verify:
+            Send a packet on port 0, ensure it is not received.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd.set_forward_mode(SimpleForwardingModes.mac)
+            testpmd.stop_all_ports()
+            testpmd.set_queue_deferred_start(0, 0, True, True)
+            testpmd.start_all_ports()
+            testpmd.stop_port_queue(0, 0, True)
+            testpmd.start()
+            self.send_packet_and_verify(should_receive=False)
+            stats = testpmd.show_port_stats(port_id=0)
+            self.verify(
+                stats.rx_packets == 0,
+                "Packets were received on Rx queue while deferred start was enabled",
+            )
+
+    @func_test
+    def test_tx_queue_deferred_start(self) -> None:
+        """Tx queue start stop test.
+
+        Steps:
+            Launch testpmd, enable deferred start on Tx queue 0 port 0.
+            Stop Tx queue 0 on port 0.
+        Verify:
+            Send a packet on port 0, ensure it is not forwarded.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd.set_forward_mode(SimpleForwardingModes.mac)
+            testpmd.stop_all_ports()
+            testpmd.set_queue_deferred_start(0, 0, False, True)
+            testpmd.start_all_ports()
+            testpmd.stop_port_queue(1, 0, False)
+            testpmd.start()
+            self.send_packet_and_verify(should_receive=False)
+            stats = testpmd.show_port_stats(port_id=1)
+            self.verify(
+                stats.tx_packets == 0,
+                "Packets were forwarded on Tx queue while deferred start was enabled",
+            )
-- 
2.44.0