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/uuid-view.hpp"
19 #include "borrowed-object.hpp"
21 #include "internal/utils.hpp"
22 #include "shared-object.hpp"
28 struct ClockClassRefFuncs final
30 static void get(const bt_clock_class * const libObjPtr) noexcept
32 bt_clock_class_get_ref(libObjPtr);
35 static void put(const bt_clock_class * const libObjPtr) noexcept
37 bt_clock_class_put_ref(libObjPtr);
41 template <typename LibObjT>
42 struct CommonClockClassSpec;
44 /* Functions specific to mutable clock classes */
46 struct CommonClockClassSpec<bt_clock_class> final
48 static bt_value *userAttributes(bt_clock_class * const libObjPtr) noexcept
50 return bt_clock_class_borrow_user_attributes(libObjPtr);
54 /* Functions specific to constant clock classes */
56 struct CommonClockClassSpec<const bt_clock_class> final
58 static const bt_value *userAttributes(const bt_clock_class * const libObjPtr) noexcept
60 return bt_clock_class_borrow_user_attributes_const(libObjPtr);
64 } /* namespace internal */
66 class ClockClassOffset final
69 explicit ClockClassOffset(const std::int64_t seconds, const std::uint64_t cycles) :
70 _mSeconds {seconds}, _mCycles {cycles}
74 std::int64_t seconds() const noexcept
79 std::uint64_t cycles() const noexcept
85 std::int64_t _mSeconds;
86 std::uint64_t _mCycles;
89 template <typename LibObjT>
90 class CommonClockClass final : public BorrowedObject<LibObjT>
93 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
94 using typename BorrowedObject<LibObjT>::_LibObjPtr;
97 using Shared = SharedObject<CommonClockClass, LibObjT, internal::ClockClassRefFuncs>;
98 using UserAttributes = internal::DepUserAttrs<LibObjT>;
100 explicit CommonClockClass(const _LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
104 template <typename OtherLibObjT>
105 CommonClockClass(const CommonClockClass<OtherLibObjT> clkClass) noexcept :
106 _ThisBorrowedObject {clkClass}
110 template <typename OtherLibObjT>
111 CommonClockClass& operator=(const CommonClockClass<OtherLibObjT> clkClass) noexcept
113 _ThisBorrowedObject::operator=(clkClass);
117 CommonClockClass<const bt_clock_class> asConst() const noexcept
119 return CommonClockClass<const bt_clock_class> {*this};
122 void frequency(const std::uint64_t frequency) const noexcept
124 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
126 bt_clock_class_set_frequency(this->libObjPtr(), frequency);
129 std::uint64_t frequency() const noexcept
131 return bt_clock_class_get_frequency(this->libObjPtr());
134 void offset(const ClockClassOffset& offset) const noexcept
136 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
138 bt_clock_class_set_offset(this->libObjPtr(), offset.seconds(), offset.cycles());
141 ClockClassOffset offset() const noexcept
143 std::int64_t seconds;
144 std::uint64_t cycles;
146 bt_clock_class_get_offset(this->libObjPtr(), &seconds, &cycles);
147 return ClockClassOffset {seconds, cycles};
150 void precision(const std::uint64_t precision) const noexcept
152 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
154 bt_clock_class_set_precision(this->libObjPtr(), precision);
157 std::uint64_t precision() const noexcept
159 return bt_clock_class_get_precision(this->libObjPtr());
162 void originIsUnixEpoch(const bool originIsUnixEpoch) const noexcept
164 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
166 bt_clock_class_set_origin_is_unix_epoch(this->libObjPtr(),
167 static_cast<bt_bool>(originIsUnixEpoch));
170 bool originIsUnixEpoch() const noexcept
172 return static_cast<bool>(bt_clock_class_origin_is_unix_epoch(this->libObjPtr()));
175 void name(const char * const name) const
177 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
179 const auto status = bt_clock_class_set_name(this->libObjPtr(), name);
181 if (status == BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
182 throw MemoryError {};
186 void name(const std::string& name) const
188 this->name(name.data());
191 const char *name() const noexcept
193 return bt_clock_class_get_name(this->libObjPtr());
196 void description(const char * const description) const
198 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
200 const auto status = bt_clock_class_set_description(this->libObjPtr(), description);
202 if (status == BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR) {
203 throw MemoryError {};
207 void description(const std::string& description) const
209 this->description(description.data());
212 const char *description() const noexcept
214 return bt_clock_class_get_description(this->libObjPtr());
217 void uuid(const std::uint8_t * const uuid) const noexcept
219 bt_clock_class_set_uuid(this->libObjPtr(), uuid);
222 nonstd::optional<bt2_common::UuidView> uuid() const noexcept
224 const auto uuid = bt_clock_class_get_uuid(this->libObjPtr());
227 return bt2_common::UuidView {uuid};
230 return nonstd::nullopt;
233 template <typename LibValT>
234 void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
236 static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
238 bt_clock_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
241 UserAttributes userAttributes() const noexcept
243 return UserAttributes {
244 internal::CommonClockClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
247 std::int64_t cyclesToNsFromOrigin(const std::uint64_t value) const
249 std::int64_t nsFromOrigin;
251 bt_clock_class_cycles_to_ns_from_origin(this->libObjPtr(), value, &nsFromOrigin);
253 if (status == BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR) {
254 throw OverflowError {};
260 Shared shared() const noexcept
262 return Shared::createWithRef(*this);
266 using ClockClass = CommonClockClass<bt_clock_class>;
267 using ConstClockClass = CommonClockClass<const bt_clock_class>;
271 struct ClockClassTypeDescr
273 using Const = ConstClockClass;
274 using NonConst = ClockClass;
278 struct TypeDescr<ClockClass> : public ClockClassTypeDescr
283 struct TypeDescr<ConstClockClass> : public ClockClassTypeDescr
287 } /* namespace internal */
288 } /* namespace bt2 */
290 #endif /* BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP */