cpp-common: rename `bt2_common` namespace -> `bt2c`
[babeltrace.git] / src / cpp-common / bt2 / clock-class.hpp
CommitLineData
cfc44919
PP
1/*
2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
3 *
4 * SPDX-License-Identifier: MIT
5 */
6
7#ifndef BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP
8#define BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP
9
cfc44919
PP
10#include <cstdint>
11#include <string>
c802cacb
SM
12#include <type_traits>
13
cfc44919
PP
14#include <babeltrace2/babeltrace.h>
15
094bf3f2 16#include "cpp-common/bt2c/uuid-view.hpp"
cfc44919 17#include "cpp-common/optional.hpp"
c802cacb 18
0d218157 19#include "borrowed-object.hpp"
39278ebc 20#include "exc.hpp"
c802cacb 21#include "internal/utils.hpp"
7f5cdaf0 22#include "shared-object.hpp"
cfc44919
PP
23#include "value.hpp"
24
25namespace bt2 {
cfc44919
PP
26namespace internal {
27
28struct ClockClassRefFuncs final
29{
c677c492 30 static void get(const bt_clock_class * const libObjPtr) noexcept
cfc44919
PP
31 {
32 bt_clock_class_get_ref(libObjPtr);
33 }
34
c677c492 35 static void put(const bt_clock_class * const libObjPtr) noexcept
cfc44919
PP
36 {
37 bt_clock_class_put_ref(libObjPtr);
38 }
39};
40
41template <typename LibObjT>
42struct CommonClockClassSpec;
43
b5f55e9f 44/* Functions specific to mutable clock classes */
cfc44919
PP
45template <>
46struct CommonClockClassSpec<bt_clock_class> final
47{
48 static bt_value *userAttributes(bt_clock_class * const libObjPtr) noexcept
49 {
50 return bt_clock_class_borrow_user_attributes(libObjPtr);
51 }
52};
53
b5f55e9f 54/* Functions specific to constant clock classes */
cfc44919
PP
55template <>
56struct CommonClockClassSpec<const bt_clock_class> final
57{
58 static const bt_value *userAttributes(const bt_clock_class * const libObjPtr) noexcept
59 {
60 return bt_clock_class_borrow_user_attributes_const(libObjPtr);
61 }
62};
63
b5f55e9f 64} /* namespace internal */
cfc44919
PP
65
66class ClockClassOffset final
67{
68public:
69 explicit ClockClassOffset(const std::int64_t seconds, const std::uint64_t cycles) :
70 _mSeconds {seconds}, _mCycles {cycles}
71 {
72 }
73
cfc44919
PP
74 std::int64_t seconds() const noexcept
75 {
76 return _mSeconds;
77 }
78
79 std::uint64_t cycles() const noexcept
80 {
81 return _mCycles;
82 }
83
84private:
85 std::int64_t _mSeconds;
86 std::uint64_t _mCycles;
87};
88
89template <typename LibObjT>
0d218157 90class CommonClockClass final : public BorrowedObject<LibObjT>
cfc44919
PP
91{
92private:
0d218157
PP
93 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
94 using typename BorrowedObject<LibObjT>::_LibObjPtr;
cfc44919
PP
95
96public:
ac19444e 97 using Shared = SharedObject<CommonClockClass, LibObjT, internal::ClockClassRefFuncs>;
8047a175 98 using UserAttributes = internal::DepUserAttrs<LibObjT>;
cfc44919 99
0d218157 100 explicit CommonClockClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
cfc44919
PP
101 {
102 }
103
104 template <typename OtherLibObjT>
100fa861 105 CommonClockClass(const CommonClockClass<OtherLibObjT> clkClass) noexcept :
0d218157 106 _ThisBorrowedObject {clkClass}
cfc44919
PP
107 {
108 }
109
110 template <typename OtherLibObjT>
ac19444e 111 CommonClockClass& operator=(const CommonClockClass<OtherLibObjT> clkClass) noexcept
cfc44919 112 {
0d218157 113 _ThisBorrowedObject::operator=(clkClass);
cfc44919
PP
114 return *this;
115 }
116
328a274a
PP
117 CommonClockClass<const bt_clock_class> asConst() const noexcept
118 {
119 return CommonClockClass<const bt_clock_class> {*this};
120 }
121
dcb8ae9b 122 void frequency(const std::uint64_t frequency) const noexcept
cfc44919 123 {
5c895f64 124 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 125
341a67c4 126 bt_clock_class_set_frequency(this->libObjPtr(), frequency);
cfc44919
PP
127 }
128
129 std::uint64_t frequency() const noexcept
130 {
341a67c4 131 return bt_clock_class_get_frequency(this->libObjPtr());
cfc44919
PP
132 }
133
dcb8ae9b 134 void offset(const ClockClassOffset& offset) const noexcept
cfc44919 135 {
5c895f64 136 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 137
341a67c4 138 bt_clock_class_set_offset(this->libObjPtr(), offset.seconds(), offset.cycles());
cfc44919
PP
139 }
140
141 ClockClassOffset offset() const noexcept
142 {
143 std::int64_t seconds;
144 std::uint64_t cycles;
145
341a67c4 146 bt_clock_class_get_offset(this->libObjPtr(), &seconds, &cycles);
cfc44919
PP
147 return ClockClassOffset {seconds, cycles};
148 }
149
dcb8ae9b 150 void precision(const std::uint64_t precision) const noexcept
cfc44919 151 {
5c895f64 152 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 153
341a67c4 154 bt_clock_class_set_precision(this->libObjPtr(), precision);
cfc44919
PP
155 }
156
157 std::uint64_t precision() const noexcept
158 {
341a67c4 159 return bt_clock_class_get_precision(this->libObjPtr());
cfc44919
PP
160 }
161
dcb8ae9b 162 void originIsUnixEpoch(const bool originIsUnixEpoch) const noexcept
cfc44919 163 {
5c895f64 164 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 165
341a67c4 166 bt_clock_class_set_origin_is_unix_epoch(this->libObjPtr(),
cfc44919
PP
167 static_cast<bt_bool>(originIsUnixEpoch));
168 }
169
170 bool originIsUnixEpoch() const noexcept
171 {
341a67c4 172 return static_cast<bool>(bt_clock_class_origin_is_unix_epoch(this->libObjPtr()));
cfc44919
PP
173 }
174
dcb8ae9b 175 void name(const char * const name) const
cfc44919 176 {
5c895f64 177 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 178
341a67c4 179 const auto status = bt_clock_class_set_name(this->libObjPtr(), name);
cfc44919
PP
180
181 if (status == BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
39278ebc 182 throw MemoryError {};
cfc44919
PP
183 }
184 }
185
dcb8ae9b 186 void name(const std::string& name) const
cfc44919
PP
187 {
188 this->name(name.data());
189 }
190
5cc5088c 191 const char *name() const noexcept
cfc44919 192 {
5cc5088c 193 return bt_clock_class_get_name(this->libObjPtr());
cfc44919
PP
194 }
195
dcb8ae9b 196 void description(const char * const description) const
cfc44919 197 {
5c895f64 198 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 199
341a67c4 200 const auto status = bt_clock_class_set_description(this->libObjPtr(), description);
cfc44919
PP
201
202 if (status == BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR) {
39278ebc 203 throw MemoryError {};
cfc44919
PP
204 }
205 }
206
dcb8ae9b 207 void description(const std::string& description) const
cfc44919
PP
208 {
209 this->description(description.data());
210 }
211
5cc5088c 212 const char *description() const noexcept
cfc44919 213 {
5cc5088c 214 return bt_clock_class_get_description(this->libObjPtr());
cfc44919
PP
215 }
216
dcb8ae9b 217 void uuid(const std::uint8_t * const uuid) const noexcept
cfc44919 218 {
341a67c4 219 bt_clock_class_set_uuid(this->libObjPtr(), uuid);
cfc44919
PP
220 }
221
094bf3f2 222 nonstd::optional<bt2c::UuidView> uuid() const noexcept
cfc44919 223 {
341a67c4 224 const auto uuid = bt_clock_class_get_uuid(this->libObjPtr());
cfc44919
PP
225
226 if (uuid) {
094bf3f2 227 return bt2c::UuidView {uuid};
cfc44919
PP
228 }
229
230 return nonstd::nullopt;
231 }
232
233 template <typename LibValT>
b7ffa6f0 234 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
cfc44919 235 {
5c895f64 236 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
cfc44919 237
341a67c4 238 bt_clock_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
cfc44919
PP
239 }
240
dcb8ae9b 241 UserAttributes userAttributes() const noexcept
cfc44919
PP
242 {
243 return UserAttributes {
341a67c4 244 internal::CommonClockClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
cfc44919
PP
245 }
246
247 std::int64_t cyclesToNsFromOrigin(const std::uint64_t value) const
248 {
249 std::int64_t nsFromOrigin;
250 const auto status =
341a67c4 251 bt_clock_class_cycles_to_ns_from_origin(this->libObjPtr(), value, &nsFromOrigin);
cfc44919
PP
252
253 if (status == BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR) {
39278ebc 254 throw OverflowError {};
cfc44919
PP
255 }
256
257 return nsFromOrigin;
258 }
259
260 Shared shared() const noexcept
261 {
c9c0b6e2 262 return Shared::createWithRef(*this);
cfc44919
PP
263 }
264};
265
266using ClockClass = CommonClockClass<bt_clock_class>;
267using ConstClockClass = CommonClockClass<const bt_clock_class>;
268
4927bae7
PP
269namespace internal {
270
271struct ClockClassTypeDescr
272{
273 using Const = ConstClockClass;
274 using NonConst = ClockClass;
275};
276
277template <>
278struct TypeDescr<ClockClass> : public ClockClassTypeDescr
279{
280};
281
282template <>
283struct TypeDescr<ConstClockClass> : public ClockClassTypeDescr
284{
285};
286
287} /* namespace internal */
b5f55e9f 288} /* namespace bt2 */
cfc44919 289
b5f55e9f 290#endif /* BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP */
This page took 0.047306 seconds and 4 git commands to generate.