mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH 0/3] Fix three Clang context analysis issues
@ 2026-11-16 22:59 Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 1/3] bit_spinlock: Fix the __bitlock() definition Bart Van Assche
                   ` (2 more replies)
  0 siblings, 3 replies; 9+ messages in thread
From: Bart Van Assche @ 2026-11-16 22:59 UTC (permalink / raw)
  To: Peter Zijlstra
  Cc: Ingo Molnar, Will Deacon, Boqun Feng, Waiman Long, linux-kernel,
	Marco Elver, Paul E . McKenney, Bart Van Assche

Hi Peter and Marco,

This patch series includes three context analysis fixes:
- bit_spinlock: Surround the bitnum argument and macro expansion in
  __bitlock() with parentheses to avoid operator precedence issues.
- cleanup: Mark __free() helper functions generated by DEFINE_FREE() as
  __context_unsafe() because cleanup expressions that unlock trigger
  Clang thread-safety false positives.
- srcu: Move __srcu_read_lock_must_hold() out of
  srcu_dereference_check() and into srcu_dereference() and
  srcu_dereference_notrace() so update-side callers satisfying the
  lockdep condition do not fail context analysis.

Please consider this patch series for the next merge window.

Thanks,

Bart.

Changes compared to v2:
- Split out only the three standalone context analysis fixes (v2 patches
  1, 2, and 4) into this series.
- Dropped the lockdep and RCU assertion behavior changes (v2 patches
  8-14: lockdep_assume_*(), lockdep_assume_in_rcu_*(), and removing
  context assumptions from lockdep_assert_held*() and
  lockdep_assert_in_rcu_*()), as agreed in the review discussion [2].
- Dropped the preparatory __must_hold*() annotation patches (v2 patches
  5-7) and the tracing branch profiling Kconfig patch (v2 patch 3) from
  this series.
- Updated the commit message of "cleanup: Disable context analysis for
  __free() helpers" with concrete examples of __free() unlock helpers
  in response to review feedback.
- Rebased onto current mainline.

Bart Van Assche (3):
  bit_spinlock: Fix the __bitlock() definition
  cleanup: Disable context analysis for __free() helpers
  srcu: Remove check from srcu_dereference_check()

 include/linux/bit_spinlock.h |  2 +-
 include/linux/cleanup.h      |  6 ++++--
 include/linux/srcu.h         | 20 +++++++++++++++-----
 3 files changed, 20 insertions(+), 8 deletions(-)


^ permalink raw reply	[flat|nested] 9+ messages in thread

* [PATCH v3 1/3] bit_spinlock: Fix the __bitlock() definition
  2026-11-16 22:59 [PATCH 0/3] Fix three Clang context analysis issues Bart Van Assche
@ 2026-11-16 22:59 ` Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 2/3] cleanup: Disable context analysis for __free() helpers Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check() Bart Van Assche
  2 siblings, 0 replies; 9+ messages in thread
From: Bart Van Assche @ 2026-11-16 22:59 UTC (permalink / raw)
  To: Peter Zijlstra
  Cc: Ingo Molnar, Will Deacon, Boqun Feng, Waiman Long, linux-kernel,
	Marco Elver, Paul E . McKenney, Bart Van Assche

Surround the bitnum argument and the entire __bitlock() macro expansion
with parentheses because bitnum could be an expression that includes an
operator with a lower precedence than the addition operator (e.g. the
exclusive-or operator) and to prevent operator precedence issues in
callers.

Reviewed-by: Marco Elver <elver@google.com>
Fixes: eb7d96a13bf4 ("bit_spinlock: Support Clang's context analysis")
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 include/linux/bit_spinlock.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/bit_spinlock.h b/include/linux/bit_spinlock.h
index 7869a6e59b6a..c31d4f4d09ee 100644
--- a/include/linux/bit_spinlock.h
+++ b/include/linux/bit_spinlock.h
@@ -17,7 +17,7 @@
  * static analysis can use.
  */
 context_lock_struct(__context_bitlock) { };
-#define __bitlock(bitnum, addr) (struct __context_bitlock *)(bitnum + (addr))
+#define __bitlock(bitnum, addr) ((struct __context_bitlock *)((bitnum) + (addr)))
 
 /*
  *  bit-based spin_lock()

^ permalink raw reply	[flat|nested] 9+ messages in thread

* [PATCH v3 2/3] cleanup: Disable context analysis for __free() helpers
  2026-11-16 22:59 [PATCH 0/3] Fix three Clang context analysis issues Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 1/3] bit_spinlock: Fix the __bitlock() definition Bart Van Assche
@ 2026-11-16 22:59 ` Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check() Bart Van Assche
  2 siblings, 0 replies; 9+ messages in thread
From: Bart Van Assche @ 2026-11-16 22:59 UTC (permalink / raw)
  To: Peter Zijlstra
  Cc: Ingo Molnar, Will Deacon, Boqun Feng, Waiman Long, linux-kernel,
	Marco Elver, Paul E . McKenney, Bart Van Assche,
	Nathan Chancellor, Dmitry Ilvokhin, Christian Brauner,
	H. Peter Anvin

The __free_##_name() helper functions defined by DEFINE_FREE() call the
free expression that has been passed to DEFINE_FREE(). If that
expression releases a lock, e.g. because it is a call to an unlock
function, the Clang thread-safety analyzer complains because it cannot
know that the variable that is passed to the helper function holds a
lock. This is needed by:
- __drm_for_each_bridge_in_chain_cleanup (include/drm/drm_bridge.h),
  used by drm_for_each_bridge_in_chain_scoped() and
  drm_for_each_bridge_in_chain_from_scoped().
- netdev_unlock (net/core/dev.h), used by for_each_netdev_lock_scoped().
- netdev_unlock_ops_compat (net/core/dev.h), used by
  for_each_netdev_lock_ops_compat_scoped().

Disable context analysis for the __free() helper functions.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 include/linux/cleanup.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
index 1fb8058b897d..f6afe80781a4 100644
--- a/include/linux/cleanup.h
+++ b/include/linux/cleanup.h
@@ -207,8 +207,10 @@
  * Without the NULL test it turns into a mess and the compiler can't help us.
  */
 
-#define DEFINE_FREE(_name, _type, _free) \
-	static __always_inline void __free_##_name(void *p) { _type _T = *(_type *)p; _free; }
+#define DEFINE_FREE(_name, _type, _free)				\
+	static __always_inline void __free_##_name(void *p)		\
+		__context_unsafe(/* _free may release a lock */)		\
+	{ _type _T = *(_type *)p; _free; }
 
 #define __free(_name)	__cleanup(__free_##_name)
 

^ permalink raw reply	[flat|nested] 9+ messages in thread

* [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check()
  2026-11-16 22:59 [PATCH 0/3] Fix three Clang context analysis issues Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 1/3] bit_spinlock: Fix the __bitlock() definition Bart Van Assche
  2026-11-16 22:59 ` [PATCH v3 2/3] cleanup: Disable context analysis for __free() helpers Bart Van Assche
@ 2026-11-16 22:59 ` Bart Van Assche
  2026-11-17  0:51   ` Paul E. McKenney
  2 siblings, 1 reply; 9+ messages in thread
From: Bart Van Assche @ 2026-11-16 22:59 UTC (permalink / raw)
  To: Peter Zijlstra
  Cc: Ingo Molnar, Will Deacon, Boqun Feng, Waiman Long, linux-kernel,
	Marco Elver, Paul E . McKenney, Bart Van Assche, Lai Jiangshan,
	Josh Triplett, Onur Özkan, Nathan Chancellor

Users of srcu_dereference_check() must either hold an SRCU reader lock
or satisfy the lockdep condition 'c', e.g. by holding the update-side
lock. However, srcu_dereference_check() calls
__srcu_read_lock_must_hold(), which tells the Clang context analyzer
that the SRCU reader lock must be held. That requirement is too strict
for update-side callers. Hence, remove the __srcu_read_lock_must_hold()
call from srcu_dereference_check() while keeping the fake RCU acquire
and release around __rcu_dereference_check(). Retain the runtime lockdep
check in srcu_dereference_check().

srcu_dereference() and srcu_dereference_notrace() do not accept a
lockdep condition and hence may only be used by SRCU readers. Call
__srcu_read_lock_must_hold() from these macros such that Clang context
analysis keeps verifying at compile time that their callers hold the
SRCU reader lock.

Cc: Marco Elver <elver@google.com>
Fixes: f0b7ce22d718 ("srcu: Support Clang's context analysis")
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 include/linux/srcu.h | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/include/linux/srcu.h b/include/linux/srcu.h
index d4dcaeb83e2b..5ef07357507b 100644
--- a/include/linux/srcu.h
+++ b/include/linux/srcu.h
@@ -278,8 +278,11 @@ static inline int srcu_read_lock_held(const struct srcu_struct *ssp)
  * No-op helper to denote that ssp must be held. Because SRCU-protected pointers
  * should still be marked with __rcu_guarded, and we do not want to mark them
  * with __guarded_by(ssp) as it would complicate annotations for writers, we
- * choose the following strategy: srcu_dereference_check() calls this helper
- * that checks that the passed ssp is held, and then fake-acquires 'RCU'.
+ * choose the following strategy: srcu_dereference() and
+ * srcu_dereference_notrace() call this helper that checks that the passed ssp
+ * is held, and srcu_dereference_check() fake-acquires 'RCU'.
+ * srcu_dereference_check() does not call this helper because its callers may
+ * satisfy the condition @c instead of holding ssp, e.g. on the update side.
  */
 static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __must_hold_shared(ssp) { }
 
@@ -297,7 +300,6 @@ static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __m
  */
 #define srcu_dereference_check(p, ssp, c)					\
 ({										\
-	__srcu_read_lock_must_hold(ssp);					\
 	__acquire_shared_ctx_lock(RCU);					\
 	__auto_type __v = __rcu_dereference_check((p), __UNIQUE_ID(rcu),	\
 				(c) || srcu_read_lock_held(ssp), __rcu);	\
@@ -315,7 +317,11 @@ static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __m
  * is enabled, invoking this outside of an RCU read-side critical
  * section will result in an RCU-lockdep splat.
  */
-#define srcu_dereference(p, ssp) srcu_dereference_check((p), (ssp), 0)
+#define srcu_dereference(p, ssp)					\
+({									\
+	__srcu_read_lock_must_hold(ssp);				\
+	srcu_dereference_check((p), (ssp), 0);				\
+})
 
 /**
  * srcu_dereference_notrace - no tracing and no lockdep calls from here
@@ -323,7 +329,11 @@ static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __m
  * @ssp: pointer to the srcu_struct, which is used to check that we
  *	really are in an SRCU read-side critical section.
  */
-#define srcu_dereference_notrace(p, ssp) srcu_dereference_check((p), (ssp), 1)
+#define srcu_dereference_notrace(p, ssp)				\
+({									\
+	__srcu_read_lock_must_hold(ssp);				\
+	srcu_dereference_check((p), (ssp), 1);				\
+})
 
 /**
  * srcu_read_lock - register a new reader for an SRCU-protected structure.

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check()
  2026-11-16 22:59 ` [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check() Bart Van Assche
@ 2026-11-17  0:51   ` Paul E. McKenney
  2026-11-17 16:53     ` Bart Van Assche
  0 siblings, 1 reply; 9+ messages in thread
From: Paul E. McKenney @ 2026-11-17  0:51 UTC (permalink / raw)
  To: Bart Van Assche
  Cc: Peter Zijlstra, Ingo Molnar, Will Deacon, Boqun Feng,
	Waiman Long, linux-kernel, Marco Elver, Lai Jiangshan,
	Josh Triplett, Onur Özkan, Nathan Chancellor

On Mon, Nov 16, 2026 at 02:59:35PM -0800, Bart Van Assche wrote:
> Users of srcu_dereference_check() must either hold an SRCU reader lock
> or satisfy the lockdep condition 'c', e.g. by holding the update-side
> lock. However, srcu_dereference_check() calls
> __srcu_read_lock_must_hold(), which tells the Clang context analyzer
> that the SRCU reader lock must be held. That requirement is too strict
> for update-side callers. Hence, remove the __srcu_read_lock_must_hold()
> call from srcu_dereference_check() while keeping the fake RCU acquire
> and release around __rcu_dereference_check(). Retain the runtime lockdep
> check in srcu_dereference_check().
> 
> srcu_dereference() and srcu_dereference_notrace() do not accept a
> lockdep condition and hence may only be used by SRCU readers. Call
> __srcu_read_lock_must_hold() from these macros such that Clang context
> analysis keeps verifying at compile time that their callers hold the
> SRCU reader lock.
> 
> Cc: Marco Elver <elver@google.com>
> Fixes: f0b7ce22d718 ("srcu: Support Clang's context analysis")
> Signed-off-by: Bart Van Assche <bvanassche@acm.org>

I clearly wasn't paying attention, and thank you for finding this!

> ---
>  include/linux/srcu.h | 20 +++++++++++++++-----
>  1 file changed, 15 insertions(+), 5 deletions(-)
> 
> diff --git a/include/linux/srcu.h b/include/linux/srcu.h
> index d4dcaeb83e2b..5ef07357507b 100644
> --- a/include/linux/srcu.h
> +++ b/include/linux/srcu.h
> @@ -278,8 +278,11 @@ static inline int srcu_read_lock_held(const struct srcu_struct *ssp)
>   * No-op helper to denote that ssp must be held. Because SRCU-protected pointers
>   * should still be marked with __rcu_guarded, and we do not want to mark them
>   * with __guarded_by(ssp) as it would complicate annotations for writers, we
> - * choose the following strategy: srcu_dereference_check() calls this helper
> - * that checks that the passed ssp is held, and then fake-acquires 'RCU'.
> + * choose the following strategy: srcu_dereference() and
> + * srcu_dereference_notrace() call this helper that checks that the passed ssp
> + * is held, and srcu_dereference_check() fake-acquires 'RCU'.
> + * srcu_dereference_check() does not call this helper because its callers may
> + * satisfy the condition @c instead of holding ssp, e.g. on the update side.
>   */
>  static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __must_hold_shared(ssp) { }
>  
> @@ -297,7 +300,6 @@ static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __m
>   */
>  #define srcu_dereference_check(p, ssp, c)					\
>  ({										\
> -	__srcu_read_lock_must_hold(ssp);					\

Should we invoke __srcu_read_lock_must_hold() conditionally, only if the
value of c is zero?

							Thanx, Paul

>  	__acquire_shared_ctx_lock(RCU);					\
>  	__auto_type __v = __rcu_dereference_check((p), __UNIQUE_ID(rcu),	\
>  				(c) || srcu_read_lock_held(ssp), __rcu);	\
> @@ -315,7 +317,11 @@ static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __m
>   * is enabled, invoking this outside of an RCU read-side critical
>   * section will result in an RCU-lockdep splat.
>   */
> -#define srcu_dereference(p, ssp) srcu_dereference_check((p), (ssp), 0)
> +#define srcu_dereference(p, ssp)					\
> +({									\
> +	__srcu_read_lock_must_hold(ssp);				\
> +	srcu_dereference_check((p), (ssp), 0);				\
> +})
>  
>  /**
>   * srcu_dereference_notrace - no tracing and no lockdep calls from here
> @@ -323,7 +329,11 @@ static inline void __srcu_read_lock_must_hold(const struct srcu_struct *ssp) __m
>   * @ssp: pointer to the srcu_struct, which is used to check that we
>   *	really are in an SRCU read-side critical section.
>   */
> -#define srcu_dereference_notrace(p, ssp) srcu_dereference_check((p), (ssp), 1)
> +#define srcu_dereference_notrace(p, ssp)				\
> +({									\
> +	__srcu_read_lock_must_hold(ssp);				\
> +	srcu_dereference_check((p), (ssp), 1);				\
> +})
>  
>  /**
>   * srcu_read_lock - register a new reader for an SRCU-protected structure.

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check()
  2026-11-17  0:51   ` Paul E. McKenney
@ 2026-11-17 16:53     ` Bart Van Assche
  2026-11-17 17:53       ` Paul E. McKenney
  0 siblings, 1 reply; 9+ messages in thread
From: Bart Van Assche @ 2026-11-17 16:53 UTC (permalink / raw)
  To: paulmck
  Cc: Peter Zijlstra, Ingo Molnar, Will Deacon, Boqun Feng,
	Waiman Long, linux-kernel, Marco Elver, Lai Jiangshan,
	Josh Triplett, Onur Özkan, Nathan Chancellor

On 11/16/26 4:51 PM, Paul E. McKenney wrote:
 > Should we invoke __srcu_read_lock_must_hold() conditionally, only if the
 > value of c is zero?

Hi Paul,

Thanks for the review. I don't think that would help. The Clang
context analysis is a compile-time analysis. It does not know the
runtime value of 'c', so a conditional call to
__srcu_read_lock_must_hold() only behaves differently from an
unconditional call if the compiler can evaluate 'c' at compile time:

- If 'c' is the constant 0, Clang removes the always-false edge and
   the call is checked. This is what srcu_dereference() does with
   this patch.

- If 'c' is the constant 1, the call is never checked. This is what
   srcu_dereference_notrace() would get. srcu_dereference_notrace()
   calls __srcu_read_lock_must_hold() directly, so it keeps the
   check.

- If 'c' is a real lockdep expression, e.g.
   lockdep_is_held(&foo->mutex), Clang can't evaluate it. The call
   stays reachable and is checked. That brings back the false
   positive for update-side callers that this patch fixes. With
   CONFIG_LOCKDEP=n, lockdep_is_held() becomes
   ({ (void)(lock); 1; }), so the result would also depend on the
   kernel config.

I checked this with a small test program built with clang
-Wthread-safety:

	#define deref_check(c) ({ if (!(c)) must_hold(&s); 0; })

	deref_check(0);                 /* warns, as expected       */
	deref_check(1);                 /* no warning               */
	deref_check(is_held(&m));       /* warns: false positive    */
	deref_check(({ (void)&m; 1; })) /* no warning (lockdep off) */

A conditional call would also evaluate 'c' outside the lockdep
checks, so it would run even when lockdep is disabled. Today 'c' is
only evaluated inside __rcu_dereference_check() when
CONFIG_PROVE_RCU=y.

So the only case where the conditional call helps is a constant 0,
and srcu_dereference() already covers that. Callers that pass a
literal 0 directly to srcu_dereference_check() can switch to
srcu_dereference(). The runtime check is unchanged: lockdep still
checks '(c) || srcu_read_lock_held(ssp)'.

Thanks,

Bart.

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check()
  2026-11-17 16:53     ` Bart Van Assche
@ 2026-11-17 17:53       ` Paul E. McKenney
  2026-11-17 18:20         ` Bart Van Assche
  0 siblings, 1 reply; 9+ messages in thread
From: Paul E. McKenney @ 2026-11-17 17:53 UTC (permalink / raw)
  To: Bart Van Assche
  Cc: Peter Zijlstra, Ingo Molnar, Will Deacon, Boqun Feng,
	Waiman Long, linux-kernel, Marco Elver, Lai Jiangshan,
	Josh Triplett, Onur Özkan, Nathan Chancellor

On Tue, Nov 17, 2026 at 08:53:52AM -0800, Bart Van Assche wrote:
> On 11/16/26 4:51 PM, Paul E. McKenney wrote:
> > Should we invoke __srcu_read_lock_must_hold() conditionally, only if the
> > value of c is zero?
> 
> Hi Paul,
> 
> Thanks for the review. I don't think that would help. The Clang
> context analysis is a compile-time analysis. It does not know the
> runtime value of 'c', so a conditional call to
> __srcu_read_lock_must_hold() only behaves differently from an
> unconditional call if the compiler can evaluate 'c' at compile time:
> 
> - If 'c' is the constant 0, Clang removes the always-false edge and
>   the call is checked. This is what srcu_dereference() does with
>   this patch.
> 
> - If 'c' is the constant 1, the call is never checked. This is what
>   srcu_dereference_notrace() would get. srcu_dereference_notrace()
>   calls __srcu_read_lock_must_hold() directly, so it keeps the
>   check.
> 
> - If 'c' is a real lockdep expression, e.g.
>   lockdep_is_held(&foo->mutex), Clang can't evaluate it. The call
>   stays reachable and is checked. That brings back the false
>   positive for update-side callers that this patch fixes. With
>   CONFIG_LOCKDEP=n, lockdep_is_held() becomes
>   ({ (void)(lock); 1; }), so the result would also depend on the
>   kernel config.
> 
> I checked this with a small test program built with clang
> -Wthread-safety:
> 
> 	#define deref_check(c) ({ if (!(c)) must_hold(&s); 0; })
> 
> 	deref_check(0);                 /* warns, as expected       */
> 	deref_check(1);                 /* no warning               */
> 	deref_check(is_held(&m));       /* warns: false positive    */
> 	deref_check(({ (void)&m; 1; })) /* no warning (lockdep off) */
> 
> A conditional call would also evaluate 'c' outside the lockdep
> checks, so it would run even when lockdep is disabled. Today 'c' is
> only evaluated inside __rcu_dereference_check() when
> CONFIG_PROVE_RCU=y.
> 
> So the only case where the conditional call helps is a constant 0,
> and srcu_dereference() already covers that. Callers that pass a
> literal 0 directly to srcu_dereference_check() can switch to
> srcu_dereference(). The runtime check is unchanged: lockdep still
> checks '(c) || srcu_read_lock_held(ssp)'.

Would __builtin_constant_p() help here?

If we don't have a build-time constant, don't check.

If we do have a build-time constant, check only if that constant has
the value zero, that is, there is no update-side protection.

Or am I still confused about what this is trying to do?

							Thanx, Paul

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check()
  2026-11-17 17:53       ` Paul E. McKenney
@ 2026-11-17 18:20         ` Bart Van Assche
  2026-11-17 18:44           ` Paul E. McKenney
  0 siblings, 1 reply; 9+ messages in thread
From: Bart Van Assche @ 2026-11-17 18:20 UTC (permalink / raw)
  To: paulmck
  Cc: Peter Zijlstra, Ingo Molnar, Will Deacon, Boqun Feng,
	Waiman Long, linux-kernel, Marco Elver, Lai Jiangshan,
	Josh Triplett, Onur Özkan, Nathan Chancellor

On 11/17/26 9:53 AM, Paul E. McKenney wrote:
 > Would __builtin_constant_p() help here?
 >
 > If we don't have a build-time constant, don't check.
 >
 > If we do have a build-time constant, check only if that constant has
 > the value zero, that is, there is no update-side protection.

Hi Paul,

Yes, that helps. I had missed this option. Something like the
following does what you describe:

	#define srcu_dereference_check(p, ssp, c)			\
	({								\
		if (__builtin_constant_p(c) && !(c))			\
			__srcu_read_lock_must_hold(ssp);		\
		__acquire_shared_ctx_lock(RCU);				\
		...

This also fixes the runtime problem I mentioned: the argument of
__builtin_constant_p() is never evaluated, and '!(c)' is only
evaluated if 'c' is a constant.

I tested this with clang -Wthread-safety at -O0 and -O2:

	c == 0                            -> checked (warns without
	                                     the SRCU read lock)
	c == 1                            -> not checked
	c == lockdep_is_held(&m)          -> not checked
	c == ({ (void)(&m); 1; })         -> not checked
	     (lockdep_is_held() with CONFIG_LOCKDEP=n)

There is one limitation. If 'c' is a plain variable, function
argument or structure member, e.g. srcu_dereference_check(p, ssp,
foo->flag), Clang does not resolve __builtin_constant_p() in the
front end. It leaves that to the optimizer, which may still find a
constant later. The context analysis then treats the call to
__srcu_read_lock_must_hold() as reachable and reports a false
positive. Clang does resolve __builtin_constant_p() to 0 when 'c'
contains a function call, and that covers lockdep_is_held(),
srcu_read_lock_held() and refcount_read(). In the current tree,
every srcu_dereference_check() caller passes either a constant or
an expression built from such calls, so this limitation doesn't
affect any existing caller.

So in v4 I plan to:
- call __srcu_read_lock_must_hold() from srcu_dereference_check()
   only if 'c' is the constant 0, as shown above;
- keep srcu_dereference() defined as
   srcu_dereference_check((p), (ssp), 0), which now gets the check
   automatically;
- keep the explicit __srcu_read_lock_must_hold() call in
   srcu_dereference_notrace(), because it passes 1 for 'c';
- update the comment above __srcu_read_lock_must_hold() and the
   patch description to match.

Does that sound good to you?

Thanks,

Bart.

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check()
  2026-11-17 18:20         ` Bart Van Assche
@ 2026-11-17 18:44           ` Paul E. McKenney
  0 siblings, 0 replies; 9+ messages in thread
From: Paul E. McKenney @ 2026-11-17 18:44 UTC (permalink / raw)
  To: Bart Van Assche
  Cc: Peter Zijlstra, Ingo Molnar, Will Deacon, Boqun Feng,
	Waiman Long, linux-kernel, Marco Elver, Lai Jiangshan,
	Josh Triplett, Onur Özkan, Nathan Chancellor

On Tue, Nov 17, 2026 at 10:20:31AM -0800, Bart Van Assche wrote:
> On 11/17/26 9:53 AM, Paul E. McKenney wrote:
> > Would __builtin_constant_p() help here?
> >
> > If we don't have a build-time constant, don't check.
> >
> > If we do have a build-time constant, check only if that constant has
> > the value zero, that is, there is no update-side protection.
> 
> Hi Paul,
> 
> Yes, that helps. I had missed this option. Something like the
> following does what you describe:
> 
> 	#define srcu_dereference_check(p, ssp, c)			\
> 	({								\
> 		if (__builtin_constant_p(c) && !(c))			\
> 			__srcu_read_lock_must_hold(ssp);		\
> 		__acquire_shared_ctx_lock(RCU);				\
> 		...
> 
> This also fixes the runtime problem I mentioned: the argument of
> __builtin_constant_p() is never evaluated, and '!(c)' is only
> evaluated if 'c' is a constant.
> 
> I tested this with clang -Wthread-safety at -O0 and -O2:
> 
> 	c == 0                            -> checked (warns without
> 	                                     the SRCU read lock)
> 	c == 1                            -> not checked
> 	c == lockdep_is_held(&m)          -> not checked
> 	c == ({ (void)(&m); 1; })         -> not checked
> 	     (lockdep_is_held() with CONFIG_LOCKDEP=n)
> 
> There is one limitation. If 'c' is a plain variable, function
> argument or structure member, e.g. srcu_dereference_check(p, ssp,
> foo->flag), Clang does not resolve __builtin_constant_p() in the
> front end. It leaves that to the optimizer, which may still find a
> constant later. The context analysis then treats the call to
> __srcu_read_lock_must_hold() as reachable and reports a false
> positive. Clang does resolve __builtin_constant_p() to 0 when 'c'
> contains a function call, and that covers lockdep_is_held(),
> srcu_read_lock_held() and refcount_read(). In the current tree,
> every srcu_dereference_check() caller passes either a constant or
> an expression built from such calls, so this limitation doesn't
> affect any existing caller.

Right you are!  Maybe __is_constexpr() would be better?

> So in v4 I plan to:
> - call __srcu_read_lock_must_hold() from srcu_dereference_check()
>   only if 'c' is the constant 0, as shown above;
> - keep srcu_dereference() defined as
>   srcu_dereference_check((p), (ssp), 0), which now gets the check
>   automatically;
> - keep the explicit __srcu_read_lock_must_hold() call in
>   srcu_dereference_notrace(), because it passes 1 for 'c';
> - update the comment above __srcu_read_lock_must_hold() and the
>   patch description to match.
> 
> Does that sound good to you?

Give or take potentially fixing my poor choice of macro to __is_constexpr(),
yes, please!

							Thanx, Paul

^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2026-11-17 18:44 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-11-16 22:59 [PATCH 0/3] Fix three Clang context analysis issues Bart Van Assche
2026-11-16 22:59 ` [PATCH v3 1/3] bit_spinlock: Fix the __bitlock() definition Bart Van Assche
2026-11-16 22:59 ` [PATCH v3 2/3] cleanup: Disable context analysis for __free() helpers Bart Van Assche
2026-11-16 22:59 ` [PATCH v3 3/3] srcu: Remove check from srcu_dereference_check() Bart Van Assche
2026-11-17  0:51   ` Paul E. McKenney
2026-11-17 16:53     ` Bart Van Assche
2026-11-17 17:53       ` Paul E. McKenney
2026-11-17 18:20         ` Bart Van Assche
2026-11-17 18:44           ` Paul E. McKenney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®