Skip to contentSkip to conversation

bluetooth: hci_h5: fix memory leak in h5_close

PATCH Superseded Anant Thazhemadam 2 participants 4 messages Oct 7, 2020 – Oct 16, 2020 Bluetooth drivers

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 bluetooth: hci_h5: fix memory leak in h5_close

If h5_close is called when !hu->serdev, h5 is directly freed. However, h5->rx_skb is not freed, which causes a memory leak.

Freeing h5->rx_skb fixes this memory leak.

In case hu->serdev exists, h5->rx_skb is then set to NULL, since we do not want to risk a potential NULL pointer dereference.

Fixes ce945552fde4 ("Bluetooth: hci_h5: Add support for serdev enumerated devices")
Reported-by [email protected]

---
Changes in v4:
* Free h5->rx_skb even when hu->serdev (Suggested by Hans de Goede <[email protected]>)
* If hu->serdev, then assign h5->rx_skb = NULL

Changes in v3:
* Free h5->rx_skb when !hu->serdev, and fix the memory leak
* Do not incorrectly and unnecessarily call serdev_device_close()

Changes in v2:
* Fixed the Fixes tag

 drivers/bluetooth/hci_h5.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/bluetooth/hci_h5.c +4 -0
index e41854e0d79a..39f9553caa5c 100644
@@ -245,11 +245,15 @@ static int h5_close(struct hci_uart *hu)
 	skb_queue_purge(&h5->rel);
 	skb_queue_purge(&h5->unrel);
 
+	kfree_skb(h5->rx_skb);
+
 	if (h5->vnd && h5->vnd->close)
 		h5->vnd->close(h5);
 
 	if (!hu->serdev)
 		kfree(h5);
+	else
+		h5->rx_skb = NULL;
 
 	return 0;
 }
Signature · 1 line
2.25.1
#1 lore raw

Hi,

Quoted 36 lines · Anant Thazhemadam

If h5_close is called when !hu->serdev, h5 is directly freed. However, h5->rx_skb is not freed, which causes a memory leak.

Freeing h5->rx_skb fixes this memory leak.

In case hu->serdev exists, h5->rx_skb is then set to NULL, since we do not want to risk a potential NULL pointer dereference.

Fixes ce945552fde4 ("Bluetooth: hci_h5: Add support for serdev enumerated devices")
Reported-by [email protected]

---
Changes in v4:
* Free h5->rx_skb even when hu->serdev (Suggested by Hans de Goede <[email protected]>)
* If hu->serdev, then assign h5->rx_skb = NULL

Changes in v3:
* Free h5->rx_skb when !hu->serdev, and fix the memory leak
* Do not incorrectly and unnecessarily call serdev_device_close()

Changes in v2:
* Fixed the Fixes tag

 drivers/bluetooth/hci_h5.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/bluetooth/hci_h5.c +0 -0
index e41854e0d79a..39f9553caa5c 100644
@@ -245,11 +245,15 @@ static int h5_close(struct hci_uart *hu)
 	skb_queue_purge(&h5->rel);
 	skb_queue_purge(&h5->unrel);

drivers/bluetooth/hci_h5.c static int h5_close(struct hci_uart *hu) · line 256

Quoted 10 lines
drivers/bluetooth/hci_h5.c +4 -0
 
+	kfree_skb(h5->rx_skb);
+
 	if (h5->vnd && h5->vnd->close)
 		h5->vnd->close(h5);
 
 	if (!hu->serdev)
 		kfree(h5);
+	else
+		h5->rx_skb = NULL;

Please just do this unconditionally directly after the kfree_skb()

So after this comment has been addressed the end result should look like this:

	skb_queue_purge(&h5->rel);
	skb_queue_purge(&h5->unrel);
	kfree_skb(h5->rx_skb);
	h5->rx_skb = NULL;

	if (h5->vnd && h5->vnd->close)
		h5->vnd->close(h5);

	if (!hu->serdev)
		kfree(h5);

return 0;

Regards,

Hans

#2 lore raw

Hi,

Quoted 45 lines · Hans de Goede

Hi,

Quoted 42 lines · Anant Thazhemadam

If h5_close is called when !hu->serdev, h5 is directly freed. However, h5->rx_skb is not freed, which causes a memory leak.

Freeing h5->rx_skb fixes this memory leak.

In case hu->serdev exists, h5->rx_skb is then set to NULL, since we do not want to risk a potential NULL pointer dereference.

Fixes ce945552fde4 ("Bluetooth: hci_h5: Add support for serdev enumerated devices")
Reported-by [email protected]

---
Changes in v4:
* Free h5->rx_skb even when hu->serdev (Suggested by Hans de Goede <[email protected]>)
* If hu->serdev, then assign h5->rx_skb = NULL

