atomic_ref.hpp 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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) 2020 Andrey Semashev
  7. */
  8. /*!
  9. * \file atomic/atomic_ref.hpp
  10. *
  11. * This header contains definition of \c atomic_ref template.
  12. */
  13. #ifndef BOOST_ATOMIC_ATOMIC_REF_HPP_INCLUDED_
  14. #define BOOST_ATOMIC_ATOMIC_REF_HPP_INCLUDED_
  15. #include <boost/assert.hpp>
  16. #include <boost/static_assert.hpp>
  17. #include <boost/memory_order.hpp>
  18. #include <boost/atomic/capabilities.hpp>
  19. #include <boost/atomic/detail/config.hpp>
  20. #include <boost/atomic/detail/intptr.hpp>
  21. #include <boost/atomic/detail/classify.hpp>
  22. #include <boost/atomic/detail/atomic_ref_impl.hpp>
  23. #include <boost/atomic/detail/type_traits/is_trivially_copyable.hpp>
  24. #include <boost/atomic/detail/header.hpp>
  25. #ifdef BOOST_HAS_PRAGMA_ONCE
  26. #pragma once
  27. #endif
  28. namespace boost {
  29. namespace atomics {
  30. //! Atomic reference to external object
  31. template< typename T >
  32. class atomic_ref :
  33. public atomics::detail::base_atomic_ref< T, typename atomics::detail::classify< T >::type, false >
  34. {
  35. private:
  36. typedef atomics::detail::base_atomic_ref< T, typename atomics::detail::classify< T >::type, false > base_type;
  37. typedef typename base_type::value_arg_type value_arg_type;
  38. public:
  39. typedef typename base_type::value_type value_type;
  40. BOOST_STATIC_ASSERT_MSG(sizeof(value_type) > 0u, "boost::atomic_ref<T> requires T to be a complete type");
  41. #if !defined(BOOST_ATOMIC_DETAIL_NO_CXX11_IS_TRIVIALLY_COPYABLE)
  42. BOOST_STATIC_ASSERT_MSG(atomics::detail::is_trivially_copyable< value_type >::value, "boost::atomic_ref<T> requires T to be a trivially copyable type");
  43. #endif
  44. private:
  45. typedef typename base_type::storage_type storage_type;
  46. public:
  47. BOOST_DEFAULTED_FUNCTION(atomic_ref(atomic_ref const& that) BOOST_ATOMIC_DETAIL_DEF_NOEXCEPT_DECL, BOOST_ATOMIC_DETAIL_DEF_NOEXCEPT_IMPL : base_type(static_cast< base_type const& >(that)) {})
  48. BOOST_FORCEINLINE explicit atomic_ref(value_type& v) BOOST_NOEXCEPT : base_type(v)
  49. {
  50. // Check that referenced object alignment satisfies required alignment
  51. BOOST_ASSERT((((atomics::detail::uintptr_t)this->m_value) & (base_type::required_alignment - 1u)) == 0u);
  52. }
  53. BOOST_FORCEINLINE value_type operator= (value_arg_type v) const BOOST_NOEXCEPT
  54. {
  55. this->store(v);
  56. return v;
  57. }
  58. BOOST_FORCEINLINE operator value_type() const BOOST_NOEXCEPT
  59. {
  60. return this->load();
  61. }
  62. BOOST_DELETED_FUNCTION(atomic_ref& operator= (atomic_ref const&))
  63. };
  64. } // namespace atomics
  65. using atomics::atomic_ref;
  66. } // namespace boost
  67. #include <boost/atomic/detail/footer.hpp>
  68. #endif // BOOST_ATOMIC_ATOMIC_REF_HPP_INCLUDED_