src/cpp-common/bt2/clock-class.hpp

   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
  10 #include <cstdint>
  11 #include <type_traits>
  12
  13 #include <babeltrace2/babeltrace.h>
  14
  15 #include "cpp-common/bt2c/c-string-view.hpp"
  16 #include "cpp-common/bt2c/uuid.hpp"
  17 #include "cpp-common/bt2s/optional.hpp"
  18
  19 #include "borrowed-object.hpp"
  20 #include "exc.hpp"
  21 #include "internal/utils.hpp"
  22 #include "shared-object.hpp"
  23 #include "value.hpp"
  24
  25 namespace bt2 {
  26 namespace internal {
  27
  28 struct ClockClassRefFuncs final
  29 {
  30     static void get(const bt_clock_class * const libObjPtr) noexcept
  31     {
  32         bt_clock_class_get_ref(libObjPtr);
  33     }
  34
  35     static void put(const bt_clock_class * const libObjPtr) noexcept
  36     {
  37         bt_clock_class_put_ref(libObjPtr);
  38     }
  39 };
  40
  41 template <typename LibObjT>
  42 struct CommonClockClassSpec;
  43
  44 /* Functions specific to mutable clock classes */
  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
  54 /* Functions specific to constant clock classes */
  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
  64 } /* namespace internal */
  65
  66 class ClockOffset final
  67 {
  68 public:
  69     explicit ClockOffset(const std::int64_t seconds, const std::uint64_t cycles) :
  70         _mSeconds {seconds}, _mCycles {cycles}
  71     {
  72     }
  73
  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>
  90 class CommonClockClass final : public BorrowedObject<LibObjT>
  91 {
  92 private:
  93     using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
  94
  95 public:
  96     using typename BorrowedObject<LibObjT>::LibObjPtr;
  97     using Shared = SharedObject<CommonClockClass, LibObjT, internal::ClockClassRefFuncs>;
  98     using UserAttributes = internal::DepUserAttrs<LibObjT>;
  99
 100     explicit CommonClockClass(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
 101     {
 102     }
 103
 104     template <typename OtherLibObjT>
 105     CommonClockClass(const CommonClockClass<OtherLibObjT> clkClass) noexcept :
 106         _ThisBorrowedObject {clkClass}
 107     {
 108     }
 109
 110     template <typename OtherLibObjT>
 111     CommonClockClass& operator=(const CommonClockClass<OtherLibObjT> clkClass) noexcept
 112     {
 113         _ThisBorrowedObject::operator=(clkClass);
 114         return *this;
 115     }
 116
 117     CommonClockClass<const bt_clock_class> asConst() const noexcept
 118     {
 119         return CommonClockClass<const bt_clock_class> {*this};
 120     }
 121
 122     void frequency(const std::uint64_t frequency) const noexcept
 123     {
 124         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 125
 126         bt_clock_class_set_frequency(this->libObjPtr(), frequency);
 127     }
 128
 129     std::uint64_t frequency() const noexcept
 130     {
 131         return bt_clock_class_get_frequency(this->libObjPtr());
 132     }
 133
 134     void offsetFromOrigin(const ClockOffset& offsetFromOrigin) const noexcept
 135     {
 136         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 137
 138         bt_clock_class_set_offset(this->libObjPtr(), offsetFromOrigin.seconds(),
 139                                   offsetFromOrigin.cycles());
 140     }
 141
 142     ClockOffset offsetFromOrigin() const noexcept
 143     {
 144         std::int64_t seconds;
 145         std::uint64_t cycles;
 146
 147         bt_clock_class_get_offset(this->libObjPtr(), &seconds, &cycles);
 148         return ClockOffset {seconds, cycles};
 149     }
 150
 151     void precision(const std::uint64_t precision) const noexcept
 152     {
 153         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 154
 155         bt_clock_class_set_precision(this->libObjPtr(), precision);
 156     }
 157
 158     std::uint64_t precision() const noexcept
 159     {
 160         return bt_clock_class_get_precision(this->libObjPtr());
 161     }
 162
 163     void originIsUnixEpoch(const bool originIsUnixEpoch) const noexcept
 164     {
 165         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 166
 167         bt_clock_class_set_origin_is_unix_epoch(this->libObjPtr(),
 168                                                 static_cast<bt_bool>(originIsUnixEpoch));
 169     }
 170
 171     bool originIsUnixEpoch() const noexcept
 172     {
 173         return static_cast<bool>(bt_clock_class_origin_is_unix_epoch(this->libObjPtr()));
 174     }
 175
 176     void name(const bt2c::CStringView name) const
 177     {
 178         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 179
 180         const auto status = bt_clock_class_set_name(this->libObjPtr(), name);
 181
 182         if (status == BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR) {
 183             throw MemoryError {};
 184         }
 185     }
 186
 187     bt2c::CStringView name() const noexcept
 188     {
 189         return bt_clock_class_get_name(this->libObjPtr());
 190     }
 191
 192     void description(const bt2c::CStringView description) const
 193     {
 194         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 195
 196         const auto status = bt_clock_class_set_description(this->libObjPtr(), description);
 197
 198         if (status == BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR) {
 199             throw MemoryError {};
 200         }
 201     }
 202
 203     bt2c::CStringView description() const noexcept
 204     {
 205         return bt_clock_class_get_description(this->libObjPtr());
 206     }
 207
 208     void uuid(const std::uint8_t * const uuid) const noexcept
 209     {
 210         bt_clock_class_set_uuid(this->libObjPtr(), uuid);
 211     }
 212
 213     bt2s::optional<bt2c::UuidView> uuid() const noexcept
 214     {
 215         const auto uuid = bt_clock_class_get_uuid(this->libObjPtr());
 216
 217         if (uuid) {
 218             return bt2c::UuidView {uuid};
 219         }
 220
 221         return bt2s::nullopt;
 222     }
 223
 224     template <typename LibValT>
 225     void userAttributes(const CommonMapValue<LibValT> userAttrs) const noexcept
 226     {
 227         static_assert(!std::is_const<LibObjT>::value, "Not available with `bt2::ConstClockClass`.");
 228
 229         bt_clock_class_set_user_attributes(this->libObjPtr(), userAttrs.libObjPtr());
 230     }
 231
 232     UserAttributes userAttributes() const noexcept
 233     {
 234         return UserAttributes {
 235             internal::CommonClockClassSpec<LibObjT>::userAttributes(this->libObjPtr())};
 236     }
 237
 238     std::int64_t cyclesToNsFromOrigin(const std::uint64_t value) const
 239     {
 240         std::int64_t nsFromOrigin;
 241         const auto status =
 242             bt_clock_class_cycles_to_ns_from_origin(this->libObjPtr(), value, &nsFromOrigin);
 243
 244         if (status == BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR) {
 245             throw OverflowError {};
 246         }
 247
 248         return nsFromOrigin;
 249     }
 250
 251     Shared shared() const noexcept
 252     {
 253         return Shared::createWithRef(*this);
 254     }
 255 };
 256
 257 using ClockClass = CommonClockClass<bt_clock_class>;
 258 using ConstClockClass = CommonClockClass<const bt_clock_class>;
 259
 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 */
 279 } /* namespace bt2 */
 280
 281 #endif /* BABELTRACE_CPP_COMMON_BT2_CLOCK_CLASS_HPP */