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"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
143 /* One of the exclusions is NULL, fail. */
144 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
148 if (key
->exclusion
&& event
->exclusion
) {
149 /* Both exclusions exists, check count followed by the names. */
150 if (event
->exclusion
->count
!= key
->exclusion
->count
||
151 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
152 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
166 * Unique add of an ust app event in the given ht. This uses the custom
167 * ht_match_ust_app_event match function and the event name as hash.
169 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
170 struct ust_app_event
*event
)
172 struct cds_lfht_node
*node_ptr
;
173 struct ust_app_ht_key key
;
177 assert(ua_chan
->events
);
180 ht
= ua_chan
->events
;
181 key
.name
= event
->attr
.name
;
182 key
.filter
= event
->filter
;
183 key
.loglevel
= event
->attr
.loglevel
;
184 key
.exclusion
= event
->exclusion
;
186 node_ptr
= cds_lfht_add_unique(ht
->ht
,
187 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
188 ht_match_ust_app_event
, &key
, &event
->node
.node
);
189 assert(node_ptr
== &event
->node
.node
);
193 * Close the notify socket from the given RCU head object. This MUST be called
194 * through a call_rcu().
196 static void close_notify_sock_rcu(struct rcu_head
*head
)
199 struct ust_app_notify_sock_obj
*obj
=
200 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
202 /* Must have a valid fd here. */
203 assert(obj
->fd
>= 0);
205 ret
= close(obj
->fd
);
207 ERR("close notify sock %d RCU", obj
->fd
);
209 lttng_fd_put(LTTNG_FD_APPS
, 1);
215 * Return the session registry according to the buffer type of the given
218 * A registry per UID object MUST exists before calling this function or else
219 * it assert() if not found. RCU read side lock must be acquired.
221 static struct ust_registry_session
*get_session_registry(
222 struct ust_app_session
*ua_sess
)
224 struct ust_registry_session
*registry
= NULL
;
228 switch (ua_sess
->buffer_type
) {
229 case LTTNG_BUFFER_PER_PID
:
231 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
235 registry
= reg_pid
->registry
->reg
.ust
;
238 case LTTNG_BUFFER_PER_UID
:
240 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
241 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
245 registry
= reg_uid
->registry
->reg
.ust
;
257 * Delete ust context safely. RCU read lock must be held before calling
261 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
268 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
269 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
270 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
271 sock
, ua_ctx
->obj
->handle
, ret
);
279 * Delete ust app event safely. RCU read lock must be held before calling
283 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
289 free(ua_event
->filter
);
291 if (ua_event
->obj
!= NULL
) {
292 ret
= ustctl_release_object(sock
, ua_event
->obj
);
293 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
294 ERR("UST app sock %d release event obj failed with ret %d",
303 * Release ust data object of the given stream.
305 * Return 0 on success or else a negative value.
307 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
314 ret
= ustctl_release_object(sock
, stream
->obj
);
315 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
316 ERR("UST app sock %d release stream obj failed with ret %d",
319 lttng_fd_put(LTTNG_FD_APPS
, 2);
327 * Delete ust app stream safely. RCU read lock must be held before calling
331 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
335 (void) release_ust_app_stream(sock
, stream
);
340 * We need to execute ht_destroy outside of RCU read-side critical
341 * section and outside of call_rcu thread, so we postpone its execution
342 * using ht_cleanup_push. It is simpler than to change the semantic of
343 * the many callers of delete_ust_app_session().
346 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
348 struct ust_app_channel
*ua_chan
=
349 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
351 ht_cleanup_push(ua_chan
->ctx
);
352 ht_cleanup_push(ua_chan
->events
);
357 * Delete ust app channel safely. RCU read lock must be held before calling
361 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
365 struct lttng_ht_iter iter
;
366 struct ust_app_event
*ua_event
;
367 struct ust_app_ctx
*ua_ctx
;
368 struct ust_app_stream
*stream
, *stmp
;
369 struct ust_registry_session
*registry
;
373 DBG3("UST app deleting channel %s", ua_chan
->name
);
376 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
377 cds_list_del(&stream
->list
);
378 delete_ust_app_stream(sock
, stream
);
382 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
383 cds_list_del(&ua_ctx
->list
);
384 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
386 delete_ust_app_ctx(sock
, ua_ctx
);
390 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
392 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
394 delete_ust_app_event(sock
, ua_event
);
397 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
398 /* Wipe and free registry from session registry. */
399 registry
= get_session_registry(ua_chan
->session
);
401 ust_registry_channel_del_free(registry
, ua_chan
->key
);
405 if (ua_chan
->obj
!= NULL
) {
406 /* Remove channel from application UST object descriptor. */
407 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
408 lttng_ht_del(app
->ust_objd
, &iter
);
409 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
410 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
411 ERR("UST app sock %d release channel obj failed with ret %d",
414 lttng_fd_put(LTTNG_FD_APPS
, 1);
417 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
421 * Push metadata to consumer socket.
423 * The socket lock MUST be acquired.
424 * The ust app session lock MUST be acquired.
426 * On success, return the len of metadata pushed or else a negative value.
428 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
429 struct consumer_socket
*socket
, int send_zero_data
)
432 char *metadata_str
= NULL
;
440 * On a push metadata error either the consumer is dead or the metadata
441 * channel has been destroyed because its endpoint might have died (e.g:
442 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
443 * metadata again which is not valid anymore on the consumer side.
445 * The ust app session mutex locked allows us to make this check without
448 if (registry
->metadata_closed
) {
452 pthread_mutex_lock(®istry
->lock
);
454 offset
= registry
->metadata_len_sent
;
455 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
457 DBG3("No metadata to push for metadata key %" PRIu64
,
458 registry
->metadata_key
);
460 if (send_zero_data
) {
461 DBG("No metadata to push");
467 /* Allocate only what we have to send. */
468 metadata_str
= zmalloc(len
);
470 PERROR("zmalloc ust app metadata string");
474 /* Copy what we haven't send out. */
475 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
476 registry
->metadata_len_sent
+= len
;
479 pthread_mutex_unlock(®istry
->lock
);
480 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
481 metadata_str
, len
, offset
);
492 pthread_mutex_unlock(®istry
->lock
);
499 * For a given application and session, push metadata to consumer. The session
500 * lock MUST be acquired here before calling this.
501 * Either sock or consumer is required : if sock is NULL, the default
502 * socket to send the metadata is retrieved from consumer, if sock
503 * is not NULL we use it to send the metadata.
505 * Return 0 on success else a negative error.
507 static int push_metadata(struct ust_registry_session
*registry
,
508 struct consumer_output
*consumer
)
512 struct consumer_socket
*socket
;
520 * Means that no metadata was assigned to the session. This can happens if
521 * no start has been done previously.
523 if (!registry
->metadata_key
) {
528 /* Get consumer socket to use to push the metadata.*/
529 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
533 goto error_rcu_unlock
;
537 * TODO: Currently, we hold the socket lock around sampling of the next
538 * metadata segment to ensure we send metadata over the consumer socket in
539 * the correct order. This makes the registry lock nest inside the socket
542 * Please note that this is a temporary measure: we should move this lock
543 * back into ust_consumer_push_metadata() when the consumer gets the
544 * ability to reorder the metadata it receives.
546 pthread_mutex_lock(socket
->lock
);
547 ret
= ust_app_push_metadata(registry
, socket
, 0);
548 pthread_mutex_unlock(socket
->lock
);
551 goto error_rcu_unlock
;
559 * On error, flag the registry that the metadata is closed. We were unable
560 * to push anything and this means that either the consumer is not
561 * responding or the metadata cache has been destroyed on the consumer.
563 registry
->metadata_closed
= 1;
570 * Send to the consumer a close metadata command for the given session. Once
571 * done, the metadata channel is deleted and the session metadata pointer is
572 * nullified. The session lock MUST be acquired here unless the application is
573 * in the destroy path.
575 * Return 0 on success else a negative value.
577 static int close_metadata(struct ust_registry_session
*registry
,
578 struct consumer_output
*consumer
)
581 struct consumer_socket
*socket
;
588 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
593 /* Get consumer socket to use to push the metadata.*/
594 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
601 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
608 * Metadata closed. Even on error this means that the consumer is not
609 * responding or not found so either way a second close should NOT be emit
612 registry
->metadata_closed
= 1;
619 * We need to execute ht_destroy outside of RCU read-side critical
620 * section and outside of call_rcu thread, so we postpone its execution
621 * using ht_cleanup_push. It is simpler than to change the semantic of
622 * the many callers of delete_ust_app_session().
625 void delete_ust_app_session_rcu(struct rcu_head
*head
)
627 struct ust_app_session
*ua_sess
=
628 caa_container_of(head
, struct ust_app_session
, rcu_head
);
630 ht_cleanup_push(ua_sess
->channels
);
635 * Delete ust app session safely. RCU read lock must be held before calling
639 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
643 struct lttng_ht_iter iter
;
644 struct ust_app_channel
*ua_chan
;
645 struct ust_registry_session
*registry
;
649 pthread_mutex_lock(&ua_sess
->lock
);
651 registry
= get_session_registry(ua_sess
);
652 if (registry
&& !registry
->metadata_closed
) {
653 /* Push metadata for application before freeing the application. */
654 (void) push_metadata(registry
, ua_sess
->consumer
);
657 * Don't ask to close metadata for global per UID buffers. Close
658 * metadata only on destroy trace session in this case. Also, the
659 * previous push metadata could have flag the metadata registry to
660 * close so don't send a close command if closed.
662 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
663 !registry
->metadata_closed
) {
664 /* And ask to close it for this session registry. */
665 (void) close_metadata(registry
, ua_sess
->consumer
);
669 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
671 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
673 delete_ust_app_channel(sock
, ua_chan
, app
);
676 /* In case of per PID, the registry is kept in the session. */
677 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
678 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
680 buffer_reg_pid_remove(reg_pid
);
681 buffer_reg_pid_destroy(reg_pid
);
685 if (ua_sess
->handle
!= -1) {
686 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
687 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
688 ERR("UST app sock %d release session handle failed with ret %d",
692 pthread_mutex_unlock(&ua_sess
->lock
);
694 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
698 * Delete a traceable application structure from the global list. Never call
699 * this function outside of a call_rcu call.
701 * RCU read side lock should _NOT_ be held when calling this function.
704 void delete_ust_app(struct ust_app
*app
)
707 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
709 /* Delete ust app sessions info */
714 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
716 /* Free every object in the session and the session. */
718 delete_ust_app_session(sock
, ua_sess
, app
);
722 ht_cleanup_push(app
->sessions
);
723 ht_cleanup_push(app
->ust_objd
);
726 * Wait until we have deleted the application from the sock hash table
727 * before closing this socket, otherwise an application could re-use the
728 * socket ID and race with the teardown, using the same hash table entry.
730 * It's OK to leave the close in call_rcu. We want it to stay unique for
731 * all RCU readers that could run concurrently with unregister app,
732 * therefore we _need_ to only close that socket after a grace period. So
733 * it should stay in this RCU callback.
735 * This close() is a very important step of the synchronization model so
736 * every modification to this function must be carefully reviewed.
742 lttng_fd_put(LTTNG_FD_APPS
, 1);
744 DBG2("UST app pid %d deleted", app
->pid
);
749 * URCU intermediate call to delete an UST app.
752 void delete_ust_app_rcu(struct rcu_head
*head
)
754 struct lttng_ht_node_ulong
*node
=
755 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
756 struct ust_app
*app
=
757 caa_container_of(node
, struct ust_app
, pid_n
);
759 DBG3("Call RCU deleting app PID %d", app
->pid
);
764 * Delete the session from the application ht and delete the data structure by
765 * freeing every object inside and releasing them.
767 static void destroy_app_session(struct ust_app
*app
,
768 struct ust_app_session
*ua_sess
)
771 struct lttng_ht_iter iter
;
776 iter
.iter
.node
= &ua_sess
->node
.node
;
777 ret
= lttng_ht_del(app
->sessions
, &iter
);
779 /* Already scheduled for teardown. */
783 /* Once deleted, free the data structure. */
784 delete_ust_app_session(app
->sock
, ua_sess
, app
);
791 * Alloc new UST app session.
794 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
796 struct ust_app_session
*ua_sess
;
798 /* Init most of the default value by allocating and zeroing */
799 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
800 if (ua_sess
== NULL
) {
805 ua_sess
->handle
= -1;
806 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
807 pthread_mutex_init(&ua_sess
->lock
, NULL
);
816 * Alloc new UST app channel.
819 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
820 struct ust_app_session
*ua_sess
,
821 struct lttng_ust_channel_attr
*attr
)
823 struct ust_app_channel
*ua_chan
;
825 /* Init most of the default value by allocating and zeroing */
826 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
827 if (ua_chan
== NULL
) {
832 /* Setup channel name */
833 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
834 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
836 ua_chan
->enabled
= 1;
837 ua_chan
->handle
= -1;
838 ua_chan
->session
= ua_sess
;
839 ua_chan
->key
= get_next_channel_key();
840 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
841 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
842 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
844 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
845 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
847 /* Copy attributes */
849 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
850 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
851 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
852 ua_chan
->attr
.overwrite
= attr
->overwrite
;
853 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
854 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
855 ua_chan
->attr
.output
= attr
->output
;
857 /* By default, the channel is a per cpu channel. */
858 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
860 DBG3("UST app channel %s allocated", ua_chan
->name
);
869 * Allocate and initialize a UST app stream.
871 * Return newly allocated stream pointer or NULL on error.
873 struct ust_app_stream
*ust_app_alloc_stream(void)
875 struct ust_app_stream
*stream
= NULL
;
877 stream
= zmalloc(sizeof(*stream
));
878 if (stream
== NULL
) {
879 PERROR("zmalloc ust app stream");
883 /* Zero could be a valid value for a handle so flag it to -1. */
891 * Alloc new UST app event.
894 struct ust_app_event
*alloc_ust_app_event(char *name
,
895 struct lttng_ust_event
*attr
)
897 struct ust_app_event
*ua_event
;
899 /* Init most of the default value by allocating and zeroing */
900 ua_event
= zmalloc(sizeof(struct ust_app_event
));
901 if (ua_event
== NULL
) {
906 ua_event
->enabled
= 1;
907 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
908 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
909 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
911 /* Copy attributes */
913 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
916 DBG3("UST app event %s allocated", ua_event
->name
);
925 * Alloc new UST app context.
928 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
930 struct ust_app_ctx
*ua_ctx
;
932 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
933 if (ua_ctx
== NULL
) {
937 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
940 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
943 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
950 * Allocate a filter and copy the given original filter.
952 * Return allocated filter or NULL on error.
954 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
955 struct lttng_ust_filter_bytecode
*orig_f
)
957 struct lttng_ust_filter_bytecode
*filter
= NULL
;
959 /* Copy filter bytecode */
960 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
962 PERROR("zmalloc alloc ust app filter");
966 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
973 * Find an ust_app using the sock and return it. RCU read side lock must be
974 * held before calling this helper function.
976 struct ust_app
*ust_app_find_by_sock(int sock
)
978 struct lttng_ht_node_ulong
*node
;
979 struct lttng_ht_iter iter
;
981 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
982 node
= lttng_ht_iter_get_node_ulong(&iter
);
984 DBG2("UST app find by sock %d not found", sock
);
988 return caa_container_of(node
, struct ust_app
, sock_n
);
995 * Find an ust_app using the notify sock and return it. RCU read side lock must
996 * be held before calling this helper function.
998 static struct ust_app
*find_app_by_notify_sock(int sock
)
1000 struct lttng_ht_node_ulong
*node
;
1001 struct lttng_ht_iter iter
;
1003 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1005 node
= lttng_ht_iter_get_node_ulong(&iter
);
1007 DBG2("UST app find by notify sock %d not found", sock
);
1011 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1018 * Lookup for an ust app event based on event name, filter bytecode and the
1021 * Return an ust_app_event object or NULL on error.
1023 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1024 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1026 struct lttng_ht_iter iter
;
1027 struct lttng_ht_node_str
*node
;
1028 struct ust_app_event
*event
= NULL
;
1029 struct ust_app_ht_key key
;
1034 /* Setup key for event lookup. */
1036 key
.filter
= filter
;
1037 key
.loglevel
= loglevel
;
1039 /* Lookup using the event name as hash and a custom match fct. */
1040 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1041 ht_match_ust_app_event
, &key
, &iter
.iter
);
1042 node
= lttng_ht_iter_get_node_str(&iter
);
1047 event
= caa_container_of(node
, struct ust_app_event
, node
);
1054 * Create the channel context on the tracer.
1056 * Called with UST app session lock held.
1059 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1060 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1064 health_code_update();
1066 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1067 ua_chan
->obj
, &ua_ctx
->obj
);
1069 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1070 ERR("UST app create channel context failed for app (pid: %d) "
1071 "with ret %d", app
->pid
, ret
);
1074 * This is normal behavior, an application can die during the
1075 * creation process. Don't report an error so the execution can
1076 * continue normally.
1079 DBG3("UST app disable event failed. Application is dead.");
1084 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1086 DBG2("UST app context handle %d created successfully for channel %s",
1087 ua_ctx
->handle
, ua_chan
->name
);
1090 health_code_update();
1095 * Set the filter on the tracer.
1098 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1099 struct ust_app
*app
)
1103 health_code_update();
1105 if (!ua_event
->filter
) {
1110 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1113 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1114 ERR("UST app event %s filter failed for app (pid: %d) "
1115 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1118 * This is normal behavior, an application can die during the
1119 * creation process. Don't report an error so the execution can
1120 * continue normally.
1123 DBG3("UST app filter event failed. Application is dead.");
1128 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1131 health_code_update();
1136 * Disable the specified event on to UST tracer for the UST session.
1138 static int disable_ust_event(struct ust_app
*app
,
1139 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1143 health_code_update();
1145 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1147 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1148 ERR("UST app event %s disable failed for app (pid: %d) "
1149 "and session handle %d with ret %d",
1150 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1153 * This is normal behavior, an application can die during the
1154 * creation process. Don't report an error so the execution can
1155 * continue normally.
1158 DBG3("UST app disable event failed. Application is dead.");
1163 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1164 ua_event
->attr
.name
, app
->pid
);
1167 health_code_update();
1172 * Disable the specified channel on to UST tracer for the UST session.
1174 static int disable_ust_channel(struct ust_app
*app
,
1175 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1179 health_code_update();
1181 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1183 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1184 ERR("UST app channel %s disable failed for app (pid: %d) "
1185 "and session handle %d with ret %d",
1186 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1189 * This is normal behavior, an application can die during the
1190 * creation process. Don't report an error so the execution can
1191 * continue normally.
1194 DBG3("UST app disable channel failed. Application is dead.");
1199 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1200 ua_chan
->name
, app
->pid
);
1203 health_code_update();
1208 * Enable the specified channel on to UST tracer for the UST session.
1210 static int enable_ust_channel(struct ust_app
*app
,
1211 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1215 health_code_update();
1217 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1219 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1220 ERR("UST app channel %s enable failed for app (pid: %d) "
1221 "and session handle %d with ret %d",
1222 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1225 * This is normal behavior, an application can die during the
1226 * creation process. Don't report an error so the execution can
1227 * continue normally.
1230 DBG3("UST app enable channel failed. Application is dead.");
1235 ua_chan
->enabled
= 1;
1237 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1238 ua_chan
->name
, app
->pid
);
1241 health_code_update();
1246 * Enable the specified event on to UST tracer for the UST session.
1248 static int enable_ust_event(struct ust_app
*app
,
1249 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1253 health_code_update();
1255 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1257 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1258 ERR("UST app event %s enable failed for app (pid: %d) "
1259 "and session handle %d with ret %d",
1260 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1263 * This is normal behavior, an application can die during the
1264 * creation process. Don't report an error so the execution can
1265 * continue normally.
1268 DBG3("UST app enable event failed. Application is dead.");
1273 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1274 ua_event
->attr
.name
, app
->pid
);
1277 health_code_update();
1282 * Send channel and stream buffer to application.
1284 * Return 0 on success. On error, a negative value is returned.
1286 static int send_channel_pid_to_ust(struct ust_app
*app
,
1287 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1290 struct ust_app_stream
*stream
, *stmp
;
1296 health_code_update();
1298 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1301 /* Send channel to the application. */
1302 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1307 health_code_update();
1309 /* Send all streams to application. */
1310 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1311 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1315 /* We don't need the stream anymore once sent to the tracer. */
1316 cds_list_del(&stream
->list
);
1317 delete_ust_app_stream(-1, stream
);
1319 /* Flag the channel that it is sent to the application. */
1320 ua_chan
->is_sent
= 1;
1323 health_code_update();
1328 * Create the specified event onto the UST tracer for a UST session.
1330 * Should be called with session mutex held.
1333 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1334 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1338 health_code_update();
1340 /* Create UST event on tracer */
1341 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1344 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1345 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1346 ua_event
->attr
.name
, app
->pid
, ret
);
1349 * This is normal behavior, an application can die during the
1350 * creation process. Don't report an error so the execution can
1351 * continue normally.
1354 DBG3("UST app create event failed. Application is dead.");
1359 ua_event
->handle
= ua_event
->obj
->handle
;
1361 DBG2("UST app event %s created successfully for pid:%d",
1362 ua_event
->attr
.name
, app
->pid
);
1364 health_code_update();
1366 /* Set filter if one is present. */
1367 if (ua_event
->filter
) {
1368 ret
= set_ust_event_filter(ua_event
, app
);
1374 /* If event not enabled, disable it on the tracer */
1375 if (ua_event
->enabled
== 0) {
1376 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1379 * If we hit an EPERM, something is wrong with our disable call. If
1380 * we get an EEXIST, there is a problem on the tracer side since we
1384 case -LTTNG_UST_ERR_PERM
:
1385 /* Code flow problem */
1387 case -LTTNG_UST_ERR_EXIST
:
1388 /* It's OK for our use case. */
1399 health_code_update();
1404 * Copy data between an UST app event and a LTT event.
1406 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1407 struct ltt_ust_event
*uevent
)
1409 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1410 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1412 ua_event
->enabled
= uevent
->enabled
;
1414 /* Copy event attributes */
1415 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1417 /* Copy filter bytecode */
1418 if (uevent
->filter
) {
1419 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1420 /* Filter might be NULL here in case of ENONEM. */
1425 * Copy data between an UST app channel and a LTT channel.
1427 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1428 struct ltt_ust_channel
*uchan
)
1430 struct lttng_ht_iter iter
;
1431 struct ltt_ust_event
*uevent
;
1432 struct ltt_ust_context
*uctx
;
1433 struct ust_app_event
*ua_event
;
1434 struct ust_app_ctx
*ua_ctx
;
1436 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1438 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1439 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1441 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1442 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1444 /* Copy event attributes since the layout is different. */
1445 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1446 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1447 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1448 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1449 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1450 ua_chan
->attr
.output
= uchan
->attr
.output
;
1452 * Note that the attribute channel type is not set since the channel on the
1453 * tracing registry side does not have this information.
1456 ua_chan
->enabled
= uchan
->enabled
;
1457 ua_chan
->tracing_channel_id
= uchan
->id
;
1459 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1460 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1461 if (ua_ctx
== NULL
) {
1464 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1465 (unsigned long) ua_ctx
->ctx
.ctx
);
1466 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1467 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1470 /* Copy all events from ltt ust channel to ust app channel */
1471 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1472 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1473 uevent
->filter
, uevent
->attr
.loglevel
);
1474 if (ua_event
== NULL
) {
1475 DBG2("UST event %s not found on shadow copy channel",
1477 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1478 if (ua_event
== NULL
) {
1481 shadow_copy_event(ua_event
, uevent
);
1482 add_unique_ust_app_event(ua_chan
, ua_event
);
1486 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1490 * Copy data between a UST app session and a regular LTT session.
1492 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1493 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1495 struct lttng_ht_node_str
*ua_chan_node
;
1496 struct lttng_ht_iter iter
;
1497 struct ltt_ust_channel
*uchan
;
1498 struct ust_app_channel
*ua_chan
;
1500 struct tm
*timeinfo
;
1504 /* Get date and time for unique app path */
1506 timeinfo
= localtime(&rawtime
);
1507 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1509 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1511 ua_sess
->tracing_id
= usess
->id
;
1512 ua_sess
->id
= get_next_session_id();
1513 ua_sess
->uid
= app
->uid
;
1514 ua_sess
->gid
= app
->gid
;
1515 ua_sess
->euid
= usess
->uid
;
1516 ua_sess
->egid
= usess
->gid
;
1517 ua_sess
->buffer_type
= usess
->buffer_type
;
1518 ua_sess
->bits_per_long
= app
->bits_per_long
;
1519 /* There is only one consumer object per session possible. */
1520 ua_sess
->consumer
= usess
->consumer
;
1521 ua_sess
->output_traces
= usess
->output_traces
;
1522 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1524 switch (ua_sess
->buffer_type
) {
1525 case LTTNG_BUFFER_PER_PID
:
1526 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1527 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1530 case LTTNG_BUFFER_PER_UID
:
1531 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1532 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1539 PERROR("asprintf UST shadow copy session");
1544 /* Iterate over all channels in global domain. */
1545 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1547 struct lttng_ht_iter uiter
;
1549 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1550 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1551 if (ua_chan_node
!= NULL
) {
1552 /* Session exist. Contiuing. */
1556 DBG2("Channel %s not found on shadow session copy, creating it",
1558 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1559 if (ua_chan
== NULL
) {
1560 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1563 shadow_copy_channel(ua_chan
, uchan
);
1565 * The concept of metadata channel does not exist on the tracing
1566 * registry side of the session daemon so this can only be a per CPU
1567 * channel and not metadata.
1569 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1571 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1579 * Lookup sesison wrapper.
1582 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1583 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1585 /* Get right UST app session from app */
1586 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1590 * Return ust app session from the app session hashtable using the UST session
1593 static struct ust_app_session
*lookup_session_by_app(
1594 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1596 struct lttng_ht_iter iter
;
1597 struct lttng_ht_node_u64
*node
;
1599 __lookup_session_by_app(usess
, app
, &iter
);
1600 node
= lttng_ht_iter_get_node_u64(&iter
);
1605 return caa_container_of(node
, struct ust_app_session
, node
);
1612 * Setup buffer registry per PID for the given session and application. If none
1613 * is found, a new one is created, added to the global registry and
1614 * initialized. If regp is valid, it's set with the newly created object.
1616 * Return 0 on success or else a negative value.
1618 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1619 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1622 struct buffer_reg_pid
*reg_pid
;
1629 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1632 * This is the create channel path meaning that if there is NO
1633 * registry available, we have to create one for this session.
1635 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1639 buffer_reg_pid_add(reg_pid
);
1644 /* Initialize registry. */
1645 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1646 app
->bits_per_long
, app
->uint8_t_alignment
,
1647 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1648 app
->uint64_t_alignment
, app
->long_alignment
,
1649 app
->byte_order
, app
->version
.major
,
1650 app
->version
.minor
);
1655 DBG3("UST app buffer registry per PID created successfully");
1667 * Setup buffer registry per UID for the given session and application. If none
1668 * is found, a new one is created, added to the global registry and
1669 * initialized. If regp is valid, it's set with the newly created object.
1671 * Return 0 on success or else a negative value.
1673 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1674 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1677 struct buffer_reg_uid
*reg_uid
;
1684 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1687 * This is the create channel path meaning that if there is NO
1688 * registry available, we have to create one for this session.
1690 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1691 LTTNG_DOMAIN_UST
, ®_uid
);
1695 buffer_reg_uid_add(reg_uid
);
1700 /* Initialize registry. */
1701 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1702 app
->bits_per_long
, app
->uint8_t_alignment
,
1703 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1704 app
->uint64_t_alignment
, app
->long_alignment
,
1705 app
->byte_order
, app
->version
.major
,
1706 app
->version
.minor
);
1710 /* Add node to teardown list of the session. */
1711 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1713 DBG3("UST app buffer registry per UID created successfully");
1725 * Create a session on the tracer side for the given app.
1727 * On success, ua_sess_ptr is populated with the session pointer or else left
1728 * untouched. If the session was created, is_created is set to 1. On error,
1729 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1732 * Returns 0 on success or else a negative code which is either -ENOMEM or
1733 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1735 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1736 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1739 int ret
, created
= 0;
1740 struct ust_app_session
*ua_sess
;
1744 assert(ua_sess_ptr
);
1746 health_code_update();
1748 ua_sess
= lookup_session_by_app(usess
, app
);
1749 if (ua_sess
== NULL
) {
1750 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1751 app
->pid
, usess
->id
);
1752 ua_sess
= alloc_ust_app_session(app
);
1753 if (ua_sess
== NULL
) {
1754 /* Only malloc can failed so something is really wrong */
1758 shadow_copy_session(ua_sess
, usess
, app
);
1762 switch (usess
->buffer_type
) {
1763 case LTTNG_BUFFER_PER_PID
:
1764 /* Init local registry. */
1765 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1770 case LTTNG_BUFFER_PER_UID
:
1771 /* Look for a global registry. If none exists, create one. */
1772 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1783 health_code_update();
1785 if (ua_sess
->handle
== -1) {
1786 ret
= ustctl_create_session(app
->sock
);
1788 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1789 ERR("Creating session for app pid %d with ret %d",
1792 DBG("UST app creating session failed. Application is dead");
1794 * This is normal behavior, an application can die during the
1795 * creation process. Don't report an error so the execution can
1796 * continue normally. This will get flagged ENOTCONN and the
1797 * caller will handle it.
1801 delete_ust_app_session(-1, ua_sess
, app
);
1802 if (ret
!= -ENOMEM
) {
1804 * Tracer is probably gone or got an internal error so let's
1805 * behave like it will soon unregister or not usable.
1812 ua_sess
->handle
= ret
;
1814 /* Add ust app session to app's HT */
1815 lttng_ht_node_init_u64(&ua_sess
->node
,
1816 ua_sess
->tracing_id
);
1817 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1819 DBG2("UST app session created successfully with handle %d", ret
);
1822 *ua_sess_ptr
= ua_sess
;
1824 *is_created
= created
;
1827 /* Everything went well. */
1831 health_code_update();
1836 * Create a context for the channel on the tracer.
1838 * Called with UST app session lock held and a RCU read side lock.
1841 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1842 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1843 struct ust_app
*app
)
1846 struct lttng_ht_iter iter
;
1847 struct lttng_ht_node_ulong
*node
;
1848 struct ust_app_ctx
*ua_ctx
;
1850 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1852 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1853 node
= lttng_ht_iter_get_node_ulong(&iter
);
1859 ua_ctx
= alloc_ust_app_ctx(uctx
);
1860 if (ua_ctx
== NULL
) {
1866 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1867 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1868 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1870 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1880 * Enable on the tracer side a ust app event for the session and channel.
1882 * Called with UST app session lock held.
1885 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1886 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1890 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1895 ua_event
->enabled
= 1;
1902 * Disable on the tracer side a ust app event for the session and channel.
1904 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1905 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1909 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1914 ua_event
->enabled
= 0;
1921 * Lookup ust app channel for session and disable it on the tracer side.
1924 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1925 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1929 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1934 ua_chan
->enabled
= 0;
1941 * Lookup ust app channel for session and enable it on the tracer side. This
1942 * MUST be called with a RCU read side lock acquired.
1944 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1945 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1948 struct lttng_ht_iter iter
;
1949 struct lttng_ht_node_str
*ua_chan_node
;
1950 struct ust_app_channel
*ua_chan
;
1952 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1953 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1954 if (ua_chan_node
== NULL
) {
1955 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1956 uchan
->name
, ua_sess
->tracing_id
);
1960 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1962 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1972 * Ask the consumer to create a channel and get it if successful.
1974 * Return 0 on success or else a negative value.
1976 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1977 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1978 int bitness
, struct ust_registry_session
*registry
)
1981 unsigned int nb_fd
= 0;
1982 struct consumer_socket
*socket
;
1990 health_code_update();
1992 /* Get the right consumer socket for the application. */
1993 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1999 health_code_update();
2001 /* Need one fd for the channel. */
2002 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2004 ERR("Exhausted number of available FD upon create channel");
2009 * Ask consumer to create channel. The consumer will return the number of
2010 * stream we have to expect.
2012 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2019 * Compute the number of fd needed before receiving them. It must be 2 per
2020 * stream (2 being the default value here).
2022 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2024 /* Reserve the amount of file descriptor we need. */
2025 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2027 ERR("Exhausted number of available FD upon create channel");
2028 goto error_fd_get_stream
;
2031 health_code_update();
2034 * Now get the channel from the consumer. This call wil populate the stream
2035 * list of that channel and set the ust objects.
2037 if (usess
->consumer
->enabled
) {
2038 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2048 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2049 error_fd_get_stream
:
2051 * Initiate a destroy channel on the consumer since we had an error
2052 * handling it on our side. The return value is of no importance since we
2053 * already have a ret value set by the previous error that we need to
2056 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2058 lttng_fd_put(LTTNG_FD_APPS
, 1);
2060 health_code_update();
2066 * Duplicate the ust data object of the ust app stream and save it in the
2067 * buffer registry stream.
2069 * Return 0 on success or else a negative value.
2071 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2072 struct ust_app_stream
*stream
)
2079 /* Reserve the amount of file descriptor we need. */
2080 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2082 ERR("Exhausted number of available FD upon duplicate stream");
2086 /* Duplicate object for stream once the original is in the registry. */
2087 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2088 reg_stream
->obj
.ust
);
2090 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2091 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2092 lttng_fd_put(LTTNG_FD_APPS
, 2);
2095 stream
->handle
= stream
->obj
->handle
;
2102 * Duplicate the ust data object of the ust app. channel and save it in the
2103 * buffer registry channel.
2105 * Return 0 on success or else a negative value.
2107 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2108 struct ust_app_channel
*ua_chan
)
2115 /* Need two fds for the channel. */
2116 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2118 ERR("Exhausted number of available FD upon duplicate channel");
2122 /* Duplicate object for stream once the original is in the registry. */
2123 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2125 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2126 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2129 ua_chan
->handle
= ua_chan
->obj
->handle
;
2134 lttng_fd_put(LTTNG_FD_APPS
, 1);
2140 * For a given channel buffer registry, setup all streams of the given ust
2141 * application channel.
2143 * Return 0 on success or else a negative value.
2145 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2146 struct ust_app_channel
*ua_chan
)
2149 struct ust_app_stream
*stream
, *stmp
;
2154 DBG2("UST app setup buffer registry stream");
2156 /* Send all streams to application. */
2157 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2158 struct buffer_reg_stream
*reg_stream
;
2160 ret
= buffer_reg_stream_create(®_stream
);
2166 * Keep original pointer and nullify it in the stream so the delete
2167 * stream call does not release the object.
2169 reg_stream
->obj
.ust
= stream
->obj
;
2171 buffer_reg_stream_add(reg_stream
, reg_chan
);
2173 /* We don't need the streams anymore. */
2174 cds_list_del(&stream
->list
);
2175 delete_ust_app_stream(-1, stream
);
2183 * Create a buffer registry channel for the given session registry and
2184 * application channel object. If regp pointer is valid, it's set with the
2185 * created object. Important, the created object is NOT added to the session
2186 * registry hash table.
2188 * Return 0 on success else a negative value.
2190 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2191 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2194 struct buffer_reg_channel
*reg_chan
= NULL
;
2199 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2201 /* Create buffer registry channel. */
2202 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2207 reg_chan
->consumer_key
= ua_chan
->key
;
2208 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2210 /* Create and add a channel registry to session. */
2211 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2212 ua_chan
->tracing_channel_id
);
2216 buffer_reg_channel_add(reg_sess
, reg_chan
);
2225 /* Safe because the registry channel object was not added to any HT. */
2226 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2232 * Setup buffer registry channel for the given session registry and application
2233 * channel object. If regp pointer is valid, it's set with the created object.
2235 * Return 0 on success else a negative value.
2237 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2238 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2245 assert(ua_chan
->obj
);
2247 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2249 /* Setup all streams for the registry. */
2250 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2255 reg_chan
->obj
.ust
= ua_chan
->obj
;
2256 ua_chan
->obj
= NULL
;
2261 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2262 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2267 * Send buffer registry channel to the application.
2269 * Return 0 on success else a negative value.
2271 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2272 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2273 struct ust_app_channel
*ua_chan
)
2276 struct buffer_reg_stream
*reg_stream
;
2283 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2285 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2290 /* Send channel to the application. */
2291 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2296 health_code_update();
2298 /* Send all streams to application. */
2299 pthread_mutex_lock(®_chan
->stream_list_lock
);
2300 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2301 struct ust_app_stream stream
;
2303 ret
= duplicate_stream_object(reg_stream
, &stream
);
2305 goto error_stream_unlock
;
2308 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2310 (void) release_ust_app_stream(-1, &stream
);
2311 goto error_stream_unlock
;
2315 * The return value is not important here. This function will output an
2318 (void) release_ust_app_stream(-1, &stream
);
2320 ua_chan
->is_sent
= 1;
2322 error_stream_unlock
:
2323 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2329 * Create and send to the application the created buffers with per UID buffers.
2331 * Return 0 on success else a negative value.
2333 static int create_channel_per_uid(struct ust_app
*app
,
2334 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2335 struct ust_app_channel
*ua_chan
)
2338 struct buffer_reg_uid
*reg_uid
;
2339 struct buffer_reg_channel
*reg_chan
;
2346 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2348 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2350 * The session creation handles the creation of this global registry
2351 * object. If none can be find, there is a code flow problem or a
2356 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2359 /* Create the buffer registry channel object. */
2360 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2367 * Create the buffers on the consumer side. This call populates the
2368 * ust app channel object with all streams and data object.
2370 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2371 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2374 * Let's remove the previously created buffer registry channel so
2375 * it's not visible anymore in the session registry.
2377 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2378 ua_chan
->tracing_channel_id
);
2379 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2380 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2385 * Setup the streams and add it to the session registry.
2387 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2394 /* Send buffers to the application. */
2395 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2405 * Create and send to the application the created buffers with per PID buffers.
2407 * Return 0 on success else a negative value.
2409 static int create_channel_per_pid(struct ust_app
*app
,
2410 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2411 struct ust_app_channel
*ua_chan
)
2414 struct ust_registry_session
*registry
;
2421 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2425 registry
= get_session_registry(ua_sess
);
2428 /* Create and add a new channel registry to session. */
2429 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2434 /* Create and get channel on the consumer side. */
2435 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2436 app
->bits_per_long
, registry
);
2441 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2452 * From an already allocated ust app channel, create the channel buffers if
2453 * need and send it to the application. This MUST be called with a RCU read
2454 * side lock acquired.
2456 * Return 0 on success or else a negative value.
2458 static int do_create_channel(struct ust_app
*app
,
2459 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2460 struct ust_app_channel
*ua_chan
)
2469 /* Handle buffer type before sending the channel to the application. */
2470 switch (usess
->buffer_type
) {
2471 case LTTNG_BUFFER_PER_UID
:
2473 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2479 case LTTNG_BUFFER_PER_PID
:
2481 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2493 /* Initialize ust objd object using the received handle and add it. */
2494 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2495 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2497 /* If channel is not enabled, disable it on the tracer */
2498 if (!ua_chan
->enabled
) {
2499 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2510 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2511 * newly created channel if not NULL.
2513 * Called with UST app session lock and RCU read-side lock held.
2515 * Return 0 on success or else a negative value.
2517 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2518 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2519 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2520 struct ust_app_channel
**ua_chanp
)
2523 struct lttng_ht_iter iter
;
2524 struct lttng_ht_node_str
*ua_chan_node
;
2525 struct ust_app_channel
*ua_chan
;
2527 /* Lookup channel in the ust app session */
2528 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2529 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2530 if (ua_chan_node
!= NULL
) {
2531 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2535 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2536 if (ua_chan
== NULL
) {
2537 /* Only malloc can fail here */
2541 shadow_copy_channel(ua_chan
, uchan
);
2543 /* Set channel type. */
2544 ua_chan
->attr
.type
= type
;
2546 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2551 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2554 /* Only add the channel if successful on the tracer side. */
2555 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2559 *ua_chanp
= ua_chan
;
2562 /* Everything went well. */
2566 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2572 * Create UST app event and create it on the tracer side.
2574 * Called with ust app session mutex held.
2577 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2578 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2579 struct ust_app
*app
)
2582 struct ust_app_event
*ua_event
;
2584 /* Get event node */
2585 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2586 uevent
->filter
, uevent
->attr
.loglevel
);
2587 if (ua_event
!= NULL
) {
2592 /* Does not exist so create one */
2593 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2594 if (ua_event
== NULL
) {
2595 /* Only malloc can failed so something is really wrong */
2599 shadow_copy_event(ua_event
, uevent
);
2601 /* Create it on the tracer side */
2602 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2604 /* Not found previously means that it does not exist on the tracer */
2605 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2609 add_unique_ust_app_event(ua_chan
, ua_event
);
2611 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2618 /* Valid. Calling here is already in a read side lock */
2619 delete_ust_app_event(-1, ua_event
);
2624 * Create UST metadata and open it on the tracer side.
2626 * Called with UST app session lock held and RCU read side lock.
2628 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2629 struct ust_app
*app
, struct consumer_output
*consumer
,
2630 struct ustctl_consumer_channel_attr
*attr
)
2633 struct ust_app_channel
*metadata
;
2634 struct consumer_socket
*socket
;
2635 struct ust_registry_session
*registry
;
2641 registry
= get_session_registry(ua_sess
);
2644 /* Metadata already exists for this registry or it was closed previously */
2645 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2650 /* Allocate UST metadata */
2651 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2653 /* malloc() failed */
2659 /* Set default attributes for metadata. */
2660 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2661 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2662 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2663 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2664 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2665 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2666 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2668 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2669 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2670 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2673 /* Need one fd for the channel. */
2674 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2676 ERR("Exhausted number of available FD upon create metadata");
2680 /* Get the right consumer socket for the application. */
2681 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2684 goto error_consumer
;
2688 * Keep metadata key so we can identify it on the consumer side. Assign it
2689 * to the registry *before* we ask the consumer so we avoid the race of the
2690 * consumer requesting the metadata and the ask_channel call on our side
2691 * did not returned yet.
2693 registry
->metadata_key
= metadata
->key
;
2696 * Ask the metadata channel creation to the consumer. The metadata object
2697 * will be created by the consumer and kept their. However, the stream is
2698 * never added or monitored until we do a first push metadata to the
2701 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2704 /* Nullify the metadata key so we don't try to close it later on. */
2705 registry
->metadata_key
= 0;
2706 goto error_consumer
;
2710 * The setup command will make the metadata stream be sent to the relayd,
2711 * if applicable, and the thread managing the metadatas. This is important
2712 * because after this point, if an error occurs, the only way the stream
2713 * can be deleted is to be monitored in the consumer.
2715 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2717 /* Nullify the metadata key so we don't try to close it later on. */
2718 registry
->metadata_key
= 0;
2719 goto error_consumer
;
2722 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2723 metadata
->key
, app
->pid
);
2726 lttng_fd_put(LTTNG_FD_APPS
, 1);
2727 delete_ust_app_channel(-1, metadata
, app
);
2733 * Return pointer to traceable apps list.
2735 struct lttng_ht
*ust_app_get_ht(void)
2741 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2742 * acquired before calling this function.
2744 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2746 struct ust_app
*app
= NULL
;
2747 struct lttng_ht_node_ulong
*node
;
2748 struct lttng_ht_iter iter
;
2750 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2751 node
= lttng_ht_iter_get_node_ulong(&iter
);
2753 DBG2("UST app no found with pid %d", pid
);
2757 DBG2("Found UST app by pid %d", pid
);
2759 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2766 * Allocate and init an UST app object using the registration information and
2767 * the command socket. This is called when the command socket connects to the
2770 * The object is returned on success or else NULL.
2772 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2774 struct ust_app
*lta
= NULL
;
2779 DBG3("UST app creating application for socket %d", sock
);
2781 if ((msg
->bits_per_long
== 64 &&
2782 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2783 || (msg
->bits_per_long
== 32 &&
2784 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2785 ERR("Registration failed: application \"%s\" (pid: %d) has "
2786 "%d-bit long, but no consumerd for this size is available.\n",
2787 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2791 lta
= zmalloc(sizeof(struct ust_app
));
2797 lta
->ppid
= msg
->ppid
;
2798 lta
->uid
= msg
->uid
;
2799 lta
->gid
= msg
->gid
;
2801 lta
->bits_per_long
= msg
->bits_per_long
;
2802 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2803 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2804 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2805 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2806 lta
->long_alignment
= msg
->long_alignment
;
2807 lta
->byte_order
= msg
->byte_order
;
2809 lta
->v_major
= msg
->major
;
2810 lta
->v_minor
= msg
->minor
;
2811 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2812 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2813 lta
->notify_sock
= -1;
2815 /* Copy name and make sure it's NULL terminated. */
2816 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2817 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2820 * Before this can be called, when receiving the registration information,
2821 * the application compatibility is checked. So, at this point, the
2822 * application can work with this session daemon.
2824 lta
->compatible
= 1;
2826 lta
->pid
= msg
->pid
;
2827 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2829 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2831 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2838 * For a given application object, add it to every hash table.
2840 void ust_app_add(struct ust_app
*app
)
2843 assert(app
->notify_sock
>= 0);
2848 * On a re-registration, we want to kick out the previous registration of
2851 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2854 * The socket _should_ be unique until _we_ call close. So, a add_unique
2855 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2856 * already in the table.
2858 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2860 /* Add application to the notify socket hash table. */
2861 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2862 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2864 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2865 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2866 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2873 * Set the application version into the object.
2875 * Return 0 on success else a negative value either an errno code or a
2876 * LTTng-UST error code.
2878 int ust_app_version(struct ust_app
*app
)
2884 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2886 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2887 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2889 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2897 * Unregister app by removing it from the global traceable app list and freeing
2900 * The socket is already closed at this point so no close to sock.
2902 void ust_app_unregister(int sock
)
2904 struct ust_app
*lta
;
2905 struct lttng_ht_node_ulong
*node
;
2906 struct lttng_ht_iter iter
;
2907 struct ust_app_session
*ua_sess
;
2912 /* Get the node reference for a call_rcu */
2913 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2914 node
= lttng_ht_iter_get_node_ulong(&iter
);
2917 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2918 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2920 /* Remove application from PID hash table */
2921 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2925 * Remove application from notify hash table. The thread handling the
2926 * notify socket could have deleted the node so ignore on error because
2927 * either way it's valid. The close of that socket is handled by the other
2930 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2931 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2934 * Ignore return value since the node might have been removed before by an
2935 * add replace during app registration because the PID can be reassigned by
2938 iter
.iter
.node
= <a
->pid_n
.node
;
2939 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2941 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2945 /* Remove sessions so they are not visible during deletion.*/
2946 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2948 struct ust_registry_session
*registry
;
2950 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2952 /* The session was already removed so scheduled for teardown. */
2957 * Add session to list for teardown. This is safe since at this point we
2958 * are the only one using this list.
2960 pthread_mutex_lock(&ua_sess
->lock
);
2963 * Normally, this is done in the delete session process which is
2964 * executed in the call rcu below. However, upon registration we can't
2965 * afford to wait for the grace period before pushing data or else the
2966 * data pending feature can race between the unregistration and stop
2967 * command where the data pending command is sent *before* the grace
2970 * The close metadata below nullifies the metadata pointer in the
2971 * session so the delete session will NOT push/close a second time.
2973 registry
= get_session_registry(ua_sess
);
2974 if (registry
&& !registry
->metadata_closed
) {
2975 /* Push metadata for application before freeing the application. */
2976 (void) push_metadata(registry
, ua_sess
->consumer
);
2979 * Don't ask to close metadata for global per UID buffers. Close
2980 * metadata only on destroy trace session in this case. Also, the
2981 * previous push metadata could have flag the metadata registry to
2982 * close so don't send a close command if closed.
2984 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2985 !registry
->metadata_closed
) {
2986 /* And ask to close it for this session registry. */
2987 (void) close_metadata(registry
, ua_sess
->consumer
);
2991 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2992 pthread_mutex_unlock(&ua_sess
->lock
);
2996 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3003 * Return traceable_app_count
3005 unsigned long ust_app_list_count(void)
3007 unsigned long count
;
3010 count
= lttng_ht_get_count(ust_app_ht
);
3017 * Fill events array with all events name of all registered apps.
3019 int ust_app_list_events(struct lttng_event
**events
)
3022 size_t nbmem
, count
= 0;
3023 struct lttng_ht_iter iter
;
3024 struct ust_app
*app
;
3025 struct lttng_event
*tmp_event
;
3027 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3028 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3029 if (tmp_event
== NULL
) {
3030 PERROR("zmalloc ust app events");
3037 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3038 struct lttng_ust_tracepoint_iter uiter
;
3040 health_code_update();
3042 if (!app
->compatible
) {
3044 * TODO: In time, we should notice the caller of this error by
3045 * telling him that this is a version error.
3049 handle
= ustctl_tracepoint_list(app
->sock
);
3051 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3052 ERR("UST app list events getting handle failed for app pid %d",
3058 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3059 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3060 /* Handle ustctl error. */
3063 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3064 ERR("UST app tp list get failed for app %d with ret %d",
3067 DBG3("UST app tp list get failed. Application is dead");
3069 * This is normal behavior, an application can die during the
3070 * creation process. Don't report an error so the execution can
3071 * continue normally. Continue normal execution.
3078 health_code_update();
3079 if (count
>= nbmem
) {
3080 /* In case the realloc fails, we free the memory */
3083 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3086 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3088 PERROR("realloc ust app events");
3095 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3096 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3097 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3098 tmp_event
[count
].pid
= app
->pid
;
3099 tmp_event
[count
].enabled
= -1;
3105 *events
= tmp_event
;
3107 DBG2("UST app list events done (%zu events)", count
);
3112 health_code_update();
3117 * Fill events array with all events name of all registered apps.
3119 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3122 size_t nbmem
, count
= 0;
3123 struct lttng_ht_iter iter
;
3124 struct ust_app
*app
;
3125 struct lttng_event_field
*tmp_event
;
3127 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3128 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3129 if (tmp_event
== NULL
) {
3130 PERROR("zmalloc ust app event fields");
3137 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3138 struct lttng_ust_field_iter uiter
;
3140 health_code_update();
3142 if (!app
->compatible
) {
3144 * TODO: In time, we should notice the caller of this error by
3145 * telling him that this is a version error.
3149 handle
= ustctl_tracepoint_field_list(app
->sock
);
3151 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3152 ERR("UST app list field getting handle failed for app pid %d",
3158 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3159 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3160 /* Handle ustctl error. */
3163 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3164 ERR("UST app tp list field failed for app %d with ret %d",
3167 DBG3("UST app tp list field failed. Application is dead");
3169 * This is normal behavior, an application can die during the
3170 * creation process. Don't report an error so the execution can
3171 * continue normally.
3178 health_code_update();
3179 if (count
>= nbmem
) {
3180 /* In case the realloc fails, we free the memory */
3183 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3186 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3188 PERROR("realloc ust app event fields");
3196 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3197 tmp_event
[count
].type
= uiter
.type
;
3198 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3200 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3201 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3202 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3203 tmp_event
[count
].event
.pid
= app
->pid
;
3204 tmp_event
[count
].event
.enabled
= -1;
3210 *fields
= tmp_event
;
3212 DBG2("UST app list event fields done (%zu events)", count
);
3217 health_code_update();
3222 * Free and clean all traceable apps of the global list.
3224 * Should _NOT_ be called with RCU read-side lock held.
3226 void ust_app_clean_list(void)
3229 struct ust_app
*app
;
3230 struct lttng_ht_iter iter
;
3232 DBG2("UST app cleaning registered apps hash table");
3236 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3237 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3239 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3242 /* Cleanup socket hash table */
3243 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3245 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3249 /* Cleanup notify socket hash table */
3250 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3251 notify_sock_n
.node
) {
3252 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3257 /* Destroy is done only when the ht is empty */
3258 ht_cleanup_push(ust_app_ht
);
3259 ht_cleanup_push(ust_app_ht_by_sock
);
3260 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3264 * Init UST app hash table.
3266 void ust_app_ht_alloc(void)
3268 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3269 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3270 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3274 * For a specific UST session, disable the channel for all registered apps.
3276 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3277 struct ltt_ust_channel
*uchan
)
3280 struct lttng_ht_iter iter
;
3281 struct lttng_ht_node_str
*ua_chan_node
;
3282 struct ust_app
*app
;
3283 struct ust_app_session
*ua_sess
;
3284 struct ust_app_channel
*ua_chan
;
3286 if (usess
== NULL
|| uchan
== NULL
) {
3287 ERR("Disabling UST global channel with NULL values");
3292 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3293 uchan
->name
, usess
->id
);
3297 /* For every registered applications */
3298 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3299 struct lttng_ht_iter uiter
;
3300 if (!app
->compatible
) {
3302 * TODO: In time, we should notice the caller of this error by
3303 * telling him that this is a version error.
3307 ua_sess
= lookup_session_by_app(usess
, app
);
3308 if (ua_sess
== NULL
) {
3313 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3314 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3315 /* If the session if found for the app, the channel must be there */
3316 assert(ua_chan_node
);
3318 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3319 /* The channel must not be already disabled */
3320 assert(ua_chan
->enabled
== 1);
3322 /* Disable channel onto application */
3323 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3325 /* XXX: We might want to report this error at some point... */
3337 * For a specific UST session, enable the channel for all registered apps.
3339 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3340 struct ltt_ust_channel
*uchan
)
3343 struct lttng_ht_iter iter
;
3344 struct ust_app
*app
;
3345 struct ust_app_session
*ua_sess
;
3347 if (usess
== NULL
|| uchan
== NULL
) {
3348 ERR("Adding UST global channel to NULL values");
3353 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3354 uchan
->name
, usess
->id
);
3358 /* For every registered applications */
3359 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3360 if (!app
->compatible
) {
3362 * TODO: In time, we should notice the caller of this error by
3363 * telling him that this is a version error.
3367 ua_sess
= lookup_session_by_app(usess
, app
);
3368 if (ua_sess
== NULL
) {
3372 /* Enable channel onto application */
3373 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3375 /* XXX: We might want to report this error at some point... */
3387 * Disable an event in a channel and for a specific session.
3389 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3390 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3393 struct lttng_ht_iter iter
, uiter
;
3394 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3395 struct ust_app
*app
;
3396 struct ust_app_session
*ua_sess
;
3397 struct ust_app_channel
*ua_chan
;
3398 struct ust_app_event
*ua_event
;
3400 DBG("UST app disabling event %s for all apps in channel "
3401 "%s for session id %" PRIu64
,
3402 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3406 /* For all registered applications */
3407 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3408 if (!app
->compatible
) {
3410 * TODO: In time, we should notice the caller of this error by
3411 * telling him that this is a version error.
3415 ua_sess
= lookup_session_by_app(usess
, app
);
3416 if (ua_sess
== NULL
) {
3421 /* Lookup channel in the ust app session */
3422 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3423 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3424 if (ua_chan_node
== NULL
) {
3425 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3426 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3429 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3431 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3432 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3433 if (ua_event_node
== NULL
) {
3434 DBG2("Event %s not found in channel %s for app pid %d."
3435 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3438 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3440 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3442 /* XXX: Report error someday... */
3453 * For a specific UST session and UST channel, the event for all
3456 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3457 struct ltt_ust_channel
*uchan
)
3460 struct lttng_ht_iter iter
, uiter
;
3461 struct lttng_ht_node_str
*ua_chan_node
;
3462 struct ust_app
*app
;
3463 struct ust_app_session
*ua_sess
;
3464 struct ust_app_channel
*ua_chan
;
3465 struct ust_app_event
*ua_event
;
3467 DBG("UST app disabling all event for all apps in channel "
3468 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3472 /* For all registered applications */
3473 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3474 if (!app
->compatible
) {
3476 * TODO: In time, we should notice the caller of this error by
3477 * telling him that this is a version error.
3481 ua_sess
= lookup_session_by_app(usess
, app
);
3483 /* The application has problem or is probably dead. */
3487 /* Lookup channel in the ust app session */
3488 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3489 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3490 /* If the channel is not found, there is a code flow error */
3491 assert(ua_chan_node
);
3493 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3495 /* Disable each events of channel */
3496 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3498 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3500 /* XXX: Report error someday... */
3512 * For a specific UST session, create the channel for all registered apps.
3514 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3515 struct ltt_ust_channel
*uchan
)
3517 int ret
= 0, created
;
3518 struct lttng_ht_iter iter
;
3519 struct ust_app
*app
;
3520 struct ust_app_session
*ua_sess
= NULL
;
3522 /* Very wrong code flow */
3526 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3527 uchan
->name
, usess
->id
);
3531 /* For every registered applications */
3532 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3533 if (!app
->compatible
) {
3535 * TODO: In time, we should notice the caller of this error by
3536 * telling him that this is a version error.
3541 * Create session on the tracer side and add it to app session HT. Note
3542 * that if session exist, it will simply return a pointer to the ust
3545 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3550 * The application's socket is not valid. Either a bad socket
3551 * or a timeout on it. We can't inform the caller that for a
3552 * specific app, the session failed so lets continue here.
3557 goto error_rcu_unlock
;
3562 pthread_mutex_lock(&ua_sess
->lock
);
3563 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3564 sizeof(uchan
->name
))) {
3565 struct ustctl_consumer_channel_attr attr
;
3566 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3567 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3570 /* Create channel onto application. We don't need the chan ref. */
3571 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3572 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3574 pthread_mutex_unlock(&ua_sess
->lock
);
3576 if (ret
== -ENOMEM
) {
3577 /* No more memory is a fatal error. Stop right now. */
3578 goto error_rcu_unlock
;
3580 /* Cleanup the created session if it's the case. */
3582 destroy_app_session(app
, ua_sess
);
3593 * Enable event for a specific session and channel on the tracer.
3595 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3596 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3599 struct lttng_ht_iter iter
, uiter
;
3600 struct lttng_ht_node_str
*ua_chan_node
;
3601 struct ust_app
*app
;
3602 struct ust_app_session
*ua_sess
;
3603 struct ust_app_channel
*ua_chan
;
3604 struct ust_app_event
*ua_event
;
3606 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3607 uevent
->attr
.name
, usess
->id
);
3610 * NOTE: At this point, this function is called only if the session and
3611 * channel passed are already created for all apps. and enabled on the
3617 /* For all registered applications */
3618 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3619 if (!app
->compatible
) {
3621 * TODO: In time, we should notice the caller of this error by
3622 * telling him that this is a version error.
3626 ua_sess
= lookup_session_by_app(usess
, app
);
3628 /* The application has problem or is probably dead. */
3632 pthread_mutex_lock(&ua_sess
->lock
);
3634 /* Lookup channel in the ust app session */
3635 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3636 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3637 /* If the channel is not found, there is a code flow error */
3638 assert(ua_chan_node
);
3640 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3642 /* Get event node */
3643 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3644 uevent
->filter
, uevent
->attr
.loglevel
);
3645 if (ua_event
== NULL
) {
3646 DBG3("UST app enable event %s not found for app PID %d."
3647 "Skipping app", uevent
->attr
.name
, app
->pid
);
3651 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3653 pthread_mutex_unlock(&ua_sess
->lock
);
3657 pthread_mutex_unlock(&ua_sess
->lock
);
3666 * For a specific existing UST session and UST channel, creates the event for
3667 * all registered apps.
3669 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3670 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3673 struct lttng_ht_iter iter
, uiter
;
3674 struct lttng_ht_node_str
*ua_chan_node
;
3675 struct ust_app
*app
;
3676 struct ust_app_session
*ua_sess
;
3677 struct ust_app_channel
*ua_chan
;
3679 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3680 uevent
->attr
.name
, usess
->id
);
3684 /* For all registered applications */
3685 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3686 if (!app
->compatible
) {
3688 * TODO: In time, we should notice the caller of this error by
3689 * telling him that this is a version error.
3693 ua_sess
= lookup_session_by_app(usess
, app
);
3695 /* The application has problem or is probably dead. */
3699 pthread_mutex_lock(&ua_sess
->lock
);
3700 /* Lookup channel in the ust app session */
3701 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3702 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3703 /* If the channel is not found, there is a code flow error */
3704 assert(ua_chan_node
);
3706 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3708 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3709 pthread_mutex_unlock(&ua_sess
->lock
);
3711 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3712 /* Possible value at this point: -ENOMEM. If so, we stop! */
3715 DBG2("UST app event %s already exist on app PID %d",
3716 uevent
->attr
.name
, app
->pid
);
3727 * Start tracing for a specific UST session and app.
3730 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3733 struct ust_app_session
*ua_sess
;
3735 DBG("Starting tracing for ust app pid %d", app
->pid
);
3739 if (!app
->compatible
) {
3743 ua_sess
= lookup_session_by_app(usess
, app
);
3744 if (ua_sess
== NULL
) {
3745 /* The session is in teardown process. Ignore and continue. */
3749 pthread_mutex_lock(&ua_sess
->lock
);
3751 /* Upon restart, we skip the setup, already done */
3752 if (ua_sess
->started
) {
3756 /* Create directories if consumer is LOCAL and has a path defined. */
3757 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3758 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3759 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3760 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3762 if (ret
!= -EEXIST
) {
3763 ERR("Trace directory creation error");
3770 * Create the metadata for the application. This returns gracefully if a
3771 * metadata was already set for the session.
3773 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3778 health_code_update();
3781 /* This start the UST tracing */
3782 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3784 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3785 ERR("Error starting tracing for app pid: %d (ret: %d)",
3788 DBG("UST app start session failed. Application is dead.");
3790 * This is normal behavior, an application can die during the
3791 * creation process. Don't report an error so the execution can
3792 * continue normally.
3794 pthread_mutex_unlock(&ua_sess
->lock
);
3800 /* Indicate that the session has been started once */
3801 ua_sess
->started
= 1;
3803 pthread_mutex_unlock(&ua_sess
->lock
);
3805 health_code_update();
3807 /* Quiescent wait after starting trace */
3808 ret
= ustctl_wait_quiescent(app
->sock
);
3809 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3810 ERR("UST app wait quiescent failed for app pid %d ret %d",
3816 health_code_update();
3820 pthread_mutex_unlock(&ua_sess
->lock
);
3822 health_code_update();
3827 * Stop tracing for a specific UST session and app.
3830 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3833 struct ust_app_session
*ua_sess
;
3834 struct ust_registry_session
*registry
;
3836 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3840 if (!app
->compatible
) {
3841 goto end_no_session
;
3844 ua_sess
= lookup_session_by_app(usess
, app
);
3845 if (ua_sess
== NULL
) {
3846 goto end_no_session
;
3849 pthread_mutex_lock(&ua_sess
->lock
);
3852 * If started = 0, it means that stop trace has been called for a session
3853 * that was never started. It's possible since we can have a fail start
3854 * from either the application manager thread or the command thread. Simply
3855 * indicate that this is a stop error.
3857 if (!ua_sess
->started
) {
3858 goto error_rcu_unlock
;
3861 health_code_update();
3863 /* This inhibits UST tracing */
3864 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3866 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3867 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3870 DBG("UST app stop session failed. Application is dead.");
3872 * This is normal behavior, an application can die during the
3873 * creation process. Don't report an error so the execution can
3874 * continue normally.
3878 goto error_rcu_unlock
;
3881 health_code_update();
3883 /* Quiescent wait after stopping trace */
3884 ret
= ustctl_wait_quiescent(app
->sock
);
3885 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3886 ERR("UST app wait quiescent failed for app pid %d ret %d",
3890 health_code_update();
3892 registry
= get_session_registry(ua_sess
);
3895 if (!registry
->metadata_closed
) {
3896 /* Push metadata for application before freeing the application. */
3897 (void) push_metadata(registry
, ua_sess
->consumer
);
3901 pthread_mutex_unlock(&ua_sess
->lock
);
3904 health_code_update();
3908 pthread_mutex_unlock(&ua_sess
->lock
);
3910 health_code_update();
3915 * Flush buffers for a specific UST session and app.
3918 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3921 struct lttng_ht_iter iter
;
3922 struct ust_app_session
*ua_sess
;
3923 struct ust_app_channel
*ua_chan
;
3925 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3929 if (!app
->compatible
) {
3930 goto end_no_session
;
3933 ua_sess
= lookup_session_by_app(usess
, app
);
3934 if (ua_sess
== NULL
) {
3935 goto end_no_session
;
3938 pthread_mutex_lock(&ua_sess
->lock
);
3940 health_code_update();
3942 /* Flushing buffers */
3943 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3945 health_code_update();
3946 assert(ua_chan
->is_sent
);
3947 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3949 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3950 ERR("UST app PID %d channel %s flush failed with ret %d",
3951 app
->pid
, ua_chan
->name
, ret
);
3953 DBG3("UST app failed to flush %s. Application is dead.",
3956 * This is normal behavior, an application can die during the
3957 * creation process. Don't report an error so the execution can
3958 * continue normally.
3961 /* Continuing flushing all buffers */
3966 health_code_update();
3968 pthread_mutex_unlock(&ua_sess
->lock
);
3971 health_code_update();
3976 * Destroy a specific UST session in apps.
3978 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3981 struct ust_app_session
*ua_sess
;
3982 struct lttng_ht_iter iter
;
3983 struct lttng_ht_node_u64
*node
;
3985 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3989 if (!app
->compatible
) {
3993 __lookup_session_by_app(usess
, app
, &iter
);
3994 node
= lttng_ht_iter_get_node_u64(&iter
);
3996 /* Session is being or is deleted. */
3999 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4001 health_code_update();
4002 destroy_app_session(app
, ua_sess
);
4004 health_code_update();
4006 /* Quiescent wait after stopping trace */
4007 ret
= ustctl_wait_quiescent(app
->sock
);
4008 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4009 ERR("UST app wait quiescent failed for app pid %d ret %d",
4014 health_code_update();
4019 * Start tracing for the UST session.
4021 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4024 struct lttng_ht_iter iter
;
4025 struct ust_app
*app
;
4027 DBG("Starting all UST traces");
4031 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4032 ret
= ust_app_start_trace(usess
, app
);
4034 /* Continue to next apps even on error */
4045 * Start tracing for the UST session.
4047 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4050 struct lttng_ht_iter iter
;
4051 struct ust_app
*app
;
4053 DBG("Stopping all UST traces");
4057 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4058 ret
= ust_app_stop_trace(usess
, app
);
4060 /* Continue to next apps even on error */
4065 /* Flush buffers and push metadata (for UID buffers). */
4066 switch (usess
->buffer_type
) {
4067 case LTTNG_BUFFER_PER_UID
:
4069 struct buffer_reg_uid
*reg
;
4071 /* Flush all per UID buffers associated to that session. */
4072 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4073 struct ust_registry_session
*ust_session_reg
;
4074 struct buffer_reg_channel
*reg_chan
;
4075 struct consumer_socket
*socket
;
4077 /* Get consumer socket to use to push the metadata.*/
4078 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4081 /* Ignore request if no consumer is found for the session. */
4085 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4086 reg_chan
, node
.node
) {
4088 * The following call will print error values so the return
4089 * code is of little importance because whatever happens, we
4090 * have to try them all.
4092 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4095 ust_session_reg
= reg
->registry
->reg
.ust
;
4096 if (!ust_session_reg
->metadata_closed
) {
4097 /* Push metadata. */
4098 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4104 case LTTNG_BUFFER_PER_PID
:
4105 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4106 ret
= ust_app_flush_trace(usess
, app
);
4108 /* Continue to next apps even on error */
4124 * Destroy app UST session.
4126 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4129 struct lttng_ht_iter iter
;
4130 struct ust_app
*app
;
4132 DBG("Destroy all UST traces");
4136 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4137 ret
= destroy_trace(usess
, app
);
4139 /* Continue to next apps even on error */
4150 * Add channels/events from UST global domain to registered apps at sock.
4152 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4155 struct lttng_ht_iter iter
, uiter
;
4156 struct ust_app
*app
;
4157 struct ust_app_session
*ua_sess
= NULL
;
4158 struct ust_app_channel
*ua_chan
;
4159 struct ust_app_event
*ua_event
;
4160 struct ust_app_ctx
*ua_ctx
;
4165 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4170 app
= ust_app_find_by_sock(sock
);
4173 * Application can be unregistered before so this is possible hence
4174 * simply stopping the update.
4176 DBG3("UST app update failed to find app sock %d", sock
);
4180 if (!app
->compatible
) {
4184 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4186 /* Tracer is probably gone or ENOMEM. */
4191 pthread_mutex_lock(&ua_sess
->lock
);
4194 * We can iterate safely here over all UST app session since the create ust
4195 * app session above made a shadow copy of the UST global domain from the
4198 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4201 * For a metadata channel, handle it differently.
4203 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4204 sizeof(ua_chan
->name
))) {
4205 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4210 /* Remove it from the hash table and continue!. */
4211 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4213 delete_ust_app_channel(-1, ua_chan
, app
);
4216 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4219 * Stop everything. On error, the application failed, no more
4220 * file descriptor are available or ENOMEM so stopping here is
4221 * the only thing we can do for now.
4228 * Add context using the list so they are enabled in the same order the
4231 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4232 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4239 /* For each events */
4240 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4242 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4249 pthread_mutex_unlock(&ua_sess
->lock
);
4251 if (usess
->start_trace
) {
4252 ret
= ust_app_start_trace(usess
, app
);
4257 DBG2("UST trace started for app pid %d", app
->pid
);
4260 /* Everything went well at this point. */
4265 pthread_mutex_unlock(&ua_sess
->lock
);
4268 destroy_app_session(app
, ua_sess
);
4275 * Add context to a specific channel for global UST domain.
4277 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4278 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4281 struct lttng_ht_node_str
*ua_chan_node
;
4282 struct lttng_ht_iter iter
, uiter
;
4283 struct ust_app_channel
*ua_chan
= NULL
;
4284 struct ust_app_session
*ua_sess
;
4285 struct ust_app
*app
;
4289 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4290 if (!app
->compatible
) {
4292 * TODO: In time, we should notice the caller of this error by
4293 * telling him that this is a version error.
4297 ua_sess
= lookup_session_by_app(usess
, app
);
4298 if (ua_sess
== NULL
) {
4302 pthread_mutex_lock(&ua_sess
->lock
);
4303 /* Lookup channel in the ust app session */
4304 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4305 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4306 if (ua_chan_node
== NULL
) {
4309 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4311 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4316 pthread_mutex_unlock(&ua_sess
->lock
);
4324 * Enable event for a channel from a UST session for a specific PID.
4326 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4327 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4330 struct lttng_ht_iter iter
;
4331 struct lttng_ht_node_str
*ua_chan_node
;
4332 struct ust_app
*app
;
4333 struct ust_app_session
*ua_sess
;
4334 struct ust_app_channel
*ua_chan
;
4335 struct ust_app_event
*ua_event
;
4337 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4341 app
= ust_app_find_by_pid(pid
);
4343 ERR("UST app enable event per PID %d not found", pid
);
4348 if (!app
->compatible
) {
4353 ua_sess
= lookup_session_by_app(usess
, app
);
4355 /* The application has problem or is probably dead. */
4360 pthread_mutex_lock(&ua_sess
->lock
);
4361 /* Lookup channel in the ust app session */
4362 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4363 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4364 /* If the channel is not found, there is a code flow error */
4365 assert(ua_chan_node
);
4367 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4369 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4370 uevent
->filter
, uevent
->attr
.loglevel
);
4371 if (ua_event
== NULL
) {
4372 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4377 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4384 pthread_mutex_unlock(&ua_sess
->lock
);
4391 * Disable event for a channel from a UST session for a specific PID.
4393 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4394 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4397 struct lttng_ht_iter iter
;
4398 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4399 struct ust_app
*app
;
4400 struct ust_app_session
*ua_sess
;
4401 struct ust_app_channel
*ua_chan
;
4402 struct ust_app_event
*ua_event
;
4404 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4408 app
= ust_app_find_by_pid(pid
);
4410 ERR("UST app disable event per PID %d not found", pid
);
4415 if (!app
->compatible
) {
4420 ua_sess
= lookup_session_by_app(usess
, app
);
4422 /* The application has problem or is probably dead. */
4426 /* Lookup channel in the ust app session */
4427 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4428 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4429 if (ua_chan_node
== NULL
) {
4430 /* Channel does not exist, skip disabling */
4433 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4435 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4436 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4437 if (ua_event_node
== NULL
) {
4438 /* Event does not exist, skip disabling */
4441 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4443 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4454 * Calibrate registered applications.
4456 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4459 struct lttng_ht_iter iter
;
4460 struct ust_app
*app
;
4464 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4465 if (!app
->compatible
) {
4467 * TODO: In time, we should notice the caller of this error by
4468 * telling him that this is a version error.
4473 health_code_update();
4475 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4479 /* Means that it's not implemented on the tracer side. */
4483 DBG2("Calibrate app PID %d returned with error %d",
4490 DBG("UST app global domain calibration finished");
4494 health_code_update();
4500 * Receive registration and populate the given msg structure.
4502 * On success return 0 else a negative value returned by the ustctl call.
4504 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4507 uint32_t pid
, ppid
, uid
, gid
;
4511 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4512 &pid
, &ppid
, &uid
, &gid
,
4513 &msg
->bits_per_long
,
4514 &msg
->uint8_t_alignment
,
4515 &msg
->uint16_t_alignment
,
4516 &msg
->uint32_t_alignment
,
4517 &msg
->uint64_t_alignment
,
4518 &msg
->long_alignment
,
4525 case LTTNG_UST_ERR_EXITING
:
4526 DBG3("UST app recv reg message failed. Application died");
4528 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4529 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4530 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4531 LTTNG_UST_ABI_MINOR_VERSION
);
4534 ERR("UST app recv reg message failed with ret %d", ret
);
4539 msg
->pid
= (pid_t
) pid
;
4540 msg
->ppid
= (pid_t
) ppid
;
4541 msg
->uid
= (uid_t
) uid
;
4542 msg
->gid
= (gid_t
) gid
;
4549 * Return a ust app channel object using the application object and the channel
4550 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4551 * lock MUST be acquired before calling this function.
4553 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4556 struct lttng_ht_node_ulong
*node
;
4557 struct lttng_ht_iter iter
;
4558 struct ust_app_channel
*ua_chan
= NULL
;
4562 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4563 node
= lttng_ht_iter_get_node_ulong(&iter
);
4565 DBG2("UST app channel find by objd %d not found", objd
);
4569 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4576 * Reply to a register channel notification from an application on the notify
4577 * socket. The channel metadata is also created.
4579 * The session UST registry lock is acquired in this function.
4581 * On success 0 is returned else a negative value.
4583 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4584 size_t nr_fields
, struct ustctl_field
*fields
)
4586 int ret
, ret_code
= 0;
4587 uint32_t chan_id
, reg_count
;
4588 uint64_t chan_reg_key
;
4589 enum ustctl_channel_header type
;
4590 struct ust_app
*app
;
4591 struct ust_app_channel
*ua_chan
;
4592 struct ust_app_session
*ua_sess
;
4593 struct ust_registry_session
*registry
;
4594 struct ust_registry_channel
*chan_reg
;
4598 /* Lookup application. If not found, there is a code flow error. */
4599 app
= find_app_by_notify_sock(sock
);
4601 DBG("Application socket %d is being teardown. Abort event notify",
4605 goto error_rcu_unlock
;
4608 /* Lookup channel by UST object descriptor. */
4609 ua_chan
= find_channel_by_objd(app
, cobjd
);
4611 DBG("Application channel is being teardown. Abort event notify");
4614 goto error_rcu_unlock
;
4617 assert(ua_chan
->session
);
4618 ua_sess
= ua_chan
->session
;
4620 /* Get right session registry depending on the session buffer type. */
4621 registry
= get_session_registry(ua_sess
);
4624 /* Depending on the buffer type, a different channel key is used. */
4625 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4626 chan_reg_key
= ua_chan
->tracing_channel_id
;
4628 chan_reg_key
= ua_chan
->key
;
4631 pthread_mutex_lock(®istry
->lock
);
4633 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4636 if (!chan_reg
->register_done
) {
4637 reg_count
= ust_registry_get_event_count(chan_reg
);
4638 if (reg_count
< 31) {
4639 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4641 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4644 chan_reg
->nr_ctx_fields
= nr_fields
;
4645 chan_reg
->ctx_fields
= fields
;
4646 chan_reg
->header_type
= type
;
4648 /* Get current already assigned values. */
4649 type
= chan_reg
->header_type
;
4651 /* Set to NULL so the error path does not do a double free. */
4654 /* Channel id is set during the object creation. */
4655 chan_id
= chan_reg
->chan_id
;
4657 /* Append to metadata */
4658 if (!chan_reg
->metadata_dumped
) {
4659 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4661 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4667 DBG3("UST app replying to register channel key %" PRIu64
4668 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4671 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4673 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4674 ERR("UST app reply channel failed with ret %d", ret
);
4676 DBG3("UST app reply channel failed. Application died");
4681 /* This channel registry registration is completed. */
4682 chan_reg
->register_done
= 1;
4685 pthread_mutex_unlock(®istry
->lock
);
4695 * Add event to the UST channel registry. When the event is added to the
4696 * registry, the metadata is also created. Once done, this replies to the
4697 * application with the appropriate error code.
4699 * The session UST registry lock is acquired in the function.
4701 * On success 0 is returned else a negative value.
4703 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4704 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4705 char *model_emf_uri
)
4708 uint32_t event_id
= 0;
4709 uint64_t chan_reg_key
;
4710 struct ust_app
*app
;
4711 struct ust_app_channel
*ua_chan
;
4712 struct ust_app_session
*ua_sess
;
4713 struct ust_registry_session
*registry
;
4717 /* Lookup application. If not found, there is a code flow error. */
4718 app
= find_app_by_notify_sock(sock
);
4720 DBG("Application socket %d is being teardown. Abort event notify",
4725 free(model_emf_uri
);
4726 goto error_rcu_unlock
;
4729 /* Lookup channel by UST object descriptor. */
4730 ua_chan
= find_channel_by_objd(app
, cobjd
);
4732 DBG("Application channel is being teardown. Abort event notify");
4736 free(model_emf_uri
);
4737 goto error_rcu_unlock
;
4740 assert(ua_chan
->session
);
4741 ua_sess
= ua_chan
->session
;
4743 registry
= get_session_registry(ua_sess
);
4746 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4747 chan_reg_key
= ua_chan
->tracing_channel_id
;
4749 chan_reg_key
= ua_chan
->key
;
4752 pthread_mutex_lock(®istry
->lock
);
4755 * From this point on, this call acquires the ownership of the sig, fields
4756 * and model_emf_uri meaning any free are done inside it if needed. These
4757 * three variables MUST NOT be read/write after this.
4759 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4760 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4761 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4765 * The return value is returned to ustctl so in case of an error, the
4766 * application can be notified. In case of an error, it's important not to
4767 * return a negative error or else the application will get closed.
4769 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4771 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4772 ERR("UST app reply event failed with ret %d", ret
);
4774 DBG3("UST app reply event failed. Application died");
4777 * No need to wipe the create event since the application socket will
4778 * get close on error hence cleaning up everything by itself.
4783 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4787 pthread_mutex_unlock(®istry
->lock
);
4794 * Handle application notification through the given notify socket.
4796 * Return 0 on success or else a negative value.
4798 int ust_app_recv_notify(int sock
)
4801 enum ustctl_notify_cmd cmd
;
4803 DBG3("UST app receiving notify from sock %d", sock
);
4805 ret
= ustctl_recv_notify(sock
, &cmd
);
4807 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4808 ERR("UST app recv notify failed with ret %d", ret
);
4810 DBG3("UST app recv notify failed. Application died");
4816 case USTCTL_NOTIFY_CMD_EVENT
:
4818 int sobjd
, cobjd
, loglevel
;
4819 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4821 struct ustctl_field
*fields
;
4823 DBG2("UST app ustctl register event received");
4825 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4826 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4828 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4829 ERR("UST app recv event failed with ret %d", ret
);
4831 DBG3("UST app recv event failed. Application died");
4837 * Add event to the UST registry coming from the notify socket. This
4838 * call will free if needed the sig, fields and model_emf_uri. This
4839 * code path loses the ownsership of these variables and transfer them
4840 * to the this function.
4842 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4843 fields
, loglevel
, model_emf_uri
);
4850 case USTCTL_NOTIFY_CMD_CHANNEL
:
4854 struct ustctl_field
*fields
;
4856 DBG2("UST app ustctl register channel received");
4858 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4861 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4862 ERR("UST app recv channel failed with ret %d", ret
);
4864 DBG3("UST app recv channel failed. Application died");
4870 * The fields ownership are transfered to this function call meaning
4871 * that if needed it will be freed. After this, it's invalid to access
4872 * fields or clean it up.
4874 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4883 /* Should NEVER happen. */
4892 * Once the notify socket hangs up, this is called. First, it tries to find the
4893 * corresponding application. On failure, the call_rcu to close the socket is
4894 * executed. If an application is found, it tries to delete it from the notify
4895 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4897 * Note that an object needs to be allocated here so on ENOMEM failure, the
4898 * call RCU is not done but the rest of the cleanup is.
4900 void ust_app_notify_sock_unregister(int sock
)
4903 struct lttng_ht_iter iter
;
4904 struct ust_app
*app
;
4905 struct ust_app_notify_sock_obj
*obj
;
4911 obj
= zmalloc(sizeof(*obj
));
4914 * An ENOMEM is kind of uncool. If this strikes we continue the
4915 * procedure but the call_rcu will not be called. In this case, we
4916 * accept the fd leak rather than possibly creating an unsynchronized
4917 * state between threads.
4919 * TODO: The notify object should be created once the notify socket is
4920 * registered and stored independantely from the ust app object. The
4921 * tricky part is to synchronize the teardown of the application and
4922 * this notify object. Let's keep that in mind so we can avoid this
4923 * kind of shenanigans with ENOMEM in the teardown path.
4930 DBG("UST app notify socket unregister %d", sock
);
4933 * Lookup application by notify socket. If this fails, this means that the
4934 * hash table delete has already been done by the application
4935 * unregistration process so we can safely close the notify socket in a
4938 app
= find_app_by_notify_sock(sock
);
4943 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4946 * Whatever happens here either we fail or succeed, in both cases we have
4947 * to close the socket after a grace period to continue to the call RCU
4948 * here. If the deletion is successful, the application is not visible
4949 * anymore by other threads and is it fails it means that it was already
4950 * deleted from the hash table so either way we just have to close the
4953 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4959 * Close socket after a grace period to avoid for the socket to be reused
4960 * before the application object is freed creating potential race between
4961 * threads trying to add unique in the global hash table.
4964 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4969 * Destroy a ust app data structure and free its memory.
4971 void ust_app_destroy(struct ust_app
*app
)
4977 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4981 * Take a snapshot for a given UST session. The snapshot is sent to the given
4984 * Return 0 on success or else a negative value.
4986 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4987 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4990 struct lttng_ht_iter iter
;
4991 struct ust_app
*app
;
4992 char pathname
[PATH_MAX
];
4993 uint64_t max_stream_size
= 0;
5001 * Compute the maximum size of a single stream if a max size is asked by
5004 if (output
->max_size
> 0 && nb_streams
> 0) {
5005 max_stream_size
= output
->max_size
/ nb_streams
;
5008 switch (usess
->buffer_type
) {
5009 case LTTNG_BUFFER_PER_UID
:
5011 struct buffer_reg_uid
*reg
;
5013 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5014 struct buffer_reg_channel
*reg_chan
;
5015 struct consumer_socket
*socket
;
5017 /* Get consumer socket to use to push the metadata.*/
5018 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5025 memset(pathname
, 0, sizeof(pathname
));
5026 ret
= snprintf(pathname
, sizeof(pathname
),
5027 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5028 reg
->uid
, reg
->bits_per_long
);
5030 PERROR("snprintf snapshot path");
5034 /* Add the UST default trace dir to path. */
5035 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5036 reg_chan
, node
.node
) {
5039 * Make sure the maximum stream size is not lower than the
5040 * subbuffer size or else it's an error since we won't be able to
5041 * snapshot anything.
5043 if (max_stream_size
&&
5044 reg_chan
->subbuf_size
> max_stream_size
) {
5046 DBG3("UST app snapshot record maximum stream size %" PRIu64
5047 " is smaller than subbuffer size of %zu",
5048 max_stream_size
, reg_chan
->subbuf_size
);
5051 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5052 usess
->uid
, usess
->gid
, pathname
, wait
,
5058 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5059 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5067 case LTTNG_BUFFER_PER_PID
:
5069 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5070 struct consumer_socket
*socket
;
5071 struct lttng_ht_iter chan_iter
;
5072 struct ust_app_channel
*ua_chan
;
5073 struct ust_app_session
*ua_sess
;
5074 struct ust_registry_session
*registry
;
5076 ua_sess
= lookup_session_by_app(usess
, app
);
5078 /* Session not associated with this app. */
5082 /* Get the right consumer socket for the application. */
5083 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5090 /* Add the UST default trace dir to path. */
5091 memset(pathname
, 0, sizeof(pathname
));
5092 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5095 PERROR("snprintf snapshot path");
5099 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5100 ua_chan
, node
.node
) {
5102 * Make sure the maximum stream size is not lower than the
5103 * subbuffer size or else it's an error since we won't be able to
5104 * snapshot anything.
5106 if (max_stream_size
&&
5107 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5109 DBG3("UST app snapshot record maximum stream size %" PRIu64
5110 " is smaller than subbuffer size of %" PRIu64
,
5111 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5115 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5116 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5123 registry
= get_session_registry(ua_sess
);
5125 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5126 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5145 * Return the number of streams for a UST session.
5147 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5149 unsigned int ret
= 0;
5150 struct ust_app
*app
;
5151 struct lttng_ht_iter iter
;
5155 switch (usess
->buffer_type
) {
5156 case LTTNG_BUFFER_PER_UID
:
5158 struct buffer_reg_uid
*reg
;
5160 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5161 struct buffer_reg_channel
*reg_chan
;
5163 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5164 reg_chan
, node
.node
) {
5165 ret
+= reg_chan
->stream_count
;
5170 case LTTNG_BUFFER_PER_PID
:
5173 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5174 struct ust_app_channel
*ua_chan
;
5175 struct ust_app_session
*ua_sess
;
5176 struct lttng_ht_iter chan_iter
;
5178 ua_sess
= lookup_session_by_app(usess
, app
);
5180 /* Session not associated with this app. */
5184 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5185 ua_chan
, node
.node
) {
5186 ret
+= ua_chan
->streams
.count
;