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"
23 #include "session.hpp"
24 #include "ust-app.hpp"
25 #include "ust-consumer.hpp"
26 #include "ust-field-convert.hpp"
29 #include <common/bytecode/bytecode.hpp>
30 #include <common/common.hpp>
31 #include <common/compat/errno.hpp>
32 #include <common/exception.hpp>
33 #include <common/format.hpp>
34 #include <common/hashtable/utils.hpp>
35 #include <common/make-unique.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
;
70 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
72 /* Next available channel key. Access under next_channel_key_lock. */
73 static uint64_t _next_channel_key
;
74 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
76 /* Next available session ID. Access under next_session_id_lock. */
77 static uint64_t _next_session_id
;
78 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
83 * Return the session registry according to the buffer type of the given
86 * A registry per UID object MUST exists before calling this function or else
87 * it LTTNG_ASSERT() if not found. RCU read side lock must be acquired.
89 static lsu::registry_session
*get_session_registry(
90 const struct ust_app_session
*ua_sess
)
92 lsu::registry_session
*registry
= NULL
;
94 LTTNG_ASSERT(ua_sess
);
96 switch (ua_sess
->buffer_type
) {
97 case LTTNG_BUFFER_PER_PID
:
99 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
103 registry
= reg_pid
->registry
->reg
.ust
;
106 case LTTNG_BUFFER_PER_UID
:
108 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
109 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
110 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
114 registry
= reg_uid
->registry
->reg
.ust
;
125 lsu::registry_session::locked_ptr
126 get_locked_session_registry(const struct ust_app_session
*ua_sess
)
128 auto session
= get_session_registry(ua_sess
);
130 pthread_mutex_lock(&session
->_lock
);
133 return lsu::registry_session::locked_ptr
{session
};
138 * Return the incremented value of next_channel_key.
140 static uint64_t get_next_channel_key(void)
144 pthread_mutex_lock(&next_channel_key_lock
);
145 ret
= ++_next_channel_key
;
146 pthread_mutex_unlock(&next_channel_key_lock
);
151 * Return the atomically incremented value of next_session_id.
153 static uint64_t get_next_session_id(void)
157 pthread_mutex_lock(&next_session_id_lock
);
158 ret
= ++_next_session_id
;
159 pthread_mutex_unlock(&next_session_id_lock
);
163 static void copy_channel_attr_to_ustctl(
164 struct lttng_ust_ctl_consumer_channel_attr
*attr
,
165 struct lttng_ust_abi_channel_attr
*uattr
)
167 /* Copy event attributes since the layout is different. */
168 attr
->subbuf_size
= uattr
->subbuf_size
;
169 attr
->num_subbuf
= uattr
->num_subbuf
;
170 attr
->overwrite
= uattr
->overwrite
;
171 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
172 attr
->read_timer_interval
= uattr
->read_timer_interval
;
173 attr
->output
= (lttng_ust_abi_output
) uattr
->output
;
174 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
178 * Match function for the hash table lookup.
180 * It matches an ust app event based on three attributes which are the event
181 * name, the filter bytecode and the loglevel.
183 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
185 struct ust_app_event
*event
;
186 const struct ust_app_ht_key
*key
;
187 int ev_loglevel_value
;
192 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
193 key
= (ust_app_ht_key
*) _key
;
194 ev_loglevel_value
= event
->attr
.loglevel
;
196 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
199 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
203 /* Event loglevel. */
204 if (ev_loglevel_value
!= key
->loglevel_type
) {
205 if (event
->attr
.loglevel_type
== LTTNG_UST_ABI_LOGLEVEL_ALL
206 && key
->loglevel_type
== 0 &&
207 ev_loglevel_value
== -1) {
209 * Match is accepted. This is because on event creation, the
210 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
211 * -1 are accepted for this loglevel type since 0 is the one set by
212 * the API when receiving an enable event.
219 /* One of the filters is NULL, fail. */
220 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
224 if (key
->filter
&& event
->filter
) {
225 /* Both filters exists, check length followed by the bytecode. */
226 if (event
->filter
->len
!= key
->filter
->len
||
227 memcmp(event
->filter
->data
, key
->filter
->data
,
228 event
->filter
->len
) != 0) {
233 /* One of the exclusions is NULL, fail. */
234 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
238 if (key
->exclusion
&& event
->exclusion
) {
239 /* Both exclusions exists, check count followed by the names. */
240 if (event
->exclusion
->count
!= key
->exclusion
->count
||
241 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
242 event
->exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
) != 0) {
256 * Unique add of an ust app event in the given ht. This uses the custom
257 * ht_match_ust_app_event match function and the event name as hash.
259 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
260 struct ust_app_event
*event
)
262 struct cds_lfht_node
*node_ptr
;
263 struct ust_app_ht_key key
;
266 LTTNG_ASSERT(ua_chan
);
267 LTTNG_ASSERT(ua_chan
->events
);
270 ht
= ua_chan
->events
;
271 key
.name
= event
->attr
.name
;
272 key
.filter
= event
->filter
;
273 key
.loglevel_type
= (lttng_ust_abi_loglevel_type
) event
->attr
.loglevel
;
274 key
.exclusion
= event
->exclusion
;
276 node_ptr
= cds_lfht_add_unique(ht
->ht
,
277 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
278 ht_match_ust_app_event
, &key
, &event
->node
.node
);
279 LTTNG_ASSERT(node_ptr
== &event
->node
.node
);
283 * Close the notify socket from the given RCU head object. This MUST be called
284 * through a call_rcu().
286 static void close_notify_sock_rcu(struct rcu_head
*head
)
289 struct ust_app_notify_sock_obj
*obj
=
290 lttng::utils::container_of(head
, &ust_app_notify_sock_obj::head
);
292 /* Must have a valid fd here. */
293 LTTNG_ASSERT(obj
->fd
>= 0);
295 ret
= close(obj
->fd
);
297 ERR("close notify sock %d RCU", obj
->fd
);
299 lttng_fd_put(LTTNG_FD_APPS
, 1);
305 * Delete ust context safely. RCU read lock must be held before calling
309 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
314 LTTNG_ASSERT(ua_ctx
);
315 ASSERT_RCU_READ_LOCKED();
318 pthread_mutex_lock(&app
->sock_lock
);
319 ret
= lttng_ust_ctl_release_object(sock
, ua_ctx
->obj
);
320 pthread_mutex_unlock(&app
->sock_lock
);
322 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
323 DBG3("UST app release ctx failed. Application is dead: pid = %d, sock = %d",
324 app
->pid
, app
->sock
);
325 } else if (ret
== -EAGAIN
) {
326 WARN("UST app release ctx failed. Communication time out: pid = %d, sock = %d",
327 app
->pid
, app
->sock
);
329 ERR("UST app release ctx obj handle %d failed with ret %d: pid = %d, sock = %d",
330 ua_ctx
->obj
->handle
, ret
,
331 app
->pid
, app
->sock
);
340 * Delete ust app event safely. RCU read lock must be held before calling
344 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
349 LTTNG_ASSERT(ua_event
);
350 ASSERT_RCU_READ_LOCKED();
352 free(ua_event
->filter
);
353 if (ua_event
->exclusion
!= NULL
)
354 free(ua_event
->exclusion
);
355 if (ua_event
->obj
!= NULL
) {
356 pthread_mutex_lock(&app
->sock_lock
);
357 ret
= lttng_ust_ctl_release_object(sock
, ua_event
->obj
);
358 pthread_mutex_unlock(&app
->sock_lock
);
360 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
361 DBG3("UST app release event failed. Application is dead: pid = %d, sock = %d",
362 app
->pid
, app
->sock
);
363 } else if (ret
== -EAGAIN
) {
364 WARN("UST app release event failed. Communication time out: pid = %d, sock = %d",
365 app
->pid
, app
->sock
);
367 ERR("UST app release event obj failed with ret %d: pid = %d, sock = %d",
368 ret
, app
->pid
, app
->sock
);
377 * Delayed reclaim of a ust_app_event_notifier_rule object. This MUST be called
378 * through a call_rcu().
381 void free_ust_app_event_notifier_rule_rcu(struct rcu_head
*head
)
383 struct ust_app_event_notifier_rule
*obj
= lttng::utils::container_of(
384 head
, &ust_app_event_notifier_rule::rcu_head
);
390 * Delete ust app event notifier rule safely.
392 static void delete_ust_app_event_notifier_rule(int sock
,
393 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
,
398 LTTNG_ASSERT(ua_event_notifier_rule
);
400 if (ua_event_notifier_rule
->exclusion
!= NULL
) {
401 free(ua_event_notifier_rule
->exclusion
);
404 if (ua_event_notifier_rule
->obj
!= NULL
) {
405 pthread_mutex_lock(&app
->sock_lock
);
406 ret
= lttng_ust_ctl_release_object(sock
, ua_event_notifier_rule
->obj
);
407 pthread_mutex_unlock(&app
->sock_lock
);
409 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
410 DBG3("UST app release event notifier failed. Application is dead: pid = %d, sock = %d",
411 app
->pid
, app
->sock
);
412 } else if (ret
== -EAGAIN
) {
413 WARN("UST app release event notifier failed. Communication time out: pid = %d, sock = %d",
414 app
->pid
, app
->sock
);
416 ERR("UST app release event notifier failed with ret %d: pid = %d, sock = %d",
417 ret
, app
->pid
, app
->sock
);
421 free(ua_event_notifier_rule
->obj
);
424 lttng_trigger_put(ua_event_notifier_rule
->trigger
);
425 call_rcu(&ua_event_notifier_rule
->rcu_head
,
426 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
,
439 LTTNG_ASSERT(stream
);
442 pthread_mutex_lock(&app
->sock_lock
);
443 ret
= lttng_ust_ctl_release_object(sock
, stream
->obj
);
444 pthread_mutex_unlock(&app
->sock_lock
);
446 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
447 DBG3("UST app release stream failed. Application is dead: pid = %d, sock = %d",
448 app
->pid
, app
->sock
);
449 } else if (ret
== -EAGAIN
) {
450 WARN("UST app release stream failed. Communication time out: pid = %d, sock = %d",
451 app
->pid
, app
->sock
);
453 ERR("UST app release stream obj failed with ret %d: pid = %d, sock = %d",
454 ret
, app
->pid
, app
->sock
);
457 lttng_fd_put(LTTNG_FD_APPS
, 2);
465 * Delete ust app stream safely. RCU read lock must be held before calling
469 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
472 LTTNG_ASSERT(stream
);
473 ASSERT_RCU_READ_LOCKED();
475 (void) release_ust_app_stream(sock
, stream
, app
);
480 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.
498 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
500 uint64_t discarded
= 0, lost
= 0;
501 struct ltt_session
*session
;
502 struct ltt_ust_channel
*uchan
;
504 if (ua_chan
->attr
.type
!= LTTNG_UST_ABI_CHAN_PER_CPU
) {
509 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
510 if (!session
|| !session
->ust_session
) {
512 * Not finding the session is not an error because there are
513 * multiple ways the channels can be torn down.
515 * 1) The session daemon can initiate the destruction of the
516 * ust app session after receiving a destroy command or
517 * during its shutdown/teardown.
518 * 2) The application, since we are in per-pid tracing, is
519 * unregistering and tearing down its ust app session.
521 * Both paths are protected by the session list lock which
522 * ensures that the accounting of lost packets and discarded
523 * events is done exactly once. The session is then unpublished
524 * from the session list, resulting in this condition.
529 if (ua_chan
->attr
.overwrite
) {
530 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
531 ua_chan
->key
, session
->ust_session
->consumer
,
534 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
535 ua_chan
->key
, session
->ust_session
->consumer
,
538 uchan
= trace_ust_find_channel_by_name(
539 session
->ust_session
->domain_global
.channels
,
542 ERR("Missing UST channel to store discarded counters");
546 uchan
->per_pid_closed_app_discarded
+= discarded
;
547 uchan
->per_pid_closed_app_lost
+= lost
;
552 session_put(session
);
557 * Delete ust app channel safely. RCU read lock must be held before calling
560 * The session list lock must be held by the caller.
562 static void delete_ust_app_channel(int sock
,
563 struct ust_app_channel
*ua_chan
,
565 const lsu::registry_session::locked_ptr
& locked_registry
)
568 struct lttng_ht_iter iter
;
569 struct ust_app_event
*ua_event
;
570 struct ust_app_ctx
*ua_ctx
;
571 struct ust_app_stream
*stream
, *stmp
;
573 LTTNG_ASSERT(ua_chan
);
574 ASSERT_RCU_READ_LOCKED();
576 DBG3("UST app deleting channel %s", ua_chan
->name
);
579 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
580 cds_list_del(&stream
->list
);
581 delete_ust_app_stream(sock
, stream
, app
);
585 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
586 cds_list_del(&ua_ctx
->list
);
587 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
589 delete_ust_app_ctx(sock
, ua_ctx
, app
);
593 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
595 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
597 delete_ust_app_event(sock
, ua_event
, app
);
600 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
601 /* Wipe and free registry from session registry. */
602 if (locked_registry
) {
604 locked_registry
->remove_channel(ua_chan
->key
, sock
>= 0);
605 } catch (const std::exception
&ex
) {
606 DBG("Could not find channel for removal: %s", ex
.what());
611 * A negative socket can be used by the caller when
612 * cleaning-up a ua_chan in an error path. Skip the
613 * accounting in this case.
616 save_per_pid_lost_discarded_counters(ua_chan
);
620 if (ua_chan
->obj
!= NULL
) {
621 /* Remove channel from application UST object descriptor. */
622 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
623 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
625 pthread_mutex_lock(&app
->sock_lock
);
626 ret
= lttng_ust_ctl_release_object(sock
, ua_chan
->obj
);
627 pthread_mutex_unlock(&app
->sock_lock
);
629 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
630 DBG3("UST app channel %s release failed. Application is dead: pid = %d, sock = %d",
631 ua_chan
->name
, app
->pid
,
633 } else if (ret
== -EAGAIN
) {
634 WARN("UST app channel %s release failed. Communication time out: pid = %d, sock = %d",
635 ua_chan
->name
, app
->pid
,
638 ERR("UST app channel %s release failed with ret %d: pid = %d, sock = %d",
639 ua_chan
->name
, ret
, app
->pid
,
643 lttng_fd_put(LTTNG_FD_APPS
, 1);
646 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
649 int ust_app_register_done(struct ust_app
*app
)
653 pthread_mutex_lock(&app
->sock_lock
);
654 ret
= lttng_ust_ctl_register_done(app
->sock
);
655 pthread_mutex_unlock(&app
->sock_lock
);
659 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*data
)
664 pthread_mutex_lock(&app
->sock_lock
);
669 ret
= lttng_ust_ctl_release_object(sock
, data
);
671 pthread_mutex_unlock(&app
->sock_lock
);
677 * Push metadata to consumer socket.
679 * RCU read-side lock must be held to guarantee existence of socket.
680 * Must be called with the ust app session lock held.
681 * Must be called with the registry lock held.
683 * On success, return the len of metadata pushed or else a negative value.
684 * Returning a -EPIPE return value means we could not send the metadata,
685 * but it can be caused by recoverable errors (e.g. the application has
686 * terminated concurrently).
688 ssize_t
ust_app_push_metadata(const lsu::registry_session::locked_ptr
& locked_registry
,
689 struct consumer_socket
*socket
,
693 char *metadata_str
= NULL
;
694 size_t len
, offset
, new_metadata_len_sent
;
696 uint64_t metadata_key
, metadata_version
;
698 LTTNG_ASSERT(locked_registry
);
699 LTTNG_ASSERT(socket
);
700 ASSERT_RCU_READ_LOCKED();
702 metadata_key
= locked_registry
->_metadata_key
;
705 * Means that no metadata was assigned to the session. This can
706 * happens if no start has been done previously.
712 offset
= locked_registry
->_metadata_len_sent
;
713 len
= locked_registry
->_metadata_len
- locked_registry
->_metadata_len_sent
;
714 new_metadata_len_sent
= locked_registry
->_metadata_len
;
715 metadata_version
= locked_registry
->_metadata_version
;
717 DBG3("No metadata to push for metadata key %" PRIu64
,
718 locked_registry
->_metadata_key
);
720 if (send_zero_data
) {
721 DBG("No metadata to push");
727 /* Allocate only what we have to send. */
728 metadata_str
= calloc
<char>(len
);
730 PERROR("zmalloc ust app metadata string");
734 /* Copy what we haven't sent out. */
735 memcpy(metadata_str
, locked_registry
->_metadata
+ offset
, len
);
738 pthread_mutex_unlock(&locked_registry
->_lock
);
740 * We need to unlock the registry while we push metadata to
741 * break a circular dependency between the consumerd metadata
742 * lock and the sessiond registry lock. Indeed, pushing metadata
743 * to the consumerd awaits that it gets pushed all the way to
744 * relayd, but doing so requires grabbing the metadata lock. If
745 * a concurrent metadata request is being performed by
746 * consumerd, this can try to grab the registry lock on the
747 * sessiond while holding the metadata lock on the consumer
748 * daemon. Those push and pull schemes are performed on two
749 * different bidirectionnal communication sockets.
751 ret
= consumer_push_metadata(socket
, metadata_key
,
752 metadata_str
, len
, offset
, metadata_version
);
753 pthread_mutex_lock(&locked_registry
->_lock
);
756 * There is an acceptable race here between the registry
757 * metadata key assignment and the creation on the
758 * consumer. The session daemon can concurrently push
759 * metadata for this registry while being created on the
760 * consumer since the metadata key of the registry is
761 * assigned *before* it is setup to avoid the consumer
762 * to ask for metadata that could possibly be not found
763 * in the session daemon.
765 * The metadata will get pushed either by the session
766 * being stopped or the consumer requesting metadata if
767 * that race is triggered.
769 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
772 ERR("Error pushing metadata to consumer");
778 * Metadata may have been concurrently pushed, since
779 * we're not holding the registry lock while pushing to
780 * consumer. This is handled by the fact that we send
781 * the metadata content, size, and the offset at which
782 * that metadata belongs. This may arrive out of order
783 * on the consumer side, and the consumer is able to
784 * deal with overlapping fragments. The consumer
785 * supports overlapping fragments, which must be
786 * contiguous starting from offset 0. We keep the
787 * largest metadata_len_sent value of the concurrent
790 locked_registry
->_metadata_len_sent
=
791 std::max(locked_registry
->_metadata_len_sent
,
792 new_metadata_len_sent
);
801 * On error, flag the registry that the metadata is
802 * closed. We were unable to push anything and this
803 * means that either the consumer is not responding or
804 * the metadata cache has been destroyed on the
807 locked_registry
->_metadata_closed
= true;
815 * For a given application and session, push metadata to consumer.
816 * Either sock or consumer is required : if sock is NULL, the default
817 * socket to send the metadata is retrieved from consumer, if sock
818 * is not NULL we use it to send the metadata.
819 * RCU read-side lock must be held while calling this function,
820 * therefore ensuring existence of registry. It also ensures existence
821 * of socket throughout this function.
823 * Return 0 on success else a negative error.
824 * Returning a -EPIPE return value means we could not send the metadata,
825 * but it can be caused by recoverable errors (e.g. the application has
826 * terminated concurrently).
828 static int push_metadata(const lsu::registry_session::locked_ptr
& locked_registry
,
829 struct consumer_output
*consumer
)
833 struct consumer_socket
*socket
;
835 LTTNG_ASSERT(locked_registry
);
836 LTTNG_ASSERT(consumer
);
837 ASSERT_RCU_READ_LOCKED();
839 if (locked_registry
->_metadata_closed
) {
844 /* Get consumer socket to use to push the metadata.*/
845 socket
= consumer_find_socket_by_bitness(locked_registry
->abi
.bits_per_long
,
852 ret
= ust_app_push_metadata(locked_registry
, socket
, 0);
864 * Send to the consumer a close metadata command for the given session. Once
865 * done, the metadata channel is deleted and the session metadata pointer is
866 * nullified. The session lock MUST be held unless the application is
867 * in the destroy path.
869 * Do not hold the registry lock while communicating with the consumerd, because
870 * doing so causes inter-process deadlocks between consumerd and sessiond with
871 * the metadata request notification.
873 * Return 0 on success else a negative value.
875 static int close_metadata(uint64_t metadata_key
, unsigned int consumer_bitness
,
876 struct consumer_output
*consumer
)
879 struct consumer_socket
*socket
;
880 lttng::urcu::read_lock_guard read_lock_guard
;
882 LTTNG_ASSERT(consumer
);
884 /* Get consumer socket to use to push the metadata. */
885 socket
= consumer_find_socket_by_bitness(consumer_bitness
,
892 ret
= consumer_close_metadata(socket
, metadata_key
);
902 void delete_ust_app_session_rcu(struct rcu_head
*head
)
904 struct ust_app_session
*ua_sess
=
905 lttng::utils::container_of(head
, &ust_app_session::rcu_head
);
907 lttng_ht_destroy(ua_sess
->channels
);
912 * Delete ust app session safely. RCU read lock must be held before calling
915 * The session list lock must be held by the caller.
918 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
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
,
942 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
944 delete_ust_app_channel(sock
, ua_chan
, app
, locked_registry
);
947 if (locked_registry
) {
949 * Don't ask to close metadata for global per UID buffers. Close
950 * metadata only on destroy trace session in this case. Also, the
951 * previous push metadata could have flag the metadata registry to
952 * close so don't send a close command if closed.
954 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
955 const auto metadata_key
= locked_registry
->_metadata_key
;
956 const auto consumer_bitness
= locked_registry
->abi
.bits_per_long
;
958 if (!locked_registry
->_metadata_closed
&& metadata_key
!= 0) {
959 locked_registry
->_metadata_closed
= true;
962 /* Release lock before communication, see comments in close_metadata(). */
963 locked_registry
.reset();
964 (void) close_metadata(metadata_key
, consumer_bitness
, ua_sess
->consumer
);
968 /* In case of per PID, the registry is kept in the session. */
969 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
970 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
973 * Registry can be null on error path during
976 buffer_reg_pid_remove(reg_pid
);
977 buffer_reg_pid_destroy(reg_pid
);
981 if (ua_sess
->handle
!= -1) {
982 pthread_mutex_lock(&app
->sock_lock
);
983 ret
= lttng_ust_ctl_release_handle(sock
, ua_sess
->handle
);
984 pthread_mutex_unlock(&app
->sock_lock
);
986 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
987 DBG3("UST app release session handle failed. Application is dead: pid = %d, sock = %d",
988 app
->pid
, app
->sock
);
989 } else if (ret
== -EAGAIN
) {
990 WARN("UST app release session handle failed. Communication time out: pid = %d, sock = %d",
991 app
->pid
, app
->sock
);
993 ERR("UST app release session handle failed with ret %d: pid = %d, sock = %d",
994 ret
, app
->pid
, app
->sock
);
998 /* Remove session from application UST object descriptor. */
999 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
1000 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
1004 pthread_mutex_unlock(&ua_sess
->lock
);
1006 consumer_output_put(ua_sess
->consumer
);
1008 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
1012 * Delete a traceable application structure from the global list. Never call
1013 * this function outside of a call_rcu call.
1016 void delete_ust_app(struct ust_app
*app
)
1019 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
1020 struct lttng_ht_iter iter
;
1021 struct ust_app_event_notifier_rule
*event_notifier_rule
;
1022 bool event_notifier_write_fd_is_open
;
1025 * The session list lock must be held during this function to guarantee
1026 * the existence of ua_sess.
1028 session_lock_list();
1029 /* Delete ust app sessions info */
1034 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
1036 /* Free every object in the session and the session. */
1038 delete_ust_app_session(sock
, ua_sess
, app
);
1042 /* Remove the event notifier rules associated with this app. */
1044 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
1045 &iter
.iter
, event_notifier_rule
, node
.node
) {
1046 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
1049 delete_ust_app_event_notifier_rule(
1050 app
->sock
, event_notifier_rule
, app
);
1055 lttng_ht_destroy(app
->sessions
);
1056 lttng_ht_destroy(app
->ust_sessions_objd
);
1057 lttng_ht_destroy(app
->ust_objd
);
1058 lttng_ht_destroy(app
->token_to_event_notifier_rule_ht
);
1061 * This could be NULL if the event notifier setup failed (e.g the app
1062 * was killed or the tracer does not support this feature).
1064 if (app
->event_notifier_group
.object
) {
1065 enum lttng_error_code ret_code
;
1066 enum event_notifier_error_accounting_status status
;
1068 const int event_notifier_read_fd
= lttng_pipe_get_readfd(
1069 app
->event_notifier_group
.event_pipe
);
1071 ret_code
= notification_thread_command_remove_tracer_event_source(
1072 the_notification_thread_handle
,
1073 event_notifier_read_fd
);
1074 if (ret_code
!= LTTNG_OK
) {
1075 ERR("Failed to remove application tracer event source from notification thread");
1078 status
= event_notifier_error_accounting_unregister_app(app
);
1079 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1080 ERR("Error unregistering app from event notifier error accounting");
1083 lttng_ust_ctl_release_object(sock
, app
->event_notifier_group
.object
);
1084 free(app
->event_notifier_group
.object
);
1087 event_notifier_write_fd_is_open
= lttng_pipe_is_write_open(
1088 app
->event_notifier_group
.event_pipe
);
1089 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1091 * Release the file descriptors reserved for the event notifier pipe.
1092 * The app could be destroyed before the write end of the pipe could be
1093 * passed to the application (and closed). In that case, both file
1094 * descriptors must be released.
1096 lttng_fd_put(LTTNG_FD_APPS
, event_notifier_write_fd_is_open
? 2 : 1);
1099 * Wait until we have deleted the application from the sock hash table
1100 * before closing this socket, otherwise an application could re-use the
1101 * socket ID and race with the teardown, using the same hash table entry.
1103 * It's OK to leave the close in call_rcu. We want it to stay unique for
1104 * all RCU readers that could run concurrently with unregister app,
1105 * therefore we _need_ to only close that socket after a grace period. So
1106 * it should stay in this RCU callback.
1108 * This close() is a very important step of the synchronization model so
1109 * every modification to this function must be carefully reviewed.
1115 lttng_fd_put(LTTNG_FD_APPS
, 1);
1117 DBG2("UST app pid %d deleted", app
->pid
);
1119 session_unlock_list();
1123 * URCU intermediate call to delete an UST app.
1126 void delete_ust_app_rcu(struct rcu_head
*head
)
1128 struct lttng_ht_node_ulong
*node
=
1129 lttng::utils::container_of(head
, <tng_ht_node_ulong::head
);
1130 struct ust_app
*app
=
1131 lttng::utils::container_of(node
, &ust_app::pid_n
);
1133 DBG3("Call RCU deleting app PID %d", app
->pid
);
1134 delete_ust_app(app
);
1138 * Delete the session from the application ht and delete the data structure by
1139 * freeing every object inside and releasing them.
1141 * The session list lock must be held by the caller.
1143 static void destroy_app_session(struct ust_app
*app
,
1144 struct ust_app_session
*ua_sess
)
1147 struct lttng_ht_iter iter
;
1150 LTTNG_ASSERT(ua_sess
);
1152 iter
.iter
.node
= &ua_sess
->node
.node
;
1153 ret
= lttng_ht_del(app
->sessions
, &iter
);
1155 /* Already scheduled for teardown. */
1159 /* Once deleted, free the data structure. */
1160 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1167 * Alloc new UST app session.
1170 struct ust_app_session
*alloc_ust_app_session(void)
1172 struct ust_app_session
*ua_sess
;
1174 /* Init most of the default value by allocating and zeroing */
1175 ua_sess
= new ust_app_session();
1176 if (ua_sess
== NULL
) {
1181 ua_sess
->metadata_attr
.type
= LTTNG_UST_ABI_CHAN_METADATA
;
1182 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1191 * Alloc new UST app channel.
1194 struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1195 struct ust_app_session
*ua_sess
,
1196 struct lttng_ust_abi_channel_attr
*attr
)
1198 struct ust_app_channel
*ua_chan
;
1200 /* Init most of the default value by allocating and zeroing */
1201 ua_chan
= zmalloc
<ust_app_channel
>();
1202 if (ua_chan
== NULL
) {
1207 /* Setup channel name */
1208 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1209 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1211 ua_chan
->enabled
= 1;
1212 ua_chan
->handle
= -1;
1213 ua_chan
->session
= ua_sess
;
1214 ua_chan
->key
= get_next_channel_key();
1215 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1216 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1217 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1219 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1220 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1222 /* Copy attributes */
1224 /* Translate from lttng_ust_channel to lttng_ust_ctl_consumer_channel_attr. */
1225 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1226 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1227 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1228 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1229 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1230 ua_chan
->attr
.output
= (lttng_ust_abi_output
) attr
->output
;
1231 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1233 /* By default, the channel is a per cpu channel. */
1234 ua_chan
->attr
.type
= LTTNG_UST_ABI_CHAN_PER_CPU
;
1236 DBG3("UST app channel %s allocated", ua_chan
->name
);
1245 * Allocate and initialize a UST app stream.
1247 * Return newly allocated stream pointer or NULL on error.
1249 struct ust_app_stream
*ust_app_alloc_stream(void)
1251 struct ust_app_stream
*stream
= NULL
;
1253 stream
= zmalloc
<ust_app_stream
>();
1254 if (stream
== NULL
) {
1255 PERROR("zmalloc ust app stream");
1259 /* Zero could be a valid value for a handle so flag it to -1. */
1260 stream
->handle
= -1;
1267 * Alloc new UST app event.
1270 struct ust_app_event
*alloc_ust_app_event(char *name
,
1271 struct lttng_ust_abi_event
*attr
)
1273 struct ust_app_event
*ua_event
;
1275 /* Init most of the default value by allocating and zeroing */
1276 ua_event
= zmalloc
<ust_app_event
>();
1277 if (ua_event
== NULL
) {
1278 PERROR("Failed to allocate ust_app_event structure");
1282 ua_event
->enabled
= 1;
1283 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1284 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1285 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1287 /* Copy attributes */
1289 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1292 DBG3("UST app event %s allocated", ua_event
->name
);
1301 * Allocate a new UST app event notifier rule.
1303 static struct ust_app_event_notifier_rule
*alloc_ust_app_event_notifier_rule(
1304 struct lttng_trigger
*trigger
)
1306 enum lttng_event_rule_generate_exclusions_status
1307 generate_exclusion_status
;
1308 enum lttng_condition_status cond_status
;
1309 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1310 struct lttng_condition
*condition
= NULL
;
1311 const struct lttng_event_rule
*event_rule
= NULL
;
1313 ua_event_notifier_rule
= zmalloc
<ust_app_event_notifier_rule
>();
1314 if (ua_event_notifier_rule
== NULL
) {
1315 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1319 ua_event_notifier_rule
->enabled
= 1;
1320 ua_event_notifier_rule
->token
= lttng_trigger_get_tracer_token(trigger
);
1321 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
,
1322 ua_event_notifier_rule
->token
);
1324 condition
= lttng_trigger_get_condition(trigger
);
1325 LTTNG_ASSERT(condition
);
1326 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
1327 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
1329 cond_status
= lttng_condition_event_rule_matches_get_rule(
1330 condition
, &event_rule
);
1331 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
1332 LTTNG_ASSERT(event_rule
);
1334 ua_event_notifier_rule
->error_counter_index
=
1335 lttng_condition_event_rule_matches_get_error_counter_index(condition
);
1336 /* Acquire the event notifier's reference to the trigger. */
1337 lttng_trigger_get(trigger
);
1339 ua_event_notifier_rule
->trigger
= trigger
;
1340 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1341 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1342 event_rule
, &ua_event_notifier_rule
->exclusion
);
1343 switch (generate_exclusion_status
) {
1344 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1345 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1348 /* Error occurred. */
1349 ERR("Failed to generate exclusions from trigger while allocating an event notifier rule");
1350 goto error_put_trigger
;
1353 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1354 ua_event_notifier_rule
->token
);
1356 return ua_event_notifier_rule
;
1359 lttng_trigger_put(trigger
);
1361 free(ua_event_notifier_rule
);
1366 * Alloc new UST app context.
1369 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1371 struct ust_app_ctx
*ua_ctx
;
1373 ua_ctx
= zmalloc
<ust_app_ctx
>();
1374 if (ua_ctx
== NULL
) {
1378 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1381 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1382 if (uctx
->ctx
== LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
) {
1383 char *provider_name
= NULL
, *ctx_name
= NULL
;
1385 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1386 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1387 if (!provider_name
|| !ctx_name
) {
1388 free(provider_name
);
1393 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1394 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1398 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1406 * Create a liblttng-ust filter bytecode from given bytecode.
1408 * Return allocated filter or NULL on error.
1410 static struct lttng_ust_abi_filter_bytecode
*create_ust_filter_bytecode_from_bytecode(
1411 const struct lttng_bytecode
*orig_f
)
1413 struct lttng_ust_abi_filter_bytecode
*filter
= NULL
;
1415 /* Copy filter bytecode. */
1416 filter
= zmalloc
<lttng_ust_abi_filter_bytecode
>(sizeof(*filter
) + orig_f
->len
);
1418 PERROR("Failed to allocate lttng_ust_filter_bytecode: bytecode len = %" PRIu32
" bytes", orig_f
->len
);
1422 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) ==
1423 sizeof(struct lttng_ust_abi_filter_bytecode
));
1424 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1430 * Create a liblttng-ust capture bytecode from given bytecode.
1432 * Return allocated filter or NULL on error.
1434 static struct lttng_ust_abi_capture_bytecode
*
1435 create_ust_capture_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1437 struct lttng_ust_abi_capture_bytecode
*capture
= NULL
;
1439 /* Copy capture bytecode. */
1440 capture
= zmalloc
<lttng_ust_abi_capture_bytecode
>(sizeof(*capture
) + orig_f
->len
);
1442 PERROR("Failed to allocate lttng_ust_abi_capture_bytecode: bytecode len = %" PRIu32
" bytes", orig_f
->len
);
1446 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) ==
1447 sizeof(struct lttng_ust_abi_capture_bytecode
));
1448 memcpy(capture
, orig_f
, sizeof(*capture
) + orig_f
->len
);
1454 * Find an ust_app using the sock and return it. RCU read side lock must be
1455 * held before calling this helper function.
1457 struct ust_app
*ust_app_find_by_sock(int sock
)
1459 struct lttng_ht_node_ulong
*node
;
1460 struct lttng_ht_iter iter
;
1462 ASSERT_RCU_READ_LOCKED();
1464 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1465 node
= lttng_ht_iter_get_node_ulong(&iter
);
1467 DBG2("UST app find by sock %d not found", sock
);
1471 return lttng::utils::container_of(node
, &ust_app::sock_n
);
1478 * Find an ust_app using the notify sock and return it. RCU read side lock must
1479 * be held before calling this helper function.
1481 static struct ust_app
*find_app_by_notify_sock(int sock
)
1483 struct lttng_ht_node_ulong
*node
;
1484 struct lttng_ht_iter iter
;
1486 ASSERT_RCU_READ_LOCKED();
1488 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1490 node
= lttng_ht_iter_get_node_ulong(&iter
);
1492 DBG2("UST app find by notify sock %d not found", sock
);
1496 return lttng::utils::container_of(node
, &ust_app::notify_sock_n
);
1503 * Lookup for an ust app event based on event name, filter bytecode and the
1506 * Return an ust_app_event object or NULL on error.
1508 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1509 const char *name
, const struct lttng_bytecode
*filter
,
1511 const struct lttng_event_exclusion
*exclusion
)
1513 struct lttng_ht_iter iter
;
1514 struct lttng_ht_node_str
*node
;
1515 struct ust_app_event
*event
= NULL
;
1516 struct ust_app_ht_key key
;
1521 /* Setup key for event lookup. */
1523 key
.filter
= filter
;
1524 key
.loglevel_type
= (lttng_ust_abi_loglevel_type
) loglevel_value
;
1525 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1526 key
.exclusion
= exclusion
;
1528 /* Lookup using the event name as hash and a custom match fct. */
1529 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1530 ht_match_ust_app_event
, &key
, &iter
.iter
);
1531 node
= lttng_ht_iter_get_node_str(&iter
);
1536 event
= lttng::utils::container_of(node
, &ust_app_event::node
);
1543 * Look-up an event notifier rule based on its token id.
1545 * Must be called with the RCU read lock held.
1546 * Return an ust_app_event_notifier_rule object or NULL on error.
1548 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(
1549 struct lttng_ht
*ht
, uint64_t token
)
1551 struct lttng_ht_iter iter
;
1552 struct lttng_ht_node_u64
*node
;
1553 struct ust_app_event_notifier_rule
*event_notifier_rule
= NULL
;
1556 ASSERT_RCU_READ_LOCKED();
1558 lttng_ht_lookup(ht
, &token
, &iter
);
1559 node
= lttng_ht_iter_get_node_u64(&iter
);
1561 DBG2("UST app event notifier rule token not found: token = %" PRIu64
,
1566 event_notifier_rule
= lttng::utils::container_of(
1567 node
, &ust_app_event_notifier_rule::node
);
1569 return event_notifier_rule
;
1573 * Create the channel context on the tracer.
1575 * Called with UST app session lock held.
1578 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1579 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1583 health_code_update();
1585 pthread_mutex_lock(&app
->sock_lock
);
1586 ret
= lttng_ust_ctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1587 ua_chan
->obj
, &ua_ctx
->obj
);
1588 pthread_mutex_unlock(&app
->sock_lock
);
1590 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1592 DBG3("UST app create channel context failed. Application is dead: pid = %d, sock = %d",
1593 app
->pid
, app
->sock
);
1594 } else if (ret
== -EAGAIN
) {
1596 WARN("UST app create channel context failed. Communication time out: pid = %d, sock = %d",
1597 app
->pid
, app
->sock
);
1599 ERR("UST app create channel context failed with ret %d: pid = %d, sock = %d",
1600 ret
, app
->pid
, app
->sock
);
1605 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1607 DBG2("UST app context handle %d created successfully for channel %s",
1608 ua_ctx
->handle
, ua_chan
->name
);
1611 health_code_update();
1616 * Set the filter on the tracer.
1618 static int set_ust_object_filter(struct ust_app
*app
,
1619 const struct lttng_bytecode
*bytecode
,
1620 struct lttng_ust_abi_object_data
*ust_object
)
1623 struct lttng_ust_abi_filter_bytecode
*ust_bytecode
= NULL
;
1625 health_code_update();
1627 ust_bytecode
= create_ust_filter_bytecode_from_bytecode(bytecode
);
1628 if (!ust_bytecode
) {
1629 ret
= -LTTNG_ERR_NOMEM
;
1632 pthread_mutex_lock(&app
->sock_lock
);
1633 ret
= lttng_ust_ctl_set_filter(app
->sock
, ust_bytecode
,
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",
1640 app
->pid
, app
->sock
);
1641 } else if (ret
== -EAGAIN
) {
1643 WARN("UST app set filter failed. Communication time out: pid = %d, sock = %d",
1644 app
->pid
, app
->sock
);
1646 ERR("UST app set filter failed with ret %d: pid = %d, sock = %d, object = %p",
1647 ret
, app
->pid
, app
->sock
, ust_object
);
1652 DBG2("UST filter successfully set: object = %p", ust_object
);
1655 health_code_update();
1661 * Set a capture bytecode for the passed object.
1662 * The sequence number enforces the ordering at runtime and on reception of
1663 * the captured payloads.
1665 static int set_ust_capture(struct ust_app
*app
,
1666 const struct lttng_bytecode
*bytecode
,
1667 unsigned int capture_seqnum
,
1668 struct lttng_ust_abi_object_data
*ust_object
)
1671 struct lttng_ust_abi_capture_bytecode
*ust_bytecode
= NULL
;
1673 health_code_update();
1675 ust_bytecode
= create_ust_capture_bytecode_from_bytecode(bytecode
);
1676 if (!ust_bytecode
) {
1677 ret
= -LTTNG_ERR_NOMEM
;
1682 * Set the sequence number to ensure the capture of fields is ordered.
1684 ust_bytecode
->seqnum
= capture_seqnum
;
1686 pthread_mutex_lock(&app
->sock_lock
);
1687 ret
= lttng_ust_ctl_set_capture(app
->sock
, ust_bytecode
,
1689 pthread_mutex_unlock(&app
->sock_lock
);
1691 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1693 DBG3("UST app set capture failed. Application is dead: pid = %d, sock = %d",
1694 app
->pid
, app
->sock
);
1695 } else if (ret
== -EAGAIN
) {
1697 DBG3("UST app set capture failed. Communication timeout: pid = %d, sock = %d",
1698 app
->pid
, app
->sock
);
1700 ERR("UST app event set capture failed with ret %d: pid = %d, sock = %d",
1708 DBG2("UST capture successfully set: object = %p", ust_object
);
1711 health_code_update();
1717 struct lttng_ust_abi_event_exclusion
*create_ust_exclusion_from_exclusion(
1718 const struct lttng_event_exclusion
*exclusion
)
1720 struct lttng_ust_abi_event_exclusion
*ust_exclusion
= NULL
;
1721 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_abi_event_exclusion
) +
1722 LTTNG_UST_ABI_SYM_NAME_LEN
* exclusion
->count
;
1724 ust_exclusion
= zmalloc
<lttng_ust_abi_event_exclusion
>(exclusion_alloc_size
);
1725 if (!ust_exclusion
) {
1730 LTTNG_ASSERT(sizeof(struct lttng_event_exclusion
) ==
1731 sizeof(struct lttng_ust_abi_event_exclusion
));
1732 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1734 return ust_exclusion
;
1738 * Set event exclusions on the tracer.
1740 static int set_ust_object_exclusions(struct ust_app
*app
,
1741 const struct lttng_event_exclusion
*exclusions
,
1742 struct lttng_ust_abi_object_data
*ust_object
)
1745 struct lttng_ust_abi_event_exclusion
*ust_exclusions
= NULL
;
1747 LTTNG_ASSERT(exclusions
&& exclusions
->count
> 0);
1749 health_code_update();
1751 ust_exclusions
= create_ust_exclusion_from_exclusion(
1753 if (!ust_exclusions
) {
1754 ret
= -LTTNG_ERR_NOMEM
;
1757 pthread_mutex_lock(&app
->sock_lock
);
1758 ret
= lttng_ust_ctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1759 pthread_mutex_unlock(&app
->sock_lock
);
1761 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1763 DBG3("UST app event exclusion failed. Application is dead: pid = %d, sock = %d",
1764 app
->pid
, app
->sock
);
1765 } else if (ret
== -EAGAIN
) {
1767 WARN("UST app event exclusion failed. Communication time out(pid: %d, sock = %d",
1768 app
->pid
, app
->sock
);
1770 ERR("UST app event exclusions failed with ret %d: pid = %d, sock = %d, object = %p",
1771 ret
, app
->pid
, app
->sock
, ust_object
);
1776 DBG2("UST exclusions set successfully for object %p", ust_object
);
1779 health_code_update();
1780 free(ust_exclusions
);
1785 * Disable the specified event on to UST tracer for the UST session.
1787 static int disable_ust_object(struct ust_app
*app
,
1788 struct lttng_ust_abi_object_data
*object
)
1792 health_code_update();
1794 pthread_mutex_lock(&app
->sock_lock
);
1795 ret
= lttng_ust_ctl_disable(app
->sock
, object
);
1796 pthread_mutex_unlock(&app
->sock_lock
);
1798 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1800 DBG3("UST app disable object failed. Application is dead: pid = %d, sock = %d",
1801 app
->pid
, app
->sock
);
1802 } else if (ret
== -EAGAIN
) {
1804 WARN("UST app disable object failed. Communication time out: pid = %d, sock = %d",
1805 app
->pid
, app
->sock
);
1807 ERR("UST app disable object failed with ret %d: pid = %d, sock = %d, object = %p",
1808 ret
, app
->pid
, app
->sock
, object
);
1813 DBG2("UST app object %p disabled successfully for app: pid = %d",
1817 health_code_update();
1822 * Disable the specified channel on to UST tracer for the UST session.
1824 static int disable_ust_channel(struct ust_app
*app
,
1825 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1829 health_code_update();
1831 pthread_mutex_lock(&app
->sock_lock
);
1832 ret
= lttng_ust_ctl_disable(app
->sock
, ua_chan
->obj
);
1833 pthread_mutex_unlock(&app
->sock_lock
);
1835 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1837 DBG3("UST app disable channel failed. Application is dead: pid = %d, sock = %d",
1838 app
->pid
, app
->sock
);
1839 } else if (ret
== -EAGAIN
) {
1841 WARN("UST app disable channel failed. Communication time out: pid = %d, sock = %d",
1842 app
->pid
, app
->sock
);
1844 ERR("UST app channel %s disable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1845 ua_chan
->name
, ua_sess
->handle
, ret
,
1846 app
->pid
, app
->sock
);
1851 DBG2("UST app channel %s disabled successfully for app: pid = %d",
1852 ua_chan
->name
, app
->pid
);
1855 health_code_update();
1860 * Enable the specified channel on to UST tracer for the UST session.
1862 static int enable_ust_channel(struct ust_app
*app
,
1863 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1867 health_code_update();
1869 pthread_mutex_lock(&app
->sock_lock
);
1870 ret
= lttng_ust_ctl_enable(app
->sock
, ua_chan
->obj
);
1871 pthread_mutex_unlock(&app
->sock_lock
);
1873 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1875 DBG3("UST app channel %s enable failed. Application is dead: pid = %d, sock = %d",
1876 ua_chan
->name
, app
->pid
, app
->sock
);
1877 } else if (ret
== -EAGAIN
) {
1879 WARN("UST app channel %s enable failed. Communication time out: pid = %d, sock = %d",
1880 ua_chan
->name
, app
->pid
, app
->sock
);
1882 ERR("UST app channel %s enable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1883 ua_chan
->name
, ua_sess
->handle
, ret
,
1884 app
->pid
, app
->sock
);
1889 ua_chan
->enabled
= 1;
1891 DBG2("UST app channel %s enabled successfully for app: pid = %d",
1892 ua_chan
->name
, app
->pid
);
1895 health_code_update();
1900 * Enable the specified event on to UST tracer for the UST session.
1902 static int enable_ust_object(
1903 struct ust_app
*app
, struct lttng_ust_abi_object_data
*ust_object
)
1907 health_code_update();
1909 pthread_mutex_lock(&app
->sock_lock
);
1910 ret
= lttng_ust_ctl_enable(app
->sock
, ust_object
);
1911 pthread_mutex_unlock(&app
->sock_lock
);
1913 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1915 DBG3("UST app enable object failed. Application is dead: pid = %d, sock = %d",
1916 app
->pid
, app
->sock
);
1917 } else if (ret
== -EAGAIN
) {
1919 WARN("UST app enable object failed. Communication time out: pid = %d, sock = %d",
1920 app
->pid
, app
->sock
);
1922 ERR("UST app enable object failed with ret %d: pid = %d, sock = %d, object = %p",
1923 ret
, app
->pid
, app
->sock
, ust_object
);
1928 DBG2("UST app object %p enabled successfully for app: pid = %d",
1929 ust_object
, app
->pid
);
1932 health_code_update();
1937 * Send channel and stream buffer to application.
1939 * Return 0 on success. On error, a negative value is returned.
1941 static int send_channel_pid_to_ust(struct ust_app
*app
,
1942 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1945 struct ust_app_stream
*stream
, *stmp
;
1948 LTTNG_ASSERT(ua_sess
);
1949 LTTNG_ASSERT(ua_chan
);
1951 health_code_update();
1953 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1956 /* Send channel to the application. */
1957 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1958 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1959 ret
= -ENOTCONN
; /* Caused by app exiting. */
1961 } else if (ret
== -EAGAIN
) {
1962 /* Caused by timeout. */
1963 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
"\".",
1964 app
->pid
, ua_chan
->name
, ua_sess
->tracing_id
);
1965 /* Treat this the same way as an application that is exiting. */
1968 } else if (ret
< 0) {
1972 health_code_update();
1974 /* Send all streams to application. */
1975 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1976 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1977 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1978 ret
= -ENOTCONN
; /* Caused by app exiting. */
1980 } else if (ret
== -EAGAIN
) {
1981 /* Caused by timeout. */
1982 WARN("Communication with application %d timed out on send_stream for stream \"%s\" of channel \"%s\" of session \"%" PRIu64
"\".",
1983 app
->pid
, stream
->name
, ua_chan
->name
,
1984 ua_sess
->tracing_id
);
1986 * Treat this the same way as an application that is
1990 } else if (ret
< 0) {
1993 /* We don't need the stream anymore once sent to the tracer. */
1994 cds_list_del(&stream
->list
);
1995 delete_ust_app_stream(-1, stream
, app
);
1999 health_code_update();
2004 * Create the specified event onto the UST tracer for a UST session.
2006 * Should be called with session mutex held.
2009 int create_ust_event(struct ust_app
*app
,
2010 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
2014 health_code_update();
2016 /* Create UST event on tracer */
2017 pthread_mutex_lock(&app
->sock_lock
);
2018 ret
= lttng_ust_ctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
2020 pthread_mutex_unlock(&app
->sock_lock
);
2022 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2024 DBG3("UST app create event failed. Application is dead: pid = %d, sock = %d",
2025 app
->pid
, app
->sock
);
2026 } else if (ret
== -EAGAIN
) {
2028 WARN("UST app create event failed. Communication time out: pid = %d, sock = %d",
2029 app
->pid
, app
->sock
);
2031 ERR("UST app create event '%s' failed with ret %d: pid = %d, sock = %d",
2032 ua_event
->attr
.name
, ret
, app
->pid
,
2038 ua_event
->handle
= ua_event
->obj
->handle
;
2040 DBG2("UST app event %s created successfully for pid:%d object = %p",
2041 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
2043 health_code_update();
2045 /* Set filter if one is present. */
2046 if (ua_event
->filter
) {
2047 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
2053 /* Set exclusions for the event */
2054 if (ua_event
->exclusion
) {
2055 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
2061 /* If event not enabled, disable it on the tracer */
2062 if (ua_event
->enabled
) {
2064 * We now need to explicitly enable the event, since it
2065 * is now disabled at creation.
2067 ret
= enable_ust_object(app
, ua_event
->obj
);
2070 * If we hit an EPERM, something is wrong with our enable call. If
2071 * we get an EEXIST, there is a problem on the tracer side since we
2075 case -LTTNG_UST_ERR_PERM
:
2076 /* Code flow problem */
2078 case -LTTNG_UST_ERR_EXIST
:
2079 /* It's OK for our use case. */
2090 health_code_update();
2094 static int init_ust_event_notifier_from_event_rule(
2095 const struct lttng_event_rule
*rule
,
2096 struct lttng_ust_abi_event_notifier
*event_notifier
)
2098 enum lttng_event_rule_status status
;
2099 enum lttng_ust_abi_loglevel_type ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2100 int loglevel
= -1, ret
= 0;
2101 const char *pattern
;
2104 memset(event_notifier
, 0, sizeof(*event_notifier
));
2106 if (lttng_event_rule_targets_agent_domain(rule
)) {
2108 * Special event for agents
2109 * The actual meat of the event is in the filter that will be
2110 * attached later on.
2111 * Set the default values for the agent event.
2113 pattern
= event_get_default_agent_ust_name(
2114 lttng_event_rule_get_domain_type(rule
));
2116 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2118 const struct lttng_log_level_rule
*log_level_rule
;
2120 LTTNG_ASSERT(lttng_event_rule_get_type(rule
) ==
2121 LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
);
2123 status
= lttng_event_rule_user_tracepoint_get_name_pattern(rule
, &pattern
);
2124 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2125 /* At this point, this is a fatal error. */
2129 status
= lttng_event_rule_user_tracepoint_get_log_level_rule(
2130 rule
, &log_level_rule
);
2131 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
2132 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2133 } else if (status
== LTTNG_EVENT_RULE_STATUS_OK
) {
2134 enum lttng_log_level_rule_status llr_status
;
2136 switch (lttng_log_level_rule_get_type(log_level_rule
)) {
2137 case LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY
:
2138 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_SINGLE
;
2139 llr_status
= lttng_log_level_rule_exactly_get_level(
2140 log_level_rule
, &loglevel
);
2142 case LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS
:
2143 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_RANGE
;
2144 llr_status
= lttng_log_level_rule_at_least_as_severe_as_get_level(
2145 log_level_rule
, &loglevel
);
2151 LTTNG_ASSERT(llr_status
== LTTNG_LOG_LEVEL_RULE_STATUS_OK
);
2153 /* At this point this is a fatal error. */
2158 event_notifier
->event
.instrumentation
= LTTNG_UST_ABI_TRACEPOINT
;
2159 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
2160 sizeof(event_notifier
->event
.name
));
2162 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
2167 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
2168 event_notifier
->event
.loglevel
= loglevel
;
2174 * Create the specified event notifier against the user space tracer of a
2175 * given application.
2177 static int create_ust_event_notifier(struct ust_app
*app
,
2178 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2181 enum lttng_condition_status condition_status
;
2182 const struct lttng_condition
*condition
= NULL
;
2183 struct lttng_ust_abi_event_notifier event_notifier
;
2184 const struct lttng_event_rule
*event_rule
= NULL
;
2185 unsigned int capture_bytecode_count
= 0, i
;
2186 enum lttng_condition_status cond_status
;
2187 enum lttng_event_rule_type event_rule_type
;
2189 health_code_update();
2190 LTTNG_ASSERT(app
->event_notifier_group
.object
);
2192 condition
= lttng_trigger_get_const_condition(
2193 ua_event_notifier_rule
->trigger
);
2194 LTTNG_ASSERT(condition
);
2195 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
2196 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
2198 condition_status
= lttng_condition_event_rule_matches_get_rule(
2199 condition
, &event_rule
);
2200 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2202 LTTNG_ASSERT(event_rule
);
2204 event_rule_type
= lttng_event_rule_get_type(event_rule
);
2205 LTTNG_ASSERT(event_rule_type
== LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
||
2206 event_rule_type
== LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
||
2208 LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
||
2210 LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
);
2212 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2213 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2214 event_notifier
.error_counter_index
= ua_event_notifier_rule
->error_counter_index
;
2216 /* Create UST event notifier against the tracer. */
2217 pthread_mutex_lock(&app
->sock_lock
);
2218 ret
= lttng_ust_ctl_create_event_notifier(app
->sock
, &event_notifier
,
2219 app
->event_notifier_group
.object
,
2220 &ua_event_notifier_rule
->obj
);
2221 pthread_mutex_unlock(&app
->sock_lock
);
2223 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2225 DBG3("UST app create event notifier failed. Application is dead: pid = %d, sock = %d",
2226 app
->pid
, app
->sock
);
2227 } else if (ret
== -EAGAIN
) {
2229 WARN("UST app create event notifier failed. Communication time out: pid = %d, sock = %d",
2230 app
->pid
, app
->sock
);
2232 ERR("UST app create event notifier '%s' failed with ret %d: pid = %d, sock = %d",
2233 event_notifier
.event
.name
, ret
, app
->pid
,
2239 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2241 DBG2("UST app event notifier %s created successfully: app = '%s': pid = %d, object = %p",
2242 event_notifier
.event
.name
, app
->name
, app
->pid
,
2243 ua_event_notifier_rule
->obj
);
2245 health_code_update();
2247 /* Set filter if one is present. */
2248 if (ua_event_notifier_rule
->filter
) {
2249 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2250 ua_event_notifier_rule
->obj
);
2256 /* Set exclusions for the event. */
2257 if (ua_event_notifier_rule
->exclusion
) {
2258 ret
= set_ust_object_exclusions(app
,
2259 ua_event_notifier_rule
->exclusion
,
2260 ua_event_notifier_rule
->obj
);
2266 /* Set the capture bytecodes. */
2267 cond_status
= lttng_condition_event_rule_matches_get_capture_descriptor_count(
2268 condition
, &capture_bytecode_count
);
2269 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
2271 for (i
= 0; i
< capture_bytecode_count
; i
++) {
2272 const struct lttng_bytecode
*capture_bytecode
=
2273 lttng_condition_event_rule_matches_get_capture_bytecode_at_index(
2276 ret
= set_ust_capture(app
, capture_bytecode
, i
,
2277 ua_event_notifier_rule
->obj
);
2284 * We now need to explicitly enable the event, since it
2285 * is disabled at creation.
2287 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2290 * If we hit an EPERM, something is wrong with our enable call.
2291 * If we get an EEXIST, there is a problem on the tracer side
2292 * since we just created it.
2295 case -LTTNG_UST_ERR_PERM
:
2296 /* Code flow problem. */
2298 case -LTTNG_UST_ERR_EXIST
:
2299 /* It's OK for our use case. */
2309 ua_event_notifier_rule
->enabled
= true;
2312 health_code_update();
2317 * Copy data between an UST app event and a LTT event.
2319 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2320 struct ltt_ust_event
*uevent
)
2322 size_t exclusion_alloc_size
;
2324 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2325 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2327 ua_event
->enabled
= uevent
->enabled
;
2329 /* Copy event attributes */
2330 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2332 /* Copy filter bytecode */
2333 if (uevent
->filter
) {
2334 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2335 /* Filter might be NULL here in case of ENONEM. */
2338 /* Copy exclusion data */
2339 if (uevent
->exclusion
) {
2340 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2341 LTTNG_UST_ABI_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2342 ua_event
->exclusion
= zmalloc
<lttng_event_exclusion
>(exclusion_alloc_size
);
2343 if (ua_event
->exclusion
== NULL
) {
2346 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2347 exclusion_alloc_size
);
2353 * Copy data between an UST app channel and a LTT channel.
2355 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2356 struct ltt_ust_channel
*uchan
)
2358 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2360 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2361 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2363 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2364 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2366 /* Copy event attributes since the layout is different. */
2367 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2368 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2369 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2370 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2371 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2372 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2373 ua_chan
->attr
.output
= (lttng_ust_abi_output
) uchan
->attr
.output
;
2374 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2377 * Note that the attribute channel type is not set since the channel on the
2378 * tracing registry side does not have this information.
2381 ua_chan
->enabled
= uchan
->enabled
;
2382 ua_chan
->tracing_channel_id
= uchan
->id
;
2384 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2388 * Copy data between a UST app session and a regular LTT session.
2390 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2391 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2393 struct tm
*timeinfo
;
2396 char tmp_shm_path
[PATH_MAX
];
2398 timeinfo
= localtime(&app
->registration_time
);
2399 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2401 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2403 ua_sess
->tracing_id
= usess
->id
;
2404 ua_sess
->id
= get_next_session_id();
2405 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2406 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2407 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2408 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2409 ua_sess
->buffer_type
= usess
->buffer_type
;
2410 ua_sess
->bits_per_long
= app
->abi
.bits_per_long
;
2412 /* There is only one consumer object per session possible. */
2413 consumer_output_get(usess
->consumer
);
2414 ua_sess
->consumer
= usess
->consumer
;
2416 ua_sess
->output_traces
= usess
->output_traces
;
2417 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2418 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2419 &usess
->metadata_attr
);
2421 switch (ua_sess
->buffer_type
) {
2422 case LTTNG_BUFFER_PER_PID
:
2423 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2424 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2427 case LTTNG_BUFFER_PER_UID
:
2428 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2429 DEFAULT_UST_TRACE_UID_PATH
,
2430 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2431 app
->abi
.bits_per_long
);
2438 PERROR("asprintf UST shadow copy session");
2443 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2444 sizeof(ua_sess
->root_shm_path
));
2445 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2446 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2447 sizeof(ua_sess
->shm_path
));
2448 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2449 if (ua_sess
->shm_path
[0]) {
2450 switch (ua_sess
->buffer_type
) {
2451 case LTTNG_BUFFER_PER_PID
:
2452 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2453 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2454 app
->name
, app
->pid
, datetime
);
2456 case LTTNG_BUFFER_PER_UID
:
2457 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2458 "/" DEFAULT_UST_TRACE_UID_PATH
,
2459 app
->uid
, app
->abi
.bits_per_long
);
2466 PERROR("sprintf UST shadow copy session");
2470 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2471 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2472 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2477 consumer_output_put(ua_sess
->consumer
);
2481 * Lookup sesison wrapper.
2484 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2485 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2487 /* Get right UST app session from app */
2488 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2492 * Return ust app session from the app session hashtable using the UST session
2495 static struct ust_app_session
*lookup_session_by_app(
2496 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2498 struct lttng_ht_iter iter
;
2499 struct lttng_ht_node_u64
*node
;
2501 __lookup_session_by_app(usess
, app
, &iter
);
2502 node
= lttng_ht_iter_get_node_u64(&iter
);
2507 return lttng::utils::container_of(node
, &ust_app_session::node
);
2514 * Setup buffer registry per PID for the given session and application. If none
2515 * is found, a new one is created, added to the global registry and
2516 * initialized. If regp is valid, it's set with the newly created object.
2518 * Return 0 on success or else a negative value.
2520 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2521 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2524 struct buffer_reg_pid
*reg_pid
;
2526 LTTNG_ASSERT(ua_sess
);
2531 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2534 * This is the create channel path meaning that if there is NO
2535 * registry available, we have to create one for this session.
2537 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2538 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2546 /* Initialize registry. */
2547 reg_pid
->registry
->reg
.ust
= ust_registry_session_per_pid_create(app
, app
->abi
,
2548 app
->version
.major
, app
->version
.minor
, reg_pid
->root_shm_path
,
2550 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2551 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2552 ua_sess
->tracing_id
);
2553 if (!reg_pid
->registry
->reg
.ust
) {
2555 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2556 * destroy the buffer registry, because it is always expected
2557 * that if the buffer registry can be found, its ust registry is
2560 buffer_reg_pid_destroy(reg_pid
);
2564 buffer_reg_pid_add(reg_pid
);
2566 DBG3("UST app buffer registry per PID created successfully");
2578 * Setup buffer registry per UID for the given session and application. If none
2579 * is found, a new one is created, added to the global registry and
2580 * initialized. If regp is valid, it's set with the newly created object.
2582 * Return 0 on success or else a negative value.
2584 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2585 struct ust_app_session
*ua_sess
,
2586 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2589 struct buffer_reg_uid
*reg_uid
;
2591 LTTNG_ASSERT(usess
);
2596 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->abi
.bits_per_long
, app
->uid
);
2599 * This is the create channel path meaning that if there is NO
2600 * registry available, we have to create one for this session.
2602 ret
= buffer_reg_uid_create(usess
->id
, app
->abi
.bits_per_long
, app
->uid
,
2603 LTTNG_DOMAIN_UST
, ®_uid
, ua_sess
->root_shm_path
,
2612 /* Initialize registry. */
2613 reg_uid
->registry
->reg
.ust
= ust_registry_session_per_uid_create(app
->abi
,
2614 app
->version
.major
, app
->version
.minor
, reg_uid
->root_shm_path
,
2615 reg_uid
->shm_path
, usess
->uid
, usess
->gid
, ua_sess
->tracing_id
, app
->uid
);
2616 if (!reg_uid
->registry
->reg
.ust
) {
2618 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2619 * destroy the buffer registry, because it is always expected
2620 * that if the buffer registry can be found, its ust registry is
2623 buffer_reg_uid_destroy(reg_uid
, NULL
);
2627 /* Add node to teardown list of the session. */
2628 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2630 buffer_reg_uid_add(reg_uid
);
2632 DBG3("UST app buffer registry per UID created successfully");
2643 * Create a session on the tracer side for the given app.
2645 * On success, ua_sess_ptr is populated with the session pointer or else left
2646 * untouched. If the session was created, is_created is set to 1. On error,
2647 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2650 * Returns 0 on success or else a negative code which is either -ENOMEM or
2651 * -ENOTCONN which is the default code if the lttng_ust_ctl_create_session fails.
2653 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2654 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2657 int ret
, created
= 0;
2658 struct ust_app_session
*ua_sess
;
2660 LTTNG_ASSERT(usess
);
2662 LTTNG_ASSERT(ua_sess_ptr
);
2664 health_code_update();
2666 ua_sess
= lookup_session_by_app(usess
, app
);
2667 if (ua_sess
== NULL
) {
2668 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2669 app
->pid
, usess
->id
);
2670 ua_sess
= alloc_ust_app_session();
2671 if (ua_sess
== NULL
) {
2672 /* Only malloc can failed so something is really wrong */
2676 shadow_copy_session(ua_sess
, usess
, app
);
2680 switch (usess
->buffer_type
) {
2681 case LTTNG_BUFFER_PER_PID
:
2682 /* Init local registry. */
2683 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2685 delete_ust_app_session(-1, ua_sess
, app
);
2689 case LTTNG_BUFFER_PER_UID
:
2690 /* Look for a global registry. If none exists, create one. */
2691 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2693 delete_ust_app_session(-1, ua_sess
, app
);
2703 health_code_update();
2705 if (ua_sess
->handle
== -1) {
2706 pthread_mutex_lock(&app
->sock_lock
);
2707 ret
= lttng_ust_ctl_create_session(app
->sock
);
2708 pthread_mutex_unlock(&app
->sock_lock
);
2710 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2711 DBG("UST app creating session failed. Application is dead: pid = %d, sock = %d",
2712 app
->pid
, app
->sock
);
2714 } else if (ret
== -EAGAIN
) {
2715 DBG("UST app creating session failed. Communication time out: pid = %d, sock = %d",
2716 app
->pid
, app
->sock
);
2719 ERR("UST app creating session failed with ret %d: pid = %d, sock =%d",
2720 ret
, app
->pid
, app
->sock
);
2722 delete_ust_app_session(-1, ua_sess
, app
);
2723 if (ret
!= -ENOMEM
) {
2725 * Tracer is probably gone or got an internal error so let's
2726 * behave like it will soon unregister or not usable.
2733 ua_sess
->handle
= ret
;
2735 /* Add ust app session to app's HT */
2736 lttng_ht_node_init_u64(&ua_sess
->node
,
2737 ua_sess
->tracing_id
);
2738 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2739 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2740 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2741 &ua_sess
->ust_objd_node
);
2743 DBG2("UST app session created successfully with handle %d", ret
);
2746 *ua_sess_ptr
= ua_sess
;
2748 *is_created
= created
;
2751 /* Everything went well. */
2755 health_code_update();
2760 * Match function for a hash table lookup of ust_app_ctx.
2762 * It matches an ust app context based on the context type and, in the case
2763 * of perf counters, their name.
2765 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2767 struct ust_app_ctx
*ctx
;
2768 const struct lttng_ust_context_attr
*key
;
2773 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2774 key
= (lttng_ust_context_attr
*) _key
;
2777 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2782 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
2783 if (strncmp(key
->u
.perf_counter
.name
,
2784 ctx
->ctx
.u
.perf_counter
.name
,
2785 sizeof(key
->u
.perf_counter
.name
))) {
2789 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
2790 if (strcmp(key
->u
.app_ctx
.provider_name
,
2791 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2792 strcmp(key
->u
.app_ctx
.ctx_name
,
2793 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2809 * Lookup for an ust app context from an lttng_ust_context.
2811 * Must be called while holding RCU read side lock.
2812 * Return an ust_app_ctx object or NULL on error.
2815 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2816 struct lttng_ust_context_attr
*uctx
)
2818 struct lttng_ht_iter iter
;
2819 struct lttng_ht_node_ulong
*node
;
2820 struct ust_app_ctx
*app_ctx
= NULL
;
2824 ASSERT_RCU_READ_LOCKED();
2826 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2827 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2828 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2829 node
= lttng_ht_iter_get_node_ulong(&iter
);
2834 app_ctx
= lttng::utils::container_of(node
, &ust_app_ctx::node
);
2841 * Create a context for the channel on the tracer.
2843 * Called with UST app session lock held and a RCU read side lock.
2846 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2847 struct lttng_ust_context_attr
*uctx
,
2848 struct ust_app
*app
)
2851 struct ust_app_ctx
*ua_ctx
;
2853 ASSERT_RCU_READ_LOCKED();
2855 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2857 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2863 ua_ctx
= alloc_ust_app_ctx(uctx
);
2864 if (ua_ctx
== NULL
) {
2870 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2871 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2872 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2874 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2884 * Enable on the tracer side a ust app event for the session and channel.
2886 * Called with UST app session lock held.
2889 int enable_ust_app_event(struct ust_app_event
*ua_event
,
2890 struct ust_app
*app
)
2894 ret
= enable_ust_object(app
, ua_event
->obj
);
2899 ua_event
->enabled
= 1;
2906 * Disable on the tracer side a ust app event for the session and channel.
2908 static int disable_ust_app_event(struct ust_app_event
*ua_event
,
2909 struct ust_app
*app
)
2913 ret
= disable_ust_object(app
, ua_event
->obj
);
2918 ua_event
->enabled
= 0;
2925 * Lookup ust app channel for session and disable it on the tracer side.
2928 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2929 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2933 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2938 ua_chan
->enabled
= 0;
2945 * Lookup ust app channel for session and enable it on the tracer side. This
2946 * MUST be called with a RCU read side lock acquired.
2948 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2949 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2952 struct lttng_ht_iter iter
;
2953 struct lttng_ht_node_str
*ua_chan_node
;
2954 struct ust_app_channel
*ua_chan
;
2956 ASSERT_RCU_READ_LOCKED();
2958 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2959 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2960 if (ua_chan_node
== NULL
) {
2961 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2962 uchan
->name
, ua_sess
->tracing_id
);
2966 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
2968 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2978 * Ask the consumer to create a channel and get it if successful.
2980 * Called with UST app session lock held.
2982 * Return 0 on success or else a negative value.
2984 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2985 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2986 int bitness
, lsu::registry_session
*registry
)
2989 unsigned int nb_fd
= 0;
2990 struct consumer_socket
*socket
;
2992 LTTNG_ASSERT(usess
);
2993 LTTNG_ASSERT(ua_sess
);
2994 LTTNG_ASSERT(ua_chan
);
2995 LTTNG_ASSERT(registry
);
2998 health_code_update();
3000 /* Get the right consumer socket for the application. */
3001 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
3007 health_code_update();
3009 /* Need one fd for the channel. */
3010 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3012 ERR("Exhausted number of available FD upon create channel");
3017 * Ask consumer to create channel. The consumer will return the number of
3018 * stream we have to expect.
3020 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
3021 registry
, usess
->current_trace_chunk
);
3027 * Compute the number of fd needed before receiving them. It must be 2 per
3028 * stream (2 being the default value here).
3030 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
3032 /* Reserve the amount of file descriptor we need. */
3033 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
3035 ERR("Exhausted number of available FD upon create channel");
3036 goto error_fd_get_stream
;
3039 health_code_update();
3042 * Now get the channel from the consumer. This call will populate the stream
3043 * list of that channel and set the ust objects.
3045 if (usess
->consumer
->enabled
) {
3046 ret
= ust_consumer_get_channel(socket
, ua_chan
);
3056 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
3057 error_fd_get_stream
:
3059 * Initiate a destroy channel on the consumer since we had an error
3060 * handling it on our side. The return value is of no importance since we
3061 * already have a ret value set by the previous error that we need to
3064 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
3066 lttng_fd_put(LTTNG_FD_APPS
, 1);
3068 health_code_update();
3074 * Duplicate the ust data object of the ust app stream and save it in the
3075 * buffer registry stream.
3077 * Return 0 on success or else a negative value.
3079 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
3080 struct ust_app_stream
*stream
)
3084 LTTNG_ASSERT(reg_stream
);
3085 LTTNG_ASSERT(stream
);
3087 /* Duplicating a stream requires 2 new fds. Reserve them. */
3088 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3090 ERR("Exhausted number of available FD upon duplicate stream");
3094 /* Duplicate object for stream once the original is in the registry. */
3095 ret
= lttng_ust_ctl_duplicate_ust_object_data(&stream
->obj
,
3096 reg_stream
->obj
.ust
);
3098 ERR("Duplicate stream obj from %p to %p failed with ret %d",
3099 reg_stream
->obj
.ust
, stream
->obj
, ret
);
3100 lttng_fd_put(LTTNG_FD_APPS
, 2);
3103 stream
->handle
= stream
->obj
->handle
;
3110 * Duplicate the ust data object of the ust app. channel and save it in the
3111 * buffer registry channel.
3113 * Return 0 on success or else a negative value.
3115 static int duplicate_channel_object(struct buffer_reg_channel
*buf_reg_chan
,
3116 struct ust_app_channel
*ua_chan
)
3120 LTTNG_ASSERT(buf_reg_chan
);
3121 LTTNG_ASSERT(ua_chan
);
3123 /* Duplicating a channel requires 1 new fd. Reserve it. */
3124 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3126 ERR("Exhausted number of available FD upon duplicate channel");
3130 /* Duplicate object for stream once the original is in the registry. */
3131 ret
= lttng_ust_ctl_duplicate_ust_object_data(&ua_chan
->obj
, buf_reg_chan
->obj
.ust
);
3133 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
3134 buf_reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
3137 ua_chan
->handle
= ua_chan
->obj
->handle
;
3142 lttng_fd_put(LTTNG_FD_APPS
, 1);
3148 * For a given channel buffer registry, setup all streams of the given ust
3149 * application channel.
3151 * Return 0 on success or else a negative value.
3153 static int setup_buffer_reg_streams(struct buffer_reg_channel
*buf_reg_chan
,
3154 struct ust_app_channel
*ua_chan
,
3155 struct ust_app
*app
)
3158 struct ust_app_stream
*stream
, *stmp
;
3160 LTTNG_ASSERT(buf_reg_chan
);
3161 LTTNG_ASSERT(ua_chan
);
3163 DBG2("UST app setup buffer registry stream");
3165 /* Send all streams to application. */
3166 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
3167 struct buffer_reg_stream
*reg_stream
;
3169 ret
= buffer_reg_stream_create(®_stream
);
3175 * Keep original pointer and nullify it in the stream so the delete
3176 * stream call does not release the object.
3178 reg_stream
->obj
.ust
= stream
->obj
;
3180 buffer_reg_stream_add(reg_stream
, buf_reg_chan
);
3182 /* We don't need the streams anymore. */
3183 cds_list_del(&stream
->list
);
3184 delete_ust_app_stream(-1, stream
, app
);
3192 * Create a buffer registry channel for the given session registry and
3193 * application channel object. If regp pointer is valid, it's set with the
3194 * created object. Important, the created object is NOT added to the session
3195 * registry hash table.
3197 * Return 0 on success else a negative value.
3199 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3200 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
3203 struct buffer_reg_channel
*buf_reg_chan
= NULL
;
3205 LTTNG_ASSERT(reg_sess
);
3206 LTTNG_ASSERT(ua_chan
);
3208 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3210 /* Create buffer registry channel. */
3211 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, &buf_reg_chan
);
3215 LTTNG_ASSERT(buf_reg_chan
);
3216 buf_reg_chan
->consumer_key
= ua_chan
->key
;
3217 buf_reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3218 buf_reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3220 /* Create and add a channel registry to session. */
3222 reg_sess
->reg
.ust
->add_channel(ua_chan
->tracing_channel_id
);
3223 } catch (const std::exception
& ex
) {
3224 ERR("Failed to add a channel registry to userspace registry session: %s", ex
.what());
3229 buffer_reg_channel_add(reg_sess
, buf_reg_chan
);
3232 *regp
= buf_reg_chan
;
3238 /* Safe because the registry channel object was not added to any HT. */
3239 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3245 * Setup buffer registry channel for the given session registry and application
3246 * channel object. If regp pointer is valid, it's set with the created object.
3248 * Return 0 on success else a negative value.
3250 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3251 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*buf_reg_chan
,
3252 struct ust_app
*app
)
3256 LTTNG_ASSERT(reg_sess
);
3257 LTTNG_ASSERT(buf_reg_chan
);
3258 LTTNG_ASSERT(ua_chan
);
3259 LTTNG_ASSERT(ua_chan
->obj
);
3261 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3263 /* Setup all streams for the registry. */
3264 ret
= setup_buffer_reg_streams(buf_reg_chan
, ua_chan
, app
);
3269 buf_reg_chan
->obj
.ust
= ua_chan
->obj
;
3270 ua_chan
->obj
= NULL
;
3275 buffer_reg_channel_remove(reg_sess
, buf_reg_chan
);
3276 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3281 * Send buffer registry channel to the application.
3283 * Return 0 on success else a negative value.
3285 static int send_channel_uid_to_ust(struct buffer_reg_channel
*buf_reg_chan
,
3286 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3287 struct ust_app_channel
*ua_chan
)
3290 struct buffer_reg_stream
*reg_stream
;
3292 LTTNG_ASSERT(buf_reg_chan
);
3294 LTTNG_ASSERT(ua_sess
);
3295 LTTNG_ASSERT(ua_chan
);
3297 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3299 ret
= duplicate_channel_object(buf_reg_chan
, ua_chan
);
3304 /* Send channel to the application. */
3305 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3306 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3307 ret
= -ENOTCONN
; /* Caused by app exiting. */
3309 } else if (ret
== -EAGAIN
) {
3310 /* Caused by timeout. */
3311 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
"\".",
3312 app
->pid
, ua_chan
->name
, ua_sess
->tracing_id
);
3313 /* Treat this the same way as an application that is exiting. */
3316 } else if (ret
< 0) {
3320 health_code_update();
3322 /* Send all streams to application. */
3323 pthread_mutex_lock(&buf_reg_chan
->stream_list_lock
);
3324 cds_list_for_each_entry(reg_stream
, &buf_reg_chan
->streams
, lnode
) {
3325 struct ust_app_stream stream
= {};
3327 ret
= duplicate_stream_object(reg_stream
, &stream
);
3329 goto error_stream_unlock
;
3332 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3334 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3335 ret
= -ENOTCONN
; /* Caused by app exiting. */
3336 } else if (ret
== -EAGAIN
) {
3338 * Caused by timeout.
3339 * Treat this the same way as an application
3342 WARN("Communication with application %d timed out on send_stream for stream of channel \"%s\" of session \"%" PRIu64
"\".",
3345 ua_sess
->tracing_id
);
3348 (void) release_ust_app_stream(-1, &stream
, app
);
3349 goto error_stream_unlock
;
3353 * The return value is not important here. This function will output an
3356 (void) release_ust_app_stream(-1, &stream
, app
);
3359 error_stream_unlock
:
3360 pthread_mutex_unlock(&buf_reg_chan
->stream_list_lock
);
3366 * Create and send to the application the created buffers with per UID buffers.
3368 * This MUST be called with a RCU read side lock acquired.
3369 * The session list lock and the session's lock must be acquired.
3371 * Return 0 on success else a negative value.
3373 static int create_channel_per_uid(struct ust_app
*app
,
3374 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3375 struct ust_app_channel
*ua_chan
)
3378 struct buffer_reg_uid
*reg_uid
;
3379 struct buffer_reg_channel
*buf_reg_chan
;
3380 struct ltt_session
*session
= NULL
;
3381 enum lttng_error_code notification_ret
;
3384 LTTNG_ASSERT(usess
);
3385 LTTNG_ASSERT(ua_sess
);
3386 LTTNG_ASSERT(ua_chan
);
3387 ASSERT_RCU_READ_LOCKED();
3389 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3391 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->abi
.bits_per_long
, app
->uid
);
3393 * The session creation handles the creation of this global registry
3394 * object. If none can be find, there is a code flow problem or a
3397 LTTNG_ASSERT(reg_uid
);
3399 buf_reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3405 /* Create the buffer registry channel object. */
3406 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, &buf_reg_chan
);
3408 ERR("Error creating the UST channel \"%s\" registry instance",
3413 session
= session_find_by_id(ua_sess
->tracing_id
);
3414 LTTNG_ASSERT(session
);
3415 ASSERT_LOCKED(session
->lock
);
3416 ASSERT_SESSION_LIST_LOCKED();
3419 * Create the buffers on the consumer side. This call populates the
3420 * ust app channel object with all streams and data object.
3422 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3423 app
->abi
.bits_per_long
, reg_uid
->registry
->reg
.ust
);
3425 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3429 * Let's remove the previously created buffer registry channel so
3430 * it's not visible anymore in the session registry.
3432 auto locked_registry
= reg_uid
->registry
->reg
.ust
->lock();
3434 locked_registry
->remove_channel(ua_chan
->tracing_channel_id
, false);
3435 } catch (const std::exception
&ex
) {
3436 DBG("Could not find channel for removal: %s", ex
.what());
3438 buffer_reg_channel_remove(reg_uid
->registry
, buf_reg_chan
);
3439 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3444 * Setup the streams and add it to the session registry.
3446 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3447 ua_chan
, buf_reg_chan
, app
);
3449 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3454 auto locked_registry
= reg_uid
->registry
->reg
.ust
->lock();
3455 auto& ust_reg_chan
= locked_registry
->get_channel(ua_chan
->tracing_channel_id
);
3457 ust_reg_chan
._consumer_key
= ua_chan
->key
;
3460 /* Notify the notification subsystem of the channel's creation. */
3461 notification_ret
= notification_thread_command_add_channel(
3462 the_notification_thread_handle
, session
->id
,
3463 ua_chan
->name
, ua_chan
->key
, LTTNG_DOMAIN_UST
,
3464 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3465 if (notification_ret
!= LTTNG_OK
) {
3466 ret
= - (int) notification_ret
;
3467 ERR("Failed to add channel to notification thread");
3472 /* Send buffers to the application. */
3473 ret
= send_channel_uid_to_ust(buf_reg_chan
, app
, ua_sess
, ua_chan
);
3475 if (ret
!= -ENOTCONN
) {
3476 ERR("Error sending channel to application");
3483 session_put(session
);
3489 * Create and send to the application the created buffers with per PID buffers.
3491 * Called with UST app session lock held.
3492 * The session list lock and the session's lock must be acquired.
3494 * Return 0 on success else a negative value.
3496 static int create_channel_per_pid(struct ust_app
*app
,
3497 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3498 struct ust_app_channel
*ua_chan
)
3501 lsu::registry_session
*registry
;
3502 enum lttng_error_code cmd_ret
;
3503 struct ltt_session
*session
= NULL
;
3504 uint64_t chan_reg_key
;
3507 LTTNG_ASSERT(usess
);
3508 LTTNG_ASSERT(ua_sess
);
3509 LTTNG_ASSERT(ua_chan
);
3511 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3515 registry
= get_session_registry(ua_sess
);
3516 /* The UST app session lock is held, registry shall not be null. */
3517 LTTNG_ASSERT(registry
);
3519 /* Create and add a new channel registry to session. */
3521 registry
->add_channel(ua_chan
->key
);
3522 } catch (const std::exception
& ex
) {
3523 ERR("Error creating the UST channel \"%s\" registry instance: %s", ua_chan
->name
,
3529 session
= session_find_by_id(ua_sess
->tracing_id
);
3530 LTTNG_ASSERT(session
);
3531 ASSERT_LOCKED(session
->lock
);
3532 ASSERT_SESSION_LIST_LOCKED();
3534 /* Create and get channel on the consumer side. */
3535 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3536 app
->abi
.bits_per_long
, registry
);
3538 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3540 goto error_remove_from_registry
;
3543 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3545 if (ret
!= -ENOTCONN
) {
3546 ERR("Error sending channel to application");
3548 goto error_remove_from_registry
;
3551 chan_reg_key
= ua_chan
->key
;
3553 auto locked_registry
= registry
->lock();
3555 auto& ust_reg_chan
= locked_registry
->get_channel(chan_reg_key
);
3556 ust_reg_chan
._consumer_key
= ua_chan
->key
;
3559 cmd_ret
= notification_thread_command_add_channel(
3560 the_notification_thread_handle
, session
->id
,
3561 ua_chan
->name
, ua_chan
->key
, LTTNG_DOMAIN_UST
,
3562 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3563 if (cmd_ret
!= LTTNG_OK
) {
3564 ret
= - (int) cmd_ret
;
3565 ERR("Failed to add channel to notification thread");
3566 goto error_remove_from_registry
;
3569 error_remove_from_registry
:
3572 auto locked_registry
= registry
->lock();
3573 locked_registry
->remove_channel(ua_chan
->key
, false);
3574 } catch (const std::exception
& ex
) {
3575 DBG("Could not find channel for removal: %s", ex
.what());
3581 session_put(session
);
3587 * From an already allocated ust app channel, create the channel buffers if
3588 * needed and send them to the application. This MUST be called with a RCU read
3589 * side lock acquired.
3591 * Called with UST app session lock held.
3593 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3594 * the application exited concurrently.
3596 static int ust_app_channel_send(struct ust_app
*app
,
3597 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3598 struct ust_app_channel
*ua_chan
)
3603 LTTNG_ASSERT(usess
);
3604 LTTNG_ASSERT(usess
->active
);
3605 LTTNG_ASSERT(ua_sess
);
3606 LTTNG_ASSERT(ua_chan
);
3607 ASSERT_RCU_READ_LOCKED();
3609 /* Handle buffer type before sending the channel to the application. */
3610 switch (usess
->buffer_type
) {
3611 case LTTNG_BUFFER_PER_UID
:
3613 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3619 case LTTNG_BUFFER_PER_PID
:
3621 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3633 /* Initialize ust objd object using the received handle and add it. */
3634 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3635 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3637 /* If channel is not enabled, disable it on the tracer */
3638 if (!ua_chan
->enabled
) {
3639 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3650 * Create UST app channel and return it through ua_chanp if not NULL.
3652 * Called with UST app session lock and RCU read-side lock held.
3654 * Return 0 on success or else a negative value.
3656 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3657 struct ltt_ust_channel
*uchan
,
3658 enum lttng_ust_abi_chan_type type
,
3659 struct ltt_ust_session
*usess
__attribute__((unused
)),
3660 struct ust_app_channel
**ua_chanp
)
3663 struct lttng_ht_iter iter
;
3664 struct lttng_ht_node_str
*ua_chan_node
;
3665 struct ust_app_channel
*ua_chan
;
3667 ASSERT_RCU_READ_LOCKED();
3669 /* Lookup channel in the ust app session */
3670 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3671 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3672 if (ua_chan_node
!= NULL
) {
3673 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
3677 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3678 if (ua_chan
== NULL
) {
3679 /* Only malloc can fail here */
3683 shadow_copy_channel(ua_chan
, uchan
);
3685 /* Set channel type. */
3686 ua_chan
->attr
.type
= type
;
3688 /* Only add the channel if successful on the tracer side. */
3689 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3692 *ua_chanp
= ua_chan
;
3695 /* Everything went well. */
3703 * Create UST app event and create it on the tracer side.
3705 * Must be called with the RCU read side lock held.
3706 * Called with ust app session mutex held.
3709 int create_ust_app_event(struct ust_app_channel
*ua_chan
,
3710 struct ltt_ust_event
*uevent
,
3711 struct ust_app
*app
)
3714 struct ust_app_event
*ua_event
;
3716 ASSERT_RCU_READ_LOCKED();
3718 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3719 if (ua_event
== NULL
) {
3720 /* Only failure mode of alloc_ust_app_event(). */
3724 shadow_copy_event(ua_event
, uevent
);
3726 /* Create it on the tracer side */
3727 ret
= create_ust_event(app
, ua_chan
, ua_event
);
3730 * Not found previously means that it does not exist on the
3731 * tracer. If the application reports that the event existed,
3732 * it means there is a bug in the sessiond or lttng-ust
3733 * (or corruption, etc.)
3735 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3736 ERR("Tracer for application reported that an event being created already existed: "
3737 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3739 app
->pid
, app
->ppid
, app
->uid
,
3745 add_unique_ust_app_event(ua_chan
, ua_event
);
3747 DBG2("UST app create event completed: app = '%s' pid = %d",
3748 app
->name
, app
->pid
);
3754 /* Valid. Calling here is already in a read side lock */
3755 delete_ust_app_event(-1, ua_event
, app
);
3760 * Create UST app event notifier rule and create it on the tracer side.
3762 * Must be called with the RCU read side lock held.
3763 * Called with ust app session mutex held.
3766 int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
,
3767 struct ust_app
*app
)
3770 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3772 ASSERT_RCU_READ_LOCKED();
3774 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3775 if (ua_event_notifier_rule
== NULL
) {
3780 /* Create it on the tracer side. */
3781 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3784 * Not found previously means that it does not exist on the
3785 * tracer. If the application reports that the event existed,
3786 * it means there is a bug in the sessiond or lttng-ust
3787 * (or corruption, etc.)
3789 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3790 ERR("Tracer for application reported that an event notifier being created already exists: "
3791 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3792 lttng_trigger_get_tracer_token(trigger
),
3793 app
->pid
, app
->ppid
, app
->uid
,
3799 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3800 &ua_event_notifier_rule
->node
);
3802 DBG2("UST app create token event rule completed: app = '%s', pid = %d, token = %" PRIu64
,
3803 app
->name
, app
->pid
, lttng_trigger_get_tracer_token(trigger
));
3808 /* The RCU read side lock is already being held by the caller. */
3809 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3815 * Create UST metadata and open it on the tracer side.
3817 * Called with UST app session lock held and RCU read side lock.
3819 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3820 struct ust_app
*app
, struct consumer_output
*consumer
)
3823 struct ust_app_channel
*metadata
;
3824 struct consumer_socket
*socket
;
3825 struct ltt_session
*session
= NULL
;
3827 LTTNG_ASSERT(ua_sess
);
3829 LTTNG_ASSERT(consumer
);
3830 ASSERT_RCU_READ_LOCKED();
3832 auto locked_registry
= get_locked_session_registry(ua_sess
);
3833 /* The UST app session is held registry shall not be null. */
3834 LTTNG_ASSERT(locked_registry
);
3836 /* Metadata already exists for this registry or it was closed previously */
3837 if (locked_registry
->_metadata_key
|| locked_registry
->_metadata_closed
) {
3842 /* Allocate UST metadata */
3843 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3845 /* malloc() failed */
3850 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3852 /* Need one fd for the channel. */
3853 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3855 ERR("Exhausted number of available FD upon create metadata");
3859 /* Get the right consumer socket for the application. */
3860 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
, consumer
);
3863 goto error_consumer
;
3867 * Keep metadata key so we can identify it on the consumer side. Assign it
3868 * to the registry *before* we ask the consumer so we avoid the race of the
3869 * consumer requesting the metadata and the ask_channel call on our side
3870 * did not returned yet.
3872 locked_registry
->_metadata_key
= metadata
->key
;
3874 session
= session_find_by_id(ua_sess
->tracing_id
);
3875 LTTNG_ASSERT(session
);
3876 ASSERT_LOCKED(session
->lock
);
3877 ASSERT_SESSION_LIST_LOCKED();
3880 * Ask the metadata channel creation to the consumer. The metadata object
3881 * will be created by the consumer and kept their. However, the stream is
3882 * never added or monitored until we do a first push metadata to the
3885 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3886 locked_registry
.get(), session
->current_trace_chunk
);
3888 /* Nullify the metadata key so we don't try to close it later on. */
3889 locked_registry
->_metadata_key
= 0;
3890 goto error_consumer
;
3894 * The setup command will make the metadata stream be sent to the relayd,
3895 * if applicable, and the thread managing the metadatas. This is important
3896 * because after this point, if an error occurs, the only way the stream
3897 * can be deleted is to be monitored in the consumer.
3899 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3901 /* Nullify the metadata key so we don't try to close it later on. */
3902 locked_registry
->_metadata_key
= 0;
3903 goto error_consumer
;
3906 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3907 metadata
->key
, app
->pid
);
3910 lttng_fd_put(LTTNG_FD_APPS
, 1);
3911 delete_ust_app_channel(-1, metadata
, app
, locked_registry
);
3914 session_put(session
);
3920 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3921 * acquired before calling this function.
3923 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3925 struct ust_app
*app
= NULL
;
3926 struct lttng_ht_node_ulong
*node
;
3927 struct lttng_ht_iter iter
;
3929 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3930 node
= lttng_ht_iter_get_node_ulong(&iter
);
3932 DBG2("UST app no found with pid %d", pid
);
3936 DBG2("Found UST app by pid %d", pid
);
3938 app
= lttng::utils::container_of(node
, &ust_app::pid_n
);
3945 * Allocate and init an UST app object using the registration information and
3946 * the command socket. This is called when the command socket connects to the
3949 * The object is returned on success or else NULL.
3951 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3954 struct ust_app
*lta
= NULL
;
3955 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3958 LTTNG_ASSERT(sock
>= 0);
3960 DBG3("UST app creating application for socket %d", sock
);
3962 if ((msg
->bits_per_long
== 64 &&
3963 (uatomic_read(&the_ust_consumerd64_fd
) ==
3965 (msg
->bits_per_long
== 32 &&
3966 (uatomic_read(&the_ust_consumerd32_fd
) ==
3968 ERR("Registration failed: application \"%s\" (pid: %d) has "
3969 "%d-bit long, but no consumerd for this size is available.\n",
3970 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3975 * Reserve the two file descriptors of the event source pipe. The write
3976 * end will be closed once it is passed to the application, at which
3977 * point a single 'put' will be performed.
3979 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3981 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s', pid = %d",
3982 msg
->name
, (int) msg
->pid
);
3986 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3987 if (!event_notifier_event_source_pipe
) {
3988 PERROR("Failed to open application event source pipe: '%s' (pid = %d)",
3989 msg
->name
, msg
->pid
);
3993 lta
= zmalloc
<ust_app
>();
3996 goto error_free_pipe
;
3999 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
4001 lta
->ppid
= msg
->ppid
;
4002 lta
->uid
= msg
->uid
;
4003 lta
->gid
= msg
->gid
;
4006 .bits_per_long
= msg
->bits_per_long
,
4007 .long_alignment
= msg
->long_alignment
,
4008 .uint8_t_alignment
= msg
->uint8_t_alignment
,
4009 .uint16_t_alignment
= msg
->uint16_t_alignment
,
4010 .uint32_t_alignment
= msg
->uint32_t_alignment
,
4011 .uint64_t_alignment
= msg
->uint64_t_alignment
,
4012 .byte_order
= msg
->byte_order
== LITTLE_ENDIAN
?
4013 lttng::sessiond::trace::byte_order::LITTLE_ENDIAN_
:
4014 lttng::sessiond::trace::byte_order::BIG_ENDIAN_
,
4017 lta
->v_major
= msg
->major
;
4018 lta
->v_minor
= msg
->minor
;
4019 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4020 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4021 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4022 lta
->notify_sock
= -1;
4023 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4025 /* Copy name and make sure it's NULL terminated. */
4026 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
4027 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
4030 * Before this can be called, when receiving the registration information,
4031 * the application compatibility is checked. So, at this point, the
4032 * application can work with this session daemon.
4034 lta
->compatible
= 1;
4036 lta
->pid
= msg
->pid
;
4037 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
4039 pthread_mutex_init(<a
->sock_lock
, NULL
);
4040 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
4042 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
4046 lttng_pipe_destroy(event_notifier_event_source_pipe
);
4047 lttng_fd_put(LTTNG_FD_APPS
, 2);
4053 * For a given application object, add it to every hash table.
4055 void ust_app_add(struct ust_app
*app
)
4058 LTTNG_ASSERT(app
->notify_sock
>= 0);
4060 app
->registration_time
= time(NULL
);
4065 * On a re-registration, we want to kick out the previous registration of
4068 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
4071 * The socket _should_ be unique until _we_ call close. So, a add_unique
4072 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
4073 * already in the table.
4075 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
4077 /* Add application to the notify socket hash table. */
4078 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
4079 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
4081 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock =%d name:%s "
4082 "notify_sock =%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
4083 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
4090 * Set the application version into the object.
4092 * Return 0 on success else a negative value either an errno code or a
4093 * LTTng-UST error code.
4095 int ust_app_version(struct ust_app
*app
)
4101 pthread_mutex_lock(&app
->sock_lock
);
4102 ret
= lttng_ust_ctl_tracer_version(app
->sock
, &app
->version
);
4103 pthread_mutex_unlock(&app
->sock_lock
);
4105 if (ret
== -LTTNG_UST_ERR_EXITING
|| ret
== -EPIPE
) {
4106 DBG3("UST app version failed. Application is dead: pid = %d, sock = %d",
4107 app
->pid
, app
->sock
);
4108 } else if (ret
== -EAGAIN
) {
4109 WARN("UST app version failed. Communication time out: pid = %d, sock = %d",
4110 app
->pid
, app
->sock
);
4112 ERR("UST app version failed with ret %d: pid = %d, sock = %d",
4113 ret
, app
->pid
, app
->sock
);
4120 bool ust_app_supports_notifiers(const struct ust_app
*app
)
4122 return app
->v_major
>= 9;
4125 bool ust_app_supports_counters(const struct ust_app
*app
)
4127 return app
->v_major
>= 9;
4131 * Setup the base event notifier group.
4133 * Return 0 on success else a negative value either an errno code or a
4134 * LTTng-UST error code.
4136 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
4139 int event_pipe_write_fd
;
4140 struct lttng_ust_abi_object_data
*event_notifier_group
= NULL
;
4141 enum lttng_error_code lttng_ret
;
4142 enum event_notifier_error_accounting_status event_notifier_error_accounting_status
;
4146 if (!ust_app_supports_notifiers(app
)) {
4151 /* Get the write side of the pipe. */
4152 event_pipe_write_fd
= lttng_pipe_get_writefd(
4153 app
->event_notifier_group
.event_pipe
);
4155 pthread_mutex_lock(&app
->sock_lock
);
4156 ret
= lttng_ust_ctl_create_event_notifier_group(app
->sock
,
4157 event_pipe_write_fd
, &event_notifier_group
);
4158 pthread_mutex_unlock(&app
->sock_lock
);
4160 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4162 DBG3("UST app create event notifier group failed. Application is dead: pid = %d, sock = %d",
4163 app
->pid
, app
->sock
);
4164 } else if (ret
== -EAGAIN
) {
4166 WARN("UST app create event notifier group failed. Communication time out: pid = %d, sock = %d",
4167 app
->pid
, app
->sock
);
4169 ERR("UST app create event notifier group failed with ret %d: pid = %d, sock = %d, event_pipe_write_fd: %d",
4170 ret
, app
->pid
, app
->sock
, event_pipe_write_fd
);
4175 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
4177 ERR("Failed to close write end of the application's event source pipe: app = '%s' (pid = %d)",
4178 app
->name
, app
->pid
);
4183 * Release the file descriptor that was reserved for the write-end of
4186 lttng_fd_put(LTTNG_FD_APPS
, 1);
4188 lttng_ret
= notification_thread_command_add_tracer_event_source(
4189 the_notification_thread_handle
,
4190 lttng_pipe_get_readfd(
4191 app
->event_notifier_group
.event_pipe
),
4193 if (lttng_ret
!= LTTNG_OK
) {
4194 ERR("Failed to add tracer event source to notification thread");
4199 /* Assign handle only when the complete setup is valid. */
4200 app
->event_notifier_group
.object
= event_notifier_group
;
4202 event_notifier_error_accounting_status
=
4203 event_notifier_error_accounting_register_app(app
);
4204 switch (event_notifier_error_accounting_status
) {
4205 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
4207 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_UNSUPPORTED
:
4208 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",
4209 app
->sock
, app
->name
, (int) app
->pid
);
4211 goto error_accounting
;
4212 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
:
4213 DBG3("Failed to setup event notifier error accounting (application is dead): app socket fd = %d, app name = '%s', app pid = %d",
4214 app
->sock
, app
->name
, (int) app
->pid
);
4216 goto error_accounting
;
4218 ERR("Failed to setup event notifier error accounting for app");
4220 goto error_accounting
;
4226 lttng_ret
= notification_thread_command_remove_tracer_event_source(
4227 the_notification_thread_handle
,
4228 lttng_pipe_get_readfd(
4229 app
->event_notifier_group
.event_pipe
));
4230 if (lttng_ret
!= LTTNG_OK
) {
4231 ERR("Failed to remove application tracer event source from notification thread");
4235 lttng_ust_ctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
4236 free(app
->event_notifier_group
.object
);
4237 app
->event_notifier_group
.object
= NULL
;
4242 * Unregister app by removing it from the global traceable app list and freeing
4245 * The socket is already closed at this point so no close to sock.
4247 void ust_app_unregister(int sock
)
4249 struct ust_app
*lta
;
4250 struct lttng_ht_node_ulong
*node
;
4251 struct lttng_ht_iter ust_app_sock_iter
;
4252 struct lttng_ht_iter iter
;
4253 struct ust_app_session
*ua_sess
;
4258 /* Get the node reference for a call_rcu */
4259 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
4260 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
4263 lta
= lttng::utils::container_of(node
, &ust_app::sock_n
);
4264 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
4267 * For per-PID buffers, perform "push metadata" and flush all
4268 * application streams before removing app from hash tables,
4269 * ensuring proper behavior of data_pending check.
4270 * Remove sessions so they are not visible during deletion.
4272 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
4274 ret
= lttng_ht_del(lta
->sessions
, &iter
);
4276 /* The session was already removed so scheduled for teardown. */
4280 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
4281 (void) ust_app_flush_app_session(lta
, ua_sess
);
4285 * Add session to list for teardown. This is safe since at this point we
4286 * are the only one using this list.
4288 pthread_mutex_lock(&ua_sess
->lock
);
4290 if (ua_sess
->deleted
) {
4291 pthread_mutex_unlock(&ua_sess
->lock
);
4296 * Normally, this is done in the delete session process which is
4297 * executed in the call rcu below. However, upon registration we can't
4298 * afford to wait for the grace period before pushing data or else the
4299 * data pending feature can race between the unregistration and stop
4300 * command where the data pending command is sent *before* the grace
4303 * The close metadata below nullifies the metadata pointer in the
4304 * session so the delete session will NOT push/close a second time.
4306 auto locked_registry
= get_locked_session_registry(ua_sess
);
4307 if (locked_registry
) {
4308 /* Push metadata for application before freeing the application. */
4309 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
4312 * Don't ask to close metadata for global per UID buffers. Close
4313 * metadata only on destroy trace session in this case. Also, the
4314 * previous push metadata could have flag the metadata registry to
4315 * close so don't send a close command if closed.
4317 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4318 const auto metadata_key
= locked_registry
->_metadata_key
;
4319 const auto consumer_bitness
= locked_registry
->abi
.bits_per_long
;
4321 if (!locked_registry
->_metadata_closed
&& metadata_key
!= 0) {
4322 locked_registry
->_metadata_closed
= true;
4325 /* Release lock before communication, see comments in close_metadata(). */
4326 locked_registry
.reset();
4327 (void) close_metadata(metadata_key
, consumer_bitness
, ua_sess
->consumer
);
4329 locked_registry
.reset();
4332 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4334 pthread_mutex_unlock(&ua_sess
->lock
);
4337 /* Remove application from PID hash table */
4338 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4342 * Remove application from notify hash table. The thread handling the
4343 * notify socket could have deleted the node so ignore on error because
4344 * either way it's valid. The close of that socket is handled by the
4345 * apps_notify_thread.
4347 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4348 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4351 * Ignore return value since the node might have been removed before by an
4352 * add replace during app registration because the PID can be reassigned by
4355 iter
.iter
.node
= <a
->pid_n
.node
;
4356 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4358 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4363 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4370 * Fill events array with all events name of all registered apps.
4372 int ust_app_list_events(struct lttng_event
**events
)
4375 size_t nbmem
, count
= 0;
4376 struct lttng_ht_iter iter
;
4377 struct ust_app
*app
;
4378 struct lttng_event
*tmp_event
;
4380 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4381 tmp_event
= calloc
<lttng_event
>(nbmem
);
4382 if (tmp_event
== NULL
) {
4383 PERROR("zmalloc ust app events");
4390 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4391 struct lttng_ust_abi_tracepoint_iter uiter
;
4393 health_code_update();
4395 if (!app
->compatible
) {
4397 * TODO: In time, we should notice the caller of this error by
4398 * telling him that this is a version error.
4402 pthread_mutex_lock(&app
->sock_lock
);
4403 handle
= lttng_ust_ctl_tracepoint_list(app
->sock
);
4405 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4406 ERR("UST app list events getting handle failed for app pid %d",
4409 pthread_mutex_unlock(&app
->sock_lock
);
4413 while ((ret
= lttng_ust_ctl_tracepoint_list_get(app
->sock
, handle
,
4414 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4415 /* Handle ustctl error. */
4419 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4420 ERR("UST app tp list get failed for app %d with ret %d",
4423 DBG3("UST app tp list get failed. Application is dead");
4427 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4428 if (release_ret
< 0 &&
4429 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4430 release_ret
!= -EPIPE
) {
4431 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4433 pthread_mutex_unlock(&app
->sock_lock
);
4437 health_code_update();
4438 if (count
>= nbmem
) {
4439 /* In case the realloc fails, we free the memory */
4440 struct lttng_event
*new_tmp_event
;
4443 new_nbmem
= nbmem
<< 1;
4444 DBG2("Reallocating event list from %zu to %zu entries",
4446 new_tmp_event
= (lttng_event
*) realloc(tmp_event
,
4447 new_nbmem
* sizeof(struct lttng_event
));
4448 if (new_tmp_event
== NULL
) {
4451 PERROR("realloc ust app events");
4454 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4455 if (release_ret
< 0 &&
4456 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4457 release_ret
!= -EPIPE
) {
4458 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4460 pthread_mutex_unlock(&app
->sock_lock
);
4463 /* Zero the new memory */
4464 memset(new_tmp_event
+ nbmem
, 0,
4465 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4467 tmp_event
= new_tmp_event
;
4469 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4470 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4471 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_ABI_TRACEPOINT
;
4472 tmp_event
[count
].pid
= app
->pid
;
4473 tmp_event
[count
].enabled
= -1;
4476 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4477 pthread_mutex_unlock(&app
->sock_lock
);
4479 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4480 DBG3("Error releasing app handle. Application died: pid = %d, sock = %d",
4481 app
->pid
, app
->sock
);
4482 } else if (ret
== -EAGAIN
) {
4483 WARN("Error releasing app handle. Communication time out: pid = %d, sock = %d",
4484 app
->pid
, app
->sock
);
4486 ERR("Error releasing app handle with ret %d: pid = %d, sock = %d",
4487 ret
, app
->pid
, app
->sock
);
4493 *events
= tmp_event
;
4495 DBG2("UST app list events done (%zu events)", count
);
4500 health_code_update();
4505 * Fill events array with all events name of all registered apps.
4507 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4510 size_t nbmem
, count
= 0;
4511 struct lttng_ht_iter iter
;
4512 struct ust_app
*app
;
4513 struct lttng_event_field
*tmp_event
;
4515 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4516 tmp_event
= calloc
<lttng_event_field
>(nbmem
);
4517 if (tmp_event
== NULL
) {
4518 PERROR("zmalloc ust app event fields");
4525 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4526 struct lttng_ust_abi_field_iter uiter
;
4528 health_code_update();
4530 if (!app
->compatible
) {
4532 * TODO: In time, we should notice the caller of this error by
4533 * telling him that this is a version error.
4537 pthread_mutex_lock(&app
->sock_lock
);
4538 handle
= lttng_ust_ctl_tracepoint_field_list(app
->sock
);
4540 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4541 ERR("UST app list field getting handle failed for app pid %d",
4544 pthread_mutex_unlock(&app
->sock_lock
);
4548 while ((ret
= lttng_ust_ctl_tracepoint_field_list_get(app
->sock
, handle
,
4549 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4550 /* Handle ustctl error. */
4554 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4555 ERR("UST app tp list field failed for app %d with ret %d",
4558 DBG3("UST app tp list field failed. Application is dead");
4562 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4563 pthread_mutex_unlock(&app
->sock_lock
);
4564 if (release_ret
< 0 &&
4565 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4566 release_ret
!= -EPIPE
) {
4567 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4572 health_code_update();
4573 if (count
>= nbmem
) {
4574 /* In case the realloc fails, we free the memory */
4575 struct lttng_event_field
*new_tmp_event
;
4578 new_nbmem
= nbmem
<< 1;
4579 DBG2("Reallocating event field list from %zu to %zu entries",
4581 new_tmp_event
= (lttng_event_field
*) realloc(tmp_event
,
4582 new_nbmem
* sizeof(struct lttng_event_field
));
4583 if (new_tmp_event
== NULL
) {
4586 PERROR("realloc ust app event fields");
4589 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4590 pthread_mutex_unlock(&app
->sock_lock
);
4592 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4593 release_ret
!= -EPIPE
) {
4594 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4598 /* Zero the new memory */
4599 memset(new_tmp_event
+ nbmem
, 0,
4600 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4602 tmp_event
= new_tmp_event
;
4605 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4606 /* Mapping between these enums matches 1 to 1. */
4607 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4608 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4610 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4611 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4612 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4613 tmp_event
[count
].event
.pid
= app
->pid
;
4614 tmp_event
[count
].event
.enabled
= -1;
4617 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4618 pthread_mutex_unlock(&app
->sock_lock
);
4620 ret
!= -LTTNG_UST_ERR_EXITING
&&
4622 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4627 *fields
= tmp_event
;
4629 DBG2("UST app list event fields done (%zu events)", count
);
4634 health_code_update();
4639 * Free and clean all traceable apps of the global list.
4641 void ust_app_clean_list(void)
4644 struct ust_app
*app
;
4645 struct lttng_ht_iter iter
;
4647 DBG2("UST app cleaning registered apps hash table");
4651 /* Cleanup notify socket hash table */
4652 if (ust_app_ht_by_notify_sock
) {
4653 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4654 notify_sock_n
.node
) {
4656 * Assert that all notifiers are gone as all triggers
4657 * are unregistered prior to this clean-up.
4659 LTTNG_ASSERT(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4661 ust_app_notify_sock_unregister(app
->notify_sock
);
4666 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4667 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4669 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4673 /* Cleanup socket hash table */
4674 if (ust_app_ht_by_sock
) {
4675 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4677 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4684 /* Destroy is done only when the ht is empty */
4686 lttng_ht_destroy(ust_app_ht
);
4688 if (ust_app_ht_by_sock
) {
4689 lttng_ht_destroy(ust_app_ht_by_sock
);
4691 if (ust_app_ht_by_notify_sock
) {
4692 lttng_ht_destroy(ust_app_ht_by_notify_sock
);
4697 * Init UST app hash table.
4699 int ust_app_ht_alloc(void)
4701 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4705 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4706 if (!ust_app_ht_by_sock
) {
4709 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4710 if (!ust_app_ht_by_notify_sock
) {
4717 * For a specific UST session, disable the channel for all registered apps.
4719 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4720 struct ltt_ust_channel
*uchan
)
4723 struct lttng_ht_iter iter
;
4724 struct lttng_ht_node_str
*ua_chan_node
;
4725 struct ust_app
*app
;
4726 struct ust_app_session
*ua_sess
;
4727 struct ust_app_channel
*ua_chan
;
4729 LTTNG_ASSERT(usess
->active
);
4730 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4731 uchan
->name
, usess
->id
);
4735 /* For every registered applications */
4736 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4737 struct lttng_ht_iter uiter
;
4738 if (!app
->compatible
) {
4740 * TODO: In time, we should notice the caller of this error by
4741 * telling him that this is a version error.
4745 ua_sess
= lookup_session_by_app(usess
, app
);
4746 if (ua_sess
== NULL
) {
4751 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4752 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4753 /* If the session if found for the app, the channel must be there */
4754 LTTNG_ASSERT(ua_chan_node
);
4756 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
4757 /* The channel must not be already disabled */
4758 LTTNG_ASSERT(ua_chan
->enabled
== 1);
4760 /* Disable channel onto application */
4761 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4763 /* XXX: We might want to report this error at some point... */
4773 * For a specific UST session, enable the channel for all registered apps.
4775 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4776 struct ltt_ust_channel
*uchan
)
4779 struct lttng_ht_iter iter
;
4780 struct ust_app
*app
;
4781 struct ust_app_session
*ua_sess
;
4783 LTTNG_ASSERT(usess
->active
);
4784 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4785 uchan
->name
, usess
->id
);
4789 /* For every registered applications */
4790 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4791 if (!app
->compatible
) {
4793 * TODO: In time, we should notice the caller of this error by
4794 * telling him that this is a version error.
4798 ua_sess
= lookup_session_by_app(usess
, app
);
4799 if (ua_sess
== NULL
) {
4803 /* Enable channel onto application */
4804 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4806 /* XXX: We might want to report this error at some point... */
4816 * Disable an event in a channel and for a specific session.
4818 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4819 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4822 struct lttng_ht_iter iter
, uiter
;
4823 struct lttng_ht_node_str
*ua_chan_node
;
4824 struct ust_app
*app
;
4825 struct ust_app_session
*ua_sess
;
4826 struct ust_app_channel
*ua_chan
;
4827 struct ust_app_event
*ua_event
;
4829 LTTNG_ASSERT(usess
->active
);
4830 DBG("UST app disabling event %s for all apps in channel "
4831 "%s for session id %" PRIu64
,
4832 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4836 /* For all registered applications */
4837 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4838 if (!app
->compatible
) {
4840 * TODO: In time, we should notice the caller of this error by
4841 * telling him that this is a version error.
4845 ua_sess
= lookup_session_by_app(usess
, app
);
4846 if (ua_sess
== NULL
) {
4851 /* Lookup channel in the ust app session */
4852 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4853 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4854 if (ua_chan_node
== NULL
) {
4855 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4856 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4859 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
4861 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4862 uevent
->filter
, uevent
->attr
.loglevel
,
4864 if (ua_event
== NULL
) {
4865 DBG2("Event %s not found in channel %s for app pid %d."
4866 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4870 ret
= disable_ust_app_event(ua_event
, app
);
4872 /* XXX: Report error someday... */
4881 /* The ua_sess lock must be held by the caller. */
4883 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4884 struct ust_app_session
*ua_sess
,
4885 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4886 struct ust_app_channel
**_ua_chan
)
4889 struct ust_app_channel
*ua_chan
= NULL
;
4891 LTTNG_ASSERT(ua_sess
);
4892 ASSERT_LOCKED(ua_sess
->lock
);
4894 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4895 sizeof(uchan
->name
))) {
4896 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4900 struct ltt_ust_context
*uctx
= NULL
;
4903 * Create channel onto application and synchronize its
4906 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4907 LTTNG_UST_ABI_CHAN_PER_CPU
, usess
,
4913 ret
= ust_app_channel_send(app
, usess
,
4920 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4921 ret
= create_ust_app_channel_context(ua_chan
,
4934 * The application's socket is not valid. Either a bad socket
4935 * or a timeout on it. We can't inform the caller that for a
4936 * specific app, the session failed so lets continue here.
4938 ret
= 0; /* Not an error. */
4946 if (ret
== 0 && _ua_chan
) {
4948 * Only return the application's channel on success. Note
4949 * that the channel can still be part of the application's
4950 * channel hashtable on error.
4952 *_ua_chan
= ua_chan
;
4958 * Enable event for a specific session and channel on the tracer.
4960 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4961 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4964 struct lttng_ht_iter iter
, uiter
;
4965 struct lttng_ht_node_str
*ua_chan_node
;
4966 struct ust_app
*app
;
4967 struct ust_app_session
*ua_sess
;
4968 struct ust_app_channel
*ua_chan
;
4969 struct ust_app_event
*ua_event
;
4971 LTTNG_ASSERT(usess
->active
);
4972 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4973 uevent
->attr
.name
, usess
->id
);
4976 * NOTE: At this point, this function is called only if the session and
4977 * channel passed are already created for all apps. and enabled on the
4983 /* For all registered applications */
4984 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4985 if (!app
->compatible
) {
4987 * TODO: In time, we should notice the caller of this error by
4988 * telling him that this is a version error.
4992 ua_sess
= lookup_session_by_app(usess
, app
);
4994 /* The application has problem or is probably dead. */
4998 pthread_mutex_lock(&ua_sess
->lock
);
5000 if (ua_sess
->deleted
) {
5001 pthread_mutex_unlock(&ua_sess
->lock
);
5005 /* Lookup channel in the ust app session */
5006 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5007 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5009 * It is possible that the channel cannot be found is
5010 * the channel/event creation occurs concurrently with
5011 * an application exit.
5013 if (!ua_chan_node
) {
5014 pthread_mutex_unlock(&ua_sess
->lock
);
5018 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
5020 /* Get event node */
5021 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5022 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5023 if (ua_event
== NULL
) {
5024 DBG3("UST app enable event %s not found for app PID %d."
5025 "Skipping app", uevent
->attr
.name
, app
->pid
);
5029 ret
= enable_ust_app_event(ua_event
, app
);
5031 pthread_mutex_unlock(&ua_sess
->lock
);
5035 pthread_mutex_unlock(&ua_sess
->lock
);
5044 * For a specific existing UST session and UST channel, creates the event for
5045 * all registered apps.
5047 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
5048 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
5051 struct lttng_ht_iter iter
, uiter
;
5052 struct lttng_ht_node_str
*ua_chan_node
;
5053 struct ust_app
*app
;
5054 struct ust_app_session
*ua_sess
;
5055 struct ust_app_channel
*ua_chan
;
5057 LTTNG_ASSERT(usess
->active
);
5058 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
5059 uevent
->attr
.name
, usess
->id
);
5063 /* For all registered applications */
5064 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5065 if (!app
->compatible
) {
5067 * TODO: In time, we should notice the caller of this error by
5068 * telling him that this is a version error.
5072 ua_sess
= lookup_session_by_app(usess
, app
);
5074 /* The application has problem or is probably dead. */
5078 pthread_mutex_lock(&ua_sess
->lock
);
5080 if (ua_sess
->deleted
) {
5081 pthread_mutex_unlock(&ua_sess
->lock
);
5085 /* Lookup channel in the ust app session */
5086 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5087 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5088 /* If the channel is not found, there is a code flow error */
5089 LTTNG_ASSERT(ua_chan_node
);
5091 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
5093 ret
= create_ust_app_event(ua_chan
, uevent
, app
);
5094 pthread_mutex_unlock(&ua_sess
->lock
);
5096 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
5097 /* Possible value at this point: -ENOMEM. If so, we stop! */
5100 DBG2("UST app event %s already exist on app PID %d",
5101 uevent
->attr
.name
, app
->pid
);
5111 * Start tracing for a specific UST session and app.
5113 * Called with UST app session lock held.
5117 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5120 struct ust_app_session
*ua_sess
;
5122 DBG("Starting tracing for ust app pid %d", app
->pid
);
5126 if (!app
->compatible
) {
5130 ua_sess
= lookup_session_by_app(usess
, app
);
5131 if (ua_sess
== NULL
) {
5132 /* The session is in teardown process. Ignore and continue. */
5136 pthread_mutex_lock(&ua_sess
->lock
);
5138 if (ua_sess
->deleted
) {
5139 pthread_mutex_unlock(&ua_sess
->lock
);
5143 if (ua_sess
->enabled
) {
5144 pthread_mutex_unlock(&ua_sess
->lock
);
5148 /* Upon restart, we skip the setup, already done */
5149 if (ua_sess
->started
) {
5153 health_code_update();
5156 /* This starts the UST tracing */
5157 pthread_mutex_lock(&app
->sock_lock
);
5158 ret
= lttng_ust_ctl_start_session(app
->sock
, ua_sess
->handle
);
5159 pthread_mutex_unlock(&app
->sock_lock
);
5161 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5162 DBG3("UST app start session failed. Application is dead: pid = %d, sock = %d",
5163 app
->pid
, app
->sock
);
5164 pthread_mutex_unlock(&ua_sess
->lock
);
5166 } else if (ret
== -EAGAIN
) {
5167 WARN("UST app start session failed. Communication time out: pid = %d, sock = %d",
5168 app
->pid
, app
->sock
);
5169 pthread_mutex_unlock(&ua_sess
->lock
);
5173 ERR("UST app start session failed with ret %d: pid = %d, sock = %d",
5174 ret
, app
->pid
, app
->sock
);
5179 /* Indicate that the session has been started once */
5180 ua_sess
->started
= 1;
5181 ua_sess
->enabled
= 1;
5183 pthread_mutex_unlock(&ua_sess
->lock
);
5185 health_code_update();
5187 /* Quiescent wait after starting trace */
5188 pthread_mutex_lock(&app
->sock_lock
);
5189 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5190 pthread_mutex_unlock(&app
->sock_lock
);
5192 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5193 DBG3("UST app wait quiescent failed. Application is dead: pid = %d, sock = %d",
5194 app
->pid
, app
->sock
);
5195 } else if (ret
== -EAGAIN
) {
5196 WARN("UST app wait quiescent failed. Communication time out: pid = %d, sock = %d",
5197 app
->pid
, app
->sock
);
5199 ERR("UST app wait quiescent failed with ret %d: pid %d, sock = %d",
5200 ret
, app
->pid
, app
->sock
);
5206 health_code_update();
5210 pthread_mutex_unlock(&ua_sess
->lock
);
5212 health_code_update();
5217 * Stop tracing for a specific UST session and app.
5220 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5223 struct ust_app_session
*ua_sess
;
5225 DBG("Stopping tracing for ust app pid %d", app
->pid
);
5229 if (!app
->compatible
) {
5230 goto end_no_session
;
5233 ua_sess
= lookup_session_by_app(usess
, app
);
5234 if (ua_sess
== NULL
) {
5235 goto end_no_session
;
5238 pthread_mutex_lock(&ua_sess
->lock
);
5240 if (ua_sess
->deleted
) {
5241 pthread_mutex_unlock(&ua_sess
->lock
);
5242 goto end_no_session
;
5246 * If started = 0, it means that stop trace has been called for a session
5247 * that was never started. It's possible since we can have a fail start
5248 * from either the application manager thread or the command thread. Simply
5249 * indicate that this is a stop error.
5251 if (!ua_sess
->started
) {
5252 goto error_rcu_unlock
;
5255 health_code_update();
5257 /* This inhibits UST tracing */
5258 pthread_mutex_lock(&app
->sock_lock
);
5259 ret
= lttng_ust_ctl_stop_session(app
->sock
, ua_sess
->handle
);
5260 pthread_mutex_unlock(&app
->sock_lock
);
5262 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5263 DBG3("UST app stop session failed. Application is dead: pid = %d, sock = %d",
5264 app
->pid
, app
->sock
);
5266 } else if (ret
== -EAGAIN
) {
5267 WARN("UST app stop session failed. Communication time out: pid = %d, sock = %d",
5268 app
->pid
, app
->sock
);
5272 ERR("UST app stop session failed with ret %d: pid = %d, sock = %d",
5273 ret
, app
->pid
, app
->sock
);
5275 goto error_rcu_unlock
;
5278 health_code_update();
5279 ua_sess
->enabled
= 0;
5281 /* Quiescent wait after stopping trace */
5282 pthread_mutex_lock(&app
->sock_lock
);
5283 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5284 pthread_mutex_unlock(&app
->sock_lock
);
5286 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5287 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d",
5288 app
->pid
, app
->sock
);
5289 } else if (ret
== -EAGAIN
) {
5290 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d",
5291 app
->pid
, app
->sock
);
5293 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d",
5294 ret
, app
->pid
, app
->sock
);
5298 health_code_update();
5301 auto locked_registry
= get_locked_session_registry(ua_sess
);
5303 /* The UST app session is held registry shall not be null. */
5304 LTTNG_ASSERT(locked_registry
);
5306 /* Push metadata for application before freeing the application. */
5307 (void) push_metadata(locked_registry
, ua_sess
->consumer
);
5311 pthread_mutex_unlock(&ua_sess
->lock
);
5314 health_code_update();
5318 pthread_mutex_unlock(&ua_sess
->lock
);
5320 health_code_update();
5325 int ust_app_flush_app_session(struct ust_app
*app
,
5326 struct ust_app_session
*ua_sess
)
5328 int ret
, retval
= 0;
5329 struct lttng_ht_iter iter
;
5330 struct ust_app_channel
*ua_chan
;
5331 struct consumer_socket
*socket
;
5333 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5337 if (!app
->compatible
) {
5338 goto end_not_compatible
;
5341 pthread_mutex_lock(&ua_sess
->lock
);
5343 if (ua_sess
->deleted
) {
5347 health_code_update();
5349 /* Flushing buffers */
5350 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
5353 /* Flush buffers and push metadata. */
5354 switch (ua_sess
->buffer_type
) {
5355 case LTTNG_BUFFER_PER_PID
:
5356 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5358 health_code_update();
5359 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5361 ERR("Error flushing consumer channel");
5367 case LTTNG_BUFFER_PER_UID
:
5373 health_code_update();
5376 pthread_mutex_unlock(&ua_sess
->lock
);
5380 health_code_update();
5385 * Flush buffers for all applications for a specific UST session.
5386 * Called with UST session lock held.
5389 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5394 DBG("Flushing session buffers for all ust apps");
5398 /* Flush buffers and push metadata. */
5399 switch (usess
->buffer_type
) {
5400 case LTTNG_BUFFER_PER_UID
:
5402 struct buffer_reg_uid
*reg
;
5403 struct lttng_ht_iter iter
;
5405 /* Flush all per UID buffers associated to that session. */
5406 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5407 lsu::registry_session
*ust_session_reg
;
5408 struct buffer_reg_channel
*buf_reg_chan
;
5409 struct consumer_socket
*socket
;
5411 /* Get consumer socket to use to push the metadata.*/
5412 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5415 /* Ignore request if no consumer is found for the session. */
5419 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5420 buf_reg_chan
, node
.node
) {
5422 * The following call will print error values so the return
5423 * code is of little importance because whatever happens, we
5424 * have to try them all.
5426 (void) consumer_flush_channel(socket
, buf_reg_chan
->consumer_key
);
5429 ust_session_reg
= reg
->registry
->reg
.ust
;
5430 /* Push metadata. */
5431 auto locked_registry
= ust_session_reg
->lock();
5432 (void) push_metadata(locked_registry
, usess
->consumer
);
5436 case LTTNG_BUFFER_PER_PID
:
5438 struct ust_app_session
*ua_sess
;
5439 struct lttng_ht_iter iter
;
5440 struct ust_app
*app
;
5442 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5443 ua_sess
= lookup_session_by_app(usess
, app
);
5444 if (ua_sess
== NULL
) {
5447 (void) ust_app_flush_app_session(app
, ua_sess
);
5458 health_code_update();
5463 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5464 struct ust_app_session
*ua_sess
)
5467 struct lttng_ht_iter iter
;
5468 struct ust_app_channel
*ua_chan
;
5469 struct consumer_socket
*socket
;
5471 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5475 if (!app
->compatible
) {
5476 goto end_not_compatible
;
5479 pthread_mutex_lock(&ua_sess
->lock
);
5481 if (ua_sess
->deleted
) {
5485 health_code_update();
5487 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
5490 ERR("Failed to find consumer (%" PRIu32
") socket",
5491 app
->abi
.bits_per_long
);
5496 /* Clear quiescent state. */
5497 switch (ua_sess
->buffer_type
) {
5498 case LTTNG_BUFFER_PER_PID
:
5499 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5500 ua_chan
, node
.node
) {
5501 health_code_update();
5502 ret
= consumer_clear_quiescent_channel(socket
,
5505 ERR("Error clearing quiescent state for consumer channel");
5511 case LTTNG_BUFFER_PER_UID
:
5518 health_code_update();
5521 pthread_mutex_unlock(&ua_sess
->lock
);
5525 health_code_update();
5530 * Clear quiescent state in each stream for all applications for a
5531 * specific UST session.
5532 * Called with UST session lock held.
5535 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5540 DBG("Clearing stream quiescent state for all ust apps");
5544 switch (usess
->buffer_type
) {
5545 case LTTNG_BUFFER_PER_UID
:
5547 struct lttng_ht_iter iter
;
5548 struct buffer_reg_uid
*reg
;
5551 * Clear quiescent for all per UID buffers associated to
5554 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5555 struct consumer_socket
*socket
;
5556 struct buffer_reg_channel
*buf_reg_chan
;
5558 /* Get associated consumer socket.*/
5559 socket
= consumer_find_socket_by_bitness(
5560 reg
->bits_per_long
, usess
->consumer
);
5563 * Ignore request if no consumer is found for
5569 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5570 &iter
.iter
, buf_reg_chan
, node
.node
) {
5572 * The following call will print error values so
5573 * the return code is of little importance
5574 * because whatever happens, we have to try them
5577 (void) consumer_clear_quiescent_channel(socket
,
5578 buf_reg_chan
->consumer_key
);
5583 case LTTNG_BUFFER_PER_PID
:
5585 struct ust_app_session
*ua_sess
;
5586 struct lttng_ht_iter iter
;
5587 struct ust_app
*app
;
5589 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5591 ua_sess
= lookup_session_by_app(usess
, app
);
5592 if (ua_sess
== NULL
) {
5595 (void) ust_app_clear_quiescent_app_session(app
,
5607 health_code_update();
5612 * Destroy a specific UST session in apps.
5614 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5617 struct ust_app_session
*ua_sess
;
5618 struct lttng_ht_iter iter
;
5619 struct lttng_ht_node_u64
*node
;
5621 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5625 if (!app
->compatible
) {
5629 __lookup_session_by_app(usess
, app
, &iter
);
5630 node
= lttng_ht_iter_get_node_u64(&iter
);
5632 /* Session is being or is deleted. */
5635 ua_sess
= lttng::utils::container_of(node
, &ust_app_session::node
);
5637 health_code_update();
5638 destroy_app_session(app
, ua_sess
);
5640 health_code_update();
5642 /* Quiescent wait after stopping trace */
5643 pthread_mutex_lock(&app
->sock_lock
);
5644 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5645 pthread_mutex_unlock(&app
->sock_lock
);
5647 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5648 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d",
5649 app
->pid
, app
->sock
);
5650 } else if (ret
== -EAGAIN
) {
5651 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d",
5652 app
->pid
, app
->sock
);
5654 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d",
5655 ret
, app
->pid
, app
->sock
);
5660 health_code_update();
5665 * Start tracing for the UST session.
5667 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5669 struct lttng_ht_iter iter
;
5670 struct ust_app
*app
;
5672 DBG("Starting all UST traces");
5675 * Even though the start trace might fail, flag this session active so
5676 * other application coming in are started by default.
5683 * In a start-stop-start use-case, we need to clear the quiescent state
5684 * of each channel set by the prior stop command, thus ensuring that a
5685 * following stop or destroy is sure to grab a timestamp_end near those
5686 * operations, even if the packet is empty.
5688 (void) ust_app_clear_quiescent_session(usess
);
5690 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5691 ust_app_global_update(usess
, app
);
5700 * Start tracing for the UST session.
5701 * Called with UST session lock held.
5703 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5706 struct lttng_ht_iter iter
;
5707 struct ust_app
*app
;
5709 DBG("Stopping all UST traces");
5712 * Even though the stop trace might fail, flag this session inactive so
5713 * other application coming in are not started by default.
5719 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5720 ret
= ust_app_stop_trace(usess
, app
);
5722 /* Continue to next apps even on error */
5727 (void) ust_app_flush_session(usess
);
5735 * Destroy app UST session.
5737 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5740 struct lttng_ht_iter iter
;
5741 struct ust_app
*app
;
5743 DBG("Destroy all UST traces");
5747 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5748 ret
= destroy_trace(usess
, app
);
5750 /* Continue to next apps even on error */
5760 /* The ua_sess lock must be held by the caller. */
5762 int find_or_create_ust_app_channel(
5763 struct ltt_ust_session
*usess
,
5764 struct ust_app_session
*ua_sess
,
5765 struct ust_app
*app
,
5766 struct ltt_ust_channel
*uchan
,
5767 struct ust_app_channel
**ua_chan
)
5770 struct lttng_ht_iter iter
;
5771 struct lttng_ht_node_str
*ua_chan_node
;
5773 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5774 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5776 *ua_chan
= caa_container_of(ua_chan_node
,
5777 struct ust_app_channel
, node
);
5781 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5790 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5791 struct ltt_ust_event
*uevent
,
5792 struct ust_app
*app
)
5795 struct ust_app_event
*ua_event
= NULL
;
5797 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5798 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5800 ret
= create_ust_app_event(ua_chan
, uevent
, app
);
5805 if (ua_event
->enabled
!= uevent
->enabled
) {
5806 ret
= uevent
->enabled
?
5807 enable_ust_app_event(ua_event
, app
) :
5808 disable_ust_app_event(ua_event
, app
);
5816 /* Called with RCU read-side lock held. */
5818 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5821 enum lttng_error_code ret_code
;
5822 enum lttng_trigger_status t_status
;
5823 struct lttng_ht_iter app_trigger_iter
;
5824 struct lttng_triggers
*triggers
= NULL
;
5825 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5826 unsigned int count
, i
;
5828 ASSERT_RCU_READ_LOCKED();
5830 if (!ust_app_supports_notifiers(app
)) {
5835 * Currrently, registering or unregistering a trigger with an
5836 * event rule condition causes a full synchronization of the event
5839 * The first step attempts to add an event notifier for all registered
5840 * triggers that apply to the user space tracers. Then, the
5841 * application's event notifiers rules are all checked against the list
5842 * of registered triggers. Any event notifier that doesn't have a
5843 * matching trigger can be assumed to have been disabled.
5845 * All of this is inefficient, but is put in place to get the feature
5846 * rolling as it is simpler at this moment. It will be optimized Soon™
5847 * to allow the state of enabled
5848 * event notifiers to be synchronized in a piece-wise way.
5851 /* Get all triggers using uid 0 (root) */
5852 ret_code
= notification_thread_command_list_triggers(
5853 the_notification_thread_handle
, 0, &triggers
);
5854 if (ret_code
!= LTTNG_OK
) {
5858 LTTNG_ASSERT(triggers
);
5860 t_status
= lttng_triggers_get_count(triggers
, &count
);
5861 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5865 for (i
= 0; i
< count
; i
++) {
5866 struct lttng_condition
*condition
;
5867 struct lttng_event_rule
*event_rule
;
5868 struct lttng_trigger
*trigger
;
5869 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5870 enum lttng_condition_status condition_status
;
5873 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5874 LTTNG_ASSERT(trigger
);
5876 token
= lttng_trigger_get_tracer_token(trigger
);
5877 condition
= lttng_trigger_get_condition(trigger
);
5879 if (lttng_condition_get_type(condition
) !=
5880 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
) {
5881 /* Does not apply */
5886 lttng_condition_event_rule_matches_borrow_rule_mutable(
5887 condition
, &event_rule
);
5888 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5890 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5891 /* Skip kernel related triggers. */
5896 * Find or create the associated token event rule. The caller
5897 * holds the RCU read lock, so this is safe to call without
5898 * explicitly acquiring it here.
5900 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5901 app
->token_to_event_notifier_rule_ht
, token
);
5902 if (!looked_up_event_notifier_rule
) {
5903 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
5911 /* Remove all unknown event sources from the app. */
5912 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5913 &app_trigger_iter
.iter
, event_notifier_rule
,
5915 const uint64_t app_token
= event_notifier_rule
->token
;
5919 * Check if the app event trigger still exists on the
5920 * notification side.
5922 for (i
= 0; i
< count
; i
++) {
5923 uint64_t notification_thread_token
;
5924 const struct lttng_trigger
*trigger
=
5925 lttng_triggers_get_at_index(
5928 LTTNG_ASSERT(trigger
);
5930 notification_thread_token
=
5931 lttng_trigger_get_tracer_token(trigger
);
5933 if (notification_thread_token
== app_token
) {
5945 * This trigger was unregistered, disable it on the tracer's
5948 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5950 LTTNG_ASSERT(ret
== 0);
5952 /* Callee logs errors. */
5953 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5955 delete_ust_app_event_notifier_rule(
5956 app
->sock
, event_notifier_rule
, app
);
5962 lttng_triggers_destroy(triggers
);
5967 * RCU read lock must be held by the caller.
5970 void ust_app_synchronize_all_channels(struct ltt_ust_session
*usess
,
5971 struct ust_app_session
*ua_sess
,
5972 struct ust_app
*app
)
5975 struct cds_lfht_iter uchan_iter
;
5976 struct ltt_ust_channel
*uchan
;
5978 LTTNG_ASSERT(usess
);
5979 LTTNG_ASSERT(ua_sess
);
5981 ASSERT_RCU_READ_LOCKED();
5983 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5985 struct ust_app_channel
*ua_chan
;
5986 struct cds_lfht_iter uevent_iter
;
5987 struct ltt_ust_event
*uevent
;
5990 * Search for a matching ust_app_channel. If none is found,
5991 * create it. Creating the channel will cause the ua_chan
5992 * structure to be allocated, the channel buffers to be
5993 * allocated (if necessary) and sent to the application, and
5994 * all enabled contexts will be added to the channel.
5996 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5997 app
, uchan
, &ua_chan
);
5999 /* Tracer is probably gone or ENOMEM. */
6004 /* ua_chan will be NULL for the metadata channel */
6008 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
6010 ret
= ust_app_channel_synchronize_event(ua_chan
,
6017 if (ua_chan
->enabled
!= uchan
->enabled
) {
6018 ret
= uchan
->enabled
?
6019 enable_ust_app_channel(ua_sess
, uchan
, app
) :
6020 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
6031 * The caller must ensure that the application is compatible and is tracked
6032 * by the process attribute trackers.
6035 void ust_app_synchronize(struct ltt_ust_session
*usess
,
6036 struct ust_app
*app
)
6039 struct ust_app_session
*ua_sess
= NULL
;
6042 * The application's configuration should only be synchronized for
6045 LTTNG_ASSERT(usess
->active
);
6047 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
6049 /* Tracer is probably gone or ENOMEM. */
6051 destroy_app_session(app
, ua_sess
);
6055 LTTNG_ASSERT(ua_sess
);
6057 pthread_mutex_lock(&ua_sess
->lock
);
6058 if (ua_sess
->deleted
) {
6059 goto deleted_session
;
6064 ust_app_synchronize_all_channels(usess
, ua_sess
, app
);
6067 * Create the metadata for the application. This returns gracefully if a
6068 * metadata was already set for the session.
6070 * The metadata channel must be created after the data channels as the
6071 * consumer daemon assumes this ordering. When interacting with a relay
6072 * daemon, the consumer will use this assumption to send the
6073 * "STREAMS_SENT" message to the relay daemon.
6075 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
6077 ERR("Metadata creation failed for app sock %d for session id %" PRIu64
,
6078 app
->sock
, usess
->id
);
6084 pthread_mutex_unlock(&ua_sess
->lock
);
6090 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6092 struct ust_app_session
*ua_sess
;
6094 ua_sess
= lookup_session_by_app(usess
, app
);
6095 if (ua_sess
== NULL
) {
6098 destroy_app_session(app
, ua_sess
);
6102 * Add channels/events from UST global domain to registered apps at sock.
6104 * Called with session lock held.
6105 * Called with RCU read-side lock held.
6107 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6109 LTTNG_ASSERT(usess
);
6110 LTTNG_ASSERT(usess
->active
);
6111 ASSERT_RCU_READ_LOCKED();
6113 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
6114 app
->sock
, usess
->id
);
6116 if (!app
->compatible
) {
6119 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
6121 trace_ust_id_tracker_lookup(
6122 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
6124 trace_ust_id_tracker_lookup(
6125 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
6128 * Synchronize the application's internal tracing configuration
6129 * and start tracing.
6131 ust_app_synchronize(usess
, app
);
6132 ust_app_start_trace(usess
, app
);
6134 ust_app_global_destroy(usess
, app
);
6139 * Add all event notifiers to an application.
6141 * Called with session lock held.
6142 * Called with RCU read-side lock held.
6144 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
6146 ASSERT_RCU_READ_LOCKED();
6148 DBG2("UST application global event notifier rules update: app = '%s', pid = %d",
6149 app
->name
, app
->pid
);
6151 if (!app
->compatible
|| !ust_app_supports_notifiers(app
)) {
6155 if (app
->event_notifier_group
.object
== NULL
) {
6156 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s', pid = %d",
6157 app
->name
, app
->pid
);
6161 ust_app_synchronize_event_notifier_rules(app
);
6165 * Called with session lock held.
6167 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
6169 struct lttng_ht_iter iter
;
6170 struct ust_app
*app
;
6173 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6174 ust_app_global_update(usess
, app
);
6179 void ust_app_global_update_all_event_notifier_rules(void)
6181 struct lttng_ht_iter iter
;
6182 struct ust_app
*app
;
6185 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6186 ust_app_global_update_event_notifier_rules(app
);
6193 * Add context to a specific channel for global UST domain.
6195 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
6196 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
6199 struct lttng_ht_node_str
*ua_chan_node
;
6200 struct lttng_ht_iter iter
, uiter
;
6201 struct ust_app_channel
*ua_chan
= NULL
;
6202 struct ust_app_session
*ua_sess
;
6203 struct ust_app
*app
;
6205 LTTNG_ASSERT(usess
->active
);
6208 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6209 if (!app
->compatible
) {
6211 * TODO: In time, we should notice the caller of this error by
6212 * telling him that this is a version error.
6216 ua_sess
= lookup_session_by_app(usess
, app
);
6217 if (ua_sess
== NULL
) {
6221 pthread_mutex_lock(&ua_sess
->lock
);
6223 if (ua_sess
->deleted
) {
6224 pthread_mutex_unlock(&ua_sess
->lock
);
6228 /* Lookup channel in the ust app session */
6229 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
6230 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6231 if (ua_chan_node
== NULL
) {
6234 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
6236 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
6241 pthread_mutex_unlock(&ua_sess
->lock
);
6249 * Receive registration and populate the given msg structure.
6251 * On success return 0 else a negative value returned by the ustctl call.
6253 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
6256 uint32_t pid
, ppid
, uid
, gid
;
6260 ret
= lttng_ust_ctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
6261 &pid
, &ppid
, &uid
, &gid
,
6262 &msg
->bits_per_long
,
6263 &msg
->uint8_t_alignment
,
6264 &msg
->uint16_t_alignment
,
6265 &msg
->uint32_t_alignment
,
6266 &msg
->uint64_t_alignment
,
6267 &msg
->long_alignment
,
6274 case LTTNG_UST_ERR_EXITING
:
6275 DBG3("UST app recv reg message failed. Application died");
6277 case LTTNG_UST_ERR_UNSUP_MAJOR
:
6278 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
6279 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
6280 LTTNG_UST_ABI_MINOR_VERSION
);
6283 ERR("UST app recv reg message failed with ret %d", ret
);
6288 msg
->pid
= (pid_t
) pid
;
6289 msg
->ppid
= (pid_t
) ppid
;
6290 msg
->uid
= (uid_t
) uid
;
6291 msg
->gid
= (gid_t
) gid
;
6298 * Return a ust app session object using the application object and the
6299 * session object descriptor has a key. If not found, NULL is returned.
6300 * A RCU read side lock MUST be acquired when calling this function.
6302 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
6305 struct lttng_ht_node_ulong
*node
;
6306 struct lttng_ht_iter iter
;
6307 struct ust_app_session
*ua_sess
= NULL
;
6310 ASSERT_RCU_READ_LOCKED();
6312 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
6313 node
= lttng_ht_iter_get_node_ulong(&iter
);
6315 DBG2("UST app session find by objd %d not found", objd
);
6319 ua_sess
= lttng::utils::container_of(node
, &ust_app_session::ust_objd_node
);
6326 * Return a ust app channel object using the application object and the channel
6327 * object descriptor has a key. If not found, NULL is returned. A RCU read side
6328 * lock MUST be acquired before calling this function.
6330 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
6333 struct lttng_ht_node_ulong
*node
;
6334 struct lttng_ht_iter iter
;
6335 struct ust_app_channel
*ua_chan
= NULL
;
6338 ASSERT_RCU_READ_LOCKED();
6340 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
6341 node
= lttng_ht_iter_get_node_ulong(&iter
);
6343 DBG2("UST app channel find by objd %d not found", objd
);
6347 ua_chan
= lttng::utils::container_of(node
, &ust_app_channel::ust_objd_node
);
6354 * Reply to a register channel notification from an application on the notify
6355 * socket. The channel metadata is also created.
6357 * The session UST registry lock is acquired in this function.
6359 * On success 0 is returned else a negative value.
6361 static int handle_app_register_channel_notification(int sock
,
6363 struct lttng_ust_ctl_field
*raw_context_fields
,
6364 size_t context_field_count
)
6366 int ret
, ret_code
= 0;
6368 uint64_t chan_reg_key
;
6369 struct ust_app
*app
;
6370 struct ust_app_channel
*ua_chan
;
6371 struct ust_app_session
*ua_sess
;
6372 auto ust_ctl_context_fields
= lttng::make_unique_wrapper
<lttng_ust_ctl_field
, lttng::free
>(
6373 raw_context_fields
);
6375 lttng::urcu::read_lock_guard read_lock_guard
;
6377 /* Lookup application. If not found, there is a code flow error. */
6378 app
= find_app_by_notify_sock(sock
);
6380 DBG("Application socket %d is being torn down. Abort event notify",
6385 /* Lookup channel by UST object descriptor. */
6386 ua_chan
= find_channel_by_objd(app
, cobjd
);
6388 DBG("Application channel is being torn down. Abort event notify");
6392 LTTNG_ASSERT(ua_chan
->session
);
6393 ua_sess
= ua_chan
->session
;
6395 /* Get right session registry depending on the session buffer type. */
6396 auto locked_registry_session
= get_locked_session_registry(ua_sess
);
6397 if (!locked_registry_session
) {
6398 DBG("Application session is being torn down. Abort event notify");
6402 /* Depending on the buffer type, a different channel key is used. */
6403 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6404 chan_reg_key
= ua_chan
->tracing_channel_id
;
6406 chan_reg_key
= ua_chan
->key
;
6409 auto& ust_reg_chan
= locked_registry_session
->get_channel(chan_reg_key
);
6411 /* Channel id is set during the object creation. */
6412 chan_id
= ust_reg_chan
.id
;
6415 * The application returns the typing information of the channel's
6416 * context fields. In per-PID buffering mode, this is the first and only
6417 * time we get this information. It is our chance to finalize the
6418 * initialiation of the channel and serialize it's layout's description
6419 * to the trace's metadata.
6421 * However, in per-UID buffering mode, every application will provide
6422 * this information (redundantly). The first time will allow us to
6423 * complete the initialization. The following times, we simply validate
6424 * that all apps provide the same typing for the context fields as a
6428 auto app_context_fields
= lsu::create_trace_fields_from_ust_ctl_fields(
6429 *locked_registry_session
, ust_ctl_context_fields
.get(),
6430 context_field_count
,
6431 lst::field_location::root::EVENT_RECORD_COMMON_CONTEXT
);
6433 if (!ust_reg_chan
.is_registered()) {
6434 lst::type::cuptr event_context
= app_context_fields
.size() ?
6435 lttng::make_unique
<lst::structure_type
>(
6436 0, std::move(app_context_fields
)) :
6439 ust_reg_chan
.set_event_context(std::move(event_context
));
6442 * Validate that the context fields match between
6443 * registry and newcoming application.
6445 bool context_fields_match
;
6446 const auto *previous_event_context
= ust_reg_chan
.get_event_context();
6448 if (!previous_event_context
) {
6449 context_fields_match
= app_context_fields
.size() == 0;
6451 const lst::structure_type
app_event_context_struct(
6452 0, std::move(app_context_fields
));
6454 context_fields_match
= *previous_event_context
==
6455 app_event_context_struct
;
6458 if (!context_fields_match
) {
6459 ERR("Registering application channel due to context field mismatch: pid = %d, sock = %d",
6460 app
->pid
, app
->sock
);
6465 } catch (std::exception
& ex
) {
6466 ERR("Failed to handle application context: %s", ex
.what());
6472 DBG3("UST app replying to register channel key %" PRIu64
6473 " with id %u, ret = %d", chan_reg_key
, chan_id
,
6476 ret
= lttng_ust_ctl_reply_register_channel(sock
, chan_id
,
6477 ust_reg_chan
.header_type_
== lst::stream_class::header_type::COMPACT
?
6478 LTTNG_UST_CTL_CHANNEL_HEADER_COMPACT
:
6479 LTTNG_UST_CTL_CHANNEL_HEADER_LARGE
,
6482 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6483 DBG3("UST app reply channel failed. Application died: pid = %d, sock = %d",
6484 app
->pid
, app
->sock
);
6485 } else if (ret
== -EAGAIN
) {
6486 WARN("UST app reply channel failed. Communication time out: pid = %d, sock = %d",
6487 app
->pid
, app
->sock
);
6489 ERR("UST app reply channel failed with ret %d: pid = %d, sock = %d",
6490 ret
, app
->pid
, app
->sock
);
6496 /* This channel registry's registration is completed. */
6497 ust_reg_chan
.set_as_registered();
6503 * Add event to the UST channel registry. When the event is added to the
6504 * registry, the metadata is also created. Once done, this replies to the
6505 * application with the appropriate error code.
6507 * The session UST registry lock is acquired in the function.
6509 * On success 0 is returned else a negative value.
6511 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, const char *name
,
6512 char *raw_signature
, size_t nr_fields
, struct lttng_ust_ctl_field
*raw_fields
,
6513 int loglevel_value
, char *raw_model_emf_uri
)
6516 uint32_t event_id
= 0;
6517 uint64_t chan_reg_key
;
6518 struct ust_app
*app
;
6519 struct ust_app_channel
*ua_chan
;
6520 struct ust_app_session
*ua_sess
;
6521 lttng::urcu::read_lock_guard rcu_lock
;
6522 auto signature
= lttng::make_unique_wrapper
<char, lttng::free
>(raw_signature
);
6523 auto fields
= lttng::make_unique_wrapper
<lttng_ust_ctl_field
, lttng::free
>(raw_fields
);
6524 auto model_emf_uri
= lttng::make_unique_wrapper
<char, lttng::free
>(raw_model_emf_uri
);
6526 /* Lookup application. If not found, there is a code flow error. */
6527 app
= find_app_by_notify_sock(sock
);
6529 DBG("Application socket %d is being torn down. Abort event notify",
6534 /* Lookup channel by UST object descriptor. */
6535 ua_chan
= find_channel_by_objd(app
, cobjd
);
6537 DBG("Application channel is being torn down. Abort event notify");
6541 LTTNG_ASSERT(ua_chan
->session
);
6542 ua_sess
= ua_chan
->session
;
6544 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6545 chan_reg_key
= ua_chan
->tracing_channel_id
;
6547 chan_reg_key
= ua_chan
->key
;
6551 auto locked_registry
= get_locked_session_registry(ua_sess
);
6552 if (locked_registry
) {
6554 * From this point on, this call acquires the ownership of the signature,
6555 * fields and model_emf_uri meaning any free are done inside it if needed.
6556 * These three variables MUST NOT be read/write after this.
6559 auto& channel
= locked_registry
->get_channel(chan_reg_key
);
6561 /* event_id is set on success. */
6562 channel
.add_event(sobjd
, cobjd
, name
, signature
.get(),
6563 lsu::create_trace_fields_from_ust_ctl_fields(
6564 *locked_registry
, fields
.get(),
6566 lst::field_location::root::
6567 EVENT_RECORD_PAYLOAD
),
6569 model_emf_uri
.get() ?
6570 nonstd::optional
<std::string
>(
6571 model_emf_uri
.get()) :
6573 ua_sess
->buffer_type
, *app
, event_id
);
6575 } catch (const std::exception
& ex
) {
6576 ERR("Failed to add event `%s` to registry session: %s", name
,
6578 /* Inform the application of the error; don't return directly. */
6582 DBG("Application session is being torn down. Abort event notify");
6588 * The return value is returned to ustctl so in case of an error, the
6589 * application can be notified. In case of an error, it's important not to
6590 * return a negative error or else the application will get closed.
6592 ret
= lttng_ust_ctl_reply_register_event(sock
, event_id
, ret_code
);
6594 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6595 DBG3("UST app reply event failed. Application died: pid = %d, sock = %d.",
6596 app
->pid
, app
->sock
);
6597 } else if (ret
== -EAGAIN
) {
6598 WARN("UST app reply event failed. Communication time out: pid = %d, sock = %d",
6599 app
->pid
, app
->sock
);
6601 ERR("UST app reply event failed with ret %d: pid = %d, sock = %d",
6602 ret
, app
->pid
, app
->sock
);
6605 * No need to wipe the create event since the application socket will
6606 * get close on error hence cleaning up everything by itself.
6611 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6617 * Add enum to the UST session registry. Once done, this replies to the
6618 * application with the appropriate error code.
6620 * The session UST registry lock is acquired within this function.
6622 * On success 0 is returned else a negative value.
6624 static int add_enum_ust_registry(int sock
, int sobjd
, const char *name
,
6625 struct lttng_ust_ctl_enum_entry
*raw_entries
, size_t nr_entries
)
6628 struct ust_app
*app
;
6629 struct ust_app_session
*ua_sess
;
6630 uint64_t enum_id
= -1ULL;
6631 lttng::urcu::read_lock_guard read_lock_guard
;
6632 auto entries
= lttng::make_unique_wrapper
<struct lttng_ust_ctl_enum_entry
, lttng::free
>(
6635 /* Lookup application. If not found, there is a code flow error. */
6636 app
= find_app_by_notify_sock(sock
);
6638 /* Return an error since this is not an error */
6639 DBG("Application socket %d is being torn down. Aborting enum registration",
6644 /* Lookup session by UST object descriptor. */
6645 ua_sess
= find_session_by_objd(app
, sobjd
);
6647 /* Return an error since this is not an error */
6648 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6652 auto locked_registry
= get_locked_session_registry(ua_sess
);
6653 if (!locked_registry
) {
6654 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6659 * From this point on, the callee acquires the ownership of
6660 * entries. The variable entries MUST NOT be read/written after
6663 int application_reply_code
;
6665 locked_registry
->create_or_find_enum(
6666 sobjd
, name
, entries
.release(), nr_entries
, &enum_id
);
6667 application_reply_code
= 0;
6668 } catch (const std::exception
& ex
) {
6669 ERR("%s: %s", fmt::format("Failed to create or find enumeration provided by application: app = {}, enumeration name = {}",
6670 *app
, name
).c_str(), ex
.what());
6671 application_reply_code
= -1;
6675 * The return value is returned to ustctl so in case of an error, the
6676 * application can be notified. In case of an error, it's important not to
6677 * return a negative error or else the application will get closed.
6679 ret
= lttng_ust_ctl_reply_register_enum(sock
, enum_id
, application_reply_code
);
6681 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6682 DBG3("UST app reply enum failed. Application died: pid = %d, sock = %d",
6683 app
->pid
, app
->sock
);
6684 } else if (ret
== -EAGAIN
) {
6685 WARN("UST app reply enum failed. Communication time out: pid = %d, sock = %d",
6686 app
->pid
, app
->sock
);
6688 ERR("UST app reply enum failed with ret %d: pid = %d, sock = %d",
6689 ret
, app
->pid
, app
->sock
);
6692 * No need to wipe the create enum since the application socket will
6693 * get close on error hence cleaning up everything by itself.
6698 DBG3("UST registry enum %s added successfully or already found", name
);
6703 * Handle application notification through the given notify socket.
6705 * Return 0 on success or else a negative value.
6707 int ust_app_recv_notify(int sock
)
6710 enum lttng_ust_ctl_notify_cmd cmd
;
6712 DBG3("UST app receiving notify from sock %d", sock
);
6714 ret
= lttng_ust_ctl_recv_notify(sock
, &cmd
);
6716 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6717 DBG3("UST app recv notify failed. Application died: sock = %d",
6719 } else if (ret
== -EAGAIN
) {
6720 WARN("UST app recv notify failed. Communication time out: sock = %d",
6723 ERR("UST app recv notify failed with ret %d: sock = %d",
6730 case LTTNG_UST_CTL_NOTIFY_CMD_EVENT
:
6732 int sobjd
, cobjd
, loglevel_value
;
6733 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6735 struct lttng_ust_ctl_field
*fields
;
6737 DBG2("UST app ustctl register event received");
6739 ret
= lttng_ust_ctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel_value
,
6740 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
6742 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6743 DBG3("UST app recv event failed. Application died: sock = %d",
6745 } else if (ret
== -EAGAIN
) {
6746 WARN("UST app recv event failed. Communication time out: sock = %d",
6749 ERR("UST app recv event failed with ret %d: sock = %d",
6756 lttng::urcu::read_lock_guard rcu_lock
;
6757 const struct ust_app
*app
= find_app_by_notify_sock(sock
);
6759 DBG("Application socket %d is being torn down. Abort event notify", sock
);
6765 if ((!fields
&& nr_fields
> 0) || (fields
&& nr_fields
== 0)) {
6766 ERR("Invalid return value from lttng_ust_ctl_recv_register_event: fields = %p, nr_fields = %zu",
6774 * Add event to the UST registry coming from the notify socket. This
6775 * call will free if needed the sig, fields and model_emf_uri. This
6776 * code path loses the ownsership of these variables and transfer them
6777 * to the this function.
6779 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6780 fields
, loglevel_value
, model_emf_uri
);
6787 case LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL
:
6791 struct lttng_ust_ctl_field
*context_fields
;
6793 DBG2("UST app ustctl register channel received");
6795 ret
= lttng_ust_ctl_recv_register_channel(
6796 sock
, &sobjd
, &cobjd
, &field_count
, &context_fields
);
6798 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6799 DBG3("UST app recv channel failed. Application died: sock = %d",
6801 } else if (ret
== -EAGAIN
) {
6802 WARN("UST app recv channel failed. Communication time out: sock = %d",
6805 ERR("UST app recv channel failed with ret %d: sock = %d", ret
,
6812 * The fields ownership are transfered to this function call meaning
6813 * that if needed it will be freed. After this, it's invalid to access
6814 * fields or clean them up.
6816 ret
= handle_app_register_channel_notification(sock
, cobjd
, context_fields
, field_count
);
6823 case LTTNG_UST_CTL_NOTIFY_CMD_ENUM
:
6826 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
6828 struct lttng_ust_ctl_enum_entry
*entries
;
6830 DBG2("UST app ustctl register enum received");
6832 ret
= lttng_ust_ctl_recv_register_enum(sock
, &sobjd
, name
,
6833 &entries
, &nr_entries
);
6835 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6836 DBG3("UST app recv enum failed. Application died: sock = %d",
6838 } else if (ret
== -EAGAIN
) {
6839 WARN("UST app recv enum failed. Communication time out: sock = %d",
6842 ERR("UST app recv enum failed with ret %d: sock = %d",
6848 /* Callee assumes ownership of entries. */
6849 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6850 entries
, nr_entries
);
6858 /* Should NEVER happen. */
6867 * Once the notify socket hangs up, this is called. First, it tries to find the
6868 * corresponding application. On failure, the call_rcu to close the socket is
6869 * executed. If an application is found, it tries to delete it from the notify
6870 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6872 * Note that an object needs to be allocated here so on ENOMEM failure, the
6873 * call RCU is not done but the rest of the cleanup is.
6875 void ust_app_notify_sock_unregister(int sock
)
6878 struct lttng_ht_iter iter
;
6879 struct ust_app
*app
;
6880 struct ust_app_notify_sock_obj
*obj
;
6882 LTTNG_ASSERT(sock
>= 0);
6886 obj
= zmalloc
<ust_app_notify_sock_obj
>();
6889 * An ENOMEM is kind of uncool. If this strikes we continue the
6890 * procedure but the call_rcu will not be called. In this case, we
6891 * accept the fd leak rather than possibly creating an unsynchronized
6892 * state between threads.
6894 * TODO: The notify object should be created once the notify socket is
6895 * registered and stored independantely from the ust app object. The
6896 * tricky part is to synchronize the teardown of the application and
6897 * this notify object. Let's keep that in mind so we can avoid this
6898 * kind of shenanigans with ENOMEM in the teardown path.
6905 DBG("UST app notify socket unregister %d", sock
);
6908 * Lookup application by notify socket. If this fails, this means that the
6909 * hash table delete has already been done by the application
6910 * unregistration process so we can safely close the notify socket in a
6913 app
= find_app_by_notify_sock(sock
);
6918 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6921 * Whatever happens here either we fail or succeed, in both cases we have
6922 * to close the socket after a grace period to continue to the call RCU
6923 * here. If the deletion is successful, the application is not visible
6924 * anymore by other threads and is it fails it means that it was already
6925 * deleted from the hash table so either way we just have to close the
6928 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6934 * Close socket after a grace period to avoid for the socket to be reused
6935 * before the application object is freed creating potential race between
6936 * threads trying to add unique in the global hash table.
6939 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6944 * Destroy a ust app data structure and free its memory.
6946 void ust_app_destroy(struct ust_app
*app
)
6952 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6956 * Take a snapshot for a given UST session. The snapshot is sent to the given
6959 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6961 enum lttng_error_code
ust_app_snapshot_record(
6962 const struct ltt_ust_session
*usess
,
6963 const struct consumer_output
*output
,
6964 uint64_t nb_packets_per_stream
)
6967 enum lttng_error_code status
= LTTNG_OK
;
6968 struct lttng_ht_iter iter
;
6969 struct ust_app
*app
;
6970 char *trace_path
= NULL
;
6972 LTTNG_ASSERT(usess
);
6973 LTTNG_ASSERT(output
);
6977 switch (usess
->buffer_type
) {
6978 case LTTNG_BUFFER_PER_UID
:
6980 struct buffer_reg_uid
*reg
;
6982 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6983 struct buffer_reg_channel
*buf_reg_chan
;
6984 struct consumer_socket
*socket
;
6985 char pathname
[PATH_MAX
];
6986 size_t consumer_path_offset
= 0;
6988 if (!reg
->registry
->reg
.ust
->_metadata_key
) {
6989 /* Skip since no metadata is present */
6993 /* Get consumer socket to use to push the metadata.*/
6994 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6997 status
= LTTNG_ERR_INVALID
;
7001 memset(pathname
, 0, sizeof(pathname
));
7002 ret
= snprintf(pathname
, sizeof(pathname
),
7003 DEFAULT_UST_TRACE_UID_PATH
,
7004 reg
->uid
, reg
->bits_per_long
);
7006 PERROR("snprintf snapshot path");
7007 status
= LTTNG_ERR_INVALID
;
7010 /* Free path allowed on previous iteration. */
7012 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
7013 &consumer_path_offset
);
7015 status
= LTTNG_ERR_INVALID
;
7018 /* Add the UST default trace dir to path. */
7019 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7020 buf_reg_chan
, node
.node
) {
7021 status
= consumer_snapshot_channel(socket
,
7022 buf_reg_chan
->consumer_key
,
7023 output
, 0, &trace_path
[consumer_path_offset
],
7024 nb_packets_per_stream
);
7025 if (status
!= LTTNG_OK
) {
7029 status
= consumer_snapshot_channel(socket
,
7030 reg
->registry
->reg
.ust
->_metadata_key
, output
, 1,
7031 &trace_path
[consumer_path_offset
], 0);
7032 if (status
!= LTTNG_OK
) {
7038 case LTTNG_BUFFER_PER_PID
:
7040 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7041 struct consumer_socket
*socket
;
7042 struct lttng_ht_iter chan_iter
;
7043 struct ust_app_channel
*ua_chan
;
7044 struct ust_app_session
*ua_sess
;
7045 lsu::registry_session
*registry
;
7046 char pathname
[PATH_MAX
];
7047 size_t consumer_path_offset
= 0;
7049 ua_sess
= lookup_session_by_app(usess
, app
);
7051 /* Session not associated with this app. */
7055 /* Get the right consumer socket for the application. */
7056 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7059 status
= LTTNG_ERR_INVALID
;
7063 /* Add the UST default trace dir to path. */
7064 memset(pathname
, 0, sizeof(pathname
));
7065 ret
= snprintf(pathname
, sizeof(pathname
), "%s",
7068 status
= LTTNG_ERR_INVALID
;
7069 PERROR("snprintf snapshot path");
7072 /* Free path allowed on previous iteration. */
7074 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
7075 &consumer_path_offset
);
7077 status
= LTTNG_ERR_INVALID
;
7080 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7081 ua_chan
, node
.node
) {
7082 status
= consumer_snapshot_channel(socket
,
7083 ua_chan
->key
, output
, 0,
7084 &trace_path
[consumer_path_offset
],
7085 nb_packets_per_stream
);
7089 case LTTNG_ERR_CHAN_NOT_FOUND
:
7096 registry
= get_session_registry(ua_sess
);
7098 DBG("Application session is being torn down. Skip application.");
7101 status
= consumer_snapshot_channel(socket
,
7102 registry
->_metadata_key
, output
, 1,
7103 &trace_path
[consumer_path_offset
], 0);
7107 case LTTNG_ERR_CHAN_NOT_FOUND
:
7127 * Return the size taken by one more packet per stream.
7129 uint64_t ust_app_get_size_one_more_packet_per_stream(
7130 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
7132 uint64_t tot_size
= 0;
7133 struct ust_app
*app
;
7134 struct lttng_ht_iter iter
;
7136 LTTNG_ASSERT(usess
);
7138 switch (usess
->buffer_type
) {
7139 case LTTNG_BUFFER_PER_UID
:
7141 struct buffer_reg_uid
*reg
;
7143 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7144 struct buffer_reg_channel
*buf_reg_chan
;
7147 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7148 buf_reg_chan
, node
.node
) {
7149 if (cur_nr_packets
>= buf_reg_chan
->num_subbuf
) {
7151 * Don't take channel into account if we
7152 * already grab all its packets.
7156 tot_size
+= buf_reg_chan
->subbuf_size
* buf_reg_chan
->stream_count
;
7162 case LTTNG_BUFFER_PER_PID
:
7165 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7166 struct ust_app_channel
*ua_chan
;
7167 struct ust_app_session
*ua_sess
;
7168 struct lttng_ht_iter chan_iter
;
7170 ua_sess
= lookup_session_by_app(usess
, app
);
7172 /* Session not associated with this app. */
7176 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7177 ua_chan
, node
.node
) {
7178 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
7180 * Don't take channel into account if we
7181 * already grab all its packets.
7185 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
7199 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
7200 struct cds_list_head
*buffer_reg_uid_list
,
7201 struct consumer_output
*consumer
, uint64_t uchan_id
,
7202 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
7205 uint64_t consumer_chan_key
;
7210 ret
= buffer_reg_uid_consumer_channel_key(
7211 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
7219 ret
= consumer_get_lost_packets(ust_session_id
,
7220 consumer_chan_key
, consumer
, lost
);
7222 ret
= consumer_get_discarded_events(ust_session_id
,
7223 consumer_chan_key
, consumer
, discarded
);
7230 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
7231 struct ltt_ust_channel
*uchan
,
7232 struct consumer_output
*consumer
, int overwrite
,
7233 uint64_t *discarded
, uint64_t *lost
)
7236 struct lttng_ht_iter iter
;
7237 struct lttng_ht_node_str
*ua_chan_node
;
7238 struct ust_app
*app
;
7239 struct ust_app_session
*ua_sess
;
7240 struct ust_app_channel
*ua_chan
;
7247 * Iterate over every registered applications. Sum counters for
7248 * all applications containing requested session and channel.
7250 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7251 struct lttng_ht_iter uiter
;
7253 ua_sess
= lookup_session_by_app(usess
, app
);
7254 if (ua_sess
== NULL
) {
7259 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
7260 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
7261 /* If the session is found for the app, the channel must be there */
7262 LTTNG_ASSERT(ua_chan_node
);
7264 ua_chan
= lttng::utils::container_of(ua_chan_node
, &ust_app_channel::node
);
7269 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
7276 uint64_t _discarded
;
7278 ret
= consumer_get_discarded_events(usess
->id
,
7279 ua_chan
->key
, consumer
, &_discarded
);
7283 (*discarded
) += _discarded
;
7292 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
7293 struct ust_app
*app
)
7296 struct ust_app_session
*ua_sess
;
7298 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
7302 ua_sess
= lookup_session_by_app(usess
, app
);
7303 if (ua_sess
== NULL
) {
7304 /* The session is in teardown process. Ignore and continue. */
7308 pthread_mutex_lock(&ua_sess
->lock
);
7310 if (ua_sess
->deleted
) {
7314 pthread_mutex_lock(&app
->sock_lock
);
7315 ret
= lttng_ust_ctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
7316 pthread_mutex_unlock(&app
->sock_lock
);
7319 pthread_mutex_unlock(&ua_sess
->lock
);
7323 health_code_update();
7328 * Regenerate the statedump for each app in the session.
7330 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
7333 struct lttng_ht_iter iter
;
7334 struct ust_app
*app
;
7336 DBG("Regenerating the metadata for all UST apps");
7340 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7341 if (!app
->compatible
) {
7345 ret
= ust_app_regenerate_statedump(usess
, app
);
7347 /* Continue to the next app even on error */
7358 * Rotate all the channels of a session.
7360 * Return LTTNG_OK on success or else an LTTng error code.
7362 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
7365 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7366 struct lttng_ht_iter iter
;
7367 struct ust_app
*app
;
7368 struct ltt_ust_session
*usess
= session
->ust_session
;
7370 LTTNG_ASSERT(usess
);
7374 switch (usess
->buffer_type
) {
7375 case LTTNG_BUFFER_PER_UID
:
7377 struct buffer_reg_uid
*reg
;
7379 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7380 struct buffer_reg_channel
*buf_reg_chan
;
7381 struct consumer_socket
*socket
;
7383 /* Get consumer socket to use to push the metadata.*/
7384 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7387 cmd_ret
= LTTNG_ERR_INVALID
;
7391 /* Rotate the data channels. */
7392 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7393 buf_reg_chan
, node
.node
) {
7394 ret
= consumer_rotate_channel(socket
,
7395 buf_reg_chan
->consumer_key
,
7397 /* is_metadata_channel */ false);
7399 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7405 * The metadata channel might not be present.
7407 * Consumer stream allocation can be done
7408 * asynchronously and can fail on intermediary
7409 * operations (i.e add context) and lead to data
7410 * channels created with no metadata channel.
7412 if (!reg
->registry
->reg
.ust
->_metadata_key
) {
7413 /* Skip since no metadata is present. */
7418 auto locked_registry
= reg
->registry
->reg
.ust
->lock();
7419 (void) push_metadata(locked_registry
, usess
->consumer
);
7422 ret
= consumer_rotate_channel(socket
,
7423 reg
->registry
->reg
.ust
->_metadata_key
,
7425 /* is_metadata_channel */ true);
7427 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7433 case LTTNG_BUFFER_PER_PID
:
7435 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7436 struct consumer_socket
*socket
;
7437 struct lttng_ht_iter chan_iter
;
7438 struct ust_app_channel
*ua_chan
;
7439 struct ust_app_session
*ua_sess
;
7440 lsu::registry_session
*registry
;
7442 ua_sess
= lookup_session_by_app(usess
, app
);
7444 /* Session not associated with this app. */
7448 /* Get the right consumer socket for the application. */
7449 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7452 cmd_ret
= LTTNG_ERR_INVALID
;
7456 registry
= get_session_registry(ua_sess
);
7458 DBG("Application session is being torn down. Skip application.");
7462 /* Rotate the data channels. */
7463 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7464 ua_chan
, node
.node
) {
7465 ret
= consumer_rotate_channel(socket
,
7468 /* is_metadata_channel */ false);
7470 /* Per-PID buffer and application going away. */
7471 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7473 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7478 /* Rotate the metadata channel. */
7480 auto locked_registry
= registry
->lock();
7482 (void) push_metadata(locked_registry
, usess
->consumer
);
7484 ret
= consumer_rotate_channel(socket
,
7485 registry
->_metadata_key
,
7487 /* is_metadata_channel */ true);
7489 /* Per-PID buffer and application going away. */
7490 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7492 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7510 enum lttng_error_code
ust_app_create_channel_subdirectories(
7511 const struct ltt_ust_session
*usess
)
7513 enum lttng_error_code ret
= LTTNG_OK
;
7514 struct lttng_ht_iter iter
;
7515 enum lttng_trace_chunk_status chunk_status
;
7516 char *pathname_index
;
7519 LTTNG_ASSERT(usess
->current_trace_chunk
);
7522 switch (usess
->buffer_type
) {
7523 case LTTNG_BUFFER_PER_UID
:
7525 struct buffer_reg_uid
*reg
;
7527 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7528 fmt_ret
= asprintf(&pathname_index
,
7529 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7530 reg
->uid
, reg
->bits_per_long
);
7532 ERR("Failed to format channel index directory");
7533 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7538 * Create the index subdirectory which will take care
7539 * of implicitly creating the channel's path.
7541 chunk_status
= lttng_trace_chunk_create_subdirectory(
7542 usess
->current_trace_chunk
,
7544 free(pathname_index
);
7545 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7546 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7552 case LTTNG_BUFFER_PER_PID
:
7554 struct ust_app
*app
;
7557 * Create the toplevel ust/ directory in case no apps are running.
7559 chunk_status
= lttng_trace_chunk_create_subdirectory(
7560 usess
->current_trace_chunk
,
7561 DEFAULT_UST_TRACE_DIR
);
7562 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7563 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7567 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7569 struct ust_app_session
*ua_sess
;
7570 lsu::registry_session
*registry
;
7572 ua_sess
= lookup_session_by_app(usess
, app
);
7574 /* Session not associated with this app. */
7578 registry
= get_session_registry(ua_sess
);
7580 DBG("Application session is being torn down. Skip application.");
7584 fmt_ret
= asprintf(&pathname_index
,
7585 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7588 ERR("Failed to format channel index directory");
7589 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7593 * Create the index subdirectory which will take care
7594 * of implicitly creating the channel's path.
7596 chunk_status
= lttng_trace_chunk_create_subdirectory(
7597 usess
->current_trace_chunk
,
7599 free(pathname_index
);
7600 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7601 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7618 * Clear all the channels of a session.
7620 * Return LTTNG_OK on success or else an LTTng error code.
7622 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7625 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7626 struct lttng_ht_iter iter
;
7627 struct ust_app
*app
;
7628 struct ltt_ust_session
*usess
= session
->ust_session
;
7630 LTTNG_ASSERT(usess
);
7634 if (usess
->active
) {
7635 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7636 cmd_ret
= LTTNG_ERR_FATAL
;
7640 switch (usess
->buffer_type
) {
7641 case LTTNG_BUFFER_PER_UID
:
7643 struct buffer_reg_uid
*reg
;
7645 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7646 struct buffer_reg_channel
*buf_reg_chan
;
7647 struct consumer_socket
*socket
;
7649 /* Get consumer socket to use to push the metadata.*/
7650 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7653 cmd_ret
= LTTNG_ERR_INVALID
;
7657 /* Clear the data channels. */
7658 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7659 buf_reg_chan
, node
.node
) {
7660 ret
= consumer_clear_channel(socket
,
7661 buf_reg_chan
->consumer_key
);
7668 auto locked_registry
= reg
->registry
->reg
.ust
->lock();
7669 (void) push_metadata(locked_registry
, usess
->consumer
);
7673 * Clear the metadata channel.
7674 * Metadata channel is not cleared per se but we still need to
7675 * perform a rotation operation on it behind the scene.
7677 ret
= consumer_clear_channel(socket
,
7678 reg
->registry
->reg
.ust
->_metadata_key
);
7685 case LTTNG_BUFFER_PER_PID
:
7687 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7688 struct consumer_socket
*socket
;
7689 struct lttng_ht_iter chan_iter
;
7690 struct ust_app_channel
*ua_chan
;
7691 struct ust_app_session
*ua_sess
;
7692 lsu::registry_session
*registry
;
7694 ua_sess
= lookup_session_by_app(usess
, app
);
7696 /* Session not associated with this app. */
7700 /* Get the right consumer socket for the application. */
7701 socket
= consumer_find_socket_by_bitness(app
->abi
.bits_per_long
,
7704 cmd_ret
= LTTNG_ERR_INVALID
;
7708 registry
= get_session_registry(ua_sess
);
7710 DBG("Application session is being torn down. Skip application.");
7714 /* Clear the data channels. */
7715 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7716 ua_chan
, node
.node
) {
7717 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7719 /* Per-PID buffer and application going away. */
7720 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7728 auto locked_registry
= registry
->lock();
7729 (void) push_metadata(locked_registry
, usess
->consumer
);
7733 * Clear the metadata channel.
7734 * Metadata channel is not cleared per se but we still need to
7735 * perform rotation operation on it behind the scene.
7737 ret
= consumer_clear_channel(socket
, registry
->_metadata_key
);
7739 /* Per-PID buffer and application going away. */
7740 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7758 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7759 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7762 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7772 * This function skips the metadata channel as the begin/end timestamps of a
7773 * metadata packet are useless.
7775 * Moreover, opening a packet after a "clear" will cause problems for live
7776 * sessions as it will introduce padding that was not part of the first trace
7777 * chunk. The relay daemon expects the content of the metadata stream of
7778 * successive metadata trace chunks to be strict supersets of one another.
7780 * For example, flushing a packet at the beginning of the metadata stream of
7781 * a trace chunk resulting from a "clear" session command will cause the
7782 * size of the metadata stream of the new trace chunk to not match the size of
7783 * the metadata stream of the original chunk. This will confuse the relay
7784 * daemon as the same "offset" in a metadata stream will no longer point
7785 * to the same content.
7787 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7789 enum lttng_error_code ret
= LTTNG_OK
;
7790 struct lttng_ht_iter iter
;
7791 struct ltt_ust_session
*usess
= session
->ust_session
;
7793 LTTNG_ASSERT(usess
);
7797 switch (usess
->buffer_type
) {
7798 case LTTNG_BUFFER_PER_UID
:
7800 struct buffer_reg_uid
*reg
;
7802 cds_list_for_each_entry (
7803 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7804 struct buffer_reg_channel
*buf_reg_chan
;
7805 struct consumer_socket
*socket
;
7807 socket
= consumer_find_socket_by_bitness(
7808 reg
->bits_per_long
, usess
->consumer
);
7810 ret
= LTTNG_ERR_FATAL
;
7814 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7815 &iter
.iter
, buf_reg_chan
, node
.node
) {
7816 const int open_ret
=
7817 consumer_open_channel_packets(
7819 buf_reg_chan
->consumer_key
);
7822 ret
= LTTNG_ERR_UNK
;
7829 case LTTNG_BUFFER_PER_PID
:
7831 struct ust_app
*app
;
7833 cds_lfht_for_each_entry (
7834 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7835 struct consumer_socket
*socket
;
7836 struct lttng_ht_iter chan_iter
;
7837 struct ust_app_channel
*ua_chan
;
7838 struct ust_app_session
*ua_sess
;
7839 lsu::registry_session
*registry
;
7841 ua_sess
= lookup_session_by_app(usess
, app
);
7843 /* Session not associated with this app. */
7847 /* Get the right consumer socket for the application. */
7848 socket
= consumer_find_socket_by_bitness(
7849 app
->abi
.bits_per_long
, usess
->consumer
);
7851 ret
= LTTNG_ERR_FATAL
;
7855 registry
= get_session_registry(ua_sess
);
7857 DBG("Application session is being torn down. Skip application.");
7861 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7862 &chan_iter
.iter
, ua_chan
, node
.node
) {
7863 const int open_ret
=
7864 consumer_open_channel_packets(
7870 * Per-PID buffer and application going
7873 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7877 ret
= LTTNG_ERR_UNK
;