Commit | Line | Data |
---|---|---|
aeeb48c6 JG |
1 | /* |
2 | * Copyright (C) 2022 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
3 | * | |
4 | * SPDX-License-Identifier: GPL-2.0-only | |
5 | * | |
6 | */ | |
7 | ||
28ab034a | 8 | #include "ctf2-trace-class-visitor.hpp" |
d7bfb9b0 JG |
9 | #include "field.hpp" |
10 | #include "lttng-sessiond.hpp" | |
11 | #include "notification-thread-commands.hpp" | |
12 | #include "session.hpp" | |
13 | #include "trace-class.hpp" | |
14 | #include "tsdl-trace-class-visitor.hpp" | |
15 | #include "ust-app.hpp" | |
16 | #include "ust-field-convert.hpp" | |
aeeb48c6 JG |
17 | #include "ust-registry.hpp" |
18 | ||
19 | #include <common/compat/directory-handle.hpp> | |
20 | #include <common/error.hpp> | |
21 | #include <common/exception.hpp> | |
d7bfb9b0 | 22 | #include <common/format.hpp> |
97f630d4 | 23 | #include <common/hashtable/utils.hpp> |
17fd219b | 24 | #include <common/macros.hpp> |
d7bfb9b0 | 25 | #include <common/make-unique.hpp> |
17fd219b | 26 | #include <common/pthread-lock.hpp> |
aeeb48c6 | 27 | #include <common/runas.hpp> |
d7bfb9b0 JG |
28 | #include <common/time.hpp> |
29 | #include <common/urcu.hpp> | |
aeeb48c6 JG |
30 | |
31 | #include <fcntl.h> | |
d7bfb9b0 | 32 | #include <functional> |
24ed18f2 | 33 | #include <initializer_list> |
d7bfb9b0 | 34 | #include <mutex> |
aeeb48c6 JG |
35 | #include <sstream> |
36 | #include <string> | |
37 | ||
d7bfb9b0 JG |
38 | namespace ls = lttng::sessiond; |
39 | namespace lst = lttng::sessiond::trace; | |
40 | namespace lsu = lttng::sessiond::ust; | |
41 | ||
42 | namespace { | |
43 | lttng_uuid generate_uuid_or_throw() | |
44 | { | |
45 | lttng_uuid new_uuid; | |
46 | ||
47 | if (lttng_uuid_generate(new_uuid)) { | |
48 | LTTNG_THROW_POSIX("Failed to generate UST uuid", errno); | |
49 | } | |
50 | ||
51 | return new_uuid; | |
52 | } | |
53 | ||
54 | int get_count_order(unsigned int count) | |
55 | { | |
56 | int order; | |
57 | ||
58 | order = lttng_fls(count) - 1; | |
59 | if (count & (count - 1)) { | |
60 | order++; | |
61 | } | |
62 | ||
63 | LTTNG_ASSERT(order >= 0); | |
64 | return order; | |
65 | } | |
66 | ||
67 | void clear_metadata_file(int fd) | |
68 | { | |
69 | const auto lseek_ret = lseek(fd, 0, SEEK_SET); | |
70 | if (lseek_ret < 0) { | |
28ab034a JG |
71 | LTTNG_THROW_POSIX( |
72 | "Failed to seek to the beginning of the metadata file while clearing it", | |
73 | errno); | |
d7bfb9b0 JG |
74 | } |
75 | ||
76 | const auto ret = ftruncate(fd, 0); | |
77 | if (ret < 0) { | |
78 | LTTNG_THROW_POSIX("Failed to truncate the metadata file while clearing it", errno); | |
79 | } | |
80 | } | |
81 | ||
82 | /* | |
83 | * Validate that the id has reached the maximum allowed or not. | |
84 | */ | |
85 | bool is_max_channel_id(uint32_t id) | |
86 | { | |
87 | return id == UINT32_MAX; | |
88 | } | |
89 | ||
90 | void destroy_channel_rcu(struct rcu_head *head) | |
91 | { | |
92 | DIAGNOSTIC_PUSH | |
93 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
94 | lsu::registry_channel *chan = | |
0114db0e | 95 | lttng::utils::container_of(head, &lsu::registry_channel::_rcu_head); |
d7bfb9b0 JG |
96 | DIAGNOSTIC_POP |
97 | ||
98 | delete chan; | |
99 | } | |
100 | ||
101 | /* | |
102 | * Destroy every element of the registry and free the memory. This does NOT | |
103 | * free the registry pointer since it might not have been allocated before so | |
104 | * it's the caller responsability. | |
3691d312 JG |
105 | * |
106 | * Called from ~registry_session(), must not throw. | |
d7bfb9b0 | 107 | */ |
3691d312 | 108 | void destroy_channel(lsu::registry_channel *chan, bool notify) noexcept |
d7bfb9b0 JG |
109 | { |
110 | struct lttng_ht_iter iter; | |
111 | lttng::sessiond::ust::registry_event *event; | |
112 | enum lttng_error_code cmd_ret; | |
113 | ||
114 | LTTNG_ASSERT(chan); | |
115 | ||
116 | if (notify) { | |
117 | cmd_ret = notification_thread_command_remove_channel( | |
28ab034a | 118 | the_notification_thread_handle, chan->_consumer_key, LTTNG_DOMAIN_UST); |
d7bfb9b0 JG |
119 | if (cmd_ret != LTTNG_OK) { |
120 | ERR("Failed to remove channel from notification thread"); | |
121 | } | |
122 | } | |
123 | ||
124 | if (chan->_events) { | |
125 | lttng::urcu::read_lock_guard read_lock_guard; | |
126 | ||
127 | /* Destroy all event associated with this registry. */ | |
128 | DIAGNOSTIC_PUSH | |
129 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
28ab034a | 130 | cds_lfht_for_each_entry (chan->_events->ht, &iter.iter, event, _node) { |
d7bfb9b0 JG |
131 | /* Delete the node from the ht and free it. */ |
132 | ust_registry_channel_destroy_event(chan, event); | |
133 | } | |
134 | DIAGNOSTIC_POP | |
135 | } | |
136 | ||
137 | call_rcu(&chan->_rcu_head, destroy_channel_rcu); | |
138 | } | |
97f630d4 JG |
139 | |
140 | void destroy_enum(lsu::registry_enum *reg_enum) | |
141 | { | |
142 | if (!reg_enum) { | |
143 | return; | |
144 | } | |
145 | ||
146 | delete reg_enum; | |
147 | } | |
148 | ||
149 | void destroy_enum_rcu(struct rcu_head *head) | |
150 | { | |
151 | DIAGNOSTIC_PUSH | |
152 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
153 | lsu::registry_enum *reg_enum = | |
0114db0e | 154 | lttng::utils::container_of(head, &lsu::registry_enum::rcu_head); |
97f630d4 JG |
155 | DIAGNOSTIC_POP |
156 | ||
157 | destroy_enum(reg_enum); | |
158 | } | |
159 | ||
160 | /* | |
161 | * Hash table match function for enumerations in the session. Match is | |
162 | * performed on enumeration name, and confirmed by comparing the enum | |
163 | * entries. | |
164 | */ | |
165 | int ht_match_enum(struct cds_lfht_node *node, const void *_key) | |
166 | { | |
167 | lsu::registry_enum *_enum; | |
168 | const lsu::registry_enum *key; | |
169 | ||
170 | LTTNG_ASSERT(node); | |
171 | LTTNG_ASSERT(_key); | |
172 | ||
173 | DIAGNOSTIC_PUSH | |
174 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
28ab034a | 175 | _enum = caa_container_of(node, lsu::registry_enum, node.node); |
97f630d4 JG |
176 | DIAGNOSTIC_POP |
177 | ||
178 | LTTNG_ASSERT(_enum); | |
179 | key = (lsu::registry_enum *) _key; | |
180 | ||
181 | return *_enum == *key; | |
182 | } | |
183 | ||
184 | /* | |
185 | * Hash table match function for enumerations in the session. Match is | |
186 | * performed by enumeration ID. | |
187 | */ | |
188 | int ht_match_enum_id(struct cds_lfht_node *node, const void *_key) | |
189 | { | |
190 | lsu::registry_enum *_enum; | |
191 | const lsu::registry_enum *key = (lsu::registry_enum *) _key; | |
192 | ||
193 | LTTNG_ASSERT(node); | |
194 | LTTNG_ASSERT(_key); | |
195 | ||
196 | DIAGNOSTIC_PUSH | |
197 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
198 | _enum = caa_container_of(node, lsu::registry_enum, node.node); | |
199 | DIAGNOSTIC_POP | |
200 | ||
201 | LTTNG_ASSERT(_enum); | |
202 | ||
203 | if (_enum->id != key->id) { | |
204 | goto no_match; | |
205 | } | |
206 | ||
207 | /* Match. */ | |
208 | return 1; | |
209 | ||
210 | no_match: | |
211 | return 0; | |
212 | } | |
213 | ||
214 | /* | |
215 | * Hash table hash function for enumerations in the session. The | |
216 | * enumeration name is used for hashing. | |
217 | */ | |
218 | unsigned long ht_hash_enum(void *_key, unsigned long seed) | |
219 | { | |
220 | lsu::registry_enum *key = (lsu::registry_enum *) _key; | |
221 | ||
222 | LTTNG_ASSERT(key); | |
223 | return hash_key_str(key->name.c_str(), seed); | |
224 | } | |
d7bfb9b0 JG |
225 | } /* namespace */ |
226 | ||
b0f2e8db | 227 | void lsu::details::locked_registry_session_release(lsu::registry_session *session) |
d7bfb9b0 JG |
228 | { |
229 | pthread_mutex_unlock(&session->_lock); | |
230 | } | |
231 | ||
b0f2e8db | 232 | lsu::registry_session::registry_session(const struct lst::abi& in_abi, |
28ab034a JG |
233 | uint32_t major, |
234 | uint32_t minor, | |
235 | const char *root_shm_path, | |
236 | const char *shm_path, | |
237 | uid_t euid, | |
238 | gid_t egid, | |
239 | uint64_t tracing_id) : | |
d7bfb9b0 | 240 | lst::trace_class(in_abi, generate_uuid_or_throw()), |
28ab034a JG |
241 | _root_shm_path{ root_shm_path ? root_shm_path : "" }, |
242 | _shm_path{ shm_path ? shm_path : "" }, | |
f9a41357 | 243 | _metadata_path{ _shm_path.size() > 0 ? lttng::format("{}/metadata", _shm_path) : |
28ab034a JG |
244 | std::string("") }, |
245 | _uid{ euid }, | |
246 | _gid{ egid }, | |
247 | _app_tracer_version{ .major = major, .minor = minor }, | |
248 | _tracing_id{ tracing_id }, | |
249 | _clock{ lttng::make_unique<lsu::clock_class>() }, | |
250 | _metadata_generating_visitor{ lttng::make_unique<ls::tsdl::trace_class_visitor>( | |
251 | abi, | |
252 | [this](const std::string& fragment) { _append_metadata_fragment(fragment); }) }, | |
253 | _packet_header{ _create_packet_header() } | |
aeeb48c6 | 254 | { |
cd9adb8b | 255 | pthread_mutex_init(&_lock, nullptr); |
97f630d4 JG |
256 | if (_shm_path.size() > 0) { |
257 | if (run_as_mkdir_recursive(_shm_path.c_str(), S_IRWXU | S_IRWXG, euid, egid)) { | |
aeeb48c6 JG |
258 | LTTNG_THROW_POSIX("run_as_mkdir_recursive", errno); |
259 | } | |
260 | } | |
261 | ||
97f630d4 | 262 | if (_metadata_path.size() > 0) { |
aeeb48c6 | 263 | /* Create metadata file. */ |
28ab034a JG |
264 | const int ret = run_as_open(_metadata_path.c_str(), |
265 | O_WRONLY | O_CREAT | O_EXCL, | |
266 | S_IRUSR | S_IWUSR, | |
267 | euid, | |
268 | egid); | |
aeeb48c6 | 269 | if (ret < 0) { |
28ab034a | 270 | LTTNG_THROW_POSIX( |
f9a41357 | 271 | lttng::format( |
28ab034a JG |
272 | "Failed to open metadata file during registry session creation: path = {}", |
273 | _metadata_path), | |
274 | errno); | |
aeeb48c6 JG |
275 | } |
276 | ||
277 | _metadata_fd = ret; | |
278 | } | |
279 | ||
280 | _enums.reset(lttng_ht_new(0, LTTNG_HT_TYPE_STRING)); | |
281 | if (!_enums) { | |
282 | LTTNG_THROW_POSIX("Failed to create enums hash table", ENOMEM); | |
283 | } | |
284 | ||
285 | /* hash/match functions are specified at call site. */ | |
cd9adb8b JG |
286 | _enums->match_fct = nullptr; |
287 | _enums->hash_fct = nullptr; | |
aeeb48c6 JG |
288 | |
289 | _channels.reset(lttng_ht_new(0, LTTNG_HT_TYPE_U64)); | |
290 | if (!_channels) { | |
291 | LTTNG_THROW_POSIX("Failed to create channels hash table", ENOMEM); | |
292 | } | |
aeeb48c6 JG |
293 | } |
294 | ||
0267b527 JG |
295 | lst::type::cuptr lsu::registry_session::_create_packet_header() const |
296 | { | |
297 | lst::structure_type::fields packet_header_fields; | |
298 | ||
299 | /* uint32_t magic */ | |
28ab034a JG |
300 | packet_header_fields.emplace_back(lttng::make_unique<lst::field>( |
301 | "magic", | |
302 | lttng::make_unique<lst::integer_type>( | |
303 | abi.uint32_t_alignment, | |
304 | abi.byte_order, | |
305 | 32, | |
306 | lst::integer_type::signedness::UNSIGNED, | |
307 | lst::integer_type::base::HEXADECIMAL, | |
308 | std::initializer_list<lst::integer_type::role>( | |
309 | { lst::integer_type::role::PACKET_MAGIC_NUMBER })))); | |
0267b527 JG |
310 | |
311 | /* uuid */ | |
28ab034a JG |
312 | packet_header_fields.emplace_back(lttng::make_unique<lst::field>( |
313 | "uuid", | |
314 | lttng::make_unique<lst::static_length_blob_type>( | |
315 | 0, | |
316 | 16, | |
317 | std::initializer_list<lst::static_length_blob_type::role>( | |
318 | { lst::static_length_blob_type::role::METADATA_STREAM_UUID })))); | |
0267b527 JG |
319 | |
320 | /* uint32_t stream_id */ | |
28ab034a JG |
321 | packet_header_fields.emplace_back(lttng::make_unique<lst::field>( |
322 | "stream_id", | |
323 | lttng::make_unique<lst::integer_type>( | |
324 | abi.uint32_t_alignment, | |
325 | abi.byte_order, | |
326 | 32, | |
327 | lst::integer_type::signedness::UNSIGNED, | |
328 | lst::integer_type::base::DECIMAL, | |
329 | std::initializer_list<lst::integer_type::role>( | |
330 | { lst::integer_type::role::DATA_STREAM_CLASS_ID })))); | |
0267b527 JG |
331 | |
332 | /* uint64_t stream_instance_id */ | |
28ab034a JG |
333 | packet_header_fields.emplace_back(lttng::make_unique<lst::field>( |
334 | "stream_instance_id", | |
335 | lttng::make_unique<lst::integer_type>( | |
336 | abi.uint64_t_alignment, | |
337 | abi.byte_order, | |
338 | 64, | |
339 | lst::integer_type::signedness::UNSIGNED, | |
340 | lst::integer_type::base::DECIMAL, | |
341 | std::initializer_list<lst::integer_type::role>( | |
342 | { lst::integer_type::role::DATA_STREAM_ID })))); | |
0267b527 JG |
343 | |
344 | return lttng::make_unique<lst::structure_type>(0, std::move(packet_header_fields)); | |
345 | } | |
346 | ||
4bcf2294 | 347 | const lst::type *lsu::registry_session::packet_header() const noexcept |
0267b527 JG |
348 | { |
349 | return _packet_header.get(); | |
350 | } | |
351 | ||
97f630d4 JG |
352 | /* |
353 | * For a given enumeration in a registry, delete the entry and destroy | |
354 | * the enumeration. | |
3691d312 JG |
355 | * |
356 | * Note that this is used by ~registry_session() and must not throw. | |
97f630d4 | 357 | */ |
3691d312 | 358 | void lsu::registry_session::_destroy_enum(lsu::registry_enum *reg_enum) noexcept |
97f630d4 JG |
359 | { |
360 | int ret; | |
361 | lttng::urcu::read_lock_guard read_lock_guard; | |
362 | ||
363 | LTTNG_ASSERT(reg_enum); | |
364 | ASSERT_RCU_READ_LOCKED(); | |
365 | ||
366 | /* Delete the node first. */ | |
367 | struct lttng_ht_iter iter; | |
368 | iter.iter.node = ®_enum->node.node; | |
369 | ret = lttng_ht_del(_enums.get(), &iter); | |
370 | LTTNG_ASSERT(!ret); | |
371 | call_rcu(®_enum->rcu_head, destroy_enum_rcu); | |
372 | } | |
373 | ||
b0f2e8db | 374 | lsu::registry_session::~registry_session() |
aeeb48c6 JG |
375 | { |
376 | int ret; | |
377 | struct lttng_ht_iter iter; | |
d7bfb9b0 JG |
378 | lsu::registry_channel *chan; |
379 | lsu::registry_enum *reg_enum; | |
aeeb48c6 JG |
380 | |
381 | /* On error, EBUSY can be returned if lock. Code flow error. */ | |
382 | ret = pthread_mutex_destroy(&_lock); | |
383 | LTTNG_ASSERT(!ret); | |
384 | ||
385 | if (_channels) { | |
d7bfb9b0 JG |
386 | lttng::urcu::read_lock_guard read_lock_guard; |
387 | ||
aeeb48c6 | 388 | /* Destroy all event associated with this registry. */ |
d7bfb9b0 JG |
389 | DIAGNOSTIC_PUSH |
390 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
28ab034a | 391 | cds_lfht_for_each_entry (_channels->ht, &iter.iter, chan, _node.node) { |
aeeb48c6 JG |
392 | /* Delete the node from the ht and free it. */ |
393 | ret = lttng_ht_del(_channels.get(), &iter); | |
394 | LTTNG_ASSERT(!ret); | |
d7bfb9b0 | 395 | destroy_channel(chan, true); |
aeeb48c6 | 396 | } |
d7bfb9b0 | 397 | DIAGNOSTIC_POP |
aeeb48c6 JG |
398 | } |
399 | ||
400 | free(_metadata); | |
401 | if (_metadata_fd >= 0) { | |
402 | ret = close(_metadata_fd); | |
403 | if (ret) { | |
404 | PERROR("close"); | |
405 | } | |
406 | ||
97f630d4 | 407 | ret = run_as_unlink(_metadata_path.c_str(), _uid, _gid); |
aeeb48c6 JG |
408 | if (ret) { |
409 | PERROR("unlink"); | |
410 | } | |
411 | } | |
412 | ||
413 | if (_root_shm_path[0]) { | |
414 | /* Try to delete the directory hierarchy. */ | |
28ab034a JG |
415 | (void) run_as_rmdir_recursive(_root_shm_path.c_str(), |
416 | _uid, | |
417 | _gid, | |
418 | LTTNG_DIRECTORY_HANDLE_SKIP_NON_EMPTY_FLAG); | |
aeeb48c6 JG |
419 | } |
420 | ||
421 | /* Destroy the enum hash table */ | |
422 | if (_enums) { | |
97f630d4 JG |
423 | lttng::urcu::read_lock_guard read_lock_guard; |
424 | ||
aeeb48c6 | 425 | /* Destroy all enum entries associated with this registry. */ |
d7bfb9b0 JG |
426 | DIAGNOSTIC_PUSH |
427 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
aeeb48c6 | 428 | cds_lfht_for_each_entry (_enums->ht, &iter.iter, reg_enum, node.node) { |
97f630d4 | 429 | _destroy_enum(reg_enum); |
aeeb48c6 | 430 | } |
d7bfb9b0 | 431 | DIAGNOSTIC_POP |
aeeb48c6 JG |
432 | } |
433 | } | |
434 | ||
77682be9 | 435 | lsu::registry_session::locked_ref lsu::registry_session::lock() noexcept |
aeeb48c6 | 436 | { |
d7bfb9b0 | 437 | pthread_mutex_lock(&_lock); |
77682be9 | 438 | return locked_ref(this); |
d7bfb9b0 JG |
439 | } |
440 | ||
441 | /* | |
442 | * Initialize registry with default values. | |
443 | */ | |
b0f2e8db | 444 | void lsu::registry_session::add_channel(uint64_t key) |
d7bfb9b0 JG |
445 | { |
446 | lttng::pthread::lock_guard session_lock_guard(_lock); | |
447 | ||
448 | /* | |
449 | * Assign a channel ID right now since the event notification comes | |
450 | * *before* the channel notify so the ID needs to be set at this point so | |
451 | * the metadata can be dumped for that event. | |
452 | */ | |
453 | if (is_max_channel_id(_used_channel_id)) { | |
f9a41357 | 454 | LTTNG_THROW_ERROR(lttng::format( |
28ab034a | 455 | "Failed to allocate unique id for channel under session while adding channel")); |
d7bfb9b0 JG |
456 | } |
457 | ||
458 | auto chan = new lsu::registry_channel( | |
28ab034a JG |
459 | _get_next_channel_id(), |
460 | abi, | |
461 | _clock->name, | |
462 | /* Registered channel listener. */ | |
463 | [this](const lsu::registry_channel& registered_channel) { | |
464 | /* | |
465 | * Channel registration completed, serialize it's layout's | |
466 | * description. | |
467 | */ | |
468 | registered_channel.accept(*_metadata_generating_visitor); | |
469 | }, | |
470 | /* Added event listener. */ | |
471 | [this](const lsu::registry_channel& channel, | |
472 | const lsu::registry_event& added_event) { | |
473 | /* | |
474 | * The channel and its event classes will be dumped at once when | |
475 | * it is registered. This check prevents event classes from being | |
476 | * declared before their stream class. | |
477 | */ | |
478 | if (channel.is_registered()) { | |
479 | added_event.accept(*_metadata_generating_visitor); | |
480 | } | |
481 | }); | |
d7bfb9b0 JG |
482 | |
483 | lttng::urcu::read_lock_guard rcu_read_lock_guard; | |
484 | lttng_ht_node_init_u64(&chan->_node, key); | |
485 | lttng_ht_add_unique_u64(_channels.get(), &chan->_node); | |
486 | } | |
487 | ||
28ab034a | 488 | lttng::sessiond::ust::registry_channel& lsu::registry_session::channel(uint64_t channel_key) const |
d7bfb9b0 JG |
489 | { |
490 | lttng::urcu::read_lock_guard read_lock_guard; | |
491 | struct lttng_ht_node_u64 *node; | |
492 | struct lttng_ht_iter iter; | |
493 | ||
494 | ASSERT_LOCKED(_lock); | |
495 | ||
496 | lttng_ht_lookup(_channels.get(), &channel_key, &iter); | |
00d7d903 | 497 | node = lttng_ht_iter_get_node<lttng_ht_node_u64>(&iter); |
d7bfb9b0 | 498 | if (!node) { |
f9a41357 JG |
499 | LTTNG_THROW_INVALID_ARGUMENT_ERROR(lttng::format( |
500 | "Invalid channel key provided: channel key = {}", channel_key)); | |
d7bfb9b0 | 501 | } |
17fd219b | 502 | |
d7bfb9b0 JG |
503 | DIAGNOSTIC_PUSH |
504 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
0114db0e | 505 | auto chan = lttng::utils::container_of(node, &lsu::registry_channel::_node); |
d7bfb9b0 JG |
506 | DIAGNOSTIC_POP |
507 | return *chan; | |
508 | } | |
509 | ||
b0f2e8db | 510 | void lsu::registry_session::remove_channel(uint64_t channel_key, bool notify) |
d7bfb9b0 JG |
511 | { |
512 | struct lttng_ht_iter iter; | |
513 | int ret; | |
514 | lttng::urcu::read_lock_guard read_lock_guard; | |
515 | ||
516 | ASSERT_LOCKED(_lock); | |
4bcf2294 | 517 | auto& channel_to_remove = channel(channel_key); |
d7bfb9b0 | 518 | |
4bcf2294 | 519 | iter.iter.node = &channel_to_remove._node.node; |
d7bfb9b0 JG |
520 | ret = lttng_ht_del(_channels.get(), &iter); |
521 | LTTNG_ASSERT(!ret); | |
4bcf2294 | 522 | destroy_channel(&channel_to_remove, notify); |
d7bfb9b0 JG |
523 | } |
524 | ||
da9dd521 | 525 | void lsu::registry_session::accept( |
28ab034a | 526 | lttng::sessiond::trace::trace_class_environment_visitor& visitor) const |
d7bfb9b0 JG |
527 | { |
528 | ASSERT_LOCKED(_lock); | |
529 | ||
530 | visitor.visit(lst::environment_field<const char *>("domain", "ust")); | |
531 | visitor.visit(lst::environment_field<const char *>("tracer_name", "lttng-ust")); | |
97f630d4 JG |
532 | visitor.visit(lst::environment_field<int64_t>("tracer_major", _app_tracer_version.major)); |
533 | visitor.visit(lst::environment_field<int64_t>("tracer_minor", _app_tracer_version.minor)); | |
28ab034a JG |
534 | visitor.visit(lst::environment_field<const char *>( |
535 | "tracer_buffering_scheme", | |
536 | buffering_scheme() == LTTNG_BUFFER_PER_PID ? "pid" : "uid")); | |
d7bfb9b0 JG |
537 | visitor.visit(lst::environment_field<int64_t>("architecture_bit_width", abi.bits_per_long)); |
538 | ||
539 | { | |
540 | /* The caller already holds the session and session list locks. */ | |
541 | ASSERT_SESSION_LIST_LOCKED(); | |
d9a970b7 JG |
542 | const auto session = ltt_session::find_session(_tracing_id); |
543 | ASSERT_LOCKED(session->_lock); | |
d7bfb9b0 | 544 | |
28ab034a JG |
545 | visitor.visit(lst::environment_field<const char *>( |
546 | "trace_name", | |
547 | session->has_auto_generated_name ? DEFAULT_SESSION_NAME : session->name)); | |
548 | visitor.visit(lst::environment_field<std::string>( | |
549 | "trace_creation_datetime", | |
550 | lttng::utils::time_to_iso8601_str(session->creation_time))); | |
d7bfb9b0 | 551 | visitor.visit(lst::environment_field<const char *>("hostname", session->hostname)); |
aeeb48c6 JG |
552 | } |
553 | } | |
d7bfb9b0 | 554 | |
b0f2e8db | 555 | void lsu::registry_session::_accept_on_clock_classes(lst::trace_class_visitor& visitor) const |
d7bfb9b0 JG |
556 | { |
557 | ASSERT_LOCKED(_lock); | |
042670db | 558 | _clock->accept(visitor); |
d7bfb9b0 JG |
559 | } |
560 | ||
b0f2e8db | 561 | void lsu::registry_session::_accept_on_stream_classes(lst::trace_class_visitor& visitor) const |
d7bfb9b0 JG |
562 | { |
563 | ASSERT_LOCKED(_lock); | |
564 | ||
565 | std::vector<const lttng::sessiond::ust::registry_channel *> sorted_stream_classes; | |
566 | ||
567 | { | |
568 | lttng::urcu::read_lock_guard rcu_lock_guard; | |
569 | const lsu::registry_channel *channel; | |
570 | lttng_ht_iter channel_it; | |
571 | ||
572 | DIAGNOSTIC_PUSH | |
573 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
28ab034a | 574 | cds_lfht_for_each_entry (_channels->ht, &channel_it.iter, channel, _node.node) { |
d7bfb9b0 JG |
575 | sorted_stream_classes.emplace_back(channel); |
576 | } | |
577 | DIAGNOSTIC_POP | |
578 | } | |
579 | ||
28ab034a JG |
580 | std::sort(sorted_stream_classes.begin(), |
581 | sorted_stream_classes.end(), | |
582 | [](const lttng::sessiond::ust::registry_channel *a, | |
583 | const lttng::sessiond::ust::registry_channel *b) { return a->id < b->id; }); | |
d7bfb9b0 JG |
584 | |
585 | for (const auto stream_class : sorted_stream_classes) { | |
586 | stream_class->accept(visitor); | |
587 | } | |
588 | } | |
589 | ||
590 | /* | |
591 | * Return next available channel id and increment the used counter. The | |
592 | * is_max_channel_id function MUST be called before in order to validate | |
593 | * if the maximum number of IDs have been reached. If not, it is safe to call | |
594 | * this function. | |
595 | * | |
596 | * Return a unique channel ID. If max is reached, the used_channel_id counter | |
597 | * is returned. | |
598 | */ | |
b0f2e8db | 599 | uint32_t lsu::registry_session::_get_next_channel_id() |
d7bfb9b0 JG |
600 | { |
601 | if (is_max_channel_id(_used_channel_id)) { | |
602 | return _used_channel_id; | |
603 | } | |
604 | ||
605 | _used_channel_id++; | |
606 | return _next_channel_id++; | |
607 | } | |
608 | ||
b0f2e8db | 609 | void lsu::registry_session::_increase_metadata_size(size_t reservation_length) |
d7bfb9b0 JG |
610 | { |
611 | const auto new_len = _metadata_len + reservation_length; | |
612 | auto new_alloc_len = new_len; | |
613 | const auto old_alloc_len = _metadata_alloc_len; | |
614 | ||
615 | /* Rounding the new allocation length to the next power of 2 would overflow. */ | |
616 | if (new_alloc_len > (UINT32_MAX >> 1)) { | |
28ab034a JG |
617 | LTTNG_THROW_ERROR( |
618 | "Failed to reserve trace metadata storage as the new size would overflow"); | |
d7bfb9b0 JG |
619 | } |
620 | ||
621 | /* The current allocation length is already the largest we can afford. */ | |
622 | if ((old_alloc_len << 1) > (UINT32_MAX >> 1)) { | |
28ab034a JG |
623 | LTTNG_THROW_ERROR( |
624 | "Failed to reserve trace metadata storage as the max size was already reached"); | |
d7bfb9b0 JG |
625 | } |
626 | ||
627 | if (new_alloc_len > old_alloc_len) { | |
28ab034a JG |
628 | new_alloc_len = |
629 | std::max<size_t>(1U << get_count_order(new_alloc_len), old_alloc_len << 1); | |
d7bfb9b0 JG |
630 | |
631 | auto newptr = (char *) realloc(_metadata, new_alloc_len); | |
632 | if (!newptr) { | |
633 | LTTNG_THROW_POSIX("Failed to allocate trace metadata storage", errno); | |
634 | } | |
635 | ||
636 | _metadata = newptr; | |
637 | ||
638 | /* We zero directly the memory from start of allocation. */ | |
639 | memset(&_metadata[old_alloc_len], 0, new_alloc_len - old_alloc_len); | |
640 | _metadata_alloc_len = new_alloc_len; | |
641 | } | |
642 | ||
643 | _metadata_len += reservation_length; | |
644 | } | |
645 | ||
b0f2e8db | 646 | void lsu::registry_session::_append_metadata_fragment(const std::string& fragment) |
d7bfb9b0 JG |
647 | { |
648 | const auto offset = _metadata_len; | |
649 | ||
650 | _increase_metadata_size(fragment.size()); | |
651 | memcpy(&_metadata[offset], fragment.c_str(), fragment.size()); | |
652 | ||
653 | if (_metadata_fd >= 0) { | |
654 | const auto bytes_written = | |
28ab034a | 655 | lttng_write(_metadata_fd, fragment.c_str(), fragment.size()); |
d7bfb9b0 JG |
656 | |
657 | if (bytes_written != fragment.size()) { | |
28ab034a | 658 | LTTNG_THROW_POSIX("Failed to write trace metadata fragment to file", errno); |
d7bfb9b0 JG |
659 | } |
660 | } | |
661 | } | |
662 | ||
b0f2e8db | 663 | void lsu::registry_session::_reset_metadata() |
d7bfb9b0 JG |
664 | { |
665 | _metadata_len_sent = 0; | |
666 | memset(_metadata, 0, _metadata_alloc_len); | |
667 | _metadata_len = 0; | |
668 | ||
669 | if (_metadata_fd > 0) { | |
670 | /* Clear the metadata file's content. */ | |
671 | clear_metadata_file(_metadata_fd); | |
672 | } | |
673 | } | |
674 | ||
b0f2e8db | 675 | void lsu::registry_session::_generate_metadata() |
d7bfb9b0 | 676 | { |
da9dd521 | 677 | trace_class::accept(*_metadata_generating_visitor); |
d7bfb9b0 JG |
678 | } |
679 | ||
b0f2e8db | 680 | void lsu::registry_session::regenerate_metadata() |
d7bfb9b0 JG |
681 | { |
682 | lttng::pthread::lock_guard registry_lock(_lock); | |
683 | ||
042670db JR |
684 | /* Resample the clock */ |
685 | _clock = lttng::make_unique<lsu::clock_class>(); | |
686 | ||
d7bfb9b0 JG |
687 | _metadata_version++; |
688 | _reset_metadata(); | |
689 | _generate_metadata(); | |
690 | } | |
97f630d4 JG |
691 | |
692 | /* | |
693 | * Lookup enumeration by enum ID. | |
694 | * | |
695 | * Note that there is no need to lock the registry session as this only | |
696 | * performs an RCU-protected look-up. The function also return an rcu-protected | |
697 | * reference, which ensures that the caller keeps the RCU read lock until it | |
698 | * disposes of the object. | |
699 | */ | |
700 | lsu::registry_enum::const_rcu_protected_reference | |
4bcf2294 | 701 | lsu::registry_session::enumeration(const char *enum_name, uint64_t enum_id) const |
97f630d4 | 702 | { |
cd9adb8b | 703 | lsu::registry_enum *reg_enum = nullptr; |
97f630d4 JG |
704 | struct lttng_ht_node_str *node; |
705 | struct lttng_ht_iter iter; | |
706 | lttng::urcu::unique_read_lock rcu_lock; | |
707 | /* | |
708 | * Hack: only the name is used for hashing; the rest of the attributes | |
709 | * can be fudged. | |
710 | */ | |
711 | lsu::registry_signed_enum reg_enum_lookup(enum_name, nullptr, 0); | |
712 | ||
713 | ASSERT_RCU_READ_LOCKED(); | |
714 | ||
715 | reg_enum_lookup.id = enum_id; | |
716 | cds_lfht_lookup(_enums->ht, | |
717 | ht_hash_enum((void *) ®_enum_lookup, lttng_ht_seed), | |
28ab034a JG |
718 | ht_match_enum_id, |
719 | ®_enum_lookup, | |
720 | &iter.iter); | |
00d7d903 | 721 | node = lttng_ht_iter_get_node<lttng_ht_node_str>(&iter); |
97f630d4 | 722 | if (!node) { |
f9a41357 | 723 | LTTNG_THROW_PROTOCOL_ERROR(lttng::format( |
28ab034a JG |
724 | "Unknown enumeration referenced by application event field: enum name = `{}`, enum id = {}", |
725 | enum_name, | |
726 | enum_id)); | |
97f630d4 JG |
727 | } |
728 | ||
729 | DIAGNOSTIC_PUSH | |
730 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
0114db0e | 731 | reg_enum = lttng::utils::container_of(node, &lsu::registry_enum::node); |
97f630d4 JG |
732 | DIAGNOSTIC_POP |
733 | ||
28ab034a | 734 | return lsu::registry_enum::const_rcu_protected_reference{ *reg_enum, std::move(rcu_lock) }; |
97f630d4 JG |
735 | } |
736 | ||
737 | /* | |
738 | * Lookup enumeration by name and comparing enumeration entries. | |
739 | * Needs to be called from RCU read-side critical section. | |
740 | */ | |
28ab034a JG |
741 | lsu::registry_enum * |
742 | lsu::registry_session::_lookup_enum(const lsu::registry_enum *reg_enum_lookup) const | |
97f630d4 | 743 | { |
cd9adb8b | 744 | lsu::registry_enum *reg_enum = nullptr; |
97f630d4 JG |
745 | struct lttng_ht_node_str *node; |
746 | struct lttng_ht_iter iter; | |
747 | ||
748 | ASSERT_RCU_READ_LOCKED(); | |
749 | ||
28ab034a JG |
750 | cds_lfht_lookup(_enums->ht, |
751 | ht_hash_enum((void *) reg_enum_lookup, lttng_ht_seed), | |
752 | ht_match_enum, | |
753 | reg_enum_lookup, | |
754 | &iter.iter); | |
00d7d903 | 755 | node = lttng_ht_iter_get_node<lttng_ht_node_str>(&iter); |
97f630d4 JG |
756 | if (!node) { |
757 | goto end; | |
758 | } | |
759 | ||
760 | DIAGNOSTIC_PUSH | |
761 | DIAGNOSTIC_IGNORE_INVALID_OFFSETOF | |
0114db0e | 762 | reg_enum = lttng::utils::container_of(node, &lsu::registry_enum::node); |
97f630d4 JG |
763 | DIAGNOSTIC_POP |
764 | ||
765 | end: | |
766 | return reg_enum; | |
767 | } | |
768 | ||
769 | /* | |
770 | * Create a lsu::registry_enum from the given parameters and add it to the | |
771 | * registry hash table, or find it if already there. | |
772 | * | |
773 | * Should be called with session registry mutex held. | |
774 | * | |
775 | * We receive ownership of entries. | |
776 | */ | |
28ab034a JG |
777 | void lsu::registry_session::create_or_find_enum(int session_objd, |
778 | const char *enum_name, | |
779 | struct lttng_ust_ctl_enum_entry *raw_entries, | |
780 | size_t nr_entries, | |
781 | uint64_t *enum_id) | |
97f630d4 JG |
782 | { |
783 | struct cds_lfht_node *nodep; | |
cd9adb8b | 784 | lsu::registry_enum *reg_enum = nullptr, *old_reg_enum; |
97f630d4 | 785 | lttng::urcu::read_lock_guard read_lock_guard; |
303ac4ed JG |
786 | auto entries = lttng::make_unique_wrapper<lttng_ust_ctl_enum_entry, lttng::memory::free>( |
787 | raw_entries); | |
97f630d4 JG |
788 | |
789 | LTTNG_ASSERT(enum_name); | |
790 | ||
791 | /* | |
792 | * This should not happen but since it comes from the UST tracer, an | |
793 | * external party, don't assert and simply validate values. | |
794 | */ | |
795 | if (session_objd < 0) { | |
f9a41357 | 796 | LTTNG_THROW_INVALID_ARGUMENT_ERROR(lttng::format( |
28ab034a JG |
797 | "Invalid parameters used to create or look-up enumeration from registry session: session_objd = {}", |
798 | session_objd)); | |
97f630d4 JG |
799 | } |
800 | if (nr_entries == 0) { | |
f9a41357 | 801 | LTTNG_THROW_INVALID_ARGUMENT_ERROR(lttng::format( |
28ab034a JG |
802 | "Invalid parameters used to create or look-up enumeration from registry session: nr_entries = {}", |
803 | nr_entries)); | |
97f630d4 | 804 | } |
28ab034a | 805 | if (lttng_strnlen(enum_name, LTTNG_UST_ABI_SYM_NAME_LEN) == LTTNG_UST_ABI_SYM_NAME_LEN) { |
97f630d4 | 806 | LTTNG_THROW_INVALID_ARGUMENT_ERROR( |
28ab034a | 807 | "Invalid parameters used to create or look-up enumeration from registry session: enumeration name is not null terminated"); |
97f630d4 JG |
808 | } |
809 | ||
810 | if (entries->start.signedness) { | |
28ab034a | 811 | reg_enum = new lsu::registry_signed_enum(enum_name, entries.get(), nr_entries); |
97f630d4 | 812 | } else { |
28ab034a | 813 | reg_enum = new lsu::registry_unsigned_enum(enum_name, entries.get(), nr_entries); |
97f630d4 JG |
814 | } |
815 | ||
816 | old_reg_enum = _lookup_enum(reg_enum); | |
817 | if (old_reg_enum) { | |
818 | DBG("enum %s already in sess_objd: %u", enum_name, session_objd); | |
819 | /* Fall through. Use prior enum. */ | |
820 | destroy_enum(reg_enum); | |
821 | reg_enum = old_reg_enum; | |
822 | } else { | |
28ab034a | 823 | DBG("UST registry creating enum: %s, sess_objd: %u", enum_name, session_objd); |
97f630d4 JG |
824 | if (_next_enum_id == -1ULL) { |
825 | destroy_enum(reg_enum); | |
28ab034a JG |
826 | LTTNG_THROW_ERROR( |
827 | "Failed to allocate unique enumeration ID as it would overflow"); | |
97f630d4 JG |
828 | } |
829 | ||
830 | reg_enum->id = _next_enum_id++; | |
831 | nodep = cds_lfht_add_unique(_enums->ht, | |
28ab034a JG |
832 | ht_hash_enum(reg_enum, lttng_ht_seed), |
833 | ht_match_enum_id, | |
834 | reg_enum, | |
835 | ®_enum->node.node); | |
97f630d4 JG |
836 | LTTNG_ASSERT(nodep == ®_enum->node.node); |
837 | } | |
838 | ||
839 | DBG("UST registry reply with enum %s with id %" PRIu64 " in sess_objd: %u", | |
28ab034a JG |
840 | enum_name, |
841 | reg_enum->id, | |
842 | session_objd); | |
97f630d4 | 843 | *enum_id = reg_enum->id; |
f139a4f9 | 844 | } |