2 * Copyright (C) 2022 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_TRACE_FORMAT_DESCRIPTOR_INTERNAL_HPP
9 #define LTTNG_TRACE_FORMAT_DESCRIPTOR_INTERNAL_HPP
11 #include <bits/stdint-uintn.h>
12 #include <common/config/session-config.hpp>
13 #include <common/dynamic-array.hpp>
14 #include <common/macros.hpp>
15 #include <common/optional.hpp>
18 #include <lttng/lttng.h>
19 #include <lttng/trace-format-descriptor.h>
22 #include <sys/types.h>
23 #include <unordered_map>
27 struct lttng_payload_view;
30 struct lttng_trace_format_descriptor_comm {
35 class trace_format_descriptor {
37 using uptr = std::unique_ptr<trace_format_descriptor>;
38 using sptr = std::shared_ptr<trace_format_descriptor>;
39 using csptr = std::shared_ptr<const trace_format_descriptor>;
40 explicit trace_format_descriptor(enum lttng_trace_format_descriptor_type type) : _type(type)
44 virtual ~trace_format_descriptor();
45 virtual uptr clone() const = 0; // Virtual constructor (copying)
47 enum lttng_trace_format_descriptor_type type() const
52 virtual lttng_error_code mi_serialize(mi_writer *writer) const final;
53 virtual lttng_error_code config_serialize(config_writer *writer) const final;
54 virtual int serialize(lttng_payload *payload) const;
55 static ssize_t create_from_payload(lttng_payload_view *view, uptr& descriptor);
57 friend bool operator==(
58 trace_format_descriptor const& lhs, trace_format_descriptor const& rhs)
60 if (lhs.type() != rhs.type()) {
63 return lhs.equal_to(rhs);
66 friend bool operator!=(
67 trace_format_descriptor const& lhs, trace_format_descriptor const& rhs)
73 using DeserializerFunction =
74 std::function<ssize_t(lttng_payload_view *view, uptr& descriptor)>;
75 using deserializer_map =
76 std::unordered_map<lttng_trace_format_descriptor_type, DeserializerFunction>;
78 static deserializer_map _deserializer_map;
79 virtual bool equal_to(trace_format_descriptor const& rhs) const = 0;
82 enum lttng_trace_format_descriptor_type _type = LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_UNKNOWN;
84 virtual lttng_error_code subtype_mi_serialize(mi_writer *writer) const = 0;
85 virtual lttng_error_code subtype_config_serialize(config_writer *writer) const = 0;
88 class trace_format_descriptor_ctf1 : public trace_format_descriptor {
90 trace_format_descriptor_ctf1() :
91 trace_format_descriptor(LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_1)
93 } // Default constructor.
95 trace_format_descriptor_ctf1(trace_format_descriptor_ctf1 const&) :
96 trace_format_descriptor_ctf1()
102 return uptr(new trace_format_descriptor_ctf1(*this));
105 uint64_t getMajor() const
109 uint64_t getMinor() const
115 static ssize_t deserialize(lttng_payload_view *view, uptr& descriptor);
116 bool equal_to(trace_format_descriptor const& rhs) const override;
119 lttng_error_code subtype_mi_serialize(mi_writer *writer) const override;
120 lttng_error_code subtype_config_serialize(config_writer *writer) const override;
122 const uint64_t _major = 1;
123 const uint64_t _minor = 8;
126 class trace_format_descriptor_ctf2 : public trace_format_descriptor {
128 trace_format_descriptor_ctf2() :
129 trace_format_descriptor(LTTNG_TRACE_FORMAT_DESCRIPTOR_TYPE_CTF_2)
133 trace_format_descriptor_ctf2(trace_format_descriptor_ctf2 const&) :
134 trace_format_descriptor_ctf2()
136 } // Copy constructor
140 return uptr(new trace_format_descriptor_ctf2(*this));
143 uint64_t getMajor() const
147 uint64_t getMinor() const
153 static ssize_t deserialize(lttng_payload_view *view, uptr& descriptor);
154 bool equal_to(trace_format_descriptor const& rhs) const override;
157 lttng_error_code subtype_mi_serialize(mi_writer *writer) const override;
158 lttng_error_code subtype_config_serialize(config_writer *writer) const override;
159 const uint64_t _major = 2;
160 const uint64_t _minor = 0;
164 #endif /* LTTNG_TRACE_FORMAT_DESCRIPTOR_INTERNAL_HPP */