PMDK C++ bindings 1.2.0
This is the C++ bindings documentation for PMDK's libpmemobj.
common.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
38#ifndef PMEMOBJ_COMMON_HPP
39#define PMEMOBJ_COMMON_HPP
40
42#include "libpmemobj/tx_base.h"
43#include <typeinfo>
44
45namespace pmem
46{
47
48namespace obj
49{
50template <typename T>
51class persistent_ptr;
52}
53
54namespace detail
55{
56
57/*
58 * Conditionally add an object to a transaction.
59 *
60 * Adds `*that` to the transaction if it is within a pmemobj pool and
61 * there is an active transaction. Does nothing otherwise.
62 *
63 * @param[in] that pointer to the object being added to the transaction.
64 */
65template <typename T>
66inline void
67conditional_add_to_tx(const T *that)
68{
69 if (pmemobj_tx_stage() != TX_STAGE_WORK)
70 return;
71
72 /* 'that' is not in any open pool */
73 if (!pmemobj_pool_by_ptr(that))
74 return;
75
76 if (pmemobj_tx_add_range_direct(that, sizeof(*that)))
77 throw transaction_error("Could not add an object to the"
78 " transaction.");
79}
80
81/*
82 * Conditionally add an object to a transaction.
83 *
84 * Adds `*that` to the transaction if it is within a pmemobj pool and
85 * there is an active transaction. Does nothing otherwise.
86 *
87 * @param[in] that persistent pointer to the object being added to the
88 * transaction. This has to be a persistent pointer to the start of an
89 * allocation and not in the middle of it.
90 */
91template <typename T>
92inline void
93conditional_add_to_tx(const obj::persistent_ptr<T> &that)
94{
95 if (pmemobj_tx_stage() != TX_STAGE_WORK)
96 return;
97
98 if (pmemobj_tx_add_range(that.raw(), 0, sizeof(T)))
99 throw transaction_error("Could not add an object to the"
100 " transaction.");
101}
102
103/*
104 * Return type number for given type.
105 */
106template <typename T>
107uint64_t
108type_num()
109{
110 return typeid(T).hash_code();
111}
112
113} /* namespace detail */
114
115} /* namespace pmem */
116
117#endif /* PMEMOBJ_COMMON_HPP */
Custom exceptions.