compiler-gcc.h 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  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. * Force always-inline if the user requests it so via the .config,
  62. * or if gcc is too old:
  63. */
  64. #if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) || \
  65. !defined(CONFIG_OPTIMIZE_INLINING) || (__GNUC__ < 4)
  66. #define inline inline __attribute__((always_inline)) notrace
  67. #define __inline__ __inline__ __attribute__((always_inline)) notrace
  68. #define __inline __inline __attribute__((always_inline)) notrace
  69. #else
  70. /* A lot of inline functions can cause havoc with function tracing */
  71. #define inline inline notrace
  72. #define __inline__ __inline__ notrace
  73. #define __inline __inline notrace
  74. #endif
  75. #define __always_inline inline __attribute__((always_inline))
  76. #define noinline __attribute__((noinline))
  77. #define __deprecated __attribute__((deprecated))
  78. #define __packed __attribute__((packed))
  79. #define __weak __attribute__((weak))
  80. #define __alias(symbol) __attribute__((alias(#symbol)))
  81. /*
  82. * it doesn't make sense on ARM (currently the only user of __naked)
  83. * to trace naked functions because then mcount is called without
  84. * stack and frame pointer being set up and there is no chance to
  85. * restore the lr register to the value before mcount was called.
  86. *
  87. * The asm() bodies of naked functions often depend on standard calling
  88. * conventions, therefore they must be noinline and noclone.
  89. *
  90. * GCC 4.[56] currently fail to enforce this, so we must do so ourselves.
  91. * See GCC PR44290.
  92. */
  93. #define __naked __attribute__((naked)) noinline __noclone notrace
  94. #define __noreturn __attribute__((noreturn))
  95. /*
  96. * From the GCC manual:
  97. *
  98. * Many functions have no effects except the return value and their
  99. * return value depends only on the parameters and/or global
  100. * variables. Such a function can be subject to common subexpression
  101. * elimination and loop optimization just as an arithmetic operator
  102. * would be.
  103. * [...]
  104. */
  105. #define __pure __attribute__((pure))
  106. #define __aligned(x) __attribute__((aligned(x)))
  107. #define __printf(a, b) __attribute__((format(printf, a, b)))
  108. #define __scanf(a, b) __attribute__((format(scanf, a, b)))
  109. #define __attribute_const__ __attribute__((__const__))
  110. #define __maybe_unused __attribute__((unused))
  111. #define __always_unused __attribute__((unused))
  112. /* gcc version specific checks */
  113. #if GCC_VERSION < 30200
  114. # error Sorry, your compiler is too old - please upgrade it.
  115. #endif
  116. #if GCC_VERSION < 30300
  117. # define __used __attribute__((__unused__))
  118. #else
  119. # define __used __attribute__((__used__))
  120. #endif
  121. #ifdef CONFIG_GCOV_KERNEL
  122. # if GCC_VERSION < 30400
  123. # error "GCOV profiling support for gcc versions below 3.4 not included"
  124. # endif /* __GNUC_MINOR__ */
  125. #endif /* CONFIG_GCOV_KERNEL */
  126. #if GCC_VERSION >= 30400
  127. #define __must_check __attribute__((warn_unused_result))
  128. #define __malloc __attribute__((__malloc__))
  129. #endif
  130. #if GCC_VERSION >= 40000
  131. /* GCC 4.1.[01] miscompiles __weak */
  132. #ifdef __KERNEL__
  133. # if GCC_VERSION >= 40100 && GCC_VERSION <= 40101
  134. # error Your version of gcc miscompiles the __weak directive
  135. # endif
  136. #endif
  137. #define __used __attribute__((__used__))
  138. #define __compiler_offsetof(a, b) \
  139. __builtin_offsetof(a, b)
  140. #if GCC_VERSION >= 40100
  141. # define __compiletime_object_size(obj) __builtin_object_size(obj, 0)
  142. #endif
  143. #if GCC_VERSION >= 40300
  144. /* Mark functions as cold. gcc will assume any path leading to a call
  145. * to them will be unlikely. This means a lot of manual unlikely()s
  146. * are unnecessary now for any paths leading to the usual suspects
  147. * like BUG(), printk(), panic() etc. [but let's keep them for now for
  148. * older compilers]
  149. *
  150. * Early snapshots of gcc 4.3 don't support this and we can't detect this
  151. * in the preprocessor, but we can live with this because they're unreleased.
  152. * Maketime probing would be overkill here.
  153. *
  154. * gcc also has a __attribute__((__hot__)) to move hot functions into
  155. * a special section, but I don't see any sense in this right now in
  156. * the kernel context
  157. */
  158. #define __cold __attribute__((__cold__))
  159. #define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)
  160. #ifndef __CHECKER__
  161. # define __compiletime_warning(message) __attribute__((warning(message)))
  162. # define __compiletime_error(message) __attribute__((error(message)))
  163. #endif /* __CHECKER__ */
  164. #endif /* GCC_VERSION >= 40300 */
  165. #if GCC_VERSION >= 40500
  166. #ifndef __CHECKER__
  167. #ifdef LATENT_ENTROPY_PLUGIN
  168. #define __latent_entropy __attribute__((latent_entropy))
  169. #endif
  170. #endif
  171. /*
  172. * Mark a position in code as unreachable. This can be used to
  173. * suppress control flow warnings after asm blocks that transfer
  174. * control elsewhere.
  175. *
  176. * Early snapshots of gcc 4.5 don't support this and we can't detect
  177. * this in the preprocessor, but we can live with this because they're
  178. * unreleased. Really, we need to have autoconf for the kernel.
  179. */
  180. #define unreachable() __builtin_unreachable()
  181. /* Mark a function definition as prohibited from being cloned. */
  182. #define __noclone __attribute__((__noclone__, __optimize__("no-tracer")))
  183. #endif /* GCC_VERSION >= 40500 */
  184. #if GCC_VERSION >= 40600
  185. /*
  186. * When used with Link Time Optimization, gcc can optimize away C functions or
  187. * variables which are referenced only from assembly code. __visible tells the
  188. * optimizer that something else uses this function or variable, thus preventing
  189. * this.
  190. */
  191. #define __visible __attribute__((externally_visible))
  192. #endif
  193. #if GCC_VERSION >= 40900 && !defined(__CHECKER__)
  194. /*
  195. * __assume_aligned(n, k): Tell the optimizer that the returned
  196. * pointer can be assumed to be k modulo n. The second argument is
  197. * optional (default 0), so we use a variadic macro to make the
  198. * shorthand.
  199. *
  200. * Beware: Do not apply this to functions which may return
  201. * ERR_PTRs. Also, it is probably unwise to apply it to functions
  202. * returning extra information in the low bits (but in that case the
  203. * compiler should see some alignment anyway, when the return value is
  204. * massaged by 'flags = ptr & 3; ptr &= ~3;').
  205. */
  206. #define __assume_aligned(a, ...) __attribute__((__assume_aligned__(a, ## __VA_ARGS__)))
  207. #endif
  208. /*
  209. * GCC 'asm goto' miscompiles certain code sequences:
  210. *
  211. * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=58670
  212. *
  213. * Work it around via a compiler barrier quirk suggested by Jakub Jelinek.
  214. *
  215. * (asm goto is automatically volatile - the naming reflects this.)
  216. */
  217. #define asm_volatile_goto(x...) do { asm goto(x); asm (""); } while (0)
  218. /*
  219. * sparse (__CHECKER__) pretends to be gcc, but can't do constant
  220. * folding in __builtin_bswap*() (yet), so don't set these for it.
  221. */
  222. #if defined(CONFIG_ARCH_USE_BUILTIN_BSWAP) && !defined(__CHECKER__)
  223. #if GCC_VERSION >= 40400
  224. #define __HAVE_BUILTIN_BSWAP32__
  225. #define __HAVE_BUILTIN_BSWAP64__
  226. #endif
  227. #if GCC_VERSION >= 40800
  228. #define __HAVE_BUILTIN_BSWAP16__
  229. #endif
  230. #endif /* CONFIG_ARCH_USE_BUILTIN_BSWAP && !__CHECKER__ */
  231. #if GCC_VERSION >= 70000
  232. #define KASAN_ABI_VERSION 5
  233. #elif GCC_VERSION >= 50000
  234. #define KASAN_ABI_VERSION 4
  235. #elif GCC_VERSION >= 40902
  236. #define KASAN_ABI_VERSION 3
  237. #endif
  238. #if GCC_VERSION >= 40902
  239. /*
  240. * Tell the compiler that address safety instrumentation (KASAN)
  241. * should not be applied to that function.
  242. * Conflicts with inlining: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67368
  243. */
  244. #define __no_sanitize_address __attribute__((no_sanitize_address))
  245. #endif
  246. #endif /* gcc version >= 40000 specific checks */
  247. #if !defined(__noclone)
  248. #define __noclone /* not needed */
  249. #endif
  250. #if !defined(__no_sanitize_address)
  251. #define __no_sanitize_address
  252. #endif
  253. /*
  254. * A trick to suppress uninitialized variable warning without generating any
  255. * code
  256. */
  257. #define uninitialized_var(x) x = x