make_persistent.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
/* Copyright 2016-2021, Intel Corporation */
 
#ifndef LIBPMEMOBJ_CPP_MAKE_PERSISTENT_HPP
#define LIBPMEMOBJ_CPP_MAKE_PERSISTENT_HPP
 
#include <libpmemobj++/allocation_flag.hpp>
#include <libpmemobj++/detail/check_persistent_ptr_array.hpp>
#include <libpmemobj++/detail/common.hpp>
#include <libpmemobj++/detail/life.hpp>
#include <libpmemobj++/detail/variadic.hpp>
#include <libpmemobj++/make_persistent_array.hpp>
#include <libpmemobj++/pexceptions.hpp>
#include <libpmemobj/tx_base.h>
 
#include <new>
#include <utility>
 
namespace pmem
{
 
namespace obj
{
 
template <typename T, typename... Args>
typename detail::pp_if_not_array<T>::type
make_persistent(allocation_flag flag, Args &&... args)
{
    if (pmemobj_tx_stage() != TX_STAGE_WORK)
        throw pmem::transaction_scope_error(
            "refusing to allocate memory outside of transaction scope");
 
    persistent_ptr<T> ptr =
        pmemobj_tx_xalloc(sizeof(T), detail::type_num<T>(), flag.value);
 
    if (ptr == nullptr) {
        const char *msg = "Failed to allocate persistent memory object";
        if (errno == ENOMEM)
            throw detail::exception_with_errormsg<
                pmem::transaction_out_of_memory>(msg);
        else
            throw detail::exception_with_errormsg<
                pmem::transaction_alloc_error>(msg);
    }
 
    detail::create<T, Args...>(ptr.get(), std::forward<Args>(args)...);
 
    return ptr;
}
 
template <typename T, typename... Args>
typename std::enable_if<
    !detail::is_first_arg_same<allocation_flag, Args...>::value,
    typename detail::pp_if_not_array<T>::type>::type
make_persistent(Args &&... args)
{
    return make_persistent<T>(allocation_flag::none(),
                  std::forward<Args>(args)...);
}
 
template <typename T>
void
delete_persistent(typename detail::pp_if_not_array<T>::type ptr)
{
    if (pmemobj_tx_stage() != TX_STAGE_WORK)
        throw pmem::transaction_scope_error(
            "refusing to free memory outside of transaction scope");
 
    if (ptr == nullptr)
        return;
 
    /*
     * At this point, everything in the object should be tracked
     * and reverted on transaction abort.
     */
    detail::destroy<T>(*ptr);
 
    if (pmemobj_tx_free(*ptr.raw_ptr()) != 0)
        throw detail::exception_with_errormsg<
            pmem::transaction_free_error>(
            "failed to delete persistent memory object");
}
 
} /* namespace obj */
 
} /* namespace pmem */
 
#endif /* LIBPMEMOBJ_CPP_MAKE_PERSISTENT_HPP */