atomic_self_relative_ptr.hpp

// SPDX-License-Identifier: BSD-3-Clause
/* Copyright 2020, Intel Corporation */
 
#ifndef LIBPMEMOBJ_CPP_ATOMIC_SELF_RELATIVE_PTR_HPP
#define LIBPMEMOBJ_CPP_ATOMIC_SELF_RELATIVE_PTR_HPP
 
#include <libpmemobj++/detail/self_relative_ptr_base_impl.hpp>
#include <libpmemobj++/experimental/self_relative_ptr.hpp>
#include <libpmemobj++/transaction.hpp>
 
#include <atomic>
 
#if LIBPMEMOBJ_CPP_VG_HELGRIND_ENABLED
 
#define LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_BEFORE(order, ptr)                     \
    if (order == std::memory_order_release ||                              \
        order == std::memory_order_acq_rel ||                              \
        order == std::memory_order_seq_cst) {                              \
        ANNOTATE_HAPPENS_BEFORE(ptr);                                  \
    }
 
#define LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_AFTER(order, ptr)                      \
    if (order == std::memory_order_consume ||                              \
        order == std::memory_order_acquire ||                              \
        order == std::memory_order_acq_rel ||                              \
        order == std::memory_order_seq_cst) {                              \
        ANNOTATE_HAPPENS_AFTER(ptr);                                   \
    }
#else
 
#define LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_BEFORE(order, ptr)
#define LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_AFTER(order, ptr)
 
#endif
 
namespace std
{
template <typename T>
struct atomic<pmem::obj::experimental::self_relative_ptr<T>> {
private:
    using ptr_type = pmem::detail::self_relative_ptr_base_impl<
        std::atomic<std::ptrdiff_t>>;
    using accessor = pmem::detail::self_relative_accessor<
        std::atomic<std::ptrdiff_t>>;
 
public:
    using this_type = atomic;
    using value_type = pmem::obj::experimental::self_relative_ptr<T>;
    using difference_type = typename value_type::difference_type;
 
    /*
     * Constructors
     */
 
    constexpr atomic() noexcept = default;
    atomic(value_type value) : ptr()
    {
        store(value);
    }
    atomic(const atomic &) = delete;
 
    void
    store(value_type desired,
          std::memory_order order = std::memory_order_seq_cst) noexcept
    {
        auto offset = accessor::pointer_to_offset(ptr, desired.get());
        LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_BEFORE(order, &ptr);
        accessor::get_offset(ptr).store(offset, order);
    }
 
    value_type
    load(std::memory_order order = std::memory_order_seq_cst) const noexcept
    {
        auto offset = accessor::get_offset(ptr).load(order);
        LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_AFTER(order, &ptr);
        auto pointer = accessor::offset_to_pointer<T>(offset, ptr);
        return value_type{pointer};
    }
 
    value_type
    exchange(value_type desired,
         std::memory_order order = std::memory_order_seq_cst) noexcept
    {
        auto new_offset =
            accessor::pointer_to_offset(ptr, desired.get());
        auto old_offset =
            accessor::get_offset(ptr).exchange(new_offset, order);
        return value_type{
            accessor::offset_to_pointer<T>(old_offset, ptr)};
    }
 
    bool
    compare_exchange_weak(value_type &expected, value_type desired,
                  std::memory_order success,
                  std::memory_order failure) noexcept
    {
        auto expected_offset =
            accessor::pointer_to_offset(ptr, expected.get());
        auto desired_offset =
            accessor::pointer_to_offset(ptr, desired.get());
 
        bool result = accessor::get_offset(ptr).compare_exchange_weak(
            expected_offset, desired_offset, success, failure);
        if (!result)
            expected = accessor::offset_to_pointer<T>(
                expected_offset, ptr);
        return result;
    }
 
