extra_ops_generic.hpp 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  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) 2015-2025 Andrey Semashev
  7. */
  8. /*!
  9. * \file atomic/detail/extra_ops_generic.hpp
  10. *
  11. * This header contains generic implementation of the extra atomic operations.
  12. */
  13. #ifndef BOOST_ATOMIC_DETAIL_EXTRA_OPS_GENERIC_HPP_INCLUDED_
  14. #define BOOST_ATOMIC_DETAIL_EXTRA_OPS_GENERIC_HPP_INCLUDED_
  15. #include <cstddef>
  16. #include <boost/memory_order.hpp>
  17. #include <boost/atomic/detail/config.hpp>
  18. #include <boost/atomic/detail/storage_traits.hpp>
  19. #include <boost/atomic/detail/integral_conversions.hpp>
  20. #include <boost/atomic/detail/extra_operations_fwd.hpp>
  21. #include <boost/atomic/detail/header.hpp>
  22. #ifdef BOOST_HAS_PRAGMA_ONCE
  23. #pragma once
  24. #endif
  25. namespace boost {
  26. namespace atomics {
  27. namespace detail {
  28. //! Generic implementation of extra operations
  29. template< typename Base, std::size_t Size, bool Signed, bool = Base::full_cas_based >
  30. struct extra_operations_generic :
  31. public Base
  32. {
  33. using base_type = Base;
  34. using storage_type = typename base_type::storage_type;
  35. using emulated_storage_type = typename storage_traits< Size >::type;
  36. static BOOST_FORCEINLINE storage_type fetch_negate(storage_type volatile& storage, memory_order order) noexcept
  37. {
  38. storage_type old_val;
  39. atomics::detail::non_atomic_load(storage, old_val);
  40. while (!base_type::compare_exchange_weak(
  41. storage, old_val, atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(-old_val)), order, memory_order_relaxed))
  42. {
  43. }
  44. return old_val;
  45. }
  46. static BOOST_FORCEINLINE storage_type negate(storage_type volatile& storage, memory_order order) noexcept
  47. {
  48. storage_type old_val, new_val;
  49. atomics::detail::non_atomic_load(storage, old_val);
  50. do
  51. {
  52. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(-old_val));
  53. }
  54. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  55. return new_val;
  56. }
  57. static BOOST_FORCEINLINE storage_type add(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  58. {
  59. return base_type::fetch_add(storage, v, order) + v;
  60. }
  61. static BOOST_FORCEINLINE storage_type sub(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  62. {
  63. return base_type::fetch_sub(storage, v, order) - v;
  64. }
  65. static BOOST_FORCEINLINE storage_type bitwise_and(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  66. {
  67. return base_type::fetch_and(storage, v, order) & v;
  68. }
  69. static BOOST_FORCEINLINE storage_type bitwise_or(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  70. {
  71. return base_type::fetch_or(storage, v, order) | v;
  72. }
  73. static BOOST_FORCEINLINE storage_type bitwise_xor(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  74. {
  75. return base_type::fetch_xor(storage, v, order) ^ v;
  76. }
  77. static BOOST_FORCEINLINE storage_type fetch_complement(storage_type volatile& storage, memory_order order) noexcept
  78. {
  79. return base_type::fetch_xor(
  80. storage, atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(~static_cast< emulated_storage_type >(0u))), order);
  81. }
  82. static BOOST_FORCEINLINE storage_type bitwise_complement(storage_type volatile& storage, memory_order order) noexcept
  83. {
  84. const storage_type mask =
  85. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(~static_cast< emulated_storage_type >(0u)));
  86. return base_type::fetch_xor(storage, mask, order) ^ mask;
  87. }
  88. static BOOST_FORCEINLINE void opaque_add(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  89. {
  90. base_type::fetch_add(storage, v, order);
  91. }
  92. static BOOST_FORCEINLINE void opaque_sub(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  93. {
  94. base_type::fetch_sub(storage, v, order);
  95. }
  96. static BOOST_FORCEINLINE void opaque_negate(storage_type volatile& storage, memory_order order) noexcept
  97. {
  98. fetch_negate(storage, order);
  99. }
  100. static BOOST_FORCEINLINE void opaque_and(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  101. {
  102. base_type::fetch_and(storage, v, order);
  103. }
  104. static BOOST_FORCEINLINE void opaque_or(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  105. {
  106. base_type::fetch_or(storage, v, order);
  107. }
  108. static BOOST_FORCEINLINE void opaque_xor(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  109. {
  110. base_type::fetch_xor(storage, v, order);
  111. }
  112. static BOOST_FORCEINLINE void opaque_complement(storage_type volatile& storage, memory_order order) noexcept
  113. {
  114. fetch_complement(storage, order);
  115. }
  116. static BOOST_FORCEINLINE bool add_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  117. {
  118. return !!static_cast< emulated_storage_type >(add(storage, v, order));
  119. }
  120. static BOOST_FORCEINLINE bool sub_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  121. {
  122. return !!static_cast< emulated_storage_type >(sub(storage, v, order));
  123. }
  124. static BOOST_FORCEINLINE bool negate_and_test(storage_type volatile& storage, memory_order order) noexcept
  125. {
  126. return !!negate(storage, order);
  127. }
  128. static BOOST_FORCEINLINE bool and_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  129. {
  130. return !!bitwise_and(storage, v, order);
  131. }
  132. static BOOST_FORCEINLINE bool or_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  133. {
  134. return !!bitwise_or(storage, v, order);
  135. }
  136. static BOOST_FORCEINLINE bool xor_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  137. {
  138. return !!bitwise_xor(storage, v, order);
  139. }
  140. static BOOST_FORCEINLINE bool complement_and_test(storage_type volatile& storage, memory_order order) noexcept
  141. {
  142. return !!static_cast< emulated_storage_type >(bitwise_complement(storage, order));
  143. }
  144. static BOOST_FORCEINLINE bool bit_test_and_set(storage_type volatile& storage, unsigned int bit_number, memory_order order) noexcept
  145. {
  146. const storage_type mask =
  147. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(static_cast< emulated_storage_type >(1u) << bit_number));
  148. storage_type old_val = base_type::fetch_or(storage, mask, order);
  149. return !!(old_val & mask);
  150. }
  151. static BOOST_FORCEINLINE bool bit_test_and_reset(storage_type volatile& storage, unsigned int bit_number, memory_order order) noexcept
  152. {
  153. const storage_type mask =
  154. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(static_cast< emulated_storage_type >(1u) << bit_number));
  155. storage_type old_val = base_type::fetch_and(storage, ~mask, order);
  156. return !!(old_val & mask);
  157. }
  158. static BOOST_FORCEINLINE bool bit_test_and_complement(storage_type volatile& storage, unsigned int bit_number, memory_order order) noexcept
  159. {
  160. const storage_type mask =
  161. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(static_cast< emulated_storage_type >(1u) << bit_number));
  162. storage_type old_val = base_type::fetch_xor(storage, mask, order);
  163. return !!(old_val & mask);
  164. }
  165. };
  166. //! Specialization for cases when the platform only natively supports CAS
  167. template< typename Base, std::size_t Size, bool Signed >
  168. struct extra_operations_generic< Base, Size, Signed, true > :
  169. public Base
  170. {
  171. using base_type = Base;
  172. using storage_type = typename base_type::storage_type;
  173. using emulated_storage_type = typename storage_traits< Size >::type;
  174. static BOOST_FORCEINLINE storage_type fetch_negate(storage_type volatile& storage, memory_order order) noexcept
  175. {
  176. storage_type old_val;
  177. atomics::detail::non_atomic_load(storage, old_val);
  178. while (!base_type::compare_exchange_weak(
  179. storage, old_val, atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(-old_val)), order, memory_order_relaxed))
  180. {
  181. }
  182. return old_val;
  183. }
  184. static BOOST_FORCEINLINE storage_type negate(storage_type volatile& storage, memory_order order) noexcept
  185. {
  186. storage_type old_val, new_val;
  187. atomics::detail::non_atomic_load(storage, old_val);
  188. do
  189. {
  190. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(-old_val));
  191. }
  192. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  193. return new_val;
  194. }
  195. static BOOST_FORCEINLINE storage_type add(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  196. {
  197. storage_type old_val, new_val;
  198. atomics::detail::non_atomic_load(storage, old_val);
  199. do
  200. {
  201. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(old_val + v));
  202. }
  203. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  204. return new_val;
  205. }
  206. static BOOST_FORCEINLINE storage_type sub(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  207. {
  208. storage_type old_val, new_val;
  209. atomics::detail::non_atomic_load(storage, old_val);
  210. do
  211. {
  212. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(old_val - v));
  213. }
  214. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  215. return new_val;
  216. }
  217. static BOOST_FORCEINLINE storage_type bitwise_and(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  218. {
  219. storage_type old_val, new_val;
  220. atomics::detail::non_atomic_load(storage, old_val);
  221. do
  222. {
  223. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(old_val & v));
  224. }
  225. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  226. return new_val;
  227. }
  228. static BOOST_FORCEINLINE storage_type bitwise_or(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  229. {
  230. storage_type old_val, new_val;
  231. atomics::detail::non_atomic_load(storage, old_val);
  232. do
  233. {
  234. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(old_val | v));
  235. }
  236. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  237. return new_val;
  238. }
  239. static BOOST_FORCEINLINE storage_type bitwise_xor(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  240. {
  241. storage_type old_val, new_val;
  242. atomics::detail::non_atomic_load(storage, old_val);
  243. do
  244. {
  245. new_val = atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(old_val ^ v));
  246. }
  247. while (!base_type::compare_exchange_weak(storage, old_val, new_val, order, memory_order_relaxed));
  248. return new_val;
  249. }
  250. static BOOST_FORCEINLINE storage_type fetch_complement(storage_type volatile& storage, memory_order order) noexcept
  251. {
  252. return base_type::fetch_xor(
  253. storage, atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(~static_cast< emulated_storage_type >(0u))), order);
  254. }
  255. static BOOST_FORCEINLINE storage_type bitwise_complement(storage_type volatile& storage, memory_order order) noexcept
  256. {
  257. return bitwise_xor(
  258. storage, atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(~static_cast< emulated_storage_type >(0u))), order);
  259. }
  260. static BOOST_FORCEINLINE void opaque_add(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  261. {
  262. base_type::fetch_add(storage, v, order);
  263. }
  264. static BOOST_FORCEINLINE void opaque_sub(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  265. {
  266. base_type::fetch_sub(storage, v, order);
  267. }
  268. static BOOST_FORCEINLINE void opaque_negate(storage_type volatile& storage, memory_order order) noexcept
  269. {
  270. fetch_negate(storage, order);
  271. }
  272. static BOOST_FORCEINLINE void opaque_and(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  273. {
  274. base_type::fetch_and(storage, v, order);
  275. }
  276. static BOOST_FORCEINLINE void opaque_or(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  277. {
  278. base_type::fetch_or(storage, v, order);
  279. }
  280. static BOOST_FORCEINLINE void opaque_xor(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  281. {
  282. base_type::fetch_xor(storage, v, order);
  283. }
  284. static BOOST_FORCEINLINE void opaque_complement(storage_type volatile& storage, memory_order order) noexcept
  285. {
  286. fetch_complement(storage, order);
  287. }
  288. static BOOST_FORCEINLINE bool add_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  289. {
  290. return !!static_cast< emulated_storage_type >(add(storage, v, order));
  291. }
  292. static BOOST_FORCEINLINE bool sub_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  293. {
  294. return !!static_cast< emulated_storage_type >(sub(storage, v, order));
  295. }
  296. static BOOST_FORCEINLINE bool negate_and_test(storage_type volatile& storage, memory_order order) noexcept
  297. {
  298. return !!negate(storage, order);
  299. }
  300. static BOOST_FORCEINLINE bool and_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  301. {
  302. return !!bitwise_and(storage, v, order);
  303. }
  304. static BOOST_FORCEINLINE bool or_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  305. {
  306. return !!bitwise_or(storage, v, order);
  307. }
  308. static BOOST_FORCEINLINE bool xor_and_test(storage_type volatile& storage, storage_type v, memory_order order) noexcept
  309. {
  310. return !!bitwise_xor(storage, v, order);
  311. }
  312. static BOOST_FORCEINLINE bool complement_and_test(storage_type volatile& storage, memory_order order) noexcept
  313. {
  314. return !!static_cast< emulated_storage_type >(bitwise_complement(storage, order));
  315. }
  316. static BOOST_FORCEINLINE bool bit_test_and_set(storage_type volatile& storage, unsigned int bit_number, memory_order order) noexcept
  317. {
  318. const storage_type mask =
  319. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(static_cast< emulated_storage_type >(1u) << bit_number));
  320. storage_type old_val = base_type::fetch_or(storage, mask, order);
  321. return !!(old_val & mask);
  322. }
  323. static BOOST_FORCEINLINE bool bit_test_and_reset(storage_type volatile& storage, unsigned int bit_number, memory_order order) noexcept
  324. {
  325. const storage_type mask =
  326. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(static_cast< emulated_storage_type >(1u) << bit_number));
  327. storage_type old_val = base_type::fetch_and(storage, ~mask, order);
  328. return !!(old_val & mask);
  329. }
  330. static BOOST_FORCEINLINE bool bit_test_and_complement(storage_type volatile& storage, unsigned int bit_number, memory_order order) noexcept
  331. {
  332. const storage_type mask =
  333. atomics::detail::integral_extend< Signed, storage_type >(static_cast< emulated_storage_type >(static_cast< emulated_storage_type >(1u) << bit_number));
  334. storage_type old_val = base_type::fetch_xor(storage, mask, order);
  335. return !!(old_val & mask);
  336. }
  337. };
  338. // Default extra_operations template definition will be used unless specialized for a specific platform
  339. template< typename Base, std::size_t Size, bool Signed >
  340. struct extra_operations< Base, Size, Signed, true > :
  341. public extra_operations_generic< Base, Size, Signed >
  342. {
  343. };
  344. } // namespace detail
  345. } // namespace atomics
  346. } // namespace boost
  347. #include <boost/atomic/detail/footer.hpp>
  348. #endif // BOOST_ATOMIC_DETAIL_EXTRA_OPS_GENERIC_HPP_INCLUDED_