patch 'ethdev: fix potential leak in PCI probing helper' has been queued to stable release 21.11.5

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 21.11.5

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

Thanks.

Kevin

---
>From 9eda05baa7292420aa0c30d04c57ec5ada94c5e3 Mon Sep 17 00:00:00 2001
From: Kaiyu Zhang <squirrel.prog at gmail.com>
Date: Tue, 11 Jul 2023 01:18:09 +0000
Subject: [PATCH] ethdev: fix potential leak in PCI probing helper

[ upstream commit 1f00a6a037040a7c6ba883e2c312894c6ebc4c32 ]

Sanity check is performed after a rte_eth_dev object is allocated.

The object is not freed if the check fails, though in the current
reality this never happens, but it's better programming paradigm
to move the quick check up front to the start of
rte_eth_dev_pci_generic_probe().

Fixes: dcd5c8112bc3 ("ethdev: add PCI driver helpers")

Signed-off-by: Kaiyu Zhang <squirrel.prog at gmail.com>
Reviewed-by: Chengwen Feng <fengchengwen at huawei.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit at amd.com>
---
 .mailmap                | 1 +
 lib/ethdev/ethdev_pci.h | 4 +++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/.mailmap b/.mailmap
index 288cc4913c..12f6084945 100644
--- a/.mailmap
+++ b/.mailmap
@@ -680,4 +680,5 @@ Kai Ji <kai.ji at intel.com>
 Kaijun Zeng <corezeng at gmail.com>
 Kaiwen Deng <kaiwenx.deng at intel.com>
+Kaiyu Zhang <squirrel.prog at gmail.com>
 Kalesh AP <kalesh-anakkur.purayil at broadcom.com>
 Kamalakannan R <kamalakannan.r at intel.com>
diff --git a/lib/ethdev/ethdev_pci.h b/lib/ethdev/ethdev_pci.h
index 0549842709..7ab819c393 100644
--- a/lib/ethdev/ethdev_pci.h
+++ b/lib/ethdev/ethdev_pci.h
@@ -127,9 +127,11 @@ rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
 	int ret;
 
+	if (*dev_init == NULL)
+		return -EINVAL;
+
 	eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
 	if (!eth_dev)
 		return -ENOMEM;
 
-	RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
 	ret = dev_init(eth_dev);
 	if (ret)
-- 
2.41.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-07-20 16:18:09.941947656 +0100
+++ 0124-ethdev-fix-potential-leak-in-PCI-probing-helper.patch	2023-07-20 16:17:55.133752436 +0100
@@ -1 +1 @@
-From 1f00a6a037040a7c6ba883e2c312894c6ebc4c32 Mon Sep 17 00:00:00 2001
+From 9eda05baa7292420aa0c30d04c57ec5ada94c5e3 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 1f00a6a037040a7c6ba883e2c312894c6ebc4c32 ]
+
@@ -14 +15,0 @@
-Cc: stable at dpdk.org
@@ -21,2 +22,2 @@
- lib/ethdev/ethdev_pci.h | 9 +++++----
- 2 files changed, 6 insertions(+), 4 deletions(-)
+ lib/ethdev/ethdev_pci.h | 4 +++-
+ 2 files changed, 4 insertions(+), 1 deletion(-)
@@ -25 +26 @@
-index d200f36339..6c28ea798d 100644
+index 288cc4913c..12f6084945 100644
@@ -28,2 +29,2 @@
-@@ -699,4 +699,5 @@ Kaijun Zeng <corezeng at gmail.com>
- Kaisen You <kaisenx.you at intel.com>
+@@ -680,4 +680,5 @@ Kai Ji <kai.ji at intel.com>
+ Kaijun Zeng <corezeng at gmail.com>
@@ -35 +36 @@
-index 94b8fba5d7..320e3e0093 100644
+index 0549842709..7ab819c393 100644
@@ -38 +39 @@
-@@ -127,10 +127,11 @@ rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
+@@ -127,9 +127,11 @@ rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
@@ -41,10 +42,2 @@
--	eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
--	if (!eth_dev)
--		return -ENOMEM;
--
- 	if (*dev_init == NULL)
- 		return -EINVAL;
-+
-+	eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
-+	if (!eth_dev)
-+		return -ENOMEM;
++	if (*dev_init == NULL)
++		return -EINVAL;
@@ -51,0 +45,5 @@
+ 	eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
+ 	if (!eth_dev)
+ 		return -ENOMEM;
+ 
+-	RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);