From patchwork Wed Aug 7 19:43:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dean Marx X-Patchwork-Id: 143007 X-Patchwork-Delegate: juraj.linkes@pantheon.tech Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8128A45760; Wed, 7 Aug 2024 21:43:37 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A59ED40ED9; Wed, 7 Aug 2024 21:43:33 +0200 (CEST) Received: from mail-qv1-f44.google.com (mail-qv1-f44.google.com [209.85.219.44]) by mails.dpdk.org (Postfix) with ESMTP id 8C96540E2A for ; Wed, 7 Aug 2024 21:43:32 +0200 (CEST) Received: by mail-qv1-f44.google.com with SMTP id 6a1803df08f44-6b78c980981so1511536d6.2 for ; Wed, 07 Aug 2024 12:43:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1723059812; x=1723664612; 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=287+kq1mMUUbqxbPr8s2SYzwzU8RvmWzFGEbbec8ljs=; b=E5cq3BYY8m798j2F679Ja1tVjOkeLpr9puo++Q9GmobsQG5ww7ChH6mkXIPUfMUIb0 ivR8F+9UvndInzMEwvAV4sQ0FY7dp7UoKwwDEG1FlVjUhA4+zz/+zgU+r5cev9SAvTcb dSl6EZQ20AA9tw+jnbyGNhV5embjg2st4VWoE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723059812; x=1723664612; 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=287+kq1mMUUbqxbPr8s2SYzwzU8RvmWzFGEbbec8ljs=; b=B9c3BCd9mtVvHSWAjr11PfIY0WUvqQx7oNgZylyASWbVoi85hX92O8w0wp2pOWFpEF h5LoEkb1Tt1VrFHj5a//G46R58+dqnQbyQbpDC5GH64udYxHSgxW+iJBhvrfsmpHN4B1 cHEd3aGaC82FT/iJh0HCqQbCwJskgAbYr0Ja8JmQkvUe/2YKMK9jpe7fCIUQaGrIzCjF EdRVGrSOCaDpD1pc8gaEnV90F8CuodfjQrtmyYY5vN55axHBtM+0Yir4fgI5pqAzTUn6 L9WIVji8UIJe+wTmiAgdYcjOIqzthZMTwLmgggLcFWcC9vz7k5W2p+kfE02bk26GxrgB i7Wg== X-Gm-Message-State: AOJu0Yy3/udE27Oy+RuB2oB0Sxr/I8u33yU4zuajrWKSv9LN7rgglHMy rSCfbdqgX0Lx9lRJ9Nk0LjcvGVG/2+RJLsEvtrXJl9jbqLOTsfZM57EFoeLPoWg= X-Google-Smtp-Source: AGHT+IFYPHm65fs+ozaDX27pKQgNnJwjRVBI24pYOC6awb893MyyVSa9v1+ozugayhhWGCrLbrDVdw== X-Received: by 2002:a05:6214:3202:b0:6b7:b236:6944 with SMTP id 6a1803df08f44-6bb98379ff7mr193515066d6.8.1723059811637; Wed, 07 Aug 2024 12:43:31 -0700 (PDT) Received: from dean-laptop.iol.unh.edu ([2606:4100:3880:1271:f9bd:24da:464d:6294]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6bb9c839d65sm59277786d6.82.2024.08.07.12.43.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Aug 2024 12:43:31 -0700 (PDT) From: Dean Marx To: probb@iol.unh.edu, npratte@iol.unh.edu, jspewock@iol.unh.edu, luca.vizzarro@arm.com, yoan.picchi@foss.arm.com, Honnappa.Nagarahalli@arm.com, paul.szczepanek@arm.com, juraj.linkes@pantheon.tech Cc: dev@dpdk.org, Dean Marx Subject: [PATCH v13 1/2] dts: add VLAN methods to testpmd shell Date: Wed, 7 Aug 2024 15:43:40 -0400 Message-ID: <20240807194341.26102-2-dmarx@iol.unh.edu> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240807194341.26102-1-dmarx@iol.unh.edu> References: <20240724163004.5681-1-dmarx@iol.unh.edu> <20240807194341.26102-1-dmarx@iol.unh.edu> MIME-Version: 1.0 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 added the following methods to testpmd shell class: vlan set filter on/off, rx vlan add/rm, vlan set strip on/off, port stop/start all/port, tx vlan set/reset, set promisc/verbose fixed bug in vlan_offload for show port info, removed $ at end of regex Signed-off-by: Dean Marx --- dts/framework/remote_session/testpmd_shell.py | 245 +++++++++++++++++- 1 file changed, 244 insertions(+), 1 deletion(-) diff --git a/dts/framework/remote_session/testpmd_shell.py b/dts/framework/remote_session/testpmd_shell.py index eda6eb320f..8e5a1c084a 100644 --- a/dts/framework/remote_session/testpmd_shell.py +++ b/dts/framework/remote_session/testpmd_shell.py @@ -98,7 +98,7 @@ def make_parser(cls) -> ParserFn: r"strip (?Pon|off), " r"filter (?Pon|off), " r"extend (?Pon|off), " - r"qinq strip (?Pon|off)$", + r"qinq strip (?Pon|off)", re.MULTILINE, named=True, ), @@ -804,6 +804,249 @@ def show_port_stats(self, port_id: int) -> TestPmdPortStats: return TestPmdPortStats.parse(output) + def vlan_filter_set(self, port: int, on: bool, verify: bool = True) -> None: + """Set vlan filter on. + + Args: + port: The port number to enable VLAN filter on, should be within 0-32. + on: Sets filter on if :data:`True`, otherwise turns off. + verify: If :data:`True`, the output of the command and show port info + is scanned to verify that vlan filtering was enabled successfully. + If not, it is considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the filter + fails to update. + """ + filter_cmd_output = self.send_command(f"vlan set filter {'on' if on else 'off'} {port}") + if verify: + if on ^ ("FILTER" in str(self.show_port_info(port_id=port).vlan_offload)): + self._logger.debug(f"Failed to set filter on port {port}: \n{filter_cmd_output}") + raise InteractiveCommandExecutionError( + f"Testpmd failed to set VLAN filter on port {port}." + ) + + def rx_vlan(self, vlan: int, port: int, add: bool, verify: bool = True) -> None: + """Add specified vlan tag to the filter list on a port. + + Args: + vlan: The vlan tag to add, should be within 1-1005, 1-4094 extended. + port: The port number to add the tag on, should be within 0-32. + add: adds the tag if :data:`True`, otherwise removes tag. + verify: If :data:`True`, the output of the command is scanned to verify that + the vlan tag was added to the filter list on the specified port. If not, it is + considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the tag + is not added. + """ + rx_output = self.send_command(f"rx_vlan {'add' if add else 'rm'} {vlan} {port}") + if verify: + if ( + "VLAN-filtering disabled" in rx_output + or "Invalid vlan_id" in rx_output + or "Bad arguments" in rx_output + ): + self._logger.debug( + f"Failed to {'add' if add else 'remove'} tag {vlan} port {port}: \n{rx_output}" + ) + raise InteractiveCommandExecutionError( + f"Testpmd failed to {'add' if add else 'remove'} tag {vlan} on port {port}." + ) + + def vlan_strip_set(self, port: int, on: bool, verify: bool = True) -> None: + """Enable vlan stripping on the specified port. + + Args: + port: The port number to use, should be within 0-32. + on: If :data:`True`, will turn strip on, otherwise will turn off. + verify: If :data:`True`, the output of the command and show port info + is scanned to verify that vlan stripping was enabled on the specified port. + If not, it is considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and stripping + fails to update. + """ + strip_output = self.send_command(f"vlan set strip {'on' if on else 'off'} {port}") + if verify: + if on ^ ("STRIP" in str(self.show_port_info(port_id=port).vlan_offload)): + self._logger.debug( + f"Failed to set strip {'on' if on else 'off'} port {port}: \n{strip_output}" + ) + raise InteractiveCommandExecutionError( + f"Testpmd failed to set strip {'on' if on else 'off'} port {port}." + ) + + def port_stop_all(self, verify: bool = True) -> None: + """Stop all ports. + + Args: + port: Specifies the port number to use, must be between 0-32. + verify: If :data:`True`, the output of the command is scanned + to ensure all ports are stopped. If not, it is considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and all ports + fail to stop. + """ + port_output = self.send_command("port stop all") + if verify: + if "Done" not in port_output: + self._logger.debug(f"Failed to stop all ports: \n{port_output}") + raise InteractiveCommandExecutionError("Testpmd failed to stop all ports.") + + def port_stop(self, port: int, verify: bool = True) -> None: + """Stop specified port. + + Args: + port: Specifies the port number to use, must be between 0-32. + verify: If :data:`True`, the output of the command is scanned + to ensure specified port is stopped. If not, it is considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the port + is not stopped. + """ + port_output = self.send_command(f"port stop {port}") + if verify: + if "Done" not in port_output: + self._logger.debug(f"Failed to stop port {port}: \n{port_output}") + raise InteractiveCommandExecutionError(f"Testpmd failed to stop port {port}.") + + def port_start_all(self, verify: bool = True) -> None: + """Start all ports. + + Args: + port: Specifies the port number to use, must be between 0-32. + verify: If :data:`True`, the output of the command is scanned + to ensure all ports are started. If not, it is considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and all ports + fail to start. + """ + port_output = self.send_command("port start all") + if verify: + if "Done" not in port_output: + self._logger.debug(f"Failed to start all ports: \n{port_output}") + raise InteractiveCommandExecutionError("Testpmd failed to start all ports.") + + def port_start(self, port: int, verify: bool = True) -> None: + """Start specified port. + + Args: + port: Specifies the port number to use, must be between 0-32. + verify: If :data:`True`, the output of the command is scanned + to ensure specified port is started. If not, it is considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the port + is not started. + """ + port_output = self.send_command(f"port start {port}") + if verify: + if "Done" not in port_output: + self._logger.debug(f"Failed to start port {port}: \n{port_output}") + raise InteractiveCommandExecutionError(f"Testpmd failed to start port {port}.") + + def tx_vlan_set(self, port: int, vlan: int, verify: bool = True) -> None: + """Set hardware insertion of vlan tags in packets sent on a port. + + Args: + port: The port number to use, should be within 0-32. + vlan: The vlan tag to insert, should be within 1-4094. + verify: If :data:`True`, the output of the command is scanned to verify that + vlan insertion was enabled on the specified port. If not, it is + considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the insertion + tag is not set. + """ + vlan_insert_output = self.send_command(f"tx_vlan set {port} {vlan}") + if verify: + if ( + "Please stop port" in vlan_insert_output + or "Invalid vlan_id" in vlan_insert_output + or "Invalid port" in vlan_insert_output + ): + self._logger.debug( + f"Failed to set vlan tag {vlan} on port {port}:\n{vlan_insert_output}" + ) + raise InteractiveCommandExecutionError( + f"Testpmd failed to set vlan insertion tag {vlan} on port {port}." + ) + + def tx_vlan_reset(self, port: int, verify: bool = True) -> None: + """Disable hardware insertion of vlan tags in packets sent on a port. + + Args: + port: The port number to use, should be within 0-32. + verify: If :data:`True`, the output of the command is scanned to verify that + vlan insertion was disabled on the specified port. If not, it is + considered an error. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and the insertion + tag is not reset. + """ + vlan_insert_output = self.send_command(f"tx_vlan set {port}") + if verify: + if "Please stop port" in vlan_insert_output or "Invalid port" in vlan_insert_output: + self._logger.debug( + f"Failed to reset vlan insertion on port {port}: \n{vlan_insert_output}" + ) + raise InteractiveCommandExecutionError( + f"Testpmd failed to reset vlan insertion on port {port}." + ) + + def set_promisc(self, port: int, on: bool, verify: bool = True) -> None: + """Turns promiscuous mode on/off for the specified port. + + Args: + port: Port number to use, should be within 0-32. + on: If :data:`True`, turn promisc mode on, otherwise turn off. + verify: If :data:`True` an additional command will be sent to verify that promisc mode + is properly set. Defaults to :data:`True`. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and promisc mode + is not correctly set. + """ + promisc_output = self.send_command(f"set promisc {port} {'on' if on else 'off'}") + if verify: + stats = self.show_port_info(port_id=port) + if on ^ stats.is_promiscuous_mode_enabled: + self._logger.debug(f"Failed to set promisc mode on port {port}: \n{promisc_output}") + raise InteractiveCommandExecutionError( + f"Testpmd failed to set promisc mode on port {port}." + ) + + def set_verbose(self, level: int, verify: bool = True) -> None: + """Set debug verbosity level. + + Args: + level: 0 - silent except for error + 1 - fully verbose except for Tx packets + 2 - fully verbose except for Rx packets + >2 - fully verbose + verify: If :data:`True` the command output will be scanned to verify that verbose level + is properly set. Defaults to :data:`True`. + + Raises: + InteractiveCommandExecutionError: If `verify` is :data:`True` and verbose level + is not correctly set. + """ + verbose_output = self.send_command(f"set verbose {level}") + if verify: + if "Change verbose level" not in verbose_output: + self._logger.debug(f"Failed to set verbose level to {level}: \n{verbose_output}") + raise InteractiveCommandExecutionError( + f"Testpmd failed to set verbose level to {level}." + ) + def _close(self) -> None: """Overrides :meth:`~.interactive_shell.close`.""" self.stop() From patchwork Wed Aug 7 19:43:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dean Marx X-Patchwork-Id: 143008 X-Patchwork-Delegate: juraj.linkes@pantheon.tech Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id CEADD45760; Wed, 7 Aug 2024 21:43:43 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 098D7410E3; Wed, 7 Aug 2024 21:43:35 +0200 (CEST) Received: from mail-vs1-f49.google.com (mail-vs1-f49.google.com [209.85.217.49]) by mails.dpdk.org (Postfix) with ESMTP id 01C2E40EE5 for ; Wed, 7 Aug 2024 21:43:34 +0200 (CEST) Received: by mail-vs1-f49.google.com with SMTP id ada2fe7eead31-4928d2f45e2so86066137.0 for ; Wed, 07 Aug 2024 12:43:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1723059813; x=1723664613; 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=K6zXVjkqbxhhQp2xrREQXCfuisZrrJX7VOzbLPQhQNU=; b=G4H10HRuiGU9IJ+uUFzdke3/XK3a+VJc7ypXhKbDLd2kg2c0OX//g6XSVk2AxiywQu C787DFHSK6w7TsqHhObZ0Pcauonad+IY1O1jZxtsTNGRGPnaiiB950i0dnOYzwl/J0oU GfVWrt/xO6QKRJ7GnEkMZtnWkxzfhzGFh/S94= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723059813; x=1723664613; 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=K6zXVjkqbxhhQp2xrREQXCfuisZrrJX7VOzbLPQhQNU=; b=hX4f6GjPlQ+r+mCGrn+esvHfVwf0mVpVxDEPi/yfcOVu7WZOrB2yJ7hyp1vZ5uyC45 bkPAdiJFcAr/hENBqzC6UxDOhoWm48vfYXCtKFrzrOUdfxdAVkGkB2iUWJ5Y97KF08LL ZxZ+fyZkQvwaOP152ib1fANBWZjUKP8Nmx1PqcR8T3dOO9Jn/P0Idep1bIUh8QRPKwJc yC2QzzlBnCse3VAOSzz1svsWoaalfgExsa99pjK7VwzkSntc8VBHfliKFquUyuzO/fma JFdRLLXDaE4vF9QyeS5eAcDeesyGWsHy5QhV6Ol2bby3q/OvN5+xBBF9Q9vn1TK0UrBY 0OZw== X-Gm-Message-State: AOJu0Yys6wexxwSJllcNeBlnjctEVoHBF/v8NDFdP/dODpAWv0YZbQUn nA8l31g/K97GB9muWNPsMkBVUBuPnDErHmI/qPCLHN+BtYZI38n95USlr8YZylo= X-Google-Smtp-Source: AGHT+IEHKALTbQHEIt7t2IKXOQHHzrTUE1d1wT304WcpQ7H+nsi0O0rY2FGu/ct+ZBojEcXwTCsi+w== X-Received: by 2002:a05:6102:e06:b0:493:c631:5ecd with SMTP id ada2fe7eead31-4945beaf2b3mr26325968137.24.1723059813171; Wed, 07 Aug 2024 12:43:33 -0700 (PDT) Received: from dean-laptop.iol.unh.edu ([2606:4100:3880:1271:f9bd:24da:464d:6294]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6bb9c839d65sm59277786d6.82.2024.08.07.12.43.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Aug 2024 12:43:32 -0700 (PDT) From: Dean Marx To: probb@iol.unh.edu, npratte@iol.unh.edu, jspewock@iol.unh.edu, luca.vizzarro@arm.com, yoan.picchi@foss.arm.com, Honnappa.Nagarahalli@arm.com, paul.szczepanek@arm.com, juraj.linkes@pantheon.tech Cc: dev@dpdk.org, Dean Marx Subject: [PATCH v13 2/2] dts: VLAN test suite implementation Date: Wed, 7 Aug 2024 15:43:41 -0400 Message-ID: <20240807194341.26102-3-dmarx@iol.unh.edu> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240807194341.26102-1-dmarx@iol.unh.edu> References: <20240724163004.5681-1-dmarx@iol.unh.edu> <20240807194341.26102-1-dmarx@iol.unh.edu> MIME-Version: 1.0 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 Test suite for verifying VLAN filtering, stripping, and insertion functionality on Poll Mode Driver. Signed-off-by: Dean Marx --- dts/framework/config/conf_yaml_schema.json | 3 +- dts/tests/TestSuite_vlan.py | 168 +++++++++++++++++++++ 2 files changed, 170 insertions(+), 1 deletion(-) create mode 100644 dts/tests/TestSuite_vlan.py diff --git a/dts/framework/config/conf_yaml_schema.json b/dts/framework/config/conf_yaml_schema.json index f02a310bb5..cd45902cc4 100644 --- a/dts/framework/config/conf_yaml_schema.json +++ b/dts/framework/config/conf_yaml_schema.json @@ -187,7 +187,8 @@ "enum": [ "hello_world", "os_udp", - "pmd_buffer_scatter" + "pmd_buffer_scatter", + "vlan" ] }, "test_target": { diff --git a/dts/tests/TestSuite_vlan.py b/dts/tests/TestSuite_vlan.py new file mode 100644 index 0000000000..3193c559f3 --- /dev/null +++ b/dts/tests/TestSuite_vlan.py @@ -0,0 +1,168 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2024 University of New Hampshire + +"""Test the support of VLAN Offload Features by Poll Mode Drivers. + +The test suite ensures that with the correct configuration, a port +will not drop a VLAN tagged packet. In order for this to be successful, +packet header stripping and packet receipts must be enabled on the Poll Mode Driver. +The test suite checks that when these conditions are met, the packet is received without issue. +The suite also checks to ensure that when these conditions are not met, as in the cases where +stripping is disabled, or VLAN packet receipts are disabled, the packet is not received. +Additionally, it checks the case where VLAN header insertion is enabled in transmitted packets, +which should be successful if the previous cases pass. + +""" + +from scapy.layers.l2 import Dot1Q, 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 + + +class TestVlan(TestSuite): + """DPDK VLAN test suite. + + Ensures VLAN packet reception, stripping, and insertion on the Poll Mode Driver + when the appropriate conditions are met. The suite contains four test cases: + + 1. VLAN reception no stripping - verifies that a vlan packet with a tag + within the filter list is received. + 2. VLAN reception stripping - verifies that a vlan packet with a tag + within the filter list is received without the vlan tag. + 3. VLAN no reception - verifies that a vlan packet with a tag not within + the filter list is dropped. + 4. VLAN insertion - verifies that a non vlan packet is received with a vlan + tag when insertion is enabled. + """ + + def set_up_suite(self) -> None: + """Set up the test suite. + + Setup: + Verify that at least two ports are open for session. + """ + self.verify(len(self._port_links) > 1, "Not enough ports") + + def send_vlan_packet_and_verify(self, should_receive: bool, strip: bool, vlan_id: int) -> None: + """Generate a vlan packet, send and verify packet with same payload is received on the dut. + + Args: + should_receive: Indicate whether the packet should be successfully received. + strip: Indicates whether stripping is on or off, and when the vlan tag is + checked for a match. + vlan_id: Expected vlan ID. + """ + packet = Ether() / Dot1Q(vlan=vlan_id) / Raw(load="xxxxx") + received_packets = self.send_packet_and_capture(packet) + test_packet = None + for packet in received_packets: + if b"xxxxx" in packet.load: + test_packet = packet + break + if should_receive: + self.verify( + test_packet is not None, "Packet was dropped when it should have been received" + ) + if test_packet is not None: + if strip: + self.verify( + not test_packet.haslayer(Dot1Q), "Vlan tag was not stripped successfully" + ) + else: + self.verify( + test_packet.vlan == vlan_id, + "The received tag did not match the expected tag", + ) + else: + self.verify( + test_packet is None, + "Packet was received when it should have been dropped", + ) + + def send_packet_and_verify_insertion(self, expected_id: int) -> None: + """Generate a packet with no vlan tag, send and verify on the dut. + + Args: + expected_id: The vlan id that is being inserted through tx_offload configuration. + """ + packet = Ether() / Raw(load="xxxxx") + received_packets = self.send_packet_and_capture(packet) + test_packet = None + for packet in received_packets: + if b"xxxxx" in packet.load: + test_packet = packet + break + self.verify(test_packet is not None, "Packet was dropped when it should have been received") + if test_packet is not None: + self.verify(test_packet.haslayer(Dot1Q), "The received packet did not have a vlan tag") + self.verify( + test_packet.vlan == expected_id, "The received tag did not match the expected tag" + ) + + def vlan_setup(self, testpmd: TestPmdShell, port_id: int, filtered_id: int) -> TestPmdShell: + """Setup method for all test cases. + + Args: + testpmd: Testpmd shell session to send commands to. + port_id: Number of port to use for setup. + filtered_id: ID to be added to the vlan filter list. + + Returns: + TestPmdShell: Testpmd session being configured. + """ + testpmd.set_forward_mode(SimpleForwardingModes.mac) + testpmd.set_promisc(port_id, False) + testpmd.vlan_filter_set(port=port_id, on=True) + testpmd.rx_vlan(vlan=filtered_id, port=port_id, add=True) + return testpmd + + def test_vlan_receipt_no_stripping(self) -> None: + """Ensure vlan packet is dropped when receipts are enabled and header stripping is disabled. + + Test: + Create an interactive testpmd shell and verify a vlan packet. + """ + with TestPmdShell(node=self.sut_node) as testpmd: + testpmd = self.vlan_setup(testpmd=testpmd, port_id=0, filtered_id=1) + testpmd.start() + self.send_vlan_packet_and_verify(True, strip=False, vlan_id=1) + + def test_vlan_receipt_stripping(self) -> None: + """Ensure vlan packet received with no tag when receipts and header stripping are enabled. + + Test: + Create an interactive testpmd shell and verify a vlan packet. + """ + with TestPmdShell(node=self.sut_node) as testpmd: + testpmd = self.vlan_setup(testpmd=testpmd, port_id=0, filtered_id=1) + testpmd.vlan_strip_set(port=0, on=True) + testpmd.start() + self.send_vlan_packet_and_verify(should_receive=True, strip=True, vlan_id=1) + + def test_vlan_no_receipt(self) -> None: + """Ensure vlan packet dropped when filter is on and sent tag not in the filter list. + + Test: + Create an interactive testpmd shell and verify a vlan packet. + """ + with TestPmdShell(node=self.sut_node) as testpmd: + testpmd = self.vlan_setup(testpmd=testpmd, port_id=0, filtered_id=1) + testpmd.start() + self.send_vlan_packet_and_verify(should_receive=False, strip=False, vlan_id=2) + + def test_vlan_header_insertion(self) -> None: + """Ensure that vlan packet is received with the correct inserted vlan tag. + + Test: + Create an interactive testpmd shell and verify a non-vlan packet. + """ + with TestPmdShell(node=self.sut_node) as testpmd: + testpmd.set_forward_mode(SimpleForwardingModes.mac) + testpmd.set_promisc(port=0, on=False) + testpmd.port_stop_all() + testpmd.tx_vlan_set(port=1, vlan=51) + testpmd.port_start_all() + testpmd.start() + self.send_packet_and_verify_insertion(expected_id=51)