2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
143 /* One of the exclusions is NULL, fail. */
144 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
148 if (key
->exclusion
&& event
->exclusion
) {
149 /* Both exclusions exists, check count followed by the names. */
150 if (event
->exclusion
->count
!= key
->exclusion
->count
||
151 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
152 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
166 * Unique add of an ust app event in the given ht. This uses the custom
167 * ht_match_ust_app_event match function and the event name as hash.
169 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
170 struct ust_app_event
*event
)
172 struct cds_lfht_node
*node_ptr
;
173 struct ust_app_ht_key key
;
177 assert(ua_chan
->events
);
180 ht
= ua_chan
->events
;
181 key
.name
= event
->attr
.name
;
182 key
.filter
= event
->filter
;
183 key
.loglevel
= event
->attr
.loglevel
;
184 key
.exclusion
= event
->exclusion
;
186 node_ptr
= cds_lfht_add_unique(ht
->ht
,
187 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
188 ht_match_ust_app_event
, &key
, &event
->node
.node
);
189 assert(node_ptr
== &event
->node
.node
);
193 * Close the notify socket from the given RCU head object. This MUST be called
194 * through a call_rcu().
196 static void close_notify_sock_rcu(struct rcu_head
*head
)
199 struct ust_app_notify_sock_obj
*obj
=
200 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
202 /* Must have a valid fd here. */
203 assert(obj
->fd
>= 0);
205 ret
= close(obj
->fd
);
207 ERR("close notify sock %d RCU", obj
->fd
);
209 lttng_fd_put(LTTNG_FD_APPS
, 1);
215 * Return the session registry according to the buffer type of the given
218 * A registry per UID object MUST exists before calling this function or else
219 * it assert() if not found. RCU read side lock must be acquired.
221 static struct ust_registry_session
*get_session_registry(
222 struct ust_app_session
*ua_sess
)
224 struct ust_registry_session
*registry
= NULL
;
228 switch (ua_sess
->buffer_type
) {
229 case LTTNG_BUFFER_PER_PID
:
231 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
235 registry
= reg_pid
->registry
->reg
.ust
;
238 case LTTNG_BUFFER_PER_UID
:
240 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
241 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
245 registry
= reg_uid
->registry
->reg
.ust
;
257 * Delete ust context safely. RCU read lock must be held before calling
261 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
268 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
269 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
270 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
271 sock
, ua_ctx
->obj
->handle
, ret
);
279 * Delete ust app event safely. RCU read lock must be held before calling
283 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
289 free(ua_event
->filter
);
290 if (ua_event
->exclusion
!= NULL
)
291 free(ua_event
->exclusion
);
292 if (ua_event
->obj
!= NULL
) {
293 ret
= ustctl_release_object(sock
, ua_event
->obj
);
294 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
295 ERR("UST app sock %d release event obj failed with ret %d",
304 * Release ust data object of the given stream.
306 * Return 0 on success or else a negative value.
308 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
315 ret
= ustctl_release_object(sock
, stream
->obj
);
316 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
317 ERR("UST app sock %d release stream obj failed with ret %d",
320 lttng_fd_put(LTTNG_FD_APPS
, 2);
328 * Delete ust app stream safely. RCU read lock must be held before calling
332 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
336 (void) release_ust_app_stream(sock
, stream
);
341 * We need to execute ht_destroy outside of RCU read-side critical
342 * section and outside of call_rcu thread, so we postpone its execution
343 * using ht_cleanup_push. It is simpler than to change the semantic of
344 * the many callers of delete_ust_app_session().
347 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
349 struct ust_app_channel
*ua_chan
=
350 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
352 ht_cleanup_push(ua_chan
->ctx
);
353 ht_cleanup_push(ua_chan
->events
);
358 * Delete ust app channel safely. RCU read lock must be held before calling
362 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
366 struct lttng_ht_iter iter
;
367 struct ust_app_event
*ua_event
;
368 struct ust_app_ctx
*ua_ctx
;
369 struct ust_app_stream
*stream
, *stmp
;
370 struct ust_registry_session
*registry
;
374 DBG3("UST app deleting channel %s", ua_chan
->name
);
377 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
378 cds_list_del(&stream
->list
);
379 delete_ust_app_stream(sock
, stream
);
383 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
384 cds_list_del(&ua_ctx
->list
);
385 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
387 delete_ust_app_ctx(sock
, ua_ctx
);
391 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
393 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
395 delete_ust_app_event(sock
, ua_event
);
398 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
399 /* Wipe and free registry from session registry. */
400 registry
= get_session_registry(ua_chan
->session
);
402 ust_registry_channel_del_free(registry
, ua_chan
->key
);
406 if (ua_chan
->obj
!= NULL
) {
407 /* Remove channel from application UST object descriptor. */
408 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
409 lttng_ht_del(app
->ust_objd
, &iter
);
410 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
411 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
412 ERR("UST app sock %d release channel obj failed with ret %d",
415 lttng_fd_put(LTTNG_FD_APPS
, 1);
418 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
422 * Push metadata to consumer socket.
424 * The socket lock MUST be acquired.
425 * The ust app session lock MUST be acquired.
427 * On success, return the len of metadata pushed or else a negative value.
429 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
430 struct consumer_socket
*socket
, int send_zero_data
)
433 char *metadata_str
= NULL
;
441 * On a push metadata error either the consumer is dead or the metadata
442 * channel has been destroyed because its endpoint might have died (e.g:
443 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
444 * metadata again which is not valid anymore on the consumer side.
446 * The ust app session mutex locked allows us to make this check without
449 if (registry
->metadata_closed
) {
453 pthread_mutex_lock(®istry
->lock
);
455 offset
= registry
->metadata_len_sent
;
456 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
458 DBG3("No metadata to push for metadata key %" PRIu64
,
459 registry
->metadata_key
);
461 if (send_zero_data
) {
462 DBG("No metadata to push");
468 /* Allocate only what we have to send. */
469 metadata_str
= zmalloc(len
);
471 PERROR("zmalloc ust app metadata string");
475 /* Copy what we haven't send out. */
476 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
477 registry
->metadata_len_sent
+= len
;
480 pthread_mutex_unlock(®istry
->lock
);
481 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
482 metadata_str
, len
, offset
);
493 pthread_mutex_unlock(®istry
->lock
);
500 * For a given application and session, push metadata to consumer. The session
501 * lock MUST be acquired here before calling this.
502 * Either sock or consumer is required : if sock is NULL, the default
503 * socket to send the metadata is retrieved from consumer, if sock
504 * is not NULL we use it to send the metadata.
506 * Return 0 on success else a negative error.
508 static int push_metadata(struct ust_registry_session
*registry
,
509 struct consumer_output
*consumer
)
513 struct consumer_socket
*socket
;
521 * Means that no metadata was assigned to the session. This can happens if
522 * no start has been done previously.
524 if (!registry
->metadata_key
) {
529 /* Get consumer socket to use to push the metadata.*/
530 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
534 goto error_rcu_unlock
;
538 * TODO: Currently, we hold the socket lock around sampling of the next
539 * metadata segment to ensure we send metadata over the consumer socket in
540 * the correct order. This makes the registry lock nest inside the socket
543 * Please note that this is a temporary measure: we should move this lock
544 * back into ust_consumer_push_metadata() when the consumer gets the
545 * ability to reorder the metadata it receives.
547 pthread_mutex_lock(socket
->lock
);
548 ret
= ust_app_push_metadata(registry
, socket
, 0);
549 pthread_mutex_unlock(socket
->lock
);
552 goto error_rcu_unlock
;
560 * On error, flag the registry that the metadata is closed. We were unable
561 * to push anything and this means that either the consumer is not
562 * responding or the metadata cache has been destroyed on the consumer.
564 registry
->metadata_closed
= 1;
571 * Send to the consumer a close metadata command for the given session. Once
572 * done, the metadata channel is deleted and the session metadata pointer is
573 * nullified. The session lock MUST be acquired here unless the application is
574 * in the destroy path.
576 * Return 0 on success else a negative value.
578 static int close_metadata(struct ust_registry_session
*registry
,
579 struct consumer_output
*consumer
)
582 struct consumer_socket
*socket
;
589 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
594 /* Get consumer socket to use to push the metadata.*/
595 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
602 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
609 * Metadata closed. Even on error this means that the consumer is not
610 * responding or not found so either way a second close should NOT be emit
613 registry
->metadata_closed
= 1;
620 * We need to execute ht_destroy outside of RCU read-side critical
621 * section and outside of call_rcu thread, so we postpone its execution
622 * using ht_cleanup_push. It is simpler than to change the semantic of
623 * the many callers of delete_ust_app_session().
626 void delete_ust_app_session_rcu(struct rcu_head
*head
)
628 struct ust_app_session
*ua_sess
=
629 caa_container_of(head
, struct ust_app_session
, rcu_head
);
631 ht_cleanup_push(ua_sess
->channels
);
636 * Delete ust app session safely. RCU read lock must be held before calling
640 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
644 struct lttng_ht_iter iter
;
645 struct ust_app_channel
*ua_chan
;
646 struct ust_registry_session
*registry
;
650 pthread_mutex_lock(&ua_sess
->lock
);
652 registry
= get_session_registry(ua_sess
);
653 if (registry
&& !registry
->metadata_closed
) {
654 /* Push metadata for application before freeing the application. */
655 (void) push_metadata(registry
, ua_sess
->consumer
);
658 * Don't ask to close metadata for global per UID buffers. Close
659 * metadata only on destroy trace session in this case. Also, the
660 * previous push metadata could have flag the metadata registry to
661 * close so don't send a close command if closed.
663 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
664 !registry
->metadata_closed
) {
665 /* And ask to close it for this session registry. */
666 (void) close_metadata(registry
, ua_sess
->consumer
);
670 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
672 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
674 delete_ust_app_channel(sock
, ua_chan
, app
);
677 /* In case of per PID, the registry is kept in the session. */
678 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
679 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
681 buffer_reg_pid_remove(reg_pid
);
682 buffer_reg_pid_destroy(reg_pid
);
686 if (ua_sess
->handle
!= -1) {
687 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
688 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
689 ERR("UST app sock %d release session handle failed with ret %d",
693 pthread_mutex_unlock(&ua_sess
->lock
);
695 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
699 * Delete a traceable application structure from the global list. Never call
700 * this function outside of a call_rcu call.
702 * RCU read side lock should _NOT_ be held when calling this function.
705 void delete_ust_app(struct ust_app
*app
)
708 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
710 /* Delete ust app sessions info */
715 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
717 /* Free every object in the session and the session. */
719 delete_ust_app_session(sock
, ua_sess
, app
);
723 ht_cleanup_push(app
->sessions
);
724 ht_cleanup_push(app
->ust_objd
);
727 * Wait until we have deleted the application from the sock hash table
728 * before closing this socket, otherwise an application could re-use the
729 * socket ID and race with the teardown, using the same hash table entry.
731 * It's OK to leave the close in call_rcu. We want it to stay unique for
732 * all RCU readers that could run concurrently with unregister app,
733 * therefore we _need_ to only close that socket after a grace period. So
734 * it should stay in this RCU callback.
736 * This close() is a very important step of the synchronization model so
737 * every modification to this function must be carefully reviewed.
743 lttng_fd_put(LTTNG_FD_APPS
, 1);
745 DBG2("UST app pid %d deleted", app
->pid
);
750 * URCU intermediate call to delete an UST app.
753 void delete_ust_app_rcu(struct rcu_head
*head
)
755 struct lttng_ht_node_ulong
*node
=
756 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
757 struct ust_app
*app
=
758 caa_container_of(node
, struct ust_app
, pid_n
);
760 DBG3("Call RCU deleting app PID %d", app
->pid
);
765 * Delete the session from the application ht and delete the data structure by
766 * freeing every object inside and releasing them.
768 static void destroy_app_session(struct ust_app
*app
,
769 struct ust_app_session
*ua_sess
)
772 struct lttng_ht_iter iter
;
777 iter
.iter
.node
= &ua_sess
->node
.node
;
778 ret
= lttng_ht_del(app
->sessions
, &iter
);
780 /* Already scheduled for teardown. */
784 /* Once deleted, free the data structure. */
785 delete_ust_app_session(app
->sock
, ua_sess
, app
);
792 * Alloc new UST app session.
795 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
797 struct ust_app_session
*ua_sess
;
799 /* Init most of the default value by allocating and zeroing */
800 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
801 if (ua_sess
== NULL
) {
806 ua_sess
->handle
= -1;
807 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
808 pthread_mutex_init(&ua_sess
->lock
, NULL
);
817 * Alloc new UST app channel.
820 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
821 struct ust_app_session
*ua_sess
,
822 struct lttng_ust_channel_attr
*attr
)
824 struct ust_app_channel
*ua_chan
;
826 /* Init most of the default value by allocating and zeroing */
827 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
828 if (ua_chan
== NULL
) {
833 /* Setup channel name */
834 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
835 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
837 ua_chan
->enabled
= 1;
838 ua_chan
->handle
= -1;
839 ua_chan
->session
= ua_sess
;
840 ua_chan
->key
= get_next_channel_key();
841 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
842 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
843 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
845 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
846 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
848 /* Copy attributes */
850 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
851 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
852 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
853 ua_chan
->attr
.overwrite
= attr
->overwrite
;
854 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
855 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
856 ua_chan
->attr
.output
= attr
->output
;
858 /* By default, the channel is a per cpu channel. */
859 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
861 DBG3("UST app channel %s allocated", ua_chan
->name
);
870 * Allocate and initialize a UST app stream.
872 * Return newly allocated stream pointer or NULL on error.
874 struct ust_app_stream
*ust_app_alloc_stream(void)
876 struct ust_app_stream
*stream
= NULL
;
878 stream
= zmalloc(sizeof(*stream
));
879 if (stream
== NULL
) {
880 PERROR("zmalloc ust app stream");
884 /* Zero could be a valid value for a handle so flag it to -1. */
892 * Alloc new UST app event.
895 struct ust_app_event
*alloc_ust_app_event(char *name
,
896 struct lttng_ust_event
*attr
)
898 struct ust_app_event
*ua_event
;
900 /* Init most of the default value by allocating and zeroing */
901 ua_event
= zmalloc(sizeof(struct ust_app_event
));
902 if (ua_event
== NULL
) {
907 ua_event
->enabled
= 1;
908 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
909 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
910 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
912 /* Copy attributes */
914 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
917 DBG3("UST app event %s allocated", ua_event
->name
);
926 * Alloc new UST app context.
929 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
931 struct ust_app_ctx
*ua_ctx
;
933 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
934 if (ua_ctx
== NULL
) {
938 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
941 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
944 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
951 * Allocate a filter and copy the given original filter.
953 * Return allocated filter or NULL on error.
955 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
956 struct lttng_ust_filter_bytecode
*orig_f
)
958 struct lttng_ust_filter_bytecode
*filter
= NULL
;
960 /* Copy filter bytecode */
961 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
963 PERROR("zmalloc alloc ust app filter");
967 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
974 * Find an ust_app using the sock and return it. RCU read side lock must be
975 * held before calling this helper function.
977 struct ust_app
*ust_app_find_by_sock(int sock
)
979 struct lttng_ht_node_ulong
*node
;
980 struct lttng_ht_iter iter
;
982 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
983 node
= lttng_ht_iter_get_node_ulong(&iter
);
985 DBG2("UST app find by sock %d not found", sock
);
989 return caa_container_of(node
, struct ust_app
, sock_n
);
996 * Find an ust_app using the notify sock and return it. RCU read side lock must
997 * be held before calling this helper function.
999 static struct ust_app
*find_app_by_notify_sock(int sock
)
1001 struct lttng_ht_node_ulong
*node
;
1002 struct lttng_ht_iter iter
;
1004 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1006 node
= lttng_ht_iter_get_node_ulong(&iter
);
1008 DBG2("UST app find by notify sock %d not found", sock
);
1012 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1019 * Lookup for an ust app event based on event name, filter bytecode and the
1022 * Return an ust_app_event object or NULL on error.
1024 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1025 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1026 const struct lttng_event_exclusion
*exclusion
)
1028 struct lttng_ht_iter iter
;
1029 struct lttng_ht_node_str
*node
;
1030 struct ust_app_event
*event
= NULL
;
1031 struct ust_app_ht_key key
;
1036 /* Setup key for event lookup. */
1038 key
.filter
= filter
;
1039 key
.loglevel
= loglevel
;
1040 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1041 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1043 /* Lookup using the event name as hash and a custom match fct. */
1044 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1045 ht_match_ust_app_event
, &key
, &iter
.iter
);
1046 node
= lttng_ht_iter_get_node_str(&iter
);
1051 event
= caa_container_of(node
, struct ust_app_event
, node
);
1058 * Create the channel context on the tracer.
1060 * Called with UST app session lock held.
1063 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1064 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1068 health_code_update();
1070 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1071 ua_chan
->obj
, &ua_ctx
->obj
);
1073 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1074 ERR("UST app create channel context failed for app (pid: %d) "
1075 "with ret %d", app
->pid
, ret
);
1078 * This is normal behavior, an application can die during the
1079 * creation process. Don't report an error so the execution can
1080 * continue normally.
1083 DBG3("UST app disable event failed. Application is dead.");
1088 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1090 DBG2("UST app context handle %d created successfully for channel %s",
1091 ua_ctx
->handle
, ua_chan
->name
);
1094 health_code_update();
1099 * Set the filter on the tracer.
1102 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1103 struct ust_app
*app
)
1107 health_code_update();
1109 if (!ua_event
->filter
) {
1114 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1117 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1118 ERR("UST app event %s filter failed for app (pid: %d) "
1119 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1122 * This is normal behavior, an application can die during the
1123 * creation process. Don't report an error so the execution can
1124 * continue normally.
1127 DBG3("UST app filter event failed. Application is dead.");
1132 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1135 health_code_update();
1140 * Set event exclusions on the tracer.
1143 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1144 struct ust_app
*app
)
1148 health_code_update();
1150 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1155 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1158 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1159 ERR("UST app event %s exclusions failed for app (pid: %d) "
1160 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1163 * This is normal behavior, an application can die during the
1164 * creation process. Don't report an error so the execution can
1165 * continue normally.
1168 DBG3("UST app event exclusion failed. Application is dead.");
1173 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1176 health_code_update();
1181 * Disable the specified event on to UST tracer for the UST session.
1183 static int disable_ust_event(struct ust_app
*app
,
1184 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1188 health_code_update();
1190 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1192 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1193 ERR("UST app event %s disable failed for app (pid: %d) "
1194 "and session handle %d with ret %d",
1195 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1198 * This is normal behavior, an application can die during the
1199 * creation process. Don't report an error so the execution can
1200 * continue normally.
1203 DBG3("UST app disable event failed. Application is dead.");
1208 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1209 ua_event
->attr
.name
, app
->pid
);
1212 health_code_update();
1217 * Disable the specified channel on to UST tracer for the UST session.
1219 static int disable_ust_channel(struct ust_app
*app
,
1220 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1224 health_code_update();
1226 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1228 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1229 ERR("UST app channel %s disable failed for app (pid: %d) "
1230 "and session handle %d with ret %d",
1231 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1234 * This is normal behavior, an application can die during the
1235 * creation process. Don't report an error so the execution can
1236 * continue normally.
1239 DBG3("UST app disable channel failed. Application is dead.");
1244 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1245 ua_chan
->name
, app
->pid
);
1248 health_code_update();
1253 * Enable the specified channel on to UST tracer for the UST session.
1255 static int enable_ust_channel(struct ust_app
*app
,
1256 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1260 health_code_update();
1262 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1264 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1265 ERR("UST app channel %s enable failed for app (pid: %d) "
1266 "and session handle %d with ret %d",
1267 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1270 * This is normal behavior, an application can die during the
1271 * creation process. Don't report an error so the execution can
1272 * continue normally.
1275 DBG3("UST app enable channel failed. Application is dead.");
1280 ua_chan
->enabled
= 1;
1282 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1283 ua_chan
->name
, app
->pid
);
1286 health_code_update();
1291 * Enable the specified event on to UST tracer for the UST session.
1293 static int enable_ust_event(struct ust_app
*app
,
1294 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1298 health_code_update();
1300 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1302 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1303 ERR("UST app event %s enable failed for app (pid: %d) "
1304 "and session handle %d with ret %d",
1305 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1308 * This is normal behavior, an application can die during the
1309 * creation process. Don't report an error so the execution can
1310 * continue normally.
1313 DBG3("UST app enable event failed. Application is dead.");
1318 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1319 ua_event
->attr
.name
, app
->pid
);
1322 health_code_update();
1327 * Send channel and stream buffer to application.
1329 * Return 0 on success. On error, a negative value is returned.
1331 static int send_channel_pid_to_ust(struct ust_app
*app
,
1332 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1335 struct ust_app_stream
*stream
, *stmp
;
1341 health_code_update();
1343 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1346 /* Send channel to the application. */
1347 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1352 health_code_update();
1354 /* Send all streams to application. */
1355 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1356 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1360 /* We don't need the stream anymore once sent to the tracer. */
1361 cds_list_del(&stream
->list
);
1362 delete_ust_app_stream(-1, stream
);
1364 /* Flag the channel that it is sent to the application. */
1365 ua_chan
->is_sent
= 1;
1368 health_code_update();
1373 * Create the specified event onto the UST tracer for a UST session.
1375 * Should be called with session mutex held.
1378 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1379 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1383 health_code_update();
1385 /* Create UST event on tracer */
1386 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1389 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1390 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1391 ua_event
->attr
.name
, app
->pid
, ret
);
1394 * This is normal behavior, an application can die during the
1395 * creation process. Don't report an error so the execution can
1396 * continue normally.
1399 DBG3("UST app create event failed. Application is dead.");
1404 ua_event
->handle
= ua_event
->obj
->handle
;
1406 DBG2("UST app event %s created successfully for pid:%d",
1407 ua_event
->attr
.name
, app
->pid
);
1409 health_code_update();
1411 /* Set filter if one is present. */
1412 if (ua_event
->filter
) {
1413 ret
= set_ust_event_filter(ua_event
, app
);
1419 /* Set exclusions for the event */
1420 if (ua_event
->exclusion
) {
1421 ret
= set_ust_event_exclusion(ua_event
, app
);
1427 /* If event not enabled, disable it on the tracer */
1428 if (ua_event
->enabled
== 0) {
1429 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1432 * If we hit an EPERM, something is wrong with our disable call. If
1433 * we get an EEXIST, there is a problem on the tracer side since we
1437 case -LTTNG_UST_ERR_PERM
:
1438 /* Code flow problem */
1440 case -LTTNG_UST_ERR_EXIST
:
1441 /* It's OK for our use case. */
1452 health_code_update();
1457 * Copy data between an UST app event and a LTT event.
1459 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1460 struct ltt_ust_event
*uevent
)
1462 size_t exclusion_alloc_size
;
1464 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1465 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1467 ua_event
->enabled
= uevent
->enabled
;
1469 /* Copy event attributes */
1470 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1472 /* Copy filter bytecode */
1473 if (uevent
->filter
) {
1474 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1475 /* Filter might be NULL here in case of ENONEM. */
1478 /* Copy exclusion data */
1479 if (uevent
->exclusion
) {
1480 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1481 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1482 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1483 if (ua_event
->exclusion
== NULL
) {
1486 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1487 exclusion_alloc_size
);
1493 * Copy data between an UST app channel and a LTT channel.
1495 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1496 struct ltt_ust_channel
*uchan
)
1498 struct lttng_ht_iter iter
;
1499 struct ltt_ust_event
*uevent
;
1500 struct ltt_ust_context
*uctx
;
1501 struct ust_app_event
*ua_event
;
1502 struct ust_app_ctx
*ua_ctx
;
1504 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1506 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1507 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1509 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1510 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1512 /* Copy event attributes since the layout is different. */
1513 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1514 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1515 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1516 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1517 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1518 ua_chan
->attr
.output
= uchan
->attr
.output
;
1520 * Note that the attribute channel type is not set since the channel on the
1521 * tracing registry side does not have this information.
1524 ua_chan
->enabled
= uchan
->enabled
;
1525 ua_chan
->tracing_channel_id
= uchan
->id
;
1527 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1528 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1529 if (ua_ctx
== NULL
) {
1532 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1533 (unsigned long) ua_ctx
->ctx
.ctx
);
1534 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1535 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1538 /* Copy all events from ltt ust channel to ust app channel */
1539 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1540 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1541 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1542 if (ua_event
== NULL
) {
1543 DBG2("UST event %s not found on shadow copy channel",
1545 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1546 if (ua_event
== NULL
) {
1549 shadow_copy_event(ua_event
, uevent
);
1550 add_unique_ust_app_event(ua_chan
, ua_event
);
1554 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1558 * Copy data between a UST app session and a regular LTT session.
1560 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1561 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1563 struct lttng_ht_node_str
*ua_chan_node
;
1564 struct lttng_ht_iter iter
;
1565 struct ltt_ust_channel
*uchan
;
1566 struct ust_app_channel
*ua_chan
;
1568 struct tm
*timeinfo
;
1572 /* Get date and time for unique app path */
1574 timeinfo
= localtime(&rawtime
);
1575 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1577 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1579 ua_sess
->tracing_id
= usess
->id
;
1580 ua_sess
->id
= get_next_session_id();
1581 ua_sess
->uid
= app
->uid
;
1582 ua_sess
->gid
= app
->gid
;
1583 ua_sess
->euid
= usess
->uid
;
1584 ua_sess
->egid
= usess
->gid
;
1585 ua_sess
->buffer_type
= usess
->buffer_type
;
1586 ua_sess
->bits_per_long
= app
->bits_per_long
;
1587 /* There is only one consumer object per session possible. */
1588 ua_sess
->consumer
= usess
->consumer
;
1589 ua_sess
->output_traces
= usess
->output_traces
;
1590 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1592 switch (ua_sess
->buffer_type
) {
1593 case LTTNG_BUFFER_PER_PID
:
1594 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1595 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1598 case LTTNG_BUFFER_PER_UID
:
1599 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1600 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1607 PERROR("asprintf UST shadow copy session");
1612 /* Iterate over all channels in global domain. */
1613 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1615 struct lttng_ht_iter uiter
;
1617 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1618 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1619 if (ua_chan_node
!= NULL
) {
1620 /* Session exist. Contiuing. */
1624 DBG2("Channel %s not found on shadow session copy, creating it",
1626 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1627 if (ua_chan
== NULL
) {
1628 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1631 shadow_copy_channel(ua_chan
, uchan
);
1633 * The concept of metadata channel does not exist on the tracing
1634 * registry side of the session daemon so this can only be a per CPU
1635 * channel and not metadata.
1637 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1639 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1647 * Lookup sesison wrapper.
1650 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1651 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1653 /* Get right UST app session from app */
1654 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1658 * Return ust app session from the app session hashtable using the UST session
1661 static struct ust_app_session
*lookup_session_by_app(
1662 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1664 struct lttng_ht_iter iter
;
1665 struct lttng_ht_node_u64
*node
;
1667 __lookup_session_by_app(usess
, app
, &iter
);
1668 node
= lttng_ht_iter_get_node_u64(&iter
);
1673 return caa_container_of(node
, struct ust_app_session
, node
);
1680 * Setup buffer registry per PID for the given session and application. If none
1681 * is found, a new one is created, added to the global registry and
1682 * initialized. If regp is valid, it's set with the newly created object.
1684 * Return 0 on success or else a negative value.
1686 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1687 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1690 struct buffer_reg_pid
*reg_pid
;
1697 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1700 * This is the create channel path meaning that if there is NO
1701 * registry available, we have to create one for this session.
1703 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1707 buffer_reg_pid_add(reg_pid
);
1712 /* Initialize registry. */
1713 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1714 app
->bits_per_long
, app
->uint8_t_alignment
,
1715 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1716 app
->uint64_t_alignment
, app
->long_alignment
,
1717 app
->byte_order
, app
->version
.major
,
1718 app
->version
.minor
);
1723 DBG3("UST app buffer registry per PID created successfully");
1735 * Setup buffer registry per UID for the given session and application. If none
1736 * is found, a new one is created, added to the global registry and
1737 * initialized. If regp is valid, it's set with the newly created object.
1739 * Return 0 on success or else a negative value.
1741 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1742 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1745 struct buffer_reg_uid
*reg_uid
;
1752 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1755 * This is the create channel path meaning that if there is NO
1756 * registry available, we have to create one for this session.
1758 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1759 LTTNG_DOMAIN_UST
, ®_uid
);
1763 buffer_reg_uid_add(reg_uid
);
1768 /* Initialize registry. */
1769 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1770 app
->bits_per_long
, app
->uint8_t_alignment
,
1771 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1772 app
->uint64_t_alignment
, app
->long_alignment
,
1773 app
->byte_order
, app
->version
.major
,
1774 app
->version
.minor
);
1778 /* Add node to teardown list of the session. */
1779 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1781 DBG3("UST app buffer registry per UID created successfully");
1793 * Create a session on the tracer side for the given app.
1795 * On success, ua_sess_ptr is populated with the session pointer or else left
1796 * untouched. If the session was created, is_created is set to 1. On error,
1797 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1800 * Returns 0 on success or else a negative code which is either -ENOMEM or
1801 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1803 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1804 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1807 int ret
, created
= 0;
1808 struct ust_app_session
*ua_sess
;
1812 assert(ua_sess_ptr
);
1814 health_code_update();
1816 ua_sess
= lookup_session_by_app(usess
, app
);
1817 if (ua_sess
== NULL
) {
1818 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1819 app
->pid
, usess
->id
);
1820 ua_sess
= alloc_ust_app_session(app
);
1821 if (ua_sess
== NULL
) {
1822 /* Only malloc can failed so something is really wrong */
1826 shadow_copy_session(ua_sess
, usess
, app
);
1830 switch (usess
->buffer_type
) {
1831 case LTTNG_BUFFER_PER_PID
:
1832 /* Init local registry. */
1833 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1838 case LTTNG_BUFFER_PER_UID
:
1839 /* Look for a global registry. If none exists, create one. */
1840 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1851 health_code_update();
1853 if (ua_sess
->handle
== -1) {
1854 ret
= ustctl_create_session(app
->sock
);
1856 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1857 ERR("Creating session for app pid %d with ret %d",
1860 DBG("UST app creating session failed. Application is dead");
1862 * This is normal behavior, an application can die during the
1863 * creation process. Don't report an error so the execution can
1864 * continue normally. This will get flagged ENOTCONN and the
1865 * caller will handle it.
1869 delete_ust_app_session(-1, ua_sess
, app
);
1870 if (ret
!= -ENOMEM
) {
1872 * Tracer is probably gone or got an internal error so let's
1873 * behave like it will soon unregister or not usable.
1880 ua_sess
->handle
= ret
;
1882 /* Add ust app session to app's HT */
1883 lttng_ht_node_init_u64(&ua_sess
->node
,
1884 ua_sess
->tracing_id
);
1885 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1887 DBG2("UST app session created successfully with handle %d", ret
);
1890 *ua_sess_ptr
= ua_sess
;
1892 *is_created
= created
;
1895 /* Everything went well. */
1899 health_code_update();
1904 * Create a context for the channel on the tracer.
1906 * Called with UST app session lock held and a RCU read side lock.
1909 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1910 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1911 struct ust_app
*app
)
1914 struct lttng_ht_iter iter
;
1915 struct lttng_ht_node_ulong
*node
;
1916 struct ust_app_ctx
*ua_ctx
;
1918 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1920 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1921 node
= lttng_ht_iter_get_node_ulong(&iter
);
1927 ua_ctx
= alloc_ust_app_ctx(uctx
);
1928 if (ua_ctx
== NULL
) {
1934 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1935 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1936 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1938 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1948 * Enable on the tracer side a ust app event for the session and channel.
1950 * Called with UST app session lock held.
1953 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1954 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1958 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1963 ua_event
->enabled
= 1;
1970 * Disable on the tracer side a ust app event for the session and channel.
1972 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1973 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1977 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1982 ua_event
->enabled
= 0;
1989 * Lookup ust app channel for session and disable it on the tracer side.
1992 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1993 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1997 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2002 ua_chan
->enabled
= 0;
2009 * Lookup ust app channel for session and enable it on the tracer side. This
2010 * MUST be called with a RCU read side lock acquired.
2012 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2013 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2016 struct lttng_ht_iter iter
;
2017 struct lttng_ht_node_str
*ua_chan_node
;
2018 struct ust_app_channel
*ua_chan
;
2020 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2021 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2022 if (ua_chan_node
== NULL
) {
2023 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2024 uchan
->name
, ua_sess
->tracing_id
);
2028 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2030 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2040 * Ask the consumer to create a channel and get it if successful.
2042 * Return 0 on success or else a negative value.
2044 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2045 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2046 int bitness
, struct ust_registry_session
*registry
)
2049 unsigned int nb_fd
= 0;
2050 struct consumer_socket
*socket
;
2058 health_code_update();
2060 /* Get the right consumer socket for the application. */
2061 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2067 health_code_update();
2069 /* Need one fd for the channel. */
2070 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2072 ERR("Exhausted number of available FD upon create channel");
2077 * Ask consumer to create channel. The consumer will return the number of
2078 * stream we have to expect.
2080 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2087 * Compute the number of fd needed before receiving them. It must be 2 per
2088 * stream (2 being the default value here).
2090 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2092 /* Reserve the amount of file descriptor we need. */
2093 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2095 ERR("Exhausted number of available FD upon create channel");
2096 goto error_fd_get_stream
;
2099 health_code_update();
2102 * Now get the channel from the consumer. This call wil populate the stream
2103 * list of that channel and set the ust objects.
2105 if (usess
->consumer
->enabled
) {
2106 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2116 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2117 error_fd_get_stream
:
2119 * Initiate a destroy channel on the consumer since we had an error
2120 * handling it on our side. The return value is of no importance since we
2121 * already have a ret value set by the previous error that we need to
2124 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2126 lttng_fd_put(LTTNG_FD_APPS
, 1);
2128 health_code_update();
2134 * Duplicate the ust data object of the ust app stream and save it in the
2135 * buffer registry stream.
2137 * Return 0 on success or else a negative value.
2139 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2140 struct ust_app_stream
*stream
)
2147 /* Reserve the amount of file descriptor we need. */
2148 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2150 ERR("Exhausted number of available FD upon duplicate stream");
2154 /* Duplicate object for stream once the original is in the registry. */
2155 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2156 reg_stream
->obj
.ust
);
2158 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2159 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2160 lttng_fd_put(LTTNG_FD_APPS
, 2);
2163 stream
->handle
= stream
->obj
->handle
;
2170 * Duplicate the ust data object of the ust app. channel and save it in the
2171 * buffer registry channel.
2173 * Return 0 on success or else a negative value.
2175 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2176 struct ust_app_channel
*ua_chan
)
2183 /* Need two fds for the channel. */
2184 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2186 ERR("Exhausted number of available FD upon duplicate channel");
2190 /* Duplicate object for stream once the original is in the registry. */
2191 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2193 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2194 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2197 ua_chan
->handle
= ua_chan
->obj
->handle
;
2202 lttng_fd_put(LTTNG_FD_APPS
, 1);
2208 * For a given channel buffer registry, setup all streams of the given ust
2209 * application channel.
2211 * Return 0 on success or else a negative value.
2213 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2214 struct ust_app_channel
*ua_chan
)
2217 struct ust_app_stream
*stream
, *stmp
;
2222 DBG2("UST app setup buffer registry stream");
2224 /* Send all streams to application. */
2225 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2226 struct buffer_reg_stream
*reg_stream
;
2228 ret
= buffer_reg_stream_create(®_stream
);
2234 * Keep original pointer and nullify it in the stream so the delete
2235 * stream call does not release the object.
2237 reg_stream
->obj
.ust
= stream
->obj
;
2239 buffer_reg_stream_add(reg_stream
, reg_chan
);
2241 /* We don't need the streams anymore. */
2242 cds_list_del(&stream
->list
);
2243 delete_ust_app_stream(-1, stream
);
2251 * Create a buffer registry channel for the given session registry and
2252 * application channel object. If regp pointer is valid, it's set with the
2253 * created object. Important, the created object is NOT added to the session
2254 * registry hash table.
2256 * Return 0 on success else a negative value.
2258 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2259 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2262 struct buffer_reg_channel
*reg_chan
= NULL
;
2267 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2269 /* Create buffer registry channel. */
2270 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2275 reg_chan
->consumer_key
= ua_chan
->key
;
2276 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2278 /* Create and add a channel registry to session. */
2279 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2280 ua_chan
->tracing_channel_id
);
2284 buffer_reg_channel_add(reg_sess
, reg_chan
);
2293 /* Safe because the registry channel object was not added to any HT. */
2294 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2300 * Setup buffer registry channel for the given session registry and application
2301 * channel object. If regp pointer is valid, it's set with the created object.
2303 * Return 0 on success else a negative value.
2305 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2306 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2313 assert(ua_chan
->obj
);
2315 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2317 /* Setup all streams for the registry. */
2318 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2323 reg_chan
->obj
.ust
= ua_chan
->obj
;
2324 ua_chan
->obj
= NULL
;
2329 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2330 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2335 * Send buffer registry channel to the application.
2337 * Return 0 on success else a negative value.
2339 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2340 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2341 struct ust_app_channel
*ua_chan
)
2344 struct buffer_reg_stream
*reg_stream
;
2351 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2353 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2358 /* Send channel to the application. */
2359 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2364 health_code_update();
2366 /* Send all streams to application. */
2367 pthread_mutex_lock(®_chan
->stream_list_lock
);
2368 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2369 struct ust_app_stream stream
;
2371 ret
= duplicate_stream_object(reg_stream
, &stream
);
2373 goto error_stream_unlock
;
2376 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2378 (void) release_ust_app_stream(-1, &stream
);
2379 goto error_stream_unlock
;
2383 * The return value is not important here. This function will output an
2386 (void) release_ust_app_stream(-1, &stream
);
2388 ua_chan
->is_sent
= 1;
2390 error_stream_unlock
:
2391 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2397 * Create and send to the application the created buffers with per UID buffers.
2399 * Return 0 on success else a negative value.
2401 static int create_channel_per_uid(struct ust_app
*app
,
2402 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2403 struct ust_app_channel
*ua_chan
)
2406 struct buffer_reg_uid
*reg_uid
;
2407 struct buffer_reg_channel
*reg_chan
;
2414 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2416 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2418 * The session creation handles the creation of this global registry
2419 * object. If none can be find, there is a code flow problem or a
2424 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2427 /* Create the buffer registry channel object. */
2428 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2435 * Create the buffers on the consumer side. This call populates the
2436 * ust app channel object with all streams and data object.
2438 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2439 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2442 * Let's remove the previously created buffer registry channel so
2443 * it's not visible anymore in the session registry.
2445 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2446 ua_chan
->tracing_channel_id
);
2447 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2448 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2453 * Setup the streams and add it to the session registry.
2455 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2462 /* Send buffers to the application. */
2463 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2473 * Create and send to the application the created buffers with per PID buffers.
2475 * Return 0 on success else a negative value.
2477 static int create_channel_per_pid(struct ust_app
*app
,
2478 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2479 struct ust_app_channel
*ua_chan
)
2482 struct ust_registry_session
*registry
;
2489 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2493 registry
= get_session_registry(ua_sess
);
2496 /* Create and add a new channel registry to session. */
2497 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2502 /* Create and get channel on the consumer side. */
2503 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2504 app
->bits_per_long
, registry
);
2509 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2520 * From an already allocated ust app channel, create the channel buffers if
2521 * need and send it to the application. This MUST be called with a RCU read
2522 * side lock acquired.
2524 * Return 0 on success or else a negative value.
2526 static int do_create_channel(struct ust_app
*app
,
2527 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2528 struct ust_app_channel
*ua_chan
)
2537 /* Handle buffer type before sending the channel to the application. */
2538 switch (usess
->buffer_type
) {
2539 case LTTNG_BUFFER_PER_UID
:
2541 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2547 case LTTNG_BUFFER_PER_PID
:
2549 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2561 /* Initialize ust objd object using the received handle and add it. */
2562 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2563 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2565 /* If channel is not enabled, disable it on the tracer */
2566 if (!ua_chan
->enabled
) {
2567 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2578 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2579 * newly created channel if not NULL.
2581 * Called with UST app session lock and RCU read-side lock held.
2583 * Return 0 on success or else a negative value.
2585 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2586 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2587 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2588 struct ust_app_channel
**ua_chanp
)
2591 struct lttng_ht_iter iter
;
2592 struct lttng_ht_node_str
*ua_chan_node
;
2593 struct ust_app_channel
*ua_chan
;
2595 /* Lookup channel in the ust app session */
2596 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2597 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2598 if (ua_chan_node
!= NULL
) {
2599 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2603 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2604 if (ua_chan
== NULL
) {
2605 /* Only malloc can fail here */
2609 shadow_copy_channel(ua_chan
, uchan
);
2611 /* Set channel type. */
2612 ua_chan
->attr
.type
= type
;
2614 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2619 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2622 /* Only add the channel if successful on the tracer side. */
2623 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2627 *ua_chanp
= ua_chan
;
2630 /* Everything went well. */
2634 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2640 * Create UST app event and create it on the tracer side.
2642 * Called with ust app session mutex held.
2645 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2646 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2647 struct ust_app
*app
)
2650 struct ust_app_event
*ua_event
;
2652 /* Get event node */
2653 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2654 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2655 if (ua_event
!= NULL
) {
2660 /* Does not exist so create one */
2661 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2662 if (ua_event
== NULL
) {
2663 /* Only malloc can failed so something is really wrong */
2667 shadow_copy_event(ua_event
, uevent
);
2669 /* Create it on the tracer side */
2670 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2672 /* Not found previously means that it does not exist on the tracer */
2673 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2677 add_unique_ust_app_event(ua_chan
, ua_event
);
2679 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2686 /* Valid. Calling here is already in a read side lock */
2687 delete_ust_app_event(-1, ua_event
);
2692 * Create UST metadata and open it on the tracer side.
2694 * Called with UST app session lock held and RCU read side lock.
2696 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2697 struct ust_app
*app
, struct consumer_output
*consumer
,
2698 struct ustctl_consumer_channel_attr
*attr
)
2701 struct ust_app_channel
*metadata
;
2702 struct consumer_socket
*socket
;
2703 struct ust_registry_session
*registry
;
2709 registry
= get_session_registry(ua_sess
);
2712 /* Metadata already exists for this registry or it was closed previously */
2713 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2718 /* Allocate UST metadata */
2719 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2721 /* malloc() failed */
2727 /* Set default attributes for metadata. */
2728 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2729 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2730 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2731 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2732 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2733 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2734 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2736 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2737 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2738 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2741 /* Need one fd for the channel. */
2742 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2744 ERR("Exhausted number of available FD upon create metadata");
2748 /* Get the right consumer socket for the application. */
2749 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2752 goto error_consumer
;
2756 * Keep metadata key so we can identify it on the consumer side. Assign it
2757 * to the registry *before* we ask the consumer so we avoid the race of the
2758 * consumer requesting the metadata and the ask_channel call on our side
2759 * did not returned yet.
2761 registry
->metadata_key
= metadata
->key
;
2764 * Ask the metadata channel creation to the consumer. The metadata object
2765 * will be created by the consumer and kept their. However, the stream is
2766 * never added or monitored until we do a first push metadata to the
2769 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2772 /* Nullify the metadata key so we don't try to close it later on. */
2773 registry
->metadata_key
= 0;
2774 goto error_consumer
;
2778 * The setup command will make the metadata stream be sent to the relayd,
2779 * if applicable, and the thread managing the metadatas. This is important
2780 * because after this point, if an error occurs, the only way the stream
2781 * can be deleted is to be monitored in the consumer.
2783 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2785 /* Nullify the metadata key so we don't try to close it later on. */
2786 registry
->metadata_key
= 0;
2787 goto error_consumer
;
2790 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2791 metadata
->key
, app
->pid
);
2794 lttng_fd_put(LTTNG_FD_APPS
, 1);
2795 delete_ust_app_channel(-1, metadata
, app
);
2801 * Return pointer to traceable apps list.
2803 struct lttng_ht
*ust_app_get_ht(void)
2809 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2810 * acquired before calling this function.
2812 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2814 struct ust_app
*app
= NULL
;
2815 struct lttng_ht_node_ulong
*node
;
2816 struct lttng_ht_iter iter
;
2818 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2819 node
= lttng_ht_iter_get_node_ulong(&iter
);
2821 DBG2("UST app no found with pid %d", pid
);
2825 DBG2("Found UST app by pid %d", pid
);
2827 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2834 * Allocate and init an UST app object using the registration information and
2835 * the command socket. This is called when the command socket connects to the
2838 * The object is returned on success or else NULL.
2840 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2842 struct ust_app
*lta
= NULL
;
2847 DBG3("UST app creating application for socket %d", sock
);
2849 if ((msg
->bits_per_long
== 64 &&
2850 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2851 || (msg
->bits_per_long
== 32 &&
2852 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2853 ERR("Registration failed: application \"%s\" (pid: %d) has "
2854 "%d-bit long, but no consumerd for this size is available.\n",
2855 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2859 lta
= zmalloc(sizeof(struct ust_app
));
2865 lta
->ppid
= msg
->ppid
;
2866 lta
->uid
= msg
->uid
;
2867 lta
->gid
= msg
->gid
;
2869 lta
->bits_per_long
= msg
->bits_per_long
;
2870 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2871 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2872 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2873 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2874 lta
->long_alignment
= msg
->long_alignment
;
2875 lta
->byte_order
= msg
->byte_order
;
2877 lta
->v_major
= msg
->major
;
2878 lta
->v_minor
= msg
->minor
;
2879 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2880 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2881 lta
->notify_sock
= -1;
2883 /* Copy name and make sure it's NULL terminated. */
2884 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2885 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2888 * Before this can be called, when receiving the registration information,
2889 * the application compatibility is checked. So, at this point, the
2890 * application can work with this session daemon.
2892 lta
->compatible
= 1;
2894 lta
->pid
= msg
->pid
;
2895 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2897 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2899 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2906 * For a given application object, add it to every hash table.
2908 void ust_app_add(struct ust_app
*app
)
2911 assert(app
->notify_sock
>= 0);
2916 * On a re-registration, we want to kick out the previous registration of
2919 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2922 * The socket _should_ be unique until _we_ call close. So, a add_unique
2923 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2924 * already in the table.
2926 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2928 /* Add application to the notify socket hash table. */
2929 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2930 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2932 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2933 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2934 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2941 * Set the application version into the object.
2943 * Return 0 on success else a negative value either an errno code or a
2944 * LTTng-UST error code.
2946 int ust_app_version(struct ust_app
*app
)
2952 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2954 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2955 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2957 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2965 * Unregister app by removing it from the global traceable app list and freeing
2968 * The socket is already closed at this point so no close to sock.
2970 void ust_app_unregister(int sock
)
2972 struct ust_app
*lta
;
2973 struct lttng_ht_node_ulong
*node
;
2974 struct lttng_ht_iter iter
;
2975 struct ust_app_session
*ua_sess
;
2980 /* Get the node reference for a call_rcu */
2981 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2982 node
= lttng_ht_iter_get_node_ulong(&iter
);
2985 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2986 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2988 /* Remove application from PID hash table */
2989 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2993 * Remove application from notify hash table. The thread handling the
2994 * notify socket could have deleted the node so ignore on error because
2995 * either way it's valid. The close of that socket is handled by the other
2998 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2999 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3002 * Ignore return value since the node might have been removed before by an
3003 * add replace during app registration because the PID can be reassigned by
3006 iter
.iter
.node
= <a
->pid_n
.node
;
3007 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3009 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3013 /* Remove sessions so they are not visible during deletion.*/
3014 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3016 struct ust_registry_session
*registry
;
3018 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3020 /* The session was already removed so scheduled for teardown. */
3025 * Add session to list for teardown. This is safe since at this point we
3026 * are the only one using this list.
3028 pthread_mutex_lock(&ua_sess
->lock
);
3031 * Normally, this is done in the delete session process which is
3032 * executed in the call rcu below. However, upon registration we can't
3033 * afford to wait for the grace period before pushing data or else the
3034 * data pending feature can race between the unregistration and stop
3035 * command where the data pending command is sent *before* the grace
3038 * The close metadata below nullifies the metadata pointer in the
3039 * session so the delete session will NOT push/close a second time.
3041 registry
= get_session_registry(ua_sess
);
3042 if (registry
&& !registry
->metadata_closed
) {
3043 /* Push metadata for application before freeing the application. */
3044 (void) push_metadata(registry
, ua_sess
->consumer
);
3047 * Don't ask to close metadata for global per UID buffers. Close
3048 * metadata only on destroy trace session in this case. Also, the
3049 * previous push metadata could have flag the metadata registry to
3050 * close so don't send a close command if closed.
3052 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3053 !registry
->metadata_closed
) {
3054 /* And ask to close it for this session registry. */
3055 (void) close_metadata(registry
, ua_sess
->consumer
);
3059 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3060 pthread_mutex_unlock(&ua_sess
->lock
);
3064 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3071 * Return traceable_app_count
3073 unsigned long ust_app_list_count(void)
3075 unsigned long count
;
3078 count
= lttng_ht_get_count(ust_app_ht
);
3085 * Fill events array with all events name of all registered apps.
3087 int ust_app_list_events(struct lttng_event
**events
)
3090 size_t nbmem
, count
= 0;
3091 struct lttng_ht_iter iter
;
3092 struct ust_app
*app
;
3093 struct lttng_event
*tmp_event
;
3095 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3096 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3097 if (tmp_event
== NULL
) {
3098 PERROR("zmalloc ust app events");
3105 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3106 struct lttng_ust_tracepoint_iter uiter
;
3108 health_code_update();
3110 if (!app
->compatible
) {
3112 * TODO: In time, we should notice the caller of this error by
3113 * telling him that this is a version error.
3117 handle
= ustctl_tracepoint_list(app
->sock
);
3119 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3120 ERR("UST app list events getting handle failed for app pid %d",
3126 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3127 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3128 /* Handle ustctl error. */
3131 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3132 ERR("UST app tp list get failed for app %d with ret %d",
3135 DBG3("UST app tp list get failed. Application is dead");
3137 * This is normal behavior, an application can die during the
3138 * creation process. Don't report an error so the execution can
3139 * continue normally. Continue normal execution.
3146 health_code_update();
3147 if (count
>= nbmem
) {
3148 /* In case the realloc fails, we free the memory */
3151 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3154 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3156 PERROR("realloc ust app events");
3163 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3164 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3165 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3166 tmp_event
[count
].pid
= app
->pid
;
3167 tmp_event
[count
].enabled
= -1;
3173 *events
= tmp_event
;
3175 DBG2("UST app list events done (%zu events)", count
);
3180 health_code_update();
3185 * Fill events array with all events name of all registered apps.
3187 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3190 size_t nbmem
, count
= 0;
3191 struct lttng_ht_iter iter
;
3192 struct ust_app
*app
;
3193 struct lttng_event_field
*tmp_event
;
3195 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3196 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3197 if (tmp_event
== NULL
) {
3198 PERROR("zmalloc ust app event fields");
3205 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3206 struct lttng_ust_field_iter uiter
;
3208 health_code_update();
3210 if (!app
->compatible
) {
3212 * TODO: In time, we should notice the caller of this error by
3213 * telling him that this is a version error.
3217 handle
= ustctl_tracepoint_field_list(app
->sock
);
3219 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3220 ERR("UST app list field getting handle failed for app pid %d",
3226 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3227 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3228 /* Handle ustctl error. */
3231 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3232 ERR("UST app tp list field failed for app %d with ret %d",
3235 DBG3("UST app tp list field failed. Application is dead");
3237 * This is normal behavior, an application can die during the
3238 * creation process. Don't report an error so the execution can
3239 * continue normally.
3246 health_code_update();
3247 if (count
>= nbmem
) {
3248 /* In case the realloc fails, we free the memory */
3251 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3254 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3256 PERROR("realloc ust app event fields");
3264 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3265 /* Mapping between these enums matches 1 to 1. */
3266 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3267 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3269 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3270 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3271 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3272 tmp_event
[count
].event
.pid
= app
->pid
;
3273 tmp_event
[count
].event
.enabled
= -1;
3279 *fields
= tmp_event
;
3281 DBG2("UST app list event fields done (%zu events)", count
);
3286 health_code_update();
3291 * Free and clean all traceable apps of the global list.
3293 * Should _NOT_ be called with RCU read-side lock held.
3295 void ust_app_clean_list(void)
3298 struct ust_app
*app
;
3299 struct lttng_ht_iter iter
;
3301 DBG2("UST app cleaning registered apps hash table");
3305 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3306 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3308 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3311 /* Cleanup socket hash table */
3312 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3314 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3318 /* Cleanup notify socket hash table */
3319 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3320 notify_sock_n
.node
) {
3321 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3326 /* Destroy is done only when the ht is empty */
3327 ht_cleanup_push(ust_app_ht
);
3328 ht_cleanup_push(ust_app_ht_by_sock
);
3329 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3333 * Init UST app hash table.
3335 void ust_app_ht_alloc(void)
3337 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3338 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3339 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3343 * For a specific UST session, disable the channel for all registered apps.
3345 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3346 struct ltt_ust_channel
*uchan
)
3349 struct lttng_ht_iter iter
;
3350 struct lttng_ht_node_str
*ua_chan_node
;
3351 struct ust_app
*app
;
3352 struct ust_app_session
*ua_sess
;
3353 struct ust_app_channel
*ua_chan
;
3355 if (usess
== NULL
|| uchan
== NULL
) {
3356 ERR("Disabling UST global channel with NULL values");
3361 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3362 uchan
->name
, usess
->id
);
3366 /* For every registered applications */
3367 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3368 struct lttng_ht_iter uiter
;
3369 if (!app
->compatible
) {
3371 * TODO: In time, we should notice the caller of this error by
3372 * telling him that this is a version error.
3376 ua_sess
= lookup_session_by_app(usess
, app
);
3377 if (ua_sess
== NULL
) {
3382 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3383 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3384 /* If the session if found for the app, the channel must be there */
3385 assert(ua_chan_node
);
3387 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3388 /* The channel must not be already disabled */
3389 assert(ua_chan
->enabled
== 1);
3391 /* Disable channel onto application */
3392 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3394 /* XXX: We might want to report this error at some point... */
3406 * For a specific UST session, enable the channel for all registered apps.
3408 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3409 struct ltt_ust_channel
*uchan
)
3412 struct lttng_ht_iter iter
;
3413 struct ust_app
*app
;
3414 struct ust_app_session
*ua_sess
;
3416 if (usess
== NULL
|| uchan
== NULL
) {
3417 ERR("Adding UST global channel to NULL values");
3422 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3423 uchan
->name
, usess
->id
);
3427 /* For every registered applications */
3428 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3429 if (!app
->compatible
) {
3431 * TODO: In time, we should notice the caller of this error by
3432 * telling him that this is a version error.
3436 ua_sess
= lookup_session_by_app(usess
, app
);
3437 if (ua_sess
== NULL
) {
3441 /* Enable channel onto application */
3442 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3444 /* XXX: We might want to report this error at some point... */
3456 * Disable an event in a channel and for a specific session.
3458 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3459 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3462 struct lttng_ht_iter iter
, uiter
;
3463 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3464 struct ust_app
*app
;
3465 struct ust_app_session
*ua_sess
;
3466 struct ust_app_channel
*ua_chan
;
3467 struct ust_app_event
*ua_event
;
3469 DBG("UST app disabling event %s for all apps in channel "
3470 "%s for session id %" PRIu64
,
3471 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3475 /* For all registered applications */
3476 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3477 if (!app
->compatible
) {
3479 * TODO: In time, we should notice the caller of this error by
3480 * telling him that this is a version error.
3484 ua_sess
= lookup_session_by_app(usess
, app
);
3485 if (ua_sess
== NULL
) {
3490 /* Lookup channel in the ust app session */
3491 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3492 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3493 if (ua_chan_node
== NULL
) {
3494 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3495 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3498 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3500 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3501 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3502 if (ua_event_node
== NULL
) {
3503 DBG2("Event %s not found in channel %s for app pid %d."
3504 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3507 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3509 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3511 /* XXX: Report error someday... */
3522 * For a specific UST session and UST channel, the event for all
3525 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3526 struct ltt_ust_channel
*uchan
)
3529 struct lttng_ht_iter iter
, uiter
;
3530 struct lttng_ht_node_str
*ua_chan_node
;
3531 struct ust_app
*app
;
3532 struct ust_app_session
*ua_sess
;
3533 struct ust_app_channel
*ua_chan
;
3534 struct ust_app_event
*ua_event
;
3536 DBG("UST app disabling all event for all apps in channel "
3537 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3541 /* For all registered applications */
3542 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3543 if (!app
->compatible
) {
3545 * TODO: In time, we should notice the caller of this error by
3546 * telling him that this is a version error.
3550 ua_sess
= lookup_session_by_app(usess
, app
);
3552 /* The application has problem or is probably dead. */
3556 /* Lookup channel in the ust app session */
3557 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3558 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3559 /* If the channel is not found, there is a code flow error */
3560 assert(ua_chan_node
);
3562 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3564 /* Disable each events of channel */
3565 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3567 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3569 /* XXX: Report error someday... */
3581 * For a specific UST session, create the channel for all registered apps.
3583 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3584 struct ltt_ust_channel
*uchan
)
3586 int ret
= 0, created
;
3587 struct lttng_ht_iter iter
;
3588 struct ust_app
*app
;
3589 struct ust_app_session
*ua_sess
= NULL
;
3591 /* Very wrong code flow */
3595 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3596 uchan
->name
, usess
->id
);
3600 /* For every registered applications */
3601 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3602 if (!app
->compatible
) {
3604 * TODO: In time, we should notice the caller of this error by
3605 * telling him that this is a version error.
3610 * Create session on the tracer side and add it to app session HT. Note
3611 * that if session exist, it will simply return a pointer to the ust
3614 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3619 * The application's socket is not valid. Either a bad socket
3620 * or a timeout on it. We can't inform the caller that for a
3621 * specific app, the session failed so lets continue here.
3626 goto error_rcu_unlock
;
3631 pthread_mutex_lock(&ua_sess
->lock
);
3632 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3633 sizeof(uchan
->name
))) {
3634 struct ustctl_consumer_channel_attr attr
;
3635 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3636 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3639 /* Create channel onto application. We don't need the chan ref. */
3640 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3641 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3643 pthread_mutex_unlock(&ua_sess
->lock
);
3645 if (ret
== -ENOMEM
) {
3646 /* No more memory is a fatal error. Stop right now. */
3647 goto error_rcu_unlock
;
3649 /* Cleanup the created session if it's the case. */
3651 destroy_app_session(app
, ua_sess
);
3662 * Enable event for a specific session and channel on the tracer.
3664 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3665 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3668 struct lttng_ht_iter iter
, uiter
;
3669 struct lttng_ht_node_str
*ua_chan_node
;
3670 struct ust_app
*app
;
3671 struct ust_app_session
*ua_sess
;
3672 struct ust_app_channel
*ua_chan
;
3673 struct ust_app_event
*ua_event
;
3675 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3676 uevent
->attr
.name
, usess
->id
);
3679 * NOTE: At this point, this function is called only if the session and
3680 * channel passed are already created for all apps. and enabled on the
3686 /* For all registered applications */
3687 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3688 if (!app
->compatible
) {
3690 * TODO: In time, we should notice the caller of this error by
3691 * telling him that this is a version error.
3695 ua_sess
= lookup_session_by_app(usess
, app
);
3697 /* The application has problem or is probably dead. */
3701 pthread_mutex_lock(&ua_sess
->lock
);
3703 /* Lookup channel in the ust app session */
3704 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3705 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3706 /* If the channel is not found, there is a code flow error */
3707 assert(ua_chan_node
);
3709 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3711 /* Get event node */
3712 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3713 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3714 if (ua_event
== NULL
) {
3715 DBG3("UST app enable event %s not found for app PID %d."
3716 "Skipping app", uevent
->attr
.name
, app
->pid
);
3720 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3722 pthread_mutex_unlock(&ua_sess
->lock
);
3726 pthread_mutex_unlock(&ua_sess
->lock
);
3735 * For a specific existing UST session and UST channel, creates the event for
3736 * all registered apps.
3738 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3739 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3742 struct lttng_ht_iter iter
, uiter
;
3743 struct lttng_ht_node_str
*ua_chan_node
;
3744 struct ust_app
*app
;
3745 struct ust_app_session
*ua_sess
;
3746 struct ust_app_channel
*ua_chan
;
3748 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3749 uevent
->attr
.name
, usess
->id
);
3753 /* For all registered applications */
3754 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3755 if (!app
->compatible
) {
3757 * TODO: In time, we should notice the caller of this error by
3758 * telling him that this is a version error.
3762 ua_sess
= lookup_session_by_app(usess
, app
);
3764 /* The application has problem or is probably dead. */
3768 pthread_mutex_lock(&ua_sess
->lock
);
3769 /* Lookup channel in the ust app session */
3770 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3771 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3772 /* If the channel is not found, there is a code flow error */
3773 assert(ua_chan_node
);
3775 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3777 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3778 pthread_mutex_unlock(&ua_sess
->lock
);
3780 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3781 /* Possible value at this point: -ENOMEM. If so, we stop! */
3784 DBG2("UST app event %s already exist on app PID %d",
3785 uevent
->attr
.name
, app
->pid
);
3796 * Start tracing for a specific UST session and app.
3799 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3802 struct ust_app_session
*ua_sess
;
3804 DBG("Starting tracing for ust app pid %d", app
->pid
);
3808 if (!app
->compatible
) {
3812 ua_sess
= lookup_session_by_app(usess
, app
);
3813 if (ua_sess
== NULL
) {
3814 /* The session is in teardown process. Ignore and continue. */
3818 pthread_mutex_lock(&ua_sess
->lock
);
3820 /* Upon restart, we skip the setup, already done */
3821 if (ua_sess
->started
) {
3825 /* Create directories if consumer is LOCAL and has a path defined. */
3826 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3827 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3828 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3829 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3831 if (ret
!= -EEXIST
) {
3832 ERR("Trace directory creation error");
3839 * Create the metadata for the application. This returns gracefully if a
3840 * metadata was already set for the session.
3842 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3847 health_code_update();
3850 /* This start the UST tracing */
3851 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3853 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3854 ERR("Error starting tracing for app pid: %d (ret: %d)",
3857 DBG("UST app start session failed. Application is dead.");
3859 * This is normal behavior, an application can die during the
3860 * creation process. Don't report an error so the execution can
3861 * continue normally.
3863 pthread_mutex_unlock(&ua_sess
->lock
);
3869 /* Indicate that the session has been started once */
3870 ua_sess
->started
= 1;
3872 pthread_mutex_unlock(&ua_sess
->lock
);
3874 health_code_update();
3876 /* Quiescent wait after starting trace */
3877 ret
= ustctl_wait_quiescent(app
->sock
);
3878 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3879 ERR("UST app wait quiescent failed for app pid %d ret %d",
3885 health_code_update();
3889 pthread_mutex_unlock(&ua_sess
->lock
);
3891 health_code_update();
3896 * Stop tracing for a specific UST session and app.
3899 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3902 struct ust_app_session
*ua_sess
;
3903 struct ust_registry_session
*registry
;
3905 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3909 if (!app
->compatible
) {
3910 goto end_no_session
;
3913 ua_sess
= lookup_session_by_app(usess
, app
);
3914 if (ua_sess
== NULL
) {
3915 goto end_no_session
;
3918 pthread_mutex_lock(&ua_sess
->lock
);
3921 * If started = 0, it means that stop trace has been called for a session
3922 * that was never started. It's possible since we can have a fail start
3923 * from either the application manager thread or the command thread. Simply
3924 * indicate that this is a stop error.
3926 if (!ua_sess
->started
) {
3927 goto error_rcu_unlock
;
3930 health_code_update();
3932 /* This inhibits UST tracing */
3933 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3935 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3936 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3939 DBG("UST app stop session failed. Application is dead.");
3941 * This is normal behavior, an application can die during the
3942 * creation process. Don't report an error so the execution can
3943 * continue normally.
3947 goto error_rcu_unlock
;
3950 health_code_update();
3952 /* Quiescent wait after stopping trace */
3953 ret
= ustctl_wait_quiescent(app
->sock
);
3954 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3955 ERR("UST app wait quiescent failed for app pid %d ret %d",
3959 health_code_update();
3961 registry
= get_session_registry(ua_sess
);
3964 if (!registry
->metadata_closed
) {
3965 /* Push metadata for application before freeing the application. */
3966 (void) push_metadata(registry
, ua_sess
->consumer
);
3970 pthread_mutex_unlock(&ua_sess
->lock
);
3973 health_code_update();
3977 pthread_mutex_unlock(&ua_sess
->lock
);
3979 health_code_update();
3984 * Flush buffers for a specific UST session and app.
3987 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3990 struct lttng_ht_iter iter
;
3991 struct ust_app_session
*ua_sess
;
3992 struct ust_app_channel
*ua_chan
;
3994 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3998 if (!app
->compatible
) {
3999 goto end_no_session
;
4002 ua_sess
= lookup_session_by_app(usess
, app
);
4003 if (ua_sess
== NULL
) {
4004 goto end_no_session
;
4007 pthread_mutex_lock(&ua_sess
->lock
);
4009 health_code_update();
4011 /* Flushing buffers */
4012 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4014 health_code_update();
4015 assert(ua_chan
->is_sent
);
4016 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
4018 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4019 ERR("UST app PID %d channel %s flush failed with ret %d",
4020 app
->pid
, ua_chan
->name
, ret
);
4022 DBG3("UST app failed to flush %s. Application is dead.",
4025 * This is normal behavior, an application can die during the
4026 * creation process. Don't report an error so the execution can
4027 * continue normally.
4030 /* Continuing flushing all buffers */
4035 health_code_update();
4037 pthread_mutex_unlock(&ua_sess
->lock
);
4040 health_code_update();
4045 * Destroy a specific UST session in apps.
4047 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4050 struct ust_app_session
*ua_sess
;
4051 struct lttng_ht_iter iter
;
4052 struct lttng_ht_node_u64
*node
;
4054 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4058 if (!app
->compatible
) {
4062 __lookup_session_by_app(usess
, app
, &iter
);
4063 node
= lttng_ht_iter_get_node_u64(&iter
);
4065 /* Session is being or is deleted. */
4068 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4070 health_code_update();
4071 destroy_app_session(app
, ua_sess
);
4073 health_code_update();
4075 /* Quiescent wait after stopping trace */
4076 ret
= ustctl_wait_quiescent(app
->sock
);
4077 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4078 ERR("UST app wait quiescent failed for app pid %d ret %d",
4083 health_code_update();
4088 * Start tracing for the UST session.
4090 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4093 struct lttng_ht_iter iter
;
4094 struct ust_app
*app
;
4096 DBG("Starting all UST traces");
4100 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4101 ret
= ust_app_start_trace(usess
, app
);
4103 /* Continue to next apps even on error */
4114 * Start tracing for the UST session.
4116 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4119 struct lttng_ht_iter iter
;
4120 struct ust_app
*app
;
4122 DBG("Stopping all UST traces");
4126 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4127 ret
= ust_app_stop_trace(usess
, app
);
4129 /* Continue to next apps even on error */
4134 /* Flush buffers and push metadata (for UID buffers). */
4135 switch (usess
->buffer_type
) {
4136 case LTTNG_BUFFER_PER_UID
:
4138 struct buffer_reg_uid
*reg
;
4140 /* Flush all per UID buffers associated to that session. */
4141 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4142 struct ust_registry_session
*ust_session_reg
;
4143 struct buffer_reg_channel
*reg_chan
;
4144 struct consumer_socket
*socket
;
4146 /* Get consumer socket to use to push the metadata.*/
4147 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4150 /* Ignore request if no consumer is found for the session. */
4154 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4155 reg_chan
, node
.node
) {
4157 * The following call will print error values so the return
4158 * code is of little importance because whatever happens, we
4159 * have to try them all.
4161 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4164 ust_session_reg
= reg
->registry
->reg
.ust
;
4165 if (!ust_session_reg
->metadata_closed
) {
4166 /* Push metadata. */
4167 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4173 case LTTNG_BUFFER_PER_PID
:
4174 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4175 ret
= ust_app_flush_trace(usess
, app
);
4177 /* Continue to next apps even on error */
4193 * Destroy app UST session.
4195 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4198 struct lttng_ht_iter iter
;
4199 struct ust_app
*app
;
4201 DBG("Destroy all UST traces");
4205 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4206 ret
= destroy_trace(usess
, app
);
4208 /* Continue to next apps even on error */
4219 * Add channels/events from UST global domain to registered apps at sock.
4221 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4224 struct lttng_ht_iter iter
, uiter
;
4225 struct ust_app
*app
;
4226 struct ust_app_session
*ua_sess
= NULL
;
4227 struct ust_app_channel
*ua_chan
;
4228 struct ust_app_event
*ua_event
;
4229 struct ust_app_ctx
*ua_ctx
;
4234 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4239 app
= ust_app_find_by_sock(sock
);
4242 * Application can be unregistered before so this is possible hence
4243 * simply stopping the update.
4245 DBG3("UST app update failed to find app sock %d", sock
);
4249 if (!app
->compatible
) {
4253 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4255 /* Tracer is probably gone or ENOMEM. */
4260 pthread_mutex_lock(&ua_sess
->lock
);
4263 * We can iterate safely here over all UST app session since the create ust
4264 * app session above made a shadow copy of the UST global domain from the
4267 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4270 * For a metadata channel, handle it differently.
4272 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4273 sizeof(ua_chan
->name
))) {
4274 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4279 /* Remove it from the hash table and continue!. */
4280 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4282 delete_ust_app_channel(-1, ua_chan
, app
);
4285 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4288 * Stop everything. On error, the application failed, no more
4289 * file descriptor are available or ENOMEM so stopping here is
4290 * the only thing we can do for now.
4297 * Add context using the list so they are enabled in the same order the
4300 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4301 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4308 /* For each events */
4309 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4311 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4318 pthread_mutex_unlock(&ua_sess
->lock
);
4320 if (usess
->start_trace
) {
4321 ret
= ust_app_start_trace(usess
, app
);
4326 DBG2("UST trace started for app pid %d", app
->pid
);
4329 /* Everything went well at this point. */
4334 pthread_mutex_unlock(&ua_sess
->lock
);
4337 destroy_app_session(app
, ua_sess
);
4344 * Add context to a specific channel for global UST domain.
4346 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4347 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4350 struct lttng_ht_node_str
*ua_chan_node
;
4351 struct lttng_ht_iter iter
, uiter
;
4352 struct ust_app_channel
*ua_chan
= NULL
;
4353 struct ust_app_session
*ua_sess
;
4354 struct ust_app
*app
;
4358 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4359 if (!app
->compatible
) {
4361 * TODO: In time, we should notice the caller of this error by
4362 * telling him that this is a version error.
4366 ua_sess
= lookup_session_by_app(usess
, app
);
4367 if (ua_sess
== NULL
) {
4371 pthread_mutex_lock(&ua_sess
->lock
);
4372 /* Lookup channel in the ust app session */
4373 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4374 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4375 if (ua_chan_node
== NULL
) {
4378 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4380 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4385 pthread_mutex_unlock(&ua_sess
->lock
);
4393 * Enable event for a channel from a UST session for a specific PID.
4395 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4396 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4399 struct lttng_ht_iter iter
;
4400 struct lttng_ht_node_str
*ua_chan_node
;
4401 struct ust_app
*app
;
4402 struct ust_app_session
*ua_sess
;
4403 struct ust_app_channel
*ua_chan
;
4404 struct ust_app_event
*ua_event
;
4406 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4410 app
= ust_app_find_by_pid(pid
);
4412 ERR("UST app enable event per PID %d not found", pid
);
4417 if (!app
->compatible
) {
4422 ua_sess
= lookup_session_by_app(usess
, app
);
4424 /* The application has problem or is probably dead. */
4429 pthread_mutex_lock(&ua_sess
->lock
);
4430 /* Lookup channel in the ust app session */
4431 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4432 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4433 /* If the channel is not found, there is a code flow error */
4434 assert(ua_chan_node
);
4436 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4438 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4439 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4440 if (ua_event
== NULL
) {
4441 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4446 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4453 pthread_mutex_unlock(&ua_sess
->lock
);
4460 * Disable event for a channel from a UST session for a specific PID.
4462 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4463 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4466 struct lttng_ht_iter iter
;
4467 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4468 struct ust_app
*app
;
4469 struct ust_app_session
*ua_sess
;
4470 struct ust_app_channel
*ua_chan
;
4471 struct ust_app_event
*ua_event
;
4473 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4477 app
= ust_app_find_by_pid(pid
);
4479 ERR("UST app disable event per PID %d not found", pid
);
4484 if (!app
->compatible
) {
4489 ua_sess
= lookup_session_by_app(usess
, app
);
4491 /* The application has problem or is probably dead. */
4495 /* Lookup channel in the ust app session */
4496 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4497 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4498 if (ua_chan_node
== NULL
) {
4499 /* Channel does not exist, skip disabling */
4502 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4504 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4505 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4506 if (ua_event_node
== NULL
) {
4507 /* Event does not exist, skip disabling */
4510 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4512 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4523 * Calibrate registered applications.
4525 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4528 struct lttng_ht_iter iter
;
4529 struct ust_app
*app
;
4533 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4534 if (!app
->compatible
) {
4536 * TODO: In time, we should notice the caller of this error by
4537 * telling him that this is a version error.
4542 health_code_update();
4544 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4548 /* Means that it's not implemented on the tracer side. */
4552 DBG2("Calibrate app PID %d returned with error %d",
4559 DBG("UST app global domain calibration finished");
4563 health_code_update();
4569 * Receive registration and populate the given msg structure.
4571 * On success return 0 else a negative value returned by the ustctl call.
4573 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4576 uint32_t pid
, ppid
, uid
, gid
;
4580 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4581 &pid
, &ppid
, &uid
, &gid
,
4582 &msg
->bits_per_long
,
4583 &msg
->uint8_t_alignment
,
4584 &msg
->uint16_t_alignment
,
4585 &msg
->uint32_t_alignment
,
4586 &msg
->uint64_t_alignment
,
4587 &msg
->long_alignment
,
4594 case LTTNG_UST_ERR_EXITING
:
4595 DBG3("UST app recv reg message failed. Application died");
4597 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4598 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4599 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4600 LTTNG_UST_ABI_MINOR_VERSION
);
4603 ERR("UST app recv reg message failed with ret %d", ret
);
4608 msg
->pid
= (pid_t
) pid
;
4609 msg
->ppid
= (pid_t
) ppid
;
4610 msg
->uid
= (uid_t
) uid
;
4611 msg
->gid
= (gid_t
) gid
;
4618 * Return a ust app channel object using the application object and the channel
4619 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4620 * lock MUST be acquired before calling this function.
4622 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4625 struct lttng_ht_node_ulong
*node
;
4626 struct lttng_ht_iter iter
;
4627 struct ust_app_channel
*ua_chan
= NULL
;
4631 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4632 node
= lttng_ht_iter_get_node_ulong(&iter
);
4634 DBG2("UST app channel find by objd %d not found", objd
);
4638 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4645 * Reply to a register channel notification from an application on the notify
4646 * socket. The channel metadata is also created.
4648 * The session UST registry lock is acquired in this function.
4650 * On success 0 is returned else a negative value.
4652 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4653 size_t nr_fields
, struct ustctl_field
*fields
)
4655 int ret
, ret_code
= 0;
4656 uint32_t chan_id
, reg_count
;
4657 uint64_t chan_reg_key
;
4658 enum ustctl_channel_header type
;
4659 struct ust_app
*app
;
4660 struct ust_app_channel
*ua_chan
;
4661 struct ust_app_session
*ua_sess
;
4662 struct ust_registry_session
*registry
;
4663 struct ust_registry_channel
*chan_reg
;
4667 /* Lookup application. If not found, there is a code flow error. */
4668 app
= find_app_by_notify_sock(sock
);
4670 DBG("Application socket %d is being teardown. Abort event notify",
4674 goto error_rcu_unlock
;
4677 /* Lookup channel by UST object descriptor. */
4678 ua_chan
= find_channel_by_objd(app
, cobjd
);
4680 DBG("Application channel is being teardown. Abort event notify");
4683 goto error_rcu_unlock
;
4686 assert(ua_chan
->session
);
4687 ua_sess
= ua_chan
->session
;
4689 /* Get right session registry depending on the session buffer type. */
4690 registry
= get_session_registry(ua_sess
);
4693 /* Depending on the buffer type, a different channel key is used. */
4694 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4695 chan_reg_key
= ua_chan
->tracing_channel_id
;
4697 chan_reg_key
= ua_chan
->key
;
4700 pthread_mutex_lock(®istry
->lock
);
4702 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4705 if (!chan_reg
->register_done
) {
4706 reg_count
= ust_registry_get_event_count(chan_reg
);
4707 if (reg_count
< 31) {
4708 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4710 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4713 chan_reg
->nr_ctx_fields
= nr_fields
;
4714 chan_reg
->ctx_fields
= fields
;
4715 chan_reg
->header_type
= type
;
4717 /* Get current already assigned values. */
4718 type
= chan_reg
->header_type
;
4720 /* Set to NULL so the error path does not do a double free. */
4723 /* Channel id is set during the object creation. */
4724 chan_id
= chan_reg
->chan_id
;
4726 /* Append to metadata */
4727 if (!chan_reg
->metadata_dumped
) {
4728 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4730 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4736 DBG3("UST app replying to register channel key %" PRIu64
4737 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4740 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4742 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4743 ERR("UST app reply channel failed with ret %d", ret
);
4745 DBG3("UST app reply channel failed. Application died");
4750 /* This channel registry registration is completed. */
4751 chan_reg
->register_done
= 1;
4754 pthread_mutex_unlock(®istry
->lock
);
4764 * Add event to the UST channel registry. When the event is added to the
4765 * registry, the metadata is also created. Once done, this replies to the
4766 * application with the appropriate error code.
4768 * The session UST registry lock is acquired in the function.
4770 * On success 0 is returned else a negative value.
4772 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4773 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4774 char *model_emf_uri
)
4777 uint32_t event_id
= 0;
4778 uint64_t chan_reg_key
;
4779 struct ust_app
*app
;
4780 struct ust_app_channel
*ua_chan
;
4781 struct ust_app_session
*ua_sess
;
4782 struct ust_registry_session
*registry
;
4786 /* Lookup application. If not found, there is a code flow error. */
4787 app
= find_app_by_notify_sock(sock
);
4789 DBG("Application socket %d is being teardown. Abort event notify",
4794 free(model_emf_uri
);
4795 goto error_rcu_unlock
;
4798 /* Lookup channel by UST object descriptor. */
4799 ua_chan
= find_channel_by_objd(app
, cobjd
);
4801 DBG("Application channel is being teardown. Abort event notify");
4805 free(model_emf_uri
);
4806 goto error_rcu_unlock
;
4809 assert(ua_chan
->session
);
4810 ua_sess
= ua_chan
->session
;
4812 registry
= get_session_registry(ua_sess
);
4815 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4816 chan_reg_key
= ua_chan
->tracing_channel_id
;
4818 chan_reg_key
= ua_chan
->key
;
4821 pthread_mutex_lock(®istry
->lock
);
4824 * From this point on, this call acquires the ownership of the sig, fields
4825 * and model_emf_uri meaning any free are done inside it if needed. These
4826 * three variables MUST NOT be read/write after this.
4828 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4829 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4830 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4834 * The return value is returned to ustctl so in case of an error, the
4835 * application can be notified. In case of an error, it's important not to
4836 * return a negative error or else the application will get closed.
4838 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4840 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4841 ERR("UST app reply event failed with ret %d", ret
);
4843 DBG3("UST app reply event failed. Application died");
4846 * No need to wipe the create event since the application socket will
4847 * get close on error hence cleaning up everything by itself.
4852 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4856 pthread_mutex_unlock(®istry
->lock
);
4863 * Handle application notification through the given notify socket.
4865 * Return 0 on success or else a negative value.
4867 int ust_app_recv_notify(int sock
)
4870 enum ustctl_notify_cmd cmd
;
4872 DBG3("UST app receiving notify from sock %d", sock
);
4874 ret
= ustctl_recv_notify(sock
, &cmd
);
4876 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4877 ERR("UST app recv notify failed with ret %d", ret
);
4879 DBG3("UST app recv notify failed. Application died");
4885 case USTCTL_NOTIFY_CMD_EVENT
:
4887 int sobjd
, cobjd
, loglevel
;
4888 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4890 struct ustctl_field
*fields
;
4892 DBG2("UST app ustctl register event received");
4894 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4895 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4897 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4898 ERR("UST app recv event failed with ret %d", ret
);
4900 DBG3("UST app recv event failed. Application died");
4906 * Add event to the UST registry coming from the notify socket. This
4907 * call will free if needed the sig, fields and model_emf_uri. This
4908 * code path loses the ownsership of these variables and transfer them
4909 * to the this function.
4911 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4912 fields
, loglevel
, model_emf_uri
);
4919 case USTCTL_NOTIFY_CMD_CHANNEL
:
4923 struct ustctl_field
*fields
;
4925 DBG2("UST app ustctl register channel received");
4927 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4930 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4931 ERR("UST app recv channel failed with ret %d", ret
);
4933 DBG3("UST app recv channel failed. Application died");
4939 * The fields ownership are transfered to this function call meaning
4940 * that if needed it will be freed. After this, it's invalid to access
4941 * fields or clean it up.
4943 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4952 /* Should NEVER happen. */
4961 * Once the notify socket hangs up, this is called. First, it tries to find the
4962 * corresponding application. On failure, the call_rcu to close the socket is
4963 * executed. If an application is found, it tries to delete it from the notify
4964 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4966 * Note that an object needs to be allocated here so on ENOMEM failure, the
4967 * call RCU is not done but the rest of the cleanup is.
4969 void ust_app_notify_sock_unregister(int sock
)
4972 struct lttng_ht_iter iter
;
4973 struct ust_app
*app
;
4974 struct ust_app_notify_sock_obj
*obj
;
4980 obj
= zmalloc(sizeof(*obj
));
4983 * An ENOMEM is kind of uncool. If this strikes we continue the
4984 * procedure but the call_rcu will not be called. In this case, we
4985 * accept the fd leak rather than possibly creating an unsynchronized
4986 * state between threads.
4988 * TODO: The notify object should be created once the notify socket is
4989 * registered and stored independantely from the ust app object. The
4990 * tricky part is to synchronize the teardown of the application and
4991 * this notify object. Let's keep that in mind so we can avoid this
4992 * kind of shenanigans with ENOMEM in the teardown path.
4999 DBG("UST app notify socket unregister %d", sock
);
5002 * Lookup application by notify socket. If this fails, this means that the
5003 * hash table delete has already been done by the application
5004 * unregistration process so we can safely close the notify socket in a
5007 app
= find_app_by_notify_sock(sock
);
5012 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5015 * Whatever happens here either we fail or succeed, in both cases we have
5016 * to close the socket after a grace period to continue to the call RCU
5017 * here. If the deletion is successful, the application is not visible
5018 * anymore by other threads and is it fails it means that it was already
5019 * deleted from the hash table so either way we just have to close the
5022 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5028 * Close socket after a grace period to avoid for the socket to be reused
5029 * before the application object is freed creating potential race between
5030 * threads trying to add unique in the global hash table.
5033 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5038 * Destroy a ust app data structure and free its memory.
5040 void ust_app_destroy(struct ust_app
*app
)
5046 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5050 * Take a snapshot for a given UST session. The snapshot is sent to the given
5053 * Return 0 on success or else a negative value.
5055 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5056 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
5059 struct lttng_ht_iter iter
;
5060 struct ust_app
*app
;
5061 char pathname
[PATH_MAX
];
5062 uint64_t max_stream_size
= 0;
5070 * Compute the maximum size of a single stream if a max size is asked by
5073 if (output
->max_size
> 0 && nb_streams
> 0) {
5074 max_stream_size
= output
->max_size
/ nb_streams
;
5077 switch (usess
->buffer_type
) {
5078 case LTTNG_BUFFER_PER_UID
:
5080 struct buffer_reg_uid
*reg
;
5082 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5083 struct buffer_reg_channel
*reg_chan
;
5084 struct consumer_socket
*socket
;
5086 /* Get consumer socket to use to push the metadata.*/
5087 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5094 memset(pathname
, 0, sizeof(pathname
));
5095 ret
= snprintf(pathname
, sizeof(pathname
),
5096 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5097 reg
->uid
, reg
->bits_per_long
);
5099 PERROR("snprintf snapshot path");
5103 /* Add the UST default trace dir to path. */
5104 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5105 reg_chan
, node
.node
) {
5108 * Make sure the maximum stream size is not lower than the
5109 * subbuffer size or else it's an error since we won't be able to
5110 * snapshot anything.
5112 if (max_stream_size
&&
5113 reg_chan
->subbuf_size
> max_stream_size
) {
5115 DBG3("UST app snapshot record maximum stream size %" PRIu64
5116 " is smaller than subbuffer size of %zu",
5117 max_stream_size
, reg_chan
->subbuf_size
);
5120 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5121 usess
->uid
, usess
->gid
, pathname
, wait
,
5127 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5128 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5136 case LTTNG_BUFFER_PER_PID
:
5138 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5139 struct consumer_socket
*socket
;
5140 struct lttng_ht_iter chan_iter
;
5141 struct ust_app_channel
*ua_chan
;
5142 struct ust_app_session
*ua_sess
;
5143 struct ust_registry_session
*registry
;
5145 ua_sess
= lookup_session_by_app(usess
, app
);
5147 /* Session not associated with this app. */
5151 /* Get the right consumer socket for the application. */
5152 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5159 /* Add the UST default trace dir to path. */
5160 memset(pathname
, 0, sizeof(pathname
));
5161 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5164 PERROR("snprintf snapshot path");
5168 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5169 ua_chan
, node
.node
) {
5171 * Make sure the maximum stream size is not lower than the
5172 * subbuffer size or else it's an error since we won't be able to
5173 * snapshot anything.
5175 if (max_stream_size
&&
5176 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5178 DBG3("UST app snapshot record maximum stream size %" PRIu64
5179 " is smaller than subbuffer size of %" PRIu64
,
5180 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5184 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5185 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5192 registry
= get_session_registry(ua_sess
);
5194 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5195 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5214 * Return the number of streams for a UST session.
5216 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5218 unsigned int ret
= 0;
5219 struct ust_app
*app
;
5220 struct lttng_ht_iter iter
;
5224 switch (usess
->buffer_type
) {
5225 case LTTNG_BUFFER_PER_UID
:
5227 struct buffer_reg_uid
*reg
;
5229 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5230 struct buffer_reg_channel
*reg_chan
;
5232 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5233 reg_chan
, node
.node
) {
5234 ret
+= reg_chan
->stream_count
;
5239 case LTTNG_BUFFER_PER_PID
:
5242 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5243 struct ust_app_channel
*ua_chan
;
5244 struct ust_app_session
*ua_sess
;
5245 struct lttng_ht_iter chan_iter
;
5247 ua_sess
= lookup_session_by_app(usess
, app
);
5249 /* Session not associated with this app. */
5253 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5254 ua_chan
, node
.node
) {
5255 ret
+= ua_chan
->streams
.count
;