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
;
1458 switch (ua_sess
->buffer_type
) {
1459 case LTTNG_BUFFER_PER_PID
:
1460 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1461 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1464 case LTTNG_BUFFER_PER_UID
:
1465 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1466 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1473 PERROR("asprintf UST shadow copy session");
1478 /* Iterate over all channels in global domain. */
1479 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1481 struct lttng_ht_iter uiter
;
1483 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1484 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1485 if (ua_chan_node
!= NULL
) {
1486 /* Session exist. Contiuing. */
1490 DBG2("Channel %s not found on shadow session copy, creating it",
1492 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1493 if (ua_chan
== NULL
) {
1494 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1497 shadow_copy_channel(ua_chan
, uchan
);
1499 * The concept of metadata channel does not exist on the tracing
1500 * registry side of the session daemon so this can only be a per CPU
1501 * channel and not metadata.
1503 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1505 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1513 * Lookup sesison wrapper.
1516 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1517 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1519 /* Get right UST app session from app */
1520 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1524 * Return ust app session from the app session hashtable using the UST session
1527 static struct ust_app_session
*lookup_session_by_app(
1528 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1530 struct lttng_ht_iter iter
;
1531 struct lttng_ht_node_u64
*node
;
1533 __lookup_session_by_app(usess
, app
, &iter
);
1534 node
= lttng_ht_iter_get_node_u64(&iter
);
1539 return caa_container_of(node
, struct ust_app_session
, node
);
1546 * Setup buffer registry per PID for the given session and application. If none
1547 * is found, a new one is created, added to the global registry and
1548 * initialized. If regp is valid, it's set with the newly created object.
1550 * Return 0 on success or else a negative value.
1552 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1553 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1556 struct buffer_reg_pid
*reg_pid
;
1563 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1566 * This is the create channel path meaning that if there is NO
1567 * registry available, we have to create one for this session.
1569 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1573 buffer_reg_pid_add(reg_pid
);
1578 /* Initialize registry. */
1579 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1580 app
->bits_per_long
, app
->uint8_t_alignment
,
1581 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1582 app
->uint64_t_alignment
, app
->long_alignment
,
1583 app
->byte_order
, app
->version
.major
,
1584 app
->version
.minor
);
1589 DBG3("UST app buffer registry per PID created successfully");
1601 * Setup buffer registry per UID for the given session and application. If none
1602 * is found, a new one is created, added to the global registry and
1603 * initialized. If regp is valid, it's set with the newly created object.
1605 * Return 0 on success or else a negative value.
1607 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1608 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1611 struct buffer_reg_uid
*reg_uid
;
1618 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1621 * This is the create channel path meaning that if there is NO
1622 * registry available, we have to create one for this session.
1624 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1625 LTTNG_DOMAIN_UST
, ®_uid
);
1629 buffer_reg_uid_add(reg_uid
);
1634 /* Initialize registry. */
1635 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1636 app
->bits_per_long
, app
->uint8_t_alignment
,
1637 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1638 app
->uint64_t_alignment
, app
->long_alignment
,
1639 app
->byte_order
, app
->version
.major
,
1640 app
->version
.minor
);
1644 /* Add node to teardown list of the session. */
1645 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1647 DBG3("UST app buffer registry per UID created successfully");
1659 * Create a session on the tracer side for the given app.
1661 * On success, ua_sess_ptr is populated with the session pointer or else left
1662 * untouched. If the session was created, is_created is set to 1. On error,
1663 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1666 * Returns 0 on success or else a negative code which is either -ENOMEM or
1667 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1669 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1670 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1673 int ret
, created
= 0;
1674 struct ust_app_session
*ua_sess
;
1678 assert(ua_sess_ptr
);
1680 health_code_update();
1682 ua_sess
= lookup_session_by_app(usess
, app
);
1683 if (ua_sess
== NULL
) {
1684 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1685 app
->pid
, usess
->id
);
1686 ua_sess
= alloc_ust_app_session(app
);
1687 if (ua_sess
== NULL
) {
1688 /* Only malloc can failed so something is really wrong */
1692 shadow_copy_session(ua_sess
, usess
, app
);
1696 switch (usess
->buffer_type
) {
1697 case LTTNG_BUFFER_PER_PID
:
1698 /* Init local registry. */
1699 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1704 case LTTNG_BUFFER_PER_UID
:
1705 /* Look for a global registry. If none exists, create one. */
1706 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1717 health_code_update();
1719 if (ua_sess
->handle
== -1) {
1720 ret
= ustctl_create_session(app
->sock
);
1722 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1723 ERR("Creating session for app pid %d with ret %d",
1726 DBG("UST app creating session failed. Application is dead");
1728 delete_ust_app_session(-1, ua_sess
, app
);
1729 if (ret
!= -ENOMEM
) {
1731 * Tracer is probably gone or got an internal error so let's
1732 * behave like it will soon unregister or not usable.
1739 ua_sess
->handle
= ret
;
1741 /* Add ust app session to app's HT */
1742 lttng_ht_node_init_u64(&ua_sess
->node
,
1743 ua_sess
->tracing_id
);
1744 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1746 DBG2("UST app session created successfully with handle %d", ret
);
1749 *ua_sess_ptr
= ua_sess
;
1751 *is_created
= created
;
1754 /* Everything went well. */
1758 health_code_update();
1763 * Create a context for the channel on the tracer.
1765 * Called with UST app session lock held and a RCU read side lock.
1768 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1769 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1770 struct ust_app
*app
)
1773 struct lttng_ht_iter iter
;
1774 struct lttng_ht_node_ulong
*node
;
1775 struct ust_app_ctx
*ua_ctx
;
1777 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1779 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1780 node
= lttng_ht_iter_get_node_ulong(&iter
);
1786 ua_ctx
= alloc_ust_app_ctx(uctx
);
1787 if (ua_ctx
== NULL
) {
1793 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1794 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1796 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1806 * Enable on the tracer side a ust app event for the session and channel.
1808 * Called with UST app session lock held.
1811 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1812 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1816 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1821 ua_event
->enabled
= 1;
1828 * Disable on the tracer side a ust app event for the session and channel.
1830 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1831 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1835 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1840 ua_event
->enabled
= 0;
1847 * Lookup ust app channel for session and disable it on the tracer side.
1850 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1851 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1855 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1860 ua_chan
->enabled
= 0;
1867 * Lookup ust app channel for session and enable it on the tracer side. This
1868 * MUST be called with a RCU read side lock acquired.
1870 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1871 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1874 struct lttng_ht_iter iter
;
1875 struct lttng_ht_node_str
*ua_chan_node
;
1876 struct ust_app_channel
*ua_chan
;
1878 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1879 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1880 if (ua_chan_node
== NULL
) {
1881 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1882 uchan
->name
, ua_sess
->tracing_id
);
1886 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1888 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1898 * Ask the consumer to create a channel and get it if successful.
1900 * Return 0 on success or else a negative value.
1902 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1903 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1904 int bitness
, struct ust_registry_session
*registry
)
1907 unsigned int nb_fd
= 0;
1908 struct consumer_socket
*socket
;
1916 health_code_update();
1918 /* Get the right consumer socket for the application. */
1919 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1925 health_code_update();
1927 /* Need one fd for the channel. */
1928 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1930 ERR("Exhausted number of available FD upon create channel");
1935 * Ask consumer to create channel. The consumer will return the number of
1936 * stream we have to expect.
1938 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
1945 * Compute the number of fd needed before receiving them. It must be 2 per
1946 * stream (2 being the default value here).
1948 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
1950 /* Reserve the amount of file descriptor we need. */
1951 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
1953 ERR("Exhausted number of available FD upon create channel");
1954 goto error_fd_get_stream
;
1957 health_code_update();
1960 * Now get the channel from the consumer. This call wil populate the stream
1961 * list of that channel and set the ust objects.
1963 if (usess
->consumer
->enabled
) {
1964 ret
= ust_consumer_get_channel(socket
, ua_chan
);
1974 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
1975 error_fd_get_stream
:
1977 * Initiate a destroy channel on the consumer since we had an error
1978 * handling it on our side. The return value is of no importance since we
1979 * already have a ret value set by the previous error that we need to
1982 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
1984 lttng_fd_put(LTTNG_FD_APPS
, 1);
1986 health_code_update();
1992 * Duplicate the ust data object of the ust app stream and save it in the
1993 * buffer registry stream.
1995 * Return 0 on success or else a negative value.
1997 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
1998 struct ust_app_stream
*stream
)
2005 /* Reserve the amount of file descriptor we need. */
2006 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2008 ERR("Exhausted number of available FD upon duplicate stream");
2012 /* Duplicate object for stream once the original is in the registry. */
2013 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2014 reg_stream
->obj
.ust
);
2016 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2017 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2018 lttng_fd_put(LTTNG_FD_APPS
, 2);
2021 stream
->handle
= stream
->obj
->handle
;
2028 * Duplicate the ust data object of the ust app. channel and save it in the
2029 * buffer registry channel.
2031 * Return 0 on success or else a negative value.
2033 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2034 struct ust_app_channel
*ua_chan
)
2041 /* Need two fds for the channel. */
2042 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2044 ERR("Exhausted number of available FD upon duplicate channel");
2048 /* Duplicate object for stream once the original is in the registry. */
2049 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2051 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2052 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2055 ua_chan
->handle
= ua_chan
->obj
->handle
;
2060 lttng_fd_put(LTTNG_FD_APPS
, 1);
2066 * For a given channel buffer registry, setup all streams of the given ust
2067 * application channel.
2069 * Return 0 on success or else a negative value.
2071 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2072 struct ust_app_channel
*ua_chan
)
2075 struct ust_app_stream
*stream
, *stmp
;
2080 DBG2("UST app setup buffer registry stream");
2082 /* Send all streams to application. */
2083 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2084 struct buffer_reg_stream
*reg_stream
;
2086 ret
= buffer_reg_stream_create(®_stream
);
2092 * Keep original pointer and nullify it in the stream so the delete
2093 * stream call does not release the object.
2095 reg_stream
->obj
.ust
= stream
->obj
;
2097 buffer_reg_stream_add(reg_stream
, reg_chan
);
2099 /* We don't need the streams anymore. */
2100 cds_list_del(&stream
->list
);
2101 delete_ust_app_stream(-1, stream
);
2109 * Create a buffer registry channel for the given session registry and
2110 * application channel object. If regp pointer is valid, it's set with the
2111 * created object. Important, the created object is NOT added to the session
2112 * registry hash table.
2114 * Return 0 on success else a negative value.
2116 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2117 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2120 struct buffer_reg_channel
*reg_chan
= NULL
;
2125 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2127 /* Create buffer registry channel. */
2128 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2133 reg_chan
->consumer_key
= ua_chan
->key
;
2135 /* Create and add a channel registry to session. */
2136 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2137 ua_chan
->tracing_channel_id
);
2141 buffer_reg_channel_add(reg_sess
, reg_chan
);
2150 /* Safe because the registry channel object was not added to any HT. */
2151 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2157 * Setup buffer registry channel for the given session registry and application
2158 * channel object. If regp pointer is valid, it's set with the created object.
2160 * Return 0 on success else a negative value.
2162 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2163 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2170 assert(ua_chan
->obj
);
2172 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2174 /* Setup all streams for the registry. */
2175 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2180 reg_chan
->obj
.ust
= ua_chan
->obj
;
2181 ua_chan
->obj
= NULL
;
2186 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2187 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2192 * Send buffer registry channel to the application.
2194 * Return 0 on success else a negative value.
2196 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2197 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2198 struct ust_app_channel
*ua_chan
)
2201 struct buffer_reg_stream
*reg_stream
;
2208 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2210 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2215 /* Send channel to the application. */
2216 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2221 health_code_update();
2223 /* Send all streams to application. */
2224 pthread_mutex_lock(®_chan
->stream_list_lock
);
2225 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2226 struct ust_app_stream stream
;
2228 ret
= duplicate_stream_object(reg_stream
, &stream
);
2230 goto error_stream_unlock
;
2233 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2235 (void) release_ust_app_stream(-1, &stream
);
2236 goto error_stream_unlock
;
2240 * The return value is not important here. This function will output an
2243 (void) release_ust_app_stream(-1, &stream
);
2245 ua_chan
->is_sent
= 1;
2247 error_stream_unlock
:
2248 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2254 * Create and send to the application the created buffers with per UID buffers.
2256 * Return 0 on success else a negative value.
2258 static int create_channel_per_uid(struct ust_app
*app
,
2259 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2260 struct ust_app_channel
*ua_chan
)
2263 struct buffer_reg_uid
*reg_uid
;
2264 struct buffer_reg_channel
*reg_chan
;
2271 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2273 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2275 * The session creation handles the creation of this global registry
2276 * object. If none can be find, there is a code flow problem or a
2281 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2284 /* Create the buffer registry channel object. */
2285 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2292 * Create the buffers on the consumer side. This call populates the
2293 * ust app channel object with all streams and data object.
2295 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2296 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2299 * Let's remove the previously created buffer registry channel so
2300 * it's not visible anymore in the session registry.
2302 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2303 ua_chan
->tracing_channel_id
);
2304 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2305 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2310 * Setup the streams and add it to the session registry.
2312 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2319 /* Send buffers to the application. */
2320 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2330 * Create and send to the application the created buffers with per PID buffers.
2332 * Return 0 on success else a negative value.
2334 static int create_channel_per_pid(struct ust_app
*app
,
2335 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2336 struct ust_app_channel
*ua_chan
)
2339 struct ust_registry_session
*registry
;
2346 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2350 registry
= get_session_registry(ua_sess
);
2353 /* Create and add a new channel registry to session. */
2354 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2359 /* Create and get channel on the consumer side. */
2360 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2361 app
->bits_per_long
, registry
);
2366 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2377 * From an already allocated ust app channel, create the channel buffers if
2378 * need and send it to the application. This MUST be called with a RCU read
2379 * side lock acquired.
2381 * Return 0 on success or else a negative value.
2383 static int do_create_channel(struct ust_app
*app
,
2384 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2385 struct ust_app_channel
*ua_chan
)
2394 /* Handle buffer type before sending the channel to the application. */
2395 switch (usess
->buffer_type
) {
2396 case LTTNG_BUFFER_PER_UID
:
2398 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2404 case LTTNG_BUFFER_PER_PID
:
2406 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2418 /* Initialize ust objd object using the received handle and add it. */
2419 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2420 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2422 /* If channel is not enabled, disable it on the tracer */
2423 if (!ua_chan
->enabled
) {
2424 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2435 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2436 * newly created channel if not NULL.
2438 * Called with UST app session lock and RCU read-side lock held.
2440 * Return 0 on success or else a negative value.
2442 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2443 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2444 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2445 struct ust_app_channel
**ua_chanp
)
2448 struct lttng_ht_iter iter
;
2449 struct lttng_ht_node_str
*ua_chan_node
;
2450 struct ust_app_channel
*ua_chan
;
2452 /* Lookup channel in the ust app session */
2453 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2454 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2455 if (ua_chan_node
!= NULL
) {
2456 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2460 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2461 if (ua_chan
== NULL
) {
2462 /* Only malloc can fail here */
2466 shadow_copy_channel(ua_chan
, uchan
);
2468 /* Set channel type. */
2469 ua_chan
->attr
.type
= type
;
2471 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2476 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2479 /* Only add the channel if successful on the tracer side. */
2480 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2484 *ua_chanp
= ua_chan
;
2487 /* Everything went well. */
2491 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2497 * Create UST app event and create it on the tracer side.
2499 * Called with ust app session mutex held.
2502 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2503 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2504 struct ust_app
*app
)
2507 struct ust_app_event
*ua_event
;
2509 /* Get event node */
2510 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2511 uevent
->filter
, uevent
->attr
.loglevel
);
2512 if (ua_event
!= NULL
) {
2517 /* Does not exist so create one */
2518 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2519 if (ua_event
== NULL
) {
2520 /* Only malloc can failed so something is really wrong */
2524 shadow_copy_event(ua_event
, uevent
);
2526 /* Create it on the tracer side */
2527 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2529 /* Not found previously means that it does not exist on the tracer */
2530 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2534 add_unique_ust_app_event(ua_chan
, ua_event
);
2536 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2543 /* Valid. Calling here is already in a read side lock */
2544 delete_ust_app_event(-1, ua_event
);
2549 * Create UST metadata and open it on the tracer side.
2551 * Called with UST app session lock held and RCU read side lock.
2553 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2554 struct ust_app
*app
, struct consumer_output
*consumer
,
2555 struct ustctl_consumer_channel_attr
*attr
)
2558 struct ust_app_channel
*metadata
;
2559 struct consumer_socket
*socket
;
2560 struct ust_registry_session
*registry
;
2566 registry
= get_session_registry(ua_sess
);
2569 /* Metadata already exists for this registry or it was closed previously */
2570 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2575 /* Allocate UST metadata */
2576 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2578 /* malloc() failed */
2584 /* Set default attributes for metadata. */
2585 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2586 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2587 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2588 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2589 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2590 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2591 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2593 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2594 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2595 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2598 /* Need one fd for the channel. */
2599 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2601 ERR("Exhausted number of available FD upon create metadata");
2605 /* Get the right consumer socket for the application. */
2606 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2609 goto error_consumer
;
2613 * Keep metadata key so we can identify it on the consumer side. Assign it
2614 * to the registry *before* we ask the consumer so we avoid the race of the
2615 * consumer requesting the metadata and the ask_channel call on our side
2616 * did not returned yet.
2618 registry
->metadata_key
= metadata
->key
;
2621 * Ask the metadata channel creation to the consumer. The metadata object
2622 * will be created by the consumer and kept their. However, the stream is
2623 * never added or monitored until we do a first push metadata to the
2626 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2629 /* Nullify the metadata key so we don't try to close it later on. */
2630 registry
->metadata_key
= 0;
2631 goto error_consumer
;
2635 * The setup command will make the metadata stream be sent to the relayd,
2636 * if applicable, and the thread managing the metadatas. This is important
2637 * because after this point, if an error occurs, the only way the stream
2638 * can be deleted is to be monitored in the consumer.
2640 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2642 /* Nullify the metadata key so we don't try to close it later on. */
2643 registry
->metadata_key
= 0;
2644 goto error_consumer
;
2647 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2648 metadata
->key
, app
->pid
);
2651 lttng_fd_put(LTTNG_FD_APPS
, 1);
2652 delete_ust_app_channel(-1, metadata
, app
);
2658 * Return pointer to traceable apps list.
2660 struct lttng_ht
*ust_app_get_ht(void)
2666 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2667 * acquired before calling this function.
2669 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2671 struct ust_app
*app
= NULL
;
2672 struct lttng_ht_node_ulong
*node
;
2673 struct lttng_ht_iter iter
;
2675 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2676 node
= lttng_ht_iter_get_node_ulong(&iter
);
2678 DBG2("UST app no found with pid %d", pid
);
2682 DBG2("Found UST app by pid %d", pid
);
2684 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2691 * Allocate and init an UST app object using the registration information and
2692 * the command socket. This is called when the command socket connects to the
2695 * The object is returned on success or else NULL.
2697 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2699 struct ust_app
*lta
= NULL
;
2704 DBG3("UST app creating application for socket %d", sock
);
2706 if ((msg
->bits_per_long
== 64 &&
2707 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2708 || (msg
->bits_per_long
== 32 &&
2709 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2710 ERR("Registration failed: application \"%s\" (pid: %d) has "
2711 "%d-bit long, but no consumerd for this size is available.\n",
2712 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2716 lta
= zmalloc(sizeof(struct ust_app
));
2722 lta
->ppid
= msg
->ppid
;
2723 lta
->uid
= msg
->uid
;
2724 lta
->gid
= msg
->gid
;
2726 lta
->bits_per_long
= msg
->bits_per_long
;
2727 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2728 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2729 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2730 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2731 lta
->long_alignment
= msg
->long_alignment
;
2732 lta
->byte_order
= msg
->byte_order
;
2734 lta
->v_major
= msg
->major
;
2735 lta
->v_minor
= msg
->minor
;
2736 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2737 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2738 lta
->notify_sock
= -1;
2740 /* Copy name and make sure it's NULL terminated. */
2741 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2742 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2745 * Before this can be called, when receiving the registration information,
2746 * the application compatibility is checked. So, at this point, the
2747 * application can work with this session daemon.
2749 lta
->compatible
= 1;
2751 lta
->pid
= msg
->pid
;
2752 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2754 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2756 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2763 * For a given application object, add it to every hash table.
2765 void ust_app_add(struct ust_app
*app
)
2768 assert(app
->notify_sock
>= 0);
2773 * On a re-registration, we want to kick out the previous registration of
2776 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2779 * The socket _should_ be unique until _we_ call close. So, a add_unique
2780 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2781 * already in the table.
2783 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2785 /* Add application to the notify socket hash table. */
2786 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2787 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2789 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2790 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2791 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2798 * Set the application version into the object.
2800 * Return 0 on success else a negative value either an errno code or a
2801 * LTTng-UST error code.
2803 int ust_app_version(struct ust_app
*app
)
2809 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2811 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2812 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2814 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2822 * Unregister app by removing it from the global traceable app list and freeing
2825 * The socket is already closed at this point so no close to sock.
2827 void ust_app_unregister(int sock
)
2829 struct ust_app
*lta
;
2830 struct lttng_ht_node_ulong
*node
;
2831 struct lttng_ht_iter iter
;
2832 struct ust_app_session
*ua_sess
;
2837 /* Get the node reference for a call_rcu */
2838 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2839 node
= lttng_ht_iter_get_node_ulong(&iter
);
2842 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2843 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2845 /* Remove application from PID hash table */
2846 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2850 * Remove application from notify hash table. The thread handling the
2851 * notify socket could have deleted the node so ignore on error because
2852 * either way it's valid. The close of that socket is handled by the other
2855 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2856 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2859 * Ignore return value since the node might have been removed before by an
2860 * add replace during app registration because the PID can be reassigned by
2863 iter
.iter
.node
= <a
->pid_n
.node
;
2864 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2866 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2870 /* Remove sessions so they are not visible during deletion.*/
2871 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2873 struct ust_registry_session
*registry
;
2875 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2877 /* The session was already removed so scheduled for teardown. */
2882 * Add session to list for teardown. This is safe since at this point we
2883 * are the only one using this list.
2885 pthread_mutex_lock(&ua_sess
->lock
);
2888 * Normally, this is done in the delete session process which is
2889 * executed in the call rcu below. However, upon registration we can't
2890 * afford to wait for the grace period before pushing data or else the
2891 * data pending feature can race between the unregistration and stop
2892 * command where the data pending command is sent *before* the grace
2895 * The close metadata below nullifies the metadata pointer in the
2896 * session so the delete session will NOT push/close a second time.
2898 registry
= get_session_registry(ua_sess
);
2899 if (registry
&& !registry
->metadata_closed
) {
2900 /* Push metadata for application before freeing the application. */
2901 (void) push_metadata(registry
, ua_sess
->consumer
);
2904 * Don't ask to close metadata for global per UID buffers. Close
2905 * metadata only on destroy trace session in this case. Also, the
2906 * previous push metadata could have flag the metadata registry to
2907 * close so don't send a close command if closed.
2909 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2910 !registry
->metadata_closed
) {
2911 /* And ask to close it for this session registry. */
2912 (void) close_metadata(registry
, ua_sess
->consumer
);
2916 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2917 pthread_mutex_unlock(&ua_sess
->lock
);
2921 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2928 * Return traceable_app_count
2930 unsigned long ust_app_list_count(void)
2932 unsigned long count
;
2935 count
= lttng_ht_get_count(ust_app_ht
);
2942 * Fill events array with all events name of all registered apps.
2944 int ust_app_list_events(struct lttng_event
**events
)
2947 size_t nbmem
, count
= 0;
2948 struct lttng_ht_iter iter
;
2949 struct ust_app
*app
;
2950 struct lttng_event
*tmp_event
;
2952 nbmem
= UST_APP_EVENT_LIST_SIZE
;
2953 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
2954 if (tmp_event
== NULL
) {
2955 PERROR("zmalloc ust app events");
2962 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2963 struct lttng_ust_tracepoint_iter uiter
;
2965 health_code_update();
2967 if (!app
->compatible
) {
2969 * TODO: In time, we should notice the caller of this error by
2970 * telling him that this is a version error.
2974 handle
= ustctl_tracepoint_list(app
->sock
);
2976 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
2977 ERR("UST app list events getting handle failed for app pid %d",
2983 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
2984 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
2985 /* Handle ustctl error. */
2988 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
2989 ERR("UST app tp list get failed for app %d with ret %d",
2992 DBG3("UST app tp list get failed. Application is dead");
2997 health_code_update();
2998 if (count
>= nbmem
) {
2999 /* In case the realloc fails, we free the memory */
3002 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3005 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3007 PERROR("realloc ust app events");
3014 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3015 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3016 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3017 tmp_event
[count
].pid
= app
->pid
;
3018 tmp_event
[count
].enabled
= -1;
3024 *events
= tmp_event
;
3026 DBG2("UST app list events done (%zu events)", count
);
3031 health_code_update();
3036 * Fill events array with all events name of all registered apps.
3038 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3041 size_t nbmem
, count
= 0;
3042 struct lttng_ht_iter iter
;
3043 struct ust_app
*app
;
3044 struct lttng_event_field
*tmp_event
;
3046 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3047 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3048 if (tmp_event
== NULL
) {
3049 PERROR("zmalloc ust app event fields");
3056 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3057 struct lttng_ust_field_iter uiter
;
3059 health_code_update();
3061 if (!app
->compatible
) {
3063 * TODO: In time, we should notice the caller of this error by
3064 * telling him that this is a version error.
3068 handle
= ustctl_tracepoint_field_list(app
->sock
);
3070 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3071 ERR("UST app list field getting handle failed for app pid %d",
3077 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3078 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3079 /* Handle ustctl error. */
3082 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3083 ERR("UST app tp list field failed for app %d with ret %d",
3086 DBG3("UST app tp list field failed. Application is dead");
3091 health_code_update();
3092 if (count
>= nbmem
) {
3093 /* In case the realloc fails, we free the memory */
3096 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3099 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3101 PERROR("realloc ust app event fields");
3109 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3110 tmp_event
[count
].type
= uiter
.type
;
3111 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3113 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3114 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3115 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3116 tmp_event
[count
].event
.pid
= app
->pid
;
3117 tmp_event
[count
].event
.enabled
= -1;
3123 *fields
= tmp_event
;
3125 DBG2("UST app list event fields done (%zu events)", count
);
3130 health_code_update();
3135 * Free and clean all traceable apps of the global list.
3137 * Should _NOT_ be called with RCU read-side lock held.
3139 void ust_app_clean_list(void)
3142 struct ust_app
*app
;
3143 struct lttng_ht_iter iter
;
3145 DBG2("UST app cleaning registered apps hash table");
3149 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3150 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3152 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3155 /* Cleanup socket hash table */
3156 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3158 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3162 /* Cleanup notify socket hash table */
3163 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3164 notify_sock_n
.node
) {
3165 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3170 /* Destroy is done only when the ht is empty */
3171 ht_cleanup_push(ust_app_ht
);
3172 ht_cleanup_push(ust_app_ht_by_sock
);
3173 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3177 * Init UST app hash table.
3179 void ust_app_ht_alloc(void)
3181 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3182 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3183 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3187 * For a specific UST session, disable the channel for all registered apps.
3189 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3190 struct ltt_ust_channel
*uchan
)
3193 struct lttng_ht_iter iter
;
3194 struct lttng_ht_node_str
*ua_chan_node
;
3195 struct ust_app
*app
;
3196 struct ust_app_session
*ua_sess
;
3197 struct ust_app_channel
*ua_chan
;
3199 if (usess
== NULL
|| uchan
== NULL
) {
3200 ERR("Disabling UST global channel with NULL values");
3205 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3206 uchan
->name
, usess
->id
);
3210 /* For every registered applications */
3211 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3212 struct lttng_ht_iter uiter
;
3213 if (!app
->compatible
) {
3215 * TODO: In time, we should notice the caller of this error by
3216 * telling him that this is a version error.
3220 ua_sess
= lookup_session_by_app(usess
, app
);
3221 if (ua_sess
== NULL
) {
3226 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3227 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3228 /* If the session if found for the app, the channel must be there */
3229 assert(ua_chan_node
);
3231 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3232 /* The channel must not be already disabled */
3233 assert(ua_chan
->enabled
== 1);
3235 /* Disable channel onto application */
3236 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3238 /* XXX: We might want to report this error at some point... */
3250 * For a specific UST session, enable the channel for all registered apps.
3252 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3253 struct ltt_ust_channel
*uchan
)
3256 struct lttng_ht_iter iter
;
3257 struct ust_app
*app
;
3258 struct ust_app_session
*ua_sess
;
3260 if (usess
== NULL
|| uchan
== NULL
) {
3261 ERR("Adding UST global channel to NULL values");
3266 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3267 uchan
->name
, usess
->id
);
3271 /* For every registered applications */
3272 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3273 if (!app
->compatible
) {
3275 * TODO: In time, we should notice the caller of this error by
3276 * telling him that this is a version error.
3280 ua_sess
= lookup_session_by_app(usess
, app
);
3281 if (ua_sess
== NULL
) {
3285 /* Enable channel onto application */
3286 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3288 /* XXX: We might want to report this error at some point... */
3300 * Disable an event in a channel and for a specific session.
3302 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3303 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3306 struct lttng_ht_iter iter
, uiter
;
3307 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3308 struct ust_app
*app
;
3309 struct ust_app_session
*ua_sess
;
3310 struct ust_app_channel
*ua_chan
;
3311 struct ust_app_event
*ua_event
;
3313 DBG("UST app disabling event %s for all apps in channel "
3314 "%s for session id %" PRIu64
,
3315 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3319 /* For all registered applications */
3320 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3321 if (!app
->compatible
) {
3323 * TODO: In time, we should notice the caller of this error by
3324 * telling him that this is a version error.
3328 ua_sess
= lookup_session_by_app(usess
, app
);
3329 if (ua_sess
== NULL
) {
3334 /* Lookup channel in the ust app session */
3335 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3336 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3337 if (ua_chan_node
== NULL
) {
3338 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3339 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3342 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3344 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3345 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3346 if (ua_event_node
== NULL
) {
3347 DBG2("Event %s not found in channel %s for app pid %d."
3348 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3351 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3353 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3355 /* XXX: Report error someday... */
3366 * For a specific UST session and UST channel, the event for all
3369 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3370 struct ltt_ust_channel
*uchan
)
3373 struct lttng_ht_iter iter
, uiter
;
3374 struct lttng_ht_node_str
*ua_chan_node
;
3375 struct ust_app
*app
;
3376 struct ust_app_session
*ua_sess
;
3377 struct ust_app_channel
*ua_chan
;
3378 struct ust_app_event
*ua_event
;
3380 DBG("UST app disabling all event for all apps in channel "
3381 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3385 /* For all registered applications */
3386 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3387 if (!app
->compatible
) {
3389 * TODO: In time, we should notice the caller of this error by
3390 * telling him that this is a version error.
3394 ua_sess
= lookup_session_by_app(usess
, app
);
3396 /* The application has problem or is probably dead. */
3400 /* Lookup channel in the ust app session */
3401 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3402 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3403 /* If the channel is not found, there is a code flow error */
3404 assert(ua_chan_node
);
3406 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3408 /* Disable each events of channel */
3409 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3411 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3413 /* XXX: Report error someday... */
3425 * For a specific UST session, create the channel for all registered apps.
3427 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3428 struct ltt_ust_channel
*uchan
)
3430 int ret
= 0, created
;
3431 struct lttng_ht_iter iter
;
3432 struct ust_app
*app
;
3433 struct ust_app_session
*ua_sess
= NULL
;
3435 /* Very wrong code flow */
3439 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3440 uchan
->name
, usess
->id
);
3444 /* For every registered applications */
3445 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3446 if (!app
->compatible
) {
3448 * TODO: In time, we should notice the caller of this error by
3449 * telling him that this is a version error.
3454 * Create session on the tracer side and add it to app session HT. Note
3455 * that if session exist, it will simply return a pointer to the ust
3458 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3463 * The application's socket is not valid. Either a bad socket
3464 * or a timeout on it. We can't inform the caller that for a
3465 * specific app, the session failed so lets continue here.
3470 goto error_rcu_unlock
;
3475 pthread_mutex_lock(&ua_sess
->lock
);
3476 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3477 sizeof(uchan
->name
))) {
3478 struct ustctl_consumer_channel_attr attr
;
3479 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3480 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3483 /* Create channel onto application. We don't need the chan ref. */
3484 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3485 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3487 pthread_mutex_unlock(&ua_sess
->lock
);
3489 if (ret
== -ENOMEM
) {
3490 /* No more memory is a fatal error. Stop right now. */
3491 goto error_rcu_unlock
;
3493 /* Cleanup the created session if it's the case. */
3495 destroy_app_session(app
, ua_sess
);
3506 * Enable event for a specific session and channel on the tracer.
3508 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3509 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3512 struct lttng_ht_iter iter
, uiter
;
3513 struct lttng_ht_node_str
*ua_chan_node
;
3514 struct ust_app
*app
;
3515 struct ust_app_session
*ua_sess
;
3516 struct ust_app_channel
*ua_chan
;
3517 struct ust_app_event
*ua_event
;
3519 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3520 uevent
->attr
.name
, usess
->id
);
3523 * NOTE: At this point, this function is called only if the session and
3524 * channel passed are already created for all apps. and enabled on the
3530 /* For all registered applications */
3531 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3532 if (!app
->compatible
) {
3534 * TODO: In time, we should notice the caller of this error by
3535 * telling him that this is a version error.
3539 ua_sess
= lookup_session_by_app(usess
, app
);
3541 /* The application has problem or is probably dead. */
3545 pthread_mutex_lock(&ua_sess
->lock
);
3547 /* Lookup channel in the ust app session */
3548 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3549 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3550 /* If the channel is not found, there is a code flow error */
3551 assert(ua_chan_node
);
3553 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3555 /* Get event node */
3556 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3557 uevent
->filter
, uevent
->attr
.loglevel
);
3558 if (ua_event
== NULL
) {
3559 DBG3("UST app enable event %s not found for app PID %d."
3560 "Skipping app", uevent
->attr
.name
, app
->pid
);
3564 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3566 pthread_mutex_unlock(&ua_sess
->lock
);
3570 pthread_mutex_unlock(&ua_sess
->lock
);
3579 * For a specific existing UST session and UST channel, creates the event for
3580 * all registered apps.
3582 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3583 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3586 struct lttng_ht_iter iter
, uiter
;
3587 struct lttng_ht_node_str
*ua_chan_node
;
3588 struct ust_app
*app
;
3589 struct ust_app_session
*ua_sess
;
3590 struct ust_app_channel
*ua_chan
;
3592 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3593 uevent
->attr
.name
, usess
->id
);
3597 /* For all registered applications */
3598 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3599 if (!app
->compatible
) {
3601 * TODO: In time, we should notice the caller of this error by
3602 * telling him that this is a version error.
3606 ua_sess
= lookup_session_by_app(usess
, app
);
3608 /* The application has problem or is probably dead. */
3612 pthread_mutex_lock(&ua_sess
->lock
);
3613 /* Lookup channel in the ust app session */
3614 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3615 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3616 /* If the channel is not found, there is a code flow error */
3617 assert(ua_chan_node
);
3619 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3621 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3622 pthread_mutex_unlock(&ua_sess
->lock
);
3624 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3625 /* Possible value at this point: -ENOMEM. If so, we stop! */
3628 DBG2("UST app event %s already exist on app PID %d",
3629 uevent
->attr
.name
, app
->pid
);
3640 * Start tracing for a specific UST session and app.
3643 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3646 struct ust_app_session
*ua_sess
;
3648 DBG("Starting tracing for ust app pid %d", app
->pid
);
3652 if (!app
->compatible
) {
3656 ua_sess
= lookup_session_by_app(usess
, app
);
3657 if (ua_sess
== NULL
) {
3658 /* The session is in teardown process. Ignore and continue. */
3662 pthread_mutex_lock(&ua_sess
->lock
);
3664 /* Upon restart, we skip the setup, already done */
3665 if (ua_sess
->started
) {
3669 /* Create directories if consumer is LOCAL and has a path defined. */
3670 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3671 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3672 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3673 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3675 if (ret
!= -EEXIST
) {
3676 ERR("Trace directory creation error");
3683 * Create the metadata for the application. This returns gracefully if a
3684 * metadata was already set for the session.
3686 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3691 health_code_update();
3694 /* This start the UST tracing */
3695 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3697 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3698 ERR("Error starting tracing for app pid: %d (ret: %d)",
3701 DBG("UST app start session failed. Application is dead.");
3706 /* Indicate that the session has been started once */
3707 ua_sess
->started
= 1;
3709 pthread_mutex_unlock(&ua_sess
->lock
);
3711 health_code_update();
3713 /* Quiescent wait after starting trace */
3714 ret
= ustctl_wait_quiescent(app
->sock
);
3715 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3716 ERR("UST app wait quiescent failed for app pid %d ret %d",
3722 health_code_update();
3726 pthread_mutex_unlock(&ua_sess
->lock
);
3728 health_code_update();
3733 * Stop tracing for a specific UST session and app.
3736 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3739 struct ust_app_session
*ua_sess
;
3740 struct ust_registry_session
*registry
;
3742 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3746 if (!app
->compatible
) {
3747 goto end_no_session
;
3750 ua_sess
= lookup_session_by_app(usess
, app
);
3751 if (ua_sess
== NULL
) {
3752 goto end_no_session
;
3755 pthread_mutex_lock(&ua_sess
->lock
);
3758 * If started = 0, it means that stop trace has been called for a session
3759 * that was never started. It's possible since we can have a fail start
3760 * from either the application manager thread or the command thread. Simply
3761 * indicate that this is a stop error.
3763 if (!ua_sess
->started
) {
3764 goto error_rcu_unlock
;
3767 health_code_update();
3769 /* This inhibits UST tracing */
3770 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3772 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3773 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3776 DBG("UST app stop session failed. Application is dead.");
3778 goto error_rcu_unlock
;
3781 health_code_update();
3783 /* Quiescent wait after stopping trace */
3784 ret
= ustctl_wait_quiescent(app
->sock
);
3785 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3786 ERR("UST app wait quiescent failed for app pid %d ret %d",
3790 health_code_update();
3792 registry
= get_session_registry(ua_sess
);
3795 if (!registry
->metadata_closed
) {
3796 /* Push metadata for application before freeing the application. */
3797 (void) push_metadata(registry
, ua_sess
->consumer
);
3800 pthread_mutex_unlock(&ua_sess
->lock
);
3803 health_code_update();
3807 pthread_mutex_unlock(&ua_sess
->lock
);
3809 health_code_update();
3814 * Flush buffers for a specific UST session and app.
3817 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3820 struct lttng_ht_iter iter
;
3821 struct ust_app_session
*ua_sess
;
3822 struct ust_app_channel
*ua_chan
;
3824 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3828 if (!app
->compatible
) {
3829 goto end_no_session
;
3832 ua_sess
= lookup_session_by_app(usess
, app
);
3833 if (ua_sess
== NULL
) {
3834 goto end_no_session
;
3837 pthread_mutex_lock(&ua_sess
->lock
);
3839 health_code_update();
3841 /* Flushing buffers */
3842 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3844 health_code_update();
3845 assert(ua_chan
->is_sent
);
3846 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3848 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3849 ERR("UST app PID %d channel %s flush failed with ret %d",
3850 app
->pid
, ua_chan
->name
, ret
);
3852 DBG3("UST app failed to flush %s. Application is dead.",
3854 /* No need to continue. */
3857 /* Continuing flushing all buffers */
3862 health_code_update();
3864 pthread_mutex_unlock(&ua_sess
->lock
);
3867 health_code_update();
3872 * Destroy a specific UST session in apps.
3874 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3877 struct ust_app_session
*ua_sess
;
3878 struct lttng_ht_iter iter
;
3879 struct lttng_ht_node_u64
*node
;
3881 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3885 if (!app
->compatible
) {
3889 __lookup_session_by_app(usess
, app
, &iter
);
3890 node
= lttng_ht_iter_get_node_u64(&iter
);
3892 /* Session is being or is deleted. */
3895 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3897 health_code_update();
3898 destroy_app_session(app
, ua_sess
);
3900 health_code_update();
3902 /* Quiescent wait after stopping trace */
3903 ret
= ustctl_wait_quiescent(app
->sock
);
3904 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3905 ERR("UST app wait quiescent failed for app pid %d ret %d",
3910 health_code_update();
3915 * Start tracing for the UST session.
3917 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
3920 struct lttng_ht_iter iter
;
3921 struct ust_app
*app
;
3923 DBG("Starting all UST traces");
3927 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3928 ret
= ust_app_start_trace(usess
, app
);
3930 /* Continue to next apps even on error */
3941 * Start tracing for the UST session.
3943 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
3946 struct lttng_ht_iter iter
;
3947 struct ust_app
*app
;
3949 DBG("Stopping all UST traces");
3953 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3954 ret
= ust_app_stop_trace(usess
, app
);
3956 /* Continue to next apps even on error */
3962 switch (usess
->buffer_type
) {
3963 case LTTNG_BUFFER_PER_UID
:
3965 struct buffer_reg_uid
*reg
;
3967 /* Flush all per UID buffers associated to that session. */
3968 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3969 struct buffer_reg_channel
*reg_chan
;
3970 struct consumer_socket
*socket
;
3972 /* Get consumer socket to use to push the metadata.*/
3973 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
3976 /* Ignore request if no consumer is found for the session. */
3980 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
3981 reg_chan
, node
.node
) {
3983 * The following call will print error values so the return
3984 * code is of little importance because whatever happens, we
3985 * have to try them all.
3987 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
3992 case LTTNG_BUFFER_PER_PID
:
3993 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3994 ret
= ust_app_flush_trace(usess
, app
);
3996 /* Continue to next apps even on error */
4012 * Destroy app UST session.
4014 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4017 struct lttng_ht_iter iter
;
4018 struct ust_app
*app
;
4020 DBG("Destroy all UST traces");
4024 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4025 ret
= destroy_trace(usess
, app
);
4027 /* Continue to next apps even on error */
4038 * Add channels/events from UST global domain to registered apps at sock.
4040 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4043 struct lttng_ht_iter iter
, uiter
, iter_ctx
;
4044 struct ust_app
*app
;
4045 struct ust_app_session
*ua_sess
= NULL
;
4046 struct ust_app_channel
*ua_chan
;
4047 struct ust_app_event
*ua_event
;
4048 struct ust_app_ctx
*ua_ctx
;
4053 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4058 app
= find_app_by_sock(sock
);
4061 * Application can be unregistered before so this is possible hence
4062 * simply stopping the update.
4064 DBG3("UST app update failed to find app sock %d", sock
);
4068 if (!app
->compatible
) {
4072 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4074 /* Tracer is probably gone or ENOMEM. */
4079 pthread_mutex_lock(&ua_sess
->lock
);
4082 * We can iterate safely here over all UST app session since the create ust
4083 * app session above made a shadow copy of the UST global domain from the
4086 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4089 * For a metadata channel, handle it differently.
4091 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4092 sizeof(ua_chan
->name
))) {
4093 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4098 /* Remove it from the hash table and continue!. */
4099 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4101 delete_ust_app_channel(-1, ua_chan
, app
);
4104 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4107 * Stop everything. On error, the application failed, no more
4108 * file descriptor are available or ENOMEM so stopping here is
4109 * the only thing we can do for now.
4115 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter_ctx
.iter
, ua_ctx
,
4117 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4124 /* For each events */
4125 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4127 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4134 pthread_mutex_unlock(&ua_sess
->lock
);
4136 if (usess
->start_trace
) {
4137 ret
= ust_app_start_trace(usess
, app
);
4142 DBG2("UST trace started for app pid %d", app
->pid
);
4145 /* Everything went well at this point. */
4150 pthread_mutex_unlock(&ua_sess
->lock
);
4153 destroy_app_session(app
, ua_sess
);
4160 * Add context to a specific channel for global UST domain.
4162 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4163 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4166 struct lttng_ht_node_str
*ua_chan_node
;
4167 struct lttng_ht_iter iter
, uiter
;
4168 struct ust_app_channel
*ua_chan
= NULL
;
4169 struct ust_app_session
*ua_sess
;
4170 struct ust_app
*app
;
4174 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4175 if (!app
->compatible
) {
4177 * TODO: In time, we should notice the caller of this error by
4178 * telling him that this is a version error.
4182 ua_sess
= lookup_session_by_app(usess
, app
);
4183 if (ua_sess
== NULL
) {
4187 pthread_mutex_lock(&ua_sess
->lock
);
4188 /* Lookup channel in the ust app session */
4189 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4190 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4191 if (ua_chan_node
== NULL
) {
4194 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4196 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4201 pthread_mutex_unlock(&ua_sess
->lock
);
4209 * Enable event for a channel from a UST session for a specific PID.
4211 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4212 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4215 struct lttng_ht_iter iter
;
4216 struct lttng_ht_node_str
*ua_chan_node
;
4217 struct ust_app
*app
;
4218 struct ust_app_session
*ua_sess
;
4219 struct ust_app_channel
*ua_chan
;
4220 struct ust_app_event
*ua_event
;
4222 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4226 app
= ust_app_find_by_pid(pid
);
4228 ERR("UST app enable event per PID %d not found", pid
);
4233 if (!app
->compatible
) {
4238 ua_sess
= lookup_session_by_app(usess
, app
);
4240 /* The application has problem or is probably dead. */
4245 pthread_mutex_lock(&ua_sess
->lock
);
4246 /* Lookup channel in the ust app session */
4247 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4248 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4249 /* If the channel is not found, there is a code flow error */
4250 assert(ua_chan_node
);
4252 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4254 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4255 uevent
->filter
, uevent
->attr
.loglevel
);
4256 if (ua_event
== NULL
) {
4257 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4262 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4269 pthread_mutex_unlock(&ua_sess
->lock
);
4276 * Disable event for a channel from a UST session for a specific PID.
4278 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4279 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4282 struct lttng_ht_iter iter
;
4283 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4284 struct ust_app
*app
;
4285 struct ust_app_session
*ua_sess
;
4286 struct ust_app_channel
*ua_chan
;
4287 struct ust_app_event
*ua_event
;
4289 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4293 app
= ust_app_find_by_pid(pid
);
4295 ERR("UST app disable event per PID %d not found", pid
);
4300 if (!app
->compatible
) {
4305 ua_sess
= lookup_session_by_app(usess
, app
);
4307 /* The application has problem or is probably dead. */
4311 /* Lookup channel in the ust app session */
4312 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4313 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4314 if (ua_chan_node
== NULL
) {
4315 /* Channel does not exist, skip disabling */
4318 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4320 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4321 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4322 if (ua_event_node
== NULL
) {
4323 /* Event does not exist, skip disabling */
4326 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4328 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4339 * Calibrate registered applications.
4341 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4344 struct lttng_ht_iter iter
;
4345 struct ust_app
*app
;
4349 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4350 if (!app
->compatible
) {
4352 * TODO: In time, we should notice the caller of this error by
4353 * telling him that this is a version error.
4358 health_code_update();
4360 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4364 /* Means that it's not implemented on the tracer side. */
4368 DBG2("Calibrate app PID %d returned with error %d",
4375 DBG("UST app global domain calibration finished");
4379 health_code_update();
4385 * Receive registration and populate the given msg structure.
4387 * On success return 0 else a negative value returned by the ustctl call.
4389 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4392 uint32_t pid
, ppid
, uid
, gid
;
4396 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4397 &pid
, &ppid
, &uid
, &gid
,
4398 &msg
->bits_per_long
,
4399 &msg
->uint8_t_alignment
,
4400 &msg
->uint16_t_alignment
,
4401 &msg
->uint32_t_alignment
,
4402 &msg
->uint64_t_alignment
,
4403 &msg
->long_alignment
,
4410 case LTTNG_UST_ERR_EXITING
:
4411 DBG3("UST app recv reg message failed. Application died");
4413 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4414 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4415 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4416 LTTNG_UST_ABI_MINOR_VERSION
);
4419 ERR("UST app recv reg message failed with ret %d", ret
);
4424 msg
->pid
= (pid_t
) pid
;
4425 msg
->ppid
= (pid_t
) ppid
;
4426 msg
->uid
= (uid_t
) uid
;
4427 msg
->gid
= (gid_t
) gid
;
4434 * Return a ust app channel object using the application object and the channel
4435 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4436 * lock MUST be acquired before calling this function.
4438 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4441 struct lttng_ht_node_ulong
*node
;
4442 struct lttng_ht_iter iter
;
4443 struct ust_app_channel
*ua_chan
= NULL
;
4447 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4448 node
= lttng_ht_iter_get_node_ulong(&iter
);
4450 DBG2("UST app channel find by objd %d not found", objd
);
4454 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4461 * Reply to a register channel notification from an application on the notify
4462 * socket. The channel metadata is also created.
4464 * The session UST registry lock is acquired in this function.
4466 * On success 0 is returned else a negative value.
4468 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4469 size_t nr_fields
, struct ustctl_field
*fields
)
4471 int ret
, ret_code
= 0;
4472 uint32_t chan_id
, reg_count
;
4473 uint64_t chan_reg_key
;
4474 enum ustctl_channel_header type
;
4475 struct ust_app
*app
;
4476 struct ust_app_channel
*ua_chan
;
4477 struct ust_app_session
*ua_sess
;
4478 struct ust_registry_session
*registry
;
4479 struct ust_registry_channel
*chan_reg
;
4483 /* Lookup application. If not found, there is a code flow error. */
4484 app
= find_app_by_notify_sock(sock
);
4486 DBG("Application socket %d is being teardown. Abort event notify",
4490 goto error_rcu_unlock
;
4493 /* Lookup channel by UST object descriptor. */
4494 ua_chan
= find_channel_by_objd(app
, cobjd
);
4496 DBG("Application channel is being teardown. Abort event notify");
4499 goto error_rcu_unlock
;
4502 assert(ua_chan
->session
);
4503 ua_sess
= ua_chan
->session
;
4505 /* Get right session registry depending on the session buffer type. */
4506 registry
= get_session_registry(ua_sess
);
4509 /* Depending on the buffer type, a different channel key is used. */
4510 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4511 chan_reg_key
= ua_chan
->tracing_channel_id
;
4513 chan_reg_key
= ua_chan
->key
;
4516 pthread_mutex_lock(®istry
->lock
);
4518 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4521 if (!chan_reg
->register_done
) {
4522 reg_count
= ust_registry_get_event_count(chan_reg
);
4523 if (reg_count
< 31) {
4524 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4526 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4529 chan_reg
->nr_ctx_fields
= nr_fields
;
4530 chan_reg
->ctx_fields
= fields
;
4531 chan_reg
->header_type
= type
;
4533 /* Get current already assigned values. */
4534 type
= chan_reg
->header_type
;
4536 /* Set to NULL so the error path does not do a double free. */
4539 /* Channel id is set during the object creation. */
4540 chan_id
= chan_reg
->chan_id
;
4542 /* Append to metadata */
4543 if (!chan_reg
->metadata_dumped
) {
4544 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4546 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4552 DBG3("UST app replying to register channel key %" PRIu64
4553 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4556 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4558 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4559 ERR("UST app reply channel failed with ret %d", ret
);
4561 DBG3("UST app reply channel failed. Application died");
4566 /* This channel registry registration is completed. */
4567 chan_reg
->register_done
= 1;
4570 pthread_mutex_unlock(®istry
->lock
);
4580 * Add event to the UST channel registry. When the event is added to the
4581 * registry, the metadata is also created. Once done, this replies to the
4582 * application with the appropriate error code.
4584 * The session UST registry lock is acquired in the function.
4586 * On success 0 is returned else a negative value.
4588 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4589 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4590 char *model_emf_uri
)
4593 uint32_t event_id
= 0;
4594 uint64_t chan_reg_key
;
4595 struct ust_app
*app
;
4596 struct ust_app_channel
*ua_chan
;
4597 struct ust_app_session
*ua_sess
;
4598 struct ust_registry_session
*registry
;
4602 /* Lookup application. If not found, there is a code flow error. */
4603 app
= find_app_by_notify_sock(sock
);
4605 DBG("Application socket %d is being teardown. Abort event notify",
4610 free(model_emf_uri
);
4611 goto error_rcu_unlock
;
4614 /* Lookup channel by UST object descriptor. */
4615 ua_chan
= find_channel_by_objd(app
, cobjd
);
4617 DBG("Application channel is being teardown. Abort event notify");
4621 free(model_emf_uri
);
4622 goto error_rcu_unlock
;
4625 assert(ua_chan
->session
);
4626 ua_sess
= ua_chan
->session
;
4628 registry
= get_session_registry(ua_sess
);
4631 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4632 chan_reg_key
= ua_chan
->tracing_channel_id
;
4634 chan_reg_key
= ua_chan
->key
;
4637 pthread_mutex_lock(®istry
->lock
);
4640 * From this point on, this call acquires the ownership of the sig, fields
4641 * and model_emf_uri meaning any free are done inside it if needed. These
4642 * three variables MUST NOT be read/write after this.
4644 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4645 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4646 model_emf_uri
, ua_sess
->buffer_type
, &event_id
);
4649 * The return value is returned to ustctl so in case of an error, the
4650 * application can be notified. In case of an error, it's important not to
4651 * return a negative error or else the application will get closed.
4653 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4655 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4656 ERR("UST app reply event failed with ret %d", ret
);
4658 DBG3("UST app reply event failed. Application died");
4661 * No need to wipe the create event since the application socket will
4662 * get close on error hence cleaning up everything by itself.
4667 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4671 pthread_mutex_unlock(®istry
->lock
);
4678 * Handle application notification through the given notify socket.
4680 * Return 0 on success or else a negative value.
4682 int ust_app_recv_notify(int sock
)
4685 enum ustctl_notify_cmd cmd
;
4687 DBG3("UST app receiving notify from sock %d", sock
);
4689 ret
= ustctl_recv_notify(sock
, &cmd
);
4691 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4692 ERR("UST app recv notify failed with ret %d", ret
);
4694 DBG3("UST app recv notify failed. Application died");
4700 case USTCTL_NOTIFY_CMD_EVENT
:
4702 int sobjd
, cobjd
, loglevel
;
4703 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4705 struct ustctl_field
*fields
;
4707 DBG2("UST app ustctl register event received");
4709 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4710 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4712 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4713 ERR("UST app recv event failed with ret %d", ret
);
4715 DBG3("UST app recv event failed. Application died");
4721 * Add event to the UST registry coming from the notify socket. This
4722 * call will free if needed the sig, fields and model_emf_uri. This
4723 * code path loses the ownsership of these variables and transfer them
4724 * to the this function.
4726 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4727 fields
, loglevel
, model_emf_uri
);
4734 case USTCTL_NOTIFY_CMD_CHANNEL
:
4738 struct ustctl_field
*fields
;
4740 DBG2("UST app ustctl register channel received");
4742 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4745 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4746 ERR("UST app recv channel failed with ret %d", ret
);
4748 DBG3("UST app recv channel failed. Application died");
4754 * The fields ownership are transfered to this function call meaning
4755 * that if needed it will be freed. After this, it's invalid to access
4756 * fields or clean it up.
4758 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4767 /* Should NEVER happen. */
4776 * Once the notify socket hangs up, this is called. First, it tries to find the
4777 * corresponding application. On failure, the call_rcu to close the socket is
4778 * executed. If an application is found, it tries to delete it from the notify
4779 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4781 * Note that an object needs to be allocated here so on ENOMEM failure, the
4782 * call RCU is not done but the rest of the cleanup is.
4784 void ust_app_notify_sock_unregister(int sock
)
4787 struct lttng_ht_iter iter
;
4788 struct ust_app
*app
;
4789 struct ust_app_notify_sock_obj
*obj
;
4795 obj
= zmalloc(sizeof(*obj
));
4798 * An ENOMEM is kind of uncool. If this strikes we continue the
4799 * procedure but the call_rcu will not be called. In this case, we
4800 * accept the fd leak rather than possibly creating an unsynchronized
4801 * state between threads.
4803 * TODO: The notify object should be created once the notify socket is
4804 * registered and stored independantely from the ust app object. The
4805 * tricky part is to synchronize the teardown of the application and
4806 * this notify object. Let's keep that in mind so we can avoid this
4807 * kind of shenanigans with ENOMEM in the teardown path.
4814 DBG("UST app notify socket unregister %d", sock
);
4817 * Lookup application by notify socket. If this fails, this means that the
4818 * hash table delete has already been done by the application
4819 * unregistration process so we can safely close the notify socket in a
4822 app
= find_app_by_notify_sock(sock
);
4827 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4830 * Whatever happens here either we fail or succeed, in both cases we have
4831 * to close the socket after a grace period to continue to the call RCU
4832 * here. If the deletion is successful, the application is not visible
4833 * anymore by other threads and is it fails it means that it was already
4834 * deleted from the hash table so either way we just have to close the
4837 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4843 * Close socket after a grace period to avoid for the socket to be reused
4844 * before the application object is freed creating potential race between
4845 * threads trying to add unique in the global hash table.
4848 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4853 * Destroy a ust app data structure and free its memory.
4855 void ust_app_destroy(struct ust_app
*app
)
4861 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);