sessiond: ust: conditionally enable the underscore prefix variant quirk
[lttng-tools.git] / src / bin / lttng-sessiond / field.hpp
index dec5b103222008200b7adbcb8a019fa2ae3dbd3d..2e3a67bf42f23f39a2b4242a1817096daff92778 100644 (file)
@@ -9,9 +9,11 @@
 #define LTTNG_FIELD_H
 
 #include <common/format.hpp>
+#include <common/make-unique.hpp>
 
 #include <vendor/optional.hpp>
 
+#include <algorithm>
 #include <memory>
 #include <string>
 #include <type_traits>
@@ -64,6 +66,10 @@ public:
        bool operator==(const type& other) const noexcept;
        bool operator!=(const type& other) const noexcept;
        virtual ~type();
+
+       /* Obtain an independent copy of `type`. */
+       virtual type::cuptr copy() const = 0;
+
        virtual void accept(type_visitor& visitor) const = 0;
 
        const unsigned int alignment;
@@ -77,14 +83,20 @@ private:
 
 class field {
 public:
+       using uptr = std::unique_ptr<field>;
        using cuptr = std::unique_ptr<const field>;
 
        field(std::string name, type::cuptr type);
        void accept(field_visitor& visitor) const;
        bool operator==(const field& other) const noexcept;
 
+       const type& get_type() const;
+       type::cuptr move_type() noexcept;
+
        const std::string name;
-       const type::cuptr _type;
+
+private:
+       type::cuptr _type;
 };
 
 class integer_type : public type {
@@ -126,6 +138,8 @@ public:
                        base base,
                        roles roles = {});
 
+       virtual type::cuptr copy() const override;
+
        virtual void accept(type_visitor& visitor) const override;
 
        const enum byte_order byte_order;
@@ -150,6 +164,8 @@ public:
                        unsigned int exponent_digits,
                        unsigned int mantissa_digits);
 
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const enum byte_order byte_order;
@@ -198,14 +214,13 @@ class enumeration_mapping {
 public:
        using range_t = enumeration_mapping_range<MappingIntegerType>;
 
-       enumeration_mapping(const enumeration_mapping<MappingIntegerType>& other) = delete;
+       enumeration_mapping(const enumeration_mapping<MappingIntegerType>& other) = default;
        enumeration_mapping(const enumeration_mapping<MappingIntegerType>&& other) :
                name{std::move(other.name)}, range{other.range}
        {
        }
 
-       /* Mapping with an implicit value. */
-       enumeration_mapping(std::string in_name) : name{std::move(in_name)}
+       enumeration_mapping(std::string in_name, MappingIntegerType value) : name{std::move(in_name)}, range{value, value}
        {
        }
 
@@ -214,7 +229,12 @@ public:
        }
 
        const std::string name;
-       const nonstd::optional<range_t> range;
+       /*
+        * Only one range per mapping is supported for the moment as
+        * the tracers (and CTF 1.8) can't express multiple ranges per
+        * mapping, which is allowed by CTF 2.
+        */
+       const range_t range;
 };
 
 template <class MappingIntegerType>
@@ -225,7 +245,7 @@ bool operator==(const enumeration_mapping<MappingIntegerType>& lhs,
 }
 } /* namespace details */
 
-template <class MappingIntegerType>
+template <typename MappingIntegerType>
 class typed_enumeration_type : public enumeration_type {
 public:
        using mapping = details::enumeration_mapping<MappingIntegerType>;
@@ -249,13 +269,19 @@ public:
                                                      integer_type::signedness::UNSIGNED,
                                in_base,
                                std::move(in_roles)),
-               _mappings{std::move(in_mappings)}
+               mappings_{std::move(in_mappings)}
+       {
+       }
+
+       virtual type::cuptr copy() const override
        {
+               return lttng::make_unique<typed_enumeration_type<MappingIntegerType>>(
+                               alignment, byte_order, size, base_, mappings_, roles_);
        }
 
        virtual void accept(type_visitor& visitor) const override final;
 
