compiler.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391
  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 __must_hold(x) __attribute__((context(x,1,1)))
  12. # define __acquires(x) __attribute__((context(x,0,1)))
  13. # define __releases(x) __attribute__((context(x,1,0)))
  14. # define __acquire(x) __context__(x,1)
  15. # define __release(x) __context__(x,-1)
  16. # define __cond_lock(x,c) ((c) ? ({ __acquire(x); 1; }) : 0)
  17. # define __percpu __attribute__((noderef, address_space(3)))
  18. #ifdef CONFIG_SPARSE_RCU_POINTER
  19. # define __rcu __attribute__((noderef, address_space(4)))
  20. #else
  21. # define __rcu
  22. #endif
  23. extern void __chk_user_ptr(const volatile void __user *);
  24. extern void __chk_io_ptr(const volatile void __iomem *);
  25. #else
  26. # define __user
  27. # define __kernel
  28. # define __safe
  29. # define __force
  30. # define __nocast
  31. # define __iomem
  32. # define __chk_user_ptr(x) (void)0
  33. # define __chk_io_ptr(x) (void)0
  34. # define __builtin_warning(x, y...) (1)
  35. # define __must_hold(x)
  36. # define __acquires(x)
  37. # define __releases(x)
  38. # define __acquire(x) (void)0
  39. # define __release(x) (void)0
  40. # define __cond_lock(x,c) (c)
  41. # define __percpu
  42. # define __rcu
  43. #endif
  44. /* Indirect macros required for expanded argument pasting, eg. __LINE__. */
  45. #define ___PASTE(a,b) a##b
  46. #define __PASTE(a,b) ___PASTE(a,b)
  47. #ifdef __KERNEL__
  48. #ifdef __GNUC__
  49. #include <linux/compiler-gcc.h>
  50. #endif
  51. #define notrace __attribute__((no_instrument_function))
  52. /* Intel compiler defines __GNUC__. So we will overwrite implementations
  53. * coming from above header files here
  54. */
  55. #ifdef __INTEL_COMPILER
  56. # include <linux/compiler-intel.h>
  57. #endif
  58. /* Clang compiler defines __GNUC__. So we will overwrite implementations
  59. * coming from above header files here
  60. */
  61. #ifdef __clang__
  62. #include <linux/compiler-clang.h>
  63. #endif
  64. /*
  65. * Generic compiler-dependent macros required for kernel
  66. * build go below this comment. Actual compiler/compiler version
  67. * specific implementations come from the above header files
  68. */
  69. struct ftrace_branch_data {
  70. const char *func;
  71. const char *file;
  72. unsigned line;
  73. union {
  74. struct {
  75. unsigned long correct;
  76. unsigned long incorrect;
  77. };
  78. struct {
  79. unsigned long miss;
  80. unsigned long hit;
  81. };
  82. unsigned long miss_hit[2];
  83. };
  84. };
  85. /*
  86. * Note: DISABLE_BRANCH_PROFILING can be used by special lowlevel code
  87. * to disable branch tracing on a per file basis.
  88. */
  89. #if defined(CONFIG_TRACE_BRANCH_PROFILING) \
  90. && !defined(DISABLE_BRANCH_PROFILING) && !defined(__CHECKER__)
  91. void ftrace_likely_update(struct ftrace_branch_data *f, int val, int expect);
  92. #define likely_notrace(x) __builtin_expect(!!(x), 1)
  93. #define unlikely_notrace(x) __builtin_expect(!!(x), 0)
  94. #define __branch_check__(x, expect) ({ \
  95. int ______r; \
  96. static struct ftrace_branch_data \
  97. __attribute__((__aligned__(4))) \
  98. __attribute__((section("_ftrace_annotated_branch"))) \
  99. ______f = { \
  100. .func = __func__, \
  101. .file = __FILE__, \
  102. .line = __LINE__, \
  103. }; \
  104. ______r = likely_notrace(x); \
  105. ftrace_likely_update(&______f, ______r, expect); \
  106. ______r; \
  107. })
  108. /*
  109. * Using __builtin_constant_p(x) to ignore cases where the return
  110. * value is always the same. This idea is taken from a similar patch
  111. * written by Daniel Walker.
  112. */
  113. # ifndef likely
  114. # define likely(x) (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 1))
  115. # endif
  116. # ifndef unlikely
  117. # define unlikely(x) (__builtin_constant_p(x) ? !!(x) : __branch_check__(x, 0))
  118. # endif
  119. #ifdef CONFIG_PROFILE_ALL_BRANCHES
  120. /*
  121. * "Define 'is'", Bill Clinton
  122. * "Define 'if'", Steven Rostedt
  123. */
  124. #define if(cond, ...) __trace_if( (cond , ## __VA_ARGS__) )
  125. #define __trace_if(cond) \
  126. if (__builtin_constant_p((cond)) ? !!(cond) : \
  127. ({ \
  128. int ______r; \
  129. static struct ftrace_branch_data \
  130. __attribute__((__aligned__(4))) \
  131. __attribute__((section("_ftrace_branch"))) \
  132. ______f = { \
  133. .func = __func__, \
  134. .file = __FILE__, \
  135. .line = __LINE__, \
  136. }; \
  137. ______r = !!(cond); \
  138. ______f.miss_hit[______r]++; \
  139. ______r; \
  140. }))
  141. #endif /* CONFIG_PROFILE_ALL_BRANCHES */
  142. #else
  143. # define likely(x) __builtin_expect(!!(x), 1)
  144. # define unlikely(x) __builtin_expect(!!(x), 0)
  145. #endif
  146. /* Optimization barrier */
  147. #ifndef barrier
  148. # define barrier() __memory_barrier()
  149. #endif
  150. /* Unreachable code */
  151. #ifndef unreachable
  152. # define unreachable() do { } while (1)
  153. #endif
  154. #ifndef RELOC_HIDE
  155. # define RELOC_HIDE(ptr, off) \
  156. ({ unsigned long __ptr; \
  157. __ptr = (unsigned long) (ptr); \
  158. (typeof(ptr)) (__ptr + (off)); })
  159. #endif
  160. #ifndef OPTIMIZER_HIDE_VAR
  161. #define OPTIMIZER_HIDE_VAR(var) barrier()
  162. #endif
  163. /* Not-quite-unique ID. */
  164. #ifndef __UNIQUE_ID
  165. # define __UNIQUE_ID(prefix) __PASTE(__PASTE(__UNIQUE_ID_, prefix), __LINE__)
  166. #endif
  167. #endif /* __KERNEL__ */
  168. #endif /* __ASSEMBLY__ */
  169. #ifdef __KERNEL__
  170. /*
  171. * Allow us to mark functions as 'deprecated' and have gcc emit a nice
  172. * warning for each use, in hopes of speeding the functions removal.
  173. * Usage is:
  174. * int __deprecated foo(void)
  175. */
  176. #ifndef __deprecated
  177. # define __deprecated /* unimplemented */
  178. #endif
  179. #ifdef MODULE
  180. #define __deprecated_for_modules __deprecated
  181. #else
  182. #define __deprecated_for_modules
  183. #endif
  184. #ifndef __must_check
  185. #define __must_check
  186. #endif
  187. #ifndef CONFIG_ENABLE_MUST_CHECK
  188. #undef __must_check
  189. #define __must_check
  190. #endif
  191. #ifndef CONFIG_ENABLE_WARN_DEPRECATED
  192. #undef __deprecated
  193. #undef __deprecated_for_modules
  194. #define __deprecated
  195. #define __deprecated_for_modules
  196. #endif
  197. /*
  198. * Allow us to avoid 'defined but not used' warnings on functions and data,
  199. * as well as force them to be emitted to the assembly file.
  200. *
  201. * As of gcc 3.4, static functions that are not marked with attribute((used))
  202. * may be elided from the assembly file. As of gcc 3.4, static data not so
  203. * marked will not be elided, but this may change in a future gcc version.
  204. *
  205. * NOTE: Because distributions shipped with a backported unit-at-a-time
  206. * compiler in gcc 3.3, we must define __used to be __attribute__((used))
  207. * for gcc >=3.3 instead of 3.4.
  208. *
  209. * In prior versions of gcc, such functions and data would be emitted, but
  210. * would be warned about except with attribute((unused)).
  211. *
  212. * Mark functions that are referenced only in inline assembly as __used so
  213. * the code is emitted even though it appears to be unreferenced.
  214. */
  215. #ifndef __used
  216. # define __used /* unimplemented */
  217. #endif
  218. #ifndef __maybe_unused
  219. # define __maybe_unused /* unimplemented */
  220. #endif
  221. #ifndef __always_unused
  222. # define __always_unused /* unimplemented */
  223. #endif
  224. #ifndef noinline
  225. #define noinline
  226. #endif
  227. /*
  228. * Rather then using noinline to prevent stack consumption, use
  229. * noinline_for_stack instead. For documentation reasons.
  230. */
  231. #define noinline_for_stack noinline
  232. #ifndef __always_inline
  233. #define __always_inline inline
  234. #endif
  235. #endif /* __KERNEL__ */
  236. /*
  237. * From the GCC manual:
  238. *
  239. * Many functions do not examine any values except their arguments,
  240. * and have no effects except the return value. Basically this is
  241. * just slightly more strict class than the `pure' attribute above,
  242. * since function is not allowed to read global memory.
  243. *
  244. * Note that a function that has pointer arguments and examines the
  245. * data pointed to must _not_ be declared `const'. Likewise, a
  246. * function that calls a non-`const' function usually must not be
  247. * `const'. It does not make sense for a `const' function to return
  248. * `void'.
  249. */
  250. #ifndef __attribute_const__
  251. # define __attribute_const__ /* unimplemented */
  252. #endif
  253. /*
  254. * Tell gcc if a function is cold. The compiler will assume any path
  255. * directly leading to the call is unlikely.
  256. */
  257. #ifndef __cold
  258. #define __cold
  259. #endif
  260. /* Simple shorthand for a section definition */
  261. #ifndef __section
  262. # define __section(S) __attribute__ ((__section__(#S)))
  263. #endif
  264. #ifndef __visible
  265. #define __visible
  266. #endif
  267. /* Are two types/vars the same type (ignoring qualifiers)? */
  268. #ifndef __same_type
  269. # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
  270. #endif
  271. /* Is this type a native word size -- useful for atomic operations */
  272. #ifndef __native_word
  273. # define __native_word(t) (sizeof(t) == sizeof(int) || sizeof(t) == sizeof(long))
  274. #endif
  275. /* Compile time object size, -1 for unknown */
  276. #ifndef __compiletime_object_size
  277. # define __compiletime_object_size(obj) -1
  278. #endif
  279. #ifndef __compiletime_warning
  280. # define __compiletime_warning(message)
  281. #endif
  282. #ifndef __compiletime_error
  283. # define __compiletime_error(message)
  284. /*
  285. * Sparse complains of variable sized arrays due to the temporary variable in
  286. * __compiletime_assert. Unfortunately we can't just expand it out to make
  287. * sparse see a constant array size without breaking compiletime_assert on old
  288. * versions of GCC (e.g. 4.2.4), so hide the array from sparse altogether.
  289. */
  290. # ifndef __CHECKER__
  291. # define __compiletime_error_fallback(condition) \
  292. do { ((void)sizeof(char[1 - 2 * condition])); } while (0)
  293. # endif
  294. #endif
  295. #ifndef __compiletime_error_fallback
  296. # define __compiletime_error_fallback(condition) do { } while (0)
  297. #endif
  298. #define __compiletime_assert(condition, msg, prefix, suffix) \
  299. do { \
  300. bool __cond = !(condition); \
  301. extern void prefix ## suffix(void) __compiletime_error(msg); \
  302. if (__cond) \
  303. prefix ## suffix(); \
  304. __compiletime_error_fallback(__cond); \
  305. } while (0)
  306. #define _compiletime_assert(condition, msg, prefix, suffix) \
  307. __compiletime_assert(condition, msg, prefix, suffix)
  308. /**
  309. * compiletime_assert - break build and emit msg if condition is false
  310. * @condition: a compile-time constant condition to check
  311. * @msg: a message to emit if condition is false
  312. *
  313. * In tradition of POSIX assert, this macro will break the build if the
  314. * supplied condition is *false*, emitting the supplied error message if the
  315. * compiler has support to do so.
  316. */
  317. #define compiletime_assert(condition, msg) \
  318. _compiletime_assert(condition, msg, __compiletime_assert_, __LINE__)
  319. #define compiletime_assert_atomic_type(t) \
  320. compiletime_assert(__native_word(t), \
  321. "Need native word sized stores/loads for atomicity.")
  322. /*
  323. * Prevent the compiler from merging or refetching accesses. The compiler
  324. * is also forbidden from reordering successive instances of ACCESS_ONCE(),
  325. * but only when the compiler is aware of some particular ordering. One way
  326. * to make the compiler aware of ordering is to put the two invocations of
  327. * ACCESS_ONCE() in different C statements.
  328. *
  329. * This macro does absolutely -nothing- to prevent the CPU from reordering,
  330. * merging, or refetching absolutely anything at any time. Its main intended
  331. * use is to mediate communication between process-level code and irq/NMI
  332. * handlers, all running on the same CPU.
  333. */
  334. #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
  335. /* Ignore/forbid kprobes attach on very low level functions marked by this attribute: */
  336. #ifdef CONFIG_KPROBES
  337. # define __kprobes __attribute__((__section__(".kprobes.text")))
  338. # define nokprobe_inline __always_inline
  339. #else
  340. # define __kprobes
  341. # define nokprobe_inline inline
  342. #endif
  343. #endif /* __LINUX_COMPILER_H */