PMDK C++ bindings  1.5.2
This is the C++ bindings documentation for PMDK's libpmemobj.
make_persistent.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2016-2018, 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 
47 #include <libpmemobj/tx_base.h>
48 
49 #include <new>
50 #include <utility>
51 
52 namespace pmem
53 {
54 
55 namespace obj
56 {
57 
73 template <typename T, typename... Args>
74 typename detail::pp_if_not_array<T>::type
75 make_persistent(Args &&... args)
76 {
77  if (pmemobj_tx_stage() != TX_STAGE_WORK)
79  "refusing to allocate "
80  "memory outside of transaction scope");
81 
82  persistent_ptr<T> ptr =
83  pmemobj_tx_alloc(sizeof(T), detail::type_num<T>());
84 
85  if (ptr == nullptr)
86  throw transaction_alloc_error("failed to allocate "
87  "persistent memory object");
88 
89  detail::create<T, Args...>(ptr.get(), std::forward<Args>(args)...);
90 
91  return ptr;
92 }
93 
108 template <typename T>
109 void
111 {
112  if (pmemobj_tx_stage() != TX_STAGE_WORK)
114  "refusing to free "
115  "memory outside of transaction scope");
116 
117  if (ptr == nullptr)
118  return;
119 
120  /*
121  * At this point, everything in the object should be tracked
122  * and reverted on transaction abort.
123  */
124  detail::destroy<T>(*ptr);
125 
126  if (pmemobj_tx_free(*ptr.raw_ptr()) != 0)
127  throw transaction_free_error("failed to delete "
128  "persistent memory object");
129 }
130 
131 } /* namespace obj */
132 
133 } /* namespace pmem */
134 
135 #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:110
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(Args &&... args)
Transactionally allocate and construct an object of type T.
Definition: make_persistent.hpp:75
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
life.hpp
Functions for destroying arrays.
pmem::transaction_scope_error
Custom transaction error class.
Definition: pexceptions.hpp:104
pmem::transaction_alloc_error
Custom transaction error class.
Definition: pexceptions.hpp:84