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 # else 35 # define __user 36 # endif 37 # define __iomem 38 # define __percpu 39 # define __rcu 40 # define __chk_user_ptr(x) (void)0 41 # define __chk_io_ptr(x) (void)0 42 /* context/locking */ 43 # define __must_hold(x) 44 # define __acquires(x) 45 # define __releases(x) 46 # define __acquire(x) (void)0 47 # define __release(x) (void)0 48 # define __cond_lock(x,c) (c) 49 /* other */ 50 # define __force 51 # define __nocast 52 # define __safe 53 # define __private 54 # define ACCESS_PRIVATE(p, member) ((p)->member) 55 # define __builtin_warning(x, y...) (1) 56 #endif /* __CHECKER__ */ 57 58 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */ 59 #define ___PASTE(a,b) a##b 60 #define __PASTE(a,b) ___PASTE(a,b) 61 62 #ifdef __KERNEL__ 63 64 /* Attributes */ 65 #include <linux/compiler_attributes.h> 66 67 /* Builtins */ 68 69 /* 70 * __has_builtin is supported on gcc >= 10, clang >= 3 and icc >= 21. 71 * In the meantime, to support gcc < 10, we implement __has_builtin 72 * by hand. 73 */ 74 #ifndef __has_builtin 75 #define __has_builtin(x) (0) 76 #endif 77 78 /* Compiler specific macros. */ 79 #ifdef __clang__ 80 #include <linux/compiler-clang.h> 81 #elif defined(__INTEL_COMPILER) 82 #include <linux/compiler-intel.h> 83 #elif defined(__GNUC__) 84 /* The above compilers also define __GNUC__, so order is important here. */ 85 #include <linux/compiler-gcc.h> 86 #else 87 #error "Unknown compiler" 88 #endif 89 90 /* 91 * Some architectures need to provide custom definitions of macros provided 92 * by linux/compiler-*.h, and can do so using asm/compiler.h. We include that 93 * conditionally rather than using an asm-generic wrapper in order to avoid 94 * build failures if any C compilation, which will include this file via an 95 * -include argument in c_flags, occurs prior to the asm-generic wrappers being 96 * generated. 97 */ 98 #ifdef CONFIG_HAVE_ARCH_COMPILER_H 99 #include <asm/compiler.h> 100 #endif 101 102 struct ftrace_branch_data { 103 const char *func; 104 const char *file; 105 unsigned line; 106 union { 107 struct { 108 unsigned long correct; 109 unsigned long incorrect; 110 }; 111 struct { 112 unsigned long miss; 113 unsigned long hit; 114 }; 115 unsigned long miss_hit[2]; 116 }; 117 }; 118 119 struct ftrace_likely_data { 120 struct ftrace_branch_data data; 121 unsigned long constant; 122 }; 123 124 #ifdef CONFIG_ENABLE_MUST_CHECK 125 #define __must_check __attribute__((__warn_unused_result__)) 126 #else 127 #define __must_check 128 #endif 129 130 #if defined(CC_USING_HOTPATCH) 131 #define notrace __attribute__((hotpatch(0, 0))) 132 #elif defined(CC_USING_PATCHABLE_FUNCTION_ENTRY) 133 #define notrace __attribute__((patchable_function_entry(0, 0))) 134 #else 135 #define notrace __attribute__((__no_instrument_function__)) 136 #endif 137 138 /* 139 * it doesn't make sense on ARM (currently the only user of __naked) 140 * to trace naked functions because then mcount is called without 141 * stack and frame pointer being set up and there is no chance to 142 * restore the lr register to the value before mcount was called. 143 */ 144 #define __naked __attribute__((__naked__)) notrace 145 146 #define __compiler_offsetof(a, b) __builtin_offsetof(a, b) 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 #define __no_kcsan __no_sanitize_thread 208 #ifdef __SANITIZE_THREAD__ 209 # define __no_sanitize_or_inline __no_kcsan notrace __maybe_unused 210 #endif 211 212 #ifndef __no_sanitize_or_inline 213 #define __no_sanitize_or_inline __always_inline 214 #endif 215 216 /* Section for code which can't be instrumented at all */ 217 #define noinstr \ 218 noinline notrace __attribute((__section__(".noinstr.text"))) \ 219 __no_kcsan __no_sanitize_address 220 221 #endif /* __KERNEL__ */ 222 223 #endif /* __ASSEMBLY__ */ 224 225 /* 226 * The below symbols may be defined for one or more, but not ALL, of the above 227 * compilers. We don't consider that to be an error, so set them to nothing. 228 * For example, some of them are for compiler specific plugins. 229 */ 230 #ifndef __latent_entropy 231 # define __latent_entropy 232 #endif 233 234 #ifndef __randomize_layout 235 # define __randomize_layout __designated_init 236 #endif 237 238 #ifndef __no_randomize_layout 239 # define __no_randomize_layout 240 #endif 241 242 #ifndef randomized_struct_fields_start 243 # define randomized_struct_fields_start 244 # define randomized_struct_fields_end 245 #endif 246 247 #ifndef __noscs 248 # define __noscs 249 #endif 250 251 #ifndef asm_volatile_goto 252 #define asm_volatile_goto(x...) asm goto(x) 253 #endif 254 255 #ifdef CONFIG_CC_HAS_ASM_INLINE 256 #define asm_inline asm __inline 257 #else 258 #define asm_inline asm 259 #endif 260 261 /* Are two types/vars the same type (ignoring qualifiers)? */ 262 #define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b)) 263 264 /* 265 * __unqual_scalar_typeof(x) - Declare an unqualified scalar type, leaving 266 * non-scalar types unchanged. 267 */ 268 /* 269 * Prefer C11 _Generic for better compile-times and simpler code. Note: 'char' 270 * is not type-compatible with 'signed char', and we define a separate case. 271 */ 272 #define __scalar_type_to_expr_cases(type) \ 273 unsigned type: (unsigned type)0, \ 274 signed type: (signed type)0 275 276 #define __unqual_scalar_typeof(x) typeof( \ 277 _Generic((x), \ 278 char: (char)0, \ 279 __scalar_type_to_expr_cases(char), \ 280 __scalar_type_to_expr_cases(short), \ 281 __scalar_type_to_expr_cases(int), \ 282 __scalar_type_to_expr_cases(long), \ 283 __scalar_type_to_expr_cases(long long), \ 284 default: (x))) 285 286 /* Is this type a native word size -- useful for atomic operations */ 287 #define __native_word(t) \ 288 (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || \ 289 sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long)) 290 291 /* Compile time object size, -1 for unknown */ 292 #ifndef __compiletime_object_size 293 # define __compiletime_object_size(obj) -1 294 #endif 295 #ifndef __compiletime_warning 296 # define __compiletime_warning(message) 297 #endif 298 #ifndef __compiletime_error 299 # define __compiletime_error(message) 300 #endif 301 302 #ifdef __OPTIMIZE__ 303 # define __compiletime_assert(condition, msg, prefix, suffix) \ 304 do { \ 305 extern void prefix ## suffix(void) __compiletime_error(msg); \ 306 if (!(condition)) \ 307 prefix ## suffix(); \ 308 } while (0) 309 #else 310 # define __compiletime_assert(condition, msg, prefix, suffix) do { } while (0) 311 #endif 312 313 #define _compiletime_assert(condition, msg, prefix, suffix) \ 314 __compiletime_assert(condition, msg, prefix, suffix) 315 316 /** 317 * compiletime_assert - break build and emit msg if condition is false 318 * @condition: a compile-time constant condition to check 319 * @msg: a message to emit if condition is false 320 * 321 * In tradition of POSIX assert, this macro will break the build if the 322 * supplied condition is *false*, emitting the supplied error message if the 323 * compiler has support to do so. 324 */ 325 #define compiletime_assert(condition, msg) \ 326 _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__) 327 328 #define compiletime_assert_atomic_type(t) \ 329 compiletime_assert(__native_word(t), \ 330 "Need native word sized stores/loads for atomicity.") 331 332 /* Helpers for emitting diagnostics in pragmas. */ 333 #ifndef __diag 334 #define __diag(string) 335 #endif 336 337 #ifndef __diag_GCC 338 #define __diag_GCC(version, severity, string) 339 #endif 340 341 #define __diag_push() __diag(push) 342 #define __diag_pop() __diag(pop) 343 344 #define __diag_ignore(compiler, version, option, comment) \ 345 __diag_ ## compiler(version, ignore, option) 346 #define __diag_warn(compiler, version, option, comment) \ 347 __diag_ ## compiler(version, warn, option) 348 #define __diag_error(compiler, version, option, comment) \ 349 __diag_ ## compiler(version, error, option) 350 351 #endif /* __LINUX_COMPILER_TYPES_H */ 352