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 2132945822; Tue, 20 Aug 2024 15:05:40 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A2B274026C; Tue, 20 Aug 2024 15:05:39 +0200 (CEST) Received: from mail-lf1-f50.google.com (mail-lf1-f50.google.com [209.85.167.50]) by mails.dpdk.org (Postfix) with ESMTP id BCE15400D6 for ; Tue, 20 Aug 2024 15:05:36 +0200 (CEST) Received: by mail-lf1-f50.google.com with SMTP id 2adb3069b0e04-52f01afa11cso6936718e87.0 for ; Tue, 20 Aug 2024 06:05:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1724159136; x=1724763936; darn=dpdk.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=z2R8KBwaO0ChOxNOFpXsn8hHEqsUa+rh0eHA7PdznR8=; b=r0FvEvKRgCLlwRXXywukA5tWcyOuYO6xNUZyeXBL2ih0qUod6x85Y+07PiheoH23vj J5afVQbQLlSqC1ZLLRPRcBpwhWlaP6ifIcsZUV7twMNTux5ZbChGBzCNp8EB3Iw/WHes CdakCGm4mipVEVBftotLRWI6fTQO9BwVBHkMmu/HDpHmNqVL1zHzpHjWBSz+Wb2+azeP llU3vYKy8xHU4c9rrX6/JqrmMPw6KeR/jwgLPJ5LpnFnWGMt7N1uOqHon4aNaxqJ3Dm4 EuKPeGfjHBDV1vo/uL/FhMPUy9hDSZUIaRKOuPO/2j4KbWb67rLkrDYIaN/9//GiSUWH UFFQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724159136; x=1724763936; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=z2R8KBwaO0ChOxNOFpXsn8hHEqsUa+rh0eHA7PdznR8=; b=ZuR27cAJhBBJu3cE7l/4rpzosTMtiqu9ur2hWngCtnrwlsEBcuFmAZ7iDm+/V50y7D 3qabssNh5c9qpMCha8qXm+zcyDNZGX12rRdDofQlrakee+DbLjEpBwUMEqPcxjOYC0uB VxnNG0fF9BBNdWRHafA2l46LyM2+BTeuNWp/UH6YhRG9o44YZj8PzkjLLn9XI8EYRqCW ONHibeqJL6vngKKQsWSVtrYReVWoFpMAmHW+MHcVQhTnk8aHI3fOYKaFheGWQgCFQgPN kxN34Kv+6d3pvrKHIJOQeskc07F/jAaTS0bg8tDqS9Pnn+cuqhGlzotjXTEvfaDenluV kiXw== X-Gm-Message-State: AOJu0YyMk/etCvKDLKwUb3ulitHDGlTpKXJUk4IUfEKjFDegToK8JAOc Ere9kUR01NUlFIsi1tW+EQMR9DKIyuTA/m5RtDdpZlFfOQJTS2Y64XYrs79nALg= X-Google-Smtp-Source: AGHT+IHlhGsUxMpRpJrCm3jiBLQiXbgekDIt2X4WlXa8T+X+fwK0PpEXnppCUyim1Z/bO0sseNfV3A== X-Received: by 2002:a05:6512:1087:b0:52c:cc38:592c with SMTP id 2adb3069b0e04-5331c61ced6mr9641374e87.0.1724159135854; Tue, 20 Aug 2024 06:05:35 -0700 (PDT) Received: from [192.168.200.22] ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a838396d048sm753910966b.204.2024.08.20.06.05.34 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 20 Aug 2024 06:05:35 -0700 (PDT) Message-ID: Date: Tue, 20 Aug 2024 15:05:34 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v7 1/2] dts: add methods for modifying MTU to testpmd shell To: jspewock@iol.unh.edu, thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, yoan.picchi@foss.arm.com, paul.szczepanek@arm.com, probb@iol.unh.edu, Luca.Vizzarro@arm.com, npratte@iol.unh.edu, wathsala.vithanage@arm.com Cc: dev@dpdk.org References: <20240514201436.2496-1-jspewock@iol.unh.edu> <20240709175341.183888-1-jspewock@iol.unh.edu> <20240709175341.183888-2-jspewock@iol.unh.edu> Content-Language: en-US From: =?UTF-8?Q?Juraj_Linke=C5=A1?= In-Reply-To: <20240709175341.183888-2-jspewock@iol.unh.edu> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit 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 I'm trying to use this patch for the capabilities series. It works as I need it to, so we just need to coordinate a bit to use this one patch for both series. > diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py > @@ -82,12 +84,82 @@ class TestPmdForwardingModes(StrEnum): > recycle_mbufs = auto() > > > +T = TypeVarTuple("T") # type: ignore[misc] > + > + > +class stop_then_start_port: Is there a particular reason why this is a class and not a function? We can pass arguments even with a function (in that case we need two inner wrapper functions). In my capabilities patch, I've made a testpmd specific decorator a static method to signify that the decorator is tied to testpmd methods. This made sense to me, but maybe we don't want to do that. > + """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. > + > + Note that, because this decorator is presented through a class to allow for passing arguments > + into the decorator, the class must be initialized when decorating functions. This means that, > + even when not modifying any arguments, the signature for decorating with this class must be > + "@stop_then_start_port()". > + > + Example usage on testpmd methods:: > + > + @stop_then_start_port() > + def ex1(self, port_id, verify=True) > + pass > + > + @stop_then_start_port(verify=False) > + def ex2(self, port_id, verify=True) > + pass > + > + Attributes: > + verify: Whether to verify the stopping and starting of the port. > + """ > + > + verify: bool > + > + def __init__(self, verify: bool = True) -> None: > + """Store decorator options. > + > + Args: > + verify: If :data:`True` the stopping/starting of ports will be verified, otherwise they > + will it won't. Defaults to :data:`True`. > + """ > + self.verify = verify > + > + def __call__( > + self, func: Callable[["TestPmdShell", int, *T], None] # type: ignore[valid-type] > + ) -> Callable[["TestPmdShell", int, *T], None]: # type: ignore[valid-type] > + """Wrap decorated method. > + > + Args: > + func: Decorated method to wrap. > + > + Returns: > + Function that stops a port, runs the decorated method, 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, self.verify) > + func(shell, port_id, *args, **kwargs) > + shell._start_port(port_id, self.verify) Is it possible that the port will be stopped when the decorator is called? In that case, we would start a port that's expected to be stopped at the end. I think we should figure out what the port state is and only start it if it started out as started. > + > + return wrapper > + > + > class TestPmdShell(InteractiveShell): > """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. > This explanation is more from the "this decorator exists and does this" point of view, but I think a more fitting explanation would be how to configure ports using the decorator, something like: "In order to configure ports in TestPmd, the ports (may) need to be stopped" and so on. This would be more of a "this how you implement configuration in this class" explanation. > Attributes: > number_of_ports: The number of ports which were allowed on the command-line when testpmd > @@ -227,6 +299,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. What is this dependence? How do we determine which PMDs need this? I guess we don't really need to concern ourselves with this as mentioned in set_port_mtu(). I think we should actually remove this line. It doesn't really add much (and the same thing is mentioned in set_port_mtu()) and the method could actually used in other contexts. > + 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. The same reasoning applies here, we don't really need this sentence. However, we could add the other sentence about the method wrapping the command to unify the doctrings a bit.