tools/include/linux/compiler.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _TOOLS_LINUX_COMPILER_H_
   3 #define _TOOLS_LINUX_COMPILER_H_
   4
   5 #include <linux/compiler_types.h>
   6
   7 #ifndef __compiletime_error
   8 # define __compiletime_error(message)
   9 #endif
  10
  11 #ifdef __OPTIMIZE__
  12 # define __compiletime_assert(condition, msg, prefix, suffix)           \
  13         do {                                                            \
  14                 extern void prefix ## suffix(void) __compiletime_error(msg); \
  15                 if (!(condition))                                       \
  16                         prefix ## suffix();                             \
  17         } while (0)
  18 #else
  19 # define __compiletime_assert(condition, msg, prefix, suffix) do { } while (0)
  20 #endif
  21
  22 #define _compiletime_assert(condition, msg, prefix, suffix) \
  23         __compiletime_assert(condition, msg, prefix, suffix)
  24
  25 /**
  26  * compiletime_assert - break build and emit msg if condition is false
  27  * @condition: a compile-time constant condition to check
  28  * @msg:       a message to emit if condition is false
  29  *
  30  * In tradition of POSIX assert, this macro will break the build if the
  31  * supplied condition is *false*, emitting the supplied error message if the
  32  * compiler has support to do so.
  33  */
  34 #define compiletime_assert(condition, msg) \
  35         _compiletime_assert(condition, msg, __compiletime_assert_, __COUNTER__)
  36
  37 /* Optimization barrier */
  38 /* The "volatile" is due to gcc bugs */
  39 #define barrier() __asm__ __volatile__("": : :"memory")
  40
  41 #ifndef __always_inline
  42 # define __always_inline        inline __attribute__((always_inline))
  43 #endif
  44
  45 #ifndef __always_unused
  46 #define __always_unused __attribute__((__unused__))
  47 #endif
  48
  49 #ifndef __noreturn
  50 #define __noreturn __attribute__((__noreturn__))
  51 #endif
  52
  53 #ifndef unreachable
  54 #define unreachable() __builtin_unreachable()
  55 #endif
  56
  57 #ifndef noinline
  58 #define noinline
  59 #endif
  60
  61 #ifndef __nocf_check
  62 #define __nocf_check __attribute__((nocf_check))
  63 #endif
  64
  65 /* Are two types/vars the same type (ignoring qualifiers)? */
  66 #ifndef __same_type
  67 # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
  68 #endif
  69
  70 /*
  71  * This returns a constant expression while determining if an argument is
  72  * a constant expression, most importantly without evaluating the argument.
  73  * Glory to Martin Uecker <Martin.Uecker@med.uni-goettingen.de>
  74  */
  75 #define __is_constexpr(x) \
  76         (sizeof(int) == sizeof(*(8 ? ((void *)((long)(x) * 0l)) : (int *)8)))
  77
  78 #ifdef __ANDROID__
  79 /*
  80  * FIXME: Big hammer to get rid of tons of:
  81  *   "warning: always_inline function might not be inlinable"
  82  *
  83  * At least on android-ndk-r12/platforms/android-24/arch-arm
  84  */
  85 #undef __always_inline
  86 #define __always_inline inline
  87 #endif
  88
  89 #define __user
  90 #define __rcu
  91 #define __read_mostly
  92
  93 #ifndef __attribute_const__
  94 # define __attribute_const__
  95 #endif
  96
  97 #ifndef __maybe_unused
  98 # define __maybe_unused         __attribute__((unused))
  99 #endif
 100
 101 #ifndef __used
 102 # define __used         __attribute__((__unused__))
 103 #endif
 104
 105 #ifndef __packed
 106 # define __packed               __attribute__((__packed__))
 107 #endif
 108
 109 #ifndef __force
 110 # define __force
 111 #endif
 112
 113 #ifndef __weak
 114 # define __weak                 __attribute__((weak))
 115 #endif
 116
 117 #ifndef likely
 118 # define likely(x)              __builtin_expect(!!(x), 1)
 119 #endif
 120
 121 #ifndef unlikely
 122 # define unlikely(x)            __builtin_expect(!!(x), 0)
 123 #endif
 124
 125 #ifndef __init
 126 # define __init
 127 #endif
 128
 129 #include <linux/types.h>
 130
 131 /*
 132  * Following functions are taken from kernel sources and
 133  * break aliasing rules in their original form.
 134  *
 135  * While kernel is compiled with -fno-strict-aliasing,
 136  * perf uses -Wstrict-aliasing=3 which makes build fail
 137  * under gcc 4.4.
 138  *
 139  * Using extra __may_alias__ type to allow aliasing
 140  * in this case.
 141  */
 142 typedef __u8  __attribute__((__may_alias__))  __u8_alias_t;
 143 typedef __u16 __attribute__((__may_alias__)) __u16_alias_t;
 144 typedef __u32 __attribute__((__may_alias__)) __u32_alias_t;
 145 typedef __u64 __attribute__((__may_alias__)) __u64_alias_t;
 146
 147 static __always_inline void __read_once_size(const volatile void *p, void *res, int size)
 148 {
 149         switch (size) {
 150         case 1: *(__u8_alias_t  *) res = *(volatile __u8_alias_t  *) p; break;
 151         case 2: *(__u16_alias_t *) res = *(volatile __u16_alias_t *) p; break;
 152         case 4: *(__u32_alias_t *) res = *(volatile __u32_alias_t *) p; break;
 153         case 8: *(__u64_alias_t *) res = *(volatile __u64_alias_t *) p; break;
 154         default:
 155                 barrier();
 156                 __builtin_memcpy((void *)res, (const void *)p, size);
 157                 barrier();
 158         }
 159 }
 160
 161 static __always_inline void __write_once_size(volatile void *p, void *res, int size)
 162 {
 163         switch (size) {
 164         case 1: *(volatile  __u8_alias_t *) p = *(__u8_alias_t  *) res; break;
 165         case 2: *(volatile __u16_alias_t *) p = *(__u16_alias_t *) res; break;
 166         case 4: *(volatile __u32_alias_t *) p = *(__u32_alias_t *) res; break;
 167         case 8: *(volatile __u64_alias_t *) p = *(__u64_alias_t *) res; break;
 168         default:
 169                 barrier();
 170                 __builtin_memcpy((void *)p, (const void *)res, size);
 171                 barrier();
 172         }
 173 }
 174
 175 /*
 176  * Prevent the compiler from merging or refetching reads or writes. The
 177  * compiler is also forbidden from reordering successive instances of
 178  * READ_ONCE and WRITE_ONCE, but only when the compiler is aware of some
 179  * particular ordering. One way to make the compiler aware of ordering is to
 180  * put the two invocations of READ_ONCE or WRITE_ONCE in different C
 181  * statements.
 182  *
 183  * These two macros will also work on aggregate data types like structs or
 184  * unions. If the size of the accessed data type exceeds the word size of
 185  * the machine (e.g., 32 bits or 64 bits) READ_ONCE() and WRITE_ONCE() will
 186  * fall back to memcpy and print a compile-time warning.
 187  *
 188  * Their two major use cases are: (1) Mediating communication between
 189  * process-level code and irq/NMI handlers, all running on the same CPU,
 190  * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
 191  * mutilate accesses that either do not require ordering or that interact
 192  * with an explicit memory barrier or atomic instruction that provides the
 193  * required ordering.
 194  */
 195
 196 #define READ_ONCE(x)                                    \
 197 ({                                                      \
 198         union { typeof(x) __val; char __c[1]; } __u =   \
 199                 { .__c = { 0 } };                       \
 200         __read_once_size(&(x), __u.__c, sizeof(x));     \
 201         __u.__val;                                      \
 202 })
 203
 204 #define WRITE_ONCE(x, val)                              \
 205 ({                                                      \
 206         union { typeof(x) __val; char __c[1]; } __u =   \
 207                 { .__val = (val) };                     \
 208         __write_once_size(&(x), __u.__c, sizeof(x));    \
 209         __u.__val;                                      \
 210 })
 211
 212
 213 /* Indirect macros required for expanded argument pasting, eg. __LINE__. */
 214 #define ___PASTE(a, b) a##b
 215 #define __PASTE(a, b) ___PASTE(a, b)
 216
 217 #ifndef OPTIMIZER_HIDE_VAR
 218 /* Make the optimizer believe the variable can be manipulated arbitrarily. */
 219 #define OPTIMIZER_HIDE_VAR(var)                                         \
 220         __asm__ ("" : "=r" (var) : "0" (var))
 221 #endif
 222
 223 #endif /* _TOOLS_LINUX_COMPILER_H */