Skip to contentSkip to conversation

wifi: rtw88: usb: fix memory leaks on USB write failures

PATCH Superseded [email protected] 2 participants 3 messages May 13 – May 18

Subsystems (2)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 wifi: rtw88: usb: fix memory leaks on USB write failures

From: Luka Gejak <[email protected]>

When rtw_usb_write_port() fails to submit a USB Request Block (URB) (e.g., due to device disconnect or ENOMEM), the completion callback is never executed.

Currently, the driver ignores the return value of rtw_usb_write_port() in rtw_usb_write_data() and rtw_usb_tx_agg_skb(). Because these functions rely on the completion callback to free the socket buffers (skbs) and the transaction control block (txcb), a submission failure results in:
1. A memory leak of the allocated skb in rtw_usb_write_data().
2. A memory leak of the txcb structure and all aggregated skbs in rtw_usb_tx_agg_skb().

Fix this by checking the return value of rtw_usb_write_port(). If it fails, explicitly free the skb in rtw_usb_write_data(), and properly purge the tx_ack_queue and free the txcb in rtw_usb_tx_agg_skb().

The issue was discovered in practice during device disconnect/reconnect scenarios and memory pressure conditions. Tested by verifying normal TX operation continues after the fix without regressions.

Fixes a82dfd33d123 ("wifi: rtw88: Add common USB chip support")

---
Changes in v3:
- Updated the Fixes tag to the commit that introduced USB support.
Changes in v2:
- Use ret = rtw_usb_write_port(...); style, and check by next line (in rtw_usb_tx_agg_skb)
- Remove unnecessary comment
- Use ieee80211_purge_tx_queue() instead of skb_queue_purge()
- Add testing details to commit message

 drivers/net/wireless/realtek/rtw88/usb.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/net/wireless/realtek/rtw88/usb.c +11 -2
index 718940ebba31..1bb922cc2928 100644
@@ -399,6 +399,7 @@ static bool rtw_usb_tx_agg_skb(struct rtw_usb *rtwusb, struct sk_buff_head *list
 	int agg_num = 0;
 	unsigned int align_next = 0;
 	u8 qsel;
+	int ret;
 
 	if (skb_queue_empty(list))
 		return false;
@@ -456,7 +457,13 @@ static bool rtw_usb_tx_agg_skb(struct rtw_usb *rtwusb, struct sk_buff_head *list
 	tx_desc = (struct rtw_tx_desc *)skb_head->data;
 	qsel = le32_get_bits(tx_desc->w1, RTW_TX_DESC_W1_QSEL);
 
-	rtw_usb_write_port(rtwdev, qsel, skb_head, rtw_usb_write_port_tx_complete, txcb);
+	ret = rtw_usb_write_port(rtwdev, qsel, skb_head,
+			         rtw_usb_write_port_tx_complete, txcb);
+	if (ret) {
+		ieee80211_purge_tx_queue(rtwdev->hw, &txcb->tx_ack_queue);
+		kfree(txcb);
+		return false;
+	}
 
 	return true;
 }
@@ -518,8 +525,10 @@ static int rtw_usb_write_data(struct rtw_dev *rtwdev,
 
 	ret = rtw_usb_write_port(rtwdev, qsel, skb,
 				 rtw_usb_write_port_complete, skb);
-	if (unlikely(ret))
+	if (unlikely(ret)) {
 		rtw_err(rtwdev, "failed to do USB write, ret=%d\n", ret);
+		dev_kfree_skb_any(skb);
+	}
 
 	return ret;
 }
Signature · 1 line
2.54.0
maintainer Acked-by on v3 1/1
#1 lore raw
Quoted 19 lines · [email protected] <[email protected]> wrote:

From: Luka Gejak <[email protected]>

When rtw_usb_write_port() fails to submit a USB Request Block (URB) (e.g., due to device disconnect or ENOMEM), the completion callback is never executed.

Currently, the driver ignores the return value of rtw_usb_write_port() in rtw_usb_write_data() and rtw_usb_tx_agg_skb(). Because these functions rely on the completion callback to free the socket buffers (skbs) and the transaction control block (txcb), a submission failure results in:
1. A memory leak of the allocated skb in rtw_usb_write_data().
2. A memory leak of the txcb structure and all aggregated skbs in rtw_usb_tx_agg_skb().

Fix this by checking the return value of rtw_usb_write_port(). If it fails, explicitly free the skb in rtw_usb_write_data(), and properly purge the tx_ack_queue and free the txcb in rtw_usb_tx_agg_skb().

Quoted 8 lines

The issue was discovered in practice during device disconnect/reconnect scenarios and memory pressure conditions. Tested by verifying normal TX operation continues after the fix without regressions.

Fixes a82dfd33d123 ("wifi: rtw88: Add common USB chip support")
maintainer
#2 lore raw
In reply to [email protected]

drivers/net/wireless/realtek/rtw88/usb.c static bool rtw_usb_tx_agg_skb(struct rtw_usb *rtwusb, struct sk_buff_head *list · line 461

Quoted 7 lines
drivers/net/wireless/realtek/rtw88/usb.c +2 -1
@@ -456,7 +457,13 @@ static bool rtw_usb_tx_agg_skb(struct rtw_usb *rtwusb, struct sk_buff_head *list
        tx_desc = (struct rtw_tx_desc *)skb_head->data;
        qsel = le32_get_bits(tx_desc->w1, RTW_TX_DESC_W1_QSEL);
 
-       rtw_usb_write_port(rtwdev, qsel, skb_head, rtw_usb_write_port_tx_complete, txcb);
+       ret = rtw_usb_write_port(rtwdev, qsel, skb_head,
+                                rtw_usb_write_port_tx_complete, txcb);

ERROR: code indent should use tabs where possible #54: FILE: drivers/net/wireless/realtek/rtw88/usb.c:461:
+^I^I^I rtw_usb_write_port_tx_complete, txcb);$

CHECK: Alignment should match open parenthesis #54: FILE: drivers/net/wireless/realtek/rtw88/usb.c:461:
+ ret = rtw_usb_write_port(rtwdev, qsel, skb_head,
+ rtw_usb_write_port_tx_complete, txcb);

Please correct them and resend v4. (You can take my acked-by in v3)

Quoted 8 lines
drivers/net/wireless/realtek/rtw88/usb.c +5 -0
+       if (ret) {
+               ieee80211_purge_tx_queue(rtwdev->hw, &txcb->tx_ack_queue);
+               kfree(txcb);
+               return false;
+       }
 
        return true;
 }