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
;
441 session_put(session
);
446 * Delete ust app channel safely. RCU read lock must be held before calling
449 * The session list lock must be held by the caller.
452 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
456 struct lttng_ht_iter iter
;
457 struct ust_app_event
*ua_event
;
458 struct ust_app_ctx
*ua_ctx
;
459 struct ust_app_stream
*stream
, *stmp
;
460 struct ust_registry_session
*registry
;
464 DBG3("UST app deleting channel %s", ua_chan
->name
);
467 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
468 cds_list_del(&stream
->list
);
469 delete_ust_app_stream(sock
, stream
, app
);
473 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
474 cds_list_del(&ua_ctx
->list
);
475 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
477 delete_ust_app_ctx(sock
, ua_ctx
, app
);
481 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
483 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
485 delete_ust_app_event(sock
, ua_event
, app
);
488 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
489 /* Wipe and free registry from session registry. */
490 registry
= get_session_registry(ua_chan
->session
);
492 ust_registry_channel_del_free(registry
, ua_chan
->key
,
496 * A negative socket can be used by the caller when
497 * cleaning-up a ua_chan in an error path. Skip the
498 * accounting in this case.
501 save_per_pid_lost_discarded_counters(ua_chan
);
505 if (ua_chan
->obj
!= NULL
) {
506 /* Remove channel from application UST object descriptor. */
507 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
508 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
510 pthread_mutex_lock(&app
->sock_lock
);
511 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
512 pthread_mutex_unlock(&app
->sock_lock
);
513 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
514 ERR("UST app sock %d release channel obj failed with ret %d",
517 lttng_fd_put(LTTNG_FD_APPS
, 1);
520 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
523 int ust_app_register_done(struct ust_app
*app
)
527 pthread_mutex_lock(&app
->sock_lock
);
528 ret
= ustctl_register_done(app
->sock
);
529 pthread_mutex_unlock(&app
->sock_lock
);
533 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
538 pthread_mutex_lock(&app
->sock_lock
);
543 ret
= ustctl_release_object(sock
, data
);
545 pthread_mutex_unlock(&app
->sock_lock
);
551 * Push metadata to consumer socket.
553 * RCU read-side lock must be held to guarantee existance of socket.
554 * Must be called with the ust app session lock held.
555 * Must be called with the registry lock held.
557 * On success, return the len of metadata pushed or else a negative value.
558 * Returning a -EPIPE return value means we could not send the metadata,
559 * but it can be caused by recoverable errors (e.g. the application has
560 * terminated concurrently).
562 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
563 struct consumer_socket
*socket
, int send_zero_data
)
566 char *metadata_str
= NULL
;
567 size_t len
, offset
, new_metadata_len_sent
;
569 uint64_t metadata_key
, metadata_version
;
574 metadata_key
= registry
->metadata_key
;
577 * Means that no metadata was assigned to the session. This can
578 * happens if no start has been done previously.
584 offset
= registry
->metadata_len_sent
;
585 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
586 new_metadata_len_sent
= registry
->metadata_len
;
587 metadata_version
= registry
->metadata_version
;
589 DBG3("No metadata to push for metadata key %" PRIu64
,
590 registry
->metadata_key
);
592 if (send_zero_data
) {
593 DBG("No metadata to push");
599 /* Allocate only what we have to send. */
600 metadata_str
= zmalloc(len
);
602 PERROR("zmalloc ust app metadata string");
606 /* Copy what we haven't sent out. */
607 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
610 pthread_mutex_unlock(®istry
->lock
);
612 * We need to unlock the registry while we push metadata to
613 * break a circular dependency between the consumerd metadata
614 * lock and the sessiond registry lock. Indeed, pushing metadata
615 * to the consumerd awaits that it gets pushed all the way to
616 * relayd, but doing so requires grabbing the metadata lock. If
617 * a concurrent metadata request is being performed by
618 * consumerd, this can try to grab the registry lock on the
619 * sessiond while holding the metadata lock on the consumer
620 * daemon. Those push and pull schemes are performed on two
621 * different bidirectionnal communication sockets.
623 ret
= consumer_push_metadata(socket
, metadata_key
,
624 metadata_str
, len
, offset
, metadata_version
);
625 pthread_mutex_lock(®istry
->lock
);
628 * There is an acceptable race here between the registry
629 * metadata key assignment and the creation on the
630 * consumer. The session daemon can concurrently push
631 * metadata for this registry while being created on the
632 * consumer since the metadata key of the registry is
633 * assigned *before* it is setup to avoid the consumer
634 * to ask for metadata that could possibly be not found
635 * in the session daemon.
637 * The metadata will get pushed either by the session
638 * being stopped or the consumer requesting metadata if
639 * that race is triggered.
641 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
644 ERR("Error pushing metadata to consumer");
650 * Metadata may have been concurrently pushed, since
651 * we're not holding the registry lock while pushing to
652 * consumer. This is handled by the fact that we send
653 * the metadata content, size, and the offset at which
654 * that metadata belongs. This may arrive out of order
655 * on the consumer side, and the consumer is able to
656 * deal with overlapping fragments. The consumer
657 * supports overlapping fragments, which must be
658 * contiguous starting from offset 0. We keep the
659 * largest metadata_len_sent value of the concurrent
662 registry
->metadata_len_sent
=
663 max_t(size_t, registry
->metadata_len_sent
,
664 new_metadata_len_sent
);
673 * On error, flag the registry that the metadata is
674 * closed. We were unable to push anything and this
675 * means that either the consumer is not responding or
676 * the metadata cache has been destroyed on the
679 registry
->metadata_closed
= 1;
687 * For a given application and session, push metadata to consumer.
688 * Either sock or consumer is required : if sock is NULL, the default
689 * socket to send the metadata is retrieved from consumer, if sock
690 * is not NULL we use it to send the metadata.
691 * RCU read-side lock must be held while calling this function,
692 * therefore ensuring existance of registry. It also ensures existance
693 * of socket throughout this function.
695 * Return 0 on success else a negative error.
696 * Returning a -EPIPE return value means we could not send the metadata,
697 * but it can be caused by recoverable errors (e.g. the application has
698 * terminated concurrently).
700 static int push_metadata(struct ust_registry_session
*registry
,
701 struct consumer_output
*consumer
)
705 struct consumer_socket
*socket
;
710 pthread_mutex_lock(®istry
->lock
);
711 if (registry
->metadata_closed
) {
716 /* Get consumer socket to use to push the metadata.*/
717 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
724 ret
= ust_app_push_metadata(registry
, socket
, 0);
729 pthread_mutex_unlock(®istry
->lock
);
733 pthread_mutex_unlock(®istry
->lock
);
738 * Send to the consumer a close metadata command for the given session. Once
739 * done, the metadata channel is deleted and the session metadata pointer is
740 * nullified. The session lock MUST be held unless the application is
741 * in the destroy path.
743 * Return 0 on success else a negative value.
745 static int close_metadata(struct ust_registry_session
*registry
,
746 struct consumer_output
*consumer
)
749 struct consumer_socket
*socket
;
756 pthread_mutex_lock(®istry
->lock
);
758 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
763 /* Get consumer socket to use to push the metadata.*/
764 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
771 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
778 * Metadata closed. Even on error this means that the consumer is not
779 * responding or not found so either way a second close should NOT be emit
782 registry
->metadata_closed
= 1;
784 pthread_mutex_unlock(®istry
->lock
);
790 * We need to execute ht_destroy outside of RCU read-side critical
791 * section and outside of call_rcu thread, so we postpone its execution
792 * using ht_cleanup_push. It is simpler than to change the semantic of
793 * the many callers of delete_ust_app_session().
796 void delete_ust_app_session_rcu(struct rcu_head
*head
)
798 struct ust_app_session
*ua_sess
=
799 caa_container_of(head
, struct ust_app_session
, rcu_head
);
801 ht_cleanup_push(ua_sess
->channels
);
806 * Delete ust app session safely. RCU read lock must be held before calling
809 * The session list lock must be held by the caller.
812 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
816 struct lttng_ht_iter iter
;
817 struct ust_app_channel
*ua_chan
;
818 struct ust_registry_session
*registry
;
822 pthread_mutex_lock(&ua_sess
->lock
);
824 assert(!ua_sess
->deleted
);
825 ua_sess
->deleted
= true;
827 registry
= get_session_registry(ua_sess
);
828 /* Registry can be null on error path during initialization. */
830 /* Push metadata for application before freeing the application. */
831 (void) push_metadata(registry
, ua_sess
->consumer
);
834 * Don't ask to close metadata for global per UID buffers. Close
835 * metadata only on destroy trace session in this case. Also, the
836 * previous push metadata could have flag the metadata registry to
837 * close so don't send a close command if closed.
839 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
840 /* And ask to close it for this session registry. */
841 (void) close_metadata(registry
, ua_sess
->consumer
);
845 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
847 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
849 delete_ust_app_channel(sock
, ua_chan
, app
);
852 /* In case of per PID, the registry is kept in the session. */
853 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
854 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
857 * Registry can be null on error path during
860 buffer_reg_pid_remove(reg_pid
);
861 buffer_reg_pid_destroy(reg_pid
);
865 if (ua_sess
->handle
!= -1) {
866 pthread_mutex_lock(&app
->sock_lock
);
867 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
868 pthread_mutex_unlock(&app
->sock_lock
);
869 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
870 ERR("UST app sock %d release session handle failed with ret %d",
873 /* Remove session from application UST object descriptor. */
874 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
875 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
879 pthread_mutex_unlock(&ua_sess
->lock
);
881 consumer_output_put(ua_sess
->consumer
);
883 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
887 * Delete a traceable application structure from the global list. Never call
888 * this function outside of a call_rcu call.
890 * RCU read side lock should _NOT_ be held when calling this function.
893 void delete_ust_app(struct ust_app
*app
)
896 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
899 * The session list lock must be held during this function to guarantee
900 * the existence of ua_sess.
903 /* Delete ust app sessions info */
908 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
910 /* Free every object in the session and the session. */
912 delete_ust_app_session(sock
, ua_sess
, app
);
916 ht_cleanup_push(app
->sessions
);
917 ht_cleanup_push(app
->ust_sessions_objd
);
918 ht_cleanup_push(app
->ust_objd
);
921 * Wait until we have deleted the application from the sock hash table
922 * before closing this socket, otherwise an application could re-use the
923 * socket ID and race with the teardown, using the same hash table entry.
925 * It's OK to leave the close in call_rcu. We want it to stay unique for
926 * all RCU readers that could run concurrently with unregister app,
927 * therefore we _need_ to only close that socket after a grace period. So
928 * it should stay in this RCU callback.
930 * This close() is a very important step of the synchronization model so
931 * every modification to this function must be carefully reviewed.
937 lttng_fd_put(LTTNG_FD_APPS
, 1);
939 DBG2("UST app pid %d deleted", app
->pid
);
941 session_unlock_list();
945 * URCU intermediate call to delete an UST app.
948 void delete_ust_app_rcu(struct rcu_head
*head
)
950 struct lttng_ht_node_ulong
*node
=
951 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
952 struct ust_app
*app
=
953 caa_container_of(node
, struct ust_app
, pid_n
);
955 DBG3("Call RCU deleting app PID %d", app
->pid
);
960 * Delete the session from the application ht and delete the data structure by
961 * freeing every object inside and releasing them.
963 * The session list lock must be held by the caller.
965 static void destroy_app_session(struct ust_app
*app
,
966 struct ust_app_session
*ua_sess
)
969 struct lttng_ht_iter iter
;
974 iter
.iter
.node
= &ua_sess
->node
.node
;
975 ret
= lttng_ht_del(app
->sessions
, &iter
);
977 /* Already scheduled for teardown. */
981 /* Once deleted, free the data structure. */
982 delete_ust_app_session(app
->sock
, ua_sess
, app
);
989 * Alloc new UST app session.
992 struct ust_app_session
*alloc_ust_app_session(void)
994 struct ust_app_session
*ua_sess
;
996 /* Init most of the default value by allocating and zeroing */
997 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
998 if (ua_sess
== NULL
) {
1003 ua_sess
->handle
= -1;
1004 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1005 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1006 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1015 * Alloc new UST app channel.
1018 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
1019 struct ust_app_session
*ua_sess
,
1020 struct lttng_ust_channel_attr
*attr
)
1022 struct ust_app_channel
*ua_chan
;
1024 /* Init most of the default value by allocating and zeroing */
1025 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1026 if (ua_chan
== NULL
) {
1031 /* Setup channel name */
1032 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1033 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1035 ua_chan
->enabled
= 1;
1036 ua_chan
->handle
= -1;
1037 ua_chan
->session
= ua_sess
;
1038 ua_chan
->key
= get_next_channel_key();
1039 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1040 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1041 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1043 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1044 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1046 /* Copy attributes */
1048 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1049 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1050 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1051 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1052 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1053 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1054 ua_chan
->attr
.output
= attr
->output
;
1055 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1057 /* By default, the channel is a per cpu channel. */
1058 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1060 DBG3("UST app channel %s allocated", ua_chan
->name
);
1069 * Allocate and initialize a UST app stream.
1071 * Return newly allocated stream pointer or NULL on error.
1073 struct ust_app_stream
*ust_app_alloc_stream(void)
1075 struct ust_app_stream
*stream
= NULL
;
1077 stream
= zmalloc(sizeof(*stream
));
1078 if (stream
== NULL
) {
1079 PERROR("zmalloc ust app stream");
1083 /* Zero could be a valid value for a handle so flag it to -1. */
1084 stream
->handle
= -1;
1091 * Alloc new UST app event.
1094 struct ust_app_event
*alloc_ust_app_event(char *name
,
1095 struct lttng_ust_event
*attr
)
1097 struct ust_app_event
*ua_event
;
1099 /* Init most of the default value by allocating and zeroing */
1100 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1101 if (ua_event
== NULL
) {
1106 ua_event
->enabled
= 1;
1107 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1108 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1109 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1111 /* Copy attributes */
1113 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1116 DBG3("UST app event %s allocated", ua_event
->name
);
1125 * Alloc new UST app context.
1128 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1130 struct ust_app_ctx
*ua_ctx
;
1132 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1133 if (ua_ctx
== NULL
) {
1137 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1140 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1141 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1142 char *provider_name
= NULL
, *ctx_name
= NULL
;
1144 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1145 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1146 if (!provider_name
|| !ctx_name
) {
1147 free(provider_name
);
1152 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1153 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1157 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1165 * Allocate a filter and copy the given original filter.
1167 * Return allocated filter or NULL on error.
1169 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1170 struct lttng_filter_bytecode
*orig_f
)
1172 struct lttng_filter_bytecode
*filter
= NULL
;
1174 /* Copy filter bytecode */
1175 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1177 PERROR("zmalloc alloc filter bytecode");
1181 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1188 * Create a liblttng-ust filter bytecode from given bytecode.
1190 * Return allocated filter or NULL on error.
1192 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1193 struct lttng_filter_bytecode
*orig_f
)
1195 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1197 /* Copy filter bytecode */
1198 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1200 PERROR("zmalloc alloc ust filter bytecode");
1204 assert(sizeof(struct lttng_filter_bytecode
) ==
1205 sizeof(struct lttng_ust_filter_bytecode
));
1206 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1212 * Find an ust_app using the sock and return it. RCU read side lock must be
1213 * held before calling this helper function.
1215 struct ust_app
*ust_app_find_by_sock(int sock
)
1217 struct lttng_ht_node_ulong
*node
;
1218 struct lttng_ht_iter iter
;
1220 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1221 node
= lttng_ht_iter_get_node_ulong(&iter
);
1223 DBG2("UST app find by sock %d not found", sock
);
1227 return caa_container_of(node
, struct ust_app
, sock_n
);
1234 * Find an ust_app using the notify sock and return it. RCU read side lock must
1235 * be held before calling this helper function.
1237 static struct ust_app
*find_app_by_notify_sock(int sock
)
1239 struct lttng_ht_node_ulong
*node
;
1240 struct lttng_ht_iter iter
;
1242 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1244 node
= lttng_ht_iter_get_node_ulong(&iter
);
1246 DBG2("UST app find by notify sock %d not found", sock
);
1250 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1257 * Lookup for an ust app event based on event name, filter bytecode and the
1260 * Return an ust_app_event object or NULL on error.
1262 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1263 char *name
, struct lttng_filter_bytecode
*filter
,
1265 const struct lttng_event_exclusion
*exclusion
)
1267 struct lttng_ht_iter iter
;
1268 struct lttng_ht_node_str
*node
;
1269 struct ust_app_event
*event
= NULL
;
1270 struct ust_app_ht_key key
;
1275 /* Setup key for event lookup. */
1277 key
.filter
= filter
;
1278 key
.loglevel_type
= loglevel_value
;
1279 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1280 key
.exclusion
= exclusion
;
1282 /* Lookup using the event name as hash and a custom match fct. */
1283 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1284 ht_match_ust_app_event
, &key
, &iter
.iter
);
1285 node
= lttng_ht_iter_get_node_str(&iter
);
1290 event
= caa_container_of(node
, struct ust_app_event
, node
);
1297 * Create the channel context on the tracer.
1299 * Called with UST app session lock held.
1302 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1303 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1307 health_code_update();
1309 pthread_mutex_lock(&app
->sock_lock
);
1310 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1311 ua_chan
->obj
, &ua_ctx
->obj
);
1312 pthread_mutex_unlock(&app
->sock_lock
);
1314 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1315 ERR("UST app create channel context failed for app (pid: %d) "
1316 "with ret %d", app
->pid
, ret
);
1319 * This is normal behavior, an application can die during the
1320 * creation process. Don't report an error so the execution can
1321 * continue normally.
1324 DBG3("UST app disable event failed. Application is dead.");
1329 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1331 DBG2("UST app context handle %d created successfully for channel %s",
1332 ua_ctx
->handle
, ua_chan
->name
);
1335 health_code_update();
1340 * Set the filter on the tracer.
1343 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1344 struct ust_app
*app
)
1347 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1349 health_code_update();
1351 if (!ua_event
->filter
) {
1356 ust_bytecode
= create_ust_bytecode_from_bytecode(ua_event
->filter
);
1357 if (!ust_bytecode
) {
1358 ret
= -LTTNG_ERR_NOMEM
;
1361 pthread_mutex_lock(&app
->sock_lock
);
1362 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1364 pthread_mutex_unlock(&app
->sock_lock
);
1366 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1367 ERR("UST app event %s filter failed for app (pid: %d) "
1368 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1371 * This is normal behavior, an application can die during the
1372 * creation process. Don't report an error so the execution can
1373 * continue normally.
1376 DBG3("UST app filter event failed. Application is dead.");
1381 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1384 health_code_update();
1390 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1391 struct lttng_event_exclusion
*exclusion
)
1393 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1394 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1395 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1397 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1398 if (!ust_exclusion
) {
1403 assert(sizeof(struct lttng_event_exclusion
) ==
1404 sizeof(struct lttng_ust_event_exclusion
));
1405 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1407 return ust_exclusion
;
1411 * Set event exclusions on the tracer.
1414 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1415 struct ust_app
*app
)
1418 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1420 health_code_update();
1422 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1427 ust_exclusion
= create_ust_exclusion_from_exclusion(
1428 ua_event
->exclusion
);
1429 if (!ust_exclusion
) {
1430 ret
= -LTTNG_ERR_NOMEM
;
1433 pthread_mutex_lock(&app
->sock_lock
);
1434 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1435 pthread_mutex_unlock(&app
->sock_lock
);
1437 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1438 ERR("UST app event %s exclusions failed for app (pid: %d) "
1439 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1442 * This is normal behavior, an application can die during the
1443 * creation process. Don't report an error so the execution can
1444 * continue normally.
1447 DBG3("UST app event exclusion failed. Application is dead.");
1452 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1455 health_code_update();
1456 free(ust_exclusion
);
1461 * Disable the specified event on to UST tracer for the UST session.
1463 static int disable_ust_event(struct ust_app
*app
,
1464 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1468 health_code_update();
1470 pthread_mutex_lock(&app
->sock_lock
);
1471 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1472 pthread_mutex_unlock(&app
->sock_lock
);
1474 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1475 ERR("UST app event %s disable failed for app (pid: %d) "
1476 "and session handle %d with ret %d",
1477 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1480 * This is normal behavior, an application can die during the
1481 * creation process. Don't report an error so the execution can
1482 * continue normally.
1485 DBG3("UST app disable event failed. Application is dead.");
1490 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1491 ua_event
->attr
.name
, app
->pid
);
1494 health_code_update();
1499 * Disable the specified channel on to UST tracer for the UST session.
1501 static int disable_ust_channel(struct ust_app
*app
,
1502 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1506 health_code_update();
1508 pthread_mutex_lock(&app
->sock_lock
);
1509 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1510 pthread_mutex_unlock(&app
->sock_lock
);
1512 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1513 ERR("UST app channel %s disable failed for app (pid: %d) "
1514 "and session handle %d with ret %d",
1515 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1518 * This is normal behavior, an application can die during the
1519 * creation process. Don't report an error so the execution can
1520 * continue normally.
1523 DBG3("UST app disable channel failed. Application is dead.");
1528 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1529 ua_chan
->name
, app
->pid
);
1532 health_code_update();
1537 * Enable the specified channel on to UST tracer for the UST session.
1539 static int enable_ust_channel(struct ust_app
*app
,
1540 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1544 health_code_update();
1546 pthread_mutex_lock(&app
->sock_lock
);
1547 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1548 pthread_mutex_unlock(&app
->sock_lock
);
1550 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1551 ERR("UST app channel %s enable failed for app (pid: %d) "
1552 "and session handle %d with ret %d",
1553 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1556 * This is normal behavior, an application can die during the
1557 * creation process. Don't report an error so the execution can
1558 * continue normally.
1561 DBG3("UST app enable channel failed. Application is dead.");
1566 ua_chan
->enabled
= 1;
1568 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1569 ua_chan
->name
, app
->pid
);
1572 health_code_update();
1577 * Enable the specified event on to UST tracer for the UST session.
1579 static int enable_ust_event(struct ust_app
*app
,
1580 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1584 health_code_update();
1586 pthread_mutex_lock(&app
->sock_lock
);
1587 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1588 pthread_mutex_unlock(&app
->sock_lock
);
1590 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1591 ERR("UST app event %s enable failed for app (pid: %d) "
1592 "and session handle %d with ret %d",
1593 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1596 * This is normal behavior, an application can die during the
1597 * creation process. Don't report an error so the execution can
1598 * continue normally.
1601 DBG3("UST app enable event failed. Application is dead.");
1606 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1607 ua_event
->attr
.name
, app
->pid
);
1610 health_code_update();
1615 * Send channel and stream buffer to application.
1617 * Return 0 on success. On error, a negative value is returned.
1619 static int send_channel_pid_to_ust(struct ust_app
*app
,
1620 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1623 struct ust_app_stream
*stream
, *stmp
;
1629 health_code_update();
1631 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1634 /* Send channel to the application. */
1635 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1636 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1637 ret
= -ENOTCONN
; /* Caused by app exiting. */
1639 } else if (ret
< 0) {
1643 health_code_update();
1645 /* Send all streams to application. */
1646 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1647 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1648 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1649 ret
= -ENOTCONN
; /* Caused by app exiting. */
1651 } else if (ret
< 0) {
1654 /* We don't need the stream anymore once sent to the tracer. */
1655 cds_list_del(&stream
->list
);
1656 delete_ust_app_stream(-1, stream
, app
);
1658 /* Flag the channel that it is sent to the application. */
1659 ua_chan
->is_sent
= 1;
1662 health_code_update();
1667 * Create the specified event onto the UST tracer for a UST session.
1669 * Should be called with session mutex held.
1672 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1673 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1677 health_code_update();
1679 /* Create UST event on tracer */
1680 pthread_mutex_lock(&app
->sock_lock
);
1681 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1683 pthread_mutex_unlock(&app
->sock_lock
);
1685 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1686 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1687 ua_event
->attr
.name
, app
->pid
, ret
);
1690 * This is normal behavior, an application can die during the
1691 * creation process. Don't report an error so the execution can
1692 * continue normally.
1695 DBG3("UST app create event failed. Application is dead.");
1700 ua_event
->handle
= ua_event
->obj
->handle
;
1702 DBG2("UST app event %s created successfully for pid:%d",
1703 ua_event
->attr
.name
, app
->pid
);
1705 health_code_update();
1707 /* Set filter if one is present. */
1708 if (ua_event
->filter
) {
1709 ret
= set_ust_event_filter(ua_event
, app
);
1715 /* Set exclusions for the event */
1716 if (ua_event
->exclusion
) {
1717 ret
= set_ust_event_exclusion(ua_event
, app
);
1723 /* If event not enabled, disable it on the tracer */
1724 if (ua_event
->enabled
) {
1726 * We now need to explicitly enable the event, since it
1727 * is now disabled at creation.
1729 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1732 * If we hit an EPERM, something is wrong with our enable call. If
1733 * we get an EEXIST, there is a problem on the tracer side since we
1737 case -LTTNG_UST_ERR_PERM
:
1738 /* Code flow problem */
1740 case -LTTNG_UST_ERR_EXIST
:
1741 /* It's OK for our use case. */
1752 health_code_update();
1757 * Copy data between an UST app event and a LTT event.
1759 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1760 struct ltt_ust_event
*uevent
)
1762 size_t exclusion_alloc_size
;
1764 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1765 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1767 ua_event
->enabled
= uevent
->enabled
;
1769 /* Copy event attributes */
1770 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1772 /* Copy filter bytecode */
1773 if (uevent
->filter
) {
1774 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1775 /* Filter might be NULL here in case of ENONEM. */
1778 /* Copy exclusion data */
1779 if (uevent
->exclusion
) {
1780 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1781 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1782 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1783 if (ua_event
->exclusion
== NULL
) {
1786 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1787 exclusion_alloc_size
);
1793 * Copy data between an UST app channel and a LTT channel.
1795 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1796 struct ltt_ust_channel
*uchan
)
1798 struct lttng_ht_iter iter
;
1799 struct ltt_ust_event
*uevent
;
1800 struct ltt_ust_context
*uctx
;
1801 struct ust_app_event
*ua_event
;
1803 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1805 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1806 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1808 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1809 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1811 /* Copy event attributes since the layout is different. */
1812 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1813 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1814 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1815 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1816 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1817 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
1818 ua_chan
->attr
.output
= uchan
->attr
.output
;
1819 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
1822 * Note that the attribute channel type is not set since the channel on the
1823 * tracing registry side does not have this information.
1826 ua_chan
->enabled
= uchan
->enabled
;
1827 ua_chan
->tracing_channel_id
= uchan
->id
;
1829 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1830 struct ust_app_ctx
*ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1832 if (ua_ctx
== NULL
) {
1835 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1836 (unsigned long) ua_ctx
->ctx
.ctx
);
1837 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1838 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1841 /* Copy all events from ltt ust channel to ust app channel */
1842 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1843 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1844 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1845 if (ua_event
== NULL
) {
1846 DBG2("UST event %s not found on shadow copy channel",
1848 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1849 if (ua_event
== NULL
) {
1852 shadow_copy_event(ua_event
, uevent
);
1853 add_unique_ust_app_event(ua_chan
, ua_event
);
1857 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1861 * Copy data between a UST app session and a regular LTT session.
1863 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1864 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1866 struct lttng_ht_node_str
*ua_chan_node
;
1867 struct lttng_ht_iter iter
;
1868 struct ltt_ust_channel
*uchan
;
1869 struct ust_app_channel
*ua_chan
;
1871 struct tm
*timeinfo
;
1874 char tmp_shm_path
[PATH_MAX
];
1876 /* Get date and time for unique app path */
1878 timeinfo
= localtime(&rawtime
);
1879 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1881 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1883 ua_sess
->tracing_id
= usess
->id
;
1884 ua_sess
->id
= get_next_session_id();
1885 ua_sess
->uid
= app
->uid
;
1886 ua_sess
->gid
= app
->gid
;
1887 ua_sess
->euid
= usess
->uid
;
1888 ua_sess
->egid
= usess
->gid
;
1889 ua_sess
->buffer_type
= usess
->buffer_type
;
1890 ua_sess
->bits_per_long
= app
->bits_per_long
;
1892 /* There is only one consumer object per session possible. */
1893 consumer_output_get(usess
->consumer
);
1894 ua_sess
->consumer
= usess
->consumer
;
1896 ua_sess
->output_traces
= usess
->output_traces
;
1897 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1898 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1899 &usess
->metadata_attr
);
1901 switch (ua_sess
->buffer_type
) {
1902 case LTTNG_BUFFER_PER_PID
:
1903 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1904 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1907 case LTTNG_BUFFER_PER_UID
:
1908 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1909 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1916 PERROR("asprintf UST shadow copy session");
1921 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1922 sizeof(ua_sess
->root_shm_path
));
1923 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1924 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1925 sizeof(ua_sess
->shm_path
));
1926 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1927 if (ua_sess
->shm_path
[0]) {
1928 switch (ua_sess
->buffer_type
) {
1929 case LTTNG_BUFFER_PER_PID
:
1930 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1931 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1932 app
->name
, app
->pid
, datetime
);
1934 case LTTNG_BUFFER_PER_UID
:
1935 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1936 DEFAULT_UST_TRACE_UID_PATH
,
1937 app
->uid
, app
->bits_per_long
);
1944 PERROR("sprintf UST shadow copy session");
1948 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1949 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1950 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1953 /* Iterate over all channels in global domain. */
1954 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1956 struct lttng_ht_iter uiter
;
1958 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1959 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1960 if (ua_chan_node
!= NULL
) {
1961 /* Session exist. Contiuing. */
1965 DBG2("Channel %s not found on shadow session copy, creating it",
1967 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
,
1969 if (ua_chan
== NULL
) {
1970 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1973 shadow_copy_channel(ua_chan
, uchan
);
1975 * The concept of metadata channel does not exist on the tracing
1976 * registry side of the session daemon so this can only be a per CPU
1977 * channel and not metadata.
1979 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1981 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1986 consumer_output_put(ua_sess
->consumer
);
1990 * Lookup sesison wrapper.
1993 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1994 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1996 /* Get right UST app session from app */
1997 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2001 * Return ust app session from the app session hashtable using the UST session
2004 static struct ust_app_session
*lookup_session_by_app(
2005 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2007 struct lttng_ht_iter iter
;
2008 struct lttng_ht_node_u64
*node
;
2010 __lookup_session_by_app(usess
, app
, &iter
);
2011 node
= lttng_ht_iter_get_node_u64(&iter
);
2016 return caa_container_of(node
, struct ust_app_session
, node
);
2023 * Setup buffer registry per PID for the given session and application. If none
2024 * is found, a new one is created, added to the global registry and
2025 * initialized. If regp is valid, it's set with the newly created object.
2027 * Return 0 on success or else a negative value.
2029 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2030 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2033 struct buffer_reg_pid
*reg_pid
;
2040 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2043 * This is the create channel path meaning that if there is NO
2044 * registry available, we have to create one for this session.
2046 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2047 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2055 /* Initialize registry. */
2056 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2057 app
->bits_per_long
, app
->uint8_t_alignment
,
2058 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2059 app
->uint64_t_alignment
, app
->long_alignment
,
2060 app
->byte_order
, app
->version
.major
,
2061 app
->version
.minor
, reg_pid
->root_shm_path
,
2063 ua_sess
->euid
, ua_sess
->egid
);
2066 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2067 * destroy the buffer registry, because it is always expected
2068 * that if the buffer registry can be found, its ust registry is
2071 buffer_reg_pid_destroy(reg_pid
);
2075 buffer_reg_pid_add(reg_pid
);
2077 DBG3("UST app buffer registry per PID created successfully");
2089 * Setup buffer registry per UID for the given session and application. If none
2090 * is found, a new one is created, added to the global registry and
2091 * initialized. If regp is valid, it's set with the newly created object.
2093 * Return 0 on success or else a negative value.
2095 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2096 struct ust_app_session
*ua_sess
,
2097 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2100 struct buffer_reg_uid
*reg_uid
;
2107 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2110 * This is the create channel path meaning that if there is NO
2111 * registry available, we have to create one for this session.
2113 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2114 LTTNG_DOMAIN_UST
, ®_uid
,
2115 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2123 /* Initialize registry. */
2124 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2125 app
->bits_per_long
, app
->uint8_t_alignment
,
2126 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2127 app
->uint64_t_alignment
, app
->long_alignment
,
2128 app
->byte_order
, app
->version
.major
,
2129 app
->version
.minor
, reg_uid
->root_shm_path
,
2130 reg_uid
->shm_path
, usess
->uid
, usess
->gid
);
2133 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2134 * destroy the buffer registry, because it is always expected
2135 * that if the buffer registry can be found, its ust registry is
2138 buffer_reg_uid_destroy(reg_uid
, NULL
);
2141 /* Add node to teardown list of the session. */
2142 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2144 buffer_reg_uid_add(reg_uid
);
2146 DBG3("UST app buffer registry per UID created successfully");
2157 * Create a session on the tracer side for the given app.
2159 * On success, ua_sess_ptr is populated with the session pointer or else left
2160 * untouched. If the session was created, is_created is set to 1. On error,
2161 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2164 * Returns 0 on success or else a negative code which is either -ENOMEM or
2165 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2167 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2168 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2171 int ret
, created
= 0;
2172 struct ust_app_session
*ua_sess
;
2176 assert(ua_sess_ptr
);
2178 health_code_update();
2180 ua_sess
= lookup_session_by_app(usess
, app
);
2181 if (ua_sess
== NULL
) {
2182 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2183 app
->pid
, usess
->id
);
2184 ua_sess
= alloc_ust_app_session();
2185 if (ua_sess
== NULL
) {
2186 /* Only malloc can failed so something is really wrong */
2190 shadow_copy_session(ua_sess
, usess
, app
);
2194 switch (usess
->buffer_type
) {
2195 case LTTNG_BUFFER_PER_PID
:
2196 /* Init local registry. */
2197 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2199 delete_ust_app_session(-1, ua_sess
, app
);
2203 case LTTNG_BUFFER_PER_UID
:
2204 /* Look for a global registry. If none exists, create one. */
2205 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2207 delete_ust_app_session(-1, ua_sess
, app
);
2217 health_code_update();
2219 if (ua_sess
->handle
== -1) {
2220 pthread_mutex_lock(&app
->sock_lock
);
2221 ret
= ustctl_create_session(app
->sock
);
2222 pthread_mutex_unlock(&app
->sock_lock
);
2224 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2225 ERR("Creating session for app pid %d with ret %d",
2228 DBG("UST app creating session failed. Application is dead");
2230 * This is normal behavior, an application can die during the
2231 * creation process. Don't report an error so the execution can
2232 * continue normally. This will get flagged ENOTCONN and the
2233 * caller will handle it.
2237 delete_ust_app_session(-1, ua_sess
, app
);
2238 if (ret
!= -ENOMEM
) {
2240 * Tracer is probably gone or got an internal error so let's
2241 * behave like it will soon unregister or not usable.
2248 ua_sess
->handle
= ret
;
2250 /* Add ust app session to app's HT */
2251 lttng_ht_node_init_u64(&ua_sess
->node
,
2252 ua_sess
->tracing_id
);
2253 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2254 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2255 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2256 &ua_sess
->ust_objd_node
);
2258 DBG2("UST app session created successfully with handle %d", ret
);
2261 *ua_sess_ptr
= ua_sess
;
2263 *is_created
= created
;
2266 /* Everything went well. */
2270 health_code_update();
2275 * Match function for a hash table lookup of ust_app_ctx.
2277 * It matches an ust app context based on the context type and, in the case
2278 * of perf counters, their name.
2280 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2282 struct ust_app_ctx
*ctx
;
2283 const struct lttng_ust_context_attr
*key
;
2288 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2292 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2297 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2298 if (strncmp(key
->u
.perf_counter
.name
,
2299 ctx
->ctx
.u
.perf_counter
.name
,
2300 sizeof(key
->u
.perf_counter
.name
))) {
2304 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2305 if (strcmp(key
->u
.app_ctx
.provider_name
,
2306 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2307 strcmp(key
->u
.app_ctx
.ctx_name
,
2308 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2324 * Lookup for an ust app context from an lttng_ust_context.
2326 * Must be called while holding RCU read side lock.
2327 * Return an ust_app_ctx object or NULL on error.
2330 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2331 struct lttng_ust_context_attr
*uctx
)
2333 struct lttng_ht_iter iter
;
2334 struct lttng_ht_node_ulong
*node
;
2335 struct ust_app_ctx
*app_ctx
= NULL
;
2340 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2341 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2342 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2343 node
= lttng_ht_iter_get_node_ulong(&iter
);
2348 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2355 * Create a context for the channel on the tracer.
2357 * Called with UST app session lock held and a RCU read side lock.
2360 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2361 struct lttng_ust_context_attr
*uctx
,
2362 struct ust_app
*app
)
2365 struct ust_app_ctx
*ua_ctx
;
2367 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2369 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2375 ua_ctx
= alloc_ust_app_ctx(uctx
);
2376 if (ua_ctx
== NULL
) {
2382 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2383 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2384 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2386 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2396 * Enable on the tracer side a ust app event for the session and channel.
2398 * Called with UST app session lock held.
2401 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2402 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2406 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2411 ua_event
->enabled
= 1;
2418 * Disable on the tracer side a ust app event for the session and channel.
2420 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2421 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2425 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2430 ua_event
->enabled
= 0;
2437 * Lookup ust app channel for session and disable it on the tracer side.
2440 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2441 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2445 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2450 ua_chan
->enabled
= 0;
2457 * Lookup ust app channel for session and enable it on the tracer side. This
2458 * MUST be called with a RCU read side lock acquired.
2460 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2461 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2464 struct lttng_ht_iter iter
;
2465 struct lttng_ht_node_str
*ua_chan_node
;
2466 struct ust_app_channel
*ua_chan
;
2468 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2469 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2470 if (ua_chan_node
== NULL
) {
2471 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2472 uchan
->name
, ua_sess
->tracing_id
);
2476 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2478 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2488 * Ask the consumer to create a channel and get it if successful.
2490 * Called with UST app session lock held.
2492 * Return 0 on success or else a negative value.
2494 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2495 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2496 int bitness
, struct ust_registry_session
*registry
,
2497 uint64_t trace_archive_id
)
2500 unsigned int nb_fd
= 0;
2501 struct consumer_socket
*socket
;
2509 health_code_update();
2511 /* Get the right consumer socket for the application. */
2512 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2518 health_code_update();
2520 /* Need one fd for the channel. */
2521 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2523 ERR("Exhausted number of available FD upon create channel");
2528 * Ask consumer to create channel. The consumer will return the number of
2529 * stream we have to expect.
2531 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2532 registry
, trace_archive_id
);
2538 * Compute the number of fd needed before receiving them. It must be 2 per
2539 * stream (2 being the default value here).
2541 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2543 /* Reserve the amount of file descriptor we need. */
2544 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2546 ERR("Exhausted number of available FD upon create channel");
2547 goto error_fd_get_stream
;
2550 health_code_update();
2553 * Now get the channel from the consumer. This call wil populate the stream
2554 * list of that channel and set the ust objects.
2556 if (usess
->consumer
->enabled
) {
2557 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2567 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2568 error_fd_get_stream
:
2570 * Initiate a destroy channel on the consumer since we had an error
2571 * handling it on our side. The return value is of no importance since we
2572 * already have a ret value set by the previous error that we need to
2575 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2577 lttng_fd_put(LTTNG_FD_APPS
, 1);
2579 health_code_update();
2585 * Duplicate the ust data object of the ust app stream and save it in the
2586 * buffer registry stream.
2588 * Return 0 on success or else a negative value.
2590 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2591 struct ust_app_stream
*stream
)
2598 /* Reserve the amount of file descriptor we need. */
2599 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2601 ERR("Exhausted number of available FD upon duplicate stream");
2605 /* Duplicate object for stream once the original is in the registry. */
2606 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2607 reg_stream
->obj
.ust
);
2609 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2610 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2611 lttng_fd_put(LTTNG_FD_APPS
, 2);
2614 stream
->handle
= stream
->obj
->handle
;
2621 * Duplicate the ust data object of the ust app. channel and save it in the
2622 * buffer registry channel.
2624 * Return 0 on success or else a negative value.
2626 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2627 struct ust_app_channel
*ua_chan
)
2634 /* Need two fds for the channel. */
2635 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2637 ERR("Exhausted number of available FD upon duplicate channel");
2641 /* Duplicate object for stream once the original is in the registry. */
2642 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2644 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2645 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2648 ua_chan
->handle
= ua_chan
->obj
->handle
;
2653 lttng_fd_put(LTTNG_FD_APPS
, 1);
2659 * For a given channel buffer registry, setup all streams of the given ust
2660 * application channel.
2662 * Return 0 on success or else a negative value.
2664 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2665 struct ust_app_channel
*ua_chan
,
2666 struct ust_app
*app
)
2669 struct ust_app_stream
*stream
, *stmp
;
2674 DBG2("UST app setup buffer registry stream");
2676 /* Send all streams to application. */
2677 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2678 struct buffer_reg_stream
*reg_stream
;
2680 ret
= buffer_reg_stream_create(®_stream
);
2686 * Keep original pointer and nullify it in the stream so the delete
2687 * stream call does not release the object.
2689 reg_stream
->obj
.ust
= stream
->obj
;
2691 buffer_reg_stream_add(reg_stream
, reg_chan
);
2693 /* We don't need the streams anymore. */
2694 cds_list_del(&stream
->list
);
2695 delete_ust_app_stream(-1, stream
, app
);
2703 * Create a buffer registry channel for the given session registry and
2704 * application channel object. If regp pointer is valid, it's set with the
2705 * created object. Important, the created object is NOT added to the session
2706 * registry hash table.
2708 * Return 0 on success else a negative value.
2710 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2711 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2714 struct buffer_reg_channel
*reg_chan
= NULL
;
2719 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2721 /* Create buffer registry channel. */
2722 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2727 reg_chan
->consumer_key
= ua_chan
->key
;
2728 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2729 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2731 /* Create and add a channel registry to session. */
2732 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2733 ua_chan
->tracing_channel_id
);
2737 buffer_reg_channel_add(reg_sess
, reg_chan
);
2746 /* Safe because the registry channel object was not added to any HT. */
2747 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2753 * Setup buffer registry channel for the given session registry and application
2754 * channel object. If regp pointer is valid, it's set with the created object.
2756 * Return 0 on success else a negative value.
2758 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2759 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2760 struct ust_app
*app
)
2767 assert(ua_chan
->obj
);
2769 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2771 /* Setup all streams for the registry. */
2772 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2777 reg_chan
->obj
.ust
= ua_chan
->obj
;
2778 ua_chan
->obj
= NULL
;
2783 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2784 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2789 * Send buffer registry channel to the application.
2791 * Return 0 on success else a negative value.
2793 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2794 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2795 struct ust_app_channel
*ua_chan
)
2798 struct buffer_reg_stream
*reg_stream
;
2805 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2807 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2812 /* Send channel to the application. */
2813 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2814 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2815 ret
= -ENOTCONN
; /* Caused by app exiting. */
2817 } else if (ret
< 0) {
2821 health_code_update();
2823 /* Send all streams to application. */
2824 pthread_mutex_lock(®_chan
->stream_list_lock
);
2825 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2826 struct ust_app_stream stream
;
2828 ret
= duplicate_stream_object(reg_stream
, &stream
);
2830 goto error_stream_unlock
;
2833 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2835 (void) release_ust_app_stream(-1, &stream
, app
);
2836 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2837 ret
= -ENOTCONN
; /* Caused by app exiting. */
2839 goto error_stream_unlock
;
2843 * The return value is not important here. This function will output an
2846 (void) release_ust_app_stream(-1, &stream
, app
);
2848 ua_chan
->is_sent
= 1;
2850 error_stream_unlock
:
2851 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2857 * Create and send to the application the created buffers with per UID buffers.
2859 * This MUST be called with a RCU read side lock acquired.
2860 * The session list lock and the session's lock must be acquired.
2862 * Return 0 on success else a negative value.
2864 static int create_channel_per_uid(struct ust_app
*app
,
2865 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2866 struct ust_app_channel
*ua_chan
)
2869 struct buffer_reg_uid
*reg_uid
;
2870 struct buffer_reg_channel
*reg_chan
;
2871 struct ltt_session
*session
= NULL
;
2872 enum lttng_error_code notification_ret
;
2873 struct ust_registry_channel
*chan_reg
;
2880 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2882 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2884 * The session creation handles the creation of this global registry
2885 * object. If none can be find, there is a code flow problem or a
2890 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2896 /* Create the buffer registry channel object. */
2897 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2899 ERR("Error creating the UST channel \"%s\" registry instance",
2904 session
= session_find_by_id(ua_sess
->tracing_id
);
2906 assert(pthread_mutex_trylock(&session
->lock
));
2907 assert(session_trylock_list());
2910 * Create the buffers on the consumer side. This call populates the
2911 * ust app channel object with all streams and data object.
2913 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2914 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
2915 session
->current_archive_id
);
2917 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2921 * Let's remove the previously created buffer registry channel so
2922 * it's not visible anymore in the session registry.
2924 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2925 ua_chan
->tracing_channel_id
, false);
2926 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2927 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2932 * Setup the streams and add it to the session registry.
2934 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2935 ua_chan
, reg_chan
, app
);
2937 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
2941 /* Notify the notification subsystem of the channel's creation. */
2942 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
2943 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
2944 ua_chan
->tracing_channel_id
);
2946 chan_reg
->consumer_key
= ua_chan
->key
;
2948 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
2950 notification_ret
= notification_thread_command_add_channel(
2951 notification_thread_handle
, session
->name
,
2952 ua_sess
->euid
, ua_sess
->egid
,
2956 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
2957 if (notification_ret
!= LTTNG_OK
) {
2958 ret
= - (int) notification_ret
;
2959 ERR("Failed to add channel to notification thread");
2964 /* Send buffers to the application. */
2965 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2967 if (ret
!= -ENOTCONN
) {
2968 ERR("Error sending channel to application");
2975 session_put(session
);
2981 * Create and send to the application the created buffers with per PID buffers.
2983 * Called with UST app session lock held.
2984 * The session list lock and the session's lock must be acquired.
2986 * Return 0 on success else a negative value.
2988 static int create_channel_per_pid(struct ust_app
*app
,
2989 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2990 struct ust_app_channel
*ua_chan
)
2993 struct ust_registry_session
*registry
;
2994 enum lttng_error_code cmd_ret
;
2995 struct ltt_session
*session
= NULL
;
2996 uint64_t chan_reg_key
;
2997 struct ust_registry_channel
*chan_reg
;
3004 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3008 registry
= get_session_registry(ua_sess
);
3009 /* The UST app session lock is held, registry shall not be null. */
3012 /* Create and add a new channel registry to session. */
3013 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3015 ERR("Error creating the UST channel \"%s\" registry instance",
3020 session
= session_find_by_id(ua_sess
->tracing_id
);
3023 assert(pthread_mutex_trylock(&session
->lock
));
3024 assert(session_trylock_list());
3026 /* Create and get channel on the consumer side. */
3027 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3028 app
->bits_per_long
, registry
,
3029 session
->current_archive_id
);
3031 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3033 goto error_remove_from_registry
;
3036 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3038 if (ret
!= -ENOTCONN
) {
3039 ERR("Error sending channel to application");
3041 goto error_remove_from_registry
;
3044 chan_reg_key
= ua_chan
->key
;
3045 pthread_mutex_lock(®istry
->lock
);
3046 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3048 chan_reg
->consumer_key
= ua_chan
->key
;
3049 pthread_mutex_unlock(®istry
->lock
);
3051 cmd_ret
= notification_thread_command_add_channel(
3052 notification_thread_handle
, session
->name
,
3053 ua_sess
->euid
, ua_sess
->egid
,
3057 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3058 if (cmd_ret
!= LTTNG_OK
) {
3059 ret
= - (int) cmd_ret
;
3060 ERR("Failed to add channel to notification thread");
3061 goto error_remove_from_registry
;
3064 error_remove_from_registry
:
3066 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3071 session_put(session
);
3077 * From an already allocated ust app channel, create the channel buffers if
3078 * need and send it to the application. This MUST be called with a RCU read
3079 * side lock acquired.
3081 * Called with UST app session lock held.
3083 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3084 * the application exited concurrently.
3086 static int do_create_channel(struct ust_app
*app
,
3087 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3088 struct ust_app_channel
*ua_chan
)
3097 /* Handle buffer type before sending the channel to the application. */
3098 switch (usess
->buffer_type
) {
3099 case LTTNG_BUFFER_PER_UID
:
3101 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3107 case LTTNG_BUFFER_PER_PID
:
3109 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3121 /* Initialize ust objd object using the received handle and add it. */
3122 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3123 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3125 /* If channel is not enabled, disable it on the tracer */
3126 if (!ua_chan
->enabled
) {
3127 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3138 * Create UST app channel and create it on the tracer. Set ua_chanp of the
3139 * newly created channel if not NULL.
3141 * Called with UST app session lock and RCU read-side lock held.
3143 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3144 * the application exited concurrently.
3146 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
3147 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
3148 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3149 struct ust_app_channel
**ua_chanp
)
3152 struct lttng_ht_iter iter
;
3153 struct lttng_ht_node_str
*ua_chan_node
;
3154 struct ust_app_channel
*ua_chan
;
3156 /* Lookup channel in the ust app session */
3157 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3158 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3159 if (ua_chan_node
!= NULL
) {
3160 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3164 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3165 if (ua_chan
== NULL
) {
3166 /* Only malloc can fail here */
3170 shadow_copy_channel(ua_chan
, uchan
);
3172 /* Set channel type. */
3173 ua_chan
->attr
.type
= type
;
3175 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
3180 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
3183 /* Only add the channel if successful on the tracer side. */
3184 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3187 *ua_chanp
= ua_chan
;
3190 /* Everything went well. */
3194 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
3200 * Create UST app event and create it on the tracer side.
3202 * Called with ust app session mutex held.
3205 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3206 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3207 struct ust_app
*app
)
3210 struct ust_app_event
*ua_event
;
3212 /* Get event node */
3213 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3214 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3215 if (ua_event
!= NULL
) {
3220 /* Does not exist so create one */
3221 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3222 if (ua_event
== NULL
) {
3223 /* Only malloc can failed so something is really wrong */
3227 shadow_copy_event(ua_event
, uevent
);
3229 /* Create it on the tracer side */
3230 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3232 /* Not found previously means that it does not exist on the tracer */
3233 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
3237 add_unique_ust_app_event(ua_chan
, ua_event
);
3239 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3246 /* Valid. Calling here is already in a read side lock */
3247 delete_ust_app_event(-1, ua_event
, app
);
3252 * Create UST metadata and open it on the tracer side.
3254 * Called with UST app session lock held and RCU read side lock.
3256 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3257 struct ust_app
*app
, struct consumer_output
*consumer
)
3260 struct ust_app_channel
*metadata
;
3261 struct consumer_socket
*socket
;
3262 struct ust_registry_session
*registry
;
3263 struct ltt_session
*session
= NULL
;
3269 registry
= get_session_registry(ua_sess
);
3270 /* The UST app session is held registry shall not be null. */
3273 pthread_mutex_lock(®istry
->lock
);
3275 /* Metadata already exists for this registry or it was closed previously */
3276 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3281 /* Allocate UST metadata */
3282 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3284 /* malloc() failed */
3289 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3291 /* Need one fd for the channel. */
3292 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3294 ERR("Exhausted number of available FD upon create metadata");
3298 /* Get the right consumer socket for the application. */
3299 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3302 goto error_consumer
;
3306 * Keep metadata key so we can identify it on the consumer side. Assign it
3307 * to the registry *before* we ask the consumer so we avoid the race of the
3308 * consumer requesting the metadata and the ask_channel call on our side
3309 * did not returned yet.
3311 registry
->metadata_key
= metadata
->key
;
3313 session
= session_find_by_id(ua_sess
->tracing_id
);
3316 assert(pthread_mutex_trylock(&session
->lock
));
3317 assert(session_trylock_list());
3320 * Ask the metadata channel creation to the consumer. The metadata object
3321 * will be created by the consumer and kept their. However, the stream is
3322 * never added or monitored until we do a first push metadata to the
3325 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3326 registry
, session
->current_archive_id
);
3328 /* Nullify the metadata key so we don't try to close it later on. */
3329 registry
->metadata_key
= 0;
3330 goto error_consumer
;
3334 * The setup command will make the metadata stream be sent to the relayd,
3335 * if applicable, and the thread managing the metadatas. This is important
3336 * because after this point, if an error occurs, the only way the stream
3337 * can be deleted is to be monitored in the consumer.
3339 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3341 /* Nullify the metadata key so we don't try to close it later on. */
3342 registry
->metadata_key
= 0;
3343 goto error_consumer
;
3346 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3347 metadata
->key
, app
->pid
);
3350 lttng_fd_put(LTTNG_FD_APPS
, 1);
3351 delete_ust_app_channel(-1, metadata
, app
);
3353 pthread_mutex_unlock(®istry
->lock
);
3355 session_put(session
);
3361 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3362 * acquired before calling this function.
3364 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3366 struct ust_app
*app
= NULL
;
3367 struct lttng_ht_node_ulong
*node
;
3368 struct lttng_ht_iter iter
;
3370 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3371 node
= lttng_ht_iter_get_node_ulong(&iter
);
3373 DBG2("UST app no found with pid %d", pid
);
3377 DBG2("Found UST app by pid %d", pid
);
3379 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3386 * Allocate and init an UST app object using the registration information and
3387 * the command socket. This is called when the command socket connects to the
3390 * The object is returned on success or else NULL.
3392 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3394 struct ust_app
*lta
= NULL
;
3399 DBG3("UST app creating application for socket %d", sock
);
3401 if ((msg
->bits_per_long
== 64 &&
3402 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3403 || (msg
->bits_per_long
== 32 &&
3404 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3405 ERR("Registration failed: application \"%s\" (pid: %d) has "
3406 "%d-bit long, but no consumerd for this size is available.\n",
3407 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3411 lta
= zmalloc(sizeof(struct ust_app
));
3417 lta
->ppid
= msg
->ppid
;
3418 lta
->uid
= msg
->uid
;
3419 lta
->gid
= msg
->gid
;
3421 lta
->bits_per_long
= msg
->bits_per_long
;
3422 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3423 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3424 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3425 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3426 lta
->long_alignment
= msg
->long_alignment
;
3427 lta
->byte_order
= msg
->byte_order
;
3429 lta
->v_major
= msg
->major
;
3430 lta
->v_minor
= msg
->minor
;
3431 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3432 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3433 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3434 lta
->notify_sock
= -1;
3436 /* Copy name and make sure it's NULL terminated. */
3437 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3438 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3441 * Before this can be called, when receiving the registration information,
3442 * the application compatibility is checked. So, at this point, the
3443 * application can work with this session daemon.
3445 lta
->compatible
= 1;
3447 lta
->pid
= msg
->pid
;
3448 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3450 pthread_mutex_init(<a
->sock_lock
, NULL
);
3451 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3453 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3459 * For a given application object, add it to every hash table.
3461 void ust_app_add(struct ust_app
*app
)
3464 assert(app
->notify_sock
>= 0);
3469 * On a re-registration, we want to kick out the previous registration of
3472 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3475 * The socket _should_ be unique until _we_ call close. So, a add_unique
3476 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3477 * already in the table.
3479 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3481 /* Add application to the notify socket hash table. */
3482 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3483 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3485 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3486 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3487 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3494 * Set the application version into the object.
3496 * Return 0 on success else a negative value either an errno code or a
3497 * LTTng-UST error code.
3499 int ust_app_version(struct ust_app
*app
)
3505 pthread_mutex_lock(&app
->sock_lock
);
3506 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3507 pthread_mutex_unlock(&app
->sock_lock
);
3509 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3510 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3512 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3520 * Unregister app by removing it from the global traceable app list and freeing
3523 * The socket is already closed at this point so no close to sock.
3525 void ust_app_unregister(int sock
)
3527 struct ust_app
*lta
;
3528 struct lttng_ht_node_ulong
*node
;
3529 struct lttng_ht_iter ust_app_sock_iter
;
3530 struct lttng_ht_iter iter
;
3531 struct ust_app_session
*ua_sess
;
3536 /* Get the node reference for a call_rcu */
3537 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3538 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3541 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3542 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3545 * For per-PID buffers, perform "push metadata" and flush all
3546 * application streams before removing app from hash tables,
3547 * ensuring proper behavior of data_pending check.
3548 * Remove sessions so they are not visible during deletion.
3550 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3552 struct ust_registry_session
*registry
;
3554 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3556 /* The session was already removed so scheduled for teardown. */
3560 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3561 (void) ust_app_flush_app_session(lta
, ua_sess
);
3565 * Add session to list for teardown. This is safe since at this point we
3566 * are the only one using this list.
3568 pthread_mutex_lock(&ua_sess
->lock
);
3570 if (ua_sess
->deleted
) {
3571 pthread_mutex_unlock(&ua_sess
->lock
);
3576 * Normally, this is done in the delete session process which is
3577 * executed in the call rcu below. However, upon registration we can't
3578 * afford to wait for the grace period before pushing data or else the
3579 * data pending feature can race between the unregistration and stop
3580 * command where the data pending command is sent *before* the grace
3583 * The close metadata below nullifies the metadata pointer in the
3584 * session so the delete session will NOT push/close a second time.
3586 registry
= get_session_registry(ua_sess
);
3588 /* Push metadata for application before freeing the application. */
3589 (void) push_metadata(registry
, ua_sess
->consumer
);
3592 * Don't ask to close metadata for global per UID buffers. Close
3593 * metadata only on destroy trace session in this case. Also, the
3594 * previous push metadata could have flag the metadata registry to
3595 * close so don't send a close command if closed.
3597 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3598 /* And ask to close it for this session registry. */
3599 (void) close_metadata(registry
, ua_sess
->consumer
);
3602 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3604 pthread_mutex_unlock(&ua_sess
->lock
);
3607 /* Remove application from PID hash table */
3608 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3612 * Remove application from notify hash table. The thread handling the
3613 * notify socket could have deleted the node so ignore on error because
3614 * either way it's valid. The close of that socket is handled by the
3615 * apps_notify_thread.
3617 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3618 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3621 * Ignore return value since the node might have been removed before by an
3622 * add replace during app registration because the PID can be reassigned by
3625 iter
.iter
.node
= <a
->pid_n
.node
;
3626 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3628 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3633 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3640 * Fill events array with all events name of all registered apps.
3642 int ust_app_list_events(struct lttng_event
**events
)
3645 size_t nbmem
, count
= 0;
3646 struct lttng_ht_iter iter
;
3647 struct ust_app
*app
;
3648 struct lttng_event
*tmp_event
;
3650 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3651 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3652 if (tmp_event
== NULL
) {
3653 PERROR("zmalloc ust app events");
3660 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3661 struct lttng_ust_tracepoint_iter uiter
;
3663 health_code_update();
3665 if (!app
->compatible
) {
3667 * TODO: In time, we should notice the caller of this error by
3668 * telling him that this is a version error.
3672 pthread_mutex_lock(&app
->sock_lock
);
3673 handle
= ustctl_tracepoint_list(app
->sock
);
3675 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3676 ERR("UST app list events getting handle failed for app pid %d",
3679 pthread_mutex_unlock(&app
->sock_lock
);
3683 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3684 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3685 /* Handle ustctl error. */
3689 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3690 ERR("UST app tp list get failed for app %d with ret %d",
3693 DBG3("UST app tp list get failed. Application is dead");
3695 * This is normal behavior, an application can die during the
3696 * creation process. Don't report an error so the execution can
3697 * continue normally. Continue normal execution.
3702 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3703 if (release_ret
< 0 &&
3704 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3705 release_ret
!= -EPIPE
) {
3706 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3708 pthread_mutex_unlock(&app
->sock_lock
);
3712 health_code_update();
3713 if (count
>= nbmem
) {
3714 /* In case the realloc fails, we free the memory */
3715 struct lttng_event
*new_tmp_event
;
3718 new_nbmem
= nbmem
<< 1;
3719 DBG2("Reallocating event list from %zu to %zu entries",
3721 new_tmp_event
= realloc(tmp_event
,
3722 new_nbmem
* sizeof(struct lttng_event
));
3723 if (new_tmp_event
== NULL
) {
3726 PERROR("realloc ust app events");
3729 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3730 if (release_ret
< 0 &&
3731 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3732 release_ret
!= -EPIPE
) {
3733 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3735 pthread_mutex_unlock(&app
->sock_lock
);
3738 /* Zero the new memory */
3739 memset(new_tmp_event
+ nbmem
, 0,
3740 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3742 tmp_event
= new_tmp_event
;
3744 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3745 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3746 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3747 tmp_event
[count
].pid
= app
->pid
;
3748 tmp_event
[count
].enabled
= -1;
3751 ret
= ustctl_release_handle(app
->sock
, handle
);
3752 pthread_mutex_unlock(&app
->sock_lock
);
3753 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3754 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3759 *events
= tmp_event
;
3761 DBG2("UST app list events done (%zu events)", count
);
3766 health_code_update();
3771 * Fill events array with all events name of all registered apps.
3773 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3776 size_t nbmem
, count
= 0;
3777 struct lttng_ht_iter iter
;
3778 struct ust_app
*app
;
3779 struct lttng_event_field
*tmp_event
;
3781 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3782 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3783 if (tmp_event
== NULL
) {
3784 PERROR("zmalloc ust app event fields");
3791 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3792 struct lttng_ust_field_iter uiter
;
3794 health_code_update();
3796 if (!app
->compatible
) {
3798 * TODO: In time, we should notice the caller of this error by
3799 * telling him that this is a version error.
3803 pthread_mutex_lock(&app
->sock_lock
);
3804 handle
= ustctl_tracepoint_field_list(app
->sock
);
3806 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3807 ERR("UST app list field getting handle failed for app pid %d",
3810 pthread_mutex_unlock(&app
->sock_lock
);
3814 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3815 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3816 /* Handle ustctl error. */
3820 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3821 ERR("UST app tp list field failed for app %d with ret %d",
3824 DBG3("UST app tp list field failed. Application is dead");
3826 * This is normal behavior, an application can die during the
3827 * creation process. Don't report an error so the execution can
3828 * continue normally. Reset list and count for next app.
3833 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3834 pthread_mutex_unlock(&app
->sock_lock
);
3835 if (release_ret
< 0 &&
3836 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3837 release_ret
!= -EPIPE
) {
3838 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3843 health_code_update();
3844 if (count
>= nbmem
) {
3845 /* In case the realloc fails, we free the memory */
3846 struct lttng_event_field
*new_tmp_event
;
3849 new_nbmem
= nbmem
<< 1;
3850 DBG2("Reallocating event field list from %zu to %zu entries",
3852 new_tmp_event
= realloc(tmp_event
,
3853 new_nbmem
* sizeof(struct lttng_event_field
));
3854 if (new_tmp_event
== NULL
) {
3857 PERROR("realloc ust app event fields");
3860 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3861 pthread_mutex_unlock(&app
->sock_lock
);
3863 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3864 release_ret
!= -EPIPE
) {
3865 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3869 /* Zero the new memory */
3870 memset(new_tmp_event
+ nbmem
, 0,
3871 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3873 tmp_event
= new_tmp_event
;
3876 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3877 /* Mapping between these enums matches 1 to 1. */
3878 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3879 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3881 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3882 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3883 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3884 tmp_event
[count
].event
.pid
= app
->pid
;
3885 tmp_event
[count
].event
.enabled
= -1;
3888 ret
= ustctl_release_handle(app
->sock
, handle
);
3889 pthread_mutex_unlock(&app
->sock_lock
);
3891 ret
!= -LTTNG_UST_ERR_EXITING
&&
3893 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3898 *fields
= tmp_event
;
3900 DBG2("UST app list event fields done (%zu events)", count
);
3905 health_code_update();
3910 * Free and clean all traceable apps of the global list.
3912 * Should _NOT_ be called with RCU read-side lock held.
3914 void ust_app_clean_list(void)
3917 struct ust_app
*app
;
3918 struct lttng_ht_iter iter
;
3920 DBG2("UST app cleaning registered apps hash table");
3925 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3926 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3928 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3932 /* Cleanup socket hash table */
3933 if (ust_app_ht_by_sock
) {
3934 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3936 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3941 /* Cleanup notify socket hash table */
3942 if (ust_app_ht_by_notify_sock
) {
3943 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3944 notify_sock_n
.node
) {
3945 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3951 /* Destroy is done only when the ht is empty */
3953 ht_cleanup_push(ust_app_ht
);
3955 if (ust_app_ht_by_sock
) {
3956 ht_cleanup_push(ust_app_ht_by_sock
);
3958 if (ust_app_ht_by_notify_sock
) {
3959 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3964 * Init UST app hash table.
3966 int ust_app_ht_alloc(void)
3968 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3972 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3973 if (!ust_app_ht_by_sock
) {
3976 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3977 if (!ust_app_ht_by_notify_sock
) {
3984 * For a specific UST session, disable the channel for all registered apps.
3986 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3987 struct ltt_ust_channel
*uchan
)
3990 struct lttng_ht_iter iter
;
3991 struct lttng_ht_node_str
*ua_chan_node
;
3992 struct ust_app
*app
;
3993 struct ust_app_session
*ua_sess
;
3994 struct ust_app_channel
*ua_chan
;
3996 if (usess
== NULL
|| uchan
== NULL
) {
3997 ERR("Disabling UST global channel with NULL values");
4002 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4003 uchan
->name
, usess
->id
);
4007 /* For every registered applications */
4008 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4009 struct lttng_ht_iter uiter
;
4010 if (!app
->compatible
) {
4012 * TODO: In time, we should notice the caller of this error by
4013 * telling him that this is a version error.
4017 ua_sess
= lookup_session_by_app(usess
, app
);
4018 if (ua_sess
== NULL
) {
4023 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4024 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4025 /* If the session if found for the app, the channel must be there */
4026 assert(ua_chan_node
);
4028 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4029 /* The channel must not be already disabled */
4030 assert(ua_chan
->enabled
== 1);
4032 /* Disable channel onto application */
4033 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4035 /* XXX: We might want to report this error at some point... */
4047 * For a specific UST session, enable the channel for all registered apps.
4049 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4050 struct ltt_ust_channel
*uchan
)
4053 struct lttng_ht_iter iter
;
4054 struct ust_app
*app
;
4055 struct ust_app_session
*ua_sess
;
4057 if (usess
== NULL
|| uchan
== NULL
) {
4058 ERR("Adding UST global channel to NULL values");
4063 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4064 uchan
->name
, usess
->id
);
4068 /* For every registered applications */
4069 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4070 if (!app
->compatible
) {
4072 * TODO: In time, we should notice the caller of this error by
4073 * telling him that this is a version error.
4077 ua_sess
= lookup_session_by_app(usess
, app
);
4078 if (ua_sess
== NULL
) {
4082 /* Enable channel onto application */
4083 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4085 /* XXX: We might want to report this error at some point... */
4097 * Disable an event in a channel and for a specific session.
4099 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4100 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4103 struct lttng_ht_iter iter
, uiter
;
4104 struct lttng_ht_node_str
*ua_chan_node
;
4105 struct ust_app
*app
;
4106 struct ust_app_session
*ua_sess
;
4107 struct ust_app_channel
*ua_chan
;
4108 struct ust_app_event
*ua_event
;
4110 DBG("UST app disabling event %s for all apps in channel "
4111 "%s for session id %" PRIu64
,
4112 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4116 /* For all registered applications */
4117 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4118 if (!app
->compatible
) {
4120 * TODO: In time, we should notice the caller of this error by
4121 * telling him that this is a version error.
4125 ua_sess
= lookup_session_by_app(usess
, app
);
4126 if (ua_sess
== NULL
) {
4131 /* Lookup channel in the ust app session */
4132 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4133 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4134 if (ua_chan_node
== NULL
) {
4135 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4136 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4139 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4141 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4142 uevent
->filter
, uevent
->attr
.loglevel
,
4144 if (ua_event
== NULL
) {
4145 DBG2("Event %s not found in channel %s for app pid %d."
4146 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4150 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4152 /* XXX: Report error someday... */
4163 * For a specific UST session, create the channel for all registered apps.
4165 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
4166 struct ltt_ust_channel
*uchan
)
4168 int ret
= 0, created
;
4169 struct lttng_ht_iter iter
;
4170 struct ust_app
*app
;
4171 struct ust_app_session
*ua_sess
= NULL
;
4173 /* Very wrong code flow */
4177 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
4178 uchan
->name
, usess
->id
);
4182 /* For every registered applications */
4183 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4184 if (!app
->compatible
) {
4186 * TODO: In time, we should notice the caller of this error by
4187 * telling him that this is a version error.
4191 if (!trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
4197 * Create session on the tracer side and add it to app session HT. Note
4198 * that if session exist, it will simply return a pointer to the ust
4201 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, &created
);
4206 * The application's socket is not valid. Either a bad socket
4207 * or a timeout on it. We can't inform the caller that for a
4208 * specific app, the session failed so lets continue here.
4210 ret
= 0; /* Not an error. */
4214 goto error_rcu_unlock
;
4219 pthread_mutex_lock(&ua_sess
->lock
);
4221 if (ua_sess
->deleted
) {
4222 pthread_mutex_unlock(&ua_sess
->lock
);
4226 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4227 sizeof(uchan
->name
))) {
4228 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
4231 /* Create channel onto application. We don't need the chan ref. */
4232 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
4233 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
4235 pthread_mutex_unlock(&ua_sess
->lock
);
4237 /* Cleanup the created session if it's the case. */
4239 destroy_app_session(app
, ua_sess
);
4244 * The application's socket is not valid. Either a bad socket
4245 * or a timeout on it. We can't inform the caller that for a
4246 * specific app, the session failed so lets continue here.
4248 ret
= 0; /* Not an error. */
4252 goto error_rcu_unlock
;
4263 * Enable event for a specific session and channel on the tracer.
4265 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4266 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4269 struct lttng_ht_iter iter
, uiter
;
4270 struct lttng_ht_node_str
*ua_chan_node
;
4271 struct ust_app
*app
;
4272 struct ust_app_session
*ua_sess
;
4273 struct ust_app_channel
*ua_chan
;
4274 struct ust_app_event
*ua_event
;
4276 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4277 uevent
->attr
.name
, usess
->id
);
4280 * NOTE: At this point, this function is called only if the session and
4281 * channel passed are already created for all apps. and enabled on the
4287 /* For all registered applications */
4288 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4289 if (!app
->compatible
) {
4291 * TODO: In time, we should notice the caller of this error by
4292 * telling him that this is a version error.
4296 ua_sess
= lookup_session_by_app(usess
, app
);
4298 /* The application has problem or is probably dead. */
4302 pthread_mutex_lock(&ua_sess
->lock
);
4304 if (ua_sess
->deleted
) {
4305 pthread_mutex_unlock(&ua_sess
->lock
);
4309 /* Lookup channel in the ust app session */
4310 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4311 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4313 * It is possible that the channel cannot be found is
4314 * the channel/event creation occurs concurrently with
4315 * an application exit.
4317 if (!ua_chan_node
) {
4318 pthread_mutex_unlock(&ua_sess
->lock
);
4322 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4324 /* Get event node */
4325 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4326 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4327 if (ua_event
== NULL
) {
4328 DBG3("UST app enable event %s not found for app PID %d."
4329 "Skipping app", uevent
->attr
.name
, app
->pid
);
4333 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4335 pthread_mutex_unlock(&ua_sess
->lock
);
4339 pthread_mutex_unlock(&ua_sess
->lock
);
4348 * For a specific existing UST session and UST channel, creates the event for
4349 * all registered apps.
4351 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4352 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4355 struct lttng_ht_iter iter
, uiter
;
4356 struct lttng_ht_node_str
*ua_chan_node
;
4357 struct ust_app
*app
;
4358 struct ust_app_session
*ua_sess
;
4359 struct ust_app_channel
*ua_chan
;
4361 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4362 uevent
->attr
.name
, usess
->id
);
4366 /* For all registered applications */
4367 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4368 if (!app
->compatible
) {
4370 * TODO: In time, we should notice the caller of this error by
4371 * telling him that this is a version error.
4375 ua_sess
= lookup_session_by_app(usess
, app
);
4377 /* The application has problem or is probably dead. */
4381 pthread_mutex_lock(&ua_sess
->lock
);
4383 if (ua_sess
->deleted
) {
4384 pthread_mutex_unlock(&ua_sess
->lock
);
4388 /* Lookup channel in the ust app session */
4389 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4390 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4391 /* If the channel is not found, there is a code flow error */
4392 assert(ua_chan_node
);
4394 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4396 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4397 pthread_mutex_unlock(&ua_sess
->lock
);
4399 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4400 /* Possible value at this point: -ENOMEM. If so, we stop! */
4403 DBG2("UST app event %s already exist on app PID %d",
4404 uevent
->attr
.name
, app
->pid
);
4415 * Start tracing for a specific UST session and app.
4417 * Called with UST app session lock held.
4421 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4424 struct ust_app_session
*ua_sess
;
4426 DBG("Starting tracing for ust app pid %d", app
->pid
);
4430 if (!app
->compatible
) {
4434 ua_sess
= lookup_session_by_app(usess
, app
);
4435 if (ua_sess
== NULL
) {
4436 /* The session is in teardown process. Ignore and continue. */
4440 pthread_mutex_lock(&ua_sess
->lock
);
4442 if (ua_sess
->deleted
) {
4443 pthread_mutex_unlock(&ua_sess
->lock
);
4447 /* Upon restart, we skip the setup, already done */
4448 if (ua_sess
->started
) {
4452 /* Create directories if consumer is LOCAL and has a path defined. */
4453 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
4454 usess
->consumer
->dst
.session_root_path
[0] != '\0') {
4457 tmp_path
= zmalloc(LTTNG_PATH_MAX
);
4459 ERR("Alloc tmp_path");
4462 ret
= snprintf(tmp_path
, LTTNG_PATH_MAX
, "%s%s%s",
4463 usess
->consumer
->dst
.session_root_path
,
4464 usess
->consumer
->chunk_path
,
4465 usess
->consumer
->subdir
);
4466 if (ret
>= LTTNG_PATH_MAX
) {
4467 ERR("Local destination path exceeds the maximal allowed length of %i bytes (needs %i bytes) with path = \"%s%s%s\"",
4468 LTTNG_PATH_MAX
, ret
,
4469 usess
->consumer
->dst
.session_root_path
,
4470 usess
->consumer
->chunk_path
,
4471 usess
->consumer
->subdir
);
4476 DBG("Creating directory path for local tracing: \"%s\"",
4478 ret
= run_as_mkdir_recursive(tmp_path
, S_IRWXU
| S_IRWXG
,
4479 ua_sess
->euid
, ua_sess
->egid
);
4482 if (errno
!= EEXIST
) {
4483 ERR("Trace directory creation error");
4490 * Create the metadata for the application. This returns gracefully if a
4491 * metadata was already set for the session.
4493 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4498 health_code_update();
4501 /* This start the UST tracing */
4502 pthread_mutex_lock(&app
->sock_lock
);
4503 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4504 pthread_mutex_unlock(&app
->sock_lock
);
4506 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4507 ERR("Error starting tracing for app pid: %d (ret: %d)",
4510 DBG("UST app start session failed. Application is dead.");
4512 * This is normal behavior, an application can die during the
4513 * creation process. Don't report an error so the execution can
4514 * continue normally.
4516 pthread_mutex_unlock(&ua_sess
->lock
);
4522 /* Indicate that the session has been started once */
4523 ua_sess
->started
= 1;
4525 pthread_mutex_unlock(&ua_sess
->lock
);
4527 health_code_update();
4529 /* Quiescent wait after starting trace */
4530 pthread_mutex_lock(&app
->sock_lock
);
4531 ret
= ustctl_wait_quiescent(app
->sock
);
4532 pthread_mutex_unlock(&app
->sock_lock
);
4533 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4534 ERR("UST app wait quiescent failed for app pid %d ret %d",
4540 health_code_update();
4544 pthread_mutex_unlock(&ua_sess
->lock
);
4546 health_code_update();
4551 * Stop tracing for a specific UST session and app.
4554 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4557 struct ust_app_session
*ua_sess
;
4558 struct ust_registry_session
*registry
;
4560 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4564 if (!app
->compatible
) {
4565 goto end_no_session
;
4568 ua_sess
= lookup_session_by_app(usess
, app
);
4569 if (ua_sess
== NULL
) {
4570 goto end_no_session
;
4573 pthread_mutex_lock(&ua_sess
->lock
);
4575 if (ua_sess
->deleted
) {
4576 pthread_mutex_unlock(&ua_sess
->lock
);
4577 goto end_no_session
;
4581 * If started = 0, it means that stop trace has been called for a session
4582 * that was never started. It's possible since we can have a fail start
4583 * from either the application manager thread or the command thread. Simply
4584 * indicate that this is a stop error.
4586 if (!ua_sess
->started
) {
4587 goto error_rcu_unlock
;
4590 health_code_update();
4592 /* This inhibits UST tracing */
4593 pthread_mutex_lock(&app
->sock_lock
);
4594 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4595 pthread_mutex_unlock(&app
->sock_lock
);
4597 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4598 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4601 DBG("UST app stop session failed. Application is dead.");
4603 * This is normal behavior, an application can die during the
4604 * creation process. Don't report an error so the execution can
4605 * continue normally.
4609 goto error_rcu_unlock
;
4612 health_code_update();
4614 /* Quiescent wait after stopping trace */
4615 pthread_mutex_lock(&app
->sock_lock
);
4616 ret
= ustctl_wait_quiescent(app
->sock
);
4617 pthread_mutex_unlock(&app
->sock_lock
);
4618 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4619 ERR("UST app wait quiescent failed for app pid %d ret %d",
4623 health_code_update();
4625 registry
= get_session_registry(ua_sess
);
4627 /* The UST app session is held registry shall not be null. */
4630 /* Push metadata for application before freeing the application. */
4631 (void) push_metadata(registry
, ua_sess
->consumer
);
4634 pthread_mutex_unlock(&ua_sess
->lock
);
4637 health_code_update();
4641 pthread_mutex_unlock(&ua_sess
->lock
);
4643 health_code_update();
4648 int ust_app_flush_app_session(struct ust_app
*app
,
4649 struct ust_app_session
*ua_sess
)
4651 int ret
, retval
= 0;
4652 struct lttng_ht_iter iter
;
4653 struct ust_app_channel
*ua_chan
;
4654 struct consumer_socket
*socket
;
4656 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4660 if (!app
->compatible
) {
4661 goto end_not_compatible
;
4664 pthread_mutex_lock(&ua_sess
->lock
);
4666 if (ua_sess
->deleted
) {
4670 health_code_update();
4672 /* Flushing buffers */
4673 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4676 /* Flush buffers and push metadata. */
4677 switch (ua_sess
->buffer_type
) {
4678 case LTTNG_BUFFER_PER_PID
:
4679 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4681 health_code_update();
4682 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4684 ERR("Error flushing consumer channel");
4690 case LTTNG_BUFFER_PER_UID
:
4696 health_code_update();
4699 pthread_mutex_unlock(&ua_sess
->lock
);
4703 health_code_update();
4708 * Flush buffers for all applications for a specific UST session.
4709 * Called with UST session lock held.
4712 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4717 DBG("Flushing session buffers for all ust apps");
4721 /* Flush buffers and push metadata. */
4722 switch (usess
->buffer_type
) {
4723 case LTTNG_BUFFER_PER_UID
:
4725 struct buffer_reg_uid
*reg
;
4726 struct lttng_ht_iter iter
;
4728 /* Flush all per UID buffers associated to that session. */
4729 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4730 struct ust_registry_session
*ust_session_reg
;
4731 struct buffer_reg_channel
*reg_chan
;
4732 struct consumer_socket
*socket
;
4734 /* Get consumer socket to use to push the metadata.*/
4735 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4738 /* Ignore request if no consumer is found for the session. */
4742 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4743 reg_chan
, node
.node
) {
4745 * The following call will print error values so the return
4746 * code is of little importance because whatever happens, we
4747 * have to try them all.
4749 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4752 ust_session_reg
= reg
->registry
->reg
.ust
;
4753 /* Push metadata. */
4754 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4758 case LTTNG_BUFFER_PER_PID
:
4760 struct ust_app_session
*ua_sess
;
4761 struct lttng_ht_iter iter
;
4762 struct ust_app
*app
;
4764 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4765 ua_sess
= lookup_session_by_app(usess
, app
);
4766 if (ua_sess
== NULL
) {
4769 (void) ust_app_flush_app_session(app
, ua_sess
);
4780 health_code_update();
4785 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
4786 struct ust_app_session
*ua_sess
)
4789 struct lttng_ht_iter iter
;
4790 struct ust_app_channel
*ua_chan
;
4791 struct consumer_socket
*socket
;
4793 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
4797 if (!app
->compatible
) {
4798 goto end_not_compatible
;
4801 pthread_mutex_lock(&ua_sess
->lock
);
4803 if (ua_sess
->deleted
) {
4807 health_code_update();
4809 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4812 ERR("Failed to find consumer (%" PRIu32
") socket",
4813 app
->bits_per_long
);
4818 /* Clear quiescent state. */
4819 switch (ua_sess
->buffer_type
) {
4820 case LTTNG_BUFFER_PER_PID
:
4821 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
4822 ua_chan
, node
.node
) {
4823 health_code_update();
4824 ret
= consumer_clear_quiescent_channel(socket
,
4827 ERR("Error clearing quiescent state for consumer channel");
4833 case LTTNG_BUFFER_PER_UID
:
4840 health_code_update();
4843 pthread_mutex_unlock(&ua_sess
->lock
);
4847 health_code_update();
4852 * Clear quiescent state in each stream for all applications for a
4853 * specific UST session.
4854 * Called with UST session lock held.
4857 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
4862 DBG("Clearing stream quiescent state for all ust apps");
4866 switch (usess
->buffer_type
) {
4867 case LTTNG_BUFFER_PER_UID
:
4869 struct lttng_ht_iter iter
;
4870 struct buffer_reg_uid
*reg
;
4873 * Clear quiescent for all per UID buffers associated to
4876 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4877 struct consumer_socket
*socket
;
4878 struct buffer_reg_channel
*reg_chan
;
4880 /* Get associated consumer socket.*/
4881 socket
= consumer_find_socket_by_bitness(
4882 reg
->bits_per_long
, usess
->consumer
);
4885 * Ignore request if no consumer is found for
4891 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
4892 &iter
.iter
, reg_chan
, node
.node
) {
4894 * The following call will print error values so
4895 * the return code is of little importance
4896 * because whatever happens, we have to try them
4899 (void) consumer_clear_quiescent_channel(socket
,
4900 reg_chan
->consumer_key
);
4905 case LTTNG_BUFFER_PER_PID
:
4907 struct ust_app_session
*ua_sess
;
4908 struct lttng_ht_iter iter
;
4909 struct ust_app
*app
;
4911 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
4913 ua_sess
= lookup_session_by_app(usess
, app
);
4914 if (ua_sess
== NULL
) {
4917 (void) ust_app_clear_quiescent_app_session(app
,
4929 health_code_update();
4934 * Destroy a specific UST session in apps.
4936 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4939 struct ust_app_session
*ua_sess
;
4940 struct lttng_ht_iter iter
;
4941 struct lttng_ht_node_u64
*node
;
4943 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4947 if (!app
->compatible
) {
4951 __lookup_session_by_app(usess
, app
, &iter
);
4952 node
= lttng_ht_iter_get_node_u64(&iter
);
4954 /* Session is being or is deleted. */
4957 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4959 health_code_update();
4960 destroy_app_session(app
, ua_sess
);
4962 health_code_update();
4964 /* Quiescent wait after stopping trace */
4965 pthread_mutex_lock(&app
->sock_lock
);
4966 ret
= ustctl_wait_quiescent(app
->sock
);
4967 pthread_mutex_unlock(&app
->sock_lock
);
4968 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4969 ERR("UST app wait quiescent failed for app pid %d ret %d",
4974 health_code_update();
4979 * Start tracing for the UST session.
4981 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4984 struct lttng_ht_iter iter
;
4985 struct ust_app
*app
;
4987 DBG("Starting all UST traces");
4992 * In a start-stop-start use-case, we need to clear the quiescent state
4993 * of each channel set by the prior stop command, thus ensuring that a
4994 * following stop or destroy is sure to grab a timestamp_end near those
4995 * operations, even if the packet is empty.
4997 (void) ust_app_clear_quiescent_session(usess
);
4999 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5000 ret
= ust_app_start_trace(usess
, app
);
5002 /* Continue to next apps even on error */
5013 * Start tracing for the UST session.
5014 * Called with UST session lock held.
5016 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5019 struct lttng_ht_iter iter
;
5020 struct ust_app
*app
;
5022 DBG("Stopping all UST traces");
5026 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5027 ret
= ust_app_stop_trace(usess
, app
);
5029 /* Continue to next apps even on error */
5034 (void) ust_app_flush_session(usess
);
5042 * Destroy app UST session.
5044 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5047 struct lttng_ht_iter iter
;
5048 struct ust_app
*app
;
5050 DBG("Destroy all UST traces");
5054 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5055 ret
= destroy_trace(usess
, app
);
5057 /* Continue to next apps even on error */
5068 void ust_app_global_create(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5071 struct lttng_ht_iter iter
, uiter
;
5072 struct ust_app_session
*ua_sess
= NULL
;
5073 struct ust_app_channel
*ua_chan
;
5074 struct ust_app_event
*ua_event
;
5075 struct ust_app_ctx
*ua_ctx
;
5078 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, &is_created
);
5080 /* Tracer is probably gone or ENOMEM. */
5084 /* App session already created. */
5089 pthread_mutex_lock(&ua_sess
->lock
);
5091 if (ua_sess
->deleted
) {
5092 pthread_mutex_unlock(&ua_sess
->lock
);
5097 * We can iterate safely here over all UST app session since the create ust
5098 * app session above made a shadow copy of the UST global domain from the
5101 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5103 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
5104 if (ret
< 0 && ret
!= -ENOTCONN
) {
5106 * Stop everything. On error, the application
5107 * failed, no more file descriptor are available
5108 * or ENOMEM so stopping here is the only thing
5109 * we can do for now. The only exception is
5110 * -ENOTCONN, which indicates that the application
5117 * Add context using the list so they are enabled in the same order the
5120 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
5121 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
5128 /* For each events */
5129 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
5131 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
5138 pthread_mutex_unlock(&ua_sess
->lock
);
5140 if (usess
->active
) {
5141 ret
= ust_app_start_trace(usess
, app
);
5146 DBG2("UST trace started for app pid %d", app
->pid
);
5149 /* Everything went well at this point. */
5153 pthread_mutex_unlock(&ua_sess
->lock
);
5156 destroy_app_session(app
, ua_sess
);
5162 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5164 struct ust_app_session
*ua_sess
;
5166 ua_sess
= lookup_session_by_app(usess
, app
);
5167 if (ua_sess
== NULL
) {
5170 destroy_app_session(app
, ua_sess
);
5174 * Add channels/events from UST global domain to registered apps at sock.
5176 * Called with session lock held.
5177 * Called with RCU read-side lock held.
5179 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5183 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5184 app
->sock
, usess
->id
);
5186 if (!app
->compatible
) {
5190 if (trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
5191 ust_app_global_create(usess
, app
);
5193 ust_app_global_destroy(usess
, app
);
5198 * Called with session lock held.
5200 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5202 struct lttng_ht_iter iter
;
5203 struct ust_app
*app
;
5206 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5207 ust_app_global_update(usess
, app
);
5213 * Add context to a specific channel for global UST domain.
5215 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5216 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5219 struct lttng_ht_node_str
*ua_chan_node
;
5220 struct lttng_ht_iter iter
, uiter
;
5221 struct ust_app_channel
*ua_chan
= NULL
;
5222 struct ust_app_session
*ua_sess
;
5223 struct ust_app
*app
;
5227 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5228 if (!app
->compatible
) {
5230 * TODO: In time, we should notice the caller of this error by
5231 * telling him that this is a version error.
5235 ua_sess
= lookup_session_by_app(usess
, app
);
5236 if (ua_sess
== NULL
) {
5240 pthread_mutex_lock(&ua_sess
->lock
);
5242 if (ua_sess
->deleted
) {
5243 pthread_mutex_unlock(&ua_sess
->lock
);
5247 /* Lookup channel in the ust app session */
5248 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5249 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5250 if (ua_chan_node
== NULL
) {
5253 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5255 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5260 pthread_mutex_unlock(&ua_sess
->lock
);
5268 * Enable event for a channel from a UST session for a specific PID.
5270 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
5271 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
5274 struct lttng_ht_iter iter
;
5275 struct lttng_ht_node_str
*ua_chan_node
;
5276 struct ust_app
*app
;
5277 struct ust_app_session
*ua_sess
;
5278 struct ust_app_channel
*ua_chan
;
5279 struct ust_app_event
*ua_event
;
5281 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
5285 app
= ust_app_find_by_pid(pid
);
5287 ERR("UST app enable event per PID %d not found", pid
);
5292 if (!app
->compatible
) {
5297 ua_sess
= lookup_session_by_app(usess
, app
);
5299 /* The application has problem or is probably dead. */
5304 pthread_mutex_lock(&ua_sess
->lock
);
5306 if (ua_sess
->deleted
) {
5311 /* Lookup channel in the ust app session */
5312 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
5313 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5314 /* If the channel is not found, there is a code flow error */
5315 assert(ua_chan_node
);
5317 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5319 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5320 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5321 if (ua_event
== NULL
) {
5322 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5327 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
5334 pthread_mutex_unlock(&ua_sess
->lock
);
5341 * Receive registration and populate the given msg structure.
5343 * On success return 0 else a negative value returned by the ustctl call.
5345 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5348 uint32_t pid
, ppid
, uid
, gid
;
5352 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5353 &pid
, &ppid
, &uid
, &gid
,
5354 &msg
->bits_per_long
,
5355 &msg
->uint8_t_alignment
,
5356 &msg
->uint16_t_alignment
,
5357 &msg
->uint32_t_alignment
,
5358 &msg
->uint64_t_alignment
,
5359 &msg
->long_alignment
,
5366 case LTTNG_UST_ERR_EXITING
:
5367 DBG3("UST app recv reg message failed. Application died");
5369 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5370 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5371 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5372 LTTNG_UST_ABI_MINOR_VERSION
);
5375 ERR("UST app recv reg message failed with ret %d", ret
);
5380 msg
->pid
= (pid_t
) pid
;
5381 msg
->ppid
= (pid_t
) ppid
;
5382 msg
->uid
= (uid_t
) uid
;
5383 msg
->gid
= (gid_t
) gid
;
5390 * Return a ust app session object using the application object and the
5391 * session object descriptor has a key. If not found, NULL is returned.
5392 * A RCU read side lock MUST be acquired when calling this function.
5394 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5397 struct lttng_ht_node_ulong
*node
;
5398 struct lttng_ht_iter iter
;
5399 struct ust_app_session
*ua_sess
= NULL
;
5403 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5404 node
= lttng_ht_iter_get_node_ulong(&iter
);
5406 DBG2("UST app session find by objd %d not found", objd
);
5410 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5417 * Return a ust app channel object using the application object and the channel
5418 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5419 * lock MUST be acquired before calling this function.
5421 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5424 struct lttng_ht_node_ulong
*node
;
5425 struct lttng_ht_iter iter
;
5426 struct ust_app_channel
*ua_chan
= NULL
;
5430 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5431 node
= lttng_ht_iter_get_node_ulong(&iter
);
5433 DBG2("UST app channel find by objd %d not found", objd
);
5437 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5444 * Reply to a register channel notification from an application on the notify
5445 * socket. The channel metadata is also created.
5447 * The session UST registry lock is acquired in this function.
5449 * On success 0 is returned else a negative value.
5451 static int reply_ust_register_channel(int sock
, int cobjd
,
5452 size_t nr_fields
, struct ustctl_field
*fields
)
5454 int ret
, ret_code
= 0;
5456 uint64_t chan_reg_key
;
5457 enum ustctl_channel_header type
;
5458 struct ust_app
*app
;
5459 struct ust_app_channel
*ua_chan
;
5460 struct ust_app_session
*ua_sess
;
5461 struct ust_registry_session
*registry
;
5462 struct ust_registry_channel
*chan_reg
;
5466 /* Lookup application. If not found, there is a code flow error. */
5467 app
= find_app_by_notify_sock(sock
);
5469 DBG("Application socket %d is being torn down. Abort event notify",
5472 goto error_rcu_unlock
;
5475 /* Lookup channel by UST object descriptor. */
5476 ua_chan
= find_channel_by_objd(app
, cobjd
);
5478 DBG("Application channel is being torn down. Abort event notify");
5480 goto error_rcu_unlock
;
5483 assert(ua_chan
->session
);
5484 ua_sess
= ua_chan
->session
;
5486 /* Get right session registry depending on the session buffer type. */
5487 registry
= get_session_registry(ua_sess
);
5489 DBG("Application session is being torn down. Abort event notify");
5491 goto error_rcu_unlock
;
5494 /* Depending on the buffer type, a different channel key is used. */
5495 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5496 chan_reg_key
= ua_chan
->tracing_channel_id
;
5498 chan_reg_key
= ua_chan
->key
;
5501 pthread_mutex_lock(®istry
->lock
);
5503 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5506 if (!chan_reg
->register_done
) {
5508 * TODO: eventually use the registry event count for
5509 * this channel to better guess header type for per-pid
5512 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5513 chan_reg
->nr_ctx_fields
= nr_fields
;
5514 chan_reg
->ctx_fields
= fields
;
5516 chan_reg
->header_type
= type
;
5518 /* Get current already assigned values. */
5519 type
= chan_reg
->header_type
;
5521 /* Channel id is set during the object creation. */
5522 chan_id
= chan_reg
->chan_id
;
5524 /* Append to metadata */
5525 if (!chan_reg
->metadata_dumped
) {
5526 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5528 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5534 DBG3("UST app replying to register channel key %" PRIu64
5535 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5538 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5540 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5541 ERR("UST app reply channel failed with ret %d", ret
);
5543 DBG3("UST app reply channel failed. Application died");
5548 /* This channel registry registration is completed. */
5549 chan_reg
->register_done
= 1;
5552 pthread_mutex_unlock(®istry
->lock
);
5560 * Add event to the UST channel registry. When the event is added to the
5561 * registry, the metadata is also created. Once done, this replies to the
5562 * application with the appropriate error code.
5564 * The session UST registry lock is acquired in the function.
5566 * On success 0 is returned else a negative value.
5568 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5569 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5570 int loglevel_value
, char *model_emf_uri
)
5573 uint32_t event_id
= 0;
5574 uint64_t chan_reg_key
;
5575 struct ust_app
*app
;
5576 struct ust_app_channel
*ua_chan
;
5577 struct ust_app_session
*ua_sess
;
5578 struct ust_registry_session
*registry
;
5582 /* Lookup application. If not found, there is a code flow error. */
5583 app
= find_app_by_notify_sock(sock
);
5585 DBG("Application socket %d is being torn down. Abort event notify",
5588 goto error_rcu_unlock
;
5591 /* Lookup channel by UST object descriptor. */
5592 ua_chan
= find_channel_by_objd(app
, cobjd
);
5594 DBG("Application channel is being torn down. Abort event notify");
5596 goto error_rcu_unlock
;
5599 assert(ua_chan
->session
);
5600 ua_sess
= ua_chan
->session
;
5602 registry
= get_session_registry(ua_sess
);
5604 DBG("Application session is being torn down. Abort event notify");
5606 goto error_rcu_unlock
;
5609 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5610 chan_reg_key
= ua_chan
->tracing_channel_id
;
5612 chan_reg_key
= ua_chan
->key
;
5615 pthread_mutex_lock(®istry
->lock
);
5618 * From this point on, this call acquires the ownership of the sig, fields
5619 * and model_emf_uri meaning any free are done inside it if needed. These
5620 * three variables MUST NOT be read/write after this.
5622 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5623 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5624 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5628 model_emf_uri
= NULL
;
5631 * The return value is returned to ustctl so in case of an error, the
5632 * application can be notified. In case of an error, it's important not to
5633 * return a negative error or else the application will get closed.
5635 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5637 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5638 ERR("UST app reply event failed with ret %d", ret
);
5640 DBG3("UST app reply event failed. Application died");
5643 * No need to wipe the create event since the application socket will
5644 * get close on error hence cleaning up everything by itself.
5649 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5653 pthread_mutex_unlock(®istry
->lock
);
5658 free(model_emf_uri
);
5663 * Add enum to the UST session registry. Once done, this replies to the
5664 * application with the appropriate error code.
5666 * The session UST registry lock is acquired within this function.
5668 * On success 0 is returned else a negative value.
5670 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
5671 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
5673 int ret
= 0, ret_code
;
5674 struct ust_app
*app
;
5675 struct ust_app_session
*ua_sess
;
5676 struct ust_registry_session
*registry
;
5677 uint64_t enum_id
= -1ULL;
5681 /* Lookup application. If not found, there is a code flow error. */
5682 app
= find_app_by_notify_sock(sock
);
5684 /* Return an error since this is not an error */
5685 DBG("Application socket %d is being torn down. Aborting enum registration",
5688 goto error_rcu_unlock
;
5691 /* Lookup session by UST object descriptor. */
5692 ua_sess
= find_session_by_objd(app
, sobjd
);
5694 /* Return an error since this is not an error */
5695 DBG("Application session is being torn down (session not found). Aborting enum registration.");
5697 goto error_rcu_unlock
;
5700 registry
= get_session_registry(ua_sess
);
5702 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
5704 goto error_rcu_unlock
;
5707 pthread_mutex_lock(®istry
->lock
);
5710 * From this point on, the callee acquires the ownership of
5711 * entries. The variable entries MUST NOT be read/written after
5714 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
5715 entries
, nr_entries
, &enum_id
);
5719 * The return value is returned to ustctl so in case of an error, the
5720 * application can be notified. In case of an error, it's important not to
5721 * return a negative error or else the application will get closed.
5723 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
5725 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5726 ERR("UST app reply enum failed with ret %d", ret
);
5728 DBG3("UST app reply enum failed. Application died");
5731 * No need to wipe the create enum since the application socket will
5732 * get close on error hence cleaning up everything by itself.
5737 DBG3("UST registry enum %s added successfully or already found", name
);
5740 pthread_mutex_unlock(®istry
->lock
);
5747 * Handle application notification through the given notify socket.
5749 * Return 0 on success or else a negative value.
5751 int ust_app_recv_notify(int sock
)
5754 enum ustctl_notify_cmd cmd
;
5756 DBG3("UST app receiving notify from sock %d", sock
);
5758 ret
= ustctl_recv_notify(sock
, &cmd
);
5760 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5761 ERR("UST app recv notify failed with ret %d", ret
);
5763 DBG3("UST app recv notify failed. Application died");
5769 case USTCTL_NOTIFY_CMD_EVENT
:
5771 int sobjd
, cobjd
, loglevel_value
;
5772 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5774 struct ustctl_field
*fields
;
5776 DBG2("UST app ustctl register event received");
5778 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5779 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5782 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5783 ERR("UST app recv event failed with ret %d", ret
);
5785 DBG3("UST app recv event failed. Application died");
5791 * Add event to the UST registry coming from the notify socket. This
5792 * call will free if needed the sig, fields and model_emf_uri. This
5793 * code path loses the ownsership of these variables and transfer them
5794 * to the this function.
5796 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5797 fields
, loglevel_value
, model_emf_uri
);
5804 case USTCTL_NOTIFY_CMD_CHANNEL
:
5808 struct ustctl_field
*fields
;
5810 DBG2("UST app ustctl register channel received");
5812 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5815 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5816 ERR("UST app recv channel failed with ret %d", ret
);
5818 DBG3("UST app recv channel failed. Application died");
5824 * The fields ownership are transfered to this function call meaning
5825 * that if needed it will be freed. After this, it's invalid to access
5826 * fields or clean it up.
5828 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
5836 case USTCTL_NOTIFY_CMD_ENUM
:
5839 char name
[LTTNG_UST_SYM_NAME_LEN
];
5841 struct ustctl_enum_entry
*entries
;
5843 DBG2("UST app ustctl register enum received");
5845 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
5846 &entries
, &nr_entries
);
5848 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5849 ERR("UST app recv enum failed with ret %d", ret
);
5851 DBG3("UST app recv enum failed. Application died");
5856 /* Callee assumes ownership of entries */
5857 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
5858 entries
, nr_entries
);
5866 /* Should NEVER happen. */
5875 * Once the notify socket hangs up, this is called. First, it tries to find the
5876 * corresponding application. On failure, the call_rcu to close the socket is
5877 * executed. If an application is found, it tries to delete it from the notify
5878 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5880 * Note that an object needs to be allocated here so on ENOMEM failure, the
5881 * call RCU is not done but the rest of the cleanup is.
5883 void ust_app_notify_sock_unregister(int sock
)
5886 struct lttng_ht_iter iter
;
5887 struct ust_app
*app
;
5888 struct ust_app_notify_sock_obj
*obj
;
5894 obj
= zmalloc(sizeof(*obj
));
5897 * An ENOMEM is kind of uncool. If this strikes we continue the
5898 * procedure but the call_rcu will not be called. In this case, we
5899 * accept the fd leak rather than possibly creating an unsynchronized
5900 * state between threads.
5902 * TODO: The notify object should be created once the notify socket is
5903 * registered and stored independantely from the ust app object. The
5904 * tricky part is to synchronize the teardown of the application and
5905 * this notify object. Let's keep that in mind so we can avoid this
5906 * kind of shenanigans with ENOMEM in the teardown path.
5913 DBG("UST app notify socket unregister %d", sock
);
5916 * Lookup application by notify socket. If this fails, this means that the
5917 * hash table delete has already been done by the application
5918 * unregistration process so we can safely close the notify socket in a
5921 app
= find_app_by_notify_sock(sock
);
5926 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5929 * Whatever happens here either we fail or succeed, in both cases we have
5930 * to close the socket after a grace period to continue to the call RCU
5931 * here. If the deletion is successful, the application is not visible
5932 * anymore by other threads and is it fails it means that it was already
5933 * deleted from the hash table so either way we just have to close the
5936 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5942 * Close socket after a grace period to avoid for the socket to be reused
5943 * before the application object is freed creating potential race between
5944 * threads trying to add unique in the global hash table.
5947 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5952 * Destroy a ust app data structure and free its memory.
5954 void ust_app_destroy(struct ust_app
*app
)
5960 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5964 * Take a snapshot for a given UST session. The snapshot is sent to the given
5967 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
5969 enum lttng_error_code
ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5970 struct snapshot_output
*output
, int wait
,
5971 uint64_t nb_packets_per_stream
)
5974 enum lttng_error_code status
= LTTNG_OK
;
5975 struct lttng_ht_iter iter
;
5976 struct ust_app
*app
;
5977 char pathname
[PATH_MAX
];
5978 struct ltt_session
*session
= NULL
;
5979 uint64_t trace_archive_id
;
5986 session
= session_find_by_id(usess
->id
);
5988 assert(pthread_mutex_trylock(&session
->lock
));
5989 assert(session_trylock_list());
5990 trace_archive_id
= session
->current_archive_id
;
5992 switch (usess
->buffer_type
) {
5993 case LTTNG_BUFFER_PER_UID
:
5995 struct buffer_reg_uid
*reg
;
5997 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5998 struct buffer_reg_channel
*reg_chan
;
5999 struct consumer_socket
*socket
;
6001 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6002 /* Skip since no metadata is present */
6006 /* Get consumer socket to use to push the metadata.*/
6007 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6010 status
= LTTNG_ERR_INVALID
;
6014 memset(pathname
, 0, sizeof(pathname
));
6015 ret
= snprintf(pathname
, sizeof(pathname
),
6016 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6017 reg
->uid
, reg
->bits_per_long
);
6019 PERROR("snprintf snapshot path");
6020 status
= LTTNG_ERR_INVALID
;
6024 /* Add the UST default trace dir to path. */
6025 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6026 reg_chan
, node
.node
) {
6027 status
= consumer_snapshot_channel(socket
,
6028 reg_chan
->consumer_key
,
6029 output
, 0, usess
->uid
,
6030 usess
->gid
, pathname
, wait
,
6031 nb_packets_per_stream
,
6033 if (status
!= LTTNG_OK
) {
6037 status
= consumer_snapshot_channel(socket
,
6038 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6039 usess
->uid
, usess
->gid
, pathname
, wait
, 0,
6041 if (status
!= LTTNG_OK
) {
6047 case LTTNG_BUFFER_PER_PID
:
6049 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6050 struct consumer_socket
*socket
;
6051 struct lttng_ht_iter chan_iter
;
6052 struct ust_app_channel
*ua_chan
;
6053 struct ust_app_session
*ua_sess
;
6054 struct ust_registry_session
*registry
;
6056 ua_sess
= lookup_session_by_app(usess
, app
);
6058 /* Session not associated with this app. */
6062 /* Get the right consumer socket for the application. */
6063 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6066 status
= LTTNG_ERR_INVALID
;
6070 /* Add the UST default trace dir to path. */
6071 memset(pathname
, 0, sizeof(pathname
));
6072 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6075 status
= LTTNG_ERR_INVALID
;
6076 PERROR("snprintf snapshot path");
6080 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6081 ua_chan
, node
.node
) {
6082 status
= consumer_snapshot_channel(socket
,
6083 ua_chan
->key
, output
,
6084 0, ua_sess
->euid
, ua_sess
->egid
,
6086 nb_packets_per_stream
,
6091 case LTTNG_ERR_CHAN_NOT_FOUND
:
6098 registry
= get_session_registry(ua_sess
);
6100 DBG("Application session is being torn down. Skip application.");
6103 status
= consumer_snapshot_channel(socket
,
6104 registry
->metadata_key
, output
,
6105 1, ua_sess
->euid
, ua_sess
->egid
,
6111 case LTTNG_ERR_CHAN_NOT_FOUND
:
6127 session_put(session
);
6133 * Return the size taken by one more packet per stream.
6135 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
6136 uint64_t cur_nr_packets
)
6138 uint64_t tot_size
= 0;
6139 struct ust_app
*app
;
6140 struct lttng_ht_iter iter
;
6144 switch (usess
->buffer_type
) {
6145 case LTTNG_BUFFER_PER_UID
:
6147 struct buffer_reg_uid
*reg
;
6149 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6150 struct buffer_reg_channel
*reg_chan
;
6153 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6154 reg_chan
, node
.node
) {
6155 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6157 * Don't take channel into account if we
6158 * already grab all its packets.
6162 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6168 case LTTNG_BUFFER_PER_PID
:
6171 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6172 struct ust_app_channel
*ua_chan
;
6173 struct ust_app_session
*ua_sess
;
6174 struct lttng_ht_iter chan_iter
;
6176 ua_sess
= lookup_session_by_app(usess
, app
);
6178 /* Session not associated with this app. */
6182 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6183 ua_chan
, node
.node
) {
6184 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6186 * Don't take channel into account if we
6187 * already grab all its packets.
6191 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6205 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6206 struct cds_list_head
*buffer_reg_uid_list
,
6207 struct consumer_output
*consumer
, uint64_t uchan_id
,
6208 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6211 uint64_t consumer_chan_key
;
6216 ret
= buffer_reg_uid_consumer_channel_key(
6217 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6225 ret
= consumer_get_lost_packets(ust_session_id
,
6226 consumer_chan_key
, consumer
, lost
);
6228 ret
= consumer_get_discarded_events(ust_session_id
,
6229 consumer_chan_key
, consumer
, discarded
);
6236 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6237 struct ltt_ust_channel
*uchan
,
6238 struct consumer_output
*consumer
, int overwrite
,
6239 uint64_t *discarded
, uint64_t *lost
)
6242 struct lttng_ht_iter iter
;
6243 struct lttng_ht_node_str
*ua_chan_node
;
6244 struct ust_app
*app
;
6245 struct ust_app_session
*ua_sess
;
6246 struct ust_app_channel
*ua_chan
;
6253 * Iterate over every registered applications. Sum counters for
6254 * all applications containing requested session and channel.
6256 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6257 struct lttng_ht_iter uiter
;
6259 ua_sess
= lookup_session_by_app(usess
, app
);
6260 if (ua_sess
== NULL
) {
6265 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6266 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6267 /* If the session is found for the app, the channel must be there */
6268 assert(ua_chan_node
);
6270 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6275 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6282 uint64_t _discarded
;
6284 ret
= consumer_get_discarded_events(usess
->id
,
6285 ua_chan
->key
, consumer
, &_discarded
);
6289 (*discarded
) += _discarded
;
6298 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6299 struct ust_app
*app
)
6302 struct ust_app_session
*ua_sess
;
6304 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6308 ua_sess
= lookup_session_by_app(usess
, app
);
6309 if (ua_sess
== NULL
) {
6310 /* The session is in teardown process. Ignore and continue. */
6314 pthread_mutex_lock(&ua_sess
->lock
);
6316 if (ua_sess
->deleted
) {
6320 pthread_mutex_lock(&app
->sock_lock
);
6321 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6322 pthread_mutex_unlock(&app
->sock_lock
);
6325 pthread_mutex_unlock(&ua_sess
->lock
);
6329 health_code_update();
6334 * Regenerate the statedump for each app in the session.
6336 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6339 struct lttng_ht_iter iter
;
6340 struct ust_app
*app
;
6342 DBG("Regenerating the metadata for all UST apps");
6346 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6347 if (!app
->compatible
) {
6351 ret
= ust_app_regenerate_statedump(usess
, app
);
6353 /* Continue to the next app even on error */
6364 * Rotate all the channels of a session.
6366 * Return LTTNG_OK on success or else an LTTng error code.
6368 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6371 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6372 struct lttng_ht_iter iter
;
6373 struct ust_app
*app
;
6374 struct ltt_ust_session
*usess
= session
->ust_session
;
6375 char pathname
[LTTNG_PATH_MAX
];
6381 switch (usess
->buffer_type
) {
6382 case LTTNG_BUFFER_PER_UID
:
6384 struct buffer_reg_uid
*reg
;
6386 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6387 struct buffer_reg_channel
*reg_chan
;
6388 struct consumer_socket
*socket
;
6390 /* Get consumer socket to use to push the metadata.*/
6391 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6394 cmd_ret
= LTTNG_ERR_INVALID
;
6398 ret
= snprintf(pathname
, sizeof(pathname
),
6399 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6400 reg
->uid
, reg
->bits_per_long
);
6401 if (ret
< 0 || ret
== sizeof(pathname
)) {
6402 PERROR("Failed to format rotation path");
6403 cmd_ret
= LTTNG_ERR_INVALID
;
6407 /* Rotate the data channels. */
6408 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6409 reg_chan
, node
.node
) {
6410 ret
= consumer_rotate_channel(socket
,
6411 reg_chan
->consumer_key
,
6412 usess
->uid
, usess
->gid
,
6413 usess
->consumer
, pathname
,
6414 /* is_metadata_channel */ false,
6415 session
->current_archive_id
);
6417 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6422 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6424 ret
= consumer_rotate_channel(socket
,
6425 reg
->registry
->reg
.ust
->metadata_key
,
6426 usess
->uid
, usess
->gid
,
6427 usess
->consumer
, pathname
,
6428 /* is_metadata_channel */ true,
6429 session
->current_archive_id
);
6431 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6437 case LTTNG_BUFFER_PER_PID
:
6439 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6440 struct consumer_socket
*socket
;
6441 struct lttng_ht_iter chan_iter
;
6442 struct ust_app_channel
*ua_chan
;
6443 struct ust_app_session
*ua_sess
;
6444 struct ust_registry_session
*registry
;
6446 ua_sess
= lookup_session_by_app(usess
, app
);
6448 /* Session not associated with this app. */
6451 ret
= snprintf(pathname
, sizeof(pathname
),
6452 DEFAULT_UST_TRACE_DIR
"/%s",
6454 if (ret
< 0 || ret
== sizeof(pathname
)) {
6455 PERROR("Failed to format rotation path");
6456 cmd_ret
= LTTNG_ERR_INVALID
;
6460 /* Get the right consumer socket for the application. */
6461 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6464 cmd_ret
= LTTNG_ERR_INVALID
;
6468 registry
= get_session_registry(ua_sess
);
6470 DBG("Application session is being torn down. Skip application.");
6475 /* Rotate the data channels. */
6476 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6477 ua_chan
, node
.node
) {
6478 ret
= consumer_rotate_channel(socket
, ua_chan
->key
,
6479 ua_sess
->euid
, ua_sess
->egid
,
6480 ua_sess
->consumer
, pathname
,
6481 /* is_metadata_channel */ false,
6482 session
->current_archive_id
);
6484 /* Per-PID buffer and application going away. */
6485 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6487 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6492 /* Rotate the metadata channel. */
6493 (void) push_metadata(registry
, usess
->consumer
);
6494 ret
= consumer_rotate_channel(socket
, registry
->metadata_key
,
6495 ua_sess
->euid
, ua_sess
->egid
,
6496 ua_sess
->consumer
, pathname
,
6497 /* is_metadata_channel */ true,
6498 session
->current_archive_id
);
6500 /* Per-PID buffer and application going away. */
6501 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6503 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;