compiler.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. #ifndef __LINUX_COMPILER_H
  2. #define __LINUX_COMPILER_H
  3. #ifndef __ASSEMBLY__
  4. #ifdef __CHECKER__
  5. # define __user __attribute__((noderef, address_space(1)))
  6. # define __kernel /* default address space */
  7. # define __safe __attribute__((safe))
  8. # define __force __attribute__((force))
  9. # define __nocast __attribute__((nocast))
  10. # define __iomem __attribute__((noderef, address_space(2)))
  11. # define __acquires(x) __attribute__((context(x,0,1)))
  12. # define __releases(x) __attribute__((context(x,1,0)))
  13. # define __acquire(x) __context__(x,1)
  14. # define __release(x) __context__(x,-1)
  15. # define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0)
  16. extern void __chk_user_ptr(const volatile void __user *);
  17. extern void __chk_io_ptr(const volatile void __iomem *);
  18. #else
  19. # define __user
  20. # define __kernel
  21. # define __safe
  22. # define __force
  23. # define __nocast
  24. # define __iomem
  25. # define __chk_user_ptr(x) (void)0
  26. # define __chk_io_ptr(x) (void)0
  27. # define __builtin_warning(x, y...) (1)
  28. # define __acquires(x)
  29. # define __releases(x)
  30. # define __acquire(x) (void)0
  31. # define __release(x) (void)0
  32. # define __cond_lock(x,c) (c)
  33. #endif
  34. #ifdef __KERNEL__
  35. #if __GNUC__ >= 4
  36. # include <linux/compiler-gcc4.h>
  37. #elif __GNUC__ == 3 && __GNUC_MINOR__ >= 2
  38. # include <linux/compiler-gcc3.h>
  39. #else
  40. # error Sorry, your compiler is too old/not recognized.
  41. #endif
  42. #define notrace __attribute__((no_instrument_function))
  43. /* Intel compiler defines __GNUC__. So we will overwrite implementations
  44. * coming from above header files here
  45. */
  46. #ifdef __INTEL_COMPILER
  47. # include <linux/compiler-intel.h>
  48. #endif
  49. /*
  50. * Generic compiler-dependent macros required for kernel
  51. * build go below this comment. Actual compiler/compiler version
  52. * specific implementations come from the above header files
  53. */
  54. #ifdef CONFIG_TRACE_UNLIKELY_PROFILE
  55. struct ftrace_likely_data {
  56. const char *func;
  57. const char *file;
  58. unsigned line;
  59. unsigned long correct;
  60. unsigned long incorrect;
  61. };
  62. void ftrace_likely_update(struct ftrace_likely_data *f, int val, int expect);
  63. #define likely_notrace(x) __builtin_expect(!!(x), 1)
  64. #define unlikely_notrace(x) __builtin_expect(!!(x), 0)
  65. #define likely_check(x) ({ \
  66. int ______r; \
  67. static struct ftrace_likely_data \
  68. __attribute__((__aligned__(4))) \
  69. __attribute__((section("_ftrace_likely"))) \
  70. ______f = { \
  71. .func = __func__, \
  72. .file = __FILE__, \
  73. .line = __LINE__, \
  74. }; \
  75. ______f.line = __LINE__; \
  76. ______r = likely_notrace(x); \
  77. ftrace_likely_update(&______f, ______r, 1); \
  78. ______r; \
  79. })
  80. #define unlikely_check(x) ({ \
  81. int ______r; \
  82. static struct ftrace_likely_data \
  83. __attribute__((__aligned__(4))) \
  84. __attribute__((section("_ftrace_unlikely"))) \
  85. ______f = { \
  86. .func = __func__, \
  87. .file = __FILE__, \
  88. .line = __LINE__, \
  89. }; \
  90. ______f.line = __LINE__; \
  91. ______r = unlikely_notrace(x); \
  92. ftrace_likely_update(&______f, ______r, 0); \
  93. ______r; \
  94. })
  95. /*
  96. * Using __builtin_constant_p(x) to ignore cases where the return
  97. * value is always the same. This idea is taken from a similar patch
  98. * written by Daniel Walker.
  99. */
  100. # ifndef likely
  101. # define likely(x) (__builtin_constant_p(x) ? !!(x) : likely_check(x))
  102. # endif
  103. # ifndef unlikely
  104. # define unlikely(x) (__builtin_constant_p(x) ? !!(x) : unlikely_check(x))
  105. # endif
  106. #else
  107. # define likely(x) __builtin_expect(!!(x), 1)
  108. # define unlikely(x) __builtin_expect(!!(x), 0)
  109. #endif
  110. /* Optimization barrier */
  111. #ifndef barrier
  112. # define barrier() __memory_barrier()
  113. #endif
  114. #ifndef RELOC_HIDE
  115. # define RELOC_HIDE(ptr, off) \
  116. ({ unsigned long __ptr; \
  117. __ptr = (unsigned long) (ptr); \
  118. (typeof(ptr)) (__ptr + (off)); })
  119. #endif
  120. #endif /* __KERNEL__ */
  121. #endif /* __ASSEMBLY__ */
  122. #ifdef __KERNEL__
  123. /*
  124. * Allow us to mark functions as 'deprecated' and have gcc emit a nice
  125. * warning for each use, in hopes of speeding the functions removal.
  126. * Usage is:
  127. * int __deprecated foo(void)
  128. */
  129. #ifndef __deprecated
  130. # define __deprecated /* unimplemented */
  131. #endif
  132. #ifdef MODULE
  133. #define __deprecated_for_modules __deprecated
  134. #else
  135. #define __deprecated_for_modules
  136. #endif
  137. #ifndef __must_check
  138. #define __must_check
  139. #endif
  140. #ifndef CONFIG_ENABLE_MUST_CHECK
  141. #undef __must_check
  142. #define __must_check
  143. #endif
  144. #ifndef CONFIG_ENABLE_WARN_DEPRECATED
  145. #undef __deprecated
  146. #undef __deprecated_for_modules
  147. #define __deprecated
  148. #define __deprecated_for_modules
  149. #endif
  150. /*
  151. * Allow us to avoid 'defined but not used' warnings on functions and data,
  152. * as well as force them to be emitted to the assembly file.
  153. *
  154. * As of gcc 3.4, static functions that are not marked with attribute((used))
  155. * may be elided from the assembly file. As of gcc 3.4, static data not so
  156. * marked will not be elided, but this may change in a future gcc version.
  157. *
  158. * NOTE: Because distributions shipped with a backported unit-at-a-time
  159. * compiler in gcc 3.3, we must define __used to be __attribute__((used))
  160. * for gcc >=3.3 instead of 3.4.
  161. *
  162. * In prior versions of gcc, such functions and data would be emitted, but
  163. * would be warned about except with attribute((unused)).
  164. *
  165. * Mark functions that are referenced only in inline assembly as __used so
  166. * the code is emitted even though it appears to be unreferenced.
  167. */
  168. #ifndef __used
  169. # define __used /* unimplemented */
  170. #endif
  171. #ifndef __maybe_unused
  172. # define __maybe_unused /* unimplemented */
  173. #endif
  174. #ifndef noinline
  175. #define noinline
  176. #endif
  177. /*
  178. * Rather then using noinline to prevent stack consumption, use
  179. * noinline_for_stack instead. For documentaiton reasons.
  180. */
  181. #define noinline_for_stack noinline
  182. #ifndef __always_inline
  183. #define __always_inline inline
  184. #endif
  185. #endif /* __KERNEL__ */
  186. /*
  187. * From the GCC manual:
  188. *
  189. * Many functions do not examine any values except their arguments,
  190. * and have no effects except the return value. Basically this is
  191. * just slightly more strict class than the `pure' attribute above,
  192. * since function is not allowed to read global memory.
  193. *
  194. * Note that a function that has pointer arguments and examines the
  195. * data pointed to must _not_ be declared `const'. Likewise, a
  196. * function that calls a non-`const' function usually must not be
  197. * `const'. It does not make sense for a `const' function to return
  198. * `void'.
  199. */
  200. #ifndef __attribute_const__
  201. # define __attribute_const__ /* unimplemented */
  202. #endif
  203. /*
  204. * Tell gcc if a function is cold. The compiler will assume any path
  205. * directly leading to the call is unlikely.
  206. */
  207. #ifndef __cold
  208. #define __cold
  209. #endif
  210. /* Simple shorthand for a section definition */
  211. #ifndef __section
  212. # define __section(S) __attribute__ ((__section__(#S)))
  213. #endif
  214. /*
  215. * Prevent the compiler from merging or refetching accesses. The compiler
  216. * is also forbidden from reordering successive instances of ACCESS_ONCE(),
  217. * but only when the compiler is aware of some particular ordering. One way
  218. * to make the compiler aware of ordering is to put the two invocations of
  219. * ACCESS_ONCE() in different C statements.
  220. *
  221. * This macro does absolutely -nothing- to prevent the CPU from reordering,
  222. * merging, or refetching absolutely anything at any time. Its main intended
  223. * use is to mediate communication between process-level code and irq/NMI
  224. * handlers, all running on the same CPU.
  225. */
  226. #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
  227. #endif /* __LINUX_COMPILER_H */