2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
44 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
46 /* Next available channel key. Access under next_channel_key_lock. */
47 static uint64_t _next_channel_key
;
48 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
50 /* Next available session ID. Access under next_session_id_lock. */
51 static uint64_t _next_session_id
;
52 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
55 * Return the incremented value of next_channel_key.
57 static uint64_t get_next_channel_key(void)
61 pthread_mutex_lock(&next_channel_key_lock
);
62 ret
= ++_next_channel_key
;
63 pthread_mutex_unlock(&next_channel_key_lock
);
68 * Return the atomically incremented value of next_session_id.
70 static uint64_t get_next_session_id(void)
74 pthread_mutex_lock(&next_session_id_lock
);
75 ret
= ++_next_session_id
;
76 pthread_mutex_unlock(&next_session_id_lock
);
80 static void copy_channel_attr_to_ustctl(
81 struct ustctl_consumer_channel_attr
*attr
,
82 struct lttng_ust_channel_attr
*uattr
)
84 /* Copy event attributes since the layout is different. */
85 attr
->subbuf_size
= uattr
->subbuf_size
;
86 attr
->num_subbuf
= uattr
->num_subbuf
;
87 attr
->overwrite
= uattr
->overwrite
;
88 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
89 attr
->read_timer_interval
= uattr
->read_timer_interval
;
90 attr
->output
= uattr
->output
;
94 * Match function for the hash table lookup.
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
99 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
101 struct ust_app_event
*event
;
102 const struct ust_app_ht_key
*key
;
107 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
110 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
113 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
117 /* Event loglevel. */
118 if (event
->attr
.loglevel
!= key
->loglevel
) {
119 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
120 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
122 * Match is accepted. This is because on event creation, the
123 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
124 * -1 are accepted for this loglevel type since 0 is the one set by
125 * the API when receiving an enable event.
132 /* One of the filters is NULL, fail. */
133 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
137 if (key
->filter
&& event
->filter
) {
138 /* Both filters exists, check length followed by the bytecode. */
139 if (event
->filter
->len
!= key
->filter
->len
||
140 memcmp(event
->filter
->data
, key
->filter
->data
,
141 event
->filter
->len
) != 0) {
146 /* One of the exclusions is NULL, fail. */
147 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
151 if (key
->exclusion
&& event
->exclusion
) {
152 /* Both exclusions exists, check count followed by the names. */
153 if (event
->exclusion
->count
!= key
->exclusion
->count
||
154 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
155 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
169 * Unique add of an ust app event in the given ht. This uses the custom
170 * ht_match_ust_app_event match function and the event name as hash.
172 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
173 struct ust_app_event
*event
)
175 struct cds_lfht_node
*node_ptr
;
176 struct ust_app_ht_key key
;
180 assert(ua_chan
->events
);
183 ht
= ua_chan
->events
;
184 key
.name
= event
->attr
.name
;
185 key
.filter
= event
->filter
;
186 key
.loglevel
= event
->attr
.loglevel
;
187 key
.exclusion
= event
->exclusion
;
189 node_ptr
= cds_lfht_add_unique(ht
->ht
,
190 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
191 ht_match_ust_app_event
, &key
, &event
->node
.node
);
192 assert(node_ptr
== &event
->node
.node
);
196 * Close the notify socket from the given RCU head object. This MUST be called
197 * through a call_rcu().
199 static void close_notify_sock_rcu(struct rcu_head
*head
)
202 struct ust_app_notify_sock_obj
*obj
=
203 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
205 /* Must have a valid fd here. */
206 assert(obj
->fd
>= 0);
208 ret
= close(obj
->fd
);
210 ERR("close notify sock %d RCU", obj
->fd
);
212 lttng_fd_put(LTTNG_FD_APPS
, 1);
218 * Return the session registry according to the buffer type of the given
221 * A registry per UID object MUST exists before calling this function or else
222 * it assert() if not found. RCU read side lock must be acquired.
224 static struct ust_registry_session
*get_session_registry(
225 struct ust_app_session
*ua_sess
)
227 struct ust_registry_session
*registry
= NULL
;
231 switch (ua_sess
->buffer_type
) {
232 case LTTNG_BUFFER_PER_PID
:
234 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
238 registry
= reg_pid
->registry
->reg
.ust
;
241 case LTTNG_BUFFER_PER_UID
:
243 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
244 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
248 registry
= reg_uid
->registry
->reg
.ust
;
260 * Delete ust context safely. RCU read lock must be held before calling
264 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
271 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
272 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
273 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
274 sock
, ua_ctx
->obj
->handle
, ret
);
282 * Delete ust app event safely. RCU read lock must be held before calling
286 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
292 free(ua_event
->filter
);
293 if (ua_event
->exclusion
!= NULL
)
294 free(ua_event
->exclusion
);
295 if (ua_event
->obj
!= NULL
) {
296 ret
= ustctl_release_object(sock
, ua_event
->obj
);
297 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
298 ERR("UST app sock %d release event obj failed with ret %d",
307 * Release ust data object of the given stream.
309 * Return 0 on success or else a negative value.
311 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
318 ret
= ustctl_release_object(sock
, stream
->obj
);
319 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
320 ERR("UST app sock %d release stream obj failed with ret %d",
323 lttng_fd_put(LTTNG_FD_APPS
, 2);
331 * Delete ust app stream safely. RCU read lock must be held before calling
335 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
339 (void) release_ust_app_stream(sock
, stream
);
344 * We need to execute ht_destroy outside of RCU read-side critical
345 * section and outside of call_rcu thread, so we postpone its execution
346 * using ht_cleanup_push. It is simpler than to change the semantic of
347 * the many callers of delete_ust_app_session().
350 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
352 struct ust_app_channel
*ua_chan
=
353 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
355 ht_cleanup_push(ua_chan
->ctx
);
356 ht_cleanup_push(ua_chan
->events
);
361 * Delete ust app channel safely. RCU read lock must be held before calling
365 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
369 struct lttng_ht_iter iter
;
370 struct ust_app_event
*ua_event
;
371 struct ust_app_ctx
*ua_ctx
;
372 struct ust_app_stream
*stream
, *stmp
;
373 struct ust_registry_session
*registry
;
377 DBG3("UST app deleting channel %s", ua_chan
->name
);
380 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
381 cds_list_del(&stream
->list
);
382 delete_ust_app_stream(sock
, stream
);
386 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
387 cds_list_del(&ua_ctx
->list
);
388 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
390 delete_ust_app_ctx(sock
, ua_ctx
);
394 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
396 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
398 delete_ust_app_event(sock
, ua_event
);
401 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
402 /* Wipe and free registry from session registry. */
403 registry
= get_session_registry(ua_chan
->session
);
405 ust_registry_channel_del_free(registry
, ua_chan
->key
);
409 if (ua_chan
->obj
!= NULL
) {
410 /* Remove channel from application UST object descriptor. */
411 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
412 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
414 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
415 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
416 ERR("UST app sock %d release channel obj failed with ret %d",
419 lttng_fd_put(LTTNG_FD_APPS
, 1);
422 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
426 * Push metadata to consumer socket.
428 * RCU read-side lock must be held to guarantee existance of socket.
429 * Must be called with the ust app session lock held.
430 * Must be called with the registry lock held.
432 * On success, return the len of metadata pushed or else a negative value.
433 * Returning a -EPIPE return value means we could not send the metadata,
434 * but it can be caused by recoverable errors (e.g. the application has
435 * terminated concurrently).
437 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
438 struct consumer_socket
*socket
, int send_zero_data
)
441 char *metadata_str
= NULL
;
449 * Means that no metadata was assigned to the session. This can
450 * happens if no start has been done previously.
452 if (!registry
->metadata_key
) {
457 * On a push metadata error either the consumer is dead or the
458 * metadata channel has been destroyed because its endpoint
459 * might have died (e.g: relayd), or because the application has
460 * exited. If so, the metadata closed flag is set to 1 so we
461 * deny pushing metadata again which is not valid anymore on the
464 if (registry
->metadata_closed
) {
468 offset
= registry
->metadata_len_sent
;
469 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
471 DBG3("No metadata to push for metadata key %" PRIu64
,
472 registry
->metadata_key
);
474 if (send_zero_data
) {
475 DBG("No metadata to push");
481 /* Allocate only what we have to send. */
482 metadata_str
= zmalloc(len
);
484 PERROR("zmalloc ust app metadata string");
488 /* Copy what we haven't send out. */
489 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
490 registry
->metadata_len_sent
+= len
;
493 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
494 metadata_str
, len
, offset
);
497 * There is an acceptable race here between the registry
498 * metadata key assignment and the creation on the
499 * consumer. The session daemon can concurrently push
500 * metadata for this registry while being created on the
501 * consumer since the metadata key of the registry is
502 * assigned *before* it is setup to avoid the consumer
503 * to ask for metadata that could possibly be not found
504 * in the session daemon.
506 * The metadata will get pushed either by the session
507 * being stopped or the consumer requesting metadata if
508 * that race is triggered.
510 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
515 * Update back the actual metadata len sent since it
518 registry
->metadata_len_sent
-= len
;
530 * On error, flag the registry that the metadata is
531 * closed. We were unable to push anything and this
532 * means that either the consumer is not responding or
533 * the metadata cache has been destroyed on the
536 registry
->metadata_closed
= 1;
544 * For a given application and session, push metadata to consumer.
545 * Either sock or consumer is required : if sock is NULL, the default
546 * socket to send the metadata is retrieved from consumer, if sock
547 * is not NULL we use it to send the metadata.
548 * RCU read-side lock must be held while calling this function,
549 * therefore ensuring existance of registry. It also ensures existance
550 * of socket throughout this function.
552 * Return 0 on success else a negative error.
553 * Returning a -EPIPE return value means we could not send the metadata,
554 * but it can be caused by recoverable errors (e.g. the application has
555 * terminated concurrently).
557 static int push_metadata(struct ust_registry_session
*registry
,
558 struct consumer_output
*consumer
)
562 struct consumer_socket
*socket
;
567 pthread_mutex_lock(®istry
->lock
);
568 if (registry
->metadata_closed
) {
573 /* Get consumer socket to use to push the metadata.*/
574 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
581 ret
= ust_app_push_metadata(registry
, socket
, 0);
586 pthread_mutex_unlock(®istry
->lock
);
590 pthread_mutex_unlock(®istry
->lock
);
595 * Send to the consumer a close metadata command for the given session. Once
596 * done, the metadata channel is deleted and the session metadata pointer is
597 * nullified. The session lock MUST be held unless the application is
598 * in the destroy path.
600 * Return 0 on success else a negative value.
602 static int close_metadata(struct ust_registry_session
*registry
,
603 struct consumer_output
*consumer
)
606 struct consumer_socket
*socket
;
613 pthread_mutex_lock(®istry
->lock
);
615 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
620 /* Get consumer socket to use to push the metadata.*/
621 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
628 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
635 * Metadata closed. Even on error this means that the consumer is not
636 * responding or not found so either way a second close should NOT be emit
639 registry
->metadata_closed
= 1;
641 pthread_mutex_unlock(®istry
->lock
);
647 * We need to execute ht_destroy outside of RCU read-side critical
648 * section and outside of call_rcu thread, so we postpone its execution
649 * using ht_cleanup_push. It is simpler than to change the semantic of
650 * the many callers of delete_ust_app_session().
653 void delete_ust_app_session_rcu(struct rcu_head
*head
)
655 struct ust_app_session
*ua_sess
=
656 caa_container_of(head
, struct ust_app_session
, rcu_head
);
658 ht_cleanup_push(ua_sess
->channels
);
663 * Delete ust app session safely. RCU read lock must be held before calling
667 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
671 struct lttng_ht_iter iter
;
672 struct ust_app_channel
*ua_chan
;
673 struct ust_registry_session
*registry
;
677 pthread_mutex_lock(&ua_sess
->lock
);
679 assert(!ua_sess
->deleted
);
680 ua_sess
->deleted
= true;
682 registry
= get_session_registry(ua_sess
);
684 /* Push metadata for application before freeing the application. */
685 (void) push_metadata(registry
, ua_sess
->consumer
);
688 * Don't ask to close metadata for global per UID buffers. Close
689 * metadata only on destroy trace session in this case. Also, the
690 * previous push metadata could have flag the metadata registry to
691 * close so don't send a close command if closed.
693 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
694 /* And ask to close it for this session registry. */
695 (void) close_metadata(registry
, ua_sess
->consumer
);
699 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
701 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
703 delete_ust_app_channel(sock
, ua_chan
, app
);
706 /* In case of per PID, the registry is kept in the session. */
707 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
708 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
710 buffer_reg_pid_remove(reg_pid
);
711 buffer_reg_pid_destroy(reg_pid
);
715 if (ua_sess
->handle
!= -1) {
716 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
717 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
718 ERR("UST app sock %d release session handle failed with ret %d",
722 pthread_mutex_unlock(&ua_sess
->lock
);
724 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
728 * Delete a traceable application structure from the global list. Never call
729 * this function outside of a call_rcu call.
731 * RCU read side lock should _NOT_ be held when calling this function.
734 void delete_ust_app(struct ust_app
*app
)
737 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
739 /* Delete ust app sessions info */
744 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
746 /* Free every object in the session and the session. */
748 delete_ust_app_session(sock
, ua_sess
, app
);
752 ht_cleanup_push(app
->sessions
);
753 ht_cleanup_push(app
->ust_objd
);
756 * Wait until we have deleted the application from the sock hash table
757 * before closing this socket, otherwise an application could re-use the
758 * socket ID and race with the teardown, using the same hash table entry.
760 * It's OK to leave the close in call_rcu. We want it to stay unique for
761 * all RCU readers that could run concurrently with unregister app,
762 * therefore we _need_ to only close that socket after a grace period. So
763 * it should stay in this RCU callback.
765 * This close() is a very important step of the synchronization model so
766 * every modification to this function must be carefully reviewed.
772 lttng_fd_put(LTTNG_FD_APPS
, 1);
774 DBG2("UST app pid %d deleted", app
->pid
);
779 * URCU intermediate call to delete an UST app.
782 void delete_ust_app_rcu(struct rcu_head
*head
)
784 struct lttng_ht_node_ulong
*node
=
785 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
786 struct ust_app
*app
=
787 caa_container_of(node
, struct ust_app
, pid_n
);
789 DBG3("Call RCU deleting app PID %d", app
->pid
);
794 * Delete the session from the application ht and delete the data structure by
795 * freeing every object inside and releasing them.
797 static void destroy_app_session(struct ust_app
*app
,
798 struct ust_app_session
*ua_sess
)
801 struct lttng_ht_iter iter
;
806 iter
.iter
.node
= &ua_sess
->node
.node
;
807 ret
= lttng_ht_del(app
->sessions
, &iter
);
809 /* Already scheduled for teardown. */
813 /* Once deleted, free the data structure. */
814 delete_ust_app_session(app
->sock
, ua_sess
, app
);
821 * Alloc new UST app session.
824 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
826 struct ust_app_session
*ua_sess
;
828 /* Init most of the default value by allocating and zeroing */
829 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
830 if (ua_sess
== NULL
) {
835 ua_sess
->handle
= -1;
836 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
837 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
838 pthread_mutex_init(&ua_sess
->lock
, NULL
);
847 * Alloc new UST app channel.
850 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
851 struct ust_app_session
*ua_sess
,
852 struct lttng_ust_channel_attr
*attr
)
854 struct ust_app_channel
*ua_chan
;
856 /* Init most of the default value by allocating and zeroing */
857 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
858 if (ua_chan
== NULL
) {
863 /* Setup channel name */
864 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
865 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
867 ua_chan
->enabled
= 1;
868 ua_chan
->handle
= -1;
869 ua_chan
->session
= ua_sess
;
870 ua_chan
->key
= get_next_channel_key();
871 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
872 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
873 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
875 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
876 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
878 /* Copy attributes */
880 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
881 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
882 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
883 ua_chan
->attr
.overwrite
= attr
->overwrite
;
884 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
885 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
886 ua_chan
->attr
.output
= attr
->output
;
888 /* By default, the channel is a per cpu channel. */
889 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
891 DBG3("UST app channel %s allocated", ua_chan
->name
);
900 * Allocate and initialize a UST app stream.
902 * Return newly allocated stream pointer or NULL on error.
904 struct ust_app_stream
*ust_app_alloc_stream(void)
906 struct ust_app_stream
*stream
= NULL
;
908 stream
= zmalloc(sizeof(*stream
));
909 if (stream
== NULL
) {
910 PERROR("zmalloc ust app stream");
914 /* Zero could be a valid value for a handle so flag it to -1. */
922 * Alloc new UST app event.
925 struct ust_app_event
*alloc_ust_app_event(char *name
,
926 struct lttng_ust_event
*attr
)
928 struct ust_app_event
*ua_event
;
930 /* Init most of the default value by allocating and zeroing */
931 ua_event
= zmalloc(sizeof(struct ust_app_event
));
932 if (ua_event
== NULL
) {
937 ua_event
->enabled
= 1;
938 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
939 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
940 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
942 /* Copy attributes */
944 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
947 DBG3("UST app event %s allocated", ua_event
->name
);
956 * Alloc new UST app context.
959 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
961 struct ust_app_ctx
*ua_ctx
;
963 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
964 if (ua_ctx
== NULL
) {
968 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
971 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
974 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
981 * Allocate a filter and copy the given original filter.
983 * Return allocated filter or NULL on error.
985 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
986 struct lttng_ust_filter_bytecode
*orig_f
)
988 struct lttng_ust_filter_bytecode
*filter
= NULL
;
990 /* Copy filter bytecode */
991 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
993 PERROR("zmalloc alloc ust app filter");
997 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1004 * Find an ust_app using the sock and return it. RCU read side lock must be
1005 * held before calling this helper function.
1007 struct ust_app
*ust_app_find_by_sock(int sock
)
1009 struct lttng_ht_node_ulong
*node
;
1010 struct lttng_ht_iter iter
;
1012 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1013 node
= lttng_ht_iter_get_node_ulong(&iter
);
1015 DBG2("UST app find by sock %d not found", sock
);
1019 return caa_container_of(node
, struct ust_app
, sock_n
);
1026 * Find an ust_app using the notify sock and return it. RCU read side lock must
1027 * be held before calling this helper function.
1029 static struct ust_app
*find_app_by_notify_sock(int sock
)
1031 struct lttng_ht_node_ulong
*node
;
1032 struct lttng_ht_iter iter
;
1034 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1036 node
= lttng_ht_iter_get_node_ulong(&iter
);
1038 DBG2("UST app find by notify sock %d not found", sock
);
1042 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1049 * Lookup for an ust app event based on event name, filter bytecode and the
1052 * Return an ust_app_event object or NULL on error.
1054 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1055 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1056 const struct lttng_event_exclusion
*exclusion
)
1058 struct lttng_ht_iter iter
;
1059 struct lttng_ht_node_str
*node
;
1060 struct ust_app_event
*event
= NULL
;
1061 struct ust_app_ht_key key
;
1066 /* Setup key for event lookup. */
1068 key
.filter
= filter
;
1069 key
.loglevel
= loglevel
;
1070 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1071 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1073 /* Lookup using the event name as hash and a custom match fct. */
1074 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1075 ht_match_ust_app_event
, &key
, &iter
.iter
);
1076 node
= lttng_ht_iter_get_node_str(&iter
);
1081 event
= caa_container_of(node
, struct ust_app_event
, node
);
1088 * Create the channel context on the tracer.
1090 * Called with UST app session lock held.
1093 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1094 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1098 health_code_update();
1100 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1101 ua_chan
->obj
, &ua_ctx
->obj
);
1103 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1104 ERR("UST app create channel context failed for app (pid: %d) "
1105 "with ret %d", app
->pid
, ret
);
1108 * This is normal behavior, an application can die during the
1109 * creation process. Don't report an error so the execution can
1110 * continue normally.
1113 DBG3("UST app disable event failed. Application is dead.");
1118 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1120 DBG2("UST app context handle %d created successfully for channel %s",
1121 ua_ctx
->handle
, ua_chan
->name
);
1124 health_code_update();
1129 * Set the filter on the tracer.
1132 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1133 struct ust_app
*app
)
1137 health_code_update();
1139 if (!ua_event
->filter
) {
1144 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1147 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1148 ERR("UST app event %s filter failed for app (pid: %d) "
1149 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1152 * This is normal behavior, an application can die during the
1153 * creation process. Don't report an error so the execution can
1154 * continue normally.
1157 DBG3("UST app filter event failed. Application is dead.");
1162 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1165 health_code_update();
1170 * Set event exclusions on the tracer.
1173 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1174 struct ust_app
*app
)
1178 health_code_update();
1180 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1185 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1188 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1189 ERR("UST app event %s exclusions failed for app (pid: %d) "
1190 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1193 * This is normal behavior, an application can die during the
1194 * creation process. Don't report an error so the execution can
1195 * continue normally.
1198 DBG3("UST app event exclusion failed. Application is dead.");
1203 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1206 health_code_update();
1211 * Disable the specified event on to UST tracer for the UST session.
1213 static int disable_ust_event(struct ust_app
*app
,
1214 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1218 health_code_update();
1220 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1222 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1223 ERR("UST app event %s disable failed for app (pid: %d) "
1224 "and session handle %d with ret %d",
1225 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1228 * This is normal behavior, an application can die during the
1229 * creation process. Don't report an error so the execution can
1230 * continue normally.
1233 DBG3("UST app disable event failed. Application is dead.");
1238 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1239 ua_event
->attr
.name
, app
->pid
);
1242 health_code_update();
1247 * Disable the specified channel on to UST tracer for the UST session.
1249 static int disable_ust_channel(struct ust_app
*app
,
1250 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1254 health_code_update();
1256 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1258 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1259 ERR("UST app channel %s disable failed for app (pid: %d) "
1260 "and session handle %d with ret %d",
1261 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1264 * This is normal behavior, an application can die during the
1265 * creation process. Don't report an error so the execution can
1266 * continue normally.
1269 DBG3("UST app disable channel failed. Application is dead.");
1274 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1275 ua_chan
->name
, app
->pid
);
1278 health_code_update();
1283 * Enable the specified channel on to UST tracer for the UST session.
1285 static int enable_ust_channel(struct ust_app
*app
,
1286 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1290 health_code_update();
1292 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1294 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1295 ERR("UST app channel %s enable failed for app (pid: %d) "
1296 "and session handle %d with ret %d",
1297 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1300 * This is normal behavior, an application can die during the
1301 * creation process. Don't report an error so the execution can
1302 * continue normally.
1305 DBG3("UST app enable channel failed. Application is dead.");
1310 ua_chan
->enabled
= 1;
1312 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1313 ua_chan
->name
, app
->pid
);
1316 health_code_update();
1321 * Enable the specified event on to UST tracer for the UST session.
1323 static int enable_ust_event(struct ust_app
*app
,
1324 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1328 health_code_update();
1330 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1332 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1333 ERR("UST app event %s enable failed for app (pid: %d) "
1334 "and session handle %d with ret %d",
1335 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1338 * This is normal behavior, an application can die during the
1339 * creation process. Don't report an error so the execution can
1340 * continue normally.
1343 DBG3("UST app enable event failed. Application is dead.");
1348 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1349 ua_event
->attr
.name
, app
->pid
);
1352 health_code_update();
1357 * Send channel and stream buffer to application.
1359 * Return 0 on success. On error, a negative value is returned.
1361 static int send_channel_pid_to_ust(struct ust_app
*app
,
1362 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1365 struct ust_app_stream
*stream
, *stmp
;
1371 health_code_update();
1373 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1376 /* Send channel to the application. */
1377 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1378 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1379 ret
= -ENOTCONN
; /* Caused by app exiting. */
1381 } else if (ret
< 0) {
1385 health_code_update();
1387 /* Send all streams to application. */
1388 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1389 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1390 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1391 ret
= -ENOTCONN
; /* Caused by app exiting. */
1393 } else if (ret
< 0) {
1396 /* We don't need the stream anymore once sent to the tracer. */
1397 cds_list_del(&stream
->list
);
1398 delete_ust_app_stream(-1, stream
);
1400 /* Flag the channel that it is sent to the application. */
1401 ua_chan
->is_sent
= 1;
1404 health_code_update();
1409 * Create the specified event onto the UST tracer for a UST session.
1411 * Should be called with session mutex held.
1414 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1415 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1419 health_code_update();
1421 /* Create UST event on tracer */
1422 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1425 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1426 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1427 ua_event
->attr
.name
, app
->pid
, ret
);
1430 * This is normal behavior, an application can die during the
1431 * creation process. Don't report an error so the execution can
1432 * continue normally.
1435 DBG3("UST app create event failed. Application is dead.");
1440 ua_event
->handle
= ua_event
->obj
->handle
;
1442 DBG2("UST app event %s created successfully for pid:%d",
1443 ua_event
->attr
.name
, app
->pid
);
1445 health_code_update();
1447 /* Set filter if one is present. */
1448 if (ua_event
->filter
) {
1449 ret
= set_ust_event_filter(ua_event
, app
);
1455 /* Set exclusions for the event */
1456 if (ua_event
->exclusion
) {
1457 ret
= set_ust_event_exclusion(ua_event
, app
);
1463 /* If event not enabled, disable it on the tracer */
1464 if (ua_event
->enabled
) {
1466 * We now need to explicitly enable the event, since it
1467 * is now disabled at creation.
1469 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1472 * If we hit an EPERM, something is wrong with our enable call. If
1473 * we get an EEXIST, there is a problem on the tracer side since we
1477 case -LTTNG_UST_ERR_PERM
:
1478 /* Code flow problem */
1480 case -LTTNG_UST_ERR_EXIST
:
1481 /* It's OK for our use case. */
1490 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1493 * If we hit an EPERM, something is wrong with our disable call. If
1494 * we get an EEXIST, there is a problem on the tracer side since we
1498 case -LTTNG_UST_ERR_PERM
:
1499 /* Code flow problem */
1501 case -LTTNG_UST_ERR_EXIST
:
1502 /* It's OK for our use case. */
1513 health_code_update();
1518 * Copy data between an UST app event and a LTT event.
1520 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1521 struct ltt_ust_event
*uevent
)
1523 size_t exclusion_alloc_size
;
1525 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1526 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1528 ua_event
->enabled
= uevent
->enabled
;
1530 /* Copy event attributes */
1531 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1533 /* Copy filter bytecode */
1534 if (uevent
->filter
) {
1535 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1536 /* Filter might be NULL here in case of ENONEM. */
1539 /* Copy exclusion data */
1540 if (uevent
->exclusion
) {
1541 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1542 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1543 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1544 if (ua_event
->exclusion
== NULL
) {
1547 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1548 exclusion_alloc_size
);
1554 * Copy data between an UST app channel and a LTT channel.
1556 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1557 struct ltt_ust_channel
*uchan
)
1559 struct lttng_ht_iter iter
;
1560 struct ltt_ust_event
*uevent
;
1561 struct ltt_ust_context
*uctx
;
1562 struct ust_app_event
*ua_event
;
1563 struct ust_app_ctx
*ua_ctx
;
1565 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1567 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1568 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1570 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1571 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1573 /* Copy event attributes since the layout is different. */
1574 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1575 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1576 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1577 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1578 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1579 ua_chan
->attr
.output
= uchan
->attr
.output
;
1581 * Note that the attribute channel type is not set since the channel on the
1582 * tracing registry side does not have this information.
1585 ua_chan
->enabled
= uchan
->enabled
;
1586 ua_chan
->tracing_channel_id
= uchan
->id
;
1588 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1589 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1590 if (ua_ctx
== NULL
) {
1593 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1594 (unsigned long) ua_ctx
->ctx
.ctx
);
1595 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1596 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1599 /* Copy all events from ltt ust channel to ust app channel */
1600 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1601 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1602 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1603 if (ua_event
== NULL
) {
1604 DBG2("UST event %s not found on shadow copy channel",
1606 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1607 if (ua_event
== NULL
) {
1610 shadow_copy_event(ua_event
, uevent
);
1611 add_unique_ust_app_event(ua_chan
, ua_event
);
1615 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1619 * Copy data between a UST app session and a regular LTT session.
1621 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1622 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1624 struct lttng_ht_node_str
*ua_chan_node
;
1625 struct lttng_ht_iter iter
;
1626 struct ltt_ust_channel
*uchan
;
1627 struct ust_app_channel
*ua_chan
;
1629 struct tm
*timeinfo
;
1633 /* Get date and time for unique app path */
1635 timeinfo
= localtime(&rawtime
);
1636 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1638 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1640 ua_sess
->tracing_id
= usess
->id
;
1641 ua_sess
->id
= get_next_session_id();
1642 ua_sess
->uid
= app
->uid
;
1643 ua_sess
->gid
= app
->gid
;
1644 ua_sess
->euid
= usess
->uid
;
1645 ua_sess
->egid
= usess
->gid
;
1646 ua_sess
->buffer_type
= usess
->buffer_type
;
1647 ua_sess
->bits_per_long
= app
->bits_per_long
;
1648 /* There is only one consumer object per session possible. */
1649 ua_sess
->consumer
= usess
->consumer
;
1650 ua_sess
->output_traces
= usess
->output_traces
;
1651 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1652 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1653 &usess
->metadata_attr
);
1655 switch (ua_sess
->buffer_type
) {
1656 case LTTNG_BUFFER_PER_PID
:
1657 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1658 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1661 case LTTNG_BUFFER_PER_UID
:
1662 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1663 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1670 PERROR("asprintf UST shadow copy session");
1675 /* Iterate over all channels in global domain. */
1676 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1678 struct lttng_ht_iter uiter
;
1680 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1681 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1682 if (ua_chan_node
!= NULL
) {
1683 /* Session exist. Contiuing. */
1687 DBG2("Channel %s not found on shadow session copy, creating it",
1689 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1690 if (ua_chan
== NULL
) {
1691 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1694 shadow_copy_channel(ua_chan
, uchan
);
1696 * The concept of metadata channel does not exist on the tracing
1697 * registry side of the session daemon so this can only be a per CPU
1698 * channel and not metadata.
1700 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1702 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1710 * Lookup sesison wrapper.
1713 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1714 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1716 /* Get right UST app session from app */
1717 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1721 * Return ust app session from the app session hashtable using the UST session
1724 static struct ust_app_session
*lookup_session_by_app(
1725 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1727 struct lttng_ht_iter iter
;
1728 struct lttng_ht_node_u64
*node
;
1730 __lookup_session_by_app(usess
, app
, &iter
);
1731 node
= lttng_ht_iter_get_node_u64(&iter
);
1736 return caa_container_of(node
, struct ust_app_session
, node
);
1743 * Setup buffer registry per PID for the given session and application. If none
1744 * is found, a new one is created, added to the global registry and
1745 * initialized. If regp is valid, it's set with the newly created object.
1747 * Return 0 on success or else a negative value.
1749 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1750 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1753 struct buffer_reg_pid
*reg_pid
;
1760 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1763 * This is the create channel path meaning that if there is NO
1764 * registry available, we have to create one for this session.
1766 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1770 buffer_reg_pid_add(reg_pid
);
1775 /* Initialize registry. */
1776 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1777 app
->bits_per_long
, app
->uint8_t_alignment
,
1778 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1779 app
->uint64_t_alignment
, app
->long_alignment
,
1780 app
->byte_order
, app
->version
.major
,
1781 app
->version
.minor
);
1786 DBG3("UST app buffer registry per PID created successfully");
1798 * Setup buffer registry per UID for the given session and application. If none
1799 * is found, a new one is created, added to the global registry and
1800 * initialized. If regp is valid, it's set with the newly created object.
1802 * Return 0 on success or else a negative value.
1804 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1805 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1808 struct buffer_reg_uid
*reg_uid
;
1815 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1818 * This is the create channel path meaning that if there is NO
1819 * registry available, we have to create one for this session.
1821 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1822 LTTNG_DOMAIN_UST
, ®_uid
);
1826 buffer_reg_uid_add(reg_uid
);
1831 /* Initialize registry. */
1832 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1833 app
->bits_per_long
, app
->uint8_t_alignment
,
1834 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1835 app
->uint64_t_alignment
, app
->long_alignment
,
1836 app
->byte_order
, app
->version
.major
,
1837 app
->version
.minor
);
1841 /* Add node to teardown list of the session. */
1842 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1844 DBG3("UST app buffer registry per UID created successfully");
1856 * Create a session on the tracer side for the given app.
1858 * On success, ua_sess_ptr is populated with the session pointer or else left
1859 * untouched. If the session was created, is_created is set to 1. On error,
1860 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1863 * Returns 0 on success or else a negative code which is either -ENOMEM or
1864 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1866 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1867 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1870 int ret
, created
= 0;
1871 struct ust_app_session
*ua_sess
;
1875 assert(ua_sess_ptr
);
1877 health_code_update();
1879 ua_sess
= lookup_session_by_app(usess
, app
);
1880 if (ua_sess
== NULL
) {
1881 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1882 app
->pid
, usess
->id
);
1883 ua_sess
= alloc_ust_app_session(app
);
1884 if (ua_sess
== NULL
) {
1885 /* Only malloc can failed so something is really wrong */
1889 shadow_copy_session(ua_sess
, usess
, app
);
1893 switch (usess
->buffer_type
) {
1894 case LTTNG_BUFFER_PER_PID
:
1895 /* Init local registry. */
1896 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1901 case LTTNG_BUFFER_PER_UID
:
1902 /* Look for a global registry. If none exists, create one. */
1903 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1914 health_code_update();
1916 if (ua_sess
->handle
== -1) {
1917 ret
= ustctl_create_session(app
->sock
);
1919 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1920 ERR("Creating session for app pid %d with ret %d",
1923 DBG("UST app creating session failed. Application is dead");
1925 * This is normal behavior, an application can die during the
1926 * creation process. Don't report an error so the execution can
1927 * continue normally. This will get flagged ENOTCONN and the
1928 * caller will handle it.
1932 delete_ust_app_session(-1, ua_sess
, app
);
1933 if (ret
!= -ENOMEM
) {
1935 * Tracer is probably gone or got an internal error so let's
1936 * behave like it will soon unregister or not usable.
1943 ua_sess
->handle
= ret
;
1945 /* Add ust app session to app's HT */
1946 lttng_ht_node_init_u64(&ua_sess
->node
,
1947 ua_sess
->tracing_id
);
1948 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1950 DBG2("UST app session created successfully with handle %d", ret
);
1953 *ua_sess_ptr
= ua_sess
;
1955 *is_created
= created
;
1958 /* Everything went well. */
1962 health_code_update();
1967 * Match function for a hash table lookup of ust_app_ctx.
1969 * It matches an ust app context based on the context type and, in the case
1970 * of perf counters, their name.
1972 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1974 struct ust_app_ctx
*ctx
;
1975 const struct lttng_ust_context
*key
;
1980 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1984 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1988 /* Check the name in the case of perf thread counters. */
1989 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1990 if (strncmp(key
->u
.perf_counter
.name
,
1991 ctx
->ctx
.u
.perf_counter
.name
,
1992 sizeof(key
->u
.perf_counter
.name
))) {
2005 * Lookup for an ust app context from an lttng_ust_context.
2007 * Must be called while holding RCU read side lock.
2008 * Return an ust_app_ctx object or NULL on error.
2011 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2012 struct lttng_ust_context
*uctx
)
2014 struct lttng_ht_iter iter
;
2015 struct lttng_ht_node_ulong
*node
;
2016 struct ust_app_ctx
*app_ctx
= NULL
;
2021 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2022 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2023 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2024 node
= lttng_ht_iter_get_node_ulong(&iter
);
2029 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2036 * Create a context for the channel on the tracer.
2038 * Called with UST app session lock held and a RCU read side lock.
2041 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2042 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2043 struct ust_app
*app
)
2046 struct ust_app_ctx
*ua_ctx
;
2048 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2050 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2056 ua_ctx
= alloc_ust_app_ctx(uctx
);
2057 if (ua_ctx
== NULL
) {
2063 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2064 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2065 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2067 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2077 * Enable on the tracer side a ust app event for the session and channel.
2079 * Called with UST app session lock held.
2082 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2083 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2087 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2092 ua_event
->enabled
= 1;
2099 * Disable on the tracer side a ust app event for the session and channel.
2101 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2102 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2106 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2111 ua_event
->enabled
= 0;
2118 * Lookup ust app channel for session and disable it on the tracer side.
2121 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2122 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2126 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2131 ua_chan
->enabled
= 0;
2138 * Lookup ust app channel for session and enable it on the tracer side. This
2139 * MUST be called with a RCU read side lock acquired.
2141 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2142 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2145 struct lttng_ht_iter iter
;
2146 struct lttng_ht_node_str
*ua_chan_node
;
2147 struct ust_app_channel
*ua_chan
;
2149 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2150 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2151 if (ua_chan_node
== NULL
) {
2152 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2153 uchan
->name
, ua_sess
->tracing_id
);
2157 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2159 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2169 * Ask the consumer to create a channel and get it if successful.
2171 * Return 0 on success or else a negative value.
2173 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2174 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2175 int bitness
, struct ust_registry_session
*registry
)
2178 unsigned int nb_fd
= 0;
2179 struct consumer_socket
*socket
;
2187 health_code_update();
2189 /* Get the right consumer socket for the application. */
2190 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2196 health_code_update();
2198 /* Need one fd for the channel. */
2199 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2201 ERR("Exhausted number of available FD upon create channel");
2206 * Ask consumer to create channel. The consumer will return the number of
2207 * stream we have to expect.
2209 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2216 * Compute the number of fd needed before receiving them. It must be 2 per
2217 * stream (2 being the default value here).
2219 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2221 /* Reserve the amount of file descriptor we need. */
2222 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2224 ERR("Exhausted number of available FD upon create channel");
2225 goto error_fd_get_stream
;
2228 health_code_update();
2231 * Now get the channel from the consumer. This call wil populate the stream
2232 * list of that channel and set the ust objects.
2234 if (usess
->consumer
->enabled
) {
2235 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2245 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2246 error_fd_get_stream
:
2248 * Initiate a destroy channel on the consumer since we had an error
2249 * handling it on our side. The return value is of no importance since we
2250 * already have a ret value set by the previous error that we need to
2253 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2255 lttng_fd_put(LTTNG_FD_APPS
, 1);
2257 health_code_update();
2263 * Duplicate the ust data object of the ust app stream and save it in the
2264 * buffer registry stream.
2266 * Return 0 on success or else a negative value.
2268 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2269 struct ust_app_stream
*stream
)
2276 /* Reserve the amount of file descriptor we need. */
2277 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2279 ERR("Exhausted number of available FD upon duplicate stream");
2283 /* Duplicate object for stream once the original is in the registry. */
2284 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2285 reg_stream
->obj
.ust
);
2287 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2288 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2289 lttng_fd_put(LTTNG_FD_APPS
, 2);
2292 stream
->handle
= stream
->obj
->handle
;
2299 * Duplicate the ust data object of the ust app. channel and save it in the
2300 * buffer registry channel.
2302 * Return 0 on success or else a negative value.
2304 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2305 struct ust_app_channel
*ua_chan
)
2312 /* Need two fds for the channel. */
2313 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2315 ERR("Exhausted number of available FD upon duplicate channel");
2319 /* Duplicate object for stream once the original is in the registry. */
2320 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2322 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2323 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2326 ua_chan
->handle
= ua_chan
->obj
->handle
;
2331 lttng_fd_put(LTTNG_FD_APPS
, 1);
2337 * For a given channel buffer registry, setup all streams of the given ust
2338 * application channel.
2340 * Return 0 on success or else a negative value.
2342 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2343 struct ust_app_channel
*ua_chan
)
2346 struct ust_app_stream
*stream
, *stmp
;
2351 DBG2("UST app setup buffer registry stream");
2353 /* Send all streams to application. */
2354 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2355 struct buffer_reg_stream
*reg_stream
;
2357 ret
= buffer_reg_stream_create(®_stream
);
2363 * Keep original pointer and nullify it in the stream so the delete
2364 * stream call does not release the object.
2366 reg_stream
->obj
.ust
= stream
->obj
;
2368 buffer_reg_stream_add(reg_stream
, reg_chan
);
2370 /* We don't need the streams anymore. */
2371 cds_list_del(&stream
->list
);
2372 delete_ust_app_stream(-1, stream
);
2380 * Create a buffer registry channel for the given session registry and
2381 * application channel object. If regp pointer is valid, it's set with the
2382 * created object. Important, the created object is NOT added to the session
2383 * registry hash table.
2385 * Return 0 on success else a negative value.
2387 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2388 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2391 struct buffer_reg_channel
*reg_chan
= NULL
;
2396 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2398 /* Create buffer registry channel. */
2399 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2404 reg_chan
->consumer_key
= ua_chan
->key
;
2405 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2406 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2408 /* Create and add a channel registry to session. */
2409 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2410 ua_chan
->tracing_channel_id
);
2414 buffer_reg_channel_add(reg_sess
, reg_chan
);
2423 /* Safe because the registry channel object was not added to any HT. */
2424 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2430 * Setup buffer registry channel for the given session registry and application
2431 * channel object. If regp pointer is valid, it's set with the created object.
2433 * Return 0 on success else a negative value.
2435 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2436 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2443 assert(ua_chan
->obj
);
2445 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2447 /* Setup all streams for the registry. */
2448 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2453 reg_chan
->obj
.ust
= ua_chan
->obj
;
2454 ua_chan
->obj
= NULL
;
2459 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2460 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2465 * Send buffer registry channel to the application.
2467 * Return 0 on success else a negative value.
2469 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2470 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2471 struct ust_app_channel
*ua_chan
)
2474 struct buffer_reg_stream
*reg_stream
;
2481 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2483 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2488 /* Send channel to the application. */
2489 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2490 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2491 ret
= -ENOTCONN
; /* Caused by app exiting. */
2493 } else if (ret
< 0) {
2497 health_code_update();
2499 /* Send all streams to application. */
2500 pthread_mutex_lock(®_chan
->stream_list_lock
);
2501 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2502 struct ust_app_stream stream
;
2504 ret
= duplicate_stream_object(reg_stream
, &stream
);
2506 goto error_stream_unlock
;
2509 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2511 (void) release_ust_app_stream(-1, &stream
);
2512 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2513 ret
= -ENOTCONN
; /* Caused by app exiting. */
2514 goto error_stream_unlock
;
2515 } else if (ret
< 0) {
2516 goto error_stream_unlock
;
2518 goto error_stream_unlock
;
2522 * The return value is not important here. This function will output an
2525 (void) release_ust_app_stream(-1, &stream
);
2527 ua_chan
->is_sent
= 1;
2529 error_stream_unlock
:
2530 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2536 * Create and send to the application the created buffers with per UID buffers.
2538 * Return 0 on success else a negative value.
2540 static int create_channel_per_uid(struct ust_app
*app
,
2541 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2542 struct ust_app_channel
*ua_chan
)
2545 struct buffer_reg_uid
*reg_uid
;
2546 struct buffer_reg_channel
*reg_chan
;
2553 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2555 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2557 * The session creation handles the creation of this global registry
2558 * object. If none can be find, there is a code flow problem or a
2563 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2566 /* Create the buffer registry channel object. */
2567 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2569 ERR("Error creating the UST channel \"%s\" registry instance",
2576 * Create the buffers on the consumer side. This call populates the
2577 * ust app channel object with all streams and data object.
2579 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2580 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2582 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2586 * Let's remove the previously created buffer registry channel so
2587 * it's not visible anymore in the session registry.
2589 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2590 ua_chan
->tracing_channel_id
);
2591 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2592 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2597 * Setup the streams and add it to the session registry.
2599 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2601 ERR("Error setting up UST channel \"%s\"",
2608 /* Send buffers to the application. */
2609 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2611 if (ret
!= -ENOTCONN
) {
2612 ERR("Error sending channel to application");
2622 * Create and send to the application the created buffers with per PID buffers.
2624 * Return 0 on success else a negative value.
2626 static int create_channel_per_pid(struct ust_app
*app
,
2627 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2628 struct ust_app_channel
*ua_chan
)
2631 struct ust_registry_session
*registry
;
2638 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2642 registry
= get_session_registry(ua_sess
);
2645 /* Create and add a new channel registry to session. */
2646 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2648 ERR("Error creating the UST channel \"%s\" registry instance",
2653 /* Create and get channel on the consumer side. */
2654 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2655 app
->bits_per_long
, registry
);
2657 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2662 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2664 if (ret
!= -ENOTCONN
) {
2665 ERR("Error sending channel to application");
2676 * From an already allocated ust app channel, create the channel buffers if
2677 * need and send it to the application. This MUST be called with a RCU read
2678 * side lock acquired.
2680 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2681 * the application exited concurrently.
2683 static int do_create_channel(struct ust_app
*app
,
2684 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2685 struct ust_app_channel
*ua_chan
)
2694 /* Handle buffer type before sending the channel to the application. */
2695 switch (usess
->buffer_type
) {
2696 case LTTNG_BUFFER_PER_UID
:
2698 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2704 case LTTNG_BUFFER_PER_PID
:
2706 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2718 /* Initialize ust objd object using the received handle and add it. */
2719 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2720 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2722 /* If channel is not enabled, disable it on the tracer */
2723 if (!ua_chan
->enabled
) {
2724 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2735 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2736 * newly created channel if not NULL.
2738 * Called with UST app session lock and RCU read-side lock held.
2740 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2741 * the application exited concurrently.
2743 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2744 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2745 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2746 struct ust_app_channel
**ua_chanp
)
2749 struct lttng_ht_iter iter
;
2750 struct lttng_ht_node_str
*ua_chan_node
;
2751 struct ust_app_channel
*ua_chan
;
2753 /* Lookup channel in the ust app session */
2754 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2755 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2756 if (ua_chan_node
!= NULL
) {
2757 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2761 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2762 if (ua_chan
== NULL
) {
2763 /* Only malloc can fail here */
2767 shadow_copy_channel(ua_chan
, uchan
);
2769 /* Set channel type. */
2770 ua_chan
->attr
.type
= type
;
2772 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2777 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2780 /* Only add the channel if successful on the tracer side. */
2781 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2785 *ua_chanp
= ua_chan
;
2788 /* Everything went well. */
2792 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2798 * Create UST app event and create it on the tracer side.
2800 * Called with ust app session mutex held.
2803 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2804 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2805 struct ust_app
*app
)
2808 struct ust_app_event
*ua_event
;
2810 /* Get event node */
2811 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2812 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2813 if (ua_event
!= NULL
) {
2818 /* Does not exist so create one */
2819 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2820 if (ua_event
== NULL
) {
2821 /* Only malloc can failed so something is really wrong */
2825 shadow_copy_event(ua_event
, uevent
);
2827 /* Create it on the tracer side */
2828 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2830 /* Not found previously means that it does not exist on the tracer */
2831 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2835 add_unique_ust_app_event(ua_chan
, ua_event
);
2837 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2844 /* Valid. Calling here is already in a read side lock */
2845 delete_ust_app_event(-1, ua_event
);
2850 * Create UST metadata and open it on the tracer side.
2852 * Called with UST app session lock held and RCU read side lock.
2854 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2855 struct ust_app
*app
, struct consumer_output
*consumer
)
2858 struct ust_app_channel
*metadata
;
2859 struct consumer_socket
*socket
;
2860 struct ust_registry_session
*registry
;
2866 registry
= get_session_registry(ua_sess
);
2869 pthread_mutex_lock(®istry
->lock
);
2871 /* Metadata already exists for this registry or it was closed previously */
2872 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2877 /* Allocate UST metadata */
2878 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2880 /* malloc() failed */
2885 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2887 /* Need one fd for the channel. */
2888 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2890 ERR("Exhausted number of available FD upon create metadata");
2894 /* Get the right consumer socket for the application. */
2895 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2898 goto error_consumer
;
2902 * Keep metadata key so we can identify it on the consumer side. Assign it
2903 * to the registry *before* we ask the consumer so we avoid the race of the
2904 * consumer requesting the metadata and the ask_channel call on our side
2905 * did not returned yet.
2907 registry
->metadata_key
= metadata
->key
;
2910 * Ask the metadata channel creation to the consumer. The metadata object
2911 * will be created by the consumer and kept their. However, the stream is
2912 * never added or monitored until we do a first push metadata to the
2915 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2918 /* Nullify the metadata key so we don't try to close it later on. */
2919 registry
->metadata_key
= 0;
2920 goto error_consumer
;
2924 * The setup command will make the metadata stream be sent to the relayd,
2925 * if applicable, and the thread managing the metadatas. This is important
2926 * because after this point, if an error occurs, the only way the stream
2927 * can be deleted is to be monitored in the consumer.
2929 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2931 /* Nullify the metadata key so we don't try to close it later on. */
2932 registry
->metadata_key
= 0;
2933 goto error_consumer
;
2936 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2937 metadata
->key
, app
->pid
);
2940 lttng_fd_put(LTTNG_FD_APPS
, 1);
2941 delete_ust_app_channel(-1, metadata
, app
);
2943 pthread_mutex_unlock(®istry
->lock
);
2948 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2949 * acquired before calling this function.
2951 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2953 struct ust_app
*app
= NULL
;
2954 struct lttng_ht_node_ulong
*node
;
2955 struct lttng_ht_iter iter
;
2957 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2958 node
= lttng_ht_iter_get_node_ulong(&iter
);
2960 DBG2("UST app no found with pid %d", pid
);
2964 DBG2("Found UST app by pid %d", pid
);
2966 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2973 * Allocate and init an UST app object using the registration information and
2974 * the command socket. This is called when the command socket connects to the
2977 * The object is returned on success or else NULL.
2979 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2981 struct ust_app
*lta
= NULL
;
2986 DBG3("UST app creating application for socket %d", sock
);
2988 if ((msg
->bits_per_long
== 64 &&
2989 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2990 || (msg
->bits_per_long
== 32 &&
2991 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2992 ERR("Registration failed: application \"%s\" (pid: %d) has "
2993 "%d-bit long, but no consumerd for this size is available.\n",
2994 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2998 lta
= zmalloc(sizeof(struct ust_app
));
3004 lta
->ppid
= msg
->ppid
;
3005 lta
->uid
= msg
->uid
;
3006 lta
->gid
= msg
->gid
;
3008 lta
->bits_per_long
= msg
->bits_per_long
;
3009 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3010 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3011 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3012 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3013 lta
->long_alignment
= msg
->long_alignment
;
3014 lta
->byte_order
= msg
->byte_order
;
3016 lta
->v_major
= msg
->major
;
3017 lta
->v_minor
= msg
->minor
;
3018 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3019 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3020 lta
->notify_sock
= -1;
3022 /* Copy name and make sure it's NULL terminated. */
3023 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3024 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3027 * Before this can be called, when receiving the registration information,
3028 * the application compatibility is checked. So, at this point, the
3029 * application can work with this session daemon.
3031 lta
->compatible
= 1;
3033 lta
->pid
= msg
->pid
;
3034 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3036 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3038 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3045 * For a given application object, add it to every hash table.
3047 void ust_app_add(struct ust_app
*app
)
3050 assert(app
->notify_sock
>= 0);
3055 * On a re-registration, we want to kick out the previous registration of
3058 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3061 * The socket _should_ be unique until _we_ call close. So, a add_unique
3062 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3063 * already in the table.
3065 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3067 /* Add application to the notify socket hash table. */
3068 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3069 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3071 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3072 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3073 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3080 * Set the application version into the object.
3082 * Return 0 on success else a negative value either an errno code or a
3083 * LTTng-UST error code.
3085 int ust_app_version(struct ust_app
*app
)
3091 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3093 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3094 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3096 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3104 * Unregister app by removing it from the global traceable app list and freeing
3107 * The socket is already closed at this point so no close to sock.
3109 void ust_app_unregister(int sock
)
3111 struct ust_app
*lta
;
3112 struct lttng_ht_node_ulong
*node
;
3113 struct lttng_ht_iter ust_app_sock_iter
;
3114 struct lttng_ht_iter iter
;
3115 struct ust_app_session
*ua_sess
;
3120 /* Get the node reference for a call_rcu */
3121 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3122 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3125 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3126 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3129 * For per-PID buffers, perform "push metadata" and flush all
3130 * application streams before removing app from hash tables,
3131 * ensuring proper behavior of data_pending check.
3132 * Remove sessions so they are not visible during deletion.
3134 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3136 struct ust_registry_session
*registry
;
3138 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3140 /* The session was already removed so scheduled for teardown. */
3144 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3145 (void) ust_app_flush_app_session(lta
, ua_sess
);
3149 * Add session to list for teardown. This is safe since at this point we
3150 * are the only one using this list.
3152 pthread_mutex_lock(&ua_sess
->lock
);
3154 if (ua_sess
->deleted
) {
3155 pthread_mutex_unlock(&ua_sess
->lock
);
3160 * Normally, this is done in the delete session process which is
3161 * executed in the call rcu below. However, upon registration we can't
3162 * afford to wait for the grace period before pushing data or else the
3163 * data pending feature can race between the unregistration and stop
3164 * command where the data pending command is sent *before* the grace
3167 * The close metadata below nullifies the metadata pointer in the
3168 * session so the delete session will NOT push/close a second time.
3170 registry
= get_session_registry(ua_sess
);
3172 /* Push metadata for application before freeing the application. */
3173 (void) push_metadata(registry
, ua_sess
->consumer
);
3176 * Don't ask to close metadata for global per UID buffers. Close
3177 * metadata only on destroy trace session in this case. Also, the
3178 * previous push metadata could have flag the metadata registry to
3179 * close so don't send a close command if closed.
3181 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3182 /* And ask to close it for this session registry. */
3183 (void) close_metadata(registry
, ua_sess
->consumer
);
3186 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3188 pthread_mutex_unlock(&ua_sess
->lock
);
3191 /* Remove application from PID hash table */
3192 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3196 * Remove application from notify hash table. The thread handling the
3197 * notify socket could have deleted the node so ignore on error because
3198 * either way it's valid. The close of that socket is handled by the other
3201 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3202 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3205 * Ignore return value since the node might have been removed before by an
3206 * add replace during app registration because the PID can be reassigned by
3209 iter
.iter
.node
= <a
->pid_n
.node
;
3210 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3212 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3217 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3224 * Fill events array with all events name of all registered apps.
3226 int ust_app_list_events(struct lttng_event
**events
)
3229 size_t nbmem
, count
= 0;
3230 struct lttng_ht_iter iter
;
3231 struct ust_app
*app
;
3232 struct lttng_event
*tmp_event
;
3234 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3235 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3236 if (tmp_event
== NULL
) {
3237 PERROR("zmalloc ust app events");
3244 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3245 struct lttng_ust_tracepoint_iter uiter
;
3247 health_code_update();
3249 if (!app
->compatible
) {
3251 * TODO: In time, we should notice the caller of this error by
3252 * telling him that this is a version error.
3256 handle
= ustctl_tracepoint_list(app
->sock
);
3258 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3259 ERR("UST app list events getting handle failed for app pid %d",
3265 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3266 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3267 /* Handle ustctl error. */
3269 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3270 ERR("UST app tp list get failed for app %d with ret %d",
3273 DBG3("UST app tp list get failed. Application is dead");
3275 * This is normal behavior, an application can die during the
3276 * creation process. Don't report an error so the execution can
3277 * continue normally. Continue normal execution.
3285 health_code_update();
3286 if (count
>= nbmem
) {
3287 /* In case the realloc fails, we free the memory */
3288 struct lttng_event
*new_tmp_event
;
3291 new_nbmem
= nbmem
<< 1;
3292 DBG2("Reallocating event list from %zu to %zu entries",
3294 new_tmp_event
= realloc(tmp_event
,
3295 new_nbmem
* sizeof(struct lttng_event
));
3296 if (new_tmp_event
== NULL
) {
3297 PERROR("realloc ust app events");
3302 /* Zero the new memory */
3303 memset(new_tmp_event
+ nbmem
, 0,
3304 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3306 tmp_event
= new_tmp_event
;
3308 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3309 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3310 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3311 tmp_event
[count
].pid
= app
->pid
;
3312 tmp_event
[count
].enabled
= -1;
3318 *events
= tmp_event
;
3320 DBG2("UST app list events done (%zu events)", count
);
3325 health_code_update();
3330 * Fill events array with all events name of all registered apps.
3332 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3335 size_t nbmem
, count
= 0;
3336 struct lttng_ht_iter iter
;
3337 struct ust_app
*app
;
3338 struct lttng_event_field
*tmp_event
;
3340 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3341 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3342 if (tmp_event
== NULL
) {
3343 PERROR("zmalloc ust app event fields");
3350 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3351 struct lttng_ust_field_iter uiter
;
3353 health_code_update();
3355 if (!app
->compatible
) {
3357 * TODO: In time, we should notice the caller of this error by
3358 * telling him that this is a version error.
3362 handle
= ustctl_tracepoint_field_list(app
->sock
);
3364 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3365 ERR("UST app list field getting handle failed for app pid %d",
3371 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3372 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3373 /* Handle ustctl error. */
3375 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3376 ERR("UST app tp list field failed for app %d with ret %d",
3379 DBG3("UST app tp list field failed. Application is dead");
3381 * This is normal behavior, an application can die during the
3382 * creation process. Don't report an error so the execution can
3383 * continue normally. Reset list and count for next app.
3391 health_code_update();
3392 if (count
>= nbmem
) {
3393 /* In case the realloc fails, we free the memory */
3394 struct lttng_event_field
*new_tmp_event
;
3397 new_nbmem
= nbmem
<< 1;
3398 DBG2("Reallocating event field list from %zu to %zu entries",
3400 new_tmp_event
= realloc(tmp_event
,
3401 new_nbmem
* sizeof(struct lttng_event_field
));
3402 if (new_tmp_event
== NULL
) {
3403 PERROR("realloc ust app event fields");
3408 /* Zero the new memory */
3409 memset(new_tmp_event
+ nbmem
, 0,
3410 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3412 tmp_event
= new_tmp_event
;
3415 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3416 /* Mapping between these enums matches 1 to 1. */
3417 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3418 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3420 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3421 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3422 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3423 tmp_event
[count
].event
.pid
= app
->pid
;
3424 tmp_event
[count
].event
.enabled
= -1;
3430 *fields
= tmp_event
;
3432 DBG2("UST app list event fields done (%zu events)", count
);
3437 health_code_update();
3442 * Free and clean all traceable apps of the global list.
3444 * Should _NOT_ be called with RCU read-side lock held.
3446 void ust_app_clean_list(void)
3449 struct ust_app
*app
;
3450 struct lttng_ht_iter iter
;
3452 DBG2("UST app cleaning registered apps hash table");
3456 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3457 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3459 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3462 /* Cleanup socket hash table */
3463 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3465 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3469 /* Cleanup notify socket hash table */
3470 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3471 notify_sock_n
.node
) {
3472 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3477 /* Destroy is done only when the ht is empty */
3478 ht_cleanup_push(ust_app_ht
);
3479 ht_cleanup_push(ust_app_ht_by_sock
);
3480 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3484 * Init UST app hash table.
3486 void ust_app_ht_alloc(void)
3488 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3489 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3490 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3494 * For a specific UST session, disable the channel for all registered apps.
3496 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3497 struct ltt_ust_channel
*uchan
)
3500 struct lttng_ht_iter iter
;
3501 struct lttng_ht_node_str
*ua_chan_node
;
3502 struct ust_app
*app
;
3503 struct ust_app_session
*ua_sess
;
3504 struct ust_app_channel
*ua_chan
;
3506 if (usess
== NULL
|| uchan
== NULL
) {
3507 ERR("Disabling UST global channel with NULL values");
3512 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3513 uchan
->name
, usess
->id
);
3517 /* For every registered applications */
3518 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3519 struct lttng_ht_iter uiter
;
3520 if (!app
->compatible
) {
3522 * TODO: In time, we should notice the caller of this error by
3523 * telling him that this is a version error.
3527 ua_sess
= lookup_session_by_app(usess
, app
);
3528 if (ua_sess
== NULL
) {
3533 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3534 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3535 /* If the session if found for the app, the channel must be there */
3536 assert(ua_chan_node
);
3538 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3539 /* The channel must not be already disabled */
3540 assert(ua_chan
->enabled
== 1);
3542 /* Disable channel onto application */
3543 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3545 /* XXX: We might want to report this error at some point... */
3557 * For a specific UST session, enable the channel for all registered apps.
3559 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3560 struct ltt_ust_channel
*uchan
)
3563 struct lttng_ht_iter iter
;
3564 struct ust_app
*app
;
3565 struct ust_app_session
*ua_sess
;
3567 if (usess
== NULL
|| uchan
== NULL
) {
3568 ERR("Adding UST global channel to NULL values");
3573 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3574 uchan
->name
, usess
->id
);
3578 /* For every registered applications */
3579 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3580 if (!app
->compatible
) {
3582 * TODO: In time, we should notice the caller of this error by
3583 * telling him that this is a version error.
3587 ua_sess
= lookup_session_by_app(usess
, app
);
3588 if (ua_sess
== NULL
) {
3592 /* Enable channel onto application */
3593 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3595 /* XXX: We might want to report this error at some point... */
3607 * Disable an event in a channel and for a specific session.
3609 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3610 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3613 struct lttng_ht_iter iter
, uiter
;
3614 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3615 struct ust_app
*app
;
3616 struct ust_app_session
*ua_sess
;
3617 struct ust_app_channel
*ua_chan
;
3618 struct ust_app_event
*ua_event
;
3620 DBG("UST app disabling event %s for all apps in channel "
3621 "%s for session id %" PRIu64
,
3622 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3626 /* For all registered applications */
3627 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3628 if (!app
->compatible
) {
3630 * TODO: In time, we should notice the caller of this error by
3631 * telling him that this is a version error.
3635 ua_sess
= lookup_session_by_app(usess
, app
);
3636 if (ua_sess
== NULL
) {
3641 /* Lookup channel in the ust app session */
3642 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3643 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3644 if (ua_chan_node
== NULL
) {
3645 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3646 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3649 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3651 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3652 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3653 if (ua_event_node
== NULL
) {
3654 DBG2("Event %s not found in channel %s for app pid %d."
3655 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3658 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3660 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3662 /* XXX: Report error someday... */
3673 * For a specific UST session, create the channel for all registered apps.
3675 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3676 struct ltt_ust_channel
*uchan
)
3678 int ret
= 0, created
;
3679 struct lttng_ht_iter iter
;
3680 struct ust_app
*app
;
3681 struct ust_app_session
*ua_sess
= NULL
;
3683 /* Very wrong code flow */
3687 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3688 uchan
->name
, usess
->id
);
3692 /* For every registered applications */
3693 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3694 if (!app
->compatible
) {
3696 * TODO: In time, we should notice the caller of this error by
3697 * telling him that this is a version error.
3702 * Create session on the tracer side and add it to app session HT. Note
3703 * that if session exist, it will simply return a pointer to the ust
3706 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3711 * The application's socket is not valid. Either a bad socket
3712 * or a timeout on it. We can't inform the caller that for a
3713 * specific app, the session failed so lets continue here.
3715 ret
= 0; /* Not an error. */
3719 goto error_rcu_unlock
;
3724 pthread_mutex_lock(&ua_sess
->lock
);
3726 if (ua_sess
->deleted
) {
3727 pthread_mutex_unlock(&ua_sess
->lock
);
3731 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3732 sizeof(uchan
->name
))) {
3733 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3736 /* Create channel onto application. We don't need the chan ref. */
3737 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3738 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3740 pthread_mutex_unlock(&ua_sess
->lock
);
3742 /* Cleanup the created session if it's the case. */
3744 destroy_app_session(app
, ua_sess
);
3749 * The application's socket is not valid. Either a bad socket
3750 * or a timeout on it. We can't inform the caller that for a
3751 * specific app, the session failed so lets continue here.
3753 ret
= 0; /* Not an error. */
3757 goto error_rcu_unlock
;
3768 * Enable event for a specific session and channel on the tracer.
3770 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3771 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3774 struct lttng_ht_iter iter
, uiter
;
3775 struct lttng_ht_node_str
*ua_chan_node
;
3776 struct ust_app
*app
;
3777 struct ust_app_session
*ua_sess
;
3778 struct ust_app_channel
*ua_chan
;
3779 struct ust_app_event
*ua_event
;
3781 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3782 uevent
->attr
.name
, usess
->id
);
3785 * NOTE: At this point, this function is called only if the session and
3786 * channel passed are already created for all apps. and enabled on the
3792 /* For all registered applications */
3793 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3794 if (!app
->compatible
) {
3796 * TODO: In time, we should notice the caller of this error by
3797 * telling him that this is a version error.
3801 ua_sess
= lookup_session_by_app(usess
, app
);
3803 /* The application has problem or is probably dead. */
3807 pthread_mutex_lock(&ua_sess
->lock
);
3809 if (ua_sess
->deleted
) {
3810 pthread_mutex_unlock(&ua_sess
->lock
);
3814 /* Lookup channel in the ust app session */
3815 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3816 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3818 * It is possible that the channel cannot be found is
3819 * the channel/event creation occurs concurrently with
3820 * an application exit.
3822 if (!ua_chan_node
) {
3823 pthread_mutex_unlock(&ua_sess
->lock
);
3827 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3829 /* Get event node */
3830 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3831 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3832 if (ua_event
== NULL
) {
3833 DBG3("UST app enable event %s not found for app PID %d."
3834 "Skipping app", uevent
->attr
.name
, app
->pid
);
3838 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3840 pthread_mutex_unlock(&ua_sess
->lock
);
3844 pthread_mutex_unlock(&ua_sess
->lock
);
3853 * For a specific existing UST session and UST channel, creates the event for
3854 * all registered apps.
3856 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3857 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3860 struct lttng_ht_iter iter
, uiter
;
3861 struct lttng_ht_node_str
*ua_chan_node
;
3862 struct ust_app
*app
;
3863 struct ust_app_session
*ua_sess
;
3864 struct ust_app_channel
*ua_chan
;
3866 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3867 uevent
->attr
.name
, usess
->id
);
3871 /* For all registered applications */
3872 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3873 if (!app
->compatible
) {
3875 * TODO: In time, we should notice the caller of this error by
3876 * telling him that this is a version error.
3880 ua_sess
= lookup_session_by_app(usess
, app
);
3882 /* The application has problem or is probably dead. */
3886 pthread_mutex_lock(&ua_sess
->lock
);
3888 if (ua_sess
->deleted
) {
3889 pthread_mutex_unlock(&ua_sess
->lock
);
3893 /* Lookup channel in the ust app session */
3894 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3895 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3896 /* If the channel is not found, there is a code flow error */
3897 assert(ua_chan_node
);
3899 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3901 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3902 pthread_mutex_unlock(&ua_sess
->lock
);
3904 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3905 /* Possible value at this point: -ENOMEM. If so, we stop! */
3908 DBG2("UST app event %s already exist on app PID %d",
3909 uevent
->attr
.name
, app
->pid
);
3920 * Start tracing for a specific UST session and app.
3923 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3926 struct ust_app_session
*ua_sess
;
3928 DBG("Starting tracing for ust app pid %d", app
->pid
);
3932 if (!app
->compatible
) {
3936 ua_sess
= lookup_session_by_app(usess
, app
);
3937 if (ua_sess
== NULL
) {
3938 /* The session is in teardown process. Ignore and continue. */
3942 pthread_mutex_lock(&ua_sess
->lock
);
3944 if (ua_sess
->deleted
) {
3945 pthread_mutex_unlock(&ua_sess
->lock
);
3949 /* Upon restart, we skip the setup, already done */
3950 if (ua_sess
->started
) {
3954 /* Create directories if consumer is LOCAL and has a path defined. */
3955 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3956 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3957 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3958 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3960 if (ret
!= -EEXIST
) {
3961 ERR("Trace directory creation error");
3968 * Create the metadata for the application. This returns gracefully if a
3969 * metadata was already set for the session.
3971 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3976 health_code_update();
3979 /* This start the UST tracing */
3980 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3982 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3983 ERR("Error starting tracing for app pid: %d (ret: %d)",
3986 DBG("UST app start session failed. Application is dead.");
3988 * This is normal behavior, an application can die during the
3989 * creation process. Don't report an error so the execution can
3990 * continue normally.
3992 pthread_mutex_unlock(&ua_sess
->lock
);
3998 /* Indicate that the session has been started once */
3999 ua_sess
->started
= 1;
4001 pthread_mutex_unlock(&ua_sess
->lock
);
4003 health_code_update();
4005 /* Quiescent wait after starting trace */
4006 ret
= ustctl_wait_quiescent(app
->sock
);
4007 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4008 ERR("UST app wait quiescent failed for app pid %d ret %d",
4014 health_code_update();
4018 pthread_mutex_unlock(&ua_sess
->lock
);
4020 health_code_update();
4025 * Stop tracing for a specific UST session and app.
4028 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4031 struct ust_app_session
*ua_sess
;
4032 struct ust_registry_session
*registry
;
4034 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4038 if (!app
->compatible
) {
4039 goto end_no_session
;
4042 ua_sess
= lookup_session_by_app(usess
, app
);
4043 if (ua_sess
== NULL
) {
4044 goto end_no_session
;
4047 pthread_mutex_lock(&ua_sess
->lock
);
4049 if (ua_sess
->deleted
) {
4050 pthread_mutex_unlock(&ua_sess
->lock
);
4051 goto end_no_session
;
4055 * If started = 0, it means that stop trace has been called for a session
4056 * that was never started. It's possible since we can have a fail start
4057 * from either the application manager thread or the command thread. Simply
4058 * indicate that this is a stop error.
4060 if (!ua_sess
->started
) {
4061 goto error_rcu_unlock
;
4064 health_code_update();
4066 /* This inhibits UST tracing */
4067 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4069 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4070 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4073 DBG("UST app stop session failed. Application is dead.");
4075 * This is normal behavior, an application can die during the
4076 * creation process. Don't report an error so the execution can
4077 * continue normally.
4081 goto error_rcu_unlock
;
4084 health_code_update();
4086 /* Quiescent wait after stopping trace */
4087 ret
= ustctl_wait_quiescent(app
->sock
);
4088 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4089 ERR("UST app wait quiescent failed for app pid %d ret %d",
4093 health_code_update();
4095 registry
= get_session_registry(ua_sess
);
4098 /* Push metadata for application before freeing the application. */
4099 (void) push_metadata(registry
, ua_sess
->consumer
);
4102 pthread_mutex_unlock(&ua_sess
->lock
);
4105 health_code_update();
4109 pthread_mutex_unlock(&ua_sess
->lock
);
4111 health_code_update();
4116 int ust_app_flush_app_session(struct ust_app
*app
,
4117 struct ust_app_session
*ua_sess
)
4119 int ret
, retval
= 0;
4120 struct lttng_ht_iter iter
;
4121 struct ust_app_channel
*ua_chan
;
4122 struct consumer_socket
*socket
;
4124 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4128 if (!app
->compatible
) {
4129 goto end_not_compatible
;
4132 pthread_mutex_lock(&ua_sess
->lock
);
4134 if (ua_sess
->deleted
) {
4138 health_code_update();
4140 /* Flushing buffers */
4141 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4144 /* Flush buffers and push metadata. */
4145 switch (ua_sess
->buffer_type
) {
4146 case LTTNG_BUFFER_PER_PID
:
4147 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4149 health_code_update();
4150 assert(ua_chan
->is_sent
);
4151 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4153 ERR("Error flushing consumer channel");
4159 case LTTNG_BUFFER_PER_UID
:
4165 health_code_update();
4168 pthread_mutex_unlock(&ua_sess
->lock
);
4172 health_code_update();
4177 * Flush buffers for all applications for a specific UST session.
4178 * Called with UST session lock held.
4181 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4186 DBG("Flushing session buffers for all ust apps");
4190 /* Flush buffers and push metadata. */
4191 switch (usess
->buffer_type
) {
4192 case LTTNG_BUFFER_PER_UID
:
4194 struct buffer_reg_uid
*reg
;
4195 struct lttng_ht_iter iter
;
4197 /* Flush all per UID buffers associated to that session. */
4198 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4199 struct ust_registry_session
*ust_session_reg
;
4200 struct buffer_reg_channel
*reg_chan
;
4201 struct consumer_socket
*socket
;
4203 /* Get consumer socket to use to push the metadata.*/
4204 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4207 /* Ignore request if no consumer is found for the session. */
4211 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4212 reg_chan
, node
.node
) {
4214 * The following call will print error values so the return
4215 * code is of little importance because whatever happens, we
4216 * have to try them all.
4218 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4221 ust_session_reg
= reg
->registry
->reg
.ust
;
4222 /* Push metadata. */
4223 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4227 case LTTNG_BUFFER_PER_PID
:
4229 struct ust_app_session
*ua_sess
;
4230 struct lttng_ht_iter iter
;
4231 struct ust_app
*app
;
4233 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4234 ua_sess
= lookup_session_by_app(usess
, app
);
4235 if (ua_sess
== NULL
) {
4238 (void) ust_app_flush_app_session(app
, ua_sess
);
4249 health_code_update();
4254 * Destroy a specific UST session in apps.
4256 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4259 struct ust_app_session
*ua_sess
;
4260 struct lttng_ht_iter iter
;
4261 struct lttng_ht_node_u64
*node
;
4263 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4267 if (!app
->compatible
) {
4271 __lookup_session_by_app(usess
, app
, &iter
);
4272 node
= lttng_ht_iter_get_node_u64(&iter
);
4274 /* Session is being or is deleted. */
4277 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4279 health_code_update();
4280 destroy_app_session(app
, ua_sess
);
4282 health_code_update();
4284 /* Quiescent wait after stopping trace */
4285 ret
= ustctl_wait_quiescent(app
->sock
);
4286 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4287 ERR("UST app wait quiescent failed for app pid %d ret %d",
4292 health_code_update();
4297 * Start tracing for the UST session.
4299 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4302 struct lttng_ht_iter iter
;
4303 struct ust_app
*app
;
4305 DBG("Starting all UST traces");
4309 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4310 ret
= ust_app_start_trace(usess
, app
);
4312 /* Continue to next apps even on error */
4323 * Start tracing for the UST session.
4324 * Called with UST session lock held.
4326 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4329 struct lttng_ht_iter iter
;
4330 struct ust_app
*app
;
4332 DBG("Stopping all UST traces");
4336 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4337 ret
= ust_app_stop_trace(usess
, app
);
4339 /* Continue to next apps even on error */
4344 (void) ust_app_flush_session(usess
);
4352 * Destroy app UST session.
4354 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4357 struct lttng_ht_iter iter
;
4358 struct ust_app
*app
;
4360 DBG("Destroy all UST traces");
4364 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4365 ret
= destroy_trace(usess
, app
);
4367 /* Continue to next apps even on error */
4378 * Add channels/events from UST global domain to registered apps at sock.
4380 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4383 struct lttng_ht_iter iter
, uiter
;
4384 struct ust_app
*app
;
4385 struct ust_app_session
*ua_sess
= NULL
;
4386 struct ust_app_channel
*ua_chan
;
4387 struct ust_app_event
*ua_event
;
4388 struct ust_app_ctx
*ua_ctx
;
4393 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4398 app
= ust_app_find_by_sock(sock
);
4401 * Application can be unregistered before so this is possible hence
4402 * simply stopping the update.
4404 DBG3("UST app update failed to find app sock %d", sock
);
4408 if (!app
->compatible
) {
4412 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4414 /* Tracer is probably gone or ENOMEM. */
4419 pthread_mutex_lock(&ua_sess
->lock
);
4421 if (ua_sess
->deleted
) {
4422 pthread_mutex_unlock(&ua_sess
->lock
);
4427 * We can iterate safely here over all UST app session since the create ust
4428 * app session above made a shadow copy of the UST global domain from the
4431 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4433 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4434 if (ret
< 0 && ret
!= -ENOTCONN
) {
4436 * Stop everything. On error, the application
4437 * failed, no more file descriptor are available
4438 * or ENOMEM so stopping here is the only thing
4439 * we can do for now. The only exception is
4440 * -ENOTCONN, which indicates that the application
4447 * Add context using the list so they are enabled in the same order the
4450 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4451 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4458 /* For each events */
4459 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4461 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4468 pthread_mutex_unlock(&ua_sess
->lock
);
4470 if (usess
->active
) {
4471 ret
= ust_app_start_trace(usess
, app
);
4476 DBG2("UST trace started for app pid %d", app
->pid
);
4479 /* Everything went well at this point. */
4484 pthread_mutex_unlock(&ua_sess
->lock
);
4487 destroy_app_session(app
, ua_sess
);
4494 * Add context to a specific channel for global UST domain.
4496 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4497 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4500 struct lttng_ht_node_str
*ua_chan_node
;
4501 struct lttng_ht_iter iter
, uiter
;
4502 struct ust_app_channel
*ua_chan
= NULL
;
4503 struct ust_app_session
*ua_sess
;
4504 struct ust_app
*app
;
4508 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4509 if (!app
->compatible
) {
4511 * TODO: In time, we should notice the caller of this error by
4512 * telling him that this is a version error.
4516 ua_sess
= lookup_session_by_app(usess
, app
);
4517 if (ua_sess
== NULL
) {
4521 pthread_mutex_lock(&ua_sess
->lock
);
4523 if (ua_sess
->deleted
) {
4524 pthread_mutex_unlock(&ua_sess
->lock
);
4528 /* Lookup channel in the ust app session */
4529 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4530 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4531 if (ua_chan_node
== NULL
) {
4534 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4536 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4541 pthread_mutex_unlock(&ua_sess
->lock
);
4549 * Enable event for a channel from a UST session for a specific PID.
4551 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4552 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4555 struct lttng_ht_iter iter
;
4556 struct lttng_ht_node_str
*ua_chan_node
;
4557 struct ust_app
*app
;
4558 struct ust_app_session
*ua_sess
;
4559 struct ust_app_channel
*ua_chan
;
4560 struct ust_app_event
*ua_event
;
4562 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4566 app
= ust_app_find_by_pid(pid
);
4568 ERR("UST app enable event per PID %d not found", pid
);
4573 if (!app
->compatible
) {
4578 ua_sess
= lookup_session_by_app(usess
, app
);
4580 /* The application has problem or is probably dead. */
4585 pthread_mutex_lock(&ua_sess
->lock
);
4587 if (ua_sess
->deleted
) {
4592 /* Lookup channel in the ust app session */
4593 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4594 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4595 /* If the channel is not found, there is a code flow error */
4596 assert(ua_chan_node
);
4598 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4600 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4601 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4602 if (ua_event
== NULL
) {
4603 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4608 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4615 pthread_mutex_unlock(&ua_sess
->lock
);
4622 * Calibrate registered applications.
4624 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4627 struct lttng_ht_iter iter
;
4628 struct ust_app
*app
;
4632 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4633 if (!app
->compatible
) {
4635 * TODO: In time, we should notice the caller of this error by
4636 * telling him that this is a version error.
4641 health_code_update();
4643 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4647 /* Means that it's not implemented on the tracer side. */
4651 DBG2("Calibrate app PID %d returned with error %d",
4658 DBG("UST app global domain calibration finished");
4662 health_code_update();
4668 * Receive registration and populate the given msg structure.
4670 * On success return 0 else a negative value returned by the ustctl call.
4672 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4675 uint32_t pid
, ppid
, uid
, gid
;
4679 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4680 &pid
, &ppid
, &uid
, &gid
,
4681 &msg
->bits_per_long
,
4682 &msg
->uint8_t_alignment
,
4683 &msg
->uint16_t_alignment
,
4684 &msg
->uint32_t_alignment
,
4685 &msg
->uint64_t_alignment
,
4686 &msg
->long_alignment
,
4693 case LTTNG_UST_ERR_EXITING
:
4694 DBG3("UST app recv reg message failed. Application died");
4696 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4697 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4698 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4699 LTTNG_UST_ABI_MINOR_VERSION
);
4702 ERR("UST app recv reg message failed with ret %d", ret
);
4707 msg
->pid
= (pid_t
) pid
;
4708 msg
->ppid
= (pid_t
) ppid
;
4709 msg
->uid
= (uid_t
) uid
;
4710 msg
->gid
= (gid_t
) gid
;
4717 * Return a ust app channel object using the application object and the channel
4718 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4719 * lock MUST be acquired before calling this function.
4721 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4724 struct lttng_ht_node_ulong
*node
;
4725 struct lttng_ht_iter iter
;
4726 struct ust_app_channel
*ua_chan
= NULL
;
4730 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4731 node
= lttng_ht_iter_get_node_ulong(&iter
);
4733 DBG2("UST app channel find by objd %d not found", objd
);
4737 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4744 * Reply to a register channel notification from an application on the notify
4745 * socket. The channel metadata is also created.
4747 * The session UST registry lock is acquired in this function.
4749 * On success 0 is returned else a negative value.
4751 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4752 size_t nr_fields
, struct ustctl_field
*fields
)
4754 int ret
, ret_code
= 0;
4755 uint32_t chan_id
, reg_count
;
4756 uint64_t chan_reg_key
;
4757 enum ustctl_channel_header type
;
4758 struct ust_app
*app
;
4759 struct ust_app_channel
*ua_chan
;
4760 struct ust_app_session
*ua_sess
;
4761 struct ust_registry_session
*registry
;
4762 struct ust_registry_channel
*chan_reg
;
4766 /* Lookup application. If not found, there is a code flow error. */
4767 app
= find_app_by_notify_sock(sock
);
4769 DBG("Application socket %d is being teardown. Abort event notify",
4773 goto error_rcu_unlock
;
4776 /* Lookup channel by UST object descriptor. */
4777 ua_chan
= find_channel_by_objd(app
, cobjd
);
4779 DBG("Application channel is being teardown. Abort event notify");
4782 goto error_rcu_unlock
;
4785 assert(ua_chan
->session
);
4786 ua_sess
= ua_chan
->session
;
4788 /* Get right session registry depending on the session buffer type. */
4789 registry
= get_session_registry(ua_sess
);
4792 /* Depending on the buffer type, a different channel key is used. */
4793 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4794 chan_reg_key
= ua_chan
->tracing_channel_id
;
4796 chan_reg_key
= ua_chan
->key
;
4799 pthread_mutex_lock(®istry
->lock
);
4801 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4804 if (!chan_reg
->register_done
) {
4805 reg_count
= ust_registry_get_event_count(chan_reg
);
4806 if (reg_count
< 31) {
4807 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4809 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4812 chan_reg
->nr_ctx_fields
= nr_fields
;
4813 chan_reg
->ctx_fields
= fields
;
4814 chan_reg
->header_type
= type
;
4816 /* Get current already assigned values. */
4817 type
= chan_reg
->header_type
;
4819 /* Set to NULL so the error path does not do a double free. */
4822 /* Channel id is set during the object creation. */
4823 chan_id
= chan_reg
->chan_id
;
4825 /* Append to metadata */
4826 if (!chan_reg
->metadata_dumped
) {
4827 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4829 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4835 DBG3("UST app replying to register channel key %" PRIu64
4836 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4839 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4841 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4842 ERR("UST app reply channel failed with ret %d", ret
);
4844 DBG3("UST app reply channel failed. Application died");
4849 /* This channel registry registration is completed. */
4850 chan_reg
->register_done
= 1;
4853 pthread_mutex_unlock(®istry
->lock
);
4863 * Add event to the UST channel registry. When the event is added to the
4864 * registry, the metadata is also created. Once done, this replies to the
4865 * application with the appropriate error code.
4867 * The session UST registry lock is acquired in the function.
4869 * On success 0 is returned else a negative value.
4871 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4872 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4873 char *model_emf_uri
)
4876 uint32_t event_id
= 0;
4877 uint64_t chan_reg_key
;
4878 struct ust_app
*app
;
4879 struct ust_app_channel
*ua_chan
;
4880 struct ust_app_session
*ua_sess
;
4881 struct ust_registry_session
*registry
;
4885 /* Lookup application. If not found, there is a code flow error. */
4886 app
= find_app_by_notify_sock(sock
);
4888 DBG("Application socket %d is being teardown. Abort event notify",
4893 free(model_emf_uri
);
4894 goto error_rcu_unlock
;
4897 /* Lookup channel by UST object descriptor. */
4898 ua_chan
= find_channel_by_objd(app
, cobjd
);
4900 DBG("Application channel is being teardown. Abort event notify");
4904 free(model_emf_uri
);
4905 goto error_rcu_unlock
;
4908 assert(ua_chan
->session
);
4909 ua_sess
= ua_chan
->session
;
4911 registry
= get_session_registry(ua_sess
);
4914 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4915 chan_reg_key
= ua_chan
->tracing_channel_id
;
4917 chan_reg_key
= ua_chan
->key
;
4920 pthread_mutex_lock(®istry
->lock
);
4923 * From this point on, this call acquires the ownership of the sig, fields
4924 * and model_emf_uri meaning any free are done inside it if needed. These
4925 * three variables MUST NOT be read/write after this.
4927 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4928 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4929 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4933 * The return value is returned to ustctl so in case of an error, the
4934 * application can be notified. In case of an error, it's important not to
4935 * return a negative error or else the application will get closed.
4937 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4939 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4940 ERR("UST app reply event failed with ret %d", ret
);
4942 DBG3("UST app reply event failed. Application died");
4945 * No need to wipe the create event since the application socket will
4946 * get close on error hence cleaning up everything by itself.
4951 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4955 pthread_mutex_unlock(®istry
->lock
);
4962 * Handle application notification through the given notify socket.
4964 * Return 0 on success or else a negative value.
4966 int ust_app_recv_notify(int sock
)
4969 enum ustctl_notify_cmd cmd
;
4971 DBG3("UST app receiving notify from sock %d", sock
);
4973 ret
= ustctl_recv_notify(sock
, &cmd
);
4975 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4976 ERR("UST app recv notify failed with ret %d", ret
);
4978 DBG3("UST app recv notify failed. Application died");
4984 case USTCTL_NOTIFY_CMD_EVENT
:
4986 int sobjd
, cobjd
, loglevel
;
4987 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4989 struct ustctl_field
*fields
;
4991 DBG2("UST app ustctl register event received");
4993 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4994 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4996 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4997 ERR("UST app recv event failed with ret %d", ret
);
4999 DBG3("UST app recv event failed. Application died");
5005 * Add event to the UST registry coming from the notify socket. This
5006 * call will free if needed the sig, fields and model_emf_uri. This
5007 * code path loses the ownsership of these variables and transfer them
5008 * to the this function.
5010 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5011 fields
, loglevel
, model_emf_uri
);
5018 case USTCTL_NOTIFY_CMD_CHANNEL
:
5022 struct ustctl_field
*fields
;
5024 DBG2("UST app ustctl register channel received");
5026 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5029 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5030 ERR("UST app recv channel failed with ret %d", ret
);
5032 DBG3("UST app recv channel failed. Application died");
5038 * The fields ownership are transfered to this function call meaning
5039 * that if needed it will be freed. After this, it's invalid to access
5040 * fields or clean it up.
5042 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
5051 /* Should NEVER happen. */
5060 * Once the notify socket hangs up, this is called. First, it tries to find the
5061 * corresponding application. On failure, the call_rcu to close the socket is
5062 * executed. If an application is found, it tries to delete it from the notify
5063 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5065 * Note that an object needs to be allocated here so on ENOMEM failure, the
5066 * call RCU is not done but the rest of the cleanup is.
5068 void ust_app_notify_sock_unregister(int sock
)
5071 struct lttng_ht_iter iter
;
5072 struct ust_app
*app
;
5073 struct ust_app_notify_sock_obj
*obj
;
5079 obj
= zmalloc(sizeof(*obj
));
5082 * An ENOMEM is kind of uncool. If this strikes we continue the
5083 * procedure but the call_rcu will not be called. In this case, we
5084 * accept the fd leak rather than possibly creating an unsynchronized
5085 * state between threads.
5087 * TODO: The notify object should be created once the notify socket is
5088 * registered and stored independantely from the ust app object. The
5089 * tricky part is to synchronize the teardown of the application and
5090 * this notify object. Let's keep that in mind so we can avoid this
5091 * kind of shenanigans with ENOMEM in the teardown path.
5098 DBG("UST app notify socket unregister %d", sock
);
5101 * Lookup application by notify socket. If this fails, this means that the
5102 * hash table delete has already been done by the application
5103 * unregistration process so we can safely close the notify socket in a
5106 app
= find_app_by_notify_sock(sock
);
5111 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5114 * Whatever happens here either we fail or succeed, in both cases we have
5115 * to close the socket after a grace period to continue to the call RCU
5116 * here. If the deletion is successful, the application is not visible
5117 * anymore by other threads and is it fails it means that it was already
5118 * deleted from the hash table so either way we just have to close the
5121 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5127 * Close socket after a grace period to avoid for the socket to be reused
5128 * before the application object is freed creating potential race between
5129 * threads trying to add unique in the global hash table.
5132 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5137 * Destroy a ust app data structure and free its memory.
5139 void ust_app_destroy(struct ust_app
*app
)
5145 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5149 * Take a snapshot for a given UST session. The snapshot is sent to the given
5152 * Return 0 on success or else a negative value.
5154 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5155 struct snapshot_output
*output
, int wait
,
5156 uint64_t nb_packets_per_stream
)
5159 unsigned int snapshot_done
= 0;
5160 struct lttng_ht_iter iter
;
5161 struct ust_app
*app
;
5162 char pathname
[PATH_MAX
];
5169 switch (usess
->buffer_type
) {
5170 case LTTNG_BUFFER_PER_UID
:
5172 struct buffer_reg_uid
*reg
;
5174 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5175 struct buffer_reg_channel
*reg_chan
;
5176 struct consumer_socket
*socket
;
5178 /* Get consumer socket to use to push the metadata.*/
5179 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5186 memset(pathname
, 0, sizeof(pathname
));
5187 ret
= snprintf(pathname
, sizeof(pathname
),
5188 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5189 reg
->uid
, reg
->bits_per_long
);
5191 PERROR("snprintf snapshot path");
5195 /* Add the UST default trace dir to path. */
5196 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5197 reg_chan
, node
.node
) {
5198 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5199 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5200 nb_packets_per_stream
);
5205 ret
= consumer_snapshot_channel(socket
,
5206 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5207 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5215 case LTTNG_BUFFER_PER_PID
:
5217 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5218 struct consumer_socket
*socket
;
5219 struct lttng_ht_iter chan_iter
;
5220 struct ust_app_channel
*ua_chan
;
5221 struct ust_app_session
*ua_sess
;
5222 struct ust_registry_session
*registry
;
5224 ua_sess
= lookup_session_by_app(usess
, app
);
5226 /* Session not associated with this app. */
5230 /* Get the right consumer socket for the application. */
5231 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5238 /* Add the UST default trace dir to path. */
5239 memset(pathname
, 0, sizeof(pathname
));
5240 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5243 PERROR("snprintf snapshot path");
5247 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5248 ua_chan
, node
.node
) {
5249 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5250 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5251 nb_packets_per_stream
);
5257 registry
= get_session_registry(ua_sess
);
5259 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5260 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5273 if (!snapshot_done
) {
5275 * If no snapshot was made and we are not in the error path, this means
5276 * that there are no buffers thus no (prior) application to snapshot
5277 * data from so we have simply NO data.
5288 * Return the size taken by one more packet per stream.
5290 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5291 uint64_t cur_nr_packets
)
5293 uint64_t tot_size
= 0;
5294 struct ust_app
*app
;
5295 struct lttng_ht_iter iter
;
5299 switch (usess
->buffer_type
) {
5300 case LTTNG_BUFFER_PER_UID
:
5302 struct buffer_reg_uid
*reg
;
5304 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5305 struct buffer_reg_channel
*reg_chan
;
5308 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5309 reg_chan
, node
.node
) {
5310 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5312 * Don't take channel into account if we
5313 * already grab all its packets.
5317 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5323 case LTTNG_BUFFER_PER_PID
:
5326 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5327 struct ust_app_channel
*ua_chan
;
5328 struct ust_app_session
*ua_sess
;
5329 struct lttng_ht_iter chan_iter
;
5331 ua_sess
= lookup_session_by_app(usess
, app
);
5333 /* Session not associated with this app. */
5337 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5338 ua_chan
, node
.node
) {
5339 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5341 * Don't take channel into account if we
5342 * already grab all its packets.
5346 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;