include/linux/compiler-gcc.h

   1 #ifndef __LINUX_COMPILER_H
   2 #error "Please don't include <linux/compiler-gcc.h> directly, include <linux/compiler.h> instead."
   3 #endif
   4
   5 /*
   6  * Common definitions for all gcc versions go here.
   7  */
   8 #define GCC_VERSION (__GNUC__ * 10000           \
   9                      + __GNUC_MINOR__ * 100     \
  10                      + __GNUC_PATCHLEVEL__)
  11
  12 /* Optimization barrier */
  13
  14 /* The "volatile" is due to gcc bugs */
  15 #define barrier() __asm__ __volatile__("": : :"memory")
  16 /*
  17  * This version is i.e. to prevent dead stores elimination on @ptr
  18  * where gcc and llvm may behave differently when otherwise using
  19  * normal barrier(): while gcc behavior gets along with a normal
  20  * barrier(), llvm needs an explicit input variable to be assumed
  21  * clobbered. The issue is as follows: while the inline asm might
  22  * access any memory it wants, the compiler could have fit all of
  23  * @ptr into memory registers instead, and since @ptr never escaped
  24  * from that, it proofed that the inline asm wasn't touching any of
  25  * it. This version works well with both compilers, i.e. we're telling
  26  * the compiler that the inline asm absolutely may see the contents
  27  * of @ptr. See also: https://llvm.org/bugs/show_bug.cgi?id=15495
  28  */
  29 #define barrier_data(ptr) __asm__ __volatile__("": :"r"(ptr) :"memory")
  30
  31 /*
  32  * This macro obfuscates arithmetic on a variable address so that gcc
  33  * shouldn't recognize the original var, and make assumptions about it.
  34  *
  35  * This is needed because the C standard makes it undefined to do
  36  * pointer arithmetic on "objects" outside their boundaries and the
  37  * gcc optimizers assume this is the case. In particular they
  38  * assume such arithmetic does not wrap.
  39  *
  40  * A miscompilation has been observed because of this on PPC.
  41  * To work around it we hide the relationship of the pointer and the object
  42  * using this macro.
  43  *
  44  * Versions of the ppc64 compiler before 4.1 had a bug where use of
  45  * RELOC_HIDE could trash r30. The bug can be worked around by changing
  46  * the inline assembly constraint from =g to =r, in this particular
  47  * case either is valid.
  48  */
  49 #define RELOC_HIDE(ptr, off)                                            \
  50 ({                                                                      \
  51         unsigned long __ptr;                                            \
  52         __asm__ ("" : "=r"(__ptr) : "0"(ptr));                          \
  53         (typeof(ptr)) (__ptr + (off));                                  \
  54 })
  55
  56 /* Make the optimizer believe the variable can be manipulated arbitrarily. */
  57 #define OPTIMIZER_HIDE_VAR(var)                                         \
  58         __asm__ ("" : "=r" (var) : "0" (var))
  59
  60 #ifdef __CHECKER__
  61 #define __must_be_array(a)      0
  62 #else
  63 /* &a[0] degrades to a pointer: a different type from an array */
  64 #define __must_be_array(a)      BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
  65 #endif
  66
  67 /*
  68  * Feature detection for gnu_inline (gnu89 extern inline semantics). Either
  69  * __GNUC_STDC_INLINE__ is defined (not using gnu89 extern inline semantics,
  70  * and we opt in to the gnu89 semantics), or __GNUC_STDC_INLINE__ is not
  71  * defined so the gnu89 semantics are the default.
  72  */
  73 #ifdef __GNUC_STDC_INLINE__
  74 # define __gnu_inline   __attribute__((gnu_inline))
  75 #else
  76 # define __gnu_inline
  77 #endif
  78
  79 /*
  80  * Force always-inline if the user requests it so via the .config,
  81  * or if gcc is too old.
  82  * GCC does not warn about unused static inline functions for
  83  * -Wunused-function.  This turns out to avoid the need for complex #ifdef
  84  * directives.  Suppress the warning in clang as well by using "unused"
  85  * function attribute, which is redundant but not harmful for gcc.
  86  * Prefer gnu_inline, so that extern inline functions do not emit an
  87  * externally visible function. This makes extern inline behave as per gnu89
  88  * semantics rather than c99. This prevents multiple symbol definition errors
  89  * of extern inline functions at link time.
  90  * A lot of inline functions can cause havoc with function tracing.
  91  */
  92 #if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) ||                \
  93     !defined(CONFIG_OPTIMIZE_INLINING) || (__GNUC__ < 4)
  94 #define inline \
  95         inline __attribute__((always_inline, unused)) notrace __gnu_inline
  96 #else
  97 #define inline inline           __attribute__((unused)) notrace __gnu_inline
  98 #endif
  99
 100 #define __inline__ inline
 101 #define __inline inline
 102 #define __always_inline inline __attribute__((always_inline))
 103 #define  noinline       __attribute__((noinline))
 104
 105 #define __deprecated    __attribute__((deprecated))
 106 #define __packed        __attribute__((packed))
 107 #define __weak          __attribute__((weak))
 108 #define __alias(symbol) __attribute__((alias(#symbol)))
 109
 110 #ifdef RETPOLINE
 111 #define __noretpoline __attribute__((indirect_branch("keep")))
 112 #endif
 113
 114 /*
 115  * it doesn't make sense on ARM (currently the only user of __naked)
 116  * to trace naked functions because then mcount is called without
 117  * stack and frame pointer being set up and there is no chance to
 118  * restore the lr register to the value before mcount was called.
 119  *
 120  * The asm() bodies of naked functions often depend on standard calling
 121  * conventions, therefore they must be noinline and noclone.
 122  *
 123  * GCC 4.[56] currently fail to enforce this, so we must do so ourselves.
 124  * See GCC PR44290.
 125  */
 126 #define __naked         __attribute__((naked)) noinline __noclone notrace
 127
 128 #define __noreturn      __attribute__((noreturn))
 129
 130 /*
 131  * From the GCC manual:
 132  *
 133  * Many functions have no effects except the return value and their
 134  * return value depends only on the parameters and/or global
 135  * variables.  Such a function can be subject to common subexpression
 136  * elimination and loop optimization just as an arithmetic operator
 137  * would be.
 138  * [...]
 139  */
 140 #define __pure                  __attribute__((pure))
 141 #define __aligned(x)            __attribute__((aligned(x)))
 142 #define __printf(a, b)          __attribute__((format(printf, a, b)))
 143 #define __scanf(a, b)           __attribute__((format(scanf, a, b)))
 144 #define __attribute_const__     __attribute__((__const__))
 145 #define __maybe_unused          __attribute__((unused))
 146 #define __always_unused         __attribute__((unused))
 147
 148 /* gcc version specific checks */
 149
 150 #if GCC_VERSION < 30200
 151 # error Sorry, your compiler is too old - please upgrade it.
 152 #endif
 153
 154 #if GCC_VERSION < 30300
 155 # define __used                 __attribute__((__unused__))
 156 #else
 157 # define __used                 __attribute__((__used__))
 158 #endif
 159
 160 #ifdef CONFIG_GCOV_KERNEL
 161 # if GCC_VERSION < 30400
 162 #   error "GCOV profiling support for gcc versions below 3.4 not included"
 163 # endif /* __GNUC_MINOR__ */
 164 #endif /* CONFIG_GCOV_KERNEL */
 165
 166 #if GCC_VERSION >= 30400
 167 #define __must_check            __attribute__((warn_unused_result))
 168 #define __malloc                __attribute__((__malloc__))
 169 #endif
 170
 171 #if GCC_VERSION >= 40000
 172
 173 /* GCC 4.1.[01] miscompiles __weak */
 174 #ifdef __KERNEL__
 175 # if GCC_VERSION >= 40100 &&  GCC_VERSION <= 40101
 176 #  error Your version of gcc miscompiles the __weak directive
 177 # endif
 178 #endif
 179
 180 #define __used                  __attribute__((__used__))
 181 #define __compiler_offsetof(a, b)                                       \
 182         __builtin_offsetof(a, b)
 183
 184 #if GCC_VERSION >= 40100
 185 # define __compiletime_object_size(obj) __builtin_object_size(obj, 0)
 186 #endif
 187
 188 #if GCC_VERSION >= 40300
 189 /* Mark functions as cold. gcc will assume any path leading to a call
 190  * to them will be unlikely.  This means a lot of manual unlikely()s
 191  * are unnecessary now for any paths leading to the usual suspects
 192  * like BUG(), printk(), panic() etc. [but let's keep them for now for
 193  * older compilers]
 194  *
 195  * Early snapshots of gcc 4.3 don't support this and we can't detect this
 196  * in the preprocessor, but we can live with this because they're unreleased.
 197  * Maketime probing would be overkill here.
 198  *
 199  * gcc also has a __attribute__((__hot__)) to move hot functions into
 200  * a special section, but I don't see any sense in this right now in
 201  * the kernel context
 202  */
 203 #define __cold                  __attribute__((__cold__))
 204
 205 #define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)
 206
 207 #ifndef __CHECKER__
 208 # define __compiletime_warning(message) __attribute__((warning(message)))
 209 # define __compiletime_error(message) __attribute__((error(message)))
 210 #endif /* __CHECKER__ */
 211 #endif /* GCC_VERSION >= 40300 */
 212
 213 #if GCC_VERSION >= 40400
 214 #define __optimize(level)       __attribute__((__optimize__(level)))
 215 #endif /* GCC_VERSION >= 40400 */
 216
 217 #if GCC_VERSION >= 40500
 218
 219 #ifndef __CHECKER__
 220 #ifdef LATENT_ENTROPY_PLUGIN
 221 #define __latent_entropy __attribute__((latent_entropy))
 222 #endif
 223 #endif
 224
 225 #ifdef CONFIG_STACK_VALIDATION
 226 #define annotate_unreachable() ({                                       \
 227         asm("1:\t\n"                                                    \
 228             ".pushsection .discard.unreachable\t\n"                     \
 229             ".long 1b\t\n"                                              \
 230             ".popsection\t\n");                                         \
 231 })
 232 #else
 233 #define annotate_unreachable()
 234 #endif
 235
 236 /*
 237  * calling noreturn functions, __builtin_unreachable() and __builtin_trap()
 238  * confuse the stack allocation in gcc, leading to overly large stack
 239  * frames, see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=82365
 240  *
 241  * Adding an empty inline assembly before it works around the problem
 242  */
 243 #define barrier_before_unreachable() asm volatile("")
 244
 245 /*
 246  * Mark a position in code as unreachable.  This can be used to
 247  * suppress control flow warnings after asm blocks that transfer
 248  * control elsewhere.
 249  *
 250  * Early snapshots of gcc 4.5 don't support this and we can't detect
 251  * this in the preprocessor, but we can live with this because they're
 252  * unreleased.  Really, we need to have autoconf for the kernel.
 253  */
 254 #define unreachable() \
 255         do {                                    \
 256                 annotate_unreachable();         \
 257                 barrier_before_unreachable();   \
 258                 __builtin_unreachable();        \
 259         } while (0)
 260
 261 /* Mark a function definition as prohibited from being cloned. */
 262 #define __noclone       __attribute__((__noclone__, __optimize__("no-tracer")))
 263
 264 #endif /* GCC_VERSION >= 40500 */
 265
 266 #if GCC_VERSION >= 40600
 267 /*
 268  * When used with Link Time Optimization, gcc can optimize away C functions or
 269  * variables which are referenced only from assembly code.  __visible tells the
 270  * optimizer that something else uses this function or variable, thus preventing
 271  * this.
 272  */
 273 #define __visible       __attribute__((externally_visible))
 274 #endif
 275
 276
 277 #if GCC_VERSION >= 40900 && !defined(__CHECKER__)
 278 /*
 279  * __assume_aligned(n, k): Tell the optimizer that the returned
 280  * pointer can be assumed to be k modulo n. The second argument is
 281  * optional (default 0), so we use a variadic macro to make the
 282  * shorthand.
 283  *
 284  * Beware: Do not apply this to functions which may return
 285  * ERR_PTRs. Also, it is probably unwise to apply it to functions
 286  * returning extra information in the low bits (but in that case the
 287  * compiler should see some alignment anyway, when the return value is
 288  * massaged by 'flags = ptr & 3; ptr &= ~3;').
 289  */
 290 #define __assume_aligned(a, ...) __attribute__((__assume_aligned__(a, ## __VA_ARGS__)))
 291 #endif
 292
 293 /*
 294  * GCC 'asm goto' miscompiles certain code sequences:
 295  *
 296  *   http://gcc.gnu.org/bugzilla/show_bug.cgi?id=58670
 297  *
 298  * Work it around via a compiler barrier quirk suggested by Jakub Jelinek.
 299  *
 300  * (asm goto is automatically volatile - the naming reflects this.)
 301  */
 302 #define asm_volatile_goto(x...) do { asm goto(x); asm (""); } while (0)
 303
 304 /*
 305  * sparse (__CHECKER__) pretends to be gcc, but can't do constant
 306  * folding in __builtin_bswap*() (yet), so don't set these for it.
 307  */
 308 #if defined(CONFIG_ARCH_USE_BUILTIN_BSWAP) && !defined(__CHECKER__)
 309 #if GCC_VERSION >= 40400
 310 #define __HAVE_BUILTIN_BSWAP32__
 311 #define __HAVE_BUILTIN_BSWAP64__
 312 #endif
 313 #if GCC_VERSION >= 40800
 314 #define __HAVE_BUILTIN_BSWAP16__
 315 #endif
 316 #endif /* CONFIG_ARCH_USE_BUILTIN_BSWAP && !__CHECKER__ */
 317
 318 #if GCC_VERSION >= 70000
 319 #define KASAN_ABI_VERSION 5
 320 #elif GCC_VERSION >= 50000
 321 #define KASAN_ABI_VERSION 4
 322 #elif GCC_VERSION >= 40902
 323 #define KASAN_ABI_VERSION 3
 324 #endif
 325
 326 #if GCC_VERSION >= 40902
 327 /*
 328  * Tell the compiler that address safety instrumentation (KASAN)
 329  * should not be applied to that function.
 330  * Conflicts with inlining: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
 331  */
 332 #define __no_sanitize_address __attribute__((no_sanitize_address))
 333 #endif
 334
 335 #endif  /* gcc version >= 40000 specific checks */
 336
 337 #if !defined(__noclone)
 338 #define __noclone       /* not needed */
 339 #endif
 340
 341 #if !defined(__no_sanitize_address)
 342 #define __no_sanitize_address
 343 #endif
 344
 345 /*
 346  * A trick to suppress uninitialized variable warning without generating any
 347  * code
 348  */
 349 #define uninitialized_var(x) x = x
 350
 351 #if GCC_VERSION >= 50100
 352 #define COMPILER_HAS_GENERIC_BUILTIN_OVERFLOW 1
 353 #endif