2 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2022 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
9 #ifndef LTTNG_UST_REGISTRY_H
10 #define LTTNG_UST_REGISTRY_H
12 #include "event-class.hpp"
14 #include "lttng-ust-ctl.hpp"
15 #include "session.hpp"
16 #include "stream-class.hpp"
17 #include "trace-class.hpp"
18 #include "ust-clock-class.hpp"
19 #include "ust-registry-channel.hpp"
20 #include "ust-registry-event.hpp"
21 #include "ust-registry-session.hpp"
23 #include <common/format.hpp>
24 #include <common/hashtable/hashtable.hpp>
25 #include <common/locked-reference.hpp>
26 #include <common/urcu.hpp>
27 #include <common/uuid.hpp>
29 #include <lttng/domain.h>
36 #include <type_traits>
38 #define CTF_SPEC_MAJOR 1
39 #define CTF_SPEC_MINOR 8
48 template <class MappingIntegerType>
49 typename trace::typed_enumeration_type<MappingIntegerType>::mapping mapping_from_ust_ctl_entry(
50 const lttng_ust_ctl_enum_entry& entry)
52 if (entry.u.extra.options & LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO) {
53 return {entry.string};
57 {(MappingIntegerType) entry.start.value,
58 (MappingIntegerType) entry.end.value}};
62 template <class MappingIntegerType>
63 typename trace::typed_enumeration_type<MappingIntegerType>::mappings mappings_from_ust_ctl_entries(
64 const lttng_ust_ctl_enum_entry *in_entries, size_t in_entry_count)
66 typename trace::typed_enumeration_type<MappingIntegerType>::mappings mappings;
68 for (size_t entry_idx = 0; entry_idx < in_entry_count; entry_idx++) {
69 const auto& entry = in_entries[entry_idx];
71 mappings.emplace_back(mapping_from_ust_ctl_entry<MappingIntegerType>(entry));
76 } /* namespace details */
80 using const_rcu_protected_reference = lttng::locked_reference<const registry_enum, lttng::urcu::unique_read_lock>;
82 registry_enum(std::string name, enum lttng::sessiond::trace::integer_type::signedness signedness);
83 virtual ~registry_enum() = default;
86 enum lttng::sessiond::trace::integer_type::signedness signedness;
87 /* enum id in session */
89 /* Enumeration node in session hash table. */
90 struct lttng_ht_node_str node;
91 /* For delayed reclaim. */
92 struct rcu_head rcu_head;
94 friend bool operator==(const registry_enum& lhs, const registry_enum& rhs) noexcept;
96 virtual bool _is_equal(const registry_enum& other) const noexcept = 0;
99 bool operator==(const registry_enum& lhs, const registry_enum& rhs) noexcept;
101 template <class MappingIntegerType>
102 class registry_typed_enum : public registry_enum {
104 registry_typed_enum(const char *in_name,
105 const lttng_ust_ctl_enum_entry *entries,
106 size_t entry_count) :
107 registry_enum(in_name,
108 std::is_signed<MappingIntegerType>::value ?
109 lttng::sessiond::trace::integer_type::signedness::SIGNED :
110 lttng::sessiond::trace::integer_type::signedness::UNSIGNED),
111 _mappings{std::make_shared<
112 typename trace::typed_enumeration_type<MappingIntegerType>::mappings>(
113 details::mappings_from_ust_ctl_entries<MappingIntegerType>(
114 entries, entry_count))}
118 const typename std::shared_ptr<const typename lttng::sessiond::trace::typed_enumeration_type<
119 MappingIntegerType>::mappings>
123 virtual bool _is_equal(const registry_enum& base_other) const noexcept
125 const auto &other = static_cast<decltype(*this)&>(base_other);
127 /* Don't compare IDs as some comparisons are performed before an id is assigned. */
128 return this->name == other.name && *this->_mappings == *other._mappings;
132 using registry_signed_enum = registry_typed_enum<int64_t>;
133 using registry_unsigned_enum = registry_typed_enum<uint64_t>;
135 } /* namespace ust */
136 } /* namespace sessiond */
137 } /* namespace lttng */
139 #ifdef HAVE_LIBLTTNG_UST_CTL
142 * Create per-uid registry with default values.
144 * Return new instance on success, nullptr on error.
146 lttng::sessiond::ust::registry_session *ust_registry_session_per_uid_create(
147 const lttng::sessiond::trace::abi& abi,
150 const char *root_shm_path,
151 const char *shm_path,
158 * Create per-pid registry with default values.
160 * Return new instance on success, nullptr on error.
162 lttng::sessiond::ust::registry_session *ust_registry_session_per_pid_create(struct ust_app *app,
163 const lttng::sessiond::trace::abi& abi,
166 const char *root_shm_path,
167 const char *shm_path,
170 uint64_t tracing_id);
171 void ust_registry_session_destroy(lttng::sessiond::ust::registry_session *session);
173 void ust_registry_channel_destroy_event(lttng::sessiond::ust::registry_channel *chan,
174 lttng::sessiond::ust::registry_event *event);
176 int ust_registry_create_or_find_enum(lttng::sessiond::ust::registry_session *session,
177 int session_objd, char *name,
178 struct lttng_ust_ctl_enum_entry *entries, size_t nr_entries,
180 lttng::sessiond::ust::registry_enum::const_rcu_protected_reference
181 ust_registry_lookup_enum_by_id(const lttng::sessiond::ust::registry_session *session,
182 const char *name, uint64_t id);
183 void ust_registry_destroy_enum(lttng::sessiond::ust::registry_session *reg_session,
184 lttng::sessiond::ust::registry_enum *reg_enum);
185 #else /* HAVE_LIBLTTNG_UST_CTL */
188 lttng::sessiond::ust::registry_session *ust_registry_session_per_uid_create(
189 uint32_t bits_per_long __attribute__((unused)),
190 uint32_t uint8_t_alignment __attribute__((unused)),
191 uint32_t uint16_t_alignment __attribute__((unused)),
192 uint32_t uint32_t_alignment __attribute__((unused)),
193 uint32_t uint64_t_alignment __attribute__((unused)),
194 uint32_t long_alignment __attribute__((unused)),
195 int byte_order __attribute__((unused)),
196 uint32_t major __attribute__((unused)),
197 uint32_t minor __attribute__((unused)),
198 const char *root_shm_path __attribute__((unused)),
199 const char *shm_path __attribute__((unused)),
200 uid_t euid __attribute__((unused)),
201 gid_t egid __attribute__((unused)),
202 uint64_t tracing_id __attribute__((unused)),
203 uid_t tracing_uid __attribute__((unused)))
209 lttng::sessiond::ust::registry_session *ust_registry_session_per_pid_create(
210 struct ust_app *app __attribute__((unused)),
211 uint32_t bits_per_long __attribute__((unused)),
212 uint32_t uint8_t_alignment __attribute__((unused)),
213 uint32_t uint16_t_alignment __attribute__((unused)),
214 uint32_t uint32_t_alignment __attribute__((unused)),
215 uint32_t uint64_t_alignment __attribute__((unused)),
216 uint32_t long_alignment __attribute__((unused)),
217 int byte_order __attribute__((unused)),
218 uint32_t major __attribute__((unused)),
219 uint32_t minor __attribute__((unused)),
220 const char *root_shm_path __attribute__((unused)),
221 const char *shm_path __attribute__((unused)),
222 uid_t euid __attribute__((unused)),
223 gid_t egid __attribute__((unused)),
224 uint64_t tracing_id __attribute__((unused)))
230 void ust_registry_session_destroy(
231 lttng::sessiond::ust::registry_session *session __attribute__((unused)))
235 void ust_registry_destroy_event(
236 lttng::sessiond::ust::registry_channel *chan __attribute__((unused)),
237 lttng::sessiond::ust::registry_event *event __attribute__((unused)))
240 /* The app object can be NULL for registry shared across applications. */
242 int ust_metadata_session_statedump(
243 lttng::sessiond::ust::registry_session *session __attribute__((unused)))
249 int ust_metadata_channel_statedump(
250 lttng::sessiond::ust::registry_session *session __attribute__((unused)),
251 lttng::sessiond::ust::registry_channel *chan __attribute__((unused)))
257 int ust_metadata_event_statedump(
258 lttng::sessiond::ust::registry_session *session __attribute__((unused)),
259 lttng::sessiond::ust::registry_channel *chan __attribute__((unused)),
260 lttng::sessiond::ust::registry_event *event __attribute__((unused)))
266 int ust_registry_create_or_find_enum(
267 lttng::sessiond::ust::registry_session *session __attribute__((unused)),
268 int session_objd __attribute__((unused)),
269 char *name __attribute__((unused)),
270 struct lttng_ust_ctl_enum_entry *entries __attribute__((unused)),
271 size_t nr_entries __attribute__((unused)),
272 uint64_t *enum_id __attribute__((unused)))
278 struct ust_registry_enum *
279 ust_registry_lookup_enum_by_id(
280 const lttng::sessiond::ust::registry_session *session __attribute__((unused)),
281 const char *name __attribute__((unused)),
282 uint64_t id __attribute__((unused)))
288 void ust_registry_destroy_enum(lttng::sessiond::ust::registry_session *reg_session __attribute__((unused)),
289 struct ust_registry_enum *reg_enum __attribute__((unused)))
292 #endif /* HAVE_LIBLTTNG_UST_CTL */
294 #endif /* LTTNG_UST_REGISTRY_H */