atomic.hpp 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. /*
  2. * Distributed under the Boost Software License, Version 1.0.
  3. * (See accompanying file LICENSE_1_0.txt or copy at
  4. * http://www.boost.org/LICENSE_1_0.txt)
  5. *
  6. * Copyright (c) 2011 Helge Bahmann
  7. * Copyright (c) 2013 Tim Blechmann
  8. * Copyright (c) 2014, 2020-2025 Andrey Semashev
  9. */
  10. /*!
  11. * \file atomic/atomic.hpp
  12. *
  13. * This header contains definition of \c atomic template.
  14. */
  15. #ifndef BOOST_ATOMIC_ATOMIC_HPP_INCLUDED_
  16. #define BOOST_ATOMIC_ATOMIC_HPP_INCLUDED_
  17. #include <cstddef>
  18. #include <cstdint>
  19. #include <type_traits>
  20. #include <boost/memory_order.hpp>
  21. #include <boost/atomic/capabilities.hpp>
  22. #include <boost/atomic/detail/config.hpp>
  23. #include <boost/atomic/detail/classify.hpp>
  24. #include <boost/atomic/detail/atomic_impl.hpp>
  25. #include <boost/atomic/detail/type_traits/is_trivially_copyable.hpp>
  26. #include <boost/atomic/detail/header.hpp>
  27. #ifdef BOOST_HAS_PRAGMA_ONCE
  28. #pragma once
  29. #endif
  30. namespace boost {
  31. namespace atomics {
  32. //! Atomic object
  33. template< typename T >
  34. class atomic :
  35. public atomics::detail::base_atomic< T, typename atomics::detail::classify< T >::type, false >
  36. {
  37. private:
  38. using base_type = atomics::detail::base_atomic< T, typename atomics::detail::classify< T >::type, false >;
  39. using value_arg_type = typename base_type::value_arg_type;
  40. public:
  41. using value_type = typename base_type::value_type;
  42. static_assert(sizeof(value_type) > 0u, "boost::atomic<T> requires T to be a complete type");
  43. static_assert(atomics::detail::is_trivially_copyable< value_type >::value, "boost::atomic<T> requires T to be a trivially copyable type");
  44. public:
  45. atomic() = default;
  46. BOOST_FORCEINLINE constexpr atomic(value_arg_type v) noexcept : base_type(v)
  47. {
  48. }
  49. atomic(atomic const&) = delete;
  50. atomic& operator= (atomic const&) = delete;
  51. atomic& operator= (atomic const&) volatile = delete;
  52. BOOST_FORCEINLINE value_type operator= (value_arg_type v) noexcept
  53. {
  54. this->store(v);
  55. return v;
  56. }
  57. BOOST_FORCEINLINE value_type operator= (value_arg_type v) volatile noexcept
  58. {
  59. this->store(v);
  60. return v;
  61. }
  62. BOOST_FORCEINLINE operator value_type() const volatile noexcept
  63. {
  64. return this->load();
  65. }
  66. };
  67. using atomic_char = atomic< char >;
  68. using atomic_uchar = atomic< unsigned char >;
  69. using atomic_schar = atomic< signed char >;
  70. using atomic_ushort = atomic< unsigned short >;
  71. using atomic_short = atomic< short >;
  72. using atomic_uint = atomic< unsigned int >;
  73. using atomic_int = atomic< int >;
  74. using atomic_ulong = atomic< unsigned long >;
  75. using atomic_long = atomic< long >;
  76. using atomic_ullong = atomic< unsigned long long >;
  77. using atomic_llong = atomic< long long >;
  78. using atomic_address = atomic< void* >;
  79. using atomic_bool = atomic< bool >;
  80. using atomic_wchar_t = atomic< wchar_t >;
  81. #if defined(__cpp_char8_t) && (__cpp_char8_t >= 201811)
  82. using atomic_char8_t = atomic< char8_t >;
  83. #endif
  84. using atomic_char16_t = atomic< char16_t >;
  85. using atomic_char32_t = atomic< char32_t >;
  86. using atomic_uint8_t = atomic< std::uint8_t >;
  87. using atomic_int8_t = atomic< std::int8_t >;
  88. using atomic_uint16_t = atomic< std::uint16_t >;
  89. using atomic_int16_t = atomic< std::int16_t >;
  90. using atomic_uint32_t = atomic< std::uint32_t >;
  91. using atomic_int32_t = atomic< std::int32_t >;
  92. using atomic_uint64_t = atomic< std::uint64_t >;
  93. using atomic_int64_t = atomic< std::int64_t >;
  94. using atomic_int_least8_t = atomic< std::int_least8_t >;
  95. using atomic_uint_least8_t = atomic< std::uint_least8_t >;
  96. using atomic_int_least16_t = atomic< std::int_least16_t >;
  97. using atomic_uint_least16_t = atomic< std::uint_least16_t >;
  98. using atomic_int_least32_t = atomic< std::int_least32_t >;
  99. using atomic_uint_least32_t = atomic< std::uint_least32_t >;
  100. using atomic_int_least64_t = atomic< std::int_least64_t >;
  101. using atomic_uint_least64_t = atomic< std::uint_least64_t >;
  102. using atomic_int_fast8_t = atomic< std::int_fast8_t >;
  103. using atomic_uint_fast8_t = atomic< std::uint_fast8_t >;
  104. using atomic_int_fast16_t = atomic< std::int_fast16_t >;
  105. using atomic_uint_fast16_t = atomic< std::uint_fast16_t >;
  106. using atomic_int_fast32_t = atomic< std::int_fast32_t >;
  107. using atomic_uint_fast32_t = atomic< std::uint_fast32_t >;
  108. using atomic_int_fast64_t = atomic< std::int_fast64_t >;
  109. using atomic_uint_fast64_t = atomic< std::uint_fast64_t >;
  110. using atomic_intmax_t = atomic< std::intmax_t >;
  111. using atomic_uintmax_t = atomic< std::uintmax_t >;
  112. #if !defined(BOOST_ATOMIC_NO_FLOATING_POINT)
  113. using atomic_float_t = atomic< float >;
  114. using atomic_double_t = atomic< double >;
  115. using atomic_long_double_t = atomic< long double >;
  116. #endif
  117. using atomic_size_t = atomic< std::size_t >;
  118. using atomic_ptrdiff_t = atomic< std::ptrdiff_t >;
  119. #if defined(UINTPTR_MAX)
  120. using atomic_intptr_t = atomic< std::intptr_t >;
  121. using atomic_uintptr_t = atomic< std::uintptr_t >;
  122. #endif
  123. // Select the lock-free atomic types that has natively supported waiting/notifying operations.
  124. // Prefer 32-bit types the most as those have the best performance on current 32 and 64-bit architectures.
  125. #if BOOST_ATOMIC_INT32_LOCK_FREE == 2 && BOOST_ATOMIC_HAS_NATIVE_INT32_WAIT_NOTIFY == 2
  126. using atomic_unsigned_lock_free = atomic< std::uint32_t >;
  127. using atomic_signed_lock_free = atomic< std::int32_t >;
  128. #elif BOOST_ATOMIC_INT64_LOCK_FREE == 2 && BOOST_ATOMIC_HAS_NATIVE_INT64_WAIT_NOTIFY == 2
  129. using atomic_unsigned_lock_free = atomic< std::uint64_t >;
  130. using atomic_signed_lock_free = atomic< std::int64_t >;
  131. #elif BOOST_ATOMIC_INT16_LOCK_FREE == 2 && BOOST_ATOMIC_HAS_NATIVE_INT16_WAIT_NOTIFY == 2
  132. using atomic_unsigned_lock_free = atomic< std::uint16_t >;
  133. using atomic_signed_lock_free = atomic< std::int16_t >;
  134. #elif BOOST_ATOMIC_INT8_LOCK_FREE == 2 && BOOST_ATOMIC_HAS_NATIVE_INT8_WAIT_NOTIFY == 2
  135. using atomic_unsigned_lock_free = atomic< std::uint8_t >;
  136. using atomic_signed_lock_free = atomic< std::int8_t >;
  137. #elif BOOST_ATOMIC_INT32_LOCK_FREE == 2
  138. using atomic_unsigned_lock_free = atomic< std::uint32_t >;
  139. using atomic_signed_lock_free = atomic< std::int32_t >;
  140. #elif BOOST_ATOMIC_INT64_LOCK_FREE == 2
  141. using atomic_unsigned_lock_free = atomic< std::uint64_t >;
  142. using atomic_signed_lock_free = atomic< std::int64_t >;
  143. #elif BOOST_ATOMIC_INT16_LOCK_FREE == 2
  144. using atomic_unsigned_lock_free = atomic< std::uint16_t >;
  145. using atomic_signed_lock_free = atomic< std::int16_t >;
  146. #elif BOOST_ATOMIC_INT8_LOCK_FREE == 2
  147. using atomic_unsigned_lock_free = atomic< std::uint8_t >;
  148. using atomic_signed_lock_free = atomic< std::int8_t >;
  149. #else
  150. #define BOOST_ATOMIC_DETAIL_NO_LOCK_FREE_TYPEDEFS
  151. #endif
  152. } // namespace atomics
  153. using atomics::atomic;
  154. using atomics::atomic_char;
  155. using atomics::atomic_uchar;
  156. using atomics::atomic_schar;
  157. using atomics::atomic_ushort;
  158. using atomics::atomic_short;
  159. using atomics::atomic_uint;
  160. using atomics::atomic_int;
  161. using atomics::atomic_ulong;
  162. using atomics::atomic_long;
  163. using atomics::atomic_ullong;
  164. using atomics::atomic_llong;
  165. using atomics::atomic_address;
  166. using atomics::atomic_bool;
  167. using atomics::atomic_wchar_t;
  168. #if defined(__cpp_char8_t) && __cpp_char8_t >= 201811
  169. using atomics::atomic_char8_t;
  170. #endif
  171. using atomics::atomic_char16_t;
  172. using atomics::atomic_char32_t;
  173. using atomics::atomic_uint8_t;
  174. using atomics::atomic_int8_t;
  175. using atomics::atomic_uint16_t;
  176. using atomics::atomic_int16_t;
  177. using atomics::atomic_uint32_t;
  178. using atomics::atomic_int32_t;
  179. using atomics::atomic_uint64_t;
  180. using atomics::atomic_int64_t;
  181. using atomics::atomic_int_least8_t;
  182. using atomics::atomic_uint_least8_t;
  183. using atomics::atomic_int_least16_t;
  184. using atomics::atomic_uint_least16_t;
  185. using atomics::atomic_int_least32_t;
  186. using atomics::atomic_uint_least32_t;
  187. using atomics::atomic_int_least64_t;
  188. using atomics::atomic_uint_least64_t;
  189. using atomics::atomic_int_fast8_t;
  190. using atomics::atomic_uint_fast8_t;
  191. using atomics::atomic_int_fast16_t;
  192. using atomics::atomic_uint_fast16_t;
  193. using atomics::atomic_int_fast32_t;
  194. using atomics::atomic_uint_fast32_t;
  195. using atomics::atomic_int_fast64_t;
  196. using atomics::atomic_uint_fast64_t;
  197. using atomics::atomic_intmax_t;
  198. using atomics::atomic_uintmax_t;
  199. #if !defined(BOOST_ATOMIC_NO_FLOATING_POINT)
  200. using atomics::atomic_float_t;
  201. using atomics::atomic_double_t;
  202. using atomics::atomic_long_double_t;
  203. #endif
  204. using atomics::atomic_size_t;
  205. using atomics::atomic_ptrdiff_t;
  206. #if defined(UINTPTR_MAX)
  207. using atomics::atomic_intptr_t;
  208. using atomics::atomic_uintptr_t;
  209. #endif
  210. #if !defined(BOOST_ATOMIC_DETAIL_NO_LOCK_FREE_TYPEDEFS)
  211. using atomics::atomic_unsigned_lock_free;
  212. using atomics::atomic_signed_lock_free;
  213. #endif
  214. #undef BOOST_ATOMIC_DETAIL_NO_LOCK_FREE_TYPEDEFS
  215. } // namespace boost
  216. #include <boost/atomic/detail/footer.hpp>
  217. #endif // BOOST_ATOMIC_ATOMIC_HPP_INCLUDED_