Commit de15feca authored by Marco Elver's avatar Marco Elver Committed by Peter Zijlstra
Browse files

compiler_types: Move lock checking attributes to compiler-context-analysis.h 



The conditional definition of lock checking macros and attributes is
about to become more complex. Factor them out into their own header for
better readability, and to make it obvious which features are supported
by which mode (currently only Sparse). This is the first step towards
generalizing towards "context analysis".

No functional change intended.

Signed-off-by: default avatarMarco Elver <elver@google.com>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: default avatarBart Van Assche <bvanassche@acm.org>
Link: https://patch.msgid.link/20251219154418.3592607-2-elver@google.com
parent de2c5a15

include/linux/compiler-context-analysis.h

0 → 100644
+32 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 */

/*

 * Macros and attributes for compiler-based static context analysis.

 */



#ifndef _LINUX_COMPILER_CONTEXT_ANALYSIS_H

#define _LINUX_COMPILER_CONTEXT_ANALYSIS_H



#ifdef __CHECKER__



/* Sparse context/lock checking support. */

# define __must_hold(x)		__attribute__((context(x,1,1)))

# define __acquires(x)		__attribute__((context(x,0,1)))

# define __cond_acquires(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)



#else /* !__CHECKER__ */



# define __must_hold(x)

# define __acquires(x)

# define __cond_acquires(x)

# define __releases(x)

# define __acquire(x)		(void)0

# define __release(x)		(void)0

# define __cond_lock(x, c)	(c)



#endif /* __CHECKER__ */



#endif /* _LINUX_COMPILER_CONTEXT_ANALYSIS_H */

include/linux/compiler_types.h

+2 −16
Original line number Diff line number Diff line
@@ -41,6 +41,8 @@ 
# define BTF_TYPE_TAG(value) /* nothing */

#endif



#include <linux/compiler-context-analysis.h>



/* sparse defines __CHECKER__; see Documentation/dev-tools/sparse.rst */

#ifdef __CHECKER__

/* address spaces */
@@ -51,14 +53,6 @@ 
# define __rcu		__attribute__((noderef, address_space(__rcu)))

static inline void __chk_user_ptr(const volatile void __user *ptr) { }

static inline void __chk_io_ptr(const volatile void __iomem *ptr) { }

/* context/locking */

# define __must_hold(x)	__attribute__((context(x,1,1)))

# define __acquires(x)	__attribute__((context(x,0,1)))

# define __cond_acquires(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)

/* other */

# define __force	__attribute__((force))

# define __nocast	__attribute__((nocast))
@@ -79,14 +73,6 @@ static inline void __chk_io_ptr(const volatile void __iomem *ptr) { } 


# define __chk_user_ptr(x)	(void)0

# define __chk_io_ptr(x)	(void)0

/* context/locking */

# define __must_hold(x)

# define __acquires(x)

# define __cond_acquires(x)

# define __releases(x)

# define __acquire(x)	(void)0

# define __release(x)	(void)0

# define __cond_lock(x,c) (c)

/* other */

# define __force

# define __nocast