atomic_base.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. //===----------------------------------------------------------------------===//
  2. //
  3. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  4. // See https://llvm.org/LICENSE.txt for license information.
  5. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  6. //
  7. //===----------------------------------------------------------------------===//
  8. #ifndef _LIBCPP___ATOMIC_ATOMIC_BASE_H
  9. #define _LIBCPP___ATOMIC_ATOMIC_BASE_H
  10. #include <__atomic/atomic_sync.h>
  11. #include <__atomic/check_memory_order.h>
  12. #include <__atomic/cxx_atomic_impl.h>
  13. #include <__atomic/is_always_lock_free.h>
  14. #include <__atomic/memory_order.h>
  15. #include <__availability>
  16. #include <__config>
  17. #include <__memory/addressof.h>
  18. #include <__type_traits/is_integral.h>
  19. #include <__type_traits/is_nothrow_default_constructible.h>
  20. #include <__type_traits/is_same.h>
  21. #include <version>
  22. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  23. # pragma GCC system_header
  24. #endif
  25. _LIBCPP_BEGIN_NAMESPACE_STD
  26. template <class _Tp, bool = is_integral<_Tp>::value && !is_same<_Tp, bool>::value>
  27. struct __atomic_base // false
  28. {
  29. mutable __cxx_atomic_impl<_Tp> __a_;
  30. #if _LIBCPP_STD_VER >= 17
  31. static _LIBCPP_CONSTEXPR bool is_always_lock_free = __libcpp_is_always_lock_free<__cxx_atomic_impl<_Tp> >::__value;
  32. #endif
  33. _LIBCPP_HIDE_FROM_ABI bool is_lock_free() const volatile _NOEXCEPT {
  34. return __cxx_atomic_is_lock_free(sizeof(__cxx_atomic_impl<_Tp>));
  35. }
  36. _LIBCPP_HIDE_FROM_ABI bool is_lock_free() const _NOEXCEPT {
  37. return static_cast<__atomic_base const volatile*>(this)->is_lock_free();
  38. }
  39. _LIBCPP_HIDE_FROM_ABI void store(_Tp __d, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT
  40. _LIBCPP_CHECK_STORE_MEMORY_ORDER(__m) {
  41. std::__cxx_atomic_store(std::addressof(__a_), __d, __m);
  42. }
  43. _LIBCPP_HIDE_FROM_ABI void store(_Tp __d, memory_order __m = memory_order_seq_cst) _NOEXCEPT
  44. _LIBCPP_CHECK_STORE_MEMORY_ORDER(__m) {
  45. std::__cxx_atomic_store(std::addressof(__a_), __d, __m);
  46. }
  47. _LIBCPP_HIDE_FROM_ABI _Tp load(memory_order __m = memory_order_seq_cst) const volatile _NOEXCEPT
  48. _LIBCPP_CHECK_LOAD_MEMORY_ORDER(__m) {
  49. return std::__cxx_atomic_load(std::addressof(__a_), __m);
  50. }
  51. _LIBCPP_HIDE_FROM_ABI _Tp load(memory_order __m = memory_order_seq_cst) const _NOEXCEPT
  52. _LIBCPP_CHECK_LOAD_MEMORY_ORDER(__m) {
  53. return std::__cxx_atomic_load(std::addressof(__a_), __m);
  54. }
  55. _LIBCPP_HIDE_FROM_ABI operator _Tp() const volatile _NOEXCEPT { return load(); }
  56. _LIBCPP_HIDE_FROM_ABI operator _Tp() const _NOEXCEPT { return load(); }
  57. _LIBCPP_HIDE_FROM_ABI _Tp exchange(_Tp __d, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  58. return std::__cxx_atomic_exchange(std::addressof(__a_), __d, __m);
  59. }
  60. _LIBCPP_HIDE_FROM_ABI _Tp exchange(_Tp __d, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  61. return std::__cxx_atomic_exchange(std::addressof(__a_), __d, __m);
  62. }
  63. _LIBCPP_HIDE_FROM_ABI bool
  64. compare_exchange_weak(_Tp& __e, _Tp __d, memory_order __s, memory_order __f) volatile _NOEXCEPT
  65. _LIBCPP_CHECK_EXCHANGE_MEMORY_ORDER(__s, __f) {
  66. return std::__cxx_atomic_compare_exchange_weak(std::addressof(__a_), std::addressof(__e), __d, __s, __f);
  67. }
  68. _LIBCPP_HIDE_FROM_ABI bool compare_exchange_weak(_Tp& __e, _Tp __d, memory_order __s, memory_order __f) _NOEXCEPT
  69. _LIBCPP_CHECK_EXCHANGE_MEMORY_ORDER(__s, __f) {
  70. return std::__cxx_atomic_compare_exchange_weak(std::addressof(__a_), std::addressof(__e), __d, __s, __f);
  71. }
  72. _LIBCPP_HIDE_FROM_ABI bool
  73. compare_exchange_strong(_Tp& __e, _Tp __d, memory_order __s, memory_order __f) volatile _NOEXCEPT
  74. _LIBCPP_CHECK_EXCHANGE_MEMORY_ORDER(__s, __f) {
  75. return std::__cxx_atomic_compare_exchange_strong(std::addressof(__a_), std::addressof(__e), __d, __s, __f);
  76. }
  77. _LIBCPP_HIDE_FROM_ABI bool compare_exchange_strong(_Tp& __e, _Tp __d, memory_order __s, memory_order __f) _NOEXCEPT
  78. _LIBCPP_CHECK_EXCHANGE_MEMORY_ORDER(__s, __f) {
  79. return std::__cxx_atomic_compare_exchange_strong(std::addressof(__a_), std::addressof(__e), __d, __s, __f);
  80. }
  81. _LIBCPP_HIDE_FROM_ABI bool
  82. compare_exchange_weak(_Tp& __e, _Tp __d, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  83. return std::__cxx_atomic_compare_exchange_weak(std::addressof(__a_), std::addressof(__e), __d, __m, __m);
  84. }
  85. _LIBCPP_HIDE_FROM_ABI bool
  86. compare_exchange_weak(_Tp& __e, _Tp __d, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  87. return std::__cxx_atomic_compare_exchange_weak(std::addressof(__a_), std::addressof(__e), __d, __m, __m);
  88. }
  89. _LIBCPP_HIDE_FROM_ABI bool
  90. compare_exchange_strong(_Tp& __e, _Tp __d, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  91. return std::__cxx_atomic_compare_exchange_strong(std::addressof(__a_), std::addressof(__e), __d, __m, __m);
  92. }
  93. _LIBCPP_HIDE_FROM_ABI bool
  94. compare_exchange_strong(_Tp& __e, _Tp __d, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  95. return std::__cxx_atomic_compare_exchange_strong(std::addressof(__a_), std::addressof(__e), __d, __m, __m);
  96. }
  97. _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void wait(_Tp __v, memory_order __m = memory_order_seq_cst) const
  98. volatile _NOEXCEPT {
  99. std::__atomic_wait(*this, __v, __m);
  100. }
  101. _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void
  102. wait(_Tp __v, memory_order __m = memory_order_seq_cst) const _NOEXCEPT {
  103. std::__atomic_wait(*this, __v, __m);
  104. }
  105. _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void notify_one() volatile _NOEXCEPT {
  106. std::__atomic_notify_one(*this);
  107. }
  108. _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void notify_one() _NOEXCEPT { std::__atomic_notify_one(*this); }
  109. _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void notify_all() volatile _NOEXCEPT {
  110. std::__atomic_notify_all(*this);
  111. }
  112. _LIBCPP_AVAILABILITY_SYNC _LIBCPP_HIDE_FROM_ABI void notify_all() _NOEXCEPT { std::__atomic_notify_all(*this); }
  113. #if _LIBCPP_STD_VER >= 20
  114. _LIBCPP_HIDE_FROM_ABI constexpr __atomic_base() noexcept(is_nothrow_default_constructible_v<_Tp>) : __a_(_Tp()) {}
  115. #else
  116. _LIBCPP_HIDE_FROM_ABI __atomic_base() _NOEXCEPT = default;
  117. #endif
  118. _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR __atomic_base(_Tp __d) _NOEXCEPT : __a_(__d) {}
  119. __atomic_base(const __atomic_base&) = delete;
  120. };
  121. #if _LIBCPP_STD_VER >= 17
  122. template <class _Tp, bool __b>
  123. _LIBCPP_CONSTEXPR bool __atomic_base<_Tp, __b>::is_always_lock_free;
  124. #endif
  125. // atomic<Integral>
  126. template <class _Tp>
  127. struct __atomic_base<_Tp, true> : public __atomic_base<_Tp, false> {
  128. using __base = __atomic_base<_Tp, false>;
  129. _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX20 __atomic_base() _NOEXCEPT = default;
  130. _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR __atomic_base(_Tp __d) _NOEXCEPT : __base(__d) {}
  131. _LIBCPP_HIDE_FROM_ABI _Tp fetch_add(_Tp __op, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  132. return std::__cxx_atomic_fetch_add(std::addressof(this->__a_), __op, __m);
  133. }
  134. _LIBCPP_HIDE_FROM_ABI _Tp fetch_add(_Tp __op, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  135. return std::__cxx_atomic_fetch_add(std::addressof(this->__a_), __op, __m);
  136. }
  137. _LIBCPP_HIDE_FROM_ABI _Tp fetch_sub(_Tp __op, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  138. return std::__cxx_atomic_fetch_sub(std::addressof(this->__a_), __op, __m);
  139. }
  140. _LIBCPP_HIDE_FROM_ABI _Tp fetch_sub(_Tp __op, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  141. return std::__cxx_atomic_fetch_sub(std::addressof(this->__a_), __op, __m);
  142. }
  143. _LIBCPP_HIDE_FROM_ABI _Tp fetch_and(_Tp __op, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  144. return std::__cxx_atomic_fetch_and(std::addressof(this->__a_), __op, __m);
  145. }
  146. _LIBCPP_HIDE_FROM_ABI _Tp fetch_and(_Tp __op, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  147. return std::__cxx_atomic_fetch_and(std::addressof(this->__a_), __op, __m);
  148. }
  149. _LIBCPP_HIDE_FROM_ABI _Tp fetch_or(_Tp __op, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  150. return std::__cxx_atomic_fetch_or(std::addressof(this->__a_), __op, __m);
  151. }
  152. _LIBCPP_HIDE_FROM_ABI _Tp fetch_or(_Tp __op, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  153. return std::__cxx_atomic_fetch_or(std::addressof(this->__a_), __op, __m);
  154. }
  155. _LIBCPP_HIDE_FROM_ABI _Tp fetch_xor(_Tp __op, memory_order __m = memory_order_seq_cst) volatile _NOEXCEPT {
  156. return std::__cxx_atomic_fetch_xor(std::addressof(this->__a_), __op, __m);
  157. }
  158. _LIBCPP_HIDE_FROM_ABI _Tp fetch_xor(_Tp __op, memory_order __m = memory_order_seq_cst) _NOEXCEPT {
  159. return std::__cxx_atomic_fetch_xor(std::addressof(this->__a_), __op, __m);
  160. }
  161. _LIBCPP_HIDE_FROM_ABI _Tp operator++(int) volatile _NOEXCEPT { return fetch_add(_Tp(1)); }
  162. _LIBCPP_HIDE_FROM_ABI _Tp operator++(int) _NOEXCEPT { return fetch_add(_Tp(1)); }
  163. _LIBCPP_HIDE_FROM_ABI _Tp operator--(int) volatile _NOEXCEPT { return fetch_sub(_Tp(1)); }
  164. _LIBCPP_HIDE_FROM_ABI _Tp operator--(int) _NOEXCEPT { return fetch_sub(_Tp(1)); }
  165. _LIBCPP_HIDE_FROM_ABI _Tp operator++() volatile _NOEXCEPT { return fetch_add(_Tp(1)) + _Tp(1); }
  166. _LIBCPP_HIDE_FROM_ABI _Tp operator++() _NOEXCEPT { return fetch_add(_Tp(1)) + _Tp(1); }
  167. _LIBCPP_HIDE_FROM_ABI _Tp operator--() volatile _NOEXCEPT { return fetch_sub(_Tp(1)) - _Tp(1); }
  168. _LIBCPP_HIDE_FROM_ABI _Tp operator--() _NOEXCEPT { return fetch_sub(_Tp(1)) - _Tp(1); }
  169. _LIBCPP_HIDE_FROM_ABI _Tp operator+=(_Tp __op) volatile _NOEXCEPT { return fetch_add(__op) + __op; }
  170. _LIBCPP_HIDE_FROM_ABI _Tp operator+=(_Tp __op) _NOEXCEPT { return fetch_add(__op) + __op; }
  171. _LIBCPP_HIDE_FROM_ABI _Tp operator-=(_Tp __op) volatile _NOEXCEPT { return fetch_sub(__op) - __op; }
  172. _LIBCPP_HIDE_FROM_ABI _Tp operator-=(_Tp __op) _NOEXCEPT { return fetch_sub(__op) - __op; }
  173. _LIBCPP_HIDE_FROM_ABI _Tp operator&=(_Tp __op) volatile _NOEXCEPT { return fetch_and(__op) & __op; }
  174. _LIBCPP_HIDE_FROM_ABI _Tp operator&=(_Tp __op) _NOEXCEPT { return fetch_and(__op) & __op; }
  175. _LIBCPP_HIDE_FROM_ABI _Tp operator|=(_Tp __op) volatile _NOEXCEPT { return fetch_or(__op) | __op; }
  176. _LIBCPP_HIDE_FROM_ABI _Tp operator|=(_Tp __op) _NOEXCEPT { return fetch_or(__op) | __op; }
  177. _LIBCPP_HIDE_FROM_ABI _Tp operator^=(_Tp __op) volatile _NOEXCEPT { return fetch_xor(__op) ^ __op; }
  178. _LIBCPP_HIDE_FROM_ABI _Tp operator^=(_Tp __op) _NOEXCEPT { return fetch_xor(__op) ^ __op; }
  179. };
  180. // Here we need _IsIntegral because the default template argument is not enough
  181. // e.g __atomic_base<int> is __atomic_base<int, true>, which inherits from
  182. // __atomic_base<int, false> and the caller of the wait function is
  183. // __atomic_base<int, false>. So specializing __atomic_base<_Tp> does not work
  184. template <class _Tp, bool _IsIntegral>
  185. struct __atomic_waitable_traits<__atomic_base<_Tp, _IsIntegral> > {
  186. static _LIBCPP_HIDE_FROM_ABI _Tp __atomic_load(const __atomic_base<_Tp, _IsIntegral>& __a, memory_order __order) {
  187. return __a.load(__order);
  188. }
  189. static _LIBCPP_HIDE_FROM_ABI _Tp
  190. __atomic_load(const volatile __atomic_base<_Tp, _IsIntegral>& __this, memory_order __order) {
  191. return __this.load(__order);
  192. }
  193. static _LIBCPP_HIDE_FROM_ABI const __cxx_atomic_impl<_Tp>*
  194. __atomic_contention_address(const __atomic_base<_Tp, _IsIntegral>& __a) {
  195. return std::addressof(__a.__a_);
  196. }
  197. static _LIBCPP_HIDE_FROM_ABI const volatile __cxx_atomic_impl<_Tp>*
  198. __atomic_contention_address(const volatile __atomic_base<_Tp, _IsIntegral>& __this) {
  199. return std::addressof(__this.__a_);
  200. }
  201. };
  202. _LIBCPP_END_NAMESPACE_STD
  203. #endif // _LIBCPP___ATOMIC_ATOMIC_BASE_H