compiler.h 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  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. struct ftrace_branch_data {
  55. const char *func;
  56. const char *file;
  57. unsigned line;
  58. union {
  59. struct {
  60. unsigned long correct;
  61. unsigned long incorrect;
  62. };
  63. struct {
  64. unsigned long miss;
  65. unsigned long hit;
  66. };
  67. };
  68. };
  69. /*
  70. * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
  71. * to disable branch tracing on a per file basis.
  72. */
  73. #if defined(CONFIG_TRACE_BRANCH_PROFILING) && !defined(DISABLE_BRANCH_PROFILING)
  74. void ftrace_likely_update(struct ftrace_branch_data *f, int val, int expect);
  75. #define likely_notrace(x) __builtin_expect(!!(x), 1)
  76. #define unlikely_notrace(x) __builtin_expect(!!(x), 0)
  77. #define __branch_check__(x, expect) ({ \
  78. int ______r; \
  79. static struct ftrace_branch_data \
  80. __attribute__((__aligned__(4))) \
  81. __attribute__((section("_ftrace_annotated_branch"))) \
  82. ______f = { \
  83. .func = __func__, \
  84. .file = __FILE__, \
  85. .line = __LINE__, \
  86. }; \
  87. ______r = likely_notrace(x); \
  88. ftrace_likely_update(&______f, ______r, expect); \
  89. ______r; \
  90. })
  91. /*
  92. * Using __builtin_constant_p(x) to ignore cases where the return
  93. * value is always the same. This idea is taken from a similar patch
  94. * written by Daniel Walker.
  95. */
  96. # ifndef likely
  97. # define likely(x) (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 1))
  98. # endif
  99. # ifndef unlikely
  100. # define unlikely(x) (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 0))
  101. # endif
  102. #ifdef CONFIG_PROFILE_ALL_BRANCHES
  103. /*
  104. * "Define 'is'", Bill Clinton
  105. * "Define 'if'", Steven Rostedt
  106. */
  107. #define if(cond) if (__builtin_constant_p((cond)) ? !!(cond) : \
  108. ({ \
  109. int ______r; \
  110. static struct ftrace_branch_data \
  111. __attribute__((__aligned__(4))) \
  112. __attribute__((section("_ftrace_branch"))) \
  113. ______f = { \
  114. .func = __func__, \
  115. .file = __FILE__, \
  116. .line = __LINE__, \
  117. }; \
  118. ______r = !!(cond); \
  119. if (______r) \
  120. ______f.hit++; \
  121. else \
  122. ______f.miss++; \
  123. ______r; \
  124. }))
  125. #endif /* CONFIG_PROFILE_ALL_BRANCHES */
  126. #else
  127. # define likely(x) __builtin_expect(!!(x), 1)
  128. # define unlikely(x) __builtin_expect(!!(x), 0)
  129. #endif
  130. /* Optimization barrier */
  131. #ifndef barrier
  132. # define barrier() __memory_barrier()
  133. #endif
  134. #ifndef RELOC_HIDE
  135. # define RELOC_HIDE(ptr, off) \
  136. ({ unsigned long __ptr; \
  137. __ptr = (unsigned long) (ptr); \
  138. (typeof(ptr)) (__ptr + (off)); })
  139. #endif
  140. #endif /* __KERNEL__ */
  141. #endif /* __ASSEMBLY__ */
  142. #ifdef __KERNEL__
  143. /*
  144. * Allow us to mark functions as 'deprecated' and have gcc emit a nice
  145. * warning for each use, in hopes of speeding the functions removal.
  146. * Usage is:
  147. * int __deprecated foo(void)
  148. */
  149. #ifndef __deprecated
  150. # define __deprecated /* unimplemented */
  151. #endif
  152. #ifdef MODULE
  153. #define __deprecated_for_modules __deprecated
  154. #else
  155. #define __deprecated_for_modules
  156. #endif
  157. #ifndef __must_check
  158. #define __must_check
  159. #endif
  160. #ifndef CONFIG_ENABLE_MUST_CHECK
  161. #undef __must_check
  162. #define __must_check
  163. #endif
  164. #ifndef CONFIG_ENABLE_WARN_DEPRECATED
  165. #undef __deprecated
  166. #undef __deprecated_for_modules
  167. #define __deprecated
  168. #define __deprecated_for_modules
  169. #endif
  170. /*
  171. * Allow us to avoid 'defined but not used' warnings on functions and data,
  172. * as well as force them to be emitted to the assembly file.
  173. *
  174. * As of gcc 3.4, static functions that are not marked with attribute((used))
  175. * may be elided from the assembly file. As of gcc 3.4, static data not so
  176. * marked will not be elided, but this may change in a future gcc version.
  177. *
  178. * NOTE: Because distributions shipped with a backported unit-at-a-time
  179. * compiler in gcc 3.3, we must define __used to be __attribute__((used))
  180. * for gcc >=3.3 instead of 3.4.
  181. *
  182. * In prior versions of gcc, such functions and data would be emitted, but
  183. * would be warned about except with attribute((unused)).
  184. *
  185. * Mark functions that are referenced only in inline assembly as __used so
  186. * the code is emitted even though it appears to be unreferenced.
  187. */
  188. #ifndef __used
  189. # define __used /* unimplemented */
  190. #endif
  191. #ifndef __maybe_unused
  192. # define __maybe_unused /* unimplemented */
  193. #endif
  194. #ifndef noinline
  195. #define noinline
  196. #endif
  197. /*
  198. * Rather then using noinline to prevent stack consumption, use
  199. * noinline_for_stack instead. For documentaiton reasons.
  200. */
  201. #define noinline_for_stack noinline
  202. #ifndef __always_inline
  203. #define __always_inline inline
  204. #endif
  205. #endif /* __KERNEL__ */
  206. /*
  207. * From the GCC manual:
  208. *
  209. * Many functions do not examine any values except their arguments,
  210. * and have no effects except the return value. Basically this is
  211. * just slightly more strict class than the `pure' attribute above,
  212. * since function is not allowed to read global memory.
  213. *
  214. * Note that a function that has pointer arguments and examines the
  215. * data pointed to must _not_ be declared `const'. Likewise, a
  216. * function that calls a non-`const' function usually must not be
  217. * `const'. It does not make sense for a `const' function to return
  218. * `void'.
  219. */
  220. #ifndef __attribute_const__
  221. # define __attribute_const__ /* unimplemented */
  222. #endif
  223. /*
  224. * Tell gcc if a function is cold. The compiler will assume any path
  225. * directly leading to the call is unlikely.
  226. */
  227. #ifndef __cold
  228. #define __cold
  229. #endif
  230. /* Simple shorthand for a section definition */
  231. #ifndef __section
  232. # define __section(S) __attribute__ ((__section__(#S)))
  233. #endif
  234. /*
  235. * Prevent the compiler from merging or refetching accesses. The compiler
  236. * is also forbidden from reordering successive instances of ACCESS_ONCE(),
  237. * but only when the compiler is aware of some particular ordering. One way
  238. * to make the compiler aware of ordering is to put the two invocations of
  239. * ACCESS_ONCE() in different C statements.
  240. *
  241. * This macro does absolutely -nothing- to prevent the CPU from reordering,
  242. * merging, or refetching absolutely anything at any time. Its main intended
  243. * use is to mediate communication between process-level code and irq/NMI
  244. * handlers, all running on the same CPU.
  245. */
  246. #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
  247. #endif /* __LINUX_COMPILER_H */