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"
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 3 elements of the key: name, filter and loglevel. */
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) {
151 * Unique add of an ust app event in the given ht. This uses the custom
152 * ht_match_ust_app_event match function and the event name as hash.
154 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
155 struct ust_app_event
*event
)
157 struct cds_lfht_node
*node_ptr
;
158 struct ust_app_ht_key key
;
162 assert(ua_chan
->events
);
165 ht
= ua_chan
->events
;
166 key
.name
= event
->attr
.name
;
167 key
.filter
= event
->filter
;
168 key
.loglevel
= event
->attr
.loglevel
;
170 node_ptr
= cds_lfht_add_unique(ht
->ht
,
171 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
172 ht_match_ust_app_event
, &key
, &event
->node
.node
);
173 assert(node_ptr
== &event
->node
.node
);
177 * Close the notify socket from the given RCU head object. This MUST be called
178 * through a call_rcu().
180 static void close_notify_sock_rcu(struct rcu_head
*head
)
183 struct ust_app_notify_sock_obj
*obj
=
184 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
186 /* Must have a valid fd here. */
187 assert(obj
->fd
>= 0);
189 ret
= close(obj
->fd
);
191 ERR("close notify sock %d RCU", obj
->fd
);
193 lttng_fd_put(LTTNG_FD_APPS
, 1);
199 * Return the session registry according to the buffer type of the given
202 * A registry per UID object MUST exists before calling this function or else
203 * it assert() if not found. RCU read side lock must be acquired.
205 static struct ust_registry_session
*get_session_registry(
206 struct ust_app_session
*ua_sess
)
208 struct ust_registry_session
*registry
= NULL
;
212 switch (ua_sess
->buffer_type
) {
213 case LTTNG_BUFFER_PER_PID
:
215 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
219 registry
= reg_pid
->registry
->reg
.ust
;
222 case LTTNG_BUFFER_PER_UID
:
224 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
225 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
229 registry
= reg_uid
->registry
->reg
.ust
;
241 * Delete ust context safely. RCU read lock must be held before calling
245 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
252 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
253 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
254 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
255 sock
, ua_ctx
->obj
->handle
, ret
);
263 * Delete ust app event safely. RCU read lock must be held before calling
267 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
273 free(ua_event
->filter
);
275 if (ua_event
->obj
!= NULL
) {
276 ret
= ustctl_release_object(sock
, ua_event
->obj
);
277 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
278 ERR("UST app sock %d release event obj failed with ret %d",
287 * Release ust data object of the given stream.
289 * Return 0 on success or else a negative value.
291 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
298 ret
= ustctl_release_object(sock
, stream
->obj
);
299 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
300 ERR("UST app sock %d release stream obj failed with ret %d",
303 lttng_fd_put(LTTNG_FD_APPS
, 2);
311 * Delete ust app stream safely. RCU read lock must be held before calling
315 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
319 (void) release_ust_app_stream(sock
, stream
);
324 * We need to execute ht_destroy outside of RCU read-side critical
325 * section and outside of call_rcu thread, so we postpone its execution
326 * using ht_cleanup_push. It is simpler than to change the semantic of
327 * the many callers of delete_ust_app_session().
330 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
332 struct ust_app_channel
*ua_chan
=
333 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
335 ht_cleanup_push(ua_chan
->ctx
);
336 ht_cleanup_push(ua_chan
->events
);
341 * Delete ust app channel safely. RCU read lock must be held before calling
345 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
349 struct lttng_ht_iter iter
;
350 struct ust_app_event
*ua_event
;
351 struct ust_app_ctx
*ua_ctx
;
352 struct ust_app_stream
*stream
, *stmp
;
353 struct ust_registry_session
*registry
;
357 DBG3("UST app deleting channel %s", ua_chan
->name
);
360 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
361 cds_list_del(&stream
->list
);
362 delete_ust_app_stream(sock
, stream
);
366 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
367 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
369 delete_ust_app_ctx(sock
, ua_ctx
);
373 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
375 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
377 delete_ust_app_event(sock
, ua_event
);
380 /* Wipe and free registry from session registry. */
381 registry
= get_session_registry(ua_chan
->session
);
383 ust_registry_channel_del_free(registry
, ua_chan
->key
);
386 if (ua_chan
->obj
!= NULL
) {
387 /* Remove channel from application UST object descriptor. */
388 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
389 lttng_ht_del(app
->ust_objd
, &iter
);
390 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
391 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
392 ERR("UST app sock %d release channel obj failed with ret %d",
395 lttng_fd_put(LTTNG_FD_APPS
, 1);
398 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
402 * Push metadata to consumer socket.
404 * The socket lock MUST be acquired.
405 * The ust app session lock MUST be acquired.
407 * On success, return the len of metadata pushed or else a negative value.
409 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
410 struct consumer_socket
*socket
, int send_zero_data
)
413 char *metadata_str
= NULL
;
421 * On a push metadata error either the consumer is dead or the metadata
422 * channel has been destroyed because its endpoint might have died (e.g:
423 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
424 * metadata again which is not valid anymore on the consumer side.
426 * The ust app session mutex locked allows us to make this check without
429 if (registry
->metadata_closed
) {
433 pthread_mutex_lock(®istry
->lock
);
435 offset
= registry
->metadata_len_sent
;
436 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
438 DBG3("No metadata to push for metadata key %" PRIu64
,
439 registry
->metadata_key
);
441 if (send_zero_data
) {
442 DBG("No metadata to push");
448 /* Allocate only what we have to send. */
449 metadata_str
= zmalloc(len
);
451 PERROR("zmalloc ust app metadata string");
455 /* Copy what we haven't send out. */
456 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
457 registry
->metadata_len_sent
+= len
;
460 pthread_mutex_unlock(®istry
->lock
);
461 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
462 metadata_str
, len
, offset
);
473 pthread_mutex_unlock(®istry
->lock
);
480 * For a given application and session, push metadata to consumer. The session
481 * lock MUST be acquired here before calling this.
482 * Either sock or consumer is required : if sock is NULL, the default
483 * socket to send the metadata is retrieved from consumer, if sock
484 * is not NULL we use it to send the metadata.
486 * Return 0 on success else a negative error.
488 static int push_metadata(struct ust_registry_session
*registry
,
489 struct consumer_output
*consumer
)
493 struct consumer_socket
*socket
;
501 * Means that no metadata was assigned to the session. This can happens if
502 * no start has been done previously.
504 if (!registry
->metadata_key
) {
509 /* Get consumer socket to use to push the metadata.*/
510 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
514 goto error_rcu_unlock
;
518 * TODO: Currently, we hold the socket lock around sampling of the next
519 * metadata segment to ensure we send metadata over the consumer socket in
520 * the correct order. This makes the registry lock nest inside the socket
523 * Please note that this is a temporary measure: we should move this lock
524 * back into ust_consumer_push_metadata() when the consumer gets the
525 * ability to reorder the metadata it receives.
527 pthread_mutex_lock(socket
->lock
);
528 ret
= ust_app_push_metadata(registry
, socket
, 0);
529 pthread_mutex_unlock(socket
->lock
);
532 goto error_rcu_unlock
;
540 * On error, flag the registry that the metadata is closed. We were unable
541 * to push anything and this means that either the consumer is not
542 * responding or the metadata cache has been destroyed on the consumer.
544 registry
->metadata_closed
= 1;
551 * Send to the consumer a close metadata command for the given session. Once
552 * done, the metadata channel is deleted and the session metadata pointer is
553 * nullified. The session lock MUST be acquired here unless the application is
554 * in the destroy path.
556 * Return 0 on success else a negative value.
558 static int close_metadata(struct ust_registry_session
*registry
,
559 struct consumer_output
*consumer
)
562 struct consumer_socket
*socket
;
569 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
574 /* Get consumer socket to use to push the metadata.*/
575 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
582 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
589 * Metadata closed. Even on error this means that the consumer is not
590 * responding or not found so either way a second close should NOT be emit
593 registry
->metadata_closed
= 1;
600 * We need to execute ht_destroy outside of RCU read-side critical
601 * section and outside of call_rcu thread, so we postpone its execution
602 * using ht_cleanup_push. It is simpler than to change the semantic of
603 * the many callers of delete_ust_app_session().
606 void delete_ust_app_session_rcu(struct rcu_head
*head
)
608 struct ust_app_session
*ua_sess
=
609 caa_container_of(head
, struct ust_app_session
, rcu_head
);
611 ht_cleanup_push(ua_sess
->channels
);
616 * Delete ust app session safely. RCU read lock must be held before calling
620 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
624 struct lttng_ht_iter iter
;
625 struct ust_app_channel
*ua_chan
;
626 struct ust_registry_session
*registry
;
630 pthread_mutex_lock(&ua_sess
->lock
);
632 registry
= get_session_registry(ua_sess
);
633 if (registry
&& !registry
->metadata_closed
) {
634 /* Push metadata for application before freeing the application. */
635 (void) push_metadata(registry
, ua_sess
->consumer
);
638 * Don't ask to close metadata for global per UID buffers. Close
639 * metadata only on destroy trace session in this case. Also, the
640 * previous push metadata could have flag the metadata registry to
641 * close so don't send a close command if closed.
643 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
644 !registry
->metadata_closed
) {
645 /* And ask to close it for this session registry. */
646 (void) close_metadata(registry
, ua_sess
->consumer
);
650 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
652 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
654 delete_ust_app_channel(sock
, ua_chan
, app
);
657 /* In case of per PID, the registry is kept in the session. */
658 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
659 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
661 buffer_reg_pid_remove(reg_pid
);
662 buffer_reg_pid_destroy(reg_pid
);
666 if (ua_sess
->handle
!= -1) {
667 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
668 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
669 ERR("UST app sock %d release session handle failed with ret %d",
673 pthread_mutex_unlock(&ua_sess
->lock
);
675 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
679 * Delete a traceable application structure from the global list. Never call
680 * this function outside of a call_rcu call.
682 * RCU read side lock should _NOT_ be held when calling this function.
685 void delete_ust_app(struct ust_app
*app
)
688 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
690 /* Delete ust app sessions info */
695 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
697 /* Free every object in the session and the session. */
699 delete_ust_app_session(sock
, ua_sess
, app
);
703 ht_cleanup_push(app
->sessions
);
704 ht_cleanup_push(app
->ust_objd
);
707 * Wait until we have deleted the application from the sock hash table
708 * before closing this socket, otherwise an application could re-use the
709 * socket ID and race with the teardown, using the same hash table entry.
711 * It's OK to leave the close in call_rcu. We want it to stay unique for
712 * all RCU readers that could run concurrently with unregister app,
713 * therefore we _need_ to only close that socket after a grace period. So
714 * it should stay in this RCU callback.
716 * This close() is a very important step of the synchronization model so
717 * every modification to this function must be carefully reviewed.
723 lttng_fd_put(LTTNG_FD_APPS
, 1);
725 DBG2("UST app pid %d deleted", app
->pid
);
730 * URCU intermediate call to delete an UST app.
733 void delete_ust_app_rcu(struct rcu_head
*head
)
735 struct lttng_ht_node_ulong
*node
=
736 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
737 struct ust_app
*app
=
738 caa_container_of(node
, struct ust_app
, pid_n
);
740 DBG3("Call RCU deleting app PID %d", app
->pid
);
745 * Delete the session from the application ht and delete the data structure by
746 * freeing every object inside and releasing them.
748 static void destroy_app_session(struct ust_app
*app
,
749 struct ust_app_session
*ua_sess
)
752 struct lttng_ht_iter iter
;
757 iter
.iter
.node
= &ua_sess
->node
.node
;
758 ret
= lttng_ht_del(app
->sessions
, &iter
);
760 /* Already scheduled for teardown. */
764 /* Once deleted, free the data structure. */
765 delete_ust_app_session(app
->sock
, ua_sess
, app
);
772 * Alloc new UST app session.
775 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
777 struct ust_app_session
*ua_sess
;
779 /* Init most of the default value by allocating and zeroing */
780 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
781 if (ua_sess
== NULL
) {
786 ua_sess
->handle
= -1;
787 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
788 pthread_mutex_init(&ua_sess
->lock
, NULL
);
797 * Alloc new UST app channel.
800 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
801 struct ust_app_session
*ua_sess
,
802 struct lttng_ust_channel_attr
*attr
)
804 struct ust_app_channel
*ua_chan
;
806 /* Init most of the default value by allocating and zeroing */
807 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
808 if (ua_chan
== NULL
) {
813 /* Setup channel name */
814 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
815 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
817 ua_chan
->enabled
= 1;
818 ua_chan
->handle
= -1;
819 ua_chan
->session
= ua_sess
;
820 ua_chan
->key
= get_next_channel_key();
821 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
822 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
823 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
825 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
827 /* Copy attributes */
829 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
830 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
831 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
832 ua_chan
->attr
.overwrite
= attr
->overwrite
;
833 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
834 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
835 ua_chan
->attr
.output
= attr
->output
;
837 /* By default, the channel is a per cpu channel. */
838 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
840 DBG3("UST app channel %s allocated", ua_chan
->name
);
849 * Allocate and initialize a UST app stream.
851 * Return newly allocated stream pointer or NULL on error.
853 struct ust_app_stream
*ust_app_alloc_stream(void)
855 struct ust_app_stream
*stream
= NULL
;
857 stream
= zmalloc(sizeof(*stream
));
858 if (stream
== NULL
) {
859 PERROR("zmalloc ust app stream");
863 /* Zero could be a valid value for a handle so flag it to -1. */
871 * Alloc new UST app event.
874 struct ust_app_event
*alloc_ust_app_event(char *name
,
875 struct lttng_ust_event
*attr
)
877 struct ust_app_event
*ua_event
;
879 /* Init most of the default value by allocating and zeroing */
880 ua_event
= zmalloc(sizeof(struct ust_app_event
));
881 if (ua_event
== NULL
) {
886 ua_event
->enabled
= 1;
887 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
888 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
889 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
891 /* Copy attributes */
893 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
896 DBG3("UST app event %s allocated", ua_event
->name
);
905 * Alloc new UST app context.
908 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
910 struct ust_app_ctx
*ua_ctx
;
912 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
913 if (ua_ctx
== NULL
) {
918 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
921 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
928 * Allocate a filter and copy the given original filter.
930 * Return allocated filter or NULL on error.
932 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
933 struct lttng_ust_filter_bytecode
*orig_f
)
935 struct lttng_ust_filter_bytecode
*filter
= NULL
;
937 /* Copy filter bytecode */
938 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
940 PERROR("zmalloc alloc ust app filter");
944 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
951 * Find an ust_app using the sock and return it. RCU read side lock must be
952 * held before calling this helper function.
955 struct ust_app
*find_app_by_sock(int sock
)
957 struct lttng_ht_node_ulong
*node
;
958 struct lttng_ht_iter iter
;
960 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
961 node
= lttng_ht_iter_get_node_ulong(&iter
);
963 DBG2("UST app find by sock %d not found", sock
);
967 return caa_container_of(node
, struct ust_app
, sock_n
);
974 * Find an ust_app using the notify sock and return it. RCU read side lock must
975 * be held before calling this helper function.
977 static struct ust_app
*find_app_by_notify_sock(int sock
)
979 struct lttng_ht_node_ulong
*node
;
980 struct lttng_ht_iter iter
;
982 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
984 node
= lttng_ht_iter_get_node_ulong(&iter
);
986 DBG2("UST app find by notify sock %d not found", sock
);
990 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
997 * Lookup for an ust app event based on event name, filter bytecode and the
1000 * Return an ust_app_event object or NULL on error.
1002 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1003 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1005 struct lttng_ht_iter iter
;
1006 struct lttng_ht_node_str
*node
;
1007 struct ust_app_event
*event
= NULL
;
1008 struct ust_app_ht_key key
;
1013 /* Setup key for event lookup. */
1015 key
.filter
= filter
;
1016 key
.loglevel
= loglevel
;
1018 /* Lookup using the event name as hash and a custom match fct. */
1019 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1020 ht_match_ust_app_event
, &key
, &iter
.iter
);
1021 node
= lttng_ht_iter_get_node_str(&iter
);
1026 event
= caa_container_of(node
, struct ust_app_event
, node
);
1033 * Create the channel context on the tracer.
1035 * Called with UST app session lock held.
1038 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1039 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1043 health_code_update();
1045 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1046 ua_chan
->obj
, &ua_ctx
->obj
);
1048 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1049 ERR("UST app create channel context failed for app (pid: %d) "
1050 "with ret %d", app
->pid
, ret
);
1052 DBG3("UST app disable event failed. Application is dead.");
1057 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1059 DBG2("UST app context handle %d created successfully for channel %s",
1060 ua_ctx
->handle
, ua_chan
->name
);
1063 health_code_update();
1068 * Set the filter on the tracer.
1071 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1072 struct ust_app
*app
)
1076 health_code_update();
1078 if (!ua_event
->filter
) {
1083 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1086 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1087 ERR("UST app event %s filter failed for app (pid: %d) "
1088 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1090 DBG3("UST app filter event failed. Application is dead.");
1095 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1098 health_code_update();
1103 * Disable the specified event on to UST tracer for the UST session.
1105 static int disable_ust_event(struct ust_app
*app
,
1106 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1110 health_code_update();
1112 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1114 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1115 ERR("UST app event %s disable failed for app (pid: %d) "
1116 "and session handle %d with ret %d",
1117 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1119 DBG3("UST app disable event failed. Application is dead.");
1124 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1125 ua_event
->attr
.name
, app
->pid
);
1128 health_code_update();
1133 * Disable the specified channel on to UST tracer for the UST session.
1135 static int disable_ust_channel(struct ust_app
*app
,
1136 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1140 health_code_update();
1142 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1144 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1145 ERR("UST app channel %s disable failed for app (pid: %d) "
1146 "and session handle %d with ret %d",
1147 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1149 DBG3("UST app disable channel failed. Application is dead.");
1154 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1155 ua_chan
->name
, app
->pid
);
1158 health_code_update();
1163 * Enable the specified channel on to UST tracer for the UST session.
1165 static int enable_ust_channel(struct ust_app
*app
,
1166 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1170 health_code_update();
1172 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1174 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1175 ERR("UST app channel %s enable failed for app (pid: %d) "
1176 "and session handle %d with ret %d",
1177 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1179 DBG3("UST app enable channel failed. Application is dead.");
1184 ua_chan
->enabled
= 1;
1186 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1187 ua_chan
->name
, app
->pid
);
1190 health_code_update();
1195 * Enable the specified event on to UST tracer for the UST session.
1197 static int enable_ust_event(struct ust_app
*app
,
1198 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1202 health_code_update();
1204 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1206 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1207 ERR("UST app event %s enable failed for app (pid: %d) "
1208 "and session handle %d with ret %d",
1209 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1211 DBG3("UST app enable event failed. Application is dead.");
1216 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1217 ua_event
->attr
.name
, app
->pid
);
1220 health_code_update();
1225 * Send channel and stream buffer to application.
1227 * Return 0 on success. On error, a negative value is returned.
1229 static int send_channel_pid_to_ust(struct ust_app
*app
,
1230 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1233 struct ust_app_stream
*stream
, *stmp
;
1239 health_code_update();
1241 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1244 /* Send channel to the application. */
1245 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1250 health_code_update();
1252 /* Send all streams to application. */
1253 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1254 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1258 /* We don't need the stream anymore once sent to the tracer. */
1259 cds_list_del(&stream
->list
);
1260 delete_ust_app_stream(-1, stream
);
1262 /* Flag the channel that it is sent to the application. */
1263 ua_chan
->is_sent
= 1;
1266 health_code_update();
1271 * Create the specified event onto the UST tracer for a UST session.
1273 * Should be called with session mutex held.
1276 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1277 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1281 health_code_update();
1283 /* Create UST event on tracer */
1284 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1287 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1288 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1289 ua_event
->attr
.name
, app
->pid
, ret
);
1291 DBG3("UST app create event failed. Application is dead.");
1296 ua_event
->handle
= ua_event
->obj
->handle
;
1298 DBG2("UST app event %s created successfully for pid:%d",
1299 ua_event
->attr
.name
, app
->pid
);
1301 health_code_update();
1303 /* Set filter if one is present. */
1304 if (ua_event
->filter
) {
1305 ret
= set_ust_event_filter(ua_event
, app
);
1311 /* If event not enabled, disable it on the tracer */
1312 if (ua_event
->enabled
== 0) {
1313 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1316 * If we hit an EPERM, something is wrong with our disable call. If
1317 * we get an EEXIST, there is a problem on the tracer side since we
1321 case -LTTNG_UST_ERR_PERM
:
1322 /* Code flow problem */
1324 case -LTTNG_UST_ERR_EXIST
:
1325 /* It's OK for our use case. */
1336 health_code_update();
1341 * Copy data between an UST app event and a LTT event.
1343 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1344 struct ltt_ust_event
*uevent
)
1346 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1347 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1349 ua_event
->enabled
= uevent
->enabled
;
1351 /* Copy event attributes */
1352 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1354 /* Copy filter bytecode */
1355 if (uevent
->filter
) {
1356 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1357 /* Filter might be NULL here in case of ENONEM. */
1362 * Copy data between an UST app channel and a LTT channel.
1364 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1365 struct ltt_ust_channel
*uchan
)
1367 struct lttng_ht_iter iter
;
1368 struct ltt_ust_event
*uevent
;
1369 struct ltt_ust_context
*uctx
;
1370 struct ust_app_event
*ua_event
;
1371 struct ust_app_ctx
*ua_ctx
;
1373 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1375 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1376 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1378 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1379 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1381 /* Copy event attributes since the layout is different. */
1382 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1383 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1384 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1385 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1386 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1387 ua_chan
->attr
.output
= uchan
->attr
.output
;
1389 * Note that the attribute channel type is not set since the channel on the
1390 * tracing registry side does not have this information.
1393 ua_chan
->enabled
= uchan
->enabled
;
1394 ua_chan
->tracing_channel_id
= uchan
->id
;
1396 cds_lfht_for_each_entry(uchan
->ctx
->ht
, &iter
.iter
, uctx
, node
.node
) {
1397 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1398 if (ua_ctx
== NULL
) {
1401 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1402 (unsigned long) ua_ctx
->ctx
.ctx
);
1403 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1406 /* Copy all events from ltt ust channel to ust app channel */
1407 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1408 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1409 uevent
->filter
, uevent
->attr
.loglevel
);
1410 if (ua_event
== NULL
) {
1411 DBG2("UST event %s not found on shadow copy channel",
1413 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1414 if (ua_event
== NULL
) {
1417 shadow_copy_event(ua_event
, uevent
);
1418 add_unique_ust_app_event(ua_chan
, ua_event
);
1422 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1426 * Copy data between a UST app session and a regular LTT session.
1428 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1429 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1431 struct lttng_ht_node_str
*ua_chan_node
;
1432 struct lttng_ht_iter iter
;
1433 struct ltt_ust_channel
*uchan
;
1434 struct ust_app_channel
*ua_chan
;
1436 struct tm
*timeinfo
;
1440 /* Get date and time for unique app path */
1442 timeinfo
= localtime(&rawtime
);
1443 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1445 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1447 ua_sess
->tracing_id
= usess
->id
;
1448 ua_sess
->id
= get_next_session_id();
1449 ua_sess
->uid
= app
->uid
;
1450 ua_sess
->gid
= app
->gid
;
1451 ua_sess
->euid
= usess
->uid
;
1452 ua_sess
->egid
= usess
->gid
;
1453 ua_sess
->buffer_type
= usess
->buffer_type
;
1454 ua_sess
->bits_per_long
= app
->bits_per_long
;
1455 /* There is only one consumer object per session possible. */
1456 ua_sess
->consumer
= usess
->consumer
;
1457 ua_sess
->output_traces
= usess
->output_traces
;
1459 switch (ua_sess
->buffer_type
) {
1460 case LTTNG_BUFFER_PER_PID
:
1461 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1462 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1465 case LTTNG_BUFFER_PER_UID
:
1466 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1467 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1474 PERROR("asprintf UST shadow copy session");
1479 /* Iterate over all channels in global domain. */
1480 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1482 struct lttng_ht_iter uiter
;
1484 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1485 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1486 if (ua_chan_node
!= NULL
) {
1487 /* Session exist. Contiuing. */
1491 DBG2("Channel %s not found on shadow session copy, creating it",
1493 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1494 if (ua_chan
== NULL
) {
1495 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1498 shadow_copy_channel(ua_chan
, uchan
);
1500 * The concept of metadata channel does not exist on the tracing
1501 * registry side of the session daemon so this can only be a per CPU
1502 * channel and not metadata.
1504 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1506 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1514 * Lookup sesison wrapper.
1517 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1518 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1520 /* Get right UST app session from app */
1521 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1525 * Return ust app session from the app session hashtable using the UST session
1528 static struct ust_app_session
*lookup_session_by_app(
1529 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1531 struct lttng_ht_iter iter
;
1532 struct lttng_ht_node_u64
*node
;
1534 __lookup_session_by_app(usess
, app
, &iter
);
1535 node
= lttng_ht_iter_get_node_u64(&iter
);
1540 return caa_container_of(node
, struct ust_app_session
, node
);
1547 * Setup buffer registry per PID for the given session and application. If none
1548 * is found, a new one is created, added to the global registry and
1549 * initialized. If regp is valid, it's set with the newly created object.
1551 * Return 0 on success or else a negative value.
1553 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1554 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1557 struct buffer_reg_pid
*reg_pid
;
1564 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1567 * This is the create channel path meaning that if there is NO
1568 * registry available, we have to create one for this session.
1570 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1574 buffer_reg_pid_add(reg_pid
);
1579 /* Initialize registry. */
1580 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1581 app
->bits_per_long
, app
->uint8_t_alignment
,
1582 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1583 app
->uint64_t_alignment
, app
->long_alignment
,
1584 app
->byte_order
, app
->version
.major
,
1585 app
->version
.minor
);
1590 DBG3("UST app buffer registry per PID created successfully");
1602 * Setup buffer registry per UID for the given session and application. If none
1603 * is found, a new one is created, added to the global registry and
1604 * initialized. If regp is valid, it's set with the newly created object.
1606 * Return 0 on success or else a negative value.
1608 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1609 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1612 struct buffer_reg_uid
*reg_uid
;
1619 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1622 * This is the create channel path meaning that if there is NO
1623 * registry available, we have to create one for this session.
1625 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1626 LTTNG_DOMAIN_UST
, ®_uid
);
1630 buffer_reg_uid_add(reg_uid
);
1635 /* Initialize registry. */
1636 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1637 app
->bits_per_long
, app
->uint8_t_alignment
,
1638 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1639 app
->uint64_t_alignment
, app
->long_alignment
,
1640 app
->byte_order
, app
->version
.major
,
1641 app
->version
.minor
);
1645 /* Add node to teardown list of the session. */
1646 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1648 DBG3("UST app buffer registry per UID created successfully");
1660 * Create a session on the tracer side for the given app.
1662 * On success, ua_sess_ptr is populated with the session pointer or else left
1663 * untouched. If the session was created, is_created is set to 1. On error,
1664 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1667 * Returns 0 on success or else a negative code which is either -ENOMEM or
1668 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1670 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1671 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1674 int ret
, created
= 0;
1675 struct ust_app_session
*ua_sess
;
1679 assert(ua_sess_ptr
);
1681 health_code_update();
1683 ua_sess
= lookup_session_by_app(usess
, app
);
1684 if (ua_sess
== NULL
) {
1685 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1686 app
->pid
, usess
->id
);
1687 ua_sess
= alloc_ust_app_session(app
);
1688 if (ua_sess
== NULL
) {
1689 /* Only malloc can failed so something is really wrong */
1693 shadow_copy_session(ua_sess
, usess
, app
);
1697 switch (usess
->buffer_type
) {
1698 case LTTNG_BUFFER_PER_PID
:
1699 /* Init local registry. */
1700 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1705 case LTTNG_BUFFER_PER_UID
:
1706 /* Look for a global registry. If none exists, create one. */
1707 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1718 health_code_update();
1720 if (ua_sess
->handle
== -1) {
1721 ret
= ustctl_create_session(app
->sock
);
1723 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1724 ERR("Creating session for app pid %d with ret %d",
1727 DBG("UST app creating session failed. Application is dead");
1729 delete_ust_app_session(-1, ua_sess
, app
);
1730 if (ret
!= -ENOMEM
) {
1732 * Tracer is probably gone or got an internal error so let's
1733 * behave like it will soon unregister or not usable.
1740 ua_sess
->handle
= ret
;
1742 /* Add ust app session to app's HT */
1743 lttng_ht_node_init_u64(&ua_sess
->node
,
1744 ua_sess
->tracing_id
);
1745 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1747 DBG2("UST app session created successfully with handle %d", ret
);
1750 *ua_sess_ptr
= ua_sess
;
1752 *is_created
= created
;
1755 /* Everything went well. */
1759 health_code_update();
1764 * Create a context for the channel on the tracer.
1766 * Called with UST app session lock held and a RCU read side lock.
1769 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1770 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1771 struct ust_app
*app
)
1774 struct lttng_ht_iter iter
;
1775 struct lttng_ht_node_ulong
*node
;
1776 struct ust_app_ctx
*ua_ctx
;
1778 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1780 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1781 node
= lttng_ht_iter_get_node_ulong(&iter
);
1787 ua_ctx
= alloc_ust_app_ctx(uctx
);
1788 if (ua_ctx
== NULL
) {
1794 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1795 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1797 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1807 * Enable on the tracer side a ust app event for the session and channel.
1809 * Called with UST app session lock held.
1812 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1813 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1817 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1822 ua_event
->enabled
= 1;
1829 * Disable on the tracer side a ust app event for the session and channel.
1831 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1832 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1836 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1841 ua_event
->enabled
= 0;
1848 * Lookup ust app channel for session and disable it on the tracer side.
1851 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1852 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1856 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1861 ua_chan
->enabled
= 0;
1868 * Lookup ust app channel for session and enable it on the tracer side. This
1869 * MUST be called with a RCU read side lock acquired.
1871 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1872 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1875 struct lttng_ht_iter iter
;
1876 struct lttng_ht_node_str
*ua_chan_node
;
1877 struct ust_app_channel
*ua_chan
;
1879 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1880 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1881 if (ua_chan_node
== NULL
) {
1882 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1883 uchan
->name
, ua_sess
->tracing_id
);
1887 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1889 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1899 * Ask the consumer to create a channel and get it if successful.
1901 * Return 0 on success or else a negative value.
1903 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1904 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1905 int bitness
, struct ust_registry_session
*registry
)
1908 unsigned int nb_fd
= 0;
1909 struct consumer_socket
*socket
;
1917 health_code_update();
1919 /* Get the right consumer socket for the application. */
1920 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1926 health_code_update();
1928 /* Need one fd for the channel. */
1929 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1931 ERR("Exhausted number of available FD upon create channel");
1936 * Ask consumer to create channel. The consumer will return the number of
1937 * stream we have to expect.
1939 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
1946 * Compute the number of fd needed before receiving them. It must be 2 per
1947 * stream (2 being the default value here).
1949 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
1951 /* Reserve the amount of file descriptor we need. */
1952 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
1954 ERR("Exhausted number of available FD upon create channel");
1955 goto error_fd_get_stream
;
1958 health_code_update();
1961 * Now get the channel from the consumer. This call wil populate the stream
1962 * list of that channel and set the ust objects.
1964 if (usess
->consumer
->enabled
) {
1965 ret
= ust_consumer_get_channel(socket
, ua_chan
);
1975 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
1976 error_fd_get_stream
:
1978 * Initiate a destroy channel on the consumer since we had an error
1979 * handling it on our side. The return value is of no importance since we
1980 * already have a ret value set by the previous error that we need to
1983 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
1985 lttng_fd_put(LTTNG_FD_APPS
, 1);
1987 health_code_update();
1993 * Duplicate the ust data object of the ust app stream and save it in the
1994 * buffer registry stream.
1996 * Return 0 on success or else a negative value.
1998 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
1999 struct ust_app_stream
*stream
)
2006 /* Reserve the amount of file descriptor we need. */
2007 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2009 ERR("Exhausted number of available FD upon duplicate stream");
2013 /* Duplicate object for stream once the original is in the registry. */
2014 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2015 reg_stream
->obj
.ust
);
2017 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2018 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2019 lttng_fd_put(LTTNG_FD_APPS
, 2);
2022 stream
->handle
= stream
->obj
->handle
;
2029 * Duplicate the ust data object of the ust app. channel and save it in the
2030 * buffer registry channel.
2032 * Return 0 on success or else a negative value.
2034 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2035 struct ust_app_channel
*ua_chan
)
2042 /* Need two fds for the channel. */
2043 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2045 ERR("Exhausted number of available FD upon duplicate channel");
2049 /* Duplicate object for stream once the original is in the registry. */
2050 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2052 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2053 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2056 ua_chan
->handle
= ua_chan
->obj
->handle
;
2061 lttng_fd_put(LTTNG_FD_APPS
, 1);
2067 * For a given channel buffer registry, setup all streams of the given ust
2068 * application channel.
2070 * Return 0 on success or else a negative value.
2072 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2073 struct ust_app_channel
*ua_chan
)
2076 struct ust_app_stream
*stream
, *stmp
;
2081 DBG2("UST app setup buffer registry stream");
2083 /* Send all streams to application. */
2084 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2085 struct buffer_reg_stream
*reg_stream
;
2087 ret
= buffer_reg_stream_create(®_stream
);
2093 * Keep original pointer and nullify it in the stream so the delete
2094 * stream call does not release the object.
2096 reg_stream
->obj
.ust
= stream
->obj
;
2098 buffer_reg_stream_add(reg_stream
, reg_chan
);
2100 /* We don't need the streams anymore. */
2101 cds_list_del(&stream
->list
);
2102 delete_ust_app_stream(-1, stream
);
2110 * Create a buffer registry channel for the given session registry and
2111 * application channel object. If regp pointer is valid, it's set with the
2112 * created object. Important, the created object is NOT added to the session
2113 * registry hash table.
2115 * Return 0 on success else a negative value.
2117 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2118 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2121 struct buffer_reg_channel
*reg_chan
= NULL
;
2126 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2128 /* Create buffer registry channel. */
2129 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2134 reg_chan
->consumer_key
= ua_chan
->key
;
2136 /* Create and add a channel registry to session. */
2137 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2138 ua_chan
->tracing_channel_id
);
2142 buffer_reg_channel_add(reg_sess
, reg_chan
);
2151 /* Safe because the registry channel object was not added to any HT. */
2152 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2158 * Setup buffer registry channel for the given session registry and application
2159 * channel object. If regp pointer is valid, it's set with the created object.
2161 * Return 0 on success else a negative value.
2163 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2164 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2171 assert(ua_chan
->obj
);
2173 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2175 /* Setup all streams for the registry. */
2176 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2181 reg_chan
->obj
.ust
= ua_chan
->obj
;
2182 ua_chan
->obj
= NULL
;
2187 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2188 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2193 * Send buffer registry channel to the application.
2195 * Return 0 on success else a negative value.
2197 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2198 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2199 struct ust_app_channel
*ua_chan
)
2202 struct buffer_reg_stream
*reg_stream
;
2209 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2211 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2216 /* Send channel to the application. */
2217 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2222 health_code_update();
2224 /* Send all streams to application. */
2225 pthread_mutex_lock(®_chan
->stream_list_lock
);
2226 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2227 struct ust_app_stream stream
;
2229 ret
= duplicate_stream_object(reg_stream
, &stream
);
2231 goto error_stream_unlock
;
2234 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2236 (void) release_ust_app_stream(-1, &stream
);
2237 goto error_stream_unlock
;
2241 * The return value is not important here. This function will output an
2244 (void) release_ust_app_stream(-1, &stream
);
2246 ua_chan
->is_sent
= 1;
2248 error_stream_unlock
:
2249 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2255 * Create and send to the application the created buffers with per UID buffers.
2257 * Return 0 on success else a negative value.
2259 static int create_channel_per_uid(struct ust_app
*app
,
2260 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2261 struct ust_app_channel
*ua_chan
)
2264 struct buffer_reg_uid
*reg_uid
;
2265 struct buffer_reg_channel
*reg_chan
;
2272 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2274 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2276 * The session creation handles the creation of this global registry
2277 * object. If none can be find, there is a code flow problem or a
2282 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2285 /* Create the buffer registry channel object. */
2286 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2293 * Create the buffers on the consumer side. This call populates the
2294 * ust app channel object with all streams and data object.
2296 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2297 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2300 * Let's remove the previously created buffer registry channel so
2301 * it's not visible anymore in the session registry.
2303 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2304 ua_chan
->tracing_channel_id
);
2305 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2306 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2311 * Setup the streams and add it to the session registry.
2313 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2320 /* Send buffers to the application. */
2321 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2331 * Create and send to the application the created buffers with per PID buffers.
2333 * Return 0 on success else a negative value.
2335 static int create_channel_per_pid(struct ust_app
*app
,
2336 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2337 struct ust_app_channel
*ua_chan
)
2340 struct ust_registry_session
*registry
;
2347 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2351 registry
= get_session_registry(ua_sess
);
2354 /* Create and add a new channel registry to session. */
2355 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2360 /* Create and get channel on the consumer side. */
2361 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2362 app
->bits_per_long
, registry
);
2367 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2378 * From an already allocated ust app channel, create the channel buffers if
2379 * need and send it to the application. This MUST be called with a RCU read
2380 * side lock acquired.
2382 * Return 0 on success or else a negative value.
2384 static int do_create_channel(struct ust_app
*app
,
2385 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2386 struct ust_app_channel
*ua_chan
)
2395 /* Handle buffer type before sending the channel to the application. */
2396 switch (usess
->buffer_type
) {
2397 case LTTNG_BUFFER_PER_UID
:
2399 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2405 case LTTNG_BUFFER_PER_PID
:
2407 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2419 /* Initialize ust objd object using the received handle and add it. */
2420 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2421 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2423 /* If channel is not enabled, disable it on the tracer */
2424 if (!ua_chan
->enabled
) {
2425 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2436 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2437 * newly created channel if not NULL.
2439 * Called with UST app session lock and RCU read-side lock held.
2441 * Return 0 on success or else a negative value.
2443 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2444 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2445 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2446 struct ust_app_channel
**ua_chanp
)
2449 struct lttng_ht_iter iter
;
2450 struct lttng_ht_node_str
*ua_chan_node
;
2451 struct ust_app_channel
*ua_chan
;
2453 /* Lookup channel in the ust app session */
2454 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2455 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2456 if (ua_chan_node
!= NULL
) {
2457 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2461 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2462 if (ua_chan
== NULL
) {
2463 /* Only malloc can fail here */
2467 shadow_copy_channel(ua_chan
, uchan
);
2469 /* Set channel type. */
2470 ua_chan
->attr
.type
= type
;
2472 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2477 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2480 /* Only add the channel if successful on the tracer side. */
2481 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2485 *ua_chanp
= ua_chan
;
2488 /* Everything went well. */
2492 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2498 * Create UST app event and create it on the tracer side.
2500 * Called with ust app session mutex held.
2503 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2504 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2505 struct ust_app
*app
)
2508 struct ust_app_event
*ua_event
;
2510 /* Get event node */
2511 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2512 uevent
->filter
, uevent
->attr
.loglevel
);
2513 if (ua_event
!= NULL
) {
2518 /* Does not exist so create one */
2519 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2520 if (ua_event
== NULL
) {
2521 /* Only malloc can failed so something is really wrong */
2525 shadow_copy_event(ua_event
, uevent
);
2527 /* Create it on the tracer side */
2528 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2530 /* Not found previously means that it does not exist on the tracer */
2531 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2535 add_unique_ust_app_event(ua_chan
, ua_event
);
2537 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2544 /* Valid. Calling here is already in a read side lock */
2545 delete_ust_app_event(-1, ua_event
);
2550 * Create UST metadata and open it on the tracer side.
2552 * Called with UST app session lock held and RCU read side lock.
2554 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2555 struct ust_app
*app
, struct consumer_output
*consumer
,
2556 struct ustctl_consumer_channel_attr
*attr
)
2559 struct ust_app_channel
*metadata
;
2560 struct consumer_socket
*socket
;
2561 struct ust_registry_session
*registry
;
2567 registry
= get_session_registry(ua_sess
);
2570 /* Metadata already exists for this registry or it was closed previously */
2571 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2576 /* Allocate UST metadata */
2577 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2579 /* malloc() failed */
2585 /* Set default attributes for metadata. */
2586 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2587 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2588 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2589 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2590 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2591 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2592 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2594 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2595 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2596 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2599 /* Need one fd for the channel. */
2600 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2602 ERR("Exhausted number of available FD upon create metadata");
2606 /* Get the right consumer socket for the application. */
2607 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2610 goto error_consumer
;
2614 * Keep metadata key so we can identify it on the consumer side. Assign it
2615 * to the registry *before* we ask the consumer so we avoid the race of the
2616 * consumer requesting the metadata and the ask_channel call on our side
2617 * did not returned yet.
2619 registry
->metadata_key
= metadata
->key
;
2622 * Ask the metadata channel creation to the consumer. The metadata object
2623 * will be created by the consumer and kept their. However, the stream is
2624 * never added or monitored until we do a first push metadata to the
2627 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2630 /* Nullify the metadata key so we don't try to close it later on. */
2631 registry
->metadata_key
= 0;
2632 goto error_consumer
;
2636 * The setup command will make the metadata stream be sent to the relayd,
2637 * if applicable, and the thread managing the metadatas. This is important
2638 * because after this point, if an error occurs, the only way the stream
2639 * can be deleted is to be monitored in the consumer.
2641 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2643 /* Nullify the metadata key so we don't try to close it later on. */
2644 registry
->metadata_key
= 0;
2645 goto error_consumer
;
2648 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2649 metadata
->key
, app
->pid
);
2652 lttng_fd_put(LTTNG_FD_APPS
, 1);
2653 delete_ust_app_channel(-1, metadata
, app
);
2659 * Return pointer to traceable apps list.
2661 struct lttng_ht
*ust_app_get_ht(void)
2667 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2668 * acquired before calling this function.
2670 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2672 struct ust_app
*app
= NULL
;
2673 struct lttng_ht_node_ulong
*node
;
2674 struct lttng_ht_iter iter
;
2676 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2677 node
= lttng_ht_iter_get_node_ulong(&iter
);
2679 DBG2("UST app no found with pid %d", pid
);
2683 DBG2("Found UST app by pid %d", pid
);
2685 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2692 * Allocate and init an UST app object using the registration information and
2693 * the command socket. This is called when the command socket connects to the
2696 * The object is returned on success or else NULL.
2698 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2700 struct ust_app
*lta
= NULL
;
2705 DBG3("UST app creating application for socket %d", sock
);
2707 if ((msg
->bits_per_long
== 64 &&
2708 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2709 || (msg
->bits_per_long
== 32 &&
2710 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2711 ERR("Registration failed: application \"%s\" (pid: %d) has "
2712 "%d-bit long, but no consumerd for this size is available.\n",
2713 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2717 lta
= zmalloc(sizeof(struct ust_app
));
2723 lta
->ppid
= msg
->ppid
;
2724 lta
->uid
= msg
->uid
;
2725 lta
->gid
= msg
->gid
;
2727 lta
->bits_per_long
= msg
->bits_per_long
;
2728 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2729 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2730 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2731 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2732 lta
->long_alignment
= msg
->long_alignment
;
2733 lta
->byte_order
= msg
->byte_order
;
2735 lta
->v_major
= msg
->major
;
2736 lta
->v_minor
= msg
->minor
;
2737 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2738 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2739 lta
->notify_sock
= -1;
2741 /* Copy name and make sure it's NULL terminated. */
2742 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2743 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2746 * Before this can be called, when receiving the registration information,
2747 * the application compatibility is checked. So, at this point, the
2748 * application can work with this session daemon.
2750 lta
->compatible
= 1;
2752 lta
->pid
= msg
->pid
;
2753 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2755 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2757 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2764 * For a given application object, add it to every hash table.
2766 void ust_app_add(struct ust_app
*app
)
2769 assert(app
->notify_sock
>= 0);
2774 * On a re-registration, we want to kick out the previous registration of
2777 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2780 * The socket _should_ be unique until _we_ call close. So, a add_unique
2781 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2782 * already in the table.
2784 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2786 /* Add application to the notify socket hash table. */
2787 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2788 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2790 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2791 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2792 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2799 * Set the application version into the object.
2801 * Return 0 on success else a negative value either an errno code or a
2802 * LTTng-UST error code.
2804 int ust_app_version(struct ust_app
*app
)
2810 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2812 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2813 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2815 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2823 * Unregister app by removing it from the global traceable app list and freeing
2826 * The socket is already closed at this point so no close to sock.
2828 void ust_app_unregister(int sock
)
2830 struct ust_app
*lta
;
2831 struct lttng_ht_node_ulong
*node
;
2832 struct lttng_ht_iter iter
;
2833 struct ust_app_session
*ua_sess
;
2838 /* Get the node reference for a call_rcu */
2839 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2840 node
= lttng_ht_iter_get_node_ulong(&iter
);
2843 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2844 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2846 /* Remove application from PID hash table */
2847 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2851 * Remove application from notify hash table. The thread handling the
2852 * notify socket could have deleted the node so ignore on error because
2853 * either way it's valid. The close of that socket is handled by the other
2856 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2857 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2860 * Ignore return value since the node might have been removed before by an
2861 * add replace during app registration because the PID can be reassigned by
2864 iter
.iter
.node
= <a
->pid_n
.node
;
2865 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2867 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2871 /* Remove sessions so they are not visible during deletion.*/
2872 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2874 struct ust_registry_session
*registry
;
2876 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2878 /* The session was already removed so scheduled for teardown. */
2883 * Add session to list for teardown. This is safe since at this point we
2884 * are the only one using this list.
2886 pthread_mutex_lock(&ua_sess
->lock
);
2889 * Normally, this is done in the delete session process which is
2890 * executed in the call rcu below. However, upon registration we can't
2891 * afford to wait for the grace period before pushing data or else the
2892 * data pending feature can race between the unregistration and stop
2893 * command where the data pending command is sent *before* the grace
2896 * The close metadata below nullifies the metadata pointer in the
2897 * session so the delete session will NOT push/close a second time.
2899 registry
= get_session_registry(ua_sess
);
2900 if (registry
&& !registry
->metadata_closed
) {
2901 /* Push metadata for application before freeing the application. */
2902 (void) push_metadata(registry
, ua_sess
->consumer
);
2905 * Don't ask to close metadata for global per UID buffers. Close
2906 * metadata only on destroy trace session in this case. Also, the
2907 * previous push metadata could have flag the metadata registry to
2908 * close so don't send a close command if closed.
2910 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2911 !registry
->metadata_closed
) {
2912 /* And ask to close it for this session registry. */
2913 (void) close_metadata(registry
, ua_sess
->consumer
);
2917 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2918 pthread_mutex_unlock(&ua_sess
->lock
);
2922 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2929 * Return traceable_app_count
2931 unsigned long ust_app_list_count(void)
2933 unsigned long count
;
2936 count
= lttng_ht_get_count(ust_app_ht
);
2943 * Fill events array with all events name of all registered apps.
2945 int ust_app_list_events(struct lttng_event
**events
)
2948 size_t nbmem
, count
= 0;
2949 struct lttng_ht_iter iter
;
2950 struct ust_app
*app
;
2951 struct lttng_event
*tmp_event
;
2953 nbmem
= UST_APP_EVENT_LIST_SIZE
;
2954 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
2955 if (tmp_event
== NULL
) {
2956 PERROR("zmalloc ust app events");
2963 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2964 struct lttng_ust_tracepoint_iter uiter
;
2966 health_code_update();
2968 if (!app
->compatible
) {
2970 * TODO: In time, we should notice the caller of this error by
2971 * telling him that this is a version error.
2975 handle
= ustctl_tracepoint_list(app
->sock
);
2977 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
2978 ERR("UST app list events getting handle failed for app pid %d",
2984 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
2985 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
2986 /* Handle ustctl error. */
2989 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
2990 ERR("UST app tp list get failed for app %d with ret %d",
2993 DBG3("UST app tp list get failed. Application is dead");
2998 health_code_update();
2999 if (count
>= nbmem
) {
3000 /* In case the realloc fails, we free the memory */
3003 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3006 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3008 PERROR("realloc ust app events");
3015 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3016 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3017 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3018 tmp_event
[count
].pid
= app
->pid
;
3019 tmp_event
[count
].enabled
= -1;
3025 *events
= tmp_event
;
3027 DBG2("UST app list events done (%zu events)", count
);
3032 health_code_update();
3037 * Fill events array with all events name of all registered apps.
3039 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3042 size_t nbmem
, count
= 0;
3043 struct lttng_ht_iter iter
;
3044 struct ust_app
*app
;
3045 struct lttng_event_field
*tmp_event
;
3047 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3048 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3049 if (tmp_event
== NULL
) {
3050 PERROR("zmalloc ust app event fields");
3057 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3058 struct lttng_ust_field_iter uiter
;
3060 health_code_update();
3062 if (!app
->compatible
) {
3064 * TODO: In time, we should notice the caller of this error by
3065 * telling him that this is a version error.
3069 handle
= ustctl_tracepoint_field_list(app
->sock
);
3071 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3072 ERR("UST app list field getting handle failed for app pid %d",
3078 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3079 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3080 /* Handle ustctl error. */
3083 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3084 ERR("UST app tp list field failed for app %d with ret %d",
3087 DBG3("UST app tp list field failed. Application is dead");
3092 health_code_update();
3093 if (count
>= nbmem
) {
3094 /* In case the realloc fails, we free the memory */
3097 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3100 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3102 PERROR("realloc ust app event fields");
3110 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3111 tmp_event
[count
].type
= uiter
.type
;
3112 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3114 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3115 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3116 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3117 tmp_event
[count
].event
.pid
= app
->pid
;
3118 tmp_event
[count
].event
.enabled
= -1;
3124 *fields
= tmp_event
;
3126 DBG2("UST app list event fields done (%zu events)", count
);
3131 health_code_update();
3136 * Free and clean all traceable apps of the global list.
3138 * Should _NOT_ be called with RCU read-side lock held.
3140 void ust_app_clean_list(void)
3143 struct ust_app
*app
;
3144 struct lttng_ht_iter iter
;
3146 DBG2("UST app cleaning registered apps hash table");
3150 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3151 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3153 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3156 /* Cleanup socket hash table */
3157 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3159 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3163 /* Cleanup notify socket hash table */
3164 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3165 notify_sock_n
.node
) {
3166 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3171 /* Destroy is done only when the ht is empty */
3172 ht_cleanup_push(ust_app_ht
);
3173 ht_cleanup_push(ust_app_ht_by_sock
);
3174 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3178 * Init UST app hash table.
3180 void ust_app_ht_alloc(void)
3182 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3183 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3184 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3188 * For a specific UST session, disable the channel for all registered apps.
3190 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3191 struct ltt_ust_channel
*uchan
)
3194 struct lttng_ht_iter iter
;
3195 struct lttng_ht_node_str
*ua_chan_node
;
3196 struct ust_app
*app
;
3197 struct ust_app_session
*ua_sess
;
3198 struct ust_app_channel
*ua_chan
;
3200 if (usess
== NULL
|| uchan
== NULL
) {
3201 ERR("Disabling UST global channel with NULL values");
3206 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3207 uchan
->name
, usess
->id
);
3211 /* For every registered applications */
3212 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3213 struct lttng_ht_iter uiter
;
3214 if (!app
->compatible
) {
3216 * TODO: In time, we should notice the caller of this error by
3217 * telling him that this is a version error.
3221 ua_sess
= lookup_session_by_app(usess
, app
);
3222 if (ua_sess
== NULL
) {
3227 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3228 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3229 /* If the session if found for the app, the channel must be there */
3230 assert(ua_chan_node
);
3232 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3233 /* The channel must not be already disabled */
3234 assert(ua_chan
->enabled
== 1);
3236 /* Disable channel onto application */
3237 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3239 /* XXX: We might want to report this error at some point... */
3251 * For a specific UST session, enable the channel for all registered apps.
3253 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3254 struct ltt_ust_channel
*uchan
)
3257 struct lttng_ht_iter iter
;
3258 struct ust_app
*app
;
3259 struct ust_app_session
*ua_sess
;
3261 if (usess
== NULL
|| uchan
== NULL
) {
3262 ERR("Adding UST global channel to NULL values");
3267 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3268 uchan
->name
, usess
->id
);
3272 /* For every registered applications */
3273 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3274 if (!app
->compatible
) {
3276 * TODO: In time, we should notice the caller of this error by
3277 * telling him that this is a version error.
3281 ua_sess
= lookup_session_by_app(usess
, app
);
3282 if (ua_sess
== NULL
) {
3286 /* Enable channel onto application */
3287 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3289 /* XXX: We might want to report this error at some point... */
3301 * Disable an event in a channel and for a specific session.
3303 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3304 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3307 struct lttng_ht_iter iter
, uiter
;
3308 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3309 struct ust_app
*app
;
3310 struct ust_app_session
*ua_sess
;
3311 struct ust_app_channel
*ua_chan
;
3312 struct ust_app_event
*ua_event
;
3314 DBG("UST app disabling event %s for all apps in channel "
3315 "%s for session id %" PRIu64
,
3316 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3320 /* For all registered applications */
3321 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3322 if (!app
->compatible
) {
3324 * TODO: In time, we should notice the caller of this error by
3325 * telling him that this is a version error.
3329 ua_sess
= lookup_session_by_app(usess
, app
);
3330 if (ua_sess
== NULL
) {
3335 /* Lookup channel in the ust app session */
3336 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3337 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3338 if (ua_chan_node
== NULL
) {
3339 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3340 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3343 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3345 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3346 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3347 if (ua_event_node
== NULL
) {
3348 DBG2("Event %s not found in channel %s for app pid %d."
3349 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3352 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3354 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3356 /* XXX: Report error someday... */
3367 * For a specific UST session and UST channel, the event for all
3370 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3371 struct ltt_ust_channel
*uchan
)
3374 struct lttng_ht_iter iter
, uiter
;
3375 struct lttng_ht_node_str
*ua_chan_node
;
3376 struct ust_app
*app
;
3377 struct ust_app_session
*ua_sess
;
3378 struct ust_app_channel
*ua_chan
;
3379 struct ust_app_event
*ua_event
;
3381 DBG("UST app disabling all event for all apps in channel "
3382 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3386 /* For all registered applications */
3387 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3388 if (!app
->compatible
) {
3390 * TODO: In time, we should notice the caller of this error by
3391 * telling him that this is a version error.
3395 ua_sess
= lookup_session_by_app(usess
, app
);
3397 /* The application has problem or is probably dead. */
3401 /* Lookup channel in the ust app session */
3402 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3403 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3404 /* If the channel is not found, there is a code flow error */
3405 assert(ua_chan_node
);
3407 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3409 /* Disable each events of channel */
3410 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3412 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3414 /* XXX: Report error someday... */
3426 * For a specific UST session, create the channel for all registered apps.
3428 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3429 struct ltt_ust_channel
*uchan
)
3431 int ret
= 0, created
;
3432 struct lttng_ht_iter iter
;
3433 struct ust_app
*app
;
3434 struct ust_app_session
*ua_sess
= NULL
;
3436 /* Very wrong code flow */
3440 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3441 uchan
->name
, usess
->id
);
3445 /* For every registered applications */
3446 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3447 if (!app
->compatible
) {
3449 * TODO: In time, we should notice the caller of this error by
3450 * telling him that this is a version error.
3455 * Create session on the tracer side and add it to app session HT. Note
3456 * that if session exist, it will simply return a pointer to the ust
3459 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3464 * The application's socket is not valid. Either a bad socket
3465 * or a timeout on it. We can't inform the caller that for a
3466 * specific app, the session failed so lets continue here.
3471 goto error_rcu_unlock
;
3476 pthread_mutex_lock(&ua_sess
->lock
);
3477 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3478 sizeof(uchan
->name
))) {
3479 struct ustctl_consumer_channel_attr attr
;
3480 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3481 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3484 /* Create channel onto application. We don't need the chan ref. */
3485 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3486 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3488 pthread_mutex_unlock(&ua_sess
->lock
);
3490 if (ret
== -ENOMEM
) {
3491 /* No more memory is a fatal error. Stop right now. */
3492 goto error_rcu_unlock
;
3494 /* Cleanup the created session if it's the case. */
3496 destroy_app_session(app
, ua_sess
);
3507 * Enable event for a specific session and channel on the tracer.
3509 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3510 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3513 struct lttng_ht_iter iter
, uiter
;
3514 struct lttng_ht_node_str
*ua_chan_node
;
3515 struct ust_app
*app
;
3516 struct ust_app_session
*ua_sess
;
3517 struct ust_app_channel
*ua_chan
;
3518 struct ust_app_event
*ua_event
;
3520 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3521 uevent
->attr
.name
, usess
->id
);
3524 * NOTE: At this point, this function is called only if the session and
3525 * channel passed are already created for all apps. and enabled on the
3531 /* For all registered applications */
3532 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3533 if (!app
->compatible
) {
3535 * TODO: In time, we should notice the caller of this error by
3536 * telling him that this is a version error.
3540 ua_sess
= lookup_session_by_app(usess
, app
);
3542 /* The application has problem or is probably dead. */
3546 pthread_mutex_lock(&ua_sess
->lock
);
3548 /* Lookup channel in the ust app session */
3549 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3550 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3551 /* If the channel is not found, there is a code flow error */
3552 assert(ua_chan_node
);
3554 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3556 /* Get event node */
3557 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3558 uevent
->filter
, uevent
->attr
.loglevel
);
3559 if (ua_event
== NULL
) {
3560 DBG3("UST app enable event %s not found for app PID %d."
3561 "Skipping app", uevent
->attr
.name
, app
->pid
);
3565 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3567 pthread_mutex_unlock(&ua_sess
->lock
);
3571 pthread_mutex_unlock(&ua_sess
->lock
);
3580 * For a specific existing UST session and UST channel, creates the event for
3581 * all registered apps.
3583 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3584 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3587 struct lttng_ht_iter iter
, uiter
;
3588 struct lttng_ht_node_str
*ua_chan_node
;
3589 struct ust_app
*app
;
3590 struct ust_app_session
*ua_sess
;
3591 struct ust_app_channel
*ua_chan
;
3593 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3594 uevent
->attr
.name
, usess
->id
);
3598 /* For all registered applications */
3599 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3600 if (!app
->compatible
) {
3602 * TODO: In time, we should notice the caller of this error by
3603 * telling him that this is a version error.
3607 ua_sess
= lookup_session_by_app(usess
, app
);
3609 /* The application has problem or is probably dead. */
3613 pthread_mutex_lock(&ua_sess
->lock
);
3614 /* Lookup channel in the ust app session */
3615 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3616 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3617 /* If the channel is not found, there is a code flow error */
3618 assert(ua_chan_node
);
3620 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3622 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3623 pthread_mutex_unlock(&ua_sess
->lock
);
3625 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3626 /* Possible value at this point: -ENOMEM. If so, we stop! */
3629 DBG2("UST app event %s already exist on app PID %d",
3630 uevent
->attr
.name
, app
->pid
);
3641 * Start tracing for a specific UST session and app.
3644 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3647 struct ust_app_session
*ua_sess
;
3649 DBG("Starting tracing for ust app pid %d", app
->pid
);
3653 if (!app
->compatible
) {
3657 ua_sess
= lookup_session_by_app(usess
, app
);
3658 if (ua_sess
== NULL
) {
3659 /* The session is in teardown process. Ignore and continue. */
3663 pthread_mutex_lock(&ua_sess
->lock
);
3665 /* Upon restart, we skip the setup, already done */
3666 if (ua_sess
->started
) {
3670 /* Create directories if consumer is LOCAL and has a path defined. */
3671 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3672 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3673 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3674 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3676 if (ret
!= -EEXIST
) {
3677 ERR("Trace directory creation error");
3684 * Create the metadata for the application. This returns gracefully if a
3685 * metadata was already set for the session.
3687 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3692 health_code_update();
3695 /* This start the UST tracing */
3696 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3698 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3699 ERR("Error starting tracing for app pid: %d (ret: %d)",
3702 DBG("UST app start session failed. Application is dead.");
3707 /* Indicate that the session has been started once */
3708 ua_sess
->started
= 1;
3710 pthread_mutex_unlock(&ua_sess
->lock
);
3712 health_code_update();
3714 /* Quiescent wait after starting trace */
3715 ret
= ustctl_wait_quiescent(app
->sock
);
3716 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3717 ERR("UST app wait quiescent failed for app pid %d ret %d",
3723 health_code_update();
3727 pthread_mutex_unlock(&ua_sess
->lock
);
3729 health_code_update();
3734 * Stop tracing for a specific UST session and app.
3737 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3740 struct ust_app_session
*ua_sess
;
3741 struct ust_registry_session
*registry
;
3743 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3747 if (!app
->compatible
) {
3748 goto end_no_session
;
3751 ua_sess
= lookup_session_by_app(usess
, app
);
3752 if (ua_sess
== NULL
) {
3753 goto end_no_session
;
3756 pthread_mutex_lock(&ua_sess
->lock
);
3759 * If started = 0, it means that stop trace has been called for a session
3760 * that was never started. It's possible since we can have a fail start
3761 * from either the application manager thread or the command thread. Simply
3762 * indicate that this is a stop error.
3764 if (!ua_sess
->started
) {
3765 goto error_rcu_unlock
;
3768 health_code_update();
3770 /* This inhibits UST tracing */
3771 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3773 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3774 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3777 DBG("UST app stop session failed. Application is dead.");
3779 goto error_rcu_unlock
;
3782 health_code_update();
3784 /* Quiescent wait after stopping trace */
3785 ret
= ustctl_wait_quiescent(app
->sock
);
3786 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3787 ERR("UST app wait quiescent failed for app pid %d ret %d",
3791 health_code_update();
3793 registry
= get_session_registry(ua_sess
);
3796 if (!registry
->metadata_closed
) {
3797 /* Push metadata for application before freeing the application. */
3798 (void) push_metadata(registry
, ua_sess
->consumer
);
3801 pthread_mutex_unlock(&ua_sess
->lock
);
3804 health_code_update();
3808 pthread_mutex_unlock(&ua_sess
->lock
);
3810 health_code_update();
3815 * Flush buffers for a specific UST session and app.
3818 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3821 struct lttng_ht_iter iter
;
3822 struct ust_app_session
*ua_sess
;
3823 struct ust_app_channel
*ua_chan
;
3825 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3829 if (!app
->compatible
) {
3830 goto end_no_session
;
3833 ua_sess
= lookup_session_by_app(usess
, app
);
3834 if (ua_sess
== NULL
) {
3835 goto end_no_session
;
3838 pthread_mutex_lock(&ua_sess
->lock
);
3840 health_code_update();
3842 /* Flushing buffers */
3843 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3845 health_code_update();
3846 assert(ua_chan
->is_sent
);
3847 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3849 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3850 ERR("UST app PID %d channel %s flush failed with ret %d",
3851 app
->pid
, ua_chan
->name
, ret
);
3853 DBG3("UST app failed to flush %s. Application is dead.",
3855 /* No need to continue. */
3858 /* Continuing flushing all buffers */
3863 health_code_update();
3865 pthread_mutex_unlock(&ua_sess
->lock
);
3868 health_code_update();
3873 * Destroy a specific UST session in apps.
3875 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3878 struct ust_app_session
*ua_sess
;
3879 struct lttng_ht_iter iter
;
3880 struct lttng_ht_node_u64
*node
;
3882 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3886 if (!app
->compatible
) {
3890 __lookup_session_by_app(usess
, app
, &iter
);
3891 node
= lttng_ht_iter_get_node_u64(&iter
);
3893 /* Session is being or is deleted. */
3896 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3898 health_code_update();
3899 destroy_app_session(app
, ua_sess
);
3901 health_code_update();
3903 /* Quiescent wait after stopping trace */
3904 ret
= ustctl_wait_quiescent(app
->sock
);
3905 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3906 ERR("UST app wait quiescent failed for app pid %d ret %d",
3911 health_code_update();
3916 * Start tracing for the UST session.
3918 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
3921 struct lttng_ht_iter iter
;
3922 struct ust_app
*app
;
3924 DBG("Starting all UST traces");
3928 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3929 ret
= ust_app_start_trace(usess
, app
);
3931 /* Continue to next apps even on error */
3942 * Start tracing for the UST session.
3944 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
3947 struct lttng_ht_iter iter
;
3948 struct ust_app
*app
;
3950 DBG("Stopping all UST traces");
3954 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3955 ret
= ust_app_stop_trace(usess
, app
);
3957 /* Continue to next apps even on error */
3963 switch (usess
->buffer_type
) {
3964 case LTTNG_BUFFER_PER_UID
:
3966 struct buffer_reg_uid
*reg
;
3968 /* Flush all per UID buffers associated to that session. */
3969 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3970 struct buffer_reg_channel
*reg_chan
;
3971 struct consumer_socket
*socket
;
3973 /* Get consumer socket to use to push the metadata.*/
3974 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
3977 /* Ignore request if no consumer is found for the session. */
3981 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
3982 reg_chan
, node
.node
) {
3984 * The following call will print error values so the return
3985 * code is of little importance because whatever happens, we
3986 * have to try them all.
3988 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
3993 case LTTNG_BUFFER_PER_PID
:
3994 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3995 ret
= ust_app_flush_trace(usess
, app
);
3997 /* Continue to next apps even on error */
4013 * Destroy app UST session.
4015 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4018 struct lttng_ht_iter iter
;
4019 struct ust_app
*app
;
4021 DBG("Destroy all UST traces");
4025 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4026 ret
= destroy_trace(usess
, app
);
4028 /* Continue to next apps even on error */
4039 * Add channels/events from UST global domain to registered apps at sock.
4041 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4044 struct lttng_ht_iter iter
, uiter
, iter_ctx
;
4045 struct ust_app
*app
;
4046 struct ust_app_session
*ua_sess
= NULL
;
4047 struct ust_app_channel
*ua_chan
;
4048 struct ust_app_event
*ua_event
;
4049 struct ust_app_ctx
*ua_ctx
;
4054 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4059 app
= find_app_by_sock(sock
);
4062 * Application can be unregistered before so this is possible hence
4063 * simply stopping the update.
4065 DBG3("UST app update failed to find app sock %d", sock
);
4069 if (!app
->compatible
) {
4073 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4075 /* Tracer is probably gone or ENOMEM. */
4080 pthread_mutex_lock(&ua_sess
->lock
);
4083 * We can iterate safely here over all UST app session since the create ust
4084 * app session above made a shadow copy of the UST global domain from the
4087 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4090 * For a metadata channel, handle it differently.
4092 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4093 sizeof(ua_chan
->name
))) {
4094 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4099 /* Remove it from the hash table and continue!. */
4100 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4102 delete_ust_app_channel(-1, ua_chan
, app
);
4105 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4108 * Stop everything. On error, the application failed, no more
4109 * file descriptor are available or ENOMEM so stopping here is
4110 * the only thing we can do for now.
4116 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter_ctx
.iter
, ua_ctx
,
4118 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4125 /* For each events */
4126 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4128 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4135 pthread_mutex_unlock(&ua_sess
->lock
);
4137 if (usess
->start_trace
) {
4138 ret
= ust_app_start_trace(usess
, app
);
4143 DBG2("UST trace started for app pid %d", app
->pid
);
4146 /* Everything went well at this point. */
4151 pthread_mutex_unlock(&ua_sess
->lock
);
4154 destroy_app_session(app
, ua_sess
);
4161 * Add context to a specific channel for global UST domain.
4163 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4164 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4167 struct lttng_ht_node_str
*ua_chan_node
;
4168 struct lttng_ht_iter iter
, uiter
;
4169 struct ust_app_channel
*ua_chan
= NULL
;
4170 struct ust_app_session
*ua_sess
;
4171 struct ust_app
*app
;
4175 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4176 if (!app
->compatible
) {
4178 * TODO: In time, we should notice the caller of this error by
4179 * telling him that this is a version error.
4183 ua_sess
= lookup_session_by_app(usess
, app
);
4184 if (ua_sess
== NULL
) {
4188 pthread_mutex_lock(&ua_sess
->lock
);
4189 /* Lookup channel in the ust app session */
4190 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4191 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4192 if (ua_chan_node
== NULL
) {
4195 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4197 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4202 pthread_mutex_unlock(&ua_sess
->lock
);
4210 * Enable event for a channel from a UST session for a specific PID.
4212 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4213 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4216 struct lttng_ht_iter iter
;
4217 struct lttng_ht_node_str
*ua_chan_node
;
4218 struct ust_app
*app
;
4219 struct ust_app_session
*ua_sess
;
4220 struct ust_app_channel
*ua_chan
;
4221 struct ust_app_event
*ua_event
;
4223 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4227 app
= ust_app_find_by_pid(pid
);
4229 ERR("UST app enable event per PID %d not found", pid
);
4234 if (!app
->compatible
) {
4239 ua_sess
= lookup_session_by_app(usess
, app
);
4241 /* The application has problem or is probably dead. */
4246 pthread_mutex_lock(&ua_sess
->lock
);
4247 /* Lookup channel in the ust app session */
4248 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4249 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4250 /* If the channel is not found, there is a code flow error */
4251 assert(ua_chan_node
);
4253 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4255 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4256 uevent
->filter
, uevent
->attr
.loglevel
);
4257 if (ua_event
== NULL
) {
4258 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4263 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4270 pthread_mutex_unlock(&ua_sess
->lock
);
4277 * Disable event for a channel from a UST session for a specific PID.
4279 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4280 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4283 struct lttng_ht_iter iter
;
4284 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4285 struct ust_app
*app
;
4286 struct ust_app_session
*ua_sess
;
4287 struct ust_app_channel
*ua_chan
;
4288 struct ust_app_event
*ua_event
;
4290 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4294 app
= ust_app_find_by_pid(pid
);
4296 ERR("UST app disable event per PID %d not found", pid
);
4301 if (!app
->compatible
) {
4306 ua_sess
= lookup_session_by_app(usess
, app
);
4308 /* The application has problem or is probably dead. */
4312 /* Lookup channel in the ust app session */
4313 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4314 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4315 if (ua_chan_node
== NULL
) {
4316 /* Channel does not exist, skip disabling */
4319 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4321 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4322 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4323 if (ua_event_node
== NULL
) {
4324 /* Event does not exist, skip disabling */
4327 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4329 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4340 * Calibrate registered applications.
4342 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4345 struct lttng_ht_iter iter
;
4346 struct ust_app
*app
;
4350 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4351 if (!app
->compatible
) {
4353 * TODO: In time, we should notice the caller of this error by
4354 * telling him that this is a version error.
4359 health_code_update();
4361 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4365 /* Means that it's not implemented on the tracer side. */
4369 DBG2("Calibrate app PID %d returned with error %d",
4376 DBG("UST app global domain calibration finished");
4380 health_code_update();
4386 * Receive registration and populate the given msg structure.
4388 * On success return 0 else a negative value returned by the ustctl call.
4390 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4393 uint32_t pid
, ppid
, uid
, gid
;
4397 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4398 &pid
, &ppid
, &uid
, &gid
,
4399 &msg
->bits_per_long
,
4400 &msg
->uint8_t_alignment
,
4401 &msg
->uint16_t_alignment
,
4402 &msg
->uint32_t_alignment
,
4403 &msg
->uint64_t_alignment
,
4404 &msg
->long_alignment
,
4411 case LTTNG_UST_ERR_EXITING
:
4412 DBG3("UST app recv reg message failed. Application died");
4414 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4415 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4416 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4417 LTTNG_UST_ABI_MINOR_VERSION
);
4420 ERR("UST app recv reg message failed with ret %d", ret
);
4425 msg
->pid
= (pid_t
) pid
;
4426 msg
->ppid
= (pid_t
) ppid
;
4427 msg
->uid
= (uid_t
) uid
;
4428 msg
->gid
= (gid_t
) gid
;
4435 * Return a ust app channel object using the application object and the channel
4436 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4437 * lock MUST be acquired before calling this function.
4439 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4442 struct lttng_ht_node_ulong
*node
;
4443 struct lttng_ht_iter iter
;
4444 struct ust_app_channel
*ua_chan
= NULL
;
4448 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4449 node
= lttng_ht_iter_get_node_ulong(&iter
);
4451 DBG2("UST app channel find by objd %d not found", objd
);
4455 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4462 * Reply to a register channel notification from an application on the notify
4463 * socket. The channel metadata is also created.
4465 * The session UST registry lock is acquired in this function.
4467 * On success 0 is returned else a negative value.
4469 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4470 size_t nr_fields
, struct ustctl_field
*fields
)
4472 int ret
, ret_code
= 0;
4473 uint32_t chan_id
, reg_count
;
4474 uint64_t chan_reg_key
;
4475 enum ustctl_channel_header type
;
4476 struct ust_app
*app
;
4477 struct ust_app_channel
*ua_chan
;
4478 struct ust_app_session
*ua_sess
;
4479 struct ust_registry_session
*registry
;
4480 struct ust_registry_channel
*chan_reg
;
4484 /* Lookup application. If not found, there is a code flow error. */
4485 app
= find_app_by_notify_sock(sock
);
4487 DBG("Application socket %d is being teardown. Abort event notify",
4491 goto error_rcu_unlock
;
4494 /* Lookup channel by UST object descriptor. */
4495 ua_chan
= find_channel_by_objd(app
, cobjd
);
4497 DBG("Application channel is being teardown. Abort event notify");
4500 goto error_rcu_unlock
;
4503 assert(ua_chan
->session
);
4504 ua_sess
= ua_chan
->session
;
4506 /* Get right session registry depending on the session buffer type. */
4507 registry
= get_session_registry(ua_sess
);
4510 /* Depending on the buffer type, a different channel key is used. */
4511 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4512 chan_reg_key
= ua_chan
->tracing_channel_id
;
4514 chan_reg_key
= ua_chan
->key
;
4517 pthread_mutex_lock(®istry
->lock
);
4519 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4522 if (!chan_reg
->register_done
) {
4523 reg_count
= ust_registry_get_event_count(chan_reg
);
4524 if (reg_count
< 31) {
4525 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4527 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4530 chan_reg
->nr_ctx_fields
= nr_fields
;
4531 chan_reg
->ctx_fields
= fields
;
4532 chan_reg
->header_type
= type
;
4534 /* Get current already assigned values. */
4535 type
= chan_reg
->header_type
;
4537 /* Set to NULL so the error path does not do a double free. */
4540 /* Channel id is set during the object creation. */
4541 chan_id
= chan_reg
->chan_id
;
4543 /* Append to metadata */
4544 if (!chan_reg
->metadata_dumped
) {
4545 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4547 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4553 DBG3("UST app replying to register channel key %" PRIu64
4554 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4557 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4559 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4560 ERR("UST app reply channel failed with ret %d", ret
);
4562 DBG3("UST app reply channel failed. Application died");
4567 /* This channel registry registration is completed. */
4568 chan_reg
->register_done
= 1;
4571 pthread_mutex_unlock(®istry
->lock
);
4581 * Add event to the UST channel registry. When the event is added to the
4582 * registry, the metadata is also created. Once done, this replies to the
4583 * application with the appropriate error code.
4585 * The session UST registry lock is acquired in the function.
4587 * On success 0 is returned else a negative value.
4589 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4590 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4591 char *model_emf_uri
)
4594 uint32_t event_id
= 0;
4595 uint64_t chan_reg_key
;
4596 struct ust_app
*app
;
4597 struct ust_app_channel
*ua_chan
;
4598 struct ust_app_session
*ua_sess
;
4599 struct ust_registry_session
*registry
;
4603 /* Lookup application. If not found, there is a code flow error. */
4604 app
= find_app_by_notify_sock(sock
);
4606 DBG("Application socket %d is being teardown. Abort event notify",
4611 free(model_emf_uri
);
4612 goto error_rcu_unlock
;
4615 /* Lookup channel by UST object descriptor. */
4616 ua_chan
= find_channel_by_objd(app
, cobjd
);
4618 DBG("Application channel is being teardown. Abort event notify");
4622 free(model_emf_uri
);
4623 goto error_rcu_unlock
;
4626 assert(ua_chan
->session
);
4627 ua_sess
= ua_chan
->session
;
4629 registry
= get_session_registry(ua_sess
);
4632 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4633 chan_reg_key
= ua_chan
->tracing_channel_id
;
4635 chan_reg_key
= ua_chan
->key
;
4638 pthread_mutex_lock(®istry
->lock
);
4641 * From this point on, this call acquires the ownership of the sig, fields
4642 * and model_emf_uri meaning any free are done inside it if needed. These
4643 * three variables MUST NOT be read/write after this.
4645 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4646 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4647 model_emf_uri
, ua_sess
->buffer_type
, &event_id
);
4650 * The return value is returned to ustctl so in case of an error, the
4651 * application can be notified. In case of an error, it's important not to
4652 * return a negative error or else the application will get closed.
4654 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4656 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4657 ERR("UST app reply event failed with ret %d", ret
);
4659 DBG3("UST app reply event failed. Application died");
4662 * No need to wipe the create event since the application socket will
4663 * get close on error hence cleaning up everything by itself.
4668 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4672 pthread_mutex_unlock(®istry
->lock
);
4679 * Handle application notification through the given notify socket.
4681 * Return 0 on success or else a negative value.
4683 int ust_app_recv_notify(int sock
)
4686 enum ustctl_notify_cmd cmd
;
4688 DBG3("UST app receiving notify from sock %d", sock
);
4690 ret
= ustctl_recv_notify(sock
, &cmd
);
4692 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4693 ERR("UST app recv notify failed with ret %d", ret
);
4695 DBG3("UST app recv notify failed. Application died");
4701 case USTCTL_NOTIFY_CMD_EVENT
:
4703 int sobjd
, cobjd
, loglevel
;
4704 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4706 struct ustctl_field
*fields
;
4708 DBG2("UST app ustctl register event received");
4710 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4711 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4713 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4714 ERR("UST app recv event failed with ret %d", ret
);
4716 DBG3("UST app recv event failed. Application died");
4722 * Add event to the UST registry coming from the notify socket. This
4723 * call will free if needed the sig, fields and model_emf_uri. This
4724 * code path loses the ownsership of these variables and transfer them
4725 * to the this function.
4727 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4728 fields
, loglevel
, model_emf_uri
);
4735 case USTCTL_NOTIFY_CMD_CHANNEL
:
4739 struct ustctl_field
*fields
;
4741 DBG2("UST app ustctl register channel received");
4743 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4746 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4747 ERR("UST app recv channel failed with ret %d", ret
);
4749 DBG3("UST app recv channel failed. Application died");
4755 * The fields ownership are transfered to this function call meaning
4756 * that if needed it will be freed. After this, it's invalid to access
4757 * fields or clean it up.
4759 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4768 /* Should NEVER happen. */
4777 * Once the notify socket hangs up, this is called. First, it tries to find the
4778 * corresponding application. On failure, the call_rcu to close the socket is
4779 * executed. If an application is found, it tries to delete it from the notify
4780 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4782 * Note that an object needs to be allocated here so on ENOMEM failure, the
4783 * call RCU is not done but the rest of the cleanup is.
4785 void ust_app_notify_sock_unregister(int sock
)
4788 struct lttng_ht_iter iter
;
4789 struct ust_app
*app
;
4790 struct ust_app_notify_sock_obj
*obj
;
4796 obj
= zmalloc(sizeof(*obj
));
4799 * An ENOMEM is kind of uncool. If this strikes we continue the
4800 * procedure but the call_rcu will not be called. In this case, we
4801 * accept the fd leak rather than possibly creating an unsynchronized
4802 * state between threads.
4804 * TODO: The notify object should be created once the notify socket is
4805 * registered and stored independantely from the ust app object. The
4806 * tricky part is to synchronize the teardown of the application and
4807 * this notify object. Let's keep that in mind so we can avoid this
4808 * kind of shenanigans with ENOMEM in the teardown path.
4815 DBG("UST app notify socket unregister %d", sock
);
4818 * Lookup application by notify socket. If this fails, this means that the
4819 * hash table delete has already been done by the application
4820 * unregistration process so we can safely close the notify socket in a
4823 app
= find_app_by_notify_sock(sock
);
4828 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4831 * Whatever happens here either we fail or succeed, in both cases we have
4832 * to close the socket after a grace period to continue to the call RCU
4833 * here. If the deletion is successful, the application is not visible
4834 * anymore by other threads and is it fails it means that it was already
4835 * deleted from the hash table so either way we just have to close the
4838 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4844 * Close socket after a grace period to avoid for the socket to be reused
4845 * before the application object is freed creating potential race between
4846 * threads trying to add unique in the global hash table.
4849 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4854 * Destroy a ust app data structure and free its memory.
4856 void ust_app_destroy(struct ust_app
*app
)
4862 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4866 * Take a snapshot for a given UST session. The snapshot is sent to the given
4869 * Return 0 on success or else a negative value.
4871 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4872 struct snapshot_output
*output
, int wait
)
4875 struct lttng_ht_iter iter
;
4876 struct ust_app
*app
;
4883 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4884 struct consumer_socket
*socket
;
4885 struct lttng_ht_iter chan_iter
;
4886 struct ust_app_channel
*ua_chan
;
4887 struct ust_app_session
*ua_sess
;
4888 struct ust_registry_session
*registry
;
4890 ua_sess
= lookup_session_by_app(usess
, app
);
4892 /* Session not associated with this app. */
4896 /* Get the right consumer socket for the application. */
4897 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4904 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
4905 ua_chan
, node
.node
) {
4906 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
4907 ua_sess
->euid
, ua_sess
->egid
, ua_sess
->path
, wait
);
4913 registry
= get_session_registry(ua_sess
);
4915 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
4916 1, ua_sess
->euid
, ua_sess
->egid
, ua_sess
->path
, wait
);