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
)
1027 struct lttng_ht_iter iter
;
1028 struct lttng_ht_node_str
*node
;
1029 struct ust_app_event
*event
= NULL
;
1030 struct ust_app_ht_key key
;
1035 /* Setup key for event lookup. */
1037 key
.filter
= filter
;
1038 key
.loglevel
= loglevel
;
1040 /* Lookup using the event name as hash and a custom match fct. */
1041 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1042 ht_match_ust_app_event
, &key
, &iter
.iter
);
1043 node
= lttng_ht_iter_get_node_str(&iter
);
1048 event
= caa_container_of(node
, struct ust_app_event
, node
);
1055 * Create the channel context on the tracer.
1057 * Called with UST app session lock held.
1060 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1061 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1065 health_code_update();
1067 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1068 ua_chan
->obj
, &ua_ctx
->obj
);
1070 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1071 ERR("UST app create channel context failed for app (pid: %d) "
1072 "with ret %d", app
->pid
, ret
);
1075 * This is normal behavior, an application can die during the
1076 * creation process. Don't report an error so the execution can
1077 * continue normally.
1080 DBG3("UST app disable event failed. Application is dead.");
1085 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1087 DBG2("UST app context handle %d created successfully for channel %s",
1088 ua_ctx
->handle
, ua_chan
->name
);
1091 health_code_update();
1096 * Set the filter on the tracer.
1099 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1100 struct ust_app
*app
)
1104 health_code_update();
1106 if (!ua_event
->filter
) {
1111 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1114 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1115 ERR("UST app event %s filter failed for app (pid: %d) "
1116 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1119 * This is normal behavior, an application can die during the
1120 * creation process. Don't report an error so the execution can
1121 * continue normally.
1124 DBG3("UST app filter event failed. Application is dead.");
1129 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1132 health_code_update();
1137 * Disable the specified event on to UST tracer for the UST session.
1139 static int disable_ust_event(struct ust_app
*app
,
1140 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1144 health_code_update();
1146 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1148 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1149 ERR("UST app event %s disable failed for app (pid: %d) "
1150 "and session handle %d with ret %d",
1151 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1154 * This is normal behavior, an application can die during the
1155 * creation process. Don't report an error so the execution can
1156 * continue normally.
1159 DBG3("UST app disable event failed. Application is dead.");
1164 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1165 ua_event
->attr
.name
, app
->pid
);
1168 health_code_update();
1173 * Disable the specified channel on to UST tracer for the UST session.
1175 static int disable_ust_channel(struct ust_app
*app
,
1176 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1180 health_code_update();
1182 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1184 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1185 ERR("UST app channel %s disable failed for app (pid: %d) "
1186 "and session handle %d with ret %d",
1187 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1190 * This is normal behavior, an application can die during the
1191 * creation process. Don't report an error so the execution can
1192 * continue normally.
1195 DBG3("UST app disable channel failed. Application is dead.");
1200 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1201 ua_chan
->name
, app
->pid
);
1204 health_code_update();
1209 * Enable the specified channel on to UST tracer for the UST session.
1211 static int enable_ust_channel(struct ust_app
*app
,
1212 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1216 health_code_update();
1218 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1220 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1221 ERR("UST app channel %s enable failed for app (pid: %d) "
1222 "and session handle %d with ret %d",
1223 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1226 * This is normal behavior, an application can die during the
1227 * creation process. Don't report an error so the execution can
1228 * continue normally.
1231 DBG3("UST app enable channel failed. Application is dead.");
1236 ua_chan
->enabled
= 1;
1238 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1239 ua_chan
->name
, app
->pid
);
1242 health_code_update();
1247 * Enable the specified event on to UST tracer for the UST session.
1249 static int enable_ust_event(struct ust_app
*app
,
1250 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1254 health_code_update();
1256 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1258 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1259 ERR("UST app event %s enable failed for app (pid: %d) "
1260 "and session handle %d with ret %d",
1261 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1264 * This is normal behavior, an application can die during the
1265 * creation process. Don't report an error so the execution can
1266 * continue normally.
1269 DBG3("UST app enable event failed. Application is dead.");
1274 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1275 ua_event
->attr
.name
, app
->pid
);
1278 health_code_update();
1283 * Send channel and stream buffer to application.
1285 * Return 0 on success. On error, a negative value is returned.
1287 static int send_channel_pid_to_ust(struct ust_app
*app
,
1288 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1291 struct ust_app_stream
*stream
, *stmp
;
1297 health_code_update();
1299 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1302 /* Send channel to the application. */
1303 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1308 health_code_update();
1310 /* Send all streams to application. */
1311 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1312 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1316 /* We don't need the stream anymore once sent to the tracer. */
1317 cds_list_del(&stream
->list
);
1318 delete_ust_app_stream(-1, stream
);
1320 /* Flag the channel that it is sent to the application. */
1321 ua_chan
->is_sent
= 1;
1324 health_code_update();
1329 * Create the specified event onto the UST tracer for a UST session.
1331 * Should be called with session mutex held.
1334 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1335 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1339 health_code_update();
1341 /* Create UST event on tracer */
1342 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1345 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1346 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1347 ua_event
->attr
.name
, app
->pid
, ret
);
1350 * This is normal behavior, an application can die during the
1351 * creation process. Don't report an error so the execution can
1352 * continue normally.
1355 DBG3("UST app create event failed. Application is dead.");
1360 ua_event
->handle
= ua_event
->obj
->handle
;
1362 DBG2("UST app event %s created successfully for pid:%d",
1363 ua_event
->attr
.name
, app
->pid
);
1365 health_code_update();
1367 /* Set filter if one is present. */
1368 if (ua_event
->filter
) {
1369 ret
= set_ust_event_filter(ua_event
, app
);
1375 /* If event not enabled, disable it on the tracer */
1376 if (ua_event
->enabled
== 0) {
1377 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1380 * If we hit an EPERM, something is wrong with our disable call. If
1381 * we get an EEXIST, there is a problem on the tracer side since we
1385 case -LTTNG_UST_ERR_PERM
:
1386 /* Code flow problem */
1388 case -LTTNG_UST_ERR_EXIST
:
1389 /* It's OK for our use case. */
1400 health_code_update();
1405 * Copy data between an UST app event and a LTT event.
1407 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1408 struct ltt_ust_event
*uevent
)
1410 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1411 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1413 ua_event
->enabled
= uevent
->enabled
;
1415 /* Copy event attributes */
1416 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1418 /* Copy filter bytecode */
1419 if (uevent
->filter
) {
1420 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1421 /* Filter might be NULL here in case of ENONEM. */
1426 * Copy data between an UST app channel and a LTT channel.
1428 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1429 struct ltt_ust_channel
*uchan
)
1431 struct lttng_ht_iter iter
;
1432 struct ltt_ust_event
*uevent
;
1433 struct ltt_ust_context
*uctx
;
1434 struct ust_app_event
*ua_event
;
1435 struct ust_app_ctx
*ua_ctx
;
1437 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1439 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1440 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1442 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1443 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1445 /* Copy event attributes since the layout is different. */
1446 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1447 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1448 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1449 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1450 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1451 ua_chan
->attr
.output
= uchan
->attr
.output
;
1453 * Note that the attribute channel type is not set since the channel on the
1454 * tracing registry side does not have this information.
1457 ua_chan
->enabled
= uchan
->enabled
;
1458 ua_chan
->tracing_channel_id
= uchan
->id
;
1460 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1461 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1462 if (ua_ctx
== NULL
) {
1465 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1466 (unsigned long) ua_ctx
->ctx
.ctx
);
1467 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1468 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1471 /* Copy all events from ltt ust channel to ust app channel */
1472 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1473 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1474 uevent
->filter
, uevent
->attr
.loglevel
);
1475 if (ua_event
== NULL
) {
1476 DBG2("UST event %s not found on shadow copy channel",
1478 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1479 if (ua_event
== NULL
) {
1482 shadow_copy_event(ua_event
, uevent
);
1483 add_unique_ust_app_event(ua_chan
, ua_event
);
1487 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1491 * Copy data between a UST app session and a regular LTT session.
1493 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1494 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1496 struct lttng_ht_node_str
*ua_chan_node
;
1497 struct lttng_ht_iter iter
;
1498 struct ltt_ust_channel
*uchan
;
1499 struct ust_app_channel
*ua_chan
;
1501 struct tm
*timeinfo
;
1505 /* Get date and time for unique app path */
1507 timeinfo
= localtime(&rawtime
);
1508 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1510 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1512 ua_sess
->tracing_id
= usess
->id
;
1513 ua_sess
->id
= get_next_session_id();
1514 ua_sess
->uid
= app
->uid
;
1515 ua_sess
->gid
= app
->gid
;
1516 ua_sess
->euid
= usess
->uid
;
1517 ua_sess
->egid
= usess
->gid
;
1518 ua_sess
->buffer_type
= usess
->buffer_type
;
1519 ua_sess
->bits_per_long
= app
->bits_per_long
;
1520 /* There is only one consumer object per session possible. */
1521 ua_sess
->consumer
= usess
->consumer
;
1522 ua_sess
->output_traces
= usess
->output_traces
;
1523 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1525 switch (ua_sess
->buffer_type
) {
1526 case LTTNG_BUFFER_PER_PID
:
1527 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1528 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1531 case LTTNG_BUFFER_PER_UID
:
1532 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1533 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1540 PERROR("asprintf UST shadow copy session");
1545 /* Iterate over all channels in global domain. */
1546 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1548 struct lttng_ht_iter uiter
;
1550 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1551 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1552 if (ua_chan_node
!= NULL
) {
1553 /* Session exist. Contiuing. */
1557 DBG2("Channel %s not found on shadow session copy, creating it",
1559 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1560 if (ua_chan
== NULL
) {
1561 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1564 shadow_copy_channel(ua_chan
, uchan
);
1566 * The concept of metadata channel does not exist on the tracing
1567 * registry side of the session daemon so this can only be a per CPU
1568 * channel and not metadata.
1570 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1572 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1580 * Lookup sesison wrapper.
1583 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1584 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1586 /* Get right UST app session from app */
1587 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1591 * Return ust app session from the app session hashtable using the UST session
1594 static struct ust_app_session
*lookup_session_by_app(
1595 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1597 struct lttng_ht_iter iter
;
1598 struct lttng_ht_node_u64
*node
;
1600 __lookup_session_by_app(usess
, app
, &iter
);
1601 node
= lttng_ht_iter_get_node_u64(&iter
);
1606 return caa_container_of(node
, struct ust_app_session
, node
);
1613 * Setup buffer registry per PID for the given session and application. If none
1614 * is found, a new one is created, added to the global registry and
1615 * initialized. If regp is valid, it's set with the newly created object.
1617 * Return 0 on success or else a negative value.
1619 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1620 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1623 struct buffer_reg_pid
*reg_pid
;
1630 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1633 * This is the create channel path meaning that if there is NO
1634 * registry available, we have to create one for this session.
1636 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1640 buffer_reg_pid_add(reg_pid
);
1645 /* Initialize registry. */
1646 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1647 app
->bits_per_long
, app
->uint8_t_alignment
,
1648 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1649 app
->uint64_t_alignment
, app
->long_alignment
,
1650 app
->byte_order
, app
->version
.major
,
1651 app
->version
.minor
);
1656 DBG3("UST app buffer registry per PID created successfully");
1668 * Setup buffer registry per UID for the given session and application. If none
1669 * is found, a new one is created, added to the global registry and
1670 * initialized. If regp is valid, it's set with the newly created object.
1672 * Return 0 on success or else a negative value.
1674 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1675 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1678 struct buffer_reg_uid
*reg_uid
;
1685 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1688 * This is the create channel path meaning that if there is NO
1689 * registry available, we have to create one for this session.
1691 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1692 LTTNG_DOMAIN_UST
, ®_uid
);
1696 buffer_reg_uid_add(reg_uid
);
1701 /* Initialize registry. */
1702 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1703 app
->bits_per_long
, app
->uint8_t_alignment
,
1704 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1705 app
->uint64_t_alignment
, app
->long_alignment
,
1706 app
->byte_order
, app
->version
.major
,
1707 app
->version
.minor
);
1711 /* Add node to teardown list of the session. */
1712 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1714 DBG3("UST app buffer registry per UID created successfully");
1726 * Create a session on the tracer side for the given app.
1728 * On success, ua_sess_ptr is populated with the session pointer or else left
1729 * untouched. If the session was created, is_created is set to 1. On error,
1730 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1733 * Returns 0 on success or else a negative code which is either -ENOMEM or
1734 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1736 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1737 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1740 int ret
, created
= 0;
1741 struct ust_app_session
*ua_sess
;
1745 assert(ua_sess_ptr
);
1747 health_code_update();
1749 ua_sess
= lookup_session_by_app(usess
, app
);
1750 if (ua_sess
== NULL
) {
1751 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1752 app
->pid
, usess
->id
);
1753 ua_sess
= alloc_ust_app_session(app
);
1754 if (ua_sess
== NULL
) {
1755 /* Only malloc can failed so something is really wrong */
1759 shadow_copy_session(ua_sess
, usess
, app
);
1763 switch (usess
->buffer_type
) {
1764 case LTTNG_BUFFER_PER_PID
:
1765 /* Init local registry. */
1766 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1771 case LTTNG_BUFFER_PER_UID
:
1772 /* Look for a global registry. If none exists, create one. */
1773 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1784 health_code_update();
1786 if (ua_sess
->handle
== -1) {
1787 ret
= ustctl_create_session(app
->sock
);
1789 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1790 ERR("Creating session for app pid %d with ret %d",
1793 DBG("UST app creating session failed. Application is dead");
1795 * This is normal behavior, an application can die during the
1796 * creation process. Don't report an error so the execution can
1797 * continue normally. This will get flagged ENOTCONN and the
1798 * caller will handle it.
1802 delete_ust_app_session(-1, ua_sess
, app
);
1803 if (ret
!= -ENOMEM
) {
1805 * Tracer is probably gone or got an internal error so let's
1806 * behave like it will soon unregister or not usable.
1813 ua_sess
->handle
= ret
;
1815 /* Add ust app session to app's HT */
1816 lttng_ht_node_init_u64(&ua_sess
->node
,
1817 ua_sess
->tracing_id
);
1818 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1820 DBG2("UST app session created successfully with handle %d", ret
);
1823 *ua_sess_ptr
= ua_sess
;
1825 *is_created
= created
;
1828 /* Everything went well. */
1832 health_code_update();
1837 * Create a context for the channel on the tracer.
1839 * Called with UST app session lock held and a RCU read side lock.
1842 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1843 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1844 struct ust_app
*app
)
1847 struct lttng_ht_iter iter
;
1848 struct lttng_ht_node_ulong
*node
;
1849 struct ust_app_ctx
*ua_ctx
;
1851 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1853 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1854 node
= lttng_ht_iter_get_node_ulong(&iter
);
1860 ua_ctx
= alloc_ust_app_ctx(uctx
);
1861 if (ua_ctx
== NULL
) {
1867 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1868 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1869 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1871 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1881 * Enable on the tracer side a ust app event for the session and channel.
1883 * Called with UST app session lock held.
1886 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1887 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1891 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1896 ua_event
->enabled
= 1;
1903 * Disable on the tracer side a ust app event for the session and channel.
1905 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1906 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1910 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1915 ua_event
->enabled
= 0;
1922 * Lookup ust app channel for session and disable it on the tracer side.
1925 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1926 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1930 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1935 ua_chan
->enabled
= 0;
1942 * Lookup ust app channel for session and enable it on the tracer side. This
1943 * MUST be called with a RCU read side lock acquired.
1945 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1946 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1949 struct lttng_ht_iter iter
;
1950 struct lttng_ht_node_str
*ua_chan_node
;
1951 struct ust_app_channel
*ua_chan
;
1953 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1954 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1955 if (ua_chan_node
== NULL
) {
1956 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1957 uchan
->name
, ua_sess
->tracing_id
);
1961 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1963 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1973 * Ask the consumer to create a channel and get it if successful.
1975 * Return 0 on success or else a negative value.
1977 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1978 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1979 int bitness
, struct ust_registry_session
*registry
)
1982 unsigned int nb_fd
= 0;
1983 struct consumer_socket
*socket
;
1991 health_code_update();
1993 /* Get the right consumer socket for the application. */
1994 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2000 health_code_update();
2002 /* Need one fd for the channel. */
2003 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2005 ERR("Exhausted number of available FD upon create channel");
2010 * Ask consumer to create channel. The consumer will return the number of
2011 * stream we have to expect.
2013 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2020 * Compute the number of fd needed before receiving them. It must be 2 per
2021 * stream (2 being the default value here).
2023 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2025 /* Reserve the amount of file descriptor we need. */
2026 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2028 ERR("Exhausted number of available FD upon create channel");
2029 goto error_fd_get_stream
;
2032 health_code_update();
2035 * Now get the channel from the consumer. This call wil populate the stream
2036 * list of that channel and set the ust objects.
2038 if (usess
->consumer
->enabled
) {
2039 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2049 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2050 error_fd_get_stream
:
2052 * Initiate a destroy channel on the consumer since we had an error
2053 * handling it on our side. The return value is of no importance since we
2054 * already have a ret value set by the previous error that we need to
2057 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2059 lttng_fd_put(LTTNG_FD_APPS
, 1);
2061 health_code_update();
2067 * Duplicate the ust data object of the ust app stream and save it in the
2068 * buffer registry stream.
2070 * Return 0 on success or else a negative value.
2072 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2073 struct ust_app_stream
*stream
)
2080 /* Reserve the amount of file descriptor we need. */
2081 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2083 ERR("Exhausted number of available FD upon duplicate stream");
2087 /* Duplicate object for stream once the original is in the registry. */
2088 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2089 reg_stream
->obj
.ust
);
2091 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2092 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2093 lttng_fd_put(LTTNG_FD_APPS
, 2);
2096 stream
->handle
= stream
->obj
->handle
;
2103 * Duplicate the ust data object of the ust app. channel and save it in the
2104 * buffer registry channel.
2106 * Return 0 on success or else a negative value.
2108 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2109 struct ust_app_channel
*ua_chan
)
2116 /* Need two fds for the channel. */
2117 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2119 ERR("Exhausted number of available FD upon duplicate channel");
2123 /* Duplicate object for stream once the original is in the registry. */
2124 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2126 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2127 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2130 ua_chan
->handle
= ua_chan
->obj
->handle
;
2135 lttng_fd_put(LTTNG_FD_APPS
, 1);
2141 * For a given channel buffer registry, setup all streams of the given ust
2142 * application channel.
2144 * Return 0 on success or else a negative value.
2146 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2147 struct ust_app_channel
*ua_chan
)
2150 struct ust_app_stream
*stream
, *stmp
;
2155 DBG2("UST app setup buffer registry stream");
2157 /* Send all streams to application. */
2158 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2159 struct buffer_reg_stream
*reg_stream
;
2161 ret
= buffer_reg_stream_create(®_stream
);
2167 * Keep original pointer and nullify it in the stream so the delete
2168 * stream call does not release the object.
2170 reg_stream
->obj
.ust
= stream
->obj
;
2172 buffer_reg_stream_add(reg_stream
, reg_chan
);
2174 /* We don't need the streams anymore. */
2175 cds_list_del(&stream
->list
);
2176 delete_ust_app_stream(-1, stream
);
2184 * Create a buffer registry channel for the given session registry and
2185 * application channel object. If regp pointer is valid, it's set with the
2186 * created object. Important, the created object is NOT added to the session
2187 * registry hash table.
2189 * Return 0 on success else a negative value.
2191 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2192 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2195 struct buffer_reg_channel
*reg_chan
= NULL
;
2200 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2202 /* Create buffer registry channel. */
2203 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2208 reg_chan
->consumer_key
= ua_chan
->key
;
2209 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2211 /* Create and add a channel registry to session. */
2212 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2213 ua_chan
->tracing_channel_id
);
2217 buffer_reg_channel_add(reg_sess
, reg_chan
);
2226 /* Safe because the registry channel object was not added to any HT. */
2227 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2233 * Setup buffer registry channel for the given session registry and application
2234 * channel object. If regp pointer is valid, it's set with the created object.
2236 * Return 0 on success else a negative value.
2238 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2239 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2246 assert(ua_chan
->obj
);
2248 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2250 /* Setup all streams for the registry. */
2251 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2256 reg_chan
->obj
.ust
= ua_chan
->obj
;
2257 ua_chan
->obj
= NULL
;
2262 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2263 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2268 * Send buffer registry channel to the application.
2270 * Return 0 on success else a negative value.
2272 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2273 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2274 struct ust_app_channel
*ua_chan
)
2277 struct buffer_reg_stream
*reg_stream
;
2284 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2286 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2291 /* Send channel to the application. */
2292 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2297 health_code_update();
2299 /* Send all streams to application. */
2300 pthread_mutex_lock(®_chan
->stream_list_lock
);
2301 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2302 struct ust_app_stream stream
;
2304 ret
= duplicate_stream_object(reg_stream
, &stream
);
2306 goto error_stream_unlock
;
2309 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2311 (void) release_ust_app_stream(-1, &stream
);
2312 goto error_stream_unlock
;
2316 * The return value is not important here. This function will output an
2319 (void) release_ust_app_stream(-1, &stream
);
2321 ua_chan
->is_sent
= 1;
2323 error_stream_unlock
:
2324 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2330 * Create and send to the application the created buffers with per UID buffers.
2332 * Return 0 on success else a negative value.
2334 static int create_channel_per_uid(struct ust_app
*app
,
2335 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2336 struct ust_app_channel
*ua_chan
)
2339 struct buffer_reg_uid
*reg_uid
;
2340 struct buffer_reg_channel
*reg_chan
;
2347 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2349 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2351 * The session creation handles the creation of this global registry
2352 * object. If none can be find, there is a code flow problem or a
2357 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2360 /* Create the buffer registry channel object. */
2361 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2368 * Create the buffers on the consumer side. This call populates the
2369 * ust app channel object with all streams and data object.
2371 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2372 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2375 * Let's remove the previously created buffer registry channel so
2376 * it's not visible anymore in the session registry.
2378 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2379 ua_chan
->tracing_channel_id
);
2380 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2381 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2386 * Setup the streams and add it to the session registry.
2388 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2395 /* Send buffers to the application. */
2396 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2406 * Create and send to the application the created buffers with per PID buffers.
2408 * Return 0 on success else a negative value.
2410 static int create_channel_per_pid(struct ust_app
*app
,
2411 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2412 struct ust_app_channel
*ua_chan
)
2415 struct ust_registry_session
*registry
;
2422 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2426 registry
= get_session_registry(ua_sess
);
2429 /* Create and add a new channel registry to session. */
2430 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2435 /* Create and get channel on the consumer side. */
2436 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2437 app
->bits_per_long
, registry
);
2442 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2453 * From an already allocated ust app channel, create the channel buffers if
2454 * need and send it to the application. This MUST be called with a RCU read
2455 * side lock acquired.
2457 * Return 0 on success or else a negative value.
2459 static int do_create_channel(struct ust_app
*app
,
2460 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2461 struct ust_app_channel
*ua_chan
)
2470 /* Handle buffer type before sending the channel to the application. */
2471 switch (usess
->buffer_type
) {
2472 case LTTNG_BUFFER_PER_UID
:
2474 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2480 case LTTNG_BUFFER_PER_PID
:
2482 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2494 /* Initialize ust objd object using the received handle and add it. */
2495 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2496 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2498 /* If channel is not enabled, disable it on the tracer */
2499 if (!ua_chan
->enabled
) {
2500 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2511 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2512 * newly created channel if not NULL.
2514 * Called with UST app session lock and RCU read-side lock held.
2516 * Return 0 on success or else a negative value.
2518 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2519 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2520 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2521 struct ust_app_channel
**ua_chanp
)
2524 struct lttng_ht_iter iter
;
2525 struct lttng_ht_node_str
*ua_chan_node
;
2526 struct ust_app_channel
*ua_chan
;
2528 /* Lookup channel in the ust app session */
2529 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2530 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2531 if (ua_chan_node
!= NULL
) {
2532 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2536 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2537 if (ua_chan
== NULL
) {
2538 /* Only malloc can fail here */
2542 shadow_copy_channel(ua_chan
, uchan
);
2544 /* Set channel type. */
2545 ua_chan
->attr
.type
= type
;
2547 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2552 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2555 /* Only add the channel if successful on the tracer side. */
2556 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2560 *ua_chanp
= ua_chan
;
2563 /* Everything went well. */
2567 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2573 * Create UST app event and create it on the tracer side.
2575 * Called with ust app session mutex held.
2578 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2579 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2580 struct ust_app
*app
)
2583 struct ust_app_event
*ua_event
;
2585 /* Get event node */
2586 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2587 uevent
->filter
, uevent
->attr
.loglevel
);
2588 if (ua_event
!= NULL
) {
2593 /* Does not exist so create one */
2594 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2595 if (ua_event
== NULL
) {
2596 /* Only malloc can failed so something is really wrong */
2600 shadow_copy_event(ua_event
, uevent
);
2602 /* Create it on the tracer side */
2603 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2605 /* Not found previously means that it does not exist on the tracer */
2606 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2610 add_unique_ust_app_event(ua_chan
, ua_event
);
2612 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2619 /* Valid. Calling here is already in a read side lock */
2620 delete_ust_app_event(-1, ua_event
);
2625 * Create UST metadata and open it on the tracer side.
2627 * Called with UST app session lock held and RCU read side lock.
2629 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2630 struct ust_app
*app
, struct consumer_output
*consumer
,
2631 struct ustctl_consumer_channel_attr
*attr
)
2634 struct ust_app_channel
*metadata
;
2635 struct consumer_socket
*socket
;
2636 struct ust_registry_session
*registry
;
2642 registry
= get_session_registry(ua_sess
);
2645 /* Metadata already exists for this registry or it was closed previously */
2646 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2651 /* Allocate UST metadata */
2652 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2654 /* malloc() failed */
2660 /* Set default attributes for metadata. */
2661 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2662 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2663 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2664 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2665 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2666 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2667 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2669 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2670 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2671 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2674 /* Need one fd for the channel. */
2675 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2677 ERR("Exhausted number of available FD upon create metadata");
2681 /* Get the right consumer socket for the application. */
2682 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2685 goto error_consumer
;
2689 * Keep metadata key so we can identify it on the consumer side. Assign it
2690 * to the registry *before* we ask the consumer so we avoid the race of the
2691 * consumer requesting the metadata and the ask_channel call on our side
2692 * did not returned yet.
2694 registry
->metadata_key
= metadata
->key
;
2697 * Ask the metadata channel creation to the consumer. The metadata object
2698 * will be created by the consumer and kept their. However, the stream is
2699 * never added or monitored until we do a first push metadata to the
2702 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2705 /* Nullify the metadata key so we don't try to close it later on. */
2706 registry
->metadata_key
= 0;
2707 goto error_consumer
;
2711 * The setup command will make the metadata stream be sent to the relayd,
2712 * if applicable, and the thread managing the metadatas. This is important
2713 * because after this point, if an error occurs, the only way the stream
2714 * can be deleted is to be monitored in the consumer.
2716 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2718 /* Nullify the metadata key so we don't try to close it later on. */
2719 registry
->metadata_key
= 0;
2720 goto error_consumer
;
2723 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2724 metadata
->key
, app
->pid
);
2727 lttng_fd_put(LTTNG_FD_APPS
, 1);
2728 delete_ust_app_channel(-1, metadata
, app
);
2734 * Return pointer to traceable apps list.
2736 struct lttng_ht
*ust_app_get_ht(void)
2742 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2743 * acquired before calling this function.
2745 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2747 struct ust_app
*app
= NULL
;
2748 struct lttng_ht_node_ulong
*node
;
2749 struct lttng_ht_iter iter
;
2751 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2752 node
= lttng_ht_iter_get_node_ulong(&iter
);
2754 DBG2("UST app no found with pid %d", pid
);
2758 DBG2("Found UST app by pid %d", pid
);
2760 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2767 * Allocate and init an UST app object using the registration information and
2768 * the command socket. This is called when the command socket connects to the
2771 * The object is returned on success or else NULL.
2773 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2775 struct ust_app
*lta
= NULL
;
2780 DBG3("UST app creating application for socket %d", sock
);
2782 if ((msg
->bits_per_long
== 64 &&
2783 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2784 || (msg
->bits_per_long
== 32 &&
2785 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2786 ERR("Registration failed: application \"%s\" (pid: %d) has "
2787 "%d-bit long, but no consumerd for this size is available.\n",
2788 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2792 lta
= zmalloc(sizeof(struct ust_app
));
2798 lta
->ppid
= msg
->ppid
;
2799 lta
->uid
= msg
->uid
;
2800 lta
->gid
= msg
->gid
;
2802 lta
->bits_per_long
= msg
->bits_per_long
;
2803 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2804 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2805 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2806 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2807 lta
->long_alignment
= msg
->long_alignment
;
2808 lta
->byte_order
= msg
->byte_order
;
2810 lta
->v_major
= msg
->major
;
2811 lta
->v_minor
= msg
->minor
;
2812 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2813 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2814 lta
->notify_sock
= -1;
2816 /* Copy name and make sure it's NULL terminated. */
2817 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2818 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2821 * Before this can be called, when receiving the registration information,
2822 * the application compatibility is checked. So, at this point, the
2823 * application can work with this session daemon.
2825 lta
->compatible
= 1;
2827 lta
->pid
= msg
->pid
;
2828 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2830 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2832 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2839 * For a given application object, add it to every hash table.
2841 void ust_app_add(struct ust_app
*app
)
2844 assert(app
->notify_sock
>= 0);
2849 * On a re-registration, we want to kick out the previous registration of
2852 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2855 * The socket _should_ be unique until _we_ call close. So, a add_unique
2856 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2857 * already in the table.
2859 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2861 /* Add application to the notify socket hash table. */
2862 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2863 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2865 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2866 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2867 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2874 * Set the application version into the object.
2876 * Return 0 on success else a negative value either an errno code or a
2877 * LTTng-UST error code.
2879 int ust_app_version(struct ust_app
*app
)
2885 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2887 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2888 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2890 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2898 * Unregister app by removing it from the global traceable app list and freeing
2901 * The socket is already closed at this point so no close to sock.
2903 void ust_app_unregister(int sock
)
2905 struct ust_app
*lta
;
2906 struct lttng_ht_node_ulong
*node
;
2907 struct lttng_ht_iter iter
;
2908 struct ust_app_session
*ua_sess
;
2913 /* Get the node reference for a call_rcu */
2914 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2915 node
= lttng_ht_iter_get_node_ulong(&iter
);
2918 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2919 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2921 /* Remove application from PID hash table */
2922 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2926 * Remove application from notify hash table. The thread handling the
2927 * notify socket could have deleted the node so ignore on error because
2928 * either way it's valid. The close of that socket is handled by the other
2931 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2932 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2935 * Ignore return value since the node might have been removed before by an
2936 * add replace during app registration because the PID can be reassigned by
2939 iter
.iter
.node
= <a
->pid_n
.node
;
2940 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2942 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2946 /* Remove sessions so they are not visible during deletion.*/
2947 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2949 struct ust_registry_session
*registry
;
2951 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2953 /* The session was already removed so scheduled for teardown. */
2958 * Add session to list for teardown. This is safe since at this point we
2959 * are the only one using this list.
2961 pthread_mutex_lock(&ua_sess
->lock
);
2964 * Normally, this is done in the delete session process which is
2965 * executed in the call rcu below. However, upon registration we can't
2966 * afford to wait for the grace period before pushing data or else the
2967 * data pending feature can race between the unregistration and stop
2968 * command where the data pending command is sent *before* the grace
2971 * The close metadata below nullifies the metadata pointer in the
2972 * session so the delete session will NOT push/close a second time.
2974 registry
= get_session_registry(ua_sess
);
2975 if (registry
&& !registry
->metadata_closed
) {
2976 /* Push metadata for application before freeing the application. */
2977 (void) push_metadata(registry
, ua_sess
->consumer
);
2980 * Don't ask to close metadata for global per UID buffers. Close
2981 * metadata only on destroy trace session in this case. Also, the
2982 * previous push metadata could have flag the metadata registry to
2983 * close so don't send a close command if closed.
2985 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2986 !registry
->metadata_closed
) {
2987 /* And ask to close it for this session registry. */
2988 (void) close_metadata(registry
, ua_sess
->consumer
);
2992 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2993 pthread_mutex_unlock(&ua_sess
->lock
);
2997 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3004 * Return traceable_app_count
3006 unsigned long ust_app_list_count(void)
3008 unsigned long count
;
3011 count
= lttng_ht_get_count(ust_app_ht
);
3018 * Fill events array with all events name of all registered apps.
3020 int ust_app_list_events(struct lttng_event
**events
)
3023 size_t nbmem
, count
= 0;
3024 struct lttng_ht_iter iter
;
3025 struct ust_app
*app
;
3026 struct lttng_event
*tmp_event
;
3028 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3029 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3030 if (tmp_event
== NULL
) {
3031 PERROR("zmalloc ust app events");
3038 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3039 struct lttng_ust_tracepoint_iter uiter
;
3041 health_code_update();
3043 if (!app
->compatible
) {
3045 * TODO: In time, we should notice the caller of this error by
3046 * telling him that this is a version error.
3050 handle
= ustctl_tracepoint_list(app
->sock
);
3052 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3053 ERR("UST app list events getting handle failed for app pid %d",
3059 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3060 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3061 /* Handle ustctl error. */
3064 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3065 ERR("UST app tp list get failed for app %d with ret %d",
3068 DBG3("UST app tp list get failed. Application is dead");
3070 * This is normal behavior, an application can die during the
3071 * creation process. Don't report an error so the execution can
3072 * continue normally. Continue normal execution.
3079 health_code_update();
3080 if (count
>= nbmem
) {
3081 /* In case the realloc fails, we free the memory */
3084 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3087 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3089 PERROR("realloc ust app events");
3096 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3097 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3098 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3099 tmp_event
[count
].pid
= app
->pid
;
3100 tmp_event
[count
].enabled
= -1;
3106 *events
= tmp_event
;
3108 DBG2("UST app list events done (%zu events)", count
);
3113 health_code_update();
3118 * Fill events array with all events name of all registered apps.
3120 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3123 size_t nbmem
, count
= 0;
3124 struct lttng_ht_iter iter
;
3125 struct ust_app
*app
;
3126 struct lttng_event_field
*tmp_event
;
3128 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3129 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3130 if (tmp_event
== NULL
) {
3131 PERROR("zmalloc ust app event fields");
3138 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3139 struct lttng_ust_field_iter uiter
;
3141 health_code_update();
3143 if (!app
->compatible
) {
3145 * TODO: In time, we should notice the caller of this error by
3146 * telling him that this is a version error.
3150 handle
= ustctl_tracepoint_field_list(app
->sock
);
3152 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3153 ERR("UST app list field getting handle failed for app pid %d",
3159 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3160 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3161 /* Handle ustctl error. */
3164 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3165 ERR("UST app tp list field failed for app %d with ret %d",
3168 DBG3("UST app tp list field failed. Application is dead");
3170 * This is normal behavior, an application can die during the
3171 * creation process. Don't report an error so the execution can
3172 * continue normally.
3179 health_code_update();
3180 if (count
>= nbmem
) {
3181 /* In case the realloc fails, we free the memory */
3184 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3187 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3189 PERROR("realloc ust app event fields");
3197 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3198 tmp_event
[count
].type
= uiter
.type
;
3199 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3201 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3202 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3203 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3204 tmp_event
[count
].event
.pid
= app
->pid
;
3205 tmp_event
[count
].event
.enabled
= -1;
3211 *fields
= tmp_event
;
3213 DBG2("UST app list event fields done (%zu events)", count
);
3218 health_code_update();
3223 * Free and clean all traceable apps of the global list.
3225 * Should _NOT_ be called with RCU read-side lock held.
3227 void ust_app_clean_list(void)
3230 struct ust_app
*app
;
3231 struct lttng_ht_iter iter
;
3233 DBG2("UST app cleaning registered apps hash table");
3237 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3238 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3240 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3243 /* Cleanup socket hash table */
3244 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3246 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3250 /* Cleanup notify socket hash table */
3251 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3252 notify_sock_n
.node
) {
3253 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3258 /* Destroy is done only when the ht is empty */
3259 ht_cleanup_push(ust_app_ht
);
3260 ht_cleanup_push(ust_app_ht_by_sock
);
3261 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3265 * Init UST app hash table.
3267 void ust_app_ht_alloc(void)
3269 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3270 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3271 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3275 * For a specific UST session, disable the channel for all registered apps.
3277 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3278 struct ltt_ust_channel
*uchan
)
3281 struct lttng_ht_iter iter
;
3282 struct lttng_ht_node_str
*ua_chan_node
;
3283 struct ust_app
*app
;
3284 struct ust_app_session
*ua_sess
;
3285 struct ust_app_channel
*ua_chan
;
3287 if (usess
== NULL
|| uchan
== NULL
) {
3288 ERR("Disabling UST global channel with NULL values");
3293 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3294 uchan
->name
, usess
->id
);
3298 /* For every registered applications */
3299 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3300 struct lttng_ht_iter uiter
;
3301 if (!app
->compatible
) {
3303 * TODO: In time, we should notice the caller of this error by
3304 * telling him that this is a version error.
3308 ua_sess
= lookup_session_by_app(usess
, app
);
3309 if (ua_sess
== NULL
) {
3314 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3315 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3316 /* If the session if found for the app, the channel must be there */
3317 assert(ua_chan_node
);
3319 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3320 /* The channel must not be already disabled */
3321 assert(ua_chan
->enabled
== 1);
3323 /* Disable channel onto application */
3324 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3326 /* XXX: We might want to report this error at some point... */
3338 * For a specific UST session, enable the channel for all registered apps.
3340 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3341 struct ltt_ust_channel
*uchan
)
3344 struct lttng_ht_iter iter
;
3345 struct ust_app
*app
;
3346 struct ust_app_session
*ua_sess
;
3348 if (usess
== NULL
|| uchan
== NULL
) {
3349 ERR("Adding UST global channel to NULL values");
3354 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3355 uchan
->name
, usess
->id
);
3359 /* For every registered applications */
3360 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3361 if (!app
->compatible
) {
3363 * TODO: In time, we should notice the caller of this error by
3364 * telling him that this is a version error.
3368 ua_sess
= lookup_session_by_app(usess
, app
);
3369 if (ua_sess
== NULL
) {
3373 /* Enable channel onto application */
3374 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3376 /* XXX: We might want to report this error at some point... */
3388 * Disable an event in a channel and for a specific session.
3390 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3391 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3394 struct lttng_ht_iter iter
, uiter
;
3395 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3396 struct ust_app
*app
;
3397 struct ust_app_session
*ua_sess
;
3398 struct ust_app_channel
*ua_chan
;
3399 struct ust_app_event
*ua_event
;
3401 DBG("UST app disabling event %s for all apps in channel "
3402 "%s for session id %" PRIu64
,
3403 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3407 /* For all registered applications */
3408 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3409 if (!app
->compatible
) {
3411 * TODO: In time, we should notice the caller of this error by
3412 * telling him that this is a version error.
3416 ua_sess
= lookup_session_by_app(usess
, app
);
3417 if (ua_sess
== NULL
) {
3422 /* Lookup channel in the ust app session */
3423 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3424 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3425 if (ua_chan_node
== NULL
) {
3426 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3427 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3430 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3432 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3433 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3434 if (ua_event_node
== NULL
) {
3435 DBG2("Event %s not found in channel %s for app pid %d."
3436 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3439 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3441 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3443 /* XXX: Report error someday... */
3454 * For a specific UST session and UST channel, the event for all
3457 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3458 struct ltt_ust_channel
*uchan
)
3461 struct lttng_ht_iter iter
, uiter
;
3462 struct lttng_ht_node_str
*ua_chan_node
;
3463 struct ust_app
*app
;
3464 struct ust_app_session
*ua_sess
;
3465 struct ust_app_channel
*ua_chan
;
3466 struct ust_app_event
*ua_event
;
3468 DBG("UST app disabling all event for all apps in channel "
3469 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3473 /* For all registered applications */
3474 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3475 if (!app
->compatible
) {
3477 * TODO: In time, we should notice the caller of this error by
3478 * telling him that this is a version error.
3482 ua_sess
= lookup_session_by_app(usess
, app
);
3484 /* The application has problem or is probably dead. */
3488 /* Lookup channel in the ust app session */
3489 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3490 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3491 /* If the channel is not found, there is a code flow error */
3492 assert(ua_chan_node
);
3494 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3496 /* Disable each events of channel */
3497 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3499 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3501 /* XXX: Report error someday... */
3513 * For a specific UST session, create the channel for all registered apps.
3515 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3516 struct ltt_ust_channel
*uchan
)
3518 int ret
= 0, created
;
3519 struct lttng_ht_iter iter
;
3520 struct ust_app
*app
;
3521 struct ust_app_session
*ua_sess
= NULL
;
3523 /* Very wrong code flow */
3527 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3528 uchan
->name
, usess
->id
);
3532 /* For every registered applications */
3533 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3534 if (!app
->compatible
) {
3536 * TODO: In time, we should notice the caller of this error by
3537 * telling him that this is a version error.
3542 * Create session on the tracer side and add it to app session HT. Note
3543 * that if session exist, it will simply return a pointer to the ust
3546 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3551 * The application's socket is not valid. Either a bad socket
3552 * or a timeout on it. We can't inform the caller that for a
3553 * specific app, the session failed so lets continue here.
3558 goto error_rcu_unlock
;
3563 pthread_mutex_lock(&ua_sess
->lock
);
3564 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3565 sizeof(uchan
->name
))) {
3566 struct ustctl_consumer_channel_attr attr
;
3567 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3568 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3571 /* Create channel onto application. We don't need the chan ref. */
3572 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3573 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3575 pthread_mutex_unlock(&ua_sess
->lock
);
3577 if (ret
== -ENOMEM
) {
3578 /* No more memory is a fatal error. Stop right now. */
3579 goto error_rcu_unlock
;
3581 /* Cleanup the created session if it's the case. */
3583 destroy_app_session(app
, ua_sess
);
3594 * Enable event for a specific session and channel on the tracer.
3596 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3597 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3600 struct lttng_ht_iter iter
, uiter
;
3601 struct lttng_ht_node_str
*ua_chan_node
;
3602 struct ust_app
*app
;
3603 struct ust_app_session
*ua_sess
;
3604 struct ust_app_channel
*ua_chan
;
3605 struct ust_app_event
*ua_event
;
3607 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3608 uevent
->attr
.name
, usess
->id
);
3611 * NOTE: At this point, this function is called only if the session and
3612 * channel passed are already created for all apps. and enabled on the
3618 /* For all registered applications */
3619 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3620 if (!app
->compatible
) {
3622 * TODO: In time, we should notice the caller of this error by
3623 * telling him that this is a version error.
3627 ua_sess
= lookup_session_by_app(usess
, app
);
3629 /* The application has problem or is probably dead. */
3633 pthread_mutex_lock(&ua_sess
->lock
);
3635 /* Lookup channel in the ust app session */
3636 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3637 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3638 /* If the channel is not found, there is a code flow error */
3639 assert(ua_chan_node
);
3641 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3643 /* Get event node */
3644 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3645 uevent
->filter
, uevent
->attr
.loglevel
);
3646 if (ua_event
== NULL
) {
3647 DBG3("UST app enable event %s not found for app PID %d."
3648 "Skipping app", uevent
->attr
.name
, app
->pid
);
3652 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3654 pthread_mutex_unlock(&ua_sess
->lock
);
3658 pthread_mutex_unlock(&ua_sess
->lock
);
3667 * For a specific existing UST session and UST channel, creates the event for
3668 * all registered apps.
3670 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3671 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3674 struct lttng_ht_iter iter
, uiter
;
3675 struct lttng_ht_node_str
*ua_chan_node
;
3676 struct ust_app
*app
;
3677 struct ust_app_session
*ua_sess
;
3678 struct ust_app_channel
*ua_chan
;
3680 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3681 uevent
->attr
.name
, usess
->id
);
3685 /* For all registered applications */
3686 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3687 if (!app
->compatible
) {
3689 * TODO: In time, we should notice the caller of this error by
3690 * telling him that this is a version error.
3694 ua_sess
= lookup_session_by_app(usess
, app
);
3696 /* The application has problem or is probably dead. */
3700 pthread_mutex_lock(&ua_sess
->lock
);
3701 /* Lookup channel in the ust app session */
3702 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3703 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3704 /* If the channel is not found, there is a code flow error */
3705 assert(ua_chan_node
);
3707 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3709 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3710 pthread_mutex_unlock(&ua_sess
->lock
);
3712 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3713 /* Possible value at this point: -ENOMEM. If so, we stop! */
3716 DBG2("UST app event %s already exist on app PID %d",
3717 uevent
->attr
.name
, app
->pid
);
3728 * Start tracing for a specific UST session and app.
3731 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3734 struct ust_app_session
*ua_sess
;
3736 DBG("Starting tracing for ust app pid %d", app
->pid
);
3740 if (!app
->compatible
) {
3744 ua_sess
= lookup_session_by_app(usess
, app
);
3745 if (ua_sess
== NULL
) {
3746 /* The session is in teardown process. Ignore and continue. */
3750 pthread_mutex_lock(&ua_sess
->lock
);
3752 /* Upon restart, we skip the setup, already done */
3753 if (ua_sess
->started
) {
3757 /* Create directories if consumer is LOCAL and has a path defined. */
3758 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3759 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3760 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3761 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3763 if (ret
!= -EEXIST
) {
3764 ERR("Trace directory creation error");
3771 * Create the metadata for the application. This returns gracefully if a
3772 * metadata was already set for the session.
3774 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3779 health_code_update();
3782 /* This start the UST tracing */
3783 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3785 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3786 ERR("Error starting tracing for app pid: %d (ret: %d)",
3789 DBG("UST app start session failed. Application is dead.");
3791 * This is normal behavior, an application can die during the
3792 * creation process. Don't report an error so the execution can
3793 * continue normally.
3795 pthread_mutex_unlock(&ua_sess
->lock
);
3801 /* Indicate that the session has been started once */
3802 ua_sess
->started
= 1;
3804 pthread_mutex_unlock(&ua_sess
->lock
);
3806 health_code_update();
3808 /* Quiescent wait after starting trace */
3809 ret
= ustctl_wait_quiescent(app
->sock
);
3810 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3811 ERR("UST app wait quiescent failed for app pid %d ret %d",
3817 health_code_update();
3821 pthread_mutex_unlock(&ua_sess
->lock
);
3823 health_code_update();
3828 * Stop tracing for a specific UST session and app.
3831 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3834 struct ust_app_session
*ua_sess
;
3835 struct ust_registry_session
*registry
;
3837 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3841 if (!app
->compatible
) {
3842 goto end_no_session
;
3845 ua_sess
= lookup_session_by_app(usess
, app
);
3846 if (ua_sess
== NULL
) {
3847 goto end_no_session
;
3850 pthread_mutex_lock(&ua_sess
->lock
);
3853 * If started = 0, it means that stop trace has been called for a session
3854 * that was never started. It's possible since we can have a fail start
3855 * from either the application manager thread or the command thread. Simply
3856 * indicate that this is a stop error.
3858 if (!ua_sess
->started
) {
3859 goto error_rcu_unlock
;
3862 health_code_update();
3864 /* This inhibits UST tracing */
3865 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3867 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3868 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3871 DBG("UST app stop session failed. Application is dead.");
3873 * This is normal behavior, an application can die during the
3874 * creation process. Don't report an error so the execution can
3875 * continue normally.
3879 goto error_rcu_unlock
;
3882 health_code_update();
3884 /* Quiescent wait after stopping trace */
3885 ret
= ustctl_wait_quiescent(app
->sock
);
3886 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3887 ERR("UST app wait quiescent failed for app pid %d ret %d",
3891 health_code_update();
3893 registry
= get_session_registry(ua_sess
);
3896 if (!registry
->metadata_closed
) {
3897 /* Push metadata for application before freeing the application. */
3898 (void) push_metadata(registry
, ua_sess
->consumer
);
3902 pthread_mutex_unlock(&ua_sess
->lock
);
3905 health_code_update();
3909 pthread_mutex_unlock(&ua_sess
->lock
);
3911 health_code_update();
3916 * Flush buffers for a specific UST session and app.
3919 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3922 struct lttng_ht_iter iter
;
3923 struct ust_app_session
*ua_sess
;
3924 struct ust_app_channel
*ua_chan
;
3926 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3930 if (!app
->compatible
) {
3931 goto end_no_session
;
3934 ua_sess
= lookup_session_by_app(usess
, app
);
3935 if (ua_sess
== NULL
) {
3936 goto end_no_session
;
3939 pthread_mutex_lock(&ua_sess
->lock
);
3941 health_code_update();
3943 /* Flushing buffers */
3944 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3946 health_code_update();
3947 assert(ua_chan
->is_sent
);
3948 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3950 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3951 ERR("UST app PID %d channel %s flush failed with ret %d",
3952 app
->pid
, ua_chan
->name
, ret
);
3954 DBG3("UST app failed to flush %s. Application is dead.",
3957 * This is normal behavior, an application can die during the
3958 * creation process. Don't report an error so the execution can
3959 * continue normally.
3962 /* Continuing flushing all buffers */
3967 health_code_update();
3969 pthread_mutex_unlock(&ua_sess
->lock
);
3972 health_code_update();
3977 * Destroy a specific UST session in apps.
3979 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3982 struct ust_app_session
*ua_sess
;
3983 struct lttng_ht_iter iter
;
3984 struct lttng_ht_node_u64
*node
;
3986 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3990 if (!app
->compatible
) {
3994 __lookup_session_by_app(usess
, app
, &iter
);
3995 node
= lttng_ht_iter_get_node_u64(&iter
);
3997 /* Session is being or is deleted. */
4000 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4002 health_code_update();
4003 destroy_app_session(app
, ua_sess
);
4005 health_code_update();
4007 /* Quiescent wait after stopping trace */
4008 ret
= ustctl_wait_quiescent(app
->sock
);
4009 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4010 ERR("UST app wait quiescent failed for app pid %d ret %d",
4015 health_code_update();
4020 * Start tracing for the UST session.
4022 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4025 struct lttng_ht_iter iter
;
4026 struct ust_app
*app
;
4028 DBG("Starting all UST traces");
4032 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4033 ret
= ust_app_start_trace(usess
, app
);
4035 /* Continue to next apps even on error */
4046 * Start tracing for the UST session.
4048 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4051 struct lttng_ht_iter iter
;
4052 struct ust_app
*app
;
4054 DBG("Stopping all UST traces");
4058 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4059 ret
= ust_app_stop_trace(usess
, app
);
4061 /* Continue to next apps even on error */
4066 /* Flush buffers and push metadata (for UID buffers). */
4067 switch (usess
->buffer_type
) {
4068 case LTTNG_BUFFER_PER_UID
:
4070 struct buffer_reg_uid
*reg
;
4072 /* Flush all per UID buffers associated to that session. */
4073 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4074 struct ust_registry_session
*ust_session_reg
;
4075 struct buffer_reg_channel
*reg_chan
;
4076 struct consumer_socket
*socket
;
4078 /* Get consumer socket to use to push the metadata.*/
4079 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4082 /* Ignore request if no consumer is found for the session. */
4086 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4087 reg_chan
, node
.node
) {
4089 * The following call will print error values so the return
4090 * code is of little importance because whatever happens, we
4091 * have to try them all.
4093 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4096 ust_session_reg
= reg
->registry
->reg
.ust
;
4097 if (!ust_session_reg
->metadata_closed
) {
4098 /* Push metadata. */
4099 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4105 case LTTNG_BUFFER_PER_PID
:
4106 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4107 ret
= ust_app_flush_trace(usess
, app
);
4109 /* Continue to next apps even on error */
4125 * Destroy app UST session.
4127 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4130 struct lttng_ht_iter iter
;
4131 struct ust_app
*app
;
4133 DBG("Destroy all UST traces");
4137 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4138 ret
= destroy_trace(usess
, app
);
4140 /* Continue to next apps even on error */
4151 * Add channels/events from UST global domain to registered apps at sock.
4153 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4156 struct lttng_ht_iter iter
, uiter
;
4157 struct ust_app
*app
;
4158 struct ust_app_session
*ua_sess
= NULL
;
4159 struct ust_app_channel
*ua_chan
;
4160 struct ust_app_event
*ua_event
;
4161 struct ust_app_ctx
*ua_ctx
;
4166 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4171 app
= ust_app_find_by_sock(sock
);
4174 * Application can be unregistered before so this is possible hence
4175 * simply stopping the update.
4177 DBG3("UST app update failed to find app sock %d", sock
);
4181 if (!app
->compatible
) {
4185 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4187 /* Tracer is probably gone or ENOMEM. */
4192 pthread_mutex_lock(&ua_sess
->lock
);
4195 * We can iterate safely here over all UST app session since the create ust
4196 * app session above made a shadow copy of the UST global domain from the
4199 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4202 * For a metadata channel, handle it differently.
4204 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4205 sizeof(ua_chan
->name
))) {
4206 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4211 /* Remove it from the hash table and continue!. */
4212 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4214 delete_ust_app_channel(-1, ua_chan
, app
);
4217 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4220 * Stop everything. On error, the application failed, no more
4221 * file descriptor are available or ENOMEM so stopping here is
4222 * the only thing we can do for now.
4229 * Add context using the list so they are enabled in the same order the
4232 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4233 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4240 /* For each events */
4241 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4243 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4250 pthread_mutex_unlock(&ua_sess
->lock
);
4252 if (usess
->start_trace
) {
4253 ret
= ust_app_start_trace(usess
, app
);
4258 DBG2("UST trace started for app pid %d", app
->pid
);
4261 /* Everything went well at this point. */
4266 pthread_mutex_unlock(&ua_sess
->lock
);
4269 destroy_app_session(app
, ua_sess
);
4276 * Add context to a specific channel for global UST domain.
4278 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4279 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4282 struct lttng_ht_node_str
*ua_chan_node
;
4283 struct lttng_ht_iter iter
, uiter
;
4284 struct ust_app_channel
*ua_chan
= NULL
;
4285 struct ust_app_session
*ua_sess
;
4286 struct ust_app
*app
;
4290 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4291 if (!app
->compatible
) {
4293 * TODO: In time, we should notice the caller of this error by
4294 * telling him that this is a version error.
4298 ua_sess
= lookup_session_by_app(usess
, app
);
4299 if (ua_sess
== NULL
) {
4303 pthread_mutex_lock(&ua_sess
->lock
);
4304 /* Lookup channel in the ust app session */
4305 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4306 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4307 if (ua_chan_node
== NULL
) {
4310 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4312 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4317 pthread_mutex_unlock(&ua_sess
->lock
);
4325 * Enable event for a channel from a UST session for a specific PID.
4327 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4328 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4331 struct lttng_ht_iter iter
;
4332 struct lttng_ht_node_str
*ua_chan_node
;
4333 struct ust_app
*app
;
4334 struct ust_app_session
*ua_sess
;
4335 struct ust_app_channel
*ua_chan
;
4336 struct ust_app_event
*ua_event
;
4338 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4342 app
= ust_app_find_by_pid(pid
);
4344 ERR("UST app enable event per PID %d not found", pid
);
4349 if (!app
->compatible
) {
4354 ua_sess
= lookup_session_by_app(usess
, app
);
4356 /* The application has problem or is probably dead. */
4361 pthread_mutex_lock(&ua_sess
->lock
);
4362 /* Lookup channel in the ust app session */
4363 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4364 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4365 /* If the channel is not found, there is a code flow error */
4366 assert(ua_chan_node
);
4368 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4370 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4371 uevent
->filter
, uevent
->attr
.loglevel
);
4372 if (ua_event
== NULL
) {
4373 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4378 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4385 pthread_mutex_unlock(&ua_sess
->lock
);
4392 * Disable event for a channel from a UST session for a specific PID.
4394 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4395 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4398 struct lttng_ht_iter iter
;
4399 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4400 struct ust_app
*app
;
4401 struct ust_app_session
*ua_sess
;
4402 struct ust_app_channel
*ua_chan
;
4403 struct ust_app_event
*ua_event
;
4405 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4409 app
= ust_app_find_by_pid(pid
);
4411 ERR("UST app disable event per PID %d not found", pid
);
4416 if (!app
->compatible
) {
4421 ua_sess
= lookup_session_by_app(usess
, app
);
4423 /* The application has problem or is probably dead. */
4427 /* Lookup channel in the ust app session */
4428 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4429 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4430 if (ua_chan_node
== NULL
) {
4431 /* Channel does not exist, skip disabling */
4434 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4436 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4437 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4438 if (ua_event_node
== NULL
) {
4439 /* Event does not exist, skip disabling */
4442 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4444 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4455 * Calibrate registered applications.
4457 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4460 struct lttng_ht_iter iter
;
4461 struct ust_app
*app
;
4465 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4466 if (!app
->compatible
) {
4468 * TODO: In time, we should notice the caller of this error by
4469 * telling him that this is a version error.
4474 health_code_update();
4476 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4480 /* Means that it's not implemented on the tracer side. */
4484 DBG2("Calibrate app PID %d returned with error %d",
4491 DBG("UST app global domain calibration finished");
4495 health_code_update();
4501 * Receive registration and populate the given msg structure.
4503 * On success return 0 else a negative value returned by the ustctl call.
4505 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4508 uint32_t pid
, ppid
, uid
, gid
;
4512 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4513 &pid
, &ppid
, &uid
, &gid
,
4514 &msg
->bits_per_long
,
4515 &msg
->uint8_t_alignment
,
4516 &msg
->uint16_t_alignment
,
4517 &msg
->uint32_t_alignment
,
4518 &msg
->uint64_t_alignment
,
4519 &msg
->long_alignment
,
4526 case LTTNG_UST_ERR_EXITING
:
4527 DBG3("UST app recv reg message failed. Application died");
4529 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4530 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4531 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4532 LTTNG_UST_ABI_MINOR_VERSION
);
4535 ERR("UST app recv reg message failed with ret %d", ret
);
4540 msg
->pid
= (pid_t
) pid
;
4541 msg
->ppid
= (pid_t
) ppid
;
4542 msg
->uid
= (uid_t
) uid
;
4543 msg
->gid
= (gid_t
) gid
;
4550 * Return a ust app channel object using the application object and the channel
4551 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4552 * lock MUST be acquired before calling this function.
4554 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4557 struct lttng_ht_node_ulong
*node
;
4558 struct lttng_ht_iter iter
;
4559 struct ust_app_channel
*ua_chan
= NULL
;
4563 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4564 node
= lttng_ht_iter_get_node_ulong(&iter
);
4566 DBG2("UST app channel find by objd %d not found", objd
);
4570 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4577 * Reply to a register channel notification from an application on the notify
4578 * socket. The channel metadata is also created.
4580 * The session UST registry lock is acquired in this function.
4582 * On success 0 is returned else a negative value.
4584 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4585 size_t nr_fields
, struct ustctl_field
*fields
)
4587 int ret
, ret_code
= 0;
4588 uint32_t chan_id
, reg_count
;
4589 uint64_t chan_reg_key
;
4590 enum ustctl_channel_header type
;
4591 struct ust_app
*app
;
4592 struct ust_app_channel
*ua_chan
;
4593 struct ust_app_session
*ua_sess
;
4594 struct ust_registry_session
*registry
;
4595 struct ust_registry_channel
*chan_reg
;
4599 /* Lookup application. If not found, there is a code flow error. */
4600 app
= find_app_by_notify_sock(sock
);
4602 DBG("Application socket %d is being teardown. Abort event notify",
4606 goto error_rcu_unlock
;
4609 /* Lookup channel by UST object descriptor. */
4610 ua_chan
= find_channel_by_objd(app
, cobjd
);
4612 DBG("Application channel is being teardown. Abort event notify");
4615 goto error_rcu_unlock
;
4618 assert(ua_chan
->session
);
4619 ua_sess
= ua_chan
->session
;
4621 /* Get right session registry depending on the session buffer type. */
4622 registry
= get_session_registry(ua_sess
);
4625 /* Depending on the buffer type, a different channel key is used. */
4626 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4627 chan_reg_key
= ua_chan
->tracing_channel_id
;
4629 chan_reg_key
= ua_chan
->key
;
4632 pthread_mutex_lock(®istry
->lock
);
4634 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4637 if (!chan_reg
->register_done
) {
4638 reg_count
= ust_registry_get_event_count(chan_reg
);
4639 if (reg_count
< 31) {
4640 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4642 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4645 chan_reg
->nr_ctx_fields
= nr_fields
;
4646 chan_reg
->ctx_fields
= fields
;
4647 chan_reg
->header_type
= type
;
4649 /* Get current already assigned values. */
4650 type
= chan_reg
->header_type
;
4652 /* Set to NULL so the error path does not do a double free. */
4655 /* Channel id is set during the object creation. */
4656 chan_id
= chan_reg
->chan_id
;
4658 /* Append to metadata */
4659 if (!chan_reg
->metadata_dumped
) {
4660 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4662 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4668 DBG3("UST app replying to register channel key %" PRIu64
4669 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4672 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4674 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4675 ERR("UST app reply channel failed with ret %d", ret
);
4677 DBG3("UST app reply channel failed. Application died");
4682 /* This channel registry registration is completed. */
4683 chan_reg
->register_done
= 1;
4686 pthread_mutex_unlock(®istry
->lock
);
4696 * Add event to the UST channel registry. When the event is added to the
4697 * registry, the metadata is also created. Once done, this replies to the
4698 * application with the appropriate error code.
4700 * The session UST registry lock is acquired in the function.
4702 * On success 0 is returned else a negative value.
4704 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4705 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4706 char *model_emf_uri
)
4709 uint32_t event_id
= 0;
4710 uint64_t chan_reg_key
;
4711 struct ust_app
*app
;
4712 struct ust_app_channel
*ua_chan
;
4713 struct ust_app_session
*ua_sess
;
4714 struct ust_registry_session
*registry
;
4718 /* Lookup application. If not found, there is a code flow error. */
4719 app
= find_app_by_notify_sock(sock
);
4721 DBG("Application socket %d is being teardown. Abort event notify",
4726 free(model_emf_uri
);
4727 goto error_rcu_unlock
;
4730 /* Lookup channel by UST object descriptor. */
4731 ua_chan
= find_channel_by_objd(app
, cobjd
);
4733 DBG("Application channel is being teardown. Abort event notify");
4737 free(model_emf_uri
);
4738 goto error_rcu_unlock
;
4741 assert(ua_chan
->session
);
4742 ua_sess
= ua_chan
->session
;
4744 registry
= get_session_registry(ua_sess
);
4747 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4748 chan_reg_key
= ua_chan
->tracing_channel_id
;
4750 chan_reg_key
= ua_chan
->key
;
4753 pthread_mutex_lock(®istry
->lock
);
4756 * From this point on, this call acquires the ownership of the sig, fields
4757 * and model_emf_uri meaning any free are done inside it if needed. These
4758 * three variables MUST NOT be read/write after this.
4760 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4761 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4762 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4766 * The return value is returned to ustctl so in case of an error, the
4767 * application can be notified. In case of an error, it's important not to
4768 * return a negative error or else the application will get closed.
4770 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4772 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4773 ERR("UST app reply event failed with ret %d", ret
);
4775 DBG3("UST app reply event failed. Application died");
4778 * No need to wipe the create event since the application socket will
4779 * get close on error hence cleaning up everything by itself.
4784 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4788 pthread_mutex_unlock(®istry
->lock
);
4795 * Handle application notification through the given notify socket.
4797 * Return 0 on success or else a negative value.
4799 int ust_app_recv_notify(int sock
)
4802 enum ustctl_notify_cmd cmd
;
4804 DBG3("UST app receiving notify from sock %d", sock
);
4806 ret
= ustctl_recv_notify(sock
, &cmd
);
4808 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4809 ERR("UST app recv notify failed with ret %d", ret
);
4811 DBG3("UST app recv notify failed. Application died");
4817 case USTCTL_NOTIFY_CMD_EVENT
:
4819 int sobjd
, cobjd
, loglevel
;
4820 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4822 struct ustctl_field
*fields
;
4824 DBG2("UST app ustctl register event received");
4826 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4827 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4829 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4830 ERR("UST app recv event failed with ret %d", ret
);
4832 DBG3("UST app recv event failed. Application died");
4838 * Add event to the UST registry coming from the notify socket. This
4839 * call will free if needed the sig, fields and model_emf_uri. This
4840 * code path loses the ownsership of these variables and transfer them
4841 * to the this function.
4843 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4844 fields
, loglevel
, model_emf_uri
);
4851 case USTCTL_NOTIFY_CMD_CHANNEL
:
4855 struct ustctl_field
*fields
;
4857 DBG2("UST app ustctl register channel received");
4859 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4862 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4863 ERR("UST app recv channel failed with ret %d", ret
);
4865 DBG3("UST app recv channel failed. Application died");
4871 * The fields ownership are transfered to this function call meaning
4872 * that if needed it will be freed. After this, it's invalid to access
4873 * fields or clean it up.
4875 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4884 /* Should NEVER happen. */
4893 * Once the notify socket hangs up, this is called. First, it tries to find the
4894 * corresponding application. On failure, the call_rcu to close the socket is
4895 * executed. If an application is found, it tries to delete it from the notify
4896 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4898 * Note that an object needs to be allocated here so on ENOMEM failure, the
4899 * call RCU is not done but the rest of the cleanup is.
4901 void ust_app_notify_sock_unregister(int sock
)
4904 struct lttng_ht_iter iter
;
4905 struct ust_app
*app
;
4906 struct ust_app_notify_sock_obj
*obj
;
4912 obj
= zmalloc(sizeof(*obj
));
4915 * An ENOMEM is kind of uncool. If this strikes we continue the
4916 * procedure but the call_rcu will not be called. In this case, we
4917 * accept the fd leak rather than possibly creating an unsynchronized
4918 * state between threads.
4920 * TODO: The notify object should be created once the notify socket is
4921 * registered and stored independantely from the ust app object. The
4922 * tricky part is to synchronize the teardown of the application and
4923 * this notify object. Let's keep that in mind so we can avoid this
4924 * kind of shenanigans with ENOMEM in the teardown path.
4931 DBG("UST app notify socket unregister %d", sock
);
4934 * Lookup application by notify socket. If this fails, this means that the
4935 * hash table delete has already been done by the application
4936 * unregistration process so we can safely close the notify socket in a
4939 app
= find_app_by_notify_sock(sock
);
4944 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4947 * Whatever happens here either we fail or succeed, in both cases we have
4948 * to close the socket after a grace period to continue to the call RCU
4949 * here. If the deletion is successful, the application is not visible
4950 * anymore by other threads and is it fails it means that it was already
4951 * deleted from the hash table so either way we just have to close the
4954 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4960 * Close socket after a grace period to avoid for the socket to be reused
4961 * before the application object is freed creating potential race between
4962 * threads trying to add unique in the global hash table.
4965 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4970 * Destroy a ust app data structure and free its memory.
4972 void ust_app_destroy(struct ust_app
*app
)
4978 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4982 * Take a snapshot for a given UST session. The snapshot is sent to the given
4985 * Return 0 on success or else a negative value.
4987 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4988 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4991 struct lttng_ht_iter iter
;
4992 struct ust_app
*app
;
4993 char pathname
[PATH_MAX
];
4994 uint64_t max_stream_size
= 0;
5002 * Compute the maximum size of a single stream if a max size is asked by
5005 if (output
->max_size
> 0 && nb_streams
> 0) {
5006 max_stream_size
= output
->max_size
/ nb_streams
;
5009 switch (usess
->buffer_type
) {
5010 case LTTNG_BUFFER_PER_UID
:
5012 struct buffer_reg_uid
*reg
;
5014 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5015 struct buffer_reg_channel
*reg_chan
;
5016 struct consumer_socket
*socket
;
5018 /* Get consumer socket to use to push the metadata.*/
5019 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5026 memset(pathname
, 0, sizeof(pathname
));
5027 ret
= snprintf(pathname
, sizeof(pathname
),
5028 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5029 reg
->uid
, reg
->bits_per_long
);
5031 PERROR("snprintf snapshot path");
5035 /* Add the UST default trace dir to path. */
5036 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5037 reg_chan
, node
.node
) {
5040 * Make sure the maximum stream size is not lower than the
5041 * subbuffer size or else it's an error since we won't be able to
5042 * snapshot anything.
5044 if (max_stream_size
&&
5045 reg_chan
->subbuf_size
> max_stream_size
) {
5047 DBG3("UST app snapshot record maximum stream size %" PRIu64
5048 " is smaller than subbuffer size of %zu",
5049 max_stream_size
, reg_chan
->subbuf_size
);
5052 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5053 usess
->uid
, usess
->gid
, pathname
, wait
,
5059 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5060 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5068 case LTTNG_BUFFER_PER_PID
:
5070 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5071 struct consumer_socket
*socket
;
5072 struct lttng_ht_iter chan_iter
;
5073 struct ust_app_channel
*ua_chan
;
5074 struct ust_app_session
*ua_sess
;
5075 struct ust_registry_session
*registry
;
5077 ua_sess
= lookup_session_by_app(usess
, app
);
5079 /* Session not associated with this app. */
5083 /* Get the right consumer socket for the application. */
5084 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5091 /* Add the UST default trace dir to path. */
5092 memset(pathname
, 0, sizeof(pathname
));
5093 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5096 PERROR("snprintf snapshot path");
5100 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5101 ua_chan
, node
.node
) {
5103 * Make sure the maximum stream size is not lower than the
5104 * subbuffer size or else it's an error since we won't be able to
5105 * snapshot anything.
5107 if (max_stream_size
&&
5108 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5110 DBG3("UST app snapshot record maximum stream size %" PRIu64
5111 " is smaller than subbuffer size of %" PRIu64
,
5112 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5116 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5117 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5124 registry
= get_session_registry(ua_sess
);
5126 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5127 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5146 * Return the number of streams for a UST session.
5148 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5150 unsigned int ret
= 0;
5151 struct ust_app
*app
;
5152 struct lttng_ht_iter iter
;
5156 switch (usess
->buffer_type
) {
5157 case LTTNG_BUFFER_PER_UID
:
5159 struct buffer_reg_uid
*reg
;
5161 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5162 struct buffer_reg_channel
*reg_chan
;
5164 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5165 reg_chan
, node
.node
) {
5166 ret
+= reg_chan
->stream_count
;
5171 case LTTNG_BUFFER_PER_PID
:
5174 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5175 struct ust_app_channel
*ua_chan
;
5176 struct ust_app_session
*ua_sess
;
5177 struct lttng_ht_iter chan_iter
;
5179 ua_sess
= lookup_session_by_app(usess
, app
);
5181 /* Session not associated with this app. */
5185 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5186 ua_chan
, node
.node
) {
5187 ret
+= ua_chan
->streams
.count
;