From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3D376454F3; Tue, 25 Jun 2024 18:27:52 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2F395427CF; Tue, 25 Jun 2024 18:27:40 +0200 (CEST) Received: from mail-vs1-f98.google.com (mail-vs1-f98.google.com [209.85.217.98]) by mails.dpdk.org (Postfix) with ESMTP id AF257427AA for ; Tue, 25 Jun 2024 18:27:34 +0200 (CEST) Received: by mail-vs1-f98.google.com with SMTP id ada2fe7eead31-48f415262f5so1009273137.1 for ; Tue, 25 Jun 2024 09:27:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1719332854; x=1719937654; 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=8i45UZYvYA3XOo4vwi5ywumXnklcBmTyv1uld3jDGnY=; b=FGZYafpnIy7pL1jmel60nqzpvTcwRVCM8DPeHAdspqKzJ6YcTzg+A5yL3/nhhXzIne esxbcXmlYgOM4DIaPCqgDFGkPgH3GoQMotvm/i5pDt5jjlwrb4b5+vxGm9Msjkl5WnZi bORpuDuNRgk5z2W0kZlVm2GsVQknmX3xt550s= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719332854; x=1719937654; 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=8i45UZYvYA3XOo4vwi5ywumXnklcBmTyv1uld3jDGnY=; b=LBzTOLVczs01/qOa9eujTNxXq4H+D5/AecQYZl8sCBwqUq5BVzwqm/iMsAFOHnGjKq dfct7Bf6yAVv0fMJumObQf9AgaEj/QgLcHkKmyM21gIdu5rNtqSZ+d111tyoxhoB8ohM ga6IMAvDACgztHoWmf3173L7x6hLZe5FOwYwuouC34h4V4Tn+UDNptohYA9KEla1Sclz +a6szFX+fWW81zfft/DoPtOcNk2koxjmGJQ47rJXaQ/kEpQVQP3o8Ii1T09EuJazSEeC bO7tVGBQS0TZtxuNho6+ttXc/xigKPjeuqFNYHmDyk9yXdwBZcefLrqiJ4B/fgS4KqLX tSnQ== X-Gm-Message-State: AOJu0YxxAvBT6Vx102Er0rhuDg7xww2GUseJAacoJWd195zSrkDPstNq v7ovmUOB8gVjtGrz6wCSu8SbyVOsRjJR1tVhFP7rj4CJDIXWDlPPOeM+Bq36y+7UKFf75YMyJtH Gu6KR+D5HlDsHaHZQZDjgcypxAutcqXqiQJYosa2MBKUCVSUC X-Google-Smtp-Source: AGHT+IFF31XhgUzFjBHA1sG5tJyvFgnC1PIvmu1pRzq9z6lRSzrprjZ9qaxxnx6cN9J1iFrxGmX00eytCsYj X-Received: by 2002:a05:6102:5c7:b0:48c:4025:755e with SMTP id ada2fe7eead31-48f4f1c352emr7315712137.30.1719332854083; Tue, 25 Jun 2024 09:27:34 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [2606:4100:3880:1234::84]) by smtp-relay.gmail.com with ESMTPS id a1e0cc1a2514c-80f72916463sm326250241.17.2024.06.25.09.27.33 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 25 Jun 2024 09:27:34 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1257::1083]) by postal.iol.unh.edu (Postfix) with ESMTP id 3C722605C382; Tue, 25 Jun 2024 12:27:32 -0400 (EDT) From: jspewock@iol.unh.edu To: Luca.Vizzarro@arm.com, Honnappa.Nagarahalli@arm.com, juraj.linkes@pantheon.tech, probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com, wathsala.vithanage@arm.com, npratte@iol.unh.edu, thomas@monjalon.net Cc: dev@dpdk.org, Jeremy Spewock Subject: [PATCH v5 3/4] dts: add methods for modifying MTU to testpmd shell Date: Tue, 25 Jun 2024 12:27:15 -0400 Message-ID: <20240625162716.2053-4-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240625162716.2053-1-jspewock@iol.unh.edu> References: <20240514201436.2496-1-jspewock@iol.unh.edu> <20240625162716.2053-1-jspewock@iol.unh.edu> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 From: Jeremy Spewock There are methods within DTS currently that support updating the MTU of ports on a node, but the methods for doing this in a linux session rely on the ip command and the port being bound to the kernel driver. Since test suites are run while bound to the driver for DPDK, there needs to be a way to modify the value while bound to said driver as well. This is done by using testpmd to modify the MTU. Signed-off-by: Jeremy Spewock --- dts/framework/remote_session/testpmd_shell.py | 97 ++++++++++++++++++- 1 file changed, 95 insertions(+), 2 deletions(-) diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py index 805bb3a77d..703f3cbeff 100644 --- a/dts/framework/remote_session/testpmd_shell.py +++ b/dts/framework/remote_session/testpmd_shell.py @@ -20,7 +20,7 @@ from enum import Enum, auto from functools import partial from pathlib import PurePath -from typing import Callable, ClassVar +from typing import Any, Callable, ClassVar from framework.exception import InteractiveCommandExecutionError from framework.settings import SETTINGS @@ -82,12 +82,48 @@ class TestPmdForwardingModes(StrEnum): recycle_mbufs = auto() +def stop_then_start_port( + func: Callable[["TestPmdShell", int, Any], None], verify: bool = True +) -> Callable[["TestPmdShell", int, Any], None]: + """Decorator that stops a port, runs decorated function, then starts the port. + + The function being decorated must be a method defined in :class:`TestPmdShell` that takes a + port ID (as an int) as its first parameter. The port ID will be passed into + :meth:`~TestPmdShell._stop_port` and :meth:`~TestPmdShell._start_port` so that the correct port + is stopped/started. + + Args: + func: The function to run while the port is stopped. The first parameter of `func` must be + a port ID given as an int. + verify: Whether to verify the stopping and starting of the port. + + Returns: + Function that stops a port, runs the decorated function, then starts the port. + """ + + def wrapper(shell: "TestPmdShell", port_id: int, *args, **kwargs) -> None: + """Function that wraps the instance method of :class:`TestPmdShell`. + + Args: + shell: Instance of the shell containing the method to decorate. + port_id: ID of the port to stop/start. + """ + shell._stop_port(port_id, verify) + func(shell, port_id, *args, **kwargs) + shell._start_port(port_id, verify) + + return wrapper + + class TestPmdShell(SingleActiveInteractiveShell): """Testpmd interactive shell. The testpmd shell users should never use the :meth:`~.interactive_shell.InteractiveShell.send_command` method directly, but rather - call specialized methods. If there isn't one that satisfies a need, it should be added. + call specialized methods. If there isn't one that satisfies a need, it should be added. Methods + of this class can be optionally decorated by :func:`~stop_then_start_port` if their first + parameter is the ID of a port in testpmd. This decorator will stop the port before running the + method and then start it again once the method is finished. Attributes: number_of_ports: The number of ports which were allowed on the command-line when testpmd @@ -227,6 +263,63 @@ def set_forward_mode(self, mode: TestPmdForwardingModes, verify: bool = True): f"Test pmd failed to set fwd mode to {mode.value}" ) + def _stop_port(self, port_id: int, verify: bool = True) -> None: + """Stop port with `port_id` in testpmd. + + Depending on the PMD, the port may need to be stopped before configuration can take place. + This method wraps the command needed to properly stop ports and take their link down. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the port did not + successfully stop. + """ + stop_port_output = self.send_command(f"port stop {port_id}") + if verify and ("Done" not in stop_port_output): + self._logger.debug(f"Failed to stop port {port_id}. Output was:\n{stop_port_output}") + raise InteractiveCommandExecutionError(f"Test pmd failed to stop port {port_id}.") + + def _start_port(self, port_id: int, verify: bool = True) -> None: + """Start port with `port_id` in testpmd. + + Because the port may need to be stopped to make some configuration changes, it naturally + follows that it will need to be started again once those changes have been made. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the port did not come + back up. + """ + start_port_output = self.send_command(f"port start {port_id}") + if verify and ("Done" not in start_port_output): + self._logger.debug(f"Failed to start port {port_id}. Output was:\n{start_port_output}") + raise InteractiveCommandExecutionError(f"Test pmd failed to start port {port_id}.") + + @stop_then_start_port + def set_port_mtu(self, port_id: int, mtu: int, verify: bool = True) -> None: + """Change the MTU of a port using testpmd. + + Some PMDs require that the port be stopped before changing the MTU, and it does no harm to + stop the port before configuring in cases where it isn't required, so we first stop ports, + then update the MTU, then start the ports again afterwards. + + Args: + port_id: ID of the port to adjust the MTU on. + mtu: Desired value for the MTU to be set to. + verify: If `verify` is :data:`True` then the output will be scanned in an attempt to + verify that the mtu was properly set on the port. Defaults to :data:`True`. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the MTU was not + properly updated on the port matching `port_id`. + """ + set_mtu_output = self.send_command(f"port config mtu {port_id} {mtu}") + if verify and (f"MTU: {mtu}" not in self.send_command(f"show port info {port_id}")): + self._logger.debug( + f"Failed to set mtu to {mtu} on port {port_id}." f" Output was:\n{set_mtu_output}" + ) + raise InteractiveCommandExecutionError( + f"Test pmd failed to update mtu of port {port_id} to {mtu}" + ) + def _close(self) -> None: """Overrides :meth:`~.interactive_shell.close`.""" self.stop() -- 2.45.2