PMDK C++ bindings 1.2.0
This is the C++ bindings documentation for PMDK's libpmemobj.
make_persistent.hpp
Go to the documentation of this file.
1/*
2 * Copyright 2016-2017, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
40#ifndef PMEMOBJ_MAKE_PERSISTENT_HPP
41#define PMEMOBJ_MAKE_PERSISTENT_HPP
42
47#include "libpmemobj/tx_base.h"
48
49#include <new>
50#include <utility>
51
52namespace pmem
53{
54
55namespace obj
56{
57
72template <typename T, typename... Args>
73typename detail::pp_if_not_array<T>::type
74make_persistent(Args &&... args)
75{
76 if (pmemobj_tx_stage() != TX_STAGE_WORK)
78 "refusing to allocate "
79 "memory outside of transaction scope");
80
82 pmemobj_tx_alloc(sizeof(T), detail::type_num<T>());
83
84 if (ptr == nullptr)
85 throw transaction_alloc_error("failed to allocate "
86 "persistent memory object");
87 try {
88 detail::create<T, Args...>(ptr.get(),
89 std::forward<Args>(args)...);
90 } catch (...) {
91 pmemobj_tx_free(*ptr.raw_ptr());
92 throw;
93 }
94
95 return ptr;
96}
97
112template <typename T>
113void
115{
116 if (pmemobj_tx_stage() != TX_STAGE_WORK)
118 "refusing to free "
119 "memory outside of transaction scope");
120
121 if (ptr == nullptr)
122 return;
123
124 /*
125 * At this point, everything in the object should be tracked
126 * and reverted on transaction abort.
127 */
128 detail::destroy<T>(*ptr);
129
130 if (pmemobj_tx_free(*ptr.raw_ptr()) != 0)
131 throw transaction_free_error("failed to delete "
132 "persistent memory object");
133}
134
135} /* namespace obj */
136
137} /* namespace pmem */
138
139#endif /* PMEMOBJ_MAKE_PERSISTENT_HPP */
Compile time type check for make_persistent.
element_type * get() const noexcept
Get a direct pointer.
Definition: persistent_ptr_base.hpp:278
PMEMoid * raw_ptr() noexcept
Get pointer to PMEMoid encapsulated by this object.
Definition: persistent_ptr_base.hpp:309
Persistent pointer class.
Definition: persistent_ptr.hpp:102
Custom transaction error class.
Definition: pexceptions.hpp:84
Custom transaction error class.
Definition: pexceptions.hpp:94
Custom transaction error class.
Definition: pexceptions.hpp:104
Commonly used functionality.
Functions for destroying arrays.
detail::pp_if_not_array< T >::type make_persistent(Args &&... args)
Transactionally allocate and construct an object of type T.
Definition: make_persistent.hpp:74
void delete_persistent(typename detail::pp_if_not_array< T >::type ptr)
Transactionally free an object of type T held in a persitent_ptr.
Definition: make_persistent.hpp:114
Custom exceptions.