    bool
    compare_exchange_weak(
        value_type &expected, value_type desired,
        std::memory_order order = std::memory_order_seq_cst) noexcept
    {
        auto expected_offset =
            accessor::pointer_to_offset(ptr, expected.get());
        auto desired_offset =
            accessor::pointer_to_offset(ptr, desired.get());
 
        bool result = accessor::get_offset(ptr).compare_exchange_weak(
            expected_offset, desired_offset, order);
        if (!result)
            expected = accessor::offset_to_pointer<T>(
                expected_offset, ptr);
        return result;
    }
 
    bool
    compare_exchange_strong(value_type &expected, value_type desired,
                std::memory_order success,
                std::memory_order failure) noexcept
    {
        auto expected_offset =
            accessor::pointer_to_offset(ptr, expected.get());
        auto desired_offset =
            accessor::pointer_to_offset(ptr, desired.get());
 
        bool result = accessor::get_offset(ptr).compare_exchange_strong(
            expected_offset, desired_offset, success, failure);
        if (!result)
            expected = accessor::offset_to_pointer<T>(
                expected_offset, ptr);
        return result;
    }
 
    bool
    compare_exchange_strong(
        value_type &expected, value_type desired,
        std::memory_order order = std::memory_order_seq_cst) noexcept
    {
        auto expected_offset =
            accessor::pointer_to_offset(ptr, expected.get());
        auto desired_offset =
            accessor::pointer_to_offset(ptr, desired.get());
 
        bool result = accessor::get_offset(ptr).compare_exchange_strong(
            expected_offset, desired_offset, order);
        if (!result)
            expected = accessor::offset_to_pointer<T>(
                expected_offset, ptr);
        return result;
    }
 
    value_type
    fetch_add(difference_type val,
          std::memory_order order = std::memory_order_seq_cst) noexcept
    {
        auto offset = accessor::get_offset(ptr).fetch_add(
            val * static_cast<difference_type>(sizeof(T)), order);
        return value_type{accessor::offset_to_pointer<T>(offset, ptr)};
    }
 
    value_type
    fetch_sub(difference_type val,
          std::memory_order order = std::memory_order_seq_cst) noexcept
    {
        auto offset = accessor::get_offset(ptr).fetch_sub(
            val * static_cast<difference_type>(sizeof(T)), order);
        return value_type{accessor::offset_to_pointer<T>(offset, ptr)};
    }
 
    bool
    is_lock_free() const noexcept
    {
        return accessor::get_offset(ptr).is_lock_free();
    }
 
    /*
     * Operators
     */
 
    operator value_type() const noexcept
    {
        return load();
    }
 
    atomic &operator=(const atomic &) = delete;
    atomic &operator=(const atomic &) volatile = delete;
 
    value_type
    operator=(value_type desired) noexcept
    {
        store(desired);
        return desired;
    }
 
    value_type
    operator++() noexcept
    {
        return this->fetch_add(1) + 1;
    }
 
    value_type
    operator++(int) noexcept
    {
        return this->fetch_add(1);
    }
 
    value_type
    operator--() noexcept
    {
        return this->fetch_sub(1) - 1;
    }
 
    value_type
    operator--(int) noexcept
    {
        return this->fetch_sub(1);
    }
 
    value_type
    operator+=(difference_type diff) noexcept
    {
        return this->fetch_add(diff) + diff;
    }
 
    value_type
    operator-=(difference_type diff) noexcept
    {
        return this->fetch_sub(diff) - diff;
    }
 
private:
    ptr_type ptr;
};
 
} /* namespace std */
 
#undef LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_BEFORE
#undef LIBPMEMOBJ_CPP_ANNOTATE_HAPPENS_AFTER
 
namespace pmem
{
 
namespace detail
{
 
template <typename T>
struct can_do_snapshot<std::atomic<obj::experimental::self_relative_ptr<T>>> {
    using snapshot_type = obj::experimental::self_relative_ptr<T>;
    static constexpr bool value = sizeof(std::atomic<snapshot_type>) ==
        sizeof(typename snapshot_type::offset_type);
    static_assert(value,
              "std::atomic<self_relative_ptr> should be the same size");
};
 
} /* namespace detail */
 
} /* namespace pmem */
 
#endif