1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __LINUX_COMPILER_TYPES_H 3 #define __LINUX_COMPILER_TYPES_H 4 5 #ifndef __ASSEMBLY__ 6 7 #if defined(CONFIG_DEBUG_INFO_BTF) && defined(CONFIG_PAHOLE_HAS_BTF_TAG) && \ 8 __has_attribute(btf_type_tag) 9 # define BTF_TYPE_TAG(value) __attribute__((btf_type_tag(#value))) 10 #else 11 # define BTF_TYPE_TAG(value) /* nothing */ 12 #endif 13 14 /* sparse defines __CHECKER__; see Documentation/dev-tools/sparse.rst */ 15 #ifdef __CHECKER__ 16 /* address spaces */ 17 # define __kernel __attribute__((address_space(0))) 18 # define __user __attribute__((noderef, address_space(__user))) 19 # define __iomem __attribute__((noderef, address_space(__iomem))) 20 # define __percpu __attribute__((noderef, address_space(__percpu))) 21 # define __rcu __attribute__((noderef, address_space(__rcu))) 22 static inline void __chk_user_ptr(const volatile void __user *ptr) { } 23 static inline void __chk_io_ptr(const volatile void __iomem *ptr) { } 24 /* context/locking */ 25 # define __must_hold(x) __attribute__((context(x,1,1))) 26 # define __acquires(x) __attribute__((context(x,0,1))) 27 # define __releases(x) __attribute__((context(x,1,0))) 28 # define __acquire(x) __context__(x,1) 29 # define __release(x) __context__(x,-1) 30 # define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0) 31 /* other */ 32 # define __force __attribute__((force)) 33 # define __nocast __attribute__((nocast)) 34 # define __safe __attribute__((safe)) 35 # define __private __attribute__((noderef)) 36 # define ACCESS_PRIVATE(p, member) (*((typeof((p)->member) __force *) &(p)->member)) 37 #else /* __CHECKER__ */ 38 /* address spaces */ 39 # define __kernel 40 # ifdef STRUCTLEAK_PLUGIN 41 # define __user __attribute__((user)) 42 # else 43 # define __user BTF_TYPE_TAG(user) 44 # endif 45 # define __iomem 46 # define __percpu BTF_TYPE_TAG(percpu) 47 # define __rcu 48 # define __chk_user_ptr(x) (void)0 49 # define __chk_io_ptr(x) (void)0 50 /* context/locking */ 51 # define __must_hold(x) 52 # define __acquires(x) 53 # define __releases(x) 54 # define __acquire(x) (void)0 55 # define __release(x) (void)0 56 # define __cond_lock(x,c) (c) 57 /* other */ 58 # define __force 59 # define __nocast 60 # define __safe 61 # define __private 62 # define ACCESS_PRIVATE(p, member) ((p)->member) 63 # define __builtin_warning(x, y...) (1) 64 #endif /* __CHECKER__ */ 65 66 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */ 67 #define ___PASTE(a,b) a##b 68 #define __PASTE(a,b) ___PASTE(a,b) 69 70 #ifdef __KERNEL__ 71 72 /* Attributes */ 73 #include <linux/compiler_attributes.h> 74 75 /* Builtins */ 76 77 /* 78 * __has_builtin is supported on gcc >= 10, clang >= 3 and icc >= 21. 79 * In the meantime, to support gcc < 10, we implement __has_builtin 80 * by hand. 81 */ 82 #ifndef __has_builtin 83 #define __has_builtin(x) (0) 84 #endif 85 86 /* Compiler specific macros. */ 87 #ifdef __clang__ 88 #include <linux/compiler-clang.h> 89 #elif defined(__INTEL_COMPILER) 90 #include <linux/compiler-intel.h> 91 #elif defined(__GNUC__) 92 /* The above compilers also define __GNUC__, so order is important here. */ 93 #include <linux/compiler-gcc.h> 94 #else 95 #error "Unknown compiler" 96 #endif 97 98 /* 99 * Some architectures need to provide custom definitions of macros provided 100 * by linux/compiler-*.h, and can do so using asm/compiler.h. We include that 101 * conditionally rather than using an asm-generic wrapper in order to avoid 102 * build failures if any C compilation, which will include this file via an 103 * -include argument in c_flags, occurs prior to the asm-generic wrappers being 104 * generated. 105 */ 106 #ifdef CONFIG_HAVE_ARCH_COMPILER_H 107 #include <asm/compiler.h> 108 #endif 109 110 struct ftrace_branch_data { 111 const char *func; 112 const char *file; 113 unsigned line; 114 union { 115 struct { 116 unsigned long correct; 117 unsigned long incorrect; 118 }; 119 struct { 120 unsigned long miss; 121 unsigned long hit; 122 }; 123 unsigned long miss_hit[2]; 124 }; 125 }; 126 127 struct ftrace_likely_data { 128 struct ftrace_branch_data data; 129 unsigned long constant; 130 }; 131 132 #if defined(CC_USING_HOTPATCH) 133 #define notrace __attribute__((hotpatch(0, 0))) 134 #elif defined(CC_USING_PATCHABLE_FUNCTION_ENTRY) 135 #define notrace __attribute__((patchable_function_entry(0, 0))) 136 #else 137 #define notrace __attribute__((__no_instrument_function__)) 138 #endif 139 140 /* 141 * it doesn't make sense on ARM (currently the only user of __naked) 142 * to trace naked functions because then mcount is called without 143 * stack and frame pointer being set up and there is no chance to 144 * restore the lr register to the value before mcount was called. 145 */ 146 #define __naked __attribute__((__naked__)) notrace 147 148 /* 149 * Prefer gnu_inline, so that extern inline functions do not emit an 150 * externally visible function. This makes extern inline behave as per gnu89 151 * semantics rather than c99. This prevents multiple symbol definition errors 152 * of extern inline functions at link time. 153 * A lot of inline functions can cause havoc with function tracing. 154 */ 155 #define inline inline __gnu_inline __inline_maybe_unused notrace 156 157 /* 158 * gcc provides both __inline__ and __inline as alternate spellings of 159 * the inline keyword, though the latter is undocumented. New kernel 160 * code should only use the inline spelling, but some existing code 161 * uses __inline__. Since we #define inline above, to ensure 162 * __inline__ has the same semantics, we need this #define. 163 * 164 * However, the spelling __inline is strictly reserved for referring 165 * to the bare keyword. 166 */ 167 #define __inline__ inline 168 169 /* 170 * GCC does not warn about unused static inline functions for -Wunused-function. 171 * Suppress the warning in clang as well by using __maybe_unused, but enable it 172 * for W=1 build. This will allow clang to find unused functions. Remove the 173 * __inline_maybe_unused entirely after fixing most of -Wunused-function warnings. 174 */ 175 #ifdef KBUILD_EXTRA_WARN1 176 #define __inline_maybe_unused 177 #else 178 #define __inline_maybe_unused __maybe_unused 179 #endif 180 181 /* 182 * Rather then using noinline to prevent stack consumption, use 183 * noinline_for_stack instead. For documentation reasons. 184 */ 185 #define noinline_for_stack noinline 186 187 /* 188 * Sanitizer helper attributes: Because using __always_inline and 189 * __no_sanitize_* conflict, provide helper attributes that will either expand 190 * to __no_sanitize_* in compilation units where instrumentation is enabled 191 * (__SANITIZE_*__), or __always_inline in compilation units without 192 * instrumentation (__SANITIZE_*__ undefined). 193 */ 194 #ifdef __SANITIZE_ADDRESS__ 195 /* 196 * We can't declare function 'inline' because __no_sanitize_address conflicts 197 * with inlining. Attempt to inline it may cause a build failure. 198 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368 199 * '__maybe_unused' allows us to avoid defined-but-not-used warnings. 200 */ 201 # define __no_kasan_or_inline __no_sanitize_address notrace __maybe_unused 202 # define __no_sanitize_or_inline __no_kasan_or_inline 203 #else 204 # define __no_kasan_or_inline __always_inline 205 #endif 206 207 #ifdef __SANITIZE_THREAD__ 208 /* 209 * Clang still emits instrumentation for __tsan_func_{entry,exit}() and builtin 210 * atomics even with __no_sanitize_thread (to avoid false positives in userspace 211 * ThreadSanitizer). The kernel's requirements are stricter and we really do not 212 * want any instrumentation with __no_kcsan. 213 * 214 * Therefore we add __disable_sanitizer_instrumentation where available to 215 * disable all instrumentation. See Kconfig.kcsan where this is mandatory. 216 */ 217 # define __no_kcsan __no_sanitize_thread __disable_sanitizer_instrumentation 218 # define __no_sanitize_or_inline __no_kcsan notrace __maybe_unused 219 #else 220 # define __no_kcsan 221 #endif 222 223 #ifndef __no_sanitize_or_inline 224 #define __no_sanitize_or_inline __always_inline 225 #endif 226 227 /* Section for code which can't be instrumented at all */ 228 #define noinstr \ 229 noinline notrace __attribute((__section__(".noinstr.text"))) \ 230 __no_kcsan __no_sanitize_address __no_profile __no_sanitize_coverage 231 232 #endif /* __KERNEL__ */ 233 234 #endif /* __ASSEMBLY__ */ 235 236 /* 237 * The below symbols may be defined for one or more, but not ALL, of the above 238 * compilers. We don't consider that to be an error, so set them to nothing. 239 * For example, some of them are for compiler specific plugins. 240 */ 241 #ifndef __latent_entropy 242 # define __latent_entropy 243 #endif 244 245 #ifndef __randomize_layout 246 # define __randomize_layout __designated_init 247 #endif 248 249 #ifndef __no_randomize_layout 250 # define __no_randomize_layout 251 #endif 252 253 #ifndef randomized_struct_fields_start 254 # define randomized_struct_fields_start 255 # define randomized_struct_fields_end 256 #endif 257 258 #ifndef __noscs 259 # define __noscs 260 #endif 261 262 #ifndef __nocfi 263 # define __nocfi 264 #endif 265 266 #ifndef __cficanonical 267 # define __cficanonical 268 #endif 269 270 /* 271 * Any place that could be marked with the "alloc_size" attribute is also 272 * a place to be marked with the "malloc" attribute. Do this as part of the 273 * __alloc_size macro to avoid redundant attributes and to avoid missing a 274 * __malloc marking. 275 */ 276 #ifdef __alloc_size__ 277 # define __alloc_size(x, ...) __alloc_size__(x, ## __VA_ARGS__) __malloc 278 #else 279 # define __alloc_size(x, ...) __malloc 280 #endif 281 282 #ifndef asm_volatile_goto 283 #define asm_volatile_goto(x...) asm goto(x) 284 #endif 285 286 #ifdef CONFIG_CC_HAS_ASM_INLINE 287 #define asm_inline asm __inline 288 #else 289 #define asm_inline asm 290 #endif 291 292 /* Are two types/vars the same type (ignoring qualifiers)? */ 293 #define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b)) 294 295 /* 296 * __unqual_scalar_typeof(x) - Declare an unqualified scalar type, leaving 297 * non-scalar types unchanged. 298 */ 299 /* 300 * Prefer C11 _Generic for better compile-times and simpler code. Note: 'char' 301 * is not type-compatible with 'signed char', and we define a separate case. 302 */ 303 #define __scalar_type_to_expr_cases(type) \ 304 unsigned type: (unsigned type)0, \ 305 signed type: (signed type)0 306 307 #define __unqual_scalar_typeof(x) typeof( \ 308 _Generic((x), \ 309 char: (char)0, \ 310 __scalar_type_to_expr_cases(char), \ 311 __scalar_type_to_expr_cases(short), \ 312 __scalar_type_to_expr_cases(int), \ 313 __scalar_type_to_expr_cases(long), \ 314 __scalar_type_to_expr_cases(long long), \ 315 default: (x))) 316 317 /* Is this type a native word size -- useful for atomic operations */ 318 #define __native_word(t) \ 319 (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || \ 320 sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long)) 321 322 #ifdef __OPTIMIZE__ 323 # define __compiletime_assert(condition, msg, prefix, suffix) \ 324 do { \ 325 /* \ 326 * __noreturn is needed to give the compiler enough \ 327 * information to avoid certain possibly-uninitialized \ 328 * warnings (regardless of the build failing). \ 329 */ \ 330 __noreturn extern void prefix ## suffix(void) \ 331 __compiletime_error(msg); \ 332 if (!(condition)) \ 333 prefix ## suffix(); \ 334 } while (0) 335 #else 336 # define __compiletime_assert(condition, msg, prefix, suffix) do { } while (0) 337 #endif 338 339 #define _compiletime_assert(condition, msg, prefix, suffix) \ 340 __compiletime_assert(condition, msg, prefix, suffix) 341 342 /** 343 * compiletime_assert - break build and emit msg if condition is false 344 * @condition: a compile-time constant condition to check 345 * @msg: a message to emit if condition is false 346 * 347 * In tradition of POSIX assert, this macro will break the build if the 348 * supplied condition is *false*, emitting the supplied error message if the 349 * compiler has support to do so. 350 */ 351 #define compiletime_assert(condition, msg) \ 352 _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__) 353 354 #define compiletime_assert_atomic_type(t) \ 355 compiletime_assert(__native_word(t), \ 356 "Need native word sized stores/loads for atomicity.") 357 358 /* Helpers for emitting diagnostics in pragmas. */ 359 #ifndef __diag 360 #define __diag(string) 361 #endif 362 363 #ifndef __diag_GCC 364 #define __diag_GCC(version, severity, string) 365 #endif 366 367 #define __diag_push() __diag(push) 368 #define __diag_pop() __diag(pop) 369 370 #define __diag_ignore(compiler, version, option, comment) \ 371 __diag_ ## compiler(version, ignore, option) 372 #define __diag_warn(compiler, version, option, comment) \ 373 __diag_ ## compiler(version, warn, option) 374 #define __diag_error(compiler, version, option, comment) \ 375 __diag_ ## compiler(version, error, option) 376 377 #ifndef __diag_ignore_all 378 #define __diag_ignore_all(option, comment) 379 #endif 380 381 #endif /* __LINUX_COMPILER_TYPES_H */ 382