Skip to contentSkip to conversation

wifi: ath11k: fix event locking

PATCH In review Johan Hovold 4 participants 15 messages Oct 19, 2023 – Jan 22, 2024

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

v2 cover wifi: ath11k: fix event locking

RCU lockdep reported suspicious RCU usage when accessing the temperature sensor. Inspection revealed that the DFS radar event code was also missing the required RCU read-side critical section marking.

Johan

Changes in v2
- add the missing rcu_read_unlock() to an ath11k_wmi_pdev_temperature_event() error path as noticed by Jeff

Johan Hovold (2):
wifi: ath11k: fix temperature event locking
wifi: ath11k: fix dfs radar event locking

 drivers/net/wireless/ath/ath11k/wmi.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
Signature · 1 line
2.41.0
#1 lore raw

PATCH v2 1/2 wifi: ath11k: fix temperature event locking

The ath11k active pdevs are protected by RCU but the temperature event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section as reported by RCU lockdep:

	=============================
	WARNING: suspicious RCU usage
	6.6.0-rc6 #7 Not tainted
	-----------------------------
	drivers/net/wireless/ath/ath11k/mac.c:638 suspicious rcu_dereference_check() usage!

	other info that might help us debug this:

	rcu_scheduler_active = 2, debug_locks = 1
	no locks held by swapper/0/0.
	...
	Call trace:
	...
	 lockdep_rcu_suspicious+0x16c/0x22c
	 ath11k_mac_get_ar_by_pdev_id+0x194/0x1b0 [ath11k]
	 ath11k_wmi_tlv_op_rx+0xa84/0x2c1c [ath11k]
	 ath11k_htc_rx_completion_handler+0x388/0x510 [ath11k]

Mark the code in question as an RCU read-side critical section to avoid any potential use-after-free issues.

Fixes a41d10348b01 ("ath11k: add thermal sensor device support")
---
 drivers/net/wireless/ath/ath11k/wmi.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
drivers/net/wireless/ath/ath11k/wmi.c +5 -2
index 23ad6825e5be..da1582b8dc30 100644
@@ -8383,14 +8383,17 @@ ath11k_wmi_pdev_temperature_event(struct ath11k_base *ab,
 	ath11k_dbg(ab, ATH11K_DBG_WMI, "event pdev temperature ev temp %d pdev_id %d\n",
 		   ev->temp, ev->pdev_id);
 
+	rcu_read_lock();
+
 	ar = ath11k_mac_get_ar_by_pdev_id(ab, ev->pdev_id);
 	if (!ar) {
 		ath11k_warn(ab, "invalid pdev id in pdev temperature ev %d", ev->pdev_id);
-		kfree(tb);
-		return;
+		goto exit;
 	}
 
 	ath11k_thermal_event_temperature(ar, ev->temp);
+exit:
+	rcu_read_unlock();
 
 	kfree(tb);
 }
Signature · 1 line
2.41.0
Acked-by on v2 1/2
#2 lore raw

Re: [PATCH v2 1/2] wifi: ath11k: fix temperature event locking

Quoted 22 lines · Johan Hovold

The ath11k active pdevs are protected by RCU but the temperature event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section as reported by RCU lockdep:

	=============================
	WARNING: suspicious RCU usage
	6.6.0-rc6 #7 Not tainted
	-----------------------------
	drivers/net/wireless/ath/ath11k/mac.c:638 suspicious rcu_dereference_check() usage!

	other info that might help us debug this:

	rcu_scheduler_active = 2, debug_locks = 1
	no locks held by swapper/0/0.
	...
	Call trace:
	...
	 lockdep_rcu_suspicious+0x16c/0x22c
	 ath11k_mac_get_ar_by_pdev_id+0x194/0x1b0 [ath11k]
	 ath11k_wmi_tlv_op_rx+0xa84/0x2c1c [ath11k]
	 ath11k_htc_rx_completion_handler+0x388/0x510 [ath11k]
Quoted 6 lines

Mark the code in question as an RCU read-side critical section to avoid any potential use-after-free issues.

Fixes a41d10348b01 ("ath11k: add thermal sensor device support")
Signature · 3 lines
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#3 lore raw

Re: [PATCH v2 1/2] wifi: ath11k: fix temperature event locking

In reply to Johan Hovold
Quoted 22 lines · Johan Hovold

The ath11k active pdevs are protected by RCU but the temperature event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section as reported by RCU lockdep:

	=============================
	WARNING: suspicious RCU usage
	6.6.0-rc6 #7 Not tainted
	-----------------------------
	drivers/net/wireless/ath/ath11k/mac.c:638 suspicious rcu_dereference_check() usage!

	other info that might help us debug this:

	rcu_scheduler_active = 2, debug_locks = 1
	no locks held by swapper/0/0.
	...
	Call trace:
	...
	 lockdep_rcu_suspicious+0x16c/0x22c
	 ath11k_mac_get_ar_by_pdev_id+0x194/0x1b0 [ath11k]
	 ath11k_wmi_tlv_op_rx+0xa84/0x2c1c [ath11k]
	 ath11k_htc_rx_completion_handler+0x388/0x510 [ath11k]
Quoted 6 lines

Mark the code in question as an RCU read-side critical section to avoid any potential use-after-free issues.

Fixes a41d10348b01 ("ath11k: add thermal sensor device support")

On what hardware and firmware version did you test this? As there's so many different combos we use Tested-on tag to provide that information in the commit message:

https://wireless.wiki.kernel.org/en/users/drivers/ath11k/submittingpatches#tested-on_tag

I can add that if you let me know what you used.

Signature · 8 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

-- 
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#4 lore raw

Re: [PATCH v2 1/2] wifi: ath11k: fix temperature event locking

Quoted 6 lines · Kalle Valo
Quoted 3 lines · Johan Hovold

The ath11k active pdevs are protected by RCU but the temperature event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section as reported by RCU lockdep:

Quoted 7 lines

On what hardware and firmware version did you test this? As there's so many different combos we use Tested-on tag to provide that information in the commit message:

https://wireless.wiki.kernel.org/en/users/drivers/ath11k/submittingpatches#tested-on_tag

I can add that if you let me know what you used.

I hit this on the Lenovo Thinkpad X13s and I guess the tag should be:

Tested-on: QCNFA765 hw2.1 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

Note that I've only been able to test the ath11k fixes (not the corresponding ath12k) and I only tested this particular patch fully (e.g. since I didn't trigger any radar events).

Johan

Signature · 3 lines
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#5 lore raw

Re: [PATCH v2 1/2] wifi: ath11k: fix temperature event locking

Quoted 11 lines · Johan Hovold
Quoted 10 lines · Kalle Valo
Quoted 3 lines · Johan Hovold

The ath11k active pdevs are protected by RCU but the temperature event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section as reported by RCU lockdep:

On what hardware and firmware version did you test this? As there's so many different combos we use Tested-on tag to provide that information in the commit message:

Quoted 7 lines
Quoted 3 lines

https://wireless.wiki.kernel.org/en/users/drivers/ath11k/submittingpatches#tested-on_tag

I can add that if you let me know what you used.

I hit this on the Lenovo Thinkpad X13s and I guess the tag should be:

Tested-on: QCNFA765 hw2.1 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

From ath11k point of view QCNFA765 is WCN6855 so I used this one:

Tested-on: WCN6855 hw2.1 PCI WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

Quoted 2 lines

Note that I've only been able to test the ath11k fixes (not the corresponding ath12k) and I only tested this particular patch fully

Thanks, I added Tested-on to this patch 1 and for the rest I added "compile tested only".

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#6 lore raw

Re: [PATCH v2 1/2] wifi: ath11k: fix temperature event locking

Quoted 8 lines · Kalle Valo
Quoted 3 lines · Johan Hovold

I hit this on the Lenovo Thinkpad X13s and I guess the tag should be:

Tested-on: QCNFA765 hw2.1 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

From ath11k point of view QCNFA765 is WCN6855 so I used this one:

Quoted 7 lines

Tested-on: WCN6855 hw2.1 PCI WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

Quoted 2 lines

Note that I've only been able to test the ath11k fixes (not the corresponding ath12k) and I only tested this particular patch fully

Thanks, I added Tested-on to this patch 1 and for the rest I added "compile tested only".

Thanks for fixing that, I'll try to remember the Tested-on tag next time.