-       const std::shared_ptr<const mappings> _mappings;
+       const std::shared_ptr<const mappings> mappings_;
 
 private:
        virtual bool _is_equal(const type& base_other) const noexcept override final
@@ -263,7 +289,7 @@ private:
                const auto& other = static_cast<const typed_enumeration_type<MappingIntegerType>&>(
                                base_other);
 
-               return integer_type::_is_equal(base_other) && *this->_mappings == *other._mappings;
+               return integer_type::_is_equal(base_other) && *this->mappings_ == *other.mappings_;
        }
 };
 
@@ -287,6 +313,8 @@ public:
                        type::cuptr element_type,
                        uint64_t in_length);
 
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const uint64_t length;
@@ -301,6 +329,8 @@ public:
                        type::cuptr element_type,
                        field_location length_field_location);
 
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const field_location length_field_location;
@@ -313,13 +343,15 @@ class static_length_blob_type : public type {
 public:
        enum class role {
                /* Packet header field class specific role. */
-               TRACE_CLASS_UUID,
+               METADATA_STREAM_UUID,
        };
 
        using roles = std::vector<role>;
 
        static_length_blob_type(unsigned int alignment, uint64_t in_length_bytes, roles roles = {});
 
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const uint64_t length_bytes;
@@ -333,6 +365,8 @@ class dynamic_length_blob_type : public type {
 public:
        dynamic_length_blob_type(unsigned int alignment, field_location length_field_location);
 
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const field_location length_field_location;
@@ -365,6 +399,9 @@ class static_length_string_type : public string_type {
 public:
        static_length_string_type(
                        unsigned int alignment, enum encoding in_encoding, uint64_t length);
+
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const uint64_t length;
@@ -378,6 +415,9 @@ public:
        dynamic_length_string_type(unsigned int alignment,
                        enum encoding in_encoding,
                        field_location length_field_location);
+
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
        const field_location length_field_location;
@@ -389,6 +429,9 @@ private:
 class null_terminated_string_type : public string_type {
 public:
        null_terminated_string_type(unsigned int alignment, enum encoding in_encoding);
+
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 };
 
@@ -398,30 +441,81 @@ public:
 
        structure_type(unsigned int alignment, fields in_fields);
 
+       virtual type::cuptr copy() const override final;
+
        virtual void accept(type_visitor& visitor) const override final;
 
-       const fields _fields;
+       const fields fields_;
 
 private:
        virtual bool _is_equal(const type& base_other) const noexcept override final;
 };
 
+template <typename MappingIntegerType>
 class variant_type : public type {
+       static_assert(std::is_same<MappingIntegerType,
+                                       unsigned_enumeration_type::mapping::range_t::
+                                                       range_integer_t>::value ||
+                                       std::is_same<MappingIntegerType,
+                                                       signed_enumeration_type::mapping::range_t::
+                                                                       range_integer_t>::value,
+                       "Variant mapping integer type must be one of those allowed by typed_enumeration_type");
+
 public:
-       using choices = std::vector<field::cuptr>;
+       using choice = std::pair<const details::enumeration_mapping<MappingIntegerType>, type::cuptr>;
+       using choices = std::vector<choice>;
+
+       variant_type(unsigned int in_alignment,
+                       field_location in_selector_field_location,
+                       choices in_choices) :
+               type(in_alignment),
+               selector_field_location{std::move(in_selector_field_location)},
+               choices_{std::move(in_choices)}
+       {
+       }
+
+       virtual type::cuptr copy() const override final
+       {
+               choices copy_of_choices;
+
+               copy_of_choices.reserve(choices_.size());
+               for (const auto& current_choice : choices_) {
+                       copy_of_choices.emplace_back(
+                                       current_choice.first, current_choice.second->copy());
+               }
 
-       variant_type(unsigned int alignment,
-                       field_location selector_field_location,
-                       choices in_choices);
+               return lttng::make_unique<variant_type<MappingIntegerType>>(
+                       alignment, selector_field_location, std::move(copy_of_choices));
+       }
 
        virtual void accept(type_visitor& visitor) const override final;
 
        const field_location selector_field_location;
-       const choices _choices;
-;
+       const choices choices_;
 
 private:
-       virtual bool _is_equal(const type& base_other) const noexcept override final;
+       static bool _choices_are_equal(const choices& a, const choices& b)
+       {
+               if (a.size() != b.size()) {
+                       return false;
+               }
+
+               return true;
+
+               return std::equal(a.cbegin(), a.cend(), b.cbegin(),
+                               [](const choice& choice_a, const choice& choice_b) {
+                                       return choice_a.first == choice_b.first &&
+                                               *choice_a.second == *choice_b.second;
+                               });
+       }
+
+       virtual bool _is_equal(const type& base_other) const noexcept override final
+       {
+               const auto& other = static_cast<decltype(*this)&>(base_other);
+
+               return selector_field_location == other.selector_field_location &&
+                               _choices_are_equal(choices_, other.choices_);
+       }
 };
 
 class field_visitor {
@@ -448,7 +542,8 @@ public:
        virtual void visit(const static_length_string_type& type) = 0;
        virtual void visit(const dynamic_length_string_type& type) = 0;
        virtual void visit(const structure_type& type) = 0;
-       virtual void visit(const variant_type& type) = 0;
+       virtual void visit(const variant_type<signed_enumeration_type::mapping::range_t::range_integer_t>& type) = 0;
+       virtual void visit(const variant_type<unsigned_enumeration_type::mapping::range_t::range_integer_t>& type) = 0;
 
 protected:
        type_visitor() = default;
@@ -459,6 +554,8 @@ protected:
 } /* namespace lttng */
 
 /*
+ * Field formatters for libfmt.
+ *
  * Due to a bug in g++ < 7.1, this specialization must be enclosed in the fmt namespace,
  * see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56480.
  */
@@ -500,6 +597,52 @@ struct formatter<lttng::sessiond::trace::field_location> : formatter<std::string
                return format_to(ctx.out(), location_str);
        }
 };
