atomic/test/atomic_wrapper.hpp
Andrey Semashev 80cfbfd0de Added implementation of inter-process atomics.
The inter-process atomics have ipc_ prefixes: ipc_atomic, ipc_atomic_ref
and ipc_atomic_flag. These types are similar to their unprefixed counterparts
with the following distinctions:

- The operations are provided with an added precondition that is_lock_free()
  returns true.
- All operations, including waiting/notifying operations, are address-free,
  so the types are suitable for inter-process communication.
- The new has_native_wait_notify() operation and always_has_native_wait_notify
  static constant allow to test if the target platform has native support for
  address-free waiting/notifying operations. If it does not, a generic
  implementation is used based on a busy wait.
- The new set of capability macros added. The macros are named
  BOOST_ATOMIC_HAS_NATIVE_<T>_IPC_WAIT_NOTIFY and indicate whether address-free
  waiting/notifying operations are supported natively for a given type.

Additionally, to unify interface and implementation of different components,
the has_native_wait_notify() operation and always_has_native_wait_notify
static constant were added to non-IPC atomic types as well. Added
BOOST_ATOMIC_HAS_NATIVE_<T>_WAIT_NOTIFY capability macros to indicate
native support for inter-thread waiting/notifying operations.

Also, added is_lock_free() and is_always_lock_free to atomic_flag.

This commit adds implementation, docs and tests.
2020-06-11 13:07:16 +03:00

72 lines
2.0 KiB
C++

// Copyright (c) 2020 Andrey Semashev
//
// Distributed under the Boost Software License, Version 1.0.
// See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
#ifndef BOOST_ATOMIC_TEST_ATOMIC_WRAPPER_HPP_INCLUDED_
#define BOOST_ATOMIC_TEST_ATOMIC_WRAPPER_HPP_INCLUDED_
#include <boost/atomic/atomic.hpp>
#include <boost/atomic/atomic_ref.hpp>
#include <boost/atomic/ipc_atomic.hpp>
#include <boost/atomic/ipc_atomic_ref.hpp>
#include <boost/config.hpp>
#include "aligned_object.hpp"
//! Wrapper type for atomic template
template< typename T >
struct atomic_wrapper
{
typedef boost::atomic< T > atomic_type;
typedef atomic_type& atomic_reference_type;
atomic_type a;
BOOST_DEFAULTED_FUNCTION(atomic_wrapper(), {})
explicit atomic_wrapper(T const& value) : a(value) {}
};
//! Wrapper type for atomic_ref template
template< typename T >
struct atomic_ref_wrapper
{
typedef boost::atomic_ref< T > atomic_type;
typedef atomic_type const& atomic_reference_type;
aligned_object< T, atomic_type::required_alignment > object;
const atomic_type a;
atomic_ref_wrapper() : a(object.get()) {}
explicit atomic_ref_wrapper(T const& value) : object(value), a(object.get()) {}
};
//! Wrapper type for ipc_atomic template
template< typename T >
struct ipc_atomic_wrapper
{
typedef boost::ipc_atomic< T > atomic_type;
typedef atomic_type& atomic_reference_type;
atomic_type a;
BOOST_DEFAULTED_FUNCTION(ipc_atomic_wrapper(), {})
explicit ipc_atomic_wrapper(T const& value) : a(value) {}
};
//! Wrapper type for atomic_ref template
template< typename T >
struct ipc_atomic_ref_wrapper
{
typedef boost::ipc_atomic_ref< T > atomic_type;
typedef atomic_type const& atomic_reference_type;
aligned_object< T, atomic_type::required_alignment > object;
const atomic_type a;
ipc_atomic_ref_wrapper() : a(object.get()) {}
explicit ipc_atomic_ref_wrapper(T const& value) : object(value), a(object.get()) {}
};
#endif // BOOST_ATOMIC_TEST_ATOMIC_WRAPPER_HPP_INCLUDED_