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
);
290 if (ua_event
->exclusion
!= NULL
)
291 free(ua_event
->exclusion
);
292 if (ua_event
->obj
!= NULL
) {
293 ret
= ustctl_release_object(sock
, ua_event
->obj
);
294 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
295 ERR("UST app sock %d release event obj failed with ret %d",
304 * Release ust data object of the given stream.
306 * Return 0 on success or else a negative value.
308 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
315 ret
= ustctl_release_object(sock
, stream
->obj
);
316 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
317 ERR("UST app sock %d release stream obj failed with ret %d",
320 lttng_fd_put(LTTNG_FD_APPS
, 2);
328 * Delete ust app stream safely. RCU read lock must be held before calling
332 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
336 (void) release_ust_app_stream(sock
, stream
);
341 * We need to execute ht_destroy outside of RCU read-side critical
342 * section and outside of call_rcu thread, so we postpone its execution
343 * using ht_cleanup_push. It is simpler than to change the semantic of
344 * the many callers of delete_ust_app_session().
347 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
349 struct ust_app_channel
*ua_chan
=
350 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
352 ht_cleanup_push(ua_chan
->ctx
);
353 ht_cleanup_push(ua_chan
->events
);
358 * Delete ust app channel safely. RCU read lock must be held before calling
362 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
366 struct lttng_ht_iter iter
;
367 struct ust_app_event
*ua_event
;
368 struct ust_app_ctx
*ua_ctx
;
369 struct ust_app_stream
*stream
, *stmp
;
370 struct ust_registry_session
*registry
;
374 DBG3("UST app deleting channel %s", ua_chan
->name
);
377 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
378 cds_list_del(&stream
->list
);
379 delete_ust_app_stream(sock
, stream
);
383 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
384 cds_list_del(&ua_ctx
->list
);
385 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
387 delete_ust_app_ctx(sock
, ua_ctx
);
391 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
393 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
395 delete_ust_app_event(sock
, ua_event
);
398 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
399 /* Wipe and free registry from session registry. */
400 registry
= get_session_registry(ua_chan
->session
);
402 ust_registry_channel_del_free(registry
, ua_chan
->key
);
406 if (ua_chan
->obj
!= NULL
) {
407 /* Remove channel from application UST object descriptor. */
408 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
409 lttng_ht_del(app
->ust_objd
, &iter
);
410 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
411 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
412 ERR("UST app sock %d release channel obj failed with ret %d",
415 lttng_fd_put(LTTNG_FD_APPS
, 1);
418 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
422 * Push metadata to consumer socket.
424 * The socket lock MUST be acquired.
425 * The ust app session lock MUST be acquired.
427 * On success, return the len of metadata pushed or else a negative value.
429 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
430 struct consumer_socket
*socket
, int send_zero_data
)
433 char *metadata_str
= NULL
;
441 * On a push metadata error either the consumer is dead or the metadata
442 * channel has been destroyed because its endpoint might have died (e.g:
443 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
444 * metadata again which is not valid anymore on the consumer side.
446 * The ust app session mutex locked allows us to make this check without
449 if (registry
->metadata_closed
) {
453 pthread_mutex_lock(®istry
->lock
);
455 offset
= registry
->metadata_len_sent
;
456 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
458 DBG3("No metadata to push for metadata key %" PRIu64
,
459 registry
->metadata_key
);
461 if (send_zero_data
) {
462 DBG("No metadata to push");
468 /* Allocate only what we have to send. */
469 metadata_str
= zmalloc(len
);
471 PERROR("zmalloc ust app metadata string");
475 /* Copy what we haven't send out. */
476 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
477 registry
->metadata_len_sent
+= len
;
480 pthread_mutex_unlock(®istry
->lock
);
481 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
482 metadata_str
, len
, offset
);
493 pthread_mutex_unlock(®istry
->lock
);
500 * For a given application and session, push metadata to consumer. The session
501 * lock MUST be acquired here before calling this.
502 * Either sock or consumer is required : if sock is NULL, the default
503 * socket to send the metadata is retrieved from consumer, if sock
504 * is not NULL we use it to send the metadata.
506 * Return 0 on success else a negative error.
508 static int push_metadata(struct ust_registry_session
*registry
,
509 struct consumer_output
*consumer
)
513 struct consumer_socket
*socket
;
521 * Means that no metadata was assigned to the session. This can happens if
522 * no start has been done previously.
524 if (!registry
->metadata_key
) {
529 /* Get consumer socket to use to push the metadata.*/
530 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
534 goto error_rcu_unlock
;
538 * TODO: Currently, we hold the socket lock around sampling of the next
539 * metadata segment to ensure we send metadata over the consumer socket in
540 * the correct order. This makes the registry lock nest inside the socket
543 * Please note that this is a temporary measure: we should move this lock
544 * back into ust_consumer_push_metadata() when the consumer gets the
545 * ability to reorder the metadata it receives.
547 pthread_mutex_lock(socket
->lock
);
548 ret
= ust_app_push_metadata(registry
, socket
, 0);
549 pthread_mutex_unlock(socket
->lock
);
552 goto error_rcu_unlock
;
560 * On error, flag the registry that the metadata is closed. We were unable
561 * to push anything and this means that either the consumer is not
562 * responding or the metadata cache has been destroyed on the consumer.
564 registry
->metadata_closed
= 1;
571 * Send to the consumer a close metadata command for the given session. Once
572 * done, the metadata channel is deleted and the session metadata pointer is
573 * nullified. The session lock MUST be acquired here unless the application is
574 * in the destroy path.
576 * Return 0 on success else a negative value.
578 static int close_metadata(struct ust_registry_session
*registry
,
579 struct consumer_output
*consumer
)
582 struct consumer_socket
*socket
;
589 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
594 /* Get consumer socket to use to push the metadata.*/
595 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
602 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
609 * Metadata closed. Even on error this means that the consumer is not
610 * responding or not found so either way a second close should NOT be emit
613 registry
->metadata_closed
= 1;
620 * We need to execute ht_destroy outside of RCU read-side critical
621 * section and outside of call_rcu thread, so we postpone its execution
622 * using ht_cleanup_push. It is simpler than to change the semantic of
623 * the many callers of delete_ust_app_session().
626 void delete_ust_app_session_rcu(struct rcu_head
*head
)
628 struct ust_app_session
*ua_sess
=
629 caa_container_of(head
, struct ust_app_session
, rcu_head
);
631 ht_cleanup_push(ua_sess
->channels
);
636 * Delete ust app session safely. RCU read lock must be held before calling
640 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
644 struct lttng_ht_iter iter
;
645 struct ust_app_channel
*ua_chan
;
646 struct ust_registry_session
*registry
;
650 pthread_mutex_lock(&ua_sess
->lock
);
652 registry
= get_session_registry(ua_sess
);
653 if (registry
&& !registry
->metadata_closed
) {
654 /* Push metadata for application before freeing the application. */
655 (void) push_metadata(registry
, ua_sess
->consumer
);
658 * Don't ask to close metadata for global per UID buffers. Close
659 * metadata only on destroy trace session in this case. Also, the
660 * previous push metadata could have flag the metadata registry to
661 * close so don't send a close command if closed.
663 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
664 !registry
->metadata_closed
) {
665 /* And ask to close it for this session registry. */
666 (void) close_metadata(registry
, ua_sess
->consumer
);
670 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
672 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
674 delete_ust_app_channel(sock
, ua_chan
, app
);
677 /* In case of per PID, the registry is kept in the session. */
678 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
679 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
681 buffer_reg_pid_remove(reg_pid
);
682 buffer_reg_pid_destroy(reg_pid
);
686 if (ua_sess
->handle
!= -1) {
687 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
688 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
689 ERR("UST app sock %d release session handle failed with ret %d",
693 pthread_mutex_unlock(&ua_sess
->lock
);
695 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
699 * Delete a traceable application structure from the global list. Never call
700 * this function outside of a call_rcu call.
702 * RCU read side lock should _NOT_ be held when calling this function.
705 void delete_ust_app(struct ust_app
*app
)
708 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
710 /* Delete ust app sessions info */
715 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
717 /* Free every object in the session and the session. */
719 delete_ust_app_session(sock
, ua_sess
, app
);
723 ht_cleanup_push(app
->sessions
);
724 ht_cleanup_push(app
->ust_objd
);
727 * Wait until we have deleted the application from the sock hash table
728 * before closing this socket, otherwise an application could re-use the
729 * socket ID and race with the teardown, using the same hash table entry.
731 * It's OK to leave the close in call_rcu. We want it to stay unique for
732 * all RCU readers that could run concurrently with unregister app,
733 * therefore we _need_ to only close that socket after a grace period. So
734 * it should stay in this RCU callback.
736 * This close() is a very important step of the synchronization model so
737 * every modification to this function must be carefully reviewed.
743 lttng_fd_put(LTTNG_FD_APPS
, 1);
745 DBG2("UST app pid %d deleted", app
->pid
);
750 * URCU intermediate call to delete an UST app.
753 void delete_ust_app_rcu(struct rcu_head
*head
)
755 struct lttng_ht_node_ulong
*node
=
756 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
757 struct ust_app
*app
=
758 caa_container_of(node
, struct ust_app
, pid_n
);
760 DBG3("Call RCU deleting app PID %d", app
->pid
);
765 * Delete the session from the application ht and delete the data structure by
766 * freeing every object inside and releasing them.
768 static void destroy_app_session(struct ust_app
*app
,
769 struct ust_app_session
*ua_sess
)
772 struct lttng_ht_iter iter
;
777 iter
.iter
.node
= &ua_sess
->node
.node
;
778 ret
= lttng_ht_del(app
->sessions
, &iter
);
780 /* Already scheduled for teardown. */
784 /* Once deleted, free the data structure. */
785 delete_ust_app_session(app
->sock
, ua_sess
, app
);
792 * Alloc new UST app session.
795 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
797 struct ust_app_session
*ua_sess
;
799 /* Init most of the default value by allocating and zeroing */
800 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
801 if (ua_sess
== NULL
) {
806 ua_sess
->handle
= -1;
807 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
808 pthread_mutex_init(&ua_sess
->lock
, NULL
);
817 * Alloc new UST app channel.
820 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
821 struct ust_app_session
*ua_sess
,
822 struct lttng_ust_channel_attr
*attr
)
824 struct ust_app_channel
*ua_chan
;
826 /* Init most of the default value by allocating and zeroing */
827 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
828 if (ua_chan
== NULL
) {
833 /* Setup channel name */
834 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
835 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
837 ua_chan
->enabled
= 1;
838 ua_chan
->handle
= -1;
839 ua_chan
->session
= ua_sess
;
840 ua_chan
->key
= get_next_channel_key();
841 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
842 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
843 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
845 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
846 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
848 /* Copy attributes */
850 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
851 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
852 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
853 ua_chan
->attr
.overwrite
= attr
->overwrite
;
854 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
855 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
856 ua_chan
->attr
.output
= attr
->output
;
858 /* By default, the channel is a per cpu channel. */
859 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
861 DBG3("UST app channel %s allocated", ua_chan
->name
);
870 * Allocate and initialize a UST app stream.
872 * Return newly allocated stream pointer or NULL on error.
874 struct ust_app_stream
*ust_app_alloc_stream(void)
876 struct ust_app_stream
*stream
= NULL
;
878 stream
= zmalloc(sizeof(*stream
));
879 if (stream
== NULL
) {
880 PERROR("zmalloc ust app stream");
884 /* Zero could be a valid value for a handle so flag it to -1. */
892 * Alloc new UST app event.
895 struct ust_app_event
*alloc_ust_app_event(char *name
,
896 struct lttng_ust_event
*attr
)
898 struct ust_app_event
*ua_event
;
900 /* Init most of the default value by allocating and zeroing */
901 ua_event
= zmalloc(sizeof(struct ust_app_event
));
902 if (ua_event
== NULL
) {
907 ua_event
->enabled
= 1;
908 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
909 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
910 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
912 /* Copy attributes */
914 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
917 DBG3("UST app event %s allocated", ua_event
->name
);
926 * Alloc new UST app context.
929 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
931 struct ust_app_ctx
*ua_ctx
;
933 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
934 if (ua_ctx
== NULL
) {
938 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
941 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
944 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
951 * Allocate a filter and copy the given original filter.
953 * Return allocated filter or NULL on error.
955 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
956 struct lttng_ust_filter_bytecode
*orig_f
)
958 struct lttng_ust_filter_bytecode
*filter
= NULL
;
960 /* Copy filter bytecode */
961 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
963 PERROR("zmalloc alloc ust app filter");
967 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
974 * Find an ust_app using the sock and return it. RCU read side lock must be
975 * held before calling this helper function.
977 struct ust_app
*ust_app_find_by_sock(int sock
)
979 struct lttng_ht_node_ulong
*node
;
980 struct lttng_ht_iter iter
;
982 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
983 node
= lttng_ht_iter_get_node_ulong(&iter
);
985 DBG2("UST app find by sock %d not found", sock
);
989 return caa_container_of(node
, struct ust_app
, sock_n
);
996 * Find an ust_app using the notify sock and return it. RCU read side lock must
997 * be held before calling this helper function.
999 static struct ust_app
*find_app_by_notify_sock(int sock
)
1001 struct lttng_ht_node_ulong
*node
;
1002 struct lttng_ht_iter iter
;
1004 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1006 node
= lttng_ht_iter_get_node_ulong(&iter
);
1008 DBG2("UST app find by notify sock %d not found", sock
);
1012 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1019 * Lookup for an ust app event based on event name, filter bytecode and the
1022 * Return an ust_app_event object or NULL on error.
1024 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1025 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1026 const struct lttng_event_exclusion
*exclusion
)
1028 struct lttng_ht_iter iter
;
1029 struct lttng_ht_node_str
*node
;
1030 struct ust_app_event
*event
= NULL
;
1031 struct ust_app_ht_key key
;
1036 /* Setup key for event lookup. */
1038 key
.filter
= filter
;
1039 key
.loglevel
= loglevel
;
1040 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1041 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1043 /* Lookup using the event name as hash and a custom match fct. */
1044 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1045 ht_match_ust_app_event
, &key
, &iter
.iter
);
1046 node
= lttng_ht_iter_get_node_str(&iter
);
1051 event
= caa_container_of(node
, struct ust_app_event
, node
);
1058 * Create the channel context on the tracer.
1060 * Called with UST app session lock held.
1063 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1064 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1068 health_code_update();
1070 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1071 ua_chan
->obj
, &ua_ctx
->obj
);
1073 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1074 ERR("UST app create channel context failed for app (pid: %d) "
1075 "with ret %d", app
->pid
, ret
);
1078 * This is normal behavior, an application can die during the
1079 * creation process. Don't report an error so the execution can
1080 * continue normally.
1083 DBG3("UST app disable event failed. Application is dead.");
1088 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1090 DBG2("UST app context handle %d created successfully for channel %s",
1091 ua_ctx
->handle
, ua_chan
->name
);
1094 health_code_update();
1099 * Set the filter on the tracer.
1102 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1103 struct ust_app
*app
)
1107 health_code_update();
1109 if (!ua_event
->filter
) {
1114 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1117 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1118 ERR("UST app event %s filter failed for app (pid: %d) "
1119 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1122 * This is normal behavior, an application can die during the
1123 * creation process. Don't report an error so the execution can
1124 * continue normally.
1127 DBG3("UST app filter event failed. Application is dead.");
1132 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1135 health_code_update();
1140 * Disable the specified event on to UST tracer for the UST session.
1142 static int disable_ust_event(struct ust_app
*app
,
1143 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1147 health_code_update();
1149 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1151 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1152 ERR("UST app event %s disable failed for app (pid: %d) "
1153 "and session handle %d with ret %d",
1154 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1157 * This is normal behavior, an application can die during the
1158 * creation process. Don't report an error so the execution can
1159 * continue normally.
1162 DBG3("UST app disable event failed. Application is dead.");
1167 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1168 ua_event
->attr
.name
, app
->pid
);
1171 health_code_update();
1176 * Disable the specified channel on to UST tracer for the UST session.
1178 static int disable_ust_channel(struct ust_app
*app
,
1179 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1183 health_code_update();
1185 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1187 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1188 ERR("UST app channel %s disable failed for app (pid: %d) "
1189 "and session handle %d with ret %d",
1190 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1193 * This is normal behavior, an application can die during the
1194 * creation process. Don't report an error so the execution can
1195 * continue normally.
1198 DBG3("UST app disable channel failed. Application is dead.");
1203 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1204 ua_chan
->name
, app
->pid
);
1207 health_code_update();
1212 * Enable the specified channel on to UST tracer for the UST session.
1214 static int enable_ust_channel(struct ust_app
*app
,
1215 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1219 health_code_update();
1221 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1223 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1224 ERR("UST app channel %s enable failed for app (pid: %d) "
1225 "and session handle %d with ret %d",
1226 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1229 * This is normal behavior, an application can die during the
1230 * creation process. Don't report an error so the execution can
1231 * continue normally.
1234 DBG3("UST app enable channel failed. Application is dead.");
1239 ua_chan
->enabled
= 1;
1241 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1242 ua_chan
->name
, app
->pid
);
1245 health_code_update();
1250 * Enable the specified event on to UST tracer for the UST session.
1252 static int enable_ust_event(struct ust_app
*app
,
1253 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1257 health_code_update();
1259 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1261 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1262 ERR("UST app event %s enable failed for app (pid: %d) "
1263 "and session handle %d with ret %d",
1264 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1267 * This is normal behavior, an application can die during the
1268 * creation process. Don't report an error so the execution can
1269 * continue normally.
1272 DBG3("UST app enable event failed. Application is dead.");
1277 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1278 ua_event
->attr
.name
, app
->pid
);
1281 health_code_update();
1286 * Send channel and stream buffer to application.
1288 * Return 0 on success. On error, a negative value is returned.
1290 static int send_channel_pid_to_ust(struct ust_app
*app
,
1291 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1294 struct ust_app_stream
*stream
, *stmp
;
1300 health_code_update();
1302 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1305 /* Send channel to the application. */
1306 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1311 health_code_update();
1313 /* Send all streams to application. */
1314 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1315 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1319 /* We don't need the stream anymore once sent to the tracer. */
1320 cds_list_del(&stream
->list
);
1321 delete_ust_app_stream(-1, stream
);
1323 /* Flag the channel that it is sent to the application. */
1324 ua_chan
->is_sent
= 1;
1327 health_code_update();
1332 * Create the specified event onto the UST tracer for a UST session.
1334 * Should be called with session mutex held.
1337 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1338 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1342 health_code_update();
1344 /* Create UST event on tracer */
1345 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1348 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1349 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1350 ua_event
->attr
.name
, app
->pid
, ret
);
1353 * This is normal behavior, an application can die during the
1354 * creation process. Don't report an error so the execution can
1355 * continue normally.
1358 DBG3("UST app create event failed. Application is dead.");
1363 ua_event
->handle
= ua_event
->obj
->handle
;
1365 DBG2("UST app event %s created successfully for pid:%d",
1366 ua_event
->attr
.name
, app
->pid
);
1368 health_code_update();
1370 /* Set filter if one is present. */
1371 if (ua_event
->filter
) {
1372 ret
= set_ust_event_filter(ua_event
, app
);
1378 /* If event not enabled, disable it on the tracer */
1379 if (ua_event
->enabled
== 0) {
1380 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1383 * If we hit an EPERM, something is wrong with our disable call. If
1384 * we get an EEXIST, there is a problem on the tracer side since we
1388 case -LTTNG_UST_ERR_PERM
:
1389 /* Code flow problem */
1391 case -LTTNG_UST_ERR_EXIST
:
1392 /* It's OK for our use case. */
1403 health_code_update();
1408 * Copy data between an UST app event and a LTT event.
1410 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1411 struct ltt_ust_event
*uevent
)
1413 size_t exclusion_alloc_size
;
1415 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1416 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1418 ua_event
->enabled
= uevent
->enabled
;
1420 /* Copy event attributes */
1421 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1423 /* Copy filter bytecode */
1424 if (uevent
->filter
) {
1425 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1426 /* Filter might be NULL here in case of ENONEM. */
1429 /* Copy exclusion data */
1430 if (uevent
->exclusion
) {
1431 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1432 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1433 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1434 if (ua_event
->exclusion
) {
1435 memcpy(ua_event
->exclusion
, uevent
->exclusion
, exclusion_alloc_size
);
1441 * Copy data between an UST app channel and a LTT channel.
1443 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1444 struct ltt_ust_channel
*uchan
)
1446 struct lttng_ht_iter iter
;
1447 struct ltt_ust_event
*uevent
;
1448 struct ltt_ust_context
*uctx
;
1449 struct ust_app_event
*ua_event
;
1450 struct ust_app_ctx
*ua_ctx
;
1452 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1454 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1455 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1457 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1458 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1460 /* Copy event attributes since the layout is different. */
1461 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1462 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1463 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1464 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1465 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1466 ua_chan
->attr
.output
= uchan
->attr
.output
;
1468 * Note that the attribute channel type is not set since the channel on the
1469 * tracing registry side does not have this information.
1472 ua_chan
->enabled
= uchan
->enabled
;
1473 ua_chan
->tracing_channel_id
= uchan
->id
;
1475 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1476 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1477 if (ua_ctx
== NULL
) {
1480 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1481 (unsigned long) ua_ctx
->ctx
.ctx
);
1482 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1483 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1486 /* Copy all events from ltt ust channel to ust app channel */
1487 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1488 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1489 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1490 if (ua_event
== NULL
) {
1491 DBG2("UST event %s not found on shadow copy channel",
1493 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1494 if (ua_event
== NULL
) {
1497 shadow_copy_event(ua_event
, uevent
);
1498 add_unique_ust_app_event(ua_chan
, ua_event
);
1502 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1506 * Copy data between a UST app session and a regular LTT session.
1508 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1509 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1511 struct lttng_ht_node_str
*ua_chan_node
;
1512 struct lttng_ht_iter iter
;
1513 struct ltt_ust_channel
*uchan
;
1514 struct ust_app_channel
*ua_chan
;
1516 struct tm
*timeinfo
;
1520 /* Get date and time for unique app path */
1522 timeinfo
= localtime(&rawtime
);
1523 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1525 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1527 ua_sess
->tracing_id
= usess
->id
;
1528 ua_sess
->id
= get_next_session_id();
1529 ua_sess
->uid
= app
->uid
;
1530 ua_sess
->gid
= app
->gid
;
1531 ua_sess
->euid
= usess
->uid
;
1532 ua_sess
->egid
= usess
->gid
;
1533 ua_sess
->buffer_type
= usess
->buffer_type
;
1534 ua_sess
->bits_per_long
= app
->bits_per_long
;
1535 /* There is only one consumer object per session possible. */
1536 ua_sess
->consumer
= usess
->consumer
;
1537 ua_sess
->output_traces
= usess
->output_traces
;
1538 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1540 switch (ua_sess
->buffer_type
) {
1541 case LTTNG_BUFFER_PER_PID
:
1542 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1543 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1546 case LTTNG_BUFFER_PER_UID
:
1547 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1548 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1555 PERROR("asprintf UST shadow copy session");
1560 /* Iterate over all channels in global domain. */
1561 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1563 struct lttng_ht_iter uiter
;
1565 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1566 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1567 if (ua_chan_node
!= NULL
) {
1568 /* Session exist. Contiuing. */
1572 DBG2("Channel %s not found on shadow session copy, creating it",
1574 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1575 if (ua_chan
== NULL
) {
1576 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1579 shadow_copy_channel(ua_chan
, uchan
);
1581 * The concept of metadata channel does not exist on the tracing
1582 * registry side of the session daemon so this can only be a per CPU
1583 * channel and not metadata.
1585 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1587 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1595 * Lookup sesison wrapper.
1598 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1599 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1601 /* Get right UST app session from app */
1602 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1606 * Return ust app session from the app session hashtable using the UST session
1609 static struct ust_app_session
*lookup_session_by_app(
1610 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1612 struct lttng_ht_iter iter
;
1613 struct lttng_ht_node_u64
*node
;
1615 __lookup_session_by_app(usess
, app
, &iter
);
1616 node
= lttng_ht_iter_get_node_u64(&iter
);
1621 return caa_container_of(node
, struct ust_app_session
, node
);
1628 * Setup buffer registry per PID for the given session and application. If none
1629 * is found, a new one is created, added to the global registry and
1630 * initialized. If regp is valid, it's set with the newly created object.
1632 * Return 0 on success or else a negative value.
1634 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1635 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1638 struct buffer_reg_pid
*reg_pid
;
1645 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1648 * This is the create channel path meaning that if there is NO
1649 * registry available, we have to create one for this session.
1651 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1655 buffer_reg_pid_add(reg_pid
);
1660 /* Initialize registry. */
1661 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1662 app
->bits_per_long
, app
->uint8_t_alignment
,
1663 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1664 app
->uint64_t_alignment
, app
->long_alignment
,
1665 app
->byte_order
, app
->version
.major
,
1666 app
->version
.minor
);
1671 DBG3("UST app buffer registry per PID created successfully");
1683 * Setup buffer registry per UID for the given session and application. If none
1684 * is found, a new one is created, added to the global registry and
1685 * initialized. If regp is valid, it's set with the newly created object.
1687 * Return 0 on success or else a negative value.
1689 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1690 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1693 struct buffer_reg_uid
*reg_uid
;
1700 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1703 * This is the create channel path meaning that if there is NO
1704 * registry available, we have to create one for this session.
1706 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1707 LTTNG_DOMAIN_UST
, ®_uid
);
1711 buffer_reg_uid_add(reg_uid
);
1716 /* Initialize registry. */
1717 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1718 app
->bits_per_long
, app
->uint8_t_alignment
,
1719 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1720 app
->uint64_t_alignment
, app
->long_alignment
,
1721 app
->byte_order
, app
->version
.major
,
1722 app
->version
.minor
);
1726 /* Add node to teardown list of the session. */
1727 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1729 DBG3("UST app buffer registry per UID created successfully");
1741 * Create a session on the tracer side for the given app.
1743 * On success, ua_sess_ptr is populated with the session pointer or else left
1744 * untouched. If the session was created, is_created is set to 1. On error,
1745 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1748 * Returns 0 on success or else a negative code which is either -ENOMEM or
1749 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1751 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1752 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1755 int ret
, created
= 0;
1756 struct ust_app_session
*ua_sess
;
1760 assert(ua_sess_ptr
);
1762 health_code_update();
1764 ua_sess
= lookup_session_by_app(usess
, app
);
1765 if (ua_sess
== NULL
) {
1766 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1767 app
->pid
, usess
->id
);
1768 ua_sess
= alloc_ust_app_session(app
);
1769 if (ua_sess
== NULL
) {
1770 /* Only malloc can failed so something is really wrong */
1774 shadow_copy_session(ua_sess
, usess
, app
);
1778 switch (usess
->buffer_type
) {
1779 case LTTNG_BUFFER_PER_PID
:
1780 /* Init local registry. */
1781 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1786 case LTTNG_BUFFER_PER_UID
:
1787 /* Look for a global registry. If none exists, create one. */
1788 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1799 health_code_update();
1801 if (ua_sess
->handle
== -1) {
1802 ret
= ustctl_create_session(app
->sock
);
1804 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1805 ERR("Creating session for app pid %d with ret %d",
1808 DBG("UST app creating session failed. Application is dead");
1810 * This is normal behavior, an application can die during the
1811 * creation process. Don't report an error so the execution can
1812 * continue normally. This will get flagged ENOTCONN and the
1813 * caller will handle it.
1817 delete_ust_app_session(-1, ua_sess
, app
);
1818 if (ret
!= -ENOMEM
) {
1820 * Tracer is probably gone or got an internal error so let's
1821 * behave like it will soon unregister or not usable.
1828 ua_sess
->handle
= ret
;
1830 /* Add ust app session to app's HT */
1831 lttng_ht_node_init_u64(&ua_sess
->node
,
1832 ua_sess
->tracing_id
);
1833 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1835 DBG2("UST app session created successfully with handle %d", ret
);
1838 *ua_sess_ptr
= ua_sess
;
1840 *is_created
= created
;
1843 /* Everything went well. */
1847 health_code_update();
1852 * Create a context for the channel on the tracer.
1854 * Called with UST app session lock held and a RCU read side lock.
1857 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1858 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1859 struct ust_app
*app
)
1862 struct lttng_ht_iter iter
;
1863 struct lttng_ht_node_ulong
*node
;
1864 struct ust_app_ctx
*ua_ctx
;
1866 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1868 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1869 node
= lttng_ht_iter_get_node_ulong(&iter
);
1875 ua_ctx
= alloc_ust_app_ctx(uctx
);
1876 if (ua_ctx
== NULL
) {
1882 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1883 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1884 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1886 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1896 * Enable on the tracer side a ust app event for the session and channel.
1898 * Called with UST app session lock held.
1901 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1902 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1906 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1911 ua_event
->enabled
= 1;
1918 * Disable on the tracer side a ust app event for the session and channel.
1920 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1921 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1925 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1930 ua_event
->enabled
= 0;
1937 * Lookup ust app channel for session and disable it on the tracer side.
1940 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1941 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1945 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1950 ua_chan
->enabled
= 0;
1957 * Lookup ust app channel for session and enable it on the tracer side. This
1958 * MUST be called with a RCU read side lock acquired.
1960 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1961 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1964 struct lttng_ht_iter iter
;
1965 struct lttng_ht_node_str
*ua_chan_node
;
1966 struct ust_app_channel
*ua_chan
;
1968 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1969 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1970 if (ua_chan_node
== NULL
) {
1971 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1972 uchan
->name
, ua_sess
->tracing_id
);
1976 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1978 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1988 * Ask the consumer to create a channel and get it if successful.
1990 * Return 0 on success or else a negative value.
1992 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1993 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1994 int bitness
, struct ust_registry_session
*registry
)
1997 unsigned int nb_fd
= 0;
1998 struct consumer_socket
*socket
;
2006 health_code_update();
2008 /* Get the right consumer socket for the application. */
2009 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2015 health_code_update();
2017 /* Need one fd for the channel. */
2018 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2020 ERR("Exhausted number of available FD upon create channel");
2025 * Ask consumer to create channel. The consumer will return the number of
2026 * stream we have to expect.
2028 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2035 * Compute the number of fd needed before receiving them. It must be 2 per
2036 * stream (2 being the default value here).
2038 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2040 /* Reserve the amount of file descriptor we need. */
2041 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2043 ERR("Exhausted number of available FD upon create channel");
2044 goto error_fd_get_stream
;
2047 health_code_update();
2050 * Now get the channel from the consumer. This call wil populate the stream
2051 * list of that channel and set the ust objects.
2053 if (usess
->consumer
->enabled
) {
2054 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2064 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2065 error_fd_get_stream
:
2067 * Initiate a destroy channel on the consumer since we had an error
2068 * handling it on our side. The return value is of no importance since we
2069 * already have a ret value set by the previous error that we need to
2072 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2074 lttng_fd_put(LTTNG_FD_APPS
, 1);
2076 health_code_update();
2082 * Duplicate the ust data object of the ust app stream and save it in the
2083 * buffer registry stream.
2085 * Return 0 on success or else a negative value.
2087 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2088 struct ust_app_stream
*stream
)
2095 /* Reserve the amount of file descriptor we need. */
2096 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2098 ERR("Exhausted number of available FD upon duplicate stream");
2102 /* Duplicate object for stream once the original is in the registry. */
2103 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2104 reg_stream
->obj
.ust
);
2106 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2107 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2108 lttng_fd_put(LTTNG_FD_APPS
, 2);
2111 stream
->handle
= stream
->obj
->handle
;
2118 * Duplicate the ust data object of the ust app. channel and save it in the
2119 * buffer registry channel.
2121 * Return 0 on success or else a negative value.
2123 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2124 struct ust_app_channel
*ua_chan
)
2131 /* Need two fds for the channel. */
2132 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2134 ERR("Exhausted number of available FD upon duplicate channel");
2138 /* Duplicate object for stream once the original is in the registry. */
2139 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2141 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2142 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2145 ua_chan
->handle
= ua_chan
->obj
->handle
;
2150 lttng_fd_put(LTTNG_FD_APPS
, 1);
2156 * For a given channel buffer registry, setup all streams of the given ust
2157 * application channel.
2159 * Return 0 on success or else a negative value.
2161 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2162 struct ust_app_channel
*ua_chan
)
2165 struct ust_app_stream
*stream
, *stmp
;
2170 DBG2("UST app setup buffer registry stream");
2172 /* Send all streams to application. */
2173 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2174 struct buffer_reg_stream
*reg_stream
;
2176 ret
= buffer_reg_stream_create(®_stream
);
2182 * Keep original pointer and nullify it in the stream so the delete
2183 * stream call does not release the object.
2185 reg_stream
->obj
.ust
= stream
->obj
;
2187 buffer_reg_stream_add(reg_stream
, reg_chan
);
2189 /* We don't need the streams anymore. */
2190 cds_list_del(&stream
->list
);
2191 delete_ust_app_stream(-1, stream
);
2199 * Create a buffer registry channel for the given session registry and
2200 * application channel object. If regp pointer is valid, it's set with the
2201 * created object. Important, the created object is NOT added to the session
2202 * registry hash table.
2204 * Return 0 on success else a negative value.
2206 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2207 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2210 struct buffer_reg_channel
*reg_chan
= NULL
;
2215 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2217 /* Create buffer registry channel. */
2218 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2223 reg_chan
->consumer_key
= ua_chan
->key
;
2224 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2226 /* Create and add a channel registry to session. */
2227 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2228 ua_chan
->tracing_channel_id
);
2232 buffer_reg_channel_add(reg_sess
, reg_chan
);
2241 /* Safe because the registry channel object was not added to any HT. */
2242 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2248 * Setup buffer registry channel for the given session registry and application
2249 * channel object. If regp pointer is valid, it's set with the created object.
2251 * Return 0 on success else a negative value.
2253 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2254 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2261 assert(ua_chan
->obj
);
2263 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2265 /* Setup all streams for the registry. */
2266 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2271 reg_chan
->obj
.ust
= ua_chan
->obj
;
2272 ua_chan
->obj
= NULL
;
2277 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2278 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2283 * Send buffer registry channel to the application.
2285 * Return 0 on success else a negative value.
2287 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2288 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2289 struct ust_app_channel
*ua_chan
)
2292 struct buffer_reg_stream
*reg_stream
;
2299 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2301 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2306 /* Send channel to the application. */
2307 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2312 health_code_update();
2314 /* Send all streams to application. */
2315 pthread_mutex_lock(®_chan
->stream_list_lock
);
2316 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2317 struct ust_app_stream stream
;
2319 ret
= duplicate_stream_object(reg_stream
, &stream
);
2321 goto error_stream_unlock
;
2324 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2326 (void) release_ust_app_stream(-1, &stream
);
2327 goto error_stream_unlock
;
2331 * The return value is not important here. This function will output an
2334 (void) release_ust_app_stream(-1, &stream
);
2336 ua_chan
->is_sent
= 1;
2338 error_stream_unlock
:
2339 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2345 * Create and send to the application the created buffers with per UID buffers.
2347 * Return 0 on success else a negative value.
2349 static int create_channel_per_uid(struct ust_app
*app
,
2350 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2351 struct ust_app_channel
*ua_chan
)
2354 struct buffer_reg_uid
*reg_uid
;
2355 struct buffer_reg_channel
*reg_chan
;
2362 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2364 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2366 * The session creation handles the creation of this global registry
2367 * object. If none can be find, there is a code flow problem or a
2372 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2375 /* Create the buffer registry channel object. */
2376 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2383 * Create the buffers on the consumer side. This call populates the
2384 * ust app channel object with all streams and data object.
2386 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2387 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2390 * Let's remove the previously created buffer registry channel so
2391 * it's not visible anymore in the session registry.
2393 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2394 ua_chan
->tracing_channel_id
);
2395 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2396 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2401 * Setup the streams and add it to the session registry.
2403 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2410 /* Send buffers to the application. */
2411 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2421 * Create and send to the application the created buffers with per PID buffers.
2423 * Return 0 on success else a negative value.
2425 static int create_channel_per_pid(struct ust_app
*app
,
2426 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2427 struct ust_app_channel
*ua_chan
)
2430 struct ust_registry_session
*registry
;
2437 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2441 registry
= get_session_registry(ua_sess
);
2444 /* Create and add a new channel registry to session. */
2445 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2450 /* Create and get channel on the consumer side. */
2451 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2452 app
->bits_per_long
, registry
);
2457 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2468 * From an already allocated ust app channel, create the channel buffers if
2469 * need and send it to the application. This MUST be called with a RCU read
2470 * side lock acquired.
2472 * Return 0 on success or else a negative value.
2474 static int do_create_channel(struct ust_app
*app
,
2475 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2476 struct ust_app_channel
*ua_chan
)
2485 /* Handle buffer type before sending the channel to the application. */
2486 switch (usess
->buffer_type
) {
2487 case LTTNG_BUFFER_PER_UID
:
2489 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2495 case LTTNG_BUFFER_PER_PID
:
2497 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2509 /* Initialize ust objd object using the received handle and add it. */
2510 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2511 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2513 /* If channel is not enabled, disable it on the tracer */
2514 if (!ua_chan
->enabled
) {
2515 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2526 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2527 * newly created channel if not NULL.
2529 * Called with UST app session lock and RCU read-side lock held.
2531 * Return 0 on success or else a negative value.
2533 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2534 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2535 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2536 struct ust_app_channel
**ua_chanp
)
2539 struct lttng_ht_iter iter
;
2540 struct lttng_ht_node_str
*ua_chan_node
;
2541 struct ust_app_channel
*ua_chan
;
2543 /* Lookup channel in the ust app session */
2544 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2545 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2546 if (ua_chan_node
!= NULL
) {
2547 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2551 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2552 if (ua_chan
== NULL
) {
2553 /* Only malloc can fail here */
2557 shadow_copy_channel(ua_chan
, uchan
);
2559 /* Set channel type. */
2560 ua_chan
->attr
.type
= type
;
2562 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2567 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2570 /* Only add the channel if successful on the tracer side. */
2571 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2575 *ua_chanp
= ua_chan
;
2578 /* Everything went well. */
2582 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2588 * Create UST app event and create it on the tracer side.
2590 * Called with ust app session mutex held.
2593 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2594 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2595 struct ust_app
*app
)
2598 struct ust_app_event
*ua_event
;
2600 /* Get event node */
2601 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2602 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2603 if (ua_event
!= NULL
) {
2608 /* Does not exist so create one */
2609 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2610 if (ua_event
== NULL
) {
2611 /* Only malloc can failed so something is really wrong */
2615 shadow_copy_event(ua_event
, uevent
);
2617 /* Create it on the tracer side */
2618 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2620 /* Not found previously means that it does not exist on the tracer */
2621 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2625 add_unique_ust_app_event(ua_chan
, ua_event
);
2627 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2634 /* Valid. Calling here is already in a read side lock */
2635 delete_ust_app_event(-1, ua_event
);
2640 * Create UST metadata and open it on the tracer side.
2642 * Called with UST app session lock held and RCU read side lock.
2644 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2645 struct ust_app
*app
, struct consumer_output
*consumer
,
2646 struct ustctl_consumer_channel_attr
*attr
)
2649 struct ust_app_channel
*metadata
;
2650 struct consumer_socket
*socket
;
2651 struct ust_registry_session
*registry
;
2657 registry
= get_session_registry(ua_sess
);
2660 /* Metadata already exists for this registry or it was closed previously */
2661 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2666 /* Allocate UST metadata */
2667 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2669 /* malloc() failed */
2675 /* Set default attributes for metadata. */
2676 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2677 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2678 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2679 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2680 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2681 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2682 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2684 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2685 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2686 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2689 /* Need one fd for the channel. */
2690 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2692 ERR("Exhausted number of available FD upon create metadata");
2696 /* Get the right consumer socket for the application. */
2697 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2700 goto error_consumer
;
2704 * Keep metadata key so we can identify it on the consumer side. Assign it
2705 * to the registry *before* we ask the consumer so we avoid the race of the
2706 * consumer requesting the metadata and the ask_channel call on our side
2707 * did not returned yet.
2709 registry
->metadata_key
= metadata
->key
;
2712 * Ask the metadata channel creation to the consumer. The metadata object
2713 * will be created by the consumer and kept their. However, the stream is
2714 * never added or monitored until we do a first push metadata to the
2717 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2720 /* Nullify the metadata key so we don't try to close it later on. */
2721 registry
->metadata_key
= 0;
2722 goto error_consumer
;
2726 * The setup command will make the metadata stream be sent to the relayd,
2727 * if applicable, and the thread managing the metadatas. This is important
2728 * because after this point, if an error occurs, the only way the stream
2729 * can be deleted is to be monitored in the consumer.
2731 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2733 /* Nullify the metadata key so we don't try to close it later on. */
2734 registry
->metadata_key
= 0;
2735 goto error_consumer
;
2738 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2739 metadata
->key
, app
->pid
);
2742 lttng_fd_put(LTTNG_FD_APPS
, 1);
2743 delete_ust_app_channel(-1, metadata
, app
);
2749 * Return pointer to traceable apps list.
2751 struct lttng_ht
*ust_app_get_ht(void)
2757 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2758 * acquired before calling this function.
2760 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2762 struct ust_app
*app
= NULL
;
2763 struct lttng_ht_node_ulong
*node
;
2764 struct lttng_ht_iter iter
;
2766 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2767 node
= lttng_ht_iter_get_node_ulong(&iter
);
2769 DBG2("UST app no found with pid %d", pid
);
2773 DBG2("Found UST app by pid %d", pid
);
2775 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2782 * Allocate and init an UST app object using the registration information and
2783 * the command socket. This is called when the command socket connects to the
2786 * The object is returned on success or else NULL.
2788 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2790 struct ust_app
*lta
= NULL
;
2795 DBG3("UST app creating application for socket %d", sock
);
2797 if ((msg
->bits_per_long
== 64 &&
2798 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2799 || (msg
->bits_per_long
== 32 &&
2800 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2801 ERR("Registration failed: application \"%s\" (pid: %d) has "
2802 "%d-bit long, but no consumerd for this size is available.\n",
2803 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2807 lta
= zmalloc(sizeof(struct ust_app
));
2813 lta
->ppid
= msg
->ppid
;
2814 lta
->uid
= msg
->uid
;
2815 lta
->gid
= msg
->gid
;
2817 lta
->bits_per_long
= msg
->bits_per_long
;
2818 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2819 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2820 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2821 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2822 lta
->long_alignment
= msg
->long_alignment
;
2823 lta
->byte_order
= msg
->byte_order
;
2825 lta
->v_major
= msg
->major
;
2826 lta
->v_minor
= msg
->minor
;
2827 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2828 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2829 lta
->notify_sock
= -1;
2831 /* Copy name and make sure it's NULL terminated. */
2832 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2833 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2836 * Before this can be called, when receiving the registration information,
2837 * the application compatibility is checked. So, at this point, the
2838 * application can work with this session daemon.
2840 lta
->compatible
= 1;
2842 lta
->pid
= msg
->pid
;
2843 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2845 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2847 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2854 * For a given application object, add it to every hash table.
2856 void ust_app_add(struct ust_app
*app
)
2859 assert(app
->notify_sock
>= 0);
2864 * On a re-registration, we want to kick out the previous registration of
2867 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2870 * The socket _should_ be unique until _we_ call close. So, a add_unique
2871 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2872 * already in the table.
2874 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2876 /* Add application to the notify socket hash table. */
2877 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2878 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2880 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2881 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2882 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2889 * Set the application version into the object.
2891 * Return 0 on success else a negative value either an errno code or a
2892 * LTTng-UST error code.
2894 int ust_app_version(struct ust_app
*app
)
2900 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2902 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2903 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2905 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2913 * Unregister app by removing it from the global traceable app list and freeing
2916 * The socket is already closed at this point so no close to sock.
2918 void ust_app_unregister(int sock
)
2920 struct ust_app
*lta
;
2921 struct lttng_ht_node_ulong
*node
;
2922 struct lttng_ht_iter iter
;
2923 struct ust_app_session
*ua_sess
;
2928 /* Get the node reference for a call_rcu */
2929 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2930 node
= lttng_ht_iter_get_node_ulong(&iter
);
2933 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2934 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2936 /* Remove application from PID hash table */
2937 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2941 * Remove application from notify hash table. The thread handling the
2942 * notify socket could have deleted the node so ignore on error because
2943 * either way it's valid. The close of that socket is handled by the other
2946 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2947 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2950 * Ignore return value since the node might have been removed before by an
2951 * add replace during app registration because the PID can be reassigned by
2954 iter
.iter
.node
= <a
->pid_n
.node
;
2955 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2957 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2961 /* Remove sessions so they are not visible during deletion.*/
2962 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2964 struct ust_registry_session
*registry
;
2966 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2968 /* The session was already removed so scheduled for teardown. */
2973 * Add session to list for teardown. This is safe since at this point we
2974 * are the only one using this list.
2976 pthread_mutex_lock(&ua_sess
->lock
);
2979 * Normally, this is done in the delete session process which is
2980 * executed in the call rcu below. However, upon registration we can't
2981 * afford to wait for the grace period before pushing data or else the
2982 * data pending feature can race between the unregistration and stop
2983 * command where the data pending command is sent *before* the grace
2986 * The close metadata below nullifies the metadata pointer in the
2987 * session so the delete session will NOT push/close a second time.
2989 registry
= get_session_registry(ua_sess
);
2990 if (registry
&& !registry
->metadata_closed
) {
2991 /* Push metadata for application before freeing the application. */
2992 (void) push_metadata(registry
, ua_sess
->consumer
);
2995 * Don't ask to close metadata for global per UID buffers. Close
2996 * metadata only on destroy trace session in this case. Also, the
2997 * previous push metadata could have flag the metadata registry to
2998 * close so don't send a close command if closed.
3000 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3001 !registry
->metadata_closed
) {
3002 /* And ask to close it for this session registry. */
3003 (void) close_metadata(registry
, ua_sess
->consumer
);
3007 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3008 pthread_mutex_unlock(&ua_sess
->lock
);
3012 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3019 * Return traceable_app_count
3021 unsigned long ust_app_list_count(void)
3023 unsigned long count
;
3026 count
= lttng_ht_get_count(ust_app_ht
);
3033 * Fill events array with all events name of all registered apps.
3035 int ust_app_list_events(struct lttng_event
**events
)
3038 size_t nbmem
, count
= 0;
3039 struct lttng_ht_iter iter
;
3040 struct ust_app
*app
;
3041 struct lttng_event
*tmp_event
;
3043 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3044 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3045 if (tmp_event
== NULL
) {
3046 PERROR("zmalloc ust app events");
3053 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3054 struct lttng_ust_tracepoint_iter uiter
;
3056 health_code_update();
3058 if (!app
->compatible
) {
3060 * TODO: In time, we should notice the caller of this error by
3061 * telling him that this is a version error.
3065 handle
= ustctl_tracepoint_list(app
->sock
);
3067 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3068 ERR("UST app list events getting handle failed for app pid %d",
3074 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3075 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3076 /* Handle ustctl error. */
3079 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3080 ERR("UST app tp list get failed for app %d with ret %d",
3083 DBG3("UST app tp list get failed. Application is dead");
3085 * This is normal behavior, an application can die during the
3086 * creation process. Don't report an error so the execution can
3087 * continue normally. Continue normal execution.
3094 health_code_update();
3095 if (count
>= nbmem
) {
3096 /* In case the realloc fails, we free the memory */
3099 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3102 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3104 PERROR("realloc ust app events");
3111 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3112 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3113 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3114 tmp_event
[count
].pid
= app
->pid
;
3115 tmp_event
[count
].enabled
= -1;
3121 *events
= tmp_event
;
3123 DBG2("UST app list events done (%zu events)", count
);
3128 health_code_update();
3133 * Fill events array with all events name of all registered apps.
3135 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3138 size_t nbmem
, count
= 0;
3139 struct lttng_ht_iter iter
;
3140 struct ust_app
*app
;
3141 struct lttng_event_field
*tmp_event
;
3143 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3144 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3145 if (tmp_event
== NULL
) {
3146 PERROR("zmalloc ust app event fields");
3153 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3154 struct lttng_ust_field_iter uiter
;
3156 health_code_update();
3158 if (!app
->compatible
) {
3160 * TODO: In time, we should notice the caller of this error by
3161 * telling him that this is a version error.
3165 handle
= ustctl_tracepoint_field_list(app
->sock
);
3167 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3168 ERR("UST app list field getting handle failed for app pid %d",
3174 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3175 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3176 /* Handle ustctl error. */
3179 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3180 ERR("UST app tp list field failed for app %d with ret %d",
3183 DBG3("UST app tp list field failed. Application is dead");
3185 * This is normal behavior, an application can die during the
3186 * creation process. Don't report an error so the execution can
3187 * continue normally.
3194 health_code_update();
3195 if (count
>= nbmem
) {
3196 /* In case the realloc fails, we free the memory */
3199 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3202 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3204 PERROR("realloc ust app event fields");
3212 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3213 tmp_event
[count
].type
= uiter
.type
;
3214 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3216 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3217 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3218 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3219 tmp_event
[count
].event
.pid
= app
->pid
;
3220 tmp_event
[count
].event
.enabled
= -1;
3226 *fields
= tmp_event
;
3228 DBG2("UST app list event fields done (%zu events)", count
);
3233 health_code_update();
3238 * Free and clean all traceable apps of the global list.
3240 * Should _NOT_ be called with RCU read-side lock held.
3242 void ust_app_clean_list(void)
3245 struct ust_app
*app
;
3246 struct lttng_ht_iter iter
;
3248 DBG2("UST app cleaning registered apps hash table");
3252 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3253 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3255 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3258 /* Cleanup socket hash table */
3259 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3261 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3265 /* Cleanup notify socket hash table */
3266 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3267 notify_sock_n
.node
) {
3268 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3273 /* Destroy is done only when the ht is empty */
3274 ht_cleanup_push(ust_app_ht
);
3275 ht_cleanup_push(ust_app_ht_by_sock
);
3276 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3280 * Init UST app hash table.
3282 void ust_app_ht_alloc(void)
3284 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3285 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3286 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3290 * For a specific UST session, disable the channel for all registered apps.
3292 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3293 struct ltt_ust_channel
*uchan
)
3296 struct lttng_ht_iter iter
;
3297 struct lttng_ht_node_str
*ua_chan_node
;
3298 struct ust_app
*app
;
3299 struct ust_app_session
*ua_sess
;
3300 struct ust_app_channel
*ua_chan
;
3302 if (usess
== NULL
|| uchan
== NULL
) {
3303 ERR("Disabling UST global channel with NULL values");
3308 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3309 uchan
->name
, usess
->id
);
3313 /* For every registered applications */
3314 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3315 struct lttng_ht_iter uiter
;
3316 if (!app
->compatible
) {
3318 * TODO: In time, we should notice the caller of this error by
3319 * telling him that this is a version error.
3323 ua_sess
= lookup_session_by_app(usess
, app
);
3324 if (ua_sess
== NULL
) {
3329 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3330 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3331 /* If the session if found for the app, the channel must be there */
3332 assert(ua_chan_node
);
3334 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3335 /* The channel must not be already disabled */
3336 assert(ua_chan
->enabled
== 1);
3338 /* Disable channel onto application */
3339 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3341 /* XXX: We might want to report this error at some point... */
3353 * For a specific UST session, enable the channel for all registered apps.
3355 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3356 struct ltt_ust_channel
*uchan
)
3359 struct lttng_ht_iter iter
;
3360 struct ust_app
*app
;
3361 struct ust_app_session
*ua_sess
;
3363 if (usess
== NULL
|| uchan
== NULL
) {
3364 ERR("Adding UST global channel to NULL values");
3369 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3370 uchan
->name
, usess
->id
);
3374 /* For every registered applications */
3375 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3376 if (!app
->compatible
) {
3378 * TODO: In time, we should notice the caller of this error by
3379 * telling him that this is a version error.
3383 ua_sess
= lookup_session_by_app(usess
, app
);
3384 if (ua_sess
== NULL
) {
3388 /* Enable channel onto application */
3389 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3391 /* XXX: We might want to report this error at some point... */
3403 * Disable an event in a channel and for a specific session.
3405 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3406 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3409 struct lttng_ht_iter iter
, uiter
;
3410 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3411 struct ust_app
*app
;
3412 struct ust_app_session
*ua_sess
;
3413 struct ust_app_channel
*ua_chan
;
3414 struct ust_app_event
*ua_event
;
3416 DBG("UST app disabling event %s for all apps in channel "
3417 "%s for session id %" PRIu64
,
3418 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3422 /* For all registered applications */
3423 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3424 if (!app
->compatible
) {
3426 * TODO: In time, we should notice the caller of this error by
3427 * telling him that this is a version error.
3431 ua_sess
= lookup_session_by_app(usess
, app
);
3432 if (ua_sess
== NULL
) {
3437 /* Lookup channel in the ust app session */
3438 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3439 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3440 if (ua_chan_node
== NULL
) {
3441 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3442 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3445 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3447 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3448 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3449 if (ua_event_node
== NULL
) {
3450 DBG2("Event %s not found in channel %s for app pid %d."
3451 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3454 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3456 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3458 /* XXX: Report error someday... */
3469 * For a specific UST session and UST channel, the event for all
3472 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3473 struct ltt_ust_channel
*uchan
)
3476 struct lttng_ht_iter iter
, uiter
;
3477 struct lttng_ht_node_str
*ua_chan_node
;
3478 struct ust_app
*app
;
3479 struct ust_app_session
*ua_sess
;
3480 struct ust_app_channel
*ua_chan
;
3481 struct ust_app_event
*ua_event
;
3483 DBG("UST app disabling all event for all apps in channel "
3484 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3488 /* For all registered applications */
3489 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3490 if (!app
->compatible
) {
3492 * TODO: In time, we should notice the caller of this error by
3493 * telling him that this is a version error.
3497 ua_sess
= lookup_session_by_app(usess
, app
);
3499 /* The application has problem or is probably dead. */
3503 /* Lookup channel in the ust app session */
3504 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3505 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3506 /* If the channel is not found, there is a code flow error */
3507 assert(ua_chan_node
);
3509 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3511 /* Disable each events of channel */
3512 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3514 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3516 /* XXX: Report error someday... */
3528 * For a specific UST session, create the channel for all registered apps.
3530 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3531 struct ltt_ust_channel
*uchan
)
3533 int ret
= 0, created
;
3534 struct lttng_ht_iter iter
;
3535 struct ust_app
*app
;
3536 struct ust_app_session
*ua_sess
= NULL
;
3538 /* Very wrong code flow */
3542 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3543 uchan
->name
, usess
->id
);
3547 /* For every registered applications */
3548 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3549 if (!app
->compatible
) {
3551 * TODO: In time, we should notice the caller of this error by
3552 * telling him that this is a version error.
3557 * Create session on the tracer side and add it to app session HT. Note
3558 * that if session exist, it will simply return a pointer to the ust
3561 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3566 * The application's socket is not valid. Either a bad socket
3567 * or a timeout on it. We can't inform the caller that for a
3568 * specific app, the session failed so lets continue here.
3573 goto error_rcu_unlock
;
3578 pthread_mutex_lock(&ua_sess
->lock
);
3579 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3580 sizeof(uchan
->name
))) {
3581 struct ustctl_consumer_channel_attr attr
;
3582 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3583 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3586 /* Create channel onto application. We don't need the chan ref. */
3587 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3588 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3590 pthread_mutex_unlock(&ua_sess
->lock
);
3592 if (ret
== -ENOMEM
) {
3593 /* No more memory is a fatal error. Stop right now. */
3594 goto error_rcu_unlock
;
3596 /* Cleanup the created session if it's the case. */
3598 destroy_app_session(app
, ua_sess
);
3609 * Enable event for a specific session and channel on the tracer.
3611 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3612 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3615 struct lttng_ht_iter iter
, uiter
;
3616 struct lttng_ht_node_str
*ua_chan_node
;
3617 struct ust_app
*app
;
3618 struct ust_app_session
*ua_sess
;
3619 struct ust_app_channel
*ua_chan
;
3620 struct ust_app_event
*ua_event
;
3622 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3623 uevent
->attr
.name
, usess
->id
);
3626 * NOTE: At this point, this function is called only if the session and
3627 * channel passed are already created for all apps. and enabled on the
3633 /* For all registered applications */
3634 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3635 if (!app
->compatible
) {
3637 * TODO: In time, we should notice the caller of this error by
3638 * telling him that this is a version error.
3642 ua_sess
= lookup_session_by_app(usess
, app
);
3644 /* The application has problem or is probably dead. */
3648 pthread_mutex_lock(&ua_sess
->lock
);
3650 /* Lookup channel in the ust app session */
3651 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3652 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3653 /* If the channel is not found, there is a code flow error */
3654 assert(ua_chan_node
);
3656 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3658 /* Get event node */
3659 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3660 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3661 if (ua_event
== NULL
) {
3662 DBG3("UST app enable event %s not found for app PID %d."
3663 "Skipping app", uevent
->attr
.name
, app
->pid
);
3667 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3669 pthread_mutex_unlock(&ua_sess
->lock
);
3673 pthread_mutex_unlock(&ua_sess
->lock
);
3682 * For a specific existing UST session and UST channel, creates the event for
3683 * all registered apps.
3685 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3686 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3689 struct lttng_ht_iter iter
, uiter
;
3690 struct lttng_ht_node_str
*ua_chan_node
;
3691 struct ust_app
*app
;
3692 struct ust_app_session
*ua_sess
;
3693 struct ust_app_channel
*ua_chan
;
3695 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3696 uevent
->attr
.name
, usess
->id
);
3700 /* For all registered applications */
3701 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3702 if (!app
->compatible
) {
3704 * TODO: In time, we should notice the caller of this error by
3705 * telling him that this is a version error.
3709 ua_sess
= lookup_session_by_app(usess
, app
);
3711 /* The application has problem or is probably dead. */
3715 pthread_mutex_lock(&ua_sess
->lock
);
3716 /* Lookup channel in the ust app session */
3717 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3718 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3719 /* If the channel is not found, there is a code flow error */
3720 assert(ua_chan_node
);
3722 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3724 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3725 pthread_mutex_unlock(&ua_sess
->lock
);
3727 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3728 /* Possible value at this point: -ENOMEM. If so, we stop! */
3731 DBG2("UST app event %s already exist on app PID %d",
3732 uevent
->attr
.name
, app
->pid
);
3743 * Start tracing for a specific UST session and app.
3746 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3749 struct ust_app_session
*ua_sess
;
3751 DBG("Starting tracing for ust app pid %d", app
->pid
);
3755 if (!app
->compatible
) {
3759 ua_sess
= lookup_session_by_app(usess
, app
);
3760 if (ua_sess
== NULL
) {
3761 /* The session is in teardown process. Ignore and continue. */
3765 pthread_mutex_lock(&ua_sess
->lock
);
3767 /* Upon restart, we skip the setup, already done */
3768 if (ua_sess
->started
) {
3772 /* Create directories if consumer is LOCAL and has a path defined. */
3773 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3774 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3775 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3776 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3778 if (ret
!= -EEXIST
) {
3779 ERR("Trace directory creation error");
3786 * Create the metadata for the application. This returns gracefully if a
3787 * metadata was already set for the session.
3789 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3794 health_code_update();
3797 /* This start the UST tracing */
3798 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3800 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3801 ERR("Error starting tracing for app pid: %d (ret: %d)",
3804 DBG("UST app start session failed. Application is dead.");
3806 * This is normal behavior, an application can die during the
3807 * creation process. Don't report an error so the execution can
3808 * continue normally.
3810 pthread_mutex_unlock(&ua_sess
->lock
);
3816 /* Indicate that the session has been started once */
3817 ua_sess
->started
= 1;
3819 pthread_mutex_unlock(&ua_sess
->lock
);
3821 health_code_update();
3823 /* Quiescent wait after starting trace */
3824 ret
= ustctl_wait_quiescent(app
->sock
);
3825 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3826 ERR("UST app wait quiescent failed for app pid %d ret %d",
3832 health_code_update();
3836 pthread_mutex_unlock(&ua_sess
->lock
);
3838 health_code_update();
3843 * Stop tracing for a specific UST session and app.
3846 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3849 struct ust_app_session
*ua_sess
;
3850 struct ust_registry_session
*registry
;
3852 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3856 if (!app
->compatible
) {
3857 goto end_no_session
;
3860 ua_sess
= lookup_session_by_app(usess
, app
);
3861 if (ua_sess
== NULL
) {
3862 goto end_no_session
;
3865 pthread_mutex_lock(&ua_sess
->lock
);
3868 * If started = 0, it means that stop trace has been called for a session
3869 * that was never started. It's possible since we can have a fail start
3870 * from either the application manager thread or the command thread. Simply
3871 * indicate that this is a stop error.
3873 if (!ua_sess
->started
) {
3874 goto error_rcu_unlock
;
3877 health_code_update();
3879 /* This inhibits UST tracing */
3880 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3882 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3883 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3886 DBG("UST app stop session failed. Application is dead.");
3888 * This is normal behavior, an application can die during the
3889 * creation process. Don't report an error so the execution can
3890 * continue normally.
3894 goto error_rcu_unlock
;
3897 health_code_update();
3899 /* Quiescent wait after stopping trace */
3900 ret
= ustctl_wait_quiescent(app
->sock
);
3901 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3902 ERR("UST app wait quiescent failed for app pid %d ret %d",
3906 health_code_update();
3908 registry
= get_session_registry(ua_sess
);
3911 if (!registry
->metadata_closed
) {
3912 /* Push metadata for application before freeing the application. */
3913 (void) push_metadata(registry
, ua_sess
->consumer
);
3917 pthread_mutex_unlock(&ua_sess
->lock
);
3920 health_code_update();
3924 pthread_mutex_unlock(&ua_sess
->lock
);
3926 health_code_update();
3931 * Flush buffers for a specific UST session and app.
3934 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3937 struct lttng_ht_iter iter
;
3938 struct ust_app_session
*ua_sess
;
3939 struct ust_app_channel
*ua_chan
;
3941 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3945 if (!app
->compatible
) {
3946 goto end_no_session
;
3949 ua_sess
= lookup_session_by_app(usess
, app
);
3950 if (ua_sess
== NULL
) {
3951 goto end_no_session
;
3954 pthread_mutex_lock(&ua_sess
->lock
);
3956 health_code_update();
3958 /* Flushing buffers */
3959 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3961 health_code_update();
3962 assert(ua_chan
->is_sent
);
3963 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3965 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3966 ERR("UST app PID %d channel %s flush failed with ret %d",
3967 app
->pid
, ua_chan
->name
, ret
);
3969 DBG3("UST app failed to flush %s. Application is dead.",
3972 * This is normal behavior, an application can die during the
3973 * creation process. Don't report an error so the execution can
3974 * continue normally.
3977 /* Continuing flushing all buffers */
3982 health_code_update();
3984 pthread_mutex_unlock(&ua_sess
->lock
);
3987 health_code_update();
3992 * Destroy a specific UST session in apps.
3994 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3997 struct ust_app_session
*ua_sess
;
3998 struct lttng_ht_iter iter
;
3999 struct lttng_ht_node_u64
*node
;
4001 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4005 if (!app
->compatible
) {
4009 __lookup_session_by_app(usess
, app
, &iter
);
4010 node
= lttng_ht_iter_get_node_u64(&iter
);
4012 /* Session is being or is deleted. */
4015 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4017 health_code_update();
4018 destroy_app_session(app
, ua_sess
);
4020 health_code_update();
4022 /* Quiescent wait after stopping trace */
4023 ret
= ustctl_wait_quiescent(app
->sock
);
4024 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4025 ERR("UST app wait quiescent failed for app pid %d ret %d",
4030 health_code_update();
4035 * Start tracing for the UST session.
4037 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4040 struct lttng_ht_iter iter
;
4041 struct ust_app
*app
;
4043 DBG("Starting all UST traces");
4047 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4048 ret
= ust_app_start_trace(usess
, app
);
4050 /* Continue to next apps even on error */
4061 * Start tracing for the UST session.
4063 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4066 struct lttng_ht_iter iter
;
4067 struct ust_app
*app
;
4069 DBG("Stopping all UST traces");
4073 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4074 ret
= ust_app_stop_trace(usess
, app
);
4076 /* Continue to next apps even on error */
4081 /* Flush buffers and push metadata (for UID buffers). */
4082 switch (usess
->buffer_type
) {
4083 case LTTNG_BUFFER_PER_UID
:
4085 struct buffer_reg_uid
*reg
;
4087 /* Flush all per UID buffers associated to that session. */
4088 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4089 struct ust_registry_session
*ust_session_reg
;
4090 struct buffer_reg_channel
*reg_chan
;
4091 struct consumer_socket
*socket
;
4093 /* Get consumer socket to use to push the metadata.*/
4094 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4097 /* Ignore request if no consumer is found for the session. */
4101 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4102 reg_chan
, node
.node
) {
4104 * The following call will print error values so the return
4105 * code is of little importance because whatever happens, we
4106 * have to try them all.
4108 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4111 ust_session_reg
= reg
->registry
->reg
.ust
;
4112 if (!ust_session_reg
->metadata_closed
) {
4113 /* Push metadata. */
4114 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4120 case LTTNG_BUFFER_PER_PID
:
4121 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4122 ret
= ust_app_flush_trace(usess
, app
);
4124 /* Continue to next apps even on error */
4140 * Destroy app UST session.
4142 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4145 struct lttng_ht_iter iter
;
4146 struct ust_app
*app
;
4148 DBG("Destroy all UST traces");
4152 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4153 ret
= destroy_trace(usess
, app
);
4155 /* Continue to next apps even on error */
4166 * Add channels/events from UST global domain to registered apps at sock.
4168 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4171 struct lttng_ht_iter iter
, uiter
;
4172 struct ust_app
*app
;
4173 struct ust_app_session
*ua_sess
= NULL
;
4174 struct ust_app_channel
*ua_chan
;
4175 struct ust_app_event
*ua_event
;
4176 struct ust_app_ctx
*ua_ctx
;
4181 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4186 app
= ust_app_find_by_sock(sock
);
4189 * Application can be unregistered before so this is possible hence
4190 * simply stopping the update.
4192 DBG3("UST app update failed to find app sock %d", sock
);
4196 if (!app
->compatible
) {
4200 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4202 /* Tracer is probably gone or ENOMEM. */
4207 pthread_mutex_lock(&ua_sess
->lock
);
4210 * We can iterate safely here over all UST app session since the create ust
4211 * app session above made a shadow copy of the UST global domain from the
4214 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4217 * For a metadata channel, handle it differently.
4219 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4220 sizeof(ua_chan
->name
))) {
4221 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4226 /* Remove it from the hash table and continue!. */
4227 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4229 delete_ust_app_channel(-1, ua_chan
, app
);
4232 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4235 * Stop everything. On error, the application failed, no more
4236 * file descriptor are available or ENOMEM so stopping here is
4237 * the only thing we can do for now.
4244 * Add context using the list so they are enabled in the same order the
4247 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4248 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4255 /* For each events */
4256 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4258 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4265 pthread_mutex_unlock(&ua_sess
->lock
);
4267 if (usess
->start_trace
) {
4268 ret
= ust_app_start_trace(usess
, app
);
4273 DBG2("UST trace started for app pid %d", app
->pid
);
4276 /* Everything went well at this point. */
4281 pthread_mutex_unlock(&ua_sess
->lock
);
4284 destroy_app_session(app
, ua_sess
);
4291 * Add context to a specific channel for global UST domain.
4293 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4294 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4297 struct lttng_ht_node_str
*ua_chan_node
;
4298 struct lttng_ht_iter iter
, uiter
;
4299 struct ust_app_channel
*ua_chan
= NULL
;
4300 struct ust_app_session
*ua_sess
;
4301 struct ust_app
*app
;
4305 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4306 if (!app
->compatible
) {
4308 * TODO: In time, we should notice the caller of this error by
4309 * telling him that this is a version error.
4313 ua_sess
= lookup_session_by_app(usess
, app
);
4314 if (ua_sess
== NULL
) {
4318 pthread_mutex_lock(&ua_sess
->lock
);
4319 /* Lookup channel in the ust app session */
4320 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4321 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4322 if (ua_chan_node
== NULL
) {
4325 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4327 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4332 pthread_mutex_unlock(&ua_sess
->lock
);
4340 * Enable event for a channel from a UST session for a specific PID.
4342 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4343 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4346 struct lttng_ht_iter iter
;
4347 struct lttng_ht_node_str
*ua_chan_node
;
4348 struct ust_app
*app
;
4349 struct ust_app_session
*ua_sess
;
4350 struct ust_app_channel
*ua_chan
;
4351 struct ust_app_event
*ua_event
;
4353 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4357 app
= ust_app_find_by_pid(pid
);
4359 ERR("UST app enable event per PID %d not found", pid
);
4364 if (!app
->compatible
) {
4369 ua_sess
= lookup_session_by_app(usess
, app
);
4371 /* The application has problem or is probably dead. */
4376 pthread_mutex_lock(&ua_sess
->lock
);
4377 /* Lookup channel in the ust app session */
4378 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4379 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4380 /* If the channel is not found, there is a code flow error */
4381 assert(ua_chan_node
);
4383 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4385 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4386 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4387 if (ua_event
== NULL
) {
4388 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4393 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4400 pthread_mutex_unlock(&ua_sess
->lock
);
4407 * Disable event for a channel from a UST session for a specific PID.
4409 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4410 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4413 struct lttng_ht_iter iter
;
4414 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4415 struct ust_app
*app
;
4416 struct ust_app_session
*ua_sess
;
4417 struct ust_app_channel
*ua_chan
;
4418 struct ust_app_event
*ua_event
;
4420 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4424 app
= ust_app_find_by_pid(pid
);
4426 ERR("UST app disable event per PID %d not found", pid
);
4431 if (!app
->compatible
) {
4436 ua_sess
= lookup_session_by_app(usess
, app
);
4438 /* The application has problem or is probably dead. */
4442 /* Lookup channel in the ust app session */
4443 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4444 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4445 if (ua_chan_node
== NULL
) {
4446 /* Channel does not exist, skip disabling */
4449 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4451 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4452 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4453 if (ua_event_node
== NULL
) {
4454 /* Event does not exist, skip disabling */
4457 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4459 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4470 * Calibrate registered applications.
4472 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4475 struct lttng_ht_iter iter
;
4476 struct ust_app
*app
;
4480 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4481 if (!app
->compatible
) {
4483 * TODO: In time, we should notice the caller of this error by
4484 * telling him that this is a version error.
4489 health_code_update();
4491 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4495 /* Means that it's not implemented on the tracer side. */
4499 DBG2("Calibrate app PID %d returned with error %d",
4506 DBG("UST app global domain calibration finished");
4510 health_code_update();
4516 * Receive registration and populate the given msg structure.
4518 * On success return 0 else a negative value returned by the ustctl call.
4520 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4523 uint32_t pid
, ppid
, uid
, gid
;
4527 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4528 &pid
, &ppid
, &uid
, &gid
,
4529 &msg
->bits_per_long
,
4530 &msg
->uint8_t_alignment
,
4531 &msg
->uint16_t_alignment
,
4532 &msg
->uint32_t_alignment
,
4533 &msg
->uint64_t_alignment
,
4534 &msg
->long_alignment
,
4541 case LTTNG_UST_ERR_EXITING
:
4542 DBG3("UST app recv reg message failed. Application died");
4544 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4545 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4546 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4547 LTTNG_UST_ABI_MINOR_VERSION
);
4550 ERR("UST app recv reg message failed with ret %d", ret
);
4555 msg
->pid
= (pid_t
) pid
;
4556 msg
->ppid
= (pid_t
) ppid
;
4557 msg
->uid
= (uid_t
) uid
;
4558 msg
->gid
= (gid_t
) gid
;
4565 * Return a ust app channel object using the application object and the channel
4566 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4567 * lock MUST be acquired before calling this function.
4569 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4572 struct lttng_ht_node_ulong
*node
;
4573 struct lttng_ht_iter iter
;
4574 struct ust_app_channel
*ua_chan
= NULL
;
4578 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4579 node
= lttng_ht_iter_get_node_ulong(&iter
);
4581 DBG2("UST app channel find by objd %d not found", objd
);
4585 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4592 * Reply to a register channel notification from an application on the notify
4593 * socket. The channel metadata is also created.
4595 * The session UST registry lock is acquired in this function.
4597 * On success 0 is returned else a negative value.
4599 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4600 size_t nr_fields
, struct ustctl_field
*fields
)
4602 int ret
, ret_code
= 0;
4603 uint32_t chan_id
, reg_count
;
4604 uint64_t chan_reg_key
;
4605 enum ustctl_channel_header type
;
4606 struct ust_app
*app
;
4607 struct ust_app_channel
*ua_chan
;
4608 struct ust_app_session
*ua_sess
;
4609 struct ust_registry_session
*registry
;
4610 struct ust_registry_channel
*chan_reg
;
4614 /* Lookup application. If not found, there is a code flow error. */
4615 app
= find_app_by_notify_sock(sock
);
4617 DBG("Application socket %d is being teardown. Abort event notify",
4621 goto error_rcu_unlock
;
4624 /* Lookup channel by UST object descriptor. */
4625 ua_chan
= find_channel_by_objd(app
, cobjd
);
4627 DBG("Application channel is being teardown. Abort event notify");
4630 goto error_rcu_unlock
;
4633 assert(ua_chan
->session
);
4634 ua_sess
= ua_chan
->session
;
4636 /* Get right session registry depending on the session buffer type. */
4637 registry
= get_session_registry(ua_sess
);
4640 /* Depending on the buffer type, a different channel key is used. */
4641 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4642 chan_reg_key
= ua_chan
->tracing_channel_id
;
4644 chan_reg_key
= ua_chan
->key
;
4647 pthread_mutex_lock(®istry
->lock
);
4649 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4652 if (!chan_reg
->register_done
) {
4653 reg_count
= ust_registry_get_event_count(chan_reg
);
4654 if (reg_count
< 31) {
4655 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4657 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4660 chan_reg
->nr_ctx_fields
= nr_fields
;
4661 chan_reg
->ctx_fields
= fields
;
4662 chan_reg
->header_type
= type
;
4664 /* Get current already assigned values. */
4665 type
= chan_reg
->header_type
;
4667 /* Set to NULL so the error path does not do a double free. */
4670 /* Channel id is set during the object creation. */
4671 chan_id
= chan_reg
->chan_id
;
4673 /* Append to metadata */
4674 if (!chan_reg
->metadata_dumped
) {
4675 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4677 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4683 DBG3("UST app replying to register channel key %" PRIu64
4684 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4687 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4689 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4690 ERR("UST app reply channel failed with ret %d", ret
);
4692 DBG3("UST app reply channel failed. Application died");
4697 /* This channel registry registration is completed. */
4698 chan_reg
->register_done
= 1;
4701 pthread_mutex_unlock(®istry
->lock
);
4711 * Add event to the UST channel registry. When the event is added to the
4712 * registry, the metadata is also created. Once done, this replies to the
4713 * application with the appropriate error code.
4715 * The session UST registry lock is acquired in the function.
4717 * On success 0 is returned else a negative value.
4719 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4720 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4721 char *model_emf_uri
)
4724 uint32_t event_id
= 0;
4725 uint64_t chan_reg_key
;
4726 struct ust_app
*app
;
4727 struct ust_app_channel
*ua_chan
;
4728 struct ust_app_session
*ua_sess
;
4729 struct ust_registry_session
*registry
;
4733 /* Lookup application. If not found, there is a code flow error. */
4734 app
= find_app_by_notify_sock(sock
);
4736 DBG("Application socket %d is being teardown. Abort event notify",
4741 free(model_emf_uri
);
4742 goto error_rcu_unlock
;
4745 /* Lookup channel by UST object descriptor. */
4746 ua_chan
= find_channel_by_objd(app
, cobjd
);
4748 DBG("Application channel is being teardown. Abort event notify");
4752 free(model_emf_uri
);
4753 goto error_rcu_unlock
;
4756 assert(ua_chan
->session
);
4757 ua_sess
= ua_chan
->session
;
4759 registry
= get_session_registry(ua_sess
);
4762 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4763 chan_reg_key
= ua_chan
->tracing_channel_id
;
4765 chan_reg_key
= ua_chan
->key
;
4768 pthread_mutex_lock(®istry
->lock
);
4771 * From this point on, this call acquires the ownership of the sig, fields
4772 * and model_emf_uri meaning any free are done inside it if needed. These
4773 * three variables MUST NOT be read/write after this.
4775 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4776 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4777 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4781 * The return value is returned to ustctl so in case of an error, the
4782 * application can be notified. In case of an error, it's important not to
4783 * return a negative error or else the application will get closed.
4785 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4787 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4788 ERR("UST app reply event failed with ret %d", ret
);
4790 DBG3("UST app reply event failed. Application died");
4793 * No need to wipe the create event since the application socket will
4794 * get close on error hence cleaning up everything by itself.
4799 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4803 pthread_mutex_unlock(®istry
->lock
);
4810 * Handle application notification through the given notify socket.
4812 * Return 0 on success or else a negative value.
4814 int ust_app_recv_notify(int sock
)
4817 enum ustctl_notify_cmd cmd
;
4819 DBG3("UST app receiving notify from sock %d", sock
);
4821 ret
= ustctl_recv_notify(sock
, &cmd
);
4823 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4824 ERR("UST app recv notify failed with ret %d", ret
);
4826 DBG3("UST app recv notify failed. Application died");
4832 case USTCTL_NOTIFY_CMD_EVENT
:
4834 int sobjd
, cobjd
, loglevel
;
4835 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4837 struct ustctl_field
*fields
;
4839 DBG2("UST app ustctl register event received");
4841 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4842 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4844 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4845 ERR("UST app recv event failed with ret %d", ret
);
4847 DBG3("UST app recv event failed. Application died");
4853 * Add event to the UST registry coming from the notify socket. This
4854 * call will free if needed the sig, fields and model_emf_uri. This
4855 * code path loses the ownsership of these variables and transfer them
4856 * to the this function.
4858 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4859 fields
, loglevel
, model_emf_uri
);
4866 case USTCTL_NOTIFY_CMD_CHANNEL
:
4870 struct ustctl_field
*fields
;
4872 DBG2("UST app ustctl register channel received");
4874 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4877 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4878 ERR("UST app recv channel failed with ret %d", ret
);
4880 DBG3("UST app recv channel failed. Application died");
4886 * The fields ownership are transfered to this function call meaning
4887 * that if needed it will be freed. After this, it's invalid to access
4888 * fields or clean it up.
4890 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4899 /* Should NEVER happen. */
4908 * Once the notify socket hangs up, this is called. First, it tries to find the
4909 * corresponding application. On failure, the call_rcu to close the socket is
4910 * executed. If an application is found, it tries to delete it from the notify
4911 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4913 * Note that an object needs to be allocated here so on ENOMEM failure, the
4914 * call RCU is not done but the rest of the cleanup is.
4916 void ust_app_notify_sock_unregister(int sock
)
4919 struct lttng_ht_iter iter
;
4920 struct ust_app
*app
;
4921 struct ust_app_notify_sock_obj
*obj
;
4927 obj
= zmalloc(sizeof(*obj
));
4930 * An ENOMEM is kind of uncool. If this strikes we continue the
4931 * procedure but the call_rcu will not be called. In this case, we
4932 * accept the fd leak rather than possibly creating an unsynchronized
4933 * state between threads.
4935 * TODO: The notify object should be created once the notify socket is
4936 * registered and stored independantely from the ust app object. The
4937 * tricky part is to synchronize the teardown of the application and
4938 * this notify object. Let's keep that in mind so we can avoid this
4939 * kind of shenanigans with ENOMEM in the teardown path.
4946 DBG("UST app notify socket unregister %d", sock
);
4949 * Lookup application by notify socket. If this fails, this means that the
4950 * hash table delete has already been done by the application
4951 * unregistration process so we can safely close the notify socket in a
4954 app
= find_app_by_notify_sock(sock
);
4959 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4962 * Whatever happens here either we fail or succeed, in both cases we have
4963 * to close the socket after a grace period to continue to the call RCU
4964 * here. If the deletion is successful, the application is not visible
4965 * anymore by other threads and is it fails it means that it was already
4966 * deleted from the hash table so either way we just have to close the
4969 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4975 * Close socket after a grace period to avoid for the socket to be reused
4976 * before the application object is freed creating potential race between
4977 * threads trying to add unique in the global hash table.
4980 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4985 * Destroy a ust app data structure and free its memory.
4987 void ust_app_destroy(struct ust_app
*app
)
4993 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4997 * Take a snapshot for a given UST session. The snapshot is sent to the given
5000 * Return 0 on success or else a negative value.
5002 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5003 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
5006 struct lttng_ht_iter iter
;
5007 struct ust_app
*app
;
5008 char pathname
[PATH_MAX
];
5009 uint64_t max_stream_size
= 0;
5017 * Compute the maximum size of a single stream if a max size is asked by
5020 if (output
->max_size
> 0 && nb_streams
> 0) {
5021 max_stream_size
= output
->max_size
/ nb_streams
;
5024 switch (usess
->buffer_type
) {
5025 case LTTNG_BUFFER_PER_UID
:
5027 struct buffer_reg_uid
*reg
;
5029 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5030 struct buffer_reg_channel
*reg_chan
;
5031 struct consumer_socket
*socket
;
5033 /* Get consumer socket to use to push the metadata.*/
5034 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5041 memset(pathname
, 0, sizeof(pathname
));
5042 ret
= snprintf(pathname
, sizeof(pathname
),
5043 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5044 reg
->uid
, reg
->bits_per_long
);
5046 PERROR("snprintf snapshot path");
5050 /* Add the UST default trace dir to path. */
5051 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5052 reg_chan
, node
.node
) {
5055 * Make sure the maximum stream size is not lower than the
5056 * subbuffer size or else it's an error since we won't be able to
5057 * snapshot anything.
5059 if (max_stream_size
&&
5060 reg_chan
->subbuf_size
> max_stream_size
) {
5062 DBG3("UST app snapshot record maximum stream size %" PRIu64
5063 " is smaller than subbuffer size of %zu",
5064 max_stream_size
, reg_chan
->subbuf_size
);
5067 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5068 usess
->uid
, usess
->gid
, pathname
, wait
,
5074 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5075 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5083 case LTTNG_BUFFER_PER_PID
:
5085 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5086 struct consumer_socket
*socket
;
5087 struct lttng_ht_iter chan_iter
;
5088 struct ust_app_channel
*ua_chan
;
5089 struct ust_app_session
*ua_sess
;
5090 struct ust_registry_session
*registry
;
5092 ua_sess
= lookup_session_by_app(usess
, app
);
5094 /* Session not associated with this app. */
5098 /* Get the right consumer socket for the application. */
5099 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5106 /* Add the UST default trace dir to path. */
5107 memset(pathname
, 0, sizeof(pathname
));
5108 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5111 PERROR("snprintf snapshot path");
5115 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5116 ua_chan
, node
.node
) {
5118 * Make sure the maximum stream size is not lower than the
5119 * subbuffer size or else it's an error since we won't be able to
5120 * snapshot anything.
5122 if (max_stream_size
&&
5123 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5125 DBG3("UST app snapshot record maximum stream size %" PRIu64
5126 " is smaller than subbuffer size of %" PRIu64
,
5127 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5131 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5132 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5139 registry
= get_session_registry(ua_sess
);
5141 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5142 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5161 * Return the number of streams for a UST session.
5163 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5165 unsigned int ret
= 0;
5166 struct ust_app
*app
;
5167 struct lttng_ht_iter iter
;
5171 switch (usess
->buffer_type
) {
5172 case LTTNG_BUFFER_PER_UID
:
5174 struct buffer_reg_uid
*reg
;
5176 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5177 struct buffer_reg_channel
*reg_chan
;
5179 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5180 reg_chan
, node
.node
) {
5181 ret
+= reg_chan
->stream_count
;
5186 case LTTNG_BUFFER_PER_PID
:
5189 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5190 struct ust_app_channel
*ua_chan
;
5191 struct ust_app_session
*ua_sess
;
5192 struct lttng_ht_iter chan_iter
;
5194 ua_sess
= lookup_session_by_app(usess
, app
);
5196 /* Session not associated with this app. */
5200 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5201 ua_chan
, node
.node
) {
5202 ret
+= ua_chan
->streams
.count
;