compiler.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _TOOLS_LINUX_COMPILER_H_
  3. #define _TOOLS_LINUX_COMPILER_H_
  4. #ifdef __GNUC__
  5. #include <linux/compiler-gcc.h>
  6. #endif
  7. #ifndef __compiletime_error
  8. # define __compiletime_error(message)
  9. #endif
  10. /* Optimization barrier */
  11. /* The "volatile" is due to gcc bugs */
  12. #define barrier() __asm__ __volatile__("": : :"memory")
  13. #ifndef __always_inline
  14. # define __always_inline inline __attribute__((always_inline))
  15. #endif
  16. #ifndef noinline
  17. #define noinline
  18. #endif
  19. /* Are two types/vars the same type (ignoring qualifiers)? */
  20. #ifndef __same_type
  21. # define __same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
  22. #endif
  23. #ifdef __ANDROID__
  24. /*
  25. * FIXME: Big hammer to get rid of tons of:
  26. * "warning: always_inline function might not be inlinable"
  27. *
  28. * At least on android-ndk-r12/platforms/android-24/arch-arm
  29. */
  30. #undef __always_inline
  31. #define __always_inline inline
  32. #endif
  33. #define __user
  34. #define __rcu
  35. #define __read_mostly
  36. #ifndef __attribute_const__
  37. # define __attribute_const__
  38. #endif
  39. #ifndef __maybe_unused
  40. # define __maybe_unused __attribute__((unused))
  41. #endif
  42. #ifndef __used
  43. # define __used __attribute__((__unused__))
  44. #endif
  45. #ifndef __packed
  46. # define __packed __attribute__((__packed__))
  47. #endif
  48. #ifndef __force
  49. # define __force
  50. #endif
  51. #ifndef __weak
  52. # define __weak __attribute__((weak))
  53. #endif
  54. #ifndef likely
  55. # define likely(x) __builtin_expect(!!(x), 1)
  56. #endif
  57. #ifndef unlikely
  58. # define unlikely(x) __builtin_expect(!!(x), 0)
  59. #endif
  60. #ifndef __init
  61. # define __init
  62. #endif
  63. #ifndef noinline
  64. # define noinline
  65. #endif
  66. #define uninitialized_var(x) x = *(&(x))
  67. #define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))
  68. #include <linux/types.h>
  69. /*
  70. * Following functions are taken from kernel sources and
  71. * break aliasing rules in their original form.
  72. *
  73. * While kernel is compiled with -fno-strict-aliasing,
  74. * perf uses -Wstrict-aliasing=3 which makes build fail
  75. * under gcc 4.4.
  76. *
  77. * Using extra __may_alias__ type to allow aliasing
  78. * in this case.
  79. */
  80. typedef __u8 __attribute__((__may_alias__)) __u8_alias_t;
  81. typedef __u16 __attribute__((__may_alias__)) __u16_alias_t;
  82. typedef __u32 __attribute__((__may_alias__)) __u32_alias_t;
  83. typedef __u64 __attribute__((__may_alias__)) __u64_alias_t;
  84. static __always_inline void __read_once_size(const volatile void *p, void *res, int size)
  85. {
  86. switch (size) {
  87. case 1: *(__u8_alias_t *) res = *(volatile __u8_alias_t *) p; break;
  88. case 2: *(__u16_alias_t *) res = *(volatile __u16_alias_t *) p; break;
  89. case 4: *(__u32_alias_t *) res = *(volatile __u32_alias_t *) p; break;
  90. case 8: *(__u64_alias_t *) res = *(volatile __u64_alias_t *) p; break;
  91. default:
  92. barrier();
  93. __builtin_memcpy((void *)res, (const void *)p, size);
  94. barrier();
  95. }
  96. }
  97. static __always_inline void __write_once_size(volatile void *p, void *res, int size)
  98. {
  99. switch (size) {
  100. case 1: *(volatile __u8_alias_t *) p = *(__u8_alias_t *) res; break;
  101. case 2: *(volatile __u16_alias_t *) p = *(__u16_alias_t *) res; break;
  102. case 4: *(volatile __u32_alias_t *) p = *(__u32_alias_t *) res; break;
  103. case 8: *(volatile __u64_alias_t *) p = *(__u64_alias_t *) res; break;
  104. default:
  105. barrier();
  106. __builtin_memcpy((void *)p, (const void *)res, size);
  107. barrier();
  108. }
  109. }
  110. /*
  111. * Prevent the compiler from merging or refetching reads or writes. The
  112. * compiler is also forbidden from reordering successive instances of
  113. * READ_ONCE, WRITE_ONCE and ACCESS_ONCE (see below), but only when the
  114. * compiler is aware of some particular ordering. One way to make the
  115. * compiler aware of ordering is to put the two invocations of READ_ONCE,
  116. * WRITE_ONCE or ACCESS_ONCE() in different C statements.
  117. *
  118. * In contrast to ACCESS_ONCE these two macros will also work on aggregate
  119. * data types like structs or unions. If the size of the accessed data
  120. * type exceeds the word size of the machine (e.g., 32 bits or 64 bits)
  121. * READ_ONCE() and WRITE_ONCE() will fall back to memcpy and print a
  122. * compile-time warning.
  123. *
  124. * Their two major use cases are: (1) Mediating communication between
  125. * process-level code and irq/NMI handlers, all running on the same CPU,
  126. * and (2) Ensuring that the compiler does not fold, spindle, or otherwise
  127. * mutilate accesses that either do not require ordering or that interact
  128. * with an explicit memory barrier or atomic instruction that provides the
  129. * required ordering.
  130. */
  131. #define READ_ONCE(x) \
  132. ({ union { typeof(x) __val; char __c[1]; } __u; __read_once_size(&(x), __u.__c, sizeof(x)); __u.__val; })
  133. #define WRITE_ONCE(x, val) \
  134. ({ union { typeof(x) __val; char __c[1]; } __u = { .__val = (val) }; __write_once_size(&(x), __u.__c, sizeof(x)); __u.__val; })
  135. #ifndef __fallthrough
  136. # define __fallthrough
  137. #endif
  138. #endif /* _TOOLS_LINUX_COMPILER_H */