NVML C++ bindings  0.1 experimental
This is the C++ bindings documentation for NVML's libpmemobj.
common.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2016, 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 
41 #include "libpmemobj++/detail/pexceptions.hpp"
42 #include "libpmemobj/tx_base.h"
43 #include <typeinfo>
44 
45 namespace nvml
46 {
47 
48 namespace detail
49 {
50 
51 /*
52  * Conditionally add an object to a transaction.
53  *
54  * Adds `*that` to the transaction if it is within a pmemobj pool and
55  * there is an active transaction. Does nothing otherwise.
56  *
57  * @param[in] that pointer to the object being added to the transaction.
58  */
59 template <typename T>
60 inline void
61 conditional_add_to_tx(const T *that)
62 {
63  /* 'that' is not in any open pool */
64  if (!pmemobj_pool_by_ptr(that))
65  return;
66 
67  if (pmemobj_tx_stage() != TX_STAGE_WORK)
68  return;
69 
70  if (pmemobj_tx_add_range_direct(that, sizeof(*that)))
71  throw transaction_error("Could not add an object to the"
72  " transaction.");
73 }
74 
75 /*
76  * Return type number for given type.
77  */
78 template <typename T>
79 constexpr uint64_t
80 type_num()
81 {
82  return typeid(T).hash_code();
83 }
84 
85 } /* namespace detail */
86 
87 } /* namespace nvml */
88 
89 #endif /* PMEMOBJ_COMMON_HPP */
pexceptions.hpp
Custom exceptions.
nvml
Definition: condition_variable.hpp:48
Generated by   doxygen 1.8.11