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
*
1335 create_ust_filter_bytecode_from_bytecode(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("Failed to allocate lttng_ust_filter_bytecode: bytecode len = %" PRIu32
" bytes", orig_f
->len
);
1346 assert(sizeof(struct lttng_bytecode
) ==
1347 sizeof(struct lttng_ust_filter_bytecode
));
1348 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1354 * Create a liblttng-ust capture bytecode from given bytecode.
1356 * Return allocated filter or NULL on error.
1358 static struct lttng_ust_capture_bytecode
*
1359 create_ust_capture_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1361 struct lttng_ust_capture_bytecode
*capture
= NULL
;
1363 /* Copy capture bytecode. */
1364 capture
= zmalloc(sizeof(*capture
) + orig_f
->len
);
1366 PERROR("Failed to allocate lttng_ust_capture_bytecode: bytecode len = %" PRIu32
" bytes", orig_f
->len
);
1370 assert(sizeof(struct lttng_bytecode
) ==
1371 sizeof(struct lttng_ust_capture_bytecode
));
1372 memcpy(capture
, orig_f
, sizeof(*capture
) + orig_f
->len
);
1378 * Find an ust_app using the sock and return it. RCU read side lock must be
1379 * held before calling this helper function.
1381 struct ust_app
*ust_app_find_by_sock(int sock
)
1383 struct lttng_ht_node_ulong
*node
;
1384 struct lttng_ht_iter iter
;
1386 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1387 node
= lttng_ht_iter_get_node_ulong(&iter
);
1389 DBG2("UST app find by sock %d not found", sock
);
1393 return caa_container_of(node
, struct ust_app
, sock_n
);
1400 * Find an ust_app using the notify sock and return it. RCU read side lock must
1401 * be held before calling this helper function.
1403 static struct ust_app
*find_app_by_notify_sock(int sock
)
1405 struct lttng_ht_node_ulong
*node
;
1406 struct lttng_ht_iter iter
;
1408 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1410 node
= lttng_ht_iter_get_node_ulong(&iter
);
1412 DBG2("UST app find by notify sock %d not found", sock
);
1416 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1423 * Lookup for an ust app event based on event name, filter bytecode and the
1426 * Return an ust_app_event object or NULL on error.
1428 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1429 const char *name
, const struct lttng_bytecode
*filter
,
1431 const struct lttng_event_exclusion
*exclusion
)
1433 struct lttng_ht_iter iter
;
1434 struct lttng_ht_node_str
*node
;
1435 struct ust_app_event
*event
= NULL
;
1436 struct ust_app_ht_key key
;
1441 /* Setup key for event lookup. */
1443 key
.filter
= filter
;
1444 key
.loglevel_type
= loglevel_value
;
1445 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1446 key
.exclusion
= exclusion
;
1448 /* Lookup using the event name as hash and a custom match fct. */
1449 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1450 ht_match_ust_app_event
, &key
, &iter
.iter
);
1451 node
= lttng_ht_iter_get_node_str(&iter
);
1456 event
= caa_container_of(node
, struct ust_app_event
, node
);
1463 * Look-up an event notifier rule based on its token id.
1465 * Must be called with the RCU read lock held.
1466 * Return an ust_app_event_notifier_rule object or NULL on error.
1468 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(
1469 struct lttng_ht
*ht
, uint64_t token
)
1471 struct lttng_ht_iter iter
;
1472 struct lttng_ht_node_u64
*node
;
1473 struct ust_app_event_notifier_rule
*event_notifier_rule
= NULL
;
1477 lttng_ht_lookup(ht
, &token
, &iter
);
1478 node
= lttng_ht_iter_get_node_u64(&iter
);
1480 DBG2("UST app event notifier rule token not found: token = %" PRIu64
,
1485 event_notifier_rule
= caa_container_of(
1486 node
, struct ust_app_event_notifier_rule
, node
);
1488 return event_notifier_rule
;
1492 * Create the channel context on the tracer.
1494 * Called with UST app session lock held.
1497 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1498 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1502 health_code_update();
1504 pthread_mutex_lock(&app
->sock_lock
);
1505 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1506 ua_chan
->obj
, &ua_ctx
->obj
);
1507 pthread_mutex_unlock(&app
->sock_lock
);
1509 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1510 ERR("UST app create channel context failed for app (pid: %d) "
1511 "with ret %d", app
->pid
, ret
);
1514 * This is normal behavior, an application can die during the
1515 * creation process. Don't report an error so the execution can
1516 * continue normally.
1519 DBG3("UST app add context failed. Application is dead.");
1524 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1526 DBG2("UST app context handle %d created successfully for channel %s",
1527 ua_ctx
->handle
, ua_chan
->name
);
1530 health_code_update();
1535 * Set the filter on the tracer.
1537 static int set_ust_object_filter(struct ust_app
*app
,
1538 const struct lttng_bytecode
*bytecode
,
1539 struct lttng_ust_object_data
*ust_object
)
1542 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1544 health_code_update();
1546 ust_bytecode
= create_ust_filter_bytecode_from_bytecode(bytecode
);
1547 if (!ust_bytecode
) {
1548 ret
= -LTTNG_ERR_NOMEM
;
1551 pthread_mutex_lock(&app
->sock_lock
);
1552 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1554 pthread_mutex_unlock(&app
->sock_lock
);
1556 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1557 ERR("UST app set object filter failed: object = %p of app pid = %d, ret = %d",
1558 ust_object
, app
->pid
, ret
);
1561 * This is normal behavior, an application can die during the
1562 * creation process. Don't report an error so the execution can
1563 * continue normally.
1566 DBG3("Failed to set UST app object filter. Application is dead.");
1571 DBG2("UST filter successfully set: object = %p", ust_object
);
1574 health_code_update();
1580 * Set a capture bytecode for the passed object.
1582 static int set_ust_capture(struct ust_app
*app
,
1583 const struct lttng_bytecode
*bytecode
,
1584 struct lttng_ust_object_data
*ust_object
)
1587 struct lttng_ust_capture_bytecode
*ust_bytecode
= NULL
;
1589 health_code_update();
1591 ust_bytecode
= create_ust_capture_bytecode_from_bytecode(bytecode
);
1592 if (!ust_bytecode
) {
1593 ret
= -LTTNG_ERR_NOMEM
;
1597 pthread_mutex_lock(&app
->sock_lock
);
1598 ret
= ustctl_set_capture(app
->sock
, ust_bytecode
,
1600 pthread_mutex_unlock(&app
->sock_lock
);
1602 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1603 ERR("UST app set object capture failed: object = %p of app pid = %d, ret = %d",
1604 ust_object
, app
->pid
, ret
);
1607 * This is normal behavior, an application can die during the
1608 * creation process. Don't report an error so the execution can
1609 * continue normally.
1612 DBG3("Failed to set UST app object capture. Application is dead.");
1618 DBG2("UST capture successfully set: object = %p", ust_object
);
1621 health_code_update();
1627 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1628 const struct lttng_event_exclusion
*exclusion
)
1630 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1631 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1632 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1634 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1635 if (!ust_exclusion
) {
1640 assert(sizeof(struct lttng_event_exclusion
) ==
1641 sizeof(struct lttng_ust_event_exclusion
));
1642 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1644 return ust_exclusion
;
1648 * Set event exclusions on the tracer.
1650 static int set_ust_object_exclusions(struct ust_app
*app
,
1651 const struct lttng_event_exclusion
*exclusions
,
1652 struct lttng_ust_object_data
*ust_object
)
1655 struct lttng_ust_event_exclusion
*ust_exclusions
= NULL
;
1657 assert(exclusions
&& exclusions
->count
> 0);
1659 health_code_update();
1661 ust_exclusions
= create_ust_exclusion_from_exclusion(
1663 if (!ust_exclusions
) {
1664 ret
= -LTTNG_ERR_NOMEM
;
1667 pthread_mutex_lock(&app
->sock_lock
);
1668 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1669 pthread_mutex_unlock(&app
->sock_lock
);
1671 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1672 ERR("Failed to set UST app exclusions for object %p of app (pid: %d) "
1673 "with ret %d", ust_object
, app
->pid
, ret
);
1676 * This is normal behavior, an application can die during the
1677 * creation process. Don't report an error so the execution can
1678 * continue normally.
1681 DBG3("Failed to set UST app object exclusions. Application is dead.");
1686 DBG2("UST exclusions set successfully for object %p", ust_object
);
1689 health_code_update();
1690 free(ust_exclusions
);
1695 * Disable the specified event on to UST tracer for the UST session.
1697 static int disable_ust_object(struct ust_app
*app
,
1698 struct lttng_ust_object_data
*object
)
1702 health_code_update();
1704 pthread_mutex_lock(&app
->sock_lock
);
1705 ret
= ustctl_disable(app
->sock
, object
);
1706 pthread_mutex_unlock(&app
->sock_lock
);
1708 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1709 ERR("Failed to disable UST app object %p app (pid: %d) with ret %d",
1710 object
, app
->pid
, ret
);
1713 * This is normal behavior, an application can die during the
1714 * creation process. Don't report an error so the execution can
1715 * continue normally.
1718 DBG3("Failed to disable UST app object. Application is dead.");
1723 DBG2("UST app object %p disabled successfully for app (pid: %d)",
1727 health_code_update();
1732 * Disable the specified channel on to UST tracer for the UST session.
1734 static int disable_ust_channel(struct ust_app
*app
,
1735 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1739 health_code_update();
1741 pthread_mutex_lock(&app
->sock_lock
);
1742 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1743 pthread_mutex_unlock(&app
->sock_lock
);
1745 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1746 ERR("UST app channel %s disable failed for app (pid: %d) "
1747 "and session handle %d with ret %d",
1748 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1751 * This is normal behavior, an application can die during the
1752 * creation process. Don't report an error so the execution can
1753 * continue normally.
1756 DBG3("UST app disable channel failed. Application is dead.");
1761 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1762 ua_chan
->name
, app
->pid
);
1765 health_code_update();
1770 * Enable the specified channel on to UST tracer for the UST session.
1772 static int enable_ust_channel(struct ust_app
*app
,
1773 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1777 health_code_update();
1779 pthread_mutex_lock(&app
->sock_lock
);
1780 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1781 pthread_mutex_unlock(&app
->sock_lock
);
1783 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1784 ERR("UST app channel %s enable failed for app (pid: %d) "
1785 "and session handle %d with ret %d",
1786 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1789 * This is normal behavior, an application can die during the
1790 * creation process. Don't report an error so the execution can
1791 * continue normally.
1794 DBG3("UST app enable channel failed. Application is dead.");
1799 ua_chan
->enabled
= 1;
1801 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1802 ua_chan
->name
, app
->pid
);
1805 health_code_update();
1810 * Enable the specified event on to UST tracer for the UST session.
1812 static int enable_ust_object(
1813 struct ust_app
*app
, struct lttng_ust_object_data
*ust_object
)
1817 health_code_update();
1819 pthread_mutex_lock(&app
->sock_lock
);
1820 ret
= ustctl_enable(app
->sock
, ust_object
);
1821 pthread_mutex_unlock(&app
->sock_lock
);
1823 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1824 ERR("UST app enable failed for object %p app (pid: %d) with ret %d",
1825 ust_object
, app
->pid
, ret
);
1828 * This is normal behavior, an application can die during the
1829 * creation process. Don't report an error so the execution can
1830 * continue normally.
1833 DBG3("Failed to enable UST app object. Application is dead.");
1838 DBG2("UST app object %p enabled successfully for app (pid: %d)",
1839 ust_object
, app
->pid
);
1842 health_code_update();
1847 * Send channel and stream buffer to application.
1849 * Return 0 on success. On error, a negative value is returned.
1851 static int send_channel_pid_to_ust(struct ust_app
*app
,
1852 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1855 struct ust_app_stream
*stream
, *stmp
;
1861 health_code_update();
1863 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1866 /* Send channel to the application. */
1867 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1868 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1869 ret
= -ENOTCONN
; /* Caused by app exiting. */
1871 } else if (ret
< 0) {
1875 health_code_update();
1877 /* Send all streams to application. */
1878 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1879 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1880 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1881 ret
= -ENOTCONN
; /* Caused by app exiting. */
1883 } else if (ret
< 0) {
1886 /* We don't need the stream anymore once sent to the tracer. */
1887 cds_list_del(&stream
->list
);
1888 delete_ust_app_stream(-1, stream
, app
);
1890 /* Flag the channel that it is sent to the application. */
1891 ua_chan
->is_sent
= 1;
1894 health_code_update();
1899 * Create the specified event onto the UST tracer for a UST session.
1901 * Should be called with session mutex held.
1904 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1905 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1909 health_code_update();
1911 /* Create UST event on tracer */
1912 pthread_mutex_lock(&app
->sock_lock
);
1913 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1915 pthread_mutex_unlock(&app
->sock_lock
);
1917 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1919 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1920 ua_event
->attr
.name
, app
->pid
, ret
);
1923 * This is normal behavior, an application can die during the
1924 * creation process. Don't report an error so the execution can
1925 * continue normally.
1928 DBG3("UST app create event failed. Application is dead.");
1933 ua_event
->handle
= ua_event
->obj
->handle
;
1935 DBG2("UST app event %s created successfully for pid:%d object: %p",
1936 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
1938 health_code_update();
1940 /* Set filter if one is present. */
1941 if (ua_event
->filter
) {
1942 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
1948 /* Set exclusions for the event */
1949 if (ua_event
->exclusion
) {
1950 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
1956 /* If event not enabled, disable it on the tracer */
1957 if (ua_event
->enabled
) {
1959 * We now need to explicitly enable the event, since it
1960 * is now disabled at creation.
1962 ret
= enable_ust_object(app
, ua_event
->obj
);
1965 * If we hit an EPERM, something is wrong with our enable call. If
1966 * we get an EEXIST, there is a problem on the tracer side since we
1970 case -LTTNG_UST_ERR_PERM
:
1971 /* Code flow problem */
1973 case -LTTNG_UST_ERR_EXIST
:
1974 /* It's OK for our use case. */
1985 health_code_update();
1989 static int init_ust_event_notifier_from_event_rule(
1990 const struct lttng_event_rule
*rule
,
1991 struct lttng_ust_event_notifier
*event_notifier
)
1993 enum lttng_event_rule_status status
;
1994 enum lttng_loglevel_type loglevel_type
;
1995 enum lttng_ust_loglevel_type ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1996 int loglevel
= -1, ret
= 0;
1997 const char *pattern
;
1999 /* For now only LTTNG_EVENT_RULE_TYPE_TRACEPOINT are supported. */
2000 assert(lttng_event_rule_get_type(rule
) ==
2001 LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
2003 memset(event_notifier
, 0, sizeof(*event_notifier
));
2005 if (lttng_event_rule_targets_agent_domain(rule
)) {
2007 * Special event for agents
2008 * The actual meat of the event is in the filter that will be
2009 * attached later on.
2010 * Set the default values for the agent event.
2012 pattern
= event_get_default_agent_ust_name(
2013 lttng_event_rule_get_domain_type(rule
));
2015 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
2017 status
= lttng_event_rule_tracepoint_get_pattern(
2019 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2020 /* At this point, this is a fatal error. */
2024 status
= lttng_event_rule_tracepoint_get_log_level_type(
2025 rule
, &loglevel_type
);
2026 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2027 /* At this point, this is a fatal error. */
2031 switch (loglevel_type
) {
2032 case LTTNG_EVENT_LOGLEVEL_ALL
:
2033 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
2035 case LTTNG_EVENT_LOGLEVEL_RANGE
:
2036 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
2038 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
2039 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
2042 /* Unknown log level specification type. */
2046 if (loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
2047 status
= lttng_event_rule_tracepoint_get_log_level(
2049 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
2053 event_notifier
->event
.instrumentation
= LTTNG_UST_TRACEPOINT
;
2054 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
2055 LTTNG_UST_SYM_NAME_LEN
- 1);
2057 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
2062 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
2063 event_notifier
->event
.loglevel
= loglevel
;
2069 * Create the specified event notifier against the user space tracer of a
2070 * given application.
2072 static int create_ust_event_notifier(struct ust_app
*app
,
2073 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2076 enum lttng_condition_status condition_status
;
2077 const struct lttng_condition
*condition
= NULL
;
2078 struct lttng_ust_event_notifier event_notifier
;
2079 const struct lttng_event_rule
*event_rule
= NULL
;
2081 health_code_update();
2082 assert(app
->event_notifier_group
.object
);
2084 condition
= lttng_trigger_get_const_condition(
2085 ua_event_notifier_rule
->trigger
);
2087 assert(lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
);
2089 condition_status
= lttng_condition_event_rule_get_rule(condition
, &event_rule
);
2090 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2092 assert(lttng_event_rule_get_type(event_rule
) == LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
2094 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2095 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2097 /* Create UST event notifier against the tracer. */
2098 pthread_mutex_lock(&app
->sock_lock
);
2099 ret
= ustctl_create_event_notifier(app
->sock
, &event_notifier
,
2100 app
->event_notifier_group
.object
,
2101 &ua_event_notifier_rule
->obj
);
2102 pthread_mutex_unlock(&app
->sock_lock
);
2104 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2105 ERR("Error ustctl create event notifier: name = '%s', app = '%s' (ppid: %d), ret = %d",
2106 event_notifier
.event
.name
, app
->name
,
2110 * This is normal behavior, an application can die
2111 * during the creation process. Don't report an error so
2112 * the execution can continue normally.
2115 DBG3("UST app create event notifier failed (application is dead): app = '%s' (ppid = %d)",
2116 app
->name
, app
->ppid
);
2122 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2124 DBG2("UST app event notifier %s created successfully: app = '%s' (ppid: %d), object: %p",
2125 event_notifier
.event
.name
, app
->name
, app
->ppid
,
2126 ua_event_notifier_rule
->obj
);
2128 health_code_update();
2130 /* Set filter if one is present. */
2131 if (ua_event_notifier_rule
->filter
) {
2132 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2133 ua_event_notifier_rule
->obj
);
2139 /* Set exclusions for the event. */
2140 if (ua_event_notifier_rule
->exclusion
) {
2141 ret
= set_ust_object_exclusions(app
,
2142 ua_event_notifier_rule
->exclusion
,
2143 ua_event_notifier_rule
->obj
);
2150 * We now need to explicitly enable the event, since it
2151 * is disabled at creation.
2153 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2156 * If we hit an EPERM, something is wrong with our enable call.
2157 * If we get an EEXIST, there is a problem on the tracer side
2158 * since we just created it.
2161 case -LTTNG_UST_ERR_PERM
:
2162 /* Code flow problem. */
2164 case -LTTNG_UST_ERR_EXIST
:
2165 /* It's OK for our use case. */
2175 ua_event_notifier_rule
->enabled
= true;
2178 health_code_update();
2183 * Copy data between an UST app event and a LTT event.
2185 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2186 struct ltt_ust_event
*uevent
)
2188 size_t exclusion_alloc_size
;
2190 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2191 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2193 ua_event
->enabled
= uevent
->enabled
;
2195 /* Copy event attributes */
2196 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2198 /* Copy filter bytecode */
2199 if (uevent
->filter
) {
2200 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2201 /* Filter might be NULL here in case of ENONEM. */
2204 /* Copy exclusion data */
2205 if (uevent
->exclusion
) {
2206 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2207 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2208 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2209 if (ua_event
->exclusion
== NULL
) {
2212 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2213 exclusion_alloc_size
);
2219 * Copy data between an UST app channel and a LTT channel.
2221 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2222 struct ltt_ust_channel
*uchan
)
2224 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2226 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2227 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2229 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2230 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2232 /* Copy event attributes since the layout is different. */
2233 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2234 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2235 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2236 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2237 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2238 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2239 ua_chan
->attr
.output
= uchan
->attr
.output
;
2240 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2243 * Note that the attribute channel type is not set since the channel on the
2244 * tracing registry side does not have this information.
2247 ua_chan
->enabled
= uchan
->enabled
;
2248 ua_chan
->tracing_channel_id
= uchan
->id
;
2250 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2254 * Copy data between a UST app session and a regular LTT session.
2256 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2257 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2259 struct tm
*timeinfo
;
2262 char tmp_shm_path
[PATH_MAX
];
2264 timeinfo
= localtime(&app
->registration_time
);
2265 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2267 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2269 ua_sess
->tracing_id
= usess
->id
;
2270 ua_sess
->id
= get_next_session_id();
2271 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2272 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2273 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2274 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2275 ua_sess
->buffer_type
= usess
->buffer_type
;
2276 ua_sess
->bits_per_long
= app
->bits_per_long
;
2278 /* There is only one consumer object per session possible. */
2279 consumer_output_get(usess
->consumer
);
2280 ua_sess
->consumer
= usess
->consumer
;
2282 ua_sess
->output_traces
= usess
->output_traces
;
2283 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2284 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2285 &usess
->metadata_attr
);
2287 switch (ua_sess
->buffer_type
) {
2288 case LTTNG_BUFFER_PER_PID
:
2289 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2290 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2293 case LTTNG_BUFFER_PER_UID
:
2294 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2295 DEFAULT_UST_TRACE_UID_PATH
,
2296 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2297 app
->bits_per_long
);
2304 PERROR("asprintf UST shadow copy session");
2309 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2310 sizeof(ua_sess
->root_shm_path
));
2311 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2312 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2313 sizeof(ua_sess
->shm_path
));
2314 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2315 if (ua_sess
->shm_path
[0]) {
2316 switch (ua_sess
->buffer_type
) {
2317 case LTTNG_BUFFER_PER_PID
:
2318 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2319 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2320 app
->name
, app
->pid
, datetime
);
2322 case LTTNG_BUFFER_PER_UID
:
2323 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2324 "/" DEFAULT_UST_TRACE_UID_PATH
,
2325 app
->uid
, app
->bits_per_long
);
2332 PERROR("sprintf UST shadow copy session");
2336 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2337 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2338 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2343 consumer_output_put(ua_sess
->consumer
);
2347 * Lookup sesison wrapper.
2350 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2351 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2353 /* Get right UST app session from app */
2354 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2358 * Return ust app session from the app session hashtable using the UST session
2361 static struct ust_app_session
*lookup_session_by_app(
2362 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2364 struct lttng_ht_iter iter
;
2365 struct lttng_ht_node_u64
*node
;
2367 __lookup_session_by_app(usess
, app
, &iter
);
2368 node
= lttng_ht_iter_get_node_u64(&iter
);
2373 return caa_container_of(node
, struct ust_app_session
, node
);
2380 * Setup buffer registry per PID for the given session and application. If none
2381 * is found, a new one is created, added to the global registry and
2382 * initialized. If regp is valid, it's set with the newly created object.
2384 * Return 0 on success or else a negative value.
2386 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2387 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2390 struct buffer_reg_pid
*reg_pid
;
2397 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2400 * This is the create channel path meaning that if there is NO
2401 * registry available, we have to create one for this session.
2403 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2404 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2412 /* Initialize registry. */
2413 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2414 app
->bits_per_long
, app
->uint8_t_alignment
,
2415 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2416 app
->uint64_t_alignment
, app
->long_alignment
,
2417 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2418 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2419 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2420 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2421 ua_sess
->tracing_id
,
2425 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2426 * destroy the buffer registry, because it is always expected
2427 * that if the buffer registry can be found, its ust registry is
2430 buffer_reg_pid_destroy(reg_pid
);
2434 buffer_reg_pid_add(reg_pid
);
2436 DBG3("UST app buffer registry per PID created successfully");
2448 * Setup buffer registry per UID for the given session and application. If none
2449 * is found, a new one is created, added to the global registry and
2450 * initialized. If regp is valid, it's set with the newly created object.
2452 * Return 0 on success or else a negative value.
2454 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2455 struct ust_app_session
*ua_sess
,
2456 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2459 struct buffer_reg_uid
*reg_uid
;
2466 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2469 * This is the create channel path meaning that if there is NO
2470 * registry available, we have to create one for this session.
2472 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2473 LTTNG_DOMAIN_UST
, ®_uid
,
2474 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2482 /* Initialize registry. */
2483 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2484 app
->bits_per_long
, app
->uint8_t_alignment
,
2485 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2486 app
->uint64_t_alignment
, app
->long_alignment
,
2487 app
->byte_order
, app
->version
.major
,
2488 app
->version
.minor
, reg_uid
->root_shm_path
,
2489 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2490 ua_sess
->tracing_id
, app
->uid
);
2493 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2494 * destroy the buffer registry, because it is always expected
2495 * that if the buffer registry can be found, its ust registry is
2498 buffer_reg_uid_destroy(reg_uid
, NULL
);
2501 /* Add node to teardown list of the session. */
2502 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2504 buffer_reg_uid_add(reg_uid
);
2506 DBG3("UST app buffer registry per UID created successfully");
2517 * Create a session on the tracer side for the given app.
2519 * On success, ua_sess_ptr is populated with the session pointer or else left
2520 * untouched. If the session was created, is_created is set to 1. On error,
2521 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2524 * Returns 0 on success or else a negative code which is either -ENOMEM or
2525 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2527 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2528 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2531 int ret
, created
= 0;
2532 struct ust_app_session
*ua_sess
;
2536 assert(ua_sess_ptr
);
2538 health_code_update();
2540 ua_sess
= lookup_session_by_app(usess
, app
);
2541 if (ua_sess
== NULL
) {
2542 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2543 app
->pid
, usess
->id
);
2544 ua_sess
= alloc_ust_app_session();
2545 if (ua_sess
== NULL
) {
2546 /* Only malloc can failed so something is really wrong */
2550 shadow_copy_session(ua_sess
, usess
, app
);
2554 switch (usess
->buffer_type
) {
2555 case LTTNG_BUFFER_PER_PID
:
2556 /* Init local registry. */
2557 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2559 delete_ust_app_session(-1, ua_sess
, app
);
2563 case LTTNG_BUFFER_PER_UID
:
2564 /* Look for a global registry. If none exists, create one. */
2565 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2567 delete_ust_app_session(-1, ua_sess
, app
);
2577 health_code_update();
2579 if (ua_sess
->handle
== -1) {
2580 pthread_mutex_lock(&app
->sock_lock
);
2581 ret
= ustctl_create_session(app
->sock
);
2582 pthread_mutex_unlock(&app
->sock_lock
);
2584 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2585 ERR("Creating session for app pid %d with ret %d",
2588 DBG("UST app creating session failed. Application is dead");
2590 * This is normal behavior, an application can die during the
2591 * creation process. Don't report an error so the execution can
2592 * continue normally. This will get flagged ENOTCONN and the
2593 * caller will handle it.
2597 delete_ust_app_session(-1, ua_sess
, app
);
2598 if (ret
!= -ENOMEM
) {
2600 * Tracer is probably gone or got an internal error so let's
2601 * behave like it will soon unregister or not usable.
2608 ua_sess
->handle
= ret
;
2610 /* Add ust app session to app's HT */
2611 lttng_ht_node_init_u64(&ua_sess
->node
,
2612 ua_sess
->tracing_id
);
2613 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2614 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2615 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2616 &ua_sess
->ust_objd_node
);
2618 DBG2("UST app session created successfully with handle %d", ret
);
2621 *ua_sess_ptr
= ua_sess
;
2623 *is_created
= created
;
2626 /* Everything went well. */
2630 health_code_update();
2635 * Match function for a hash table lookup of ust_app_ctx.
2637 * It matches an ust app context based on the context type and, in the case
2638 * of perf counters, their name.
2640 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2642 struct ust_app_ctx
*ctx
;
2643 const struct lttng_ust_context_attr
*key
;
2648 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2652 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2657 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2658 if (strncmp(key
->u
.perf_counter
.name
,
2659 ctx
->ctx
.u
.perf_counter
.name
,
2660 sizeof(key
->u
.perf_counter
.name
))) {
2664 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2665 if (strcmp(key
->u
.app_ctx
.provider_name
,
2666 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2667 strcmp(key
->u
.app_ctx
.ctx_name
,
2668 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2684 * Lookup for an ust app context from an lttng_ust_context.
2686 * Must be called while holding RCU read side lock.
2687 * Return an ust_app_ctx object or NULL on error.
2690 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2691 struct lttng_ust_context_attr
*uctx
)
2693 struct lttng_ht_iter iter
;
2694 struct lttng_ht_node_ulong
*node
;
2695 struct ust_app_ctx
*app_ctx
= NULL
;
2700 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2701 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2702 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2703 node
= lttng_ht_iter_get_node_ulong(&iter
);
2708 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2715 * Create a context for the channel on the tracer.
2717 * Called with UST app session lock held and a RCU read side lock.
2720 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2721 struct lttng_ust_context_attr
*uctx
,
2722 struct ust_app
*app
)
2725 struct ust_app_ctx
*ua_ctx
;
2727 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2729 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2735 ua_ctx
= alloc_ust_app_ctx(uctx
);
2736 if (ua_ctx
== NULL
) {
2742 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2743 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2744 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2746 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2756 * Enable on the tracer side a ust app event for the session and channel.
2758 * Called with UST app session lock held.
2761 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2762 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2766 ret
= enable_ust_object(app
, ua_event
->obj
);
2771 ua_event
->enabled
= 1;
2778 * Disable on the tracer side a ust app event for the session and channel.
2780 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2781 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2785 ret
= disable_ust_object(app
, ua_event
->obj
);
2790 ua_event
->enabled
= 0;
2797 * Lookup ust app channel for session and disable it on the tracer side.
2800 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2801 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2805 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2810 ua_chan
->enabled
= 0;
2817 * Lookup ust app channel for session and enable it on the tracer side. This
2818 * MUST be called with a RCU read side lock acquired.
2820 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2821 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2824 struct lttng_ht_iter iter
;
2825 struct lttng_ht_node_str
*ua_chan_node
;
2826 struct ust_app_channel
*ua_chan
;
2828 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2829 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2830 if (ua_chan_node
== NULL
) {
2831 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2832 uchan
->name
, ua_sess
->tracing_id
);
2836 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2838 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2848 * Ask the consumer to create a channel and get it if successful.
2850 * Called with UST app session lock held.
2852 * Return 0 on success or else a negative value.
2854 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2855 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2856 int bitness
, struct ust_registry_session
*registry
,
2857 uint64_t trace_archive_id
)
2860 unsigned int nb_fd
= 0;
2861 struct consumer_socket
*socket
;
2869 health_code_update();
2871 /* Get the right consumer socket for the application. */
2872 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2878 health_code_update();
2880 /* Need one fd for the channel. */
2881 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2883 ERR("Exhausted number of available FD upon create channel");
2888 * Ask consumer to create channel. The consumer will return the number of
2889 * stream we have to expect.
2891 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2892 registry
, usess
->current_trace_chunk
);
2898 * Compute the number of fd needed before receiving them. It must be 2 per
2899 * stream (2 being the default value here).
2901 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2903 /* Reserve the amount of file descriptor we need. */
2904 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2906 ERR("Exhausted number of available FD upon create channel");
2907 goto error_fd_get_stream
;
2910 health_code_update();
2913 * Now get the channel from the consumer. This call wil populate the stream
2914 * list of that channel and set the ust objects.
2916 if (usess
->consumer
->enabled
) {
2917 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2927 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2928 error_fd_get_stream
:
2930 * Initiate a destroy channel on the consumer since we had an error
2931 * handling it on our side. The return value is of no importance since we
2932 * already have a ret value set by the previous error that we need to
2935 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2937 lttng_fd_put(LTTNG_FD_APPS
, 1);
2939 health_code_update();
2945 * Duplicate the ust data object of the ust app stream and save it in the
2946 * buffer registry stream.
2948 * Return 0 on success or else a negative value.
2950 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2951 struct ust_app_stream
*stream
)
2958 /* Reserve the amount of file descriptor we need. */
2959 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2961 ERR("Exhausted number of available FD upon duplicate stream");
2965 /* Duplicate object for stream once the original is in the registry. */
2966 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2967 reg_stream
->obj
.ust
);
2969 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2970 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2971 lttng_fd_put(LTTNG_FD_APPS
, 2);
2974 stream
->handle
= stream
->obj
->handle
;
2981 * Duplicate the ust data object of the ust app. channel and save it in the
2982 * buffer registry channel.
2984 * Return 0 on success or else a negative value.
2986 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2987 struct ust_app_channel
*ua_chan
)
2994 /* Need two fds for the channel. */
2995 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2997 ERR("Exhausted number of available FD upon duplicate channel");
3001 /* Duplicate object for stream once the original is in the registry. */
3002 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
3004 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
3005 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
3008 ua_chan
->handle
= ua_chan
->obj
->handle
;
3013 lttng_fd_put(LTTNG_FD_APPS
, 1);
3019 * For a given channel buffer registry, setup all streams of the given ust
3020 * application channel.
3022 * Return 0 on success or else a negative value.
3024 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
3025 struct ust_app_channel
*ua_chan
,
3026 struct ust_app
*app
)
3029 struct ust_app_stream
*stream
, *stmp
;
3034 DBG2("UST app setup buffer registry stream");
3036 /* Send all streams to application. */
3037 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
3038 struct buffer_reg_stream
*reg_stream
;
3040 ret
= buffer_reg_stream_create(®_stream
);
3046 * Keep original pointer and nullify it in the stream so the delete
3047 * stream call does not release the object.
3049 reg_stream
->obj
.ust
= stream
->obj
;
3051 buffer_reg_stream_add(reg_stream
, reg_chan
);
3053 /* We don't need the streams anymore. */
3054 cds_list_del(&stream
->list
);
3055 delete_ust_app_stream(-1, stream
, app
);
3063 * Create a buffer registry channel for the given session registry and
3064 * application channel object. If regp pointer is valid, it's set with the
3065 * created object. Important, the created object is NOT added to the session
3066 * registry hash table.
3068 * Return 0 on success else a negative value.
3070 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3071 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
3074 struct buffer_reg_channel
*reg_chan
= NULL
;
3079 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3081 /* Create buffer registry channel. */
3082 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
3087 reg_chan
->consumer_key
= ua_chan
->key
;
3088 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3089 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3091 /* Create and add a channel registry to session. */
3092 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3093 ua_chan
->tracing_channel_id
);
3097 buffer_reg_channel_add(reg_sess
, reg_chan
);
3106 /* Safe because the registry channel object was not added to any HT. */
3107 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3113 * Setup buffer registry channel for the given session registry and application
3114 * channel object. If regp pointer is valid, it's set with the created object.
3116 * Return 0 on success else a negative value.
3118 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3119 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
3120 struct ust_app
*app
)
3127 assert(ua_chan
->obj
);
3129 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3131 /* Setup all streams for the registry. */
3132 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
3137 reg_chan
->obj
.ust
= ua_chan
->obj
;
3138 ua_chan
->obj
= NULL
;
3143 buffer_reg_channel_remove(reg_sess
, reg_chan
);
3144 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3149 * Send buffer registry channel to the application.
3151 * Return 0 on success else a negative value.
3153 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
3154 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3155 struct ust_app_channel
*ua_chan
)
3158 struct buffer_reg_stream
*reg_stream
;
3165 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3167 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
3172 /* Send channel to the application. */
3173 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3174 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3175 ret
= -ENOTCONN
; /* Caused by app exiting. */
3177 } else if (ret
< 0) {
3181 health_code_update();
3183 /* Send all streams to application. */
3184 pthread_mutex_lock(®_chan
->stream_list_lock
);
3185 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
3186 struct ust_app_stream stream
;
3188 ret
= duplicate_stream_object(reg_stream
, &stream
);
3190 goto error_stream_unlock
;
3193 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3195 (void) release_ust_app_stream(-1, &stream
, app
);
3196 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3197 ret
= -ENOTCONN
; /* Caused by app exiting. */
3199 goto error_stream_unlock
;
3203 * The return value is not important here. This function will output an
3206 (void) release_ust_app_stream(-1, &stream
, app
);
3208 ua_chan
->is_sent
= 1;
3210 error_stream_unlock
:
3211 pthread_mutex_unlock(®_chan
->stream_list_lock
);
3217 * Create and send to the application the created buffers with per UID buffers.
3219 * This MUST be called with a RCU read side lock acquired.
3220 * The session list lock and the session's lock must be acquired.
3222 * Return 0 on success else a negative value.
3224 static int create_channel_per_uid(struct ust_app
*app
,
3225 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3226 struct ust_app_channel
*ua_chan
)
3229 struct buffer_reg_uid
*reg_uid
;
3230 struct buffer_reg_channel
*reg_chan
;
3231 struct ltt_session
*session
= NULL
;
3232 enum lttng_error_code notification_ret
;
3233 struct ust_registry_channel
*chan_reg
;
3240 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3242 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3244 * The session creation handles the creation of this global registry
3245 * object. If none can be find, there is a code flow problem or a
3250 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3256 /* Create the buffer registry channel object. */
3257 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
3259 ERR("Error creating the UST channel \"%s\" registry instance",
3264 session
= session_find_by_id(ua_sess
->tracing_id
);
3266 assert(pthread_mutex_trylock(&session
->lock
));
3267 assert(session_trylock_list());
3270 * Create the buffers on the consumer side. This call populates the
3271 * ust app channel object with all streams and data object.
3273 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3274 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3275 session
->most_recent_chunk_id
.value
);
3277 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3281 * Let's remove the previously created buffer registry channel so
3282 * it's not visible anymore in the session registry.
3284 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3285 ua_chan
->tracing_channel_id
, false);
3286 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
3287 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3292 * Setup the streams and add it to the session registry.
3294 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3295 ua_chan
, reg_chan
, app
);
3297 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3301 /* Notify the notification subsystem of the channel's creation. */
3302 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3303 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3304 ua_chan
->tracing_channel_id
);
3306 chan_reg
->consumer_key
= ua_chan
->key
;
3308 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3310 notification_ret
= notification_thread_command_add_channel(
3311 notification_thread_handle
, session
->name
,
3312 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3313 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3315 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3316 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3317 if (notification_ret
!= LTTNG_OK
) {
3318 ret
= - (int) notification_ret
;
3319 ERR("Failed to add channel to notification thread");
3324 /* Send buffers to the application. */
3325 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
3327 if (ret
!= -ENOTCONN
) {
3328 ERR("Error sending channel to application");
3335 session_put(session
);
3341 * Create and send to the application the created buffers with per PID buffers.
3343 * Called with UST app session lock held.
3344 * The session list lock and the session's lock must be acquired.
3346 * Return 0 on success else a negative value.
3348 static int create_channel_per_pid(struct ust_app
*app
,
3349 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3350 struct ust_app_channel
*ua_chan
)
3353 struct ust_registry_session
*registry
;
3354 enum lttng_error_code cmd_ret
;
3355 struct ltt_session
*session
= NULL
;
3356 uint64_t chan_reg_key
;
3357 struct ust_registry_channel
*chan_reg
;
3364 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3368 registry
= get_session_registry(ua_sess
);
3369 /* The UST app session lock is held, registry shall not be null. */
3372 /* Create and add a new channel registry to session. */
3373 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3375 ERR("Error creating the UST channel \"%s\" registry instance",
3380 session
= session_find_by_id(ua_sess
->tracing_id
);
3383 assert(pthread_mutex_trylock(&session
->lock
));
3384 assert(session_trylock_list());
3386 /* Create and get channel on the consumer side. */
3387 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3388 app
->bits_per_long
, registry
,
3389 session
->most_recent_chunk_id
.value
);
3391 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3393 goto error_remove_from_registry
;
3396 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3398 if (ret
!= -ENOTCONN
) {
3399 ERR("Error sending channel to application");
3401 goto error_remove_from_registry
;
3404 chan_reg_key
= ua_chan
->key
;
3405 pthread_mutex_lock(®istry
->lock
);
3406 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3408 chan_reg
->consumer_key
= ua_chan
->key
;
3409 pthread_mutex_unlock(®istry
->lock
);
3411 cmd_ret
= notification_thread_command_add_channel(
3412 notification_thread_handle
, session
->name
,
3413 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3414 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3416 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3417 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3418 if (cmd_ret
!= LTTNG_OK
) {
3419 ret
= - (int) cmd_ret
;
3420 ERR("Failed to add channel to notification thread");
3421 goto error_remove_from_registry
;
3424 error_remove_from_registry
:
3426 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3431 session_put(session
);
3437 * From an already allocated ust app channel, create the channel buffers if
3438 * needed and send them to the application. This MUST be called with a RCU read
3439 * side lock acquired.
3441 * Called with UST app session lock held.
3443 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3444 * the application exited concurrently.
3446 static int ust_app_channel_send(struct ust_app
*app
,
3447 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3448 struct ust_app_channel
*ua_chan
)
3454 assert(usess
->active
);
3458 /* Handle buffer type before sending the channel to the application. */
3459 switch (usess
->buffer_type
) {
3460 case LTTNG_BUFFER_PER_UID
:
3462 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3468 case LTTNG_BUFFER_PER_PID
:
3470 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3482 /* Initialize ust objd object using the received handle and add it. */
3483 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3484 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3486 /* If channel is not enabled, disable it on the tracer */
3487 if (!ua_chan
->enabled
) {
3488 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3499 * Create UST app channel and return it through ua_chanp if not NULL.
3501 * Called with UST app session lock and RCU read-side lock held.
3503 * Return 0 on success or else a negative value.
3505 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3506 struct ltt_ust_channel
*uchan
,
3507 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3508 struct ust_app_channel
**ua_chanp
)
3511 struct lttng_ht_iter iter
;
3512 struct lttng_ht_node_str
*ua_chan_node
;
3513 struct ust_app_channel
*ua_chan
;
3515 /* Lookup channel in the ust app session */
3516 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3517 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3518 if (ua_chan_node
!= NULL
) {
3519 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3523 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3524 if (ua_chan
== NULL
) {
3525 /* Only malloc can fail here */
3529 shadow_copy_channel(ua_chan
, uchan
);
3531 /* Set channel type. */
3532 ua_chan
->attr
.type
= type
;
3534 /* Only add the channel if successful on the tracer side. */
3535 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3538 *ua_chanp
= ua_chan
;
3541 /* Everything went well. */
3549 * Create UST app event and create it on the tracer side.
3551 * Must be called with the RCU read side lock held.
3552 * Called with ust app session mutex held.
3555 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3556 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3557 struct ust_app
*app
)
3560 struct ust_app_event
*ua_event
;
3562 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3563 if (ua_event
== NULL
) {
3564 /* Only failure mode of alloc_ust_app_event(). */
3568 shadow_copy_event(ua_event
, uevent
);
3570 /* Create it on the tracer side */
3571 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3574 * Not found previously means that it does not exist on the
3575 * tracer. If the application reports that the event existed,
3576 * it means there is a bug in the sessiond or lttng-ust
3577 * (or corruption, etc.)
3579 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3580 ERR("Tracer for application reported that an event being created already existed: "
3581 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3583 app
->pid
, app
->ppid
, app
->uid
,
3589 add_unique_ust_app_event(ua_chan
, ua_event
);
3591 DBG2("UST app create event completed: app = '%s' (ppid: %d)",
3592 app
->name
, app
->ppid
);
3598 /* Valid. Calling here is already in a read side lock */
3599 delete_ust_app_event(-1, ua_event
, app
);
3604 * Create UST app event notifier rule and create it on the tracer side.
3606 * Must be called with the RCU read side lock held.
3607 * Called with ust app session mutex held.
3610 int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
,
3611 struct ust_app
*app
)
3614 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3616 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3617 if (ua_event_notifier_rule
== NULL
) {
3622 /* Create it on the tracer side. */
3623 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3626 * Not found previously means that it does not exist on the
3627 * tracer. If the application reports that the event existed,
3628 * it means there is a bug in the sessiond or lttng-ust
3629 * (or corruption, etc.)
3631 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3632 ERR("Tracer for application reported that an event notifier being created already exists: "
3633 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3634 lttng_trigger_get_tracer_token(trigger
),
3635 app
->pid
, app
->ppid
, app
->uid
,
3641 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3642 &ua_event_notifier_rule
->node
);
3644 DBG2("UST app create token event rule completed: app = '%s' (ppid: %d), token = %" PRIu64
,
3645 app
->name
, app
->ppid
, lttng_trigger_get_tracer_token(trigger
));
3651 /* The RCU read side lock is already being held by the caller. */
3652 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3657 * Create UST metadata and open it on the tracer side.
3659 * Called with UST app session lock held and RCU read side lock.
3661 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3662 struct ust_app
*app
, struct consumer_output
*consumer
)
3665 struct ust_app_channel
*metadata
;
3666 struct consumer_socket
*socket
;
3667 struct ust_registry_session
*registry
;
3668 struct ltt_session
*session
= NULL
;
3674 registry
= get_session_registry(ua_sess
);
3675 /* The UST app session is held registry shall not be null. */
3678 pthread_mutex_lock(®istry
->lock
);
3680 /* Metadata already exists for this registry or it was closed previously */
3681 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3686 /* Allocate UST metadata */
3687 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3689 /* malloc() failed */
3694 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3696 /* Need one fd for the channel. */
3697 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3699 ERR("Exhausted number of available FD upon create metadata");
3703 /* Get the right consumer socket for the application. */
3704 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3707 goto error_consumer
;
3711 * Keep metadata key so we can identify it on the consumer side. Assign it
3712 * to the registry *before* we ask the consumer so we avoid the race of the
3713 * consumer requesting the metadata and the ask_channel call on our side
3714 * did not returned yet.
3716 registry
->metadata_key
= metadata
->key
;
3718 session
= session_find_by_id(ua_sess
->tracing_id
);
3721 assert(pthread_mutex_trylock(&session
->lock
));
3722 assert(session_trylock_list());
3725 * Ask the metadata channel creation to the consumer. The metadata object
3726 * will be created by the consumer and kept their. However, the stream is
3727 * never added or monitored until we do a first push metadata to the
3730 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3731 registry
, session
->current_trace_chunk
);
3733 /* Nullify the metadata key so we don't try to close it later on. */
3734 registry
->metadata_key
= 0;
3735 goto error_consumer
;
3739 * The setup command will make the metadata stream be sent to the relayd,
3740 * if applicable, and the thread managing the metadatas. This is important
3741 * because after this point, if an error occurs, the only way the stream
3742 * can be deleted is to be monitored in the consumer.
3744 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3746 /* Nullify the metadata key so we don't try to close it later on. */
3747 registry
->metadata_key
= 0;
3748 goto error_consumer
;
3751 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3752 metadata
->key
, app
->pid
);
3755 lttng_fd_put(LTTNG_FD_APPS
, 1);
3756 delete_ust_app_channel(-1, metadata
, app
);
3758 pthread_mutex_unlock(®istry
->lock
);
3760 session_put(session
);
3766 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3767 * acquired before calling this function.
3769 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3771 struct ust_app
*app
= NULL
;
3772 struct lttng_ht_node_ulong
*node
;
3773 struct lttng_ht_iter iter
;
3775 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3776 node
= lttng_ht_iter_get_node_ulong(&iter
);
3778 DBG2("UST app no found with pid %d", pid
);
3782 DBG2("Found UST app by pid %d", pid
);
3784 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3791 * Allocate and init an UST app object using the registration information and
3792 * the command socket. This is called when the command socket connects to the
3795 * The object is returned on success or else NULL.
3797 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3800 struct ust_app
*lta
= NULL
;
3801 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3806 DBG3("UST app creating application for socket %d", sock
);
3808 if ((msg
->bits_per_long
== 64 &&
3809 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3810 || (msg
->bits_per_long
== 32 &&
3811 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3812 ERR("Registration failed: application \"%s\" (pid: %d) has "
3813 "%d-bit long, but no consumerd for this size is available.\n",
3814 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3819 * Reserve the two file descriptors of the event source pipe. The write
3820 * end will be closed once it is passed to the application, at which
3821 * point a single 'put' will be performed.
3823 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3825 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s' (ppid: %d)",
3826 msg
->name
, (int) msg
->ppid
);
3830 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3831 if (!event_notifier_event_source_pipe
) {
3832 PERROR("Failed to open application event source pipe: '%s' (ppid = %d)",
3833 msg
->name
, msg
->ppid
);
3837 lta
= zmalloc(sizeof(struct ust_app
));
3840 goto error_free_pipe
;
3843 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
3845 lta
->ppid
= msg
->ppid
;
3846 lta
->uid
= msg
->uid
;
3847 lta
->gid
= msg
->gid
;
3849 lta
->bits_per_long
= msg
->bits_per_long
;
3850 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3851 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3852 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3853 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3854 lta
->long_alignment
= msg
->long_alignment
;
3855 lta
->byte_order
= msg
->byte_order
;
3857 lta
->v_major
= msg
->major
;
3858 lta
->v_minor
= msg
->minor
;
3859 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3860 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3861 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3862 lta
->notify_sock
= -1;
3863 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3865 /* Copy name and make sure it's NULL terminated. */
3866 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3867 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3870 * Before this can be called, when receiving the registration information,
3871 * the application compatibility is checked. So, at this point, the
3872 * application can work with this session daemon.
3874 lta
->compatible
= 1;
3876 lta
->pid
= msg
->pid
;
3877 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3879 pthread_mutex_init(<a
->sock_lock
, NULL
);
3880 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3882 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3886 lttng_pipe_destroy(event_notifier_event_source_pipe
);
3887 lttng_fd_put(LTTNG_FD_APPS
, 2);
3893 * For a given application object, add it to every hash table.
3895 void ust_app_add(struct ust_app
*app
)
3898 assert(app
->notify_sock
>= 0);
3900 app
->registration_time
= time(NULL
);
3905 * On a re-registration, we want to kick out the previous registration of
3908 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3911 * The socket _should_ be unique until _we_ call close. So, a add_unique
3912 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3913 * already in the table.
3915 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3917 /* Add application to the notify socket hash table. */
3918 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3919 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3921 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3922 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3923 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3930 * Set the application version into the object.
3932 * Return 0 on success else a negative value either an errno code or a
3933 * LTTng-UST error code.
3935 int ust_app_version(struct ust_app
*app
)
3941 pthread_mutex_lock(&app
->sock_lock
);
3942 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3943 pthread_mutex_unlock(&app
->sock_lock
);
3945 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3946 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3948 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3956 * Setup the base event notifier group.
3958 * Return 0 on success else a negative value either an errno code or a
3959 * LTTng-UST error code.
3961 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
3964 int event_pipe_write_fd
;
3965 struct lttng_ust_object_data
*event_notifier_group
= NULL
;
3966 enum lttng_error_code lttng_ret
;
3970 /* Get the write side of the pipe. */
3971 event_pipe_write_fd
= lttng_pipe_get_writefd(
3972 app
->event_notifier_group
.event_pipe
);
3974 pthread_mutex_lock(&app
->sock_lock
);
3975 ret
= ustctl_create_event_notifier_group(app
->sock
,
3976 event_pipe_write_fd
, &event_notifier_group
);
3977 pthread_mutex_unlock(&app
->sock_lock
);
3979 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3980 ERR("Failed to create application event notifier group: ret = %d, app socket fd = %d, event_pipe_write_fd = %d",
3981 ret
, app
->sock
, event_pipe_write_fd
);
3983 DBG("Failed to create application event notifier group (application is dead): app socket fd = %d",
3990 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
3992 ERR("Failed to close write end of the application's event source pipe: app = '%s' (ppid = %d)",
3993 app
->name
, app
->ppid
);
3998 * Release the file descriptor that was reserved for the write-end of
4001 lttng_fd_put(LTTNG_FD_APPS
, 1);
4003 lttng_ret
= notification_thread_command_add_tracer_event_source(
4004 notification_thread_handle
,
4005 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
),
4007 if (lttng_ret
!= LTTNG_OK
) {
4008 ERR("Failed to add tracer event source to notification thread");
4013 /* Assign handle only when the complete setup is valid. */
4014 app
->event_notifier_group
.object
= event_notifier_group
;
4018 ustctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
4019 free(app
->event_notifier_group
.object
);
4024 * Unregister app by removing it from the global traceable app list and freeing
4027 * The socket is already closed at this point so no close to sock.
4029 void ust_app_unregister(int sock
)
4031 struct ust_app
*lta
;
4032 struct lttng_ht_node_ulong
*node
;
4033 struct lttng_ht_iter ust_app_sock_iter
;
4034 struct lttng_ht_iter iter
;
4035 struct ust_app_session
*ua_sess
;
4040 /* Get the node reference for a call_rcu */
4041 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
4042 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
4045 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
4046 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
4049 * For per-PID buffers, perform "push metadata" and flush all
4050 * application streams before removing app from hash tables,
4051 * ensuring proper behavior of data_pending check.
4052 * Remove sessions so they are not visible during deletion.
4054 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
4056 struct ust_registry_session
*registry
;
4058 ret
= lttng_ht_del(lta
->sessions
, &iter
);
4060 /* The session was already removed so scheduled for teardown. */
4064 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
4065 (void) ust_app_flush_app_session(lta
, ua_sess
);
4069 * Add session to list for teardown. This is safe since at this point we
4070 * are the only one using this list.
4072 pthread_mutex_lock(&ua_sess
->lock
);
4074 if (ua_sess
->deleted
) {
4075 pthread_mutex_unlock(&ua_sess
->lock
);
4080 * Normally, this is done in the delete session process which is
4081 * executed in the call rcu below. However, upon registration we can't
4082 * afford to wait for the grace period before pushing data or else the
4083 * data pending feature can race between the unregistration and stop
4084 * command where the data pending command is sent *before* the grace
4087 * The close metadata below nullifies the metadata pointer in the
4088 * session so the delete session will NOT push/close a second time.
4090 registry
= get_session_registry(ua_sess
);
4092 /* Push metadata for application before freeing the application. */
4093 (void) push_metadata(registry
, ua_sess
->consumer
);
4096 * Don't ask to close metadata for global per UID buffers. Close
4097 * metadata only on destroy trace session in this case. Also, the
4098 * previous push metadata could have flag the metadata registry to
4099 * close so don't send a close command if closed.
4101 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4102 /* And ask to close it for this session registry. */
4103 (void) close_metadata(registry
, ua_sess
->consumer
);
4106 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4108 pthread_mutex_unlock(&ua_sess
->lock
);
4111 /* Remove application from PID hash table */
4112 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4116 * Remove application from notify hash table. The thread handling the
4117 * notify socket could have deleted the node so ignore on error because
4118 * either way it's valid. The close of that socket is handled by the
4119 * apps_notify_thread.
4121 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4122 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4125 * Ignore return value since the node might have been removed before by an
4126 * add replace during app registration because the PID can be reassigned by
4129 iter
.iter
.node
= <a
->pid_n
.node
;
4130 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4132 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4137 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4144 * Fill events array with all events name of all registered apps.
4146 int ust_app_list_events(struct lttng_event
**events
)
4149 size_t nbmem
, count
= 0;
4150 struct lttng_ht_iter iter
;
4151 struct ust_app
*app
;
4152 struct lttng_event
*tmp_event
;
4154 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4155 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4156 if (tmp_event
== NULL
) {
4157 PERROR("zmalloc ust app events");
4164 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4165 struct lttng_ust_tracepoint_iter uiter
;
4167 health_code_update();
4169 if (!app
->compatible
) {
4171 * TODO: In time, we should notice the caller of this error by
4172 * telling him that this is a version error.
4176 pthread_mutex_lock(&app
->sock_lock
);
4177 handle
= ustctl_tracepoint_list(app
->sock
);
4179 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4180 ERR("UST app list events getting handle failed for app pid %d",
4183 pthread_mutex_unlock(&app
->sock_lock
);
4187 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
4188 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4189 /* Handle ustctl error. */
4193 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4194 ERR("UST app tp list get failed for app %d with ret %d",
4197 DBG3("UST app tp list get failed. Application is dead");
4199 * This is normal behavior, an application can die during the
4200 * creation process. Don't report an error so the execution can
4201 * continue normally. Continue normal execution.
4206 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4207 if (release_ret
< 0 &&
4208 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4209 release_ret
!= -EPIPE
) {
4210 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4212 pthread_mutex_unlock(&app
->sock_lock
);
4216 health_code_update();
4217 if (count
>= nbmem
) {
4218 /* In case the realloc fails, we free the memory */
4219 struct lttng_event
*new_tmp_event
;
4222 new_nbmem
= nbmem
<< 1;
4223 DBG2("Reallocating event list from %zu to %zu entries",
4225 new_tmp_event
= realloc(tmp_event
,
4226 new_nbmem
* sizeof(struct lttng_event
));
4227 if (new_tmp_event
== NULL
) {
4230 PERROR("realloc ust app events");
4233 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4234 if (release_ret
< 0 &&
4235 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4236 release_ret
!= -EPIPE
) {
4237 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4239 pthread_mutex_unlock(&app
->sock_lock
);
4242 /* Zero the new memory */
4243 memset(new_tmp_event
+ nbmem
, 0,
4244 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4246 tmp_event
= new_tmp_event
;
4248 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
4249 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4250 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
4251 tmp_event
[count
].pid
= app
->pid
;
4252 tmp_event
[count
].enabled
= -1;
4255 ret
= ustctl_release_handle(app
->sock
, handle
);
4256 pthread_mutex_unlock(&app
->sock_lock
);
4257 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4258 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4263 *events
= tmp_event
;
4265 DBG2("UST app list events done (%zu events)", count
);
4270 health_code_update();
4275 * Fill events array with all events name of all registered apps.
4277 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4280 size_t nbmem
, count
= 0;
4281 struct lttng_ht_iter iter
;
4282 struct ust_app
*app
;
4283 struct lttng_event_field
*tmp_event
;
4285 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4286 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4287 if (tmp_event
== NULL
) {
4288 PERROR("zmalloc ust app event fields");
4295 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4296 struct lttng_ust_field_iter uiter
;
4298 health_code_update();
4300 if (!app
->compatible
) {
4302 * TODO: In time, we should notice the caller of this error by
4303 * telling him that this is a version error.
4307 pthread_mutex_lock(&app
->sock_lock
);
4308 handle
= ustctl_tracepoint_field_list(app
->sock
);
4310 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4311 ERR("UST app list field getting handle failed for app pid %d",
4314 pthread_mutex_unlock(&app
->sock_lock
);
4318 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
4319 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4320 /* Handle ustctl error. */
4324 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4325 ERR("UST app tp list field failed for app %d with ret %d",
4328 DBG3("UST app tp list field failed. Application is dead");
4330 * This is normal behavior, an application can die during the
4331 * creation process. Don't report an error so the execution can
4332 * continue normally. Reset list and count for next app.
4337 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4338 pthread_mutex_unlock(&app
->sock_lock
);
4339 if (release_ret
< 0 &&
4340 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4341 release_ret
!= -EPIPE
) {
4342 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4347 health_code_update();
4348 if (count
>= nbmem
) {
4349 /* In case the realloc fails, we free the memory */
4350 struct lttng_event_field
*new_tmp_event
;
4353 new_nbmem
= nbmem
<< 1;
4354 DBG2("Reallocating event field list from %zu to %zu entries",
4356 new_tmp_event
= realloc(tmp_event
,
4357 new_nbmem
* sizeof(struct lttng_event_field
));
4358 if (new_tmp_event
== NULL
) {
4361 PERROR("realloc ust app event fields");
4364 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4365 pthread_mutex_unlock(&app
->sock_lock
);
4367 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4368 release_ret
!= -EPIPE
) {
4369 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4373 /* Zero the new memory */
4374 memset(new_tmp_event
+ nbmem
, 0,
4375 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4377 tmp_event
= new_tmp_event
;
4380 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
4381 /* Mapping between these enums matches 1 to 1. */
4382 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4383 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4385 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
4386 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4387 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4388 tmp_event
[count
].event
.pid
= app
->pid
;
4389 tmp_event
[count
].event
.enabled
= -1;
4392 ret
= ustctl_release_handle(app
->sock
, handle
);
4393 pthread_mutex_unlock(&app
->sock_lock
);
4395 ret
!= -LTTNG_UST_ERR_EXITING
&&
4397 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4402 *fields
= tmp_event
;
4404 DBG2("UST app list event fields done (%zu events)", count
);
4409 health_code_update();
4414 * Free and clean all traceable apps of the global list.
4416 * Should _NOT_ be called with RCU read-side lock held.
4418 void ust_app_clean_list(void)
4421 struct ust_app
*app
;
4422 struct lttng_ht_iter iter
;
4424 DBG2("UST app cleaning registered apps hash table");
4428 /* Cleanup notify socket hash table */
4429 if (ust_app_ht_by_notify_sock
) {
4430 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4431 notify_sock_n
.node
) {
4433 * Assert that all notifiers are gone as all triggers
4434 * are unregistered prior to this clean-up.
4436 assert(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4438 ust_app_notify_sock_unregister(app
->notify_sock
);
4443 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4444 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4446 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4450 /* Cleanup socket hash table */
4451 if (ust_app_ht_by_sock
) {
4452 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4454 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4461 /* Destroy is done only when the ht is empty */
4463 ht_cleanup_push(ust_app_ht
);
4465 if (ust_app_ht_by_sock
) {
4466 ht_cleanup_push(ust_app_ht_by_sock
);
4468 if (ust_app_ht_by_notify_sock
) {
4469 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4474 * Init UST app hash table.
4476 int ust_app_ht_alloc(void)
4478 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4482 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4483 if (!ust_app_ht_by_sock
) {
4486 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4487 if (!ust_app_ht_by_notify_sock
) {
4494 * For a specific UST session, disable the channel for all registered apps.
4496 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4497 struct ltt_ust_channel
*uchan
)
4500 struct lttng_ht_iter iter
;
4501 struct lttng_ht_node_str
*ua_chan_node
;
4502 struct ust_app
*app
;
4503 struct ust_app_session
*ua_sess
;
4504 struct ust_app_channel
*ua_chan
;
4506 assert(usess
->active
);
4507 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4508 uchan
->name
, usess
->id
);
4512 /* For every registered applications */
4513 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4514 struct lttng_ht_iter uiter
;
4515 if (!app
->compatible
) {
4517 * TODO: In time, we should notice the caller of this error by
4518 * telling him that this is a version error.
4522 ua_sess
= lookup_session_by_app(usess
, app
);
4523 if (ua_sess
== NULL
) {
4528 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4529 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4530 /* If the session if found for the app, the channel must be there */
4531 assert(ua_chan_node
);
4533 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4534 /* The channel must not be already disabled */
4535 assert(ua_chan
->enabled
== 1);
4537 /* Disable channel onto application */
4538 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4540 /* XXX: We might want to report this error at some point... */
4550 * For a specific UST session, enable the channel for all registered apps.
4552 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4553 struct ltt_ust_channel
*uchan
)
4556 struct lttng_ht_iter iter
;
4557 struct ust_app
*app
;
4558 struct ust_app_session
*ua_sess
;
4560 assert(usess
->active
);
4561 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4562 uchan
->name
, usess
->id
);
4566 /* For every registered applications */
4567 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4568 if (!app
->compatible
) {
4570 * TODO: In time, we should notice the caller of this error by
4571 * telling him that this is a version error.
4575 ua_sess
= lookup_session_by_app(usess
, app
);
4576 if (ua_sess
== NULL
) {
4580 /* Enable channel onto application */
4581 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4583 /* XXX: We might want to report this error at some point... */
4593 * Disable an event in a channel and for a specific session.
4595 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4596 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4599 struct lttng_ht_iter iter
, uiter
;
4600 struct lttng_ht_node_str
*ua_chan_node
;
4601 struct ust_app
*app
;
4602 struct ust_app_session
*ua_sess
;
4603 struct ust_app_channel
*ua_chan
;
4604 struct ust_app_event
*ua_event
;
4606 assert(usess
->active
);
4607 DBG("UST app disabling event %s for all apps in channel "
4608 "%s for session id %" PRIu64
,
4609 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4613 /* For all registered applications */
4614 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4615 if (!app
->compatible
) {
4617 * TODO: In time, we should notice the caller of this error by
4618 * telling him that this is a version error.
4622 ua_sess
= lookup_session_by_app(usess
, app
);
4623 if (ua_sess
== NULL
) {
4628 /* Lookup channel in the ust app session */
4629 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4630 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4631 if (ua_chan_node
== NULL
) {
4632 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4633 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4636 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4638 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4639 uevent
->filter
, uevent
->attr
.loglevel
,
4641 if (ua_event
== NULL
) {
4642 DBG2("Event %s not found in channel %s for app pid %d."
4643 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4647 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4649 /* XXX: Report error someday... */
4658 /* The ua_sess lock must be held by the caller. */
4660 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4661 struct ust_app_session
*ua_sess
,
4662 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4663 struct ust_app_channel
**_ua_chan
)
4666 struct ust_app_channel
*ua_chan
= NULL
;
4669 ASSERT_LOCKED(ua_sess
->lock
);
4671 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4672 sizeof(uchan
->name
))) {
4673 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4677 struct ltt_ust_context
*uctx
= NULL
;
4680 * Create channel onto application and synchronize its
4683 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4684 LTTNG_UST_CHAN_PER_CPU
, usess
,
4690 ret
= ust_app_channel_send(app
, usess
,
4697 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4698 ret
= create_ust_app_channel_context(ua_chan
,
4711 * The application's socket is not valid. Either a bad socket
4712 * or a timeout on it. We can't inform the caller that for a
4713 * specific app, the session failed so lets continue here.
4715 ret
= 0; /* Not an error. */
4723 if (ret
== 0 && _ua_chan
) {
4725 * Only return the application's channel on success. Note
4726 * that the channel can still be part of the application's
4727 * channel hashtable on error.
4729 *_ua_chan
= ua_chan
;
4735 * Enable event for a specific session and channel on the tracer.
4737 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4738 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4741 struct lttng_ht_iter iter
, uiter
;
4742 struct lttng_ht_node_str
*ua_chan_node
;
4743 struct ust_app
*app
;
4744 struct ust_app_session
*ua_sess
;
4745 struct ust_app_channel
*ua_chan
;
4746 struct ust_app_event
*ua_event
;
4748 assert(usess
->active
);
4749 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4750 uevent
->attr
.name
, usess
->id
);
4753 * NOTE: At this point, this function is called only if the session and
4754 * channel passed are already created for all apps. and enabled on the
4760 /* For all registered applications */
4761 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4762 if (!app
->compatible
) {
4764 * TODO: In time, we should notice the caller of this error by
4765 * telling him that this is a version error.
4769 ua_sess
= lookup_session_by_app(usess
, app
);
4771 /* The application has problem or is probably dead. */
4775 pthread_mutex_lock(&ua_sess
->lock
);
4777 if (ua_sess
->deleted
) {
4778 pthread_mutex_unlock(&ua_sess
->lock
);
4782 /* Lookup channel in the ust app session */
4783 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4784 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4786 * It is possible that the channel cannot be found is
4787 * the channel/event creation occurs concurrently with
4788 * an application exit.
4790 if (!ua_chan_node
) {
4791 pthread_mutex_unlock(&ua_sess
->lock
);
4795 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4797 /* Get event node */
4798 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4799 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4800 if (ua_event
== NULL
) {
4801 DBG3("UST app enable event %s not found for app PID %d."
4802 "Skipping app", uevent
->attr
.name
, app
->pid
);
4806 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4808 pthread_mutex_unlock(&ua_sess
->lock
);
4812 pthread_mutex_unlock(&ua_sess
->lock
);
4821 * For a specific existing UST session and UST channel, creates the event for
4822 * all registered apps.
4824 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4825 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4828 struct lttng_ht_iter iter
, uiter
;
4829 struct lttng_ht_node_str
*ua_chan_node
;
4830 struct ust_app
*app
;
4831 struct ust_app_session
*ua_sess
;
4832 struct ust_app_channel
*ua_chan
;
4834 assert(usess
->active
);
4835 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4836 uevent
->attr
.name
, usess
->id
);
4840 /* For all registered applications */
4841 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4842 if (!app
->compatible
) {
4844 * TODO: In time, we should notice the caller of this error by
4845 * telling him that this is a version error.
4849 ua_sess
= lookup_session_by_app(usess
, app
);
4851 /* The application has problem or is probably dead. */
4855 pthread_mutex_lock(&ua_sess
->lock
);
4857 if (ua_sess
->deleted
) {
4858 pthread_mutex_unlock(&ua_sess
->lock
);
4862 /* Lookup channel in the ust app session */
4863 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4864 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4865 /* If the channel is not found, there is a code flow error */
4866 assert(ua_chan_node
);
4868 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4870 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4871 pthread_mutex_unlock(&ua_sess
->lock
);
4873 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4874 /* Possible value at this point: -ENOMEM. If so, we stop! */
4877 DBG2("UST app event %s already exist on app PID %d",
4878 uevent
->attr
.name
, app
->pid
);
4888 * Start tracing for a specific UST session and app.
4890 * Called with UST app session lock held.
4894 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4897 struct ust_app_session
*ua_sess
;
4899 DBG("Starting tracing for ust app pid %d", app
->pid
);
4903 if (!app
->compatible
) {
4907 ua_sess
= lookup_session_by_app(usess
, app
);
4908 if (ua_sess
== NULL
) {
4909 /* The session is in teardown process. Ignore and continue. */
4913 pthread_mutex_lock(&ua_sess
->lock
);
4915 if (ua_sess
->deleted
) {
4916 pthread_mutex_unlock(&ua_sess
->lock
);
4920 if (ua_sess
->enabled
) {
4921 pthread_mutex_unlock(&ua_sess
->lock
);
4925 /* Upon restart, we skip the setup, already done */
4926 if (ua_sess
->started
) {
4930 health_code_update();
4933 /* This starts the UST tracing */
4934 pthread_mutex_lock(&app
->sock_lock
);
4935 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4936 pthread_mutex_unlock(&app
->sock_lock
);
4938 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4939 ERR("Error starting tracing for app pid: %d (ret: %d)",
4942 DBG("UST app start session failed. Application is dead.");
4944 * This is normal behavior, an application can die during the
4945 * creation process. Don't report an error so the execution can
4946 * continue normally.
4948 pthread_mutex_unlock(&ua_sess
->lock
);
4954 /* Indicate that the session has been started once */
4955 ua_sess
->started
= 1;
4956 ua_sess
->enabled
= 1;
4958 pthread_mutex_unlock(&ua_sess
->lock
);
4960 health_code_update();
4962 /* Quiescent wait after starting trace */
4963 pthread_mutex_lock(&app
->sock_lock
);
4964 ret
= ustctl_wait_quiescent(app
->sock
);
4965 pthread_mutex_unlock(&app
->sock_lock
);
4966 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4967 ERR("UST app wait quiescent failed for app pid %d ret %d",
4973 health_code_update();
4977 pthread_mutex_unlock(&ua_sess
->lock
);
4979 health_code_update();
4984 * Stop tracing for a specific UST session and app.
4987 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4990 struct ust_app_session
*ua_sess
;
4991 struct ust_registry_session
*registry
;
4993 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4997 if (!app
->compatible
) {
4998 goto end_no_session
;
5001 ua_sess
= lookup_session_by_app(usess
, app
);
5002 if (ua_sess
== NULL
) {
5003 goto end_no_session
;
5006 pthread_mutex_lock(&ua_sess
->lock
);
5008 if (ua_sess
->deleted
) {
5009 pthread_mutex_unlock(&ua_sess
->lock
);
5010 goto end_no_session
;
5014 * If started = 0, it means that stop trace has been called for a session
5015 * that was never started. It's possible since we can have a fail start
5016 * from either the application manager thread or the command thread. Simply
5017 * indicate that this is a stop error.
5019 if (!ua_sess
->started
) {
5020 goto error_rcu_unlock
;
5023 health_code_update();
5025 /* This inhibits UST tracing */
5026 pthread_mutex_lock(&app
->sock_lock
);
5027 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
5028 pthread_mutex_unlock(&app
->sock_lock
);
5030 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5031 ERR("Error stopping tracing for app pid: %d (ret: %d)",
5034 DBG("UST app stop session failed. Application is dead.");
5036 * This is normal behavior, an application can die during the
5037 * creation process. Don't report an error so the execution can
5038 * continue normally.
5042 goto error_rcu_unlock
;
5045 health_code_update();
5046 ua_sess
->enabled
= 0;
5048 /* Quiescent wait after stopping trace */
5049 pthread_mutex_lock(&app
->sock_lock
);
5050 ret
= ustctl_wait_quiescent(app
->sock
);
5051 pthread_mutex_unlock(&app
->sock_lock
);
5052 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5053 ERR("UST app wait quiescent failed for app pid %d ret %d",
5057 health_code_update();
5059 registry
= get_session_registry(ua_sess
);
5061 /* The UST app session is held registry shall not be null. */
5064 /* Push metadata for application before freeing the application. */
5065 (void) push_metadata(registry
, ua_sess
->consumer
);
5068 pthread_mutex_unlock(&ua_sess
->lock
);
5071 health_code_update();
5075 pthread_mutex_unlock(&ua_sess
->lock
);
5077 health_code_update();
5082 int ust_app_flush_app_session(struct ust_app
*app
,
5083 struct ust_app_session
*ua_sess
)
5085 int ret
, retval
= 0;
5086 struct lttng_ht_iter iter
;
5087 struct ust_app_channel
*ua_chan
;
5088 struct consumer_socket
*socket
;
5090 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5094 if (!app
->compatible
) {
5095 goto end_not_compatible
;
5098 pthread_mutex_lock(&ua_sess
->lock
);
5100 if (ua_sess
->deleted
) {
5104 health_code_update();
5106 /* Flushing buffers */
5107 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5110 /* Flush buffers and push metadata. */
5111 switch (ua_sess
->buffer_type
) {
5112 case LTTNG_BUFFER_PER_PID
:
5113 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5115 health_code_update();
5116 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5118 ERR("Error flushing consumer channel");
5124 case LTTNG_BUFFER_PER_UID
:
5130 health_code_update();
5133 pthread_mutex_unlock(&ua_sess
->lock
);
5137 health_code_update();
5142 * Flush buffers for all applications for a specific UST session.
5143 * Called with UST session lock held.
5146 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5151 DBG("Flushing session buffers for all ust apps");
5155 /* Flush buffers and push metadata. */
5156 switch (usess
->buffer_type
) {
5157 case LTTNG_BUFFER_PER_UID
:
5159 struct buffer_reg_uid
*reg
;
5160 struct lttng_ht_iter iter
;
5162 /* Flush all per UID buffers associated to that session. */
5163 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5164 struct ust_registry_session
*ust_session_reg
;
5165 struct buffer_reg_channel
*reg_chan
;
5166 struct consumer_socket
*socket
;
5168 /* Get consumer socket to use to push the metadata.*/
5169 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5172 /* Ignore request if no consumer is found for the session. */
5176 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5177 reg_chan
, node
.node
) {
5179 * The following call will print error values so the return
5180 * code is of little importance because whatever happens, we
5181 * have to try them all.
5183 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
5186 ust_session_reg
= reg
->registry
->reg
.ust
;
5187 /* Push metadata. */
5188 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5192 case LTTNG_BUFFER_PER_PID
:
5194 struct ust_app_session
*ua_sess
;
5195 struct lttng_ht_iter iter
;
5196 struct ust_app
*app
;
5198 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5199 ua_sess
= lookup_session_by_app(usess
, app
);
5200 if (ua_sess
== NULL
) {
5203 (void) ust_app_flush_app_session(app
, ua_sess
);
5214 health_code_update();
5219 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5220 struct ust_app_session
*ua_sess
)
5223 struct lttng_ht_iter iter
;
5224 struct ust_app_channel
*ua_chan
;
5225 struct consumer_socket
*socket
;
5227 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5231 if (!app
->compatible
) {
5232 goto end_not_compatible
;
5235 pthread_mutex_lock(&ua_sess
->lock
);
5237 if (ua_sess
->deleted
) {
5241 health_code_update();
5243 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5246 ERR("Failed to find consumer (%" PRIu32
") socket",
5247 app
->bits_per_long
);
5252 /* Clear quiescent state. */
5253 switch (ua_sess
->buffer_type
) {
5254 case LTTNG_BUFFER_PER_PID
:
5255 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5256 ua_chan
, node
.node
) {
5257 health_code_update();
5258 ret
= consumer_clear_quiescent_channel(socket
,
5261 ERR("Error clearing quiescent state for consumer channel");
5267 case LTTNG_BUFFER_PER_UID
:
5274 health_code_update();
5277 pthread_mutex_unlock(&ua_sess
->lock
);
5281 health_code_update();
5286 * Clear quiescent state in each stream for all applications for a
5287 * specific UST session.
5288 * Called with UST session lock held.
5291 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5296 DBG("Clearing stream quiescent state for all ust apps");
5300 switch (usess
->buffer_type
) {
5301 case LTTNG_BUFFER_PER_UID
:
5303 struct lttng_ht_iter iter
;
5304 struct buffer_reg_uid
*reg
;
5307 * Clear quiescent for all per UID buffers associated to
5310 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5311 struct consumer_socket
*socket
;
5312 struct buffer_reg_channel
*reg_chan
;
5314 /* Get associated consumer socket.*/
5315 socket
= consumer_find_socket_by_bitness(
5316 reg
->bits_per_long
, usess
->consumer
);
5319 * Ignore request if no consumer is found for
5325 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5326 &iter
.iter
, reg_chan
, node
.node
) {
5328 * The following call will print error values so
5329 * the return code is of little importance
5330 * because whatever happens, we have to try them
5333 (void) consumer_clear_quiescent_channel(socket
,
5334 reg_chan
->consumer_key
);
5339 case LTTNG_BUFFER_PER_PID
:
5341 struct ust_app_session
*ua_sess
;
5342 struct lttng_ht_iter iter
;
5343 struct ust_app
*app
;
5345 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5347 ua_sess
= lookup_session_by_app(usess
, app
);
5348 if (ua_sess
== NULL
) {
5351 (void) ust_app_clear_quiescent_app_session(app
,
5363 health_code_update();
5368 * Destroy a specific UST session in apps.
5370 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5373 struct ust_app_session
*ua_sess
;
5374 struct lttng_ht_iter iter
;
5375 struct lttng_ht_node_u64
*node
;
5377 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5381 if (!app
->compatible
) {
5385 __lookup_session_by_app(usess
, app
, &iter
);
5386 node
= lttng_ht_iter_get_node_u64(&iter
);
5388 /* Session is being or is deleted. */
5391 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5393 health_code_update();
5394 destroy_app_session(app
, ua_sess
);
5396 health_code_update();
5398 /* Quiescent wait after stopping trace */
5399 pthread_mutex_lock(&app
->sock_lock
);
5400 ret
= ustctl_wait_quiescent(app
->sock
);
5401 pthread_mutex_unlock(&app
->sock_lock
);
5402 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5403 ERR("UST app wait quiescent failed for app pid %d ret %d",
5408 health_code_update();
5413 * Start tracing for the UST session.
5415 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5417 struct lttng_ht_iter iter
;
5418 struct ust_app
*app
;
5420 DBG("Starting all UST traces");
5423 * Even though the start trace might fail, flag this session active so
5424 * other application coming in are started by default.
5431 * In a start-stop-start use-case, we need to clear the quiescent state
5432 * of each channel set by the prior stop command, thus ensuring that a
5433 * following stop or destroy is sure to grab a timestamp_end near those
5434 * operations, even if the packet is empty.
5436 (void) ust_app_clear_quiescent_session(usess
);
5438 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5439 ust_app_global_update(usess
, app
);
5448 * Start tracing for the UST session.
5449 * Called with UST session lock held.
5451 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5454 struct lttng_ht_iter iter
;
5455 struct ust_app
*app
;
5457 DBG("Stopping all UST traces");
5460 * Even though the stop trace might fail, flag this session inactive so
5461 * other application coming in are not started by default.
5467 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5468 ret
= ust_app_stop_trace(usess
, app
);
5470 /* Continue to next apps even on error */
5475 (void) ust_app_flush_session(usess
);
5483 * Destroy app UST session.
5485 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5488 struct lttng_ht_iter iter
;
5489 struct ust_app
*app
;
5491 DBG("Destroy all UST traces");
5495 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5496 ret
= destroy_trace(usess
, app
);
5498 /* Continue to next apps even on error */
5508 /* The ua_sess lock must be held by the caller. */
5510 int find_or_create_ust_app_channel(
5511 struct ltt_ust_session
*usess
,
5512 struct ust_app_session
*ua_sess
,
5513 struct ust_app
*app
,
5514 struct ltt_ust_channel
*uchan
,
5515 struct ust_app_channel
**ua_chan
)
5518 struct lttng_ht_iter iter
;
5519 struct lttng_ht_node_str
*ua_chan_node
;
5521 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5522 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5524 *ua_chan
= caa_container_of(ua_chan_node
,
5525 struct ust_app_channel
, node
);
5529 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5538 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5539 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5540 struct ust_app
*app
)
5543 struct ust_app_event
*ua_event
= NULL
;
5545 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5546 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5548 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5553 if (ua_event
->enabled
!= uevent
->enabled
) {
5554 ret
= uevent
->enabled
?
5555 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5556 disable_ust_app_event(ua_sess
, ua_event
, app
);
5564 /* Called with RCU read-side lock held. */
5566 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5569 enum lttng_error_code ret_code
;
5570 enum lttng_trigger_status t_status
;
5571 struct lttng_ht_iter app_trigger_iter
;
5572 struct lttng_triggers
*triggers
= NULL
;
5573 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5574 unsigned int count
, i
;
5577 * Currrently, registering or unregistering a trigger with an
5578 * event rule condition causes a full synchronization of the event
5581 * The first step attempts to add an event notifier for all registered
5582 * triggers that apply to the user space tracers. Then, the
5583 * application's event notifiers rules are all checked against the list
5584 * of registered triggers. Any event notifier that doesn't have a
5585 * matching trigger can be assumed to have been disabled.
5587 * All of this is inefficient, but is put in place to get the feature
5588 * rolling as it is simpler at this moment. It will be optimized Soon™
5589 * to allow the state of enabled
5590 * event notifiers to be synchronized in a piece-wise way.
5593 /* Get all triggers using uid 0 (root) */
5594 ret_code
= notification_thread_command_list_triggers(
5595 notification_thread_handle
, 0, &triggers
);
5596 if (ret_code
!= LTTNG_OK
) {
5603 t_status
= lttng_triggers_get_count(triggers
, &count
);
5604 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5609 for (i
= 0; i
< count
; i
++) {
5610 struct lttng_condition
*condition
;
5611 struct lttng_event_rule
*event_rule
;
5612 struct lttng_trigger
*trigger
;
5613 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5614 enum lttng_condition_status condition_status
;
5617 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5620 token
= lttng_trigger_get_tracer_token(trigger
);
5621 condition
= lttng_trigger_get_condition(trigger
);
5623 if (lttng_condition_get_type(condition
) != LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
) {
5624 /* Does not apply */
5628 condition_status
= lttng_condition_event_rule_borrow_rule_mutable(condition
, &event_rule
);
5629 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5631 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5632 /* Skip kernel related triggers. */
5637 * Find or create the associated token event rule. The caller
5638 * holds the RCU read lock, so this is safe to call without
5639 * explicitly acquiring it here.
5641 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5642 app
->token_to_event_notifier_rule_ht
, token
);
5643 if (!looked_up_event_notifier_rule
) {
5644 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
5652 /* Remove all unknown event sources from the app. */
5653 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5654 &app_trigger_iter
.iter
, event_notifier_rule
,
5656 const uint64_t app_token
= event_notifier_rule
->token
;
5660 * Check if the app event trigger still exists on the
5661 * notification side.
5663 for (i
= 0; i
< count
; i
++) {
5664 uint64_t notification_thread_token
;
5665 const struct lttng_trigger
*trigger
=
5666 lttng_triggers_get_at_index(
5671 notification_thread_token
=
5672 lttng_trigger_get_tracer_token(trigger
);
5674 if (notification_thread_token
== app_token
) {
5686 * This trigger was unregistered, disable it on the tracer's
5689 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5693 /* Callee logs errors. */
5694 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5696 delete_ust_app_event_notifier_rule(
5697 app
->sock
, event_notifier_rule
, app
);
5703 lttng_triggers_destroy(triggers
);
5708 * The caller must ensure that the application is compatible and is tracked
5709 * by the process attribute trackers.
5712 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5713 struct ust_app
*app
)
5716 struct cds_lfht_iter uchan_iter
;
5717 struct ltt_ust_channel
*uchan
;
5718 struct ust_app_session
*ua_sess
= NULL
;
5721 * The application's configuration should only be synchronized for
5724 assert(usess
->active
);
5726 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5728 /* Tracer is probably gone or ENOMEM. */
5733 pthread_mutex_lock(&ua_sess
->lock
);
5734 if (ua_sess
->deleted
) {
5735 pthread_mutex_unlock(&ua_sess
->lock
);
5741 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5743 struct ust_app_channel
*ua_chan
;
5744 struct cds_lfht_iter uevent_iter
;
5745 struct ltt_ust_event
*uevent
;
5748 * Search for a matching ust_app_channel. If none is found,
5749 * create it. Creating the channel will cause the ua_chan
5750 * structure to be allocated, the channel buffers to be
5751 * allocated (if necessary) and sent to the application, and
5752 * all enabled contexts will be added to the channel.
5754 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5755 app
, uchan
, &ua_chan
);
5757 /* Tracer is probably gone or ENOMEM. */
5762 /* ua_chan will be NULL for the metadata channel */
5766 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5768 ret
= ust_app_channel_synchronize_event(ua_chan
,
5769 uevent
, ua_sess
, app
);
5775 if (ua_chan
->enabled
!= uchan
->enabled
) {
5776 ret
= uchan
->enabled
?
5777 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5778 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5786 * Create the metadata for the application. This returns gracefully if a
5787 * metadata was already set for the session.
5789 * The metadata channel must be created after the data channels as the
5790 * consumer daemon assumes this ordering. When interacting with a relay
5791 * daemon, the consumer will use this assumption to send the
5792 * "STREAMS_SENT" message to the relay daemon.
5794 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
5802 pthread_mutex_unlock(&ua_sess
->lock
);
5803 /* Everything went well at this point. */
5808 pthread_mutex_unlock(&ua_sess
->lock
);
5811 destroy_app_session(app
, ua_sess
);
5817 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5819 struct ust_app_session
*ua_sess
;
5821 ua_sess
= lookup_session_by_app(usess
, app
);
5822 if (ua_sess
== NULL
) {
5825 destroy_app_session(app
, ua_sess
);
5829 * Add channels/events from UST global domain to registered apps at sock.
5831 * Called with session lock held.
5832 * Called with RCU read-side lock held.
5834 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5837 assert(usess
->active
);
5839 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5840 app
->sock
, usess
->id
);
5842 if (!app
->compatible
) {
5845 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
5847 trace_ust_id_tracker_lookup(
5848 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
5850 trace_ust_id_tracker_lookup(
5851 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
5854 * Synchronize the application's internal tracing configuration
5855 * and start tracing.
5857 ust_app_synchronize(usess
, app
);
5858 ust_app_start_trace(usess
, app
);
5860 ust_app_global_destroy(usess
, app
);
5865 * Add all event notifiers to an application.
5867 * Called with session lock held.
5868 * Called with RCU read-side lock held.
5870 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
5872 DBG2("UST application global event notifier rules update: app = '%s' (ppid: %d)",
5873 app
->name
, app
->ppid
);
5875 if (!app
->compatible
) {
5879 if (app
->event_notifier_group
.object
== NULL
) {
5880 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s' (ppid: %d)",
5881 app
->name
, app
->ppid
);
5885 ust_app_synchronize_event_notifier_rules(app
);
5889 * Called with session lock held.
5891 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5893 struct lttng_ht_iter iter
;
5894 struct ust_app
*app
;
5897 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5898 ust_app_global_update(usess
, app
);
5903 void ust_app_global_update_all_event_notifier_rules(void)
5905 struct lttng_ht_iter iter
;
5906 struct ust_app
*app
;
5909 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5910 ust_app_global_update_event_notifier_rules(app
);
5917 * Add context to a specific channel for global UST domain.
5919 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5920 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5923 struct lttng_ht_node_str
*ua_chan_node
;
5924 struct lttng_ht_iter iter
, uiter
;
5925 struct ust_app_channel
*ua_chan
= NULL
;
5926 struct ust_app_session
*ua_sess
;
5927 struct ust_app
*app
;
5929 assert(usess
->active
);
5932 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5933 if (!app
->compatible
) {
5935 * TODO: In time, we should notice the caller of this error by
5936 * telling him that this is a version error.
5940 ua_sess
= lookup_session_by_app(usess
, app
);
5941 if (ua_sess
== NULL
) {
5945 pthread_mutex_lock(&ua_sess
->lock
);
5947 if (ua_sess
->deleted
) {
5948 pthread_mutex_unlock(&ua_sess
->lock
);
5952 /* Lookup channel in the ust app session */
5953 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5954 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5955 if (ua_chan_node
== NULL
) {
5958 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5960 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5965 pthread_mutex_unlock(&ua_sess
->lock
);
5973 * Receive registration and populate the given msg structure.
5975 * On success return 0 else a negative value returned by the ustctl call.
5977 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5980 uint32_t pid
, ppid
, uid
, gid
;
5984 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5985 &pid
, &ppid
, &uid
, &gid
,
5986 &msg
->bits_per_long
,
5987 &msg
->uint8_t_alignment
,
5988 &msg
->uint16_t_alignment
,
5989 &msg
->uint32_t_alignment
,
5990 &msg
->uint64_t_alignment
,
5991 &msg
->long_alignment
,
5998 case LTTNG_UST_ERR_EXITING
:
5999 DBG3("UST app recv reg message failed. Application died");
6001 case LTTNG_UST_ERR_UNSUP_MAJOR
:
6002 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
6003 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
6004 LTTNG_UST_ABI_MINOR_VERSION
);
6007 ERR("UST app recv reg message failed with ret %d", ret
);
6012 msg
->pid
= (pid_t
) pid
;
6013 msg
->ppid
= (pid_t
) ppid
;
6014 msg
->uid
= (uid_t
) uid
;
6015 msg
->gid
= (gid_t
) gid
;
6022 * Return a ust app session object using the application object and the
6023 * session object descriptor has a key. If not found, NULL is returned.
6024 * A RCU read side lock MUST be acquired when calling this function.
6026 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
6029 struct lttng_ht_node_ulong
*node
;
6030 struct lttng_ht_iter iter
;
6031 struct ust_app_session
*ua_sess
= NULL
;
6035 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
6036 node
= lttng_ht_iter_get_node_ulong(&iter
);
6038 DBG2("UST app session find by objd %d not found", objd
);
6042 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
6049 * Return a ust app channel object using the application object and the channel
6050 * object descriptor has a key. If not found, NULL is returned. A RCU read side
6051 * lock MUST be acquired before calling this function.
6053 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
6056 struct lttng_ht_node_ulong
*node
;
6057 struct lttng_ht_iter iter
;
6058 struct ust_app_channel
*ua_chan
= NULL
;
6062 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
6063 node
= lttng_ht_iter_get_node_ulong(&iter
);
6065 DBG2("UST app channel find by objd %d not found", objd
);
6069 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
6076 * Reply to a register channel notification from an application on the notify
6077 * socket. The channel metadata is also created.
6079 * The session UST registry lock is acquired in this function.
6081 * On success 0 is returned else a negative value.
6083 static int reply_ust_register_channel(int sock
, int cobjd
,
6084 size_t nr_fields
, struct ustctl_field
*fields
)
6086 int ret
, ret_code
= 0;
6088 uint64_t chan_reg_key
;
6089 enum ustctl_channel_header type
;
6090 struct ust_app
*app
;
6091 struct ust_app_channel
*ua_chan
;
6092 struct ust_app_session
*ua_sess
;
6093 struct ust_registry_session
*registry
;
6094 struct ust_registry_channel
*chan_reg
;
6098 /* Lookup application. If not found, there is a code flow error. */
6099 app
= find_app_by_notify_sock(sock
);
6101 DBG("Application socket %d is being torn down. Abort event notify",
6104 goto error_rcu_unlock
;
6107 /* Lookup channel by UST object descriptor. */
6108 ua_chan
= find_channel_by_objd(app
, cobjd
);
6110 DBG("Application channel is being torn down. Abort event notify");
6112 goto error_rcu_unlock
;
6115 assert(ua_chan
->session
);
6116 ua_sess
= ua_chan
->session
;
6118 /* Get right session registry depending on the session buffer type. */
6119 registry
= get_session_registry(ua_sess
);
6121 DBG("Application session is being torn down. Abort event notify");
6123 goto error_rcu_unlock
;
6126 /* Depending on the buffer type, a different channel key is used. */
6127 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6128 chan_reg_key
= ua_chan
->tracing_channel_id
;
6130 chan_reg_key
= ua_chan
->key
;
6133 pthread_mutex_lock(®istry
->lock
);
6135 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
6138 if (!chan_reg
->register_done
) {
6140 * TODO: eventually use the registry event count for
6141 * this channel to better guess header type for per-pid
6144 type
= USTCTL_CHANNEL_HEADER_LARGE
;
6145 chan_reg
->nr_ctx_fields
= nr_fields
;
6146 chan_reg
->ctx_fields
= fields
;
6148 chan_reg
->header_type
= type
;
6150 /* Get current already assigned values. */
6151 type
= chan_reg
->header_type
;
6153 /* Channel id is set during the object creation. */
6154 chan_id
= chan_reg
->chan_id
;
6156 /* Append to metadata */
6157 if (!chan_reg
->metadata_dumped
) {
6158 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
6160 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6166 DBG3("UST app replying to register channel key %" PRIu64
6167 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
6170 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6172 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6173 ERR("UST app reply channel failed with ret %d", ret
);
6175 DBG3("UST app reply channel failed. Application died");
6180 /* This channel registry registration is completed. */
6181 chan_reg
->register_done
= 1;
6184 pthread_mutex_unlock(®istry
->lock
);
6192 * Add event to the UST channel registry. When the event is added to the
6193 * registry, the metadata is also created. Once done, this replies to the
6194 * application with the appropriate error code.
6196 * The session UST registry lock is acquired in the function.
6198 * On success 0 is returned else a negative value.
6200 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6201 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
6202 int loglevel_value
, char *model_emf_uri
)
6205 uint32_t event_id
= 0;
6206 uint64_t chan_reg_key
;
6207 struct ust_app
*app
;
6208 struct ust_app_channel
*ua_chan
;
6209 struct ust_app_session
*ua_sess
;
6210 struct ust_registry_session
*registry
;
6214 /* Lookup application. If not found, there is a code flow error. */
6215 app
= find_app_by_notify_sock(sock
);
6217 DBG("Application socket %d is being torn down. Abort event notify",
6220 goto error_rcu_unlock
;
6223 /* Lookup channel by UST object descriptor. */
6224 ua_chan
= find_channel_by_objd(app
, cobjd
);
6226 DBG("Application channel is being torn down. Abort event notify");
6228 goto error_rcu_unlock
;
6231 assert(ua_chan
->session
);
6232 ua_sess
= ua_chan
->session
;
6234 registry
= get_session_registry(ua_sess
);
6236 DBG("Application session is being torn down. Abort event notify");
6238 goto error_rcu_unlock
;
6241 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6242 chan_reg_key
= ua_chan
->tracing_channel_id
;
6244 chan_reg_key
= ua_chan
->key
;
6247 pthread_mutex_lock(®istry
->lock
);
6250 * From this point on, this call acquires the ownership of the sig, fields
6251 * and model_emf_uri meaning any free are done inside it if needed. These
6252 * three variables MUST NOT be read/write after this.
6254 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6255 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6256 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6260 model_emf_uri
= NULL
;
6263 * The return value is returned to ustctl so in case of an error, the
6264 * application can be notified. In case of an error, it's important not to
6265 * return a negative error or else the application will get closed.
6267 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
6269 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6270 ERR("UST app reply event failed with ret %d", ret
);
6272 DBG3("UST app reply event failed. Application died");
6275 * No need to wipe the create event since the application socket will
6276 * get close on error hence cleaning up everything by itself.
6281 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6285 pthread_mutex_unlock(®istry
->lock
);
6290 free(model_emf_uri
);
6295 * Add enum to the UST session registry. Once done, this replies to the
6296 * application with the appropriate error code.
6298 * The session UST registry lock is acquired within this function.
6300 * On success 0 is returned else a negative value.
6302 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6303 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
6305 int ret
= 0, ret_code
;
6306 struct ust_app
*app
;
6307 struct ust_app_session
*ua_sess
;
6308 struct ust_registry_session
*registry
;
6309 uint64_t enum_id
= -1ULL;
6313 /* Lookup application. If not found, there is a code flow error. */
6314 app
= find_app_by_notify_sock(sock
);
6316 /* Return an error since this is not an error */
6317 DBG("Application socket %d is being torn down. Aborting enum registration",
6320 goto error_rcu_unlock
;
6323 /* Lookup session by UST object descriptor. */
6324 ua_sess
= find_session_by_objd(app
, sobjd
);
6326 /* Return an error since this is not an error */
6327 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6329 goto error_rcu_unlock
;
6332 registry
= get_session_registry(ua_sess
);
6334 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6336 goto error_rcu_unlock
;
6339 pthread_mutex_lock(®istry
->lock
);
6342 * From this point on, the callee acquires the ownership of
6343 * entries. The variable entries MUST NOT be read/written after
6346 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6347 entries
, nr_entries
, &enum_id
);
6351 * The return value is returned to ustctl so in case of an error, the
6352 * application can be notified. In case of an error, it's important not to
6353 * return a negative error or else the application will get closed.
6355 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
6357 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6358 ERR("UST app reply enum failed with ret %d", ret
);
6360 DBG3("UST app reply enum failed. Application died");
6363 * No need to wipe the create enum since the application socket will
6364 * get close on error hence cleaning up everything by itself.
6369 DBG3("UST registry enum %s added successfully or already found", name
);
6372 pthread_mutex_unlock(®istry
->lock
);
6379 * Handle application notification through the given notify socket.
6381 * Return 0 on success or else a negative value.
6383 int ust_app_recv_notify(int sock
)
6386 enum ustctl_notify_cmd cmd
;
6388 DBG3("UST app receiving notify from sock %d", sock
);
6390 ret
= ustctl_recv_notify(sock
, &cmd
);
6392 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6393 ERR("UST app recv notify failed with ret %d", ret
);
6395 DBG3("UST app recv notify failed. Application died");
6401 case USTCTL_NOTIFY_CMD_EVENT
:
6403 int sobjd
, cobjd
, loglevel_value
;
6404 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6406 struct ustctl_field
*fields
;
6408 DBG2("UST app ustctl register event received");
6410 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6411 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6414 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6415 ERR("UST app recv event failed with ret %d", ret
);
6417 DBG3("UST app recv event failed. Application died");
6423 * Add event to the UST registry coming from the notify socket. This
6424 * call will free if needed the sig, fields and model_emf_uri. This
6425 * code path loses the ownsership of these variables and transfer them
6426 * to the this function.
6428 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6429 fields
, loglevel_value
, model_emf_uri
);
6436 case USTCTL_NOTIFY_CMD_CHANNEL
:
6440 struct ustctl_field
*fields
;
6442 DBG2("UST app ustctl register channel received");
6444 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6447 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6448 ERR("UST app recv channel failed with ret %d", ret
);
6450 DBG3("UST app recv channel failed. Application died");
6456 * The fields ownership are transfered to this function call meaning
6457 * that if needed it will be freed. After this, it's invalid to access
6458 * fields or clean it up.
6460 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6468 case USTCTL_NOTIFY_CMD_ENUM
:
6471 char name
[LTTNG_UST_SYM_NAME_LEN
];
6473 struct ustctl_enum_entry
*entries
;
6475 DBG2("UST app ustctl register enum received");
6477 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
6478 &entries
, &nr_entries
);
6480 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6481 ERR("UST app recv enum failed with ret %d", ret
);
6483 DBG3("UST app recv enum failed. Application died");
6488 /* Callee assumes ownership of entries */
6489 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6490 entries
, nr_entries
);
6498 /* Should NEVER happen. */
6507 * Once the notify socket hangs up, this is called. First, it tries to find the
6508 * corresponding application. On failure, the call_rcu to close the socket is
6509 * executed. If an application is found, it tries to delete it from the notify
6510 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6512 * Note that an object needs to be allocated here so on ENOMEM failure, the
6513 * call RCU is not done but the rest of the cleanup is.
6515 void ust_app_notify_sock_unregister(int sock
)
6518 struct lttng_ht_iter iter
;
6519 struct ust_app
*app
;
6520 struct ust_app_notify_sock_obj
*obj
;
6526 obj
= zmalloc(sizeof(*obj
));
6529 * An ENOMEM is kind of uncool. If this strikes we continue the
6530 * procedure but the call_rcu will not be called. In this case, we
6531 * accept the fd leak rather than possibly creating an unsynchronized
6532 * state between threads.
6534 * TODO: The notify object should be created once the notify socket is
6535 * registered and stored independantely from the ust app object. The
6536 * tricky part is to synchronize the teardown of the application and
6537 * this notify object. Let's keep that in mind so we can avoid this
6538 * kind of shenanigans with ENOMEM in the teardown path.
6545 DBG("UST app notify socket unregister %d", sock
);
6548 * Lookup application by notify socket. If this fails, this means that the
6549 * hash table delete has already been done by the application
6550 * unregistration process so we can safely close the notify socket in a
6553 app
= find_app_by_notify_sock(sock
);
6558 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6561 * Whatever happens here either we fail or succeed, in both cases we have
6562 * to close the socket after a grace period to continue to the call RCU
6563 * here. If the deletion is successful, the application is not visible
6564 * anymore by other threads and is it fails it means that it was already
6565 * deleted from the hash table so either way we just have to close the
6568 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6574 * Close socket after a grace period to avoid for the socket to be reused
6575 * before the application object is freed creating potential race between
6576 * threads trying to add unique in the global hash table.
6579 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6584 * Destroy a ust app data structure and free its memory.
6586 void ust_app_destroy(struct ust_app
*app
)
6592 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6596 * Take a snapshot for a given UST session. The snapshot is sent to the given
6599 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6601 enum lttng_error_code
ust_app_snapshot_record(
6602 const struct ltt_ust_session
*usess
,
6603 const struct consumer_output
*output
, int wait
,
6604 uint64_t nb_packets_per_stream
)
6607 enum lttng_error_code status
= LTTNG_OK
;
6608 struct lttng_ht_iter iter
;
6609 struct ust_app
*app
;
6610 char *trace_path
= NULL
;
6617 switch (usess
->buffer_type
) {
6618 case LTTNG_BUFFER_PER_UID
:
6620 struct buffer_reg_uid
*reg
;
6622 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6623 struct buffer_reg_channel
*reg_chan
;
6624 struct consumer_socket
*socket
;
6625 char pathname
[PATH_MAX
];
6626 size_t consumer_path_offset
= 0;
6628 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6629 /* Skip since no metadata is present */
6633 /* Get consumer socket to use to push the metadata.*/
6634 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6637 status
= LTTNG_ERR_INVALID
;
6641 memset(pathname
, 0, sizeof(pathname
));
6642 ret
= snprintf(pathname
, sizeof(pathname
),
6643 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6644 reg
->uid
, reg
->bits_per_long
);
6646 PERROR("snprintf snapshot path");
6647 status
= LTTNG_ERR_INVALID
;
6650 /* Free path allowed on previous iteration. */
6652 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6653 &consumer_path_offset
);
6655 status
= LTTNG_ERR_INVALID
;
6658 /* Add the UST default trace dir to path. */
6659 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6660 reg_chan
, node
.node
) {
6661 status
= consumer_snapshot_channel(socket
,
6662 reg_chan
->consumer_key
,
6663 output
, 0, usess
->uid
,
6664 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
6665 nb_packets_per_stream
);
6666 if (status
!= LTTNG_OK
) {
6670 status
= consumer_snapshot_channel(socket
,
6671 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6672 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
6674 if (status
!= LTTNG_OK
) {
6680 case LTTNG_BUFFER_PER_PID
:
6682 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6683 struct consumer_socket
*socket
;
6684 struct lttng_ht_iter chan_iter
;
6685 struct ust_app_channel
*ua_chan
;
6686 struct ust_app_session
*ua_sess
;
6687 struct ust_registry_session
*registry
;
6688 char pathname
[PATH_MAX
];
6689 size_t consumer_path_offset
= 0;
6691 ua_sess
= lookup_session_by_app(usess
, app
);
6693 /* Session not associated with this app. */
6697 /* Get the right consumer socket for the application. */
6698 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6701 status
= LTTNG_ERR_INVALID
;
6705 /* Add the UST default trace dir to path. */
6706 memset(pathname
, 0, sizeof(pathname
));
6707 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6710 status
= LTTNG_ERR_INVALID
;
6711 PERROR("snprintf snapshot path");
6714 /* Free path allowed on previous iteration. */
6716 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6717 &consumer_path_offset
);
6719 status
= LTTNG_ERR_INVALID
;
6722 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6723 ua_chan
, node
.node
) {
6724 status
= consumer_snapshot_channel(socket
,
6725 ua_chan
->key
, output
, 0,
6726 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6727 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6728 &trace_path
[consumer_path_offset
], wait
,
6729 nb_packets_per_stream
);
6733 case LTTNG_ERR_CHAN_NOT_FOUND
:
6740 registry
= get_session_registry(ua_sess
);
6742 DBG("Application session is being torn down. Skip application.");
6745 status
= consumer_snapshot_channel(socket
,
6746 registry
->metadata_key
, output
, 1,
6747 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6748 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6749 &trace_path
[consumer_path_offset
], wait
, 0);
6753 case LTTNG_ERR_CHAN_NOT_FOUND
:
6773 * Return the size taken by one more packet per stream.
6775 uint64_t ust_app_get_size_one_more_packet_per_stream(
6776 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6778 uint64_t tot_size
= 0;
6779 struct ust_app
*app
;
6780 struct lttng_ht_iter iter
;
6784 switch (usess
->buffer_type
) {
6785 case LTTNG_BUFFER_PER_UID
:
6787 struct buffer_reg_uid
*reg
;
6789 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6790 struct buffer_reg_channel
*reg_chan
;
6793 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6794 reg_chan
, node
.node
) {
6795 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6797 * Don't take channel into account if we
6798 * already grab all its packets.
6802 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6808 case LTTNG_BUFFER_PER_PID
:
6811 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6812 struct ust_app_channel
*ua_chan
;
6813 struct ust_app_session
*ua_sess
;
6814 struct lttng_ht_iter chan_iter
;
6816 ua_sess
= lookup_session_by_app(usess
, app
);
6818 /* Session not associated with this app. */
6822 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6823 ua_chan
, node
.node
) {
6824 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6826 * Don't take channel into account if we
6827 * already grab all its packets.
6831 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6845 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6846 struct cds_list_head
*buffer_reg_uid_list
,
6847 struct consumer_output
*consumer
, uint64_t uchan_id
,
6848 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6851 uint64_t consumer_chan_key
;
6856 ret
= buffer_reg_uid_consumer_channel_key(
6857 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6865 ret
= consumer_get_lost_packets(ust_session_id
,
6866 consumer_chan_key
, consumer
, lost
);
6868 ret
= consumer_get_discarded_events(ust_session_id
,
6869 consumer_chan_key
, consumer
, discarded
);
6876 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6877 struct ltt_ust_channel
*uchan
,
6878 struct consumer_output
*consumer
, int overwrite
,
6879 uint64_t *discarded
, uint64_t *lost
)
6882 struct lttng_ht_iter iter
;
6883 struct lttng_ht_node_str
*ua_chan_node
;
6884 struct ust_app
*app
;
6885 struct ust_app_session
*ua_sess
;
6886 struct ust_app_channel
*ua_chan
;
6893 * Iterate over every registered applications. Sum counters for
6894 * all applications containing requested session and channel.
6896 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6897 struct lttng_ht_iter uiter
;
6899 ua_sess
= lookup_session_by_app(usess
, app
);
6900 if (ua_sess
== NULL
) {
6905 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6906 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6907 /* If the session is found for the app, the channel must be there */
6908 assert(ua_chan_node
);
6910 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6915 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6922 uint64_t _discarded
;
6924 ret
= consumer_get_discarded_events(usess
->id
,
6925 ua_chan
->key
, consumer
, &_discarded
);
6929 (*discarded
) += _discarded
;
6938 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6939 struct ust_app
*app
)
6942 struct ust_app_session
*ua_sess
;
6944 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6948 ua_sess
= lookup_session_by_app(usess
, app
);
6949 if (ua_sess
== NULL
) {
6950 /* The session is in teardown process. Ignore and continue. */
6954 pthread_mutex_lock(&ua_sess
->lock
);
6956 if (ua_sess
->deleted
) {
6960 pthread_mutex_lock(&app
->sock_lock
);
6961 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6962 pthread_mutex_unlock(&app
->sock_lock
);
6965 pthread_mutex_unlock(&ua_sess
->lock
);
6969 health_code_update();
6974 * Regenerate the statedump for each app in the session.
6976 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6979 struct lttng_ht_iter iter
;
6980 struct ust_app
*app
;
6982 DBG("Regenerating the metadata for all UST apps");
6986 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6987 if (!app
->compatible
) {
6991 ret
= ust_app_regenerate_statedump(usess
, app
);
6993 /* Continue to the next app even on error */
7004 * Rotate all the channels of a session.
7006 * Return LTTNG_OK on success or else an LTTng error code.
7008 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
7011 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7012 struct lttng_ht_iter iter
;
7013 struct ust_app
*app
;
7014 struct ltt_ust_session
*usess
= session
->ust_session
;
7020 switch (usess
->buffer_type
) {
7021 case LTTNG_BUFFER_PER_UID
:
7023 struct buffer_reg_uid
*reg
;
7025 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7026 struct buffer_reg_channel
*reg_chan
;
7027 struct consumer_socket
*socket
;
7029 if (!reg
->registry
->reg
.ust
->metadata_key
) {
7030 /* Skip since no metadata is present */
7034 /* Get consumer socket to use to push the metadata.*/
7035 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7038 cmd_ret
= LTTNG_ERR_INVALID
;
7042 /* Rotate the data channels. */
7043 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7044 reg_chan
, node
.node
) {
7045 ret
= consumer_rotate_channel(socket
,
7046 reg_chan
->consumer_key
,
7047 usess
->uid
, usess
->gid
,
7049 /* is_metadata_channel */ false);
7051 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7056 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7058 ret
= consumer_rotate_channel(socket
,
7059 reg
->registry
->reg
.ust
->metadata_key
,
7060 usess
->uid
, usess
->gid
,
7062 /* is_metadata_channel */ true);
7064 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7070 case LTTNG_BUFFER_PER_PID
:
7072 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7073 struct consumer_socket
*socket
;
7074 struct lttng_ht_iter chan_iter
;
7075 struct ust_app_channel
*ua_chan
;
7076 struct ust_app_session
*ua_sess
;
7077 struct ust_registry_session
*registry
;
7079 ua_sess
= lookup_session_by_app(usess
, app
);
7081 /* Session not associated with this app. */
7085 /* Get the right consumer socket for the application. */
7086 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7089 cmd_ret
= LTTNG_ERR_INVALID
;
7093 registry
= get_session_registry(ua_sess
);
7095 DBG("Application session is being torn down. Skip application.");
7099 /* Rotate the data channels. */
7100 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7101 ua_chan
, node
.node
) {
7102 ret
= consumer_rotate_channel(socket
,
7104 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7105 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7107 /* is_metadata_channel */ false);
7109 /* Per-PID buffer and application going away. */
7110 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7112 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7117 /* Rotate the metadata channel. */
7118 (void) push_metadata(registry
, usess
->consumer
);
7119 ret
= consumer_rotate_channel(socket
,
7120 registry
->metadata_key
,
7121 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7122 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7124 /* is_metadata_channel */ true);
7126 /* Per-PID buffer and application going away. */
7127 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7129 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7147 enum lttng_error_code
ust_app_create_channel_subdirectories(
7148 const struct ltt_ust_session
*usess
)
7150 enum lttng_error_code ret
= LTTNG_OK
;
7151 struct lttng_ht_iter iter
;
7152 enum lttng_trace_chunk_status chunk_status
;
7153 char *pathname_index
;
7156 assert(usess
->current_trace_chunk
);
7159 switch (usess
->buffer_type
) {
7160 case LTTNG_BUFFER_PER_UID
:
7162 struct buffer_reg_uid
*reg
;
7164 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7165 fmt_ret
= asprintf(&pathname_index
,
7166 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7167 reg
->uid
, reg
->bits_per_long
);
7169 ERR("Failed to format channel index directory");
7170 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7175 * Create the index subdirectory which will take care
7176 * of implicitly creating the channel's path.
7178 chunk_status
= lttng_trace_chunk_create_subdirectory(
7179 usess
->current_trace_chunk
,
7181 free(pathname_index
);
7182 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7183 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7189 case LTTNG_BUFFER_PER_PID
:
7191 struct ust_app
*app
;
7194 * Create the toplevel ust/ directory in case no apps are running.
7196 chunk_status
= lttng_trace_chunk_create_subdirectory(
7197 usess
->current_trace_chunk
,
7198 DEFAULT_UST_TRACE_DIR
);
7199 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7200 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7204 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7206 struct ust_app_session
*ua_sess
;
7207 struct ust_registry_session
*registry
;
7209 ua_sess
= lookup_session_by_app(usess
, app
);
7211 /* Session not associated with this app. */
7215 registry
= get_session_registry(ua_sess
);
7217 DBG("Application session is being torn down. Skip application.");
7221 fmt_ret
= asprintf(&pathname_index
,
7222 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7225 ERR("Failed to format channel index directory");
7226 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7230 * Create the index subdirectory which will take care
7231 * of implicitly creating the channel's path.
7233 chunk_status
= lttng_trace_chunk_create_subdirectory(
7234 usess
->current_trace_chunk
,
7236 free(pathname_index
);
7237 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7238 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7255 * Clear all the channels of a session.
7257 * Return LTTNG_OK on success or else an LTTng error code.
7259 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7262 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7263 struct lttng_ht_iter iter
;
7264 struct ust_app
*app
;
7265 struct ltt_ust_session
*usess
= session
->ust_session
;
7271 if (usess
->active
) {
7272 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7273 cmd_ret
= LTTNG_ERR_FATAL
;
7277 switch (usess
->buffer_type
) {
7278 case LTTNG_BUFFER_PER_UID
:
7280 struct buffer_reg_uid
*reg
;
7282 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7283 struct buffer_reg_channel
*reg_chan
;
7284 struct consumer_socket
*socket
;
7286 /* Get consumer socket to use to push the metadata.*/
7287 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7290 cmd_ret
= LTTNG_ERR_INVALID
;
7294 /* Clear the data channels. */
7295 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7296 reg_chan
, node
.node
) {
7297 ret
= consumer_clear_channel(socket
,
7298 reg_chan
->consumer_key
);
7304 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7307 * Clear the metadata channel.
7308 * Metadata channel is not cleared per se but we still need to
7309 * perform a rotation operation on it behind the scene.
7311 ret
= consumer_clear_channel(socket
,
7312 reg
->registry
->reg
.ust
->metadata_key
);
7319 case LTTNG_BUFFER_PER_PID
:
7321 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7322 struct consumer_socket
*socket
;
7323 struct lttng_ht_iter chan_iter
;
7324 struct ust_app_channel
*ua_chan
;
7325 struct ust_app_session
*ua_sess
;
7326 struct ust_registry_session
*registry
;
7328 ua_sess
= lookup_session_by_app(usess
, app
);
7330 /* Session not associated with this app. */
7334 /* Get the right consumer socket for the application. */
7335 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7338 cmd_ret
= LTTNG_ERR_INVALID
;
7342 registry
= get_session_registry(ua_sess
);
7344 DBG("Application session is being torn down. Skip application.");
7348 /* Clear the data channels. */
7349 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7350 ua_chan
, node
.node
) {
7351 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7353 /* Per-PID buffer and application going away. */
7354 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7361 (void) push_metadata(registry
, usess
->consumer
);
7364 * Clear the metadata channel.
7365 * Metadata channel is not cleared per se but we still need to
7366 * perform rotation operation on it behind the scene.
7368 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7370 /* Per-PID buffer and application going away. */
7371 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7389 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7390 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7393 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7403 * This function skips the metadata channel as the begin/end timestamps of a
7404 * metadata packet are useless.
7406 * Moreover, opening a packet after a "clear" will cause problems for live
7407 * sessions as it will introduce padding that was not part of the first trace
7408 * chunk. The relay daemon expects the content of the metadata stream of
7409 * successive metadata trace chunks to be strict supersets of one another.
7411 * For example, flushing a packet at the beginning of the metadata stream of
7412 * a trace chunk resulting from a "clear" session command will cause the
7413 * size of the metadata stream of the new trace chunk to not match the size of
7414 * the metadata stream of the original chunk. This will confuse the relay
7415 * daemon as the same "offset" in a metadata stream will no longer point
7416 * to the same content.
7418 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7420 enum lttng_error_code ret
= LTTNG_OK
;
7421 struct lttng_ht_iter iter
;
7422 struct ltt_ust_session
*usess
= session
->ust_session
;
7428 switch (usess
->buffer_type
) {
7429 case LTTNG_BUFFER_PER_UID
:
7431 struct buffer_reg_uid
*reg
;
7433 cds_list_for_each_entry (
7434 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7435 struct buffer_reg_channel
*reg_chan
;
7436 struct consumer_socket
*socket
;
7438 socket
= consumer_find_socket_by_bitness(
7439 reg
->bits_per_long
, usess
->consumer
);
7441 ret
= LTTNG_ERR_FATAL
;
7445 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7446 &iter
.iter
, reg_chan
, node
.node
) {
7447 const int open_ret
=
7448 consumer_open_channel_packets(
7450 reg_chan
->consumer_key
);
7453 ret
= LTTNG_ERR_UNK
;
7460 case LTTNG_BUFFER_PER_PID
:
7462 struct ust_app
*app
;
7464 cds_lfht_for_each_entry (
7465 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7466 struct consumer_socket
*socket
;
7467 struct lttng_ht_iter chan_iter
;
7468 struct ust_app_channel
*ua_chan
;
7469 struct ust_app_session
*ua_sess
;
7470 struct ust_registry_session
*registry
;
7472 ua_sess
= lookup_session_by_app(usess
, app
);
7474 /* Session not associated with this app. */
7478 /* Get the right consumer socket for the application. */
7479 socket
= consumer_find_socket_by_bitness(
7480 app
->bits_per_long
, usess
->consumer
);
7482 ret
= LTTNG_ERR_FATAL
;
7486 registry
= get_session_registry(ua_sess
);
7488 DBG("Application session is being torn down. Skip application.");
7492 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7493 &chan_iter
.iter
, ua_chan
, node
.node
) {
7494 const int open_ret
=
7495 consumer_open_channel_packets(
7501 * Per-PID buffer and application going
7504 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7508 ret
= LTTNG_ERR_UNK
;