2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP
12 #include <type_traits>
14 #include <babeltrace2/babeltrace.h>
16 #include "cpp-common/optional.hpp"
17 #include "cpp-common/string_view.hpp"
18 #include "cpp-common/uuid-view.hpp"
20 #include "borrowed-object.hpp"
22 #include "internal/utils.hpp"
23 #include "shared-object.hpp"
29 struct ClockClassRefFuncs final
31 static void get(const bt_clock_class * const libObjPtr) noexcept
33 bt_clock_class_get_ref(libObjPtr);
36 static void put(const bt_clock_class * const libObjPtr) noexcept
38 bt_clock_class_put_ref(libObjPtr);
42 template <typename LibObjT>
43 struct CommonClockClassSpec;
45 /* Functions specific to mutable clock classes */
47 struct CommonClockClassSpec<bt_clock_class> final
49 static bt_value *userAttributes(bt_clock_class * const libObjPtr) noexcept
51 return bt_clock_class_borrow_user_attributes(libObjPtr);
55 /* Functions specific to constant clock classes */
57 struct CommonClockClassSpec<const bt_clock_class> final
59 static const bt_value *userAttributes(const bt_clock_class * const libObjPtr) noexcept
61 return bt_clock_class_borrow_user_attributes_const(libObjPtr);
65 } /* namespace internal */
67 class ClockClassOffset final
70 explicit ClockClassOffset(const std::int64_t seconds, const std::uint64_t cycles) :
71 _mSeconds {seconds}, _mCycles {cycles}
75 ClockClassOffset(const ClockClassOffset&) noexcept = default;
76 ClockClassOffset& operator=(const ClockClassOffset&) noexcept = default;
78 std::int64_t seconds() const noexcept
83 std::uint64_t cycles() const noexcept
89 std::int64_t _mSeconds;
90 std::uint64_t _mCycles;
93 template <typename LibObjT>
94 class CommonClockClass final : public BorrowedObject<LibObjT>
97 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
98 using typename BorrowedObject<LibObjT>::_LibObjPtr;
101 using Shared = SharedObject<CommonClockClass, LibObjT, internal::ClockClassRefFuncs>;
102 using UserAttributes = internal::DepUserAttrs<LibObjT>;
104 explicit CommonClockClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
108 template <typename OtherLibObjT>
109 CommonClockClass(const CommonClockClass<OtherLibObjT> clkClass) noexcept :
110 _ThisBorrowedObject {clkClass}
114 template <typename OtherLibObjT>
115 CommonClockClass& operator=(const CommonClockClass<OtherLibObjT> clkClass) noexcept
117 _ThisBorrowedObject::operator=(clkClass);
121 CommonClockClass<const bt_clock_class> asConst() const noexcept
123 return CommonClockClass<const bt_clock_class> {*this};
126 void frequency(const std::uint64_t frequency) const noexcept
128 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
130 bt_clock_class_set_frequency(this->libObjPtr(), frequency);
133 std::uint64_t frequency() const noexcept
135 return bt_clock_class_get_frequency(this->libObjPtr());
138 void offset(const ClockClassOffset& offset) const noexcept
140 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
142 bt_clock_class_set_offset(this->libObjPtr(), offset.seconds(), offset.cycles());
145 ClockClassOffset offset() const noexcept
147 std::int64_t seconds;
148 std::uint64_t cycles;
150 bt_clock_class_get_offset(this->libObjPtr(), &seconds, &cycles);
151 return ClockClassOffset {seconds, cycles};
154 void precision(const std::uint64_t precision) const noexcept
156 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
158 bt_clock_class_set_precision(this->libObjPtr(), precision);
161 std::uint64_t precision() const noexcept
163 return bt_clock_class_get_precision(this->libObjPtr());
166 void originIsUnixEpoch(const bool originIsUnixEpoch) const noexcept
168 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
170 bt_clock_class_set_origin_is_unix_epoch(this->libObjPtr(),
171 static_cast<bt_bool>(originIsUnixEpoch));
174 bool originIsUnixEpoch() const noexcept
176 return static_cast<bool>(bt_clock_class_origin_is_unix_epoch(this->libObjPtr()));
179 void name(const char * const name) const
181 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
183 const auto status = bt_clock_class_set_name(this->libObjPtr(), name);
185 if (status == BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
186 throw MemoryError {};
190 void name(const std::string& name) const
192 this->name(name.data());
195 nonstd::optional<bpstd::string_view> name() const noexcept
197 const auto name = bt_clock_class_get_name(this->libObjPtr());
203 return nonstd::nullopt;
206 void description(const char * const description) const
208 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
210 const auto status = bt_clock_class_set_description(this->libObjPtr(), description);
212 if (status == BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR) {
213 throw MemoryError {};
217 void description(const std::string& description) const
219 this->description(description.data());
222 nonstd::optional<bpstd::string_view> description() const noexcept
224 const auto description = bt_clock_class_get_description(this->libObjPtr());
230 return nonstd::nullopt;
233 void uuid(const std::uint8_t * const uuid) const noexcept
235 bt_clock_class_set_uuid(this->libObjPtr(), uuid);
238 nonstd::optional<bt2_common::UuidView> uuid() const noexcept
240 const auto uuid = bt_clock_class_get_uuid(this->libObjPtr());
243 return bt2_common::UuidView {uuid};
246 return nonstd::nullopt;
249 template <typename LibValT>
250 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
252 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
254 bt_clock_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
257 UserAttributes userAttributes() const noexcept
259 return UserAttributes {
260 internal::CommonClockClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
263 std::int64_t cyclesToNsFromOrigin(const std::uint64_t value) const
265 std::int64_t nsFromOrigin;
267 bt_clock_class_cycles_to_ns_from_origin(this->libObjPtr(), value, &nsFromOrigin);
269 if (status == BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR) {
270 throw OverflowError {};
276 Shared shared() const noexcept
278 return Shared::createWithRef(*this);
282 using ClockClass = CommonClockClass<bt_clock_class>;
283 using ConstClockClass = CommonClockClass<const bt_clock_class>;
287 struct ClockClassTypeDescr
289 using Const = ConstClockClass;
290 using NonConst = ClockClass;
294 struct TypeDescr<ClockClass> : public ClockClassTypeDescr
299 struct TypeDescr<ConstClockClass> : public ClockClassTypeDescr
303 } /* namespace internal */
304 } /* namespace bt2 */
306 #endif /* BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP */