include/linux/compiler_types.h

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