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 #ifdef __CHECKER__ 8 /* address spaces */ 9 # define __kernel __attribute__((address_space(0))) 10 # define __user __attribute__((noderef, address_space(__user))) 11 # define __iomem __attribute__((noderef, address_space(__iomem))) 12 # define __percpu __attribute__((noderef, address_space(__percpu))) 13 # define __rcu __attribute__((noderef, address_space(__rcu))) 14 static inline void __chk_user_ptr(const volatile void __user *ptr) { } 15 static inline void __chk_io_ptr(const volatile void __iomem *ptr) { } 16 /* context/locking */ 17 # define __must_hold(x) __attribute__((context(x,1,1))) 18 # define __acquires(x) __attribute__((context(x,0,1))) 19 # define __releases(x) __attribute__((context(x,1,0))) 20 # define __acquire(x) __context__(x,1) 21 # define __release(x) __context__(x,-1) 22 # define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0) 23 /* other */ 24 # define __force __attribute__((force)) 25 # define __nocast __attribute__((nocast)) 26 # define __safe __attribute__((safe)) 27 # define __private __attribute__((noderef)) 28 # define ACCESS_PRIVATE(p, member) (*((typeof((p)->member) __force *) &(p)->member)) 29 #else /* __CHECKER__ */ 30 /* address spaces */ 31 # define __kernel 32 # ifdef STRUCTLEAK_PLUGIN 33 # define __user __attribute__((user)) 34 # elif defined(CONFIG_DEBUG_INFO_BTF) && defined(CONFIG_PAHOLE_HAS_BTF_TAG) && \ 35 __has_attribute(btf_type_tag) 36 # define __user __attribute__((btf_type_tag("user"))) 37 # else 38 # define __user 39 # endif 40 # define __iomem 41 # if defined(CONFIG_DEBUG_INFO_BTF) && defined(CONFIG_PAHOLE_HAS_BTF_TAG) && \ 42 __has_attribute(btf_type_tag) 43 # define __percpu __attribute__((btf_type_tag("percpu"))) 44 # else 45 # define __percpu 46 # endif 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 #define __compiler_offsetof(a, b) __builtin_offsetof(a, b) 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 234 #endif /* __KERNEL__ */ 235 236 #endif /* __ASSEMBLY__ */ 237 238 /* 239 * The below symbols may be defined for one or more, but not ALL, of the above 240 * compilers. We don't consider that to be an error, so set them to nothing. 241 * For example, some of them are for compiler specific plugins. 242 */ 243 #ifndef __latent_entropy 244 # define __latent_entropy 245 #endif 246 247 #ifndef __randomize_layout 248 # define __randomize_layout __designated_init 249 #endif 250 251 #ifndef __no_randomize_layout 252 # define __no_randomize_layout 253 #endif 254 255 #ifndef randomized_struct_fields_start 256 # define randomized_struct_fields_start 257 # define randomized_struct_fields_end 258 #endif 259 260 #ifndef __noscs 261 # define __noscs 262 #endif 263 264 #ifndef __nocfi 265 # define __nocfi 266 #endif 267 268 #ifndef __cficanonical 269 # define __cficanonical 270 #endif 271 272 /* 273 * Any place that could be marked with the "alloc_size" attribute is also 274 * a place to be marked with the "malloc" attribute. Do this as part of the 275 * __alloc_size macro to avoid redundant attributes and to avoid missing a 276 * __malloc marking. 277 */ 278 #ifdef __alloc_size__ 279 # define __alloc_size(x, ...) __alloc_size__(x, ## __VA_ARGS__) __malloc 280 #else 281 # define __alloc_size(x, ...) __malloc 282 #endif 283 284 #ifndef asm_volatile_goto 285 #define asm_volatile_goto(x...) asm goto(x) 286 #endif 287 288 #ifdef CONFIG_CC_HAS_ASM_INLINE 289 #define asm_inline asm __inline 290 #else 291 #define asm_inline asm 292 #endif 293 294 /* Are two types/vars the same type (ignoring qualifiers)? */ 295 #define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b)) 296 297 /* 298 * __unqual_scalar_typeof(x) - Declare an unqualified scalar type, leaving 299 * non-scalar types unchanged. 300 */ 301 /* 302 * Prefer C11 _Generic for better compile-times and simpler code. Note: 'char' 303 * is not type-compatible with 'signed char', and we define a separate case. 304 */ 305 #define __scalar_type_to_expr_cases(type) \ 306 unsigned type: (unsigned type)0, \ 307 signed type: (signed type)0 308 309 #define __unqual_scalar_typeof(x) typeof( \ 310 _Generic((x), \ 311 char: (char)0, \ 312 __scalar_type_to_expr_cases(char), \ 313 __scalar_type_to_expr_cases(short), \ 314 __scalar_type_to_expr_cases(int), \ 315 __scalar_type_to_expr_cases(long), \ 316 __scalar_type_to_expr_cases(long long), \ 317 default: (x))) 318 319 /* Is this type a native word size -- useful for atomic operations */ 320 #define __native_word(t) \ 321 (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || \ 322 sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long)) 323 324 #ifdef __OPTIMIZE__ 325 # define __compiletime_assert(condition, msg, prefix, suffix) \ 326 do { \ 327 /* \ 328 * __noreturn is needed to give the compiler enough \ 329 * information to avoid certain possibly-uninitialized \ 330 * warnings (regardless of the build failing). \ 331 */ \ 332 __noreturn extern void prefix ## suffix(void) \ 333 __compiletime_error(msg); \ 334 if (!(condition)) \ 335 prefix ## suffix(); \ 336 } while (0) 337 #else 338 # define __compiletime_assert(condition, msg, prefix, suffix) do { } while (0) 339 #endif 340 341 #define _compiletime_assert(condition, msg, prefix, suffix) \ 342 __compiletime_assert(condition, msg, prefix, suffix) 343 344 /** 345 * compiletime_assert - break build and emit msg if condition is false 346 * @condition: a compile-time constant condition to check 347 * @msg: a message to emit if condition is false 348 * 349 * In tradition of POSIX assert, this macro will break the build if the 350 * supplied condition is *false*, emitting the supplied error message if the 351 * compiler has support to do so. 352 */ 353 #define compiletime_assert(condition, msg) \ 354 _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__) 355 356 #define compiletime_assert_atomic_type(t) \ 357 compiletime_assert(__native_word(t), \ 358 "Need native word sized stores/loads for atomicity.") 359 360 /* Helpers for emitting diagnostics in pragmas. */ 361 #ifndef __diag 362 #define __diag(string) 363 #endif 364 365 #ifndef __diag_GCC 366 #define __diag_GCC(version, severity, string) 367 #endif 368 369 #define __diag_push() __diag(push) 370 #define __diag_pop() __diag(pop) 371 372 #define __diag_ignore(compiler, version, option, comment) \ 373 __diag_ ## compiler(version, ignore, option) 374 #define __diag_warn(compiler, version, option, comment) \ 375 __diag_ ## compiler(version, warn, option) 376 #define __diag_error(compiler, version, option, comment) \ 377 __diag_ ## compiler(version, error, option) 378 379 #ifndef __diag_ignore_all 380 #define __diag_ignore_all(option, comment) 381 #endif 382 383 #endif /* __LINUX_COMPILER_TYPES_H */ 384