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