include/linux/compiler.h

   1 #ifndef __LINUX_COMPILER_H
   2 #define __LINUX_COMPILER_H
   3
   4 #ifndef __ASSEMBLY__
   5
   6 #ifdef __CHECKER__
   7 # define __user         __attribute__((noderef, address_space(1)))
   8 # define __kernel       __attribute__((address_space(0)))
   9 # define __safe         __attribute__((safe))
  10 # define __force        __attribute__((force))
  11 # define __nocast       __attribute__((nocast))
  12 # define __iomem        __attribute__((noderef, address_space(2)))
  13 # define __must_hold(x) __attribute__((context(x,1,1)))
  14 # define __acquires(x)  __attribute__((context(x,0,1)))
  15 # define __releases(x)  __attribute__((context(x,1,0)))
  16 # define __acquire(x)   __context__(x,1)
  17 # define __release(x)   __context__(x,-1)
  18 # define __cond_lock(x,c)       ((c) ? ({ __acquire(x); 1; }) : 0)
  19 # define __percpu       __attribute__((noderef, address_space(3)))
  20 #ifdef CONFIG_SPARSE_RCU_POINTER
  21 # define __rcu          __attribute__((noderef, address_space(4)))
  22 #else /* CONFIG_SPARSE_RCU_POINTER */
  23 # define __rcu
  24 #endif /* CONFIG_SPARSE_RCU_POINTER */
  25 # define __private      __attribute__((noderef))
  26 extern void __chk_user_ptr(const volatile void __user *);
  27 extern void __chk_io_ptr(const volatile void __iomem *);
  28 # define ACCESS_PRIVATE(p, member) (*((typeof((p)->member) __force *) &(p)->member))
  29 #else /* __CHECKER__ */
  30 # define __user
  31 # define __kernel
  32 # define __safe
  33 # define __force
  34 # define __nocast
  35 # define __iomem
  36 # define __chk_user_ptr(x) (void)0
  37 # define __chk_io_ptr(x) (void)0
  38 # define __builtin_warning(x, y...) (1)
  39 # define __must_hold(x)
  40 # define __acquires(x)
  41 # define __releases(x)
  42 # define __acquire(x) (void)0
  43 # define __release(x) (void)0
  44 # define __cond_lock(x,c) (c)
  45 # define __percpu
  46 # define __rcu
  47 # define __private
  48 # define ACCESS_PRIVATE(p, member) ((p)->member)
  49 #endif /* __CHECKER__ */
  50
  51 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */
  52 #define ___PASTE(a,b) a##b
  53 #define __PASTE(a,b) ___PASTE(a,b)
  54
  55 #ifdef __KERNEL__
  56
  57 /*
  58  * Minimal backport of compiler_attributes.h to add support for __copy
  59  * to v4.9.y so that we can use it in init/exit_module to avoid
  60  * -Werror=missing-attributes errors on GCC 9.
  61  */
  62 #ifndef __has_attribute
  63 # define __has_attribute(x) __GCC4_has_attribute_##x
  64 # define __GCC4_has_attribute___copy__                0
  65 #endif
  66
  67 #if __has_attribute(__copy__)
  68 # define __copy(symbol)                 __attribute__((__copy__(symbol)))
  69 #else
  70 # define __copy(symbol)
  71 #endif
  72
  73 #ifdef __GNUC__
  74 #include <linux/compiler-gcc.h>
  75 #endif
  76
  77 #if defined(CC_USING_HOTPATCH) && !defined(__CHECKER__)
  78 #define notrace __attribute__((hotpatch(0,0)))
  79 #else
  80 #define notrace __attribute__((no_instrument_function))
  81 #endif
  82
  83 /* Intel compiler defines __GNUC__. So we will overwrite implementations
  84  * coming from above header files here
  85  */
  86 #ifdef __INTEL_COMPILER
  87 # include <linux/compiler-intel.h>
  88 #endif
  89
  90 /* Clang compiler defines __GNUC__. So we will overwrite implementations
  91  * coming from above header files here
  92  */
  93 #ifdef __clang__
  94 #include <linux/compiler-clang.h>
  95 #endif
  96
  97 /*
  98  * Generic compiler-dependent macros required for kernel
  99  * build go below this comment. Actual compiler/compiler version
 100  * specific implementations come from the above header files
 101  */
 102
 103 struct ftrace_branch_data {
 104         const char *func;
 105         const char *file;
 106         unsigned line;
 107         union {
 108                 struct {
 109                         unsigned long correct;
 110                         unsigned long incorrect;
 111                 };
 112                 struct {
 113                         unsigned long miss;
 114                         unsigned long hit;
 115                 };
 116                 unsigned long miss_hit[2];
 117         };
 118 };
 119
 120 /*
 121  * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
 122  * to disable branch tracing on a per file basis.
 123  */
 124 #if defined(CONFIG_TRACE_BRANCH_PROFILING) \
 125     && !defined(DISABLE_BRANCH_PROFILING) && !defined(__CHECKER__)
 126 void ftrace_likely_update(struct ftrace_branch_data *f, int val, int expect);
 127
 128 #define likely_notrace(x)       __builtin_expect(!!(x), 1)
 129 #define unlikely_notrace(x)     __builtin_expect(!!(x), 0)
 130
 131 #define __branch_check__(x, expect) ({                                  \
 132                         long ______r;                                   \
 133                         static struct ftrace_branch_data                \
 134                                 __attribute__((__aligned__(4)))         \
 135                                 __attribute__((section("_ftrace_annotated_branch"))) \
 136                                 ______f = {                             \
 137                                 .func = __func__,                       \
 138                                 .file = __FILE__,                       \
 139                                 .line = __LINE__,                       \
 140                         };                                              \
 141                         ______r = likely_notrace(x);                    \
 142                         ftrace_likely_update(&______f, ______r, expect); \
 143                         ______r;                                        \
 144                 })
 145
 146 /*
 147  * Using __builtin_constant_p(x) to ignore cases where the return
 148  * value is always the same.  This idea is taken from a similar patch
 149  * written by Daniel Walker.
 150  */
 151 # ifndef likely
 152 #  define likely(x)     (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 1))
 153 # endif
 154 # ifndef unlikely
 155 #  define unlikely(x)   (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 0))
 156 # endif
 157
 158 #ifdef CONFIG_PROFILE_ALL_BRANCHES
 159 /*
 160  * "Define 'is'", Bill Clinton
 161  * "Define 'if'", Steven Rostedt
 162  */
 163 #define if(cond, ...) __trace_if( (cond , ## __VA_ARGS__) )
 164 #define __trace_if(cond) \
 165         if (__builtin_constant_p(!!(cond)) ? !!(cond) :                 \
 166         ({                                                              \
 167                 int ______r;                                            \
 168                 static struct ftrace_branch_data                        \
 169                         __attribute__((__aligned__(4)))                 \
 170                         __attribute__((section("_ftrace_branch")))      \
 171                         ______f = {                                     \
 172                                 .func = __func__,                       \
 173                                 .file = __FILE__,                       \
 174                                 .line = __LINE__,                       \
 175                         };                                              \
 176                 ______r = !!(cond);                                     \
 177                 ______f.miss_hit[______r]++;                                    \
 178                 ______r;                                                \
 179         }))
 180 #endif /* CONFIG_PROFILE_ALL_BRANCHES */
 181
 182 #else
 183 # define likely(x)      __builtin_expect(!!(x), 1)
 184 # define unlikely(x)    __builtin_expect(!!(x), 0)
 185 #endif
 186
 187 /* Optimization barrier */
 188 #ifndef barrier
 189 # define barrier() __memory_barrier()
 190 #endif
 191
 192 #ifndef barrier_data
 193 # define barrier_data(ptr) barrier()
 194 #endif
 195
 196 /* workaround for GCC PR82365 if needed */
 197 #ifndef barrier_before_unreachable
 198 # define barrier_before_unreachable() do { } while (0)
 199 #endif
 200
 201 /* Unreachable code */
 202 #ifndef unreachable
 203 # define unreachable() do { } while (1)
 204 #endif
 205
 206 /*
 207  * KENTRY - kernel entry point
 208  * This can be used to annotate symbols (functions or data) that are used
 209  * without their linker symbol being referenced explicitly. For example,
 210  * interrupt vector handlers, or functions in the kernel image that are found
 211  * programatically.
 212  *
 213  * Not required for symbols exported with EXPORT_SYMBOL, or initcalls. Those
 214  * are handled in their own way (with KEEP() in linker scripts).
 215  *
 216  * KENTRY can be avoided if the symbols in question are marked as KEEP() in the
 217  * linker script. For example an architecture could KEEP() its entire
 218  * boot/exception vector code rather than annotate each function and data.
 219  */
 220 #ifndef KENTRY
 221 # define KENTRY(sym)                                            \
 222         extern typeof(sym) sym;                                 \
 223         static const unsigned long __kentry_##sym               \
 224         __used                                                  \
 225         __attribute__((section("___kentry" "+" #sym ), used))   \
 226         = (unsigned long)&sym;
 227 #endif
 228
 229 #ifndef RELOC_HIDE
 230 # define RELOC_HIDE(ptr, off)                                   \
 231   ({ unsigned long __ptr;                                       \
 232      __ptr = (unsigned long) (ptr);                             \
 233     (typeof(ptr)) (__ptr + (off)); })
 234 #endif
 235
 236 #ifndef OPTIMIZER_HIDE_VAR
 237 #define OPTIMIZER_HIDE_VAR(var) barrier()
 238 #endif
 239
 240 /* Not-quite-unique ID. */
 241 #ifndef __UNIQUE_ID
 242 # define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __LINE__)
 243 #endif
 244
 245 #include <uapi/linux/types.h>
 246
 247 #define __READ_ONCE_SIZE                                                \
 248 ({                                                                      \
 249         switch (size) {                                                 \
 250         case 1: *(__u8 *)res = *(volatile __u8 *)p; break;              \
 251         case 2: *(__u16 *)res = *(volatile __u16 *)p; break;            \
 252         case 4: *(__u32 *)res = *(volatile __u32 *)p; break;            \
 253         case 8: *(__u64 *)res = *(volatile __u64 *)p; break;            \
 254         default:                                                        \
 255                 barrier();                                              \
 256                 __builtin_memcpy((void *)res, (const void *)p, size);   \
 257                 barrier();                                              \
 258         }                                                               \
 259 })
 260
 261 static __always_inline
 262 void __read_once_size(const volatile void *p, void *res, int size)
 263 {
 264         __READ_ONCE_SIZE;
 265 }
 266
 267 #ifdef CONFIG_KASAN
 268 /*
 269  * We can't declare function 'inline' because __no_sanitize_address confilcts
 270  * with inlining. Attempt to inline it may cause a build failure.
 271  *      https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
 272  * '__maybe_unused' allows us to avoid defined-but-not-used warnings.
 273  */
 274 # define __no_kasan_or_inline __no_sanitize_address __maybe_unused
 275 #else
 276 # define __no_kasan_or_inline __always_inline
 277 #endif
 278
 279 static __no_kasan_or_inline
 280 void __read_once_size_nocheck(const volatile void *p, void *res, int size)
 281 {
 282         __READ_ONCE_SIZE;
 283 }
 284
 285 static __always_inline void __write_once_size(volatile void *p, void *res, int size)
 286 {
 287         switch (size) {
 288         case 1: *(volatile __u8 *)p = *(__u8 *)res; break;
 289         case 2: *(volatile __u16 *)p = *(__u16 *)res; break;
 290         case 4: *(volatile __u32 *)p = *(__u32 *)res; break;
 291         case 8: *(volatile __u64 *)p = *(__u64 *)res; break;
 292         default:
 293                 barrier();
 294                 __builtin_memcpy((void *)p, (const void *)res, size);
 295                 barrier();
 296         }
 297 }
 298
 299 /*
 300  * Prevent the compiler from merging or refetching reads or writes. The
 301  * compiler is also forbidden from reordering successive instances of
 302  * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
 303  * compiler is aware of some particular ordering.  One way to make the
 304  * compiler aware of ordering is to put the two invocations of READ_ONCE,
 305  * WRITE_ONCE or ACCESS_ONCE() in different C statements.
 306  *
 307  * In contrast to ACCESS_ONCE these two macros will also work on aggregate
 308  * data types like structs or unions. If the size of the accessed data
 309  * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
 310  * READ_ONCE() and WRITE_ONCE() will fall back to memcpy(). There's at
 311  * least two memcpy()s: one for the __builtin_memcpy() and then one for
 312  * the macro doing the copy of variable - '__u' allocated on the stack.
 313  *
 314  * Their two major use cases are: (1) Mediating communication between
 315  * process-level code and irq/NMI handlers, all running on the same CPU,
 316  * and (2) Ensuring that the compiler does not  fold, spindle, or otherwise
 317  * mutilate accesses that either do not require ordering or that interact
 318  * with an explicit memory barrier or atomic instruction that provides the
 319  * required ordering.
 320  */
 321 #include <linux/kasan-checks.h>
 322
 323 #define __READ_ONCE(x, check)                                           \
 324 ({                                                                      \
 325         union { typeof(x) __val; char __c[1]; } __u;                    \
 326         if (check)                                                      \
 327                 __read_once_size(&(x), __u.__c, sizeof(x));             \
 328         else                                                            \
 329                 __read_once_size_nocheck(&(x), __u.__c, sizeof(x));     \
 330         __u.__val;                                                      \
 331 })
 332 #define READ_ONCE(x) __READ_ONCE(x, 1)
 333
 334 /*
 335  * Use READ_ONCE_NOCHECK() instead of READ_ONCE() if you need
 336  * to hide memory access from KASAN.
 337  */
 338 #define READ_ONCE_NOCHECK(x) __READ_ONCE(x, 0)
 339
 340 static __no_kasan_or_inline
 341 unsigned long read_word_at_a_time(const void *addr)
 342 {
 343         kasan_check_read(addr, 1);
 344         return *(unsigned long *)addr;
 345 }
 346
 347 #define WRITE_ONCE(x, val) \
 348 ({                                                      \
 349         union { typeof(x) __val; char __c[1]; } __u =   \
 350                 { .__val = (__force typeof(x)) (val) }; \
 351         __write_once_size(&(x), __u.__c, sizeof(x));    \
 352         __u.__val;                                      \
 353 })
 354
 355 #endif /* __KERNEL__ */
 356
 357 #endif /* __ASSEMBLY__ */
 358
 359 #ifdef __KERNEL__
 360 /*
 361  * Allow us to mark functions as 'deprecated' and have gcc emit a nice
 362  * warning for each use, in hopes of speeding the functions removal.
 363  * Usage is:
 364  *              int __deprecated foo(void)
 365  */
 366 #ifndef __deprecated
 367 # define __deprecated           /* unimplemented */
 368 #endif
 369
 370 #ifdef MODULE
 371 #define __deprecated_for_modules __deprecated
 372 #else
 373 #define __deprecated_for_modules
 374 #endif
 375
 376 #ifndef __must_check
 377 #define __must_check
 378 #endif
 379
 380 #ifndef CONFIG_ENABLE_MUST_CHECK
 381 #undef __must_check
 382 #define __must_check
 383 #endif
 384 #ifndef CONFIG_ENABLE_WARN_DEPRECATED
 385 #undef __deprecated
 386 #undef __deprecated_for_modules
 387 #define __deprecated
 388 #define __deprecated_for_modules
 389 #endif
 390
 391 #ifndef __malloc
 392 #define __malloc
 393 #endif
 394
 395 /*
 396  * Allow us to avoid 'defined but not used' warnings on functions and data,
 397  * as well as force them to be emitted to the assembly file.
 398  *
 399  * As of gcc 3.4, static functions that are not marked with attribute((used))
 400  * may be elided from the assembly file.  As of gcc 3.4, static data not so
 401  * marked will not be elided, but this may change in a future gcc version.
 402  *
 403  * NOTE: Because distributions shipped with a backported unit-at-a-time
 404  * compiler in gcc 3.3, we must define __used to be __attribute__((used))
 405  * for gcc >=3.3 instead of 3.4.
 406  *
 407  * In prior versions of gcc, such functions and data would be emitted, but
 408  * would be warned about except with attribute((unused)).
 409  *
 410  * Mark functions that are referenced only in inline assembly as __used so
 411  * the code is emitted even though it appears to be unreferenced.
 412  */
 413 #ifndef __used
 414 # define __used                 /* unimplemented */
 415 #endif
 416
 417 #ifndef __maybe_unused
 418 # define __maybe_unused         /* unimplemented */
 419 #endif
 420
 421 #ifndef __always_unused
 422 # define __always_unused        /* unimplemented */
 423 #endif
 424
 425 #ifndef noinline
 426 #define noinline
 427 #endif
 428
 429 /*
 430  * Rather then using noinline to prevent stack consumption, use
 431  * noinline_for_stack instead.  For documentation reasons.
 432  */
 433 #define noinline_for_stack noinline
 434
 435 #ifndef __always_inline
 436 #define __always_inline inline
 437 #endif
 438
 439 #endif /* __KERNEL__ */
 440
 441 /*
 442  * From the GCC manual:
 443  *
 444  * Many functions do not examine any values except their arguments,
 445  * and have no effects except the return value.  Basically this is
 446  * just slightly more strict class than the `pure' attribute above,
 447  * since function is not allowed to read global memory.
 448  *
 449  * Note that a function that has pointer arguments and examines the
 450  * data pointed to must _not_ be declared `const'.  Likewise, a
 451  * function that calls a non-`const' function usually must not be
 452  * `const'.  It does not make sense for a `const' function to return
 453  * `void'.
 454  */
 455 #ifndef __attribute_const__
 456 # define __attribute_const__    /* unimplemented */
 457 #endif
 458
 459 #ifndef __latent_entropy
 460 # define __latent_entropy
 461 #endif
 462
 463 /*
 464  * Tell gcc if a function is cold. The compiler will assume any path
 465  * directly leading to the call is unlikely.
 466  */
 467
 468 #ifndef __cold
 469 #define __cold
 470 #endif
 471
 472 /* Simple shorthand for a section definition */
 473 #ifndef __section
 474 # define __section(S) __attribute__ ((__section__(#S)))
 475 #endif
 476
 477 #ifndef __visible
 478 #define __visible
 479 #endif
 480
 481 /*
 482  * Assume alignment of return value.
 483  */
 484 #ifndef __assume_aligned
 485 #define __assume_aligned(a, ...)
 486 #endif
 487
 488
 489 /* Are two types/vars the same type (ignoring qualifiers)? */
 490 #ifndef __same_type
 491 # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
 492 #endif
 493
 494 /* Is this type a native word size -- useful for atomic operations */
 495 #ifndef __native_word
 496 # define __native_word(t) (sizeof(t) == sizeof(char) || sizeof(t) == sizeof(short) || sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long))
 497 #endif
 498
 499 #ifndef __optimize
 500 # define __optimize(level)
 501 #endif
 502
 503 /* Compile time object size, -1 for unknown */
 504 #ifndef __compiletime_object_size
 505 # define __compiletime_object_size(obj) -1
 506 #endif
 507 #ifndef __compiletime_warning
 508 # define __compiletime_warning(message)
 509 #endif
 510 #ifndef __compiletime_error
 511 # define __compiletime_error(message)
 512 /*
 513  * Sparse complains of variable sized arrays due to the temporary variable in
 514  * __compiletime_assert. Unfortunately we can't just expand it out to make
 515  * sparse see a constant array size without breaking compiletime_assert on old
 516  * versions of GCC (e.g. 4.2.4), so hide the array from sparse altogether.
 517  */
 518 # ifndef __CHECKER__
 519 #  define __compiletime_error_fallback(condition) \
 520         do { ((void)sizeof(char[1 - 2 * condition])); } while (0)
 521 # endif
 522 #endif
 523 #ifndef __compiletime_error_fallback
 524 # define __compiletime_error_fallback(condition) do { } while (0)
 525 #endif
 526
 527 #define __compiletime_assert(condition, msg, prefix, suffix)            \
 528         do {                                                            \
 529                 bool __cond = !(condition);                             \
 530                 extern void prefix ## suffix(void) __compiletime_error(msg); \
 531                 if (__cond)                                             \
 532                         prefix ## suffix();                             \
 533                 __compiletime_error_fallback(__cond);                   \
 534         } while (0)
 535
 536 #define _compiletime_assert(condition, msg, prefix, suffix) \
 537         __compiletime_assert(condition, msg, prefix, suffix)
 538
 539 /**
 540  * compiletime_assert - break build and emit msg if condition is false
 541  * @condition: a compile-time constant condition to check
 542  * @msg:       a message to emit if condition is false
 543  *
 544  * In tradition of POSIX assert, this macro will break the build if the
 545  * supplied condition is *false*, emitting the supplied error message if the
 546  * compiler has support to do so.
 547  */
 548 #define compiletime_assert(condition, msg) \
 549         _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__)
 550
 551 #define compiletime_assert_atomic_type(t)                               \
 552         compiletime_assert(__native_word(t),                            \
 553                 "Need native word sized stores/loads for atomicity.")
 554
 555 /*
 556  * Prevent the compiler from merging or refetching accesses.  The compiler
 557  * is also forbidden from reordering successive instances of ACCESS_ONCE(),
 558  * but only when the compiler is aware of some particular ordering.  One way
 559  * to make the compiler aware of ordering is to put the two invocations of
 560  * ACCESS_ONCE() in different C statements.
 561  *
 562  * ACCESS_ONCE will only work on scalar types. For union types, ACCESS_ONCE
 563  * on a union member will work as long as the size of the member matches the
 564  * size of the union and the size is smaller than word size.
 565  *
 566  * The major use cases of ACCESS_ONCE used to be (1) Mediating communication
 567  * between process-level code and irq/NMI handlers, all running on the same CPU,
 568  * and (2) Ensuring that the compiler does not  fold, spindle, or otherwise
 569  * mutilate accesses that either do not require ordering or that interact
 570  * with an explicit memory barrier or atomic instruction that provides the
 571  * required ordering.
 572  *
 573  * If possible use READ_ONCE()/WRITE_ONCE() instead.
 574  */
 575 #define __ACCESS_ONCE(x) ({ \
 576          __maybe_unused typeof(x) __var = (__force typeof(x)) 0; \
 577         (volatile typeof(x) *)&(x); })
 578 #define ACCESS_ONCE(x) (*__ACCESS_ONCE(x))
 579
 580 /**
 581  * lockless_dereference() - safely load a pointer for later dereference
 582  * @p: The pointer to load
 583  *
 584  * Similar to rcu_dereference(), but for situations where the pointed-to
 585  * object's lifetime is managed by something other than RCU.  That
 586  * "something other" might be reference counting or simple immortality.
 587  *
 588  * The seemingly unused variable ___typecheck_p validates that @p is
 589  * indeed a pointer type by using a pointer to typeof(*p) as the type.
 590  * Taking a pointer to typeof(*p) again is needed in case p is void *.
 591  */
 592 #define lockless_dereference(p) \
 593 ({ \
 594         typeof(p) _________p1 = READ_ONCE(p); \
 595         typeof(*(p)) *___typecheck_p __maybe_unused; \
 596         smp_read_barrier_depends(); /* Dependency order vs. p above. */ \
 597         (_________p1); \
 598 })
 599
 600 /* Ignore/forbid kprobes attach on very low level functions marked by this attribute: */
 601 #ifdef CONFIG_KPROBES
 602 # define __kprobes      __attribute__((__section__(".kprobes.text")))
 603 # define nokprobe_inline        __always_inline
 604 #else
 605 # define __kprobes
 606 # define nokprobe_inline        inline
 607 #endif
 608
 609 /*
 610  * This is needed in functions which generate the stack canary, see
 611  * arch/x86/kernel/smpboot.c::start_secondary() for an example.
 612  */
 613 #define prevent_tail_call_optimization()        mb()
 614
 615 #endif /* __LINUX_COMPILER_H */