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 static 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
;
508 ltt_session::ref session
;
510 session
= ltt_session::find_session(ua_chan
->session
->tracing_id
);
511 } catch (const lttng::sessiond::exceptions::session_not_found_error
& ex
) {
512 DBG_FMT("Failed to save per-pid lost/discarded counters: {}, location='{}'",
517 if (!session
|| !session
->ust_session
) {
519 * Not finding the session is not an error because there are
520 * multiple ways the channels can be torn down.
522 * 1) The session daemon can initiate the destruction of the
523 * ust app session after receiving a destroy command or
524 * during its shutdown/teardown.
525 * 2) The application, since we are in per-pid tracing, is
526 * unregistering and tearing down its ust app session.
528 * Both paths are protected by the session list lock which
529 * ensures that the accounting of lost packets and discarded
530 * events is done exactly once. The session is then unpublished
531 * from the session list, resulting in this condition.
536 if (ua_chan
->attr
.overwrite
) {
537 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
539 session
->ust_session
->consumer
,
542 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
544 session
->ust_session
->consumer
,
547 uchan
= trace_ust_find_channel_by_name(session
->ust_session
->domain_global
.channels
,
550 ERR("Missing UST channel to store discarded counters");
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 pthread_mutex_lock(&ua_sess
->lock
);
930 LTTNG_ASSERT(!ua_sess
->deleted
);
931 ua_sess
->deleted
= true;
933 auto locked_registry
= get_locked_session_registry(ua_sess
);
934 /* Registry can be null on error path during initialization. */
935 if (locked_registry
) {
936 /* Push metadata for application before freeing the application. */
937 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
940 cds_lfht_for_each_entry (ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
, node
.node
) {
941 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
943 delete_ust_app_channel(sock
, ua_chan
, app
, locked_registry
);
946 if (locked_registry
) {
948 * Don't ask to close metadata for global per UID buffers. Close
949 * metadata only on destroy trace session in this case. Also, the
950 * previous push metadata could have flag the metadata registry to
951 * close so don't send a close command if closed.
953 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
954 const auto metadata_key
= locked_registry
->_metadata_key
;
955 const auto consumer_bitness
= locked_registry
->abi
.bits_per_long
;
957 if (!locked_registry
->_metadata_closed
&& metadata_key
!= 0) {
958 locked_registry
->_metadata_closed
= true;
961 /* Release lock before communication, see comments in close_metadata(). */
962 locked_registry
.reset();
963 (void) close_metadata(metadata_key
, consumer_bitness
, ua_sess
->consumer
);
967 /* In case of per PID, the registry is kept in the session. */
968 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
969 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
972 * Registry can be null on error path during
975 buffer_reg_pid_remove(reg_pid
);
976 buffer_reg_pid_destroy(reg_pid
);
980 if (ua_sess
->handle
!= -1) {
981 pthread_mutex_lock(&app
->sock_lock
);
982 ret
= lttng_ust_ctl_release_handle(sock
, ua_sess
->handle
);
983 pthread_mutex_unlock(&app
->sock_lock
);
985 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
986 DBG3("UST app release session handle failed. Application is dead: pid = %d, sock = %d",
989 } else if (ret
== -EAGAIN
) {
990 WARN("UST app release session handle failed. Communication time out: pid = %d, sock = %d",
994 ERR("UST app release session handle failed with ret %d: pid = %d, sock = %d",
1001 /* Remove session from application UST object descriptor. */
1002 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
1003 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
1007 pthread_mutex_unlock(&ua_sess
->lock
);
1009 consumer_output_put(ua_sess
->consumer
);
1011 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
1015 * Delete a traceable application structure from the global list. Never call
1016 * this function outside of a call_rcu call.
1018 static void delete_ust_app(struct ust_app
*app
)
1021 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
1022 struct lttng_ht_iter iter
;
1023 struct ust_app_event_notifier_rule
*event_notifier_rule
;
1024 bool event_notifier_write_fd_is_open
;
1027 * The session list lock must be held during this function to guarantee
1028 * the existence of ua_sess.
1030 const auto list_lock
= lttng::sessiond::lock_session_list();
1031 /* Delete ust app sessions info */
1036 cds_list_for_each_entry_safe (ua_sess
, tmp_ua_sess
, &app
->teardown_head
, teardown_node
) {
1037 /* Free every object in the session and the session. */
1038 lttng::urcu::read_lock_guard read_lock
;
1039 delete_ust_app_session(sock
, ua_sess
, app
);
1042 /* Remove the event notifier rules associated with this app. */
1044 lttng::urcu::read_lock_guard read_lock
;
1046 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
1048 event_notifier_rule
,
1050 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
1053 delete_ust_app_event_notifier_rule(app
->sock
, event_notifier_rule
, app
);
1057 lttng_ht_destroy(app
->sessions
);
1058 lttng_ht_destroy(app
->ust_sessions_objd
);
1059 lttng_ht_destroy(app
->ust_objd
);
1060 lttng_ht_destroy(app
->token_to_event_notifier_rule_ht
);
1063 * This could be NULL if the event notifier setup failed (e.g the app
1064 * was killed or the tracer does not support this feature).
1066 if (app
->event_notifier_group
.object
) {
1067 enum lttng_error_code ret_code
;
1068 enum event_notifier_error_accounting_status status
;
1070 const int event_notifier_read_fd
=
1071 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
);
1073 ret_code
= notification_thread_command_remove_tracer_event_source(
1074 the_notification_thread_handle
, event_notifier_read_fd
);
1075 if (ret_code
!= LTTNG_OK
) {
1076 ERR("Failed to remove application tracer event source from notification thread");
1079 status
= event_notifier_error_accounting_unregister_app(app
);
1080 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1081 ERR("Error unregistering app from event notifier error accounting");
1084 lttng_ust_ctl_release_object(sock
, app
->event_notifier_group
.object
);
1085 free(app
->event_notifier_group
.object
);
1088 event_notifier_write_fd_is_open
=
1089 lttng_pipe_is_write_open(app
->event_notifier_group
.event_pipe
);
1090 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1092 * Release the file descriptors reserved for the event notifier pipe.
1093 * The app could be destroyed before the write end of the pipe could be
1094 * passed to the application (and closed). In that case, both file
1095 * descriptors must be released.
1097 lttng_fd_put(LTTNG_FD_APPS
, event_notifier_write_fd_is_open
? 2 : 1);
1100 * Wait until we have deleted the application from the sock hash table
1101 * before closing this socket, otherwise an application could re-use the
1102 * socket ID and race with the teardown, using the same hash table entry.
1104 * It's OK to leave the close in call_rcu. We want it to stay unique for
1105 * all RCU readers that could run concurrently with unregister app,
1106 * therefore we _need_ to only close that socket after a grace period. So
1107 * it should stay in this RCU callback.
1109 * This close() is a very important step of the synchronization model so
1110 * every modification to this function must be carefully reviewed.
1116 lttng_fd_put(LTTNG_FD_APPS
, 1);
1118 DBG2("UST app pid %d deleted", app
->pid
);
1123 * URCU intermediate call to delete an UST app.
1125 static void delete_ust_app_rcu(struct rcu_head
*head
)
1127 struct lttng_ht_node_ulong
*node
=
1128 lttng::utils::container_of(head
, <tng_ht_node_ulong::head
);
1129 struct ust_app
*app
= lttng::utils::container_of(node
, &ust_app::pid_n
);
1131 DBG3("Call RCU deleting app PID %d", app
->pid
);
1132 delete_ust_app(app
);
1136 * Delete the session from the application ht and delete the data structure by
1137 * freeing every object inside and releasing them.
1139 * The session list lock must be held by the caller.
1141 static void destroy_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
)
1144 struct lttng_ht_iter iter
;
1147 LTTNG_ASSERT(ua_sess
);
1149 iter
.iter
.node
= &ua_sess
->node
.node
;
1150 ret
= lttng_ht_del(app
->sessions
, &iter
);
1152 /* Already scheduled for teardown. */
1156 /* Once deleted, free the data structure. */
1157 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1164 * Alloc new UST app session.
1166 static struct ust_app_session
*alloc_ust_app_session()
1168 struct ust_app_session
*ua_sess
;
1170 /* Init most of the default value by allocating and zeroing */
1171 ua_sess
= zmalloc
<ust_app_session
>();
1172 if (ua_sess
== nullptr) {
1177 ua_sess
->handle
= -1;
1178 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1179 ua_sess
->metadata_attr
.type
= LTTNG_UST_ABI_CHAN_METADATA
;
1180 pthread_mutex_init(&ua_sess
->lock
, nullptr);
1189 * Alloc new UST app channel.
1191 static struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1192 struct ust_app_session
*ua_sess
,
1193 struct lttng_ust_abi_channel_attr
*attr
)
1195 struct ust_app_channel
*ua_chan
;
1197 /* Init most of the default value by allocating and zeroing */
1198 ua_chan
= zmalloc
<ust_app_channel
>();
1199 if (ua_chan
== nullptr) {
1204 /* Setup channel name */
1205 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1206 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1208 ua_chan
->enabled
= true;
1209 ua_chan
->handle
= -1;
1210 ua_chan
->session
= ua_sess
;
1211 ua_chan
->key
= get_next_channel_key();
1212 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1213 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1214 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1216 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1217 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1219 /* Copy attributes */
1221 /* Translate from lttng_ust_channel to lttng_ust_ctl_consumer_channel_attr. */
1222 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1223 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1224 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1225 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1226 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1227 ua_chan
->attr
.output
= (lttng_ust_abi_output
) attr
->output
;
1228 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1230 /* By default, the channel is a per cpu channel. */
1231 ua_chan
->attr
.type
= LTTNG_UST_ABI_CHAN_PER_CPU
;
1233 DBG3("UST app channel %s allocated", ua_chan
->name
);
1242 * Allocate and initialize a UST app stream.
1244 * Return newly allocated stream pointer or NULL on error.
1246 struct ust_app_stream
*ust_app_alloc_stream()
1248 struct ust_app_stream
*stream
= nullptr;
1250 stream
= zmalloc
<ust_app_stream
>();
1251 if (stream
== nullptr) {
1252 PERROR("zmalloc ust app stream");
1256 /* Zero could be a valid value for a handle so flag it to -1. */
1257 stream
->handle
= -1;
1264 * Alloc new UST app event.
1266 static struct ust_app_event
*alloc_ust_app_event(char *name
, struct lttng_ust_abi_event
*attr
)
1268 struct ust_app_event
*ua_event
;
1270 /* Init most of the default value by allocating and zeroing */
1271 ua_event
= zmalloc
<ust_app_event
>();
1272 if (ua_event
== nullptr) {
1273 PERROR("Failed to allocate ust_app_event structure");
1277 ua_event
->enabled
= true;
1278 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1279 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1280 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1282 /* Copy attributes */
1284 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1287 DBG3("UST app event %s allocated", ua_event
->name
);
1296 * Allocate a new UST app event notifier rule.
1298 static struct ust_app_event_notifier_rule
*
1299 alloc_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
)
1301 enum lttng_event_rule_generate_exclusions_status generate_exclusion_status
;
1302 enum lttng_condition_status cond_status
;
1303 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1304 struct lttng_condition
*condition
= nullptr;
1305 const struct lttng_event_rule
*event_rule
= nullptr;
1307 ua_event_notifier_rule
= zmalloc
<ust_app_event_notifier_rule
>();
1308 if (ua_event_notifier_rule
== nullptr) {
1309 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1313 ua_event_notifier_rule
->enabled
= true;
1314 ua_event_notifier_rule
->token
= lttng_trigger_get_tracer_token(trigger
);
1315 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
, ua_event_notifier_rule
->token
);
1317 condition
= lttng_trigger_get_condition(trigger
);
1318 LTTNG_ASSERT(condition
);
1319 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
1320 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
1322 cond_status
= lttng_condition_event_rule_matches_get_rule(condition
, &event_rule
);
1323 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
1324 LTTNG_ASSERT(event_rule
);
1326 ua_event_notifier_rule
->error_counter_index
=
1327 lttng_condition_event_rule_matches_get_error_counter_index(condition
);
1328 /* Acquire the event notifier's reference to the trigger. */
1329 lttng_trigger_get(trigger
);
1331 ua_event_notifier_rule
->trigger
= trigger
;
1332 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1333 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1334 event_rule
, &ua_event_notifier_rule
->exclusion
);
1335 switch (generate_exclusion_status
) {
1336 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1337 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1340 /* Error occurred. */
1341 ERR("Failed to generate exclusions from trigger while allocating an event notifier rule");
1342 goto error_put_trigger
;
1345 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1346 ua_event_notifier_rule
->token
);
1348 return ua_event_notifier_rule
;
1351 lttng_trigger_put(trigger
);
1353 free(ua_event_notifier_rule
);
1358 * Alloc new UST app context.
1360 static struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1362 struct ust_app_ctx
*ua_ctx
;
1364 ua_ctx
= zmalloc
<ust_app_ctx
>();
1365 if (ua_ctx
== nullptr) {
1369 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1372 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1373 if (uctx
->ctx
== LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
) {
1374 char *provider_name
= nullptr, *ctx_name
= nullptr;
1376 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1377 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1378 if (!provider_name
|| !ctx_name
) {
1379 free(provider_name
);
1384 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1385 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1389 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1397 * Create a liblttng-ust filter bytecode from given bytecode.
1399 * Return allocated filter or NULL on error.
1401 static struct lttng_ust_abi_filter_bytecode
*
1402 create_ust_filter_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1404 struct lttng_ust_abi_filter_bytecode
*filter
= nullptr;
1406 /* Copy filter bytecode. */
1407 filter
= zmalloc
<lttng_ust_abi_filter_bytecode
>(sizeof(*filter
) + orig_f
->len
);
1409 PERROR("Failed to allocate lttng_ust_filter_bytecode: bytecode len = %" PRIu32
1415 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) == sizeof(struct lttng_ust_abi_filter_bytecode
));
1416 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1422 * Create a liblttng-ust capture bytecode from given bytecode.
1424 * Return allocated filter or NULL on error.
1426 static struct lttng_ust_abi_capture_bytecode
*
1427 create_ust_capture_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1429 struct lttng_ust_abi_capture_bytecode
*capture
= nullptr;
1431 /* Copy capture bytecode. */
1432 capture
= zmalloc
<lttng_ust_abi_capture_bytecode
>(sizeof(*capture
) + orig_f
->len
);
1434 PERROR("Failed to allocate lttng_ust_abi_capture_bytecode: bytecode len = %" PRIu32
1440 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) ==
1441 sizeof(struct lttng_ust_abi_capture_bytecode
));
1442 memcpy(capture
, orig_f
, sizeof(*capture
) + orig_f
->len
);
1448 * Find an ust_app using the sock and return it. RCU read side lock must be
1449 * held before calling this helper function.
1451 struct ust_app
*ust_app_find_by_sock(int sock
)
1453 struct lttng_ht_node_ulong
*node
;
1454 struct lttng_ht_iter iter
;
1456 ASSERT_RCU_READ_LOCKED();
1458 lttng_ht_lookup(ust_app_ht_by_sock
, (void *) ((unsigned long) sock
), &iter
);
1459 node
= lttng_ht_iter_get_node_ulong(&iter
);
1460 if (node
== nullptr) {
1461 DBG2("UST app find by sock %d not found", sock
);
1465 return lttng::utils::container_of(node
, &ust_app::sock_n
);
1472 * Find an ust_app using the notify sock and return it. RCU read side lock must
1473 * be held before calling this helper function.
1475 static struct ust_app
*find_app_by_notify_sock(int sock
)
1477 struct lttng_ht_node_ulong
*node
;
1478 struct lttng_ht_iter iter
;
1480 ASSERT_RCU_READ_LOCKED();
1482 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *) ((unsigned long) sock
), &iter
);
1483 node
= lttng_ht_iter_get_node_ulong(&iter
);
1484 if (node
== nullptr) {
1485 DBG2("UST app find by notify sock %d not found", sock
);
1489 return lttng::utils::container_of(node
, &ust_app::notify_sock_n
);
1496 * Lookup for an ust app event based on event name, filter bytecode and the
1499 * Return an ust_app_event object or NULL on error.
1501 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1503 const struct lttng_bytecode
*filter
,
1504 lttng_ust_abi_loglevel_type loglevel_type
,
1506 const struct lttng_event_exclusion
*exclusion
)
1508 struct lttng_ht_iter iter
;
1509 struct lttng_ht_node_str
*node
;
1510 struct ust_app_event
*event
= nullptr;
1511 struct ust_app_ht_key key
;
1516 /* Setup key for event lookup. */
1518 key
.filter
= filter
;
1519 key
.loglevel_type
= loglevel_type
;
1520 key
.loglevel_value
= loglevel_value
;
1521 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1522 key
.exclusion
= exclusion
;
1524 /* Lookup using the event name as hash and a custom match fct. */
1525 cds_lfht_lookup(ht
->ht
,
1526 ht
->hash_fct((void *) name
, lttng_ht_seed
),
1527 ht_match_ust_app_event
,
1530 node
= lttng_ht_iter_get_node_str(&iter
);
1531 if (node
== nullptr) {
1535 event
= lttng::utils::container_of(node
, &ust_app_event::node
);
1542 * Look-up an event notifier rule based on its token id.
1544 * Must be called with the RCU read lock held.
1545 * Return an ust_app_event_notifier_rule object or NULL on error.
1547 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(struct lttng_ht
*ht
,
1550 struct lttng_ht_iter iter
;
1551 struct lttng_ht_node_u64
*node
;
1552 struct ust_app_event_notifier_rule
*event_notifier_rule
= nullptr;
1555 ASSERT_RCU_READ_LOCKED();
1557 lttng_ht_lookup(ht
, &token
, &iter
);
1558 node
= lttng_ht_iter_get_node_u64(&iter
);
1559 if (node
== nullptr) {
1560 DBG2("UST app event notifier rule token not found: token = %" PRIu64
, token
);
1564 event_notifier_rule
= lttng::utils::container_of(node
, &ust_app_event_notifier_rule::node
);
1566 return event_notifier_rule
;
1570 * Create the channel context on the tracer.
1572 * Called with UST app session lock held.
1574 static int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1575 struct ust_app_ctx
*ua_ctx
,
1576 struct ust_app
*app
)
1580 health_code_update();
1582 pthread_mutex_lock(&app
->sock_lock
);
1583 ret
= lttng_ust_ctl_add_context(app
->sock
, &ua_ctx
->ctx
, ua_chan
->obj
, &ua_ctx
->obj
);
1584 pthread_mutex_unlock(&app
->sock_lock
);
1586 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1588 DBG3("UST app create channel context failed. Application is dead: pid = %d, sock = %d",
1591 } else if (ret
== -EAGAIN
) {
1593 WARN("UST app create channel context failed. Communication time out: pid = %d, sock = %d",
1597 ERR("UST app create channel context failed with ret %d: pid = %d, sock = %d",
1605 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1607 DBG2("UST app context handle %d created successfully for channel %s",
1612 health_code_update();
1617 * Set the filter on the tracer.
1619 static int set_ust_object_filter(struct ust_app
*app
,
1620 const struct lttng_bytecode
*bytecode
,
1621 struct lttng_ust_abi_object_data
*ust_object
)
1624 struct lttng_ust_abi_filter_bytecode
*ust_bytecode
= nullptr;
1626 health_code_update();
1628 ust_bytecode
= create_ust_filter_bytecode_from_bytecode(bytecode
);
1629 if (!ust_bytecode
) {
1630 ret
= -LTTNG_ERR_NOMEM
;
1633 pthread_mutex_lock(&app
->sock_lock
);
1634 ret
= lttng_ust_ctl_set_filter(app
->sock
, ust_bytecode
, ust_object
);
1635 pthread_mutex_unlock(&app
->sock_lock
);
1637 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1639 DBG3("UST app set filter failed. Application is dead: pid = %d, sock = %d",
1642 } else if (ret
== -EAGAIN
) {
1644 WARN("UST app set filter failed. Communication time out: pid = %d, sock = %d",
1648 ERR("UST app set filter failed with ret %d: pid = %d, sock = %d, object = %p",
1657 DBG2("UST filter successfully set: object = %p", ust_object
);
1660 health_code_update();
1666 * Set a capture bytecode for the passed object.
1667 * The sequence number enforces the ordering at runtime and on reception of
1668 * the captured payloads.
1670 static int set_ust_capture(struct ust_app
*app
,
1671 const struct lttng_bytecode
*bytecode
,
1672 unsigned int capture_seqnum
,
1673 struct lttng_ust_abi_object_data
*ust_object
)
1676 struct lttng_ust_abi_capture_bytecode
*ust_bytecode
= nullptr;
1678 health_code_update();
1680 ust_bytecode
= create_ust_capture_bytecode_from_bytecode(bytecode
);
1681 if (!ust_bytecode
) {
1682 ret
= -LTTNG_ERR_NOMEM
;
1687 * Set the sequence number to ensure the capture of fields is ordered.
1689 ust_bytecode
->seqnum
= capture_seqnum
;
1691 pthread_mutex_lock(&app
->sock_lock
);
1692 ret
= lttng_ust_ctl_set_capture(app
->sock
, ust_bytecode
, ust_object
);
1693 pthread_mutex_unlock(&app
->sock_lock
);
1695 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1697 DBG3("UST app set capture failed. Application is dead: pid = %d, sock = %d",
1700 } else if (ret
== -EAGAIN
) {
1702 DBG3("UST app set capture failed. Communication timeout: pid = %d, sock = %d",
1706 ERR("UST app event set capture failed with ret %d: pid = %d, sock = %d",
1715 DBG2("UST capture successfully set: object = %p", ust_object
);
1718 health_code_update();
1723 static struct lttng_ust_abi_event_exclusion
*
1724 create_ust_exclusion_from_exclusion(const struct lttng_event_exclusion
*exclusion
)
1726 struct lttng_ust_abi_event_exclusion
*ust_exclusion
= nullptr;
1727 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_abi_event_exclusion
) +
1728 LTTNG_UST_ABI_SYM_NAME_LEN
* exclusion
->count
;
1730 ust_exclusion
= zmalloc
<lttng_ust_abi_event_exclusion
>(exclusion_alloc_size
);
1731 if (!ust_exclusion
) {
1736 LTTNG_ASSERT(sizeof(struct lttng_event_exclusion
) ==
1737 sizeof(struct lttng_ust_abi_event_exclusion
));
1738 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1740 return ust_exclusion
;
1744 * Set event exclusions on the tracer.
1746 static int set_ust_object_exclusions(struct ust_app
*app
,
1747 const struct lttng_event_exclusion
*exclusions
,
1748 struct lttng_ust_abi_object_data
*ust_object
)
1751 struct lttng_ust_abi_event_exclusion
*ust_exclusions
= nullptr;
1753 LTTNG_ASSERT(exclusions
&& exclusions
->count
> 0);
1755 health_code_update();
1757 ust_exclusions
= create_ust_exclusion_from_exclusion(exclusions
);
1758 if (!ust_exclusions
) {
1759 ret
= -LTTNG_ERR_NOMEM
;
1762 pthread_mutex_lock(&app
->sock_lock
);
1763 ret
= lttng_ust_ctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1764 pthread_mutex_unlock(&app
->sock_lock
);
1766 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1768 DBG3("UST app event exclusion failed. Application is dead: pid = %d, sock = %d",
1771 } else if (ret
== -EAGAIN
) {
1773 WARN("UST app event exclusion failed. Communication time out(pid: %d, sock = %d",
1777 ERR("UST app event exclusions failed with ret %d: pid = %d, sock = %d, object = %p",
1786 DBG2("UST exclusions set successfully for object %p", ust_object
);
1789 health_code_update();
1790 free(ust_exclusions
);
1795 * Disable the specified event on to UST tracer for the UST session.
1797 static int disable_ust_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*object
)
1801 health_code_update();
1803 pthread_mutex_lock(&app
->sock_lock
);
1804 ret
= lttng_ust_ctl_disable(app
->sock
, object
);
1805 pthread_mutex_unlock(&app
->sock_lock
);
1807 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1809 DBG3("UST app disable object failed. Application is dead: pid = %d, sock = %d",
1812 } else if (ret
== -EAGAIN
) {
1814 WARN("UST app disable object failed. Communication time out: pid = %d, sock = %d",
1818 ERR("UST app disable object failed with ret %d: pid = %d, sock = %d, object = %p",
1827 DBG2("UST app object %p disabled successfully for app: pid = %d", object
, app
->pid
);
1830 health_code_update();
1835 * Disable the specified channel on to UST tracer for the UST session.
1837 static int disable_ust_channel(struct ust_app
*app
,
1838 struct ust_app_session
*ua_sess
,
1839 struct ust_app_channel
*ua_chan
)
1843 health_code_update();
1845 pthread_mutex_lock(&app
->sock_lock
);
1846 ret
= lttng_ust_ctl_disable(app
->sock
, ua_chan
->obj
);
1847 pthread_mutex_unlock(&app
->sock_lock
);
1849 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1851 DBG3("UST app disable channel failed. Application is dead: pid = %d, sock = %d",
1854 } else if (ret
== -EAGAIN
) {
1856 WARN("UST app disable channel failed. Communication time out: pid = %d, sock = %d",
1860 ERR("UST app channel %s disable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1870 DBG2("UST app channel %s disabled successfully for app: pid = %d", ua_chan
->name
, app
->pid
);
1873 health_code_update();
1878 * Enable the specified channel on to UST tracer for the UST session.
1880 static int enable_ust_channel(struct ust_app
*app
,
1881 struct ust_app_session
*ua_sess
,
1882 struct ust_app_channel
*ua_chan
)
1886 health_code_update();
1888 pthread_mutex_lock(&app
->sock_lock
);
1889 ret
= lttng_ust_ctl_enable(app
->sock
, ua_chan
->obj
);
1890 pthread_mutex_unlock(&app
->sock_lock
);
1892 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1894 DBG3("UST app channel %s enable failed. Application is dead: pid = %d, sock = %d",
1898 } else if (ret
== -EAGAIN
) {
1900 WARN("UST app channel %s enable failed. Communication time out: pid = %d, sock = %d",
1905 ERR("UST app channel %s enable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1915 ua_chan
->enabled
= true;
1917 DBG2("UST app channel %s enabled successfully for app: pid = %d", ua_chan
->name
, app
->pid
);
1920 health_code_update();
1925 * Enable the specified event on to UST tracer for the UST session.
1927 static int enable_ust_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*ust_object
)
1931 health_code_update();
1933 pthread_mutex_lock(&app
->sock_lock
);
1934 ret
= lttng_ust_ctl_enable(app
->sock
, ust_object
);
1935 pthread_mutex_unlock(&app
->sock_lock
);
1937 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1939 DBG3("UST app enable object failed. Application is dead: pid = %d, sock = %d",
1942 } else if (ret
== -EAGAIN
) {
1944 WARN("UST app enable object failed. Communication time out: pid = %d, sock = %d",
1948 ERR("UST app enable object failed with ret %d: pid = %d, sock = %d, object = %p",
1957 DBG2("UST app object %p enabled successfully for app: pid = %d", ust_object
, app
->pid
);
1960 health_code_update();
1965 * Send channel and stream buffer to application.
1967 * Return 0 on success. On error, a negative value is returned.
1969 static int send_channel_pid_to_ust(struct ust_app
*app
,
1970 struct ust_app_session
*ua_sess
,
1971 struct ust_app_channel
*ua_chan
)
1974 struct ust_app_stream
*stream
, *stmp
;
1977 LTTNG_ASSERT(ua_sess
);
1978 LTTNG_ASSERT(ua_chan
);
1980 health_code_update();
1982 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
, app
->sock
);
1984 /* Send channel to the application. */
1985 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1986 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1987 ret
= -ENOTCONN
; /* Caused by app exiting. */
1989 } else if (ret
== -EAGAIN
) {
1990 /* Caused by timeout. */
1991 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
1995 ua_sess
->tracing_id
);
1996 /* Treat this the same way as an application that is exiting. */
1999 } else if (ret
< 0) {
2003 health_code_update();
2005 /* Send all streams to application. */
2006 cds_list_for_each_entry_safe (stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2007 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
2008 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2009 ret
= -ENOTCONN
; /* Caused by app exiting. */
2011 } else if (ret
== -EAGAIN
) {
2012 /* Caused by timeout. */
2013 WARN("Communication with application %d timed out on send_stream for stream \"%s\" of channel \"%s\" of session \"%" PRIu64
2018 ua_sess
->tracing_id
);
2020 * Treat this the same way as an application that is
2024 } else if (ret
< 0) {
2027 /* We don't need the stream anymore once sent to the tracer. */
2028 cds_list_del(&stream
->list
);
2029 delete_ust_app_stream(-1, stream
, app
);
2033 health_code_update();
2038 * Create the specified event onto the UST tracer for a UST session.
2040 * Should be called with session mutex held.
2042 static int create_ust_event(struct ust_app
*app
,
2043 struct ust_app_channel
*ua_chan
,
2044 struct ust_app_event
*ua_event
)
2048 health_code_update();
2050 /* Create UST event on tracer */
2051 pthread_mutex_lock(&app
->sock_lock
);
2052 ret
= lttng_ust_ctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
, &ua_event
->obj
);
2053 pthread_mutex_unlock(&app
->sock_lock
);
2055 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2057 DBG3("UST app create event failed. Application is dead: pid = %d, sock = %d",
2060 } else if (ret
== -EAGAIN
) {
2062 WARN("UST app create event failed. Communication time out: pid = %d, sock = %d",
2066 ERR("UST app create event '%s' failed with ret %d: pid = %d, sock = %d",
2067 ua_event
->attr
.name
,
2075 ua_event
->handle
= ua_event
->obj
->handle
;
2077 DBG2("UST app event %s created successfully for pid:%d object = %p",
2078 ua_event
->attr
.name
,
2082 health_code_update();
2084 /* Set filter if one is present. */
2085 if (ua_event
->filter
) {
2086 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
2092 /* Set exclusions for the event */
2093 if (ua_event
->exclusion
) {
2094 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
2100 /* If event not enabled, disable it on the tracer */
2101 if (ua_event
->enabled
) {
2103 * We now need to explicitly enable the event, since it
2104 * is now disabled at creation.
2106 ret
= enable_ust_object(app
, ua_event
->obj
);
2109 * If we hit an EPERM, something is wrong with our enable call. If
2110 * we get an EEXIST, there is a problem on the tracer side since we
2114 case -LTTNG_UST_ERR_PERM
:
2115 /* Code flow problem */
2117 case -LTTNG_UST_ERR_EXIST
:
2118 /* It's OK for our use case. */
2129 health_code_update();
2134 init_ust_event_notifier_from_event_rule(const struct lttng_event_rule
*rule
,
2135 struct lttng_ust_abi_event_notifier
*event_notifier
)
2137 enum lttng_event_rule_status status
;
2138 enum lttng_ust_abi_loglevel_type ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2139 int loglevel
= -1, ret
= 0;
2140 const char *pattern
;
2142 memset(event_notifier
, 0, sizeof(*event_notifier
));
2144 if (lttng_event_rule_targets_agent_domain(rule
)) {
2146 * Special event for agents
2147 * The actual meat of the event is in the filter that will be
2148 * attached later on.
2149 * Set the default values for the agent event.
2151 pattern
= event_get_default_agent_ust_name(lttng_event_rule_get_domain_type(rule
));
2153 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2155 const struct lttng_log_level_rule
*log_level_rule
;
2157 LTTNG_ASSERT(lttng_event_rule_get_type(rule
) ==
2158 LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
);
2160 status
= lttng_event_rule_user_tracepoint_get_name_pattern(rule
, &pattern
);
2161 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2162 /* At this point, this is a fatal error. */
2166 status
= lttng_event_rule_user_tracepoint_get_log_level_rule(rule
, &log_level_rule
);
2167 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
2168 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2169 } else if (status
== LTTNG_EVENT_RULE_STATUS_OK
) {
2170 enum lttng_log_level_rule_status llr_status
;
2172 switch (lttng_log_level_rule_get_type(log_level_rule
)) {
2173 case LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY
:
2174 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_SINGLE
;
2175 llr_status
= lttng_log_level_rule_exactly_get_level(log_level_rule
,
2178 case LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS
:
2179 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_RANGE
;
2180 llr_status
= lttng_log_level_rule_at_least_as_severe_as_get_level(
2181 log_level_rule
, &loglevel
);
2187 LTTNG_ASSERT(llr_status
== LTTNG_LOG_LEVEL_RULE_STATUS_OK
);
2189 /* At this point this is a fatal error. */
2194 event_notifier
->event
.instrumentation
= LTTNG_UST_ABI_TRACEPOINT
;
2195 ret
= lttng_strncpy(
2196 event_notifier
->event
.name
, pattern
, sizeof(event_notifier
->event
.name
));
2198 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ", pattern
);
2202 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
2203 event_notifier
->event
.loglevel
= loglevel
;
2209 * Create the specified event notifier against the user space tracer of a
2210 * given application.
2212 static int create_ust_event_notifier(struct ust_app
*app
,
2213 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2216 enum lttng_condition_status condition_status
;
2217 const struct lttng_condition
*condition
= nullptr;
2218 struct lttng_ust_abi_event_notifier event_notifier
;
2219 const struct lttng_event_rule
*event_rule
= nullptr;
2220 unsigned int capture_bytecode_count
= 0, i
;
2221 enum lttng_condition_status cond_status
;
2222 enum lttng_event_rule_type event_rule_type
;
2224 health_code_update();
2225 LTTNG_ASSERT(app
->event_notifier_group
.object
);
2227 condition
= lttng_trigger_get_const_condition(ua_event_notifier_rule
->trigger
);
2228 LTTNG_ASSERT(condition
);
2229 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
2230 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
2232 condition_status
= lttng_condition_event_rule_matches_get_rule(condition
, &event_rule
);
2233 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2235 LTTNG_ASSERT(event_rule
);
2237 event_rule_type
= lttng_event_rule_get_type(event_rule
);
2238 LTTNG_ASSERT(event_rule_type
== LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
||
2239 event_rule_type
== LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
||
2240 event_rule_type
== LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
||
2241 event_rule_type
== LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
);
2243 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2244 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2245 event_notifier
.error_counter_index
= ua_event_notifier_rule
->error_counter_index
;
2247 /* Create UST event notifier against the tracer. */
2248 pthread_mutex_lock(&app
->sock_lock
);
2249 ret
= lttng_ust_ctl_create_event_notifier(app
->sock
,
2251 app
->event_notifier_group
.object
,
2252 &ua_event_notifier_rule
->obj
);
2253 pthread_mutex_unlock(&app
->sock_lock
);
2255 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2257 DBG3("UST app create event notifier failed. Application is dead: pid = %d, sock = %d",
2260 } else if (ret
== -EAGAIN
) {
2262 WARN("UST app create event notifier failed. Communication time out: pid = %d, sock = %d",
2266 ERR("UST app create event notifier '%s' failed with ret %d: pid = %d, sock = %d",
2267 event_notifier
.event
.name
,
2275 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2277 DBG2("UST app event notifier %s created successfully: app = '%s': pid = %d, object = %p",
2278 event_notifier
.event
.name
,
2281 ua_event_notifier_rule
->obj
);
2283 health_code_update();
2285 /* Set filter if one is present. */
2286 if (ua_event_notifier_rule
->filter
) {
2287 ret
= set_ust_object_filter(
2288 app
, ua_event_notifier_rule
->filter
, ua_event_notifier_rule
->obj
);
2294 /* Set exclusions for the event. */
2295 if (ua_event_notifier_rule
->exclusion
) {
2296 ret
= set_ust_object_exclusions(
2297 app
, ua_event_notifier_rule
->exclusion
, ua_event_notifier_rule
->obj
);
2303 /* Set the capture bytecodes. */
2304 cond_status
= lttng_condition_event_rule_matches_get_capture_descriptor_count(
2305 condition
, &capture_bytecode_count
);
2306 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
2308 for (i
= 0; i
< capture_bytecode_count
; i
++) {
2309 const struct lttng_bytecode
*capture_bytecode
=
2310 lttng_condition_event_rule_matches_get_capture_bytecode_at_index(condition
,
2313 ret
= set_ust_capture(app
, capture_bytecode
, i
, ua_event_notifier_rule
->obj
);
2320 * We now need to explicitly enable the event, since it
2321 * is disabled at creation.
2323 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2326 * If we hit an EPERM, something is wrong with our enable call.
2327 * If we get an EEXIST, there is a problem on the tracer side
2328 * since we just created it.
2331 case -LTTNG_UST_ERR_PERM
:
2332 /* Code flow problem. */
2334 case -LTTNG_UST_ERR_EXIST
:
2335 /* It's OK for our use case. */
2345 ua_event_notifier_rule
->enabled
= true;
2348 health_code_update();
2353 * Copy data between an UST app event and a LTT event.
2355 static void shadow_copy_event(struct ust_app_event
*ua_event
, struct ltt_ust_event
*uevent
)
2357 size_t exclusion_alloc_size
;
2359 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2360 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2362 ua_event
->enabled
= uevent
->enabled
;
2364 /* Copy event attributes */
2365 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2367 /* Copy filter bytecode */
2368 if (uevent
->filter
) {
2369 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2370 /* Filter might be NULL here in case of ENONEM. */
2373 /* Copy exclusion data */
2374 if (uevent
->exclusion
) {
2375 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2376 LTTNG_UST_ABI_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2377 ua_event
->exclusion
= zmalloc
<lttng_event_exclusion
>(exclusion_alloc_size
);
2378 if (ua_event
->exclusion
== nullptr) {
2381 memcpy(ua_event
->exclusion
, uevent
->exclusion
, exclusion_alloc_size
);
2387 * Copy data between an UST app channel and a LTT channel.
2389 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
, struct ltt_ust_channel
*uchan
)
2391 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2393 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2394 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2396 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2397 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2399 /* Copy event attributes since the layout is different. */
2400 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2401 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2402 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2403 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2404 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2405 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2406 ua_chan
->attr
.output
= (lttng_ust_abi_output
) uchan
->attr
.output
;
2407 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2410 * Note that the attribute channel type is not set since the channel on the
2411 * tracing registry side does not have this information.
2414 ua_chan
->enabled
= uchan
->enabled
;
2415 ua_chan
->tracing_channel_id
= uchan
->id
;
2417 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2421 * Copy data between a UST app session and a regular LTT session.
2423 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2424 struct ltt_ust_session
*usess
,
2425 struct ust_app
*app
)
2427 struct tm
*timeinfo
;
2430 char tmp_shm_path
[PATH_MAX
];
2432 timeinfo
= localtime(&app
->registration_time
);
2433 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2435 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2437 ua_sess
->tracing_id
= usess
->id
;
2438 ua_sess
->id
= get_next_session_id();
2439 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2440 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2441 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2442 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2443 ua_sess
->buffer_type
= usess
->buffer_type
;
2444 ua_sess
->bits_per_long
= app
->abi
.bits_per_long
;
2446 /* There is only one consumer object per session possible. */
2447 consumer_output_get(usess
->consumer
);
2448 ua_sess
->consumer
= usess
->consumer
;
2450 ua_sess
->output_traces
= usess
->output_traces
;
2451 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2452 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &usess
->metadata_attr
);
2454 switch (ua_sess
->buffer_type
) {
2455 case LTTNG_BUFFER_PER_PID
:
2456 ret
= snprintf(ua_sess
->path
,
2457 sizeof(ua_sess
->path
),
2458 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2463 case LTTNG_BUFFER_PER_UID
:
2464 ret
= snprintf(ua_sess
->path
,
2465 sizeof(ua_sess
->path
),
2466 DEFAULT_UST_TRACE_UID_PATH
,
2467 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2468 app
->abi
.bits_per_long
);
2475 PERROR("asprintf UST shadow copy session");
2480 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
, sizeof(ua_sess
->root_shm_path
));
2481 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2482 strncpy(ua_sess
->shm_path
, usess
->shm_path
, sizeof(ua_sess
->shm_path
));
2483 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2484 if (ua_sess
->shm_path
[0]) {
2485 switch (ua_sess
->buffer_type
) {
2486 case LTTNG_BUFFER_PER_PID
:
2487 ret
= snprintf(tmp_shm_path
,
2488 sizeof(tmp_shm_path
),
2489 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2494 case LTTNG_BUFFER_PER_UID
:
2495 ret
= snprintf(tmp_shm_path
,
2496 sizeof(tmp_shm_path
),
2497 "/" DEFAULT_UST_TRACE_UID_PATH
,
2499 app
->abi
.bits_per_long
);
2506 PERROR("sprintf UST shadow copy session");
2510 strncat(ua_sess
->shm_path
,
2512 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2513 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2518 consumer_output_put(ua_sess
->consumer
);
2522 * Lookup sesison wrapper.
2524 static void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2525 struct ust_app
*app
,
2526 struct lttng_ht_iter
*iter
)
2528 /* Get right UST app session from app */
2529 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2533 * Return ust app session from the app session hashtable using the UST session
2536 static struct ust_app_session
*lookup_session_by_app(const struct ltt_ust_session
*usess
,
2537 struct ust_app
*app
)
2539 struct lttng_ht_iter iter
;
2540 struct lttng_ht_node_u64
*node
;
2542 __lookup_session_by_app(usess
, app
, &iter
);
2543 node
= lttng_ht_iter_get_node_u64(&iter
);
2544 if (node
== nullptr) {
2548 return lttng::utils::container_of(node
, &ust_app_session::node
);
2555 * Setup buffer registry per PID for the given session and application. If none
2556 * is found, a new one is created, added to the global registry and
2557 * initialized. If regp is valid, it's set with the newly created object.
2559 * Return 0 on success or else a negative value.
2561 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2562 struct ust_app
*app
,
2563 struct buffer_reg_pid
**regp
)
2566 struct buffer_reg_pid
*reg_pid
;
2568 LTTNG_ASSERT(ua_sess
);
2571 lttng::urcu::read_lock_guard read_lock
;
2573 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2576 * This is the create channel path meaning that if there is NO
2577 * registry available, we have to create one for this session.
2579 ret
= buffer_reg_pid_create(
2580 ua_sess
->id
, ®_pid
, ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2588 /* Initialize registry. */
2589 reg_pid
->registry
->reg
.ust
= ust_registry_session_per_pid_create(
2594 reg_pid
->root_shm_path
,
2596 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2597 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2598 ua_sess
->tracing_id
);
2599 if (!reg_pid
->registry
->reg
.ust
) {
2601 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2602 * destroy the buffer registry, because it is always expected
2603 * that if the buffer registry can be found, its ust registry is
2606 buffer_reg_pid_destroy(reg_pid
);
2610 buffer_reg_pid_add(reg_pid
);
2612 DBG3("UST app buffer registry per PID created successfully");
2623 * Setup buffer registry per UID for the given session and application. If none
2624 * is found, a new one is created, added to the global registry and
2625 * initialized. If regp is valid, it's set with the newly created object.
2627 * Return 0 on success or else a negative value.
2629 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2630 struct ust_app_session
*ua_sess
,
2631 struct ust_app
*app
,
2632 struct buffer_reg_uid
**regp
)
2635 struct buffer_reg_uid
*reg_uid
;
2637 LTTNG_ASSERT(usess
);
2640 lttng::urcu::read_lock_guard read_lock
;
2642 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->abi
.bits_per_long
, app
->uid
);
2645 * This is the create channel path meaning that if there is NO
2646 * registry available, we have to create one for this session.
2648 ret
= buffer_reg_uid_create(usess
->id
,
2649 app
->abi
.bits_per_long
,
2653 ua_sess
->root_shm_path
,
2662 /* Initialize registry. */
2663 reg_uid
->registry
->reg
.ust
= ust_registry_session_per_uid_create(app
->abi
,
2666 reg_uid
->root_shm_path
,
2670 ua_sess
->tracing_id
,
2672 if (!reg_uid
->registry
->reg
.ust
) {
2674 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2675 * destroy the buffer registry, because it is always expected
2676 * that if the buffer registry can be found, its ust registry is
2679 buffer_reg_uid_destroy(reg_uid
, nullptr);
2683 /* Add node to teardown list of the session. */
2684 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2686 buffer_reg_uid_add(reg_uid
);
2688 DBG3("UST app buffer registry per UID created successfully");
2698 * Create a session on the tracer side for the given app.
2700 * On success, ua_sess_ptr is populated with the session pointer or else left
2701 * untouched. If the session was created, is_created is set to 1. On error,
2702 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2705 * Returns 0 on success or else a negative code which is either -ENOMEM or
2706 * -ENOTCONN which is the default code if the lttng_ust_ctl_create_session fails.
2708 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2709 struct ust_app
*app
,
2710 struct ust_app_session
**ua_sess_ptr
,
2713 int ret
, created
= 0;
2714 struct ust_app_session
*ua_sess
;
2716 LTTNG_ASSERT(usess
);
2718 LTTNG_ASSERT(ua_sess_ptr
);
2720 health_code_update();
2722 ua_sess
= lookup_session_by_app(usess
, app
);
2723 if (ua_sess
== nullptr) {
2724 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2727 ua_sess
= alloc_ust_app_session();
2728 if (ua_sess
== nullptr) {
2729 /* Only malloc can failed so something is really wrong */
2733 shadow_copy_session(ua_sess
, usess
, app
);
2737 switch (usess
->buffer_type
) {
2738 case LTTNG_BUFFER_PER_PID
:
2739 /* Init local registry. */
2740 ret
= setup_buffer_reg_pid(ua_sess
, app
, nullptr);
2742 delete_ust_app_session(-1, ua_sess
, app
);
2746 case LTTNG_BUFFER_PER_UID
:
2747 /* Look for a global registry. If none exists, create one. */
2748 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, nullptr);
2750 delete_ust_app_session(-1, ua_sess
, app
);
2760 health_code_update();
2762 if (ua_sess
->handle
== -1) {
2763 pthread_mutex_lock(&app
->sock_lock
);
2764 ret
= lttng_ust_ctl_create_session(app
->sock
);
2765 pthread_mutex_unlock(&app
->sock_lock
);
2767 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2768 DBG("UST app creating session failed. Application is dead: pid = %d, sock = %d",
2772 } else if (ret
== -EAGAIN
) {
2773 DBG("UST app creating session failed. Communication time out: pid = %d, sock = %d",
2778 ERR("UST app creating session failed with ret %d: pid = %d, sock =%d",
2783 delete_ust_app_session(-1, ua_sess
, app
);
2784 if (ret
!= -ENOMEM
) {
2786 * Tracer is probably gone or got an internal error so let's
2787 * behave like it will soon unregister or not usable.
2794 ua_sess
->handle
= ret
;
2796 /* Add ust app session to app's HT */
2797 lttng_ht_node_init_u64(&ua_sess
->node
, ua_sess
->tracing_id
);
2798 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2799 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2800 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
, &ua_sess
->ust_objd_node
);
2802 DBG2("UST app session created successfully with handle %d", ret
);
2805 *ua_sess_ptr
= ua_sess
;
2807 *is_created
= created
;
2810 /* Everything went well. */
2814 health_code_update();
2819 * Match function for a hash table lookup of ust_app_ctx.
2821 * It matches an ust app context based on the context type and, in the case
2822 * of perf counters, their name.
2824 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2826 struct ust_app_ctx
*ctx
;
2827 const struct lttng_ust_context_attr
*key
;
2832 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2833 key
= (lttng_ust_context_attr
*) _key
;
2836 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2841 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
2842 if (strncmp(key
->u
.perf_counter
.name
,
2843 ctx
->ctx
.u
.perf_counter
.name
,
2844 sizeof(key
->u
.perf_counter
.name
)) != 0) {
2848 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
2849 if (strcmp(key
->u
.app_ctx
.provider_name
, ctx
->ctx
.u
.app_ctx
.provider_name
) != 0 ||
2850 strcmp(key
->u
.app_ctx
.ctx_name
, ctx
->ctx
.u
.app_ctx
.ctx_name
) != 0) {
2866 * Lookup for an ust app context from an lttng_ust_context.
2868 * Must be called while holding RCU read side lock.
2869 * Return an ust_app_ctx object or NULL on error.
2871 static struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2872 struct lttng_ust_context_attr
*uctx
)
2874 struct lttng_ht_iter iter
;
2875 struct lttng_ht_node_ulong
*node
;
2876 struct ust_app_ctx
*app_ctx
= nullptr;
2880 ASSERT_RCU_READ_LOCKED();
2882 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2883 cds_lfht_lookup(ht
->ht
,
2884 ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2885 ht_match_ust_app_ctx
,
2888 node
= lttng_ht_iter_get_node_ulong(&iter
);
2893 app_ctx
= lttng::utils::container_of(node
, &ust_app_ctx::node
);
2900 * Create a context for the channel on the tracer.
2902 * Called with UST app session lock held and a RCU read side lock.
2904 static int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2905 struct lttng_ust_context_attr
*uctx
,
2906 struct ust_app
*app
)
2909 struct ust_app_ctx
*ua_ctx
;
2911 ASSERT_RCU_READ_LOCKED();
2913 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2915 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2921 ua_ctx
= alloc_ust_app_ctx(uctx
);
2922 if (ua_ctx
== nullptr) {
2928 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2929 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2930 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2932 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2942 * Enable on the tracer side a ust app event for the session and channel.
2944 * Called with UST app session lock held.
2946 static int enable_ust_app_event(struct ust_app_event
*ua_event
, struct ust_app
*app
)
2950 ret
= enable_ust_object(app
, ua_event
->obj
);
2955 ua_event
->enabled
= true;
2962 * Disable on the tracer side a ust app event for the session and channel.
2964 static int disable_ust_app_event(struct ust_app_event
*ua_event
, struct ust_app
*app
)
2968 ret
= disable_ust_object(app
, ua_event
->obj
);
2973 ua_event
->enabled
= false;
2980 * Lookup ust app channel for session and disable it on the tracer side.
2982 static int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2983 struct ust_app_channel
*ua_chan
,
2984 struct ust_app
*app
)
2988 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2993 ua_chan
->enabled
= false;
3000 * Lookup ust app channel for session and enable it on the tracer side. This
3001 * MUST be called with a RCU read side lock acquired.
3003 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
3004 struct ltt_ust_channel
*uchan
,
3005 struct ust_app
*app
)
3008 struct lttng_ht_iter iter
;
3009 struct lttng_ht_node_str
*ua_chan_node
;
3010 struct ust_app_channel
*ua_chan
;
3012 ASSERT_RCU_READ_LOCKED();
3014 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
3015 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3016 if (ua_chan_node
== nullptr) {
3017 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
3019 ua_sess
->tracing_id
);
3023 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
3025 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
3035 * Ask the consumer to create a channel and get it if successful.
3037 * Called with UST app session lock held.
3039 * Return 0 on success or else a negative value.
3041 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
3042 struct ust_app_session
*ua_sess
,
3043 struct ust_app_channel
*ua_chan
,
3045 lsu::registry_session
*registry
)
3048 unsigned int nb_fd
= 0;
3049 struct consumer_socket
*socket
;
3051 LTTNG_ASSERT(usess
);
3052 LTTNG_ASSERT(ua_sess
);
3053 LTTNG_ASSERT(ua_chan
);
3054 LTTNG_ASSERT(registry
);
3056 lttng::urcu::read_lock_guard read_lock
;
3057 health_code_update();
3059 /* Get the right consumer socket for the application. */
3060 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
3066 health_code_update();
3068 /* Need one fd for the channel. */
3069 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3071 ERR("Exhausted number of available FD upon create channel");
3076 * Ask consumer to create channel. The consumer will return the number of
3077 * stream we have to expect.
3079 ret
= ust_consumer_ask_channel(
3080 ua_sess
, ua_chan
, usess
->consumer
, socket
, registry
, usess
->current_trace_chunk
);
3086 * Compute the number of fd needed before receiving them. It must be 2 per
3087 * stream (2 being the default value here).
3089 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
3091 /* Reserve the amount of file descriptor we need. */
3092 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
3094 ERR("Exhausted number of available FD upon create channel");
3095 goto error_fd_get_stream
;
3098 health_code_update();
3101 * Now get the channel from the consumer. This call will populate the stream
3102 * list of that channel and set the ust objects.
3104 if (usess
->consumer
->enabled
) {
3105 ret
= ust_consumer_get_channel(socket
, ua_chan
);
3114 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
3115 error_fd_get_stream
:
3117 * Initiate a destroy channel on the consumer since we had an error
3118 * handling it on our side. The return value is of no importance since we
3119 * already have a ret value set by the previous error that we need to
3122 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
3124 lttng_fd_put(LTTNG_FD_APPS
, 1);
3126 health_code_update();
3131 * Duplicate the ust data object of the ust app stream and save it in the
3132 * buffer registry stream.
3134 * Return 0 on success or else a negative value.
3136 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
3137 struct ust_app_stream
*stream
)
3141 LTTNG_ASSERT(reg_stream
);
3142 LTTNG_ASSERT(stream
);
3144 /* Duplicating a stream requires 2 new fds. Reserve them. */
3145 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3147 ERR("Exhausted number of available FD upon duplicate stream");
3151 /* Duplicate object for stream once the original is in the registry. */
3152 ret
= lttng_ust_ctl_duplicate_ust_object_data(&stream
->obj
, reg_stream
->obj
.ust
);
3154 ERR("Duplicate stream obj from %p to %p failed with ret %d",
3155 reg_stream
->obj
.ust
,
3158 lttng_fd_put(LTTNG_FD_APPS
, 2);
3161 stream
->handle
= stream
->obj
->handle
;
3168 * Duplicate the ust data object of the ust app. channel and save it in the
3169 * buffer registry channel.
3171 * Return 0 on success or else a negative value.
3173 static int duplicate_channel_object(struct buffer_reg_channel
*buf_reg_chan
,
3174 struct ust_app_channel
*ua_chan
)
3178 LTTNG_ASSERT(buf_reg_chan
);
3179 LTTNG_ASSERT(ua_chan
);
3181 /* Duplicating a channel requires 1 new fd. Reserve it. */
3182 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3184 ERR("Exhausted number of available FD upon duplicate channel");
3188 /* Duplicate object for stream once the original is in the registry. */
3189 ret
= lttng_ust_ctl_duplicate_ust_object_data(&ua_chan
->obj
, buf_reg_chan
->obj
.ust
);
3191 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
3192 buf_reg_chan
->obj
.ust
,
3197 ua_chan
->handle
= ua_chan
->obj
->handle
;
3202 lttng_fd_put(LTTNG_FD_APPS
, 1);
3208 * For a given channel buffer registry, setup all streams of the given ust
3209 * application channel.
3211 * Return 0 on success or else a negative value.
3213 static int setup_buffer_reg_streams(struct buffer_reg_channel
*buf_reg_chan
,
3214 struct ust_app_channel
*ua_chan
,
3215 struct ust_app
*app
)
3218 struct ust_app_stream
*stream
, *stmp
;
3220 LTTNG_ASSERT(buf_reg_chan
);
3221 LTTNG_ASSERT(ua_chan
);
3223 DBG2("UST app setup buffer registry stream");
3225 /* Send all streams to application. */
3226 cds_list_for_each_entry_safe (stream
, stmp
, &ua_chan
->streams
.head
, list
) {
3227 struct buffer_reg_stream
*reg_stream
;
3229 ret
= buffer_reg_stream_create(®_stream
);
3235 * Keep original pointer and nullify it in the stream so the delete
3236 * stream call does not release the object.
3238 reg_stream
->obj
.ust
= stream
->obj
;
3239 stream
->obj
= nullptr;
3240 buffer_reg_stream_add(reg_stream
, buf_reg_chan
);
3242 /* We don't need the streams anymore. */
3243 cds_list_del(&stream
->list
);
3244 delete_ust_app_stream(-1, stream
, app
);
3252 * Create a buffer registry channel for the given session registry and
3253 * application channel object. If regp pointer is valid, it's set with the
3254 * created object. Important, the created object is NOT added to the session
3255 * registry hash table.
3257 * Return 0 on success else a negative value.
3259 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3260 struct ust_app_channel
*ua_chan
,
3261 struct buffer_reg_channel
**regp
)
3264 struct buffer_reg_channel
*buf_reg_chan
= nullptr;
3266 LTTNG_ASSERT(reg_sess
);
3267 LTTNG_ASSERT(ua_chan
);
3269 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3271 /* Create buffer registry channel. */
3272 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, &buf_reg_chan
);
3276 LTTNG_ASSERT(buf_reg_chan
);
3277 buf_reg_chan
->consumer_key
= ua_chan
->key
;
3278 buf_reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3279 buf_reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3281 /* Create and add a channel registry to session. */
3283 reg_sess
->reg
.ust
->add_channel(ua_chan
->tracing_channel_id
);
3284 } catch (const std::exception
& ex
) {
3285 ERR("Failed to add a channel registry to userspace registry session: %s",
3291 buffer_reg_channel_add(reg_sess
, buf_reg_chan
);
3294 *regp
= buf_reg_chan
;
3300 /* Safe because the registry channel object was not added to any HT. */
3301 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3307 * Setup buffer registry channel for the given session registry and application
3308 * channel object. If regp pointer is valid, it's set with the created object.
3310 * Return 0 on success else a negative value.
3312 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3313 struct ust_app_channel
*ua_chan
,
3314 struct buffer_reg_channel
*buf_reg_chan
,
3315 struct ust_app
*app
)
3319 LTTNG_ASSERT(reg_sess
);
3320 LTTNG_ASSERT(buf_reg_chan
);
3321 LTTNG_ASSERT(ua_chan
);
3322 LTTNG_ASSERT(ua_chan
->obj
);
3324 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3326 /* Setup all streams for the registry. */
3327 ret
= setup_buffer_reg_streams(buf_reg_chan
, ua_chan
, app
);
3332 buf_reg_chan
->obj
.ust
= ua_chan
->obj
;
3333 ua_chan
->obj
= nullptr;
3338 buffer_reg_channel_remove(reg_sess
, buf_reg_chan
);
3339 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3344 * Send buffer registry channel to the application.
3346 * Return 0 on success else a negative value.
3348 static int send_channel_uid_to_ust(struct buffer_reg_channel
*buf_reg_chan
,
3349 struct ust_app
*app
,
3350 struct ust_app_session
*ua_sess
,
3351 struct ust_app_channel
*ua_chan
)
3354 struct buffer_reg_stream
*reg_stream
;
3356 LTTNG_ASSERT(buf_reg_chan
);
3358 LTTNG_ASSERT(ua_sess
);
3359 LTTNG_ASSERT(ua_chan
);
3361 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3363 ret
= duplicate_channel_object(buf_reg_chan
, ua_chan
);
3368 /* Send channel to the application. */
3369 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3370 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3371 ret
= -ENOTCONN
; /* Caused by app exiting. */
3373 } else if (ret
== -EAGAIN
) {
3374 /* Caused by timeout. */
3375 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
3379 ua_sess
->tracing_id
);
3380 /* Treat this the same way as an application that is exiting. */
3383 } else if (ret
< 0) {
3387 health_code_update();
3389 /* Send all streams to application. */
3390 pthread_mutex_lock(&buf_reg_chan
->stream_list_lock
);
3391 cds_list_for_each_entry (reg_stream
, &buf_reg_chan
->streams
, lnode
) {
3392 struct ust_app_stream stream
= {};
3394 ret
= duplicate_stream_object(reg_stream
, &stream
);
3396 goto error_stream_unlock
;
3399 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3401 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3402 ret
= -ENOTCONN
; /* Caused by app exiting. */
3403 } else if (ret
== -EAGAIN
) {
3405 * Caused by timeout.
3406 * Treat this the same way as an application
3409 WARN("Communication with application %d timed out on send_stream for stream of channel \"%s\" of session \"%" PRIu64
3413 ua_sess
->tracing_id
);
3416 (void) release_ust_app_stream(-1, &stream
, app
);
3417 goto error_stream_unlock
;
3421 * The return value is not important here. This function will output an
3424 (void) release_ust_app_stream(-1, &stream
, app
);
3427 error_stream_unlock
:
3428 pthread_mutex_unlock(&buf_reg_chan
->stream_list_lock
);
3434 * Create and send to the application the created buffers with per UID buffers.
3436 * This MUST be called with a RCU read side lock acquired.
3437 * The session list lock and the session's lock must be acquired.
3439 * Return 0 on success else a negative value.
3441 static int create_channel_per_uid(struct ust_app
*app
,
3442 struct ltt_ust_session
*usess
,
3443 struct ust_app_session
*ua_sess
,
3444 struct ust_app_channel
*ua_chan
)
3447 struct buffer_reg_uid
*reg_uid
;
3448 struct buffer_reg_channel
*buf_reg_chan
;
3449 ltt_session::ref session
;
3450 enum lttng_error_code notification_ret
;
3453 LTTNG_ASSERT(usess
);
3454 LTTNG_ASSERT(ua_sess
);
3455 LTTNG_ASSERT(ua_chan
);
3456 ASSERT_RCU_READ_LOCKED();
3458 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
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
);
3480 /* Guaranteed to exist; will not throw. */
3481 session
= ltt_session::find_session(ua_sess
->tracing_id
);
3482 ASSERT_LOCKED(session
->_lock
);
3483 ASSERT_SESSION_LIST_LOCKED();
3486 * Create the buffers on the consumer side. This call populates the
3487 * ust app channel object with all streams and data object.
3489 ret
= do_consumer_create_channel(
3490 usess
, ua_sess
, ua_chan
, app
->abi
.bits_per_long
, reg_uid
->registry
->reg
.ust
);
3492 ERR("Error creating UST channel \"%s\" on the consumer daemon", ua_chan
->name
);
3495 * Let's remove the previously created buffer registry channel so
3496 * it's not visible anymore in the session registry.
3498 auto locked_registry
= reg_uid
->registry
->reg
.ust
->lock();
3500 locked_registry
->remove_channel(ua_chan
->tracing_channel_id
, false);
3501 } catch (const std::exception
& ex
) {
3502 DBG("Could not find channel for removal: %s", ex
.what());
3504 buffer_reg_channel_remove(reg_uid
->registry
, buf_reg_chan
);
3505 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3510 * Setup the streams and add it to the session registry.
3512 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, buf_reg_chan
, app
);
3514 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3519 auto locked_registry
= reg_uid
->registry
->reg
.ust
->lock();
3520 auto& ust_reg_chan
= locked_registry
->channel(ua_chan
->tracing_channel_id
);
3522 ust_reg_chan
._consumer_key
= ua_chan
->key
;
3525 /* Notify the notification subsystem of the channel's creation. */
3526 notification_ret
= notification_thread_command_add_channel(
3527 the_notification_thread_handle
,
3532 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3533 if (notification_ret
!= LTTNG_OK
) {
3534 ret
= -(int) notification_ret
;
3535 ERR("Failed to add channel to notification thread");
3540 /* Send buffers to the application. */
3541 ret
= send_channel_uid_to_ust(buf_reg_chan
, app
, ua_sess
, ua_chan
);
3543 if (ret
!= -ENOTCONN
) {
3544 ERR("Error sending channel to application");
3554 * Create and send to the application the created buffers with per PID buffers.
3556 * Called with UST app session lock held.
3557 * The session list lock and the session's lock must be acquired.
3559 * Return 0 on success else a negative value.
3561 static int create_channel_per_pid(struct ust_app
*app
,
3562 struct ltt_ust_session
*usess
,
3563 struct ust_app_session
*ua_sess
,
3564 struct ust_app_channel
*ua_chan
)
3567 lsu::registry_session
*registry
;
3568 enum lttng_error_code cmd_ret
;
3569 ltt_session::ref session
;
3570 uint64_t chan_reg_key
;
3573 LTTNG_ASSERT(usess
);
3574 LTTNG_ASSERT(ua_sess
);
3575 LTTNG_ASSERT(ua_chan
);
3577 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3579 lttng::urcu::read_lock_guard read_lock
;
3581 registry
= get_session_registry(ua_sess
);
3582 /* The UST app session lock is held, registry shall not be null. */
3583 LTTNG_ASSERT(registry
);
3585 /* Create and add a new channel registry to session. */
3587 registry
->add_channel(ua_chan
->key
);
3588 } catch (const std::exception
& ex
) {
3589 ERR("Error creating the UST channel \"%s\" registry instance: %s",
3596 /* Guaranteed to exist; will not throw. */
3597 session
= ltt_session::find_session(ua_sess
->tracing_id
);
3598 ASSERT_LOCKED(session
->_lock
);
3599 ASSERT_SESSION_LIST_LOCKED();
3601 /* Create and get channel on the consumer side. */
3602 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
, app
->abi
.bits_per_long
, registry
);
3604 ERR("Error creating UST channel \"%s\" on the consumer daemon", ua_chan
->name
);
3605 goto error_remove_from_registry
;
3608 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3610 if (ret
!= -ENOTCONN
) {
3611 ERR("Error sending channel to application");
3613 goto error_remove_from_registry
;
3616 chan_reg_key
= ua_chan
->key
;
3618 auto locked_registry
= registry
->lock();
3620 auto& ust_reg_chan
= locked_registry
->channel(chan_reg_key
);
3621 ust_reg_chan
._consumer_key
= ua_chan
->key
;
3624 cmd_ret
= notification_thread_command_add_channel(the_notification_thread_handle
,
3629 ua_chan
->attr
.subbuf_size
*
3630 ua_chan
->attr
.num_subbuf
);
3631 if (cmd_ret
!= LTTNG_OK
) {
3632 ret
= -(int) cmd_ret
;
3633 ERR("Failed to add channel to notification thread");
3634 goto error_remove_from_registry
;
3637 error_remove_from_registry
:
3640 auto locked_registry
= registry
->lock();
3641 locked_registry
->remove_channel(ua_chan
->key
, false);
3642 } catch (const std::exception
& ex
) {
3643 DBG("Could not find channel for removal: %s", ex
.what());
3651 * From an already allocated ust app channel, create the channel buffers if
3652 * needed and send them to the application. This MUST be called with a RCU read
3653 * side lock acquired.
3655 * Called with UST app session lock held.
3657 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3658 * the application exited concurrently.
3660 static int ust_app_channel_send(struct ust_app
*app
,
3661 struct ltt_ust_session
*usess
,
3662 struct ust_app_session
*ua_sess
,
3663 struct ust_app_channel
*ua_chan
)
3668 LTTNG_ASSERT(usess
);
3669 LTTNG_ASSERT(usess
->active
);
3670 LTTNG_ASSERT(ua_sess
);
3671 LTTNG_ASSERT(ua_chan
);
3672 ASSERT_RCU_READ_LOCKED();
3674 /* Handle buffer type before sending the channel to the application. */
3675 switch (usess
->buffer_type
) {
3676 case LTTNG_BUFFER_PER_UID
:
3678 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3684 case LTTNG_BUFFER_PER_PID
:
3686 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3698 /* Initialize ust objd object using the received handle and add it. */
3699 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3700 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3702 /* If channel is not enabled, disable it on the tracer */
3703 if (!ua_chan
->enabled
) {
3704 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3715 * Create UST app channel and return it through ua_chanp if not NULL.
3717 * Called with UST app session lock and RCU read-side lock held.
3719 * Return 0 on success or else a negative value.
3721 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3722 struct ltt_ust_channel
*uchan
,
3723 enum lttng_ust_abi_chan_type type
,
3724 struct ltt_ust_session
*usess
__attribute__((unused
)),
3725 struct ust_app_channel
**ua_chanp
)
3728 struct lttng_ht_iter iter
;
3729 struct lttng_ht_node_str
*ua_chan_node
;
3730 struct ust_app_channel
*ua_chan
;
3732 ASSERT_RCU_READ_LOCKED();
3734 /* Lookup channel in the ust app session */
3735 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
3736 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3737 if (ua_chan_node
!= nullptr) {
3738 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
3742 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3743 if (ua_chan
== nullptr) {
3744 /* Only malloc can fail here */
3748 shadow_copy_channel(ua_chan
, uchan
);
3750 /* Set channel type. */
3751 ua_chan
->attr
.type
= type
;
3753 /* Only add the channel if successful on the tracer side. */
3754 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3757 *ua_chanp
= ua_chan
;
3760 /* Everything went well. */
3768 * Create UST app event and create it on the tracer side.
3770 * Must be called with the RCU read side lock held.
3771 * Called with ust app session mutex held.
3773 static int create_ust_app_event(struct ust_app_channel
*ua_chan
,
3774 struct ltt_ust_event
*uevent
,
3775 struct ust_app
*app
)
3778 struct ust_app_event
*ua_event
;
3780 ASSERT_RCU_READ_LOCKED();
3782 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3783 if (ua_event
== nullptr) {
3784 /* Only failure mode of alloc_ust_app_event(). */
3788 shadow_copy_event(ua_event
, uevent
);
3790 /* Create it on the tracer side */
3791 ret
= create_ust_event(app
, ua_chan
, ua_event
);
3794 * Not found previously means that it does not exist on the
3795 * tracer. If the application reports that the event existed,
3796 * it means there is a bug in the sessiond or lttng-ust
3797 * (or corruption, etc.)
3799 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3800 ERR("Tracer for application reported that an event being created already existed: "
3801 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3811 add_unique_ust_app_event(ua_chan
, ua_event
);
3813 DBG2("UST app create event completed: app = '%s' pid = %d", app
->name
, app
->pid
);
3819 /* Valid. Calling here is already in a read side lock */
3820 delete_ust_app_event(-1, ua_event
, app
);
3825 * Create UST app event notifier rule and create it on the tracer side.
3827 * Must be called with the RCU read side lock held.
3828 * Called with ust app session mutex held.
3830 static int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
, struct ust_app
*app
)
3833 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3835 ASSERT_RCU_READ_LOCKED();
3837 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3838 if (ua_event_notifier_rule
== nullptr) {
3843 /* Create it on the tracer side. */
3844 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3847 * Not found previously means that it does not exist on the
3848 * tracer. If the application reports that the event existed,
3849 * it means there is a bug in the sessiond or lttng-ust
3850 * (or corruption, etc.)
3852 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3853 ERR("Tracer for application reported that an event notifier being created already exists: "
3854 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3855 lttng_trigger_get_tracer_token(trigger
),
3864 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3865 &ua_event_notifier_rule
->node
);
3867 DBG2("UST app create token event rule completed: app = '%s', pid = %d, token = %" PRIu64
,
3870 lttng_trigger_get_tracer_token(trigger
));
3875 /* The RCU read side lock is already being held by the caller. */
3876 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3882 * Create UST metadata and open it on the tracer side.
3884 * Called with UST app session lock held and RCU read side lock.
3886 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3887 struct ust_app
*app
,
3888 struct consumer_output
*consumer
)
3891 struct ust_app_channel
*metadata
;
3892 struct consumer_socket
*socket
;
3893 ltt_session::ref session
;
3895 LTTNG_ASSERT(ua_sess
);
3897 LTTNG_ASSERT(consumer
);
3898 ASSERT_RCU_READ_LOCKED();
3900 auto locked_registry
= get_locked_session_registry(ua_sess
);
3901 /* The UST app session is held registry shall not be null. */
3902 LTTNG_ASSERT(locked_registry
);
3904 /* Metadata already exists for this registry or it was closed previously */
3905 if (locked_registry
->_metadata_key
|| locked_registry
->_metadata_closed
) {
3910 /* Allocate UST metadata */
3911 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, nullptr);
3913 /* malloc() failed */
3918 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3920 /* Need one fd for the channel. */
3921 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3923 ERR("Exhausted number of available FD upon create metadata");
3927 /* Get the right consumer socket for the application. */
3928 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, consumer
);
3931 goto error_consumer
;
3935 * Keep metadata key so we can identify it on the consumer side. Assign it
3936 * to the registry *before* we ask the consumer so we avoid the race of the
3937 * consumer requesting the metadata and the ask_channel call on our side
3938 * did not returned yet.
3940 locked_registry
->_metadata_key
= metadata
->key
;
3942 /* Guaranteed to exist; will not throw. */
3943 session
= ltt_session::find_session(ua_sess
->tracing_id
);
3944 ASSERT_LOCKED(session
->_lock
);
3945 ASSERT_SESSION_LIST_LOCKED();
3948 * Ask the metadata channel creation to the consumer. The metadata object
3949 * will be created by the consumer and kept their. However, the stream is
3950 * never added or monitored until we do a first push metadata to the
3953 ret
= ust_consumer_ask_channel(ua_sess
,
3957 locked_registry
.get(),
3958 session
->current_trace_chunk
);
3960 /* Nullify the metadata key so we don't try to close it later on. */
3961 locked_registry
->_metadata_key
= 0;
3962 goto error_consumer
;
3966 * The setup command will make the metadata stream be sent to the relayd,
3967 * if applicable, and the thread managing the metadatas. This is important
3968 * because after this point, if an error occurs, the only way the stream
3969 * can be deleted is to be monitored in the consumer.
3971 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3973 /* Nullify the metadata key so we don't try to close it later on. */
3974 locked_registry
->_metadata_key
= 0;
3975 goto error_consumer
;
3978 DBG2("UST metadata with key %" PRIu64
" created for app pid %d", metadata
->key
, app
->pid
);
3981 lttng_fd_put(LTTNG_FD_APPS
, 1);
3982 delete_ust_app_channel(-1, metadata
, app
, locked_registry
);
3988 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3989 * acquired before calling this function.
3991 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3993 struct ust_app
*app
= nullptr;
3994 struct lttng_ht_node_ulong
*node
;
3995 struct lttng_ht_iter iter
;
3997 lttng_ht_lookup(ust_app_ht
, (void *) ((unsigned long) pid
), &iter
);
3998 node
= lttng_ht_iter_get_node_ulong(&iter
);
3999 if (node
== nullptr) {
4000 DBG2("UST app no found with pid %d", pid
);
4004 DBG2("Found UST app by pid %d", pid
);
4006 app
= lttng::utils::container_of(node
, &ust_app::pid_n
);
4013 * Allocate and init an UST app object using the registration information and
4014 * the command socket. This is called when the command socket connects to the
4017 * The object is returned on success or else NULL.
4019 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
4022 struct ust_app
*lta
= nullptr;
4023 struct lttng_pipe
*event_notifier_event_source_pipe
= nullptr;
4026 LTTNG_ASSERT(sock
>= 0);
4028 DBG3("UST app creating application for socket %d", sock
);
4030 if ((msg
->bits_per_long
== 64 && (uatomic_read(&the_ust_consumerd64_fd
) == -EINVAL
)) ||
4031 (msg
->bits_per_long
== 32 && (uatomic_read(&the_ust_consumerd32_fd
) == -EINVAL
))) {
4032 ERR("Registration failed: application \"%s\" (pid: %d) has "
4033 "%d-bit long, but no consumerd for this size is available.\n",
4036 msg
->bits_per_long
);
4041 * Reserve the two file descriptors of the event source pipe. The write
4042 * end will be closed once it is passed to the application, at which
4043 * point a single 'put' will be performed.
4045 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
4047 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s', pid = %d",
4053 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
4054 if (!event_notifier_event_source_pipe
) {
4055 PERROR("Failed to open application event source pipe: '%s' (pid = %d)",
4061 lta
= zmalloc
<ust_app
>();
4062 if (lta
== nullptr) {
4064 goto error_free_pipe
;
4067 urcu_ref_init(<a
->ref
);
4069 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
4071 lta
->ppid
= msg
->ppid
;
4072 lta
->uid
= msg
->uid
;
4073 lta
->gid
= msg
->gid
;
4076 .bits_per_long
= msg
->bits_per_long
,
4077 .long_alignment
= msg
->long_alignment
,
4078 .uint8_t_alignment
= msg
->uint8_t_alignment
,
4079 .uint16_t_alignment
= msg
->uint16_t_alignment
,
4080 .uint32_t_alignment
= msg
->uint32_t_alignment
,
4081 .uint64_t_alignment
= msg
->uint64_t_alignment
,
4082 .byte_order
= msg
->byte_order
== LITTLE_ENDIAN
?
4083 lttng::sessiond::trace::byte_order::LITTLE_ENDIAN_
:
4084 lttng::sessiond::trace::byte_order::BIG_ENDIAN_
,
4087 lta
->v_major
= msg
->major
;
4088 lta
->v_minor
= msg
->minor
;
4089 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4090 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4091 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4092 lta
->notify_sock
= -1;
4093 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4095 /* Copy name and make sure it's NULL terminated. */
4096 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
4097 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
4100 * Before this can be called, when receiving the registration information,
4101 * the application compatibility is checked. So, at this point, the
4102 * application can work with this session daemon.
4104 lta
->compatible
= 1;
4106 lta
->pid
= msg
->pid
;
4107 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
4109 pthread_mutex_init(<a
->sock_lock
, nullptr);
4110 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
4112 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
4116 lttng_pipe_destroy(event_notifier_event_source_pipe
);
4117 lttng_fd_put(LTTNG_FD_APPS
, 2);
4123 * For a given application object, add it to every hash table.
4125 void ust_app_add(struct ust_app
*app
)
4128 LTTNG_ASSERT(app
->notify_sock
>= 0);
4130 app
->registration_time
= time(nullptr);
4132 lttng::urcu::read_lock_guard read_lock
;
4135 * On a re-registration, we want to kick out the previous registration of
4138 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
4141 * The socket _should_ be unique until _we_ call close. So, a add_unique
4142 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
4143 * already in the table.
4145 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
4147 /* Add application to the notify socket hash table. */
4148 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
4149 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
4151 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock =%d name:%s "
4152 "notify_sock =%d (version %d.%d)",
4165 * Set the application version into the object.
4167 * Return 0 on success else a negative value either an errno code or a
4168 * LTTng-UST error code.
4170 int ust_app_version(struct ust_app
*app
)
4176 pthread_mutex_lock(&app
->sock_lock
);
4177 ret
= lttng_ust_ctl_tracer_version(app
->sock
, &app
->version
);
4178 pthread_mutex_unlock(&app
->sock_lock
);
4180 if (ret
== -LTTNG_UST_ERR_EXITING
|| ret
== -EPIPE
) {
4181 DBG3("UST app version failed. Application is dead: pid = %d, sock = %d",
4184 } else if (ret
== -EAGAIN
) {
4185 WARN("UST app version failed. Communication time out: pid = %d, sock = %d",
4189 ERR("UST app version failed with ret %d: pid = %d, sock = %d",
4199 bool ust_app_supports_notifiers(const struct ust_app
*app
)
4201 return app
->v_major
>= 9;
4204 bool ust_app_supports_counters(const struct ust_app
*app
)
4206 return app
->v_major
>= 9;
4210 * Setup the base event notifier group.
4212 * Return 0 on success else a negative value either an errno code or a
4213 * LTTng-UST error code.
4215 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
4218 int event_pipe_write_fd
;
4219 struct lttng_ust_abi_object_data
*event_notifier_group
= nullptr;
4220 enum lttng_error_code lttng_ret
;
4221 enum event_notifier_error_accounting_status event_notifier_error_accounting_status
;
4225 if (!ust_app_supports_notifiers(app
)) {
4230 /* Get the write side of the pipe. */
4231 event_pipe_write_fd
= lttng_pipe_get_writefd(app
->event_notifier_group
.event_pipe
);
4233 pthread_mutex_lock(&app
->sock_lock
);
4234 ret
= lttng_ust_ctl_create_event_notifier_group(
4235 app
->sock
, event_pipe_write_fd
, &event_notifier_group
);
4236 pthread_mutex_unlock(&app
->sock_lock
);
4238 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4240 DBG3("UST app create event notifier group failed. Application is dead: pid = %d, sock = %d",
4243 } else if (ret
== -EAGAIN
) {
4245 WARN("UST app create event notifier group failed. Communication time out: pid = %d, sock = %d",
4249 ERR("UST app create event notifier group failed with ret %d: pid = %d, sock = %d, event_pipe_write_fd: %d",
4253 event_pipe_write_fd
);
4258 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
4260 ERR("Failed to close write end of the application's event source pipe: app = '%s' (pid = %d)",
4267 * Release the file descriptor that was reserved for the write-end of
4270 lttng_fd_put(LTTNG_FD_APPS
, 1);
4272 lttng_ret
= notification_thread_command_add_tracer_event_source(
4273 the_notification_thread_handle
,
4274 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
),
4276 if (lttng_ret
!= LTTNG_OK
) {
4277 ERR("Failed to add tracer event source to notification thread");
4282 /* Assign handle only when the complete setup is valid. */
4283 app
->event_notifier_group
.object
= event_notifier_group
;
4285 event_notifier_error_accounting_status
= event_notifier_error_accounting_register_app(app
);
4286 switch (event_notifier_error_accounting_status
) {
4287 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
4289 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_UNSUPPORTED
:
4290 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",
4295 goto error_accounting
;
4296 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
:
4297 DBG3("Failed to setup event notifier error accounting (application is dead): app socket fd = %d, app name = '%s', app pid = %d",
4302 goto error_accounting
;
4304 ERR("Failed to setup event notifier error accounting for app");
4306 goto error_accounting
;
4312 lttng_ret
= notification_thread_command_remove_tracer_event_source(
4313 the_notification_thread_handle
,
4314 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
));
4315 if (lttng_ret
!= LTTNG_OK
) {
4316 ERR("Failed to remove application tracer event source from notification thread");
4320 lttng_ust_ctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
4321 free(app
->event_notifier_group
.object
);
4322 app
->event_notifier_group
.object
= nullptr;
4326 static void ust_app_unregister(ust_app
& app
)
4328 struct lttng_ht_iter iter
;
4329 struct ust_app_session
*ua_sess
;
4331 lttng::urcu::read_lock_guard read_lock
;
4334 * For per-PID buffers, perform "push metadata" and flush all
4335 * application streams before removing app from hash tables,
4336 * ensuring proper behavior of data_pending check.
4337 * Remove sessions so they are not visible during deletion.
4339 cds_lfht_for_each_entry (app
.sessions
->ht
, &iter
.iter
, ua_sess
, node
.node
) {
4340 const auto del_ret
= lttng_ht_del(app
.sessions
, &iter
);
4342 /* The session was already removed so scheduled for teardown. */
4346 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
4347 (void) ust_app_flush_app_session(app
, *ua_sess
);
4351 * Add session to list for teardown. This is safe since at this point we
4352 * are the only one using this list.
4354 lttng::pthread::lock_guard
ust_app_session_lock(ua_sess
->lock
);
4356 if (ua_sess
->deleted
) {
4361 * Normally, this is done in the delete session process which is
4362 * executed in the call rcu below. However, upon registration we can't
4363 * afford to wait for the grace period before pushing data or else the
4364 * data pending feature can race between the unregistration and stop
4365 * command where the data pending command is sent *before* the grace
4368 * The close metadata below nullifies the metadata pointer in the
4369 * session so the delete session will NOT push/close a second time.
4371 auto locked_registry
= get_locked_session_registry(ua_sess
);
4372 if (locked_registry
) {
4373 /* Push metadata for application before freeing the application. */
4374 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
4377 * Don't ask to close metadata for global per UID buffers. Close
4378 * metadata only on destroy trace session in this case. Also, the
4379 * previous push metadata could have flag the metadata registry to
4380 * close so don't send a close command if closed.
4382 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4383 const auto metadata_key
= locked_registry
->_metadata_key
;
4384 const auto consumer_bitness
= locked_registry
->abi
.bits_per_long
;
4386 if (!locked_registry
->_metadata_closed
&& metadata_key
!= 0) {
4387 locked_registry
->_metadata_closed
= true;
4390 /* Release lock before communication, see comments in
4391 * close_metadata(). */
4392 locked_registry
.reset();
4393 (void) close_metadata(
4394 metadata_key
, consumer_bitness
, ua_sess
->consumer
);
4396 locked_registry
.reset();
4400 cds_list_add(&ua_sess
->teardown_node
, &app
.teardown_head
);
4404 * Remove application from notify hash table. The thread handling the
4405 * notify socket could have deleted the node so ignore on error because
4406 * either way it's valid. The close of that socket is handled by the
4407 * apps_notify_thread.
4409 iter
.iter
.node
= &app
.notify_sock_n
.node
;
4410 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4413 * Ignore return value since the node might have been removed before by an
4414 * add replace during app registration because the PID can be reassigned by
4417 iter
.iter
.node
= &app
.pid_n
.node
;
4418 if (lttng_ht_del(ust_app_ht
, &iter
)) {
4419 DBG3("Unregister app by PID %d failed. This can happen on pid reuse", app
.pid
);
4424 * Unregister app by removing it from the global traceable app list and freeing
4427 * The socket is already closed at this point, so there is no need to close it.
4429 void ust_app_unregister_by_socket(int sock_fd
)
4431 struct ust_app
*app
;
4432 struct lttng_ht_node_ulong
*node
;
4433 struct lttng_ht_iter ust_app_sock_iter
;
4436 lttng::urcu::read_lock_guard read_lock
;
4438 /* Get the node reference for a call_rcu */
4439 lttng_ht_lookup(ust_app_ht_by_sock
, (void *) ((unsigned long) sock_fd
), &ust_app_sock_iter
);
4440 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
4443 app
= caa_container_of(node
, struct ust_app
, sock_n
);
4445 DBG_FMT("Application unregistering after socket activity: pid={}, socket_fd={}",
4449 /* Remove application from socket hash table */
4450 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4454 * The socket is closed: release its reference to the application
4455 * to trigger its eventual teardown.
4461 * Fill events array with all events name of all registered apps.
4463 int ust_app_list_events(struct lttng_event
**events
)
4466 size_t nbmem
, count
= 0;
4467 struct lttng_ht_iter iter
;
4468 struct ust_app
*app
;
4469 struct lttng_event
*tmp_event
;
4471 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4472 tmp_event
= calloc
<lttng_event
>(nbmem
);
4473 if (tmp_event
== nullptr) {
4474 PERROR("zmalloc ust app events");
4480 lttng::urcu::read_lock_guard read_lock
;
4482 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4483 struct lttng_ust_abi_tracepoint_iter uiter
;
4485 health_code_update();
4487 if (!app
->compatible
) {
4489 * TODO: In time, we should notice the caller of this error by
4490 * telling him that this is a version error.
4495 pthread_mutex_lock(&app
->sock_lock
);
4496 handle
= lttng_ust_ctl_tracepoint_list(app
->sock
);
4498 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4499 ERR("UST app list events getting handle failed for app pid %d",
4502 pthread_mutex_unlock(&app
->sock_lock
);
4506 while ((ret
= lttng_ust_ctl_tracepoint_list_get(
4507 app
->sock
, handle
, &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4508 /* Handle ustctl error. */
4512 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4513 ERR("UST app tp list get failed for app %d with ret %d",
4517 DBG3("UST app tp list get failed. Application is dead");
4523 lttng_ust_ctl_release_handle(app
->sock
, handle
);
4524 if (release_ret
< 0 &&
4525 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4526 release_ret
!= -EPIPE
) {
4527 ERR("Error releasing app handle for app %d with ret %d",
4532 pthread_mutex_unlock(&app
->sock_lock
);
4536 health_code_update();
4537 if (count
>= nbmem
) {
4538 /* In case the realloc fails, we free the memory */
4539 struct lttng_event
*new_tmp_event
;
4542 new_nbmem
= nbmem
<< 1;
4543 DBG2("Reallocating event list from %zu to %zu entries",
4546 new_tmp_event
= (lttng_event
*) realloc(
4547 tmp_event
, new_nbmem
* sizeof(struct lttng_event
));
4548 if (new_tmp_event
== nullptr) {
4551 PERROR("realloc ust app events");
4554 release_ret
= lttng_ust_ctl_release_handle(
4556 if (release_ret
< 0 &&
4557 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4558 release_ret
!= -EPIPE
) {
4559 ERR("Error releasing app handle for app %d with ret %d",
4564 pthread_mutex_unlock(&app
->sock_lock
);
4567 /* Zero the new memory */
4568 memset(new_tmp_event
+ nbmem
,
4570 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4572 tmp_event
= new_tmp_event
;
4575 memcpy(tmp_event
[count
].name
,
4577 LTTNG_UST_ABI_SYM_NAME_LEN
);
4578 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4579 tmp_event
[count
].type
=
4580 (enum lttng_event_type
) LTTNG_UST_ABI_TRACEPOINT
;
4581 tmp_event
[count
].pid
= app
->pid
;
4582 tmp_event
[count
].enabled
= -1;
4586 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4587 pthread_mutex_unlock(&app
->sock_lock
);
4589 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4590 DBG3("Error releasing app handle. Application died: pid = %d, sock = %d",
4593 } else if (ret
== -EAGAIN
) {
4594 WARN("Error releasing app handle. Communication time out: pid = %d, sock = %d",
4598 ERR("Error releasing app handle with ret %d: pid = %d, sock = %d",
4608 *events
= tmp_event
;
4610 DBG2("UST app list events done (%zu events)", count
);
4614 health_code_update();
4619 * Fill events array with all events name of all registered apps.
4621 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4624 size_t nbmem
, count
= 0;
4625 struct lttng_ht_iter iter
;
4626 struct ust_app
*app
;
4627 struct lttng_event_field
*tmp_event
;
4629 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4630 tmp_event
= calloc
<lttng_event_field
>(nbmem
);
4631 if (tmp_event
== nullptr) {
4632 PERROR("zmalloc ust app event fields");
4638 lttng::urcu::read_lock_guard read_lock
;
4640 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4641 struct lttng_ust_abi_field_iter uiter
;
4643 health_code_update();
4645 if (!app
->compatible
) {
4647 * TODO: In time, we should notice the caller of this error by
4648 * telling him that this is a version error.
4653 pthread_mutex_lock(&app
->sock_lock
);
4654 handle
= lttng_ust_ctl_tracepoint_field_list(app
->sock
);
4656 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4657 ERR("UST app list field getting handle failed for app pid %d",
4660 pthread_mutex_unlock(&app
->sock_lock
);
4664 while ((ret
= lttng_ust_ctl_tracepoint_field_list_get(
4665 app
->sock
, handle
, &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4666 /* Handle ustctl error. */
4670 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4671 ERR("UST app tp list field failed for app %d with ret %d",
4675 DBG3("UST app tp list field failed. Application is dead");
4681 lttng_ust_ctl_release_handle(app
->sock
, handle
);
4682 pthread_mutex_unlock(&app
->sock_lock
);
4683 if (release_ret
< 0 &&
4684 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4685 release_ret
!= -EPIPE
) {
4686 ERR("Error releasing app handle for app %d with ret %d",
4694 health_code_update();
4695 if (count
>= nbmem
) {
4696 /* In case the realloc fails, we free the memory */
4697 struct lttng_event_field
*new_tmp_event
;
4700 new_nbmem
= nbmem
<< 1;
4701 DBG2("Reallocating event field list from %zu to %zu entries",
4704 new_tmp_event
= (lttng_event_field
*) realloc(
4706 new_nbmem
* sizeof(struct lttng_event_field
));
4707 if (new_tmp_event
== nullptr) {
4710 PERROR("realloc ust app event fields");
4713 release_ret
= lttng_ust_ctl_release_handle(
4715 pthread_mutex_unlock(&app
->sock_lock
);
4717 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4718 release_ret
!= -EPIPE
) {
4719 ERR("Error releasing app handle for app %d with ret %d",
4727 /* Zero the new memory */
4728 memset(new_tmp_event
+ nbmem
,
4730 (new_nbmem
- nbmem
) *
4731 sizeof(struct lttng_event_field
));
4733 tmp_event
= new_tmp_event
;
4736 memcpy(tmp_event
[count
].field_name
,
4738 LTTNG_UST_ABI_SYM_NAME_LEN
);
4739 /* Mapping between these enums matches 1 to 1. */
4740 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4741 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4743 memcpy(tmp_event
[count
].event
.name
,
4745 LTTNG_UST_ABI_SYM_NAME_LEN
);
4746 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4747 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4748 tmp_event
[count
].event
.pid
= app
->pid
;
4749 tmp_event
[count
].event
.enabled
= -1;
4753 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4754 pthread_mutex_unlock(&app
->sock_lock
);
4755 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4756 ERR("Error releasing app handle for app %d with ret %d",
4764 *fields
= tmp_event
;
4766 DBG2("UST app list event fields done (%zu events)", count
);
4770 health_code_update();
4775 * Free and clean all traceable apps of the global list.
4777 void ust_app_clean_list()
4780 struct ust_app
*app
;
4781 struct lttng_ht_iter iter
;
4783 DBG2("UST app cleaning registered apps hash table");
4785 /* Cleanup notify socket hash table */
4786 if (ust_app_ht_by_notify_sock
) {
4787 lttng::urcu::read_lock_guard read_lock
;
4789 cds_lfht_for_each_entry (
4790 ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
, notify_sock_n
.node
) {
4792 * Assert that all notifiers are gone as all triggers
4793 * are unregistered prior to this clean-up.
4795 LTTNG_ASSERT(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4796 ust_app_notify_sock_unregister(app
->notify_sock
);
4800 /* Cleanup socket hash table */
4801 if (ust_app_ht_by_sock
) {
4802 lttng::urcu::read_lock_guard read_lock
;
4804 cds_lfht_for_each_entry (ust_app_ht_by_sock
->ht
, &iter
.iter
, app
, sock_n
.node
) {
4805 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4811 /* Destroy is done only when the ht is empty */
4813 lttng_ht_destroy(ust_app_ht
);
4815 if (ust_app_ht_by_sock
) {
4816 lttng_ht_destroy(ust_app_ht_by_sock
);
4818 if (ust_app_ht_by_notify_sock
) {
4819 lttng_ht_destroy(ust_app_ht_by_notify_sock
);
4824 * Init UST app hash table.
4826 int ust_app_ht_alloc()
4828 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4832 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4833 if (!ust_app_ht_by_sock
) {
4836 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4837 if (!ust_app_ht_by_notify_sock
) {
4844 * For a specific UST session, disable the channel for all registered apps.
4846 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
, struct ltt_ust_channel
*uchan
)
4849 struct lttng_ht_iter iter
;
4850 struct lttng_ht_node_str
*ua_chan_node
;
4851 struct ust_app
*app
;
4852 struct ust_app_session
*ua_sess
;
4853 struct ust_app_channel
*ua_chan
;
4855 LTTNG_ASSERT(usess
->active
);
4856 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4861 lttng::urcu::read_lock_guard read_lock
;
4863 /* For every registered applications */
4864 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4865 struct lttng_ht_iter uiter
;
4866 if (!app
->compatible
) {
4868 * TODO: In time, we should notice the caller of this error by
4869 * telling him that this is a version error.
4873 ua_sess
= lookup_session_by_app(usess
, app
);
4874 if (ua_sess
== nullptr) {
4879 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
4880 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4881 /* If the session if found for the app, the channel must be there */
4882 LTTNG_ASSERT(ua_chan_node
);
4884 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
4885 /* The channel must not be already disabled */
4886 LTTNG_ASSERT(ua_chan
->enabled
);
4888 /* Disable channel onto application */
4889 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4891 /* XXX: We might want to report this error at some point... */
4901 * For a specific UST session, enable the channel for all registered apps.
4903 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
, struct ltt_ust_channel
*uchan
)
4906 struct lttng_ht_iter iter
;
4907 struct ust_app
*app
;
4908 struct ust_app_session
*ua_sess
;
4910 LTTNG_ASSERT(usess
->active
);
4911 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4916 lttng::urcu::read_lock_guard read_lock
;
4918 /* For every registered applications */
4919 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4920 if (!app
->compatible
) {
4922 * TODO: In time, we should notice the caller of this error by
4923 * telling him that this is a version error.
4927 ua_sess
= lookup_session_by_app(usess
, app
);
4928 if (ua_sess
== nullptr) {
4932 /* Enable channel onto application */
4933 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4935 /* XXX: We might want to report this error at some point... */
4945 * Disable an event in a channel and for a specific session.
4947 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4948 struct ltt_ust_channel
*uchan
,
4949 struct ltt_ust_event
*uevent
)
4952 struct lttng_ht_iter iter
, uiter
;
4953 struct lttng_ht_node_str
*ua_chan_node
;
4954 struct ust_app
*app
;
4955 struct ust_app_session
*ua_sess
;
4956 struct ust_app_channel
*ua_chan
;
4957 struct ust_app_event
*ua_event
;
4959 LTTNG_ASSERT(usess
->active
);
4960 DBG("UST app disabling event %s for all apps in channel "
4961 "%s for session id %" PRIu64
,
4967 lttng::urcu::read_lock_guard read_lock
;
4969 /* For all registered applications */
4970 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4971 if (!app
->compatible
) {
4973 * TODO: In time, we should notice the caller of this error by
4974 * telling him that this is a version error.
4978 ua_sess
= lookup_session_by_app(usess
, app
);
4979 if (ua_sess
== nullptr) {
4984 /* Lookup channel in the ust app session */
4985 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
4986 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4987 if (ua_chan_node
== nullptr) {
4988 DBG2("Channel %s not found in session id %" PRIu64
4996 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
4998 ua_event
= find_ust_app_event(
5002 (enum lttng_ust_abi_loglevel_type
) uevent
->attr
.loglevel_type
,
5003 uevent
->attr
.loglevel
,
5005 if (ua_event
== nullptr) {
5006 DBG2("Event %s not found in channel %s for app pid %d."
5014 ret
= disable_ust_app_event(ua_event
, app
);
5016 /* XXX: Report error someday... */
5025 /* The ua_sess lock must be held by the caller. */
5026 static int ust_app_channel_create(struct ltt_ust_session
*usess
,
5027 struct ust_app_session
*ua_sess
,
5028 struct ltt_ust_channel
*uchan
,
5029 struct ust_app
*app
,
5030 struct ust_app_channel
**_ua_chan
)
5033 struct ust_app_channel
*ua_chan
= nullptr;
5035 LTTNG_ASSERT(ua_sess
);
5036 ASSERT_LOCKED(ua_sess
->lock
);
5038 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
, sizeof(uchan
->name
))) {
5039 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
5042 struct ltt_ust_context
*uctx
= nullptr;
5045 * Create channel onto application and synchronize its
5048 ret
= ust_app_channel_allocate(
5049 ua_sess
, uchan
, LTTNG_UST_ABI_CHAN_PER_CPU
, usess
, &ua_chan
);
5054 ret
= ust_app_channel_send(app
, usess
, ua_sess
, ua_chan
);
5060 cds_list_for_each_entry (uctx
, &uchan
->ctx_list
, list
) {
5061 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5073 * The application's socket is not valid. Either a bad socket
5074 * or a timeout on it. We can't inform the caller that for a
5075 * specific app, the session failed so lets continue here.
5077 ret
= 0; /* Not an error. */
5085 if (ret
== 0 && _ua_chan
) {
5087 * Only return the application's channel on success. Note
5088 * that the channel can still be part of the application's
5089 * channel hashtable on error.
5091 *_ua_chan
= ua_chan
;
5097 * Enable event for a specific session and channel on the tracer.
5099 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
5100 struct ltt_ust_channel
*uchan
,
5101 struct ltt_ust_event
*uevent
)
5104 struct lttng_ht_iter iter
, uiter
;
5105 struct lttng_ht_node_str
*ua_chan_node
;
5106 struct ust_app
*app
;
5107 struct ust_app_session
*ua_sess
;
5108 struct ust_app_channel
*ua_chan
;
5109 struct ust_app_event
*ua_event
;
5111 LTTNG_ASSERT(usess
->active
);
5112 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
5117 * NOTE: At this point, this function is called only if the session and
5118 * channel passed are already created for all apps. and enabled on the
5123 lttng::urcu::read_lock_guard read_lock
;
5125 /* For all registered applications */
5126 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5127 if (!app
->compatible
) {
5129 * TODO: In time, we should notice the caller of this error by
5130 * telling him that this is a version error.
5134 ua_sess
= lookup_session_by_app(usess
, app
);
5136 /* The application has problem or is probably dead. */
5140 pthread_mutex_lock(&ua_sess
->lock
);
5142 if (ua_sess
->deleted
) {
5143 pthread_mutex_unlock(&ua_sess
->lock
);
5147 /* Lookup channel in the ust app session */
5148 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
5149 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5151 * It is possible that the channel cannot be found is
5152 * the channel/event creation occurs concurrently with
5153 * an application exit.
5155 if (!ua_chan_node
) {
5156 pthread_mutex_unlock(&ua_sess
->lock
);
5160 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
5162 /* Get event node */
5163 ua_event
= find_ust_app_event(
5167 (enum lttng_ust_abi_loglevel_type
) uevent
->attr
.loglevel_type
,
5168 uevent
->attr
.loglevel
,
5170 if (ua_event
== nullptr) {
5171 DBG3("UST app enable event %s not found for app PID %d."
5178 ret
= enable_ust_app_event(ua_event
, app
);
5180 pthread_mutex_unlock(&ua_sess
->lock
);
5184 pthread_mutex_unlock(&ua_sess
->lock
);
5192 * For a specific existing UST session and UST channel, creates the event for
5193 * all registered apps.
5195 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
5196 struct ltt_ust_channel
*uchan
,
5197 struct ltt_ust_event
*uevent
)
5200 struct lttng_ht_iter iter
, uiter
;
5201 struct lttng_ht_node_str
*ua_chan_node
;
5202 struct ust_app
*app
;
5203 struct ust_app_session
*ua_sess
;
5204 struct ust_app_channel
*ua_chan
;
5206 LTTNG_ASSERT(usess
->active
);
5207 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
5212 lttng::urcu::read_lock_guard read_lock
;
5214 /* For all registered applications */
5215 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5216 if (!app
->compatible
) {
5218 * TODO: In time, we should notice the caller of this error by
5219 * telling him that this is a version error.
5224 ua_sess
= lookup_session_by_app(usess
, app
);
5226 /* The application has problem or is probably dead. */
5230 pthread_mutex_lock(&ua_sess
->lock
);
5232 if (ua_sess
->deleted
) {
5233 pthread_mutex_unlock(&ua_sess
->lock
);
5237 /* Lookup channel in the ust app session */
5238 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
5239 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5240 /* If the channel is not found, there is a code flow error */
5241 LTTNG_ASSERT(ua_chan_node
);
5243 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
5245 ret
= create_ust_app_event(ua_chan
, uevent
, app
);
5246 pthread_mutex_unlock(&ua_sess
->lock
);
5248 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
5249 /* Possible value at this point: -ENOMEM. If so, we stop! */
5253 DBG2("UST app event %s already exist on app PID %d",
5265 * Start tracing for a specific UST session and app.
5267 * Called with UST app session lock held.
5270 static int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5273 struct ust_app_session
*ua_sess
;
5275 DBG("Starting tracing for ust app pid %d", app
->pid
);
5277 lttng::urcu::read_lock_guard read_lock
;
5279 if (!app
->compatible
) {
5283 ua_sess
= lookup_session_by_app(usess
, app
);
5284 if (ua_sess
== nullptr) {
5285 /* The session is in teardown process. Ignore and continue. */
5289 pthread_mutex_lock(&ua_sess
->lock
);
5291 if (ua_sess
->deleted
) {
5292 pthread_mutex_unlock(&ua_sess
->lock
);
5296 if (ua_sess
->enabled
) {
5297 pthread_mutex_unlock(&ua_sess
->lock
);
5301 /* Upon restart, we skip the setup, already done */
5302 if (ua_sess
->started
) {
5306 health_code_update();
5309 /* This starts the UST tracing */
5310 pthread_mutex_lock(&app
->sock_lock
);
5311 ret
= lttng_ust_ctl_start_session(app
->sock
, ua_sess
->handle
);
5312 pthread_mutex_unlock(&app
->sock_lock
);
5314 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5315 DBG3("UST app start session failed. Application is dead: pid = %d, sock = %d",
5318 pthread_mutex_unlock(&ua_sess
->lock
);
5320 } else if (ret
== -EAGAIN
) {
5321 WARN("UST app start session failed. Communication time out: pid = %d, sock = %d",
5324 pthread_mutex_unlock(&ua_sess
->lock
);
5328 ERR("UST app start session failed with ret %d: pid = %d, sock = %d",
5336 /* Indicate that the session has been started once */
5337 ua_sess
->started
= true;
5338 ua_sess
->enabled
= true;
5340 pthread_mutex_unlock(&ua_sess
->lock
);
5342 health_code_update();
5344 /* Quiescent wait after starting trace */
5345 pthread_mutex_lock(&app
->sock_lock
);
5346 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5347 pthread_mutex_unlock(&app
->sock_lock
);
5349 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5350 DBG3("UST app wait quiescent failed. Application is dead: pid = %d, sock = %d",
5353 } else if (ret
== -EAGAIN
) {
5354 WARN("UST app wait quiescent failed. Communication time out: pid = %d, sock = %d",
5358 ERR("UST app wait quiescent failed with ret %d: pid %d, sock = %d",
5366 health_code_update();
5370 pthread_mutex_unlock(&ua_sess
->lock
);
5371 health_code_update();
5376 * Stop tracing for a specific UST session and app.
5378 static int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5381 struct ust_app_session
*ua_sess
;
5383 DBG("Stopping tracing for ust app pid %d", app
->pid
);
5385 lttng::urcu::read_lock_guard read_lock
;
5387 if (!app
->compatible
) {
5388 goto end_no_session
;
5391 ua_sess
= lookup_session_by_app(usess
, app
);
5392 if (ua_sess
== nullptr) {
5393 goto end_no_session
;
5396 pthread_mutex_lock(&ua_sess
->lock
);
5398 if (ua_sess
->deleted
) {
5399 pthread_mutex_unlock(&ua_sess
->lock
);
5400 goto end_no_session
;
5404 * If started = 0, it means that stop trace has been called for a session
5405 * that was never started. It's possible since we can have a fail start
5406 * from either the application manager thread or the command thread. Simply
5407 * indicate that this is a stop error.
5409 if (!ua_sess
->started
) {
5410 goto error_rcu_unlock
;
5413 health_code_update();
5415 /* This inhibits UST tracing */
5416 pthread_mutex_lock(&app
->sock_lock
);
5417 ret
= lttng_ust_ctl_stop_session(app
->sock
, ua_sess
->handle
);
5418 pthread_mutex_unlock(&app
->sock_lock
);
5420 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5421 DBG3("UST app stop session failed. Application is dead: pid = %d, sock = %d",
5425 } else if (ret
== -EAGAIN
) {
5426 WARN("UST app stop session failed. Communication time out: pid = %d, sock = %d",
5432 ERR("UST app stop session failed with ret %d: pid = %d, sock = %d",
5437 goto error_rcu_unlock
;
5440 health_code_update();
5441 ua_sess
->enabled
= false;
5443 /* Quiescent wait after stopping trace */
5444 pthread_mutex_lock(&app
->sock_lock
);
5445 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5446 pthread_mutex_unlock(&app
->sock_lock
);
5448 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5449 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d",
5452 } else if (ret
== -EAGAIN
) {
5453 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d",
5457 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d",
5464 health_code_update();
5467 auto locked_registry
= get_locked_session_registry(ua_sess
);
5469 /* The UST app session is held registry shall not be null. */
5470 LTTNG_ASSERT(locked_registry
);
5472 /* Push metadata for application before freeing the application. */
5473 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
5477 pthread_mutex_unlock(&ua_sess
->lock
);
5479 health_code_update();
5483 pthread_mutex_unlock(&ua_sess
->lock
);
5484 health_code_update();
5488 static int ust_app_flush_app_session(ust_app
& app
, ust_app_session
& ua_sess
)
5490 int ret
, retval
= 0;
5491 struct lttng_ht_iter iter
;
5492 struct ust_app_channel
*ua_chan
;
5493 struct consumer_socket
*socket
;
5495 DBG("Flushing app session buffers for ust app pid %d", app
.pid
);
5497 if (!app
.compatible
) {
5498 goto end_not_compatible
;
5501 pthread_mutex_lock(&ua_sess
.lock
);
5503 if (ua_sess
.deleted
) {
5507 health_code_update();
5509 /* Flushing buffers */
5510 socket
= consumer_find_socket_by_bitness(app
.abi
.bits_per_long
, ua_sess
.consumer
);
5512 /* Flush buffers and push metadata. */
5513 switch (ua_sess
.buffer_type
) {
5514 case LTTNG_BUFFER_PER_PID
:
5516 lttng::urcu::read_lock_guard read_lock
;
5518 cds_lfht_for_each_entry (ua_sess
.channels
->ht
, &iter
.iter
, ua_chan
, node
.node
) {
5519 health_code_update();
5520 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5522 ERR("Error flushing consumer channel");
5530 case LTTNG_BUFFER_PER_UID
:
5536 health_code_update();
5539 pthread_mutex_unlock(&ua_sess
.lock
);
5542 health_code_update();
5547 * Flush buffers for all applications for a specific UST session.
5548 * Called with UST session lock held.
5550 static int ust_app_flush_session(struct ltt_ust_session
*usess
)
5555 DBG("Flushing session buffers for all ust apps");
5557 /* Flush buffers and push metadata. */
5558 switch (usess
->buffer_type
) {
5559 case LTTNG_BUFFER_PER_UID
:
5561 struct buffer_reg_uid
*reg
;
5562 struct lttng_ht_iter iter
;
5564 /* Flush all per UID buffers associated to that session. */
5565 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5566 lttng::urcu::read_lock_guard read_lock
;
5567 lsu::registry_session
*ust_session_reg
;
5568 struct buffer_reg_channel
*buf_reg_chan
;
5569 struct consumer_socket
*socket
;
5571 /* Get consumer socket to use to push the metadata.*/
5572 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5575 /* Ignore request if no consumer is found for the session. */
5579 cds_lfht_for_each_entry (
5580 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
5582 * The following call will print error values so the return
5583 * code is of little importance because whatever happens, we
5584 * have to try them all.
5586 (void) consumer_flush_channel(socket
, buf_reg_chan
->consumer_key
);
5589 ust_session_reg
= reg
->registry
->reg
.ust
;
5590 /* Push metadata. */
5591 auto locked_registry
= ust_session_reg
->lock();
5592 (void) push_metadata(locked_registry
, usess
->consumer
);
5597 case LTTNG_BUFFER_PER_PID
:
5599 struct ust_app_session
*ua_sess
;
5600 struct lttng_ht_iter iter
;
5601 struct ust_app
*app
;
5602 lttng::urcu::read_lock_guard read_lock
;
5604 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5605 ua_sess
= lookup_session_by_app(usess
, app
);
5606 if (ua_sess
== nullptr) {
5610 (void) ust_app_flush_app_session(*app
, *ua_sess
);
5621 health_code_update();
5625 static int ust_app_clear_quiescent_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
)
5628 struct lttng_ht_iter iter
;
5629 struct ust_app_channel
*ua_chan
;
5630 struct consumer_socket
*socket
;
5632 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5634 lttng::urcu::read_lock_guard read_lock
;
5636 if (!app
->compatible
) {
5637 goto end_not_compatible
;
5640 pthread_mutex_lock(&ua_sess
->lock
);
5642 if (ua_sess
->deleted
) {
5646 health_code_update();
5648 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, ua_sess
->consumer
);
5650 ERR("Failed to find consumer (%" PRIu32
") socket", app
->abi
.bits_per_long
);
5655 /* Clear quiescent state. */
5656 switch (ua_sess
->buffer_type
) {
5657 case LTTNG_BUFFER_PER_PID
:
5658 cds_lfht_for_each_entry (ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
, node
.node
) {
5659 health_code_update();
5660 ret
= consumer_clear_quiescent_channel(socket
, ua_chan
->key
);
5662 ERR("Error clearing quiescent state for consumer channel");
5668 case LTTNG_BUFFER_PER_UID
:
5675 health_code_update();
5678 pthread_mutex_unlock(&ua_sess
->lock
);
5681 health_code_update();
5686 * Clear quiescent state in each stream for all applications for a
5687 * specific UST session.
5688 * Called with UST session lock held.
5690 static int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5695 DBG("Clearing stream quiescent state for all ust apps");
5697 switch (usess
->buffer_type
) {
5698 case LTTNG_BUFFER_PER_UID
:
5700 struct lttng_ht_iter iter
;
5701 struct buffer_reg_uid
*reg
;
5704 * Clear quiescent for all per UID buffers associated to
5707 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5708 struct consumer_socket
*socket
;
5709 struct buffer_reg_channel
*buf_reg_chan
;
5710 lttng::urcu::read_lock_guard read_lock
;
5712 /* Get associated consumer socket.*/
5713 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5717 * Ignore request if no consumer is found for
5723 cds_lfht_for_each_entry (
5724 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
5726 * The following call will print error values so
5727 * the return code is of little importance
5728 * because whatever happens, we have to try them
5731 (void) consumer_clear_quiescent_channel(socket
,
5732 buf_reg_chan
->consumer_key
);
5738 case LTTNG_BUFFER_PER_PID
:
5740 struct ust_app_session
*ua_sess
;
5741 struct lttng_ht_iter iter
;
5742 struct ust_app
*app
;
5743 lttng::urcu::read_lock_guard read_lock
;
5745 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5746 ua_sess
= lookup_session_by_app(usess
, app
);
5747 if (ua_sess
== nullptr) {
5750 (void) ust_app_clear_quiescent_app_session(app
, ua_sess
);
5761 health_code_update();
5766 * Destroy a specific UST session in apps.
5768 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5771 struct ust_app_session
*ua_sess
;
5772 struct lttng_ht_iter iter
;
5773 struct lttng_ht_node_u64
*node
;
5775 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5777 lttng::urcu::read_lock_guard read_lock
;
5779 if (!app
->compatible
) {
5783 __lookup_session_by_app(usess
, app
, &iter
);
5784 node
= lttng_ht_iter_get_node_u64(&iter
);
5785 if (node
== nullptr) {
5786 /* Session is being or is deleted. */
5789 ua_sess
= lttng::utils::container_of(node
, &ust_app_session::node
);
5791 health_code_update();
5792 destroy_app_session(app
, ua_sess
);
5794 health_code_update();
5796 /* Quiescent wait after stopping trace */
5797 pthread_mutex_lock(&app
->sock_lock
);
5798 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5799 pthread_mutex_unlock(&app
->sock_lock
);
5801 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5802 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d",
5805 } else if (ret
== -EAGAIN
) {
5806 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d",
5810 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d",
5817 health_code_update();
5822 * Start tracing for the UST session.
5824 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5826 struct lttng_ht_iter iter
;
5827 struct ust_app
*app
;
5829 DBG("Starting all UST traces");
5832 * Even though the start trace might fail, flag this session active so
5833 * other application coming in are started by default.
5835 usess
->active
= true;
5838 * In a start-stop-start use-case, we need to clear the quiescent state
5839 * of each channel set by the prior stop command, thus ensuring that a
5840 * following stop or destroy is sure to grab a timestamp_end near those
5841 * operations, even if the packet is empty.
5843 (void) ust_app_clear_quiescent_session(usess
);
5846 lttng::urcu::read_lock_guard read_lock
;
5848 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5849 ust_app_global_update(usess
, app
);
5857 * Start tracing for the UST session.
5858 * Called with UST session lock held.
5860 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5863 struct lttng_ht_iter iter
;
5864 struct ust_app
*app
;
5866 DBG("Stopping all UST traces");
5869 * Even though the stop trace might fail, flag this session inactive so
5870 * other application coming in are not started by default.
5872 usess
->active
= false;
5875 lttng::urcu::read_lock_guard read_lock
;
5877 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5878 ret
= ust_app_stop_trace(usess
, app
);
5880 /* Continue to next apps even on error */
5886 (void) ust_app_flush_session(usess
);
5892 * Destroy app UST session.
5894 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5897 struct lttng_ht_iter iter
;
5898 struct ust_app
*app
;
5900 DBG("Destroy all UST traces");
5903 lttng::urcu::read_lock_guard read_lock
;
5905 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5906 ret
= destroy_trace(usess
, app
);
5908 /* Continue to next apps even on error */
5917 /* The ua_sess lock must be held by the caller. */
5918 static int find_or_create_ust_app_channel(struct ltt_ust_session
*usess
,
5919 struct ust_app_session
*ua_sess
,
5920 struct ust_app
*app
,
5921 struct ltt_ust_channel
*uchan
,
5922 struct ust_app_channel
**ua_chan
)
5925 struct lttng_ht_iter iter
;
5926 struct lttng_ht_node_str
*ua_chan_node
;
5928 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5929 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5931 *ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5935 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5943 static int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5944 struct ltt_ust_event
*uevent
,
5945 struct ust_app
*app
)
5948 struct ust_app_event
*ua_event
= nullptr;
5950 ua_event
= find_ust_app_event(ua_chan
->events
,
5953 (enum lttng_ust_abi_loglevel_type
) uevent
->attr
.loglevel_type
,
5954 uevent
->attr
.loglevel
,
5957 ret
= create_ust_app_event(ua_chan
, uevent
, app
);
5962 if (ua_event
->enabled
!= uevent
->enabled
) {
5963 ret
= uevent
->enabled
? enable_ust_app_event(ua_event
, app
) :
5964 disable_ust_app_event(ua_event
, app
);
5972 /* Called with RCU read-side lock held. */
5973 static void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5976 enum lttng_error_code ret_code
;
5977 enum lttng_trigger_status t_status
;
5978 struct lttng_ht_iter app_trigger_iter
;
5979 struct lttng_triggers
*triggers
= nullptr;
5980 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5981 unsigned int count
, i
;
5983 ASSERT_RCU_READ_LOCKED();
5985 if (!ust_app_supports_notifiers(app
)) {
5990 * Currrently, registering or unregistering a trigger with an
5991 * event rule condition causes a full synchronization of the event
5994 * The first step attempts to add an event notifier for all registered
5995 * triggers that apply to the user space tracers. Then, the
5996 * application's event notifiers rules are all checked against the list
5997 * of registered triggers. Any event notifier that doesn't have a
5998 * matching trigger can be assumed to have been disabled.
6000 * All of this is inefficient, but is put in place to get the feature
6001 * rolling as it is simpler at this moment. It will be optimized Soon™
6002 * to allow the state of enabled
6003 * event notifiers to be synchronized in a piece-wise way.
6006 /* Get all triggers using uid 0 (root) */
6007 ret_code
= notification_thread_command_list_triggers(
6008 the_notification_thread_handle
, 0, &triggers
);
6009 if (ret_code
!= LTTNG_OK
) {
6013 LTTNG_ASSERT(triggers
);
6015 t_status
= lttng_triggers_get_count(triggers
, &count
);
6016 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
6020 for (i
= 0; i
< count
; i
++) {
6021 const struct lttng_condition
*condition
;
6022 const struct lttng_event_rule
*event_rule
;
6023 struct lttng_trigger
*trigger
;
6024 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
6025 enum lttng_condition_status condition_status
;
6028 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
6029 LTTNG_ASSERT(trigger
);
6031 token
= lttng_trigger_get_tracer_token(trigger
);
6032 condition
= lttng_trigger_get_const_condition(trigger
);
6034 if (lttng_condition_get_type(condition
) !=
6035 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
) {
6036 /* Does not apply */
6041 lttng_condition_event_rule_matches_get_rule(condition
, &event_rule
);
6042 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
6044 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
6045 /* Skip kernel related triggers. */
6050 * Find or create the associated token event rule. The caller
6051 * holds the RCU read lock, so this is safe to call without
6052 * explicitly acquiring it here.
6054 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
6055 app
->token_to_event_notifier_rule_ht
, token
);
6056 if (!looked_up_event_notifier_rule
) {
6057 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
6065 lttng::urcu::read_lock_guard read_lock
;
6067 /* Remove all unknown event sources from the app. */
6068 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
6069 &app_trigger_iter
.iter
,
6070 event_notifier_rule
,
6072 const uint64_t app_token
= event_notifier_rule
->token
;
6076 * Check if the app event trigger still exists on the
6077 * notification side.
6079 for (i
= 0; i
< count
; i
++) {
6080 uint64_t notification_thread_token
;
6081 const struct lttng_trigger
*trigger
=
6082 lttng_triggers_get_at_index(triggers
, i
);
6084 LTTNG_ASSERT(trigger
);
6086 notification_thread_token
= lttng_trigger_get_tracer_token(trigger
);
6088 if (notification_thread_token
== app_token
) {
6100 * This trigger was unregistered, disable it on the tracer's
6103 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &app_trigger_iter
);
6104 LTTNG_ASSERT(ret
== 0);
6106 /* Callee logs errors. */
6107 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
6109 delete_ust_app_event_notifier_rule(app
->sock
, event_notifier_rule
, app
);
6114 lttng_triggers_destroy(triggers
);
6119 * RCU read lock must be held by the caller.
6121 static void ust_app_synchronize_all_channels(struct ltt_ust_session
*usess
,
6122 struct ust_app_session
*ua_sess
,
6123 struct ust_app
*app
)
6126 struct cds_lfht_iter uchan_iter
;
6127 struct ltt_ust_channel
*uchan
;
6129 LTTNG_ASSERT(usess
);
6130 LTTNG_ASSERT(ua_sess
);
6132 ASSERT_RCU_READ_LOCKED();
6134 cds_lfht_for_each_entry (usess
->domain_global
.channels
->ht
, &uchan_iter
, uchan
, node
.node
) {
6135 struct ust_app_channel
*ua_chan
;
6136 struct cds_lfht_iter uevent_iter
;
6137 struct ltt_ust_event
*uevent
;
6140 * Search for a matching ust_app_channel. If none is found,
6141 * create it. Creating the channel will cause the ua_chan
6142 * structure to be allocated, the channel buffers to be
6143 * allocated (if necessary) and sent to the application, and
6144 * all enabled contexts will be added to the channel.
6146 ret
= find_or_create_ust_app_channel(usess
, ua_sess
, app
, uchan
, &ua_chan
);
6148 /* Tracer is probably gone or ENOMEM. */
6153 /* ua_chan will be NULL for the metadata channel */
6157 cds_lfht_for_each_entry (uchan
->events
->ht
, &uevent_iter
, uevent
, node
.node
) {
6158 ret
= ust_app_channel_synchronize_event(ua_chan
, uevent
, app
);
6164 if (ua_chan
->enabled
!= uchan
->enabled
) {
6165 ret
= uchan
->enabled
? enable_ust_app_channel(ua_sess
, uchan
, app
) :
6166 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
6177 * The caller must ensure that the application is compatible and is tracked
6178 * by the process attribute trackers.
6180 static void ust_app_synchronize(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6183 struct ust_app_session
*ua_sess
= nullptr;
6186 * The application's configuration should only be synchronized for
6189 LTTNG_ASSERT(usess
->active
);
6191 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, nullptr);
6193 /* Tracer is probably gone or ENOMEM. */
6197 LTTNG_ASSERT(ua_sess
);
6199 pthread_mutex_lock(&ua_sess
->lock
);
6200 if (ua_sess
->deleted
) {
6201 goto deleted_session
;
6205 lttng::urcu::read_lock_guard read_lock
;
6207 ust_app_synchronize_all_channels(usess
, ua_sess
, app
);
6210 * Create the metadata for the application. This returns gracefully if a
6211 * metadata was already set for the session.
6213 * The metadata channel must be created after the data channels as the
6214 * consumer daemon assumes this ordering. When interacting with a relay
6215 * daemon, the consumer will use this assumption to send the
6216 * "STREAMS_SENT" message to the relay daemon.
6218 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
6220 ERR("Metadata creation failed for app sock %d for session id %" PRIu64
,
6227 pthread_mutex_unlock(&ua_sess
->lock
);
6232 static void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6234 struct ust_app_session
*ua_sess
;
6236 ua_sess
= lookup_session_by_app(usess
, app
);
6237 if (ua_sess
== nullptr) {
6240 destroy_app_session(app
, ua_sess
);
6244 * Add channels/events from UST global domain to registered apps at sock.
6246 * Called with session lock held.
6247 * Called with RCU read-side lock held.
6249 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6251 LTTNG_ASSERT(usess
);
6252 LTTNG_ASSERT(usess
->active
);
6253 ASSERT_RCU_READ_LOCKED();
6255 DBG2("UST app global update for app sock %d for session id %" PRIu64
, app
->sock
, usess
->id
);
6257 if (!app
->compatible
) {
6260 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
, usess
, app
->pid
) &&
6261 trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
, usess
, app
->uid
) &&
6262 trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
, usess
, app
->gid
)) {
6264 * Synchronize the application's internal tracing configuration
6265 * and start tracing.
6267 ust_app_synchronize(usess
, app
);
6268 ust_app_start_trace(usess
, app
);
6270 ust_app_global_destroy(usess
, app
);
6275 * Add all event notifiers to an application.
6277 * Called with session lock held.
6278 * Called with RCU read-side lock held.
6280 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
6282 ASSERT_RCU_READ_LOCKED();
6284 DBG2("UST application global event notifier rules update: app = '%s', pid = %d",
6288 if (!app
->compatible
|| !ust_app_supports_notifiers(app
)) {
6292 if (app
->event_notifier_group
.object
== nullptr) {
6293 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s', pid = %d",
6299 ust_app_synchronize_event_notifier_rules(app
);
6303 * Called with session lock held.
6305 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
6307 struct lttng_ht_iter iter
;
6308 struct ust_app
*app
;
6311 lttng::urcu::read_lock_guard read_lock
;
6313 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6314 ust_app_global_update(usess
, app
);
6319 void ust_app_global_update_all_event_notifier_rules()
6321 struct lttng_ht_iter iter
;
6322 struct ust_app
*app
;
6324 lttng::urcu::read_lock_guard read_lock
;
6325 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6326 ust_app_global_update_event_notifier_rules(app
);
6331 * Add context to a specific channel for global UST domain.
6333 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
6334 struct ltt_ust_channel
*uchan
,
6335 struct ltt_ust_context
*uctx
)
6338 struct lttng_ht_node_str
*ua_chan_node
;
6339 struct lttng_ht_iter iter
, uiter
;
6340 struct ust_app_channel
*ua_chan
= nullptr;
6341 struct ust_app_session
*ua_sess
;
6342 struct ust_app
*app
;
6344 LTTNG_ASSERT(usess
->active
);
6347 lttng::urcu::read_lock_guard read_lock
;
6348 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6349 if (!app
->compatible
) {
6351 * TODO: In time, we should notice the caller of this error by
6352 * telling him that this is a version error.
6356 ua_sess
= lookup_session_by_app(usess
, app
);
6357 if (ua_sess
== nullptr) {
6361 pthread_mutex_lock(&ua_sess
->lock
);
6363 if (ua_sess
->deleted
) {
6364 pthread_mutex_unlock(&ua_sess
->lock
);
6368 /* Lookup channel in the ust app session */
6369 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6370 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6371 if (ua_chan_node
== nullptr) {
6374 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6375 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
6380 pthread_mutex_unlock(&ua_sess
->lock
);
6388 * Receive registration and populate the given msg structure.
6390 * On success return 0 else a negative value returned by the ustctl call.
6392 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
6395 uint32_t pid
, ppid
, uid
, gid
;
6399 ret
= lttng_ust_ctl_recv_reg_msg(sock
,
6407 &msg
->bits_per_long
,
6408 &msg
->uint8_t_alignment
,
6409 &msg
->uint16_t_alignment
,
6410 &msg
->uint32_t_alignment
,
6411 &msg
->uint64_t_alignment
,
6412 &msg
->long_alignment
,
6419 case LTTNG_UST_ERR_EXITING
:
6420 DBG3("UST app recv reg message failed. Application died");
6422 case LTTNG_UST_ERR_UNSUP_MAJOR
:
6423 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
6426 LTTNG_UST_ABI_MAJOR_VERSION
,
6427 LTTNG_UST_ABI_MINOR_VERSION
);
6430 ERR("UST app recv reg message failed with ret %d", ret
);
6435 msg
->pid
= (pid_t
) pid
;
6436 msg
->ppid
= (pid_t
) ppid
;
6437 msg
->uid
= (uid_t
) uid
;
6438 msg
->gid
= (gid_t
) gid
;
6445 * Return a ust app session object using the application object and the
6446 * session object descriptor has a key. If not found, NULL is returned.
6447 * A RCU read side lock MUST be acquired when calling this function.
6449 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
, int objd
)
6451 struct lttng_ht_node_ulong
*node
;
6452 struct lttng_ht_iter iter
;
6453 struct ust_app_session
*ua_sess
= nullptr;
6456 ASSERT_RCU_READ_LOCKED();
6458 lttng_ht_lookup(app
->ust_sessions_objd
, (void *) ((unsigned long) objd
), &iter
);
6459 node
= lttng_ht_iter_get_node_ulong(&iter
);
6460 if (node
== nullptr) {
6461 DBG2("UST app session find by objd %d not found", objd
);
6465 ua_sess
= lttng::utils::container_of(node
, &ust_app_session::ust_objd_node
);
6472 * Return a ust app channel object using the application object and the channel
6473 * object descriptor has a key. If not found, NULL is returned. A RCU read side
6474 * lock MUST be acquired before calling this function.
6476 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
, int objd
)
6478 struct lttng_ht_node_ulong
*node
;
6479 struct lttng_ht_iter iter
;
6480 struct ust_app_channel
*ua_chan
= nullptr;
6483 ASSERT_RCU_READ_LOCKED();
6485 lttng_ht_lookup(app
->ust_objd
, (void *) ((unsigned long) objd
), &iter
);
6486 node
= lttng_ht_iter_get_node_ulong(&iter
);
6487 if (node
== nullptr) {
6488 DBG2("UST app channel find by objd %d not found", objd
);
6492 ua_chan
= lttng::utils::container_of(node
, &ust_app_channel::ust_objd_node
);
6499 * Reply to a register channel notification from an application on the notify
6500 * socket. The channel metadata is also created.
6502 * The session UST registry lock is acquired in this function.
6504 * On success 0 is returned else a negative value.
6506 static int handle_app_register_channel_notification(int sock
,
6508 struct lttng_ust_ctl_field
*raw_context_fields
,
6509 size_t context_field_count
)
6511 int ret
, ret_code
= 0;
6513 uint64_t chan_reg_key
;
6514 struct ust_app
*app
;
6515 struct ust_app_channel
*ua_chan
;
6516 struct ust_app_session
*ua_sess
;
6517 auto ust_ctl_context_fields
=
6518 lttng::make_unique_wrapper
<lttng_ust_ctl_field
, lttng::memory::free
>(
6519 raw_context_fields
);
6521 lttng::urcu::read_lock_guard read_lock_guard
;
6523 /* Lookup application. If not found, there is a code flow error. */
6524 app
= find_app_by_notify_sock(sock
);
6526 DBG("Application socket %d is being torn down. Abort event notify", sock
);
6530 /* Lookup channel by UST object descriptor. */
6531 ua_chan
= find_channel_by_objd(app
, cobjd
);
6533 DBG("Application channel is being torn down. Abort event notify");
6537 LTTNG_ASSERT(ua_chan
->session
);
6538 ua_sess
= ua_chan
->session
;
6540 /* Get right session registry depending on the session buffer type. */
6541 auto locked_registry_session
= get_locked_session_registry(ua_sess
);
6542 if (!locked_registry_session
) {
6543 DBG("Application session is being torn down. Abort event notify");
6547 /* Depending on the buffer type, a different channel key is used. */
6548 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6549 chan_reg_key
= ua_chan
->tracing_channel_id
;
6551 chan_reg_key
= ua_chan
->key
;
6554 auto& ust_reg_chan
= locked_registry_session
->channel(chan_reg_key
);
6556 /* Channel id is set during the object creation. */
6557 chan_id
= ust_reg_chan
.id
;
6560 * The application returns the typing information of the channel's
6561 * context fields. In per-PID buffering mode, this is the first and only
6562 * time we get this information. It is our chance to finalize the
6563 * initialiation of the channel and serialize it's layout's description
6564 * to the trace's metadata.
6566 * However, in per-UID buffering mode, every application will provide
6567 * this information (redundantly). The first time will allow us to
6568 * complete the initialization. The following times, we simply validate
6569 * that all apps provide the same typing for the context fields as a
6573 auto app_context_fields
= lsu::create_trace_fields_from_ust_ctl_fields(
6574 *locked_registry_session
,
6575 ust_ctl_context_fields
.get(),
6576 context_field_count
,
6577 lst::field_location::root::EVENT_RECORD_COMMON_CONTEXT
,
6578 lsu::ctl_field_quirks::UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS
);
6580 if (!ust_reg_chan
.is_registered()) {
6581 lst::type::cuptr event_context
= app_context_fields
.size() ?
6582 lttng::make_unique
<lst::structure_type
>(
6583 0, std::move(app_context_fields
)) :
6586 ust_reg_chan
.event_context(std::move(event_context
));
6589 * Validate that the context fields match between
6590 * registry and newcoming application.
6592 bool context_fields_match
;
6593 const auto *previous_event_context
= ust_reg_chan
.event_context();
6595 if (!previous_event_context
) {
6596 context_fields_match
= app_context_fields
.size() == 0;
6598 const lst::structure_type
app_event_context_struct(
6599 0, std::move(app_context_fields
));
6601 context_fields_match
= *previous_event_context
==
6602 app_event_context_struct
;
6605 if (!context_fields_match
) {
6606 ERR("Registering application channel due to context field mismatch: pid = %d, sock = %d",
6613 } catch (const std::exception
& ex
) {
6614 ERR("Failed to handle application context: %s", ex
.what());
6620 DBG3("UST app replying to register channel key %" PRIu64
" with id %u, ret = %d",
6625 ret
= lttng_ust_ctl_reply_register_channel(
6628 ust_reg_chan
.header_type_
== lst::stream_class::header_type::COMPACT
?
6629 LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT
:
6630 LTTNG_UST_CTL_CHANNEL_HEADER_LARGE
,
6633 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6634 DBG3("UST app reply channel failed. Application died: pid = %d, sock = %d",
6637 } else if (ret
== -EAGAIN
) {
6638 WARN("UST app reply channel failed. Communication time out: pid = %d, sock = %d",
6642 ERR("UST app reply channel failed with ret %d: pid = %d, sock = %d",
6651 /* This channel registry's registration is completed. */
6652 ust_reg_chan
.set_as_registered();
6658 * Add event to the UST channel registry. When the event is added to the
6659 * registry, the metadata is also created. Once done, this replies to the
6660 * application with the appropriate error code.
6662 * The session UST registry lock is acquired in the function.
6664 * On success 0 is returned else a negative value.
6666 static int add_event_ust_registry(int sock
,
6670 char *raw_signature
,
6672 struct lttng_ust_ctl_field
*raw_fields
,
6674 char *raw_model_emf_uri
)
6677 uint32_t event_id
= 0;
6678 uint64_t chan_reg_key
;
6679 struct ust_app
*app
;
6680 struct ust_app_channel
*ua_chan
;
6681 struct ust_app_session
*ua_sess
;
6682 lttng::urcu::read_lock_guard rcu_lock
;
6683 auto signature
= lttng::make_unique_wrapper
<char, lttng::memory::free
>(raw_signature
);
6685 lttng::make_unique_wrapper
<lttng_ust_ctl_field
, lttng::memory::free
>(raw_fields
);
6686 auto model_emf_uri
=
6687 lttng::make_unique_wrapper
<char, lttng::memory::free
>(raw_model_emf_uri
);
6689 /* Lookup application. If not found, there is a code flow error. */
6690 app
= find_app_by_notify_sock(sock
);
6692 DBG("Application socket %d is being torn down. Abort event notify", sock
);
6696 /* Lookup channel by UST object descriptor. */
6697 ua_chan
= find_channel_by_objd(app
, cobjd
);
6699 DBG("Application channel is being torn down. Abort event notify");
6703 LTTNG_ASSERT(ua_chan
->session
);
6704 ua_sess
= ua_chan
->session
;
6706 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6707 chan_reg_key
= ua_chan
->tracing_channel_id
;
6709 chan_reg_key
= ua_chan
->key
;
6713 auto locked_registry
= get_locked_session_registry(ua_sess
);
6714 if (locked_registry
) {
6716 * From this point on, this call acquires the ownership of the signature,
6717 * fields and model_emf_uri meaning any free are done inside it if needed.
6718 * These three variables MUST NOT be read/write after this.
6721 auto& channel
= locked_registry
->channel(chan_reg_key
);
6723 /* event_id is set on success. */
6729 lsu::create_trace_fields_from_ust_ctl_fields(
6733 lst::field_location::root::EVENT_RECORD_PAYLOAD
,
6734 lsu::ctl_field_quirks::
6735 UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS
),
6737 model_emf_uri
.get() ?
6738 nonstd::optional
<std::string
>(model_emf_uri
.get()) :
6740 ua_sess
->buffer_type
,
6744 } catch (const std::exception
& ex
) {
6745 ERR("Failed to add event `%s` to registry session: %s",
6748 /* Inform the application of the error; don't return directly. */
6752 DBG("Application session is being torn down. Abort event notify");
6758 * The return value is returned to ustctl so in case of an error, the
6759 * application can be notified. In case of an error, it's important not to
6760 * return a negative error or else the application will get closed.
6762 ret
= lttng_ust_ctl_reply_register_event(sock
, event_id
, ret_code
);
6764 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6765 DBG3("UST app reply event failed. Application died: pid = %d, sock = %d.",
6768 } else if (ret
== -EAGAIN
) {
6769 WARN("UST app reply event failed. Communication time out: pid = %d, sock = %d",
6773 ERR("UST app reply event failed with ret %d: pid = %d, sock = %d",
6779 * No need to wipe the create event since the application socket will
6780 * get close on error hence cleaning up everything by itself.
6785 DBG3("UST registry event %s with id %" PRId32
" added successfully", name
, event_id
);
6790 * Add enum to the UST session registry. Once done, this replies to the
6791 * application with the appropriate error code.
6793 * The session UST registry lock is acquired within this function.
6795 * On success 0 is returned else a negative value.
6797 static int add_enum_ust_registry(int sock
,
6800 struct lttng_ust_ctl_enum_entry
*raw_entries
,
6804 struct ust_app
*app
;
6805 struct ust_app_session
*ua_sess
;
6806 uint64_t enum_id
= -1ULL;
6807 lttng::urcu::read_lock_guard read_lock_guard
;
6809 lttng::make_unique_wrapper
<struct lttng_ust_ctl_enum_entry
, lttng::memory::free
>(
6812 /* Lookup application. If not found, there is a code flow error. */
6813 app
= find_app_by_notify_sock(sock
);
6815 /* Return an error since this is not an error */
6816 DBG("Application socket %d is being torn down. Aborting enum registration", sock
);
6820 /* Lookup session by UST object descriptor. */
6821 ua_sess
= find_session_by_objd(app
, sobjd
);
6823 /* Return an error since this is not an error */
6824 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6828 auto locked_registry
= get_locked_session_registry(ua_sess
);
6829 if (!locked_registry
) {
6830 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6835 * From this point on, the callee acquires the ownership of
6836 * entries. The variable entries MUST NOT be read/written after
6839 int application_reply_code
;
6841 locked_registry
->create_or_find_enum(
6842 sobjd
, name
, entries
.release(), nr_entries
, &enum_id
);
6843 application_reply_code
= 0;
6844 } catch (const std::exception
& ex
) {
6847 "Failed to create or find enumeration provided by application: app = {}, enumeration name = {}",
6852 application_reply_code
= -1;
6856 * The return value is returned to ustctl so in case of an error, the
6857 * application can be notified. In case of an error, it's important not to
6858 * return a negative error or else the application will get closed.
6860 ret
= lttng_ust_ctl_reply_register_enum(sock
, enum_id
, application_reply_code
);
6862 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6863 DBG3("UST app reply enum failed. Application died: pid = %d, sock = %d",
6866 } else if (ret
== -EAGAIN
) {
6867 WARN("UST app reply enum failed. Communication time out: pid = %d, sock = %d",
6871 ERR("UST app reply enum failed with ret %d: pid = %d, sock = %d",
6877 * No need to wipe the create enum since the application socket will
6878 * get close on error hence cleaning up everything by itself.
6883 DBG3("UST registry enum %s added successfully or already found", name
);
6888 * Handle application notification through the given notify socket.
6890 * Return 0 on success or else a negative value.
6892 int ust_app_recv_notify(int sock
)
6895 enum lttng_ust_ctl_notify_cmd cmd
;
6897 DBG3("UST app receiving notify from sock %d", sock
);
6899 ret
= lttng_ust_ctl_recv_notify(sock
, &cmd
);
6901 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6902 DBG3("UST app recv notify failed. Application died: sock = %d", sock
);
6903 } else if (ret
== -EAGAIN
) {
6904 WARN("UST app recv notify failed. Communication time out: sock = %d", sock
);
6906 ERR("UST app recv notify failed with ret %d: sock = %d", ret
, sock
);
6912 case LTTNG_UST_CTL_NOTIFY_CMD_EVENT
:
6914 int sobjd
, cobjd
, loglevel_value
;
6915 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6917 struct lttng_ust_ctl_field
*fields
;
6919 DBG2("UST app ustctl register event received");
6921 ret
= lttng_ust_ctl_recv_register_event(sock
,
6931 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6932 DBG3("UST app recv event failed. Application died: sock = %d",
6934 } else if (ret
== -EAGAIN
) {
6935 WARN("UST app recv event failed. Communication time out: sock = %d",
6938 ERR("UST app recv event failed with ret %d: sock = %d", ret
, sock
);
6944 lttng::urcu::read_lock_guard rcu_lock
;
6945 const struct ust_app
*app
= find_app_by_notify_sock(sock
);
6947 DBG("Application socket %d is being torn down. Abort event notify",
6954 if ((!fields
&& nr_fields
> 0) || (fields
&& nr_fields
== 0)) {
6955 ERR("Invalid return value from lttng_ust_ctl_recv_register_event: fields = %p, nr_fields = %zu",
6964 * Add event to the UST registry coming from the notify socket. This
6965 * call will free if needed the sig, fields and model_emf_uri. This
6966 * code path loses the ownsership of these variables and transfer them
6967 * to the this function.
6969 ret
= add_event_ust_registry(sock
,
6984 case LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL
:
6988 struct lttng_ust_ctl_field
*context_fields
;
6990 DBG2("UST app ustctl register channel received");
6992 ret
= lttng_ust_ctl_recv_register_channel(
6993 sock
, &sobjd
, &cobjd
, &field_count
, &context_fields
);
6995 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6996 DBG3("UST app recv channel failed. Application died: sock = %d",
6998 } else if (ret
== -EAGAIN
) {
6999 WARN("UST app recv channel failed. Communication time out: sock = %d",
7002 ERR("UST app recv channel failed with ret %d: sock = %d",
7010 * The fields ownership are transfered to this function call meaning
7011 * that if needed it will be freed. After this, it's invalid to access
7012 * fields or clean them up.
7014 ret
= handle_app_register_channel_notification(
7015 sock
, cobjd
, context_fields
, field_count
);
7022 case LTTNG_UST_CTL_NOTIFY_CMD_ENUM
:
7025 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
7027 struct lttng_ust_ctl_enum_entry
*entries
;
7029 DBG2("UST app ustctl register enum received");
7031 ret
= lttng_ust_ctl_recv_register_enum(sock
, &sobjd
, name
, &entries
, &nr_entries
);
7033 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
7034 DBG3("UST app recv enum failed. Application died: sock = %d", sock
);
7035 } else if (ret
== -EAGAIN
) {
7036 WARN("UST app recv enum failed. Communication time out: sock = %d",
7039 ERR("UST app recv enum failed with ret %d: sock = %d", ret
, sock
);
7044 /* Callee assumes ownership of entries. */
7045 ret
= add_enum_ust_registry(sock
, sobjd
, name
, entries
, nr_entries
);
7053 /* Should NEVER happen. */
7062 * Once the notify socket hangs up, this is called. First, it tries to find the
7063 * corresponding application. On failure, the call_rcu to close the socket is
7064 * executed. If an application is found, it tries to delete it from the notify
7065 * socket hash table. Whathever the result, it proceeds to the call_rcu.
7067 * Note that an object needs to be allocated here so on ENOMEM failure, the
7068 * call RCU is not done but the rest of the cleanup is.
7070 void ust_app_notify_sock_unregister(int sock
)
7073 struct lttng_ht_iter iter
;
7074 struct ust_app
*app
;
7075 struct ust_app_notify_sock_obj
*obj
;
7077 LTTNG_ASSERT(sock
>= 0);
7079 lttng::urcu::read_lock_guard read_lock
;
7081 obj
= zmalloc
<ust_app_notify_sock_obj
>();
7084 * An ENOMEM is kind of uncool. If this strikes we continue the
7085 * procedure but the call_rcu will not be called. In this case, we
7086 * accept the fd leak rather than possibly creating an unsynchronized
7087 * state between threads.
7089 * TODO: The notify object should be created once the notify socket is
7090 * registered and stored independantely from the ust app object. The
7091 * tricky part is to synchronize the teardown of the application and
7092 * this notify object. Let's keep that in mind so we can avoid this
7093 * kind of shenanigans with ENOMEM in the teardown path.
7100 DBG("UST app notify socket unregister %d", sock
);
7103 * Lookup application by notify socket. If this fails, this means that the
7104 * hash table delete has already been done by the application
7105 * unregistration process so we can safely close the notify socket in a
7108 app
= find_app_by_notify_sock(sock
);
7113 iter
.iter
.node
= &app
->notify_sock_n
.node
;
7116 * Whatever happens here either we fail or succeed, in both cases we have
7117 * to close the socket after a grace period to continue to the call RCU
7118 * here. If the deletion is successful, the application is not visible
7119 * anymore by other threads and is it fails it means that it was already
7120 * deleted from the hash table so either way we just have to close the
7123 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
7128 * Close socket after a grace period to avoid for the socket to be reused
7129 * before the application object is freed creating potential race between
7130 * threads trying to add unique in the global hash table.
7133 call_rcu(&obj
->head
, close_notify_sock_rcu
);
7138 * Destroy a ust app data structure and free its memory.
7140 static void ust_app_destroy(ust_app
& app
)
7142 call_rcu(&app
.pid_n
.head
, delete_ust_app_rcu
);
7146 * Take a snapshot for a given UST session. The snapshot is sent to the given
7149 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
7151 enum lttng_error_code
ust_app_snapshot_record(const struct ltt_ust_session
*usess
,
7152 const struct consumer_output
*output
,
7153 uint64_t nb_packets_per_stream
)
7156 enum lttng_error_code status
= LTTNG_OK
;
7157 struct lttng_ht_iter iter
;
7158 struct ust_app
*app
;
7159 char *trace_path
= nullptr;
7161 LTTNG_ASSERT(usess
);
7162 LTTNG_ASSERT(output
);
7164 switch (usess
->buffer_type
) {
7165 case LTTNG_BUFFER_PER_UID
:
7167 struct buffer_reg_uid
*reg
;
7169 lttng::urcu::read_lock_guard read_lock
;
7171 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7172 struct buffer_reg_channel
*buf_reg_chan
;
7173 struct consumer_socket
*socket
;
7174 char pathname
[PATH_MAX
];
7175 size_t consumer_path_offset
= 0;
7177 if (!reg
->registry
->reg
.ust
->_metadata_key
) {
7178 /* Skip since no metadata is present */
7182 /* Get consumer socket to use to push the metadata.*/
7183 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7186 status
= LTTNG_ERR_INVALID
;
7190 memset(pathname
, 0, sizeof(pathname
));
7191 ret
= snprintf(pathname
,
7193 DEFAULT_UST_TRACE_UID_PATH
,
7195 reg
->bits_per_long
);
7197 PERROR("snprintf snapshot path");
7198 status
= LTTNG_ERR_INVALID
;
7201 /* Free path allowed on previous iteration. */
7203 trace_path
= setup_channel_trace_path(
7204 usess
->consumer
, pathname
, &consumer_path_offset
);
7206 status
= LTTNG_ERR_INVALID
;
7209 /* Add the UST default trace dir to path. */
7210 cds_lfht_for_each_entry (
7211 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7213 consumer_snapshot_channel(socket
,
7214 buf_reg_chan
->consumer_key
,
7217 &trace_path
[consumer_path_offset
],
7218 nb_packets_per_stream
);
7219 if (status
!= LTTNG_OK
) {
7223 status
= consumer_snapshot_channel(socket
,
7224 reg
->registry
->reg
.ust
->_metadata_key
,
7227 &trace_path
[consumer_path_offset
],
7229 if (status
!= LTTNG_OK
) {
7236 case LTTNG_BUFFER_PER_PID
:
7238 lttng::urcu::read_lock_guard read_lock
;
7240 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7241 struct consumer_socket
*socket
;
7242 struct lttng_ht_iter chan_iter
;
7243 struct ust_app_channel
*ua_chan
;
7244 struct ust_app_session
*ua_sess
;
7245 lsu::registry_session
*registry
;
7246 char pathname
[PATH_MAX
];
7247 size_t consumer_path_offset
= 0;
7249 ua_sess
= lookup_session_by_app(usess
, app
);
7251 /* Session not associated with this app. */
7255 /* Get the right consumer socket for the application. */
7256 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, output
);
7258 status
= LTTNG_ERR_INVALID
;
7262 /* Add the UST default trace dir to path. */
7263 memset(pathname
, 0, sizeof(pathname
));
7264 ret
= snprintf(pathname
, sizeof(pathname
), "%s", ua_sess
->path
);
7266 status
= LTTNG_ERR_INVALID
;
7267 PERROR("snprintf snapshot path");
7270 /* Free path allowed on previous iteration. */
7272 trace_path
= setup_channel_trace_path(
7273 usess
->consumer
, pathname
, &consumer_path_offset
);
7275 status
= LTTNG_ERR_INVALID
;
7278 cds_lfht_for_each_entry (
7279 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7281 consumer_snapshot_channel(socket
,
7285 &trace_path
[consumer_path_offset
],
7286 nb_packets_per_stream
);
7290 case LTTNG_ERR_CHAN_NOT_FOUND
:
7297 registry
= get_session_registry(ua_sess
);
7299 DBG("Application session is being torn down. Skip application.");
7302 status
= consumer_snapshot_channel(socket
,
7303 registry
->_metadata_key
,
7306 &trace_path
[consumer_path_offset
],
7311 case LTTNG_ERR_CHAN_NOT_FOUND
:
7330 * Return the size taken by one more packet per stream.
7332 uint64_t ust_app_get_size_one_more_packet_per_stream(const struct ltt_ust_session
*usess
,
7333 uint64_t cur_nr_packets
)
7335 uint64_t tot_size
= 0;
7336 struct ust_app
*app
;
7337 struct lttng_ht_iter iter
;
7339 LTTNG_ASSERT(usess
);
7341 switch (usess
->buffer_type
) {
7342 case LTTNG_BUFFER_PER_UID
:
7344 struct buffer_reg_uid
*reg
;
7346 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7347 struct buffer_reg_channel
*buf_reg_chan
;
7349 lttng::urcu::read_lock_guard read_lock
;
7351 cds_lfht_for_each_entry (
7352 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7353 if (cur_nr_packets
>= buf_reg_chan
->num_subbuf
) {
7355 * Don't take channel into account if we
7356 * already grab all its packets.
7360 tot_size
+= buf_reg_chan
->subbuf_size
* buf_reg_chan
->stream_count
;
7365 case LTTNG_BUFFER_PER_PID
:
7367 lttng::urcu::read_lock_guard read_lock
;
7369 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7370 struct ust_app_channel
*ua_chan
;
7371 struct ust_app_session
*ua_sess
;
7372 struct lttng_ht_iter chan_iter
;
7374 ua_sess
= lookup_session_by_app(usess
, app
);
7376 /* Session not associated with this app. */
7380 cds_lfht_for_each_entry (
7381 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7382 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
7384 * Don't take channel into account if we
7385 * already grab all its packets.
7389 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
7402 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
7403 struct cds_list_head
*buffer_reg_uid_list
,
7404 struct consumer_output
*consumer
,
7407 uint64_t *discarded
,
7411 uint64_t consumer_chan_key
;
7416 ret
= buffer_reg_uid_consumer_channel_key(
7417 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
7425 ret
= consumer_get_lost_packets(ust_session_id
, consumer_chan_key
, consumer
, lost
);
7427 ret
= consumer_get_discarded_events(
7428 ust_session_id
, consumer_chan_key
, consumer
, discarded
);
7435 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
7436 struct ltt_ust_channel
*uchan
,
7437 struct consumer_output
*consumer
,
7439 uint64_t *discarded
,
7443 struct lttng_ht_iter iter
;
7444 struct lttng_ht_node_str
*ua_chan_node
;
7445 struct ust_app
*app
;
7446 struct ust_app_session
*ua_sess
;
7447 struct ust_app_channel
*ua_chan
;
7453 * Iterate over every registered applications. Sum counters for
7454 * all applications containing requested session and channel.
7456 lttng::urcu::read_lock_guard read_lock
;
7458 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7459 struct lttng_ht_iter uiter
;
7461 ua_sess
= lookup_session_by_app(usess
, app
);
7462 if (ua_sess
== nullptr) {
7467 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
7468 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
7469 /* If the session is found for the app, the channel must be there */
7470 LTTNG_ASSERT(ua_chan_node
);
7472 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
7477 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
, consumer
, &_lost
);
7483 uint64_t _discarded
;
7485 ret
= consumer_get_discarded_events(
7486 usess
->id
, ua_chan
->key
, consumer
, &_discarded
);
7490 (*discarded
) += _discarded
;
7497 static int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
, struct ust_app
*app
)
7500 struct ust_app_session
*ua_sess
;
7502 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
7504 lttng::urcu::read_lock_guard read_lock
;
7506 ua_sess
= lookup_session_by_app(usess
, app
);
7507 if (ua_sess
== nullptr) {
7508 /* The session is in teardown process. Ignore and continue. */
7512 pthread_mutex_lock(&ua_sess
->lock
);
7514 if (ua_sess
->deleted
) {
7518 pthread_mutex_lock(&app
->sock_lock
);
7519 ret
= lttng_ust_ctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
7520 pthread_mutex_unlock(&app
->sock_lock
);
7523 pthread_mutex_unlock(&ua_sess
->lock
);
7526 health_code_update();
7531 * Regenerate the statedump for each app in the session.
7533 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
7536 struct lttng_ht_iter iter
;
7537 struct ust_app
*app
;
7539 DBG("Regenerating the metadata for all UST apps");
7541 lttng::urcu::read_lock_guard read_lock
;
7543 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7544 if (!app
->compatible
) {
7548 ret
= ust_app_regenerate_statedump(usess
, app
);
7550 /* Continue to the next app even on error */
7559 * Rotate all the channels of a session.
7561 * Return LTTNG_OK on success or else an LTTng error code.
7563 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
7566 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7567 struct lttng_ht_iter iter
;
7568 struct ltt_ust_session
*usess
= session
->ust_session
;
7570 LTTNG_ASSERT(usess
);
7572 switch (usess
->buffer_type
) {
7573 case LTTNG_BUFFER_PER_UID
:
7575 struct buffer_reg_uid
*reg
;
7577 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7578 struct buffer_reg_channel
*buf_reg_chan
;
7579 struct consumer_socket
*socket
;
7580 lttng::urcu::read_lock_guard read_lock
;
7582 /* Get consumer socket to use to push the metadata.*/
7583 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7586 cmd_ret
= LTTNG_ERR_INVALID
;
7590 /* Rotate the data channels. */
7591 cds_lfht_for_each_entry (
7592 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7593 ret
= consumer_rotate_channel(socket
,
7594 buf_reg_chan
->consumer_key
,
7596 /* is_metadata_channel */ false);
7598 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7604 * The metadata channel might not be present.
7606 * Consumer stream allocation can be done
7607 * asynchronously and can fail on intermediary
7608 * operations (i.e add context) and lead to data
7609 * channels created with no metadata channel.
7611 if (!reg
->registry
->reg
.ust
->_metadata_key
) {
7612 /* Skip since no metadata is present. */
7617 auto locked_registry
= reg
->registry
->reg
.ust
->lock();
7618 (void) push_metadata(locked_registry
, usess
->consumer
);
7621 ret
= consumer_rotate_channel(socket
,
7622 reg
->registry
->reg
.ust
->_metadata_key
,
7624 /* is_metadata_channel */ true);
7626 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7632 case LTTNG_BUFFER_PER_PID
:
7634 lttng::urcu::read_lock_guard read_lock
;
7637 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, raw_app
, pid_n
.node
) {
7638 struct consumer_socket
*socket
;
7639 struct lttng_ht_iter chan_iter
;
7640 struct ust_app_channel
*ua_chan
;
7641 struct ust_app_session
*ua_sess
;
7642 lsu::registry_session
*registry
;
7643 bool app_reference_taken
;
7645 app_reference_taken
= ust_app_get(*raw_app
);
7646 if (!app_reference_taken
) {
7647 /* Application unregistered concurrently, skip it. */
7648 DBG("Could not get application reference as it is being torn down; skipping application");
7652 ust_app_reference
app(raw_app
);
7655 ua_sess
= lookup_session_by_app(usess
, app
.get());
7657 /* Session not associated with this app. */
7661 /* Get the right consumer socket for the application. */
7662 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7665 cmd_ret
= LTTNG_ERR_INVALID
;
7669 registry
= get_session_registry(ua_sess
);
7670 LTTNG_ASSERT(registry
);
7672 /* Rotate the data channels. */
7673 cds_lfht_for_each_entry (
7674 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7675 ret
= consumer_rotate_channel(socket
,
7678 /* is_metadata_channel */ false);
7680 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7685 /* Rotate the metadata channel. */
7687 auto locked_registry
= registry
->lock();
7689 (void) push_metadata(locked_registry
, usess
->consumer
);
7692 ret
= consumer_rotate_channel(socket
,
7693 registry
->_metadata_key
,
7695 /* is_metadata_channel */ true);
7697 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7715 enum lttng_error_code
ust_app_create_channel_subdirectories(const struct ltt_ust_session
*usess
)
7717 enum lttng_error_code ret
= LTTNG_OK
;
7718 struct lttng_ht_iter iter
;
7719 enum lttng_trace_chunk_status chunk_status
;
7720 char *pathname_index
;
7723 LTTNG_ASSERT(usess
->current_trace_chunk
);
7725 switch (usess
->buffer_type
) {
7726 case LTTNG_BUFFER_PER_UID
:
7728 struct buffer_reg_uid
*reg
;
7729 lttng::urcu::read_lock_guard read_lock
;
7731 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7732 fmt_ret
= asprintf(&pathname_index
,
7733 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
7734 "/" DEFAULT_INDEX_DIR
,
7736 reg
->bits_per_long
);
7738 ERR("Failed to format channel index directory");
7739 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7744 * Create the index subdirectory which will take care
7745 * of implicitly creating the channel's path.
7747 chunk_status
= lttng_trace_chunk_create_subdirectory(
7748 usess
->current_trace_chunk
, pathname_index
);
7749 free(pathname_index
);
7750 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7751 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7757 case LTTNG_BUFFER_PER_PID
:
7759 struct ust_app
*app
;
7760 lttng::urcu::read_lock_guard read_lock
;
7763 * Create the toplevel ust/ directory in case no apps are running.
7765 chunk_status
= lttng_trace_chunk_create_subdirectory(usess
->current_trace_chunk
,
7766 DEFAULT_UST_TRACE_DIR
);
7767 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7768 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7772 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7773 struct ust_app_session
*ua_sess
;
7774 lsu::registry_session
*registry
;
7776 ua_sess
= lookup_session_by_app(usess
, app
);
7778 /* Session not associated with this app. */
7782 registry
= get_session_registry(ua_sess
);
7784 DBG("Application session is being torn down. Skip application.");
7788 fmt_ret
= asprintf(&pathname_index
,
7789 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7792 ERR("Failed to format channel index directory");
7793 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7797 * Create the index subdirectory which will take care
7798 * of implicitly creating the channel's path.
7800 chunk_status
= lttng_trace_chunk_create_subdirectory(
7801 usess
->current_trace_chunk
, pathname_index
);
7802 free(pathname_index
);
7803 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7804 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7820 * Clear all the channels of a session.
7822 * Return LTTNG_OK on success or else an LTTng error code.
7824 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7827 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7828 struct lttng_ht_iter iter
;
7829 struct ust_app
*app
;
7830 struct ltt_ust_session
*usess
= session
->ust_session
;
7832 LTTNG_ASSERT(usess
);
7834 if (usess
->active
) {
7835 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7836 cmd_ret
= LTTNG_ERR_FATAL
;
7840 switch (usess
->buffer_type
) {
7841 case LTTNG_BUFFER_PER_UID
:
7843 struct buffer_reg_uid
*reg
;
7844 lttng::urcu::read_lock_guard read_lock
;
7846 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7847 struct buffer_reg_channel
*buf_reg_chan
;
7848 struct consumer_socket
*socket
;
7850 /* Get consumer socket to use to push the metadata.*/
7851 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7854 cmd_ret
= LTTNG_ERR_INVALID
;
7858 /* Clear the data channels. */
7859 cds_lfht_for_each_entry (
7860 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
7861 ret
= consumer_clear_channel(socket
, buf_reg_chan
->consumer_key
);
7868 auto locked_registry
= reg
->registry
->reg
.ust
->lock();
7869 (void) push_metadata(locked_registry
, usess
->consumer
);
7873 * Clear the metadata channel.
7874 * Metadata channel is not cleared per se but we still need to
7875 * perform a rotation operation on it behind the scene.
7877 ret
= consumer_clear_channel(socket
, reg
->registry
->reg
.ust
->_metadata_key
);
7884 case LTTNG_BUFFER_PER_PID
:
7886 lttng::urcu::read_lock_guard read_lock
;
7888 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7889 struct consumer_socket
*socket
;
7890 struct lttng_ht_iter chan_iter
;
7891 struct ust_app_channel
*ua_chan
;
7892 struct ust_app_session
*ua_sess
;
7893 lsu::registry_session
*registry
;
7895 ua_sess
= lookup_session_by_app(usess
, app
);
7897 /* Session not associated with this app. */
7901 /* Get the right consumer socket for the application. */
7902 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7905 cmd_ret
= LTTNG_ERR_INVALID
;
7909 registry
= get_session_registry(ua_sess
);
7911 DBG("Application session is being torn down. Skip application.");
7915 /* Clear the data channels. */
7916 cds_lfht_for_each_entry (
7917 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
7918 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7920 /* Per-PID buffer and application going away. */
7921 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7929 auto locked_registry
= registry
->lock();
7930 (void) push_metadata(locked_registry
, usess
->consumer
);
7934 * Clear the metadata channel.
7935 * Metadata channel is not cleared per se but we still need to
7936 * perform rotation operation on it behind the scene.
7938 ret
= consumer_clear_channel(socket
, registry
->_metadata_key
);
7940 /* Per-PID buffer and application going away. */
7941 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7959 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7960 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7963 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7972 * This function skips the metadata channel as the begin/end timestamps of a
7973 * metadata packet are useless.
7975 * Moreover, opening a packet after a "clear" will cause problems for live
7976 * sessions as it will introduce padding that was not part of the first trace
7977 * chunk. The relay daemon expects the content of the metadata stream of
7978 * successive metadata trace chunks to be strict supersets of one another.
7980 * For example, flushing a packet at the beginning of the metadata stream of
7981 * a trace chunk resulting from a "clear" session command will cause the
7982 * size of the metadata stream of the new trace chunk to not match the size of
7983 * the metadata stream of the original chunk. This will confuse the relay
7984 * daemon as the same "offset" in a metadata stream will no longer point
7985 * to the same content.
7987 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7989 enum lttng_error_code ret
= LTTNG_OK
;
7990 struct lttng_ht_iter iter
;
7991 struct ltt_ust_session
*usess
= session
->ust_session
;
7993 LTTNG_ASSERT(usess
);
7995 switch (usess
->buffer_type
) {
7996 case LTTNG_BUFFER_PER_UID
:
7998 struct buffer_reg_uid
*reg
;
8000 cds_list_for_each_entry (reg
, &usess
->buffer_reg_uid_list
, lnode
) {
8001 struct buffer_reg_channel
*buf_reg_chan
;
8002 struct consumer_socket
*socket
;
8003 lttng::urcu::read_lock_guard read_lock
;
8005 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
8008 ret
= LTTNG_ERR_FATAL
;
8012 cds_lfht_for_each_entry (
8013 reg
->registry
->channels
->ht
, &iter
.iter
, buf_reg_chan
, node
.node
) {
8014 const int open_ret
= consumer_open_channel_packets(
8015 socket
, buf_reg_chan
->consumer_key
);
8018 ret
= LTTNG_ERR_UNK
;
8025 case LTTNG_BUFFER_PER_PID
:
8027 struct ust_app
*app
;
8028 lttng::urcu::read_lock_guard read_lock
;
8030 cds_lfht_for_each_entry (ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
8031 struct consumer_socket
*socket
;
8032 struct lttng_ht_iter chan_iter
;
8033 struct ust_app_channel
*ua_chan
;
8034 struct ust_app_session
*ua_sess
;
8035 lsu::registry_session
*registry
;
8037 ua_sess
= lookup_session_by_app(usess
, app
);
8039 /* Session not associated with this app. */
8043 /* Get the right consumer socket for the application. */
8044 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
8047 ret
= LTTNG_ERR_FATAL
;
8051 registry
= get_session_registry(ua_sess
);
8053 DBG("Application session is being torn down. Skip application.");
8057 cds_lfht_for_each_entry (
8058 ua_sess
->channels
->ht
, &chan_iter
.iter
, ua_chan
, node
.node
) {
8059 const int open_ret
=
8060 consumer_open_channel_packets(socket
, ua_chan
->key
);
8064 * Per-PID buffer and application going
8067 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
8071 ret
= LTTNG_ERR_UNK
;
8087 lsu::ctl_field_quirks
ust_app::ctl_field_quirks() const
8090 * Application contexts are expressed as variants. LTTng-UST announces
8091 * those by registering an enumeration named `..._tag`. It then registers a
8092 * variant as part of the event context that contains the various possible
8095 * Unfortunately, the names used in the enumeration and variant don't
8096 * match: the enumeration names are all prefixed with an underscore while
8097 * the variant type tag fields aren't.
8099 * While the CTF 1.8.3 specification mentions that
8100 * underscores *should* (not *must*) be removed by CTF readers. Babeltrace
8101 * 1.x (and possibly others) expect a perfect match between the names used
8102 * by tags and variants.
8104 * When the UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS quirk is enabled,
8105 * the variant's fields are modified to match the mappings of its tag.
8107 * From ABI version >= 10.x, the variant fields and tag mapping names
8108 * correctly match, making this quirk unnecessary.
8110 return v_major
<= 9 ? lsu::ctl_field_quirks::UNDERSCORE_PREFIXED_VARIANT_TAG_MAPPINGS
:
8111 lsu::ctl_field_quirks::NONE
;
8114 static void ust_app_release(urcu_ref
*ref
)
8116 auto& app
= *lttng::utils::container_of(ref
, &ust_app::ref
);
8118 ust_app_unregister(app
);
8119 ust_app_destroy(app
);
8122 bool ust_app_get(ust_app
& app
)
8124 return urcu_ref_get_unless_zero(&app
.ref
);
8127 void ust_app_put(struct ust_app
*app
)
8133 urcu_ref_put(&app
->ref
, ust_app_release
);