Commit | Line | Data |
---|---|---|
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 | 10 | #include <cstdint> |
c802cacb SM |
11 | #include <type_traits> |
12 | ||
cfc44919 PP |
13 | #include <babeltrace2/babeltrace.h> |
14 | ||
e7f0f07b | 15 | #include "cpp-common/bt2c/c-string-view.hpp" |
12958bb9 | 16 | #include "cpp-common/bt2c/uuid.hpp" |
c022776a | 17 | #include "cpp-common/bt2s/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 | ||
25 | namespace bt2 { | |
cfc44919 PP |
26 | namespace internal { |
27 | ||
28 | struct 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 | ||
41 | template <typename LibObjT> | |
42 | struct CommonClockClassSpec; | |
43 | ||
b5f55e9f | 44 | /* Functions specific to mutable clock classes */ |
cfc44919 PP |
45 | template <> |
46 | struct 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 |
55 | template <> |
56 | struct 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 | 65 | |
aa5aac94 | 66 | class ClockOffset final |
cfc44919 PP |
67 | { |
68 | public: | |
aa5aac94 | 69 | explicit ClockOffset(const std::int64_t seconds, const std::uint64_t cycles) : |
cfc44919 PP |
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 | ||
84 | private: | |
85 | std::int64_t _mSeconds; | |
86 | std::uint64_t _mCycles; | |
87 | }; | |
88 | ||
89 | template <typename LibObjT> | |
0d218157 | 90 | class CommonClockClass final : public BorrowedObject<LibObjT> |
cfc44919 PP |
91 | { |
92 | private: | |
0d218157 | 93 | using typename BorrowedObject<LibObjT>::_ThisBorrowedObject; |
cfc44919 PP |
94 | |
95 | public: | |
d246c457 | 96 | using typename BorrowedObject<LibObjT>::LibObjPtr; |
ac19444e | 97 | using Shared = SharedObject<CommonClockClass, LibObjT, internal::ClockClassRefFuncs>; |
8047a175 | 98 | using UserAttributes = internal::DepUserAttrs<LibObjT>; |
cfc44919 | 99 | |
d246c457 | 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 | ||
aa5aac94 | 134 | void offsetFromOrigin(const ClockOffset& offsetFromOrigin) const noexcept |
cfc44919 | 135 | { |
5c895f64 | 136 | static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`."); |
cfc44919 | 137 | |
aa5aac94 PP |
138 | bt_clock_class_set_offset(this->libObjPtr(), offsetFromOrigin.seconds(), |
139 | offsetFromOrigin.cycles()); | |
cfc44919 PP |
140 | } |
141 | ||
aa5aac94 | 142 | ClockOffset offsetFromOrigin() const noexcept |
cfc44919 PP |
143 | { |
144 | std::int64_t seconds; | |
145 | std::uint64_t cycles; | |
146 | ||
341a67c4 | 147 | bt_clock_class_get_offset(this->libObjPtr(), &seconds, &cycles); |
aa5aac94 | 148 | return ClockOffset {seconds, cycles}; |
cfc44919 PP |
149 | } |
150 | ||
dcb8ae9b | 151 | void precision(const std::uint64_t precision) const noexcept |
cfc44919 | 152 | { |
5c895f64 | 153 | static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`."); |
cfc44919 | 154 | |
341a67c4 | 155 | bt_clock_class_set_precision(this->libObjPtr(), precision); |
cfc44919 PP |
156 | } |
157 | ||
158 | std::uint64_t precision() const noexcept | |
159 | { | |
341a67c4 | 160 | return bt_clock_class_get_precision(this->libObjPtr()); |
cfc44919 PP |
161 | } |
162 | ||
dcb8ae9b | 163 | void originIsUnixEpoch(const bool originIsUnixEpoch) const noexcept |
cfc44919 | 164 | { |
5c895f64 | 165 | static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`."); |
cfc44919 | 166 | |
341a67c4 | 167 | bt_clock_class_set_origin_is_unix_epoch(this->libObjPtr(), |
cfc44919 PP |
168 | static_cast<bt_bool>(originIsUnixEpoch)); |
169 | } | |
170 | ||
171 | bool originIsUnixEpoch() const noexcept | |
172 | { | |
341a67c4 | 173 | return static_cast<bool>(bt_clock_class_origin_is_unix_epoch(this->libObjPtr())); |
cfc44919 PP |
174 | } |
175 | ||
15030982 | 176 | void name(const bt2c::CStringView name) const |
cfc44919 | 177 | { |
5c895f64 | 178 | static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`."); |
cfc44919 | 179 | |
341a67c4 | 180 | const auto status = bt_clock_class_set_name(this->libObjPtr(), name); |
cfc44919 PP |
181 | |
182 | if (status == BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR) { | |
39278ebc | 183 | throw MemoryError {}; |
cfc44919 PP |
184 | } |
185 | } | |
186 | ||
e7f0f07b | 187 | bt2c::CStringView name() const noexcept |
cfc44919 | 188 | { |
5cc5088c | 189 | return bt_clock_class_get_name(this->libObjPtr()); |
cfc44919 PP |
190 | } |
191 | ||
15030982 | 192 | void description(const bt2c::CStringView description) const |
cfc44919 | 193 | { |
5c895f64 | 194 | static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`."); |
cfc44919 | 195 | |
341a67c4 | 196 | const auto status = bt_clock_class_set_description(this->libObjPtr(), description); |
cfc44919 PP |
197 | |
198 | if (status == BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR) { | |
39278ebc | 199 | throw MemoryError {}; |
cfc44919 PP |
200 | } |
201 | } | |
202 | ||
e7f0f07b | 203 | bt2c::CStringView description() const noexcept |
cfc44919 | 204 | { |
5cc5088c | 205 | return bt_clock_class_get_description(this->libObjPtr()); |
cfc44919 PP |
206 | } |
207 | ||
dcb8ae9b | 208 | void uuid(const std::uint8_t * const uuid) const noexcept |
cfc44919 | 209 | { |
341a67c4 | 210 | bt_clock_class_set_uuid(this->libObjPtr(), uuid); |
cfc44919 PP |
211 | } |
212 | ||
c022776a | 213 | bt2s::optional<bt2c::UuidView> uuid() const noexcept |
cfc44919 | 214 | { |
341a67c4 | 215 | const auto uuid = bt_clock_class_get_uuid(this->libObjPtr()); |
cfc44919 PP |
216 | |
217 | if (uuid) { | |
094bf3f2 | 218 | return bt2c::UuidView {uuid}; |
cfc44919 PP |
219 | } |
220 | ||
c022776a | 221 | return bt2s::nullopt; |
cfc44919 PP |
222 | } |
223 | ||
224 | template <typename LibValT> | |
b7ffa6f0 | 225 | void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept |
cfc44919 | 226 | { |
5c895f64 | 227 | static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`."); |
cfc44919 | 228 | |
341a67c4 | 229 | bt_clock_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr()); |
cfc44919 PP |
230 | } |
231 | ||
dcb8ae9b | 232 | UserAttributes userAttributes() const noexcept |
cfc44919 PP |
233 | { |
234 | return UserAttributes { | |
341a67c4 | 235 | internal::CommonClockClassSpec<LibObjT>::userAttributes(this->libObjPtr())}; |
cfc44919 PP |
236 | } |
237 | ||
238 | std::int64_t cyclesToNsFromOrigin(const std::uint64_t value) const | |
239 | { | |
240 | std::int64_t nsFromOrigin; | |
241 | const auto status = | |
341a67c4 | 242 | bt_clock_class_cycles_to_ns_from_origin(this->libObjPtr(), value, &nsFromOrigin); |
cfc44919 PP |
243 | |
244 | if (status == BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR) { | |
39278ebc | 245 | throw OverflowError {}; |
cfc44919 PP |
246 | } |
247 | ||
248 | return nsFromOrigin; | |
249 | } | |
250 | ||
251 | Shared shared() const noexcept | |
252 | { | |
c9c0b6e2 | 253 | return Shared::createWithRef(*this); |
cfc44919 PP |
254 | } |
255 | }; | |
256 | ||
257 | using ClockClass = CommonClockClass<bt_clock_class>; | |
258 | using ConstClockClass = CommonClockClass<const bt_clock_class>; | |
259 | ||
4927bae7 PP |
260 | namespace internal { |
261 | ||
262 | struct ClockClassTypeDescr | |
263 | { | |
264 | using Const = ConstClockClass; | |
265 | using NonConst = ClockClass; | |
266 | }; | |
267 | ||
268 | template <> | |
269 | struct TypeDescr<ClockClass> : public ClockClassTypeDescr | |
270 | { | |
271 | }; | |
272 | ||
273 | template <> | |
274 | struct TypeDescr<ConstClockClass> : public ClockClassTypeDescr | |
275 | { | |
276 | }; | |
277 | ||
278 | } /* namespace internal */ | |
b5f55e9f | 279 | } /* namespace bt2 */ |
cfc44919 | 280 | |
b5f55e9f | 281 | #endif /* BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP */ |