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
, ua_sess
->uid
);
257 registry
= reg_uid
->registry
->reg
.ust
;
269 * Delete ust context safely. RCU read lock must be held before calling
273 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
281 pthread_mutex_lock(&app
->sock_lock
);
282 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
283 pthread_mutex_unlock(&app
->sock_lock
);
284 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
285 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
286 sock
, ua_ctx
->obj
->handle
, ret
);
294 * Delete ust app event safely. RCU read lock must be held before calling
298 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
305 free(ua_event
->filter
);
306 if (ua_event
->exclusion
!= NULL
)
307 free(ua_event
->exclusion
);
308 if (ua_event
->obj
!= NULL
) {
309 pthread_mutex_lock(&app
->sock_lock
);
310 ret
= ustctl_release_object(sock
, ua_event
->obj
);
311 pthread_mutex_unlock(&app
->sock_lock
);
312 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
313 ERR("UST app sock %d release event obj failed with ret %d",
322 * Release ust data object of the given stream.
324 * Return 0 on success or else a negative value.
326 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
334 pthread_mutex_lock(&app
->sock_lock
);
335 ret
= ustctl_release_object(sock
, stream
->obj
);
336 pthread_mutex_unlock(&app
->sock_lock
);
337 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
338 ERR("UST app sock %d release stream obj failed with ret %d",
341 lttng_fd_put(LTTNG_FD_APPS
, 2);
349 * Delete ust app stream safely. RCU read lock must be held before calling
353 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
358 (void) release_ust_app_stream(sock
, stream
, app
);
363 * We need to execute ht_destroy outside of RCU read-side critical
364 * section and outside of call_rcu thread, so we postpone its execution
365 * using ht_cleanup_push. It is simpler than to change the semantic of
366 * the many callers of delete_ust_app_session().
369 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
371 struct ust_app_channel
*ua_chan
=
372 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
374 ht_cleanup_push(ua_chan
->ctx
);
375 ht_cleanup_push(ua_chan
->events
);
380 * Extract the lost packet or discarded events counter when the channel is
381 * being deleted and store the value in the parent channel so we can
382 * access it from lttng list and at stop/destroy.
384 * The session list lock must be held by the caller.
387 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
389 uint64_t discarded
= 0, lost
= 0;
390 struct ltt_session
*session
;
391 struct ltt_ust_channel
*uchan
;
393 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
398 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
399 if (!session
|| !session
->ust_session
) {
401 * Not finding the session is not an error because there are
402 * multiple ways the channels can be torn down.
404 * 1) The session daemon can initiate the destruction of the
405 * ust app session after receiving a destroy command or
406 * during its shutdown/teardown.
407 * 2) The application, since we are in per-pid tracing, is
408 * unregistering and tearing down its ust app session.
410 * Both paths are protected by the session list lock which
411 * ensures that the accounting of lost packets and discarded
412 * events is done exactly once. The session is then unpublished
413 * from the session list, resulting in this condition.
418 if (ua_chan
->attr
.overwrite
) {
419 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
420 ua_chan
->key
, session
->ust_session
->consumer
,
423 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
424 ua_chan
->key
, session
->ust_session
->consumer
,
427 uchan
= trace_ust_find_channel_by_name(
428 session
->ust_session
->domain_global
.channels
,
431 ERR("Missing UST channel to store discarded counters");
435 uchan
->per_pid_closed_app_discarded
+= discarded
;
436 uchan
->per_pid_closed_app_lost
+= lost
;
443 * Delete ust app channel safely. RCU read lock must be held before calling
446 * The session list lock must be held by the caller.
449 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
453 struct lttng_ht_iter iter
;
454 struct ust_app_event
*ua_event
;
455 struct ust_app_ctx
*ua_ctx
;
456 struct ust_app_stream
*stream
, *stmp
;
457 struct ust_registry_session
*registry
;
461 DBG3("UST app deleting channel %s", ua_chan
->name
);
464 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
465 cds_list_del(&stream
->list
);
466 delete_ust_app_stream(sock
, stream
, app
);
470 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
471 cds_list_del(&ua_ctx
->list
);
472 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
474 delete_ust_app_ctx(sock
, ua_ctx
, app
);
478 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
480 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
482 delete_ust_app_event(sock
, ua_event
, app
);
485 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
486 /* Wipe and free registry from session registry. */
487 registry
= get_session_registry(ua_chan
->session
);
489 ust_registry_channel_del_free(registry
, ua_chan
->key
,
492 save_per_pid_lost_discarded_counters(ua_chan
);
495 if (ua_chan
->obj
!= NULL
) {
496 /* Remove channel from application UST object descriptor. */
497 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
498 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
500 pthread_mutex_lock(&app
->sock_lock
);
501 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
502 pthread_mutex_unlock(&app
->sock_lock
);
503 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
504 ERR("UST app sock %d release channel obj failed with ret %d",
507 lttng_fd_put(LTTNG_FD_APPS
, 1);
510 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
513 int ust_app_register_done(struct ust_app
*app
)
517 pthread_mutex_lock(&app
->sock_lock
);
518 ret
= ustctl_register_done(app
->sock
);
519 pthread_mutex_unlock(&app
->sock_lock
);
523 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
528 pthread_mutex_lock(&app
->sock_lock
);
533 ret
= ustctl_release_object(sock
, data
);
535 pthread_mutex_unlock(&app
->sock_lock
);
541 * Push metadata to consumer socket.
543 * RCU read-side lock must be held to guarantee existance of socket.
544 * Must be called with the ust app session lock held.
545 * Must be called with the registry lock held.
547 * On success, return the len of metadata pushed or else a negative value.
548 * Returning a -EPIPE return value means we could not send the metadata,
549 * but it can be caused by recoverable errors (e.g. the application has
550 * terminated concurrently).
552 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
553 struct consumer_socket
*socket
, int send_zero_data
)
556 char *metadata_str
= NULL
;
557 size_t len
, offset
, new_metadata_len_sent
;
559 uint64_t metadata_key
, metadata_version
;
564 metadata_key
= registry
->metadata_key
;
567 * Means that no metadata was assigned to the session. This can
568 * happens if no start has been done previously.
574 offset
= registry
->metadata_len_sent
;
575 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
576 new_metadata_len_sent
= registry
->metadata_len
;
577 metadata_version
= registry
->metadata_version
;
579 DBG3("No metadata to push for metadata key %" PRIu64
,
580 registry
->metadata_key
);
582 if (send_zero_data
) {
583 DBG("No metadata to push");
589 /* Allocate only what we have to send. */
590 metadata_str
= zmalloc(len
);
592 PERROR("zmalloc ust app metadata string");
596 /* Copy what we haven't sent out. */
597 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
600 pthread_mutex_unlock(®istry
->lock
);
602 * We need to unlock the registry while we push metadata to
603 * break a circular dependency between the consumerd metadata
604 * lock and the sessiond registry lock. Indeed, pushing metadata
605 * to the consumerd awaits that it gets pushed all the way to
606 * relayd, but doing so requires grabbing the metadata lock. If
607 * a concurrent metadata request is being performed by
608 * consumerd, this can try to grab the registry lock on the
609 * sessiond while holding the metadata lock on the consumer
610 * daemon. Those push and pull schemes are performed on two
611 * different bidirectionnal communication sockets.
613 ret
= consumer_push_metadata(socket
, metadata_key
,
614 metadata_str
, len
, offset
, metadata_version
);
615 pthread_mutex_lock(®istry
->lock
);
618 * There is an acceptable race here between the registry
619 * metadata key assignment and the creation on the
620 * consumer. The session daemon can concurrently push
621 * metadata for this registry while being created on the
622 * consumer since the metadata key of the registry is
623 * assigned *before* it is setup to avoid the consumer
624 * to ask for metadata that could possibly be not found
625 * in the session daemon.
627 * The metadata will get pushed either by the session
628 * being stopped or the consumer requesting metadata if
629 * that race is triggered.
631 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
634 ERR("Error pushing metadata to consumer");
640 * Metadata may have been concurrently pushed, since
641 * we're not holding the registry lock while pushing to
642 * consumer. This is handled by the fact that we send
643 * the metadata content, size, and the offset at which
644 * that metadata belongs. This may arrive out of order
645 * on the consumer side, and the consumer is able to
646 * deal with overlapping fragments. The consumer
647 * supports overlapping fragments, which must be
648 * contiguous starting from offset 0. We keep the
649 * largest metadata_len_sent value of the concurrent
652 registry
->metadata_len_sent
=
653 max_t(size_t, registry
->metadata_len_sent
,
654 new_metadata_len_sent
);
663 * On error, flag the registry that the metadata is
664 * closed. We were unable to push anything and this
665 * means that either the consumer is not responding or
666 * the metadata cache has been destroyed on the
669 registry
->metadata_closed
= 1;
677 * For a given application and session, push metadata to consumer.
678 * Either sock or consumer is required : if sock is NULL, the default
679 * socket to send the metadata is retrieved from consumer, if sock
680 * is not NULL we use it to send the metadata.
681 * RCU read-side lock must be held while calling this function,
682 * therefore ensuring existance of registry. It also ensures existance
683 * of socket throughout this function.
685 * Return 0 on success else a negative error.
686 * Returning a -EPIPE return value means we could not send the metadata,
687 * but it can be caused by recoverable errors (e.g. the application has
688 * terminated concurrently).
690 static int push_metadata(struct ust_registry_session
*registry
,
691 struct consumer_output
*consumer
)
695 struct consumer_socket
*socket
;
700 pthread_mutex_lock(®istry
->lock
);
701 if (registry
->metadata_closed
) {
706 /* Get consumer socket to use to push the metadata.*/
707 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
714 ret
= ust_app_push_metadata(registry
, socket
, 0);
719 pthread_mutex_unlock(®istry
->lock
);
723 pthread_mutex_unlock(®istry
->lock
);
728 * Send to the consumer a close metadata command for the given session. Once
729 * done, the metadata channel is deleted and the session metadata pointer is
730 * nullified. The session lock MUST be held unless the application is
731 * in the destroy path.
733 * Return 0 on success else a negative value.
735 static int close_metadata(struct ust_registry_session
*registry
,
736 struct consumer_output
*consumer
)
739 struct consumer_socket
*socket
;
746 pthread_mutex_lock(®istry
->lock
);
748 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
753 /* Get consumer socket to use to push the metadata.*/
754 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
761 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
768 * Metadata closed. Even on error this means that the consumer is not
769 * responding or not found so either way a second close should NOT be emit
772 registry
->metadata_closed
= 1;
774 pthread_mutex_unlock(®istry
->lock
);
780 * We need to execute ht_destroy outside of RCU read-side critical
781 * section and outside of call_rcu thread, so we postpone its execution
782 * using ht_cleanup_push. It is simpler than to change the semantic of
783 * the many callers of delete_ust_app_session().
786 void delete_ust_app_session_rcu(struct rcu_head
*head
)
788 struct ust_app_session
*ua_sess
=
789 caa_container_of(head
, struct ust_app_session
, rcu_head
);
791 ht_cleanup_push(ua_sess
->channels
);
796 * Delete ust app session safely. RCU read lock must be held before calling
799 * The session list lock must be held by the caller.
802 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
806 struct lttng_ht_iter iter
;
807 struct ust_app_channel
*ua_chan
;
808 struct ust_registry_session
*registry
;
812 pthread_mutex_lock(&ua_sess
->lock
);
814 assert(!ua_sess
->deleted
);
815 ua_sess
->deleted
= true;
817 registry
= get_session_registry(ua_sess
);
818 /* Registry can be null on error path during initialization. */
820 /* Push metadata for application before freeing the application. */
821 (void) push_metadata(registry
, ua_sess
->consumer
);
824 * Don't ask to close metadata for global per UID buffers. Close
825 * metadata only on destroy trace session in this case. Also, the
826 * previous push metadata could have flag the metadata registry to
827 * close so don't send a close command if closed.
829 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
830 /* And ask to close it for this session registry. */
831 (void) close_metadata(registry
, ua_sess
->consumer
);
835 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
837 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
839 delete_ust_app_channel(sock
, ua_chan
, app
);
842 /* In case of per PID, the registry is kept in the session. */
843 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
844 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
847 * Registry can be null on error path during
850 buffer_reg_pid_remove(reg_pid
);
851 buffer_reg_pid_destroy(reg_pid
);
855 if (ua_sess
->handle
!= -1) {
856 pthread_mutex_lock(&app
->sock_lock
);
857 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
858 pthread_mutex_unlock(&app
->sock_lock
);
859 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
860 ERR("UST app sock %d release session handle failed with ret %d",
863 /* Remove session from application UST object descriptor. */
864 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
865 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
869 pthread_mutex_unlock(&ua_sess
->lock
);
871 consumer_output_put(ua_sess
->consumer
);
873 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
877 * Delete a traceable application structure from the global list. Never call
878 * this function outside of a call_rcu call.
880 * RCU read side lock should _NOT_ be held when calling this function.
883 void delete_ust_app(struct ust_app
*app
)
886 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
889 * The session list lock must be held during this function to guarantee
890 * the existence of ua_sess.
893 /* Delete ust app sessions info */
898 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
900 /* Free every object in the session and the session. */
902 delete_ust_app_session(sock
, ua_sess
, app
);
906 ht_cleanup_push(app
->sessions
);
907 ht_cleanup_push(app
->ust_sessions_objd
);
908 ht_cleanup_push(app
->ust_objd
);
911 * Wait until we have deleted the application from the sock hash table
912 * before closing this socket, otherwise an application could re-use the
913 * socket ID and race with the teardown, using the same hash table entry.
915 * It's OK to leave the close in call_rcu. We want it to stay unique for
916 * all RCU readers that could run concurrently with unregister app,
917 * therefore we _need_ to only close that socket after a grace period. So
918 * it should stay in this RCU callback.
920 * This close() is a very important step of the synchronization model so
921 * every modification to this function must be carefully reviewed.
927 lttng_fd_put(LTTNG_FD_APPS
, 1);
929 DBG2("UST app pid %d deleted", app
->pid
);
931 session_unlock_list();
935 * URCU intermediate call to delete an UST app.
938 void delete_ust_app_rcu(struct rcu_head
*head
)
940 struct lttng_ht_node_ulong
*node
=
941 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
942 struct ust_app
*app
=
943 caa_container_of(node
, struct ust_app
, pid_n
);
945 DBG3("Call RCU deleting app PID %d", app
->pid
);
950 * Delete the session from the application ht and delete the data structure by
951 * freeing every object inside and releasing them.
953 * The session list lock must be held by the caller.
955 static void destroy_app_session(struct ust_app
*app
,
956 struct ust_app_session
*ua_sess
)
959 struct lttng_ht_iter iter
;
964 iter
.iter
.node
= &ua_sess
->node
.node
;
965 ret
= lttng_ht_del(app
->sessions
, &iter
);
967 /* Already scheduled for teardown. */
971 /* Once deleted, free the data structure. */
972 delete_ust_app_session(app
->sock
, ua_sess
, app
);
979 * Alloc new UST app session.
982 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
984 struct ust_app_session
*ua_sess
;
986 /* Init most of the default value by allocating and zeroing */
987 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
988 if (ua_sess
== NULL
) {
993 ua_sess
->handle
= -1;
994 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
995 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
996 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1005 * Alloc new UST app channel.
1008 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
1009 struct ust_app_session
*ua_sess
,
1010 struct lttng_ust_channel_attr
*attr
)
1012 struct ust_app_channel
*ua_chan
;
1014 /* Init most of the default value by allocating and zeroing */
1015 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1016 if (ua_chan
== NULL
) {
1021 /* Setup channel name */
1022 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1023 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1025 ua_chan
->enabled
= 1;
1026 ua_chan
->handle
= -1;
1027 ua_chan
->session
= ua_sess
;
1028 ua_chan
->key
= get_next_channel_key();
1029 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1030 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1031 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1033 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1034 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1036 /* Copy attributes */
1038 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1039 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1040 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1041 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1042 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1043 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1044 ua_chan
->attr
.output
= attr
->output
;
1045 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1047 /* By default, the channel is a per cpu channel. */
1048 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1050 DBG3("UST app channel %s allocated", ua_chan
->name
);
1059 * Allocate and initialize a UST app stream.
1061 * Return newly allocated stream pointer or NULL on error.
1063 struct ust_app_stream
*ust_app_alloc_stream(void)
1065 struct ust_app_stream
*stream
= NULL
;
1067 stream
= zmalloc(sizeof(*stream
));
1068 if (stream
== NULL
) {
1069 PERROR("zmalloc ust app stream");
1073 /* Zero could be a valid value for a handle so flag it to -1. */
1074 stream
->handle
= -1;
1081 * Alloc new UST app event.
1084 struct ust_app_event
*alloc_ust_app_event(char *name
,
1085 struct lttng_ust_event
*attr
)
1087 struct ust_app_event
*ua_event
;
1089 /* Init most of the default value by allocating and zeroing */
1090 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1091 if (ua_event
== NULL
) {
1096 ua_event
->enabled
= 1;
1097 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1098 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1099 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1101 /* Copy attributes */
1103 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1106 DBG3("UST app event %s allocated", ua_event
->name
);
1115 * Alloc new UST app context.
1118 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1120 struct ust_app_ctx
*ua_ctx
;
1122 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1123 if (ua_ctx
== NULL
) {
1127 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1130 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1131 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1132 char *provider_name
= NULL
, *ctx_name
= NULL
;
1134 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1135 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1136 if (!provider_name
|| !ctx_name
) {
1137 free(provider_name
);
1142 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1143 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1147 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1155 * Allocate a filter and copy the given original filter.
1157 * Return allocated filter or NULL on error.
1159 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1160 struct lttng_filter_bytecode
*orig_f
)
1162 struct lttng_filter_bytecode
*filter
= NULL
;
1164 /* Copy filter bytecode */
1165 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1167 PERROR("zmalloc alloc filter bytecode");
1171 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1178 * Create a liblttng-ust filter bytecode from given bytecode.
1180 * Return allocated filter or NULL on error.
1182 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1183 struct lttng_filter_bytecode
*orig_f
)
1185 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1187 /* Copy filter bytecode */
1188 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1190 PERROR("zmalloc alloc ust filter bytecode");
1194 assert(sizeof(struct lttng_filter_bytecode
) ==
1195 sizeof(struct lttng_ust_filter_bytecode
));
1196 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1202 * Find an ust_app using the sock and return it. RCU read side lock must be
1203 * held before calling this helper function.
1205 struct ust_app
*ust_app_find_by_sock(int sock
)
1207 struct lttng_ht_node_ulong
*node
;
1208 struct lttng_ht_iter iter
;
1210 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1211 node
= lttng_ht_iter_get_node_ulong(&iter
);
1213 DBG2("UST app find by sock %d not found", sock
);
1217 return caa_container_of(node
, struct ust_app
, sock_n
);
1224 * Find an ust_app using the notify sock and return it. RCU read side lock must
1225 * be held before calling this helper function.
1227 static struct ust_app
*find_app_by_notify_sock(int sock
)
1229 struct lttng_ht_node_ulong
*node
;
1230 struct lttng_ht_iter iter
;
1232 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1234 node
= lttng_ht_iter_get_node_ulong(&iter
);
1236 DBG2("UST app find by notify sock %d not found", sock
);
1240 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1247 * Lookup for an ust app event based on event name, filter bytecode and the
1250 * Return an ust_app_event object or NULL on error.
1252 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1253 char *name
, struct lttng_filter_bytecode
*filter
,
1255 const struct lttng_event_exclusion
*exclusion
)
1257 struct lttng_ht_iter iter
;
1258 struct lttng_ht_node_str
*node
;
1259 struct ust_app_event
*event
= NULL
;
1260 struct ust_app_ht_key key
;
1265 /* Setup key for event lookup. */
1267 key
.filter
= filter
;
1268 key
.loglevel_type
= loglevel_value
;
1269 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1270 key
.exclusion
= exclusion
;
1272 /* Lookup using the event name as hash and a custom match fct. */
1273 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1274 ht_match_ust_app_event
, &key
, &iter
.iter
);
1275 node
= lttng_ht_iter_get_node_str(&iter
);
1280 event
= caa_container_of(node
, struct ust_app_event
, node
);
1287 * Create the channel context on the tracer.
1289 * Called with UST app session lock held.
1292 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1293 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1297 health_code_update();
1299 pthread_mutex_lock(&app
->sock_lock
);
1300 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1301 ua_chan
->obj
, &ua_ctx
->obj
);
1302 pthread_mutex_unlock(&app
->sock_lock
);
1304 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1305 ERR("UST app create channel context failed for app (pid: %d) "
1306 "with ret %d", app
->pid
, ret
);
1309 * This is normal behavior, an application can die during the
1310 * creation process. Don't report an error so the execution can
1311 * continue normally.
1314 DBG3("UST app disable event failed. Application is dead.");
1319 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1321 DBG2("UST app context handle %d created successfully for channel %s",
1322 ua_ctx
->handle
, ua_chan
->name
);
1325 health_code_update();
1330 * Set the filter on the tracer.
1333 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1334 struct ust_app
*app
)
1337 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1339 health_code_update();
1341 if (!ua_event
->filter
) {
1346 ust_bytecode
= create_ust_bytecode_from_bytecode(ua_event
->filter
);
1347 if (!ust_bytecode
) {
1348 ret
= -LTTNG_ERR_NOMEM
;
1351 pthread_mutex_lock(&app
->sock_lock
);
1352 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1354 pthread_mutex_unlock(&app
->sock_lock
);
1356 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1357 ERR("UST app event %s filter failed for app (pid: %d) "
1358 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1361 * This is normal behavior, an application can die during the
1362 * creation process. Don't report an error so the execution can
1363 * continue normally.
1366 DBG3("UST app filter event failed. Application is dead.");
1371 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1374 health_code_update();
1380 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1381 struct lttng_event_exclusion
*exclusion
)
1383 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1384 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1385 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1387 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1388 if (!ust_exclusion
) {
1393 assert(sizeof(struct lttng_event_exclusion
) ==
1394 sizeof(struct lttng_ust_event_exclusion
));
1395 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1397 return ust_exclusion
;
1401 * Set event exclusions on the tracer.
1404 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1405 struct ust_app
*app
)
1408 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1410 health_code_update();
1412 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1417 ust_exclusion
= create_ust_exclusion_from_exclusion(
1418 ua_event
->exclusion
);
1419 if (!ust_exclusion
) {
1420 ret
= -LTTNG_ERR_NOMEM
;
1423 pthread_mutex_lock(&app
->sock_lock
);
1424 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1425 pthread_mutex_unlock(&app
->sock_lock
);
1427 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1428 ERR("UST app event %s exclusions failed for app (pid: %d) "
1429 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1432 * This is normal behavior, an application can die during the
1433 * creation process. Don't report an error so the execution can
1434 * continue normally.
1437 DBG3("UST app event exclusion failed. Application is dead.");
1442 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1445 health_code_update();
1446 free(ust_exclusion
);
1451 * Disable the specified event on to UST tracer for the UST session.
1453 static int disable_ust_event(struct ust_app
*app
,
1454 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1458 health_code_update();
1460 pthread_mutex_lock(&app
->sock_lock
);
1461 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1462 pthread_mutex_unlock(&app
->sock_lock
);
1464 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1465 ERR("UST app event %s disable failed for app (pid: %d) "
1466 "and session handle %d with ret %d",
1467 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1470 * This is normal behavior, an application can die during the
1471 * creation process. Don't report an error so the execution can
1472 * continue normally.
1475 DBG3("UST app disable event failed. Application is dead.");
1480 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1481 ua_event
->attr
.name
, app
->pid
);
1484 health_code_update();
1489 * Disable the specified channel on to UST tracer for the UST session.
1491 static int disable_ust_channel(struct ust_app
*app
,
1492 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1496 health_code_update();
1498 pthread_mutex_lock(&app
->sock_lock
);
1499 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1500 pthread_mutex_unlock(&app
->sock_lock
);
1502 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1503 ERR("UST app channel %s disable failed for app (pid: %d) "
1504 "and session handle %d with ret %d",
1505 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1508 * This is normal behavior, an application can die during the
1509 * creation process. Don't report an error so the execution can
1510 * continue normally.
1513 DBG3("UST app disable channel failed. Application is dead.");
1518 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1519 ua_chan
->name
, app
->pid
);
1522 health_code_update();
1527 * Enable the specified channel on to UST tracer for the UST session.
1529 static int enable_ust_channel(struct ust_app
*app
,
1530 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1534 health_code_update();
1536 pthread_mutex_lock(&app
->sock_lock
);
1537 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1538 pthread_mutex_unlock(&app
->sock_lock
);
1540 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1541 ERR("UST app channel %s enable failed for app (pid: %d) "
1542 "and session handle %d with ret %d",
1543 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1546 * This is normal behavior, an application can die during the
1547 * creation process. Don't report an error so the execution can
1548 * continue normally.
1551 DBG3("UST app enable channel failed. Application is dead.");
1556 ua_chan
->enabled
= 1;
1558 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1559 ua_chan
->name
, app
->pid
);
1562 health_code_update();
1567 * Enable the specified event on to UST tracer for the UST session.
1569 static int enable_ust_event(struct ust_app
*app
,
1570 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1574 health_code_update();
1576 pthread_mutex_lock(&app
->sock_lock
);
1577 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1578 pthread_mutex_unlock(&app
->sock_lock
);
1580 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1581 ERR("UST app event %s enable failed for app (pid: %d) "
1582 "and session handle %d with ret %d",
1583 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1586 * This is normal behavior, an application can die during the
1587 * creation process. Don't report an error so the execution can
1588 * continue normally.
1591 DBG3("UST app enable event failed. Application is dead.");
1596 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1597 ua_event
->attr
.name
, app
->pid
);
1600 health_code_update();
1605 * Send channel and stream buffer to application.
1607 * Return 0 on success. On error, a negative value is returned.
1609 static int send_channel_pid_to_ust(struct ust_app
*app
,
1610 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1613 struct ust_app_stream
*stream
, *stmp
;
1619 health_code_update();
1621 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1624 /* Send channel to the application. */
1625 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1626 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1627 ret
= -ENOTCONN
; /* Caused by app exiting. */
1629 } else if (ret
< 0) {
1633 health_code_update();
1635 /* Send all streams to application. */
1636 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1637 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1638 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1639 ret
= -ENOTCONN
; /* Caused by app exiting. */
1641 } else if (ret
< 0) {
1644 /* We don't need the stream anymore once sent to the tracer. */
1645 cds_list_del(&stream
->list
);
1646 delete_ust_app_stream(-1, stream
, app
);
1648 /* Flag the channel that it is sent to the application. */
1649 ua_chan
->is_sent
= 1;
1652 health_code_update();
1657 * Create the specified event onto the UST tracer for a UST session.
1659 * Should be called with session mutex held.
1662 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1663 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1667 health_code_update();
1669 /* Create UST event on tracer */
1670 pthread_mutex_lock(&app
->sock_lock
);
1671 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1673 pthread_mutex_unlock(&app
->sock_lock
);
1675 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1676 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1677 ua_event
->attr
.name
, app
->pid
, ret
);
1680 * This is normal behavior, an application can die during the
1681 * creation process. Don't report an error so the execution can
1682 * continue normally.
1685 DBG3("UST app create event failed. Application is dead.");
1690 ua_event
->handle
= ua_event
->obj
->handle
;
1692 DBG2("UST app event %s created successfully for pid:%d",
1693 ua_event
->attr
.name
, app
->pid
);
1695 health_code_update();
1697 /* Set filter if one is present. */
1698 if (ua_event
->filter
) {
1699 ret
= set_ust_event_filter(ua_event
, app
);
1705 /* Set exclusions for the event */
1706 if (ua_event
->exclusion
) {
1707 ret
= set_ust_event_exclusion(ua_event
, app
);
1713 /* If event not enabled, disable it on the tracer */
1714 if (ua_event
->enabled
) {
1716 * We now need to explicitly enable the event, since it
1717 * is now disabled at creation.
1719 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1722 * If we hit an EPERM, something is wrong with our enable call. If
1723 * we get an EEXIST, there is a problem on the tracer side since we
1727 case -LTTNG_UST_ERR_PERM
:
1728 /* Code flow problem */
1730 case -LTTNG_UST_ERR_EXIST
:
1731 /* It's OK for our use case. */
1742 health_code_update();
1747 * Copy data between an UST app event and a LTT event.
1749 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1750 struct ltt_ust_event
*uevent
)
1752 size_t exclusion_alloc_size
;
1754 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1755 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1757 ua_event
->enabled
= uevent
->enabled
;
1759 /* Copy event attributes */
1760 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1762 /* Copy filter bytecode */
1763 if (uevent
->filter
) {
1764 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1765 /* Filter might be NULL here in case of ENONEM. */
1768 /* Copy exclusion data */
1769 if (uevent
->exclusion
) {
1770 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1771 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1772 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1773 if (ua_event
->exclusion
== NULL
) {
1776 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1777 exclusion_alloc_size
);
1783 * Copy data between an UST app channel and a LTT channel.
1785 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1786 struct ltt_ust_channel
*uchan
)
1788 struct lttng_ht_iter iter
;
1789 struct ltt_ust_event
*uevent
;
1790 struct ltt_ust_context
*uctx
;
1791 struct ust_app_event
*ua_event
;
1793 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1795 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1796 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1798 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1799 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1801 /* Copy event attributes since the layout is different. */
1802 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1803 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1804 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1805 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1806 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1807 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
1808 ua_chan
->attr
.output
= uchan
->attr
.output
;
1809 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
1812 * Note that the attribute channel type is not set since the channel on the
1813 * tracing registry side does not have this information.
1816 ua_chan
->enabled
= uchan
->enabled
;
1817 ua_chan
->tracing_channel_id
= uchan
->id
;
1819 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1820 struct ust_app_ctx
*ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1822 if (ua_ctx
== NULL
) {
1825 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1826 (unsigned long) ua_ctx
->ctx
.ctx
);
1827 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1828 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1831 /* Copy all events from ltt ust channel to ust app channel */
1832 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1833 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1834 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1835 if (ua_event
== NULL
) {
1836 DBG2("UST event %s not found on shadow copy channel",
1838 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1839 if (ua_event
== NULL
) {
1842 shadow_copy_event(ua_event
, uevent
);
1843 add_unique_ust_app_event(ua_chan
, ua_event
);
1847 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1851 * Copy data between a UST app session and a regular LTT session.
1853 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1854 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1856 struct lttng_ht_node_str
*ua_chan_node
;
1857 struct lttng_ht_iter iter
;
1858 struct ltt_ust_channel
*uchan
;
1859 struct ust_app_channel
*ua_chan
;
1861 struct tm
*timeinfo
;
1864 char tmp_shm_path
[PATH_MAX
];
1866 /* Get date and time for unique app path */
1868 timeinfo
= localtime(&rawtime
);
1869 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1871 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1873 ua_sess
->tracing_id
= usess
->id
;
1874 ua_sess
->id
= get_next_session_id();
1875 ua_sess
->uid
= app
->uid
;
1876 ua_sess
->gid
= app
->gid
;
1877 ua_sess
->euid
= usess
->uid
;
1878 ua_sess
->egid
= usess
->gid
;
1879 ua_sess
->buffer_type
= usess
->buffer_type
;
1880 ua_sess
->bits_per_long
= app
->bits_per_long
;
1882 /* There is only one consumer object per session possible. */
1883 consumer_output_get(usess
->consumer
);
1884 ua_sess
->consumer
= usess
->consumer
;
1886 ua_sess
->output_traces
= usess
->output_traces
;
1887 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1888 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1889 &usess
->metadata_attr
);
1891 switch (ua_sess
->buffer_type
) {
1892 case LTTNG_BUFFER_PER_PID
:
1893 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1894 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1897 case LTTNG_BUFFER_PER_UID
:
1898 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1899 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1906 PERROR("asprintf UST shadow copy session");
1911 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1912 sizeof(ua_sess
->root_shm_path
));
1913 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1914 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1915 sizeof(ua_sess
->shm_path
));
1916 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1917 if (ua_sess
->shm_path
[0]) {
1918 switch (ua_sess
->buffer_type
) {
1919 case LTTNG_BUFFER_PER_PID
:
1920 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1921 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1922 app
->name
, app
->pid
, datetime
);
1924 case LTTNG_BUFFER_PER_UID
:
1925 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1926 DEFAULT_UST_TRACE_UID_PATH
,
1927 app
->uid
, app
->bits_per_long
);
1934 PERROR("sprintf UST shadow copy session");
1938 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1939 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1940 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1943 /* Iterate over all channels in global domain. */
1944 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1946 struct lttng_ht_iter uiter
;
1948 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1949 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1950 if (ua_chan_node
!= NULL
) {
1951 /* Session exist. Contiuing. */
1955 DBG2("Channel %s not found on shadow session copy, creating it",
1957 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
,
1959 if (ua_chan
== NULL
) {
1960 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1963 shadow_copy_channel(ua_chan
, uchan
);
1965 * The concept of metadata channel does not exist on the tracing
1966 * registry side of the session daemon so this can only be a per CPU
1967 * channel and not metadata.
1969 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1971 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1976 consumer_output_put(ua_sess
->consumer
);
1980 * Lookup sesison wrapper.
1983 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1984 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1986 /* Get right UST app session from app */
1987 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1991 * Return ust app session from the app session hashtable using the UST session
1994 static struct ust_app_session
*lookup_session_by_app(
1995 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1997 struct lttng_ht_iter iter
;
1998 struct lttng_ht_node_u64
*node
;
2000 __lookup_session_by_app(usess
, app
, &iter
);
2001 node
= lttng_ht_iter_get_node_u64(&iter
);
2006 return caa_container_of(node
, struct ust_app_session
, node
);
2013 * Setup buffer registry per PID for the given session and application. If none
2014 * is found, a new one is created, added to the global registry and
2015 * initialized. If regp is valid, it's set with the newly created object.
2017 * Return 0 on success or else a negative value.
2019 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2020 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2023 struct buffer_reg_pid
*reg_pid
;
2030 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2033 * This is the create channel path meaning that if there is NO
2034 * registry available, we have to create one for this session.
2036 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2037 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2045 /* Initialize registry. */
2046 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2047 app
->bits_per_long
, app
->uint8_t_alignment
,
2048 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2049 app
->uint64_t_alignment
, app
->long_alignment
,
2050 app
->byte_order
, app
->version
.major
,
2051 app
->version
.minor
, reg_pid
->root_shm_path
,
2053 ua_sess
->euid
, ua_sess
->egid
);
2056 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2057 * destroy the buffer registry, because it is always expected
2058 * that if the buffer registry can be found, its ust registry is
2061 buffer_reg_pid_destroy(reg_pid
);
2065 buffer_reg_pid_add(reg_pid
);
2067 DBG3("UST app buffer registry per PID created successfully");
2079 * Setup buffer registry per UID for the given session and application. If none
2080 * is found, a new one is created, added to the global registry and
2081 * initialized. If regp is valid, it's set with the newly created object.
2083 * Return 0 on success or else a negative value.
2085 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2086 struct ust_app_session
*ua_sess
,
2087 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2090 struct buffer_reg_uid
*reg_uid
;
2097 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2100 * This is the create channel path meaning that if there is NO
2101 * registry available, we have to create one for this session.
2103 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2104 LTTNG_DOMAIN_UST
, ®_uid
,
2105 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2113 /* Initialize registry. */
2114 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2115 app
->bits_per_long
, app
->uint8_t_alignment
,
2116 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2117 app
->uint64_t_alignment
, app
->long_alignment
,
2118 app
->byte_order
, app
->version
.major
,
2119 app
->version
.minor
, reg_uid
->root_shm_path
,
2120 reg_uid
->shm_path
, usess
->uid
, usess
->gid
);
2123 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2124 * destroy the buffer registry, because it is always expected
2125 * that if the buffer registry can be found, its ust registry is
2128 buffer_reg_uid_destroy(reg_uid
, NULL
);
2131 /* Add node to teardown list of the session. */
2132 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2134 buffer_reg_uid_add(reg_uid
);
2136 DBG3("UST app buffer registry per UID created successfully");
2147 * Create a session on the tracer side for the given app.
2149 * On success, ua_sess_ptr is populated with the session pointer or else left
2150 * untouched. If the session was created, is_created is set to 1. On error,
2151 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2154 * Returns 0 on success or else a negative code which is either -ENOMEM or
2155 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2157 static int create_ust_app_session(struct ltt_ust_session
*usess
,
2158 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2161 int ret
, created
= 0;
2162 struct ust_app_session
*ua_sess
;
2166 assert(ua_sess_ptr
);
2168 health_code_update();
2170 ua_sess
= lookup_session_by_app(usess
, app
);
2171 if (ua_sess
== NULL
) {
2172 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2173 app
->pid
, usess
->id
);
2174 ua_sess
= alloc_ust_app_session(app
);
2175 if (ua_sess
== NULL
) {
2176 /* Only malloc can failed so something is really wrong */
2180 shadow_copy_session(ua_sess
, usess
, app
);
2184 switch (usess
->buffer_type
) {
2185 case LTTNG_BUFFER_PER_PID
:
2186 /* Init local registry. */
2187 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2189 delete_ust_app_session(-1, ua_sess
, app
);
2193 case LTTNG_BUFFER_PER_UID
:
2194 /* Look for a global registry. If none exists, create one. */
2195 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2197 delete_ust_app_session(-1, ua_sess
, app
);
2207 health_code_update();
2209 if (ua_sess
->handle
== -1) {
2210 pthread_mutex_lock(&app
->sock_lock
);
2211 ret
= ustctl_create_session(app
->sock
);
2212 pthread_mutex_unlock(&app
->sock_lock
);
2214 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2215 ERR("Creating session for app pid %d with ret %d",
2218 DBG("UST app creating session failed. Application is dead");
2220 * This is normal behavior, an application can die during the
2221 * creation process. Don't report an error so the execution can
2222 * continue normally. This will get flagged ENOTCONN and the
2223 * caller will handle it.
2227 delete_ust_app_session(-1, ua_sess
, app
);
2228 if (ret
!= -ENOMEM
) {
2230 * Tracer is probably gone or got an internal error so let's
2231 * behave like it will soon unregister or not usable.
2238 ua_sess
->handle
= ret
;
2240 /* Add ust app session to app's HT */
2241 lttng_ht_node_init_u64(&ua_sess
->node
,
2242 ua_sess
->tracing_id
);
2243 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2244 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2245 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2246 &ua_sess
->ust_objd_node
);
2248 DBG2("UST app session created successfully with handle %d", ret
);
2251 *ua_sess_ptr
= ua_sess
;
2253 *is_created
= created
;
2256 /* Everything went well. */
2260 health_code_update();
2265 * Match function for a hash table lookup of ust_app_ctx.
2267 * It matches an ust app context based on the context type and, in the case
2268 * of perf counters, their name.
2270 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2272 struct ust_app_ctx
*ctx
;
2273 const struct lttng_ust_context_attr
*key
;
2278 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2282 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2287 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2288 if (strncmp(key
->u
.perf_counter
.name
,
2289 ctx
->ctx
.u
.perf_counter
.name
,
2290 sizeof(key
->u
.perf_counter
.name
))) {
2294 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2295 if (strcmp(key
->u
.app_ctx
.provider_name
,
2296 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2297 strcmp(key
->u
.app_ctx
.ctx_name
,
2298 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2314 * Lookup for an ust app context from an lttng_ust_context.
2316 * Must be called while holding RCU read side lock.
2317 * Return an ust_app_ctx object or NULL on error.
2320 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2321 struct lttng_ust_context_attr
*uctx
)
2323 struct lttng_ht_iter iter
;
2324 struct lttng_ht_node_ulong
*node
;
2325 struct ust_app_ctx
*app_ctx
= NULL
;
2330 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2331 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2332 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2333 node
= lttng_ht_iter_get_node_ulong(&iter
);
2338 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2345 * Create a context for the channel on the tracer.
2347 * Called with UST app session lock held and a RCU read side lock.
2350 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2351 struct ust_app_channel
*ua_chan
,
2352 struct lttng_ust_context_attr
*uctx
,
2353 struct ust_app
*app
)
2356 struct ust_app_ctx
*ua_ctx
;
2358 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2360 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2366 ua_ctx
= alloc_ust_app_ctx(uctx
);
2367 if (ua_ctx
== NULL
) {
2373 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2374 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2375 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2377 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2387 * Enable on the tracer side a ust app event for the session and channel.
2389 * Called with UST app session lock held.
2392 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2393 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2397 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2402 ua_event
->enabled
= 1;
2409 * Disable on the tracer side a ust app event for the session and channel.
2411 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2412 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2416 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2421 ua_event
->enabled
= 0;
2428 * Lookup ust app channel for session and disable it on the tracer side.
2431 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2432 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2436 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2441 ua_chan
->enabled
= 0;
2448 * Lookup ust app channel for session and enable it on the tracer side. This
2449 * MUST be called with a RCU read side lock acquired.
2451 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2452 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2455 struct lttng_ht_iter iter
;
2456 struct lttng_ht_node_str
*ua_chan_node
;
2457 struct ust_app_channel
*ua_chan
;
2459 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2460 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2461 if (ua_chan_node
== NULL
) {
2462 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2463 uchan
->name
, ua_sess
->tracing_id
);
2467 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2469 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2479 * Ask the consumer to create a channel and get it if successful.
2481 * Called with UST app session lock held.
2483 * Return 0 on success or else a negative value.
2485 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2486 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2487 int bitness
, struct ust_registry_session
*registry
)
2490 unsigned int nb_fd
= 0;
2491 struct consumer_socket
*socket
;
2499 health_code_update();
2501 /* Get the right consumer socket for the application. */
2502 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2508 health_code_update();
2510 /* Need one fd for the channel. */
2511 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2513 ERR("Exhausted number of available FD upon create channel");
2518 * Ask consumer to create channel. The consumer will return the number of
2519 * stream we have to expect.
2521 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2528 * Compute the number of fd needed before receiving them. It must be 2 per
2529 * stream (2 being the default value here).
2531 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2533 /* Reserve the amount of file descriptor we need. */
2534 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2536 ERR("Exhausted number of available FD upon create channel");
2537 goto error_fd_get_stream
;
2540 health_code_update();
2543 * Now get the channel from the consumer. This call wil populate the stream
2544 * list of that channel and set the ust objects.
2546 if (usess
->consumer
->enabled
) {
2547 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2557 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2558 error_fd_get_stream
:
2560 * Initiate a destroy channel on the consumer since we had an error
2561 * handling it on our side. The return value is of no importance since we
2562 * already have a ret value set by the previous error that we need to
2565 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2567 lttng_fd_put(LTTNG_FD_APPS
, 1);
2569 health_code_update();
2575 * Duplicate the ust data object of the ust app stream and save it in the
2576 * buffer registry stream.
2578 * Return 0 on success or else a negative value.
2580 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2581 struct ust_app_stream
*stream
)
2588 /* Reserve the amount of file descriptor we need. */
2589 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2591 ERR("Exhausted number of available FD upon duplicate stream");
2595 /* Duplicate object for stream once the original is in the registry. */
2596 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2597 reg_stream
->obj
.ust
);
2599 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2600 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2601 lttng_fd_put(LTTNG_FD_APPS
, 2);
2604 stream
->handle
= stream
->obj
->handle
;
2611 * Duplicate the ust data object of the ust app. channel and save it in the
2612 * buffer registry channel.
2614 * Return 0 on success or else a negative value.
2616 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2617 struct ust_app_channel
*ua_chan
)
2624 /* Need two fds for the channel. */
2625 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2627 ERR("Exhausted number of available FD upon duplicate channel");
2631 /* Duplicate object for stream once the original is in the registry. */
2632 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2634 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2635 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2638 ua_chan
->handle
= ua_chan
->obj
->handle
;
2643 lttng_fd_put(LTTNG_FD_APPS
, 1);
2649 * For a given channel buffer registry, setup all streams of the given ust
2650 * application channel.
2652 * Return 0 on success or else a negative value.
2654 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2655 struct ust_app_channel
*ua_chan
,
2656 struct ust_app
*app
)
2659 struct ust_app_stream
*stream
, *stmp
;
2664 DBG2("UST app setup buffer registry stream");
2666 /* Send all streams to application. */
2667 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2668 struct buffer_reg_stream
*reg_stream
;
2670 ret
= buffer_reg_stream_create(®_stream
);
2676 * Keep original pointer and nullify it in the stream so the delete
2677 * stream call does not release the object.
2679 reg_stream
->obj
.ust
= stream
->obj
;
2681 buffer_reg_stream_add(reg_stream
, reg_chan
);
2683 /* We don't need the streams anymore. */
2684 cds_list_del(&stream
->list
);
2685 delete_ust_app_stream(-1, stream
, app
);
2693 * Create a buffer registry channel for the given session registry and
2694 * application channel object. If regp pointer is valid, it's set with the
2695 * created object. Important, the created object is NOT added to the session
2696 * registry hash table.
2698 * Return 0 on success else a negative value.
2700 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2701 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2704 struct buffer_reg_channel
*reg_chan
= NULL
;
2709 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2711 /* Create buffer registry channel. */
2712 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2717 reg_chan
->consumer_key
= ua_chan
->key
;
2718 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2719 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2721 /* Create and add a channel registry to session. */
2722 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2723 ua_chan
->tracing_channel_id
);
2727 buffer_reg_channel_add(reg_sess
, reg_chan
);
2736 /* Safe because the registry channel object was not added to any HT. */
2737 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2743 * Setup buffer registry channel for the given session registry and application
2744 * channel object. If regp pointer is valid, it's set with the created object.
2746 * Return 0 on success else a negative value.
2748 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2749 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2750 struct ust_app
*app
)
2757 assert(ua_chan
->obj
);
2759 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2761 /* Setup all streams for the registry. */
2762 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2767 reg_chan
->obj
.ust
= ua_chan
->obj
;
2768 ua_chan
->obj
= NULL
;
2773 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2774 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2779 * Send buffer registry channel to the application.
2781 * Return 0 on success else a negative value.
2783 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2784 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2785 struct ust_app_channel
*ua_chan
)
2788 struct buffer_reg_stream
*reg_stream
;
2795 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2797 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2802 /* Send channel to the application. */
2803 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2804 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2805 ret
= -ENOTCONN
; /* Caused by app exiting. */
2807 } else if (ret
< 0) {
2811 health_code_update();
2813 /* Send all streams to application. */
2814 pthread_mutex_lock(®_chan
->stream_list_lock
);
2815 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2816 struct ust_app_stream stream
;
2818 ret
= duplicate_stream_object(reg_stream
, &stream
);
2820 goto error_stream_unlock
;
2823 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2825 (void) release_ust_app_stream(-1, &stream
, app
);
2826 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2827 ret
= -ENOTCONN
; /* Caused by app exiting. */
2829 goto error_stream_unlock
;
2833 * The return value is not important here. This function will output an
2836 (void) release_ust_app_stream(-1, &stream
, app
);
2838 ua_chan
->is_sent
= 1;
2840 error_stream_unlock
:
2841 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2847 * Create and send to the application the created buffers with per UID buffers.
2849 * This MUST be called with a RCU read side lock acquired.
2851 * Return 0 on success else a negative value.
2853 static int create_channel_per_uid(struct ust_app
*app
,
2854 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2855 struct ust_app_channel
*ua_chan
)
2858 struct buffer_reg_uid
*reg_uid
;
2859 struct buffer_reg_channel
*reg_chan
;
2860 bool created
= false;
2867 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2869 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2871 * The session creation handles the creation of this global registry
2872 * object. If none can be find, there is a code flow problem or a
2877 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2880 /* Create the buffer registry channel object. */
2881 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2883 ERR("Error creating the UST channel \"%s\" registry instance",
2890 * Create the buffers on the consumer side. This call populates the
2891 * ust app channel object with all streams and data object.
2893 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2894 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2896 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2900 * Let's remove the previously created buffer registry channel so
2901 * it's not visible anymore in the session registry.
2903 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2904 ua_chan
->tracing_channel_id
, false);
2905 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2906 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2911 * Setup the streams and add it to the session registry.
2913 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2914 ua_chan
, reg_chan
, app
);
2916 ERR("Error setting up UST channel \"%s\"",
2924 enum lttng_error_code cmd_ret
;
2925 struct ltt_session
*session
;
2926 uint64_t chan_reg_key
;
2927 struct ust_registry_channel
*chan_reg
;
2929 chan_reg_key
= ua_chan
->tracing_channel_id
;
2931 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
2932 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
2935 chan_reg
->consumer_key
= ua_chan
->key
;
2937 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
2939 session
= session_find_by_id(ua_sess
->tracing_id
);
2942 cmd_ret
= notification_thread_command_add_channel(
2943 notification_thread_handle
, session
->name
,
2944 ua_sess
->euid
, ua_sess
->egid
,
2948 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2949 if (cmd_ret
!= LTTNG_OK
) {
2950 ret
= - (int) cmd_ret
;
2951 ERR("Failed to add channel to notification thread");
2956 /* Send buffers to the application. */
2957 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2959 if (ret
!= -ENOTCONN
) {
2960 ERR("Error sending channel to application");
2970 * Create and send to the application the created buffers with per PID buffers.
2972 * Called with UST app session lock held.
2974 * Return 0 on success else a negative value.
2976 static int create_channel_per_pid(struct ust_app
*app
,
2977 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2978 struct ust_app_channel
*ua_chan
)
2981 struct ust_registry_session
*registry
;
2982 enum lttng_error_code cmd_ret
;
2983 struct ltt_session
*session
;
2984 uint64_t chan_reg_key
;
2985 struct ust_registry_channel
*chan_reg
;
2992 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2996 registry
= get_session_registry(ua_sess
);
2997 /* The UST app session lock is held, registry shall not be null. */
3000 /* Create and add a new channel registry to session. */
3001 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3003 ERR("Error creating the UST channel \"%s\" registry instance",
3008 /* Create and get channel on the consumer side. */
3009 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3010 app
->bits_per_long
, registry
);
3012 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3017 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3019 if (ret
!= -ENOTCONN
) {
3020 ERR("Error sending channel to application");
3025 session
= session_find_by_id(ua_sess
->tracing_id
);
3028 chan_reg_key
= ua_chan
->key
;
3029 pthread_mutex_lock(®istry
->lock
);
3030 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3032 chan_reg
->consumer_key
= ua_chan
->key
;
3033 pthread_mutex_unlock(®istry
->lock
);
3035 cmd_ret
= notification_thread_command_add_channel(
3036 notification_thread_handle
, session
->name
,
3037 ua_sess
->euid
, ua_sess
->egid
,
3041 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3042 if (cmd_ret
!= LTTNG_OK
) {
3043 ret
= - (int) cmd_ret
;
3044 ERR("Failed to add channel to notification thread");
3054 * From an already allocated ust app channel, create the channel buffers if
3055 * need and send it to the application. This MUST be called with a RCU read
3056 * side lock acquired.
3058 * Called with UST app session lock held.
3060 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3061 * the application exited concurrently.
3063 static int do_create_channel(struct ust_app
*app
,
3064 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3065 struct ust_app_channel
*ua_chan
)
3074 /* Handle buffer type before sending the channel to the application. */
3075 switch (usess
->buffer_type
) {
3076 case LTTNG_BUFFER_PER_UID
:
3078 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3084 case LTTNG_BUFFER_PER_PID
:
3086 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3098 /* Initialize ust objd object using the received handle and add it. */
3099 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3100 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3102 /* If channel is not enabled, disable it on the tracer */
3103 if (!ua_chan
->enabled
) {
3104 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3115 * Create UST app channel and create it on the tracer. Set ua_chanp of the
3116 * newly created channel if not NULL.
3118 * Called with UST app session lock and RCU read-side lock held.
3120 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3121 * the application exited concurrently.
3123 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
3124 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
3125 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3126 struct ust_app_channel
**ua_chanp
)
3129 struct lttng_ht_iter iter
;
3130 struct lttng_ht_node_str
*ua_chan_node
;
3131 struct ust_app_channel
*ua_chan
;
3133 /* Lookup channel in the ust app session */
3134 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3135 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3136 if (ua_chan_node
!= NULL
) {
3137 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3141 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3142 if (ua_chan
== NULL
) {
3143 /* Only malloc can fail here */
3147 shadow_copy_channel(ua_chan
, uchan
);
3149 /* Set channel type. */
3150 ua_chan
->attr
.type
= type
;
3152 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
3157 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
3160 /* Only add the channel if successful on the tracer side. */
3161 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3164 *ua_chanp
= ua_chan
;
3167 /* Everything went well. */
3171 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
3177 * Create UST app event and create it on the tracer side.
3179 * Called with ust app session mutex held.
3182 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3183 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3184 struct ust_app
*app
)
3187 struct ust_app_event
*ua_event
;
3189 /* Get event node */
3190 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3191 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3192 if (ua_event
!= NULL
) {
3197 /* Does not exist so create one */
3198 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3199 if (ua_event
== NULL
) {
3200 /* Only malloc can failed so something is really wrong */
3204 shadow_copy_event(ua_event
, uevent
);
3206 /* Create it on the tracer side */
3207 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3209 /* Not found previously means that it does not exist on the tracer */
3210 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
3214 add_unique_ust_app_event(ua_chan
, ua_event
);
3216 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3223 /* Valid. Calling here is already in a read side lock */
3224 delete_ust_app_event(-1, ua_event
, app
);
3229 * Create UST metadata and open it on the tracer side.
3231 * Called with UST app session lock held and RCU read side lock.
3233 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3234 struct ust_app
*app
, struct consumer_output
*consumer
)
3237 struct ust_app_channel
*metadata
;
3238 struct consumer_socket
*socket
;
3239 struct ust_registry_session
*registry
;
3245 registry
= get_session_registry(ua_sess
);
3246 /* The UST app session is held registry shall not be null. */
3249 pthread_mutex_lock(®istry
->lock
);
3251 /* Metadata already exists for this registry or it was closed previously */
3252 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3257 /* Allocate UST metadata */
3258 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3260 /* malloc() failed */
3265 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3267 /* Need one fd for the channel. */
3268 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3270 ERR("Exhausted number of available FD upon create metadata");
3274 /* Get the right consumer socket for the application. */
3275 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3278 goto error_consumer
;
3282 * Keep metadata key so we can identify it on the consumer side. Assign it
3283 * to the registry *before* we ask the consumer so we avoid the race of the
3284 * consumer requesting the metadata and the ask_channel call on our side
3285 * did not returned yet.
3287 registry
->metadata_key
= metadata
->key
;
3290 * Ask the metadata channel creation to the consumer. The metadata object
3291 * will be created by the consumer and kept their. However, the stream is
3292 * never added or monitored until we do a first push metadata to the
3295 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3298 /* Nullify the metadata key so we don't try to close it later on. */
3299 registry
->metadata_key
= 0;
3300 goto error_consumer
;
3304 * The setup command will make the metadata stream be sent to the relayd,
3305 * if applicable, and the thread managing the metadatas. This is important
3306 * because after this point, if an error occurs, the only way the stream
3307 * can be deleted is to be monitored in the consumer.
3309 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3311 /* Nullify the metadata key so we don't try to close it later on. */
3312 registry
->metadata_key
= 0;
3313 goto error_consumer
;
3316 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3317 metadata
->key
, app
->pid
);
3320 lttng_fd_put(LTTNG_FD_APPS
, 1);
3321 delete_ust_app_channel(-1, metadata
, app
);
3323 pthread_mutex_unlock(®istry
->lock
);
3328 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3329 * acquired before calling this function.
3331 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3333 struct ust_app
*app
= NULL
;
3334 struct lttng_ht_node_ulong
*node
;
3335 struct lttng_ht_iter iter
;
3337 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3338 node
= lttng_ht_iter_get_node_ulong(&iter
);
3340 DBG2("UST app no found with pid %d", pid
);
3344 DBG2("Found UST app by pid %d", pid
);
3346 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3353 * Allocate and init an UST app object using the registration information and
3354 * the command socket. This is called when the command socket connects to the
3357 * The object is returned on success or else NULL.
3359 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3361 struct ust_app
*lta
= NULL
;
3366 DBG3("UST app creating application for socket %d", sock
);
3368 if ((msg
->bits_per_long
== 64 &&
3369 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3370 || (msg
->bits_per_long
== 32 &&
3371 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3372 ERR("Registration failed: application \"%s\" (pid: %d) has "
3373 "%d-bit long, but no consumerd for this size is available.\n",
3374 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3378 lta
= zmalloc(sizeof(struct ust_app
));
3384 lta
->ppid
= msg
->ppid
;
3385 lta
->uid
= msg
->uid
;
3386 lta
->gid
= msg
->gid
;
3388 lta
->bits_per_long
= msg
->bits_per_long
;
3389 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3390 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3391 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3392 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3393 lta
->long_alignment
= msg
->long_alignment
;
3394 lta
->byte_order
= msg
->byte_order
;
3396 lta
->v_major
= msg
->major
;
3397 lta
->v_minor
= msg
->minor
;
3398 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3399 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3400 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3401 lta
->notify_sock
= -1;
3403 /* Copy name and make sure it's NULL terminated. */
3404 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3405 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3408 * Before this can be called, when receiving the registration information,
3409 * the application compatibility is checked. So, at this point, the
3410 * application can work with this session daemon.
3412 lta
->compatible
= 1;
3414 lta
->pid
= msg
->pid
;
3415 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3417 pthread_mutex_init(<a
->sock_lock
, NULL
);
3418 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3420 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3426 * For a given application object, add it to every hash table.
3428 void ust_app_add(struct ust_app
*app
)
3431 assert(app
->notify_sock
>= 0);
3436 * On a re-registration, we want to kick out the previous registration of
3439 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3442 * The socket _should_ be unique until _we_ call close. So, a add_unique
3443 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3444 * already in the table.
3446 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3448 /* Add application to the notify socket hash table. */
3449 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3450 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3452 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3453 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3454 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3461 * Set the application version into the object.
3463 * Return 0 on success else a negative value either an errno code or a
3464 * LTTng-UST error code.
3466 int ust_app_version(struct ust_app
*app
)
3472 pthread_mutex_lock(&app
->sock_lock
);
3473 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3474 pthread_mutex_unlock(&app
->sock_lock
);
3476 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3477 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3479 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3487 * Unregister app by removing it from the global traceable app list and freeing
3490 * The socket is already closed at this point so no close to sock.
3492 void ust_app_unregister(int sock
)
3494 struct ust_app
*lta
;
3495 struct lttng_ht_node_ulong
*node
;
3496 struct lttng_ht_iter ust_app_sock_iter
;
3497 struct lttng_ht_iter iter
;
3498 struct ust_app_session
*ua_sess
;
3503 /* Get the node reference for a call_rcu */
3504 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3505 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3508 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3509 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3512 * For per-PID buffers, perform "push metadata" and flush all
3513 * application streams before removing app from hash tables,
3514 * ensuring proper behavior of data_pending check.
3515 * Remove sessions so they are not visible during deletion.
3517 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3519 struct ust_registry_session
*registry
;
3521 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3523 /* The session was already removed so scheduled for teardown. */
3527 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3528 (void) ust_app_flush_app_session(lta
, ua_sess
);
3532 * Add session to list for teardown. This is safe since at this point we
3533 * are the only one using this list.
3535 pthread_mutex_lock(&ua_sess
->lock
);
3537 if (ua_sess
->deleted
) {
3538 pthread_mutex_unlock(&ua_sess
->lock
);
3543 * Normally, this is done in the delete session process which is
3544 * executed in the call rcu below. However, upon registration we can't
3545 * afford to wait for the grace period before pushing data or else the
3546 * data pending feature can race between the unregistration and stop
3547 * command where the data pending command is sent *before* the grace
3550 * The close metadata below nullifies the metadata pointer in the
3551 * session so the delete session will NOT push/close a second time.
3553 registry
= get_session_registry(ua_sess
);
3555 /* Push metadata for application before freeing the application. */
3556 (void) push_metadata(registry
, ua_sess
->consumer
);
3559 * Don't ask to close metadata for global per UID buffers. Close
3560 * metadata only on destroy trace session in this case. Also, the
3561 * previous push metadata could have flag the metadata registry to
3562 * close so don't send a close command if closed.
3564 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3565 /* And ask to close it for this session registry. */
3566 (void) close_metadata(registry
, ua_sess
->consumer
);
3569 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3571 pthread_mutex_unlock(&ua_sess
->lock
);
3574 /* Remove application from PID hash table */
3575 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3579 * Remove application from notify hash table. The thread handling the
3580 * notify socket could have deleted the node so ignore on error because
3581 * either way it's valid. The close of that socket is handled by the
3582 * apps_notify_thread.
3584 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3585 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3588 * Ignore return value since the node might have been removed before by an
3589 * add replace during app registration because the PID can be reassigned by
3592 iter
.iter
.node
= <a
->pid_n
.node
;
3593 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3595 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3600 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3607 * Fill events array with all events name of all registered apps.
3609 int ust_app_list_events(struct lttng_event
**events
)
3612 size_t nbmem
, count
= 0;
3613 struct lttng_ht_iter iter
;
3614 struct ust_app
*app
;
3615 struct lttng_event
*tmp_event
;
3617 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3618 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3619 if (tmp_event
== NULL
) {
3620 PERROR("zmalloc ust app events");
3627 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3628 struct lttng_ust_tracepoint_iter uiter
;
3630 health_code_update();
3632 if (!app
->compatible
) {
3634 * TODO: In time, we should notice the caller of this error by
3635 * telling him that this is a version error.
3639 pthread_mutex_lock(&app
->sock_lock
);
3640 handle
= ustctl_tracepoint_list(app
->sock
);
3642 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3643 ERR("UST app list events getting handle failed for app pid %d",
3646 pthread_mutex_unlock(&app
->sock_lock
);
3650 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3651 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3652 /* Handle ustctl error. */
3656 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3657 ERR("UST app tp list get failed for app %d with ret %d",
3660 DBG3("UST app tp list get failed. Application is dead");
3662 * This is normal behavior, an application can die during the
3663 * creation process. Don't report an error so the execution can
3664 * continue normally. Continue normal execution.
3669 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3670 if (release_ret
< 0 &&
3671 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3672 release_ret
!= -EPIPE
) {
3673 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3675 pthread_mutex_unlock(&app
->sock_lock
);
3679 health_code_update();
3680 if (count
>= nbmem
) {
3681 /* In case the realloc fails, we free the memory */
3682 struct lttng_event
*new_tmp_event
;
3685 new_nbmem
= nbmem
<< 1;
3686 DBG2("Reallocating event list from %zu to %zu entries",
3688 new_tmp_event
= realloc(tmp_event
,
3689 new_nbmem
* sizeof(struct lttng_event
));
3690 if (new_tmp_event
== NULL
) {
3693 PERROR("realloc ust app events");
3696 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3697 if (release_ret
< 0 &&
3698 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3699 release_ret
!= -EPIPE
) {
3700 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3702 pthread_mutex_unlock(&app
->sock_lock
);
3705 /* Zero the new memory */
3706 memset(new_tmp_event
+ nbmem
, 0,
3707 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3709 tmp_event
= new_tmp_event
;
3711 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3712 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3713 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3714 tmp_event
[count
].pid
= app
->pid
;
3715 tmp_event
[count
].enabled
= -1;
3718 ret
= ustctl_release_handle(app
->sock
, handle
);
3719 pthread_mutex_unlock(&app
->sock_lock
);
3720 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3721 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3726 *events
= tmp_event
;
3728 DBG2("UST app list events done (%zu events)", count
);
3733 health_code_update();
3738 * Fill events array with all events name of all registered apps.
3740 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3743 size_t nbmem
, count
= 0;
3744 struct lttng_ht_iter iter
;
3745 struct ust_app
*app
;
3746 struct lttng_event_field
*tmp_event
;
3748 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3749 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3750 if (tmp_event
== NULL
) {
3751 PERROR("zmalloc ust app event fields");
3758 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3759 struct lttng_ust_field_iter uiter
;
3761 health_code_update();
3763 if (!app
->compatible
) {
3765 * TODO: In time, we should notice the caller of this error by
3766 * telling him that this is a version error.
3770 pthread_mutex_lock(&app
->sock_lock
);
3771 handle
= ustctl_tracepoint_field_list(app
->sock
);
3773 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3774 ERR("UST app list field getting handle failed for app pid %d",
3777 pthread_mutex_unlock(&app
->sock_lock
);
3781 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3782 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3783 /* Handle ustctl error. */
3787 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3788 ERR("UST app tp list field failed for app %d with ret %d",
3791 DBG3("UST app tp list field failed. Application is dead");
3793 * This is normal behavior, an application can die during the
3794 * creation process. Don't report an error so the execution can
3795 * continue normally. Reset list and count for next app.
3800 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3801 pthread_mutex_unlock(&app
->sock_lock
);
3802 if (release_ret
< 0 &&
3803 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3804 release_ret
!= -EPIPE
) {
3805 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3810 health_code_update();
3811 if (count
>= nbmem
) {
3812 /* In case the realloc fails, we free the memory */
3813 struct lttng_event_field
*new_tmp_event
;
3816 new_nbmem
= nbmem
<< 1;
3817 DBG2("Reallocating event field list from %zu to %zu entries",
3819 new_tmp_event
= realloc(tmp_event
,
3820 new_nbmem
* sizeof(struct lttng_event_field
));
3821 if (new_tmp_event
== NULL
) {
3824 PERROR("realloc ust app event fields");
3827 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3828 pthread_mutex_unlock(&app
->sock_lock
);
3830 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3831 release_ret
!= -EPIPE
) {
3832 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3836 /* Zero the new memory */
3837 memset(new_tmp_event
+ nbmem
, 0,
3838 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3840 tmp_event
= new_tmp_event
;
3843 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3844 /* Mapping between these enums matches 1 to 1. */
3845 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3846 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3848 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3849 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3850 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3851 tmp_event
[count
].event
.pid
= app
->pid
;
3852 tmp_event
[count
].event
.enabled
= -1;
3855 ret
= ustctl_release_handle(app
->sock
, handle
);
3856 pthread_mutex_unlock(&app
->sock_lock
);
3858 ret
!= -LTTNG_UST_ERR_EXITING
&&
3860 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3865 *fields
= tmp_event
;
3867 DBG2("UST app list event fields done (%zu events)", count
);
3872 health_code_update();
3877 * Free and clean all traceable apps of the global list.
3879 * Should _NOT_ be called with RCU read-side lock held.
3881 void ust_app_clean_list(void)
3884 struct ust_app
*app
;
3885 struct lttng_ht_iter iter
;
3887 DBG2("UST app cleaning registered apps hash table");
3892 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3893 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3895 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3899 /* Cleanup socket hash table */
3900 if (ust_app_ht_by_sock
) {
3901 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3903 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3908 /* Cleanup notify socket hash table */
3909 if (ust_app_ht_by_notify_sock
) {
3910 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3911 notify_sock_n
.node
) {
3912 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3918 /* Destroy is done only when the ht is empty */
3920 ht_cleanup_push(ust_app_ht
);
3922 if (ust_app_ht_by_sock
) {
3923 ht_cleanup_push(ust_app_ht_by_sock
);
3925 if (ust_app_ht_by_notify_sock
) {
3926 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3931 * Init UST app hash table.
3933 int ust_app_ht_alloc(void)
3935 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3939 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3940 if (!ust_app_ht_by_sock
) {
3943 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3944 if (!ust_app_ht_by_notify_sock
) {
3951 * For a specific UST session, disable the channel for all registered apps.
3953 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3954 struct ltt_ust_channel
*uchan
)
3957 struct lttng_ht_iter iter
;
3958 struct lttng_ht_node_str
*ua_chan_node
;
3959 struct ust_app
*app
;
3960 struct ust_app_session
*ua_sess
;
3961 struct ust_app_channel
*ua_chan
;
3963 if (usess
== NULL
|| uchan
== NULL
) {
3964 ERR("Disabling UST global channel with NULL values");
3969 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3970 uchan
->name
, usess
->id
);
3974 /* For every registered applications */
3975 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3976 struct lttng_ht_iter uiter
;
3977 if (!app
->compatible
) {
3979 * TODO: In time, we should notice the caller of this error by
3980 * telling him that this is a version error.
3984 ua_sess
= lookup_session_by_app(usess
, app
);
3985 if (ua_sess
== NULL
) {
3990 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3991 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3992 /* If the session if found for the app, the channel must be there */
3993 assert(ua_chan_node
);
3995 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3996 /* The channel must not be already disabled */
3997 assert(ua_chan
->enabled
== 1);
3999 /* Disable channel onto application */
4000 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4002 /* XXX: We might want to report this error at some point... */
4014 * For a specific UST session, enable the channel for all registered apps.
4016 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4017 struct ltt_ust_channel
*uchan
)
4020 struct lttng_ht_iter iter
;
4021 struct ust_app
*app
;
4022 struct ust_app_session
*ua_sess
;
4024 if (usess
== NULL
|| uchan
== NULL
) {
4025 ERR("Adding UST global channel to NULL values");
4030 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4031 uchan
->name
, usess
->id
);
4035 /* For every registered applications */
4036 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4037 if (!app
->compatible
) {
4039 * TODO: In time, we should notice the caller of this error by
4040 * telling him that this is a version error.
4044 ua_sess
= lookup_session_by_app(usess
, app
);
4045 if (ua_sess
== NULL
) {
4049 /* Enable channel onto application */
4050 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4052 /* XXX: We might want to report this error at some point... */
4064 * Disable an event in a channel and for a specific session.
4066 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4067 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4070 struct lttng_ht_iter iter
, uiter
;
4071 struct lttng_ht_node_str
*ua_chan_node
;
4072 struct ust_app
*app
;
4073 struct ust_app_session
*ua_sess
;
4074 struct ust_app_channel
*ua_chan
;
4075 struct ust_app_event
*ua_event
;
4077 DBG("UST app disabling event %s for all apps in channel "
4078 "%s for session id %" PRIu64
,
4079 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4083 /* For all registered applications */
4084 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4085 if (!app
->compatible
) {
4087 * TODO: In time, we should notice the caller of this error by
4088 * telling him that this is a version error.
4092 ua_sess
= lookup_session_by_app(usess
, app
);
4093 if (ua_sess
== NULL
) {
4098 /* Lookup channel in the ust app session */
4099 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4100 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4101 if (ua_chan_node
== NULL
) {
4102 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4103 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4106 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4108 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4109 uevent
->filter
, uevent
->attr
.loglevel
,
4111 if (ua_event
== NULL
) {
4112 DBG2("Event %s not found in channel %s for app pid %d."
4113 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4117 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4119 /* XXX: Report error someday... */
4130 * For a specific UST session, create the channel for all registered apps.
4132 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
4133 struct ltt_ust_channel
*uchan
)
4135 int ret
= 0, created
;
4136 struct lttng_ht_iter iter
;
4137 struct ust_app
*app
;
4138 struct ust_app_session
*ua_sess
= NULL
;
4140 /* Very wrong code flow */
4144 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
4145 uchan
->name
, usess
->id
);
4149 /* For every registered applications */
4150 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4151 if (!app
->compatible
) {
4153 * TODO: In time, we should notice the caller of this error by
4154 * telling him that this is a version error.
4158 if (!trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
4164 * Create session on the tracer side and add it to app session HT. Note
4165 * that if session exist, it will simply return a pointer to the ust
4168 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
4173 * The application's socket is not valid. Either a bad socket
4174 * or a timeout on it. We can't inform the caller that for a
4175 * specific app, the session failed so lets continue here.
4177 ret
= 0; /* Not an error. */
4181 goto error_rcu_unlock
;
4186 pthread_mutex_lock(&ua_sess
->lock
);
4188 if (ua_sess
->deleted
) {
4189 pthread_mutex_unlock(&ua_sess
->lock
);
4193 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4194 sizeof(uchan
->name
))) {
4195 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
4198 /* Create channel onto application. We don't need the chan ref. */
4199 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
4200 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
4202 pthread_mutex_unlock(&ua_sess
->lock
);
4204 /* Cleanup the created session if it's the case. */
4206 destroy_app_session(app
, ua_sess
);
4211 * The application's socket is not valid. Either a bad socket
4212 * or a timeout on it. We can't inform the caller that for a
4213 * specific app, the session failed so lets continue here.
4215 ret
= 0; /* Not an error. */
4219 goto error_rcu_unlock
;
4230 * Enable event for a specific session and channel on the tracer.
4232 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4233 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4236 struct lttng_ht_iter iter
, uiter
;
4237 struct lttng_ht_node_str
*ua_chan_node
;
4238 struct ust_app
*app
;
4239 struct ust_app_session
*ua_sess
;
4240 struct ust_app_channel
*ua_chan
;
4241 struct ust_app_event
*ua_event
;
4243 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4244 uevent
->attr
.name
, usess
->id
);
4247 * NOTE: At this point, this function is called only if the session and
4248 * channel passed are already created for all apps. and enabled on the
4254 /* For all registered applications */
4255 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4256 if (!app
->compatible
) {
4258 * TODO: In time, we should notice the caller of this error by
4259 * telling him that this is a version error.
4263 ua_sess
= lookup_session_by_app(usess
, app
);
4265 /* The application has problem or is probably dead. */
4269 pthread_mutex_lock(&ua_sess
->lock
);
4271 if (ua_sess
->deleted
) {
4272 pthread_mutex_unlock(&ua_sess
->lock
);
4276 /* Lookup channel in the ust app session */
4277 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4278 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4280 * It is possible that the channel cannot be found is
4281 * the channel/event creation occurs concurrently with
4282 * an application exit.
4284 if (!ua_chan_node
) {
4285 pthread_mutex_unlock(&ua_sess
->lock
);
4289 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4291 /* Get event node */
4292 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4293 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4294 if (ua_event
== NULL
) {
4295 DBG3("UST app enable event %s not found for app PID %d."
4296 "Skipping app", uevent
->attr
.name
, app
->pid
);
4300 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4302 pthread_mutex_unlock(&ua_sess
->lock
);
4306 pthread_mutex_unlock(&ua_sess
->lock
);
4315 * For a specific existing UST session and UST channel, creates the event for
4316 * all registered apps.
4318 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4319 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4322 struct lttng_ht_iter iter
, uiter
;
4323 struct lttng_ht_node_str
*ua_chan_node
;
4324 struct ust_app
*app
;
4325 struct ust_app_session
*ua_sess
;
4326 struct ust_app_channel
*ua_chan
;
4328 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4329 uevent
->attr
.name
, usess
->id
);
4333 /* For all registered applications */
4334 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4335 if (!app
->compatible
) {
4337 * TODO: In time, we should notice the caller of this error by
4338 * telling him that this is a version error.
4342 ua_sess
= lookup_session_by_app(usess
, app
);
4344 /* The application has problem or is probably dead. */
4348 pthread_mutex_lock(&ua_sess
->lock
);
4350 if (ua_sess
->deleted
) {
4351 pthread_mutex_unlock(&ua_sess
->lock
);
4355 /* Lookup channel in the ust app session */
4356 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4357 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4358 /* If the channel is not found, there is a code flow error */
4359 assert(ua_chan_node
);
4361 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4363 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4364 pthread_mutex_unlock(&ua_sess
->lock
);
4366 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4367 /* Possible value at this point: -ENOMEM. If so, we stop! */
4370 DBG2("UST app event %s already exist on app PID %d",
4371 uevent
->attr
.name
, app
->pid
);
4382 * Start tracing for a specific UST session and app.
4384 * Called with UST app session lock held.
4388 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4391 struct ust_app_session
*ua_sess
;
4393 DBG("Starting tracing for ust app pid %d", app
->pid
);
4397 if (!app
->compatible
) {
4401 ua_sess
= lookup_session_by_app(usess
, app
);
4402 if (ua_sess
== NULL
) {
4403 /* The session is in teardown process. Ignore and continue. */
4407 pthread_mutex_lock(&ua_sess
->lock
);
4409 if (ua_sess
->deleted
) {
4410 pthread_mutex_unlock(&ua_sess
->lock
);
4414 /* Upon restart, we skip the setup, already done */
4415 if (ua_sess
->started
) {
4419 /* Create directories if consumer is LOCAL and has a path defined. */
4420 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
4421 usess
->consumer
->dst
.session_root_path
[0] != '\0') {
4424 tmp_path
= zmalloc(LTTNG_PATH_MAX
);
4426 ERR("Alloc tmp_path");
4429 ret
= snprintf(tmp_path
, LTTNG_PATH_MAX
, "%s%s%s",
4430 usess
->consumer
->dst
.session_root_path
,
4431 usess
->consumer
->chunk_path
,
4432 usess
->consumer
->subdir
);
4433 if (ret
>= LTTNG_PATH_MAX
) {
4434 ERR("Local destination path exceeds the maximal allowed length of %i bytes (needs %i bytes) with path = \"%s%s%s\"",
4435 LTTNG_PATH_MAX
, ret
,
4436 usess
->consumer
->dst
.session_root_path
,
4437 usess
->consumer
->chunk_path
,
4438 usess
->consumer
->subdir
);
4442 DBG("Creating directory path for local tracing: \"%s\"",
4444 ret
= run_as_mkdir_recursive(tmp_path
, S_IRWXU
| S_IRWXG
,
4445 ua_sess
->euid
, ua_sess
->egid
);
4448 if (errno
!= EEXIST
) {
4449 ERR("Trace directory creation error");
4456 * Create the metadata for the application. This returns gracefully if a
4457 * metadata was already set for the session.
4459 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4464 health_code_update();
4467 /* This start the UST tracing */
4468 pthread_mutex_lock(&app
->sock_lock
);
4469 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4470 pthread_mutex_unlock(&app
->sock_lock
);
4472 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4473 ERR("Error starting tracing for app pid: %d (ret: %d)",
4476 DBG("UST app start session failed. Application is dead.");
4478 * This is normal behavior, an application can die during the
4479 * creation process. Don't report an error so the execution can
4480 * continue normally.
4482 pthread_mutex_unlock(&ua_sess
->lock
);
4488 /* Indicate that the session has been started once */
4489 ua_sess
->started
= 1;
4491 pthread_mutex_unlock(&ua_sess
->lock
);
4493 health_code_update();
4495 /* Quiescent wait after starting trace */
4496 pthread_mutex_lock(&app
->sock_lock
);
4497 ret
= ustctl_wait_quiescent(app
->sock
);
4498 pthread_mutex_unlock(&app
->sock_lock
);
4499 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4500 ERR("UST app wait quiescent failed for app pid %d ret %d",
4506 health_code_update();
4510 pthread_mutex_unlock(&ua_sess
->lock
);
4512 health_code_update();
4517 * Stop tracing for a specific UST session and app.
4520 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4523 struct ust_app_session
*ua_sess
;
4524 struct ust_registry_session
*registry
;
4526 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4530 if (!app
->compatible
) {
4531 goto end_no_session
;
4534 ua_sess
= lookup_session_by_app(usess
, app
);
4535 if (ua_sess
== NULL
) {
4536 goto end_no_session
;
4539 pthread_mutex_lock(&ua_sess
->lock
);
4541 if (ua_sess
->deleted
) {
4542 pthread_mutex_unlock(&ua_sess
->lock
);
4543 goto end_no_session
;
4547 * If started = 0, it means that stop trace has been called for a session
4548 * that was never started. It's possible since we can have a fail start
4549 * from either the application manager thread or the command thread. Simply
4550 * indicate that this is a stop error.
4552 if (!ua_sess
->started
) {
4553 goto error_rcu_unlock
;
4556 health_code_update();
4558 /* This inhibits UST tracing */
4559 pthread_mutex_lock(&app
->sock_lock
);
4560 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4561 pthread_mutex_unlock(&app
->sock_lock
);
4563 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4564 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4567 DBG("UST app stop session failed. Application is dead.");
4569 * This is normal behavior, an application can die during the
4570 * creation process. Don't report an error so the execution can
4571 * continue normally.
4575 goto error_rcu_unlock
;
4578 health_code_update();
4580 /* Quiescent wait after stopping trace */
4581 pthread_mutex_lock(&app
->sock_lock
);
4582 ret
= ustctl_wait_quiescent(app
->sock
);
4583 pthread_mutex_unlock(&app
->sock_lock
);
4584 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4585 ERR("UST app wait quiescent failed for app pid %d ret %d",
4589 health_code_update();
4591 registry
= get_session_registry(ua_sess
);
4593 /* The UST app session is held registry shall not be null. */
4596 /* Push metadata for application before freeing the application. */
4597 (void) push_metadata(registry
, ua_sess
->consumer
);
4600 pthread_mutex_unlock(&ua_sess
->lock
);
4603 health_code_update();
4607 pthread_mutex_unlock(&ua_sess
->lock
);
4609 health_code_update();
4614 int ust_app_flush_app_session(struct ust_app
*app
,
4615 struct ust_app_session
*ua_sess
)
4617 int ret
, retval
= 0;
4618 struct lttng_ht_iter iter
;
4619 struct ust_app_channel
*ua_chan
;
4620 struct consumer_socket
*socket
;
4622 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4626 if (!app
->compatible
) {
4627 goto end_not_compatible
;
4630 pthread_mutex_lock(&ua_sess
->lock
);
4632 if (ua_sess
->deleted
) {
4636 health_code_update();
4638 /* Flushing buffers */
4639 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4642 /* Flush buffers and push metadata. */
4643 switch (ua_sess
->buffer_type
) {
4644 case LTTNG_BUFFER_PER_PID
:
4645 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4647 health_code_update();
4648 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4650 ERR("Error flushing consumer channel");
4656 case LTTNG_BUFFER_PER_UID
:
4662 health_code_update();
4665 pthread_mutex_unlock(&ua_sess
->lock
);
4669 health_code_update();
4674 * Flush buffers for all applications for a specific UST session.
4675 * Called with UST session lock held.
4678 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4683 DBG("Flushing session buffers for all ust apps");
4687 /* Flush buffers and push metadata. */
4688 switch (usess
->buffer_type
) {
4689 case LTTNG_BUFFER_PER_UID
:
4691 struct buffer_reg_uid
*reg
;
4692 struct lttng_ht_iter iter
;
4694 /* Flush all per UID buffers associated to that session. */
4695 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4696 struct ust_registry_session
*ust_session_reg
;
4697 struct buffer_reg_channel
*reg_chan
;
4698 struct consumer_socket
*socket
;
4700 /* Get consumer socket to use to push the metadata.*/
4701 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4704 /* Ignore request if no consumer is found for the session. */
4708 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4709 reg_chan
, node
.node
) {
4711 * The following call will print error values so the return
4712 * code is of little importance because whatever happens, we
4713 * have to try them all.
4715 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4718 ust_session_reg
= reg
->registry
->reg
.ust
;
4719 /* Push metadata. */
4720 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4724 case LTTNG_BUFFER_PER_PID
:
4726 struct ust_app_session
*ua_sess
;
4727 struct lttng_ht_iter iter
;
4728 struct ust_app
*app
;
4730 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4731 ua_sess
= lookup_session_by_app(usess
, app
);
4732 if (ua_sess
== NULL
) {
4735 (void) ust_app_flush_app_session(app
, ua_sess
);
4746 health_code_update();
4751 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
4752 struct ust_app_session
*ua_sess
)
4755 struct lttng_ht_iter iter
;
4756 struct ust_app_channel
*ua_chan
;
4757 struct consumer_socket
*socket
;
4759 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
4763 if (!app
->compatible
) {
4764 goto end_not_compatible
;
4767 pthread_mutex_lock(&ua_sess
->lock
);
4769 if (ua_sess
->deleted
) {
4773 health_code_update();
4775 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4778 ERR("Failed to find consumer (%" PRIu32
") socket",
4779 app
->bits_per_long
);
4784 /* Clear quiescent state. */
4785 switch (ua_sess
->buffer_type
) {
4786 case LTTNG_BUFFER_PER_PID
:
4787 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
4788 ua_chan
, node
.node
) {
4789 health_code_update();
4790 ret
= consumer_clear_quiescent_channel(socket
,
4793 ERR("Error clearing quiescent state for consumer channel");
4799 case LTTNG_BUFFER_PER_UID
:
4806 health_code_update();
4809 pthread_mutex_unlock(&ua_sess
->lock
);
4813 health_code_update();
4818 * Clear quiescent state in each stream for all applications for a
4819 * specific UST session.
4820 * Called with UST session lock held.
4823 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
4828 DBG("Clearing stream quiescent state for all ust apps");
4832 switch (usess
->buffer_type
) {
4833 case LTTNG_BUFFER_PER_UID
:
4835 struct lttng_ht_iter iter
;
4836 struct buffer_reg_uid
*reg
;
4839 * Clear quiescent for all per UID buffers associated to
4842 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4843 struct consumer_socket
*socket
;
4844 struct buffer_reg_channel
*reg_chan
;
4846 /* Get associated consumer socket.*/
4847 socket
= consumer_find_socket_by_bitness(
4848 reg
->bits_per_long
, usess
->consumer
);
4851 * Ignore request if no consumer is found for
4857 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
4858 &iter
.iter
, reg_chan
, node
.node
) {
4860 * The following call will print error values so
4861 * the return code is of little importance
4862 * because whatever happens, we have to try them
4865 (void) consumer_clear_quiescent_channel(socket
,
4866 reg_chan
->consumer_key
);
4871 case LTTNG_BUFFER_PER_PID
:
4873 struct ust_app_session
*ua_sess
;
4874 struct lttng_ht_iter iter
;
4875 struct ust_app
*app
;
4877 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
4879 ua_sess
= lookup_session_by_app(usess
, app
);
4880 if (ua_sess
== NULL
) {
4883 (void) ust_app_clear_quiescent_app_session(app
,
4895 health_code_update();
4900 * Destroy a specific UST session in apps.
4902 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4905 struct ust_app_session
*ua_sess
;
4906 struct lttng_ht_iter iter
;
4907 struct lttng_ht_node_u64
*node
;
4909 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4913 if (!app
->compatible
) {
4917 __lookup_session_by_app(usess
, app
, &iter
);
4918 node
= lttng_ht_iter_get_node_u64(&iter
);
4920 /* Session is being or is deleted. */
4923 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4925 health_code_update();
4926 destroy_app_session(app
, ua_sess
);
4928 health_code_update();
4930 /* Quiescent wait after stopping trace */
4931 pthread_mutex_lock(&app
->sock_lock
);
4932 ret
= ustctl_wait_quiescent(app
->sock
);
4933 pthread_mutex_unlock(&app
->sock_lock
);
4934 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4935 ERR("UST app wait quiescent failed for app pid %d ret %d",
4940 health_code_update();
4945 * Start tracing for the UST session.
4947 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4950 struct lttng_ht_iter iter
;
4951 struct ust_app
*app
;
4953 DBG("Starting all UST traces");
4958 * In a start-stop-start use-case, we need to clear the quiescent state
4959 * of each channel set by the prior stop command, thus ensuring that a
4960 * following stop or destroy is sure to grab a timestamp_end near those
4961 * operations, even if the packet is empty.
4963 (void) ust_app_clear_quiescent_session(usess
);
4965 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4966 ret
= ust_app_start_trace(usess
, app
);
4968 /* Continue to next apps even on error */
4979 * Start tracing for the UST session.
4980 * Called with UST session lock held.
4982 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4985 struct lttng_ht_iter iter
;
4986 struct ust_app
*app
;
4988 DBG("Stopping all UST traces");
4992 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4993 ret
= ust_app_stop_trace(usess
, app
);
4995 /* Continue to next apps even on error */
5000 (void) ust_app_flush_session(usess
);
5008 * Destroy app UST session.
5010 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5013 struct lttng_ht_iter iter
;
5014 struct ust_app
*app
;
5016 DBG("Destroy all UST traces");
5020 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5021 ret
= destroy_trace(usess
, app
);
5023 /* Continue to next apps even on error */
5034 void ust_app_global_create(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5037 struct lttng_ht_iter iter
, uiter
;
5038 struct ust_app_session
*ua_sess
= NULL
;
5039 struct ust_app_channel
*ua_chan
;
5040 struct ust_app_event
*ua_event
;
5041 struct ust_app_ctx
*ua_ctx
;
5044 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &is_created
);
5046 /* Tracer is probably gone or ENOMEM. */
5050 /* App session already created. */
5055 pthread_mutex_lock(&ua_sess
->lock
);
5057 if (ua_sess
->deleted
) {
5058 pthread_mutex_unlock(&ua_sess
->lock
);
5063 * We can iterate safely here over all UST app session since the create ust
5064 * app session above made a shadow copy of the UST global domain from the
5067 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5069 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
5070 if (ret
< 0 && ret
!= -ENOTCONN
) {
5072 * Stop everything. On error, the application
5073 * failed, no more file descriptor are available
5074 * or ENOMEM so stopping here is the only thing
5075 * we can do for now. The only exception is
5076 * -ENOTCONN, which indicates that the application
5083 * Add context using the list so they are enabled in the same order the
5086 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
5087 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
5094 /* For each events */
5095 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
5097 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
5104 pthread_mutex_unlock(&ua_sess
->lock
);
5106 if (usess
->active
) {
5107 ret
= ust_app_start_trace(usess
, app
);
5112 DBG2("UST trace started for app pid %d", app
->pid
);
5115 /* Everything went well at this point. */
5119 pthread_mutex_unlock(&ua_sess
->lock
);
5122 destroy_app_session(app
, ua_sess
);
5128 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5130 struct ust_app_session
*ua_sess
;
5132 ua_sess
= lookup_session_by_app(usess
, app
);
5133 if (ua_sess
== NULL
) {
5136 destroy_app_session(app
, ua_sess
);
5140 * Add channels/events from UST global domain to registered apps at sock.
5142 * Called with session lock held.
5143 * Called with RCU read-side lock held.
5145 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5149 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5150 app
->sock
, usess
->id
);
5152 if (!app
->compatible
) {
5156 if (trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
5157 ust_app_global_create(usess
, app
);
5159 ust_app_global_destroy(usess
, app
);
5164 * Called with session lock held.
5166 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5168 struct lttng_ht_iter iter
;
5169 struct ust_app
*app
;
5172 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5173 ust_app_global_update(usess
, app
);
5179 * Add context to a specific channel for global UST domain.
5181 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5182 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5185 struct lttng_ht_node_str
*ua_chan_node
;
5186 struct lttng_ht_iter iter
, uiter
;
5187 struct ust_app_channel
*ua_chan
= NULL
;
5188 struct ust_app_session
*ua_sess
;
5189 struct ust_app
*app
;
5193 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5194 if (!app
->compatible
) {
5196 * TODO: In time, we should notice the caller of this error by
5197 * telling him that this is a version error.
5201 ua_sess
= lookup_session_by_app(usess
, app
);
5202 if (ua_sess
== NULL
) {
5206 pthread_mutex_lock(&ua_sess
->lock
);
5208 if (ua_sess
->deleted
) {
5209 pthread_mutex_unlock(&ua_sess
->lock
);
5213 /* Lookup channel in the ust app session */
5214 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5215 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5216 if (ua_chan_node
== NULL
) {
5219 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5221 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
5226 pthread_mutex_unlock(&ua_sess
->lock
);
5234 * Enable event for a channel from a UST session for a specific PID.
5236 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
5237 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
5240 struct lttng_ht_iter iter
;
5241 struct lttng_ht_node_str
*ua_chan_node
;
5242 struct ust_app
*app
;
5243 struct ust_app_session
*ua_sess
;
5244 struct ust_app_channel
*ua_chan
;
5245 struct ust_app_event
*ua_event
;
5247 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
5251 app
= ust_app_find_by_pid(pid
);
5253 ERR("UST app enable event per PID %d not found", pid
);
5258 if (!app
->compatible
) {
5263 ua_sess
= lookup_session_by_app(usess
, app
);
5265 /* The application has problem or is probably dead. */
5270 pthread_mutex_lock(&ua_sess
->lock
);
5272 if (ua_sess
->deleted
) {
5277 /* Lookup channel in the ust app session */
5278 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
5279 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5280 /* If the channel is not found, there is a code flow error */
5281 assert(ua_chan_node
);
5283 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5285 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5286 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5287 if (ua_event
== NULL
) {
5288 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5293 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
5300 pthread_mutex_unlock(&ua_sess
->lock
);
5307 * Receive registration and populate the given msg structure.
5309 * On success return 0 else a negative value returned by the ustctl call.
5311 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5314 uint32_t pid
, ppid
, uid
, gid
;
5318 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5319 &pid
, &ppid
, &uid
, &gid
,
5320 &msg
->bits_per_long
,
5321 &msg
->uint8_t_alignment
,
5322 &msg
->uint16_t_alignment
,
5323 &msg
->uint32_t_alignment
,
5324 &msg
->uint64_t_alignment
,
5325 &msg
->long_alignment
,
5332 case LTTNG_UST_ERR_EXITING
:
5333 DBG3("UST app recv reg message failed. Application died");
5335 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5336 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5337 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5338 LTTNG_UST_ABI_MINOR_VERSION
);
5341 ERR("UST app recv reg message failed with ret %d", ret
);
5346 msg
->pid
= (pid_t
) pid
;
5347 msg
->ppid
= (pid_t
) ppid
;
5348 msg
->uid
= (uid_t
) uid
;
5349 msg
->gid
= (gid_t
) gid
;
5356 * Return a ust app session object using the application object and the
5357 * session object descriptor has a key. If not found, NULL is returned.
5358 * A RCU read side lock MUST be acquired when calling this function.
5360 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5363 struct lttng_ht_node_ulong
*node
;
5364 struct lttng_ht_iter iter
;
5365 struct ust_app_session
*ua_sess
= NULL
;
5369 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5370 node
= lttng_ht_iter_get_node_ulong(&iter
);
5372 DBG2("UST app session find by objd %d not found", objd
);
5376 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5383 * Return a ust app channel object using the application object and the channel
5384 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5385 * lock MUST be acquired before calling this function.
5387 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5390 struct lttng_ht_node_ulong
*node
;
5391 struct lttng_ht_iter iter
;
5392 struct ust_app_channel
*ua_chan
= NULL
;
5396 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5397 node
= lttng_ht_iter_get_node_ulong(&iter
);
5399 DBG2("UST app channel find by objd %d not found", objd
);
5403 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5410 * Reply to a register channel notification from an application on the notify
5411 * socket. The channel metadata is also created.
5413 * The session UST registry lock is acquired in this function.
5415 * On success 0 is returned else a negative value.
5417 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
5418 size_t nr_fields
, struct ustctl_field
*fields
)
5420 int ret
, ret_code
= 0;
5421 uint32_t chan_id
, reg_count
;
5422 uint64_t chan_reg_key
;
5423 enum ustctl_channel_header type
;
5424 struct ust_app
*app
;
5425 struct ust_app_channel
*ua_chan
;
5426 struct ust_app_session
*ua_sess
;
5427 struct ust_registry_session
*registry
;
5428 struct ust_registry_channel
*chan_reg
;
5432 /* Lookup application. If not found, there is a code flow error. */
5433 app
= find_app_by_notify_sock(sock
);
5435 DBG("Application socket %d is being torn down. Abort event notify",
5438 goto error_rcu_unlock
;
5441 /* Lookup channel by UST object descriptor. */
5442 ua_chan
= find_channel_by_objd(app
, cobjd
);
5444 DBG("Application channel is being torn down. Abort event notify");
5446 goto error_rcu_unlock
;
5449 assert(ua_chan
->session
);
5450 ua_sess
= ua_chan
->session
;
5452 /* Get right session registry depending on the session buffer type. */
5453 registry
= get_session_registry(ua_sess
);
5455 DBG("Application session is being torn down. Abort event notify");
5457 goto error_rcu_unlock
;
5460 /* Depending on the buffer type, a different channel key is used. */
5461 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5462 chan_reg_key
= ua_chan
->tracing_channel_id
;
5464 chan_reg_key
= ua_chan
->key
;
5467 pthread_mutex_lock(®istry
->lock
);
5469 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5472 if (!chan_reg
->register_done
) {
5473 reg_count
= ust_registry_get_event_count(chan_reg
);
5474 if (reg_count
< 31) {
5475 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
5477 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5480 chan_reg
->nr_ctx_fields
= nr_fields
;
5481 chan_reg
->ctx_fields
= fields
;
5483 chan_reg
->header_type
= type
;
5485 /* Get current already assigned values. */
5486 type
= chan_reg
->header_type
;
5488 /* Channel id is set during the object creation. */
5489 chan_id
= chan_reg
->chan_id
;
5491 /* Append to metadata */
5492 if (!chan_reg
->metadata_dumped
) {
5493 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5495 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5501 DBG3("UST app replying to register channel key %" PRIu64
5502 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5505 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5507 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5508 ERR("UST app reply channel failed with ret %d", ret
);
5510 DBG3("UST app reply channel failed. Application died");
5515 /* This channel registry registration is completed. */
5516 chan_reg
->register_done
= 1;
5519 pthread_mutex_unlock(®istry
->lock
);
5527 * Add event to the UST channel registry. When the event is added to the
5528 * registry, the metadata is also created. Once done, this replies to the
5529 * application with the appropriate error code.
5531 * The session UST registry lock is acquired in the function.
5533 * On success 0 is returned else a negative value.
5535 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5536 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5537 int loglevel_value
, char *model_emf_uri
)
5540 uint32_t event_id
= 0;
5541 uint64_t chan_reg_key
;
5542 struct ust_app
*app
;
5543 struct ust_app_channel
*ua_chan
;
5544 struct ust_app_session
*ua_sess
;
5545 struct ust_registry_session
*registry
;
5549 /* Lookup application. If not found, there is a code flow error. */
5550 app
= find_app_by_notify_sock(sock
);
5552 DBG("Application socket %d is being torn down. Abort event notify",
5555 goto error_rcu_unlock
;
5558 /* Lookup channel by UST object descriptor. */
5559 ua_chan
= find_channel_by_objd(app
, cobjd
);
5561 DBG("Application channel is being torn down. Abort event notify");
5563 goto error_rcu_unlock
;
5566 assert(ua_chan
->session
);
5567 ua_sess
= ua_chan
->session
;
5569 registry
= get_session_registry(ua_sess
);
5571 DBG("Application session is being torn down. Abort event notify");
5573 goto error_rcu_unlock
;
5576 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5577 chan_reg_key
= ua_chan
->tracing_channel_id
;
5579 chan_reg_key
= ua_chan
->key
;
5582 pthread_mutex_lock(®istry
->lock
);
5585 * From this point on, this call acquires the ownership of the sig, fields
5586 * and model_emf_uri meaning any free are done inside it if needed. These
5587 * three variables MUST NOT be read/write after this.
5589 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5590 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5591 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5595 model_emf_uri
= NULL
;
5598 * The return value is returned to ustctl so in case of an error, the
5599 * application can be notified. In case of an error, it's important not to
5600 * return a negative error or else the application will get closed.
5602 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5604 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5605 ERR("UST app reply event failed with ret %d", ret
);
5607 DBG3("UST app reply event failed. Application died");
5610 * No need to wipe the create event since the application socket will
5611 * get close on error hence cleaning up everything by itself.
5616 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5620 pthread_mutex_unlock(®istry
->lock
);
5625 free(model_emf_uri
);
5630 * Add enum to the UST session registry. Once done, this replies to the
5631 * application with the appropriate error code.
5633 * The session UST registry lock is acquired within this function.
5635 * On success 0 is returned else a negative value.
5637 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
5638 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
5640 int ret
= 0, ret_code
;
5641 struct ust_app
*app
;
5642 struct ust_app_session
*ua_sess
;
5643 struct ust_registry_session
*registry
;
5644 uint64_t enum_id
= -1ULL;
5648 /* Lookup application. If not found, there is a code flow error. */
5649 app
= find_app_by_notify_sock(sock
);
5651 /* Return an error since this is not an error */
5652 DBG("Application socket %d is being torn down. Aborting enum registration",
5655 goto error_rcu_unlock
;
5658 /* Lookup session by UST object descriptor. */
5659 ua_sess
= find_session_by_objd(app
, sobjd
);
5661 /* Return an error since this is not an error */
5662 DBG("Application session is being torn down (session not found). Aborting enum registration.");
5664 goto error_rcu_unlock
;
5667 registry
= get_session_registry(ua_sess
);
5669 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
5671 goto error_rcu_unlock
;
5674 pthread_mutex_lock(®istry
->lock
);
5677 * From this point on, the callee acquires the ownership of
5678 * entries. The variable entries MUST NOT be read/written after
5681 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
5682 entries
, nr_entries
, &enum_id
);
5686 * The return value is returned to ustctl so in case of an error, the
5687 * application can be notified. In case of an error, it's important not to
5688 * return a negative error or else the application will get closed.
5690 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
5692 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5693 ERR("UST app reply enum failed with ret %d", ret
);
5695 DBG3("UST app reply enum failed. Application died");
5698 * No need to wipe the create enum since the application socket will
5699 * get close on error hence cleaning up everything by itself.
5704 DBG3("UST registry enum %s added successfully or already found", name
);
5707 pthread_mutex_unlock(®istry
->lock
);
5714 * Handle application notification through the given notify socket.
5716 * Return 0 on success or else a negative value.
5718 int ust_app_recv_notify(int sock
)
5721 enum ustctl_notify_cmd cmd
;
5723 DBG3("UST app receiving notify from sock %d", sock
);
5725 ret
= ustctl_recv_notify(sock
, &cmd
);
5727 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5728 ERR("UST app recv notify failed with ret %d", ret
);
5730 DBG3("UST app recv notify failed. Application died");
5736 case USTCTL_NOTIFY_CMD_EVENT
:
5738 int sobjd
, cobjd
, loglevel_value
;
5739 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5741 struct ustctl_field
*fields
;
5743 DBG2("UST app ustctl register event received");
5745 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5746 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5749 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5750 ERR("UST app recv event failed with ret %d", ret
);
5752 DBG3("UST app recv event failed. Application died");
5758 * Add event to the UST registry coming from the notify socket. This
5759 * call will free if needed the sig, fields and model_emf_uri. This
5760 * code path loses the ownsership of these variables and transfer them
5761 * to the this function.
5763 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5764 fields
, loglevel_value
, model_emf_uri
);
5771 case USTCTL_NOTIFY_CMD_CHANNEL
:
5775 struct ustctl_field
*fields
;
5777 DBG2("UST app ustctl register channel received");
5779 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5782 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5783 ERR("UST app recv channel failed with ret %d", ret
);
5785 DBG3("UST app recv channel failed. Application died");
5791 * The fields ownership are transfered to this function call meaning
5792 * that if needed it will be freed. After this, it's invalid to access
5793 * fields or clean it up.
5795 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
5803 case USTCTL_NOTIFY_CMD_ENUM
:
5806 char name
[LTTNG_UST_SYM_NAME_LEN
];
5808 struct ustctl_enum_entry
*entries
;
5810 DBG2("UST app ustctl register enum received");
5812 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
5813 &entries
, &nr_entries
);
5815 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5816 ERR("UST app recv enum failed with ret %d", ret
);
5818 DBG3("UST app recv enum failed. Application died");
5823 /* Callee assumes ownership of entries */
5824 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
5825 entries
, nr_entries
);
5833 /* Should NEVER happen. */
5842 * Once the notify socket hangs up, this is called. First, it tries to find the
5843 * corresponding application. On failure, the call_rcu to close the socket is
5844 * executed. If an application is found, it tries to delete it from the notify
5845 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5847 * Note that an object needs to be allocated here so on ENOMEM failure, the
5848 * call RCU is not done but the rest of the cleanup is.
5850 void ust_app_notify_sock_unregister(int sock
)
5853 struct lttng_ht_iter iter
;
5854 struct ust_app
*app
;
5855 struct ust_app_notify_sock_obj
*obj
;
5861 obj
= zmalloc(sizeof(*obj
));
5864 * An ENOMEM is kind of uncool. If this strikes we continue the
5865 * procedure but the call_rcu will not be called. In this case, we
5866 * accept the fd leak rather than possibly creating an unsynchronized
5867 * state between threads.
5869 * TODO: The notify object should be created once the notify socket is
5870 * registered and stored independantely from the ust app object. The
5871 * tricky part is to synchronize the teardown of the application and
5872 * this notify object. Let's keep that in mind so we can avoid this
5873 * kind of shenanigans with ENOMEM in the teardown path.
5880 DBG("UST app notify socket unregister %d", sock
);
5883 * Lookup application by notify socket. If this fails, this means that the
5884 * hash table delete has already been done by the application
5885 * unregistration process so we can safely close the notify socket in a
5888 app
= find_app_by_notify_sock(sock
);
5893 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5896 * Whatever happens here either we fail or succeed, in both cases we have
5897 * to close the socket after a grace period to continue to the call RCU
5898 * here. If the deletion is successful, the application is not visible
5899 * anymore by other threads and is it fails it means that it was already
5900 * deleted from the hash table so either way we just have to close the
5903 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5909 * Close socket after a grace period to avoid for the socket to be reused
5910 * before the application object is freed creating potential race between
5911 * threads trying to add unique in the global hash table.
5914 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5919 * Destroy a ust app data structure and free its memory.
5921 void ust_app_destroy(struct ust_app
*app
)
5927 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5931 * Take a snapshot for a given UST session. The snapshot is sent to the given
5934 * Return 0 on success or else a negative value.
5936 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5937 struct snapshot_output
*output
, int wait
,
5938 uint64_t nb_packets_per_stream
)
5941 struct lttng_ht_iter iter
;
5942 struct ust_app
*app
;
5943 char pathname
[PATH_MAX
];
5950 switch (usess
->buffer_type
) {
5951 case LTTNG_BUFFER_PER_UID
:
5953 struct buffer_reg_uid
*reg
;
5955 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5956 struct buffer_reg_channel
*reg_chan
;
5957 struct consumer_socket
*socket
;
5959 /* Get consumer socket to use to push the metadata.*/
5960 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5967 memset(pathname
, 0, sizeof(pathname
));
5968 ret
= snprintf(pathname
, sizeof(pathname
),
5969 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5970 reg
->uid
, reg
->bits_per_long
);
5972 PERROR("snprintf snapshot path");
5976 /* Add the UST default trace dir to path. */
5977 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5978 reg_chan
, node
.node
) {
5979 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5980 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5981 nb_packets_per_stream
);
5986 ret
= consumer_snapshot_channel(socket
,
5987 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5988 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5995 case LTTNG_BUFFER_PER_PID
:
5997 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5998 struct consumer_socket
*socket
;
5999 struct lttng_ht_iter chan_iter
;
6000 struct ust_app_channel
*ua_chan
;
6001 struct ust_app_session
*ua_sess
;
6002 struct ust_registry_session
*registry
;
6004 ua_sess
= lookup_session_by_app(usess
, app
);
6006 /* Session not associated with this app. */
6010 /* Get the right consumer socket for the application. */
6011 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6018 /* Add the UST default trace dir to path. */
6019 memset(pathname
, 0, sizeof(pathname
));
6020 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6023 PERROR("snprintf snapshot path");
6027 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6028 ua_chan
, node
.node
) {
6029 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
6030 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
6031 nb_packets_per_stream
);
6037 registry
= get_session_registry(ua_sess
);
6039 DBG("Application session is being torn down. Abort snapshot record.");
6043 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
6044 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
6062 * Return the size taken by one more packet per stream.
6064 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
6065 uint64_t cur_nr_packets
)
6067 uint64_t tot_size
= 0;
6068 struct ust_app
*app
;
6069 struct lttng_ht_iter iter
;
6073 switch (usess
->buffer_type
) {
6074 case LTTNG_BUFFER_PER_UID
:
6076 struct buffer_reg_uid
*reg
;
6078 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6079 struct buffer_reg_channel
*reg_chan
;
6082 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6083 reg_chan
, node
.node
) {
6084 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6086 * Don't take channel into account if we
6087 * already grab all its packets.
6091 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6097 case LTTNG_BUFFER_PER_PID
:
6100 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6101 struct ust_app_channel
*ua_chan
;
6102 struct ust_app_session
*ua_sess
;
6103 struct lttng_ht_iter chan_iter
;
6105 ua_sess
= lookup_session_by_app(usess
, app
);
6107 /* Session not associated with this app. */
6111 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6112 ua_chan
, node
.node
) {
6113 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6115 * Don't take channel into account if we
6116 * already grab all its packets.
6120 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6134 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6135 struct cds_list_head
*buffer_reg_uid_list
,
6136 struct consumer_output
*consumer
, uint64_t uchan_id
,
6137 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6140 uint64_t consumer_chan_key
;
6145 ret
= buffer_reg_uid_consumer_channel_key(
6146 buffer_reg_uid_list
, ust_session_id
,
6147 uchan_id
, &consumer_chan_key
);
6155 ret
= consumer_get_lost_packets(ust_session_id
,
6156 consumer_chan_key
, consumer
, lost
);
6158 ret
= consumer_get_discarded_events(ust_session_id
,
6159 consumer_chan_key
, consumer
, discarded
);
6166 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6167 struct ltt_ust_channel
*uchan
,
6168 struct consumer_output
*consumer
, int overwrite
,
6169 uint64_t *discarded
, uint64_t *lost
)
6172 struct lttng_ht_iter iter
;
6173 struct lttng_ht_node_str
*ua_chan_node
;
6174 struct ust_app
*app
;
6175 struct ust_app_session
*ua_sess
;
6176 struct ust_app_channel
*ua_chan
;
6183 * Iterate over every registered applications. Sum counters for
6184 * all applications containing requested session and channel.
6186 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6187 struct lttng_ht_iter uiter
;
6189 ua_sess
= lookup_session_by_app(usess
, app
);
6190 if (ua_sess
== NULL
) {
6195 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6196 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6197 /* If the session is found for the app, the channel must be there */
6198 assert(ua_chan_node
);
6200 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6205 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6212 uint64_t _discarded
;
6214 ret
= consumer_get_discarded_events(usess
->id
,
6215 ua_chan
->key
, consumer
, &_discarded
);
6219 (*discarded
) += _discarded
;
6228 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6229 struct ust_app
*app
)
6232 struct ust_app_session
*ua_sess
;
6234 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6238 ua_sess
= lookup_session_by_app(usess
, app
);
6239 if (ua_sess
== NULL
) {
6240 /* The session is in teardown process. Ignore and continue. */
6244 pthread_mutex_lock(&ua_sess
->lock
);
6246 if (ua_sess
->deleted
) {
6250 pthread_mutex_lock(&app
->sock_lock
);
6251 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6252 pthread_mutex_unlock(&app
->sock_lock
);
6255 pthread_mutex_unlock(&ua_sess
->lock
);
6259 health_code_update();
6264 * Regenerate the statedump for each app in the session.
6266 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6269 struct lttng_ht_iter iter
;
6270 struct ust_app
*app
;
6272 DBG("Regenerating the metadata for all UST apps");
6276 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6277 if (!app
->compatible
) {
6281 ret
= ust_app_regenerate_statedump(usess
, app
);
6283 /* Continue to the next app even on error */
6294 * Rotate all the channels of a session.
6296 * Return 0 on success or else a negative value.
6298 int ust_app_rotate_session(struct ltt_session
*session
, bool *ust_active
)
6301 struct lttng_ht_iter iter
;
6302 struct ust_app
*app
;
6303 struct ltt_ust_session
*usess
= session
->ust_session
;
6304 char pathname
[LTTNG_PATH_MAX
];
6310 switch (usess
->buffer_type
) {
6311 case LTTNG_BUFFER_PER_UID
:
6313 struct buffer_reg_uid
*reg
;
6315 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6316 struct buffer_reg_channel
*reg_chan
;
6317 struct consumer_socket
*socket
;
6319 /* Get consumer socket to use to push the metadata.*/
6320 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6328 * Account the metadata channel first to make sure the
6329 * number of channels waiting for a rotation cannot
6330 * reach 0 before we complete the iteration over all
6333 ret
= rotate_add_channel_pending(
6334 reg
->registry
->reg
.ust
->metadata_key
,
6335 LTTNG_DOMAIN_UST
, session
);
6337 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
6341 ret
= snprintf(pathname
, sizeof(pathname
),
6342 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6343 reg
->uid
, reg
->bits_per_long
);
6344 if (ret
< 0 || ret
== sizeof(pathname
)) {
6345 PERROR("Failed to format rotation path");
6349 /* Rotate the data channels. */
6350 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6351 reg_chan
, node
.node
) {
6352 ret
= rotate_add_channel_pending(
6353 reg_chan
->consumer_key
,
6354 LTTNG_DOMAIN_UST
, session
);
6356 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
6359 ret
= consumer_rotate_channel(socket
,
6360 reg_chan
->consumer_key
,
6361 usess
->uid
, usess
->gid
,
6362 usess
->consumer
, pathname
,
6363 /* is_metadata_channel */ false,
6364 session
->rotate_count
,
6365 &session
->rotate_pending_relay
);
6371 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6373 ret
= consumer_rotate_channel(socket
,
6374 reg
->registry
->reg
.ust
->metadata_key
,
6375 usess
->uid
, usess
->gid
,
6376 usess
->consumer
, pathname
,
6377 /* is_metadata_channel */ true,
6378 session
->rotate_count
,
6379 &session
->rotate_pending_relay
);
6387 case LTTNG_BUFFER_PER_PID
:
6389 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6390 struct consumer_socket
*socket
;
6391 struct lttng_ht_iter chan_iter
;
6392 struct ust_app_channel
*ua_chan
;
6393 struct ust_app_session
*ua_sess
;
6394 struct ust_registry_session
*registry
;
6396 ua_sess
= lookup_session_by_app(usess
, app
);
6398 /* Session not associated with this app. */
6401 ret
= snprintf(pathname
, sizeof(pathname
),
6402 DEFAULT_UST_TRACE_DIR
"/%s",
6404 if (ret
< 0 || ret
== sizeof(pathname
)) {
6405 PERROR("Failed to format rotation path");
6409 /* Get the right consumer socket for the application. */
6410 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6417 registry
= get_session_registry(ua_sess
);
6419 DBG("Application session is being torn down. Abort snapshot record.");
6425 * Account the metadata channel first to make sure the
6426 * number of channels waiting for a rotation cannot
6427 * reach 0 before we complete the iteration over all
6430 ret
= rotate_add_channel_pending(registry
->metadata_key
,
6431 LTTNG_DOMAIN_UST
, session
);
6433 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
6437 /* Rotate the data channels. */
6438 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6439 ua_chan
, node
.node
) {
6440 ret
= rotate_add_channel_pending(
6441 ua_chan
->key
, LTTNG_DOMAIN_UST
,
6444 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
6447 ret
= consumer_rotate_channel(socket
, ua_chan
->key
,
6448 ua_sess
->euid
, ua_sess
->egid
,
6449 ua_sess
->consumer
, pathname
,
6450 /* is_metadata_channel */ false,
6451 session
->rotate_count
,
6452 &session
->rotate_pending_relay
);
6458 /* Rotate the metadata channel. */
6459 (void) push_metadata(registry
, usess
->consumer
);
6460 ret
= consumer_rotate_channel(socket
, registry
->metadata_key
,
6461 ua_sess
->euid
, ua_sess
->egid
,
6462 ua_sess
->consumer
, pathname
,
6463 /* is_metadata_channel */ true,
6464 session
->rotate_count
,
6465 &session
->rotate_pending_relay
);