Johan

#7 lore raw

Re: [PATCH v2 1/2] wifi: ath11k: fix temperature event locking

In reply to Johan Hovold
Quoted 25 lines · Johan Hovold

The ath11k active pdevs are protected by RCU but the temperature event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section as reported by RCU lockdep:

        =============================
        WARNING: suspicious RCU usage
        6.6.0-rc6 #7 Not tainted
        -----------------------------
        drivers/net/wireless/ath/ath11k/mac.c:638 suspicious rcu_dereference_check() usage!

        other info that might help us debug this:

        rcu_scheduler_active = 2, debug_locks = 1
        no locks held by swapper/0/0.
        ...
        Call trace:
        ...
         lockdep_rcu_suspicious+0x16c/0x22c
         ath11k_mac_get_ar_by_pdev_id+0x194/0x1b0 [ath11k]
         ath11k_wmi_tlv_op_rx+0xa84/0x2c1c [ath11k]
         ath11k_htc_rx_completion_handler+0x388/0x510 [ath11k]

Mark the code in question as an RCU read-side critical section to avoid any potential use-after-free issues.

Quoted 7 lines

Tested-on: WCN6855 hw2.1 PCI WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

Fixes a41d10348b01 ("ath11k: add thermal sensor device support")

2 patches applied to ath-next branch of ath.git, thanks.

1a5352a81b47 wifi: ath11k: fix temperature event locking 3b6c14833165 wifi: ath11k: fix dfs radar event locking

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/patch/[email protected]/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#8 lore raw

PATCH v2 2/2 wifi: ath11k: fix dfs radar event locking

In reply to Johan Hovold

The ath11k active pdevs are protected by RCU but the DFS radar event handling code calling ath11k_mac_get_ar_by_pdev_id() was not marked as a read-side critical section.

Mark the code in question as an RCU read-side critical section to avoid any potential use-after-free issues.

Fixes d5c65159f289 ("ath11k: driver for Qualcomm IEEE 802.11ax devices")
---
 drivers/net/wireless/ath/ath11k/wmi.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/net/wireless/ath/ath11k/wmi.c +4 -0
index da1582b8dc30..f0eac6cb84fd 100644
@@ -8337,6 +8337,8 @@ ath11k_wmi_pdev_dfs_radar_detected_event(struct ath11k_base *ab, struct sk_buff
 		   ev->detector_id, ev->segment_id, ev->timestamp, ev->is_chirp,
 		   ev->freq_offset, ev->sidx);
 
