PMDK C++ bindings  1.9.1
This is the C++ bindings documentation for PMDK's libpmemobj.
ctl.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 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 
38 #ifndef LIBPMEMOBJ_CPP_CTL_HPP
39 #define LIBPMEMOBJ_CPP_CTL_HPP
40 
41 #include <libpmemobj/ctl.h>
42 #include <string>
43 
44 #include <cerrno>
45 #include <cstring>
46 
48 
49 namespace pmem
50 {
51 
52 namespace obj
53 {
54 
55 template <typename T>
56 T
57 ctl_get_detail(PMEMobjpool *pool, const std::string &name)
58 {
59  T tmp;
60 
61 #ifdef _WIN32
62  int ret = pmemobj_ctl_getU(pool, name.c_str(), &tmp);
63 #else
64  int ret = pmemobj_ctl_get(pool, name.c_str(), &tmp);
65 #endif
66  if (ret)
67  throw pmem::ctl_error("ctl_get failed").with_pmemobj_errormsg();
68 
69  return tmp;
70 }
71 
72 template <typename T>
73 T
74 ctl_set_detail(PMEMobjpool *pool, const std::string &name, T arg)
75 {
76 #ifdef _WIN32
77  int ret = pmemobj_ctl_setU(pool, name.c_str(), &arg);
78 #else
79  int ret = pmemobj_ctl_set(pool, name.c_str(), &arg);
80 #endif
81  if (ret)
82  throw pmem::ctl_error("ctl_set failed").with_pmemobj_errormsg();
83 
84  return arg;
85 }
86 
87 template <typename T>
88 T
89 ctl_exec_detail(PMEMobjpool *pool, const std::string &name, T arg)
90 {
91 #ifdef _WIN32
92  int ret = pmemobj_ctl_execU(pool, name.c_str(), &arg);
93 #else
94  int ret = pmemobj_ctl_exec(pool, name.c_str(), &arg);
95 #endif
96  if (ret)
97  throw pmem::ctl_error("ctl_exec failed")
98  .with_pmemobj_errormsg();
99 
100  return arg;
101 }
102 
103 #ifdef _WIN32
104 template <typename T>
105 T
106 ctl_get_detail(PMEMobjpool *pool, const std::wstring &name)
107 {
108  T tmp;
109 
110  int ret = pmemobj_ctl_getW(pool, name.c_str(), &tmp);
111  if (ret)
112  throw pmem::ctl_error("ctl_get failed").with_pmemobj_errormsg();
113 
114  return tmp;
115 }
116 
117 template <typename T>
118 T
119 ctl_set_detail(PMEMobjpool *pool, const std::wstring &name, T arg)
120 {
121  int ret = pmemobj_ctl_setW(pool, name.c_str(), &arg);
122  if (ret)
123  throw pmem::ctl_error("ctl_set failed").with_pmemobj_errormsg();
124 
125  return arg;
126 }
127 
128 template <typename T>
129 T
130 ctl_exec_detail(PMEMobjpool *pool, const std::wstring &name, T arg)
131 {
132  int ret = pmemobj_ctl_execW(pool, name.c_str(), &arg);
133  if (ret)
134  throw pmem::ctl_error("ctl_exec failed")
135  .with_pmemobj_errormsg();
136 
137  return arg;
138 }
139 #endif
140 
141 } /* namespace obj */
142 
143 } /* namespace pmem */
144 
145 #endif /* LIBPMEMOBJ_CPP_CTL_HPP */
pmem
Persistent memory namespace.
Definition: allocation_flag.hpp:44
pexceptions.hpp
Custom exceptions.
pmem::ctl_error
Custom ctl error class.
Definition: pexceptions.hpp:222