2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <sys/types.h>
29 #include <urcu/compiler.h>
30 #include <lttng/ust-error.h>
33 #include <common/common.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
36 #include "buffer-registry.h"
38 #include "health-sessiond.h"
40 #include "ust-consumer.h"
44 #include "lttng-sessiond.h"
45 #include "notification-thread-commands.h"
49 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
51 /* Next available channel key. Access under next_channel_key_lock. */
52 static uint64_t _next_channel_key
;
53 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
55 /* Next available session ID. Access under next_session_id_lock. */
56 static uint64_t _next_session_id
;
57 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
60 * Return the incremented value of next_channel_key.
62 static uint64_t get_next_channel_key(void)
66 pthread_mutex_lock(&next_channel_key_lock
);
67 ret
= ++_next_channel_key
;
68 pthread_mutex_unlock(&next_channel_key_lock
);
73 * Return the atomically incremented value of next_session_id.
75 static uint64_t get_next_session_id(void)
79 pthread_mutex_lock(&next_session_id_lock
);
80 ret
= ++_next_session_id
;
81 pthread_mutex_unlock(&next_session_id_lock
);
85 static void copy_channel_attr_to_ustctl(
86 struct ustctl_consumer_channel_attr
*attr
,
87 struct lttng_ust_channel_attr
*uattr
)
89 /* Copy event attributes since the layout is different. */
90 attr
->subbuf_size
= uattr
->subbuf_size
;
91 attr
->num_subbuf
= uattr
->num_subbuf
;
92 attr
->overwrite
= uattr
->overwrite
;
93 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
94 attr
->read_timer_interval
= uattr
->read_timer_interval
;
95 attr
->output
= uattr
->output
;
96 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
100 * Match function for the hash table lookup.
102 * It matches an ust app event based on three attributes which are the event
103 * name, the filter bytecode and the loglevel.
105 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
107 struct ust_app_event
*event
;
108 const struct ust_app_ht_key
*key
;
109 int ev_loglevel_value
;
114 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
116 ev_loglevel_value
= event
->attr
.loglevel
;
118 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
121 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
125 /* Event loglevel. */
126 if (ev_loglevel_value
!= key
->loglevel_type
) {
127 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
128 && key
->loglevel_type
== 0 &&
129 ev_loglevel_value
== -1) {
131 * Match is accepted. This is because on event creation, the
132 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
133 * -1 are accepted for this loglevel type since 0 is the one set by
134 * the API when receiving an enable event.
141 /* One of the filters is NULL, fail. */
142 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
146 if (key
->filter
&& event
->filter
) {
147 /* Both filters exists, check length followed by the bytecode. */
148 if (event
->filter
->len
!= key
->filter
->len
||
149 memcmp(event
->filter
->data
, key
->filter
->data
,
150 event
->filter
->len
) != 0) {
155 /* One of the exclusions is NULL, fail. */
156 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
160 if (key
->exclusion
&& event
->exclusion
) {
161 /* Both exclusions exists, check count followed by the names. */
162 if (event
->exclusion
->count
!= key
->exclusion
->count
||
163 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
164 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
178 * Unique add of an ust app event in the given ht. This uses the custom
179 * ht_match_ust_app_event match function and the event name as hash.
181 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
182 struct ust_app_event
*event
)
184 struct cds_lfht_node
*node_ptr
;
185 struct ust_app_ht_key key
;
189 assert(ua_chan
->events
);
192 ht
= ua_chan
->events
;
193 key
.name
= event
->attr
.name
;
194 key
.filter
= event
->filter
;
195 key
.loglevel_type
= event
->attr
.loglevel
;
196 key
.exclusion
= event
->exclusion
;
198 node_ptr
= cds_lfht_add_unique(ht
->ht
,
199 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
200 ht_match_ust_app_event
, &key
, &event
->node
.node
);
201 assert(node_ptr
== &event
->node
.node
);
205 * Close the notify socket from the given RCU head object. This MUST be called
206 * through a call_rcu().
208 static void close_notify_sock_rcu(struct rcu_head
*head
)
211 struct ust_app_notify_sock_obj
*obj
=
212 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
214 /* Must have a valid fd here. */
215 assert(obj
->fd
>= 0);
217 ret
= close(obj
->fd
);
219 ERR("close notify sock %d RCU", obj
->fd
);
221 lttng_fd_put(LTTNG_FD_APPS
, 1);
227 * Return the session registry according to the buffer type of the given
230 * A registry per UID object MUST exists before calling this function or else
231 * it assert() if not found. RCU read side lock must be acquired.
233 static struct ust_registry_session
*get_session_registry(
234 struct ust_app_session
*ua_sess
)
236 struct ust_registry_session
*registry
= NULL
;
240 switch (ua_sess
->buffer_type
) {
241 case LTTNG_BUFFER_PER_PID
:
243 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
247 registry
= reg_pid
->registry
->reg
.ust
;
250 case LTTNG_BUFFER_PER_UID
:
252 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
253 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
254 ua_sess
->real_credentials
.uid
);
258 registry
= reg_uid
->registry
->reg
.ust
;
270 * Delete ust context safely. RCU read lock must be held before calling
274 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
282 pthread_mutex_lock(&app
->sock_lock
);
283 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
284 pthread_mutex_unlock(&app
->sock_lock
);
285 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
286 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
287 sock
, ua_ctx
->obj
->handle
, ret
);
295 * Delete ust app event safely. RCU read lock must be held before calling
299 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
306 free(ua_event
->filter
);
307 if (ua_event
->exclusion
!= NULL
)
308 free(ua_event
->exclusion
);
309 if (ua_event
->obj
!= NULL
) {
310 pthread_mutex_lock(&app
->sock_lock
);
311 ret
= ustctl_release_object(sock
, ua_event
->obj
);
312 pthread_mutex_unlock(&app
->sock_lock
);
313 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
314 ERR("UST app sock %d release event obj failed with ret %d",
323 * Release ust data object of the given stream.
325 * Return 0 on success or else a negative value.
327 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
335 pthread_mutex_lock(&app
->sock_lock
);
336 ret
= ustctl_release_object(sock
, stream
->obj
);
337 pthread_mutex_unlock(&app
->sock_lock
);
338 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
339 ERR("UST app sock %d release stream obj failed with ret %d",
342 lttng_fd_put(LTTNG_FD_APPS
, 2);
350 * Delete ust app stream safely. RCU read lock must be held before calling
354 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
359 (void) release_ust_app_stream(sock
, stream
, app
);
364 * We need to execute ht_destroy outside of RCU read-side critical
365 * section and outside of call_rcu thread, so we postpone its execution
366 * using ht_cleanup_push. It is simpler than to change the semantic of
367 * the many callers of delete_ust_app_session().
370 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
372 struct ust_app_channel
*ua_chan
=
373 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
375 ht_cleanup_push(ua_chan
->ctx
);
376 ht_cleanup_push(ua_chan
->events
);
381 * Extract the lost packet or discarded events counter when the channel is
382 * being deleted and store the value in the parent channel so we can
383 * access it from lttng list and at stop/destroy.
385 * The session list lock must be held by the caller.
388 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
390 uint64_t discarded
= 0, lost
= 0;
391 struct ltt_session
*session
;
392 struct ltt_ust_channel
*uchan
;
394 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
399 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
400 if (!session
|| !session
->ust_session
) {
402 * Not finding the session is not an error because there are
403 * multiple ways the channels can be torn down.
405 * 1) The session daemon can initiate the destruction of the
406 * ust app session after receiving a destroy command or
407 * during its shutdown/teardown.
408 * 2) The application, since we are in per-pid tracing, is
409 * unregistering and tearing down its ust app session.
411 * Both paths are protected by the session list lock which
412 * ensures that the accounting of lost packets and discarded
413 * events is done exactly once. The session is then unpublished
414 * from the session list, resulting in this condition.
419 if (ua_chan
->attr
.overwrite
) {
420 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
421 ua_chan
->key
, session
->ust_session
->consumer
,
424 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
425 ua_chan
->key
, session
->ust_session
->consumer
,
428 uchan
= trace_ust_find_channel_by_name(
429 session
->ust_session
->domain_global
.channels
,
432 ERR("Missing UST channel to store discarded counters");
436 uchan
->per_pid_closed_app_discarded
+= discarded
;
437 uchan
->per_pid_closed_app_lost
+= lost
;
442 session_put(session
);
447 * Delete ust app channel safely. RCU read lock must be held before calling
450 * The session list lock must be held by the caller.
453 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
457 struct lttng_ht_iter iter
;
458 struct ust_app_event
*ua_event
;
459 struct ust_app_ctx
*ua_ctx
;
460 struct ust_app_stream
*stream
, *stmp
;
461 struct ust_registry_session
*registry
;
465 DBG3("UST app deleting channel %s", ua_chan
->name
);
468 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
469 cds_list_del(&stream
->list
);
470 delete_ust_app_stream(sock
, stream
, app
);
474 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
475 cds_list_del(&ua_ctx
->list
);
476 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
478 delete_ust_app_ctx(sock
, ua_ctx
, app
);
482 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
484 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
486 delete_ust_app_event(sock
, ua_event
, app
);
489 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
490 /* Wipe and free registry from session registry. */
491 registry
= get_session_registry(ua_chan
->session
);
493 ust_registry_channel_del_free(registry
, ua_chan
->key
,
497 * A negative socket can be used by the caller when
498 * cleaning-up a ua_chan in an error path. Skip the
499 * accounting in this case.
502 save_per_pid_lost_discarded_counters(ua_chan
);
506 if (ua_chan
->obj
!= NULL
) {
507 /* Remove channel from application UST object descriptor. */
508 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
509 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
511 pthread_mutex_lock(&app
->sock_lock
);
512 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
513 pthread_mutex_unlock(&app
->sock_lock
);
514 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
515 ERR("UST app sock %d release channel obj failed with ret %d",
518 lttng_fd_put(LTTNG_FD_APPS
, 1);
521 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
524 int ust_app_register_done(struct ust_app
*app
)
528 pthread_mutex_lock(&app
->sock_lock
);
529 ret
= ustctl_register_done(app
->sock
);
530 pthread_mutex_unlock(&app
->sock_lock
);
534 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
539 pthread_mutex_lock(&app
->sock_lock
);
544 ret
= ustctl_release_object(sock
, data
);
546 pthread_mutex_unlock(&app
->sock_lock
);
552 * Push metadata to consumer socket.
554 * RCU read-side lock must be held to guarantee existance of socket.
555 * Must be called with the ust app session lock held.
556 * Must be called with the registry lock held.
558 * On success, return the len of metadata pushed or else a negative value.
559 * Returning a -EPIPE return value means we could not send the metadata,
560 * but it can be caused by recoverable errors (e.g. the application has
561 * terminated concurrently).
563 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
564 struct consumer_socket
*socket
, int send_zero_data
)
567 char *metadata_str
= NULL
;
568 size_t len
, offset
, new_metadata_len_sent
;
570 uint64_t metadata_key
, metadata_version
;
575 metadata_key
= registry
->metadata_key
;
578 * Means that no metadata was assigned to the session. This can
579 * happens if no start has been done previously.
585 offset
= registry
->metadata_len_sent
;
586 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
587 new_metadata_len_sent
= registry
->metadata_len
;
588 metadata_version
= registry
->metadata_version
;
590 DBG3("No metadata to push for metadata key %" PRIu64
,
591 registry
->metadata_key
);
593 if (send_zero_data
) {
594 DBG("No metadata to push");
600 /* Allocate only what we have to send. */
601 metadata_str
= zmalloc(len
);
603 PERROR("zmalloc ust app metadata string");
607 /* Copy what we haven't sent out. */
608 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
611 pthread_mutex_unlock(®istry
->lock
);
613 * We need to unlock the registry while we push metadata to
614 * break a circular dependency between the consumerd metadata
615 * lock and the sessiond registry lock. Indeed, pushing metadata
616 * to the consumerd awaits that it gets pushed all the way to
617 * relayd, but doing so requires grabbing the metadata lock. If
618 * a concurrent metadata request is being performed by
619 * consumerd, this can try to grab the registry lock on the
620 * sessiond while holding the metadata lock on the consumer
621 * daemon. Those push and pull schemes are performed on two
622 * different bidirectionnal communication sockets.
624 ret
= consumer_push_metadata(socket
, metadata_key
,
625 metadata_str
, len
, offset
, metadata_version
);
626 pthread_mutex_lock(®istry
->lock
);
629 * There is an acceptable race here between the registry
630 * metadata key assignment and the creation on the
631 * consumer. The session daemon can concurrently push
632 * metadata for this registry while being created on the
633 * consumer since the metadata key of the registry is
634 * assigned *before* it is setup to avoid the consumer
635 * to ask for metadata that could possibly be not found
636 * in the session daemon.
638 * The metadata will get pushed either by the session
639 * being stopped or the consumer requesting metadata if
640 * that race is triggered.
642 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
645 ERR("Error pushing metadata to consumer");
651 * Metadata may have been concurrently pushed, since
652 * we're not holding the registry lock while pushing to
653 * consumer. This is handled by the fact that we send
654 * the metadata content, size, and the offset at which
655 * that metadata belongs. This may arrive out of order
656 * on the consumer side, and the consumer is able to
657 * deal with overlapping fragments. The consumer
658 * supports overlapping fragments, which must be
659 * contiguous starting from offset 0. We keep the
660 * largest metadata_len_sent value of the concurrent
663 registry
->metadata_len_sent
=
664 max_t(size_t, registry
->metadata_len_sent
,
665 new_metadata_len_sent
);
674 * On error, flag the registry that the metadata is
675 * closed. We were unable to push anything and this
676 * means that either the consumer is not responding or
677 * the metadata cache has been destroyed on the
680 registry
->metadata_closed
= 1;
688 * For a given application and session, push metadata to consumer.
689 * Either sock or consumer is required : if sock is NULL, the default
690 * socket to send the metadata is retrieved from consumer, if sock
691 * is not NULL we use it to send the metadata.
692 * RCU read-side lock must be held while calling this function,
693 * therefore ensuring existance of registry. It also ensures existance
694 * of socket throughout this function.
696 * Return 0 on success else a negative error.
697 * Returning a -EPIPE return value means we could not send the metadata,
698 * but it can be caused by recoverable errors (e.g. the application has
699 * terminated concurrently).
701 static int push_metadata(struct ust_registry_session
*registry
,
702 struct consumer_output
*consumer
)
706 struct consumer_socket
*socket
;
711 pthread_mutex_lock(®istry
->lock
);
712 if (registry
->metadata_closed
) {
717 /* Get consumer socket to use to push the metadata.*/
718 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
725 ret
= ust_app_push_metadata(registry
, socket
, 0);
730 pthread_mutex_unlock(®istry
->lock
);
734 pthread_mutex_unlock(®istry
->lock
);
739 * Send to the consumer a close metadata command for the given session. Once
740 * done, the metadata channel is deleted and the session metadata pointer is
741 * nullified. The session lock MUST be held unless the application is
742 * in the destroy path.
744 * Return 0 on success else a negative value.
746 static int close_metadata(struct ust_registry_session
*registry
,
747 struct consumer_output
*consumer
)
750 struct consumer_socket
*socket
;
757 pthread_mutex_lock(®istry
->lock
);
759 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
764 /* Get consumer socket to use to push the metadata.*/
765 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
772 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
779 * Metadata closed. Even on error this means that the consumer is not
780 * responding or not found so either way a second close should NOT be emit
783 registry
->metadata_closed
= 1;
785 pthread_mutex_unlock(®istry
->lock
);
791 * We need to execute ht_destroy outside of RCU read-side critical
792 * section and outside of call_rcu thread, so we postpone its execution
793 * using ht_cleanup_push. It is simpler than to change the semantic of
794 * the many callers of delete_ust_app_session().
797 void delete_ust_app_session_rcu(struct rcu_head
*head
)
799 struct ust_app_session
*ua_sess
=
800 caa_container_of(head
, struct ust_app_session
, rcu_head
);
802 ht_cleanup_push(ua_sess
->channels
);
807 * Delete ust app session safely. RCU read lock must be held before calling
810 * The session list lock must be held by the caller.
813 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
817 struct lttng_ht_iter iter
;
818 struct ust_app_channel
*ua_chan
;
819 struct ust_registry_session
*registry
;
823 pthread_mutex_lock(&ua_sess
->lock
);
825 assert(!ua_sess
->deleted
);
826 ua_sess
->deleted
= true;
828 registry
= get_session_registry(ua_sess
);
829 /* Registry can be null on error path during initialization. */
831 /* Push metadata for application before freeing the application. */
832 (void) push_metadata(registry
, ua_sess
->consumer
);
835 * Don't ask to close metadata for global per UID buffers. Close
836 * metadata only on destroy trace session in this case. Also, the
837 * previous push metadata could have flag the metadata registry to
838 * close so don't send a close command if closed.
840 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
841 /* And ask to close it for this session registry. */
842 (void) close_metadata(registry
, ua_sess
->consumer
);
846 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
848 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
850 delete_ust_app_channel(sock
, ua_chan
, app
);
853 /* In case of per PID, the registry is kept in the session. */
854 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
855 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
858 * Registry can be null on error path during
861 buffer_reg_pid_remove(reg_pid
);
862 buffer_reg_pid_destroy(reg_pid
);
866 if (ua_sess
->handle
!= -1) {
867 pthread_mutex_lock(&app
->sock_lock
);
868 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
869 pthread_mutex_unlock(&app
->sock_lock
);
870 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
871 ERR("UST app sock %d release session handle failed with ret %d",
874 /* Remove session from application UST object descriptor. */
875 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
876 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
880 pthread_mutex_unlock(&ua_sess
->lock
);
882 consumer_output_put(ua_sess
->consumer
);
884 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
888 * Delete a traceable application structure from the global list. Never call
889 * this function outside of a call_rcu call.
891 * RCU read side lock should _NOT_ be held when calling this function.
894 void delete_ust_app(struct ust_app
*app
)
897 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
900 * The session list lock must be held during this function to guarantee
901 * the existence of ua_sess.
904 /* Delete ust app sessions info */
909 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
911 /* Free every object in the session and the session. */
913 delete_ust_app_session(sock
, ua_sess
, app
);
917 ht_cleanup_push(app
->sessions
);
918 ht_cleanup_push(app
->ust_sessions_objd
);
919 ht_cleanup_push(app
->ust_objd
);
922 * Wait until we have deleted the application from the sock hash table
923 * before closing this socket, otherwise an application could re-use the
924 * socket ID and race with the teardown, using the same hash table entry.
926 * It's OK to leave the close in call_rcu. We want it to stay unique for
927 * all RCU readers that could run concurrently with unregister app,
928 * therefore we _need_ to only close that socket after a grace period. So
929 * it should stay in this RCU callback.
931 * This close() is a very important step of the synchronization model so
932 * every modification to this function must be carefully reviewed.
938 lttng_fd_put(LTTNG_FD_APPS
, 1);
940 DBG2("UST app pid %d deleted", app
->pid
);
942 session_unlock_list();
946 * URCU intermediate call to delete an UST app.
949 void delete_ust_app_rcu(struct rcu_head
*head
)
951 struct lttng_ht_node_ulong
*node
=
952 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
953 struct ust_app
*app
=
954 caa_container_of(node
, struct ust_app
, pid_n
);
956 DBG3("Call RCU deleting app PID %d", app
->pid
);
961 * Delete the session from the application ht and delete the data structure by
962 * freeing every object inside and releasing them.
964 * The session list lock must be held by the caller.
966 static void destroy_app_session(struct ust_app
*app
,
967 struct ust_app_session
*ua_sess
)
970 struct lttng_ht_iter iter
;
975 iter
.iter
.node
= &ua_sess
->node
.node
;
976 ret
= lttng_ht_del(app
->sessions
, &iter
);
978 /* Already scheduled for teardown. */
982 /* Once deleted, free the data structure. */
983 delete_ust_app_session(app
->sock
, ua_sess
, app
);
990 * Alloc new UST app session.
993 struct ust_app_session
*alloc_ust_app_session(void)
995 struct ust_app_session
*ua_sess
;
997 /* Init most of the default value by allocating and zeroing */
998 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
999 if (ua_sess
== NULL
) {
1004 ua_sess
->handle
= -1;
1005 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1006 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1007 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1016 * Alloc new UST app channel.
1019 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
1020 struct ust_app_session
*ua_sess
,
1021 struct lttng_ust_channel_attr
*attr
)
1023 struct ust_app_channel
*ua_chan
;
1025 /* Init most of the default value by allocating and zeroing */
1026 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1027 if (ua_chan
== NULL
) {
1032 /* Setup channel name */
1033 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1034 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1036 ua_chan
->enabled
= 1;
1037 ua_chan
->handle
= -1;
1038 ua_chan
->session
= ua_sess
;
1039 ua_chan
->key
= get_next_channel_key();
1040 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1041 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1042 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1044 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1045 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1047 /* Copy attributes */
1049 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1050 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1051 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1052 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1053 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1054 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1055 ua_chan
->attr
.output
= attr
->output
;
1056 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1058 /* By default, the channel is a per cpu channel. */
1059 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1061 DBG3("UST app channel %s allocated", ua_chan
->name
);
1070 * Allocate and initialize a UST app stream.
1072 * Return newly allocated stream pointer or NULL on error.
1074 struct ust_app_stream
*ust_app_alloc_stream(void)
1076 struct ust_app_stream
*stream
= NULL
;
1078 stream
= zmalloc(sizeof(*stream
));
1079 if (stream
== NULL
) {
1080 PERROR("zmalloc ust app stream");
1084 /* Zero could be a valid value for a handle so flag it to -1. */
1085 stream
->handle
= -1;
1092 * Alloc new UST app event.
1095 struct ust_app_event
*alloc_ust_app_event(char *name
,
1096 struct lttng_ust_event
*attr
)
1098 struct ust_app_event
*ua_event
;
1100 /* Init most of the default value by allocating and zeroing */
1101 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1102 if (ua_event
== NULL
) {
1107 ua_event
->enabled
= 1;
1108 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1109 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1110 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1112 /* Copy attributes */
1114 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1117 DBG3("UST app event %s allocated", ua_event
->name
);
1126 * Alloc new UST app context.
1129 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1131 struct ust_app_ctx
*ua_ctx
;
1133 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1134 if (ua_ctx
== NULL
) {
1138 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1141 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1142 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1143 char *provider_name
= NULL
, *ctx_name
= NULL
;
1145 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1146 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1147 if (!provider_name
|| !ctx_name
) {
1148 free(provider_name
);
1153 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1154 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1158 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1166 * Allocate a filter and copy the given original filter.
1168 * Return allocated filter or NULL on error.
1170 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1171 struct lttng_filter_bytecode
*orig_f
)
1173 struct lttng_filter_bytecode
*filter
= NULL
;
1175 /* Copy filter bytecode */
1176 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1178 PERROR("zmalloc alloc filter bytecode");
1182 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1189 * Create a liblttng-ust filter bytecode from given bytecode.
1191 * Return allocated filter or NULL on error.
1193 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1194 struct lttng_filter_bytecode
*orig_f
)
1196 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1198 /* Copy filter bytecode */
1199 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1201 PERROR("zmalloc alloc ust filter bytecode");
1205 assert(sizeof(struct lttng_filter_bytecode
) ==
1206 sizeof(struct lttng_ust_filter_bytecode
));
1207 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1213 * Find an ust_app using the sock and return it. RCU read side lock must be
1214 * held before calling this helper function.
1216 struct ust_app
*ust_app_find_by_sock(int sock
)
1218 struct lttng_ht_node_ulong
*node
;
1219 struct lttng_ht_iter iter
;
1221 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1222 node
= lttng_ht_iter_get_node_ulong(&iter
);
1224 DBG2("UST app find by sock %d not found", sock
);
1228 return caa_container_of(node
, struct ust_app
, sock_n
);
1235 * Find an ust_app using the notify sock and return it. RCU read side lock must
1236 * be held before calling this helper function.
1238 static struct ust_app
*find_app_by_notify_sock(int sock
)
1240 struct lttng_ht_node_ulong
*node
;
1241 struct lttng_ht_iter iter
;
1243 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1245 node
= lttng_ht_iter_get_node_ulong(&iter
);
1247 DBG2("UST app find by notify sock %d not found", sock
);
1251 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1258 * Lookup for an ust app event based on event name, filter bytecode and the
1261 * Return an ust_app_event object or NULL on error.
1263 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1264 const char *name
, const struct lttng_filter_bytecode
*filter
,
1266 const struct lttng_event_exclusion
*exclusion
)
1268 struct lttng_ht_iter iter
;
1269 struct lttng_ht_node_str
*node
;
1270 struct ust_app_event
*event
= NULL
;
1271 struct ust_app_ht_key key
;
1276 /* Setup key for event lookup. */
1278 key
.filter
= filter
;
1279 key
.loglevel_type
= loglevel_value
;
1280 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1281 key
.exclusion
= exclusion
;
1283 /* Lookup using the event name as hash and a custom match fct. */
1284 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1285 ht_match_ust_app_event
, &key
, &iter
.iter
);
1286 node
= lttng_ht_iter_get_node_str(&iter
);
1291 event
= caa_container_of(node
, struct ust_app_event
, node
);
1298 * Create the channel context on the tracer.
1300 * Called with UST app session lock held.
1303 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1304 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1308 health_code_update();
1310 pthread_mutex_lock(&app
->sock_lock
);
1311 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1312 ua_chan
->obj
, &ua_ctx
->obj
);
1313 pthread_mutex_unlock(&app
->sock_lock
);
1315 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1316 ERR("UST app create channel context failed for app (pid: %d) "
1317 "with ret %d", app
->pid
, ret
);
1320 * This is normal behavior, an application can die during the
1321 * creation process. Don't report an error so the execution can
1322 * continue normally.
1325 DBG3("UST app add context failed. Application is dead.");
1330 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1332 DBG2("UST app context handle %d created successfully for channel %s",
1333 ua_ctx
->handle
, ua_chan
->name
);
1336 health_code_update();
1341 * Set the filter on the tracer.
1344 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1345 struct ust_app
*app
)
1348 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1350 health_code_update();
1352 if (!ua_event
->filter
) {
1357 ust_bytecode
= create_ust_bytecode_from_bytecode(ua_event
->filter
);
1358 if (!ust_bytecode
) {
1359 ret
= -LTTNG_ERR_NOMEM
;
1362 pthread_mutex_lock(&app
->sock_lock
);
1363 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1365 pthread_mutex_unlock(&app
->sock_lock
);
1367 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1368 ERR("UST app event %s filter failed for app (pid: %d) "
1369 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1372 * This is normal behavior, an application can die during the
1373 * creation process. Don't report an error so the execution can
1374 * continue normally.
1377 DBG3("UST app filter event failed. Application is dead.");
1382 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1385 health_code_update();
1391 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1392 struct lttng_event_exclusion
*exclusion
)
1394 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1395 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1396 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1398 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1399 if (!ust_exclusion
) {
1404 assert(sizeof(struct lttng_event_exclusion
) ==
1405 sizeof(struct lttng_ust_event_exclusion
));
1406 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1408 return ust_exclusion
;
1412 * Set event exclusions on the tracer.
1415 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1416 struct ust_app
*app
)
1419 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1421 health_code_update();
1423 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1428 ust_exclusion
= create_ust_exclusion_from_exclusion(
1429 ua_event
->exclusion
);
1430 if (!ust_exclusion
) {
1431 ret
= -LTTNG_ERR_NOMEM
;
1434 pthread_mutex_lock(&app
->sock_lock
);
1435 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1436 pthread_mutex_unlock(&app
->sock_lock
);
1438 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1439 ERR("UST app event %s exclusions failed for app (pid: %d) "
1440 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1443 * This is normal behavior, an application can die during the
1444 * creation process. Don't report an error so the execution can
1445 * continue normally.
1448 DBG3("UST app event exclusion failed. Application is dead.");
1453 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1456 health_code_update();
1457 free(ust_exclusion
);
1462 * Disable the specified event on to UST tracer for the UST session.
1464 static int disable_ust_event(struct ust_app
*app
,
1465 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1469 health_code_update();
1471 pthread_mutex_lock(&app
->sock_lock
);
1472 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1473 pthread_mutex_unlock(&app
->sock_lock
);
1475 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1476 ERR("UST app event %s disable failed for app (pid: %d) "
1477 "and session handle %d with ret %d",
1478 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1481 * This is normal behavior, an application can die during the
1482 * creation process. Don't report an error so the execution can
1483 * continue normally.
1486 DBG3("UST app disable event failed. Application is dead.");
1491 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1492 ua_event
->attr
.name
, app
->pid
);
1495 health_code_update();
1500 * Disable the specified channel on to UST tracer for the UST session.
1502 static int disable_ust_channel(struct ust_app
*app
,
1503 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1507 health_code_update();
1509 pthread_mutex_lock(&app
->sock_lock
);
1510 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1511 pthread_mutex_unlock(&app
->sock_lock
);
1513 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1514 ERR("UST app channel %s disable failed for app (pid: %d) "
1515 "and session handle %d with ret %d",
1516 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1519 * This is normal behavior, an application can die during the
1520 * creation process. Don't report an error so the execution can
1521 * continue normally.
1524 DBG3("UST app disable channel failed. Application is dead.");
1529 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1530 ua_chan
->name
, app
->pid
);
1533 health_code_update();
1538 * Enable the specified channel on to UST tracer for the UST session.
1540 static int enable_ust_channel(struct ust_app
*app
,
1541 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1545 health_code_update();
1547 pthread_mutex_lock(&app
->sock_lock
);
1548 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1549 pthread_mutex_unlock(&app
->sock_lock
);
1551 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1552 ERR("UST app channel %s enable failed for app (pid: %d) "
1553 "and session handle %d with ret %d",
1554 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1557 * This is normal behavior, an application can die during the
1558 * creation process. Don't report an error so the execution can
1559 * continue normally.
1562 DBG3("UST app enable channel failed. Application is dead.");
1567 ua_chan
->enabled
= 1;
1569 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1570 ua_chan
->name
, app
->pid
);
1573 health_code_update();
1578 * Enable the specified event on to UST tracer for the UST session.
1580 static int enable_ust_event(struct ust_app
*app
,
1581 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1585 health_code_update();
1587 pthread_mutex_lock(&app
->sock_lock
);
1588 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1589 pthread_mutex_unlock(&app
->sock_lock
);
1591 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1592 ERR("UST app event %s enable failed for app (pid: %d) "
1593 "and session handle %d with ret %d",
1594 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1597 * This is normal behavior, an application can die during the
1598 * creation process. Don't report an error so the execution can
1599 * continue normally.
1602 DBG3("UST app enable event failed. Application is dead.");
1607 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1608 ua_event
->attr
.name
, app
->pid
);
1611 health_code_update();
1616 * Send channel and stream buffer to application.
1618 * Return 0 on success. On error, a negative value is returned.
1620 static int send_channel_pid_to_ust(struct ust_app
*app
,
1621 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1624 struct ust_app_stream
*stream
, *stmp
;
1630 health_code_update();
1632 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1635 /* Send channel to the application. */
1636 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1637 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1638 ret
= -ENOTCONN
; /* Caused by app exiting. */
1640 } else if (ret
< 0) {
1644 health_code_update();
1646 /* Send all streams to application. */
1647 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1648 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1649 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1650 ret
= -ENOTCONN
; /* Caused by app exiting. */
1652 } else if (ret
< 0) {
1655 /* We don't need the stream anymore once sent to the tracer. */
1656 cds_list_del(&stream
->list
);
1657 delete_ust_app_stream(-1, stream
, app
);
1659 /* Flag the channel that it is sent to the application. */
1660 ua_chan
->is_sent
= 1;
1663 health_code_update();
1668 * Create the specified event onto the UST tracer for a UST session.
1670 * Should be called with session mutex held.
1673 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1674 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1678 health_code_update();
1680 /* Create UST event on tracer */
1681 pthread_mutex_lock(&app
->sock_lock
);
1682 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1684 pthread_mutex_unlock(&app
->sock_lock
);
1686 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1688 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1689 ua_event
->attr
.name
, app
->pid
, ret
);
1692 * This is normal behavior, an application can die during the
1693 * creation process. Don't report an error so the execution can
1694 * continue normally.
1697 DBG3("UST app create event failed. Application is dead.");
1702 ua_event
->handle
= ua_event
->obj
->handle
;
1704 DBG2("UST app event %s created successfully for pid:%d",
1705 ua_event
->attr
.name
, app
->pid
);
1707 health_code_update();
1709 /* Set filter if one is present. */
1710 if (ua_event
->filter
) {
1711 ret
= set_ust_event_filter(ua_event
, app
);
1717 /* Set exclusions for the event */
1718 if (ua_event
->exclusion
) {
1719 ret
= set_ust_event_exclusion(ua_event
, app
);
1725 /* If event not enabled, disable it on the tracer */
1726 if (ua_event
->enabled
) {
1728 * We now need to explicitly enable the event, since it
1729 * is now disabled at creation.
1731 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1734 * If we hit an EPERM, something is wrong with our enable call. If
1735 * we get an EEXIST, there is a problem on the tracer side since we
1739 case -LTTNG_UST_ERR_PERM
:
1740 /* Code flow problem */
1742 case -LTTNG_UST_ERR_EXIST
:
1743 /* It's OK for our use case. */
1754 health_code_update();
1759 * Copy data between an UST app event and a LTT event.
1761 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1762 struct ltt_ust_event
*uevent
)
1764 size_t exclusion_alloc_size
;
1766 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1767 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1769 ua_event
->enabled
= uevent
->enabled
;
1771 /* Copy event attributes */
1772 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1774 /* Copy filter bytecode */
1775 if (uevent
->filter
) {
1776 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1777 /* Filter might be NULL here in case of ENONEM. */
1780 /* Copy exclusion data */
1781 if (uevent
->exclusion
) {
1782 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1783 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1784 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1785 if (ua_event
->exclusion
== NULL
) {
1788 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1789 exclusion_alloc_size
);
1795 * Copy data between an UST app channel and a LTT channel.
1797 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1798 struct ltt_ust_channel
*uchan
)
1800 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1802 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1803 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1805 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1806 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1808 /* Copy event attributes since the layout is different. */
1809 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1810 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1811 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1812 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1813 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1814 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
1815 ua_chan
->attr
.output
= uchan
->attr
.output
;
1816 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
1819 * Note that the attribute channel type is not set since the channel on the
1820 * tracing registry side does not have this information.
1823 ua_chan
->enabled
= uchan
->enabled
;
1824 ua_chan
->tracing_channel_id
= uchan
->id
;
1826 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1830 * Copy data between a UST app session and a regular LTT session.
1832 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1833 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1835 struct tm
*timeinfo
;
1838 char tmp_shm_path
[PATH_MAX
];
1840 timeinfo
= localtime(&app
->registration_time
);
1841 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1843 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1845 ua_sess
->tracing_id
= usess
->id
;
1846 ua_sess
->id
= get_next_session_id();
1847 ua_sess
->real_credentials
.uid
= app
->uid
;
1848 ua_sess
->real_credentials
.gid
= app
->gid
;
1849 ua_sess
->effective_credentials
.uid
= usess
->uid
;
1850 ua_sess
->effective_credentials
.gid
= usess
->gid
;
1851 ua_sess
->buffer_type
= usess
->buffer_type
;
1852 ua_sess
->bits_per_long
= app
->bits_per_long
;
1854 /* There is only one consumer object per session possible. */
1855 consumer_output_get(usess
->consumer
);
1856 ua_sess
->consumer
= usess
->consumer
;
1858 ua_sess
->output_traces
= usess
->output_traces
;
1859 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1860 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1861 &usess
->metadata_attr
);
1863 switch (ua_sess
->buffer_type
) {
1864 case LTTNG_BUFFER_PER_PID
:
1865 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1866 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1869 case LTTNG_BUFFER_PER_UID
:
1870 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1871 DEFAULT_UST_TRACE_UID_PATH
,
1872 ua_sess
->real_credentials
.uid
,
1873 app
->bits_per_long
);
1880 PERROR("asprintf UST shadow copy session");
1885 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1886 sizeof(ua_sess
->root_shm_path
));
1887 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1888 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1889 sizeof(ua_sess
->shm_path
));
1890 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1891 if (ua_sess
->shm_path
[0]) {
1892 switch (ua_sess
->buffer_type
) {
1893 case LTTNG_BUFFER_PER_PID
:
1894 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1895 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1896 app
->name
, app
->pid
, datetime
);
1898 case LTTNG_BUFFER_PER_UID
:
1899 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1900 DEFAULT_UST_TRACE_UID_PATH
,
1901 app
->uid
, app
->bits_per_long
);
1908 PERROR("sprintf UST shadow copy session");
1912 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1913 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1914 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1919 consumer_output_put(ua_sess
->consumer
);
1923 * Lookup sesison wrapper.
1926 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
1927 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1929 /* Get right UST app session from app */
1930 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1934 * Return ust app session from the app session hashtable using the UST session
1937 static struct ust_app_session
*lookup_session_by_app(
1938 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
1940 struct lttng_ht_iter iter
;
1941 struct lttng_ht_node_u64
*node
;
1943 __lookup_session_by_app(usess
, app
, &iter
);
1944 node
= lttng_ht_iter_get_node_u64(&iter
);
1949 return caa_container_of(node
, struct ust_app_session
, node
);
1956 * Setup buffer registry per PID for the given session and application. If none
1957 * is found, a new one is created, added to the global registry and
1958 * initialized. If regp is valid, it's set with the newly created object.
1960 * Return 0 on success or else a negative value.
1962 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1963 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1966 struct buffer_reg_pid
*reg_pid
;
1973 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1976 * This is the create channel path meaning that if there is NO
1977 * registry available, we have to create one for this session.
1979 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
1980 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1988 /* Initialize registry. */
1989 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1990 app
->bits_per_long
, app
->uint8_t_alignment
,
1991 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1992 app
->uint64_t_alignment
, app
->long_alignment
,
1993 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
1994 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
1995 ua_sess
->effective_credentials
.uid
,
1996 ua_sess
->effective_credentials
.gid
);
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
);
2066 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2067 * destroy the buffer registry, because it is always expected
2068 * that if the buffer registry can be found, its ust registry is
2071 buffer_reg_uid_destroy(reg_uid
, NULL
);
2074 /* Add node to teardown list of the session. */
2075 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2077 buffer_reg_uid_add(reg_uid
);
2079 DBG3("UST app buffer registry per UID created successfully");
2090 * Create a session on the tracer side for the given app.
2092 * On success, ua_sess_ptr is populated with the session pointer or else left
2093 * untouched. If the session was created, is_created is set to 1. On error,
2094 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2097 * Returns 0 on success or else a negative code which is either -ENOMEM or
2098 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2100 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2101 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2104 int ret
, created
= 0;
2105 struct ust_app_session
*ua_sess
;
2109 assert(ua_sess_ptr
);
2111 health_code_update();
2113 ua_sess
= lookup_session_by_app(usess
, app
);
2114 if (ua_sess
== NULL
) {
2115 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2116 app
->pid
, usess
->id
);
2117 ua_sess
= alloc_ust_app_session();
2118 if (ua_sess
== NULL
) {
2119 /* Only malloc can failed so something is really wrong */
2123 shadow_copy_session(ua_sess
, usess
, app
);
2127 switch (usess
->buffer_type
) {
2128 case LTTNG_BUFFER_PER_PID
:
2129 /* Init local registry. */
2130 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2132 delete_ust_app_session(-1, ua_sess
, app
);
2136 case LTTNG_BUFFER_PER_UID
:
2137 /* Look for a global registry. If none exists, create one. */
2138 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2140 delete_ust_app_session(-1, ua_sess
, app
);
2150 health_code_update();
2152 if (ua_sess
->handle
== -1) {
2153 pthread_mutex_lock(&app
->sock_lock
);
2154 ret
= ustctl_create_session(app
->sock
);
2155 pthread_mutex_unlock(&app
->sock_lock
);
2157 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2158 ERR("Creating session for app pid %d with ret %d",
2161 DBG("UST app creating session failed. Application is dead");
2163 * This is normal behavior, an application can die during the
2164 * creation process. Don't report an error so the execution can
2165 * continue normally. This will get flagged ENOTCONN and the
2166 * caller will handle it.
2170 delete_ust_app_session(-1, ua_sess
, app
);
2171 if (ret
!= -ENOMEM
) {
2173 * Tracer is probably gone or got an internal error so let's
2174 * behave like it will soon unregister or not usable.
2181 ua_sess
->handle
= ret
;
2183 /* Add ust app session to app's HT */
2184 lttng_ht_node_init_u64(&ua_sess
->node
,
2185 ua_sess
->tracing_id
);
2186 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2187 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2188 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2189 &ua_sess
->ust_objd_node
);
2191 DBG2("UST app session created successfully with handle %d", ret
);
2194 *ua_sess_ptr
= ua_sess
;
2196 *is_created
= created
;
2199 /* Everything went well. */
2203 health_code_update();
2208 * Match function for a hash table lookup of ust_app_ctx.
2210 * It matches an ust app context based on the context type and, in the case
2211 * of perf counters, their name.
2213 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2215 struct ust_app_ctx
*ctx
;
2216 const struct lttng_ust_context_attr
*key
;
2221 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2225 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2230 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2231 if (strncmp(key
->u
.perf_counter
.name
,
2232 ctx
->ctx
.u
.perf_counter
.name
,
2233 sizeof(key
->u
.perf_counter
.name
))) {
2237 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2238 if (strcmp(key
->u
.app_ctx
.provider_name
,
2239 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2240 strcmp(key
->u
.app_ctx
.ctx_name
,
2241 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2257 * Lookup for an ust app context from an lttng_ust_context.
2259 * Must be called while holding RCU read side lock.
2260 * Return an ust_app_ctx object or NULL on error.
2263 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2264 struct lttng_ust_context_attr
*uctx
)
2266 struct lttng_ht_iter iter
;
2267 struct lttng_ht_node_ulong
*node
;
2268 struct ust_app_ctx
*app_ctx
= NULL
;
2273 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2274 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2275 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2276 node
= lttng_ht_iter_get_node_ulong(&iter
);
2281 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2288 * Create a context for the channel on the tracer.
2290 * Called with UST app session lock held and a RCU read side lock.
2293 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2294 struct lttng_ust_context_attr
*uctx
,
2295 struct ust_app
*app
)
2298 struct ust_app_ctx
*ua_ctx
;
2300 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2302 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2308 ua_ctx
= alloc_ust_app_ctx(uctx
);
2309 if (ua_ctx
== NULL
) {
2315 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2316 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2317 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2319 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2329 * Enable on the tracer side a ust app event for the session and channel.
2331 * Called with UST app session lock held.
2334 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2335 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2339 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2344 ua_event
->enabled
= 1;
2351 * Disable on the tracer side a ust app event for the session and channel.
2353 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2354 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2358 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2363 ua_event
->enabled
= 0;
2370 * Lookup ust app channel for session and disable it on the tracer side.
2373 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2374 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2378 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2383 ua_chan
->enabled
= 0;
2390 * Lookup ust app channel for session and enable it on the tracer side. This
2391 * MUST be called with a RCU read side lock acquired.
2393 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2394 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2397 struct lttng_ht_iter iter
;
2398 struct lttng_ht_node_str
*ua_chan_node
;
2399 struct ust_app_channel
*ua_chan
;
2401 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2402 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2403 if (ua_chan_node
== NULL
) {
2404 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2405 uchan
->name
, ua_sess
->tracing_id
);
2409 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2411 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2421 * Ask the consumer to create a channel and get it if successful.
2423 * Called with UST app session lock held.
2425 * Return 0 on success or else a negative value.
2427 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2428 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2429 int bitness
, struct ust_registry_session
*registry
,
2430 uint64_t trace_archive_id
)
2433 unsigned int nb_fd
= 0;
2434 struct consumer_socket
*socket
;
2442 health_code_update();
2444 /* Get the right consumer socket for the application. */
2445 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2451 health_code_update();
2453 /* Need one fd for the channel. */
2454 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2456 ERR("Exhausted number of available FD upon create channel");
2461 * Ask consumer to create channel. The consumer will return the number of
2462 * stream we have to expect.
2464 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2465 registry
, usess
->current_trace_chunk
);
2471 * Compute the number of fd needed before receiving them. It must be 2 per
2472 * stream (2 being the default value here).
2474 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2476 /* Reserve the amount of file descriptor we need. */
2477 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2479 ERR("Exhausted number of available FD upon create channel");
2480 goto error_fd_get_stream
;
2483 health_code_update();
2486 * Now get the channel from the consumer. This call wil populate the stream
2487 * list of that channel and set the ust objects.
2489 if (usess
->consumer
->enabled
) {
2490 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2500 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2501 error_fd_get_stream
:
2503 * Initiate a destroy channel on the consumer since we had an error
2504 * handling it on our side. The return value is of no importance since we
2505 * already have a ret value set by the previous error that we need to
2508 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2510 lttng_fd_put(LTTNG_FD_APPS
, 1);
2512 health_code_update();
2518 * Duplicate the ust data object of the ust app stream and save it in the
2519 * buffer registry stream.
2521 * Return 0 on success or else a negative value.
2523 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2524 struct ust_app_stream
*stream
)
2531 /* Reserve the amount of file descriptor we need. */
2532 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2534 ERR("Exhausted number of available FD upon duplicate stream");
2538 /* Duplicate object for stream once the original is in the registry. */
2539 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2540 reg_stream
->obj
.ust
);
2542 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2543 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2544 lttng_fd_put(LTTNG_FD_APPS
, 2);
2547 stream
->handle
= stream
->obj
->handle
;
2554 * Duplicate the ust data object of the ust app. channel and save it in the
2555 * buffer registry channel.
2557 * Return 0 on success or else a negative value.
2559 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2560 struct ust_app_channel
*ua_chan
)
2567 /* Need two fds for the channel. */
2568 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2570 ERR("Exhausted number of available FD upon duplicate channel");
2574 /* Duplicate object for stream once the original is in the registry. */
2575 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2577 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2578 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2581 ua_chan
->handle
= ua_chan
->obj
->handle
;
2586 lttng_fd_put(LTTNG_FD_APPS
, 1);
2592 * For a given channel buffer registry, setup all streams of the given ust
2593 * application channel.
2595 * Return 0 on success or else a negative value.
2597 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2598 struct ust_app_channel
*ua_chan
,
2599 struct ust_app
*app
)
2602 struct ust_app_stream
*stream
, *stmp
;
2607 DBG2("UST app setup buffer registry stream");
2609 /* Send all streams to application. */
2610 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2611 struct buffer_reg_stream
*reg_stream
;
2613 ret
= buffer_reg_stream_create(®_stream
);
2619 * Keep original pointer and nullify it in the stream so the delete
2620 * stream call does not release the object.
2622 reg_stream
->obj
.ust
= stream
->obj
;
2624 buffer_reg_stream_add(reg_stream
, reg_chan
);
2626 /* We don't need the streams anymore. */
2627 cds_list_del(&stream
->list
);
2628 delete_ust_app_stream(-1, stream
, app
);
2636 * Create a buffer registry channel for the given session registry and
2637 * application channel object. If regp pointer is valid, it's set with the
2638 * created object. Important, the created object is NOT added to the session
2639 * registry hash table.
2641 * Return 0 on success else a negative value.
2643 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2644 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2647 struct buffer_reg_channel
*reg_chan
= NULL
;
2652 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2654 /* Create buffer registry channel. */
2655 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2660 reg_chan
->consumer_key
= ua_chan
->key
;
2661 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2662 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2664 /* Create and add a channel registry to session. */
2665 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2666 ua_chan
->tracing_channel_id
);
2670 buffer_reg_channel_add(reg_sess
, reg_chan
);
2679 /* Safe because the registry channel object was not added to any HT. */
2680 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2686 * Setup buffer registry channel for the given session registry and application
2687 * channel object. If regp pointer is valid, it's set with the created object.
2689 * Return 0 on success else a negative value.
2691 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2692 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2693 struct ust_app
*app
)
2700 assert(ua_chan
->obj
);
2702 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2704 /* Setup all streams for the registry. */
2705 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2710 reg_chan
->obj
.ust
= ua_chan
->obj
;
2711 ua_chan
->obj
= NULL
;
2716 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2717 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2722 * Send buffer registry channel to the application.
2724 * Return 0 on success else a negative value.
2726 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2727 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2728 struct ust_app_channel
*ua_chan
)
2731 struct buffer_reg_stream
*reg_stream
;
2738 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2740 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2745 /* Send channel to the application. */
2746 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2747 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2748 ret
= -ENOTCONN
; /* Caused by app exiting. */
2750 } else if (ret
< 0) {
2754 health_code_update();
2756 /* Send all streams to application. */
2757 pthread_mutex_lock(®_chan
->stream_list_lock
);
2758 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2759 struct ust_app_stream stream
;
2761 ret
= duplicate_stream_object(reg_stream
, &stream
);
2763 goto error_stream_unlock
;
2766 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2768 (void) release_ust_app_stream(-1, &stream
, app
);
2769 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2770 ret
= -ENOTCONN
; /* Caused by app exiting. */
2772 goto error_stream_unlock
;
2776 * The return value is not important here. This function will output an
2779 (void) release_ust_app_stream(-1, &stream
, app
);
2781 ua_chan
->is_sent
= 1;
2783 error_stream_unlock
:
2784 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2790 * Create and send to the application the created buffers with per UID buffers.
2792 * This MUST be called with a RCU read side lock acquired.
2793 * The session list lock and the session's lock must be acquired.
2795 * Return 0 on success else a negative value.
2797 static int create_channel_per_uid(struct ust_app
*app
,
2798 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2799 struct ust_app_channel
*ua_chan
)
2802 struct buffer_reg_uid
*reg_uid
;
2803 struct buffer_reg_channel
*reg_chan
;
2804 struct ltt_session
*session
= NULL
;
2805 enum lttng_error_code notification_ret
;
2806 struct ust_registry_channel
*chan_reg
;
2813 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2815 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2817 * The session creation handles the creation of this global registry
2818 * object. If none can be find, there is a code flow problem or a
2823 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2829 /* Create the buffer registry channel object. */
2830 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2832 ERR("Error creating the UST channel \"%s\" registry instance",
2837 session
= session_find_by_id(ua_sess
->tracing_id
);
2839 assert(pthread_mutex_trylock(&session
->lock
));
2840 assert(session_trylock_list());
2843 * Create the buffers on the consumer side. This call populates the
2844 * ust app channel object with all streams and data object.
2846 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2847 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
2848 session
->most_recent_chunk_id
.value
);
2850 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2854 * Let's remove the previously created buffer registry channel so
2855 * it's not visible anymore in the session registry.
2857 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2858 ua_chan
->tracing_channel_id
, false);
2859 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2860 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2865 * Setup the streams and add it to the session registry.
2867 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2868 ua_chan
, reg_chan
, app
);
2870 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
2874 /* Notify the notification subsystem of the channel's creation. */
2875 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
2876 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
2877 ua_chan
->tracing_channel_id
);
2879 chan_reg
->consumer_key
= ua_chan
->key
;
2881 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
2883 notification_ret
= notification_thread_command_add_channel(
2884 notification_thread_handle
, session
->name
,
2885 ua_sess
->effective_credentials
.uid
,
2886 ua_sess
->effective_credentials
.gid
, ua_chan
->name
,
2887 ua_chan
->key
, LTTNG_DOMAIN_UST
,
2888 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2889 if (notification_ret
!= LTTNG_OK
) {
2890 ret
= - (int) notification_ret
;
2891 ERR("Failed to add channel to notification thread");
2896 /* Send buffers to the application. */
2897 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2899 if (ret
!= -ENOTCONN
) {
2900 ERR("Error sending channel to application");
2907 session_put(session
);
2913 * Create and send to the application the created buffers with per PID buffers.
2915 * Called with UST app session lock held.
2916 * The session list lock and the session's lock must be acquired.
2918 * Return 0 on success else a negative value.
2920 static int create_channel_per_pid(struct ust_app
*app
,
2921 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2922 struct ust_app_channel
*ua_chan
)
2925 struct ust_registry_session
*registry
;
2926 enum lttng_error_code cmd_ret
;
2927 struct ltt_session
*session
= NULL
;
2928 uint64_t chan_reg_key
;
2929 struct ust_registry_channel
*chan_reg
;
2936 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2940 registry
= get_session_registry(ua_sess
);
2941 /* The UST app session lock is held, registry shall not be null. */
2944 /* Create and add a new channel registry to session. */
2945 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2947 ERR("Error creating the UST channel \"%s\" registry instance",
2952 session
= session_find_by_id(ua_sess
->tracing_id
);
2955 assert(pthread_mutex_trylock(&session
->lock
));
2956 assert(session_trylock_list());
2958 /* Create and get channel on the consumer side. */
2959 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2960 app
->bits_per_long
, registry
,
2961 session
->most_recent_chunk_id
.value
);
2963 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2965 goto error_remove_from_registry
;
2968 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2970 if (ret
!= -ENOTCONN
) {
2971 ERR("Error sending channel to application");
2973 goto error_remove_from_registry
;
2976 chan_reg_key
= ua_chan
->key
;
2977 pthread_mutex_lock(®istry
->lock
);
2978 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
2980 chan_reg
->consumer_key
= ua_chan
->key
;
2981 pthread_mutex_unlock(®istry
->lock
);
2983 cmd_ret
= notification_thread_command_add_channel(
2984 notification_thread_handle
, session
->name
,
2985 ua_sess
->effective_credentials
.uid
,
2986 ua_sess
->effective_credentials
.gid
, ua_chan
->name
,
2987 ua_chan
->key
, LTTNG_DOMAIN_UST
,
2988 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2989 if (cmd_ret
!= LTTNG_OK
) {
2990 ret
= - (int) cmd_ret
;
2991 ERR("Failed to add channel to notification thread");
2992 goto error_remove_from_registry
;
2995 error_remove_from_registry
:
2997 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3002 session_put(session
);
3008 * From an already allocated ust app channel, create the channel buffers if
3009 * needed and send them to the application. This MUST be called with a RCU read
3010 * side lock acquired.
3012 * Called with UST app session lock held.
3014 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3015 * the application exited concurrently.
3017 static int ust_app_channel_send(struct ust_app
*app
,
3018 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3019 struct ust_app_channel
*ua_chan
)
3025 assert(usess
->active
);
3029 /* Handle buffer type before sending the channel to the application. */
3030 switch (usess
->buffer_type
) {
3031 case LTTNG_BUFFER_PER_UID
:
3033 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3039 case LTTNG_BUFFER_PER_PID
:
3041 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3053 /* Initialize ust objd object using the received handle and add it. */
3054 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3055 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3057 /* If channel is not enabled, disable it on the tracer */
3058 if (!ua_chan
->enabled
) {
3059 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3070 * Create UST app channel and return it through ua_chanp if not NULL.
3072 * Called with UST app session lock and RCU read-side lock held.
3074 * Return 0 on success or else a negative value.
3076 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3077 struct ltt_ust_channel
*uchan
,
3078 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3079 struct ust_app_channel
**ua_chanp
)
3082 struct lttng_ht_iter iter
;
3083 struct lttng_ht_node_str
*ua_chan_node
;
3084 struct ust_app_channel
*ua_chan
;
3086 /* Lookup channel in the ust app session */
3087 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3088 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3089 if (ua_chan_node
!= NULL
) {
3090 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3094 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3095 if (ua_chan
== NULL
) {
3096 /* Only malloc can fail here */
3100 shadow_copy_channel(ua_chan
, uchan
);
3102 /* Set channel type. */
3103 ua_chan
->attr
.type
= type
;
3105 /* Only add the channel if successful on the tracer side. */
3106 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3109 *ua_chanp
= ua_chan
;
3112 /* Everything went well. */
3120 * Create UST app event and create it on the tracer side.
3122 * Called with ust app session mutex held.
3125 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3126 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3127 struct ust_app
*app
)
3130 struct ust_app_event
*ua_event
;
3132 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3133 if (ua_event
== NULL
) {
3134 /* Only malloc can failed so something is really wrong */
3138 shadow_copy_event(ua_event
, uevent
);
3140 /* Create it on the tracer side */
3141 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3143 /* Not found previously means that it does not exist on the tracer */
3144 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
3148 add_unique_ust_app_event(ua_chan
, ua_event
);
3150 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3157 /* Valid. Calling here is already in a read side lock */
3158 delete_ust_app_event(-1, ua_event
, app
);
3163 * Create UST metadata and open it on the tracer side.
3165 * Called with UST app session lock held and RCU read side lock.
3167 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3168 struct ust_app
*app
, struct consumer_output
*consumer
)
3171 struct ust_app_channel
*metadata
;
3172 struct consumer_socket
*socket
;
3173 struct ust_registry_session
*registry
;
3174 struct ltt_session
*session
= NULL
;
3180 registry
= get_session_registry(ua_sess
);
3181 /* The UST app session is held registry shall not be null. */
3184 pthread_mutex_lock(®istry
->lock
);
3186 /* Metadata already exists for this registry or it was closed previously */
3187 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3192 /* Allocate UST metadata */
3193 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3195 /* malloc() failed */
3200 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3202 /* Need one fd for the channel. */
3203 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3205 ERR("Exhausted number of available FD upon create metadata");
3209 /* Get the right consumer socket for the application. */
3210 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3213 goto error_consumer
;
3217 * Keep metadata key so we can identify it on the consumer side. Assign it
3218 * to the registry *before* we ask the consumer so we avoid the race of the
3219 * consumer requesting the metadata and the ask_channel call on our side
3220 * did not returned yet.
3222 registry
->metadata_key
= metadata
->key
;
3224 session
= session_find_by_id(ua_sess
->tracing_id
);
3227 assert(pthread_mutex_trylock(&session
->lock
));
3228 assert(session_trylock_list());
3231 * Ask the metadata channel creation to the consumer. The metadata object
3232 * will be created by the consumer and kept their. However, the stream is
3233 * never added or monitored until we do a first push metadata to the
3236 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3237 registry
, session
->current_trace_chunk
);
3239 /* Nullify the metadata key so we don't try to close it later on. */
3240 registry
->metadata_key
= 0;
3241 goto error_consumer
;
3245 * The setup command will make the metadata stream be sent to the relayd,
3246 * if applicable, and the thread managing the metadatas. This is important
3247 * because after this point, if an error occurs, the only way the stream
3248 * can be deleted is to be monitored in the consumer.
3250 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3252 /* Nullify the metadata key so we don't try to close it later on. */
3253 registry
->metadata_key
= 0;
3254 goto error_consumer
;
3257 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3258 metadata
->key
, app
->pid
);
3261 lttng_fd_put(LTTNG_FD_APPS
, 1);
3262 delete_ust_app_channel(-1, metadata
, app
);
3264 pthread_mutex_unlock(®istry
->lock
);
3266 session_put(session
);
3272 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3273 * acquired before calling this function.
3275 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3277 struct ust_app
*app
= NULL
;
3278 struct lttng_ht_node_ulong
*node
;
3279 struct lttng_ht_iter iter
;
3281 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3282 node
= lttng_ht_iter_get_node_ulong(&iter
);
3284 DBG2("UST app no found with pid %d", pid
);
3288 DBG2("Found UST app by pid %d", pid
);
3290 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3297 * Allocate and init an UST app object using the registration information and
3298 * the command socket. This is called when the command socket connects to the
3301 * The object is returned on success or else NULL.
3303 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3305 struct ust_app
*lta
= NULL
;
3310 DBG3("UST app creating application for socket %d", sock
);
3312 if ((msg
->bits_per_long
== 64 &&
3313 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3314 || (msg
->bits_per_long
== 32 &&
3315 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3316 ERR("Registration failed: application \"%s\" (pid: %d) has "
3317 "%d-bit long, but no consumerd for this size is available.\n",
3318 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3322 lta
= zmalloc(sizeof(struct ust_app
));
3328 lta
->ppid
= msg
->ppid
;
3329 lta
->uid
= msg
->uid
;
3330 lta
->gid
= msg
->gid
;
3332 lta
->bits_per_long
= msg
->bits_per_long
;
3333 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3334 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3335 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3336 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3337 lta
->long_alignment
= msg
->long_alignment
;
3338 lta
->byte_order
= msg
->byte_order
;
3340 lta
->v_major
= msg
->major
;
3341 lta
->v_minor
= msg
->minor
;
3342 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3343 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3344 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3345 lta
->notify_sock
= -1;
3347 /* Copy name and make sure it's NULL terminated. */
3348 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3349 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3352 * Before this can be called, when receiving the registration information,
3353 * the application compatibility is checked. So, at this point, the
3354 * application can work with this session daemon.
3356 lta
->compatible
= 1;
3358 lta
->pid
= msg
->pid
;
3359 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3361 pthread_mutex_init(<a
->sock_lock
, NULL
);
3362 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3364 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3370 * For a given application object, add it to every hash table.
3372 void ust_app_add(struct ust_app
*app
)
3375 assert(app
->notify_sock
>= 0);
3377 app
->registration_time
= time(NULL
);
3382 * On a re-registration, we want to kick out the previous registration of
3385 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3388 * The socket _should_ be unique until _we_ call close. So, a add_unique
3389 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3390 * already in the table.
3392 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3394 /* Add application to the notify socket hash table. */
3395 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3396 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3398 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3399 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3400 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3407 * Set the application version into the object.
3409 * Return 0 on success else a negative value either an errno code or a
3410 * LTTng-UST error code.
3412 int ust_app_version(struct ust_app
*app
)
3418 pthread_mutex_lock(&app
->sock_lock
);
3419 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3420 pthread_mutex_unlock(&app
->sock_lock
);
3422 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3423 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3425 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3433 * Unregister app by removing it from the global traceable app list and freeing
3436 * The socket is already closed at this point so no close to sock.
3438 void ust_app_unregister(int sock
)
3440 struct ust_app
*lta
;
3441 struct lttng_ht_node_ulong
*node
;
3442 struct lttng_ht_iter ust_app_sock_iter
;
3443 struct lttng_ht_iter iter
;
3444 struct ust_app_session
*ua_sess
;
3449 /* Get the node reference for a call_rcu */
3450 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3451 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3454 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3455 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3458 * For per-PID buffers, perform "push metadata" and flush all
3459 * application streams before removing app from hash tables,
3460 * ensuring proper behavior of data_pending check.
3461 * Remove sessions so they are not visible during deletion.
3463 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3465 struct ust_registry_session
*registry
;
3467 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3469 /* The session was already removed so scheduled for teardown. */
3473 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3474 (void) ust_app_flush_app_session(lta
, ua_sess
);
3478 * Add session to list for teardown. This is safe since at this point we
3479 * are the only one using this list.
3481 pthread_mutex_lock(&ua_sess
->lock
);
3483 if (ua_sess
->deleted
) {
3484 pthread_mutex_unlock(&ua_sess
->lock
);
3489 * Normally, this is done in the delete session process which is
3490 * executed in the call rcu below. However, upon registration we can't
3491 * afford to wait for the grace period before pushing data or else the
3492 * data pending feature can race between the unregistration and stop
3493 * command where the data pending command is sent *before* the grace
3496 * The close metadata below nullifies the metadata pointer in the
3497 * session so the delete session will NOT push/close a second time.
3499 registry
= get_session_registry(ua_sess
);
3501 /* Push metadata for application before freeing the application. */
3502 (void) push_metadata(registry
, ua_sess
->consumer
);
3505 * Don't ask to close metadata for global per UID buffers. Close
3506 * metadata only on destroy trace session in this case. Also, the
3507 * previous push metadata could have flag the metadata registry to
3508 * close so don't send a close command if closed.
3510 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3511 /* And ask to close it for this session registry. */
3512 (void) close_metadata(registry
, ua_sess
->consumer
);
3515 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3517 pthread_mutex_unlock(&ua_sess
->lock
);
3520 /* Remove application from PID hash table */
3521 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3525 * Remove application from notify hash table. The thread handling the
3526 * notify socket could have deleted the node so ignore on error because
3527 * either way it's valid. The close of that socket is handled by the
3528 * apps_notify_thread.
3530 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3531 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3534 * Ignore return value since the node might have been removed before by an
3535 * add replace during app registration because the PID can be reassigned by
3538 iter
.iter
.node
= <a
->pid_n
.node
;
3539 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3541 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3546 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3553 * Fill events array with all events name of all registered apps.
3555 int ust_app_list_events(struct lttng_event
**events
)
3558 size_t nbmem
, count
= 0;
3559 struct lttng_ht_iter iter
;
3560 struct ust_app
*app
;
3561 struct lttng_event
*tmp_event
;
3563 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3564 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3565 if (tmp_event
== NULL
) {
3566 PERROR("zmalloc ust app events");
3573 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3574 struct lttng_ust_tracepoint_iter uiter
;
3576 health_code_update();
3578 if (!app
->compatible
) {
3580 * TODO: In time, we should notice the caller of this error by
3581 * telling him that this is a version error.
3585 pthread_mutex_lock(&app
->sock_lock
);
3586 handle
= ustctl_tracepoint_list(app
->sock
);
3588 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3589 ERR("UST app list events getting handle failed for app pid %d",
3592 pthread_mutex_unlock(&app
->sock_lock
);
3596 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3597 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3598 /* Handle ustctl error. */
3602 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3603 ERR("UST app tp list get failed for app %d with ret %d",
3606 DBG3("UST app tp list get failed. Application is dead");
3608 * This is normal behavior, an application can die during the
3609 * creation process. Don't report an error so the execution can
3610 * continue normally. Continue normal execution.
3615 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3616 if (release_ret
< 0 &&
3617 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3618 release_ret
!= -EPIPE
) {
3619 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3621 pthread_mutex_unlock(&app
->sock_lock
);
3625 health_code_update();
3626 if (count
>= nbmem
) {
3627 /* In case the realloc fails, we free the memory */
3628 struct lttng_event
*new_tmp_event
;
3631 new_nbmem
= nbmem
<< 1;
3632 DBG2("Reallocating event list from %zu to %zu entries",
3634 new_tmp_event
= realloc(tmp_event
,
3635 new_nbmem
* sizeof(struct lttng_event
));
3636 if (new_tmp_event
== NULL
) {
3639 PERROR("realloc ust app events");
3642 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3643 if (release_ret
< 0 &&
3644 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3645 release_ret
!= -EPIPE
) {
3646 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3648 pthread_mutex_unlock(&app
->sock_lock
);
3651 /* Zero the new memory */
3652 memset(new_tmp_event
+ nbmem
, 0,
3653 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3655 tmp_event
= new_tmp_event
;
3657 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3658 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3659 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3660 tmp_event
[count
].pid
= app
->pid
;
3661 tmp_event
[count
].enabled
= -1;
3664 ret
= ustctl_release_handle(app
->sock
, handle
);
3665 pthread_mutex_unlock(&app
->sock_lock
);
3666 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3667 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3672 *events
= tmp_event
;
3674 DBG2("UST app list events done (%zu events)", count
);
3679 health_code_update();
3684 * Fill events array with all events name of all registered apps.
3686 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3689 size_t nbmem
, count
= 0;
3690 struct lttng_ht_iter iter
;
3691 struct ust_app
*app
;
3692 struct lttng_event_field
*tmp_event
;
3694 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3695 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3696 if (tmp_event
== NULL
) {
3697 PERROR("zmalloc ust app event fields");
3704 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3705 struct lttng_ust_field_iter uiter
;
3707 health_code_update();
3709 if (!app
->compatible
) {
3711 * TODO: In time, we should notice the caller of this error by
3712 * telling him that this is a version error.
3716 pthread_mutex_lock(&app
->sock_lock
);
3717 handle
= ustctl_tracepoint_field_list(app
->sock
);
3719 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3720 ERR("UST app list field getting handle failed for app pid %d",
3723 pthread_mutex_unlock(&app
->sock_lock
);
3727 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3728 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3729 /* Handle ustctl error. */
3733 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3734 ERR("UST app tp list field failed for app %d with ret %d",
3737 DBG3("UST app tp list field failed. Application is dead");
3739 * This is normal behavior, an application can die during the
3740 * creation process. Don't report an error so the execution can
3741 * continue normally. Reset list and count for next app.
3746 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3747 pthread_mutex_unlock(&app
->sock_lock
);
3748 if (release_ret
< 0 &&
3749 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3750 release_ret
!= -EPIPE
) {
3751 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3756 health_code_update();
3757 if (count
>= nbmem
) {
3758 /* In case the realloc fails, we free the memory */
3759 struct lttng_event_field
*new_tmp_event
;
3762 new_nbmem
= nbmem
<< 1;
3763 DBG2("Reallocating event field list from %zu to %zu entries",
3765 new_tmp_event
= realloc(tmp_event
,
3766 new_nbmem
* sizeof(struct lttng_event_field
));
3767 if (new_tmp_event
== NULL
) {
3770 PERROR("realloc ust app event fields");
3773 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3774 pthread_mutex_unlock(&app
->sock_lock
);
3776 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3777 release_ret
!= -EPIPE
) {
3778 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3782 /* Zero the new memory */
3783 memset(new_tmp_event
+ nbmem
, 0,
3784 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3786 tmp_event
= new_tmp_event
;
3789 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3790 /* Mapping between these enums matches 1 to 1. */
3791 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3792 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3794 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3795 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3796 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3797 tmp_event
[count
].event
.pid
= app
->pid
;
3798 tmp_event
[count
].event
.enabled
= -1;
3801 ret
= ustctl_release_handle(app
->sock
, handle
);
3802 pthread_mutex_unlock(&app
->sock_lock
);
3804 ret
!= -LTTNG_UST_ERR_EXITING
&&
3806 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3811 *fields
= tmp_event
;
3813 DBG2("UST app list event fields done (%zu events)", count
);
3818 health_code_update();
3823 * Free and clean all traceable apps of the global list.
3825 * Should _NOT_ be called with RCU read-side lock held.
3827 void ust_app_clean_list(void)
3830 struct ust_app
*app
;
3831 struct lttng_ht_iter iter
;
3833 DBG2("UST app cleaning registered apps hash table");
3837 /* Cleanup notify socket hash table */
3838 if (ust_app_ht_by_notify_sock
) {
3839 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3840 notify_sock_n
.node
) {
3841 struct cds_lfht_node
*node
;
3842 struct ust_app
*app
;
3844 node
= cds_lfht_iter_get_node(&iter
.iter
);
3849 app
= container_of(node
, struct ust_app
,
3850 notify_sock_n
.node
);
3851 ust_app_notify_sock_unregister(app
->notify_sock
);
3856 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3857 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3859 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3863 /* Cleanup socket hash table */
3864 if (ust_app_ht_by_sock
) {
3865 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3867 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3874 /* Destroy is done only when the ht is empty */
3876 ht_cleanup_push(ust_app_ht
);
3878 if (ust_app_ht_by_sock
) {
3879 ht_cleanup_push(ust_app_ht_by_sock
);
3881 if (ust_app_ht_by_notify_sock
) {
3882 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3887 * Init UST app hash table.
3889 int ust_app_ht_alloc(void)
3891 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3895 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3896 if (!ust_app_ht_by_sock
) {
3899 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3900 if (!ust_app_ht_by_notify_sock
) {
3907 * For a specific UST session, disable the channel for all registered apps.
3909 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3910 struct ltt_ust_channel
*uchan
)
3913 struct lttng_ht_iter iter
;
3914 struct lttng_ht_node_str
*ua_chan_node
;
3915 struct ust_app
*app
;
3916 struct ust_app_session
*ua_sess
;
3917 struct ust_app_channel
*ua_chan
;
3919 assert(usess
->active
);
3920 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3921 uchan
->name
, usess
->id
);
3925 /* For every registered applications */
3926 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3927 struct lttng_ht_iter uiter
;
3928 if (!app
->compatible
) {
3930 * TODO: In time, we should notice the caller of this error by
3931 * telling him that this is a version error.
3935 ua_sess
= lookup_session_by_app(usess
, app
);
3936 if (ua_sess
== NULL
) {
3941 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3942 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3943 /* If the session if found for the app, the channel must be there */
3944 assert(ua_chan_node
);
3946 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3947 /* The channel must not be already disabled */
3948 assert(ua_chan
->enabled
== 1);
3950 /* Disable channel onto application */
3951 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3953 /* XXX: We might want to report this error at some point... */
3963 * For a specific UST session, enable the channel for all registered apps.
3965 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3966 struct ltt_ust_channel
*uchan
)
3969 struct lttng_ht_iter iter
;
3970 struct ust_app
*app
;
3971 struct ust_app_session
*ua_sess
;
3973 assert(usess
->active
);
3974 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3975 uchan
->name
, usess
->id
);
3979 /* For every registered applications */
3980 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3981 if (!app
->compatible
) {
3983 * TODO: In time, we should notice the caller of this error by
3984 * telling him that this is a version error.
3988 ua_sess
= lookup_session_by_app(usess
, app
);
3989 if (ua_sess
== NULL
) {
3993 /* Enable channel onto application */
3994 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3996 /* XXX: We might want to report this error at some point... */
4006 * Disable an event in a channel and for a specific session.
4008 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4009 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4012 struct lttng_ht_iter iter
, uiter
;
4013 struct lttng_ht_node_str
*ua_chan_node
;
4014 struct ust_app
*app
;
4015 struct ust_app_session
*ua_sess
;
4016 struct ust_app_channel
*ua_chan
;
4017 struct ust_app_event
*ua_event
;
4019 assert(usess
->active
);
4020 DBG("UST app disabling event %s for all apps in channel "
4021 "%s for session id %" PRIu64
,
4022 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4026 /* For all registered applications */
4027 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4028 if (!app
->compatible
) {
4030 * TODO: In time, we should notice the caller of this error by
4031 * telling him that this is a version error.
4035 ua_sess
= lookup_session_by_app(usess
, app
);
4036 if (ua_sess
== NULL
) {
4041 /* Lookup channel in the ust app session */
4042 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4043 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4044 if (ua_chan_node
== NULL
) {
4045 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4046 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4049 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4051 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4052 uevent
->filter
, uevent
->attr
.loglevel
,
4054 if (ua_event
== NULL
) {
4055 DBG2("Event %s not found in channel %s for app pid %d."
4056 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4060 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4062 /* XXX: Report error someday... */
4071 /* The ua_sess lock must be held by the caller. */
4073 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4074 struct ust_app_session
*ua_sess
,
4075 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4076 struct ust_app_channel
**_ua_chan
)
4079 struct ust_app_channel
*ua_chan
= NULL
;
4082 ASSERT_LOCKED(ua_sess
->lock
);
4084 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4085 sizeof(uchan
->name
))) {
4086 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4090 struct ltt_ust_context
*uctx
= NULL
;
4093 * Create channel onto application and synchronize its
4096 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4097 LTTNG_UST_CHAN_PER_CPU
, usess
,
4100 ret
= ust_app_channel_send(app
, usess
,
4107 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4108 ret
= create_ust_app_channel_context(ua_chan
,
4119 * The application's socket is not valid. Either a bad socket
4120 * or a timeout on it. We can't inform the caller that for a
4121 * specific app, the session failed so lets continue here.
4123 ret
= 0; /* Not an error. */
4131 if (ret
== 0 && _ua_chan
) {
4133 * Only return the application's channel on success. Note
4134 * that the channel can still be part of the application's
4135 * channel hashtable on error.
4137 *_ua_chan
= ua_chan
;
4143 * For a specific UST session, create the channel for all registered apps.
4145 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
4146 struct ltt_ust_channel
*uchan
)
4149 struct cds_lfht_iter iter
;
4150 struct ust_app
*app
;
4153 assert(usess
->active
);
4156 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
4157 uchan
->name
, usess
->id
);
4160 /* For every registered applications */
4161 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
, app
, pid_n
.node
) {
4162 struct ust_app_session
*ua_sess
;
4163 int session_was_created
= 0;
4165 if (!app
->compatible
||
4166 !trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
4167 goto error_rcu_unlock
;
4171 * Create session on the tracer side and add it to app session HT. Note
4172 * that if session exist, it will simply return a pointer to the ust
4175 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
,
4176 &session_was_created
);
4181 * The application's socket is not valid. Either a bad
4182 * socket or a timeout on it. We can't inform the caller
4183 * that for a specific app, the session failed so lets
4184 * continue here; it is not an error.
4187 goto error_rcu_unlock
;
4190 goto error_rcu_unlock
;
4194 if (ua_sess
->deleted
) {
4197 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, NULL
);
4199 if (session_was_created
) {
4200 destroy_app_session(app
, ua_sess
);
4202 goto error_rcu_unlock
;
4212 * Enable event for a specific session and channel on the tracer.
4214 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4215 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4218 struct lttng_ht_iter iter
, uiter
;
4219 struct lttng_ht_node_str
*ua_chan_node
;
4220 struct ust_app
*app
;
4221 struct ust_app_session
*ua_sess
;
4222 struct ust_app_channel
*ua_chan
;
4223 struct ust_app_event
*ua_event
;
4225 assert(usess
->active
);
4226 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4227 uevent
->attr
.name
, usess
->id
);
4230 * NOTE: At this point, this function is called only if the session and
4231 * channel passed are already created for all apps. and enabled on the
4237 /* For all registered applications */
4238 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4239 if (!app
->compatible
) {
4241 * TODO: In time, we should notice the caller of this error by
4242 * telling him that this is a version error.
4246 ua_sess
= lookup_session_by_app(usess
, app
);
4248 /* The application has problem or is probably dead. */
4252 pthread_mutex_lock(&ua_sess
->lock
);
4254 if (ua_sess
->deleted
) {
4255 pthread_mutex_unlock(&ua_sess
->lock
);
4259 /* Lookup channel in the ust app session */
4260 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4261 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4263 * It is possible that the channel cannot be found is
4264 * the channel/event creation occurs concurrently with
4265 * an application exit.
4267 if (!ua_chan_node
) {
4268 pthread_mutex_unlock(&ua_sess
->lock
);
4272 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4274 /* Get event node */
4275 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4276 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4277 if (ua_event
== NULL
) {
4278 DBG3("UST app enable event %s not found for app PID %d."
4279 "Skipping app", uevent
->attr
.name
, app
->pid
);
4283 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4285 pthread_mutex_unlock(&ua_sess
->lock
);
4289 pthread_mutex_unlock(&ua_sess
->lock
);
4298 * For a specific existing UST session and UST channel, creates the event for
4299 * all registered apps.
4301 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4302 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4305 struct lttng_ht_iter iter
, uiter
;
4306 struct lttng_ht_node_str
*ua_chan_node
;
4307 struct ust_app
*app
;
4308 struct ust_app_session
*ua_sess
;
4309 struct ust_app_channel
*ua_chan
;
4311 assert(usess
->active
);
4312 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4313 uevent
->attr
.name
, usess
->id
);
4317 /* For all registered applications */
4318 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4319 if (!app
->compatible
) {
4321 * TODO: In time, we should notice the caller of this error by
4322 * telling him that this is a version error.
4326 ua_sess
= lookup_session_by_app(usess
, app
);
4328 /* The application has problem or is probably dead. */
4332 pthread_mutex_lock(&ua_sess
->lock
);
4334 if (ua_sess
->deleted
) {
4335 pthread_mutex_unlock(&ua_sess
->lock
);
4339 /* Lookup channel in the ust app session */
4340 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4341 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4342 /* If the channel is not found, there is a code flow error */
4343 assert(ua_chan_node
);
4345 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4347 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4348 pthread_mutex_unlock(&ua_sess
->lock
);
4350 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4351 /* Possible value at this point: -ENOMEM. If so, we stop! */
4354 DBG2("UST app event %s already exist on app PID %d",
4355 uevent
->attr
.name
, app
->pid
);
4365 * Start tracing for a specific UST session and app.
4367 * Called with UST app session lock held.
4371 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4374 struct ust_app_session
*ua_sess
;
4376 DBG("Starting tracing for ust app pid %d", app
->pid
);
4380 if (!app
->compatible
) {
4384 ua_sess
= lookup_session_by_app(usess
, app
);
4385 if (ua_sess
== NULL
) {
4386 /* The session is in teardown process. Ignore and continue. */
4390 pthread_mutex_lock(&ua_sess
->lock
);
4392 if (ua_sess
->deleted
) {
4393 pthread_mutex_unlock(&ua_sess
->lock
);
4397 /* Upon restart, we skip the setup, already done */
4398 if (ua_sess
->started
) {
4403 * Create the metadata for the application. This returns gracefully if a
4404 * metadata was already set for the session.
4406 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4411 health_code_update();
4414 /* This start the UST tracing */
4415 pthread_mutex_lock(&app
->sock_lock
);
4416 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4417 pthread_mutex_unlock(&app
->sock_lock
);
4419 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4420 ERR("Error starting tracing for app pid: %d (ret: %d)",
4423 DBG("UST app start session failed. Application is dead.");
4425 * This is normal behavior, an application can die during the
4426 * creation process. Don't report an error so the execution can
4427 * continue normally.
4429 pthread_mutex_unlock(&ua_sess
->lock
);
4435 /* Indicate that the session has been started once */
4436 ua_sess
->started
= 1;
4438 pthread_mutex_unlock(&ua_sess
->lock
);
4440 health_code_update();
4442 /* Quiescent wait after starting trace */
4443 pthread_mutex_lock(&app
->sock_lock
);
4444 ret
= ustctl_wait_quiescent(app
->sock
);
4445 pthread_mutex_unlock(&app
->sock_lock
);
4446 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4447 ERR("UST app wait quiescent failed for app pid %d ret %d",
4453 health_code_update();
4457 pthread_mutex_unlock(&ua_sess
->lock
);
4459 health_code_update();
4464 * Stop tracing for a specific UST session and app.
4467 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4470 struct ust_app_session
*ua_sess
;
4471 struct ust_registry_session
*registry
;
4473 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4477 if (!app
->compatible
) {
4478 goto end_no_session
;
4481 ua_sess
= lookup_session_by_app(usess
, app
);
4482 if (ua_sess
== NULL
) {
4483 goto end_no_session
;
4486 pthread_mutex_lock(&ua_sess
->lock
);
4488 if (ua_sess
->deleted
) {
4489 pthread_mutex_unlock(&ua_sess
->lock
);
4490 goto end_no_session
;
4494 * If started = 0, it means that stop trace has been called for a session
4495 * that was never started. It's possible since we can have a fail start
4496 * from either the application manager thread or the command thread. Simply
4497 * indicate that this is a stop error.
4499 if (!ua_sess
->started
) {
4500 goto error_rcu_unlock
;
4503 health_code_update();
4505 /* This inhibits UST tracing */
4506 pthread_mutex_lock(&app
->sock_lock
);
4507 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4508 pthread_mutex_unlock(&app
->sock_lock
);
4510 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4511 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4514 DBG("UST app stop session failed. Application is dead.");
4516 * This is normal behavior, an application can die during the
4517 * creation process. Don't report an error so the execution can
4518 * continue normally.
4522 goto error_rcu_unlock
;
4525 health_code_update();
4527 /* Quiescent wait after stopping trace */
4528 pthread_mutex_lock(&app
->sock_lock
);
4529 ret
= ustctl_wait_quiescent(app
->sock
);
4530 pthread_mutex_unlock(&app
->sock_lock
);
4531 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4532 ERR("UST app wait quiescent failed for app pid %d ret %d",
4536 health_code_update();
4538 registry
= get_session_registry(ua_sess
);
4540 /* The UST app session is held registry shall not be null. */
4543 /* Push metadata for application before freeing the application. */
4544 (void) push_metadata(registry
, ua_sess
->consumer
);
4547 pthread_mutex_unlock(&ua_sess
->lock
);
4550 health_code_update();
4554 pthread_mutex_unlock(&ua_sess
->lock
);
4556 health_code_update();
4561 int ust_app_flush_app_session(struct ust_app
*app
,
4562 struct ust_app_session
*ua_sess
)
4564 int ret
, retval
= 0;
4565 struct lttng_ht_iter iter
;
4566 struct ust_app_channel
*ua_chan
;
4567 struct consumer_socket
*socket
;
4569 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4573 if (!app
->compatible
) {
4574 goto end_not_compatible
;
4577 pthread_mutex_lock(&ua_sess
->lock
);
4579 if (ua_sess
->deleted
) {
4583 health_code_update();
4585 /* Flushing buffers */
4586 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4589 /* Flush buffers and push metadata. */
4590 switch (ua_sess
->buffer_type
) {
4591 case LTTNG_BUFFER_PER_PID
:
4592 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4594 health_code_update();
4595 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4597 ERR("Error flushing consumer channel");
4603 case LTTNG_BUFFER_PER_UID
:
4609 health_code_update();
4612 pthread_mutex_unlock(&ua_sess
->lock
);
4616 health_code_update();
4621 * Flush buffers for all applications for a specific UST session.
4622 * Called with UST session lock held.
4625 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4630 DBG("Flushing session buffers for all ust apps");
4634 /* Flush buffers and push metadata. */
4635 switch (usess
->buffer_type
) {
4636 case LTTNG_BUFFER_PER_UID
:
4638 struct buffer_reg_uid
*reg
;
4639 struct lttng_ht_iter iter
;
4641 /* Flush all per UID buffers associated to that session. */
4642 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4643 struct ust_registry_session
*ust_session_reg
;
4644 struct buffer_reg_channel
*reg_chan
;
4645 struct consumer_socket
*socket
;
4647 /* Get consumer socket to use to push the metadata.*/
4648 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4651 /* Ignore request if no consumer is found for the session. */
4655 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4656 reg_chan
, node
.node
) {
4658 * The following call will print error values so the return
4659 * code is of little importance because whatever happens, we
4660 * have to try them all.
4662 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4665 ust_session_reg
= reg
->registry
->reg
.ust
;
4666 /* Push metadata. */
4667 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4671 case LTTNG_BUFFER_PER_PID
:
4673 struct ust_app_session
*ua_sess
;
4674 struct lttng_ht_iter iter
;
4675 struct ust_app
*app
;
4677 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4678 ua_sess
= lookup_session_by_app(usess
, app
);
4679 if (ua_sess
== NULL
) {
4682 (void) ust_app_flush_app_session(app
, ua_sess
);
4693 health_code_update();
4698 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
4699 struct ust_app_session
*ua_sess
)
4702 struct lttng_ht_iter iter
;
4703 struct ust_app_channel
*ua_chan
;
4704 struct consumer_socket
*socket
;
4706 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
4710 if (!app
->compatible
) {
4711 goto end_not_compatible
;
4714 pthread_mutex_lock(&ua_sess
->lock
);
4716 if (ua_sess
->deleted
) {
4720 health_code_update();
4722 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4725 ERR("Failed to find consumer (%" PRIu32
") socket",
4726 app
->bits_per_long
);
4731 /* Clear quiescent state. */
4732 switch (ua_sess
->buffer_type
) {
4733 case LTTNG_BUFFER_PER_PID
:
4734 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
4735 ua_chan
, node
.node
) {
4736 health_code_update();
4737 ret
= consumer_clear_quiescent_channel(socket
,
4740 ERR("Error clearing quiescent state for consumer channel");
4746 case LTTNG_BUFFER_PER_UID
:
4753 health_code_update();
4756 pthread_mutex_unlock(&ua_sess
->lock
);
4760 health_code_update();
4765 * Clear quiescent state in each stream for all applications for a
4766 * specific UST session.
4767 * Called with UST session lock held.
4770 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
4775 DBG("Clearing stream quiescent state for all ust apps");
4779 switch (usess
->buffer_type
) {
4780 case LTTNG_BUFFER_PER_UID
:
4782 struct lttng_ht_iter iter
;
4783 struct buffer_reg_uid
*reg
;
4786 * Clear quiescent for all per UID buffers associated to
4789 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4790 struct consumer_socket
*socket
;
4791 struct buffer_reg_channel
*reg_chan
;
4793 /* Get associated consumer socket.*/
4794 socket
= consumer_find_socket_by_bitness(
4795 reg
->bits_per_long
, usess
->consumer
);
4798 * Ignore request if no consumer is found for
4804 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
4805 &iter
.iter
, reg_chan
, node
.node
) {
4807 * The following call will print error values so
4808 * the return code is of little importance
4809 * because whatever happens, we have to try them
4812 (void) consumer_clear_quiescent_channel(socket
,
4813 reg_chan
->consumer_key
);
4818 case LTTNG_BUFFER_PER_PID
:
4820 struct ust_app_session
*ua_sess
;
4821 struct lttng_ht_iter iter
;
4822 struct ust_app
*app
;
4824 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
4826 ua_sess
= lookup_session_by_app(usess
, app
);
4827 if (ua_sess
== NULL
) {
4830 (void) ust_app_clear_quiescent_app_session(app
,
4842 health_code_update();
4847 * Destroy a specific UST session in apps.
4849 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4852 struct ust_app_session
*ua_sess
;
4853 struct lttng_ht_iter iter
;
4854 struct lttng_ht_node_u64
*node
;
4856 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4860 if (!app
->compatible
) {
4864 __lookup_session_by_app(usess
, app
, &iter
);
4865 node
= lttng_ht_iter_get_node_u64(&iter
);
4867 /* Session is being or is deleted. */
4870 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4872 health_code_update();
4873 destroy_app_session(app
, ua_sess
);
4875 health_code_update();
4877 /* Quiescent wait after stopping trace */
4878 pthread_mutex_lock(&app
->sock_lock
);
4879 ret
= ustctl_wait_quiescent(app
->sock
);
4880 pthread_mutex_unlock(&app
->sock_lock
);
4881 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4882 ERR("UST app wait quiescent failed for app pid %d ret %d",
4887 health_code_update();
4892 * Start tracing for the UST session.
4894 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4896 struct lttng_ht_iter iter
;
4897 struct ust_app
*app
;
4899 DBG("Starting all UST traces");
4902 * Even though the start trace might fail, flag this session active so
4903 * other application coming in are started by default.
4910 * In a start-stop-start use-case, we need to clear the quiescent state
4911 * of each channel set by the prior stop command, thus ensuring that a
4912 * following stop or destroy is sure to grab a timestamp_end near those
4913 * operations, even if the packet is empty.
4915 (void) ust_app_clear_quiescent_session(usess
);
4917 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4918 ust_app_global_update(usess
, app
);
4927 * Start tracing for the UST session.
4928 * Called with UST session lock held.
4930 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4933 struct lttng_ht_iter iter
;
4934 struct ust_app
*app
;
4936 DBG("Stopping all UST traces");
4939 * Even though the stop trace might fail, flag this session inactive so
4940 * other application coming in are not started by default.
4946 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4947 ret
= ust_app_stop_trace(usess
, app
);
4949 /* Continue to next apps even on error */
4954 (void) ust_app_flush_session(usess
);
4962 * Destroy app UST session.
4964 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4967 struct lttng_ht_iter iter
;
4968 struct ust_app
*app
;
4970 DBG("Destroy all UST traces");
4974 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4975 ret
= destroy_trace(usess
, app
);
4977 /* Continue to next apps even on error */
4987 /* The ua_sess lock must be held by the caller. */
4989 int find_or_create_ust_app_channel(
4990 struct ltt_ust_session
*usess
,
4991 struct ust_app_session
*ua_sess
,
4992 struct ust_app
*app
,
4993 struct ltt_ust_channel
*uchan
,
4994 struct ust_app_channel
**ua_chan
)
4997 struct lttng_ht_iter iter
;
4998 struct lttng_ht_node_str
*ua_chan_node
;
5000 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5001 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5003 *ua_chan
= caa_container_of(ua_chan_node
,
5004 struct ust_app_channel
, node
);
5008 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5017 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5018 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5019 struct ust_app
*app
)
5022 struct ust_app_event
*ua_event
= NULL
;
5024 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5025 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5027 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5032 if (ua_event
->enabled
!= uevent
->enabled
) {
5033 ret
= uevent
->enabled
?
5034 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5035 disable_ust_app_event(ua_sess
, ua_event
, app
);
5044 * The caller must ensure that the application is compatible and is tracked
5045 * by the PID tracker.
5048 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5049 struct ust_app
*app
)
5052 struct cds_lfht_iter uchan_iter
;
5053 struct ltt_ust_channel
*uchan
;
5054 struct ust_app_session
*ua_sess
= NULL
;
5057 * The application's configuration should only be synchronized for
5060 assert(usess
->active
);
5062 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5064 /* Tracer is probably gone or ENOMEM. */
5069 pthread_mutex_lock(&ua_sess
->lock
);
5070 if (ua_sess
->deleted
) {
5071 pthread_mutex_unlock(&ua_sess
->lock
);
5076 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5078 struct ust_app_channel
*ua_chan
;
5079 struct cds_lfht_iter uevent_iter
;
5080 struct ltt_ust_event
*uevent
;
5083 * Search for a matching ust_app_channel. If none is found,
5084 * create it. Creating the channel will cause the ua_chan
5085 * structure to be allocated, the channel buffers to be
5086 * allocated (if necessary) and sent to the application, and
5087 * all enabled contexts will be added to the channel.
5089 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5090 app
, uchan
, &ua_chan
);
5092 /* Tracer is probably gone or ENOMEM. */
5097 /* ua_chan will be NULL for the metadata channel */
5101 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5103 ret
= ust_app_channel_synchronize_event(ua_chan
,
5104 uevent
, ua_sess
, app
);
5110 if (ua_chan
->enabled
!= uchan
->enabled
) {
5111 ret
= uchan
->enabled
?
5112 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5113 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5122 pthread_mutex_unlock(&ua_sess
->lock
);
5123 /* Everything went well at this point. */
5128 pthread_mutex_unlock(&ua_sess
->lock
);
5131 destroy_app_session(app
, ua_sess
);
5137 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5139 struct ust_app_session
*ua_sess
;
5141 ua_sess
= lookup_session_by_app(usess
, app
);
5142 if (ua_sess
== NULL
) {
5145 destroy_app_session(app
, ua_sess
);
5149 * Add channels/events from UST global domain to registered apps at sock.
5151 * Called with session lock held.
5152 * Called with RCU read-side lock held.
5154 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5157 assert(usess
->active
);
5159 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5160 app
->sock
, usess
->id
);
5162 if (!app
->compatible
) {
5165 if (trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
5167 * Synchronize the application's internal tracing configuration
5168 * and start tracing.
5170 ust_app_synchronize(usess
, app
);
5171 ust_app_start_trace(usess
, app
);
5173 ust_app_global_destroy(usess
, app
);
5178 * Called with session lock held.
5180 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5182 struct lttng_ht_iter iter
;
5183 struct ust_app
*app
;
5186 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5187 ust_app_global_update(usess
, app
);
5193 * Add context to a specific channel for global UST domain.
5195 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5196 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5199 struct lttng_ht_node_str
*ua_chan_node
;
5200 struct lttng_ht_iter iter
, uiter
;
5201 struct ust_app_channel
*ua_chan
= NULL
;
5202 struct ust_app_session
*ua_sess
;
5203 struct ust_app
*app
;
5205 assert(usess
->active
);
5208 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5209 if (!app
->compatible
) {
5211 * TODO: In time, we should notice the caller of this error by
5212 * telling him that this is a version error.
5216 ua_sess
= lookup_session_by_app(usess
, app
);
5217 if (ua_sess
== NULL
) {
5221 pthread_mutex_lock(&ua_sess
->lock
);
5223 if (ua_sess
->deleted
) {
5224 pthread_mutex_unlock(&ua_sess
->lock
);
5228 /* Lookup channel in the ust app session */
5229 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5230 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5231 if (ua_chan_node
== NULL
) {
5234 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5236 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5241 pthread_mutex_unlock(&ua_sess
->lock
);
5249 * Receive registration and populate the given msg structure.
5251 * On success return 0 else a negative value returned by the ustctl call.
5253 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5256 uint32_t pid
, ppid
, uid
, gid
;
5260 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5261 &pid
, &ppid
, &uid
, &gid
,
5262 &msg
->bits_per_long
,
5263 &msg
->uint8_t_alignment
,
5264 &msg
->uint16_t_alignment
,
5265 &msg
->uint32_t_alignment
,
5266 &msg
->uint64_t_alignment
,
5267 &msg
->long_alignment
,
5274 case LTTNG_UST_ERR_EXITING
:
5275 DBG3("UST app recv reg message failed. Application died");
5277 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5278 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5279 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5280 LTTNG_UST_ABI_MINOR_VERSION
);
5283 ERR("UST app recv reg message failed with ret %d", ret
);
5288 msg
->pid
= (pid_t
) pid
;
5289 msg
->ppid
= (pid_t
) ppid
;
5290 msg
->uid
= (uid_t
) uid
;
5291 msg
->gid
= (gid_t
) gid
;
5298 * Return a ust app session object using the application object and the
5299 * session object descriptor has a key. If not found, NULL is returned.
5300 * A RCU read side lock MUST be acquired when calling this function.
5302 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5305 struct lttng_ht_node_ulong
*node
;
5306 struct lttng_ht_iter iter
;
5307 struct ust_app_session
*ua_sess
= NULL
;
5311 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5312 node
= lttng_ht_iter_get_node_ulong(&iter
);
5314 DBG2("UST app session find by objd %d not found", objd
);
5318 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5325 * Return a ust app channel object using the application object and the channel
5326 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5327 * lock MUST be acquired before calling this function.
5329 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5332 struct lttng_ht_node_ulong
*node
;
5333 struct lttng_ht_iter iter
;
5334 struct ust_app_channel
*ua_chan
= NULL
;
5338 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5339 node
= lttng_ht_iter_get_node_ulong(&iter
);
5341 DBG2("UST app channel find by objd %d not found", objd
);
5345 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5352 * Reply to a register channel notification from an application on the notify
5353 * socket. The channel metadata is also created.
5355 * The session UST registry lock is acquired in this function.
5357 * On success 0 is returned else a negative value.
5359 static int reply_ust_register_channel(int sock
, int cobjd
,
5360 size_t nr_fields
, struct ustctl_field
*fields
)
5362 int ret
, ret_code
= 0;
5364 uint64_t chan_reg_key
;
5365 enum ustctl_channel_header type
;
5366 struct ust_app
*app
;
5367 struct ust_app_channel
*ua_chan
;
5368 struct ust_app_session
*ua_sess
;
5369 struct ust_registry_session
*registry
;
5370 struct ust_registry_channel
*chan_reg
;
5374 /* Lookup application. If not found, there is a code flow error. */
5375 app
= find_app_by_notify_sock(sock
);
5377 DBG("Application socket %d is being torn down. Abort event notify",
5380 goto error_rcu_unlock
;
5383 /* Lookup channel by UST object descriptor. */
5384 ua_chan
= find_channel_by_objd(app
, cobjd
);
5386 DBG("Application channel is being torn down. Abort event notify");
5388 goto error_rcu_unlock
;
5391 assert(ua_chan
->session
);
5392 ua_sess
= ua_chan
->session
;
5394 /* Get right session registry depending on the session buffer type. */
5395 registry
= get_session_registry(ua_sess
);
5397 DBG("Application session is being torn down. Abort event notify");
5399 goto error_rcu_unlock
;
5402 /* Depending on the buffer type, a different channel key is used. */
5403 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5404 chan_reg_key
= ua_chan
->tracing_channel_id
;
5406 chan_reg_key
= ua_chan
->key
;
5409 pthread_mutex_lock(®istry
->lock
);
5411 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5414 if (!chan_reg
->register_done
) {
5416 * TODO: eventually use the registry event count for
5417 * this channel to better guess header type for per-pid
5420 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5421 chan_reg
->nr_ctx_fields
= nr_fields
;
5422 chan_reg
->ctx_fields
= fields
;
5424 chan_reg
->header_type
= type
;
5426 /* Get current already assigned values. */
5427 type
= chan_reg
->header_type
;
5429 /* Channel id is set during the object creation. */
5430 chan_id
= chan_reg
->chan_id
;
5432 /* Append to metadata */
5433 if (!chan_reg
->metadata_dumped
) {
5434 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5436 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5442 DBG3("UST app replying to register channel key %" PRIu64
5443 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5446 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5448 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5449 ERR("UST app reply channel failed with ret %d", ret
);
5451 DBG3("UST app reply channel failed. Application died");
5456 /* This channel registry registration is completed. */
5457 chan_reg
->register_done
= 1;
5460 pthread_mutex_unlock(®istry
->lock
);
5468 * Add event to the UST channel registry. When the event is added to the
5469 * registry, the metadata is also created. Once done, this replies to the
5470 * application with the appropriate error code.
5472 * The session UST registry lock is acquired in the function.
5474 * On success 0 is returned else a negative value.
5476 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5477 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5478 int loglevel_value
, char *model_emf_uri
)
5481 uint32_t event_id
= 0;
5482 uint64_t chan_reg_key
;
5483 struct ust_app
*app
;
5484 struct ust_app_channel
*ua_chan
;
5485 struct ust_app_session
*ua_sess
;
5486 struct ust_registry_session
*registry
;
5490 /* Lookup application. If not found, there is a code flow error. */
5491 app
= find_app_by_notify_sock(sock
);
5493 DBG("Application socket %d is being torn down. Abort event notify",
5496 goto error_rcu_unlock
;
5499 /* Lookup channel by UST object descriptor. */
5500 ua_chan
= find_channel_by_objd(app
, cobjd
);
5502 DBG("Application channel is being torn down. Abort event notify");
5504 goto error_rcu_unlock
;
5507 assert(ua_chan
->session
);
5508 ua_sess
= ua_chan
->session
;
5510 registry
= get_session_registry(ua_sess
);
5512 DBG("Application session is being torn down. Abort event notify");
5514 goto error_rcu_unlock
;
5517 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5518 chan_reg_key
= ua_chan
->tracing_channel_id
;
5520 chan_reg_key
= ua_chan
->key
;
5523 pthread_mutex_lock(®istry
->lock
);
5526 * From this point on, this call acquires the ownership of the sig, fields
5527 * and model_emf_uri meaning any free are done inside it if needed. These
5528 * three variables MUST NOT be read/write after this.
5530 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5531 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5532 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5536 model_emf_uri
= NULL
;
5539 * The return value is returned to ustctl so in case of an error, the
5540 * application can be notified. In case of an error, it's important not to
5541 * return a negative error or else the application will get closed.
5543 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5545 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5546 ERR("UST app reply event failed with ret %d", ret
);
5548 DBG3("UST app reply event failed. Application died");
5551 * No need to wipe the create event since the application socket will
5552 * get close on error hence cleaning up everything by itself.
5557 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5561 pthread_mutex_unlock(®istry
->lock
);
5566 free(model_emf_uri
);
5571 * Add enum to the UST session registry. Once done, this replies to the
5572 * application with the appropriate error code.
5574 * The session UST registry lock is acquired within this function.
5576 * On success 0 is returned else a negative value.
5578 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
5579 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
5581 int ret
= 0, ret_code
;
5582 struct ust_app
*app
;
5583 struct ust_app_session
*ua_sess
;
5584 struct ust_registry_session
*registry
;
5585 uint64_t enum_id
= -1ULL;
5589 /* Lookup application. If not found, there is a code flow error. */
5590 app
= find_app_by_notify_sock(sock
);
5592 /* Return an error since this is not an error */
5593 DBG("Application socket %d is being torn down. Aborting enum registration",
5596 goto error_rcu_unlock
;
5599 /* Lookup session by UST object descriptor. */
5600 ua_sess
= find_session_by_objd(app
, sobjd
);
5602 /* Return an error since this is not an error */
5603 DBG("Application session is being torn down (session not found). Aborting enum registration.");
5605 goto error_rcu_unlock
;
5608 registry
= get_session_registry(ua_sess
);
5610 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
5612 goto error_rcu_unlock
;
5615 pthread_mutex_lock(®istry
->lock
);
5618 * From this point on, the callee acquires the ownership of
5619 * entries. The variable entries MUST NOT be read/written after
5622 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
5623 entries
, nr_entries
, &enum_id
);
5627 * The return value is returned to ustctl so in case of an error, the
5628 * application can be notified. In case of an error, it's important not to
5629 * return a negative error or else the application will get closed.
5631 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
5633 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5634 ERR("UST app reply enum failed with ret %d", ret
);
5636 DBG3("UST app reply enum failed. Application died");
5639 * No need to wipe the create enum since the application socket will
5640 * get close on error hence cleaning up everything by itself.
5645 DBG3("UST registry enum %s added successfully or already found", name
);
5648 pthread_mutex_unlock(®istry
->lock
);
5655 * Handle application notification through the given notify socket.
5657 * Return 0 on success or else a negative value.
5659 int ust_app_recv_notify(int sock
)
5662 enum ustctl_notify_cmd cmd
;
5664 DBG3("UST app receiving notify from sock %d", sock
);
5666 ret
= ustctl_recv_notify(sock
, &cmd
);
5668 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5669 ERR("UST app recv notify failed with ret %d", ret
);
5671 DBG3("UST app recv notify failed. Application died");
5677 case USTCTL_NOTIFY_CMD_EVENT
:
5679 int sobjd
, cobjd
, loglevel_value
;
5680 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5682 struct ustctl_field
*fields
;
5684 DBG2("UST app ustctl register event received");
5686 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5687 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5690 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5691 ERR("UST app recv event failed with ret %d", ret
);
5693 DBG3("UST app recv event failed. Application died");
5699 * Add event to the UST registry coming from the notify socket. This
5700 * call will free if needed the sig, fields and model_emf_uri. This
5701 * code path loses the ownsership of these variables and transfer them
5702 * to the this function.
5704 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5705 fields
, loglevel_value
, model_emf_uri
);
5712 case USTCTL_NOTIFY_CMD_CHANNEL
:
5716 struct ustctl_field
*fields
;
5718 DBG2("UST app ustctl register channel received");
5720 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5723 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5724 ERR("UST app recv channel failed with ret %d", ret
);
5726 DBG3("UST app recv channel failed. Application died");
5732 * The fields ownership are transfered to this function call meaning
5733 * that if needed it will be freed. After this, it's invalid to access
5734 * fields or clean it up.
5736 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
5744 case USTCTL_NOTIFY_CMD_ENUM
:
5747 char name
[LTTNG_UST_SYM_NAME_LEN
];
5749 struct ustctl_enum_entry
*entries
;
5751 DBG2("UST app ustctl register enum received");
5753 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
5754 &entries
, &nr_entries
);
5756 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5757 ERR("UST app recv enum failed with ret %d", ret
);
5759 DBG3("UST app recv enum failed. Application died");
5764 /* Callee assumes ownership of entries */
5765 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
5766 entries
, nr_entries
);
5774 /* Should NEVER happen. */
5783 * Once the notify socket hangs up, this is called. First, it tries to find the
5784 * corresponding application. On failure, the call_rcu to close the socket is
5785 * executed. If an application is found, it tries to delete it from the notify
5786 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5788 * Note that an object needs to be allocated here so on ENOMEM failure, the
5789 * call RCU is not done but the rest of the cleanup is.
5791 void ust_app_notify_sock_unregister(int sock
)
5794 struct lttng_ht_iter iter
;
5795 struct ust_app
*app
;
5796 struct ust_app_notify_sock_obj
*obj
;
5802 obj
= zmalloc(sizeof(*obj
));
5805 * An ENOMEM is kind of uncool. If this strikes we continue the
5806 * procedure but the call_rcu will not be called. In this case, we
5807 * accept the fd leak rather than possibly creating an unsynchronized
5808 * state between threads.
5810 * TODO: The notify object should be created once the notify socket is
5811 * registered and stored independantely from the ust app object. The
5812 * tricky part is to synchronize the teardown of the application and
5813 * this notify object. Let's keep that in mind so we can avoid this
5814 * kind of shenanigans with ENOMEM in the teardown path.
5821 DBG("UST app notify socket unregister %d", sock
);
5824 * Lookup application by notify socket. If this fails, this means that the
5825 * hash table delete has already been done by the application
5826 * unregistration process so we can safely close the notify socket in a
5829 app
= find_app_by_notify_sock(sock
);
5834 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5837 * Whatever happens here either we fail or succeed, in both cases we have
5838 * to close the socket after a grace period to continue to the call RCU
5839 * here. If the deletion is successful, the application is not visible
5840 * anymore by other threads and is it fails it means that it was already
5841 * deleted from the hash table so either way we just have to close the
5844 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5850 * Close socket after a grace period to avoid for the socket to be reused
5851 * before the application object is freed creating potential race between
5852 * threads trying to add unique in the global hash table.
5855 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5860 * Destroy a ust app data structure and free its memory.
5862 void ust_app_destroy(struct ust_app
*app
)
5868 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5872 * Take a snapshot for a given UST session. The snapshot is sent to the given
5875 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5877 enum lttng_error_code
ust_app_snapshot_record(
5878 const struct ltt_ust_session
*usess
,
5879 const struct consumer_output
*output
, int wait
,
5880 uint64_t nb_packets_per_stream
)
5883 enum lttng_error_code status
= LTTNG_OK
;
5884 struct lttng_ht_iter iter
;
5885 struct ust_app
*app
;
5892 switch (usess
->buffer_type
) {
5893 case LTTNG_BUFFER_PER_UID
:
5895 struct buffer_reg_uid
*reg
;
5897 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5898 struct buffer_reg_channel
*reg_chan
;
5899 struct consumer_socket
*socket
;
5900 char *trace_path
= NULL
;
5901 char pathname
[PATH_MAX
];
5903 if (!reg
->registry
->reg
.ust
->metadata_key
) {
5904 /* Skip since no metadata is present */
5908 /* Get consumer socket to use to push the metadata.*/
5909 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5912 status
= LTTNG_ERR_INVALID
;
5916 memset(pathname
, 0, sizeof(pathname
));
5918 * DEFAULT_UST_TRACE_UID_PATH already contains a path
5921 ret
= snprintf(pathname
, sizeof(pathname
),
5922 DEFAULT_UST_TRACE_DIR DEFAULT_UST_TRACE_UID_PATH
,
5923 reg
->uid
, reg
->bits_per_long
);
5925 PERROR("snprintf snapshot path");
5926 status
= LTTNG_ERR_INVALID
;
5929 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
);
5931 status
= LTTNG_ERR_INVALID
;
5934 /* Add the UST default trace dir to path. */
5935 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5936 reg_chan
, node
.node
) {
5937 status
= consumer_snapshot_channel(socket
,
5938 reg_chan
->consumer_key
,
5939 output
, 0, usess
->uid
,
5940 usess
->gid
, trace_path
, wait
,
5941 nb_packets_per_stream
);
5942 if (status
!= LTTNG_OK
) {
5947 status
= consumer_snapshot_channel(socket
,
5948 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5949 usess
->uid
, usess
->gid
, trace_path
, wait
, 0);
5951 if (status
!= LTTNG_OK
) {
5957 case LTTNG_BUFFER_PER_PID
:
5959 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5960 struct consumer_socket
*socket
;
5961 struct lttng_ht_iter chan_iter
;
5962 struct ust_app_channel
*ua_chan
;
5963 struct ust_app_session
*ua_sess
;
5964 struct ust_registry_session
*registry
;
5965 char *trace_path
= NULL
;
5966 char pathname
[PATH_MAX
];
5968 ua_sess
= lookup_session_by_app(usess
, app
);
5970 /* Session not associated with this app. */
5974 /* Get the right consumer socket for the application. */
5975 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5978 status
= LTTNG_ERR_INVALID
;
5982 /* Add the UST default trace dir to path. */
5983 memset(pathname
, 0, sizeof(pathname
));
5984 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"%s",
5987 status
= LTTNG_ERR_INVALID
;
5988 PERROR("snprintf snapshot path");
5991 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
);
5993 status
= LTTNG_ERR_INVALID
;
5996 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5997 ua_chan
, node
.node
) {
5998 status
= consumer_snapshot_channel(socket
,
5999 ua_chan
->key
, output
, 0,
6000 ua_sess
->effective_credentials
6002 ua_sess
->effective_credentials
6005 nb_packets_per_stream
);
6009 case LTTNG_ERR_CHAN_NOT_FOUND
:
6018 registry
= get_session_registry(ua_sess
);
6020 DBG("Application session is being torn down. Skip application.");
6023 status
= consumer_snapshot_channel(socket
,
6024 registry
->metadata_key
, output
, 1,
6025 ua_sess
->effective_credentials
.uid
,
6026 ua_sess
->effective_credentials
.gid
,
6027 trace_path
, wait
, 0);
6032 case LTTNG_ERR_CHAN_NOT_FOUND
:
6051 * Return the size taken by one more packet per stream.
6053 uint64_t ust_app_get_size_one_more_packet_per_stream(
6054 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6056 uint64_t tot_size
= 0;
6057 struct ust_app
*app
;
6058 struct lttng_ht_iter iter
;
6062 switch (usess
->buffer_type
) {
6063 case LTTNG_BUFFER_PER_UID
:
6065 struct buffer_reg_uid
*reg
;
6067 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6068 struct buffer_reg_channel
*reg_chan
;
6071 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6072 reg_chan
, node
.node
) {
6073 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6075 * Don't take channel into account if we
6076 * already grab all its packets.
6080 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6086 case LTTNG_BUFFER_PER_PID
:
6089 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6090 struct ust_app_channel
*ua_chan
;
6091 struct ust_app_session
*ua_sess
;
6092 struct lttng_ht_iter chan_iter
;
6094 ua_sess
= lookup_session_by_app(usess
, app
);
6096 /* Session not associated with this app. */
6100 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6101 ua_chan
, node
.node
) {
6102 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6104 * Don't take channel into account if we
6105 * already grab all its packets.
6109 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6123 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6124 struct cds_list_head
*buffer_reg_uid_list
,
6125 struct consumer_output
*consumer
, uint64_t uchan_id
,
6126 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6129 uint64_t consumer_chan_key
;
6134 ret
= buffer_reg_uid_consumer_channel_key(
6135 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6143 ret
= consumer_get_lost_packets(ust_session_id
,
6144 consumer_chan_key
, consumer
, lost
);
6146 ret
= consumer_get_discarded_events(ust_session_id
,
6147 consumer_chan_key
, consumer
, discarded
);
6154 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6155 struct ltt_ust_channel
*uchan
,
6156 struct consumer_output
*consumer
, int overwrite
,
6157 uint64_t *discarded
, uint64_t *lost
)
6160 struct lttng_ht_iter iter
;
6161 struct lttng_ht_node_str
*ua_chan_node
;
6162 struct ust_app
*app
;
6163 struct ust_app_session
*ua_sess
;
6164 struct ust_app_channel
*ua_chan
;
6171 * Iterate over every registered applications. Sum counters for
6172 * all applications containing requested session and channel.
6174 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6175 struct lttng_ht_iter uiter
;
6177 ua_sess
= lookup_session_by_app(usess
, app
);
6178 if (ua_sess
== NULL
) {
6183 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6184 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6185 /* If the session is found for the app, the channel must be there */
6186 assert(ua_chan_node
);
6188 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6193 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6200 uint64_t _discarded
;
6202 ret
= consumer_get_discarded_events(usess
->id
,
6203 ua_chan
->key
, consumer
, &_discarded
);
6207 (*discarded
) += _discarded
;
6216 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6217 struct ust_app
*app
)
6220 struct ust_app_session
*ua_sess
;
6222 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6226 ua_sess
= lookup_session_by_app(usess
, app
);
6227 if (ua_sess
== NULL
) {
6228 /* The session is in teardown process. Ignore and continue. */
6232 pthread_mutex_lock(&ua_sess
->lock
);
6234 if (ua_sess
->deleted
) {
6238 pthread_mutex_lock(&app
->sock_lock
);
6239 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6240 pthread_mutex_unlock(&app
->sock_lock
);
6243 pthread_mutex_unlock(&ua_sess
->lock
);
6247 health_code_update();
6252 * Regenerate the statedump for each app in the session.
6254 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6257 struct lttng_ht_iter iter
;
6258 struct ust_app
*app
;
6260 DBG("Regenerating the metadata for all UST apps");
6264 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6265 if (!app
->compatible
) {
6269 ret
= ust_app_regenerate_statedump(usess
, app
);
6271 /* Continue to the next app even on error */
6282 * Rotate all the channels of a session.
6284 * Return LTTNG_OK on success or else an LTTng error code.
6286 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6289 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6290 struct lttng_ht_iter iter
;
6291 struct ust_app
*app
;
6292 struct ltt_ust_session
*usess
= session
->ust_session
;
6298 switch (usess
->buffer_type
) {
6299 case LTTNG_BUFFER_PER_UID
:
6301 struct buffer_reg_uid
*reg
;
6303 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6304 struct buffer_reg_channel
*reg_chan
;
6305 struct consumer_socket
*socket
;
6307 /* Get consumer socket to use to push the metadata.*/
6308 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6311 cmd_ret
= LTTNG_ERR_INVALID
;
6315 /* Rotate the data channels. */
6316 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6317 reg_chan
, node
.node
) {
6318 ret
= consumer_rotate_channel(socket
,
6319 reg_chan
->consumer_key
,
6320 usess
->uid
, usess
->gid
,
6322 /* is_metadata_channel */ false);
6324 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6329 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6331 ret
= consumer_rotate_channel(socket
,
6332 reg
->registry
->reg
.ust
->metadata_key
,
6333 usess
->uid
, usess
->gid
,
6335 /* is_metadata_channel */ true);
6337 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6343 case LTTNG_BUFFER_PER_PID
:
6345 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6346 struct consumer_socket
*socket
;
6347 struct lttng_ht_iter chan_iter
;
6348 struct ust_app_channel
*ua_chan
;
6349 struct ust_app_session
*ua_sess
;
6350 struct ust_registry_session
*registry
;
6352 ua_sess
= lookup_session_by_app(usess
, app
);
6354 /* Session not associated with this app. */
6358 /* Get the right consumer socket for the application. */
6359 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6362 cmd_ret
= LTTNG_ERR_INVALID
;
6366 registry
= get_session_registry(ua_sess
);
6368 DBG("Application session is being torn down. Skip application.");
6372 /* Rotate the data channels. */
6373 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6374 ua_chan
, node
.node
) {
6375 ret
= consumer_rotate_channel(socket
,
6377 ua_sess
->effective_credentials
6379 ua_sess
->effective_credentials
6382 /* is_metadata_channel */ false);
6384 /* Per-PID buffer and application going away. */
6385 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6387 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6392 /* Rotate the metadata channel. */
6393 (void) push_metadata(registry
, usess
->consumer
);
6394 ret
= consumer_rotate_channel(socket
,
6395 registry
->metadata_key
,
6396 ua_sess
->effective_credentials
.uid
,
6397 ua_sess
->effective_credentials
.gid
,
6399 /* is_metadata_channel */ true);
6401 /* Per-PID buffer and application going away. */
6402 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6404 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6422 enum lttng_error_code
ust_app_create_channel_subdirectories(
6423 const struct ltt_ust_session
*usess
)
6425 enum lttng_error_code ret
= LTTNG_OK
;
6426 struct lttng_ht_iter iter
;
6427 enum lttng_trace_chunk_status chunk_status
;
6428 char *pathname_index
;
6431 assert(usess
->current_trace_chunk
);
6434 switch (usess
->buffer_type
) {
6435 case LTTNG_BUFFER_PER_UID
:
6437 struct buffer_reg_uid
*reg
;
6439 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6440 fmt_ret
= asprintf(&pathname_index
,
6441 DEFAULT_UST_TRACE_DIR DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
6442 reg
->uid
, reg
->bits_per_long
);
6444 ERR("Failed to format channel index directory");
6445 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6450 * Create the index subdirectory which will take care
6451 * of implicitly creating the channel's path.
6453 chunk_status
= lttng_trace_chunk_create_subdirectory(
6454 usess
->current_trace_chunk
,
6456 free(pathname_index
);
6457 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6458 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6464 case LTTNG_BUFFER_PER_PID
:
6466 struct ust_app
*app
;
6468 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
6470 struct ust_app_session
*ua_sess
;
6471 struct ust_registry_session
*registry
;
6473 ua_sess
= lookup_session_by_app(usess
, app
);
6475 /* Session not associated with this app. */
6479 registry
= get_session_registry(ua_sess
);
6481 DBG("Application session is being torn down. Skip application.");
6485 fmt_ret
= asprintf(&pathname_index
,
6486 DEFAULT_UST_TRACE_DIR
"%s/" DEFAULT_INDEX_DIR
,
6489 ERR("Failed to format channel index directory");
6490 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
6494 * Create the index subdirectory which will take care
6495 * of implicitly creating the channel's path.
6497 chunk_status
= lttng_trace_chunk_create_subdirectory(
6498 usess
->current_trace_chunk
,
6500 free(pathname_index
);
6501 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
6502 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;