+	rcu_read_lock();
+
 	ar = ath11k_mac_get_ar_by_pdev_id(ab, ev->pdev_id);
 
 	if (!ar) {
@@ -8354,6 +8356,8 @@ ath11k_wmi_pdev_dfs_radar_detected_event(struct ath11k_base *ab, struct sk_buff
 		ieee80211_radar_detected(ar->hw);
 
 exit:
+	rcu_read_unlock();
+
 	kfree(tb);
 }
 
Signature · 1 line
2.41.0
#9 lore raw
In reply to Johan Hovold
Quoted 7 lines · Johan Hovold

RCU lockdep reported suspicious RCU usage when accessing the temperature sensor. Inspection revealed that the DFS radar event code was also missing the required RCU read-side critical section marking.

Johan

Quoted 8 lines

Changes in v2
- add the missing rcu_read_unlock() to an ath11k_wmi_pdev_temperature_event() error path as noticed by Jeff

Johan Hovold (2):
wifi: ath11k: fix temperature event locking
wifi: ath11k: fix dfs radar event locking

Thanks for the fixes. I really like using lockdep_assert_held() to document if a function requires some lock held, is there anything similar for RCU?

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#10 lore raw
Quoted 14 lines · Kalle Valo
Quoted 12 lines · Johan Hovold

RCU lockdep reported suspicious RCU usage when accessing the temperature sensor. Inspection revealed that the DFS radar event code was also missing the required RCU read-side critical section marking.

Johan

Changes in v2
- add the missing rcu_read_unlock() to an ath11k_wmi_pdev_temperature_event() error path as noticed by Jeff

Quoted 7 lines
Quoted 3 lines

Johan Hovold (2):
wifi: ath11k: fix temperature event locking
wifi: ath11k: fix dfs radar event locking

Thanks for the fixes. I really like using lockdep_assert_held() to document if a function requires some lock held, is there anything similar for RCU?

Not really, but the checking is instead built into the primitives like rcu_dereference() and enabled whenever CONFIG_PROVE_RCU is set.

For some special cases, we have open-coded checks like:

	RCU_LOCKDEP_WARN(!rcu_read_lock_held());

which similarly depend on CONFIG_PROVE_RCU or simply

	WARN_ON_ONCE(!rcu_read_lock_held());

Johan

Signature · 3 lines
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#11 lore raw

ath11k: checking RCU usage

(old discussion, changing title)

Quoted 27 lines · Johan Hovold
Quoted 14 lines · Kalle Valo
Quoted 12 lines · Johan Hovold

RCU lockdep reported suspicious RCU usage when accessing the temperature sensor. Inspection revealed that the DFS radar event code was also missing the required RCU read-side critical section marking.

Johan

Changes in v2
- add the missing rcu_read_unlock() to an ath11k_wmi_pdev_temperature_event() error path as noticed by Jeff

Quoted 7 lines
Quoted 3 lines

Johan Hovold (2):
wifi: ath11k: fix temperature event locking
wifi: ath11k: fix dfs radar event locking

Thanks for the fixes. I really like using lockdep_assert_held() to document if a function requires some lock held, is there anything similar for RCU?

Not really, but the checking is instead built into the primitives like rcu_dereference() and enabled whenever CONFIG_PROVE_RCU is set.

Quoted 7 lines

For some special cases, we have open-coded checks like:

	RCU_LOCKDEP_WARN(!rcu_read_lock_held());

which similarly depend on CONFIG_PROVE_RCU or simply

	WARN_ON_ONCE(!rcu_read_lock_held());

I just found out that sparse has __must_hold():

https://lore.kernel.org/linux-wireless/[email protected]/

That looks promising, should we start using that in ath11k and ath12k to check our RCU usage?

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#12 lore raw

Re: ath11k: checking RCU usage

Hi Kalle,

Quoted 19 lines · Kalle Valo

(old discussion, changing title)

Quoted 15 lines · Johan Hovold
Quoted 3 lines · Kalle Valo

Thanks for the fixes. I really like using lockdep_assert_held() to document if a function requires some lock held, is there anything similar for RCU?

Not really, but the checking is instead built into the primitives like rcu_dereference() and enabled whenever CONFIG_PROVE_RCU is set.

For some special cases, we have open-coded checks like:

	RCU_LOCKDEP_WARN(!rcu_read_lock_held());

which similarly depend on CONFIG_PROVE_RCU or simply

Quoted 8 lines
Quoted 1 line
	WARN_ON_ONCE(!rcu_read_lock_held());

I just found out that sparse has __must_hold():

https://lore.kernel.org/linux-wireless/[email protected]/

That looks promising, should we start using that in ath11k and ath12k to check our RCU usage?

I see that Johannes already commented on this in the thread above.

I'm pretty sure smatch can't be used for this.

Johan

#13 lore raw

Re: ath11k: checking RCU usage

Quoted 4 lines · Johan Hovold
Quoted 2 lines · Kalle Valo

I just found out that sparse has __must_hold():

Quoted 8 lines
Quoted 4 lines

https://lore.kernel.org/linux-wireless/[email protected]/

That looks promising, should we start using that in ath11k and ath12k to check our RCU usage?

I see that Johannes already commented on this in the thread above.

I'm pretty sure smatch can't be used for this.

I meant "sparse"...

Johan

#14 lore raw

Re: ath11k: checking RCU usage

Quoted 7 lines · Johan Hovold
Quoted 6 lines · Johan Hovold
Quoted 4 lines · Kalle Valo

I just found out that sparse has __must_hold():

https://lore.kernel.org/linux-wireless/[email protected]/

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

That looks promising, should we start using that in ath11k and ath12k to check our RCU usage?

I see that Johannes already commented on this in the thread above.

I'm pretty sure smatch can't be used for this.

I meant "sparse"...

Yeah, that was a disappointment. I should have tested it first :)

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches