mirror of
https://github.com/torvalds/linux.git
synced 2026-03-08 03:04:51 +01:00
compiler-context-analysis: Remove Sparse support
Remove Sparse support as discussed at [1].
The kernel codebase is still scattered with numerous places that try to
appease Sparse's context tracking ("annotation for sparse", "fake out
sparse", "work around sparse", etc.). Eventually, as more subsystems
enable Clang's context analysis, these places will show up and need
adjustment or removal of the workarounds altogether.
Signed-off-by: Marco Elver <elver@google.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Link: https://lore.kernel.org/all/20250207083335.GW7145@noisy.programming.kicks-ass.net/ [1]
Link: https://lore.kernel.org/all/Z6XTKTo_LMj9KmbY@elver.google.com/ [2]
Link: https://patch.msgid.link/20251219154418.3592607-24-elver@google.com
This commit is contained in:
Marco Elver
Peter Zijlstra
parent
4f109baeea
commit
5b63d0ae94
3 changed files with 27 additions and 90 deletions
|
|
@ -53,25 +53,6 @@ sure that bitwise types don't get mixed up (little-endian vs big-endian
|
|||
vs cpu-endian vs whatever), and there the constant "0" really _is_
|
||||
special.
|
||||
|
||||
Using sparse for lock checking
|
||||
------------------------------
|
||||
|
||||
The following macros are undefined for gcc and defined during a sparse
|
||||
run to use the "context" tracking feature of sparse, applied to
|
||||
locking. These annotations tell sparse when a lock is held, with
|
||||
regard to the annotated function's entry and exit.
|
||||
|
||||
__must_hold - The specified lock is held on function entry and exit.
|
||||
|
||||
__acquires - The specified lock is held on function exit, but not entry.
|
||||
|
||||
__releases - The specified lock is held on function entry, but not exit.
|
||||
|
||||
If the function enters and exits without the lock held, acquiring and
|
||||
releasing the lock inside the function in a balanced way, no
|
||||
annotation is needed. The three annotations above are for cases where
|
||||
sparse would otherwise report a context imbalance.
|
||||
|
||||
Getting sparse
|
||||
--------------
|
||||
|
||||
|
|
|
|||
|
|
@ -262,57 +262,32 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
extern const struct __ctx_lock_##ctx *name
|
||||
|
||||
/*
|
||||
* Common keywords for static context analysis. Both Clang's "capability
|
||||
* analysis" and Sparse's "context tracking" are currently supported.
|
||||
* Common keywords for static context analysis.
|
||||
*/
|
||||
#ifdef __CHECKER__
|
||||
|
||||
/* Sparse context/lock checking support. */
|
||||
# define __must_hold(x) __attribute__((context(x,1,1)))
|
||||
# define __must_not_hold(x)
|
||||
# define __acquires(x) __attribute__((context(x,0,1)))
|
||||
# define __cond_acquires(ret, x) __attribute__((context(x,0,-1)))
|
||||
# define __releases(x) __attribute__((context(x,1,0)))
|
||||
# define __acquire(x) __context__(x,1)
|
||||
# define __release(x) __context__(x,-1)
|
||||
# define __cond_lock(x, c) ((c) ? ({ __acquire(x); 1; }) : 0)
|
||||
/* For Sparse, there's no distinction between exclusive and shared locks. */
|
||||
# define __must_hold_shared __must_hold
|
||||
# define __acquires_shared __acquires
|
||||
# define __cond_acquires_shared __cond_acquires
|
||||
# define __releases_shared __releases
|
||||
# define __acquire_shared __acquire
|
||||
# define __release_shared __release
|
||||
# define __cond_lock_shared __cond_acquire
|
||||
|
||||
#else /* !__CHECKER__ */
|
||||
|
||||
/**
|
||||
* __must_hold() - function attribute, caller must hold exclusive context lock
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the caller must hold the given context
|
||||
* lock instance @x exclusively.
|
||||
* lock instance(s) exclusively.
|
||||
*/
|
||||
# define __must_hold(x) __requires_ctx_lock(x)
|
||||
#define __must_hold(...) __requires_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* __must_not_hold() - function attribute, caller must not hold context lock
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the caller must not hold the given context
|
||||
* lock instance @x.
|
||||
* lock instance(s).
|
||||
*/
|
||||
# define __must_not_hold(x) __excludes_ctx_lock(x)
|
||||
#define __must_not_hold(...) __excludes_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* __acquires() - function attribute, function acquires context lock exclusively
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the function acquires the given context
|
||||
* lock instance @x exclusively, but does not release it.
|
||||
* lock instance(s) exclusively, but does not release them.
|
||||
*/
|
||||
# define __acquires(x) __acquires_ctx_lock(x)
|
||||
#define __acquires(...) __acquires_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/*
|
||||
* Clang's analysis does not care precisely about the value, only that it is
|
||||
|
|
@ -339,17 +314,16 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
*
|
||||
* @ret may be one of: true, false, nonzero, 0, nonnull, NULL.
|
||||
*/
|
||||
# define __cond_acquires(ret, x) __cond_acquires_impl_##ret(x)
|
||||
#define __cond_acquires(ret, x) __cond_acquires_impl_##ret(x)
|
||||
|
||||
/**
|
||||
* __releases() - function attribute, function releases a context lock exclusively
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the function releases the given context
|
||||
* lock instance @x exclusively. The associated context must be active on
|
||||
* lock instance(s) exclusively. The associated context(s) must be active on
|
||||
* entry.
|
||||
*/
|
||||
# define __releases(x) __releases_ctx_lock(x)
|
||||
#define __releases(...) __releases_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* __acquire() - function to acquire context lock exclusively
|
||||
|
|
@ -357,7 +331,7 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
*
|
||||
* No-op function that acquires the given context lock instance @x exclusively.
|
||||
*/
|
||||
# define __acquire(x) __acquire_ctx_lock(x)
|
||||
#define __acquire(x) __acquire_ctx_lock(x)
|
||||
|
||||
/**
|
||||
* __release() - function to release context lock exclusively
|
||||
|
|
@ -365,7 +339,7 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
*
|
||||
* No-op function that releases the given context lock instance @x.
|
||||
*/
|
||||
# define __release(x) __release_ctx_lock(x)
|
||||
#define __release(x) __release_ctx_lock(x)
|
||||
|
||||
/**
|
||||
* __cond_lock() - function that conditionally acquires a context lock
|
||||
|
|
@ -383,25 +357,23 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
*
|
||||
* #define spin_trylock(l) __cond_lock(&lock, _spin_trylock(&lock))
|
||||
*/
|
||||
# define __cond_lock(x, c) __try_acquire_ctx_lock(x, c)
|
||||
#define __cond_lock(x, c) __try_acquire_ctx_lock(x, c)
|
||||
|
||||
/**
|
||||
* __must_hold_shared() - function attribute, caller must hold shared context lock
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the caller must hold the given context
|
||||
* lock instance @x with shared access.
|
||||
* lock instance(s) with shared access.
|
||||
*/
|
||||
# define __must_hold_shared(x) __requires_shared_ctx_lock(x)
|
||||
#define __must_hold_shared(...) __requires_shared_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* __acquires_shared() - function attribute, function acquires context lock shared
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the function acquires the given
|
||||
* context lock instance @x with shared access, but does not release it.
|
||||
* context lock instance(s) with shared access, but does not release them.
|
||||
*/
|
||||
# define __acquires_shared(x) __acquires_shared_ctx_lock(x)
|
||||
#define __acquires_shared(...) __acquires_shared_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* __cond_acquires_shared() - function attribute, function conditionally
|
||||
|
|
@ -410,23 +382,22 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the function conditionally acquires the
|
||||
* given context lock instance @x with shared access, but does not release it. The
|
||||
* function return value @ret denotes when the context lock is acquired.
|
||||
* given context lock instance @x with shared access, but does not release it.
|
||||
* The function return value @ret denotes when the context lock is acquired.
|
||||
*
|
||||
* @ret may be one of: true, false, nonzero, 0, nonnull, NULL.
|
||||
*/
|
||||
# define __cond_acquires_shared(ret, x) __cond_acquires_impl_##ret(x, _shared)
|
||||
#define __cond_acquires_shared(ret, x) __cond_acquires_impl_##ret(x, _shared)
|
||||
|
||||
/**
|
||||
* __releases_shared() - function attribute, function releases a
|
||||
* context lock shared
|
||||
* @x: context lock instance pointer
|
||||
*
|
||||
* Function attribute declaring that the function releases the given context
|
||||
* lock instance @x with shared access. The associated context must be active
|
||||
* on entry.
|
||||
* lock instance(s) with shared access. The associated context(s) must be
|
||||
* active on entry.
|
||||
*/
|
||||
# define __releases_shared(x) __releases_shared_ctx_lock(x)
|
||||
#define __releases_shared(...) __releases_shared_ctx_lock(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* __acquire_shared() - function to acquire context lock shared
|
||||
|
|
@ -435,7 +406,7 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
* No-op function that acquires the given context lock instance @x with shared
|
||||
* access.
|
||||
*/
|
||||
# define __acquire_shared(x) __acquire_shared_ctx_lock(x)
|
||||
#define __acquire_shared(x) __acquire_shared_ctx_lock(x)
|
||||
|
||||
/**
|
||||
* __release_shared() - function to release context lock shared
|
||||
|
|
@ -444,7 +415,7 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
* No-op function that releases the given context lock instance @x with shared
|
||||
* access.
|
||||
*/
|
||||
# define __release_shared(x) __release_shared_ctx_lock(x)
|
||||
#define __release_shared(x) __release_shared_ctx_lock(x)
|
||||
|
||||
/**
|
||||
* __cond_lock_shared() - function that conditionally acquires a context lock shared
|
||||
|
|
@ -457,9 +428,7 @@ static inline void _context_unsafe_alias(void **p) { }
|
|||
* shared access, if the boolean expression @c is true. The result of @c is the
|
||||
* return value.
|
||||
*/
|
||||
# define __cond_lock_shared(x, c) __try_acquire_shared_ctx_lock(x, c)
|
||||
|
||||
#endif /* __CHECKER__ */
|
||||
#define __cond_lock_shared(x, c) __try_acquire_shared_ctx_lock(x, c)
|
||||
|
||||
/**
|
||||
* __acquire_ret() - helper to acquire context lock of return value
|
||||
|
|
|
|||
|
|
@ -1219,20 +1219,7 @@ rcu_head_after_call_rcu(struct rcu_head *rhp, rcu_callback_t f)
|
|||
extern int rcu_expedited;
|
||||
extern int rcu_normal;
|
||||
|
||||
DEFINE_LOCK_GUARD_0(rcu,
|
||||
do {
|
||||
rcu_read_lock();
|
||||
/*
|
||||
* sparse doesn't call the cleanup function,
|
||||
* so just release immediately and don't track
|
||||
* the context. We don't need to anyway, since
|
||||
* the whole point of the guard is to not need
|
||||
* the explicit unlock.
|
||||
*/
|
||||
__release(RCU);
|
||||
} while (0),
|
||||
rcu_read_unlock())
|
||||
|
||||
DEFINE_LOCK_GUARD_0(rcu, rcu_read_lock(), rcu_read_unlock())
|
||||
DECLARE_LOCK_GUARD_0_ATTRS(rcu, __acquires_shared(RCU), __releases_shared(RCU))
|
||||
|
||||
#endif /* __LINUX_RCUPDATE_H */
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue