patch 'net/i40e: check register read for outer VLAN' has been queued to stable release 21.11.9

[Kevin Traynor <ktraynor@redhat.com>]

Hi,

FYI, your patch has been queued to stable release 21.11.9

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/02/24. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/b70507e59f9851e15707afd90b2eb8ccb3f2c4f7

Thanks.

Kevin

---
From b70507e59f9851e15707afd90b2eb8ccb3f2c4f7 Mon Sep 17 00:00:00 2001
From: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
Date: Fri, 15 Nov 2024 19:14:25 +0000
Subject: [PATCH] net/i40e: check register read for outer VLAN

[ upstream commit c11c52dd5d2a19c97616ac32a1d4911c48f157d4 ]

'i40e_get_outer_vlan()' does not check 'i40e_aq_debug_read_register()'
return value. This patch fixes this issue, by checking the return value
and, on error, having the i40e_get_outer_vlan() function return that
error back to the caller.

This in turn requires a change in the return type of that function and
updates to the places where it is called to:
* handle the error, and
* handle the tpid being returned as an "out" parameter rather than
  return code.

Coverity issue: 445518
Fixes: 86eb05d6350b ("net/i40e: add flow validate function")

Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 drivers/net/i40e/i40e_flow.c | 77 ++++++++++++++++++++++++++++++------
 1 file changed, 65 insertions(+), 12 deletions(-)

diff --git a/drivers/net/i40e/i40e_flow.c b/drivers/net/i40e/i40e_flow.c
index 5c7f445018..576a63f06f 100644
--- a/drivers/net/i40e/i40e_flow.c
+++ b/drivers/net/i40e/i40e_flow.c
@@ -2019,6 +2019,6 @@ i40e_flow_parse_attr(const struct rte_flow_attr *attr,
 }
 
