compiler-gcc.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  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 macro obfuscates arithmetic on a variable address so that gcc
  15. * shouldn't recognize the original var, and make assumptions about it.
  16. *
  17. * This is needed because the C standard makes it undefined to do
  18. * pointer arithmetic on "objects" outside their boundaries and the
  19. * gcc optimizers assume this is the case. In particular they
  20. * assume such arithmetic does not wrap.
  21. *
  22. * A miscompilation has been observed because of this on PPC.
  23. * To work around it we hide the relationship of the pointer and the object
  24. * using this macro.
  25. *
  26. * Versions of the ppc64 compiler before 4.1 had a bug where use of
  27. * RELOC_HIDE could trash r30. The bug can be worked around by changing
  28. * the inline assembly constraint from =g to =r, in this particular
  29. * case either is valid.
  30. */
  31. #define RELOC_HIDE(ptr, off) \
  32. ({ unsigned long __ptr; \
  33. __asm__ ("" : "=r"(__ptr) : "0"(ptr)); \
  34. (typeof(ptr)) (__ptr + (off)); })
  35. /* Make the optimizer believe the variable can be manipulated arbitrarily. */
  36. #define OPTIMIZER_HIDE_VAR(var) __asm__ ("" : "=r" (var) : "0" (var))
  37. #ifdef __CHECKER__
  38. #define __must_be_array(arr) 0
  39. #else
  40. /* &a[0] degrades to a pointer: a different type from an array */
  41. #define __must_be_array(a) BUILD_BUG_ON_ZERO(__same_type((a), &(a)[0]))
  42. #endif
  43. /*
  44. * Force always-inline if the user requests it so via the .config,
  45. * or if gcc is too old:
  46. */
  47. #if !defined(CONFIG_ARCH_SUPPORTS_OPTIMIZED_INLINING) || \
  48. !defined(CONFIG_OPTIMIZE_INLINING) || (__GNUC__ < 4)
  49. # define inline inline __attribute__((always_inline))
  50. # define __inline__ __inline__ __attribute__((always_inline))
  51. # define __inline __inline __attribute__((always_inline))
  52. #else
  53. /* A lot of inline functions can cause havoc with function tracing */
  54. # define inline inline notrace
  55. # define __inline__ __inline__ notrace
  56. # define __inline __inline notrace
  57. #endif
  58. #define __deprecated __attribute__((deprecated))
  59. #define __packed __attribute__((packed))
  60. #define __weak __attribute__((weak))
  61. /*
  62. * it doesn't make sense on ARM (currently the only user of __naked) to trace
  63. * naked functions because then mcount is called without stack and frame pointer
  64. * being set up and there is no chance to restore the lr register to the value
  65. * before mcount was called.
  66. *
  67. * The asm() bodies of naked functions often depend on standard calling conventions,
  68. * therefore they must be noinline and noclone. GCC 4.[56] currently fail to enforce
  69. * this, so we must do so ourselves. See GCC PR44290.
  70. */
  71. #define __naked __attribute__((naked)) noinline __noclone notrace
  72. #define __noreturn __attribute__((noreturn))
  73. /*
  74. * From the GCC manual:
  75. *
  76. * Many functions have no effects except the return value and their
  77. * return value depends only on the parameters and/or global
  78. * variables. Such a function can be subject to common subexpression
  79. * elimination and loop optimization just as an arithmetic operator
  80. * would be.
  81. * [...]
  82. */
  83. #define __pure __attribute__((pure))
  84. #define __aligned(x) __attribute__((aligned(x)))
  85. #define __printf(a, b) __attribute__((format(printf, a, b)))
  86. #define __scanf(a, b) __attribute__((format(scanf, a, b)))
  87. #define noinline __attribute__((noinline))
  88. #define __attribute_const__ __attribute__((__const__))
  89. #define __maybe_unused __attribute__((unused))
  90. #define __always_unused __attribute__((unused))
  91. /* gcc version specific checks */
  92. #if GCC_VERSION < 30200
  93. # error Sorry, your compiler is too old - please upgrade it.
  94. #endif
  95. #if GCC_VERSION < 30300
  96. # define __used __attribute__((__unused__))
  97. #else
  98. # define __used __attribute__((__used__))
  99. #endif
  100. #ifdef CONFIG_GCOV_KERNEL
  101. # if GCC_VERSION < 30400
  102. # error "GCOV profiling support for gcc versions below 3.4 not included"
  103. # endif /* __GNUC_MINOR__ */
  104. #endif /* CONFIG_GCOV_KERNEL */
  105. #if GCC_VERSION >= 30400
  106. #define __must_check __attribute__((warn_unused_result))
  107. #endif
  108. #if GCC_VERSION >= 40000
  109. /* GCC 4.1.[01] miscompiles __weak */
  110. #ifdef __KERNEL__
  111. # if GCC_VERSION >= 40100 && GCC_VERSION <= 40101
  112. # error Your version of gcc miscompiles the __weak directive
  113. # endif
  114. #endif
  115. #define __used __attribute__((__used__))
  116. #define __compiler_offsetof(a, b) \
  117. __builtin_offsetof(a, b)
  118. #if GCC_VERSION >= 40100 && GCC_VERSION < 40600
  119. # define __compiletime_object_size(obj) __builtin_object_size(obj, 0)
  120. #endif
  121. #if GCC_VERSION >= 40300
  122. /* Mark functions as cold. gcc will assume any path leading to a call
  123. * to them will be unlikely. This means a lot of manual unlikely()s
  124. * are unnecessary now for any paths leading to the usual suspects
  125. * like BUG(), printk(), panic() etc. [but let's keep them for now for
  126. * older compilers]
  127. *
  128. * Early snapshots of gcc 4.3 don't support this and we can't detect this
  129. * in the preprocessor, but we can live with this because they're unreleased.
  130. * Maketime probing would be overkill here.
  131. *
  132. * gcc also has a __attribute__((__hot__)) to move hot functions into
  133. * a special section, but I don't see any sense in this right now in
  134. * the kernel context
  135. */
  136. #define __cold __attribute__((__cold__))
  137. #define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __COUNTER__)
  138. #ifndef __CHECKER__
  139. # define __compiletime_warning(message) __attribute__((warning(message)))
  140. # define __compiletime_error(message) __attribute__((error(message)))
  141. #endif /* __CHECKER__ */
  142. #endif /* GCC_VERSION >= 40300 */
  143. #if GCC_VERSION >= 40500
  144. /*
  145. * calling noreturn functions, __builtin_unreachable() and __builtin_trap()
  146. * confuse the stack allocation in gcc, leading to overly large stack
  147. * frames, see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=82365
  148. *
  149. * Adding an empty inline assembly before it works around the problem
  150. */
  151. #define barrier_before_unreachable() asm volatile("")
  152. /*
  153. * Mark a position in code as unreachable. This can be used to
  154. * suppress control flow warnings after asm blocks that transfer
  155. * control elsewhere.
  156. *
  157. * Early snapshots of gcc 4.5 don't support this and we can't detect
  158. * this in the preprocessor, but we can live with this because they're
  159. * unreleased. Really, we need to have autoconf for the kernel.
  160. */
  161. #define unreachable() \
  162. do { \
  163. barrier_before_unreachable(); \
  164. __builtin_unreachable(); \
  165. } while (0)
  166. /* Mark a function definition as prohibited from being cloned. */
  167. #define __noclone __attribute__((__noclone__))
  168. #endif /* GCC_VERSION >= 40500 */
  169. #if GCC_VERSION >= 40600
  170. /*
  171. * Tell the optimizer that something else uses this function or variable.
  172. */
  173. #define __visible __attribute__((externally_visible))
  174. #endif
  175. /*
  176. * GCC 'asm goto' miscompiles certain code sequences:
  177. *
  178. * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=58670
  179. *
  180. * Work it around via a compiler barrier quirk suggested by Jakub Jelinek.
  181. *
  182. * (asm goto is automatically volatile - the naming reflects this.)
  183. */
  184. #define asm_volatile_goto(x...) do { asm goto(x); asm (""); } while (0)
  185. #ifdef CONFIG_ARCH_USE_BUILTIN_BSWAP
  186. #if GCC_VERSION >= 40400
  187. #define __HAVE_BUILTIN_BSWAP32__
  188. #define __HAVE_BUILTIN_BSWAP64__
  189. #endif
  190. #if GCC_VERSION >= 40800 || (defined(__powerpc__) && GCC_VERSION >= 40600)
  191. #define __HAVE_BUILTIN_BSWAP16__
  192. #endif
  193. #endif /* CONFIG_ARCH_USE_BUILTIN_BSWAP */
  194. #if GCC_VERSION >= 50000
  195. #define KASAN_ABI_VERSION 4
  196. #elif GCC_VERSION >= 40902
  197. #define KASAN_ABI_VERSION 3
  198. #endif
  199. #endif /* gcc version >= 40000 specific checks */
  200. #if !defined(__noclone)
  201. #define __noclone /* not needed */
  202. #endif
  203. /*
  204. * A trick to suppress uninitialized variable warning without generating any
  205. * code
  206. */
  207. #define uninitialized_var(x) x = x
  208. #define __always_inline inline __attribute__((always_inline))