PMDK C++ bindings  1.6.1
This is the C++ bindings documentation for PMDK's libpmemobj.
make_persistent.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2016-2019, 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 LIBPMEMOBJ_CPP_MAKE_PERSISTENT_HPP
41 #define LIBPMEMOBJ_CPP_MAKE_PERSISTENT_HPP
42 
49 #include <libpmemobj/tx_base.h>
50 
51 #include <new>
52 #include <utility>
53 
54 namespace pmem
55 {
56 
57 namespace obj
58 {
59 
76 template <typename T, typename... Args>
77 typename detail::pp_if_not_array<T>::type
78 make_persistent(allocation_flag flag, Args &&... args)
79 {
80  if (pmemobj_tx_stage() != TX_STAGE_WORK)
82  "refusing to allocate memory outside of transaction scope");
83 
84  persistent_ptr<T> ptr =
85  pmemobj_tx_xalloc(sizeof(T), detail::type_num<T>(), flag.value);
86 
87  if (ptr == nullptr)
89  "failed to allocate persistent memory object");
90 
91  detail::create<T, Args...>(ptr.get(), std::forward<Args>(args)...);
92 
93  return ptr;
94 }
95 
111 template <typename T, typename... Args>
112 typename std::enable_if<
113  !detail::is_first_arg_same<allocation_flag, Args...>::value,
114  typename detail::pp_if_not_array<T>::type>::type
115 make_persistent(Args &&... args)
116 {
117  return make_persistent<T>(allocation_flag::none(),
118  std::forward<Args>(args)...);
119 }
120 
135 template <typename T>
136 void
138 {
139  if (pmemobj_tx_stage() != TX_STAGE_WORK)
141  "refusing to free memory outside of transaction scope");
142 
143  if (ptr == nullptr)
144  return;
145 
146  /*
147  * At this point, everything in the object should be tracked
148  * and reverted on transaction abort.
149  */
150  detail::destroy<T>(*ptr);
151 
152  if (pmemobj_tx_free(*ptr.raw_ptr()) != 0)
154  "failed to delete persistent memory object");
155 }
156 
157 } /* namespace obj */
158 
159 } /* namespace pmem */
160 
161 #endif /* LIBPMEMOBJ_CPP_MAKE_PERSISTENT_HPP */
pmem::obj::delete_persistent
void delete_persistent(typename detail::pp_if_not_array< T >::type ptr)
Transactionally free an object of type T held in a persistent_ptr.
Definition: make_persistent.hpp:137
pmem::transaction_free_error
Custom transaction error class.
Definition: pexceptions.hpp:94
pmem::obj::make_persistent
detail::pp_if_not_array< T >::type make_persistent(allocation_flag flag, Args &&... args)
Transactionally allocate and construct an object of type T.
Definition: make_persistent.hpp:78
common.hpp
Commonly used functionality.
pexceptions.hpp
Custom exceptions.
check_persistent_ptr_array.hpp
Compile time type check for make_persistent.
pmem::obj::persistent_ptr
Persistent pointer class.
Definition: persistent_ptr.hpp:132
pmem::obj::allocation_flag::none
static allocation_flag none()
Do not change allocator behaviour.
Definition: allocation_flag.hpp:90
life.hpp
Functions for destroying arrays.
pmem::obj::allocation_flag
Type of flag which can be passed to make_persistent.
Definition: allocation_flag.hpp:60
pmem::transaction_scope_error
Custom transaction error class.
Definition: pexceptions.hpp:104
variadic.hpp
Helper functionality for handling variadic templates.
allocation_flag.hpp
allocation_flag - defines flags which can be passed to make_persistent
pmem::transaction_alloc_error
Custom transaction error class.
Definition: pexceptions.hpp:84