Changes in v3:
* Free h5->rx_skb when !hu->serdev, and fix the memory leak
* Do not incorrectly and unnecessarily call serdev_device_close()

Changes in v2:
* Fixed the Fixes tag

 drivers/bluetooth/hci_h5.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/bluetooth/hci_h5.c +2 -0
index e41854e0d79a..39f9553caa5c 100644
@@ -245,11 +245,15 @@ static int h5_close(struct hci_uart *hu)
 	skb_queue_purge(&h5->rel);
 	skb_queue_purge(&h5->unrel);
 
+	kfree_skb(h5->rx_skb);
+
 	if (h5->vnd && h5->vnd->close)
 		h5->vnd->close(h5);
 
Quoted 6 lines

drivers/bluetooth/hci_h5.c static int h5_close(struct hci_uart *hu) · line 256

Quoted 4 lines
drivers/bluetooth/hci_h5.c +2 -0
 	if (!hu->serdev)
 		kfree(h5);
+	else
+		h5->rx_skb = NULL;

Please just do this unconditionally directly after the kfree_skb()

Could you also please tell me why this might be necessary?
The pointer value stored at h5->rx_skb would be freed anyways when we free h5 (since rx_skb is essentially a member of the structure that h5 points to).
Also since we're performing the *if* check, the *else* condition wouldn't exactly be taxing either, right?
Is there some performance metric that I'm missing where unconditionally setting it to NULL in this manner would be better? (I couldn't find any resources that had any similar analysis performed :/ )
Or is this in interest of code readability?

Also, how about we introduce a h5 = NULL, after freeing h5 when !hu->serdev?

Thank you for your time.

Thanks,
Anant

#3 lore raw

Hi,

Quoted 56 lines · Anant Thazhemadam

Hi,

Quoted 45 lines · Hans de Goede

Hi,

Quoted 42 lines · Anant Thazhemadam

If h5_close is called when !hu->serdev, h5 is directly freed. However, h5->rx_skb is not freed, which causes a memory leak.

Freeing h5->rx_skb fixes this memory leak.

In case hu->serdev exists, h5->rx_skb is then set to NULL, since we do not want to risk a potential NULL pointer dereference.

Fixes ce945552fde4 ("Bluetooth: hci_h5: Add support for serdev enumerated devices")
Reported-by [email protected]

---
Changes in v4:
* Free h5->rx_skb even when hu->serdev (Suggested by Hans de Goede <[email protected]>)
* If hu->serdev, then assign h5->rx_skb = NULL

Changes in v3:
* Free h5->rx_skb when !hu->serdev, and fix the memory leak
* Do not incorrectly and unnecessarily call serdev_device_close()

Changes in v2:
* Fixed the Fixes tag

 drivers/bluetooth/hci_h5.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/bluetooth/hci_h5.c +2 -0
index e41854e0d79a..39f9553caa5c 100644
@@ -245,11 +245,15 @@ static int h5_close(struct hci_uart *hu)
 	skb_queue_purge(&h5->rel);
 	skb_queue_purge(&h5->unrel);
 
+	kfree_skb(h5->rx_skb);
+
 	if (h5->vnd && h5->vnd->close)
 		h5->vnd->close(h5);
 
Quoted 6 lines

drivers/bluetooth/hci_h5.c static int h5_close(struct hci_uart *hu) · line 256

Quoted 4 lines
drivers/bluetooth/hci_h5.c +2 -0
 	if (!hu->serdev)
 		kfree(h5);
+	else
+		h5->rx_skb = NULL;

Please just do this unconditionally directly after the kfree_skb()

Quoted 3 lines

Could you also please tell me why this might be necessary?
The pointer value stored at h5->rx_skb would be freed anyways when we free h5 (since rx_skb is essentially a member of the structure that h5 points to).

It is necessary in the path where the struct h5 points to is not free-ed and it is cleaner to just always do it then, as you indicate yourself

Quoted 2 lines

Also since we're performing the *if* check, the *else* condition wouldn't exactly be taxing either, right?

For the computer it is not taxing, but for a human reading the code and trying to understand the flow it makes things extra complicated unnecessarily.

Quoted 4 lines

Is there some performance metric that I'm missing where unconditionally setting it to NULL in this manner would be better? (I couldn't find any resources that had any similar analysis performed :/ )
Or is this in interest of code readability?

Yes, it is in interest of code readability?

Quoted 1 line

Also, how about we introduce a h5 = NULL, after freeing h5 when !hu->serdev?

That is not necessary, there is no reason to have that in either code path.

Regards,

Hans

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees