From: Jeremy Spewock <jspew...@iol.unh.edu>
Added a method within the testpmd interactive shell that polls the
status of ports and verifies that the link status on a given port is
"up." Polling will continue until either the link comes up, or the
timeout is reached. Also added methods for starting and stopping packet
forwarding in testpmd and a method for setting the forwarding mode on
testpmd. The method for starting packet forwarding will also attempt to
verify that forwarding did indeed start by default.
Signed-off-by: Jeremy Spewock <jspew...@iol.unh.edu>
---
dts/framework/exception.py | 4 +
.../remote_session/remote/testpmd_shell.py | 92 +++++++++++++++++++
2 files changed, 96 insertions(+)
diff --git a/dts/framework/exception.py b/dts/framework/exception.py
index b362e42924..e36db20e32 100644
--- a/dts/framework/exception.py
+++ b/dts/framework/exception.py
@@ -119,6 +119,10 @@ def __str__(self) -> str:
return f"Command {self.command} returned a non-zero exit code:
{self.command_return_code}"
+class InteractiveCommandExecutionError(DTSError):
+ severity: ClassVar[ErrorSeverity] = ErrorSeverity.REMOTE_CMD_EXEC_ERR
+
+
class RemoteDirectoryExistsError(DTSError):
"""
Raised when a remote directory to be created already exists.
diff --git a/dts/framework/remote_session/remote/testpmd_shell.py
b/dts/framework/remote_session/remote/testpmd_shell.py
index 08ac311016..b5e4cba9b3 100644
--- a/dts/framework/remote_session/remote/testpmd_shell.py
+++ b/dts/framework/remote_session/remote/testpmd_shell.py
@@ -1,9 +1,15 @@
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2023 University of New Hampshire
+import time
+from enum import auto
from pathlib import PurePath
from typing import Callable
+from framework.exception import InteractiveCommandExecutionError
+from framework.settings import SETTINGS
+from framework.utils import StrEnum
+
from .interactive_shell import InteractiveShell
@@ -17,6 +23,37 @@ def __str__(self) -> str:
return self.pci_address
+class TestPmdForwardingModes(StrEnum):
+ r"""The supported packet forwarding modes for :class:`~TestPmdShell`\s"""
+
+ #:
+ io = auto()
+ #:
+ mac = auto()
+ #:
+ macswap = auto()
+ #:
+ flowgen = auto()
+ #:
+ rxonly = auto()
+ #:
+ txonly = auto()
+ #:
+ csum = auto()
+ #:
+ icmpecho = auto()
+ #:
+ ieee1588 = auto()
+ #:
+ noisy = auto()
+ #:
+ fivetswap = "5tswap"
+ #:
+ shared_rxq = "shared-rxq"
+ #:
+ recycle_mbufs = auto()
+
+
class TestPmdShell(InteractiveShell):
path: PurePath = PurePath("app", "dpdk-testpmd")
dpdk_app: bool = True
@@ -28,6 +65,27 @@ def _start_application(self, get_privileged_command:
Callable[[str], str] | None
self._app_args += " -- -i"
super()._start_application(get_privileged_command)
+ def start(self, verify: bool = True) -> None:
+ """Start packet forwarding with the current configuration.
+
+ Args:
+ verify: If :data:`True` , a second start command will be sent in
an attempt to verify
+ packet forwarding started as expected.
+
+ Raises:
+ InteractiveCommandExecutionError: If `verify` is :data:`True` and
forwarding fails to
+ start.
+ """
+ self.send_command("start")
+ if verify:
+ # If forwarding was already started, sending "start" again should
tell us
+ if "Packet forwarding already started" not in
self.send_command("start"):
+ raise InteractiveCommandExecutionError("Testpmd failed to
start packet forwarding.")
+
+ def stop(self) -> None:
+ """Stop packet forwarding."""
+ self.send_command("stop")
+
def get_devices(self) -> list[TestPmdDevice]:
"""Get a list of device names that are known to testpmd
@@ -43,3 +101,37 @@ def get_devices(self) -> list[TestPmdDevice]:
if "device name:" in line.lower():
dev_list.append(TestPmdDevice(line))
return dev_list
+
+ def wait_link_status_up(self, port_id: int, timeout=SETTINGS.timeout) ->
bool:
+ """Wait until the link status on the given port is "up".
+
+ Arguments:
+ port_id: Port to check the link status on.
+ timeout: Time to wait for the link to come up. The default value
for this
+ argument is set using the :option:`-t, --timeout` command-line
argument
+ or the :envvar:`DTS_TIMEOUT` environment variable.
+
+ Returns:
+ If the link came up in time or not.
+ """
+ time_to_stop = time.time() + timeout
+ while time.time() < time_to_stop:
+ port_info = self.send_command(f"show port info {port_id}")
+ if "Link status: up" in port_info:
+ break
+ time.sleep(0.5)
+ else:
+ self._logger.error(f"The link for port {port_id} did not come up
in the given timeout.")
+ return "Link status: up" in port_info
+
+ def set_forward_mode(self, mode: TestPmdForwardingModes):
+ """Set packet forwarding mode.
+
+ Args:
+ mode: The forwarding mode to use.
+ """
+ self.send_command(f"set fwd {mode.value}")
+
+ def close(self) -> None:
+ self.send_command("exit", "")
+ return super().close()
--
2.43.0
