patch 'net/fm10k: fix cleanup during init failure' has been queued to stable release 21.11.8

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 21.11.8

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 08/28/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/7a97a44a0a9d65856f26499c092fcb05e51f16f1

Thanks.

Kevin

---
>From 7a97a44a0a9d65856f26499c092fcb05e51f16f1 Mon Sep 17 00:00:00 2001
From: Julien Meunier <julien.meunier at nokia.com>
Date: Wed, 3 Apr 2024 13:55:41 +0200
Subject: [PATCH] net/fm10k: fix cleanup during init failure

[ upstream commit cd7f5da2e7d647863a3d6552b6787f413bbd05f2 ]

Cleanup was not done on this PMD if a error is seen during the init:
- possible memory leak due to a missing free
- interrupt handler was not disabled: if an IRQ is received after the
  init, a SIGSEGV can be seen (private data stored in
  rte_eth_devices[port_id] is pointing to NULL)

Fixes: a6061d9e7075 ("fm10k: register PF driver")
Fixes: 4c287332c39a ("fm10k: add PF and VF interrupt handling")

Signed-off-by: Julien Meunier <julien.meunier at nokia.com>
Reviewed-by: Bruce Richardson <bruce.richardson at intel.com>
---
 drivers/net/fm10k/fm10k_ethdev.c | 39 +++++++++++++++++++++++++++-----
 1 file changed, 33 insertions(+), 6 deletions(-)

diff --git a/drivers/net/fm10k/fm10k_ethdev.c b/drivers/net/fm10k/fm10k_ethdev.c
index 8bbd8b445d..5bac1794fb 100644
--- a/drivers/net/fm10k/fm10k_ethdev.c
+++ b/drivers/net/fm10k/fm10k_ethdev.c
@@ -3057,5 +3057,5 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 	struct rte_pci_device *pdev = RTE_ETH_DEV_TO_PCI(dev);
 	struct rte_intr_handle *intr_handle = pdev->intr_handle;
-	int diag, i;
+	int diag, i, ret;
 	struct fm10k_macvlan_filter_info *macvlan;
 
@@ -3146,5 +3146,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 	if (diag != 0) {
 		PMD_INIT_LOG(ERR, "Stats reset failed: %d", diag);
-		return diag;
+		ret = diag;
+		goto err_stat;
 	}
 
@@ -3153,5 +3154,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 	if (diag != FM10K_SUCCESS) {
 		PMD_INIT_LOG(ERR, "Hardware reset failed: %d", diag);
-		return -EIO;
+		ret = -EIO;
+		goto err_reset_hw;
 	}
 
@@ -3160,5 +3162,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 	if (diag != FM10K_SUCCESS) {
 		PMD_INIT_LOG(ERR, "Failed to setup mailbox: %d", diag);
-		return -EIO;
+		ret = -EIO;
+		goto err_mbx;
 	}
 
@@ -3199,5 +3202,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 		if (switch_ready == false) {
 			PMD_INIT_LOG(ERR, "switch is not ready");
-			return -1;
+			ret = -1;
+			goto err_switch_ready;
 		}
 	}
@@ -3234,5 +3238,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 		if (!hw->mac.default_vid) {
 			PMD_INIT_LOG(ERR, "default VID is not ready");
-			return -1;
+			ret = -1;
+			goto err_vid;
 		}
 	}
@@ -3243,4 +3248,26 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
 
 	return 0;
+
+err_vid:
+err_switch_ready:
+	rte_intr_disable(intr_handle);
+
+	if (hw->mac.type == fm10k_mac_pf) {
+		fm10k_dev_disable_intr_pf(dev);
+		rte_intr_callback_unregister(intr_handle,
+			fm10k_dev_interrupt_handler_pf, (void *)dev);
+	} else {
+		fm10k_dev_disable_intr_vf(dev);
+		rte_intr_callback_unregister(intr_handle,
+			fm10k_dev_interrupt_handler_vf, (void *)dev);
+	}
+
+err_mbx:
+err_reset_hw:
+err_stat:
+	rte_free(dev->data->mac_addrs);
+	dev->data->mac_addrs = NULL;
+
+	return ret;
 }
 
-- 
2.46.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2024-08-23 17:18:11.104916685 +0100
+++ 0039-net-fm10k-fix-cleanup-during-init-failure.patch	2024-08-23 17:18:09.681429969 +0100
@@ -1 +1 @@
-From cd7f5da2e7d647863a3d6552b6787f413bbd05f2 Mon Sep 17 00:00:00 2001
+From 7a97a44a0a9d65856f26499c092fcb05e51f16f1 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit cd7f5da2e7d647863a3d6552b6787f413bbd05f2 ]
+
@@ -14 +15,0 @@
-Cc: stable at dpdk.org
@@ -23 +24 @@
-index fa0d16277e..7b490bea17 100644
+index 8bbd8b445d..5bac1794fb 100644
@@ -26 +27 @@
-@@ -3059,5 +3059,5 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3057,5 +3057,5 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
@@ -33 +34 @@
-@@ -3148,5 +3148,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3146,5 +3146,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
@@ -41 +42 @@
-@@ -3155,5 +3156,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3153,5 +3154,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
@@ -49 +50 @@
-@@ -3162,5 +3164,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3160,5 +3162,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
@@ -57 +58 @@
-@@ -3201,5 +3204,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3199,5 +3202,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
@@ -65 +66 @@
-@@ -3236,5 +3240,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3234,5 +3238,6 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
@@ -73 +74 @@
-@@ -3245,4 +3250,26 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
+@@ -3243,4 +3248,26 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)