compiler-gcc.h 10 KB

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