2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
16 #include <sys/types.h>
18 #include <urcu/compiler.h>
21 #include <common/bytecode/bytecode.h>
22 #include <common/compat/errno.h>
23 #include <common/common.h>
24 #include <common/hashtable/utils.h>
25 #include <lttng/event-rule/event-rule.h>
26 #include <lttng/event-rule/event-rule-internal.h>
27 #include <lttng/event-rule/tracepoint.h>
28 #include <lttng/condition/condition.h>
29 #include <lttng/condition/event-rule-internal.h>
30 #include <lttng/condition/event-rule.h>
31 #include <common/sessiond-comm/sessiond-comm.h>
33 #include "buffer-registry.h"
35 #include "health-sessiond.h"
37 #include "ust-consumer.h"
38 #include "lttng-ust-ctl.h"
39 #include "lttng-ust-error.h"
42 #include "lttng-sessiond.h"
43 #include "notification-thread-commands.h"
47 struct lttng_ht
*ust_app_ht
;
48 struct lttng_ht
*ust_app_ht_by_sock
;
49 struct lttng_ht
*ust_app_ht_by_notify_sock
;
52 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
54 /* Next available channel key. Access under next_channel_key_lock. */
55 static uint64_t _next_channel_key
;
56 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
58 /* Next available session ID. Access under next_session_id_lock. */
59 static uint64_t _next_session_id
;
60 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
63 * Return the incremented value of next_channel_key.
65 static uint64_t get_next_channel_key(void)
69 pthread_mutex_lock(&next_channel_key_lock
);
70 ret
= ++_next_channel_key
;
71 pthread_mutex_unlock(&next_channel_key_lock
);
76 * Return the atomically incremented value of next_session_id.
78 static uint64_t get_next_session_id(void)
82 pthread_mutex_lock(&next_session_id_lock
);
83 ret
= ++_next_session_id
;
84 pthread_mutex_unlock(&next_session_id_lock
);
88 static void copy_channel_attr_to_ustctl(
89 struct ustctl_consumer_channel_attr
*attr
,
90 struct lttng_ust_channel_attr
*uattr
)
92 /* Copy event attributes since the layout is different. */
93 attr
->subbuf_size
= uattr
->subbuf_size
;
94 attr
->num_subbuf
= uattr
->num_subbuf
;
95 attr
->overwrite
= uattr
->overwrite
;
96 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
97 attr
->read_timer_interval
= uattr
->read_timer_interval
;
98 attr
->output
= uattr
->output
;
99 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
103 * Match function for the hash table lookup.
105 * It matches an ust app event based on three attributes which are the event
106 * name, the filter bytecode and the loglevel.
108 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
110 struct ust_app_event
*event
;
111 const struct ust_app_ht_key
*key
;
112 int ev_loglevel_value
;
117 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
119 ev_loglevel_value
= event
->attr
.loglevel
;
121 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
124 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
128 /* Event loglevel. */
129 if (ev_loglevel_value
!= key
->loglevel_type
) {
130 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
131 && key
->loglevel_type
== 0 &&
132 ev_loglevel_value
== -1) {
134 * Match is accepted. This is because on event creation, the
135 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
136 * -1 are accepted for this loglevel type since 0 is the one set by
137 * the API when receiving an enable event.
144 /* One of the filters is NULL, fail. */
145 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
149 if (key
->filter
&& event
->filter
) {
150 /* Both filters exists, check length followed by the bytecode. */
151 if (event
->filter
->len
!= key
->filter
->len
||
152 memcmp(event
->filter
->data
, key
->filter
->data
,
153 event
->filter
->len
) != 0) {
158 /* One of the exclusions is NULL, fail. */
159 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
163 if (key
->exclusion
&& event
->exclusion
) {
164 /* Both exclusions exists, check count followed by the names. */
165 if (event
->exclusion
->count
!= key
->exclusion
->count
||
166 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
167 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
181 * Unique add of an ust app event in the given ht. This uses the custom
182 * ht_match_ust_app_event match function and the event name as hash.
184 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
185 struct ust_app_event
*event
)
187 struct cds_lfht_node
*node_ptr
;
188 struct ust_app_ht_key key
;
192 assert(ua_chan
->events
);
195 ht
= ua_chan
->events
;
196 key
.name
= event
->attr
.name
;
197 key
.filter
= event
->filter
;
198 key
.loglevel_type
= event
->attr
.loglevel
;
199 key
.exclusion
= event
->exclusion
;
201 node_ptr
= cds_lfht_add_unique(ht
->ht
,
202 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
203 ht_match_ust_app_event
, &key
, &event
->node
.node
);
204 assert(node_ptr
== &event
->node
.node
);
208 * Close the notify socket from the given RCU head object. This MUST be called
209 * through a call_rcu().
211 static void close_notify_sock_rcu(struct rcu_head
*head
)
214 struct ust_app_notify_sock_obj
*obj
=
215 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
217 /* Must have a valid fd here. */
218 assert(obj
->fd
>= 0);
220 ret
= close(obj
->fd
);
222 ERR("close notify sock %d RCU", obj
->fd
);
224 lttng_fd_put(LTTNG_FD_APPS
, 1);
230 * Return the session registry according to the buffer type of the given
233 * A registry per UID object MUST exists before calling this function or else
234 * it assert() if not found. RCU read side lock must be acquired.
236 static struct ust_registry_session
*get_session_registry(
237 struct ust_app_session
*ua_sess
)
239 struct ust_registry_session
*registry
= NULL
;
243 switch (ua_sess
->buffer_type
) {
244 case LTTNG_BUFFER_PER_PID
:
246 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
250 registry
= reg_pid
->registry
->reg
.ust
;
253 case LTTNG_BUFFER_PER_UID
:
255 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
256 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
257 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
261 registry
= reg_uid
->registry
->reg
.ust
;
273 * Delete ust context safely. RCU read lock must be held before calling
277 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
285 pthread_mutex_lock(&app
->sock_lock
);
286 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
287 pthread_mutex_unlock(&app
->sock_lock
);
288 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
289 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
290 sock
, ua_ctx
->obj
->handle
, ret
);
298 * Delete ust app event safely. RCU read lock must be held before calling
302 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
309 free(ua_event
->filter
);
310 if (ua_event
->exclusion
!= NULL
)
311 free(ua_event
->exclusion
);
312 if (ua_event
->obj
!= NULL
) {
313 pthread_mutex_lock(&app
->sock_lock
);
314 ret
= ustctl_release_object(sock
, ua_event
->obj
);
315 pthread_mutex_unlock(&app
->sock_lock
);
316 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
317 ERR("UST app sock %d release event obj failed with ret %d",
326 * Delayed reclaim of a ust_app_event_notifier_rule object. This MUST be called
327 * through a call_rcu().
330 void free_ust_app_event_notifier_rule_rcu(struct rcu_head
*head
)
332 struct ust_app_event_notifier_rule
*obj
= caa_container_of(
333 head
, struct ust_app_event_notifier_rule
, rcu_head
);
339 * Delete ust app event notifier rule safely.
341 static void delete_ust_app_event_notifier_rule(int sock
,
342 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
,
347 assert(ua_event_notifier_rule
);
349 if (ua_event_notifier_rule
->exclusion
!= NULL
) {
350 free(ua_event_notifier_rule
->exclusion
);
353 if (ua_event_notifier_rule
->obj
!= NULL
) {
354 pthread_mutex_lock(&app
->sock_lock
);
355 ret
= ustctl_release_object(sock
, ua_event_notifier_rule
->obj
);
356 pthread_mutex_unlock(&app
->sock_lock
);
357 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
358 ERR("Failed to release event notifier object: app = '%s' (ppid %d), ret = %d",
359 app
->name
, (int) app
->ppid
, ret
);
362 free(ua_event_notifier_rule
->obj
);
365 lttng_trigger_put(ua_event_notifier_rule
->trigger
);
366 call_rcu(&ua_event_notifier_rule
->rcu_head
,
367 free_ust_app_event_notifier_rule_rcu
);
371 * Release ust data object of the given stream.
373 * Return 0 on success or else a negative value.
375 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
383 pthread_mutex_lock(&app
->sock_lock
);
384 ret
= ustctl_release_object(sock
, stream
->obj
);
385 pthread_mutex_unlock(&app
->sock_lock
);
386 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
387 ERR("UST app sock %d release stream obj failed with ret %d",
390 lttng_fd_put(LTTNG_FD_APPS
, 2);
398 * Delete ust app stream safely. RCU read lock must be held before calling
402 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
407 (void) release_ust_app_stream(sock
, stream
, app
);
412 * We need to execute ht_destroy outside of RCU read-side critical
413 * section and outside of call_rcu thread, so we postpone its execution
414 * using ht_cleanup_push. It is simpler than to change the semantic of
415 * the many callers of delete_ust_app_session().
418 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
420 struct ust_app_channel
*ua_chan
=
421 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
423 ht_cleanup_push(ua_chan
->ctx
);
424 ht_cleanup_push(ua_chan
->events
);
429 * Extract the lost packet or discarded events counter when the channel is
430 * being deleted and store the value in the parent channel so we can
431 * access it from lttng list and at stop/destroy.
433 * The session list lock must be held by the caller.
436 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
438 uint64_t discarded
= 0, lost
= 0;
439 struct ltt_session
*session
;
440 struct ltt_ust_channel
*uchan
;
442 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
447 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
448 if (!session
|| !session
->ust_session
) {
450 * Not finding the session is not an error because there are
451 * multiple ways the channels can be torn down.
453 * 1) The session daemon can initiate the destruction of the
454 * ust app session after receiving a destroy command or
455 * during its shutdown/teardown.
456 * 2) The application, since we are in per-pid tracing, is
457 * unregistering and tearing down its ust app session.
459 * Both paths are protected by the session list lock which
460 * ensures that the accounting of lost packets and discarded
461 * events is done exactly once. The session is then unpublished
462 * from the session list, resulting in this condition.
467 if (ua_chan
->attr
.overwrite
) {
468 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
469 ua_chan
->key
, session
->ust_session
->consumer
,
472 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
473 ua_chan
->key
, session
->ust_session
->consumer
,
476 uchan
= trace_ust_find_channel_by_name(
477 session
->ust_session
->domain_global
.channels
,
480 ERR("Missing UST channel to store discarded counters");
484 uchan
->per_pid_closed_app_discarded
+= discarded
;
485 uchan
->per_pid_closed_app_lost
+= lost
;
490 session_put(session
);
495 * Delete ust app channel safely. RCU read lock must be held before calling
498 * The session list lock must be held by the caller.
501 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
505 struct lttng_ht_iter iter
;
506 struct ust_app_event
*ua_event
;
507 struct ust_app_ctx
*ua_ctx
;
508 struct ust_app_stream
*stream
, *stmp
;
509 struct ust_registry_session
*registry
;
513 DBG3("UST app deleting channel %s", ua_chan
->name
);
516 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
517 cds_list_del(&stream
->list
);
518 delete_ust_app_stream(sock
, stream
, app
);
522 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
523 cds_list_del(&ua_ctx
->list
);
524 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
526 delete_ust_app_ctx(sock
, ua_ctx
, app
);
530 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
532 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
534 delete_ust_app_event(sock
, ua_event
, app
);
537 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
538 /* Wipe and free registry from session registry. */
539 registry
= get_session_registry(ua_chan
->session
);
541 ust_registry_channel_del_free(registry
, ua_chan
->key
,
545 * A negative socket can be used by the caller when
546 * cleaning-up a ua_chan in an error path. Skip the
547 * accounting in this case.
550 save_per_pid_lost_discarded_counters(ua_chan
);
554 if (ua_chan
->obj
!= NULL
) {
555 /* Remove channel from application UST object descriptor. */
556 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
557 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
559 pthread_mutex_lock(&app
->sock_lock
);
560 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
561 pthread_mutex_unlock(&app
->sock_lock
);
562 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
563 ERR("UST app sock %d release channel obj failed with ret %d",
566 lttng_fd_put(LTTNG_FD_APPS
, 1);
569 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
572 int ust_app_register_done(struct ust_app
*app
)
576 pthread_mutex_lock(&app
->sock_lock
);
577 ret
= ustctl_register_done(app
->sock
);
578 pthread_mutex_unlock(&app
->sock_lock
);
582 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
587 pthread_mutex_lock(&app
->sock_lock
);
592 ret
= ustctl_release_object(sock
, data
);
594 pthread_mutex_unlock(&app
->sock_lock
);
600 * Push metadata to consumer socket.
602 * RCU read-side lock must be held to guarantee existance of socket.
603 * Must be called with the ust app session lock held.
604 * Must be called with the registry lock held.
606 * On success, return the len of metadata pushed or else a negative value.
607 * Returning a -EPIPE return value means we could not send the metadata,
608 * but it can be caused by recoverable errors (e.g. the application has
609 * terminated concurrently).
611 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
612 struct consumer_socket
*socket
, int send_zero_data
)
615 char *metadata_str
= NULL
;
616 size_t len
, offset
, new_metadata_len_sent
;
618 uint64_t metadata_key
, metadata_version
;
623 metadata_key
= registry
->metadata_key
;
626 * Means that no metadata was assigned to the session. This can
627 * happens if no start has been done previously.
633 offset
= registry
->metadata_len_sent
;
634 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
635 new_metadata_len_sent
= registry
->metadata_len
;
636 metadata_version
= registry
->metadata_version
;
638 DBG3("No metadata to push for metadata key %" PRIu64
,
639 registry
->metadata_key
);
641 if (send_zero_data
) {
642 DBG("No metadata to push");
648 /* Allocate only what we have to send. */
649 metadata_str
= zmalloc(len
);
651 PERROR("zmalloc ust app metadata string");
655 /* Copy what we haven't sent out. */
656 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
659 pthread_mutex_unlock(®istry
->lock
);
661 * We need to unlock the registry while we push metadata to
662 * break a circular dependency between the consumerd metadata
663 * lock and the sessiond registry lock. Indeed, pushing metadata
664 * to the consumerd awaits that it gets pushed all the way to
665 * relayd, but doing so requires grabbing the metadata lock. If
666 * a concurrent metadata request is being performed by
667 * consumerd, this can try to grab the registry lock on the
668 * sessiond while holding the metadata lock on the consumer
669 * daemon. Those push and pull schemes are performed on two
670 * different bidirectionnal communication sockets.
672 ret
= consumer_push_metadata(socket
, metadata_key
,
673 metadata_str
, len
, offset
, metadata_version
);
674 pthread_mutex_lock(®istry
->lock
);
677 * There is an acceptable race here between the registry
678 * metadata key assignment and the creation on the
679 * consumer. The session daemon can concurrently push
680 * metadata for this registry while being created on the
681 * consumer since the metadata key of the registry is
682 * assigned *before* it is setup to avoid the consumer
683 * to ask for metadata that could possibly be not found
684 * in the session daemon.
686 * The metadata will get pushed either by the session
687 * being stopped or the consumer requesting metadata if
688 * that race is triggered.
690 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
693 ERR("Error pushing metadata to consumer");
699 * Metadata may have been concurrently pushed, since
700 * we're not holding the registry lock while pushing to
701 * consumer. This is handled by the fact that we send
702 * the metadata content, size, and the offset at which
703 * that metadata belongs. This may arrive out of order
704 * on the consumer side, and the consumer is able to
705 * deal with overlapping fragments. The consumer
706 * supports overlapping fragments, which must be
707 * contiguous starting from offset 0. We keep the
708 * largest metadata_len_sent value of the concurrent
711 registry
->metadata_len_sent
=
712 max_t(size_t, registry
->metadata_len_sent
,
713 new_metadata_len_sent
);
722 * On error, flag the registry that the metadata is
723 * closed. We were unable to push anything and this
724 * means that either the consumer is not responding or
725 * the metadata cache has been destroyed on the
728 registry
->metadata_closed
= 1;
736 * For a given application and session, push metadata to consumer.
737 * Either sock or consumer is required : if sock is NULL, the default
738 * socket to send the metadata is retrieved from consumer, if sock
739 * is not NULL we use it to send the metadata.
740 * RCU read-side lock must be held while calling this function,
741 * therefore ensuring existance of registry. It also ensures existance
742 * of socket throughout this function.
744 * Return 0 on success else a negative error.
745 * Returning a -EPIPE return value means we could not send the metadata,
746 * but it can be caused by recoverable errors (e.g. the application has
747 * terminated concurrently).
749 static int push_metadata(struct ust_registry_session
*registry
,
750 struct consumer_output
*consumer
)
754 struct consumer_socket
*socket
;
759 pthread_mutex_lock(®istry
->lock
);
760 if (registry
->metadata_closed
) {
765 /* Get consumer socket to use to push the metadata.*/
766 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
773 ret
= ust_app_push_metadata(registry
, socket
, 0);
778 pthread_mutex_unlock(®istry
->lock
);
782 pthread_mutex_unlock(®istry
->lock
);
787 * Send to the consumer a close metadata command for the given session. Once
788 * done, the metadata channel is deleted and the session metadata pointer is
789 * nullified. The session lock MUST be held unless the application is
790 * in the destroy path.
792 * Do not hold the registry lock while communicating with the consumerd, because
793 * doing so causes inter-process deadlocks between consumerd and sessiond with
794 * the metadata request notification.
796 * Return 0 on success else a negative value.
798 static int close_metadata(struct ust_registry_session
*registry
,
799 struct consumer_output
*consumer
)
802 struct consumer_socket
*socket
;
803 uint64_t metadata_key
;
804 bool registry_was_already_closed
;
811 pthread_mutex_lock(®istry
->lock
);
812 metadata_key
= registry
->metadata_key
;
813 registry_was_already_closed
= registry
->metadata_closed
;
814 if (metadata_key
!= 0) {
816 * Metadata closed. Even on error this means that the consumer
817 * is not responding or not found so either way a second close
818 * should NOT be emit for this registry.
820 registry
->metadata_closed
= 1;
822 pthread_mutex_unlock(®istry
->lock
);
824 if (metadata_key
== 0 || registry_was_already_closed
) {
829 /* Get consumer socket to use to push the metadata.*/
830 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
837 ret
= consumer_close_metadata(socket
, metadata_key
);
848 * We need to execute ht_destroy outside of RCU read-side critical
849 * section and outside of call_rcu thread, so we postpone its execution
850 * using ht_cleanup_push. It is simpler than to change the semantic of
851 * the many callers of delete_ust_app_session().
854 void delete_ust_app_session_rcu(struct rcu_head
*head
)
856 struct ust_app_session
*ua_sess
=
857 caa_container_of(head
, struct ust_app_session
, rcu_head
);
859 ht_cleanup_push(ua_sess
->channels
);
864 * Delete ust app session safely. RCU read lock must be held before calling
867 * The session list lock must be held by the caller.
870 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
874 struct lttng_ht_iter iter
;
875 struct ust_app_channel
*ua_chan
;
876 struct ust_registry_session
*registry
;
880 pthread_mutex_lock(&ua_sess
->lock
);
882 assert(!ua_sess
->deleted
);
883 ua_sess
->deleted
= true;
885 registry
= get_session_registry(ua_sess
);
886 /* Registry can be null on error path during initialization. */
888 /* Push metadata for application before freeing the application. */
889 (void) push_metadata(registry
, ua_sess
->consumer
);
892 * Don't ask to close metadata for global per UID buffers. Close
893 * metadata only on destroy trace session in this case. Also, the
894 * previous push metadata could have flag the metadata registry to
895 * close so don't send a close command if closed.
897 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
898 /* And ask to close it for this session registry. */
899 (void) close_metadata(registry
, ua_sess
->consumer
);
903 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
905 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
907 delete_ust_app_channel(sock
, ua_chan
, app
);
910 /* In case of per PID, the registry is kept in the session. */
911 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
912 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
915 * Registry can be null on error path during
918 buffer_reg_pid_remove(reg_pid
);
919 buffer_reg_pid_destroy(reg_pid
);
923 if (ua_sess
->handle
!= -1) {
924 pthread_mutex_lock(&app
->sock_lock
);
925 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
926 pthread_mutex_unlock(&app
->sock_lock
);
927 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
928 ERR("UST app sock %d release session handle failed with ret %d",
931 /* Remove session from application UST object descriptor. */
932 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
933 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
937 pthread_mutex_unlock(&ua_sess
->lock
);
939 consumer_output_put(ua_sess
->consumer
);
941 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
945 * Delete a traceable application structure from the global list. Never call
946 * this function outside of a call_rcu call.
948 * RCU read side lock should _NOT_ be held when calling this function.
951 void delete_ust_app(struct ust_app
*app
)
954 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
955 struct lttng_ht_iter iter
;
956 struct ust_app_event_notifier_rule
*event_notifier_rule
;
957 bool event_notifier_write_fd_is_open
;
960 * The session list lock must be held during this function to guarantee
961 * the existence of ua_sess.
964 /* Delete ust app sessions info */
969 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
971 /* Free every object in the session and the session. */
973 delete_ust_app_session(sock
, ua_sess
, app
);
977 /* Remove the event notifier rules associated with this app. */
979 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
980 &iter
.iter
, event_notifier_rule
, node
.node
) {
981 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
984 delete_ust_app_event_notifier_rule(
985 app
->sock
, event_notifier_rule
, app
);
990 ht_cleanup_push(app
->sessions
);
991 ht_cleanup_push(app
->ust_sessions_objd
);
992 ht_cleanup_push(app
->ust_objd
);
993 ht_cleanup_push(app
->token_to_event_notifier_rule_ht
);
996 * This could be NULL if the event notifier setup failed (e.g the app
997 * was killed or the tracer does not support this feature).
999 if (app
->event_notifier_group
.object
) {
1000 enum lttng_error_code ret_code
;
1001 const int event_notifier_read_fd
= lttng_pipe_get_readfd(
1002 app
->event_notifier_group
.event_pipe
);
1004 ret_code
= notification_thread_command_remove_tracer_event_source(
1005 notification_thread_handle
,
1006 event_notifier_read_fd
);
1007 if (ret_code
!= LTTNG_OK
) {
1008 ERR("Failed to remove application tracer event source from notification thread");
1011 ustctl_release_object(sock
, app
->event_notifier_group
.object
);
1012 free(app
->event_notifier_group
.object
);
1015 event_notifier_write_fd_is_open
= lttng_pipe_is_write_open(
1016 app
->event_notifier_group
.event_pipe
);
1017 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1019 * Release the file descriptors reserved for the event notifier pipe.
1020 * The app could be destroyed before the write end of the pipe could be
1021 * passed to the application (and closed). In that case, both file
1022 * descriptors must be released.
1024 lttng_fd_put(LTTNG_FD_APPS
, event_notifier_write_fd_is_open
? 2 : 1);
1027 * Wait until we have deleted the application from the sock hash table
1028 * before closing this socket, otherwise an application could re-use the
1029 * socket ID and race with the teardown, using the same hash table entry.
1031 * It's OK to leave the close in call_rcu. We want it to stay unique for
1032 * all RCU readers that could run concurrently with unregister app,
1033 * therefore we _need_ to only close that socket after a grace period. So
1034 * it should stay in this RCU callback.
1036 * This close() is a very important step of the synchronization model so
1037 * every modification to this function must be carefully reviewed.
1043 lttng_fd_put(LTTNG_FD_APPS
, 1);
1045 DBG2("UST app pid %d deleted", app
->pid
);
1047 session_unlock_list();
1051 * URCU intermediate call to delete an UST app.
1054 void delete_ust_app_rcu(struct rcu_head
*head
)
1056 struct lttng_ht_node_ulong
*node
=
1057 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
1058 struct ust_app
*app
=
1059 caa_container_of(node
, struct ust_app
, pid_n
);
1061 DBG3("Call RCU deleting app PID %d", app
->pid
);
1062 delete_ust_app(app
);
1066 * Delete the session from the application ht and delete the data structure by
1067 * freeing every object inside and releasing them.
1069 * The session list lock must be held by the caller.
1071 static void destroy_app_session(struct ust_app
*app
,
1072 struct ust_app_session
*ua_sess
)
1075 struct lttng_ht_iter iter
;
1080 iter
.iter
.node
= &ua_sess
->node
.node
;
1081 ret
= lttng_ht_del(app
->sessions
, &iter
);
1083 /* Already scheduled for teardown. */
1087 /* Once deleted, free the data structure. */
1088 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1095 * Alloc new UST app session.
1098 struct ust_app_session
*alloc_ust_app_session(void)
1100 struct ust_app_session
*ua_sess
;
1102 /* Init most of the default value by allocating and zeroing */
1103 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
1104 if (ua_sess
== NULL
) {
1109 ua_sess
->handle
= -1;
1110 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1111 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1112 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1121 * Alloc new UST app channel.
1124 struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1125 struct ust_app_session
*ua_sess
,
1126 struct lttng_ust_channel_attr
*attr
)
1128 struct ust_app_channel
*ua_chan
;
1130 /* Init most of the default value by allocating and zeroing */
1131 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1132 if (ua_chan
== NULL
) {
1137 /* Setup channel name */
1138 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1139 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1141 ua_chan
->enabled
= 1;
1142 ua_chan
->handle
= -1;
1143 ua_chan
->session
= ua_sess
;
1144 ua_chan
->key
= get_next_channel_key();
1145 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1146 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1147 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1149 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1150 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1152 /* Copy attributes */
1154 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1155 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1156 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1157 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1158 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1159 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1160 ua_chan
->attr
.output
= attr
->output
;
1161 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1163 /* By default, the channel is a per cpu channel. */
1164 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1166 DBG3("UST app channel %s allocated", ua_chan
->name
);
1175 * Allocate and initialize a UST app stream.
1177 * Return newly allocated stream pointer or NULL on error.
1179 struct ust_app_stream
*ust_app_alloc_stream(void)
1181 struct ust_app_stream
*stream
= NULL
;
1183 stream
= zmalloc(sizeof(*stream
));
1184 if (stream
== NULL
) {
1185 PERROR("zmalloc ust app stream");
1189 /* Zero could be a valid value for a handle so flag it to -1. */
1190 stream
->handle
= -1;
1197 * Alloc new UST app event.
1200 struct ust_app_event
*alloc_ust_app_event(char *name
,
1201 struct lttng_ust_event
*attr
)
1203 struct ust_app_event
*ua_event
;
1205 /* Init most of the default value by allocating and zeroing */
1206 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1207 if (ua_event
== NULL
) {
1208 PERROR("Failed to allocate ust_app_event structure");
1212 ua_event
->enabled
= 1;
1213 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1214 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1215 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1217 /* Copy attributes */
1219 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1222 DBG3("UST app event %s allocated", ua_event
->name
);
1231 * Allocate a new UST app event notifier rule.
1233 static struct ust_app_event_notifier_rule
*alloc_ust_app_event_notifier_rule(
1234 struct lttng_trigger
*trigger
)
1236 enum lttng_event_rule_generate_exclusions_status
1237 generate_exclusion_status
;
1238 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1239 struct lttng_condition
*condition
= NULL
;
1240 const struct lttng_event_rule
*event_rule
= NULL
;
1242 ua_event_notifier_rule
= zmalloc(sizeof(struct ust_app_event_notifier_rule
));
1243 if (ua_event_notifier_rule
== NULL
) {
1244 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1248 ua_event_notifier_rule
->enabled
= 1;
1249 ua_event_notifier_rule
->token
= lttng_trigger_get_tracer_token(trigger
);
1250 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
,
1251 ua_event_notifier_rule
->token
);
1253 condition
= lttng_trigger_get_condition(trigger
);
1255 assert(lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
);
1257 assert(LTTNG_CONDITION_STATUS_OK
== lttng_condition_event_rule_get_rule(condition
, &event_rule
));
1260 /* Acquire the event notifier's reference to the trigger. */
1261 lttng_trigger_get(trigger
);
1263 ua_event_notifier_rule
->trigger
= trigger
;
1264 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1265 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1266 event_rule
, &ua_event_notifier_rule
->exclusion
);
1267 switch (generate_exclusion_status
) {
1268 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1269 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1272 /* Error occured. */
1273 ERR("Failed to generate exclusions from trigger while allocating an event notifier rule");
1274 goto error_put_trigger
;
1277 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1278 ua_event_notifier_rule
->token
);
1280 return ua_event_notifier_rule
;
1283 lttng_trigger_put(trigger
);
1285 free(ua_event_notifier_rule
);
1290 * Alloc new UST app context.
1293 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1295 struct ust_app_ctx
*ua_ctx
;
1297 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1298 if (ua_ctx
== NULL
) {
1302 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1305 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1306 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1307 char *provider_name
= NULL
, *ctx_name
= NULL
;
1309 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1310 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1311 if (!provider_name
|| !ctx_name
) {
1312 free(provider_name
);
1317 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1318 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1322 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1330 * Create a liblttng-ust filter bytecode from given bytecode.
1332 * Return allocated filter or NULL on error.
1334 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1335 const struct lttng_bytecode
*orig_f
)
1337 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1339 /* Copy filter bytecode */
1340 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1342 PERROR("zmalloc alloc ust filter bytecode");
1346 assert(sizeof(struct lttng_bytecode
) ==
1347 sizeof(struct lttng_ust_filter_bytecode
));
1348 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1354 * Find an ust_app using the sock and return it. RCU read side lock must be
1355 * held before calling this helper function.
1357 struct ust_app
*ust_app_find_by_sock(int sock
)
1359 struct lttng_ht_node_ulong
*node
;
1360 struct lttng_ht_iter iter
;
1362 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1363 node
= lttng_ht_iter_get_node_ulong(&iter
);
1365 DBG2("UST app find by sock %d not found", sock
);
1369 return caa_container_of(node
, struct ust_app
, sock_n
);
1376 * Find an ust_app using the notify sock and return it. RCU read side lock must
1377 * be held before calling this helper function.
1379 static struct ust_app
*find_app_by_notify_sock(int sock
)
1381 struct lttng_ht_node_ulong
*node
;
1382 struct lttng_ht_iter iter
;
1384 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1386 node
= lttng_ht_iter_get_node_ulong(&iter
);
1388 DBG2("UST app find by notify sock %d not found", sock
);
1392 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1399 * Lookup for an ust app event based on event name, filter bytecode and the
1402 * Return an ust_app_event object or NULL on error.
1404 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1405 const char *name
, const struct lttng_bytecode
*filter
,
1407 const struct lttng_event_exclusion
*exclusion
)
1409 struct lttng_ht_iter iter
;
1410 struct lttng_ht_node_str
*node
;
1411 struct ust_app_event
*event
= NULL
;
1412 struct ust_app_ht_key key
;
1417 /* Setup key for event lookup. */
1419 key
.filter
= filter
;
1420 key
.loglevel_type
= loglevel_value
;
1421 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1422 key
.exclusion
= exclusion
;
1424 /* Lookup using the event name as hash and a custom match fct. */
1425 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1426 ht_match_ust_app_event
, &key
, &iter
.iter
);
1427 node
= lttng_ht_iter_get_node_str(&iter
);
1432 event
= caa_container_of(node
, struct ust_app_event
, node
);
1439 * Look-up an event notifier rule based on its token id.
1441 * Must be called with the RCU read lock held.
1442 * Return an ust_app_event_notifier_rule object or NULL on error.
1444 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(
1445 struct lttng_ht
*ht
, uint64_t token
)
1447 struct lttng_ht_iter iter
;
1448 struct lttng_ht_node_u64
*node
;
1449 struct ust_app_event_notifier_rule
*event_notifier_rule
= NULL
;
1453 lttng_ht_lookup(ht
, &token
, &iter
);
1454 node
= lttng_ht_iter_get_node_u64(&iter
);
1456 DBG2("UST app event notifier rule token not found: token = %" PRIu64
,
1461 event_notifier_rule
= caa_container_of(
1462 node
, struct ust_app_event_notifier_rule
, node
);
1464 return event_notifier_rule
;
1468 * Create the channel context on the tracer.
1470 * Called with UST app session lock held.
1473 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1474 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1478 health_code_update();
1480 pthread_mutex_lock(&app
->sock_lock
);
1481 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1482 ua_chan
->obj
, &ua_ctx
->obj
);
1483 pthread_mutex_unlock(&app
->sock_lock
);
1485 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1486 ERR("UST app create channel context failed for app (pid: %d) "
1487 "with ret %d", app
->pid
, ret
);
1490 * This is normal behavior, an application can die during the
1491 * creation process. Don't report an error so the execution can
1492 * continue normally.
1495 DBG3("UST app add context failed. Application is dead.");
1500 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1502 DBG2("UST app context handle %d created successfully for channel %s",
1503 ua_ctx
->handle
, ua_chan
->name
);
1506 health_code_update();
1511 * Set the filter on the tracer.
1513 static int set_ust_object_filter(struct ust_app
*app
,
1514 const struct lttng_bytecode
*bytecode
,
1515 struct lttng_ust_object_data
*ust_object
)
1518 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1520 health_code_update();
1522 ust_bytecode
= create_ust_bytecode_from_bytecode(bytecode
);
1523 if (!ust_bytecode
) {
1524 ret
= -LTTNG_ERR_NOMEM
;
1527 pthread_mutex_lock(&app
->sock_lock
);
1528 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1530 pthread_mutex_unlock(&app
->sock_lock
);
1532 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1533 ERR("UST app set object filter failed for object %p of app (pid: %d) "
1534 "with ret %d", ust_object
, app
->pid
, ret
);
1537 * This is normal behavior, an application can die during the
1538 * creation process. Don't report an error so the execution can
1539 * continue normally.
1542 DBG3("Failed to set UST app object filter. Application is dead.");
1547 DBG2("UST filter successfully set for object %p", ust_object
);
1550 health_code_update();
1556 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1557 const struct lttng_event_exclusion
*exclusion
)
1559 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1560 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1561 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1563 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1564 if (!ust_exclusion
) {
1569 assert(sizeof(struct lttng_event_exclusion
) ==
1570 sizeof(struct lttng_ust_event_exclusion
));
1571 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1573 return ust_exclusion
;
1577 * Set event exclusions on the tracer.
1579 static int set_ust_object_exclusions(struct ust_app
*app
,
1580 const struct lttng_event_exclusion
*exclusions
,
1581 struct lttng_ust_object_data
*ust_object
)
1584 struct lttng_ust_event_exclusion
*ust_exclusions
= NULL
;
1586 assert(exclusions
&& exclusions
->count
> 0);
1588 health_code_update();
1590 ust_exclusions
= create_ust_exclusion_from_exclusion(
1592 if (!ust_exclusions
) {
1593 ret
= -LTTNG_ERR_NOMEM
;
1596 pthread_mutex_lock(&app
->sock_lock
);
1597 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1598 pthread_mutex_unlock(&app
->sock_lock
);
1600 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1601 ERR("Failed to set UST app exclusions for object %p of app (pid: %d) "
1602 "with ret %d", ust_object
, app
->pid
, ret
);
1605 * This is normal behavior, an application can die during the
1606 * creation process. Don't report an error so the execution can
1607 * continue normally.
1610 DBG3("Failed to set UST app object exclusions. Application is dead.");
1615 DBG2("UST exclusions set successfully for object %p", ust_object
);
1618 health_code_update();
1619 free(ust_exclusions
);
1624 * Disable the specified event on to UST tracer for the UST session.
1626 static int disable_ust_object(struct ust_app
*app
,
1627 struct lttng_ust_object_data
*object
)
1631 health_code_update();
1633 pthread_mutex_lock(&app
->sock_lock
);
1634 ret
= ustctl_disable(app
->sock
, object
);
1635 pthread_mutex_unlock(&app
->sock_lock
);
1637 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1638 ERR("Failed to disable UST app object %p app (pid: %d) with ret %d",
1639 object
, app
->pid
, ret
);
1642 * This is normal behavior, an application can die during the
1643 * creation process. Don't report an error so the execution can
1644 * continue normally.
1647 DBG3("Failed to disable UST app object. Application is dead.");
1652 DBG2("UST app object %p disabled successfully for app (pid: %d)",
1656 health_code_update();
1661 * Disable the specified channel on to UST tracer for the UST session.
1663 static int disable_ust_channel(struct ust_app
*app
,
1664 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1668 health_code_update();
1670 pthread_mutex_lock(&app
->sock_lock
);
1671 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1672 pthread_mutex_unlock(&app
->sock_lock
);
1674 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1675 ERR("UST app channel %s disable failed for app (pid: %d) "
1676 "and session handle %d with ret %d",
1677 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1680 * This is normal behavior, an application can die during the
1681 * creation process. Don't report an error so the execution can
1682 * continue normally.
1685 DBG3("UST app disable channel failed. Application is dead.");
1690 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1691 ua_chan
->name
, app
->pid
);
1694 health_code_update();
1699 * Enable the specified channel on to UST tracer for the UST session.
1701 static int enable_ust_channel(struct ust_app
*app
,
1702 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1706 health_code_update();
1708 pthread_mutex_lock(&app
->sock_lock
);
1709 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1710 pthread_mutex_unlock(&app
->sock_lock
);
1712 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1713 ERR("UST app channel %s enable failed for app (pid: %d) "
1714 "and session handle %d with ret %d",
1715 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1718 * This is normal behavior, an application can die during the
1719 * creation process. Don't report an error so the execution can
1720 * continue normally.
1723 DBG3("UST app enable channel failed. Application is dead.");
1728 ua_chan
->enabled
= 1;
1730 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1731 ua_chan
->name
, app
->pid
);
1734 health_code_update();
1739 * Enable the specified event on to UST tracer for the UST session.
1741 static int enable_ust_object(
1742 struct ust_app
*app
, struct lttng_ust_object_data
*ust_object
)
1746 health_code_update();
1748 pthread_mutex_lock(&app
->sock_lock
);
1749 ret
= ustctl_enable(app
->sock
, ust_object
);
1750 pthread_mutex_unlock(&app
->sock_lock
);
1752 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1753 ERR("UST app enable failed for object %p app (pid: %d) with ret %d",
1754 ust_object
, app
->pid
, ret
);
1757 * This is normal behavior, an application can die during the
1758 * creation process. Don't report an error so the execution can
1759 * continue normally.
1762 DBG3("Failed to enable UST app object. Application is dead.");
1767 DBG2("UST app object %p enabled successfully for app (pid: %d)",
1768 ust_object
, app
->pid
);
1771 health_code_update();
1776 * Send channel and stream buffer to application.
1778 * Return 0 on success. On error, a negative value is returned.
1780 static int send_channel_pid_to_ust(struct ust_app
*app
,
1781 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1784 struct ust_app_stream
*stream
, *stmp
;
1790 health_code_update();
1792 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1795 /* Send channel to the application. */
1796 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1797 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1798 ret
= -ENOTCONN
; /* Caused by app exiting. */
1800 } else if (ret
< 0) {
1804 health_code_update();
1806 /* Send all streams to application. */
1807 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1808 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1809 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1810 ret
= -ENOTCONN
; /* Caused by app exiting. */
1812 } else if (ret
< 0) {
1815 /* We don't need the stream anymore once sent to the tracer. */
1816 cds_list_del(&stream
->list
);
1817 delete_ust_app_stream(-1, stream
, app
);
1819 /* Flag the channel that it is sent to the application. */
1820 ua_chan
->is_sent
= 1;
1823 health_code_update();
1828 * Create the specified event onto the UST tracer for a UST session.
1830 * Should be called with session mutex held.
1833 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1834 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1838 health_code_update();
1840 /* Create UST event on tracer */
1841 pthread_mutex_lock(&app
->sock_lock
);
1842 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1844 pthread_mutex_unlock(&app
->sock_lock
);
1846 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1848 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1849 ua_event
->attr
.name
, app
->pid
, ret
);
1852 * This is normal behavior, an application can die during the
1853 * creation process. Don't report an error so the execution can
1854 * continue normally.
1857 DBG3("UST app create event failed. Application is dead.");
1862 ua_event
->handle
= ua_event
->obj
->handle
;
1864 DBG2("UST app event %s created successfully for pid:%d object: %p",
1865 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
1867 health_code_update();
1869 /* Set filter if one is present. */
1870 if (ua_event
->filter
) {
1871 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
1877 /* Set exclusions for the event */
1878 if (ua_event
->exclusion
) {
1879 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
1885 /* If event not enabled, disable it on the tracer */
1886 if (ua_event
->enabled
) {
1888 * We now need to explicitly enable the event, since it
1889 * is now disabled at creation.
1891 ret
= enable_ust_object(app
, ua_event
->obj
);
1894 * If we hit an EPERM, something is wrong with our enable call. If
1895 * we get an EEXIST, there is a problem on the tracer side since we
1899 case -LTTNG_UST_ERR_PERM
:
1900 /* Code flow problem */
1902 case -LTTNG_UST_ERR_EXIST
:
1903 /* It's OK for our use case. */
1914 health_code_update();
1918 static int init_ust_event_notifier_from_event_rule(
1919 const struct lttng_event_rule
*rule
,
1920 struct lttng_ust_event_notifier
*event_notifier
)
1922 enum lttng_event_rule_status status
;
1923 enum lttng_loglevel_type loglevel_type
;
1924 enum lttng_ust_loglevel_type ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1925 int loglevel
= -1, ret
= 0;
1926 const char *pattern
;
1928 /* For now only LTTNG_EVENT_RULE_TYPE_TRACEPOINT are supported. */
1929 assert(lttng_event_rule_get_type(rule
) ==
1930 LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
1932 memset(event_notifier
, 0, sizeof(*event_notifier
));
1934 if (lttng_event_rule_targets_agent_domain(rule
)) {
1936 * Special event for agents
1937 * The actual meat of the event is in the filter that will be
1938 * attached later on.
1939 * Set the default values for the agent event.
1941 pattern
= event_get_default_agent_ust_name(
1942 lttng_event_rule_get_domain_type(rule
));
1944 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1946 status
= lttng_event_rule_tracepoint_get_pattern(
1948 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1949 /* At this point, this is a fatal error. */
1953 status
= lttng_event_rule_tracepoint_get_log_level_type(
1954 rule
, &loglevel_type
);
1955 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1956 /* At this point, this is a fatal error. */
1960 switch (loglevel_type
) {
1961 case LTTNG_EVENT_LOGLEVEL_ALL
:
1962 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1964 case LTTNG_EVENT_LOGLEVEL_RANGE
:
1965 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
1967 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
1968 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
1971 /* Unknown log level specification type. */
1975 if (loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1976 status
= lttng_event_rule_tracepoint_get_log_level(
1978 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
1982 event_notifier
->event
.instrumentation
= LTTNG_UST_TRACEPOINT
;
1983 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
1984 LTTNG_UST_SYM_NAME_LEN
- 1);
1986 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
1991 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
1992 event_notifier
->event
.loglevel
= loglevel
;
1998 * Create the specified event notifier against the user space tracer of a
1999 * given application.
2001 static int create_ust_event_notifier(struct ust_app
*app
,
2002 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2005 enum lttng_condition_status condition_status
;
2006 const struct lttng_condition
*condition
= NULL
;
2007 struct lttng_ust_event_notifier event_notifier
;
2008 const struct lttng_event_rule
*event_rule
= NULL
;
2010 health_code_update();
2011 assert(app
->event_notifier_group
.object
);
2013 condition
= lttng_trigger_get_const_condition(
2014 ua_event_notifier_rule
->trigger
);
2016 assert(lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
);
2018 condition_status
= lttng_condition_event_rule_get_rule(condition
, &event_rule
);
2019 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2021 assert(lttng_event_rule_get_type(event_rule
) == LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
2023 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2024 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2026 /* Create UST event notifier against the tracer. */
2027 pthread_mutex_lock(&app
->sock_lock
);
2028 ret
= ustctl_create_event_notifier(app
->sock
, &event_notifier
,
2029 app
->event_notifier_group
.object
,
2030 &ua_event_notifier_rule
->obj
);
2031 pthread_mutex_unlock(&app
->sock_lock
);
2033 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2034 ERR("Error ustctl create event notifier: name = '%s', app = '%s' (ppid: %d), ret = %d",
2035 event_notifier
.event
.name
, app
->name
,
2039 * This is normal behavior, an application can die
2040 * during the creation process. Don't report an error so
2041 * the execution can continue normally.
2044 DBG3("UST app create event notifier failed (application is dead): app = '%s' (ppid = %d)",
2045 app
->name
, app
->ppid
);
2051 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2053 DBG2("UST app event notifier %s created successfully: app = '%s' (ppid: %d), object: %p",
2054 event_notifier
.event
.name
, app
->name
, app
->ppid
,
2055 ua_event_notifier_rule
->obj
);
2057 health_code_update();
2059 /* Set filter if one is present. */
2060 if (ua_event_notifier_rule
->filter
) {
2061 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2062 ua_event_notifier_rule
->obj
);
2068 /* Set exclusions for the event. */
2069 if (ua_event_notifier_rule
->exclusion
) {
2070 ret
= set_ust_object_exclusions(app
,
2071 ua_event_notifier_rule
->exclusion
,
2072 ua_event_notifier_rule
->obj
);
2079 * We now need to explicitly enable the event, since it
2080 * is disabled at creation.
2082 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2085 * If we hit an EPERM, something is wrong with our enable call.
2086 * If we get an EEXIST, there is a problem on the tracer side
2087 * since we just created it.
2090 case -LTTNG_UST_ERR_PERM
:
2091 /* Code flow problem. */
2093 case -LTTNG_UST_ERR_EXIST
:
2094 /* It's OK for our use case. */
2104 ua_event_notifier_rule
->enabled
= true;
2107 health_code_update();
2112 * Copy data between an UST app event and a LTT event.
2114 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2115 struct ltt_ust_event
*uevent
)
2117 size_t exclusion_alloc_size
;
2119 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2120 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2122 ua_event
->enabled
= uevent
->enabled
;
2124 /* Copy event attributes */
2125 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2127 /* Copy filter bytecode */
2128 if (uevent
->filter
) {
2129 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2130 /* Filter might be NULL here in case of ENONEM. */
2133 /* Copy exclusion data */
2134 if (uevent
->exclusion
) {
2135 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2136 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2137 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2138 if (ua_event
->exclusion
== NULL
) {
2141 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2142 exclusion_alloc_size
);
2148 * Copy data between an UST app channel and a LTT channel.
2150 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2151 struct ltt_ust_channel
*uchan
)
2153 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2155 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2156 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2158 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2159 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2161 /* Copy event attributes since the layout is different. */
2162 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2163 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2164 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2165 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2166 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2167 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2168 ua_chan
->attr
.output
= uchan
->attr
.output
;
2169 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2172 * Note that the attribute channel type is not set since the channel on the
2173 * tracing registry side does not have this information.
2176 ua_chan
->enabled
= uchan
->enabled
;
2177 ua_chan
->tracing_channel_id
= uchan
->id
;
2179 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2183 * Copy data between a UST app session and a regular LTT session.
2185 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2186 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2188 struct tm
*timeinfo
;
2191 char tmp_shm_path
[PATH_MAX
];
2193 timeinfo
= localtime(&app
->registration_time
);
2194 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2196 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2198 ua_sess
->tracing_id
= usess
->id
;
2199 ua_sess
->id
= get_next_session_id();
2200 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2201 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2202 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2203 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2204 ua_sess
->buffer_type
= usess
->buffer_type
;
2205 ua_sess
->bits_per_long
= app
->bits_per_long
;
2207 /* There is only one consumer object per session possible. */
2208 consumer_output_get(usess
->consumer
);
2209 ua_sess
->consumer
= usess
->consumer
;
2211 ua_sess
->output_traces
= usess
->output_traces
;
2212 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2213 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2214 &usess
->metadata_attr
);
2216 switch (ua_sess
->buffer_type
) {
2217 case LTTNG_BUFFER_PER_PID
:
2218 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2219 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2222 case LTTNG_BUFFER_PER_UID
:
2223 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2224 DEFAULT_UST_TRACE_UID_PATH
,
2225 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2226 app
->bits_per_long
);
2233 PERROR("asprintf UST shadow copy session");
2238 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2239 sizeof(ua_sess
->root_shm_path
));
2240 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2241 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2242 sizeof(ua_sess
->shm_path
));
2243 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2244 if (ua_sess
->shm_path
[0]) {
2245 switch (ua_sess
->buffer_type
) {
2246 case LTTNG_BUFFER_PER_PID
:
2247 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2248 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2249 app
->name
, app
->pid
, datetime
);
2251 case LTTNG_BUFFER_PER_UID
:
2252 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2253 "/" DEFAULT_UST_TRACE_UID_PATH
,
2254 app
->uid
, app
->bits_per_long
);
2261 PERROR("sprintf UST shadow copy session");
2265 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2266 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2267 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2272 consumer_output_put(ua_sess
->consumer
);
2276 * Lookup sesison wrapper.
2279 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2280 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2282 /* Get right UST app session from app */
2283 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2287 * Return ust app session from the app session hashtable using the UST session
2290 static struct ust_app_session
*lookup_session_by_app(
2291 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2293 struct lttng_ht_iter iter
;
2294 struct lttng_ht_node_u64
*node
;
2296 __lookup_session_by_app(usess
, app
, &iter
);
2297 node
= lttng_ht_iter_get_node_u64(&iter
);
2302 return caa_container_of(node
, struct ust_app_session
, node
);
2309 * Setup buffer registry per PID for the given session and application. If none
2310 * is found, a new one is created, added to the global registry and
2311 * initialized. If regp is valid, it's set with the newly created object.
2313 * Return 0 on success or else a negative value.
2315 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2316 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2319 struct buffer_reg_pid
*reg_pid
;
2326 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2329 * This is the create channel path meaning that if there is NO
2330 * registry available, we have to create one for this session.
2332 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2333 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2341 /* Initialize registry. */
2342 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2343 app
->bits_per_long
, app
->uint8_t_alignment
,
2344 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2345 app
->uint64_t_alignment
, app
->long_alignment
,
2346 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2347 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2348 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2349 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2350 ua_sess
->tracing_id
,
2354 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2355 * destroy the buffer registry, because it is always expected
2356 * that if the buffer registry can be found, its ust registry is
2359 buffer_reg_pid_destroy(reg_pid
);
2363 buffer_reg_pid_add(reg_pid
);
2365 DBG3("UST app buffer registry per PID created successfully");
2377 * Setup buffer registry per UID for the given session and application. If none
2378 * is found, a new one is created, added to the global registry and
2379 * initialized. If regp is valid, it's set with the newly created object.
2381 * Return 0 on success or else a negative value.
2383 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2384 struct ust_app_session
*ua_sess
,
2385 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2388 struct buffer_reg_uid
*reg_uid
;
2395 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2398 * This is the create channel path meaning that if there is NO
2399 * registry available, we have to create one for this session.
2401 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2402 LTTNG_DOMAIN_UST
, ®_uid
,
2403 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2411 /* Initialize registry. */
2412 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2413 app
->bits_per_long
, app
->uint8_t_alignment
,
2414 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2415 app
->uint64_t_alignment
, app
->long_alignment
,
2416 app
->byte_order
, app
->version
.major
,
2417 app
->version
.minor
, reg_uid
->root_shm_path
,
2418 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2419 ua_sess
->tracing_id
, app
->uid
);
2422 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2423 * destroy the buffer registry, because it is always expected
2424 * that if the buffer registry can be found, its ust registry is
2427 buffer_reg_uid_destroy(reg_uid
, NULL
);
2430 /* Add node to teardown list of the session. */
2431 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2433 buffer_reg_uid_add(reg_uid
);
2435 DBG3("UST app buffer registry per UID created successfully");
2446 * Create a session on the tracer side for the given app.
2448 * On success, ua_sess_ptr is populated with the session pointer or else left
2449 * untouched. If the session was created, is_created is set to 1. On error,
2450 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2453 * Returns 0 on success or else a negative code which is either -ENOMEM or
2454 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2456 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2457 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2460 int ret
, created
= 0;
2461 struct ust_app_session
*ua_sess
;
2465 assert(ua_sess_ptr
);
2467 health_code_update();
2469 ua_sess
= lookup_session_by_app(usess
, app
);
2470 if (ua_sess
== NULL
) {
2471 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2472 app
->pid
, usess
->id
);
2473 ua_sess
= alloc_ust_app_session();
2474 if (ua_sess
== NULL
) {
2475 /* Only malloc can failed so something is really wrong */
2479 shadow_copy_session(ua_sess
, usess
, app
);
2483 switch (usess
->buffer_type
) {
2484 case LTTNG_BUFFER_PER_PID
:
2485 /* Init local registry. */
2486 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2488 delete_ust_app_session(-1, ua_sess
, app
);
2492 case LTTNG_BUFFER_PER_UID
:
2493 /* Look for a global registry. If none exists, create one. */
2494 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2496 delete_ust_app_session(-1, ua_sess
, app
);
2506 health_code_update();
2508 if (ua_sess
->handle
== -1) {
2509 pthread_mutex_lock(&app
->sock_lock
);
2510 ret
= ustctl_create_session(app
->sock
);
2511 pthread_mutex_unlock(&app
->sock_lock
);
2513 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2514 ERR("Creating session for app pid %d with ret %d",
2517 DBG("UST app creating session failed. Application is dead");
2519 * This is normal behavior, an application can die during the
2520 * creation process. Don't report an error so the execution can
2521 * continue normally. This will get flagged ENOTCONN and the
2522 * caller will handle it.
2526 delete_ust_app_session(-1, ua_sess
, app
);
2527 if (ret
!= -ENOMEM
) {
2529 * Tracer is probably gone or got an internal error so let's
2530 * behave like it will soon unregister or not usable.
2537 ua_sess
->handle
= ret
;
2539 /* Add ust app session to app's HT */
2540 lttng_ht_node_init_u64(&ua_sess
->node
,
2541 ua_sess
->tracing_id
);
2542 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2543 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2544 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2545 &ua_sess
->ust_objd_node
);
2547 DBG2("UST app session created successfully with handle %d", ret
);
2550 *ua_sess_ptr
= ua_sess
;
2552 *is_created
= created
;
2555 /* Everything went well. */
2559 health_code_update();
2564 * Match function for a hash table lookup of ust_app_ctx.
2566 * It matches an ust app context based on the context type and, in the case
2567 * of perf counters, their name.
2569 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2571 struct ust_app_ctx
*ctx
;
2572 const struct lttng_ust_context_attr
*key
;
2577 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2581 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2586 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2587 if (strncmp(key
->u
.perf_counter
.name
,
2588 ctx
->ctx
.u
.perf_counter
.name
,
2589 sizeof(key
->u
.perf_counter
.name
))) {
2593 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2594 if (strcmp(key
->u
.app_ctx
.provider_name
,
2595 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2596 strcmp(key
->u
.app_ctx
.ctx_name
,
2597 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2613 * Lookup for an ust app context from an lttng_ust_context.
2615 * Must be called while holding RCU read side lock.
2616 * Return an ust_app_ctx object or NULL on error.
2619 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2620 struct lttng_ust_context_attr
*uctx
)
2622 struct lttng_ht_iter iter
;
2623 struct lttng_ht_node_ulong
*node
;
2624 struct ust_app_ctx
*app_ctx
= NULL
;
2629 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2630 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2631 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2632 node
= lttng_ht_iter_get_node_ulong(&iter
);
2637 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2644 * Create a context for the channel on the tracer.
2646 * Called with UST app session lock held and a RCU read side lock.
2649 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2650 struct lttng_ust_context_attr
*uctx
,
2651 struct ust_app
*app
)
2654 struct ust_app_ctx
*ua_ctx
;
2656 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2658 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2664 ua_ctx
= alloc_ust_app_ctx(uctx
);
2665 if (ua_ctx
== NULL
) {
2671 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2672 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2673 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2675 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2685 * Enable on the tracer side a ust app event for the session and channel.
2687 * Called with UST app session lock held.
2690 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2691 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2695 ret
= enable_ust_object(app
, ua_event
->obj
);
2700 ua_event
->enabled
= 1;
2707 * Disable on the tracer side a ust app event for the session and channel.
2709 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2710 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2714 ret
= disable_ust_object(app
, ua_event
->obj
);
2719 ua_event
->enabled
= 0;
2726 * Lookup ust app channel for session and disable it on the tracer side.
2729 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2730 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2734 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2739 ua_chan
->enabled
= 0;
2746 * Lookup ust app channel for session and enable it on the tracer side. This
2747 * MUST be called with a RCU read side lock acquired.
2749 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2750 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2753 struct lttng_ht_iter iter
;
2754 struct lttng_ht_node_str
*ua_chan_node
;
2755 struct ust_app_channel
*ua_chan
;
2757 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2758 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2759 if (ua_chan_node
== NULL
) {
2760 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2761 uchan
->name
, ua_sess
->tracing_id
);
2765 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2767 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2777 * Ask the consumer to create a channel and get it if successful.
2779 * Called with UST app session lock held.
2781 * Return 0 on success or else a negative value.
2783 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2784 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2785 int bitness
, struct ust_registry_session
*registry
,
2786 uint64_t trace_archive_id
)
2789 unsigned int nb_fd
= 0;
2790 struct consumer_socket
*socket
;
2798 health_code_update();
2800 /* Get the right consumer socket for the application. */
2801 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2807 health_code_update();
2809 /* Need one fd for the channel. */
2810 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2812 ERR("Exhausted number of available FD upon create channel");
2817 * Ask consumer to create channel. The consumer will return the number of
2818 * stream we have to expect.
2820 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2821 registry
, usess
->current_trace_chunk
);
2827 * Compute the number of fd needed before receiving them. It must be 2 per
2828 * stream (2 being the default value here).
2830 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2832 /* Reserve the amount of file descriptor we need. */
2833 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2835 ERR("Exhausted number of available FD upon create channel");
2836 goto error_fd_get_stream
;
2839 health_code_update();
2842 * Now get the channel from the consumer. This call wil populate the stream
2843 * list of that channel and set the ust objects.
2845 if (usess
->consumer
->enabled
) {
2846 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2856 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2857 error_fd_get_stream
:
2859 * Initiate a destroy channel on the consumer since we had an error
2860 * handling it on our side. The return value is of no importance since we
2861 * already have a ret value set by the previous error that we need to
2864 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2866 lttng_fd_put(LTTNG_FD_APPS
, 1);
2868 health_code_update();
2874 * Duplicate the ust data object of the ust app stream and save it in the
2875 * buffer registry stream.
2877 * Return 0 on success or else a negative value.
2879 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2880 struct ust_app_stream
*stream
)
2887 /* Reserve the amount of file descriptor we need. */
2888 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2890 ERR("Exhausted number of available FD upon duplicate stream");
2894 /* Duplicate object for stream once the original is in the registry. */
2895 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2896 reg_stream
->obj
.ust
);
2898 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2899 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2900 lttng_fd_put(LTTNG_FD_APPS
, 2);
2903 stream
->handle
= stream
->obj
->handle
;
2910 * Duplicate the ust data object of the ust app. channel and save it in the
2911 * buffer registry channel.
2913 * Return 0 on success or else a negative value.
2915 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2916 struct ust_app_channel
*ua_chan
)
2923 /* Need two fds for the channel. */
2924 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2926 ERR("Exhausted number of available FD upon duplicate channel");
2930 /* Duplicate object for stream once the original is in the registry. */
2931 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2933 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2934 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2937 ua_chan
->handle
= ua_chan
->obj
->handle
;
2942 lttng_fd_put(LTTNG_FD_APPS
, 1);
2948 * For a given channel buffer registry, setup all streams of the given ust
2949 * application channel.
2951 * Return 0 on success or else a negative value.
2953 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2954 struct ust_app_channel
*ua_chan
,
2955 struct ust_app
*app
)
2958 struct ust_app_stream
*stream
, *stmp
;
2963 DBG2("UST app setup buffer registry stream");
2965 /* Send all streams to application. */
2966 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2967 struct buffer_reg_stream
*reg_stream
;
2969 ret
= buffer_reg_stream_create(®_stream
);
2975 * Keep original pointer and nullify it in the stream so the delete
2976 * stream call does not release the object.
2978 reg_stream
->obj
.ust
= stream
->obj
;
2980 buffer_reg_stream_add(reg_stream
, reg_chan
);
2982 /* We don't need the streams anymore. */
2983 cds_list_del(&stream
->list
);
2984 delete_ust_app_stream(-1, stream
, app
);
2992 * Create a buffer registry channel for the given session registry and
2993 * application channel object. If regp pointer is valid, it's set with the
2994 * created object. Important, the created object is NOT added to the session
2995 * registry hash table.
2997 * Return 0 on success else a negative value.
2999 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3000 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
3003 struct buffer_reg_channel
*reg_chan
= NULL
;
3008 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3010 /* Create buffer registry channel. */
3011 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
3016 reg_chan
->consumer_key
= ua_chan
->key
;
3017 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3018 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3020 /* Create and add a channel registry to session. */
3021 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3022 ua_chan
->tracing_channel_id
);
3026 buffer_reg_channel_add(reg_sess
, reg_chan
);
3035 /* Safe because the registry channel object was not added to any HT. */
3036 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3042 * Setup buffer registry channel for the given session registry and application
3043 * channel object. If regp pointer is valid, it's set with the created object.
3045 * Return 0 on success else a negative value.
3047 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3048 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
3049 struct ust_app
*app
)
3056 assert(ua_chan
->obj
);
3058 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3060 /* Setup all streams for the registry. */
3061 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
3066 reg_chan
->obj
.ust
= ua_chan
->obj
;
3067 ua_chan
->obj
= NULL
;
3072 buffer_reg_channel_remove(reg_sess
, reg_chan
);
3073 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3078 * Send buffer registry channel to the application.
3080 * Return 0 on success else a negative value.
3082 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
3083 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3084 struct ust_app_channel
*ua_chan
)
3087 struct buffer_reg_stream
*reg_stream
;
3094 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3096 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
3101 /* Send channel to the application. */
3102 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3103 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3104 ret
= -ENOTCONN
; /* Caused by app exiting. */
3106 } else if (ret
< 0) {
3110 health_code_update();
3112 /* Send all streams to application. */
3113 pthread_mutex_lock(®_chan
->stream_list_lock
);
3114 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
3115 struct ust_app_stream stream
;
3117 ret
= duplicate_stream_object(reg_stream
, &stream
);
3119 goto error_stream_unlock
;
3122 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3124 (void) release_ust_app_stream(-1, &stream
, app
);
3125 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3126 ret
= -ENOTCONN
; /* Caused by app exiting. */
3128 goto error_stream_unlock
;
3132 * The return value is not important here. This function will output an
3135 (void) release_ust_app_stream(-1, &stream
, app
);
3137 ua_chan
->is_sent
= 1;
3139 error_stream_unlock
:
3140 pthread_mutex_unlock(®_chan
->stream_list_lock
);
3146 * Create and send to the application the created buffers with per UID buffers.
3148 * This MUST be called with a RCU read side lock acquired.
3149 * The session list lock and the session's lock must be acquired.
3151 * Return 0 on success else a negative value.
3153 static int create_channel_per_uid(struct ust_app
*app
,
3154 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3155 struct ust_app_channel
*ua_chan
)
3158 struct buffer_reg_uid
*reg_uid
;
3159 struct buffer_reg_channel
*reg_chan
;
3160 struct ltt_session
*session
= NULL
;
3161 enum lttng_error_code notification_ret
;
3162 struct ust_registry_channel
*chan_reg
;
3169 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3171 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3173 * The session creation handles the creation of this global registry
3174 * object. If none can be find, there is a code flow problem or a
3179 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3185 /* Create the buffer registry channel object. */
3186 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
3188 ERR("Error creating the UST channel \"%s\" registry instance",
3193 session
= session_find_by_id(ua_sess
->tracing_id
);
3195 assert(pthread_mutex_trylock(&session
->lock
));
3196 assert(session_trylock_list());
3199 * Create the buffers on the consumer side. This call populates the
3200 * ust app channel object with all streams and data object.
3202 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3203 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3204 session
->most_recent_chunk_id
.value
);
3206 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3210 * Let's remove the previously created buffer registry channel so
3211 * it's not visible anymore in the session registry.
3213 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3214 ua_chan
->tracing_channel_id
, false);
3215 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
3216 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3221 * Setup the streams and add it to the session registry.
3223 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3224 ua_chan
, reg_chan
, app
);
3226 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3230 /* Notify the notification subsystem of the channel's creation. */
3231 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3232 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3233 ua_chan
->tracing_channel_id
);
3235 chan_reg
->consumer_key
= ua_chan
->key
;
3237 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3239 notification_ret
= notification_thread_command_add_channel(
3240 notification_thread_handle
, session
->name
,
3241 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3242 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3244 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3245 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3246 if (notification_ret
!= LTTNG_OK
) {
3247 ret
= - (int) notification_ret
;
3248 ERR("Failed to add channel to notification thread");
3253 /* Send buffers to the application. */
3254 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
3256 if (ret
!= -ENOTCONN
) {
3257 ERR("Error sending channel to application");
3264 session_put(session
);
3270 * Create and send to the application the created buffers with per PID buffers.
3272 * Called with UST app session lock held.
3273 * The session list lock and the session's lock must be acquired.
3275 * Return 0 on success else a negative value.
3277 static int create_channel_per_pid(struct ust_app
*app
,
3278 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3279 struct ust_app_channel
*ua_chan
)
3282 struct ust_registry_session
*registry
;
3283 enum lttng_error_code cmd_ret
;
3284 struct ltt_session
*session
= NULL
;
3285 uint64_t chan_reg_key
;
3286 struct ust_registry_channel
*chan_reg
;
3293 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3297 registry
= get_session_registry(ua_sess
);
3298 /* The UST app session lock is held, registry shall not be null. */
3301 /* Create and add a new channel registry to session. */
3302 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3304 ERR("Error creating the UST channel \"%s\" registry instance",
3309 session
= session_find_by_id(ua_sess
->tracing_id
);
3312 assert(pthread_mutex_trylock(&session
->lock
));
3313 assert(session_trylock_list());
3315 /* Create and get channel on the consumer side. */
3316 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3317 app
->bits_per_long
, registry
,
3318 session
->most_recent_chunk_id
.value
);
3320 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3322 goto error_remove_from_registry
;
3325 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3327 if (ret
!= -ENOTCONN
) {
3328 ERR("Error sending channel to application");
3330 goto error_remove_from_registry
;
3333 chan_reg_key
= ua_chan
->key
;
3334 pthread_mutex_lock(®istry
->lock
);
3335 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3337 chan_reg
->consumer_key
= ua_chan
->key
;
3338 pthread_mutex_unlock(®istry
->lock
);
3340 cmd_ret
= notification_thread_command_add_channel(
3341 notification_thread_handle
, session
->name
,
3342 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3343 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3345 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3346 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3347 if (cmd_ret
!= LTTNG_OK
) {
3348 ret
= - (int) cmd_ret
;
3349 ERR("Failed to add channel to notification thread");
3350 goto error_remove_from_registry
;
3353 error_remove_from_registry
:
3355 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3360 session_put(session
);
3366 * From an already allocated ust app channel, create the channel buffers if
3367 * needed and send them to the application. This MUST be called with a RCU read
3368 * side lock acquired.
3370 * Called with UST app session lock held.
3372 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3373 * the application exited concurrently.
3375 static int ust_app_channel_send(struct ust_app
*app
,
3376 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3377 struct ust_app_channel
*ua_chan
)
3383 assert(usess
->active
);
3387 /* Handle buffer type before sending the channel to the application. */
3388 switch (usess
->buffer_type
) {
3389 case LTTNG_BUFFER_PER_UID
:
3391 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3397 case LTTNG_BUFFER_PER_PID
:
3399 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3411 /* Initialize ust objd object using the received handle and add it. */
3412 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3413 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3415 /* If channel is not enabled, disable it on the tracer */
3416 if (!ua_chan
->enabled
) {
3417 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3428 * Create UST app channel and return it through ua_chanp if not NULL.
3430 * Called with UST app session lock and RCU read-side lock held.
3432 * Return 0 on success or else a negative value.
3434 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3435 struct ltt_ust_channel
*uchan
,
3436 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3437 struct ust_app_channel
**ua_chanp
)
3440 struct lttng_ht_iter iter
;
3441 struct lttng_ht_node_str
*ua_chan_node
;
3442 struct ust_app_channel
*ua_chan
;
3444 /* Lookup channel in the ust app session */
3445 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3446 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3447 if (ua_chan_node
!= NULL
) {
3448 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3452 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3453 if (ua_chan
== NULL
) {
3454 /* Only malloc can fail here */
3458 shadow_copy_channel(ua_chan
, uchan
);
3460 /* Set channel type. */
3461 ua_chan
->attr
.type
= type
;
3463 /* Only add the channel if successful on the tracer side. */
3464 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3467 *ua_chanp
= ua_chan
;
3470 /* Everything went well. */
3478 * Create UST app event and create it on the tracer side.
3480 * Must be called with the RCU read side lock held.
3481 * Called with ust app session mutex held.
3484 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3485 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3486 struct ust_app
*app
)
3489 struct ust_app_event
*ua_event
;
3491 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3492 if (ua_event
== NULL
) {
3493 /* Only failure mode of alloc_ust_app_event(). */
3497 shadow_copy_event(ua_event
, uevent
);
3499 /* Create it on the tracer side */
3500 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3503 * Not found previously means that it does not exist on the
3504 * tracer. If the application reports that the event existed,
3505 * it means there is a bug in the sessiond or lttng-ust
3506 * (or corruption, etc.)
3508 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3509 ERR("Tracer for application reported that an event being created already existed: "
3510 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3512 app
->pid
, app
->ppid
, app
->uid
,
3518 add_unique_ust_app_event(ua_chan
, ua_event
);
3520 DBG2("UST app create event completed: app = '%s' (ppid: %d)",
3521 app
->name
, app
->ppid
);
3527 /* Valid. Calling here is already in a read side lock */
3528 delete_ust_app_event(-1, ua_event
, app
);
3533 * Create UST app event notifier rule and create it on the tracer side.
3535 * Must be called with the RCU read side lock held.
3536 * Called with ust app session mutex held.
3539 int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
,
3540 struct ust_app
*app
)
3543 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3545 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3546 if (ua_event_notifier_rule
== NULL
) {
3551 /* Create it on the tracer side. */
3552 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3555 * Not found previously means that it does not exist on the
3556 * tracer. If the application reports that the event existed,
3557 * it means there is a bug in the sessiond or lttng-ust
3558 * (or corruption, etc.)
3560 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3561 ERR("Tracer for application reported that an event notifier being created already exists: "
3562 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3563 lttng_trigger_get_tracer_token(trigger
),
3564 app
->pid
, app
->ppid
, app
->uid
,
3570 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3571 &ua_event_notifier_rule
->node
);
3573 DBG2("UST app create token event rule completed: app = '%s' (ppid: %d), token = %" PRIu64
,
3574 app
->name
, app
->ppid
, lttng_trigger_get_tracer_token(trigger
));
3580 /* The RCU read side lock is already being held by the caller. */
3581 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3586 * Create UST metadata and open it on the tracer side.
3588 * Called with UST app session lock held and RCU read side lock.
3590 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3591 struct ust_app
*app
, struct consumer_output
*consumer
)
3594 struct ust_app_channel
*metadata
;
3595 struct consumer_socket
*socket
;
3596 struct ust_registry_session
*registry
;
3597 struct ltt_session
*session
= NULL
;
3603 registry
= get_session_registry(ua_sess
);
3604 /* The UST app session is held registry shall not be null. */
3607 pthread_mutex_lock(®istry
->lock
);
3609 /* Metadata already exists for this registry or it was closed previously */
3610 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3615 /* Allocate UST metadata */
3616 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3618 /* malloc() failed */
3623 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3625 /* Need one fd for the channel. */
3626 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3628 ERR("Exhausted number of available FD upon create metadata");
3632 /* Get the right consumer socket for the application. */
3633 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3636 goto error_consumer
;
3640 * Keep metadata key so we can identify it on the consumer side. Assign it
3641 * to the registry *before* we ask the consumer so we avoid the race of the
3642 * consumer requesting the metadata and the ask_channel call on our side
3643 * did not returned yet.
3645 registry
->metadata_key
= metadata
->key
;
3647 session
= session_find_by_id(ua_sess
->tracing_id
);
3650 assert(pthread_mutex_trylock(&session
->lock
));
3651 assert(session_trylock_list());
3654 * Ask the metadata channel creation to the consumer. The metadata object
3655 * will be created by the consumer and kept their. However, the stream is
3656 * never added or monitored until we do a first push metadata to the
3659 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3660 registry
, session
->current_trace_chunk
);
3662 /* Nullify the metadata key so we don't try to close it later on. */
3663 registry
->metadata_key
= 0;
3664 goto error_consumer
;
3668 * The setup command will make the metadata stream be sent to the relayd,
3669 * if applicable, and the thread managing the metadatas. This is important
3670 * because after this point, if an error occurs, the only way the stream
3671 * can be deleted is to be monitored in the consumer.
3673 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3675 /* Nullify the metadata key so we don't try to close it later on. */
3676 registry
->metadata_key
= 0;
3677 goto error_consumer
;
3680 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3681 metadata
->key
, app
->pid
);
3684 lttng_fd_put(LTTNG_FD_APPS
, 1);
3685 delete_ust_app_channel(-1, metadata
, app
);
3687 pthread_mutex_unlock(®istry
->lock
);
3689 session_put(session
);
3695 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3696 * acquired before calling this function.
3698 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3700 struct ust_app
*app
= NULL
;
3701 struct lttng_ht_node_ulong
*node
;
3702 struct lttng_ht_iter iter
;
3704 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3705 node
= lttng_ht_iter_get_node_ulong(&iter
);
3707 DBG2("UST app no found with pid %d", pid
);
3711 DBG2("Found UST app by pid %d", pid
);
3713 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3720 * Allocate and init an UST app object using the registration information and
3721 * the command socket. This is called when the command socket connects to the
3724 * The object is returned on success or else NULL.
3726 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3729 struct ust_app
*lta
= NULL
;
3730 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3735 DBG3("UST app creating application for socket %d", sock
);
3737 if ((msg
->bits_per_long
== 64 &&
3738 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3739 || (msg
->bits_per_long
== 32 &&
3740 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3741 ERR("Registration failed: application \"%s\" (pid: %d) has "
3742 "%d-bit long, but no consumerd for this size is available.\n",
3743 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3748 * Reserve the two file descriptors of the event source pipe. The write
3749 * end will be closed once it is passed to the application, at which
3750 * point a single 'put' will be performed.
3752 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3754 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s' (ppid: %d)",
3755 msg
->name
, (int) msg
->ppid
);
3759 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3760 if (!event_notifier_event_source_pipe
) {
3761 PERROR("Failed to open application event source pipe: '%s' (ppid = %d)",
3762 msg
->name
, msg
->ppid
);
3766 lta
= zmalloc(sizeof(struct ust_app
));
3769 goto error_free_pipe
;
3772 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
3774 lta
->ppid
= msg
->ppid
;
3775 lta
->uid
= msg
->uid
;
3776 lta
->gid
= msg
->gid
;
3778 lta
->bits_per_long
= msg
->bits_per_long
;
3779 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3780 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3781 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3782 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3783 lta
->long_alignment
= msg
->long_alignment
;
3784 lta
->byte_order
= msg
->byte_order
;
3786 lta
->v_major
= msg
->major
;
3787 lta
->v_minor
= msg
->minor
;
3788 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3789 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3790 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3791 lta
->notify_sock
= -1;
3792 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3794 /* Copy name and make sure it's NULL terminated. */
3795 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3796 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3799 * Before this can be called, when receiving the registration information,
3800 * the application compatibility is checked. So, at this point, the
3801 * application can work with this session daemon.
3803 lta
->compatible
= 1;
3805 lta
->pid
= msg
->pid
;
3806 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3808 pthread_mutex_init(<a
->sock_lock
, NULL
);
3809 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3811 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3815 lttng_pipe_destroy(event_notifier_event_source_pipe
);
3816 lttng_fd_put(LTTNG_FD_APPS
, 2);
3822 * For a given application object, add it to every hash table.
3824 void ust_app_add(struct ust_app
*app
)
3827 assert(app
->notify_sock
>= 0);
3829 app
->registration_time
= time(NULL
);
3834 * On a re-registration, we want to kick out the previous registration of
3837 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3840 * The socket _should_ be unique until _we_ call close. So, a add_unique
3841 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3842 * already in the table.
3844 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3846 /* Add application to the notify socket hash table. */
3847 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3848 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3850 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3851 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3852 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3859 * Set the application version into the object.
3861 * Return 0 on success else a negative value either an errno code or a
3862 * LTTng-UST error code.
3864 int ust_app_version(struct ust_app
*app
)
3870 pthread_mutex_lock(&app
->sock_lock
);
3871 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3872 pthread_mutex_unlock(&app
->sock_lock
);
3874 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3875 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3877 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3885 * Setup the base event notifier group.
3887 * Return 0 on success else a negative value either an errno code or a
3888 * LTTng-UST error code.
3890 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
3893 int event_pipe_write_fd
;
3894 struct lttng_ust_object_data
*event_notifier_group
= NULL
;
3895 enum lttng_error_code lttng_ret
;
3899 /* Get the write side of the pipe. */
3900 event_pipe_write_fd
= lttng_pipe_get_writefd(
3901 app
->event_notifier_group
.event_pipe
);
3903 pthread_mutex_lock(&app
->sock_lock
);
3904 ret
= ustctl_create_event_notifier_group(app
->sock
,
3905 event_pipe_write_fd
, &event_notifier_group
);
3906 pthread_mutex_unlock(&app
->sock_lock
);
3908 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3909 ERR("Failed to create application event notifier group: ret = %d, app socket fd = %d, event_pipe_write_fd = %d",
3910 ret
, app
->sock
, event_pipe_write_fd
);
3912 DBG("Failed to create application event notifier group (application is dead): app socket fd = %d",
3919 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
3921 ERR("Failed to close write end of the application's event source pipe: app = '%s' (ppid = %d)",
3922 app
->name
, app
->ppid
);
3927 * Release the file descriptor that was reserved for the write-end of
3930 lttng_fd_put(LTTNG_FD_APPS
, 1);
3932 lttng_ret
= notification_thread_command_add_tracer_event_source(
3933 notification_thread_handle
,
3934 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
),
3936 if (lttng_ret
!= LTTNG_OK
) {
3937 ERR("Failed to add tracer event source to notification thread");
3942 /* Assign handle only when the complete setup is valid. */
3943 app
->event_notifier_group
.object
= event_notifier_group
;
3947 ustctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
3948 free(app
->event_notifier_group
.object
);
3953 * Unregister app by removing it from the global traceable app list and freeing
3956 * The socket is already closed at this point so no close to sock.
3958 void ust_app_unregister(int sock
)
3960 struct ust_app
*lta
;
3961 struct lttng_ht_node_ulong
*node
;
3962 struct lttng_ht_iter ust_app_sock_iter
;
3963 struct lttng_ht_iter iter
;
3964 struct ust_app_session
*ua_sess
;
3969 /* Get the node reference for a call_rcu */
3970 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3971 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3974 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3975 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3978 * For per-PID buffers, perform "push metadata" and flush all
3979 * application streams before removing app from hash tables,
3980 * ensuring proper behavior of data_pending check.
3981 * Remove sessions so they are not visible during deletion.
3983 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3985 struct ust_registry_session
*registry
;
3987 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3989 /* The session was already removed so scheduled for teardown. */
3993 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3994 (void) ust_app_flush_app_session(lta
, ua_sess
);
3998 * Add session to list for teardown. This is safe since at this point we
3999 * are the only one using this list.
4001 pthread_mutex_lock(&ua_sess
->lock
);
4003 if (ua_sess
->deleted
) {
4004 pthread_mutex_unlock(&ua_sess
->lock
);
4009 * Normally, this is done in the delete session process which is
4010 * executed in the call rcu below. However, upon registration we can't
4011 * afford to wait for the grace period before pushing data or else the
4012 * data pending feature can race between the unregistration and stop
4013 * command where the data pending command is sent *before* the grace
4016 * The close metadata below nullifies the metadata pointer in the
4017 * session so the delete session will NOT push/close a second time.
4019 registry
= get_session_registry(ua_sess
);
4021 /* Push metadata for application before freeing the application. */
4022 (void) push_metadata(registry
, ua_sess
->consumer
);
4025 * Don't ask to close metadata for global per UID buffers. Close
4026 * metadata only on destroy trace session in this case. Also, the
4027 * previous push metadata could have flag the metadata registry to
4028 * close so don't send a close command if closed.
4030 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4031 /* And ask to close it for this session registry. */
4032 (void) close_metadata(registry
, ua_sess
->consumer
);
4035 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4037 pthread_mutex_unlock(&ua_sess
->lock
);
4040 /* Remove application from PID hash table */
4041 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4045 * Remove application from notify hash table. The thread handling the
4046 * notify socket could have deleted the node so ignore on error because
4047 * either way it's valid. The close of that socket is handled by the
4048 * apps_notify_thread.
4050 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4051 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4054 * Ignore return value since the node might have been removed before by an
4055 * add replace during app registration because the PID can be reassigned by
4058 iter
.iter
.node
= <a
->pid_n
.node
;
4059 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4061 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4066 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4073 * Fill events array with all events name of all registered apps.
4075 int ust_app_list_events(struct lttng_event
**events
)
4078 size_t nbmem
, count
= 0;
4079 struct lttng_ht_iter iter
;
4080 struct ust_app
*app
;
4081 struct lttng_event
*tmp_event
;
4083 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4084 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4085 if (tmp_event
== NULL
) {
4086 PERROR("zmalloc ust app events");
4093 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4094 struct lttng_ust_tracepoint_iter uiter
;
4096 health_code_update();
4098 if (!app
->compatible
) {
4100 * TODO: In time, we should notice the caller of this error by
4101 * telling him that this is a version error.
4105 pthread_mutex_lock(&app
->sock_lock
);
4106 handle
= ustctl_tracepoint_list(app
->sock
);
4108 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4109 ERR("UST app list events getting handle failed for app pid %d",
4112 pthread_mutex_unlock(&app
->sock_lock
);
4116 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
4117 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4118 /* Handle ustctl error. */
4122 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4123 ERR("UST app tp list get failed for app %d with ret %d",
4126 DBG3("UST app tp list get failed. Application is dead");
4128 * This is normal behavior, an application can die during the
4129 * creation process. Don't report an error so the execution can
4130 * continue normally. Continue normal execution.
4135 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4136 if (release_ret
< 0 &&
4137 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4138 release_ret
!= -EPIPE
) {
4139 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4141 pthread_mutex_unlock(&app
->sock_lock
);
4145 health_code_update();
4146 if (count
>= nbmem
) {
4147 /* In case the realloc fails, we free the memory */
4148 struct lttng_event
*new_tmp_event
;
4151 new_nbmem
= nbmem
<< 1;
4152 DBG2("Reallocating event list from %zu to %zu entries",
4154 new_tmp_event
= realloc(tmp_event
,
4155 new_nbmem
* sizeof(struct lttng_event
));
4156 if (new_tmp_event
== NULL
) {
4159 PERROR("realloc ust app events");
4162 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4163 if (release_ret
< 0 &&
4164 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4165 release_ret
!= -EPIPE
) {
4166 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4168 pthread_mutex_unlock(&app
->sock_lock
);
4171 /* Zero the new memory */
4172 memset(new_tmp_event
+ nbmem
, 0,
4173 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4175 tmp_event
= new_tmp_event
;
4177 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
4178 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4179 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
4180 tmp_event
[count
].pid
= app
->pid
;
4181 tmp_event
[count
].enabled
= -1;
4184 ret
= ustctl_release_handle(app
->sock
, handle
);
4185 pthread_mutex_unlock(&app
->sock_lock
);
4186 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4187 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4192 *events
= tmp_event
;
4194 DBG2("UST app list events done (%zu events)", count
);
4199 health_code_update();
4204 * Fill events array with all events name of all registered apps.
4206 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4209 size_t nbmem
, count
= 0;
4210 struct lttng_ht_iter iter
;
4211 struct ust_app
*app
;
4212 struct lttng_event_field
*tmp_event
;
4214 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4215 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4216 if (tmp_event
== NULL
) {
4217 PERROR("zmalloc ust app event fields");
4224 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4225 struct lttng_ust_field_iter uiter
;
4227 health_code_update();
4229 if (!app
->compatible
) {
4231 * TODO: In time, we should notice the caller of this error by
4232 * telling him that this is a version error.
4236 pthread_mutex_lock(&app
->sock_lock
);
4237 handle
= ustctl_tracepoint_field_list(app
->sock
);
4239 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4240 ERR("UST app list field getting handle failed for app pid %d",
4243 pthread_mutex_unlock(&app
->sock_lock
);
4247 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
4248 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4249 /* Handle ustctl error. */
4253 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4254 ERR("UST app tp list field failed for app %d with ret %d",
4257 DBG3("UST app tp list field failed. Application is dead");
4259 * This is normal behavior, an application can die during the
4260 * creation process. Don't report an error so the execution can
4261 * continue normally. Reset list and count for next app.
4266 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4267 pthread_mutex_unlock(&app
->sock_lock
);
4268 if (release_ret
< 0 &&
4269 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4270 release_ret
!= -EPIPE
) {
4271 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4276 health_code_update();
4277 if (count
>= nbmem
) {
4278 /* In case the realloc fails, we free the memory */
4279 struct lttng_event_field
*new_tmp_event
;
4282 new_nbmem
= nbmem
<< 1;
4283 DBG2("Reallocating event field list from %zu to %zu entries",
4285 new_tmp_event
= realloc(tmp_event
,
4286 new_nbmem
* sizeof(struct lttng_event_field
));
4287 if (new_tmp_event
== NULL
) {
4290 PERROR("realloc ust app event fields");
4293 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4294 pthread_mutex_unlock(&app
->sock_lock
);
4296 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4297 release_ret
!= -EPIPE
) {
4298 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4302 /* Zero the new memory */
4303 memset(new_tmp_event
+ nbmem
, 0,
4304 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4306 tmp_event
= new_tmp_event
;
4309 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
4310 /* Mapping between these enums matches 1 to 1. */
4311 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4312 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4314 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
4315 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4316 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4317 tmp_event
[count
].event
.pid
= app
->pid
;
4318 tmp_event
[count
].event
.enabled
= -1;
4321 ret
= ustctl_release_handle(app
->sock
, handle
);
4322 pthread_mutex_unlock(&app
->sock_lock
);
4324 ret
!= -LTTNG_UST_ERR_EXITING
&&
4326 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4331 *fields
= tmp_event
;
4333 DBG2("UST app list event fields done (%zu events)", count
);
4338 health_code_update();
4343 * Free and clean all traceable apps of the global list.
4345 * Should _NOT_ be called with RCU read-side lock held.
4347 void ust_app_clean_list(void)
4350 struct ust_app
*app
;
4351 struct lttng_ht_iter iter
;
4353 DBG2("UST app cleaning registered apps hash table");
4357 /* Cleanup notify socket hash table */
4358 if (ust_app_ht_by_notify_sock
) {
4359 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4360 notify_sock_n
.node
) {
4362 * Assert that all notifiers are gone as all triggers
4363 * are unregistered prior to this clean-up.
4365 assert(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4367 ust_app_notify_sock_unregister(app
->notify_sock
);
4372 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4373 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4375 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4379 /* Cleanup socket hash table */
4380 if (ust_app_ht_by_sock
) {
4381 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4383 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4390 /* Destroy is done only when the ht is empty */
4392 ht_cleanup_push(ust_app_ht
);
4394 if (ust_app_ht_by_sock
) {
4395 ht_cleanup_push(ust_app_ht_by_sock
);
4397 if (ust_app_ht_by_notify_sock
) {
4398 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4403 * Init UST app hash table.
4405 int ust_app_ht_alloc(void)
4407 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4411 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4412 if (!ust_app_ht_by_sock
) {
4415 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4416 if (!ust_app_ht_by_notify_sock
) {
4423 * For a specific UST session, disable the channel for all registered apps.
4425 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4426 struct ltt_ust_channel
*uchan
)
4429 struct lttng_ht_iter iter
;
4430 struct lttng_ht_node_str
*ua_chan_node
;
4431 struct ust_app
*app
;
4432 struct ust_app_session
*ua_sess
;
4433 struct ust_app_channel
*ua_chan
;
4435 assert(usess
->active
);
4436 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4437 uchan
->name
, usess
->id
);
4441 /* For every registered applications */
4442 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4443 struct lttng_ht_iter uiter
;
4444 if (!app
->compatible
) {
4446 * TODO: In time, we should notice the caller of this error by
4447 * telling him that this is a version error.
4451 ua_sess
= lookup_session_by_app(usess
, app
);
4452 if (ua_sess
== NULL
) {
4457 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4458 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4459 /* If the session if found for the app, the channel must be there */
4460 assert(ua_chan_node
);
4462 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4463 /* The channel must not be already disabled */
4464 assert(ua_chan
->enabled
== 1);
4466 /* Disable channel onto application */
4467 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4469 /* XXX: We might want to report this error at some point... */
4479 * For a specific UST session, enable the channel for all registered apps.
4481 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4482 struct ltt_ust_channel
*uchan
)
4485 struct lttng_ht_iter iter
;
4486 struct ust_app
*app
;
4487 struct ust_app_session
*ua_sess
;
4489 assert(usess
->active
);
4490 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4491 uchan
->name
, usess
->id
);
4495 /* For every registered applications */
4496 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4497 if (!app
->compatible
) {
4499 * TODO: In time, we should notice the caller of this error by
4500 * telling him that this is a version error.
4504 ua_sess
= lookup_session_by_app(usess
, app
);
4505 if (ua_sess
== NULL
) {
4509 /* Enable channel onto application */
4510 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4512 /* XXX: We might want to report this error at some point... */
4522 * Disable an event in a channel and for a specific session.
4524 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4525 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4528 struct lttng_ht_iter iter
, uiter
;
4529 struct lttng_ht_node_str
*ua_chan_node
;
4530 struct ust_app
*app
;
4531 struct ust_app_session
*ua_sess
;
4532 struct ust_app_channel
*ua_chan
;
4533 struct ust_app_event
*ua_event
;
4535 assert(usess
->active
);
4536 DBG("UST app disabling event %s for all apps in channel "
4537 "%s for session id %" PRIu64
,
4538 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4542 /* For all registered applications */
4543 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4544 if (!app
->compatible
) {
4546 * TODO: In time, we should notice the caller of this error by
4547 * telling him that this is a version error.
4551 ua_sess
= lookup_session_by_app(usess
, app
);
4552 if (ua_sess
== NULL
) {
4557 /* Lookup channel in the ust app session */
4558 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4559 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4560 if (ua_chan_node
== NULL
) {
4561 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4562 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4565 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4567 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4568 uevent
->filter
, uevent
->attr
.loglevel
,
4570 if (ua_event
== NULL
) {
4571 DBG2("Event %s not found in channel %s for app pid %d."
4572 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4576 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4578 /* XXX: Report error someday... */
4587 /* The ua_sess lock must be held by the caller. */
4589 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4590 struct ust_app_session
*ua_sess
,
4591 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4592 struct ust_app_channel
**_ua_chan
)
4595 struct ust_app_channel
*ua_chan
= NULL
;
4598 ASSERT_LOCKED(ua_sess
->lock
);
4600 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4601 sizeof(uchan
->name
))) {
4602 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4606 struct ltt_ust_context
*uctx
= NULL
;
4609 * Create channel onto application and synchronize its
4612 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4613 LTTNG_UST_CHAN_PER_CPU
, usess
,
4619 ret
= ust_app_channel_send(app
, usess
,
4626 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4627 ret
= create_ust_app_channel_context(ua_chan
,
4640 * The application's socket is not valid. Either a bad socket
4641 * or a timeout on it. We can't inform the caller that for a
4642 * specific app, the session failed so lets continue here.
4644 ret
= 0; /* Not an error. */
4652 if (ret
== 0 && _ua_chan
) {
4654 * Only return the application's channel on success. Note
4655 * that the channel can still be part of the application's
4656 * channel hashtable on error.
4658 *_ua_chan
= ua_chan
;
4664 * Enable event for a specific session and channel on the tracer.
4666 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4667 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4670 struct lttng_ht_iter iter
, uiter
;
4671 struct lttng_ht_node_str
*ua_chan_node
;
4672 struct ust_app
*app
;
4673 struct ust_app_session
*ua_sess
;
4674 struct ust_app_channel
*ua_chan
;
4675 struct ust_app_event
*ua_event
;
4677 assert(usess
->active
);
4678 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4679 uevent
->attr
.name
, usess
->id
);
4682 * NOTE: At this point, this function is called only if the session and
4683 * channel passed are already created for all apps. and enabled on the
4689 /* For all registered applications */
4690 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4691 if (!app
->compatible
) {
4693 * TODO: In time, we should notice the caller of this error by
4694 * telling him that this is a version error.
4698 ua_sess
= lookup_session_by_app(usess
, app
);
4700 /* The application has problem or is probably dead. */
4704 pthread_mutex_lock(&ua_sess
->lock
);
4706 if (ua_sess
->deleted
) {
4707 pthread_mutex_unlock(&ua_sess
->lock
);
4711 /* Lookup channel in the ust app session */
4712 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4713 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4715 * It is possible that the channel cannot be found is
4716 * the channel/event creation occurs concurrently with
4717 * an application exit.
4719 if (!ua_chan_node
) {
4720 pthread_mutex_unlock(&ua_sess
->lock
);
4724 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4726 /* Get event node */
4727 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4728 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4729 if (ua_event
== NULL
) {
4730 DBG3("UST app enable event %s not found for app PID %d."
4731 "Skipping app", uevent
->attr
.name
, app
->pid
);
4735 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4737 pthread_mutex_unlock(&ua_sess
->lock
);
4741 pthread_mutex_unlock(&ua_sess
->lock
);
4750 * For a specific existing UST session and UST channel, creates the event for
4751 * all registered apps.
4753 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4754 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4757 struct lttng_ht_iter iter
, uiter
;
4758 struct lttng_ht_node_str
*ua_chan_node
;
4759 struct ust_app
*app
;
4760 struct ust_app_session
*ua_sess
;
4761 struct ust_app_channel
*ua_chan
;
4763 assert(usess
->active
);
4764 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4765 uevent
->attr
.name
, usess
->id
);
4769 /* For all registered applications */
4770 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4771 if (!app
->compatible
) {
4773 * TODO: In time, we should notice the caller of this error by
4774 * telling him that this is a version error.
4778 ua_sess
= lookup_session_by_app(usess
, app
);
4780 /* The application has problem or is probably dead. */
4784 pthread_mutex_lock(&ua_sess
->lock
);
4786 if (ua_sess
->deleted
) {
4787 pthread_mutex_unlock(&ua_sess
->lock
);
4791 /* Lookup channel in the ust app session */
4792 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4793 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4794 /* If the channel is not found, there is a code flow error */
4795 assert(ua_chan_node
);
4797 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4799 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4800 pthread_mutex_unlock(&ua_sess
->lock
);
4802 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4803 /* Possible value at this point: -ENOMEM. If so, we stop! */
4806 DBG2("UST app event %s already exist on app PID %d",
4807 uevent
->attr
.name
, app
->pid
);
4817 * Start tracing for a specific UST session and app.
4819 * Called with UST app session lock held.
4823 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4826 struct ust_app_session
*ua_sess
;
4828 DBG("Starting tracing for ust app pid %d", app
->pid
);
4832 if (!app
->compatible
) {
4836 ua_sess
= lookup_session_by_app(usess
, app
);
4837 if (ua_sess
== NULL
) {
4838 /* The session is in teardown process. Ignore and continue. */
4842 pthread_mutex_lock(&ua_sess
->lock
);
4844 if (ua_sess
->deleted
) {
4845 pthread_mutex_unlock(&ua_sess
->lock
);
4849 if (ua_sess
->enabled
) {
4850 pthread_mutex_unlock(&ua_sess
->lock
);
4854 /* Upon restart, we skip the setup, already done */
4855 if (ua_sess
->started
) {
4859 health_code_update();
4862 /* This starts the UST tracing */
4863 pthread_mutex_lock(&app
->sock_lock
);
4864 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4865 pthread_mutex_unlock(&app
->sock_lock
);
4867 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4868 ERR("Error starting tracing for app pid: %d (ret: %d)",
4871 DBG("UST app start session failed. Application is dead.");
4873 * This is normal behavior, an application can die during the
4874 * creation process. Don't report an error so the execution can
4875 * continue normally.
4877 pthread_mutex_unlock(&ua_sess
->lock
);
4883 /* Indicate that the session has been started once */
4884 ua_sess
->started
= 1;
4885 ua_sess
->enabled
= 1;
4887 pthread_mutex_unlock(&ua_sess
->lock
);
4889 health_code_update();
4891 /* Quiescent wait after starting trace */
4892 pthread_mutex_lock(&app
->sock_lock
);
4893 ret
= ustctl_wait_quiescent(app
->sock
);
4894 pthread_mutex_unlock(&app
->sock_lock
);
4895 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4896 ERR("UST app wait quiescent failed for app pid %d ret %d",
4902 health_code_update();
4906 pthread_mutex_unlock(&ua_sess
->lock
);
4908 health_code_update();
4913 * Stop tracing for a specific UST session and app.
4916 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4919 struct ust_app_session
*ua_sess
;
4920 struct ust_registry_session
*registry
;
4922 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4926 if (!app
->compatible
) {
4927 goto end_no_session
;
4930 ua_sess
= lookup_session_by_app(usess
, app
);
4931 if (ua_sess
== NULL
) {
4932 goto end_no_session
;
4935 pthread_mutex_lock(&ua_sess
->lock
);
4937 if (ua_sess
->deleted
) {
4938 pthread_mutex_unlock(&ua_sess
->lock
);
4939 goto end_no_session
;
4943 * If started = 0, it means that stop trace has been called for a session
4944 * that was never started. It's possible since we can have a fail start
4945 * from either the application manager thread or the command thread. Simply
4946 * indicate that this is a stop error.
4948 if (!ua_sess
->started
) {
4949 goto error_rcu_unlock
;
4952 health_code_update();
4954 /* This inhibits UST tracing */
4955 pthread_mutex_lock(&app
->sock_lock
);
4956 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4957 pthread_mutex_unlock(&app
->sock_lock
);
4959 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4960 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4963 DBG("UST app stop session failed. Application is dead.");
4965 * This is normal behavior, an application can die during the
4966 * creation process. Don't report an error so the execution can
4967 * continue normally.
4971 goto error_rcu_unlock
;
4974 health_code_update();
4975 ua_sess
->enabled
= 0;
4977 /* Quiescent wait after stopping trace */
4978 pthread_mutex_lock(&app
->sock_lock
);
4979 ret
= ustctl_wait_quiescent(app
->sock
);
4980 pthread_mutex_unlock(&app
->sock_lock
);
4981 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4982 ERR("UST app wait quiescent failed for app pid %d ret %d",
4986 health_code_update();
4988 registry
= get_session_registry(ua_sess
);
4990 /* The UST app session is held registry shall not be null. */
4993 /* Push metadata for application before freeing the application. */
4994 (void) push_metadata(registry
, ua_sess
->consumer
);
4997 pthread_mutex_unlock(&ua_sess
->lock
);
5000 health_code_update();
5004 pthread_mutex_unlock(&ua_sess
->lock
);
5006 health_code_update();
5011 int ust_app_flush_app_session(struct ust_app
*app
,
5012 struct ust_app_session
*ua_sess
)
5014 int ret
, retval
= 0;
5015 struct lttng_ht_iter iter
;
5016 struct ust_app_channel
*ua_chan
;
5017 struct consumer_socket
*socket
;
5019 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5023 if (!app
->compatible
) {
5024 goto end_not_compatible
;
5027 pthread_mutex_lock(&ua_sess
->lock
);
5029 if (ua_sess
->deleted
) {
5033 health_code_update();
5035 /* Flushing buffers */
5036 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5039 /* Flush buffers and push metadata. */
5040 switch (ua_sess
->buffer_type
) {
5041 case LTTNG_BUFFER_PER_PID
:
5042 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5044 health_code_update();
5045 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5047 ERR("Error flushing consumer channel");
5053 case LTTNG_BUFFER_PER_UID
:
5059 health_code_update();
5062 pthread_mutex_unlock(&ua_sess
->lock
);
5066 health_code_update();
5071 * Flush buffers for all applications for a specific UST session.
5072 * Called with UST session lock held.
5075 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5080 DBG("Flushing session buffers for all ust apps");
5084 /* Flush buffers and push metadata. */
5085 switch (usess
->buffer_type
) {
5086 case LTTNG_BUFFER_PER_UID
:
5088 struct buffer_reg_uid
*reg
;
5089 struct lttng_ht_iter iter
;
5091 /* Flush all per UID buffers associated to that session. */
5092 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5093 struct ust_registry_session
*ust_session_reg
;
5094 struct buffer_reg_channel
*reg_chan
;
5095 struct consumer_socket
*socket
;
5097 /* Get consumer socket to use to push the metadata.*/
5098 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5101 /* Ignore request if no consumer is found for the session. */
5105 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5106 reg_chan
, node
.node
) {
5108 * The following call will print error values so the return
5109 * code is of little importance because whatever happens, we
5110 * have to try them all.
5112 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
5115 ust_session_reg
= reg
->registry
->reg
.ust
;
5116 /* Push metadata. */
5117 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5121 case LTTNG_BUFFER_PER_PID
:
5123 struct ust_app_session
*ua_sess
;
5124 struct lttng_ht_iter iter
;
5125 struct ust_app
*app
;
5127 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5128 ua_sess
= lookup_session_by_app(usess
, app
);
5129 if (ua_sess
== NULL
) {
5132 (void) ust_app_flush_app_session(app
, ua_sess
);
5143 health_code_update();
5148 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5149 struct ust_app_session
*ua_sess
)
5152 struct lttng_ht_iter iter
;
5153 struct ust_app_channel
*ua_chan
;
5154 struct consumer_socket
*socket
;
5156 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5160 if (!app
->compatible
) {
5161 goto end_not_compatible
;
5164 pthread_mutex_lock(&ua_sess
->lock
);
5166 if (ua_sess
->deleted
) {
5170 health_code_update();
5172 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5175 ERR("Failed to find consumer (%" PRIu32
") socket",
5176 app
->bits_per_long
);
5181 /* Clear quiescent state. */
5182 switch (ua_sess
->buffer_type
) {
5183 case LTTNG_BUFFER_PER_PID
:
5184 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5185 ua_chan
, node
.node
) {
5186 health_code_update();
5187 ret
= consumer_clear_quiescent_channel(socket
,
5190 ERR("Error clearing quiescent state for consumer channel");
5196 case LTTNG_BUFFER_PER_UID
:
5203 health_code_update();
5206 pthread_mutex_unlock(&ua_sess
->lock
);
5210 health_code_update();
5215 * Clear quiescent state in each stream for all applications for a
5216 * specific UST session.
5217 * Called with UST session lock held.
5220 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5225 DBG("Clearing stream quiescent state for all ust apps");
5229 switch (usess
->buffer_type
) {
5230 case LTTNG_BUFFER_PER_UID
:
5232 struct lttng_ht_iter iter
;
5233 struct buffer_reg_uid
*reg
;
5236 * Clear quiescent for all per UID buffers associated to
5239 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5240 struct consumer_socket
*socket
;
5241 struct buffer_reg_channel
*reg_chan
;
5243 /* Get associated consumer socket.*/
5244 socket
= consumer_find_socket_by_bitness(
5245 reg
->bits_per_long
, usess
->consumer
);
5248 * Ignore request if no consumer is found for
5254 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5255 &iter
.iter
, reg_chan
, node
.node
) {
5257 * The following call will print error values so
5258 * the return code is of little importance
5259 * because whatever happens, we have to try them
5262 (void) consumer_clear_quiescent_channel(socket
,
5263 reg_chan
->consumer_key
);
5268 case LTTNG_BUFFER_PER_PID
:
5270 struct ust_app_session
*ua_sess
;
5271 struct lttng_ht_iter iter
;
5272 struct ust_app
*app
;
5274 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5276 ua_sess
= lookup_session_by_app(usess
, app
);
5277 if (ua_sess
== NULL
) {
5280 (void) ust_app_clear_quiescent_app_session(app
,
5292 health_code_update();
5297 * Destroy a specific UST session in apps.
5299 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5302 struct ust_app_session
*ua_sess
;
5303 struct lttng_ht_iter iter
;
5304 struct lttng_ht_node_u64
*node
;
5306 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5310 if (!app
->compatible
) {
5314 __lookup_session_by_app(usess
, app
, &iter
);
5315 node
= lttng_ht_iter_get_node_u64(&iter
);
5317 /* Session is being or is deleted. */
5320 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5322 health_code_update();
5323 destroy_app_session(app
, ua_sess
);
5325 health_code_update();
5327 /* Quiescent wait after stopping trace */
5328 pthread_mutex_lock(&app
->sock_lock
);
5329 ret
= ustctl_wait_quiescent(app
->sock
);
5330 pthread_mutex_unlock(&app
->sock_lock
);
5331 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5332 ERR("UST app wait quiescent failed for app pid %d ret %d",
5337 health_code_update();
5342 * Start tracing for the UST session.
5344 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5346 struct lttng_ht_iter iter
;
5347 struct ust_app
*app
;
5349 DBG("Starting all UST traces");
5352 * Even though the start trace might fail, flag this session active so
5353 * other application coming in are started by default.
5360 * In a start-stop-start use-case, we need to clear the quiescent state
5361 * of each channel set by the prior stop command, thus ensuring that a
5362 * following stop or destroy is sure to grab a timestamp_end near those
5363 * operations, even if the packet is empty.
5365 (void) ust_app_clear_quiescent_session(usess
);
5367 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5368 ust_app_global_update(usess
, app
);
5377 * Start tracing for the UST session.
5378 * Called with UST session lock held.
5380 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5383 struct lttng_ht_iter iter
;
5384 struct ust_app
*app
;
5386 DBG("Stopping all UST traces");
5389 * Even though the stop trace might fail, flag this session inactive so
5390 * other application coming in are not started by default.
5396 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5397 ret
= ust_app_stop_trace(usess
, app
);
5399 /* Continue to next apps even on error */
5404 (void) ust_app_flush_session(usess
);
5412 * Destroy app UST session.
5414 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5417 struct lttng_ht_iter iter
;
5418 struct ust_app
*app
;
5420 DBG("Destroy all UST traces");
5424 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5425 ret
= destroy_trace(usess
, app
);
5427 /* Continue to next apps even on error */
5437 /* The ua_sess lock must be held by the caller. */
5439 int find_or_create_ust_app_channel(
5440 struct ltt_ust_session
*usess
,
5441 struct ust_app_session
*ua_sess
,
5442 struct ust_app
*app
,
5443 struct ltt_ust_channel
*uchan
,
5444 struct ust_app_channel
**ua_chan
)
5447 struct lttng_ht_iter iter
;
5448 struct lttng_ht_node_str
*ua_chan_node
;
5450 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5451 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5453 *ua_chan
= caa_container_of(ua_chan_node
,
5454 struct ust_app_channel
, node
);
5458 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5467 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5468 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5469 struct ust_app
*app
)
5472 struct ust_app_event
*ua_event
= NULL
;
5474 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5475 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5477 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5482 if (ua_event
->enabled
!= uevent
->enabled
) {
5483 ret
= uevent
->enabled
?
5484 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5485 disable_ust_app_event(ua_sess
, ua_event
, app
);
5493 /* Called with RCU read-side lock held. */
5495 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5498 enum lttng_error_code ret_code
;
5499 enum lttng_trigger_status t_status
;
5500 struct lttng_ht_iter app_trigger_iter
;
5501 struct lttng_triggers
*triggers
= NULL
;
5502 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5503 unsigned int count
, i
;
5506 * Currrently, registering or unregistering a trigger with an
5507 * event rule condition causes a full synchronization of the event
5510 * The first step attempts to add an event notifier for all registered
5511 * triggers that apply to the user space tracers. Then, the
5512 * application's event notifiers rules are all checked against the list
5513 * of registered triggers. Any event notifier that doesn't have a
5514 * matching trigger can be assumed to have been disabled.
5516 * All of this is inefficient, but is put in place to get the feature
5517 * rolling as it is simpler at this moment. It will be optimized Soon™
5518 * to allow the state of enabled
5519 * event notifiers to be synchronized in a piece-wise way.
5522 /* Get all triggers using uid 0 (root) */
5523 ret_code
= notification_thread_command_list_triggers(
5524 notification_thread_handle
, 0, &triggers
);
5525 if (ret_code
!= LTTNG_OK
) {
5532 t_status
= lttng_triggers_get_count(triggers
, &count
);
5533 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5538 for (i
= 0; i
< count
; i
++) {
5539 struct lttng_condition
*condition
;
5540 struct lttng_event_rule
*event_rule
;
5541 struct lttng_trigger
*trigger
;
5542 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5543 enum lttng_condition_status condition_status
;
5546 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5549 token
= lttng_trigger_get_tracer_token(trigger
);
5550 condition
= lttng_trigger_get_condition(trigger
);
5552 if (lttng_condition_get_type(condition
) != LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
) {
5553 /* Does not apply */
5557 condition_status
= lttng_condition_event_rule_borrow_rule_mutable(condition
, &event_rule
);
5558 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5560 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5561 /* Skip kernel related triggers. */
5566 * Find or create the associated token event rule. The caller
5567 * holds the RCU read lock, so this is safe to call without
5568 * explicitly acquiring it here.
5570 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5571 app
->token_to_event_notifier_rule_ht
, token
);
5572 if (!looked_up_event_notifier_rule
) {
5573 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
5581 /* Remove all unknown event sources from the app. */
5582 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5583 &app_trigger_iter
.iter
, event_notifier_rule
,
5585 const uint64_t app_token
= event_notifier_rule
->token
;
5589 * Check if the app event trigger still exists on the
5590 * notification side.
5592 for (i
= 0; i
< count
; i
++) {
5593 uint64_t notification_thread_token
;
5594 const struct lttng_trigger
*trigger
=
5595 lttng_triggers_get_at_index(
5600 notification_thread_token
=
5601 lttng_trigger_get_tracer_token(trigger
);
5603 if (notification_thread_token
== app_token
) {
5615 * This trigger was unregistered, disable it on the tracer's
5618 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5622 /* Callee logs errors. */
5623 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5625 delete_ust_app_event_notifier_rule(
5626 app
->sock
, event_notifier_rule
, app
);
5632 lttng_triggers_destroy(triggers
);
5637 * The caller must ensure that the application is compatible and is tracked
5638 * by the process attribute trackers.
5641 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5642 struct ust_app
*app
)
5645 struct cds_lfht_iter uchan_iter
;
5646 struct ltt_ust_channel
*uchan
;
5647 struct ust_app_session
*ua_sess
= NULL
;
5650 * The application's configuration should only be synchronized for
5653 assert(usess
->active
);
5655 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5657 /* Tracer is probably gone or ENOMEM. */
5662 pthread_mutex_lock(&ua_sess
->lock
);
5663 if (ua_sess
->deleted
) {
5664 pthread_mutex_unlock(&ua_sess
->lock
);
5670 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5672 struct ust_app_channel
*ua_chan
;
5673 struct cds_lfht_iter uevent_iter
;
5674 struct ltt_ust_event
*uevent
;
5677 * Search for a matching ust_app_channel. If none is found,
5678 * create it. Creating the channel will cause the ua_chan
5679 * structure to be allocated, the channel buffers to be
5680 * allocated (if necessary) and sent to the application, and
5681 * all enabled contexts will be added to the channel.
5683 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5684 app
, uchan
, &ua_chan
);
5686 /* Tracer is probably gone or ENOMEM. */
5691 /* ua_chan will be NULL for the metadata channel */
5695 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5697 ret
= ust_app_channel_synchronize_event(ua_chan
,
5698 uevent
, ua_sess
, app
);
5704 if (ua_chan
->enabled
!= uchan
->enabled
) {
5705 ret
= uchan
->enabled
?
5706 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5707 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5715 * Create the metadata for the application. This returns gracefully if a
5716 * metadata was already set for the session.
5718 * The metadata channel must be created after the data channels as the
5719 * consumer daemon assumes this ordering. When interacting with a relay
5720 * daemon, the consumer will use this assumption to send the
5721 * "STREAMS_SENT" message to the relay daemon.
5723 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
5731 pthread_mutex_unlock(&ua_sess
->lock
);
5732 /* Everything went well at this point. */
5737 pthread_mutex_unlock(&ua_sess
->lock
);
5740 destroy_app_session(app
, ua_sess
);
5746 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5748 struct ust_app_session
*ua_sess
;
5750 ua_sess
= lookup_session_by_app(usess
, app
);
5751 if (ua_sess
== NULL
) {
5754 destroy_app_session(app
, ua_sess
);
5758 * Add channels/events from UST global domain to registered apps at sock.
5760 * Called with session lock held.
5761 * Called with RCU read-side lock held.
5763 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5766 assert(usess
->active
);
5768 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5769 app
->sock
, usess
->id
);
5771 if (!app
->compatible
) {
5774 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
5776 trace_ust_id_tracker_lookup(
5777 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
5779 trace_ust_id_tracker_lookup(
5780 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
5783 * Synchronize the application's internal tracing configuration
5784 * and start tracing.
5786 ust_app_synchronize(usess
, app
);
5787 ust_app_start_trace(usess
, app
);
5789 ust_app_global_destroy(usess
, app
);
5794 * Add all event notifiers to an application.
5796 * Called with session lock held.
5797 * Called with RCU read-side lock held.
5799 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
5801 DBG2("UST application global event notifier rules update: app = '%s' (ppid: %d)",
5802 app
->name
, app
->ppid
);
5804 if (!app
->compatible
) {
5808 if (app
->event_notifier_group
.object
== NULL
) {
5809 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s' (ppid: %d)",
5810 app
->name
, app
->ppid
);
5814 ust_app_synchronize_event_notifier_rules(app
);
5818 * Called with session lock held.
5820 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5822 struct lttng_ht_iter iter
;
5823 struct ust_app
*app
;
5826 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5827 ust_app_global_update(usess
, app
);
5832 void ust_app_global_update_all_event_notifier_rules(void)
5834 struct lttng_ht_iter iter
;
5835 struct ust_app
*app
;
5838 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5839 ust_app_global_update_event_notifier_rules(app
);
5846 * Add context to a specific channel for global UST domain.
5848 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5849 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5852 struct lttng_ht_node_str
*ua_chan_node
;
5853 struct lttng_ht_iter iter
, uiter
;
5854 struct ust_app_channel
*ua_chan
= NULL
;
5855 struct ust_app_session
*ua_sess
;
5856 struct ust_app
*app
;
5858 assert(usess
->active
);
5861 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5862 if (!app
->compatible
) {
5864 * TODO: In time, we should notice the caller of this error by
5865 * telling him that this is a version error.
5869 ua_sess
= lookup_session_by_app(usess
, app
);
5870 if (ua_sess
== NULL
) {
5874 pthread_mutex_lock(&ua_sess
->lock
);
5876 if (ua_sess
->deleted
) {
5877 pthread_mutex_unlock(&ua_sess
->lock
);
5881 /* Lookup channel in the ust app session */
5882 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5883 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5884 if (ua_chan_node
== NULL
) {
5887 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5889 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5894 pthread_mutex_unlock(&ua_sess
->lock
);
5902 * Receive registration and populate the given msg structure.
5904 * On success return 0 else a negative value returned by the ustctl call.
5906 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5909 uint32_t pid
, ppid
, uid
, gid
;
5913 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5914 &pid
, &ppid
, &uid
, &gid
,
5915 &msg
->bits_per_long
,
5916 &msg
->uint8_t_alignment
,
5917 &msg
->uint16_t_alignment
,
5918 &msg
->uint32_t_alignment
,
5919 &msg
->uint64_t_alignment
,
5920 &msg
->long_alignment
,
5927 case LTTNG_UST_ERR_EXITING
:
5928 DBG3("UST app recv reg message failed. Application died");
5930 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5931 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5932 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5933 LTTNG_UST_ABI_MINOR_VERSION
);
5936 ERR("UST app recv reg message failed with ret %d", ret
);
5941 msg
->pid
= (pid_t
) pid
;
5942 msg
->ppid
= (pid_t
) ppid
;
5943 msg
->uid
= (uid_t
) uid
;
5944 msg
->gid
= (gid_t
) gid
;
5951 * Return a ust app session object using the application object and the
5952 * session object descriptor has a key. If not found, NULL is returned.
5953 * A RCU read side lock MUST be acquired when calling this function.
5955 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5958 struct lttng_ht_node_ulong
*node
;
5959 struct lttng_ht_iter iter
;
5960 struct ust_app_session
*ua_sess
= NULL
;
5964 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5965 node
= lttng_ht_iter_get_node_ulong(&iter
);
5967 DBG2("UST app session find by objd %d not found", objd
);
5971 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5978 * Return a ust app channel object using the application object and the channel
5979 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5980 * lock MUST be acquired before calling this function.
5982 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5985 struct lttng_ht_node_ulong
*node
;
5986 struct lttng_ht_iter iter
;
5987 struct ust_app_channel
*ua_chan
= NULL
;
5991 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5992 node
= lttng_ht_iter_get_node_ulong(&iter
);
5994 DBG2("UST app channel find by objd %d not found", objd
);
5998 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
6005 * Reply to a register channel notification from an application on the notify
6006 * socket. The channel metadata is also created.
6008 * The session UST registry lock is acquired in this function.
6010 * On success 0 is returned else a negative value.
6012 static int reply_ust_register_channel(int sock
, int cobjd
,
6013 size_t nr_fields
, struct ustctl_field
*fields
)
6015 int ret
, ret_code
= 0;
6017 uint64_t chan_reg_key
;
6018 enum ustctl_channel_header type
;
6019 struct ust_app
*app
;
6020 struct ust_app_channel
*ua_chan
;
6021 struct ust_app_session
*ua_sess
;
6022 struct ust_registry_session
*registry
;
6023 struct ust_registry_channel
*chan_reg
;
6027 /* Lookup application. If not found, there is a code flow error. */
6028 app
= find_app_by_notify_sock(sock
);
6030 DBG("Application socket %d is being torn down. Abort event notify",
6033 goto error_rcu_unlock
;
6036 /* Lookup channel by UST object descriptor. */
6037 ua_chan
= find_channel_by_objd(app
, cobjd
);
6039 DBG("Application channel is being torn down. Abort event notify");
6041 goto error_rcu_unlock
;
6044 assert(ua_chan
->session
);
6045 ua_sess
= ua_chan
->session
;
6047 /* Get right session registry depending on the session buffer type. */
6048 registry
= get_session_registry(ua_sess
);
6050 DBG("Application session is being torn down. Abort event notify");
6052 goto error_rcu_unlock
;
6055 /* Depending on the buffer type, a different channel key is used. */
6056 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6057 chan_reg_key
= ua_chan
->tracing_channel_id
;
6059 chan_reg_key
= ua_chan
->key
;
6062 pthread_mutex_lock(®istry
->lock
);
6064 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
6067 if (!chan_reg
->register_done
) {
6069 * TODO: eventually use the registry event count for
6070 * this channel to better guess header type for per-pid
6073 type
= USTCTL_CHANNEL_HEADER_LARGE
;
6074 chan_reg
->nr_ctx_fields
= nr_fields
;
6075 chan_reg
->ctx_fields
= fields
;
6077 chan_reg
->header_type
= type
;
6079 /* Get current already assigned values. */
6080 type
= chan_reg
->header_type
;
6082 /* Channel id is set during the object creation. */
6083 chan_id
= chan_reg
->chan_id
;
6085 /* Append to metadata */
6086 if (!chan_reg
->metadata_dumped
) {
6087 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
6089 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6095 DBG3("UST app replying to register channel key %" PRIu64
6096 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
6099 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6101 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6102 ERR("UST app reply channel failed with ret %d", ret
);
6104 DBG3("UST app reply channel failed. Application died");
6109 /* This channel registry registration is completed. */
6110 chan_reg
->register_done
= 1;
6113 pthread_mutex_unlock(®istry
->lock
);
6121 * Add event to the UST channel registry. When the event is added to the
6122 * registry, the metadata is also created. Once done, this replies to the
6123 * application with the appropriate error code.
6125 * The session UST registry lock is acquired in the function.
6127 * On success 0 is returned else a negative value.
6129 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6130 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
6131 int loglevel_value
, char *model_emf_uri
)
6134 uint32_t event_id
= 0;
6135 uint64_t chan_reg_key
;
6136 struct ust_app
*app
;
6137 struct ust_app_channel
*ua_chan
;
6138 struct ust_app_session
*ua_sess
;
6139 struct ust_registry_session
*registry
;
6143 /* Lookup application. If not found, there is a code flow error. */
6144 app
= find_app_by_notify_sock(sock
);
6146 DBG("Application socket %d is being torn down. Abort event notify",
6149 goto error_rcu_unlock
;
6152 /* Lookup channel by UST object descriptor. */
6153 ua_chan
= find_channel_by_objd(app
, cobjd
);
6155 DBG("Application channel is being torn down. Abort event notify");
6157 goto error_rcu_unlock
;
6160 assert(ua_chan
->session
);
6161 ua_sess
= ua_chan
->session
;
6163 registry
= get_session_registry(ua_sess
);
6165 DBG("Application session is being torn down. Abort event notify");
6167 goto error_rcu_unlock
;
6170 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6171 chan_reg_key
= ua_chan
->tracing_channel_id
;
6173 chan_reg_key
= ua_chan
->key
;
6176 pthread_mutex_lock(®istry
->lock
);
6179 * From this point on, this call acquires the ownership of the sig, fields
6180 * and model_emf_uri meaning any free are done inside it if needed. These
6181 * three variables MUST NOT be read/write after this.
6183 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6184 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6185 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6189 model_emf_uri
= NULL
;
6192 * The return value is returned to ustctl so in case of an error, the
6193 * application can be notified. In case of an error, it's important not to
6194 * return a negative error or else the application will get closed.
6196 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
6198 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6199 ERR("UST app reply event failed with ret %d", ret
);
6201 DBG3("UST app reply event failed. Application died");
6204 * No need to wipe the create event since the application socket will
6205 * get close on error hence cleaning up everything by itself.
6210 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6214 pthread_mutex_unlock(®istry
->lock
);
6219 free(model_emf_uri
);
6224 * Add enum to the UST session registry. Once done, this replies to the
6225 * application with the appropriate error code.
6227 * The session UST registry lock is acquired within this function.
6229 * On success 0 is returned else a negative value.
6231 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6232 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
6234 int ret
= 0, ret_code
;
6235 struct ust_app
*app
;
6236 struct ust_app_session
*ua_sess
;
6237 struct ust_registry_session
*registry
;
6238 uint64_t enum_id
= -1ULL;
6242 /* Lookup application. If not found, there is a code flow error. */
6243 app
= find_app_by_notify_sock(sock
);
6245 /* Return an error since this is not an error */
6246 DBG("Application socket %d is being torn down. Aborting enum registration",
6249 goto error_rcu_unlock
;
6252 /* Lookup session by UST object descriptor. */
6253 ua_sess
= find_session_by_objd(app
, sobjd
);
6255 /* Return an error since this is not an error */
6256 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6258 goto error_rcu_unlock
;
6261 registry
= get_session_registry(ua_sess
);
6263 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6265 goto error_rcu_unlock
;
6268 pthread_mutex_lock(®istry
->lock
);
6271 * From this point on, the callee acquires the ownership of
6272 * entries. The variable entries MUST NOT be read/written after
6275 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6276 entries
, nr_entries
, &enum_id
);
6280 * The return value is returned to ustctl so in case of an error, the
6281 * application can be notified. In case of an error, it's important not to
6282 * return a negative error or else the application will get closed.
6284 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
6286 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6287 ERR("UST app reply enum failed with ret %d", ret
);
6289 DBG3("UST app reply enum failed. Application died");
6292 * No need to wipe the create enum since the application socket will
6293 * get close on error hence cleaning up everything by itself.
6298 DBG3("UST registry enum %s added successfully or already found", name
);
6301 pthread_mutex_unlock(®istry
->lock
);
6308 * Handle application notification through the given notify socket.
6310 * Return 0 on success or else a negative value.
6312 int ust_app_recv_notify(int sock
)
6315 enum ustctl_notify_cmd cmd
;
6317 DBG3("UST app receiving notify from sock %d", sock
);
6319 ret
= ustctl_recv_notify(sock
, &cmd
);
6321 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6322 ERR("UST app recv notify failed with ret %d", ret
);
6324 DBG3("UST app recv notify failed. Application died");
6330 case USTCTL_NOTIFY_CMD_EVENT
:
6332 int sobjd
, cobjd
, loglevel_value
;
6333 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6335 struct ustctl_field
*fields
;
6337 DBG2("UST app ustctl register event received");
6339 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6340 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6343 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6344 ERR("UST app recv event failed with ret %d", ret
);
6346 DBG3("UST app recv event failed. Application died");
6352 * Add event to the UST registry coming from the notify socket. This
6353 * call will free if needed the sig, fields and model_emf_uri. This
6354 * code path loses the ownsership of these variables and transfer them
6355 * to the this function.
6357 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6358 fields
, loglevel_value
, model_emf_uri
);
6365 case USTCTL_NOTIFY_CMD_CHANNEL
:
6369 struct ustctl_field
*fields
;
6371 DBG2("UST app ustctl register channel received");
6373 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6376 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6377 ERR("UST app recv channel failed with ret %d", ret
);
6379 DBG3("UST app recv channel failed. Application died");
6385 * The fields ownership are transfered to this function call meaning
6386 * that if needed it will be freed. After this, it's invalid to access
6387 * fields or clean it up.
6389 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6397 case USTCTL_NOTIFY_CMD_ENUM
:
6400 char name
[LTTNG_UST_SYM_NAME_LEN
];
6402 struct ustctl_enum_entry
*entries
;
6404 DBG2("UST app ustctl register enum received");
6406 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
6407 &entries
, &nr_entries
);
6409 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6410 ERR("UST app recv enum failed with ret %d", ret
);
6412 DBG3("UST app recv enum failed. Application died");
6417 /* Callee assumes ownership of entries */
6418 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6419 entries
, nr_entries
);
6427 /* Should NEVER happen. */
6436 * Once the notify socket hangs up, this is called. First, it tries to find the
6437 * corresponding application. On failure, the call_rcu to close the socket is
6438 * executed. If an application is found, it tries to delete it from the notify
6439 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6441 * Note that an object needs to be allocated here so on ENOMEM failure, the
6442 * call RCU is not done but the rest of the cleanup is.
6444 void ust_app_notify_sock_unregister(int sock
)
6447 struct lttng_ht_iter iter
;
6448 struct ust_app
*app
;
6449 struct ust_app_notify_sock_obj
*obj
;
6455 obj
= zmalloc(sizeof(*obj
));
6458 * An ENOMEM is kind of uncool. If this strikes we continue the
6459 * procedure but the call_rcu will not be called. In this case, we
6460 * accept the fd leak rather than possibly creating an unsynchronized
6461 * state between threads.
6463 * TODO: The notify object should be created once the notify socket is
6464 * registered and stored independantely from the ust app object. The
6465 * tricky part is to synchronize the teardown of the application and
6466 * this notify object. Let's keep that in mind so we can avoid this
6467 * kind of shenanigans with ENOMEM in the teardown path.
6474 DBG("UST app notify socket unregister %d", sock
);
6477 * Lookup application by notify socket. If this fails, this means that the
6478 * hash table delete has already been done by the application
6479 * unregistration process so we can safely close the notify socket in a
6482 app
= find_app_by_notify_sock(sock
);
6487 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6490 * Whatever happens here either we fail or succeed, in both cases we have
6491 * to close the socket after a grace period to continue to the call RCU
6492 * here. If the deletion is successful, the application is not visible
6493 * anymore by other threads and is it fails it means that it was already
6494 * deleted from the hash table so either way we just have to close the
6497 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6503 * Close socket after a grace period to avoid for the socket to be reused
6504 * before the application object is freed creating potential race between
6505 * threads trying to add unique in the global hash table.
6508 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6513 * Destroy a ust app data structure and free its memory.
6515 void ust_app_destroy(struct ust_app
*app
)
6521 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6525 * Take a snapshot for a given UST session. The snapshot is sent to the given
6528 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6530 enum lttng_error_code
ust_app_snapshot_record(
6531 const struct ltt_ust_session
*usess
,
6532 const struct consumer_output
*output
, int wait
,
6533 uint64_t nb_packets_per_stream
)
6536 enum lttng_error_code status
= LTTNG_OK
;
6537 struct lttng_ht_iter iter
;
6538 struct ust_app
*app
;
6539 char *trace_path
= NULL
;
6546 switch (usess
->buffer_type
) {
6547 case LTTNG_BUFFER_PER_UID
:
6549 struct buffer_reg_uid
*reg
;
6551 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6552 struct buffer_reg_channel
*reg_chan
;
6553 struct consumer_socket
*socket
;
6554 char pathname
[PATH_MAX
];
6555 size_t consumer_path_offset
= 0;
6557 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6558 /* Skip since no metadata is present */
6562 /* Get consumer socket to use to push the metadata.*/
6563 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6566 status
= LTTNG_ERR_INVALID
;
6570 memset(pathname
, 0, sizeof(pathname
));
6571 ret
= snprintf(pathname
, sizeof(pathname
),
6572 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6573 reg
->uid
, reg
->bits_per_long
);
6575 PERROR("snprintf snapshot path");
6576 status
= LTTNG_ERR_INVALID
;
6579 /* Free path allowed on previous iteration. */
6581 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6582 &consumer_path_offset
);
6584 status
= LTTNG_ERR_INVALID
;
6587 /* Add the UST default trace dir to path. */
6588 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6589 reg_chan
, node
.node
) {
6590 status
= consumer_snapshot_channel(socket
,
6591 reg_chan
->consumer_key
,
6592 output
, 0, usess
->uid
,
6593 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
6594 nb_packets_per_stream
);
6595 if (status
!= LTTNG_OK
) {
6599 status
= consumer_snapshot_channel(socket
,
6600 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6601 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
6603 if (status
!= LTTNG_OK
) {
6609 case LTTNG_BUFFER_PER_PID
:
6611 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6612 struct consumer_socket
*socket
;
6613 struct lttng_ht_iter chan_iter
;
6614 struct ust_app_channel
*ua_chan
;
6615 struct ust_app_session
*ua_sess
;
6616 struct ust_registry_session
*registry
;
6617 char pathname
[PATH_MAX
];
6618 size_t consumer_path_offset
= 0;
6620 ua_sess
= lookup_session_by_app(usess
, app
);
6622 /* Session not associated with this app. */
6626 /* Get the right consumer socket for the application. */
6627 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6630 status
= LTTNG_ERR_INVALID
;
6634 /* Add the UST default trace dir to path. */
6635 memset(pathname
, 0, sizeof(pathname
));
6636 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6639 status
= LTTNG_ERR_INVALID
;
6640 PERROR("snprintf snapshot path");
6643 /* Free path allowed on previous iteration. */
6645 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6646 &consumer_path_offset
);
6648 status
= LTTNG_ERR_INVALID
;
6651 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6652 ua_chan
, node
.node
) {
6653 status
= consumer_snapshot_channel(socket
,
6654 ua_chan
->key
, output
, 0,
6655 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6656 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6657 &trace_path
[consumer_path_offset
], wait
,
6658 nb_packets_per_stream
);
6662 case LTTNG_ERR_CHAN_NOT_FOUND
:
6669 registry
= get_session_registry(ua_sess
);
6671 DBG("Application session is being torn down. Skip application.");
6674 status
= consumer_snapshot_channel(socket
,
6675 registry
->metadata_key
, output
, 1,
6676 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6677 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6678 &trace_path
[consumer_path_offset
], wait
, 0);
6682 case LTTNG_ERR_CHAN_NOT_FOUND
:
6702 * Return the size taken by one more packet per stream.
6704 uint64_t ust_app_get_size_one_more_packet_per_stream(
6705 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6707 uint64_t tot_size
= 0;
6708 struct ust_app
*app
;
6709 struct lttng_ht_iter iter
;
6713 switch (usess
->buffer_type
) {
6714 case LTTNG_BUFFER_PER_UID
:
6716 struct buffer_reg_uid
*reg
;
6718 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6719 struct buffer_reg_channel
*reg_chan
;
6722 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6723 reg_chan
, node
.node
) {
6724 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6726 * Don't take channel into account if we
6727 * already grab all its packets.
6731 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6737 case LTTNG_BUFFER_PER_PID
:
6740 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6741 struct ust_app_channel
*ua_chan
;
6742 struct ust_app_session
*ua_sess
;
6743 struct lttng_ht_iter chan_iter
;
6745 ua_sess
= lookup_session_by_app(usess
, app
);
6747 /* Session not associated with this app. */
6751 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6752 ua_chan
, node
.node
) {
6753 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6755 * Don't take channel into account if we
6756 * already grab all its packets.
6760 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6774 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6775 struct cds_list_head
*buffer_reg_uid_list
,
6776 struct consumer_output
*consumer
, uint64_t uchan_id
,
6777 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6780 uint64_t consumer_chan_key
;
6785 ret
= buffer_reg_uid_consumer_channel_key(
6786 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6794 ret
= consumer_get_lost_packets(ust_session_id
,
6795 consumer_chan_key
, consumer
, lost
);
6797 ret
= consumer_get_discarded_events(ust_session_id
,
6798 consumer_chan_key
, consumer
, discarded
);
6805 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6806 struct ltt_ust_channel
*uchan
,
6807 struct consumer_output
*consumer
, int overwrite
,
6808 uint64_t *discarded
, uint64_t *lost
)
6811 struct lttng_ht_iter iter
;
6812 struct lttng_ht_node_str
*ua_chan_node
;
6813 struct ust_app
*app
;
6814 struct ust_app_session
*ua_sess
;
6815 struct ust_app_channel
*ua_chan
;
6822 * Iterate over every registered applications. Sum counters for
6823 * all applications containing requested session and channel.
6825 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6826 struct lttng_ht_iter uiter
;
6828 ua_sess
= lookup_session_by_app(usess
, app
);
6829 if (ua_sess
== NULL
) {
6834 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6835 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6836 /* If the session is found for the app, the channel must be there */
6837 assert(ua_chan_node
);
6839 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6844 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6851 uint64_t _discarded
;
6853 ret
= consumer_get_discarded_events(usess
->id
,
6854 ua_chan
->key
, consumer
, &_discarded
);
6858 (*discarded
) += _discarded
;
6867 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6868 struct ust_app
*app
)
6871 struct ust_app_session
*ua_sess
;
6873 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6877 ua_sess
= lookup_session_by_app(usess
, app
);
6878 if (ua_sess
== NULL
) {
6879 /* The session is in teardown process. Ignore and continue. */
6883 pthread_mutex_lock(&ua_sess
->lock
);
6885 if (ua_sess
->deleted
) {
6889 pthread_mutex_lock(&app
->sock_lock
);
6890 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6891 pthread_mutex_unlock(&app
->sock_lock
);
6894 pthread_mutex_unlock(&ua_sess
->lock
);
6898 health_code_update();
6903 * Regenerate the statedump for each app in the session.
6905 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6908 struct lttng_ht_iter iter
;
6909 struct ust_app
*app
;
6911 DBG("Regenerating the metadata for all UST apps");
6915 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6916 if (!app
->compatible
) {
6920 ret
= ust_app_regenerate_statedump(usess
, app
);
6922 /* Continue to the next app even on error */
6933 * Rotate all the channels of a session.
6935 * Return LTTNG_OK on success or else an LTTng error code.
6937 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6940 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6941 struct lttng_ht_iter iter
;
6942 struct ust_app
*app
;
6943 struct ltt_ust_session
*usess
= session
->ust_session
;
6949 switch (usess
->buffer_type
) {
6950 case LTTNG_BUFFER_PER_UID
:
6952 struct buffer_reg_uid
*reg
;
6954 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6955 struct buffer_reg_channel
*reg_chan
;
6956 struct consumer_socket
*socket
;
6958 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6959 /* Skip since no metadata is present */
6963 /* Get consumer socket to use to push the metadata.*/
6964 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6967 cmd_ret
= LTTNG_ERR_INVALID
;
6971 /* Rotate the data channels. */
6972 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6973 reg_chan
, node
.node
) {
6974 ret
= consumer_rotate_channel(socket
,
6975 reg_chan
->consumer_key
,
6976 usess
->uid
, usess
->gid
,
6978 /* is_metadata_channel */ false);
6980 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6985 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6987 ret
= consumer_rotate_channel(socket
,
6988 reg
->registry
->reg
.ust
->metadata_key
,
6989 usess
->uid
, usess
->gid
,
6991 /* is_metadata_channel */ true);
6993 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6999 case LTTNG_BUFFER_PER_PID
:
7001 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7002 struct consumer_socket
*socket
;
7003 struct lttng_ht_iter chan_iter
;
7004 struct ust_app_channel
*ua_chan
;
7005 struct ust_app_session
*ua_sess
;
7006 struct ust_registry_session
*registry
;
7008 ua_sess
= lookup_session_by_app(usess
, app
);
7010 /* Session not associated with this app. */
7014 /* Get the right consumer socket for the application. */
7015 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7018 cmd_ret
= LTTNG_ERR_INVALID
;
7022 registry
= get_session_registry(ua_sess
);
7024 DBG("Application session is being torn down. Skip application.");
7028 /* Rotate the data channels. */
7029 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7030 ua_chan
, node
.node
) {
7031 ret
= consumer_rotate_channel(socket
,
7033 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7034 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7036 /* is_metadata_channel */ false);
7038 /* Per-PID buffer and application going away. */
7039 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7041 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7046 /* Rotate the metadata channel. */
7047 (void) push_metadata(registry
, usess
->consumer
);
7048 ret
= consumer_rotate_channel(socket
,
7049 registry
->metadata_key
,
7050 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7051 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7053 /* is_metadata_channel */ true);
7055 /* Per-PID buffer and application going away. */
7056 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7058 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7076 enum lttng_error_code
ust_app_create_channel_subdirectories(
7077 const struct ltt_ust_session
*usess
)
7079 enum lttng_error_code ret
= LTTNG_OK
;
7080 struct lttng_ht_iter iter
;
7081 enum lttng_trace_chunk_status chunk_status
;
7082 char *pathname_index
;
7085 assert(usess
->current_trace_chunk
);
7088 switch (usess
->buffer_type
) {
7089 case LTTNG_BUFFER_PER_UID
:
7091 struct buffer_reg_uid
*reg
;
7093 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7094 fmt_ret
= asprintf(&pathname_index
,
7095 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7096 reg
->uid
, reg
->bits_per_long
);
7098 ERR("Failed to format channel index directory");
7099 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7104 * Create the index subdirectory which will take care
7105 * of implicitly creating the channel's path.
7107 chunk_status
= lttng_trace_chunk_create_subdirectory(
7108 usess
->current_trace_chunk
,
7110 free(pathname_index
);
7111 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7112 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7118 case LTTNG_BUFFER_PER_PID
:
7120 struct ust_app
*app
;
7123 * Create the toplevel ust/ directory in case no apps are running.
7125 chunk_status
= lttng_trace_chunk_create_subdirectory(
7126 usess
->current_trace_chunk
,
7127 DEFAULT_UST_TRACE_DIR
);
7128 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7129 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7133 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7135 struct ust_app_session
*ua_sess
;
7136 struct ust_registry_session
*registry
;
7138 ua_sess
= lookup_session_by_app(usess
, app
);
7140 /* Session not associated with this app. */
7144 registry
= get_session_registry(ua_sess
);
7146 DBG("Application session is being torn down. Skip application.");
7150 fmt_ret
= asprintf(&pathname_index
,
7151 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7154 ERR("Failed to format channel index directory");
7155 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7159 * Create the index subdirectory which will take care
7160 * of implicitly creating the channel's path.
7162 chunk_status
= lttng_trace_chunk_create_subdirectory(
7163 usess
->current_trace_chunk
,
7165 free(pathname_index
);
7166 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7167 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7184 * Clear all the channels of a session.
7186 * Return LTTNG_OK on success or else an LTTng error code.
7188 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7191 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7192 struct lttng_ht_iter iter
;
7193 struct ust_app
*app
;
7194 struct ltt_ust_session
*usess
= session
->ust_session
;
7200 if (usess
->active
) {
7201 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7202 cmd_ret
= LTTNG_ERR_FATAL
;
7206 switch (usess
->buffer_type
) {
7207 case LTTNG_BUFFER_PER_UID
:
7209 struct buffer_reg_uid
*reg
;
7211 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7212 struct buffer_reg_channel
*reg_chan
;
7213 struct consumer_socket
*socket
;
7215 /* Get consumer socket to use to push the metadata.*/
7216 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7219 cmd_ret
= LTTNG_ERR_INVALID
;
7223 /* Clear the data channels. */
7224 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7225 reg_chan
, node
.node
) {
7226 ret
= consumer_clear_channel(socket
,
7227 reg_chan
->consumer_key
);
7233 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7236 * Clear the metadata channel.
7237 * Metadata channel is not cleared per se but we still need to
7238 * perform a rotation operation on it behind the scene.
7240 ret
= consumer_clear_channel(socket
,
7241 reg
->registry
->reg
.ust
->metadata_key
);
7248 case LTTNG_BUFFER_PER_PID
:
7250 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7251 struct consumer_socket
*socket
;
7252 struct lttng_ht_iter chan_iter
;
7253 struct ust_app_channel
*ua_chan
;
7254 struct ust_app_session
*ua_sess
;
7255 struct ust_registry_session
*registry
;
7257 ua_sess
= lookup_session_by_app(usess
, app
);
7259 /* Session not associated with this app. */
7263 /* Get the right consumer socket for the application. */
7264 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7267 cmd_ret
= LTTNG_ERR_INVALID
;
7271 registry
= get_session_registry(ua_sess
);
7273 DBG("Application session is being torn down. Skip application.");
7277 /* Clear the data channels. */
7278 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7279 ua_chan
, node
.node
) {
7280 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7282 /* Per-PID buffer and application going away. */
7283 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7290 (void) push_metadata(registry
, usess
->consumer
);
7293 * Clear the metadata channel.
7294 * Metadata channel is not cleared per se but we still need to
7295 * perform rotation operation on it behind the scene.
7297 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7299 /* Per-PID buffer and application going away. */
7300 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7318 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7319 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7322 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7332 * This function skips the metadata channel as the begin/end timestamps of a
7333 * metadata packet are useless.
7335 * Moreover, opening a packet after a "clear" will cause problems for live
7336 * sessions as it will introduce padding that was not part of the first trace
7337 * chunk. The relay daemon expects the content of the metadata stream of
7338 * successive metadata trace chunks to be strict supersets of one another.
7340 * For example, flushing a packet at the beginning of the metadata stream of
7341 * a trace chunk resulting from a "clear" session command will cause the
7342 * size of the metadata stream of the new trace chunk to not match the size of
7343 * the metadata stream of the original chunk. This will confuse the relay
7344 * daemon as the same "offset" in a metadata stream will no longer point
7345 * to the same content.
7347 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7349 enum lttng_error_code ret
= LTTNG_OK
;
7350 struct lttng_ht_iter iter
;
7351 struct ltt_ust_session
*usess
= session
->ust_session
;
7357 switch (usess
->buffer_type
) {
7358 case LTTNG_BUFFER_PER_UID
:
7360 struct buffer_reg_uid
*reg
;
7362 cds_list_for_each_entry (
7363 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7364 struct buffer_reg_channel
*reg_chan
;
7365 struct consumer_socket
*socket
;
7367 socket
= consumer_find_socket_by_bitness(
7368 reg
->bits_per_long
, usess
->consumer
);
7370 ret
= LTTNG_ERR_FATAL
;
7374 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7375 &iter
.iter
, reg_chan
, node
.node
) {
7376 const int open_ret
=
7377 consumer_open_channel_packets(
7379 reg_chan
->consumer_key
);
7382 ret
= LTTNG_ERR_UNK
;
7389 case LTTNG_BUFFER_PER_PID
:
7391 struct ust_app
*app
;
7393 cds_lfht_for_each_entry (
7394 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7395 struct consumer_socket
*socket
;
7396 struct lttng_ht_iter chan_iter
;
7397 struct ust_app_channel
*ua_chan
;
7398 struct ust_app_session
*ua_sess
;
7399 struct ust_registry_session
*registry
;
7401 ua_sess
= lookup_session_by_app(usess
, app
);
7403 /* Session not associated with this app. */
7407 /* Get the right consumer socket for the application. */
7408 socket
= consumer_find_socket_by_bitness(
7409 app
->bits_per_long
, usess
->consumer
);
7411 ret
= LTTNG_ERR_FATAL
;
7415 registry
= get_session_registry(ua_sess
);
7417 DBG("Application session is being torn down. Skip application.");
7421 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7422 &chan_iter
.iter
, ua_chan
, node
.node
) {
7423 const int open_ret
=
7424 consumer_open_channel_packets(
7430 * Per-PID buffer and application going
7433 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7437 ret
= LTTNG_ERR_UNK
;