2 * Copyright (C) 2022 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
11 #include <common/format.hpp>
13 #include <vendor/optional.hpp>
18 #include <type_traits>
28 enum class byte_order {
33 class field_location {
39 EVENT_RECORD_COMMON_CONTEXT,
40 EVENT_RECORD_SPECIFIC_CONTEXT,
44 using elements = std::vector<std::string>;
46 field_location(root lookup_root, elements elements);
47 bool operator==(const field_location& other) const noexcept;
50 const elements elements_;
54 * Field, and the various field types, represents fields as exposed by the
55 * LTTng tracers. These classes do not attempt to describe the complete spectrum of the CTF
61 using cuptr = std::unique_ptr<const type>;
63 static byte_order reverse_byte_order(byte_order byte_order) noexcept;
65 bool operator==(const type& other) const noexcept;
66 bool operator!=(const type& other) const noexcept;
68 virtual void accept(type_visitor& visitor) const = 0;
70 const unsigned int alignment;
73 type(unsigned int alignment);
76 virtual bool _is_equal(const type& rhs) const noexcept = 0;
81 using uptr = std::unique_ptr<field>;
82 using cuptr = std::unique_ptr<const field>;
84 field(std::string name, type::cuptr type);
85 void accept(field_visitor& visitor) const;
86 bool operator==(const field& other) const noexcept;
88 const type& get_type() const;
89 type::cuptr move_type() noexcept;
91 const std::string name;
97 class integer_type : public type {
99 enum class signedness {
112 DEFAULT_CLOCK_TIMESTAMP,
113 /* Packet header field class specific roles. */
114 DATA_STREAM_CLASS_ID,
117 /* Packet context field class specific roles. */
118 DISCARDED_EVENT_RECORD_COUNTER_SNAPSHOT,
119 PACKET_CONTENT_LENGTH,
120 PACKET_END_DEFAULT_CLOCK_TIMESTAMP,
121 PACKET_SEQUENCE_NUMBER,
123 /* Event record field class roles. */
124 EVENT_RECORD_CLASS_ID,
127 using roles = std::vector<role>;
129 integer_type(unsigned int alignment,
130 byte_order byte_order,
132 signedness signedness,
136 virtual void accept(type_visitor& visitor) const override;
138 const enum byte_order byte_order;
139 const unsigned int size;
141 * signedness and base are suffixed with '_' to work-around a bug in older
142 * GCCs (before 6) that do not recognize hidden/shadowed enumeration as valid
143 * nested-name-specifiers.
145 const signedness signedness_;
150 virtual bool _is_equal(const type& other) const noexcept override;
153 class floating_point_type : public type {
155 floating_point_type(unsigned int alignment,
156 byte_order byte_order,
157 unsigned int exponent_digits,
158 unsigned int mantissa_digits);
160 virtual void accept(type_visitor& visitor) const override final;
162 const enum byte_order byte_order;
163 const unsigned int exponent_digits;
164 const unsigned int mantissa_digits;
167 virtual bool _is_equal(const type& other) const noexcept override final;
170 class enumeration_type : public integer_type {
172 enumeration_type(unsigned int alignment,
173 enum byte_order byte_order,
175 enum signedness signedness,
177 integer_type::roles roles = {});
179 virtual void accept(type_visitor& visitor) const = 0;
183 template <class MappingIntegerType>
184 class enumeration_mapping_range {
186 using range_integer_t = MappingIntegerType;
188 enumeration_mapping_range(MappingIntegerType in_begin, MappingIntegerType in_end) :
189 begin{in_begin}, end{in_end}
193 const range_integer_t begin, end;
196 template <class MappingIntegerType>
197 bool operator==(const enumeration_mapping_range<MappingIntegerType>& lhs,
198 const enumeration_mapping_range<MappingIntegerType>& rhs) noexcept
200 return lhs.begin == rhs.begin && lhs.end == rhs.end;
203 template <class MappingIntegerType>
204 class enumeration_mapping {
206 using range_t = enumeration_mapping_range<MappingIntegerType>;
208 enumeration_mapping(const enumeration_mapping<MappingIntegerType>& other) = default;
209 enumeration_mapping(const enumeration_mapping<MappingIntegerType>&& other) :
210 name{std::move(other.name)}, range{other.range}
214 /* Mapping with an implicit value. */
215 enumeration_mapping(std::string in_name) : name{std::move(in_name)}
219 enumeration_mapping(std::string in_name, range_t in_range) : name{std::move(in_name)}, range{in_range}
223 const std::string name;
224 const nonstd::optional<range_t> range;
227 template <class MappingIntegerType>
228 bool operator==(const enumeration_mapping<MappingIntegerType>& lhs,
229 const enumeration_mapping<MappingIntegerType>& rhs) noexcept
231 return lhs.name == rhs.name && lhs.range == rhs.range;
233 } /* namespace details */
235 template <class MappingIntegerType>
236 class typed_enumeration_type : public enumeration_type {
238 using mapping = details::enumeration_mapping<MappingIntegerType>;
239 using mappings = std::vector<mapping>;
241 static_assert(std::is_integral<MappingIntegerType>::value &&
242 sizeof(MappingIntegerType) == 8,
243 "MappingIntegerType must be either int64_t or uint64_t");
245 typed_enumeration_type(unsigned int in_alignment,
246 enum byte_order in_byte_order,
247 unsigned int in_size,
249 const std::shared_ptr<const mappings>& in_mappings,
250 integer_type::roles in_roles = {}) :
251 enumeration_type(in_alignment,
254 std::is_signed<MappingIntegerType>::value ?
255 integer_type::signedness::SIGNED :
256 integer_type::signedness::UNSIGNED,
258 std::move(in_roles)),
259 _mappings{std::move(in_mappings)}
263 virtual void accept(type_visitor& visitor) const override final;
265 const std::shared_ptr<const mappings> _mappings;
268 virtual bool _is_equal(const type& base_other) const noexcept override final
270 const auto& other = static_cast<const typed_enumeration_type<MappingIntegerType>&>(
273 return integer_type::_is_equal(base_other) && *this->_mappings == *other._mappings;
277 /* Aliases for all allowed enumeration mapping types. */
278 using signed_enumeration_type = typed_enumeration_type<int64_t>;
279 using unsigned_enumeration_type = typed_enumeration_type<uint64_t>;
281 class array_type : public type {
283 array_type(unsigned int alignment, type::cuptr element_type);
285 const type::cuptr element_type;
288 virtual bool _is_equal(const type& base_other) const noexcept override;
291 class static_length_array_type : public array_type {
293 static_length_array_type(unsigned int alignment,
294 type::cuptr element_type,
297 virtual void accept(type_visitor& visitor) const override final;
299 const uint64_t length;
302 virtual bool _is_equal(const type& base_other) const noexcept override final;
305 class dynamic_length_array_type : public array_type {
307 dynamic_length_array_type(unsigned int alignment,
308 type::cuptr element_type,
309 field_location length_field_location);
311 virtual void accept(type_visitor& visitor) const override final;
313 const field_location length_field_location;
316 virtual bool _is_equal(const type& base_other) const noexcept override final;
319 class static_length_blob_type : public type {
322 /* Packet header field class specific role. */
326 using roles = std::vector<role>;
328 static_length_blob_type(unsigned int alignment, uint64_t in_length_bytes, roles roles = {});
330 virtual void accept(type_visitor& visitor) const override final;
332 const uint64_t length_bytes;
336 virtual bool _is_equal(const type& base_other) const noexcept override final;
339 class dynamic_length_blob_type : public type {
341 dynamic_length_blob_type(unsigned int alignment, field_location length_field_location);
343 virtual void accept(type_visitor& visitor) const override final;
345 const field_location length_field_location;
348 virtual bool _is_equal(const type& base_other) const noexcept override final;
351 class string_type : public type {
353 enum class encoding {
358 string_type(unsigned int alignment, enum encoding encoding);
361 * encoding is suffixed with '_' to work-around a bug in older
362 * GCCs (before 6) that do not recognize hidden/shadowed enumeration as valid
363 * nested-name-specifiers.
365 const encoding encoding_;
368 virtual bool _is_equal(const type& base_other) const noexcept override;
371 class static_length_string_type : public string_type {
373 static_length_string_type(
374 unsigned int alignment, enum encoding in_encoding, uint64_t length);
375 virtual void accept(type_visitor& visitor) const override final;
377 const uint64_t length;
380 virtual bool _is_equal(const type& base_other) const noexcept override final;
383 class dynamic_length_string_type : public string_type {
385 dynamic_length_string_type(unsigned int alignment,
386 enum encoding in_encoding,
387 field_location length_field_location);
388 virtual void accept(type_visitor& visitor) const override final;
390 const field_location length_field_location;
393 virtual bool _is_equal(const type& base_other) const noexcept override final;
396 class null_terminated_string_type : public string_type {
398 null_terminated_string_type(unsigned int alignment, enum encoding in_encoding);
399 virtual void accept(type_visitor& visitor) const override final;
402 class structure_type : public type {
404 using fields = std::vector<field::cuptr>;
406 structure_type(unsigned int alignment, fields in_fields);
408 virtual void accept(type_visitor& visitor) const override final;
410 const fields _fields;
413 virtual bool _is_equal(const type& base_other) const noexcept override final;
416 template <class MappingIntegerType>
417 class variant_type : public type {
418 static_assert(std::is_same<MappingIntegerType,
419 unsigned_enumeration_type::mapping::range_t::
420 range_integer_t>::value ||
421 std::is_same<MappingIntegerType,
422 signed_enumeration_type::mapping::range_t::
423 range_integer_t>::value,
424 "Variant mapping integer type must be one of those allowed by typed_enumeration_type");
427 using choice = std::pair<const details::enumeration_mapping<MappingIntegerType>, type::cuptr>;
428 using choices = std::vector<choice>;
430 variant_type(unsigned int in_alignment,
431 field_location in_selector_field_location,
432 choices in_choices) :
434 selector_field_location{std::move(in_selector_field_location)},
435 _choices{std::move(in_choices)}
439 virtual void accept(type_visitor& visitor) const override final;
441 const field_location selector_field_location;
442 const choices _choices;
445 static bool _choices_are_equal(const choices& a, const choices& b)
447 if (a.size() != b.size()) {
453 return std::equal(a.cbegin(), a.cend(), b.cbegin(),
454 [](const choice& choice_a, const choice& choice_b) {
455 return choice_a.first == choice_b.first &&
456 *choice_a.second == *choice_b.second;
460 virtual bool _is_equal(const type& base_other) const noexcept override final
462 const auto& other = static_cast<decltype(*this)&>(base_other);
464 return selector_field_location == other.selector_field_location &&
465 _choices_are_equal(_choices, other._choices);
469 class field_visitor {
471 virtual ~field_visitor() = default;
472 virtual void visit(const field& field) = 0;
475 field_visitor() = default;
480 virtual ~type_visitor() = default;
481 virtual void visit(const integer_type& type) = 0;
482 virtual void visit(const floating_point_type& type) = 0;
483 virtual void visit(const signed_enumeration_type& type) = 0;
484 virtual void visit(const unsigned_enumeration_type& type) = 0;
485 virtual void visit(const static_length_array_type& type) = 0;
486 virtual void visit(const dynamic_length_array_type& type) = 0;
487 virtual void visit(const static_length_blob_type& type) = 0;
488 virtual void visit(const dynamic_length_blob_type& type) = 0;
489 virtual void visit(const null_terminated_string_type& type) = 0;
490 virtual void visit(const static_length_string_type& type) = 0;
491 virtual void visit(const dynamic_length_string_type& type) = 0;
492 virtual void visit(const structure_type& type) = 0;
493 virtual void visit(const variant_type<signed_enumeration_type::mapping::range_t::range_integer_t>& type) = 0;
494 virtual void visit(const variant_type<unsigned_enumeration_type::mapping::range_t::range_integer_t>& type) = 0;
497 type_visitor() = default;
500 } /* namespace trace */
501 } /* namespace sessiond */
502 } /* namespace lttng */
505 * Due to a bug in g++ < 7.1, this specialization must be enclosed in the fmt namespace,
506 * see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56480.
510 struct formatter<lttng::sessiond::trace::field_location> : formatter<std::string> {
511 template <typename FormatCtx>
512 typename FormatCtx::iterator format(
513 const lttng::sessiond::trace::field_location& location, FormatCtx& ctx)
515 std::string location_str{"["};
517 switch (location.root_) {
518 case lttng::sessiond::trace::field_location::root::PACKET_HEADER:
519 location_str += "\"packet-header\"";
521 case lttng::sessiond::trace::field_location::root::PACKET_CONTEXT:
522 location_str += "\"packet-context\"";
524 case lttng::sessiond::trace::field_location::root::EVENT_RECORD_HEADER:
525 location_str += "\"event-record-header\"";
527 case lttng::sessiond::trace::field_location::root::EVENT_RECORD_COMMON_CONTEXT:
528 location_str += "\"event-record-common-context\"";
530 case lttng::sessiond::trace::field_location::root::EVENT_RECORD_SPECIFIC_CONTEXT:
531 location_str += "\"event-record-specific-context\"";
533 case lttng::sessiond::trace::field_location::root::EVENT_RECORD_PAYLOAD:
534 location_str += "\"event-record-payload\"";
538 for (const auto &name : location.elements_) {
539 location_str += ", \"" + name + "\"";
543 return format_to(ctx.out(), location_str);
546 } /* namespace fmt */
548 #endif /* LTTNG_FIELD_H */