[mirror_ubuntu-focal-kernel.git] / include / linux / compiler-clang.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __LINUX_COMPILER_TYPES_H
#error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
#endif

/* Some compiler specific definitions are overwritten here
 * for Clang compiler
 */
#define uninitialized_var(x) x = *(&(x))

/* same as gcc, this was present in clang-2.6 so we can assume it works
 * with any version that can compile the kernel
 */
#define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)

/* all clang versions usable with the kernel support KASAN ABI version 5 */
#define KASAN_ABI_VERSION 5

/* emulate gcc's __SANITIZE_ADDRESS__ flag */
#if __has_feature(address_sanitizer)
#define __SANITIZE_ADDRESS__
#endif

#define __no_sanitize_address __attribute__((no_sanitize("address")))

/*
 * Not all versions of clang implement the the type-generic versions
 * of the builtin overflow checkers. Fortunately, clang implements
 * __has_builtin allowing us to avoid awkward version
 * checks. Unfortunately, we don't know which version of gcc clang
 * pretends to be, so the macro may or may not be defined.
 */
#if __has_builtin(__builtin_mul_overflow) && \
    __has_builtin(__builtin_add_overflow) && \
    __has_builtin(__builtin_sub_overflow)
#define COMPILER_HAS_GENERIC_BUILTIN_OVERFLOW 1
#endif

/* The following are for compatibility with GCC, from compiler-gcc.h,
 * and may be redefined here because they should not be shared with other
 * compilers, like ICC.
 */
#define barrier() __asm__ __volatile__("" : : : "memory")
#define __must_be_array(a) BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
#define __assume_aligned(a, ...)	\
	__attribute__((__assume_aligned__(a, ## __VA_ARGS__)))
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
d1515582	2	#ifndef __LINUX_COMPILER_TYPES_H
565cbdc2 MC	3	#error "Please don't include <linux/compiler-clang.h> directly, include <linux/compiler.h> instead."
	4	#endif
	5
	6	/* Some compiler specific definitions are overwritten here
	7	* for Clang compiler
	8	*/
565cbdc2	9	#define uninitialized_var(x) x = *(&(x))
b41c29b0 AB	10
	11	/* same as gcc, this was present in clang-2.6 so we can assume it works
	12	* with any version that can compile the kernel
	13	*/
	14	#define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)
4ca59b14	15
53a98ed7 PL	16	/* all clang versions usable with the kernel support KASAN ABI version 5 */
	17	#define KASAN_ABI_VERSION 5
	18
	19	/* emulate gcc's __SANITIZE_ADDRESS__ flag */
	20	#if __has_feature(address_sanitizer)
	21	#define __SANITIZE_ADDRESS__
	22	#endif
87358710	23
12c8f25a AK	24	#define __no_sanitize_address __attribute__((no_sanitize("address")))
12c8f25a AK	25
f0907827 RV	26	/*
	27	* Not all versions of clang implement the the type-generic versions
	28	* of the builtin overflow checkers. Fortunately, clang implements
	29	* __has_builtin allowing us to avoid awkward version
	30	* checks. Unfortunately, we don't know which version of gcc clang
	31	* pretends to be, so the macro may or may not be defined.
	32	*/
f0907827 RV	33	#if __has_builtin(__builtin_mul_overflow) && \
	34	__has_builtin(__builtin_add_overflow) && \
	35	__has_builtin(__builtin_sub_overflow)
	36	#define COMPILER_HAS_GENERIC_BUILTIN_OVERFLOW 1
	37	#endif
815f0ddb ND	38
	39	/* The following are for compatibility with GCC, from compiler-gcc.h,
	40	* and may be redefined here because they should not be shared with other
	41	* compilers, like ICC.
	42	*/
	43	#define barrier() __asm__ __volatile__("" : : : "memory")
	44	#define __must_be_array(a) BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
	45	#define __assume_aligned(a, ...) \
	46	__attribute__((__assume_aligned__(a, ## __VA_ARGS__)))