2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
16 #include <sys/types.h>
18 #include <urcu/compiler.h>
21 #include <common/compat/errno.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 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
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(const 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 const 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.
1346 static int set_ust_object_filter(struct ust_app
*app
,
1347 const struct lttng_filter_bytecode
*bytecode
,
1348 struct lttng_ust_object_data
*ust_object
)
1351 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1353 health_code_update();
1355 ust_bytecode
= create_ust_bytecode_from_bytecode(bytecode
);
1356 if (!ust_bytecode
) {
1357 ret
= -LTTNG_ERR_NOMEM
;
1360 pthread_mutex_lock(&app
->sock_lock
);
1361 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1363 pthread_mutex_unlock(&app
->sock_lock
);
1365 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1366 ERR("UST app set object filter failed for object %p of app (pid: %d) "
1367 "with ret %d", ust_object
, app
->pid
, ret
);
1370 * This is normal behavior, an application can die during the
1371 * creation process. Don't report an error so the execution can
1372 * continue normally.
1375 DBG3("Failed to set UST app object filter. Application is dead.");
1380 DBG2("UST filter successfully set for object %p", ust_object
);
1383 health_code_update();
1389 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1390 struct lttng_event_exclusion
*exclusion
)
1392 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1393 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1394 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1396 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1397 if (!ust_exclusion
) {
1402 assert(sizeof(struct lttng_event_exclusion
) ==
1403 sizeof(struct lttng_ust_event_exclusion
));
1404 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1406 return ust_exclusion
;
1410 * Set event exclusions on the tracer.
1413 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1414 struct ust_app
*app
)
1417 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1419 health_code_update();
1421 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1426 ust_exclusion
= create_ust_exclusion_from_exclusion(
1427 ua_event
->exclusion
);
1428 if (!ust_exclusion
) {
1429 ret
= -LTTNG_ERR_NOMEM
;
1432 pthread_mutex_lock(&app
->sock_lock
);
1433 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1434 pthread_mutex_unlock(&app
->sock_lock
);
1436 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1437 ERR("UST app event %s exclusions failed for app (pid: %d) "
1438 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1441 * This is normal behavior, an application can die during the
1442 * creation process. Don't report an error so the execution can
1443 * continue normally.
1446 DBG3("UST app event exclusion failed. Application is dead.");
1451 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1454 health_code_update();
1455 free(ust_exclusion
);
1460 * Disable the specified event on to UST tracer for the UST session.
1462 static int disable_ust_event(struct ust_app
*app
,
1463 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1467 health_code_update();
1469 pthread_mutex_lock(&app
->sock_lock
);
1470 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1471 pthread_mutex_unlock(&app
->sock_lock
);
1473 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1474 ERR("UST app event %s disable failed for app (pid: %d) "
1475 "and session handle %d with ret %d",
1476 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1479 * This is normal behavior, an application can die during the
1480 * creation process. Don't report an error so the execution can
1481 * continue normally.
1484 DBG3("UST app disable event failed. Application is dead.");
1489 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1490 ua_event
->attr
.name
, app
->pid
);
1493 health_code_update();
1498 * Disable the specified channel on to UST tracer for the UST session.
1500 static int disable_ust_channel(struct ust_app
*app
,
1501 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1505 health_code_update();
1507 pthread_mutex_lock(&app
->sock_lock
);
1508 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1509 pthread_mutex_unlock(&app
->sock_lock
);
1511 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1512 ERR("UST app channel %s disable failed for app (pid: %d) "
1513 "and session handle %d with ret %d",
1514 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1517 * This is normal behavior, an application can die during the
1518 * creation process. Don't report an error so the execution can
1519 * continue normally.
1522 DBG3("UST app disable channel failed. Application is dead.");
1527 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1528 ua_chan
->name
, app
->pid
);
1531 health_code_update();
1536 * Enable the specified channel on to UST tracer for the UST session.
1538 static int enable_ust_channel(struct ust_app
*app
,
1539 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1543 health_code_update();
1545 pthread_mutex_lock(&app
->sock_lock
);
1546 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1547 pthread_mutex_unlock(&app
->sock_lock
);
1549 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1550 ERR("UST app channel %s enable failed for app (pid: %d) "
1551 "and session handle %d with ret %d",
1552 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1555 * This is normal behavior, an application can die during the
1556 * creation process. Don't report an error so the execution can
1557 * continue normally.
1560 DBG3("UST app enable channel failed. Application is dead.");
1565 ua_chan
->enabled
= 1;
1567 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1568 ua_chan
->name
, app
->pid
);
1571 health_code_update();
1576 * Enable the specified event on to UST tracer for the UST session.
1578 static int enable_ust_event(struct ust_app
*app
,
1579 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1583 health_code_update();
1585 pthread_mutex_lock(&app
->sock_lock
);
1586 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1587 pthread_mutex_unlock(&app
->sock_lock
);
1589 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1590 ERR("UST app event %s enable failed for app (pid: %d) "
1591 "and session handle %d with ret %d",
1592 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1595 * This is normal behavior, an application can die during the
1596 * creation process. Don't report an error so the execution can
1597 * continue normally.
1600 DBG3("UST app enable event failed. Application is dead.");
1605 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1606 ua_event
->attr
.name
, app
->pid
);
1609 health_code_update();
1614 * Send channel and stream buffer to application.
1616 * Return 0 on success. On error, a negative value is returned.
1618 static int send_channel_pid_to_ust(struct ust_app
*app
,
1619 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1622 struct ust_app_stream
*stream
, *stmp
;
1628 health_code_update();
1630 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1633 /* Send channel to the application. */
1634 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1635 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1636 ret
= -ENOTCONN
; /* Caused by app exiting. */
1638 } else if (ret
< 0) {
1642 health_code_update();
1644 /* Send all streams to application. */
1645 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1646 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1647 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1648 ret
= -ENOTCONN
; /* Caused by app exiting. */
1650 } else if (ret
< 0) {
1653 /* We don't need the stream anymore once sent to the tracer. */
1654 cds_list_del(&stream
->list
);
1655 delete_ust_app_stream(-1, stream
, app
);
1657 /* Flag the channel that it is sent to the application. */
1658 ua_chan
->is_sent
= 1;
1661 health_code_update();
1666 * Create the specified event onto the UST tracer for a UST session.
1668 * Should be called with session mutex held.
1671 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1672 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1676 health_code_update();
1678 /* Create UST event on tracer */
1679 pthread_mutex_lock(&app
->sock_lock
);
1680 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1682 pthread_mutex_unlock(&app
->sock_lock
);
1684 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1686 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1687 ua_event
->attr
.name
, app
->pid
, ret
);
1690 * This is normal behavior, an application can die during the
1691 * creation process. Don't report an error so the execution can
1692 * continue normally.
1695 DBG3("UST app create event failed. Application is dead.");
1700 ua_event
->handle
= ua_event
->obj
->handle
;
1702 DBG2("UST app event %s created successfully for pid:%d",
1703 ua_event
->attr
.name
, app
->pid
);
1705 health_code_update();
1707 /* Set filter if one is present. */
1708 if (ua_event
->filter
) {
1709 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
1715 /* Set exclusions for the event */
1716 if (ua_event
->exclusion
) {
1717 ret
= set_ust_event_exclusion(ua_event
, app
);
1723 /* If event not enabled, disable it on the tracer */
1724 if (ua_event
->enabled
) {
1726 * We now need to explicitly enable the event, since it
1727 * is now disabled at creation.
1729 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1732 * If we hit an EPERM, something is wrong with our enable call. If
1733 * we get an EEXIST, there is a problem on the tracer side since we
1737 case -LTTNG_UST_ERR_PERM
:
1738 /* Code flow problem */
1740 case -LTTNG_UST_ERR_EXIST
:
1741 /* It's OK for our use case. */
1752 health_code_update();
1757 * Copy data between an UST app event and a LTT event.
1759 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1760 struct ltt_ust_event
*uevent
)
1762 size_t exclusion_alloc_size
;
1764 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1765 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1767 ua_event
->enabled
= uevent
->enabled
;
1769 /* Copy event attributes */
1770 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1772 /* Copy filter bytecode */
1773 if (uevent
->filter
) {
1774 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1775 /* Filter might be NULL here in case of ENONEM. */
1778 /* Copy exclusion data */
1779 if (uevent
->exclusion
) {
1780 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1781 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1782 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1783 if (ua_event
->exclusion
== NULL
) {
1786 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1787 exclusion_alloc_size
);
1793 * Copy data between an UST app channel and a LTT channel.
1795 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1796 struct ltt_ust_channel
*uchan
)
1798 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1800 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1801 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1803 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1804 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1806 /* Copy event attributes since the layout is different. */
1807 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1808 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1809 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1810 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1811 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1812 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
1813 ua_chan
->attr
.output
= uchan
->attr
.output
;
1814 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
1817 * Note that the attribute channel type is not set since the channel on the
1818 * tracing registry side does not have this information.
1821 ua_chan
->enabled
= uchan
->enabled
;
1822 ua_chan
->tracing_channel_id
= uchan
->id
;
1824 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1828 * Copy data between a UST app session and a regular LTT session.
1830 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1831 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1833 struct tm
*timeinfo
;
1836 char tmp_shm_path
[PATH_MAX
];
1838 timeinfo
= localtime(&app
->registration_time
);
1839 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1841 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1843 ua_sess
->tracing_id
= usess
->id
;
1844 ua_sess
->id
= get_next_session_id();
1845 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
1846 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
1847 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
1848 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
1849 ua_sess
->buffer_type
= usess
->buffer_type
;
1850 ua_sess
->bits_per_long
= app
->bits_per_long
;
1852 /* There is only one consumer object per session possible. */
1853 consumer_output_get(usess
->consumer
);
1854 ua_sess
->consumer
= usess
->consumer
;
1856 ua_sess
->output_traces
= usess
->output_traces
;
1857 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1858 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1859 &usess
->metadata_attr
);
1861 switch (ua_sess
->buffer_type
) {
1862 case LTTNG_BUFFER_PER_PID
:
1863 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1864 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1867 case LTTNG_BUFFER_PER_UID
:
1868 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1869 DEFAULT_UST_TRACE_UID_PATH
,
1870 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
1871 app
->bits_per_long
);
1878 PERROR("asprintf UST shadow copy session");
1883 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1884 sizeof(ua_sess
->root_shm_path
));
1885 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1886 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1887 sizeof(ua_sess
->shm_path
));
1888 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1889 if (ua_sess
->shm_path
[0]) {
1890 switch (ua_sess
->buffer_type
) {
1891 case LTTNG_BUFFER_PER_PID
:
1892 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1893 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1894 app
->name
, app
->pid
, datetime
);
1896 case LTTNG_BUFFER_PER_UID
:
1897 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1898 "/" DEFAULT_UST_TRACE_UID_PATH
,
1899 app
->uid
, app
->bits_per_long
);
1906 PERROR("sprintf UST shadow copy session");
1910 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1911 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1912 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1917 consumer_output_put(ua_sess
->consumer
);
1921 * Lookup sesison wrapper.
1924 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
1925 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1927 /* Get right UST app session from app */
1928 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1932 * Return ust app session from the app session hashtable using the UST session
1935 static struct ust_app_session
*lookup_session_by_app(
1936 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
1938 struct lttng_ht_iter iter
;
1939 struct lttng_ht_node_u64
*node
;
1941 __lookup_session_by_app(usess
, app
, &iter
);
1942 node
= lttng_ht_iter_get_node_u64(&iter
);
1947 return caa_container_of(node
, struct ust_app_session
, node
);
1954 * Setup buffer registry per PID for the given session and application. If none
1955 * is found, a new one is created, added to the global registry and
1956 * initialized. If regp is valid, it's set with the newly created object.
1958 * Return 0 on success or else a negative value.
1960 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1961 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1964 struct buffer_reg_pid
*reg_pid
;
1971 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1974 * This is the create channel path meaning that if there is NO
1975 * registry available, we have to create one for this session.
1977 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
1978 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1986 /* Initialize registry. */
1987 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1988 app
->bits_per_long
, app
->uint8_t_alignment
,
1989 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1990 app
->uint64_t_alignment
, app
->long_alignment
,
1991 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
1992 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
1993 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
1994 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
1995 ua_sess
->tracing_id
,
1999 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2000 * destroy the buffer registry, because it is always expected
2001 * that if the buffer registry can be found, its ust registry is
2004 buffer_reg_pid_destroy(reg_pid
);
2008 buffer_reg_pid_add(reg_pid
);
2010 DBG3("UST app buffer registry per PID created successfully");
2022 * Setup buffer registry per UID for the given session and application. If none
2023 * is found, a new one is created, added to the global registry and
2024 * initialized. If regp is valid, it's set with the newly created object.
2026 * Return 0 on success or else a negative value.
2028 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2029 struct ust_app_session
*ua_sess
,
2030 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2033 struct buffer_reg_uid
*reg_uid
;
2040 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2043 * This is the create channel path meaning that if there is NO
2044 * registry available, we have to create one for this session.
2046 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2047 LTTNG_DOMAIN_UST
, ®_uid
,
2048 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2056 /* Initialize registry. */
2057 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2058 app
->bits_per_long
, app
->uint8_t_alignment
,
2059 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2060 app
->uint64_t_alignment
, app
->long_alignment
,
2061 app
->byte_order
, app
->version
.major
,
2062 app
->version
.minor
, reg_uid
->root_shm_path
,
2063 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2064 ua_sess
->tracing_id
, app
->uid
);
2067 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2068 * destroy the buffer registry, because it is always expected
2069 * that if the buffer registry can be found, its ust registry is
2072 buffer_reg_uid_destroy(reg_uid
, NULL
);
2075 /* Add node to teardown list of the session. */
2076 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2078 buffer_reg_uid_add(reg_uid
);
2080 DBG3("UST app buffer registry per UID created successfully");
2091 * Create a session on the tracer side for the given app.
2093 * On success, ua_sess_ptr is populated with the session pointer or else left
2094 * untouched. If the session was created, is_created is set to 1. On error,
2095 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2098 * Returns 0 on success or else a negative code which is either -ENOMEM or
2099 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2101 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2102 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2105 int ret
, created
= 0;
2106 struct ust_app_session
*ua_sess
;
2110 assert(ua_sess_ptr
);
2112 health_code_update();
2114 ua_sess
= lookup_session_by_app(usess
, app
);
2115 if (ua_sess
== NULL
) {
2116 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2117 app
->pid
, usess
->id
);
2118 ua_sess
= alloc_ust_app_session();
2119 if (ua_sess
== NULL
) {
2120 /* Only malloc can failed so something is really wrong */
2124 shadow_copy_session(ua_sess
, usess
, app
);
2128 switch (usess
->buffer_type
) {
2129 case LTTNG_BUFFER_PER_PID
:
2130 /* Init local registry. */
2131 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2133 delete_ust_app_session(-1, ua_sess
, app
);
2137 case LTTNG_BUFFER_PER_UID
:
2138 /* Look for a global registry. If none exists, create one. */
2139 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2141 delete_ust_app_session(-1, ua_sess
, app
);
2151 health_code_update();
2153 if (ua_sess
->handle
== -1) {
2154 pthread_mutex_lock(&app
->sock_lock
);
2155 ret
= ustctl_create_session(app
->sock
);
2156 pthread_mutex_unlock(&app
->sock_lock
);
2158 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2159 ERR("Creating session for app pid %d with ret %d",
2162 DBG("UST app creating session failed. Application is dead");
2164 * This is normal behavior, an application can die during the
2165 * creation process. Don't report an error so the execution can
2166 * continue normally. This will get flagged ENOTCONN and the
2167 * caller will handle it.
2171 delete_ust_app_session(-1, ua_sess
, app
);
2172 if (ret
!= -ENOMEM
) {
2174 * Tracer is probably gone or got an internal error so let's
2175 * behave like it will soon unregister or not usable.
2182 ua_sess
->handle
= ret
;
2184 /* Add ust app session to app's HT */
2185 lttng_ht_node_init_u64(&ua_sess
->node
,
2186 ua_sess
->tracing_id
);
2187 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2188 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2189 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2190 &ua_sess
->ust_objd_node
);
2192 DBG2("UST app session created successfully with handle %d", ret
);
2195 *ua_sess_ptr
= ua_sess
;
2197 *is_created
= created
;
2200 /* Everything went well. */
2204 health_code_update();
2209 * Match function for a hash table lookup of ust_app_ctx.
2211 * It matches an ust app context based on the context type and, in the case
2212 * of perf counters, their name.
2214 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2216 struct ust_app_ctx
*ctx
;
2217 const struct lttng_ust_context_attr
*key
;
2222 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2226 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2231 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2232 if (strncmp(key
->u
.perf_counter
.name
,
2233 ctx
->ctx
.u
.perf_counter
.name
,
2234 sizeof(key
->u
.perf_counter
.name
))) {
2238 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2239 if (strcmp(key
->u
.app_ctx
.provider_name
,
2240 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2241 strcmp(key
->u
.app_ctx
.ctx_name
,
2242 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2258 * Lookup for an ust app context from an lttng_ust_context.
2260 * Must be called while holding RCU read side lock.
2261 * Return an ust_app_ctx object or NULL on error.
2264 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2265 struct lttng_ust_context_attr
*uctx
)
2267 struct lttng_ht_iter iter
;
2268 struct lttng_ht_node_ulong
*node
;
2269 struct ust_app_ctx
*app_ctx
= NULL
;
2274 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2275 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2276 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2277 node
= lttng_ht_iter_get_node_ulong(&iter
);
2282 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2289 * Create a context for the channel on the tracer.
2291 * Called with UST app session lock held and a RCU read side lock.
2294 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2295 struct lttng_ust_context_attr
*uctx
,
2296 struct ust_app
*app
)
2299 struct ust_app_ctx
*ua_ctx
;
2301 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2303 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2309 ua_ctx
= alloc_ust_app_ctx(uctx
);
2310 if (ua_ctx
== NULL
) {
2316 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2317 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2318 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2320 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2330 * Enable on the tracer side a ust app event for the session and channel.
2332 * Called with UST app session lock held.
2335 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2336 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2340 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2345 ua_event
->enabled
= 1;
2352 * Disable on the tracer side a ust app event for the session and channel.
2354 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2355 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2359 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2364 ua_event
->enabled
= 0;
2371 * Lookup ust app channel for session and disable it on the tracer side.
2374 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2375 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2379 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2384 ua_chan
->enabled
= 0;
2391 * Lookup ust app channel for session and enable it on the tracer side. This
2392 * MUST be called with a RCU read side lock acquired.
2394 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2395 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2398 struct lttng_ht_iter iter
;
2399 struct lttng_ht_node_str
*ua_chan_node
;
2400 struct ust_app_channel
*ua_chan
;
2402 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2403 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2404 if (ua_chan_node
== NULL
) {
2405 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2406 uchan
->name
, ua_sess
->tracing_id
);
2410 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2412 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2422 * Ask the consumer to create a channel and get it if successful.
2424 * Called with UST app session lock held.
2426 * Return 0 on success or else a negative value.
2428 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2429 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2430 int bitness
, struct ust_registry_session
*registry
,
2431 uint64_t trace_archive_id
)
2434 unsigned int nb_fd
= 0;
2435 struct consumer_socket
*socket
;
2443 health_code_update();
2445 /* Get the right consumer socket for the application. */
2446 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2452 health_code_update();
2454 /* Need one fd for the channel. */
2455 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2457 ERR("Exhausted number of available FD upon create channel");
2462 * Ask consumer to create channel. The consumer will return the number of
2463 * stream we have to expect.
2465 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2466 registry
, usess
->current_trace_chunk
);
2472 * Compute the number of fd needed before receiving them. It must be 2 per
2473 * stream (2 being the default value here).
2475 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2477 /* Reserve the amount of file descriptor we need. */
2478 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2480 ERR("Exhausted number of available FD upon create channel");
2481 goto error_fd_get_stream
;
2484 health_code_update();
2487 * Now get the channel from the consumer. This call wil populate the stream
2488 * list of that channel and set the ust objects.
2490 if (usess
->consumer
->enabled
) {
2491 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2501 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2502 error_fd_get_stream
:
2504 * Initiate a destroy channel on the consumer since we had an error
2505 * handling it on our side. The return value is of no importance since we
2506 * already have a ret value set by the previous error that we need to
2509 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2511 lttng_fd_put(LTTNG_FD_APPS
, 1);
2513 health_code_update();
2519 * Duplicate the ust data object of the ust app stream and save it in the
2520 * buffer registry stream.
2522 * Return 0 on success or else a negative value.
2524 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2525 struct ust_app_stream
*stream
)
2532 /* Reserve the amount of file descriptor we need. */
2533 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2535 ERR("Exhausted number of available FD upon duplicate stream");
2539 /* Duplicate object for stream once the original is in the registry. */
2540 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2541 reg_stream
->obj
.ust
);
2543 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2544 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2545 lttng_fd_put(LTTNG_FD_APPS
, 2);
2548 stream
->handle
= stream
->obj
->handle
;
2555 * Duplicate the ust data object of the ust app. channel and save it in the
2556 * buffer registry channel.
2558 * Return 0 on success or else a negative value.
2560 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2561 struct ust_app_channel
*ua_chan
)
2568 /* Need two fds for the channel. */
2569 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2571 ERR("Exhausted number of available FD upon duplicate channel");
2575 /* Duplicate object for stream once the original is in the registry. */
2576 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2578 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2579 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2582 ua_chan
->handle
= ua_chan
->obj
->handle
;
2587 lttng_fd_put(LTTNG_FD_APPS
, 1);
2593 * For a given channel buffer registry, setup all streams of the given ust
2594 * application channel.
2596 * Return 0 on success or else a negative value.
2598 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2599 struct ust_app_channel
*ua_chan
,
2600 struct ust_app
*app
)
2603 struct ust_app_stream
*stream
, *stmp
;
2608 DBG2("UST app setup buffer registry stream");
2610 /* Send all streams to application. */
2611 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2612 struct buffer_reg_stream
*reg_stream
;
2614 ret
= buffer_reg_stream_create(®_stream
);
2620 * Keep original pointer and nullify it in the stream so the delete
2621 * stream call does not release the object.
2623 reg_stream
->obj
.ust
= stream
->obj
;
2625 buffer_reg_stream_add(reg_stream
, reg_chan
);
2627 /* We don't need the streams anymore. */
2628 cds_list_del(&stream
->list
);
2629 delete_ust_app_stream(-1, stream
, app
);
2637 * Create a buffer registry channel for the given session registry and
2638 * application channel object. If regp pointer is valid, it's set with the
2639 * created object. Important, the created object is NOT added to the session
2640 * registry hash table.
2642 * Return 0 on success else a negative value.
2644 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2645 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2648 struct buffer_reg_channel
*reg_chan
= NULL
;
2653 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2655 /* Create buffer registry channel. */
2656 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2661 reg_chan
->consumer_key
= ua_chan
->key
;
2662 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2663 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2665 /* Create and add a channel registry to session. */
2666 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2667 ua_chan
->tracing_channel_id
);
2671 buffer_reg_channel_add(reg_sess
, reg_chan
);
2680 /* Safe because the registry channel object was not added to any HT. */
2681 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2687 * Setup buffer registry channel for the given session registry and application
2688 * channel object. If regp pointer is valid, it's set with the created object.
2690 * Return 0 on success else a negative value.
2692 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2693 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2694 struct ust_app
*app
)
2701 assert(ua_chan
->obj
);
2703 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2705 /* Setup all streams for the registry. */
2706 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2711 reg_chan
->obj
.ust
= ua_chan
->obj
;
2712 ua_chan
->obj
= NULL
;
2717 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2718 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2723 * Send buffer registry channel to the application.
2725 * Return 0 on success else a negative value.
2727 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2728 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2729 struct ust_app_channel
*ua_chan
)
2732 struct buffer_reg_stream
*reg_stream
;
2739 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2741 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2746 /* Send channel to the application. */
2747 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2748 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2749 ret
= -ENOTCONN
; /* Caused by app exiting. */
2751 } else if (ret
< 0) {
2755 health_code_update();
2757 /* Send all streams to application. */
2758 pthread_mutex_lock(®_chan
->stream_list_lock
);
2759 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2760 struct ust_app_stream stream
;
2762 ret
= duplicate_stream_object(reg_stream
, &stream
);
2764 goto error_stream_unlock
;
2767 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2769 (void) release_ust_app_stream(-1, &stream
, app
);
2770 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2771 ret
= -ENOTCONN
; /* Caused by app exiting. */
2773 goto error_stream_unlock
;
2777 * The return value is not important here. This function will output an
2780 (void) release_ust_app_stream(-1, &stream
, app
);
2782 ua_chan
->is_sent
= 1;
2784 error_stream_unlock
:
2785 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2791 * Create and send to the application the created buffers with per UID buffers.
2793 * This MUST be called with a RCU read side lock acquired.
2794 * The session list lock and the session's lock must be acquired.
2796 * Return 0 on success else a negative value.
2798 static int create_channel_per_uid(struct ust_app
*app
,
2799 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2800 struct ust_app_channel
*ua_chan
)
2803 struct buffer_reg_uid
*reg_uid
;
2804 struct buffer_reg_channel
*reg_chan
;
2805 struct ltt_session
*session
= NULL
;
2806 enum lttng_error_code notification_ret
;
2807 struct ust_registry_channel
*chan_reg
;
2814 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2816 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2818 * The session creation handles the creation of this global registry
2819 * object. If none can be find, there is a code flow problem or a
2824 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2830 /* Create the buffer registry channel object. */
2831 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2833 ERR("Error creating the UST channel \"%s\" registry instance",
2838 session
= session_find_by_id(ua_sess
->tracing_id
);
2840 assert(pthread_mutex_trylock(&session
->lock
));
2841 assert(session_trylock_list());
2844 * Create the buffers on the consumer side. This call populates the
2845 * ust app channel object with all streams and data object.
2847 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2848 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
2849 session
->most_recent_chunk_id
.value
);
2851 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2855 * Let's remove the previously created buffer registry channel so
2856 * it's not visible anymore in the session registry.
2858 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2859 ua_chan
->tracing_channel_id
, false);
2860 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2861 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2866 * Setup the streams and add it to the session registry.
2868 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2869 ua_chan
, reg_chan
, app
);
2871 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
2875 /* Notify the notification subsystem of the channel's creation. */
2876 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
2877 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
2878 ua_chan
->tracing_channel_id
);
2880 chan_reg
->consumer_key
= ua_chan
->key
;
2882 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
2884 notification_ret
= notification_thread_command_add_channel(
2885 notification_thread_handle
, session
->name
,
2886 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2887 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2889 ua_chan
->key
, LTTNG_DOMAIN_UST
,
2890 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2891 if (notification_ret
!= LTTNG_OK
) {
2892 ret
= - (int) notification_ret
;
2893 ERR("Failed to add channel to notification thread");
2898 /* Send buffers to the application. */
2899 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2901 if (ret
!= -ENOTCONN
) {
2902 ERR("Error sending channel to application");
2909 session_put(session
);
2915 * Create and send to the application the created buffers with per PID buffers.
2917 * Called with UST app session lock held.
2918 * The session list lock and the session's lock must be acquired.
2920 * Return 0 on success else a negative value.
2922 static int create_channel_per_pid(struct ust_app
*app
,
2923 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2924 struct ust_app_channel
*ua_chan
)
2927 struct ust_registry_session
*registry
;
2928 enum lttng_error_code cmd_ret
;
2929 struct ltt_session
*session
= NULL
;
2930 uint64_t chan_reg_key
;
2931 struct ust_registry_channel
*chan_reg
;
2938 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2942 registry
= get_session_registry(ua_sess
);
2943 /* The UST app session lock is held, registry shall not be null. */
2946 /* Create and add a new channel registry to session. */
2947 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2949 ERR("Error creating the UST channel \"%s\" registry instance",
2954 session
= session_find_by_id(ua_sess
->tracing_id
);
2957 assert(pthread_mutex_trylock(&session
->lock
));
2958 assert(session_trylock_list());
2960 /* Create and get channel on the consumer side. */
2961 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2962 app
->bits_per_long
, registry
,
2963 session
->most_recent_chunk_id
.value
);
2965 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2967 goto error_remove_from_registry
;
2970 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2972 if (ret
!= -ENOTCONN
) {
2973 ERR("Error sending channel to application");
2975 goto error_remove_from_registry
;
2978 chan_reg_key
= ua_chan
->key
;
2979 pthread_mutex_lock(®istry
->lock
);
2980 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
2982 chan_reg
->consumer_key
= ua_chan
->key
;
2983 pthread_mutex_unlock(®istry
->lock
);
2985 cmd_ret
= notification_thread_command_add_channel(
2986 notification_thread_handle
, session
->name
,
2987 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2988 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2990 ua_chan
->key
, LTTNG_DOMAIN_UST
,
2991 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2992 if (cmd_ret
!= LTTNG_OK
) {
2993 ret
= - (int) cmd_ret
;
2994 ERR("Failed to add channel to notification thread");
2995 goto error_remove_from_registry
;
2998 error_remove_from_registry
:
3000 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3005 session_put(session
);
3011 * From an already allocated ust app channel, create the channel buffers if
3012 * needed and send them to the application. This MUST be called with a RCU read
3013 * side lock acquired.
3015 * Called with UST app session lock held.
3017 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3018 * the application exited concurrently.
3020 static int ust_app_channel_send(struct ust_app
*app
,
3021 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3022 struct ust_app_channel
*ua_chan
)
3028 assert(usess
->active
);
3032 /* Handle buffer type before sending the channel to the application. */
3033 switch (usess
->buffer_type
) {
3034 case LTTNG_BUFFER_PER_UID
:
3036 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3042 case LTTNG_BUFFER_PER_PID
:
3044 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3056 /* Initialize ust objd object using the received handle and add it. */
3057 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3058 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3060 /* If channel is not enabled, disable it on the tracer */
3061 if (!ua_chan
->enabled
) {
3062 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3073 * Create UST app channel and return it through ua_chanp if not NULL.
3075 * Called with UST app session lock and RCU read-side lock held.
3077 * Return 0 on success or else a negative value.
3079 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3080 struct ltt_ust_channel
*uchan
,
3081 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3082 struct ust_app_channel
**ua_chanp
)
3085 struct lttng_ht_iter iter
;
3086 struct lttng_ht_node_str
*ua_chan_node
;
3087 struct ust_app_channel
*ua_chan
;
3089 /* Lookup channel in the ust app session */
3090 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3091 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3092 if (ua_chan_node
!= NULL
) {
3093 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3097 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3098 if (ua_chan
== NULL
) {
3099 /* Only malloc can fail here */
3103 shadow_copy_channel(ua_chan
, uchan
);
3105 /* Set channel type. */
3106 ua_chan
->attr
.type
= type
;
3108 /* Only add the channel if successful on the tracer side. */
3109 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3112 *ua_chanp
= ua_chan
;
3115 /* Everything went well. */
3123 * Create UST app event and create it on the tracer side.
3125 * Called with ust app session mutex held.
3128 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3129 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3130 struct ust_app
*app
)
3133 struct ust_app_event
*ua_event
;
3135 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3136 if (ua_event
== NULL
) {
3137 /* Only failure mode of alloc_ust_app_event(). */
3141 shadow_copy_event(ua_event
, uevent
);
3143 /* Create it on the tracer side */
3144 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3147 * Not found previously means that it does not exist on the
3148 * tracer. If the application reports that the event existed,
3149 * it means there is a bug in the sessiond or lttng-ust
3150 * (or corruption, etc.)
3152 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3153 ERR("Tracer for application reported that an event being created already existed: "
3154 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3156 app
->pid
, app
->ppid
, app
->uid
,
3162 add_unique_ust_app_event(ua_chan
, ua_event
);
3164 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3171 /* Valid. Calling here is already in a read side lock */
3172 delete_ust_app_event(-1, ua_event
, app
);
3177 * Create UST metadata and open it on the tracer side.
3179 * Called with UST app session lock held and RCU read side lock.
3181 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3182 struct ust_app
*app
, struct consumer_output
*consumer
)
3185 struct ust_app_channel
*metadata
;
3186 struct consumer_socket
*socket
;
3187 struct ust_registry_session
*registry
;
3188 struct ltt_session
*session
= NULL
;
3194 registry
= get_session_registry(ua_sess
);
3195 /* The UST app session is held registry shall not be null. */
3198 pthread_mutex_lock(®istry
->lock
);
3200 /* Metadata already exists for this registry or it was closed previously */
3201 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3206 /* Allocate UST metadata */
3207 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3209 /* malloc() failed */
3214 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3216 /* Need one fd for the channel. */
3217 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3219 ERR("Exhausted number of available FD upon create metadata");
3223 /* Get the right consumer socket for the application. */
3224 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3227 goto error_consumer
;
3231 * Keep metadata key so we can identify it on the consumer side. Assign it
3232 * to the registry *before* we ask the consumer so we avoid the race of the
3233 * consumer requesting the metadata and the ask_channel call on our side
3234 * did not returned yet.
3236 registry
->metadata_key
= metadata
->key
;
3238 session
= session_find_by_id(ua_sess
->tracing_id
);
3241 assert(pthread_mutex_trylock(&session
->lock
));
3242 assert(session_trylock_list());
3245 * Ask the metadata channel creation to the consumer. The metadata object
3246 * will be created by the consumer and kept their. However, the stream is
3247 * never added or monitored until we do a first push metadata to the
3250 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3251 registry
, session
->current_trace_chunk
);
3253 /* Nullify the metadata key so we don't try to close it later on. */
3254 registry
->metadata_key
= 0;
3255 goto error_consumer
;
3259 * The setup command will make the metadata stream be sent to the relayd,
3260 * if applicable, and the thread managing the metadatas. This is important
3261 * because after this point, if an error occurs, the only way the stream
3262 * can be deleted is to be monitored in the consumer.
3264 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3266 /* Nullify the metadata key so we don't try to close it later on. */
3267 registry
->metadata_key
= 0;
3268 goto error_consumer
;
3271 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3272 metadata
->key
, app
->pid
);
3275 lttng_fd_put(LTTNG_FD_APPS
, 1);
3276 delete_ust_app_channel(-1, metadata
, app
);
3278 pthread_mutex_unlock(®istry
->lock
);
3280 session_put(session
);
3286 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3287 * acquired before calling this function.
3289 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3291 struct ust_app
*app
= NULL
;
3292 struct lttng_ht_node_ulong
*node
;
3293 struct lttng_ht_iter iter
;
3295 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3296 node
= lttng_ht_iter_get_node_ulong(&iter
);
3298 DBG2("UST app no found with pid %d", pid
);
3302 DBG2("Found UST app by pid %d", pid
);
3304 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3311 * Allocate and init an UST app object using the registration information and
3312 * the command socket. This is called when the command socket connects to the
3315 * The object is returned on success or else NULL.
3317 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3319 struct ust_app
*lta
= NULL
;
3324 DBG3("UST app creating application for socket %d", sock
);
3326 if ((msg
->bits_per_long
== 64 &&
3327 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3328 || (msg
->bits_per_long
== 32 &&
3329 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3330 ERR("Registration failed: application \"%s\" (pid: %d) has "
3331 "%d-bit long, but no consumerd for this size is available.\n",
3332 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3336 lta
= zmalloc(sizeof(struct ust_app
));
3342 lta
->ppid
= msg
->ppid
;
3343 lta
->uid
= msg
->uid
;
3344 lta
->gid
= msg
->gid
;
3346 lta
->bits_per_long
= msg
->bits_per_long
;
3347 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3348 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3349 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3350 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3351 lta
->long_alignment
= msg
->long_alignment
;
3352 lta
->byte_order
= msg
->byte_order
;
3354 lta
->v_major
= msg
->major
;
3355 lta
->v_minor
= msg
->minor
;
3356 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3357 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3358 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3359 lta
->notify_sock
= -1;
3361 /* Copy name and make sure it's NULL terminated. */
3362 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3363 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3366 * Before this can be called, when receiving the registration information,
3367 * the application compatibility is checked. So, at this point, the
3368 * application can work with this session daemon.
3370 lta
->compatible
= 1;
3372 lta
->pid
= msg
->pid
;
3373 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3375 pthread_mutex_init(<a
->sock_lock
, NULL
);
3376 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3378 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3384 * For a given application object, add it to every hash table.
3386 void ust_app_add(struct ust_app
*app
)
3389 assert(app
->notify_sock
>= 0);
3391 app
->registration_time
= time(NULL
);
3396 * On a re-registration, we want to kick out the previous registration of
3399 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3402 * The socket _should_ be unique until _we_ call close. So, a add_unique
3403 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3404 * already in the table.
3406 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3408 /* Add application to the notify socket hash table. */
3409 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3410 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3412 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3413 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3414 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3421 * Set the application version into the object.
3423 * Return 0 on success else a negative value either an errno code or a
3424 * LTTng-UST error code.
3426 int ust_app_version(struct ust_app
*app
)
3432 pthread_mutex_lock(&app
->sock_lock
);
3433 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3434 pthread_mutex_unlock(&app
->sock_lock
);
3436 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3437 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3439 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3447 * Unregister app by removing it from the global traceable app list and freeing
3450 * The socket is already closed at this point so no close to sock.
3452 void ust_app_unregister(int sock
)
3454 struct ust_app
*lta
;
3455 struct lttng_ht_node_ulong
*node
;
3456 struct lttng_ht_iter ust_app_sock_iter
;
3457 struct lttng_ht_iter iter
;
3458 struct ust_app_session
*ua_sess
;
3463 /* Get the node reference for a call_rcu */
3464 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3465 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3468 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3469 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3472 * For per-PID buffers, perform "push metadata" and flush all
3473 * application streams before removing app from hash tables,
3474 * ensuring proper behavior of data_pending check.
3475 * Remove sessions so they are not visible during deletion.
3477 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3479 struct ust_registry_session
*registry
;
3481 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3483 /* The session was already removed so scheduled for teardown. */
3487 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3488 (void) ust_app_flush_app_session(lta
, ua_sess
);
3492 * Add session to list for teardown. This is safe since at this point we
3493 * are the only one using this list.
3495 pthread_mutex_lock(&ua_sess
->lock
);
3497 if (ua_sess
->deleted
) {
3498 pthread_mutex_unlock(&ua_sess
->lock
);
3503 * Normally, this is done in the delete session process which is
3504 * executed in the call rcu below. However, upon registration we can't
3505 * afford to wait for the grace period before pushing data or else the
3506 * data pending feature can race between the unregistration and stop
3507 * command where the data pending command is sent *before* the grace
3510 * The close metadata below nullifies the metadata pointer in the
3511 * session so the delete session will NOT push/close a second time.
3513 registry
= get_session_registry(ua_sess
);
3515 /* Push metadata for application before freeing the application. */
3516 (void) push_metadata(registry
, ua_sess
->consumer
);
3519 * Don't ask to close metadata for global per UID buffers. Close
3520 * metadata only on destroy trace session in this case. Also, the
3521 * previous push metadata could have flag the metadata registry to
3522 * close so don't send a close command if closed.
3524 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3525 /* And ask to close it for this session registry. */
3526 (void) close_metadata(registry
, ua_sess
->consumer
);
3529 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3531 pthread_mutex_unlock(&ua_sess
->lock
);
3534 /* Remove application from PID hash table */
3535 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3539 * Remove application from notify hash table. The thread handling the
3540 * notify socket could have deleted the node so ignore on error because
3541 * either way it's valid. The close of that socket is handled by the
3542 * apps_notify_thread.
3544 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3545 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3548 * Ignore return value since the node might have been removed before by an
3549 * add replace during app registration because the PID can be reassigned by
3552 iter
.iter
.node
= <a
->pid_n
.node
;
3553 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3555 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3560 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3567 * Fill events array with all events name of all registered apps.
3569 int ust_app_list_events(struct lttng_event
**events
)
3572 size_t nbmem
, count
= 0;
3573 struct lttng_ht_iter iter
;
3574 struct ust_app
*app
;
3575 struct lttng_event
*tmp_event
;
3577 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3578 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3579 if (tmp_event
== NULL
) {
3580 PERROR("zmalloc ust app events");
3587 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3588 struct lttng_ust_tracepoint_iter uiter
;
3590 health_code_update();
3592 if (!app
->compatible
) {
3594 * TODO: In time, we should notice the caller of this error by
3595 * telling him that this is a version error.
3599 pthread_mutex_lock(&app
->sock_lock
);
3600 handle
= ustctl_tracepoint_list(app
->sock
);
3602 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3603 ERR("UST app list events getting handle failed for app pid %d",
3606 pthread_mutex_unlock(&app
->sock_lock
);
3610 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3611 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3612 /* Handle ustctl error. */
3616 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3617 ERR("UST app tp list get failed for app %d with ret %d",
3620 DBG3("UST app tp list get failed. Application is dead");
3622 * This is normal behavior, an application can die during the
3623 * creation process. Don't report an error so the execution can
3624 * continue normally. Continue normal execution.
3629 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3630 if (release_ret
< 0 &&
3631 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3632 release_ret
!= -EPIPE
) {
3633 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3635 pthread_mutex_unlock(&app
->sock_lock
);
3639 health_code_update();
3640 if (count
>= nbmem
) {
3641 /* In case the realloc fails, we free the memory */
3642 struct lttng_event
*new_tmp_event
;
3645 new_nbmem
= nbmem
<< 1;
3646 DBG2("Reallocating event list from %zu to %zu entries",
3648 new_tmp_event
= realloc(tmp_event
,
3649 new_nbmem
* sizeof(struct lttng_event
));
3650 if (new_tmp_event
== NULL
) {
3653 PERROR("realloc ust app events");
3656 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3657 if (release_ret
< 0 &&
3658 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3659 release_ret
!= -EPIPE
) {
3660 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3662 pthread_mutex_unlock(&app
->sock_lock
);
3665 /* Zero the new memory */
3666 memset(new_tmp_event
+ nbmem
, 0,
3667 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3669 tmp_event
= new_tmp_event
;
3671 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3672 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3673 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3674 tmp_event
[count
].pid
= app
->pid
;
3675 tmp_event
[count
].enabled
= -1;
3678 ret
= ustctl_release_handle(app
->sock
, handle
);
3679 pthread_mutex_unlock(&app
->sock_lock
);
3680 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3681 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3686 *events
= tmp_event
;
3688 DBG2("UST app list events done (%zu events)", count
);
3693 health_code_update();
3698 * Fill events array with all events name of all registered apps.
3700 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3703 size_t nbmem
, count
= 0;
3704 struct lttng_ht_iter iter
;
3705 struct ust_app
*app
;
3706 struct lttng_event_field
*tmp_event
;
3708 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3709 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3710 if (tmp_event
== NULL
) {
3711 PERROR("zmalloc ust app event fields");
3718 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3719 struct lttng_ust_field_iter uiter
;
3721 health_code_update();
3723 if (!app
->compatible
) {
3725 * TODO: In time, we should notice the caller of this error by
3726 * telling him that this is a version error.
3730 pthread_mutex_lock(&app
->sock_lock
);
3731 handle
= ustctl_tracepoint_field_list(app
->sock
);
3733 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3734 ERR("UST app list field getting handle failed for app pid %d",
3737 pthread_mutex_unlock(&app
->sock_lock
);
3741 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3742 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3743 /* Handle ustctl error. */
3747 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3748 ERR("UST app tp list field failed for app %d with ret %d",
3751 DBG3("UST app tp list field failed. Application is dead");
3753 * This is normal behavior, an application can die during the
3754 * creation process. Don't report an error so the execution can
3755 * continue normally. Reset list and count for next app.
3760 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3761 pthread_mutex_unlock(&app
->sock_lock
);
3762 if (release_ret
< 0 &&
3763 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3764 release_ret
!= -EPIPE
) {
3765 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3770 health_code_update();
3771 if (count
>= nbmem
) {
3772 /* In case the realloc fails, we free the memory */
3773 struct lttng_event_field
*new_tmp_event
;
3776 new_nbmem
= nbmem
<< 1;
3777 DBG2("Reallocating event field list from %zu to %zu entries",
3779 new_tmp_event
= realloc(tmp_event
,
3780 new_nbmem
* sizeof(struct lttng_event_field
));
3781 if (new_tmp_event
== NULL
) {
3784 PERROR("realloc ust app event fields");
3787 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3788 pthread_mutex_unlock(&app
->sock_lock
);
3790 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3791 release_ret
!= -EPIPE
) {
3792 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3796 /* Zero the new memory */
3797 memset(new_tmp_event
+ nbmem
, 0,
3798 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3800 tmp_event
= new_tmp_event
;
3803 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3804 /* Mapping between these enums matches 1 to 1. */
3805 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3806 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3808 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3809 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3810 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3811 tmp_event
[count
].event
.pid
= app
->pid
;
3812 tmp_event
[count
].event
.enabled
= -1;
3815 ret
= ustctl_release_handle(app
->sock
, handle
);
3816 pthread_mutex_unlock(&app
->sock_lock
);
3818 ret
!= -LTTNG_UST_ERR_EXITING
&&
3820 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3825 *fields
= tmp_event
;
3827 DBG2("UST app list event fields done (%zu events)", count
);
3832 health_code_update();
3837 * Free and clean all traceable apps of the global list.
3839 * Should _NOT_ be called with RCU read-side lock held.
3841 void ust_app_clean_list(void)
3844 struct ust_app
*app
;
3845 struct lttng_ht_iter iter
;
3847 DBG2("UST app cleaning registered apps hash table");
3851 /* Cleanup notify socket hash table */
3852 if (ust_app_ht_by_notify_sock
) {
3853 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3854 notify_sock_n
.node
) {
3855 struct cds_lfht_node
*node
;
3856 struct ust_app
*app
;
3858 node
= cds_lfht_iter_get_node(&iter
.iter
);
3863 app
= container_of(node
, struct ust_app
,
3864 notify_sock_n
.node
);
3865 ust_app_notify_sock_unregister(app
->notify_sock
);
3870 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3871 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3873 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3877 /* Cleanup socket hash table */
3878 if (ust_app_ht_by_sock
) {
3879 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3881 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3888 /* Destroy is done only when the ht is empty */
3890 ht_cleanup_push(ust_app_ht
);
3892 if (ust_app_ht_by_sock
) {
3893 ht_cleanup_push(ust_app_ht_by_sock
);
3895 if (ust_app_ht_by_notify_sock
) {
3896 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3901 * Init UST app hash table.
3903 int ust_app_ht_alloc(void)
3905 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3909 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3910 if (!ust_app_ht_by_sock
) {
3913 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3914 if (!ust_app_ht_by_notify_sock
) {
3921 * For a specific UST session, disable the channel for all registered apps.
3923 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3924 struct ltt_ust_channel
*uchan
)
3927 struct lttng_ht_iter iter
;
3928 struct lttng_ht_node_str
*ua_chan_node
;
3929 struct ust_app
*app
;
3930 struct ust_app_session
*ua_sess
;
3931 struct ust_app_channel
*ua_chan
;
3933 assert(usess
->active
);
3934 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3935 uchan
->name
, usess
->id
);
3939 /* For every registered applications */
3940 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3941 struct lttng_ht_iter uiter
;
3942 if (!app
->compatible
) {
3944 * TODO: In time, we should notice the caller of this error by
3945 * telling him that this is a version error.
3949 ua_sess
= lookup_session_by_app(usess
, app
);
3950 if (ua_sess
== NULL
) {
3955 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3956 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3957 /* If the session if found for the app, the channel must be there */
3958 assert(ua_chan_node
);
3960 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3961 /* The channel must not be already disabled */
3962 assert(ua_chan
->enabled
== 1);
3964 /* Disable channel onto application */
3965 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3967 /* XXX: We might want to report this error at some point... */
3977 * For a specific UST session, enable the channel for all registered apps.
3979 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3980 struct ltt_ust_channel
*uchan
)
3983 struct lttng_ht_iter iter
;
3984 struct ust_app
*app
;
3985 struct ust_app_session
*ua_sess
;
3987 assert(usess
->active
);
3988 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3989 uchan
->name
, usess
->id
);
3993 /* For every registered applications */
3994 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3995 if (!app
->compatible
) {
3997 * TODO: In time, we should notice the caller of this error by
3998 * telling him that this is a version error.
4002 ua_sess
= lookup_session_by_app(usess
, app
);
4003 if (ua_sess
== NULL
) {
4007 /* Enable channel onto application */
4008 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4010 /* XXX: We might want to report this error at some point... */
4020 * Disable an event in a channel and for a specific session.
4022 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4023 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4026 struct lttng_ht_iter iter
, uiter
;
4027 struct lttng_ht_node_str
*ua_chan_node
;
4028 struct ust_app
*app
;
4029 struct ust_app_session
*ua_sess
;
4030 struct ust_app_channel
*ua_chan
;
4031 struct ust_app_event
*ua_event
;
4033 assert(usess
->active
);
4034 DBG("UST app disabling event %s for all apps in channel "
4035 "%s for session id %" PRIu64
,
4036 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4040 /* For all registered applications */
4041 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4042 if (!app
->compatible
) {
4044 * TODO: In time, we should notice the caller of this error by
4045 * telling him that this is a version error.
4049 ua_sess
= lookup_session_by_app(usess
, app
);
4050 if (ua_sess
== NULL
) {
4055 /* Lookup channel in the ust app session */
4056 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4057 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4058 if (ua_chan_node
== NULL
) {
4059 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4060 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4063 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4065 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4066 uevent
->filter
, uevent
->attr
.loglevel
,
4068 if (ua_event
== NULL
) {
4069 DBG2("Event %s not found in channel %s for app pid %d."
4070 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4074 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4076 /* XXX: Report error someday... */
4085 /* The ua_sess lock must be held by the caller. */
4087 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4088 struct ust_app_session
*ua_sess
,
4089 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4090 struct ust_app_channel
**_ua_chan
)
4093 struct ust_app_channel
*ua_chan
= NULL
;
4096 ASSERT_LOCKED(ua_sess
->lock
);
4098 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4099 sizeof(uchan
->name
))) {
4100 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4104 struct ltt_ust_context
*uctx
= NULL
;
4107 * Create channel onto application and synchronize its
4110 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4111 LTTNG_UST_CHAN_PER_CPU
, usess
,
4117 ret
= ust_app_channel_send(app
, usess
,
4124 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4125 ret
= create_ust_app_channel_context(ua_chan
,
4138 * The application's socket is not valid. Either a bad socket
4139 * or a timeout on it. We can't inform the caller that for a
4140 * specific app, the session failed so lets continue here.
4142 ret
= 0; /* Not an error. */
4150 if (ret
== 0 && _ua_chan
) {
4152 * Only return the application's channel on success. Note
4153 * that the channel can still be part of the application's
4154 * channel hashtable on error.
4156 *_ua_chan
= ua_chan
;
4162 * Enable event for a specific session and channel on the tracer.
4164 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4165 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4168 struct lttng_ht_iter iter
, uiter
;
4169 struct lttng_ht_node_str
*ua_chan_node
;
4170 struct ust_app
*app
;
4171 struct ust_app_session
*ua_sess
;
4172 struct ust_app_channel
*ua_chan
;
4173 struct ust_app_event
*ua_event
;
4175 assert(usess
->active
);
4176 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4177 uevent
->attr
.name
, usess
->id
);
4180 * NOTE: At this point, this function is called only if the session and
4181 * channel passed are already created for all apps. and enabled on the
4187 /* For all registered applications */
4188 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4189 if (!app
->compatible
) {
4191 * TODO: In time, we should notice the caller of this error by
4192 * telling him that this is a version error.
4196 ua_sess
= lookup_session_by_app(usess
, app
);
4198 /* The application has problem or is probably dead. */
4202 pthread_mutex_lock(&ua_sess
->lock
);
4204 if (ua_sess
->deleted
) {
4205 pthread_mutex_unlock(&ua_sess
->lock
);
4209 /* Lookup channel in the ust app session */
4210 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4211 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4213 * It is possible that the channel cannot be found is
4214 * the channel/event creation occurs concurrently with
4215 * an application exit.
4217 if (!ua_chan_node
) {
4218 pthread_mutex_unlock(&ua_sess
->lock
);
4222 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4224 /* Get event node */
4225 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4226 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4227 if (ua_event
== NULL
) {
4228 DBG3("UST app enable event %s not found for app PID %d."
4229 "Skipping app", uevent
->attr
.name
, app
->pid
);
4233 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4235 pthread_mutex_unlock(&ua_sess
->lock
);
4239 pthread_mutex_unlock(&ua_sess
->lock
);
4248 * For a specific existing UST session and UST channel, creates the event for
4249 * all registered apps.
4251 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4252 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4255 struct lttng_ht_iter iter
, uiter
;
4256 struct lttng_ht_node_str
*ua_chan_node
;
4257 struct ust_app
*app
;
4258 struct ust_app_session
*ua_sess
;
4259 struct ust_app_channel
*ua_chan
;
4261 assert(usess
->active
);
4262 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4263 uevent
->attr
.name
, usess
->id
);
4267 /* For all registered applications */
4268 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4269 if (!app
->compatible
) {
4271 * TODO: In time, we should notice the caller of this error by
4272 * telling him that this is a version error.
4276 ua_sess
= lookup_session_by_app(usess
, app
);
4278 /* The application has problem or is probably dead. */
4282 pthread_mutex_lock(&ua_sess
->lock
);
4284 if (ua_sess
->deleted
) {
4285 pthread_mutex_unlock(&ua_sess
->lock
);
4289 /* Lookup channel in the ust app session */
4290 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4291 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4292 /* If the channel is not found, there is a code flow error */
4293 assert(ua_chan_node
);
4295 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4297 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4298 pthread_mutex_unlock(&ua_sess
->lock
);
4300 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4301 /* Possible value at this point: -ENOMEM. If so, we stop! */
4304 DBG2("UST app event %s already exist on app PID %d",
4305 uevent
->attr
.name
, app
->pid
);
4315 * Start tracing for a specific UST session and app.
4317 * Called with UST app session lock held.
4321 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4324 struct ust_app_session
*ua_sess
;
4326 DBG("Starting tracing for ust app pid %d", app
->pid
);
4330 if (!app
->compatible
) {
4334 ua_sess
= lookup_session_by_app(usess
, app
);
4335 if (ua_sess
== NULL
) {
4336 /* The session is in teardown process. Ignore and continue. */
4340 pthread_mutex_lock(&ua_sess
->lock
);
4342 if (ua_sess
->deleted
) {
4343 pthread_mutex_unlock(&ua_sess
->lock
);
4347 if (ua_sess
->enabled
) {
4348 pthread_mutex_unlock(&ua_sess
->lock
);
4352 /* Upon restart, we skip the setup, already done */
4353 if (ua_sess
->started
) {
4357 health_code_update();
4360 /* This starts the UST tracing */
4361 pthread_mutex_lock(&app
->sock_lock
);
4362 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4363 pthread_mutex_unlock(&app
->sock_lock
);
4365 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4366 ERR("Error starting tracing for app pid: %d (ret: %d)",
4369 DBG("UST app start session failed. Application is dead.");
4371 * This is normal behavior, an application can die during the
4372 * creation process. Don't report an error so the execution can
4373 * continue normally.
4375 pthread_mutex_unlock(&ua_sess
->lock
);
4381 /* Indicate that the session has been started once */
4382 ua_sess
->started
= 1;
4383 ua_sess
->enabled
= 1;
4385 pthread_mutex_unlock(&ua_sess
->lock
);
4387 health_code_update();
4389 /* Quiescent wait after starting trace */
4390 pthread_mutex_lock(&app
->sock_lock
);
4391 ret
= ustctl_wait_quiescent(app
->sock
);
4392 pthread_mutex_unlock(&app
->sock_lock
);
4393 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4394 ERR("UST app wait quiescent failed for app pid %d ret %d",
4400 health_code_update();
4404 pthread_mutex_unlock(&ua_sess
->lock
);
4406 health_code_update();
4411 * Stop tracing for a specific UST session and app.
4414 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4417 struct ust_app_session
*ua_sess
;
4418 struct ust_registry_session
*registry
;
4420 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4424 if (!app
->compatible
) {
4425 goto end_no_session
;
4428 ua_sess
= lookup_session_by_app(usess
, app
);
4429 if (ua_sess
== NULL
) {
4430 goto end_no_session
;
4433 pthread_mutex_lock(&ua_sess
->lock
);
4435 if (ua_sess
->deleted
) {
4436 pthread_mutex_unlock(&ua_sess
->lock
);
4437 goto end_no_session
;
4441 * If started = 0, it means that stop trace has been called for a session
4442 * that was never started. It's possible since we can have a fail start
4443 * from either the application manager thread or the command thread. Simply
4444 * indicate that this is a stop error.
4446 if (!ua_sess
->started
) {
4447 goto error_rcu_unlock
;
4450 health_code_update();
4452 /* This inhibits UST tracing */
4453 pthread_mutex_lock(&app
->sock_lock
);
4454 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4455 pthread_mutex_unlock(&app
->sock_lock
);
4457 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4458 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4461 DBG("UST app stop session failed. Application is dead.");
4463 * This is normal behavior, an application can die during the
4464 * creation process. Don't report an error so the execution can
4465 * continue normally.
4469 goto error_rcu_unlock
;
4472 health_code_update();
4473 ua_sess
->enabled
= 0;
4475 /* Quiescent wait after stopping trace */
4476 pthread_mutex_lock(&app
->sock_lock
);
4477 ret
= ustctl_wait_quiescent(app
->sock
);
4478 pthread_mutex_unlock(&app
->sock_lock
);
4479 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4480 ERR("UST app wait quiescent failed for app pid %d ret %d",
4484 health_code_update();
4486 registry
= get_session_registry(ua_sess
);
4488 /* The UST app session is held registry shall not be null. */
4491 /* Push metadata for application before freeing the application. */
4492 (void) push_metadata(registry
, ua_sess
->consumer
);
4495 pthread_mutex_unlock(&ua_sess
->lock
);
4498 health_code_update();
4502 pthread_mutex_unlock(&ua_sess
->lock
);
4504 health_code_update();
4509 int ust_app_flush_app_session(struct ust_app
*app
,
4510 struct ust_app_session
*ua_sess
)
4512 int ret
, retval
= 0;
4513 struct lttng_ht_iter iter
;
4514 struct ust_app_channel
*ua_chan
;
4515 struct consumer_socket
*socket
;
4517 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4521 if (!app
->compatible
) {
4522 goto end_not_compatible
;
4525 pthread_mutex_lock(&ua_sess
->lock
);
4527 if (ua_sess
->deleted
) {
4531 health_code_update();
4533 /* Flushing buffers */
4534 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4537 /* Flush buffers and push metadata. */
4538 switch (ua_sess
->buffer_type
) {
4539 case LTTNG_BUFFER_PER_PID
:
4540 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4542 health_code_update();
4543 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4545 ERR("Error flushing consumer channel");
4551 case LTTNG_BUFFER_PER_UID
:
4557 health_code_update();
4560 pthread_mutex_unlock(&ua_sess
->lock
);
4564 health_code_update();
4569 * Flush buffers for all applications for a specific UST session.
4570 * Called with UST session lock held.
4573 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4578 DBG("Flushing session buffers for all ust apps");
4582 /* Flush buffers and push metadata. */
4583 switch (usess
->buffer_type
) {
4584 case LTTNG_BUFFER_PER_UID
:
4586 struct buffer_reg_uid
*reg
;
4587 struct lttng_ht_iter iter
;
4589 /* Flush all per UID buffers associated to that session. */
4590 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4591 struct ust_registry_session
*ust_session_reg
;
4592 struct buffer_reg_channel
*reg_chan
;
4593 struct consumer_socket
*socket
;
4595 /* Get consumer socket to use to push the metadata.*/
4596 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4599 /* Ignore request if no consumer is found for the session. */
4603 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4604 reg_chan
, node
.node
) {
4606 * The following call will print error values so the return
4607 * code is of little importance because whatever happens, we
4608 * have to try them all.
4610 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4613 ust_session_reg
= reg
->registry
->reg
.ust
;
4614 /* Push metadata. */
4615 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4619 case LTTNG_BUFFER_PER_PID
:
4621 struct ust_app_session
*ua_sess
;
4622 struct lttng_ht_iter iter
;
4623 struct ust_app
*app
;
4625 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4626 ua_sess
= lookup_session_by_app(usess
, app
);
4627 if (ua_sess
== NULL
) {
4630 (void) ust_app_flush_app_session(app
, ua_sess
);
4641 health_code_update();
4646 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
4647 struct ust_app_session
*ua_sess
)
4650 struct lttng_ht_iter iter
;
4651 struct ust_app_channel
*ua_chan
;
4652 struct consumer_socket
*socket
;
4654 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
4658 if (!app
->compatible
) {
4659 goto end_not_compatible
;
4662 pthread_mutex_lock(&ua_sess
->lock
);
4664 if (ua_sess
->deleted
) {
4668 health_code_update();
4670 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4673 ERR("Failed to find consumer (%" PRIu32
") socket",
4674 app
->bits_per_long
);
4679 /* Clear quiescent state. */
4680 switch (ua_sess
->buffer_type
) {
4681 case LTTNG_BUFFER_PER_PID
:
4682 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
4683 ua_chan
, node
.node
) {
4684 health_code_update();
4685 ret
= consumer_clear_quiescent_channel(socket
,
4688 ERR("Error clearing quiescent state for consumer channel");
4694 case LTTNG_BUFFER_PER_UID
:
4701 health_code_update();
4704 pthread_mutex_unlock(&ua_sess
->lock
);
4708 health_code_update();
4713 * Clear quiescent state in each stream for all applications for a
4714 * specific UST session.
4715 * Called with UST session lock held.
4718 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
4723 DBG("Clearing stream quiescent state for all ust apps");
4727 switch (usess
->buffer_type
) {
4728 case LTTNG_BUFFER_PER_UID
:
4730 struct lttng_ht_iter iter
;
4731 struct buffer_reg_uid
*reg
;
4734 * Clear quiescent for all per UID buffers associated to
4737 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4738 struct consumer_socket
*socket
;
4739 struct buffer_reg_channel
*reg_chan
;
4741 /* Get associated consumer socket.*/
4742 socket
= consumer_find_socket_by_bitness(
4743 reg
->bits_per_long
, usess
->consumer
);
4746 * Ignore request if no consumer is found for
4752 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
4753 &iter
.iter
, reg_chan
, node
.node
) {
4755 * The following call will print error values so
4756 * the return code is of little importance
4757 * because whatever happens, we have to try them
4760 (void) consumer_clear_quiescent_channel(socket
,
4761 reg_chan
->consumer_key
);
4766 case LTTNG_BUFFER_PER_PID
:
4768 struct ust_app_session
*ua_sess
;
4769 struct lttng_ht_iter iter
;
4770 struct ust_app
*app
;
4772 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
4774 ua_sess
= lookup_session_by_app(usess
, app
);
4775 if (ua_sess
== NULL
) {
4778 (void) ust_app_clear_quiescent_app_session(app
,
4790 health_code_update();
4795 * Destroy a specific UST session in apps.
4797 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4800 struct ust_app_session
*ua_sess
;
4801 struct lttng_ht_iter iter
;
4802 struct lttng_ht_node_u64
*node
;
4804 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4808 if (!app
->compatible
) {
4812 __lookup_session_by_app(usess
, app
, &iter
);
4813 node
= lttng_ht_iter_get_node_u64(&iter
);
4815 /* Session is being or is deleted. */
4818 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4820 health_code_update();
4821 destroy_app_session(app
, ua_sess
);
4823 health_code_update();
4825 /* Quiescent wait after stopping trace */
4826 pthread_mutex_lock(&app
->sock_lock
);
4827 ret
= ustctl_wait_quiescent(app
->sock
);
4828 pthread_mutex_unlock(&app
->sock_lock
);
4829 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4830 ERR("UST app wait quiescent failed for app pid %d ret %d",
4835 health_code_update();
4840 * Start tracing for the UST session.
4842 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4844 struct lttng_ht_iter iter
;
4845 struct ust_app
*app
;
4847 DBG("Starting all UST traces");
4850 * Even though the start trace might fail, flag this session active so
4851 * other application coming in are started by default.
4858 * In a start-stop-start use-case, we need to clear the quiescent state
4859 * of each channel set by the prior stop command, thus ensuring that a
4860 * following stop or destroy is sure to grab a timestamp_end near those
4861 * operations, even if the packet is empty.
4863 (void) ust_app_clear_quiescent_session(usess
);
4865 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4866 ust_app_global_update(usess
, app
);
4875 * Start tracing for the UST session.
4876 * Called with UST session lock held.
4878 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4881 struct lttng_ht_iter iter
;
4882 struct ust_app
*app
;
4884 DBG("Stopping all UST traces");
4887 * Even though the stop trace might fail, flag this session inactive so
4888 * other application coming in are not started by default.
4894 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4895 ret
= ust_app_stop_trace(usess
, app
);
4897 /* Continue to next apps even on error */
4902 (void) ust_app_flush_session(usess
);
4910 * Destroy app UST session.
4912 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4915 struct lttng_ht_iter iter
;
4916 struct ust_app
*app
;
4918 DBG("Destroy all UST traces");
4922 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4923 ret
= destroy_trace(usess
, app
);
4925 /* Continue to next apps even on error */
4935 /* The ua_sess lock must be held by the caller. */
4937 int find_or_create_ust_app_channel(
4938 struct ltt_ust_session
*usess
,
4939 struct ust_app_session
*ua_sess
,
4940 struct ust_app
*app
,
4941 struct ltt_ust_channel
*uchan
,
4942 struct ust_app_channel
**ua_chan
)
4945 struct lttng_ht_iter iter
;
4946 struct lttng_ht_node_str
*ua_chan_node
;
4948 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
4949 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4951 *ua_chan
= caa_container_of(ua_chan_node
,
4952 struct ust_app_channel
, node
);
4956 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
4965 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
4966 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
4967 struct ust_app
*app
)
4970 struct ust_app_event
*ua_event
= NULL
;
4972 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4973 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4975 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4980 if (ua_event
->enabled
!= uevent
->enabled
) {
4981 ret
= uevent
->enabled
?
4982 enable_ust_app_event(ua_sess
, ua_event
, app
) :
4983 disable_ust_app_event(ua_sess
, ua_event
, app
);
4992 * The caller must ensure that the application is compatible and is tracked
4993 * by the process attribute trackers.
4996 void ust_app_synchronize(struct ltt_ust_session
*usess
,
4997 struct ust_app
*app
)
5000 struct cds_lfht_iter uchan_iter
;
5001 struct ltt_ust_channel
*uchan
;
5002 struct ust_app_session
*ua_sess
= NULL
;
5005 * The application's configuration should only be synchronized for
5008 assert(usess
->active
);
5010 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5012 /* Tracer is probably gone or ENOMEM. */
5017 pthread_mutex_lock(&ua_sess
->lock
);
5018 if (ua_sess
->deleted
) {
5019 pthread_mutex_unlock(&ua_sess
->lock
);
5025 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5027 struct ust_app_channel
*ua_chan
;
5028 struct cds_lfht_iter uevent_iter
;
5029 struct ltt_ust_event
*uevent
;
5032 * Search for a matching ust_app_channel. If none is found,
5033 * create it. Creating the channel will cause the ua_chan
5034 * structure to be allocated, the channel buffers to be
5035 * allocated (if necessary) and sent to the application, and
5036 * all enabled contexts will be added to the channel.
5038 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5039 app
, uchan
, &ua_chan
);
5041 /* Tracer is probably gone or ENOMEM. */
5046 /* ua_chan will be NULL for the metadata channel */
5050 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5052 ret
= ust_app_channel_synchronize_event(ua_chan
,
5053 uevent
, ua_sess
, app
);
5059 if (ua_chan
->enabled
!= uchan
->enabled
) {
5060 ret
= uchan
->enabled
?
5061 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5062 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5070 * Create the metadata for the application. This returns gracefully if a
5071 * metadata was already set for the session.
5073 * The metadata channel must be created after the data channels as the
5074 * consumer daemon assumes this ordering. When interacting with a relay
5075 * daemon, the consumer will use this assumption to send the
5076 * "STREAMS_SENT" message to the relay daemon.
5078 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
5086 pthread_mutex_unlock(&ua_sess
->lock
);
5087 /* Everything went well at this point. */
5092 pthread_mutex_unlock(&ua_sess
->lock
);
5095 destroy_app_session(app
, ua_sess
);
5101 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5103 struct ust_app_session
*ua_sess
;
5105 ua_sess
= lookup_session_by_app(usess
, app
);
5106 if (ua_sess
== NULL
) {
5109 destroy_app_session(app
, ua_sess
);
5113 * Add channels/events from UST global domain to registered apps at sock.
5115 * Called with session lock held.
5116 * Called with RCU read-side lock held.
5118 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5121 assert(usess
->active
);
5123 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5124 app
->sock
, usess
->id
);
5126 if (!app
->compatible
) {
5129 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
5131 trace_ust_id_tracker_lookup(
5132 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
5134 trace_ust_id_tracker_lookup(
5135 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
5138 * Synchronize the application's internal tracing configuration
5139 * and start tracing.
5141 ust_app_synchronize(usess
, app
);
5142 ust_app_start_trace(usess
, app
);
5144 ust_app_global_destroy(usess
, app
);
5149 * Called with session lock held.
5151 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5153 struct lttng_ht_iter iter
;
5154 struct ust_app
*app
;
5157 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5158 ust_app_global_update(usess
, app
);
5164 * Add context to a specific channel for global UST domain.
5166 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5167 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5170 struct lttng_ht_node_str
*ua_chan_node
;
5171 struct lttng_ht_iter iter
, uiter
;
5172 struct ust_app_channel
*ua_chan
= NULL
;
5173 struct ust_app_session
*ua_sess
;
5174 struct ust_app
*app
;
5176 assert(usess
->active
);
5179 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5180 if (!app
->compatible
) {
5182 * TODO: In time, we should notice the caller of this error by
5183 * telling him that this is a version error.
5187 ua_sess
= lookup_session_by_app(usess
, app
);
5188 if (ua_sess
== NULL
) {
5192 pthread_mutex_lock(&ua_sess
->lock
);
5194 if (ua_sess
->deleted
) {
5195 pthread_mutex_unlock(&ua_sess
->lock
);
5199 /* Lookup channel in the ust app session */
5200 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5201 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5202 if (ua_chan_node
== NULL
) {
5205 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5207 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5212 pthread_mutex_unlock(&ua_sess
->lock
);
5220 * Receive registration and populate the given msg structure.
5222 * On success return 0 else a negative value returned by the ustctl call.
5224 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5227 uint32_t pid
, ppid
, uid
, gid
;
5231 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5232 &pid
, &ppid
, &uid
, &gid
,
5233 &msg
->bits_per_long
,
5234 &msg
->uint8_t_alignment
,
5235 &msg
->uint16_t_alignment
,
5236 &msg
->uint32_t_alignment
,
5237 &msg
->uint64_t_alignment
,
5238 &msg
->long_alignment
,
5245 case LTTNG_UST_ERR_EXITING
:
5246 DBG3("UST app recv reg message failed. Application died");
5248 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5249 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5250 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5251 LTTNG_UST_ABI_MINOR_VERSION
);
5254 ERR("UST app recv reg message failed with ret %d", ret
);
5259 msg
->pid
= (pid_t
) pid
;
5260 msg
->ppid
= (pid_t
) ppid
;
5261 msg
->uid
= (uid_t
) uid
;
5262 msg
->gid
= (gid_t
) gid
;
5269 * Return a ust app session object using the application object and the
5270 * session object descriptor has a key. If not found, NULL is returned.
5271 * A RCU read side lock MUST be acquired when calling this function.
5273 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5276 struct lttng_ht_node_ulong
*node
;
5277 struct lttng_ht_iter iter
;
5278 struct ust_app_session
*ua_sess
= NULL
;
5282 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5283 node
= lttng_ht_iter_get_node_ulong(&iter
);
5285 DBG2("UST app session find by objd %d not found", objd
);
5289 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5296 * Return a ust app channel object using the application object and the channel
5297 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5298 * lock MUST be acquired before calling this function.
5300 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5303 struct lttng_ht_node_ulong
*node
;
5304 struct lttng_ht_iter iter
;
5305 struct ust_app_channel
*ua_chan
= NULL
;
5309 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5310 node
= lttng_ht_iter_get_node_ulong(&iter
);
5312 DBG2("UST app channel find by objd %d not found", objd
);
5316 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5323 * Reply to a register channel notification from an application on the notify
5324 * socket. The channel metadata is also created.
5326 * The session UST registry lock is acquired in this function.
5328 * On success 0 is returned else a negative value.
5330 static int reply_ust_register_channel(int sock
, int cobjd
,
5331 size_t nr_fields
, struct ustctl_field
*fields
)
5333 int ret
, ret_code
= 0;
5335 uint64_t chan_reg_key
;
5336 enum ustctl_channel_header type
;
5337 struct ust_app
*app
;
5338 struct ust_app_channel
*ua_chan
;
5339 struct ust_app_session
*ua_sess
;
5340 struct ust_registry_session
*registry
;
5341 struct ust_registry_channel
*chan_reg
;
5345 /* Lookup application. If not found, there is a code flow error. */
5346 app
= find_app_by_notify_sock(sock
);
5348 DBG("Application socket %d is being torn down. Abort event notify",
5351 goto error_rcu_unlock
;
5354 /* Lookup channel by UST object descriptor. */
5355 ua_chan
= find_channel_by_objd(app
, cobjd
);
5357 DBG("Application channel is being torn down. Abort event notify");
5359 goto error_rcu_unlock
;
5362 assert(ua_chan
->session
);
5363 ua_sess
= ua_chan
->session
;
5365 /* Get right session registry depending on the session buffer type. */
5366 registry
= get_session_registry(ua_sess
);
5368 DBG("Application session is being torn down. Abort event notify");
5370 goto error_rcu_unlock
;
5373 /* Depending on the buffer type, a different channel key is used. */
5374 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5375 chan_reg_key
= ua_chan
->tracing_channel_id
;
5377 chan_reg_key
= ua_chan
->key
;
5380 pthread_mutex_lock(®istry
->lock
);
5382 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5385 if (!chan_reg
->register_done
) {
5387 * TODO: eventually use the registry event count for
5388 * this channel to better guess header type for per-pid
5391 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5392 chan_reg
->nr_ctx_fields
= nr_fields
;
5393 chan_reg
->ctx_fields
= fields
;
5395 chan_reg
->header_type
= type
;
5397 /* Get current already assigned values. */
5398 type
= chan_reg
->header_type
;
5400 /* Channel id is set during the object creation. */
5401 chan_id
= chan_reg
->chan_id
;
5403 /* Append to metadata */
5404 if (!chan_reg
->metadata_dumped
) {
5405 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5407 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5413 DBG3("UST app replying to register channel key %" PRIu64
5414 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5417 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5419 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5420 ERR("UST app reply channel failed with ret %d", ret
);
5422 DBG3("UST app reply channel failed. Application died");
5427 /* This channel registry registration is completed. */
5428 chan_reg
->register_done
= 1;
5431 pthread_mutex_unlock(®istry
->lock
);
5439 * Add event to the UST channel registry. When the event is added to the
5440 * registry, the metadata is also created. Once done, this replies to the
5441 * application with the appropriate error code.
5443 * The session UST registry lock is acquired in the function.
5445 * On success 0 is returned else a negative value.
5447 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5448 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5449 int loglevel_value
, char *model_emf_uri
)
5452 uint32_t event_id
= 0;
5453 uint64_t chan_reg_key
;
5454 struct ust_app
*app
;
5455 struct ust_app_channel
*ua_chan
;
5456 struct ust_app_session
*ua_sess
;
5457 struct ust_registry_session
*registry
;
5461 /* Lookup application. If not found, there is a code flow error. */
5462 app
= find_app_by_notify_sock(sock
);
5464 DBG("Application socket %d is being torn down. Abort event notify",
5467 goto error_rcu_unlock
;
5470 /* Lookup channel by UST object descriptor. */
5471 ua_chan
= find_channel_by_objd(app
, cobjd
);
5473 DBG("Application channel is being torn down. Abort event notify");
5475 goto error_rcu_unlock
;
5478 assert(ua_chan
->session
);
5479 ua_sess
= ua_chan
->session
;
5481 registry
= get_session_registry(ua_sess
);
5483 DBG("Application session is being torn down. Abort event notify");
5485 goto error_rcu_unlock
;
5488 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5489 chan_reg_key
= ua_chan
->tracing_channel_id
;
5491 chan_reg_key
= ua_chan
->key
;
5494 pthread_mutex_lock(®istry
->lock
);
5497 * From this point on, this call acquires the ownership of the sig, fields
5498 * and model_emf_uri meaning any free are done inside it if needed. These
5499 * three variables MUST NOT be read/write after this.
5501 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5502 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5503 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5507 model_emf_uri
= NULL
;
5510 * The return value is returned to ustctl so in case of an error, the
5511 * application can be notified. In case of an error, it's important not to
5512 * return a negative error or else the application will get closed.
5514 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5516 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5517 ERR("UST app reply event failed with ret %d", ret
);
5519 DBG3("UST app reply event failed. Application died");
5522 * No need to wipe the create event since the application socket will
5523 * get close on error hence cleaning up everything by itself.
5528 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5532 pthread_mutex_unlock(®istry
->lock
);
5537 free(model_emf_uri
);
5542 * Add enum to the UST session registry. Once done, this replies to the
5543 * application with the appropriate error code.
5545 * The session UST registry lock is acquired within this function.
5547 * On success 0 is returned else a negative value.
5549 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
5550 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
5552 int ret
= 0, ret_code
;
5553 struct ust_app
*app
;
5554 struct ust_app_session
*ua_sess
;
5555 struct ust_registry_session
*registry
;
5556 uint64_t enum_id
= -1ULL;
5560 /* Lookup application. If not found, there is a code flow error. */
5561 app
= find_app_by_notify_sock(sock
);
5563 /* Return an error since this is not an error */
5564 DBG("Application socket %d is being torn down. Aborting enum registration",
5567 goto error_rcu_unlock
;
5570 /* Lookup session by UST object descriptor. */
5571 ua_sess
= find_session_by_objd(app
, sobjd
);
5573 /* Return an error since this is not an error */
5574 DBG("Application session is being torn down (session not found). Aborting enum registration.");
5576 goto error_rcu_unlock
;
5579 registry
= get_session_registry(ua_sess
);
5581 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
5583 goto error_rcu_unlock
;
5586 pthread_mutex_lock(®istry
->lock
);
5589 * From this point on, the callee acquires the ownership of
5590 * entries. The variable entries MUST NOT be read/written after
5593 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
5594 entries
, nr_entries
, &enum_id
);
5598 * The return value is returned to ustctl so in case of an error, the
5599 * application can be notified. In case of an error, it's important not to
5600 * return a negative error or else the application will get closed.
5602 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
5604 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5605 ERR("UST app reply enum failed with ret %d", ret
);
5607 DBG3("UST app reply enum failed. Application died");
5610 * No need to wipe the create enum since the application socket will
5611 * get close on error hence cleaning up everything by itself.
5616 DBG3("UST registry enum %s added successfully or already found", name
);
5619 pthread_mutex_unlock(®istry
->lock
);
5626 * Handle application notification through the given notify socket.
5628 * Return 0 on success or else a negative value.
5630 int ust_app_recv_notify(int sock
)
5633 enum ustctl_notify_cmd cmd
;
5635 DBG3("UST app receiving notify from sock %d", sock
);
5637 ret
= ustctl_recv_notify(sock
, &cmd
);
5639 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5640 ERR("UST app recv notify failed with ret %d", ret
);
5642 DBG3("UST app recv notify failed. Application died");
5648 case USTCTL_NOTIFY_CMD_EVENT
:
5650 int sobjd
, cobjd
, loglevel_value
;
5651 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5653 struct ustctl_field
*fields
;
5655 DBG2("UST app ustctl register event received");
5657 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5658 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5661 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5662 ERR("UST app recv event failed with ret %d", ret
);
5664 DBG3("UST app recv event failed. Application died");
5670 * Add event to the UST registry coming from the notify socket. This
5671 * call will free if needed the sig, fields and model_emf_uri. This
5672 * code path loses the ownsership of these variables and transfer them
5673 * to the this function.
5675 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5676 fields
, loglevel_value
, model_emf_uri
);
5683 case USTCTL_NOTIFY_CMD_CHANNEL
:
5687 struct ustctl_field
*fields
;
5689 DBG2("UST app ustctl register channel received");
5691 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5694 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5695 ERR("UST app recv channel failed with ret %d", ret
);
5697 DBG3("UST app recv channel failed. Application died");
5703 * The fields ownership are transfered to this function call meaning
5704 * that if needed it will be freed. After this, it's invalid to access
5705 * fields or clean it up.
5707 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
5715 case USTCTL_NOTIFY_CMD_ENUM
:
5718 char name
[LTTNG_UST_SYM_NAME_LEN
];
5720 struct ustctl_enum_entry
*entries
;
5722 DBG2("UST app ustctl register enum received");
5724 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
5725 &entries
, &nr_entries
);
5727 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5728 ERR("UST app recv enum failed with ret %d", ret
);
5730 DBG3("UST app recv enum failed. Application died");
5735 /* Callee assumes ownership of entries */
5736 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
5737 entries
, nr_entries
);
5745 /* Should NEVER happen. */
5754 * Once the notify socket hangs up, this is called. First, it tries to find the
5755 * corresponding application. On failure, the call_rcu to close the socket is
5756 * executed. If an application is found, it tries to delete it from the notify
5757 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5759 * Note that an object needs to be allocated here so on ENOMEM failure, the
5760 * call RCU is not done but the rest of the cleanup is.
5762 void ust_app_notify_sock_unregister(int sock
)
5765 struct lttng_ht_iter iter
;
5766 struct ust_app
*app
;
5767 struct ust_app_notify_sock_obj
*obj
;
5773 obj
= zmalloc(sizeof(*obj
));
5776 * An ENOMEM is kind of uncool. If this strikes we continue the
5777 * procedure but the call_rcu will not be called. In this case, we
5778 * accept the fd leak rather than possibly creating an unsynchronized
5779 * state between threads.
5781 * TODO: The notify object should be created once the notify socket is
5782 * registered and stored independantely from the ust app object. The
5783 * tricky part is to synchronize the teardown of the application and
5784 * this notify object. Let's keep that in mind so we can avoid this
5785 * kind of shenanigans with ENOMEM in the teardown path.
5792 DBG("UST app notify socket unregister %d", sock
);
5795 * Lookup application by notify socket. If this fails, this means that the
5796 * hash table delete has already been done by the application
5797 * unregistration process so we can safely close the notify socket in a
5800 app
= find_app_by_notify_sock(sock
);
5805 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5808 * Whatever happens here either we fail or succeed, in both cases we have
5809 * to close the socket after a grace period to continue to the call RCU
5810 * here. If the deletion is successful, the application is not visible
5811 * anymore by other threads and is it fails it means that it was already
5812 * deleted from the hash table so either way we just have to close the
5815 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5821 * Close socket after a grace period to avoid for the socket to be reused
5822 * before the application object is freed creating potential race between
5823 * threads trying to add unique in the global hash table.
5826 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5831 * Destroy a ust app data structure and free its memory.
5833 void ust_app_destroy(struct ust_app
*app
)
5839 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5843 * Take a snapshot for a given UST session. The snapshot is sent to the given
5846 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5848 enum lttng_error_code
ust_app_snapshot_record(
5849 const struct ltt_ust_session
*usess
,
5850 const struct consumer_output
*output
, int wait
,
5851 uint64_t nb_packets_per_stream
)
5854 enum lttng_error_code status
= LTTNG_OK
;
5855 struct lttng_ht_iter iter
;
5856 struct ust_app
*app
;
5857 char *trace_path
= NULL
;
5864 switch (usess
->buffer_type
) {
5865 case LTTNG_BUFFER_PER_UID
:
5867 struct buffer_reg_uid
*reg
;
5869 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5870 struct buffer_reg_channel
*reg_chan
;
5871 struct consumer_socket
*socket
;
5872 char pathname
[PATH_MAX
];
5873 size_t consumer_path_offset
= 0;
5875 if (!reg
->registry
->reg
.ust
->metadata_key
) {
5876 /* Skip since no metadata is present */
5880 /* Get consumer socket to use to push the metadata.*/
5881 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5884 status
= LTTNG_ERR_INVALID
;
5888 memset(pathname
, 0, sizeof(pathname
));
5889 ret
= snprintf(pathname
, sizeof(pathname
),
5890 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5891 reg
->uid
, reg
->bits_per_long
);
5893 PERROR("snprintf snapshot path");
5894 status
= LTTNG_ERR_INVALID
;
5897 /* Free path allowed on previous iteration. */
5899 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
5900 &consumer_path_offset
);
5902 status
= LTTNG_ERR_INVALID
;
5905 /* Add the UST default trace dir to path. */
5906 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5907 reg_chan
, node
.node
) {
5908 status
= consumer_snapshot_channel(socket
,
5909 reg_chan
->consumer_key
,
5910 output
, 0, usess
->uid
,
5911 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
5912 nb_packets_per_stream
);
5913 if (status
!= LTTNG_OK
) {
5917 status
= consumer_snapshot_channel(socket
,
5918 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5919 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
5921 if (status
!= LTTNG_OK
) {
5927 case LTTNG_BUFFER_PER_PID
:
5929 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5930 struct consumer_socket
*socket
;
5931 struct lttng_ht_iter chan_iter
;
5932 struct ust_app_channel
*ua_chan
;
5933 struct ust_app_session
*ua_sess
;
5934 struct ust_registry_session
*registry
;
5935 char pathname
[PATH_MAX
];
5936 size_t consumer_path_offset
= 0;
5938 ua_sess
= lookup_session_by_app(usess
, app
);
5940 /* Session not associated with this app. */
5944 /* Get the right consumer socket for the application. */
5945 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5948 status
= LTTNG_ERR_INVALID
;
5952 /* Add the UST default trace dir to path. */
5953 memset(pathname
, 0, sizeof(pathname
));
5954 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5957 status
= LTTNG_ERR_INVALID
;
5958 PERROR("snprintf snapshot path");
5961 /* Free path allowed on previous iteration. */
5963 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
5964 &consumer_path_offset
);
5966 status
= LTTNG_ERR_INVALID
;
5969 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5970 ua_chan
, node
.node
) {
5971 status
= consumer_snapshot_channel(socket
,
5972 ua_chan
->key
, output
, 0,
5973 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
5974 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
5975 &trace_path
[consumer_path_offset
], wait
,
5976 nb_packets_per_stream
);
5980 case LTTNG_ERR_CHAN_NOT_FOUND
:
5987 registry
= get_session_registry(ua_sess
);
5989 DBG("Application session is being torn down. Skip application.");
5992 status
= consumer_snapshot_channel(socket
,
5993 registry
->metadata_key
, output
, 1,
5994 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
5995 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
5996 &trace_path
[consumer_path_offset
], wait
, 0);
6000 case LTTNG_ERR_CHAN_NOT_FOUND
:
6020 * Return the size taken by one more packet per stream.
6022 uint64_t ust_app_get_size_one_more_packet_per_stream(
6023 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6025 uint64_t tot_size
= 0;
6026 struct ust_app
*app
;
6027 struct lttng_ht_iter iter
;
6031 switch (usess
->buffer_type
) {
6032 case LTTNG_BUFFER_PER_UID
:
6034 struct buffer_reg_uid
*reg
;
6036 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6037 struct buffer_reg_channel
*reg_chan
;
6040 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6041 reg_chan
, node
.node
) {
6042 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6044 * Don't take channel into account if we
6045 * already grab all its packets.
6049 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6055 case LTTNG_BUFFER_PER_PID
:
6058 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6059 struct ust_app_channel
*ua_chan
;
6060 struct ust_app_session
*ua_sess
;
6061 struct lttng_ht_iter chan_iter
;
6063 ua_sess
= lookup_session_by_app(usess
, app
);
6065 /* Session not associated with this app. */
6069 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6070 ua_chan
, node
.node
) {
6071 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6073 * Don't take channel into account if we
6074 * already grab all its packets.
6078 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6092 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6093 struct cds_list_head
*buffer_reg_uid_list
,
6094 struct consumer_output
*consumer
, uint64_t uchan_id
,
6095 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6098 uint64_t consumer_chan_key
;
6103 ret
= buffer_reg_uid_consumer_channel_key(
6104 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6112 ret
= consumer_get_lost_packets(ust_session_id
,
6113 consumer_chan_key
, consumer
, lost
);
6115 ret
= consumer_get_discarded_events(ust_session_id
,
6116 consumer_chan_key
, consumer
, discarded
);
6123 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6124 struct ltt_ust_channel
*uchan
,
6125 struct consumer_output
*consumer
, int overwrite
,
6126 uint64_t *discarded
, uint64_t *lost
)
6129 struct lttng_ht_iter iter
;
6130 struct lttng_ht_node_str
*ua_chan_node
;
6131 struct ust_app
*app
;
6132 struct ust_app_session
*ua_sess
;
6133 struct ust_app_channel
*ua_chan
;
6140 * Iterate over every registered applications. Sum counters for
6141 * all applications containing requested session and channel.
6143 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6144 struct lttng_ht_iter uiter
;
6146 ua_sess
= lookup_session_by_app(usess
, app
);
6147 if (ua_sess
== NULL
) {
6152 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6153 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6154 /* If the session is found for the app, the channel must be there */
6155 assert(ua_chan_node
);
6157 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6162 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6169 uint64_t _discarded
;
6171 ret
= consumer_get_discarded_events(usess
->id
,
6172 ua_chan
->key
, consumer
, &_discarded
);
6176 (*discarded
) += _discarded
;
6185 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6186 struct ust_app
*app
)
6189 struct ust_app_session
*ua_sess
;
6191 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6195 ua_sess
= lookup_session_by_app(usess
, app
);
6196 if (ua_sess
== NULL
) {
6197 /* The session is in teardown process. Ignore and continue. */
6201 pthread_mutex_lock(&ua_sess
->lock
);
6203 if (ua_sess
->deleted
) {
6207 pthread_mutex_lock(&app
->sock_lock
);
6208 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6209 pthread_mutex_unlock(&app
->sock_lock
);
6212 pthread_mutex_unlock(&ua_sess
->lock
);
6216 health_code_update();
6221 * Regenerate the statedump for each app in the session.
6223 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6226 struct lttng_ht_iter iter
;
6227 struct ust_app
*app
;
6229 DBG("Regenerating the metadata for all UST apps");
6233 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6234 if (!app
->compatible
) {
6238 ret
= ust_app_regenerate_statedump(usess
, app
);
6240 /* Continue to the next app even on error */
6251 * Rotate all the channels of a session.
6253 * Return LTTNG_OK on success or else an LTTng error code.
6255 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6258 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6259 struct lttng_ht_iter iter
;
6260 struct ust_app
*app
;
6261 struct ltt_ust_session
*usess
= session
->ust_session
;
6267 switch (usess
->buffer_type
) {
6268 case LTTNG_BUFFER_PER_UID
:
6270 struct buffer_reg_uid
*reg
;
6272 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6273 struct buffer_reg_channel
*reg_chan
;
6274 struct consumer_socket
*socket
;
6276 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6277 /* Skip since no metadata is present */
6281 /* Get consumer socket to use to push the metadata.*/
6282 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6285 cmd_ret
= LTTNG_ERR_INVALID
;
6289 /* Rotate the data channels. */
6290 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6291 reg_chan
, node
.node
) {
6292 ret
= consumer_rotate_channel(socket
,
6293 reg_chan
->consumer_key
,
6294 usess
->uid
, usess
->gid
,
6296 /* is_metadata_channel */ false);
6298 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6303 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6305 ret
= consumer_rotate_channel(socket
,
6306 reg
->registry
->reg
.ust
->metadata_key
,
6307 usess
->uid
, usess
->gid
,
6309 /* is_metadata_channel */ true);
6311 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6317 case LTTNG_BUFFER_PER_PID
:
6319 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6320 struct consumer_socket
*socket
;
6321 struct lttng_ht_iter chan_iter
;
6322 struct ust_app_channel
*ua_chan
;
6323 struct ust_app_session
*ua_sess
;
6324 struct ust_registry_session
*registry
;
6326 ua_sess
= lookup_session_by_app(usess
, app
);
6328 /* Session not associated with this app. */
6332 /* Get the right consumer socket for the application. */
6333 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6336 cmd_ret
= LTTNG_ERR_INVALID
;
6340 registry
= get_session_registry(ua_sess
);
6342 DBG("Application session is being torn down. Skip application.");
6346 /* Rotate the data channels. */
6347 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6348 ua_chan
, node
.node
) {
6349 ret
= consumer_rotate_channel(socket
,
6351 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6352 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6354 /* is_metadata_channel */ false);
6356 /* Per-PID buffer and application going away. */
6357 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6359 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6364 /* Rotate the metadata channel. */
6365 (void) push_metadata(registry
, usess
->consumer
);
6366 ret
= consumer_rotate_channel(socket
,
6367 registry
->metadata_key
,
6368 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6369 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6371 /* is_metadata_channel */ true);
6373 /* Per-PID buffer and application going away. */
6374 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6376 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6394 enum lttng_error_code
ust_app_create_channel_subdirectories(
6395 const struct ltt_ust_session
*usess
)
6397 enum lttng_error_code ret
= LTTNG_OK
;
6398 struct lttng_ht_iter iter
;
6399 enum lttng_trace_chunk_status chunk_status
;
6400 char *pathname_index
;
6403 assert(usess
->current_trace_chunk
);
6406 switch (usess
->buffer_type
) {
6407 case LTTNG_BUFFER_PER_UID
:
6409 struct buffer_reg_uid
*reg
;
6411 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6412 fmt_ret
= asprintf(&pathname_index
,
6413 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
6414 reg
->uid
, reg
->bits_per_long
);
6416 ERR("Failed to format channel index directory");
6417 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6422 * Create the index subdirectory which will take care
6423 * of implicitly creating the channel's path.
6425 chunk_status
= lttng_trace_chunk_create_subdirectory(
6426 usess
->current_trace_chunk
,
6428 free(pathname_index
);
6429 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6430 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6436 case LTTNG_BUFFER_PER_PID
:
6438 struct ust_app
*app
;
6441 * Create the toplevel ust/ directory in case no apps are running.
6443 chunk_status
= lttng_trace_chunk_create_subdirectory(
6444 usess
->current_trace_chunk
,
6445 DEFAULT_UST_TRACE_DIR
);
6446 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6447 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6451 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
6453 struct ust_app_session
*ua_sess
;
6454 struct ust_registry_session
*registry
;
6456 ua_sess
= lookup_session_by_app(usess
, app
);
6458 /* Session not associated with this app. */
6462 registry
= get_session_registry(ua_sess
);
6464 DBG("Application session is being torn down. Skip application.");
6468 fmt_ret
= asprintf(&pathname_index
,
6469 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
6472 ERR("Failed to format channel index directory");
6473 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6477 * Create the index subdirectory which will take care
6478 * of implicitly creating the channel's path.
6480 chunk_status
= lttng_trace_chunk_create_subdirectory(
6481 usess
->current_trace_chunk
,
6483 free(pathname_index
);
6484 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6485 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6502 * Clear all the channels of a session.
6504 * Return LTTNG_OK on success or else an LTTng error code.
6506 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
6509 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6510 struct lttng_ht_iter iter
;
6511 struct ust_app
*app
;
6512 struct ltt_ust_session
*usess
= session
->ust_session
;
6518 if (usess
->active
) {
6519 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
6520 cmd_ret
= LTTNG_ERR_FATAL
;
6524 switch (usess
->buffer_type
) {
6525 case LTTNG_BUFFER_PER_UID
:
6527 struct buffer_reg_uid
*reg
;
6529 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6530 struct buffer_reg_channel
*reg_chan
;
6531 struct consumer_socket
*socket
;
6533 /* Get consumer socket to use to push the metadata.*/
6534 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6537 cmd_ret
= LTTNG_ERR_INVALID
;
6541 /* Clear the data channels. */
6542 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6543 reg_chan
, node
.node
) {
6544 ret
= consumer_clear_channel(socket
,
6545 reg_chan
->consumer_key
);
6551 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6554 * Clear the metadata channel.
6555 * Metadata channel is not cleared per se but we still need to
6556 * perform a rotation operation on it behind the scene.
6558 ret
= consumer_clear_channel(socket
,
6559 reg
->registry
->reg
.ust
->metadata_key
);
6566 case LTTNG_BUFFER_PER_PID
:
6568 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6569 struct consumer_socket
*socket
;
6570 struct lttng_ht_iter chan_iter
;
6571 struct ust_app_channel
*ua_chan
;
6572 struct ust_app_session
*ua_sess
;
6573 struct ust_registry_session
*registry
;
6575 ua_sess
= lookup_session_by_app(usess
, app
);
6577 /* Session not associated with this app. */
6581 /* Get the right consumer socket for the application. */
6582 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6585 cmd_ret
= LTTNG_ERR_INVALID
;
6589 registry
= get_session_registry(ua_sess
);
6591 DBG("Application session is being torn down. Skip application.");
6595 /* Clear the data channels. */
6596 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6597 ua_chan
, node
.node
) {
6598 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
6600 /* Per-PID buffer and application going away. */
6601 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
6608 (void) push_metadata(registry
, usess
->consumer
);
6611 * Clear the metadata channel.
6612 * Metadata channel is not cleared per se but we still need to
6613 * perform rotation operation on it behind the scene.
6615 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
6617 /* Per-PID buffer and application going away. */
6618 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
6636 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
6637 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
6640 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
6650 * This function skips the metadata channel as the begin/end timestamps of a
6651 * metadata packet are useless.
6653 * Moreover, opening a packet after a "clear" will cause problems for live
6654 * sessions as it will introduce padding that was not part of the first trace
6655 * chunk. The relay daemon expects the content of the metadata stream of
6656 * successive metadata trace chunks to be strict supersets of one another.
6658 * For example, flushing a packet at the beginning of the metadata stream of
6659 * a trace chunk resulting from a "clear" session command will cause the
6660 * size of the metadata stream of the new trace chunk to not match the size of
6661 * the metadata stream of the original chunk. This will confuse the relay
6662 * daemon as the same "offset" in a metadata stream will no longer point
6663 * to the same content.
6665 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
6667 enum lttng_error_code ret
= LTTNG_OK
;
6668 struct lttng_ht_iter iter
;
6669 struct ltt_ust_session
*usess
= session
->ust_session
;
6675 switch (usess
->buffer_type
) {
6676 case LTTNG_BUFFER_PER_UID
:
6678 struct buffer_reg_uid
*reg
;
6680 cds_list_for_each_entry (
6681 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6682 struct buffer_reg_channel
*reg_chan
;
6683 struct consumer_socket
*socket
;
6685 socket
= consumer_find_socket_by_bitness(
6686 reg
->bits_per_long
, usess
->consumer
);
6688 ret
= LTTNG_ERR_FATAL
;
6692 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
6693 &iter
.iter
, reg_chan
, node
.node
) {
6694 const int open_ret
=
6695 consumer_open_channel_packets(
6697 reg_chan
->consumer_key
);
6700 ret
= LTTNG_ERR_UNK
;
6707 case LTTNG_BUFFER_PER_PID
:
6709 struct ust_app
*app
;
6711 cds_lfht_for_each_entry (
6712 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6713 struct consumer_socket
*socket
;
6714 struct lttng_ht_iter chan_iter
;
6715 struct ust_app_channel
*ua_chan
;
6716 struct ust_app_session
*ua_sess
;
6717 struct ust_registry_session
*registry
;
6719 ua_sess
= lookup_session_by_app(usess
, app
);
6721 /* Session not associated with this app. */
6725 /* Get the right consumer socket for the application. */
6726 socket
= consumer_find_socket_by_bitness(
6727 app
->bits_per_long
, usess
->consumer
);
6729 ret
= LTTNG_ERR_FATAL
;
6733 registry
= get_session_registry(ua_sess
);
6735 DBG("Application session is being torn down. Skip application.");
6739 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
6740 &chan_iter
.iter
, ua_chan
, node
.node
) {
6741 const int open_ret
=
6742 consumer_open_channel_packets(
6748 * Per-PID buffer and application going
6751 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
6755 ret
= LTTNG_ERR_UNK
;