Skip to contentSkip to conversation

octeontx2-pf: Fix potential memory leak in otx2_init_tc()

PATCH Applied Ziyang Xuan 3 participants 5 messages Dec 2, 2022 – Dec 5, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 octeontx2-pf: Fix potential memory leak in otx2_init_tc()

In otx2_init_tc(), if rhashtable_init() failed, it does not free tc->tc_entries_bitmap which is allocated in otx2_tc_alloc_ent_bitmap().

Fixes 2e2a8126ffac ("octeontx2-pf: Unify flow management variables")

---
v2:
- Remove patch 2 which is not a problem, see the following link:

    https://www.spinics.net/lists/netdev/msg864159.html
---
 drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +6 -1
index e64318c110fd..6a01ab1a6e6f 100644
@@ -1134,7 +1134,12 @@ int otx2_init_tc(struct otx2_nic *nic)
 		return err;
 
 	tc->flow_ht_params = tc_flow_ht_params;
-	return rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	err = rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	if (err) {
+		kfree(tc->tc_entries_bitmap);
+		tc->tc_entries_bitmap = NULL;
+	}
+	return err;
 }
 EXPORT_SYMBOL(otx2_init_tc);
 
Signature · 1 line
2.25.1
#1 lore raw
Quoted 18 lines · Ziyang Xuan

In otx2_init_tc(), if rhashtable_init() failed, it does not free tc->tc_entries_bitmap which is allocated in otx2_tc_alloc_ent_bitmap().

Fixes 2e2a8126ffac ("octeontx2-pf: Unify flow management variables")

---
v2:
- Remove patch 2 which is not a problem, see the following link:

    https://www.spinics.net/lists/netdev/msg864159.html
---
 drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +0 -0
index e64318c110fd..6a01ab1a6e6f 100644

drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c int otx2_init_tc(struct otx2_nic *nic) · line 1140

Quoted 8 lines
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +4 -1
@@ -1134,7 +1134,12 @@ int otx2_init_tc(struct otx2_nic *nic)
 		return err;
 
 	tc->flow_ht_params = tc_flow_ht_params;
-	return rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	err = rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	if (err) {
+		kfree(tc->tc_entries_bitmap);
+		tc->tc_entries_bitmap = NULL;

Why do you set NULL here? All callers of otx2_init_tc() unwind error properly.

Quoted 8 lines
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +2 -0
+	}
+	return err;
 }
 EXPORT_SYMBOL(otx2_init_tc);
 
Signature · 1 line
2.25.1
#2 lore raw
Quoted 21 lines · Ziyang Xuan
Quoted 20 lines

In otx2_init_tc(), if rhashtable_init() failed, it does not free tc->tc_entries_bitmap which is allocated in otx2_tc_alloc_ent_bitmap().

Fixes 2e2a8126ffac ("octeontx2-pf: Unify flow management variables")

---
v2:
- Remove patch 2 which is not a problem, see the following link:

    https://www.spinics.net/lists/netdev/msg864159.html
---
 drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +0 -0
index e64318c110fd..6a01ab1a6e6f 100644
@@ -1134,7 +1134,12 @@ int otx2_init_tc(struct otx2_nic *nic)
 		return err;
 
Quoted 9 lines

drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c int otx2_init_tc(struct otx2_nic *nic) · line 1140

Quoted 6 lines
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +4 -1
 	tc->flow_ht_params = tc_flow_ht_params;
-	return rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	err = rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	if (err) {
+		kfree(tc->tc_entries_bitmap);
+		tc->tc_entries_bitmap = NULL;

Why do you set NULL here? All callers of otx2_init_tc() unwind error properly.

See the implementation of otx2_tc_alloc_ent_bitmap() as following:

int otx2_tc_alloc_ent_bitmap(struct otx2_nic *nic)

{
	struct otx2_tc_info *tc = &nic->tc_info;

	if (!nic->flow_cfg->max_flows)
		return 0;

	/* Max flows changed, free the existing bitmap */
	kfree(tc->tc_entries_bitmap);
	
	...
}

Hello Leon Romanovsky,

It will kfree(tc->tc_entries_bitmap) firstly, and otx2_tc_alloc_ent_bitmap() is called by otx2_dl_mcam_count_set() and otx2_init_tc(). I am not sure their sequence and whether it will cause double free for tc->tc_entries_bitmap. So setting tc->tc_entries_bitmap to NULL is safe, I think.

Thank you!

Quoted 11 lines
Quoted 9 lines
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +2 -0
+	}
+	return err;
 }
 EXPORT_SYMBOL(otx2_init_tc);
 
Signature · 1 line
2.25.1

.

Reviewed-by
#3 lore raw
Quoted 34 lines · Ziyang Xuan (William)
Quoted 21 lines · Ziyang Xuan
Quoted 20 lines

In otx2_init_tc(), if rhashtable_init() failed, it does not free tc->tc_entries_bitmap which is allocated in otx2_tc_alloc_ent_bitmap().

Fixes 2e2a8126ffac ("octeontx2-pf: Unify flow management variables")

---
v2:
- Remove patch 2 which is not a problem, see the following link:

    https://www.spinics.net/lists/netdev/msg864159.html
---
 drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +0 -0
index e64318c110fd..6a01ab1a6e6f 100644
@@ -1134,7 +1134,12 @@ int otx2_init_tc(struct otx2_nic *nic)
 		return err;
 
Quoted 9 lines

drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c int otx2_init_tc(struct otx2_nic *nic) · line 1140

Quoted 6 lines
drivers/net/ethernet/marvell/octeontx2/nic/otx2_tc.c +4 -1
 	tc->flow_ht_params = tc_flow_ht_params;
-	return rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	err = rhashtable_init(&tc->flow_table, &tc->flow_ht_params);
+	if (err) {
+		kfree(tc->tc_entries_bitmap);
+		tc->tc_entries_bitmap = NULL;

Why do you set NULL here? All callers of otx2_init_tc() unwind error properly.

See the implementation of otx2_tc_alloc_ent_bitmap() as following:

int otx2_tc_alloc_ent_bitmap(struct otx2_nic *nic)

Quoted 8 lines
{
	struct otx2_tc_info *tc = &nic->tc_info;

	if (!nic->flow_cfg->max_flows)
		return 0;

	/* Max flows changed, free the existing bitmap */
	kfree(tc->tc_entries_bitmap);

It is worthless call for probe() calls as tc->tc_entries_bitmap is always NULL at this point for them.

The kfree(tc->tc_entries_bitmap); needs to be moved into otx2_dl_mcam_count_set() as it is the one place which can change bitmap.

But ok, it is probably too much to request.

Thanks,

#4 lore raw
In reply to Ziyang Xuan
This patch was applied to netdev/net.git (master) by David S. Miller <[email protected]>:

Hello:

This patch was applied to netdev/net.git (master)
by David S. Miller <[email protected]>:

Quoted 11 lines · On Fri, 2 Dec 2022 19:04:30 +0800 you wrote:

In otx2_init_tc(), if rhashtable_init() failed, it does not free tc->tc_entries_bitmap which is allocated in otx2_tc_alloc_ent_bitmap().

Fixes 2e2a8126ffac ("octeontx2-pf: Unify flow management variables")

---
v2:
- Remove patch 2 which is not a problem, see the following link:

    https://www.spinics.net/lists/netdev/msg864159.html

[...]

Here is the summary with links:
- [net,v2] octeontx2-pf: Fix potential memory leak in otx2_init_tc()

    https://git.kernel.org/netdev/net/c/fbf33f5ac76f

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html