-static uint16_t
-i40e_get_outer_vlan(struct rte_eth_dev *dev)
+static int
+i40e_get_outer_vlan(struct rte_eth_dev *dev, uint16_t *tpid)
 {
 	struct i40e_hw *hw = I40E_DEV_PRIVATE_TO_HW(dev->data->dev_private);
@@ -2027,5 +2027,5 @@ i40e_get_outer_vlan(struct rte_eth_dev *dev)
 	uint64_t reg_r = 0;
 	uint16_t reg_id;
-	uint16_t tpid;
+	int ret;
 
 	if (qinq)
@@ -2034,10 +2034,14 @@ i40e_get_outer_vlan(struct rte_eth_dev *dev)
 		reg_id = 3;
 
-	i40e_aq_debug_read_register(hw, I40E_GL_SWT_L2TAGCTRL(reg_id),
+	ret = i40e_aq_debug_read_register(hw, I40E_GL_SWT_L2TAGCTRL(reg_id),
 				    &reg_r, NULL);
+	if (ret != I40E_SUCCESS) {
+		PMD_DRV_LOG(ERR, "Failed to read from L2 tag ctrl register [%d]", reg_id);
+		return -EIO;
+	}
 
-	tpid = (reg_r >> I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_SHIFT) & 0xFFFF;
+	*tpid = (reg_r >> I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_SHIFT) & 0xFFFF;
 
-	return tpid;
+	return 0;
 }
 
@@ -2059,4 +2063,6 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
 	const struct rte_flow_item_eth *eth_mask;
 	enum rte_flow_item_type item_type;
+	int ret;
+	uint16_t tpid;
 
 	for (; item->type != RTE_FLOW_ITEM_TYPE_END; item++) {
@@ -2117,6 +2123,21 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
 			if (filter->ether_type == RTE_ETHER_TYPE_IPV4 ||
 			    filter->ether_type == RTE_ETHER_TYPE_IPV6 ||
-			    filter->ether_type == RTE_ETHER_TYPE_LLDP ||
-			    filter->ether_type == i40e_get_outer_vlan(dev)) {
+			    filter->ether_type == RTE_ETHER_TYPE_LLDP) {
+				rte_flow_error_set(error, EINVAL,
+						   RTE_FLOW_ERROR_TYPE_ITEM,
+						   item,
+						   "Unsupported ether_type in control packet filter.");
+				return -rte_errno;
+			}
+
+			ret = i40e_get_outer_vlan(dev, &tpid);
+			if (ret != 0) {
+				rte_flow_error_set(error, EIO,
+						RTE_FLOW_ERROR_TYPE_ITEM,
+						item,
+						"Can not get the Ethertype identifying the L2 tag");
+				return -rte_errno;
+			}
+			if (filter->ether_type == tpid) {
 				rte_flow_error_set(error, EINVAL,
 						   RTE_FLOW_ERROR_TYPE_ITEM,
@@ -2126,4 +2147,5 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
 				return -rte_errno;
 			}
+
 			break;
 		default:
@@ -2399,4 +2421,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
 	uint8_t field_idx;
 	int ret;
+	uint16_t tpid;
 
 	memset(off_arr, 0, sizeof(off_arr));
@@ -2467,6 +2490,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
 
 				if (ether_type == RTE_ETHER_TYPE_IPV4 ||
-				    ether_type == RTE_ETHER_TYPE_IPV6 ||
-				    ether_type == i40e_get_outer_vlan(dev)) {
+				    ether_type == RTE_ETHER_TYPE_IPV6) {
 					rte_flow_error_set(error, EINVAL,
 						     RTE_FLOW_ERROR_TYPE_ITEM,
@@ -2475,4 +2497,20 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
 					return -rte_errno;
 				}
+				ret = i40e_get_outer_vlan(dev, &tpid);
+				if (ret != 0) {
+					rte_flow_error_set(error, EIO,
+							RTE_FLOW_ERROR_TYPE_ITEM,
+							item,
+							"Can not get the Ethertype identifying the L2 tag");
+					return -rte_errno;
+				}
+				if (ether_type == tpid) {
+					rte_flow_error_set(error, EINVAL,
+						     RTE_FLOW_ERROR_TYPE_ITEM,
+						     item,
+						     "Unsupported ether_type.");
+					return -rte_errno;
+				}
+
 				input_set |= I40E_INSET_LAST_ETHER_TYPE;
 				filter->input.flow.l2_flow.ether_type =
@@ -2521,6 +2559,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
 
 				if (ether_type == RTE_ETHER_TYPE_IPV4 ||
-				    ether_type == RTE_ETHER_TYPE_IPV6 ||
-				    ether_type == i40e_get_outer_vlan(dev)) {
+				    ether_type == RTE_ETHER_TYPE_IPV6) {
 					rte_flow_error_set(error, EINVAL,
 						     RTE_FLOW_ERROR_TYPE_ITEM,
@@ -2529,4 +2566,20 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
 					return -rte_errno;
 				}
+				ret = i40e_get_outer_vlan(dev, &tpid);
+				if (ret != 0) {
+					rte_flow_error_set(error, EIO,
+							RTE_FLOW_ERROR_TYPE_ITEM,
+							item,
+							"Can not get the Ethertype identifying the L2 tag");
+					return -rte_errno;
+				}
+				if (ether_type == tpid) {
+					rte_flow_error_set(error, EINVAL,
+						     RTE_FLOW_ERROR_TYPE_ITEM,
+						     item,
+						     "Unsupported ether_type.");
+					return -rte_errno;
+				}
+
 				input_set |= I40E_INSET_LAST_ETHER_TYPE;
 				filter->input.flow.l2_flow.ether_type =
-- 
2.47.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2024-11-27 17:17:41.785873526 +0000
+++ 0112-net-i40e-check-register-read-for-outer-VLAN.patch	2024-11-27 17:17:38.344269990 +0000
@@ -1 +1 @@
-From c11c52dd5d2a19c97616ac32a1d4911c48f157d4 Mon Sep 17 00:00:00 2001
+From b70507e59f9851e15707afd90b2eb8ccb3f2c4f7 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit c11c52dd5d2a19c97616ac32a1d4911c48f157d4 ]
+
@@ -19 +20,0 @@
-Cc: stable@dpdk.org
@@ -28 +29 @@
-index c6857727e8..cd598431e1 100644
+index 5c7f445018..576a63f06f 100644
@@ -31 +32 @@
-@@ -1264,6 +1264,6 @@ i40e_flow_parse_attr(const struct rte_flow_attr *attr,
+@@ -2019,6 +2019,6 @@ i40e_flow_parse_attr(const struct rte_flow_attr *attr,
@@ -40 +41 @@
-@@ -1272,5 +1272,5 @@ i40e_get_outer_vlan(struct rte_eth_dev *dev)
+@@ -2027,5 +2027,5 @@ i40e_get_outer_vlan(struct rte_eth_dev *dev)
@@ -47 +48 @@
-@@ -1279,10 +1279,14 @@ i40e_get_outer_vlan(struct rte_eth_dev *dev)
+@@ -2034,10 +2034,14 @@ i40e_get_outer_vlan(struct rte_eth_dev *dev)
@@ -65 +66 @@
-@@ -1304,4 +1308,6 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
+@@ -2059,4 +2063,6 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
@@ -72 +73 @@
-@@ -1362,6 +1368,21 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
+@@ -2117,6 +2123,21 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
@@ -96 +97 @@
-@@ -1371,4 +1392,5 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
+@@ -2126,4 +2147,5 @@ i40e_flow_parse_ethertype_pattern(struct rte_eth_dev *dev,
@@ -102 +103 @@
-@@ -1642,4 +1664,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
+@@ -2399,4 +2421,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
@@ -108 +109 @@
-@@ -1710,6 +1733,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
+@@ -2467,6 +2490,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
@@ -116 +117 @@
-@@ -1718,4 +1740,20 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
+@@ -2475,4 +2497,20 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
@@ -137 +138 @@
-@@ -1764,6 +1802,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
+@@ -2521,6 +2559,5 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
@@ -145 +146 @@
-@@ -1772,4 +1809,20 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,
+@@ -2529,4 +2566,20 @@ i40e_flow_parse_fdir_pattern(struct rte_eth_dev *dev,