compiler.h 8.4 KB

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