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
17 #include <sys/types.h>
19 #include <urcu/compiler.h>
22 #include <common/common.h>
23 #include <common/sessiond-comm/sessiond-comm.h>
25 #include "buffer-registry.h"
27 #include "health-sessiond.h"
29 #include "ust-consumer.h"
30 #include "lttng-ust-ctl.h"
31 #include "lttng-ust-error.h"
34 #include "lttng-sessiond.h"
35 #include "notification-thread-commands.h"
38 struct lttng_ht
*ust_app_ht
;
39 struct lttng_ht
*ust_app_ht_by_sock
;
40 struct lttng_ht
*ust_app_ht_by_notify_sock
;
43 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
45 /* Next available channel key. Access under next_channel_key_lock. */
46 static uint64_t _next_channel_key
;
47 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
49 /* Next available session ID. Access under next_session_id_lock. */
50 static uint64_t _next_session_id
;
51 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
54 * Return the incremented value of next_channel_key.
56 static uint64_t get_next_channel_key(void)
60 pthread_mutex_lock(&next_channel_key_lock
);
61 ret
= ++_next_channel_key
;
62 pthread_mutex_unlock(&next_channel_key_lock
);
67 * Return the atomically incremented value of next_session_id.
69 static uint64_t get_next_session_id(void)
73 pthread_mutex_lock(&next_session_id_lock
);
74 ret
= ++_next_session_id
;
75 pthread_mutex_unlock(&next_session_id_lock
);
79 static void copy_channel_attr_to_ustctl(
80 struct ustctl_consumer_channel_attr
*attr
,
81 struct lttng_ust_channel_attr
*uattr
)
83 /* Copy event attributes since the layout is different. */
84 attr
->subbuf_size
= uattr
->subbuf_size
;
85 attr
->num_subbuf
= uattr
->num_subbuf
;
86 attr
->overwrite
= uattr
->overwrite
;
87 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
88 attr
->read_timer_interval
= uattr
->read_timer_interval
;
89 attr
->output
= uattr
->output
;
90 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
94 * Match function for the hash table lookup.
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
99 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
101 struct ust_app_event
*event
;
102 const struct ust_app_ht_key
*key
;
103 int ev_loglevel_value
;
108 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
110 ev_loglevel_value
= event
->attr
.loglevel
;
112 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
115 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
119 /* Event loglevel. */
120 if (ev_loglevel_value
!= key
->loglevel_type
) {
121 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
122 && key
->loglevel_type
== 0 &&
123 ev_loglevel_value
== -1) {
125 * Match is accepted. This is because on event creation, the
126 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
127 * -1 are accepted for this loglevel type since 0 is the one set by
128 * the API when receiving an enable event.
135 /* One of the filters is NULL, fail. */
136 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
140 if (key
->filter
&& event
->filter
) {
141 /* Both filters exists, check length followed by the bytecode. */
142 if (event
->filter
->len
!= key
->filter
->len
||
143 memcmp(event
->filter
->data
, key
->filter
->data
,
144 event
->filter
->len
) != 0) {
149 /* One of the exclusions is NULL, fail. */
150 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
154 if (key
->exclusion
&& event
->exclusion
) {
155 /* Both exclusions exists, check count followed by the names. */
156 if (event
->exclusion
->count
!= key
->exclusion
->count
||
157 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
158 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
172 * Unique add of an ust app event in the given ht. This uses the custom
173 * ht_match_ust_app_event match function and the event name as hash.
175 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
176 struct ust_app_event
*event
)
178 struct cds_lfht_node
*node_ptr
;
179 struct ust_app_ht_key key
;
183 assert(ua_chan
->events
);
186 ht
= ua_chan
->events
;
187 key
.name
= event
->attr
.name
;
188 key
.filter
= event
->filter
;
189 key
.loglevel_type
= event
->attr
.loglevel
;
190 key
.exclusion
= event
->exclusion
;
192 node_ptr
= cds_lfht_add_unique(ht
->ht
,
193 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
194 ht_match_ust_app_event
, &key
, &event
->node
.node
);
195 assert(node_ptr
== &event
->node
.node
);
199 * Close the notify socket from the given RCU head object. This MUST be called
200 * through a call_rcu().
202 static void close_notify_sock_rcu(struct rcu_head
*head
)
205 struct ust_app_notify_sock_obj
*obj
=
206 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
208 /* Must have a valid fd here. */
209 assert(obj
->fd
>= 0);
211 ret
= close(obj
->fd
);
213 ERR("close notify sock %d RCU", obj
->fd
);
215 lttng_fd_put(LTTNG_FD_APPS
, 1);
221 * Return the session registry according to the buffer type of the given
224 * A registry per UID object MUST exists before calling this function or else
225 * it assert() if not found. RCU read side lock must be acquired.
227 static struct ust_registry_session
*get_session_registry(
228 struct ust_app_session
*ua_sess
)
230 struct ust_registry_session
*registry
= NULL
;
234 switch (ua_sess
->buffer_type
) {
235 case LTTNG_BUFFER_PER_PID
:
237 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
241 registry
= reg_pid
->registry
->reg
.ust
;
244 case LTTNG_BUFFER_PER_UID
:
246 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
247 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
248 ua_sess
->real_credentials
.uid
);
252 registry
= reg_uid
->registry
->reg
.ust
;
264 * Delete ust context safely. RCU read lock must be held before calling
268 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
276 pthread_mutex_lock(&app
->sock_lock
);
277 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
278 pthread_mutex_unlock(&app
->sock_lock
);
279 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
280 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
281 sock
, ua_ctx
->obj
->handle
, ret
);
289 * Delete ust app event safely. RCU read lock must be held before calling
293 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
300 free(ua_event
->filter
);
301 if (ua_event
->exclusion
!= NULL
)
302 free(ua_event
->exclusion
);
303 if (ua_event
->obj
!= NULL
) {
304 pthread_mutex_lock(&app
->sock_lock
);
305 ret
= ustctl_release_object(sock
, ua_event
->obj
);
306 pthread_mutex_unlock(&app
->sock_lock
);
307 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
308 ERR("UST app sock %d release event obj failed with ret %d",
317 * Release ust data object of the given stream.
319 * Return 0 on success or else a negative value.
321 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
329 pthread_mutex_lock(&app
->sock_lock
);
330 ret
= ustctl_release_object(sock
, stream
->obj
);
331 pthread_mutex_unlock(&app
->sock_lock
);
332 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
333 ERR("UST app sock %d release stream obj failed with ret %d",
336 lttng_fd_put(LTTNG_FD_APPS
, 2);
344 * Delete ust app stream safely. RCU read lock must be held before calling
348 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
353 (void) release_ust_app_stream(sock
, stream
, app
);
358 * We need to execute ht_destroy outside of RCU read-side critical
359 * section and outside of call_rcu thread, so we postpone its execution
360 * using ht_cleanup_push. It is simpler than to change the semantic of
361 * the many callers of delete_ust_app_session().
364 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
366 struct ust_app_channel
*ua_chan
=
367 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
369 ht_cleanup_push(ua_chan
->ctx
);
370 ht_cleanup_push(ua_chan
->events
);
375 * Extract the lost packet or discarded events counter when the channel is
376 * being deleted and store the value in the parent channel so we can
377 * access it from lttng list and at stop/destroy.
379 * The session list lock must be held by the caller.
382 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
384 uint64_t discarded
= 0, lost
= 0;
385 struct ltt_session
*session
;
386 struct ltt_ust_channel
*uchan
;
388 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
393 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
394 if (!session
|| !session
->ust_session
) {
396 * Not finding the session is not an error because there are
397 * multiple ways the channels can be torn down.
399 * 1) The session daemon can initiate the destruction of the
400 * ust app session after receiving a destroy command or
401 * during its shutdown/teardown.
402 * 2) The application, since we are in per-pid tracing, is
403 * unregistering and tearing down its ust app session.
405 * Both paths are protected by the session list lock which
406 * ensures that the accounting of lost packets and discarded
407 * events is done exactly once. The session is then unpublished
408 * from the session list, resulting in this condition.
413 if (ua_chan
->attr
.overwrite
) {
414 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
415 ua_chan
->key
, session
->ust_session
->consumer
,
418 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
419 ua_chan
->key
, session
->ust_session
->consumer
,
422 uchan
= trace_ust_find_channel_by_name(
423 session
->ust_session
->domain_global
.channels
,
426 ERR("Missing UST channel to store discarded counters");
430 uchan
->per_pid_closed_app_discarded
+= discarded
;
431 uchan
->per_pid_closed_app_lost
+= lost
;
436 session_put(session
);
441 * Delete ust app channel safely. RCU read lock must be held before calling
444 * The session list lock must be held by the caller.
447 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
451 struct lttng_ht_iter iter
;
452 struct ust_app_event
*ua_event
;
453 struct ust_app_ctx
*ua_ctx
;
454 struct ust_app_stream
*stream
, *stmp
;
455 struct ust_registry_session
*registry
;
459 DBG3("UST app deleting channel %s", ua_chan
->name
);
462 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
463 cds_list_del(&stream
->list
);
464 delete_ust_app_stream(sock
, stream
, app
);
468 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
469 cds_list_del(&ua_ctx
->list
);
470 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
472 delete_ust_app_ctx(sock
, ua_ctx
, app
);
476 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
478 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
480 delete_ust_app_event(sock
, ua_event
, app
);
483 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
484 /* Wipe and free registry from session registry. */
485 registry
= get_session_registry(ua_chan
->session
);
487 ust_registry_channel_del_free(registry
, ua_chan
->key
,
491 * A negative socket can be used by the caller when
492 * cleaning-up a ua_chan in an error path. Skip the
493 * accounting in this case.
496 save_per_pid_lost_discarded_counters(ua_chan
);
500 if (ua_chan
->obj
!= NULL
) {
501 /* Remove channel from application UST object descriptor. */
502 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
503 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
505 pthread_mutex_lock(&app
->sock_lock
);
506 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
507 pthread_mutex_unlock(&app
->sock_lock
);
508 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
509 ERR("UST app sock %d release channel obj failed with ret %d",
512 lttng_fd_put(LTTNG_FD_APPS
, 1);
515 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
518 int ust_app_register_done(struct ust_app
*app
)
522 pthread_mutex_lock(&app
->sock_lock
);
523 ret
= ustctl_register_done(app
->sock
);
524 pthread_mutex_unlock(&app
->sock_lock
);
528 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
533 pthread_mutex_lock(&app
->sock_lock
);
538 ret
= ustctl_release_object(sock
, data
);
540 pthread_mutex_unlock(&app
->sock_lock
);
546 * Push metadata to consumer socket.
548 * RCU read-side lock must be held to guarantee existance of socket.
549 * Must be called with the ust app session lock held.
550 * Must be called with the registry lock held.
552 * On success, return the len of metadata pushed or else a negative value.
553 * Returning a -EPIPE return value means we could not send the metadata,
554 * but it can be caused by recoverable errors (e.g. the application has
555 * terminated concurrently).
557 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
558 struct consumer_socket
*socket
, int send_zero_data
)
561 char *metadata_str
= NULL
;
562 size_t len
, offset
, new_metadata_len_sent
;
564 uint64_t metadata_key
, metadata_version
;
569 metadata_key
= registry
->metadata_key
;
572 * Means that no metadata was assigned to the session. This can
573 * happens if no start has been done previously.
579 offset
= registry
->metadata_len_sent
;
580 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
581 new_metadata_len_sent
= registry
->metadata_len
;
582 metadata_version
= registry
->metadata_version
;
584 DBG3("No metadata to push for metadata key %" PRIu64
,
585 registry
->metadata_key
);
587 if (send_zero_data
) {
588 DBG("No metadata to push");
594 /* Allocate only what we have to send. */
595 metadata_str
= zmalloc(len
);
597 PERROR("zmalloc ust app metadata string");
601 /* Copy what we haven't sent out. */
602 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
605 pthread_mutex_unlock(®istry
->lock
);
607 * We need to unlock the registry while we push metadata to
608 * break a circular dependency between the consumerd metadata
609 * lock and the sessiond registry lock. Indeed, pushing metadata
610 * to the consumerd awaits that it gets pushed all the way to
611 * relayd, but doing so requires grabbing the metadata lock. If
612 * a concurrent metadata request is being performed by
613 * consumerd, this can try to grab the registry lock on the
614 * sessiond while holding the metadata lock on the consumer
615 * daemon. Those push and pull schemes are performed on two
616 * different bidirectionnal communication sockets.
618 ret
= consumer_push_metadata(socket
, metadata_key
,
619 metadata_str
, len
, offset
, metadata_version
);
620 pthread_mutex_lock(®istry
->lock
);
623 * There is an acceptable race here between the registry
624 * metadata key assignment and the creation on the
625 * consumer. The session daemon can concurrently push
626 * metadata for this registry while being created on the
627 * consumer since the metadata key of the registry is
628 * assigned *before* it is setup to avoid the consumer
629 * to ask for metadata that could possibly be not found
630 * in the session daemon.
632 * The metadata will get pushed either by the session
633 * being stopped or the consumer requesting metadata if
634 * that race is triggered.
636 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
639 ERR("Error pushing metadata to consumer");
645 * Metadata may have been concurrently pushed, since
646 * we're not holding the registry lock while pushing to
647 * consumer. This is handled by the fact that we send
648 * the metadata content, size, and the offset at which
649 * that metadata belongs. This may arrive out of order
650 * on the consumer side, and the consumer is able to
651 * deal with overlapping fragments. The consumer
652 * supports overlapping fragments, which must be
653 * contiguous starting from offset 0. We keep the
654 * largest metadata_len_sent value of the concurrent
657 registry
->metadata_len_sent
=
658 max_t(size_t, registry
->metadata_len_sent
,
659 new_metadata_len_sent
);
668 * On error, flag the registry that the metadata is
669 * closed. We were unable to push anything and this
670 * means that either the consumer is not responding or
671 * the metadata cache has been destroyed on the
674 registry
->metadata_closed
= 1;
682 * For a given application and session, push metadata to consumer.
683 * Either sock or consumer is required : if sock is NULL, the default
684 * socket to send the metadata is retrieved from consumer, if sock
685 * is not NULL we use it to send the metadata.
686 * RCU read-side lock must be held while calling this function,
687 * therefore ensuring existance of registry. It also ensures existance
688 * of socket throughout this function.
690 * Return 0 on success else a negative error.
691 * Returning a -EPIPE return value means we could not send the metadata,
692 * but it can be caused by recoverable errors (e.g. the application has
693 * terminated concurrently).
695 static int push_metadata(struct ust_registry_session
*registry
,
696 struct consumer_output
*consumer
)
700 struct consumer_socket
*socket
;
705 pthread_mutex_lock(®istry
->lock
);
706 if (registry
->metadata_closed
) {
711 /* Get consumer socket to use to push the metadata.*/
712 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
719 ret
= ust_app_push_metadata(registry
, socket
, 0);
724 pthread_mutex_unlock(®istry
->lock
);
728 pthread_mutex_unlock(®istry
->lock
);
733 * Send to the consumer a close metadata command for the given session. Once
734 * done, the metadata channel is deleted and the session metadata pointer is
735 * nullified. The session lock MUST be held unless the application is
736 * in the destroy path.
738 * Do not hold the registry lock while communicating with the consumerd, because
739 * doing so causes inter-process deadlocks between consumerd and sessiond with
740 * the metadata request notification.
742 * Return 0 on success else a negative value.
744 static int close_metadata(struct ust_registry_session
*registry
,
745 struct consumer_output
*consumer
)
748 struct consumer_socket
*socket
;
749 uint64_t metadata_key
;
750 bool registry_was_already_closed
;
757 pthread_mutex_lock(®istry
->lock
);
758 metadata_key
= registry
->metadata_key
;
759 registry_was_already_closed
= registry
->metadata_closed
;
760 if (metadata_key
!= 0) {
762 * Metadata closed. Even on error this means that the consumer
763 * is not responding or not found so either way a second close
764 * should NOT be emit for this registry.
766 registry
->metadata_closed
= 1;
768 pthread_mutex_unlock(®istry
->lock
);
770 if (metadata_key
== 0 || registry_was_already_closed
) {
775 /* Get consumer socket to use to push the metadata.*/
776 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
783 ret
= consumer_close_metadata(socket
, metadata_key
);
794 * We need to execute ht_destroy outside of RCU read-side critical
795 * section and outside of call_rcu thread, so we postpone its execution
796 * using ht_cleanup_push. It is simpler than to change the semantic of
797 * the many callers of delete_ust_app_session().
800 void delete_ust_app_session_rcu(struct rcu_head
*head
)
802 struct ust_app_session
*ua_sess
=
803 caa_container_of(head
, struct ust_app_session
, rcu_head
);
805 ht_cleanup_push(ua_sess
->channels
);
810 * Delete ust app session safely. RCU read lock must be held before calling
813 * The session list lock must be held by the caller.
816 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
820 struct lttng_ht_iter iter
;
821 struct ust_app_channel
*ua_chan
;
822 struct ust_registry_session
*registry
;
826 pthread_mutex_lock(&ua_sess
->lock
);
828 assert(!ua_sess
->deleted
);
829 ua_sess
->deleted
= true;
831 registry
= get_session_registry(ua_sess
);
832 /* Registry can be null on error path during initialization. */
834 /* Push metadata for application before freeing the application. */
835 (void) push_metadata(registry
, ua_sess
->consumer
);
838 * Don't ask to close metadata for global per UID buffers. Close
839 * metadata only on destroy trace session in this case. Also, the
840 * previous push metadata could have flag the metadata registry to
841 * close so don't send a close command if closed.
843 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
844 /* And ask to close it for this session registry. */
845 (void) close_metadata(registry
, ua_sess
->consumer
);
849 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
851 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
853 delete_ust_app_channel(sock
, ua_chan
, app
);
856 /* In case of per PID, the registry is kept in the session. */
857 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
858 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
861 * Registry can be null on error path during
864 buffer_reg_pid_remove(reg_pid
);
865 buffer_reg_pid_destroy(reg_pid
);
869 if (ua_sess
->handle
!= -1) {
870 pthread_mutex_lock(&app
->sock_lock
);
871 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
872 pthread_mutex_unlock(&app
->sock_lock
);
873 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
874 ERR("UST app sock %d release session handle failed with ret %d",
877 /* Remove session from application UST object descriptor. */
878 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
879 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
883 pthread_mutex_unlock(&ua_sess
->lock
);
885 consumer_output_put(ua_sess
->consumer
);
887 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
891 * Delete a traceable application structure from the global list. Never call
892 * this function outside of a call_rcu call.
894 * RCU read side lock should _NOT_ be held when calling this function.
897 void delete_ust_app(struct ust_app
*app
)
900 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
903 * The session list lock must be held during this function to guarantee
904 * the existence of ua_sess.
907 /* Delete ust app sessions info */
912 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
914 /* Free every object in the session and the session. */
916 delete_ust_app_session(sock
, ua_sess
, app
);
920 ht_cleanup_push(app
->sessions
);
921 ht_cleanup_push(app
->ust_sessions_objd
);
922 ht_cleanup_push(app
->ust_objd
);
925 * Wait until we have deleted the application from the sock hash table
926 * before closing this socket, otherwise an application could re-use the
927 * socket ID and race with the teardown, using the same hash table entry.
929 * It's OK to leave the close in call_rcu. We want it to stay unique for
930 * all RCU readers that could run concurrently with unregister app,
931 * therefore we _need_ to only close that socket after a grace period. So
932 * it should stay in this RCU callback.
934 * This close() is a very important step of the synchronization model so
935 * every modification to this function must be carefully reviewed.
941 lttng_fd_put(LTTNG_FD_APPS
, 1);
943 DBG2("UST app pid %d deleted", app
->pid
);
945 session_unlock_list();
949 * URCU intermediate call to delete an UST app.
952 void delete_ust_app_rcu(struct rcu_head
*head
)
954 struct lttng_ht_node_ulong
*node
=
955 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
956 struct ust_app
*app
=
957 caa_container_of(node
, struct ust_app
, pid_n
);
959 DBG3("Call RCU deleting app PID %d", app
->pid
);
964 * Delete the session from the application ht and delete the data structure by
965 * freeing every object inside and releasing them.
967 * The session list lock must be held by the caller.
969 static void destroy_app_session(struct ust_app
*app
,
970 struct ust_app_session
*ua_sess
)
973 struct lttng_ht_iter iter
;
978 iter
.iter
.node
= &ua_sess
->node
.node
;
979 ret
= lttng_ht_del(app
->sessions
, &iter
);
981 /* Already scheduled for teardown. */
985 /* Once deleted, free the data structure. */
986 delete_ust_app_session(app
->sock
, ua_sess
, app
);
993 * Alloc new UST app session.
996 struct ust_app_session
*alloc_ust_app_session(void)
998 struct ust_app_session
*ua_sess
;
1000 /* Init most of the default value by allocating and zeroing */
1001 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
1002 if (ua_sess
== NULL
) {
1007 ua_sess
->handle
= -1;
1008 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1009 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1010 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1019 * Alloc new UST app channel.
1022 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
1023 struct ust_app_session
*ua_sess
,
1024 struct lttng_ust_channel_attr
*attr
)
1026 struct ust_app_channel
*ua_chan
;
1028 /* Init most of the default value by allocating and zeroing */
1029 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1030 if (ua_chan
== NULL
) {
1035 /* Setup channel name */
1036 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1037 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1039 ua_chan
->enabled
= 1;
1040 ua_chan
->handle
= -1;
1041 ua_chan
->session
= ua_sess
;
1042 ua_chan
->key
= get_next_channel_key();
1043 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1044 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1045 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1047 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1048 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1050 /* Copy attributes */
1052 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1053 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1054 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1055 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1056 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1057 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1058 ua_chan
->attr
.output
= attr
->output
;
1059 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1061 /* By default, the channel is a per cpu channel. */
1062 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1064 DBG3("UST app channel %s allocated", ua_chan
->name
);
1073 * Allocate and initialize a UST app stream.
1075 * Return newly allocated stream pointer or NULL on error.
1077 struct ust_app_stream
*ust_app_alloc_stream(void)
1079 struct ust_app_stream
*stream
= NULL
;
1081 stream
= zmalloc(sizeof(*stream
));
1082 if (stream
== NULL
) {
1083 PERROR("zmalloc ust app stream");
1087 /* Zero could be a valid value for a handle so flag it to -1. */
1088 stream
->handle
= -1;
1095 * Alloc new UST app event.
1098 struct ust_app_event
*alloc_ust_app_event(char *name
,
1099 struct lttng_ust_event
*attr
)
1101 struct ust_app_event
*ua_event
;
1103 /* Init most of the default value by allocating and zeroing */
1104 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1105 if (ua_event
== NULL
) {
1106 PERROR("Failed to allocate ust_app_event structure");
1110 ua_event
->enabled
= 1;
1111 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1112 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1113 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1115 /* Copy attributes */
1117 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1120 DBG3("UST app event %s allocated", ua_event
->name
);
1129 * Alloc new UST app context.
1132 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1134 struct ust_app_ctx
*ua_ctx
;
1136 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1137 if (ua_ctx
== NULL
) {
1141 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1144 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1145 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1146 char *provider_name
= NULL
, *ctx_name
= NULL
;
1148 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1149 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1150 if (!provider_name
|| !ctx_name
) {
1151 free(provider_name
);
1156 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1157 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1161 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1169 * Allocate a filter and copy the given original filter.
1171 * Return allocated filter or NULL on error.
1173 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1174 struct lttng_filter_bytecode
*orig_f
)
1176 struct lttng_filter_bytecode
*filter
= NULL
;
1178 /* Copy filter bytecode */
1179 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1181 PERROR("zmalloc alloc filter bytecode");
1185 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1192 * Create a liblttng-ust filter bytecode from given bytecode.
1194 * Return allocated filter or NULL on error.
1196 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1197 struct lttng_filter_bytecode
*orig_f
)
1199 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1201 /* Copy filter bytecode */
1202 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1204 PERROR("zmalloc alloc ust filter bytecode");
1208 assert(sizeof(struct lttng_filter_bytecode
) ==
1209 sizeof(struct lttng_ust_filter_bytecode
));
1210 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1216 * Find an ust_app using the sock and return it. RCU read side lock must be
1217 * held before calling this helper function.
1219 struct ust_app
*ust_app_find_by_sock(int sock
)
1221 struct lttng_ht_node_ulong
*node
;
1222 struct lttng_ht_iter iter
;
1224 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1225 node
= lttng_ht_iter_get_node_ulong(&iter
);
1227 DBG2("UST app find by sock %d not found", sock
);
1231 return caa_container_of(node
, struct ust_app
, sock_n
);
1238 * Find an ust_app using the notify sock and return it. RCU read side lock must
1239 * be held before calling this helper function.
1241 static struct ust_app
*find_app_by_notify_sock(int sock
)
1243 struct lttng_ht_node_ulong
*node
;
1244 struct lttng_ht_iter iter
;
1246 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1248 node
= lttng_ht_iter_get_node_ulong(&iter
);
1250 DBG2("UST app find by notify sock %d not found", sock
);
1254 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1261 * Lookup for an ust app event based on event name, filter bytecode and the
1264 * Return an ust_app_event object or NULL on error.
1266 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1267 const char *name
, const struct lttng_filter_bytecode
*filter
,
1269 const struct lttng_event_exclusion
*exclusion
)
1271 struct lttng_ht_iter iter
;
1272 struct lttng_ht_node_str
*node
;
1273 struct ust_app_event
*event
= NULL
;
1274 struct ust_app_ht_key key
;
1279 /* Setup key for event lookup. */
1281 key
.filter
= filter
;
1282 key
.loglevel_type
= loglevel_value
;
1283 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1284 key
.exclusion
= exclusion
;
1286 /* Lookup using the event name as hash and a custom match fct. */
1287 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1288 ht_match_ust_app_event
, &key
, &iter
.iter
);
1289 node
= lttng_ht_iter_get_node_str(&iter
);
1294 event
= caa_container_of(node
, struct ust_app_event
, node
);
1301 * Create the channel context on the tracer.
1303 * Called with UST app session lock held.
1306 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1307 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1311 health_code_update();
1313 pthread_mutex_lock(&app
->sock_lock
);
1314 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1315 ua_chan
->obj
, &ua_ctx
->obj
);
1316 pthread_mutex_unlock(&app
->sock_lock
);
1318 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1319 ERR("UST app create channel context failed for app (pid: %d) "
1320 "with ret %d", app
->pid
, ret
);
1323 * This is normal behavior, an application can die during the
1324 * creation process. Don't report an error so the execution can
1325 * continue normally.
1328 DBG3("UST app add context failed. Application is dead.");
1333 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1335 DBG2("UST app context handle %d created successfully for channel %s",
1336 ua_ctx
->handle
, ua_chan
->name
);
1339 health_code_update();
1344 * Set the filter on the tracer.
1347 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1348 struct ust_app
*app
)
1351 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1353 health_code_update();
1355 if (!ua_event
->filter
) {
1360 ust_bytecode
= create_ust_bytecode_from_bytecode(ua_event
->filter
);
1361 if (!ust_bytecode
) {
1362 ret
= -LTTNG_ERR_NOMEM
;
1365 pthread_mutex_lock(&app
->sock_lock
);
1366 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1368 pthread_mutex_unlock(&app
->sock_lock
);
1370 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1371 ERR("UST app event %s filter failed for app (pid: %d) "
1372 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1375 * This is normal behavior, an application can die during the
1376 * creation process. Don't report an error so the execution can
1377 * continue normally.
1380 DBG3("UST app filter event failed. Application is dead.");
1385 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1388 health_code_update();
1394 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1395 struct lttng_event_exclusion
*exclusion
)
1397 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1398 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1399 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1401 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1402 if (!ust_exclusion
) {
1407 assert(sizeof(struct lttng_event_exclusion
) ==
1408 sizeof(struct lttng_ust_event_exclusion
));
1409 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1411 return ust_exclusion
;
1415 * Set event exclusions on the tracer.
1418 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1419 struct ust_app
*app
)
1422 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1424 health_code_update();
1426 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1431 ust_exclusion
= create_ust_exclusion_from_exclusion(
1432 ua_event
->exclusion
);
1433 if (!ust_exclusion
) {
1434 ret
= -LTTNG_ERR_NOMEM
;
1437 pthread_mutex_lock(&app
->sock_lock
);
1438 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1439 pthread_mutex_unlock(&app
->sock_lock
);
1441 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1442 ERR("UST app event %s exclusions failed for app (pid: %d) "
1443 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1446 * This is normal behavior, an application can die during the
1447 * creation process. Don't report an error so the execution can
1448 * continue normally.
1451 DBG3("UST app event exclusion failed. Application is dead.");
1456 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1459 health_code_update();
1460 free(ust_exclusion
);
1465 * Disable the specified event on to UST tracer for the UST session.
1467 static int disable_ust_event(struct ust_app
*app
,
1468 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1472 health_code_update();
1474 pthread_mutex_lock(&app
->sock_lock
);
1475 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1476 pthread_mutex_unlock(&app
->sock_lock
);
1478 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1479 ERR("UST app event %s disable failed for app (pid: %d) "
1480 "and session handle %d with ret %d",
1481 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1484 * This is normal behavior, an application can die during the
1485 * creation process. Don't report an error so the execution can
1486 * continue normally.
1489 DBG3("UST app disable event failed. Application is dead.");
1494 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1495 ua_event
->attr
.name
, app
->pid
);
1498 health_code_update();
1503 * Disable the specified channel on to UST tracer for the UST session.
1505 static int disable_ust_channel(struct ust_app
*app
,
1506 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1510 health_code_update();
1512 pthread_mutex_lock(&app
->sock_lock
);
1513 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1514 pthread_mutex_unlock(&app
->sock_lock
);
1516 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1517 ERR("UST app channel %s disable failed for app (pid: %d) "
1518 "and session handle %d with ret %d",
1519 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1522 * This is normal behavior, an application can die during the
1523 * creation process. Don't report an error so the execution can
1524 * continue normally.
1527 DBG3("UST app disable channel failed. Application is dead.");
1532 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1533 ua_chan
->name
, app
->pid
);
1536 health_code_update();
1541 * Enable the specified channel on to UST tracer for the UST session.
1543 static int enable_ust_channel(struct ust_app
*app
,
1544 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1548 health_code_update();
1550 pthread_mutex_lock(&app
->sock_lock
);
1551 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1552 pthread_mutex_unlock(&app
->sock_lock
);
1554 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1555 ERR("UST app channel %s enable failed for app (pid: %d) "
1556 "and session handle %d with ret %d",
1557 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1560 * This is normal behavior, an application can die during the
1561 * creation process. Don't report an error so the execution can
1562 * continue normally.
1565 DBG3("UST app enable channel failed. Application is dead.");
1570 ua_chan
->enabled
= 1;
1572 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1573 ua_chan
->name
, app
->pid
);
1576 health_code_update();
1581 * Enable the specified event on to UST tracer for the UST session.
1583 static int enable_ust_event(struct ust_app
*app
,
1584 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1588 health_code_update();
1590 pthread_mutex_lock(&app
->sock_lock
);
1591 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1592 pthread_mutex_unlock(&app
->sock_lock
);
1594 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1595 ERR("UST app event %s enable failed for app (pid: %d) "
1596 "and session handle %d with ret %d",
1597 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1600 * This is normal behavior, an application can die during the
1601 * creation process. Don't report an error so the execution can
1602 * continue normally.
1605 DBG3("UST app enable event failed. Application is dead.");
1610 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1611 ua_event
->attr
.name
, app
->pid
);
1614 health_code_update();
1619 * Send channel and stream buffer to application.
1621 * Return 0 on success. On error, a negative value is returned.
1623 static int send_channel_pid_to_ust(struct ust_app
*app
,
1624 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1627 struct ust_app_stream
*stream
, *stmp
;
1633 health_code_update();
1635 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1638 /* Send channel to the application. */
1639 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1640 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1641 ret
= -ENOTCONN
; /* Caused by app exiting. */
1643 } else if (ret
< 0) {
1647 health_code_update();
1649 /* Send all streams to application. */
1650 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1651 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1652 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1653 ret
= -ENOTCONN
; /* Caused by app exiting. */
1655 } else if (ret
< 0) {
1658 /* We don't need the stream anymore once sent to the tracer. */
1659 cds_list_del(&stream
->list
);
1660 delete_ust_app_stream(-1, stream
, app
);
1662 /* Flag the channel that it is sent to the application. */
1663 ua_chan
->is_sent
= 1;
1666 health_code_update();
1671 * Create the specified event onto the UST tracer for a UST session.
1673 * Should be called with session mutex held.
1676 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1677 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1681 health_code_update();
1683 /* Create UST event on tracer */
1684 pthread_mutex_lock(&app
->sock_lock
);
1685 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1687 pthread_mutex_unlock(&app
->sock_lock
);
1689 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1691 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1692 ua_event
->attr
.name
, app
->pid
, ret
);
1695 * This is normal behavior, an application can die during the
1696 * creation process. Don't report an error so the execution can
1697 * continue normally.
1700 DBG3("UST app create event failed. Application is dead.");
1705 ua_event
->handle
= ua_event
->obj
->handle
;
1707 DBG2("UST app event %s created successfully for pid:%d",
1708 ua_event
->attr
.name
, app
->pid
);
1710 health_code_update();
1712 /* Set filter if one is present. */
1713 if (ua_event
->filter
) {
1714 ret
= set_ust_event_filter(ua_event
, app
);
1720 /* Set exclusions for the event */
1721 if (ua_event
->exclusion
) {
1722 ret
= set_ust_event_exclusion(ua_event
, app
);
1728 /* If event not enabled, disable it on the tracer */
1729 if (ua_event
->enabled
) {
1731 * We now need to explicitly enable the event, since it
1732 * is now disabled at creation.
1734 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1737 * If we hit an EPERM, something is wrong with our enable call. If
1738 * we get an EEXIST, there is a problem on the tracer side since we
1742 case -LTTNG_UST_ERR_PERM
:
1743 /* Code flow problem */
1745 case -LTTNG_UST_ERR_EXIST
:
1746 /* It's OK for our use case. */
1757 health_code_update();
1762 * Copy data between an UST app event and a LTT event.
1764 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1765 struct ltt_ust_event
*uevent
)
1767 size_t exclusion_alloc_size
;
1769 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1770 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1772 ua_event
->enabled
= uevent
->enabled
;
1774 /* Copy event attributes */
1775 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1777 /* Copy filter bytecode */
1778 if (uevent
->filter
) {
1779 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1780 /* Filter might be NULL here in case of ENONEM. */
1783 /* Copy exclusion data */
1784 if (uevent
->exclusion
) {
1785 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1786 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1787 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1788 if (ua_event
->exclusion
== NULL
) {
1791 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1792 exclusion_alloc_size
);
1798 * Copy data between an UST app channel and a LTT channel.
1800 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1801 struct ltt_ust_channel
*uchan
)
1803 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1805 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1806 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1808 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1809 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1811 /* Copy event attributes since the layout is different. */
1812 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1813 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1814 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1815 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1816 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1817 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
1818 ua_chan
->attr
.output
= uchan
->attr
.output
;
1819 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
1822 * Note that the attribute channel type is not set since the channel on the
1823 * tracing registry side does not have this information.
1826 ua_chan
->enabled
= uchan
->enabled
;
1827 ua_chan
->tracing_channel_id
= uchan
->id
;
1829 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1833 * Copy data between a UST app session and a regular LTT session.
1835 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1836 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1838 struct tm
*timeinfo
;
1841 char tmp_shm_path
[PATH_MAX
];
1843 timeinfo
= localtime(&app
->registration_time
);
1844 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1846 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1848 ua_sess
->tracing_id
= usess
->id
;
1849 ua_sess
->id
= get_next_session_id();
1850 ua_sess
->real_credentials
.uid
= app
->uid
;
1851 ua_sess
->real_credentials
.gid
= app
->gid
;
1852 ua_sess
->effective_credentials
.uid
= usess
->uid
;
1853 ua_sess
->effective_credentials
.gid
= usess
->gid
;
1854 ua_sess
->buffer_type
= usess
->buffer_type
;
1855 ua_sess
->bits_per_long
= app
->bits_per_long
;
1857 /* There is only one consumer object per session possible. */
1858 consumer_output_get(usess
->consumer
);
1859 ua_sess
->consumer
= usess
->consumer
;
1861 ua_sess
->output_traces
= usess
->output_traces
;
1862 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1863 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1864 &usess
->metadata_attr
);
1866 switch (ua_sess
->buffer_type
) {
1867 case LTTNG_BUFFER_PER_PID
:
1868 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1869 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1872 case LTTNG_BUFFER_PER_UID
:
1873 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1874 DEFAULT_UST_TRACE_UID_PATH
,
1875 ua_sess
->real_credentials
.uid
,
1876 app
->bits_per_long
);
1883 PERROR("asprintf UST shadow copy session");
1888 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1889 sizeof(ua_sess
->root_shm_path
));
1890 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1891 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1892 sizeof(ua_sess
->shm_path
));
1893 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1894 if (ua_sess
->shm_path
[0]) {
1895 switch (ua_sess
->buffer_type
) {
1896 case LTTNG_BUFFER_PER_PID
:
1897 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1898 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1899 app
->name
, app
->pid
, datetime
);
1901 case LTTNG_BUFFER_PER_UID
:
1902 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1903 "/" DEFAULT_UST_TRACE_UID_PATH
,
1904 app
->uid
, app
->bits_per_long
);
1911 PERROR("sprintf UST shadow copy session");
1915 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1916 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1917 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1922 consumer_output_put(ua_sess
->consumer
);
1926 * Lookup sesison wrapper.
1929 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
1930 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1932 /* Get right UST app session from app */
1933 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1937 * Return ust app session from the app session hashtable using the UST session
1940 static struct ust_app_session
*lookup_session_by_app(
1941 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
1943 struct lttng_ht_iter iter
;
1944 struct lttng_ht_node_u64
*node
;
1946 __lookup_session_by_app(usess
, app
, &iter
);
1947 node
= lttng_ht_iter_get_node_u64(&iter
);
1952 return caa_container_of(node
, struct ust_app_session
, node
);
1959 * Setup buffer registry per PID for the given session and application. If none
1960 * is found, a new one is created, added to the global registry and
1961 * initialized. If regp is valid, it's set with the newly created object.
1963 * Return 0 on success or else a negative value.
1965 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1966 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1969 struct buffer_reg_pid
*reg_pid
;
1976 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1979 * This is the create channel path meaning that if there is NO
1980 * registry available, we have to create one for this session.
1982 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
1983 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1991 /* Initialize registry. */
1992 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1993 app
->bits_per_long
, app
->uint8_t_alignment
,
1994 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1995 app
->uint64_t_alignment
, app
->long_alignment
,
1996 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
1997 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
1998 ua_sess
->effective_credentials
.uid
,
1999 ua_sess
->effective_credentials
.gid
, ua_sess
->tracing_id
,
2003 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2004 * destroy the buffer registry, because it is always expected
2005 * that if the buffer registry can be found, its ust registry is
2008 buffer_reg_pid_destroy(reg_pid
);
2012 buffer_reg_pid_add(reg_pid
);
2014 DBG3("UST app buffer registry per PID created successfully");
2026 * Setup buffer registry per UID for the given session and application. If none
2027 * is found, a new one is created, added to the global registry and
2028 * initialized. If regp is valid, it's set with the newly created object.
2030 * Return 0 on success or else a negative value.
2032 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2033 struct ust_app_session
*ua_sess
,
2034 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2037 struct buffer_reg_uid
*reg_uid
;
2044 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2047 * This is the create channel path meaning that if there is NO
2048 * registry available, we have to create one for this session.
2050 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2051 LTTNG_DOMAIN_UST
, ®_uid
,
2052 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2060 /* Initialize registry. */
2061 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2062 app
->bits_per_long
, app
->uint8_t_alignment
,
2063 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2064 app
->uint64_t_alignment
, app
->long_alignment
,
2065 app
->byte_order
, app
->version
.major
,
2066 app
->version
.minor
, reg_uid
->root_shm_path
,
2067 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2068 ua_sess
->tracing_id
, app
->uid
);
2071 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2072 * destroy the buffer registry, because it is always expected
2073 * that if the buffer registry can be found, its ust registry is
2076 buffer_reg_uid_destroy(reg_uid
, NULL
);
2079 /* Add node to teardown list of the session. */
2080 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2082 buffer_reg_uid_add(reg_uid
);
2084 DBG3("UST app buffer registry per UID created successfully");
2095 * Create a session on the tracer side for the given app.
2097 * On success, ua_sess_ptr is populated with the session pointer or else left
2098 * untouched. If the session was created, is_created is set to 1. On error,
2099 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2102 * Returns 0 on success or else a negative code which is either -ENOMEM or
2103 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2105 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2106 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2109 int ret
, created
= 0;
2110 struct ust_app_session
*ua_sess
;
2114 assert(ua_sess_ptr
);
2116 health_code_update();
2118 ua_sess
= lookup_session_by_app(usess
, app
);
2119 if (ua_sess
== NULL
) {
2120 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2121 app
->pid
, usess
->id
);
2122 ua_sess
= alloc_ust_app_session();
2123 if (ua_sess
== NULL
) {
2124 /* Only malloc can failed so something is really wrong */
2128 shadow_copy_session(ua_sess
, usess
, app
);
2132 switch (usess
->buffer_type
) {
2133 case LTTNG_BUFFER_PER_PID
:
2134 /* Init local registry. */
2135 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2137 delete_ust_app_session(-1, ua_sess
, app
);
2141 case LTTNG_BUFFER_PER_UID
:
2142 /* Look for a global registry. If none exists, create one. */
2143 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2145 delete_ust_app_session(-1, ua_sess
, app
);
2155 health_code_update();
2157 if (ua_sess
->handle
== -1) {
2158 pthread_mutex_lock(&app
->sock_lock
);
2159 ret
= ustctl_create_session(app
->sock
);
2160 pthread_mutex_unlock(&app
->sock_lock
);
2162 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2163 ERR("Creating session for app pid %d with ret %d",
2166 DBG("UST app creating session failed. Application is dead");
2168 * This is normal behavior, an application can die during the
2169 * creation process. Don't report an error so the execution can
2170 * continue normally. This will get flagged ENOTCONN and the
2171 * caller will handle it.
2175 delete_ust_app_session(-1, ua_sess
, app
);
2176 if (ret
!= -ENOMEM
) {
2178 * Tracer is probably gone or got an internal error so let's
2179 * behave like it will soon unregister or not usable.
2186 ua_sess
->handle
= ret
;
2188 /* Add ust app session to app's HT */
2189 lttng_ht_node_init_u64(&ua_sess
->node
,
2190 ua_sess
->tracing_id
);
2191 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2192 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2193 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2194 &ua_sess
->ust_objd_node
);
2196 DBG2("UST app session created successfully with handle %d", ret
);
2199 *ua_sess_ptr
= ua_sess
;
2201 *is_created
= created
;
2204 /* Everything went well. */
2208 health_code_update();
2213 * Match function for a hash table lookup of ust_app_ctx.
2215 * It matches an ust app context based on the context type and, in the case
2216 * of perf counters, their name.
2218 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2220 struct ust_app_ctx
*ctx
;
2221 const struct lttng_ust_context_attr
*key
;
2226 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2230 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2235 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2236 if (strncmp(key
->u
.perf_counter
.name
,
2237 ctx
->ctx
.u
.perf_counter
.name
,
2238 sizeof(key
->u
.perf_counter
.name
))) {
2242 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2243 if (strcmp(key
->u
.app_ctx
.provider_name
,
2244 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2245 strcmp(key
->u
.app_ctx
.ctx_name
,
2246 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2262 * Lookup for an ust app context from an lttng_ust_context.
2264 * Must be called while holding RCU read side lock.
2265 * Return an ust_app_ctx object or NULL on error.
2268 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2269 struct lttng_ust_context_attr
*uctx
)
2271 struct lttng_ht_iter iter
;
2272 struct lttng_ht_node_ulong
*node
;
2273 struct ust_app_ctx
*app_ctx
= NULL
;
2278 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2279 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2280 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2281 node
= lttng_ht_iter_get_node_ulong(&iter
);
2286 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2293 * Create a context for the channel on the tracer.
2295 * Called with UST app session lock held and a RCU read side lock.
2298 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2299 struct lttng_ust_context_attr
*uctx
,
2300 struct ust_app
*app
)
2303 struct ust_app_ctx
*ua_ctx
;
2305 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2307 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2313 ua_ctx
= alloc_ust_app_ctx(uctx
);
2314 if (ua_ctx
== NULL
) {
2320 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2321 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2322 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2324 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2334 * Enable on the tracer side a ust app event for the session and channel.
2336 * Called with UST app session lock held.
2339 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2340 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2344 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2349 ua_event
->enabled
= 1;
2356 * Disable on the tracer side a ust app event for the session and channel.
2358 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2359 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2363 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2368 ua_event
->enabled
= 0;
2375 * Lookup ust app channel for session and disable it on the tracer side.
2378 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2379 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2383 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2388 ua_chan
->enabled
= 0;
2395 * Lookup ust app channel for session and enable it on the tracer side. This
2396 * MUST be called with a RCU read side lock acquired.
2398 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2399 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2402 struct lttng_ht_iter iter
;
2403 struct lttng_ht_node_str
*ua_chan_node
;
2404 struct ust_app_channel
*ua_chan
;
2406 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2407 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2408 if (ua_chan_node
== NULL
) {
2409 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2410 uchan
->name
, ua_sess
->tracing_id
);
2414 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2416 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2426 * Ask the consumer to create a channel and get it if successful.
2428 * Called with UST app session lock held.
2430 * Return 0 on success or else a negative value.
2432 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2433 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2434 int bitness
, struct ust_registry_session
*registry
,
2435 uint64_t trace_archive_id
)
2438 unsigned int nb_fd
= 0;
2439 struct consumer_socket
*socket
;
2447 health_code_update();
2449 /* Get the right consumer socket for the application. */
2450 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2456 health_code_update();
2458 /* Need one fd for the channel. */
2459 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2461 ERR("Exhausted number of available FD upon create channel");
2466 * Ask consumer to create channel. The consumer will return the number of
2467 * stream we have to expect.
2469 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2470 registry
, usess
->current_trace_chunk
);
2476 * Compute the number of fd needed before receiving them. It must be 2 per
2477 * stream (2 being the default value here).
2479 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2481 /* Reserve the amount of file descriptor we need. */
2482 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2484 ERR("Exhausted number of available FD upon create channel");
2485 goto error_fd_get_stream
;
2488 health_code_update();
2491 * Now get the channel from the consumer. This call wil populate the stream
2492 * list of that channel and set the ust objects.
2494 if (usess
->consumer
->enabled
) {
2495 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2505 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2506 error_fd_get_stream
:
2508 * Initiate a destroy channel on the consumer since we had an error
2509 * handling it on our side. The return value is of no importance since we
2510 * already have a ret value set by the previous error that we need to
2513 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2515 lttng_fd_put(LTTNG_FD_APPS
, 1);
2517 health_code_update();
2523 * Duplicate the ust data object of the ust app stream and save it in the
2524 * buffer registry stream.
2526 * Return 0 on success or else a negative value.
2528 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2529 struct ust_app_stream
*stream
)
2536 /* Reserve the amount of file descriptor we need. */
2537 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2539 ERR("Exhausted number of available FD upon duplicate stream");
2543 /* Duplicate object for stream once the original is in the registry. */
2544 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2545 reg_stream
->obj
.ust
);
2547 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2548 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2549 lttng_fd_put(LTTNG_FD_APPS
, 2);
2552 stream
->handle
= stream
->obj
->handle
;
2559 * Duplicate the ust data object of the ust app. channel and save it in the
2560 * buffer registry channel.
2562 * Return 0 on success or else a negative value.
2564 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2565 struct ust_app_channel
*ua_chan
)
2572 /* Need two fds for the channel. */
2573 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2575 ERR("Exhausted number of available FD upon duplicate channel");
2579 /* Duplicate object for stream once the original is in the registry. */
2580 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2582 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2583 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2586 ua_chan
->handle
= ua_chan
->obj
->handle
;
2591 lttng_fd_put(LTTNG_FD_APPS
, 1);
2597 * For a given channel buffer registry, setup all streams of the given ust
2598 * application channel.
2600 * Return 0 on success or else a negative value.
2602 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2603 struct ust_app_channel
*ua_chan
,
2604 struct ust_app
*app
)
2607 struct ust_app_stream
*stream
, *stmp
;
2612 DBG2("UST app setup buffer registry stream");
2614 /* Send all streams to application. */
2615 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2616 struct buffer_reg_stream
*reg_stream
;
2618 ret
= buffer_reg_stream_create(®_stream
);
2624 * Keep original pointer and nullify it in the stream so the delete
2625 * stream call does not release the object.
2627 reg_stream
->obj
.ust
= stream
->obj
;
2629 buffer_reg_stream_add(reg_stream
, reg_chan
);
2631 /* We don't need the streams anymore. */
2632 cds_list_del(&stream
->list
);
2633 delete_ust_app_stream(-1, stream
, app
);
2641 * Create a buffer registry channel for the given session registry and
2642 * application channel object. If regp pointer is valid, it's set with the
2643 * created object. Important, the created object is NOT added to the session
2644 * registry hash table.
2646 * Return 0 on success else a negative value.
2648 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2649 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2652 struct buffer_reg_channel
*reg_chan
= NULL
;
2657 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2659 /* Create buffer registry channel. */
2660 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2665 reg_chan
->consumer_key
= ua_chan
->key
;
2666 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2667 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2669 /* Create and add a channel registry to session. */
2670 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2671 ua_chan
->tracing_channel_id
);
2675 buffer_reg_channel_add(reg_sess
, reg_chan
);
2684 /* Safe because the registry channel object was not added to any HT. */
2685 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2691 * Setup buffer registry channel for the given session registry and application
2692 * channel object. If regp pointer is valid, it's set with the created object.
2694 * Return 0 on success else a negative value.
2696 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2697 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2698 struct ust_app
*app
)
2705 assert(ua_chan
->obj
);
2707 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2709 /* Setup all streams for the registry. */
2710 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2715 reg_chan
->obj
.ust
= ua_chan
->obj
;
2716 ua_chan
->obj
= NULL
;
2721 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2722 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2727 * Send buffer registry channel to the application.
2729 * Return 0 on success else a negative value.
2731 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2732 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2733 struct ust_app_channel
*ua_chan
)
2736 struct buffer_reg_stream
*reg_stream
;
2743 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2745 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2750 /* Send channel to the application. */
2751 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2752 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2753 ret
= -ENOTCONN
; /* Caused by app exiting. */
2755 } else if (ret
< 0) {
2759 health_code_update();
2761 /* Send all streams to application. */
2762 pthread_mutex_lock(®_chan
->stream_list_lock
);
2763 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2764 struct ust_app_stream stream
;
2766 ret
= duplicate_stream_object(reg_stream
, &stream
);
2768 goto error_stream_unlock
;
2771 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2773 (void) release_ust_app_stream(-1, &stream
, app
);
2774 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2775 ret
= -ENOTCONN
; /* Caused by app exiting. */
2777 goto error_stream_unlock
;
2781 * The return value is not important here. This function will output an
2784 (void) release_ust_app_stream(-1, &stream
, app
);
2786 ua_chan
->is_sent
= 1;
2788 error_stream_unlock
:
2789 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2795 * Create and send to the application the created buffers with per UID buffers.
2797 * This MUST be called with a RCU read side lock acquired.
2798 * The session list lock and the session's lock must be acquired.
2800 * Return 0 on success else a negative value.
2802 static int create_channel_per_uid(struct ust_app
*app
,
2803 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2804 struct ust_app_channel
*ua_chan
)
2807 struct buffer_reg_uid
*reg_uid
;
2808 struct buffer_reg_channel
*reg_chan
;
2809 struct ltt_session
*session
= NULL
;
2810 enum lttng_error_code notification_ret
;
2811 struct ust_registry_channel
*chan_reg
;
2818 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2820 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2822 * The session creation handles the creation of this global registry
2823 * object. If none can be find, there is a code flow problem or a
2828 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2834 /* Create the buffer registry channel object. */
2835 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2837 ERR("Error creating the UST channel \"%s\" registry instance",
2842 session
= session_find_by_id(ua_sess
->tracing_id
);
2844 assert(pthread_mutex_trylock(&session
->lock
));
2845 assert(session_trylock_list());
2848 * Create the buffers on the consumer side. This call populates the
2849 * ust app channel object with all streams and data object.
2851 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2852 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
2853 session
->most_recent_chunk_id
.value
);
2855 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2859 * Let's remove the previously created buffer registry channel so
2860 * it's not visible anymore in the session registry.
2862 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2863 ua_chan
->tracing_channel_id
, false);
2864 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2865 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2870 * Setup the streams and add it to the session registry.
2872 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2873 ua_chan
, reg_chan
, app
);
2875 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
2879 /* Notify the notification subsystem of the channel's creation. */
2880 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
2881 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
2882 ua_chan
->tracing_channel_id
);
2884 chan_reg
->consumer_key
= ua_chan
->key
;
2886 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
2888 notification_ret
= notification_thread_command_add_channel(
2889 notification_thread_handle
, session
->name
,
2890 ua_sess
->effective_credentials
.uid
,
2891 ua_sess
->effective_credentials
.gid
, ua_chan
->name
,
2892 ua_chan
->key
, LTTNG_DOMAIN_UST
,
2893 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2894 if (notification_ret
!= LTTNG_OK
) {
2895 ret
= - (int) notification_ret
;
2896 ERR("Failed to add channel to notification thread");
2901 /* Send buffers to the application. */
2902 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2904 if (ret
!= -ENOTCONN
) {
2905 ERR("Error sending channel to application");
2912 session_put(session
);
2918 * Create and send to the application the created buffers with per PID buffers.
2920 * Called with UST app session lock held.
2921 * The session list lock and the session's lock must be acquired.
2923 * Return 0 on success else a negative value.
2925 static int create_channel_per_pid(struct ust_app
*app
,
2926 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2927 struct ust_app_channel
*ua_chan
)
2930 struct ust_registry_session
*registry
;
2931 enum lttng_error_code cmd_ret
;
2932 struct ltt_session
*session
= NULL
;
2933 uint64_t chan_reg_key
;
2934 struct ust_registry_channel
*chan_reg
;
2941 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2945 registry
= get_session_registry(ua_sess
);
2946 /* The UST app session lock is held, registry shall not be null. */
2949 /* Create and add a new channel registry to session. */
2950 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2952 ERR("Error creating the UST channel \"%s\" registry instance",
2957 session
= session_find_by_id(ua_sess
->tracing_id
);
2960 assert(pthread_mutex_trylock(&session
->lock
));
2961 assert(session_trylock_list());
2963 /* Create and get channel on the consumer side. */
2964 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2965 app
->bits_per_long
, registry
,
2966 session
->most_recent_chunk_id
.value
);
2968 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2970 goto error_remove_from_registry
;
2973 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2975 if (ret
!= -ENOTCONN
) {
2976 ERR("Error sending channel to application");
2978 goto error_remove_from_registry
;
2981 chan_reg_key
= ua_chan
->key
;
2982 pthread_mutex_lock(®istry
->lock
);
2983 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
2985 chan_reg
->consumer_key
= ua_chan
->key
;
2986 pthread_mutex_unlock(®istry
->lock
);
2988 cmd_ret
= notification_thread_command_add_channel(
2989 notification_thread_handle
, session
->name
,
2990 ua_sess
->effective_credentials
.uid
,
2991 ua_sess
->effective_credentials
.gid
, ua_chan
->name
,
2992 ua_chan
->key
, LTTNG_DOMAIN_UST
,
2993 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2994 if (cmd_ret
!= LTTNG_OK
) {
2995 ret
= - (int) cmd_ret
;
2996 ERR("Failed to add channel to notification thread");
2997 goto error_remove_from_registry
;
3000 error_remove_from_registry
:
3002 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3007 session_put(session
);
3013 * From an already allocated ust app channel, create the channel buffers if
3014 * needed and send them to the application. This MUST be called with a RCU read
3015 * side lock acquired.
3017 * Called with UST app session lock held.
3019 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3020 * the application exited concurrently.
3022 static int ust_app_channel_send(struct ust_app
*app
,
3023 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3024 struct ust_app_channel
*ua_chan
)
3030 assert(usess
->active
);
3034 /* Handle buffer type before sending the channel to the application. */
3035 switch (usess
->buffer_type
) {
3036 case LTTNG_BUFFER_PER_UID
:
3038 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3044 case LTTNG_BUFFER_PER_PID
:
3046 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3058 /* Initialize ust objd object using the received handle and add it. */
3059 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3060 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3062 /* If channel is not enabled, disable it on the tracer */
3063 if (!ua_chan
->enabled
) {
3064 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3075 * Create UST app channel and return it through ua_chanp if not NULL.
3077 * Called with UST app session lock and RCU read-side lock held.
3079 * Return 0 on success or else a negative value.
3081 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3082 struct ltt_ust_channel
*uchan
,
3083 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3084 struct ust_app_channel
**ua_chanp
)
3087 struct lttng_ht_iter iter
;
3088 struct lttng_ht_node_str
*ua_chan_node
;
3089 struct ust_app_channel
*ua_chan
;
3091 /* Lookup channel in the ust app session */
3092 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3093 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3094 if (ua_chan_node
!= NULL
) {
3095 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3099 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3100 if (ua_chan
== NULL
) {
3101 /* Only malloc can fail here */
3105 shadow_copy_channel(ua_chan
, uchan
);
3107 /* Set channel type. */
3108 ua_chan
->attr
.type
= type
;
3110 /* Only add the channel if successful on the tracer side. */
3111 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3114 *ua_chanp
= ua_chan
;
3117 /* Everything went well. */
3125 * Create UST app event and create it on the tracer side.
3127 * Called with ust app session mutex held.
3130 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3131 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3132 struct ust_app
*app
)
3135 struct ust_app_event
*ua_event
;
3137 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3138 if (ua_event
== NULL
) {
3139 /* Only failure mode of alloc_ust_app_event(). */
3143 shadow_copy_event(ua_event
, uevent
);
3145 /* Create it on the tracer side */
3146 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3149 * Not found previously means that it does not exist on the
3150 * tracer. If the application reports that the event existed,
3151 * it means there is a bug in the sessiond or lttng-ust
3152 * (or corruption, etc.)
3154 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3155 ERR("Tracer for application reported that an event being created already existed: "
3156 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3158 app
->pid
, app
->ppid
, app
->uid
,
3164 add_unique_ust_app_event(ua_chan
, ua_event
);
3166 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3173 /* Valid. Calling here is already in a read side lock */
3174 delete_ust_app_event(-1, ua_event
, app
);
3179 * Create UST metadata and open it on the tracer side.
3181 * Called with UST app session lock held and RCU read side lock.
3183 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3184 struct ust_app
*app
, struct consumer_output
*consumer
)
3187 struct ust_app_channel
*metadata
;
3188 struct consumer_socket
*socket
;
3189 struct ust_registry_session
*registry
;
3190 struct ltt_session
*session
= NULL
;
3196 registry
= get_session_registry(ua_sess
);
3197 /* The UST app session is held registry shall not be null. */
3200 pthread_mutex_lock(®istry
->lock
);
3202 /* Metadata already exists for this registry or it was closed previously */
3203 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3208 /* Allocate UST metadata */
3209 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3211 /* malloc() failed */
3216 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3218 /* Need one fd for the channel. */
3219 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3221 ERR("Exhausted number of available FD upon create metadata");
3225 /* Get the right consumer socket for the application. */
3226 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3229 goto error_consumer
;
3233 * Keep metadata key so we can identify it on the consumer side. Assign it
3234 * to the registry *before* we ask the consumer so we avoid the race of the
3235 * consumer requesting the metadata and the ask_channel call on our side
3236 * did not returned yet.
3238 registry
->metadata_key
= metadata
->key
;
3240 session
= session_find_by_id(ua_sess
->tracing_id
);
3243 assert(pthread_mutex_trylock(&session
->lock
));
3244 assert(session_trylock_list());
3247 * Ask the metadata channel creation to the consumer. The metadata object
3248 * will be created by the consumer and kept their. However, the stream is
3249 * never added or monitored until we do a first push metadata to the
3252 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3253 registry
, session
->current_trace_chunk
);
3255 /* Nullify the metadata key so we don't try to close it later on. */
3256 registry
->metadata_key
= 0;
3257 goto error_consumer
;
3261 * The setup command will make the metadata stream be sent to the relayd,
3262 * if applicable, and the thread managing the metadatas. This is important
3263 * because after this point, if an error occurs, the only way the stream
3264 * can be deleted is to be monitored in the consumer.
3266 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3268 /* Nullify the metadata key so we don't try to close it later on. */
3269 registry
->metadata_key
= 0;
3270 goto error_consumer
;
3273 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3274 metadata
->key
, app
->pid
);
3277 lttng_fd_put(LTTNG_FD_APPS
, 1);
3278 delete_ust_app_channel(-1, metadata
, app
);
3280 pthread_mutex_unlock(®istry
->lock
);
3282 session_put(session
);
3288 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3289 * acquired before calling this function.
3291 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3293 struct ust_app
*app
= NULL
;
3294 struct lttng_ht_node_ulong
*node
;
3295 struct lttng_ht_iter iter
;
3297 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3298 node
= lttng_ht_iter_get_node_ulong(&iter
);
3300 DBG2("UST app no found with pid %d", pid
);
3304 DBG2("Found UST app by pid %d", pid
);
3306 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3313 * Allocate and init an UST app object using the registration information and
3314 * the command socket. This is called when the command socket connects to the
3317 * The object is returned on success or else NULL.
3319 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3321 struct ust_app
*lta
= NULL
;
3326 DBG3("UST app creating application for socket %d", sock
);
3328 if ((msg
->bits_per_long
== 64 &&
3329 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3330 || (msg
->bits_per_long
== 32 &&
3331 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3332 ERR("Registration failed: application \"%s\" (pid: %d) has "
3333 "%d-bit long, but no consumerd for this size is available.\n",
3334 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3338 lta
= zmalloc(sizeof(struct ust_app
));
3344 lta
->ppid
= msg
->ppid
;
3345 lta
->uid
= msg
->uid
;
3346 lta
->gid
= msg
->gid
;
3348 lta
->bits_per_long
= msg
->bits_per_long
;
3349 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3350 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3351 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3352 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3353 lta
->long_alignment
= msg
->long_alignment
;
3354 lta
->byte_order
= msg
->byte_order
;
3356 lta
->v_major
= msg
->major
;
3357 lta
->v_minor
= msg
->minor
;
3358 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3359 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3360 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3361 lta
->notify_sock
= -1;
3363 /* Copy name and make sure it's NULL terminated. */
3364 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3365 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3368 * Before this can be called, when receiving the registration information,
3369 * the application compatibility is checked. So, at this point, the
3370 * application can work with this session daemon.
3372 lta
->compatible
= 1;
3374 lta
->pid
= msg
->pid
;
3375 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3377 pthread_mutex_init(<a
->sock_lock
, NULL
);
3378 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3380 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3386 * For a given application object, add it to every hash table.
3388 void ust_app_add(struct ust_app
*app
)
3391 assert(app
->notify_sock
>= 0);
3393 app
->registration_time
= time(NULL
);
3398 * On a re-registration, we want to kick out the previous registration of
3401 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3404 * The socket _should_ be unique until _we_ call close. So, a add_unique
3405 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3406 * already in the table.
3408 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3410 /* Add application to the notify socket hash table. */
3411 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3412 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3414 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3415 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3416 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3423 * Set the application version into the object.
3425 * Return 0 on success else a negative value either an errno code or a
3426 * LTTng-UST error code.
3428 int ust_app_version(struct ust_app
*app
)
3434 pthread_mutex_lock(&app
->sock_lock
);
3435 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3436 pthread_mutex_unlock(&app
->sock_lock
);
3438 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3439 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3441 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3449 * Unregister app by removing it from the global traceable app list and freeing
3452 * The socket is already closed at this point so no close to sock.
3454 void ust_app_unregister(int sock
)
3456 struct ust_app
*lta
;
3457 struct lttng_ht_node_ulong
*node
;
3458 struct lttng_ht_iter ust_app_sock_iter
;
3459 struct lttng_ht_iter iter
;
3460 struct ust_app_session
*ua_sess
;
3465 /* Get the node reference for a call_rcu */
3466 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3467 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3470 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3471 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3474 * For per-PID buffers, perform "push metadata" and flush all
3475 * application streams before removing app from hash tables,
3476 * ensuring proper behavior of data_pending check.
3477 * Remove sessions so they are not visible during deletion.
3479 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3481 struct ust_registry_session
*registry
;
3483 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3485 /* The session was already removed so scheduled for teardown. */
3489 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3490 (void) ust_app_flush_app_session(lta
, ua_sess
);
3494 * Add session to list for teardown. This is safe since at this point we
3495 * are the only one using this list.
3497 pthread_mutex_lock(&ua_sess
->lock
);
3499 if (ua_sess
->deleted
) {
3500 pthread_mutex_unlock(&ua_sess
->lock
);
3505 * Normally, this is done in the delete session process which is
3506 * executed in the call rcu below. However, upon registration we can't
3507 * afford to wait for the grace period before pushing data or else the
3508 * data pending feature can race between the unregistration and stop
3509 * command where the data pending command is sent *before* the grace
3512 * The close metadata below nullifies the metadata pointer in the
3513 * session so the delete session will NOT push/close a second time.
3515 registry
= get_session_registry(ua_sess
);
3517 /* Push metadata for application before freeing the application. */
3518 (void) push_metadata(registry
, ua_sess
->consumer
);
3521 * Don't ask to close metadata for global per UID buffers. Close
3522 * metadata only on destroy trace session in this case. Also, the
3523 * previous push metadata could have flag the metadata registry to
3524 * close so don't send a close command if closed.
3526 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3527 /* And ask to close it for this session registry. */
3528 (void) close_metadata(registry
, ua_sess
->consumer
);
3531 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3533 pthread_mutex_unlock(&ua_sess
->lock
);
3536 /* Remove application from PID hash table */
3537 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3541 * Remove application from notify hash table. The thread handling the
3542 * notify socket could have deleted the node so ignore on error because
3543 * either way it's valid. The close of that socket is handled by the
3544 * apps_notify_thread.
3546 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3547 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3550 * Ignore return value since the node might have been removed before by an
3551 * add replace during app registration because the PID can be reassigned by
3554 iter
.iter
.node
= <a
->pid_n
.node
;
3555 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3557 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3562 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3569 * Fill events array with all events name of all registered apps.
3571 int ust_app_list_events(struct lttng_event
**events
)
3574 size_t nbmem
, count
= 0;
3575 struct lttng_ht_iter iter
;
3576 struct ust_app
*app
;
3577 struct lttng_event
*tmp_event
;
3579 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3580 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3581 if (tmp_event
== NULL
) {
3582 PERROR("zmalloc ust app events");
3589 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3590 struct lttng_ust_tracepoint_iter uiter
;
3592 health_code_update();
3594 if (!app
->compatible
) {
3596 * TODO: In time, we should notice the caller of this error by
3597 * telling him that this is a version error.
3601 pthread_mutex_lock(&app
->sock_lock
);
3602 handle
= ustctl_tracepoint_list(app
->sock
);
3604 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3605 ERR("UST app list events getting handle failed for app pid %d",
3608 pthread_mutex_unlock(&app
->sock_lock
);
3612 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3613 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3614 /* Handle ustctl error. */
3618 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3619 ERR("UST app tp list get failed for app %d with ret %d",
3622 DBG3("UST app tp list get failed. Application is dead");
3624 * This is normal behavior, an application can die during the
3625 * creation process. Don't report an error so the execution can
3626 * continue normally. Continue normal execution.
3631 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3632 if (release_ret
< 0 &&
3633 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3634 release_ret
!= -EPIPE
) {
3635 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3637 pthread_mutex_unlock(&app
->sock_lock
);
3641 health_code_update();
3642 if (count
>= nbmem
) {
3643 /* In case the realloc fails, we free the memory */
3644 struct lttng_event
*new_tmp_event
;
3647 new_nbmem
= nbmem
<< 1;
3648 DBG2("Reallocating event list from %zu to %zu entries",
3650 new_tmp_event
= realloc(tmp_event
,
3651 new_nbmem
* sizeof(struct lttng_event
));
3652 if (new_tmp_event
== NULL
) {
3655 PERROR("realloc ust app events");
3658 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3659 if (release_ret
< 0 &&
3660 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3661 release_ret
!= -EPIPE
) {
3662 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3664 pthread_mutex_unlock(&app
->sock_lock
);
3667 /* Zero the new memory */
3668 memset(new_tmp_event
+ nbmem
, 0,
3669 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3671 tmp_event
= new_tmp_event
;
3673 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3674 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3675 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3676 tmp_event
[count
].pid
= app
->pid
;
3677 tmp_event
[count
].enabled
= -1;
3680 ret
= ustctl_release_handle(app
->sock
, handle
);
3681 pthread_mutex_unlock(&app
->sock_lock
);
3682 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3683 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3688 *events
= tmp_event
;
3690 DBG2("UST app list events done (%zu events)", count
);
3695 health_code_update();
3700 * Fill events array with all events name of all registered apps.
3702 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3705 size_t nbmem
, count
= 0;
3706 struct lttng_ht_iter iter
;
3707 struct ust_app
*app
;
3708 struct lttng_event_field
*tmp_event
;
3710 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3711 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3712 if (tmp_event
== NULL
) {
3713 PERROR("zmalloc ust app event fields");
3720 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3721 struct lttng_ust_field_iter uiter
;
3723 health_code_update();
3725 if (!app
->compatible
) {
3727 * TODO: In time, we should notice the caller of this error by
3728 * telling him that this is a version error.
3732 pthread_mutex_lock(&app
->sock_lock
);
3733 handle
= ustctl_tracepoint_field_list(app
->sock
);
3735 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3736 ERR("UST app list field getting handle failed for app pid %d",
3739 pthread_mutex_unlock(&app
->sock_lock
);
3743 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3744 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3745 /* Handle ustctl error. */
3749 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3750 ERR("UST app tp list field failed for app %d with ret %d",
3753 DBG3("UST app tp list field failed. Application is dead");
3755 * This is normal behavior, an application can die during the
3756 * creation process. Don't report an error so the execution can
3757 * continue normally. Reset list and count for next app.
3762 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3763 pthread_mutex_unlock(&app
->sock_lock
);
3764 if (release_ret
< 0 &&
3765 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3766 release_ret
!= -EPIPE
) {
3767 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3772 health_code_update();
3773 if (count
>= nbmem
) {
3774 /* In case the realloc fails, we free the memory */
3775 struct lttng_event_field
*new_tmp_event
;
3778 new_nbmem
= nbmem
<< 1;
3779 DBG2("Reallocating event field list from %zu to %zu entries",
3781 new_tmp_event
= realloc(tmp_event
,
3782 new_nbmem
* sizeof(struct lttng_event_field
));
3783 if (new_tmp_event
== NULL
) {
3786 PERROR("realloc ust app event fields");
3789 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3790 pthread_mutex_unlock(&app
->sock_lock
);
3792 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3793 release_ret
!= -EPIPE
) {
3794 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3798 /* Zero the new memory */
3799 memset(new_tmp_event
+ nbmem
, 0,
3800 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3802 tmp_event
= new_tmp_event
;
3805 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3806 /* Mapping between these enums matches 1 to 1. */
3807 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3808 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3810 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3811 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3812 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3813 tmp_event
[count
].event
.pid
= app
->pid
;
3814 tmp_event
[count
].event
.enabled
= -1;
3817 ret
= ustctl_release_handle(app
->sock
, handle
);
3818 pthread_mutex_unlock(&app
->sock_lock
);
3820 ret
!= -LTTNG_UST_ERR_EXITING
&&
3822 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3827 *fields
= tmp_event
;
3829 DBG2("UST app list event fields done (%zu events)", count
);
3834 health_code_update();
3839 * Free and clean all traceable apps of the global list.
3841 * Should _NOT_ be called with RCU read-side lock held.
3843 void ust_app_clean_list(void)
3846 struct ust_app
*app
;
3847 struct lttng_ht_iter iter
;
3849 DBG2("UST app cleaning registered apps hash table");
3853 /* Cleanup notify socket hash table */
3854 if (ust_app_ht_by_notify_sock
) {
3855 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3856 notify_sock_n
.node
) {
3857 struct cds_lfht_node
*node
;
3858 struct ust_app
*app
;
3860 node
= cds_lfht_iter_get_node(&iter
.iter
);
3865 app
= container_of(node
, struct ust_app
,
3866 notify_sock_n
.node
);
3867 ust_app_notify_sock_unregister(app
->notify_sock
);
3872 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3873 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3875 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3879 /* Cleanup socket hash table */
3880 if (ust_app_ht_by_sock
) {
3881 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3883 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3890 /* Destroy is done only when the ht is empty */
3892 ht_cleanup_push(ust_app_ht
);
3894 if (ust_app_ht_by_sock
) {
3895 ht_cleanup_push(ust_app_ht_by_sock
);
3897 if (ust_app_ht_by_notify_sock
) {
3898 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3903 * Init UST app hash table.
3905 int ust_app_ht_alloc(void)
3907 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3911 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3912 if (!ust_app_ht_by_sock
) {
3915 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3916 if (!ust_app_ht_by_notify_sock
) {
3923 * For a specific UST session, disable the channel for all registered apps.
3925 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3926 struct ltt_ust_channel
*uchan
)
3929 struct lttng_ht_iter iter
;
3930 struct lttng_ht_node_str
*ua_chan_node
;
3931 struct ust_app
*app
;
3932 struct ust_app_session
*ua_sess
;
3933 struct ust_app_channel
*ua_chan
;
3935 assert(usess
->active
);
3936 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3937 uchan
->name
, usess
->id
);
3941 /* For every registered applications */
3942 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3943 struct lttng_ht_iter uiter
;
3944 if (!app
->compatible
) {
3946 * TODO: In time, we should notice the caller of this error by
3947 * telling him that this is a version error.
3951 ua_sess
= lookup_session_by_app(usess
, app
);
3952 if (ua_sess
== NULL
) {
3957 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3958 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3959 /* If the session if found for the app, the channel must be there */
3960 assert(ua_chan_node
);
3962 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3963 /* The channel must not be already disabled */
3964 assert(ua_chan
->enabled
== 1);
3966 /* Disable channel onto application */
3967 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3969 /* XXX: We might want to report this error at some point... */
3979 * For a specific UST session, enable the channel for all registered apps.
3981 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3982 struct ltt_ust_channel
*uchan
)
3985 struct lttng_ht_iter iter
;
3986 struct ust_app
*app
;
3987 struct ust_app_session
*ua_sess
;
3989 assert(usess
->active
);
3990 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3991 uchan
->name
, usess
->id
);
3995 /* For every registered applications */
3996 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3997 if (!app
->compatible
) {
3999 * TODO: In time, we should notice the caller of this error by
4000 * telling him that this is a version error.
4004 ua_sess
= lookup_session_by_app(usess
, app
);
4005 if (ua_sess
== NULL
) {
4009 /* Enable channel onto application */
4010 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4012 /* XXX: We might want to report this error at some point... */
4022 * Disable an event in a channel and for a specific session.
4024 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4025 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4028 struct lttng_ht_iter iter
, uiter
;
4029 struct lttng_ht_node_str
*ua_chan_node
;
4030 struct ust_app
*app
;
4031 struct ust_app_session
*ua_sess
;
4032 struct ust_app_channel
*ua_chan
;
4033 struct ust_app_event
*ua_event
;
4035 assert(usess
->active
);
4036 DBG("UST app disabling event %s for all apps in channel "
4037 "%s for session id %" PRIu64
,
4038 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4042 /* For all registered applications */
4043 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4044 if (!app
->compatible
) {
4046 * TODO: In time, we should notice the caller of this error by
4047 * telling him that this is a version error.
4051 ua_sess
= lookup_session_by_app(usess
, app
);
4052 if (ua_sess
== NULL
) {
4057 /* Lookup channel in the ust app session */
4058 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4059 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4060 if (ua_chan_node
== NULL
) {
4061 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4062 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4065 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4067 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4068 uevent
->filter
, uevent
->attr
.loglevel
,
4070 if (ua_event
== NULL
) {
4071 DBG2("Event %s not found in channel %s for app pid %d."
4072 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4076 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4078 /* XXX: Report error someday... */
4087 /* The ua_sess lock must be held by the caller. */
4089 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4090 struct ust_app_session
*ua_sess
,
4091 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4092 struct ust_app_channel
**_ua_chan
)
4095 struct ust_app_channel
*ua_chan
= NULL
;
4098 ASSERT_LOCKED(ua_sess
->lock
);
4100 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4101 sizeof(uchan
->name
))) {
4102 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4106 struct ltt_ust_context
*uctx
= NULL
;
4109 * Create channel onto application and synchronize its
4112 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4113 LTTNG_UST_CHAN_PER_CPU
, usess
,
4116 ret
= ust_app_channel_send(app
, usess
,
4123 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4124 ret
= create_ust_app_channel_context(ua_chan
,
4135 * The application's socket is not valid. Either a bad socket
4136 * or a timeout on it. We can't inform the caller that for a
4137 * specific app, the session failed so lets continue here.
4139 ret
= 0; /* Not an error. */
4147 if (ret
== 0 && _ua_chan
) {
4149 * Only return the application's channel on success. Note
4150 * that the channel can still be part of the application's
4151 * channel hashtable on error.
4153 *_ua_chan
= ua_chan
;
4159 * Enable event for a specific session and channel on the tracer.
4161 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4162 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4165 struct lttng_ht_iter iter
, uiter
;
4166 struct lttng_ht_node_str
*ua_chan_node
;
4167 struct ust_app
*app
;
4168 struct ust_app_session
*ua_sess
;
4169 struct ust_app_channel
*ua_chan
;
4170 struct ust_app_event
*ua_event
;
4172 assert(usess
->active
);
4173 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4174 uevent
->attr
.name
, usess
->id
);
4177 * NOTE: At this point, this function is called only if the session and
4178 * channel passed are already created for all apps. and enabled on the
4184 /* For all registered applications */
4185 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4186 if (!app
->compatible
) {
4188 * TODO: In time, we should notice the caller of this error by
4189 * telling him that this is a version error.
4193 ua_sess
= lookup_session_by_app(usess
, app
);
4195 /* The application has problem or is probably dead. */
4199 pthread_mutex_lock(&ua_sess
->lock
);
4201 if (ua_sess
->deleted
) {
4202 pthread_mutex_unlock(&ua_sess
->lock
);
4206 /* Lookup channel in the ust app session */
4207 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4208 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4210 * It is possible that the channel cannot be found is
4211 * the channel/event creation occurs concurrently with
4212 * an application exit.
4214 if (!ua_chan_node
) {
4215 pthread_mutex_unlock(&ua_sess
->lock
);
4219 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4221 /* Get event node */
4222 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4223 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4224 if (ua_event
== NULL
) {
4225 DBG3("UST app enable event %s not found for app PID %d."
4226 "Skipping app", uevent
->attr
.name
, app
->pid
);
4230 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4232 pthread_mutex_unlock(&ua_sess
->lock
);
4236 pthread_mutex_unlock(&ua_sess
->lock
);
4245 * For a specific existing UST session and UST channel, creates the event for
4246 * all registered apps.
4248 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4249 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4252 struct lttng_ht_iter iter
, uiter
;
4253 struct lttng_ht_node_str
*ua_chan_node
;
4254 struct ust_app
*app
;
4255 struct ust_app_session
*ua_sess
;
4256 struct ust_app_channel
*ua_chan
;
4258 assert(usess
->active
);
4259 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4260 uevent
->attr
.name
, usess
->id
);
4264 /* For all registered applications */
4265 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4266 if (!app
->compatible
) {
4268 * TODO: In time, we should notice the caller of this error by
4269 * telling him that this is a version error.
4273 ua_sess
= lookup_session_by_app(usess
, app
);
4275 /* The application has problem or is probably dead. */
4279 pthread_mutex_lock(&ua_sess
->lock
);
4281 if (ua_sess
->deleted
) {
4282 pthread_mutex_unlock(&ua_sess
->lock
);
4286 /* Lookup channel in the ust app session */
4287 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4288 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4289 /* If the channel is not found, there is a code flow error */
4290 assert(ua_chan_node
);
4292 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4294 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4295 pthread_mutex_unlock(&ua_sess
->lock
);
4297 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4298 /* Possible value at this point: -ENOMEM. If so, we stop! */
4301 DBG2("UST app event %s already exist on app PID %d",
4302 uevent
->attr
.name
, app
->pid
);
4312 * Start tracing for a specific UST session and app.
4314 * Called with UST app session lock held.
4318 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4321 struct ust_app_session
*ua_sess
;
4323 DBG("Starting tracing for ust app pid %d", app
->pid
);
4327 if (!app
->compatible
) {
4331 ua_sess
= lookup_session_by_app(usess
, app
);
4332 if (ua_sess
== NULL
) {
4333 /* The session is in teardown process. Ignore and continue. */
4337 pthread_mutex_lock(&ua_sess
->lock
);
4339 if (ua_sess
->deleted
) {
4340 pthread_mutex_unlock(&ua_sess
->lock
);
4344 if (ua_sess
->enabled
) {
4345 pthread_mutex_unlock(&ua_sess
->lock
);
4349 /* Upon restart, we skip the setup, already done */
4350 if (ua_sess
->started
) {
4355 * Create the metadata for the application. This returns gracefully if a
4356 * metadata was already set for the session.
4358 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4363 health_code_update();
4366 /* This starts the UST tracing */
4367 pthread_mutex_lock(&app
->sock_lock
);
4368 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4369 pthread_mutex_unlock(&app
->sock_lock
);
4371 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4372 ERR("Error starting tracing for app pid: %d (ret: %d)",
4375 DBG("UST app start session failed. Application is dead.");
4377 * This is normal behavior, an application can die during the
4378 * creation process. Don't report an error so the execution can
4379 * continue normally.
4381 pthread_mutex_unlock(&ua_sess
->lock
);
4387 /* Indicate that the session has been started once */
4388 ua_sess
->started
= 1;
4389 ua_sess
->enabled
= 1;
4391 pthread_mutex_unlock(&ua_sess
->lock
);
4393 health_code_update();
4395 /* Quiescent wait after starting trace */
4396 pthread_mutex_lock(&app
->sock_lock
);
4397 ret
= ustctl_wait_quiescent(app
->sock
);
4398 pthread_mutex_unlock(&app
->sock_lock
);
4399 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4400 ERR("UST app wait quiescent failed for app pid %d ret %d",
4406 health_code_update();
4410 pthread_mutex_unlock(&ua_sess
->lock
);
4412 health_code_update();
4417 * Stop tracing for a specific UST session and app.
4420 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4423 struct ust_app_session
*ua_sess
;
4424 struct ust_registry_session
*registry
;
4426 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4430 if (!app
->compatible
) {
4431 goto end_no_session
;
4434 ua_sess
= lookup_session_by_app(usess
, app
);
4435 if (ua_sess
== NULL
) {
4436 goto end_no_session
;
4439 pthread_mutex_lock(&ua_sess
->lock
);
4441 if (ua_sess
->deleted
) {
4442 pthread_mutex_unlock(&ua_sess
->lock
);
4443 goto end_no_session
;
4447 * If started = 0, it means that stop trace has been called for a session
4448 * that was never started. It's possible since we can have a fail start
4449 * from either the application manager thread or the command thread. Simply
4450 * indicate that this is a stop error.
4452 if (!ua_sess
->started
) {
4453 goto error_rcu_unlock
;
4456 health_code_update();
4458 /* This inhibits UST tracing */
4459 pthread_mutex_lock(&app
->sock_lock
);
4460 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4461 pthread_mutex_unlock(&app
->sock_lock
);
4463 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4464 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4467 DBG("UST app stop session failed. Application is dead.");
4469 * This is normal behavior, an application can die during the
4470 * creation process. Don't report an error so the execution can
4471 * continue normally.
4475 goto error_rcu_unlock
;
4478 health_code_update();
4479 ua_sess
->enabled
= 0;
4481 /* Quiescent wait after stopping trace */
4482 pthread_mutex_lock(&app
->sock_lock
);
4483 ret
= ustctl_wait_quiescent(app
->sock
);
4484 pthread_mutex_unlock(&app
->sock_lock
);
4485 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4486 ERR("UST app wait quiescent failed for app pid %d ret %d",
4490 health_code_update();
4492 registry
= get_session_registry(ua_sess
);
4494 /* The UST app session is held registry shall not be null. */
4497 /* Push metadata for application before freeing the application. */
4498 (void) push_metadata(registry
, ua_sess
->consumer
);
4501 pthread_mutex_unlock(&ua_sess
->lock
);
4504 health_code_update();
4508 pthread_mutex_unlock(&ua_sess
->lock
);
4510 health_code_update();
4515 int ust_app_flush_app_session(struct ust_app
*app
,
4516 struct ust_app_session
*ua_sess
)
4518 int ret
, retval
= 0;
4519 struct lttng_ht_iter iter
;
4520 struct ust_app_channel
*ua_chan
;
4521 struct consumer_socket
*socket
;
4523 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4527 if (!app
->compatible
) {
4528 goto end_not_compatible
;
4531 pthread_mutex_lock(&ua_sess
->lock
);
4533 if (ua_sess
->deleted
) {
4537 health_code_update();
4539 /* Flushing buffers */
4540 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4543 /* Flush buffers and push metadata. */
4544 switch (ua_sess
->buffer_type
) {
4545 case LTTNG_BUFFER_PER_PID
:
4546 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4548 health_code_update();
4549 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4551 ERR("Error flushing consumer channel");
4557 case LTTNG_BUFFER_PER_UID
:
4563 health_code_update();
4566 pthread_mutex_unlock(&ua_sess
->lock
);
4570 health_code_update();
4575 * Flush buffers for all applications for a specific UST session.
4576 * Called with UST session lock held.
4579 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4584 DBG("Flushing session buffers for all ust apps");
4588 /* Flush buffers and push metadata. */
4589 switch (usess
->buffer_type
) {
4590 case LTTNG_BUFFER_PER_UID
:
4592 struct buffer_reg_uid
*reg
;
4593 struct lttng_ht_iter iter
;
4595 /* Flush all per UID buffers associated to that session. */
4596 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4597 struct ust_registry_session
*ust_session_reg
;
4598 struct buffer_reg_channel
*reg_chan
;
4599 struct consumer_socket
*socket
;
4601 /* Get consumer socket to use to push the metadata.*/
4602 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4605 /* Ignore request if no consumer is found for the session. */
4609 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4610 reg_chan
, node
.node
) {
4612 * The following call will print error values so the return
4613 * code is of little importance because whatever happens, we
4614 * have to try them all.
4616 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4619 ust_session_reg
= reg
->registry
->reg
.ust
;
4620 /* Push metadata. */
4621 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4625 case LTTNG_BUFFER_PER_PID
:
4627 struct ust_app_session
*ua_sess
;
4628 struct lttng_ht_iter iter
;
4629 struct ust_app
*app
;
4631 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4632 ua_sess
= lookup_session_by_app(usess
, app
);
4633 if (ua_sess
== NULL
) {
4636 (void) ust_app_flush_app_session(app
, ua_sess
);
4647 health_code_update();
4652 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
4653 struct ust_app_session
*ua_sess
)
4656 struct lttng_ht_iter iter
;
4657 struct ust_app_channel
*ua_chan
;
4658 struct consumer_socket
*socket
;
4660 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
4664 if (!app
->compatible
) {
4665 goto end_not_compatible
;
4668 pthread_mutex_lock(&ua_sess
->lock
);
4670 if (ua_sess
->deleted
) {
4674 health_code_update();
4676 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4679 ERR("Failed to find consumer (%" PRIu32
") socket",
4680 app
->bits_per_long
);
4685 /* Clear quiescent state. */
4686 switch (ua_sess
->buffer_type
) {
4687 case LTTNG_BUFFER_PER_PID
:
4688 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
4689 ua_chan
, node
.node
) {
4690 health_code_update();
4691 ret
= consumer_clear_quiescent_channel(socket
,
4694 ERR("Error clearing quiescent state for consumer channel");
4700 case LTTNG_BUFFER_PER_UID
:
4707 health_code_update();
4710 pthread_mutex_unlock(&ua_sess
->lock
);
4714 health_code_update();
4719 * Clear quiescent state in each stream for all applications for a
4720 * specific UST session.
4721 * Called with UST session lock held.
4724 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
4729 DBG("Clearing stream quiescent state for all ust apps");
4733 switch (usess
->buffer_type
) {
4734 case LTTNG_BUFFER_PER_UID
:
4736 struct lttng_ht_iter iter
;
4737 struct buffer_reg_uid
*reg
;
4740 * Clear quiescent for all per UID buffers associated to
4743 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4744 struct consumer_socket
*socket
;
4745 struct buffer_reg_channel
*reg_chan
;
4747 /* Get associated consumer socket.*/
4748 socket
= consumer_find_socket_by_bitness(
4749 reg
->bits_per_long
, usess
->consumer
);
4752 * Ignore request if no consumer is found for
4758 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
4759 &iter
.iter
, reg_chan
, node
.node
) {
4761 * The following call will print error values so
4762 * the return code is of little importance
4763 * because whatever happens, we have to try them
4766 (void) consumer_clear_quiescent_channel(socket
,
4767 reg_chan
->consumer_key
);
4772 case LTTNG_BUFFER_PER_PID
:
4774 struct ust_app_session
*ua_sess
;
4775 struct lttng_ht_iter iter
;
4776 struct ust_app
*app
;
4778 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
4780 ua_sess
= lookup_session_by_app(usess
, app
);
4781 if (ua_sess
== NULL
) {
4784 (void) ust_app_clear_quiescent_app_session(app
,
4796 health_code_update();
4801 * Destroy a specific UST session in apps.
4803 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4806 struct ust_app_session
*ua_sess
;
4807 struct lttng_ht_iter iter
;
4808 struct lttng_ht_node_u64
*node
;
4810 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4814 if (!app
->compatible
) {
4818 __lookup_session_by_app(usess
, app
, &iter
);
4819 node
= lttng_ht_iter_get_node_u64(&iter
);
4821 /* Session is being or is deleted. */
4824 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4826 health_code_update();
4827 destroy_app_session(app
, ua_sess
);
4829 health_code_update();
4831 /* Quiescent wait after stopping trace */
4832 pthread_mutex_lock(&app
->sock_lock
);
4833 ret
= ustctl_wait_quiescent(app
->sock
);
4834 pthread_mutex_unlock(&app
->sock_lock
);
4835 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4836 ERR("UST app wait quiescent failed for app pid %d ret %d",
4841 health_code_update();
4846 * Start tracing for the UST session.
4848 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4850 struct lttng_ht_iter iter
;
4851 struct ust_app
*app
;
4853 DBG("Starting all UST traces");
4856 * Even though the start trace might fail, flag this session active so
4857 * other application coming in are started by default.
4864 * In a start-stop-start use-case, we need to clear the quiescent state
4865 * of each channel set by the prior stop command, thus ensuring that a
4866 * following stop or destroy is sure to grab a timestamp_end near those
4867 * operations, even if the packet is empty.
4869 (void) ust_app_clear_quiescent_session(usess
);
4871 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4872 ust_app_global_update(usess
, app
);
4881 * Start tracing for the UST session.
4882 * Called with UST session lock held.
4884 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4887 struct lttng_ht_iter iter
;
4888 struct ust_app
*app
;
4890 DBG("Stopping all UST traces");
4893 * Even though the stop trace might fail, flag this session inactive so
4894 * other application coming in are not started by default.
4900 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4901 ret
= ust_app_stop_trace(usess
, app
);
4903 /* Continue to next apps even on error */
4908 (void) ust_app_flush_session(usess
);
4916 * Destroy app UST session.
4918 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4921 struct lttng_ht_iter iter
;
4922 struct ust_app
*app
;
4924 DBG("Destroy all UST traces");
4928 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4929 ret
= destroy_trace(usess
, app
);
4931 /* Continue to next apps even on error */
4941 /* The ua_sess lock must be held by the caller. */
4943 int find_or_create_ust_app_channel(
4944 struct ltt_ust_session
*usess
,
4945 struct ust_app_session
*ua_sess
,
4946 struct ust_app
*app
,
4947 struct ltt_ust_channel
*uchan
,
4948 struct ust_app_channel
**ua_chan
)
4951 struct lttng_ht_iter iter
;
4952 struct lttng_ht_node_str
*ua_chan_node
;
4954 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
4955 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4957 *ua_chan
= caa_container_of(ua_chan_node
,
4958 struct ust_app_channel
, node
);
4962 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
4971 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
4972 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
4973 struct ust_app
*app
)
4976 struct ust_app_event
*ua_event
= NULL
;
4978 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4979 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4981 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4986 if (ua_event
->enabled
!= uevent
->enabled
) {
4987 ret
= uevent
->enabled
?
4988 enable_ust_app_event(ua_sess
, ua_event
, app
) :
4989 disable_ust_app_event(ua_sess
, ua_event
, app
);
4998 * The caller must ensure that the application is compatible and is tracked
4999 * by the PID tracker.
5002 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5003 struct ust_app
*app
)
5006 struct cds_lfht_iter uchan_iter
;
5007 struct ltt_ust_channel
*uchan
;
5008 struct ust_app_session
*ua_sess
= NULL
;
5011 * The application's configuration should only be synchronized for
5014 assert(usess
->active
);
5016 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5018 /* Tracer is probably gone or ENOMEM. */
5023 pthread_mutex_lock(&ua_sess
->lock
);
5024 if (ua_sess
->deleted
) {
5025 pthread_mutex_unlock(&ua_sess
->lock
);
5030 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5032 struct ust_app_channel
*ua_chan
;
5033 struct cds_lfht_iter uevent_iter
;
5034 struct ltt_ust_event
*uevent
;
5037 * Search for a matching ust_app_channel. If none is found,
5038 * create it. Creating the channel will cause the ua_chan
5039 * structure to be allocated, the channel buffers to be
5040 * allocated (if necessary) and sent to the application, and
5041 * all enabled contexts will be added to the channel.
5043 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5044 app
, uchan
, &ua_chan
);
5046 /* Tracer is probably gone or ENOMEM. */
5051 /* ua_chan will be NULL for the metadata channel */
5055 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5057 ret
= ust_app_channel_synchronize_event(ua_chan
,
5058 uevent
, ua_sess
, app
);
5064 if (ua_chan
->enabled
!= uchan
->enabled
) {
5065 ret
= uchan
->enabled
?
5066 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5067 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5076 pthread_mutex_unlock(&ua_sess
->lock
);
5077 /* Everything went well at this point. */
5082 pthread_mutex_unlock(&ua_sess
->lock
);
5085 destroy_app_session(app
, ua_sess
);
5091 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5093 struct ust_app_session
*ua_sess
;
5095 ua_sess
= lookup_session_by_app(usess
, app
);
5096 if (ua_sess
== NULL
) {
5099 destroy_app_session(app
, ua_sess
);
5103 * Add channels/events from UST global domain to registered apps at sock.
5105 * Called with session lock held.
5106 * Called with RCU read-side lock held.
5108 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5111 assert(usess
->active
);
5113 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5114 app
->sock
, usess
->id
);
5116 if (!app
->compatible
) {
5119 if (trace_ust_id_tracker_lookup(LTTNG_TRACKER_VPID
, usess
, app
->pid
) &&
5120 trace_ust_id_tracker_lookup(
5121 LTTNG_TRACKER_VUID
, usess
, app
->uid
) &&
5122 trace_ust_id_tracker_lookup(
5123 LTTNG_TRACKER_VGID
, usess
, app
->gid
)) {
5125 * Synchronize the application's internal tracing configuration
5126 * and start tracing.
5128 ust_app_synchronize(usess
, app
);
5129 ust_app_start_trace(usess
, app
);
5131 ust_app_global_destroy(usess
, app
);
5136 * Called with session lock held.
5138 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5140 struct lttng_ht_iter iter
;
5141 struct ust_app
*app
;
5144 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5145 ust_app_global_update(usess
, app
);
5151 * Add context to a specific channel for global UST domain.
5153 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5154 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5157 struct lttng_ht_node_str
*ua_chan_node
;
5158 struct lttng_ht_iter iter
, uiter
;
5159 struct ust_app_channel
*ua_chan
= NULL
;
5160 struct ust_app_session
*ua_sess
;
5161 struct ust_app
*app
;
5163 assert(usess
->active
);
5166 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5167 if (!app
->compatible
) {
5169 * TODO: In time, we should notice the caller of this error by
5170 * telling him that this is a version error.
5174 ua_sess
= lookup_session_by_app(usess
, app
);
5175 if (ua_sess
== NULL
) {
5179 pthread_mutex_lock(&ua_sess
->lock
);
5181 if (ua_sess
->deleted
) {
5182 pthread_mutex_unlock(&ua_sess
->lock
);
5186 /* Lookup channel in the ust app session */
5187 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5188 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5189 if (ua_chan_node
== NULL
) {
5192 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5194 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5199 pthread_mutex_unlock(&ua_sess
->lock
);
5207 * Receive registration and populate the given msg structure.
5209 * On success return 0 else a negative value returned by the ustctl call.
5211 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5214 uint32_t pid
, ppid
, uid
, gid
;
5218 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5219 &pid
, &ppid
, &uid
, &gid
,
5220 &msg
->bits_per_long
,
5221 &msg
->uint8_t_alignment
,
5222 &msg
->uint16_t_alignment
,
5223 &msg
->uint32_t_alignment
,
5224 &msg
->uint64_t_alignment
,
5225 &msg
->long_alignment
,
5232 case LTTNG_UST_ERR_EXITING
:
5233 DBG3("UST app recv reg message failed. Application died");
5235 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5236 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5237 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5238 LTTNG_UST_ABI_MINOR_VERSION
);
5241 ERR("UST app recv reg message failed with ret %d", ret
);
5246 msg
->pid
= (pid_t
) pid
;
5247 msg
->ppid
= (pid_t
) ppid
;
5248 msg
->uid
= (uid_t
) uid
;
5249 msg
->gid
= (gid_t
) gid
;
5256 * Return a ust app session object using the application object and the
5257 * session object descriptor has a key. If not found, NULL is returned.
5258 * A RCU read side lock MUST be acquired when calling this function.
5260 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5263 struct lttng_ht_node_ulong
*node
;
5264 struct lttng_ht_iter iter
;
5265 struct ust_app_session
*ua_sess
= NULL
;
5269 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5270 node
= lttng_ht_iter_get_node_ulong(&iter
);
5272 DBG2("UST app session find by objd %d not found", objd
);
5276 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5283 * Return a ust app channel object using the application object and the channel
5284 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5285 * lock MUST be acquired before calling this function.
5287 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5290 struct lttng_ht_node_ulong
*node
;
5291 struct lttng_ht_iter iter
;
5292 struct ust_app_channel
*ua_chan
= NULL
;
5296 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5297 node
= lttng_ht_iter_get_node_ulong(&iter
);
5299 DBG2("UST app channel find by objd %d not found", objd
);
5303 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5310 * Reply to a register channel notification from an application on the notify
5311 * socket. The channel metadata is also created.
5313 * The session UST registry lock is acquired in this function.
5315 * On success 0 is returned else a negative value.
5317 static int reply_ust_register_channel(int sock
, int cobjd
,
5318 size_t nr_fields
, struct ustctl_field
*fields
)
5320 int ret
, ret_code
= 0;
5322 uint64_t chan_reg_key
;
5323 enum ustctl_channel_header type
;
5324 struct ust_app
*app
;
5325 struct ust_app_channel
*ua_chan
;
5326 struct ust_app_session
*ua_sess
;
5327 struct ust_registry_session
*registry
;
5328 struct ust_registry_channel
*chan_reg
;
5332 /* Lookup application. If not found, there is a code flow error. */
5333 app
= find_app_by_notify_sock(sock
);
5335 DBG("Application socket %d is being torn down. Abort event notify",
5338 goto error_rcu_unlock
;
5341 /* Lookup channel by UST object descriptor. */
5342 ua_chan
= find_channel_by_objd(app
, cobjd
);
5344 DBG("Application channel is being torn down. Abort event notify");
5346 goto error_rcu_unlock
;
5349 assert(ua_chan
->session
);
5350 ua_sess
= ua_chan
->session
;
5352 /* Get right session registry depending on the session buffer type. */
5353 registry
= get_session_registry(ua_sess
);
5355 DBG("Application session is being torn down. Abort event notify");
5357 goto error_rcu_unlock
;
5360 /* Depending on the buffer type, a different channel key is used. */
5361 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5362 chan_reg_key
= ua_chan
->tracing_channel_id
;
5364 chan_reg_key
= ua_chan
->key
;
5367 pthread_mutex_lock(®istry
->lock
);
5369 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5372 if (!chan_reg
->register_done
) {
5374 * TODO: eventually use the registry event count for
5375 * this channel to better guess header type for per-pid
5378 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5379 chan_reg
->nr_ctx_fields
= nr_fields
;
5380 chan_reg
->ctx_fields
= fields
;
5382 chan_reg
->header_type
= type
;
5384 /* Get current already assigned values. */
5385 type
= chan_reg
->header_type
;
5387 /* Channel id is set during the object creation. */
5388 chan_id
= chan_reg
->chan_id
;
5390 /* Append to metadata */
5391 if (!chan_reg
->metadata_dumped
) {
5392 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5394 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5400 DBG3("UST app replying to register channel key %" PRIu64
5401 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5404 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5406 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5407 ERR("UST app reply channel failed with ret %d", ret
);
5409 DBG3("UST app reply channel failed. Application died");
5414 /* This channel registry registration is completed. */
5415 chan_reg
->register_done
= 1;
5418 pthread_mutex_unlock(®istry
->lock
);
5426 * Add event to the UST channel registry. When the event is added to the
5427 * registry, the metadata is also created. Once done, this replies to the
5428 * application with the appropriate error code.
5430 * The session UST registry lock is acquired in the function.
5432 * On success 0 is returned else a negative value.
5434 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5435 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5436 int loglevel_value
, char *model_emf_uri
)
5439 uint32_t event_id
= 0;
5440 uint64_t chan_reg_key
;
5441 struct ust_app
*app
;
5442 struct ust_app_channel
*ua_chan
;
5443 struct ust_app_session
*ua_sess
;
5444 struct ust_registry_session
*registry
;
5448 /* Lookup application. If not found, there is a code flow error. */
5449 app
= find_app_by_notify_sock(sock
);
5451 DBG("Application socket %d is being torn down. Abort event notify",
5454 goto error_rcu_unlock
;
5457 /* Lookup channel by UST object descriptor. */
5458 ua_chan
= find_channel_by_objd(app
, cobjd
);
5460 DBG("Application channel is being torn down. Abort event notify");
5462 goto error_rcu_unlock
;
5465 assert(ua_chan
->session
);
5466 ua_sess
= ua_chan
->session
;
5468 registry
= get_session_registry(ua_sess
);
5470 DBG("Application session is being torn down. Abort event notify");
5472 goto error_rcu_unlock
;
5475 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5476 chan_reg_key
= ua_chan
->tracing_channel_id
;
5478 chan_reg_key
= ua_chan
->key
;
5481 pthread_mutex_lock(®istry
->lock
);
5484 * From this point on, this call acquires the ownership of the sig, fields
5485 * and model_emf_uri meaning any free are done inside it if needed. These
5486 * three variables MUST NOT be read/write after this.
5488 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5489 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5490 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5494 model_emf_uri
= NULL
;
5497 * The return value is returned to ustctl so in case of an error, the
5498 * application can be notified. In case of an error, it's important not to
5499 * return a negative error or else the application will get closed.
5501 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5503 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5504 ERR("UST app reply event failed with ret %d", ret
);
5506 DBG3("UST app reply event failed. Application died");
5509 * No need to wipe the create event since the application socket will
5510 * get close on error hence cleaning up everything by itself.
5515 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5519 pthread_mutex_unlock(®istry
->lock
);
5524 free(model_emf_uri
);
5529 * Add enum to the UST session registry. Once done, this replies to the
5530 * application with the appropriate error code.
5532 * The session UST registry lock is acquired within this function.
5534 * On success 0 is returned else a negative value.
5536 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
5537 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
5539 int ret
= 0, ret_code
;
5540 struct ust_app
*app
;
5541 struct ust_app_session
*ua_sess
;
5542 struct ust_registry_session
*registry
;
5543 uint64_t enum_id
= -1ULL;
5547 /* Lookup application. If not found, there is a code flow error. */
5548 app
= find_app_by_notify_sock(sock
);
5550 /* Return an error since this is not an error */
5551 DBG("Application socket %d is being torn down. Aborting enum registration",
5554 goto error_rcu_unlock
;
5557 /* Lookup session by UST object descriptor. */
5558 ua_sess
= find_session_by_objd(app
, sobjd
);
5560 /* Return an error since this is not an error */
5561 DBG("Application session is being torn down (session not found). Aborting enum registration.");
5563 goto error_rcu_unlock
;
5566 registry
= get_session_registry(ua_sess
);
5568 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
5570 goto error_rcu_unlock
;
5573 pthread_mutex_lock(®istry
->lock
);
5576 * From this point on, the callee acquires the ownership of
5577 * entries. The variable entries MUST NOT be read/written after
5580 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
5581 entries
, nr_entries
, &enum_id
);
5585 * The return value is returned to ustctl so in case of an error, the
5586 * application can be notified. In case of an error, it's important not to
5587 * return a negative error or else the application will get closed.
5589 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
5591 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5592 ERR("UST app reply enum failed with ret %d", ret
);
5594 DBG3("UST app reply enum failed. Application died");
5597 * No need to wipe the create enum since the application socket will
5598 * get close on error hence cleaning up everything by itself.
5603 DBG3("UST registry enum %s added successfully or already found", name
);
5606 pthread_mutex_unlock(®istry
->lock
);
5613 * Handle application notification through the given notify socket.
5615 * Return 0 on success or else a negative value.
5617 int ust_app_recv_notify(int sock
)
5620 enum ustctl_notify_cmd cmd
;
5622 DBG3("UST app receiving notify from sock %d", sock
);
5624 ret
= ustctl_recv_notify(sock
, &cmd
);
5626 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5627 ERR("UST app recv notify failed with ret %d", ret
);
5629 DBG3("UST app recv notify failed. Application died");
5635 case USTCTL_NOTIFY_CMD_EVENT
:
5637 int sobjd
, cobjd
, loglevel_value
;
5638 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5640 struct ustctl_field
*fields
;
5642 DBG2("UST app ustctl register event received");
5644 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5645 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5648 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5649 ERR("UST app recv event failed with ret %d", ret
);
5651 DBG3("UST app recv event failed. Application died");
5657 * Add event to the UST registry coming from the notify socket. This
5658 * call will free if needed the sig, fields and model_emf_uri. This
5659 * code path loses the ownsership of these variables and transfer them
5660 * to the this function.
5662 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5663 fields
, loglevel_value
, model_emf_uri
);
5670 case USTCTL_NOTIFY_CMD_CHANNEL
:
5674 struct ustctl_field
*fields
;
5676 DBG2("UST app ustctl register channel received");
5678 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5681 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5682 ERR("UST app recv channel failed with ret %d", ret
);
5684 DBG3("UST app recv channel failed. Application died");
5690 * The fields ownership are transfered to this function call meaning
5691 * that if needed it will be freed. After this, it's invalid to access
5692 * fields or clean it up.
5694 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
5702 case USTCTL_NOTIFY_CMD_ENUM
:
5705 char name
[LTTNG_UST_SYM_NAME_LEN
];
5707 struct ustctl_enum_entry
*entries
;
5709 DBG2("UST app ustctl register enum received");
5711 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
5712 &entries
, &nr_entries
);
5714 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5715 ERR("UST app recv enum failed with ret %d", ret
);
5717 DBG3("UST app recv enum failed. Application died");
5722 /* Callee assumes ownership of entries */
5723 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
5724 entries
, nr_entries
);
5732 /* Should NEVER happen. */
5741 * Once the notify socket hangs up, this is called. First, it tries to find the
5742 * corresponding application. On failure, the call_rcu to close the socket is
5743 * executed. If an application is found, it tries to delete it from the notify
5744 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5746 * Note that an object needs to be allocated here so on ENOMEM failure, the
5747 * call RCU is not done but the rest of the cleanup is.
5749 void ust_app_notify_sock_unregister(int sock
)
5752 struct lttng_ht_iter iter
;
5753 struct ust_app
*app
;
5754 struct ust_app_notify_sock_obj
*obj
;
5760 obj
= zmalloc(sizeof(*obj
));
5763 * An ENOMEM is kind of uncool. If this strikes we continue the
5764 * procedure but the call_rcu will not be called. In this case, we
5765 * accept the fd leak rather than possibly creating an unsynchronized
5766 * state between threads.
5768 * TODO: The notify object should be created once the notify socket is
5769 * registered and stored independantely from the ust app object. The
5770 * tricky part is to synchronize the teardown of the application and
5771 * this notify object. Let's keep that in mind so we can avoid this
5772 * kind of shenanigans with ENOMEM in the teardown path.
5779 DBG("UST app notify socket unregister %d", sock
);
5782 * Lookup application by notify socket. If this fails, this means that the
5783 * hash table delete has already been done by the application
5784 * unregistration process so we can safely close the notify socket in a
5787 app
= find_app_by_notify_sock(sock
);
5792 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5795 * Whatever happens here either we fail or succeed, in both cases we have
5796 * to close the socket after a grace period to continue to the call RCU
5797 * here. If the deletion is successful, the application is not visible
5798 * anymore by other threads and is it fails it means that it was already
5799 * deleted from the hash table so either way we just have to close the
5802 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5808 * Close socket after a grace period to avoid for the socket to be reused
5809 * before the application object is freed creating potential race between
5810 * threads trying to add unique in the global hash table.
5813 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5818 * Destroy a ust app data structure and free its memory.
5820 void ust_app_destroy(struct ust_app
*app
)
5826 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5830 * Take a snapshot for a given UST session. The snapshot is sent to the given
5833 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5835 enum lttng_error_code
ust_app_snapshot_record(
5836 const struct ltt_ust_session
*usess
,
5837 const struct consumer_output
*output
, int wait
,
5838 uint64_t nb_packets_per_stream
)
5841 enum lttng_error_code status
= LTTNG_OK
;
5842 struct lttng_ht_iter iter
;
5843 struct ust_app
*app
;
5844 char *trace_path
= NULL
;
5851 switch (usess
->buffer_type
) {
5852 case LTTNG_BUFFER_PER_UID
:
5854 struct buffer_reg_uid
*reg
;
5856 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5857 struct buffer_reg_channel
*reg_chan
;
5858 struct consumer_socket
*socket
;
5859 char pathname
[PATH_MAX
];
5860 size_t consumer_path_offset
= 0;
5862 if (!reg
->registry
->reg
.ust
->metadata_key
) {
5863 /* Skip since no metadata is present */
5867 /* Get consumer socket to use to push the metadata.*/
5868 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5871 status
= LTTNG_ERR_INVALID
;
5875 memset(pathname
, 0, sizeof(pathname
));
5876 ret
= snprintf(pathname
, sizeof(pathname
),
5877 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5878 reg
->uid
, reg
->bits_per_long
);
5880 PERROR("snprintf snapshot path");
5881 status
= LTTNG_ERR_INVALID
;
5884 /* Free path allowed on previous iteration. */
5886 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
5887 &consumer_path_offset
);
5889 status
= LTTNG_ERR_INVALID
;
5892 /* Add the UST default trace dir to path. */
5893 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5894 reg_chan
, node
.node
) {
5895 status
= consumer_snapshot_channel(socket
,
5896 reg_chan
->consumer_key
,
5897 output
, 0, usess
->uid
,
5898 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
5899 nb_packets_per_stream
);
5900 if (status
!= LTTNG_OK
) {
5904 status
= consumer_snapshot_channel(socket
,
5905 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5906 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
5908 if (status
!= LTTNG_OK
) {
5914 case LTTNG_BUFFER_PER_PID
:
5916 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5917 struct consumer_socket
*socket
;
5918 struct lttng_ht_iter chan_iter
;
5919 struct ust_app_channel
*ua_chan
;
5920 struct ust_app_session
*ua_sess
;
5921 struct ust_registry_session
*registry
;
5922 char pathname
[PATH_MAX
];
5923 size_t consumer_path_offset
= 0;
5925 ua_sess
= lookup_session_by_app(usess
, app
);
5927 /* Session not associated with this app. */
5931 /* Get the right consumer socket for the application. */
5932 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5935 status
= LTTNG_ERR_INVALID
;
5939 /* Add the UST default trace dir to path. */
5940 memset(pathname
, 0, sizeof(pathname
));
5941 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5944 status
= LTTNG_ERR_INVALID
;
5945 PERROR("snprintf snapshot path");
5948 /* Free path allowed on previous iteration. */
5950 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
5951 &consumer_path_offset
);
5953 status
= LTTNG_ERR_INVALID
;
5956 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5957 ua_chan
, node
.node
) {
5958 status
= consumer_snapshot_channel(socket
,
5959 ua_chan
->key
, output
, 0,
5960 ua_sess
->effective_credentials
5962 ua_sess
->effective_credentials
5964 &trace_path
[consumer_path_offset
], wait
,
5965 nb_packets_per_stream
);
5969 case LTTNG_ERR_CHAN_NOT_FOUND
:
5976 registry
= get_session_registry(ua_sess
);
5978 DBG("Application session is being torn down. Skip application.");
5981 status
= consumer_snapshot_channel(socket
,
5982 registry
->metadata_key
, output
, 1,
5983 ua_sess
->effective_credentials
.uid
,
5984 ua_sess
->effective_credentials
.gid
,
5985 &trace_path
[consumer_path_offset
], wait
, 0);
5989 case LTTNG_ERR_CHAN_NOT_FOUND
:
6009 * Return the size taken by one more packet per stream.
6011 uint64_t ust_app_get_size_one_more_packet_per_stream(
6012 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6014 uint64_t tot_size
= 0;
6015 struct ust_app
*app
;
6016 struct lttng_ht_iter iter
;
6020 switch (usess
->buffer_type
) {
6021 case LTTNG_BUFFER_PER_UID
:
6023 struct buffer_reg_uid
*reg
;
6025 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6026 struct buffer_reg_channel
*reg_chan
;
6029 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6030 reg_chan
, node
.node
) {
6031 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6033 * Don't take channel into account if we
6034 * already grab all its packets.
6038 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6044 case LTTNG_BUFFER_PER_PID
:
6047 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6048 struct ust_app_channel
*ua_chan
;
6049 struct ust_app_session
*ua_sess
;
6050 struct lttng_ht_iter chan_iter
;
6052 ua_sess
= lookup_session_by_app(usess
, app
);
6054 /* Session not associated with this app. */
6058 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6059 ua_chan
, node
.node
) {
6060 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6062 * Don't take channel into account if we
6063 * already grab all its packets.
6067 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6081 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6082 struct cds_list_head
*buffer_reg_uid_list
,
6083 struct consumer_output
*consumer
, uint64_t uchan_id
,
6084 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6087 uint64_t consumer_chan_key
;
6092 ret
= buffer_reg_uid_consumer_channel_key(
6093 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6101 ret
= consumer_get_lost_packets(ust_session_id
,
6102 consumer_chan_key
, consumer
, lost
);
6104 ret
= consumer_get_discarded_events(ust_session_id
,
6105 consumer_chan_key
, consumer
, discarded
);
6112 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6113 struct ltt_ust_channel
*uchan
,
6114 struct consumer_output
*consumer
, int overwrite
,
6115 uint64_t *discarded
, uint64_t *lost
)
6118 struct lttng_ht_iter iter
;
6119 struct lttng_ht_node_str
*ua_chan_node
;
6120 struct ust_app
*app
;
6121 struct ust_app_session
*ua_sess
;
6122 struct ust_app_channel
*ua_chan
;
6129 * Iterate over every registered applications. Sum counters for
6130 * all applications containing requested session and channel.
6132 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6133 struct lttng_ht_iter uiter
;
6135 ua_sess
= lookup_session_by_app(usess
, app
);
6136 if (ua_sess
== NULL
) {
6141 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6142 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6143 /* If the session is found for the app, the channel must be there */
6144 assert(ua_chan_node
);
6146 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6151 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6158 uint64_t _discarded
;
6160 ret
= consumer_get_discarded_events(usess
->id
,
6161 ua_chan
->key
, consumer
, &_discarded
);
6165 (*discarded
) += _discarded
;
6174 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6175 struct ust_app
*app
)
6178 struct ust_app_session
*ua_sess
;
6180 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6184 ua_sess
= lookup_session_by_app(usess
, app
);
6185 if (ua_sess
== NULL
) {
6186 /* The session is in teardown process. Ignore and continue. */
6190 pthread_mutex_lock(&ua_sess
->lock
);
6192 if (ua_sess
->deleted
) {
6196 pthread_mutex_lock(&app
->sock_lock
);
6197 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6198 pthread_mutex_unlock(&app
->sock_lock
);
6201 pthread_mutex_unlock(&ua_sess
->lock
);
6205 health_code_update();
6210 * Regenerate the statedump for each app in the session.
6212 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6215 struct lttng_ht_iter iter
;
6216 struct ust_app
*app
;
6218 DBG("Regenerating the metadata for all UST apps");
6222 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6223 if (!app
->compatible
) {
6227 ret
= ust_app_regenerate_statedump(usess
, app
);
6229 /* Continue to the next app even on error */
6240 * Rotate all the channels of a session.
6242 * Return LTTNG_OK on success or else an LTTng error code.
6244 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6247 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6248 struct lttng_ht_iter iter
;
6249 struct ust_app
*app
;
6250 struct ltt_ust_session
*usess
= session
->ust_session
;
6256 switch (usess
->buffer_type
) {
6257 case LTTNG_BUFFER_PER_UID
:
6259 struct buffer_reg_uid
*reg
;
6261 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6262 struct buffer_reg_channel
*reg_chan
;
6263 struct consumer_socket
*socket
;
6265 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6266 /* Skip since no metadata is present */
6270 /* Get consumer socket to use to push the metadata.*/
6271 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6274 cmd_ret
= LTTNG_ERR_INVALID
;
6278 /* Rotate the data channels. */
6279 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6280 reg_chan
, node
.node
) {
6281 ret
= consumer_rotate_channel(socket
,
6282 reg_chan
->consumer_key
,
6283 usess
->uid
, usess
->gid
,
6285 /* is_metadata_channel */ false);
6287 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6292 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6294 ret
= consumer_rotate_channel(socket
,
6295 reg
->registry
->reg
.ust
->metadata_key
,
6296 usess
->uid
, usess
->gid
,
6298 /* is_metadata_channel */ true);
6300 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6306 case LTTNG_BUFFER_PER_PID
:
6308 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6309 struct consumer_socket
*socket
;
6310 struct lttng_ht_iter chan_iter
;
6311 struct ust_app_channel
*ua_chan
;
6312 struct ust_app_session
*ua_sess
;
6313 struct ust_registry_session
*registry
;
6315 ua_sess
= lookup_session_by_app(usess
, app
);
6317 /* Session not associated with this app. */
6321 /* Get the right consumer socket for the application. */
6322 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6325 cmd_ret
= LTTNG_ERR_INVALID
;
6329 registry
= get_session_registry(ua_sess
);
6331 DBG("Application session is being torn down. Skip application.");
6335 /* Rotate the data channels. */
6336 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6337 ua_chan
, node
.node
) {
6338 ret
= consumer_rotate_channel(socket
,
6340 ua_sess
->effective_credentials
6342 ua_sess
->effective_credentials
6345 /* is_metadata_channel */ false);
6347 /* Per-PID buffer and application going away. */
6348 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6350 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6355 /* Rotate the metadata channel. */
6356 (void) push_metadata(registry
, usess
->consumer
);
6357 ret
= consumer_rotate_channel(socket
,
6358 registry
->metadata_key
,
6359 ua_sess
->effective_credentials
.uid
,
6360 ua_sess
->effective_credentials
.gid
,
6362 /* is_metadata_channel */ true);
6364 /* Per-PID buffer and application going away. */
6365 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6367 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6385 enum lttng_error_code
ust_app_create_channel_subdirectories(
6386 const struct ltt_ust_session
*usess
)
6388 enum lttng_error_code ret
= LTTNG_OK
;
6389 struct lttng_ht_iter iter
;
6390 enum lttng_trace_chunk_status chunk_status
;
6391 char *pathname_index
;
6394 assert(usess
->current_trace_chunk
);
6397 switch (usess
->buffer_type
) {
6398 case LTTNG_BUFFER_PER_UID
:
6400 struct buffer_reg_uid
*reg
;
6402 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6403 fmt_ret
= asprintf(&pathname_index
,
6404 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
6405 reg
->uid
, reg
->bits_per_long
);
6407 ERR("Failed to format channel index directory");
6408 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6413 * Create the index subdirectory which will take care
6414 * of implicitly creating the channel's path.
6416 chunk_status
= lttng_trace_chunk_create_subdirectory(
6417 usess
->current_trace_chunk
,
6419 free(pathname_index
);
6420 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6421 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6427 case LTTNG_BUFFER_PER_PID
:
6429 struct ust_app
*app
;
6432 * Create the toplevel ust/ directory in case no apps are running.
6434 chunk_status
= lttng_trace_chunk_create_subdirectory(
6435 usess
->current_trace_chunk
,
6436 DEFAULT_UST_TRACE_DIR
);
6437 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6438 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6442 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
6444 struct ust_app_session
*ua_sess
;
6445 struct ust_registry_session
*registry
;
6447 ua_sess
= lookup_session_by_app(usess
, app
);
6449 /* Session not associated with this app. */
6453 registry
= get_session_registry(ua_sess
);
6455 DBG("Application session is being torn down. Skip application.");
6459 fmt_ret
= asprintf(&pathname_index
,
6460 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
6463 ERR("Failed to format channel index directory");
6464 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6468 * Create the index subdirectory which will take care
6469 * of implicitly creating the channel's path.
6471 chunk_status
= lttng_trace_chunk_create_subdirectory(
6472 usess
->current_trace_chunk
,
6474 free(pathname_index
);
6475 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6476 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6493 * Clear all the channels of a session.
6495 * Return LTTNG_OK on success or else an LTTng error code.
6497 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
6500 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6501 struct lttng_ht_iter iter
;
6502 struct ust_app
*app
;
6503 struct ltt_ust_session
*usess
= session
->ust_session
;
6509 if (usess
->active
) {
6510 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
6511 cmd_ret
= LTTNG_ERR_FATAL
;
6515 switch (usess
->buffer_type
) {
6516 case LTTNG_BUFFER_PER_UID
:
6518 struct buffer_reg_uid
*reg
;
6520 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6521 struct buffer_reg_channel
*reg_chan
;
6522 struct consumer_socket
*socket
;
6524 /* Get consumer socket to use to push the metadata.*/
6525 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6528 cmd_ret
= LTTNG_ERR_INVALID
;
6532 /* Clear the data channels. */
6533 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6534 reg_chan
, node
.node
) {
6535 ret
= consumer_clear_channel(socket
,
6536 reg_chan
->consumer_key
);
6542 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6545 * Clear the metadata channel.
6546 * Metadata channel is not cleared per se but we still need to
6547 * perform a rotation operation on it behind the scene.
6549 ret
= consumer_clear_channel(socket
,
6550 reg
->registry
->reg
.ust
->metadata_key
);
6557 case LTTNG_BUFFER_PER_PID
:
6559 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6560 struct consumer_socket
*socket
;
6561 struct lttng_ht_iter chan_iter
;
6562 struct ust_app_channel
*ua_chan
;
6563 struct ust_app_session
*ua_sess
;
6564 struct ust_registry_session
*registry
;
6566 ua_sess
= lookup_session_by_app(usess
, app
);
6568 /* Session not associated with this app. */
6572 /* Get the right consumer socket for the application. */
6573 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6576 cmd_ret
= LTTNG_ERR_INVALID
;
6580 registry
= get_session_registry(ua_sess
);
6582 DBG("Application session is being torn down. Skip application.");
6586 /* Clear the data channels. */
6587 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6588 ua_chan
, node
.node
) {
6589 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
6591 /* Per-PID buffer and application going away. */
6592 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
6599 (void) push_metadata(registry
, usess
->consumer
);
6602 * Clear the metadata channel.
6603 * Metadata channel is not cleared per se but we still need to
6604 * perform rotation operation on it behind the scene.
6606 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
6608 /* Per-PID buffer and application going away. */
6609 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
6627 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
6628 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
6631 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;