+
+namespace details {
+template <typename MappingIntegerType>
+::std::string format_mapping_range(typename lttng::sessiond::trace::typed_enumeration_type<
+               MappingIntegerType>::mapping::range_t range)
+{
+       if (range.begin == range.end) {
+               return ::fmt::format("[{}]", range.begin);
+       } else {
+               return ::fmt::format("[{}, {}]", range.begin, range.end);
+       }
+}
+} /* namespace details */
+
+template <>
+struct formatter<typename lttng::sessiond::trace::signed_enumeration_type::mapping::range_t>
+       : formatter<std::string> {
+       template <typename FormatCtx>
+       typename FormatCtx::iterator
+       format(typename lttng::sessiond::trace::signed_enumeration_type::mapping::range_t range,
+                       FormatCtx& ctx)
+       {
+               return format_to(ctx.out(),
+                               details::format_mapping_range<
+                                               lttng::sessiond::trace::signed_enumeration_type::
+                                                               mapping::range_t::range_integer_t>(
+                                               range));
+       }
+};
+
+template <>
+struct formatter<typename lttng::sessiond::trace::unsigned_enumeration_type::mapping::range_t>
+       : formatter<std::string> {
+       template <typename FormatCtx>
+       typename FormatCtx::iterator
+       format(typename lttng::sessiond::trace::unsigned_enumeration_type::mapping::range_t range,
+                       FormatCtx& ctx)
+       {
+               return format_to(ctx.out(),
+                               details::format_mapping_range<
+                                               lttng::sessiond::trace::unsigned_enumeration_type::
+                                                               mapping::range_t::range_integer_t>(
+                                               range));
+       }
+};
+
 } /* namespace fmt */
 
 #endif /* LTTNG_FIELD_H */
This page took 0.028859 seconds and 4 git commands to generate.