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 82A4C45600; Thu, 11 Jul 2024 18:34:52 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E04D542EE2; Thu, 11 Jul 2024 18:34:45 +0200 (CEST) Received: from mail-io1-f104.google.com (mail-io1-f104.google.com [209.85.166.104]) by mails.dpdk.org (Postfix) with ESMTP id EC5E442EB1 for ; Thu, 11 Jul 2024 18:34:44 +0200 (CEST) Received: by mail-io1-f104.google.com with SMTP id ca18e2360f4ac-8036ce66134so46437739f.3 for ; Thu, 11 Jul 2024 09:34:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1720715684; x=1721320484; 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=mkGbyFiVUtD42quablB23uOO+8YEj9Wp8Y5n3cVtUvg=; b=BrVw9MRTMnzeRHdcydwdq8pkz/0eFccqmzkfnDWiVWwPBH+oxJQnbdbneOcbl199S4 pXOEheEtcPCrbjHhrSDwS3MW1sPZMWBeinx6ZICRzapbkp6ovP+d+TEA9nw8jT7KfcMr 5UZr/u7FghW1ct+ZJXvr+hYzEma8/5CwuMLrQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720715684; x=1721320484; 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=mkGbyFiVUtD42quablB23uOO+8YEj9Wp8Y5n3cVtUvg=; b=gES2K40ogV48qaHosh118sJx8GU41iAlNsPCrFT4gX78ziUFAzjOAqNgzmbeKJPpSP 2Ghme1ndFEwzBO3228j+QCdVvdTA4go20E0tSv4C3qjIYLlSNJ8lshtrhpa4YhsEJPvg W/pT8HoFtrgeZB2QhxfR6cGpJ7FpXc1xQ+HertiPF9ntyDHH0zwH5eNeICTG0b8/7JvU OXEdmRLllyy4g8jkYnGRtYySD2qYL8TYLS1u3y0fvcgPiBjFaCo59ksAHIBjo/twnlz6 0tWkrxV90i1zr0D6O2I7INvEbF3VgX3i5nDpg3DR0tyPrkY1fpCRX0E9mh6YKaeMe8+Q IHLg== X-Gm-Message-State: AOJu0YwGIv12uSy9bvVyiE6UDYo3BWsn/ybrmVqteu6iFwRJ2GPYWEx1 qddfpQBDXseMTbO4kkQfVCn9/IrufCOBB95sT6hIGWmLutPl5YRVYlLD4CxZhyp4a+zccvTCdFC 4UYJZkM7K5eUFwdWMegv0WU6iYN+Up+el3JLWmRs2mpahZ1yv X-Google-Smtp-Source: AGHT+IHbRrr/oSl3RmbJgCzxeRjc04+cA7Ky/tn/S1gKPdtbMy8dh6MEZ86WLg9lELsHopVdRV/AAoSamaTF X-Received: by 2002:a6b:f107:0:b0:803:cc64:e0d4 with SMTP id ca18e2360f4ac-803cc64e3famr716475939f.3.1720715684299; Thu, 11 Jul 2024 09:34:44 -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 ca18e2360f4ac-7ffe921233esm28767239f.12.2024.07.11.09.34.44 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 11 Jul 2024 09:34:44 -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 5C744605C380; Thu, 11 Jul 2024 12:34:43 -0400 (EDT) From: jspewock@iol.unh.edu To: yoan.picchi@foss.arm.com, wathsala.vithanage@arm.com, Honnappa.Nagarahalli@arm.com, npratte@iol.unh.edu, probb@iol.unh.edu, juraj.linkes@pantheon.tech, Luca.Vizzarro@arm.com, paul.szczepanek@arm.com, thomas@monjalon.net Cc: dev@dpdk.org, Jeremy Spewock , Luca Vizzarro Subject: [PATCH v2 2/2] dts: improve starting and stopping interactive shells Date: Thu, 11 Jul 2024 12:34:10 -0400 Message-ID: <20240711163410.89017-3-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240711163410.89017-1-jspewock@iol.unh.edu> References: <20240709163145.110030-1-jspewock@iol.unh.edu> <20240711163410.89017-1-jspewock@iol.unh.edu> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 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 The InteractiveShell class currently relies on being cleaned up and shutdown at the time of garbage collection, but this cleanup of the class does no verification that the session is still running prior to cleanup. So, if a user were to call this method themselves prior to garbage collection, it would be called twice and throw an exception when the desired behavior is to do nothing since the session is already cleaned up. This is solved by using a weakref and a finalize class which achieves the same result of calling the method at garbage collection, but also ensures that it is called exactly once. Additionally, this fixes issues regarding starting a primary DPDK application while another is still cleaning up via a retry when starting interactive shells. It also adds catch for attempting to send a command to an interactive shell that is not running to create a more descriptive error message. Signed-off-by: Jeremy Spewock Reviewed-by: Luca Vizzarro Reviewed-by: Patrick Robb Reviewed-by: Juraj Linkeš --- .../remote_session/interactive_shell.py | 29 ++++++++---- .../single_active_interactive_shell.py | 46 +++++++++++++++++-- dts/framework/remote_session/testpmd_shell.py | 2 +- 3 files changed, 64 insertions(+), 13 deletions(-) diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 11dc8a0643..9ca285b604 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -9,6 +9,9 @@ collection. """ +import weakref +from typing import ClassVar + from .single_active_interactive_shell import SingleActiveInteractiveShell @@ -16,18 +19,26 @@ class InteractiveShell(SingleActiveInteractiveShell): """Adds manual start and stop functionality to interactive shells. Like its super-class, this class should not be instantiated directly and should instead be - extended. This class also provides an option for automated cleanup of the application through - the garbage collector. + extended. This class also provides an option for automated cleanup of the application using a + weakref and a finalize class. This finalize class allows for cleanup of the class at the time + of garbage collection and also ensures that cleanup only happens once. This way if a user + initiates the closing of the shell manually it is not repeated at the time of garbage + collection. """ + _finalizer: weakref.finalize + #: One attempt should be enough for shells which don't have to worry about other instances + #: closing before starting a new one. + _init_attempts: ClassVar[int] = 1 + def start_application(self) -> None: - """Start the application.""" + """Start the application. + + After the application has started, use :class:`weakref.finalize` to manage cleanup. + """ self._start_application() + self._finalizer = weakref.finalize(self, self._close) def close(self) -> None: - """Properly free all resources.""" - self._close() - - def __del__(self) -> None: - """Make sure the session is properly closed before deleting the object.""" - self.close() + """Free all resources using :class:`weakref.finalize`.""" + self._finalizer() diff --git a/dts/framework/remote_session/single_active_interactive_shell.py b/dts/framework/remote_session/single_active_interactive_shell.py index 30c55d4703..38094c0fe2 100644 --- a/dts/framework/remote_session/single_active_interactive_shell.py +++ b/dts/framework/remote_session/single_active_interactive_shell.py @@ -27,6 +27,7 @@ from paramiko import Channel, channel # type: ignore[import-untyped] from typing_extensions import Self +from framework.exception import InteractiveCommandExecutionError from framework.logger import DTSLogger from framework.params import Params from framework.settings import SETTINGS @@ -45,6 +46,10 @@ class SingleActiveInteractiveShell(ABC): Interactive shells are started and stopped using a context manager. This allows for the start and cleanup of the application to happen at predictable times regardless of exceptions or interrupts. + + Attributes: + is_alive: :data:`True` if the application has started successfully, :data:`False` + otherwise. """ _node: Node @@ -57,6 +62,9 @@ class SingleActiveInteractiveShell(ABC): _privileged: bool _real_path: PurePath + #: The number of times to try starting the application before considering it a failure. + _init_attempts: ClassVar[int] = 5 + #: Prompt to expect at the end of output when sending a command. #: This is often overridden by subclasses. _default_prompt: ClassVar[str] = "" @@ -69,6 +77,8 @@ class SingleActiveInteractiveShell(ABC): #: Path to the executable to start the interactive application. path: ClassVar[PurePath] + is_alive: bool = False + def __init__( self, node: Node, @@ -111,11 +121,33 @@ def _make_start_command(self) -> str: def _start_application(self) -> None: """Starts a new interactive application based on the path to the app. - This method is often overridden by subclasses as their process for - starting may look different. + This method is often overridden by subclasses as their process for starting may look + different. Initialization of the shell on the host can be retried up to + `self._init_attempts` - 1 times. This is done because some DPDK applications need slightly + more time after exiting their script to clean up EAL before others can start. + + Raises: + InteractiveCommandExecutionError: If the application fails to start within the allotted + number of retries. """ self._setup_ssh_channel() - self.send_command(self._make_start_command()) + self._ssh_channel.settimeout(5) + start_command = self._make_start_command() + self.is_alive = True + for attempt in range(self._init_attempts): + try: + self.send_command(start_command) + break + except TimeoutError: + self._logger.info( + f"Interactive shell failed to start (attempt {attempt+1} out of " + f"{self._init_attempts})" + ) + else: + self._ssh_channel.settimeout(self._timeout) + self.is_alive = False # update state on failure to start + raise InteractiveCommandExecutionError("Failed to start application.") + self._ssh_channel.settimeout(self._timeout) def send_command( self, command: str, prompt: str | None = None, skip_first_line: bool = False @@ -139,7 +171,15 @@ def send_command( Returns: All output in the buffer before expected string. + + Raises: + InteractiveCommandExecutionError: If attempting to send a command to a shell that is + not currently running. """ + if not self.is_alive: + raise InteractiveCommandExecutionError( + f"Cannot send command {command} to application because the shell is not running." + ) self._logger.info(f"Sending: '{command}'") if prompt is None: prompt = self._default_prompt diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py index f54a745185..eda6eb320f 100644 --- a/dts/framework/remote_session/testpmd_shell.py +++ b/dts/framework/remote_session/testpmd_shell.py @@ -807,5 +807,5 @@ def show_port_stats(self, port_id: int) -> TestPmdPortStats: def _close(self) -> None: """Overrides :meth:`~.interactive_shell.close`.""" self.stop() - self.send_command("quit", "") + self.send_command("quit", "Bye...") return super()._close() -- 2.45.2