2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
11 #include "buffer-registry.hpp"
12 #include "condition-internal.hpp"
13 #include "event-notifier-error-accounting.hpp"
15 #include "fd-limit.hpp"
17 #include "health-sessiond.hpp"
18 #include "lttng-sessiond.hpp"
19 #include "lttng-ust-ctl.hpp"
20 #include "lttng-ust-error.hpp"
21 #include "notification-thread-commands.hpp"
22 #include "session.hpp"
23 #include "ust-app.hpp"
24 #include "ust-consumer.hpp"
25 #include "ust-field-convert.hpp"
28 #include <common/bytecode/bytecode.hpp>
29 #include <common/common.hpp>
30 #include <common/compat/errno.hpp>
31 #include <common/exception.hpp>
32 #include <common/format.hpp>
33 #include <common/hashtable/utils.hpp>
34 #include <common/make-unique.hpp>
35 #include <common/pthread-lock.hpp>
36 #include <common/sessiond-comm/sessiond-comm.hpp>
37 #include <common/urcu.hpp>
39 #include <lttng/condition/condition.h>
40 #include <lttng/condition/event-rule-matches-internal.hpp>
41 #include <lttng/condition/event-rule-matches.h>
42 #include <lttng/event-rule/event-rule-internal.hpp>
43 #include <lttng/event-rule/event-rule.h>
44 #include <lttng/event-rule/user-tracepoint.h>
45 #include <lttng/trigger/trigger-internal.hpp>
57 #include <sys/types.h>
59 #include <urcu/compiler.h>
62 namespace lsu
= lttng::sessiond::ust
;
63 namespace lst
= lttng::sessiond::trace
;
65 struct lttng_ht
*ust_app_ht
;
66 struct lttng_ht
*ust_app_ht_by_sock
;
67 struct lttng_ht
*ust_app_ht_by_notify_sock
;
69 static int ust_app_flush_app_session(ust_app
& app
, ust_app_session
& ua_sess
);
71 /* Next available channel key. Access under next_channel_key_lock. */
72 static uint64_t _next_channel_key
;
73 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
75 /* Next available session ID. Access under next_session_id_lock. */
76 static uint64_t _next_session_id
;
77 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
82 * Return the session registry according to the buffer type of the given
85 * A registry per UID object MUST exists before calling this function or else
86 * it LTTNG_ASSERT() if not found. RCU read side lock must be acquired.
88 lsu::registry_session
*get_session_registry(const struct ust_app_session
*ua_sess
)
90 lsu::registry_session
*registry
= nullptr;
92 LTTNG_ASSERT(ua_sess
);
94 switch (ua_sess
->buffer_type
) {
95 case LTTNG_BUFFER_PER_PID
:
97 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
101 registry
= reg_pid
->registry
->reg
.ust
;
104 case LTTNG_BUFFER_PER_UID
:
106 struct buffer_reg_uid
*reg_uid
=
107 buffer_reg_uid_find(ua_sess
->tracing_id
,
108 ua_sess
->bits_per_long
,
109 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
113 registry
= reg_uid
->registry
->reg
.ust
;
124 lsu::registry_session::locked_ref
get_locked_session_registry(const struct ust_app_session
*ua_sess
)
126 auto session
= get_session_registry(ua_sess
);
128 pthread_mutex_lock(&session
->_lock
);
131 return lsu::registry_session::locked_ref
{ session
};
136 * Return the incremented value of next_channel_key.
138 static uint64_t get_next_channel_key()
142 pthread_mutex_lock(&next_channel_key_lock
);
143 ret
= ++_next_channel_key
;
144 pthread_mutex_unlock(&next_channel_key_lock
);
149 * Return the atomically incremented value of next_session_id.
151 static uint64_t get_next_session_id()
155 pthread_mutex_lock(&next_session_id_lock
);
156 ret
= ++_next_session_id
;
157 pthread_mutex_unlock(&next_session_id_lock
);
161 static void copy_channel_attr_to_ustctl(struct lttng_ust_ctl_consumer_channel_attr
*attr
,
162 struct lttng_ust_abi_channel_attr
*uattr
)
164 /* Copy event attributes since the layout is different. */
165 attr
->subbuf_size
= uattr
->subbuf_size
;
166 attr
->num_subbuf
= uattr
->num_subbuf
;
167 attr
->overwrite
= uattr
->overwrite
;
168 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
169 attr
->read_timer_interval
= uattr
->read_timer_interval
;
170 attr
->output
= (lttng_ust_abi_output
) uattr
->output
;
171 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
175 * Match function for the hash table lookup.
177 * It matches an ust app event based on three attributes which are the event
178 * name, the filter bytecode and the loglevel.
180 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
182 struct ust_app_event
*event
;
183 const struct ust_app_ht_key
*key
;
188 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
189 key
= (ust_app_ht_key
*) _key
;
191 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
194 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
198 /* Event loglevel. */
199 if (!loglevels_match(event
->attr
.loglevel_type
,
200 event
->attr
.loglevel
,
203 LTTNG_UST_ABI_LOGLEVEL_ALL
)) {
207 /* One of the filters is NULL, fail. */
208 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
212 if (key
->filter
&& event
->filter
) {
213 /* Both filters exists, check length followed by the bytecode. */
214 if (event
->filter
->len
!= key
->filter
->len
||
215 memcmp(event
->filter
->data
, key
->filter
->data
, event
->filter
->len
) != 0) {
220 /* One of the exclusions is NULL, fail. */
221 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
225 if (key
->exclusion
&& event
->exclusion
) {
226 /* Both exclusions exists, check count followed by the names. */
227 if (event
->exclusion
->count
!= key
->exclusion
->count
||
228 memcmp(event
->exclusion
->names
,
229 key
->exclusion
->names
,
230 event
->exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
) != 0) {
243 * Unique add of an ust app event in the given ht. This uses the custom
244 * ht_match_ust_app_event match function and the event name as hash.
246 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
, struct ust_app_event
*event
)
248 struct cds_lfht_node
*node_ptr
;
249 struct ust_app_ht_key key
;
252 LTTNG_ASSERT(ua_chan
);
253 LTTNG_ASSERT(ua_chan
->events
);
256 ht
= ua_chan
->events
;
257 key
.name
= event
->attr
.name
;
258 key
.filter
= event
->filter
;
259 key
.loglevel_type
= (lttng_ust_abi_loglevel_type
) event
->attr
.loglevel_type
;
260 key
.loglevel_value
= event
->attr
.loglevel
;
261 key
.exclusion
= event
->exclusion
;
263 node_ptr
= cds_lfht_add_unique(ht
->ht
,
264 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
265 ht_match_ust_app_event
,
268 LTTNG_ASSERT(node_ptr
== &event
->node
.node
);
272 * Close the notify socket from the given RCU head object. This MUST be called
273 * through a call_rcu().
275 static void close_notify_sock_rcu(struct rcu_head
*head
)
278 struct ust_app_notify_sock_obj
*obj
=
279 lttng::utils::container_of(head
, &ust_app_notify_sock_obj::head
);
281 /* Must have a valid fd here. */
282 LTTNG_ASSERT(obj
->fd
>= 0);
284 ret
= close(obj
->fd
);
286 ERR("close notify sock %d RCU", obj
->fd
);
288 lttng_fd_put(LTTNG_FD_APPS
, 1);
294 * Delete ust context safely. RCU read lock must be held before calling
297 static void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
301 LTTNG_ASSERT(ua_ctx
);
302 ASSERT_RCU_READ_LOCKED();
305 pthread_mutex_lock(&app
->sock_lock
);
306 ret
= lttng_ust_ctl_release_object(sock
, ua_ctx
->obj
);
307 pthread_mutex_unlock(&app
->sock_lock
);
309 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
310 DBG3("UST app release ctx failed. Application is dead: pid = %d, sock = %d",
313 } else if (ret
== -EAGAIN
) {
314 WARN("UST app release ctx failed. Communication time out: pid = %d, sock = %d",
318 ERR("UST app release ctx obj handle %d failed with ret %d: pid = %d, sock = %d",
328 if (ua_ctx
->ctx
.ctx
== LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
) {
329 free(ua_ctx
->ctx
.u
.app_ctx
.provider_name
);
330 free(ua_ctx
->ctx
.u
.app_ctx
.ctx_name
);
337 * Delete ust app event safely. RCU read lock must be held before calling
340 static void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
, struct ust_app
*app
)
344 LTTNG_ASSERT(ua_event
);
345 ASSERT_RCU_READ_LOCKED();
347 free(ua_event
->filter
);
348 if (ua_event
->exclusion
!= nullptr)
349 free(ua_event
->exclusion
);
350 if (ua_event
->obj
!= nullptr) {
351 pthread_mutex_lock(&app
->sock_lock
);
352 ret
= lttng_ust_ctl_release_object(sock
, ua_event
->obj
);
353 pthread_mutex_unlock(&app
->sock_lock
);
355 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
356 DBG3("UST app release event failed. Application is dead: pid = %d, sock = %d",
359 } else if (ret
== -EAGAIN
) {
360 WARN("UST app release event failed. Communication time out: pid = %d, sock = %d",
364 ERR("UST app release event obj failed with ret %d: pid = %d, sock = %d",
376 * Delayed reclaim of a ust_app_event_notifier_rule object. This MUST be called
377 * through a call_rcu().
379 static void free_ust_app_event_notifier_rule_rcu(struct rcu_head
*head
)
381 struct ust_app_event_notifier_rule
*obj
=
382 lttng::utils::container_of(head
, &ust_app_event_notifier_rule::rcu_head
);
388 * Delete ust app event notifier rule safely.
390 static void delete_ust_app_event_notifier_rule(
391 int sock
, struct ust_app_event_notifier_rule
*ua_event_notifier_rule
, struct ust_app
*app
)
395 LTTNG_ASSERT(ua_event_notifier_rule
);
397 if (ua_event_notifier_rule
->exclusion
!= nullptr) {
398 free(ua_event_notifier_rule
->exclusion
);
401 if (ua_event_notifier_rule
->obj
!= nullptr) {
402 pthread_mutex_lock(&app
->sock_lock
);
403 ret
= lttng_ust_ctl_release_object(sock
, ua_event_notifier_rule
->obj
);
404 pthread_mutex_unlock(&app
->sock_lock
);
406 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
407 DBG3("UST app release event notifier failed. Application is dead: pid = %d, sock = %d",
410 } else if (ret
== -EAGAIN
) {
411 WARN("UST app release event notifier failed. Communication time out: pid = %d, sock = %d",
415 ERR("UST app release event notifier failed with ret %d: pid = %d, sock = %d",
422 free(ua_event_notifier_rule
->obj
);
425 lttng_trigger_put(ua_event_notifier_rule
->trigger
);
426 call_rcu(&ua_event_notifier_rule
->rcu_head
, free_ust_app_event_notifier_rule_rcu
);
430 * Release ust data object of the given stream.
432 * Return 0 on success or else a negative value.
434 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
, struct ust_app
*app
)
438 LTTNG_ASSERT(stream
);
441 pthread_mutex_lock(&app
->sock_lock
);
442 ret
= lttng_ust_ctl_release_object(sock
, stream
->obj
);
443 pthread_mutex_unlock(&app
->sock_lock
);
445 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
446 DBG3("UST app release stream failed. Application is dead: pid = %d, sock = %d",
449 } else if (ret
== -EAGAIN
) {
450 WARN("UST app release stream failed. Communication time out: pid = %d, sock = %d",
454 ERR("UST app release stream obj failed with ret %d: pid = %d, sock = %d",
460 lttng_fd_put(LTTNG_FD_APPS
, 2);
468 * Delete ust app stream safely. RCU read lock must be held before calling
471 static void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
, struct ust_app
*app
)
473 LTTNG_ASSERT(stream
);
474 ASSERT_RCU_READ_LOCKED();
476 (void) release_ust_app_stream(sock
, stream
, app
);
480 static void delete_ust_app_channel_rcu(struct rcu_head
*head
)
482 struct ust_app_channel
*ua_chan
=
483 lttng::utils::container_of(head
, &ust_app_channel::rcu_head
);
485 lttng_ht_destroy(ua_chan
->ctx
);
486 lttng_ht_destroy(ua_chan
->events
);
491 * Extract the lost packet or discarded events counter when the channel is
492 * being deleted and store the value in the parent channel so we can
493 * access it from lttng list and at stop/destroy.
495 * The session list lock must be held by the caller.
497 static void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
499 uint64_t discarded
= 0, lost
= 0;
500 struct ltt_ust_channel
*uchan
;
502 if (ua_chan
->attr
.type
!= LTTNG_UST_ABI_CHAN_PER_CPU
) {
506 lttng::urcu::read_lock_guard read_lock
;
509 const auto session
= ltt_session::find_session(ua_chan
->session
->tracing_id
);
511 if (!session
->ust_session
) {
513 * Not finding the session is not an error because there are
514 * multiple ways the channels can be torn down.
516 * 1) The session daemon can initiate the destruction of the
517 * ust app session after receiving a destroy command or
518 * during its shutdown/teardown.
519 * 2) The application, since we are in per-pid tracing, is
520 * unregistering and tearing down its ust app session.
522 * Both paths are protected by the session list lock which
523 * ensures that the accounting of lost packets and discarded
524 * events is done exactly once. The session is then unpublished
525 * from the session list, resulting in this condition.
530 if (ua_chan
->attr
.overwrite
) {
531 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
533 session
->ust_session
->consumer
,
536 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
538 session
->ust_session
->consumer
,
541 uchan
= trace_ust_find_channel_by_name(session
->ust_session
->domain_global
.channels
,
544 ERR("Missing UST channel to store discarded counters");
547 } catch (const lttng::sessiond::exceptions::session_not_found_error
& ex
) {
548 DBG_FMT("Failed to save per-pid lost/discarded counters: {}, location='{}'",
554 uchan
->per_pid_closed_app_discarded
+= discarded
;
555 uchan
->per_pid_closed_app_lost
+= lost
;
559 * Delete ust app channel safely. RCU read lock must be held before calling
562 * The session list lock must be held by the caller.
564 static void delete_ust_app_channel(int sock
,
565 struct ust_app_channel
*ua_chan
,
567 const lsu::registry_session::locked_ref
& locked_registry
)
570 struct lttng_ht_iter iter
;
571 struct ust_app_event
*ua_event
;
572 struct ust_app_ctx
*ua_ctx
;
573 struct ust_app_stream
*stream
, *stmp
;
575 LTTNG_ASSERT(ua_chan
);
576 ASSERT_RCU_READ_LOCKED();
578 DBG3("UST app deleting channel %s", ua_chan
->name
);
581 cds_list_for_each_entry_safe (stream
, stmp
, &ua_chan
->streams
.head
, list
) {
582 cds_list_del(&stream
->list
);
583 delete_ust_app_stream(sock
, stream
, app
);
587 cds_lfht_for_each_entry (ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
588 cds_list_del(&ua_ctx
->list
);
589 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
591 delete_ust_app_ctx(sock
, ua_ctx
, app
);
595 cds_lfht_for_each_entry (ua_chan
->events
->ht
, &iter
.iter
, ua_event
, node
.node
) {
596 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
598 delete_ust_app_event(sock
, ua_event
, app
);
601 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
602 /* Wipe and free registry from session registry. */
603 if (locked_registry
) {
605 locked_registry
->remove_channel(ua_chan
->key
, sock
>= 0);
606 } catch (const std::exception
& ex
) {
607 DBG("Could not find channel for removal: %s", ex
.what());
612 * A negative socket can be used by the caller when
613 * cleaning-up a ua_chan in an error path. Skip the
614 * accounting in this case.
617 save_per_pid_lost_discarded_counters(ua_chan
);
621 if (ua_chan
->obj
!= nullptr) {
622 /* Remove channel from application UST object descriptor. */
623 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
624 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
626 pthread_mutex_lock(&app
->sock_lock
);
627 ret
= lttng_ust_ctl_release_object(sock
, ua_chan
->obj
);
628 pthread_mutex_unlock(&app
->sock_lock
);
630 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
631 DBG3("UST app channel %s release failed. Application is dead: pid = %d, sock = %d",
635 } else if (ret
== -EAGAIN
) {
636 WARN("UST app channel %s release failed. Communication time out: pid = %d, sock = %d",
641 ERR("UST app channel %s release failed with ret %d: pid = %d, sock = %d",
648 lttng_fd_put(LTTNG_FD_APPS
, 1);
651 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
654 int ust_app_register_done(struct ust_app
*app
)
658 pthread_mutex_lock(&app
->sock_lock
);
659 ret
= lttng_ust_ctl_register_done(app
->sock
);
660 pthread_mutex_unlock(&app
->sock_lock
);
664 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*data
)
669 pthread_mutex_lock(&app
->sock_lock
);
674 ret
= lttng_ust_ctl_release_object(sock
, data
);
676 pthread_mutex_unlock(&app
->sock_lock
);
682 * Push metadata to consumer socket.
684 * RCU read-side lock must be held to guarantee existence of socket.
685 * Must be called with the ust app session lock held.
686 * Must be called with the registry lock held.
688 * On success, return the len of metadata pushed or else a negative value.
689 * Returning a -EPIPE return value means we could not send the metadata,
690 * but it can be caused by recoverable errors (e.g. the application has
691 * terminated concurrently).
693 ssize_t
ust_app_push_metadata(const lsu::registry_session::locked_ref
& locked_registry
,
694 struct consumer_socket
*socket
,
698 char *metadata_str
= nullptr;
699 size_t len
, offset
, new_metadata_len_sent
;
701 uint64_t metadata_key
, metadata_version
;
703 LTTNG_ASSERT(locked_registry
);
704 LTTNG_ASSERT(socket
);
705 ASSERT_RCU_READ_LOCKED();
707 metadata_key
= locked_registry
->_metadata_key
;
710 * Means that no metadata was assigned to the session. This can
711 * happens if no start has been done previously.
717 offset
= locked_registry
->_metadata_len_sent
;
718 len
= locked_registry
->_metadata_len
- locked_registry
->_metadata_len_sent
;
719 new_metadata_len_sent
= locked_registry
->_metadata_len
;
720 metadata_version
= locked_registry
->_metadata_version
;
722 DBG3("No metadata to push for metadata key %" PRIu64
,
723 locked_registry
->_metadata_key
);
725 if (send_zero_data
) {
726 DBG("No metadata to push");
732 /* Allocate only what we have to send. */
733 metadata_str
= calloc
<char>(len
);
735 PERROR("zmalloc ust app metadata string");
739 /* Copy what we haven't sent out. */
740 memcpy(metadata_str
, locked_registry
->_metadata
+ offset
, len
);
743 pthread_mutex_unlock(&locked_registry
->_lock
);
745 * We need to unlock the registry while we push metadata to
746 * break a circular dependency between the consumerd metadata
747 * lock and the sessiond registry lock. Indeed, pushing metadata
748 * to the consumerd awaits that it gets pushed all the way to
749 * relayd, but doing so requires grabbing the metadata lock. If
750 * a concurrent metadata request is being performed by
751 * consumerd, this can try to grab the registry lock on the
752 * sessiond while holding the metadata lock on the consumer
753 * daemon. Those push and pull schemes are performed on two
754 * different bidirectionnal communication sockets.
756 ret
= consumer_push_metadata(
757 socket
, metadata_key
, metadata_str
, len
, offset
, metadata_version
);
758 pthread_mutex_lock(&locked_registry
->_lock
);
761 * There is an acceptable race here between the registry
762 * metadata key assignment and the creation on the
763 * consumer. The session daemon can concurrently push
764 * metadata for this registry while being created on the
765 * consumer since the metadata key of the registry is
766 * assigned *before* it is setup to avoid the consumer
767 * to ask for metadata that could possibly be not found
768 * in the session daemon.
770 * The metadata will get pushed either by the session
771 * being stopped or the consumer requesting metadata if
772 * that race is triggered.
774 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
777 ERR("Error pushing metadata to consumer");
783 * Metadata may have been concurrently pushed, since
784 * we're not holding the registry lock while pushing to
785 * consumer. This is handled by the fact that we send
786 * the metadata content, size, and the offset at which
787 * that metadata belongs. This may arrive out of order
788 * on the consumer side, and the consumer is able to
789 * deal with overlapping fragments. The consumer
790 * supports overlapping fragments, which must be
791 * contiguous starting from offset 0. We keep the
792 * largest metadata_len_sent value of the concurrent
795 locked_registry
->_metadata_len_sent
=
796 std::max(locked_registry
->_metadata_len_sent
, new_metadata_len_sent
);
805 * On error, flag the registry that the metadata is
806 * closed. We were unable to push anything and this
807 * means that either the consumer is not responding or
808 * the metadata cache has been destroyed on the
811 locked_registry
->_metadata_closed
= true;
819 * For a given application and session, push metadata to consumer.
820 * Either sock or consumer is required : if sock is NULL, the default
821 * socket to send the metadata is retrieved from consumer, if sock
822 * is not NULL we use it to send the metadata.
823 * RCU read-side lock must be held while calling this function,
824 * therefore ensuring existence of registry. It also ensures existence
825 * of socket throughout this function.
827 * Return 0 on success else a negative error.
828 * Returning a -EPIPE return value means we could not send the metadata,
829 * but it can be caused by recoverable errors (e.g. the application has
830 * terminated concurrently).
832 static int push_metadata(const lsu::registry_session::locked_ref
& locked_registry
,
833 struct consumer_output
*consumer
)
837 struct consumer_socket
*socket
;
839 LTTNG_ASSERT(locked_registry
);
840 LTTNG_ASSERT(consumer
);
841 ASSERT_RCU_READ_LOCKED();
843 if (locked_registry
->_metadata_closed
) {
848 /* Get consumer socket to use to push the metadata.*/
849 socket
= consumer_find_socket_by_bitness(locked_registry
->abi
.bits_per_long
, consumer
);
855 ret
= ust_app_push_metadata(locked_registry
, socket
, 0);
867 * Send to the consumer a close metadata command for the given session. Once
868 * done, the metadata channel is deleted and the session metadata pointer is
869 * nullified. The session lock MUST be held unless the application is
870 * in the destroy path.
872 * Do not hold the registry lock while communicating with the consumerd, because
873 * doing so causes inter-process deadlocks between consumerd and sessiond with
874 * the metadata request notification.
876 * Return 0 on success else a negative value.
878 static int close_metadata(uint64_t metadata_key
,
879 unsigned int consumer_bitness
,
880 struct consumer_output
*consumer
)
883 struct consumer_socket
*socket
;
884 lttng::urcu::read_lock_guard read_lock_guard
;
886 LTTNG_ASSERT(consumer
);
888 /* Get consumer socket to use to push the metadata. */
889 socket
= consumer_find_socket_by_bitness(consumer_bitness
, consumer
);
895 ret
= consumer_close_metadata(socket
, metadata_key
);
904 static void delete_ust_app_session_rcu(struct rcu_head
*head
)
906 struct ust_app_session
*ua_sess
=
907 lttng::utils::container_of(head
, &ust_app_session::rcu_head
);
909 lttng_ht_destroy(ua_sess
->channels
);
914 * Delete ust app session safely. RCU read lock must be held before calling
917 * The session list lock must be held by the caller.
919 static void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
, struct ust_app
*app
)
922 struct lttng_ht_iter iter
;
923 struct ust_app_channel
*ua_chan
;
925 LTTNG_ASSERT(ua_sess
);
926 ASSERT_RCU_READ_LOCKED();
928 /* Locked for the duration of the function. */
929 auto locked_ua_sess
= ua_sess
->lock();
931 LTTNG_ASSERT(!ua_sess
->deleted
);
932 ua_sess
->deleted
= true;
934 auto locked_registry
= get_locked_session_registry(ua_sess
);
935 /* Registry can be null on error path during initialization. */
936 if (locked_registry
) {
937 /* Push metadata for application before freeing the application. */
938 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
941 cds_lfht_for_each_entry (ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
, node
.node
) {
942 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
944 delete_ust_app_channel(sock
, ua_chan
, app
, locked_registry
);
947 if (locked_registry
) {
949 * Don't ask to close metadata for global per UID buffers. Close
950 * metadata only on destroy trace session in this case. Also, the
951 * previous push metadata could have flag the metadata registry to
952 * close so don't send a close command if closed.
954 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
955 const auto metadata_key
= locked_registry
->_metadata_key
;
956 const auto consumer_bitness
= locked_registry
->abi
.bits_per_long
;
958 if (!locked_registry
->_metadata_closed
&& metadata_key
!= 0) {
959 locked_registry
->_metadata_closed
= true;
962 /* Release lock before communication, see comments in close_metadata(). */
963 locked_registry
.reset();
964 (void) close_metadata(metadata_key
, consumer_bitness
, ua_sess
->consumer
);
968 /* In case of per PID, the registry is kept in the session. */
969 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
970 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
973 * Registry can be null on error path during
976 buffer_reg_pid_remove(reg_pid
);
977 buffer_reg_pid_destroy(reg_pid
);
981 if (ua_sess
->handle
!= -1) {
982 pthread_mutex_lock(&app
->sock_lock
);
983 ret
= lttng_ust_ctl_release_handle(sock
, ua_sess
->handle
);
984 pthread_mutex_unlock(&app
->sock_lock
);
986 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
987 DBG3("UST app release session handle failed. Application is dead: pid = %d, sock = %d",
990 } else if (ret
== -EAGAIN
) {
991 WARN("UST app release session handle failed. Communication time out: pid = %d, sock = %d",
995 ERR("UST app release session handle failed with ret %d: pid = %d, sock = %d",
1002 /* Remove session from application UST object descriptor. */
1003 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
1004 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
1008 consumer_output_put(ua_sess
->consumer
);
1009 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
1013 * Delete a traceable application structure from the global list. Never call
1014 * this function outside of a call_rcu call.
1016 static void delete_ust_app(struct ust_app
*app
)
1019 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
1020 struct lttng_ht_iter iter
;
1021 struct ust_app_event_notifier_rule
*event_notifier_rule
;
1022 bool event_notifier_write_fd_is_open
;
1025 * The session list lock must be held during this function to guarantee
1026 * the existence of ua_sess.
1028 const auto list_lock
= lttng::sessiond::lock_session_list();
1029 /* Delete ust app sessions info */
1034 cds_list_for_each_entry_safe (ua_sess
, tmp_ua_sess
, &app
->teardown_head
, teardown_node
) {
1035 /* Free every object in the session and the session. */
1036 lttng::urcu::read_lock_guard read_lock
;
1037 delete_ust_app_session(sock
, ua_sess
, app
);
1040 /* Remove the event notifier rules associated with this app. */
1042 lttng::urcu::read_lock_guard read_lock
;
1044 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
1046 event_notifier_rule
,
1048 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
1051 delete_ust_app_event_notifier_rule(app
->sock
, event_notifier_rule
, app
);
1055 lttng_ht_destroy(app
->sessions
);
1056 lttng_ht_destroy(app
->ust_sessions_objd
);
1057 lttng_ht_destroy(app
->ust_objd
);
1058 lttng_ht_destroy(app
->token_to_event_notifier_rule_ht
);
1061 * This could be NULL if the event notifier setup failed (e.g the app
1062 * was killed or the tracer does not support this feature).
1064 if (app
->event_notifier_group
.object
) {
1065 enum lttng_error_code ret_code
;
1066 enum event_notifier_error_accounting_status status
;
1068 const int event_notifier_read_fd
=
1069 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
);
1071 ret_code
= notification_thread_command_remove_tracer_event_source(
1072 the_notification_thread_handle
, event_notifier_read_fd
);
1073 if (ret_code
!= LTTNG_OK
) {
1074 ERR("Failed to remove application tracer event source from notification thread");
1077 status
= event_notifier_error_accounting_unregister_app(app
);
1078 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1079 ERR("Error unregistering app from event notifier error accounting");
1082 lttng_ust_ctl_release_object(sock
, app
->event_notifier_group
.object
);
1083 free(app
->event_notifier_group
.object
);
1086 event_notifier_write_fd_is_open
=
1087 lttng_pipe_is_write_open(app
->event_notifier_group
.event_pipe
);
1088 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1090 * Release the file descriptors reserved for the event notifier pipe.
1091 * The app could be destroyed before the write end of the pipe could be
1092 * passed to the application (and closed). In that case, both file
1093 * descriptors must be released.
1095 lttng_fd_put(LTTNG_FD_APPS
, event_notifier_write_fd_is_open
? 2 : 1);
1098 * Wait until we have deleted the application from the sock hash table
1099 * before closing this socket, otherwise an application could re-use the
1100 * socket ID and race with the teardown, using the same hash table entry.
1102 * It's OK to leave the close in call_rcu. We want it to stay unique for
1103 * all RCU readers that could run concurrently with unregister app,
1104 * therefore we _need_ to only close that socket after a grace period. So
1105 * it should stay in this RCU callback.
1107 * This close() is a very important step of the synchronization model so
1108 * every modification to this function must be carefully reviewed.
1114 lttng_fd_put(LTTNG_FD_APPS
, 1);
1116 DBG2("UST app pid %d deleted", app
->pid
);
1121 * URCU intermediate call to delete an UST app.
1123 static void delete_ust_app_rcu(struct rcu_head
*head
)
1125 struct lttng_ht_node_ulong
*node
=
1126 lttng::utils::container_of(head
, <tng_ht_node_ulong::head
);
1127 struct ust_app
*app
= lttng::utils::container_of(node
, &ust_app::pid_n
);
1129 DBG3("Call RCU deleting app PID %d", app
->pid
);
1130 delete_ust_app(app
);
1134 * Delete the session from the application ht and delete the data structure by
1135 * freeing every object inside and releasing them.
1137 * The session list lock must be held by the caller.
1139 static void destroy_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
)
1142 struct lttng_ht_iter iter
;
1145 LTTNG_ASSERT(ua_sess
);
1147 iter
.iter
.node
= &ua_sess
->node
.node
;
1148 ret
= lttng_ht_del(app
->sessions
, &iter
);
1150 /* Already scheduled for teardown. */
1154 /* Once deleted, free the data structure. */
1155 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1162 * Alloc new UST app session.
1164 static struct ust_app_session
*alloc_ust_app_session()
1166 struct ust_app_session
*ua_sess
;
1168 /* Init most of the default value by allocating and zeroing */
1169 ua_sess
= new ust_app_session
;
1170 if (ua_sess
== nullptr) {
1175 ua_sess
->handle
= -1;
1176 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1177 ua_sess
->metadata_attr
.type
= LTTNG_UST_ABI_CHAN_METADATA
;
1186 * Alloc new UST app channel.
1188 static struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1189 struct ust_app_session
*ua_sess
,
1190 struct lttng_ust_abi_channel_attr
*attr
)
1192 struct ust_app_channel
*ua_chan
;
1194 /* Init most of the default value by allocating and zeroing */
1195 ua_chan
= zmalloc
<ust_app_channel
>();
1196 if (ua_chan
== nullptr) {
1201 /* Setup channel name */
1202 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1203 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1205 ua_chan
->enabled
= true;
1206 ua_chan
->handle
= -1;
1207 ua_chan
->session
= ua_sess
;
1208 ua_chan
->key
= get_next_channel_key();
1209 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1210 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1211 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1213 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1214 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1216 /* Copy attributes */
1218 /* Translate from lttng_ust_channel to lttng_ust_ctl_consumer_channel_attr. */
1219 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1220 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1221 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1222 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1223 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1224 ua_chan
->attr
.output
= (lttng_ust_abi_output
) attr
->output
;
1225 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1227 /* By default, the channel is a per cpu channel. */
1228 ua_chan
->attr
.type
= LTTNG_UST_ABI_CHAN_PER_CPU
;
1230 DBG3("UST app channel %s allocated", ua_chan
->name
);
1239 * Allocate and initialize a UST app stream.
1241 * Return newly allocated stream pointer or NULL on error.
1243 struct ust_app_stream
*ust_app_alloc_stream()
1245 struct ust_app_stream
*stream
= nullptr;
1247 stream
= zmalloc
<ust_app_stream
>();
1248 if (stream
== nullptr) {
1249 PERROR("zmalloc ust app stream");
1253 /* Zero could be a valid value for a handle so flag it to -1. */
1254 stream
->handle
= -1;
1261 * Alloc new UST app event.
1263 static struct ust_app_event
*alloc_ust_app_event(char *name
, struct lttng_ust_abi_event
*attr
)
1265 struct ust_app_event
*ua_event
;
1267 /* Init most of the default value by allocating and zeroing */
1268 ua_event
= zmalloc
<ust_app_event
>();
1269 if (ua_event
== nullptr) {
1270 PERROR("Failed to allocate ust_app_event structure");
1274 ua_event
->enabled
= true;
1275 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1276 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1277 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1279 /* Copy attributes */
1281 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1284 DBG3("UST app event %s allocated", ua_event
->name
);
1293 * Allocate a new UST app event notifier rule.
1295 static struct ust_app_event_notifier_rule
*
1296 alloc_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
)
1298 enum lttng_event_rule_generate_exclusions_status generate_exclusion_status
;
1299 enum lttng_condition_status cond_status
;
1300 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1301 struct lttng_condition
*condition
= nullptr;
1302 const struct lttng_event_rule
*event_rule
= nullptr;
1304 ua_event_notifier_rule
= zmalloc
<ust_app_event_notifier_rule
>();
1305 if (ua_event_notifier_rule
== nullptr) {
1306 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1310 ua_event_notifier_rule
->enabled
= true;
1311 ua_event_notifier_rule
->token
= lttng_trigger_get_tracer_token(trigger
);
1312 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
, ua_event_notifier_rule
->token
);
1314 condition
= lttng_trigger_get_condition(trigger
);
1315 LTTNG_ASSERT(condition
);
1316 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
1317 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
1319 cond_status
= lttng_condition_event_rule_matches_get_rule(condition
, &event_rule
);
1320 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
1321 LTTNG_ASSERT(event_rule
);
1323 ua_event_notifier_rule
->error_counter_index
=
1324 lttng_condition_event_rule_matches_get_error_counter_index(condition
);
1325 /* Acquire the event notifier's reference to the trigger. */
1326 lttng_trigger_get(trigger
);
1328 ua_event_notifier_rule
->trigger
= trigger
;
1329 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1330 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1331 event_rule
, &ua_event_notifier_rule
->exclusion
);
1332 switch (generate_exclusion_status
) {
1333 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1334 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1337 /* Error occurred. */
1338 ERR("Failed to generate exclusions from trigger while allocating an event notifier rule");
1339 goto error_put_trigger
;
1342 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1343 ua_event_notifier_rule
->token
);
1345 return ua_event_notifier_rule
;
1348 lttng_trigger_put(trigger
);
1350 free(ua_event_notifier_rule
);
1355 * Alloc new UST app context.
1357 static struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1359 struct ust_app_ctx
*ua_ctx
;
1361 ua_ctx
= zmalloc
<ust_app_ctx
>();
1362 if (ua_ctx
== nullptr) {
1366 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1369 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1370 if (uctx
->ctx
== LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
) {
1371 char *provider_name
= nullptr, *ctx_name
= nullptr;
1373 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1374 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1375 if (!provider_name
|| !ctx_name
) {
1376 free(provider_name
);
1381 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1382 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1386 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1394 * Create a liblttng-ust filter bytecode from given bytecode.
1396 * Return allocated filter or NULL on error.
1398 static struct lttng_ust_abi_filter_bytecode
*
1399 create_ust_filter_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1401 struct lttng_ust_abi_filter_bytecode
*filter
= nullptr;
1403 /* Copy filter bytecode. */
1404 filter
= zmalloc
<lttng_ust_abi_filter_bytecode
>(sizeof(*filter
) + orig_f
->len
);
1406 PERROR("Failed to allocate lttng_ust_filter_bytecode: bytecode len = %" PRIu32
1412 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) == sizeof(struct lttng_ust_abi_filter_bytecode
));
1413 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1419 * Create a liblttng-ust capture bytecode from given bytecode.
1421 * Return allocated filter or NULL on error.
1423 static struct lttng_ust_abi_capture_bytecode
*
1424 create_ust_capture_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1426 struct lttng_ust_abi_capture_bytecode
*capture
= nullptr;
1428 /* Copy capture bytecode. */
1429 capture
= zmalloc
<lttng_ust_abi_capture_bytecode
>(sizeof(*capture
) + orig_f
->len
);
1431 PERROR("Failed to allocate lttng_ust_abi_capture_bytecode: bytecode len = %" PRIu32
1437 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) ==
1438 sizeof(struct lttng_ust_abi_capture_bytecode
));
1439 memcpy(capture
, orig_f
, sizeof(*capture
) + orig_f
->len
);
1445 * Find an ust_app using the sock and return it. RCU read side lock must be
1446 * held before calling this helper function.
1448 struct ust_app
*ust_app_find_by_sock(int sock
)
1450 struct lttng_ht_node_ulong
*node
;
1451 struct lttng_ht_iter iter
;
1453 ASSERT_RCU_READ_LOCKED();
1455 lttng_ht_lookup(ust_app_ht_by_sock
, (void *) ((unsigned long) sock
), &iter
);
1456 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&iter
);
1457 if (node
== nullptr) {
1458 DBG2("UST app find by sock %d not found", sock
);
1462 return lttng::utils::container_of(node
, &ust_app::sock_n
);
1469 * Find an ust_app using the notify sock and return it. RCU read side lock must
1470 * be held before calling this helper function.
1472 static struct ust_app
*find_app_by_notify_sock(int sock
)
1474 struct lttng_ht_node_ulong
*node
;
1475 struct lttng_ht_iter iter
;
1477 ASSERT_RCU_READ_LOCKED();
1479 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *) ((unsigned long) sock
), &iter
);
1480 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&iter
);
1481 if (node
== nullptr) {
1482 DBG2("UST app find by notify sock %d not found", sock
);
1486 return lttng::utils::container_of(node
, &ust_app::notify_sock_n
);
1493 * Lookup for an ust app event based on event name, filter bytecode and the
1496 * Return an ust_app_event object or NULL on error.
1498 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1500 const struct lttng_bytecode
*filter
,
1501 lttng_ust_abi_loglevel_type loglevel_type
,
1503 const struct lttng_event_exclusion
*exclusion
)
1505 struct lttng_ht_iter iter
;
1506 struct lttng_ht_node_str
*node
;
1507 struct ust_app_event
*event
= nullptr;
1508 struct ust_app_ht_key key
;
1513 /* Setup key for event lookup. */
1515 key
.filter
= filter
;
1516 key
.loglevel_type
= loglevel_type
;
1517 key
.loglevel_value
= loglevel_value
;
1518 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1519 key
.exclusion
= exclusion
;
1521 /* Lookup using the event name as hash and a custom match fct. */
1522 cds_lfht_lookup(ht
->ht
,
1523 ht
->hash_fct((void *) name
, lttng_ht_seed
),
1524 ht_match_ust_app_event
,
1527 node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&iter
);
1528 if (node
== nullptr) {
1532 event
= lttng::utils::container_of(node
, &ust_app_event::node
);
1539 * Look-up an event notifier rule based on its token id.
1541 * Must be called with the RCU read lock held.
1542 * Return an ust_app_event_notifier_rule object or NULL on error.
1544 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(struct lttng_ht
*ht
,
1547 struct lttng_ht_iter iter
;
1548 struct lttng_ht_node_u64
*node
;
1549 struct ust_app_event_notifier_rule
*event_notifier_rule
= nullptr;
1552 ASSERT_RCU_READ_LOCKED();
1554 lttng_ht_lookup(ht
, &token
, &iter
);
1555 node
= lttng_ht_iter_get_node
<lttng_ht_node_u64
>(&iter
);
1556 if (node
== nullptr) {
1557 DBG2("UST app event notifier rule token not found: token = %" PRIu64
, token
);
1561 event_notifier_rule
= lttng::utils::container_of(node
, &ust_app_event_notifier_rule::node
);
1563 return event_notifier_rule
;
1567 * Create the channel context on the tracer.
1569 * Called with UST app session lock held.
1571 static int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1572 struct ust_app_ctx
*ua_ctx
,
1573 struct ust_app
*app
)
1577 health_code_update();
1579 pthread_mutex_lock(&app
->sock_lock
);
1580 ret
= lttng_ust_ctl_add_context(app
->sock
, &ua_ctx
->ctx
, ua_chan
->obj
, &ua_ctx
->obj
);
1581 pthread_mutex_unlock(&app
->sock_lock
);
1583 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1585 DBG3("UST app create channel context failed. Application is dead: pid = %d, sock = %d",
1588 } else if (ret
== -EAGAIN
) {
1590 WARN("UST app create channel context failed. Communication time out: pid = %d, sock = %d",
1594 ERR("UST app create channel context failed with ret %d: pid = %d, sock = %d",
1602 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1604 DBG2("UST app context handle %d created successfully for channel %s",
1609 health_code_update();
1614 * Set the filter on the tracer.
1616 static int set_ust_object_filter(struct ust_app
*app
,
1617 const struct lttng_bytecode
*bytecode
,
1618 struct lttng_ust_abi_object_data
*ust_object
)
1621 struct lttng_ust_abi_filter_bytecode
*ust_bytecode
= nullptr;
1623 health_code_update();
1625 ust_bytecode
= create_ust_filter_bytecode_from_bytecode(bytecode
);
1626 if (!ust_bytecode
) {
1627 ret
= -LTTNG_ERR_NOMEM
;
1630 pthread_mutex_lock(&app
->sock_lock
);
1631 ret
= lttng_ust_ctl_set_filter(app
->sock
, ust_bytecode
, ust_object
);
1632 pthread_mutex_unlock(&app
->sock_lock
);
1634 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1636 DBG3("UST app set filter failed. Application is dead: pid = %d, sock = %d",
1639 } else if (ret
== -EAGAIN
) {
1641 WARN("UST app set filter failed. Communication time out: pid = %d, sock = %d",
1645 ERR("UST app set filter failed with ret %d: pid = %d, sock = %d, object = %p",
1654 DBG2("UST filter successfully set: object = %p", ust_object
);
1657 health_code_update();
1663 * Set a capture bytecode for the passed object.
1664 * The sequence number enforces the ordering at runtime and on reception of
1665 * the captured payloads.
1667 static int set_ust_capture(struct ust_app
*app
,
1668 const struct lttng_bytecode
*bytecode
,
1669 unsigned int capture_seqnum
,
1670 struct lttng_ust_abi_object_data
*ust_object
)
1673 struct lttng_ust_abi_capture_bytecode
*ust_bytecode
= nullptr;
1675 health_code_update();
1677 ust_bytecode
= create_ust_capture_bytecode_from_bytecode(bytecode
);
1678 if (!ust_bytecode
) {
1679 ret
= -LTTNG_ERR_NOMEM
;
1684 * Set the sequence number to ensure the capture of fields is ordered.
1686 ust_bytecode
->seqnum
= capture_seqnum
;
1688 pthread_mutex_lock(&app
->sock_lock
);
1689 ret
= lttng_ust_ctl_set_capture(app
->sock
, ust_bytecode
, ust_object
);
1690 pthread_mutex_unlock(&app
->sock_lock
);
1692 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1694 DBG3("UST app set capture failed. Application is dead: pid = %d, sock = %d",
1697 } else if (ret
== -EAGAIN
) {
1699 DBG3("UST app set capture failed. Communication timeout: pid = %d, sock = %d",
1703 ERR("UST app event set capture failed with ret %d: pid = %d, sock = %d",
1712 DBG2("UST capture successfully set: object = %p", ust_object
);
1715 health_code_update();
1720 static struct lttng_ust_abi_event_exclusion
*
1721 create_ust_exclusion_from_exclusion(const struct lttng_event_exclusion
*exclusion
)
1723 struct lttng_ust_abi_event_exclusion
*ust_exclusion
= nullptr;
1724 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_abi_event_exclusion
) +
1725 LTTNG_UST_ABI_SYM_NAME_LEN
* exclusion
->count
;
1727 ust_exclusion
= zmalloc
<lttng_ust_abi_event_exclusion
>(exclusion_alloc_size
);
1728 if (!ust_exclusion
) {
1733 LTTNG_ASSERT(sizeof(struct lttng_event_exclusion
) ==
1734 sizeof(struct lttng_ust_abi_event_exclusion
));
1735 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1737 return ust_exclusion
;
1741 * Set event exclusions on the tracer.
1743 static int set_ust_object_exclusions(struct ust_app
*app
,
1744 const struct lttng_event_exclusion
*exclusions
,
1745 struct lttng_ust_abi_object_data
*ust_object
)
1748 struct lttng_ust_abi_event_exclusion
*ust_exclusions
= nullptr;
1750 LTTNG_ASSERT(exclusions
&& exclusions
->count
> 0);
1752 health_code_update();
1754 ust_exclusions
= create_ust_exclusion_from_exclusion(exclusions
);
1755 if (!ust_exclusions
) {
1756 ret
= -LTTNG_ERR_NOMEM
;
1759 pthread_mutex_lock(&app
->sock_lock
);
1760 ret
= lttng_ust_ctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1761 pthread_mutex_unlock(&app
->sock_lock
);
1763 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1765 DBG3("UST app event exclusion failed. Application is dead: pid = %d, sock = %d",
1768 } else if (ret
== -EAGAIN
) {
1770 WARN("UST app event exclusion failed. Communication time out(pid: %d, sock = %d",
1774 ERR("UST app event exclusions failed with ret %d: pid = %d, sock = %d, object = %p",
1783 DBG2("UST exclusions set successfully for object %p", ust_object
);
1786 health_code_update();
1787 free(ust_exclusions
);
1792 * Disable the specified event on to UST tracer for the UST session.
1794 static int disable_ust_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*object
)
1798 health_code_update();
1800 pthread_mutex_lock(&app
->sock_lock
);
1801 ret
= lttng_ust_ctl_disable(app
->sock
, object
);
1802 pthread_mutex_unlock(&app
->sock_lock
);
1804 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1806 DBG3("UST app disable object failed. Application is dead: pid = %d, sock = %d",
1809 } else if (ret
== -EAGAIN
) {
1811 WARN("UST app disable object failed. Communication time out: pid = %d, sock = %d",
1815 ERR("UST app disable object failed with ret %d: pid = %d, sock = %d, object = %p",
1824 DBG2("UST app object %p disabled successfully for app: pid = %d", object
, app
->pid
);
1827 health_code_update();
1832 * Disable the specified channel on to UST tracer for the UST session.
1834 static int disable_ust_channel(struct ust_app
*app
,
1835 struct ust_app_session
*ua_sess
,
1836 struct ust_app_channel
*ua_chan
)
1840 health_code_update();
1842 pthread_mutex_lock(&app
->sock_lock
);
1843 ret
= lttng_ust_ctl_disable(app
->sock
, ua_chan
->obj
);
1844 pthread_mutex_unlock(&app
->sock_lock
);
1846 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1848 DBG3("UST app disable channel failed. Application is dead: pid = %d, sock = %d",
1851 } else if (ret
== -EAGAIN
) {
1853 WARN("UST app disable channel failed. Communication time out: pid = %d, sock = %d",
1857 ERR("UST app channel %s disable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1867 DBG2("UST app channel %s disabled successfully for app: pid = %d", ua_chan
->name
, app
->pid
);
1870 health_code_update();
1875 * Enable the specified channel on to UST tracer for the UST session.
1877 static int enable_ust_channel(struct ust_app
*app
,
1878 struct ust_app_session
*ua_sess
,
1879 struct ust_app_channel
*ua_chan
)
1883 health_code_update();
1885 pthread_mutex_lock(&app
->sock_lock
);
1886 ret
= lttng_ust_ctl_enable(app
->sock
, ua_chan
->obj
);
1887 pthread_mutex_unlock(&app
->sock_lock
);
1889 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1891 DBG3("UST app channel %s enable failed. Application is dead: pid = %d, sock = %d",
1895 } else if (ret
== -EAGAIN
) {
1897 WARN("UST app channel %s enable failed. Communication time out: pid = %d, sock = %d",
1902 ERR("UST app channel %s enable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1912 ua_chan
->enabled
= true;
1914 DBG2("UST app channel %s enabled successfully for app: pid = %d", ua_chan
->name
, app
->pid
);
1917 health_code_update();
1922 * Enable the specified event on to UST tracer for the UST session.
1924 static int enable_ust_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*ust_object
)
1928 health_code_update();
1930 pthread_mutex_lock(&app
->sock_lock
);
1931 ret
= lttng_ust_ctl_enable(app
->sock
, ust_object
);
1932 pthread_mutex_unlock(&app
->sock_lock
);
1934 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1936 DBG3("UST app enable object failed. Application is dead: pid = %d, sock = %d",
1939 } else if (ret
== -EAGAIN
) {
1941 WARN("UST app enable object failed. Communication time out: pid = %d, sock = %d",
1945 ERR("UST app enable object failed with ret %d: pid = %d, sock = %d, object = %p",
1954 DBG2("UST app object %p enabled successfully for app: pid = %d", ust_object
, app
->pid
);
1957 health_code_update();
1962 * Send channel and stream buffer to application.
1964 * Return 0 on success. On error, a negative value is returned.
1966 static int send_channel_pid_to_ust(struct ust_app
*app
,
1967 struct ust_app_session
*ua_sess
,
1968 struct ust_app_channel
*ua_chan
)
1971 struct ust_app_stream
*stream
, *stmp
;
1974 LTTNG_ASSERT(ua_sess
);
1975 LTTNG_ASSERT(ua_chan
);
1977 health_code_update();
1979 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
, app
->sock
);
1981 /* Send channel to the application. */
1982 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1983 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1984 ret
= -ENOTCONN
; /* Caused by app exiting. */
1986 } else if (ret
== -EAGAIN
) {
1987 /* Caused by timeout. */
1988 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
1992 ua_sess
->tracing_id
);
1993 /* Treat this the same way as an application that is exiting. */
1996 } else if (ret
< 0) {
2000 health_code_update();
2002 /* Send all streams to application. */
2003 cds_list_for_each_entry_safe (stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2004 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
2005 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2006 ret
= -ENOTCONN
; /* Caused by app exiting. */
2008 } else if (ret
== -EAGAIN
) {
2009 /* Caused by timeout. */
2010 WARN("Communication with application %d timed out on send_stream for stream \"%s\" of channel \"%s\" of session \"%" PRIu64
2015 ua_sess
->tracing_id
);
2017 * Treat this the same way as an application that is
2021 } else if (ret
< 0) {
2024 /* We don't need the stream anymore once sent to the tracer. */
2025 cds_list_del(&stream
->list
);
2026 delete_ust_app_stream(-1, stream
, app
);
2030 health_code_update();
2035 * Create the specified event onto the UST tracer for a UST session.
2037 * Should be called with session mutex held.
2039 static int create_ust_event(struct ust_app
*app
,
2040 struct ust_app_channel
*ua_chan
,
2041 struct ust_app_event
*ua_event
)
2045 health_code_update();
2047 /* Create UST event on tracer */
2048 pthread_mutex_lock(&app
->sock_lock
);
2049 ret
= lttng_ust_ctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
, &ua_event
->obj
);
2050 pthread_mutex_unlock(&app
->sock_lock
);
2052 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2054 DBG3("UST app create event failed. Application is dead: pid = %d, sock = %d",
2057 } else if (ret
== -EAGAIN
) {
2059 WARN("UST app create event failed. Communication time out: pid = %d, sock = %d",
2063 ERR("UST app create event '%s' failed with ret %d: pid = %d, sock = %d",
2064 ua_event
->attr
.name
,
2072 ua_event
->handle
= ua_event
->obj
->handle
;
2074 DBG2("UST app event %s created successfully for pid:%d object = %p",
2075 ua_event
->attr
.name
,
2079 health_code_update();
2081 /* Set filter if one is present. */
2082 if (ua_event
->filter
) {
2083 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
2089 /* Set exclusions for the event */
2090 if (ua_event
->exclusion
) {
2091 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
2097 /* If event not enabled, disable it on the tracer */
2098 if (ua_event
->enabled
) {
2100 * We now need to explicitly enable the event, since it
2101 * is now disabled at creation.
2103 ret
= enable_ust_object(app
, ua_event
->obj
);
2106 * If we hit an EPERM, something is wrong with our enable call. If
2107 * we get an EEXIST, there is a problem on the tracer side since we
2111 case -LTTNG_UST_ERR_PERM
:
2112 /* Code flow problem */
2114 case -LTTNG_UST_ERR_EXIST
:
2115 /* It's OK for our use case. */
2126 health_code_update();
2131 init_ust_event_notifier_from_event_rule(const struct lttng_event_rule
*rule
,
2132 struct lttng_ust_abi_event_notifier
*event_notifier
)
2134 enum lttng_event_rule_status status
;
2135 enum lttng_ust_abi_loglevel_type ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2136 int loglevel
= -1, ret
= 0;
2137 const char *pattern
;
2139 memset(event_notifier
, 0, sizeof(*event_notifier
));
2141 if (lttng_event_rule_targets_agent_domain(rule
)) {
2143 * Special event for agents
2144 * The actual meat of the event is in the filter that will be
2145 * attached later on.
2146 * Set the default values for the agent event.
2148 pattern
= event_get_default_agent_ust_name(lttng_event_rule_get_domain_type(rule
));
2150 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2152 const struct lttng_log_level_rule
*log_level_rule
;
2154 LTTNG_ASSERT(lttng_event_rule_get_type(rule
) ==
2155 LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
);
2157 status
= lttng_event_rule_user_tracepoint_get_name_pattern(rule
, &pattern
);
2158 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2159 /* At this point, this is a fatal error. */
2163 status
= lttng_event_rule_user_tracepoint_get_log_level_rule(rule
, &log_level_rule
);
2164 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
2165 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2166 } else if (status
== LTTNG_EVENT_RULE_STATUS_OK
) {
2167 enum lttng_log_level_rule_status llr_status
;
2169 switch (lttng_log_level_rule_get_type(log_level_rule
)) {
2170 case LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY
:
2171 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_SINGLE
;
2172 llr_status
= lttng_log_level_rule_exactly_get_level(log_level_rule
,
2175 case LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS
:
2176 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_RANGE
;
2177 llr_status
= lttng_log_level_rule_at_least_as_severe_as_get_level(
2178 log_level_rule
, &loglevel
);
2184 LTTNG_ASSERT(llr_status
== LTTNG_LOG_LEVEL_RULE_STATUS_OK
);
2186 /* At this point this is a fatal error. */
2191 event_notifier
->event
.instrumentation
= LTTNG_UST_ABI_TRACEPOINT
;
2192 ret
= lttng_strncpy(
2193 event_notifier
->event
.name
, pattern
, sizeof(event_notifier
->event
.name
));
2195 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ", pattern
);
2199 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
2200 event_notifier
->event
.loglevel
= loglevel
;
2206 * Create the specified event notifier against the user space tracer of a
2207 * given application.
2209 static int create_ust_event_notifier(struct ust_app
*app
,
2210 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2213 enum lttng_condition_status condition_status
;
2214 const struct lttng_condition
*condition
= nullptr;
2215 struct lttng_ust_abi_event_notifier event_notifier
;
2216 const struct lttng_event_rule
*event_rule
= nullptr;
2217 unsigned int capture_bytecode_count
= 0, i
;
2218 enum lttng_condition_status cond_status
;
2219 enum lttng_event_rule_type event_rule_type
;
2221 health_code_update();
2222 LTTNG_ASSERT(app
->event_notifier_group
.object
);
2224 condition
= lttng_trigger_get_const_condition(ua_event_notifier_rule
->trigger
);
2225 LTTNG_ASSERT(condition
);
2226 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
2227 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
2229 condition_status
= lttng_condition_event_rule_matches_get_rule(condition
, &event_rule
);
2230 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2232 LTTNG_ASSERT(event_rule
);
2234 event_rule_type
= lttng_event_rule_get_type(event_rule
);
2235 LTTNG_ASSERT(event_rule_type
== LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
||
2236 event_rule_type
== LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
||
2237 event_rule_type
== LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
||
2238 event_rule_type
== LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
);
2240 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2241 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2242 event_notifier
.error_counter_index
= ua_event_notifier_rule
->error_counter_index
;
2244 /* Create UST event notifier against the tracer. */
2245 pthread_mutex_lock(&app
->sock_lock
);
2246 ret
= lttng_ust_ctl_create_event_notifier(app
->sock
,
2248 app
->event_notifier_group
.object
,
2249 &ua_event_notifier_rule
->obj
);
2250 pthread_mutex_unlock(&app
->sock_lock
);
2252 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2254 DBG3("UST app create event notifier failed. Application is dead: pid = %d, sock = %d",
2257 } else if (ret
== -EAGAIN
) {
2259 WARN("UST app create event notifier failed. Communication time out: pid = %d, sock = %d",
2263 ERR("UST app create event notifier '%s' failed with ret %d: pid = %d, sock = %d",
2264 event_notifier
.event
.name
,
2272 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2274 DBG2("UST app event notifier %s created successfully: app = '%s': pid = %d, object = %p",
2275 event_notifier
.event
.name
,
2278 ua_event_notifier_rule
->obj
);
2280 health_code_update();
2282 /* Set filter if one is present. */
2283 if (ua_event_notifier_rule
->filter
) {
2284 ret
= set_ust_object_filter(
2285 app
, ua_event_notifier_rule
->filter
, ua_event_notifier_rule
->obj
);
2291 /* Set exclusions for the event. */
2292 if (ua_event_notifier_rule
->exclusion
) {
2293 ret
= set_ust_object_exclusions(
2294 app
, ua_event_notifier_rule
->exclusion
, ua_event_notifier_rule
->obj
);
2300 /* Set the capture bytecodes. */
2301 cond_status
= lttng_condition_event_rule_matches_get_capture_descriptor_count(
2302 condition
, &capture_bytecode_count
);
2303 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
2305 for (i
= 0; i
< capture_bytecode_count
; i
++) {
2306 const struct lttng_bytecode
*capture_bytecode
=
2307 lttng_condition_event_rule_matches_get_capture_bytecode_at_index(condition
,
2310 ret
= set_ust_capture(app
, capture_bytecode
, i
, ua_event_notifier_rule
->obj
);
2317 * We now need to explicitly enable the event, since it
2318 * is disabled at creation.
2320 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2323 * If we hit an EPERM, something is wrong with our enable call.
2324 * If we get an EEXIST, there is a problem on the tracer side
2325 * since we just created it.
2328 case -LTTNG_UST_ERR_PERM
:
2329 /* Code flow problem. */
2331 case -LTTNG_UST_ERR_EXIST
:
2332 /* It's OK for our use case. */
2342 ua_event_notifier_rule
->enabled
= true;
2345 health_code_update();
2350 * Copy data between an UST app event and a LTT event.
2352 static void shadow_copy_event(struct ust_app_event
*ua_event
, struct ltt_ust_event
*uevent
)
2354 size_t exclusion_alloc_size
;
2356 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2357 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2359 ua_event
->enabled
= uevent
->enabled
;
2361 /* Copy event attributes */
2362 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2364 /* Copy filter bytecode */
2365 if (uevent
->filter
) {
2366 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2367 /* Filter might be NULL here in case of ENONEM. */
2370 /* Copy exclusion data */
2371 if (uevent
->exclusion
) {
2372 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2373 LTTNG_UST_ABI_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2374 ua_event
->exclusion
= zmalloc
<lttng_event_exclusion
>(exclusion_alloc_size
);
2375 if (ua_event
->exclusion
== nullptr) {
2378 memcpy(ua_event
->exclusion
, uevent
->exclusion
, exclusion_alloc_size
);
2384 * Copy data between an UST app channel and a LTT channel.
2386 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
, struct ltt_ust_channel
*uchan
)
2388 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2390 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2391 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2393 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2394 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2396 /* Copy event attributes since the layout is different. */
2397 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2398 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2399 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2400 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2401 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2402 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2403 ua_chan
->attr
.output
= (lttng_ust_abi_output
) uchan
->attr
.output
;
2404 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2407 * Note that the attribute channel type is not set since the channel on the
2408 * tracing registry side does not have this information.
2411 ua_chan
->enabled
= uchan
->enabled
;
2412 ua_chan
->tracing_channel_id
= uchan
->id
;
2414 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2418 * Copy data between a UST app session and a regular LTT session.
2420 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2421 struct ltt_ust_session
*usess
,
2422 struct ust_app
*app
)
2424 struct tm
*timeinfo
;
2427 char tmp_shm_path
[PATH_MAX
];
2429 timeinfo
= localtime(&app
->registration_time
);
2430 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2432 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2434 ua_sess
->tracing_id
= usess
->id
;
2435 ua_sess
->id
= get_next_session_id();
2436 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2437 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2438 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2439 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2440 ua_sess
->buffer_type
= usess
->buffer_type
;
2441 ua_sess
->bits_per_long
= app
->abi
.bits_per_long
;
2443 /* There is only one consumer object per session possible. */
2444 consumer_output_get(usess
->consumer
);
2445 ua_sess
->consumer
= usess
->consumer
;
2447 ua_sess
->output_traces
= usess
->output_traces
;
2448 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2449 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &usess
->metadata_attr
);
2451 switch (ua_sess
->buffer_type
) {
2452 case LTTNG_BUFFER_PER_PID
:
2453 ret
= snprintf(ua_sess
->path
,
2454 sizeof(ua_sess
->path
),
2455 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2460 case LTTNG_BUFFER_PER_UID
:
2461 ret
= snprintf(ua_sess
->path
,
2462 sizeof(ua_sess
->path
),
2463 DEFAULT_UST_TRACE_UID_PATH
,
2464 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2465 app
->abi
.bits_per_long
);
2472 PERROR("asprintf UST shadow copy session");
2477 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
, sizeof(ua_sess
->root_shm_path
));
2478 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2479 strncpy(ua_sess
->shm_path
, usess
->shm_path
, sizeof(ua_sess
->shm_path
));
2480 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2481 if (ua_sess
->shm_path
[0]) {
2482 switch (ua_sess
->buffer_type
) {
2483 case LTTNG_BUFFER_PER_PID
:
2484 ret
= snprintf(tmp_shm_path
,
2485 sizeof(tmp_shm_path
),
2486 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2491 case LTTNG_BUFFER_PER_UID
:
2492 ret
= snprintf(tmp_shm_path
,
2493 sizeof(tmp_shm_path
),
2494 "/" DEFAULT_UST_TRACE_UID_PATH
,
2496 app
->abi
.bits_per_long
);
2503 PERROR("sprintf UST shadow copy session");
2507 strncat(ua_sess
->shm_path
,
2509 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2510 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2515 consumer_output_put(ua_sess
->consumer
);
2519 * Lookup sesison wrapper.
2521 static void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2522 struct ust_app
*app
,
2523 struct lttng_ht_iter
*iter
)
2525 /* Get right UST app session from app */
2526 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2530 * Return ust app session from the app session hashtable using the UST session
2533 static struct ust_app_session
*lookup_session_by_app(const struct ltt_ust_session
*usess
,
2534 struct ust_app
*app
)
2536 struct lttng_ht_iter iter
;
2537 struct lttng_ht_node_u64
*node
;
2539 __lookup_session_by_app(usess
, app
, &iter
);
2540 node
= lttng_ht_iter_get_node
<lttng_ht_node_u64
>(&iter
);
2541 if (node
== nullptr) {
2545 return lttng::utils::container_of(node
, &ust_app_session::node
);
2552 * Setup buffer registry per PID for the given session and application. If none
2553 * is found, a new one is created, added to the global registry and
2554 * initialized. If regp is valid, it's set with the newly created object.
2556 * Return 0 on success or else a negative value.
2558 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2559 struct ust_app
*app
,
2560 struct buffer_reg_pid
**regp
)
2563 struct buffer_reg_pid
*reg_pid
;
2565 LTTNG_ASSERT(ua_sess
);
2568 lttng::urcu::read_lock_guard read_lock
;
2570 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2573 * This is the create channel path meaning that if there is NO
2574 * registry available, we have to create one for this session.
2576 ret
= buffer_reg_pid_create(
2577 ua_sess
->id
, ®_pid
, ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2585 /* Initialize registry. */
2586 reg_pid
->registry
->reg
.ust
= ust_registry_session_per_pid_create(
2591 reg_pid
->root_shm_path
,
2593 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2594 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2595 ua_sess
->tracing_id
);
2596 if (!reg_pid
->registry
->reg
.ust
) {
2598 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2599 * destroy the buffer registry, because it is always expected
2600 * that if the buffer registry can be found, its ust registry is
2603 buffer_reg_pid_destroy(reg_pid
);
2607 buffer_reg_pid_add(reg_pid
);
2609 DBG3("UST app buffer registry per PID created successfully");
2620 * Setup buffer registry per UID for the given session and application. If none
2621 * is found, a new one is created, added to the global registry and
2622 * initialized. If regp is valid, it's set with the newly created object.
2624 * Return 0 on success or else a negative value.
2626 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2627 struct ust_app_session
*ua_sess
,
2628 struct ust_app
*app
,
2629 struct buffer_reg_uid
**regp
)
2632 struct buffer_reg_uid
*reg_uid
;
2634 LTTNG_ASSERT(usess
);
2637 lttng::urcu::read_lock_guard read_lock
;
2639 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->abi
.bits_per_long
, app
->uid
);
2642 * This is the create channel path meaning that if there is NO
2643 * registry available, we have to create one for this session.
2645 ret
= buffer_reg_uid_create(usess
->id
,
2646 app
->abi
.bits_per_long
,
2650 ua_sess
->root_shm_path
,
2659 /* Initialize registry. */
2660 reg_uid
->registry
->reg
.ust
= ust_registry_session_per_uid_create(app
->abi
,
2663 reg_uid
->root_shm_path
,
2667 ua_sess
->tracing_id
,
2669 if (!reg_uid
->registry
->reg
.ust
) {
2671 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2672 * destroy the buffer registry, because it is always expected
2673 * that if the buffer registry can be found, its ust registry is
2676 buffer_reg_uid_destroy(reg_uid
, nullptr);
2680 /* Add node to teardown list of the session. */
2681 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2683 buffer_reg_uid_add(reg_uid
);
2685 DBG3("UST app buffer registry per UID created successfully");
2695 * Create a session on the tracer side for the given app.
2697 * On success, ua_sess_ptr is populated with the session pointer or else left
2698 * untouched. If the session was created, is_created is set to 1. On error,
2699 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2702 * Returns 0 on success or else a negative code which is either -ENOMEM or
2703 * -ENOTCONN which is the default code if the lttng_ust_ctl_create_session fails.
2705 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2706 struct ust_app
*app
,
2707 struct ust_app_session
**ua_sess_ptr
,
2710 int ret
, created
= 0;
2711 struct ust_app_session
*ua_sess
;
2713 LTTNG_ASSERT(usess
);
2715 LTTNG_ASSERT(ua_sess_ptr
);
2717 health_code_update();
2719 ua_sess
= lookup_session_by_app(usess
, app
);
2720 if (ua_sess
== nullptr) {
2721 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2724 ua_sess
= alloc_ust_app_session();
2725 if (ua_sess
== nullptr) {
2726 /* Only malloc can failed so something is really wrong */
2730 shadow_copy_session(ua_sess
, usess
, app
);
2734 switch (usess
->buffer_type
) {
2735 case LTTNG_BUFFER_PER_PID
:
2736 /* Init local registry. */
2737 ret
= setup_buffer_reg_pid(ua_sess
, app
, nullptr);
2739 delete_ust_app_session(-1, ua_sess
, app
);
2743 case LTTNG_BUFFER_PER_UID
:
2744 /* Look for a global registry. If none exists, create one. */
2745 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, nullptr);
2747 delete_ust_app_session(-1, ua_sess
, app
);
2757 health_code_update();
2759 if (ua_sess
->handle
== -1) {
2760 pthread_mutex_lock(&app
->sock_lock
);
2761 ret
= lttng_ust_ctl_create_session(app
->sock
);
2762 pthread_mutex_unlock(&app
->sock_lock
);
2764 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2765 DBG("UST app creating session failed. Application is dead: pid = %d, sock = %d",
2769 } else if (ret
== -EAGAIN
) {
2770 DBG("UST app creating session failed. Communication time out: pid = %d, sock = %d",
2775 ERR("UST app creating session failed with ret %d: pid = %d, sock =%d",
2780 delete_ust_app_session(-1, ua_sess
, app
);
2781 if (ret
!= -ENOMEM
) {
2783 * Tracer is probably gone or got an internal error so let's
2784 * behave like it will soon unregister or not usable.
2791 ua_sess
->handle
= ret
;
2793 /* Add ust app session to app's HT */
2794 lttng_ht_node_init_u64(&ua_sess
->node
, ua_sess
->tracing_id
);
2795 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2796 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2797 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
, &ua_sess
->ust_objd_node
);
2799 DBG2("UST app session created successfully with handle %d", ret
);
2802 *ua_sess_ptr
= ua_sess
;
2804 *is_created
= created
;
2807 /* Everything went well. */
2811 health_code_update();
2816 * Match function for a hash table lookup of ust_app_ctx.
2818 * It matches an ust app context based on the context type and, in the case
2819 * of perf counters, their name.
2821 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2823 struct ust_app_ctx
*ctx
;
2824 const struct lttng_ust_context_attr
*key
;
2829 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2830 key
= (lttng_ust_context_attr
*) _key
;
2833 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2838 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
2839 if (strncmp(key
->u
.perf_counter
.name
,
2840 ctx
->ctx
.u
.perf_counter
.name
,
2841 sizeof(key
->u
.perf_counter
.name
)) != 0) {
2845 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
2846 if (strcmp(key
->u
.app_ctx
.provider_name
, ctx
->ctx
.u
.app_ctx
.provider_name
) != 0 ||
2847 strcmp(key
->u
.app_ctx
.ctx_name
, ctx
->ctx
.u
.app_ctx
.ctx_name
) != 0) {
2863 * Lookup for an ust app context from an lttng_ust_context.
2865 * Must be called while holding RCU read side lock.
2866 * Return an ust_app_ctx object or NULL on error.
2868 static struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2869 struct lttng_ust_context_attr
*uctx
)
2871 struct lttng_ht_iter iter
;
2872 struct lttng_ht_node_ulong
*node
;
2873 struct ust_app_ctx
*app_ctx
= nullptr;
2877 ASSERT_RCU_READ_LOCKED();
2879 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2880 cds_lfht_lookup(ht
->ht
,
2881 ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2882 ht_match_ust_app_ctx
,
2885 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&iter
);
2890 app_ctx
= lttng::utils::container_of(node
, &ust_app_ctx::node
);
2897 * Create a context for the channel on the tracer.
2899 * Called with UST app session lock held and a RCU read side lock.
2901 static int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2902 struct lttng_ust_context_attr
*uctx
,
2903 struct ust_app
*app
)
2906 struct ust_app_ctx
*ua_ctx
;
2908 ASSERT_RCU_READ_LOCKED();
2910 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2912 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2918 ua_ctx
= alloc_ust_app_ctx(uctx
);
2919 if (ua_ctx
== nullptr) {
2925 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2926 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2927 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2929 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2939 * Enable on the tracer side a ust app event for the session and channel.
2941 * Called with UST app session lock held.
2943 static int enable_ust_app_event(struct ust_app_event
*ua_event
, struct ust_app
*app
)
2947 ret
= enable_ust_object(app
, ua_event
->obj
);
2952 ua_event
->enabled
= true;
2959 * Disable on the tracer side a ust app event for the session and channel.
2961 static int disable_ust_app_event(struct ust_app_event
*ua_event
, struct ust_app
*app
)
2965 ret
= disable_ust_object(app
, ua_event
->obj
);
2970 ua_event
->enabled
= false;
2977 * Lookup ust app channel for session and disable it on the tracer side.
2979 static int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2980 struct ust_app_channel
*ua_chan
,
2981 struct ust_app
*app
)
2985 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2990 ua_chan
->enabled
= false;
2997 * Lookup ust app channel for session and enable it on the tracer side. This
2998 * MUST be called with a RCU read side lock acquired.
3000 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
3001 struct ltt_ust_channel
*uchan
,
3002 struct ust_app
*app
)
3005 struct lttng_ht_iter iter
;
3006 struct lttng_ht_node_str
*ua_chan_node
;
3007 struct ust_app_channel
*ua_chan
;
3009 ASSERT_RCU_READ_LOCKED();
3011 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
3012 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&iter
);
3013 if (ua_chan_node
== nullptr) {
3014 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
3016 ua_sess
->tracing_id
);
3020 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
3022 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
3032 * Ask the consumer to create a channel and get it if successful.
3034 * Called with UST app session lock held.
3036 * Return 0 on success or else a negative value.
3038 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
3039 struct ust_app_session
*ua_sess
,
3040 struct ust_app_channel
*ua_chan
,
3042 lsu::registry_session
*registry
)
3045 unsigned int nb_fd
= 0;
3046 struct consumer_socket
*socket
;
3048 LTTNG_ASSERT(usess
);
3049 LTTNG_ASSERT(ua_sess
);
3050 LTTNG_ASSERT(ua_chan
);
3051 LTTNG_ASSERT(registry
);
3053 lttng::urcu::read_lock_guard read_lock
;
3054 health_code_update();
3056 /* Get the right consumer socket for the application. */
3057 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
3063 health_code_update();
3065 /* Need one fd for the channel. */
3066 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3068 ERR("Exhausted number of available FD upon create channel");
3073 * Ask consumer to create channel. The consumer will return the number of
3074 * stream we have to expect.
3076 ret
= ust_consumer_ask_channel(
3077 ua_sess
, ua_chan
, usess
->consumer
, socket
, registry
, usess
->current_trace_chunk
);
3083 * Compute the number of fd needed before receiving them. It must be 2 per
3084 * stream (2 being the default value here).
3086 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
3088 /* Reserve the amount of file descriptor we need. */
3089 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
3091 ERR("Exhausted number of available FD upon create channel");
3092 goto error_fd_get_stream
;
3095 health_code_update();
3098 * Now get the channel from the consumer. This call will populate the stream
3099 * list of that channel and set the ust objects.
3101 if (usess
->consumer
->enabled
) {
3102 ret
= ust_consumer_get_channel(socket
, ua_chan
);
3111 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
3112 error_fd_get_stream
:
3114 * Initiate a destroy channel on the consumer since we had an error
3115 * handling it on our side. The return value is of no importance since we
3116 * already have a ret value set by the previous error that we need to
3119 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
3121 lttng_fd_put(LTTNG_FD_APPS
, 1);
3123 health_code_update();
3128 * Duplicate the ust data object of the ust app stream and save it in the
3129 * buffer registry stream.
3131 * Return 0 on success or else a negative value.
3133 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
3134 struct ust_app_stream
*stream
)
3138 LTTNG_ASSERT(reg_stream
);
3139 LTTNG_ASSERT(stream
);
3141 /* Duplicating a stream requires 2 new fds. Reserve them. */
3142 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3144 ERR("Exhausted number of available FD upon duplicate stream");
3148 /* Duplicate object for stream once the original is in the registry. */
3149 ret
= lttng_ust_ctl_duplicate_ust_object_data(&stream
->obj
, reg_stream
->obj
.ust
);
3151 ERR("Duplicate stream obj from %p to %p failed with ret %d",
3152 reg_stream
->obj
.ust
,
3155 lttng_fd_put(LTTNG_FD_APPS
, 2);
3158 stream
->handle
= stream
->obj
->handle
;
3165 * Duplicate the ust data object of the ust app. channel and save it in the
3166 * buffer registry channel.
3168 * Return 0 on success or else a negative value.
3170 static int duplicate_channel_object(struct buffer_reg_channel
*buf_reg_chan
,
3171 struct ust_app_channel
*ua_chan
)
3175 LTTNG_ASSERT(buf_reg_chan
);
3176 LTTNG_ASSERT(ua_chan
);
3178 /* Duplicating a channel requires 1 new fd. Reserve it. */
3179 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3181 ERR("Exhausted number of available FD upon duplicate channel");
3185 /* Duplicate object for stream once the original is in the registry. */
3186 ret
= lttng_ust_ctl_duplicate_ust_object_data(&ua_chan
->obj
, buf_reg_chan
->obj
.ust
);
3188 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
3189 buf_reg_chan
->obj
.ust
,
3194 ua_chan
->handle
= ua_chan
->obj
->handle
;
3199 lttng_fd_put(LTTNG_FD_APPS
, 1);
3205 * For a given channel buffer registry, setup all streams of the given ust
3206 * application channel.
3208 * Return 0 on success or else a negative value.
3210 static int setup_buffer_reg_streams(struct buffer_reg_channel
*buf_reg_chan
,
3211 struct ust_app_channel
*ua_chan
,
3212 struct ust_app
*app
)
3215 struct ust_app_stream
*stream
, *stmp
;
3217 LTTNG_ASSERT(buf_reg_chan
);
3218 LTTNG_ASSERT(ua_chan
);
3220 DBG2("UST app setup buffer registry stream");
3222 /* Send all streams to application. */
3223 cds_list_for_each_entry_safe (stream
, stmp
, &ua_chan
->streams
.head
, list
) {
3224 struct buffer_reg_stream
*reg_stream
;
3226 ret
= buffer_reg_stream_create(®_stream
);
3232 * Keep original pointer and nullify it in the stream so the delete
3233 * stream call does not release the object.
3235 reg_stream
->obj
.ust
= stream
->obj
;
3236 stream
->obj
= nullptr;
3237 buffer_reg_stream_add(reg_stream
, buf_reg_chan
);
3239 /* We don't need the streams anymore. */
3240 cds_list_del(&stream
->list
);
3241 delete_ust_app_stream(-1, stream
, app
);
3249 * Create a buffer registry channel for the given session registry and
3250 * application channel object. If regp pointer is valid, it's set with the
3251 * created object. Important, the created object is NOT added to the session
3252 * registry hash table.
3254 * Return 0 on success else a negative value.
3256 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3257 struct ust_app_channel
*ua_chan
,
3258 struct buffer_reg_channel
**regp
)
3261 struct buffer_reg_channel
*buf_reg_chan
= nullptr;
3263 LTTNG_ASSERT(reg_sess
);
3264 LTTNG_ASSERT(ua_chan
);
3266 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3268 /* Create buffer registry channel. */
3269 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, &buf_reg_chan
);
3273 LTTNG_ASSERT(buf_reg_chan
);
3274 buf_reg_chan
->consumer_key
= ua_chan
->key
;
3275 buf_reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3276 buf_reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3278 /* Create and add a channel registry to session. */
3280 reg_sess
->reg
.ust
->add_channel(ua_chan
->tracing_channel_id
);
3281 } catch (const std::exception
& ex
) {
3282 ERR("Failed to add a channel registry to userspace registry session: %s",
3288 buffer_reg_channel_add(reg_sess
, buf_reg_chan
);
3291 *regp
= buf_reg_chan
;
3297 /* Safe because the registry channel object was not added to any HT. */
3298 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3304 * Setup buffer registry channel for the given session registry and application
3305 * channel object. If regp pointer is valid, it's set with the created object.
3307 * Return 0 on success else a negative value.
3309 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3310 struct ust_app_channel
*ua_chan
,
3311 struct buffer_reg_channel
*buf_reg_chan
,
3312 struct ust_app
*app
)
3316 LTTNG_ASSERT(reg_sess
);
3317 LTTNG_ASSERT(buf_reg_chan
);
3318 LTTNG_ASSERT(ua_chan
);
3319 LTTNG_ASSERT(ua_chan
->obj
);
3321 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3323 /* Setup all streams for the registry. */
3324 ret
= setup_buffer_reg_streams(buf_reg_chan
, ua_chan
, app
);
3329 buf_reg_chan
->obj
.ust
= ua_chan
->obj
;
3330 ua_chan
->obj
= nullptr;
3335 buffer_reg_channel_remove(reg_sess
, buf_reg_chan
);
3336 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3341 * Send buffer registry channel to the application.
3343 * Return 0 on success else a negative value.
3345 static int send_channel_uid_to_ust(struct buffer_reg_channel
*buf_reg_chan
,
3346 struct ust_app
*app
,
3347 struct ust_app_session
*ua_sess
,
3348 struct ust_app_channel
*ua_chan
)
3351 struct buffer_reg_stream
*reg_stream
;
3353 LTTNG_ASSERT(buf_reg_chan
);
3355 LTTNG_ASSERT(ua_sess
);
3356 LTTNG_ASSERT(ua_chan
);
3358 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3360 ret
= duplicate_channel_object(buf_reg_chan
, ua_chan
);
3365 /* Send channel to the application. */
3366 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3367 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3368 ret
= -ENOTCONN
; /* Caused by app exiting. */
3370 } else if (ret
== -EAGAIN
) {
3371 /* Caused by timeout. */
3372 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
3376 ua_sess
->tracing_id
);
3377 /* Treat this the same way as an application that is exiting. */
3380 } else if (ret
< 0) {
3384 health_code_update();
3386 /* Send all streams to application. */
3387 pthread_mutex_lock(&buf_reg_chan
->stream_list_lock
);
3388 cds_list_for_each_entry (reg_stream
, &buf_reg_chan
->streams
, lnode
) {
3389 struct ust_app_stream stream
= {};
3391 ret
= duplicate_stream_object(reg_stream
, &stream
);
3393 goto error_stream_unlock
;
3396 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3398 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3399 ret
= -ENOTCONN
; /* Caused by app exiting. */
3400 } else if (ret
== -EAGAIN
) {
3402 * Caused by timeout.
3403 * Treat this the same way as an application
3406 WARN("Communication with application %d timed out on send_stream for stream of channel \"%s\" of session \"%" PRIu64
3410 ua_sess
->tracing_id
);
3413 (void) release_ust_app_stream(-1, &stream
, app
);
3414 goto error_stream_unlock
;
3418 * The return value is not important here. This function will output an
3421 (void) release_ust_app_stream(-1, &stream
, app
);
3424 error_stream_unlock
:
3425 pthread_mutex_unlock(&buf_reg_chan
->stream_list_lock
);
3431 * Create and send to the application the created buffers with per UID buffers.
3433 * This MUST be called with a RCU read side lock acquired.
3434 * The session list lock and the session's lock must be acquired.
3436 * Return 0 on success else a negative value.
3438 static int create_channel_per_uid(struct ust_app
*app
,
3439 struct ltt_ust_session
*usess
,
3440 struct ust_app_session
*ua_sess
,
3441 struct ust_app_channel
*ua_chan
)
3444 struct buffer_reg_uid
*reg_uid
;
3445 struct buffer_reg_channel
*buf_reg_chan
;
3446 enum lttng_error_code notification_ret
;
3449 LTTNG_ASSERT(usess
);
3450 LTTNG_ASSERT(ua_sess
);
3451 LTTNG_ASSERT(ua_chan
);
3452 ASSERT_RCU_READ_LOCKED();
3454 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3456 /* Guaranteed to exist; will not throw. */
3457 const auto session
= ltt_session::find_session(ua_sess
->tracing_id
);
3458 ASSERT_SESSION_LIST_LOCKED();
3460 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->abi
.bits_per_long
, app
->uid
);
3462 * The session creation handles the creation of this global registry
3463 * object. If none can be find, there is a code flow problem or a
3466 LTTNG_ASSERT(reg_uid
);
3468 buf_reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
, reg_uid
);
3473 /* Create the buffer registry channel object. */
3474 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, &buf_reg_chan
);
3476 ERR("Error creating the UST channel \"%s\" registry instance", ua_chan
->name
);
3481 * Create the buffers on the consumer side. This call populates the
3482 * ust app channel object with all streams and data object.
3484 ret
= do_consumer_create_channel(
3485 usess
, ua_sess
, ua_chan
, app
->abi
.bits_per_long
, reg_uid
->registry
->reg
.ust
);
3487 ERR("Error creating UST channel \"%s\" on the consumer daemon", ua_chan
->name
);
3490 * Let's remove the previously created buffer registry channel so
3491 * it's not visible anymore in the session registry.
3493 auto locked_registry
= reg_uid
->registry
->reg
.ust
->lock();
3495 locked_registry
->remove_channel(ua_chan
->tracing_channel_id
, false);
3496 } catch (const std::exception
& ex
) {
3497 DBG("Could not find channel for removal: %s", ex
.what());
3499 buffer_reg_channel_remove(reg_uid
->registry
, buf_reg_chan
);
3500 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3505 * Setup the streams and add it to the session registry.
3507 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, buf_reg_chan
, app
);
3509 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3514 auto locked_registry
= reg_uid
->registry
->reg
.ust
->lock();
3515 auto& ust_reg_chan
= locked_registry
->channel(ua_chan
->tracing_channel_id
);
3517 ust_reg_chan
._consumer_key
= ua_chan
->key
;
3520 /* Notify the notification subsystem of the channel's creation. */
3521 notification_ret
= notification_thread_command_add_channel(
3522 the_notification_thread_handle
,
3527 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3528 if (notification_ret
!= LTTNG_OK
) {
3529 ret
= -(int) notification_ret
;
3530 ERR("Failed to add channel to notification thread");
3535 /* Send buffers to the application. */
3536 ret
= send_channel_uid_to_ust(buf_reg_chan
, app
, ua_sess
, ua_chan
);
3538 if (ret
!= -ENOTCONN
) {
3539 ERR("Error sending channel to application");
3549 * Create and send to the application the created buffers with per PID buffers.
3551 * Called with UST app session lock held.
3552 * The session list lock and the session's lock must be acquired.
3554 * Return 0 on success else a negative value.
3556 static int create_channel_per_pid(struct ust_app
*app
,
3557 struct ltt_ust_session
*usess
,
3558 struct ust_app_session
*ua_sess
,
3559 struct ust_app_channel
*ua_chan
)
3562 lsu::registry_session
*registry
;
3563 enum lttng_error_code cmd_ret
;
3564 uint64_t chan_reg_key
;
3567 LTTNG_ASSERT(usess
);
3568 LTTNG_ASSERT(ua_sess
);
3569 LTTNG_ASSERT(ua_chan
);
3571 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3573 lttng::urcu::read_lock_guard read_lock
;
3575 registry
= get_session_registry(ua_sess
);
3576 /* The UST app session lock is held, registry shall not be null. */
3577 LTTNG_ASSERT(registry
);
3579 /* Guaranteed to exist; will not throw. */
3580 const auto session
= ltt_session::find_session(ua_sess
->tracing_id
);
3581 ASSERT_LOCKED(session
->_lock
);
3582 ASSERT_SESSION_LIST_LOCKED();
3584 /* Create and add a new channel registry to session. */
3586 registry
->add_channel(ua_chan
->key
);
3587 } catch (const std::exception
& ex
) {
3588 ERR("Error creating the UST channel \"%s\" registry instance: %s",
3595 /* Create and get channel on the consumer side. */
3596 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
, app
->abi
.bits_per_long
, registry
);
3598 ERR("Error creating UST channel \"%s\" on the consumer daemon", ua_chan
->name
);
3599 goto error_remove_from_registry
;
3602 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3604 if (ret
!= -ENOTCONN
) {
3605 ERR("Error sending channel to application");
3607 goto error_remove_from_registry
;
3610 chan_reg_key
= ua_chan
->key
;
3612 auto locked_registry
= registry
->lock();
3614 auto& ust_reg_chan
= locked_registry
->channel(chan_reg_key
);
3615 ust_reg_chan
._consumer_key
= ua_chan
->key
;
3618 cmd_ret
= notification_thread_command_add_channel(the_notification_thread_handle
,
3623 ua_chan
->attr
.subbuf_size
*
3624 ua_chan
->attr
.num_subbuf
);
3625 if (cmd_ret
!= LTTNG_OK
) {
3626 ret
= -(int) cmd_ret
;
3627 ERR("Failed to add channel to notification thread");
3628 goto error_remove_from_registry
;
3631 error_remove_from_registry
:
3634 auto locked_registry
= registry
->lock();
3635 locked_registry
->remove_channel(ua_chan
->key
, false);
3636 } catch (const std::exception
& ex
) {
3637 DBG("Could not find channel for removal: %s", ex
.what());
3645 * From an already allocated ust app channel, create the channel buffers if
3646 * needed and send them to the application. This MUST be called with a RCU read
3647 * side lock acquired.
3649 * Called with UST app session lock held.
3651 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3652 * the application exited concurrently.
3654 static int ust_app_channel_send(struct ust_app
*app
,
3655 struct ltt_ust_session
*usess
,
3656 struct ust_app_session
*ua_sess
,
3657 struct ust_app_channel
*ua_chan
)
3662 LTTNG_ASSERT(usess
);
3663 LTTNG_ASSERT(usess
->active
);
3664 LTTNG_ASSERT(ua_sess
);
3665 LTTNG_ASSERT(ua_chan
);
3666 ASSERT_RCU_READ_LOCKED();
3668 /* Handle buffer type before sending the channel to the application. */
3669 switch (usess
->buffer_type
) {
3670 case LTTNG_BUFFER_PER_UID
:
3672 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3678 case LTTNG_BUFFER_PER_PID
:
3680 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3692 /* Initialize ust objd object using the received handle and add it. */
3693 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3694 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3696 /* If channel is not enabled, disable it on the tracer */
3697 if (!ua_chan
->enabled
) {
3698 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3709 * Create UST app channel and return it through ua_chanp if not NULL.
3711 * Called with UST app session lock and RCU read-side lock held.
3713 * Return 0 on success or else a negative value.
3715 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3716 struct ltt_ust_channel
*uchan
,
3717 enum lttng_ust_abi_chan_type type
,
3718 struct ltt_ust_session
*usess
__attribute__((unused
)),
3719 struct ust_app_channel
**ua_chanp
)
3722 struct lttng_ht_iter iter
;
3723 struct lttng_ht_node_str
*ua_chan_node
;
3724 struct ust_app_channel
*ua_chan
;
3726 ASSERT_RCU_READ_LOCKED();
3728 /* Lookup channel in the ust app session */
3729 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
3730 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&iter
);
3731 if (ua_chan_node
!= nullptr) {
3732 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
3736 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3737 if (ua_chan
== nullptr) {
3738 /* Only malloc can fail here */
3742 shadow_copy_channel(ua_chan
, uchan
);
3744 /* Set channel type. */
3745 ua_chan
->attr
.type
= type
;
3747 /* Only add the channel if successful on the tracer side. */
3748 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3751 *ua_chanp
= ua_chan
;
3754 /* Everything went well. */
3762 * Create UST app event and create it on the tracer side.
3764 * Must be called with the RCU read side lock held.
3765 * Called with ust app session mutex held.
3767 static int create_ust_app_event(struct ust_app_channel
*ua_chan
,
3768 struct ltt_ust_event
*uevent
,
3769 struct ust_app
*app
)
3772 struct ust_app_event
*ua_event
;
3774 ASSERT_RCU_READ_LOCKED();
3776 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3777 if (ua_event
== nullptr) {
3778 /* Only failure mode of alloc_ust_app_event(). */
3782 shadow_copy_event(ua_event
, uevent
);
3784 /* Create it on the tracer side */
3785 ret
= create_ust_event(app
, ua_chan
, ua_event
);
3788 * Not found previously means that it does not exist on the
3789 * tracer. If the application reports that the event existed,
3790 * it means there is a bug in the sessiond or lttng-ust
3791 * (or corruption, etc.)
3793 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3794 ERR("Tracer for application reported that an event being created already existed: "
3795 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3805 add_unique_ust_app_event(ua_chan
, ua_event
);
3807 DBG2("UST app create event completed: app = '%s' pid = %d", app
->name
, app
->pid
);
3813 /* Valid. Calling here is already in a read side lock */
3814 delete_ust_app_event(-1, ua_event
, app
);
3819 * Create UST app event notifier rule and create it on the tracer side.
3821 * Must be called with the RCU read side lock held.
3822 * Called with ust app session mutex held.
3824 static int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
, struct ust_app
*app
)
3827 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3829 ASSERT_RCU_READ_LOCKED();
3831 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3832 if (ua_event_notifier_rule
== nullptr) {
3837 /* Create it on the tracer side. */
3838 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3841 * Not found previously means that it does not exist on the
3842 * tracer. If the application reports that the event existed,
3843 * it means there is a bug in the sessiond or lttng-ust
3844 * (or corruption, etc.)
3846 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3847 ERR("Tracer for application reported that an event notifier being created already exists: "
3848 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3849 lttng_trigger_get_tracer_token(trigger
),
3858 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3859 &ua_event_notifier_rule
->node
);
3861 DBG2("UST app create token event rule completed: app = '%s', pid = %d, token = %" PRIu64
,
3864 lttng_trigger_get_tracer_token(trigger
));
3869 /* The RCU read side lock is already being held by the caller. */
3870 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3876 * Create UST metadata and open it on the tracer side.
3878 * Called with UST app session lock held and RCU read side lock.
3880 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3881 struct ust_app
*app
,
3882 struct consumer_output
*consumer
)
3885 struct ust_app_channel
*metadata
;
3886 struct consumer_socket
*socket
;
3888 LTTNG_ASSERT(ua_sess
);
3890 LTTNG_ASSERT(consumer
);
3891 ASSERT_RCU_READ_LOCKED();
3893 auto locked_registry
= get_locked_session_registry(ua_sess
);
3894 /* The UST app session is held registry shall not be null. */
3895 LTTNG_ASSERT(locked_registry
);
3897 /* Guaranteed to exist; will not throw. */
3898 const auto session
= ltt_session::find_session(ua_sess
->tracing_id
);
3899 ASSERT_LOCKED(session
->_lock
);
3900 ASSERT_SESSION_LIST_LOCKED();
3902 /* Metadata already exists for this registry or it was closed previously */
3903 if (locked_registry
->_metadata_key
|| locked_registry
->_metadata_closed
) {
3908 /* Allocate UST metadata */
3909 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, nullptr);
3911 /* malloc() failed */
3916 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3918 /* Need one fd for the channel. */
3919 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3921 ERR("Exhausted number of available FD upon create metadata");
3925 /* Get the right consumer socket for the application. */
3926 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, consumer
);
3929 goto error_consumer
;
3933 * Keep metadata key so we can identify it on the consumer side. Assign it
3934 * to the registry *before* we ask the consumer so we avoid the race of the
3935 * consumer requesting the metadata and the ask_channel call on our side
3936 * did not returned yet.
3938 locked_registry
->_metadata_key
= metadata
->key
;
3941 * Ask the metadata channel creation to the consumer. The metadata object
3942 * will be created by the consumer and kept their. However, the stream is
3943 * never added or monitored until we do a first push metadata to the
3946 ret
= ust_consumer_ask_channel(ua_sess
,
3950 locked_registry
.get(),
3951 session
->current_trace_chunk
);
3953 /* Nullify the metadata key so we don't try to close it later on. */
3954 locked_registry
->_metadata_key
= 0;
3955 goto error_consumer
;
3959 * The setup command will make the metadata stream be sent to the relayd,
3960 * if applicable, and the thread managing the metadatas. This is important
3961 * because after this point, if an error occurs, the only way the stream
3962 * can be deleted is to be monitored in the consumer.
3964 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3966 /* Nullify the metadata key so we don't try to close it later on. */
3967 locked_registry
->_metadata_key
= 0;
3968 goto error_consumer
;
3971 DBG2("UST metadata with key %" PRIu64
" created for app pid %d", metadata
->key
, app
->pid
);
3974 lttng_fd_put(LTTNG_FD_APPS
, 1);
3975 delete_ust_app_channel(-1, metadata
, app
, locked_registry
);
3981 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3982 * acquired before calling this function.
3984 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3986 struct ust_app
*app
= nullptr;
3987 struct lttng_ht_node_ulong
*node
;
3988 struct lttng_ht_iter iter
;
3990 lttng_ht_lookup(ust_app_ht
, (void *) ((unsigned long) pid
), &iter
);
3991 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&iter
);
3992 if (node
== nullptr) {
3993 DBG2("UST app no found with pid %d", pid
);
3997 DBG2("Found UST app by pid %d", pid
);
3999 app
= lttng::utils::container_of(node
, &ust_app::pid_n
);
4006 * Allocate and init an UST app object using the registration information and
4007 * the command socket. This is called when the command socket connects to the
4010 * The object is returned on success or else NULL.
4012 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
4015 struct ust_app
*lta
= nullptr;
4016 struct lttng_pipe
*event_notifier_event_source_pipe
= nullptr;
4019 LTTNG_ASSERT(sock
>= 0);
4021 DBG3("UST app creating application for socket %d", sock
);
4023 if ((msg
->bits_per_long
== 64 && (uatomic_read(&the_ust_consumerd64_fd
) == -EINVAL
)) ||
4024 (msg
->bits_per_long
== 32 && (uatomic_read(&the_ust_consumerd32_fd
) == -EINVAL
))) {
4025 ERR("Registration failed: application \"%s\" (pid: %d) has "
4026 "%d-bit long, but no consumerd for this size is available.\n",
4029 msg
->bits_per_long
);
4034 * Reserve the two file descriptors of the event source pipe. The write
4035 * end will be closed once it is passed to the application, at which
4036 * point a single 'put' will be performed.
4038 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
4040 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s', pid = %d",
4046 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
4047 if (!event_notifier_event_source_pipe
) {
4048 PERROR("Failed to open application event source pipe: '%s' (pid = %d)",
4054 lta
= zmalloc
<ust_app
>();
4055 if (lta
== nullptr) {
4057 goto error_free_pipe
;
4060 urcu_ref_init(<a
->ref
);
4062 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
4064 lta
->ppid
= msg
->ppid
;
4065 lta
->uid
= msg
->uid
;
4066 lta
->gid
= msg
->gid
;
4069 .bits_per_long
= msg
->bits_per_long
,
4070 .long_alignment
= msg
->long_alignment
,
4071 .uint8_t_alignment
= msg
->uint8_t_alignment
,
4072 .uint16_t_alignment
= msg
->uint16_t_alignment
,
4073 .uint32_t_alignment
= msg
->uint32_t_alignment
,
4074 .uint64_t_alignment
= msg
->uint64_t_alignment
,
4075 .byte_order
= msg
->byte_order
== LITTLE_ENDIAN
?
4076 lttng::sessiond::trace::byte_order::LITTLE_ENDIAN_
:
4077 lttng::sessiond::trace::byte_order::BIG_ENDIAN_
,
4080 lta
->v_major
= msg
->major
;
4081 lta
->v_minor
= msg
->minor
;
4082 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4083 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4084 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4085 lta
->notify_sock
= -1;
4086 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4088 /* Copy name and make sure it's NULL terminated. */
4089 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
4090 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
4093 * Before this can be called, when receiving the registration information,
4094 * the application compatibility is checked. So, at this point, the
4095 * application can work with this session daemon.
4097 lta
->compatible
= 1;
4099 lta
->pid
= msg
->pid
;
4100 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
4102 pthread_mutex_init(<a
->sock_lock
, nullptr);
4103 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
4105 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
4109 lttng_pipe_destroy(event_notifier_event_source_pipe
);
4110 lttng_fd_put(LTTNG_FD_APPS
, 2);
4116 * For a given application object, add it to every hash table.
4118 void ust_app_add(struct ust_app
*app
)
4121 LTTNG_ASSERT(app
->notify_sock
>= 0);
4123 app
->registration_time
= time(nullptr);
4125 lttng::urcu::read_lock_guard read_lock
;
4128 * On a re-registration, we want to kick out the previous registration of
4131 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
4134 * The socket _should_ be unique until _we_ call close. So, a add_unique
4135 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
4136 * already in the table.
4138 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
4140 /* Add application to the notify socket hash table. */
4141 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
4142 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
4144 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock =%d name:%s "
4145 "notify_sock =%d (version %d.%d)",
4158 * Set the application version into the object.
4160 * Return 0 on success else a negative value either an errno code or a
4161 * LTTng-UST error code.
4163 int ust_app_version(struct ust_app
*app
)
4169 pthread_mutex_lock(&app
->sock_lock
);
4170 ret
= lttng_ust_ctl_tracer_version(app
->sock
, &app
->version
);
4171 pthread_mutex_unlock(&app
->sock_lock
);
4173 if (ret
== -LTTNG_UST_ERR_EXITING
|| ret
== -EPIPE
) {
4174 DBG3("UST app version failed. Application is dead: pid = %d, sock = %d",
4177 } else if (ret
== -EAGAIN
) {
4178 WARN("UST app version failed. Communication time out: pid = %d, sock = %d",
4182 ERR("UST app version failed with ret %d: pid = %d, sock = %d",
4192 bool ust_app_supports_notifiers(const struct ust_app
*app
)
4194 return app
->v_major
>= 9;
4197 bool ust_app_supports_counters(const struct ust_app
*app
)
4199 return app
->v_major
>= 9;
4203 * Setup the base event notifier group.
4205 * Return 0 on success else a negative value either an errno code or a
4206 * LTTng-UST error code.
4208 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
4211 int event_pipe_write_fd
;
4212 struct lttng_ust_abi_object_data
*event_notifier_group
= nullptr;
4213 enum lttng_error_code lttng_ret
;
4214 enum event_notifier_error_accounting_status event_notifier_error_accounting_status
;
4218 if (!ust_app_supports_notifiers(app
)) {
4223 /* Get the write side of the pipe. */
4224 event_pipe_write_fd
= lttng_pipe_get_writefd(app
->event_notifier_group
.event_pipe
);
4226 pthread_mutex_lock(&app
->sock_lock
);
4227 ret
= lttng_ust_ctl_create_event_notifier_group(
4228 app
->sock
, event_pipe_write_fd
, &event_notifier_group
);
4229 pthread_mutex_unlock(&app
->sock_lock
);
4231 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4233 DBG3("UST app create event notifier group failed. Application is dead: pid = %d, sock = %d",
4236 } else if (ret
== -EAGAIN
) {
4238 WARN("UST app create event notifier group failed. Communication time out: pid = %d, sock = %d",
4242 ERR("UST app create event notifier group failed with ret %d: pid = %d, sock = %d, event_pipe_write_fd: %d",
4246 event_pipe_write_fd
);
4251 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
4253 ERR("Failed to close write end of the application's event source pipe: app = '%s' (pid = %d)",
4260 * Release the file descriptor that was reserved for the write-end of
4263 lttng_fd_put(LTTNG_FD_APPS
, 1);
4265 lttng_ret
= notification_thread_command_add_tracer_event_source(
4266 the_notification_thread_handle
,
4267 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
),
4269 if (lttng_ret
!= LTTNG_OK
) {
4270 ERR("Failed to add tracer event source to notification thread");
4275 /* Assign handle only when the complete setup is valid. */
4276 app
->event_notifier_group
.object
= event_notifier_group
;
4278 event_notifier_error_accounting_status
= event_notifier_error_accounting_register_app(app
);
4279 switch (event_notifier_error_accounting_status
) {
4280 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
4282 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_UNSUPPORTED
:
4283 DBG3("Failed to setup event notifier error accounting (application does not support notifier error accounting): app socket fd = %d, app name = '%s', app pid = %d",
4288 goto error_accounting
;
4289 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
:
4290 DBG3("Failed to setup event notifier error accounting (application is dead): app socket fd = %d, app name = '%s', app pid = %d",
4295 goto error_accounting
;
4297 ERR("Failed to setup event notifier error accounting for app");
4299 goto error_accounting
;
4305 lttng_ret
= notification_thread_command_remove_tracer_event_source(
4306 the_notification_thread_handle
,
4307 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
));
4308 if (lttng_ret
!= LTTNG_OK
) {
4309 ERR("Failed to remove application tracer event source from notification thread");
4313 lttng_ust_ctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
4314 free(app
->event_notifier_group
.object
);
4315 app
->event_notifier_group
.object
= nullptr;
4319 static void ust_app_unregister(ust_app
& app
)
4321 struct lttng_ht_iter iter
;
4322 struct ust_app_session
*ua_sess
;
4324 lttng::urcu::read_lock_guard read_lock
;
4327 * For per-PID buffers, perform "push metadata" and flush all
4328 * application streams before removing app from hash tables,
4329 * ensuring proper behavior of data_pending check.
4330 * Remove sessions so they are not visible during deletion.
4332 cds_lfht_for_each_entry (app
.sessions
->ht
, &iter
.iter
, ua_sess
, node
.node
) {
4333 const auto del_ret
= lttng_ht_del(app
.sessions
, &iter
);
4335 /* The session was already removed so scheduled for teardown. */
4339 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
4340 (void) ust_app_flush_app_session(app
, *ua_sess
);
4344 * Add session to list for teardown. This is safe since at this point we
4345 * are the only one using this list.
4347 auto locked_ua_sess
= ua_sess
->lock();
4349 if (ua_sess
->deleted
) {
4354 * Normally, this is done in the delete session process which is
4355 * executed in the call rcu below. However, upon registration we can't
4356 * afford to wait for the grace period before pushing data or else the
4357 * data pending feature can race between the unregistration and stop
4358 * command where the data pending command is sent *before* the grace
4361 * The close metadata below nullifies the metadata pointer in the
4362 * session so the delete session will NOT push/close a second time.
4364 auto locked_registry
= get_locked_session_registry(ua_sess
);
4365 if (locked_registry
) {
4366 /* Push metadata for application before freeing the application. */
4367 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
4370 * Don't ask to close metadata for global per UID buffers. Close
4371 * metadata only on destroy trace session in this case. Also, the
4372 * previous push metadata could have flag the metadata registry to
4373 * close so don't send a close command if closed.
4375 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4376 const auto metadata_key
= locked_registry
->_metadata_key
;
4377 const auto consumer_bitness
= locked_registry
->abi
.bits_per_long
;
4379 if (!locked_registry
->_metadata_closed
&& metadata_key
!= 0) {
4380 locked_registry
->_metadata_closed
= true;
4383 /* Release lock before communication, see comments in
4384 * close_metadata(). */
4385 locked_registry
.reset();
4386 (void) close_metadata(
4387 metadata_key
, consumer_bitness
, ua_sess
->consumer
);
4389 locked_registry
.reset();
4393 cds_list_add(&ua_sess
->teardown_node
, &app
.teardown_head
);
4397 * Remove application from notify hash table. The thread handling the
4398 * notify socket could have deleted the node so ignore on error because
4399 * either way it's valid. The close of that socket is handled by the
4400 * apps_notify_thread.
4402 iter
.iter
.node
= &app
.notify_sock_n
.node
;
4403 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4406 * Ignore return value since the node might have been removed before by an
4407 * add replace during app registration because the PID can be reassigned by
4410 iter
.iter
.node
= &app
.pid_n
.node
;
4411 if (lttng_ht_del(ust_app_ht
, &iter
)) {
4412 DBG3("Unregister app by PID %d failed. This can happen on pid reuse", app
.pid
);
4417 * Unregister app by removing it from the global traceable app list and freeing
4420 * The socket is already closed at this point, so there is no need to close it.
4422 void ust_app_unregister_by_socket(int sock_fd
)
4424 struct ust_app
*app
;
4425 struct lttng_ht_node_ulong
*node
;
4426 struct lttng_ht_iter ust_app_sock_iter
;
4429 lttng::urcu::read_lock_guard read_lock
;
4431 /* Get the node reference for a call_rcu */
4432 lttng_ht_lookup(ust_app_ht_by_sock
, (void *) ((unsigned long) sock_fd
), &ust_app_sock_iter
);
4433 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&ust_app_sock_iter
);
4436 app
= caa_container_of(node
, struct ust_app
, sock_n
);
4438 DBG_FMT("Application unregistering after socket activity: pid={}, socket_fd={}",
4442 /* Remove application from socket hash table */
4443 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4447 * The socket is closed: release its reference to the application
4448 * to trigger its eventual teardown.
4454 * Fill events array with all events name of all registered apps.
4456 int ust_app_list_events(struct lttng_event
**events
)
4459 size_t nbmem
, count
= 0;
4460 struct lttng_ht_iter iter
;
4461 struct ust_app
*app
;
4462 struct lttng_event
*tmp_event
;
4464 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4465 tmp_event
= calloc
<lttng_event
>(nbmem
);
4466 if (tmp_event
== nullptr) {
4467 PERROR("zmalloc ust app events");
4473 lttng::urcu::read_lock_guard read_lock
;
4475 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4476 struct lttng_ust_abi_tracepoint_iter uiter
;
4478 health_code_update();
4480 if (!app
->compatible
) {
4482 * TODO: In time, we should notice the caller of this error by
4483 * telling him that this is a version error.
4488 pthread_mutex_lock(&app
->sock_lock
);
4489 handle
= lttng_ust_ctl_tracepoint_list(app
->sock
);
4491 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4492 ERR("UST app list events getting handle failed for app pid %d",
4495 pthread_mutex_unlock(&app
->sock_lock
);
4499 while ((ret
= lttng_ust_ctl_tracepoint_list_get(
4500 app
->sock
, handle
, &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4501 /* Handle ustctl error. */
4505 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4506 ERR("UST app tp list get failed for app %d with ret %d",
4510 DBG3("UST app tp list get failed. Application is dead");
4516 lttng_ust_ctl_release_handle(app
->sock
, handle
);
4517 if (release_ret
< 0 &&
4518 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4519 release_ret
!= -EPIPE
) {
4520 ERR("Error releasing app handle for app %d with ret %d",
4525 pthread_mutex_unlock(&app
->sock_lock
);
4529 health_code_update();
4530 if (count
>= nbmem
) {
4531 /* In case the realloc fails, we free the memory */
4532 struct lttng_event
*new_tmp_event
;
4535 new_nbmem
= nbmem
<< 1;
4536 DBG2("Reallocating event list from %zu to %zu entries",
4539 new_tmp_event
= (lttng_event
*) realloc(
4540 tmp_event
, new_nbmem
* sizeof(struct lttng_event
));
4541 if (new_tmp_event
== nullptr) {
4544 PERROR("realloc ust app events");
4547 release_ret
= lttng_ust_ctl_release_handle(
4549 if (release_ret
< 0 &&
4550 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4551 release_ret
!= -EPIPE
) {
4552 ERR("Error releasing app handle for app %d with ret %d",
4557 pthread_mutex_unlock(&app
->sock_lock
);
4560 /* Zero the new memory */
4561 memset(new_tmp_event
+ nbmem
,
4563 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4565 tmp_event
= new_tmp_event
;
4568 memcpy(tmp_event
[count
].name
,
4570 LTTNG_UST_ABI_SYM_NAME_LEN
);
4571 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4572 tmp_event
[count
].type
=
4573 (enum lttng_event_type
) LTTNG_UST_ABI_TRACEPOINT
;
4574 tmp_event
[count
].pid
= app
->pid
;
4575 tmp_event
[count
].enabled
= -1;
4579 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4580 pthread_mutex_unlock(&app
->sock_lock
);
4582 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4583 DBG3("Error releasing app handle. Application died: pid = %d, sock = %d",
4586 } else if (ret
== -EAGAIN
) {
4587 WARN("Error releasing app handle. Communication time out: pid = %d, sock = %d",
4591 ERR("Error releasing app handle with ret %d: pid = %d, sock = %d",
4601 *events
= tmp_event
;
4603 DBG2("UST app list events done (%zu events)", count
);
4607 health_code_update();
4612 * Fill events array with all events name of all registered apps.
4614 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4617 size_t nbmem
, count
= 0;
4618 struct lttng_ht_iter iter
;
4619 struct ust_app
*app
;
4620 struct lttng_event_field
*tmp_event
;
4622 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4623 tmp_event
= calloc
<lttng_event_field
>(nbmem
);
4624 if (tmp_event
== nullptr) {
4625 PERROR("zmalloc ust app event fields");
4631 lttng::urcu::read_lock_guard read_lock
;
4633 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4634 struct lttng_ust_abi_field_iter uiter
;
4636 health_code_update();
4638 if (!app
->compatible
) {
4640 * TODO: In time, we should notice the caller of this error by
4641 * telling him that this is a version error.
4646 pthread_mutex_lock(&app
->sock_lock
);
4647 handle
= lttng_ust_ctl_tracepoint_field_list(app
->sock
);
4649 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4650 ERR("UST app list field getting handle failed for app pid %d",
4653 pthread_mutex_unlock(&app
->sock_lock
);
4657 while ((ret
= lttng_ust_ctl_tracepoint_field_list_get(
4658 app
->sock
, handle
, &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4659 /* Handle ustctl error. */
4663 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4664 ERR("UST app tp list field failed for app %d with ret %d",
4668 DBG3("UST app tp list field failed. Application is dead");
4674 lttng_ust_ctl_release_handle(app
->sock
, handle
);
4675 pthread_mutex_unlock(&app
->sock_lock
);
4676 if (release_ret
< 0 &&
4677 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4678 release_ret
!= -EPIPE
) {
4679 ERR("Error releasing app handle for app %d with ret %d",
4687 health_code_update();
4688 if (count
>= nbmem
) {
4689 /* In case the realloc fails, we free the memory */
4690 struct lttng_event_field
*new_tmp_event
;
4693 new_nbmem
= nbmem
<< 1;
4694 DBG2("Reallocating event field list from %zu to %zu entries",
4697 new_tmp_event
= (lttng_event_field
*) realloc(
4699 new_nbmem
* sizeof(struct lttng_event_field
));
4700 if (new_tmp_event
== nullptr) {
4703 PERROR("realloc ust app event fields");
4706 release_ret
= lttng_ust_ctl_release_handle(
4708 pthread_mutex_unlock(&app
->sock_lock
);
4710 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4711 release_ret
!= -EPIPE
) {
4712 ERR("Error releasing app handle for app %d with ret %d",
4720 /* Zero the new memory */
4721 memset(new_tmp_event
+ nbmem
,
4723 (new_nbmem
- nbmem
) *
4724 sizeof(struct lttng_event_field
));
4726 tmp_event
= new_tmp_event
;
4729 memcpy(tmp_event
[count
].field_name
,
4731 LTTNG_UST_ABI_SYM_NAME_LEN
);
4732 /* Mapping between these enums matches 1 to 1. */
4733 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4734 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4736 memcpy(tmp_event
[count
].event
.name
,
4738 LTTNG_UST_ABI_SYM_NAME_LEN
);
4739 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4740 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4741 tmp_event
[count
].event
.pid
= app
->pid
;
4742 tmp_event
[count
].event
.enabled
= -1;
4746 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4747 pthread_mutex_unlock(&app
->sock_lock
);
4748 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4749 ERR("Error releasing app handle for app %d with ret %d",
4757 *fields
= tmp_event
;
4759 DBG2("UST app list event fields done (%zu events)", count
);
4763 health_code_update();
4768 * Free and clean all traceable apps of the global list.
4770 void ust_app_clean_list()
4773 struct ust_app
*app
;
4774 struct lttng_ht_iter iter
;
4776 DBG2("UST app cleaning registered apps hash table");
4778 /* Cleanup notify socket hash table */
4779 if (ust_app_ht_by_notify_sock
) {
4780 lttng::urcu::read_lock_guard read_lock
;
4782 cds_lfht_for_each_entry (
4783 ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
, notify_sock_n
.node
) {
4785 * Assert that all notifiers are gone as all triggers
4786 * are unregistered prior to this clean-up.
4788 LTTNG_ASSERT(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4789 ust_app_notify_sock_unregister(app
->notify_sock
);
4793 /* Cleanup socket hash table */
4794 if (ust_app_ht_by_sock
) {
4795 lttng::urcu::read_lock_guard read_lock
;
4797 cds_lfht_for_each_entry (ust_app_ht_by_sock
->ht
, &iter
.iter
, app
, sock_n
.node
) {
4798 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4804 /* Destroy is done only when the ht is empty */
4806 lttng_ht_destroy(ust_app_ht
);
4808 if (ust_app_ht_by_sock
) {
4809 lttng_ht_destroy(ust_app_ht_by_sock
);
4811 if (ust_app_ht_by_notify_sock
) {
4812 lttng_ht_destroy(ust_app_ht_by_notify_sock
);
4817 * Init UST app hash table.
4819 int ust_app_ht_alloc()
4821 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4825 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4826 if (!ust_app_ht_by_sock
) {
4829 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4830 if (!ust_app_ht_by_notify_sock
) {
4837 * For a specific UST session, disable the channel for all registered apps.
4839 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
, struct ltt_ust_channel
*uchan
)
4842 struct lttng_ht_iter iter
;
4843 struct lttng_ht_node_str
*ua_chan_node
;
4844 struct ust_app
*app
;
4845 struct ust_app_session
*ua_sess
;
4846 struct ust_app_channel
*ua_chan
;
4848 LTTNG_ASSERT(usess
->active
);
4849 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4854 lttng::urcu::read_lock_guard read_lock
;
4856 /* For every registered applications */
4857 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4858 struct lttng_ht_iter uiter
;
4859 if (!app
->compatible
) {
4861 * TODO: In time, we should notice the caller of this error by
4862 * telling him that this is a version error.
4866 ua_sess
= lookup_session_by_app(usess
, app
);
4867 if (ua_sess
== nullptr) {
4872 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
4873 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&uiter
);
4874 /* If the session if found for the app, the channel must be there */
4875 LTTNG_ASSERT(ua_chan_node
);
4877 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
4878 /* The channel must not be already disabled */
4879 LTTNG_ASSERT(ua_chan
->enabled
);
4881 /* Disable channel onto application */
4882 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4884 /* XXX: We might want to report this error at some point... */
4894 * For a specific UST session, enable the channel for all registered apps.
4896 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
, struct ltt_ust_channel
*uchan
)
4899 struct lttng_ht_iter iter
;
4900 struct ust_app
*app
;
4901 struct ust_app_session
*ua_sess
;
4903 LTTNG_ASSERT(usess
->active
);
4904 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4909 lttng::urcu::read_lock_guard read_lock
;
4911 /* For every registered applications */
4912 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4913 if (!app
->compatible
) {
4915 * TODO: In time, we should notice the caller of this error by
4916 * telling him that this is a version error.
4920 ua_sess
= lookup_session_by_app(usess
, app
);
4921 if (ua_sess
== nullptr) {
4925 /* Enable channel onto application */
4926 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4928 /* XXX: We might want to report this error at some point... */
4938 * Disable an event in a channel and for a specific session.
4940 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4941 struct ltt_ust_channel
*uchan
,
4942 struct ltt_ust_event
*uevent
)
4945 struct lttng_ht_iter iter
, uiter
;
4946 struct lttng_ht_node_str
*ua_chan_node
;
4947 struct ust_app
*app
;
4948 struct ust_app_session
*ua_sess
;
4949 struct ust_app_channel
*ua_chan
;
4950 struct ust_app_event
*ua_event
;
4952 LTTNG_ASSERT(usess
->active
);
4953 DBG("UST app disabling event %s for all apps in channel "
4954 "%s for session id %" PRIu64
,
4960 lttng::urcu::read_lock_guard read_lock
;
4962 /* For all registered applications */
4963 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4964 if (!app
->compatible
) {
4966 * TODO: In time, we should notice the caller of this error by
4967 * telling him that this is a version error.
4971 ua_sess
= lookup_session_by_app(usess
, app
);
4972 if (ua_sess
== nullptr) {
4977 /* Lookup channel in the ust app session */
4978 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
4979 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&uiter
);
4980 if (ua_chan_node
== nullptr) {
4981 DBG2("Channel %s not found in session id %" PRIu64
4989 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
4991 ua_event
= find_ust_app_event(
4995 (enum lttng_ust_abi_loglevel_type
) uevent
->attr
.loglevel_type
,
4996 uevent
->attr
.loglevel
,
4998 if (ua_event
== nullptr) {
4999 DBG2("Event %s not found in channel %s for app pid %d."
5007 ret
= disable_ust_app_event(ua_event
, app
);
5009 /* XXX: Report error someday... */
5018 /* The ua_sess lock must be held by the caller. */
5019 static int ust_app_channel_create(struct ltt_ust_session
*usess
,
5020 struct ust_app_session
*ua_sess
,
5021 struct ltt_ust_channel
*uchan
,
5022 struct ust_app
*app
,
5023 struct ust_app_channel
**_ua_chan
)
5026 struct ust_app_channel
*ua_chan
= nullptr;
5028 LTTNG_ASSERT(ua_sess
);
5030 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
, sizeof(uchan
->name
))) {
5031 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
5034 struct ltt_ust_context
*uctx
= nullptr;
5037 * Create channel onto application and synchronize its
5040 ret
= ust_app_channel_allocate(
5041 ua_sess
, uchan
, LTTNG_UST_ABI_CHAN_PER_CPU
, usess
, &ua_chan
);
5046 ret
= ust_app_channel_send(app
, usess
, ua_sess
, ua_chan
);
5052 cds_list_for_each_entry (uctx
, &uchan
->ctx_list
, list
) {
5053 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5065 * The application's socket is not valid. Either a bad socket
5066 * or a timeout on it. We can't inform the caller that for a
5067 * specific app, the session failed so lets continue here.
5069 ret
= 0; /* Not an error. */
5077 if (ret
== 0 && _ua_chan
) {
5079 * Only return the application's channel on success. Note
5080 * that the channel can still be part of the application's
5081 * channel hashtable on error.
5083 *_ua_chan
= ua_chan
;
5089 * Enable event for a specific session and channel on the tracer.
5091 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
5092 struct ltt_ust_channel
*uchan
,
5093 struct ltt_ust_event
*uevent
)
5096 struct lttng_ht_iter iter
, uiter
;
5097 struct lttng_ht_node_str
*ua_chan_node
;
5098 struct ust_app
*app
;
5099 struct ust_app_session
*ua_sess
;
5100 struct ust_app_channel
*ua_chan
;
5101 struct ust_app_event
*ua_event
;
5103 LTTNG_ASSERT(usess
->active
);
5104 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
5109 * NOTE: At this point, this function is called only if the session and
5110 * channel passed are already created for all apps. and enabled on the
5115 lttng::urcu::read_lock_guard read_lock
;
5117 /* For all registered applications */
5118 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5119 if (!app
->compatible
) {
5121 * TODO: In time, we should notice the caller of this error by
5122 * telling him that this is a version error.
5126 ua_sess
= lookup_session_by_app(usess
, app
);
5128 /* The application has problem or is probably dead. */
5132 auto locked_ua_sess
= ua_sess
->lock();
5133 if (ua_sess
->deleted
) {
5137 /* Lookup channel in the ust app session */
5138 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
5139 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&uiter
);
5141 * It is possible that the channel cannot be found is
5142 * the channel/event creation occurs concurrently with
5143 * an application exit.
5145 if (!ua_chan_node
) {
5149 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
5151 /* Get event node */
5152 ua_event
= find_ust_app_event(
5156 (enum lttng_ust_abi_loglevel_type
) uevent
->attr
.loglevel_type
,
5157 uevent
->attr
.loglevel
,
5159 if (ua_event
== nullptr) {
5160 DBG3("UST app enable event %s not found for app PID %d."
5167 ret
= enable_ust_app_event(ua_event
, app
);
5178 * For a specific existing UST session and UST channel, creates the event for
5179 * all registered apps.
5181 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
5182 struct ltt_ust_channel
*uchan
,
5183 struct ltt_ust_event
*uevent
)
5186 struct lttng_ht_iter iter
, uiter
;
5187 struct lttng_ht_node_str
*ua_chan_node
;
5188 struct ust_app
*app
;
5189 struct ust_app_session
*ua_sess
;
5190 struct ust_app_channel
*ua_chan
;
5192 LTTNG_ASSERT(usess
->active
);
5193 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
5198 lttng::urcu::read_lock_guard read_lock
;
5200 /* For all registered applications */
5201 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5202 if (!app
->compatible
) {
5204 * TODO: In time, we should notice the caller of this error by
5205 * telling him that this is a version error.
5210 ua_sess
= lookup_session_by_app(usess
, app
);
5212 /* The application has problem or is probably dead. */
5216 auto locked_ua_sess
= ua_sess
->lock();
5218 if (locked_ua_sess
->deleted
) {
5222 /* Lookup channel in the ust app session */
5223 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
5224 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&uiter
);
5225 /* If the channel is not found, there is a code flow error */
5226 LTTNG_ASSERT(ua_chan_node
);
5228 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
5230 ret
= create_ust_app_event(ua_chan
, uevent
, app
);
5232 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
5233 /* Possible value at this point: -ENOMEM. If so, we stop! */
5237 DBG2("UST app event %s already exist on app PID %d",
5249 * Start tracing for a specific UST session and app.
5251 * Called with UST app session lock held.
5254 static int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5257 struct ust_app_session
*ua_sess
;
5259 DBG("Starting tracing for ust app pid %d", app
->pid
);
5261 lttng::urcu::read_lock_guard read_lock
;
5262 const auto update_health_code_on_exit
=
5263 lttng::make_scope_exit([]() noexcept
{ health_code_update(); });
5265 if (!app
->compatible
) {
5269 ua_sess
= lookup_session_by_app(usess
, app
);
5270 if (ua_sess
== nullptr) {
5271 /* The session is in teardown process. Ignore and continue. */
5275 auto locked_ua_sess
= ua_sess
->lock();
5277 if (locked_ua_sess
->deleted
) {
5281 if (locked_ua_sess
->enabled
) {
5285 /* This starts the UST tracing */
5286 pthread_mutex_lock(&app
->sock_lock
);
5287 ret
= lttng_ust_ctl_start_session(app
->sock
, ua_sess
->handle
);
5288 pthread_mutex_unlock(&app
->sock_lock
);
5290 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5291 DBG3("UST app start session failed. Application is dead: pid = %d, sock = %d",
5295 } else if (ret
== -EAGAIN
) {
5296 WARN("UST app start session failed. Communication time out: pid = %d, sock = %d",
5302 ERR("UST app start session failed with ret %d: pid = %d, sock = %d",
5311 /* Indicate that the session has been started once */
5312 ua_sess
->started
= true;
5313 ua_sess
->enabled
= true;
5315 health_code_update();
5317 /* Quiescent wait after starting trace */
5318 pthread_mutex_lock(&app
->sock_lock
);
5319 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5320 pthread_mutex_unlock(&app
->sock_lock
);
5322 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5323 DBG3("UST app wait quiescent failed. Application is dead: pid = %d, sock = %d",
5326 } else if (ret
== -EAGAIN
) {
5327 WARN("UST app wait quiescent failed. Communication time out: pid = %d, sock = %d",
5331 ERR("UST app wait quiescent failed with ret %d: pid %d, sock = %d",
5342 * Stop tracing for a specific UST session and app.
5344 static int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5347 struct ust_app_session
*ua_sess
;
5349 DBG("Stopping tracing for ust app pid %d", app
->pid
);
5351 lttng::urcu::read_lock_guard read_lock
;
5352 const auto update_health_code_on_exit
=
5353 lttng::make_scope_exit([]() noexcept
{ health_code_update(); });
5355 if (!app
->compatible
) {
5359 ua_sess
= lookup_session_by_app(usess
, app
);
5360 if (ua_sess
== nullptr) {
5364 auto locked_ua_sess
= ua_sess
->lock();
5366 if (ua_sess
->deleted
) {
5371 * If started = 0, it means that stop trace has been called for a session
5372 * that was never started. It's possible since we can have a fail start
5373 * from either the application manager thread or the command thread. Simply
5374 * indicate that this is a stop error.
5376 if (!ua_sess
->started
) {
5380 health_code_update();
5382 /* This inhibits UST tracing */
5383 pthread_mutex_lock(&app
->sock_lock
);
5384 ret
= lttng_ust_ctl_stop_session(app
->sock
, ua_sess
->handle
);
5385 pthread_mutex_unlock(&app
->sock_lock
);
5387 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5388 DBG3("UST app stop session failed. Application is dead: pid = %d, sock = %d",
5392 } else if (ret
== -EAGAIN
) {
5393 WARN("UST app stop session failed. Communication time out: pid = %d, sock = %d",
5399 ERR("UST app stop session failed with ret %d: pid = %d, sock = %d",
5408 health_code_update();
5409 ua_sess
->enabled
= false;
5411 /* Quiescent wait after stopping trace */
5412 pthread_mutex_lock(&app
->sock_lock
);
5413 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5414 pthread_mutex_unlock(&app
->sock_lock
);
5416 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5417 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d",
5420 } else if (ret
== -EAGAIN
) {
5421 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d",
5425 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d",
5432 health_code_update();
5435 auto locked_registry
= get_locked_session_registry(ua_sess
);
5437 /* The UST app session is held registry shall not be null. */
5438 LTTNG_ASSERT(locked_registry
);
5440 /* Push metadata for application before freeing the application. */
5441 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
5447 static int ust_app_flush_app_session(ust_app
& app
, ust_app_session
& ua_sess
)
5449 int ret
, retval
= 0;
5450 struct lttng_ht_iter iter
;
5451 struct ust_app_channel
*ua_chan
;
5452 struct consumer_socket
*socket
;
5454 const auto update_health_code_on_exit
=
5455 lttng::make_scope_exit([]() noexcept
{ health_code_update(); });
5457 DBG("Flushing app session buffers for ust app pid %d", app
.pid
);
5459 if (!app
.compatible
) {
5463 const auto locked_ua_sess
= ua_sess
.lock();
5464 if (locked_ua_sess
->deleted
) {
5468 health_code_update();
5470 /* Flushing buffers */
5471 socket
= consumer_find_socket_by_bitness(app
.abi
.bits_per_long
, ua_sess
.consumer
);
5473 /* Flush buffers and push metadata. */
5474 switch (ua_sess
.buffer_type
) {
5475 case LTTNG_BUFFER_PER_PID
:
5477 lttng::urcu::read_lock_guard read_lock
;
5479 cds_lfht_for_each_entry (ua_sess
.channels
->ht
, &iter
.iter
, ua_chan
, node
.node
) {
5480 health_code_update();
5481 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5483 ERR("Error flushing consumer channel");
5491 case LTTNG_BUFFER_PER_UID
:
5501 * Flush buffers for all applications for a specific UST session.
5502 * Called with UST session lock held.
5504 static int ust_app_flush_session(struct ltt_ust_session
*usess
)
5509 DBG("Flushing session buffers for all ust apps");
5511 /* Flush buffers and push metadata. */
5512 switch (usess
->buffer_type
) {
5513 case LTTNG_BUFFER_PER_UID
:
5515 struct buffer_reg_uid
*reg
;
5516 struct lttng_ht_iter iter
;
5518 /* Flush all per UID buffers associated to that session. */
5519 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5520 lttng::urcu::read_lock_guard read_lock
;
5521 lsu::registry_session
*ust_session_reg
;
5522 struct buffer_reg_channel
*buf_reg_chan
;
5523 struct consumer_socket
*socket
;
5525 /* Get consumer socket to use to push the metadata.*/
5526 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5529 /* Ignore request if no consumer is found for the session. */
5533 cds_lfht_for_each_entry (
5534 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
5536 * The following call will print error values so the return
5537 * code is of little importance because whatever happens, we
5538 * have to try them all.
5540 (void) consumer_flush_channel(socket
, buf_reg_chan
->consumer_key
);
5543 ust_session_reg
= reg
->registry
->reg
.ust
;
5544 /* Push metadata. */
5545 auto locked_registry
= ust_session_reg
->lock();
5546 (void) push_metadata(locked_registry
, usess
->consumer
);
5551 case LTTNG_BUFFER_PER_PID
:
5553 struct ust_app_session
*ua_sess
;
5554 struct lttng_ht_iter iter
;
5555 struct ust_app
*app
;
5556 lttng::urcu::read_lock_guard read_lock
;
5558 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5559 ua_sess
= lookup_session_by_app(usess
, app
);
5560 if (ua_sess
== nullptr) {
5564 (void) ust_app_flush_app_session(*app
, *ua_sess
);
5575 health_code_update();
5579 static int ust_app_clear_quiescent_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
)
5582 struct lttng_ht_iter iter
;
5583 struct ust_app_channel
*ua_chan
;
5584 struct consumer_socket
*socket
;
5586 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5588 lttng::urcu::read_lock_guard read_lock
;
5589 const auto update_health_code_on_exit
=
5590 lttng::make_scope_exit([]() noexcept
{ health_code_update(); });
5592 if (!app
->compatible
) {
5596 const auto locked_ua_sess
= ua_sess
->lock();
5597 if (locked_ua_sess
->deleted
) {
5601 health_code_update();
5603 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, ua_sess
->consumer
);
5605 ERR("Failed to find consumer (%" PRIu32
") socket", app
->abi
.bits_per_long
);
5609 /* Clear quiescent state. */
5610 switch (ua_sess
->buffer_type
) {
5611 case LTTNG_BUFFER_PER_PID
:
5612 cds_lfht_for_each_entry (ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
, node
.node
) {
5613 health_code_update();
5614 ret
= consumer_clear_quiescent_channel(socket
, ua_chan
->key
);
5616 ERR("Error clearing quiescent state for consumer channel");
5622 case LTTNG_BUFFER_PER_UID
:
5633 * Clear quiescent state in each stream for all applications for a
5634 * specific UST session.
5635 * Called with UST session lock held.
5637 static int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5642 DBG("Clearing stream quiescent state for all ust apps");
5644 switch (usess
->buffer_type
) {
5645 case LTTNG_BUFFER_PER_UID
:
5647 struct lttng_ht_iter iter
;
5648 struct buffer_reg_uid
*reg
;
5651 * Clear quiescent for all per UID buffers associated to
5654 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5655 struct consumer_socket
*socket
;
5656 struct buffer_reg_channel
*buf_reg_chan
;
5657 lttng::urcu::read_lock_guard read_lock
;
5659 /* Get associated consumer socket.*/
5660 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5664 * Ignore request if no consumer is found for
5670 cds_lfht_for_each_entry (
5671 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
5673 * The following call will print error values so
5674 * the return code is of little importance
5675 * because whatever happens, we have to try them
5678 (void) consumer_clear_quiescent_channel(socket
,
5679 buf_reg_chan
->consumer_key
);
5685 case LTTNG_BUFFER_PER_PID
:
5687 struct ust_app_session
*ua_sess
;
5688 struct lttng_ht_iter iter
;
5689 struct ust_app
*app
;
5690 lttng::urcu::read_lock_guard read_lock
;
5692 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5693 ua_sess
= lookup_session_by_app(usess
, app
);
5694 if (ua_sess
== nullptr) {
5697 (void) ust_app_clear_quiescent_app_session(app
, ua_sess
);
5708 health_code_update();
5713 * Destroy a specific UST session in apps.
5715 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5718 struct ust_app_session
*ua_sess
;
5719 struct lttng_ht_iter iter
;
5720 struct lttng_ht_node_u64
*node
;
5722 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5724 lttng::urcu::read_lock_guard read_lock
;
5726 if (!app
->compatible
) {
5730 __lookup_session_by_app(usess
, app
, &iter
);
5731 node
= lttng_ht_iter_get_node
<lttng_ht_node_u64
>(&iter
);
5732 if (node
== nullptr) {
5733 /* Session is being or is deleted. */
5736 ua_sess
= lttng::utils::container_of(node
, &ust_app_session::node
);
5738 health_code_update();
5739 destroy_app_session(app
, ua_sess
);
5741 health_code_update();
5743 /* Quiescent wait after stopping trace */
5744 pthread_mutex_lock(&app
->sock_lock
);
5745 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5746 pthread_mutex_unlock(&app
->sock_lock
);
5748 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5749 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d",
5752 } else if (ret
== -EAGAIN
) {
5753 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d",
5757 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d",
5764 health_code_update();
5769 * Start tracing for the UST session.
5771 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5773 struct lttng_ht_iter iter
;
5774 struct ust_app
*app
;
5776 DBG("Starting all UST traces");
5779 * Even though the start trace might fail, flag this session active so
5780 * other application coming in are started by default.
5782 usess
->active
= true;
5785 * In a start-stop-start use-case, we need to clear the quiescent state
5786 * of each channel set by the prior stop command, thus ensuring that a
5787 * following stop or destroy is sure to grab a timestamp_end near those
5788 * operations, even if the packet is empty.
5790 (void) ust_app_clear_quiescent_session(usess
);
5793 lttng::urcu::read_lock_guard read_lock
;
5795 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5796 ust_app_global_update(usess
, app
);
5804 * Start tracing for the UST session.
5805 * Called with UST session lock held.
5807 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5810 struct lttng_ht_iter iter
;
5811 struct ust_app
*app
;
5813 DBG("Stopping all UST traces");
5816 * Even though the stop trace might fail, flag this session inactive so
5817 * other application coming in are not started by default.
5819 usess
->active
= false;
5822 lttng::urcu::read_lock_guard read_lock
;
5824 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5825 ret
= ust_app_stop_trace(usess
, app
);
5827 /* Continue to next apps even on error */
5833 (void) ust_app_flush_session(usess
);
5839 * Destroy app UST session.
5841 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5844 struct lttng_ht_iter iter
;
5845 struct ust_app
*app
;
5847 DBG("Destroy all UST traces");
5850 lttng::urcu::read_lock_guard read_lock
;
5852 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5853 ret
= destroy_trace(usess
, app
);
5855 /* Continue to next apps even on error */
5864 /* The ua_sess lock must be held by the caller. */
5865 static int find_or_create_ust_app_channel(struct ltt_ust_session
*usess
,
5866 struct ust_app_session
*ua_sess
,
5867 struct ust_app
*app
,
5868 struct ltt_ust_channel
*uchan
,
5869 struct ust_app_channel
**ua_chan
)
5872 struct lttng_ht_iter iter
;
5873 struct lttng_ht_node_str
*ua_chan_node
;
5875 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5876 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&iter
);
5878 *ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5882 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5890 static int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5891 struct ltt_ust_event
*uevent
,
5892 struct ust_app
*app
)
5895 struct ust_app_event
*ua_event
= nullptr;
5897 ua_event
= find_ust_app_event(ua_chan
->events
,
5900 (enum lttng_ust_abi_loglevel_type
) uevent
->attr
.loglevel_type
,
5901 uevent
->attr
.loglevel
,
5904 ret
= create_ust_app_event(ua_chan
, uevent
, app
);
5909 if (ua_event
->enabled
!= uevent
->enabled
) {
5910 ret
= uevent
->enabled
? enable_ust_app_event(ua_event
, app
) :
5911 disable_ust_app_event(ua_event
, app
);
5919 /* Called with RCU read-side lock held. */
5920 static void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5923 enum lttng_error_code ret_code
;
5924 enum lttng_trigger_status t_status
;
5925 struct lttng_ht_iter app_trigger_iter
;
5926 struct lttng_triggers
*triggers
= nullptr;
5927 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5928 unsigned int count
, i
;
5930 ASSERT_RCU_READ_LOCKED();
5932 if (!ust_app_supports_notifiers(app
)) {
5937 * Currrently, registering or unregistering a trigger with an
5938 * event rule condition causes a full synchronization of the event
5941 * The first step attempts to add an event notifier for all registered
5942 * triggers that apply to the user space tracers. Then, the
5943 * application's event notifiers rules are all checked against the list
5944 * of registered triggers. Any event notifier that doesn't have a
5945 * matching trigger can be assumed to have been disabled.
5947 * All of this is inefficient, but is put in place to get the feature
5948 * rolling as it is simpler at this moment. It will be optimized Soon™
5949 * to allow the state of enabled
5950 * event notifiers to be synchronized in a piece-wise way.
5953 /* Get all triggers using uid 0 (root) */
5954 ret_code
= notification_thread_command_list_triggers(
5955 the_notification_thread_handle
, 0, &triggers
);
5956 if (ret_code
!= LTTNG_OK
) {
5960 LTTNG_ASSERT(triggers
);
5962 t_status
= lttng_triggers_get_count(triggers
, &count
);
5963 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5967 for (i
= 0; i
< count
; i
++) {
5968 const struct lttng_condition
*condition
;
5969 const struct lttng_event_rule
*event_rule
;
5970 struct lttng_trigger
*trigger
;
5971 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5972 enum lttng_condition_status condition_status
;
5975 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5976 LTTNG_ASSERT(trigger
);
5978 token
= lttng_trigger_get_tracer_token(trigger
);
5979 condition
= lttng_trigger_get_const_condition(trigger
);
5981 if (lttng_condition_get_type(condition
) !=
5982 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
) {
5983 /* Does not apply */
5988 lttng_condition_event_rule_matches_get_rule(condition
, &event_rule
);
5989 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5991 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5992 /* Skip kernel related triggers. */
5997 * Find or create the associated token event rule. The caller
5998 * holds the RCU read lock, so this is safe to call without
5999 * explicitly acquiring it here.
6001 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
6002 app
->token_to_event_notifier_rule_ht
, token
);
6003 if (!looked_up_event_notifier_rule
) {
6004 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
6012 lttng::urcu::read_lock_guard read_lock
;
6014 /* Remove all unknown event sources from the app. */
6015 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
6016 &app_trigger_iter
.iter
,
6017 event_notifier_rule
,
6019 const uint64_t app_token
= event_notifier_rule
->token
;
6023 * Check if the app event trigger still exists on the
6024 * notification side.
6026 for (i
= 0; i
< count
; i
++) {
6027 uint64_t notification_thread_token
;
6028 const struct lttng_trigger
*trigger
=
6029 lttng_triggers_get_at_index(triggers
, i
);
6031 LTTNG_ASSERT(trigger
);
6033 notification_thread_token
= lttng_trigger_get_tracer_token(trigger
);
6035 if (notification_thread_token
== app_token
) {
6047 * This trigger was unregistered, disable it on the tracer's
6050 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &app_trigger_iter
);
6051 LTTNG_ASSERT(ret
== 0);
6053 /* Callee logs errors. */
6054 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
6056 delete_ust_app_event_notifier_rule(app
->sock
, event_notifier_rule
, app
);
6061 lttng_triggers_destroy(triggers
);
6066 * RCU read lock must be held by the caller.
6068 static void ust_app_synchronize_all_channels(struct ltt_ust_session
*usess
,
6069 struct ust_app_session
*ua_sess
,
6070 struct ust_app
*app
)
6073 struct cds_lfht_iter uchan_iter
;
6074 struct ltt_ust_channel
*uchan
;
6076 LTTNG_ASSERT(usess
);
6077 LTTNG_ASSERT(ua_sess
);
6079 ASSERT_RCU_READ_LOCKED();
6081 cds_lfht_for_each_entry (usess
->domain_global
.channels
->ht
, &uchan_iter
, uchan
, node
.node
) {
6082 struct ust_app_channel
*ua_chan
;
6083 struct cds_lfht_iter uevent_iter
;
6084 struct ltt_ust_event
*uevent
;
6087 * Search for a matching ust_app_channel. If none is found,
6088 * create it. Creating the channel will cause the ua_chan
6089 * structure to be allocated, the channel buffers to be
6090 * allocated (if necessary) and sent to the application, and
6091 * all enabled contexts will be added to the channel.
6093 ret
= find_or_create_ust_app_channel(usess
, ua_sess
, app
, uchan
, &ua_chan
);
6095 /* Tracer is probably gone or ENOMEM. */
6100 /* ua_chan will be NULL for the metadata channel */
6104 cds_lfht_for_each_entry (uchan
->events
->ht
, &uevent_iter
, uevent
, node
.node
) {
6105 ret
= ust_app_channel_synchronize_event(ua_chan
, uevent
, app
);
6111 if (ua_chan
->enabled
!= uchan
->enabled
) {
6112 ret
= uchan
->enabled
? enable_ust_app_channel(ua_sess
, uchan
, app
) :
6113 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
6124 * The caller must ensure that the application is compatible and is tracked
6125 * by the process attribute trackers.
6127 static void ust_app_synchronize(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6130 struct ust_app_session
*ua_sess
= nullptr;
6133 * The application's configuration should only be synchronized for
6136 LTTNG_ASSERT(usess
->active
);
6138 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, nullptr);
6140 /* Tracer is probably gone or ENOMEM. */
6144 LTTNG_ASSERT(ua_sess
);
6146 const auto locked_ua_sess
= ua_sess
->lock();
6147 if (locked_ua_sess
->deleted
) {
6152 lttng::urcu::read_lock_guard read_lock
;
6154 ust_app_synchronize_all_channels(usess
, ua_sess
, app
);
6157 * Create the metadata for the application. This returns gracefully if a
6158 * metadata was already set for the session.
6160 * The metadata channel must be created after the data channels as the
6161 * consumer daemon assumes this ordering. When interacting with a relay
6162 * daemon, the consumer will use this assumption to send the
6163 * "STREAMS_SENT" message to the relay daemon.
6165 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
6167 ERR("Metadata creation failed for app sock %d for session id %" PRIu64
,
6174 static void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6176 struct ust_app_session
*ua_sess
;
6178 ua_sess
= lookup_session_by_app(usess
, app
);
6179 if (ua_sess
== nullptr) {
6182 destroy_app_session(app
, ua_sess
);
6186 * Add channels/events from UST global domain to registered apps at sock.
6188 * Called with session lock held.
6189 * Called with RCU read-side lock held.
6191 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6193 LTTNG_ASSERT(usess
);
6194 LTTNG_ASSERT(usess
->active
);
6195 ASSERT_RCU_READ_LOCKED();
6197 DBG2("UST app global update for app sock %d for session id %" PRIu64
, app
->sock
, usess
->id
);
6199 if (!app
->compatible
) {
6202 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
, usess
, app
->pid
) &&
6203 trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
, usess
, app
->uid
) &&
6204 trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
, usess
, app
->gid
)) {
6206 * Synchronize the application's internal tracing configuration
6207 * and start tracing.
6209 ust_app_synchronize(usess
, app
);
6210 ust_app_start_trace(usess
, app
);
6212 ust_app_global_destroy(usess
, app
);
6217 * Add all event notifiers to an application.
6219 * Called with session lock held.
6220 * Called with RCU read-side lock held.
6222 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
6224 ASSERT_RCU_READ_LOCKED();
6226 DBG2("UST application global event notifier rules update: app = '%s', pid = %d",
6230 if (!app
->compatible
|| !ust_app_supports_notifiers(app
)) {
6234 if (app
->event_notifier_group
.object
== nullptr) {
6235 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s', pid = %d",
6241 ust_app_synchronize_event_notifier_rules(app
);
6245 * Called with session lock held.
6247 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
6249 struct lttng_ht_iter iter
;
6250 struct ust_app
*app
;
6253 lttng::urcu::read_lock_guard read_lock
;
6255 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6256 ust_app_global_update(usess
, app
);
6261 void ust_app_global_update_all_event_notifier_rules()
6263 struct lttng_ht_iter iter
;
6264 struct ust_app
*app
;
6266 lttng::urcu::read_lock_guard read_lock
;
6267 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6268 ust_app_global_update_event_notifier_rules(app
);
6273 * Add context to a specific channel for global UST domain.
6275 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
6276 struct ltt_ust_channel
*uchan
,
6277 struct ltt_ust_context
*uctx
)
6280 struct lttng_ht_node_str
*ua_chan_node
;
6281 struct lttng_ht_iter iter
, uiter
;
6282 struct ust_app_channel
*ua_chan
= nullptr;
6283 struct ust_app_session
*ua_sess
;
6284 struct ust_app
*app
;
6286 LTTNG_ASSERT(usess
->active
);
6289 lttng::urcu::read_lock_guard read_lock
;
6290 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6291 if (!app
->compatible
) {
6293 * TODO: In time, we should notice the caller of this error by
6294 * telling him that this is a version error.
6298 ua_sess
= lookup_session_by_app(usess
, app
);
6299 if (ua_sess
== nullptr) {
6303 const auto locked_ua_sess
= ua_sess
->lock();
6304 if (locked_ua_sess
->deleted
) {
6308 /* Lookup channel in the ust app session */
6309 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6310 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&uiter
);
6311 if (ua_chan_node
== nullptr) {
6314 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6315 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
6326 * Receive registration and populate the given msg structure.
6328 * On success return 0 else a negative value returned by the ustctl call.
6330 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
6333 uint32_t pid
, ppid
, uid
, gid
;
6337 ret
= lttng_ust_ctl_recv_reg_msg(sock
,
6345 &msg
->bits_per_long
,
6346 &msg
->uint8_t_alignment
,
6347 &msg
->uint16_t_alignment
,
6348 &msg
->uint32_t_alignment
,
6349 &msg
->uint64_t_alignment
,
6350 &msg
->long_alignment
,
6357 case LTTNG_UST_ERR_EXITING
:
6358 DBG3("UST app recv reg message failed. Application died");
6360 case LTTNG_UST_ERR_UNSUP_MAJOR
:
6361 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
6364 LTTNG_UST_ABI_MAJOR_VERSION
,
6365 LTTNG_UST_ABI_MINOR_VERSION
);
6368 ERR("UST app recv reg message failed with ret %d", ret
);
6373 msg
->pid
= (pid_t
) pid
;
6374 msg
->ppid
= (pid_t
) ppid
;
6375 msg
->uid
= (uid_t
) uid
;
6376 msg
->gid
= (gid_t
) gid
;
6383 * Return a ust app session object using the application object and the
6384 * session object descriptor has a key. If not found, NULL is returned.
6385 * A RCU read side lock MUST be acquired when calling this function.
6387 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
, int objd
)
6389 struct lttng_ht_node_ulong
*node
;
6390 struct lttng_ht_iter iter
;
6391 struct ust_app_session
*ua_sess
= nullptr;
6394 ASSERT_RCU_READ_LOCKED();
6396 lttng_ht_lookup(app
->ust_sessions_objd
, (void *) ((unsigned long) objd
), &iter
);
6397 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&iter
);
6398 if (node
== nullptr) {
6399 DBG2("UST app session find by objd %d not found", objd
);
6403 ua_sess
= lttng::utils::container_of(node
, &ust_app_session::ust_objd_node
);
6410 * Return a ust app channel object using the application object and the channel
6411 * object descriptor has a key. If not found, NULL is returned. A RCU read side
6412 * lock MUST be acquired before calling this function.
6414 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
, int objd
)
6416 struct lttng_ht_node_ulong
*node
;
6417 struct lttng_ht_iter iter
;
6418 struct ust_app_channel
*ua_chan
= nullptr;
6421 ASSERT_RCU_READ_LOCKED();
6423 lttng_ht_lookup(app
->ust_objd
, (void *) ((unsigned long) objd
), &iter
);
6424 node
= lttng_ht_iter_get_node
<lttng_ht_node_ulong
>(&iter
);
6425 if (node
== nullptr) {
6426 DBG2("UST app channel find by objd %d not found", objd
);
6430 ua_chan
= lttng::utils::container_of(node
, &ust_app_channel::ust_objd_node
);
6437 * Reply to a register channel notification from an application on the notify
6438 * socket. The channel metadata is also created.
6440 * The session UST registry lock is acquired in this function.
6442 * On success 0 is returned else a negative value.
6444 static int handle_app_register_channel_notification(int sock
,
6446 struct lttng_ust_ctl_field
*raw_context_fields
,
6447 size_t context_field_count
)
6449 int ret
, ret_code
= 0;
6451 uint64_t chan_reg_key
;
6452 struct ust_app
*app
;
6453 struct ust_app_channel
*ua_chan
;
6454 struct ust_app_session
*ua_sess
;
6455 auto ust_ctl_context_fields
=
6456 lttng::make_unique_wrapper
<lttng_ust_ctl_field
, lttng::memory::free
>(
6457 raw_context_fields
);
6459 lttng::urcu::read_lock_guard read_lock_guard
;
6461 /* Lookup application. If not found, there is a code flow error. */
6462 app
= find_app_by_notify_sock(sock
);
6464 DBG("Application socket %d is being torn down. Abort event notify", sock
);
6468 /* Lookup channel by UST object descriptor. */
6469 ua_chan
= find_channel_by_objd(app
, cobjd
);
6471 DBG("Application channel is being torn down. Abort event notify");
6475 LTTNG_ASSERT(ua_chan
->session
);
6476 ua_sess
= ua_chan
->session
;
6478 /* Get right session registry depending on the session buffer type. */
6479 auto locked_registry_session
= get_locked_session_registry(ua_sess
);
6480 if (!locked_registry_session
) {
6481 DBG("Application session is being torn down. Abort event notify");
6485 /* Depending on the buffer type, a different channel key is used. */
6486 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6487 chan_reg_key
= ua_chan
->tracing_channel_id
;
6489 chan_reg_key
= ua_chan
->key
;
6492 auto& ust_reg_chan
= locked_registry_session
->channel(chan_reg_key
);
6494 /* Channel id is set during the object creation. */
6495 chan_id
= ust_reg_chan
.id
;
6498 * The application returns the typing information of the channel's
6499 * context fields. In per-PID buffering mode, this is the first and only
6500 * time we get this information. It is our chance to finalize the
6501 * initialiation of the channel and serialize it's layout's description
6502 * to the trace's metadata.
6504 * However, in per-UID buffering mode, every application will provide
6505 * this information (redundantly). The first time will allow us to
6506 * complete the initialization. The following times, we simply validate
6507 * that all apps provide the same typing for the context fields as a
6511 auto app_context_fields
= lsu::create_trace_fields_from_ust_ctl_fields(
6512 *locked_registry_session
,
6513 ust_ctl_context_fields
.get(),
6514 context_field_count
,
6515 lst::field_location::root::EVENT_RECORD_COMMON_CONTEXT
,
6516 lsu::ctl_field_quirks::UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS
);
6518 if (!ust_reg_chan
.is_registered()) {
6519 lst::type::cuptr event_context
= app_context_fields
.size() ?
6520 lttng::make_unique
<lst::structure_type
>(
6521 0, std::move(app_context_fields
)) :
6524 ust_reg_chan
.event_context(std::move(event_context
));
6527 * Validate that the context fields match between
6528 * registry and newcoming application.
6530 bool context_fields_match
;
6531 const auto *previous_event_context
= ust_reg_chan
.event_context();
6533 if (!previous_event_context
) {
6534 context_fields_match
= app_context_fields
.size() == 0;
6536 const lst::structure_type
app_event_context_struct(
6537 0, std::move(app_context_fields
));
6539 context_fields_match
= *previous_event_context
==
6540 app_event_context_struct
;
6543 if (!context_fields_match
) {
6544 ERR("Registering application channel due to context field mismatch: pid = %d, sock = %d",
6551 } catch (const std::exception
& ex
) {
6552 ERR("Failed to handle application context: %s", ex
.what());
6558 DBG3("UST app replying to register channel key %" PRIu64
" with id %u, ret = %d",
6563 ret
= lttng_ust_ctl_reply_register_channel(
6566 ust_reg_chan
.header_type_
== lst::stream_class::header_type::COMPACT
?
6567 LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT
:
6568 LTTNG_UST_CTL_CHANNEL_HEADER_LARGE
,
6571 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6572 DBG3("UST app reply channel failed. Application died: pid = %d, sock = %d",
6575 } else if (ret
== -EAGAIN
) {
6576 WARN("UST app reply channel failed. Communication time out: pid = %d, sock = %d",
6580 ERR("UST app reply channel failed with ret %d: pid = %d, sock = %d",
6589 /* This channel registry's registration is completed. */
6590 ust_reg_chan
.set_as_registered();
6596 * Add event to the UST channel registry. When the event is added to the
6597 * registry, the metadata is also created. Once done, this replies to the
6598 * application with the appropriate error code.
6600 * The session UST registry lock is acquired in the function.
6602 * On success 0 is returned else a negative value.
6604 static int add_event_ust_registry(int sock
,
6608 char *raw_signature
,
6610 struct lttng_ust_ctl_field
*raw_fields
,
6612 char *raw_model_emf_uri
)
6615 uint32_t event_id
= 0;
6616 uint64_t chan_reg_key
;
6617 struct ust_app
*app
;
6618 struct ust_app_channel
*ua_chan
;
6619 struct ust_app_session
*ua_sess
;
6620 lttng::urcu::read_lock_guard rcu_lock
;
6621 auto signature
= lttng::make_unique_wrapper
<char, lttng::memory::free
>(raw_signature
);
6623 lttng::make_unique_wrapper
<lttng_ust_ctl_field
, lttng::memory::free
>(raw_fields
);
6624 auto model_emf_uri
=
6625 lttng::make_unique_wrapper
<char, lttng::memory::free
>(raw_model_emf_uri
);
6627 /* Lookup application. If not found, there is a code flow error. */
6628 app
= find_app_by_notify_sock(sock
);
6630 DBG("Application socket %d is being torn down. Abort event notify", sock
);
6634 /* Lookup channel by UST object descriptor. */
6635 ua_chan
= find_channel_by_objd(app
, cobjd
);
6637 DBG("Application channel is being torn down. Abort event notify");
6641 LTTNG_ASSERT(ua_chan
->session
);
6642 ua_sess
= ua_chan
->session
;
6644 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6645 chan_reg_key
= ua_chan
->tracing_channel_id
;
6647 chan_reg_key
= ua_chan
->key
;
6651 auto locked_registry
= get_locked_session_registry(ua_sess
);
6652 if (locked_registry
) {
6654 * From this point on, this call acquires the ownership of the signature,
6655 * fields and model_emf_uri meaning any free are done inside it if needed.
6656 * These three variables MUST NOT be read/write after this.
6659 auto& channel
= locked_registry
->channel(chan_reg_key
);
6661 /* event_id is set on success. */
6667 lsu::create_trace_fields_from_ust_ctl_fields(
6671 lst::field_location::root::EVENT_RECORD_PAYLOAD
,
6672 lsu::ctl_field_quirks::
6673 UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS
),
6675 model_emf_uri
.get() ?
6676 nonstd::optional
<std::string
>(model_emf_uri
.get()) :
6678 ua_sess
->buffer_type
,
6682 } catch (const std::exception
& ex
) {
6683 ERR("Failed to add event `%s` to registry session: %s",
6686 /* Inform the application of the error; don't return directly. */
6690 DBG("Application session is being torn down. Abort event notify");
6696 * The return value is returned to ustctl so in case of an error, the
6697 * application can be notified. In case of an error, it's important not to
6698 * return a negative error or else the application will get closed.
6700 ret
= lttng_ust_ctl_reply_register_event(sock
, event_id
, ret_code
);
6702 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6703 DBG3("UST app reply event failed. Application died: pid = %d, sock = %d.",
6706 } else if (ret
== -EAGAIN
) {
6707 WARN("UST app reply event failed. Communication time out: pid = %d, sock = %d",
6711 ERR("UST app reply event failed with ret %d: pid = %d, sock = %d",
6717 * No need to wipe the create event since the application socket will
6718 * get close on error hence cleaning up everything by itself.
6723 DBG3("UST registry event %s with id %" PRId32
" added successfully", name
, event_id
);
6728 * Add enum to the UST session registry. Once done, this replies to the
6729 * application with the appropriate error code.
6731 * The session UST registry lock is acquired within this function.
6733 * On success 0 is returned else a negative value.
6735 static int add_enum_ust_registry(int sock
,
6738 struct lttng_ust_ctl_enum_entry
*raw_entries
,
6742 struct ust_app
*app
;
6743 struct ust_app_session
*ua_sess
;
6744 uint64_t enum_id
= -1ULL;
6745 lttng::urcu::read_lock_guard read_lock_guard
;
6747 lttng::make_unique_wrapper
<struct lttng_ust_ctl_enum_entry
, lttng::memory::free
>(
6750 /* Lookup application. If not found, there is a code flow error. */
6751 app
= find_app_by_notify_sock(sock
);
6753 /* Return an error since this is not an error */
6754 DBG("Application socket %d is being torn down. Aborting enum registration", sock
);
6758 /* Lookup session by UST object descriptor. */
6759 ua_sess
= find_session_by_objd(app
, sobjd
);
6761 /* Return an error since this is not an error */
6762 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6766 auto locked_registry
= get_locked_session_registry(ua_sess
);
6767 if (!locked_registry
) {
6768 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6773 * From this point on, the callee acquires the ownership of
6774 * entries. The variable entries MUST NOT be read/written after
6777 int application_reply_code
;
6779 locked_registry
->create_or_find_enum(
6780 sobjd
, name
, entries
.release(), nr_entries
, &enum_id
);
6781 application_reply_code
= 0;
6782 } catch (const std::exception
& ex
) {
6785 "Failed to create or find enumeration provided by application: app = {}, enumeration name = {}",
6790 application_reply_code
= -1;
6794 * The return value is returned to ustctl so in case of an error, the
6795 * application can be notified. In case of an error, it's important not to
6796 * return a negative error or else the application will get closed.
6798 ret
= lttng_ust_ctl_reply_register_enum(sock
, enum_id
, application_reply_code
);
6800 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6801 DBG3("UST app reply enum failed. Application died: pid = %d, sock = %d",
6804 } else if (ret
== -EAGAIN
) {
6805 WARN("UST app reply enum failed. Communication time out: pid = %d, sock = %d",
6809 ERR("UST app reply enum failed with ret %d: pid = %d, sock = %d",
6815 * No need to wipe the create enum since the application socket will
6816 * get close on error hence cleaning up everything by itself.
6821 DBG3("UST registry enum %s added successfully or already found", name
);
6826 * Handle application notification through the given notify socket.
6828 * Return 0 on success or else a negative value.
6830 int ust_app_recv_notify(int sock
)
6833 enum lttng_ust_ctl_notify_cmd cmd
;
6835 DBG3("UST app receiving notify from sock %d", sock
);
6837 ret
= lttng_ust_ctl_recv_notify(sock
, &cmd
);
6839 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6840 DBG3("UST app recv notify failed. Application died: sock = %d", sock
);
6841 } else if (ret
== -EAGAIN
) {
6842 WARN("UST app recv notify failed. Communication time out: sock = %d", sock
);
6844 ERR("UST app recv notify failed with ret %d: sock = %d", ret
, sock
);
6850 case LTTNG_UST_CTL_NOTIFY_CMD_EVENT
:
6852 int sobjd
, cobjd
, loglevel_value
;
6853 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6855 struct lttng_ust_ctl_field
*fields
;
6857 DBG2("UST app ustctl register event received");
6859 ret
= lttng_ust_ctl_recv_register_event(sock
,
6869 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6870 DBG3("UST app recv event failed. Application died: sock = %d",
6872 } else if (ret
== -EAGAIN
) {
6873 WARN("UST app recv event failed. Communication time out: sock = %d",
6876 ERR("UST app recv event failed with ret %d: sock = %d", ret
, sock
);
6882 lttng::urcu::read_lock_guard rcu_lock
;
6883 const struct ust_app
*app
= find_app_by_notify_sock(sock
);
6885 DBG("Application socket %d is being torn down. Abort event notify",
6892 if ((!fields
&& nr_fields
> 0) || (fields
&& nr_fields
== 0)) {
6893 ERR("Invalid return value from lttng_ust_ctl_recv_register_event: fields = %p, nr_fields = %zu",
6902 * Add event to the UST registry coming from the notify socket. This
6903 * call will free if needed the sig, fields and model_emf_uri. This
6904 * code path loses the ownsership of these variables and transfer them
6905 * to the this function.
6907 ret
= add_event_ust_registry(sock
,
6922 case LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL
:
6926 struct lttng_ust_ctl_field
*context_fields
;
6928 DBG2("UST app ustctl register channel received");
6930 ret
= lttng_ust_ctl_recv_register_channel(
6931 sock
, &sobjd
, &cobjd
, &field_count
, &context_fields
);
6933 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6934 DBG3("UST app recv channel failed. Application died: sock = %d",
6936 } else if (ret
== -EAGAIN
) {
6937 WARN("UST app recv channel failed. Communication time out: sock = %d",
6940 ERR("UST app recv channel failed with ret %d: sock = %d",
6948 * The fields ownership are transfered to this function call meaning
6949 * that if needed it will be freed. After this, it's invalid to access
6950 * fields or clean them up.
6952 ret
= handle_app_register_channel_notification(
6953 sock
, cobjd
, context_fields
, field_count
);
6960 case LTTNG_UST_CTL_NOTIFY_CMD_ENUM
:
6963 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
6965 struct lttng_ust_ctl_enum_entry
*entries
;
6967 DBG2("UST app ustctl register enum received");
6969 ret
= lttng_ust_ctl_recv_register_enum(sock
, &sobjd
, name
, &entries
, &nr_entries
);
6971 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6972 DBG3("UST app recv enum failed. Application died: sock = %d", sock
);
6973 } else if (ret
== -EAGAIN
) {
6974 WARN("UST app recv enum failed. Communication time out: sock = %d",
6977 ERR("UST app recv enum failed with ret %d: sock = %d", ret
, sock
);
6982 /* Callee assumes ownership of entries. */
6983 ret
= add_enum_ust_registry(sock
, sobjd
, name
, entries
, nr_entries
);
6991 /* Should NEVER happen. */
7000 * Once the notify socket hangs up, this is called. First, it tries to find the
7001 * corresponding application. On failure, the call_rcu to close the socket is
7002 * executed. If an application is found, it tries to delete it from the notify
7003 * socket hash table. Whathever the result, it proceeds to the call_rcu.
7005 * Note that an object needs to be allocated here so on ENOMEM failure, the
7006 * call RCU is not done but the rest of the cleanup is.
7008 void ust_app_notify_sock_unregister(int sock
)
7011 struct lttng_ht_iter iter
;
7012 struct ust_app
*app
;
7013 struct ust_app_notify_sock_obj
*obj
;
7015 LTTNG_ASSERT(sock
>= 0);
7017 lttng::urcu::read_lock_guard read_lock
;
7019 obj
= zmalloc
<ust_app_notify_sock_obj
>();
7022 * An ENOMEM is kind of uncool. If this strikes we continue the
7023 * procedure but the call_rcu will not be called. In this case, we
7024 * accept the fd leak rather than possibly creating an unsynchronized
7025 * state between threads.
7027 * TODO: The notify object should be created once the notify socket is
7028 * registered and stored independantely from the ust app object. The
7029 * tricky part is to synchronize the teardown of the application and
7030 * this notify object. Let's keep that in mind so we can avoid this
7031 * kind of shenanigans with ENOMEM in the teardown path.
7038 DBG("UST app notify socket unregister %d", sock
);
7041 * Lookup application by notify socket. If this fails, this means that the
7042 * hash table delete has already been done by the application
7043 * unregistration process so we can safely close the notify socket in a
7046 app
= find_app_by_notify_sock(sock
);
7051 iter
.iter
.node
= &app
->notify_sock_n
.node
;
7054 * Whatever happens here either we fail or succeed, in both cases we have
7055 * to close the socket after a grace period to continue to the call RCU
7056 * here. If the deletion is successful, the application is not visible
7057 * anymore by other threads and is it fails it means that it was already
7058 * deleted from the hash table so either way we just have to close the
7061 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
7066 * Close socket after a grace period to avoid for the socket to be reused
7067 * before the application object is freed creating potential race between
7068 * threads trying to add unique in the global hash table.
7071 call_rcu(&obj
->head
, close_notify_sock_rcu
);
7076 * Destroy a ust app data structure and free its memory.
7078 static void ust_app_destroy(ust_app
& app
)
7080 call_rcu(&app
.pid_n
.head
, delete_ust_app_rcu
);
7084 * Take a snapshot for a given UST session. The snapshot is sent to the given
7087 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
7089 enum lttng_error_code
ust_app_snapshot_record(const struct ltt_ust_session
*usess
,
7090 const struct consumer_output
*output
,
7091 uint64_t nb_packets_per_stream
)
7094 enum lttng_error_code status
= LTTNG_OK
;
7095 struct lttng_ht_iter iter
;
7096 struct ust_app
*app
;
7097 char *trace_path
= nullptr;
7099 LTTNG_ASSERT(usess
);
7100 LTTNG_ASSERT(output
);
7102 switch (usess
->buffer_type
) {
7103 case LTTNG_BUFFER_PER_UID
:
7105 struct buffer_reg_uid
*reg
;
7107 lttng::urcu::read_lock_guard read_lock
;
7109 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7110 struct buffer_reg_channel
*buf_reg_chan
;
7111 struct consumer_socket
*socket
;
7112 char pathname
[PATH_MAX
];
7113 size_t consumer_path_offset
= 0;
7115 if (!reg
->registry
->reg
.ust
->_metadata_key
) {
7116 /* Skip since no metadata is present */
7120 /* Get consumer socket to use to push the metadata.*/
7121 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7124 status
= LTTNG_ERR_INVALID
;
7128 memset(pathname
, 0, sizeof(pathname
));
7129 ret
= snprintf(pathname
,
7131 DEFAULT_UST_TRACE_UID_PATH
,
7133 reg
->bits_per_long
);
7135 PERROR("snprintf snapshot path");
7136 status
= LTTNG_ERR_INVALID
;
7139 /* Free path allowed on previous iteration. */
7141 trace_path
= setup_channel_trace_path(
7142 usess
->consumer
, pathname
, &consumer_path_offset
);
7144 status
= LTTNG_ERR_INVALID
;
7147 /* Add the UST default trace dir to path. */
7148 cds_lfht_for_each_entry (
7149 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7151 consumer_snapshot_channel(socket
,
7152 buf_reg_chan
->consumer_key
,
7155 &trace_path
[consumer_path_offset
],
7156 nb_packets_per_stream
);
7157 if (status
!= LTTNG_OK
) {
7161 status
= consumer_snapshot_channel(socket
,
7162 reg
->registry
->reg
.ust
->_metadata_key
,
7165 &trace_path
[consumer_path_offset
],
7167 if (status
!= LTTNG_OK
) {
7174 case LTTNG_BUFFER_PER_PID
:
7176 lttng::urcu::read_lock_guard read_lock
;
7178 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7179 struct consumer_socket
*socket
;
7180 struct lttng_ht_iter chan_iter
;
7181 struct ust_app_channel
*ua_chan
;
7182 struct ust_app_session
*ua_sess
;
7183 lsu::registry_session
*registry
;
7184 char pathname
[PATH_MAX
];
7185 size_t consumer_path_offset
= 0;
7187 ua_sess
= lookup_session_by_app(usess
, app
);
7189 /* Session not associated with this app. */
7193 /* Get the right consumer socket for the application. */
7194 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, output
);
7196 status
= LTTNG_ERR_INVALID
;
7200 /* Add the UST default trace dir to path. */
7201 memset(pathname
, 0, sizeof(pathname
));
7202 ret
= snprintf(pathname
, sizeof(pathname
), "%s", ua_sess
->path
);
7204 status
= LTTNG_ERR_INVALID
;
7205 PERROR("snprintf snapshot path");
7208 /* Free path allowed on previous iteration. */
7210 trace_path
= setup_channel_trace_path(
7211 usess
->consumer
, pathname
, &consumer_path_offset
);
7213 status
= LTTNG_ERR_INVALID
;
7216 cds_lfht_for_each_entry (
7217 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7219 consumer_snapshot_channel(socket
,
7223 &trace_path
[consumer_path_offset
],
7224 nb_packets_per_stream
);
7228 case LTTNG_ERR_CHAN_NOT_FOUND
:
7235 registry
= get_session_registry(ua_sess
);
7237 DBG("Application session is being torn down. Skip application.");
7240 status
= consumer_snapshot_channel(socket
,
7241 registry
->_metadata_key
,
7244 &trace_path
[consumer_path_offset
],
7249 case LTTNG_ERR_CHAN_NOT_FOUND
:
7268 * Return the size taken by one more packet per stream.
7270 uint64_t ust_app_get_size_one_more_packet_per_stream(const struct ltt_ust_session
*usess
,
7271 uint64_t cur_nr_packets
)
7273 uint64_t tot_size
= 0;
7274 struct ust_app
*app
;
7275 struct lttng_ht_iter iter
;
7277 LTTNG_ASSERT(usess
);
7279 switch (usess
->buffer_type
) {
7280 case LTTNG_BUFFER_PER_UID
:
7282 struct buffer_reg_uid
*reg
;
7284 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7285 struct buffer_reg_channel
*buf_reg_chan
;
7287 lttng::urcu::read_lock_guard read_lock
;
7289 cds_lfht_for_each_entry (
7290 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7291 if (cur_nr_packets
>= buf_reg_chan
->num_subbuf
) {
7293 * Don't take channel into account if we
7294 * already grab all its packets.
7298 tot_size
+= buf_reg_chan
->subbuf_size
* buf_reg_chan
->stream_count
;
7303 case LTTNG_BUFFER_PER_PID
:
7305 lttng::urcu::read_lock_guard read_lock
;
7307 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7308 struct ust_app_channel
*ua_chan
;
7309 struct ust_app_session
*ua_sess
;
7310 struct lttng_ht_iter chan_iter
;
7312 ua_sess
= lookup_session_by_app(usess
, app
);
7314 /* Session not associated with this app. */
7318 cds_lfht_for_each_entry (
7319 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7320 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
7322 * Don't take channel into account if we
7323 * already grab all its packets.
7327 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
7340 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
7341 struct cds_list_head
*buffer_reg_uid_list
,
7342 struct consumer_output
*consumer
,
7345 uint64_t *discarded
,
7349 uint64_t consumer_chan_key
;
7354 ret
= buffer_reg_uid_consumer_channel_key(
7355 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
7363 ret
= consumer_get_lost_packets(ust_session_id
, consumer_chan_key
, consumer
, lost
);
7365 ret
= consumer_get_discarded_events(
7366 ust_session_id
, consumer_chan_key
, consumer
, discarded
);
7373 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
7374 struct ltt_ust_channel
*uchan
,
7375 struct consumer_output
*consumer
,
7377 uint64_t *discarded
,
7381 struct lttng_ht_iter iter
;
7382 struct lttng_ht_node_str
*ua_chan_node
;
7383 struct ust_app
*app
;
7384 struct ust_app_session
*ua_sess
;
7385 struct ust_app_channel
*ua_chan
;
7391 * Iterate over every registered applications. Sum counters for
7392 * all applications containing requested session and channel.
7394 lttng::urcu::read_lock_guard read_lock
;
7396 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7397 struct lttng_ht_iter uiter
;
7399 ua_sess
= lookup_session_by_app(usess
, app
);
7400 if (ua_sess
== nullptr) {
7405 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
7406 ua_chan_node
= lttng_ht_iter_get_node
<lttng_ht_node_str
>(&uiter
);
7407 /* If the session is found for the app, the channel must be there */
7408 LTTNG_ASSERT(ua_chan_node
);
7410 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
7415 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
, consumer
, &_lost
);
7421 uint64_t _discarded
;
7423 ret
= consumer_get_discarded_events(
7424 usess
->id
, ua_chan
->key
, consumer
, &_discarded
);
7428 (*discarded
) += _discarded
;
7435 static int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
, struct ust_app
*app
)
7438 struct ust_app_session
*ua_sess
;
7440 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
7442 lttng::urcu::read_lock_guard read_lock
;
7443 const auto update_health_code_on_exit
=
7444 lttng::make_scope_exit([]() noexcept
{ health_code_update(); });
7446 ua_sess
= lookup_session_by_app(usess
, app
);
7447 if (ua_sess
== nullptr) {
7448 /* The session is in teardown process. Ignore and continue. */
7452 const auto locked_ua_sess
= ua_sess
->lock();
7453 if (locked_ua_sess
->deleted
) {
7457 pthread_mutex_lock(&app
->sock_lock
);
7458 ret
= lttng_ust_ctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
7459 pthread_mutex_unlock(&app
->sock_lock
);
7464 * Regenerate the statedump for each app in the session.
7466 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
7469 struct lttng_ht_iter iter
;
7470 struct ust_app
*app
;
7472 DBG("Regenerating the metadata for all UST apps");
7474 lttng::urcu::read_lock_guard read_lock
;
7476 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7477 if (!app
->compatible
) {
7481 ret
= ust_app_regenerate_statedump(usess
, app
);
7483 /* Continue to the next app even on error */
7492 * Rotate all the channels of a session.
7494 * Return LTTNG_OK on success or else an LTTng error code.
7496 enum lttng_error_code
ust_app_rotate_session(const ltt_session::locked_ref
& session
)
7499 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7500 struct lttng_ht_iter iter
;
7501 struct ltt_ust_session
*usess
= session
->ust_session
;
7503 LTTNG_ASSERT(usess
);
7505 switch (usess
->buffer_type
) {
7506 case LTTNG_BUFFER_PER_UID
:
7508 struct buffer_reg_uid
*reg
;
7510 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7511 struct buffer_reg_channel
*buf_reg_chan
;
7512 struct consumer_socket
*socket
;
7513 lttng::urcu::read_lock_guard read_lock
;
7515 /* Get consumer socket to use to push the metadata.*/
7516 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7519 cmd_ret
= LTTNG_ERR_INVALID
;
7523 /* Rotate the data channels. */
7524 cds_lfht_for_each_entry (
7525 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7526 ret
= consumer_rotate_channel(socket
,
7527 buf_reg_chan
->consumer_key
,
7529 /* is_metadata_channel */ false);
7531 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7537 * The metadata channel might not be present.
7539 * Consumer stream allocation can be done
7540 * asynchronously and can fail on intermediary
7541 * operations (i.e add context) and lead to data
7542 * channels created with no metadata channel.
7544 if (!reg
->registry
->reg
.ust
->_metadata_key
) {
7545 /* Skip since no metadata is present. */
7550 auto locked_registry
= reg
->registry
->reg
.ust
->lock();
7551 (void) push_metadata(locked_registry
, usess
->consumer
);
7554 ret
= consumer_rotate_channel(socket
,
7555 reg
->registry
->reg
.ust
->_metadata_key
,
7557 /* is_metadata_channel */ true);
7559 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7565 case LTTNG_BUFFER_PER_PID
:
7567 lttng::urcu::read_lock_guard read_lock
;
7570 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, raw_app
, pid_n
.node
) {
7571 struct consumer_socket
*socket
;
7572 struct lttng_ht_iter chan_iter
;
7573 struct ust_app_channel
*ua_chan
;
7574 struct ust_app_session
*ua_sess
;
7575 lsu::registry_session
*registry
;
7576 bool app_reference_taken
;
7578 app_reference_taken
= ust_app_get(*raw_app
);
7579 if (!app_reference_taken
) {
7580 /* Application unregistered concurrently, skip it. */
7581 DBG("Could not get application reference as it is being torn down; skipping application");
7585 ust_app_reference
app(raw_app
);
7588 ua_sess
= lookup_session_by_app(usess
, app
.get());
7590 /* Session not associated with this app. */
7594 /* Get the right consumer socket for the application. */
7595 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7598 cmd_ret
= LTTNG_ERR_INVALID
;
7602 registry
= get_session_registry(ua_sess
);
7603 LTTNG_ASSERT(registry
);
7605 /* Rotate the data channels. */
7606 cds_lfht_for_each_entry (
7607 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7608 ret
= consumer_rotate_channel(socket
,
7611 /* is_metadata_channel */ false);
7613 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7618 /* Rotate the metadata channel. */
7620 auto locked_registry
= registry
->lock();
7622 (void) push_metadata(locked_registry
, usess
->consumer
);
7625 ret
= consumer_rotate_channel(socket
,
7626 registry
->_metadata_key
,
7628 /* is_metadata_channel */ true);
7630 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7648 enum lttng_error_code
ust_app_create_channel_subdirectories(const struct ltt_ust_session
*usess
)
7650 enum lttng_error_code ret
= LTTNG_OK
;
7651 struct lttng_ht_iter iter
;
7652 enum lttng_trace_chunk_status chunk_status
;
7653 char *pathname_index
;
7656 LTTNG_ASSERT(usess
->current_trace_chunk
);
7658 switch (usess
->buffer_type
) {
7659 case LTTNG_BUFFER_PER_UID
:
7661 struct buffer_reg_uid
*reg
;
7662 lttng::urcu::read_lock_guard read_lock
;
7664 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7665 fmt_ret
= asprintf(&pathname_index
,
7666 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
7667 "/" DEFAULT_INDEX_DIR
,
7669 reg
->bits_per_long
);
7671 ERR("Failed to format channel index directory");
7672 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7677 * Create the index subdirectory which will take care
7678 * of implicitly creating the channel's path.
7680 chunk_status
= lttng_trace_chunk_create_subdirectory(
7681 usess
->current_trace_chunk
, pathname_index
);
7682 free(pathname_index
);
7683 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7684 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7690 case LTTNG_BUFFER_PER_PID
:
7692 struct ust_app
*app
;
7693 lttng::urcu::read_lock_guard read_lock
;
7696 * Create the toplevel ust/ directory in case no apps are running.
7698 chunk_status
= lttng_trace_chunk_create_subdirectory(usess
->current_trace_chunk
,
7699 DEFAULT_UST_TRACE_DIR
);
7700 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7701 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7705 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7706 struct ust_app_session
*ua_sess
;
7707 lsu::registry_session
*registry
;
7709 ua_sess
= lookup_session_by_app(usess
, app
);
7711 /* Session not associated with this app. */
7715 registry
= get_session_registry(ua_sess
);
7717 DBG("Application session is being torn down. Skip application.");
7721 fmt_ret
= asprintf(&pathname_index
,
7722 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7725 ERR("Failed to format channel index directory");
7726 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7730 * Create the index subdirectory which will take care
7731 * of implicitly creating the channel's path.
7733 chunk_status
= lttng_trace_chunk_create_subdirectory(
7734 usess
->current_trace_chunk
, pathname_index
);
7735 free(pathname_index
);
7736 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7737 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7753 * Clear all the channels of a session.
7755 * Return LTTNG_OK on success or else an LTTng error code.
7757 enum lttng_error_code
ust_app_clear_session(const ltt_session::locked_ref
& session
)
7760 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7761 struct lttng_ht_iter iter
;
7762 struct ust_app
*app
;
7763 struct ltt_ust_session
*usess
= session
->ust_session
;
7765 LTTNG_ASSERT(usess
);
7767 if (usess
->active
) {
7768 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7769 cmd_ret
= LTTNG_ERR_FATAL
;
7773 switch (usess
->buffer_type
) {
7774 case LTTNG_BUFFER_PER_UID
:
7776 struct buffer_reg_uid
*reg
;
7777 lttng::urcu::read_lock_guard read_lock
;
7779 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7780 struct buffer_reg_channel
*buf_reg_chan
;
7781 struct consumer_socket
*socket
;
7783 /* Get consumer socket to use to push the metadata.*/
7784 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7787 cmd_ret
= LTTNG_ERR_INVALID
;
7791 /* Clear the data channels. */
7792 cds_lfht_for_each_entry (
7793 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7794 ret
= consumer_clear_channel(socket
, buf_reg_chan
->consumer_key
);
7801 auto locked_registry
= reg
->registry
->reg
.ust
->lock();
7802 (void) push_metadata(locked_registry
, usess
->consumer
);
7806 * Clear the metadata channel.
7807 * Metadata channel is not cleared per se but we still need to
7808 * perform a rotation operation on it behind the scene.
7810 ret
= consumer_clear_channel(socket
, reg
->registry
->reg
.ust
->_metadata_key
);
7817 case LTTNG_BUFFER_PER_PID
:
7819 lttng::urcu::read_lock_guard read_lock
;
7821 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7822 struct consumer_socket
*socket
;
7823 struct lttng_ht_iter chan_iter
;
7824 struct ust_app_channel
*ua_chan
;
7825 struct ust_app_session
*ua_sess
;
7826 lsu::registry_session
*registry
;
7828 ua_sess
= lookup_session_by_app(usess
, app
);
7830 /* Session not associated with this app. */
7834 /* Get the right consumer socket for the application. */
7835 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7838 cmd_ret
= LTTNG_ERR_INVALID
;
7842 registry
= get_session_registry(ua_sess
);
7844 DBG("Application session is being torn down. Skip application.");
7848 /* Clear the data channels. */
7849 cds_lfht_for_each_entry (
7850 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7851 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7853 /* Per-PID buffer and application going away. */
7854 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7862 auto locked_registry
= registry
->lock();
7863 (void) push_metadata(locked_registry
, usess
->consumer
);
7867 * Clear the metadata channel.
7868 * Metadata channel is not cleared per se but we still need to
7869 * perform rotation operation on it behind the scene.
7871 ret
= consumer_clear_channel(socket
, registry
->_metadata_key
);
7873 /* Per-PID buffer and application going away. */
7874 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7892 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7893 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7896 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7905 * This function skips the metadata channel as the begin/end timestamps of a
7906 * metadata packet are useless.
7908 * Moreover, opening a packet after a "clear" will cause problems for live
7909 * sessions as it will introduce padding that was not part of the first trace
7910 * chunk. The relay daemon expects the content of the metadata stream of
7911 * successive metadata trace chunks to be strict supersets of one another.
7913 * For example, flushing a packet at the beginning of the metadata stream of
7914 * a trace chunk resulting from a "clear" session command will cause the
7915 * size of the metadata stream of the new trace chunk to not match the size of
7916 * the metadata stream of the original chunk. This will confuse the relay
7917 * daemon as the same "offset" in a metadata stream will no longer point
7918 * to the same content.
7920 enum lttng_error_code
ust_app_open_packets(const ltt_session::locked_ref
& session
)
7922 enum lttng_error_code ret
= LTTNG_OK
;
7923 struct lttng_ht_iter iter
;
7924 struct ltt_ust_session
*usess
= session
->ust_session
;
7926 LTTNG_ASSERT(usess
);
7928 switch (usess
->buffer_type
) {
7929 case LTTNG_BUFFER_PER_UID
:
7931 struct buffer_reg_uid
*reg
;
7933 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7934 struct buffer_reg_channel
*buf_reg_chan
;
7935 struct consumer_socket
*socket
;
7936 lttng::urcu::read_lock_guard read_lock
;
7938 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7941 ret
= LTTNG_ERR_FATAL
;
7945 cds_lfht_for_each_entry (
7946 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7947 const int open_ret
= consumer_open_channel_packets(
7948 socket
, buf_reg_chan
->consumer_key
);
7951 ret
= LTTNG_ERR_UNK
;
7958 case LTTNG_BUFFER_PER_PID
:
7960 struct ust_app
*app
;
7961 lttng::urcu::read_lock_guard read_lock
;
7963 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7964 struct consumer_socket
*socket
;
7965 struct lttng_ht_iter chan_iter
;
7966 struct ust_app_channel
*ua_chan
;
7967 struct ust_app_session
*ua_sess
;
7968 lsu::registry_session
*registry
;
7970 ua_sess
= lookup_session_by_app(usess
, app
);
7972 /* Session not associated with this app. */
7976 /* Get the right consumer socket for the application. */
7977 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7980 ret
= LTTNG_ERR_FATAL
;
7984 registry
= get_session_registry(ua_sess
);
7986 DBG("Application session is being torn down. Skip application.");
7990 cds_lfht_for_each_entry (
7991 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7992 const int open_ret
=
7993 consumer_open_channel_packets(socket
, ua_chan
->key
);
7997 * Per-PID buffer and application going
8000 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
8004 ret
= LTTNG_ERR_UNK
;
8020 lsu::ctl_field_quirks
ust_app::ctl_field_quirks() const
8023 * Application contexts are expressed as variants. LTTng-UST announces
8024 * those by registering an enumeration named `..._tag`. It then registers a
8025 * variant as part of the event context that contains the various possible
8028 * Unfortunately, the names used in the enumeration and variant don't
8029 * match: the enumeration names are all prefixed with an underscore while
8030 * the variant type tag fields aren't.
8032 * While the CTF 1.8.3 specification mentions that
8033 * underscores *should* (not *must*) be removed by CTF readers. Babeltrace
8034 * 1.x (and possibly others) expect a perfect match between the names used
8035 * by tags and variants.
8037 * When the UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS quirk is enabled,
8038 * the variant's fields are modified to match the mappings of its tag.
8040 * From ABI version >= 10.x, the variant fields and tag mapping names
8041 * correctly match, making this quirk unnecessary.
8043 return v_major
<= 9 ? lsu::ctl_field_quirks::UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS
:
8044 lsu::ctl_field_quirks::NONE
;
8047 static void ust_app_release(urcu_ref
*ref
)
8049 auto& app
= *lttng::utils::container_of(ref
, &ust_app::ref
);
8051 ust_app_unregister(app
);
8052 ust_app_destroy(app
);
8055 bool ust_app_get(ust_app
& app
)
8057 return urcu_ref_get_unless_zero(&app
.ref
);
8060 void ust_app_put(struct ust_app
*app
)
8066 urcu_ref_put(&app
->ref
, ust_app_release
);
8069 ust_app_session::const_locked_weak_ref
ust_app_session::lock() const noexcept
8071 pthread_mutex_lock(&_lock
);
8072 return ust_app_session::const_locked_weak_ref(*this);
8075 ust_app_session::locked_weak_ref
ust_app_session::lock() noexcept
8077 pthread_mutex_lock(&_lock
);
8078 return ust_app_session::locked_weak_ref(*this);
8081 void ust_app_session::_const_session_unlock(const ust_app_session
*session
)
8083 pthread_mutex_unlock(&session
->_lock
);
8086 void ust_app_session::_session_unlock(ust_app_session
*session
)
8088 pthread_mutex_unlock(&session
->_lock
);